diff --git a/.gitignore b/.gitignore index 3698163e415..034e380690d 100644 --- a/.gitignore +++ b/.gitignore @@ -9,3 +9,4 @@ data .DS_Store pages/platform/kubernetes-k8s/monitoring-gpu-application/images/gpu-app-demo-video.mov +llm-config/ \ No newline at end of file diff --git a/links/bare-metal/sgx b/links/bare-metal/sgx new file mode 100644 index 00000000000..d859d512bd1 --- /dev/null +++ b/links/bare-metal/sgx @@ -0,0 +1,16 @@ +- [de-de](https://www.ovhcloud.com/de/bare-metal/intel-software-guard-extensions/) +- [en-asia](https://www.ovhcloud.com/asia/bare-metal/intel-software-guard-extensions/) +- [en-au](https://www.ovhcloud.com/en-au/bare-metal/intel-software-guard-extensions/) +- [en-ca](https://www.ovhcloud.com/en-ca/bare-metal/intel-software-guard-extensions/) +- [en-gb](https://www.ovhcloud.com/en-gb/bare-metal/intel-software-guard-extensions/) +- [en-ie](https://www.ovhcloud.com/en-ie/bare-metal/intel-software-guard-extensions/) +- [en-in](https://www.ovhcloud.com/en-in/bare-metal/intel-software-guard-extensions/) +- [en-sg](https://www.ovhcloud.com/en-sg/bare-metal/intel-software-guard-extensions/) +- [en-us](https://www.ovhcloud.com/en/bare-metal/intel-software-guard-extensions/) +- [es-es](https://www.ovhcloud.com/es-es/bare-metal/intel-software-guard-extensions/) +- [es-us](https://www.ovhcloud.com/es/bare-metal/intel-software-guard-extensions/) +- [fr-ca](https://www.ovhcloud.com/fr-ca/bare-metal/intel-software-guard-extensions/) +- [fr-fr](https://www.ovhcloud.com/fr/bare-metal/intel-software-guard-extensions/) +- [it-it](https://www.ovhcloud.com/it/bare-metal/intel-software-guard-extensions/) +- [pl-pl](https://www.ovhcloud.com/pl/bare-metal/intel-software-guard-extensions/) +- [pt-pt](https://www.ovhcloud.com/pt/bare-metal/intel-software-guard-extensions/) \ No newline at end of file diff --git a/links/bare-metal/vps-lz b/links/bare-metal/vps-lz index 6a77e0f742c..17fe20eebd8 100644 --- a/links/bare-metal/vps-lz +++ b/links/bare-metal/vps-lz @@ -1,16 +1,16 @@ -- [de-de](https://www.ovhcloud.com/de/vps/) -- [en-asia](https://www.ovhcloud.com/asia/vps/) -- [en-au](https://www.ovhcloud.com/en-au/vps/) -- [en-ca](https://www.ovhcloud.com/en-ca/vps/) -- [en-gb](https://www.ovhcloud.com/en-gb/vps/) -- [en-ie](https://www.ovhcloud.com/en-ie/vps/) -- [en-in](https://www.ovhcloud.com/en-in/vps/) -- [en-sg](https://www.ovhcloud.com/en-sg/vps/) -- [en-us](https://www.ovhcloud.com/en/vps/) -- [es-es](https://www.ovhcloud.com/es-es/vps/) -- [es-us](https://www.ovhcloud.com/es/vps/) -- [fr-ca](https://www.ovhcloud.com/fr-ca/vps/) -- [fr-fr](https://www.ovhcloud.com/fr/vps/) -- [it-it](https://www.ovhcloud.com/it/vps/) -- [pl-pl](https://www.ovhcloud.com/pl/vps/) -- [pt-pt](https://www.ovhcloud.com/pt/vps/) +- [de-de](https://www.ovhcloud.com/de/lp/vps-localzone/) +- [en-asia](https://www.ovhcloud.com/asia/lp/vps-localzone/) +- [en-au](https://www.ovhcloud.com/en-au/lp/vps-localzone/) +- [en-ca](https://www.ovhcloud.com/en-ca/lp/vps-localzone/) +- [en-gb](https://www.ovhcloud.com/en-gb/lp/vps-localzone/) +- [en-ie](https://www.ovhcloud.com/en-ie/lp/vps-localzone/) +- [en-in](https://www.ovhcloud.com/en-in/lp/vps-localzone/) +- [en-sg](https://www.ovhcloud.com/en-sg/lp/vps-localzone/) +- [en-us](https://www.ovhcloud.com/en/lp/vps-localzone/) +- [es-es](https://www.ovhcloud.com/es-es/lp/vps-localzone/) +- [es-us](https://www.ovhcloud.com/es/lp/vps-localzone/) +- [fr-ca](https://www.ovhcloud.com/fr-ca/lp/vps-localzone/) +- [fr-fr](https://www.ovhcloud.com/fr/lp/vps-localzone/) +- [it-it](https://www.ovhcloud.com/it/lp/vps-localzone/) +- [pl-pl](https://www.ovhcloud.com/pl/lp/vps-localzone/) +- [pt-pt](https://www.ovhcloud.com/pt/lp/vps-localzone/) \ No newline at end of file diff --git a/links/bare-metal/vps-n8n b/links/bare-metal/vps-n8n new file mode 100644 index 00000000000..861438ebbfb --- /dev/null +++ b/links/bare-metal/vps-n8n @@ -0,0 +1,16 @@ +- [de-de](https://www.ovhcloud.com/de/vps/vps-n8n/) +- [en-asia](https://www.ovhcloud.com/asia/vps/vps-n8n/) +- [en-au](https://www.ovhcloud.com/en-au/vps/vps-n8n/) +- [en-ca](https://www.ovhcloud.com/en-ca/vps/vps-n8n/) +- [en-gb](https://www.ovhcloud.com/en-gb/vps/vps-n8n/) +- [en-ie](https://www.ovhcloud.com/en-ie/vps/vps-n8n/) +- [en-in](https://www.ovhcloud.com/en-in/vps/vps-n8n/) +- [en-sg](https://www.ovhcloud.com/en-sg/vps/vps-n8n/) +- [en-us](https://www.ovhcloud.com/en/vps/vps-n8n/) +- [es-es](https://www.ovhcloud.com/es-es/vps/vps-n8n/) +- [es-us](https://www.ovhcloud.com/es/vps/vps-n8n/) +- [fr-ca](https://www.ovhcloud.com/fr-ca/vps/vps-n8n/) +- [fr-fr](https://www.ovhcloud.com/fr/vps/vps-n8n/) +- [it-it](https://www.ovhcloud.com/it/vps/vps-n8n/) +- [pl-pl](https://www.ovhcloud.com/pl/vps/vps-n8n/) +- [pt-pt](https://www.ovhcloud.com/pt/vps/vps-n8n/) \ No newline at end of file diff --git a/links/hosted-private-cloud/onprem-cloud-platform b/links/hosted-private-cloud/onprem-cloud-platform new file mode 100644 index 00000000000..d4b1d476c95 --- /dev/null +++ b/links/hosted-private-cloud/onprem-cloud-platform @@ -0,0 +1,16 @@ +- [de-de](https://www.ovhcloud.com/en-ie/hosted-private-cloud/onprem-cloud-platform/) +- [en-asia](https://www.ovhcloud.com/asia/hosted-private-cloud/onprem-cloud-platform/) +- [en-au](https://www.ovhcloud.com/en-au/hosted-private-cloud/onprem-cloud-platform/) +- [en-ca](https://www.ovhcloud.com/en-ca/hosted-private-cloud/onprem-cloud-platform/) +- [en-gb](https://www.ovhcloud.com/en-gb/hosted-private-cloud/onprem-cloud-platform/) +- [en-ie](https://www.ovhcloud.com/en-ie/hosted-private-cloud/onprem-cloud-platform/) +- [en-in](https://www.ovhcloud.com/en-in/hosted-private-cloud/onprem-cloud-platform/) +- [en-sg](https://www.ovhcloud.com/en-sg/hosted-private-cloud/onprem-cloud-platform/) +- [en-us](https://www.ovhcloud.com/en/hosted-private-cloud/onprem-cloud-platform/) +- [es-es](https://www.ovhcloud.com/en-ie/hosted-private-cloud/onprem-cloud-platform/) +- [es-us](https://www.ovhcloud.com/en-ie/hosted-private-cloud/onprem-cloud-platform/) +- [fr-ca](https://www.ovhcloud.com/fr-ca/hosted-private-cloud/onprem-cloud-platform/) +- [fr-fr](https://www.ovhcloud.com/fr/hosted-private-cloud/onprem-cloud-platform/) +- [it-it](https://www.ovhcloud.com/en-ie/hosted-private-cloud/onprem-cloud-platform/) +- [pl-pl](https://www.ovhcloud.com/en-ie/hosted-private-cloud/onprem-cloud-platform/) +- [pt-pt](https://www.ovhcloud.com/en-ie/hosted-private-cloud/onprem-cloud-platform/) \ No newline at end of file diff --git a/links/hosted-private-cloud/public-vcf-aas-veeam b/links/hosted-private-cloud/public-vcf-aas-veeam new file mode 100644 index 00000000000..7820b11ffc0 --- /dev/null +++ b/links/hosted-private-cloud/public-vcf-aas-veeam @@ -0,0 +1,16 @@ +- [de-de](https://www.ovhcloud.com/de/public-vcf-aas/veeam/) +- [en-asia](https://www.ovhcloud.com/asia/public-vcf-aas/veeam/) +- [en-au](https://www.ovhcloud.com/en-au/public-vcf-aas/veeam/) +- [en-ca](https://www.ovhcloud.com/en-ca/public-vcf-aas/veeam/) +- [en-gb](https://www.ovhcloud.com/en-gb/public-vcf-aas/veeam/) +- [en-ie](https://www.ovhcloud.com/en-ie/public-vcf-aas/veeam/) +- [en-in](https://www.ovhcloud.com/en-in/public-vcf-aas/veeam/) +- [en-sg](https://www.ovhcloud.com/en-sg/public-vcf-aas/veeam/) +- [en-us](https://www.ovhcloud.com/en/public-vcf-aas/veeam/) +- [es-es](https://www.ovhcloud.com/es-es/public-vcf-aas/veeam/) +- [es-us](https://www.ovhcloud.com/es/public-vcf-aas/veeam/) +- [fr-ca](https://www.ovhcloud.com/fr-ca/public-vcf-aas/veeam/) +- [fr-fr](https://www.ovhcloud.com/fr/public-vcf-aas/veeam/) +- [it-it](https://www.ovhcloud.com/it/public-vcf-aas/veeam/) +- [pl-pl](https://www.ovhcloud.com/pl/public-vcf-aas/veeam/) +- [pt-pt](https://www.ovhcloud.com/pt/public-vcf-aas/veeam/) \ No newline at end of file diff --git a/links/manager b/links/manager index 6a51312600b..ee926e229d1 100644 --- a/links/manager +++ b/links/manager @@ -1,16 +1,16 @@ -- [de-de](https://www.ovh.com/auth/?action=gotomanager&from=https://www.ovh.de/&ovhSubsidiary=de) -- [en-asia](https://ca.ovh.com/auth/?action=gotomanager&from=https://www.ovh.com/asia/&ovhSubsidiary=asia) -- [en-au](https://ca.ovh.com/auth/?action=gotomanager&from=https://www.ovh.com.au/&ovhSubsidiary=au) -- [en-ca](https://ca.ovh.com/auth/?action=gotomanager&from=https://www.ovh.com/ca/en/&ovhSubsidiary=ca) -- [en-gb](https://www.ovh.com/auth/?action=gotomanager&from=https://www.ovh.co.uk/&ovhSubsidiary=GB) -- [en-ie](https://www.ovh.com/auth/?action=gotomanager&from=https://www.ovh.ie/&ovhSubsidiary=ie) -- [en-in](https://ca.ovh.com/auth/?action=gotomanager&from=https//ca.ovh.com/manager&ovhSubsidiary=IN) -- [en-sg](https://ca.ovh.com/auth/?action=gotomanager&from=https://www.ovh.com/sg/&ovhSubsidiary=sg) -- [en-us](https://ca.ovh.com/auth/?action=gotomanager&from=https://www.ovh.com/world/&ovhSubsidiary=we) -- [es-es](https://www.ovh.com/auth/?action=gotomanager&from=https://www.ovh.es/&ovhSubsidiary=es) -- [es-us](https://ca.ovh.com/auth/?action=gotomanager&from=https://www.ovh.com/world/&ovhSubsidiary=ws) -- [fr-ca](https://ca.ovh.com/auth/?action=gotomanager&from=https://www.ovh.com/ca/fr/&ovhSubsidiary=qc) -- [fr-fr](https://www.ovh.com/auth/?action=gotomanager&from=https://www.ovh.com/fr/&ovhSubsidiary=fr) -- [it-it](https://www.ovh.com/auth/?action=gotomanager&from=https://www.ovh.it/&ovhSubsidiary=it) -- [pl-pl](https://www.ovh.com/auth/?action=gotomanager&from=https://www.ovh.pl/&ovhSubsidiary=pl) -- [pt-pt](https://www.ovh.com/auth/?action=gotomanager&from=https://www.ovh.pt/&ovhSubsidiary=pt) \ No newline at end of file +- [de-de](https://www.ovh.com/auth/?onsuccess=https://manager.eu.ovhcloud.com/&from=https://www.ovh.de/&ovhSubsidiary=de) +- [en-asia](https://ca.ovh.com/auth/?onsuccess=https://manager.ca.ovhcloud.com/&from=https://www.ovh.com/asia/&ovhSubsidiary=asia) +- [en-au](https://ca.ovh.com/auth/?onsuccess=https://manager.ca.ovhcloud.com/&from=https://www.ovh.com.au/&ovhSubsidiary=au) +- [en-ca](https://ca.ovh.com/auth/?onsuccess=https://manager.ca.ovhcloud.com/&from=https://www.ovh.com/ca/en/&ovhSubsidiary=ca) +- [en-gb](https://www.ovh.com/auth/?onsuccess=https://manager.eu.ovhcloud.com/&from=https://www.ovh.co.uk/&ovhSubsidiary=GB) +- [en-ie](https://www.ovh.com/auth/?onsuccess=https://manager.eu.ovhcloud.com/&from=https://www.ovh.ie/&ovhSubsidiary=ie) +- [en-in](https://ca.ovh.com/auth/?onsuccess=https://manager.ca.ovhcloud.com/&from=https//ca.ovh.com/manager&ovhSubsidiary=IN) +- [en-sg](https://ca.ovh.com/auth/?onsuccess=https://manager.ca.ovhcloud.com/&from=https://www.ovh.com/sg/&ovhSubsidiary=sg) +- [en-us](https://ca.ovh.com/auth/?onsuccess=https://manager.ca.ovhcloud.com/&from=https://www.ovh.com/world/&ovhSubsidiary=we) +- [es-es](https://www.ovh.com/auth/?onsuccess=https://manager.eu.ovhcloud.com/&from=https://www.ovh.es/&ovhSubsidiary=es) +- [es-us](https://ca.ovh.com/auth/?onsuccess=https://manager.ca.ovhcloud.com/&from=https://www.ovh.com/world/&ovhSubsidiary=ws) +- [fr-ca](https://ca.ovh.com/auth/?onsuccess=https://manager.ca.ovhcloud.com/&from=https://www.ovh.com/ca/fr/&ovhSubsidiary=qc) +- [fr-fr](https://www.ovh.com/auth/?onsuccess=https://manager.eu.ovhcloud.com/&from=https://www.ovh.com/fr/&ovhSubsidiary=fr) +- [it-it](https://www.ovh.com/auth/?onsuccess=https://manager.eu.ovhcloud.com/&from=https://www.ovh.it/&ovhSubsidiary=it) +- [pl-pl](https://www.ovh.com/auth/?onsuccess=https://manager.eu.ovhcloud.com/&from=https://www.ovh.pl/&ovhSubsidiary=pl) +- [pt-pt](https://www.ovh.com/auth/?onsuccess=https://manager.eu.ovhcloud.com/&from=https://www.ovh.pt/&ovhSubsidiary=pt) \ No newline at end of file diff --git a/links/public-cloud/instance-backup b/links/public-cloud/instance-backup new file mode 100644 index 00000000000..fc4bf14156c --- /dev/null +++ b/links/public-cloud/instance-backup @@ -0,0 +1,16 @@ +- [de-de](https://www.ovhcloud.com/de/public-cloud/instance-backup/) +- [en-asia](https://www.ovhcloud.com/asia/public-cloud/instance-backup/) +- [en-au](https://www.ovhcloud.com/en-au/public-cloud/instance-backup/) +- [en-ca](https://www.ovhcloud.com/en-ca/public-cloud/instance-backup/) +- [en-gb](https://www.ovhcloud.com/en-gb/public-cloud/instance-backup/) +- [en-ie](https://www.ovhcloud.com/en-ie/public-cloud/instance-backup/) +- [en-in](https://www.ovhcloud.com/en-in/public-cloud/instance-backup/) +- [en-sg](https://www.ovhcloud.com/en-sg/public-cloud/instance-backup/) +- [en-us](https://www.ovhcloud.com/en/public-cloud/instance-backup/) +- [es-es](https://www.ovhcloud.com/es-es/public-cloud/instance-backup/) +- [es-us](https://www.ovhcloud.com/es/public-cloud/instance-backup/) +- [fr-ca](https://www.ovhcloud.com/fr-ca/public-cloud/instance-backup/) +- [fr-fr](https://www.ovhcloud.com/fr/public-cloud/instance-backup/) +- [it-it](https://www.ovhcloud.com/it/public-cloud/instance-backup/) +- [pl-pl](https://www.ovhcloud.com/pl/public-cloud/instance-backup/) +- [pt-pt](https://www.ovhcloud.com/pt/public-cloud/instance-backup/) \ No newline at end of file diff --git a/links/public-cloud/prices-ai b/links/public-cloud/prices-ai new file mode 100644 index 00000000000..ac31035d1be --- /dev/null +++ b/links/public-cloud/prices-ai @@ -0,0 +1,16 @@ +- [de-de](https://www.ovhcloud.com/de/public-cloud/prices/#ai-&-machine-learning) +- [en-asia](https://www.ovhcloud.com/asia/public-cloud/prices/#ai-&-machine-learning) +- [en-au](https://www.ovhcloud.com/en-au/public-cloud/prices/#ai-&-machine-learning) +- [en-ca](https://www.ovhcloud.com/en-ca/public-cloud/prices/#ai-&-machine-learning) +- [en-gb](https://www.ovhcloud.com/en-gb/public-cloud/prices/#ai-&-machine-learning) +- [en-ie](https://www.ovhcloud.com/en-ie/public-cloud/prices/#ai-&-machine-learning) +- [en-in](https://www.ovhcloud.com/en-in/public-cloud/prices/#ai-&-machine-learning) +- [en-sg](https://www.ovhcloud.com/en-sg/public-cloud/prices/#ai-&-machine-learning) +- [en-us](https://www.ovhcloud.com/en/public-cloud/prices/#ai-&-machine-learning) +- [es-es](https://www.ovhcloud.com/es-es/public-cloud/prices/#ai-&-machine-learning) +- [es-us](https://www.ovhcloud.com/es/public-cloud/prices/#ai-&-machine-learning) +- [fr-ca](https://www.ovhcloud.com/fr-ca/public-cloud/prices/#ai-&-machine-learning) +- [fr-fr](https://www.ovhcloud.com/fr/public-cloud/prices/#ai-&-machine-learning) +- [it-it](https://www.ovhcloud.com/it/public-cloud/prices/#ai-&-machine-learning) +- [pl-pl](https://www.ovhcloud.com/pl/public-cloud/prices/#ai-&-machine-learning) +- [pt-pt](https://www.ovhcloud.com/pt/public-cloud/prices/#ai-&-machine-learning) \ No newline at end of file diff --git a/links/telecom/offre-internet b/links/telecom/offre-internet index d6e81707bdf..1707c04b053 100644 --- a/links/telecom/offre-internet +++ b/links/telecom/offre-internet @@ -1 +1,2 @@ -- [fr-fr](https://www.ovhcloud.com/fr/internet/) \ No newline at end of file +- [fr-fr](https://www.ovhcloud.com/fr/internet/) +- [en-gb](https://www.ovhcloud.com/fr/internet/) \ No newline at end of file diff --git a/links/telecom/sms-vln b/links/telecom/sms-vln new file mode 100644 index 00000000000..61eaca88d64 --- /dev/null +++ b/links/telecom/sms-vln @@ -0,0 +1,6 @@ +- [en-gb](https://www.ovhcloud.com/en-gb/sms/virtual-numbers) +- [en-ie](https://www.ovhcloud.com/en-ie/sms/virtual-numbers) +- [es-es](https://www.ovhcloud.com/es-es/sms/virtual-numbers) +- [fr-fr](https://www.ovhcloud.com/fr/sms/virtual-numbers) +- [it-it](https://www.ovhcloud.com/it/sms/virtual-numbers) +- [pl-pl](https://www.ovhcloud.com/pl/sms/virtual-numbers) \ No newline at end of file diff --git a/links/transversal/events b/links/transversal/events new file mode 100644 index 00000000000..32883ee6360 --- /dev/null +++ b/links/transversal/events @@ -0,0 +1,16 @@ +- [de-de](https://events.ovhcloud.com/de/) +- [en-asia](https://events.ovhcloud.com/asia/) +- [en-au](https://events.ovhcloud.com/en-au/) +- [en-ca](https://events.ovhcloud.com/en-ca/) +- [en-gb](https://events.ovhcloud.com/en-gb/) +- [en-ie](https://events.ovhcloud.com/en-ie/) +- [en-in](https://events.ovhcloud.com/en-in/) +- [en-sg](https://events.ovhcloud.com/en-sg/) +- [en-us](https://events.ovhcloud.com/en/) +- [es-es](https://events.ovhcloud.com/es-es/) +- [es-us](https://events.ovhcloud.com/es/) +- [fr-ca](https://events.ovhcloud.com/fr-ca/) +- [fr-fr](https://events.ovhcloud.com/fr/) +- [it-it](https://events.ovhcloud.com/it/) +- [pl-pl](https://events.ovhcloud.com/pl/) +- [pt-pt](https://events.ovhcloud.com/pt/) \ No newline at end of file diff --git a/links/transversal/events-startup b/links/transversal/events-startup new file mode 100644 index 00000000000..b0ba82ae4f8 --- /dev/null +++ b/links/transversal/events-startup @@ -0,0 +1,16 @@ +- [de-de](https://events.ovhcloud.com/de/all-events-startup/) +- [en-asia](https://events.ovhcloud.com/asia/all-events-startup/) +- [en-au](https://events.ovhcloud.com/en-au/all-events-startup/) +- [en-ca](https://events.ovhcloud.com/en-ca/all-events-startup/) +- [en-gb](https://events.ovhcloud.com/en-gb/all-events-startup/) +- [en-ie](https://events.ovhcloud.com/en-ie/all-events-startup/) +- [en-in](https://events.ovhcloud.com/en-in/all-events-startup/) +- [en-sg](https://events.ovhcloud.com/en-sg/all-events-startup/) +- [en-us](https://events.ovhcloud.com/en/all-events-startup/) +- [es-es](https://events.ovhcloud.com/es-es/all-events-startup/) +- [es-us](https://events.ovhcloud.com/es/all-events-startup/) +- [fr-ca](https://events.ovhcloud.com/fr-ca/all-events-startup/) +- [fr-fr](https://events.ovhcloud.com/fr/all-events-startup/) +- [it-it](https://events.ovhcloud.com/it/all-events-startup/) +- [pl-pl](https://events.ovhcloud.com/pl/all-events-startup/) +- [pt-pt](https://events.ovhcloud.com/pt/all-events-startup/) \ No newline at end of file diff --git a/links/transversal/marketplace b/links/transversal/marketplace new file mode 100644 index 00000000000..07263338b49 --- /dev/null +++ b/links/transversal/marketplace @@ -0,0 +1 @@ +- [fr-fr](https://marketplace.ovhcloud.com/) \ No newline at end of file diff --git a/links/transversal/marketplace-support-collaboration b/links/transversal/marketplace-support-collaboration new file mode 100644 index 00000000000..24a5370ae9b --- /dev/null +++ b/links/transversal/marketplace-support-collaboration @@ -0,0 +1 @@ +- [fr-fr](https://marketplace.ovhcloud.com/products) \ No newline at end of file diff --git a/links/transversal/startup-program b/links/transversal/startup-program new file mode 100644 index 00000000000..9d80d4fe49b --- /dev/null +++ b/links/transversal/startup-program @@ -0,0 +1,16 @@ +- [de-de](https://startup.ovhcloud.com/de/) +- [en-asia](https://startup.ovhcloud.com/asia/) +- [en-au](https://startup.ovhcloud.com/en-au/) +- [en-ca](https://startup.ovhcloud.com/en-ca/) +- [en-gb](https://startup.ovhcloud.com/en-gb/) +- [en-ie](https://startup.ovhcloud.com/en-ie/) +- [en-in](https://startup.ovhcloud.com/en-in/) +- [en-sg](https://startup.ovhcloud.com/en-sg/) +- [en-us](https://startup.ovhcloud.com/en/) +- [es-es](https://startup.ovhcloud.com/es-es/) +- [es-us](https://startup.ovhcloud.com/es/) +- [fr-ca](https://startup.ovhcloud.com/fr-ca/) +- [fr-fr](https://startup.ovhcloud.com/fr/) +- [it-it](https://startup.ovhcloud.com/it/) +- [pl-pl](https://startup.ovhcloud.com/pl/) +- [pt-pt](https://startup.ovhcloud.com/pt/) \ No newline at end of file diff --git a/links/transversal/startup-program-faq-managers b/links/transversal/startup-program-faq-managers new file mode 100644 index 00000000000..19ea979282a --- /dev/null +++ b/links/transversal/startup-program-faq-managers @@ -0,0 +1,16 @@ +- [de-de](https://startup.ovhcloud.com/de/faq-support/#SPManager) +- [en-asia](https://startup.ovhcloud.com/asia/faq-support/#SPManager) +- [en-au](https://startup.ovhcloud.com/en-au/faq-support/#SPManager) +- [en-ca](https://startup.ovhcloud.com/en-ca/faq-support/#SPManager) +- [en-gb](https://startup.ovhcloud.com/en-gb/faq-support/#SPManager) +- [en-ie](https://startup.ovhcloud.com/en-ie/faq-support/#SPManager) +- [en-in](https://startup.ovhcloud.com/en-in/faq-support/#SPManager) +- [en-sg](https://startup.ovhcloud.com/en-sg/faq-support/#SPManager) +- [en-us](https://startup.ovhcloud.com/en/faq-support/#SPManager) +- [es-es](https://startup.ovhcloud.com/es-es/faq-support/#SPManager) +- [es-us](https://startup.ovhcloud.com/es/faq-support/#SPManager) +- [fr-ca](https://startup.ovhcloud.com/fr-ca/faq-support/#SPManager) +- [fr-fr](https://startup.ovhcloud.com/fr/faq-support/#SPManager) +- [it-it](https://startup.ovhcloud.com/it/faq-support/#SPManager) +- [pl-pl](https://startup.ovhcloud.com/pl/faq-support/#SPManager) +- [pt-pt](https://startup.ovhcloud.com/pt/faq-support/#SPManager) \ No newline at end of file diff --git a/links/web/contact-domain-owner b/links/web/contact-domain-owner new file mode 100644 index 00000000000..ab598a98015 --- /dev/null +++ b/links/web/contact-domain-owner @@ -0,0 +1,16 @@ +- [de-de](https://www.ovhcloud.com/de/lp/request-ovhcloud-registered-domain/) +- [en-asia](https://www.ovhcloud.com/asia/lp/request-ovhcloud-registered-domain/) +- [en-au](https://www.ovhcloud.com/en-au/lp/request-ovhcloud-registered-domain/) +- [en-ca](https://www.ovhcloud.com/en-ca/lp/request-ovhcloud-registered-domain/) +- [en-gb](https://www.ovhcloud.com/en-gb/lp/request-ovhcloud-registered-domain/) +- [en-ie](https://www.ovhcloud.com/en-ie/lp/request-ovhcloud-registered-domain/) +- [en-in](https://www.ovhcloud.com/en-in/lp/request-ovhcloud-registered-domain/) +- [en-sg](https://www.ovhcloud.com/en-sg/lp/request-ovhcloud-registered-domain/) +- [en-us](https://www.ovhcloud.com/en/lp/request-ovhcloud-registered-domain/) +- [es-es](https://www.ovhcloud.com/es-es/lp/request-ovhcloud-registered-domain/) +- [es-us](https://www.ovhcloud.com/es/lp/request-ovhcloud-registered-domain/) +- [fr-ca](https://www.ovhcloud.com/fr-ca/lp/request-ovhcloud-registered-domain/) +- [fr-fr](https://www.ovhcloud.com/fr/lp/request-ovhcloud-registered-domain/) +- [it-it](https://www.ovhcloud.com/it/lp/request-ovhcloud-registered-domain/) +- [pl-pl](https://www.ovhcloud.com/pl/lp/request-ovhcloud-registered-domain/) +- [pt-pt](https://www.ovhcloud.com/pt/lp/request-ovhcloud-registered-domain/) \ No newline at end of file diff --git a/links/web/omm b/links/web/omm new file mode 100644 index 00000000000..dbd81af6358 --- /dev/null +++ b/links/web/omm @@ -0,0 +1,16 @@ +- [de-de](https://omm.ovhcloud.com/) +- [en-asia](https://omm.ovhcloud.com/) +- [en-au](https://omm.ovhcloud.com/) +- [en-ca](https://omm.ovhcloud.com/) +- [en-gb](https://omm.ovhcloud.com/) +- [en-ie](https://omm.ovhcloud.com/) +- [en-in](https://omm.ovhcloud.com/) +- [en-sg](https://omm.ovhcloud.com/) +- [en-us](https://omm.ovhcloud.com/) +- [es-es](https://omm.ovhcloud.com/) +- [es-us](https://omm.ovhcloud.com/) +- [fr-ca](https://omm.ovhcloud.com/) +- [fr-fr](https://omm.ovhcloud.com/) +- [it-it](https://omm.ovhcloud.com/) +- [pl-pl](https://omm.ovhcloud.com/) +- [pt-pt](https://omm.ovhcloud.com/) \ No newline at end of file diff --git a/llm-config/config.json b/llm-config/config.json new file mode 100644 index 00000000000..709ba355450 --- /dev/null +++ b/llm-config/config.json @@ -0,0 +1,43 @@ +{ + "runMidscene": { + "model": "Qwen2.5-VL-72B-Instruct", + "configuration": { + "baseURL": "https://oai.endpoints.preprod.ai.cloud.ovh.net/v1", + "cache": "1" + } + }, + "translateGuide": { + "model": "Qwen3-32B", + "configuration": { + "baseURL": "https://oai.endpoints.preprod.ai.cloud.ovh.net/v1" + }, + "maxTokens": 4000, + "temperature": 0.2 + }, + "generateGuide": { + "model": "Meta-Llama-3_3-70B-Instruct", + "configuration": { + "baseURL": "https://oai.endpoints.preprod.ai.cloud.ovh.net/v1" + }, + "maxTokens": 5000, + "temperature": 0.2, + "topP": 1 + }, + "guideToPrompt": { + "model": "Meta-Llama-3_3-70B-Instruct", + "configuration": { + "baseURL": "https://oai.endpoints.preprod.ai.cloud.ovh.net/v1" + }, + "maxTokens": 5000, + "temperature": 0.2 + }, + "proofreadGuide": { + "model": "Meta-Llama-3_3-70B-Instruct", + "configuration": { + "baseURL": "https://oai.endpoints.preprod.ai.cloud.ovh.net/v1" + }, + "maxTokens": 5000, + "temperature": 0.2, + "streaming": false + } +} diff --git a/llm-config/system-prompts/generation.md b/llm-config/system-prompts/generation.md new file mode 100644 index 00000000000..a383ffb7af4 --- /dev/null +++ b/llm-config/system-prompts/generation.md @@ -0,0 +1,134 @@ +**System Role** +You are an expert **technical writer** producing **structured, audience-adapted guides** based on a sequence of **UI console actions** and contextual instructions. + +--- + +### **Main Goal** + +Transform the provided YAML steps into a **complete, logically ordered, and fully visible Markdown guide** that any reader — from beginner to developer — can follow without confusion. + +Every action from the YAML input must appear **explicitly** in the output under the *Instructions* section, unless it is clearly marked as metadata or a screenshot-only step. + +--- + +### **Audience Adaptation** + +Adapt the tone and detail level automatically: + +* **Non-technical readers:** plain, direct language; define technical terms with footnotes; emphasize visible UI elements (“Click **Save**”, “Select **Settings** tab”). +* **Developers or technical users:** concise phrasing; may include config, code, or endpoint references. +* **Mixed audience:** combine both — clear procedural language with short technical clarifications. + +--- + +### **Required Markdown Structure** + +Each guide must follow this exact template and order: + +````markdown +--- +title: "Add a meaningful title here (generated by AI)" +excerpt: "Add a meta description of the guide" +updated: {{date}} +flag: hidden +--- + +## Objective +Describe what the user will achieve at the end of this guide. + +## Requirements +- List prerequisites (accounts, permissions, tools, etc.) needed before starting. +- If the instructions describe access to the OVHcloud Control Panel, write it as follows with this exact link: + +```markdown +Access to the [OVHcloud Control Panel](/links:manager) +``` + +## Instructions + + + +Invite the reader to log in to the UI mentioned in the requirements. + +Then, transform each provided step into a **visible sub-section** using this format: + +### [Short Action Title] +- Describe the exact action performed in the UI console. +- Do NOT describe waiting steps +- Keep each UI action separate; do **not** merge consecutive steps. +- Add short context or purpose before the action when useful. +- Maintain continuity between steps so users can follow the workflow. + +If the step is of type `screenshot`, insert only the image in this format, right after the related action: + +```markdown +![Descriptive alt text inspired by description or filename](path/filename){.thumbnail} +``` + +Skip numbering; use titles and line breaks for separation. + +## Go further + +Provide additional notes, troubleshooting, or next steps. + +```` + +--- + +### **Guide Metadata** +- **Guide name:** `{{scenario}}` +- **Base URL:** `{{base_url}}` (must appear in the first visible step) +- Add `` tag before the first step. +- Use valid Markdown syntax (no fenced wrapping of the whole output). +- Include both header and footer metadata. +- Skip scrolling steps, waiting steps, or repetitive filler. +- Skip a line before each bulleted list, even if the bulleted list directly follows a sub-section. +- Apply any contextual additions from `{{custom_instructions}}`. +- Highlight UI clickable buttons with the following markdown format: + +```markdown +`button`{.action} +``` + +--- + +### **Writing Quality Rules** +- Language: `{{locale}}` +- Maintain **clarity, directness, and step visibility**. +- Preserve all actions: do **not** drop or generalize UI interactions. +- Use consistent terminology and UI labels (match capitalization as seen in the console). +- Use active voice (“Click”, “Select”, “Enter”). +- Add brief explanations for outcomes or reasons when helpful. +- Include **footnotes** only for domain-specific or technical terms. + +--- + +### **Generation Behavior** +- Output must be deterministic, formatted, and complete. +- Follow all sections exactly as written above. +- Every UI action must appear visibly in *Instructions*. +- The final text must be directly publishable in Markdown. +- Do not enclose the guide in code fences. + +--- + +## **Audience Adaptation** + +When generating the guide, analyze the content and automatically adjust complexity and tone: + +- If instructions involve **APIs, integrations, or scripts**, favor a developer-oriented writing style. +- If instructions describe **UI-based operations** or **user workflows**, favor a non-technical style. +- For **mixed audiences**, strike a balance: clear plain-language explanations with optional technical clarifications in parentheses or footnotes. + +--- + +### **Input** +```yaml +{{steps}} +``` + +### **Final Task** + +Generate the guide using all the instructions above. + +--- \ No newline at end of file diff --git a/llm-config/system-prompts/guide-refinement.md b/llm-config/system-prompts/guide-refinement.md new file mode 100644 index 00000000000..86f22819088 --- /dev/null +++ b/llm-config/system-prompts/guide-refinement.md @@ -0,0 +1,30 @@ +**Guide Refinement Task** + +Act as a technical editor to polish the provided guide. Make minimal but impactful improvements to enhance readability while preserving the original structure and content. + +**Input** + +```markdown +{{guide}} +``` + +**Your Task** + +Review the guide and make light edits to: + +- Remove any obviously redundant or unnecessary sentences +- Simplify overly complex phrasing while keeping technical accuracy +- Ensure the tone feels natural and professional (not robotic) +- Fix any grammatical or stylistic issues + +**Important Constraints** + +- Keep all steps and their titles intact unless truly redundant +- Preserve all technical details, footnotes, and formatting +- Maintain the document header and structure +- Do not reorganize or heavily rewrite content +- Make only essential improvements + +**Output Format** + +Provide the refined guide in valid Markdown format. Do not encapsulate the result in a fenced code block. diff --git a/llm-config/system-prompts/guide-to-prompt.md b/llm-config/system-prompts/guide-to-prompt.md new file mode 100644 index 00000000000..e13cffd43d7 --- /dev/null +++ b/llm-config/system-prompts/guide-to-prompt.md @@ -0,0 +1,109 @@ +**Task: Convert User Guide into Bot Actions** + +Your goal is to break down a given user guide into a series of steps that a browser-manipulating bot can follow. Typically, guides are already divided into steps, so your task is to transform these steps into detailed actions that an AI agent can easily replicate. +Note that you will be already logged in when accessing OVHcloud manager, so you don't need to add steps concerning authentification. +Links described as "/link/manager" corresponds to "https://www.ovh.com/manager/#/" +Note that your name as a user will be "POC Guides". + +**Requirements:** + +1. Each step should be written in English, event If the UI is in a language other than English, translate any referenced text into English. +2. Provide enough detail for an AI agent to reproduce the steps without ambiguity. +3. When a value needs to be filled, it should be valid. +4. Note that the AI agent can only interact with the interface and cannot see the URL. + +**Input:** + +The user guide to be converted is provided below: + +```md +{{guide}} +``` + +**Output Format:** + +The output should be in the following format: + +```json +{ + "target": { + "url": "https://website.com/exact-path", + "viewportWidth": 1280, + "viewportHeight": 720 + }, + "tasks": [ + { + "name": "Task Name", + "flow": [ + { + "type": "aiWaitFor", + "action": "Perform action 1" + }, + { + "type": "ai", + "action": "Perform action 2" + } + ] + } + ] +} +``` + +**Example:** + +For reference, here is an example of what the output might look like: + +```json +{ + "target": { + "url": "https://url-of-the-starting-point", + "viewportWidth": 1280, + "viewportHeight": 720 + }, + "tasks": [ + { + "name": "How to change date of birth", + "flow": [ + { + "type": "aiWaitFor", + "action": "You are on the page 'My Account'" + }, + { + "type": "ai", + "action": "Click on 'My informations'" + }, + { + "type": "aiWaitFor", + "action": "Wait for the page to finish loading" + }, + { + "type": "ai", + "action": "Click on Edit" + }, + { + "type": "aiAssert", + "action": "The user information form should be visible" + }, + { + "type": "ai", + "action": "Click the 'Date of birth' or 'Birthday' field" + }, + { + "type": "ai", + "action": "Update the field with a random date" + }, + { + "type": "ai", + "action": "Click on confirm" + }, + { + "type": "aiWaitFor", + "action": "A confirmation text should appear" + } + ] + } + ] +} +``` + +Please convert the provided user guide into this format, following the requirements and guidelines above. diff --git a/llm-config/system-prompts/proofreading.md b/llm-config/system-prompts/proofreading.md new file mode 100644 index 00000000000..4f4aa427087 --- /dev/null +++ b/llm-config/system-prompts/proofreading.md @@ -0,0 +1,70 @@ +You are a professional proofreader reviewing a technical guide written in italian. Your task is to identify and correct any grammatical errors in the document, with particular attention to articles and prepositions. + +## Critical Rules + +**PRESERVE MARKDOWN SYNTAX**: Do not modify, break, or alter any markdown formatting: +- Keep link syntax intact: `[text](url)` must remain exactly as is +- Do not change text inside links, bold (`**text**`), italic (`*text*`), code blocks (` ``` `), inline code (`` `text` ``), or any other markdown elements +- Only fix grammar in the plain text surrounding markdown syntax + +**OUTPUT REQUIREMENT**: Return the complete guide in its entirety. Do NOT wrap your output in a code block. Return the raw markdown text with corrections applied (or unchanged if no errors found). + +## What to Fix + +Focus on grammatical errors, especially: + +1. **Articles and prepositions before markdown elements** + - Wrong: `le [interface]` → Correct: `l'[interface]` (French elision) + - Wrong: `del [strumento]` → Correct: `dello [strumento]` (Italian preposition agreement) + - Wrong: `de [image]` → Correct: `d'[image]` (French elision) + +2. **General grammatical errors** such as: + - Subject-verb agreement + - Incorrect article usage (a/an, le/la/l', il/lo/la, etc.) + - Preposition errors + - Obvious typos or syntax errors in plain text + +## Language-Specific Rules + +### Italian Articulated Prepositions + +When reviewing Italian text, pay special attention to articulated prepositions (preposizioni articolate). These must match the article of the following word: + +**Key rule for "dello/allo/dallo/nello/sullo":** +Use these forms (NOT del/al/dal/nel/sul) before masculine singular words starting with: +- s + consonant: `dello [strumento]`, `nello [storage]`, `sullo [schermo]` +- z: `dello [zaino]` +- gn, ps, x, y + +**Common patterns:** +- di + il = del, but di + lo = dello +- a + il = al, but a + lo = allo +- da + il = dal, but da + lo = dallo +- in + il = nel, but in + lo = nello +- su + il = sul, but su + lo = sullo + +**Plural forms:** +- Use "degli/agli/dagli/negli/sugli" before vowels or the same consonant groups: `degli [utenti]`, `negli [strumenti]` + +## What NOT to Change + +- Do not translate any content +- Do not rewrite or rephrase sentences +- Do not modify technical terms or product names +- Do not change markdown syntax or structure +- Do not alter text inside markdown formatting (links, bold, code, etc.) + +## Process + +1. Carefully read through the entire guide +2. Identify grammatical errors in plain text and around markdown syntax +3. Make corrections while preserving all markdown formatting +4. Return the complete guide with corrections applied + +**Note**: If no errors are found, return the guide exactly as provided. This is perfectly acceptable. + +--- + +Here is the guide to review: + +{{guide}} diff --git a/llm-config/system-prompts/translation.md b/llm-config/system-prompts/translation.md new file mode 100644 index 00000000000..d6a2b3eed95 --- /dev/null +++ b/llm-config/system-prompts/translation.md @@ -0,0 +1,55 @@ +/set nothink + +You are a translation tool. Your purpose is to create an accurately translated output text from a guide markdown. + +Follow these steps: + +1. The source language is {{source_lang}}. +2. Proceed with the translation of the user input text into {{target_lang}}. Strictly follow the formatting instructions specified below. +3. Output ONLY the completed translated text without any additional commentary, explanations, or formatting markers. Just pure markdown and do not encapsulate response in code block. + +## Tone & Style + +The input text is of a technical nature, specifically: + +- How to use OVHcloud products (user instructions, FAQ, tutorial) + Do not alter the tone or style. Your goal is to provide an accurate translation of the input text. + +## Formatting instructions + +- The input text is formatted in Markdown. Leave all Markdown formatting intact. +- The input text might contain HTML tags. Leave all HTML tags exactly as they are. (example: ). +- The input text includes custom Markdown formats. Leave all Markdown formats and their markers intact. Here are examples: + - Page frontmatter + - Relative links to internal pages + - Relative links to images + - External links + - Triple forward slashes (usage example: /// details | ///) + - Custom Markdown formats identfied by: [!api], [!primary], [!warning], [!alert], [!success], [!tabs] +- **Button labels and UI elements**: Text inside backticks (with or without {.action}) must be translated. Only keep the backticks and {.action} marker unchanged. The text content must be in the target language. +- The input text may contain french quotation marks: « ». Rewrite them into English quotation marks: "". + +## Translation exceptions + +- Preserve the content of code blocks (English). +- Do not translate HTML link fragments and anchors. +- The structure of the input text may often contain certain sections names which must have standardized translations. Refer to the "CSV-formatted list of sections" for the approved translations of these sections. Ensure that you use these exact translations consistently throughout the guide, without introducing any variations. + +### CSV-formatted list of sections + +```csv +French;English;German;Spanish;Italian;Polish;Portuguese +Objectif;Objective;Ziel;Objetivo;Obiettivo;Wprowadzenie;Objetivo +Prérequis;Requirements;Voraussetzungen;Requisitos;Prerequisiti;Wymagania początkowe;Requisitos +En pratique;Instructions;In der praktischen Anwendung;Procedimiento;Procedura;W praktyce;Instruções +Aller plus loin;Go further;Weiterführende Informationen;Más información;Per saperne di più;Sprawdź również;Quer saber mais? +Échangez avec notre [communauté d'utilisateurs](/links/community).;Join our [community of users](/links/community).;Treten Sie unserer [User Community](/links/community) bei.;Interactúe con nuestra [comunidad de usuarios](/links/community).;Contatta la nostra [Community di utenti](/links/community).;Dołącz do [grona naszych użytkowników](/links/community).;Fale com a nossa [comunidade de utilizadores](/links/community). +``` + +## Text to translate + +**CRITICAL: Output the translated content directly as raw markdown. Do NOT wrap your response in code blocks (```), do NOT add explanatory text before or after, and do NOT include phrases like "Here is the translation" or similar commentary. Also, do not try to fix the markdown in any way** + +```markdown +{{guide}} +``` diff --git a/llm-config/terminology/translations.csv b/llm-config/terminology/translations.csv new file mode 100644 index 00000000000..b4516bbdfba --- /dev/null +++ b/llm-config/terminology/translations.csv @@ -0,0 +1,215 @@ +German;English;Spanish;French;Italian;Polish;Portuguese +OVHcloud Kundencenter;OVHcloud Control Panel;área de cliente de OVHcloud;espace client OVHcloud;Spazio Cliente OVHcloud;Panel klienta OVHcloud;área de cliente OVHcloud +Zerto;Zerto;Zerto;Zerto;Zerto;Zerto;Zerto +Nutanix on OVHcloud;Nutanix on OVHcloud;Nutanix on OVHcloud;Nutanix on OVHcloud;Nutanix on OVHcloud;Nutanix on OVHcloud;Nutanix on OVHcloud +Performance 4;Performance 4;Performance 4;Performance 4;Performance 4;Performance 4;Perf 4 +Analytics Manager;Analytics Manager;Analytics Manager;Analytics Manager;Analytics Manager;Analytics Manager;Analytics Manager +Quota- und Regionmanagement;Quota and Region Management;Quota and Region Management;Quota and region management;Quota and Region Management;Quota and Region Management;Quota and Region Management +Boost;Boost;Boost;Boost;Boost;Boost;Boost +CDN;CDN;CDN;CDN;CDN;CDN;CDN +;water cooling;;watercooling;;; +Private Exchange;Private Exchange;Private Exchange;Private Exchange;Private Exchange;Private Exchange;Private Exchange +;retrieval-augmented generation;;génération augmentée par récupération;;; +;Special Terms and Conditions;;Conditions Particulières;;; +Classic Block Storage;Classic Block Storage;Classic;Classic Block Storage;Classic;Classic Block Storage;Classic Block Storage +Kafka;Kafka;Kafka;Kafka;Kafka;Kafka;Kafka +SAP HANA on Private Cloud;SAP HANA on Private Cloud;SAP HANA on Private Cloud;SAP HANA on Private Cloud;SAP HANA on Private Cloud;SAP HANA on Private Cloud;SAP HANA on Private Cloud +GPU;GPU;GPU;GPU;GPU;GPU;GPU +Cloud Disk Array;Cloud Disk Array;Cloud Disk Array;Cloud Disk Array;Cloud Disk Array;Cloud Disk Array;Cloud Disk Array +Elite;Elite;Elite;Elite;Elite;Elite;Elite +;;;Availability Zone;;Availability Zone; +Environmental Impact Tracker;Environmental Impact Tracker;Environmental Impact Tracker;Environmental Impact Tracker;Environmental Impact Tracker;Environmental Impact Tracker;Environmental Impact Tracker +OVHcloud Partner Program;OVHcloud Partner Program;OVHcloud Partner Program;OVHcloud Partner program;OVHcloud Partner Program;OVHcloud Partner Program;OVHcloud Partner program +;;;Réseau et sécurité;;Sieć i bezpieczeństwo; +;Email solutions;Soluciones de correo;Solutions e-mail;Soluzioni email;Rozwiązania poczty elektronicznej;Soluções de e-mail +Standard Support;Standard Support;Soporte Standard;Support Standard;Supporto Standard;Standard;Suporte Standard +Veeam Managed Backup;Veeam Managed Backup;Veeam Managed Backup;Veeam Managed Backup;Veeam Managed Backup;Veeam Backup Managed;Veeam Managed Backup +MySQL;MySQL;MySQL;MySQL;MySQL;MySQL;MySQL +High Speed Block Storage;High Speed Block Storage;High Speed;High Speed Block Storage;High Speed;High Speed Block Storage;High Speed Block Storage +OVHcloud Load Balancer;OVHcloud Load Balancer;Load Balancer de OVHcloud;OVHcloud Load Balancer;Load Balancer OVHcloud;OVHcloud Load Balancer;Load Balancer da OVHcloud +;;;Environmental Impact Tracker;;Environmental Impact Tracker; +Trusted Exchange;Trusted Exchange;Trusted Exchange;Trusted Exchange;Trusted Exchange;Trusted Exchange;Trusted Exchange +;Collaborative solutions;Soluciones colaborativas;Solutions collaboratives;Soluzioni collaborative;Rozwiązania do pracy zespołowej;Soluções colaborativas +Data Processing Engine;Data Processing Engine;Data Processing Engine;Data Processing Engine;Data Processing Engine;Data Processing Engine;Data Processing Engine +Kafka Connect;Kafka Connect;Kafka Connect;Kafka Connect;Kafka Connect;Kafka Connect;Kafka Connect +On-Prem Cloud Platform;On-Prem Cloud Platform;On-Prem Cloud Platform;On-Prem Cloud Platform;On-Prem Cloud Platform;On-Prem Cloud Platform;On-Prem Cloud Platform +Advanced Collaborative Suite;Advanced collaborative suite;Suite colaborativa Advanced;Suite collaborative Advanced;Suite collaborativa Advance;Advanced collaborative suite;Suite colaborativa Advanced +Cloud Web 1;Cloud Web 1;Cloud Web 1;Cloud Web 1;Cloud Web 1;Cloud Web 1;Cloud Web 1 +Local Zones;Local Zones;Local Zones;Local Zones;Local Zones;Local Zones;Local Zones +Volume Snapshot;Volume Snapshot;Volume Snapshot;Volume Snapshot;Volume Snapshot;Volume Snapshot;Volume Snapshot +CDN Security;CDN Security;CDN Security;CDN Security;CDN Security;CDN Security;CDN Security +CDN Advanced;CDN Advanced;CDN Advanced;CDN Advanced;CDN Advanced;CDN Advanced;CDN Advanced +Bring your own IP (BYOIP);Bring Your Own IP (BYOIP);Bring Your Own IP (BYOIP);Bring Your Own IP (BYOIP);Bring Your Own IP (BYOIP);Bring your own IP (BYOIP);Bring your own IP (BYOIP) +;business-critical information;;informations stratégique;;; +Hosted Private Cloud powered by Anthos;Hosted Private Cloud powered by Anthos;Hosted Private Cloud powered by Anthos;Hosted Private Cloud powered by Anthos;Hosted Private Cloud powered by Anthos;Hosted Private Cloud powered by Anthos;Hosted Private Cloud powered by Anthos +Backup;Backup;Backup;Backup;Backup;Backup;Backup +E-Mail Pro;Email Pro;Email Pro;E-mail Pro;Email Pro;E-mail Pro;E-mail Pro +Managed Big Data Cluster;Managed Big Data Cluster;Managed Big Data Cluster;Managed Big Data Cluster;Managed Big Data Cluster;Managed Big Data Cluster;Managed Big Data Cluster +Managed Private Registry;Managed Private Registry;Managed Private Registry;Managed Private Registry;Managed Private Registry;Managed Private Registry;Managed Private Registry +;Web Hosting;Hosting;Hébergements web;Hosting Web;Hosting;Alojamentos web +Scale;Scale;Scale;Scale;Scale;Scale;Scale +CDN Basic;CDN Basic;CDN Basic;CDN Basic;CDN Basic;CDN Basic;CDN Basic +;Network Services;Servicios de red;Services réseau;Servizi di rete;Usługi sieciowe;Serviços de rede +;Levels of support;Niveles de soporte;Niveaux de support;Livelli di supporto;Poziomy wsparcia;Níveis de suporte +Cold Archive;Cold Archive;Cold Archive;Cold Archive;Cold Archive;Cold Archive;Cold Archive +Object Storage;Object Storage;Object Storage;Object storage;Object Storage;Object Storage;Object Storage +Starter;Starter;Starter;Starter;Starter;Starter;Starter +;;;Offre packagée;;Oferta pakietowa; +Das private Netzwerk vRack;vRack private network;Red privada vRack;Réseau privé vRack;Rete privata vRack;Prywatna sieć vRack;Rede privada vRack +;compute resources;;ressources de calcul;;; +Start 10M;Start 10M;Start 10M;Start 10M;Start 10M;Start 10M;Start 10M +Performance Hosting;Performance Hosting;Hosting Performance;Hébergement Performance;Hosting Performance;Hosting Performance;Alojamento Performance +Cloud Webhosting;Cloud Web Hosting;Hosting Cloud Web;Hébergement Cloud Web;Hosting Cloud Web;Hosting Cloud Web;Alojamento Cloud Web +Control Center;Control Center;Control Center;Control Center;Control Center;Control Center;Control Center +Hosted Exchange;Hosted Exchange;Hosted Exchange;Hosted Exchange;Hosted Exchange;Hosted Exchange;Hosted Exchange +High Grade;High Grade;High Grade;High Grade;High Grade;High Grade;High Grade +Data Catalog;Data Catalog;Data Catalog;Data Catalog;Data Catalog;Data Catalog;Data Catalog +;;;Bare Metal Cloud;;Bare Metal Cloud; +IOPS;IOPS;IOPS;IOPS;IOPS;IOPS;IOPS +VPS;VPS;VPS;VPS;VPS;VPS;VPS +Additional IP;Additional IP;Additional IP;Additional IP;Additional IP;Additional IP;Additional IP +;Domain Name Registrant;;Titulaire d’un Nom de Domaine;;; +HYCU for ovhcloud;HYCU for ovhcloud;HYCU for ovhcloud;HYCU for ovhcloud;HYCU for ovhcloud;;HYCU for ovhcloud +OpenSearch;OpenSearch;OpenSearch;OpenSearch;OpenSearch;OpenSearch;OpenSearch +Trusted Zone;Trusted Zone;Trusted Zone;Zone de confiance;Trusted Zone;Trusted Zone;Zonas de Confiança +Enterprise File Storage;Enterprise File Storage;Enterprise File Storage;Enterprise File Storage;Enterprise File Storage;Enterprise File Storage;Enterprise File Storage +Private Image Catalog;Private Image Catalog;Private Image Catalog;Private Image catalog;Private Image Catalog;Private Image Catalog;Private Image Catalog +Managed Kubernetes Service;Managed Kubernetes Service;Managed Kubernetes Service;Managed Kubernetes Service;Managed Kubernetes;Managed Kubernetes;Managed Kubernetes Service +;Domain names;Dominios;Noms de domaine;Domini;Domeny;Nomes de domínio +SSL-Zertifikat "Sectigo DV";Sectigo DV SSL certificate;Certificado SSL Sectigo DV;Certificat SSL Sectigo DV;Certificato SSL Sectigo DV;Certyfikat SSL Sectigo DV;Certificado SSL Sectigo DV +;Web security;Protección web;Sécurité web;Sicurezza Web;Bezpieczeństwo sieci;Segurança web +;Guaranteed resources;Guaranteed Resources;Guaranteed resources;Guaranteed Resources;Guaranteed Resources;Guaranteed Resources +;;;PERFORMANCE 4;;Performance 4; +Public VCF as-a-Service;Public VCF as-a-Service;Public VCF as-a-Service;Public VCF as-a-Service;Public VCF as-a-Service;Public VCF as-a-Service;Public VCF as-a-Service +Game;Game;Game;Game;Game;Game;Game +OVHcloud Link Aggregation (OLA);OVHcloud Link Aggregation (OLA);OVHcloud Link Aggregation (OLA);OVHcloud Link Aggregation (OLA);OVHcloud Link Aggregation (OLA);OVHcloud Link Aggregation (OLA);OVHcloud Link Aggregation (OLA) +SharePoint;SharePoint;SharePoint;SharePoint;SharePoint;SharePoint;SharePoint +Enterprise Support;Enterprise Support;Soporte Enterprise;Support Enterprise;Supporto Enterprise;Enterprise;Suporte Enterprise +Rise;Rise;Rise;Rise;Rise;Rise;Rise +CDN Security;CDN Security;CDN Security;CDN Security;CDN Security;CDN Security;CDN Security +Lakehouse Manager;Lakehouse Manager;Lakehouse Manager;Lakehouse Manager;Lakehouse Manager;Lakehouse Manager;Lakehouse Manager +;conformance program;;programme de conformité;;; +Business Support;Business Support;Soporte Business;Support Business;Supporto Business;Business;Suporte Business +;Options;Opciones;Options;Opzioni;Opcje;Opções +;;;Sécurité web;;Bezpieczeństwo sieci; +OVHcloud AI Training;OVHcloud AI Training;OVHcloud AI Training;OVHcloud AI Training;OVHcloud AI Training;OVHcloud AI Training;OVHcloud AI Training +;Affiliates;;Sociétés Apparentées;;; +File Storage;File Storage;File storage;File storage;File Storage;File storage;File storage +Local Zone;Local Zone;Local Zone;Local Zone;Local Zone;Local Zone;Local Zone +Managed Veeam for VCD;Managed Veeam for VCD;Managed Veeam for VCD;Managed Veeam for VCD;Managed Veeam for VCD;Managed Veeam for VCD;Managed Veeam for VCD +Enterprise Cloud Databases;Enterprise Cloud Databases;Enterprise Cloud Databases;Enterprise Cloud Databases;Enterprise Cloud Databases;Enterprise Cloud Databases;Enterprise Cloud Databases +Logs Data Platform;Logs Data Platform;Logs Data Platform;Logs Data Platform;Logs Data Platform;Logs Data Platform;Logs Data Platform +Performance 1;Performance 1;Performance 1;Performance 1;Performance 1;Performance 1;Perf 1 +DDoS-Schutz-Infrastruktur;Anti-DDoS infrastructure;Infraestructura anti-DDoS;Infrastructure Anti-DDoS;Infrastruttura anti-DDoS;Infrastruktura Anty-DDoS;Infraestrutura Anti-DDoS +MongoDB;MongoDB;MongoDB;MongoDB;MongoDB;MongoDB;MongoDB +NVIDIA NGC Platform;NVIDIA NGC Platform;NVIDIA NGC Platform;NVIDIA NGC Platform;NVIDIA NGC Platform;NVIDIA NGC Platform;NVIDIA NGC Platform +So you Start;So you Start;So you Start;So you Start;So you Start;So you Start;So you Start +Data Processing;Data Processing;Data Processing;Data Processing;Data Processing;Data Processing;Data Processing +Applications Services;Applications Services;Applications Services;Applications Services;Applications Services;Applications Services;Applications Services +;Dedicated Servers;Servidores dedicados;Serveurs dédiés;Server dedicati;Serwery dedykowane;Servidores dedicados +Cassandra;Cassandra;Cassandra;Cassandra;Cassandra;Cassandra;Cassandra +Basic Hosting;Personal Hosting;Hosting Personal;Hébergement Perso;Hosting Personale;Hosting Perso;Alojamento Perso +;;;Sécurité des hôtes et services;;Bezpieczeństwo hostów i usług; +Archive;Archive;Archive;Archive;Archive;Archive;Archive +;;;PERFORMANCE 3;;Performance 3; +M3DB;M3DB;M3DB;M3DB;M3DB;M3DB;M3DB +;Public bandwidth;Ancho de banda público;Bande passante publique;Banda passante pubblica;Przepustowość do sieci publicznej;Largura de banda pública +SSL;SSL;SSL;SSL;SSL;SSL;SSL +Redis;Redis;Redis;Redis;Redis;Redis;Redis +Grafana;Grafana;Grafana;Grafana;Grafana;Grafana;Grafana +Performance 3;Performance 3;Performance 3;Performance 3;Performance 3;Performance 3;Perf 3 +PostgreSQL;PostgreSQL;PostgreSQL;PostgreSQL;PostgreSQL;PostgreSQL;PostgreSQL +Comfort;Comfort;Comfort;Comfort;Comfort;Comfort;Comfort +;;;Hosted Private Cloud powered by VMware;;Hosted Private Cloud powered by VMware; +AI Notebooks;AI Notebooks;AI Notebooks;AI Notebooks;AI Notebooks;AI Notebooks;AI Notebooks +Value;Value;Value;Value;Value;Value;Value +Instance Backup;Instance Backup;Instance Backup;Instance Backup;Instance Backup;Instance Backup;Instance Backup +;Project Management;Project Management;Project management;Project Management;Project Management;Project Management +;white area;;Zone blanche;;; +Marketplace;Marketplace;Marketplace;Marketplace;Marketplace;Marketplace;Marketplace +;Infrastructure protection;Protección de infraestructura;Protection de l'infrastructure;Protezione dell'infrastruttura;Ochrona infrastruktury;Proteção da infraestrutura +Public Image Catalog;Public Image Catalog;Public Image Catalog;Public Image catalog;Public Image Catalog;Public Image Catalog;Public Image Catalog +;;;Pack Nutanix Advanced;;Pakiet Nutanix Advanced; +;SSL certificate as-a-Service;Certificado SSL as a Service;Certificat SSL as a Service;SSL Certificate as a Service;Certyfikat SSL as a Service;Certificado SSL as a Service +;;;PERFORMANCE 2;;Performance 2; +Standard Object Storage;Standard Object Storage;Standard Object Storage;Standard Object Storage;Standard Object Storage;Standard Object Storage;Standard Object Storage +;Web Hosting options;Opciones de alojamiento web;Options hébergement web;Opzioni hosting Web;Opcje hostingu;Opções de alojamento web +;AI & Machine Learning;AI & Machine Learning;AI & machine learning;AI & Machine Learning;AI & Machine Learning;AI & Machine Learning +Trusted Zone;Trusted Zone;Trusted Zone;Zone de confiance;Trusted Zone;Trusted Zone;Zonas de Confiança +Offsite Replication;Offsite Replication;Offsite Replication;Offsite Replication;Offsite Replication;Offsite Replication;Offsite Replication +Open Trusted Cloud;Open Trusted Cloud;Open Trusted Cloud;Open Trusted Cloud;Open Trusted Cloud;Open Trusted Cloud;Open Trusted Cloud +;;;Visibilité Pro;;Widoczna firma; +Discovery;Discovery;Discovery;Discovery;Discovery;Discovery;Discovery +Advance;Advance;Advance;Advance;Advance;Advance;Advance +DNSSEC;DNSSEC;DNSSEC;DNSSEC;DNSSEC;DNSSEC;DNSSEC +DDoS-Schutz;DDoS protection;DDoS Protection;Protection Anti-DDoS;Protezione anti-DDoS;Ochrona Anty-DDoS;Proteção DDoS +CDN Infrastructure;CDN Infrastructure;CDN Infrastructure;CDN Infrastructure;CDN Infrastructure;CDN Infrastructure;CDN Infrastructure +Metal Instance;Metal Instance;Metal Instance;Metal Instance;Metal Instance;Metal Instance;Metal Instance +Sicherheit von Hosts und Diensten (Hosted Private Cloud);Security for hosts and services (Hosted Private Cloud);Protección de hosts y servicios solo para Hosted Private Cloud;Sécurité des hôtes et services (Hosted Private Cloud);Sicurezza di host e servizi (Hosted Private Cloud);Bezpieczeństwo hostów i usług (Hosted Private Cloud);Segurança dos hosts e serviços (Hosted Private Cloud) +ML Serving;ML Serving;ML Serving;ML Serving;ML Serving;ML Serving;ML Serving +Data Platform;ForePaaS;Data Platform;Data Platform;Data Platform;Data Platform;Data Platform +;SMS;SMS;SMS;SMS;Usługa SMS; +Kimsufi;Kimsufi;Kimsufi;Kimsufi;Kimsufi;Kimsufi;Kimsufi +;Security for hosts and services;Protección de hosts y servicios;Sécurité des hôtes et services;Sicurezza di host e servizi;;Segurança dos hosts e serviços +Start SQL-Datenbanken;Start SQL Databases;Bases de datos Start SQL;Bases de données Start SQL;Database Start SQL;Bazy danych Start SQL;Bases de dados Start SQL +;Edge;;périphérie;;; +SSL-Zertifikat "Let's Encrypt";Let's Encrypt SSL certificate;Certificado SSL Let's Encrypt;Certificat SSL Let's Encrypt;Certificato SSL Let's Encrypt;Certyfikat SSL Let's Encrypt;Certificado SSL Let's Encrypt +Plesk Hosting (EOL);Plesk Hosting (EOL);Hosting Plesk (EOL);Hébergement Plesk (EOL);Hosting Plesk (EOL);Hosting Plesk (EOL);Alojamento Plesk (EOL) +Console Connect;Console Connect;Console Connect;Console Connect;Console Connect;Console Connect;Console Connect +Performance 2;Performance 2;Performance 2;Performance 2;Performance 2;Performance 2;Perf 2 +Microsoft 365;Microsoft 365;Microsoft 365;Microsoft 365;Microsoft 365;Microsoft 365;Microsoft 365 +;;;computer vision;;widzenie komputerowe; +;vRack Services;;;;vRack Services; +;;;Services et certifications;;Usługi i certyfikaty; +Kafka MirrorMaker;Kafka MirrorMaker;Kafka MirrorMaker;Kafka MirrorMaker;Kafka MirrorMaker;Kafka MirrorMaker;Kafka MirrorMaker +;;;Pack Nutanix Standard;;Pakiet Nutanix Standard; +OVHcloud Connect;OVHcloud Connect;OVHcloud Connect;OVHcloud Connect;OVHcloud Connect;OVHcloud Connect;OVHcloud Connect +Pro Hosting;Professional Hosting;Hosting Profesional;Hébergement Pro;Hosting Pro;Hosting Pro;Alojamento Pro +Storage;Storage;Storage;Storage;Storage;Storage;Storage +;Security;Seguridad;Sécurité;Sicurezza;Bezpieczeństwo;Segurança +Cloud Archive;Cloud Archive;Cloud Archive;Cloud Archive;Cloud Archive;Cloud Archive;Cloud Archive +SecNumCloud;SecNumCloud;SecNumCloud;SecNumCloud;SecNumCloud;SecNumCloud;SecNumCloud +;Data Analytics;Data Analytics;Data Analytics;Data Analytics;Data Analytics;Data Analytics +;;;Stockage et sauvegarde;;Przechowywanie i kopie zapasowe; +;decoupling;;découplage;;; +;Data localisation;;Localisation des données;;; +Eco Dedicated Server;Eco Dedicated Servers;Servidores dedicados Eco;Serveurs dédiés Eco;Server dedicati Eco;Serwery dedykowane Eco;Servidores dedicados Eco +Managed Rancher Service;Managed Rancher Service;Managed Rancher Service;Managed Rancher Service;Managed Rancher Service;Managed Rancher Service;Managed Rancher Service +;;;Offre Nutanix on OVHcloud packagée;;Oferta pakietowa Nutanix on OVHcloud; +High Performance Object Storage;High Performance Object Storage;High Performance Object Storage;High Performance Object Storage;High Performance Object Storage;High Performance Object Storage;High Performance Object Storage +;Service Endpoint;;;;Service Endpoint; +Bare Metal Cloud Netzwerkdienste;Network Services for Bare Metal Cloud;Servicios de red para Bare Metal Cloud;Services réseau Bare Metal Cloud;Servizi di rete Bare Metal Cloud;Usługi sieciowe Bare Metal Cloud;Serviços de rede Bare Metal Cloud +Cloud Web 2;Cloud Web 2;Cloud Web 2;Cloud Web 2;Cloud Web 2;Cloud Web 2;Cloud Web 2 +Billing Control;Billing Control;Billing Control;Billing control;Billing Control;Billing Control;Billing Control +HA-NAS;HA-NAS;NAS-HA;NAS-HA;NAS-HA;NAS-HA;NAS-HA +;graphical console;;console graphique;;; +Compute;Compute;Compute;Compute;Compute;Compute;Compute +Backup Storage;Backup Storage;Backup Storage;Backup Storage;Backup Storage;Backup Storage;Backup Storage +Managed Bare Metal;Managed Bare Metal;Managed Bare Metal;Managed Bare Metal;Managed Bare Metal;Managed Bare Metal;Managed Bare Metal +Cloud Web 3;Cloud Web 3;Cloud Web 3;Cloud Web 3;Cloud Web 3;Cloud Web 3;Cloud Web 3 +SSL-Zertifikat „Sectigo EV“;Sectigo EV SSL certificate;Certificado SSL Sectigo EV;Certificat SSL Sectigo EV;Certificato SSL Sectigo EV;Certyfikat SSL Sectigo EV;Certificado SSL Sectigo EV +OpenStack Orchestration;OpenStack Orchestration;OpenStack Orchestration;OpenStack Orchestration;OpenStack Orchestration;OpenStack Orchestration;OpenStack Orchestration +;Registrant;;Titulaire;;; +Block Storage;Block Storage;Block Storage;Block Storage;Block Storage;Block Storage;Block Storage +;reseller;;revendeur;;; +User and Role Management;User and Role Management;User and Role Management;User and role management;User and Role Management;User and Role Management;User and Role Management +;;;conditions générales de service;;Ogólne warunki świadczenia usługi; +;sub-processor;;sous-traitant ultérieur;;; +Professional Services;Professional Services;Professional Services;Professional Services;Professional Services;Professional Services;Professional Services +SSL Gateway;SSL Gateway;SSL Gateway;SSL Gateway;SSL Gateway;SSL Gateway;SSL Gateway +M3 Aggregator;M3 Aggregator;M3 Aggregator;M3 Aggregator;M3 Aggregator;M3 Aggregator;M3 Aggregator +;tape storage;;archivage sur bande;;; +VMware on OVHcloud;VMware on OVHcloud;VMware on OVHcloud;VMware on OVHcloud;VMware on OVHcloud;VMware on OVHcloud;VMware on OVHcloud +Private SQL-Datenbanken;Private SQL Databases;Bases de datos SQL Privado;Bases de données SQL Privé;Database SQL Privato;Bazy danych Private SQL;Bases de dados SQL Privado +Workflow Management;Workflow Management;Workflow Management;Workflow management;Workflow Management;Workflow Management;Workflow Management +;Databases;Databases;Databases;Database;Databases;Databases +Essential;Essential;Essential;Essential;Essential;Essential;Essential +High Speed Gen2 Block Storage;High Speed Gen2 Block Storage;High Speed Gen2;High Speed Gen2 Block Storage;High Speed Gen2;High Speed Gen2 Block Storage;High Speed Gen2 Block Storage +;Registry operators;;Registres opérateurs;;; +OVHcloud Startup Program;OVHcloud Startup Program;OVHcloud Startup Program;Startup program;OVHcloud Startup Program;OVHcloud Startup Program;OVHcloud Startup Program +Premium Support;Premium Support;Soporte Premium;Support Premium;Supporto Premium;Premium;Suporte Premium +;;;Public VCF as-a-Service;;Public VCF as a Service; +;;;Web Cloud;;Web Cloud; +Game DDoS-Schutz;Anti-DDoS Game;Anti-DDoS Game;Anti-DDoS Game;Anti-DDoS Game;Anty-DDoS Game;Anti-DDoS Game +NSX Edge-Dienste;NSX Edge Services;Servicios NSX Edge;Services NSX Edge;Servizi NSX Edge;NSX Edge Services;Serviços NSX Edge +;Containers and Orchestration;Containers & Orchestration;Containers and orchestration;Containers and Orchestration;Containers & Orchestration;Containers & Orchestration \ No newline at end of file diff --git a/pages/account_and_service_management/account_information/all_about_username/images/3936.png b/pages/account_and_service_management/account_information/all_about_username/images/3936.png deleted file mode 100644 index b7fca5a1ef1..00000000000 Binary files a/pages/account_and_service_management/account_information/all_about_username/images/3936.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/all_about_username/images/3948.png b/pages/account_and_service_management/account_information/all_about_username/images/3948.png deleted file mode 100644 index feaef0511fe..00000000000 Binary files a/pages/account_and_service_management/account_information/all_about_username/images/3948.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/all_about_username/images/3949.png b/pages/account_and_service_management/account_information/all_about_username/images/3949.png deleted file mode 100644 index c0db9c7b922..00000000000 Binary files a/pages/account_and_service_management/account_information/all_about_username/images/3949.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/all_about_username/images/3953.png b/pages/account_and_service_management/account_information/all_about_username/images/3953.png deleted file mode 100644 index 3d791b48ec0..00000000000 Binary files a/pages/account_and_service_management/account_information/all_about_username/images/3953.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/all_about_username/images/3954.png b/pages/account_and_service_management/account_information/all_about_username/images/3954.png deleted file mode 100644 index 9acff959115..00000000000 Binary files a/pages/account_and_service_management/account_information/all_about_username/images/3954.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/all_about_username/images/3955.png b/pages/account_and_service_management/account_information/all_about_username/images/3955.png deleted file mode 100644 index f6bbf804097..00000000000 Binary files a/pages/account_and_service_management/account_information/all_about_username/images/3955.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/all_about_username/images/3956.png b/pages/account_and_service_management/account_information/all_about_username/images/3956.png deleted file mode 100644 index 1c946681a64..00000000000 Binary files a/pages/account_and_service_management/account_information/all_about_username/images/3956.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/all_about_username/images/3957.png b/pages/account_and_service_management/account_information/all_about_username/images/3957.png deleted file mode 100644 index f72c922ff90..00000000000 Binary files a/pages/account_and_service_management/account_information/all_about_username/images/3957.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/all_about_username/images/SS_1.png b/pages/account_and_service_management/account_information/all_about_username/images/SS_1.png deleted file mode 100644 index 75c7f8d72fc..00000000000 Binary files a/pages/account_and_service_management/account_information/all_about_username/images/SS_1.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/all_about_username/images/SS_2.png b/pages/account_and_service_management/account_information/all_about_username/images/SS_2.png deleted file mode 100644 index 55c6d1d5ab6..00000000000 Binary files a/pages/account_and_service_management/account_information/all_about_username/images/SS_2.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/all_about_username/images/SS_3.png b/pages/account_and_service_management/account_information/all_about_username/images/SS_3.png deleted file mode 100644 index 6b3387b919c..00000000000 Binary files a/pages/account_and_service_management/account_information/all_about_username/images/SS_3.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/all_about_username/images/SS_4.png b/pages/account_and_service_management/account_information/all_about_username/images/SS_4.png deleted file mode 100644 index c3a6fd24649..00000000000 Binary files a/pages/account_and_service_management/account_information/all_about_username/images/SS_4.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/all_about_username/images/SS_5.PNG b/pages/account_and_service_management/account_information/all_about_username/images/SS_5.PNG deleted file mode 100644 index 642b95e6bcc..00000000000 Binary files a/pages/account_and_service_management/account_information/all_about_username/images/SS_5.PNG and /dev/null differ diff --git a/pages/account_and_service_management/account_information/all_about_username/images/SS_6.png b/pages/account_and_service_management/account_information/all_about_username/images/SS_6.png deleted file mode 100644 index eb2a34fdf10..00000000000 Binary files a/pages/account_and_service_management/account_information/all_about_username/images/SS_6.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/all_about_username/images/SS_8.png.jpg b/pages/account_and_service_management/account_information/all_about_username/images/SS_8.png.jpg deleted file mode 100644 index debe4ac4ad7..00000000000 Binary files a/pages/account_and_service_management/account_information/all_about_username/images/SS_8.png.jpg and /dev/null differ diff --git a/pages/account_and_service_management/account_information/all_about_username/images/customercode1.png b/pages/account_and_service_management/account_information/all_about_username/images/customercode1.png deleted file mode 100644 index 0b833c4acca..00000000000 Binary files a/pages/account_and_service_management/account_information/all_about_username/images/customercode1.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/all_about_username/images/newhub1.png b/pages/account_and_service_management/account_information/all_about_username/images/newhub1.png deleted file mode 100644 index 048835b53e1..00000000000 Binary files a/pages/account_and_service_management/account_information/all_about_username/images/newhub1.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/all_about_username/images/newhub2.png b/pages/account_and_service_management/account_information/all_about_username/images/newhub2.png deleted file mode 100644 index b071d76ddb4..00000000000 Binary files a/pages/account_and_service_management/account_information/all_about_username/images/newhub2.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/all_about_username/images/nic-handle-initials.png b/pages/account_and_service_management/account_information/all_about_username/images/nic-handle-initials.png deleted file mode 100644 index 8ad82fc7790..00000000000 Binary files a/pages/account_and_service_management/account_information/all_about_username/images/nic-handle-initials.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/all_about_username/images/nichandle01.png b/pages/account_and_service_management/account_information/all_about_username/images/nichandle01.png deleted file mode 100644 index 324771f7f22..00000000000 Binary files a/pages/account_and_service_management/account_information/all_about_username/images/nichandle01.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/all_about_username/images/nichandle01b.png b/pages/account_and_service_management/account_information/all_about_username/images/nichandle01b.png deleted file mode 100644 index b6bbca895b2..00000000000 Binary files a/pages/account_and_service_management/account_information/all_about_username/images/nichandle01b.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/all_about_username/images/nichandle02.png b/pages/account_and_service_management/account_information/all_about_username/images/nichandle02.png deleted file mode 100644 index 2be61d3dd81..00000000000 Binary files a/pages/account_and_service_management/account_information/all_about_username/images/nichandle02.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/all_about_username/images/nichandle03.png b/pages/account_and_service_management/account_information/all_about_username/images/nichandle03.png deleted file mode 100644 index 68f058dd45b..00000000000 Binary files a/pages/account_and_service_management/account_information/all_about_username/images/nichandle03.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/all_about_username/images/nichandle05.png b/pages/account_and_service_management/account_information/all_about_username/images/nichandle05.png deleted file mode 100644 index 8fa6204098c..00000000000 Binary files a/pages/account_and_service_management/account_information/all_about_username/images/nichandle05.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/all_about_username/images/nichandle06.png b/pages/account_and_service_management/account_information/all_about_username/images/nichandle06.png deleted file mode 100644 index b87763dd005..00000000000 Binary files a/pages/account_and_service_management/account_information/all_about_username/images/nichandle06.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/faq-account-management/guide.de-de.md b/pages/account_and_service_management/account_information/faq-account-management/guide.de-de.md index 1a2deae20d6..10cd2e3cf43 100644 --- a/pages/account_and_service_management/account_information/faq-account-management/guide.de-de.md +++ b/pages/account_and_service_management/account_information/faq-account-management/guide.de-de.md @@ -1,191 +1,366 @@ --- -title: FAQ zur Verwaltung des OVHcloud Accounts -excerpt: Hier finden Sie die häufigsten Fragen zur Verwaltung des OVHcloud Accounts -updated: 2025-04-28 +title: FAQ zur Verwaltung des OVHcloud Kunden-Accounts +excerpt: Hier finden Sie Antworten auf die häufigsten Fragen zur Verwaltung Ihres OVHcloud Kunden-Accounts +updated: 2025-10-30 --- + + ## Ziel -Hier finden Sie die häufigsten Fragen zur Verwaltung Ihres OVHcloud Accounts. +Hier finden Sie die am häufigsten gestellten Fragen zur Verwaltung Ihres OVHcloud Kunden-Accounts. + +## FAQ + +### OVHcloud Kunden-Account erstellen, einloggen und absichern -### Wie kann ich einen OVHcloud Account erstellen? +/// details | Wie erstelle ich einen OVHcloud Kunden-Account? -Die Erstellung eines Accounts ist kostenfrei. Dieser Bereich vereinfacht den Zugriff auf Ihre Informationen und erlaubt die Verwaltung Ihrer Dienstleistungen. Lesen Sie unsere Anleitung [OVHcloud-Konto erstellen](/pages/account_and_service_management/account_information/ovhcloud-account-creation). +Die Erstellung eines Kunden-Accounts ist kostenlos. Dieser Bereich erleichtert den Zugriff auf Ihre Daten und ermöglicht die Verwaltung Ihrer Dienste. Lesen Sie unsere Anleitung: [OVHcloud Kunden-Account erstellen](/pages/account_and_service_management/account_information/ovhcloud-account-creation). > [!success] -> Nachdem Sie Ihren Account erstellt haben, denken Sie daran, ihn durch die Einrichtung einer Zwei-Faktor-Authentifizierung zu sichern. Weitere Informationen finden Sie in unserer Anleitung [OVHcloud-Konto mit Zwei-Faktor-Authentifizierung sichern](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa). +> Nachdem Sie Ihren Account erstellt haben, sollten Sie es durch die Einrichtung einer Zwei-Faktor-Authentifizierung sichern. Weitere Informationen finden Sie in unserer Anleitung: [OVHcloud Kunden-Account mit Zwei-Faktor-Authentifizierung sichern](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa). -### Wo finde ich meine OVHcloud Kundenkennung? +/// -Ihre Kundenkennung steht auf Ihrer letzten Rechnung oben rechts. Sie sieht so aus: “aa00000-ovh”. Die ersten Buchstaben sind meist die Initialen der Person, die den Account erstellt hat. Diese Kundenkennung finden Sie auch in allen E-Mails von OVHcloud, zum Beispiel in Bestätigungs-E-Mails bei der Erstellung eines Accounts, Verlängerungen und neuen Bestellungen. +/// details | Wie kann ich bei der Accounterstellung meine Telefonnummer korrekt eingeben? -Haben Sie Ihre Kundenkennung nicht gefunden? Dann können Sie auf den Link “Kennung oder Passwort vergessen” auf der [Login-Seite](/links/manager) des OVHcloud-Accounts klicken. Geben Sie dann die E-Mail-Adresse an, die mit Ihrem Account verbunden ist. +Geben Sie Ihre Telefonnummer im internationalen Format ein. > [!success] -> Wenn Sie in Ihrem Kundencenter angemeldet sind, sehen Sie Ihre Kundenkennung jederzeit rechts oben neben Ihrem Namen. +> Für "0612/345678" geben Sie also "+49 612345678" ein. "+49" wird automatisch hinzugefügt, wenn Sie Deutschland als Standort ausgewählt haben. -### Ich habe keinen Zugriff mehr auf meinen Kunden-Account. Was soll ich tun? +/// -Wenn Sie sich nicht anmelden oder mit Ihrem Kundencenter verbinden können, kann dies verschiedene Ursachen haben; ein vergessenes Passwort, oder vielleicht können Sie nicht mehr auf Ihre E-Mail-Adresse und Ihr Mobiltelefon zugreifen. Daran kann dann die Identifikation per SMS scheitern. -In diesem Fall empfehlen wir [Ihnen diese Hilfestellung](/pages/account_and_service_management/account_information/ovhcloud-account-login#login-failure) +/// details | Wo finde ich meine OVHcloud Kundenkennung? -### Wie kann ich meine persönlichen Angaben ändern? +Ihre Kundenkennung, auch "NIC-handle" genannt, finden Sie oben rechts auf Ihrer letzten Rechnung. Sie sieht so aus: "aa00000-ovh" (die ersten Buchstaben sind in der Regel die Initialen der Person, die das Konto erstellt hat). Diese Kennung ist auch in allen E-Mails angegeben, die von OVHcloud gesendet werden (Bestätigungsmail für die Kontoerstellung, Bestätigungs- oder Verlängerungs-E-Mails etc.). -Um Ihre persönlichen Angaben anzuzeigen oder zu ändern, loggen Sie sich in Ihr [OVHcloud Kundencenter](/links/manager) ein, klicken Sie oben rechts auf Ihren Namen und dann auf `Zu meinem Account`{.action}. +Wenn Sie Ihre Kennung immer noch nicht gefunden haben, können Sie auf der [Login-Seite](/links/manager) auf den Link "Benutzername oder Passwort vergessen?" klicken. Geben Sie anschließend die E-Mail-Adresse ein, die mit Ihrem Account verknüpft ist. -Im Bereich `Mein Profil`{.action} rechts auf Ihrem Bildschirm (klicken Sie erneut auf Ihren Namen, um das rechte Menü zu schließen) klicken Sie auf `Mein Profil bearbeiten`{.action}. +> [!success] +> Wenn Sie angemeldet sind, können Sie Ihre Benutzerkennung jederzeit oben rechts in Ihrem Kundenbereich finden, indem Sie auf Ihren Namen klicken. -#### Tipps und Tricks +/// -Sie möchten die für Ihren OVHcloud Account hinterlegte Kontakt-E-Mail-Adresse ändern? Sie erhalten zunächst eine Bestätigungs-E-Mail für Ihre Anfrage an die bisher in Ihrem Kundencenter hinterlegte Adresse. Sollten Sie auf diese Adresse keinen Zugriff mehr haben, warten Sie bitte 24 Stunden. Nach Ablauf dieser Frist nehmen wir die Änderungen automatisch vor. +/// details | Wie sichere ich meinen Kunden-Account ab? -### Wie kann ich bei der Accounterstellung meine Telefonnummer korrekt eingeben? +Es gibt mehrere Möglichkeiten, die Sicherheit Ihres Kunden-Accounts zu erhöhen: -Bitte geben Sie Ihre Telefonnummer im internationalen Format an. +- Die Wahl eines [komplexen Passworts und dessen regelmäßige Aktualisierung](/pages/account_and_service_management/account_information/manage-ovh-password) +- Die Einrichtung einer [Zwei-Faktor-Authentifizierung](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa) +- Die Einrichtung einer [IP-Einschränkung](/pages/account_and_service_management/account_information/ovhcloud-control-panel-ip-restriction) -#### Tipps und Tricks +Um auf alle diese Optionen zuzugreifen, melden Sie sich in Ihrem [OVHcloud Kundencenter](/links/manager) an, klicken Sie oben rechts auf Ihren Namen und dann auf `Mein Account`{.action}. -Für “0612/345678” geben Sie also bitte “+49 612345678” ein. “+49” wird automatisch hinzugefügt, wenn Sie Deutschland als Standort ausgewählt haben. +Klicken Sie auf den Tab `Sicherheit`{.action}, um sie anzuzeigen. -### Welche Auswirkungen hat DSGVO auf meine personenbezogenen Daten? +/// -Für detaillierte Informationen zur Datenschutz-Grundverordnung (DSGVO) bezüglich Ihrer beruflichen Aktivitäten oder Ihrer personenbezogenen Daten, empfehlen wir Ihnen die folgenden Links: +/// details | Wie aktiviere ich die Zwei-Faktor-Authentifizierung (2FA) auf meinem OVHcloud Kunden-Account? -- [OVHcloud und der Schutz personenbezogener Daten](https://www.ovhcloud.com/de/personal-data-protection/); -- [DSGVO – Antworten auf Ihre häufigsten Fragen](https://www.ovhcloud.com/de/personal-data-protection/gdpr/). +Sie können eine oder mehrere Methoden der Zwei-Faktor-Authentifizierung aktivieren, um den Zugriff auf Ihr Kundencenter zu sichern und zu kontrollieren. Weitere Einzelheiten finden Sie in unserer Anleitung "[OVHcloud Kunden-Account mit Zwei-Faktor-Authentifizierung sichern](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa)". -### Wie ändere ich mein OVHcloud Passwort? +/// -Gehen Sie auf die Login-Seite für das Kundencenter und wählen Sie “Login oder Passwort vergessen”. Geben Sie Ihre Kundenkennung oder die E-Mail-Adresse, die Ihrem OVHcloud Account als erstes zugeordnet ist, an und klicken Sie dann auf “Absenden”. Sie erhalten danach eine Bestätigungs-E-Mail für die Anfrage an die für Ihren Account hinterlegte Kontakt-E-Mail-Adresse. Lesen Sie die Anweisungen bitte sorgfältig durch und klicken Sie auf den Link in der E-Mail. +/// details | Was tun, wenn ich mich nicht in meinen Kunden-Account einloggen kann? -#### Tipps und Tricks +Haben Sie Ihr Passwort vergessen? Haben Sie keinen Zugriff mehr auf Ihre E-Mail-Adresse? Haben Sie eine Zwei-Faktor-Authentifizierung eingerichtet, aber Ihr Gerät zur Generierung der Codes ist nicht mehr nutzbar? +Für alle diese Fälle finden Sie [Vorgehensweisen in unserer Anleitung](/pages/account_and_service_management/account_information/ovhcloud-account-login#login-failure), die Ihnen helfen, die richtigen Schritte zu unternehmen. -Sollten Sie keinen Zugriff mehr auf Ihre Kontakt-E-Mail-Adresse haben, bitten wir Sie darum, diese auf diesem Wege [herauszufinden](https://www.ovh.de/support/vorgaenge/). -Sollten Sie Ihre Kundenkennung vergessen haben, finden Sie diese rechts oben auf Ihrer letzten Rechnung. Sie setzt sich wie folgt zusammen: „aa00000-ovh“ (die ersten Buchstaben entsprechen meist den Initialen der Person, die den Account erstellt hat). Die Kundenkennung finden Sie ebenfalls in der Bestätigungs-E-Mail zur Erstellung Ihres Accounts sowie in den Bestätigungs-E-Mails zu neuen Bestellungen oder Verlängerungen. +/// -### Wie kann ich meine hinterlegten Kontakte ändern? +/// details | Wie ändere ich das Passwort meines OVHcloud Kunden-Accounts? -Ihn Ihrem Kundencenter können Sie die administrative und technische Verwaltung sowie die Abrechnung Ihrer Dienste auf weitere OVHcloud Kunden-Accounts übertragen. Loggen Sie sich mit Ihr [OVHcloud Kundencenter](/links/manager) ein, klicken Sie oben rechts auf Ihren Namen und dann auf `Meine Kontakte`{.action}. +Melden Sie sich in Ihrem [OVHcloud Kundencenter](/links/manager) an, klicken Sie oben rechts auf Ihren Namen und dann auf `Zu meinem Account`{.action}. + +Klicken Sie auf den Tab `Sicherheit`{.action}, dann auf den Button `Ändern`{.action} rechts neben **Passwort**. Sie können anschließend Ihr aktuelles Passwort ändern. Eine Sicherheitsmeldung wird angezeigt, um Sie zu informieren, dass Sie sich für eine Passwortänderung entschieden haben. Nach Ihrer Bestätigung erhalten Sie eine E-Mail (an die in Ihrem Account angegebene Haupt-E-Mail-Adresse), die die Vorgehensweise enthält. + +Weitere Informationen finden Sie in unserer Anleitung "[Passwort Ihres Kunden-Accounts ändern](/pages/account_and_service_management/account_information/manage-ovh-password)". + +> [!success] +> **Sie erinnern sich nicht mehr an Ihr Passwort?** +> +> Gehen Sie zur [Login-Seite Ihres OVHcloud Kundencenters](/links/manager) und klicken Sie auf `Benutzername oder Passwort vergessen`{.action}. Geben Sie Ihren Benutzernamen oder die Haupt-E-Mail-Adresse ein, die mit Ihrem OVHcloud Kunden-Account verknüpft ist, und klicken Sie auf `Senden`{.action}. Eine E-Mail wird an die Kontakt-E-Mail-Adresse des Kunden-Accounts gesendet, um die Anfrage zu bestätigen. Lesen Sie die Anweisungen sorgfältig und klicken Sie auf den darin enthaltenen Link. +> +> Wenn Sie nicht mehr auf diese E-Mail-Adresse zugreifen können, aber auf Ihre Ersatz-E-Mail-Adresse zugreifen können, erstellen Sie einen [Support-Ticket über das Help Center](https://help.ovhcloud.com/csm?id=csm_get_help), um Ihre Haupt-E-Mail-Adresse durch Ihre sekundäre E-Mail-Adresse zu ersetzen. +> +> Wenn Sie weder auf Ihre E-Mail-Adresse noch auf Ihr OVHcloud Kundencenter zugreifen können oder keine Ersatz-E-Mail-Adresse haben, müssen Sie [diese Vorgehensweise](/links/transversal/procedure-email-change) befolgen. +> +> Wenn Sie Ihre Kundenkennung vergessen haben, finden Sie sie oben rechts auf Ihrer letzten Rechnung. Sie sieht so aus: "aa00000-ovh" (die ersten Buchstaben sind in der Regel die Initialen der Person, die den Account erstellt hat). Die Kundenkennung ist auch in der E-Mail-Bestätigung der Account-Erstellung sowie in den E-Mails zur Bestätigung oder Verlängerung Ihrer Bestellungen angegeben. +> -Die Übertragung für den jeweiligen Dienst muss sowohl vom Administrator des Dienstes als auch vom neuen Kontakt per E-Mail bestätigt werden. +/// -Bevor Sie eine Änderung vornehmen, vergewissern Sie sich bitte, dass alle Kontakt-E-Mail-Adressen gültig sind. Andernfalls kann Ihrer Anfrage nicht entsprochen werden. +/// details | Gibt es eine Begrenzung für Passwort-Änderungen meines OVHcloud Kunden-Accounts (über die Option "Benutzername oder Passwort vergessen")? -Möchten Sie einen Domainnamen abrufen, als dessen Inhaber Sie bei der Registry registriert sind? Überprüfen können Sie diese Angaben auf [www.ovh.com/de/cgi-bin/tools/check_whois.pl](https://www.ovh.com/de/cgi-bin/tools/check_whois.pl) Wenn Sie aber keinen Zugriff auf den Administrator-Kundenaccount haben, folgen Sie bitte diesem Verfahren: [www.ovh.de/cgi-bin/de/procedure/procedureChangeContacts.cgi](https://www.ovh.de/cgi-bin/de/procedure/procedureChangeContacts.cgi). +OVHcloud legt keine Grenze für die Anzahl der Passwortänderungen fest. -#### Gut zu wissen +Allerdings sendet unser System die E-Mails an Ihre Kontakt-E-Mail-Adresse, und es ist möglich, dass Ihr E-Mail-Anbieter den Posteingang blockiert, wenn Sie in kurzer Zeit viele Passwortänderungen anfordern. -Weitere Informationen zur Kontaktverwaltung finden Sie [hier](/pages/account_and_service_management/account_information/managing_contacts#auf-die-kontaktverwaltung-zugreifen). +/// -### Wie kann ich einen Rechnungskontakt einstellen oder ändern? +/// details | Ich habe die Zwei-Faktor-Authentifizierung auf meinem Konto nicht aktiviert, aber ich werde dennoch nach einem Code gefragt. Wie deaktiviere ich dies? -Loggen Sie sich mit Ihr [OVHcloud Kundencenter](/links/manager) ein, klicken Sie oben rechts auf Ihren Namen und dann auf `Meine Kontakte`{.action}. +Selbst wenn die Zwei-Faktor-Authentifizierung auf Ihrem Account nicht aktiviert ist, kann ein Bestätigungscode angefordert werden, um Ihre Identität zu überprüfen. Diese Maßnahme dient dazu, Ihren Account und Ihre Daten zu schützen, und kann nicht deaktiviert werden. + +Der Sicherheitscode wird an die **Haupt-E-Mail-Adresse** gesendet, die Sie in Ihrem Account angegeben haben. + +Wenn Sie den Code nicht finden, prüfen Sie die Ordner "Spam" / "Junk" Ihrer E-Mail-Adresse. > [!success] -> Lesen Sie für mehr Informationen zur Kontaktverwaltung die folgende Anleitung: [Verwaltung der Kontakte Ihrer Dienste](/pages/account_and_service_management/account_information/managing_contacts) +> - Die Aktivierung der Zwei-Faktor-Authentifizierung auf Ihrem Account ermöglicht es Ihnen, das Gerät auszuwählen, das Sie verwenden möchten (Telefon, Tablet, Smartphone, U2F-Schlüssel), um einen Authentifizierungscode zu empfangen. Weitere Informationen finden Sie in unserer Anleitung "[OVHcloud Kunden-Account mit Zwei-Faktor-Authentifizierung sichern](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa)". +> - Sie können auch eine zusätzliche Sicherheitsmaßnahme einrichten, um den Zugriff auf Ihr OVHcloud Kunden-Account auf eine oder mehrere IP-Adressen zu beschränken. Weitere Informationen finden Sie in unserer Anleitung "[Zugriff über IP-Adresse auf Ihr OVHcloud Kundencenter beschränken](/pages/account_and_service_management/account_information/ovhcloud-control-panel-ip-restriction)". -### Wie kann ich meinen Account schützen? +/// -Es stehen Ihnen mehrere Lösungen zur Absicherung Ihres Accounts zur Verfügung, zum Beispiel: +/// details | Wie deaktiviere ich die Zwei-Faktor-Authentifizierung (2FA) auf meinem OVHcloud Kunden-Account? -- die Wahl eines komplexen Passworts -- die regelmäßige Verlängerung des Passworts -- Zwei-Faktor-Authentifizierung +Wenn Sie Ihr Gerät (Mobilgerät / Sicherheitsschlüssel), das für die Zwei-Faktor-Authentifizierung verwendet wird, nicht mehr nutzen können,haben Sie die folgenden Möglichkeiten: -Um auf alle diese Optionen zuzugreifen, loggen Sie sich in Ihr [OVHcloud Kundencenter](/links/manager) ein, klicken Sie oben rechts auf Ihren Namen und dann auf `Zu meinem Account`{.action}. +- Die [Notfallcodes](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#codes) verwenden, die Sie gespeichert haben. +- Ein anderes Gerät für die Zwei-Faktor-Authentifizierung verwenden, falls Sie mehrere aktiviert haben. +- Die Zwei-Faktor-Authentifizierung [deaktivieren](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#desactivation). -Klicken Sie auf den Tab `Sicherheit`{.action}, um sie anzuzeigen. +Lesen Sie den Abschnitt "[Was tun, wenn eines meiner Geräte verloren, gestohlen oder nicht mehr funktioniert?](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#lost-device)" oder den Abschnitt "[Zwei-Faktor-Authentifizierung vollständig deaktivieren](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#desactivation)" unserer Anleitung zur Zwei-Faktor-Authentifizierung. + +/// -Für mehr Informationen sehen Sie das [Video](https://www.youtube.com/watch?v=odO58c4gJfc&list=PL0DynEzr_sE5MnOfJOpVJN-EhfMDWoqGS&index=24). +### Persönliche Informationen verwalten -### Wie aktiviere ich die Zwei-Faktor-Authentifizierung (2FA) von OVHcloud? +/// details | Wie ändere ich meine persönlichen Informationen? -Nachdem Sie Ihr Kundenkonto bei OVHcloud erstellt haben, empfehlen wir Ihnen -Ihre persönlichen Daten zu sichern. Aktivieren Sie dazu die Zwei-Faktor- -Authentifizierung. Loggen Sie sich in Ihr [OVHcloud Kundencenter](/links/manager) ein, klicken Sie oben rechts auf Ihren Namen und dann auf `Zu meinem Account`{.action}. +Um Ihre Kontaktdaten anzuzeigen oder zu ändern, melden Sie sich in Ihrem [OVHcloud Kundencenter](/links/manager) an, klicken Sie oben rechts auf Ihren Namen und dann auf `Zu meinem Account`{.action}. -Klicken Sie danach auf `Sicherheit`{.action}. -Sie haben mehrere Möglichkeiten, um sich zu authentifizieren und die 2FA zu aktivieren: +Klicken Sie anschließend auf `Profil bearbeiten`{.action} im Bereich `Mein Profil`. -- Per SMS mit einem Sicherheitscode -- Über eine mobile Applikation, die kompatibel zu Android, iPhone und Windows Mobile ist -- Mit einem U2F-kompatiblen Sicherheitsschlüssel +> [!success] +> **Möchten Sie die E-Mail-Adresse Ihres OVHcloud Kunden-Accounts ändern?** +> +> Zunächst wird Ihnen eine Bestätigungsanfrage an die aktuelle E-Mail-Adresse gesendet, die Sie in Ihrem Kundencenter angegeben haben. Wenn Sie nicht mehr auf diese E-Mail-Adresse zugreifen können, ist eine Wartezeit von 24 Stunden erforderlich. Nach Ablauf dieser Zeit wird die Änderung automatisch vorgenommen. +> -[Mehr erfahren](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa). +/// -### Wie kann ich die Zwei-Faktor-Authentifizierung (2FA) von OVHcloud deaktivieren? +/// details | Wie greife ich auf Verträge und allgemeine Geschäftsbedingungen zu? -Wenn Sie die Zwei-Faktor-Authentifizierung deaktivieren möchten, loggen Sie sich in Ihr [OVHcloud Kundencenter](/links/manager) ein, klicken Sie oben rechts auf Ihren Namen und dann auf `Zu meinem Account`{.action}. +Sie können die Verträge zu Ihren OVHcloud Diensten direkt in Ihrem [Kundencenter](/links/manager) finden. Melden Sie sich an und gehen Sie zum Menü `Zu meinem Account`{.action}, klicken Sie dann auf `Meine Verträge ansehen`{.action}. -Klicken Sie auf den Tab `Sicherheit`{.action}. +Sie können die Verträge auch auf unserer Website über [diesen Link](/links/terms-conditions-contracts) einsehen. -Hier können Sie die verschiedenen Sicherheitsvorkehrungen einzeln deaktivieren.  -Haben Sie Ihr Gerät zur Zwei-Faktor-Authentifizierung nicht mehr, und daher keinen Zugang zu Ihrem Kundencenter? Dann wenden Sie sich bitte an den OVHcloud Kundendienst. Ein Mitarbeiter wird das Gerät manuell deaktivieren, nachdem Sie sich ausgewiesen haben. +Diese Seite enthält alle notwendigen Informationen zu unseren Verträgen, einschließlich der Bedingungen und Konditionen unserer Dienstleistungen. -### Was kann ich tun, wenn mein OVHcloud Account gehackt wurde? +/// -Sollte Ihr OVHcloud Account missbräuchlich verwendet werden (Kundenkennung, Zahlungsmittel...), wenden Sie sich bitte umgehend an die zuständige Polizeibehörde, um Anzeige zu erstatten. +/// details | Welche Auswirkungen hat DSGVO auf meine persönlichen Daten? -Die Behörde wird Sie daraufhin kontaktieren und die Anzeige gemeinsam mit Ihnen aufnehmen. Sobald Sie Anzeige erstattet haben, senden Sie uns bitte ein Kopie der Anzeige zu. Wir können dann interne Schritte einleiten. +Für detaillierte Informationen zur Datenschutz-Grundverordnung (DSGVO) bezüglich Ihrer beruflichen Aktivitäten oder Ihrer personenbezogenen Daten, besuchen Sie die folgenden Seiten: -Ihre Kundenkennung wird infolgedessen blockiert. Missbräuchlich bestellte Dienste werden wir löschen und Ihnen die Zahlungen automatisch rückerstatten. +- [OVHcloud und der Schutz personenbezogener Daten](/links/transversal/personal-data-protection) +- [DSGVO – Antworten auf Ihre häufigsten Fragen](/links/transversal/personal-data-protection-faq) + +/// + +/// details | Kann ich meine Kundenkennung manuell ändern? Ich möchte andere Buchstaben oder Zahlen. + +Der Kundenkennung kann nicht geändert werden, da sie mit den Angaben verknüpft ist, die Sie bei der Erstellung Ihres OVHcloud Kunden-Accounts gemacht haben. Die ersten beiden Buchstaben entsprechen in der Regel den Initialen des Administrators, während die folgenden Zahlen zufällig generiert werden. + +Sie können jedoch einen [neuen OVHcloud Kunden-Account erstellen](/pages/account_and_service_management/account_information/ovhcloud-account-creation). Anschließend müssen Sie jedoch alle Ihre Dienste manuell in diesen Account übertragen, indem Sie den [Kontaktwechsel-Prozess](/pages/account_and_service_management/account_information/managing_contacts) befolgen. + +/// + +/// details | Kann ich die Tochtergesellschaft meines OVHcloud Kunden-Accounts ändern? + +Wenn Sie einen OVHcloud Kunden-Account in der falschen Tochtergesellschaft erstellt haben, können Sie einen neuen Account in der richtigen Tochtergesellschaft mit denselben persönlichen Informationen erstellen. + +Allerdings müssen Sie eine andere Kontakt-E-Mail-Adresse verwenden, da es nicht möglich ist, zwei verschiedene OVHcloud Accounts mit derselben Kontakt-E-Mail-Adresse zu haben. + +Weitere Informationen zur Erstellung eines OVHcloud Kunden-Accounts finden Sie in unserer Anleitung "[OVHcloud Kunden-Account erstellen](/pages/account_and_service_management/account_information/ovhcloud-account-creation)". + +Nachdem Sie Ihren OVHcloud Kunden-Account in der richtigen Tochtergesellschaft erstellt haben, können Sie die Anweisungen in [dieser Anleitung](/pages/account_and_service_management/account_information/managing_contacts) befolgen, um Ihre Dienste von einem Account zum anderen zu übertragen. + +Wenn Sie einen OVHcloud Kunden-Account in unserer kanadischen Infrastruktur (d. h. in einem Land außerhalb Europas) besitzen, können Sie keine Dienste zwischen Accounts verschieben. In diesem Fall müssen Sie neue Dienste im neuen Account bestellen und Ihre Inhalte ggf. manuell migrieren. + +Für weitere Informationen wenden Sie sich an unseren Support, indem Sie ein [Support-Ticket über das OVHcloud Help Center erstellen](https://help.ovhcloud.com/csm?id=csm_get_help). + +/// + +/// details | Wie lösche ich meinen OVHcloud Kunden-Account? + +Die Schließung Ihres OVHcloud Kunden-Accounts und die Löschung Ihrer persönlichen Daten ist nur unter folgenden Voraussetzungen möglich: + +1. Sie haben keine Dienste mehr in der Bereich "[Meine Dienste](https://www.ovh.com/manager/dedicated/#/billing/autoRenew)". Falls nicht, müssen Sie diese Dienste zunächst stornieren und auf deren Löschung warten. +2. Sie haben keine ausstehenden Rechnungen. Falls doch, müssen Sie diese über den Button `Jetzt bezahlen`{.action} in den Massenaktionen auf der Seite "[Meine Rechnungen](https://www.ovh.com/manager/#/dedicated/billing/history)" begleichen. +3. Sie haben keine laufenden Bestellungen. Überprüfen Sie dies auf [dieser Seite](https://www.ovh.com/manager/#/dedicated/billing/orders/orders). +4. Ihr Prepaid-Konto ist ausgeglichen (Saldo 0,00€). Überprüfen Sie dies auf [dieser Seite](https://www.ovh.com/manager/#/dedicated/billing/payment/ovhaccount). + +Wenn alle oben genannten Bedingungen erfüllt sind, können Sie die Löschung Ihres OVHcloud Kunden-Accounts und der damit verbundenen Daten beantragen, indem Sie die folgenden Schritte ausführen: + +1. Melden Sie sich im [OVHcloud Help Center](https://help.ovhcloud.com/csm?id=csm_get_help) an. +1. Wählen Sie `Ihren OVHcloud Kunden-Account verwalten`{.action} aus. +1. Geben Sie `Ich möchte meinen OVHcloud Kunden-Account schließen`{.action} an und folgen Sie den Schritten. + +/// -Damit Sie Ihren Account wieder nutzen können, werden wir Sie dazu auffordern, Ihre E-Mail-Adresse und/oder Ihr Passwort über den folgenden Link zu ändern: [www.ovh.de/cgi-bin/de/procedure/procedureChangeEmail.cgi](https://www.ovh.de/cgi-bin/de/procedure/procedureChangeEmail.cgi). +### Verwalten von Benachrichtigungen und Logs -### Ich habe eine E-Mail erhalten, die ein Versuch von Phishing sein könnte. Angeblich kommt sie von OVHcloud. Wie kann ich eine Überprüfung veranlassen? +/// details | Kann ich alle Benachrichtigungen von OVHcloud an mehrere E-Mail-Adressen senden lassen? -Wie Sie einen Phishing-Versuch durch eine E-Mail oder eine SMS identifizieren und melden können, erfahren Sie in unserer [Anleitung](/pages/account_and_service_management/account_information/phishing_care). +Leider ist es nicht möglich, E-Mails an mehrere Adressen zu senden. -### Wie kann ich als Opfer missbräuchliches Verhalten oder rechtswidrige Inhalte melden, für die bei OVHcloud gehostete Dienste genutzt werden? +Im [OVHcloud Kundencenter](/links/manager) können Sie jedoch eine Ersatz-E-Mail-Adresse konfigurieren, die nicht für den Empfang aller Kommunikationen (Verlängerungen, Dienstlöschungen etc.) verwendet wird. -Jegliches missbräuchliche Verhalten und illegale Inhalte können Sie auf der eigens dafür eingerichteten Plattform von OVHcloud melden: [www.ovh.com/abuse/](https://www.ovh.com/abuse/). Wählen Sie bitte die entsprechende Kategorie und füllen Sie die erforderlichen Felder aus. +Diese Ersatz-E-Mail-Adresse ist nützlich, um den Login zu ermöglichen falls Sie den Zugriff auf Ihre primäre E-Mail-Adresse verlieren. -Dem Inhaber des jeweiligen Dienstes dürfen nur Logs und technische Daten übermittelt werden. Bitte achten Sie daher darauf, in diesen Feldern keine personenbezogenen Angaben zu machen. +/// -### Was passiert, nachdem ich einen Missbrauch gemeldet habe? +/// details | Ich habe eine Benachrichtigung in der falschen Sprache erhalten. Wie kann ich das korrigieren? -Die Rechtsabteilung von OVHcloud bearbeitet Ihre Meldung schnellstmöglich und analysiert Ihre Beschwerde. Auf dieser Grundlage teilen wir Ihnen im Anschluss weiterführende Informationen mit. Wird das missbräuchliche Verhalten eines unserer Kunden bestätigt, werden wir Sie darüber informieren. Bei den fraglichen Personen wirken wir darauf hin, dieses Verhalten unverzüglich einzustellen. +Sie können die Sprache unserer automatisierten E-Mails wie folgt ändern: -### OVHcloud hat mir eine E-Mail zu potenziell missbräuchlichem Verhalten meinerseits zugesandt. Was soll ich tun? +1. Melden Sie sich in Ihrem [OVHcloud Kundencenter](/links/manager) an. +1. Gehen Sie anschließend zum [OVHcloud Help Center](https://help.ovhcloud.com/csm?id=csm_get_help). +1. Klicken Sie auf `Zum Help Center`{.action} und bestätigen Sie Ihre Anmeldung. +1. Klicken Sie auf die Flagge oben rechts und wählen Sie die Region aus, die der gewünschten Sprache entspricht. +1. Klicken Sie auf `Beim Help Center abmelden`{.action}. + +Anschließend werden die nächsten automatisierten E-Mail-Benachrichtigungen in der gewünschten Sprache gesendet. + +/// + +/// details | Kann ich alle Aktionen, die im Kundencenter durchgeführt wurden, einsehen? Gibt es Logs? + +Ja, Sie können auf die Logs der Aktionen, die auf Ihrem Account durchgeführt wurden, zugreifen. + +Nutzen Sie ggf. unsere Anleitung zur [OVHcloud API](/pages/manage_and_operate/api/first-steps), und loggen Sie sich mit den Zugangsdaten Ihres Kunden-Accounts in der [OVHcloud API-Konsole](/links/api) ein. Verwenden Sie dann den folgenden Aufruf, um die Logs einzusehen: + +> [!api] +> +> @api {v1} /me GET /me/api/logs/self +> + +Sie erhalten die Liste der Log-IDs. Anschließend können Sie den folgenden API-Aufruf verwenden, um die Details eines bestimmten Logss abzurufen: + +> [!api] +> +> @api {v1} /me GET /me/api/logs/self/{logId} +> + +Ersetzen Sie `{logId}` durch die Log-ID, die Sie abrufen möchten. In der Rückmeldung des Aufrufs können Sie die Aktionen, die im Kundencenter durchgeführt wurden, einsehen. + +/// + +### Zugriff auf Dienste delegieren + +/// details | Wie kann ich den Zugriff auf meine Dienste an andere Personen delegieren? + +Sie können anderen Kunden-Accounts die administrative, technische und Rechnungsverwaltung Ihrer Dienste zuweisen. Dazu melden Sie sich in Ihrem [OVHcloud Kundencenter](/links/manager) an, klicken Sie auf Ihren Namen oben rechts und dann auf `Meine Kontakte`{.action}. + +Die Dienstdelegierung muss per E-Mail sowohl vom Dienstadministrator als auch vom neuen Kontakt bestätigt werden. + +Bevor Sie Änderungen vornehmen, stellen Sie sicher, dass alle Kontaktadressen gültig sind, andernfalls kann die Anfrage nicht abgeschlossen werden. + +Um die Verwaltung eines Domainnamens dessen Inhaber Sie sind (zu prüfen über [unser Whois-Tool](/links/web/domains-whois)), zu erlangen, wenn Sie keinen Zugriff auf den entsprechenden Administrator-Kontakt haben, empfehlen wir, [diese Vorgehensweise](/links/transversal/procedure-contact-change) zu befolgen. + +> [!success] +> Unsere Anleitung zur Verwaltung von Kontakten ist [hier](/pages/account_and_service_management/account_information/managing_contacts) verfügbar. + +/// + +/// details | Wie kann ich einen Rechnungskontakt konfigurieren oder ändern? + +Melden Sie sich in Ihrem [OVHcloud Kundencenter](/links/manager) an, klicken Sie auf Ihren Namen oben rechts und dann auf `Meine Kontakte`{.action}. + +> [!success] +> Wenn Sie weitere Informationen zur Verwaltung von Kontakten benötigen, empfehlen wir Ihnen, unsere Anleitung zu konsultieren: "[Kontakte zu Ihren Diensten verwalten](/pages/account_and_service_management/account_information/managing_contacts)". + +/// + +/// details | Kann ich meine Dienste in einem Schritt auf einen anderen OVHcloud Kunden-Account übertragen? + +Um alle Ihre Dienste auf einen anderen OVHcloud Kunden-Account zu übertragen, empfehlen wir Ihnen, [unseren technischen Support zu kontaktieren](https://help.ovhcloud.com/csm?id=csm_get_help). Unsere Teams können Sie während des gesamten Prozesses begleiten und Ihnen bei der Massenübertragung Ihrer Dienste auf den neuen Kunden-Account helfen. + +/// + + +### Melden von betrügerischen Aktivitäten oder Hackerangriffen + +/// details | Was tun, wenn mein OVHcloud Kunden-Account gehackt wurde? + +Sollte Ihr OVHcloud Kunden-Account missbräuchlich verwendet werden (Identität, Zahlungsmittel, etc.), wenden Sie sich bitte umgehend an die zuständige Polizeibehörde, um Anzeige zu erstatten. + +Sobald Sie Anzeige erstattet haben, senden Sie uns bitte ein Kopie der Anzeige zu. Wir können dann interne Schritte einleiten. + +Ihre Kundenkennung wird infolgedessen blockiert. Missbräuchlich bestellte Dienste werden wir löschen und Ihnen die Zahlungen automatisch rückerstatten. -Wenn uns ein missbräuchliches Verhalten gemeldet oder von unseren Teams festgestellt wird, erhalten Sie eine E-Mail. Das Format der E-Mail-Adresse ist “ticket+"ticket-nummer"@abuse.ovh.net”. +Kontaktieren Sie den OVHcloud Support telefonisch: -In Anbetracht der Einzelheiten, die Sie in der E-Mail erfahren werden, werden wir Sie bitten, den Angaben nachzugehen, etwaiges missbräuchliches Verhalten einzustellen und jegliche rechtswidrigen Inhalte zu löschen. +- Deutschland: +49 681 906730 -Wir empfehlen Ihnen, die Absicherung Ihrer Dienste zu überprüfen. Lassen Sie sich von diesen Anleitungen unterstützen, um auszuschließen, dass Ihre Dienste gehackt wurden und unter dem Einfluss Dritter stehen: +Damit Sie Ihren Account wieder nutzen können, werden wir Sie dazu auffordern, Ihre E-Mail-Adresse und/oder Ihr Passwort über [diese Vorgehensweise](/links/transversal/procedure-email-change), um wieder Zugriff auf Ihren Account zu erhalten. -- [Den OVHcloud Account absichern und persönliche Informationen verwalten](/pages/account_and_service_management/account_information/all_about_username) -- [Das Passwort Ihres Accounts ändern](/pages/account_and_service_management/account_information/manage-ovh-password) -- [Den OVHcloud Account mit der Zwei-Faktor-Authentifizierung absichern](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa) -- [Die Sicherheit Ihrer Website optimieren](/pages/web_cloud/web_hosting/secure_your_website) -- [VPS absichern](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps) -- [Einen dedizierten Server absichern](/pages/bare_metal_cloud/dedicated_servers/securing-a-dedicated-server) +/// -### Wie kann ich vermeiden, dass meine Dienste blockiert werden, wenn eine potenzielle missbräuchliche Verwendung eines meiner OVHcloud Dienste festgestellt wird? +/// details | Ich habe eine E-Mail erhalten, die Phishing sein könnte. Angeblich kommt sie von OVHcloud. Wie kann ich eine Überprüfung veranlassen? -Ergreifen Sie die erforderlichen Maßnahmen und antworten Sie dann bitte direkt auf die E-Mail unserer Abteilung “Abuse”. Legen Sie darin bitte diese Maßnahmen dar. -Ein Mitarbeiter aus unserem Team wird Ihnen dann schnellstmöglich antworten. +Um verdächtige E-Mails oder SMS zu identifizieren und zu melden, konsultieren Sie [unsere Anleitung zu Phishing](/pages/account_and_service_management/account_information/phishing_care). -### Ich habe der Abteilung “Abuse” von OVHcloud geantwortet, aber mein Dienst ist immer noch blockiert. Was kann ich tun? +/// -Sie haben die Möglichkeit, in Ihrem [OVHcloud Help Center](https://help.ovhcloud.com/csm?id=csm_get_help) eine Support-Anfrage zu stellen und so weitere Informationen zur Bearbeitung Ihres Abuse-Tickets einzuholen. Sie erleichtern und beschleunigen die Bearbeitung Ihrer Support-Anfrage, wenn Sie darin die Referenznummer dieses Abuse-Tickets angeben. +/// details | Wie melde ich Missbrauch oder unzulässige Inhalte auf von OVHcloud gehosteten Diensten? -### Wie kann ich meinen OVHcloud Kunden-Account löschen? +Finden Sie Antworten auf Fragen zur Meldung von betrügerischem Verhalten oder unzulässigem Inhalt in unserer [FAQ zum OVHcloud Support](/pages/account_and_service_management/account_information/faq-support). -Die Schließung Ihres OVHcloud Kunden-Accounts und die Löschung Ihrer personenbezogenen Daten ist nur unter diesen Voraussetzungen möglich: +/// -1. Sie haben keine Dienstleistungen mehr im Bereich "[Meine Dienste](https://www.ovh.com/manager/dedicated/#/billing/autoRenew)". Ist dies nicht der Fall, müssen Sie zunächst deren Kündigung beantragen und auf deren Löschung warten. -2. Sie haben keine ausstehenden Rechnungen. Ist das nicht der Fall, müssen Sie die Zahlung vornehmen, indem Sie in den Massenaktionen auf der Seite "[Meine Rechnungen](https://www.ovh.com/manager/#/dedicated/billing/history)" auf den Button `Sofort zahlen`{.action} klicken. -3. Sie haben keine laufenden Bestellungen. Prüfen Sie diese auf [dieser Seite](https://www.ovh.com/manager/#/dedicated/billing/orders/orders). -4. Ihr Prepaid-Konto ist ausgeglichen (Saldo 0,00€). Prüfen Sie dies auf [dieser Seite](https://www.ovh.com/manager/#/dedicated/billing/payment/ovhaccount). +/// details | OVHcloud hat mir eine E-Mail geschickt, in der von einem möglichen betrügerischen Verhalten meinerseits die Rede ist, was soll ich tun? -Wenn die oben genannten Bedingungen erfüllt sind, können Sie die Löschung Ihres OVHcloud Accounts und der zugehörigen Daten beantragen, indem Sie folgende Schritte ausführen: +Finden Sie Antworten auf Fragen zur Meldung von betrügerischem Verhalten oder unzulässigem Inhalt in unserer [FAQ zum OVHcloud Support](/pages/account_and_service_management/account_information/faq-support). -1. Loggen Sie sich ein und gehen Sie zum [OVHcloud Help Center](https://help.ovhcloud.com/csm?id=csm_get_help). -2. Klicken Sie auf den Button `Ticket erstellen`{.action}. -3. Wählen Sie den Zweck `Verwalten Sie IhrenOVHcloud Kunden-Account`{.action} aus. -4. Geben Sie `Ich möchte meinen OVHcloud Account schließen`{.action} an und folgen Sie den angezeigten Schritten. +/// ## Weiterführende Informationen -Treten Sie unserer [User Community](/links/community) bei. \ No newline at end of file +Treten Sie unserer [User Community](/links/community) bei. diff --git a/pages/account_and_service_management/account_information/faq-account-management/guide.en-asia.md b/pages/account_and_service_management/account_information/faq-account-management/guide.en-asia.md index 5f4cd4e86e7..f36f43d6868 100644 --- a/pages/account_and_service_management/account_information/faq-account-management/guide.en-asia.md +++ b/pages/account_and_service_management/account_information/faq-account-management/guide.en-asia.md @@ -1,20 +1,50 @@ --- title: OVHcloud account management FAQ excerpt: Find the most frequently asked questions about managing your OVHcloud account -updated: 2025-09-12 +updated: 2025-10-30 --- @@ -24,7 +54,7 @@ Here are the most frequently asked questions about managing your OVHcloud accoun ## FAQ -### Creating an OVHcloud account, loggin in, and securing it +### Creating an OVHcloud account, logging in, and securing it /// details | How do I create an OVHcloud account? @@ -80,12 +110,13 @@ You can find more information in our guide [Changing your account password](/pag > **Can't remember your password?** > > Go to the [login page for your Control Panel](/links/manager) and click `Forgot username or password?`{.action}. Enter your NIC handle or the primary email address associated with your OVHcloud account, then click `Submit`{.action}. An email is then sent to the account’s contact email address, to confirm the request. Please read the instructions carefully and click on the link in it. - -If you no longer have access to this address but have access to your alternate email address, create a [help ticket via the Help Center](https://help.ovhcloud.com/csm?id=csm_get_help) to replace your primary email address with the backup email address. - -If you do not have access to your email address, the OVHcloud Control Panel, or a backup email address, you will need to follow [this procedure](links/transversal/procedure-email-change). - -If you have forgotten your NIC handle, you can find it in the top right-hand corner of your last bill. It looks like this: "aa00000-ovh" (the first letters are usually the initials of the person who created the account). You will also find this ID in the email confirming that you have created your account, as well as in the emails of orders confirmation or renewal. +> +> If you no longer have access to this address but have access to your alternate email address, create a [help ticket via the Help Center](https://help.ovhcloud.com/csm?id=csm_get_help) to replace your primary email address with the backup email address. +> +> If you do not have access to your email address, the OVHcloud Control Panel, or a backup email address, you will need to follow [this procedure](/links/transversal/procedure-email-change). +> +> If you have forgotten your NIC handle, you can find it in the top right-hand corner of your last bill. It looks like this: "aa00000-ovh" (the first letters are usually the initials of the person who created the account). You will also find this ID in the email confirming that you have created your account, as well as in the emails of orders confirmation or renewal. +> /// @@ -119,7 +150,7 @@ If your device (mobile phone/smartphone/security key) used for two-factor authen - use another two-factor authentication device, if you have enabled several; - [disable two-factor authentication](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#deactivation). -Check out the ["What do I do if I lose one of my devices, or if it stops working? "](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#lost-device) or the ["Disabling two-factor authentication completely "](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#deactivation) sections of our guide on two-factor authentication. +Check out the "[What do I do if I lose one of my devices, or if it stops working?](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#lost-device)" or the "[Disabling two-factor authentication completely](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#deactivation) sections of our guide on two-factor authentication." /// @@ -195,9 +226,8 @@ Closing your OVHcloud customer account and deleting your personal data is only p If the above conditions are met, you can request to delete your OVHcloud account and the related data by following these steps: 1. Log in to the [OVHcloud Help Centre](https://help.ovhcloud.com/csm?id=csm_get_help). -2. Click the `Create ticket`{.action} button. -3. Select the reason `Manage your OVHcloud customer account`{.action}. -4. Specify `I want to close my OVHcloud account`{.action} and follow the steps described. +1. Select the reason `Manage your OVHcloud customer account`{.action}. +1. Specify `I want to close my OVHcloud account`{.action} and follow the steps described. /// @@ -259,10 +289,10 @@ The service delegation must be validated via email both by the service administr Before you make any changes, please ensure that all contact email addresses are valid, otherwise the request will not be successful. -If you would like to retrieve a domain name that you are the registered owner of from the registry (you can check this information using our own [whois tool](/links/web/domains-whois)), but you do not have access to the administrator customer account, please follow [this procedure](/links/transversal/procedure-contact-change) +If you would like to retrieve a domain name that you are the registered owner of from the registry (you can check this information using our own [whois tool](/links/web/domains-whois)), but you do not have access to the administrator customer account, please follow [this procedure](/links/transversal/procedure-contact-change). > [!success] -> A full contact management guide is available here: [/pages/account_and_service_management/account_information/managing_contacts#access-contact-management](/pages/account_and_service_management/account_information/managing_contacts#access-contact-management) +> A full contact management guide is available here: [Managing contacts for your services](/pages/account_and_service_management/account_information/managing_contacts). /// diff --git a/pages/account_and_service_management/account_information/faq-account-management/guide.en-au.md b/pages/account_and_service_management/account_information/faq-account-management/guide.en-au.md index 0ab0c62d9ed..6d2607a5b4d 100644 --- a/pages/account_and_service_management/account_information/faq-account-management/guide.en-au.md +++ b/pages/account_and_service_management/account_information/faq-account-management/guide.en-au.md @@ -1,20 +1,50 @@ --- title: OVHcloud account management FAQ excerpt: Find the most frequently asked questions about managing your OVHcloud account -updated: 2025-09-12 +updated: 2025-10-30 --- @@ -24,7 +54,7 @@ Here are the most frequently asked questions about managing your OVHcloud accoun ## FAQ -### Creating an OVHcloud account, loggin in, and securing it +### Creating an OVHcloud account, logging in, and securing it /// details | How do I create an OVHcloud account? @@ -79,12 +109,13 @@ You can find more information in our guide [Changing your account password](/pag > **Can't remember your password?** > > Go to the [login page for your Control Panel](/links/manager) and click `Forgot username or password?`{.action}. Enter your NIC handle or the primary email address associated with your OVHcloud account, then click `Submit`{.action}. An email is then sent to the account’s contact email address, to confirm the request. Please read the instructions carefully and click on the link in it. - -If you no longer have access to this address but have access to your alternate email address, create a [help ticket via the Help Center](https://help.ovhcloud.com/csm?id=csm_get_help) to replace your primary email address with the backup email address. - -If you do not have access to your email address, the OVHcloud Control Panel, or a backup email address, you will need to follow [this procedure](links/transversal/procedure-email-change). - -If you have forgotten your NIC handle, you can find it in the top right-hand corner of your last bill. It looks like this: "aa00000-ovh" (the first letters are usually the initials of the person who created the account). You will also find this ID in the email confirming that you have created your account, as well as in the emails of orders confirmation or renewal. +> +> If you no longer have access to this address but have access to your alternate email address, create a [help ticket via the Help Center](https://help.ovhcloud.com/csm?id=csm_get_help) to replace your primary email address with the backup email address. +> +> If you do not have access to your email address, the OVHcloud Control Panel, or a backup email address, you will need to follow [this procedure](/links/transversal/procedure-email-change). +> +> If you have forgotten your NIC handle, you can find it in the top right-hand corner of your last bill. It looks like this: "aa00000-ovh" (the first letters are usually the initials of the person who created the account). You will also find this ID in the email confirming that you have created your account, as well as in the emails of orders confirmation or renewal. +> /// @@ -118,7 +149,7 @@ If your device (mobile phone/smartphone/security key) used for two-factor authen - use another two-factor authentication device, if you have enabled several; - [disable two-factor authentication](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#deactivation). -Check out the ["What do I do if I lose one of my devices, or if it stops working? "](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#lost-device) or the ["Disabling two-factor authentication completely "](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#deactivation) sections of our guide on two-factor authentication. +Check out the "[What do I do if I lose one of my devices, or if it stops working?](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#lost-device)" or the "[Disabling two-factor authentication completely](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#deactivation) sections of our guide on two-factor authentication." /// @@ -194,9 +225,8 @@ Closing your OVHcloud customer account and deleting your personal data is only p If the above conditions are met, you can request to delete your OVHcloud account and the related data by following these steps: 1. Log in to the [OVHcloud Help Centre](https://help.ovhcloud.com/csm?id=csm_get_help). -2. Click the `Create ticket`{.action} button. -3. Select the reason `Manage your OVHcloud customer account`{.action}. -4. Specify `I want to close my OVHcloud account`{.action} and follow the steps described. +1. Select the reason `Manage your OVHcloud customer account`{.action}. +1. Specify `I want to close my OVHcloud account`{.action} and follow the steps described. /// @@ -258,10 +288,10 @@ The service delegation must be validated via email both by the service administr Before you make any changes, please ensure that all contact email addresses are valid, otherwise the request will not be successful. -If you would like to retrieve a domain name that you are the registered owner of from the registry (you can check this information using our own [whois tool](/links/web/domains-whois)), but you do not have access to the administrator customer account, please follow [this procedure](/links/transversal/procedure-contact-change) +If you would like to retrieve a domain name that you are the registered owner of from the registry (you can check this information using our own [whois tool](/links/web/domains-whois)), but you do not have access to the administrator customer account, please follow [this procedure](/links/transversal/procedure-contact-change). > [!success] -> A full contact management guide is available here: [/pages/account_and_service_management/account_information/managing_contacts#access-contact-management](/pages/account_and_service_management/account_information/managing_contacts#access-contact-management) +> A full contact management guide is available here: [Managing contacts for your services](/pages/account_and_service_management/account_information/managing_contacts). /// diff --git a/pages/account_and_service_management/account_information/faq-account-management/guide.en-ca.md b/pages/account_and_service_management/account_information/faq-account-management/guide.en-ca.md index deba054d102..39418f4f9b0 100644 --- a/pages/account_and_service_management/account_information/faq-account-management/guide.en-ca.md +++ b/pages/account_and_service_management/account_information/faq-account-management/guide.en-ca.md @@ -1,20 +1,50 @@ --- title: OVHcloud account management FAQ excerpt: Find the most frequently asked questions about managing your OVHcloud account -updated: 2025-09-12 +updated: 2025-10-30 --- @@ -24,7 +54,7 @@ Here are the most frequently asked questions about managing your OVHcloud accoun ## FAQ -### Creating an OVHcloud account, loggin in, and securing it +### Creating an OVHcloud account, logging in, and securing it /// details | How do I create an OVHcloud account? @@ -79,12 +109,13 @@ You can find more information in our guide [Changing your account password](/pag > **Can't remember your password?** > > Go to the [login page for your Control Panel](/links/manager) and click `Forgot username or password?`{.action}. Enter your NIC handle or the primary email address associated with your OVHcloud account, then click `Submit`{.action}. An email is then sent to the account’s contact email address, to confirm the request. Please read the instructions carefully and click on the link in it. - -If you no longer have access to this address but have access to your alternate email address, create a [help ticket via the Help Center](https://help.ovhcloud.com/csm?id=csm_get_help) to replace your primary email address with the backup email address. - -If you do not have access to your email address, the OVHcloud Control Panel, or a backup email address, you will need to follow [this procedure](links/transversal/procedure-email-change). - -If you have forgotten your NIC handle, you can find it in the top right-hand corner of your last bill. It looks like this: "aa00000-ovh" (the first letters are usually the initials of the person who created the account). You will also find this ID in the email confirming that you have created your account, as well as in the emails of orders confirmation or renewal. +> +> If you no longer have access to this address but have access to your alternate email address, create a [help ticket via the Help Center](https://help.ovhcloud.com/csm?id=csm_get_help) to replace your primary email address with the backup email address. +> +> If you do not have access to your email address, the OVHcloud Control Panel, or a backup email address, you will need to follow [this procedure](/links/transversal/procedure-email-change). +> +> If you have forgotten your NIC handle, you can find it in the top right-hand corner of your last bill. It looks like this: "aa00000-ovh" (the first letters are usually the initials of the person who created the account). You will also find this ID in the email confirming that you have created your account, as well as in the emails of orders confirmation or renewal. +> /// @@ -118,7 +149,7 @@ If your device (mobile phone/smartphone/security key) used for two-factor authen - use another two-factor authentication device, if you have enabled several; - [disable two-factor authentication](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#deactivation). -Check out the ["What do I do if I lose one of my devices, or if it stops working? "](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#lost-device) or the ["Disabling two-factor authentication completely "](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#deactivation) sections of our guide on two-factor authentication. +Check out the "[What do I do if I lose one of my devices, or if it stops working?](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#lost-device)" or the "[Disabling two-factor authentication completely](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#deactivation) sections of our guide on two-factor authentication." /// @@ -194,9 +225,8 @@ Closing your OVHcloud customer account and deleting your personal data is only p If the above conditions are met, you can request to delete your OVHcloud account and the related data by following these steps: 1. Log in to the [OVHcloud Help Centre](https://help.ovhcloud.com/csm?id=csm_get_help). -2. Click the `Create ticket`{.action} button. -3. Select the reason `Manage your OVHcloud customer account`{.action}. -4. Specify `I want to close my OVHcloud account`{.action} and follow the steps described. +1. Select the reason `Manage your OVHcloud customer account`{.action}. +1. Specify `I want to close my OVHcloud account`{.action} and follow the steps described. /// @@ -258,10 +288,10 @@ The service delegation must be validated via email both by the service administr Before you make any changes, please ensure that all contact email addresses are valid, otherwise the request will not be successful. -If you would like to retrieve a domain name that you are the registered owner of from the registry (you can check this information using our own [whois tool](/links/web/domains-whois)), but you do not have access to the administrator customer account, please follow [this procedure](/links/transversal/procedure-contact-change) +If you would like to retrieve a domain name that you are the registered owner of from the registry (you can check this information using our own [whois tool](/links/web/domains-whois)), but you do not have access to the administrator customer account, please follow [this procedure](/links/transversal/procedure-contact-change). > [!success] -> A full contact management guide is available here: [/pages/account_and_service_management/account_information/managing_contacts#access-contact-management](/pages/account_and_service_management/account_information/managing_contacts#access-contact-management) +> A full contact management guide is available here: [Managing contacts for your services](/pages/account_and_service_management/account_information/managing_contacts). /// diff --git a/pages/account_and_service_management/account_information/faq-account-management/guide.en-gb.md b/pages/account_and_service_management/account_information/faq-account-management/guide.en-gb.md index 4b34ed6a470..808f6257bbc 100644 --- a/pages/account_and_service_management/account_information/faq-account-management/guide.en-gb.md +++ b/pages/account_and_service_management/account_information/faq-account-management/guide.en-gb.md @@ -1,20 +1,50 @@ --- title: OVHcloud account management FAQ excerpt: Find the most frequently asked questions about managing your OVHcloud account -updated: 2025-09-12 +updated: 2025-10-30 --- @@ -24,7 +54,7 @@ Here are the most frequently asked questions about managing your OVHcloud accoun ## FAQ -### Creating an OVHcloud account, loggin in, and securing it +### Creating an OVHcloud account, logging in, and securing it /// details | How do I create an OVHcloud account? @@ -99,12 +129,13 @@ You can find more information in our guide [Changing your account password](/pag > **Can't remember your password?** > > Go to the [login page for your Control Panel](/links/manager) and click `Forgot username or password?`{.action}. Enter your NIC handle or the primary email address associated with your OVHcloud account, then click `Submit`{.action}. An email is then sent to the account’s contact email address, to confirm the request. Please read the instructions carefully and click on the link in it. - -If you no longer have access to this address but have access to your alternate email address, create a [help ticket via the Help Center](https://help.ovhcloud.com/csm?id=csm_get_help) to replace your primary email address with the backup email address. - -If you do not have access to your email address, the OVHcloud Control Panel, or a backup email address, you will need to follow [this procedure](/links/transversal/procedure-email-change). - -If you have forgotten your NIC handle, you can find it in the top right-hand corner of your last bill. It looks like this: "aa00000-ovh" (the first letters are usually the initials of the person who created the account). You will also find this ID in the email confirming that you have created your account, as well as in the emails of orders confirmation or renewal. +> +> If you no longer have access to this address but have access to your alternate email address, create a [help ticket via the Help Center](https://help.ovhcloud.com/csm?id=csm_get_help) to replace your primary email address with the backup email address. +> +> If you do not have access to your email address, the OVHcloud Control Panel, or a backup email address, you will need to follow [this procedure](/links/transversal/procedure-email-change). +> +> If you have forgotten your NIC handle, you can find it in the top right-hand corner of your last bill. It looks like this: "aa00000-ovh" (the first letters are usually the initials of the person who created the account). You will also find this ID in the email confirming that you have created your account, as well as in the emails of orders confirmation or renewal. +> /// @@ -138,7 +169,7 @@ If your device (mobile phone/smartphone/security key) used for two-factor authen - use another two-factor authentication device, if you have enabled several; - [disable two-factor authentication](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#deactivation). -Check out the ["What do I do if I lose one of my devices, or if it stops working? "](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#lost-device) or the ["Disabling two-factor authentication completely "](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#deactivation) sections of our guide on two-factor authentication. +Check out the "[What do I do if I lose one of my devices, or if it stops working?](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#lost-device)" or the "[Disabling two-factor authentication completely](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#deactivation) sections of our guide on two-factor authentication." /// @@ -214,9 +245,8 @@ Closing your OVHcloud customer account and deleting your personal data is only p If the above conditions are met, you can request to delete your OVHcloud account and the related data by following these steps: 1. Log in to the [OVHcloud Help Centre](https://help.ovhcloud.com/csm?id=csm_get_help). -2. Click the `Create ticket`{.action} button. -3. Select the reason `Manage your OVHcloud customer account`{.action}. -4. Specify `I want to close my OVHcloud account`{.action} and follow the steps described. +1. Select the reason `Manage your OVHcloud customer account`{.action}. +1. Specify `I want to close my OVHcloud account`{.action} and follow the steps described. /// @@ -278,10 +308,10 @@ The service delegation must be validated via email both by the service administr Before you make any changes, please ensure that all contact email addresses are valid, otherwise the request will not be successful. -If you would like to retrieve a domain name that you are the registered owner of from the registry (you can check this information using our own [whois tool](/links/web/domains-whois)), but you do not have access to the administrator customer account, please follow [this procedure](/links/transversal/procedure-contact-change) +If you would like to retrieve a domain name that you are the registered owner of from the registry (you can check this information using our own [whois tool](/links/web/domains-whois)), but you do not have access to the administrator customer account, please follow [this procedure](/links/transversal/procedure-contact-change). > [!success] -> A full contact management guide is available here: [/pages/account_and_service_management/account_information/managing_contacts#access-contact-management](/pages/account_and_service_management/account_information/managing_contacts#access-contact-management) +> A full contact management guide is available here: [Managing contacts for your services](/pages/account_and_service_management/account_information/managing_contacts). /// diff --git a/pages/account_and_service_management/account_information/faq-account-management/guide.en-ie.md b/pages/account_and_service_management/account_information/faq-account-management/guide.en-ie.md index 8461b28a167..6459ae56544 100644 --- a/pages/account_and_service_management/account_information/faq-account-management/guide.en-ie.md +++ b/pages/account_and_service_management/account_information/faq-account-management/guide.en-ie.md @@ -1,20 +1,50 @@ --- title: OVHcloud account management FAQ excerpt: Find the most frequently asked questions about managing your OVHcloud account -updated: 2025-09-12 +updated: 2025-10-30 --- @@ -24,7 +54,7 @@ Here are the most frequently asked questions about managing your OVHcloud accoun ## FAQ -### Creating an OVHcloud account, loggin in, and securing it +### Creating an OVHcloud account, logging in, and securing it /// details | How do I create an OVHcloud account? @@ -90,12 +120,13 @@ You can find more information in our guide [Changing your account password](/pag > **Can't remember your password?** > > Go to the [login page for your Control Panel](/links/manager) and click `Forgot username or password?`{.action}. Enter your NIC handle or the primary email address associated with your OVHcloud account, then click `Submit`{.action}. An email is then sent to the account’s contact email address, to confirm the request. Please read the instructions carefully and click on the link in it. - -If you no longer have access to this address but have access to your alternate email address, create a [help ticket via the Help Center](https://help.ovhcloud.com/csm?id=csm_get_help) to replace your primary email address with the backup email address. - -If you do not have access to your email address, the OVHcloud Control Panel, or a backup email address, you will need to follow [this procedure](links/transversal/procedure-email-change). - -If you have forgotten your NIC handle, you can find it in the top right-hand corner of your last bill. It looks like this: "aa00000-ovh" (the first letters are usually the initials of the person who created the account). You will also find this ID in the email confirming that you have created your account, as well as in the emails of orders confirmation or renewal. +> +> If you no longer have access to this address but have access to your alternate email address, create a [help ticket via the Help Center](https://help.ovhcloud.com/csm?id=csm_get_help) to replace your primary email address with the backup email address. +> +> If you do not have access to your email address, the OVHcloud Control Panel, or a backup email address, you will need to follow [this procedure](/links/transversal/procedure-email-change). +> +> If you have forgotten your NIC handle, you can find it in the top right-hand corner of your last bill. It looks like this: "aa00000-ovh" (the first letters are usually the initials of the person who created the account). You will also find this ID in the email confirming that you have created your account, as well as in the emails of orders confirmation or renewal. +> /// @@ -129,7 +160,7 @@ If your device (mobile phone/smartphone/security key) used for two-factor authen - use another two-factor authentication device, if you have enabled several; - [disable two-factor authentication](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#deactivation). -Check out the ["What do I do if I lose one of my devices, or if it stops working? "](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#lost-device) or the ["Disabling two-factor authentication completely "](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#deactivation) sections of our guide on two-factor authentication. +Check out the "[What do I do if I lose one of my devices, or if it stops working?](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#lost-device)" or the "[Disabling two-factor authentication completely](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#deactivation) sections of our guide on two-factor authentication." /// @@ -205,9 +236,8 @@ Closing your OVHcloud customer account and deleting your personal data is only p If the above conditions are met, you can request to delete your OVHcloud account and the related data by following these steps: 1. Log in to the [OVHcloud Help Centre](https://help.ovhcloud.com/csm?id=csm_get_help). -2. Click the `Create ticket`{.action} button. -3. Select the reason `Manage your OVHcloud customer account`{.action}. -4. Specify `I want to close my OVHcloud account`{.action} and follow the steps described. +1. Select the reason `Manage your OVHcloud customer account`{.action}. +1. Specify `I want to close my OVHcloud account`{.action} and follow the steps described. /// @@ -269,10 +299,10 @@ The service delegation must be validated via email both by the service administr Before you make any changes, please ensure that all contact email addresses are valid, otherwise the request will not be successful. -If you would like to retrieve a domain name that you are the registered owner of from the registry (you can check this information using our own [whois tool](/links/web/domains-whois)), but you do not have access to the administrator customer account, please follow [this procedure](/links/transversal/procedure-contact-change) +If you would like to retrieve a domain name that you are the registered owner of from the registry (you can check this information using our own [whois tool](/links/web/domains-whois)), but you do not have access to the administrator customer account, please follow [this procedure](/links/transversal/procedure-contact-change). > [!success] -> A full contact management guide is available here: [/pages/account_and_service_management/account_information/managing_contacts#access-contact-management](/pages/account_and_service_management/account_information/managing_contacts#access-contact-management) +> A full contact management guide is available here: [Managing contacts for your services](/pages/account_and_service_management/account_information/managing_contacts). /// diff --git a/pages/account_and_service_management/account_information/faq-account-management/guide.en-sg.md b/pages/account_and_service_management/account_information/faq-account-management/guide.en-sg.md index 3783dcded13..af06c097ca0 100644 --- a/pages/account_and_service_management/account_information/faq-account-management/guide.en-sg.md +++ b/pages/account_and_service_management/account_information/faq-account-management/guide.en-sg.md @@ -1,20 +1,50 @@ --- title: OVHcloud account management FAQ excerpt: Find the most frequently asked questions about managing your OVHcloud account -updated: 2025-09-12 +updated: 2025-10-30 --- @@ -24,7 +54,7 @@ Here are the most frequently asked questions about managing your OVHcloud accoun ## FAQ -### Creating an OVHcloud account, loggin in, and securing it +### Creating an OVHcloud account, logging in, and securing it /// details | How do I create an OVHcloud account? @@ -79,12 +109,13 @@ You can find more information in our guide [Changing your account password](/pag > **Can't remember your password?** > > Go to the [login page for your Control Panel](/links/manager) and click `Forgot username or password?`{.action}. Enter your NIC handle or the primary email address associated with your OVHcloud account, then click `Submit`{.action}. An email is then sent to the account’s contact email address, to confirm the request. Please read the instructions carefully and click on the link in it. - -If you no longer have access to this address but have access to your alternate email address, create a [help ticket via the Help Center](https://help.ovhcloud.com/csm?id=csm_get_help) to replace your primary email address with the backup email address. - -If you do not have access to your email address, the OVHcloud Control Panel, or a backup email address, you will need to follow [this procedure](links/transversal/procedure-email-change). - -If you have forgotten your NIC handle, you can find it in the top right-hand corner of your last bill. It looks like this: "aa00000-ovh" (the first letters are usually the initials of the person who created the account). You will also find this ID in the email confirming that you have created your account, as well as in the emails of orders confirmation or renewal. +> +> If you no longer have access to this address but have access to your alternate email address, create a [help ticket via the Help Center](https://help.ovhcloud.com/csm?id=csm_get_help) to replace your primary email address with the backup email address. +> +> If you do not have access to your email address, the OVHcloud Control Panel, or a backup email address, you will need to follow [this procedure](/links/transversal/procedure-email-change). +> +> If you have forgotten your NIC handle, you can find it in the top right-hand corner of your last bill. It looks like this: "aa00000-ovh" (the first letters are usually the initials of the person who created the account). You will also find this ID in the email confirming that you have created your account, as well as in the emails of orders confirmation or renewal. +> /// @@ -118,7 +149,7 @@ If your device (mobile phone/smartphone/security key) used for two-factor authen - use another two-factor authentication device, if you have enabled several; - [disable two-factor authentication](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#deactivation). -Check out the ["What do I do if I lose one of my devices, or if it stops working? "](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#lost-device) or the ["Disabling two-factor authentication completely "](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#deactivation) sections of our guide on two-factor authentication. +Check out the "[What do I do if I lose one of my devices, or if it stops working?](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#lost-device)" or the "[Disabling two-factor authentication completely](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#deactivation) sections of our guide on two-factor authentication." /// @@ -194,9 +225,8 @@ Closing your OVHcloud customer account and deleting your personal data is only p If the above conditions are met, you can request to delete your OVHcloud account and the related data by following these steps: 1. Log in to the [OVHcloud Help Centre](https://help.ovhcloud.com/csm?id=csm_get_help). -2. Click the `Create ticket`{.action} button. -3. Select the reason `Manage your OVHcloud customer account`{.action}. -4. Specify `I want to close my OVHcloud account`{.action} and follow the steps described. +1. Select the reason `Manage your OVHcloud customer account`{.action}. +1. Specify `I want to close my OVHcloud account`{.action} and follow the steps described. /// @@ -258,10 +288,10 @@ The service delegation must be validated via email both by the service administr Before you make any changes, please ensure that all contact email addresses are valid, otherwise the request will not be successful. -If you would like to retrieve a domain name that you are the registered owner of from the registry (you can check this information using our own [whois tool](/links/web/domains-whois)), but you do not have access to the administrator customer account, please follow [this procedure](/links/transversal/procedure-contact-change) +If you would like to retrieve a domain name that you are the registered owner of from the registry (you can check this information using our own [whois tool](/links/web/domains-whois)), but you do not have access to the administrator customer account, please follow [this procedure](/links/transversal/procedure-contact-change). > [!success] -> A full contact management guide is available here: [/pages/account_and_service_management/account_information/managing_contacts#access-contact-management](/pages/account_and_service_management/account_information/managing_contacts#access-contact-management) +> A full contact management guide is available here: [Managing contacts for your services](/pages/account_and_service_management/account_information/managing_contacts). /// diff --git a/pages/account_and_service_management/account_information/faq-account-management/guide.en-us.md b/pages/account_and_service_management/account_information/faq-account-management/guide.en-us.md index 3ca9fe3367d..892f98f9730 100644 --- a/pages/account_and_service_management/account_information/faq-account-management/guide.en-us.md +++ b/pages/account_and_service_management/account_information/faq-account-management/guide.en-us.md @@ -1,20 +1,50 @@ --- title: OVHcloud account management FAQ excerpt: Find the most frequently asked questions about managing your OVHcloud account -updated: 2025-09-12 +updated: 2025-10-30 --- @@ -24,7 +54,7 @@ Here are the most frequently asked questions about managing your OVHcloud accoun ## FAQ -### Creating an OVHcloud account, loggin in, and securing it +### Creating an OVHcloud account, logging in, and securing it /// details | How do I create an OVHcloud account? @@ -90,12 +120,13 @@ You can find more information in our guide [Changing your account password](/pag > **Can't remember your password?** > > Go to the [login page for your Control Panel](/links/manager) and click `Forgot username or password?`{.action}. Enter your NIC handle or the primary email address associated with your OVHcloud account, then click `Submit`{.action}. An email is then sent to the account’s contact email address, to confirm the request. Please read the instructions carefully and click on the link in it. - -If you no longer have access to this address but have access to your alternate email address, create a [help ticket via the Help Center](https://help.ovhcloud.com/csm?id=csm_get_help) to replace your primary email address with the backup email address. - -If you do not have access to your email address, the OVHcloud Control Panel, or a backup email address, you will need to follow [this procedure](links/transversal/procedure-email-change). - -If you have forgotten your NIC handle, you can find it in the top right-hand corner of your last bill. It looks like this: "aa00000-ovh" (the first letters are usually the initials of the person who created the account). You will also find this ID in the email confirming that you have created your account, as well as in the emails of orders confirmation or renewal. +> +> If you no longer have access to this address but have access to your alternate email address, create a [help ticket via the Help Center](https://help.ovhcloud.com/csm?id=csm_get_help) to replace your primary email address with the backup email address. +> +> If you do not have access to your email address, the OVHcloud Control Panel, or a backup email address, you will need to follow [this procedure](/links/transversal/procedure-email-change). +> +> If you have forgotten your NIC handle, you can find it in the top right-hand corner of your last bill. It looks like this: "aa00000-ovh" (the first letters are usually the initials of the person who created the account). You will also find this ID in the email confirming that you have created your account, as well as in the emails of orders confirmation or renewal. +> /// @@ -129,7 +160,7 @@ If your device (mobile phone/smartphone/security key) used for two-factor authen - use another two-factor authentication device, if you have enabled several; - [disable two-factor authentication](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#deactivation). -Check out the ["What do I do if I lose one of my devices, or if it stops working? "](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#lost-device) or the ["Disabling two-factor authentication completely "](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#deactivation) sections of our guide on two-factor authentication. +Check out the "[What do I do if I lose one of my devices, or if it stops working?](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#lost-device)" or the "[Disabling two-factor authentication completely](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#deactivation) sections of our guide on two-factor authentication." /// @@ -205,9 +236,8 @@ Closing your OVHcloud customer account and deleting your personal data is only p If the above conditions are met, you can request to delete your OVHcloud account and the related data by following these steps: 1. Log in to the [OVHcloud Help Centre](https://help.ovhcloud.com/csm?id=csm_get_help). -2. Click the `Create ticket`{.action} button. -3. Select the reason `Manage your OVHcloud customer account`{.action}. -4. Specify `I want to close my OVHcloud account`{.action} and follow the steps described. +1. Select the reason `Manage your OVHcloud customer account`{.action}. +1. Specify `I want to close my OVHcloud account`{.action} and follow the steps described. /// @@ -269,10 +299,10 @@ The service delegation must be validated via email both by the service administr Before you make any changes, please ensure that all contact email addresses are valid, otherwise the request will not be successful. -If you would like to retrieve a domain name that you are the registered owner of from the registry (you can check this information using our own [whois tool](/links/web/domains-whois)), but you do not have access to the administrator customer account, please follow [this procedure](/links/transversal/procedure-contact-change) +If you would like to retrieve a domain name that you are the registered owner of from the registry (you can check this information using our own [whois tool](/links/web/domains-whois)), but you do not have access to the administrator customer account, please follow [this procedure](/links/transversal/procedure-contact-change). > [!success] -> A full contact management guide is available here: [/pages/account_and_service_management/account_information/managing_contacts#access-contact-management](/pages/account_and_service_management/account_information/managing_contacts#access-contact-management) +> A full contact management guide is available here: [Managing contacts for your services](/pages/account_and_service_management/account_information/managing_contacts). /// diff --git a/pages/account_and_service_management/account_information/faq-account-management/guide.es-es.md b/pages/account_and_service_management/account_information/faq-account-management/guide.es-es.md index c57003e548a..86730a2b06d 100644 --- a/pages/account_and_service_management/account_information/faq-account-management/guide.es-es.md +++ b/pages/account_and_service_management/account_information/faq-account-management/guide.es-es.md @@ -1,198 +1,364 @@ --- title: Preguntas frecuentes sobre la gestión de la cuenta de OVHcloud excerpt: Consulte las preguntas más frecuentes sobre la gestión de la cuenta de OVHcloud -updated: 2025-04-28 +updated: 2025-10-30 --- + + ## Objetivo -Consulte las preguntas más frecuentes sobre la gestión de la cuenta de OVHcloud. +Encuentre aquí las preguntas más frecuentes sobre la gestión de su cuenta de OVHcloud. + +## Preguntas frecuentes -### ¿Cómo crear una cuenta en OVHcloud? +### Crear una cuenta de OVHcloud, iniciar sesión y asegurarla -La creación de una cuenta es gratuita. Este espacio facilita el acceso a sus datos y le permite gestionar sus servicios. Consulte nuestra guía [Crear una cuenta de OVHcloud](/pages/account_and_service_management/account_information/ovhcloud-account-creation). +/// details | ¿Cómo crear una cuenta de OVHcloud ? + +La creación de una cuenta es gratuita. Este espacio facilita el acceso a sus informaciones y permite gestionar sus servicios. Consulte nuestro guía "[Crear una cuenta de OVHcloud](/pages/account_and_service_management/account_information/ovhcloud-account-creation)". > [!success] -> Una vez que haya creado su cuenta, asegúrese de protegerla configurando la doble autenticación. Para más información, consulte nuestra guía [Proteger su cuenta de OVHcloud con la doble autenticación](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa). +> Una vez creada su cuenta, asegúrese de protegerla configurando una autenticación de doble factor. Encuentre más información en nuestro guía "[Proteger su cuenta de OVHcloud con la doble autenticación](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa)". + +/// -#### Ideas y consejos +/// details | ¿Cómo introducir correctamente mi número de teléfono durante la creación de mi cuenta? -Si no encuentra su país, puede cambiar el idioma de la web haciendo clic en la bandera que desee en la esquina superior derecha. +Debe introducir su número de teléfono en formato internacional. -Si desea más información sobre la cuenta de cliente de OVHcloud, consulte nuestra guía ["Todo sobre el ID de cliente de OVHcloud"](/pages/account_and_service_management/account_information/all_about_username). +> [!success] +> Si su número es el "612 345 678", deberá introducir "+34 612 345 678". El prefijo "+ 34" se añade automáticamente al seleccionar España como país de residencia. + +/// -### ¿Dónde encontrar mi identificador de cliente de OVHcloud? +/// details | ¿Dónde encontrar mi identificador de OVHcloud ? -Su identificador de cliente, también llamado ID de cliente o "NIC-handle", aparece en la esquina superior derecha de su última factura. Tiene el siguiente formato: "aa00000-ovh" (donde las primeras letras suelen corresponder a las iniciales de la persona que ha creado la cuenta). También puede consultar su identificador de cliente en todos los mensajes de correo electrónico enviados por OVHcloud (emails de confirmación de creación de su cuenta, emails de confirmación de un pedido o de renovación, etc.). +Su identificador de cliente, a veces también llamado "NIC-handle", aparece en la parte superior derecha de su última factura. Tiene este aspecto: "aa00000-ovh" (las primeras letras suelen ser las iniciales de la persona que creó la cuenta). Este identificador también se indica en todos los correos electrónicos enviados por OVHcloud (correo de confirmación de creación de cuenta, correos de confirmación o renovación de pedido, etc.). -Si todavía no ha encontrado su identificador, haga clic en el enlace "¿No recuerda su ID de cliente o contraseña?" que aparece en la página de [conexión al área de cliente de OVHcloud](/links/manager) e introduzca la dirección de correo electrónico asociada a su cuenta. +Si no ha encontrado aún su identificador, puede hacer clic en el enlace "¿No recuerda su ID de cliente o contraseña?" presente en la página de [conexión a la cuenta de OVHcloud](/links/manager). Introduzca entonces la dirección de correo electrónico asociada a su cuenta. + +> [!success] +> En cualquier momento, cuando esté conectado a su espacio cliente, puede encontrar su identificador en la parte superior derecha al hacer clic en su nombre. -#### Ideas y consejos +/// -Puede consultar su ID de cliente en cualquier momento desde el área de cliente, desplegando el menú "Mi cuenta" situado en la esquina superior derecha. +/// details | ¿Cómo puedo asegurar mi cuenta? -#### ¿Qué hago si no puedo conectarme a mi cuenta de cliente? +Existen varias soluciones para proteger su cuenta, como: -Existen diversos motivos por los que esto puede ocurrir: no recuerda su contraseña, no tiene acceso a su cuenta de correo electrónico o su teléfono móvil para identificarse por SMS, etc. +- la elección de una [contraseña compleja y su renovación periódica](/pages/account_and_service_management/account_information/manage-ovh-password) ; +- la adición de una [doble autenticación](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa) ; +- la configuración de una [restricción por IP](/pages/account_and_service_management/account_information/ovhcloud-control-panel-ip-restriction). -Si no puede identificarse o conectarse a su área de cliente, consulte [la siguiente guía](/pages/account_and_service_management/account_information/ovhcloud-account-login#login-failure). +Para acceder a todas estas opciones, inicie sesión en su [área de cliente OVHcloud](/links/manager), haga clic en su nombre en la parte superior derecha y luego en `Mi Cuenta`{.action}. -### ¿Cómo modificar mis datos personales? +Haga clic en la pestaña `Seguridad`{.action} para verlas. -Para consultar o modificar sus datos, conéctese a su [área de cliente de OVHcloud](/links/manager), haga clic en su nombre en la parte superior derecha y seleccione `Acceder a mi cuenta`{.action}. +/// -Haga clic en el cuadro `Mi perfil` y luego en `Editar mi perfil`{.action}. +/// details | ¿Cómo activar la doble autenticación (2FA) en mi cuenta OVHcloud? -#### Ideas y consejos +Puede activar una o varias métodos de doble autenticación para proteger y controlar el acceso a su área de cliente. Encuentre todos los detalles en nuestra guía "[Proteger su cuenta OVHcloud con la doble autenticación](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa)". -Al cambiar la dirección de correo electrónico asociada a su cuenta de OVHcloud, recibirá una solicitud de confirmación en la dirección que figura en el área de cliente. Si ya no tiene acceso a esa dirección, solo tiene que esperar 24 horas. Una vez transcurrido ese plazo, el cambio se hará efectivo de forma automática. +/// -### ¿Cómo introducir el número de teléfono al crear una cuenta? +/// details | ¿Qué hacer si no puedo acceder a mi cuenta? -Es necesario introducir el número de teléfono en formato internacional. Por ejemplo, si su número es el "612 345 678", deberá introducir "+34 612345678". +¿Olvidó su contraseña? ¿No tiene acceso a su dirección de correo electrónico? ¿Configuró una doble autenticación pero su teléfono está roto/perdido/robado? +Para todos estos casos, consulte [esta documentación](/pages/account_and_service_management/account_information/ovhcloud-account-login#login-failure) para conocer los procedimientos adecuados. + +/// + +/// details | ¿Cómo cambiar la contraseña de mi cuenta OVHcloud? + +Inicie sesión en su [área de cliente OVHcloud](/links/manager), haga clic en su nombre en la parte superior derecha y luego en `Mi Cuenta`{.action}. + +Haga clic en la pestaña `Seguridad`{.action}, luego en el botón `Editar`{.action} situado a la derecha de la etiqueta **Contraseña**. Puede cambiar su contraseña actual. Aparecerá un mensaje de seguridad para informarle que está a punto de realizar un cambio de contraseña. Tras confirmar, recibirá (en la dirección de correo principal registrada en la cuenta) un correo electrónico con la procedimiento a seguir. + +Encuentre más información en nuestra guía "[Establecer y gestionar la contraseña de su cuenta](/pages/account_and_service_management/account_information/manage-ovh-password)". + +> [!success] +> **¿No recuerda su contraseña?** +> +> Vaya a la [página de inicio de sesión a su área de cliente](/links/manager) y haga clic en `¿No recuerda su ID de cliente o contraseña?`{.action}. Introduzca su ID de cliente o la dirección de correo principal asociada a su cuenta OVHcloud, y haga clic en `Enviar`{.action}. Se enviará un correo electrónico a la dirección de contacto de la cuenta para confirmar la solicitud. Lea cuidadosamente las instrucciones y haga clic en el enlace que contiene. +> +> Si ya no tiene acceso a esta dirección pero sí a su dirección de correo de respaldo, cree un [ticket de asistencia a través del centro de ayuda](https://help.ovhcloud.com/csm?id=csm_get_help) para reemplazar su dirección de correo principal por la dirección de correo de respaldo. +> +> Si no tiene acceso ni a su dirección de correo, ni a su área de cliente, ni a su dirección de correo de respaldo, deberá seguir [este procedimiento](/links/transversal/procedure-email-change). +> +> Si ha olvidado su identificador de cliente, puede encontrarlo en la parte superior derecha de su última factura. Tiene este aspecto: "aa00000-ovh" (las primeras letras suelen ser las iniciales de la persona que creó la cuenta). Este identificador también se indica en el correo de confirmación de creación de la cuenta, así como en los correos de confirmación o renovación de pedidos. +> -#### Ideas y consejos +/// -Al seleccionar España como país de residencia, el prefijo "+34" se selecciona automáticamente. +/// details | ¿Existe un límite en el número de veces que puedo cambiar la contraseña de mi cuenta OVHcloud (a través de la opción "¿No recuerda su ID de cliente o contraseña?")? -### ¿Cómo afecta el RGPD a mis datos personales? +OVHcloud no impone un límite en el número de cambios de contraseña, puede modificarla tantas veces como desee. -Para saber cómo afecta el Reglamento general de protección de datos (RGPD) a su actividad profesional o sus datos personales, le recomendamos que consulte los siguientes recursos: +Sin embargo, nuestro sistema envía los correos a su dirección de contacto y es posible que su proveedor de correo bloquee el correo si solicita muchos cambios de contraseña en unos minutos. -- ["OVHcloud y la protección de datos personales"](https://www.ovhcloud.com/es-es/personal-data-protection/) -- ["RGPD: la respuesta a sus preguntas"](https://www.ovhcloud.com/es-es/personal-data-protection/faq/) +/// -### ¿Cómo cambiar la contraseña en OVHcloud? +/// details | No he activado la doble autenticación en mi cuenta pero me piden un código. ¿Cómo desactivar esto? -En la página de conexión al área de cliente, haga clic en "¿No recuerda su ID de cliente o contraseña?". Introduzca su ID de cliente o la dirección de correo electrónico principal asociada a su cuenta de OVHcloud y haga clic en "Enviar". Recibirá un email a la dirección de contacto de la cuenta para confirmar su solicitud. Lea atentamente las indicaciones y haga clic en el enlace que contiene el email. +Aunque la doble autenticación no esté activada en su cuenta, se le puede pedir un código de verificación para validar su identificación. Esta medida tiene como objetivo proteger su cuenta y sus datos y no es posible desactivarla. -#### Ideas y consejos +El código de seguridad se envía por correo electrónico **a la dirección principal** que ha registrado en la cuenta. -Si ya no tiene acceso a la dirección de correo electrónico de contacto, siga este [procedimiento](https://www.ovh.es/soporte/procedimientos/). +Si no encuentra este código, verifique las carpetas "spam" / "correo no deseado" de su dirección de correo. + +> [!success] +> - Activar la doble autenticación en su cuenta le permite elegir el dispositivo a utilizar (teléfono, tableta, smartphone, clave U2F) para recibir un código de autenticación. Más información en nuestra guía "[Proteger su cuenta OVHcloud con la doble autenticación](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa)". +> - También puede implementar una seguridad adicional para restringir el acceso a su cuenta OVHcloud a una o varias direcciones IP. Más información en nuestra guía "[Restringir el acceso por IP a su área de cliente OVHcloud](/pages/account_and_service_management/account_information/ovhcloud-control-panel-ip-restriction)". + +/// + +/// details | ¿Cómo desactivar la doble autenticación (2FA) en mi cuenta OVHcloud? + +Si su dispositivo (teléfono móvil / smartphone / clave de seguridad) utilizado para la doble autenticación se ha perdido, robado o dejado de funcionar, puede: + +- utilizar los [códigos de respaldo](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#codes) activos que ha guardado; +- utilizar otro dispositivo de doble autenticación disponible, si ha activado varios; +- [desactivar la doble autenticación](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#desactivation). + +Consulte la sección ["¿Qué hacer si uno de mis dispositivos se ha perdido/robado o dejado de funcionar?"](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#lost-device) o la sección ["Desactivar completamente la doble autenticación"](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#desactivation) de nuestra guía sobre la doble autenticación. + +/// + +### Gestionar sus informaciones personales + +/// details | ¿Cómo modificar mis informaciónes personales? + +Para visualizar o modificar sus coordenadas, inicie sesión en su [área de cliente OVHcloud](/links/manager), haga clic en su nombre en la parte superior derecha y luego en `Mi Cuenta`{.action}. + +Haga clic en `Editar mi perfil`{.action}, en el marco `Mi perfil`. + +> [!success] +> **¿Desea modificar la dirección de correo de su cuenta OVHcloud?** +> +> Se le enviará primero una solicitud de confirmación a la dirección de correo que actualmente tiene registrada en su área de cliente. Si ya no puede acceder a esta dirección de correo, será necesario un plazo de 24 horas. Tras este plazo, el cambio se realizará automáticamente. +> -Si ha olvidado su ID de cliente, puede consultarlo en la esquina superior derecha de su última factura. Tiene el siguiente formato: "aa00000-ovh" (donde las primeras letras suelen corresponder a las iniciales de la persona que ha creado la cuenta). También encontrará su ID de cliente en el email de confirmación de creación de la cuenta, así como en los emails de confirmación de pedido o de renovación. +/// -### ¿Cómo cambiar los contactos? +/// details | ¿Cómo acceder a los contratos y condiciones generales de servicios? -OVHcloud le ofrece la posibilidad de delegar en otras cuentas de cliente de OVHcloud la gestión administrativa, técnica y de facturación de sus servicios desde el área de cliente. Para ello, conéctese a su [área de cliente de OVHcloud](/links/manager), haga clic en su nombre en la parte superior derecha y seleccione en `Mis contactos`{.action}. +Puede encontrar los contratos de sus servicios OVHcloud directamente en su [área de cliente](/links/manager). Una vez conectado, vaya al menú `Mi cuenta`{.action} y haga clic en `Ver mis contratos`{.action}. -La delegación del servicio deberá ser validada por correo electrónico tanto por el administrador del servicio como por el nuevo contacto. +También puede consultar los contratos en nuestro sitio web, a través de [este enlace](/links/terms-conditions-contracts). -Antes de realizar cualquier cambio, asegúrese de que todas las direcciones de correo electrónico de contacto son válidas, ya que, de lo contrario, la solicitud no podrá completarse. +Esta página contiene toda la información necesaria sobre nuestros contratos, incluyendo los términos y condiciones de nuestros servicios. -Si desea recuperar un dominio del que usted es el propietario registrado en un registro (puede consultar esta información en [www.ovh.es/cgi-bin/tools/check_whois.pl](https://www.ovh.es/cgi-bin/tools/check_whois.pl)), pero no tiene acceso a la cuenta de cliente administrador, le recomendamos que siga los pasos que se indican en el siguiente procedimiento: [www.ovh.es/cgi-bin/es/procedure/procedureChangeContacts.cgi](https://www.ovh.es/cgi-bin/es/procedure/procedureChangeContacts.cgi). +/// -#### Ideas y consejos +/// details | ¿Cuáles son los impactos del RGPD en mis datos personales? -Para más información sobre la gestión de contactos, consulte la siguiente [guía](/pages/account_and_service_management/account_information/managing_contacts#acceder-a-la-gestion-de-los-contactos). +Para conocer mejor los impactos del Reglamento General de Protección de Datos (RGPD) en su actividad profesional o en sus informaciones personales, le invitamos a consultar estos recursos: -### ¿Cómo cambiar el contacto de facturación? +- [OVHcloud y la protección de datos personales](/links/transversal/personal-data-protection) ; +- [RGPD: preguntas que se hace](/links/transversal/personal-data-protection-faq). -Conéctese al área de cliente con su ID de cliente y contraseña. Para modificar el contacto de facturación, conéctese a su [área de cliente de OVHcloud](/links/manager), haga clic en su nombre en la parte superior derecha y seleccione en `Mis contactos`{.action}. +/// -#### Ideas y consejos +/// details | ¿Puedo cambiar manualmente mi identificador de cliente? Me gustaría otras letras o números. -Si desea más información sobre la gestión de los contactos, consulte nuestra guía ["Gestionar los contactos de los servicios"](/pages/account_and_service_management/account_information/managing_contacts). +El identificador de cliente no puede modificarse ya que está vinculado a las informaciones proporcionadas durante la creación de su cuenta OVHcloud. Las dos primeras letras corresponden generalmente a las iniciales del nombre del administrador, mientras que los números siguientes se generan aleatoriamente. -### ¿Cómo proteger mi cuenta? +Sin embargo, tiene la posibilidad de [crear una nueva cuenta OVHcloud](/pages/account_and_service_management/account_information/ovhcloud-account-creation). Sin embargo, deberá transferir manualmente todos sus servicios al nuevo cuenta siguiendo el [proceso de cambio de contactos](/pages/account_and_service_management/account_information/managing_contacts). -Existen diversas formas de proteger su cuenta: +/// -- elegir una contraseña compleja -- la renovación regular de esta contraseña -- doble autenticación +/// details | ¿Puedo cambiar la filial de mi cuenta OVHcloud? -Para la doble autenticación mediante el envío de un código por SMS o a través de la restricción por IP (autorización o denegación de acceso a determinadas direcciones), tiene la posibilidad de añadir reglas de seguridad desde su área de cliente. Estas opciones están disponibles en la sección "Seguridad" de su perfil. Para acceder a ella, conéctese a su [área de cliente de OVHcloud](/links/manager), haga clic en su nombre en la parte superior derecha y seleccione `Acceder a mi cuenta`{.action}. +Si creó una cuenta OVHcloud en la filial incorrecta, puede crear una nueva cuenta en la filial correcta con las mismas informaciones personales. -Luego, haga clic en `Seguridad`{.action}. +Sin embargo, deberá asociar una dirección de correo de contacto diferente, ya que no es posible tener dos cuentas OVHcloud diferentes con la misma dirección de correo de contacto. -Y para más información, ver el [video](https://www.youtube.com/watch?v=odO58c4gJfc&list=PL0DynEzr_sE5MnOfJOpVJN-EhfMDWoqGS&index=24). +Encuentre información adicional sobre la creación de una cuenta OVHcloud en nuestra guía "[Crear una cuenta OVHcloud](/pages/account_and_service_management/account_information/ovhcloud-account-creation)". -### ¿Cómo activar la doble autenticación/2FA de OVHcloud? +Una vez que haya creado su nueva cuenta OVHcloud en la filial correcta, puede seguir las instrucciones de [esta guía](/pages/account_and_service_management/account_information/managing_contacts) para trasladar sus servicios de una cuenta a otra. -Una vez que haya creado su cuenta de cliente de OVHcloud, le recomendamos que proteja sus datos personales activando la doble autenticación. Para ello, conéctese a su [área de cliente de OVHcloud](/links/manager), haga clic en su nombre en la parte superior derecha y seleccione `Acceder a mi cuenta`{.action}. +Si posee una cuenta OVHcloud en nuestra infraestructura canadiense (es decir, en un país fuera de Europa), no podrá trasladar servicios entre cuentas. En este caso, será necesario encargar nuevos servicios en la nueva cuenta y migrar manualmente sus contenidos, si es necesario. -Luego, haga clic en `Seguridad`{.action}. +Para cualquier información adicional, póngase en contacto con nuestro soporte creando un [ticket de asistencia desde el centro de ayuda OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help). -Al activar la doble autenticación o 2FA, podrá elegir el método con el que desea autenticarse: +/// -- por SMS, a través de un código de seguridad; -- desde una aplicación móvil compatible con Android, iPhone y Windows móvil; -- con una llave de seguridad compatible con U2F. +/// details | ¿Cómo eliminar mi cuenta OVHcloud? -Para más información, haga clic [aquí](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa). +La cierre de su cuenta de cliente OVHcloud y la eliminación de sus datos personales solo es posible si: -### ¿Cómo desactivar la doble autenticación/2FA de OVHcloud? +1. No tiene más servicios visibles en la sección "[Mis Servicios](https://www.ovh.com/manager/dedicated/#/billing/autoRenew)". En caso contrario, deberá solicitar su cancelación previamente y esperar a su eliminación. +2. No tiene facturas pendientes de pago. En caso contrario, deberá proceder al pago haciendo clic en el botón `Pagar inmediatamente`{.action} en las acciones de masa de la página "[Mis facturas](https://www.ovh.com/manager/#/dedicated/billing/history)". +3. No tiene pedidos en curso. Verifíquelo en [esta página](https://www.ovh.com/manager/#/dedicated/billing/orders/orders). +4. Su cuenta prepaga no está positiva. Verifíquelo en [esta página](https://www.ovh.com/manager/#/dedicated/billing/payment/ovhaccount). -Puede desactivar la doble autenticación directamente desde su área de cliente, conéctese a su [área de cliente de OVHcloud](/links/manager), haga clic en su nombre en la parte superior derecha y seleccione `Acceder a mi cuenta`{.action}. +Si se cumplen las condiciones anteriores, puede solicitar la eliminación de su cuenta OVHcloud y los datos asociados siguiendo estos pasos: -Luego, haga clic en `Seguridad`{.action}. +1. Inicie sesión en el [centro de ayuda OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help). +1. Seleccione el motivo `Gestione su cuenta de cliente OVHcloud`{.action}. +1. Indique `Quiero cerrar mi cuenta de cliente OVHcloud`{.action} y siga los pasos descritos. -Es posible desactivar uno por uno los diferentes dispositivos de seguridad.  +/// -Si ha perdido su periférico de doble autenticación y no puede acceder al área de cliente, puede ponerse en contacto con el equipo de soporte de OVHcloud para que uno de nuestros asesores desactive manualmente el dispositivo. Tenga en cuenta que, en este caso, deberá identificarse proporcionando los justificantes de identidad pertinentes. +### Gestionar notificaciones y registros -### ¿Qué hacer si me han pirateado la cuenta de OVHcloud? +/// details | ¿Puedo recibir todas las notificaciones de OVHcloud en varias direcciones de correo? -Si detecta un uso fraudulento de su cuenta de OVHcloud (identidad, formas de pago...), le recomendamos que lo denuncie a la policía lo antes posible. A continuación, contacte telefónicamente con el soporte. Para garantizar su seguridad, le pediremos que justifique su identidad mediante el envío de la documentación correspondiente y que nos haga llegar una copia de la denuncia. De este modo, podremos iniciar los trámites internos. +Desafortunadamente, no es posible enviar correos de comunicación a varias direcciones. -Nuestros especialistas analizarán su caso y adoptarán las medidas pertinentes, que podrían incluir el bloqueo de su ID de cliente o la eliminación y reembolso de los servicios contratados de manera fraudulenta. +Desde su [área de cliente OVHcloud](/links/manager), puede configurar una dirección de correo de respaldo que no se utilizará para el envío de todas nuestras comunicaciones (renovaciones, eliminaciones de servicios, etc.). + +Esta dirección de correo de respaldo es útil en caso de pérdida de acceso a su dirección de correo principal, ya que esto le impediría conectarse a su área de cliente OVHcloud. + +/// + +/// details | He recibido una notificación suya en otro idioma. ¿Cómo corregir esto? + +Puede cambiar el idioma de nuestros correos automatizados siguiendo estos pasos: + +1. Inicie sesión en su [área de cliente OVHcloud](/links/manager). +1. Acceda al [centro de ayuda OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help). +1. Haga clic en `Conectarse al centro de ayuda`{.action} y confirme su conexión. +1. Haga clic en la bandera en la parte superior derecha del centro de ayuda y seleccione el país/la región correspondiente al idioma deseado. +1. Haga clic en `Desconectarse del centro de ayuda`{.action}. + +A partir de ahora, las próximas notificaciones automatizadas por correo se enviarán en el idioma deseado. + +/// + +/// details | ¿Puedo ver todas las acciones realizadas desde el área de cliente? ¿Hay registros? + +Sí, puede acceder a los registros de las acciones realizadas en su cuenta. + +Para ello, deberá conectarse a las [API OVHcloud](/links/api) siguiendo la guía "[Primeros pasos con las API OVHcloud](/pages/manage_and_operate/api/first-steps)". Una vez conectado, puede utilizar la llamada API siguiente para recuperar el ID del registro: + +> [!api] +> +> @api {v1} /me GET /me/api/logs/self +> + +Obtendrá así la lista de identificadores de registros. A continuación, puede utilizar la llamada API siguiente para recuperar los detalles de un registro específico: + +> [!api] +> +> @api {v1} /me GET /me/api/logs/self/{logId} +> + +Reemplace `{logId}` por el identificador real del registro que desea consultar. Esto le permitirá acceder al registro y visualizar las acciones realizadas desde el área de cliente. + +/// + +### Delegar el acceso a sus servicios + +/// details | ¿Cómo delegar el acceso a mis servicios a otras personas? + +Tiene la posibilidad de delegar a otros clientes de OVHcloud la gestión administrativa, técnica y facturación de sus servicios desde su área de cliente. Para ello, inicie sesión en su [área de cliente OVHcloud](/links/manager), haga clic en su nombre en la parte superior derecha y luego en `Mis contactos`{.action}. + +La delegación de servicio deberá validarse por correo tanto por el administrador del servicio como por el nuevo contacto. + +Antes de cualquier modificación, asegúrese de que todas las direcciones de correo de contacto sean válidas, de lo contrario, la solicitud no podrá concluirse. + +Si desea recuperar un nombre de dominio del cual es titular registrado ante el registro (puede verificar esta información en [nuestra herramienta WHOIS en línea](/links/web/domains-whois)), pero no tiene acceso a la cuenta de cliente administradora, le invitamos a seguir [este procedimiento](/links/transversal/procedure-contact-change). + +> [!success] +> Un guía completo sobre la gestión de contactos está disponible [aquí](/pages/account_and_service_management/account_information/managing_contacts). + +/// + +/// details | ¿Cómo configurar o modificar un contacto de facturación? + +Inicie sesión en su [área de cliente OVHcloud](/links/manager), haga clic en su nombre en la parte superior derecha y luego en `Mis contactos`{.action}. + +> [!success] +> Si desea obtener más información sobre la gestión de contactos, le invitamos a consultar este guía detallado: "[Gestionar los contactos de sus servicios](/pages/account_and_service_management/account_information/managing_contacts)". -Finalmente, para recuperar su cuenta de cliente podremos solicitarle que cambie su dirección de correo electrónico y/o su contraseña cumplimentando este [procedimiento](https://www.ovh.es/cgi-bin/es/procedure/procedureChangeEmail.cgi). +/// -### He recibido un mensaje de correo electrónico que parece ser un mensaje de phishing usurpando la identidad de OVHcloud, ¿cómo puedo notificarlo para que se compruebe su legitimidad? +/// details | Deseo trasladar todo mis servicios a otro cuenta OVHcloud, ¿cómo puedo hacerlo en una sola vez? -Para identificar y denunciar un mensaje de correo electrónico o un SMS de phishing, consulte nuestra [guía dedicada](/pages/account_and_service_management/account_information/phishing_care). +Para transferir todo sus servicios a otro cuenta OVHcloud, le recomendamos [contactar directamente con nuestro soporte técnico](https://help.ovhcloud.com/csm?id=csm_get_help). Nuestros equipos podrán guiarle durante todo el proceso y ayudarle en la transferencia masiva de sus servicios a la nueva cuenta. -### ¿Cómo puedo denunciar un comportamiento abusivo o un contenido ilícito procedente de servicios alojados en OVHcloud? +/// -Puede denunciar cualquier comportamiento abusivo o contenido ilícito en la plataforma de OVHcloud específica para tal fin [www.ovh.com/abuse/](https://www.ovh.com/abuse/). Seleccione la categoría correspondiente e introduzca la información que se le solicita. +### Denunciar una actividad abusiva/ilegal o un ciberataque -OVHcloud solo enviará los logs y los elementos técnicos al titular del servicio del que procede la infracción. Por favor, no incluya datos personales en esos campos. +/// details | ¿Qué hacer si mi cuenta OVHcloud ha sido pirateada? -### Después de denunciar una infracción, ¿qué sucede con esta notificación? +En caso de uso fraudulento de su cuenta OVHcloud (identidad, medio de pago, etc.), le invitamos a presentar una denuncia lo antes posible ante la prefectura de Policía o la gendarmería. -El servicio jurídico de OVHcloud estudiará su notificación de infracción o contenido ilícito lo antes posible. Nuestro equipo analizará su denuncia y posteriormente se pondrá en contacto con usted para ofrecerle información adicional. Si se demuestra el comportamiento abusivo de uno de nuestros clientes, le informaremos y haremos todo lo necesario para que los responsables pongan fin a este comportamiento lo antes posible. +Tan pronto como disponga de la denuncia, deberá enviarnos una copia. Esta permitirá iniciar nuestros procedimientos internos. -### OVHcloud me ha enviado un mensaje de correo electrónico en el que se indica que yo podría estar cometiendo una infracción, ¿qué debo hacer? +Póngase en contacto con el soporte OVHcloud por teléfono: -Si nuestro equipo ha detectado o comprobado la existencia de un comportamiento abusivo, recibirá un mensaje de correo electrónico desde una dirección de correo electrónico con el siguiente formato: "tíquet+"número de tíquet"@abuse.ovh.net". +- España: 91 758 34 77 -Teniendo en cuenta los elementos adicionales que se le indicarán en este mensaje de correo electrónico, nuestro equipo le solicitará que realice una serie de comprobaciones para identificar y corregir el comportamiento abusivo o, en su caso, eliminar el contenido ilícito. +Su identificador de cliente será bloqueado y los servicios suscritos fraudulentamente serán eliminados. -Asimismo, deberá asegurarse de que sus servicios no están siendo controlados por un tercero (por ejemplo, debido a un ataque informático). Para ello, consulte nuestras guías: +Finalmente, para recuperar el uso de su cuenta de cliente, le podremos solicitar que modifique su dirección de correo y/o su contraseña a través de [este procedimiento](/links/transversal/procedure-email-change). -- [Proteger mi cuenta de OVHcloud y gestionar mis datos personales](/pages/account_and_service_management/account_information/all_about_username) -- [Cambiar la contraseña de su cuenta](/pages/account_and_service_management/account_information/manage-ovh-password) -- [Proteger su cuenta de OVHcloud con la doble autenticación](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa) -- [¿Cómo proteger su sitio web?](/pages/web_cloud/web_hosting/secure_your_website) -- [Proteger un VPS](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps) -- [Proteger un servidor dedicado](/pages/bare_metal_cloud/dedicated_servers/securing-a-dedicated-server) +/// -### En caso de identificar una posible infracción en uno de mis servicios de OVHcloud, ¿cómo puedo evitar la suspensión del servicio? +/// details | He recibido un correo que parece ser phishing usurpando la identidad de OVHcloud, ¿cómo denunciarlo para verificación? -Una vez que haya realizado las acciones necesarias, deberá responder directamente al mensaje de correo electrónico que le hemos enviado desde nuestro servicio de Abuse indicándonos qué medidas ha adoptado. -Nuestro equipo le responderá lo antes posible. +Para identificar y denunciar un correo o un SMS de phishing, consulte nuestro [guía dedicado](/pages/account_and_service_management/account_information/phishing_care). -### He respondido al mensaje que me envió el equipo de Abuse de OVHcloud, pero mi servicio sigue bloqueado. ¿Qué puedo hacer? +/// -Puede crear un tíquet de asistencia desde su [Centro de ayuda de OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help) para solicitar información adicional sobre el tratamiento de su tíquet de Abuse. Por favor, incluya la referencia de su tíquet de Abuse para facilitar el tratamiento del tíquet de asistencia. +/// details | ¿Cómo denunciar un comportamiento abusivo o contenido ilegal proveniente de servicios alojados por OVHcloud y del cual soy víctima? -### ¿Cómo eliminar una cuenta de OVHcloud? +Encuentre las respuestas a las preguntas sobre la denuncia de comportamientos abusivos o contenido ilegal en nuestra [FAQ sobre el soporte OVHcloud](/pages/account_and_service_management/account_information/faq-support). -Solo es posible cerrar su cuenta de cliente de OVHcloud y eliminar sus datos personales si: +/// -1. Ya no tiene servicios visibles en la sección "[Mis servicios](https://www.ovh.com/manager/dedicated/#/billing/autoRenew)". En caso contrario, deberá solicitar en primer lugar la baja del servicio y esperar a su eliminación. -2. No hay facturas pendientes de pago. En caso contrario, deberá abonarlos haciendo clic en el botón `Abonar inmediatamente`{.action} en las acciones de masa de la página "[Mis facturas](https://www.ovh.com/manager/#/dedicated/billing/history)". -3. No hay pedidos en curso. Consúltelo en [esta página](https://www.ovh.com/manager/#/dedicated/billing/orders/orders). -4. Su cuenta de prepago no es positiva. Consúltelo en [esta página](https://www.ovh.com/manager/#/dedicated/billing/payment/ovhaccount). +/// details | OVHcloud me ha enviado un correo indicando un posible comportamiento abusivo por mi parte, ¿qué debo hacer? -Si cumple las condiciones anteriores, puede solicitar la eliminación de su cuenta de OVHcloud y de los datos asociados siguiendo estos pasos: +Encuentre las respuestas a las preguntas sobre la denuncia de comportamientos abusivos o contenido ilegal en nuestra [FAQ sobre el soporte OVHcloud](/pages/account_and_service_management/account_information/faq-support). -1. Conéctese al [Centro de ayuda de OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help). -2. Haga clic en el botón `Crear un tíquet`{.action}. -3. Seleccione el motivo `Gestione su cuenta de cliente OVHcloud`{.action}. -4. Indique `Quiero cerrar mi cuenta de cliente OVHcloud`{.action} y siga los pasos que se indican. +/// ## Más información diff --git a/pages/account_and_service_management/account_information/faq-account-management/guide.es-us.md b/pages/account_and_service_management/account_information/faq-account-management/guide.es-us.md index 0cd563bbe11..f3fcaa7b6f6 100644 --- a/pages/account_and_service_management/account_information/faq-account-management/guide.es-us.md +++ b/pages/account_and_service_management/account_information/faq-account-management/guide.es-us.md @@ -1,191 +1,365 @@ --- title: Preguntas frecuentes sobre la gestión de la cuenta de OVHcloud excerpt: Consulte las preguntas más frecuentes sobre la gestión de la cuenta de OVHcloud -updated: 2025-04-28 +updated: 2025-10-30 --- + + ## Objetivo -Consulte las preguntas más frecuentes sobre la gestión de la cuenta de OVHcloud. +Encuentre aquí las preguntas más frecuentes sobre la gestión de su cuenta de OVHcloud. + +## Preguntas frecuentes + +### Crear una cuenta de OVHcloud, iniciar sesión y asegurarla + +/// details | ¿Cómo crear una cuenta de OVHcloud ? + +La creación de una cuenta es gratuita. Este espacio facilita el acceso a sus informaciones y permite gestionar sus servicios. Consulte nuestro guía "[Crear una cuenta de OVHcloud](/pages/account_and_service_management/account_information/ovhcloud-account-creation)". + +> [!success] +> Una vez creada su cuenta, asegúrese de protegerla configurando una autenticación de doble factor. Encuentre más información en nuestro guía "[Proteger su cuenta de OVHcloud con la doble autenticación](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa)". + +/// + +/// details | ¿Cómo introducir correctamente mi número de teléfono durante la creación de mi cuenta? + +Debe introducir su número de teléfono en formato internacional. + +> [!success] +> Si su número es el "612 345 678", deberá introducir "+34 612 345 678". El prefijo "+ 34" se añade automáticamente al seleccionar España como país de residencia. + +/// + +/// details | ¿Dónde encontrar mi identificador de OVHcloud ? + +Su identificador de cliente, a veces también llamado "NIC-handle", aparece en la parte superior derecha de su última factura. Tiene este aspecto: "aa00000-ovh" (las primeras letras suelen ser las iniciales de la persona que creó la cuenta). Este identificador también se indica en todos los correos electrónicos enviados por OVHcloud (correo de confirmación de creación de cuenta, correos de confirmación o renovación de pedido, etc.). + +Si no ha encontrado aún su identificador, puede hacer clic en el enlace "¿No recuerda su ID de cliente o contraseña?" presente en la página de [conexión a la cuenta de OVHcloud](/links/manager). Introduzca entonces la dirección de correo electrónico asociada a su cuenta. + +> [!success] +> En cualquier momento, cuando esté conectado a su espacio cliente, puede encontrar su identificador en la parte superior derecha al hacer clic en su nombre. + +/// + +/// details | ¿Cómo puedo asegurar mi cuenta? + +Existen varias soluciones para proteger su cuenta, como: + +- la elección de una [contraseña compleja y su renovación periódica](/pages/account_and_service_management/account_information/manage-ovh-password) ; +- la adición de una [doble autenticación](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa) ; +- la configuración de una [restricción por IP](/pages/account_and_service_management/account_information/ovhcloud-control-panel-ip-restriction). + +Para acceder a todas estas opciones, inicie sesión en su [área de cliente OVHcloud](/links/manager), haga clic en su nombre en la parte superior derecha y luego en `Mi Cuenta`{.action}. + +Haga clic en la pestaña `Seguridad`{.action} para verlas. + +/// + +/// details | ¿Cómo activar la doble autenticación (2FA) en mi cuenta OVHcloud? + +Puede activar una o varias métodos de doble autenticación para proteger y controlar el acceso a su área de cliente. Encuentre todos los detalles en nuestra guía "[Proteger su cuenta OVHcloud con la doble autenticación](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa)". + +/// + +/// details | ¿Qué hacer si no puedo acceder a mi cuenta? + +¿Olvidó su contraseña? ¿No tiene acceso a su dirección de correo electrónico? ¿Configuró una doble autenticación pero su teléfono está roto/perdido/robado? +Para todos estos casos, consulte [esta documentación](/pages/account_and_service_management/account_information/ovhcloud-account-login#login-failure) para conocer los procedimientos adecuados. -### ¿Cómo crear una cuenta en OVHcloud? +/// -La creación de una cuenta es gratuita. Este espacio facilita el acceso a sus datos y le permite gestionar sus servicios. Consulte nuestra guía [Crear una cuenta de OVHcloud](/pages/account_and_service_management/account_information/ovhcloud-account-creation). +/// details | ¿Cómo cambiar la contraseña de mi cuenta OVHcloud? + +Inicie sesión en su [área de cliente OVHcloud](/links/manager), haga clic en su nombre en la parte superior derecha y luego en `Mi Cuenta`{.action}. + +Haga clic en la pestaña `Seguridad`{.action}, luego en el botón `Editar`{.action} situado a la derecha de la etiqueta **Contraseña**. Puede cambiar su contraseña actual. Aparecerá un mensaje de seguridad para informarle que está a punto de realizar un cambio de contraseña. Tras confirmar, recibirá (en la dirección de correo principal registrada en la cuenta) un correo electrónico con la procedimiento a seguir. + +Encuentre más información en nuestra guía "[Establecer y gestionar la contraseña de su cuenta](/pages/account_and_service_management/account_information/manage-ovh-password)". + +> [!success] +> **¿No recuerda su contraseña?** +> +> Vaya a la [página de inicio de sesión a su área de cliente](/links/manager) y haga clic en `¿No recuerda su ID de cliente o contraseña?`{.action}. Introduzca su ID de cliente o la dirección de correo principal asociada a su cuenta OVHcloud, y haga clic en `Enviar`{.action}. Se enviará un correo electrónico a la dirección de contacto de la cuenta para confirmar la solicitud. Lea cuidadosamente las instrucciones y haga clic en el enlace que contiene. +> +> Si ya no tiene acceso a esta dirección pero sí a su dirección de correo de respaldo, cree un [ticket de asistencia a través del centro de ayuda](https://help.ovhcloud.com/csm?id=csm_get_help) para reemplazar su dirección de correo principal por la dirección de correo de respaldo. +> +> Si no tiene acceso ni a su dirección de correo, ni a su área de cliente, ni a su dirección de correo de respaldo, deberá seguir [este procedimiento](/links/transversal/procedure-email-change). +> +> Si ha olvidado su identificador de cliente, puede encontrarlo en la parte superior derecha de su última factura. Tiene este aspecto: "aa00000-ovh" (las primeras letras suelen ser las iniciales de la persona que creó la cuenta). Este identificador también se indica en el correo de confirmación de creación de la cuenta, así como en los correos de confirmación o renovación de pedidos. +> + +/// + +/// details | ¿Existe un límite en el número de veces que puedo cambiar la contraseña de mi cuenta OVHcloud (a través de la opción "¿No recuerda su ID de cliente o contraseña?")? + +OVHcloud no impone un límite en el número de cambios de contraseña, puede modificarla tantas veces como desee. + +Sin embargo, nuestro sistema envía los correos a su dirección de contacto y es posible que su proveedor de correo bloquee el correo si solicita muchos cambios de contraseña en unos minutos. + +/// + +/// details | No he activado la doble autenticación en mi cuenta pero me piden un código. ¿Cómo desactivar esto? + +Aunque la doble autenticación no esté activada en su cuenta, se le puede pedir un código de verificación para validar su identificación. Esta medida tiene como objetivo proteger su cuenta y sus datos y no es posible desactivarla. + +El código de seguridad se envía por correo electrónico **a la dirección principal** que ha registrado en la cuenta. + +Si no encuentra este código, verifique las carpetas "spam" / "correo no deseado" de su dirección de correo. + +> [!success] +> - Activar la doble autenticación en su cuenta le permite elegir el dispositivo a utilizar (teléfono, tableta, smartphone, clave U2F) para recibir un código de autenticación. Más información en nuestra guía "[Proteger su cuenta OVHcloud con la doble autenticación](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa)". +> - También puede implementar una seguridad adicional para restringir el acceso a su cuenta OVHcloud a una o varias direcciones IP. Más información en nuestra guía "[Restringir el acceso por IP a su área de cliente OVHcloud](/pages/account_and_service_management/account_information/ovhcloud-control-panel-ip-restriction)". + +/// + +/// details | ¿Cómo desactivar la doble autenticación (2FA) en mi cuenta OVHcloud? + +Si su dispositivo (teléfono móvil / smartphone / clave de seguridad) utilizado para la doble autenticación se ha perdido, robado o dejado de funcionar, puede: + +- utilizar los [códigos de respaldo](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#codes) activos que ha guardado; +- utilizar otro dispositivo de doble autenticación disponible, si ha activado varios; +- [desactivar la doble autenticación](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#desactivation). + +Consulte la sección ["¿Qué hacer si uno de mis dispositivos se ha perdido/robado o dejado de funcionar?"](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#lost-device) o la sección ["Desactivar completamente la doble autenticación"](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#desactivation) de nuestra guía sobre la doble autenticación. + +/// + +### Gestionar sus informaciones personales + +/// details | ¿Cómo modificar mis informaciónes personales? + +Para visualizar o modificar sus coordenadas, inicie sesión en su [área de cliente OVHcloud](/links/manager), haga clic en su nombre en la parte superior derecha y luego en `Mi Cuenta`{.action}. + +Haga clic en `Editar mi perfil`{.action}, en el marco `Mi perfil`. > [!success] -> Una vez que haya creado su cuenta, asegúrese de protegerla configurando la doble autenticación. Para más información, consulte nuestra guía [Proteger su cuenta de OVHcloud con la doble autenticación](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa). +> **¿Desea modificar la dirección de correo de su cuenta OVHcloud?** +> +> Se le enviará primero una solicitud de confirmación a la dirección de correo que actualmente tiene registrada en su área de cliente. Si ya no puede acceder a esta dirección de correo, será necesario un plazo de 24 horas. Tras este plazo, el cambio se realizará automáticamente. +> -#### Ideas y consejos +/// -Si no encuentra su país, puede cambiar el idioma de la web haciendo clic en la bandera que desee en la esquina superior derecha. +/// details | ¿Cómo acceder a los contratos y condiciones generales de servicios? -Si desea más información sobre la cuenta de cliente de OVHcloud, consulte nuestra guía ["Todo sobre el ID de cliente de OVHcloud"](/pages/account_and_service_management/account_information/all_about_username). +Puede encontrar los contratos de sus servicios OVHcloud directamente en su [área de cliente](/links/manager). Una vez conectado, vaya al menú `Mi cuenta`{.action} y haga clic en `Ver mis contratos`{.action}. -### ¿Dónde encontrar mi identificador de cliente de OVHcloud? +También puede consultar los contratos en nuestro sitio web, a través de [este enlace](/links/terms-conditions-contracts). -Su identificador de cliente, también llamado ID de cliente o "NIC-handle", aparece en la esquina superior derecha de su última factura. Tiene el siguiente formato: "aa00000-ovh" (donde las primeras letras suelen corresponder a las iniciales de la persona que ha creado la cuenta). También puede consultar su identificador de cliente en todos los mensajes de correo electrónico enviados por OVHcloud (emails de confirmación de creación de su cuenta, emails de confirmación de un pedido o de renovación, etc.). +Esta página contiene toda la información necesaria sobre nuestros contratos, incluyendo los términos y condiciones de nuestros servicios. -Si todavía no ha encontrado su identificador, haga clic en el enlace "¿No recuerda su ID de cliente o contraseña?" que aparece en la página de [conexión al área de cliente de OVHcloud](/links/manager) e introduzca la dirección de correo electrónico asociada a su cuenta. +/// -#### Ideas y consejos +/// details | ¿Cuáles son los impactos del RGPD en mis datos personales? -Puede consultar su ID de cliente en cualquier momento desde el área de cliente, desplegando el menú "Mi cuenta" situado en la esquina superior derecha. +Para conocer mejor los impactos del Reglamento General de Protección de Datos (RGPD) en su actividad profesional o en sus informaciones personales, le invitamos a consultar estos recursos: -#### ¿Qué hago si no puedo conectarme a mi cuenta de cliente? +- [OVHcloud y la protección de datos personales](/links/transversal/personal-data-protection) ; +- [RGPD: preguntas que se hace](/links/transversal/personal-data-protection-faq). -Existen diversos motivos por los que esto puede ocurrir: no recuerda su contraseña, no tiene acceso a su cuenta de correo electrónico o su teléfono móvil para identificarse por SMS, etc. +/// -Si no puede identificarse o conectarse a su área de cliente, consulte [la siguiente guía](/pages/account_and_service_management/account_information/ovhcloud-account-login#login-failure). +/// details | ¿Puedo cambiar manualmente mi identificador de cliente? Me gustaría otras letras o números. -### ¿Cómo modificar mis datos personales? +El identificador de cliente no puede modificarse ya que está vinculado a las informaciones proporcionadas durante la creación de su cuenta OVHcloud. Las dos primeras letras corresponden generalmente a las iniciales del nombre del administrador, mientras que los números siguientes se generan aleatoriamente. -Para consultar o modificar sus datos, conéctese a su [área de cliente de OVHcloud](/links/manager), haga clic en su nombre en la parte superior derecha y seleccione `Acceder a mi cuenta`{.action}. +Sin embargo, tiene la posibilidad de [crear una nueva cuenta OVHcloud](/pages/account_and_service_management/account_information/ovhcloud-account-creation). Sin embargo, deberá transferir manualmente todos sus servicios al nuevo cuenta siguiendo el [proceso de cambio de contactos](/pages/account_and_service_management/account_information/managing_contacts). -Haga clic en el cuadro `Mi perfil` y luego en `Editar mi perfil`{.action}. +/// -#### Ideas y consejos +/// details | ¿Puedo cambiar la filial de mi cuenta OVHcloud? -Al cambiar la dirección de correo electrónico asociada a su cuenta de OVHcloud, recibirá una solicitud de confirmación en la dirección que figura en el área de cliente. Si ya no tiene acceso a esa dirección, solo tiene que esperar 24 horas. Una vez transcurrido ese plazo, el cambio se hará efectivo de forma automática. +Si creó una cuenta OVHcloud en la filial incorrecta, puede crear una nueva cuenta en la filial correcta con las mismas informaciones personales. -### ¿Cómo introducir el número de teléfono al crear una cuenta? +Sin embargo, deberá asociar una dirección de correo de contacto diferente, ya que no es posible tener dos cuentas OVHcloud diferentes con la misma dirección de correo de contacto. -Es necesario introducir el número de teléfono en formato internacional. Por ejemplo, si su número es el "612 345 678", deberá introducir "+34 612345678". +Encuentre información adicional sobre la creación de una cuenta OVHcloud en nuestra guía "[Crear una cuenta OVHcloud](/pages/account_and_service_management/account_information/ovhcloud-account-creation)". -#### Ideas y consejos +Una vez que haya creado su nueva cuenta OVHcloud en la filial correcta, puede seguir las instrucciones de [esta guía](/pages/account_and_service_management/account_information/managing_contacts) para trasladar sus servicios de una cuenta a otra. -Al seleccionar España como país de residencia, el prefijo "+34" se selecciona automáticamente. +Si posee una cuenta OVHcloud en nuestra infraestructura canadiense (es decir, en un país fuera de Europa), no podrá trasladar servicios entre cuentas. En este caso, será necesario encargar nuevos servicios en la nueva cuenta y migrar manualmente sus contenidos, si es necesario. -### ¿Cómo cambiar la contraseña en OVHcloud? +Para cualquier información adicional, póngase en contacto con nuestro soporte creando un [ticket de asistencia desde el centro de ayuda OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help). -En la página de conexión al área de cliente, haga clic en "¿No recuerda su ID de cliente o contraseña?". Introduzca su ID de cliente o la dirección de correo electrónico principal asociada a su cuenta de OVHcloud y haga clic en "Enviar". Recibirá un email a la dirección de contacto de la cuenta para confirmar su solicitud. Lea atentamente las indicaciones y haga clic en el enlace que contiene el email. +/// -#### Ideas y consejos +/// details | ¿Cómo eliminar mi cuenta OVHcloud? -Si ya no tiene acceso a la dirección de correo electrónico de contacto, siga este procedimiento. +La cierre de su cuenta de cliente OVHcloud y la eliminación de sus datos personales solo es posible si: -Si ha olvidado su ID de cliente, puede consultarlo en la esquina superior derecha de su última factura. Tiene el siguiente formato: "aa00000-ovh" (donde las primeras letras suelen corresponder a las iniciales de la persona que ha creado la cuenta). También encontrará su ID de cliente en el email de confirmación de creación de la cuenta, así como en los emails de confirmación de pedido o de renovación. +1. No tiene más servicios visibles en la sección "[Mis Servicios](https://www.ovh.com/manager/dedicated/#/billing/autoRenew)". En caso contrario, deberá solicitar su cancelación previamente y esperar a su eliminación. +2. No tiene facturas pendientes de pago. En caso contrario, deberá proceder al pago haciendo clic en el botón `Pagar inmediatamente`{.action} en las acciones de masa de la página "[Mis facturas](https://www.ovh.com/manager/#/dedicated/billing/history)". +3. No tiene pedidos en curso. Verifíquelo en [esta página](https://www.ovh.com/manager/#/dedicated/billing/orders/orders). +4. Su cuenta prepaga no está positiva. Verifíquelo en [esta página](https://www.ovh.com/manager/#/dedicated/billing/payment/ovhaccount). -### ¿Cómo cambiar los contactos? +Si se cumplen las condiciones anteriores, puede solicitar la eliminación de su cuenta OVHcloud y los datos asociados siguiendo estos pasos: -OVHcloud le ofrece la posibilidad de delegar en otras cuentas de cliente de OVHcloud la gestión administrativa, técnica y de facturación de sus servicios desde el área de cliente. Para ello, conéctese a su [área de cliente de OVHcloud](/links/manager), haga clic en su nombre en la parte superior derecha y seleccione en `Mis contactos`{.action}. +1. Inicie sesión en el [centro de ayuda OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help). +1. Seleccione el motivo `Gestione su cuenta de cliente OVHcloud`{.action}. +1. Indique `Quiero cerrar mi cuenta de cliente OVHcloud`{.action} y siga los pasos descritos. -La delegación del servicio deberá ser validada por correo electrónico tanto por el administrador del servicio como por el nuevo contacto. +/// -Antes de realizar cualquier cambio, asegúrese de que todas las direcciones de correo electrónico de contacto son válidas, ya que, de lo contrario, la solicitud no podrá completarse. +### Gestionar notificaciones y registros -Si desea recuperar un dominio del que usted es el propietario registrado en un registro (puede consultar esta información en [www.ovh.es/cgi-bin/tools/check_whois.pl](https://www.ovh.es/cgi-bin/tools/check_whois.pl)), pero no tiene acceso a la cuenta de cliente administrador, le recomendamos que siga los pasos que se indican en el siguiente procedimiento: [www.ovh.es/cgi-bin/es/procedure/procedureChangeContacts.cgi](https://www.ovh.es/cgi-bin/es/procedure/procedureChangeContacts.cgi). +/// details | ¿Puedo recibir todas las notificaciones de OVHcloud en varias direcciones de correo? -#### Ideas y consejos +Desafortunadamente, no es posible enviar correos de comunicación a varias direcciones. -Para más información sobre la gestión de contactos, consulte la siguiente [guía](/pages/account_and_service_management/account_information/managing_contacts#acceder-a-la-gestion-de-los-contactos). +Desde su [área de cliente OVHcloud](/links/manager), puede configurar una dirección de correo de respaldo que no se utilizará para el envío de todas nuestras comunicaciones (renovaciones, eliminaciones de servicios, etc.). -### ¿Cómo cambiar el contacto de facturación? +Esta dirección de correo de respaldo es útil en caso de pérdida de acceso a su dirección de correo principal, ya que esto le impediría conectarse a su área de cliente OVHcloud. -Conéctese al área de cliente con su ID de cliente y contraseña. Para modificar el contacto de facturación, conéctese a su [área de cliente de OVHcloud](/links/manager), haga clic en su nombre en la parte superior derecha y seleccione en `Mis contactos`{.action}. +/// -### Ideas y consejos +/// details | He recibido una notificación suya en otro idioma. ¿Cómo corregir esto? -Si desea más información sobre la gestión de los contactos, consulte nuestra guía ["Gestionar los contactos de los servicios"](/pages/account_and_service_management/account_information/managing_contacts). +Puede cambiar el idioma de nuestros correos automatizados siguiendo estos pasos: -### ¿Cómo proteger mi cuenta? +1. Inicie sesión en su [área de cliente OVHcloud](/links/manager). +1. Acceda al [centro de ayuda OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help). +1. Haga clic en `Conectarse al centro de ayuda`{.action} y confirme su conexión. +1. Haga clic en la bandera en la parte superior derecha del centro de ayuda y seleccione el país/la región correspondiente al idioma deseado. +1. Haga clic en `Desconectarse del centro de ayuda`{.action}. -Existen diversas formas de proteger su cuenta: +A partir de ahora, las próximas notificaciones automatizadas por correo se enviarán en el idioma deseado. -- elegir una contraseña compleja -- la renovación regular de esta contraseña -- doble autenticación +/// -Para la doble autenticación mediante el envío de un código por SMS o a través de la restricción por IP (autorización o denegación de acceso a determinadas direcciones), tiene la posibilidad de añadir reglas de seguridad desde su área de cliente. Estas opciones están disponibles en la sección "Seguridad" de su perfil. Para acceder a ella, conéctese a su [área de cliente de OVHcloud](/links/manager), haga clic en su nombre en la parte superior derecha y seleccione `Acceder a mi cuenta`{.action}. +/// details | ¿Puedo ver todas las acciones realizadas desde el área de cliente? ¿Hay registros? -Luego, haga clic en `Seguridad`{.action}. +Sí, puede acceder a los registros de las acciones realizadas en su cuenta. -Y para más información, ver el [video](https://www.youtube.com/watch?v=odO58c4gJfc&list=PL0DynEzr_sE5MnOfJOpVJN-EhfMDWoqGS&index=24). +Para ello, deberá conectarse a las [API OVHcloud](/links/api) siguiendo la guía "[Primeros pasos con las API OVHcloud](/pages/manage_and_operate/api/first-steps)". Una vez conectado, puede utilizar la llamada API siguiente para recuperar el ID del registro: -### ¿Cómo activar la doble autenticación/2FA de OVHcloud? +> [!api] +> +> @api {v1} /me GET /me/api/logs/self +> -Una vez que haya creado su cuenta de cliente de OVHcloud, le recomendamos que proteja sus datos personales activando la doble autenticación. Para ello, conéctese a su [área de cliente de OVHcloud](/links/manager), haga clic en su nombre en la parte superior derecha y seleccione `Acceder a mi cuenta`{.action}. +Obtendrá así la lista de identificadores de registros. A continuación, puede utilizar la llamada API siguiente para recuperar los detalles de un registro específico: -Luego, haga clic en `Seguridad`{.action}. +> [!api] +> +> @api {v1} /me GET /me/api/logs/self/{logId} +> -Al activar la doble autenticación o 2FA, podrá elegir el método con el que desea autenticarse: +Reemplace `{logId}` por el identificador real del registro que desea consultar. Esto le permitirá acceder al registro y visualizar las acciones realizadas desde el área de cliente. -- por SMS, a través de un código de seguridad; -- desde una aplicación móvil compatible con Android, iPhone y Windows móvil; -- con una llave de seguridad compatible con U2F. +/// -Para más información, haga clic [aquí](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa). +### Delegar el acceso a sus servicios -### ¿Cómo desactivar la doble autenticación/2FA de OVHcloud? +/// details | ¿Cómo delegar el acceso a mis servicios a otras personas? -Conéctese a su [área de cliente de OVHcloud](/links/manager), haga clic en su nombre en la parte superior derecha y seleccione `Acceder a mi cuenta`{.action}. +Tiene la posibilidad de delegar a otros clientes de OVHcloud la gestión administrativa, técnica y facturación de sus servicios desde su área de cliente. Para ello, inicie sesión en su [área de cliente OVHcloud](/links/manager), haga clic en su nombre en la parte superior derecha y luego en `Mis contactos`{.action}. -Luego, haga clic en `Seguridad`{.action}. +La delegación de servicio deberá validarse por correo tanto por el administrador del servicio como por el nuevo contacto. -Es posible desactivar uno por uno los diferentes dispositivos de seguridad.  +Antes de cualquier modificación, asegúrese de que todas las direcciones de correo de contacto sean válidas, de lo contrario, la solicitud no podrá concluirse. -Si ha perdido su periférico de doble autenticación y no puede acceder al área de cliente, puede ponerse en contacto con el equipo de soporte de OVHcloud para que uno de nuestros asesores desactive manualmente el dispositivo. Tenga en cuenta que, en este caso, deberá identificarse proporcionando los justificantes de identidad pertinentes. +Si desea recuperar un nombre de dominio del cual es titular registrado ante el registro (puede verificar esta información en [nuestra herramienta WHOIS en línea](/links/web/domains-whois)), pero no tiene acceso a la cuenta de cliente administradora, le invitamos a seguir [este procedimiento](/links/transversal/procedure-contact-change). -### ¿Qué hacer si me han pirateado la cuenta de OVHcloud? +> [!success] +> Un guía completo sobre la gestión de contactos está disponible [aquí](/pages/account_and_service_management/account_information/managing_contacts). -Si detecta un uso fraudulento de su cuenta de OVHcloud (identidad, formas de pago...), le recomendamos que lo denuncie a la policía lo antes posible. A continuación, contacte telefónicamente con el soporte. Para garantizar su seguridad, le pediremos que justifique su identidad mediante el envío de la documentación correspondiente y que nos haga llegar una copia de la denuncia. De este modo, podremos iniciar los trámites internos. +/// -Nuestros especialistas analizarán su caso y adoptarán las medidas pertinentes, que podrían incluir el bloqueo de su ID de cliente o la eliminación y reembolso de los servicios contratados de manera fraudulenta. +/// details | ¿Cómo configurar o modificar un contacto de facturación? + +Inicie sesión en su [área de cliente OVHcloud](/links/manager), haga clic en su nombre en la parte superior derecha y luego en `Mis contactos`{.action}. + +> [!success] +> Si desea obtener más información sobre la gestión de contactos, le invitamos a consultar este guía detallado: "[Gestionar los contactos de sus servicios](/pages/account_and_service_management/account_information/managing_contacts)". -Finalmente, para recuperar su cuenta de cliente podremos solicitarle que cambie su dirección de correo electrónico y/o su contraseña cumplimentando este [procedimiento](https://www.ovh.es/cgi-bin/es/procedure/procedureChangeEmail.cgi). +/// -### He recibido un mensaje de correo electrónico que parece ser un mensaje de phishing usurpando la identidad de OVHcloud, ¿cómo puedo notificarlo para que se compruebe su legitimidad? +/// details | Deseo trasladar todo mis servicios a otro cuenta OVHcloud, ¿cómo puedo hacerlo en una sola vez? -Para identificar y denunciar un mensaje de correo electrónico o un SMS de phishing, consulte nuestra [guía dedicada](/pages/account_and_service_management/account_information/phishing_care). +Para transferir todo sus servicios a otro cuenta OVHcloud, le recomendamos [contactar directamente con nuestro soporte técnico](https://help.ovhcloud.com/csm?id=csm_get_help). Nuestros equipos podrán guiarle durante todo el proceso y ayudarle en la transferencia masiva de sus servicios a la nueva cuenta. -### ¿Cómo puedo denunciar un comportamiento abusivo o un contenido ilícito procedente de servicios alojados en OVHcloud? +/// -Puede denunciar cualquier comportamiento abusivo o contenido ilícito en la plataforma de OVHcloud específica para tal fin [www.ovh.com/abuse/](https://www.ovh.com/abuse/). Seleccione la categoría correspondiente e introduzca la información que se le solicita. +### Denunciar una actividad abusiva/ilegal o un ciberataque -OVHcloud solo enviará los logs y los elementos técnicos al titular del servicio del que procede la infracción. Por favor, no incluya datos personales en esos campos. +/// details | ¿Qué hacer si mi cuenta OVHcloud ha sido pirateada? -### Después de denunciar una infracción, ¿qué sucede con esta notificación? +En caso de uso fraudulento de su cuenta OVHcloud (identidad, medio de pago, etc.), le invitamos a presentar una denuncia lo antes posible ante la prefectura de Policía o la gendarmería. -El servicio jurídico de OVHcloud estudiará su notificación de infracción o contenido ilícito lo antes posible. Nuestro equipo analizará su denuncia y posteriormente se pondrá en contacto con usted para ofrecerle información adicional. Si se demuestra el comportamiento abusivo de uno de nuestros clientes, le informaremos y haremos todo lo necesario para que los responsables pongan fin a este comportamiento lo antes posible. +Tan pronto como disponga de la denuncia, deberá enviarnos una copia. Esta permitirá iniciar nuestros procedimientos internos. -### OVHcloud me ha enviado un mensaje de correo electrónico en el que se indica que yo podría estar cometiendo una infracción, ¿qué debo hacer? +Póngase en contacto con el soporte OVHcloud por teléfono: -Si nuestro equipo ha detectado o comprobado la existencia de un comportamiento abusivo, recibirá un mensaje de correo electrónico desde una dirección de correo electrónico con el siguiente formato: "tíquet+"número de tíquet"@abuse.ovh.net". +- España: 91 758 34 77 +- América Latina: 1-855-684-5463 -Teniendo en cuenta los elementos adicionales que se le indicarán en este mensaje de correo electrónico, nuestro equipo le solicitará que realice una serie de comprobaciones para identificar y corregir el comportamiento abusivo o, en su caso, eliminar el contenido ilícito. +Su identificador de cliente será bloqueado y los servicios suscritos fraudulentamente serán eliminados. -Asimismo, deberá asegurarse de que sus servicios no están siendo controlados por un tercero (por ejemplo, debido a un ataque informático). Para ello, consulte nuestras guías: +Finalmente, para recuperar el uso de su cuenta de cliente, le podremos solicitar que modifique su dirección de correo y/o su contraseña a través de [este procedimiento](/links/transversal/procedure-email-change). -- [Proteger mi cuenta de OVHcloud y gestionar mis datos personales](/pages/account_and_service_management/account_information/all_about_username) -- [Cambiar la contraseña de su cuenta](/pages/account_and_service_management/account_information/manage-ovh-password) -- [Proteger su cuenta de OVHcloud con la doble autenticación](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa) -- [¿Cómo proteger su sitio web?](/pages/web_cloud/web_hosting/secure_your_website) -- [Proteger un VPS](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps) -- [Proteger un servidor dedicado](/pages/bare_metal_cloud/dedicated_servers/securing-a-dedicated-server) +/// -### En caso de identificar una posible infracción en uno de mis servicios de OVHcloud, ¿cómo puedo evitar la suspensión del servicio? +/// details | He recibido un correo que parece ser phishing usurpando la identidad de OVHcloud, ¿cómo denunciarlo para verificación? -Una vez que haya realizado las acciones necesarias, deberá responder directamente al mensaje de correo electrónico que le hemos enviado desde nuestro servicio de Abuse indicándonos qué medidas ha adoptado. -Nuestro equipo le responderá lo antes posible. +Para identificar y denunciar un correo o un SMS de phishing, consulte nuestro [guía dedicado](/pages/account_and_service_management/account_information/phishing_care). -### He respondido al mensaje que me envió el equipo de Abuse de OVHcloud, pero mi servicio sigue bloqueado. ¿Qué puedo hacer? +/// -Puede crear un tíquet de asistencia desde su [Centro de ayuda de OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help) para solicitar información adicional sobre el tratamiento de su tíquet de Abuse. Por favor, incluya la referencia de su tíquet de Abuse para facilitar el tratamiento del tíquet de asistencia. +/// details | ¿Cómo denunciar un comportamiento abusivo o contenido ilegal proveniente de servicios alojados por OVHcloud y del cual soy víctima? -### ¿Cómo eliminar una cuenta de OVHcloud? +Encuentre las respuestas a las preguntas sobre la denuncia de comportamientos abusivos o contenido ilegal en nuestra [FAQ sobre el soporte OVHcloud](/pages/account_and_service_management/account_information/faq-support). -Solo es posible cerrar su cuenta de cliente de OVHcloud y eliminar sus datos personales si: +/// -1. Ya no tiene servicios visibles en la sección "[Mis servicios](https://www.ovh.com/manager/dedicated/#/billing/autoRenew)". En caso contrario, deberá solicitar en primer lugar la baja del servicio y esperar a su eliminación. -2. No hay facturas pendientes de pago. En caso contrario, deberá abonarlos haciendo clic en el botón `Abonar inmediatamente`{.action} en las acciones de masa de la página "[Mis facturas](https://www.ovh.com/manager/#/dedicated/billing/history)". -3. No hay pedidos en curso. Consúltelo en [esta página](https://www.ovh.com/manager/#/dedicated/billing/orders/orders). -4. Su cuenta de prepago no es positiva. Consúltelo en [esta página](https://www.ovh.com/manager/#/dedicated/billing/payment/ovhaccount). +/// details | OVHcloud me ha enviado un correo indicando un posible comportamiento abusivo por mi parte, ¿qué debo hacer? -Si cumple las condiciones anteriores, puede solicitar la eliminación de su cuenta de OVHcloud y de los datos asociados siguiendo estos pasos: +Encuentre las respuestas a las preguntas sobre la denuncia de comportamientos abusivos o contenido ilegal en nuestra [FAQ sobre el soporte OVHcloud](/pages/account_and_service_management/account_information/faq-support). -1. Conéctese al [Centro de ayuda de OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help). -2. Haga clic en el botón `Crear un tíquet`{.action}. -3. Seleccione el motivo `Gestione su cuenta de cliente OVHcloud`{.action}. -4. Indique `Quiero cerrar mi cuenta de cliente OVHcloud`{.action} y siga los pasos que se indican. +/// ## Más información diff --git a/pages/account_and_service_management/account_information/faq-account-management/guide.fr-ca.md b/pages/account_and_service_management/account_information/faq-account-management/guide.fr-ca.md index 01115fe747c..a80fb51bbd7 100644 --- a/pages/account_and_service_management/account_information/faq-account-management/guide.fr-ca.md +++ b/pages/account_and_service_management/account_information/faq-account-management/guide.fr-ca.md @@ -1,20 +1,50 @@ --- title: FAQ sur la gestion du compte OVHcloud excerpt: Retrouvez les questions les plus fréquemment posées sur la gestion du compte OVHcloud -updated: 2025-09-12 +updated: 2025-10-30 --- @@ -75,12 +105,13 @@ Retrouvez plus d'informations dans notre guide «[Modifier le mot de passe de vo > **Vous ne vous rappelez plus de votre mot de passe ?** > > Rendez-vous sur la [page de connexion à votre espace client](/links/manager) et cliquez sur `Identifiant ou mot de passe oublié`{.action}. Renseignez votre identifiant ou l’adresse e-mail principale associée à votre compte OVHcloud, puis cliquez sur `Envoyer`{.action}. Un e-mail est alors envoyé à l’adresse e-mail de contact du compte, afin de confirmer la demande. Lisez attentivement les instructions et cliquez sur le lien qu’il contient. - -Si vous n'avez plus accès à cette adresse mais que vous avez accès votre adresse e-mail de secours, créez un [ticket d'assistance via le centre d'aide](https://help.ovhcloud.com/csm?id=csm_get_help) afin de remplacer votre adresse e-mail principale par l'adresse e-mail de secours. - -Si vous n'avez accès ni à votre adresse e-mail, ni à votre espace client, ou que vous n'avez pas d'adresse e-mail de secours, il vous faudra suivre [cette procédure](/links/transversal/procedure-email-change). - -Si vous avez oublié votre identifiant client, vous pouvez le retrouver en haut à droite de votre dernière facture. Il ressemble à ceci : « aa00000-ovh » (les premières lettres sont généralement les initiales de la personne qui a créé le compte). Cet identifiant est aussi indiqué dans l’e-mail de confirmation de création du compte, ainsi que dans les e-mails de confirmation ou de renouvellement de commande. +> +> Si vous n'avez plus accès à cette adresse mais que vous avez accès votre adresse e-mail de secours, créez un [ticket d'assistance via le centre d'aide](https://help.ovhcloud.com/csm?id=csm_get_help) afin de remplacer votre adresse e-mail principale par l'adresse e-mail de secours. +> +> Si vous n'avez accès ni à votre adresse e-mail, ni à votre espace client, ou que vous n'avez pas d'adresse e-mail de secours, il vous faudra suivre [cette procédure](/links/transversal/procedure-email-change). +> +> Si vous avez oublié votre identifiant client, vous pouvez le retrouver en haut à droite de votre dernière facture. Il ressemble à ceci : « aa00000-ovh » (les premières lettres sont généralement les initiales de la personne qui a créé le compte). Cet identifiant est aussi indiqué dans l’e-mail de confirmation de création du compte, ainsi que dans les e-mails de confirmation ou de renouvellement de commande. +> /// @@ -114,7 +145,7 @@ Si votre périphérique (téléphone mobile / smartphone / clé de sécurité) u - utiliser un autre périphérique de double authentification à votre disposition, si vous en avez activé plusieurs ; - [désactiver la double authentification](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#desactivation). -Consultez la partie [« Que faire si l'un de mes périphériques est perdu/volé ou cesse de fonctionner ? »](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#lost-device) ou la partie [« Désactiver complètement la double authentification »](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#desactivation) de notre guide sur la double authentification. +Consultez la partie « [Que faire si l'un de mes périphériques est perdu/volé ou cesse de fonctionner ?](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#lost-device) » ou la partie « [Désactiver complètement la double authentification](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#desactivation) » de notre guide sur la double authentification. /// @@ -154,7 +185,9 @@ Pour mieux connaître les impacts du règlement général sur la protection des /// -/// details | Puis-je changer manuellement mon identifiant client ? J'aimerais d'autres lettres ou chiffres. +/// details | Puis-je changer manuellement mon identifiant client ? + +J'aimerais d'autres lettres ou chiffres. L'identifiant client ne peut pas être modififé car il est lié aux informations fournies lors de la création de votre compte OVHcloud. Les deux premières lettres correspondent généralement aux initiales du nom de l'administrateur, tandis que les chiffres suivants sont générés aléatoirement. @@ -190,9 +223,8 @@ La fermeture de votre compte client OVHcloud et la suppression de vos données p Si les conditions ci-dessus sont remplies, vous pouvez demander à supprimer votre compte OVHcloud et les données liées en suivant ces étapes : 1. Connectez-vous au [centre d'aide OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help). -2. Cliquez sur le bouton `Créer un ticket`{.action}. -3. Sélectionnez le motif `Gérez votre compte client OVHcloud`{.action}. -4. Précisez `Je veux fermer mon compte client OVHcloud`{.action} et suivez les étapes décrites. +1. Sélectionnez le motif `Gérez votre compte client OVHcloud`{.action}. +1. Précisez `Je veux fermer mon compte client OVHcloud`{.action} et suivez les étapes décrites. /// diff --git a/pages/account_and_service_management/account_information/faq-account-management/guide.fr-fr.md b/pages/account_and_service_management/account_information/faq-account-management/guide.fr-fr.md index 2985fddd299..f829c8ccd88 100644 --- a/pages/account_and_service_management/account_information/faq-account-management/guide.fr-fr.md +++ b/pages/account_and_service_management/account_information/faq-account-management/guide.fr-fr.md @@ -1,20 +1,50 @@ --- title: FAQ sur la gestion du compte OVHcloud excerpt: Retrouvez les questions les plus fréquemment posées sur la gestion du compte OVHcloud -updated: 2025-09-12 +updated: 2025-10-30 --- @@ -94,12 +124,13 @@ Retrouvez plus d'informations dans notre guide «[Modifier le mot de passe de vo > **Vous ne vous rappelez plus de votre mot de passe ?** > > Rendez-vous sur la [page de connexion à votre espace client](/links/manager) et cliquez sur `Identifiant ou mot de passe oublié`{.action}. Renseignez votre identifiant ou l’adresse e-mail principale associée à votre compte OVHcloud, puis cliquez sur `Envoyer`{.action}. Un e-mail est alors envoyé à l’adresse e-mail de contact du compte, afin de confirmer la demande. Lisez attentivement les instructions et cliquez sur le lien qu’il contient. - -Si vous n'avez plus accès à cette adresse mais que vous avez accès votre adresse e-mail de secours, créez un [ticket d'assistance via le centre d'aide](https://help.ovhcloud.com/csm?id=csm_get_help) afin de remplacer votre adresse e-mail principale par l'adresse e-mail de secours. - -Si vous n'avez accès ni à votre adresse e-mail, ni à votre espace client, ou que vous n'avez pas d'adresse e-mail de secours, il vous faudra suivre [cette procédure](/links/transversal/procedure-email-change). - -Si vous avez oublié votre identifiant client, vous pouvez le retrouver en haut à droite de votre dernière facture. Il ressemble à ceci : « aa00000-ovh » (les premières lettres sont généralement les initiales de la personne qui a créé le compte). Cet identifiant est aussi indiqué dans l’e-mail de confirmation de création du compte, ainsi que dans les e-mails de confirmation ou de renouvellement de commande. +> +> Si vous n'avez plus accès à cette adresse mais que vous avez accès votre adresse e-mail de secours, créez un [ticket d'assistance via le centre d'aide](https://help.ovhcloud.com/csm?id=csm_get_help) afin de remplacer votre adresse e-mail principale par l'adresse e-mail de secours. +> +> Si vous n'avez accès ni à votre adresse e-mail, ni à votre espace client, ou que vous n'avez pas d'adresse e-mail de secours, il vous faudra suivre [cette procédure](/links/transversal/procedure-email-change). +> +> Si vous avez oublié votre identifiant client, vous pouvez le retrouver en haut à droite de votre dernière facture. Il ressemble à ceci : « aa00000-ovh » (les premières lettres sont généralement les initiales de la personne qui a créé le compte). Cet identifiant est aussi indiqué dans l’e-mail de confirmation de création du compte, ainsi que dans les e-mails de confirmation ou de renouvellement de commande. +> /// @@ -223,9 +254,8 @@ La fermeture de votre compte client OVHcloud et la suppression de vos données p Si les conditions ci-dessus sont remplies, vous pouvez demander à supprimer votre compte OVHcloud et les données liées en suivant ces étapes : 1. Connectez-vous au [centre d'aide OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help). -2. Cliquez sur le bouton `Créer un ticket`{.action}. -3. Sélectionnez le motif `Gérez votre compte client OVHcloud`{.action}. -4. Précisez `Je veux fermer mon compte client OVHcloud`{.action} et suivez les étapes décrites. +1. Sélectionnez le motif `Gérez votre compte client OVHcloud`{.action}. +1. Précisez `Je veux fermer mon compte client OVHcloud`{.action} et suivez les étapes décrites. /// @@ -287,7 +317,7 @@ La délégation de service devra être validée par e-mail à la fois par l’ad Avant toute modification, assurez-vous donc que toutes les adresses e-mail de contact sont valides, sans quoi la demande ne pourra aboutir. -Si vous souhaitez récupérer un nom de domaine dont vous êtes le propriétaire enregistré auprès du registre (vous pouvez vérifier ces informations sur [notre outil Whois en ligne](/links/web/domains-whois)), mais que vous n’avez pas accès au compte client administrateur, nous vous invitons à suivre [cette procédure](/links/transversal/procedure-contact-change). +Si vous souhaitez récupérer un nom de domaine dont vous êtes le propriétaire enregistré auprès du registre (vous pouvez vérifier ces informations sur [notre outil WHOIS en ligne](/links/web/domains-whois)), mais que vous n’avez pas accès au compte client administrateur, nous vous invitons à suivre [cette procédure](/links/transversal/procedure-contact-change). > [!success] > Un guide complet sur la gestion des contacts est disponible [ici](/pages/account_and_service_management/account_information/managing_contacts). diff --git a/pages/account_and_service_management/account_information/faq-account-management/guide.it-it.md b/pages/account_and_service_management/account_information/faq-account-management/guide.it-it.md index 75723bfa0b6..b67da2c9950 100644 --- a/pages/account_and_service_management/account_information/faq-account-management/guide.it-it.md +++ b/pages/account_and_service_management/account_information/faq-account-management/guide.it-it.md @@ -1,191 +1,362 @@ --- title: "FAQ sulla gestione dell'account OVHcloud" excerpt: "Trovi le domande più frequenti sulla gestione dell'account OVHcloud" -updated: 2025-04-28 +updated: 2025-10-30 --- + + ## Obiettivo -Trovi le domande più frequenti sulla gestione dell'account OVHcloud. +Trova qui le domande più frequenti sulla gestione del tuo account OVHcloud. + +## FAQ + +/// details | Come creare un account OVHcloud? + +La creazione di un account è gratuita. Questo spazio facilita l'accesso alle tue informazioni e ti permette di gestire i tuoi servizi. Consulta la nostra guida "[Creare un account OVHcloud](/pages/account_and_service_management/account_information/ovhcloud-account-creation)". + +> [!success] +> Una volta creato il tuo account, ricorda di proteggerlo configurando un'autenticazione a due fattori. Trova maggiori informazioni nella nostra guida "[Rendere sicuro il tuo account OVHcloud con la doppia autenticazione](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa)". + +/// + +/// details | Come compilare correttamente il mio numero di telefono durante la creazione del mio account? -### Come creare un account OVHcloud? +Devi inserire il tuo numero di telefono nel formato internazionale. -La creazione di un account è gratuita. Questo spazio facilita l'accesso alle tue informazioni e permette di gestire i tuoi servizi. Consulta la nostra guida [Creare un account OVHcloud](/pages/account_and_service_management/account_information/ovhcloud-account-creation). +> [!success] +> Per “02 1234 5678”, inserisci “+39 02 1234 5678”. Selezionando l’Italia come Paese di residenza il “+39” viene aggiunto automaticamente. + +/// + +/// details | Dove trovare il mio identificativo OVHcloud? + +Il tuo identificativo cliente, talvolta chiamato anche "NIC-handle", è presente in alto a destra sulla tua ultima fattura. Assomiglia a questo: "aa00000-ovh" (le prime lettere sono in genere le iniziali della persona che ha creato l'account). Questo identificativo è anche indicato in tutti gli e-mail inviati da OVHcloud (e-mail di conferma della creazione dell'account, e-mail di conferma o di rinnovo dell'ordine, ecc.). + +Se non hai ancora trovato il tuo identificativo, puoi cliccare sul link "Non ricordi identificativo o password?" presente sulla pagina di [accesso al tuo account OVHcloud](/links/manager). Inserisci quindi l'indirizzo e-mail associato al tuo account. > [!success] -> Una volta creato il tuo account, ricordati di proteggerlo configurando un’autenticazione a due fattori. Per maggiori informazioni, consulta la nostra guida [Proteggere l’account OVHcloud con la doppia autenticazione](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa). +> In qualsiasi momento, quando sei connesso al tuo Spazio Cliente, puoi trovare il tuo identificativo in alto a destra cliccando sul tuo nome. + +/// -#### Consigli e suggerimenti +/// details | Come proteggere il mio account? -Se non riesci a trovare la versione del sito OVHcloud del tuo Paese, clicca sulla bandiera in alto a destra nella homepage per selezionare la lingua che ti interessa. +Sono disponibili diverse soluzioni per proteggere il tuo account, come ad esempio: -### Come recuperare l’identificativo OVHcloud? +- la scelta di una [password complessa e il suo aggiornamento regolare](/pages/account_and_service_management/account_information/manage-ovh-password); +- l'aggiunta di un'[autenticazione a due fattori](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa); +- la configurazione di una [limitazione per IP](/pages/account_and_service_management/account_information/ovhcloud-control-panel-ip-restriction). -Il tuo identificativo cliente, chiamato anche NIC-handle, si trova in alto a destra dell'ultima fattura e ha un formato di questo tipo: aa00000-ovh (le prime lettere corrispondono in genere con le iniziali dell’utente che ha creato l’account). L’identificativo cliente è indicato anche in tutte le email inviate da OVHcloud (email di conferma di creazione dell’account, di rinnovo dell’ordine, ecc.). +Per accedere a queste opzioni, effettua l'accesso al tuo [Spazio Cliente OVHcloud](/links/manager), clicca sul tuo nome in alto a destra, quindi su `Il mio account`{.action}. -Se non riesci a trovare l’identificativo, clicca su "Non ricordi identificativo o password?" nella pagina di connessione allo [Spazio Cliente di OVHcloud](/links/manager) e inserisci l'indirizzo email associato all’account. +Clicca sulla scheda `Sicurezza`{.action} per visualizzarle. -#### Consigli e suggerimenti +/// -L’identificativo cliente è disponibile anche nello Spazio Cliente: viene mostrato in alto a destra nella pagina, accanto al nome utente. +/// details | Come attivare l'autenticazione a due fattori (2FA) sul mio account OVHcloud? -### Cosa fare in caso di impossibilità ad accedere all’account cliente? +Puoi attivare una o più metodi di autenticazione a due fattori per proteggere e controllare l'accesso al tuo Spazio Cliente. Trova tutti i dettagli nella nostra guida "[Rendere sicuro il tuo account OVHcloud con la doppia autenticazione](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa)". -Per diversi motivi potrebbe risultare impossibile identificarsi o accedere allo Spazio Cliente, ad esempio in caso di password dimenticata, perdita di accesso all’indirizzo email oppure al telefono cellulare per l'identificazione via SMS. -In questa evenienza, consigliamo di consultare [questa documentazione](/pages/account_and_service_management/account_information/ovhcloud-account-login#login-failure), che spiega come risolvere questo tipo di problema. +/// -### Come modificare le informazioni personali di un account OVHcloud? +/// details | Cosa fare se non riesco a connettermi al mio account cliente? -Per visualizzare o modificare i dati associati a un account OVHcloud è necessario accedere al proprio profilo nello Spazio Cliente cliccando sulle iniziali del proprio nome che compaiono nella parte destra della dashboard iniziale. Clicca sul tuo nome in alto a destra del tuo [Spazio Cliente OVHcloud](/links/manager) e poi su `Accedere al mio account`{.action}. +Hai dimenticato la tua password? Non hai più accesso alla tua e-mail? Hai configurato un'autenticazione a due fattori ma il tuo telefono è rotto/perduto/sparito? +Per tutti questi casi, consulta [questa documentazione](/pages/account_and_service_management/account_information/ovhcloud-account-login#login-failure) che ti permetterà di conoscere le procedure appropriate. -Nella sezione `Il tuo profilo`{.action} a destra dello schermo (clicca di nuovo sul tuo nome per eliminare il menu a sinistra), clicca su `Modifica il tuo profilo`{.action}. +/// -#### Consigli e suggerimenti +/// details | Come modificare la password del mio account OVHcloud? -Per modificare l’indirizzo email associato all’account OVHcloud, accedi alla pagina di modifica del profilo e inserisci la nuova email. Riceverai un messaggio di conferma all’indirizzo impostato precedentemente. Se non riesci più ad accedere a questo indirizzo ma ne possiedi uno di recupero, è possibile contattare il supporto via ticket e richiedere di utilizzarlo come email principale. +Effettua l'accesso al tuo [Spazio Cliente OVHcloud](/links/manager), clicca sul tuo nome in alto a destra, quindi su `Il mio account`{.action}. -### Come inserire correttamente il numero di telefono durante la creazione dell’account? +Clicca sulla scheda `Sicurezza`{.action}, quindi sul pulsante `Modifica`{.action} situato a destra della voce **Password**. Puoi quindi modificare la tua password corrente. Un messaggio di sicurezza appare per informarti che stai per effettuare un cambio password. Dopo la tua conferma, riceverai (all'indirizzo e-mail principale indicato nell'account) un'e-mail contenente la procedura da seguire. -Il numero di telefono deve essere inserito nel formato internazionale. +Trova maggiori informazioni nella nostra guida "[Impostare e gestire la password di un account OVHcloud](/pages/account_and_service_management/account_information/manage-ovh-password)". + +> [!success] +> **Non ricordi più la tua password?** +> +> Vai alla [pagina di accesso al tuo Spazio Cliente](/links/manager) e clicca su `Non ricordi identificativo o password?`{.action}. Inserisci il tuo identificativo o l'e-mail principale associata al tuo account OVHcloud, quindi clicca su `Invia`{.action}. Un'e-mail viene inviata all'indirizzo e-mail di contatto dell'account, per confermare la richiesta. Leggi attentamente le istruzioni e clicca sul link che contiene. +> +> Se non hai più accesso a questa e-mail ma hai accesso alla tua e-mail di riserva, crea un [ticket di assistenza tramite il centro di aiuto](https://help.ovhcloud.com/csm?id=csm_get_help) per sostituire la tua e-mail principale con l'e-mail di riserva. +> +> Se non hai accesso né alla tua e-mail, né al tuo Spazio Cliente, né hai un'e-mail di riserva, dovrai seguire [questa procedura](/links/transversal/procedure-email-change). +> +> Se hai dimenticato il tuo identificativo cliente, puoi trovarlo in alto a destra sulla tua ultima fattura. Assomiglia a questo: "aa00000-ovh" (le prime lettere sono in genere le iniziali della persona che ha creato l'account). Questo identificativo è anche indicato nell'e-mail di conferma della creazione dell'account, così come negli e-mail di conferma o di rinnovo dell'ordine. +> -#### Consigli e suggerimenti +/// -Per “02 123456”, inserisci “+39 02 123456”. Selezionando l’Italia come Paese di residenza il “+39” viene aggiunto automaticamente. +/// details | Esiste un limite al numero di volte in cui posso modificare la password del mio account OVHcloud (tramite l'opzione "Non ricordi identificativo o password?")? -### Quali sono gli effetti del GDPR sui dati personali? +OVHcloud non impone un limite al numero di modifiche alla password, puoi modificarla quante volte desideri. -Per conoscere meglio l’impatto del Regolamento Generale sulla Protezione dei Dati (GDPR) sulla tua attività professionale o sulle tue informazioni personali, ti invitiamo a consultare queste pagine: +Tuttavia, il nostro sistema invia le e-mail al tuo indirizzo e-mail di contatto e potrebbe capitare che il tuo fornitore di posta blocchi la posta se richiedi molti cambiamenti di password in pochi minuti. -- [OVHcloud e la protezione dei dati personali](https://www.ovhcloud.com/it/personal-data-protection/) -- [GDPR - Le risposte alle tue domande](https://www.ovhcloud.com/it/personal-data-protection/faq/) +/// -### Come modificare la password OVHcloud? +/// details | Non ho attivato l'autenticazione a due fattori sul mio account ma mi chiede comunque un codice. Come disattivare questa funzione? -Accedi alla pagina di login dello Spazio Cliente e clicca su “Non ricordi identificativo o password?”. Inserisci l’identificativo o l’indirizzo email principale associato all’account OVHcloud e clicca su “Invia”. Riceverai un’email per confermare la richiesta all’indirizzo di contatto impostato. Leggi le istruzioni e clicca sul link contenuto nell’email. +Anche se l'autenticazione a due fattori non è attivata sul tuo account, ti può essere richiesto un codice di verifica per confermare la tua identità. Questa misura mira a proteggere il tuo account e i tuoi dati e non è possibile disattivarla. -#### Consigli e suggerimenti +Il codice di sicurezza ti viene inviato per e-mail **all'indirizzo principale** che hai indicato sull'account. + +Se non trovi questo codice, ricorda di controllare le cartelle "spam" / "posta indesiderata" della tua e-mail. + +> [!success] +> - L'attivazione dell'autenticazione a due fattori sul tuo account ti permette di scegliere il dispositivo da utilizzare (telefono, tablet, smartphone, chiave U2F) per ricevere un codice di autenticazione. Maggiori informazioni nella nostra guida "[Rendere sicuro il tuo account OVHcloud con la doppia autenticazione](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa)". +> - Puoi anche mettere in atto una sicurezza aggiuntiva per limitare l'accesso al tuo account OVHcloud a una o più indirizzi IP. Maggiori informazioni nella nostra guida "[Limitare l'accesso via IP al tuo Spazio Cliente OVHcloud](/pages/account_and_service_management/account_information/ovhcloud-control-panel-ip-restriction)". + +/// + +/// details | Come disattivare l'autenticazione a due fattori (2FA) sul mio account OVHcloud? + +Se il tuo dispositivo (telefono cellulare / smartphone / chiave di sicurezza) utilizzato per l'autenticazione a due fattori è perduto, rubato o non funziona più, puoi: + +- utilizzare [i codici di riserva](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#codes) attivi che hai salvato; +- utilizzare un altro dispositivo di autenticazione a due fattori a tua disposizione, se ne hai attivati diversi; +- [disattivare l'autenticazione a due fattori](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#desactivation). + +Consulta la parte "[Cosa fare se uno dei miei dispositivi è perduto/rubato o smette di funzionare?](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#lost-device)" o la parte "[Disattivare completamente l'autenticazione a due fattori](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#desactivation)" della nostra guida sull'autenticazione a due fattori. + +/// + +### Gestire le informazioni personali + +/// details | Come modificare le mie informazioni personali? + +Per visualizzare o modificare le tue coordinate, effettua l'accesso al tuo [Spazio Cliente OVHcloud](/links/manager), clicca sul tuo nome in alto a destra, quindi su `Il mio account`{.action}. + +Clicca quindi su `Modifica il mio profilo`{.action}, nel riquadro `Il mio profilo`. + +> [!success] +> **Vuoi modificare l'indirizzo e-mail del tuo account OVHcloud?** +> +> Ti verrà prima inviata una richiesta di conferma all'indirizzo e-mail che hai attualmente indicato nel tuo Spazio Cliente. Se non riesci più ad accedere a questa e-mail, è necessario attendere 24 ore. Trascorso questo periodo, il cambiamento sarà effettuato automaticamente. +> -Se non riesci più ad accedere all’indirizzo email di contatto, ti suggeriamo di seguire questa [procedura](https://www.ovh.it/cgi-bin/it/procedure/procedureChangeEmail.cgi). -Se hai dimenticato il tuo identificativo cliente, è possibile recuperarlo da qualsiasi fattura: viene indicato in alto a destra e ha un formato di questo tipo: aa00000-ovh (le prime lettere corrispondono in genere con le iniziali dell’utente che ha creato l’account). L’identificativo cliente è indicato anche nell’email di conferma di creazione dell’account o di rinnovo dell’ordine. +/// -### Come modificare i contatti di un account OVHcloud? +/// details | Come accedere ai contratti e alle condizioni generali di servizio? -Dallo Spazio Cliente è possibile delegare ad altri account cliente OVHcloud la gestione amministrativa, tecnica e di fatturazione dei servizi. Per effettuare questa operazione accedi allo [Spazio Cliente OVHcloud](/links/manager), clicca sul tuo nome in alto a destra e poi su `I miei contatti`{.action}. +Puoi trovare i contratti dei tuoi servizi OVHcloud direttamente nel tuo [Spazio Cliente](/links/manager). Una volta connesso, vai al menu `Il mio account`{.action} e clicca su `Visualizzare i miei contratti`{.action}. -La delega dei servizi dovrà essere convalidata via email dall'amministratore del servizio e dal nuovo contatto. +Puoi anche consultare i contratti sul nostro sito, tramite [questo link](/links/terms-conditions-contracts). -Prima di apportare qualsiasi modifica, assicurati che tutti gli indirizzi email di contatto siano validi. In caso contrario la richiesta non potrà essere completata. +Questa pagina contiene tutte le informazioni necessarie sui nostri contratti, compresi i termini e le condizioni dei nostri servizi. -Se vuoi recuperare un dominio di cui risulti proprietario presso il Registro (verifica questa informazione su [www.ovh.it/cgi-bin/tools/check_whois.pl](http://www.ovh.it/cgi-bin/tools/check_whois.pl)) ma non disponi dell’accesso all'account amministratore, ti invitiamo a seguire gli step indicati in questa procedura: [www.ovh.it/cgi-bin/fr/procedure/procedureChangeContacts.cgi](https://www.ovh.it/cgi-bin/fr/procedure/procedureChangeContacts.cgi). +/// -#### Consigli e suggerimenti +/// details | Quali sono gli impatti del RGPD sulle mie informazioni personali? -Per maggiori informazioni sulla gestione dei contatti, consulta questa [guida](/pages/account_and_service_management/account_information/managing_contacts#accedi-alla-pagina-di-gestione-dei-contatti). +Per conoscere meglio gli impatti del regolamento generale sulla protezione dei dati (RGPD) sulla tua attività professionale o sulle tue informazioni personali, ti proponiamo di consultare queste risorse: -### Come configurare o modificare il contatto di fatturazione? +- [OVHcloud e la protezione dei dati personali](/links/transversal/personal-data-protection); +- [RGPD: le domande che ti poni](/links/transversal/personal-data-protection-faq). -Accedi allo [Spazio Cliente OVHcloud](/links/manager), clicca sul tuo nome in alto a destra e poi su `I miei contatti`{.action}. +/// -#### Consigli e suggerimenti +/// details | Posso modificare manualmente il mio identificativo cliente? Vorrei altre lettere o numeri. -Per maggiori informazioni sulla gestione dei contatti, consulta la guida [Gestire i contatti dei servizi OVHcloud](/pages/account_and_service_management/account_information/managing_contacts). +L'identificativo cliente non può essere modificato poiché è legato alle informazioni fornite al momento della creazione del tuo account OVHcloud. Le prime due lettere corrispondono generalmente alle iniziali del nome dell'amministratore, mentre i numeri successivi vengono generati in modo casuale. -### Come proteggere il proprio account? +Tuttavia, hai la possibilità di [creare un nuovo account OVHcloud](/pages/account_and_service_management/account_information/ovhcloud-account-creation). Dovrai però trasferire manualmente tutti i tuoi servizi verso il nuovo account seguendo il [processo di cambio contatti](/pages/account_and_service_management/account_information/managing_contacts). -Sono disponibili diverse soluzioni per proteggere il tuo account, come: +/// -- la scelta di una password complessa -- il rinnovo regolare della password -- doppia autenticazione +/// details | Posso cambiare la filiale del mio account OVHcloud? -Per la doppia autenticazione tramite l'invio di un codice via SMS o tramite la restrizione IP (autorizzazione o rifiuto di accesso ad alcuni indirizzi), è possibile aggiungere regole di sicurezza dal tuo Spazio Cliente. Queste opzioni sono disponibili nella sezione "Sicurezza" del tuo profilo. Accedi allo [Spazio Cliente OVHcloud](/links/manager), clicca sul tuo nome in alto a destra e poi su `Accedere al mio account`{.action}. +Se hai creato un account OVHcloud nella filiale sbagliata, puoi creare un nuovo account nella filiale corretta con le stesse informazioni personali. -Clicca sulla scheda `Sicurezza`{.action} +Tuttavia, devi associare un indirizzo e-mail di contatto diverso, poiché non è possibile disporre di due account OVHcloud diversi con lo stesso indirizzo e-mail di contatto. -Per maggiori informazioni, visualizza il [video](https://www.youtube.com/watch?v=odO58c4gJfc&list=PL0DynEzr_sE5MnOfJOpVJN-EhfMDWoqGS&index=24). +Troverai informazioni complementari sulla creazione di un account OVHcloud nella nostra guida "[Creare un account OVHcloud](/pages/account_and_service_management/account_information/ovhcloud-account-creation)". -### Come attivare la doppia autenticazione/2FA di OVHcloud? +Una volta che hai creato il tuo nuovo account OVHcloud nella filiale corretta, puoi seguire le istruzioni di [questa guida](/pages/account_and_service_management/account_information/managing_contacts) per spostare i tuoi servizi da un account all'altro. -Dopo aver creato il tuo account cliente OVHcloud, ti consigliamo di proteggere i tuoi dati personali attivando la doppia autenticazione. Puoi effettuare questa operazione accedi allo [Spazio Cliente OVHcloud](/links/manager), clicca sul tuo nome in alto a destra e poi su `Accedere al mio account`{.action}. +Se possiedi un account OVHcloud nella nostra infrastruttura canadese (ovvero in un paese fuori dall'Europa), non potrai spostare i servizi tra gli account. In questo caso, sarà necessario ordinare nuovi servizi nel nuovo account e migrare manualmente i tuoi contenuti, se necessario. -Clicca sulla scheda `Sicurezza`{.action}. Inoltre, per attivare la 2FA, puoi autenticarti in diversi modi: +Per qualsiasi informazione complementare, contatta il nostro supporto creando un [ticket di assistenza dal centro di aiuto OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help). -- tramite SMS, con un codice di sicurezza; -- da un'applicazione mobile compatibile con Android, Iphone e Windows mobile; -- tramite una chiave di sicurezza compatibile con U2F. +/// -Para más información, haga clic [aquí](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa) +/// details | Come cancellare il mio account OVHcloud? -### Come disattivare la doppia autenticazione/2FA di OVHcloud? +La chiusura del tuo account cliente OVHcloud e l'eliminazione delle tue informazioni personali è possibile solo se: -Per disattivare la doppia autenticazione, accedi allo [Spazio Cliente OVHcloud](/links/manager), clicca sul tuo nome in alto a destra e poi su `Accedere al mio account`{.action}. +1. Non hai più servizi visibili nella sezione "[Le mie offerte e servizi](https://www.ovh.com/manager/dedicated/#/billing/autoRenew)". In caso contrario, dovrai prima richiedere la loro cancellazione e attendere la loro rimozione. +2. Non hai fatture in sospeso. In caso contrario, dovrai procedere al pagamento cliccando sul pulsante `Paga immediatamente`{.action} nelle azioni di massa della pagina "[Le tue fatture](https://www.ovh.com/manager/#/dedicated/billing/history)". +3. Non hai ordini in corso. Verifica qui [questa pagina](https://www.ovh.com/manager/#/dedicated/billing/orders/orders). +4. Il tuo conto prepagato non è positivo. Verifica qui [questa pagina](https://www.ovh.com/manager/#/dedicated/billing/payment/ovhaccount). -Clicca sulla scheda `Sicurezza`{.action}. +Se le condizioni sopra indicate sono soddisfatte, puoi richiedere l'eliminazione del tuo account OVHcloud e i dati ad esso collegati seguendo questi passaggi: -Le diverse periferiche di sicurezza possono essere disattivate una alla volta.  -Se non riesci ad accedere allo Spazio Cliente perché hai perso la periferica di doppia autenticazione, ti invitiamo a contattare il supporto OVHcloud per richiedere a un consulente di disattivare manualmente il dispositivo, previa presentazione di documenti giustificativi. +1. Accedi al [centro di assistenza OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help). +1. Seleziona il motivo `Gestisci il tuo account client OVHcloud`{.action}. +1. Specifica `Voglio chiudere il mio account client OVHcloud`{.action} e segui le istruzioni descritte. -### Cosa fare se l’account OVHcloud è vittima di hacking? +/// -In caso di utilizzo fraudolento dell’account OVHcloud (identità, metodo di pagamento...), ti suggeriamo di rivolgerti il prima possibile alle autorità competenti. In Italia il reparto specializzato preposto al contrasto delle frodi postali e del crimine informatico è quello della Polizia Postale. Le segnalazioni per reati telematici possono essere inviate direttamente tramite il loro sito Web, dalla pagina . +### Gestire le notifiche e i log -Sarà poi questo stesso dipartimento a contattarci per svolgere le opportune verifiche e accertamenti tecnici. Con l’avvio di questa procedura, l’identificativo cliente verrà bloccato e i servizi attivati in maniera fraudolenta sospesi. +/// details | Posso ricevere tutte le notifiche di OVHcloud su più indirizzi email? + +Purtroppo non è possibile inviare email di comunicazione a più indirizzi. + +Dallo [Spazio Cliente OVHcloud](/links/manager), è comunque possibile configurare un indirizzo email di riserva che non verrà utilizzato per l'invio di tutte le nostre comunicazioni (rinnovi, disattivazioni di servizi, ecc.). + +Questo indirizzo email di riserva è utile in caso di perdita di accesso al proprio indirizzo email principale, poiché ti impedirebbe di accedere allo Spazio Cliente OVHcloud. + +/// + +/// details | Ho ricevuto una notifica da parte vostra in un'altra lingua. Come posso correggerlo? + +Puoi modificare la lingua delle nostre email automatizzate seguendo questi passaggi: + +1. Accedi allo [Spazio Cliente OVHcloud](/links/manager). +1. Vai quindi al [centro di assistenza OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help). +1. Clicca su `Accedi al centro di assistenza`{.action} e conferma il tuo accesso. +1. Clicca sulla bandiera in alto a destra del centro di assistenza e seleziona il paese/la regione corrispondente alla lingua desiderata. +1. Clicca su `Esci dal centro di assistenza`{.action}. + +Successivamente, le prossime notifiche automatizzate via email saranno inviate nella lingua desiderata. + +/// + +/// details | Posso visualizzare tutte le azioni effettuate dal client? Ci sono dei log? + +Sì, puoi accedere ai log delle azioni effettuate sul tuo account. + +Per farlo, devi accedere alle [API OVHcloud](/links/api) seguendo la guida "[Primi passi con le API OVHcloud](/pages/manage_and_operate/api/first-steps)". Una volta connesso, puoi utilizzare l'API seguente per recuperare l'ID del log: + +> [!api] +> +> @api {v1} /me GET /me/api/logs/self +> + +Otterrai quindi l'elenco degli identificativi dei log. Successivamente, puoi utilizzare l'API seguente per recuperare i dettagli di un log specifico: + +> [!api] +> +> @api {v1} /me GET /me/api/logs/self/{logId} +> + +Sostituisci `{logId}` con l'identificativo reale del log che desideri consultare. Questo ti permetterà di accedere al log e visualizzare le azioni effettuate dal client. + +/// + +### Delegare l'accesso ai propri servizi + +/// details | Come posso delegare l'accesso ai miei servizi ad altre persone? + +Hai la possibilità di delegare ad altri account client OVHcloud la gestione amministrativa, tecnica e fatturazione dei tuoi servizi dal tuo spazio client. Per farlo, accedi al tuo [Spazio Cliente OVHcloud](/links/manager), clicca sul tuo nome in alto a destra, quindi su `I miei contatti`{.action}. + +L'assegnazione del servizio dovrà essere validata via email sia dall'amministratore del servizio che dal nuovo contatto. + +Prima di apportare qualsiasi modifica, assicurati quindi che tutti gli indirizzi email di contatto siano validi, altrimenti la richiesta non potrà essere completata. + +Se desideri recuperare un nome di dominio di cui sei il proprietario registrato presso il registro (puoi verificare queste informazioni tramite [il nostro strumento WHOIS online](/links/web/domains-whois)), ma non hai accesso all'account client amministrativo, ti invitiamo a seguire [questa procedura](/links/transversal/procedure-contact-change). + +> [!success] +> Una guida completa sulla gestione dei contatti è disponibile [qui](/pages/account_and_service_management/account_information/managing_contacts). + +/// + +/// details | Come configurare o modificare un contatto per la fatturazione? + +Accedi al tuo [Spazio Cliente OVHcloud](/links/manager), clicca sul tuo nome in alto a destra, quindi su `I miei contatti`{.action}. + +> [!success] +> Se desideri saperne di più sulla gestione dei contatti, ti invitiamo a consultare questa guida dettagliata: "[Gestire i contatti dei servizi OVHcloud](/pages/account_and_service_management/account_information/managing_contacts)". -Per ripristinare la corretta operatività dell’account cliente, potremmo chiederti di modificare l’indirizzo email associato e la relativa password tramite la procedura disponibile a questo [link](https://www.ovh.it/cgi-bin/it/procedure/procedureChangeEmail.cgi). +/// -### Ho ricevuto una possibile email di phishing che utilizza l’identità di OVHcloud: come segnalarla per effettuare una verifica? +/// details | Vorrei spostare tutti i miei servizi su un altro account OVHcloud, come posso farlo in un'unica volta? -Per identificare e segnalare un'email o un SMS di phishing, consulta la nostra [guida dedicata](/pages/account_and_service_management/account_information/phishing_care). +Per trasferire tutti i tuoi servizi su un altro account OVHcloud, ti consigliamo di [contattare direttamente il nostro supporto tecnico](https://help.ovhcloud.com/csm?id=csm_get_help). Le nostre squadre saranno in grado di guidarti durante l'intero processo e di aiutarti nel trasferimento di massa dei tuoi servizi verso il nuovo account. -### Come segnalare un comportamento fraudolento o contenuti illeciti provenienti da servizi ospitati da OVHcloud di cui sono vittima? +/// -Tutti i comportamenti fraudolenti e contenuti illeciti possono essere segnalati sulla piattaforma OVHcloud dedicata [www.ovh.com/abuse/](https://www.ovh.com/abuse/), selezionando la categoria nella lista e completando i campi richiesti. +### Segnalare un'attività abusiva/illecita o un furto d'identità -Ricordiamo che al titolare del servizio segnalato possono essere trasmessi esclusivamente i log e gli elementi tecnici, pertanto è inutile riportare in questi campi dati personali. +/// details | Cosa fare se il mio account OVHcloud è stato violato? -### Una volta inviata, cosa ne sarà della segnalazione di abuso? +In caso di utilizzo fraudolento del tuo account OVHcloud (identità, mezzi di pagamento, ecc.), ti invitiamo a depositare una denuncia il più rapidamente possibile presso la Prefettura di Polizia o la Gendarmeria. -La segnalazione verrà presa in carico nel più breve tempo possibile dall’ufficio legale di OVHcloud, che procederà ad analizzata e, se necessario, richiederà ulteriori precisazioni e dettagli. Se il comportamento abusivo di uno dei nostri clienti viene accertato, provvederemo ad informarti e faremo tutto il necessario per contattare le persone interessate e risolvere il problema quanto prima. +Appena la denuncia sarà in tuo possesso, dovrai inviarci una copia. Questa permetterà di avviare le nostre procedure interne. -### OVHcloud mi ha inviato un'email per comunicare un possibile comportamento fraudolento da parte mia: cosa fare? +Contatta il supporto OVHcloud via telefono: -Se i nostri team hanno ricevuto una segnalazione o constatato un comportamento fraudolento, riceverai un’email proveniente da un account con formato di tipo "ticket+"numero di ticket"@abuse.ovh.net". +- Italia: +39 02 5560 0423 -Tenuto conto degli elementi aggiuntivi indicati nell'email, ti chiederemo di effettuare un'indagine per correggere il comportamento fraudolento e/o eliminare qualsiasi contenuto illecito. +Il tuo identificativo client sarà bloccato e i servizi sottoscritti fraudolentemente saranno eliminati. -Per assicurarti che i servizi utilizzati non si trovino sotto il controllo di terzi (ad esempio in caso di hacking), consigliamo di verificarne il livello di sicurezza: +Infine, per riprendere l'uso del tuo account client, ti potremo chiedere di modificare la tua e-mail e/o la tua password tramite [questa procedura](/links/transversal/procedure-email-change). -- [Rendere sicuro il tuo account OVHcloud e gestire i tuoi dati personali](/pages/account_and_service_management/account_information/all_about_username) -- [Impostare e gestire la password di un account OVHcloud](/pages/account_and_service_management/account_information/manage-ovh-password) -- [Rendere sicuro il tuo account OVHcloud con la doppia autenticazione](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa) -- [Come proteggere il tuo sito Web?](/pages/web_cloud/web_hosting/secure_your_website) -- [Mettere in sicurezza un VPS](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps) -- [Mettere in sicurezza un server dedicato](/pages/bare_metal_cloud/dedicated_servers/securing-a-dedicated-server) +/// -### In caso di identificazione di un eventuale abuso su uno dei miei servizi OVHcloud, come evitarne la sospensione? +/// details | Ho ricevuto un'e-mail che sembra phishing che imita l'identità di OVHcloud, come posso segnalarla per la verifica? -Una volta effettuate le operazioni necessarie, rispondi direttamente all'email ricevuta dal nostro servizio Abuse, precisando le misure adottate. -Un membro del nostro team risponderà il prima possibile. +Per identificare e segnalare un'e-mail o un SMS di phishing, consulta la nostra [guida dedicata](/pages/account_and_service_management/account_information/phishing_care). -### Ho risposto all’email di Abuse di OVHcloud ma il servizio è sempre bloccato: cosa fare? +/// -Dallo Spazio Cliente è possibile inviare una richiesta di assistenza al servizio [Help Center di OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help) per ottenere maggiori informazioni sullo stato del ticket da parte del team Abuse. Per semplificare la gestione della richiesta, ricorda di riportare il numero di riferimento del ticket. +/// details | Come segnalare un comportamento abusivo o contenuti illeciti provenienti da servizi ospitati da OVHcloud e di cui sono vittima? -### Come eliminare un account OVHcloud? +Trova le risposte alle domande sulla segnalazione di comportamenti abusivi o contenuti illeciti nella nostra [FAQ sul supporto OVHcloud](/pages/account_and_service_management/account_information/faq-support). -La chiusura del tuo account cliente OVHcloud e la cancellazione dei tuoi dati personali è possibile solo se: +/// -1. Non disponi più di servizi visibili nella sezione "[I tuoi servizi](https://www.ovh.com/manager/dedicated/#/billing/autoRenew)". In caso contrario, dovrai prima richiederne la disattivazione e attenderne l’eliminazione. -2. Non ci sono fatture in attesa di pagamento. In caso contrario, è necessario procedere al loro pagamento cliccando sul pulsante `Salda subito`{.action} nelle azioni di massa nella pagina "[Le mie fatture](https://www.ovh.com/manager/#/dedicated/billing/history)". -3. Non sono presenti ordini in corso. Verificatelo su [questa pagina](https://www.ovh.com/manager/#/dedicated/billing/orders/orders). -4. Il tuo conto prepagato non è positivo. Verifica la tua password all’indirizzo [questa pagina](https://www.ovh.com/manager/#/dedicated/billing/payment/ovhaccount). +/// details | OVHcloud mi ha inviato un'e-mail che indica un possibile comportamento abusivo da parte mia, cosa devo fare? -Se le condizioni di cui sopra sono soddisfatte, puoi richiedere di eliminare il tuo account OVHcloud e i dati ad esso associati seguendo questi step: +Trova le risposte alle domande sulla segnalazione di comportamenti abusivi o contenuti illeciti nella nostra [FAQ sul supporto OVHcloud](/pages/account_and_service_management/account_information/faq-support). -1. Connettiti al [Help Center di OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help). -2. Clicca sul pulsante `Crea un ticket`{.action}. -3. Seleziona il motivo `Gestisci il tuo account cliente OVHcloud`{.action}. -4. Indica `Voglio chiudere il mio account cliente OVHcloud`{.action} e segui gli step descritti. +/// ## Per saperne di più diff --git a/pages/account_and_service_management/account_information/faq-account-management/guide.pl-pl.md b/pages/account_and_service_management/account_information/faq-account-management/guide.pl-pl.md index a04746001ad..194c44a56d9 100644 --- a/pages/account_and_service_management/account_information/faq-account-management/guide.pl-pl.md +++ b/pages/account_and_service_management/account_information/faq-account-management/guide.pl-pl.md @@ -1,199 +1,361 @@ --- title: FAQ dotyczący zarządzania kontem OVHcloud excerpt: Najczęściej zadawane pytania dotyczące zarządzania kontem OVHcloud -updated: 2025-04-28 +updated: 2025-10-30 --- + + ## Wprowadzenie -Najczęściej zadawane pytania dotyczące zarządzania kontem OVHcloud. +Znajdź najczęściej zadawane pytania dotyczące zarządzania kontem OVHcloud. + +## Często zadawane pytania + +### Tworzenie konta OVHcloud, logowanie i jego zabezpieczenie + +/// details | Jak utworzyć konto OVHcloud? + +Utworzenie konta jest darmowe. Ten obszar ułatwia dostęp do Twoich informacji i umożliwia zarządzanie Twoimi usługami. Zapoznaj się z naszym przewodnikiem "[Utwórz konto OVHcloud](/pages/account_and_service_management/account_information/ovhcloud-account-creation)". + +> [!success] +> Po utworzeniu konta pamiętaj, aby je zabezpieczyć, skonfigurując podwójną autoryzację. Aby uzyskać więcej informacji, zapoznaj się z naszym przewodnikiem "[Zabezpieczenie konta OVHcloud za pomocą weryfikacji dwuetapowej](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa)". + +/// -### Jak otworzyć konto OVHcloud? +/// details | Jak poprawnie wpisać numer telefonu podczas tworzenia konta? -Otwarcie konta jest darmowe. Dzięki niemu masz łatwy dostęp do swoich danych i możesz zarządzać swoimi usługami. Zapoznaj się z naszym przewodnikiem [Utwórz konto OVHcloud](/pages/account_and_service_management/account_information/ovhcloud-account-creation). +Musisz wpisać numer telefonu w formacie międzynarodowym. > [!success] -> Po utworzeniu konta pamiętaj, aby go zabezpieczyć, konfigurując weryfikację dwuetapową. Więcej informacji znajdziesz w naszym przewodniku [Zabezpiecz konto OVHcloud za pomocą weryfikacji dwuetapowej](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa). +> Dla numeru “06 12 34 56 78" należy zatem wpisać “+48 612345678". Prefiks “+48" dodawany jest automatycznie po wybraniu Polski jako kraju zamieszkania. + +/// + +/// details | Gdzie znaleźć identyfikator konta OVHcloud? + +Twój identyfikator klienta, czasem nazywany "NIC-handle", znajduje się w prawym górnym rogu Twojej ostatniej faktury. Wygląda to mniej więcej tak: "aa00000-ovh" (pierwsze litery są zazwyczaj inicjałami osoby, która utworzyła konto). Ten identyfikator jest również wskazany we wszystkich wiadomościach e-mail wysyłanych przez OVHcloud (e-mail potwierdzający utworzenie konta, e-maile potwierdzające lub odnawiające zamówienie itp.). + +Jeśli nadal nie możesz odnaleźć swojego identyfikatora, możesz kliknąć link "Nie pamiętasz identyfikatora klienta lub hasła?" znajdujący się na stronie [logowania do konta OVHcloud](/links/manager). Następnie wpisz adres e-mail przypisany do Twojego konta. + +> [!success] +> W dowolnym momencie, gdy jesteś zalogowany do swojego konta, możesz odnaleźć swój identyfikator w prawym górnym rogu, klikając na swoje imię. + +/// -#### Wskazówki i porady +/// details | Jak zabezpieczyć moje konto? -Nie możesz odnaleźć Twojego kraju? Zmień język strony klikając na odpowiednią flagę w prawym górnym rogu. +Masz kilka opcji, aby zabezpieczyć swoje konto, takich jak: -### Gdzie mogę znaleźć swój identyfikator OVHcloud? +- wybór [skomplikowanego hasła i jego regularne odnawianie](/pages/account_and_service_management/account_information/manage-ovh-password); +- dodanie [podwójnej autoryzacji](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa); +- skonfigurowanie [ograniczenia według adresu IP](/pages/account_and_service_management/account_information/ovhcloud-control-panel-ip-restriction). -Swój identyfikator klienta, zwany także NIC-handle, znajdziesz w prawym górnym rogu na ostatniej fakturze. Zbudowany jest w następujący sposób: "aa00000-ovh" (pierwsze litery to zazwyczaj inicjały osoby, która założyła konto). Identyfikator jest również podawany we wszystkich wiadomościach e-mail wysyłanych przez OVHcloud (e-mail z potwierdzeniem utworzenia konta, e-mail z potwierdzeniem lub odnowieniem zamówienia itp.) +Aby uzyskać dostęp do tych opcji, zaloguj się do swojego [konta OVHcloud](/links/manager), kliknij swoje imię w prawym górnym rogu, a następnie kliknij `Moje konto`{.action}. -Jeśli nie dysponujesz loginem, kliknij link “Nie pamiętam loginu lub hasła” na stronie [logowania do konta OVHcloud](/links/manager) i wpisz adres e-mail przypisany do Twojego konta. +Kliknij kartę `Bezpieczeństwo`{.action}, aby je wyświetlić. -#### Porady i wskazówki +/// -Po zalogowaniu do swojej strefy klienta, identyfikator znajdziesz w prawym górnym rogu, obok swojego nazwiska. +/// details | Jak aktywować podwójną autoryzację (2FA) na moim koncie OVHcloud? -### Co zrobić, jeśli nie mogę zalogować się do mojego konta klienta? +Możesz aktywować jedną lub więcej metod podwójnej autoryzacji, aby zabezpieczyć i kontrolować dostęp do swojego konta. Aby uzyskać wszystkie szczegóły, zapoznaj się z naszym przewodnikiem "[Zabezpieczenie konta OVHcloud za pomocą weryfikacji dwuetapowej](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa)". -Może się zdarzyć z różnych powodów, takich jak zapomnienie hasła, utrata dostępu do konta e-mail lub do telefonu komórkowego służącego do identyfikacji za pomocą SMS, że użytkownik nie jest w stanie zalogować się do Panelu klienta. -W takiej sytuacji zachęcamy do zapoznania się z poniższą [dokumentacją](/pages/account_and_service_management/account_information/ovhcloud-account-login#login-failure), z której dowiesz się, jak rozwiązać ten problem. +/// -### Jak zmienić dane osobowe? +/// details | Co zrobić, jeśli nie mogę się zalogować do mojego konta? -Aby wyświetlić lub zmienić dane, zaloguj się do Panelu klienta za pomocą identyfikatora oraz hasła dostępu. Aby uzyskać dostęp do danych osobowych, klikając w prawym górnym rogu [Panelu klienta OVHcloud](/links/manager) Twoje nazwisko, a następnie wybierając `Dostęp do konta`{.action}. +Zapomniałeś hasła? Nie masz już dostępu do swojego adresu e-mail? Skonfigurowałeś podwójną autoryzację, ale Twój telefon jest uszkodzony/utracony/skonfiskowany? +W każdym z tych przypadków, zapoznaj się z [tą dokumentacją](/pages/account_and_service_management/account_information/ovhcloud-account-login#login-failure), która pomoże Ci zrozumieć odpowiednie procedury. -W sekcji `Mój profil`{.action} po prawej stronie ekranu (kliknij ponownie nazwę, aby usunąć menu po lewej stronie), kliknij `Edytuj moj profil`{.action}. +/// -#### Wskazówki i porady +/// details | Jak zmienić hasło do mojego konta OVHcloud? -Chcesz zmienić adres e-mail przypisany do Twojego konta OVHcloud? Na adres aktualnie widniejący w Panelu klienta, zostanie wysłana wiadomość z prośbą o potwierdzenie. Jeżeli nie masz już dostępu do tego adresu, wystarczy, że odczekasz 24 godziny. Po ich upływie zmiana adresu zostanie automatycznie zarejestrowana. +Zaloguj się do swojego [konta OVHcloud](/links/manager), kliknij swoje imię w prawym górnym rogu, a następnie kliknij `Moje konto`{.action}. -### Jak poprawnie wpisać mój numer telefonu w momencie zakładania konta? +Kliknij kartę `Bezpieczeństwo`{.action}, a następnie kliknij przycisk `Zmień`{.action} po lewej stronie od słowa **Hasło**. Możesz następnie zmienić swoje obecne hasło. Wyświetlany jest komunikat bezpieczeństwa, który informuje Cię, że jesteś na punkcie zmiany hasła. Po potwierdzeniu, otrzymasz (na główny adres e-mail podany w koncie) wiadomość e-mail zawierającą procedurę do wykonania. -Numer telefonu powinien zostać wpisany w formacie międzynarodowym. +Aby uzyskać więcej informacji, zapoznaj się z naszym przewodnikiem "[Tworzenie i zarządzanie hasłem do konta](/pages/account_and_service_management/account_information/manage-ovh-password)". -#### Wskazówki i porady +> [!success] +> **Nie pamiętasz swojego hasła?** +> +> Przejdź na [stronę logowania do swojego konta](/links/manager) i kliknij `Nie pamiętasz identyfikatora klienta lub hasła?`{.action}. Wpisz swój identyfikator lub główny adres e-mail przypisany do Twojego konta OVHcloud, a następnie kliknij `Wyślij`{.action}. Wiadomość e-mail zostanie wysłana na adres e-mail kontaktowy konta, aby potwierdzić żądanie. Dokładnie przeczytaj instrukcje i kliknij link, który zawiera. +> +> Jeśli nie masz już dostępu do tego adresu, ale masz dostęp do swojego adresu e-mail rezerwowego, utwórz [bilet wsparcia za pośrednictwem centrum pomocy](https://help.ovhcloud.com/csm?id=csm_get_help), aby zastąpić główny adres e-mail adresem e-mail rezerwowym. +> +> Jeśli nie masz dostępu ani do swojego adresu e-mail, ani do swojego konta, ani do adresu e-mail rezerwowego, musisz wykonać [tą procedurę](/links/transversal/procedure-email-change). +> +> Jeśli zapomniałeś swojego identyfikatora klienta, możesz go odnaleźć w prawym górnym rogu Twojej ostatniej faktury. Wygląda to mniej więcej tak: "aa00000-ovh" (pierwsze litery są zazwyczaj inicjałami osoby, która utworzyła konto). Ten identyfikator jest również wskazany w e-mailu potwierdzającym utworzenie konta, jak również w e-mailach potwierdzających lub odnawiających zamówienie. +> + +/// + +/// details | Czy istnieje limit liczby razy, w jakich mogę zmienić hasło do mojego konta OVHcloud (za pomocą opcji "Nie pamiętasz identyfikatora klienta lub hasła?")? + +OVHcloud nie nakłada limitu na liczbę zmian hasła, możesz je zmieniać tyle razy, ile chcesz. -Dla numeru “06 12 34 56 78” należy zatem wpisać “+48 612345678”. Prefiks “+48” dodawany jest automatycznie po wybraniu Polski jako kraju zamieszkania. +Jednak nasz system wysyła wiadomości e-mail na Twój adres e-mail kontaktowy, a możliwe jest, że Twój dostawca usług e-mail zablokuje pocztę, jeśli złożysz wiele żądań zmiany hasła w ciągu kilku minut. -### Jakie są konsekwencje wprowadzenia rozporządzenia RODO względem ochrony moich danych osobowych? +/// -Aby lepiej poznać konsekwencje rozporządzenia ogólnego o ochronie danych osobowych (RODO) dla Twojej działalności zawodowej lub względem ochrony Twoich danych osobowych, zapoznaj się z treścią poniższych dokumentów: +/// details | Nie aktywowałem podwójnej autoryzacji na moim koncie, ale mimo to proszą mnie o kod. Jak to wyłączyć? -- [OVHcloud i ochrona danych osobowych](https://www.ovhcloud.com/pl/personal-data-protection/); -- [RODO - Pytania do eksperta OVHcloud](https://www.ovhcloud.com/pl/personal-data-protection/faq/). +Nawet jeśli podwójna autoryzacja nie jest aktywowana na Twoim koncie, może Cię poprosić o kod weryfikacyjny, aby potwierdzić swoją tożsamość. Ta procedura ma na celu ochronę Twojego konta i danych i nie można jej wyłączyć. -### Jak zmienić moje hasło OVHcloud? +Kod bezpieczeństwa jest wysyłany przez e-mail **na główny adres**, który podałeś na koncie. -Udaj się do strony logowania w Twoim Panelu klienta i wybierz „Nie pamiętam identyfikatora lub hasła”. Wpisz swój identyfikator lub główny adres e-mail przypisany do Twojego konta OVHcloud, a następnie kliknij „Wyślij”. Na adres kontaktowy konta zostanie wysłany e-mail z prośbą o potwierdzenie. Przeczytaj uważnie instrukcje i kliknij umieszczony w e-mailu link. +Jeśli nie możesz odnaleźć tego kodu, sprawdź katalogi "spam" / "niechciana poczta" swojego adresu e-mail. -#### Wskazówki i porady +> [!success] +> - Aktywacja podwójnej autoryzacji na Twoim koncie pozwala Ci wybrać urządzenie, które chcesz użyć (telefon, tablet, smartfon, klucz U2F), aby otrzymać kod uwierzytelniający. Więcej informacji w naszym przewodniku "[Zabezpieczenie konta OVHcloud za pomocą weryfikacji dwuetapowej](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa)". +> - Możesz również wdrożyć dodatkowe zabezpieczenie, aby ograniczyć dostęp do Twojego konta OVHcloud do jednego lub kilku adresów IP. Więcej informacji w naszym przewodniku "[Ogranicz dostęp przez IP do Panelu klienta OVHcloud](/pages/account_and_service_management/account_information/ovhcloud-control-panel-ip-restriction)". + +/// -Jeśli nie masz dostępu do adresu e-mail do kontaktu, prosimy o wypełnienie tej [procedury](https://www.ovh.pl/pomoc/procedury/). -Jeśli nie pamiętasz Twojego identyfikatora klienta, odnajdziesz go w prawym górnym rogu Twojej ostatniej faktury. Identyfikator składa się z następujących znaków: “aa00000-ovh” (przy czym pierwsze litery są zazwyczaj inicjałami osoby, która założyła konto). Identyfikator znajduje się również w e-mailu potwierdzającym założenie konta oraz w e-mailach potwierdzających złożenie zamówienia lub jego odnowienie. +/// details | Jak wyłączyć podwójną autoryzację (2FA) na moim koncie OVHcloud? -### Jak zmienić dane kontaktowe? +Jeśli urządzenie (telefon komórkowy / smartfon / klucz bezpieczeństwa), które używasz do podwójnej autoryzacji, zostało stracone, skradzione lub przestało działać, możesz: -Możesz nadać innym kontom klienta OVHcloud uprawnienia do zarządzania Twoimi usługami w zakresie administracyjnym, technicznym i księgowym. Zaloguj się do [Panelu klienta OVHcloud](/links/manager), kliknij Twoją nazwę użytkownika w prawym górnym rogu, a następnie kliknij `Moje kontakty`{.action}. +- użyć [kodów awaryjnych](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#codes), które aktywne masz zapisane; +- użyć innego urządzenia podwójnej autoryzacji, jeśli masz aktywowane kilka; +- [wyłączyć podwójną autoryzację](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#desactivation). -Nadanie uprawnień musi zostać zatwierdzone drogą mailową zarówno przez administratora usługi, jak i przez nowy kontakt. +Zapoznaj się z sekcją "[Co zrobić, jeśli jedno z moich urządzeń zostało stracone/skonfiskowane lub przestało działać?](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#lost-device)" lub sekcją "[Całkowite wyłączenie podwójnej autoryzacji](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#desactivation)" naszego przewodnika dotyczącego podwójnej autoryzacji. -Przed wprowadzeniem jakiejkolwiek zmiany upewnij się, że wszystkie adresy e-mail podane do kontaktu są prawidłowe. W przeciwnym razie dyspozycja nie będzie mogła zostać zrealizowana. +/// -Jeśli chcesz odzyskać domenę, której jesteś właścicielem zarejestrowanym w odpowiednim rejestrze (możesz sprawdzić te informacje na [www.ovh.com/pl/cgi-bin/tools/check_whois.pl](https://www.ovh.com/pl/cgi-bin/tools/check_whois.pl)), ale nie masz dostępu do konta klienta administratora, zalecamy zastosowanie procedury: [www.ovh.pl/cgi-bin/pl/procedure/procedureChangeContacts.cgi](https://www.ovh.pl/cgi-bin/pl/procedure/procedureChangeContacts.cgi). +### Zarządzanie informacjami osobowymi -#### Wskazówki i porady +/// details | Jak zmienić moje informacje osobiste? -Pełny przewodnik po zarządzaniu kontaktami jest dostępny [tutaj] -(/pages/account_and_service_management/account_information/managing_contacts#dostep-do-zarzadzania-kontaktami). +Aby wyświetlić lub zmienić swoje dane kontaktowe, zaloguj się do swojego [konta OVHcloud](/links/manager), kliknij swoje imię w prawym górnym rogu, a następnie kliknij `Moje konto`{.action}. -### W jaki sposób skonfigurować lub zmienić kontakt księgowy? +Kliknij następnie `Edytuj mój profil`{.action}, w sekcji `Mój profil`. + +> [!success] +> **Chcesz zmienić adres e-mail swojego konta OVHcloud?** +> +> Najpierw zostanie wysłane żądanie potwierdzenia na adres e-mail, który obecnie podałeś w swoim koncie. Jeśli nie możesz już uzyskać dostępu do tego adresu e-mail, potrzebny jest czas oczekiwania 24 godziny. Po tym czasie zmiana zostanie automatycznie wykonana. +> -Zaloguj się do [Panelu klienta OVHcloud](/links/manager), kliknij Twoją nazwę użytkownika w prawym górnym rogu, a następnie kliknij `Moje kontakty`{.action}. +/// -#### Wskazówki i porady +/// details | Jak uzyskać dostęp do umów i warunków ogólnych usług? -Aby dowiedzieć się więcej o zarządzaniu kontaktami, zapoznaj się z treścią przewodnika: [Zarządzanie kontaktami i usługami](/pages/account_and_service_management/account_information/managing_contacts). +Regulaminy usług OVHcloud można znaleźć bezpośrednio w [Panelu klienta](/links/manager). Po zalogowaniu przejdź do menu `Moje konto`{.action}, a następnie kliknij `Wyświetl regulaminy`{.action}. -### Jak mogę zabezpieczyć moje konto? +Możesz również zapoznać się z umowami na naszej stronie internetowej, za pośrednictwem [tego linku](/links/terms-conditions-contracts). -Aby zabezpieczyć Twoje konto, masz do wyboru kilka rozwiązań, takich jak: +Ta strona zawiera wszystkie potrzebne informacje dotyczące naszych umów, w tym warunki i zasady naszych usług. -- wybór złożonego hasła -- jego regularne odnowienie tego hasła -- weryfikacji dwuetapowej +/// -W przypadku weryfikacji dwuetapowej za pomocą wysyłania kodu w wiadomości SMS lub poprzez ograniczenie za pomocą adresu IP (autoryzacja lub odmowa dostępu do niektórych adresów) możesz dodać reguły bezpieczeństwa w Panelu klienta. Wszystkie te opcje są dostępne w sekcji “Bezpieczeństwo” po kliknięciu na Twoje inicjały w prawym górnym rogu Panelu klienta OVHcloud. +/// details | Jakie są skutki RODO dla moich danych osobowych? -Zaloguj się do [Panelu klienta OVHcloud](/links/manager), kliknij Twoją nazwę użytkownika w prawym górnym rogu, a następnie kliknij `Dostęp do konta`{.action}. Kliknij `Bezpieczeństwo`{.action}. +Aby lepiej zrozumieć skutki rozporządzenia o ogólnej ochronie danych (RODO) dla Twojej działalności zawodowej lub danych osobowych, zapraszamy do zapoznania się z tymi zasobami: -Aby uzyskać więcej informacji, obejrzyj [film](https://www.youtube.com/watch?v=odO58c4gJfc&list=PL0DynEzr_sE5MnOfJOpVJN-EhfMDWoqGS&index=24). +- [OVHcloud i ochrona danych osobowych](/links/transversal/personal-data-protection); +- [RODO: pytania, które zadajesz sobie](/links/transversal/personal-data-protection-faq). -### Jak aktywować uwierzytelnianie dwuetapowe/2FA w OVHcloud? +/// -Po utworzeniu konta klienta OVHcloud zalecamy -zabezpieczyć Twoje dane osobowe, aktywując dwuetapowe -uwierzytelnianie. +/// details | Czy mogę ręcznie zmienić swój identyfikator klienta? Chciałbym innych liter lub cyfr. -Zaloguj się do [Panelu klienta OVHcloud](/links/manager), kliknij Twoją nazwę użytkownika w prawym górnym rogu, a następnie kliknij `Dostęp do konta`{.action}. Kliknij `Bezpieczeństwo`{.action}. +Identyfikator klienta nie może być zmieniony, ponieważ jest powiązany z informacjami podanymi podczas tworzenia Twojego konta OVHcloud. Pierwsze dwie litery odpowiadają zazwyczaj inicjałom nazwiska administratora, a kolejne cyfry są generowane losowo. -Ponadto, aby aktywować 2FA, dostępnych jest kilka rozwiązań umożliwiających uwierzytelnienie: +Zapamiętaj, że masz również możliwość [utworzenia nowego konta OVHcloud](/pages/account_and_service_management/account_information/ovhcloud-account-creation). Musisz jednak ręcznie przenieść wszystkie swoje usługi na nowe konto, postępując zgodnie z [procedurą zmiany kontaktów](/pages/account_and_service_management/account_information/managing_contacts). -- SMS-em, za pomocą kodu bezpieczeństwa -- Z aplikacji mobilnej kompatybilnej z systemami Android, iPhone i Windows mobile -- Korzystając z klucza bezpieczeństwa zgodnego z U2F +/// -Więcej informacji można znaleźć pod tym [linkiem](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa) +/// details | Czy mogę zmienić filię mojego konta OVHcloud? -### Jak dezaktywować uwierzytelnianie dwuetapowe/2FA w OVHcloud? +Jeśli utworzyłeś konto OVHcloud w złej filii, możesz utworzyć nowe konto w odpowiedniej filii, używając tych samych danych osobowych. -Jeśli chcesz dezaktywować skonfigurowane dwuetapowe uwierzytelnianie, zaloguj się do [Panelu klienta OVHcloud](/links/manager), kliknij Twoją nazwę użytkownika w prawym górnym rogu, a następnie kliknij `Dostęp do konta`{.action}. Kliknij `Bezpieczeństwo`{.action}. +Jednak musisz przypisać inny adres e-mail kontaktowy, ponieważ nie można mieć dwóch różnych kont OVHcloud z tym samym adresem e-mail kontaktowym. -Będziesz mieć możliwość dezaktywacji poszczególnych zabezpieczających urządzeń peryferyjnych.  -Jeśli nie masz już dostępu do swojej strefy klienta z powodu utraty urządzenia do dwuetapowego uwierzytelnienia, skontaktuj się z pomocą techniczną OVHcloud, aby doradca mógł ręcznie dezaktywować urządzenie po przedstawieniu dokumentów potwierdzających. +Znajdziesz dodatkowe informacje na temat tworzenia konta OVHcloud w naszym przewodniku "[Utwórz konto OVHcloud](/pages/account_and_service_management/account_information/ovhcloud-account-creation)". -### Co zrobić w sytuacji, gdy moje konto OVHcloud zostało zhakowane? +Po utworzeniu nowego konta OVHcloud w odpowiedniej filii, możesz postępować zgodnie z instrukcjami [tego przewodnika](/pages/account_and_service_management/account_information/managing_contacts), aby przenieść swoje usługi z jednego konta na drugie. -W przypadku nielegalnego wykorzystania Twojego konta OVHcloud (tożsamość, środek płatności...), należy jak najszybciej złożyć wstępne zgłoszenie o wystąpieniu naruszenia do odpowiednich organów policji. +/// -Po otrzymaniu zawiadomienia organy policji skontaktują się z Tobą, aby umówić się na spotkanie i dokończyć procedurę. Zaraz po otrzymaniu dokumentu potwierdzającego złożenie przez Ciebie skargi, należy przesłać nam jego kopię. Tym samym będziemy mogli rozpocząć odpowiednie działania wewnętrzne. +/// details | Jak usunąć mój konto OVHcloud ? -Twój identyfikator klienta zostanie zablokowany. Wszelkie usługi wykupione nielegalnie zostaną automatycznie usunięte, a płatności za nie zwrócone. +Zamknięcie Twojego konta klienta OVHcloud oraz usunięcie Twoich danych osobowych jest możliwe tylko wtedy, gdy: -Abyś mogła/mógł ponownie korzystać z Twojego konta klienta, poprosimy Cię ewentualnie o zmianę Twojego adresu e-mail i/lub Twojego hasła po kliknięciu tego linku: [www.ovh.pl/cgi-bin/pl/procedure/procedureChangeEmail.cgi](https://www.ovh.pl/cgi-bin/pl/procedure/procedureChangeEmail.cgi). +1. Nie masz już widocznych usług w sekcji "[Moje usługi](https://www.ovh.com/manager/dedicated/#/billing/autoRenew)". W przeciwnym razie, musisz najpierw złożyć wniosek o ich zakończenie i poczekać na ich usunięcie. +2. Nie masz żadnych faktur do zapłacenia. W przeciwnym razie, musisz je uregulować, klikając przycisk `Rozlicz natychmiast`{.action} w akcjach masowych na stronie "[Moje faktury](https://www.ovh.com/manager/#/dedicated/billing/history)". +3. Nie masz żadnych aktywnych zamówień. Sprawdź to na [tej stronie](https://www.ovh.com/manager/#/dedicated/billing/orders/orders). +4. Twój rachunek płatny z góry nie jest dodatni. Sprawdź to na [tej stronie](https://www.ovh.com/manager/#/dedicated/billing/payment/ovhaccount). -Chcąc uniknąć podobnych sytuacji w przyszłości, zabezpiecz swoje konto z poziomu Panelu klienta, dodając np. dwuskładnikowe uwierzytelnienie (kod wysyłany za pomocą SMS-a) oraz ogranicz dostęp do konta do Twojego adresu/adresów IP (akceptacja lub odmowa dostępu do niektórych adresów IP). Wszystkie te opcje można odnaleźć w sekcji “Bezpieczeństwo”. Zaloguj się do [Panelu klienta OVHcloud](/links/manager), kliknij Twoją nazwę użytkownika w prawym górnym rogu, a następnie kliknij `Dostęp do konta`{.action}. Kliknij `Bezpieczeństwo`{.action} +Jeśli wszystkie powyższe warunki są spełnione, możesz złożyć wniosek o usunięcie swojego konta OVHcloud oraz powiązanych danych, wykonując poniższe kroki: -### Otrzymałem e-mail, który wygląda na phishing i kradzież tożsamości OVHcloud. Jak zgłosić tę wiadomość do weryfikacji? +1. Zaloguj się do [centrum pomocy OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help). +1. Wybierz motyw `Zarządzaj swoim kontem OVHcloud`{.action}. +1. Wpisz `Chcę zamknąć swoje konto OVHcloud`{.action} i wykonaj opisane kroki. -Wyjaśnienie, jak rozpoznać i zgłosić atak phising przeprowadzony przy użyciu wiadomości e-mail lub SMS, znajdziesz w [przewodniku](/pages/account_and_service_management/account_information/phishing_care). +/// -### W jaki sposób zgłosić nadużycie lub treści niezgodne z prawem wykryte na usługach hostowanych przez OVHcloud? +### Zarządzanie powiadomieniami i logami -Nadużycia lub treści niezgodne z prawem należy zgłaszać na przeznaczonej do tego celu platformie OVHcloud [www.ovh.com/abuse/](https://www.ovh.com/abuse/). Wybierz odpowiednią kategorię i uzupełnij wymagane pola. +/// details | Czy mogę otrzymywać wszystkie powiadomienia z OVHcloud na wielu adresach e-mail? -Tylko logi i dane techniczne mogą zostać przekazane właścicielowi usługi, której dotyczy nadużycie. Wypełniając pola, nie należy zatem podawać żadnych danych osobowych. +Niestety nie jest możliwe wysyłanie wiadomości e-mail na wiele adresów. -### Após a declaração de um abuso, o que acontece à minha queixa? +Z poziomu [Panelu klienta OVHcloud](/links/manager) możesz jednak skonfigurować adres e-mail rezerwowy, który nie będzie używany do wysyłania wszystkich naszych komunikatów (renewal, usunięcia usług itp.). -A sua queixa será tratada o mais rapidamente possível pelo Serviço Jurídico da OVHcloud. A sua queixa será analisada e, em função disso, comunicar-lhe-emos mais pormenores. Após comprovação do comportamento abusivo de um dos nossos clientes, informá-lo-emos e faremos o necessário junto da(s) pessoa(s) em causa para resolver a situação o quanto antes. +Taki adres e-mail rezerwowy może być przydatny w przypadku utraty dostępu do głównego adresu e-mail, co uniemożliwiłoby logowanie się do Panelu klienta OVHcloud. -### Firma OVHcloud przesłała mi wiadomość e-mail informującą o potencjalnym nadużyciu z mojej strony. Co powinienem w takiej sytuacji zrobić? +/// -Jeśli nadużycie zostało nam zgłoszone lub zauważone przez nasze zespoły, otrzymasz wiadomość e-mail wysłaną z adresu o formacie: "ticket+"numer-zgłoszenia"@abuse.ovh.net". +/// details | Otrzymałem od Państwa powiadomienie w innej języku. Jak to poprawić? -Poprosimy Cię o przeanalizowanie działań uznanych jako nadużycie oraz podjęcie odpowiednich kroków w celu ich zaprzestania i/lub usunięcie wszelkich treści niezgodnych z prawem. +Możesz zmienić język naszych automatycznych wiadomości e-mail, wykonując poniższe kroki: -Aby upewnić się, czy osoby trzecie nie przejęły kontroli nad Twoimi usługami (np. w wyniku włamania), zalecamy, abyś sprawdził, czy Twoje usługi są odpowiednio zabezpieczone: +1. Zaloguj się do [Panelu klienta OVHcloud](/links/manager). +1. Przejdź następnie do [centrum pomocy OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help). +1. Kliknij `Zaloguj się do centrum pomocy`{.action} i potwierdź logowanie. +1. Kliknij flagę w prawym górnym rogu centrum pomocy i wybierz kraj/region odpowiadający wybranemu językowi. +1. Kliknij `Wyloguj się z centrum pomocy`{.action}. -- [Zabezpieczenie konta OVHcloud i zarządzanie danymi osobowymi](/pages/account_and_service_management/account_information/all_about_username) -- [Zmiana hasła do konta](/pages/account_and_service_management/account_information/manage-ovh-password) -- [Zabezpieczenie konta OVHcloud za pomocą weryfikacji dwuetapowej](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa) -- [Jak zabezpieczyć stronę WWW?](/pages/web_cloud/web_hosting/secure_your_website) -- [Zabezpieczenie serwera VPS](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps) -- [Zabezpieczenie serwera dedykowanego](/pages/bare_metal_cloud/dedicated_servers/securing-a-dedicated-server) +Następnie kolejne automatyczne powiadomienia e-mail zostaną wysłane w wybranym języku. -### W jaki sposób mogę uniknąć zawieszenia usługi w przypadku wykrycia nadużycia na jednej z moich usług OVHcloud? +/// -Po przeprowadzeniu niezbędnych działań odpowiedz na wiadomość e-mail wysłaną przez dział Abuse i poinformuj o podjętych krokach. -Pracownik naszego zespołu odpowie na Twoją wiadomość w najkrótszym możliwym terminie. +/// details | Czy mogę zobaczyć wszystkie działania wykonane z poziomu Panelu klienta? Czy są logi? -### Wysłałem wiadomość do działu Abuse OVHcloud, ale moja usługa jest nadal zablokowana. Co mogę zrobić? +Tak, możesz uzyskać dostęp do logów działań wykonanych na Twoim koncie. -W [Centrum pomocy OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help) możesz zwrócić się do Biura Obsługi Klienta o udzielenie dodatkowych informacji dotyczących przetwarzania Twojego zgłoszenia Abuse. Aby usprawnić obsługę Twojego zapytania, podaj numer zgłoszenia Abuse. +Aby to zrobić, musisz zalogować się do [API OVHcloud](/links/api), korzystając z przewodnika "[Pierwsze kroki z API OVHcloud](/pages/manage_and_operate/api/first-steps)". Po zalogowaniu możesz użyć poniższego wywołania API, aby pobrać identyfikator logu: -### Jak usunąć moje konto OVHcloud? +> [!api] +> +> @api {v1} /me GET /me/api/logs/self +> -Zamknięcie konta klienta OVHcloud i usunięcie danych osobowych jest możliwe tylko wtedy, gdy: +W ten sposób otrzymasz listę identyfikatorów logów. Następnie możesz użyć poniższego wywołania API, aby pobrać szczegóły konkretnego logu: -1. Nie masz już widocznych usług w sekcji "[Moje usługi](https://www.ovh.com/manager/dedicated/#/billing/autoRenew)". W przeciwnym razie najpierw poproś o ich rozwiązanie i zaczekaj na ich usunięcie. -2. Nie masz faktur oczekujących na płatność. W przeciwnym razie należy uregulować należność, klikając przycisk `Zapłać teraz`{.action} w akcjach masowych na stronie "[Moje faktury](https://www.ovh.com/manager/#/dedicated/billing/history)". -3. Nie posiadasz zamówień w trakcie realizacji. Sprawdź go na [tej stronie](https://www.ovh.com/manager/#/dedicated/billing/orders/orders). -4. Twoje konto przedpłacone nie jest dodatnie. Sprawdź go na [tej stronie](https://www.ovh.com/manager/#/dedicated/billing/payment/ovhaccount). +> [!api] +> +> @api {v1} /me GET /me/api/logs/self/{logId} +> -Jeśli powyższe warunki są spełnione, możesz zażądać usunięcia konta OVHcloud i powiązanych z nim danych, wykonując następujące kroki: +Zamień `{logId}` na rzeczywisty identyfikator logu, który chcesz sprawdzić. Dzięki temu uzyskasz dostęp do logu i zobaczysz działania wykonane z poziomu Panelu klienta. -1. Zaloguj się do [Centrum pomocy OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help). -2. Kliknij przycisk `Utwórz zgłoszenie`{.action}. -3. Wybierz motyw `Zarządzaj kontem klienta OVHcloud`{.action}. -4. Prosimy o sprecyzowanie opcji `Chcę zamknąć konto klienta OVHcloud`{.action} i postępowanie zgodnie z instrukcjami zawartymi w tej operacji. +/// + +### Delegowanie dostępu do usług + +/// details | Jak mogę przekazać dostęp do moich usług innym osobom? + +Możesz przekazać innym kontom klientów OVHcloud zarządzanie administracyjne, techniczne i fakturą swoich usług z poziomu swojego Panelu klienta. Aby to zrobić, zaloguj się do [Panelu klienta OVHcloud](/links/manager), kliknij swoje imię w prawym górnym rogu, a następnie `Moje kontakty`{.action}. + +Delegacja usług musi zostać potwierdzona e-mailem zarówno przez administratora usługi, jak i nowy kontakt. + +Przed każdą zmianą upewnij się, że wszystkie adresy e-mail kontaktowe są poprawne, w przeciwnym razie żądanie nie zostanie zakończone sukcesem. + +Jeśli chcesz odzyskać nazwę domeny, której jesteś właścicielem zarejestrowanym u rejestranta (możesz to sprawdzić za pomocą [naszego narzędzia WHOIS online](/links/web/domains-whois)), ale nie masz dostępu do konta administratora, zachęcamy do wykonania [tej procedury](/links/transversal/procedure-contact-change). + +> [!success] +> Pełny przewodnik dotyczący zarządzania kontaktami jest dostępny [tutaj](/pages/account_and_service_management/account_information/managing_contacts). + +/// + +/// details | Jak skonfigurować lub zmienić kontakt do faktury? + +Zaloguj się do [Panelu klienta OVHcloud](/links/manager), kliknij swoje imię w prawym górnym rogu, a następnie `Moje kontakty`{.action}. + +> [!success] +> Jeśli chcesz dowiedzieć się więcej o zarządzaniu kontaktami, zachęcamy do przeczytania szczegółowego przewodnika: "[Zarządzanie kontaktami usług](/pages/account_and_service_management/account_information/managing_contacts)". + +/// + +/// details | Chcę przenieść wszystkie moje usługi na inne konto OVHcloud, jak mogę to zrobić w jednym kroku? + +Aby przenieść wszystkie swoje usługi na inne konto OVHcloud, sugerujemy, abyś [skontaktował się bezpośrednio z naszym wsparciem technicznym](https://help.ovhcloud.com/csm?id=csm_get_help). Nasze zespoły będą mogły Ci pomóc w całym procesie i wspierać Cię w masowym przeniesieniu usług na nowe konto. + +/// + +### Zgłaszanie działań nadużywczych/nielegalnych lub włamania + +/// details | Co zrobić, jeśli moje konto OVHcloud zostało skompromitowane? + +W przypadku nadużycia Twojego konta OVHcloud (identyfikator, metody płatności itp.), zachęcamy do złożenia skargi jak najszybciej w komendurze policji lub gminie. + +Gdy skarga będzie w Twoim posiadaniu, musisz jej nam przesłać kopię. Umożliwi to rozpoczęcie naszych wewnętrznych działań. + +Skontaktuj się z obsługą OVHcloud telefonicznie: + +- Polska: 71 750 02 00 + +Twój identyfikator klienta zostanie zablokowany, a usługi podpisane nadużywanie zostaną usunięte. + +Na koniec, aby odzyskać dostęp do swojego konta klienta, możemy Cię poprosić o zmianę adresu e-mail i/lub hasła za pomocą [tej procedury](/links/transversal/procedure-email-change). + +/// + +/// details | Otrzymałem e-mail, który wydaje się być phishingiem, który nadaje się na OVHcloud, jak zgłosić go do weryfikacji? + +Aby zidentyfikować i zgłosić e-mail lub SMS phishingowy, zapoznaj się z naszym [wyłącznie poświęconym przewodnikiem](/pages/account_and_service_management/account_information/phishing_care). + +/// + +/// details | Jak zgłosić nadużycie lub nielegalny zawartość pochodzące z usług hostowanych przez OVHcloud, na które jestem ofiarą? + +Znajdź odpowiedzi na pytania dotyczące zgłaszania nadużyć lub nielegalnej zawartości w naszej [FAQ dotyczącej wsparcia OVHcloud](/pages/account_and_service_management/account_information/faq-support). + +/// + +/// details | OVHcloud wysłał mi e-mail mówiący o możliwym nadużyciu ze strony mojej, co powinienem zrobić? + +Znajdź odpowiedzi na pytania dotyczące zgłaszania nadużyć lub nielegalnej zawartości w naszej [FAQ dotyczącej wsparcia OVHcloud](/pages/account_and_service_management/account_information/faq-support). + +/// ## Sprawdź również - -Dołącz do [grona naszych użytkowników](/links/community). + +Dołącz do [grona naszych użytkowników](/links/community). \ No newline at end of file diff --git a/pages/account_and_service_management/account_information/faq-account-management/guide.pt-pt.md b/pages/account_and_service_management/account_information/faq-account-management/guide.pt-pt.md index 22c31506771..9eafca991d6 100644 --- a/pages/account_and_service_management/account_information/faq-account-management/guide.pt-pt.md +++ b/pages/account_and_service_management/account_information/faq-account-management/guide.pt-pt.md @@ -1,188 +1,365 @@ --- title: FAQ sobre a gestão da conta OVHcloud excerpt: Encontre as questões mais frequentes sobre a gestão da conta OVHcloud -updated: 2025-04-28 +updated: 2025-10-30 --- + + ## Objetivo -Encontre as questões mais frequentes sobre a gestão da conta OVHcloud. +Encontre aqui as perguntas mais frequentemente feitas sobre a gestão da sua conta OVHcloud. + +## Perguntas frequentes + +### Criar uma conta OVHcloud, aceder e protegê-la + +/// details | Como criar uma conta OVHcloud? + +A criação de uma conta é gratuita. Este espaço facilita o acesso às suas informações e permite gerir os seus serviços. Consulte o nosso guia "[Criar uma conta OVHcloud](/pages/account_and_service_management/account_information/ovhcloud-account-creation)". + +> [!success] +> Após a criação da sua conta, lembre-se de a proteger configurando uma autenticação em dois fatores. Encontre mais informações no nosso guia "[Proteger a sua conta OVHcloud com a dupla autenticação](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa)". + +/// + +/// details | Como preencher corretamente o meu número de telefone durante a criação da minha conta? + +Deve introduzir o seu número de telefone no formato internacional. + +> [!success] +> Por exemplo: se o seu número for “21 123 45 67”, indique “+351 211234567”. O indicativo “+351” é adicionado automaticamente se selecionar Portugal como país de residência. + +/// + +/// details | Onde encontrar o meu identificador OVHcloud? + +O seu identificador de cliente, também chamado de vezes "NIC-handle", está no canto superior direito da sua última fatura. Assemelha-se a isto: "aa00000-ovh" (as primeiras letras são geralmente as iniciais da pessoa que criou a conta). Este identificador também é indicado em todos os e-mails enviados pela OVHcloud (e-mail de confirmação da criação da conta, e-mails de confirmação ou renovação de encomenda, etc.). + +Se ainda assim não encontrar o seu identificador, pode clicar no link "Perdeu o identificador ou a palavra-passe?" presente na página de [ligação à conta OVHcloud](/links/manager). Introduza então o endereço de e-mail associado à sua conta. + +> [!success] +> A qualquer momento, quando estiver ligado ao seu Área de Cliente OVHcloud, pode encontrar o seu identificador no canto superior direito ao clicar no seu nome. + +/// + +/// details | Como proteger a minha conta? + +Várias soluções estão à sua disposição para proteger a sua conta, tais como: + +- a escolha de uma [palavra-passe complexa e a sua renovação regular](/pages/account_and_service_management/account_information/manage-ovh-password); +- a adição de uma [autenticação em dois fatores](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa); +- a configuração de uma [restrição por IP](/pages/account_and_service_management/account_information/ovhcloud-control-panel-ip-restriction). + +Para aceder a todas estas opções, ligue-se ao seu [Área de Cliente OVHcloud](/links/manager), clique no seu nome no canto superior direito, depois em `A minha Conta`{.action}. + +Clique no separador `Segurança`{.action} para as visualizar. + +/// + +/// details | Como ativar a autenticação em dois fatores (2FA) na minha conta OVHcloud? + +Pode ativar uma ou várias métodos de autenticação em dois fatores para proteger e controlar o acesso ao seu Área de Cliente OVHcloud. Encontre todos os detalhes no nosso guia "[Proteger a sua conta OVHcloud com a autenticação em dois fatores](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa)". + +/// + +/// details | Que fazer se não conseguir ligar-me à minha conta cliente? + +Esqueceu a sua palavra-passe? Já não tem acesso ao seu endereço de e-mail? Configurou uma autenticação em dois fatores mas o seu telemóvel está partido/perdido/roubado? +Para todos estes casos, consulte [esta documentação](/pages/account_and_service_management/account_information/ovhcloud-account-login#login-failure) que lhe permitirá conhecer as démarches apropriadas. + +/// + +/// details | Como modificar a palavra-passe da minha conta OVHcloud? -### Como criar uma conta OVHcloud? +Ligue-se ao seu [Área de Cliente OVHcloud](/links/manager), clique no seu nome no canto superior direito, depois em `A minha Conta`{.action}. -A criação de uma conta é gratuita. Este espaço facilita o acesso às suas informações e permite gerir os seus serviços. Consulte o nosso guia [Criar uma conta OVHcloud](/pages/account_and_service_management/account_information/ovhcloud-account-creation). +Clique no separador `Segurança`{.action}, depois no botão `Alterar`{.action} situado à direita da menção **Palavra-passe**. Pode então modificar a sua palavra-passe atual. Uma mensagem de segurança aparece para lhe informar que está prestes a efetuar uma mudança de palavra-passe. Após a sua confirmação, vai receber (no endereço de correio eletrónico principal indicado na conta) um e-mail contendo a procedimento a seguir. + +Encontre mais informações no nosso guia "[Modificar a palavra-passe da sua conta](/pages/account_and_service_management/account_information/manage-ovh-password)". + +> [!success] +> **Já não se lembra da sua palavra-passe?** +> +> Dirija-se à [página de ligação ao seu Área de Cliente OVHcloud](/links/manager) e clique em `Perdeu o identificador ou a palavra-passe?`{.action}. Introduza o seu identificador ou o endereço de e-mail principal associado à sua conta OVHcloud, depois clique em `Enviar`{.action}. Um e-mail é então enviado para o endereço de correio eletrónico de contacto da conta, para confirmar a solicitação. Leia atentamente as instruções e clique no link que contém. +> +> Se já não tem acesso a este endereço mas tem acesso ao seu endereço de correio eletrónico de recuperação, crie um [ticket de assistência através do centro de ajuda](https://help.ovhcloud.com/csm?id=csm_get_help) para substituir o seu endereço de correio eletrónico principal pelo endereço de correio eletrónico de recuperação. +> +> Se não tem acesso nem ao seu endereço de correio eletrónico, nem ao seu Área de Cliente OVHcloud, ou que não tem um endereço de correio eletrónico de recuperação, terá de seguir [esta procedimento](/links/transversal/procedure-email-change). +> +> Se esqueceu o seu identificador de cliente, pode encontrá-lo no canto superior direito da sua última fatura. Assemelha-se a isto: "aa00000-ovh" (as primeiras letras são geralmente as iniciais da pessoa que criou a conta). Este identificador também é indicado no e-mail de confirmação da criação da conta, bem como nos e-mails de confirmação ou renovação de encomenda. +> + +/// + +/// details | Existe um limite ao número de vezes em que posso modificar a palavra-passe da minha conta OVHcloud (via a opção "Perdeu o identificador ou a palavra-passe?")? + +OVHcloud não impõe um limite ao número de mudanças de palavra-passe, pode modificá-la tantas vezes quanto quiser. + +No entanto, o nosso sistema envia os e-mails ao seu endereço de correio eletrónico de contacto e é possível que o seu fornecedor de correio eletrónico bloqueie a correspondência se solicitar muitas mudanças de palavra-passe em alguns minutos. + +/// + +/// details | Não ativei a autenticação em dois fatores na minha conta mas é-me pedido um código. Como desativar isso? + +Mesmo que a autenticação em dois fatores não esteja ativada na sua conta, pode-lhe ser pedido um código de verificação para validar a sua identificação. Esta medida visa proteger a sua conta e os seus dados e não é possível desativá-la. + +O código de segurança é enviado por e-mail **para o endereço principal** que introduziu na conta. + +Se não encontrar este código, lembre-se de verificar as pastas "spam" / "correio indesejado" do seu endereço de correio eletrónico. > [!success] -> Depois de criar a sua conta, certifique-se de que a protege configurando uma dupla autenticação. Encontre mais informações no nosso guia [Tornar segura a sua conta OVHcloud com a dupla autenticação](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa). +> - Ativar a autenticação em dois fatores na sua conta permite-lhe escolher o dispositivo a utilizar (telemóvel, tablet, smartphone, chave U2F) para receber um código de autenticação. Mais informações no nosso guia "[Proteger a sua conta OVHcloud com a autenticação em dois fatores](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa)". +> - Pode também colocar uma segurança adicional para restringir o acesso à sua conta OVHcloud a uma ou várias endereços IP. Mais informações no nosso guia "[Limitar o acesso por IP à Área de Cliente OVHcloud](/pages/account_and_service_management/account_information/ovhcloud-control-panel-ip-restriction)". + +/// + +/// details | Como desativar a autenticação em dois fatores (2FA) na minha conta OVHcloud? + +Se o seu dispositivo (telemóvel / smartphone / chave de segurança) utilizado para a autenticação em dois fatores foi perdido, roubado ou deixou de funcionar, pode: + +- utilizar [os códigos de recuperação](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#codes) ativos que salvou; +- utilizar outro dispositivo de autenticação em dois fatores à sua disposição, se tiver ativado vários; +- [desativar a autenticação em dois fatores](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#desactivation). -#### Truques e dicas: +Consulte a parte "[Que fazer se um dos meus dispositivos foi perdido/roubado ou deixou de funcionar?](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#lost-device)" ou a parte "[Desativar completamente a autenticação em dois fatores](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa#desactivation)" do nosso guia sobre a autenticação em dois fatores. -Não encontra o seu país? Altere a língua do site clicando no canto superior direito, na bandeira da sua escolha. +/// -### Onde encontrar o meu ID de cliente da OVHcloud? +### Gerir as informações pessoais -O seu ID de cliente, também conhecido como NIC-handle, encontra-se no canto superior direito da sua última fatura. Tem o seguinte formato: “aa00000-ovh” (as primeiras letras costumam ser as iniciais do nome da pessoa que criou a conta). Também pode consultar o ID de cliente em todos os e-mails enviados pela OVHcloud (e-mail de confirmação da criação da conta, e-mails de confirmação ou de renovação da encomenda, etc.) +/// details | Como modificar as minhas informações pessoais? -Se ainda não encontrou o seu ID de cliente, pode clicar na ligação "Perdeu o identificador ou a palavra-passe?" na página de [login à sua conta OVHcloud](/links/manager), introduzindo o endereço de e-mail associado à sua conta. +Para visualizar ou modificar as suas coordenadas, ligue-se ao seu [Área de Cliente OVHcloud](/links/manager), clique no seu nome no canto superior direito, depois em `A minha Conta`{.action}. + +Clique então em `Editar o meu perfil`{.action}, no quadro `O meu perfil`. > [!success] -> A qualquer momento, se estiver ligado à sua Área de Cliente, pode encontrar o seu ID de cliente clicando no seu nome, no canto superior direito. +> **Deseja modificar o endereço de correio eletrónico da sua conta OVHcloud?** +> +> Uma solicitação de confirmação será primeiro enviada para o endereço de correio eletrónico que atualmente introduziu no seu Área de Cliente OVHcloud. Se já não conseguir aceder a este endereço de correio eletrónico, será necessário um prazo de 24 horas. Após este prazo, a mudança será automaticamente efetuada. +> + +/// + +/// details | Como aceder aos contratos e condições gerais de serviço? + +Pode encontrar os contratos dos seus serviços OVHcloud diretamente no seu [Área de Cliente OVHcloud](/links/manager). Uma vez ligado, dirija-se ao menu `Minha conta`{.action} depois clique em `Ver os meus contratos`{.action}. + +Também pode consultar os contratos no nosso site, através [deste link](/links/terms-conditions-contracts). + +Esta página contém todas as informações necessárias sobre os nossos contratos, incluindo os termos e condições dos nossos serviços. + +/// + +/// details | Quais são os impactos do RGPD nas minhas informações pessoais? -### O que devo fazer se não conseguir aceder à minha conta de cliente? +Para conhecer melhor os impactos do regulamento geral sobre a proteção de dados (RGPD) na sua atividade profissional ou nas suas informações pessoais, propomos-lhe consultar estes recursos: -Por várias razões, tais como o esquecimento da sua palavra-passe, a perda de acesso ao seu endereço de e-mail ou ao seu telemóvel para uma identificação por SMS, pode acontecer que não consiga identificar-se ou conectar-se à sua Área de Cliente. -Se for o caso, siga [este manual](/pages/account_and_service_management/account_information/ovhcloud-account-login#login-failure) para resolver este tipo de situação. +- [OVHcloud e a proteção de dados pessoais](/links/transversal/personal-data-protection); +- [RGPD: as perguntas que se faz](/links/transversal/personal-data-protection-faq). -### Como alterar os meus dados pessoais? +/// -Para visualizar ou alterar os seus dados pessoais, aceda à Área de Cliente. Poderá aceder aos seus dados pessoais clicando, no canto superior direito do seu [Área de Cliente OVHcloud](/links/manager), no seu nome e, depois, em `Aceder à minha conta`{.action}. +/// details | Posso mudar manualmente o meu identificador de cliente? Gostaria de outras letras ou números. -Na secção `O meu perfil`{.action} à direita do ecrã (clique novamente no seu nome para eliminar o menu à esquerda), clique em `Editar o meu perfil`{.action}. +O identificador de cliente não pode ser modificado pois está ligado às informações fornecidas durante a criação da sua conta OVHcloud. As duas primeiras letras correspondem geralmente às iniciais do nome do administrador, enquanto os números seguintes são gerados aleatoriamente. -#### Truques e dicas +Saiba que tem, no entanto, a possibilidade de [criar uma nova conta OVHcloud](/pages/account_and_service_management/account_information/ovhcloud-account-creation). No entanto, terá de transferir manualmente todos os seus serviços para a nova conta seguindo o [processo de mudança de contactos](/pages/account_and_service_management/account_information/managing_contacts). -Pretende alterar o endereço de e-mail da sua conta OVHcloud? Receberá primeiro um pedido de confirmação no endereço de e-mail atualmente indicado na Área de Cliente. Se perdeu o acesso a este endereço, basta aguardar 24 horas. Após esse prazo, a alteração será implementada automaticamente. +/// -### Como indicar corretamente o meu número de telefone durante o processo de criação de conta? +/// details | Posso mudar a filial da minha conta OVHcloud? -Deve indicar o seu número de telefone em formato internacional. +Se criou uma conta OVHcloud na filial errada, pode criar uma nova conta na filial correta com as mesmas informações pessoais. -#### Truques e dicas: +No entanto, deve associar um endereço de contacto diferente, pois não é possível ter duas contas OVHcloud diferentes com o mesmo endereço de contacto. -Por exemplo: se o seu número for “21 123 45 67”, indique “+351 211234567”. O indicativo “+351” é adicionado automaticamente se selecionar Portugal como país de residência. +Encontrará informações complementares sobre a criação de uma conta OVHcloud no nosso guia "[Criar uma conta OVHcloud](/pages/account_and_service_management/account_information/ovhcloud-account-creation)". -### Que impacto tem o RGPD sobre os meus dados pessoais? +Uma vez que tenha criado a sua nova conta OVHcloud na filial correta, pode seguir as instruções de [este guia](/pages/account_and_service_management/account_information/managing_contacts) para mover os seus serviços de uma conta para outra. -Para conhecer o impacto do Regulamento Geral sobre a Proteção de Dados (RGPD) relativamente à sua atividade profissional ou às suas informações pessoais, pode consultar os recursos seguintes: +Se possui uma conta OVHcloud na nossa infraestrutura canadense (ou seja, num país fora da Europa), não poderá mover serviços entre as contas. Neste caso, será necessário encomendar novos serviços na nova conta e migrar manualmente os seus conteúdos, se necessário. -- [“A OVHcloud e a proteção de dados pessoais”](https://www.ovhcloud.com/pt/personal-data-protection/); -- [“RGPD - Resposta a questões frequentes”](https://www.ovhcloud.com/pt/personal-data-protection/faq/?lsdDoc=faq.xml). +Para qualquer informação complementar, contacte o nosso suporte criando um [ticket de assistência a partir do centro de ajuda OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help). -### Como modificar a minha palavra-passe OVHcloud? +/// -Na página de login da sua Área de Cliente, selecione a opção “ID de cliente ou palavra-passe esquecidos”. Indique o seu ID ou o endereço de e-mail principal associado à sua conta OVHcloud. A seguir, clique em “Enviar”. Para confirmar o pedido, receberá um e-mail no endereço de contacto da conta. Leia atentamente as instruções e clique na ligação que lhe será apresentada. +/// details | Como eliminar a minha conta OVHcloud? -#### Truques e dicas: +A fechamento da sua conta cliente OVHcloud e a eliminação das suas informações pessoais só é possível se: -No caso de ter perdido o acesso ao endereço de e-mail de contacto, sugerimos que siga o seguinte [procedimento](https://www.ovh.pt/suporte/procedimentos/). -Se se esqueceu do seu ID de cliente, poderá encontrá-lo no canto superior direito da sua última fatura. Tem a seguinte forma: “aa00000-ovh” (as primeiras letras costumam ser as iniciais do nome da pessoa que criou a conta). Este ID de cliente também se encontra indicado no e-mail de confirmação de criação de conta, bem como nos e-mails de confirmação ou de renovação de encomenda. +1. Não tem serviços visíveis na secção "[As minhas ofertas e serviços](https://www.ovh.com/manager/dedicated/#/billing/autoRenew)". Caso contrário, terá de solicitar a sua rescisão e aguardar a sua eliminação. +2. Não tem faturas pendentes de pagamento. Caso contrário, deverá liquidá-las clicando no botão `Pagar imediatamente`{.action} nas ações em massa na página "[As minhas faturas](https://www.ovh.com/manager/#/dedicated/billing/history)". +3. Não tem encomendas em curso. Verifique-o [nesta página](https://www.ovh.com/manager/#/dedicated/billing/orders/orders). +4. O seu saldo pré-pago não é positivo. Verifique-o [nesta página](https://www.ovh.com/manager/#/dedicated/billing/payment/ovhaccount). -### Como alterar os contactos? +Se todas as condições acima forem cumpridas, pode solicitar a eliminação da sua conta OVHcloud e os dados associados seguindo estes passos: -Tem a possibilidade de delegar a gestão administrativa, técnica e faturação dos seus serviços a outras contas de cliente OVHcloud a partir da sua Área de Cliente. Para isso, aceda à sua [Área de Cliente OVHcloud](/links/manager), clique no seu nome no canto superior direito e, a seguir, em `Contactos`{.action}. +1. Inicie sessão no [centro de ajuda OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help). +1. Selecione o motivo `Gerir a sua conta cliente OVHcloud`{.action}. +1. Indique `Quero encerrar a minha conta cliente OVHcloud`{.action} e siga as etapas descritas. -A delegação do serviço deverá ser validada por e-mail pelo administrador do serviço e pelo novo contacto. +/// -Antes de efetuar qualquer alteração, certifique-se de que todos os endereços de e-mail de contacto são válidos, caso o contrário o pedido não poderá ser tido em conta. +### Gerir notificações e registos -Se pretender recuperar um nome de domínio do qual é o proprietário registado junto da entidade de registo (pode verificar estas informações em [www.ovh.com/pt/cgi-bin/tools/check_whois.pl](https://www.ovh.com/pt/cgi-bin/tools/check_whois.pl)), mas não tem acesso à conta de cliente administrador, recomendamos que siga o seguinte procedimento: [www.ovh.com/pt/cgi-bin/pt/procedure/procedureChangeContacts.cgi](https://www.ovh.com/pt/cgi-bin/pt/procedure/procedureChangeContacts.cgi). +/// details | Posso receber todas as notificações da OVHcloud em vários endereços de correio eletrónico? -#### Conselhos e dicas +Infelizmente, não é possível enviar e-mails de comunicação para múltiplos endereços. -Está disponível um guia completo sobre gestão de contactos [aqui](/pages/account_and_service_management/account_information/managing_contacts#aceder-a-area-de-gestao-dos-contactos). +A partir do seu [Área de Cliente OVHcloud](/links/manager), pode configurar um endereço de correio eletrónico de recuperação que não será utilizado para enviar todas as nossas comunicações (renovações, eliminações de serviços, etc.). -### Como configurar ou modificar um contacto de faturação? +Este endereço de correio eletrónico de recuperação é útil em caso de perda de acesso ao seu endereço de correio eletrónico principal, pois isso impediria a sua ligação ao seu Área de Cliente OVHcloud. -Aceda à sua [Área de Cliente OVHcloud](/links/manager), clique no seu nome no canto superior direito e, a seguir, em `Contactos`{.action}. +/// -#### Truques e dicas +/// details | Recebi uma notificação sua em outra língua. Como corrigir isso? -Se deseja saber mais sobre a gestão dos contactos, consulte este manual pormenorizado: [“Como gerir os contactos (gestores) dos serviços OVHcloud”](/pages/account_and_service_management/account_information/managing_contacts). +Pode alterar a língua dos nossos e-mails automatizados seguindo estes passos: -### Como proteger a minha conta? +1. Inicie sessão no seu [Área de Cliente OVHcloud](/links/manager). +1. Aceda, em seguida, ao [centro de ajuda OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help). +1. Clique em `Iniciar sessão no centro de ajuda`{.action} e confirme a sua ligação. +1. Clique na bandeira no canto superior direito do centro de ajuda e selecione o país/região correspondente à língua desejada. +1. Clique em `Terminar sessão no centro de ajuda`{.action}. -Tem à sua disposição várias soluções para proteger a sua conta tais como: +A partir daí, as próximas notificações automáticas por e-mail serão enviadas na língua desejada. -- a escolha de uma palavra-passe complexa -- a renovação regular desta palavra-passe -- dupla autenticação +/// -Para a dupla autenticação através do envio de um código por SMS ou através da restrição por IP (autorização ou recusa de acesso a certos endereços), tem a possibilidade de adicionar regras de segurança a partir do seu Espaço Cliente. Todas estas opções estão disponíveis na secção "Segurança". Aceda à sua [Área de Cliente OVHcloud](/links/manager), clique no seu nome no canto superior direito e, a seguir, em `Aceder à minha conta`{.action}. Clique então em `Segurança`{.action}. +/// details | Posso ver todas as ações realizadas a partir do Área de Cliente OVHcloud? Existem registos? -Para mais informações, visualize o [vídeo](https://www.youtube.com/watch?v=odO58c4gJfc&list=PL0DynEzr_sE5MnOfJOpVJN-EhfMDWoqGS&index=24). +Sim, pode aceder aos registos das ações realizadas na sua conta. -### Como ativar a dupla autenticação/2FA da OVHcloud? +Para isso, terá de se ligar às [APIs OVHcloud](/links/api) com a ajuda do guia "[Primeiros passos com as APIs OVHcloud](/pages/manage_and_operate/api/first-steps)". Uma vez ligado, pode utilizar o seguinte pedido API para recuperar o ID do registo: -Depois de criar a sua conta de cliente OVHcloud, recomendamos que proteja os seus dados pessoais, ativando a dupla autenticação. Para isso, aceda à sua [Área de Cliente OVHcloud](/links/manager), clique no seu nome no canto superior direito e, a seguir, em `Aceder à minha conta`{.action}. Clique então em `Segurança`{.action}. Assim, para ativar a 2FA, existem várias soluções para a autenticação: +> [!api] +> +> @api {v1} /me GET /me/api/logs/self +> -- Por SMS, através de um código de segurança -- A partir de uma aplicação móvel compatível com Android, iPhone e Windows Mobile -- Com uma chave de segurança, compatível com U2F +Assim, obterá a lista dos identificadores de registos. Em seguida, pode utilizar o seguinte pedido API para recuperar os detalhes de um registo específico: -Para mais informações, consulte esta [ligação](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa) +> [!api] +> +> @api {v1} /me GET /me/api/logs/self/{logId} +> -### Como desativar a dupla autenticação/2FA da OVHcloud? +Substitua `{logId}` pelo identificador real do registo que deseja consultar. Isto permitirá aceder ao registo e visualizar as ações realizadas a partir do Área de Cliente OVHcloud. -Se pretender desativar a dupla autenticação que implementou, pode aceda à sua [Área de Cliente OVHcloud](/links/manager), clique no seu nome no canto superior direito e, a seguir, em `Aceder à minha conta`{.action}. Clique então em `Segurança`{.action}. +/// -Poderá desativar cada um dos diferentes periféricos de segurança.  +### Delegar o acesso aos seus serviços -No entanto, se já não tiver acesso à sua Área de Cliente, porque perdeu o seu periférico de dupla autenticação, recomendamos que contacte o suporte da OVHcloud para que um conselheiro desative manualmente o dispositivo, mediante a apresentação de documentos comprovativos. +/// details | Como delegar o acesso aos meus serviços a outras pessoas? -### O que fazer se a minha conta OVHcloud foi pirateada? +Tem a possibilidade de delegar a gestão administrativa, técnica e faturação dos seus serviços a outros contos clientes OVHcloud a partir do seu Área de Cliente OVHcloud. Para isso, inicie sessão no seu [Área de Cliente OVHcloud](/links/manager), clique no seu nome no canto superior direito e, em seguida, em `Contactos`{.action}. -Em caso de uso fraudulento da sua conta OVHcloud (identidade, método de pagamento...), convidamo-lo a apresentar queixa, o mais rapidamente possível, junto dos serviços policiais. +A delegação de serviço terá de ser validada por e-mail tanto pelo administrador do serviço como pelo novo contacto. -Quando estiver na posse da queixa formal, deverá enviar-nos uma cópia. Esse documento permitirá que se dê início a um processo interno. +Antes de qualquer alteração, certifique-se de que todos os endereços de contacto são válidos, caso contrário, a solicitação não poderá ser concluída. -O seu nome de utilizador será bloqueado. Os serviços subscritos de forma fraudulenta serão suprimidos e reembolsados automaticamente. +Se desejar recuperar um nome de domínio de que é o proprietário registado junto do registo (pode verificar estas informações no [nosso ferramenta WHOIS online](/links/web/domains-whois)), mas não tem acesso à conta cliente administrativa, convidamo-lo a seguir [esta procedimento](/links/transversal/procedure-contact-change). -Por fim, de modo a recuperar o controlo da sua conta de cliente, poderemos pedir-lhe que altere o seu endereço de e-mail e/ou a sua palavra-passe através desta [ligação](https://www.ovh.pt/cgi-bin/pt/procedure/procedureChangeEmail.cgi). +> [!success] +> Um guia completo sobre a gestão de contactos está disponível [aqui](/pages/account_and_service_management/account_information/managing_contacts). + +/// + +/// details | Como configurar ou modificar um contacto de faturação? + +Inicie sessão no seu [Área de Cliente OVHcloud](/links/manager), clique no seu nome no canto superior direito e, em seguida, em `Contactos`{.action}. -### Recebi um e-mail que parece ser phishing a usurpar a identidade da OVHcloud. Como posso chamar a vossa atenção? +> [!success] +> Se desejar saber mais sobre a gestão de contactos, convidamo-lo a consultar este guia detalhado: "[Gerir os contactos dos seus serviços](/pages/account_and_service_management/account_information/managing_contacts)". + +/// -Para sinalizar um e-mail ou uma SMS de phishing, consulte o nosso [guia dedicado](/pages/account_and_service_management/account_information/phishing_care). +/// details | Quero transferir todos os meus serviços para outra conta OVHcloud, como posso fazê-lo de uma só vez? -### Como assinalar um comportamento abusivo ou um conteúdo ilícito proveniente de serviços alojados pela OVHcloud e do qual sou vítima? +Para transferir todos os seus serviços para outra conta OVHcloud, recomendamos que [contacte diretamente o nosso suporte técnico](https://help.ovhcloud.com/csm?id=csm_get_help). As nossas equipas estarão disponíveis para o orientar ao longo do processo e ajudá-lo na transferência em massa dos seus serviços para a nova conta. -Pode assinalar qualquer comportamento abusivo ou conteúdo ilícito na plataforma OVHcloud dedicada a este efeito [www.ovh.com/abuse/](https://www.ovh.com/abuse/). Selecione a categoria em causa e introduza os campos solicitados. +/// -Só os logs e os elementos técnicos podem ser transmitidos ao titular do serviço incriminado. Por favor, não inclua dados pessoais nestes campos. +### Denunciar uma atividade abusiva/ilegal ou um ataque informático -### Após a declaração de um abuso, o que acontece à minha queixa? +/// details | O que fazer se a minha conta OVHcloud foi comprometida? -A sua queixa será tratada o mais rapidamente possível pelo Serviço Jurídico da OVHcloud. A sua queixa será analisada e, em função disso, comunicar-lhe-emos mais pormenores. Após comprovação do comportamento abusivo de um dos nossos clientes, informá-lo-emos e faremos o necessário junto da(s) pessoa(s) em causa para resolver a situação o quanto antes. +Em caso de utilização fraudulenta da sua conta OVHcloud (identidade, meios de pagamento, etc.), convidamo-lo a apresentar uma queixa o mais rapidamente possível perante a Prefeitura de Polícia ou a Gendarmerie. -### A OVHcloud enviou-me um e-mail a comunicar um eventual comportamento abusivo da minha parte. O que devo fazer? +Assim que a queixa estiver em sua posse, terá de nos enviar uma cópia. Esta permitirá iniciar as nossas démarches internas. -Se nos foi comunicado (ou se as nossas equipas verificaram) um comportamento abusivo, receberá um e-mail proveniente de um endereço de e-mail no formato "ticket+"número-de-ticket"@abuse.ovh.net". +Contacte o suporte OVHcloud por telefone: -Tendo em conta os elementos complementares que lhe serão indicados nesse e-mail, solicitamos-lhe que proceda a uma investigação a fim de remediar o comportamento abusivo e/ou de eliminar qualquer conteúdo ilícito. +- Portugal: +351 213 155 642 -Para garantir que os seus serviços não estão sob o controlo de terceiros (por exemplo, na sequência de pirataria), recomendamos que verifique a respetiva segurança: +O seu identificador de cliente será bloqueado e os serviços subscritos de forma fraudulenta serão eliminados. -- [Proteger a minha conta OVHcloud e gerir as minhas informações pessoais](/pages/account_and_service_management/account_information/all_about_username) -- [Alterar a palavra-passe da sua conta](/pages/account_and_service_management/account_information/manage-ovh-password) -- [Proteger a sua conta OVHcloud com a dupla autenticação](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa) -- [Como proteger o seu website?](/pages/web_cloud/web_hosting/secure_your_website) -- [Proteger um VPS](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps) -- [Proteger um servidor dedicado](/pages/bare_metal_cloud/dedicated_servers/securing-a-dedicated-server) +Por fim, para recuperar o uso da sua conta cliente, poderemos solicitar-lhe que modifique o seu endereço de correio eletrónico e/ou a sua palavra-passe através [desta procedimento](/links/transversal/procedure-email-change). -### Em caso de identificação de um eventual abuso por parte de um dos meus serviços, como evitar uma suspensão? +/// -Depois de realizar as ações necessárias, responda diretamente ao e-mail que lhe foi enviado pelo nosso serviço Abuse, especificando as medidas que tomou. -Um membro da nossa equipa irá responder-lhe o mais rapidamente possível. +/// details | Recebi um e-mail que parece ser phishing a usurpar a identidade da OVHcloud, como o denunciar para verificação? -### Respondi ao e-mail de Abuse da OVHcloud, mas o meu serviço continua bloqueado. O que posso fazer? +Para identificar e denunciar um e-mail ou SMS de phishing, consulte o nosso [guia dedicado](/pages/account_and_service_management/account_information/phishing_care). -A partir da [Centro de ajuda da OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help), pode abrir um pedido de assistência junto do Serviço de Clientes da OVHcloud, de modo a obter informações complementares sobre o tratamento do seu ticket Abuse. Para facilitar o tratamento do seu pedido, queira mencionar no pedido de assistência a referência do ticket Abuse. +/// -### Como eliminar a minha conta OVHcloud? +/// details | Como denunciar um comportamento abusivo ou conteúdo ilegal proveniente de serviços alojados pela OVHcloud e de que sou vítima? -O encerramento da sua conta de cliente OVHcloud e a eliminação dos seus dados pessoais só é possível se: +Encontre as respostas às perguntas sobre a denúncia de comportamentos abusivos ou conteúdo ilegal no nosso [FAQ sobre o suporte OVHcloud](/pages/account_and_service_management/account_information/faq-support). -1. Já não tem serviços visíveis na secção [O meus Serviços](https://www.ovh.com/manager/dedicated/#/billing/autoRenew). Caso contrário, deverá começar por solicitar a sua rescisão e aguardar a sua eliminação. -2. Não possui faturas com pagamento pendente. Caso contrário, deverá proceder ao seu pagamento clicando no botão `Pagar imediatamente`{.action} nas ações de massas da página [As minhas faturas](https://www.ovh.com/manager/#/dedicated/billing/history). -3. Não possui encomendas em curso. Verifique-o em [esta página](https://www.ovh.com/manager/#/dedicated/billing/orders/orders). -4. A sua conta pré-paga não é positiva. Verifique-o em [esta página](https://www.ovh.com/manager/#/dedicated/billing/payment/ovhaccount). +/// -Se as condições acima estiverem preenchidas, pode pedir para eliminar a sua conta OVHcloud e os dados associados seguindo estas etapas: +/// details | A OVHcloud enviou-me um e-mail indicando um possível comportamento abusivo por minha parte, o que devo fazer? -1. Aceder a [Centro de Ajuda da OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help). -2. Clique no botão `Criar um ticket`{.action}. -3. Selecione o motivo `Gerir a sua conta de cliente OVHcloud`{.action}. -4. Especifique `Quero encerrar a minha conta de cliente OVHcloud`{.action} e siga as etapas descritas. +Encontre as respostas às perguntas sobre a denúncia de comportamentos abusivos ou conteúdo ilegal no nosso [FAQ sobre o suporte OVHcloud](/pages/account_and_service_management/account_information/faq-support). + +/// ## Quer saber mais? - + Fale com nossa [comunidade de utilizadores](/links/community). \ No newline at end of file diff --git a/pages/account_and_service_management/account_information/faq-account-management/images/infos-modif_final_comp-min.gif b/pages/account_and_service_management/account_information/faq-account-management/images/infos-modif_final_comp-min.gif deleted file mode 100644 index 5c8b1661988..00000000000 Binary files a/pages/account_and_service_management/account_information/faq-account-management/images/infos-modif_final_comp-min.gif and /dev/null differ diff --git a/pages/account_and_service_management/account_information/faq-account-management/meta.yaml b/pages/account_and_service_management/account_information/faq-account-management/meta.yaml index 4f7ab0b92c0..8352963db1e 100644 --- a/pages/account_and_service_management/account_information/faq-account-management/meta.yaml +++ b/pages/account_and_service_management/account_information/faq-account-management/meta.yaml @@ -1,4 +1,4 @@ -id : 0fa1489b-422b-4e3f-8582-fb63d664cb1a +id: 0fa1489b-422b-4e3f-8582-fb63d664cb1a full_slug: faq-account-management reference_category: account-and-service-management-account-information-faq translation_banner: true \ No newline at end of file diff --git a/pages/account_and_service_management/account_information/faq-support/guide.de-de.md b/pages/account_and_service_management/account_information/faq-support/guide.de-de.md index 2308c9befd4..568c5221241 100644 --- a/pages/account_and_service_management/account_information/faq-support/guide.de-de.md +++ b/pages/account_and_service_management/account_information/faq-support/guide.de-de.md @@ -1,20 +1,110 @@ --- title: OVHcloud Support FAQ excerpt: Hier finden Sie die häufigsten Fragen zum OVHcloud Support -updated: 2025-04-28 +updated: 2025-10-30 --- -## Ziel + -Hier finden Sie Antworten zu den häufigsten Fragen zum OVHcloud Support. +## Ziel - +Unterliegt Ihr Dienst einen Ausfall? Benötigen Sie Unterstützung?
+Finden Sie hier die häufigsten Fragen zum OVHcloud Support. -## Voraussetzungen +## FAQ -### Was kann ich tun, wenn ich Schwierigkeiten habe, mich mit dem Help Center oder dem Interface zur Verwaltung meiner Tickets zu verbinden? +### Status der Dienste + +/// details | Ich vermute, mein Dienst ist von einem Ausfall betroffen. Wo kann ich prüfen, ob eine globale Störung vorliegt? + +Wenn Sie einen Ausfall auf Ihrem Dienst feststellen und bereits bestätigt haben, dass dieser aktiv und verlängert ist, besuchen Sie diese Seite, um m aktuelle Störungsbehebungen auf unseren Infrastrukturen zu prüfen: . + +Klicken Sie dann auf die betroffene Infrastruktur (z. B.: `Web Cloud`{.action} für einen Webhosting-Dienst oder E-Mail). + +- Laufende Vorfälle sind im Bereich *Current events* oben auf der Seite aufgelistet. +- Vergangene Vorfälle sind im Bereich *Past Incidents* unten auf der Seite aufgelistet. + +Klicken Sie auf das Ereignis, das Ihren Dienst betrifft, um weitere Informationen zu erhalten. + +> [!success] +> +> Für Webhosting Dienste können Sie [diese Anleitung](/pages/web_cloud/web_hosting/how_to_know_cluster_and_filer/) konsultieren, um Ihren Cluster und Ihren Host-Filer daraufhin zu überprüfen, ob er von einem laufenden oder vergangenen Vorfall betroffen ist. + +/// + +/// details | Wie kann ich per E-Mail die neuesten Informationen zu einem spezifischen Vorfall oder Wartung erhalten? + +Wenn Sie auf [dieser Seite](https://www.status-ovhcloud.com/) oder über das Support-Team bestätigt haben, dass Ihr Dienst von einem laufenden Vorfall betroffen ist und Sie Updates per E-Mail erhalten möchten, können Sie einen spezifischen Vorfall abonnieren, um Updates zu erhalten. + +Dazu besuchen Sie die Seite und öffnen den laufenden Vorfall. + +Klicken Sie dann auf den Button `Subscribe to this report`{.action}. + +Sie können sich auch auf eine der „Status“-Seiten abonnieren, um allgemeine Updates zu verschiedenen Vorfällen zu erhalten. + +Zum Beispiel klicken Sie auf der Seite [Web Cloud Status](https://web-cloud.status-ovhcloud.com/) auf `Subscribe to updates`{.action}. + +/// + +### Support kontaktieren + +/// details | Wie erstelle ich ein Support-Ticket? + +Klicken Sie auf [diesen Link](https://help.ovhcloud.com/csm?id=csm_get_help), um ein Support-Ticket über das OVHcloud Help Center zu erstellen. +Melden Sie sich anschließend mit Ihren OVHcloud-Anmeldeinformationen an. + +Nach der Anmeldung klicken Sie auf `✉ Tickets`{.action} und dann auf den Button `Ticket erstellen`{.action}. Wählen Sie anschließend den Grund Ihres Anliegens sowie das betroffene Produkt und Service aus. Geben Sie dann Ihre Anfrage detailliert ein, um personalisierte Hilfestellungen und Tipps zu erhalten. +Falls dies Ihr Anliegen nicht löst, klicken Sie auf `Weiter`{.action}, um Ihre Anfrage zu vervollständigen und ein Support-Ticket zu erstellen. Achten Sie darauf, möglichst viele Informationen bereitzustellen, damit unsere Teams Ihnen bestmöglich helfen können. + +/// + + + +/// details | Was kann ich tun, wenn ich Schwierigkeiten habe, mich mit dem Help Center oder dem Interface zur Verwaltung meiner Tickets zu verbinden? Mögliche Ursachen für dieses Problem: @@ -32,38 +122,90 @@ Versuchen Sie zunächst die folgenden Lösungen: Wenn das Problem weiterhin besteht, wenden Sie sich bitte an unser Support-Team. -#### Tipps und Tricks +> [!success] +> +> **Tipps und Tricks** +> +> Sollten Sie Probleme bei der Verbindung mit Ihrem Kundencenter haben, können Sie auch versuchen, sich über eines der folgenden Gateways anzumelden: +> +> - Europäische Union (EU): +> - Kanada (CA): +> +> Dies kann unter Umständen Verbindungsprobleme beheben. -Sollten Sie Probleme bei der Verbindung mit Ihrem Kundencenter haben, können Sie auch versuchen, sich über eines der folgenden Gateways anzumelden: +/// -- Europäische Union (EU): -- Kanada (CA): - -Dies kann einige Verbindungsprobleme beheben. - -### Was kann ich tun, wenn ich den Support telefonisch nicht erreiche? +/// details | Was kann ich tun, wenn ich den Support telefonisch nicht erreiche? Um Wartezeiten am Telefon zu vermeiden, erstellen Sie eine Support-Anfrage über das [OVHcloud Help Center](https://help.ovhcloud.com/csm?id=csm_get_help). Klicken Sie auf `Ticket erstellen`{.action}. Sie können auch unsere gesamte Dokumentation (FAQ, Anleitungen, Diagnosetools, etc.) im [Help Center](https://help.ovhcloud.com/csm/de-documentation?id=kb_home) einsehen. -### Warum hat sich das Support-Anfrage-Formular geändert? +/// + +/// details | Warum hat sich das Support-Anfrage-Formular geändert? Mit dem neuen Anfrage-Formular wird die Ticket-Erstellung vollständiger und genauer, da wir uns auf einen Fragenkatalog stützen, der es uns ermöglicht, Ihre Anfragen besser einzuordnen: nach Art des Services, Ihrem Betreuungsbedürfnis und der Dringlichkeit Ihrer Anfrage. So können unsere Teams Ihre Anfrage ohne aufwendigen E-Mail-Verkehr schnell und effizient bearbeiten. -### Wie kann ich Dokumente und andere Dateien an den OVHcloud Support senden? +/// + +/// details | Wie kann ich Dokumente und andere Dateien an den OVHcloud Support senden? Sie können Dateien in den folgenden Formaten übertragen (max. Größe: 1024 MB): bmp, cap, csv, eml, gif, jpeg, jpg, pcap, pdf, png, txt, xml, yaml, yml. Erstellen Sie eine Support-Anfrage im [OVHcloud Help Center](https://help.ovhcloud.com/csm?id=csm_get_help) und hängen Sie Ihre Dateien an. -### Wo kann ich mein Support-Level finden? +Wenn Ihre Dateien die maximal erlaubte Größe überschreiten oder Sie ein nicht unterstütztes Format teilen müssen, können Sie direkt auf die E-Mail-Kopie des Tickets **von der E-Mail-Adresse aus, die mit Ihrer Kundenkennung verknüpft ist**, antworten und die Dateien anhängen. Dies ermöglicht es uns, sie zu prüfen und Ihre Anfrage sicher zu beantworten. -Um den Support-Level für Ihre Kundenkennung zu ermitteln, loggen Sie sich in Ihrem [OVHcloud Kundencenter](/links/manager) ein und klicken Sie oben rechts auf Ihren Namen. Der Support-Level wird rechts neben **Support** angezeigt. Wenn Sie keinen kostenpflichtigen Support abonniert haben, erhalten Sie standardmäßig den Standard-Support-Level. +/// -Entdecken und vergleichen Sie [hier](/links/support) die verfügbaren Support-Level. +/// details | Kann ich in einem Ticket Links zu externen Seiten wie Google Drive einfügen? + +Wir können keine externen Links wie Google Drive öffnen, da dies die Sicherheit und Vertraulichkeit Ihrer Daten gefährden könnte. + +Wenn Sie Dateien teilen müssen, können Sie sie direkt in Ihr Ticket über das [OVHcloud Help Center](https://help.ovhcloud.com/csm?id=csm_get_help) im folgenden Format hinzufügen (maximale Größe: 1024 MB): bmp, cap, csv, eml, gif, jpeg, jpg, pcap, pdf, png, txt, xml, yaml, yml. + +/// + +/// details | Kann ich Videodateien in ein Ticket einfügen? Welche Empfehlungen gelten für Größe, Format und Dauer? + +Wenn Sie uns ein Video senden möchten, beachten Sie, dass nur das Format gif akzeptiert wird und die Größe 1024 MB nicht überschreiten darf. Wenn Ihr Video in einem anderen Format ist oder größer ist, können Sie eine der folgenden Methoden wählen: + +- Antworten Sie per E-Mail (von der E-Mail-Adresse, die mit Ihrem OVHcloud Kunden-Account verknüpft ist) auf das Support-Ticket und fügen Sie das Video als Anhang hinzu. +- Laden Sie das Video auf eine Plattform wie YouTube hoch und teilen Sie den Link im Ticket. + +> [!warning] +> **Achtung!** +> +> Wenn Ihr Video sensible Kontoinformationen zeigt (z. B. Kundenkennung, Passwort, IP-Adresse, Dienst-ID usw.), laden Sie das Video nicht öffentlich auf eine Plattform wie YouTube hoch, da dies Ihre Dienste einem Datendiebstahl aussetzen könnte. + +/// + +/// details | Wie kann ich meine alten Support-Tickets einsehen? + +Klicken Sie auf [diesen Link](https://help.ovhcloud.com/csm?id=csm_get_help), um sich im OVHcloud Help Center anzumelden. Geben Sie anschließend Ihre OVHcloud Logindaten ein. + +Nach der Anmeldung werden Ihre neuesten Support-Tickets angezeigt. Klicken Sie auf das Filter-Symbol über der Liste Ihrer Tickets. + +Sie können dann auf den Button `Alle zurücksetzen`{.action} klicken, um alle Filterbedingungen zu löschen und somit auf ältere geschlossene Tickets zugreifen zu können. + +> [!success] +> Nachdem alle Filterbedingungen gelöscht wurden, klicken Sie auf die Spalte `Aktualisiert`{.action}, um Ihre Tickets nach dem Datum der letzten Aktualisierung zu sortieren. +> + +/// + +/// details | Ich benötige einen Experten/Systemadministrator. Wie kann ich einen Spezialisten kontaktieren? + +Wenn Sie bezüglich Administration oder einer falschen lokalen Konfiguration Probleme mit Ihrem Dienst haben, können Sie sich an einen unserer empfohlenen Partner wenden, um zusätzliche Unterstützung für Themen außerhalb des technischen OVHcloud Supports zu erhalten. + +Die Liste der OVHcloud Partner finden Sie auf [dieser Seite](/links/partner). + +/// + +### Support-Level -### Warum hat OVHcloud seinen Kunden-Support erneuert? +/// details | Warum hat OVHcloud den Kunden-Support erneuert? OVHcloud möchte Kunden die bestmögliche Nutzererfahrung bieten und Ihren Erwartungen entsprechen. Dies bedeutet: kurze Antwortzeiten auf verschiedene Fragen und eine verbesserte Servicequalität. @@ -71,6 +213,114 @@ OVHcloud bietet deshalb erweiterten und maßgeschneiderten Support an. Das neue Entdecken und vergleichen Sie [hier](/links/support) die verfügbaren Support-Level. +/// + +/// details | Wo kann ich meinen Support-Level finden? + +Um den Support-Level für Ihre Kundenkennung zu ermitteln, loggen Sie sich in Ihrem [OVHcloud Kundencenter](/links/manager) ein und klicken Sie oben rechts auf den Account-Namen. Der Support-Level wird rechts neben **Support** angezeigt. Wenn Sie keinen kostenpflichtigen Support abonniert haben, ht Ihr Kunden-Account den Support-Level Standard. + +Entdecken und vergleichen Sie [hier](/links/support) die verfügbaren Support-Level. + +/// + +/// details | Ich möchte wieder den Standard-Support-Level nutzen. Wie kann ich meinen aktuellen Support-Level stornieren? + +Nach Ablauf der ursprünglichen Vertragsdauer von 12 Monaten können Sie Ihren Premium-Support-Level stornieren, ohne an eine feste Vertragsdauer gebunden zu sein. + +In diesem Fall benötigen wir eine schriftliche Bestätigung, um die Stornierung zu bearbeiten. + +Um diese Stornierung durchzuführen, wenden Sie sich an unser Support-Team, indem Sie ein [Support-Ticket über das OVHcloud Help Center erstellen](https://help.ovhcloud.com/csm?id=csm_get_help). + +> [!warning] +> **Wichtig:** +> +> - Der Premium-Support wird auf der Grundlage eines 12-monatigen Vertrags abgeschlossen, und Kunden können den Service während der Vertragsdauer nicht stornieren. +> - Die einzige Ausnahme ist das Widerrufsrecht nach dem Kauf, das bestimmten Bedingungen unterliegt: +> - Die Stornierung muss innerhalb von 14 Tagen ab dem Kaufdatum beantragt werden. +> - Der Service muss als Einzelkunde erworben worden sein. + +Wenden Sie sich an [unser Support-Team](https://help.ovhcloud.com/csm?id=csm_get_help), um weitere Informationen zu erhalten. + +/// + +/// details | Wo finde ich Video-Tutorials? + +Wir fügen beständig Tutorials zu unserem YouTube-Kanal hinzu: . + +Nutzen Sie auch die Suchfunktion auf dieser Seite, um Videos zu einem bestimmten Thema zu finden (z. B. „Erstellen einer Website“). + +/// + +### Missbräuchliche/rechtswidrige Aktivitäten oder Hacking melden + +/// details | Was kann ich tun, wenn mein OVHcloud Kunden-Account gehackt wurde? + +Sollte Ihr OVHcloud Kunden-Account missbräuchlich verwendet werden (Kundenkennung, Zahlungsmittel, etc.), wenden Sie sich bitte umgehend an die zuständige Polizeibehörde, um Anzeige zu erstatten. + +Die Behörde wird Sie daraufhin kontaktieren und die Anzeige gemeinsam mit Ihnen aufnehmen. Sobald Sie Anzeige erstattet haben, senden Sie uns bitte ein Kopie der Anzeige zu. Wir können dann interne Schritte einleiten. + +Kontaktieren Sie den OVHcloud Support telefonisch: + +- Deutschland: +49 681 906730 + +Ihre Kundenkennung wird infolgedessen blockiert. Missbräuchlich bestellte Dienste werden wir löschen und Ihnen die Zahlungen automatisch rückerstatten. + +Damit Sie Ihren Account wieder nutzen können, werden wir Sie dazu auffordern, Ihre E-Mail-Adresse und/oder Ihr Passwort über den folgenden Link zu ändern: [www.ovh.de/cgi-bin/de/procedure/procedureChangeEmail.cgi](https://www.ovh.de/cgi-bin/de/procedure/procedureChangeEmail.cgi). + +/// + +/// details | Ich habe eine E-Mail erhalten, die Phishing sein könnte. Angeblich kommt sie von OVHcloud. Wie kann ich eine Überprüfung veranlassen? + +Wie Sie einen Phishing-Versuch durch eine E-Mail oder eine SMS identifizieren und melden können, erfahren Sie in unserer [Anleitung](/pages/account_and_service_management/account_information/phishing_care). + +/// + +/// details | Wie kann ich als Opfer missbräuchliches Verhalten oder rechtswidrige Inhalte melden, für die bei OVHcloud gehostete Dienste genutzt werden (Abuse)? + +Jegliches missbräuchliche Verhalten und illegale Inhalte können Sie auf der eigens dafür eingerichteten Plattform von OVHcloud melden: [www.ovh.com/abuse/](https://www.ovh.com/abuse/). Wählen Sie bitte die entsprechende Kategorie und füllen Sie die erforderlichen Felder aus. + +Dem Inhaber des jeweiligen Dienstes dürfen nur Logs und technische Daten übermittelt werden. Bitte achten Sie daher darauf, in diesen Feldern keine personenbezogenen Angaben zu machen. + +/// + +/// details | Was passiert, nachdem ich einen Missbrauch gemeldet habe? + +Die Rechtsabteilung von OVHcloud bearbeitet Ihre Meldung schnellstmöglich und analysiert Ihre Beschwerde. Auf dieser Grundlage teilen wir Ihnen im Anschluss weiterführende Informationen mit. Wird das missbräuchliche Verhalten seitens eines Kunden bestätigt, werden wir Sie darüber informieren. Bei den fraglichen Personen wirken wir darauf hin, dieses Verhalten unverzüglich einzustellen. + +/// + +/// details | OVHcloud hat mir eine E-Mail zu potenziell missbräuchlichem Verhalten meinerseits gesendet. Was soll ich tun? + +Wenn uns ein missbräuchliches Verhalten gemeldet oder von unseren Teams festgestellt wird, erhalten Sie eine E-Mail. Das Format der E-Mail-Adresse ist “ticket+"ticket-nummer"@abuse.ovh.net”. + +In Anbetracht der Details, die Sie in der E-Mail erfahren werden, werden wir Sie bitten, den Angaben nachzugehen, etwaiges missbräuchliches Verhalten einzustellen und jegliche rechtswidrigen Inhalte zu löschen. + +Wir empfehlen Ihnen, die Absicherung Ihrer Dienste zu überprüfen. Lassen Sie sich von diesen Anleitungen unterstützen, um auszuschließen, dass Ihre Dienste gehackt wurden und unter dem Einfluss Dritter stehen: + +- [Den OVHcloud Kunden-Account absichern und persönliche Informationen verwalten](/pages/account_and_service_management/account_information/all_about_username) +- [Das Passwort Ihres OVHcloud Kunden-Accounts ändern](/pages/account_and_service_management/account_information/manage-ovh-password) +- [Den OVHcloud Kunden-Account mit der Zwei-Faktor-Authentifizierung absichern](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa) +- [Die Sicherheit Ihrer Website optimieren](/pages/web_cloud/web_hosting/secure_your_website) +- [VPS absichern](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps) +- [Einen dedizierten Server absichern](/pages/bare_metal_cloud/dedicated_servers/securing-a-dedicated-server) + +/// + +/// details | Wie kann ich vermeiden, dass meine Dienste blockiert werden, wenn eine potenzielle missbräuchliche Verwendung eines meiner OVHcloud Dienste festgestellt wird? + +Ergreifen Sie die erforderlichen Maßnahmen und antworten Sie dann bitte direkt auf die E-Mail unserer Abteilung “Abuse”. Beschreiben Sie in Ihrer Antwort die von Ihnen ausgeführten Schritte. +Ein Mitarbeiter aus unserem Team wird Ihnen dann schnellstmöglich antworten. + +/// + +/// details | Ich habe der Abteilung “Abuse” von OVHcloud geantwortet, aber mein Dienst ist immer noch blockiert. Was kann ich tun? + +Sie haben die Möglichkeit, in Ihrem [OVHcloud Help Center](https://help.ovhcloud.com/csm?id=csm_get_help) eine Support-Anfrage zu stellen und so weitere Informationen zur Bearbeitung Ihres Abuse-Tickets einzuholen. Sie erleichtern und beschleunigen die Bearbeitung Ihrer Support-Anfrage, wenn Sie darin die Referenznummer dieses Abuse-Tickets angeben. + +/// + ## Weiterführende Informationen -Treten Sie unserer [User Community](/links/community) bei. \ No newline at end of file +[FAQ zur Verwaltung des OVHcloud Kunden-Accounts](/pages/account_and_service_management/account_information/faq-account-management) + +Treten Sie unserer [User Community](/links/community) bei. diff --git a/pages/account_and_service_management/account_information/faq-support/guide.en-asia.md b/pages/account_and_service_management/account_information/faq-support/guide.en-asia.md index 06e4b4a80f1..cdca072efd6 100644 --- a/pages/account_and_service_management/account_information/faq-support/guide.en-asia.md +++ b/pages/account_and_service_management/account_information/faq-support/guide.en-asia.md @@ -1,20 +1,50 @@ --- title: OVHcloud Support FAQ excerpt: Find the most frequently asked questions about the OVHcloud support -updated: 2025-09-12 +updated: 2025-10-30 --- @@ -94,8 +124,8 @@ If the problem persists, please contact our assistance team for help. > > - European Union (EU): > - Canada (CA): - -This may solve some login problems. +> +> This may solve some login problems. /// diff --git a/pages/account_and_service_management/account_information/faq-support/guide.en-au.md b/pages/account_and_service_management/account_information/faq-support/guide.en-au.md index 06e4b4a80f1..cdca072efd6 100644 --- a/pages/account_and_service_management/account_information/faq-support/guide.en-au.md +++ b/pages/account_and_service_management/account_information/faq-support/guide.en-au.md @@ -1,20 +1,50 @@ --- title: OVHcloud Support FAQ excerpt: Find the most frequently asked questions about the OVHcloud support -updated: 2025-09-12 +updated: 2025-10-30 --- @@ -94,8 +124,8 @@ If the problem persists, please contact our assistance team for help. > > - European Union (EU): > - Canada (CA): - -This may solve some login problems. +> +> This may solve some login problems. /// diff --git a/pages/account_and_service_management/account_information/faq-support/guide.en-ca.md b/pages/account_and_service_management/account_information/faq-support/guide.en-ca.md index 06e4b4a80f1..cdca072efd6 100644 --- a/pages/account_and_service_management/account_information/faq-support/guide.en-ca.md +++ b/pages/account_and_service_management/account_information/faq-support/guide.en-ca.md @@ -1,20 +1,50 @@ --- title: OVHcloud Support FAQ excerpt: Find the most frequently asked questions about the OVHcloud support -updated: 2025-09-12 +updated: 2025-10-30 --- @@ -94,8 +124,8 @@ If the problem persists, please contact our assistance team for help. > > - European Union (EU): > - Canada (CA): - -This may solve some login problems. +> +> This may solve some login problems. /// diff --git a/pages/account_and_service_management/account_information/faq-support/guide.en-gb.md b/pages/account_and_service_management/account_information/faq-support/guide.en-gb.md index 923955ca147..d94cda0f51e 100644 --- a/pages/account_and_service_management/account_information/faq-support/guide.en-gb.md +++ b/pages/account_and_service_management/account_information/faq-support/guide.en-gb.md @@ -1,20 +1,50 @@ --- title: OVHcloud Support FAQ excerpt: Find the most frequently asked questions about the OVHcloud support -updated: 2025-09-12 +updated: 2025-10-30 --- @@ -94,8 +124,8 @@ If the problem persists, please contact our assistance team for help. > > - European Union (EU): > - Canada (CA): - -This may solve some login problems. +> +> This may solve some login problems. /// diff --git a/pages/account_and_service_management/account_information/faq-support/guide.en-ie.md b/pages/account_and_service_management/account_information/faq-support/guide.en-ie.md index 06e4b4a80f1..cdca072efd6 100644 --- a/pages/account_and_service_management/account_information/faq-support/guide.en-ie.md +++ b/pages/account_and_service_management/account_information/faq-support/guide.en-ie.md @@ -1,20 +1,50 @@ --- title: OVHcloud Support FAQ excerpt: Find the most frequently asked questions about the OVHcloud support -updated: 2025-09-12 +updated: 2025-10-30 --- @@ -94,8 +124,8 @@ If the problem persists, please contact our assistance team for help. > > - European Union (EU): > - Canada (CA): - -This may solve some login problems. +> +> This may solve some login problems. /// diff --git a/pages/account_and_service_management/account_information/faq-support/guide.en-sg.md b/pages/account_and_service_management/account_information/faq-support/guide.en-sg.md index 06e4b4a80f1..cdca072efd6 100644 --- a/pages/account_and_service_management/account_information/faq-support/guide.en-sg.md +++ b/pages/account_and_service_management/account_information/faq-support/guide.en-sg.md @@ -1,20 +1,50 @@ --- title: OVHcloud Support FAQ excerpt: Find the most frequently asked questions about the OVHcloud support -updated: 2025-09-12 +updated: 2025-10-30 --- @@ -94,8 +124,8 @@ If the problem persists, please contact our assistance team for help. > > - European Union (EU): > - Canada (CA): - -This may solve some login problems. +> +> This may solve some login problems. /// diff --git a/pages/account_and_service_management/account_information/faq-support/guide.en-us.md b/pages/account_and_service_management/account_information/faq-support/guide.en-us.md index 06e4b4a80f1..cdca072efd6 100644 --- a/pages/account_and_service_management/account_information/faq-support/guide.en-us.md +++ b/pages/account_and_service_management/account_information/faq-support/guide.en-us.md @@ -1,20 +1,50 @@ --- title: OVHcloud Support FAQ excerpt: Find the most frequently asked questions about the OVHcloud support -updated: 2025-09-12 +updated: 2025-10-30 --- @@ -94,8 +124,8 @@ If the problem persists, please contact our assistance team for help. > > - European Union (EU): > - Canada (CA): - -This may solve some login problems. +> +> This may solve some login problems. /// diff --git a/pages/account_and_service_management/account_information/faq-support/guide.es-es.md b/pages/account_and_service_management/account_information/faq-support/guide.es-es.md index c4ef0ecc8fc..1b4c7eafdaa 100644 --- a/pages/account_and_service_management/account_information/faq-support/guide.es-es.md +++ b/pages/account_and_service_management/account_information/faq-support/guide.es-es.md @@ -1,20 +1,108 @@ --- title: FAQ en el soporte de OVHcloud excerpt: Encuentre las preguntas más frecuentes en el soporte de OVHcloud -updated: 2025-04-28 +updated: 2025-10-30 --- + + ## Objetivo +¿Su servicio está sufriendo un incidente? ¿Necesita asistencia?
Encuentre aquí las preguntas más frecuentes sobre el soporte de OVHcloud. - - -## FAQ +## Preguntas frecuentes -### ¿Qué hago si tengo problemas para conectarme al centro de ayuda o a la interfaz de gestión de mis tíquets? +### Estado de los servicios + +/// details | Creo que mi servicio está sufriendo un incidente. ¿Dónde puedo verificar si hay un incidente global? + +Si detecta un fallo en su servicio y ya ha confirmado que está activo/renovado, consulte esta página para verificar posibles incidentes en curso en nuestras infraestructuras: . + +Haga clic en la infraestructura afectada (por ejemplo: `Web Cloud`{.action} para un servicio de alojamiento web o una línea VoIP). + +- Los incidentes en curso se enumeran en la sección *Current events* (eventos actuales) en la parte superior de la página. +- Los incidentes pasados se enumeran en la sección *Past Incidents* en la parte inferior de la página. + +Haga clic en el evento correspondiente al servicio afectado para obtener más información. + +> [!success] +> +> Para las plataformas de alojamiento web, puede consultar [este guía](/pages/web_cloud/web_hosting/how_to_know_cluster_and_filer/) para verificar su clúster y su filer de alojamiento para comprobar si están afectados por un incidente en curso o pasado. + +/// + +/// details | ¿Cómo recibir por correo electrónico las últimas actualizaciones sobre un incidente o mantenimiento específico? + +Si ha confirmado en [esta página](https://www.status-ovhcloud.com/) o a través del equipo de soporte que su servicio está afectado por un incidente en curso y desea recibir actualizaciones por correo electrónico, puede suscribirse a un incidente específico para obtener actualizaciones. + +Para ello, vaya a la página y abra el incidente en curso correspondiente. + +Haga clic en el botón `Subscribe to this report`{.action}. + +También puede suscribirse a una de las páginas «status» para recibir actualizaciones generales sobre diversos incidentes. + +Por ejemplo, en la página [Web Cloud Status](https://web-cloud.status-ovhcloud.com/), haga clic en `Subscribe to updates`{.action}. + +/// + +### Contactar con el soporte + +/// details | ¿Cómo crear un ticket de asistencia? + +Haga clic en [este enlace](https://help.ovhcloud.com/csm?id=csm_get_help) para crear un ticket de asistencia desde el centro de ayuda de OVHcloud. Inicie sesión con sus credenciales de OVHcloud. + +Una vez identificado, haga clic en `✉ Tickets`{.action} y luego en el botón `Crear ticket`{.action}. Seleccione el motivo de su solicitud y el producto y servicio afectados. Proporcione después su consulta para acceder a sugerencias personalizadas de ayuda y consejos. Si esto no resuelve su necesidad, haga clic en `Siguiente`{.action} para completar su solicitud y crear un ticket de asistencia. Asegúrese de proporcionar la mayor cantidad de información posible para que nuestros equipos puedan ayudarle al máximo. + +/// + + + +/// details | ¿Qué hago si tengo problemas para conectarme al centro de ayuda o a la interfaz de gestión de mis tíquets? Las causas posibles de este problema pueden ser las siguientes: @@ -32,38 +120,89 @@ Estas son las soluciones que debe probar: Si el problema continúa, póngase en contacto con nuestro equipo de soporte para obtener ayuda. -#### Ideas y consejos +> [!success] +> +> **Ideas y consejos** +> +> Si tiene problemas para conectarse al área de cliente, también puede intentar conectarse utilizando una de las dos puertas de enlace siguientes: +> +> - Unión Europea (UE): +> - Canadá (CA): +> +> Esto puede resolver algunos problemas de conexión. -Si tiene problemas para conectarse al área de cliente, también puede intentar conectarse utilizando una de las dos puertas de enlace siguientes: +/// -- Unión Europea (UE): -- Canadá (CA): - -Esto puede resolver algunos problemas de conexión. - -### ¿Qué hacer si no consigo contactar con el soporte por teléfono? +/// details | ¿Qué hacer si no consigo contactar con el soporte por teléfono? Para evitar tener que esperar por teléfono, le invitamos a crear una solicitud de soporte desde el [Centro de ayuda de OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help). Haga clic en el botón `Crear tíquet`{.action}. -También puede consultar toda nuestra documentación (FAQ, guías, herramientas de diagnóstico, etc.) en el [Centro de ayuda](https://help.ovhcloud.com/csm/es-es-documentation?id=kb_home). +También puede consultar toda nuestra documentación (FAQ, guías, herramientas de diagnóstico, etc.) en el [Centro de ayuda](https://help.ovhcloud.com/csm/es-es-documentation?id=kb_home). -### ¿Por qué ha cambiado el formulario de creación de tíquets? +/// + +/// details | ¿Por qué ha cambiado el formulario de creación de tíquets? El objetivo del nuevo formulario es que el proceso de creación de un tíquet sea más completo y preciso. A través de una serie de preguntas, podemos clasificar mejor sus solicitudes según el tipo de servicio, la asistencia que necesita y el nivel de criticidad. Así reducimos el número de intercambios entre usted y nuestro equipo y aceleramos la resolución. -### ¿Cómo puedo enviar documentos y otros archivos al soporte de OVHcloud? +/// + +/// details | ¿Cómo puedo enviar documentos y otros archivos al soporte de OVHcloud? Puede transmitir archivos en los siguientes formatos (tamaño máx.: 1024 MB): bmp, cap, csv, eml, gif, jpeg, jpg, pcap, pdf, png, txt, xml, yaml, yml. Cree una solicitud de asistencia en el [Centro de ayuda de OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help) y adjunte sus archivos. -### ¿Qué nivel de soporte tengo? +Si sus archivos superan el tamaño máximo permitido o si necesita compartir un formato no compatible, puede responder directamente a la copia del ticket enviada por correo electrónico **a la dirección asociada a su identificador de cliente** y adjuntar los archivos. Esto nos permitirá examinarlos y responder a su solicitud con seguridad. -Para conocer el nivel de soporte asociado a su ID de cliente, conéctese a su [área de cliente de OVHcloud](/links/manager) y haga clic en su nombre en la parte superior derecha. El nivel de soporte aparece a la derecha de **Soporte**. Si no ha contratado un servicio de soporte de pago, se beneficia por defecto del nivel Standard. +/// -Descubra y compare los diferentes niveles de soporte disponibles [aquí](/links/support). +/// details | ¿Puedo proporcionar en un ticket enlaces a sitios externos, como Google Drive? + +No podemos acceder a enlaces externos como Google Drive, ya que podría comprometer la seguridad y la confidencialidad de sus datos. + +Si necesita compartir archivos, puede agregarlos directamente en su ticket desde el [centro de ayuda de OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help) en los siguientes formatos (tamaño máximo: 1024 MB): bmp, cap, csv, eml, gif, jpeg, jpg, pcap, pdf, png, txt, xml, yaml, yml. + +/// + +/// details | ¿Puedo añadir archivos de video en un ticket? ¿Cuáles son las recomendaciones de tamaño, formato y duración? + +Si desea enviarnos un video, tenga en cuenta que solo se acepta el formato gif y el tamaño no debe superar los 1024 MB. Si su video está en otro formato o su tamaño es superior, puede optar por una de estas dos opciones: + +- Responder por correo electrónico (desde la dirección de correo asociada a su cuenta de OVHcloud) al ticket de soporte y adjuntar el video como archivo adjunto a su respuesta. +- Subir el video a una plataforma como YouTube y compartir el enlace del video en el ticket. + +> [!warning] +> **¡Atención!** +> Si su video muestra información sensible de su cuenta (por ejemplo: identificador de cliente, contraseña, dirección(es) IP, identificador(es) de servicios, etc.), no suba el video públicamente a una plataforma como YouTube, ya que expondría sus servicios a un potencial robo de datos. + +/// + +/// details | ¿Cómo puedo consultar mis tickets de soporte anteriores? + +Haga clic en [este enlace](https://help.ovhcloud.com/csm?id=csm_get_help) para acceder al centro de ayuda de OVHcloud. Inicie sesión con sus credenciales de OVHcloud. + +Una vez identificado, se mostrarán sus tickets de soporte más recientes. Haga clic en el icono de filtro encima de la lista de sus tickets. + +Puede hacer clic en el botón `Borrar todo`{.action} para restablecer todas las condiciones de filtro y así consultar tickets anteriores cerrados. + +> [!success] +> Una vez que todas las condiciones de filtro se hayan borrado, haga clic en la columna `Actualizado`{.action} para ordenar sus tickets por fecha de actualización. +> + +/// + +/// details | Necesito un experto en contenido/un administrador de sistemas, ¿tienen este tipo de especialista? ¿Dónde puedo contactarlos? + +Si tiene un problema con su servicio debido a la gestión de contenido y/o a una mala configuración local, puede contactar a uno de nuestros socios recomendados para obtener una asistencia adicional sobre temas no incluidos en el soporte técnico de OVHcloud. + +Encuentre la lista de socios de OVHcloud en [esta página](/links/partner). + +/// + +### Niveles de soporte -### ¿Por qué OVHcloud ha actualizado su servicio de atención al cliente? +/// details | ¿Por qué OVHcloud ha actualizado su servicio de atención al cliente? OVhcloud ha tomado esta decisión para mejorar la experiencia que ofrece a sus clientes, que esperan una rápida respuesta a sus preguntas y una excelente calidad de servicio. @@ -71,6 +210,112 @@ Gracias a estos cambios, ahora le ofrecemos más niveles de soporte distintos qu Descubra y compare los diferentes niveles de soporte disponibles [aquí](/links/support). +/// + +/// details | ¿Qué nivel de soporte tengo? + +Para conocer el nivel de soporte asociado a su ID de cliente, conéctese a su [área de cliente de OVHcloud](/links/manager) y haga clic en su nombre en la parte superior derecha. El nivel de soporte aparece a la derecha de **Soporte**. Si no ha contratado un servicio de soporte de pago, se beneficia por defecto del nivel Standard. + +Descubra y compare los diferentes niveles de soporte disponibles [aquí](/links/support). + +/// + +/// details | Deseo volver a beneficiarme del nivel de soporte Standard. ¿Cómo puedo cancelar mi nivel de soporte actual? + +Después de finalizar el período contractual inicial de 12 meses, puede cancelar su nivel de soporte Premium en cualquier momento, sin estar vinculado a una duración contractual fija. + +En este caso, necesitamos una confirmación escrita para procesar la cancelación. + +Para realizar esta cancelación, póngase en contacto con nuestro equipo de soporte creando un [ticket de asistencia a través del centro de ayuda de OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help). + +> [!warning] +> **Importante:** +> +> - El soporte Premium se contrata bajo un contrato de 12 meses y los clientes no pueden cancelar el servicio durante la duración del contrato. +> - La única excepción es el derecho de retractación después de la compra, que está sujeto a ciertas condiciones: +> - La cancelación debe solicitarse dentro de los 14 días siguientes a la fecha de compra. +> - El servicio debe haberse adquirido como cliente individual. + +Póngase en contacto con [nuestro equipo de soporte](https://help.ovhcloud.com/csm?id=csm_get_help) para obtener más información. + +/// + +/// details | ¿Tienen tutoriales en video? + +Añadimos cada vez más tutoriales a nuestro canal de YouTube: . + +No dude en utilizar el motor de búsqueda en esta página para encontrar videos sobre un tema específico (por ejemplo: «crear un sitio web»). + +/// + +### Informar sobre actividad abusiva/ilícita o piratería + +/// details | ¿Qué hacer si me han pirateado la cuenta de OVHcloud? + +Si detecta un uso fraudulento de su cuenta de OVHcloud (identidad, formas de pago...), le recomendamos que lo denuncie a la policía lo antes posible. A continuación, contacte telefónicamente con el soporte. Para garantizar su seguridad, le pediremos que justifique su identidad mediante el envío de la documentación correspondiente y que nos haga llegar una copia de la denuncia. De este modo, podremos iniciar los trámites internos. + +Contacte con el soporte de OVHcloud por teléfono: + +- España: 91 758 34 77 + +Nuestros especialistas analizarán su caso y adoptarán las medidas pertinentes, que podrían incluir el bloqueo de su ID de cliente o la eliminación y reembolso de los servicios contratados de manera fraudulenta. + +Finalmente, para recuperar su cuenta de cliente podremos solicitarle que cambie su dirección de correo electrónico y/o su contraseña cumplimentando este [procedimiento](https://www.ovh.es/cgi-bin/es/procedure/procedureChangeEmail.cgi). + +/// + +/// details | He recibido un mensaje de correo electrónico que parece ser un mensaje de phishing usurpando la identidad de OVHcloud, ¿cómo puedo notificarlo para que se compruebe su legitimidad? + +Para identificar y denunciar un mensaje de correo electrónico o un SMS de phishing, consulte nuestra [guía dedicada](/pages/account_and_service_management/account_information/phishing_care). + +/// + +/// details | ¿Cómo puedo denunciar un comportamiento abusivo o un contenido ilícito procedente de servicios alojados en OVHcloud? + +Puede denunciar cualquier comportamiento abusivo o contenido ilícito en la plataforma de OVHcloud específica para tal fin [www.ovh.com/abuse/](https://www.ovh.com/abuse/). Seleccione la categoría correspondiente e introduzca la información que se le solicita. + +OVHcloud solo enviará los logs y los elementos técnicos al titular del servicio del que procede la infracción. Por favor, no incluya datos personales en esos campos. + +/// + +/// details | Después de denunciar una infracción, ¿qué sucede con esta notificación? + +El servicio jurídico de OVHcloud estudiará su notificación de infracción o contenido ilícito lo antes posible. Nuestro equipo analizará su denuncia y posteriormente se pondrá en contacto con usted para ofrecerle información adicional. Si se demuestra el comportamiento abusivo de uno de nuestros clientes, le informaremos y haremos todo lo necesario para que los responsables pongan fin a este comportamiento lo antes posible. + +/// + +/// details | OVHcloud me ha enviado un mensaje de correo electrónico en el que se indica que yo podría estar cometiendo una infracción, ¿qué debo hacer? + +Si nuestro equipo ha detectado o comprobado la existencia de un comportamiento abusivo, recibirá un mensaje de correo electrónico desde una dirección de correo electrónico con el siguiente formato: "tíquet+"número de tíquet"@abuse.ovh.net". + +Teniendo en cuenta los elementos adicionales que se le indicarán en este mensaje de correo electrónico, nuestro equipo le solicitará que realice una serie de comprobaciones para identificar y corregir el comportamiento abusivo o, en su caso, eliminar el contenido ilícito. + +Asimismo, deberá asegurarse de que sus servicios no están siendo controlados por un tercero (por ejemplo, debido a un ataque informático). Para ello, consulte nuestras guías: + +- [Proteger mi cuenta de OVHcloud y gestionar mis datos personales](/pages/account_and_service_management/account_information/all_about_username) +- [Cambiar la contraseña de su cuenta](/pages/account_and_service_management/account_information/manage-ovh-password) +- [Proteger su cuenta de OVHcloud con la doble autenticación](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa) +- [¿Cómo proteger su sitio web?](/pages/web_cloud/web_hosting/secure_your_website) +- [Proteger un VPS](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps) +- [Proteger un servidor dedicado](/pages/bare_metal_cloud/dedicated_servers/securing-a-dedicated-server) + +/// + +/// details | En caso de identificar una posible infracción en uno de mis servicios de OVHcloud, ¿cómo puedo evitar la suspensión del servicio? + +Una vez que haya realizado las acciones necesarias, deberá responder directamente al mensaje de correo electrónico que le hemos enviado desde nuestro servicio de Abuse indicándonos qué medidas ha adoptado. +Nuestro equipo le responderá lo antes posible. + +/// + +/// details | He respondido al mensaje que me envió el equipo de Abuse de OVHcloud, pero mi servicio sigue bloqueado. ¿Qué puedo hacer? + +Puede crear un tíquet de asistencia desde su [Centro de ayuda de OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help) para solicitar información adicional sobre el tratamiento de su tíquet de Abuse. Por favor, incluya la referencia de su tíquet de Abuse para facilitar el tratamiento del tíquet de asistencia. + +/// + ## Más información +[FAQ sobre la gestión de la cuenta OVHcloud](/pages/account_and_service_management/account_information/faq-account-management) + Interactúe con nuestra [comunidad de usuarios](/links/community). \ No newline at end of file diff --git a/pages/account_and_service_management/account_information/faq-support/guide.es-us.md b/pages/account_and_service_management/account_information/faq-support/guide.es-us.md index c4ef0ecc8fc..a0460d76aff 100644 --- a/pages/account_and_service_management/account_information/faq-support/guide.es-us.md +++ b/pages/account_and_service_management/account_information/faq-support/guide.es-us.md @@ -1,20 +1,108 @@ --- title: FAQ en el soporte de OVHcloud excerpt: Encuentre las preguntas más frecuentes en el soporte de OVHcloud -updated: 2025-04-28 +updated: 2025-10-30 --- + + ## Objetivo +¿Su servicio está sufriendo un incidente? ¿Necesita asistencia?
Encuentre aquí las preguntas más frecuentes sobre el soporte de OVHcloud. - - -## FAQ +## Preguntas frecuentes -### ¿Qué hago si tengo problemas para conectarme al centro de ayuda o a la interfaz de gestión de mis tíquets? +### Estado de los servicios + +/// details | Creo que mi servicio está sufriendo un incidente. ¿Dónde puedo verificar si hay un incidente global? + +Si detecta un fallo en su servicio y ya ha confirmado que está activo/renovado, consulte esta página para verificar posibles incidentes en curso en nuestras infraestructuras: . + +Haga clic en la infraestructura afectada (por ejemplo: `Web Cloud`{.action} para un servicio de alojamiento web o una línea VoIP). + +- Los incidentes en curso se enumeran en la sección *Current events* (eventos actuales) en la parte superior de la página. +- Los incidentes pasados se enumeran en la sección *Past Incidents* en la parte inferior de la página. + +Haga clic en el evento correspondiente al servicio afectado para obtener más información. + +> [!success] +> +> Para las plataformas de alojamiento web, puede consultar [este guía](/pages/web_cloud/web_hosting/how_to_know_cluster_and_filer/) para verificar su clúster y su filer de alojamiento para comprobar si están afectados por un incidente en curso o pasado. + +/// + +/// details | ¿Cómo recibir por correo electrónico las últimas actualizaciones sobre un incidente o mantenimiento específico? + +Si ha confirmado en [esta página](https://www.status-ovhcloud.com/) o a través del equipo de soporte que su servicio está afectado por un incidente en curso y desea recibir actualizaciones por correo electrónico, puede suscribirse a un incidente específico para obtener actualizaciones. + +Para ello, vaya a la página y abra el incidente en curso correspondiente. + +Haga clic en el botón `Subscribe to this report`{.action}. + +También puede suscribirse a una de las páginas «status» para recibir actualizaciones generales sobre diversos incidentes. + +Por ejemplo, en la página [Web Cloud Status](https://web-cloud.status-ovhcloud.com/), haga clic en `Subscribe to updates`{.action}. + +/// + +### Contactar con el soporte + +/// details | ¿Cómo crear un ticket de asistencia? + +Haga clic en [este enlace](https://help.ovhcloud.com/csm?id=csm_get_help) para crear un ticket de asistencia desde el centro de ayuda de OVHcloud. Inicie sesión con sus credenciales de OVHcloud. + +Una vez identificado, haga clic en `✉ Tickets`{.action} y luego en el botón `Crear ticket`{.action}. Seleccione el motivo de su solicitud y el producto y servicio afectados. Proporcione después su consulta para acceder a sugerencias personalizadas de ayuda y consejos. Si esto no resuelve su necesidad, haga clic en `Siguiente`{.action} para completar su solicitud y crear un ticket de asistencia. Asegúrese de proporcionar la mayor cantidad de información posible para que nuestros equipos puedan ayudarle al máximo. + +/// + + + +/// details | ¿Qué hago si tengo problemas para conectarme al centro de ayuda o a la interfaz de gestión de mis tíquets? Las causas posibles de este problema pueden ser las siguientes: @@ -32,38 +120,89 @@ Estas son las soluciones que debe probar: Si el problema continúa, póngase en contacto con nuestro equipo de soporte para obtener ayuda. -#### Ideas y consejos +> [!success] +> +> **Ideas y consejos** +> +> Si tiene problemas para conectarse al área de cliente, también puede intentar conectarse utilizando una de las dos puertas de enlace siguientes: +> +> - Unión Europea (UE): +> - Canadá (CA): +> +> Esto puede resolver algunos problemas de conexión. -Si tiene problemas para conectarse al área de cliente, también puede intentar conectarse utilizando una de las dos puertas de enlace siguientes: +/// -- Unión Europea (UE): -- Canadá (CA): - -Esto puede resolver algunos problemas de conexión. - -### ¿Qué hacer si no consigo contactar con el soporte por teléfono? +/// details | ¿Qué hacer si no consigo contactar con el soporte por teléfono? Para evitar tener que esperar por teléfono, le invitamos a crear una solicitud de soporte desde el [Centro de ayuda de OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help). Haga clic en el botón `Crear tíquet`{.action}. -También puede consultar toda nuestra documentación (FAQ, guías, herramientas de diagnóstico, etc.) en el [Centro de ayuda](https://help.ovhcloud.com/csm/es-es-documentation?id=kb_home). +También puede consultar toda nuestra documentación (FAQ, guías, herramientas de diagnóstico, etc.) en el [Centro de ayuda](https://help.ovhcloud.com/csm/es-es-documentation?id=kb_home). -### ¿Por qué ha cambiado el formulario de creación de tíquets? +/// + +/// details | ¿Por qué ha cambiado el formulario de creación de tíquets? El objetivo del nuevo formulario es que el proceso de creación de un tíquet sea más completo y preciso. A través de una serie de preguntas, podemos clasificar mejor sus solicitudes según el tipo de servicio, la asistencia que necesita y el nivel de criticidad. Así reducimos el número de intercambios entre usted y nuestro equipo y aceleramos la resolución. -### ¿Cómo puedo enviar documentos y otros archivos al soporte de OVHcloud? +/// + +/// details | ¿Cómo puedo enviar documentos y otros archivos al soporte de OVHcloud? Puede transmitir archivos en los siguientes formatos (tamaño máx.: 1024 MB): bmp, cap, csv, eml, gif, jpeg, jpg, pcap, pdf, png, txt, xml, yaml, yml. Cree una solicitud de asistencia en el [Centro de ayuda de OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help) y adjunte sus archivos. -### ¿Qué nivel de soporte tengo? +Si sus archivos superan el tamaño máximo permitido o si necesita compartir un formato no compatible, puede responder directamente a la copia del ticket enviada por correo electrónico **a la dirección asociada a su identificador de cliente** y adjuntar los archivos. Esto nos permitirá examinarlos y responder a su solicitud con seguridad. -Para conocer el nivel de soporte asociado a su ID de cliente, conéctese a su [área de cliente de OVHcloud](/links/manager) y haga clic en su nombre en la parte superior derecha. El nivel de soporte aparece a la derecha de **Soporte**. Si no ha contratado un servicio de soporte de pago, se beneficia por defecto del nivel Standard. +/// -Descubra y compare los diferentes niveles de soporte disponibles [aquí](/links/support). +/// details | ¿Puedo proporcionar en un ticket enlaces a sitios externos, como Google Drive? + +No podemos acceder a enlaces externos como Google Drive, ya que podría comprometer la seguridad y la confidencialidad de sus datos. + +Si necesita compartir archivos, puede agregarlos directamente en su ticket desde el [centro de ayuda de OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help) en los siguientes formatos (tamaño máximo: 1024 MB): bmp, cap, csv, eml, gif, jpeg, jpg, pcap, pdf, png, txt, xml, yaml, yml. + +/// + +/// details | ¿Puedo añadir archivos de video en un ticket? ¿Cuáles son las recomendaciones de tamaño, formato y duración? + +Si desea enviarnos un video, tenga en cuenta que solo se acepta el formato gif y el tamaño no debe superar los 1024 MB. Si su video está en otro formato o su tamaño es superior, puede optar por una de estas dos opciones: + +- Responder por correo electrónico (desde la dirección de correo asociada a su cuenta de OVHcloud) al ticket de soporte y adjuntar el video como archivo adjunto a su respuesta. +- Subir el video a una plataforma como YouTube y compartir el enlace del video en el ticket. + +> [!warning] +> **¡Atención!** +> Si su video muestra información sensible de su cuenta (por ejemplo: identificador de cliente, contraseña, dirección(es) IP, identificador(es) de servicios, etc.), no suba el video públicamente a una plataforma como YouTube, ya que expondría sus servicios a un potencial robo de datos. + +/// + +/// details | ¿Cómo puedo consultar mis tickets de soporte anteriores? + +Haga clic en [este enlace](https://help.ovhcloud.com/csm?id=csm_get_help) para acceder al centro de ayuda de OVHcloud. Inicie sesión con sus credenciales de OVHcloud. + +Una vez identificado, se mostrarán sus tickets de soporte más recientes. Haga clic en el icono de filtro encima de la lista de sus tickets. + +Puede hacer clic en el botón `Borrar todo`{.action} para restablecer todas las condiciones de filtro y así consultar tickets anteriores cerrados. + +> [!success] +> Una vez que todas las condiciones de filtro se hayan borrado, haga clic en la columna `Actualizado`{.action} para ordenar sus tickets por fecha de actualización. +> + +/// + +/// details | Necesito un experto en contenido/un administrador de sistemas, ¿tienen este tipo de especialista? ¿Dónde puedo contactarlos? + +Si tiene un problema con su servicio debido a la gestión de contenido y/o a una mala configuración local, puede contactar a uno de nuestros socios recomendados para obtener una asistencia adicional sobre temas no incluidos en el soporte técnico de OVHcloud. + +Encuentre la lista de socios de OVHcloud en [esta página](/links/partner). + +/// + +### Niveles de soporte -### ¿Por qué OVHcloud ha actualizado su servicio de atención al cliente? +/// details | ¿Por qué OVHcloud ha actualizado su servicio de atención al cliente? OVhcloud ha tomado esta decisión para mejorar la experiencia que ofrece a sus clientes, que esperan una rápida respuesta a sus preguntas y una excelente calidad de servicio. @@ -71,6 +210,112 @@ Gracias a estos cambios, ahora le ofrecemos más niveles de soporte distintos qu Descubra y compare los diferentes niveles de soporte disponibles [aquí](/links/support). +/// + +/// details | ¿Qué nivel de soporte tengo? + +Para conocer el nivel de soporte asociado a su ID de cliente, conéctese a su [área de cliente de OVHcloud](/links/manager) y haga clic en su nombre en la parte superior derecha. El nivel de soporte aparece a la derecha de **Soporte**. Si no ha contratado un servicio de soporte de pago, se beneficia por defecto del nivel Standard. + +Descubra y compare los diferentes niveles de soporte disponibles [aquí](/links/support). + +/// + +/// details | Deseo volver a beneficiarme del nivel de soporte Standard. ¿Cómo puedo cancelar mi nivel de soporte actual? + +Después de finalizar el período contractual inicial de 12 meses, puede cancelar su nivel de soporte Premium en cualquier momento, sin estar vinculado a una duración contractual fija. + +En este caso, necesitamos una confirmación escrita para procesar la cancelación. + +Para realizar esta cancelación, póngase en contacto con nuestro equipo de soporte creando un [ticket de asistencia a través del centro de ayuda de OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help). + +> [!warning] +> **Importante:** +> +> - El soporte Premium se contrata bajo un contrato de 12 meses y los clientes no pueden cancelar el servicio durante la duración del contrato. +> - La única excepción es el derecho de retractación después de la compra, que está sujeto a ciertas condiciones: +> - La cancelación debe solicitarse dentro de los 14 días siguientes a la fecha de compra. +> - El servicio debe haberse adquirido como cliente individual. + +Póngase en contacto con [nuestro equipo de soporte](https://help.ovhcloud.com/csm?id=csm_get_help) para obtener más información. + +/// + +/// details | ¿Tienen tutoriales en video? + +Añadimos cada vez más tutoriales a nuestro canal de YouTube: . + +No dude en utilizar el motor de búsqueda en esta página para encontrar videos sobre un tema específico (por ejemplo: «crear un sitio web»). + +/// + +### Informar sobre actividad abusiva/ilícita o piratería + +/// details | ¿Qué hacer si me han pirateado la cuenta de OVHcloud? + +Si detecta un uso fraudulento de su cuenta de OVHcloud (identidad, formas de pago...), le recomendamos que lo denuncie a la policía lo antes posible. A continuación, contacte telefónicamente con el soporte. Para garantizar su seguridad, le pediremos que justifique su identidad mediante el envío de la documentación correspondiente y que nos haga llegar una copia de la denuncia. De este modo, podremos iniciar los trámites internos. + +Contacte con el soporte de OVHcloud por teléfono: + +- América Latina: 1-855-684-5463 + +Nuestros especialistas analizarán su caso y adoptarán las medidas pertinentes, que podrían incluir el bloqueo de su ID de cliente o la eliminación y reembolso de los servicios contratados de manera fraudulenta. + +Finalmente, para recuperar su cuenta de cliente podremos solicitarle que cambie su dirección de correo electrónico y/o su contraseña cumplimentando este [procedimiento](https://www.ovh.es/cgi-bin/es/procedure/procedureChangeEmail.cgi). + +/// + +/// details | He recibido un mensaje de correo electrónico que parece ser un mensaje de phishing usurpando la identidad de OVHcloud, ¿cómo puedo notificarlo para que se compruebe su legitimidad? + +Para identificar y denunciar un mensaje de correo electrónico o un SMS de phishing, consulte nuestra [guía dedicada](/pages/account_and_service_management/account_information/phishing_care). + +/// + +/// details | ¿Cómo puedo denunciar un comportamiento abusivo o un contenido ilícito procedente de servicios alojados en OVHcloud? + +Puede denunciar cualquier comportamiento abusivo o contenido ilícito en la plataforma de OVHcloud específica para tal fin [www.ovh.com/abuse/](https://www.ovh.com/abuse/). Seleccione la categoría correspondiente e introduzca la información que se le solicita. + +OVHcloud solo enviará los logs y los elementos técnicos al titular del servicio del que procede la infracción. Por favor, no incluya datos personales en esos campos. + +/// + +/// details | Después de denunciar una infracción, ¿qué sucede con esta notificación? + +El servicio jurídico de OVHcloud estudiará su notificación de infracción o contenido ilícito lo antes posible. Nuestro equipo analizará su denuncia y posteriormente se pondrá en contacto con usted para ofrecerle información adicional. Si se demuestra el comportamiento abusivo de uno de nuestros clientes, le informaremos y haremos todo lo necesario para que los responsables pongan fin a este comportamiento lo antes posible. + +/// + +/// details | OVHcloud me ha enviado un mensaje de correo electrónico en el que se indica que yo podría estar cometiendo una infracción, ¿qué debo hacer? + +Si nuestro equipo ha detectado o comprobado la existencia de un comportamiento abusivo, recibirá un mensaje de correo electrónico desde una dirección de correo electrónico con el siguiente formato: "tíquet+"número de tíquet"@abuse.ovh.net". + +Teniendo en cuenta los elementos adicionales que se le indicarán en este mensaje de correo electrónico, nuestro equipo le solicitará que realice una serie de comprobaciones para identificar y corregir el comportamiento abusivo o, en su caso, eliminar el contenido ilícito. + +Asimismo, deberá asegurarse de que sus servicios no están siendo controlados por un tercero (por ejemplo, debido a un ataque informático). Para ello, consulte nuestras guías: + +- [Proteger mi cuenta de OVHcloud y gestionar mis datos personales](/pages/account_and_service_management/account_information/all_about_username) +- [Cambiar la contraseña de su cuenta](/pages/account_and_service_management/account_information/manage-ovh-password) +- [Proteger su cuenta de OVHcloud con la doble autenticación](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa) +- [¿Cómo proteger su sitio web?](/pages/web_cloud/web_hosting/secure_your_website) +- [Proteger un VPS](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps) +- [Proteger un servidor dedicado](/pages/bare_metal_cloud/dedicated_servers/securing-a-dedicated-server) + +/// + +/// details | En caso de identificar una posible infracción en uno de mis servicios de OVHcloud, ¿cómo puedo evitar la suspensión del servicio? + +Una vez que haya realizado las acciones necesarias, deberá responder directamente al mensaje de correo electrónico que le hemos enviado desde nuestro servicio de Abuse indicándonos qué medidas ha adoptado. +Nuestro equipo le responderá lo antes posible. + +/// + +/// details | He respondido al mensaje que me envió el equipo de Abuse de OVHcloud, pero mi servicio sigue bloqueado. ¿Qué puedo hacer? + +Puede crear un tíquet de asistencia desde su [Centro de ayuda de OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help) para solicitar información adicional sobre el tratamiento de su tíquet de Abuse. Por favor, incluya la referencia de su tíquet de Abuse para facilitar el tratamiento del tíquet de asistencia. + +/// + ## Más información +[FAQ sobre la gestión de la cuenta OVHcloud](/pages/account_and_service_management/account_information/faq-account-management) + Interactúe con nuestra [comunidad de usuarios](/links/community). \ No newline at end of file diff --git a/pages/account_and_service_management/account_information/faq-support/guide.fr-ca.md b/pages/account_and_service_management/account_information/faq-support/guide.fr-ca.md index 88beb024dc4..c9e71a3a3f6 100644 --- a/pages/account_and_service_management/account_information/faq-support/guide.fr-ca.md +++ b/pages/account_and_service_management/account_information/faq-support/guide.fr-ca.md @@ -1,20 +1,50 @@ --- title: FAQ sur le support OVHcloud excerpt: Retrouvez les questions les plus fréquemment posées sur le support OVHcloud -updated: 2025-09-12 +updated: 2025-10-30 --- @@ -98,8 +128,8 @@ Si le problème persiste, n'hésitez pas à contacter notre équipe d'assistance > > - Union européenne (UE) : > - Canada (CA) : - -Cela peut résoudre certains problèmes de connexion. +> +> Cela peut résoudre certains problèmes de connexion. /// diff --git a/pages/account_and_service_management/account_information/faq-support/guide.fr-fr.md b/pages/account_and_service_management/account_information/faq-support/guide.fr-fr.md index 57d613ea24b..88d99a9a0f0 100644 --- a/pages/account_and_service_management/account_information/faq-support/guide.fr-fr.md +++ b/pages/account_and_service_management/account_information/faq-support/guide.fr-fr.md @@ -1,20 +1,50 @@ --- title: FAQ sur le support OVHcloud excerpt: Retrouvez les questions les plus fréquemment posées sur le support OVHcloud -updated: 2025-09-12 +updated: 2025-10-30 --- @@ -98,8 +128,8 @@ Si le problème persiste, n'hésitez pas à contacter notre équipe d'assistance > > - Union européenne (UE) : > - Canada (CA) : - -Cela peut résoudre certains problèmes de connexion. +> +> Cela peut résoudre certains problèmes de connexion. /// diff --git a/pages/account_and_service_management/account_information/faq-support/guide.it-it.md b/pages/account_and_service_management/account_information/faq-support/guide.it-it.md index d105e13c108..bf42acebd42 100644 --- a/pages/account_and_service_management/account_information/faq-support/guide.it-it.md +++ b/pages/account_and_service_management/account_information/faq-support/guide.it-it.md @@ -1,20 +1,108 @@ --- title: FAQ sul supporto OVHcloud excerpt: Le domande più frequenti sul supporto OVHcloud -updated: 2025-04-28 +updated: 2025-10-30 --- -## Obiettivo + -Le domande più frequenti sul supporto OVHcloud. +## Obiettivo - +Il tuo servizio è interessato da un incidente? Hai bisogno di assistenza?
+Trova qui le domande frequenti sul supporto OVHcloud. ## FAQ -### Cosa fare se si verificano dei problemi di connessione al centro assistenza o all'interfaccia di gestione dei ticket? +### Stato dei servizi + +/// details | Penso che il mio servizio stia subendo un incidente. Dove posso verificare se c'è un incidente globale? + +Se hai rilevato un guasto sul tuo servizio e hai già confermato che è attivo/rinnovato, consulta questa pagina per verificare eventuali incidenti in corso sulle nostre infrastrutture: . + +Clicca quindi sull'infrastruttura interessata (ad esempio: `Web Cloud`{.action} per un hosting web o per una linea VoIP). + +- Gli incidenti in corso sono elencati nella sezione *Current events* (eventi correnti) in alto sulla pagina. +- Gli incidenti passati sono elencati nella sezione *Past Incidents* in fondo alla pagina. + +Clicca sull'evento corrispondente al servizio interessato per ottenere ulteriori informazioni. + +> [!success] +> +> Per le piattaforme di hosting web, puoi consultare [questa guida](/pages/web_cloud/web_hosting/how_to_know_cluster_and_filer/) per verificare il tuo cluster e il tuo filer di hosting per verificare se sono interessati da un incidente in corso o passato. + +/// + +/// details | Come ricevere via e-mail le ultime informazioni su un incidente o una manutenzione specifica? + +Se hai confermato su [questa pagina](https://www.status-ovhcloud.com/) o tramite il team di supporto che il tuo servizio è interessato da un incidente in corso e desideri ricevere aggiornamenti via e-mail, puoi iscriverti a un incidente specifico per ricevere aggiornamenti. + +Per farlo, vai alla pagina e apri l'incidente in corso interessato. + +Clicca quindi sul pulsante `Subscribe to this report`{.action}. + +Puoi anche iscriverti a una delle pagine «status» per ricevere aggiornamenti generali su diversi incidenti. + +Ad esempio, sulla pagina [Web Cloud Status](https://web-cloud.status-ovhcloud.com/), clicca su `Subscribe to updates`{.action}. + +/// + +### Contattare il supporto + +/// details | Come creare un ticket di supporto? + +Clicca su [questo link](https://help.ovhcloud.com/csm?id=csm_get_help) per creare un ticket di supporto dal centro di aiuto di OVHcloud. Accedi con le tue credenziali OVHcloud. + +Una volta autenticato, clicca su `✉ Tickets`{.action} e poi sul pulsante `Crea ticket`{.action}. Seleziona il motivo della tua richiesta e il prodotto e il servizio interessati. Specifica quindi la tua richiesta per accedere a suggerimenti personalizzati di aiuto e consigli. Se ciò non risolve la tua esigenza, clicca su `Avanti`{.action} per completare la tua richiesta e creare un ticket di supporto. Assicurati di fornire il massimo delle informazioni affinché i nostri team possano aiutarti al meglio. + +/// + + + +/// details | Cosa fare se si verificano dei problemi di connessione al centro assistenza o all'interfaccia di gestione dei ticket? Le possibili cause di questo problema possono essere: @@ -32,38 +120,91 @@ Ecco le soluzioni da provare: Se il problema persiste, contatta il nostro team di supporto per assistenza. -#### Suggerimenti +> [!success] +> +> **Suggerimenti** +> +> In caso di difficoltà di accesso allo Spazio Cliente, è possibile provare a eseguire l'accesso utilizzando uno dei gateway seguenti: +> +> - Unione europea (UE): +> - Canada (CA): +> +> Questo può risolvere alcuni problemi di connessione. +> -In caso di difficoltà di accesso allo Spazio Cliente, è possibile provare a eseguire l'accesso utilizzando uno dei gateway seguenti: +/// -- Unione europea (UE): -- Canada (CA): -Questo può risolvere alcuni problemi di connessione. - -### Cosa fare in caso di difficoltà a contattare il supporto telefonicamente? +/// details | Cosa fare in caso di difficoltà a contattare il supporto telefonicamente? Per evitare di aspettare al telefono, ti invitiamo a creare una richiesta di supporto dal [Centro assistenza OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help). Clicca sul pulsante `Creazione ticket`{.action}. Per consultare tutta la nostra documentazione (FAQ, guide, strumenti di diagnostica, ecc.), accedi al [Centro assistenza](https://help.ovhcloud.com/csm/it-documentation?id=kb_home). -### Perché il modulo per la creazione dei ticket è stato aggiornato? +/// + +/// details | Perché il modulo per la creazione dei ticket è stato aggiornato? Il nuovo form è pensato per rendere più precise e complete le informazioni fornite durante la creazione del ticket. Il sistema di domande integrato consente una classificazione adeguata delle richieste per una gestione più efficace in base a tipo di servizio, livello di criticità e assistenza necessaria. In questo modo vengono evitati lunghi scambi di email. -### Come inviare documenti e altri file al supporto OVHcloud? +/// + +/// details | Come inviare documenti e altri file al supporto OVHcloud? Potete trasmettere file nei seguenti formati (dimensioni massime: 1024 MB): bmp, cap, csv, eml, gif, jpeg, jpg, pcap, pdf, png, txt, xml, yaml, yml. Crea una richiesta di assistenza nel [Centro assistenza OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help) e allega i file. -### Dove verificare il livello di supporto attivo? +Se i tuoi file superano la dimensione massima consentita o devi condividere un formato non supportato, puoi rispondere direttamente alla copia del ticket inviata via email **all'indirizzo associato al tuo identificativo cliente** e allegare i file. Questo ci permetterà di esaminarli e rispondere alla tua richiesta in modo sicuro. -Per conoscere il livello di supporto associato all’identificativo cliente, accedi allo [Spazio Cliente OVHcloud](/links/manager) e clicca sul tuo nome in alto a destra. Il livello di supporto compare a destra della voce **Supporto**. Se non hai sottoscritto un servizio di supporto a pagamento, utilizzi di default il livello Standard. +/// -Scopri e confronta i diversi livelli di supporto disponibili [qui](/links/support). +/// details | Posso fornire in un ticket link a siti esterni, come Google Drive? + +Non possiamo accedere a link esterni come Google Drive, poiché potrebbero compromettere la sicurezza e la riservatezza delle tue informazioni. + +Se devi condividere file, puoi aggiungerli direttamente nel tuo ticket dal [centro di aiuto di OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help) nei seguenti formati (dimensione massima: 1024 MB): bmp, cap, csv, eml, gif, jpeg, jpg, pcap, pdf, png, txt, xml, yaml, yml. + +/// + +/// details | Posso aggiungere file video in un ticket? Quali sono le raccomandazioni per dimensione, formato e durata? + +Se desideri inviarci un video, tieni presente che è accettato solo il formato gif e la dimensione non deve superare i 1024 MB. Se il tuo video è in un altro formato o la sua dimensione è superiore, puoi scegliere una di queste due opzioni: + +- Rispondi via email (dall'indirizzo email associato al tuo account OVHcloud) al ticket di supporto e allega il video come allegato alla tua risposta. +- Carica il video su una piattaforma come YouTube e condividi il link del video nel ticket. + +> [!warning] +> **Attenzione!** +> Se il tuo video mostra informazioni sensibili del tuo account (ad esempio: identificativo cliente, password, indirizzo(i) IP, identificativo(i) dei servizi, ecc.), non caricare il video pubblicamente su una piattaforma come YouTube, poiché esporresti i tuoi servizi a un potenziale furto di dati. + +/// + +/// details | Come posso consultare i miei vecchi ticket di supporto? + +Clicca su [questo link](https://help.ovhcloud.com/csm?id=csm_get_help) per accedere al centro di aiuto di OVHcloud. Inserisci quindi le tue credenziali OVHcloud. + +Una volta autenticato, i tuoi ticket di supporto più recenti vengono visualizzati. Clicca sull'icona del filtro sopra l'elenco dei tuoi ticket. + +Puoi cliccare sul pulsante `Tutto cancellato`{.action} per reimpostare tutte le condizioni di filtro e consultare quindi ticket precedenti chiusi. + +> [!success] +> Una volta che tutte le condizioni di filtro sono state cancellate, clicca sulla colonna `Aggiornato`{.action} per ordinare i tuoi ticket in base alla data di aggiornamento. +> + +/// + +/// details | Ho bisogno di un esperto di contenuti/un amministratore di sistema, avete questo tipo di specialista? Dove posso contattarli? + +Se hai un problema con il tuo servizio dovuto alla gestione del contenuto e/o a una cattiva configurazione locale, puoi contattare uno dei nostri partner consigliati per ottenere un supporto aggiuntivo su argomenti non inclusi nel supporto tecnico di OVHcloud. + +Troverai l'elenco dei partner di OVHcloud su [questa pagina](/links/partner). + +/// + +### Livelli di supporto -### Perché OVHcloud ha riorganizzato il proprio supporto? +/// details | Perché OVHcloud ha riorganizzato il proprio supporto? Questa decisione ha l’obiettivo di offrire la migliore user experience ai clienti rispondendo in modo adeguato alle loro aspettative: ottenere risposte rapide e usufruire di un’elevata qualità del servizio. @@ -71,6 +212,112 @@ La nuova organizzazione propone un’offerta di assistenza più ampia e precisa, Scopri e confronta i diversi livelli di supporto disponibili [qui](/links/support). +/// + +/// details | Dove verificare il livello di supporto attivo? + +Per conoscere il livello di supporto associato all’identificativo cliente, accedi allo [Spazio Cliente OVHcloud](/links/manager) e clicca sul tuo nome in alto a destra. Il livello di supporto compare a destra della voce **Supporto**. Se non hai sottoscritto un servizio di supporto a pagamento, utilizzi di default il livello Standard. + +Scopri e confronta i diversi livelli di supporto disponibili [qui](/links/support). + +/// + +/// details | Vorrei tornare a beneficiare del livello di supporto Standard. Come posso annullare il mio livello di supporto attuale? + +Dopo la fine del periodo contrattuale iniziale di 12 mesi, puoi annullare il tuo livello di supporto Premium in qualsiasi momento, senza essere vincolato da una durata contrattuale fissa. + +In questo caso, abbiamo bisogno di una conferma scritta per gestire l'annullamento. + +Per effettuare questa annullamento, contatta il nostro team di supporto creando un [ticket di assistenza tramite il centro di aiuto di OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help). + +> [!warning] +> **Importante:** +> +> - Il supporto Premium è sottoscritto su base di un contratto di 12 mesi e i clienti non possono annullare il servizio durante la durata del contratto. +> - L'unica eccezione è il diritto di recesso dopo l'acquisto, che è soggetto a determinate condizioni: +> - L'annullamento deve essere richiesto entro 14 giorni dalla data d'acquisto. +> - Il servizio deve essere stato acquistato come cliente individuale. + +Contatta [il nostro team di supporto](https://help.ovhcloud.com/csm?id=csm_get_help) per ulteriori informazioni. + +/// + +/// details | Avete tutorial video? + +Aggiungiamo sempre più tutorial al nostro canale YouTube: . + +Non esitare a utilizzare il motore di ricerca su questa pagina per trovare video su un tema specifico (ad esempio: «creare un sito web»). + +/// + +### Segnalare un'attività abusiva/illecita o una pirateria + +/// details | Cosa fare se l’account OVHcloud è vittima di hacking? + +In caso di utilizzo fraudolento dell’account OVHcloud (identità, metodo di pagamento...), ti suggeriamo di rivolgerti il prima possibile alle autorità competenti. In Italia il reparto specializzato preposto al contrasto delle frodi postali e del crimine informatico è quello della Polizia Postale. Le segnalazioni per reati telematici possono essere inviate direttamente tramite il loro sito Web, dalla pagina . + +Sarà poi questo stesso dipartimento a contattarci per svolgere le opportune verifiche e accertamenti tecnici. Con l’avvio di questa procedura, l’identificativo cliente verrà bloccato e i servizi attivati in maniera fraudolenta sospesi. + +Contatta il supporto OVHcloud per telefono: + +- Italia: +39 02 5560 0423 + +Per ripristinare la corretta operatività dell’account cliente, potremmo chiederti di modificare l’indirizzo email associato e la relativa password tramite la procedura disponibile a questo [link](https://www.ovh.it/cgi-bin/it/procedure/procedureChangeEmail.cgi). + +/// + +/// details | Ho ricevuto una possibile email di phishing che utilizza l’identità di OVHcloud: come segnalarla per effettuare una verifica? + +Per identificare e segnalare un'email o un SMS di phishing, consulta la nostra [guida dedicata](/pages/account_and_service_management/account_information/phishing_care). + +/// + +/// details | Come segnalare un comportamento fraudolento o contenuti illeciti provenienti da servizi ospitati da OVHcloud di cui sono vittima? + +Tutti i comportamenti fraudolenti e contenuti illeciti possono essere segnalati sulla piattaforma OVHcloud dedicata [www.ovh.com/abuse/](https://www.ovh.com/abuse/), selezionando la categoria nella lista e completando i campi richiesti. + +Ricordiamo che al titolare del servizio segnalato possono essere trasmessi esclusivamente i log e gli elementi tecnici, pertanto è inutile riportare in questi campi dati personali. + +/// + +/// details | Una volta inviata, cosa ne sarà della segnalazione di abuso? + +La segnalazione verrà presa in carico nel più breve tempo possibile dall’ufficio legale di OVHcloud, che procederà ad analizzata e, se necessario, richiederà ulteriori precisazioni e dettagli. Se il comportamento abusivo di uno dei nostri clienti viene accertato, provvederemo ad informarti e faremo tutto il necessario per contattare le persone interessate e risolvere il problema quanto prima. + +/// + +/// details | OVHcloud mi ha inviato un'email per comunicare un possibile comportamento fraudolento da parte mia: cosa fare? + +Se i nostri team hanno ricevuto una segnalazione o constatato un comportamento fraudolento, riceverai un’email proveniente da un account con formato di tipo "ticket+"numero di ticket"@abuse.ovh.net". + +Tenuto conto degli elementi aggiuntivi indicati nell'email, ti chiederemo di effettuare un'indagine per correggere il comportamento fraudolento e/o eliminare qualsiasi contenuto illecito. + +Per assicurarti che i servizi utilizzati non si trovino sotto il controllo di terzi (ad esempio in caso di hacking), consigliamo di verificarne il livello di sicurezza: + +- [Rendere sicuro il tuo account OVHcloud e gestire i tuoi dati personali](/pages/account_and_service_management/account_information/all_about_username) +- [Impostare e gestire la password di un account OVHcloud](/pages/account_and_service_management/account_information/manage-ovh-password) +- [Rendere sicuro il tuo account OVHcloud con la doppia autenticazione](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa) +- [Come proteggere il tuo sito Web?](/pages/web_cloud/web_hosting/secure_your_website) +- [Mettere in sicurezza un VPS](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps) +- [Mettere in sicurezza un server dedicato](/pages/bare_metal_cloud/dedicated_servers/securing-a-dedicated-server) + +/// + +/// details | In caso di identificazione di un eventuale abuso su uno dei miei servizi OVHcloud, come evitarne la sospensione? + +Una volta effettuate le operazioni necessarie, rispondi direttamente all'email ricevuta dal nostro servizio Abuse, precisando le misure adottate. +Un membro del nostro team risponderà il prima possibile. + +/// + +/// details | Ho risposto all’email di Abuse di OVHcloud ma il servizio è sempre bloccato: cosa fare? + +Dallo Spazio Cliente è possibile inviare una richiesta di assistenza al servizio [Help Center di OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help) per ottenere maggiori informazioni sullo stato del ticket da parte del team Abuse. Per semplificare la gestione della richiesta, ricorda di riportare il numero di riferimento del ticket. + +/// + ## Per saperne di più +[FAQ gestione account OVHcloud](/pages/account_and_service_management/account_information/faq-account-management) + Contatta la nostra [Community di utenti](/links/community). \ No newline at end of file diff --git a/pages/account_and_service_management/account_information/faq-support/guide.pl-pl.md b/pages/account_and_service_management/account_information/faq-support/guide.pl-pl.md index 0dfc6720920..cccb0bd9b50 100644 --- a/pages/account_and_service_management/account_information/faq-support/guide.pl-pl.md +++ b/pages/account_and_service_management/account_information/faq-support/guide.pl-pl.md @@ -1,20 +1,108 @@ --- title: FAQ dotyczący pomocy OVHcloud excerpt: Najczęściej zadawane pytania znajdziesz w pomocy OVHcloud -updated: 2025-04-28 +updated: 2025-10-30 --- -## Wprowadzenie + -Najczęściej zadawane pytania znajdziesz w pomocy OVHcloud. +## Wprowadzenie - +Czy Twój serwis jest objęty incydentem? Czy potrzebujesz pomocy?
+Znajdź tu najczęściej zadawane pytania dotyczące wsparcia OVHcloud. ## FAQ -## Co zrobić w sytuacji, gdy mam problem z zalogowaniem się do centrum pomocy lub do interfejsu zarządzania zgłoszeniami? +### Status usług + +/// details | Myślę, że mój serwis jest objęty incydentem. Gdzie mogę sprawdzić, czy występuje globalny incydent? + +Jeśli zauważysz awarię na swoim serwisie i potwierdziłeś, że jest aktywny/odnowiony, sprawdź tę stronę, aby zweryfikować ewentualne bieżące incydenty na naszych infrastrukturach: . + +Kliknij wtedy na infrastrukturę, która jest objęta (np. `Web Cloud`{.action} dla hostingu webowego lub linii VoIP). + +- Bieżące incydenty są wymienione w sekcji *Current events* (bieżące wydarzenia) na górze strony. +- Przeszłe incydenty są wymienione w sekcji *Past Incidents* na dole strony. + +Kliknij w wydarzenie odpowiadające serwisowi, który jest objęty, aby uzyskać więcej informacji. + +> [!success] +> +> Dla platform hostingu webowego możesz skorzystać z [tego przewodnika](/pages/web_cloud/web_hosting/how_to_know_cluster_and_filer/), aby sprawdzić swój klaster i filer hostingu, aby upewnić się, czy są objęte bieżącym lub przeszłym incydentem. + +/// + +/// details | Jak otrzymywać przez e-mail najnowsze informacje na temat konkretnego incydentu lub konserwacji? + +Jeśli potwierdziłeś na [tej stronie](https://www.status-ovhcloud.com/) lub za pośrednictwem zespołu wsparcia, że Twój serwis jest objęty bieżącym incydentem i chcesz otrzymywać aktualizacje przez e-mail, możesz subskrybować konkretny incydent, aby otrzymywać aktualizacje. + +Aby to zrobić, wejdź na stronę i otwórz bieżący incydent, który Cię dotyczy. + +Kliknij wtedy przycisk `Subscribe to this report`{.action}. + +Możesz również subskrybować jedną z stron „status”, aby otrzymywać ogólne aktualizacje dotyczące różnych incydentów. + +Na przykład na stronie [Web Cloud Status](https://web-cloud.status-ovhcloud.com/), kliknij `Subscribe to updates`{.action}. + +/// + +### Skontaktuj się z wsparciem + +/// details | Jak utworzyć zgłoszenie wsparcia? + +Kliknij [ten link](https://help.ovhcloud.com/csm?id=csm_get_help), aby utworzyć zgłoszenie wsparcia z poziomu centrum pomocy OVHcloud. Zaloguj się następnie swoimi danymi OVHcloud. + +Po zalogowaniu kliknij `✉ Zgłoszenia`{.action}, a następnie przycisk `Utwórz zgłoszenie`{.action}. Wybierz powód swojego zapytania oraz produkt i usługę, które są dotknięte. Następnie szczegółowo opisz swoje zapytanie, aby uzyskać spersonalizowane wskazówki i porady. Jeśli to nie rozwiąże Twojego problemu, kliknij `Dalej`{.action}, aby uzupełnić swoje zgłoszenie i utworzyć zgłoszenie wsparcia. Upewnij się, że podasz jak najwięcej informacji, aby nasze zespoły mogły Ci pomóc jak najlepiej. + +/// + + + +/// details | Co zrobić w sytuacji, gdy mam problem z zalogowaniem się do centrum pomocy lub do interfejsu zarządzania zgłoszeniami? Możliwe przyczyny tego problemu: @@ -32,38 +120,89 @@ Oto rozwiązania, których należy wypróbować: Jeśli problem będzie się powtarzać, skontaktuj się z naszym zespołem pomocy technicznej, aby uzyskać dalszą pomoc. -### Wskazówki i porady - -Jeśli masz trudności z zalogowaniem się do Panelu klienta, możesz również spróbować zalogować się przy użyciu jednej z dwóch następujących bramek: +> [!success] +> +> **Wskazówki i porady** +> +>Jeśli masz trudności z zalogowaniem się do Panelu klienta, możesz również spróbować zalogować się przy użyciu jednej z dwóch następujących bramek: +> +> - Unia Europejska (UE): +> - Kanada (CA): +> +> Może to rozwiązać niektóre problemy z połączeniem. -- Unia Europejska (UE): -- Kanada (CA): +/// -Może to rozwiązać niektóre problemy z połączeniem. - -### Co zrobić, kiedy nie mogę połączyć się z działem wsparcia klienta przez telefon? +/// details | Co zrobić, kiedy nie mogę połączyć się z działem wsparcia klienta przez telefon? Aby nie przedłużać oczekiwania na pomoc przez telefon, prosimy o utworzenie zgłoszenia w [Centrum pomocy OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help). Kliknij przycisk `Utwórz zgłoszenie`{.action}. Możesz również zapoznać się z całością naszej dokumentacji (FAQ, przewodniki, narzędzia do diagnostyki, ...) dostępnej w [Centrum Pomocy](https://help.ovhcloud.com/csm/pl-documentation?id=kb_home). -### Dlaczego formularz otwierania zgłoszenia został zmieniony? +/// + +/// details | Dlaczego formularz otwierania zgłoszenia został zmieniony? Dzięki systemowi pytań, na jakich opiera się nowy formularz, procedura otwierania zgłoszenia będzie bardziej kompletna i precyzyjna. Formularz pozwoli na sprawniejszą ocenę Twojego zapytania, w zależności od rodzaju usługi, Twojego zapotrzebowania na wsparcie oraz poziomu krytyczności. Dzięki temu ograniczamy do niezbędnego minimum wymianę pytań i odpowiedzi pomiędzy Tobą, a naszymi zespołami. -### Jak mogę wysyłać dokumenty i inne pliki do pomocy OVHcloud? +/// + +/// details | Jak mogę wysyłać dokumenty i inne pliki do pomocy OVHcloud? Pliki można przesyłać w następujących formatach (maksymalny rozmiar: 1024 MB): bmp, cap, csv, eml, gif, jpeg, jpg, pcap, pdf, png, txt, xml, yaml, yml. Utwórz zgłoszenie w [Centrum pomocy OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help) i dołącz pliki. -### Gdzie znajdę informację o przysługującym mi poziomie wsparcia klienta? +Jeśli Twoje pliki przekraczają maksymalny dozwolony rozmiar lub musisz udostępnić nieobsługiwany format, możesz odpowiedzieć bezpośrednio na kopię zgłoszenia wysłaną e-mailem **na adres przypisany do Twojej identyfikacji klienta** i dołączyć pliki. Pozwoli to nam je przeanalizować i bezpiecznie odpowiedzieć na Twoje żądanie. -Aby poznać poziom wsparcia powiązany z Twoim identyfikatorem klienta, zaloguj się do Twojego [Panelu klienta OVHcloud](/links/manager), a następnie kliknij Twoją nazwę użytkownika w prawym górnym rogu. Po prawej stronie wzmianki znajduje się poziom wsparcia **Dział Wsparcia Klienta**. Jeśli nie została przez Ciebie wykupiona płatna usługa wsparcia, możesz korzystać z domyślnej usługi wsparcia na poziomie Standard. +/// -Sprawdź i porównaj różne poziomy wsparcia dostępne [tutaj](/links/support). +/// details | Czy mogę podać w zgłoszeniu linki do zewnętrznych stron, takich jak Google Drive? + +Nie możemy uzyskiwać dostępu do zewnętrznych linków, takich jak Google Drive, ponieważ mogłoby to zagrozić bezpieczeństwu i poufności Twoich danych. + +Jeśli musisz udostępnić pliki, możesz je bezpośrednio dodać do swojego zgłoszenia z poziomu [centrum pomocy OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help) w poniższych formatach (maksymalny rozmiar: 1024 MB): bmp, cap, csv, eml, gif, jpeg, jpg, pcap, pdf, png, txt, xml, yaml, yml. + +/// + +/// details | Czy mogę dodać pliki wideo do zgłoszenia? Jakie są rekomendacje dotyczące rozmiaru, formatu i czasu trwania? + +Jeśli chcesz przesłać nam wideo, pamiętaj, że akceptowany jest tylko format gif, a rozmiar nie może przekraczać 1024 MB. Jeśli Twoje wideo jest w innym formacie lub jego rozmiar jest większy, możesz wybrać jedną z poniższych opcji: + +- Odpowiedz e-mailem (z adresu e-mail przypisanego do Twojego konta OVHcloud) na zgłoszenie wsparcia i dołącz wideo jako załącznik do swojej odpowiedzi. +- Prześlij wideo na platformę taką jak YouTube i udostępnij link do wideo w zgłoszeniu. + +> [!warning] +> **Uwaga!** +> Jeśli Twoje wideo przedstawia wrażliwe informacje o Twoim koncie (np. identyfikator klienta, hasło, adres(y) IP, identyfikator(y) usług itp.), nie udostępniaj wideo publicznie na platformie takiej jak YouTube, ponieważ może to wystawić Twoje usługi na potencjalne kradzieże danych. + +/// -### Dlaczego OVHcloud zmieniła sposób funkcjonowania wsparcia klienta? +/// details | Jak mogę sprawdzić moje stare zgłoszenia wsparcia? + +Kliknij [ten link](https://help.ovhcloud.com/csm?id=csm_get_help), aby zalogować się do centrum pomocy OVHcloud. Wprowadź następnie swoje dane logowania do OVHcloud. + +Po zalogowaniu Twoje najnowsze zgłoszenia wsparcia zostaną wyświetlone. Kliknij ikonę filtra nad listą swoich zgłoszeń. + +Możesz kliknąć przycisk `Wyczyść wszystko`{.action}, aby zresetować wszystkie warunki filtrowania i sprawdzić starsze zgłoszenia zamknięte. + +> [!success] +> Po usunięciu wszystkich warunków filtrowania kliknij kolumnę `Zaktualizowane`{.action}, aby posortować swoje zgłoszenia według daty aktualizacji. +> + +/// + +/// details | Potrzebuję eksperta ds. treści/administratora systemu, czy macie tego typu specjalistę? Gdzie mogę się z nim skontaktować? + +Jeśli masz problem z Twoim usługą spowodowany zarządzaniem treścią i/lub złym lokalnym ustawieniem, możesz skontaktować się z jednym z naszych rekomendowanych partnerów, aby uzyskać dodatkową pomoc w sprawach spoza wsparcia technicznego OVHcloud. + +Znajdziesz listę partnerów OVHcloud na [tej stronie](/links/partner). + +/// + +### Poziomy wsparcia + +/// details | Dlaczego OVHcloud zmieniła sposób funkcjonowania wsparcia klienta? Decyzja o zmianie systemu została podjęta przez OVHcloud, aby zapewnić jeszcze wyższy poziom satysfakcji klienta i sprawić, żeby doświadczenia podczas korzystania z usług wsparcia odpowiadały Twoim oczekiwaniom. Oznacza to możliwość szybkiego uzyskania odpowiedzi na Twoje pytania i dostęp do usługi o jeszcze wyższej jakości. @@ -71,6 +210,115 @@ Dzięki temu OVHcloud może zaoferować bardziej rozbudowaną, spersonalizowaną Sprawdź i porównaj różne poziomy wsparcia dostępne [tutaj](/links/support). +/// + +/// details | Gdzie znajdę informację o przysługującym mi poziomie wsparcia klienta? + +Aby poznać poziom wsparcia powiązany z Twoim identyfikatorem klienta, zaloguj się do Twojego [Panelu klienta OVHcloud](/links/manager), a następnie kliknij Twoją nazwę użytkownika w prawym górnym rogu. Po prawej stronie wzmianki znajduje się poziom wsparcia **Dział Wsparcia Klienta**. Jeśli nie została przez Ciebie wykupiona płatna usługa wsparcia, możesz korzystać z domyślnej usługi wsparcia na poziomie Standard. + +Sprawdź i porównaj różne poziomy wsparcia dostępne [tutaj](/links/support). + +/// + +/// details | Chcę ponownie skorzystać z poziomu wsparcia Standard. Jak mogę anulować obecny poziom wsparcia? + +Po zakończeniu początkowego okresu umownego 12 miesięcy możesz anulować swój poziom wsparcia Premium w dowolnym momencie, bez wiązania się z ustaloną długością umowy. + +W tym przypadku potrzebujemy pisemnej potwierdzenia, aby przetworzyć anulowanie. + +Aby dokonać tego anulowania, skontaktuj się z naszym zespołem wsparcia, tworząc [zgłoszenie wsparcia za pośrednictwem centrum pomocy OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help). + +> [!warning] +> **Ważne:** +> +> - Wsparcie Premium jest zawierane na podstawie umowy na 12 miesięcy, a klienci nie mogą anulować usługi w trakcie trwania umowy. +> - Jedyne wyjątki to prawo odstąpienia od umowy po zakupie, które podlega określonym warunkom: +> - Anulowanie musi zostać złożone w ciągu 14 dni od daty zakupu. +> - Usługa musiała zostać zakupiona jako klient indywidualny. + +Skontaktuj się z [naszym zespołem wsparcia](https://help.ovhcloud.com/csm?id=csm_get_help), aby uzyskać więcej informacji. + +/// + +/// details | Czy macie tutoriale wideo? + +Dodajemy coraz więcej tutoriali do naszego kanału YouTube: . + +Nie wahaj się skorzystać z wyszukiwarki na tej stronie, aby znaleźć wideo na konkretne tematy (np. „stworzenie strony internetowej”). + +/// + + +### Zgłoś nadużycie/nadużycie lub włamanie + +/// details | Co zrobić w sytuacji, gdy moje konto OVHcloud zostało zhakowane? + +W przypadku nielegalnego wykorzystania Twojego konta OVHcloud (tożsamość, środek płatności...), należy jak najszybciej złożyć wstępne zgłoszenie o wystąpieniu naruszenia do odpowiednich organów policji. + +Po otrzymaniu zawiadomienia organy policji skontaktują się z Tobą, aby umówić się na spotkanie i dokończyć procedurę. Zaraz po otrzymaniu dokumentu potwierdzającego złożenie przez Ciebie skargi, należy przesłać nam jego kopię. Tym samym będziemy mogli rozpocząć odpowiednie działania wewnętrzne. + +Twój identyfikator klienta zostanie zablokowany. Wszelkie usługi wykupione nielegalnie zostaną automatycznie usunięte, a płatności za nie zwrócone. + +Skontaktuj się z pomocą OVHcloud telefonicznie: + +- Polska: 71 750 02 00 + +Abyś mogła/mógł ponownie korzystać z Twojego konta klienta, poprosimy Cię ewentualnie o zmianę Twojego adresu e-mail i/lub Twojego hasła po kliknięciu tego linku: [www.ovh.pl/cgi-bin/pl/procedure/procedureChangeEmail.cgi](https://www.ovh.pl/cgi-bin/pl/procedure/procedureChangeEmail.cgi). + +/// + +/// details | Otrzymałem e-mail, który wygląda na phishing i kradzież tożsamości OVHcloud. Jak zgłosić tę wiadomość do weryfikacji? + +Wyjaśnienie, jak rozpoznać i zgłosić atak phising przeprowadzony przy użyciu wiadomości e-mail lub SMS, znajdziesz w [przewodniku](/pages/account_and_service_management/account_information/phishing_care). + +/// + +/// details | W jaki sposób zgłosić nadużycie lub treści niezgodne z prawem wykryte na usługach hostowanych przez OVHcloud? + +Nadużycia lub treści niezgodne z prawem należy zgłaszać na przeznaczonej do tego celu platformie OVHcloud [www.ovh.com/abuse/](https://www.ovh.com/abuse/). Wybierz odpowiednią kategorię i uzupełnij wymagane pola. + +Tylko logi i dane techniczne mogą zostać przekazane właścicielowi usługi, której dotyczy nadużycie. Wypełniając pola, nie należy zatem podawać żadnych danych osobowych. + +/// + +/// details | Po zgłoszeniu nadużycia, co się stanie z moją zgłoszeniem? + +Twoja zgłoszenie zostanie przetworzone jak najszybciej przez dział prawny OVHcloud. Twoja skarga zostanie przeanalizowana, a na podstawie tego skontaktujemy się z Tobą z dodatkowymi informacjami. Jeśli nadużywanie przez jednego z naszych klientów zostanie potwierdzone, poinformujemy Cię i zrobimy wszystko, co konieczne, by jak najszybciej zakończyć to u osób odpowiedzialnych. + +/// + +/// details | Firma OVHcloud przesłała mi wiadomość e-mail informującą o potencjalnym nadużyciu z mojej strony. Co powinienem w takiej sytuacji zrobić? + +Jeśli nadużycie zostało nam zgłoszone lub zauważone przez nasze zespoły, otrzymasz wiadomość e-mail wysłaną z adresu o formacie: "ticket+"numer-zgłoszenia"@abuse.ovh.net". + +Poprosimy Cię o przeanalizowanie działań uznanych jako nadużycie oraz podjęcie odpowiednich kroków w celu ich zaprzestania i/lub usunięcie wszelkich treści niezgodnych z prawem. + +Aby upewnić się, czy osoby trzecie nie przejęły kontroli nad Twoimi usługami (np. w wyniku włamania), zalecamy, abyś sprawdził, czy Twoje usługi są odpowiednio zabezpieczone: + +- [Zabezpieczenie konta OVHcloud i zarządzanie danymi osobowymi](/pages/account_and_service_management/account_information/all_about_username) +- [Zmiana hasła do konta](/pages/account_and_service_management/account_information/manage-ovh-password) +- [Zabezpieczenie konta OVHcloud za pomocą weryfikacji dwuetapowej](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa) +- [Jak zabezpieczyć stronę WWW?](/pages/web_cloud/web_hosting/secure_your_website) +- [Zabezpieczenie serwera VPS](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps) +- [Zabezpieczenie serwera dedykowanego](/pages/bare_metal_cloud/dedicated_servers/securing-a-dedicated-server) + +/// + +/// details | W jaki sposób mogę uniknąć zawieszenia usługi w przypadku wykrycia nadużycia na jednej z moich usług OVHcloud? + +Po przeprowadzeniu niezbędnych działań odpowiedz na wiadomość e-mail wysłaną przez dział Abuse i poinformuj o podjętych krokach. +Pracownik naszego zespołu odpowie na Twoją wiadomość w najkrótszym możliwym terminie. + +/// + +/// details | Wysłałem wiadomość do działu Abuse OVHcloud, ale moja usługa jest nadal zablokowana. Co mogę zrobić? + +W [Centrum pomocy OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help) możesz zwrócić się do Biura Obsługi Klienta o udzielenie dodatkowych informacji dotyczących przetwarzania Twojego zgłoszenia Abuse. Aby usprawnić obsługę Twojego zapytania, podaj numer zgłoszenia Abuse. + +/// + ## Sprawdź również +[FAQ dotyczący zarządzania kontem OVHcloud](/pages/account_and_service_management/account_information/faq-account-management) + Dołącz do [grona naszych użytkowników](/links/community). \ No newline at end of file diff --git a/pages/account_and_service_management/account_information/faq-support/guide.pt-pt.md b/pages/account_and_service_management/account_information/faq-support/guide.pt-pt.md index b9e654d7c9c..65b94283e3d 100644 --- a/pages/account_and_service_management/account_information/faq-support/guide.pt-pt.md +++ b/pages/account_and_service_management/account_information/faq-support/guide.pt-pt.md @@ -1,20 +1,108 @@ --- title: FAQ sobre o suporte da OVHcloud excerpt: Encontre as questões mais frequentes sobre o suporte da OVHcloud -updated: 2025-04-28 +updated: 2025-10-30 --- -## Objetivo + -Encontre as questões mais frequentes sobre o suporte da OVHcloud. +## Objetivo - +Seu serviço está sofrendo um incidente? Você precisa de assistência?
+Encontre aqui as perguntas mais frequentes sobre o suporte OVHcloud. -## FAQ +## Perguntas frequentes -### O que devo fazer se tiver problemas em aceder à Central de Ajuda ou à interface de gestão dos tickets? +### Status dos serviços + +/// details | Acredito que meu serviço está sofrendo um incidente. Onde posso verificar se há um incidente global? + +Se você identificar uma falha no seu serviço e já confirmou que está ativo/renovado, consulte esta página para verificar possíveis incidentes em andamento nas nossas infraestruturas: . + +Clique então na infraestrutura afetada (por exemplo: `Web Cloud`{.action} para um serviço de hospedagem web ou uma linha VoIP). + +- Incidentes em andamento são listados na seção *Current events* (eventos atuais) no topo da página. +- Incidentes passados são listados na seção *Past Incidents* no final da página. + +Clique no evento correspondente ao serviço afetado para obter mais informações. + +> [!success] +> +> Para plataformas de hospedagem web, você pode consultar [este guia](/pages/web_cloud/web_hosting/how_to_know_cluster_and_filer/) para verificar seu cluster e seu filer de hospedagem para verificar se estão afetados por um incidente em andamento ou passado. + +/// + +/// details | Como receber por e-mail as últimas informações sobre um incidente ou manutenção específica? + +Se você confirmou em [esta página](https://www.status-ovhcloud.com/) ou via equipe de suporte que seu serviço está afetado por um incidente em andamento e deseja receber atualizações por e-mail, você pode se inscrever em um incidente específico para receber atualizações. + +Para isso, acesse a página e abra o incidente em andamento relevante. + +Clique então no botão `Subscribe to this report`{.action}. + +Você também pode se inscrever em uma das páginas «status» para receber atualizações gerais sobre diversos incidentes. + +Por exemplo, na página [Web Cloud Status](https://web-cloud.status-ovhcloud.com/), clique em `Subscribe to updates`{.action}. + +/// + +### Contatar o suporte + +/// details | Como criar um ticket de suporte? + +Clique [nesta ligação](https://help.ovhcloud.com/csm?id=csm_get_help) para criar um ticket de suporte a partir do centro de ajuda OVHcloud. Faça login com as suas credenciais OVHcloud. + +Depois de autenticado, clique em `✉ Tickets`{.action} e, em seguida, no botão `Criar ticket`{.action}. Selecione o motivo da sua solicitação e o produto e serviço afetados. Indique depois a sua solicitação para aceder a sugestões personalizadas de ajuda e conselhos. Se isso não resolver a sua necessidade, clique em `Seguinte`{.action} para completar a sua solicitação e criar um ticket de suporte. Certifique-se de fornecer o máximo de informações possível para que as nossas equipas possam ajudá-lo ao máximo. + +/// + + + +/// details | O que devo fazer se tiver problemas em aceder à Central de Ajuda ou à interface de gestão dos tickets? As possíveis causas para este problema podem ser as seguintes: @@ -32,38 +120,89 @@ Aqui estão as soluções a tentar: Se o problema persistir, não hesite em contactar a nossa equipa de suporte para obter assistência. -#### Truques e dicas +> [!success] +> +> **Truques e dicas** +> +> Se tiver problemas em aceder à Área de Cliente, pode tentar aceder utilizando uma das seguintes gateways: +> +> - União Europeia (UE): +> - Canadá (CA): +> +> Este procedimento pode resolver alguns problemas de ligação. -Se tiver problemas em aceder à Área de Cliente, pode tentar aceder utilizando uma das seguintes gateways: +/// -- União Europeia (UE): -- Canadá (CA): - -Este procedimento pode resolver alguns problemas de ligação. - -### O que devo fazer se não conseguir contactar o Apoio ao Cliente por telefone? +/// details | O que devo fazer se não conseguir contactar o Apoio ao Cliente por telefone? Para evitar esperar ao telefone, convidamo-lo a criar um pedido de suporte a partir do [Centro de Ajuda da OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help). Clique no botão `Criação de ticket`{.action}. Pode igualmente consultar o conjunto da nossa documentação (FAQ, guias, ferramentas de diagnóstico, etc.) no [Centro de Ajuda](https://help.ovhcloud.com/csm/pt-documentation?id=kb_home). -### A que se deve a mudança do formulário de criação de tickets? +/// + +/// details | A que se deve a mudança do formulário de criação de tickets? O novo formulário tem por objetivo tornar o processo de criação de tickets mais completo e preciso, graças a um sistema de perguntas. Este sistema permite uma melhor qualificação das solicitações em função do tipo de serviço, da necessidade de assistência e do nível de gravidade. Assim, agiliza a comunicação entre os clientes e as nossas equipas. -### Como posso enviar documentos e outros ficheiros para o suporte da OVHcloud? +/// + +/// details | Como posso enviar documentos e outros ficheiros para o suporte da OVHcloud? Pode transmitir ficheiros nos seguintes formatos (tamanho máximo: 1024 MB): bmp, cap, csv, eml, gif, jpeg, jpg, pcap, pdf, png, txt, xml, yaml, yml. Crie um pedido de assistência no [Centro de Ajuda OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help) e anexe os seus ficheiros. -### Onde posso encontrar o nível de suporte que tenho? +Se os seus ficheiros ultrapassarem o tamanho máximo permitido ou se precisar partilhar um formato não suportado, pode responder diretamente à cópia do ticket enviada por e-mail **para o endereço associado ao seu identificador de cliente** e anexar os ficheiros. Isto permitirá que os analisemos e respondamos à sua solicitação com segurança. -Para conhecer o nível de suporte associado ao seu identificador de cliente, aceda à [Área de Cliente OVHcloud](/links/manager) e clique no seu nome no canto superior direito. O nível de suporte aparece à direita de **Apoio ao Cliente**. Se não tiver adquirido um serviço de suporte pago, terá acesso ao nível Standard por predefinição. +/// -Descubra e compare os diferentes níveis de suporte disponíveis [aqui](/links/support). +/// details | Posso fornecer em um ticket links para sites externos, como Google Drive? + +Não podemos aceder a links externos como Google Drive, pois poderia comprometer a segurança e a confidencialidade das suas informações. + +Se precisar partilhar ficheiros, pode adicioná-los diretamente no seu ticket a partir do [centro de ajuda OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help) nos seguintes formatos (tamanho máximo: 1024 MB): bmp, cap, csv, eml, gif, jpeg, jpg, pcap, pdf, png, txt, xml, yaml, yml. + +/// + +/// details | Posso adicionar ficheiros de vídeo a um ticket? Quais são as recomendações de tamanho, formato e duração? + +Se quiser enviar-nos um vídeo, saiba que apenas o formato gif é aceite e o tamanho não deve exceder 1024 MB. Se o seu vídeo estiver num outro formato ou o seu tamanho for superior, pode optar por uma destas duas opções: + +- Responda por e-mail (a partir do endereço de e-mail associado à sua conta OVHcloud) ao ticket de suporte e adicione o vídeo como anexo à sua resposta. +- Carregue o vídeo numa plataforma como YouTube e partilhe o link do vídeo no ticket. + +> [!warning] +> **Atenção!** +> Se o seu vídeo mostrar informações sensíveis da sua conta (por exemplo: identificador de cliente, palavra-passe, endereço(s) IP, identificador(es) de serviços, etc.), não carregue o vídeo publicamente numa plataforma como YouTube, pois exporia os seus serviços a um potencial roubo de dados. + +/// + +/// details | Como posso consultar os meus tickets de suporte antigos? + +Clique [nesta ligação](https://help.ovhcloud.com/csm?id=csm_get_help) para aceder ao centro de ajuda OVHcloud. Introduza depois as suas credenciais OVHcloud. + +Depois de autenticado, os seus tickets de suporte mais recentes são apresentados. Clique no ícone de filtro acima da lista dos seus tickets. + +Pode então clicar no botão `Limpar tudo`{.action} para redefinir todas as condições de filtro e consultar tickets antigos fechados. + +> [!success] +> Depois de todas as condições de filtro serem limpas, clique na coluna `Atualizado`{.action} para ordenar os seus tickets por data de atualização. +> + +/// + +/// details | Preciso de um especialista em conteúdo/um administrador de sistema, têm este tipo de especialista? Onde posso contactá-los? + +Se tiver um problema com o seu serviço devido à gestão de conteúdo e/ou a uma má configuração local, pode contactar um dos nossos parceiros recomendados para obter assistência adicional sobre temas fora do suporte técnico da OVHcloud. + +Encontre a lista de parceiros da OVHcloud [nesta página](/links/partner). + +/// + +### Níveis de suporte -### Porque é que a OVHcloud alterou o seu apoio ao cliente? +/// details | Porque é que a OVHcloud alterou o seu apoio ao cliente? A OVHcloud tomou essa decisão para melhorar a experiência oferecida. Esta última deve adequar-se às expectativas dos clientes. Isso significa fornecer respostas rápidas às diferentes solicitações e proporcionar uma melhor qualidade de serviço. @@ -71,6 +210,114 @@ A OVHcloud passa a oferecer uma oferta de suporte mais ampla e precisa. Adaptamo Descubra e compare os diferentes níveis de suporte disponíveis [aqui](/links/support). +/// + +/// details | Onde posso encontrar o nível de suporte que tenho? + +Para conhecer o nível de suporte associado ao seu identificador de cliente, aceda à [Área de Cliente OVHcloud](/links/manager) e clique no seu nome no canto superior direito. O nível de suporte aparece à direita de **Apoio ao Cliente**. Se não tiver adquirido um serviço de suporte pago, terá acesso ao nível Standard por predefinição. + +Descubra e compare os diferentes níveis de suporte disponíveis [aqui](/links/support). + +/// + +/// details | Quero voltar a beneficiar do nível de suporte Standard. Como posso cancelar o meu nível de suporte atual? + +Após o fim do período contratual inicial de 12 meses, pode cancelar o seu nível de suporte Premium a qualquer momento, sem estar vinculado a uma duração contratual fixa. + +Neste caso, necessitamos de uma confirmação escrita para processar o cancelamento. + +Para efetuar este cancelamento, contacte a nossa equipa de suporte criando um [ticket de assistência através do centro de ajuda OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help). + +> [!warning] +> **Importante:** +> +> - O suporte Premium é subscrito com base num contrato de 12 meses e os clientes não podem cancelar o serviço durante a duração do contrato. +> - A única exceção é o direito de retração após a compra, que está sujeito a certas condições: +> - O cancelamento deve ser solicitado no prazo de 14 dias a contar da data da compra. +> - O serviço deve ter sido adquirido como cliente individual. + +Contacte [a nossa equipa de suporte](https://help.ovhcloud.com/csm?id=csm_get_help) para obter mais informações. + +/// + +/// details | Têm tutoriais em vídeo? + +Adicionamos cada vez mais tutoriais ao nosso canal do YouTube: . + +Não hesite em utilizar o motor de pesquisa nesta página para encontrar vídeos sobre um tema específico (por exemplo: «criar um site web»). + +/// + +### Denunciar uma atividade abusiva/ilícita ou pirataria + +/// details | O que fazer se a minha conta OVHcloud foi pirateada? + +Em caso de uso fraudulento da sua conta OVHcloud (identidade, método de pagamento...), convidamo-lo a apresentar queixa, o mais rapidamente possível, junto dos serviços policiais. + +Quando estiver na posse da queixa formal, deverá enviar-nos uma cópia. Esse documento permitirá que se dê início a um processo interno. + +Contacte o suporte da OVHcloud por telefone: + +- Portugal: +351 213 155 642 + +O seu nome de utilizador será bloqueado. Os serviços subscritos de forma fraudulenta serão suprimidos e reembolsados automaticamente. + +Por fim, de modo a recuperar o controlo da sua conta de cliente, poderemos pedir-lhe que altere o seu endereço de e-mail e/ou a sua palavra-passe através desta [ligação](https://www.ovh.pt/cgi-bin/pt/procedure/procedureChangeEmail.cgi). + +/// + +/// details | Recebi um e-mail que parece ser phishing a usurpar a identidade da OVHcloud. Como posso chamar a vossa atenção? + +Para sinalizar um e-mail ou uma SMS de phishing, consulte o nosso [guia dedicado](/pages/account_and_service_management/account_information/phishing_care). + +/// + +/// details | Como assinalar um comportamento abusivo ou um conteúdo ilícito proveniente de serviços alojados pela OVHcloud e do qual sou vítima? + +Pode assinalar qualquer comportamento abusivo ou conteúdo ilícito na plataforma OVHcloud dedicada a este efeito [www.ovh.com/abuse/](https://www.ovh.com/abuse/). Selecione a categoria em causa e introduza os campos solicitados. + +Só os logs e os elementos técnicos podem ser transmitidos ao titular do serviço incriminado. Por favor, não inclua dados pessoais nestes campos. + +/// + +/// details | Após a declaração de um abuso, o que acontece à minha queixa? + +A sua queixa será tratada o mais rapidamente possível pelo Serviço Jurídico da OVHcloud. A sua queixa será analisada e, em função disso, comunicar-lhe-emos mais pormenores. Após comprovação do comportamento abusivo de um dos nossos clientes, informá-lo-emos e faremos o necessário junto da(s) pessoa(s) em causa para resolver a situação o quanto antes. + +/// + +/// details | A OVHcloud enviou-me um e-mail a comunicar um eventual comportamento abusivo da minha parte. O que devo fazer? + +Se nos foi comunicado (ou se as nossas equipas verificaram) um comportamento abusivo, receberá um e-mail proveniente de um endereço de e-mail no formato "ticket+"número-de-ticket"@abuse.ovh.net". + +Tendo em conta os elementos complementares que lhe serão indicados nesse e-mail, solicitamos-lhe que proceda a uma investigação a fim de remediar o comportamento abusivo e/ou de eliminar qualquer conteúdo ilícito. + +Para garantir que os seus serviços não estão sob o controlo de terceiros (por exemplo, na sequência de pirataria), recomendamos que verifique a respetiva segurança: + +- [Proteger a minha conta OVHcloud e gerir as minhas informações pessoais](/pages/account_and_service_management/account_information/all_about_username) +- [Alterar a palavra-passe da sua conta](/pages/account_and_service_management/account_information/manage-ovh-password) +- [Proteger a sua conta OVHcloud com a dupla autenticação](/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa) +- [Como proteger o seu website?](/pages/web_cloud/web_hosting/secure_your_website) +- [Proteger um VPS](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps) +- [Proteger um servidor dedicado](/pages/bare_metal_cloud/dedicated_servers/securing-a-dedicated-server) + +/// + +/// details | Em caso de identificação de um eventual abuso por parte de um dos meus serviços, como evitar uma suspensão? + +Depois de realizar as ações necessárias, responda diretamente ao e-mail que lhe foi enviado pelo nosso serviço Abuse, especificando as medidas que tomou. +Um membro da nossa equipa irá responder-lhe o mais rapidamente possível. + +/// + +/// details | Respondi ao e-mail de Abuse da OVHcloud, mas o meu serviço continua bloqueado. O que posso fazer? + +A partir da [Centro de ajuda da OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help), pode abrir um pedido de assistência junto do Serviço de Clientes da OVHcloud, de modo a obter informações complementares sobre o tratamento do seu ticket Abuse. Para facilitar o tratamento do seu pedido, queira mencionar no pedido de assistência a referência do ticket Abuse. + +/// + ## Quer saber mais? +[FAQ sobre la gestión de la cuenta OVHcloud](/pages/account_and_service_management/account_information/faq-account-management) + Fale com nossa [comunidade de utilizadores](/links/community). \ No newline at end of file diff --git a/pages/account_and_service_management/account_information/faq-support/meta.yaml b/pages/account_and_service_management/account_information/faq-support/meta.yaml index 047e81ab048..8c12d76f8d0 100644 --- a/pages/account_and_service_management/account_information/faq-support/meta.yaml +++ b/pages/account_and_service_management/account_information/faq-support/meta.yaml @@ -1,4 +1,4 @@ -id : 464bc7b1-3c2a-428a-9d67-5e4e38b91203 +id: 464bc7b1-3c2a-428a-9d67-5e4e38b91203 full_slug: faq-support reference_category: account-and-service-management-account-information-faq translation_banner: true \ No newline at end of file diff --git a/pages/account_and_service_management/account_information/iam-policies-api/guide.de-de.md b/pages/account_and_service_management/account_information/iam-policies-api/guide.de-de.md index c367fb2243a..0ca4f3ca0ac 100644 --- a/pages/account_and_service_management/account_information/iam-policies-api/guide.de-de.md +++ b/pages/account_and_service_management/account_information/iam-policies-api/guide.de-de.md @@ -1,7 +1,7 @@ --- title: Verwendung von IAM-Richtlinien mit der OVHcloud API (EN) excerpt: "Find out how to give specific access rights to users from an OVHcloud account" -updated: 2025-09-08 +updated: 2025-10-10 --- ## Objective @@ -103,7 +103,7 @@ Items in policies are defined by URNs. These URNs are defined by the following p |**VPS Example**|urn|:|v1|:|ca|:|resource|:|vps|:|vps-5b48d78b.vps.ovh.net| |**Resource Group Example**|urn|:|v1|:|us|:|resourceGroup|||:|aa0713ab-ed13-4f1a-89a5-32aa0cb936d8| -The URNs and actions can end with a `*` wildcard character. This allows referring to multiple resources, identities or actions in a single line. +The resources URNs and actions can end with a `*` wildcard character. This allows referring to multiple resources or actions in a single line. *Example of a resource URN with a wildcard :* diff --git a/pages/account_and_service_management/account_information/iam-policies-api/guide.en-asia.md b/pages/account_and_service_management/account_information/iam-policies-api/guide.en-asia.md index 0833cc2bd9a..1a3d39cbd69 100644 --- a/pages/account_and_service_management/account_information/iam-policies-api/guide.en-asia.md +++ b/pages/account_and_service_management/account_information/iam-policies-api/guide.en-asia.md @@ -1,7 +1,7 @@ --- title: How to use IAM policies using the OVHcloud API excerpt: "Find out how to give specific access rights to users from an OVHcloud account" -updated: 2025-09-08 +updated: 2025-10-10 --- ## Objective @@ -103,7 +103,7 @@ Items in policies are defined by URNs. These URNs are defined by the following p |**VPS Example**|urn|:|v1|:|ca|:|resource|:|vps|:|vps-5b48d78b.vps.ovh.net| |**Resource Group Example**|urn|:|v1|:|us|:|resourceGroup|||:|aa0713ab-ed13-4f1a-89a5-32aa0cb936d8| -The URNs and actions can end with a `*` wildcard character. This allows referring to multiple resources, identities or actions in a single line. +The resources URNs and actions can end with a `*` wildcard character. This allows referring to multiple resources or actions in a single line. *Example of a resource URN with a wildcard :* diff --git a/pages/account_and_service_management/account_information/iam-policies-api/guide.en-au.md b/pages/account_and_service_management/account_information/iam-policies-api/guide.en-au.md index 0833cc2bd9a..1a3d39cbd69 100644 --- a/pages/account_and_service_management/account_information/iam-policies-api/guide.en-au.md +++ b/pages/account_and_service_management/account_information/iam-policies-api/guide.en-au.md @@ -1,7 +1,7 @@ --- title: How to use IAM policies using the OVHcloud API excerpt: "Find out how to give specific access rights to users from an OVHcloud account" -updated: 2025-09-08 +updated: 2025-10-10 --- ## Objective @@ -103,7 +103,7 @@ Items in policies are defined by URNs. These URNs are defined by the following p |**VPS Example**|urn|:|v1|:|ca|:|resource|:|vps|:|vps-5b48d78b.vps.ovh.net| |**Resource Group Example**|urn|:|v1|:|us|:|resourceGroup|||:|aa0713ab-ed13-4f1a-89a5-32aa0cb936d8| -The URNs and actions can end with a `*` wildcard character. This allows referring to multiple resources, identities or actions in a single line. +The resources URNs and actions can end with a `*` wildcard character. This allows referring to multiple resources or actions in a single line. *Example of a resource URN with a wildcard :* diff --git a/pages/account_and_service_management/account_information/iam-policies-api/guide.en-ca.md b/pages/account_and_service_management/account_information/iam-policies-api/guide.en-ca.md index 0833cc2bd9a..1a3d39cbd69 100644 --- a/pages/account_and_service_management/account_information/iam-policies-api/guide.en-ca.md +++ b/pages/account_and_service_management/account_information/iam-policies-api/guide.en-ca.md @@ -1,7 +1,7 @@ --- title: How to use IAM policies using the OVHcloud API excerpt: "Find out how to give specific access rights to users from an OVHcloud account" -updated: 2025-09-08 +updated: 2025-10-10 --- ## Objective @@ -103,7 +103,7 @@ Items in policies are defined by URNs. These URNs are defined by the following p |**VPS Example**|urn|:|v1|:|ca|:|resource|:|vps|:|vps-5b48d78b.vps.ovh.net| |**Resource Group Example**|urn|:|v1|:|us|:|resourceGroup|||:|aa0713ab-ed13-4f1a-89a5-32aa0cb936d8| -The URNs and actions can end with a `*` wildcard character. This allows referring to multiple resources, identities or actions in a single line. +The resources URNs and actions can end with a `*` wildcard character. This allows referring to multiple resources or actions in a single line. *Example of a resource URN with a wildcard :* diff --git a/pages/account_and_service_management/account_information/iam-policies-api/guide.en-gb.md b/pages/account_and_service_management/account_information/iam-policies-api/guide.en-gb.md index 0833cc2bd9a..1a3d39cbd69 100644 --- a/pages/account_and_service_management/account_information/iam-policies-api/guide.en-gb.md +++ b/pages/account_and_service_management/account_information/iam-policies-api/guide.en-gb.md @@ -1,7 +1,7 @@ --- title: How to use IAM policies using the OVHcloud API excerpt: "Find out how to give specific access rights to users from an OVHcloud account" -updated: 2025-09-08 +updated: 2025-10-10 --- ## Objective @@ -103,7 +103,7 @@ Items in policies are defined by URNs. These URNs are defined by the following p |**VPS Example**|urn|:|v1|:|ca|:|resource|:|vps|:|vps-5b48d78b.vps.ovh.net| |**Resource Group Example**|urn|:|v1|:|us|:|resourceGroup|||:|aa0713ab-ed13-4f1a-89a5-32aa0cb936d8| -The URNs and actions can end with a `*` wildcard character. This allows referring to multiple resources, identities or actions in a single line. +The resources URNs and actions can end with a `*` wildcard character. This allows referring to multiple resources or actions in a single line. *Example of a resource URN with a wildcard :* diff --git a/pages/account_and_service_management/account_information/iam-policies-api/guide.en-ie.md b/pages/account_and_service_management/account_information/iam-policies-api/guide.en-ie.md index 0833cc2bd9a..1a3d39cbd69 100644 --- a/pages/account_and_service_management/account_information/iam-policies-api/guide.en-ie.md +++ b/pages/account_and_service_management/account_information/iam-policies-api/guide.en-ie.md @@ -1,7 +1,7 @@ --- title: How to use IAM policies using the OVHcloud API excerpt: "Find out how to give specific access rights to users from an OVHcloud account" -updated: 2025-09-08 +updated: 2025-10-10 --- ## Objective @@ -103,7 +103,7 @@ Items in policies are defined by URNs. These URNs are defined by the following p |**VPS Example**|urn|:|v1|:|ca|:|resource|:|vps|:|vps-5b48d78b.vps.ovh.net| |**Resource Group Example**|urn|:|v1|:|us|:|resourceGroup|||:|aa0713ab-ed13-4f1a-89a5-32aa0cb936d8| -The URNs and actions can end with a `*` wildcard character. This allows referring to multiple resources, identities or actions in a single line. +The resources URNs and actions can end with a `*` wildcard character. This allows referring to multiple resources or actions in a single line. *Example of a resource URN with a wildcard :* diff --git a/pages/account_and_service_management/account_information/iam-policies-api/guide.en-sg.md b/pages/account_and_service_management/account_information/iam-policies-api/guide.en-sg.md index 0833cc2bd9a..1a3d39cbd69 100644 --- a/pages/account_and_service_management/account_information/iam-policies-api/guide.en-sg.md +++ b/pages/account_and_service_management/account_information/iam-policies-api/guide.en-sg.md @@ -1,7 +1,7 @@ --- title: How to use IAM policies using the OVHcloud API excerpt: "Find out how to give specific access rights to users from an OVHcloud account" -updated: 2025-09-08 +updated: 2025-10-10 --- ## Objective @@ -103,7 +103,7 @@ Items in policies are defined by URNs. These URNs are defined by the following p |**VPS Example**|urn|:|v1|:|ca|:|resource|:|vps|:|vps-5b48d78b.vps.ovh.net| |**Resource Group Example**|urn|:|v1|:|us|:|resourceGroup|||:|aa0713ab-ed13-4f1a-89a5-32aa0cb936d8| -The URNs and actions can end with a `*` wildcard character. This allows referring to multiple resources, identities or actions in a single line. +The resources URNs and actions can end with a `*` wildcard character. This allows referring to multiple resources or actions in a single line. *Example of a resource URN with a wildcard :* diff --git a/pages/account_and_service_management/account_information/iam-policies-api/guide.en-us.md b/pages/account_and_service_management/account_information/iam-policies-api/guide.en-us.md index 0833cc2bd9a..1a3d39cbd69 100644 --- a/pages/account_and_service_management/account_information/iam-policies-api/guide.en-us.md +++ b/pages/account_and_service_management/account_information/iam-policies-api/guide.en-us.md @@ -1,7 +1,7 @@ --- title: How to use IAM policies using the OVHcloud API excerpt: "Find out how to give specific access rights to users from an OVHcloud account" -updated: 2025-09-08 +updated: 2025-10-10 --- ## Objective @@ -103,7 +103,7 @@ Items in policies are defined by URNs. These URNs are defined by the following p |**VPS Example**|urn|:|v1|:|ca|:|resource|:|vps|:|vps-5b48d78b.vps.ovh.net| |**Resource Group Example**|urn|:|v1|:|us|:|resourceGroup|||:|aa0713ab-ed13-4f1a-89a5-32aa0cb936d8| -The URNs and actions can end with a `*` wildcard character. This allows referring to multiple resources, identities or actions in a single line. +The resources URNs and actions can end with a `*` wildcard character. This allows referring to multiple resources or actions in a single line. *Example of a resource URN with a wildcard :* diff --git a/pages/account_and_service_management/account_information/iam-policies-api/guide.es-es.md b/pages/account_and_service_management/account_information/iam-policies-api/guide.es-es.md index 6dcd050990e..dfd4899534b 100644 --- a/pages/account_and_service_management/account_information/iam-policies-api/guide.es-es.md +++ b/pages/account_and_service_management/account_information/iam-policies-api/guide.es-es.md @@ -1,7 +1,7 @@ --- title: "Cómo utilizar las políticas de IAM con la API de OVHcloud (EN)" excerpt: "Find out how to give specific access rights to users from an OVHcloud account" -updated: 2025-09-08 +updated: 2025-10-10 --- ## Objective @@ -103,7 +103,7 @@ Items in policies are defined by URNs. These URNs are defined by the following p |**VPS Example**|urn|:|v1|:|ca|:|resource|:|vps|:|vps-5b48d78b.vps.ovh.net| |**Resource Group Example**|urn|:|v1|:|us|:|resourceGroup|||:|aa0713ab-ed13-4f1a-89a5-32aa0cb936d8| -The URNs and actions can end with a `*` wildcard character. This allows referring to multiple resources, identities or actions in a single line. +The resources URNs and actions can end with a `*` wildcard character. This allows referring to multiple resources or actions in a single line. *Example of a resource URN with a wildcard :* diff --git a/pages/account_and_service_management/account_information/iam-policies-api/guide.es-us.md b/pages/account_and_service_management/account_information/iam-policies-api/guide.es-us.md index 6dcd050990e..dfd4899534b 100644 --- a/pages/account_and_service_management/account_information/iam-policies-api/guide.es-us.md +++ b/pages/account_and_service_management/account_information/iam-policies-api/guide.es-us.md @@ -1,7 +1,7 @@ --- title: "Cómo utilizar las políticas de IAM con la API de OVHcloud (EN)" excerpt: "Find out how to give specific access rights to users from an OVHcloud account" -updated: 2025-09-08 +updated: 2025-10-10 --- ## Objective @@ -103,7 +103,7 @@ Items in policies are defined by URNs. These URNs are defined by the following p |**VPS Example**|urn|:|v1|:|ca|:|resource|:|vps|:|vps-5b48d78b.vps.ovh.net| |**Resource Group Example**|urn|:|v1|:|us|:|resourceGroup|||:|aa0713ab-ed13-4f1a-89a5-32aa0cb936d8| -The URNs and actions can end with a `*` wildcard character. This allows referring to multiple resources, identities or actions in a single line. +The resources URNs and actions can end with a `*` wildcard character. This allows referring to multiple resources or actions in a single line. *Example of a resource URN with a wildcard :* diff --git a/pages/account_and_service_management/account_information/iam-policies-api/guide.fr-ca.md b/pages/account_and_service_management/account_information/iam-policies-api/guide.fr-ca.md index ccecbaa28ad..a192347f9c7 100644 --- a/pages/account_and_service_management/account_information/iam-policies-api/guide.fr-ca.md +++ b/pages/account_and_service_management/account_information/iam-policies-api/guide.fr-ca.md @@ -1,7 +1,7 @@ --- title: "Comment utiliser les politiques IAM via l’API OVHcloud" excerpt: "Découvrez comment donner des droits d'accès spécifiques aux utilisateurs d'un compte OVHcloud" -updated: 2025-09-08 +updated: 2025-10-10 --- ## Objectif @@ -104,7 +104,7 @@ Les éléments des politiques sont définis par des URNs. Ces URNs sont définie | **VPS Exemple** | urn | : | v1 | : | ca | : | resource | : | vps | : | vps-5b48d78b.vps.ovh.net | | **Resource Group Exemple** | urn | : | v1 | : | us | : | resourceGroup | | | : | aa0713ab-ed13-4f1a-89a5-32aa0cb936d8 | -Les actions et les URNs peuvent finir par un caractère *wildcard* `*`. Cela permet de faire référence à plusieurs resources ou identités en une seule ligne. +Les actions et les URNs de ressources peuvent finir par un caractère *wildcard* `*`. Cela permet de faire référence à plusieurs resources ou actions en une seule ligne. *Exemple d'une URN avec un wildcard :* @@ -735,4 +735,4 @@ Voici une partie du résultat: ## Aller plus loin -Échangez avec notre [communauté d'utilisateurs](/links/community). +Échangez avec notre [communauté d'utilisateurs](/links/community). \ No newline at end of file diff --git a/pages/account_and_service_management/account_information/iam-policies-api/guide.fr-fr.md b/pages/account_and_service_management/account_information/iam-policies-api/guide.fr-fr.md index a0e639fe1cc..a192347f9c7 100644 --- a/pages/account_and_service_management/account_information/iam-policies-api/guide.fr-fr.md +++ b/pages/account_and_service_management/account_information/iam-policies-api/guide.fr-fr.md @@ -1,7 +1,7 @@ --- title: "Comment utiliser les politiques IAM via l’API OVHcloud" excerpt: "Découvrez comment donner des droits d'accès spécifiques aux utilisateurs d'un compte OVHcloud" -updated: 2025-09-08 +updated: 2025-10-10 --- ## Objectif @@ -104,7 +104,7 @@ Les éléments des politiques sont définis par des URNs. Ces URNs sont définie | **VPS Exemple** | urn | : | v1 | : | ca | : | resource | : | vps | : | vps-5b48d78b.vps.ovh.net | | **Resource Group Exemple** | urn | : | v1 | : | us | : | resourceGroup | | | : | aa0713ab-ed13-4f1a-89a5-32aa0cb936d8 | -Les actions et les URNs peuvent finir par un caractère *wildcard* `*`. Cela permet de faire référence à plusieurs resources ou identités en une seule ligne. +Les actions et les URNs de ressources peuvent finir par un caractère *wildcard* `*`. Cela permet de faire référence à plusieurs resources ou actions en une seule ligne. *Exemple d'une URN avec un wildcard :* diff --git a/pages/account_and_service_management/account_information/iam-policies-api/guide.it-it.md b/pages/account_and_service_management/account_information/iam-policies-api/guide.it-it.md index 10da30c98e4..6445850860b 100644 --- a/pages/account_and_service_management/account_information/iam-policies-api/guide.it-it.md +++ b/pages/account_and_service_management/account_information/iam-policies-api/guide.it-it.md @@ -1,7 +1,7 @@ --- title: "Come utilizzare le policy di IAM utilizzando l’API OVHcloud (EN)" excerpt: "Find out how to give specific access rights to users from an OVHcloud account" -updated: 2025-09-08 +updated: 2025-10-10 --- ## Objective @@ -103,7 +103,7 @@ Items in policies are defined by URNs. These URNs are defined by the following p |**VPS Example**|urn|:|v1|:|ca|:|resource|:|vps|:|vps-5b48d78b.vps.ovh.net| |**Resource Group Example**|urn|:|v1|:|us|:|resourceGroup|||:|aa0713ab-ed13-4f1a-89a5-32aa0cb936d8| -The URNs and actions can end with a `*` wildcard character. This allows referring to multiple resources, identities or actions in a single line. +The resources URNs and actions can end with a `*` wildcard character. This allows referring to multiple resources or actions in a single line. *Example of a resource URN with a wildcard :* diff --git a/pages/account_and_service_management/account_information/iam-policies-api/guide.pl-pl.md b/pages/account_and_service_management/account_information/iam-policies-api/guide.pl-pl.md index 506119595a7..add9fe5fd40 100644 --- a/pages/account_and_service_management/account_information/iam-policies-api/guide.pl-pl.md +++ b/pages/account_and_service_management/account_information/iam-policies-api/guide.pl-pl.md @@ -1,7 +1,7 @@ --- title: "Jak korzystać z zasad IAM przy użyciu interfejsu API OVHcloud (EN)" excerpt: "Find out how to give specific access rights to users from an OVHcloud account" -updated: 2025-09-08 +updated: 2025-10-10 --- ## Objective @@ -103,7 +103,7 @@ Items in policies are defined by URNs. These URNs are defined by the following p |**VPS Example**|urn|:|v1|:|ca|:|resource|:|vps|:|vps-5b48d78b.vps.ovh.net| |**Resource Group Example**|urn|:|v1|:|us|:|resourceGroup|||:|aa0713ab-ed13-4f1a-89a5-32aa0cb936d8| -The URNs and actions can end with a `*` wildcard character. This allows referring to multiple resources, identities or actions in a single line. +The resources URNs and actions can end with a `*` wildcard character. This allows referring to multiple resources or actions in a single line. *Example of a resource URN with a wildcard :* diff --git a/pages/account_and_service_management/account_information/iam-policies-api/guide.pt-pt.md b/pages/account_and_service_management/account_information/iam-policies-api/guide.pt-pt.md index 748ef265534..6e95e6fcd40 100644 --- a/pages/account_and_service_management/account_information/iam-policies-api/guide.pt-pt.md +++ b/pages/account_and_service_management/account_information/iam-policies-api/guide.pt-pt.md @@ -1,7 +1,7 @@ --- title: "Utilização das políticas IAM com a API OVHcloud (EN)" excerpt: "Find out how to give specific access rights to users from an OVHcloud account" -updated: 2025-09-08 +updated: 2025-10-10 --- ## Objective @@ -103,7 +103,7 @@ Items in policies are defined by URNs. These URNs are defined by the following p |**VPS Example**|urn|:|v1|:|ca|:|resource|:|vps|:|vps-5b48d78b.vps.ovh.net| |**Resource Group Example**|urn|:|v1|:|us|:|resourceGroup|||:|aa0713ab-ed13-4f1a-89a5-32aa0cb936d8| -The URNs and actions can end with a `*` wildcard character. This allows referring to multiple resources, identities or actions in a single line. +The resources URNs and actions can end with a `*` wildcard character. This allows referring to multiple resources or actions in a single line. *Example of a resource URN with a wildcard :* diff --git a/pages/account_and_service_management/account_information/iam-policy-ui/guide.de-de.md b/pages/account_and_service_management/account_information/iam-policy-ui/guide.de-de.md index 33811307b77..f261e08cb21 100644 --- a/pages/account_and_service_management/account_information/iam-policy-ui/guide.de-de.md +++ b/pages/account_and_service_management/account_information/iam-policy-ui/guide.de-de.md @@ -1,7 +1,7 @@ --- title: Verwendung von IAM-Richtlinie über Ihr Kundencenter excerpt: Erfahren Sie hier, wie Sie Benutzern im OVHcloud Kunden-Account spezifische Zugriffsrechte gewähren -updated: 2025-08-27 +updated: 2025-10-27 --- ## Ziel @@ -77,15 +77,15 @@ Das folgende Formular wird angezeigt: - **Ressourcen**: Fügen Sie Ressourcen oder Ressourcengruppen hinzu, die durch die Richtlinie abgedeckt werden sollen. Die verfügbaren Ressourcen werden nach dem zuvor ausgewählten Produkttyp gefiltert. - **Aktionen**. -Es gibt drei Möglichkeiten, Aktionen hinzuzufügen: +**Es gibt vier Möglichkeiten, Aktionen hinzuzufügen:** -- Aktivieren der Option `Alle Aktionen zulassen`{.action} +##### 1 - Option „Alle Aktionen zulassen” aktivieren ![Richtlinie erstellen](images/create_a_policy_02.png){.thumbnail} Wenn Sie diese Option aktivieren, lassen Sie alle Aktionen zu, die sich auf die ausgewählten Produkte beziehen. Dies schließt alle bestehenden und in Zukunft hinzugefügten Aktionen für diese Produktkategorien ein. -- Auswählen einer verwalteten Berechtigungsgruppe +##### 2 - Auswählen einer verwalteten Berechtigungsgruppe Wir stellen Berechtigungsgruppen zur Verfügung, die von OVHcloud vorkonfiguriert und verwaltet werden. Sie können eine oder mehrere Gruppen aus der verfügbaren Liste auswählen. @@ -96,7 +96,7 @@ Details zum Inhalt verwalteter Berechtigungsgruppen finden Sie in der zugehörig Verwaltete Aktionsgruppen können als Ergänzung zu Komponentenaktionen verwendet werden. -- Manuelles Hinzufügen von Aktionen +##### 3 - Aktionen manuell hinzufügen Wenn Sie den Namen der Aktion kennen, können Sie sie manuell hinzufügen. @@ -110,7 +110,7 @@ Wenn Sie beispielsweise `vps:apiovh:ips/*` hinzufügen, geben Sie folgende Recht - **vps:apiovh:ips/delete** - **vps:apiovh:ips/get** -- Auswählen von Aktionen aus der Liste +##### 4 - Aktionen aus der Liste auswählen Aktionen können in der Liste ausgewählt werden. @@ -127,7 +127,27 @@ Die verfügbaren Aktionen hängen vom Ressourcentyp ab und gehören zu einer der Ein Suchfeld ist verfügbar, mit dem Sie eine bestimmte Aktion in der Liste identifizieren können. > [!primary] -> Aktionen im Zusammenhang mit IP- und vRack-Produkten sowie Aktionen im Zusammenhang mit der Bestellung und Abrechnung sind im IAM von OVHcloud noch nicht verfügbar. +> Aktionen im Zusammenhang mit Bestellungen und Rechnungen sind im OVHcloud IAM noch nicht verfügbar. + +#### Bedingungen für Richtlinien + +Es ist möglich, Bedingungen an IAM-Richtlinien anzuhängen. + +Eine Richtlinie mit Bedingungen ist gültig, wenn alle Bedingungen validiert sind. + +Es ist möglich, Bedingungen für folgende Elemente festzulegen: + +- Tag der Ressource +- Name der Ressource +- Produkttyp +- IP-Adresse der Anfrage +- Wochentag +- Datum +- Uhrzeit + +![Richtlinie erstellen](images/conditions.png){.thumbnail} + +Nachdem sie hinzugefügt wurden, werden die Bedingungen mit der [Syntax angezeigt, die in der API verwendet wird](/pages/account_and_service_management/account_information/iam-policies-api). #### Richtlinien bearbeiten diff --git a/pages/account_and_service_management/account_information/iam-policy-ui/guide.en-asia.md b/pages/account_and_service_management/account_information/iam-policy-ui/guide.en-asia.md index 6a56b20f0d4..e1a3b037929 100644 --- a/pages/account_and_service_management/account_information/iam-policy-ui/guide.en-asia.md +++ b/pages/account_and_service_management/account_information/iam-policy-ui/guide.en-asia.md @@ -1,7 +1,7 @@ --- title: How to use IAM policies using the OVHcloud Control Panel excerpt: "Find out how to give specific access rights to users from an OVHcloud account" -updated: 2025-08-27 +updated: 2025-10-27 --- ## Objective @@ -61,8 +61,6 @@ Each policy is displayed with its name, the number of identities linked to it, a ### Managing policies - - #### Creating a policy Click the `Create a policy`{.action} button. @@ -77,15 +75,15 @@ The following form will be displayed: - **Resources**: Add resources or resource groups to be covered by the policy. The resources available are filtered by the product type selected beforehand. - **Actions**. -There are 4 different ways to add actions: +**There are 4 different ways to add actions:** -- Activating the `Authorise all actions`{.action} option +##### 1 - Activating the "Authorise all actions" option ![Create a policy](images/create_a_policy_02.png){.thumbnail} When activating this option, you allow all actions related to the selected products. This includes all existing actions as well as actions added in the future for these product types. -- Selecting a group of managed permissions +##### 2 - Selecting a group of managed permissions We provide permission groups that are preconfigured and managed by OVHcloud. You can select one or more groups by selecting them from the available list. @@ -95,7 +93,7 @@ Details of the content of the managed permission groups are available in the [as Managed action groups can be used in addition to unit actions. -- Adding actions manually +##### 3 - Adding actions manually If you know the action name, you can add it manually. @@ -109,7 +107,7 @@ For example, adding `vps:apiovh:ips/*` will grant the following rights: - **vps:apiovh:ips/delete** - **vps:apiovh:ips/get** -- Selecting actions from the list +##### 4 - Selecting actions from the list Finally, you can select actions from the list. @@ -126,7 +124,27 @@ The available actions depend on the resource type and belong to one of five cate A search field is available to help identify a specific action on the list. > [!primary] -> Actions related to IP and vRack products, as well as actions related to ordering and billing, are not yet available in the OVHcloud IAM. +> Actions related to ordering and billing are not yet available in the OVHcloud IAM. + +#### Conditions on policies + +It's possible to add conditions on IAM policies. + +A policy with conditions is valid only if all conditions are validated. + +It's possible to add conditions on these elements: + +- A resource tag +- The resource name +- The product type +- The IP of the request +- The day of the week +- The date +- The time + +![Créer une politique](images/conditions.png){.thumbnail} + +Once added, conditions are displayed with the [syntax used on API](/pages/account_and_service_management/account_information/iam-policies-api) #### Editing a policy diff --git a/pages/account_and_service_management/account_information/iam-policy-ui/guide.en-au.md b/pages/account_and_service_management/account_information/iam-policy-ui/guide.en-au.md index 6a56b20f0d4..e1a3b037929 100644 --- a/pages/account_and_service_management/account_information/iam-policy-ui/guide.en-au.md +++ b/pages/account_and_service_management/account_information/iam-policy-ui/guide.en-au.md @@ -1,7 +1,7 @@ --- title: How to use IAM policies using the OVHcloud Control Panel excerpt: "Find out how to give specific access rights to users from an OVHcloud account" -updated: 2025-08-27 +updated: 2025-10-27 --- ## Objective @@ -61,8 +61,6 @@ Each policy is displayed with its name, the number of identities linked to it, a ### Managing policies - - #### Creating a policy Click the `Create a policy`{.action} button. @@ -77,15 +75,15 @@ The following form will be displayed: - **Resources**: Add resources or resource groups to be covered by the policy. The resources available are filtered by the product type selected beforehand. - **Actions**. -There are 4 different ways to add actions: +**There are 4 different ways to add actions:** -- Activating the `Authorise all actions`{.action} option +##### 1 - Activating the "Authorise all actions" option ![Create a policy](images/create_a_policy_02.png){.thumbnail} When activating this option, you allow all actions related to the selected products. This includes all existing actions as well as actions added in the future for these product types. -- Selecting a group of managed permissions +##### 2 - Selecting a group of managed permissions We provide permission groups that are preconfigured and managed by OVHcloud. You can select one or more groups by selecting them from the available list. @@ -95,7 +93,7 @@ Details of the content of the managed permission groups are available in the [as Managed action groups can be used in addition to unit actions. -- Adding actions manually +##### 3 - Adding actions manually If you know the action name, you can add it manually. @@ -109,7 +107,7 @@ For example, adding `vps:apiovh:ips/*` will grant the following rights: - **vps:apiovh:ips/delete** - **vps:apiovh:ips/get** -- Selecting actions from the list +##### 4 - Selecting actions from the list Finally, you can select actions from the list. @@ -126,7 +124,27 @@ The available actions depend on the resource type and belong to one of five cate A search field is available to help identify a specific action on the list. > [!primary] -> Actions related to IP and vRack products, as well as actions related to ordering and billing, are not yet available in the OVHcloud IAM. +> Actions related to ordering and billing are not yet available in the OVHcloud IAM. + +#### Conditions on policies + +It's possible to add conditions on IAM policies. + +A policy with conditions is valid only if all conditions are validated. + +It's possible to add conditions on these elements: + +- A resource tag +- The resource name +- The product type +- The IP of the request +- The day of the week +- The date +- The time + +![Créer une politique](images/conditions.png){.thumbnail} + +Once added, conditions are displayed with the [syntax used on API](/pages/account_and_service_management/account_information/iam-policies-api) #### Editing a policy diff --git a/pages/account_and_service_management/account_information/iam-policy-ui/guide.en-ca.md b/pages/account_and_service_management/account_information/iam-policy-ui/guide.en-ca.md index 6a56b20f0d4..e1a3b037929 100644 --- a/pages/account_and_service_management/account_information/iam-policy-ui/guide.en-ca.md +++ b/pages/account_and_service_management/account_information/iam-policy-ui/guide.en-ca.md @@ -1,7 +1,7 @@ --- title: How to use IAM policies using the OVHcloud Control Panel excerpt: "Find out how to give specific access rights to users from an OVHcloud account" -updated: 2025-08-27 +updated: 2025-10-27 --- ## Objective @@ -61,8 +61,6 @@ Each policy is displayed with its name, the number of identities linked to it, a ### Managing policies - - #### Creating a policy Click the `Create a policy`{.action} button. @@ -77,15 +75,15 @@ The following form will be displayed: - **Resources**: Add resources or resource groups to be covered by the policy. The resources available are filtered by the product type selected beforehand. - **Actions**. -There are 4 different ways to add actions: +**There are 4 different ways to add actions:** -- Activating the `Authorise all actions`{.action} option +##### 1 - Activating the "Authorise all actions" option ![Create a policy](images/create_a_policy_02.png){.thumbnail} When activating this option, you allow all actions related to the selected products. This includes all existing actions as well as actions added in the future for these product types. -- Selecting a group of managed permissions +##### 2 - Selecting a group of managed permissions We provide permission groups that are preconfigured and managed by OVHcloud. You can select one or more groups by selecting them from the available list. @@ -95,7 +93,7 @@ Details of the content of the managed permission groups are available in the [as Managed action groups can be used in addition to unit actions. -- Adding actions manually +##### 3 - Adding actions manually If you know the action name, you can add it manually. @@ -109,7 +107,7 @@ For example, adding `vps:apiovh:ips/*` will grant the following rights: - **vps:apiovh:ips/delete** - **vps:apiovh:ips/get** -- Selecting actions from the list +##### 4 - Selecting actions from the list Finally, you can select actions from the list. @@ -126,7 +124,27 @@ The available actions depend on the resource type and belong to one of five cate A search field is available to help identify a specific action on the list. > [!primary] -> Actions related to IP and vRack products, as well as actions related to ordering and billing, are not yet available in the OVHcloud IAM. +> Actions related to ordering and billing are not yet available in the OVHcloud IAM. + +#### Conditions on policies + +It's possible to add conditions on IAM policies. + +A policy with conditions is valid only if all conditions are validated. + +It's possible to add conditions on these elements: + +- A resource tag +- The resource name +- The product type +- The IP of the request +- The day of the week +- The date +- The time + +![Créer une politique](images/conditions.png){.thumbnail} + +Once added, conditions are displayed with the [syntax used on API](/pages/account_and_service_management/account_information/iam-policies-api) #### Editing a policy diff --git a/pages/account_and_service_management/account_information/iam-policy-ui/guide.en-gb.md b/pages/account_and_service_management/account_information/iam-policy-ui/guide.en-gb.md index 6a56b20f0d4..7b8645241a4 100644 --- a/pages/account_and_service_management/account_information/iam-policy-ui/guide.en-gb.md +++ b/pages/account_and_service_management/account_information/iam-policy-ui/guide.en-gb.md @@ -1,7 +1,7 @@ --- title: How to use IAM policies using the OVHcloud Control Panel excerpt: "Find out how to give specific access rights to users from an OVHcloud account" -updated: 2025-08-27 +updated: 2025-10-27 --- ## Objective @@ -61,8 +61,6 @@ Each policy is displayed with its name, the number of identities linked to it, a ### Managing policies - - #### Creating a policy Click the `Create a policy`{.action} button. @@ -77,15 +75,15 @@ The following form will be displayed: - **Resources**: Add resources or resource groups to be covered by the policy. The resources available are filtered by the product type selected beforehand. - **Actions**. -There are 4 different ways to add actions: +**There are 4 different ways to add actions:** -- Activating the `Authorise all actions`{.action} option +##### 1 - Activating the "Authorise all actions" option ![Create a policy](images/create_a_policy_02.png){.thumbnail} When activating this option, you allow all actions related to the selected products. This includes all existing actions as well as actions added in the future for these product types. -- Selecting a group of managed permissions +##### 2 - Selecting a group of managed permissions We provide permission groups that are preconfigured and managed by OVHcloud. You can select one or more groups by selecting them from the available list. @@ -95,7 +93,7 @@ Details of the content of the managed permission groups are available in the [as Managed action groups can be used in addition to unit actions. -- Adding actions manually +##### 3 - Adding actions manually If you know the action name, you can add it manually. @@ -109,7 +107,7 @@ For example, adding `vps:apiovh:ips/*` will grant the following rights: - **vps:apiovh:ips/delete** - **vps:apiovh:ips/get** -- Selecting actions from the list +##### 4 - Selecting actions from the list Finally, you can select actions from the list. @@ -126,7 +124,27 @@ The available actions depend on the resource type and belong to one of five cate A search field is available to help identify a specific action on the list. > [!primary] -> Actions related to IP and vRack products, as well as actions related to ordering and billing, are not yet available in the OVHcloud IAM. +> Actions related to ordering and billing are not yet available in the OVHcloud IAM. + +#### Conditions on policies + +It's possible to add conditions on IAM policies. + +A policy with conditions is valid only if all conditions are validated. + +It's possible to add conditions on these elements: + +- A resource tag +- The resource name +- The product type +- The IP of the request +- The day of the week +- The date +- The time + +![Créer une politique](images/conditions.png){.thumbnail} + +Once added, conditions are displayed with the [syntax used on API](/pages/account_and_service_management/account_information/iam-policies-api) #### Editing a policy @@ -190,4 +208,4 @@ A popup window will ask you to confirm the deletion. ## Go further -Join our [community of users](/links/community). \ No newline at end of file +Join our [community of users](/links/community). diff --git a/pages/account_and_service_management/account_information/iam-policy-ui/guide.en-ie.md b/pages/account_and_service_management/account_information/iam-policy-ui/guide.en-ie.md index 6a56b20f0d4..e1a3b037929 100644 --- a/pages/account_and_service_management/account_information/iam-policy-ui/guide.en-ie.md +++ b/pages/account_and_service_management/account_information/iam-policy-ui/guide.en-ie.md @@ -1,7 +1,7 @@ --- title: How to use IAM policies using the OVHcloud Control Panel excerpt: "Find out how to give specific access rights to users from an OVHcloud account" -updated: 2025-08-27 +updated: 2025-10-27 --- ## Objective @@ -61,8 +61,6 @@ Each policy is displayed with its name, the number of identities linked to it, a ### Managing policies - - #### Creating a policy Click the `Create a policy`{.action} button. @@ -77,15 +75,15 @@ The following form will be displayed: - **Resources**: Add resources or resource groups to be covered by the policy. The resources available are filtered by the product type selected beforehand. - **Actions**. -There are 4 different ways to add actions: +**There are 4 different ways to add actions:** -- Activating the `Authorise all actions`{.action} option +##### 1 - Activating the "Authorise all actions" option ![Create a policy](images/create_a_policy_02.png){.thumbnail} When activating this option, you allow all actions related to the selected products. This includes all existing actions as well as actions added in the future for these product types. -- Selecting a group of managed permissions +##### 2 - Selecting a group of managed permissions We provide permission groups that are preconfigured and managed by OVHcloud. You can select one or more groups by selecting them from the available list. @@ -95,7 +93,7 @@ Details of the content of the managed permission groups are available in the [as Managed action groups can be used in addition to unit actions. -- Adding actions manually +##### 3 - Adding actions manually If you know the action name, you can add it manually. @@ -109,7 +107,7 @@ For example, adding `vps:apiovh:ips/*` will grant the following rights: - **vps:apiovh:ips/delete** - **vps:apiovh:ips/get** -- Selecting actions from the list +##### 4 - Selecting actions from the list Finally, you can select actions from the list. @@ -126,7 +124,27 @@ The available actions depend on the resource type and belong to one of five cate A search field is available to help identify a specific action on the list. > [!primary] -> Actions related to IP and vRack products, as well as actions related to ordering and billing, are not yet available in the OVHcloud IAM. +> Actions related to ordering and billing are not yet available in the OVHcloud IAM. + +#### Conditions on policies + +It's possible to add conditions on IAM policies. + +A policy with conditions is valid only if all conditions are validated. + +It's possible to add conditions on these elements: + +- A resource tag +- The resource name +- The product type +- The IP of the request +- The day of the week +- The date +- The time + +![Créer une politique](images/conditions.png){.thumbnail} + +Once added, conditions are displayed with the [syntax used on API](/pages/account_and_service_management/account_information/iam-policies-api) #### Editing a policy diff --git a/pages/account_and_service_management/account_information/iam-policy-ui/guide.en-sg.md b/pages/account_and_service_management/account_information/iam-policy-ui/guide.en-sg.md index 6a56b20f0d4..e1a3b037929 100644 --- a/pages/account_and_service_management/account_information/iam-policy-ui/guide.en-sg.md +++ b/pages/account_and_service_management/account_information/iam-policy-ui/guide.en-sg.md @@ -1,7 +1,7 @@ --- title: How to use IAM policies using the OVHcloud Control Panel excerpt: "Find out how to give specific access rights to users from an OVHcloud account" -updated: 2025-08-27 +updated: 2025-10-27 --- ## Objective @@ -61,8 +61,6 @@ Each policy is displayed with its name, the number of identities linked to it, a ### Managing policies - - #### Creating a policy Click the `Create a policy`{.action} button. @@ -77,15 +75,15 @@ The following form will be displayed: - **Resources**: Add resources or resource groups to be covered by the policy. The resources available are filtered by the product type selected beforehand. - **Actions**. -There are 4 different ways to add actions: +**There are 4 different ways to add actions:** -- Activating the `Authorise all actions`{.action} option +##### 1 - Activating the "Authorise all actions" option ![Create a policy](images/create_a_policy_02.png){.thumbnail} When activating this option, you allow all actions related to the selected products. This includes all existing actions as well as actions added in the future for these product types. -- Selecting a group of managed permissions +##### 2 - Selecting a group of managed permissions We provide permission groups that are preconfigured and managed by OVHcloud. You can select one or more groups by selecting them from the available list. @@ -95,7 +93,7 @@ Details of the content of the managed permission groups are available in the [as Managed action groups can be used in addition to unit actions. -- Adding actions manually +##### 3 - Adding actions manually If you know the action name, you can add it manually. @@ -109,7 +107,7 @@ For example, adding `vps:apiovh:ips/*` will grant the following rights: - **vps:apiovh:ips/delete** - **vps:apiovh:ips/get** -- Selecting actions from the list +##### 4 - Selecting actions from the list Finally, you can select actions from the list. @@ -126,7 +124,27 @@ The available actions depend on the resource type and belong to one of five cate A search field is available to help identify a specific action on the list. > [!primary] -> Actions related to IP and vRack products, as well as actions related to ordering and billing, are not yet available in the OVHcloud IAM. +> Actions related to ordering and billing are not yet available in the OVHcloud IAM. + +#### Conditions on policies + +It's possible to add conditions on IAM policies. + +A policy with conditions is valid only if all conditions are validated. + +It's possible to add conditions on these elements: + +- A resource tag +- The resource name +- The product type +- The IP of the request +- The day of the week +- The date +- The time + +![Créer une politique](images/conditions.png){.thumbnail} + +Once added, conditions are displayed with the [syntax used on API](/pages/account_and_service_management/account_information/iam-policies-api) #### Editing a policy diff --git a/pages/account_and_service_management/account_information/iam-policy-ui/guide.en-us.md b/pages/account_and_service_management/account_information/iam-policy-ui/guide.en-us.md index 6a56b20f0d4..e1a3b037929 100644 --- a/pages/account_and_service_management/account_information/iam-policy-ui/guide.en-us.md +++ b/pages/account_and_service_management/account_information/iam-policy-ui/guide.en-us.md @@ -1,7 +1,7 @@ --- title: How to use IAM policies using the OVHcloud Control Panel excerpt: "Find out how to give specific access rights to users from an OVHcloud account" -updated: 2025-08-27 +updated: 2025-10-27 --- ## Objective @@ -61,8 +61,6 @@ Each policy is displayed with its name, the number of identities linked to it, a ### Managing policies - - #### Creating a policy Click the `Create a policy`{.action} button. @@ -77,15 +75,15 @@ The following form will be displayed: - **Resources**: Add resources or resource groups to be covered by the policy. The resources available are filtered by the product type selected beforehand. - **Actions**. -There are 4 different ways to add actions: +**There are 4 different ways to add actions:** -- Activating the `Authorise all actions`{.action} option +##### 1 - Activating the "Authorise all actions" option ![Create a policy](images/create_a_policy_02.png){.thumbnail} When activating this option, you allow all actions related to the selected products. This includes all existing actions as well as actions added in the future for these product types. -- Selecting a group of managed permissions +##### 2 - Selecting a group of managed permissions We provide permission groups that are preconfigured and managed by OVHcloud. You can select one or more groups by selecting them from the available list. @@ -95,7 +93,7 @@ Details of the content of the managed permission groups are available in the [as Managed action groups can be used in addition to unit actions. -- Adding actions manually +##### 3 - Adding actions manually If you know the action name, you can add it manually. @@ -109,7 +107,7 @@ For example, adding `vps:apiovh:ips/*` will grant the following rights: - **vps:apiovh:ips/delete** - **vps:apiovh:ips/get** -- Selecting actions from the list +##### 4 - Selecting actions from the list Finally, you can select actions from the list. @@ -126,7 +124,27 @@ The available actions depend on the resource type and belong to one of five cate A search field is available to help identify a specific action on the list. > [!primary] -> Actions related to IP and vRack products, as well as actions related to ordering and billing, are not yet available in the OVHcloud IAM. +> Actions related to ordering and billing are not yet available in the OVHcloud IAM. + +#### Conditions on policies + +It's possible to add conditions on IAM policies. + +A policy with conditions is valid only if all conditions are validated. + +It's possible to add conditions on these elements: + +- A resource tag +- The resource name +- The product type +- The IP of the request +- The day of the week +- The date +- The time + +![Créer une politique](images/conditions.png){.thumbnail} + +Once added, conditions are displayed with the [syntax used on API](/pages/account_and_service_management/account_information/iam-policies-api) #### Editing a policy diff --git a/pages/account_and_service_management/account_information/iam-policy-ui/guide.es-es.md b/pages/account_and_service_management/account_information/iam-policy-ui/guide.es-es.md index eb032d9f970..94b4648749d 100644 --- a/pages/account_and_service_management/account_information/iam-policy-ui/guide.es-es.md +++ b/pages/account_and_service_management/account_information/iam-policy-ui/guide.es-es.md @@ -1,7 +1,7 @@ --- title: Cómo utilizar las políticas IAM desde el área de cliente excerpt: Cómo conceder permisos de acceso específicos a los usuarios desde una cuenta de OVHcloud -updated: 2025-08-27 +updated: 2025-10-27 --- ## Objetivo @@ -77,15 +77,15 @@ Aparecerá el siguiente formulario: - **Recursos**: añada recursos o grupos de recursos para cubrir la política. Los recursos disponibles se filtran por tipo de producto previamente seleccionado. - **Acciones**. -Hay tres maneras de agregar acciones: +**Hay 4 maneras de agregar acciones:** -- Activando la opción `Permitir todas las acciones`{.action} +##### 1 - Activar la opción "Permitir todas las acciones" ![Crear una política](images/create_a_policy_02.png){.thumbnail} Al activar esta opción, autoriza todas las acciones relacionadas con los productos seleccionados. Esto incluye todas las acciones existentes, así como las acciones que se añadan en el futuro para estas categorías de productos. -- Seleccionando un grupo de permisos administrados +##### 2 - Seleccionar un grupo de permisos administrados OVHcloud pone a su disposición grupos de permisos preconfigurados y administrados. Puede seleccionar uno o varios grupos seleccionándolos de la lista disponible. @@ -96,7 +96,7 @@ Los detalles del contenido de los grupos de permisos administrados están dispon Los grupos de acciones administradas se pueden utilizar como complemento de las acciones unitarias. -- Añadiendo manualmente acciones +##### 3 - Añadir manualmente acciones Si conoce el nombre de la acción, puede agregarla manualmente. @@ -110,7 +110,7 @@ Por ejemplo, la adición de `vps:apiovh:ips/*` concederá los siguientes permiso - **vps:apiovh:ips/delete** - **vps:apiovh:ips/get** -- Seleccionando acciones de la lista +##### 4 - Seleccionar acciones de la lista Se pueden seleccionar acciones de la lista. @@ -127,7 +127,27 @@ Las acciones disponibles dependen del tipo de recurso y pertenecen a una de las Hay un campo de búsqueda disponible para ayudarle a identificar una acción específica en la lista. > [!primary] -> Las acciones relacionadas con los productos IP y vRack, así como las acciones relacionadas con el pedido y la facturación, aún no están disponibles en el IAM de OVHcloud. +> Las acciones relacionadas con la compra y la facturación no están disponibles en el IAM de OVHcloud. + +#### Condiciones sobre las políticas + +Es posible añadir condiciones a las políticas IAM. + +Una política con condiciones es válida cuando todas las condiciones se validan. + +Es posible aplicar condiciones sobre: + +- una etiqueta del recurso; +- el nombre del recurso; +- el tipo de producto; +- la dirección IP de la solicitud; +- el día de la semana; +- la fecha; +- la hora. + +![Crear una política](images/conditions.png){.thumbnail} + +Una vez agregadas, las condiciones se muestran con la sintaxis [utilizada en la API](/pages/account_and_service_management/account_information/iam-policies-api) #### Modificar una política diff --git a/pages/account_and_service_management/account_information/iam-policy-ui/guide.es-us.md b/pages/account_and_service_management/account_information/iam-policy-ui/guide.es-us.md index eb032d9f970..94b4648749d 100644 --- a/pages/account_and_service_management/account_information/iam-policy-ui/guide.es-us.md +++ b/pages/account_and_service_management/account_information/iam-policy-ui/guide.es-us.md @@ -1,7 +1,7 @@ --- title: Cómo utilizar las políticas IAM desde el área de cliente excerpt: Cómo conceder permisos de acceso específicos a los usuarios desde una cuenta de OVHcloud -updated: 2025-08-27 +updated: 2025-10-27 --- ## Objetivo @@ -77,15 +77,15 @@ Aparecerá el siguiente formulario: - **Recursos**: añada recursos o grupos de recursos para cubrir la política. Los recursos disponibles se filtran por tipo de producto previamente seleccionado. - **Acciones**. -Hay tres maneras de agregar acciones: +**Hay 4 maneras de agregar acciones:** -- Activando la opción `Permitir todas las acciones`{.action} +##### 1 - Activar la opción "Permitir todas las acciones" ![Crear una política](images/create_a_policy_02.png){.thumbnail} Al activar esta opción, autoriza todas las acciones relacionadas con los productos seleccionados. Esto incluye todas las acciones existentes, así como las acciones que se añadan en el futuro para estas categorías de productos. -- Seleccionando un grupo de permisos administrados +##### 2 - Seleccionar un grupo de permisos administrados OVHcloud pone a su disposición grupos de permisos preconfigurados y administrados. Puede seleccionar uno o varios grupos seleccionándolos de la lista disponible. @@ -96,7 +96,7 @@ Los detalles del contenido de los grupos de permisos administrados están dispon Los grupos de acciones administradas se pueden utilizar como complemento de las acciones unitarias. -- Añadiendo manualmente acciones +##### 3 - Añadir manualmente acciones Si conoce el nombre de la acción, puede agregarla manualmente. @@ -110,7 +110,7 @@ Por ejemplo, la adición de `vps:apiovh:ips/*` concederá los siguientes permiso - **vps:apiovh:ips/delete** - **vps:apiovh:ips/get** -- Seleccionando acciones de la lista +##### 4 - Seleccionar acciones de la lista Se pueden seleccionar acciones de la lista. @@ -127,7 +127,27 @@ Las acciones disponibles dependen del tipo de recurso y pertenecen a una de las Hay un campo de búsqueda disponible para ayudarle a identificar una acción específica en la lista. > [!primary] -> Las acciones relacionadas con los productos IP y vRack, así como las acciones relacionadas con el pedido y la facturación, aún no están disponibles en el IAM de OVHcloud. +> Las acciones relacionadas con la compra y la facturación no están disponibles en el IAM de OVHcloud. + +#### Condiciones sobre las políticas + +Es posible añadir condiciones a las políticas IAM. + +Una política con condiciones es válida cuando todas las condiciones se validan. + +Es posible aplicar condiciones sobre: + +- una etiqueta del recurso; +- el nombre del recurso; +- el tipo de producto; +- la dirección IP de la solicitud; +- el día de la semana; +- la fecha; +- la hora. + +![Crear una política](images/conditions.png){.thumbnail} + +Una vez agregadas, las condiciones se muestran con la sintaxis [utilizada en la API](/pages/account_and_service_management/account_information/iam-policies-api) #### Modificar una política diff --git a/pages/account_and_service_management/account_information/iam-policy-ui/guide.fr-ca.md b/pages/account_and_service_management/account_information/iam-policy-ui/guide.fr-ca.md index 758a6d8cf56..f33c4212673 100644 --- a/pages/account_and_service_management/account_information/iam-policy-ui/guide.fr-ca.md +++ b/pages/account_and_service_management/account_information/iam-policy-ui/guide.fr-ca.md @@ -1,7 +1,7 @@ --- title: Comment utiliser les politiques IAM depuis votre espace client excerpt: "Découvrez comment donner des droits d'accès spécifiques aux utilisateurs depuis un compte OVHcloud" -updated: 2025-08-27 +updated: 2025-10-27 --- ## Objectif @@ -61,8 +61,6 @@ Chaque politique est affichée avec son nom, le nombre d'identités qui lui sont ### Gestion des politiques - - #### Créer une politique Cliquez sur le bouton `Créer une politique`{.action}. @@ -77,15 +75,15 @@ Le formulaire suivant s'affiche : - **Ressources** : ajoutez des ressources ou des groupes de ressources à couvrir par la politique. Les ressources disponibles sont filtrées par type de produit préalablement sélectionné. - **Actions**. -Il existe 4 façons d'ajouter des actions : +**Il existe 4 façons d'ajouter des actions :** -- En activant l'option `Autoriser toutes les actions`{.action} +##### 1 - Activer l'option « Autoriser toutes les actions » ![Créer une politique](images/create_a_policy_02.png){.thumbnail} Lors de l'activation de cette option, vous autorisez toutes les actions liées aux produits sélectionnés. Cela inclut toutes les actions existantes ainsi que les actions ajoutées à l'avenir pour ces catégories de produits. -- En sélectionnant un groupe de permissions managées +##### 2 - Sélectionner un groupe de permissions managées Nous mettons à disposition des groupes de permissions préconfigurées et managées par OVHcloud. Vous pouuvez sélectionner un ou plusieurs groupes en les sélectionnant parmi la liste disponible. @@ -96,7 +94,7 @@ Le détail du contenu des groupes de permissions managées est disponible dans l Il est possible d'utiliser les groupes d'actions managées en complément d'actions unitaires. -- En ajoutant manuellement des actions +##### 3 - Ajouter manuellement des actions Si vous connaissez le nom de l'action, vous pouvez l'ajouter manuellement. @@ -110,7 +108,7 @@ Par exemple, l'ajout de `vps:apiovh:ips/*` accordera les droits suivants : - **vps:apiovh:ips/delete** - **vps:apiovh:ips/get** -- En sélectionnant des actions dans la liste +##### 4 - Sélectionner des actions dans la liste Des actions peuvent être sélectionnées dans la liste. @@ -127,7 +125,27 @@ Les actions disponibles dépendent du type de ressource et appartiennent à l'un Un champ de recherche est disponible pour vous aider à identifier une action spécifique dans la liste. > [!primary] -> Les actions liées aux produits IP et vRack, ainsi que les actions liées à la commande et la facturation, ne sont pas encore disponibles dans l'IAM OVHcloud. +> Les actions liées à la commande et la facturation ne sont pas encore disponibles dans l'IAM OVHcloud. + +#### Conditions sur les politiques + +Il est possible d'ajouter des conditions sur les politiques IAM. + +Une politique avec des conditions est valide lorsque toutes les conditions sont validées. + +Il est possible d'appliquer des conditions sur : + +- un tag de la ressource ; +- le nom de la ressource ; +- le type de produit ; +- l'adresse IP de la requête ; +- le jour de la semaine ; +- la date ; +- l'heure. + +![Créer une politique](images/conditions.png){.thumbnail} + +Une fois ajoutées, les conditions sont affichées avec la syntaxe [utilisée dans l'API](/pages/account_and_service_management/account_information/iam-policies-api) #### Modifier une politique @@ -191,4 +209,4 @@ Une fenêtre contextuelle vous demandera de confirmer la suppression. ## Aller plus loin -Échangez avec notre [communauté d'utilisateurs](/links/community). \ No newline at end of file +Échangez avec notre [communauté d'utilisateurs](/links/community). diff --git a/pages/account_and_service_management/account_information/iam-policy-ui/guide.fr-fr.md b/pages/account_and_service_management/account_information/iam-policy-ui/guide.fr-fr.md index 758a6d8cf56..f33c4212673 100644 --- a/pages/account_and_service_management/account_information/iam-policy-ui/guide.fr-fr.md +++ b/pages/account_and_service_management/account_information/iam-policy-ui/guide.fr-fr.md @@ -1,7 +1,7 @@ --- title: Comment utiliser les politiques IAM depuis votre espace client excerpt: "Découvrez comment donner des droits d'accès spécifiques aux utilisateurs depuis un compte OVHcloud" -updated: 2025-08-27 +updated: 2025-10-27 --- ## Objectif @@ -61,8 +61,6 @@ Chaque politique est affichée avec son nom, le nombre d'identités qui lui sont ### Gestion des politiques - - #### Créer une politique Cliquez sur le bouton `Créer une politique`{.action}. @@ -77,15 +75,15 @@ Le formulaire suivant s'affiche : - **Ressources** : ajoutez des ressources ou des groupes de ressources à couvrir par la politique. Les ressources disponibles sont filtrées par type de produit préalablement sélectionné. - **Actions**. -Il existe 4 façons d'ajouter des actions : +**Il existe 4 façons d'ajouter des actions :** -- En activant l'option `Autoriser toutes les actions`{.action} +##### 1 - Activer l'option « Autoriser toutes les actions » ![Créer une politique](images/create_a_policy_02.png){.thumbnail} Lors de l'activation de cette option, vous autorisez toutes les actions liées aux produits sélectionnés. Cela inclut toutes les actions existantes ainsi que les actions ajoutées à l'avenir pour ces catégories de produits. -- En sélectionnant un groupe de permissions managées +##### 2 - Sélectionner un groupe de permissions managées Nous mettons à disposition des groupes de permissions préconfigurées et managées par OVHcloud. Vous pouuvez sélectionner un ou plusieurs groupes en les sélectionnant parmi la liste disponible. @@ -96,7 +94,7 @@ Le détail du contenu des groupes de permissions managées est disponible dans l Il est possible d'utiliser les groupes d'actions managées en complément d'actions unitaires. -- En ajoutant manuellement des actions +##### 3 - Ajouter manuellement des actions Si vous connaissez le nom de l'action, vous pouvez l'ajouter manuellement. @@ -110,7 +108,7 @@ Par exemple, l'ajout de `vps:apiovh:ips/*` accordera les droits suivants : - **vps:apiovh:ips/delete** - **vps:apiovh:ips/get** -- En sélectionnant des actions dans la liste +##### 4 - Sélectionner des actions dans la liste Des actions peuvent être sélectionnées dans la liste. @@ -127,7 +125,27 @@ Les actions disponibles dépendent du type de ressource et appartiennent à l'un Un champ de recherche est disponible pour vous aider à identifier une action spécifique dans la liste. > [!primary] -> Les actions liées aux produits IP et vRack, ainsi que les actions liées à la commande et la facturation, ne sont pas encore disponibles dans l'IAM OVHcloud. +> Les actions liées à la commande et la facturation ne sont pas encore disponibles dans l'IAM OVHcloud. + +#### Conditions sur les politiques + +Il est possible d'ajouter des conditions sur les politiques IAM. + +Une politique avec des conditions est valide lorsque toutes les conditions sont validées. + +Il est possible d'appliquer des conditions sur : + +- un tag de la ressource ; +- le nom de la ressource ; +- le type de produit ; +- l'adresse IP de la requête ; +- le jour de la semaine ; +- la date ; +- l'heure. + +![Créer une politique](images/conditions.png){.thumbnail} + +Une fois ajoutées, les conditions sont affichées avec la syntaxe [utilisée dans l'API](/pages/account_and_service_management/account_information/iam-policies-api) #### Modifier une politique @@ -191,4 +209,4 @@ Une fenêtre contextuelle vous demandera de confirmer la suppression. ## Aller plus loin -Échangez avec notre [communauté d'utilisateurs](/links/community). \ No newline at end of file +Échangez avec notre [communauté d'utilisateurs](/links/community). diff --git a/pages/account_and_service_management/account_information/iam-policy-ui/guide.it-it.md b/pages/account_and_service_management/account_information/iam-policy-ui/guide.it-it.md index 202b11805a4..e3735692483 100644 --- a/pages/account_and_service_management/account_information/iam-policy-ui/guide.it-it.md +++ b/pages/account_and_service_management/account_information/iam-policy-ui/guide.it-it.md @@ -1,7 +1,7 @@ --- title: Come utilizzare le politiche IAM dallo Spazio Cliente excerpt: Come assegnare diritti di accesso specifici agli utenti da un account OVHcloud -updated: 2025-08-27 +updated: 2025-10-27 --- ## Obiettivo @@ -77,15 +77,15 @@ Compare il seguente form: - **Risorse**: aggiungete risorse o gruppi di risorse che saranno coperti dalla politica. Le risorse disponibili sono filtrate per tipo di prodotto selezionato in precedenza. - **Azioni** -Esistono 3 modi per aggiungere azioni: +**Esistono 4 modi per aggiungere azioni:** -- Attivando l'opzione `Autorizza tutte le azioni`{.action} +##### 1 - Attivare l'opzione "Autorizza tutte le azioni" ![Crea una politica](images/create_a_policy_02.png){.thumbnail} Al momento dell'attivazione di questa opzione, autorizzi tutte le azioni relative ai prodotti selezionati. Ciò comprende tutte le azioni esistenti e le azioni aggiunte in futuro per queste categorie di prodotti. -- Selezionando un gruppo di permessi gestiti +##### 2 - Selezionare un gruppo di autorizzazioni gestite OVHcloud mette a disposizione gruppi di permessi preconfigurati e gestiti da OVHcloud. È possibile selezionare uno o più gruppi selezionandoli dall'elenco disponibile. @@ -96,7 +96,7 @@ I dettagli del contenuto dei gruppi di permessi gestiti sono disponibili nella [ I gruppi di azioni gestite possono essere utilizzati in aggiunta alle azioni unitarie. -- Aggiungendo manualmente azioni +##### 3 - Aggiungere manualmente delle azioni Se conosci il nome dell'azione, puoi aggiungerla manualmente. @@ -110,7 +110,7 @@ Ad esempio, l'aggiunta di `vps:apiovh:ips/*` conferirà i seguenti diritti: - **vps:apiovh:ips/delete** - **vps:apiovh:ips/get** -- Selezionando azioni nell'elenco +##### 4 - Selezionare le azioni dall'elenco Le azioni possono essere selezionate nell'elenco. @@ -127,7 +127,27 @@ Le azioni disponibili dipendono dal tipo di risorsa e appartengono ad una delle Per aiutarti a identificare un'azione specifica nella lista, è disponibile un campo di ricerca. > [!primary] -> Le azioni relative ai prodotti IP e vRack, così come le azioni relative all'ordine e alla fatturazione, non sono ancora disponibili nello IAM OVHcloud. +> Le azioni legate all'acquisto e alla fatturazione non sono ancora disponibili nell'IAM di OVHcloud. + +#### Condizioni sulle politiche + +È possibile aggiungere condizioni alle politiche IAM. + +Una politica con condizioni è valida quando tutte le condizioni sono validate. + +È possibile applicare condizioni su: + +- un tag della risorsa; +- il nome della risorsa; +- il tipo di prodotto; +- l'indirizzo IP della richiesta; +- il giorno della settimana; +- la data; +- l'ora. + +![Creare una politica](images/conditions.png){.thumbnail} + +Una volta aggiunte, le condizioni vengono visualizzate con la sintassi [utilizzata nell'API](/pages/account_and_service_management/account_information/iam-policies-api) #### Modifica una politica diff --git a/pages/account_and_service_management/account_information/iam-policy-ui/guide.pl-pl.md b/pages/account_and_service_management/account_information/iam-policy-ui/guide.pl-pl.md index 7a067d5d00e..a2e6ea65d68 100644 --- a/pages/account_and_service_management/account_information/iam-policy-ui/guide.pl-pl.md +++ b/pages/account_and_service_management/account_information/iam-policy-ui/guide.pl-pl.md @@ -1,7 +1,7 @@ --- title: Jak korzystać z polityki IAM w Panelu klienta excerpt: Dowiedz się, jak przypisać użytkownikom uprawnienia dostępu do konta OVHcloud -updated: 2025-08-27 +updated: 2025-10-27 --- ## Wprowadzenie @@ -77,15 +77,15 @@ Pojawi się następujący formularz: - **Zasoby**: dodaj zasoby lub grupy zasobów do pokrycia w ramach polityki. Dostępne zasoby są filtrowane według uprzednio wybranego typu produktu. - **Działania**. -Istnieją 3 sposoby dodawania operacji: +**Istnieją 4 sposoby dodawania operacji:** -- Po włączeniu opcji `Zezwalaj na wykonywanie wszystkich operacji`{.action} +##### 1 - Włącz opcję "Zezwalaj na wykonywanie wszystkich operacji" ![Tworzenie polityki](images/create_a_policy_02.png){.thumbnail} Podczas aktywacji tej opcji zatwierdzisz wszystkie operacje związane z wybranymi produktami. Obejmuje to wszystkie istniejące działania oraz przyszłe działania dodane do tych kategorii produktów. -- Wybierając grupę uprawnień zarządzanych +##### 2 - Wybierz grupę zarządzanych uprawnień Udostępniamy wstępnie skonfigurowane grupy uprawnień zarządzane przez OVHcloud. Możesz wybrać jedną lub kilka grup, wybierając je z dostępnej listy. @@ -96,7 +96,7 @@ Szczegółowe informacje na temat zawartości grup uprawnień zarządzanych moż Zarządzane grupy akcji mogą być używane jako uzupełnienie akcji jednostkowych. -- Ręcznie dodając operacje +##### 3 - Dodaj działania ręcznie Jeśli znasz nazwę działania, możesz dodać ją ręcznie. @@ -110,7 +110,7 @@ Na przykład, dodanie `vps:apiovh:ips/*` przyznaje następujące uprawnienia: - **vps:apiovh:ips/delete** - **vps:apiovh:ips/get** -- Wybierając działania z listy +##### 4 - Wybierz działania z listy Działania mogą być wybrane z listy. @@ -127,7 +127,27 @@ Dostępne działania zależą od rodzaju zasobów i należą do jednej z pięciu Pole wyszukiwania jest dostępne, aby pomóc Ci zidentyfikować konkretne działanie na liście. > [!primary] -> Operacje związane z produktami IP i vRack, jak również operacje związane z zamówieniem i płatnościami nie są jeszcze dostępne w IAM OVHcloud. +> Działania związane z zamówieniami i fakturami nie są jeszcze dostępne w IAM OVHcloud. + +#### Warunki dla zasad + +Można dodać warunki do zasad IAM. + +Zasada z warunkami jest ważna tylko wtedy, gdy wszystkie warunki są zweryfikowane. + +Można dodać warunki dotyczące: + +- tagu zasobu; +- nazwy zasobu; +- typu produktu; +- adresu IP żądania; +- dnia tygodnia; +- daty; +- godziny. + +![Utwórz zasadę](images/conditions.png){.thumbnail} + +Po dodaniu warunki są wyświetlane zgodnie z [składnią używaną w API](/pages/account_and_service_management/account_information/iam-policies-api). #### Zmień politykę diff --git a/pages/account_and_service_management/account_information/iam-policy-ui/guide.pt-pt.md b/pages/account_and_service_management/account_information/iam-policy-ui/guide.pt-pt.md index 996b6a03b4e..71147a05dfc 100644 --- a/pages/account_and_service_management/account_information/iam-policy-ui/guide.pt-pt.md +++ b/pages/account_and_service_management/account_information/iam-policy-ui/guide.pt-pt.md @@ -1,7 +1,7 @@ --- title: Como utilizar as políticas IAM a partir do seu Espaço Cliente excerpt: Descubra como dar direitos de acesso específicos aos utilizadores a partir de uma conta OVHcloud -updated: 2025-08-27 +updated: 2025-10-27 --- ## Objetivo @@ -77,15 +77,15 @@ Clique no botão `Criar uma política`{.action}. - **Recursos**: adicione recursos ou grupos de recursos a serem cobertos pela política. Os recursos disponíveis são filtrados por tipo de produto previamente selecionado. - **Ações**. -Existem 3 formas de adicionar ações: +**Existem 4 formas de adicionar ações:** -- Ao ativar a opção `Autorizar todas as ações`{.action} +##### 1 - Ativar a opção "Autorizar todas as ações" ![Criar uma política](images/create_a_policy_02.png){.thumbnail} Ao ativar esta opção, estará a autorizar todas as ações relacionadas com os produtos selecionados. Isto inclui todas as ações existentes, bem como as ações futuras acrescentadas a estas categorias de produtos. -- Selecionando um grupo de permissões geridas +##### 2 - Selecionar um grupo de permissões geridas Colocamos à disposição grupos de permissões pré-configuradas e geridas pela OVHcloud. Pode selecionar um ou mais grupos selecionando-os na lista disponível. @@ -96,7 +96,7 @@ Os detalhes do conteúdo dos grupos de permissão administrados estão disponív É possível utilizar os grupos de ações administradas em complemento de ações unitárias. -- Adicionando manualmente ações +##### 3 - Adicionar ações manualmente Se conhece o nome da ação, pode adicioná-la manualmente. @@ -110,7 +110,7 @@ Por exemplo, a adição de `vps:apiovh:ips/*` irá conceder os seguintes direito - **vps:apiovh:ips/delete** - **vps:apiovh:ips/get** -- Selecionando ações da lista +##### 4 - Selecionar ações na lista As ações podem ser selecionadas na lista. @@ -127,7 +127,27 @@ As ações disponíveis dependem do tipo de recursos e pertencem a uma das cinco Está disponível um campo de pesquisa para o ajudar a identificar uma ação específica na lista. > [!primary] -> As ações relativas aos produtos IP e vRack, bem como as ações ligadas à encomenda e faturação, ainda não se encontram disponíveis no IAM OVHcloud. +> As ações relacionadas à compra e à faturação não estão disponíveis no IAM da OVHcloud. + +#### Condições nas políticas + +É possível adicionar condições às políticas IAM. + +Uma política com condições é válida quando todas as condições são validadas. + +É possível aplicar condições sobre: + +- uma etiqueta do recurso; +- o nome do recurso; +- o tipo de produto; +- o endereço IP da solicitação; +- o dia da semana; +- a data; +- a hora. + +![Criar uma política](images/conditions.png){.thumbnail} + +Uma vez adicionadas, as condições são exibidas com a sintaxe [utilizada na API](/pages/account_and_service_management/account_information/iam-policies-api) #### Alterar uma política diff --git a/pages/account_and_service_management/account_information/iam-policy-ui/images/conditions.png b/pages/account_and_service_management/account_information/iam-policy-ui/images/conditions.png new file mode 100644 index 00000000000..a055973c563 Binary files /dev/null and b/pages/account_and_service_management/account_information/iam-policy-ui/images/conditions.png differ diff --git a/pages/account_and_service_management/account_information/iam-policy-ui/images/link_identity_to_policy.png b/pages/account_and_service_management/account_information/iam-policy-ui/images/link_identity_to_policy.png deleted file mode 100644 index 1499ce67df7..00000000000 Binary files a/pages/account_and_service_management/account_information/iam-policy-ui/images/link_identity_to_policy.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/manage-messages/guide.de-de.md b/pages/account_and_service_management/account_information/manage-messages/guide.de-de.md new file mode 100644 index 00000000000..a01fb733f63 --- /dev/null +++ b/pages/account_and_service_management/account_information/manage-messages/guide.de-de.md @@ -0,0 +1,76 @@ +--- +title: "Verwalten von Benachrichtigungen in Ihrem OVHcloud Kundencenter" +excerpt: "Erfahren Sie, wie Sie zusätzliche Kontaktadressen zu Ihrem OVHcloud Kunden-Account hinzufügen und Kommunikationsregeln konfigurieren" +updated: 2025-12-03 +--- + +## Ziel + +Beim Anlegen Ihres OVHcloud Kunden-Accounts haben Sie eine E-Mail-Adresse als Kontaktadresse angegeben. Wenn Sie die Verwaltung der Nachrichten bezüglich Ihres Kunden-Account teilen oder delegieren möchten, können Sie hierzu neue E-Mail-Adressen hinzufügen und Regeln konfigurieren, um die versendeten E-Mails zu verwalten. + +**Diese Anleitung erklärt, wie Sie zusätzliche Kontakt-E-Mail-Adressen zu Ihrem OVHcloud Kunden-Account hinzufügen und Regeln für die Verteilung von Nachrichten konfigurieren.** + +## Voraussetzungen + +- Sie haben Zugriff auf Ihr [OVHcloud Kundencenter](/links/manager). + +## In der praktischen Anwendung + +Um auf die Verwaltung der Kommunikation in Ihrem OVHcloud Kundencenter zuzugreifen: + +1. Loggen Sie sich im [OVHcloud Kundencenter](/links/manager) ein. +1. Klicken Sie auf Ihren Namen oben rechts und dann auf `Meine Kommunikation`{.action}. + +### Meine Kommunikation + +Über den Tab `Meine Kommunikation`{.action} können Sie alle Nachrichten einsehen, die an Ihre E-Mail-Adresse gesendet wurden. In der oberen rechten Ecke der Tabelle können Sie einen Filter aktivieren, um Ihre Nachrichten nach Priorität, Datum und Kategorie zu sortieren. + +![my messages](images/messages-01.png){.thumbnail .w-600} + +### Kontakte + +Über den Tab `Kontakte`{.action} können Sie die Referenz-E-Mail-Adresse Ihres OVHcloud Kunden-Accounts einsehen, die nicht über das Kundencenter entfernt oder geändert werden kann. + +> [!primary] +> +> Wenn Sie keinen Zugriff mehr auf Ihre primäre E-Mail-Adresse haben und keine Ersatz-E-Mail-Adresse hinterlegt haben, müssen Sie [diese Prozedur](/links/transversal/procedure-email-change) ausführen, um bei unseren Teams einen Änderungsantrag zu stellen. + +Neben Ihrem Standardkontakt können Sie weitere E-Mail-Adressen zu Ihrem OVHcloud Kunden-Account hinzufügen: + +- **(1)**: Klicken Sie auf den Button `Kontakt hinzufügen`{.action}, geben Sie die E-Mail-Adresse und den Namen des Kontakts ein und klicken Sie auf `Hinzufügen`{.action}. Ein Validierungscode wird an diese E-Mail-Adresse gesendet. + +- **(2)**: Klicken Sie auf den Button `⋮`{.action} rechts neben dem neuen Kontakt, um die Optionen anzuzeigen: + - `Bestätigungscode eingeben`{.action}: Geben Sie den Validierungscode ein, der an den neuen Kontakt per E-Mail gesendet wurde. + - `Die Bestätigungsmail erneut senden`{.action}: Eine E-Mail mit einem Validierungscode an diesen Kontakt senden. + - `Löschen`{.action}: Diesen Kontakt löschen. + +![my messages](images/contacts-01.png){.thumbnail .w-600} + +### Sendungseinstellungen + +Über den Tab `Sendungseinstellungen`{.action} können Sie Regeln erstellen, um die Sendung von Nachrichten an Ihre E-Mail-Adressen zu organisieren. + +- **(1)**: Klicken Sie auf den Button `Regel erstellen`{.action}, um festzulegen, welche Kontakte Nachrichten erhalten, abhängig von den Kategorien und Prioritätsstufen, die Sie auswählen. + +- **(2)**: Klicken Sie auf den Button `⋮`{.action} rechts neben einer Regel, um auf die Optionen zuzugreifen: + - `Aktivieren / Deaktivieren`{.action}: Ermöglicht es Ihnen, die Regel zu aktivieren oder zu deaktivieren **ohne sie zu löschen** . + - `Ändern`{.action}. + - `Löschen`{.action}. + +![my messages](images/rules-01.png){.thumbnail .w-600} + +Die Regeln werden anhand von zwei Kriterien angewendet: + +- **Die Kategorie**: Account, Rechnung, Incident, Wartung, Produkt und Sicherheit. +- **Die Priorität**: Niedrig, Mittel oder Hoch. + +Sie können Ihre Regeln einzeln erstellen. Sie werden alle ausgeführt, sobald eine Nachricht an Ihren Account gesendet wird. + +Sie können auch eine Regel erstellen, die mehrere Bedingungen enthält, die nacheinander ausgeführt werden. Dazu klicken Sie während der Konfiguration einer Regel auf den Button `Bedingung hinzufügen`{.action} **(1)**. Sie können so viele Bedingungen wie nötig hinzufügen. +Standardmäßig stoppt der Prozess, sobald eine Bedingung zutrifft. Wenn Sie möchten, dass der Prozess fortfährt und die folgenden Bedingungen angewendet werden, aktivieren Sie den Button `Und die Regelverarbeitung fortsetzen`{.action} **(2)** unter der Regel, die Sie konfiguriert haben. + +![my messages](images/rules-02.png){.thumbnail .w-600} + +## Weiterführende Informationen + +Treten Sie unserer [User Community](/links/community) bei. \ No newline at end of file diff --git a/pages/account_and_service_management/account_information/manage-messages/guide.en-gb.md b/pages/account_and_service_management/account_information/manage-messages/guide.en-gb.md new file mode 100644 index 00000000000..f22ad8ff3ab --- /dev/null +++ b/pages/account_and_service_management/account_information/manage-messages/guide.en-gb.md @@ -0,0 +1,76 @@ +--- +title: "How to manage messages in your OVHcloud Control Panel" +excerpt: "Discover how to add additional contact email addresses to your OVHcloud account and configure notification delivery rules" +updated: 2025-12-03 +--- + +## Objective + +When you created your OVHcloud account, you specified a contact email address. If you want to share or delegate the management of your messages related to your customer account, you can add new contact email addresses and configure rules to manage these messages. + +**This guide explains how to add additional email contact addresses to your OVHcloud account and configure notification delivery rules.** + +## Requirements + +- Access to the [OVHcloud Control Panel](/links/manager) + +## Instructions + +To access the communication management page for your OVHcloud customer account: + +1. Log in to your [OVHcloud Control Pane](/links/manager). +1. Click on your name in the top right corner, then click on `My messages`{.action}. + +### My messages + +From the `My messages`{.action} tab, you can view all messages that have been sent to your contact email address. In the top right corner of the table, you can activate a filter to sort your messages by priority, date, and category. + +![my messages](images/messages-01.png){.thumbnail .w-600} + +### Contacts + +From the `Contacts`{.action} tab, you can find the reference email address of the OVHcloud account, which cannot be removed or modified from the customer account. + +> [!primary] +> +> If you no longer have access to your main contact email address and do not have a backup email address, you will need to follow [this procedure](/links/transversal/procedure-email-change) to request a change from our teams. + +In addition to your default contact, you can add new contact email addresses to your OVHcloud account: + +- **(1)**: Click on the `Add a contact`{.action} button, enter the email address and the contact's name, then click on `Add`{.action}. A validation code will then be sent to this email address. + +- **(2)**: Click on the `⋮`{.action} button to the right of the new contact to display the options: + - `Enter validation code`{.action}: Allows you to enter the validation code sent to the new contact by email. + - `Resend the confiramtion code`{.action}: Allows you to resend an email containing a validation code to this contact. + - `Delete`{.action}: Allows you to delete this contact. + +![my messages](images/contacts-01.png){.thumbnail .w-600} + +### Delivery settings + +From the `Delivery settings`{.action} tab, you can create rules to organize the delivery of messages to your contact email addresses. + +- **(1)**: Click on the `Create a rule`{.action} button to define which contacts will receive the messages, based on the categories and priority levels you select. + +- **(2)**: Click on the `⋮`{.action} button to the right of a rule to access the options: + - `Enable / Disable`{.action}: Allows you to enable or disable the rule **without deleting it**. + - `Edit`{.action} the rule. + - `Delete`{.action} the rule. + +![my messages](images/rules-01.png){.thumbnail .w-600} + +Rules are applied based on two criteria: + +- **The category**: Account, Billing, Incident, Maintenance, Product, and Security. +- **The priority**: Set on 3 levels: Low, Medium, and High. + +You can create your rules one by one; they will all be applied when a message is sent to your account. + +You can also create a rule that includes multiple conditions that will be applied in sequence. To do this, when configuring a rule, click on the `Add condition`{.action} **(1)** button. You can add as many conditions as needed. +By default, if a condition applies, the process stops. If you want the process to continue applying the following conditions, enable the `And continue the processing of rules`{.action} **(2)** button under the rule you have configured. + +![my messages](images/rules-02.png){.thumbnail .w-600} + +## Go further + +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/account_and_service_management/account_information/manage-messages/guide.es-es.md b/pages/account_and_service_management/account_information/manage-messages/guide.es-es.md new file mode 100644 index 00000000000..01b249f0cbf --- /dev/null +++ b/pages/account_and_service_management/account_information/manage-messages/guide.es-es.md @@ -0,0 +1,76 @@ +--- +title: "Gestionar las comunicaciones relacionadas con los servicios de OVHcloud" +excerpt: "Descubra cómo añadir direcciones de correo electrónico de contacto adicionales a su cuenta de OVHcloud y configurar reglas para la distribución de mensajes" +updated: 2025-12-03 +--- + +## Objetivo + +Al crear su cuenta de OVHcloud, especificó una dirección de correo electrónico de contacto. Si desea compartir o delegar la gestión de mensajes relacionadas con su espacio cliente, puede añadir nuevas direcciones de correo electrónico de contacto y configurar reglas para gestionar estas mensajes. + +**Descubra cómo añadir direcciones de correo electrónico de contacto adicionales a su cuenta de OVHcloud y configurar reglas de distribución de mensajes.** + +## Requisitos + +- Tener acceso al [área de cliente de OVHcloud](/links/manager) + +## Procedimiento + +Para acceder a la gestión de mensajes en su espacio cliente OVHcloud: + +1. Inicie sesión en su [área de cliente de OVHcloud](/links/manager). +1. Haga clic en su nombre en la parte superior derecha y luego en `Mis mensajes`{.action}. + +### Mis mensajes + +Desde la pestaña `Mis mensajes`{.action}, puede ver todos los mensajes que se han enviado a su dirección de correo electrónico de contacto. En la parte superior derecha de la tabla, puede activar un filtro para ordenar sus mensajes por prioridad, fecha y categoría. + +![my messages](images/messages-01.png){.thumbnail .w-600} + +### Contactos + +Desde la pestaña `Contactos`{.action}, encontrará la dirección de correo electrónico de referencia de la cuenta de OVHcloud, que no se puede eliminar ni modificar desde el espacio cliente. + +> [!primary] +> +> Si ya no tiene acceso a su dirección de correo electrónico de contacto principal y no dispone de una dirección de correo electrónico de respaldo, deberá seguir [este procedimiento](/links/transversal/procedure-email-change) para solicitar su cambio a nuestras equipos. + +Además de su contacto `por defecto`, puede añadir nuevas direcciones de correo electrónico de contacto a su cuenta de OVHcloud: + +- **(1)**: Haga clic en el botón `Añadir un contacto`{.action}, introduzca la dirección de correo electrónico y el nombre del contacto y, a continuación, haga clic en `Añadir`{.action}. Se enviará un código de validación a esta dirección de correo electrónico. + +- **(2)**: Haga clic en el botón `⋮`{.action} a la derecha del nuevo contacto para mostrar las opciones: + - `Introducir el código de validación`{.action}: Permite introducir el código de validación enviado al nuevo contacto por correo electrónico. + - `Reenviar el código de validación`{.action}: Le permite reenviar un correo electrónico que contiene un código de validación a este contacto. + - `Eliminar`{.action}: Permite eliminar este contacto. + +![my messages](images/contacts-01.png){.thumbnail .w-600} + +### Parámetros de envío + +Desde la pestaña `Parámetros de envío`{.action}, puede crear reglas para organizar la distribución de los mensajes a sus direcciones de correo electrónico de contacto. + +- **(1)**: Haga clic en el botón `Crear una regla`{.action} para definir qué contactos recibirán las comunicaciones, según las categorías y los niveles de prioridad que seleccione. + +- **(2)**: Haga clic en el botón `⋮`{.action} a la derecha de una regla para acceder a las opciones: + - `Activar / Desactivar`{.action}: Le permite activar o desactivar la regla **sin eliminarla**. + - `Modificar`{.action} la regla. + - `Eliminar`{.action} la regla. + +![my messages](images/rules-01.png){.thumbnail .w-600} + +Las reglas se aplican según dos criterios: + +- **La categoría**: Cuenta, Facturación, Incidencia, Mantenimiento, Producto y Seguridad. +- **La prioridad**, definida en 3 niveles: Bajo, Medio y Alto. + +Puede crear sus reglas una por una, y todas se aplicarán cuando se transmita un mensaje a su cuenta. + +También puede crear una regla que incluya varias condiciones que se aplicarán en cascada. Para ello, durante la configuración de una regla, haga clic en el botón `Agregar una condición`{.action} **(1)**. Puede añadir tantas condiciones como sea necesario.
+Por defecto, si se aplica una condición, el proceso se detiene. Si desea que el proceso siga aplicando las condiciones siguientes, active el botón `Y continuar el tratamiento de reglas `{.action} **(2)** debajo de la regla que ha configurado. + +![my messages](images/rules-02.png){.thumbnail .w-600} + +## Más información + +Interactúe con nuestra [comunidad de usuarios](/links/community). \ No newline at end of file diff --git a/pages/account_and_service_management/account_information/manage-messages/guide.fr-fr.md b/pages/account_and_service_management/account_information/manage-messages/guide.fr-fr.md new file mode 100644 index 00000000000..e1cc3190561 --- /dev/null +++ b/pages/account_and_service_management/account_information/manage-messages/guide.fr-fr.md @@ -0,0 +1,76 @@ +--- +title: "Gérer les communications liées aux services OVHcloud" +excerpt: "Découvrez comment ajouter des adresses e-mail de contact supplémentaires à votre compte OVHcloud et configurer des règles de distribution des messages" +updated: 2025-12-03 +--- + +## Objectif + +Lors de la création de votre compte OVHcloud, vous avez spécifié une adresse e-mail de contact. Si vous souhaitez partager ou déléguer la gestion de vos communications liées à votre espace client, vous pouvez ajouter de nouvelles adresses e-mail de contact et configurer des règles pour gérer ces communications. + +**Découvrez comment ajouter des adresses e-mail de contact supplémentaires à votre compte OVHcloud et configurer des règles de distribution des messages.** + +## Prérequis + +- Avoir accès à [l'espace client OVHcloud](/links/manager). + +## En pratique + +Pour accéder à la gestion des communications sur votre espace client OVHcloud : + +1. Connectez-vous à votre [espace client OVHcloud](/links/manager). +1. Cliquez sur votre nom en haut à droite, puis sur `Mes communications`{.action}. + +### Mes communications + +Depuis l'onglet `Mes communications`{.action}, retrouvez tous les messages qui ont été envoyés à votre adresse e-mail de contact. Dans la partie supérieure droite du tableau, vous pouvez activer un filtre pour trier vos messages par priorité, date et catégorie. + +![my messages](images/messages-01.png){.thumbnail .w-600} + +### Contacts + +Depuis l'onglet `Contacts`{.action}, vous retrouverez l'adresse e-mail de référence du compte OVHcloud, qui ne peut pas être retirée ou modifiée depuis l'espace client. + +> [!primary] +> +> Si vous n'avez plus accès à votre adresse e-mail de contact principale et que vous ne disposez pas d'adresse e-mail de secours, vous devrez suivre [cette procédure](/links/transversal/procedure-email-change) pour demander son changement auprès de nos équipes. + +En plus de votre contact `par défaut`, vous pouvez ajouter de nouvelles adresses e-mail de contact à votre compte OVHcloud : + +- **(1)** : Cliquez sur le bouton `Ajouter un contact`{.action}, renseignez l'adresse e-mail et le nom du contact puis cliquez sur `Ajouter`{.action}. Un code de validation sera alors envoyé à cette adresse e-mail. + +- **(2)** : Cliquez sur le bouton `⋮`{.action} à droite du nouveau contact pour afficher les options : + - `Entrer le code de validation`{.action} : Permet de saisir le code de validation envoyé au nouveau contact par e-mail. + - `Renvoyer le code de validation`{.action} : Vous permet de renvoyer un e-mail contenant un code de validation à ce contact. + - `Supprimer`{.action} : Permet de supprimer ce contact. + +![my messages](images/contacts-01.png){.thumbnail .w-600} + +### Paramètres de diffusion + +Depuis l'onglet `Paramètres de diffusion`{.action}, vous pouvez créer des règles pour organiser la distribution des messages vers vos adresses e-mail de contact. + +- **(1)** : Cliquez sur le bouton `Créer une règle`{.action} pour définir quels contacts recevront les communications, en fonction des catégories et des niveaux de priorité que vous sélectionnez. + +- **(2)** : Cliquez sur le bouton `⋮`{.action} à droite d'une règle pour accéder aux options : + - `Activer / Désactiver`{.action} : Vous permet d'activer ou de désactiver la règle **sans la supprimer**. + - `Modifier`{.action} la règle. + - `Supprimer`{.action} la règle. + +![my messages](images/rules-01.png){.thumbnail .w-600} + +Les règles s'appliquent selon deux critères : + +- **La catégorie** : Compte, Facturation, Incident, Maintenance, Produit et Sécurité. +- **La priorité**, définie sur 3 niveaux : Faible, Moyen et Élevé. + +Vous pouvez créer vos règles une par une, elles seront toutes appliquées lorsqu'un message sera transmis sur votre compte. + +Vous pouvez également créer une règle comprenant plusieurs conditions qui seront appliquées en cascade. Pour cela, lors de la configuration d'une règle, cliquez sur le bouton `Ajouter une condition`{.action} **(1)**. Vous pouvez ajouter autant de conditions que nécessaire.
+Par défaut, si une condition s'applique, le processus s'arrête. Si vous souhaitez que le processus continue à appliquer les conditions suivantes, activez le bouton `Et continuer le traitement de règles`{.action} **(2)** sous la règle que vous avez paramétrée. + +![my messages](images/rules-02.png){.thumbnail .w-600} + +## Aller plus loin + +Échangez avec notre [communauté d'utilisateurs](/links/community). \ No newline at end of file diff --git a/pages/account_and_service_management/account_information/manage-messages/guide.it-it.md b/pages/account_and_service_management/account_information/manage-messages/guide.it-it.md new file mode 100644 index 00000000000..1e45ee6e19e --- /dev/null +++ b/pages/account_and_service_management/account_information/manage-messages/guide.it-it.md @@ -0,0 +1,76 @@ +--- +title: "Gestire le comunicazioni relative ai servizi OVHcloud" +excerpt: "Scopri come aggiungere nuovi indirizzi email di contatto al tuo account OVHcloud e configurare le regole di distribuzione dei messaggi" +updated: 2025-12-03 +--- + +## Obiettivo + +Al momento della creazione del tuo account OVHcloud, hai specificato un indirizzo email di contatto. Se desideri condividere o delegare la gestione delle tue comunicazioni relative al tuo spazio client, puoi aggiungere nuovi indirizzi email di contatto e configurare delle regole per gestire queste comunicazioni. + +**Scopri come aggiungere nuovi indirizzi email di contatto al tuo account OVHcloud e configurare le regole di distribuzione dei messaggi.** + +## Prerequisiti + +- Avere accesso allo [Spazio Cliente OVHcloud](/links/manager) + +## Procedura + +Per accedere alla gestione delle comunicazioni sul tuo spazio client OVHcloud: + +1. Accedi al tuo [Spazio Cliente OVHcloud](/links/manager). +1. Clicca sul tuo nome in alto a destra, quindi su `Le mie comunicazioni`{.action}. + +### Le mie comunicazioni + +Dalla scheda `Le mie comunicazioni`{.action}, puoi trovare tutti i messaggi che sono stati inviati al tuo indirizzo email di contatto. Nella parte in alto a destra del tableau, puoi attivare un filtro per classificare i tuoi messaggi in base alla priorità, data e categoria. + +![my messages](images/messages-01.png){.thumbnail .w-600} + +### Contatti + +Dalla scheda `Contatti`{.action}, puoi trovare l'indirizzo email di riferimento del tuo account OVHcloud, che non può essere rimosso o modificato direttamente dallo spazio client. + +> [!primary] +> +> Se non hai più accesso al tuo indirizzo email di contatto principale e non hai un indirizzo email di riserva, dovrai seguire [questa procedura](/links/transversal/procedure-email-change) per richiedere il suo aggiornamento alle nostre squadre. + +Oltre al tuo contatto `predefinito`, puoi aggiungere nuovi indirizzi email di contatto al tuo account OVHcloud: + +- **(1)**: Clicca sul pulsante `Aggiungere un contatto`{.action}, inserisci l'indirizzo email e il nome del contatto e clicca su `Aggiungere`{.action}. Un codice di validazione verrà inviato a questa email. + +- **(2)**: Clicca sul pulsante `⋮`{.action} a destra del nuovo contatto per visualizzare le opzioni: + - `Inserire il codice di conferma`{.action}: Permette di inserire il codice di validazione inviato al nuovo contatto via email. + - `Reinviare l'email di convalida`{.action}: Ti permette di inviare un'email contenente un codice di validazione a questo contatto. + - `Eliminare`{.action}: Permette di eliminare questo contatto. + +![my messages](images/contacts-01.png){.thumbnail .w-600} + +### Parametri di invio + +Dalla scheda `Parametri di invio`{.action}, puoi creare delle regole per organizzare la distribuzione dei messaggi verso i tuoi indirizzi email di contatto. + +- **(1)**: Clicca sul pulsante `Creare una regola`{.action} per definire quali contatti riceveranno le comunicazioni, in base alle categorie e ai livelli di priorità che selezioni. + +- **(2)**: Clicca sul pulsante `⋮`{.action} a destra di una regola per accedere alle opzioni: + - `Attivare / Disattivare`{.action}: Ti permette di attivare o disattivare la regola **senza eliminarla**. + - `Modificare`{.action} la regola. + - `Eliminare`{.action} la regola. + +![my messages](images/rules-01.png){.thumbnail .w-600} + +Le regole si applicano in base a due criteri: + +- **La categoria**: Account, Fatturazione, Incidente, Manutenzione, Prodotto e Sicurezza. +- **La priorità**, definita su 3 livelli: Basso, Medio e Alto. + +Puoi creare le tue regole una alla volta, esse saranno tutte applicate quando un messaggio verrà trasmesso sul tuo account. + +Puoi anche creare una regola che comprende più condizioni che saranno applicate in cascata. Per farlo, durante la configurazione di una regola, clicca sul pulsante `Aggiungi una condizione`{.action} **(1)**. Puoi aggiungere tante condizioni quanto necessario.
+Per default, se una condizione si applica, il processo si arresta. Se desideri che il processo continui ad applicare le condizioni successive, attiva il pulsante `E continuare il trattamento delle regole`{.action} **(2)** sotto la regola che hai configurato. + +![my messages](images/rules-02.png){.thumbnail .w-600} + +## Per saperne di più + +Contatta la nostra [Community di utenti](/links/community). \ No newline at end of file diff --git a/pages/account_and_service_management/account_information/manage-messages/guide.pl-pl.md b/pages/account_and_service_management/account_information/manage-messages/guide.pl-pl.md new file mode 100644 index 00000000000..7b41f7fbb1c --- /dev/null +++ b/pages/account_and_service_management/account_information/manage-messages/guide.pl-pl.md @@ -0,0 +1,76 @@ +--- +title: "Zarządzanie komunikacją dotyczącą usług OVHcloud" +excerpt: "Dowiedz się, jak dodać dodatkowe adresy e-mail kontaktowe do swojego konta OVHcloud i skonfigurować reguły dystrybucji wiadomości" +updated: 2025-12-03 +--- + +## Wprowadzenie + +Podczas zakładania konta OVHcloud podałeś adres e-mail kontaktowy. Jeśli chcesz podzielić się lub zdelegować zarządzanie komunikacją związaną z Twoim kontem, możesz dodać nowe adresy e-mail kontaktowe i skonfigurować reguły zarządzania tą komunikacją. + +**Dowiedz się, jak dodać dodatkowe adresy e-mail kontaktowe do swojego konta OVHcloud i skonfigurować reguły dystrybucji wiadomości.** + +## Wymagania początkowe + +- Dostęp do [Panelu klienta OVHcloud](/links/manager) + +## W praktyce + +Aby uzyskać dostęp do zarządzania komunikacją na Twoim koncie OVHcloud: + +1. Zaloguj się do [Panelu klienta OVHcloud](/links/manager). +1. Kliknij swój nick w prawym górnym rogu, a następnie wybierz `Połączenia`{.action}. + +### Wiadomości + +W zakładce `Wiadomości`{.action} znajdziesz wszystkie wiadomości wysłane na Twój adres e-mail kontaktowy. W prawym górnym rogu tabeli możesz włączyć filtr, aby posortować wiadomości według priorytetu, daty i kategorii. + +![my messages](images/messages-01.png){.thumbnail .w-600} + +### Kontakty + +W zakładce `Kontakty`{.action} znajdziesz główny adres e-mail konta OVHcloud, który nie może zostać usunięty ani zmodyfikowany z poziomu panelu klienta. + +> [!primary] +> +> Jeśli nie masz już dostępu do swojego głównego adresu e-mail kontaktowego i nie posiadasz adresu e-mail rezerwowego, musisz postępować zgodnie z [tą procedurą](/links/transversal/procedure-email-change), aby zażądać jego zmiany u naszych zespołów. + +Oprócz kontaktu `domyślny`, możesz dodać nowe adresy e-mail kontaktowe do swojego konta OVHcloud: + +- **(1)**: Kliknij przycisk `Dodaj kontakt`{.action}, wprowadź adres e-mail i imię kontaktu, a następnie kliknij `Dodaj`{.action}. Kod weryfikacyjny zostanie wysłany na ten adres e-mail. + +- **(2)**: Kliknij przycisk `⋮`{.action} obok nowego kontaktu, aby wyświetlić opcje: + - `Wprowadź kod weryfikacyjny`{.action}: Pozwala wpisać kod weryfikacyjny wysłany nowemu kontaktowi przez e-mail. + - `Prześlij ponownie e-mail potwierdzający`{.action}: Pozwala wysłać ponownie e-mail z kodem weryfikacyjnym do tego kontaktu. + - `Usuń`{.action}: Pozwala usunąć ten kontakt. + +![my messages](images/contacts-01.png){.thumbnail .w-600} + +### Ustawienia wysyłki wiadomości + +W zakładce `Ustawienia wysyłki wiadomości`{.action} możesz tworzyć reguły, aby zorganizować dystrybucję wiadomości do swoich adresów e-mail kontaktowych. + +- **(1)**: Kliknij przycisk `Utwórz regułę`{.action}, aby określić, którzy kontakt będzie otrzymywał komunikaty, w zależności od kategorii i poziomów priorytetu, które wybierzesz. + +- **(2)**: Kliknij przycisk `⋮`{.action} obok reguły, aby uzyskać dostęp do opcji: + - `Włącz / Wyłącz`{.action}: Pozwala włączyć lub wyłączyć regułę **bez jej usuwania**. + - `Zmodyfikuj`{.action} regułę. + - `Usuń`{.action} regułę. + +![my messages](images/rules-01.png){.thumbnail .w-600} + +Reguły są stosowane zgodnie z dwoma kryteriami: + +- **Kategoria**: Konto, Płatności, Awaria, Konserwacja, Produkt i Bezpieczeństwo. +- **Priorytet**, ustalony na 3 poziomach: Niski, Średni i Wysoki. + +Możesz tworzyć reguły po jednej, wszystkie zostaną zastosowane, gdy wiadomość zostanie wysłana na Twoje konto. + +Możesz również utworzyć regułę zawierającą wiele warunków, które zostaną zastosowane kaskadowo. Aby to zrobić, podczas konfigurowania reguły kliknij przycisk `Dodaj warunek`{.action} **(1)**. Możesz dodać tyle warunków, ile jest to konieczne.
+Domyślnie, jeśli warunek zostanie spełniony, proces się zatrzyma. Jeśli chcesz, aby proces kontynuował stosowanie kolejnych warunków, włącz przycisk `I kontynuuj przetwarzanie reguł`{.action} **(2)** pod regułą, którą skonfigurowałeś. + +![my messages](images/rules-02.png){.thumbnail .w-600} + +## Sprawdź również + +Dołącz do [grona naszych użytkowników](/links/community). \ No newline at end of file diff --git a/pages/account_and_service_management/account_information/manage-messages/guide.pt-pt.md b/pages/account_and_service_management/account_information/manage-messages/guide.pt-pt.md new file mode 100644 index 00000000000..30cc6e6a05c --- /dev/null +++ b/pages/account_and_service_management/account_information/manage-messages/guide.pt-pt.md @@ -0,0 +1,76 @@ +--- +title: 'Gerir comunicações relacionadas com os serviços da OVHcloud' +excerpt: 'Descubra como adicionar endereços de correio eletrónico de contacto adicionais ao seu conta OVHcloud e configurar regras de distribuição de mensagens' +updated: 2025-12-03 +--- + +## Objetivo + +Ao criar a sua conta OVHcloud, especificou um endereço de correio eletrónico de contacto. Se pretender partilhar ou delegar a gestão das suas comunicações associadas ao seu espaço cliente, pode adicionar novos endereços de correio eletrónico de contacto e configurar regras para gerir estas comunicações. + +**Descubra como adicionar endereços de correio eletrónico de contacto adicionais à sua conta OVHcloud e configurar regras de distribuição de mensagens.** + +## Requisitos + +- Ter acesso à [Área de Cliente OVHcloud](/links/manager) + +## Instruções + +Para aceder à gestão das comunicações no seu espaço cliente OVHcloud: + +1. Inicie sessão no seu [Área de Cliente OVHcloud](/links/manager). +1. Clique no seu nome no canto superior direito, depois em `As minhas comunicações`{.action}. + +### As minhas comunicações + +A partir do separador `As minhas comunicações`{.action}, encontre todos os mensagens que foram enviadas para o seu endereço de correio eletrónico de contacto. Na parte superior direita da tabela, pode ativar um filtro para classificar as suas mensagens por prioridade, data e categoria. + +![my messages](images/messages-01.png){.thumbnail .w-600} + +### Contactos + +A partir do separador `Contactos`{.action}, encontra o endereço de correio eletrónico de referência da conta OVHcloud, que não pode ser removido ou modificado a partir do espaço cliente. + +> [!primary] +> +> Se já não tiver acesso ao seu endereço de correio eletrónico de contacto principal e não tiver um endereço de correio eletrónico de recuperação, terá de seguir [esta procedimento](/links/transversal/procedure-email-change) para solicitar a sua alteração às nossas equipas. + +Além do seu contacto `predefinido`, pode adicionar novos endereços de correio eletrónico de contacto à sua conta OVHcloud: + +- **(1)**: Clique no botão `Adicionar um contacto`{.action}, preencha o endereço de correio eletrónico e o nome do contacto e clique em `Adicionar`{.action}. Um código de validação será enviado para esse endereço de correio eletrónico. + +- **(2)**: Clique no botão `⋮`{.action} à direita do novo contacto para visualizar as opções: + - `Introduzir o código de validação`{.action}: Permite introduzir o código de validação enviado para o novo contacto por correio eletrónico. + - `Reenviar o e-mail de validação`{.action}: Permite reenviar um correio eletrónico contendo um código de validação para este contacto. + - `Eliminar`{.action}: Permite eliminar este contacto. + +![my messages](images/contacts-01.png){.thumbnail .w-600} + +### Definições de difusão + +A partir do separador `Definições de difusão`{.action}, pode criar regras para organizar a distribuição das mensagens para os seus endereços de correio eletrónico de contacto. + +- **(1)**: Clique no botão `Criar uma regra`{.action} para definir quais os contactos que receberão as comunicações, consoante as categorias e os níveis de prioridade que selecionar. + +- **(2)**: Clique no botão `⋮`{.action} à direita de uma regra para aceder às opções: + - `Ativar / Desativar`{.action}: Permite ativar ou desativar a regra **sem a eliminar**. + - `Alterar`{.action} a regra. + - `Eliminar`{.action} a regra. + +![my messages](images/rules-01.png){.thumbnail .w-600} + +As regras aplicam-se de acordo com dois critérios: + +- **A categoria**: Conta, Faturação, Incidente, Manutenção, Produto e Segurança. +- **A prioridade**, definida em 3 níveis: Baixo, Médio e Elevado. + +Pode criar as suas regras uma a uma, todas serão aplicadas quando uma mensagem for transmitida para a sua conta. + +Também pode criar uma regra que inclua várias condições que serão aplicadas em cascata. Para isso, durante a configuração de uma regra, clique no botão `Adicionar uma condição`{.action} **(1)**. Pode adicionar tantas condições quanto necessário.
+Por defeito, se uma condição se aplicar, o processo pára. Se quiser que o processo continue a aplicar as condições seguintes, ative o botão `E continuar o tratamento de regras`{.action} **(2)** sob a regra que configurou. + +![my messages](images/rules-02.png){.thumbnail .w-600} + +## Quer saber mais? + +Fale com a nossa [comunidade de utilizadores](/links/community). \ No newline at end of file diff --git a/pages/account_and_service_management/account_information/manage-messages/images/contacts-01.png b/pages/account_and_service_management/account_information/manage-messages/images/contacts-01.png new file mode 100644 index 00000000000..0aa2fb9c297 Binary files /dev/null and b/pages/account_and_service_management/account_information/manage-messages/images/contacts-01.png differ diff --git a/pages/account_and_service_management/account_information/manage-messages/images/messages-01.png b/pages/account_and_service_management/account_information/manage-messages/images/messages-01.png new file mode 100644 index 00000000000..7862b067279 Binary files /dev/null and b/pages/account_and_service_management/account_information/manage-messages/images/messages-01.png differ diff --git a/pages/account_and_service_management/account_information/manage-messages/images/rules-01.png b/pages/account_and_service_management/account_information/manage-messages/images/rules-01.png new file mode 100644 index 00000000000..0501037908b Binary files /dev/null and b/pages/account_and_service_management/account_information/manage-messages/images/rules-01.png differ diff --git a/pages/account_and_service_management/account_information/manage-messages/images/rules-02.png b/pages/account_and_service_management/account_information/manage-messages/images/rules-02.png new file mode 100644 index 00000000000..104ab0db054 Binary files /dev/null and b/pages/account_and_service_management/account_information/manage-messages/images/rules-02.png differ diff --git a/pages/account_and_service_management/account_information/manage-messages/meta.yaml b/pages/account_and_service_management/account_information/manage-messages/meta.yaml new file mode 100644 index 00000000000..10d17a6ced0 --- /dev/null +++ b/pages/account_and_service_management/account_information/manage-messages/meta.yaml @@ -0,0 +1,3 @@ +id: 00daa66b-5d6e-4a0f-aee0-bf784b3df686 +full_slug: account-messages +translation_banner: true \ No newline at end of file diff --git a/pages/account_and_service_management/account_information/manage-ovh-password/images/account-password-modif-manager-step1.png b/pages/account_and_service_management/account_information/manage-ovh-password/images/account-password-modif-manager-step1.png deleted file mode 100644 index 014c2413ad7..00000000000 Binary files a/pages/account_and_service_management/account_information/manage-ovh-password/images/account-password-modif-manager-step1.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/manage-ovh-password/images/account-password-modif-manager-step2.png b/pages/account_and_service_management/account_information/manage-ovh-password/images/account-password-modif-manager-step2.png deleted file mode 100644 index b40e822284e..00000000000 Binary files a/pages/account_and_service_management/account_information/manage-ovh-password/images/account-password-modif-manager-step2.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/manage-ovh-password/images/account-password-modif-manager-step3.png b/pages/account_and_service_management/account_information/manage-ovh-password/images/account-password-modif-manager-step3.png deleted file mode 100644 index 6f80660954d..00000000000 Binary files a/pages/account_and_service_management/account_information/manage-ovh-password/images/account-password-modif-manager-step3.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/manage-ovh-password/images/account-password-modif-manager-step5.png b/pages/account_and_service_management/account_information/manage-ovh-password/images/account-password-modif-manager-step5.png deleted file mode 100644 index f5ee32c142b..00000000000 Binary files a/pages/account_and_service_management/account_information/manage-ovh-password/images/account-password-modif-manager-step5.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/manage-ovh-password/images/manage-password02.png b/pages/account_and_service_management/account_information/manage-ovh-password/images/manage-password02.png deleted file mode 100644 index ff56aef245c..00000000000 Binary files a/pages/account_and_service_management/account_information/manage-ovh-password/images/manage-password02.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/manage-ovh-password/images/manage-password03.png b/pages/account_and_service_management/account_information/manage-ovh-password/images/manage-password03.png deleted file mode 100644 index 0f7e31631e4..00000000000 Binary files a/pages/account_and_service_management/account_information/manage-ovh-password/images/manage-password03.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/manage-ovh-password/images/newhub2.png b/pages/account_and_service_management/account_information/manage-ovh-password/images/newhub2.png deleted file mode 100644 index b071d76ddb4..00000000000 Binary files a/pages/account_and_service_management/account_information/manage-ovh-password/images/newhub2.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/managing_contacts/guide.fr-fr.md b/pages/account_and_service_management/account_information/managing_contacts/guide.fr-fr.md index 4c456cd9b87..740040f635e 100644 --- a/pages/account_and_service_management/account_information/managing_contacts/guide.fr-fr.md +++ b/pages/account_and_service_management/account_information/managing_contacts/guide.fr-fr.md @@ -35,6 +35,9 @@ L'identifiant client est un identifiant personnel que vous recevez par e-mail lo - Le nouveau contact doit quant à lui disposer d'un accès à l'adresse e-mail renseignée dans son profil. - L'ancien et le nouveau contact facturation doivent être à jour de leurs règlements. +> [!warning] +> Si vous souhaitez effectuer un changement de contacts pour vos services de téléphonie OVHcloud, veuillez suivre [notre guide dédié](/pages/web_cloud/phone_and_fax/voip/effectuer_un_changement_de_contact_pour_les_services_voip). + ## En pratique > [!primary] diff --git a/pages/account_and_service_management/account_information/new-control-panel-navigation/guide.fr-ca.md b/pages/account_and_service_management/account_information/new-control-panel-navigation/guide.fr-ca.md index 51f3a9fb2c4..af301093118 100644 --- a/pages/account_and_service_management/account_information/new-control-panel-navigation/guide.fr-ca.md +++ b/pages/account_and_service_management/account_information/new-control-panel-navigation/guide.fr-ca.md @@ -75,7 +75,7 @@ En bas à gauche de l'espace client, des raccourcis vous permettent de découvri /// details | Liens utiles - [Le Centre d'aide OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help) -- [OVHcloud Marketplace](https://marketplace.ovhcloud.com/) +- [OVHcloud Partners](/links/partner) - [OVHcloud Status](https://www.status-ovhcloud.com/) - [Comment obtenir l'empreinte carbone de vos services OVHcloud](/pages/account_and_service_management/managing_billing_payments_and_services/carbon_footprint) diff --git a/pages/account_and_service_management/account_information/new-control-panel-navigation/guide.fr-fr.md b/pages/account_and_service_management/account_information/new-control-panel-navigation/guide.fr-fr.md index 51f3a9fb2c4..c403acbc09e 100644 --- a/pages/account_and_service_management/account_information/new-control-panel-navigation/guide.fr-fr.md +++ b/pages/account_and_service_management/account_information/new-control-panel-navigation/guide.fr-fr.md @@ -75,7 +75,7 @@ En bas à gauche de l'espace client, des raccourcis vous permettent de découvri /// details | Liens utiles - [Le Centre d'aide OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help) -- [OVHcloud Marketplace](https://marketplace.ovhcloud.com/) +- [OVHcloud Marketplace](/links/transversal/marketplace) - [OVHcloud Status](https://www.status-ovhcloud.com/) - [Comment obtenir l'empreinte carbone de vos services OVHcloud](/pages/account_and_service_management/managing_billing_payments_and_services/carbon_footprint) diff --git a/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-adfs/images/adfs_relying_party_trust_mapping_1.png b/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-adfs/images/adfs_relying_party_trust_mapping_1.png deleted file mode 100644 index 563e9899f62..00000000000 Binary files a/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-adfs/images/adfs_relying_party_trust_mapping_1.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-adfs/images/ovhcloud_login.png b/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-adfs/images/ovhcloud_login.png deleted file mode 100644 index c0de1ff4ed5..00000000000 Binary files a/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-adfs/images/ovhcloud_login.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-adfs/images/ovhcloud_profile_menu.png b/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-adfs/images/ovhcloud_profile_menu.png deleted file mode 100644 index a05329f9e87..00000000000 Binary files a/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-adfs/images/ovhcloud_profile_menu.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-adfs/images/ovhcloud_top_menu.png b/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-adfs/images/ovhcloud_top_menu.png deleted file mode 100644 index fc4b90e642d..00000000000 Binary files a/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-adfs/images/ovhcloud_top_menu.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-adfs/images/ovhcloud_user_infos.png b/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-adfs/images/ovhcloud_user_infos.png deleted file mode 100644 index 17e1de696b4..00000000000 Binary files a/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-adfs/images/ovhcloud_user_infos.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-azure-ad/images/azure_ad_login_4.png b/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-azure-ad/images/azure_ad_login_4.png deleted file mode 100644 index 28da983c851..00000000000 Binary files a/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-azure-ad/images/azure_ad_login_4.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-azure-ad/images/azure_ad_sso_4.png b/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-azure-ad/images/azure_ad_sso_4.png deleted file mode 100644 index cf2d39e484a..00000000000 Binary files a/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-azure-ad/images/azure_ad_sso_4.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-azure-ad/images/azure_ad_sso_7.png b/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-azure-ad/images/azure_ad_sso_7.png deleted file mode 100644 index 39ffa6e18d2..00000000000 Binary files a/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-azure-ad/images/azure_ad_sso_7.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-azure-ad/images/ovhcloud_groups_1.png b/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-azure-ad/images/ovhcloud_groups_1.png deleted file mode 100644 index ee3744e7531..00000000000 Binary files a/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-azure-ad/images/ovhcloud_groups_1.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-azure-ad/images/ovhcloud_login.png b/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-azure-ad/images/ovhcloud_login.png deleted file mode 100644 index c0de1ff4ed5..00000000000 Binary files a/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-azure-ad/images/ovhcloud_login.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-azure-ad/images/ovhcloud_profile_menu.png b/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-azure-ad/images/ovhcloud_profile_menu.png deleted file mode 100644 index 6750e944c8e..00000000000 Binary files a/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-azure-ad/images/ovhcloud_profile_menu.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-azure-ad/images/ovhcloud_top_menu.png b/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-azure-ad/images/ovhcloud_top_menu.png deleted file mode 100644 index c9ac10bdc1b..00000000000 Binary files a/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-azure-ad/images/ovhcloud_top_menu.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-azure-ad/images/ovhcloud_user_infos.png b/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-azure-ad/images/ovhcloud_user_infos.png deleted file mode 100644 index 4f27261a695..00000000000 Binary files a/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-azure-ad/images/ovhcloud_user_infos.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-google-workspace/images/ovhcloud_login.png b/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-google-workspace/images/ovhcloud_login.png deleted file mode 100644 index 0cd600367c3..00000000000 Binary files a/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-google-workspace/images/ovhcloud_login.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-google-workspace/images/ovhcloud_profile_menu.png b/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-google-workspace/images/ovhcloud_profile_menu.png deleted file mode 100644 index 859be1090f3..00000000000 Binary files a/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-google-workspace/images/ovhcloud_profile_menu.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-google-workspace/images/ovhcloud_top_menu.png b/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-google-workspace/images/ovhcloud_top_menu.png deleted file mode 100644 index 996ca3b6dbd..00000000000 Binary files a/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-google-workspace/images/ovhcloud_top_menu.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-google-workspace/images/ovhcloud_user_infos.png b/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-google-workspace/images/ovhcloud_user_infos.png deleted file mode 100644 index 08018028b40..00000000000 Binary files a/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-google-workspace/images/ovhcloud_user_infos.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-okta/images/ovhcloud_login.png b/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-okta/images/ovhcloud_login.png deleted file mode 100644 index 0cd600367c3..00000000000 Binary files a/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-okta/images/ovhcloud_login.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-okta/images/ovhcloud_profile_menu.png b/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-okta/images/ovhcloud_profile_menu.png deleted file mode 100644 index 8a4b5aa3c78..00000000000 Binary files a/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-okta/images/ovhcloud_profile_menu.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-okta/images/ovhcloud_top_menu.png b/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-okta/images/ovhcloud_top_menu.png deleted file mode 100644 index 965a5a8326d..00000000000 Binary files a/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-okta/images/ovhcloud_top_menu.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-okta/images/ovhcloud_user_infos.png b/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-okta/images/ovhcloud_user_infos.png deleted file mode 100644 index 08018028b40..00000000000 Binary files a/pages/account_and_service_management/account_information/ovhcloud-account-connect-saml-okta/images/ovhcloud_user_infos.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/ovhcloud-account-login/images/customer-id-manager-fr.png b/pages/account_and_service_management/account_information/ovhcloud-account-login/images/customer-id-manager-fr.png deleted file mode 100644 index 4b88bc88625..00000000000 Binary files a/pages/account_and_service_management/account_information/ovhcloud-account-login/images/customer-id-manager-fr.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/ovhcloud-account-login/images/nichandle01b.png b/pages/account_and_service_management/account_information/ovhcloud-account-login/images/nichandle01b.png deleted file mode 100644 index b6bbca895b2..00000000000 Binary files a/pages/account_and_service_management/account_information/ovhcloud-account-login/images/nichandle01b.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/ovhcloud-control-panel-ip-restriction/images/ip1.png b/pages/account_and_service_management/account_information/ovhcloud-control-panel-ip-restriction/images/ip1.png deleted file mode 100644 index 1564beaf6ef..00000000000 Binary files a/pages/account_and_service_management/account_information/ovhcloud-control-panel-ip-restriction/images/ip1.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/ovhcloud-control-panel-ip-restriction/images/ip8.png b/pages/account_and_service_management/account_information/ovhcloud-control-panel-ip-restriction/images/ip8.png deleted file mode 100644 index c1aabe48309..00000000000 Binary files a/pages/account_and_service_management/account_information/ovhcloud-control-panel-ip-restriction/images/ip8.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/ovhcloud-users-management/images/hubusers.png b/pages/account_and_service_management/account_information/ovhcloud-users-management/images/hubusers.png deleted file mode 100644 index b6af64d348a..00000000000 Binary files a/pages/account_and_service_management/account_information/ovhcloud-users-management/images/hubusers.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/ovhcloud-users-management/images/umv3.png b/pages/account_and_service_management/account_information/ovhcloud-users-management/images/umv3.png deleted file mode 100644 index 98a10d51e8c..00000000000 Binary files a/pages/account_and_service_management/account_information/ovhcloud-users-management/images/umv3.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/ovhcloud-users-management/images/umv4.png b/pages/account_and_service_management/account_information/ovhcloud-users-management/images/umv4.png deleted file mode 100644 index 20c922d629d..00000000000 Binary files a/pages/account_and_service_management/account_information/ovhcloud-users-management/images/umv4.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/ovhcloud-users-management/images/usersexample.png b/pages/account_and_service_management/account_information/ovhcloud-users-management/images/usersexample.png deleted file mode 100644 index a1047b83b8e..00000000000 Binary files a/pages/account_and_service_management/account_information/ovhcloud-users-management/images/usersexample.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/ovhcloud-users-management/images/usersmanagement1.png b/pages/account_and_service_management/account_information/ovhcloud-users-management/images/usersmanagement1.png deleted file mode 100644 index 8c21505332b..00000000000 Binary files a/pages/account_and_service_management/account_information/ovhcloud-users-management/images/usersmanagement1.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/ovhcloud-users-management/images/usersmanagement5.png b/pages/account_and_service_management/account_information/ovhcloud-users-management/images/usersmanagement5.png deleted file mode 100644 index f5f8319bc10..00000000000 Binary files a/pages/account_and_service_management/account_information/ovhcloud-users-management/images/usersmanagement5.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/phishing_care/guide.en-asia.md b/pages/account_and_service_management/account_information/phishing_care/guide.en-asia.md index 96c5879f048..ab40f65137d 100644 --- a/pages/account_and_service_management/account_information/phishing_care/guide.en-asia.md +++ b/pages/account_and_service_management/account_information/phishing_care/guide.en-asia.md @@ -30,7 +30,7 @@ If you have received an email claiming to be from OVHcloud and you are unsure wh |Number/description|Legit OVHcloud email|Phishing email| |---|---|---| -|1. Sender|Check that the address used to send the email ends in "@ovhcloud.com", "@ovh.com", "@soyoustart.com", "@kimsufi.com" or a sub-domain such as "@events.ovhcloud.com", "@news.soyoustart.com", "@services.kimsufi.com", etc.|Most of the times, the email will be marked as spam between brackets, and your NIC handle will not be shown OR will be incorrect.| +|1. Sender|Check that the address used to send the email ends in "@ovhcloud.com", "@ovh.com", "@ovh.ca", "@soyoustart.com", "@kimsufi.com" or a sub-domain such as "@events.ovhcloud.com", "@news.soyoustart.com", "@services.kimsufi.com", etc.|Most of the times, the email will be marked as spam between brackets, and your NIC handle will not be shown OR will be incorrect.| |2. Subject|Check that your NIC handle **(beginning with the first letter of the surname and the first letter of your first name you have registered with OVHcloud)** and/or the email address associated with your account appear in the message’s subject line.|Most of the time, the email will be marked as spam between brackets, and your NIC handle will not be shown OR will be incorrect.| |3. Link|Move your mouse over the link, and you will be able to see its contents at the bottom of your browser, without having to click on it. Here, the link does indeed points to `https://www.ovh.com/`.| In our example, you can see when you move your mouse over the link that it has nothing to do with OVHcloud. Do not click it.| diff --git a/pages/account_and_service_management/account_information/phishing_care/guide.en-au.md b/pages/account_and_service_management/account_information/phishing_care/guide.en-au.md index 96c5879f048..ab40f65137d 100644 --- a/pages/account_and_service_management/account_information/phishing_care/guide.en-au.md +++ b/pages/account_and_service_management/account_information/phishing_care/guide.en-au.md @@ -30,7 +30,7 @@ If you have received an email claiming to be from OVHcloud and you are unsure wh |Number/description|Legit OVHcloud email|Phishing email| |---|---|---| -|1. Sender|Check that the address used to send the email ends in "@ovhcloud.com", "@ovh.com", "@soyoustart.com", "@kimsufi.com" or a sub-domain such as "@events.ovhcloud.com", "@news.soyoustart.com", "@services.kimsufi.com", etc.|Most of the times, the email will be marked as spam between brackets, and your NIC handle will not be shown OR will be incorrect.| +|1. Sender|Check that the address used to send the email ends in "@ovhcloud.com", "@ovh.com", "@ovh.ca", "@soyoustart.com", "@kimsufi.com" or a sub-domain such as "@events.ovhcloud.com", "@news.soyoustart.com", "@services.kimsufi.com", etc.|Most of the times, the email will be marked as spam between brackets, and your NIC handle will not be shown OR will be incorrect.| |2. Subject|Check that your NIC handle **(beginning with the first letter of the surname and the first letter of your first name you have registered with OVHcloud)** and/or the email address associated with your account appear in the message’s subject line.|Most of the time, the email will be marked as spam between brackets, and your NIC handle will not be shown OR will be incorrect.| |3. Link|Move your mouse over the link, and you will be able to see its contents at the bottom of your browser, without having to click on it. Here, the link does indeed points to `https://www.ovh.com/`.| In our example, you can see when you move your mouse over the link that it has nothing to do with OVHcloud. Do not click it.| diff --git a/pages/account_and_service_management/account_information/phishing_care/guide.en-ca.md b/pages/account_and_service_management/account_information/phishing_care/guide.en-ca.md index 96c5879f048..ab40f65137d 100644 --- a/pages/account_and_service_management/account_information/phishing_care/guide.en-ca.md +++ b/pages/account_and_service_management/account_information/phishing_care/guide.en-ca.md @@ -30,7 +30,7 @@ If you have received an email claiming to be from OVHcloud and you are unsure wh |Number/description|Legit OVHcloud email|Phishing email| |---|---|---| -|1. Sender|Check that the address used to send the email ends in "@ovhcloud.com", "@ovh.com", "@soyoustart.com", "@kimsufi.com" or a sub-domain such as "@events.ovhcloud.com", "@news.soyoustart.com", "@services.kimsufi.com", etc.|Most of the times, the email will be marked as spam between brackets, and your NIC handle will not be shown OR will be incorrect.| +|1. Sender|Check that the address used to send the email ends in "@ovhcloud.com", "@ovh.com", "@ovh.ca", "@soyoustart.com", "@kimsufi.com" or a sub-domain such as "@events.ovhcloud.com", "@news.soyoustart.com", "@services.kimsufi.com", etc.|Most of the times, the email will be marked as spam between brackets, and your NIC handle will not be shown OR will be incorrect.| |2. Subject|Check that your NIC handle **(beginning with the first letter of the surname and the first letter of your first name you have registered with OVHcloud)** and/or the email address associated with your account appear in the message’s subject line.|Most of the time, the email will be marked as spam between brackets, and your NIC handle will not be shown OR will be incorrect.| |3. Link|Move your mouse over the link, and you will be able to see its contents at the bottom of your browser, without having to click on it. Here, the link does indeed points to `https://www.ovh.com/`.| In our example, you can see when you move your mouse over the link that it has nothing to do with OVHcloud. Do not click it.| diff --git a/pages/account_and_service_management/account_information/phishing_care/guide.en-sg.md b/pages/account_and_service_management/account_information/phishing_care/guide.en-sg.md index 96c5879f048..ab40f65137d 100644 --- a/pages/account_and_service_management/account_information/phishing_care/guide.en-sg.md +++ b/pages/account_and_service_management/account_information/phishing_care/guide.en-sg.md @@ -30,7 +30,7 @@ If you have received an email claiming to be from OVHcloud and you are unsure wh |Number/description|Legit OVHcloud email|Phishing email| |---|---|---| -|1. Sender|Check that the address used to send the email ends in "@ovhcloud.com", "@ovh.com", "@soyoustart.com", "@kimsufi.com" or a sub-domain such as "@events.ovhcloud.com", "@news.soyoustart.com", "@services.kimsufi.com", etc.|Most of the times, the email will be marked as spam between brackets, and your NIC handle will not be shown OR will be incorrect.| +|1. Sender|Check that the address used to send the email ends in "@ovhcloud.com", "@ovh.com", "@ovh.ca", "@soyoustart.com", "@kimsufi.com" or a sub-domain such as "@events.ovhcloud.com", "@news.soyoustart.com", "@services.kimsufi.com", etc.|Most of the times, the email will be marked as spam between brackets, and your NIC handle will not be shown OR will be incorrect.| |2. Subject|Check that your NIC handle **(beginning with the first letter of the surname and the first letter of your first name you have registered with OVHcloud)** and/or the email address associated with your account appear in the message’s subject line.|Most of the time, the email will be marked as spam between brackets, and your NIC handle will not be shown OR will be incorrect.| |3. Link|Move your mouse over the link, and you will be able to see its contents at the bottom of your browser, without having to click on it. Here, the link does indeed points to `https://www.ovh.com/`.| In our example, you can see when you move your mouse over the link that it has nothing to do with OVHcloud. Do not click it.| diff --git a/pages/account_and_service_management/account_information/phishing_care/guide.en-us.md b/pages/account_and_service_management/account_information/phishing_care/guide.en-us.md index 96c5879f048..ab40f65137d 100644 --- a/pages/account_and_service_management/account_information/phishing_care/guide.en-us.md +++ b/pages/account_and_service_management/account_information/phishing_care/guide.en-us.md @@ -30,7 +30,7 @@ If you have received an email claiming to be from OVHcloud and you are unsure wh |Number/description|Legit OVHcloud email|Phishing email| |---|---|---| -|1. Sender|Check that the address used to send the email ends in "@ovhcloud.com", "@ovh.com", "@soyoustart.com", "@kimsufi.com" or a sub-domain such as "@events.ovhcloud.com", "@news.soyoustart.com", "@services.kimsufi.com", etc.|Most of the times, the email will be marked as spam between brackets, and your NIC handle will not be shown OR will be incorrect.| +|1. Sender|Check that the address used to send the email ends in "@ovhcloud.com", "@ovh.com", "@ovh.ca", "@soyoustart.com", "@kimsufi.com" or a sub-domain such as "@events.ovhcloud.com", "@news.soyoustart.com", "@services.kimsufi.com", etc.|Most of the times, the email will be marked as spam between brackets, and your NIC handle will not be shown OR will be incorrect.| |2. Subject|Check that your NIC handle **(beginning with the first letter of the surname and the first letter of your first name you have registered with OVHcloud)** and/or the email address associated with your account appear in the message’s subject line.|Most of the time, the email will be marked as spam between brackets, and your NIC handle will not be shown OR will be incorrect.| |3. Link|Move your mouse over the link, and you will be able to see its contents at the bottom of your browser, without having to click on it. Here, the link does indeed points to `https://www.ovh.com/`.| In our example, you can see when you move your mouse over the link that it has nothing to do with OVHcloud. Do not click it.| diff --git a/pages/account_and_service_management/account_information/phishing_care/guide.fr-ca.md b/pages/account_and_service_management/account_information/phishing_care/guide.fr-ca.md index e43ef46650f..21ae4e59bfb 100644 --- a/pages/account_and_service_management/account_information/phishing_care/guide.fr-ca.md +++ b/pages/account_and_service_management/account_information/phishing_care/guide.fr-ca.md @@ -34,7 +34,7 @@ Cliquez sur l'image pour l'agrandir. Retrouvez les détails et explications dans |Numéro - description|E-mail OVHcloud légitime|E-mail de phishing frauduleux| |---|---|---| -|1 - Expéditeur|Vérifiez que l’adresse utilisée pour l’envoi de l’e-mail se termine par un domaine tel que « @ovhcloud.com », « @ovh.com », « @soyoustart.com » , « @kimsufi.com » ou un sous-domaine tel que « @events.ovhcloud.com », « @news.soyoustart.com », « @services.kimsufi.com », etc... |L'expéditeur de l'e-mail sera forcément une adresse qui ne vient pas d'OVHcloud.| +|1 - Expéditeur|Vérifiez que l’adresse utilisée pour l’envoi de l’e-mail se termine par un domaine tel que « @ovhcloud.com », « @ovh.com », « @ovh.ca" », « @soyoustart.com » , « @kimsufi.com » ou un sous-domaine tel que « @events.ovhcloud.com », « @news.soyoustart.com », « @services.kimsufi.com », etc... |L'expéditeur de l'e-mail sera forcément une adresse qui ne vient pas d'OVHcloud.| |2 - Objet|Vérifiez que votre identifiant **(commençant par la première lettre du nom enregistré chez OVHcloud puis par la première lettre du prénom enregistré chez OVHcloud)** et/ou l’adresse e-mail de votre compte figurent dans l’objet du message.|Très souvent, l'e-mail sera marqué comme \[SPAM] et **votre identifiant n'apparaîtra pas ou sera incorrect**.| |3 - Lien|**Sans cliquer dessus, passez votre pointeur de souris sur le lien ou le bouton** et vous en verrez directement la cible (en dessous ou tout en bas de votre navigateur). Dans notre exemple, le lien renvoie bien vers une adresse https://www.ovh.com/.|Dans notre exemple, en passant le pointeur de la souris sur le lien, vous remarquez que celui-ci n'a rien à voir avec OVHcloud. **Ne cliquez pas dessus.**| diff --git a/pages/account_and_service_management/account_information/phishing_care/images/sms.png b/pages/account_and_service_management/account_information/phishing_care/images/sms.png deleted file mode 100644 index 82139299ced..00000000000 Binary files a/pages/account_and_service_management/account_information/phishing_care/images/sms.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa/guide.de-de.md b/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa/guide.de-de.md index 7b5f7c5acb5..b244c9e0304 100644 --- a/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa/guide.de-de.md +++ b/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa/guide.de-de.md @@ -25,7 +25,7 @@ details[open]>summary::before { ## Ziel -OVHcloud stellt mit der Zwei-Faktor-Authentifizierung (2FA) Möglichkeiten zur Verfügung, um die Sicherheit Ihres Accounts und Ihrer Dienste zu erhöhen. +OVHcloud stellt mit der Zwei-Faktor-Authentifizierung (2FA) Möglichkeiten zur Verfügung, um die Sicherheit Ihres Accounts und Ihrer Dienste zu erhöhen. 2FA ergänzt Ihre Anmeldung im Kundencenter mit Kennung und Passwort mithilfe eines zusätzlichen Geräts: z.B. Mobiltelefon, Tablet oder USB-Sicherheitsschlüssel. **Diese Anleitung erklärt die verschiedenen Sicherheitsmethoden und deren Aktivierung.** @@ -54,7 +54,7 @@ Wir bieten vier verschiedene Methoden an (klicken Sie jeweils auf die Tabs, um d > SMS >>![2FA SMS](images/sms.svg)
>> Für diese Methode müssen Sie Ihre Mobiltelefonnummer angeben. ->> Sie erhalten bei jedem Versuch, sich mit Ihrem OVHcloud-Konto zu verbinden, einen Einmalcode per SMS zugesandt. +>> Sie erhalten bei jedem Versuch, sich mit Ihrem OVHcloud Kunden-Account zu verbinden, einen Einmalcode per SMS zugesandt. >> >> Der Hauptvorteil dieser Methode ist, dass Codes an ein Gerät separat von Ihrem Computer gesendet werden. Bei einer Kompromittierung Ihres Systems, zum Beispiel über Malware, bliebe Ihr Account dennoch abgesichert. >> Sie müssen jedoch über eine ausreichende Netzwerkabdeckung verfügen, um SMS empfangen zu können. @@ -77,7 +77,7 @@ Wir bieten vier verschiedene Methoden an (klicken Sie jeweils auf die Tabs, um d >> > USB-Token >>![2FA U2F](images/key.svg)
->> Für diese Methode benötigen Sie einen USB-"Schlüssel" **U2F**, den Sie bei jeder Verbindung mit Ihrem OVHcloud Kunden-Account an einen USB-Port Ihres Computers anschließen. Die Authentifizierung erfolgt dann automatisch. +>> Für diese Methode benötigen Sie einen USB-"Schlüssel" (**U2F**), den Sie bei jeder Verbindung mit Ihrem OVHcloud Kunden-Account an einen USB-Port Ihres Computers anschließen. Die Authentifizierung erfolgt dann automatisch. >> >> Diese Methode bietet ein höheres Sicherheitsniveau, da sie auf einem separaten physischen Sicherheitsfaktor basiert, der vollständig von Ihrem Computer, Smartphone oder Tablet getrennt ist und weniger anfällig für Hacks ist. > Notfall-Codes @@ -86,7 +86,7 @@ Wir bieten vier verschiedene Methoden an (klicken Sie jeweils auf die Tabs, um d >> >> Diese Methode der Zwei-Faktor-Authentifizierung ergänzt eine bereits aktivierte Methode (mit **SMS**, **OTP App** oder **U2F**) und kann nicht alleinstehend aktiviert werden. >> ->> Bei jedem Anmeldeversuch können Sie einen der 10 Einmalcodes eingeben. +>> Bei jedem Anmeldeversuch können Sie einen der 10 Einmalcodes eingeben. >> Es ist wichtig, immer mindestens einen Notfall-Code übrig zu haben. Denken Sie daran, diese über Ihr Kundencenter zu erneuern, wenn Sie alle verwendet oder sie verloren haben. ### Schritt 1: Aktivieren Sie Ihre erste Methode der Zwei-Faktor-Authentifizierung @@ -102,7 +102,7 @@ Klicken Sie danach auf `Sicherheit`{.action}, und schließlich auf `Die Zwei-Fak >> Wählen Sie die Methode SMS aus und klicken Sie auf `Weiter`{.action}. >> >>![2FA SMS](images/2024-002-sms-choice.png){.thumbnail width="400"}
->> Geben Sie Ihre Mobiltelefonnummer im internationalen Format ein (zum Beispiel +33612345678 für ein Mobiltelefon in Frankreich) und bestätigen Sie. +>> Geben Sie Ihre Mobiltelefonnummer im internationalen Format ein (zum Beispiel +49612345678 für eine Nummer in Deutschland) und bestätigen Sie. >> Ein Validierungscode wird dann per SMS an die von Ihnen angegebene Nummer gesendet. >> >>![2FA SMS](images/2fasms3edit.png){.thumbnail width="400"}
@@ -181,7 +181,7 @@ Wenn Ihr Peripheriegerät (Mobiltelefon/Smartphone/Sicherheitsschlüssel) verlor > [!warning] > -> Wenn eines Ihrer Geräte verloren gegangen ist oder gestohlen wurde, kann dies die Sicherheit Ihres OVHcloud-Accounts gefährden. +> Wenn eines Ihrer Geräte verloren gegangen ist oder gestohlen wurde, kann dies die Sicherheit Ihres OVHcloud Kunden-Accounts gefährden. > Sobald Sie wieder Zugang zu Ihrem Kundencenter haben, entfernen Sie **dieses Gerät aus der Liste der Geräte, die für die Zwei-Faktor-Authentifizierung verwendet werden**. > > Weitere Informationen zum Entfernen eines Geräts finden Sie im nächsten Abschnitt. diff --git a/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa/images/2024-001-enabling-2fa.png b/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa/images/2024-001-enabling-2fa.png deleted file mode 100644 index 6c31575173f..00000000000 Binary files a/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa/images/2024-001-enabling-2fa.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa/images/2facodes.png b/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa/images/2facodes.png deleted file mode 100644 index f03b23e8808..00000000000 Binary files a/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa/images/2facodes.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa/images/2facodesaction.png b/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa/images/2facodesaction.png deleted file mode 100644 index 88992c77e6a..00000000000 Binary files a/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa/images/2facodesaction.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa/images/2faloginchoice.png b/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa/images/2faloginchoice.png deleted file mode 100644 index e2b576f888f..00000000000 Binary files a/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa/images/2faloginchoice.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa/images/2fasmsloginedit.png b/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa/images/2fasmsloginedit.png deleted file mode 100644 index c61fe68fcc9..00000000000 Binary files a/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa/images/2fasmsloginedit.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa/images/backupcode_auth.png b/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa/images/backupcode_auth.png deleted file mode 100644 index d8d0c86ff10..00000000000 Binary files a/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa/images/backupcode_auth.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa/images/delete-device.png b/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa/images/delete-device.png deleted file mode 100644 index c848af5f610..00000000000 Binary files a/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa/images/delete-device.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa/images/hub2FAb.png b/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa/images/hub2FAb.png deleted file mode 100644 index e06df3c570d..00000000000 Binary files a/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa/images/hub2FAb.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa/images/hub2FAc.png b/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa/images/hub2FAc.png deleted file mode 100644 index bec6cf711c6..00000000000 Binary files a/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa/images/hub2FAc.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa/images/mobile_auth.png b/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa/images/mobile_auth.png deleted file mode 100644 index e3f2cb5242b..00000000000 Binary files a/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa/images/mobile_auth.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa/images/remove_auth.png b/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa/images/remove_auth.png deleted file mode 100644 index 423167cce26..00000000000 Binary files a/pages/account_and_service_management/account_information/secure-ovhcloud-account-with-2fa/images/remove_auth.png and /dev/null differ diff --git a/pages/account_and_service_management/account_information/security-specifications-dedicated-servers/images/spec_HDS.PNG b/pages/account_and_service_management/account_information/security-specifications-dedicated-servers/images/spec_HDS.PNG deleted file mode 100644 index ecbe8a7247b..00000000000 Binary files a/pages/account_and_service_management/account_information/security-specifications-dedicated-servers/images/spec_HDS.PNG and /dev/null differ diff --git a/pages/account_and_service_management/account_information/ssh-key-creation/images/screenshot-4.fr-fr.jpg b/pages/account_and_service_management/account_information/ssh-key-creation/images/screenshot-4.fr-fr.jpg deleted file mode 100644 index aba1e1f9753..00000000000 Binary files a/pages/account_and_service_management/account_information/ssh-key-creation/images/screenshot-4.fr-fr.jpg and /dev/null differ diff --git a/pages/account_and_service_management/account_information/ssh-key-creation/images/screenshot-4.it-it.jpg b/pages/account_and_service_management/account_information/ssh-key-creation/images/screenshot-4.it-it.jpg deleted file mode 100644 index 287ac90c77a..00000000000 Binary files a/pages/account_and_service_management/account_information/ssh-key-creation/images/screenshot-4.it-it.jpg and /dev/null differ diff --git a/pages/account_and_service_management/account_information/ssh-key-creation/images/screenshot-4.pl-pl.jpg b/pages/account_and_service_management/account_information/ssh-key-creation/images/screenshot-4.pl-pl.jpg deleted file mode 100644 index 7ff1499afd1..00000000000 Binary files a/pages/account_and_service_management/account_information/ssh-key-creation/images/screenshot-4.pl-pl.jpg and /dev/null differ diff --git a/pages/account_and_service_management/account_information/ssh-key-creation/images/screenshot-4.pt-pt.jpg b/pages/account_and_service_management/account_information/ssh-key-creation/images/screenshot-4.pt-pt.jpg deleted file mode 100644 index 9dad870c6e2..00000000000 Binary files a/pages/account_and_service_management/account_information/ssh-key-creation/images/screenshot-4.pt-pt.jpg and /dev/null differ diff --git a/pages/account_and_service_management/account_information/use-plik/guide.es-us.md b/pages/account_and_service_management/account_information/use-plik/guide.es-us.md index cf99ed7fc48..6cd0ccef213 100644 --- a/pages/account_and_service_management/account_information/use-plik/guide.es-us.md +++ b/pages/account_and_service_management/account_information/use-plik/guide.es-us.md @@ -34,7 +34,7 @@ Una vez que haya iniciado sesión, podrá cargar archivos, cerrar sesión, crear ![Carga](images/plik-upload.png) -Para cargar un archivo, seleccione el botón `Upload Files`{.acción}. Esto abrirá una nueva página. En esta página, tiene muchas opciones sobre cómo hacer que sus cargas estén disponibles. +Para cargar un archivo, seleccione el botón `Upload Files`{.action}. Esto abrirá una nueva página. En esta página, tiene muchas opciones sobre cómo hacer que sus cargas estén disponibles. ![Opciones de carga](images/plik-upload-options.png) @@ -59,7 +59,7 @@ Seleccione las opciones que desea utilizar y haga clic en el botón `Add files`{ > Nota: los archivos están limitados a 10 GB de tamaño. > -Después de seleccionar los archivos que desea cargar, seleccione el botón verde `Upload`{.acción} en el lado izquierdo. Esto abrirá una nueva página con sus archivos adjuntos; desde aquí, repasaremos nuestras opciones de descarga. +Después de seleccionar los archivos que desea cargar, seleccione el botón verde `Upload`{.action} en el lado izquierdo. Esto abrirá una nueva página con sus archivos adjuntos; desde aquí, repasaremos nuestras opciones de descarga. ### Descargando archivos diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/add_cloud_credit_to_project/images/buycredit1.png b/pages/account_and_service_management/managing_billing_payments_and_services/add_cloud_credit_to_project/images/buycredit1.png deleted file mode 100644 index 406639fe6fb..00000000000 Binary files a/pages/account_and_service_management/managing_billing_payments_and_services/add_cloud_credit_to_project/images/buycredit1.png and /dev/null differ diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/add_cloud_credit_to_project/images/buycredit2.png b/pages/account_and_service_management/managing_billing_payments_and_services/add_cloud_credit_to_project/images/buycredit2.png deleted file mode 100644 index a40f97e9f47..00000000000 Binary files a/pages/account_and_service_management/managing_billing_payments_and_services/add_cloud_credit_to_project/images/buycredit2.png and /dev/null differ diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/add_cloud_credit_to_project/images/buycredit3.png b/pages/account_and_service_management/managing_billing_payments_and_services/add_cloud_credit_to_project/images/buycredit3.png deleted file mode 100644 index 00242f482f8..00000000000 Binary files a/pages/account_and_service_management/managing_billing_payments_and_services/add_cloud_credit_to_project/images/buycredit3.png and /dev/null differ diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/add_cloud_credit_to_project/images/buycredit4.png b/pages/account_and_service_management/managing_billing_payments_and_services/add_cloud_credit_to_project/images/buycredit4.png deleted file mode 100644 index 96f3adc5729..00000000000 Binary files a/pages/account_and_service_management/managing_billing_payments_and_services/add_cloud_credit_to_project/images/buycredit4.png and /dev/null differ diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/add_cloud_credit_to_project/images/buycredit6.png b/pages/account_and_service_management/managing_billing_payments_and_services/add_cloud_credit_to_project/images/buycredit6.png deleted file mode 100644 index 2aafa2071b7..00000000000 Binary files a/pages/account_and_service_management/managing_billing_payments_and_services/add_cloud_credit_to_project/images/buycredit6.png and /dev/null differ diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/add_cloud_credit_to_project/images/buycredit7.png b/pages/account_and_service_management/managing_billing_payments_and_services/add_cloud_credit_to_project/images/buycredit7.png deleted file mode 100644 index eeebd8cf5fe..00000000000 Binary files a/pages/account_and_service_management/managing_billing_payments_and_services/add_cloud_credit_to_project/images/buycredit7.png and /dev/null differ diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/billing_best_practices/images/viewmyorders.png b/pages/account_and_service_management/managing_billing_payments_and_services/billing_best_practices/images/viewmyorders.png deleted file mode 100644 index 7bcf900a49b..00000000000 Binary files a/pages/account_and_service_management/managing_billing_payments_and_services/billing_best_practices/images/viewmyorders.png and /dev/null differ diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/changing_hourly_monthly_billing/images/1_swich_to_monthly_sub.png b/pages/account_and_service_management/managing_billing_payments_and_services/changing_hourly_monthly_billing/images/1_swich_to_monthly_sub.png deleted file mode 100644 index 2144a0a1677..00000000000 Binary files a/pages/account_and_service_management/managing_billing_payments_and_services/changing_hourly_monthly_billing/images/1_swich_to_monthly_sub.png and /dev/null differ diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/changing_hourly_monthly_billing/images/2_switch_to_monthly_confirm.png b/pages/account_and_service_management/managing_billing_payments_and_services/changing_hourly_monthly_billing/images/2_switch_to_monthly_confirm.png deleted file mode 100644 index 968de8a5cb6..00000000000 Binary files a/pages/account_and_service_management/managing_billing_payments_and_services/changing_hourly_monthly_billing/images/2_switch_to_monthly_confirm.png and /dev/null differ diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/changing_hourly_monthly_billing/images/switch1.png b/pages/account_and_service_management/managing_billing_payments_and_services/changing_hourly_monthly_billing/images/switch1.png deleted file mode 100644 index c56d48148a2..00000000000 Binary files a/pages/account_and_service_management/managing_billing_payments_and_services/changing_hourly_monthly_billing/images/switch1.png and /dev/null differ diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/comment_resilier_le_private_cloud/images/Disclaimer.PNG b/pages/account_and_service_management/managing_billing_payments_and_services/comment_resilier_le_private_cloud/images/Disclaimer.PNG deleted file mode 100644 index 4b6fafcdf62..00000000000 Binary files a/pages/account_and_service_management/managing_billing_payments_and_services/comment_resilier_le_private_cloud/images/Disclaimer.PNG and /dev/null differ diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/facturation_private_cloud/images/Action.PNG b/pages/account_and_service_management/managing_billing_payments_and_services/facturation_private_cloud/images/Action.PNG deleted file mode 100644 index 611c0ab1144..00000000000 Binary files a/pages/account_and_service_management/managing_billing_payments_and_services/facturation_private_cloud/images/Action.PNG and /dev/null differ diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/facturation_private_cloud/images/AddRule.PNG b/pages/account_and_service_management/managing_billing_payments_and_services/facturation_private_cloud/images/AddRule.PNG deleted file mode 100644 index ac35c4004d5..00000000000 Binary files a/pages/account_and_service_management/managing_billing_payments_and_services/facturation_private_cloud/images/AddRule.PNG and /dev/null differ diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/facturation_private_cloud/images/AddSection.PNG b/pages/account_and_service_management/managing_billing_payments_and_services/facturation_private_cloud/images/AddSection.PNG deleted file mode 100644 index 6f31f8c9d4e..00000000000 Binary files a/pages/account_and_service_management/managing_billing_payments_and_services/facturation_private_cloud/images/AddSection.PNG and /dev/null differ diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/facturation_private_cloud/images/AppliedOn.PNG b/pages/account_and_service_management/managing_billing_payments_and_services/facturation_private_cloud/images/AppliedOn.PNG deleted file mode 100644 index 4cc0233634b..00000000000 Binary files a/pages/account_and_service_management/managing_billing_payments_and_services/facturation_private_cloud/images/AppliedOn.PNG and /dev/null differ diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/facturation_private_cloud/images/ExampleRules.PNG b/pages/account_and_service_management/managing_billing_payments_and_services/facturation_private_cloud/images/ExampleRules.PNG deleted file mode 100644 index 2e8e8e04e3c..00000000000 Binary files a/pages/account_and_service_management/managing_billing_payments_and_services/facturation_private_cloud/images/ExampleRules.PNG and /dev/null differ diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/facturation_private_cloud/images/FirewallMenu.PNG b/pages/account_and_service_management/managing_billing_payments_and_services/facturation_private_cloud/images/FirewallMenu.PNG deleted file mode 100644 index 823c6337003..00000000000 Binary files a/pages/account_and_service_management/managing_billing_payments_and_services/facturation_private_cloud/images/FirewallMenu.PNG and /dev/null differ diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/facturation_private_cloud/images/Icones.PNG b/pages/account_and_service_management/managing_billing_payments_and_services/facturation_private_cloud/images/Icones.PNG deleted file mode 100644 index de4554bd8aa..00000000000 Binary files a/pages/account_and_service_management/managing_billing_payments_and_services/facturation_private_cloud/images/Icones.PNG and /dev/null differ diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/facturation_private_cloud/images/Name.PNG b/pages/account_and_service_management/managing_billing_payments_and_services/facturation_private_cloud/images/Name.PNG deleted file mode 100644 index 12fb16fc1c0..00000000000 Binary files a/pages/account_and_service_management/managing_billing_payments_and_services/facturation_private_cloud/images/Name.PNG and /dev/null differ diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/facturation_private_cloud/images/No.PNG b/pages/account_and_service_management/managing_billing_payments_and_services/facturation_private_cloud/images/No.PNG deleted file mode 100644 index a85775b9669..00000000000 Binary files a/pages/account_and_service_management/managing_billing_payments_and_services/facturation_private_cloud/images/No.PNG and /dev/null differ diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/facturation_private_cloud/images/Publish.PNG b/pages/account_and_service_management/managing_billing_payments_and_services/facturation_private_cloud/images/Publish.PNG deleted file mode 100644 index 49373a6ada2..00000000000 Binary files a/pages/account_and_service_management/managing_billing_payments_and_services/facturation_private_cloud/images/Publish.PNG and /dev/null differ diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/facturation_private_cloud/images/SectionAdded.PNG b/pages/account_and_service_management/managing_billing_payments_and_services/facturation_private_cloud/images/SectionAdded.PNG deleted file mode 100644 index fc947f37993..00000000000 Binary files a/pages/account_and_service_management/managing_billing_payments_and_services/facturation_private_cloud/images/SectionAdded.PNG and /dev/null differ diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/facturation_private_cloud/images/Service.png b/pages/account_and_service_management/managing_billing_payments_and_services/facturation_private_cloud/images/Service.png deleted file mode 100644 index 27842c03ce6..00000000000 Binary files a/pages/account_and_service_management/managing_billing_payments_and_services/facturation_private_cloud/images/Service.png and /dev/null differ diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/facturation_private_cloud/images/SourceDest.png b/pages/account_and_service_management/managing_billing_payments_and_services/facturation_private_cloud/images/SourceDest.png deleted file mode 100644 index 5bd1984751e..00000000000 Binary files a/pages/account_and_service_management/managing_billing_payments_and_services/facturation_private_cloud/images/SourceDest.png and /dev/null differ diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/faq-billing/meta.yaml b/pages/account_and_service_management/managing_billing_payments_and_services/faq-billing/meta.yaml index a1e3101b545..feeb1224ec2 100644 --- a/pages/account_and_service_management/managing_billing_payments_and_services/faq-billing/meta.yaml +++ b/pages/account_and_service_management/managing_billing_payments_and_services/faq-billing/meta.yaml @@ -1,3 +1,3 @@ -id : fd50aa9b-e0fb-4388-ac6c-c77910496e9c +id: fd50aa9b-e0fb-4388-ac6c-c77910496e9c full_slug: faq-billing translation_banner: true \ No newline at end of file diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/faq-order-tracking/images/order_final-min.gif b/pages/account_and_service_management/managing_billing_payments_and_services/faq-order-tracking/images/order_final-min.gif deleted file mode 100644 index 02983d995c1..00000000000 Binary files a/pages/account_and_service_management/managing_billing_payments_and_services/faq-order-tracking/images/order_final-min.gif and /dev/null differ diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/faq-order-tracking/meta.yaml b/pages/account_and_service_management/managing_billing_payments_and_services/faq-order-tracking/meta.yaml index 9221807a1fc..b201bdcb36f 100644 --- a/pages/account_and_service_management/managing_billing_payments_and_services/faq-order-tracking/meta.yaml +++ b/pages/account_and_service_management/managing_billing_payments_and_services/faq-order-tracking/meta.yaml @@ -1,3 +1,3 @@ -id : 83402f98-60cf-11ed-9b6a-0242ac120002 +id: 83402f98-60cf-11ed-9b6a-0242ac120002 full_slug: faq-order-tracking translation_banner: true \ No newline at end of file diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/how_to_cancel_services/images/cancel_exchange.png b/pages/account_and_service_management/managing_billing_payments_and_services/how_to_cancel_services/images/cancel_exchange.png deleted file mode 100644 index fb46468ba15..00000000000 Binary files a/pages/account_and_service_management/managing_billing_payments_and_services/how_to_cancel_services/images/cancel_exchange.png and /dev/null differ diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/invoice_management/images/action-choices_ca.png b/pages/account_and_service_management/managing_billing_payments_and_services/invoice_management/images/action-choices_ca.png deleted file mode 100644 index b01b86b2008..00000000000 Binary files a/pages/account_and_service_management/managing_billing_payments_and_services/invoice_management/images/action-choices_ca.png and /dev/null differ diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/invoice_management/images/actions-choice.png b/pages/account_and_service_management/managing_billing_payments_and_services/invoice_management/images/actions-choice.png deleted file mode 100644 index ce4240a5b5a..00000000000 Binary files a/pages/account_and_service_management/managing_billing_payments_and_services/invoice_management/images/actions-choice.png and /dev/null differ diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/invoice_management/images/balance-payment.png b/pages/account_and_service_management/managing_billing_payments_and_services/invoice_management/images/balance-payment.png deleted file mode 100644 index 9f18ffbff09..00000000000 Binary files a/pages/account_and_service_management/managing_billing_payments_and_services/invoice_management/images/balance-payment.png and /dev/null differ diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/invoice_management/images/billing-section.png b/pages/account_and_service_management/managing_billing_payments_and_services/invoice_management/images/billing-section.png deleted file mode 100644 index fae10cdc182..00000000000 Binary files a/pages/account_and_service_management/managing_billing_payments_and_services/invoice_management/images/billing-section.png and /dev/null differ diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/invoice_management/images/billing-section_ca.png b/pages/account_and_service_management/managing_billing_payments_and_services/invoice_management/images/billing-section_ca.png deleted file mode 100644 index 7f8d61a92f9..00000000000 Binary files a/pages/account_and_service_management/managing_billing_payments_and_services/invoice_management/images/billing-section_ca.png and /dev/null differ diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/invoice_management/images/csv-export.png b/pages/account_and_service_management/managing_billing_payments_and_services/invoice_management/images/csv-export.png deleted file mode 100644 index 3f0d19f43b1..00000000000 Binary files a/pages/account_and_service_management/managing_billing_payments_and_services/invoice_management/images/csv-export.png and /dev/null differ diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/invoice_management/images/invoice-es.png b/pages/account_and_service_management/managing_billing_payments_and_services/invoice_management/images/invoice-es.png deleted file mode 100644 index 160b7282a17..00000000000 Binary files a/pages/account_and_service_management/managing_billing_payments_and_services/invoice_management/images/invoice-es.png and /dev/null differ diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/invoice_management/images/invoice-filter.png b/pages/account_and_service_management/managing_billing_payments_and_services/invoice_management/images/invoice-filter.png deleted file mode 100644 index b868792c095..00000000000 Binary files a/pages/account_and_service_management/managing_billing_payments_and_services/invoice_management/images/invoice-filter.png and /dev/null differ diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/invoice_management/images/invoice-ovh_ca.png b/pages/account_and_service_management/managing_billing_payments_and_services/invoice_management/images/invoice-ovh_ca.png deleted file mode 100644 index 7ce81121945..00000000000 Binary files a/pages/account_and_service_management/managing_billing_payments_and_services/invoice_management/images/invoice-ovh_ca.png and /dev/null differ diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/invoice_management/images/pay_debt_ca.png b/pages/account_and_service_management/managing_billing_payments_and_services/invoice_management/images/pay_debt_ca.png deleted file mode 100644 index 0e0fd298c69..00000000000 Binary files a/pages/account_and_service_management/managing_billing_payments_and_services/invoice_management/images/pay_debt_ca.png and /dev/null differ diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/invoice_management/images/payment_tracking_ca.png b/pages/account_and_service_management/managing_billing_payments_and_services/invoice_management/images/payment_tracking_ca.png deleted file mode 100644 index 706d21bd007..00000000000 Binary files a/pages/account_and_service_management/managing_billing_payments_and_services/invoice_management/images/payment_tracking_ca.png and /dev/null differ diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/invoice_management/images/sort_filters_ca.png b/pages/account_and_service_management/managing_billing_payments_and_services/invoice_management/images/sort_filters_ca.png deleted file mode 100644 index a896a6db007..00000000000 Binary files a/pages/account_and_service_management/managing_billing_payments_and_services/invoice_management/images/sort_filters_ca.png and /dev/null differ diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/manage-payment-methods/images/bank-account.png b/pages/account_and_service_management/managing_billing_payments_and_services/manage-payment-methods/images/bank-account.png deleted file mode 100644 index 13d5d0d70b3..00000000000 Binary files a/pages/account_and_service_management/managing_billing_payments_and_services/manage-payment-methods/images/bank-account.png and /dev/null differ diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/manage-payment-methods/images/choose-payment-method.png b/pages/account_and_service_management/managing_billing_payments_and_services/manage-payment-methods/images/choose-payment-method.png deleted file mode 100644 index 1a1cfa85400..00000000000 Binary files a/pages/account_and_service_management/managing_billing_payments_and_services/manage-payment-methods/images/choose-payment-method.png and /dev/null differ diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/manage-payment-methods/images/hubpayment.png b/pages/account_and_service_management/managing_billing_payments_and_services/manage-payment-methods/images/hubpayment.png deleted file mode 100644 index 6310ceee009..00000000000 Binary files a/pages/account_and_service_management/managing_billing_payments_and_services/manage-payment-methods/images/hubpayment.png and /dev/null differ diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/manage-payment-methods/images/managepaymentmethods1.png b/pages/account_and_service_management/managing_billing_payments_and_services/manage-payment-methods/images/managepaymentmethods1.png deleted file mode 100644 index edb8e93e4d8..00000000000 Binary files a/pages/account_and_service_management/managing_billing_payments_and_services/manage-payment-methods/images/managepaymentmethods1.png and /dev/null differ diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/manage-payment-methods/images/managepaymentmethods2b.png b/pages/account_and_service_management/managing_billing_payments_and_services/manage-payment-methods/images/managepaymentmethods2b.png deleted file mode 100644 index 7db54d192c6..00000000000 Binary files a/pages/account_and_service_management/managing_billing_payments_and_services/manage-payment-methods/images/managepaymentmethods2b.png and /dev/null differ diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/manage-payment-methods/images/split-payment.png b/pages/account_and_service_management/managing_billing_payments_and_services/manage-payment-methods/images/split-payment.png deleted file mode 100644 index e41525e421d..00000000000 Binary files a/pages/account_and_service_management/managing_billing_payments_and_services/manage-payment-methods/images/split-payment.png and /dev/null differ diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/manage-payment-methods/images/yousign.png b/pages/account_and_service_management/managing_billing_payments_and_services/manage-payment-methods/images/yousign.png deleted file mode 100644 index 95c78f24a34..00000000000 Binary files a/pages/account_and_service_management/managing_billing_payments_and_services/manage-payment-methods/images/yousign.png and /dev/null differ diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/managing_ovh_orders/guide.de-de.md b/pages/account_and_service_management/managing_billing_payments_and_services/managing_ovh_orders/guide.de-de.md index 1a90b2cb18e..22313b12ac5 100644 --- a/pages/account_and_service_management/managing_billing_payments_and_services/managing_ovh_orders/guide.de-de.md +++ b/pages/account_and_service_management/managing_billing_payments_and_services/managing_ovh_orders/guide.de-de.md @@ -81,7 +81,7 @@ Das folgende Fenster wird angezeigt, um den Status anhand von vier Schritten anz ### Widerrufsrecht ausüben -In Artikel 14.1.1 unserer [Allgemeinen Geschäftsbedingungen](https://contract.eu.ovhapis.com/1.0/pdf/contrat_genServices-de.pdf){.action} heißt es: "*Sie haben das Recht, binnen vierzehn Tagen ohne Angabe von Gründen diesen Vertrag zu widerrufen. Die Widerrufsfrist beträgt vierzehn Tage ab dem Tag des Vertragsabschlusses.*" +In Artikel 14.1.1 unserer [Allgemeinen Geschäftsbedingungen](https://contract.eu.ovhapis.com/1.0/pdf/contrat_genServices-de.pdf) heißt es: "*Sie haben das Recht, binnen vierzehn Tagen ohne Angabe von Gründen diesen Vertrag zu widerrufen. Die Widerrufsfrist beträgt vierzehn Tage ab dem Tag des Vertragsabschlusses.*" Weitere Informationen zur Ausübung ihres Widerrufsrechts finden Sie in unseren AGB. diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/managing_ovh_orders/guide.en-gb.md b/pages/account_and_service_management/managing_billing_payments_and_services/managing_ovh_orders/guide.en-gb.md index eeb9653454d..011050bf71b 100644 --- a/pages/account_and_service_management/managing_billing_payments_and_services/managing_ovh_orders/guide.en-gb.md +++ b/pages/account_and_service_management/managing_billing_payments_and_services/managing_ovh_orders/guide.en-gb.md @@ -81,7 +81,7 @@ The window below will appear, allowing you to follow it in four steps. ### Apply the right of withdrawal -Article 14.1.2 of our [General Terms of Service](https://contract.eu.ovhapis.com/1.0/pdf/contrat_genServices-gb.pdf){.action} states that "*Pursuant to the Consumer Contracts Regulations 2013, the Client enjoys the statutory right of cancellation. Client may exercise this right, without having to justify its reasons nor pay any penalties other than any return fees, within a period of fourteen (14) days from the day after the Order.*" +Article 14.1.2 of our [General Terms of Service](https://contract.eu.ovhapis.com/1.0/pdf/contrat_genServices-gb.pdf) states that "*Pursuant to the Consumer Contracts Regulations 2013, the Client enjoys the statutory right of cancellation. Client may exercise this right, without having to justify its reasons nor pay any penalties other than any return fees, within a period of fourteen (14) days from the day after the Order.*" The terms and conditions for the right of withdrawal can be found in the remainder of that article. diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/managing_ovh_orders/guide.en-ie.md b/pages/account_and_service_management/managing_billing_payments_and_services/managing_ovh_orders/guide.en-ie.md index e1b8a91d546..b64ec7b4470 100644 --- a/pages/account_and_service_management/managing_billing_payments_and_services/managing_ovh_orders/guide.en-ie.md +++ b/pages/account_and_service_management/managing_billing_payments_and_services/managing_ovh_orders/guide.en-ie.md @@ -82,7 +82,7 @@ The window below will appear, allowing you to follow it in four steps. ### Apply the right of withdrawal -Article 14.1.2 of our [General Terms of Service](https://contract.eu.ovhapis.com/1.0/pdf/contrat_genServices-gb.pdf){.action} states that "*Pursuant to the Consumer Contracts Regulations 2013, the Client enjoys the statutory right of cancellation. Client may exercise this right, without having to justify its reasons nor pay any penalties other than any return fees, within a period of fourteen (14) days from the day after the Order.*" +Article 14.1.2 of our [General Terms of Service](https://contract.eu.ovhapis.com/1.0/pdf/contrat_genServices-gb.pdf) states that "*Pursuant to the Consumer Contracts Regulations 2013, the Client enjoys the statutory right of cancellation. Client may exercise this right, without having to justify its reasons nor pay any penalties other than any return fees, within a period of fourteen (14) days from the day after the Order.*" The terms and conditions for the right of withdrawal can be found in the remainder of that article. diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/managing_ovh_orders/guide.fr-fr.md b/pages/account_and_service_management/managing_billing_payments_and_services/managing_ovh_orders/guide.fr-fr.md index d3b25ef5b80..e50fb22fc15 100644 --- a/pages/account_and_service_management/managing_billing_payments_and_services/managing_ovh_orders/guide.fr-fr.md +++ b/pages/account_and_service_management/managing_billing_payments_and_services/managing_ovh_orders/guide.fr-fr.md @@ -82,7 +82,7 @@ La fenêtre ci-dessous apparaît, vous permettant un suivi en quatre étapes. ### Appliquer le droit de rétractation -L'article 12.1.2 de nos [Conditions Générales de Service](https://www.ovh.com/fr/support/documents_legaux/conditions%20generales%20de%20service.pdf){.action} précise que « *les clients ayant la qualité de consommateur au sens de l’article liminaire du Code de la consommation, bénéficient d'un droit de rétractation de 14 jours* ». +L'article 12.1.2 de nos [Conditions Générales de Service](https://www.ovh.com/fr/support/documents_legaux/conditions%20generales%20de%20service.pdf) précise que « *les clients ayant la qualité de consommateur au sens de l’article liminaire du Code de la consommation, bénéficient d'un droit de rétractation de 14 jours* ». Vous trouverez toutes les modalités d'application du droit de rétractation dans la suite de ce même article. diff --git a/pages/account_and_service_management/managing_billing_payments_and_services/purchase_order/images/internalreference00.png b/pages/account_and_service_management/managing_billing_payments_and_services/purchase_order/images/internalreference00.png deleted file mode 100644 index 694feb5d49b..00000000000 Binary files a/pages/account_and_service_management/managing_billing_payments_and_services/purchase_order/images/internalreference00.png and /dev/null differ diff --git a/pages/account_and_service_management/reversibility/18-logs-data-platform-reversibility/guide.fr-fr.md b/pages/account_and_service_management/reversibility/18-logs-data-platform-reversibility/guide.fr-fr.md index fe71bb13807..fb7bd979d3a 100644 --- a/pages/account_and_service_management/reversibility/18-logs-data-platform-reversibility/guide.fr-fr.md +++ b/pages/account_and_service_management/reversibility/18-logs-data-platform-reversibility/guide.fr-fr.md @@ -1,5 +1,5 @@ --- -title: "Politique de réversibilité du produit Managed Log Manager" +title: "Reversibility Policy for the Managed Log Manager product" updated: 2025-07-08 --- diff --git a/pages/account_and_service_management/startup-program/00-apply-to-newsletter/guide.en-gb.md b/pages/account_and_service_management/startup-program/00-apply-to-newsletter/guide.en-gb.md new file mode 100644 index 00000000000..0942a018bb8 --- /dev/null +++ b/pages/account_and_service_management/startup-program/00-apply-to-newsletter/guide.en-gb.md @@ -0,0 +1,27 @@ +--- +title: "Startup Program - How to apply to our newsletter?" +excerpt: 'Find out how to subscribe to the OVHcloud Startup Program newsletter and stay up to date with the latest news and exclusive offers' +updated: 2025-10-14 +--- + +## Introduction + +At OVHcloud, we believe in the importance of staying connected with our community. That's why we created a newsletter accessible to everyone, whether you're a customer or not. By subscribing to our newsletter, you'll gain access to valuable information about our Startup Program, our ecosystem, and our partners, including incubators, accelerators, and venture capitalists. Each month, we will provide you with updates, exclusive offers, showcases of our best startups, and details about our upcoming events. + +## Key Points + +- **Accessibility**: Anyone can subscribe to the newsletter, whether they are an OVHcloud customer or not. +- **Rich content**: Receive monthly information about the Startup Program, partners, and news from our ecosystem. +- **Exclusive offers**: Enjoy useful OVHcloud offers for the server infrastructure of startups. +- **Startup highlights**: Discover a selection of our best startups each month. +- **Upcoming events**: Stay informed about upcoming events where you can meet our team and community. + +## Steps to Follow + +1. **Visit our Website**: Go to the [OVHcloud Startup Program website](/links/transversal/startup-program). +2. **Fill out the form**: Complete the form with your information. Make sure to provide a valid email address to receive the newsletter. +3. **Enjoy the benefits**: Once subscribed, you can expect to receive our newsletter each month, filled with useful information and exclusive offers. + +## Conclusion + +Subscribing to the OVHcloud newsletter is a great way to stay updated on the latest news and activities within our ecosystem. Whether you are a member of the Startup Program, an alumnus, a partner, or simply interested in the startup world, our newsletter will provide you with valuable resources and exciting opportunities. Don’t miss this chance to join our community and take advantage of everything we have to offer! \ No newline at end of file diff --git a/pages/account_and_service_management/startup-program/00-apply-to-newsletter/guide.fr-fr.md b/pages/account_and_service_management/startup-program/00-apply-to-newsletter/guide.fr-fr.md new file mode 100644 index 00000000000..b97ad3ed848 --- /dev/null +++ b/pages/account_and_service_management/startup-program/00-apply-to-newsletter/guide.fr-fr.md @@ -0,0 +1,27 @@ +--- +title: "Comment souscrire à notre newsletter Startup Program" +excerpt: "Découvrez comment souscrire à la newsletter du Startup Program d'OVHcloud et rester informé des dernières actualités et offres exclusives" +updated: 2025-10-14 +--- + +## Introduction + +Chez OVHcloud, nous croyons en l'importance de rester connecté avec notre communauté. C'est pourquoi nous avons créé une newsletter accessible à tous, clients ou non. En vous inscrivant à notre newsletter, vous aurez accès à des informations précieuses sur notre Startup Program, notre écosystème, et nos partenaires, tels que des incubateurs, des accélérateurs et des investisseurs en capital-risque. Chaque mois, nous vous fournirons des mises à jour, des offres exclusives, des présentations de nos meilleures startups et des détails sur nos prochains événements. + +## Points clés + +- **Accessibilité** : Tout le monde peut s'inscrire à la newsletter, qu'il soit client d'OVHcloud ou non. +- **Contenu riche** : Recevez des informations mensuelles sur le Startup Program, les partenaires et les nouvelles de notre écosystème. +- **Offres exclusives** : Profitez d'offres OVHcloud utiles aux infrastructures serveur des startups. +- **Mise en avant des startups** : Découvrez chaque mois une sélection de nos meilleures startups. +- **Événements à venir** : Restez informé des événements à venir où vous pouvez rencontrer notre équipe et notre communauté. + +## Étapes à suivre + +1. **Visitez notre site web** : Rendez-vous sur le [site web du Startup Program d'OVHcloud](/links/transversal/startup-program). +2. **Remplissez le formulaire** : Complétez le formulaire avec vos informations. Assurez-vous de fournir une adresse e-mail valide pour recevoir la newsletter. +3. **Profitez des avantages** : Une fois inscrit, attendez-vous à recevoir notre newsletter chaque mois, remplie d'informations utiles et d'offres exclusives. + +## Conclusion + +S'inscrire à la newsletter d'OVHcloud est une excellente manière de rester informé des dernières nouvelles et des activités de notre écosystème. Que vous soyez membre du Startup Program, alumnus, partenaire ou simplement intéressé par le monde des startups, notre newsletter vous fournira des ressources précieuses et des opportunités intéressantes. Ne manquez pas cette chance de rejoindre notre communauté et de bénéficier de tout ce que nous avons à offrir ! \ No newline at end of file diff --git a/pages/account_and_service_management/startup-program/00-apply-to-newsletter/meta.yaml b/pages/account_and_service_management/startup-program/00-apply-to-newsletter/meta.yaml new file mode 100644 index 00000000000..f3cb3891208 --- /dev/null +++ b/pages/account_and_service_management/startup-program/00-apply-to-newsletter/meta.yaml @@ -0,0 +1,2 @@ +id: ac46779d-1e72-45ce-b7b2-455eed408963 +full_slug: startup-program-newsletter-application \ No newline at end of file diff --git a/pages/account_and_service_management/startup-program/01-optimise-application/guide.en-gb.md b/pages/account_and_service_management/startup-program/01-optimise-application/guide.en-gb.md new file mode 100644 index 00000000000..a2283400299 --- /dev/null +++ b/pages/account_and_service_management/startup-program/01-optimise-application/guide.en-gb.md @@ -0,0 +1,58 @@ +--- +title: "How to optimise your application to the Startup Program" +excerpt: 'Find out how to optimise your application to the OVHcloud Startup Program to maximise your chances of acceptance' +updated: 2025-10-14 +--- + +## Objective + +OVHcloud's Startup Program offers numerous benefits to support startups in their growth. + +**To maximize your chances of acceptance, follow these steps to prepare and complete your application.** + +## Requirements + +- An [OVHcloud account](/pages/account_and_service_management/account_information/ovhcloud-account-creation). +- Access to the [OVHcloud Control Panel](/links/manager). + +## Instructions + +### Step 1 - Update your OVHcloud account + +Ensure your OVHcloud account is correctly configured before submitting your application. + +Select `Company` as legal form and complete the required information: +Provide the SIRET (only for accounts in France), VAT number, company address, and the personal information of the account holder. Use a professional email address associated with your company domain. Please also enter a backup email address (preferably a personal email address). + +![Account type](images/01-account-type.png){.thumbnail} + +Refer to this guide for more information: [Securing my OVHcloud account and managing my personal information](/pages/account_and_service_management/account_information/all_about_username). + +### Step 2 - Add a valid payment method + +A valid payment method is required to ensure the continuity of your services. It will be used for non-eligible products during your participation in the program and for all products after the program ends. + +Refer to this guide for more information: [Managing payment methods](/pages/account_and_service_management/managing_billing_payments_and_services/manage-payment-methods). + +![Payment method](images/02-payment-mean.png){.thumbnail} + +### Step 3 - Carefully complete the Startup Program application form + +To allow us to effectively review your application, complete the form with accuracy and detail. + +**Essential information to provide:** + +- Company name +- Website +- Social media (LinkedIn, X) +- Description of your project and business model +- Server infrastructure needs +- Stage of development of your project + +**Precision and completeness**: Any missing or incorrect information could result in your application being rejected or delays if updates are required. + +### Processing time + +Applications are reviewed within 7 days. To expedite the process, ensure all required information is provided during the initial submission. + +By following these steps, you will significantly increase your chances of being accepted into OVHcloud’s Startup Program. \ No newline at end of file diff --git a/pages/account_and_service_management/startup-program/01-optimise-application/guide.fr-fr.md b/pages/account_and_service_management/startup-program/01-optimise-application/guide.fr-fr.md new file mode 100644 index 00000000000..87f16cb905b --- /dev/null +++ b/pages/account_and_service_management/startup-program/01-optimise-application/guide.fr-fr.md @@ -0,0 +1,57 @@ +--- +title: "Comment optimiser votre candidature au Startup Program" +excerpt: "Découvrez comment optimiser votre candidature au Startup Program d'OVHcloud pour maximiser vos chances d'acceptation" +updated: 2025-10-14 +--- + +## Objectif + +Le Startup Program d'OVHcloud offre de nombreux avantages pour soutenir les startups dans leur développement. + +**Pour maximiser vos chances d'acceptation, ce guide vous détaille les étapes à suivre pour préparer et finaliser votre inscription.** + +## Prérequis + +- Avoir créé [votre compte OVHcloud](/pages/account_and_service_management/account_information/ovhcloud-account-creation). +- Être connecté à votre [espace client OVHcloud](/links/manager). + +## En pratique + +### Etape 1 - Mettre à jour votre compte OVHcloud + +Assurez-vous que votre compte OVHcloud est correctement configuré avant de soumettre votre candidature. + +Sélectionnez le statut `Entreprise` et complétez les informations requises. Renseignez le SIRET, le numéro de TVA, l'adresse de la société ainsi que les informations personnelles du titulaire du compte. Utilisez une adresse e-mail professionnelle associée au nom de domaine de votre entreprise. Renseignez également une adresse e-mail de secours (privilégiez une adresse e-mail personnelle). + +![Type de compte](images/01-account-type.png){.thumbnail} + +Pour plus d'informations, consultez ce guide : [Sécuriser mon compte OVHcloud et gérer mes informations personnelles](/pages/account_and_service_management/account_information/all_about_username). + +### Etape 2 - Ajouter un moyen de paiement valide + +Un moyen de paiement valide est requis pour garantir la continuité de vos services. Il sera utilisé pour les produits non éligibles pendant votre participation au programme et pour tous les produits après la fin du programme. + +Consultez ce guide pour plus d'informations : [Gérer mes moyens de paiement](/pages/account_and_service_management/managing_billing_payments_and_services/manage-payment-methods). + +![Moyen de paiement](images/02-payment-mean.png){.thumbnail} + +### Etape 3 - Remplir soigneusement le formulaire d'inscription au Startup Program + +Pour nous permettre d'étudier efficacement votre candidature, complétez le formulaire d'inscription avec précision et détail. + +**Informations essentielles à renseigner** : + +- Nom de votre société +- Site web +- Réseaux sociaux (LinkedIn, X) +- Description de votre projet et de votre modèle économique +- Besoins en infrastructure serveur +- État d'avancement de votre projet + +**Précision et complétude** : Toute information manquante ou incorrecte pourrait entraîner le rejet de votre inscription ou des délais supplémentaires en cas de demande de mise à jour. + +### Délai de traitement + +Les inscriptions sont analysées sous 7 jours. Afin d'accélérer le processus, veillez à fournir toutes les informations demandées dès la première soumission. + +En suivant ces étapes, vous augmenterez significativement vos chances d’être accepté au Startup Program d’OVHcloud. \ No newline at end of file diff --git a/pages/account_and_service_management/startup-program/01-optimise-application/images/01-account-type.png b/pages/account_and_service_management/startup-program/01-optimise-application/images/01-account-type.png new file mode 100644 index 00000000000..44941be7d56 Binary files /dev/null and b/pages/account_and_service_management/startup-program/01-optimise-application/images/01-account-type.png differ diff --git a/pages/account_and_service_management/startup-program/01-optimise-application/images/02-payment-mean.png b/pages/account_and_service_management/startup-program/01-optimise-application/images/02-payment-mean.png new file mode 100644 index 00000000000..030ab8c9c31 Binary files /dev/null and b/pages/account_and_service_management/startup-program/01-optimise-application/images/02-payment-mean.png differ diff --git a/pages/account_and_service_management/startup-program/01-optimise-application/meta.yaml b/pages/account_and_service_management/startup-program/01-optimise-application/meta.yaml new file mode 100644 index 00000000000..71c24934426 --- /dev/null +++ b/pages/account_and_service_management/startup-program/01-optimise-application/meta.yaml @@ -0,0 +1,2 @@ +id: 2c655aa3-e463-4161-a615-13bc790037f0 +full_slug: startup-program-optimise-application \ No newline at end of file diff --git a/pages/account_and_service_management/startup-program/02-sign-agreement/guide.en-gb.md b/pages/account_and_service_management/startup-program/02-sign-agreement/guide.en-gb.md new file mode 100644 index 00000000000..a732831a604 --- /dev/null +++ b/pages/account_and_service_management/startup-program/02-sign-agreement/guide.en-gb.md @@ -0,0 +1,45 @@ +--- +title: "How to sign your Startup Program contract" +excerpt: 'Find out how to sign your OVHcloud Startup Program contract to activate your credits quickly' +updated: 2025-10-14 +--- + +## Objective + +To participate in the OVHcloud Startup Program, signing the contract is an essential step. Once your application is accepted, you will receive an email containing a direct link to sign the contract. You can also find the contract in your OVHcloud Control Panel. + +**This guide explains how to access and sign this contract so that your credits are activated quickly.** + +## Requirements + +- Your Startup Program application must have been validated. Find more information in our guide "[How to optimize your Startup Program application](/pages/account_and_service_management/startup-program/01-optimise-application)". +- Access to the [OVHcloud Control Panel](/links/manager). + +## Instructions + +### Signing the contract via email + +Check your inbox: After your Startup Program application is accepted, an email will be sent to the address linked to your OVHcloud account. This email contains a direct link to sign the contract. Click on the link and follow the instructions to complete the signature. + +### Signing the contract via the OVHcloud Control Panel + +If you cannot find the email, you can access the contract directly in your [OVHcloud Control Panel](/links/manager). + +Make sure to log in with the account you used to apply for the Startup Program. From the homepage, click on your name in the top right corner and then click on `My offers and services`{.action}. + +![products and services](images/01-products-services.png){.thumbnail} + +Select the `Contracts`{.action} tab. + +![my services - contracts](images/02-services-contracts.png){.thumbnail} + +Look for your Startup Program contract in the `My contracts to confirm` section. + +Click the `...`{.action} button to the right of the contract to download and review it.
+Click the `...`{.action} button again and select `Accept` to validate the contract acceptance. + +![my contracts](images/03-my-contracts.png){.thumbnail} + +After signing, your credits will be credited to your account within 48 business hours, and you will be able to fully benefit from the program's advantages. + +Your signed contract will remain available in the `Contracts`{.action} tab of your Control Panel for reference at any time. \ No newline at end of file diff --git a/pages/account_and_service_management/startup-program/02-sign-agreement/guide.fr-fr.md b/pages/account_and_service_management/startup-program/02-sign-agreement/guide.fr-fr.md new file mode 100644 index 00000000000..cb129c82b94 --- /dev/null +++ b/pages/account_and_service_management/startup-program/02-sign-agreement/guide.fr-fr.md @@ -0,0 +1,45 @@ +--- +title: "Comment signer votre contrat du Startup Program" +excerpt: "Découvrez comment signer votre contrat du Startup Program d'OVHcloud pour activer vos crédits rapidement" +updated: 2025-10-14 +--- + +## Objectif + +Pour participer au Startup Program d'OVHcloud, la signature du contrat est une étape indispensable. Une fois votre candidature acceptée, vous recevrez un e-mail contenant un lien direct pour signer le contrat. Il est également possible de retrouver le contrat dans votre espace client OVHcloud. + +**Ce guide vous explique comment accéder à ce contrat et le signer pour que vos crédits soient activés rapidement** + +## Prérequis + +- Votre candidature au Startup Program doit avoir été validée. Retrouvez plus d'informations dans notre guide « [Comment optimiser votre candidature au Startup Program](/pages/account_and_service_management/startup-program/01-optimise-application) ». +- Être connecté à votre [espace client OVHcloud](/links/manager). + +## En pratique + +### Signer le contrat via l’e-mail + +Vérifiez votre boîte de réception : Après l'acceptation de votre candidature au Startup Program, un e-mail sera envoyé à l'adresse liée à votre compte OVHcloud. Cet e-mail contient un lien direct pour signer le contrat. Cliquez sur le lien et suivez les instructions pour finaliser la signature. + +### Signer le contrat via l’espace client OVHcloud + +Si vous ne trouvez pas l'e-mail, vous pouvez accéder au contrat directement dans votre [espace client OVHcloud](/links/manager). + +Assurez-vous de vous connecter avec le compte que vous avez utilisé pour l’inscription au Startup Program. Depuis la page d’accueil, cliquez sur votre nom en haut à droite puis cliquez sur `Mes offres & services`{.action}. + +![produits et services](images/01-products-services.png){.thumbnail} + +Sélectionnez l’onglet `Contrats`{.action}. + +![mes services - contrats](images/02-services-contracts.png){.thumbnail} + +Recherchez votre contrat Startup Program dans la section `Mes contrats à signer`. + +Cliquez sur e bouton `...`{.action} à droite du contrat pour le télécharger et en prendre connaissance.
+Cliquez à nouveau sur le bouton `...`{.action} et sélectionnez `Accepter` pour valider l'acceptation du contrat. + +![mes contrats](images/03-my-contracts.png){.thumbnail} + +Après la signature, vos crédits seront crédités sur votre compte sous 48 heures ouvrées et vous pourrez profiter pleinement des avantages du programme. + +Votre contrat signé restera disponible dans l’onglet `Contrats`{.action} de votre espace client pour être consulté à tout moment. \ No newline at end of file diff --git a/pages/account_and_service_management/startup-program/02-sign-agreement/images/01-products-services.png b/pages/account_and_service_management/startup-program/02-sign-agreement/images/01-products-services.png new file mode 100644 index 00000000000..0c301a9c666 Binary files /dev/null and b/pages/account_and_service_management/startup-program/02-sign-agreement/images/01-products-services.png differ diff --git a/pages/account_and_service_management/startup-program/02-sign-agreement/images/02-services-contracts.png b/pages/account_and_service_management/startup-program/02-sign-agreement/images/02-services-contracts.png new file mode 100644 index 00000000000..d469fa085e6 Binary files /dev/null and b/pages/account_and_service_management/startup-program/02-sign-agreement/images/02-services-contracts.png differ diff --git a/pages/account_and_service_management/startup-program/02-sign-agreement/images/03-my-contracts.png b/pages/account_and_service_management/startup-program/02-sign-agreement/images/03-my-contracts.png new file mode 100644 index 00000000000..a6d698936f3 Binary files /dev/null and b/pages/account_and_service_management/startup-program/02-sign-agreement/images/03-my-contracts.png differ diff --git a/pages/account_and_service_management/startup-program/02-sign-agreement/meta.yaml b/pages/account_and_service_management/startup-program/02-sign-agreement/meta.yaml new file mode 100644 index 00000000000..65a84af7ef8 --- /dev/null +++ b/pages/account_and_service_management/startup-program/02-sign-agreement/meta.yaml @@ -0,0 +1,2 @@ +id: 828b2fc4-af6b-4fcf-8349-93cb7ea5fa70 +full_slug: startup-program-sign-contract \ No newline at end of file diff --git a/pages/account_and_service_management/startup-program/03-contact-manager/guide.en-gb.md b/pages/account_and_service_management/startup-program/03-contact-manager/guide.en-gb.md new file mode 100644 index 00000000000..bfef64812dc --- /dev/null +++ b/pages/account_and_service_management/startup-program/03-contact-manager/guide.en-gb.md @@ -0,0 +1,46 @@ +--- +title: "How to contact a Startup Program manager and/or request a technical consultation" +excerpt: 'Contact an OVHcloud Startup Program manager for advice, technical consultation or information about the program' +updated: 2025-10-14 +--- + +## Objective + +As a member of the OVHcloud Startup Program, you can contact our Startup Program Managers to address a variety of questions and needs. Whether you want to better understand the program's benefits, request a technical consultation for your server infrastructure, discover our products, explore partnership opportunities, or learn where to meet us at events, our teams are here to guide you.
+You can also consult them for advice on using your free credits.
+All these elements are covered in detail during your onboarding session at the start of the program, but our Startup Program Managers remain available for ongoing support. + +## Key points + +- **General questions about the Startup Program**: Our Startup Program Managers are available to answer any questions about the OVHcloud Startup Program and its support offerings. +- **Technical support**: As a member of the OVHcloud Startup Program, you receive technical support hours for your server infrastructure. These sessions are designed to help you evaluate whether your infrastructure meets your needs and, if not, to evolve it with the assistance of our technical experts. +- **Technical incident**: For any questions related to an order or ongoing incident affecting one of your services, we recommend [contacting our sales and technical support teams directly](https://help.ovhcloud.com/csm?id=csm_get_help) before reaching out to our Startup Program team. + +## Instructions + +### Contact us by email + +You can contact our Startup Program Managers by email for any questions or assistance related to the Startup Program, including technical consultations. Please select the appropriate email address based on your geographic zone. The table below will help you identify the correct address according to your physical location, ensuring you are connected with the team in your region. + +| Zone | Mailing list | +|---|---| +| France, Belgium, Netherlands, Luxembourg | frbenelux-startup@ovh.com | +| Africa and Middle East | africa-me-startup@ovh.com | +| Northern Europe | ne-startup@ovh.com | +| Asia and Pacific | apac-startup@ovh.com | +| Central Europe (Germany, Austria, Switzerland) | dach-startup@ovh.com | +| North America | america-startup@ovh.com | +| Eastern Europe | cee-startup@ovh.com | +| Southern Europe | se-startup@ovh.com | + +### Contact a Startup Program Manager directly + +If you are already in contact with or have met one of our Startup Program Managers, you can reach them directly via LinkedIn. Find the full list of our Startup Program Managers on [our website](/links/transversal/startup-program-faq-managers). + +### Meet our teams at events + +We organize or participate in numerous events where our Startup Program Managers are available to answer your questions and introduce you to the OVHcloud Startup Program. Check the full list of our events on [our website](/links/transversal/events-startup). + +## Conclusion + +OVHcloud's Startup Program offers you personalized support throughout your journey. Whether you need advice on using your credits, collaboration opportunities, or technical consultations, our Startup Program Managers are here to help. Feel free to contact them by email, meet them in person at events, or reach out via LinkedIn. For urgent technical issues, our support and sales teams are also available to assist you. We look forward to supporting the growth of your startup and helping you achieve success. \ No newline at end of file diff --git a/pages/account_and_service_management/startup-program/03-contact-manager/guide.fr-fr.md b/pages/account_and_service_management/startup-program/03-contact-manager/guide.fr-fr.md new file mode 100644 index 00000000000..c3d6807b1a4 --- /dev/null +++ b/pages/account_and_service_management/startup-program/03-contact-manager/guide.fr-fr.md @@ -0,0 +1,46 @@ +--- +title: "Comment contacter un responsable du Startup Program et/ou demander une consultation technique" +excerpt: "Contactez un responsable du Startup Program d'OVHcloud pour obtenir des conseils, une consultation technique ou des informations sur le programme" +updated: 2025-10-14 +--- + +## Objectif + +En tant que membre du Startup Program d'OVHcloud, vous avez la possibilité de contacter nos Startup Program Managers pour leur poser toutes vos questions et leur faire part de vos besoins. Que ce soit pour mieux comprendre les bénéfices du programme, demander à participer à une consultation technique sur votre infrastructure serveur, découvrir nos produits, explorer des opportunités de partenariat, ou encore savoir où nous rencontrer lors d'événements, nos équipes sont là pour vous guider.
+Vous pouvez également les solliciter pour des conseils sur l’utilisation de vos crédits gratuits.
+Tous ces éléments sont couverts en détail lors de votre session d'onboarding au début du programme, mais nos Startup Program Managers restent à votre disposition pour un accompagnement continu. + +## Points clés + +- **Questions générales sur le Startup Program** : Nos Startup Program Managers sont disponibles pour répondre à toute question portant sur le Startup Program d'OVHcloud et son accompagnement. +- **Accompagnement technique** : En tant que membre du Startup Program d'OVHcloud, vous bénéficiez d'heures d'accompagnement techniques portant sur votre infrastructure serveur. Ces accompagnements sont faits pour vous aider à évaluer la capacité de votre infrastructure serveur à répondre correctement à vos besoins et à la faire évoluer dans le cas contraire, grâce à l'aide apportée par nos experts techniques. +- **Incident technique** : Pour toute question relative à une commande ou à un incident en cours affectant l’un de vos services, nous vous invitons à [contacter impérativement nos équipes commerciales et de support technique](https://help.ovhcloud.com/csm?id=csm_get_help) avant de solliciter notre équipe Startup Program. + +## En pratique + +### Nous contacter par e-mail + +Vous pouvez contacter nos Startup Program Managers par e-mail pour toute question ou demande d’assistance en rapport avec le Startup Program, ainsi que pour bénéficier de consultations techniques. Veuillez toutefois choisir l’adresse e-mail appropriée en fonction de votre zone géographique. Le tableau ci-dessous vous aidera à identifier l’adresse à utiliser selon votre emplacement physique, afin que vous soyez mis en relation avec l’équipe correspondant à votre région. + +| Zone | Mailing list | +|---|---| +| France, Belgique, Pays-bas et Luxembourg | frbenelux-startup@ovh.com | +| Afrique et Moyen-Orient | africa-me-startup@ovh.com | +| Europe du Nord | ne-startup@ovh.com | +| Asie et Pacifique | apac-startup@ovh.com | +| Europe Centrale (Allemagne, Autriche et Suisse) | dach-startup@ovh.com | +| Amérique du Nord | america-startup@ovh.com | +| Europe de l'est | cee-startup@ovh.com | +| Europe du Sud | se-startup@ovh.com | + +### Contacter un Startup Program Manager en direct + +Si vous êtes déjà en contact ou avez rencontré l'un de nos Startup Program Managers, vous pouvez les joindre directement via LinkedIn. Vous retrouverez la liste complète de nos Startup Program Managers sur [notre site web](/links/transversal/startup-program-faq-managers). + +### Rencontrer nos équipes lors d'événements + +Nous organisons ou participons à de nombreux événements où nos Startup Program Managers sont disponibles pour répondre à vos questions et vous faire découvrir le Startup Program d'OVHcloud. Vous pouvez consulter la liste complète de nos événements sur [notre site web](/links/transversal/events-startup). + +## Conclusion + +Le Startup Program d'OVHcloud vous offre un accompagnement personnalisé tout au long de votre parcours. Que ce soit pour des conseils sur l’utilisation de vos crédits, des opportunités de collaboration ou pour bénéficier de consultations techniques, nos Startup Program Managers sont là pour vous aider. N'hésitez pas à les contacter par e-mail, en personne lors d'événements, ou directement via LinkedIn. En cas de besoin technique urgent, nos équipes de support et commerciales restent également à votre disposition. Nous sommes impatients de vous soutenir dans le développement de votre startup et de vous accompagner vers le succès. \ No newline at end of file diff --git a/pages/account_and_service_management/startup-program/03-contact-manager/meta.yaml b/pages/account_and_service_management/startup-program/03-contact-manager/meta.yaml new file mode 100644 index 00000000000..56eac8b7b32 --- /dev/null +++ b/pages/account_and_service_management/startup-program/03-contact-manager/meta.yaml @@ -0,0 +1,2 @@ +id: 17e1bf63-3293-4a6c-918f-0ae07777ea23 +full_slug: startup-program-contact-managers \ No newline at end of file diff --git a/pages/account_and_service_management/startup-program/04-view-credits/guide.en-gb.md b/pages/account_and_service_management/startup-program/04-view-credits/guide.en-gb.md new file mode 100644 index 00000000000..836e4368d0b --- /dev/null +++ b/pages/account_and_service_management/startup-program/04-view-credits/guide.en-gb.md @@ -0,0 +1,43 @@ +--- +title: "How to check your Startup Program credits" +excerpt: 'Check your OVHcloud Startup Program credits to manage your resources and track your balance and usage history' +updated: 2025-10-14 +--- + +## Objective + +As a member of the OVHcloud Startup Program, you receive free credits to support the growth of your infrastructure. These credits are automatically activated within 48 business hours after signing your contract. It is important to regularly check your credit balance and usage history to better manage your resources. + +**This guide explains how to verify the amount of credits allocated, the remaining balance, and how to access the consumption history in your OVHcloud Control Panel.** + +## Requirements + +- Your Startup Program application must have been validated, and your contract signed. Find more information in our guides: + - [How to optimise your application to the Startup Program](/pages/account_and_service_management/startup-program/01-optimise-application) + - [How to sign your Startup Program contrac](/pages/account_and_service_management/startup-program/02-sign-agreement) +- Access to the [OVHcloud Control Panel](/links/manager). + +## Key points + +- **Credit activation**: Credits are automatically activated within 48 business hours after signing the Startup Program contract. +- **Validity period**: Credits are valid for 12 months from the contract’s signature date and are automatically removed at the end of this period. +- **Valid payment method**: A valid payment method must be linked to your account to ensure continuity of services after the credits expire or for services not eligible for the free credits. +- **Billing after expiration**: After the credits are removed, services will be charged via the default payment method linked to your account. + +## Instructions + +1. Log in to the [OVHcloud Control Panel](/links/manager). + +2. From the homepage, click on your name in the top right corner and then click on `My offers and services`{.action}. + + ![products and services](images/01-products-services.png){.thumbnail} + +3. In the left-hand menu, click on `My Payment Methods`{.action}. + +4. On the payment methods page, select the `My Vouchers`{.action} tab. Here, you will see the total amount of allocated credits, the expiration date, remaining credits, and the consumption history. + + ![vouchers](images/02-vouchers.png){.thumbnail} + +## Conclusion + +Managing and monitoring your credit usage within the OVHcloud Startup Program is crucial to optimizing your resources. Through your OVHcloud Control Panel, you can easily check your balance and consumption history. Remember that your credits are valid for 12 months after signing the contract, and a valid payment method must be linked to your account to ensure service continuity after the credits expire. Follow these steps to maximize the benefits and ensure smooth management of your services after the program ends. \ No newline at end of file diff --git a/pages/account_and_service_management/startup-program/04-view-credits/guide.fr-fr.md b/pages/account_and_service_management/startup-program/04-view-credits/guide.fr-fr.md new file mode 100644 index 00000000000..286f3fac6ef --- /dev/null +++ b/pages/account_and_service_management/startup-program/04-view-credits/guide.fr-fr.md @@ -0,0 +1,44 @@ +--- +title: "Comment consulter vos crédits du Startup Program" +excerpt: "Consultez vos crédits du Startup Program d'OVHcloud pour gérer vos ressources et suivre votre solde et historique de consommation" +updated: 2025-10-14 +--- + +## Objectif + +En tant que membre du Startup Program d'OVHcloud, vous bénéficiez de crédits offerts pour soutenir la croissance de votre infrastructure. Ces crédits sont activés automatiquement dans les 48 heures ouvrées suivant la signature de votre contrat. Il est important de consulter régulièrement votre solde de crédits et leur historique d’utilisation pour mieux gérer vos ressources. + +**Ce guide vous explique comment vérifier le montant de crédits attribués, restants, et comment accéder à l’historique de consommation dans votre espace client OVHcloud.** + +## Prérequis + +- Votre candidature au Startup Program doit avoir été validée et votre contrat signé. Retrouvez plus d'informations dans nos guides : + - [Comment optimiser votre candidature au Startup Program](/pages/account_and_service_management/startup-program/01-optimise-application) + - [Comment signer votre contrat du Startup Program](/pages/account_and_service_management/startup-program/02-sign-agreement) +- Être connecté à votre [espace client OVHcloud](/links/manager). + +## Points clés + +- **Activation des crédits** : Les crédits sont activés automatiquement dans les 48 heures ouvrées après la signature du contrat du Startup Program. +- **Durée de validité** : Les crédits sont valables pendant 12 mois à compter de la signature du contrat, et sont automatiquement supprimés à la fin de cette période. +- **Moyen de paiement valide** : Un moyen de paiement valide doit être lié à votre compte pour garantir la continuité des services après expiration des crédits ou pour les services non éligibles avec les crédits. +- **Facturation après expiration** : Après suppression des crédits, les services seront facturés via le moyen de paiement par défaut attaché à votre compte. + + +## En pratique + +1. Connectez-vous à [l'espace client OVHcloud](/links/manager). + +2. Depuis la page d’accueil, cliquez sur votre nom en haut à droite puis cliquez sur `Mes offres & services`{.action}. + + ![produits et services](images/01-products-services.png){.thumbnail} + +3. Dans le menu de gauche, cliquez sur `Mes moyens de paiement`{.action}. + +4. Une fois sur la page des moyens de paiement, sélectionnez l’onglet `Mes bons d'achat`{.action}. Ici, vous verrez le montant total de vos crédits attribués, la date d'expiration, les crédits restants, et l’historique de leur consommation. + + ![bons d'achat](images/02-vouchers.png){.thumbnail} + +## Conclusion + +Gérer et surveiller l’utilisation de vos crédits dans le cadre du Startup Program d'OVHcloud est essentiel pour optimiser vos ressources. Grâce à votre espace client, vous pouvez facilement consulter votre solde et l’historique de consommation. N'oubliez pas que vos crédits sont valables 12 mois après la signature du contrat et qu’un moyen de paiement valide doit être lié à votre compte pour assurer la continuité des services après l’expiration des crédits. Veillez donc à suivre ces étapes pour tirer le meilleur parti de vos avantages et garantir la bonne gestion de vos services après la fin du programme. \ No newline at end of file diff --git a/pages/account_and_service_management/startup-program/04-view-credits/images/01-products-services.png b/pages/account_and_service_management/startup-program/04-view-credits/images/01-products-services.png new file mode 100644 index 00000000000..0c301a9c666 Binary files /dev/null and b/pages/account_and_service_management/startup-program/04-view-credits/images/01-products-services.png differ diff --git a/pages/account_and_service_management/startup-program/04-view-credits/images/02-vouchers.png b/pages/account_and_service_management/startup-program/04-view-credits/images/02-vouchers.png new file mode 100644 index 00000000000..d10acb09172 Binary files /dev/null and b/pages/account_and_service_management/startup-program/04-view-credits/images/02-vouchers.png differ diff --git a/pages/account_and_service_management/startup-program/04-view-credits/meta.yaml b/pages/account_and_service_management/startup-program/04-view-credits/meta.yaml new file mode 100644 index 00000000000..c0cdc5c367b --- /dev/null +++ b/pages/account_and_service_management/startup-program/04-view-credits/meta.yaml @@ -0,0 +1,2 @@ +id: f66ac84c-0ebc-4f94-9eb7-054432bf1c5d +full_slug: startup-program-credits \ No newline at end of file diff --git a/pages/account_and_service_management/startup-program/05-pay-bill-with-credits/guide.en-gb.md b/pages/account_and_service_management/startup-program/05-pay-bill-with-credits/guide.en-gb.md new file mode 100644 index 00000000000..191b5278387 --- /dev/null +++ b/pages/account_and_service_management/startup-program/05-pay-bill-with-credits/guide.en-gb.md @@ -0,0 +1,59 @@ +--- +title: "How to pay a bill with your Startup Program credits" +excerpt: 'Find out how to pay your bills with your OVHcloud Startup Program credits to optimise your infrastructure expenditure' +updated: 2025-10-14 +--- + +## Objective + +As a member of the OVHcloud Startup Program, you have credits to support your projects and cover your infrastructure expenses. It is essential to understand how these credits can be used to pay your bills, whether for renewing existing services or placing new orders. + +**This guide explains how to use your credits optimally during orders or renewals, depending on the type of service.** + +## Requirements + +- Your Startup Program application must have been validated, and your contract signed. Find more information in our guides: + - [How to optimise your application to the Startup Program](/pages/account_and_service_management/startup-program/01-optimise-application) + - [How to sign your Startup Program contrac](/pages/account_and_service_management/startup-program/02-sign-agreement) +- Access to the [OVHcloud Control Panel](/links/manager). +- Knowledge of the [balance of your Startup Program credits](/pages/account_and_service_management/startup-program/04-view-credits). + +## Key Points + +- **Automatic renewal**: For eligible services, your credits are automatically used to renew your services, without requiring any action from you. +- **New orders**: + - For eligible Public Cloud services, credits will be automatically applied during the next billing cycle. + - For other eligible products, you must select "Digital Launchpad Credits" as the payment method during the ordering process. + +## Instructions + +### Service renewal + +Startup Program credits are automatically applied during the renewal of eligible services. No action is required; the credits will be deducted automatically from your bill during renewal. + +### Placing a new order + +Depending on the type of service you want to order, here's how to use your credits: + +#### For eligible Public Cloud services + +1. Place your order normally: Select the Public Cloud services you need and proceed with the order. +2. Credits applied automatically: During the next billing cycle for these services, your Startup Program credits will automatically cover the costs. + +#### For other eligible products + +1. Place your order: Select the eligible services you want to purchase. +1. Select the payment method: + 1. At the end of the order, when prompted to choose a payment method, go to the `Voucher`{.action} section. + 1. Select the `STARTUP_PROGRAM` voucher by clicking `Apply`{.action}. + 1. Add or select a payment method to cover the cost of non-eligible products using the voucher. +1. Proceed to payment: Click `Pay`{.action} to finalize the order using your credits. + +![Order](images/01-pay-bill.png){.thumbnail width="800"} + +> [!success] +> 💡 Need to know which products are eligible? Find the complete list [here](/pages/account_and_service_management/startup-program/06-available-products). + +## Conclusion + +Using your OVHcloud Startup Program credits to pay your bills is simple, whether for service renewals or new orders. Eligible services for renewal are automatically covered by your credits, while for new orders, you must select the credits at the payment stage. By following these steps, you can optimize your credit usage and reduce your infrastructure costs with minimal effort. \ No newline at end of file diff --git a/pages/account_and_service_management/startup-program/05-pay-bill-with-credits/guide.fr-fr.md b/pages/account_and_service_management/startup-program/05-pay-bill-with-credits/guide.fr-fr.md new file mode 100644 index 00000000000..c761f801d0e --- /dev/null +++ b/pages/account_and_service_management/startup-program/05-pay-bill-with-credits/guide.fr-fr.md @@ -0,0 +1,59 @@ +--- +title: "Comment payer une facture avec mes crédits du Startup Program" +excerpt: "Découvrez comment payer vos factures avec vos crédits du Startup Program d'OVHcloud pour optimiser vos dépenses d'infrastructure" +updated: 2025-10-14 +--- + +## Objectif + +En tant que membre du Startup Program d'OVHcloud, vous disposez de crédits pour soutenir vos projets et couvrir vos dépenses d'infrastructure. Il est essentiel de comprendre comment ces crédits peuvent être utilisés pour payer vos factures, que ce soit pour le renouvellement de services existants ou pour passer de nouvelles commandes. + +**Ce guide vous explique comment utiliser vos crédits de manière optimale lors des commandes ou des renouvellements, selon le type de service.** + +## Prérequis + +- Votre candidature au Startup Program doit avoir été validée et votre contrat signé. Retrouvez plus d'informations dans nos guides : + - [Comment optimiser votre candidature au Startup Program](/pages/account_and_service_management/startup-program/01-optimise-application) + - [Comment signer votre contrat du Startup Program](/pages/account_and_service_management/startup-program/02-sign-agreement) +- Être connecté à votre [espace client OVHcloud](/links/manager). +- Connaître le [solde de vos crédits du Startup Program](/pages/account_and_service_management/startup-program/04-view-credits). + +## Points clés + +- **Renouvellement automatique** : Pour les services éligibles, vos crédits sont utilisés automatiquement pour renouveler vos services, sans intervention de votre part. +- **Nouvelles commandes** : + - Pour les services Public Cloud éligibles, les crédits seront automatiquement appliqués lors de la prochaine facturation. + - Pour d’autres produits éligibles, vous devrez sélectionner les "Crédits Digital Launchpad" comme mode de paiement lors du processus de commande. + +## En pratique + +### Renouvellement de services + +Les crédits du Startup Program sont automatiquement appliqués lors du renouvellement des services éligibles. Il n'est pas nécessaire de faire une action particulière ; les crédits seront déduits automatiquement de votre facture lors du renouvellement. + +### Passer une nouvelle commande + +Selon le type de service que vous souhaitez commander, voici comment utiliser vos crédits : + +#### Pour les services Public Cloud éligibles + +1. Passez votre commande normalement : Sélectionnez les services Public Cloud dont vous avez besoin et passez la commande. +2. Crédits appliqués automatiquement : Lors de la prochaine facturation de ces services, vos crédits du Startup Program seront automatiquement utilisés pour couvrir les coûts. + +#### Pour les autres produits éligibles + +1. Passez votre commande : Sélectionnez les services éligibles que vous souhaitez acheter. +1. Sélectionnez le mode de paiement : + 1. À la fin de la commande, lorsqu’il vous sera demandé de choisir un moyen de paiement, allez dans la section `Voucher`{.action}. + 1. Sélectionnez le voucher `STARTUP_PROGRAM` en cliquant sur `Appliquer`{.action}. + 1. Ajoutez ou sélectionnez un moyen de paiement pour couvrir l'achat des produits non-éligibles avec le voucher. +1. Continuez les étapes jusqu'au paiement : Cliquez sur `Payer`{.action} pour finaliser la commande en utilisant vos crédits. + +![Commande](images/01-pay-bill.png){.thumbnail width="800"} + +> [!success] +> 💡 Besoin de savoir quels produits sont éligibles ? Retrouvez la liste complète [ici](/pages/account_and_service_management/startup-program/06-available-products). + +## Conclusion + +Utiliser vos crédits du Startup Program d'OVHcloud pour payer vos factures est simple, que ce soit pour le renouvellement de services ou pour de nouvelles commandes. Les services éligibles au renouvellement sont automatiquement couverts par vos crédits, tandis que pour les nouvelles commandes, vous devez sélectionner les crédits au moment du paiement. En suivant ces étapes, vous pouvez optimiser l'utilisation de vos crédits et réduire vos coûts d'infrastructure sans effort supplémentaire. \ No newline at end of file diff --git a/pages/account_and_service_management/startup-program/05-pay-bill-with-credits/images/01-pay-bill.png b/pages/account_and_service_management/startup-program/05-pay-bill-with-credits/images/01-pay-bill.png new file mode 100644 index 00000000000..3dfb8856607 Binary files /dev/null and b/pages/account_and_service_management/startup-program/05-pay-bill-with-credits/images/01-pay-bill.png differ diff --git a/pages/account_and_service_management/startup-program/05-pay-bill-with-credits/meta.yaml b/pages/account_and_service_management/startup-program/05-pay-bill-with-credits/meta.yaml new file mode 100644 index 00000000000..15ece64e2c6 --- /dev/null +++ b/pages/account_and_service_management/startup-program/05-pay-bill-with-credits/meta.yaml @@ -0,0 +1,2 @@ +id: 37c89abd-2859-4c33-b86a-af32eee76e36 +full_slug: startup-program-services-payment \ No newline at end of file diff --git a/pages/account_and_service_management/startup-program/06-available-products/guide.en-gb.md b/pages/account_and_service_management/startup-program/06-available-products/guide.en-gb.md new file mode 100644 index 00000000000..384aff6fe8d --- /dev/null +++ b/pages/account_and_service_management/startup-program/06-available-products/guide.en-gb.md @@ -0,0 +1,94 @@ +--- +title: "Which products are available to use with Startup Program credits?" +excerpt: 'Find out which OVHcloud solutions are eligible for Startup Program credits to support your start-up' +updated: 2025-10-14 +--- + +## Objective + +As part of OVHcloud's Startup Program, the credits provided help startups build, a flexible and scalable server infrastructure. However, not all solutions are eligible for use with Startup Program credits. + +**This guide explains which solutions are eligible, how to consult the eligible solutions table, and important exceptions to be aware of.** + +## Key Points + +- **Eligible solutions**: Startup Program credits are primarily intended for server infrastructure solutions, such as Public Cloud and Private Cloud. +- **Eligible GPU solutions**: Some Public Cloud solutions using GPUs are eligible, including AI & Machine Learning solutions as well as GPU v100/v100s and RTX 5000 instances. +- **Non-eligible solutions**: Web and Telecom solutions, along with certain specific infrastructure solutions, are not covered by the credits. +- **Non-eligible GPU solutions**: Some Public Cloud instances using GPUs (A100, H100, H200, L4, L40S) are not covered by the credits. +- **Order error management**: If non-eligible solutions are ordered by mistake, they must be stopped or transferred to another customer account not part of the Startup Program. + +## Instructions + +### Consult the list of eligible solutions + +To find out which solution are eligible for your Startup Program credits, it is important to consult the eligible solutions table provided by OVHcloud. Credits are primarily intended for server infrastructure solutions such as: + +- **Public Cloud**: A Cloud ecosystem of standard solutions to accelerate your business. +- **Private Cloud**: Leverage VMware virtualization on dedicated, managed infrastructures to save time and gain agility with OVHcloud’s Managed VMware vSphere solutions. + +Here is a summary of eligible solutions: + +#### Hosted Private Cloud + +| Solutions | Eligibility | +|---|---| +| **VMware**: Managed vSphere, Hyperconverged Storage, Network Security Virtualization, Software-Defined Datacentre | ✅ | +| **Nutanix**: Package service, BYOL service | ✅ | +| **Compliance & Certifications**: Healthcare, SecNumCloud, HIPAA & HITECH, PCI-DSS | ✅ | + +#### Public Cloud + +| Solutions | Eligibility | +|---|---| +| **Compute**: Instances (excluding instances using GPUs A100, H100, H200, L4, L40S), Baremetal Cloud | ✅ | +| **Storage & Backup**: Block Storage, Object Storage, Cloud Archive, Cold Archive, Snapshot, Backup | ✅ | +| **Network**: Load Balancer, vRack (Free), Bandwidth, Floating IP, Gateway, Anti-DDoS | ✅ | +| **Containers & Orchestration**: Managed K8s Service, Managed Rancher Service, Managed K8s Load Balancer, Managed Private Registry, Workflow Management, Image Catalog | ✅ | +| **Databases**: MySQL, PostgreSQL, MongoDB, Valkey, Cassandra | ✅ | +| **Data Analytics**: Data Processing, Kafka,Caching, Managed OpenSearch, Kafka MirrorMaker, Kafka Connect, Grafana, Logs Data Platform | ✅ | +| **AI & Machine Learning**: AI Notebooks, AI Training, AI Deploy, AI Endpoints | ✅ | +| **Quantum computing**: Quantum Notebooks | ✅ | +| **Data Platform**: Data Catalog, Data Processing Engine, Lakehouse Manager, Analytics Manager, Application Services, Data Platform capacity compute option | ✅ | + +#### Bare Metal & VPS + +| Solutions | Eligibility | +|---|---| +| **Managed Bare Metal** ("Essentials" range powered by VMware) | ✅ | +| **Dedicated Servers** | ❌ | +| **Storage**: NAS-HA, Cloud Disk Array | ✅ | +| **VPS** | ❌ | + +#### Web Cloud + +| Solutions | Eligibility | +|---|---| +| **Domains, Web Hosting, Emails, Collaborative Solutions** | ❌ | + +#### Telecom + +| Solutions | Eligibility | +|---|---| +| **Fiber, Broadband Access, Telephony, SMS, Fax, OverTheBox** | ❌ | + +#### Support + +| Solutions | Eligibility | +|---|---| +| **Standard** | Free | +| **Premium** | ✅ | +| **Business** | ✅ (For Scale level only) | +| **Enterprise** | ❌ | + +### What to do if you order non-eligible solutions? + +If non-eligible solutions are ordered by mistake, follow this procedure: + +- **Instance transfer**: If you ordered non-eligible GPU instances, we will contact you to stop and recreate them on another client account not in the Startup Program. + - Consult [our guide](/pages/public_cloud/compute/change_project_contacts) to transfer your instances to another customer account. +- **If you choose not to stop the instances**: If you choose not to stop the non-eligible instances, OVHcloud may terminate your participation in the Startup Program. + +## Conclusion + +OVHcloud Startup Program credits are designed to support startups by providing them with server infrastructure solutions that meet high availability and scalability needs. It’s crucial to check the eligibility of the solutions you plan to use with your credits by consulting the eligible solutions table. If non-eligible solutions are ordered by mistake, follow the steps to correct the situation or transfer the instances to another account. Maximize your credits by focusing on flexible solutions that best suit your startup’s growth. \ No newline at end of file diff --git a/pages/account_and_service_management/startup-program/06-available-products/guide.fr-fr.md b/pages/account_and_service_management/startup-program/06-available-products/guide.fr-fr.md new file mode 100644 index 00000000000..e28cab9a6f1 --- /dev/null +++ b/pages/account_and_service_management/startup-program/06-available-products/guide.fr-fr.md @@ -0,0 +1,94 @@ +--- +title: "Quels produits sont disponibles avec les crédits du Startup Program ?" +excerpt: "Découvrez quelles solutions OVHcloud sont éligibles avec les crédits du Startup Program pour soutenir votre startup" +updated: 2025-10-14 +--- + +## Objectif + +Dans le cadre du Startup Program d'OVHcloud, les crédits offerts permettent aux startups de bénéficier d’une infrastructure serveur flexible et adaptée à leurs besoins. Cependant, toutes les solutions ne sont pas éligibles aux crédits du Startup Program. + +**Ce guide explique quelles solutions sont éligibles, comment consulter le tableau des solutions éligibles, et les exceptions à connaître.** + +## Points clés + +- **Solutions éligibles** : Les crédits du Startup Program sont principalement destinés aux solutions d’infrastructure serveur, tels que le Public Cloud et le Private Cloud. +- **Solutions GPU éligibles** : Certaines solutions Public Cloud utilisant des GPU sont éligibles, notamment les solutions AI & Machine Learning et les instances GPU v100/v100s et RTX 5000. +- **Solutions non-éligibles** : Les solutions Web et Télécom, ainsi que certaines solutions d’infrastructure spécifiques, ne sont pas couvertes par les crédits. +- **Solutions GPU non-éligibles** : Certaines instances Public Cloud et solutions IA utilisant des GPU (A100, H100, H200, L4, L40S) ne sont pas éligibles avec les crédits. +- **Gestion des erreurs de commande** : Si des solutions non-éligibles sont commandées par erreur, elles devront être arrêtées ou transférées vers un autre compte client ne faisant pas partie du Startup Program. + +## En pratique + +### Consulter le tableau des solutions éligibles + +Pour savoir quelles solutions sont éligibles avec vos crédits du Startup Program, il est important de consulter le tableau des solutions éligibles fourni par OVHcloud. Les crédits sont principalement destinés aux solutions d’infrastructure serveur, telles que : + +- **Public Cloud** : Un écosystème Cloud de solutions standard pour accélérer votre activité. +- **Private Cloud** : Bénéficiez de la plateforme de virtualisation VMware dans des infrastructures dédiées, managées et opérationnelles. Gagnez ainsi du temps et de l'agilité avec les solutions OVHcloud Managed VMware vSphere. + +Voici un résumé des solutions éligibles : + +#### Hosted Private Cloud + +| Solutions | Éligibilité | +|---|---| +| **VMware** : Managed vSphere, Hyperconverged Storage, Network Security Virtualization, Software-Defined Datacentre | ✅ | +| **Nutanix** : Package service, BYOL service | ✅ | +| **Compliance & Certifications** : Healthcare, SecNumCloud, HIPAA & HITECH, PCI-DSS | ✅ | + +#### Public Cloud + +| Solutions | Éligibilité | +|---|---| +| **Compute** : Instances (ne sont pas comprises les instances utilisant les GPU A100, H100, H200, L4, L40S), Baremetal Cloud | ✅ | +| **Storage & Backup** : Block Storage, Object Storage, Cloud Archive, Cold Archive, Snapshot, Backup | ✅ | +| **Network** : Load Balancer, vRack (Free), Bande passante, Floating IP, Gateway, Anti-DDoS | ✅ | +| **Containers & Orchestration** : Managed K8s Service, Managed Rancher Service, Managed K8s Load Balancer, Managed Private Registry, Workflow Management, Image Catalog | ✅ | +| **Databases** : MySQL, PostgreSQL, MongoDB, Valkey, Cassandra | ✅ | +| **Data Analytics** : Data Processing, Kafka,Caching, Managed OpenSearch, Kafka MirrorMaker, Kafka Connect, Grafana, Logs Data Platform | ✅ | +| **AI & Machine Learning** : AI Notebooks, AI Training, AI Deploy, AI Endpoints | ✅ | +| **Quantum computing** : Quantum Notebooks | ✅ | +| **Data Platform** : Data Catalog, Data Processing Engine, Lakehouse Manager, Analytics Manager, Application Services, Data Platform capacity compute option | ✅ | + +#### Bare Metal & VPS + +| Solutions | Éligibilité | +|---|---| +| **Managed Bare Metal** (gamme "Essentials" powered by VMware) | ✅ | +| **Dedicated Servers** | ❌ | +| **Storage** : NAS-HA, Cloud Disk Array | ✅ | +| **VPS** | ❌ | + +#### Web Cloud + +| Solutions | Éligibilité | +|---|---| +| **Domaines, Hébergements web, E-mails et Outils collaboratifs** | ❌ | + +#### Telecom + +| Solutions | Éligibilité | +|---|---| +| **Fibre, Accès haut débit, Téléphonie, SMS, Fax, OverTheBox** | ❌ | + +#### Support + +| Solutions | Éligibilité | +|---|---| +| **Standard** | Gratuit | +| **Premium** | ✅ | +| **Business** | ✅ (Uniquement pour le niveau Scale) | +| **Enterprise** | ❌ | + +### Que faire en cas d’erreur de commande de GPU non-éligibles ? + +Si des solutions non-éligibles sont commandées par erreur, voici la procédure à suivre : + +- **Transfert des instances** : Si vous avez commandé des instances GPU non-éligibles, nous vous contacterons pour les arrêter et les recréer sur un autre compte client qui n'est pas dans le Startup Program. + - Consultez [notre guide](/pages/public_cloud/compute/change_project_contacts) pour transférer vos instances vers un autre compte client. +- **Si vous ne souhaitez pas arrêter les instances** : Si vous choisissez de ne pas couper les instances non-éligibles, OVHcloud pourra mettre fin à votre participation au Startup Program. + +## Conclusion + +Les crédits du Startup Program d'OVHcloud sont conçus pour soutenir les startups en leur offrant des solutions d’infrastructure serveur adaptées à leurs besoins de haute disponibilité et de scalabilité. Il est crucial de vérifier l’éligibilité des solutions que vous souhaitez utiliser avec vos crédits en consultant le tableau des solutions éligibles. En cas d’erreur de commande de solutions non-éligibles, suivez les étapes pour rectifier la situation ou transférez les instances vers un autre compte. Maximisez l’utilisation de vos crédits en vous concentrant sur les solutions flexibles qui conviennent le mieux à la croissance de votre startup. \ No newline at end of file diff --git a/pages/account_and_service_management/startup-program/06-available-products/meta.yaml b/pages/account_and_service_management/startup-program/06-available-products/meta.yaml new file mode 100644 index 00000000000..c7947b1d086 --- /dev/null +++ b/pages/account_and_service_management/startup-program/06-available-products/meta.yaml @@ -0,0 +1,2 @@ +id: 1212821b-795b-4811-b387-30f25f0762ea +full_slug: startup-program-available-products \ No newline at end of file diff --git a/pages/account_and_service_management/startup-program/07-increase-quota/guide.en-gb.md b/pages/account_and_service_management/startup-program/07-increase-quota/guide.en-gb.md new file mode 100644 index 00000000000..73e4a7bbcf9 --- /dev/null +++ b/pages/account_and_service_management/startup-program/07-increase-quota/guide.en-gb.md @@ -0,0 +1,50 @@ +--- +title: "How to increase Public Cloud quotas for a Startup Program member" +excerpt: 'Find out how to increase Public Cloud quotas for a OVHcloud Startup Program member and optimise your Cloud resources' +updated: 2025-10-14 +--- + +## Objective + +This guide explains the steps to request a quota increase on your Cloud account when using our services. If you are part of the Startup Program, it is important to consider certain limitations, especially regarding the use of credits provided by the program when increasing your quota. + +## Key Points + +- **Startup credits usage**: It is not possible to request a quota increase using credits provided by the Startup Program. If you still wish to increase the quota, you must follow the steps outlined below. +- **Personal payment**: If you are a Startup Program member and choose to pay with your own funds to increase your quota, the amount paid can be credited (upon request) to your customer account as Cloud credit. This credit will be used first for future payments, before your Startup Program credits. +- **Preparation**: Before requesting a quota increase, you must add a valid payment method to your customer account and ensure that your account is registered as a company. + +## Requirements + +- You are a member of the [Startup Program](/links/transversal/startup-program). +- Your OVHcloud account has a valid payment method. Refer to [this guide](/pages/account_and_service_management/managing_billing_payments_and_services/manage-payment-methods) to add a valid payment method. +- Your account is registered under the `Company` status. Refer to [this guide](/pages/account_and_service_management/account_information/all_about_username) to update your information. +- Access to the [OVHcloud Control Panel](/links/manager). + +## Instructions + +This procedure allows you to manually request a quota increase and validate it via an initial payment (Public Cloud credit). + +### Step 1 - Create a support ticket to request a quota increase + +After fulfilling the prerequisites above, create a support ticket by following these steps: + +Log in to your [OVHcloud Control Panel](/links/manager), navigate to the `Public Cloud`{.action} section, and select your Public Cloud project. + +In the `Project Management` section, click on `Quota & Regions`{.action}. Click on `Contact Support`{.action}. + +![Contacter le support](images/01-quota.png){.thumbnail width="800"} + +Justify your quota increase request by specifying your participation in the OVHcloud Startup Program, stating your technical needs, and providing the name of your Startup Program Manager responsible for overseeing your participation (consult the list of Startup Program Managers [here](/links/transversal/startup-program-faq-managers)). + +![Contacter le support](images/02-support-request.png){.thumbnail width="800"} + +### Step 2 - Contact your Startup Program Manager + +After submitting your quota increase request, it is recommended to contact your regional Startup Program Manager to ensure your ticket is tracked and to receive prompt assistance. + +Find the list of Startup Program Managers [here](/links/transversal/startup-program-faq-managers). + +## Conclusion + +Requesting a quota increase may be necessary to adapt your Cloud resources to your growing needs. However, it is important to understand the payment terms and credit priority to avoid unexpected charges from your own funds. If in doubt, don't hesitate to reach out to your Startup Program Manager for guidance through every step of the process. \ No newline at end of file diff --git a/pages/account_and_service_management/startup-program/07-increase-quota/guide.fr-fr.md b/pages/account_and_service_management/startup-program/07-increase-quota/guide.fr-fr.md new file mode 100644 index 00000000000..e7b57a7435b --- /dev/null +++ b/pages/account_and_service_management/startup-program/07-increase-quota/guide.fr-fr.md @@ -0,0 +1,50 @@ +--- +title: "Comment augmenter les quotas Public Cloud pour un membre du Startup Program" +excerpt: "Découvrez comment augmenter les quotas Public Cloud pour un membre du Startup Program d'OVHcloud et optimiser vos ressources Cloud" +updated: 2025-10-14 +--- + +## Objectif + +Ce guide vous explique les étapes à suivre pour demander une augmentation de quota sur votre compte Cloud dans le cadre de l'utilisation de nos services. Si vous faites partie du Startup Program, il est important de prendre en compte certaines limitations, notamment concernant l’utilisation des crédits alloués par le programme lors de l'augmentation de quota. + +## Points clés + +- **Utilisation des crédits du Startup Program** : Il n'est pas possible de commander une augmentation de quota en utilisant les crédits fournis par le Startup Program. Il faudra alors suivre les étapes décrites ci-dessous si vous souhaitez quand-même augmenter le quota. +- **Paiement personnel** : Si vous êtes membre du Startup Program et que vous choisissez tout de même de payer avec vos propres fonds pour augmenter votre quota, le montant payé pourra être crédité (à votre demande) sur votre compte client en tant que crédit Cloud. Ce crédit sera utilisé en priorité pour vos futurs paiements, avant vos crédits du Startup Program. +- **Préparation** : Avant de demander une augmentation de quota, vous devez ajouter un moyen de paiement valide à votre compte client et vous assurer que vous êtes enregistré en tant que société. + +## Prérequis + +- Vous êtes membre du [Startup Program](/links/transversal/startup-program). +- Votre compte OVHcloud dispose d'un moyen de paiement valide. Consultez [ce guide](/pages/account_and_service_management/managing_billing_payments_and_services/manage-payment-methods) pour vous aider à ajouter un moyen de paiement valide. +- Votre compte est enregistré sous le statut `Entreprise`. Consultez [ce guide](/pages/account_and_service_management/account_information/all_about_username) pour vous aider à modifier vos informations. +- Être connecté à votre [espace client OVHcloud](/links/manager). + +## En pratique + +Cette procédure vous permet de demander manuellement une augmentation de quota et de la valider via un paiement initial (crédit Public Cloud). + +### Etape 1 - Créer un ticket pour demander une augmentation de quota + +Une fois les prérequis ci-dessus remplis, vous pouvez créer un ticket de support en suivant ces étapes : + +Connectez-vous à votre [espace client OVHcloud](/links/manager), accédez à la section `Public Cloud`{.action} et sélectionnez votre projet Public Cloud. + +Dans la rubrique `Project Management`, cliquez sur `Quota and Regions`{.action}. Cliquez sur `Contacter le support`{.action}. + +![Contacter le support](images/01-quota.png){.thumbnail width="800"} + +Motivez votre demande d'augmentation de quota en précisant votre participation au Startup Program d'OVHcloud et en indiquant votre besoin technique et le nom du Startup Program Manager en charge du suivi de votre participation (consultez la liste des Startup Program Managers [ici](/links/transversal/startup-program-faq-managers)). + +![Contacter le support](images/02-support-request.png){.thumbnail width="800"} + +### Etape 2 - Contacter votre Startup Program Manager + +Après avoir soumis votre demande d’augmentation de quota, il est recommandé de contacter le Startup Program Manager de votre région pour assurer un suivi de votre ticket et obtenir une assistance rapide. + +Retrouvez la liste des Startup Program Managers [ici](/links/transversal/startup-program-faq-managers). + +## Conclusion + +Demander une augmentation de quota peut être nécessaire pour adapter vos ressources Cloud à vos besoins en terme de croissance. Cependant, il est important de bien comprendre les modalités de paiement et l’ordre de priorité des crédits pour éviter les paiements inattendus avec vos fonds propres. En cas de doute, n'hésitez pas à contacter votre Startup Program Manager pour vous guider à chaque étape du processus. \ No newline at end of file diff --git a/pages/account_and_service_management/startup-program/07-increase-quota/images/01-quota.png b/pages/account_and_service_management/startup-program/07-increase-quota/images/01-quota.png new file mode 100644 index 00000000000..aca0193e5f0 Binary files /dev/null and b/pages/account_and_service_management/startup-program/07-increase-quota/images/01-quota.png differ diff --git a/pages/account_and_service_management/startup-program/07-increase-quota/images/02-support-request.png b/pages/account_and_service_management/startup-program/07-increase-quota/images/02-support-request.png new file mode 100644 index 00000000000..94bb8fa2a04 Binary files /dev/null and b/pages/account_and_service_management/startup-program/07-increase-quota/images/02-support-request.png differ diff --git a/pages/account_and_service_management/startup-program/07-increase-quota/meta.yaml b/pages/account_and_service_management/startup-program/07-increase-quota/meta.yaml new file mode 100644 index 00000000000..96594874df1 --- /dev/null +++ b/pages/account_and_service_management/startup-program/07-increase-quota/meta.yaml @@ -0,0 +1,2 @@ +id: beac2b43-ed72-43eb-8930-9e305376e5f0 +full_slug: startup-program-increase-quota \ No newline at end of file diff --git a/pages/assets/screens/control_panel/product-selection/right-column/my-solutions-and-services/dns-zone-cancel-my-subscription.png b/pages/assets/screens/control_panel/product-selection/right-column/my-solutions-and-services/dns-zone-cancel-my-subscription.png new file mode 100644 index 00000000000..c8b9f4596b3 Binary files /dev/null and b/pages/assets/screens/control_panel/product-selection/right-column/my-solutions-and-services/dns-zone-cancel-my-subscription.png differ diff --git a/pages/assets/screens/control_panel/product-selection/right-column/my-solutions-and-services/dns-zone-delete-your-service.png b/pages/assets/screens/control_panel/product-selection/right-column/my-solutions-and-services/dns-zone-delete-your-service.png new file mode 100644 index 00000000000..358c125fab2 Binary files /dev/null and b/pages/assets/screens/control_panel/product-selection/right-column/my-solutions-and-services/dns-zone-delete-your-service.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/boost-my-hosting-plan/deactivate-the-boost-plan.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/boost-my-hosting-plan/deactivate-the-boost-plan.png index 462779ee798..ebb4b8aa990 100644 Binary files a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/boost-my-hosting-plan/deactivate-the-boost-plan.png and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/boost-my-hosting-plan/deactivate-the-boost-plan.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/databases.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/databases.png similarity index 100% rename from pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/databases.png rename to pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/databases.png diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/databases/change-password.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/databases/change-password.png index 21906a13d2c..3db3abec97c 100644 Binary files a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/databases/change-password.png and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/databases/change-password.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/databases/create-a-backup.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/databases/create-a-backup.png index 5f07521062e..07cb3246018 100644 Binary files a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/databases/create-a-backup.png and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/databases/create-a-backup.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/databases/go-to-phpmyadmin.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/databases/go-to-phpmyadmin.png index f809f408b26..cc037a1b4ff 100644 Binary files a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/databases/go-to-phpmyadmin.png and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/databases/go-to-phpmyadmin.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/databases/import-file.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/databases/import-file.png index 59c670037ab..72ff5902dba 100644 Binary files a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/databases/import-file.png and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/databases/import-file.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/databases/recalculate-quota.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/databases/recalculate-quota.png index 2c6f31046ce..28669c7c94c 100644 Binary files a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/databases/recalculate-quota.png and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/databases/recalculate-quota.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/databases/restore-backup.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/databases/restore-backup.png index 35aa8832f14..2129a824f87 100644 Binary files a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/databases/restore-backup.png and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/databases/restore-backup.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/databases/sharedsql-dashboard-db-list.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/databases/sharedsql-dashboard-db-list.png index d56f79b4359..109dd25cf78 100644 Binary files a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/databases/sharedsql-dashboard-db-list.png and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/databases/sharedsql-dashboard-db-list.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/databases/tab.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/databases/tab.png index d56f79b4359..2c0b6899924 100644 Binary files a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/databases/tab.png and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/databases/tab.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/email-scripts/tab.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/email-scripts/tab.png index 632c1a6b4b9..09b3027a388 100644 Binary files a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/email-scripts/tab.png and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/email-scripts/tab.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/ftp-ssh.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ftp-ssh.png similarity index 100% rename from pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/ftp-ssh.png rename to pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ftp-ssh.png diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ftp-ssh/change-password-perso.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ftp-ssh/change-password-perso.png index befac25e72e..a2b4728d2a0 100644 Binary files a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ftp-ssh/change-password-perso.png and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ftp-ssh/change-password-perso.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ftp-ssh/change-password-pro.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ftp-ssh/change-password-pro.png index fbf30c3b195..b60192c3973 100644 Binary files a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ftp-ssh/change-password-pro.png and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ftp-ssh/change-password-pro.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ftp-ssh/create-user.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ftp-ssh/create-user.png index 80364573047..fcabef16aa9 100644 Binary files a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ftp-ssh/create-user.png and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ftp-ssh/create-user.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ftp-ssh/delete-user1.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ftp-ssh/delete-user1.png index af4273f0684..a68f21aaf4f 100644 Binary files a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ftp-ssh/delete-user1.png and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ftp-ssh/delete-user1.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ftp-ssh/edit-user1.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ftp-ssh/edit-user1.png index 595e85a0d7d..e20c43ddc06 100644 Binary files a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ftp-ssh/edit-user1.png and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ftp-ssh/edit-user1.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ftp-ssh/hostname.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ftp-ssh/hostname.png index fdf1e0934a8..f098fe0837b 100644 Binary files a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ftp-ssh/hostname.png and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ftp-ssh/hostname.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ftp-ssh/login-infos.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ftp-ssh/login-infos.png index 4af5f58e039..77c5d09dc45 100644 Binary files a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ftp-ssh/login-infos.png and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ftp-ssh/login-infos.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ftp-ssh/tab-perso.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ftp-ssh/tab-perso.png index 507a2e5b301..3f351805809 100644 Binary files a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ftp-ssh/tab-perso.png and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ftp-ssh/tab-perso.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ftp-ssh/tab-pro.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ftp-ssh/tab-pro.png index 528b9a741e7..ef272aea72a 100644 Binary files a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ftp-ssh/tab-pro.png and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ftp-ssh/tab-pro.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ftp-ssh/tab-ssh.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ftp-ssh/tab-ssh.png index 096cdaa8174..bbfb557d902 100644 Binary files a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ftp-ssh/tab-ssh.png and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ftp-ssh/tab-ssh.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/cancel-email-included-webhosting.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/cancel-email-included-webhosting.png index 3bcc3a94cf9..28f5c10263c 100644 Binary files a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/cancel-email-included-webhosting.png and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/cancel-email-included-webhosting.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/cancel-the-cdn.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/cancel-the-cdn.png index 3e18827772e..afb80904859 100644 Binary files a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/cancel-the-cdn.png and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/cancel-the-cdn.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/change-php-version-step1.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/change-php-version-step1.png index 88f3b063168..65cd8a2e32b 100644 Binary files a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/change-php-version-step1.png and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/change-php-version-step1.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/detach-email-included-webhosting.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/detach-email-included-webhosting.png index f117031c80e..d670db53f01 100644 Binary files a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/detach-email-included-webhosting.png and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/detach-email-included-webhosting.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/detach-my-web-cloud-databases.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/detach-my-web-cloud-databases.png index d20f420ee36..32ff6107310 100644 Binary files a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/detach-my-web-cloud-databases.png and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/detach-my-web-cloud-databases.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/enable-email-included-webhosting.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/enable-email-included-webhosting.png index 284d9a3bebd..168b4ba5e8e 100644 Binary files a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/enable-email-included-webhosting.png and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/enable-email-included-webhosting.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/find-disk-space.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/find-disk-space.png index b5becd49455..11f9656ba40 100644 Binary files a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/find-disk-space.png and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/find-disk-space.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/find-ipv4-and-ipv6.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/find-ipv4-and-ipv6.png index 6643307d12a..8fea4908539 100644 Binary files a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/find-ipv4-and-ipv6.png and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/find-ipv4-and-ipv6.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/find-ipv4.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/find-ipv4.png deleted file mode 100644 index 17f619b4713..00000000000 Binary files a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/find-ipv4.png and /dev/null differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/find-ipv6.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/find-ipv6.png index 9af763d4139..fff70c02cd7 100644 Binary files a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/find-ipv6.png and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/find-ipv6.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/find-webhosting-name.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/find-webhosting-name.png index ef41e4d06e5..56ba416f5d7 100644 Binary files a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/find-webhosting-name.png and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/find-webhosting-name.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/modify-hosting-configuration.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/modify-hosting-configuration.png index a428b08f373..f85fae5faa2 100644 Binary files a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/modify-hosting-configuration.png and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/modify-hosting-configuration.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/order-a-cdn.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/order-a-cdn.png index 6b265d70f52..2ded1dd2e02 100644 Binary files a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/order-a-cdn.png and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/order-a-cdn.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/order-activate-email-included-webhosting-step-1.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/order-activate-email-included-webhosting-step-1.png index 6385b91902f..306607936c3 100644 Binary files a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/order-activate-email-included-webhosting-step-1.png and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/order-activate-email-included-webhosting-step-1.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/pro-change-plan.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/pro-change-plan.png index ecb2112ea00..8a419ae2e8d 100644 Binary files a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/pro-change-plan.png and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/pro-change-plan.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/wcdb-detach.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/wcdb-detach.png index 6550472852e..4e6309de973 100644 Binary files a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/wcdb-detach.png and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/general-information/wcdb-detach.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/more-2.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/more-2.png new file mode 100644 index 00000000000..29f1639e503 Binary files /dev/null and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/more-2.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/more.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/more.png new file mode 100644 index 00000000000..dce53b02a05 Binary files /dev/null and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/more.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/multisite/modify-a-domain-step-1-all-disabled-git-message.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/multisite/modify-a-domain-step-1-all-disabled-git-message.png index 25c613a6188..d5896e68ba9 100644 Binary files a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/multisite/modify-a-domain-step-1-all-disabled-git-message.png and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/multisite/modify-a-domain-step-1-all-disabled-git-message.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/multisite/modify-a-domain-step-1-all-disabled.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/multisite/modify-a-domain-step-1-all-disabled.png index 9614ff0cc5b..8ebff6ad175 100644 Binary files a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/multisite/modify-a-domain-step-1-all-disabled.png and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/multisite/modify-a-domain-step-1-all-disabled.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ssl-certificates.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ssl-certificates.png new file mode 100644 index 00000000000..a3322803e55 Binary files /dev/null and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ssl-certificates.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ssl-certificates/disable-ssl.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ssl-certificates/disable-ssl.png new file mode 100644 index 00000000000..28edf83c4dc Binary files /dev/null and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ssl-certificates/disable-ssl.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ssl-certificates/enable-ssl-lets-encrypt.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ssl-certificates/enable-ssl-lets-encrypt.png new file mode 100644 index 00000000000..9cee9c20d07 Binary files /dev/null and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ssl-certificates/enable-ssl-lets-encrypt.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ssl-certificates/import-your-own-ssl-certificate-window-completed.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ssl-certificates/import-your-own-ssl-certificate-window-completed.png new file mode 100644 index 00000000000..afb9861c671 Binary files /dev/null and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ssl-certificates/import-your-own-ssl-certificate-window-completed.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ssl-certificates/import-your-own-ssl-certificate-window.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ssl-certificates/import-your-own-ssl-certificate-window.png new file mode 100644 index 00000000000..cb8386d3dda Binary files /dev/null and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ssl-certificates/import-your-own-ssl-certificate-window.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ssl-certificates/import-your-own-ssl-certificate.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ssl-certificates/import-your-own-ssl-certificate.png new file mode 100644 index 00000000000..7bc807bb0f7 Binary files /dev/null and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ssl-certificates/import-your-own-ssl-certificate.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ssl-certificates/order-a-sectigo-ssl-certificate-select-domain.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ssl-certificates/order-a-sectigo-ssl-certificate-select-domain.png new file mode 100644 index 00000000000..81c3ca9c747 Binary files /dev/null and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ssl-certificates/order-a-sectigo-ssl-certificate-select-domain.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ssl-certificates/order-a-sectigo-ssl-certificate.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ssl-certificates/order-a-sectigo-ssl-certificate.png new file mode 100644 index 00000000000..361a8cdccda Binary files /dev/null and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ssl-certificates/order-a-sectigo-ssl-certificate.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ssl-certificates/ssl-deletion.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ssl-certificates/ssl-deletion.png new file mode 100644 index 00000000000..ec2595e4e7b Binary files /dev/null and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ssl-certificates/ssl-deletion.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ssl-certificates/tab-custom.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ssl-certificates/tab-custom.png new file mode 100644 index 00000000000..6b43d30c1ef Binary files /dev/null and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ssl-certificates/tab-custom.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ssl-certificates/tab.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ssl-certificates/tab.png new file mode 100644 index 00000000000..c367e068788 Binary files /dev/null and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/ssl-certificates/tab.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/statistics-and-logs.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/statistics-and-logs.png new file mode 100644 index 00000000000..573fc3f881c Binary files /dev/null and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/statistics-and-logs.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/statistics-and-logs/tab.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/statistics-and-logs/tab.png index 5e7aceaa9ba..675ae0ebe0f 100644 Binary files a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/statistics-and-logs/tab.png and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/statistics-and-logs/tab.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/statistics-and-logs/view-logs.png b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/statistics-and-logs/view-logs.png index 3a46a506d36..609393027ce 100644 Binary files a/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/statistics-and-logs/view-logs.png and b/pages/assets/screens/control_panel/product-selection/web-cloud/web-hosting/statistics-and-logs/view-logs.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/zimbra/domain/diagnostics/access.png b/pages/assets/screens/control_panel/product-selection/web-cloud/zimbra/domain/diagnostics/access.png new file mode 100644 index 00000000000..bd0f49dfb59 Binary files /dev/null and b/pages/assets/screens/control_panel/product-selection/web-cloud/zimbra/domain/diagnostics/access.png differ diff --git a/pages/assets/screens/control_panel/product-selection/web-cloud/zimbra/domain/diagnostics/dkim-cname-conf.png b/pages/assets/screens/control_panel/product-selection/web-cloud/zimbra/domain/diagnostics/dkim-cname-conf.png new file mode 100644 index 00000000000..7888e2c61ea Binary files /dev/null and b/pages/assets/screens/control_panel/product-selection/web-cloud/zimbra/domain/diagnostics/dkim-cname-conf.png differ diff --git a/pages/bare_metal_cloud/dedicated_servers/3az-presentation/images/01-20240513-blur.png b/pages/bare_metal_cloud/dedicated_servers/3az-presentation/images/01-20240513-blur.png deleted file mode 100644 index c027620d9cf..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/3az-presentation/images/01-20240513-blur.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/3az-presentation/images/02-20240513-blur.png b/pages/bare_metal_cloud/dedicated_servers/3az-presentation/images/02-20240513-blur.png deleted file mode 100644 index 11277cf75ad..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/3az-presentation/images/02-20240513-blur.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/3az-presentation/images/03-20240513-blur.png b/pages/bare_metal_cloud/dedicated_servers/3az-presentation/images/03-20240513-blur.png deleted file mode 100644 index 5ae5e3a7472..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/3az-presentation/images/03-20240513-blur.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/3az-presentation/images/04-20240513-blur.png b/pages/bare_metal_cloud/dedicated_servers/3az-presentation/images/04-20240513-blur.png deleted file mode 100644 index 1e90d620b92..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/3az-presentation/images/04-20240513-blur.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/activate-port-firewall-soft-win/images/step7_01.PNG b/pages/bare_metal_cloud/dedicated_servers/activate-port-firewall-soft-win/images/step7_01.PNG deleted file mode 100644 index 9e844d4fd7b..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/activate-port-firewall-soft-win/images/step7_01.PNG and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/dns2-01.png b/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/dns2-01.png deleted file mode 100644 index 3c1fa34e200..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/dns2-01.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/dns2-01_2020.png b/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/dns2-01_2020.png deleted file mode 100644 index e7b3defaae8..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/dns2-01_2020.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/dns2-02.png b/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/dns2-02.png deleted file mode 100644 index 2f26aec91d3..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/dns2-02.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/dns2-02_2020.png b/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/dns2-02_2020.png deleted file mode 100644 index 61c27b1d552..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/dns2-02_2020.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/dns2-03.png b/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/dns2-03.png deleted file mode 100644 index ef3b01835e1..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/dns2-03.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/dns2-03_2020.png b/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/dns2-03_2020.png deleted file mode 100644 index b43081c1cad..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/dns2-03_2020.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/dns2-04a.png b/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/dns2-04a.png deleted file mode 100644 index 5c1298418fe..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/dns2-04a.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/dns2-04a_2020.png b/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/dns2-04a_2020.png deleted file mode 100644 index 213aaf52cfd..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/dns2-04a_2020.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/dns2-04b.png b/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/dns2-04b.png deleted file mode 100644 index 0afb59ced8f..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/dns2-04b.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/dns2-04b_2020.png b/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/dns2-04b_2020.png deleted file mode 100644 index 03e5df01e3f..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/dns2-04b_2020.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/dns2-05.png b/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/dns2-05.png deleted file mode 100644 index 3290988135b..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/dns2-05.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/dns2-05_2020.png b/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/dns2-05_2020.png deleted file mode 100644 index 99c9a933d61..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/dns2-05_2020.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/domain-verification-01.png b/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/domain-verification-01.png deleted file mode 100644 index f7d98fe271c..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/domain-verification-01.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/domain-verification-02.png b/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/domain-verification-02.png deleted file mode 100644 index 20dadc15e1b..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/domain-verification-02.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/domain-verification-03.png b/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/domain-verification-03.png deleted file mode 100644 index 1565f922aef..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/domain-verification-03.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/domain-verification-04.png b/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/domain-verification-04.png deleted file mode 100644 index aaa02adc743..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/domain-verification-04.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/domain-verification-05.png b/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/domain-verification-05.png deleted file mode 100644 index cc0707fa585..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/domain-verification-05.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/secondarydns.png b/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/secondarydns.png deleted file mode 100644 index 84c5ec57e39..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/adding-secondary-dns-on-dedicated-server/images/secondarydns.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/antispam_best_practices/images/alertantispam.png b/pages/bare_metal_cloud/dedicated_servers/antispam_best_practices/images/alertantispam.png deleted file mode 100644 index 3ee9567deeb..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/antispam_best_practices/images/alertantispam.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/antispam_best_practices/meta.yaml b/pages/bare_metal_cloud/dedicated_servers/antispam_best_practices/meta.yaml index 91d39c72bd3..875366dc783 100755 --- a/pages/bare_metal_cloud/dedicated_servers/antispam_best_practices/meta.yaml +++ b/pages/bare_metal_cloud/dedicated_servers/antispam_best_practices/meta.yaml @@ -1,3 +1,3 @@ id: ad3d2222-d0ed-45a9-a5da-ef9bba9d52ab full_slug: dedicated-servers-antispam-best-practices -reference_category: bare-metal-cloud-dedicated-servers-managing-servers \ No newline at end of file +reference_category: bare-metal-cloud-dedicated-servers-security-network \ No newline at end of file diff --git a/pages/bare_metal_cloud/dedicated_servers/blockchain_anti_ddos/guide.en-gb.md b/pages/bare_metal_cloud/dedicated_servers/blockchain_anti_ddos/guide.en-gb.md new file mode 100644 index 00000000000..8eebffcd466 --- /dev/null +++ b/pages/bare_metal_cloud/dedicated_servers/blockchain_anti_ddos/guide.en-gb.md @@ -0,0 +1,64 @@ +--- +title: "How to configure the Anti-DDos Infrastructure for Solana" +excerpt: "Learn how to leverage the OVHcloud Anti-DDoS infrastructure to protect your Solana nodes without harming their functionality" +updated: 2025-10-13 +--- + +> [!primary] +> This guide's instructions and examples are currently focused exclusively on the **Solana** blockchain. +> + +## Objective + +This guide's objective is to help you better understand the OVHcloud Anti-DDoS Infrastructure, and to provide instructions on how to configure effective protection without harming legitimate network traffic relative to the blockchain. + +## Requirements + +- At least one [dedicated server](/links/bare-metal/bare-metal) which respects the desired blockchain's specific hardware requirements. + +## Introduction to Blockchain + +A blockchain is a decentralized, distributed digital ledger that records transactions across many computers, ensuring that the data cannot be altered retroactively without the alteration of all subsequent blocks and the consensus of the network. + +This technology creates a tamper-proof and transparent record of information, such as financial transactions, making it secure and trustworthy. + +In some cases, communication spikes can trigger the Anti-DDoS Infrastructure and lead to the detection of some traffic patterns as false positives. + +## Instructions + +To avoid having your network traffic suspected or blocked by the Anti-DDoS Infrastructure (as a false positive detection), we strongly recommend that you provide the IP addresses of your nodes to our support teams. This will enable us to create a customised Solana profile for better protection and uninterrupted operation. + +To get started, create a [support request ticket](https://help.ovhcloud.com/csm?id=csm_get_help) with the following options: Incident -> Public IP -> [x] This service is not listed -> Create a support request -> `Next`{.action}. + +Fill in the short description with **"Blockchain Solana Anti-DDoS tuning"**, then list your Solana nodes' IPv4 addresses, their ports, the types of servers that host the nodes, and the size of your cluster (the approximate number of clients connected) in the issue description. + +Please note that in the future, you will be able to control Anti-DDoS behaviour directly through our Control Panel. + +If you are not sure about which elements you should send to our teams, you can refer to the following use case. + +### Use Cas : Solana + +Solana is a high-performance blockchain platform known for its exceptional speed and low transaction costs, making it a popular alternative for decentralized applications. It achieves this by using a unique cryptographic clock called Proof of History (PoH), which timestamps transactions to enable parallel processing and greater efficiency. This system is paired with a Proof of Stake (PoS) consensus mechanism, in which validators are chosen based on their SOL stake, thus ensuring the security and decentralisation of the network. + +Solana's architecture also utilizes a combination of protocols like Tower BFT, Turbine, Gulf Stream and Sealevel to optimize block propagation, transaction processing, and smart contract execution, all contributing to its high speed and efficiency. + +There are typically two types of nodes: + +- **Validator nodes**: (also called consensus nodes), which secure the Solana network by validating transactions and participating in consensus. +- **RPC nodes**: which act as access points for users and applications, allowing them to submit transactions and query blockchain data via APIs *without* participating in consensus. + +Solana nodes use the following network protocols and ports: + +| Protocol | Usage | Port | Node Types | +| :--- | :--- | :--- | :--- | +| Gossip | Node discovery and cluster info sharing | TCP/UDP 8000-10000 (default 8001) | Validator / RPC | +| JSON-RPC over HTTP | Used by applications to query the blockchain and submit transactions | TCP 8899 | RPC | +| JSON-RPC WebSockets API | Used by applications to query the blockchain and submit transactions | TCP 8900 | RPC | +| QUIC | Ingest transactions from clients, improving network reliability and efficiency | UDP 8000-8002 (may vary) | Validator / RPC | +| Turbine | Network state dissemination and block/shred propagation | TCP/UDP 8000-10000 (default 8003) | Validator / RPC | + +You can find the hardware requirements for Solana Validator and RPC nodes in [the official Anza documentation](https://docs.anza.xyz/operations/requirements). + +## Go further + +Join our [community of users](/links/community). diff --git a/pages/bare_metal_cloud/dedicated_servers/blockchain_anti_ddos/guide.fr-fr.md b/pages/bare_metal_cloud/dedicated_servers/blockchain_anti_ddos/guide.fr-fr.md new file mode 100644 index 00000000000..733306f93a5 --- /dev/null +++ b/pages/bare_metal_cloud/dedicated_servers/blockchain_anti_ddos/guide.fr-fr.md @@ -0,0 +1,64 @@ +--- +title: "Comment configurer l'infrastructure Anti-DDoS pour Solana" +excerpt: "Apprenez à utiliser l'infrastructure Anti-DDoS d'OVHcloud pour protéger vos nœuds Solana sans nuire à leur fonctionnalité" +updated: 2025-10-13 +--- + +> [!primary] +> Les instructions et exemples fournis dans ce guide s'appliquent actuellement exclusivement à la blockchain **Solana**. +> + +## Objectif + +L'objectif de ce guide est de vous aider à mieux comprendre l'infrastructure Anti-DDoS d'OVHcloud et de vous fournir des instructions sur la façon de configurer une protection efficace sans nuire au trafic réseau relatif à la blockchain. + +## Prérequis + +- Au moins un [serveur dédié ](/links/bare-metal/bare-metal) qui respecte les exigences matérielles spécifiques de la blockchain souhaitée. + +## Introduction à la Blockchain + +La blockchain est un registre numérique décentralisé et distribué qui enregistre les transactions sur de nombreux ordinateurs, garantissant que les données ne peuvent pas être modifiées rétroactivement sans la modification de tous les blocs suivants et le consensus du réseau. + +Cette technologie crée un registre inviolable et transparent des informations, telles que les transactions financières, ce qui la rend sécurisée et fiable. + +Dans certains cas, les pics de communication peuvent déclencher l'infrastructure Anti-DDoS et entraîner la détection de certains modèles de trafic comme des faux positifs. + +## En pratique + +Pour éviter que votre trafic réseau ne soit suspecté ou bloqué par l'infrastructure Anti-DDoS (en tant que détection de faux positifs), nous vous recommandons fortement de signaler les adresses IP de vos nœuds à nos équipes de support. Cela permettra de créer un profil Solana personnalisé pour une meilleure protection et une fonctionnalité ininterrompue. + +Pour commencer, veuillez créer un [ticket de demande d'assistance](https://help.ovhcloud.com/csm?id=csm_get_help) avec les options suivantes : Incident -> IP publique -> [x] Ce service n'est pas répertorié -> Créer une demande d'assistance -> `Suivant`{.action}. + +Renseignez ensuite le champ `brève description` avec **"Blockchain Solana Anti-DDoS tuning"**, puis listez les adresses IPv4 de vos nœuds Solana, leurs ports, les types de serveurs qui hébergent les nœuds et la taille de votre cluster (le nombre approximatif de clients connectés) dans la description du problème. + +Veuillez noter qu'à l'avenir, vous pourrez contrôler le comportement Anti-DDoS directement via notre espace client. + +Si vous n'êtes pas sûr des éléments que vous devez envoyer à nos équipes, vous pouvez vous référer aux cas d'utilisation suivants. + +### Cas d'utilisation : Solana + +Solana est une plateforme de blockchain à haute performance connue pour sa vitesse exceptionnelle et ses coûts de transaction faibles, ce qui en fait une alternative populaire pour les applications décentralisées. Elle atteint cela en utilisant une horloge cryptographique unique appelée *Proof of History (PoH*), qui horodate les transactions afin de permettre un traitement parallèle et une plus grande efficacité. Ce système est associé à un mécanisme de consensus *Proof of Stake (PoS)*, où les validateurs sont choisis en fonction de leur SOL en jeu, garantissant que le réseau reste sécurisé et décentralisé. + +L'architecture de Solana utilise également une combinaison de protocoles tels que Tower BFT, Turbine, Gulf Stream et Sealevel pour optimiser la propagation des blocs, le traitement des transactions et l'exécution des contrats intelligents, contribuant tous à sa vitesse et à son efficacité élevées. + +Il existe généralement deux types de nœuds : + +- Les **Nœuds validateurs** (également appelés nœuds de consensus) qui sécurisent le réseau Solana en validant les transactions et en participant au consensus. +- Les **Nœuds RPC** qui agissent comme des points d'accès pour les utilisateurs et les applications, permettant de soumettre des transactions et d'interroger les données de la blockchain via des API *sans* participer au consensus. + +Les nœuds Solana utilisent les protocoles réseau et les ports suivants : + +| Protocole | Utilisation | Port | Types de nœuds | +| :--- | :--- | :--- | :--- | +| Gossip | Découverte de nœuds et partage d'informations de cluster | TCP/UDP 8000-10000 (par défaut 8001) | Validateur / RPC | +| JSON-RPC sur HTTP | Utilisé par les applications pour interroger la blockchain et soumettre des transactions | TCP 8899 | RPC | +| API JSON-RPC WebSockets | Utilisé par les applications pour interroger la blockchain et soumettre des transactions | TCP 8900 | RPC | +| QUIC | Ingestion de transactions à partir de clients, améliorant la fiabilité et l'efficacité du réseau | UDP 8000-8002 (peut varier) | Validateur / RPC | +| Turbine | Diffusion de l'état du réseau et propagation de blocs/shred | TCP/UDP 8000-10000 (par défaut 8003) | Validateur / RPC | + +Vous pouvez trouver les exigences matérielles pour les nœuds Solana Validator et RPC dans [la documentation officielle d'Anza](https://docs.anza.xyz/operations/requirements). + +## Aller plus loin + +Rejoignez notre [communauté d'utilisateurs](/links/community). diff --git a/pages/bare_metal_cloud/dedicated_servers/blockchain_anti_ddos/meta.yaml b/pages/bare_metal_cloud/dedicated_servers/blockchain_anti_ddos/meta.yaml new file mode 100644 index 00000000000..0845f6db036 --- /dev/null +++ b/pages/bare_metal_cloud/dedicated_servers/blockchain_anti_ddos/meta.yaml @@ -0,0 +1,2 @@ +id: 9be9766b-7c68-41bf-8695-64ef982a62c9 +full_slug: network-blockchain-anti-ddos \ No newline at end of file diff --git a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.de-de.md b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.de-de.md index 40e86d68fa2..0260ff67219 100644 --- a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.de-de.md +++ b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.de-de.md @@ -34,7 +34,7 @@ In addition to the requirement and limitations mentioned below, you must ensure There are some technical limitations linked to the use of physical products such as dedicated servers. Here is a non-exhaustive list, to keep in mind during your deployment preparation: - Boot type: **uefi** or **legacy** -- Partition type: **MBR** or **GPT** +- Partition type: **MBR** or **GPT** - Image format: **qcow2** or **raw** > [!warning] @@ -180,7 +180,7 @@ The following table gives an overview of well known customer errors and how to f |image provided has a size of `n` bytes which is larger than `device` of `m` bytes|The image provided has a size that is bigger than the size of the disk chosen for the OS installation.|- If your server has several disk groups, you can try to reinstall the OS on another disk group by specifying the `diskgroupid` argument.
- You need to reduce the size of your image.| |Can't write `t` on disk|Impossible to write qcow2/raw image on disk.|Modify your image so that the command `qemu-img convert -f "$imageType" -O raw $pathToImageFile "$device"` works.| |Could not download, `t` image is too big to download in memory.|Your server doesn't have enough RAM to download the image.|You need to reduce the size of your image.| -|Could not download image located: `url`|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can precise them with the `httpHeaders` argument.| +|Could not download image: ``|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can provide them with the `httpHeaders` argument.| |image provided format is not of type raw because no partition table was found. It seems to contain: `x`|A raw image must contain a partition table.|Check that your image contains a partition table.| |Bad `checkSumType` for downloaded file, got: `n` while expecting `m`.|Incorrect checksum.|- Please ensure that you have specified the correct checksum.
- Check that a download with the `curl` command from your server works in rescue mode.| diff --git a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.en-asia.md b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.en-asia.md index e40c1fb1dab..c569cc73f05 100644 --- a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.en-asia.md +++ b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.en-asia.md @@ -34,7 +34,7 @@ In addition to the requirement and limitations mentioned below, you must ensure There are some technical limitations linked to the use of physical products such as dedicated servers. Here is a non-exhaustive list, to keep in mind during your deployment preparation: - Boot type: **uefi** or **legacy** -- Partition type: **MBR** or **GPT** +- Partition type: **MBR** or **GPT** - Image format: **qcow2** or **raw** > [!warning] @@ -180,7 +180,7 @@ The following table gives an overview of well known customer errors and how to f |image provided has a size of `n` bytes which is larger than `device` of `m` bytes|The image provided has a size that is bigger than the size of the disk chosen for the OS installation.|- If your server has several disk groups, you can try to reinstall the OS on another disk group by specifying the `diskgroupid` argument.
- You need to reduce the size of your image.| |Can't write `t` on disk|Impossible to write qcow2/raw image on disk.|Modify your image so that the command `qemu-img convert -f "$imageType" -O raw $pathToImageFile "$device"` works.| |Could not download, `t` image is too big to download in memory.|Your server doesn't have enough RAM to download the image.|You need to reduce the size of your image.| -|Could not download image located: `url`|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can precise them with the `httpHeaders` argument.| +|Could not download image: ``|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can provide them with the `httpHeaders` argument.| |image provided format is not of type raw because no partition table was found. It seems to contain: `x`|A raw image must contain a partition table.|Check that your image contains a partition table.| |Bad `checkSumType` for downloaded file, got: `n` while expecting `m`.|Incorrect checksum.|- Please ensure that you have specified the correct checksum.
- Check that a download with the `curl` command from your server works in rescue mode.| diff --git a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.en-au.md b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.en-au.md index e40c1fb1dab..c569cc73f05 100644 --- a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.en-au.md +++ b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.en-au.md @@ -34,7 +34,7 @@ In addition to the requirement and limitations mentioned below, you must ensure There are some technical limitations linked to the use of physical products such as dedicated servers. Here is a non-exhaustive list, to keep in mind during your deployment preparation: - Boot type: **uefi** or **legacy** -- Partition type: **MBR** or **GPT** +- Partition type: **MBR** or **GPT** - Image format: **qcow2** or **raw** > [!warning] @@ -180,7 +180,7 @@ The following table gives an overview of well known customer errors and how to f |image provided has a size of `n` bytes which is larger than `device` of `m` bytes|The image provided has a size that is bigger than the size of the disk chosen for the OS installation.|- If your server has several disk groups, you can try to reinstall the OS on another disk group by specifying the `diskgroupid` argument.
- You need to reduce the size of your image.| |Can't write `t` on disk|Impossible to write qcow2/raw image on disk.|Modify your image so that the command `qemu-img convert -f "$imageType" -O raw $pathToImageFile "$device"` works.| |Could not download, `t` image is too big to download in memory.|Your server doesn't have enough RAM to download the image.|You need to reduce the size of your image.| -|Could not download image located: `url`|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can precise them with the `httpHeaders` argument.| +|Could not download image: ``|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can provide them with the `httpHeaders` argument.| |image provided format is not of type raw because no partition table was found. It seems to contain: `x`|A raw image must contain a partition table.|Check that your image contains a partition table.| |Bad `checkSumType` for downloaded file, got: `n` while expecting `m`.|Incorrect checksum.|- Please ensure that you have specified the correct checksum.
- Check that a download with the `curl` command from your server works in rescue mode.| diff --git a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.en-ca.md b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.en-ca.md index e40c1fb1dab..c569cc73f05 100644 --- a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.en-ca.md +++ b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.en-ca.md @@ -34,7 +34,7 @@ In addition to the requirement and limitations mentioned below, you must ensure There are some technical limitations linked to the use of physical products such as dedicated servers. Here is a non-exhaustive list, to keep in mind during your deployment preparation: - Boot type: **uefi** or **legacy** -- Partition type: **MBR** or **GPT** +- Partition type: **MBR** or **GPT** - Image format: **qcow2** or **raw** > [!warning] @@ -180,7 +180,7 @@ The following table gives an overview of well known customer errors and how to f |image provided has a size of `n` bytes which is larger than `device` of `m` bytes|The image provided has a size that is bigger than the size of the disk chosen for the OS installation.|- If your server has several disk groups, you can try to reinstall the OS on another disk group by specifying the `diskgroupid` argument.
- You need to reduce the size of your image.| |Can't write `t` on disk|Impossible to write qcow2/raw image on disk.|Modify your image so that the command `qemu-img convert -f "$imageType" -O raw $pathToImageFile "$device"` works.| |Could not download, `t` image is too big to download in memory.|Your server doesn't have enough RAM to download the image.|You need to reduce the size of your image.| -|Could not download image located: `url`|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can precise them with the `httpHeaders` argument.| +|Could not download image: ``|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can provide them with the `httpHeaders` argument.| |image provided format is not of type raw because no partition table was found. It seems to contain: `x`|A raw image must contain a partition table.|Check that your image contains a partition table.| |Bad `checkSumType` for downloaded file, got: `n` while expecting `m`.|Incorrect checksum.|- Please ensure that you have specified the correct checksum.
- Check that a download with the `curl` command from your server works in rescue mode.| diff --git a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.en-gb.md b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.en-gb.md index e40c1fb1dab..c569cc73f05 100644 --- a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.en-gb.md +++ b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.en-gb.md @@ -34,7 +34,7 @@ In addition to the requirement and limitations mentioned below, you must ensure There are some technical limitations linked to the use of physical products such as dedicated servers. Here is a non-exhaustive list, to keep in mind during your deployment preparation: - Boot type: **uefi** or **legacy** -- Partition type: **MBR** or **GPT** +- Partition type: **MBR** or **GPT** - Image format: **qcow2** or **raw** > [!warning] @@ -180,7 +180,7 @@ The following table gives an overview of well known customer errors and how to f |image provided has a size of `n` bytes which is larger than `device` of `m` bytes|The image provided has a size that is bigger than the size of the disk chosen for the OS installation.|- If your server has several disk groups, you can try to reinstall the OS on another disk group by specifying the `diskgroupid` argument.
- You need to reduce the size of your image.| |Can't write `t` on disk|Impossible to write qcow2/raw image on disk.|Modify your image so that the command `qemu-img convert -f "$imageType" -O raw $pathToImageFile "$device"` works.| |Could not download, `t` image is too big to download in memory.|Your server doesn't have enough RAM to download the image.|You need to reduce the size of your image.| -|Could not download image located: `url`|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can precise them with the `httpHeaders` argument.| +|Could not download image: ``|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can provide them with the `httpHeaders` argument.| |image provided format is not of type raw because no partition table was found. It seems to contain: `x`|A raw image must contain a partition table.|Check that your image contains a partition table.| |Bad `checkSumType` for downloaded file, got: `n` while expecting `m`.|Incorrect checksum.|- Please ensure that you have specified the correct checksum.
- Check that a download with the `curl` command from your server works in rescue mode.| diff --git a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.en-ie.md b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.en-ie.md index e40c1fb1dab..c569cc73f05 100644 --- a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.en-ie.md +++ b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.en-ie.md @@ -34,7 +34,7 @@ In addition to the requirement and limitations mentioned below, you must ensure There are some technical limitations linked to the use of physical products such as dedicated servers. Here is a non-exhaustive list, to keep in mind during your deployment preparation: - Boot type: **uefi** or **legacy** -- Partition type: **MBR** or **GPT** +- Partition type: **MBR** or **GPT** - Image format: **qcow2** or **raw** > [!warning] @@ -180,7 +180,7 @@ The following table gives an overview of well known customer errors and how to f |image provided has a size of `n` bytes which is larger than `device` of `m` bytes|The image provided has a size that is bigger than the size of the disk chosen for the OS installation.|- If your server has several disk groups, you can try to reinstall the OS on another disk group by specifying the `diskgroupid` argument.
- You need to reduce the size of your image.| |Can't write `t` on disk|Impossible to write qcow2/raw image on disk.|Modify your image so that the command `qemu-img convert -f "$imageType" -O raw $pathToImageFile "$device"` works.| |Could not download, `t` image is too big to download in memory.|Your server doesn't have enough RAM to download the image.|You need to reduce the size of your image.| -|Could not download image located: `url`|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can precise them with the `httpHeaders` argument.| +|Could not download image: ``|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can provide them with the `httpHeaders` argument.| |image provided format is not of type raw because no partition table was found. It seems to contain: `x`|A raw image must contain a partition table.|Check that your image contains a partition table.| |Bad `checkSumType` for downloaded file, got: `n` while expecting `m`.|Incorrect checksum.|- Please ensure that you have specified the correct checksum.
- Check that a download with the `curl` command from your server works in rescue mode.| diff --git a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.en-sg.md b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.en-sg.md index e40c1fb1dab..c569cc73f05 100644 --- a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.en-sg.md +++ b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.en-sg.md @@ -34,7 +34,7 @@ In addition to the requirement and limitations mentioned below, you must ensure There are some technical limitations linked to the use of physical products such as dedicated servers. Here is a non-exhaustive list, to keep in mind during your deployment preparation: - Boot type: **uefi** or **legacy** -- Partition type: **MBR** or **GPT** +- Partition type: **MBR** or **GPT** - Image format: **qcow2** or **raw** > [!warning] @@ -180,7 +180,7 @@ The following table gives an overview of well known customer errors and how to f |image provided has a size of `n` bytes which is larger than `device` of `m` bytes|The image provided has a size that is bigger than the size of the disk chosen for the OS installation.|- If your server has several disk groups, you can try to reinstall the OS on another disk group by specifying the `diskgroupid` argument.
- You need to reduce the size of your image.| |Can't write `t` on disk|Impossible to write qcow2/raw image on disk.|Modify your image so that the command `qemu-img convert -f "$imageType" -O raw $pathToImageFile "$device"` works.| |Could not download, `t` image is too big to download in memory.|Your server doesn't have enough RAM to download the image.|You need to reduce the size of your image.| -|Could not download image located: `url`|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can precise them with the `httpHeaders` argument.| +|Could not download image: ``|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can provide them with the `httpHeaders` argument.| |image provided format is not of type raw because no partition table was found. It seems to contain: `x`|A raw image must contain a partition table.|Check that your image contains a partition table.| |Bad `checkSumType` for downloaded file, got: `n` while expecting `m`.|Incorrect checksum.|- Please ensure that you have specified the correct checksum.
- Check that a download with the `curl` command from your server works in rescue mode.| diff --git a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.en-us.md b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.en-us.md index e40c1fb1dab..c569cc73f05 100644 --- a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.en-us.md +++ b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.en-us.md @@ -34,7 +34,7 @@ In addition to the requirement and limitations mentioned below, you must ensure There are some technical limitations linked to the use of physical products such as dedicated servers. Here is a non-exhaustive list, to keep in mind during your deployment preparation: - Boot type: **uefi** or **legacy** -- Partition type: **MBR** or **GPT** +- Partition type: **MBR** or **GPT** - Image format: **qcow2** or **raw** > [!warning] @@ -180,7 +180,7 @@ The following table gives an overview of well known customer errors and how to f |image provided has a size of `n` bytes which is larger than `device` of `m` bytes|The image provided has a size that is bigger than the size of the disk chosen for the OS installation.|- If your server has several disk groups, you can try to reinstall the OS on another disk group by specifying the `diskgroupid` argument.
- You need to reduce the size of your image.| |Can't write `t` on disk|Impossible to write qcow2/raw image on disk.|Modify your image so that the command `qemu-img convert -f "$imageType" -O raw $pathToImageFile "$device"` works.| |Could not download, `t` image is too big to download in memory.|Your server doesn't have enough RAM to download the image.|You need to reduce the size of your image.| -|Could not download image located: `url`|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can precise them with the `httpHeaders` argument.| +|Could not download image: ``|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can provide them with the `httpHeaders` argument.| |image provided format is not of type raw because no partition table was found. It seems to contain: `x`|A raw image must contain a partition table.|Check that your image contains a partition table.| |Bad `checkSumType` for downloaded file, got: `n` while expecting `m`.|Incorrect checksum.|- Please ensure that you have specified the correct checksum.
- Check that a download with the `curl` command from your server works in rescue mode.| diff --git a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.es-es.md b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.es-es.md index 40e86d68fa2..0260ff67219 100644 --- a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.es-es.md +++ b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.es-es.md @@ -34,7 +34,7 @@ In addition to the requirement and limitations mentioned below, you must ensure There are some technical limitations linked to the use of physical products such as dedicated servers. Here is a non-exhaustive list, to keep in mind during your deployment preparation: - Boot type: **uefi** or **legacy** -- Partition type: **MBR** or **GPT** +- Partition type: **MBR** or **GPT** - Image format: **qcow2** or **raw** > [!warning] @@ -180,7 +180,7 @@ The following table gives an overview of well known customer errors and how to f |image provided has a size of `n` bytes which is larger than `device` of `m` bytes|The image provided has a size that is bigger than the size of the disk chosen for the OS installation.|- If your server has several disk groups, you can try to reinstall the OS on another disk group by specifying the `diskgroupid` argument.
- You need to reduce the size of your image.| |Can't write `t` on disk|Impossible to write qcow2/raw image on disk.|Modify your image so that the command `qemu-img convert -f "$imageType" -O raw $pathToImageFile "$device"` works.| |Could not download, `t` image is too big to download in memory.|Your server doesn't have enough RAM to download the image.|You need to reduce the size of your image.| -|Could not download image located: `url`|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can precise them with the `httpHeaders` argument.| +|Could not download image: ``|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can provide them with the `httpHeaders` argument.| |image provided format is not of type raw because no partition table was found. It seems to contain: `x`|A raw image must contain a partition table.|Check that your image contains a partition table.| |Bad `checkSumType` for downloaded file, got: `n` while expecting `m`.|Incorrect checksum.|- Please ensure that you have specified the correct checksum.
- Check that a download with the `curl` command from your server works in rescue mode.| diff --git a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.es-us.md b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.es-us.md index 40e86d68fa2..0260ff67219 100644 --- a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.es-us.md +++ b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.es-us.md @@ -34,7 +34,7 @@ In addition to the requirement and limitations mentioned below, you must ensure There are some technical limitations linked to the use of physical products such as dedicated servers. Here is a non-exhaustive list, to keep in mind during your deployment preparation: - Boot type: **uefi** or **legacy** -- Partition type: **MBR** or **GPT** +- Partition type: **MBR** or **GPT** - Image format: **qcow2** or **raw** > [!warning] @@ -180,7 +180,7 @@ The following table gives an overview of well known customer errors and how to f |image provided has a size of `n` bytes which is larger than `device` of `m` bytes|The image provided has a size that is bigger than the size of the disk chosen for the OS installation.|- If your server has several disk groups, you can try to reinstall the OS on another disk group by specifying the `diskgroupid` argument.
- You need to reduce the size of your image.| |Can't write `t` on disk|Impossible to write qcow2/raw image on disk.|Modify your image so that the command `qemu-img convert -f "$imageType" -O raw $pathToImageFile "$device"` works.| |Could not download, `t` image is too big to download in memory.|Your server doesn't have enough RAM to download the image.|You need to reduce the size of your image.| -|Could not download image located: `url`|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can precise them with the `httpHeaders` argument.| +|Could not download image: ``|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can provide them with the `httpHeaders` argument.| |image provided format is not of type raw because no partition table was found. It seems to contain: `x`|A raw image must contain a partition table.|Check that your image contains a partition table.| |Bad `checkSumType` for downloaded file, got: `n` while expecting `m`.|Incorrect checksum.|- Please ensure that you have specified the correct checksum.
- Check that a download with the `curl` command from your server works in rescue mode.| diff --git a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.fr-ca.md b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.fr-ca.md index cc56d7cada4..7baa36b4a39 100644 --- a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.fr-ca.md +++ b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.fr-ca.md @@ -180,7 +180,7 @@ Le tableau suivant donne un aperçu des erreurs clients les plus connues et de l |image provided has a size of `n` bytes which is larger than `device` of `m` bytes|L'image spécifiée a une taille supérieure à celle du disque choisi pour l'installation.|- Si votre serveur possède plusieurs grappes de disques, vous pouvez réessayez une installation sur une autre grappe de disques à l'aide de l'argument `diskgroupid`.
- Vous devez réduire la taille de votre image.| |Can't write `t` on disk|Impossible d'écrire l'image qcow2/raw sur le disque.|Modifier votre image de telle sorte que la commande `qemu-img convert -f "$imageType" -O raw $pathToImageFile "$device"` fonctionne.| |Could not download, `t` image is too big to download in memory.|Il n'y a pas assez d'espace en RAM pour télécharger l'image.|Réduisez la taille de votre image.| -|Could not download image located : `url`|Impossible de télécharger l'image située : `imageURL`.|Vérifiez qu'un téléchargement avec `curl` depuis votre serveur en rescue fonctionne. Si des en-têtes HTTP sont requises, vous devez les spécifier à l'aide des paramètres `httpHeaders`.| +|Could not download image: ``|Impossible de télécharger l'image depuis `imageURL`.|Vérifiez qu'un téléchargement avec `curl` depuis votre serveur en rescue fonctionne. Si des en-têtes HTTP sont requis, vous devez les spécifier à l'aide des paramètres `httpHeaders`.| |image provided format is not of type raw because no partition table was found. It seems to contain: `x`|Une image de type raw doit contenir une table de partitions|Vérifiez que votre image contient bien une table de partitions.| |Bad `checkSumType` for downloaded file, got : `n` while expecting `m`.|Le checksum est incorrect.|- Assurez-vous de spécifier le bon checksum
- Vérifiez qu'un téléchargement avec `curl` depuis votre serveur en rescue fonctionne.| diff --git a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.fr-fr.md b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.fr-fr.md index cc56d7cada4..7baa36b4a39 100644 --- a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.fr-fr.md +++ b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.fr-fr.md @@ -180,7 +180,7 @@ Le tableau suivant donne un aperçu des erreurs clients les plus connues et de l |image provided has a size of `n` bytes which is larger than `device` of `m` bytes|L'image spécifiée a une taille supérieure à celle du disque choisi pour l'installation.|- Si votre serveur possède plusieurs grappes de disques, vous pouvez réessayez une installation sur une autre grappe de disques à l'aide de l'argument `diskgroupid`.
- Vous devez réduire la taille de votre image.| |Can't write `t` on disk|Impossible d'écrire l'image qcow2/raw sur le disque.|Modifier votre image de telle sorte que la commande `qemu-img convert -f "$imageType" -O raw $pathToImageFile "$device"` fonctionne.| |Could not download, `t` image is too big to download in memory.|Il n'y a pas assez d'espace en RAM pour télécharger l'image.|Réduisez la taille de votre image.| -|Could not download image located : `url`|Impossible de télécharger l'image située : `imageURL`.|Vérifiez qu'un téléchargement avec `curl` depuis votre serveur en rescue fonctionne. Si des en-têtes HTTP sont requises, vous devez les spécifier à l'aide des paramètres `httpHeaders`.| +|Could not download image: ``|Impossible de télécharger l'image depuis `imageURL`.|Vérifiez qu'un téléchargement avec `curl` depuis votre serveur en rescue fonctionne. Si des en-têtes HTTP sont requis, vous devez les spécifier à l'aide des paramètres `httpHeaders`.| |image provided format is not of type raw because no partition table was found. It seems to contain: `x`|Une image de type raw doit contenir une table de partitions|Vérifiez que votre image contient bien une table de partitions.| |Bad `checkSumType` for downloaded file, got : `n` while expecting `m`.|Le checksum est incorrect.|- Assurez-vous de spécifier le bon checksum
- Vérifiez qu'un téléchargement avec `curl` depuis votre serveur en rescue fonctionne.| diff --git a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.it-it.md b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.it-it.md index 40e86d68fa2..0260ff67219 100644 --- a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.it-it.md +++ b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.it-it.md @@ -34,7 +34,7 @@ In addition to the requirement and limitations mentioned below, you must ensure There are some technical limitations linked to the use of physical products such as dedicated servers. Here is a non-exhaustive list, to keep in mind during your deployment preparation: - Boot type: **uefi** or **legacy** -- Partition type: **MBR** or **GPT** +- Partition type: **MBR** or **GPT** - Image format: **qcow2** or **raw** > [!warning] @@ -180,7 +180,7 @@ The following table gives an overview of well known customer errors and how to f |image provided has a size of `n` bytes which is larger than `device` of `m` bytes|The image provided has a size that is bigger than the size of the disk chosen for the OS installation.|- If your server has several disk groups, you can try to reinstall the OS on another disk group by specifying the `diskgroupid` argument.
- You need to reduce the size of your image.| |Can't write `t` on disk|Impossible to write qcow2/raw image on disk.|Modify your image so that the command `qemu-img convert -f "$imageType" -O raw $pathToImageFile "$device"` works.| |Could not download, `t` image is too big to download in memory.|Your server doesn't have enough RAM to download the image.|You need to reduce the size of your image.| -|Could not download image located: `url`|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can precise them with the `httpHeaders` argument.| +|Could not download image: ``|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can provide them with the `httpHeaders` argument.| |image provided format is not of type raw because no partition table was found. It seems to contain: `x`|A raw image must contain a partition table.|Check that your image contains a partition table.| |Bad `checkSumType` for downloaded file, got: `n` while expecting `m`.|Incorrect checksum.|- Please ensure that you have specified the correct checksum.
- Check that a download with the `curl` command from your server works in rescue mode.| diff --git a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.pl-pl.md b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.pl-pl.md index 40e86d68fa2..0260ff67219 100755 --- a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.pl-pl.md +++ b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.pl-pl.md @@ -34,7 +34,7 @@ In addition to the requirement and limitations mentioned below, you must ensure There are some technical limitations linked to the use of physical products such as dedicated servers. Here is a non-exhaustive list, to keep in mind during your deployment preparation: - Boot type: **uefi** or **legacy** -- Partition type: **MBR** or **GPT** +- Partition type: **MBR** or **GPT** - Image format: **qcow2** or **raw** > [!warning] @@ -180,7 +180,7 @@ The following table gives an overview of well known customer errors and how to f |image provided has a size of `n` bytes which is larger than `device` of `m` bytes|The image provided has a size that is bigger than the size of the disk chosen for the OS installation.|- If your server has several disk groups, you can try to reinstall the OS on another disk group by specifying the `diskgroupid` argument.
- You need to reduce the size of your image.| |Can't write `t` on disk|Impossible to write qcow2/raw image on disk.|Modify your image so that the command `qemu-img convert -f "$imageType" -O raw $pathToImageFile "$device"` works.| |Could not download, `t` image is too big to download in memory.|Your server doesn't have enough RAM to download the image.|You need to reduce the size of your image.| -|Could not download image located: `url`|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can precise them with the `httpHeaders` argument.| +|Could not download image: ``|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can provide them with the `httpHeaders` argument.| |image provided format is not of type raw because no partition table was found. It seems to contain: `x`|A raw image must contain a partition table.|Check that your image contains a partition table.| |Bad `checkSumType` for downloaded file, got: `n` while expecting `m`.|Incorrect checksum.|- Please ensure that you have specified the correct checksum.
- Check that a download with the `curl` command from your server works in rescue mode.| diff --git a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.pt-pt.md b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.pt-pt.md index 40e86d68fa2..0260ff67219 100644 --- a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.pt-pt.md +++ b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-image/guide.pt-pt.md @@ -34,7 +34,7 @@ In addition to the requirement and limitations mentioned below, you must ensure There are some technical limitations linked to the use of physical products such as dedicated servers. Here is a non-exhaustive list, to keep in mind during your deployment preparation: - Boot type: **uefi** or **legacy** -- Partition type: **MBR** or **GPT** +- Partition type: **MBR** or **GPT** - Image format: **qcow2** or **raw** > [!warning] @@ -180,7 +180,7 @@ The following table gives an overview of well known customer errors and how to f |image provided has a size of `n` bytes which is larger than `device` of `m` bytes|The image provided has a size that is bigger than the size of the disk chosen for the OS installation.|- If your server has several disk groups, you can try to reinstall the OS on another disk group by specifying the `diskgroupid` argument.
- You need to reduce the size of your image.| |Can't write `t` on disk|Impossible to write qcow2/raw image on disk.|Modify your image so that the command `qemu-img convert -f "$imageType" -O raw $pathToImageFile "$device"` works.| |Could not download, `t` image is too big to download in memory.|Your server doesn't have enough RAM to download the image.|You need to reduce the size of your image.| -|Could not download image located: `url`|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can precise them with the `httpHeaders` argument.| +|Could not download image: ``|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can provide them with the `httpHeaders` argument.| |image provided format is not of type raw because no partition table was found. It seems to contain: `x`|A raw image must contain a partition table.|Check that your image contains a partition table.| |Bad `checkSumType` for downloaded file, got: `n` while expecting `m`.|Incorrect checksum.|- Please ensure that you have specified the correct checksum.
- Check that a download with the `curl` command from your server works in rescue mode.| diff --git a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.de-de.md b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.de-de.md index 57e97112bdf..26d5553fc6c 100644 --- a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.de-de.md +++ b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.de-de.md @@ -1,7 +1,7 @@ --- title: Bring Your Own Linux (BYOLinux) (EN) excerpt: Find out how to easily deploy your own Linux images on dedicated servers -updated: 2025-06-05 +updated: 2025-09-30 --- ## Objective @@ -34,8 +34,7 @@ In addition to the requirement and limitations mentioned below, you must ensure There are some technical limitations linked to the use of physical products such as dedicated servers. Here is a non-exhaustive list, to keep in mind during your deployment preparation: -- Boot type: **uefi** or **legacy** -- Partition type: **MBR** or **GPT** +- Boot type: **UEFI** or **legacy** (depending on the boot type of your server) - Image format: **qcow2** - Only one partition in the qcow2 image @@ -176,7 +175,7 @@ The following table gives an overview of well known customer errors and how to f |image provided has a size of `n` bytes which is larger than `device` of `m` bytes|Image provided has a size that is bigger than the size of the disk chosen for the OS installation.|- If your server has several disk groups, you can try to reinstall the OS on another disk group by specifying the `diskgroupid` argument.
- You need to reduce the size of your image.| |Can't write qcow2 on disk|Impossible to write qcow2 image on disk.|Modify your image so that the command `qemu-img convert -f "$imageType" -O raw $pathToImageFile "$device"` works.| |Could not download, qcow2 image is too big to download in memory.|Your server doesn't have enough RAM to download the image.|You need to reduce the size of your image.| -|Could not download image located: `url`|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can precise them with the `httpHeaders` argument.| +|Could not download image: ``|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can provide them with the `httpHeaders` argument.| |Bad `checkSumType` for downloaded file, got: `n` while expecting `m`.|Incorrect checksum.|- Please ensure that you have specified the correct checksum.
- Check that a download with the `curl` command from your server works in rescue mode.| See OVHcloud API and Storage [Common customer errors](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh#errors) for related partitioning issues. diff --git a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.en-asia.md b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.en-asia.md index c7c13bbfcb3..db59e88b438 100644 --- a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.en-asia.md +++ b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.en-asia.md @@ -1,7 +1,7 @@ --- title: Bring Your Own Linux (BYOLinux) excerpt: Find out how to easily deploy your own Linux images on dedicated servers -updated: 2025-06-05 +updated: 2025-09-30 --- ## Objective @@ -34,8 +34,7 @@ In addition to the requirement and limitations mentioned below, you must ensure There are some technical limitations linked to the use of physical products such as dedicated servers. Here is a non-exhaustive list, to keep in mind during your deployment preparation: -- Boot type: **uefi** or **legacy** -- Partition type: **MBR** or **GPT** +- Boot type: **UEFI** or **legacy** (depending on the boot type of your server) - Image format: **qcow2** - Only one partition in the qcow2 image @@ -176,7 +175,7 @@ The following table gives an overview of well known customer errors and how to f |image provided has a size of `n` bytes which is larger than `device` of `m` bytes|Image provided has a size that is bigger than the size of the disk chosen for the OS installation.|- If your server has several disk groups, you can try to reinstall the OS on another disk group by specifying the `diskgroupid` argument.
- You need to reduce the size of your image.| |Can't write qcow2 on disk|Impossible to write qcow2 image on disk.|Modify your image so that the command `qemu-img convert -f "$imageType" -O raw $pathToImageFile "$device"` works.| |Could not download, qcow2 image is too big to download in memory.|Your server doesn't have enough RAM to download the image.|You need to reduce the size of your image.| -|Could not download image located: `url`|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can precise them with the `httpHeaders` argument.| +|Could not download image: ``|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can provide them with the `httpHeaders` argument.| |Bad `checkSumType` for downloaded file, got: `n` while expecting `m`.|Incorrect checksum.|- Please ensure that you have specified the correct checksum.
- Check that a download with the `curl` command from your server works in rescue mode.| See OVHcloud API and Storage [Common customer errors](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh#errors) for related partitioning issues. diff --git a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.en-au.md b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.en-au.md index c7c13bbfcb3..db59e88b438 100644 --- a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.en-au.md +++ b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.en-au.md @@ -1,7 +1,7 @@ --- title: Bring Your Own Linux (BYOLinux) excerpt: Find out how to easily deploy your own Linux images on dedicated servers -updated: 2025-06-05 +updated: 2025-09-30 --- ## Objective @@ -34,8 +34,7 @@ In addition to the requirement and limitations mentioned below, you must ensure There are some technical limitations linked to the use of physical products such as dedicated servers. Here is a non-exhaustive list, to keep in mind during your deployment preparation: -- Boot type: **uefi** or **legacy** -- Partition type: **MBR** or **GPT** +- Boot type: **UEFI** or **legacy** (depending on the boot type of your server) - Image format: **qcow2** - Only one partition in the qcow2 image @@ -176,7 +175,7 @@ The following table gives an overview of well known customer errors and how to f |image provided has a size of `n` bytes which is larger than `device` of `m` bytes|Image provided has a size that is bigger than the size of the disk chosen for the OS installation.|- If your server has several disk groups, you can try to reinstall the OS on another disk group by specifying the `diskgroupid` argument.
- You need to reduce the size of your image.| |Can't write qcow2 on disk|Impossible to write qcow2 image on disk.|Modify your image so that the command `qemu-img convert -f "$imageType" -O raw $pathToImageFile "$device"` works.| |Could not download, qcow2 image is too big to download in memory.|Your server doesn't have enough RAM to download the image.|You need to reduce the size of your image.| -|Could not download image located: `url`|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can precise them with the `httpHeaders` argument.| +|Could not download image: ``|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can provide them with the `httpHeaders` argument.| |Bad `checkSumType` for downloaded file, got: `n` while expecting `m`.|Incorrect checksum.|- Please ensure that you have specified the correct checksum.
- Check that a download with the `curl` command from your server works in rescue mode.| See OVHcloud API and Storage [Common customer errors](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh#errors) for related partitioning issues. diff --git a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.en-ca.md b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.en-ca.md index c7c13bbfcb3..db59e88b438 100644 --- a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.en-ca.md +++ b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.en-ca.md @@ -1,7 +1,7 @@ --- title: Bring Your Own Linux (BYOLinux) excerpt: Find out how to easily deploy your own Linux images on dedicated servers -updated: 2025-06-05 +updated: 2025-09-30 --- ## Objective @@ -34,8 +34,7 @@ In addition to the requirement and limitations mentioned below, you must ensure There are some technical limitations linked to the use of physical products such as dedicated servers. Here is a non-exhaustive list, to keep in mind during your deployment preparation: -- Boot type: **uefi** or **legacy** -- Partition type: **MBR** or **GPT** +- Boot type: **UEFI** or **legacy** (depending on the boot type of your server) - Image format: **qcow2** - Only one partition in the qcow2 image @@ -176,7 +175,7 @@ The following table gives an overview of well known customer errors and how to f |image provided has a size of `n` bytes which is larger than `device` of `m` bytes|Image provided has a size that is bigger than the size of the disk chosen for the OS installation.|- If your server has several disk groups, you can try to reinstall the OS on another disk group by specifying the `diskgroupid` argument.
- You need to reduce the size of your image.| |Can't write qcow2 on disk|Impossible to write qcow2 image on disk.|Modify your image so that the command `qemu-img convert -f "$imageType" -O raw $pathToImageFile "$device"` works.| |Could not download, qcow2 image is too big to download in memory.|Your server doesn't have enough RAM to download the image.|You need to reduce the size of your image.| -|Could not download image located: `url`|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can precise them with the `httpHeaders` argument.| +|Could not download image: ``|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can provide them with the `httpHeaders` argument.| |Bad `checkSumType` for downloaded file, got: `n` while expecting `m`.|Incorrect checksum.|- Please ensure that you have specified the correct checksum.
- Check that a download with the `curl` command from your server works in rescue mode.| See OVHcloud API and Storage [Common customer errors](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh#errors) for related partitioning issues. diff --git a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.en-gb.md b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.en-gb.md index c7c13bbfcb3..db59e88b438 100644 --- a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.en-gb.md +++ b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.en-gb.md @@ -1,7 +1,7 @@ --- title: Bring Your Own Linux (BYOLinux) excerpt: Find out how to easily deploy your own Linux images on dedicated servers -updated: 2025-06-05 +updated: 2025-09-30 --- ## Objective @@ -34,8 +34,7 @@ In addition to the requirement and limitations mentioned below, you must ensure There are some technical limitations linked to the use of physical products such as dedicated servers. Here is a non-exhaustive list, to keep in mind during your deployment preparation: -- Boot type: **uefi** or **legacy** -- Partition type: **MBR** or **GPT** +- Boot type: **UEFI** or **legacy** (depending on the boot type of your server) - Image format: **qcow2** - Only one partition in the qcow2 image @@ -176,7 +175,7 @@ The following table gives an overview of well known customer errors and how to f |image provided has a size of `n` bytes which is larger than `device` of `m` bytes|Image provided has a size that is bigger than the size of the disk chosen for the OS installation.|- If your server has several disk groups, you can try to reinstall the OS on another disk group by specifying the `diskgroupid` argument.
- You need to reduce the size of your image.| |Can't write qcow2 on disk|Impossible to write qcow2 image on disk.|Modify your image so that the command `qemu-img convert -f "$imageType" -O raw $pathToImageFile "$device"` works.| |Could not download, qcow2 image is too big to download in memory.|Your server doesn't have enough RAM to download the image.|You need to reduce the size of your image.| -|Could not download image located: `url`|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can precise them with the `httpHeaders` argument.| +|Could not download image: ``|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can provide them with the `httpHeaders` argument.| |Bad `checkSumType` for downloaded file, got: `n` while expecting `m`.|Incorrect checksum.|- Please ensure that you have specified the correct checksum.
- Check that a download with the `curl` command from your server works in rescue mode.| See OVHcloud API and Storage [Common customer errors](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh#errors) for related partitioning issues. diff --git a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.en-ie.md b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.en-ie.md index c7c13bbfcb3..db59e88b438 100644 --- a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.en-ie.md +++ b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.en-ie.md @@ -1,7 +1,7 @@ --- title: Bring Your Own Linux (BYOLinux) excerpt: Find out how to easily deploy your own Linux images on dedicated servers -updated: 2025-06-05 +updated: 2025-09-30 --- ## Objective @@ -34,8 +34,7 @@ In addition to the requirement and limitations mentioned below, you must ensure There are some technical limitations linked to the use of physical products such as dedicated servers. Here is a non-exhaustive list, to keep in mind during your deployment preparation: -- Boot type: **uefi** or **legacy** -- Partition type: **MBR** or **GPT** +- Boot type: **UEFI** or **legacy** (depending on the boot type of your server) - Image format: **qcow2** - Only one partition in the qcow2 image @@ -176,7 +175,7 @@ The following table gives an overview of well known customer errors and how to f |image provided has a size of `n` bytes which is larger than `device` of `m` bytes|Image provided has a size that is bigger than the size of the disk chosen for the OS installation.|- If your server has several disk groups, you can try to reinstall the OS on another disk group by specifying the `diskgroupid` argument.
- You need to reduce the size of your image.| |Can't write qcow2 on disk|Impossible to write qcow2 image on disk.|Modify your image so that the command `qemu-img convert -f "$imageType" -O raw $pathToImageFile "$device"` works.| |Could not download, qcow2 image is too big to download in memory.|Your server doesn't have enough RAM to download the image.|You need to reduce the size of your image.| -|Could not download image located: `url`|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can precise them with the `httpHeaders` argument.| +|Could not download image: ``|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can provide them with the `httpHeaders` argument.| |Bad `checkSumType` for downloaded file, got: `n` while expecting `m`.|Incorrect checksum.|- Please ensure that you have specified the correct checksum.
- Check that a download with the `curl` command from your server works in rescue mode.| See OVHcloud API and Storage [Common customer errors](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh#errors) for related partitioning issues. diff --git a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.en-sg.md b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.en-sg.md index c7c13bbfcb3..db59e88b438 100644 --- a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.en-sg.md +++ b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.en-sg.md @@ -1,7 +1,7 @@ --- title: Bring Your Own Linux (BYOLinux) excerpt: Find out how to easily deploy your own Linux images on dedicated servers -updated: 2025-06-05 +updated: 2025-09-30 --- ## Objective @@ -34,8 +34,7 @@ In addition to the requirement and limitations mentioned below, you must ensure There are some technical limitations linked to the use of physical products such as dedicated servers. Here is a non-exhaustive list, to keep in mind during your deployment preparation: -- Boot type: **uefi** or **legacy** -- Partition type: **MBR** or **GPT** +- Boot type: **UEFI** or **legacy** (depending on the boot type of your server) - Image format: **qcow2** - Only one partition in the qcow2 image @@ -176,7 +175,7 @@ The following table gives an overview of well known customer errors and how to f |image provided has a size of `n` bytes which is larger than `device` of `m` bytes|Image provided has a size that is bigger than the size of the disk chosen for the OS installation.|- If your server has several disk groups, you can try to reinstall the OS on another disk group by specifying the `diskgroupid` argument.
- You need to reduce the size of your image.| |Can't write qcow2 on disk|Impossible to write qcow2 image on disk.|Modify your image so that the command `qemu-img convert -f "$imageType" -O raw $pathToImageFile "$device"` works.| |Could not download, qcow2 image is too big to download in memory.|Your server doesn't have enough RAM to download the image.|You need to reduce the size of your image.| -|Could not download image located: `url`|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can precise them with the `httpHeaders` argument.| +|Could not download image: ``|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can provide them with the `httpHeaders` argument.| |Bad `checkSumType` for downloaded file, got: `n` while expecting `m`.|Incorrect checksum.|- Please ensure that you have specified the correct checksum.
- Check that a download with the `curl` command from your server works in rescue mode.| See OVHcloud API and Storage [Common customer errors](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh#errors) for related partitioning issues. diff --git a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.en-us.md b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.en-us.md index c7c13bbfcb3..db59e88b438 100644 --- a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.en-us.md +++ b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.en-us.md @@ -1,7 +1,7 @@ --- title: Bring Your Own Linux (BYOLinux) excerpt: Find out how to easily deploy your own Linux images on dedicated servers -updated: 2025-06-05 +updated: 2025-09-30 --- ## Objective @@ -34,8 +34,7 @@ In addition to the requirement and limitations mentioned below, you must ensure There are some technical limitations linked to the use of physical products such as dedicated servers. Here is a non-exhaustive list, to keep in mind during your deployment preparation: -- Boot type: **uefi** or **legacy** -- Partition type: **MBR** or **GPT** +- Boot type: **UEFI** or **legacy** (depending on the boot type of your server) - Image format: **qcow2** - Only one partition in the qcow2 image @@ -176,7 +175,7 @@ The following table gives an overview of well known customer errors and how to f |image provided has a size of `n` bytes which is larger than `device` of `m` bytes|Image provided has a size that is bigger than the size of the disk chosen for the OS installation.|- If your server has several disk groups, you can try to reinstall the OS on another disk group by specifying the `diskgroupid` argument.
- You need to reduce the size of your image.| |Can't write qcow2 on disk|Impossible to write qcow2 image on disk.|Modify your image so that the command `qemu-img convert -f "$imageType" -O raw $pathToImageFile "$device"` works.| |Could not download, qcow2 image is too big to download in memory.|Your server doesn't have enough RAM to download the image.|You need to reduce the size of your image.| -|Could not download image located: `url`|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can precise them with the `httpHeaders` argument.| +|Could not download image: ``|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can provide them with the `httpHeaders` argument.| |Bad `checkSumType` for downloaded file, got: `n` while expecting `m`.|Incorrect checksum.|- Please ensure that you have specified the correct checksum.
- Check that a download with the `curl` command from your server works in rescue mode.| See OVHcloud API and Storage [Common customer errors](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh#errors) for related partitioning issues. diff --git a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.es-es.md b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.es-es.md index 57e97112bdf..26d5553fc6c 100644 --- a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.es-es.md +++ b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.es-es.md @@ -1,7 +1,7 @@ --- title: Bring Your Own Linux (BYOLinux) (EN) excerpt: Find out how to easily deploy your own Linux images on dedicated servers -updated: 2025-06-05 +updated: 2025-09-30 --- ## Objective @@ -34,8 +34,7 @@ In addition to the requirement and limitations mentioned below, you must ensure There are some technical limitations linked to the use of physical products such as dedicated servers. Here is a non-exhaustive list, to keep in mind during your deployment preparation: -- Boot type: **uefi** or **legacy** -- Partition type: **MBR** or **GPT** +- Boot type: **UEFI** or **legacy** (depending on the boot type of your server) - Image format: **qcow2** - Only one partition in the qcow2 image @@ -176,7 +175,7 @@ The following table gives an overview of well known customer errors and how to f |image provided has a size of `n` bytes which is larger than `device` of `m` bytes|Image provided has a size that is bigger than the size of the disk chosen for the OS installation.|- If your server has several disk groups, you can try to reinstall the OS on another disk group by specifying the `diskgroupid` argument.
- You need to reduce the size of your image.| |Can't write qcow2 on disk|Impossible to write qcow2 image on disk.|Modify your image so that the command `qemu-img convert -f "$imageType" -O raw $pathToImageFile "$device"` works.| |Could not download, qcow2 image is too big to download in memory.|Your server doesn't have enough RAM to download the image.|You need to reduce the size of your image.| -|Could not download image located: `url`|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can precise them with the `httpHeaders` argument.| +|Could not download image: ``|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can provide them with the `httpHeaders` argument.| |Bad `checkSumType` for downloaded file, got: `n` while expecting `m`.|Incorrect checksum.|- Please ensure that you have specified the correct checksum.
- Check that a download with the `curl` command from your server works in rescue mode.| See OVHcloud API and Storage [Common customer errors](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh#errors) for related partitioning issues. diff --git a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.es-us.md b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.es-us.md index 57e97112bdf..26d5553fc6c 100644 --- a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.es-us.md +++ b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.es-us.md @@ -1,7 +1,7 @@ --- title: Bring Your Own Linux (BYOLinux) (EN) excerpt: Find out how to easily deploy your own Linux images on dedicated servers -updated: 2025-06-05 +updated: 2025-09-30 --- ## Objective @@ -34,8 +34,7 @@ In addition to the requirement and limitations mentioned below, you must ensure There are some technical limitations linked to the use of physical products such as dedicated servers. Here is a non-exhaustive list, to keep in mind during your deployment preparation: -- Boot type: **uefi** or **legacy** -- Partition type: **MBR** or **GPT** +- Boot type: **UEFI** or **legacy** (depending on the boot type of your server) - Image format: **qcow2** - Only one partition in the qcow2 image @@ -176,7 +175,7 @@ The following table gives an overview of well known customer errors and how to f |image provided has a size of `n` bytes which is larger than `device` of `m` bytes|Image provided has a size that is bigger than the size of the disk chosen for the OS installation.|- If your server has several disk groups, you can try to reinstall the OS on another disk group by specifying the `diskgroupid` argument.
- You need to reduce the size of your image.| |Can't write qcow2 on disk|Impossible to write qcow2 image on disk.|Modify your image so that the command `qemu-img convert -f "$imageType" -O raw $pathToImageFile "$device"` works.| |Could not download, qcow2 image is too big to download in memory.|Your server doesn't have enough RAM to download the image.|You need to reduce the size of your image.| -|Could not download image located: `url`|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can precise them with the `httpHeaders` argument.| +|Could not download image: ``|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can provide them with the `httpHeaders` argument.| |Bad `checkSumType` for downloaded file, got: `n` while expecting `m`.|Incorrect checksum.|- Please ensure that you have specified the correct checksum.
- Check that a download with the `curl` command from your server works in rescue mode.| See OVHcloud API and Storage [Common customer errors](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh#errors) for related partitioning issues. diff --git a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.fr-ca.md b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.fr-ca.md index aea27568d22..f1f047dc082 100644 --- a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.fr-ca.md +++ b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.fr-ca.md @@ -1,7 +1,7 @@ --- title: Bring Your Own Linux (BYOLinux) excerpt: Découvrez comment déployer facilement vos propres images Linux sur des serveurs dédiés -updated: 2025-06-05 +updated: 2025-09-30 --- ## Objectif @@ -34,8 +34,7 @@ En plus des prérequis et limitations mentionnés ci-dessous, vous devez vous as Certaines limites techniques sont liées à l’utilisation de produits physiques comme les serveurs dédiés. Voici une liste non exhaustive à garder à l'esprit lors de la préparation de votre déploiement : -- Type de démarrage : **uefi** ou **legacy** -- Type de partition : **MBR** ou **GPT** +- Type de démarrage : **UEFI** ou **legacy** (en fonction du type de démarrage de votre serveur) - Format de l'image : **qcow2** - Une seule partition dans l'image qcow2 @@ -176,7 +175,7 @@ Le tableau suivant donne un aperçu des erreurs clients les plus connues et de l |image provided has a size of `n` bytes which is larger than `device` of `m` bytes|L'image spécifiée a une taille supérieure à celle du disque choisi pour l'installation.|- Si votre serveur possède plusieurs grappes de disques, vous pouvez réessayez une installation sur une autre grappe de disques à l'aide de l'argument `diskgroupid`.
- Vous devez réduire la taille de votre image.| |Can't write qcow2 on disk|Impossible d'écrire l'image qcow2 sur le disque.|Modifier votre image de telle sorte que la commande `qemu-img convert -f "$imageType" -O raw $pathToImageFile "$device"` fonctionne.| |Could not download, qcow2 image is too big to download in memory.|Il n'y a pas assez d'espace en RAM pour télécharger l'image.|Réduisez la taille de votre image.| -|Could not download image located : `url`|Impossible de télécharger l'image située : `imageURL`.|Vérifiez qu'un téléchargement avec `curl` depuis votre serveur en rescue fonctionne. Si des en-têtes HTTP sont requises, vous devez les spécifier à l'aide des paramètres `httpHeaders`.| +|Could not download image: ``|Impossible de télécharger l'image depuis `imageURL`.|Vérifiez qu'un téléchargement avec `curl` depuis votre serveur en rescue fonctionne. Si des en-têtes HTTP sont requis, vous devez les spécifier à l'aide des paramètres `httpHeaders`.| |Bad `checkSumType` for downloaded file, got : `n` while expecting `m`.|Le checksum est incorrect.|- Assurez-vous de spécifier le bon checksum
- Vérifiez qu'un téléchargement avec `curl` depuis votre serveur en rescue fonctionne.| Voir la section « [erreurs clients fréquentes](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh#errors) » de la page API OVHcloud et Stockage pour les erreurs spécifiques au partitionnement. diff --git a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.fr-fr.md b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.fr-fr.md index aea27568d22..f1f047dc082 100644 --- a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.fr-fr.md +++ b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.fr-fr.md @@ -1,7 +1,7 @@ --- title: Bring Your Own Linux (BYOLinux) excerpt: Découvrez comment déployer facilement vos propres images Linux sur des serveurs dédiés -updated: 2025-06-05 +updated: 2025-09-30 --- ## Objectif @@ -34,8 +34,7 @@ En plus des prérequis et limitations mentionnés ci-dessous, vous devez vous as Certaines limites techniques sont liées à l’utilisation de produits physiques comme les serveurs dédiés. Voici une liste non exhaustive à garder à l'esprit lors de la préparation de votre déploiement : -- Type de démarrage : **uefi** ou **legacy** -- Type de partition : **MBR** ou **GPT** +- Type de démarrage : **UEFI** ou **legacy** (en fonction du type de démarrage de votre serveur) - Format de l'image : **qcow2** - Une seule partition dans l'image qcow2 @@ -176,7 +175,7 @@ Le tableau suivant donne un aperçu des erreurs clients les plus connues et de l |image provided has a size of `n` bytes which is larger than `device` of `m` bytes|L'image spécifiée a une taille supérieure à celle du disque choisi pour l'installation.|- Si votre serveur possède plusieurs grappes de disques, vous pouvez réessayez une installation sur une autre grappe de disques à l'aide de l'argument `diskgroupid`.
- Vous devez réduire la taille de votre image.| |Can't write qcow2 on disk|Impossible d'écrire l'image qcow2 sur le disque.|Modifier votre image de telle sorte que la commande `qemu-img convert -f "$imageType" -O raw $pathToImageFile "$device"` fonctionne.| |Could not download, qcow2 image is too big to download in memory.|Il n'y a pas assez d'espace en RAM pour télécharger l'image.|Réduisez la taille de votre image.| -|Could not download image located : `url`|Impossible de télécharger l'image située : `imageURL`.|Vérifiez qu'un téléchargement avec `curl` depuis votre serveur en rescue fonctionne. Si des en-têtes HTTP sont requises, vous devez les spécifier à l'aide des paramètres `httpHeaders`.| +|Could not download image: ``|Impossible de télécharger l'image depuis `imageURL`.|Vérifiez qu'un téléchargement avec `curl` depuis votre serveur en rescue fonctionne. Si des en-têtes HTTP sont requis, vous devez les spécifier à l'aide des paramètres `httpHeaders`.| |Bad `checkSumType` for downloaded file, got : `n` while expecting `m`.|Le checksum est incorrect.|- Assurez-vous de spécifier le bon checksum
- Vérifiez qu'un téléchargement avec `curl` depuis votre serveur en rescue fonctionne.| Voir la section « [erreurs clients fréquentes](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh#errors) » de la page API OVHcloud et Stockage pour les erreurs spécifiques au partitionnement. diff --git a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.it-it.md b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.it-it.md index 57e97112bdf..26d5553fc6c 100644 --- a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.it-it.md +++ b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.it-it.md @@ -1,7 +1,7 @@ --- title: Bring Your Own Linux (BYOLinux) (EN) excerpt: Find out how to easily deploy your own Linux images on dedicated servers -updated: 2025-06-05 +updated: 2025-09-30 --- ## Objective @@ -34,8 +34,7 @@ In addition to the requirement and limitations mentioned below, you must ensure There are some technical limitations linked to the use of physical products such as dedicated servers. Here is a non-exhaustive list, to keep in mind during your deployment preparation: -- Boot type: **uefi** or **legacy** -- Partition type: **MBR** or **GPT** +- Boot type: **UEFI** or **legacy** (depending on the boot type of your server) - Image format: **qcow2** - Only one partition in the qcow2 image @@ -176,7 +175,7 @@ The following table gives an overview of well known customer errors and how to f |image provided has a size of `n` bytes which is larger than `device` of `m` bytes|Image provided has a size that is bigger than the size of the disk chosen for the OS installation.|- If your server has several disk groups, you can try to reinstall the OS on another disk group by specifying the `diskgroupid` argument.
- You need to reduce the size of your image.| |Can't write qcow2 on disk|Impossible to write qcow2 image on disk.|Modify your image so that the command `qemu-img convert -f "$imageType" -O raw $pathToImageFile "$device"` works.| |Could not download, qcow2 image is too big to download in memory.|Your server doesn't have enough RAM to download the image.|You need to reduce the size of your image.| -|Could not download image located: `url`|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can precise them with the `httpHeaders` argument.| +|Could not download image: ``|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can provide them with the `httpHeaders` argument.| |Bad `checkSumType` for downloaded file, got: `n` while expecting `m`.|Incorrect checksum.|- Please ensure that you have specified the correct checksum.
- Check that a download with the `curl` command from your server works in rescue mode.| See OVHcloud API and Storage [Common customer errors](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh#errors) for related partitioning issues. diff --git a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.pl-pl.md b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.pl-pl.md index 57e97112bdf..26d5553fc6c 100644 --- a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.pl-pl.md +++ b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.pl-pl.md @@ -1,7 +1,7 @@ --- title: Bring Your Own Linux (BYOLinux) (EN) excerpt: Find out how to easily deploy your own Linux images on dedicated servers -updated: 2025-06-05 +updated: 2025-09-30 --- ## Objective @@ -34,8 +34,7 @@ In addition to the requirement and limitations mentioned below, you must ensure There are some technical limitations linked to the use of physical products such as dedicated servers. Here is a non-exhaustive list, to keep in mind during your deployment preparation: -- Boot type: **uefi** or **legacy** -- Partition type: **MBR** or **GPT** +- Boot type: **UEFI** or **legacy** (depending on the boot type of your server) - Image format: **qcow2** - Only one partition in the qcow2 image @@ -176,7 +175,7 @@ The following table gives an overview of well known customer errors and how to f |image provided has a size of `n` bytes which is larger than `device` of `m` bytes|Image provided has a size that is bigger than the size of the disk chosen for the OS installation.|- If your server has several disk groups, you can try to reinstall the OS on another disk group by specifying the `diskgroupid` argument.
- You need to reduce the size of your image.| |Can't write qcow2 on disk|Impossible to write qcow2 image on disk.|Modify your image so that the command `qemu-img convert -f "$imageType" -O raw $pathToImageFile "$device"` works.| |Could not download, qcow2 image is too big to download in memory.|Your server doesn't have enough RAM to download the image.|You need to reduce the size of your image.| -|Could not download image located: `url`|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can precise them with the `httpHeaders` argument.| +|Could not download image: ``|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can provide them with the `httpHeaders` argument.| |Bad `checkSumType` for downloaded file, got: `n` while expecting `m`.|Incorrect checksum.|- Please ensure that you have specified the correct checksum.
- Check that a download with the `curl` command from your server works in rescue mode.| See OVHcloud API and Storage [Common customer errors](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh#errors) for related partitioning issues. diff --git a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.pt-pt.md b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.pt-pt.md index 57e97112bdf..26d5553fc6c 100644 --- a/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.pt-pt.md +++ b/pages/bare_metal_cloud/dedicated_servers/bring-your-own-linux/guide.pt-pt.md @@ -1,7 +1,7 @@ --- title: Bring Your Own Linux (BYOLinux) (EN) excerpt: Find out how to easily deploy your own Linux images on dedicated servers -updated: 2025-06-05 +updated: 2025-09-30 --- ## Objective @@ -34,8 +34,7 @@ In addition to the requirement and limitations mentioned below, you must ensure There are some technical limitations linked to the use of physical products such as dedicated servers. Here is a non-exhaustive list, to keep in mind during your deployment preparation: -- Boot type: **uefi** or **legacy** -- Partition type: **MBR** or **GPT** +- Boot type: **UEFI** or **legacy** (depending on the boot type of your server) - Image format: **qcow2** - Only one partition in the qcow2 image @@ -176,7 +175,7 @@ The following table gives an overview of well known customer errors and how to f |image provided has a size of `n` bytes which is larger than `device` of `m` bytes|Image provided has a size that is bigger than the size of the disk chosen for the OS installation.|- If your server has several disk groups, you can try to reinstall the OS on another disk group by specifying the `diskgroupid` argument.
- You need to reduce the size of your image.| |Can't write qcow2 on disk|Impossible to write qcow2 image on disk.|Modify your image so that the command `qemu-img convert -f "$imageType" -O raw $pathToImageFile "$device"` works.| |Could not download, qcow2 image is too big to download in memory.|Your server doesn't have enough RAM to download the image.|You need to reduce the size of your image.| -|Could not download image located: `url`|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can precise them with the `httpHeaders` argument.| +|Could not download image: ``|Cannot download image from `imageURL`.|Check that a download with the `curl` command from your server works in rescue mode. If some HTTP specific headers are required, you can provide them with the `httpHeaders` argument.| |Bad `checkSumType` for downloaded file, got: `n` while expecting `m`.|Incorrect checksum.|- Please ensure that you have specified the correct checksum.
- Check that a download with the `curl` command from your server works in rescue mode.| See OVHcloud API and Storage [Common customer errors](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh#errors) for related partitioning issues. diff --git a/pages/bare_metal_cloud/dedicated_servers/changing-admin-password-on-windows/images/adminpw_win_001.png b/pages/bare_metal_cloud/dedicated_servers/changing-admin-password-on-windows/images/adminpw_win_001.png deleted file mode 100644 index 3dd97d24f18..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/changing-admin-password-on-windows/images/adminpw_win_001.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/changing-admin-password-on-windows/images/adminpw_win_008.png b/pages/bare_metal_cloud/dedicated_servers/changing-admin-password-on-windows/images/adminpw_win_008.png deleted file mode 100644 index 41a5f5cebc8..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/changing-admin-password-on-windows/images/adminpw_win_008.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/changing-admin-password-on-windows/images/adminpw_win_01.png b/pages/bare_metal_cloud/dedicated_servers/changing-admin-password-on-windows/images/adminpw_win_01.png deleted file mode 100644 index ee4fdb10fda..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/changing-admin-password-on-windows/images/adminpw_win_01.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/changing-admin-password-on-windows/images/adminpw_win_02.png b/pages/bare_metal_cloud/dedicated_servers/changing-admin-password-on-windows/images/adminpw_win_02.png deleted file mode 100644 index 035cec0d3f5..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/changing-admin-password-on-windows/images/adminpw_win_02.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/changing-admin-password-on-windows/images/adminpw_win_08.png b/pages/bare_metal_cloud/dedicated_servers/changing-admin-password-on-windows/images/adminpw_win_08.png deleted file mode 100644 index 3eaf99216c7..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/changing-admin-password-on-windows/images/adminpw_win_08.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/changing-admin-password-on-windows/images/ntpwdi-tool-01.png b/pages/bare_metal_cloud/dedicated_servers/changing-admin-password-on-windows/images/ntpwdi-tool-01.png deleted file mode 100644 index 4f87e75dc58..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/changing-admin-password-on-windows/images/ntpwdi-tool-01.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/changing-admin-password-on-windows/images/ntpwdi-tool-02.png b/pages/bare_metal_cloud/dedicated_servers/changing-admin-password-on-windows/images/ntpwdi-tool-02.png deleted file mode 100644 index bbc1e88cfc6..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/changing-admin-password-on-windows/images/ntpwdi-tool-02.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/changing-admin-password-on-windows/images/ntpwdi-tool-03.png b/pages/bare_metal_cloud/dedicated_servers/changing-admin-password-on-windows/images/ntpwdi-tool-03.png deleted file mode 100644 index 9c218f59283..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/changing-admin-password-on-windows/images/ntpwdi-tool-03.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/changing-admin-password-on-windows/images/ntpwdi-tool-04.png b/pages/bare_metal_cloud/dedicated_servers/changing-admin-password-on-windows/images/ntpwdi-tool-04.png deleted file mode 100644 index 9aea704ec52..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/changing-admin-password-on-windows/images/ntpwdi-tool-04.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/changing_root_password_linux_ds/meta.yaml b/pages/bare_metal_cloud/dedicated_servers/changing_root_password_linux_ds/meta.yaml index e9728820fae..2709cca7162 100755 --- a/pages/bare_metal_cloud/dedicated_servers/changing_root_password_linux_ds/meta.yaml +++ b/pages/bare_metal_cloud/dedicated_servers/changing_root_password_linux_ds/meta.yaml @@ -1,3 +1,3 @@ id: b88769c3-203b-40b1-99e4-59882a3bc72b full_slug: dedicated-servers-root-password -reference_category: bare-metal-cloud-dedicated-servers-managing-servers \ No newline at end of file +reference_category: bare-metal-cloud-dedicated-servers-configuration-system \ No newline at end of file diff --git a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/011.png b/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/011.png deleted file mode 100644 index 87d431bd251..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/011.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/03.png b/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/03.png deleted file mode 100644 index ea3d182b923..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/03.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/06.png b/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/06.png deleted file mode 100644 index ca01ae7872c..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/06.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/101.png b/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/101.png deleted file mode 100644 index 3519da29e0e..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/101.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/102.png b/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/102.png deleted file mode 100644 index 69a4a1aefe6..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/102.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/103.png b/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/103.png deleted file mode 100644 index 3a059c45fa2..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/103.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/104.png b/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/104.png deleted file mode 100644 index d3b87026a28..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/104.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/105.png b/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/105.png deleted file mode 100644 index 8ef13b087db..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/105.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/106.png b/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/106.png deleted file mode 100644 index 08d2ec34ed4..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/106.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/107.png b/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/107.png deleted file mode 100644 index d9b1b37a3dc..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/107.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/20240418-01.png b/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/20240418-01.png deleted file mode 100644 index 08dd658243f..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/20240418-01.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/220.png b/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/220.png deleted file mode 100644 index 0b085b679fa..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/220.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/221.png b/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/221.png deleted file mode 100644 index 732b6535dcb..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/221.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/299.png b/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/299.png deleted file mode 100644 index 52bd57f1fa5..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/299.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/300.png b/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/300.png deleted file mode 100644 index 248624a06bc..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/300.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/301.png b/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/301.png deleted file mode 100644 index 952d2be4692..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/301.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/302.png b/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/302.png deleted file mode 100644 index 2605f79525a..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/302.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/303.png b/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/303.png deleted file mode 100644 index fc0aad94051..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/303.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/304.png b/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/304.png deleted file mode 100644 index a86ea5251e7..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/304.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/601.png b/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/601.png deleted file mode 100644 index dc86934e653..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/601.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/602.png b/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/602.png deleted file mode 100644 index 93892450d0e..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/602.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/710.png b/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/710.png deleted file mode 100644 index c94bb8ca869..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/710.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/get-eligibleServices.png b/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/get-eligibleServices.png deleted file mode 100644 index 3463215fd07..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/get-eligibleServices.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/location.png b/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/location.png deleted file mode 100644 index 5ad49967ef3..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/images/location.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/meta.yaml b/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/meta.yaml index 05cd7bb0e6b..2f8a03d84c2 100644 --- a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/meta.yaml +++ b/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack/meta.yaml @@ -1,3 +1,3 @@ id: 63ffe1bb-2469-4cf5-b547-5fdc3de13a0c full_slug: dedicated-servers-configure-an-ipv6-in-a-vrack -reference_category: bare-metal-cloud-dedicated-servers-network-and-ip-management \ No newline at end of file +reference_category: bare-metal-cloud-dedicated-servers-configuration-vRack \ No newline at end of file diff --git a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-on-a-vm/meta.yaml b/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-on-a-vm/meta.yaml index d5be0fb64f6..06c6e3f60bb 100644 --- a/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-on-a-vm/meta.yaml +++ b/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-on-a-vm/meta.yaml @@ -1,3 +1,3 @@ id: ee31b7ec-208f-42e9-9290-c13e935bbcca full_slug: dedicated-servers-configure-ipv6-virtual-machine -reference_category: bare-metal-cloud-dedicated-servers-network-and-ip-management \ No newline at end of file +reference_category: bare-metal-cloud-dedicated-servers-configuration-network \ No newline at end of file diff --git a/pages/bare_metal_cloud/dedicated_servers/configuring-an-ip-block-in-a-vrack/images/vrack-ajouter-blocip-2.jpg b/pages/bare_metal_cloud/dedicated_servers/configuring-an-ip-block-in-a-vrack/images/vrack-ajouter-blocip-2.jpg deleted file mode 100644 index ef24fd279f3..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configuring-an-ip-block-in-a-vrack/images/vrack-ajouter-blocip-2.jpg and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configuring-an-ip-block-in-a-vrack/images/vrack-ajouter-blocip.jpg b/pages/bare_metal_cloud/dedicated_servers/configuring-an-ip-block-in-a-vrack/images/vrack-ajouter-blocip.jpg deleted file mode 100644 index f3e308e258c..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configuring-an-ip-block-in-a-vrack/images/vrack-ajouter-blocip.jpg and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configuring-an-ip-block-in-a-vrack/images/vrack-supprimer-blocip-2.jpg b/pages/bare_metal_cloud/dedicated_servers/configuring-an-ip-block-in-a-vrack/images/vrack-supprimer-blocip-2.jpg deleted file mode 100644 index fff0c47dcbd..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configuring-an-ip-block-in-a-vrack/images/vrack-supprimer-blocip-2.jpg and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configuring-an-ip-block-in-a-vrack/images/vrack-supprimer-blocip.jpg b/pages/bare_metal_cloud/dedicated_servers/configuring-an-ip-block-in-a-vrack/images/vrack-supprimer-blocip.jpg deleted file mode 100644 index 5f9c5d755c2..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configuring-an-ip-block-in-a-vrack/images/vrack-supprimer-blocip.jpg and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configuring-an-ip-block-in-a-vrack/images/win-ip-vrack-5-5.png b/pages/bare_metal_cloud/dedicated_servers/configuring-an-ip-block-in-a-vrack/images/win-ip-vrack-5-5.png deleted file mode 100644 index 9564a568ca1..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configuring-an-ip-block-in-a-vrack/images/win-ip-vrack-5-5.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configuring-an-ip-block-in-a-vrack/images/win-ip-vrack-5.png b/pages/bare_metal_cloud/dedicated_servers/configuring-an-ip-block-in-a-vrack/images/win-ip-vrack-5.png deleted file mode 100644 index 0c169bbfea4..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configuring-an-ip-block-in-a-vrack/images/win-ip-vrack-5.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configuring-an-ip-block-in-a-vrack/images/win-ip-vrack-8.png b/pages/bare_metal_cloud/dedicated_servers/configuring-an-ip-block-in-a-vrack/images/win-ip-vrack-8.png deleted file mode 100644 index 69373c54463..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configuring-an-ip-block-in-a-vrack/images/win-ip-vrack-8.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/orderingvrack.png b/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/orderingvrack.png deleted file mode 100644 index 563c3bdb52e..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/orderingvrack.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-01.png b/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-01.png deleted file mode 100644 index b03217c475e..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-01.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-01_2020.png b/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-01_2020.png deleted file mode 100644 index c512aaeee55..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-01_2020.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-02.png b/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-02.png deleted file mode 100644 index dbed3235717..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-02.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-02_2020.png b/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-02_2020.png deleted file mode 100644 index 95ca0022d4b..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-02_2020.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-03.png b/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-03.png deleted file mode 100644 index 83586ee1ffc..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-03.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-04.png b/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-04.png deleted file mode 100644 index 9b6d19f4bdd..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-04.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-05.png b/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-05.png deleted file mode 100644 index da4f50dc749..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-05.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-project-01.png b/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-project-01.png deleted file mode 100644 index b6c56874bc4..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-project-01.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-project-01_2020.png b/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-project-01_2020.png deleted file mode 100644 index 58ec942ea5b..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-project-01_2020.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-project-02.png b/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-project-02.png deleted file mode 100644 index 0b9a2e327e0..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-project-02.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-project-02_2020.png b/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-project-02_2020.png deleted file mode 100644 index c00ca41140e..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-project-02_2020.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-project-03.png b/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-project-03.png deleted file mode 100644 index 3685b3fa2b6..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-project-03.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-project-03a_2020.png b/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-project-03a_2020.png deleted file mode 100644 index ea35ba0c691..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-project-03a_2020.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-project-03b_2020.png b/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-project-03b_2020.png deleted file mode 100644 index e398f5896df..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-project-03b_2020.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-vrack-00_2020.png b/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-vrack-00_2020.png deleted file mode 100644 index 47ed03ceba8..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-vrack-00_2020.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-vrack-00a_2020.png b/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-vrack-00a_2020.png deleted file mode 100644 index 59a0397c934..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-vrack-00a_2020.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-vrack-01.png b/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-vrack-01.png deleted file mode 100644 index a0281f71333..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-vrack-01.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-vrack-01_2020.png b/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-vrack-01_2020.png deleted file mode 100644 index 1c2a500e56c..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-vrack-01_2020.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-vrack-02.png b/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-vrack-02.png deleted file mode 100644 index 4fc6f697a85..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-vrack-02.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-vrack-02_2020.png b/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-vrack-02_2020.png deleted file mode 100644 index cab5a428d97..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/pci-vrack-02_2020.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/vrackdelivered.png b/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/vrackdelivered.png deleted file mode 100644 index 40782d5bda2..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/configuring-the-vrack-between-the-public-cloud-and-a-dedicated-server/images/vrackdelivered.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.de-de.md b/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.de-de.md index f49b95c2388..d2ef63efe14 100644 --- a/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.de-de.md +++ b/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.de-de.md @@ -1,7 +1,7 @@ --- title: How to install VMware ESXi 8 on a dedicated server excerpt: Find out how to install and configure VMware ESXi 8 on a dedicated server using an OVHcloud provided image -updated: 2025-09-15 +updated: 2025-10-03 --- ## Objective @@ -11,8 +11,7 @@ updated: 2025-09-15 > Since September 15, 2025, OVHcloud provides an ESXi 8 installation template for its dedicated servers. > -With [OVHcloud dedicated servers](/links/bare-metal/bare-metal), you can freely [configure partitioning](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh). This gives customers a wide range of options when installing an operating system. ESXi is an exception because it is a UNIX-based, proprietary system with a proprietary installer.
-OVHcloud installations of ESXi are therefore compliant with the configuration set by the software publisher. Since ESXi 7.0, it is possible to choose between 4 different predefined partitioning layouts. This guide will show you how to install ESXi 8 and select a partitioning layout in the [OVHcloud Control Panel](/links/manager) or via the [OVHcloud API](/links/api). +This guide will show you how to install ESXi 8 on your dedicated servers, and select a partitioning layout in the [OVHcloud Control Panel](/links/manager) or via the [OVHcloud API](/links/api). ## Requirements @@ -26,11 +25,15 @@ OVHcloud installations of ESXi are therefore compliant with the configuration se ## Instructions +With OVHcloud dedicated servers, you can freely [configure partitioning](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh). This gives customers a wide range of options when installing an operating system. ESXi is an exception because it is a UNIX-based, proprietary system with a proprietary installer. + +OVHcloud installations of ESXi are therefore compliant with the configuration set by the software publisher. + ESXi 7.0 and later versions introduced a [boot option to configure the size of ESXi system partitions](https://kb.vmware.com/s/article/81166) because the increased size of the system partition could cause issues, especially on systems with small disks. OVHcloud includes this feature in the [OVHcloud Control Panel](/links/manager) and the [OVHcloud API](/links/api). Even with multiple disks available on a server, the ESXi OS installation uses only the first disk of the targeted disk group (see [OVHcloud API and OS Installation - Disk Groups](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh#disk-group)). Other disks may be configured afterwards to be used for virtual machines (see [How to add a datastore](/pages/bare_metal_cloud/dedicated_servers/hgrstor2_system_configuration#add-datastore)). -There are 4 different values: +There are 4 predefined partitioning layouts: |Value|System size¹|Datastore³| |---|---|---| diff --git a/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.en-asia.md b/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.en-asia.md index f49b95c2388..d2ef63efe14 100644 --- a/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.en-asia.md +++ b/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.en-asia.md @@ -1,7 +1,7 @@ --- title: How to install VMware ESXi 8 on a dedicated server excerpt: Find out how to install and configure VMware ESXi 8 on a dedicated server using an OVHcloud provided image -updated: 2025-09-15 +updated: 2025-10-03 --- ## Objective @@ -11,8 +11,7 @@ updated: 2025-09-15 > Since September 15, 2025, OVHcloud provides an ESXi 8 installation template for its dedicated servers. > -With [OVHcloud dedicated servers](/links/bare-metal/bare-metal), you can freely [configure partitioning](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh). This gives customers a wide range of options when installing an operating system. ESXi is an exception because it is a UNIX-based, proprietary system with a proprietary installer.
-OVHcloud installations of ESXi are therefore compliant with the configuration set by the software publisher. Since ESXi 7.0, it is possible to choose between 4 different predefined partitioning layouts. This guide will show you how to install ESXi 8 and select a partitioning layout in the [OVHcloud Control Panel](/links/manager) or via the [OVHcloud API](/links/api). +This guide will show you how to install ESXi 8 on your dedicated servers, and select a partitioning layout in the [OVHcloud Control Panel](/links/manager) or via the [OVHcloud API](/links/api). ## Requirements @@ -26,11 +25,15 @@ OVHcloud installations of ESXi are therefore compliant with the configuration se ## Instructions +With OVHcloud dedicated servers, you can freely [configure partitioning](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh). This gives customers a wide range of options when installing an operating system. ESXi is an exception because it is a UNIX-based, proprietary system with a proprietary installer. + +OVHcloud installations of ESXi are therefore compliant with the configuration set by the software publisher. + ESXi 7.0 and later versions introduced a [boot option to configure the size of ESXi system partitions](https://kb.vmware.com/s/article/81166) because the increased size of the system partition could cause issues, especially on systems with small disks. OVHcloud includes this feature in the [OVHcloud Control Panel](/links/manager) and the [OVHcloud API](/links/api). Even with multiple disks available on a server, the ESXi OS installation uses only the first disk of the targeted disk group (see [OVHcloud API and OS Installation - Disk Groups](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh#disk-group)). Other disks may be configured afterwards to be used for virtual machines (see [How to add a datastore](/pages/bare_metal_cloud/dedicated_servers/hgrstor2_system_configuration#add-datastore)). -There are 4 different values: +There are 4 predefined partitioning layouts: |Value|System size¹|Datastore³| |---|---|---| diff --git a/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.en-au.md b/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.en-au.md index f49b95c2388..d2ef63efe14 100644 --- a/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.en-au.md +++ b/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.en-au.md @@ -1,7 +1,7 @@ --- title: How to install VMware ESXi 8 on a dedicated server excerpt: Find out how to install and configure VMware ESXi 8 on a dedicated server using an OVHcloud provided image -updated: 2025-09-15 +updated: 2025-10-03 --- ## Objective @@ -11,8 +11,7 @@ updated: 2025-09-15 > Since September 15, 2025, OVHcloud provides an ESXi 8 installation template for its dedicated servers. > -With [OVHcloud dedicated servers](/links/bare-metal/bare-metal), you can freely [configure partitioning](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh). This gives customers a wide range of options when installing an operating system. ESXi is an exception because it is a UNIX-based, proprietary system with a proprietary installer.
-OVHcloud installations of ESXi are therefore compliant with the configuration set by the software publisher. Since ESXi 7.0, it is possible to choose between 4 different predefined partitioning layouts. This guide will show you how to install ESXi 8 and select a partitioning layout in the [OVHcloud Control Panel](/links/manager) or via the [OVHcloud API](/links/api). +This guide will show you how to install ESXi 8 on your dedicated servers, and select a partitioning layout in the [OVHcloud Control Panel](/links/manager) or via the [OVHcloud API](/links/api). ## Requirements @@ -26,11 +25,15 @@ OVHcloud installations of ESXi are therefore compliant with the configuration se ## Instructions +With OVHcloud dedicated servers, you can freely [configure partitioning](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh). This gives customers a wide range of options when installing an operating system. ESXi is an exception because it is a UNIX-based, proprietary system with a proprietary installer. + +OVHcloud installations of ESXi are therefore compliant with the configuration set by the software publisher. + ESXi 7.0 and later versions introduced a [boot option to configure the size of ESXi system partitions](https://kb.vmware.com/s/article/81166) because the increased size of the system partition could cause issues, especially on systems with small disks. OVHcloud includes this feature in the [OVHcloud Control Panel](/links/manager) and the [OVHcloud API](/links/api). Even with multiple disks available on a server, the ESXi OS installation uses only the first disk of the targeted disk group (see [OVHcloud API and OS Installation - Disk Groups](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh#disk-group)). Other disks may be configured afterwards to be used for virtual machines (see [How to add a datastore](/pages/bare_metal_cloud/dedicated_servers/hgrstor2_system_configuration#add-datastore)). -There are 4 different values: +There are 4 predefined partitioning layouts: |Value|System size¹|Datastore³| |---|---|---| diff --git a/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.en-ca.md b/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.en-ca.md index f49b95c2388..d2ef63efe14 100644 --- a/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.en-ca.md +++ b/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.en-ca.md @@ -1,7 +1,7 @@ --- title: How to install VMware ESXi 8 on a dedicated server excerpt: Find out how to install and configure VMware ESXi 8 on a dedicated server using an OVHcloud provided image -updated: 2025-09-15 +updated: 2025-10-03 --- ## Objective @@ -11,8 +11,7 @@ updated: 2025-09-15 > Since September 15, 2025, OVHcloud provides an ESXi 8 installation template for its dedicated servers. > -With [OVHcloud dedicated servers](/links/bare-metal/bare-metal), you can freely [configure partitioning](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh). This gives customers a wide range of options when installing an operating system. ESXi is an exception because it is a UNIX-based, proprietary system with a proprietary installer.
-OVHcloud installations of ESXi are therefore compliant with the configuration set by the software publisher. Since ESXi 7.0, it is possible to choose between 4 different predefined partitioning layouts. This guide will show you how to install ESXi 8 and select a partitioning layout in the [OVHcloud Control Panel](/links/manager) or via the [OVHcloud API](/links/api). +This guide will show you how to install ESXi 8 on your dedicated servers, and select a partitioning layout in the [OVHcloud Control Panel](/links/manager) or via the [OVHcloud API](/links/api). ## Requirements @@ -26,11 +25,15 @@ OVHcloud installations of ESXi are therefore compliant with the configuration se ## Instructions +With OVHcloud dedicated servers, you can freely [configure partitioning](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh). This gives customers a wide range of options when installing an operating system. ESXi is an exception because it is a UNIX-based, proprietary system with a proprietary installer. + +OVHcloud installations of ESXi are therefore compliant with the configuration set by the software publisher. + ESXi 7.0 and later versions introduced a [boot option to configure the size of ESXi system partitions](https://kb.vmware.com/s/article/81166) because the increased size of the system partition could cause issues, especially on systems with small disks. OVHcloud includes this feature in the [OVHcloud Control Panel](/links/manager) and the [OVHcloud API](/links/api). Even with multiple disks available on a server, the ESXi OS installation uses only the first disk of the targeted disk group (see [OVHcloud API and OS Installation - Disk Groups](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh#disk-group)). Other disks may be configured afterwards to be used for virtual machines (see [How to add a datastore](/pages/bare_metal_cloud/dedicated_servers/hgrstor2_system_configuration#add-datastore)). -There are 4 different values: +There are 4 predefined partitioning layouts: |Value|System size¹|Datastore³| |---|---|---| diff --git a/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.en-gb.md b/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.en-gb.md index f49b95c2388..d2ef63efe14 100644 --- a/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.en-gb.md +++ b/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.en-gb.md @@ -1,7 +1,7 @@ --- title: How to install VMware ESXi 8 on a dedicated server excerpt: Find out how to install and configure VMware ESXi 8 on a dedicated server using an OVHcloud provided image -updated: 2025-09-15 +updated: 2025-10-03 --- ## Objective @@ -11,8 +11,7 @@ updated: 2025-09-15 > Since September 15, 2025, OVHcloud provides an ESXi 8 installation template for its dedicated servers. > -With [OVHcloud dedicated servers](/links/bare-metal/bare-metal), you can freely [configure partitioning](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh). This gives customers a wide range of options when installing an operating system. ESXi is an exception because it is a UNIX-based, proprietary system with a proprietary installer.
-OVHcloud installations of ESXi are therefore compliant with the configuration set by the software publisher. Since ESXi 7.0, it is possible to choose between 4 different predefined partitioning layouts. This guide will show you how to install ESXi 8 and select a partitioning layout in the [OVHcloud Control Panel](/links/manager) or via the [OVHcloud API](/links/api). +This guide will show you how to install ESXi 8 on your dedicated servers, and select a partitioning layout in the [OVHcloud Control Panel](/links/manager) or via the [OVHcloud API](/links/api). ## Requirements @@ -26,11 +25,15 @@ OVHcloud installations of ESXi are therefore compliant with the configuration se ## Instructions +With OVHcloud dedicated servers, you can freely [configure partitioning](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh). This gives customers a wide range of options when installing an operating system. ESXi is an exception because it is a UNIX-based, proprietary system with a proprietary installer. + +OVHcloud installations of ESXi are therefore compliant with the configuration set by the software publisher. + ESXi 7.0 and later versions introduced a [boot option to configure the size of ESXi system partitions](https://kb.vmware.com/s/article/81166) because the increased size of the system partition could cause issues, especially on systems with small disks. OVHcloud includes this feature in the [OVHcloud Control Panel](/links/manager) and the [OVHcloud API](/links/api). Even with multiple disks available on a server, the ESXi OS installation uses only the first disk of the targeted disk group (see [OVHcloud API and OS Installation - Disk Groups](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh#disk-group)). Other disks may be configured afterwards to be used for virtual machines (see [How to add a datastore](/pages/bare_metal_cloud/dedicated_servers/hgrstor2_system_configuration#add-datastore)). -There are 4 different values: +There are 4 predefined partitioning layouts: |Value|System size¹|Datastore³| |---|---|---| diff --git a/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.en-ie.md b/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.en-ie.md index f49b95c2388..d2ef63efe14 100644 --- a/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.en-ie.md +++ b/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.en-ie.md @@ -1,7 +1,7 @@ --- title: How to install VMware ESXi 8 on a dedicated server excerpt: Find out how to install and configure VMware ESXi 8 on a dedicated server using an OVHcloud provided image -updated: 2025-09-15 +updated: 2025-10-03 --- ## Objective @@ -11,8 +11,7 @@ updated: 2025-09-15 > Since September 15, 2025, OVHcloud provides an ESXi 8 installation template for its dedicated servers. > -With [OVHcloud dedicated servers](/links/bare-metal/bare-metal), you can freely [configure partitioning](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh). This gives customers a wide range of options when installing an operating system. ESXi is an exception because it is a UNIX-based, proprietary system with a proprietary installer.
-OVHcloud installations of ESXi are therefore compliant with the configuration set by the software publisher. Since ESXi 7.0, it is possible to choose between 4 different predefined partitioning layouts. This guide will show you how to install ESXi 8 and select a partitioning layout in the [OVHcloud Control Panel](/links/manager) or via the [OVHcloud API](/links/api). +This guide will show you how to install ESXi 8 on your dedicated servers, and select a partitioning layout in the [OVHcloud Control Panel](/links/manager) or via the [OVHcloud API](/links/api). ## Requirements @@ -26,11 +25,15 @@ OVHcloud installations of ESXi are therefore compliant with the configuration se ## Instructions +With OVHcloud dedicated servers, you can freely [configure partitioning](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh). This gives customers a wide range of options when installing an operating system. ESXi is an exception because it is a UNIX-based, proprietary system with a proprietary installer. + +OVHcloud installations of ESXi are therefore compliant with the configuration set by the software publisher. + ESXi 7.0 and later versions introduced a [boot option to configure the size of ESXi system partitions](https://kb.vmware.com/s/article/81166) because the increased size of the system partition could cause issues, especially on systems with small disks. OVHcloud includes this feature in the [OVHcloud Control Panel](/links/manager) and the [OVHcloud API](/links/api). Even with multiple disks available on a server, the ESXi OS installation uses only the first disk of the targeted disk group (see [OVHcloud API and OS Installation - Disk Groups](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh#disk-group)). Other disks may be configured afterwards to be used for virtual machines (see [How to add a datastore](/pages/bare_metal_cloud/dedicated_servers/hgrstor2_system_configuration#add-datastore)). -There are 4 different values: +There are 4 predefined partitioning layouts: |Value|System size¹|Datastore³| |---|---|---| diff --git a/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.en-sg.md b/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.en-sg.md index f49b95c2388..d2ef63efe14 100644 --- a/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.en-sg.md +++ b/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.en-sg.md @@ -1,7 +1,7 @@ --- title: How to install VMware ESXi 8 on a dedicated server excerpt: Find out how to install and configure VMware ESXi 8 on a dedicated server using an OVHcloud provided image -updated: 2025-09-15 +updated: 2025-10-03 --- ## Objective @@ -11,8 +11,7 @@ updated: 2025-09-15 > Since September 15, 2025, OVHcloud provides an ESXi 8 installation template for its dedicated servers. > -With [OVHcloud dedicated servers](/links/bare-metal/bare-metal), you can freely [configure partitioning](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh). This gives customers a wide range of options when installing an operating system. ESXi is an exception because it is a UNIX-based, proprietary system with a proprietary installer.
-OVHcloud installations of ESXi are therefore compliant with the configuration set by the software publisher. Since ESXi 7.0, it is possible to choose between 4 different predefined partitioning layouts. This guide will show you how to install ESXi 8 and select a partitioning layout in the [OVHcloud Control Panel](/links/manager) or via the [OVHcloud API](/links/api). +This guide will show you how to install ESXi 8 on your dedicated servers, and select a partitioning layout in the [OVHcloud Control Panel](/links/manager) or via the [OVHcloud API](/links/api). ## Requirements @@ -26,11 +25,15 @@ OVHcloud installations of ESXi are therefore compliant with the configuration se ## Instructions +With OVHcloud dedicated servers, you can freely [configure partitioning](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh). This gives customers a wide range of options when installing an operating system. ESXi is an exception because it is a UNIX-based, proprietary system with a proprietary installer. + +OVHcloud installations of ESXi are therefore compliant with the configuration set by the software publisher. + ESXi 7.0 and later versions introduced a [boot option to configure the size of ESXi system partitions](https://kb.vmware.com/s/article/81166) because the increased size of the system partition could cause issues, especially on systems with small disks. OVHcloud includes this feature in the [OVHcloud Control Panel](/links/manager) and the [OVHcloud API](/links/api). Even with multiple disks available on a server, the ESXi OS installation uses only the first disk of the targeted disk group (see [OVHcloud API and OS Installation - Disk Groups](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh#disk-group)). Other disks may be configured afterwards to be used for virtual machines (see [How to add a datastore](/pages/bare_metal_cloud/dedicated_servers/hgrstor2_system_configuration#add-datastore)). -There are 4 different values: +There are 4 predefined partitioning layouts: |Value|System size¹|Datastore³| |---|---|---| diff --git a/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.en-us.md b/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.en-us.md index f49b95c2388..d2ef63efe14 100644 --- a/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.en-us.md +++ b/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.en-us.md @@ -1,7 +1,7 @@ --- title: How to install VMware ESXi 8 on a dedicated server excerpt: Find out how to install and configure VMware ESXi 8 on a dedicated server using an OVHcloud provided image -updated: 2025-09-15 +updated: 2025-10-03 --- ## Objective @@ -11,8 +11,7 @@ updated: 2025-09-15 > Since September 15, 2025, OVHcloud provides an ESXi 8 installation template for its dedicated servers. > -With [OVHcloud dedicated servers](/links/bare-metal/bare-metal), you can freely [configure partitioning](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh). This gives customers a wide range of options when installing an operating system. ESXi is an exception because it is a UNIX-based, proprietary system with a proprietary installer.
-OVHcloud installations of ESXi are therefore compliant with the configuration set by the software publisher. Since ESXi 7.0, it is possible to choose between 4 different predefined partitioning layouts. This guide will show you how to install ESXi 8 and select a partitioning layout in the [OVHcloud Control Panel](/links/manager) or via the [OVHcloud API](/links/api). +This guide will show you how to install ESXi 8 on your dedicated servers, and select a partitioning layout in the [OVHcloud Control Panel](/links/manager) or via the [OVHcloud API](/links/api). ## Requirements @@ -26,11 +25,15 @@ OVHcloud installations of ESXi are therefore compliant with the configuration se ## Instructions +With OVHcloud dedicated servers, you can freely [configure partitioning](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh). This gives customers a wide range of options when installing an operating system. ESXi is an exception because it is a UNIX-based, proprietary system with a proprietary installer. + +OVHcloud installations of ESXi are therefore compliant with the configuration set by the software publisher. + ESXi 7.0 and later versions introduced a [boot option to configure the size of ESXi system partitions](https://kb.vmware.com/s/article/81166) because the increased size of the system partition could cause issues, especially on systems with small disks. OVHcloud includes this feature in the [OVHcloud Control Panel](/links/manager) and the [OVHcloud API](/links/api). Even with multiple disks available on a server, the ESXi OS installation uses only the first disk of the targeted disk group (see [OVHcloud API and OS Installation - Disk Groups](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh#disk-group)). Other disks may be configured afterwards to be used for virtual machines (see [How to add a datastore](/pages/bare_metal_cloud/dedicated_servers/hgrstor2_system_configuration#add-datastore)). -There are 4 different values: +There are 4 predefined partitioning layouts: |Value|System size¹|Datastore³| |---|---|---| diff --git a/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.es-es.md b/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.es-es.md index f49b95c2388..d2ef63efe14 100644 --- a/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.es-es.md +++ b/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.es-es.md @@ -1,7 +1,7 @@ --- title: How to install VMware ESXi 8 on a dedicated server excerpt: Find out how to install and configure VMware ESXi 8 on a dedicated server using an OVHcloud provided image -updated: 2025-09-15 +updated: 2025-10-03 --- ## Objective @@ -11,8 +11,7 @@ updated: 2025-09-15 > Since September 15, 2025, OVHcloud provides an ESXi 8 installation template for its dedicated servers. > -With [OVHcloud dedicated servers](/links/bare-metal/bare-metal), you can freely [configure partitioning](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh). This gives customers a wide range of options when installing an operating system. ESXi is an exception because it is a UNIX-based, proprietary system with a proprietary installer.
-OVHcloud installations of ESXi are therefore compliant with the configuration set by the software publisher. Since ESXi 7.0, it is possible to choose between 4 different predefined partitioning layouts. This guide will show you how to install ESXi 8 and select a partitioning layout in the [OVHcloud Control Panel](/links/manager) or via the [OVHcloud API](/links/api). +This guide will show you how to install ESXi 8 on your dedicated servers, and select a partitioning layout in the [OVHcloud Control Panel](/links/manager) or via the [OVHcloud API](/links/api). ## Requirements @@ -26,11 +25,15 @@ OVHcloud installations of ESXi are therefore compliant with the configuration se ## Instructions +With OVHcloud dedicated servers, you can freely [configure partitioning](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh). This gives customers a wide range of options when installing an operating system. ESXi is an exception because it is a UNIX-based, proprietary system with a proprietary installer. + +OVHcloud installations of ESXi are therefore compliant with the configuration set by the software publisher. + ESXi 7.0 and later versions introduced a [boot option to configure the size of ESXi system partitions](https://kb.vmware.com/s/article/81166) because the increased size of the system partition could cause issues, especially on systems with small disks. OVHcloud includes this feature in the [OVHcloud Control Panel](/links/manager) and the [OVHcloud API](/links/api). Even with multiple disks available on a server, the ESXi OS installation uses only the first disk of the targeted disk group (see [OVHcloud API and OS Installation - Disk Groups](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh#disk-group)). Other disks may be configured afterwards to be used for virtual machines (see [How to add a datastore](/pages/bare_metal_cloud/dedicated_servers/hgrstor2_system_configuration#add-datastore)). -There are 4 different values: +There are 4 predefined partitioning layouts: |Value|System size¹|Datastore³| |---|---|---| diff --git a/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.es-us.md b/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.es-us.md index f49b95c2388..d2ef63efe14 100644 --- a/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.es-us.md +++ b/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.es-us.md @@ -1,7 +1,7 @@ --- title: How to install VMware ESXi 8 on a dedicated server excerpt: Find out how to install and configure VMware ESXi 8 on a dedicated server using an OVHcloud provided image -updated: 2025-09-15 +updated: 2025-10-03 --- ## Objective @@ -11,8 +11,7 @@ updated: 2025-09-15 > Since September 15, 2025, OVHcloud provides an ESXi 8 installation template for its dedicated servers. > -With [OVHcloud dedicated servers](/links/bare-metal/bare-metal), you can freely [configure partitioning](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh). This gives customers a wide range of options when installing an operating system. ESXi is an exception because it is a UNIX-based, proprietary system with a proprietary installer.
-OVHcloud installations of ESXi are therefore compliant with the configuration set by the software publisher. Since ESXi 7.0, it is possible to choose between 4 different predefined partitioning layouts. This guide will show you how to install ESXi 8 and select a partitioning layout in the [OVHcloud Control Panel](/links/manager) or via the [OVHcloud API](/links/api). +This guide will show you how to install ESXi 8 on your dedicated servers, and select a partitioning layout in the [OVHcloud Control Panel](/links/manager) or via the [OVHcloud API](/links/api). ## Requirements @@ -26,11 +25,15 @@ OVHcloud installations of ESXi are therefore compliant with the configuration se ## Instructions +With OVHcloud dedicated servers, you can freely [configure partitioning](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh). This gives customers a wide range of options when installing an operating system. ESXi is an exception because it is a UNIX-based, proprietary system with a proprietary installer. + +OVHcloud installations of ESXi are therefore compliant with the configuration set by the software publisher. + ESXi 7.0 and later versions introduced a [boot option to configure the size of ESXi system partitions](https://kb.vmware.com/s/article/81166) because the increased size of the system partition could cause issues, especially on systems with small disks. OVHcloud includes this feature in the [OVHcloud Control Panel](/links/manager) and the [OVHcloud API](/links/api). Even with multiple disks available on a server, the ESXi OS installation uses only the first disk of the targeted disk group (see [OVHcloud API and OS Installation - Disk Groups](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh#disk-group)). Other disks may be configured afterwards to be used for virtual machines (see [How to add a datastore](/pages/bare_metal_cloud/dedicated_servers/hgrstor2_system_configuration#add-datastore)). -There are 4 different values: +There are 4 predefined partitioning layouts: |Value|System size¹|Datastore³| |---|---|---| diff --git a/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.fr-ca.md b/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.fr-ca.md index 92afdc0983f..e06831105fb 100644 --- a/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.fr-ca.md +++ b/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.fr-ca.md @@ -1,7 +1,7 @@ --- title: "Installer VMware ESXi 8 sur un serveur dédié" excerpt: "Découvrez comment installer et configurer VMware ESXi 8 sur un serveur dédié en utilisant un template fourni par OVHcloud" -updated: 2025-09-15 +updated: 2025-10-03 --- ## Objectif @@ -11,9 +11,7 @@ updated: 2025-09-15 > Depuis le 15 septembre 2025, OVHcloud propose un template d'installation ESXi 8 pour ses serveurs dédiés. > -Avec les [serveurs dédiés OVHcloud](/links/bare-metal/bare-metal), vous pouvez [personnaliser le partitionnement](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh). Cela vous donne des possibilités de configuration assez vastes lors de l'installation du système d'exploitation. ESXi ne le permet pas à cause de ses spécificités car il s'agit d'un système propriétaire UNIX avec un installateur propriétaire. Par conséquent, les installations ESXi d'OVHcloud sont conformes à la configuration définie par l'éditeur du logiciel. Depuis ESXi 7.0, il est possible de choisir entre 4 schémas de partitionnement prédéfinis. - -Ce guide a pour objectif de vous montrer comment installer ESXi 8 et sélectionner un schéma de partitionnement dans l'[espace client OVHcloud](/links/manager) ou via l'[API OVHcloud](/links/api). +Ce guide a pour objectif de vous montrer comment installer ESXi 8 sur vos serveurs dédiés, et sélectionner un schéma de partitionnement dans l'[espace client OVHcloud](/links/manager) ou via l'[API OVHcloud](/links/api). ## Prérequis @@ -27,11 +25,15 @@ Ce guide a pour objectif de vous montrer comment installer ESXi 8 et sélectionn ## En pratique -ESXi 7.0 et les versions ultérieures ont introduit une [option d'amorçage permettant de configurer la taille des partitions système d'ESXi](https://kb.vmware.com/s/article/81166). Cette fonctionnalité a été introduite par l'éditeur car l'augmentation de la taille de la partition système pouvait poser problème, en particulier sur les machines avec de petits disques. OVHcloud a inclus cette fonctionnalité qui est disponible aussi bien depuis l'[espace client OVHcloud](https://www.ovh.com/manager/#/dedicated/configuration) que via l'[API OVHcloud](/links/api). +Avec les serveurs dédiés OVHcloud, vous pouvez [personnaliser le partitionnement](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh), ce qui offre une grande flexibilité lors de l’installation du système d’exploitation. En revanche, cela n’est pas possible avec ESXi, car il s’agit d’un système propriétaire basé sur UNIX et utilisant un installateur propriétaire. + +Par conséquent, les installations ESXi d'OVHcloud sont conformes à la configuration définie par l'éditeur du logiciel. + +ESXi 7.0 et les versions ultérieures ont introduit une [option d'amorçage permettant de configurer la taille des partitions système d'ESXi](https://kb.vmware.com/s/article/81166). Cette fonctionnalité a été introduite par l'éditeur car l'augmentation de la taille de la partition système pouvait poser problème, en particulier sur les machines avec de petits disques. OVHcloud a inclus cette fonctionnalité, qui est disponible aussi bien depuis l'[espace client OVHcloud](/links/manager) que via l'[API OVHcloud](/links/api). Même si votre serveur dispose de plusieurs disques, l'installation d'ESXi utilise uniquement le premier disque du groupe de disques ciblé (voir « [API OVHcloud et installation d'un OS - Grappes de disques](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh#disk-group) »). Les autres disques peuvent être configurés par la suite pour être utilisés pour les machines virtuelles (voir « [Comment ajouter un datastore](/pages/bare_metal_cloud/dedicated_servers/hgrstor2_system_configuration#add-datastore) »). -Il existe 4 valeurs différentes : +Il existe 4 schémas de partitionnement prédéfinis : |Valeur|Taille Système¹|Datastore³| |---|---|---| diff --git a/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.fr-fr.md b/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.fr-fr.md index 92afdc0983f..e06831105fb 100644 --- a/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.fr-fr.md +++ b/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.fr-fr.md @@ -1,7 +1,7 @@ --- title: "Installer VMware ESXi 8 sur un serveur dédié" excerpt: "Découvrez comment installer et configurer VMware ESXi 8 sur un serveur dédié en utilisant un template fourni par OVHcloud" -updated: 2025-09-15 +updated: 2025-10-03 --- ## Objectif @@ -11,9 +11,7 @@ updated: 2025-09-15 > Depuis le 15 septembre 2025, OVHcloud propose un template d'installation ESXi 8 pour ses serveurs dédiés. > -Avec les [serveurs dédiés OVHcloud](/links/bare-metal/bare-metal), vous pouvez [personnaliser le partitionnement](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh). Cela vous donne des possibilités de configuration assez vastes lors de l'installation du système d'exploitation. ESXi ne le permet pas à cause de ses spécificités car il s'agit d'un système propriétaire UNIX avec un installateur propriétaire. Par conséquent, les installations ESXi d'OVHcloud sont conformes à la configuration définie par l'éditeur du logiciel. Depuis ESXi 7.0, il est possible de choisir entre 4 schémas de partitionnement prédéfinis. - -Ce guide a pour objectif de vous montrer comment installer ESXi 8 et sélectionner un schéma de partitionnement dans l'[espace client OVHcloud](/links/manager) ou via l'[API OVHcloud](/links/api). +Ce guide a pour objectif de vous montrer comment installer ESXi 8 sur vos serveurs dédiés, et sélectionner un schéma de partitionnement dans l'[espace client OVHcloud](/links/manager) ou via l'[API OVHcloud](/links/api). ## Prérequis @@ -27,11 +25,15 @@ Ce guide a pour objectif de vous montrer comment installer ESXi 8 et sélectionn ## En pratique -ESXi 7.0 et les versions ultérieures ont introduit une [option d'amorçage permettant de configurer la taille des partitions système d'ESXi](https://kb.vmware.com/s/article/81166). Cette fonctionnalité a été introduite par l'éditeur car l'augmentation de la taille de la partition système pouvait poser problème, en particulier sur les machines avec de petits disques. OVHcloud a inclus cette fonctionnalité qui est disponible aussi bien depuis l'[espace client OVHcloud](https://www.ovh.com/manager/#/dedicated/configuration) que via l'[API OVHcloud](/links/api). +Avec les serveurs dédiés OVHcloud, vous pouvez [personnaliser le partitionnement](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh), ce qui offre une grande flexibilité lors de l’installation du système d’exploitation. En revanche, cela n’est pas possible avec ESXi, car il s’agit d’un système propriétaire basé sur UNIX et utilisant un installateur propriétaire. + +Par conséquent, les installations ESXi d'OVHcloud sont conformes à la configuration définie par l'éditeur du logiciel. + +ESXi 7.0 et les versions ultérieures ont introduit une [option d'amorçage permettant de configurer la taille des partitions système d'ESXi](https://kb.vmware.com/s/article/81166). Cette fonctionnalité a été introduite par l'éditeur car l'augmentation de la taille de la partition système pouvait poser problème, en particulier sur les machines avec de petits disques. OVHcloud a inclus cette fonctionnalité, qui est disponible aussi bien depuis l'[espace client OVHcloud](/links/manager) que via l'[API OVHcloud](/links/api). Même si votre serveur dispose de plusieurs disques, l'installation d'ESXi utilise uniquement le premier disque du groupe de disques ciblé (voir « [API OVHcloud et installation d'un OS - Grappes de disques](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh#disk-group) »). Les autres disques peuvent être configurés par la suite pour être utilisés pour les machines virtuelles (voir « [Comment ajouter un datastore](/pages/bare_metal_cloud/dedicated_servers/hgrstor2_system_configuration#add-datastore) »). -Il existe 4 valeurs différentes : +Il existe 4 schémas de partitionnement prédéfinis : |Valeur|Taille Système¹|Datastore³| |---|---|---| diff --git a/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.it-it.md b/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.it-it.md index f49b95c2388..d2ef63efe14 100644 --- a/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.it-it.md +++ b/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.it-it.md @@ -1,7 +1,7 @@ --- title: How to install VMware ESXi 8 on a dedicated server excerpt: Find out how to install and configure VMware ESXi 8 on a dedicated server using an OVHcloud provided image -updated: 2025-09-15 +updated: 2025-10-03 --- ## Objective @@ -11,8 +11,7 @@ updated: 2025-09-15 > Since September 15, 2025, OVHcloud provides an ESXi 8 installation template for its dedicated servers. > -With [OVHcloud dedicated servers](/links/bare-metal/bare-metal), you can freely [configure partitioning](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh). This gives customers a wide range of options when installing an operating system. ESXi is an exception because it is a UNIX-based, proprietary system with a proprietary installer.
-OVHcloud installations of ESXi are therefore compliant with the configuration set by the software publisher. Since ESXi 7.0, it is possible to choose between 4 different predefined partitioning layouts. This guide will show you how to install ESXi 8 and select a partitioning layout in the [OVHcloud Control Panel](/links/manager) or via the [OVHcloud API](/links/api). +This guide will show you how to install ESXi 8 on your dedicated servers, and select a partitioning layout in the [OVHcloud Control Panel](/links/manager) or via the [OVHcloud API](/links/api). ## Requirements @@ -26,11 +25,15 @@ OVHcloud installations of ESXi are therefore compliant with the configuration se ## Instructions +With OVHcloud dedicated servers, you can freely [configure partitioning](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh). This gives customers a wide range of options when installing an operating system. ESXi is an exception because it is a UNIX-based, proprietary system with a proprietary installer. + +OVHcloud installations of ESXi are therefore compliant with the configuration set by the software publisher. + ESXi 7.0 and later versions introduced a [boot option to configure the size of ESXi system partitions](https://kb.vmware.com/s/article/81166) because the increased size of the system partition could cause issues, especially on systems with small disks. OVHcloud includes this feature in the [OVHcloud Control Panel](/links/manager) and the [OVHcloud API](/links/api). Even with multiple disks available on a server, the ESXi OS installation uses only the first disk of the targeted disk group (see [OVHcloud API and OS Installation - Disk Groups](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh#disk-group)). Other disks may be configured afterwards to be used for virtual machines (see [How to add a datastore](/pages/bare_metal_cloud/dedicated_servers/hgrstor2_system_configuration#add-datastore)). -There are 4 different values: +There are 4 predefined partitioning layouts: |Value|System size¹|Datastore³| |---|---|---| diff --git a/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.pl-pl.md b/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.pl-pl.md index f49b95c2388..d2ef63efe14 100644 --- a/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.pl-pl.md +++ b/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.pl-pl.md @@ -1,7 +1,7 @@ --- title: How to install VMware ESXi 8 on a dedicated server excerpt: Find out how to install and configure VMware ESXi 8 on a dedicated server using an OVHcloud provided image -updated: 2025-09-15 +updated: 2025-10-03 --- ## Objective @@ -11,8 +11,7 @@ updated: 2025-09-15 > Since September 15, 2025, OVHcloud provides an ESXi 8 installation template for its dedicated servers. > -With [OVHcloud dedicated servers](/links/bare-metal/bare-metal), you can freely [configure partitioning](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh). This gives customers a wide range of options when installing an operating system. ESXi is an exception because it is a UNIX-based, proprietary system with a proprietary installer.
-OVHcloud installations of ESXi are therefore compliant with the configuration set by the software publisher. Since ESXi 7.0, it is possible to choose between 4 different predefined partitioning layouts. This guide will show you how to install ESXi 8 and select a partitioning layout in the [OVHcloud Control Panel](/links/manager) or via the [OVHcloud API](/links/api). +This guide will show you how to install ESXi 8 on your dedicated servers, and select a partitioning layout in the [OVHcloud Control Panel](/links/manager) or via the [OVHcloud API](/links/api). ## Requirements @@ -26,11 +25,15 @@ OVHcloud installations of ESXi are therefore compliant with the configuration se ## Instructions +With OVHcloud dedicated servers, you can freely [configure partitioning](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh). This gives customers a wide range of options when installing an operating system. ESXi is an exception because it is a UNIX-based, proprietary system with a proprietary installer. + +OVHcloud installations of ESXi are therefore compliant with the configuration set by the software publisher. + ESXi 7.0 and later versions introduced a [boot option to configure the size of ESXi system partitions](https://kb.vmware.com/s/article/81166) because the increased size of the system partition could cause issues, especially on systems with small disks. OVHcloud includes this feature in the [OVHcloud Control Panel](/links/manager) and the [OVHcloud API](/links/api). Even with multiple disks available on a server, the ESXi OS installation uses only the first disk of the targeted disk group (see [OVHcloud API and OS Installation - Disk Groups](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh#disk-group)). Other disks may be configured afterwards to be used for virtual machines (see [How to add a datastore](/pages/bare_metal_cloud/dedicated_servers/hgrstor2_system_configuration#add-datastore)). -There are 4 different values: +There are 4 predefined partitioning layouts: |Value|System size¹|Datastore³| |---|---|---| diff --git a/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.pt-pt.md b/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.pt-pt.md index f49b95c2388..d2ef63efe14 100644 --- a/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.pt-pt.md +++ b/pages/bare_metal_cloud/dedicated_servers/esxi-partitioning/guide.pt-pt.md @@ -1,7 +1,7 @@ --- title: How to install VMware ESXi 8 on a dedicated server excerpt: Find out how to install and configure VMware ESXi 8 on a dedicated server using an OVHcloud provided image -updated: 2025-09-15 +updated: 2025-10-03 --- ## Objective @@ -11,8 +11,7 @@ updated: 2025-09-15 > Since September 15, 2025, OVHcloud provides an ESXi 8 installation template for its dedicated servers. > -With [OVHcloud dedicated servers](/links/bare-metal/bare-metal), you can freely [configure partitioning](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh). This gives customers a wide range of options when installing an operating system. ESXi is an exception because it is a UNIX-based, proprietary system with a proprietary installer.
-OVHcloud installations of ESXi are therefore compliant with the configuration set by the software publisher. Since ESXi 7.0, it is possible to choose between 4 different predefined partitioning layouts. This guide will show you how to install ESXi 8 and select a partitioning layout in the [OVHcloud Control Panel](/links/manager) or via the [OVHcloud API](/links/api). +This guide will show you how to install ESXi 8 on your dedicated servers, and select a partitioning layout in the [OVHcloud Control Panel](/links/manager) or via the [OVHcloud API](/links/api). ## Requirements @@ -26,11 +25,15 @@ OVHcloud installations of ESXi are therefore compliant with the configuration se ## Instructions +With OVHcloud dedicated servers, you can freely [configure partitioning](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh). This gives customers a wide range of options when installing an operating system. ESXi is an exception because it is a UNIX-based, proprietary system with a proprietary installer. + +OVHcloud installations of ESXi are therefore compliant with the configuration set by the software publisher. + ESXi 7.0 and later versions introduced a [boot option to configure the size of ESXi system partitions](https://kb.vmware.com/s/article/81166) because the increased size of the system partition could cause issues, especially on systems with small disks. OVHcloud includes this feature in the [OVHcloud Control Panel](/links/manager) and the [OVHcloud API](/links/api). Even with multiple disks available on a server, the ESXi OS installation uses only the first disk of the targeted disk group (see [OVHcloud API and OS Installation - Disk Groups](/pages/bare_metal_cloud/dedicated_servers/partitioning_ovh#disk-group)). Other disks may be configured afterwards to be used for virtual machines (see [How to add a datastore](/pages/bare_metal_cloud/dedicated_servers/hgrstor2_system_configuration#add-datastore)). -There are 4 different values: +There are 4 predefined partitioning layouts: |Value|System size¹|Datastore³| |---|---|---| diff --git a/pages/bare_metal_cloud/dedicated_servers/faq-esxi/meta.yaml b/pages/bare_metal_cloud/dedicated_servers/faq-esxi/meta.yaml index 3c011b758b1..d433d03d0df 100644 --- a/pages/bare_metal_cloud/dedicated_servers/faq-esxi/meta.yaml +++ b/pages/bare_metal_cloud/dedicated_servers/faq-esxi/meta.yaml @@ -1,3 +1,3 @@ id: 55a19d8a-3e75-4a5e-a249-1ff91f357aa2 full_slug: dedicated-servers-esxi-faq -reference_category: bare-metal-cloud-dedicated-servers-security \ No newline at end of file +reference_category: bare-metal-cloud-dedicated-servers-security-hardening \ No newline at end of file diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos/images/GAME_screen_en.png b/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos/images/GAME_screen_en.png deleted file mode 100644 index 8ca99bb106e..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos/images/GAME_screen_en.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos/images/add-rule-btn.png b/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos/images/add-rule-btn.png deleted file mode 100644 index 189522f74fa..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos/images/add-rule-btn.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos/images/add-rule-screen.png b/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos/images/add-rule-screen.png deleted file mode 100644 index c3e7b1f55c1..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos/images/add-rule-screen.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos/images/bare-metal-cloud-tab.png b/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos/images/bare-metal-cloud-tab.png deleted file mode 100644 index 5c8632849d3..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos/images/bare-metal-cloud-tab.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos/images/basic-rule.png b/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos/images/basic-rule.png deleted file mode 100644 index ee34b2d7843..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos/images/basic-rule.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos/images/configure-game-firewall.png b/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos/images/configure-game-firewall.png deleted file mode 100644 index b8fd466d5fc..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos/images/configure-game-firewall.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos/images/confirm-new-rule.png b/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos/images/confirm-new-rule.png deleted file mode 100644 index 756596add81..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos/images/confirm-new-rule.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos/images/edge-firewall-add-rule.png b/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos/images/edge-firewall-add-rule.png deleted file mode 100644 index b750df35741..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos/images/edge-firewall-add-rule.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos/images/firewall_game_01.png b/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos/images/firewall_game_01.png deleted file mode 100644 index 3924b81dfe3..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos/images/firewall_game_01.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos/images/firewall_game_api_get_proto.png b/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos/images/firewall_game_api_get_proto.png deleted file mode 100644 index d4a1adb41c9..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos/images/firewall_game_api_get_proto.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos/images/game-server.png b/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos/images/game-server.png deleted file mode 100644 index 963bfdafd9c..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos/images/game-server.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos/images/global_schema.png b/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos/images/global_schema.png deleted file mode 100644 index 6d941e742ed..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos/images/global_schema.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos/images/ip-tab.png b/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos/images/ip-tab.png deleted file mode 100644 index fdc25c9d764..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos/images/ip-tab.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos/images/network-tab.png b/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos/images/network-tab.png deleted file mode 100644 index 5a29c147703..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos/images/network-tab.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos/images/tcp-rule.png b/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos/images/tcp-rule.png deleted file mode 100644 index 8f395bfd6a7..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos/images/tcp-rule.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.de-de.md b/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.de-de.md index 579c8c68252..30ce764eb60 100644 --- a/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.de-de.md +++ b/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.de-de.md @@ -1,7 +1,7 @@ --- title: Aktivieren und Konfigurieren der Edge Network Firewall excerpt: Erfahren Sie hier, wie Sie die Edge Network Firewall konfigurieren -updated: 2025-09-08 +updated: 2025-10-21 --- ## Ziel @@ -15,9 +15,9 @@ Zum Schutz von Diensten, die über öffentliche IP-Adressen zugänglich sind, bi > Weitere Informationen zu unserer Anti-DDoS-Lösung finden Sie [hier](/links/security/antiddos). > -| ![global-schema](images/global_schema.png) | -|:--:| -| Diagramm zu DDoS-Schutz & Infrastruktur bei OVHcloud | +| OVHcloud Anti-DDoS-Infrastruktur & Game-Schutzdienste-Diagramm | +|:--:| +| ![global-schema](images/global_schema_2025.png) | ## Voraussetzungen diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.en-asia.md b/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.en-asia.md index a9936bb7dda..6239e106d42 100644 --- a/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.en-asia.md +++ b/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.en-asia.md @@ -1,7 +1,7 @@ --- title: Enabling and configuring the Edge Network Firewall excerpt: Find out how to configure the Edge Network Firewall for your services -updated: 2025-09-08 +updated: 2025-10-21 --- ## Objective @@ -15,9 +15,9 @@ To protect customer services exposed on public IP addresses, OVHcloud offers a s > You can find more information on our Anti-DDoS solution on [our website](/links/security/antiddos). > -| ![global-schema](images/global_schema.png) | -|:--:| -| Anti-DDoS infrastructure & game protection services diagram at OVHcloud | +| Anti-DDoS infrastructure & Game protection services diagram at OVHcloud | +|:--:| +| ![global-schema](images/global_schema_2025.png) | ## Requirements diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.en-au.md b/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.en-au.md index f67615cf347..ba50bcaa5fe 100644 --- a/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.en-au.md +++ b/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.en-au.md @@ -1,7 +1,7 @@ --- title: Enabling and configuring the Edge Network Firewall excerpt: Find out how to configure the Edge Network Firewall for your services -updated: 2025-09-08 +updated: 2025-10-21 --- ## Objective @@ -15,9 +15,9 @@ To protect customer services exposed on public IP addresses, OVHcloud offers a s > You can find more information on our Anti-DDoS solution on [our website](/links/security/antiddos). > -| ![global-schema](images/global_schema.png) | -|:--:| -| Anti-DDoS infrastructure & game protection services diagram at OVHcloud | +| Anti-DDoS infrastructure & Game protection services diagram at OVHcloud | +|:--:| +| ![global-schema](images/global_schema_2025.png) | ## Requirements diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.en-ca.md b/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.en-ca.md index a9936bb7dda..6239e106d42 100644 --- a/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.en-ca.md +++ b/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.en-ca.md @@ -1,7 +1,7 @@ --- title: Enabling and configuring the Edge Network Firewall excerpt: Find out how to configure the Edge Network Firewall for your services -updated: 2025-09-08 +updated: 2025-10-21 --- ## Objective @@ -15,9 +15,9 @@ To protect customer services exposed on public IP addresses, OVHcloud offers a s > You can find more information on our Anti-DDoS solution on [our website](/links/security/antiddos). > -| ![global-schema](images/global_schema.png) | -|:--:| -| Anti-DDoS infrastructure & game protection services diagram at OVHcloud | +| Anti-DDoS infrastructure & Game protection services diagram at OVHcloud | +|:--:| +| ![global-schema](images/global_schema_2025.png) | ## Requirements diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.en-gb.md b/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.en-gb.md index a9936bb7dda..6239e106d42 100644 --- a/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.en-gb.md +++ b/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.en-gb.md @@ -1,7 +1,7 @@ --- title: Enabling and configuring the Edge Network Firewall excerpt: Find out how to configure the Edge Network Firewall for your services -updated: 2025-09-08 +updated: 2025-10-21 --- ## Objective @@ -15,9 +15,9 @@ To protect customer services exposed on public IP addresses, OVHcloud offers a s > You can find more information on our Anti-DDoS solution on [our website](/links/security/antiddos). > -| ![global-schema](images/global_schema.png) | -|:--:| -| Anti-DDoS infrastructure & game protection services diagram at OVHcloud | +| Anti-DDoS infrastructure & Game protection services diagram at OVHcloud | +|:--:| +| ![global-schema](images/global_schema_2025.png) | ## Requirements diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.en-ie.md b/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.en-ie.md index a9936bb7dda..6239e106d42 100644 --- a/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.en-ie.md +++ b/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.en-ie.md @@ -1,7 +1,7 @@ --- title: Enabling and configuring the Edge Network Firewall excerpt: Find out how to configure the Edge Network Firewall for your services -updated: 2025-09-08 +updated: 2025-10-21 --- ## Objective @@ -15,9 +15,9 @@ To protect customer services exposed on public IP addresses, OVHcloud offers a s > You can find more information on our Anti-DDoS solution on [our website](/links/security/antiddos). > -| ![global-schema](images/global_schema.png) | -|:--:| -| Anti-DDoS infrastructure & game protection services diagram at OVHcloud | +| Anti-DDoS infrastructure & Game protection services diagram at OVHcloud | +|:--:| +| ![global-schema](images/global_schema_2025.png) | ## Requirements diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.en-sg.md b/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.en-sg.md index a9936bb7dda..6239e106d42 100644 --- a/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.en-sg.md +++ b/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.en-sg.md @@ -1,7 +1,7 @@ --- title: Enabling and configuring the Edge Network Firewall excerpt: Find out how to configure the Edge Network Firewall for your services -updated: 2025-09-08 +updated: 2025-10-21 --- ## Objective @@ -15,9 +15,9 @@ To protect customer services exposed on public IP addresses, OVHcloud offers a s > You can find more information on our Anti-DDoS solution on [our website](/links/security/antiddos). > -| ![global-schema](images/global_schema.png) | -|:--:| -| Anti-DDoS infrastructure & game protection services diagram at OVHcloud | +| Anti-DDoS infrastructure & Game protection services diagram at OVHcloud | +|:--:| +| ![global-schema](images/global_schema_2025.png) | ## Requirements diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.en-us.md b/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.en-us.md index a9936bb7dda..6239e106d42 100644 --- a/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.en-us.md +++ b/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.en-us.md @@ -1,7 +1,7 @@ --- title: Enabling and configuring the Edge Network Firewall excerpt: Find out how to configure the Edge Network Firewall for your services -updated: 2025-09-08 +updated: 2025-10-21 --- ## Objective @@ -15,9 +15,9 @@ To protect customer services exposed on public IP addresses, OVHcloud offers a s > You can find more information on our Anti-DDoS solution on [our website](/links/security/antiddos). > -| ![global-schema](images/global_schema.png) | -|:--:| -| Anti-DDoS infrastructure & game protection services diagram at OVHcloud | +| Anti-DDoS infrastructure & Game protection services diagram at OVHcloud | +|:--:| +| ![global-schema](images/global_schema_2025.png) | ## Requirements diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.es-es.md b/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.es-es.md index 2b5dd03424c..c71cb0f0287 100644 --- a/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.es-es.md +++ b/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.es-es.md @@ -1,7 +1,7 @@ --- title: 'Activación y configuración del Edge Network Firewall' excerpt: 'Descubra cómo configurar el Edge Network Firewall para sus servicios' -updated: 2025-09-08 +updated: 2025-10-21 --- ## Objetivo @@ -17,9 +17,9 @@ Para proteger su infraestructura mundial y los servidores de sus clientes, OVHcl > Puede encontrar más información sobre nuestra solución anti-DDoS en [nuestro sitio web](/links/security/antiddos). > -| ![global-schema](images/global_schema.png) | +| Infraestructura anti-DDoS y protección DDoS Game en OVHcloud | |:--:| -| Diagrama de los servicios de protección de juegos e infraestructuras anti-DDoS en OVHcloud | +| ![global-schema](images/global_schema_2025.png) | ## Requisitos diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.es-us.md b/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.es-us.md index 6eaa927888f..18c71e23663 100644 --- a/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.es-us.md +++ b/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.es-us.md @@ -1,7 +1,7 @@ --- title: 'Activación y configuración del Edge Network Firewall' excerpt: 'Descubra cómo configurar el Edge Network Firewall para sus servicios' -updated: 2025-09-08 +updated: 2025-10-21 --- ## Objetivo @@ -17,9 +17,9 @@ Para proteger su infraestructura mundial y los servidores de sus clientes, OVHcl > Puede encontrar más información sobre nuestra solución anti-DDoS en [nuestro sitio web](/links/security/antiddos). > -| ![global-schema](images/global_schema.png) | +| Infraestructura anti-DDoS y protección DDoS Game en OVHcloud | |:--:| -| Diagrama de los servicios de protección de juegos e infraestructuras anti-DDoS en OVHcloud | +| ![global-schema](images/global_schema_2025.png) | ## Requisitos diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.fr-ca.md b/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.fr-ca.md index bf6eb931bdd..f650921fc8e 100644 --- a/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.fr-ca.md +++ b/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.fr-ca.md @@ -1,7 +1,7 @@ --- title: 'Activer et configurer le Edge Network Firewall' excerpt: 'Découvrez comment configurer le Edge Network Firewall pour vos services' -updated: 2025-09-08 +updated: 2025-10-21 --- ## Objectif @@ -15,9 +15,9 @@ Pour protéger les services des clients exposés sur les adresses IP publiques, > Pour plus d'informations sur notre solution Anti-DDoS, [cliquez ici](/links/security/antiddos). > -| ![global-schema](images/global_schema.png) | -|:--:| -| Comment DDoS mitigation est réalisée chez OVHcloud | +| Infrastructure anti-DDoS et protection DDoS Game chez OVHcloud | +|:--:| +| ![global-schema](images/global_schema_2025.png) | ## Prérequis diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.fr-fr.md b/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.fr-fr.md index 13b95c7aeac..ca5a0347463 100644 --- a/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.fr-fr.md +++ b/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.fr-fr.md @@ -1,7 +1,7 @@ --- title: 'Activer et configurer le Edge Network Firewall' excerpt: 'Découvrez comment configurer le Edge Network Firewall pour vos services' -updated: 2025-09-08 +updated: 2025-10-21 --- ## Objectif @@ -15,9 +15,9 @@ Pour protéger les services des clients exposés sur les adresses IP publiques, > Pour plus d'informations sur notre solution Anti-DDoS, [cliquez ici](/links/security/antiddos). > -| ![global-schema](images/global_schema.png) | -|:--:| -| Comment DDoS mitigation est réalisée chez OVHcloud | +| Infrastructure anti-DDoS et protection DDoS Game chez OVHcloud | +|:--:| +| ![global-schema](images/global_schema_2025.png) | ## Prérequis diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.it-it.md b/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.it-it.md index a1435a3af48..f377b356840 100644 --- a/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.it-it.md +++ b/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.it-it.md @@ -1,7 +1,7 @@ --- title: 'Abilitazione e configurazione di Edge Network Firewall' excerpt: 'Come configurare Edge Network Firewall per i servizi' -updated: 2025-09-08 +updated: 2025-10-21 --- ## Obiettivo @@ -15,9 +15,9 @@ Per proteggere i servizi clienti esposti agli indirizzi IP pubblici, OVHcloud of > Per maggiori informazioni sulla soluzione anti-DDoS di OVHcloud, visita [il sito Web](/links/security/antiddos). > -| ![global-schema](images/global_schema.png) | -|:--:| -| Schema dei servizi anti-DDoS e di protezione dei giochi in OVHcloud | +| Infrastruttura anti-DDoS e protezione DDoS Game su OVHcloud | +|:--:| +| ![global-schema](images/global_schema_2025.png) | ## Requisiti diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.pl-pl.md b/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.pl-pl.md index 53f60db6835..17b34dbc8c6 100644 --- a/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.pl-pl.md +++ b/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.pl-pl.md @@ -1,7 +1,7 @@ --- title: 'Aktywacja i konfiguracja Edge Network Firewall' excerpt: 'Dowiedz się, jak skonfigurować Edge Network Firewall dla Twoich usług' -updated: 2025-09-08 +updated: 2025-10-21 --- ## Wprowadzenie @@ -15,9 +15,9 @@ Aby chronić usługi dostępne dla klientów korzystających z publicznych adres > Więcej informacji na temat rozwiązania Anty-DDoS znajdziesz na [naszej stronie WWW](/links/security/antiddos). > -| ![global-schema](images/global_schema.png) | +| Infrastruktura Anty-DDoS & usługi ochrony gier diagram w OVHcloud | |:--:| -| Anty-DDoS - schemat infrastruktury i usług ochrony gier w OVHcloud | +| ![global-schema](images/global_schema_2025.png) | ## Wymagania początkowe diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.pt-pt.md b/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.pt-pt.md index ee3b98667b4..f6c1a42c227 100644 --- a/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.pt-pt.md +++ b/pages/bare_metal_cloud/dedicated_servers/firewall_network/guide.pt-pt.md @@ -1,7 +1,7 @@ --- title: 'Habilitar e configurar o Edge Network Firewall' excerpt: 'Saiba como configurar a Edge Network Firewall para os seus serviços' -updated: 2025-09-08 +updated: 2025-10-21 --- ## Objetivo @@ -15,9 +15,9 @@ Para proteger os serviços dos clientes expostos aos IPs públicos, a OVHcloud o > Encontrará mais informações sobre a nossa solução Anti-DDoS no [nosso website](/links/security/antiddos). > -| ![global-schema](images/global_schema.png) | -|:--:| -| Esquema da infraestrutura Anti-DDoS e dos serviços de proteção de jogos da OVHcloud | +| Infraestrutura anti-DDoS e proteção DDoS Game na OVHcloud | +|:--:| +| ![global-schema](images/global_schema_2025.png) | ## Requisitos diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/ConfigureArmor.jpg b/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/ConfigureArmor.jpg deleted file mode 100644 index 3d90f7ce6a1..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/ConfigureArmor.jpg and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/ConfigureArmor2021.png b/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/ConfigureArmor2021.png deleted file mode 100644 index 08a2a05792a..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/ConfigureArmor2021.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/GAMEWall.jpg b/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/GAMEWall.jpg deleted file mode 100644 index 87ac38a79c0..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/GAMEWall.jpg and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/GAMEwall2021.png b/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/GAMEwall2021.png deleted file mode 100644 index a94ba573c6e..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/GAMEwall2021.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/activate-desactivate.png b/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/activate-desactivate.png deleted file mode 100644 index afee2120bc2..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/activate-desactivate.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/activationconfig_2020.png b/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/activationconfig_2020.png deleted file mode 100644 index 4d101b72ea3..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/activationconfig_2020.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/addarule2022.png b/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/addarule2022.png deleted file mode 100644 index 656783d1920..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/addarule2022.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/ajoutregle1.png b/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/ajoutregle1.png deleted file mode 100644 index 98c0649ee93..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/ajoutregle1.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/ajoutregle1_2020.png b/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/ajoutregle1_2020.png deleted file mode 100644 index 9352a55f367..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/ajoutregle1_2020.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/ajoutregle4.png b/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/ajoutregle4.png deleted file mode 100644 index e133edcb4b8..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/ajoutregle4.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/ajoutregle4_2020.png b/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/ajoutregle4_2020.png deleted file mode 100644 index 181b8704d68..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/ajoutregle4_2020.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/bare-metal-cloud-tab.png b/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/bare-metal-cloud-tab.png deleted file mode 100644 index 5c8632849d3..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/bare-metal-cloud-tab.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/basic-rule.png b/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/basic-rule.png deleted file mode 100644 index ee34b2d7843..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/basic-rule.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/confirm-mitigation.png b/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/confirm-mitigation.png deleted file mode 100644 index 6925ad970c0..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/confirm-mitigation.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/creationvalid.png b/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/creationvalid.png deleted file mode 100644 index 30c44f88d8a..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/creationvalid.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/creationvalid_2020.png b/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/creationvalid_2020.png deleted file mode 100644 index cc722421b76..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/creationvalid_2020.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/edge-firewall-add-rule.png b/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/edge-firewall-add-rule.png deleted file mode 100644 index b750df35741..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/edge-firewall-add-rule.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/enf_enabled_button_02.png b/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/enf_enabled_button_02.png deleted file mode 100644 index 86783944bd7..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/enf_enabled_button_02.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/enf_enabled_button_02_blur.png b/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/enf_enabled_button_02_blur.png deleted file mode 100644 index d1801aa85ea..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/enf_enabled_button_02_blur.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/enf_enabled_button_03.png b/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/enf_enabled_button_03.png deleted file mode 100644 index be36e27d30f..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/enf_enabled_button_03.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/enf_enabled_button_03_blur.png b/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/enf_enabled_button_03_blur.png deleted file mode 100644 index 14265e19d48..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/enf_enabled_button_03_blur.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/enf_screen_01_en.png b/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/enf_screen_01_en.png deleted file mode 100644 index 6763fb2219a..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/enf_screen_01_en.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/exemple_2020.png b/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/exemple_2020.png deleted file mode 100644 index 42247524df9..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/exemple_2020.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/firewall_creation.png b/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/firewall_creation.png deleted file mode 100644 index 834f9728b6f..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/firewall_creation.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/firewall_creation2022.png b/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/firewall_creation2022.png deleted file mode 100644 index bb7bf7d5262..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/firewall_creation2022.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/firewall_creation_2020.png b/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/firewall_creation_2020.png deleted file mode 100644 index bcf23fbaa67..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/firewall_creation_2020.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/global_schema.png b/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/global_schema.png deleted file mode 100644 index 6d941e742ed..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/global_schema.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/global_schema_2025.png b/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/global_schema_2025.png new file mode 100644 index 00000000000..e2126a12486 Binary files /dev/null and b/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/global_schema_2025.png differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/ip-tab.png b/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/ip-tab.png deleted file mode 100644 index fdc25c9d764..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/ip-tab.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/menu-ipv4.png b/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/menu-ipv4.png deleted file mode 100644 index 764ef2c9957..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/menu-ipv4.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/mitigation-option.png b/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/mitigation-option.png deleted file mode 100644 index 379e13f81b7..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/mitigation-option.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/mitigation_menu.png b/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/mitigation_menu.png deleted file mode 100644 index 7ad931003e8..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/mitigation_menu.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/mitigation_menu_step_2.png b/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/mitigation_menu_step_2.png deleted file mode 100644 index dcf7a550a3d..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/mitigation_menu_step_2.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/mitigation_menu_step_3.png b/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/mitigation_menu_step_3.png deleted file mode 100644 index 351b685a16f..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/mitigation_menu_step_3.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/mitigation_menu_step_3_blur.png b/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/mitigation_menu_step_3_blur.png deleted file mode 100644 index 399f49151e3..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/mitigation_menu_step_3_blur.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/network-tab.png b/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/network-tab.png deleted file mode 100644 index 5a29c147703..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/network-tab.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/selectservice.png b/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/selectservice.png deleted file mode 100644 index 90a14ca0b62..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/selectservice.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/tcp-rule.png b/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/tcp-rule.png deleted file mode 100644 index 8f395bfd6a7..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/tcp-rule.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/vac-inside.png b/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/vac-inside.png deleted file mode 100644 index f650af203ac..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/firewall_network/images/vac-inside.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/getting-familiar-with-ovhcloud-control-panel/images/manageIPOVHcloud.png b/pages/bare_metal_cloud/dedicated_servers/getting-familiar-with-ovhcloud-control-panel/images/manageIPOVHcloud.png deleted file mode 100644 index e0ebe99132e..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/getting-familiar-with-ovhcloud-control-panel/images/manageIPOVHcloud.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/getting-familiar-with-ovhcloud-control-panel/images/manageIPsOVHcloud.png b/pages/bare_metal_cloud/dedicated_servers/getting-familiar-with-ovhcloud-control-panel/images/manageIPsOVHcloud.png deleted file mode 100644 index 26cc8e370b6..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/getting-familiar-with-ovhcloud-control-panel/images/manageIPsOVHcloud.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/getting-familiar-with-ovhcloud-control-panel/images/managelicenceOVHcloud.png b/pages/bare_metal_cloud/dedicated_servers/getting-familiar-with-ovhcloud-control-panel/images/managelicenceOVHcloud.png deleted file mode 100644 index d6260db6c1c..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/getting-familiar-with-ovhcloud-control-panel/images/managelicenceOVHcloud.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/getting-familiar-with-ovhcloud-control-panel/images/menutabovhcloud.png b/pages/bare_metal_cloud/dedicated_servers/getting-familiar-with-ovhcloud-control-panel/images/menutabovhcloud.png deleted file mode 100644 index b74bdf7be9e..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/getting-familiar-with-ovhcloud-control-panel/images/menutabovhcloud.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.de-de.md b/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.de-de.md index 81325560b7e..24112bc63e7 100644 --- a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.de-de.md +++ b/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.de-de.md @@ -1,13 +1,9 @@ --- title: "Hardwarefehler auf einem dedizierten Server im Rescue-Modus diagnostizieren" excerpt: "Erfahren Sie hier, wie Sie mithilfe von OVHcloud Rescue-Modus und Diagnose-Tools Hardwarefehler auf Ihrem Dedicated Server identifizieren" -updated: 2025-09-05 +updated: 2025-10-16 --- -> [!primary] -> Diese Übersetzung wurde durch unseren Partner SYSTRAN automatisch erstellt. In manchen Fällen können ungenaue Formulierungen verwendet worden sein, z.B. bei der Beschriftung von Schaltflächen oder technischen Details. Bitte ziehen Sie im Zweifelsfall die englische oder französische Fassung der Anleitung zu Rate. Möchten Sie mithelfen, diese Übersetzung zu verbessern? Dann nutzen Sie dazu bitte den Button "Beitragen" auf dieser Seite. -> - ## Ziel Mit der Zeit kann es bei Ihrem Server zu Hardwarefehlern kommen, die Fehlfunktionen verursachen. Wenn der Server im OVHcloud Rescue-Modus gestartet ist, stehen Ihnen mehrere Diagnosetools zur Verfügung, um fehlerhafte Hardwarekomponenten zu identifizieren. @@ -79,13 +75,7 @@ Führen Sie den folgenden Befehl aus, um das Dateisystem zu überprüfen: fsck -fy ``` -Führen Sie den folgenden Befehl aus, um einen Wiedergabetest durchzuführen. Ersetzen Sie `sd(x)` durch eigene Werte. - -```bash -dd if=/dev/zero of=/dev/sd(x) bs=1M count=100 -``` - -Führen Sie den folgenden Befehl aus, um einen Schreibtest durchzuführen. Ersetzen Sie `sd(x)` durch eigene Werte +Führen Sie den folgenden Befehl aus, um einen *Read*-Test durchzuführen. Ersetzen Sie `sd(x)` durch eigene Werte. ```bash hdparm -t /dev/sd(x) diff --git a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.en-asia.md b/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.en-asia.md index c1ed0bdcf6e..266333af8fe 100644 --- a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.en-asia.md +++ b/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.en-asia.md @@ -1,7 +1,7 @@ --- title: "How to perform server hardware diagnostics in rescue mode" excerpt: "Find out how to use the OVHcloud rescue mode and diagnostic tools to identify hardware failures on your dedicated server" -updated: 2025-09-05 +updated: 2025-10-16 --- ## Objective @@ -75,13 +75,7 @@ To check the file system, run the following command: fsck-fy ``` -For a read test, run the command below. Replace `sd(x)` with your own values. - -```bash -dd if=/dev/zero of=/dev/sd(x) bs=1M count=100 -``` - -For a write test, run the command below. Replace `sd(x)` with your own values +For a read test, run the command below. Replace `sd(x)` with your own values ```bash hdparm -t /dev/sd(x) diff --git a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.en-au.md b/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.en-au.md index 85782b71721..266333af8fe 100644 --- a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.en-au.md +++ b/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.en-au.md @@ -1,7 +1,7 @@ --- title: "How to perform server hardware diagnostics in rescue mode" excerpt: "Find out how to use the OVHcloud rescue mode and diagnostic tools to identify hardware failures on your dedicated server" -updated: 2025-09-05 +updated: 2025-10-16 --- ## Objective @@ -75,13 +75,7 @@ To check the file system, run the following command: fsck-fy ``` -For a read test, run the command below. Replace `sd(x)` with your own values. - -```bash -dd if=/dev/zero of=/dev/sd(x) bs=1M count=100 -``` - -For a write test, run the command below. Replace `sd(x)` with your own values +For a read test, run the command below. Replace `sd(x)` with your own values ```bash hdparm -t /dev/sd(x) @@ -89,4 +83,4 @@ hdparm -t /dev/sd(x) ## Go further -Join our [community of users](/links/community). \ No newline at end of file +Join our [community of users](/links/community). diff --git a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.en-ca.md b/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.en-ca.md index 85782b71721..266333af8fe 100644 --- a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.en-ca.md +++ b/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.en-ca.md @@ -1,7 +1,7 @@ --- title: "How to perform server hardware diagnostics in rescue mode" excerpt: "Find out how to use the OVHcloud rescue mode and diagnostic tools to identify hardware failures on your dedicated server" -updated: 2025-09-05 +updated: 2025-10-16 --- ## Objective @@ -75,13 +75,7 @@ To check the file system, run the following command: fsck-fy ``` -For a read test, run the command below. Replace `sd(x)` with your own values. - -```bash -dd if=/dev/zero of=/dev/sd(x) bs=1M count=100 -``` - -For a write test, run the command below. Replace `sd(x)` with your own values +For a read test, run the command below. Replace `sd(x)` with your own values ```bash hdparm -t /dev/sd(x) @@ -89,4 +83,4 @@ hdparm -t /dev/sd(x) ## Go further -Join our [community of users](/links/community). \ No newline at end of file +Join our [community of users](/links/community). diff --git a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.en-gb.md b/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.en-gb.md index 85782b71721..5c4ae290907 100644 --- a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.en-gb.md +++ b/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.en-gb.md @@ -1,7 +1,7 @@ --- title: "How to perform server hardware diagnostics in rescue mode" excerpt: "Find out how to use the OVHcloud rescue mode and diagnostic tools to identify hardware failures on your dedicated server" -updated: 2025-09-05 +updated: 2025-10-16 --- ## Objective @@ -75,13 +75,7 @@ To check the file system, run the following command: fsck-fy ``` -For a read test, run the command below. Replace `sd(x)` with your own values. - -```bash -dd if=/dev/zero of=/dev/sd(x) bs=1M count=100 -``` - -For a write test, run the command below. Replace `sd(x)` with your own values +For a read test, run the command below. Replace `sd(x)` with your own values ```bash hdparm -t /dev/sd(x) diff --git a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.en-ie.md b/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.en-ie.md index 85782b71721..266333af8fe 100644 --- a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.en-ie.md +++ b/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.en-ie.md @@ -1,7 +1,7 @@ --- title: "How to perform server hardware diagnostics in rescue mode" excerpt: "Find out how to use the OVHcloud rescue mode and diagnostic tools to identify hardware failures on your dedicated server" -updated: 2025-09-05 +updated: 2025-10-16 --- ## Objective @@ -75,13 +75,7 @@ To check the file system, run the following command: fsck-fy ``` -For a read test, run the command below. Replace `sd(x)` with your own values. - -```bash -dd if=/dev/zero of=/dev/sd(x) bs=1M count=100 -``` - -For a write test, run the command below. Replace `sd(x)` with your own values +For a read test, run the command below. Replace `sd(x)` with your own values ```bash hdparm -t /dev/sd(x) @@ -89,4 +83,4 @@ hdparm -t /dev/sd(x) ## Go further -Join our [community of users](/links/community). \ No newline at end of file +Join our [community of users](/links/community). diff --git a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.en-sg.md b/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.en-sg.md index 85782b71721..266333af8fe 100644 --- a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.en-sg.md +++ b/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.en-sg.md @@ -1,7 +1,7 @@ --- title: "How to perform server hardware diagnostics in rescue mode" excerpt: "Find out how to use the OVHcloud rescue mode and diagnostic tools to identify hardware failures on your dedicated server" -updated: 2025-09-05 +updated: 2025-10-16 --- ## Objective @@ -75,13 +75,7 @@ To check the file system, run the following command: fsck-fy ``` -For a read test, run the command below. Replace `sd(x)` with your own values. - -```bash -dd if=/dev/zero of=/dev/sd(x) bs=1M count=100 -``` - -For a write test, run the command below. Replace `sd(x)` with your own values +For a read test, run the command below. Replace `sd(x)` with your own values ```bash hdparm -t /dev/sd(x) @@ -89,4 +83,4 @@ hdparm -t /dev/sd(x) ## Go further -Join our [community of users](/links/community). \ No newline at end of file +Join our [community of users](/links/community). diff --git a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.en-us.md b/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.en-us.md index 85782b71721..266333af8fe 100644 --- a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.en-us.md +++ b/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.en-us.md @@ -1,7 +1,7 @@ --- title: "How to perform server hardware diagnostics in rescue mode" excerpt: "Find out how to use the OVHcloud rescue mode and diagnostic tools to identify hardware failures on your dedicated server" -updated: 2025-09-05 +updated: 2025-10-16 --- ## Objective @@ -75,13 +75,7 @@ To check the file system, run the following command: fsck-fy ``` -For a read test, run the command below. Replace `sd(x)` with your own values. - -```bash -dd if=/dev/zero of=/dev/sd(x) bs=1M count=100 -``` - -For a write test, run the command below. Replace `sd(x)` with your own values +For a read test, run the command below. Replace `sd(x)` with your own values ```bash hdparm -t /dev/sd(x) @@ -89,4 +83,4 @@ hdparm -t /dev/sd(x) ## Go further -Join our [community of users](/links/community). \ No newline at end of file +Join our [community of users](/links/community). diff --git a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.es-es.md b/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.es-es.md index dcd792fcc2f..a5badf67b01 100644 --- a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.es-es.md +++ b/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.es-es.md @@ -1,16 +1,11 @@ --- title: "Diagnosticar fallos de hardware en un servidor dedicado" excerpt: "Cómo utilizar las herramientas de diagnóstico para identificar fallos de hardware en el servidor" -updated: 2025-09-05 +updated: 2025-10-16 --- -> [!primary] -> Esta traducción ha sido generada de forma automática por nuestro partner SYSTRAN. En algunos casos puede contener términos imprecisos, como en las etiquetas de los botones o los detalles técnicos. En caso de duda, le recomendamos que consulte la versión inglesa o francesa de la guía. Si quiere ayudarnos a mejorar esta traducción, por favor, utilice el botón "Contribuir" de esta página. -> - ## Objetivo - En algún momento de la vida de su servidor, puede experimentar una avería debido a un problema de hardware. Cuando el servidor se inicia en modo de rescate de OVHcloud, dispone de varias herramientas de diagnóstico que permiten identificar los componentes de hardware defectuosos. **Esta guía explica cómo diagnosticar fallos de hardware en un servidor dedicado.** @@ -80,13 +75,7 @@ Para comprobar el sistema de archivos, ejecute el siguiente comando: fsck -fy ``` -Para una prueba de reproducción, ejecute el siguiente comando. Sustituya `sd(x)` por sus propios valores. - -```bash -dd if=/dev/zero of=/dev/sd(x) bs=1M count=100 -``` - -Para una prueba de escritura, ejecute el siguiente comando. Sustituya `sd(x)` por sus propios valores +Para una prueba de lectura, ejecute el siguiente comando. Sustituya `sd(x)` por sus propios valores ```bash hdparm -t /dev/sd(x) diff --git a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.es-us.md b/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.es-us.md index dcd792fcc2f..a5badf67b01 100644 --- a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.es-us.md +++ b/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.es-us.md @@ -1,16 +1,11 @@ --- title: "Diagnosticar fallos de hardware en un servidor dedicado" excerpt: "Cómo utilizar las herramientas de diagnóstico para identificar fallos de hardware en el servidor" -updated: 2025-09-05 +updated: 2025-10-16 --- -> [!primary] -> Esta traducción ha sido generada de forma automática por nuestro partner SYSTRAN. En algunos casos puede contener términos imprecisos, como en las etiquetas de los botones o los detalles técnicos. En caso de duda, le recomendamos que consulte la versión inglesa o francesa de la guía. Si quiere ayudarnos a mejorar esta traducción, por favor, utilice el botón "Contribuir" de esta página. -> - ## Objetivo - En algún momento de la vida de su servidor, puede experimentar una avería debido a un problema de hardware. Cuando el servidor se inicia en modo de rescate de OVHcloud, dispone de varias herramientas de diagnóstico que permiten identificar los componentes de hardware defectuosos. **Esta guía explica cómo diagnosticar fallos de hardware en un servidor dedicado.** @@ -80,13 +75,7 @@ Para comprobar el sistema de archivos, ejecute el siguiente comando: fsck -fy ``` -Para una prueba de reproducción, ejecute el siguiente comando. Sustituya `sd(x)` por sus propios valores. - -```bash -dd if=/dev/zero of=/dev/sd(x) bs=1M count=100 -``` - -Para una prueba de escritura, ejecute el siguiente comando. Sustituya `sd(x)` por sus propios valores +Para una prueba de lectura, ejecute el siguiente comando. Sustituya `sd(x)` por sus propios valores ```bash hdparm -t /dev/sd(x) diff --git a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.fr-ca.md b/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.fr-ca.md index 903ed912b54..b731287a4a8 100644 --- a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.fr-ca.md +++ b/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.fr-ca.md @@ -1,7 +1,7 @@ --- title: 'Diagnostiquer des dysfonctionnements matériels sur un serveur dédié' excerpt: 'Découvrez comment utiliser les outils de diagnostic pour identifier des dysfonctionnements matériels sur votre serveur' -updated: 2025-09-05 +updated: 2025-10-16 --- ## Objectif @@ -23,7 +23,7 @@ Ce guide vous détaille les tests à réaliser pour diagnostiquer : - la connexion du réseau ; - la mémoire RAM ; - disques et partitions. - +  ### Processeurs Le test du processeur vérifie le bon fonctionnement du processeur de votre serveur et nécessite environ 30 minutes pour s'exécuter correctement. Si le serveur tombe en panne pendant ce test, cela signifie que le processeur est défectueux. @@ -31,7 +31,7 @@ Le test du processeur vérifie le bon fonctionnement du processeur de votre serv ```bash WRKR=$(grep -c "^processor" /proc/cpuinfo) stress-ng --metrics-brief --timeout 60s --cpu $WRKR --io $WRKR --aggressive --ignite-cpu --maximize --pathological -stress-ng --metrics-brief --timeout 60s --brk 0 --stack 0 --bigheap 0 +stress-ng --metrics-brief --timeout 60s --brk 0 --stack 0 --bigheap 0  ``` ### Connexion au réseau @@ -75,13 +75,7 @@ Pour vérifier le système de fichiers, exécutez la commande suivante : fsck -fy ``` -Pour un test de lecture, exécutez la commande ci-dessous. Remplacez `sd(x)` par vos propres valeurs. - -```bash -dd if=/dev/zero of=/dev/sd(x) bs=1M count=100 -``` - -Pour un test d'écriture, exécutez la commande ci-dessous. Remplacez `sd(x)` par vos propres valeurs +Pour un test de lecture, exécutez la commande ci-dessous. Remplacez `sd(x)` par vos propres valeurs ```bash hdparm -t /dev/sd(x) diff --git a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.fr-fr.md b/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.fr-fr.md index 8e38e9206b1..b731287a4a8 100644 --- a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.fr-fr.md +++ b/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.fr-fr.md @@ -1,7 +1,7 @@ --- title: 'Diagnostiquer des dysfonctionnements matériels sur un serveur dédié' excerpt: 'Découvrez comment utiliser les outils de diagnostic pour identifier des dysfonctionnements matériels sur votre serveur' -updated: 2025-09-05 +updated: 2025-10-16 --- ## Objectif @@ -75,13 +75,7 @@ Pour vérifier le système de fichiers, exécutez la commande suivante : fsck -fy ``` -Pour un test de lecture, exécutez la commande ci-dessous. Remplacez `sd(x)` par vos propres valeurs. - -```bash -dd if=/dev/zero of=/dev/sd(x) bs=1M count=100 -``` - -Pour un test d'écriture, exécutez la commande ci-dessous. Remplacez `sd(x)` par vos propres valeurs +Pour un test de lecture, exécutez la commande ci-dessous. Remplacez `sd(x)` par vos propres valeurs ```bash hdparm -t /dev/sd(x) diff --git a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.it-it.md b/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.it-it.md index fd81c1e3970..4a0a65fb5a4 100644 --- a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.it-it.md +++ b/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.it-it.md @@ -1,13 +1,9 @@ --- title: "Diagnosticare problemi hardware su un server dedicato" excerpt: "Scopri come utilizzare gli strumenti di diagnostica per identificare malfunzionamenti hardware sul tuo server" -updated: 2025-09-05 +updated: 2025-10-16 --- -> [!primary] -> Questa traduzione è stata generata automaticamente dal nostro partner SYSTRAN. I contenuti potrebbero presentare imprecisioni, ad esempio la nomenclatura dei pulsanti o alcuni dettagli tecnici. In caso di dubbi consigliamo di fare riferimento alla versione inglese o francese della guida. Per aiutarci a migliorare questa traduzione, utilizza il pulsante "Contribuisci" di questa pagina. -> - ## Obiettivo A un certo punto della vita del tuo server, potresti riscontrare un guasto a causa di un problema hardware. Quando il server viene avviato in modalità Rescue OVHcloud, sono disponibili diversi strumenti di diagnostica che permettono di identificare i componenti hardware difettosi. @@ -79,13 +75,7 @@ Per verificare il file system, esegui il comando: fsck -fy ``` -Per effettuare un test di lettura, esegui il comando seguente. Sostituisci `sd(x)` con i tuoi valori. - -```bash -dd if=/dev/zero of=/dev/sd(x) bs=1M count=100 -``` - -Per effettuare un test di scrittura, esegui il comando seguente. Sostituisci `sd(x)` con i tuoi valori +Per effettuare un test di lettura, esegui il comando seguente. Sostituisci `sd(x)` con i tuoi valori ```bash hdparm -t /dev/sd(x) diff --git a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.pl-pl.md b/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.pl-pl.md index ea194b74936..1140820a305 100644 --- a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.pl-pl.md +++ b/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.pl-pl.md @@ -1,13 +1,9 @@ --- title: "Diagnostyka usterek sprzętowych serwera dedykowanego" excerpt: "Dowiedz się, jak korzystać z narzędzi diagnostycznych do identyfikacji usterek sprzętowych na Twoim serwerze" -updated: 2025-09-05 +updated: 2025-10-16 --- -> [!primary] -> Tłumaczenie zostało wygenerowane automatycznie przez system naszego partnera SYSTRAN. W niektórych przypadkach mogą wystąpić nieprecyzyjne sformułowania, na przykład w tłumaczeniu nazw przycisków lub szczegółów technicznych. W przypadku jakichkolwiek wątpliwości zalecamy zapoznanie się z angielską/francuską wersją przewodnika. Jeśli chcesz przyczynić się do ulepszenia tłumaczenia, kliknij przycisk "Zgłóś propozycję modyfikacji" na tej stronie. -> - ## Wprowadzenie W pewnym momencie życia Twojego serwera może wystąpić awaria z powodu problemu sprzętowego. Po uruchomieniu serwera w trybie Rescue OVHcloud masz do dyspozycji kilka narzędzi diagnostycznych umożliwiających identyfikację uszkodzonych komponentów. @@ -81,12 +77,6 @@ fsck -fy W celu przeprowadzenia testu odczytu wprowadź poniższą komendę. Zamień `sd(x)` na własne wartości. -```bash -dd if=/dev/zero of=/dev/sd(x) bs=1M count=100 -``` - -Aby wykonać test zapisu, wprowadź poniższą komendę. Zamień `sd(x)` na własne wartości - ```bash hdparm -t /dev/sd(x) ``` diff --git a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.pt-pt.md b/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.pt-pt.md index eadfac9f3dd..b998b7e88eb 100644 --- a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.pt-pt.md +++ b/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/guide.pt-pt.md @@ -1,13 +1,9 @@ --- title: "Diagnosticar avarias materiais num servidor dedicado" excerpt: "Saiba como utilizar as ferramentas de diagnóstico para identificar avarias materiais no seu servidor" -updated: 2025-09-05 +updated: 2025-10-16 --- -> [!primary] -> Esta tradução foi automaticamente gerada pelo nosso parceiro SYSTRAN. Em certos casos, poderão ocorrer formulações imprecisas, como por exemplo nomes de botões ou detalhes técnicos. Recomendamos que consulte a versão inglesa ou francesa do manual, caso tenha alguma dúvida. Se nos quiser ajudar a melhorar esta tradução, clique em "Contribuir" nesta página. -> - ## Sumário A um determinado momento da vida do seu servidor, pode sofrer uma avaria devido a um problema material. Quando o servidor é iniciado através do modo rescue OVHcloud, dispõe de várias ferramentas de diagnóstico que permitem identificar os componentes materiais com defeito. @@ -79,13 +75,7 @@ Para verificar o sistema de arquivos, execute o comando a seguir: fsck -fy ``` -Para efetuar um teste de leitura, execute o comando abaixo. Substitua `sd(x)` pelos seus próprios valores. - -```bash -dd if=/dev/zero of=/dev/sd(x) bs=1M count=100 -``` - -Para efetuar um teste de escrita, execute o comando abaixo. Substitua `sd(x)` pelos seus próprios valores +Para efetuar um teste de leitura, execute o comando abaixo. Substitua `sd(x)` pelos seus próprios valores ```bash hdparm -t /dev/sd(x) diff --git a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/images/memory.png b/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/images/memory.png deleted file mode 100644 index 464cc38bc43..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/images/memory.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/images/network-connection.png b/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/images/network-connection.png deleted file mode 100644 index 592aa7078df..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/images/network-connection.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/images/partitions.png b/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/images/partitions.png deleted file mode 100644 index e9101bc2e51..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/images/partitions.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/images/processors.png b/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/images/processors.png deleted file mode 100644 index e624a8c3a4f..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/images/processors.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/images/rescue-mode-01.png b/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/images/rescue-mode-01.png deleted file mode 100644 index 06d3dfecf5a..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/images/rescue-mode-01.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/images/rescue-mode-01_2020.png b/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/images/rescue-mode-01_2020.png deleted file mode 100644 index df4b438319a..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/images/rescue-mode-01_2020.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/images/rescue-mode-02.png b/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/images/rescue-mode-02.png deleted file mode 100644 index cf85d8a51dc..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/images/rescue-mode-02.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/images/rescue-mode-02_2020.png b/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/images/rescue-mode-02_2020.png deleted file mode 100644 index 86b5d1bc97c..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/images/rescue-mode-02_2020.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/images/rescue-mode-03.png b/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/images/rescue-mode-03.png deleted file mode 100644 index de555531f7c..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/images/rescue-mode-03.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/images/rescue-mode-03_2020.png b/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/images/rescue-mode-03_2020.png deleted file mode 100644 index 3be3b5ab672..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/images/rescue-mode-03_2020.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/images/rescue-mode-04.png b/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/images/rescue-mode-04.png deleted file mode 100644 index 16bcaf1aa26..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/images/rescue-mode-04.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/images/rescue-mode-042.png b/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/images/rescue-mode-042.png deleted file mode 100644 index 1e06b7b124b..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/images/rescue-mode-042.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/meta.yaml b/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/meta.yaml index 7e41a4522cd..13370d82aa9 100755 --- a/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/meta.yaml +++ b/pages/bare_metal_cloud/dedicated_servers/hardware-diagnose/meta.yaml @@ -1,3 +1,4 @@ id: 90291d3b-9aa5-4589-894e-2500fb05dd73 full_slug: dedicated-servers-hardware-diagnostics -reference_category: bare-metal-cloud-dedicated-servers-troubleshooting \ No newline at end of file +reference_category: bare-metal-cloud-dedicated-servers-troubleshooting +translation_banner: true \ No newline at end of file diff --git a/pages/bare_metal_cloud/dedicated_servers/hgrstor2_system_configuration/images/ovh-dashboard-view-01.png b/pages/bare_metal_cloud/dedicated_servers/hgrstor2_system_configuration/images/ovh-dashboard-view-01.png deleted file mode 100644 index 16c879976ad..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/hgrstor2_system_configuration/images/ovh-dashboard-view-01.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/hotswap_raid_soft/images/0display1.png b/pages/bare_metal_cloud/dedicated_servers/hotswap_raid_soft/images/0display1.png deleted file mode 100644 index 81b2a337b04..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/hotswap_raid_soft/images/0display1.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/hotswap_raid_soft/images/0display2.png b/pages/bare_metal_cloud/dedicated_servers/hotswap_raid_soft/images/0display2.png deleted file mode 100644 index 5d3b24bc923..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/hotswap_raid_soft/images/0display2.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/how-to-copy-data-from-one-dedicated-server-to-another-using-rsync/meta.yaml b/pages/bare_metal_cloud/dedicated_servers/how-to-copy-data-from-one-dedicated-server-to-another-using-rsync/meta.yaml index 5bc2b9d88b3..041cb16ed35 100755 --- a/pages/bare_metal_cloud/dedicated_servers/how-to-copy-data-from-one-dedicated-server-to-another-using-rsync/meta.yaml +++ b/pages/bare_metal_cloud/dedicated_servers/how-to-copy-data-from-one-dedicated-server-to-another-using-rsync/meta.yaml @@ -1,3 +1,3 @@ id: e6cf7b71-2779-4ec3-a992-453db76f3a9e full_slug: dedicated-servers-copy-data-server-rsync -reference_category: bare-metal-cloud-dedicated-servers-tutorials \ No newline at end of file +reference_category: bare-metal-cloud-dedicated-servers-migration \ No newline at end of file diff --git a/pages/bare_metal_cloud/dedicated_servers/hyperv-network-HG-Scale/images/create_vswitch_1.png b/pages/bare_metal_cloud/dedicated_servers/hyperv-network-HG-Scale/images/create_vswitch_1.png deleted file mode 100644 index 44e6771841a..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/hyperv-network-HG-Scale/images/create_vswitch_1.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/hyperv-network-HG-Scale/images/create_vswitch_2.png b/pages/bare_metal_cloud/dedicated_servers/hyperv-network-HG-Scale/images/create_vswitch_2.png deleted file mode 100644 index 70e2a0ab05a..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/hyperv-network-HG-Scale/images/create_vswitch_2.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/hyperv-network-HG-Scale/images/create_vswitch_3.png b/pages/bare_metal_cloud/dedicated_servers/hyperv-network-HG-Scale/images/create_vswitch_3.png deleted file mode 100644 index 3cbe7f52d71..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/hyperv-network-HG-Scale/images/create_vswitch_3.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/hyperv-network-HG-Scale/images/install_roles_3.png b/pages/bare_metal_cloud/dedicated_servers/hyperv-network-HG-Scale/images/install_roles_3.png deleted file mode 100644 index fb62199f19a..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/hyperv-network-HG-Scale/images/install_roles_3.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/hyperv-network-HG-Scale/images/nic_teaming_3.png b/pages/bare_metal_cloud/dedicated_servers/hyperv-network-HG-Scale/images/nic_teaming_3.png deleted file mode 100644 index c2b194e2479..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/hyperv-network-HG-Scale/images/nic_teaming_3.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/installing_lamp_debian9_ubuntu18/images/tuto_apache.png b/pages/bare_metal_cloud/dedicated_servers/installing_lamp_debian9_ubuntu18/images/tuto_apache.png deleted file mode 100644 index d2a1babecba..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/installing_lamp_debian9_ubuntu18/images/tuto_apache.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/installing_lamp_debian9_ubuntu18/images/tuto_php.png b/pages/bare_metal_cloud/dedicated_servers/installing_lamp_debian9_ubuntu18/images/tuto_php.png deleted file mode 100644 index 91a9c69835c..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/installing_lamp_debian9_ubuntu18/images/tuto_php.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/installing_lamp_debian9_ubuntu18/images/tuto_pma.png b/pages/bare_metal_cloud/dedicated_servers/installing_lamp_debian9_ubuntu18/images/tuto_pma.png deleted file mode 100644 index 1645d179839..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/installing_lamp_debian9_ubuntu18/images/tuto_pma.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/installing_lamp_debian9_ubuntu18/images/tuto_wp.png b/pages/bare_metal_cloud/dedicated_servers/installing_lamp_debian9_ubuntu18/images/tuto_wp.png deleted file mode 100644 index 44a3bfb89ac..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/installing_lamp_debian9_ubuntu18/images/tuto_wp.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/lacp-resilience-scale-hg/guide.en-gb.md b/pages/bare_metal_cloud/dedicated_servers/lacp-resilience-scale-hg/guide.en-gb.md new file mode 100644 index 00000000000..c0ecf5e184a --- /dev/null +++ b/pages/bare_metal_cloud/dedicated_servers/lacp-resilience-scale-hg/guide.en-gb.md @@ -0,0 +1,56 @@ +--- +title: Improving Network Resilience on Bare Metal servers +excerpt: Discover how to reinforce the resilience of public and private interfaces on your OVHcloud Bare Metal servers with the new network aggregation architecture +updated: 2025-10-28 +--- + +> [!primary] +> +> This document is related to a deployment planned for **November 25, 2025**, which will change the way link aggregation (LACP) functions within OVHcloud infrastructures. +> OVHcloud customers affected by these changes will also receive a communication by e-mail. + +## Objective + +This guide presents the new network aggregation architecture implemented on OVHcloud Bare Metal servers. This evolution aims to strengthen fault tolerance and improve service continuity for your critical environments. + +## Requirements + +- A [dedicated server](/links/bare-metal/bare-metal) with 4 network interfaces (High Grade & SCALE ranges). +- Link aggregation (LACP) configured on its public or private interfaces (excluding OLA). + +## Instructions + +### What's changing + +Until now, the aggregation (LACP) of network interfaces was performed on ports belonging to the **same Network Interface Card (NIC)**. This configuration already ensured redundancy in case of a ToR (Top-of-Rack) switch failure but did not cover the risk of a NIC failure. + +From now on: + +- Logical aggregations will be spread across **two distinct network cards** (with no physical cabling modification). +- Existing aggregations **are not modified**. + +![Before/after resilience comparison](images/resilience_comparison.svg){.thumbnail} + +If you do not use LACP link aggregation on your server, **no action is required** and **no change will be visible for your services**. + +### How to apply the change on your servers + +To activate the new rule, you need to [switch to **OLA** mode](/pages/bare_metal_cloud/dedicated_servers/ola-enable-manager), then revert to the default mode. +Once the new rule is activated, it will no longer be possible to revert to the old configuration. Servers delivered after the deployment date will immediately benefit from this new rule. + +> [!warning] +> If you plan on switching to the new aggregation rule, you will need to update the MAC addresses assigned to each bond in your operating system. +> +> In case of incorrect configuration in the OS, resilience might not be effective. + +### Benefits + +Subject to correct configuration on the OS side, this development provides: + +- **Enhanced Availability**: better tolerance to hardware failures (network cards, switches, connectivity). +- **Uninterrupted Connectivity**: your services remain accessible even in the event of a network card failure. +- **Transparent Evolution**: no modification required for existing aggregations, apart from specific cases mentioned above. + +## Go Further + +Join our [user community](/links/community). diff --git a/pages/bare_metal_cloud/dedicated_servers/lacp-resilience-scale-hg/guide.fr-fr.md b/pages/bare_metal_cloud/dedicated_servers/lacp-resilience-scale-hg/guide.fr-fr.md new file mode 100644 index 00000000000..20e619f5bb0 --- /dev/null +++ b/pages/bare_metal_cloud/dedicated_servers/lacp-resilience-scale-hg/guide.fr-fr.md @@ -0,0 +1,56 @@ +--- +title: Amélioration de la résilience réseau sur les serveurs Bare Metal +excerpt: "Découvrez comment renforcer la résilience des interfaces publiques et privées sur vos serveurs Bare Metal OVHcloud avec la nouvelle architecture d'agrégation réseau" +updated: 2025-10-28 +--- + +> [!primary] +> Ce document concerne un déploiement prévu le **25 novembre 2025**, qui changera la manière dont fonctionne l'aggrégation de liens (LACP) au sein des infrastructures OVHcloud. +> Les clients OVHcloud concernés par ces changements recevront également une communication par e-mail. + +## Objectif + +Ce guide présente la nouvelle architecture d’agrégation réseau mise en place sur les serveurs Bare Metal OVHcloud. Cette évolution a pour but de renforcer la tolérance aux pannes et d’améliorer la continuité de service pour vos environnements critiques. + +## Prérequis + +- Disposer d'un [serveur dédié](/links/bare-metal/bare-metal) possédant 4 interfaces réseau (gammes High Grade et SCALE). +- Avoir configuré l’agrégation de liens (LACP) sur vos interfaces publiques ou privées (hors OLA) + +## En pratique + +### Ce qui change + +Jusqu’à présent, l’agrégation (LACP) des interfaces réseau était réalisée sur des ports appartenant à la **même carte réseau (NIC)**. Cette configuration assurait déjà une redondance en cas de défaillance d’un switch ToR (Top-of-Rack), mais ne couvrait pas le risque de panne d’une carte réseau. + +Désormais : + +- Les agrégations logiques seront réparties sur **deux cartes réseau distinctes** (sans modification physique du câblage). +- Les agrégations existantes **ne sont pas modifiées**. + +![Comparaison de la résilience avant/après](images/resilience_comparison.svg){.thumbnail} + +Si vous n’utilisez pas l’agrégation de liens LACP sur votre serveur, **aucune action n’est requise** et **aucun changement ne sera visible pour vos services**. + +### Comment effectuer le changement sur vos serveurs + +Pour activer la nouvelle règle, vous devez [passer en mode **OLA**](/pages/bare_metal_cloud/dedicated_servers/ola-enable-manager), puis revenir au mode par défaut. + +Une fois la nouvelle règle activée, il ne sera plus possible de revenir à l’ancienne configuration. Les serveurs livrés après la date de déploiement bénéficieront directement de cette nouvelle règle. + +> [!warning] +> Afin que les modifications soient effectives, vous devez **reconfigurer les adresses MAC déclarées** dans votre système d’exploitation. +> +> En cas de configuration incorrecte dans l’OS, la résilience pourrait ne pas être effective. + +### Bénéfices + +Sous réserve d’une configuration correcte côté OS, cette évolution permet : + +- **Une disponibilité renforcée** : meilleure tolérance aux pannes matérielles (cartes réseau, switches, connectique). +- **Une connectivité ininterrompue** : vos services restent accessibles même en cas de défaillance d’une carte réseau. +- **Une évolution transparente** : aucune modification requise pour les agrégations existantes, hors cas spécifiques mentionnés ci-dessus. + +## Aller plus loin + +Rejoignez notre [communauté d'utilisateurs](/links/community). diff --git a/pages/bare_metal_cloud/dedicated_servers/lacp-resilience-scale-hg/images/resilience_comparison.svg b/pages/bare_metal_cloud/dedicated_servers/lacp-resilience-scale-hg/images/resilience_comparison.svg new file mode 100644 index 00000000000..e8715828c9c --- /dev/null +++ b/pages/bare_metal_cloud/dedicated_servers/lacp-resilience-scale-hg/images/resilience_comparison.svg @@ -0,0 +1,279 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/pages/bare_metal_cloud/dedicated_servers/lacp-resilience-scale-hg/meta.yaml b/pages/bare_metal_cloud/dedicated_servers/lacp-resilience-scale-hg/meta.yaml new file mode 100644 index 00000000000..849abefc18a --- /dev/null +++ b/pages/bare_metal_cloud/dedicated_servers/lacp-resilience-scale-hg/meta.yaml @@ -0,0 +1,2 @@ +id: 6ee64c7a-2f1a-4be7-bab0-dbac71a489aa +full_slug: dedicated-servers-improve-network-resilience \ No newline at end of file diff --git a/pages/bare_metal_cloud/dedicated_servers/manage_bandwidth_api/images/bandwidth_04.png b/pages/bare_metal_cloud/dedicated_servers/manage_bandwidth_api/images/bandwidth_04.png deleted file mode 100644 index 4f2c3ae8d6d..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/manage_bandwidth_api/images/bandwidth_04.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/megaraid_config/images/rescue-mode-03.png b/pages/bare_metal_cloud/dedicated_servers/megaraid_config/images/rescue-mode-03.png deleted file mode 100644 index ee4fdb10fda..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/megaraid_config/images/rescue-mode-03.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/megaraid_config/images/rescue_mode_raid0_01.png b/pages/bare_metal_cloud/dedicated_servers/megaraid_config/images/rescue_mode_raid0_01.png deleted file mode 100644 index fa66ba5884b..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/megaraid_config/images/rescue_mode_raid0_01.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/megaraid_config/images/rescue_mode_raid0_01_2020.png b/pages/bare_metal_cloud/dedicated_servers/megaraid_config/images/rescue_mode_raid0_01_2020.png deleted file mode 100644 index a8d9f81b4f4..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/megaraid_config/images/rescue_mode_raid0_01_2020.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/megaraid_config/images/rescue_mode_raid0_02.png b/pages/bare_metal_cloud/dedicated_servers/megaraid_config/images/rescue_mode_raid0_02.png deleted file mode 100644 index 07971b1a59f..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/megaraid_config/images/rescue_mode_raid0_02.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/megaraid_config/images/rescue_mode_raid0_03.png b/pages/bare_metal_cloud/dedicated_servers/megaraid_config/images/rescue_mode_raid0_03.png deleted file mode 100644 index ebbd52c7e1b..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/megaraid_config/images/rescue_mode_raid0_03.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/megaraid_config/images/server_installation_raid0_02.png b/pages/bare_metal_cloud/dedicated_servers/megaraid_config/images/server_installation_raid0_02.png deleted file mode 100644 index dab1cfb6362..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/megaraid_config/images/server_installation_raid0_02.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/megaraid_config/images/server_installation_raid0_03.png b/pages/bare_metal_cloud/dedicated_servers/megaraid_config/images/server_installation_raid0_03.png deleted file mode 100644 index 1e4eabf016f..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/megaraid_config/images/server_installation_raid0_03.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/megaraid_config/images/server_installation_raid0_04.png b/pages/bare_metal_cloud/dedicated_servers/megaraid_config/images/server_installation_raid0_04.png deleted file mode 100644 index 6a1c07b61e1..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/megaraid_config/images/server_installation_raid0_04.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/megaraid_config/images/server_installation_raid0_05.png b/pages/bare_metal_cloud/dedicated_servers/megaraid_config/images/server_installation_raid0_05.png deleted file mode 100644 index 39442d369bb..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/megaraid_config/images/server_installation_raid0_05.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/megaraid_config/images/server_installation_raid0_06.png b/pages/bare_metal_cloud/dedicated_servers/megaraid_config/images/server_installation_raid0_06.png deleted file mode 100644 index 27603c0fb5c..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/megaraid_config/images/server_installation_raid0_06.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/megaraid_config/images/server_installation_raid0_06_2020.png b/pages/bare_metal_cloud/dedicated_servers/megaraid_config/images/server_installation_raid0_06_2020.png deleted file mode 100644 index 28a88a223bf..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/megaraid_config/images/server_installation_raid0_06_2020.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/megaraid_config/images/server_installation_raid0_1.png b/pages/bare_metal_cloud/dedicated_servers/megaraid_config/images/server_installation_raid0_1.png deleted file mode 100644 index c9789034d2c..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/megaraid_config/images/server_installation_raid0_1.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/micron-7500-fw-upgrade/guide.en-gb.md b/pages/bare_metal_cloud/dedicated_servers/micron-7500-fw-upgrade/guide.en-gb.md new file mode 100644 index 00000000000..428c0aca302 --- /dev/null +++ b/pages/bare_metal_cloud/dedicated_servers/micron-7500-fw-upgrade/guide.en-gb.md @@ -0,0 +1,429 @@ +--- +title: Dedicated Servers - Upgrading your Micron 7500 PRO firmware +excerpt: Learn how to upgrade your Micron 7500 PRO firmware for Linux, ESXi and Windows Dedicated Servers +updated: 2025-09-25 +--- + +## Objective + +Routine firmware updates play a pivotal role in upholding your drives, performance, stability, and security. Such updates often encompass critical bug fixes, enhanced compatibility, and advanced security features that are indispensable for preserving your data integrity and maintaining optimal operational efficiency. + +**An important patch has been introduced in this new firmware (version E3MQ005). We strongly recommend updating your firmware to avoid premature failure.** + +> **Firmware Release Notes:** +> +> - Increased compatibility with customer platforms +> - Disable LTR (Latency Tolerance Reporting) support +> - Improved overall product robustness for handling invalid commands and non‑compliant host behavior +> - Improved firmware handling during shutdown and power‑on +> - Improved MCP command handling +> - Improved NVMe‑Mi command processing and handling +> - Improved alignment with OCP 2.0 specification + +## Drive Part Number + +- **MTFDKCC960TGP-1BK1DABYY** (960 GB capacity) +- **MTFDKCC1T9TGP-1BK1DABYY** (1.92 TB capacity) +- **MTFDKCC3T8TGP-1BK1DABYY** (3.84 TB capacity) +- **MTFDKCC7T6TGP-1BK1DABYY** (7.86 TB capacity) +- **MTFDKCC15T3TGP-1BK1DABYY** (15.36 TB capacity) + +**The purpose of this guide is to help you upgrade your Micron 7500 PRO PCIe 4.0 NVMe firmware.** + +## Requirements + +A bare metal server with a Micron 7500 PRO PCIe 4.0 NVMe device, from the following ranges: + +- High Grade +- Scale +- Advance +- Rise (Processor AMD Ryzen R5‑5600X, AMD Ryzen R7‑5800X, AMD Ryzen R7‑3700pro, AMD Epyc 7302, Intel Xeon E5‑2689v4) + +## Instructions + +> [!alert] +> - Before attempting any firmware update, a backup of the data on the drive **must** be made. Use our guide on [Backup Storage](/pages/bare_metal_cloud/dedicated_servers/services_backup_storage) to learn how to back up your data. +> - The firmware update does **not** format the drive or delete data, but a firmware update failure may happen. **Do not power off the drive or the bare metal server during the firmware update process.** + + +> [!primary] +> All commands must be run as **root** for Linux and VMware ESXi, and with an **administrator** account for Windows. + +### Linux + +#### Software configuration tested by OVHcloud + +| Platform | nvme flash tool version | Firmware | Result | +|---------------|-------------------------|----------|--------| +| Debian 13 OS | 2.13‑2 | E3MQ005 | OK | +| Debian 12 OS | 2.4+really2.3‑3 | E3MQ005 | OK | +| Ubuntu 22.04 OS | 1.16‑3ubuntu0.3 | E3MQ005 | OK | +| Ubuntu 24.04 OS | 2.8‑1ubuntu0.1 | E3MQ005 | OK | +| Rocky 9 OS | 2.11‑6.el9_6 | E3MQ005 | OK | +| Rocky 10 OS | 2.11‑6.el10_0 | E3MQ005 | OK | + +#### Step 1 – Install `nvme‑cli` + +```bash +dnf install nvme-cli # RHEL, CentOS, RockyLinux, AlmaLinux, Fedora, etc. +``` + +```bash +apt install nvme-cli # Debian, Ubuntu, Mint, Proxmox, etc. +``` + +#### Step 2 – Check if a firmware update is needed + +The command `nvme list` lists all NVMe devices on your server: + +```bash +nvme list | grep -E 'Node|MTFDKCC960TGP-1BK1DABYY|MTFDKCC1T9TGP-1BK1DABYY|MTFDKCC3T8TGP-1BK1DABYY|MTFDKCC7T6TGP-1BK1DABYY|MTFDKCC15T3TGP-1BK1DABYY' +``` + +> [!primary] +> We added a filter on this command to only display Micron 7500 PRO NVMe devices, because the firmware update only concerns these NVMe models and your server may have other disks connected to it. + +> [!primary] +> If the column **FW Rev** for all your Micron 7500 PRO devices is already **E3MQ005**, your firmware is up‑to‑date and you do not need to continue. Otherwise, proceed with step 3. + +##### Example result (2 drives to update) + +```text +Node Generic SN Model Namespace Usage Format FW Rev +/dev/nvme0n1 /dev/ng0n1 032510B842C5 MTFDKCC1T9TGP-1BK1DABYY 0x1 8.19 kB / 1.92 TB 512 B + 0 B E3MQ001 +/dev/nvme1n1 /dev/ng1n1 132510B824CD MTFDKCC1T9TGP-1BK1DABYY 0x1 8.19 kB / 1.92 TB 512 B + 0 B E3MQ001 +``` + +#### Step 3 – Firmware update + +Download the firmware binary on your server: + +```bash +wget https://last-public-ovh-baremetal.snap.mirrors.ovh.net/hardware/7500_PRO/Micron_7500_E3MQ005_release.ubi +``` + +Execute the following command for each NVMe identified in step 2: +(Replace `X` with the device node.) + +```bash +nvme fw-download --fw Micron_7500_E3MQ005_release.ubi /dev/nvmeX +nvme fw-commit /dev/nvmeX -s 2 -a 3 +``` + +**NVMe firmware update example** + +```text +root@labo:/home/debian# nvme fw-download --fw Micron_7500_E3MQ005_release.ubi /dev/nvme0 +Firmware download success +root@labo:/home/debian# nvme fw-commit /dev/nvme0 -s 2 -a 3 +Success committing firmware action:3 slot:2 +Multiple Update Detected (MUD) Value: 0 +root@labo:/home/debian# nvme fw-download --fw Micron_7500_E3MQ005_release.ubi /dev/nvme1 +Firmware download success +root@labo:/home/debian# nvme fw-commit /dev/nvme1 -s 2 -a 3 +Success committing firmware action:3 slot:2 +Multiple Update Detected (MUD) Value: 0 +``` + +> [!primary] +> Once the command line is launched, a confirmation is requested before starting the flash. Confirm with `Y`. + +#### Step 4 – Verify firmware version after server reboot + +You can use the same command as in step 2: + +```bash +nvme list | grep -E 'Node|MTFDKCC960TGP-1BK1DABYY|MTFDKCC1T9TGP-1BK1DABYY|MTFDKCC3T8TGP-1BK1DABYY|MTFDKCC7T6TGP-1BK1DABYY|MTFDKCC15T3TGP-1BK1DABYY' +``` + +Expected output: + +```text +Node Generic SN Model Namespace Usage Format FW Rev +/dev/nvme0n1 /dev/ng0n1 032510B842C5 MTFDKCC1T9TGP-1BK1DABYY 0x1 8.19 kB / 1.92 TB 512 B + 0 B E3MQ005 +/dev/nvme1n1 /dev/ng1n1 132510B824CD MTFDKCC1T9TGP-1BK1DABYY 0x1 8.19 kB / 1.92 TB 512 B + 0 B E3MQ005 +``` + +Now your NVMe drives should have have the firmware version **E3MQ005**. + +### ESXi + +#### Software configuration tested by OVHcloud + +| Platform | Flash tool | Firmware | Result | +|-------------------|------------|----------|--------| +| ESXi 8.0.3 OS | esxcli 8.0.3 | E3MQ005 | OK | +| ESXi 9.0.0 OS | esxcli 9.0.0 | E3MQ005 | OK | + +#### Step 1 – List NVMe drives and check if a firmware update is needed + +The command `esxcli nvme controller list` lists all NVMe devices on your server: + +```bash +esxcli nvme adapter list | grep -oE '^vmhba\S' \ + | xargs -I% sh -c "esxcli nvme device get -A % \ + | grep -qE 'MTFDKCC960TGP-1BK1DABYY|MTFDKCC1T9TGP-1BK1DABYY|MTFDKCC3T8TGP-1BK1DABYY|MTFDKCC7T6TGP-1BK1DABYY|MTFDKCC15T3TGP-1BK1DABYY' && echo %" \ + | xargs -I% sh -c "echo %:; esxcli nvme device get -A % \ + | grep -E 'Model Number:|Firmware Revision:'" +``` + +> [!primary] +> We added a filter on this command to only display Micron 7500 PRO NVMe devices, because the firmware update only concerns these NVMe models and your server may have other disks connected to it. + +> [!primary] +> If the column "Firmware Revision" for all your NVMe Micron 7500 PRO devices is already version E3MQ005, your firmware is up-to-date and you do not need to continue this process. +> On the other hand, if at least one firmware is different from version E3MQ005, you must proceed with step 2. + +##### Example result (2 drives to update) + +```bash +[root@labo:~] esxcli nvme adapter list | grep -oE '^vmhba\S' | xargs -I% sh -c "esxcli nvme device get -A % | grep -qE 'MTFDKCC960TGP-1BK1DABYY|MTFDKCC1T9TGP-1BK1DABYY|MTFDKCC3T8TGP-1BK1DABYY|MTFDKCC7T6TG +``` + +```text +vmhba4: + Model Number: MTFDKCC1T9TGP-1BK1DABYY + Firmware Revision: E3MQ001 +vmhba5: + Model Number: MTFDKCC1T9TGP-1BK1DABYY + Firmware Revision: E3MQ001 +``` + +#### Step 2 – Firmware update + +Download the firmware binary on your server: + +```bash +wget https://last-public-ovh-baremetal.snap.mirrors.ovh.net/hardware/7500_PRO/Micron_7500_E3MQ005_release.ubi --no-check-certificate +``` + +> [!primary] +> By default, ESXi’s firewall blocks outbound HTTPS traffic. If the download fails, add a firewall rule to allow outbound HTTPS connections. + +Execute the following command for each NVMe identified in step 1: +(Replace `X` with the adapter index.) + +```bash +esxcli nvme device firmware download -A vmhbaX -f /[path-to-firmware]/Micron_7500_E3MQ005_release.ubi +esxcli nvme device firmware activate -a 3 -A vmhbaX -s 2 +``` + +##### NVMe firmware update example + +In our previous example, both NVMe drives need a firmware update to the latest version ****. Here are example commands for how to update the 2 NVMe drives and their output: + +```bash +[root@labo:~] esxcli nvme device firmware download -A vmhba6 -f /Micron_7500_E3MQ005_release.ubi +Download firmware successfully. +[root@labo:~] esxcli nvme device firmware activate -a 3 -A vmhba6 -s 2 +Commit firmware successfully. +[root@labo:~] esxcli nvme device firmware download -A vmhba7 -f /Micron_7500_E3MQ005_release.ubi +Download firmware successfully. +[root@labo:~] esxcli nvme device firmware activate -a 3 -A vmhba7 -s 2 +Commit firmware successfully. +``` + +At this point the firmware update is complete. Reboot the server to finish the process. + +#### Step 3 – Verify firmware version after reboot + +You can use the same nvme list command as in step 1: + +```bash +esxcli nvme adapter list | grep -oE '^vmhba\S' \ + | xargs -I% sh -c "esxcli nvme device get -A % \ + | grep -qE 'MTFDKCC960TGP-1BK1DABYY|MTFDKCC1T9TGP-1BK1DABYY|MTFDKCC3T8TGP-1BK1DABYY|MTFDKCC7T6TGP-1BK1DABYY|MTFDKCC15T3TGP-1BK1DABYY' && echo %" \ + | xargs -I% sh -c "echo %:; esxcli nvme device get -A % \ + | grep -E 'Model Number:|Firmware Revision:'" +``` + +Expected output: + +```text +vmhba4: + Model Number: MTFDKCC1T9TGP-1BK1DABYY + Firmware Revision: E3MQ005 +vmhba5: + Model Number: MTFDKCC1T9TGP-1BK1DABYY + Firmware Revision: E3MQ005 +``` + +Now your NVMe drives should have have the firmware version **E3MQ005**. + + +### Windows + +#### Software configuration tested by OVHcloud + +| Platform | Flash tool | Firmware | Result | +|-----------------|-----------------|----------|--------| +| Windows 2019 OS | msecli 08.11.25 | E3MQ005 | OK | +| Windows 2022 OS | msecli 08.11.25 | E3MQ005 | OK | +| Windows 2025 OS | msecli 08.11.25 | E3MQ005 | OK | + +#### Step 1 – Download `msecli` + +Download the `msecli` executable: + + +Install the software with the default options. + +#### Step 2 – List NVMe drive + +Open Windows PowerShell as Administrator, then run the following command to list NVMe devices: + +```bash +msecli -L | sls "MTFDKCC960TGP-1BK1DABYY","MTFDKCC1T9TGP-1BK1DABYY","MTFDKCC3T8TGP-1BK1DABYY","MTFDKCC7T6TGP-1BK1DABYY","MTFDKCC15T3TGP-1BK1DABYY" -Context 0,11 +``` + +> [!primary] +> We added a filter on this command to only display the Micron 7500 PRO NVMe, because the firmware update only concerns these NVMe references and your server may have other disks connected to it. + +> [!primary] +> If the line **FW‑Rev** for all your NVMe Micron 7500 PRO devices already displays version **E3MQ005**, your firmware is up‑to‑date and you do not need to continue this process. +> On the other hand, if at least one firmware is different from version **E3MQ005**, you must proceed with step 3. + +##### Example result on a server with 2 NVMe drives to update + +```bash +PS C:\Windows\system32> msecli -L | sls "MTFDKCC960TGP-1BK1DABYY","MTFDKCC1T9TGP-1BK1DABYY","MTFDKCC3T8TGP-1BK1DABYY","MTFDKCC7T6TGP-1BK1DABYY","MTFDKCC15T3TGP-1BK1DABYY" -Context 0,11 +``` + +Expected output: + +```text +> Model No : MTFDKCC1T9TGP-1BK1DABYY + Serial No : 082510AA535D + FW-Rev : E3MQ001 + Drive Density : 1920.00GB + Total Size : 1920.00GB + Drive Status : Drive is in good health + PCI Path (B:D.F) : 1D:00.0 + Vendor : Micron + ZNS Supported : No + PCIe Link Speed : 16.0 GT/s + Device Path : + OS Device : Drive0 +> Model No : MTFDKCC1T9TGP-1BK1DABYY + Serial No : 082510AA5337 + FW-Rev : E3MQ001 + Drive Density : 1920.00GB + Total Size : 1920.00GB + Drive Status : Drive is in good health + PCI Path (B:D.F) : 20:00.0 + Vendor : Micron + ZNS Supported : No + PCIe Link Speed : 16.0 GT/s + Device Path : + OS Device : Drive1 +``` + +#### Step 3 – Firmware update + +Download the firmware binary on your server: + +```bash +Invoke-WebRequest "https://last-public-ovh-baremetal.snap.mirrors.ovh.net/hardware/7500_PRO/Micron_7500_E3MQ005_release.ubi" -OutFile "Micron_7500_E3MQ005_release.ubi" +``` + +Execute the following command for each identified NVMe in step 2. +(Replace `X` with the "OS Device" index listed in step 2.) + +```bash +msecli -F -U Micron_7500_E3MQ005_release.ubi -n DriveX -S 2 +``` + +> [!primary] +> Once the command is launched, a confirmation is requested before starting the flash. Confirm with `Y`. + +##### NVMe firmware update example + +In our previous example, both NVMe drives need a firmware update to the latest version **E3MQ005**. Here are example commands for how to update the 2 NVMe drives and their output: + +```bash +PS C:\Windows\system32> msecli -F -U Micron_7500_E3MQ005_release.ubi -n Drive0 -S 2 +``` + +```text +Trying to update current firmware for mtinvme082510AA535D. +Are you sure you want to continue(Y|N):Y + +Firmware update for mtinvme082510AA535D will take a few minutes to complete. +Please wait +.... +Device Name : mtinvme082510aa535d +Firmware update operation completed successfully. + +CMD_STATUS : Success +STATUS_CODE : 0 +TIME_STAMP : Tue Sep 23 02:29:10 2025 + +Copyright (C) 2025 Micron Technology, Inc. +PS C:\Windows\system32> msecli -F -U Micron_7500_E3MQ005_release.ubi -n Drive1 -S 2 + +Trying to update current firmware for mtinvme082510AA5337. +Are you sure you want to continue(Y|N):Y + +Firmware update for mtinvme082510AA5337 will take a few minutes to complete. +Please wait +.... +Device Name : mtinvme082510AA5337 +Firmware update operation completed successfully. + +CMD_STATUS : Success +STATUS_CODE : 0 +TIME_STAMP : Tue Sep 23 02:29:10 2025 + +Copyright (C) 2025 Micron Technology, Inc. +``` + +At this point the firmware update is complete. Reboot the server to finish the process. + +#### Step 4 – Verify firmware version after server reboot + +You can use the same command as in step 2: + +```bash +msecli -L | sls "MTFDKCC960TGP-1BK1DABYY","MTFDKCC1T9TGP-1BK1DABYY","MTFDKCC3T8TGP-1BK1DABYY","MTFDKCC7T6TGP-1BK1DABYY","MTFDKCC15T3TGP-1BK1DABYY" -0,11 +``` + +##### Example output after the update + +```bash +PS C:\Windows\system32> msecli -L | sls "MTFDKCC960TGP-1BK1DABYY","MTFDKCC1T9TGP-1BK1DABYY","MTFDKCC3T8TGP-1BK1DABYY","MTFDKCC7T6TGP-1BK1DABYY","MTFDKCC15T3TGP-1BK1DABYY" -Context 0,11 +``` + +```text +> Model No : MTFDKCC1T9TGP-1BK1DABYY + Serial No : 082510AA535D + FW-Rev : E3MQ005 + Drive Density : 1920.00GB + Total Size : 1920.00GB + Drive Status : Drive is in good health + PCI Path (B:D.F) : 1D:00.0 + Vendor : Micron + ZNS Supported : No + PCIe Link Speed : 16.0 GT/s + Device Path : + OS Device : Drive2 +> Model No : MTFDKCC1T9TGP-1BK1DABYY + Serial No : 082510AA5337 + FW-Rev : E3MQ005 + Drive Density : 1920.00GB + Total Size : 1920.00GB + Drive Status : Drive is in good health + PCI Path (B:D.F) : 20:00.0 + Vendor : Micron + ZNS Supported : No + PCIe Link Speed : 16.0 GT/s + Device Path : + OS Device : Drive3 +``` + +Now your NVMe drives should have have the firmware version **E3MQ005**. + +## Go further + +If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. + +Join our [community of users](/links/community). diff --git a/pages/bare_metal_cloud/dedicated_servers/micron-7500-fw-upgrade/guide.fr-fr.md b/pages/bare_metal_cloud/dedicated_servers/micron-7500-fw-upgrade/guide.fr-fr.md new file mode 100644 index 00000000000..e4b4d944e61 --- /dev/null +++ b/pages/bare_metal_cloud/dedicated_servers/micron-7500-fw-upgrade/guide.fr-fr.md @@ -0,0 +1,429 @@ +--- +title: Serveurs Dédiés - Mise à jour du firmware de votre Micron 7500 PRO (EN) +excerpt: Learn how to upgrade your Micron 7500 PRO firmware for Linux, ESXi and Windows Dedicated Servers +updated: 2025-09-25 +--- + +## Objective + +Routine firmware updates play a pivotal role in upholding your drives, performance, stability, and security. Such updates often encompass critical bug fixes, enhanced compatibility, and advanced security features that are indispensable for preserving your data integrity and maintaining optimal operational efficiency. + +**An important patch has been introduced in this new firmware (version E3MQ005). We strongly recommend updating your firmware to avoid premature failure.** + +> **Firmware Release Notes:** +> +> - Increased compatibility with customer platforms +> - Disable LTR (Latency Tolerance Reporting) support +> - Improved overall product robustness for handling invalid commands and non‑compliant host behavior +> - Improved firmware handling during shutdown and power‑on +> - Improved MCP command handling +> - Improved NVMe‑Mi command processing and handling +> - Improved alignment with OCP 2.0 specification + +## Drive Part Number + +- **MTFDKCC960TGP-1BK1DABYY** (960 GB capacity) +- **MTFDKCC1T9TGP-1BK1DABYY** (1.92 TB capacity) +- **MTFDKCC3T8TGP-1BK1DABYY** (3.84 TB capacity) +- **MTFDKCC7T6TGP-1BK1DABYY** (7.86 TB capacity) +- **MTFDKCC15T3TGP-1BK1DABYY** (15.36 TB capacity) + +**The purpose of this guide is to help you upgrade your Micron 7500 PRO PCIe 4.0 NVMe firmware.** + +## Requirements + +A bare metal server with a Micron 7500 PRO PCIe 4.0 NVMe device, from the following ranges: + +- High Grade +- Scale +- Advance +- Rise (Processor AMD Ryzen R5‑5600X, AMD Ryzen R7‑5800X, AMD Ryzen R7‑3700pro, AMD Epyc 7302, Intel Xeon E5‑2689v4) + +## Instructions + +> [!alert] +> - Before attempting any firmware update, a backup of the data on the drive **must** be made. Use our guide on [Backup Storage](/pages/bare_metal_cloud/dedicated_servers/services_backup_storage) to learn how to back up your data. +> - The firmware update does **not** format the drive or delete data, but a firmware update failure may happen. **Do not power off the drive or the bare metal server during the firmware update process.** + + +> [!primary] +> All commands must be run as **root** for Linux and VMware ESXi, and with an **administrator** account for Windows. + +### Linux + +#### Software configuration tested by OVHcloud + +| Platform | nvme flash tool version | Firmware | Result | +|---------------|-------------------------|----------|--------| +| Debian 13 OS | 2.13‑2 | E3MQ005 | OK | +| Debian 12 OS | 2.4+really2.3‑3 | E3MQ005 | OK | +| Ubuntu 22.04 OS | 1.16‑3ubuntu0.3 | E3MQ005 | OK | +| Ubuntu 24.04 OS | 2.8‑1ubuntu0.1 | E3MQ005 | OK | +| Rocky 9 OS | 2.11‑6.el9_6 | E3MQ005 | OK | +| Rocky 10 OS | 2.11‑6.el10_0 | E3MQ005 | OK | + +#### Step 1 – Install `nvme‑cli` + +```bash +dnf install nvme-cli # RHEL, CentOS, RockyLinux, AlmaLinux, Fedora, etc. +``` + +```bash +apt install nvme-cli # Debian, Ubuntu, Mint, Proxmox, etc. +``` + +#### Step 2 – Check if a firmware update is needed + +The command `nvme list` lists all NVMe devices on your server: + +```bash +nvme list | grep -E 'Node|MTFDKCC960TGP-1BK1DABYY|MTFDKCC1T9TGP-1BK1DABYY|MTFDKCC3T8TGP-1BK1DABYY|MTFDKCC7T6TGP-1BK1DABYY|MTFDKCC15T3TGP-1BK1DABYY' +``` + +> [!primary] +> We added a filter on this command to only display Micron 7500 PRO NVMe devices, because the firmware update only concerns these NVMe models and your server may have other disks connected to it. + +> [!primary] +> If the column **FW Rev** for all your Micron 7500 PRO devices is already **E3MQ005**, your firmware is up‑to‑date and you do not need to continue. Otherwise, proceed with step 3. + +##### Example result (2 drives to update) + +```text +Node Generic SN Model Namespace Usage Format FW Rev +/dev/nvme0n1 /dev/ng0n1 032510B842C5 MTFDKCC1T9TGP-1BK1DABYY 0x1 8.19 kB / 1.92 TB 512 B + 0 B E3MQ001 +/dev/nvme1n1 /dev/ng1n1 132510B824CD MTFDKCC1T9TGP-1BK1DABYY 0x1 8.19 kB / 1.92 TB 512 B + 0 B E3MQ001 +``` + +#### Step 3 – Firmware update + +Download the firmware binary on your server: + +```bash +wget https://last-public-ovh-baremetal.snap.mirrors.ovh.net/hardware/7500_PRO/Micron_7500_E3MQ005_release.ubi +``` + +Execute the following command for each NVMe identified in step 2: +(Replace `X` with the device node.) + +```bash +nvme fw-download --fw Micron_7500_E3MQ005_release.ubi /dev/nvmeX +nvme fw-commit /dev/nvmeX -s 2 -a 3 +``` + +**NVMe firmware update example** + +```text +root@labo:/home/debian# nvme fw-download --fw Micron_7500_E3MQ005_release.ubi /dev/nvme0 +Firmware download success +root@labo:/home/debian# nvme fw-commit /dev/nvme0 -s 2 -a 3 +Success committing firmware action:3 slot:2 +Multiple Update Detected (MUD) Value: 0 +root@labo:/home/debian# nvme fw-download --fw Micron_7500_E3MQ005_release.ubi /dev/nvme1 +Firmware download success +root@labo:/home/debian# nvme fw-commit /dev/nvme1 -s 2 -a 3 +Success committing firmware action:3 slot:2 +Multiple Update Detected (MUD) Value: 0 +``` + +> [!primary] +> Once the command line is launched, a confirmation is requested before starting the flash. Confirm with `Y`. + +#### Step 4 – Verify firmware version after server reboot + +You can use the same command as in step 2: + +```bash +nvme list | grep -E 'Node|MTFDKCC960TGP-1BK1DABYY|MTFDKCC1T9TGP-1BK1DABYY|MTFDKCC3T8TGP-1BK1DABYY|MTFDKCC7T6TGP-1BK1DABYY|MTFDKCC15T3TGP-1BK1DABYY' +``` + +Expected output: + +```text +Node Generic SN Model Namespace Usage Format FW Rev +/dev/nvme0n1 /dev/ng0n1 032510B842C5 MTFDKCC1T9TGP-1BK1DABYY 0x1 8.19 kB / 1.92 TB 512 B + 0 B E3MQ005 +/dev/nvme1n1 /dev/ng1n1 132510B824CD MTFDKCC1T9TGP-1BK1DABYY 0x1 8.19 kB / 1.92 TB 512 B + 0 B E3MQ005 +``` + +Now your NVMe drives should have have the firmware version **E3MQ005**. + +### ESXi + +#### Software configuration tested by OVHcloud + +| Platform | Flash tool | Firmware | Result | +|-------------------|------------|----------|--------| +| ESXi 8.0.3 OS | esxcli 8.0.3 | E3MQ005 | OK | +| ESXi 9.0.0 OS | esxcli 9.0.0 | E3MQ005 | OK | + +#### Step 1 – List NVMe drives and check if a firmware update is needed + +The command `esxcli nvme controller list` lists all NVMe devices on your server: + +```bash +esxcli nvme adapter list | grep -oE '^vmhba\S' \ + | xargs -I% sh -c "esxcli nvme device get -A % \ + | grep -qE 'MTFDKCC960TGP-1BK1DABYY|MTFDKCC1T9TGP-1BK1DABYY|MTFDKCC3T8TGP-1BK1DABYY|MTFDKCC7T6TGP-1BK1DABYY|MTFDKCC15T3TGP-1BK1DABYY' && echo %" \ + | xargs -I% sh -c "echo %:; esxcli nvme device get -A % \ + | grep -E 'Model Number:|Firmware Revision:'" +``` + +> [!primary] +> We added a filter on this command to only display Micron 7500 PRO NVMe devices, because the firmware update only concerns these NVMe models and your server may have other disks connected to it. + +> [!primary] +> If the column "Firmware Revision" for all your NVMe Micron 7500 PRO devices is already version E3MQ005, your firmware is up-to-date and you do not need to continue this process. +> On the other hand, if at least one firmware is different from version E3MQ005, you must proceed with step 2. + +##### Example result (2 drives to update) + +```bash +[root@labo:~] esxcli nvme adapter list | grep -oE '^vmhba\S' | xargs -I% sh -c "esxcli nvme device get -A % | grep -qE 'MTFDKCC960TGP-1BK1DABYY|MTFDKCC1T9TGP-1BK1DABYY|MTFDKCC3T8TGP-1BK1DABYY|MTFDKCC7T6TG +``` + +```text +vmhba4: + Model Number: MTFDKCC1T9TGP-1BK1DABYY + Firmware Revision: E3MQ001 +vmhba5: + Model Number: MTFDKCC1T9TGP-1BK1DABYY + Firmware Revision: E3MQ001 +``` + +#### Step 2 – Firmware update + +Download the firmware binary on your server: + +```bash +wget https://last-public-ovh-baremetal.snap.mirrors.ovh.net/hardware/7500_PRO/Micron_7500_E3MQ005_release.ubi --no-check-certificate +``` + +> [!primary] +> By default, ESXi’s firewall blocks outbound HTTPS traffic. If the download fails, add a firewall rule to allow outbound HTTPS connections. + +Execute the following command for each NVMe identified in step 1: +(Replace `X` with the adapter index.) + +```bash +esxcli nvme device firmware download -A vmhbaX -f /[path-to-firmware]/Micron_7500_E3MQ005_release.ubi +esxcli nvme device firmware activate -a 3 -A vmhbaX -s 2 +``` + +##### NVMe firmware update example + +In our previous example, both NVMe drives need a firmware update to the latest version ****. Here are example commands for how to update the 2 NVMe drives and their output: + +```bash +[root@labo:~] esxcli nvme device firmware download -A vmhba6 -f /Micron_7500_E3MQ005_release.ubi +Download firmware successfully. +[root@labo:~] esxcli nvme device firmware activate -a 3 -A vmhba6 -s 2 +Commit firmware successfully. +[root@labo:~] esxcli nvme device firmware download -A vmhba7 -f /Micron_7500_E3MQ005_release.ubi +Download firmware successfully. +[root@labo:~] esxcli nvme device firmware activate -a 3 -A vmhba7 -s 2 +Commit firmware successfully. +``` + +At this point the firmware update is complete. Reboot the server to finish the process. + +#### Step 3 – Verify firmware version after reboot + +You can use the same nvme list command as in step 1: + +```bash +esxcli nvme adapter list | grep -oE '^vmhba\S' \ + | xargs -I% sh -c "esxcli nvme device get -A % \ + | grep -qE 'MTFDKCC960TGP-1BK1DABYY|MTFDKCC1T9TGP-1BK1DABYY|MTFDKCC3T8TGP-1BK1DABYY|MTFDKCC7T6TGP-1BK1DABYY|MTFDKCC15T3TGP-1BK1DABYY' && echo %" \ + | xargs -I% sh -c "echo %:; esxcli nvme device get -A % \ + | grep -E 'Model Number:|Firmware Revision:'" +``` + +Expected output: + +```text +vmhba4: + Model Number: MTFDKCC1T9TGP-1BK1DABYY + Firmware Revision: E3MQ005 +vmhba5: + Model Number: MTFDKCC1T9TGP-1BK1DABYY + Firmware Revision: E3MQ005 +``` + +Now your NVMe drives should have have the firmware version **E3MQ005**. + + +### Windows + +#### Software configuration tested by OVHcloud + +| Platform | Flash tool | Firmware | Result | +|-----------------|-----------------|----------|--------| +| Windows 2019 OS | msecli 08.11.25 | E3MQ005 | OK | +| Windows 2022 OS | msecli 08.11.25 | E3MQ005 | OK | +| Windows 2025 OS | msecli 08.11.25 | E3MQ005 | OK | + +#### Step 1 – Download `msecli` + +Download the `msecli` executable: + + +Install the software with the default options. + +#### Step 2 – List NVMe drive + +Open Windows PowerShell as Administrator, then run the following command to list NVMe devices: + +```bash +msecli -L | sls "MTFDKCC960TGP-1BK1DABYY","MTFDKCC1T9TGP-1BK1DABYY","MTFDKCC3T8TGP-1BK1DABYY","MTFDKCC7T6TGP-1BK1DABYY","MTFDKCC15T3TGP-1BK1DABYY" -Context 0,11 +``` + +> [!primary] +> We added a filter on this command to only display the Micron 7500 PRO NVMe, because the firmware update only concerns these NVMe references and your server may have other disks connected to it. + +> [!primary] +> If the line **FW‑Rev** for all your NVMe Micron 7500 PRO devices already displays version **E3MQ005**, your firmware is up‑to‑date and you do not need to continue this process. +> On the other hand, if at least one firmware is different from version **E3MQ005**, you must proceed with step 3. + +##### Example result on a server with 2 NVMe drives to update + +```bash +PS C:\Windows\system32> msecli -L | sls "MTFDKCC960TGP-1BK1DABYY","MTFDKCC1T9TGP-1BK1DABYY","MTFDKCC3T8TGP-1BK1DABYY","MTFDKCC7T6TGP-1BK1DABYY","MTFDKCC15T3TGP-1BK1DABYY" -Context 0,11 +``` + +Expected output: + +```text +> Model No : MTFDKCC1T9TGP-1BK1DABYY + Serial No : 082510AA535D + FW-Rev : E3MQ001 + Drive Density : 1920.00GB + Total Size : 1920.00GB + Drive Status : Drive is in good health + PCI Path (B:D.F) : 1D:00.0 + Vendor : Micron + ZNS Supported : No + PCIe Link Speed : 16.0 GT/s + Device Path : + OS Device : Drive0 +> Model No : MTFDKCC1T9TGP-1BK1DABYY + Serial No : 082510AA5337 + FW-Rev : E3MQ001 + Drive Density : 1920.00GB + Total Size : 1920.00GB + Drive Status : Drive is in good health + PCI Path (B:D.F) : 20:00.0 + Vendor : Micron + ZNS Supported : No + PCIe Link Speed : 16.0 GT/s + Device Path : + OS Device : Drive1 +``` + +#### Step 3 – Firmware update + +Download the firmware binary on your server: + +```bash +Invoke-WebRequest "https://last-public-ovh-baremetal.snap.mirrors.ovh.net/hardware/7500_PRO/Micron_7500_E3MQ005_release.ubi" -OutFile "Micron_7500_E3MQ005_release.ubi" +``` + +Execute the following command for each identified NVMe in step 2. +(Replace `X` with the "OS Device" index listed in step 2.) + +```bash +msecli -F -U Micron_7500_E3MQ005_release.ubi -n DriveX -S 2 +``` + +> [!primary] +> Once the command is launched, a confirmation is requested before starting the flash. Confirm with `Y`. + +##### NVMe firmware update example + +In our previous example, both NVMe drives need a firmware update to the latest version **E3MQ005**. Here are example commands for how to update the 2 NVMe drives and their output: + +```bash +PS C:\Windows\system32> msecli -F -U Micron_7500_E3MQ005_release.ubi -n Drive0 -S 2 +``` + +```text +Trying to update current firmware for mtinvme082510AA535D. +Are you sure you want to continue(Y|N):Y + +Firmware update for mtinvme082510AA535D will take a few minutes to complete. +Please wait +.... +Device Name : mtinvme082510aa535d +Firmware update operation completed successfully. + +CMD_STATUS : Success +STATUS_CODE : 0 +TIME_STAMP : Tue Sep 23 02:29:10 2025 + +Copyright (C) 2025 Micron Technology, Inc. +PS C:\Windows\system32> msecli -F -U Micron_7500_E3MQ005_release.ubi -n Drive1 -S 2 + +Trying to update current firmware for mtinvme082510AA5337. +Are you sure you want to continue(Y|N):Y + +Firmware update for mtinvme082510AA5337 will take a few minutes to complete. +Please wait +.... +Device Name : mtinvme082510AA5337 +Firmware update operation completed successfully. + +CMD_STATUS : Success +STATUS_CODE : 0 +TIME_STAMP : Tue Sep 23 02:29:10 2025 + +Copyright (C) 2025 Micron Technology, Inc. +``` + +At this point the firmware update is complete. Reboot the server to finish the process. + +#### Step 4 – Verify firmware version after server reboot + +You can use the same command as in step 2: + +```bash +msecli -L | sls "MTFDKCC960TGP-1BK1DABYY","MTFDKCC1T9TGP-1BK1DABYY","MTFDKCC3T8TGP-1BK1DABYY","MTFDKCC7T6TGP-1BK1DABYY","MTFDKCC15T3TGP-1BK1DABYY" -0,11 +``` + +##### Example output after the update + +```bash +PS C:\Windows\system32> msecli -L | sls "MTFDKCC960TGP-1BK1DABYY","MTFDKCC1T9TGP-1BK1DABYY","MTFDKCC3T8TGP-1BK1DABYY","MTFDKCC7T6TGP-1BK1DABYY","MTFDKCC15T3TGP-1BK1DABYY" -Context 0,11 +``` + +```text +> Model No : MTFDKCC1T9TGP-1BK1DABYY + Serial No : 082510AA535D + FW-Rev : E3MQ005 + Drive Density : 1920.00GB + Total Size : 1920.00GB + Drive Status : Drive is in good health + PCI Path (B:D.F) : 1D:00.0 + Vendor : Micron + ZNS Supported : No + PCIe Link Speed : 16.0 GT/s + Device Path : + OS Device : Drive2 +> Model No : MTFDKCC1T9TGP-1BK1DABYY + Serial No : 082510AA5337 + FW-Rev : E3MQ005 + Drive Density : 1920.00GB + Total Size : 1920.00GB + Drive Status : Drive is in good health + PCI Path (B:D.F) : 20:00.0 + Vendor : Micron + ZNS Supported : No + PCIe Link Speed : 16.0 GT/s + Device Path : + OS Device : Drive3 +``` + +Now your NVMe drives should have have the firmware version **E3MQ005**. + +## Go further + +If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. + +Join our [community of users](/links/community). diff --git a/pages/bare_metal_cloud/dedicated_servers/micron-7500-fw-upgrade/meta.yaml b/pages/bare_metal_cloud/dedicated_servers/micron-7500-fw-upgrade/meta.yaml new file mode 100644 index 00000000000..ed08d27203a --- /dev/null +++ b/pages/bare_metal_cloud/dedicated_servers/micron-7500-fw-upgrade/meta.yaml @@ -0,0 +1,2 @@ +id: dd4253d4-36e3-4c6f-ba08-36cf8d404ab8 +full_slug: dedicated-servers-micron-7500-pro-fw-update \ No newline at end of file diff --git a/pages/bare_metal_cloud/dedicated_servers/move-failover-ip/images/manager03.png b/pages/bare_metal_cloud/dedicated_servers/move-failover-ip/images/manager03.png deleted file mode 100644 index 47ee84b4b48..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/move-failover-ip/images/manager03.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/move-failover-ip/images/moveadditionalIP.png b/pages/bare_metal_cloud/dedicated_servers/move-failover-ip/images/moveadditionalIP.png deleted file mode 100644 index 6ba6874eb21..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/move-failover-ip/images/moveadditionalIP.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/network_bridging/images/virtual_mac.png b/pages/bare_metal_cloud/dedicated_servers/network_bridging/images/virtual_mac.png deleted file mode 100644 index d4a7839db2c..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/network_bridging/images/virtual_mac.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/network_bridging/images/virtual_mac_01.png b/pages/bare_metal_cloud/dedicated_servers/network_bridging/images/virtual_mac_01.png deleted file mode 100644 index 6421993b10b..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/network_bridging/images/virtual_mac_01.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/network_bridging/images/virtual_mac_01_2020.png b/pages/bare_metal_cloud/dedicated_servers/network_bridging/images/virtual_mac_01_2020.png deleted file mode 100644 index 18dab259621..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/network_bridging/images/virtual_mac_01_2020.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/network_bridging/images/virtual_mac_01_2020_1.png b/pages/bare_metal_cloud/dedicated_servers/network_bridging/images/virtual_mac_01_2020_1.png deleted file mode 100644 index 171f174050c..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/network_bridging/images/virtual_mac_01_2020_1.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/network_bridging/images/virtual_mac_02.png b/pages/bare_metal_cloud/dedicated_servers/network_bridging/images/virtual_mac_02.png deleted file mode 100644 index 06bfe9664a9..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/network_bridging/images/virtual_mac_02.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/network_bridging/images/virtual_mac_02_2020.png b/pages/bare_metal_cloud/dedicated_servers/network_bridging/images/virtual_mac_02_2020.png deleted file mode 100644 index b27257a8449..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/network_bridging/images/virtual_mac_02_2020.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/network_bridging/images/virtual_mac_03.png b/pages/bare_metal_cloud/dedicated_servers/network_bridging/images/virtual_mac_03.png deleted file mode 100644 index d4a7839db2c..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/network_bridging/images/virtual_mac_03.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/network_ip_monitoring/images/ServiceStatus.jpg b/pages/bare_metal_cloud/dedicated_servers/network_ip_monitoring/images/ServiceStatus.jpg deleted file mode 100644 index 212fe7b55cc..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/network_ip_monitoring/images/ServiceStatus.jpg and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/network_ip_monitoring/images/monitoring3.png b/pages/bare_metal_cloud/dedicated_servers/network_ip_monitoring/images/monitoring3.png deleted file mode 100644 index c7e73c5f2c9..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/network_ip_monitoring/images/monitoring3.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.de-de.md b/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.de-de.md index 03a80620c08..41f32fdc7b9 100644 --- a/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.de-de.md +++ b/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.de-de.md @@ -1,9 +1,23 @@ --- title: "Konfiguration von IP-Aliasing" excerpt: "Erfahren Sie hier, wie Sie Additional IPs zu Ihrer Konfiguration hinzufügen" -updated: 2025-07-22 +updated: 2025-11-12 --- + + > [!primary] > Diese Anleitung befasst sich mit der Konfiguration von Additional IPv4-Adressen auf einer öffentlichen Schnittstelle. Sie können auch IPv6-Adressen auf Ihren Dedicated Servern konfigurieren, indem Sie [diese Anleitung](/pages/bare_metal_cloud/dedicated_servers/network_ipv6) verwenden. > @@ -54,495 +68,509 @@ Beachten Sie die folgende Terminologie, die in Codebeispielen und Anweisungen de In unseren Beispielen verwenden wir den Texteditor `nano`. Bei einigen Betriebssystemen muss es vor der Verwendung installiert werden. Ist das der Fall, werden Sie dazu aufgefordert. Sie können natürlich auch einen beliebigen Texteditor verwenden. -### Debian 11 - -Standardmäßig befindet sich die Konfigurationsdatei unter `/etc/network/interfaces.d/`. Es wird empfohlen, zunächst eine Sicherungskopie der entsprechenden Konfigurationsdatei zu erstellen. - -#### Schritt 1: Backup erstellen - -In unserem Beispiel heißt die Datei `50-cloud-init`, also kopieren wir die Datei `50-cloud-init` mit folgendem Befehl: - -```sh -sudo cp /etc/network/interfaces.d/50-cloud-init /etc/network/interfaces.d/50-cloud-init.bak -``` - -Wenn Sie einen Fehler gemacht haben, können Sie mit den folgenden Befehlen zum vorherigen Zustand zurückkehren: - -```sh -sudo rm -f /etc/network/interfaces.d/50-cloud-init -sudo cp /etc/network/interfaces.d/50-cloud-init.bak /etc/network/interfaces.d/50-cloud-init -``` - -#### Schritt 2: Konfigurationsdatei bearbeiten - -> [!primary] -> -> Die Namen der Netzwerkschnittstellen in dieser Anleitung können von den Namen Ihres Systems abweichen. Passen Sie die Einstellungen entsprechend an. -> - -Sie können nun die Konfigurationsdatei bearbeiten: - -```sh -sudo nano /etc/network/interfaces.d/50-cloud-init -``` - -Fügen Sie anschließend ein virtuelles Interface oder einen Ethernet-Alias hinzu. In unserem Beispiel heißt das Interface `eth0`, der Alias ist also `eth0:0`. Tun Sie dies für jede Additional IP-Adresse, die Sie konfigurieren möchten. - -Ändern Sie nicht die bestehenden Zeilen in der Konfigurationsdatei, sondern fügen Sie einfach Ihre Additional IP wie unten beschrieben zu der Datei hinzu und ersetzen Sie `ADDITIONAL_IP/32` sowie das virtuelle Interface (wenn Ihr Server nicht **eth0:0** verwendet) durch Ihre eigenen Werte: - -```console -auto eth0:0 -iface eth0:0 inet static -address ADDITIONAL_IP -netmask 255.255.255.255 -``` - -Sie können Ihre Additional IP auch konfigurieren, indem Sie der Konfigurationsdatei die folgenden Zeilen hinzufügen: - -```console -post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP netmask 255.255.255.255 broadcast ADDITIONAL_IP -pre-down /sbin/ifconfig eth0:0 down -``` - -Bei der oben stehenden Konfiguration wird das virtuelle Interface jedes Mal aktiviert oder deaktiviert, wenn das `eth0` Interface aktiviert oder deaktiviert wird. - -Wenn Sie zwei Additional IPs konfigurieren müssen, sollte die Datei `/etc/network/interfaces.d/50-cloud-init` wie folgt aussehen: - -```console -auto eth0 -iface eth0 inet dhcp - -auto eth0:0 -iface eth0:0 inet static -address ADDITIONAL_IP1 -netmask 255.255.255.255 - -auto eth0:1 -iface eth0:1 inet static -address ADDITIONAL_IP2 -netmask 255.255.255.255 -``` - -Oder: - -```console -auto eth0 -iface eth0 inet dhcp - -# IP 1 -post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP1 netmask 255.255.255.255 broadcast ADDITIONAL_IP1 -pre-down /sbin/ifconfig eth0:0 down - -# IP 2 -post-up /sbin/ifconfig eth0:1 ADDITIONAL_IP2 netmask 255.255.255.255 broadcast ADDITIONAL_IP2 -pre-down /sbin/ifconfig eth0:1 down -``` - -**Konfigurationsbeispiel:** - -```console -auto eth0 -iface eth0 inet dhcp - -auto eth0:0 -iface eth0:0 inet static -address 203.0.113.1 -netmask 255.255.255.255 -``` - -Oder - -```console -auto eth0 -iface eth0 inet dhcp - -# IP 1 -post-up /sbin/ifconfig eth0:0 203.0.113.1 netmask 255.255.255.255 broadcast 203.0.113.1 -pre-down /sbin/ifconfig eth0:0 down -``` - -#### Schritt 3: Interface neu starten - -Im letzten Schritt starten Sie das Interface neu: - -```sh -sudo /etc/init.d/networking restart -``` - -### Fedora 39 und spätere Versionen - -Fedora verwendet nunmehr Schlüsseldateien (*keyfiles*). -Fedora speicherte zuvor im Verzeichnis `/etc/sysconfig/network-scripts/` Netzwerkprofile im Format ifcfg.
-Da ifcfg nicht mehr unterstützt wird, erstellt NetworkManager keine neuen Profile mehr in diesem Format. Die Konfigurationsdatei befindet sich nun in `/etc/NetworkManager/system-connections/`. - -#### Schritt 1: Backup erstellen - -> [!primary] -> -> Beachten Sie, dass der Name der Netzwerkdatei in unserem Beispiel von Ihrem abweichen kann. Bitte passen Sie die Beispiele mit dem passenden Namen an. -> - -Es wird empfohlen, zunächst eine Sicherungskopie der entsprechenden Konfigurationsdatei zu erstellen. In unserem Beispiel heißt die Konfigurationsdatei `cloud-init-eno1.nmconnection`: - -```sh -sudo cp -r /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak -``` - -Wenn Sie einen Fehler gemacht haben, können Sie mit den folgenden Befehlen zum vorherigen Zustand zurückkehren: - -```sh -sudo rm -f /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -sudo cp /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -``` - -#### Schritt 2: Konfigurationsdatei bearbeiten - -> [!primary] -> -> Beachten Sie, dass der Name der Netzwerkdatei in unserem Beispiel sich von Ihrem unterscheiden kann. Passen Sie die Befehle an den Namen Ihrer Datei an. -> - -Um den Namen Ihres Netzwerkinterfaces für die Netzwerkdatei zu erhalten, können Sie folgenden Befehl ausführen: - -```sh -ip a -``` - -```sh -nmcli connection show -``` - -Ändern Sie keine bestehenden Zeilen in der Konfigurationsdatei. Fügen Sie Ihre Additional IP wie folgt in die Datei ein und ersetzen Sie `ADDITIONAL_IP/32` durch Ihre eigenen Werte: - - -```sh -sudo nano /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -``` - -```console -[ipv4] -method=auto -may-fail=false -address1=ADDITIONAL_IP/32 -``` - -Wenn Sie zwei Additional IP-Adressen konfigurieren möchten, sollte die Konfigurationsdatei wie folgt aussehen: - -```console -[ipv4] -method=auto -may-fail=false -address1=ADDITIONAL_IP1/32 -address2=ADDITIONAL_IP2/32 -``` - -**Konfigurationsbeispiel:** - -```console -[ipv4] -method=auto -may-fail=false -address1=203.0.113.1/32 -``` - -#### Schritt 3: Interface neu starten - -Als letzten Schritt starten Sie Ihr Interface neu: - -```sh -sudo systemctl restart NetworkManager -``` - -### Debian 12, Ubuntu 20.04 und spätere Versionen - -Standardmäßig befinden sich die Konfigurationsdateien im Verzeichnis `/etc/netplan`. - -Am besten erstellen Sie eine separate Konfigurationsdatei, um die Additional IP-Adressen zu konfigurieren. So können Sie im Falle eines Fehlers die Konfiguration wiederherstellen. - -#### Schritt 1: Interface bestimmen - -```sh -ip a -``` - -Notieren Sie sich den Namen des Interface (das Interface, auf dem die Haupt-IP-Adresse Ihres Servers konfiguriert ist). - -#### Schritt 2: Konfigurationsdatei erstellen - -Erstellen Sie anschließend eine Konfigurationsdatei mit der Erweiterung `.yaml`. In unserem Beispiel heißt die Datei `51-cloud-init.yaml`. - -```sh -sudo nano /etc/netplan/51-cloud-init.yaml -``` - -Bearbeiten Sie anschließend die Datei mit folgendem Inhalt und ersetzen Sie `INTERFACE_NAME` und `ADDITIONAL_IP` durch Ihre eigenen Werte: - -```yaml -network: - version: 2 - ethernets: - INTERFACE_NAME: - dhcp4: true - addresses: - - ADDITIONAL_IP/32 -``` - -Wenn Sie zwei Additional IPs konfigurieren müssen, sollte die Konfigurationsdatei wie folgt aussehen: - -```yaml -network: - version: 2 - ethernets: - INTERFACE_NAME: - dhcp4: true - addresses: - - ADDITIONAL_IP1/32 - - ADDITIONAL_IP2/32 -``` - -> [!warning] -> -> Es ist wichtig, die Ausrichtung jedes Elements in dieser Datei zu beachten, wie im obigen Beispiel dargestellt. Verwenden Sie nicht die Tabulatortaste, um Abstand zu erstellen. Es ist nur die Leertaste erforderlich. -> - -**Konfigurationsbeispiel:** - -```yaml -network: - version: 2 - ethernets: - eth0: - dhcp4: true - addresses: - - 203.0.113.1/32 -``` - -Datei speichern und schließen. Sie können die Konfiguration mit folgendem Befehl testen: - -```sh -sudo netplan try -``` - -#### Schritt 3: Änderung anwenden - -Führen Sie anschließend folgende Befehle aus, um die Konfiguration anzuwenden: - -```sh -sudo netplan apply -``` - -> [!primary] -> Bei Verwendung des Befehls `netplan try` kann eine Warnmeldung wie `Permissions for /etc/netplan/xx-cloud-init.yaml are too open. Netplan configuration should NOT be accessible by others`. Das bedeutet nur, dass die Datei keine einschränkenden Berechtigungen hat. Dies hat keine Auswirkungen auf die Konfiguration Ihrer Additional IP. Weitere Informationen zu Dateiberechtigungen finden Sie in der [offiziellen Dokumentation von Ubuntu](https://help.ubuntu.com/community/FilePermissions). +> [!success] +> Wählen Sie den Tab für Ihr Betriebssystem. > -### AlmaLinux (8 & 9), Rocky Linux (8 & 9) - -Die Hauptkonfigurationsdatei befindet sich unter `/etc/sysconfig/network-scripts/`. In unserem Beispiel heißt es `ifcfg-eth0`. Überprüfen Sie Ihren Dateinamen in diesem Ordner, bevor Sie Änderungen vornehmen. - -Für jede zu konfigurierende Additional IP wird eine separate Konfigurationsdatei mit den folgenden Parametern erstellt: `ifcfg-NETWORK_INTERFACE:ID`. Dabei steht `NETWORK_INTERFACE` für die physische Schnittstelle und `ID` für die virtuelle Netzwerkschnittstelle oder den Ethernet-Alias, der mit einem Wert von 0 beginnt. Für unsere Schnittstelle `eth0` ist der erste Alias beispielsweise `eth0:0`, der zweite Alias ist `eth0:1`, etc. - -#### Schritt 1: Schnittstelle bestimmen - -```sh -ip a -``` - -Notieren Sie sich den Namen des Interface (das Interface, auf dem die Haupt-IP-Adresse Ihres Servers konfiguriert ist). - -#### Schritt 2: Konfigurationsdatei erstellen - -Erstellen Sie zunächst die Konfigurationsdatei. Ersetzen Sie `NETWORK_INTERFACE:ID` durch Ihre eigenen Werte. - -```sh -sudo nano /etc/sysconfig/network-scripts/ifcfg-NETWORK_INTERFACE:ID -``` - -Bearbeiten Sie anschließend die Datei mit dem unten stehenden Inhalt und ersetzen Sie `NETWORK_INTERFACE:ID` und `ADDITIONAL_IP` durch Ihre eigenen Werte: - -```console -DEVICE=NETWORK_INTERFACE:ID -ONBOOT=yes -BOOTPROTO=none # For CentOS use "static" -IPADDR=ADDITIONAL_IP -NETMASK=255.255.255.255 -BROADCAST=ADDITIONAL_IP -``` - -**Konfigurationsbeispiel:** - -```console -DEVICE=eth0:0 -ONBOOT=yes -BOOTPROTO=none # For CentOS use "static" -IPADDR=203.0.113.1 -NETMASK=255.255.255.255 -BROADCAST=203.0.113.1 -``` - -#### Schritt 3: Interface neu starten - -Als letzten Schritt starten Sie Ihr Interface neu: - -```sh -sudo systemctl restart NetworkManager -``` - -## cPanel - -#### Schritt 1: Zugang zum WHM IP Verwaltungsbereich - -Klicken Sie im WHM-Kundencenter auf `IP functions`{.action} und wählen Sie im Menü links `Add a New IP Address`{.action} aus. - -![Eine neue IP-Adresse hinzufügen](images/Cpanel-1.png){.thumbnail} - -#### Schritt 2: Zusätzliche IP-Informationen hinzufügen - -Geben Sie Ihre Additional IP in der Form "xxx.xxx.xxx.xxx" im Feld "New IP or IP range to add" ein. - -Klicken Sie auf `255.255.255.255` als Subnetzmaske und dann auf `Submit`{.action}. - -![Neue Informationen zur neuen IP-Adresse eingeben](images/Cpanel-2024.png){.thumbnail} - -> [!warning] -> -> Achtung: Wenn Sie mehrere IP-Adressen in einem einzigen Block konfigurieren müssen und alle gleichzeitig hinzufügen, wird das WHM-System die Verwendung der Subnetzmaske `255.255.255.0` erzwingen. Die Verwendung dieser Konfiguration wird nicht empfohlen. Um die entsprechende Subnetzmaske `255.255.255.255` verwenden zu können, fügen Sie die IP-Adressen stattdessen einzeln hinzu. -> - -#### Schritt 3: Aktuelle IP-Konfiguration überprüfen - -Zurück im Abschnitt `IP functions`{.action} klicken Sie auf `Show or Delete Current IP Addresses`{.action}, um zu überprüfen, ob die Additional IP korrekt hinzugefügt wurde. - -![check konfiguration IP](images/Cpanel-2024-1.png){.thumbnail} - - -### Windows Server - -Die Netzwerkeinstellung von Windows Servern ist häufig mit DHCP konfiguriert. Wenn Sie bereits eine Additional IP angelegt oder Ihre Konfiguration als statische IP definiert haben, können Sie direkt zum nächsten Schritt übergehen. - -Andernfalls wechseln Sie zunächst von einer DHCP-Konfiguration auf Netzwerkebene zur statischen IP-Konfiguration. - -Starten Sie die Eingabeaufforderung `cmd`{.action} oder `powershell`{.action} und geben Sie den folgenden Befehl ein: - -```powershell -ipconfig -``` - -Sie erhalten daraufhin zum Beispiel Folgendes: - -![Result of "ipconfig" command](images/ipconfig.png){.thumbnail} - -Notieren Sie dann IPv4, Subnetzmaske, Standardgateway sowie den Namen der Netzwerkkarte. - -In diesem Beispiel lautet die IP des Servers: **192.0.2.28**. - -Die nächsten Schritte können Sie entweder über die Eingabeaufforderung oder über die grafische Benutzeroberfläche ausführen. - -#### In der Kommandozeile (empfohlen) - -In den untenstehenden Befehlen ersetzen Sie Folgendes: - -|Befehl|Wert| -|---|---| -|NETWORK_ADAPTER| Name der Netzwerkkarte (in unserem Beispiel: Ethernet 2)| -|IP_ADDRESS| Server-IP-Adresse (in unserem Beispiel: 192.0.2.28)| -|SUBNET_MASK| Subnetzmaske (in unserem Beispiel: 255.255.255.0)| -|GATEWAY| Standardgateway (in unserem Beispiel: 192.0.2.254)| -|ADDITIONAL_IP| Additional IP-Adresse, die Sie hinzufügen möchten| - -> [!warning] -> -> Die Eingabe falscher Daten führt dazu, dass der Server nicht mehr erreichbar ist. In diesem Fall sind dann Korrekturmaßnahmen im WinRescue-Modus oder über KVM erforderlich. -> - -In der Eingabeaufforderung: - -1\. Umschalten auf statische IP - -```powershell -netsh interface ipv4 set address name="NETWORK_ADAPTER" static IP_ADDRESS SUBNET_MASK GATEWAY -``` - -2\. DNS-Server festlegen - -```powershell -netsh interface ipv4 set dns name="NETWORK_ADAPTER" static 213.186.33.99 -``` - -3\. Additional IP hinzufügen - -```powershell -netsh interface ipv4 add address "NETWORK_ADAPTER" ADDITIONAL_IP 255.255.255.255 -``` - -Ihre Additional IP ist damit funktionsfähig. - -#### Grafische Benutzeroberfläche - -1. Öffnen Sie `Start`{.action}, `Control Panel`{.action}, `Network and Internet`{.action}, `Network and Sharing Centre`{.action}, `Change Adapter Settings`{.action} (im linken Menü). -2. Klicken Sie mit der rechten Maustaste auf Ihre Netzwerkverbindung, in unserem Beispiel `Ethernet 2`{.action}. -3. Klicken Sie auf `Properties`{.action}. -4. Wählen Sie `Internet Protocol Version 4 (TCP/IPv4)`{.action} aus und klicken Sie auf `Properties`{.action}. -5. Klicken Sie auf `Use the following IP address`{.action} und geben Sie die Haupt-IP-Adresse Ihres Servers, die Subnetzmaske und das Standardgateway ein, die Sie über den Befehl `ipconfig`{.action} erhalten haben. (Im Feld “Preferred DNS Server” geben Sie 213.186.33.99 ein). - -![Internet Protocol Version 4 (TCP/IPv4) Properties](images/configure-main-ip.png){.thumbnail} - -> [!warning] -> -> Achtung, der Server wird unerreichbar, wenn Sie falsche Werte eingeben. Die Korrekturen müssen dann im [WinRescue-Modus](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) oder über [IPMI](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers) durchgeführt werden. -> - -Klicken Sie auf `Advanced`{.action} (in `TCP/IP Settings`{.action}). - -![Internet Protocol Version 4 (TCP/IPv4) Properties](images/configure-main-ip-1.png){.thumbnail} - - -Im Bereich `IP Address`{.action} klicken Sie auf `Add`{.action}. - -![Advanced TCP/IPv4 Settings](images/add-additional-ip.png){.thumbnail} - - -Geben Sie dann Ihre Additional IP und die Subnetzmaske **255.255.255.255** ein. Klicken Sie auf `Add`{.action}. - -![TCP/IP Address](images/configure-additional-ip.png){.thumbnail} - -Klicken Sie auf `OK`{.action}, um Ihre Konfiguration zu bestätigen. - -Ihre Additional IP ist nun betriebsbereit. Sie können die Konfiguration mit folgendem Befehl überprüfen: - -```powershell -ipconfig -``` - -Sie erhalten daraufhin zum Beispiel Folgendes: - -![Result of "ipconfig" command](images/final-ip-configuration.png){.thumbnail} - - -### Plesk - -#### Schritt 1: Auf die IP-Verwaltung von Plesk zugreifen - -Wählen Sie im Plesk Konfigurationspanel `Tools & Settings`{.action} im linken Menü aus. - -![Zugang zur Verwaltung der IP-Adressen](images/pleskip1.png){.thumbnail} - -Klicken Sie auf `IP Addresses`{.action} unter **Tools & Resources**. - -#### Schritt 2: Additional IP hinzufügen - -Klicken Sie in diesem Abschnitt auf den Button `Add IP Address`{.action}. - -![IP-Informationen hinzufügen](images/Plesk-2024.png){.thumbnail} - -Geben Sie Ihre Additional IP in der Form `xxx.xxx.xxx.xxx/32` in das Feld "IP address and subnet mask" ein und klicken Sie dann auf `OK`{.action}. - -![IP-Informationen hinzufügen](images/Plesk-2024-1.png){.thumbnail} - -#### Schritt 3: Aktuelle IP-Konfiguration überprüfen - -Überprüfen Sie im Bereich "IP Addresses" ob die Additional IP korrekt hinzugefügt wurde. - -![aktuelle IP-Konfiguration](images/Plesk-2024-2.png){.thumbnail} +> [!tabs] +> Debian 11 +>> **Debian 11** +>> +>> Standardmäßig befindet sich die Konfigurationsdatei unter `/etc/network/interfaces.d/`. Es wird empfohlen, zunächst eine Sicherungskopie der entsprechenden Konfigurationsdatei zu erstellen. +>> +>> Schritt 1: Backup erstellen +>> +>> In unserem Beispiel heißt die Datei `50-cloud-init`, also kopieren wir die Datei `50-cloud-init` mit folgendem Befehl: +>> +>> ```sh +>> sudo cp /etc/network/interfaces.d/50-cloud-init /etc/network/interfaces.d/50-cloud-init.bak +>> ``` +>> +>> Wenn Sie einen Fehler gemacht haben, können Sie mit den folgenden Befehlen zum vorherigen Zustand zurückkehren: +>> +>> ```sh +>> sudo rm -f /etc/network/interfaces.d/50-cloud-init +>> sudo cp /etc/network/interfaces.d/50-cloud-init.bak /etc/network/interfaces.d/50-cloud-init +>> ``` +>> +>> Schritt 2: Konfigurationsdatei bearbeiten +>> +>> > [!primary] +>> > +>> > Die Namen der Netzwerkschnittstellen in dieser Anleitung können von den Namen Ihres Systems abweichen. Passen Sie die Einstellungen entsprechend an. +>> > +>> +>> Sie können nun die Konfigurationsdatei bearbeiten: +>> +>> ```sh +>> sudo nano /etc/network/interfaces.d/50-cloud-init +>> ``` +>> +>> Fügen Sie anschließend ein virtuelles Interface oder einen Ethernet-Alias hinzu. In unserem Beispiel heißt das Interface `eth0`, der Alias ist also `eth0:0`. Tun Sie dies für jede Additional IP-Adresse, die Sie konfigurieren möchten. +>> +>> Ändern Sie nicht die bestehenden Zeilen in der Konfigurationsdatei, sondern fügen Sie einfach Ihre Additional IP wie unten beschrieben zu der Datei hinzu und ersetzen Sie `ADDITIONAL_IP/32` sowie das virtuelle Interface (wenn Ihr Server nicht **eth0:0** verwendet) durch Ihre eigenen Werte: +>> +>> ```console +>> auto eth0:0 +>> iface eth0:0 inet static +>> address ADDITIONAL_IP +>> netmask 255.255.255.255 +>> ``` +>> +>> Sie können Ihre Additional IP auch konfigurieren, indem Sie der Konfigurationsdatei die folgenden Zeilen hinzufügen: +>> +>> ```console +>> post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP netmask 255.255.255.255 broadcast ADDITIONAL_IP +>> pre-down /sbin/ifconfig eth0:0 down +>> ``` +>> +>> Bei der oben stehenden Konfiguration wird das virtuelle Interface jedes Mal aktiviert oder deaktiviert, wenn das `eth0` Interface aktiviert oder deaktiviert wird. +>> +>> Wenn Sie zwei Additional IPs konfigurieren müssen, sollte die Datei `/etc/network/interfaces.d/50-cloud-init` wie folgt aussehen: +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> auto eth0:0 +>> iface eth0:0 inet static +>> address ADDITIONAL_IP1 +>> netmask 255.255.255.255 +>> +>> auto eth0:1 +>> iface eth0:1 inet static +>> address ADDITIONAL_IP2 +>> netmask 255.255.255.255 +>> ``` +>> +>> Oder: +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> # IP 1 +>> post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP1 netmask 255.255.255.255 broadcast ADDITIONAL_IP1 +>> pre-down /sbin/ifconfig eth0:0 down +>> +>> # IP 2 +>> post-up /sbin/ifconfig eth0:1 ADDITIONAL_IP2 netmask 255.255.255.255 broadcast ADDITIONAL_IP2 +>> pre-down /sbin/ifconfig eth0:1 down +>> ``` +>> +>> /// details | **Konfigurationsbeispiel** +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> auto eth0:0 +>> iface eth0:0 inet static +>> address 203.0.113.1 +>> netmask 255.255.255.255 +>> ``` +>> +>> Oder +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> # IP 1 +>> post-up /sbin/ifconfig eth0:0 203.0.113.1 netmask 255.255.255.255 broadcast 203.0.113.1 +>> pre-down /sbin/ifconfig eth0:0 down +>> ``` +>> /// +>> +>> Schritt 3: Interface neu starten +>> +>> Im letzten Schritt starten Sie das Interface neu: +>> +>> ```sh +>> sudo /etc/init.d/networking restart +>> ``` +>> +> Fedora 41+ +>> **Fedora 41 und spätere Versionen** +>> +>> Fedora verwendet nunmehr Schlüsseldateien (*keyfiles*). +>> Fedora speicherte zuvor im Verzeichnis `/etc/sysconfig/network-scripts/` Netzwerkprofile im Format ifcfg.
+>> Da ifcfg nicht mehr unterstützt wird, erstellt NetworkManager keine neuen Profile mehr in diesem Format. Die Konfigurationsdatei befindet sich nun in `/etc/NetworkManager/system-connections/`. +>> +>> Schritt 1: Backup erstellen +>> +>> > [!primary] +>> > +>> > Beachten Sie, dass der Name der Netzwerkdatei in unserem Beispiel von Ihrem abweichen kann. Bitte passen Sie die Beispiele mit dem passenden Namen an. +>> > +>> +>> Es wird empfohlen, zunächst eine Sicherungskopie der entsprechenden Konfigurationsdatei zu erstellen. In unserem Beispiel heißt die Konfigurationsdatei `cloud-init-eno1.nmconnection`: +>> +>> ```sh +>> sudo cp -r /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak +>> ``` +>> +>> Wenn Sie einen Fehler gemacht haben, können Sie mit den folgenden Befehlen zum vorherigen Zustand zurückkehren: +>> +>> ```sh +>> sudo rm -f /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> sudo cp /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> ``` +>> +>> Schritt 2: Konfigurationsdatei bearbeiten +>> +>> > [!primary] +>> > +>> > Beachten Sie, dass der Name der Netzwerkdatei in unserem Beispiel sich von Ihrem unterscheiden kann. Passen Sie die Befehle an den Namen Ihrer Datei an. +>> > +>> +>> Um den Namen Ihres Netzwerkinterfaces für die Netzwerkdatei zu erhalten, können Sie folgenden Befehl ausführen: +>> +>> ```bash +>> ip a +>> ``` +>> +>> ```bash +>> nmcli connection show +>> ``` +>> +>> Ändern Sie keine bestehenden Zeilen in der Konfigurationsdatei. Fügen Sie Ihre Additional IP wie folgt in die Datei ein und ersetzen Sie `ADDITIONAL_IP/32` durch Ihre eigenen Werte: +>> +>> +>> ```sh +>> sudo nano /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> ``` +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=ADDITIONAL_IP/32 +>> ``` +>> +>> Wenn Sie zwei Additional IP-Adressen konfigurieren möchten, sollte die Konfigurationsdatei wie folgt aussehen: +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=ADDITIONAL_IP1/32 +>> address2=ADDITIONAL_IP2/32 +>> ``` +>> +>> /// details | **Konfigurationsbeispiel** +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=203.0.113.1/32 +>> ``` +>> +>> Schritt 3: Interface neu starten +>> +>> Als letzten Schritt starten Sie Ihr Interface neu: +>> +>> ```sh +>> sudo systemctl restart NetworkManager +>> ``` +>> +> Debian 12 und Ubuntu 20.04+ +>> **Debian 12, Ubuntu 20.04 und spätere Versionen** +>> +>> Standardmäßig befinden sich die Konfigurationsdateien im Verzeichnis `/etc/netplan`. +>> +>> Am besten erstellen Sie eine separate Konfigurationsdatei, um die Additional IP-Adressen zu konfigurieren. So können Sie im Falle eines Fehlers die Konfiguration wiederherstellen. +>> +>> Schritt 1: Interface bestimmen +>> +>> ```sh +>> ip a +>> ``` +>> +>> Notieren Sie sich den Namen des Interface (das Interface, auf dem die Haupt-IP-Adresse Ihres Servers konfiguriert ist). +>> +>> Schritt 2: Konfigurationsdatei erstellen +>> +>> Erstellen Sie anschließend eine Konfigurationsdatei mit der Erweiterung `.yaml`. In unserem Beispiel heißt die Datei `51-cloud-init.yaml`. +>> +>> ```sh +>> sudo nano /etc/netplan/51-cloud-init.yaml +>> ``` +>> +>> Bearbeiten Sie anschließend die Datei mit folgendem Inhalt und ersetzen Sie `INTERFACE_NAME` und `ADDITIONAL_IP` durch Ihre eigenen Werte: +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> INTERFACE_NAME: +>> dhcp4: true +>> addresses: +>> - ADDITIONAL_IP/32 +>> ``` +>> +>> Wenn Sie zwei Additional IPs konfigurieren müssen, sollte die Konfigurationsdatei wie folgt aussehen: +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> INTERFACE_NAME: +>> dhcp4: true +>> addresses: +>> - ADDITIONAL_IP1/32 +>> - ADDITIONAL_IP2/32 +>> ``` +>> +>> > [!warning] +>> > +>> > Es ist wichtig, die Ausrichtung jedes Elements in dieser Datei zu beachten, wie im obigen Beispiel dargestellt. Verwenden Sie nicht die Tabulatortaste, um Abstand zu erstellen. Es ist nur die Leertaste erforderlich. +>> > +>> +>> /// details | **Konfigurationsbeispiel** +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> eth0: +>> dhcp4: true +>> addresses: +>> - 203.0.113.1/32 +>> ``` +>> /// +>> +>> Datei speichern und schließen. Sie können die Konfiguration mit folgendem Befehl testen: +>> +>> ```sh +>> sudo netplan try +>> ``` +>> +>> Schritt 3: Änderung anwenden +>> +>> Führen Sie anschließend folgende Befehle aus, um die Konfiguration anzuwenden: +>> +>> ```sh +>> sudo netplan apply +>> ``` +>> +>> > [!primary] +>> > Bei Verwendung des Befehls `netplan try` kann eine Warnmeldung wie `Permissions for /etc/netplan/xx-cloud-init.yaml are too open. Netplan configuration should NOT be accessible by others`. Das bedeutet nur, dass die Datei keine einschränkenden Berechtigungen hat. Dies hat keine Auswirkungen auf die Konfiguration Ihrer Additional IP. Weitere Informationen zu Dateiberechtigungen finden Sie in der [offiziellen Dokumentation von Ubuntu](https://help.ubuntu.com/community/FilePermissions). +>> > +>> +> AlmaLinux / Rocky Linux +>> **AlmaLinux (8 & 9), Rocky Linux (8 & 9)** +>> Die Hauptkonfigurationsdatei befindet sich unter `/etc/sysconfig/network-scripts/`. In unserem Beispiel heißt es `ifcfg-eth0`. Überprüfen Sie Ihren Dateinamen in diesem Ordner, bevor Sie Änderungen vornehmen. +>> +>> Für jede zu konfigurierende Additional IP wird eine separate Konfigurationsdatei mit den folgenden Parametern erstellt: `ifcfg-NETWORK_INTERFACE:ID`. Dabei steht `NETWORK_INTERFACE` für die physische Schnittstelle und `ID` für die virtuelle Netzwerkschnittstelle oder den Ethernet-Alias, der mit einem Wert von 0 beginnt. Für unsere Schnittstelle `eth0` ist der erste Alias beispielsweise `eth0:0`, der zweite Alias ist `eth0:1`, etc. +>> +>> Schritt 1: Schnittstelle bestimmen +>> +>> ```sh +>> ip a +>> ``` +>> +>> Notieren Sie sich den Namen des Interface (das Interface, auf dem die Haupt-IP-Adresse Ihres Servers konfiguriert ist). +>> +>> Schritt 2: Konfigurationsdatei erstellen +>> +>> Erstellen Sie zunächst die Konfigurationsdatei. Ersetzen Sie `NETWORK_INTERFACE:ID` durch Ihre eigenen Werte. +>> +>> ```sh +>> sudo nano /etc/sysconfig/network-scripts/ifcfg-NETWORK_INTERFACE:ID +>> ``` +>> +>> Bearbeiten Sie anschließend die Datei mit dem unten stehenden Inhalt und ersetzen Sie `NETWORK_INTERFACE:ID` und `ADDITIONAL_IP` durch Ihre eigenen Werte: +>> +>> ```console +>> DEVICE=NETWORK_INTERFACE:ID +>> ONBOOT=yes +>> BOOTPROTO=none # For CentOS use "static" +>> IPADDR=ADDITIONAL_IP +>> NETMASK=255.255.255.255 +>> BROADCAST=ADDITIONAL_IP +>> ``` +>> +>> /// details | **Konfigurationsbeispiel** +>> +>> ```console +>> DEVICE=eth0:0 +>> ONBOOT=yes +>> BOOTPROTO=none # For CentOS use "static" +>> IPADDR=203.0.113.1 +>> NETMASK=255.255.255.255 +>> BROADCAST=203.0.113.1 +>> ``` +>> /// +>> +>> Schritt 3: Interface neu starten +>> +>> Als letzten Schritt starten Sie Ihr Interface neu: +>> +>> ```sh +>> sudo systemctl restart NetworkManager +>> ``` +>> +> cPanel +>> **cPanel** +>> +>> Schritt 1: Zugang zum WHM IP Verwaltungsbereich +>> +>> Klicken Sie im WHM-Kundencenter auf `IP functions`{.action} und wählen Sie im Menü links `Add a New IP Address`{.action} aus. +>> +>> ![Eine neue IP-Adresse hinzufügen](images/Cpanel-1.png){.thumbnail} +>> +>> Schritt 2: Zusätzliche IP-Informationen hinzufügen +>> +>> Geben Sie Ihre Additional IP in der Form "xxx.xxx.xxx.xxx" im Feld "New IP or IP range to add" ein. +>> +>> Klicken Sie auf `255.255.255.255` als Subnetzmaske und dann auf `Submit`{.action}. +>> +>> ![Neue Informationen zur neuen IP-Adresse eingeben](images/Cpanel-2024.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Achtung: Wenn Sie mehrere IP-Adressen in einem einzigen Block konfigurieren müssen und alle gleichzeitig hinzufügen, wird das WHM-System die Verwendung der Subnetzmaske `255.255.255.0` erzwingen. Die Verwendung dieser Konfiguration wird nicht empfohlen. Um die entsprechende Subnetzmaske `255.255.255.255` verwenden zu können, fügen Sie die IP-Adressen stattdessen einzeln hinzu. +>> > +>> +>> Schritt 3: Aktuelle IP-Konfiguration überprüfen +>> +>> Zurück im Abschnitt `IP functions`{.action} klicken Sie auf `Show or Delete Current IP Addresses`{.action}, um zu überprüfen, ob die Additional IP korrekt hinzugefügt wurde. +>> +>> ![check konfiguration IP](images/Cpanel-2024-1.png){.thumbnail} +>> +>> +> Windows Server +>> **Windows Server** +>> +>> Die Netzwerkeinstellung von Windows Servern ist häufig mit DHCP konfiguriert. Wenn Sie bereits eine Additional IP angelegt oder Ihre Konfiguration als statische IP definiert haben, können Sie direkt zum nächsten Schritt übergehen. +>> +>> Andernfalls wechseln Sie zunächst von einer DHCP-Konfiguration auf Netzwerkebene zur statischen IP-Konfiguration. +>> +>> Starten Sie die Eingabeaufforderung `cmd`{.action} oder `powershell`{.action} und geben Sie den folgenden Befehl ein: +>> +>> ```powershell +>> ipconfig +>> ``` +>> +>> Sie erhalten daraufhin zum Beispiel Folgendes: +>> +>> ![Result of "ipconfig" command](images/ipconfig.png){.thumbnail} +>> +>> Notieren Sie dann IPv4, Subnetzmaske, Standardgateway sowie den Namen der Netzwerkkarte. +>> +>> In diesem Beispiel lautet die IP des Servers: **192.0.2.28**. +>> +>> Die nächsten Schritte können Sie entweder über die Eingabeaufforderung oder über die grafische Benutzeroberfläche ausführen. +>> +>> **In der Kommandozeile (empfohlen)** +>> +>> In den untenstehenden Befehlen ersetzen Sie Folgendes: +>> +>> |Befehl|Wert| +>> |---|---| +>> |NETWORK_ADAPTER| Name der Netzwerkkarte (in unserem Beispiel: Ethernet 2)| +>> |IP_ADDRESS| Server-IP-Adresse (in unserem Beispiel: 192.0.2.28)| +>> |SUBNET_MASK| Subnetzmaske (in unserem Beispiel: 255.255.255.0)| +>> |GATEWAY| Standardgateway (in unserem Beispiel: 192.0.2.254)| +>> |ADDITIONAL_IP| Additional IP-Adresse, die Sie hinzufügen möchten| +>> +>> > [!warning] +>> > +>> > Die Eingabe falscher Daten führt dazu, dass der Server nicht mehr erreichbar ist. In diesem Fall sind dann Korrekturmaßnahmen im WinRescue-Modus oder über KVM erforderlich. +>> > +>> +>> In der Eingabeaufforderung: +>> +>> 1\. Umschalten auf statische IP +>> +>> ```powershell +>> netsh interface ipv4 set address name="NETWORK_ADAPTER" static IP_ADDRESS SUBNET_MASK GATEWAY +>> ``` +>> +>> 2\. DNS-Server festlegen +>> +>> ```powershell +>> netsh interface ipv4 set dns name="NETWORK_ADAPTER" static 213.186.33.99 +>> ``` +>> +>> 3\. Additional IP hinzufügen +>> +>> ```powershell +>> netsh interface ipv4 add address "NETWORK_ADAPTER" ADDITIONAL_IP 255.255.255.255 +>> ``` +>> +>> Ihre Additional IP ist damit funktionsfähig. +>> +>> /// details | **Grafische Benutzeroberfläche** +>> +>> 1. Öffnen Sie `Start`{.action}, `Control Panel`{.action}, `Network and Internet`{.action}, `Network and Sharing Centre`{.action}, `Change Adapter Settings`{.action} (im linken Menü). +>> 2. Klicken Sie mit der rechten Maustaste auf Ihre Netzwerkverbindung, in unserem Beispiel `Ethernet 2`{.action}. +>> 3. Klicken Sie auf `Properties`{.action}. +>> 4. Wählen Sie `Internet Protocol Version 4 (TCP/IPv4)`{.action} aus und klicken Sie auf `Properties`{.action}. +>> 5. Klicken Sie auf `Use the following IP address`{.action} und geben Sie die Haupt-IP-Adresse Ihres Servers, die Subnetzmaske und das Standardgateway ein, die Sie über den Befehl `ipconfig`{.action} erhalten haben. (Im Feld “Preferred DNS Server” geben Sie 213.186.33.99 ein). +>> +>> ![Internet Protocol Version 4 (TCP/IPv4) Properties](images/configure-main-ip.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Achtung, der Server wird unerreichbar, wenn Sie falsche Werte eingeben. Die Korrekturen müssen dann im [WinRescue-Modus](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) oder über [IPMI](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers) durchgeführt werden. +>> > +>> +>> Klicken Sie auf `Advanced`{.action} (in `TCP/IP Settings`{.action}). +>> +>> ![Internet Protocol Version 4 (TCP/IPv4) Properties](images/configure-main-ip-1.png){.thumbnail} +>> +>> Im Bereich `IP Address`{.action} klicken Sie auf `Add`{.action}. +>> +>> ![Advanced TCP/IPv4 Settings](images/add-additional-ip.png){.thumbnail} +>> +>> Geben Sie dann Ihre Additional IP und die Subnetzmaske **255.255.255.255** ein. Klicken Sie auf `Add`{.action}. +>> +>> ![TCP/IP Address](images/configure-additional-ip.png){.thumbnail} +>> +>> Klicken Sie auf `OK`{.action}, um Ihre Konfiguration zu bestätigen. +>> +>> Ihre Additional IP ist nun betriebsbereit. Sie können die Konfiguration mit folgendem Befehl überprüfen: +>> +>> ```powershell +>> ipconfig +>> ``` +>> +>> Sie erhalten daraufhin zum Beispiel Folgendes: +>> +>> ![Result of "ipconfig" command](images/final-ip-configuration.png){.thumbnail} +>> +>> /// +>> +> Plesk +>> **Plesk** +>> +>> Schritt 1: Auf die IP-Verwaltung von Plesk zugreifen +>> +>> Wählen Sie im Plesk Konfigurationspanel `Tools & Settings`{.action} im linken Menü aus. +>> +>> ![Zugang zur Verwaltung der IP-Adressen](images/pleskip1.png){.thumbnail} +>> +>> Klicken Sie auf `IP Addresses`{.action} unter **Tools & Resources**. +>> +>> Schritt 2: Additional IP hinzufügen +>> +>> Klicken Sie in diesem Abschnitt auf den Button `Add IP Address`{.action}. +>> +>> ![IP-Informationen hinzufügen](images/Plesk-2024.png){.thumbnail} +>> +>> Geben Sie Ihre Additional IP in der Form `xxx.xxx.xxx.xxx/32` in das Feld "IP address and subnet mask" ein und klicken Sie dann auf `OK`{.action}. +>> +>> ![IP-Informationen hinzufügen](images/Plesk-2024-1.png){.thumbnail} +>> +>> Schritt 3: Aktuelle IP-Konfiguration überprüfen +>> +>> Überprüfen Sie im Bereich "IP Addresses" ob die Additional IP korrekt hinzugefügt wurde. +>> +>> ![aktuelle IP-Konfiguration](images/Plesk-2024-2.png){.thumbnail} +>> #### Fehlerbehebung diff --git a/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.en-asia.md b/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.en-asia.md index 2c6e95eaf10..4e9c7201a42 100644 --- a/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.en-asia.md +++ b/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.en-asia.md @@ -1,9 +1,23 @@ --- title: 'Configuring IP aliasing' excerpt: 'Find out how to add Additional IP addresses to your server configuration' -updated: 2025-07-22 +updated: 2025-11-12 --- + + > [!primary] > This article is about Additional IPv4 configuration on a public interface. You can also configure Primary IPv6 addresses on your dedicated servers using [this guide](/pages/bare_metal_cloud/dedicated_servers/network_ipv6). > @@ -41,8 +55,7 @@ IP aliasing is a special network configuration for your OVHcloud dedicated serve The following sections contain configurations for the distributions we currently offer and the most commonly used distributions/operating systems. The first step is always to log in to your server via SSH or a GUI login session (RDP for a Windows server). > [!primary] -> -Concerning different distribution releases, please note that the proper procedure to configure your network interface as well as the file names may have been subject to change. We recommend to consult the manuals and knowledge resources of the respective OS versions if you experience any issues. +> Concerning different distribution releases, please note that the proper procedure to configure your network interface as well as the file names may have been subject to change. We recommend to consult the manuals and knowledge resources of the respective OS versions if you experience any issues. > **Please take note of the following terminology that will be used in code examples and instructions of the guide sections below:** @@ -55,480 +68,500 @@ Concerning different distribution releases, please note that the proper procedur In the examples below, we will use the `nano` text editor. With some operating systems, you will need to install it first before using it. If this is the case, you will be prompted to do so. You can, of course, use the text editor of your choice. -### Debian 11 - -By default, the configuration files are located in `/etc/network/interfaces.d/`. We recommend that you start by backing up the relevant configuration file. - -#### Step 1: Create a backup - -In our example, our file is called `50-cloud-init`, so we make a copy of the `50-cloud-init` file using the following command: - -```bash -sudo cp /etc/network/interfaces.d/50-cloud-init /etc/network/interfaces.d/50-cloud-init.bak -``` - -In case of a mistake, you will be able to revert the changes, using the commands below: - -```bash -sudo rm -f /etc/network/interfaces.d/50-cloud-init -sudo cp /etc/network/interfaces.d/50-cloud-init.bak /etc/network/interfaces.d/50-cloud-init -``` - -#### Step 2: Edit the configuration file - -> [!primary] -> -Note that the names of the network interfaces in our examples may differ from your own. Please adjust to your appropriate interface names. -> - -You can now modify the configuration file: - -```bash -sudo nano /etc/network/interfaces.d/50-cloud-init -``` - -Next, you need to add a virtual interface or ethernet alias. In our example, our interface is called `eth0`, so our alias is `eth0:0`. Do this for each additional IP you wish to configure. - -Do not modify the existing lines in the configuration file, simply add your Additional IP to the file as follows, replacing `ADDITIONAL_IP/32` as well as the virtual interface (if your server is not using **eth0:0**) wih your own values: - -```console -auto eth0:0 -iface eth0:0 inet static -address ADDITIONAL_IP -netmask 255.255.255.255 -``` - -Alternatively, you can configure your Additional IP by adding the following lines in the configuration file: - -```console -post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP netmask 255.255.255.255 broadcast ADDITIONAL_IP -pre-down /sbin/ifconfig eth0:0 down -``` - -With the configuration above, the virtual interface is enabled or disabled whenever the `eth0` interface is enabled or disabled. - -If you have two Additional IPs to configure, the `/etc/network/interfaces.d/50-cloud-init` file should look like this: - -```console -auto eth0 -iface eth0 inet dhcp - -auto eth0:0 -iface eth0:0 inet static -address ADDITIONAL_IP1 -netmask 255.255.255.255 - -auto eth0:1 -iface eth0:1 inet static -address ADDITIONAL_IP2 -netmask 255.255.255.255 -``` - -Or like this: - -```console -auto eth0 -iface eth0 inet dhcp - -# IP 1 -post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP1 netmask 255.255.255.255 broadcast ADDITIONAL_IP1 -pre-down /sbin/ifconfig eth0:0 down - -# IP 2 -post-up /sbin/ifconfig eth0:1 ADDITIONAL_IP2 netmask 255.255.255.255 broadcast ADDITIONAL_IP2 -pre-down /sbin/ifconfig eth0:1 down -``` - -Configuration example: - -```console -auto eth0 -iface eth0 inet dhcp - -auto eth0:0 -iface eth0:0 inet static -address 203.0.113.1 -netmask 255.255.255.255 -``` - -Or : - -```console -auto eth0 -iface eth0 inet dhcp - -# IP 1 -post-up /sbin/ifconfig eth0:0 203.0.113.1 netmask 255.255.255.255 broadcast 203.0.113.1 -pre-down /sbin/ifconfig eth0:0 down -``` - -#### Step 3: Restart the interface - -To restart the interface, use the following command: - -```bash -sudo /etc/init.d/networking restart -``` - -### Fedora 39 and following - -Fedora now uses keyfiles. NetworkManager previously stored network profiles in ifcfg format in this directory: `/etc/sysconfig/network-scripts/`. However, the ifcfg format is now deprecated. By default, NetworkManager no longer creates new profiles in this format. The configuration file is now found in `/etc/NetworkManager/system-connections/`. - -#### Step 1: Create a backup - -> [!primary] -> -> Note that the name of the network file in our example may differ from your own. Please adjust to your appropriate name. -> - -First, make a copy of the configuration file, so that you can revert at any time. In our example, our configuration file is called `cloud-init-eno1.nmconnection`. - -```bash -sudo cp -r /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak -``` - -#### Step 2: Edit the config file - -> [!primary] -> Please note that the name of the network file in our example may differ from yours. Please adapt the commands to your file name. -> - -To obtain the name of your network interface in order to edit the appropriate network file, you can run one of the following commands: - -```bash -ip a -``` - -```bash -nmcli connection show -``` - -Do not modify the existing lines in the configuration file, add your Additional IP to the file as follows, replacing `ADDITIONAL_IP/32` wih your own values: - -```bash -sudo nano /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -``` - -```console -[ipv4] -method=auto -may-fail=false -address1=ADDITIONAL_IP/32 -``` - -If you have two Additional IPs to configure, the configuration should look like this: - -```console -[ipv4] -method=auto -may-fail=false -address1=ADDITIONAL_IP1/32 -address2=ADDITIONAL_IP2/32 -``` - -Configuration example: - -```console -[ipv4] -method=auto -may-fail=false -address1=203.0.113.1/32 -``` - -#### Step 3: Restart the interface - -You now need to restart your interface: - -```bash -sudo systemctl restart NetworkManager -``` - -### Debian 12, Ubuntu 20.04 and following - -By default, the configuration files are located in the `/etc/netplan` directory. - -The best practice approach is to create a separate configuration file to set up Additional IP addresses. This way, you can easily revert the changes in case of an error. - -#### Step 1: Determine the interface - -```bash -ip a -``` - -Note the name of the interface (the one on which your server's main IP address is configured). - -#### Step 2: Create and edit the configuration file - -Next, create a configuration file with a `.yaml` extension. In our example, our file is called `51-cloud-init.yaml`. - -```bash -sudo nano /etc/netplan/51-cloud-init.yaml -``` - -Edit the file with the content below, replacing `INTERFACE_NAME` and `ADDITIONAL_IP` with your own values: - -```yaml -network: - version: 2 - ethernets: - INTERFACE_NAME: - dhcp4: true - addresses: - - ADDITIONAL_IP/32 -``` - -If you have two Additional IPs to configure, the configuration file should look like this: - -```yaml -network: - version: 2 - ethernets: - INTERFACE_NAME: - dhcp4: true - addresses: - - ADDITIONAL_IP1/32 - - ADDITIONAL_IP2/32 -``` - -> [!warning] -> It is important to respect the alignment of each element in this file as represented in the example above. Do not use the tab key to create your spacing. Only the space key is needed. +> [!success] +> Select the tab corresponding to your operating system. > -Configuration example: - -```yaml -network: - version: 2 - ethernets: - eth0: - dhcp4: true - addresses: - - 203.0.113.1/32 -``` - -Save and close the file. You can test the configuration with the following command: - -```bash -sudo netplan try -``` - -#### Step 3: Apply the change - -If it is correct, apply it using the following command: - -```bash -sudo netplan apply -``` - -> [!primary] -> When using the `netplan try` command, it is possible that the system returns a warning message such as `Permissions for /etc/netplan/xx-cloud-init.yaml are too open. Netplan configuration should NOT be accessible by others`. This simply means that the file does not have restrictive permissions. This does not affect the configuration of your Additional IP. For more information about file permissions, consult the [official documentation of ubuntu](https://help.ubuntu.com/community/FilePermissions). -> - -### AlmaLinux (8 & 9), Rocky Linux (8 & 9) - -The main configuration file is located in `/etc/sysconfig/network-scripts/`. In this example it is called `ifcfg-eth0`. Before making changes, verify the actual file name in this folder. - -For each Additional IP to be configured, we create a seperate configuration file with the following parameters: `ifcfg-NETWORK_INTERFACE:ID`. Where `NETWORK_INTERFACE` is the physical interface and `ID` is the virtual network interface or ethernet alias starting with a value of 0. For example, for our interface named `eth0` the first alias is `eth0:0`, the second alias is `eth0:1`, etc... - -#### Step 1: Determine the interface - -```bash -ip a -``` - -Note the name of the interface (the one on which your server's main IP address is configured). - -#### Step 2: Create the configuration file - -First, create the configuration file. Replace `NETWORK_INTERFACE:ID` with your own values. - -```bash -sudo nano /etc/sysconfig/network-scripts/ifcfg-NETWORK_INTERFACE:ID -``` - -Next, edit the file with the content below, replacing `NETWORK_INTERFACE:ID`, and `ADDITIONAL_IP` with your own values: - -```console -DEVICE=NETWORK_INTERFACE:ID -ONBOOT=yes -BOOTPROTO=none # For CentOS use "static" -IPADDR=ADDITIONAL_IP -NETMASK=255.255.255.255 -BROADCAST=ADDITIONAL_IP -``` - -Configuration example: - -```console -DEVICE=eth0:0 -ONBOOT=yes -BOOTPROTO=none # For CentOS use "static" -IPADDR=203.0.113.1 -NETMASK=255.255.255.255 -BROADCAST=203.0.113.1 -``` - -#### Step 3: Restart the interface - -Next, restart the network interface with the following command: - -```bash -sudo systemctl restart NetworkManager -``` - -### cPanel - -#### Step 1: Access the WHM IP management section - -In the WHM control panel, click on `IP Functions`{.action} and select `Add a New IP Address`{.action} in the left-hand sidebar. - -![Add new IP](images/Cpanel-1.png){.thumbnail} - -#### Step 2: Add the Additional IP information - -Enter your Additional IP in the form `xxx.xxx.xxx.xxx` into the field “New IP or IP range to add”. - -Select `255.255.255.255` as your subnet mask, then click on `Submit`{.action}. - -![enter new IP information](images/Cpanel-2024.png){.thumbnail} - -> [!warning] -> -> Please note that if you have more than one IP to configure on the same block and you add them all at once, the WHM system will force you to use the subnet mask `255.255.255.0`. We do not recommend using this configuration. Instead, you need to add each IP individually in order to use the proper subnet mask `255.255.255.255`. -> - -#### Step 3: Check the current IP configuration - -Back in the section `IP Functions`{.action}, click on `Show or Delete Current IP Addresses`{.action} to verify that the Additional IP address was added correctly. - -![check configured IP](images/Cpanel-2024-1.png){.thumbnail} - -### Windows Servers - -Windows servers are often DHCP-enabled in the network configuration. If you have already set up an Additional IP or switched your configuration to a fixed IP, go directly to the next step. - -Otherwise, you need to first switch from a network-level DHCP configuration to a fixed IP configuration. - -Open the command prompt `cmd`{.action} or `powershell`{.action}, then type the following command: - -```powershell -ipconfig -``` - -This will return a result similar to the following example: - -![Result of "ipconfig" command](images/ipconfig.png){.thumbnail} - -Identify and write down your IPv4, subnet mask, default gateway and the name of the network interface controller (network adapter). - -In our example, the server IP is **192.0.2.28**. - -You can perform the next steps via either a command-line interface or the graphical user interface. - -#### Via a command-line interface (recommended) - -In the commands below, you need to replace: - -|Command|Value| -|---|---| -|NETWORK_ADAPTER| Name of the network adapter (in our example: Ethernet 2)| -|IP_ADDRESS| Server IP address (in our example: 192.0.2.28)| -|SUBNET_MASK| Subnet mask (in our example: 255.255.255.0)| -|GATEWAY| Default gateway (in our example: 192.0.2.254)| -|ADDITIONAL_IP| Address of Additional IP you want to add (in our example 203.0.113.1)| - -> [!warning] -> -> Be careful – the server will no longer be accessible if you enter incorrect information. You will then have to make the corrections in [Winrescue mode](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) or via the [IPMI](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). -> - -In the command prompt: - -1\. Switch to a fixed IP - -```powershell -netsh interface ipv4 set address name="NETWORK_ADAPTER" static IP_ADDRESS SUBNET_MASK GATEWAY -``` - -2\. Set the DNS server - -```powershell -netsh interface ipv4 set dns name="NETWORK_ADAPTER" static 213.186.33.99 -``` - -3\. Add an Additional IP - -```powershell -netsh interface ipv4 add address "NETWORK_ADAPTER" ADDITIONAL_IP 255.255.255.255 -``` - -Your Additional IP is now functional. - -#### Via the graphical user interface - -1. Go to `Start`{.action}> `Control Panel`{.action}>` Network and Internet`{.action}> `Network and Sharing Centre`{.action}> `Change Adapter Settings `{.action}(in the left-hand menu). -2. Right-click on your network connection, in our example `Ethernet 2`{.action}. -3. Click on `Properties`{.action}. -4. Select `Internet Protocol Version 4 (TCP/IPv4)`{.action}, then click on `Properties`{.action}. -5. Click on `Use the following IP address`{.action} and type in your server’s primary IP, subnet mask and default gateway information obtained by using the `ipconfig`{.action} command above. In the "Preferred DNS Server" box, type 213.186.33.99. - -![Internet Protocol Version 4 (TCP/IPv4) Properties](images/configure-main-ip.png){.thumbnail} - -> [!warning] -> -> Be careful – the server will no longer be accessible if you enter incorrect information. You will then have to make the corrections in [Winrescue mode](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) or via the [IPMI](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). -> - -Then click on `Advanced`{.action} (still in the `TCP/IP Settings`{.action}). - -![Internet Protocol Version 4 (TCP/IPv4) Properties](images/configure-main-ip-1.png){.thumbnail} - -In the `IP Address`{.action} section, click `Add`{.action}: - -![Advanced TCP/IPv4 Settings](images/add-additional-ip.png){.thumbnail} - -Type in your Additional IP and the subnet mask **255.255.255.255**. Then click on `Add`{.action} - -![TCP/IP Address](images/configure-additional-ip.png){.thumbnail} - - -Click on `OK`{.action} to apply your configuration. - -Your Additional IP is now functional, you can verify the configuration with the following command: - -```powershell -ipconfig -``` - -This will return a result similar to the following example: - -![Final configuration](images/final-ip-configuration.png){.thumbnail} - -### Plesk - -#### Step 1: Access the Plesk IP management section - -In the Plesk control panel, choose `Tools & Settings`{.action} from the left-hand sidebar. - -![acces to the ip addresses management](images/pleskip1.png){.thumbnail} - -Click on `IP Addresses`{.action} under **Tools & Resources**. - -#### Step 2: Add the Additional IP information - -In this section, click on the button `Add IP Address`{.action}. - -![add ip information](images/Plesk-2024.png){.thumbnail} - -Enter your Additional IP in the form `xxx.xxx.xxx.xxx/32` into the field "IP address and subnet mask", then click on `OK`{.action}. - -![add ip information](images/Plesk-2024-1.png){.thumbnail} - -#### Step 3: Check the current IP configuration - -Back in the section "IP Addresses", verify that the Additional IP address was added correctly. - -![current IP configuration](images/Plesk-2024-2.png){.thumbnail} +> [!tabs] +> Debian 11 +>> **Debian 11** +>> +>> By default, the configuration files are located in `/etc/network/interfaces.d/`. We recommend that you start by backing up the relevant configuration file. +>> +>> Step 1: Create a backup +>> +>> In our example, our file is called `50-cloud-init`, so we make a copy of the `50-cloud-init` file using the following command: +>> +>> ```bash +>> sudo cp /etc/network/interfaces.d/50-cloud-init /etc/network/interfaces.d/50-cloud-init.bak +>> ``` +>> +>> In case of a mistake, you will be able to revert the changes, using the commands below: +>> +>> ```bash +>> sudo rm -f /etc/network/interfaces.d/50-cloud-init +>> sudo cp /etc/network/interfaces.d/50-cloud-init.bak /etc/network/interfaces.d/50-cloud-init +>> ``` +>> +>> Step 2: Edit the configuration file +>> +>> > [!primary] +>> > Note that the names of the network interfaces in our examples may differ from your own. Please adjust to your appropriate interface names. +>> > +>> +>> You can now modify the configuration file: +>> +>> ```bash +>> sudo nano /etc/network/interfaces.d/50-cloud-init +>> ``` +>> +>> Next, you need to add a virtual interface or ethernet alias. In our example, our interface is called `eth0`, so our alias is `eth0:0`. Do this for each additional IP you wish to configure. +>> +>> Do not modify the existing lines in the configuration file, simply add your Additional IP to the file as follows, replacing `ADDITIONAL_IP/32` as well as the virtual interface (if your server is not using **eth0:0**) wih your own values: +>> +>> ```console +>> auto eth0:0 +>> iface eth0:0 inet static +>> address ADDITIONAL_IP +>> netmask 255.255.255.255 +>> ``` +>> +>> Alternatively, you can configure your Additional IP by adding the following lines in the configuration file: +>> +>> ```console +>> post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP netmask 255.255.255.255 broadcast ADDITIONAL_IP +>> pre-down /sbin/ifconfig eth0:0 down +>> ``` +>> +>> With the configuration above, the virtual interface is enabled or disabled whenever the `eth0` interface is enabled or disabled. +>> +>> If you have two Additional IPs to configure, the `/etc/network/interfaces.d/50-cloud-init` file should look like this: +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> auto eth0:0 +>> iface eth0:0 inet static +>> address ADDITIONAL_IP1 +>> netmask 255.255.255.255 +>> +>> auto eth0:1 +>> iface eth0:1 inet static +>> address ADDITIONAL_IP2 +>> netmask 255.255.255.255 +>> ``` +>> +>> Or like this: +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> # IP 1 +>> post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP1 netmask 255.255.255.255 broadcast ADDITIONAL_IP1 +>> pre-down /sbin/ifconfig eth0:0 down +>> +>> # IP 2 +>> post-up /sbin/ifconfig eth0:1 ADDITIONAL_IP2 netmask 255.255.255.255 broadcast ADDITIONAL_IP2 +>> pre-down /sbin/ifconfig eth0:1 down +>> ``` +>> +>> /// details | **Configuration example** +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> auto eth0:0 +>> iface eth0:0 inet static +>> address 203.0.113.1 +>> netmask 255.255.255.255 +>> ``` +>> +>> Or: +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> # IP 1 +>> post-up /sbin/ifconfig eth0:0 203.0.113.1 netmask 255.255.255.255 broadcast 203.0.113.1 +>> pre-down /sbin/ifconfig eth0:0 down +>> ``` +>> /// +>> +>> Step 3: Restart the interface +>> +>> To restart the interface, use the following command: +>> +>> ```bash +>> sudo /etc/init.d/networking restart +>> ``` +>> +> Fedora 41+ +>> **Fedora 41 and following** +>> +>> Fedora now uses keyfiles. NetworkManager previously stored network profiles in ifcfg format in this directory: `/etc/sysconfig/network-scripts/`. However, the ifcfg format is now deprecated. By default, NetworkManager no longer creates new profiles in this format. The configuration file is now found in `/etc/NetworkManager/system-connections/`. +>> +>> Step 1: Create a backup +>> +>> > [!primary] +>> > +>> > Note that the name of the network file in our example may differ from your own. Please adjust to your appropriate name. +>> > +>> +>> First, make a copy of the configuration file, so that you can revert at any time. In our example, our configuration file is called `cloud-init-eno1.nmconnection`. +>> +>> ```bash +>> sudo cp -r /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak +>> ``` +>> +>> Step 2: Edit the config file +>> +>> > [!primary] +>> > Please note that the name of the network file in our example may differ from yours. Please adapt the commands to your file name. +>> > +>> +>> To obtain the name of your network interface in order to edit the appropriate network file, you can run one of the following commands: +>> +>> ```bash +>> ip a +>> ``` +>> +>> ```bash +>> nmcli connection show +>> ``` +>> +>> Do not modify the existing lines in the configuration file, add your Additional IP to the file as follows, replacing `ADDITIONAL_IP/32` wih your own values: +>> +>> ```bash +>> sudo nano /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> ``` +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=ADDITIONAL_IP/32 +>> ``` +>> +>> If you have two Additional IPs to configure, the configuration should look like this: +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=ADDITIONAL_IP1/32 +>> address2=ADDITIONAL_IP2/32 +>> ``` +>> +>> /// details | **Configuration example** +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=203.0.113.1/32 +>> ``` +>> /// +>> +>> Step 3: Restart the interface +>> +>> You now need to restart your interface: +>> +>> ```bash +>> sudo systemctl restart NetworkManager +>> ``` +>> +> Debian 12 and Ubuntu 20.04+ +>> **Debian 12, Ubuntu 20.04 and following** +>> +>> By default, the configuration files are located in the `/etc/netplan` directory. +>> +>> The best practice approach is to create a separate configuration file to set up Additional IP addresses. This way, you can easily revert the changes in case of an error. +>> +>> Step 1: Determine the interface +>> +>> ```bash +>> ip a +>> ``` +>> +>> Note the name of the interface (the one on which your server's main IP address is configured). +>> +>> Step 2: Create and edit the configuration file +>> +>> Next, create a configuration file with a `.yaml` extension. In our example, our file is called `51-cloud-init.yaml`. +>> +>> ```bash +>> sudo nano /etc/netplan/51-cloud-init.yaml +>> ``` +>> +>> Edit the file with the content below, replacing `INTERFACE_NAME` and `ADDITIONAL_IP` with your own values: +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> INTERFACE_NAME: +>> dhcp4: true +>> addresses: +>> - ADDITIONAL_IP/32 +>> ``` +>> +>> If you have two Additional IPs to configure, the configuration file should look like this: +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> INTERFACE_NAME: +>> dhcp4: true +>> addresses: +>> - ADDITIONAL_IP1/32 +>> - ADDITIONAL_IP2/32 +>> ``` +>> +>> +>> > [!warning] +>> > It is important to respect the alignment of each element in this file as represented in the example above. Do not use the tab key to create your spacing. Only the space key is needed. +>> > +>> +>> /// details | **Configuration example** +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> eth0: +>> dhcp4: true +>> addresses: +>> - 203.0.113.1/32 +>> ``` +>> /// +>> +>> Save and close the file. You can test the configuration with the following command: +>> +>> ```bash +>> sudo netplan try +>> ``` +>> +>> Step 3: Apply the change +>> +>> If it is correct, apply it using the following command: +>> +>> ```bash +>> sudo netplan apply +>> ``` +>> +>> > [!primary] +>> > When using the `netplan try` command, it is possible that the system returns a warning message such as `Permissions for /etc/netplan/xx-cloud-init.yaml are too open. Netplan configuration should NOT be accessible by others`. This simply means that the file does not have restrictive permissions. This does not affect the configuration of your Additional IP. For more information about file permissions, consult the [official documentation of ubuntu](https://help.ubuntu.com/community/FilePermissions). +>> > +>> +> AlmaLinux / Rocky Linux +>> **AlmaLinux (8 & 9), Rocky Linux (8 & 9)** +>> +>> The main configuration file is located in `/etc/sysconfig/network-scripts/`. In this example it is called `ifcfg-eth0`. Before making changes, verify the actual file name in this folder. +>> +>> For each Additional IP to be configured, we create a seperate configuration file with the following parameters: `ifcfg-NETWORK_INTERFACE:ID`. Where `NETWORK_INTERFACE` is the physical interface and `ID` is the virtual network interface or ethernet alias starting with a value of 0. For example, for our interface named `eth0` the first alias is `eth0:0`, the second alias is `eth0:1`, etc... +>> +>> Step 1: Determine the interface +>> +>> ```bash +>> ip a +>> ``` +>> +>> Note the name of the interface (the one on which your server's main IP address is configured). +>> +>> Step 2: Create the configuration file +>> +>> First, create the configuration file. Replace `NETWORK_INTERFACE:ID` with your own values. +>> +>> ```bash +>> sudo nano /etc/sysconfig/network-scripts/ifcfg-NETWORK_INTERFACE:ID +>> ``` +>> +>> Next, edit the file with the content below, replacing `NETWORK_INTERFACE:ID`, and `ADDITIONAL_IP` with your own values: +>> +>> ```console +>> DEVICE=NETWORK_INTERFACE:ID +>> ONBOOT=yes +>> BOOTPROTO=none # For CentOS use "static" +>> IPADDR=ADDITIONAL_IP +>> NETMASK=255.255.255.255 +>> BROADCAST=ADDITIONAL_IP +>> ``` +>> +>> /// details | **Configuration example** +>> +>> ```console +>> DEVICE=eth0:0 +>> ONBOOT=yes +>> BOOTPROTO=none # For CentOS use "static" +>> IPADDR=203.0.113.1 +>> NETMASK=255.255.255.255 +>> BROADCAST=203.0.113.1 +>> ``` +>> /// +>> +>> Step 3: Restart the interface +>> +>> Next, restart the network interface with the following command: +>> +>> ```bash +>> sudo systemctl restart NetworkManager +>> ``` +>> +> cPanel +>> **cPanel** +>> +>> Step 1: Access the WHM IP management section +>> +>> In the WHM control panel, click on `IP Functions`{.action} and select `Add a New IP Address`{.action} in the left-hand sidebar. +>> +>> ![Add new IP](images/Cpanel-1.png){.thumbnail} +>> +>> Step 2: Add the Additional IP information +>> +>> Enter your Additional IP in the form `xxx.xxx.xxx.xxx` into the field “New IP or IP range to add”. +>> +>> Select `255.255.255.255` as your subnet mask, then click on `Submit`{.action}. +>> +>> ![enter new IP information](images/Cpanel-2024.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Please note that if you have more than one IP to configure on the same block and you add them all at once, the WHM system will force you to use the subnet mask `255.255.255.0`. We do not recommend using this configuration. Instead, you need to add each IP individually in order to use the proper subnet mask `255.255.255.255`. +>> > +>> +>> Step 3: Check the current IP configuration +>> +>> Back in the section `IP Functions`{.action}, click on `Show or Delete Current IP Addresses`{.action} to verify that the Additional IP address was added correctly. +>> +>> ![check configured IP](images/Cpanel-2024-1.png){.thumbnail} +>> +> Windows Servers +>> **Windows Servers** +>> +>> Windows servers are often DHCP-enabled in the network configuration. If you have already set up an Additional IP or switched your configuration to a fixed IP, go directly to the next step. +>> +>> Otherwise, you need to first switch from a network-level DHCP configuration to a fixed IP configuration. +>> +>> Open the command prompt `cmd`{.action} or `powershell`{.action}, then type the following command: +>> +>> ```powershell +>> ipconfig +>> ``` +>> +>> This will return a result similar to the following example: +>> +>> ![Result of "ipconfig" command](images/ipconfig.png){.thumbnail} +>> +>> Identify and write down your IPv4, subnet mask, default gateway and the name of the network interface controller (network adapter). +>> +>> In our example, the server IP is **192.0.2.28**. +>> +>> You can perform the next steps via either a command-line interface or the graphical user interface. +>> +>> **Via a command-line interface (recommended)** +>> +>> In the commands below, you need to replace: +>> +>> |Command|Value| +>> |---|---| +>> |NETWORK_ADAPTER| Name of the network adapter (in our example: Ethernet 2)| +>> |IP_ADDRESS| Server IP address (in our example: 192.0.2.28)| +>> |SUBNET_MASK| Subnet mask (in our example: 255.255.255.0)| +>> |GATEWAY| Default gateway (in our example: 192.0.2.254)| +>> |ADDITIONAL_IP| Address of Additional IP you want to add (in our example 203.0.113.1)| +>> +>> > [!warning] +>> > +>> > Be careful – the server will no longer be accessible if you enter incorrect information. You will then have to make the corrections in [Winrescue mode](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) or via the [IPMI](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). +>> > +>> +>> In the command prompt: +>> +>> 1\. Switch to a fixed IP +>> +>> ```powershell +>> netsh interface ipv4 set address name="NETWORK_ADAPTER" static IP_ADDRESS SUBNET_MASK GATEWAY +>> ``` +>> +>> 2\. Set the DNS server +>> +>> ```powershell +>> netsh interface ipv4 set dns name="NETWORK_ADAPTER" static 213.186.33.99 +>> ``` +>> +>> 3\. Add an Additional IP +>> +>> ```powershell +>> netsh interface ipv4 add address "NETWORK_ADAPTER" ADDITIONAL_IP 255.255.255.255 +>> ``` +>> +>> Your Additional IP is now functional. +>> +>> /// details | **Via the graphical user interface** +>> +>> 1. Go to `Start`{.action}> `Control Panel`{.action}>` Network and Internet`{.action}> `Network and Sharing Centre`{.action}> `Change Adapter Settings `{.action}(in the left-hand menu). +>> 2. Right-click on your network connection, in our example `Ethernet 2`{.action}. +>> 3. Click on `Properties`{.action}. +>> 4. Select `Internet Protocol Version 4 (TCP/IPv4)`{.action}, then click on `Properties`{.action}. +>> 5. Click on `Use the following IP address`{.action} and type in your server’s primary IP, subnet mask and default gateway information obtained by using the `ipconfig`{.action} command above. In the "Preferred DNS Server" box, type 213.186.33.99. +>> +>> ![Internet Protocol Version 4 (TCP/IPv4) Properties](images/configure-main-ip.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Be careful – the server will no longer be accessible if you enter incorrect information. You will then have to make the corrections in [Winrescue mode](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) or via the [IPMI](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). +>> > +>> +>> Then click on `Advanced`{.action} (still in the `TCP/IP Settings`{.action}). +>> +>> ![Internet Protocol Version 4 (TCP/IPv4) Properties](images/configure-main-ip-1.png){.thumbnail} +>> +>> In the `IP Address`{.action} section, click `Add`{.action}: +>> +>> ![Advanced TCP/IPv4 Settings](images/add-additional-ip.png){.thumbnail} +>> +>> Type in your Additional IP and the subnet mask **255.255.255.255**. Then click on `Add`{.action} +>> +>> ![TCP/IP Address](images/configure-additional-ip.png){.thumbnail} +>> +>> +>> Click on `OK`{.action} to apply your configuration. +>> +>> +>> Your Additional IP is now functional, you can verify the configuration with the following command: +>> +>> ```powershell +>> ipconfig +>> ``` +>> +>> This will return a result similar to the following example: +>> +>> ![Final configuration](images/final-ip-configuration.png){.thumbnail} +>> +>> /// +>> +> Plesk +>> **Plesk** +>> +>> Step 1: Access the Plesk IP management section +>> +>> In the Plesk control panel, choose `Tools & Settings`{.action} from the left-hand sidebar. +>> +>> ![acces to the ip addresses management](images/pleskip1.png){.thumbnail} +>> +>> Click on `IP Addresses`{.action} under **Tools & Resources**. +>> +>> Step 2: Add the Additional IP information +>> +>> In this section, click on the button `Add IP Address`{.action}. +>> +>> ![add ip information](images/Plesk-2024.png){.thumbnail} +>> +>> Enter your Additional IP in the form `xxx.xxx.xxx.xxx/32` into the field "IP address and subnet mask", then click on `OK`{.action}. +>> +>> ![add ip information](images/Plesk-2024-1.png){.thumbnail} +>> +>> Step 3: Check the current IP configuration +>> +>> Back in the section "IP Addresses", verify that the Additional IP address was added correctly. +>> +>> ![current IP configuration](images/Plesk-2024-2.png){.thumbnail} +>> ### Troubleshooting diff --git a/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.en-au.md b/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.en-au.md index 2c6e95eaf10..4e9c7201a42 100644 --- a/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.en-au.md +++ b/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.en-au.md @@ -1,9 +1,23 @@ --- title: 'Configuring IP aliasing' excerpt: 'Find out how to add Additional IP addresses to your server configuration' -updated: 2025-07-22 +updated: 2025-11-12 --- + + > [!primary] > This article is about Additional IPv4 configuration on a public interface. You can also configure Primary IPv6 addresses on your dedicated servers using [this guide](/pages/bare_metal_cloud/dedicated_servers/network_ipv6). > @@ -41,8 +55,7 @@ IP aliasing is a special network configuration for your OVHcloud dedicated serve The following sections contain configurations for the distributions we currently offer and the most commonly used distributions/operating systems. The first step is always to log in to your server via SSH or a GUI login session (RDP for a Windows server). > [!primary] -> -Concerning different distribution releases, please note that the proper procedure to configure your network interface as well as the file names may have been subject to change. We recommend to consult the manuals and knowledge resources of the respective OS versions if you experience any issues. +> Concerning different distribution releases, please note that the proper procedure to configure your network interface as well as the file names may have been subject to change. We recommend to consult the manuals and knowledge resources of the respective OS versions if you experience any issues. > **Please take note of the following terminology that will be used in code examples and instructions of the guide sections below:** @@ -55,480 +68,500 @@ Concerning different distribution releases, please note that the proper procedur In the examples below, we will use the `nano` text editor. With some operating systems, you will need to install it first before using it. If this is the case, you will be prompted to do so. You can, of course, use the text editor of your choice. -### Debian 11 - -By default, the configuration files are located in `/etc/network/interfaces.d/`. We recommend that you start by backing up the relevant configuration file. - -#### Step 1: Create a backup - -In our example, our file is called `50-cloud-init`, so we make a copy of the `50-cloud-init` file using the following command: - -```bash -sudo cp /etc/network/interfaces.d/50-cloud-init /etc/network/interfaces.d/50-cloud-init.bak -``` - -In case of a mistake, you will be able to revert the changes, using the commands below: - -```bash -sudo rm -f /etc/network/interfaces.d/50-cloud-init -sudo cp /etc/network/interfaces.d/50-cloud-init.bak /etc/network/interfaces.d/50-cloud-init -``` - -#### Step 2: Edit the configuration file - -> [!primary] -> -Note that the names of the network interfaces in our examples may differ from your own. Please adjust to your appropriate interface names. -> - -You can now modify the configuration file: - -```bash -sudo nano /etc/network/interfaces.d/50-cloud-init -``` - -Next, you need to add a virtual interface or ethernet alias. In our example, our interface is called `eth0`, so our alias is `eth0:0`. Do this for each additional IP you wish to configure. - -Do not modify the existing lines in the configuration file, simply add your Additional IP to the file as follows, replacing `ADDITIONAL_IP/32` as well as the virtual interface (if your server is not using **eth0:0**) wih your own values: - -```console -auto eth0:0 -iface eth0:0 inet static -address ADDITIONAL_IP -netmask 255.255.255.255 -``` - -Alternatively, you can configure your Additional IP by adding the following lines in the configuration file: - -```console -post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP netmask 255.255.255.255 broadcast ADDITIONAL_IP -pre-down /sbin/ifconfig eth0:0 down -``` - -With the configuration above, the virtual interface is enabled or disabled whenever the `eth0` interface is enabled or disabled. - -If you have two Additional IPs to configure, the `/etc/network/interfaces.d/50-cloud-init` file should look like this: - -```console -auto eth0 -iface eth0 inet dhcp - -auto eth0:0 -iface eth0:0 inet static -address ADDITIONAL_IP1 -netmask 255.255.255.255 - -auto eth0:1 -iface eth0:1 inet static -address ADDITIONAL_IP2 -netmask 255.255.255.255 -``` - -Or like this: - -```console -auto eth0 -iface eth0 inet dhcp - -# IP 1 -post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP1 netmask 255.255.255.255 broadcast ADDITIONAL_IP1 -pre-down /sbin/ifconfig eth0:0 down - -# IP 2 -post-up /sbin/ifconfig eth0:1 ADDITIONAL_IP2 netmask 255.255.255.255 broadcast ADDITIONAL_IP2 -pre-down /sbin/ifconfig eth0:1 down -``` - -Configuration example: - -```console -auto eth0 -iface eth0 inet dhcp - -auto eth0:0 -iface eth0:0 inet static -address 203.0.113.1 -netmask 255.255.255.255 -``` - -Or : - -```console -auto eth0 -iface eth0 inet dhcp - -# IP 1 -post-up /sbin/ifconfig eth0:0 203.0.113.1 netmask 255.255.255.255 broadcast 203.0.113.1 -pre-down /sbin/ifconfig eth0:0 down -``` - -#### Step 3: Restart the interface - -To restart the interface, use the following command: - -```bash -sudo /etc/init.d/networking restart -``` - -### Fedora 39 and following - -Fedora now uses keyfiles. NetworkManager previously stored network profiles in ifcfg format in this directory: `/etc/sysconfig/network-scripts/`. However, the ifcfg format is now deprecated. By default, NetworkManager no longer creates new profiles in this format. The configuration file is now found in `/etc/NetworkManager/system-connections/`. - -#### Step 1: Create a backup - -> [!primary] -> -> Note that the name of the network file in our example may differ from your own. Please adjust to your appropriate name. -> - -First, make a copy of the configuration file, so that you can revert at any time. In our example, our configuration file is called `cloud-init-eno1.nmconnection`. - -```bash -sudo cp -r /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak -``` - -#### Step 2: Edit the config file - -> [!primary] -> Please note that the name of the network file in our example may differ from yours. Please adapt the commands to your file name. -> - -To obtain the name of your network interface in order to edit the appropriate network file, you can run one of the following commands: - -```bash -ip a -``` - -```bash -nmcli connection show -``` - -Do not modify the existing lines in the configuration file, add your Additional IP to the file as follows, replacing `ADDITIONAL_IP/32` wih your own values: - -```bash -sudo nano /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -``` - -```console -[ipv4] -method=auto -may-fail=false -address1=ADDITIONAL_IP/32 -``` - -If you have two Additional IPs to configure, the configuration should look like this: - -```console -[ipv4] -method=auto -may-fail=false -address1=ADDITIONAL_IP1/32 -address2=ADDITIONAL_IP2/32 -``` - -Configuration example: - -```console -[ipv4] -method=auto -may-fail=false -address1=203.0.113.1/32 -``` - -#### Step 3: Restart the interface - -You now need to restart your interface: - -```bash -sudo systemctl restart NetworkManager -``` - -### Debian 12, Ubuntu 20.04 and following - -By default, the configuration files are located in the `/etc/netplan` directory. - -The best practice approach is to create a separate configuration file to set up Additional IP addresses. This way, you can easily revert the changes in case of an error. - -#### Step 1: Determine the interface - -```bash -ip a -``` - -Note the name of the interface (the one on which your server's main IP address is configured). - -#### Step 2: Create and edit the configuration file - -Next, create a configuration file with a `.yaml` extension. In our example, our file is called `51-cloud-init.yaml`. - -```bash -sudo nano /etc/netplan/51-cloud-init.yaml -``` - -Edit the file with the content below, replacing `INTERFACE_NAME` and `ADDITIONAL_IP` with your own values: - -```yaml -network: - version: 2 - ethernets: - INTERFACE_NAME: - dhcp4: true - addresses: - - ADDITIONAL_IP/32 -``` - -If you have two Additional IPs to configure, the configuration file should look like this: - -```yaml -network: - version: 2 - ethernets: - INTERFACE_NAME: - dhcp4: true - addresses: - - ADDITIONAL_IP1/32 - - ADDITIONAL_IP2/32 -``` - -> [!warning] -> It is important to respect the alignment of each element in this file as represented in the example above. Do not use the tab key to create your spacing. Only the space key is needed. +> [!success] +> Select the tab corresponding to your operating system. > -Configuration example: - -```yaml -network: - version: 2 - ethernets: - eth0: - dhcp4: true - addresses: - - 203.0.113.1/32 -``` - -Save and close the file. You can test the configuration with the following command: - -```bash -sudo netplan try -``` - -#### Step 3: Apply the change - -If it is correct, apply it using the following command: - -```bash -sudo netplan apply -``` - -> [!primary] -> When using the `netplan try` command, it is possible that the system returns a warning message such as `Permissions for /etc/netplan/xx-cloud-init.yaml are too open. Netplan configuration should NOT be accessible by others`. This simply means that the file does not have restrictive permissions. This does not affect the configuration of your Additional IP. For more information about file permissions, consult the [official documentation of ubuntu](https://help.ubuntu.com/community/FilePermissions). -> - -### AlmaLinux (8 & 9), Rocky Linux (8 & 9) - -The main configuration file is located in `/etc/sysconfig/network-scripts/`. In this example it is called `ifcfg-eth0`. Before making changes, verify the actual file name in this folder. - -For each Additional IP to be configured, we create a seperate configuration file with the following parameters: `ifcfg-NETWORK_INTERFACE:ID`. Where `NETWORK_INTERFACE` is the physical interface and `ID` is the virtual network interface or ethernet alias starting with a value of 0. For example, for our interface named `eth0` the first alias is `eth0:0`, the second alias is `eth0:1`, etc... - -#### Step 1: Determine the interface - -```bash -ip a -``` - -Note the name of the interface (the one on which your server's main IP address is configured). - -#### Step 2: Create the configuration file - -First, create the configuration file. Replace `NETWORK_INTERFACE:ID` with your own values. - -```bash -sudo nano /etc/sysconfig/network-scripts/ifcfg-NETWORK_INTERFACE:ID -``` - -Next, edit the file with the content below, replacing `NETWORK_INTERFACE:ID`, and `ADDITIONAL_IP` with your own values: - -```console -DEVICE=NETWORK_INTERFACE:ID -ONBOOT=yes -BOOTPROTO=none # For CentOS use "static" -IPADDR=ADDITIONAL_IP -NETMASK=255.255.255.255 -BROADCAST=ADDITIONAL_IP -``` - -Configuration example: - -```console -DEVICE=eth0:0 -ONBOOT=yes -BOOTPROTO=none # For CentOS use "static" -IPADDR=203.0.113.1 -NETMASK=255.255.255.255 -BROADCAST=203.0.113.1 -``` - -#### Step 3: Restart the interface - -Next, restart the network interface with the following command: - -```bash -sudo systemctl restart NetworkManager -``` - -### cPanel - -#### Step 1: Access the WHM IP management section - -In the WHM control panel, click on `IP Functions`{.action} and select `Add a New IP Address`{.action} in the left-hand sidebar. - -![Add new IP](images/Cpanel-1.png){.thumbnail} - -#### Step 2: Add the Additional IP information - -Enter your Additional IP in the form `xxx.xxx.xxx.xxx` into the field “New IP or IP range to add”. - -Select `255.255.255.255` as your subnet mask, then click on `Submit`{.action}. - -![enter new IP information](images/Cpanel-2024.png){.thumbnail} - -> [!warning] -> -> Please note that if you have more than one IP to configure on the same block and you add them all at once, the WHM system will force you to use the subnet mask `255.255.255.0`. We do not recommend using this configuration. Instead, you need to add each IP individually in order to use the proper subnet mask `255.255.255.255`. -> - -#### Step 3: Check the current IP configuration - -Back in the section `IP Functions`{.action}, click on `Show or Delete Current IP Addresses`{.action} to verify that the Additional IP address was added correctly. - -![check configured IP](images/Cpanel-2024-1.png){.thumbnail} - -### Windows Servers - -Windows servers are often DHCP-enabled in the network configuration. If you have already set up an Additional IP or switched your configuration to a fixed IP, go directly to the next step. - -Otherwise, you need to first switch from a network-level DHCP configuration to a fixed IP configuration. - -Open the command prompt `cmd`{.action} or `powershell`{.action}, then type the following command: - -```powershell -ipconfig -``` - -This will return a result similar to the following example: - -![Result of "ipconfig" command](images/ipconfig.png){.thumbnail} - -Identify and write down your IPv4, subnet mask, default gateway and the name of the network interface controller (network adapter). - -In our example, the server IP is **192.0.2.28**. - -You can perform the next steps via either a command-line interface or the graphical user interface. - -#### Via a command-line interface (recommended) - -In the commands below, you need to replace: - -|Command|Value| -|---|---| -|NETWORK_ADAPTER| Name of the network adapter (in our example: Ethernet 2)| -|IP_ADDRESS| Server IP address (in our example: 192.0.2.28)| -|SUBNET_MASK| Subnet mask (in our example: 255.255.255.0)| -|GATEWAY| Default gateway (in our example: 192.0.2.254)| -|ADDITIONAL_IP| Address of Additional IP you want to add (in our example 203.0.113.1)| - -> [!warning] -> -> Be careful – the server will no longer be accessible if you enter incorrect information. You will then have to make the corrections in [Winrescue mode](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) or via the [IPMI](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). -> - -In the command prompt: - -1\. Switch to a fixed IP - -```powershell -netsh interface ipv4 set address name="NETWORK_ADAPTER" static IP_ADDRESS SUBNET_MASK GATEWAY -``` - -2\. Set the DNS server - -```powershell -netsh interface ipv4 set dns name="NETWORK_ADAPTER" static 213.186.33.99 -``` - -3\. Add an Additional IP - -```powershell -netsh interface ipv4 add address "NETWORK_ADAPTER" ADDITIONAL_IP 255.255.255.255 -``` - -Your Additional IP is now functional. - -#### Via the graphical user interface - -1. Go to `Start`{.action}> `Control Panel`{.action}>` Network and Internet`{.action}> `Network and Sharing Centre`{.action}> `Change Adapter Settings `{.action}(in the left-hand menu). -2. Right-click on your network connection, in our example `Ethernet 2`{.action}. -3. Click on `Properties`{.action}. -4. Select `Internet Protocol Version 4 (TCP/IPv4)`{.action}, then click on `Properties`{.action}. -5. Click on `Use the following IP address`{.action} and type in your server’s primary IP, subnet mask and default gateway information obtained by using the `ipconfig`{.action} command above. In the "Preferred DNS Server" box, type 213.186.33.99. - -![Internet Protocol Version 4 (TCP/IPv4) Properties](images/configure-main-ip.png){.thumbnail} - -> [!warning] -> -> Be careful – the server will no longer be accessible if you enter incorrect information. You will then have to make the corrections in [Winrescue mode](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) or via the [IPMI](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). -> - -Then click on `Advanced`{.action} (still in the `TCP/IP Settings`{.action}). - -![Internet Protocol Version 4 (TCP/IPv4) Properties](images/configure-main-ip-1.png){.thumbnail} - -In the `IP Address`{.action} section, click `Add`{.action}: - -![Advanced TCP/IPv4 Settings](images/add-additional-ip.png){.thumbnail} - -Type in your Additional IP and the subnet mask **255.255.255.255**. Then click on `Add`{.action} - -![TCP/IP Address](images/configure-additional-ip.png){.thumbnail} - - -Click on `OK`{.action} to apply your configuration. - -Your Additional IP is now functional, you can verify the configuration with the following command: - -```powershell -ipconfig -``` - -This will return a result similar to the following example: - -![Final configuration](images/final-ip-configuration.png){.thumbnail} - -### Plesk - -#### Step 1: Access the Plesk IP management section - -In the Plesk control panel, choose `Tools & Settings`{.action} from the left-hand sidebar. - -![acces to the ip addresses management](images/pleskip1.png){.thumbnail} - -Click on `IP Addresses`{.action} under **Tools & Resources**. - -#### Step 2: Add the Additional IP information - -In this section, click on the button `Add IP Address`{.action}. - -![add ip information](images/Plesk-2024.png){.thumbnail} - -Enter your Additional IP in the form `xxx.xxx.xxx.xxx/32` into the field "IP address and subnet mask", then click on `OK`{.action}. - -![add ip information](images/Plesk-2024-1.png){.thumbnail} - -#### Step 3: Check the current IP configuration - -Back in the section "IP Addresses", verify that the Additional IP address was added correctly. - -![current IP configuration](images/Plesk-2024-2.png){.thumbnail} +> [!tabs] +> Debian 11 +>> **Debian 11** +>> +>> By default, the configuration files are located in `/etc/network/interfaces.d/`. We recommend that you start by backing up the relevant configuration file. +>> +>> Step 1: Create a backup +>> +>> In our example, our file is called `50-cloud-init`, so we make a copy of the `50-cloud-init` file using the following command: +>> +>> ```bash +>> sudo cp /etc/network/interfaces.d/50-cloud-init /etc/network/interfaces.d/50-cloud-init.bak +>> ``` +>> +>> In case of a mistake, you will be able to revert the changes, using the commands below: +>> +>> ```bash +>> sudo rm -f /etc/network/interfaces.d/50-cloud-init +>> sudo cp /etc/network/interfaces.d/50-cloud-init.bak /etc/network/interfaces.d/50-cloud-init +>> ``` +>> +>> Step 2: Edit the configuration file +>> +>> > [!primary] +>> > Note that the names of the network interfaces in our examples may differ from your own. Please adjust to your appropriate interface names. +>> > +>> +>> You can now modify the configuration file: +>> +>> ```bash +>> sudo nano /etc/network/interfaces.d/50-cloud-init +>> ``` +>> +>> Next, you need to add a virtual interface or ethernet alias. In our example, our interface is called `eth0`, so our alias is `eth0:0`. Do this for each additional IP you wish to configure. +>> +>> Do not modify the existing lines in the configuration file, simply add your Additional IP to the file as follows, replacing `ADDITIONAL_IP/32` as well as the virtual interface (if your server is not using **eth0:0**) wih your own values: +>> +>> ```console +>> auto eth0:0 +>> iface eth0:0 inet static +>> address ADDITIONAL_IP +>> netmask 255.255.255.255 +>> ``` +>> +>> Alternatively, you can configure your Additional IP by adding the following lines in the configuration file: +>> +>> ```console +>> post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP netmask 255.255.255.255 broadcast ADDITIONAL_IP +>> pre-down /sbin/ifconfig eth0:0 down +>> ``` +>> +>> With the configuration above, the virtual interface is enabled or disabled whenever the `eth0` interface is enabled or disabled. +>> +>> If you have two Additional IPs to configure, the `/etc/network/interfaces.d/50-cloud-init` file should look like this: +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> auto eth0:0 +>> iface eth0:0 inet static +>> address ADDITIONAL_IP1 +>> netmask 255.255.255.255 +>> +>> auto eth0:1 +>> iface eth0:1 inet static +>> address ADDITIONAL_IP2 +>> netmask 255.255.255.255 +>> ``` +>> +>> Or like this: +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> # IP 1 +>> post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP1 netmask 255.255.255.255 broadcast ADDITIONAL_IP1 +>> pre-down /sbin/ifconfig eth0:0 down +>> +>> # IP 2 +>> post-up /sbin/ifconfig eth0:1 ADDITIONAL_IP2 netmask 255.255.255.255 broadcast ADDITIONAL_IP2 +>> pre-down /sbin/ifconfig eth0:1 down +>> ``` +>> +>> /// details | **Configuration example** +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> auto eth0:0 +>> iface eth0:0 inet static +>> address 203.0.113.1 +>> netmask 255.255.255.255 +>> ``` +>> +>> Or: +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> # IP 1 +>> post-up /sbin/ifconfig eth0:0 203.0.113.1 netmask 255.255.255.255 broadcast 203.0.113.1 +>> pre-down /sbin/ifconfig eth0:0 down +>> ``` +>> /// +>> +>> Step 3: Restart the interface +>> +>> To restart the interface, use the following command: +>> +>> ```bash +>> sudo /etc/init.d/networking restart +>> ``` +>> +> Fedora 41+ +>> **Fedora 41 and following** +>> +>> Fedora now uses keyfiles. NetworkManager previously stored network profiles in ifcfg format in this directory: `/etc/sysconfig/network-scripts/`. However, the ifcfg format is now deprecated. By default, NetworkManager no longer creates new profiles in this format. The configuration file is now found in `/etc/NetworkManager/system-connections/`. +>> +>> Step 1: Create a backup +>> +>> > [!primary] +>> > +>> > Note that the name of the network file in our example may differ from your own. Please adjust to your appropriate name. +>> > +>> +>> First, make a copy of the configuration file, so that you can revert at any time. In our example, our configuration file is called `cloud-init-eno1.nmconnection`. +>> +>> ```bash +>> sudo cp -r /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak +>> ``` +>> +>> Step 2: Edit the config file +>> +>> > [!primary] +>> > Please note that the name of the network file in our example may differ from yours. Please adapt the commands to your file name. +>> > +>> +>> To obtain the name of your network interface in order to edit the appropriate network file, you can run one of the following commands: +>> +>> ```bash +>> ip a +>> ``` +>> +>> ```bash +>> nmcli connection show +>> ``` +>> +>> Do not modify the existing lines in the configuration file, add your Additional IP to the file as follows, replacing `ADDITIONAL_IP/32` wih your own values: +>> +>> ```bash +>> sudo nano /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> ``` +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=ADDITIONAL_IP/32 +>> ``` +>> +>> If you have two Additional IPs to configure, the configuration should look like this: +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=ADDITIONAL_IP1/32 +>> address2=ADDITIONAL_IP2/32 +>> ``` +>> +>> /// details | **Configuration example** +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=203.0.113.1/32 +>> ``` +>> /// +>> +>> Step 3: Restart the interface +>> +>> You now need to restart your interface: +>> +>> ```bash +>> sudo systemctl restart NetworkManager +>> ``` +>> +> Debian 12 and Ubuntu 20.04+ +>> **Debian 12, Ubuntu 20.04 and following** +>> +>> By default, the configuration files are located in the `/etc/netplan` directory. +>> +>> The best practice approach is to create a separate configuration file to set up Additional IP addresses. This way, you can easily revert the changes in case of an error. +>> +>> Step 1: Determine the interface +>> +>> ```bash +>> ip a +>> ``` +>> +>> Note the name of the interface (the one on which your server's main IP address is configured). +>> +>> Step 2: Create and edit the configuration file +>> +>> Next, create a configuration file with a `.yaml` extension. In our example, our file is called `51-cloud-init.yaml`. +>> +>> ```bash +>> sudo nano /etc/netplan/51-cloud-init.yaml +>> ``` +>> +>> Edit the file with the content below, replacing `INTERFACE_NAME` and `ADDITIONAL_IP` with your own values: +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> INTERFACE_NAME: +>> dhcp4: true +>> addresses: +>> - ADDITIONAL_IP/32 +>> ``` +>> +>> If you have two Additional IPs to configure, the configuration file should look like this: +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> INTERFACE_NAME: +>> dhcp4: true +>> addresses: +>> - ADDITIONAL_IP1/32 +>> - ADDITIONAL_IP2/32 +>> ``` +>> +>> +>> > [!warning] +>> > It is important to respect the alignment of each element in this file as represented in the example above. Do not use the tab key to create your spacing. Only the space key is needed. +>> > +>> +>> /// details | **Configuration example** +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> eth0: +>> dhcp4: true +>> addresses: +>> - 203.0.113.1/32 +>> ``` +>> /// +>> +>> Save and close the file. You can test the configuration with the following command: +>> +>> ```bash +>> sudo netplan try +>> ``` +>> +>> Step 3: Apply the change +>> +>> If it is correct, apply it using the following command: +>> +>> ```bash +>> sudo netplan apply +>> ``` +>> +>> > [!primary] +>> > When using the `netplan try` command, it is possible that the system returns a warning message such as `Permissions for /etc/netplan/xx-cloud-init.yaml are too open. Netplan configuration should NOT be accessible by others`. This simply means that the file does not have restrictive permissions. This does not affect the configuration of your Additional IP. For more information about file permissions, consult the [official documentation of ubuntu](https://help.ubuntu.com/community/FilePermissions). +>> > +>> +> AlmaLinux / Rocky Linux +>> **AlmaLinux (8 & 9), Rocky Linux (8 & 9)** +>> +>> The main configuration file is located in `/etc/sysconfig/network-scripts/`. In this example it is called `ifcfg-eth0`. Before making changes, verify the actual file name in this folder. +>> +>> For each Additional IP to be configured, we create a seperate configuration file with the following parameters: `ifcfg-NETWORK_INTERFACE:ID`. Where `NETWORK_INTERFACE` is the physical interface and `ID` is the virtual network interface or ethernet alias starting with a value of 0. For example, for our interface named `eth0` the first alias is `eth0:0`, the second alias is `eth0:1`, etc... +>> +>> Step 1: Determine the interface +>> +>> ```bash +>> ip a +>> ``` +>> +>> Note the name of the interface (the one on which your server's main IP address is configured). +>> +>> Step 2: Create the configuration file +>> +>> First, create the configuration file. Replace `NETWORK_INTERFACE:ID` with your own values. +>> +>> ```bash +>> sudo nano /etc/sysconfig/network-scripts/ifcfg-NETWORK_INTERFACE:ID +>> ``` +>> +>> Next, edit the file with the content below, replacing `NETWORK_INTERFACE:ID`, and `ADDITIONAL_IP` with your own values: +>> +>> ```console +>> DEVICE=NETWORK_INTERFACE:ID +>> ONBOOT=yes +>> BOOTPROTO=none # For CentOS use "static" +>> IPADDR=ADDITIONAL_IP +>> NETMASK=255.255.255.255 +>> BROADCAST=ADDITIONAL_IP +>> ``` +>> +>> /// details | **Configuration example** +>> +>> ```console +>> DEVICE=eth0:0 +>> ONBOOT=yes +>> BOOTPROTO=none # For CentOS use "static" +>> IPADDR=203.0.113.1 +>> NETMASK=255.255.255.255 +>> BROADCAST=203.0.113.1 +>> ``` +>> /// +>> +>> Step 3: Restart the interface +>> +>> Next, restart the network interface with the following command: +>> +>> ```bash +>> sudo systemctl restart NetworkManager +>> ``` +>> +> cPanel +>> **cPanel** +>> +>> Step 1: Access the WHM IP management section +>> +>> In the WHM control panel, click on `IP Functions`{.action} and select `Add a New IP Address`{.action} in the left-hand sidebar. +>> +>> ![Add new IP](images/Cpanel-1.png){.thumbnail} +>> +>> Step 2: Add the Additional IP information +>> +>> Enter your Additional IP in the form `xxx.xxx.xxx.xxx` into the field “New IP or IP range to add”. +>> +>> Select `255.255.255.255` as your subnet mask, then click on `Submit`{.action}. +>> +>> ![enter new IP information](images/Cpanel-2024.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Please note that if you have more than one IP to configure on the same block and you add them all at once, the WHM system will force you to use the subnet mask `255.255.255.0`. We do not recommend using this configuration. Instead, you need to add each IP individually in order to use the proper subnet mask `255.255.255.255`. +>> > +>> +>> Step 3: Check the current IP configuration +>> +>> Back in the section `IP Functions`{.action}, click on `Show or Delete Current IP Addresses`{.action} to verify that the Additional IP address was added correctly. +>> +>> ![check configured IP](images/Cpanel-2024-1.png){.thumbnail} +>> +> Windows Servers +>> **Windows Servers** +>> +>> Windows servers are often DHCP-enabled in the network configuration. If you have already set up an Additional IP or switched your configuration to a fixed IP, go directly to the next step. +>> +>> Otherwise, you need to first switch from a network-level DHCP configuration to a fixed IP configuration. +>> +>> Open the command prompt `cmd`{.action} or `powershell`{.action}, then type the following command: +>> +>> ```powershell +>> ipconfig +>> ``` +>> +>> This will return a result similar to the following example: +>> +>> ![Result of "ipconfig" command](images/ipconfig.png){.thumbnail} +>> +>> Identify and write down your IPv4, subnet mask, default gateway and the name of the network interface controller (network adapter). +>> +>> In our example, the server IP is **192.0.2.28**. +>> +>> You can perform the next steps via either a command-line interface or the graphical user interface. +>> +>> **Via a command-line interface (recommended)** +>> +>> In the commands below, you need to replace: +>> +>> |Command|Value| +>> |---|---| +>> |NETWORK_ADAPTER| Name of the network adapter (in our example: Ethernet 2)| +>> |IP_ADDRESS| Server IP address (in our example: 192.0.2.28)| +>> |SUBNET_MASK| Subnet mask (in our example: 255.255.255.0)| +>> |GATEWAY| Default gateway (in our example: 192.0.2.254)| +>> |ADDITIONAL_IP| Address of Additional IP you want to add (in our example 203.0.113.1)| +>> +>> > [!warning] +>> > +>> > Be careful – the server will no longer be accessible if you enter incorrect information. You will then have to make the corrections in [Winrescue mode](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) or via the [IPMI](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). +>> > +>> +>> In the command prompt: +>> +>> 1\. Switch to a fixed IP +>> +>> ```powershell +>> netsh interface ipv4 set address name="NETWORK_ADAPTER" static IP_ADDRESS SUBNET_MASK GATEWAY +>> ``` +>> +>> 2\. Set the DNS server +>> +>> ```powershell +>> netsh interface ipv4 set dns name="NETWORK_ADAPTER" static 213.186.33.99 +>> ``` +>> +>> 3\. Add an Additional IP +>> +>> ```powershell +>> netsh interface ipv4 add address "NETWORK_ADAPTER" ADDITIONAL_IP 255.255.255.255 +>> ``` +>> +>> Your Additional IP is now functional. +>> +>> /// details | **Via the graphical user interface** +>> +>> 1. Go to `Start`{.action}> `Control Panel`{.action}>` Network and Internet`{.action}> `Network and Sharing Centre`{.action}> `Change Adapter Settings `{.action}(in the left-hand menu). +>> 2. Right-click on your network connection, in our example `Ethernet 2`{.action}. +>> 3. Click on `Properties`{.action}. +>> 4. Select `Internet Protocol Version 4 (TCP/IPv4)`{.action}, then click on `Properties`{.action}. +>> 5. Click on `Use the following IP address`{.action} and type in your server’s primary IP, subnet mask and default gateway information obtained by using the `ipconfig`{.action} command above. In the "Preferred DNS Server" box, type 213.186.33.99. +>> +>> ![Internet Protocol Version 4 (TCP/IPv4) Properties](images/configure-main-ip.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Be careful – the server will no longer be accessible if you enter incorrect information. You will then have to make the corrections in [Winrescue mode](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) or via the [IPMI](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). +>> > +>> +>> Then click on `Advanced`{.action} (still in the `TCP/IP Settings`{.action}). +>> +>> ![Internet Protocol Version 4 (TCP/IPv4) Properties](images/configure-main-ip-1.png){.thumbnail} +>> +>> In the `IP Address`{.action} section, click `Add`{.action}: +>> +>> ![Advanced TCP/IPv4 Settings](images/add-additional-ip.png){.thumbnail} +>> +>> Type in your Additional IP and the subnet mask **255.255.255.255**. Then click on `Add`{.action} +>> +>> ![TCP/IP Address](images/configure-additional-ip.png){.thumbnail} +>> +>> +>> Click on `OK`{.action} to apply your configuration. +>> +>> +>> Your Additional IP is now functional, you can verify the configuration with the following command: +>> +>> ```powershell +>> ipconfig +>> ``` +>> +>> This will return a result similar to the following example: +>> +>> ![Final configuration](images/final-ip-configuration.png){.thumbnail} +>> +>> /// +>> +> Plesk +>> **Plesk** +>> +>> Step 1: Access the Plesk IP management section +>> +>> In the Plesk control panel, choose `Tools & Settings`{.action} from the left-hand sidebar. +>> +>> ![acces to the ip addresses management](images/pleskip1.png){.thumbnail} +>> +>> Click on `IP Addresses`{.action} under **Tools & Resources**. +>> +>> Step 2: Add the Additional IP information +>> +>> In this section, click on the button `Add IP Address`{.action}. +>> +>> ![add ip information](images/Plesk-2024.png){.thumbnail} +>> +>> Enter your Additional IP in the form `xxx.xxx.xxx.xxx/32` into the field "IP address and subnet mask", then click on `OK`{.action}. +>> +>> ![add ip information](images/Plesk-2024-1.png){.thumbnail} +>> +>> Step 3: Check the current IP configuration +>> +>> Back in the section "IP Addresses", verify that the Additional IP address was added correctly. +>> +>> ![current IP configuration](images/Plesk-2024-2.png){.thumbnail} +>> ### Troubleshooting diff --git a/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.en-ca.md b/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.en-ca.md index 2c6e95eaf10..4e9c7201a42 100644 --- a/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.en-ca.md +++ b/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.en-ca.md @@ -1,9 +1,23 @@ --- title: 'Configuring IP aliasing' excerpt: 'Find out how to add Additional IP addresses to your server configuration' -updated: 2025-07-22 +updated: 2025-11-12 --- + + > [!primary] > This article is about Additional IPv4 configuration on a public interface. You can also configure Primary IPv6 addresses on your dedicated servers using [this guide](/pages/bare_metal_cloud/dedicated_servers/network_ipv6). > @@ -41,8 +55,7 @@ IP aliasing is a special network configuration for your OVHcloud dedicated serve The following sections contain configurations for the distributions we currently offer and the most commonly used distributions/operating systems. The first step is always to log in to your server via SSH or a GUI login session (RDP for a Windows server). > [!primary] -> -Concerning different distribution releases, please note that the proper procedure to configure your network interface as well as the file names may have been subject to change. We recommend to consult the manuals and knowledge resources of the respective OS versions if you experience any issues. +> Concerning different distribution releases, please note that the proper procedure to configure your network interface as well as the file names may have been subject to change. We recommend to consult the manuals and knowledge resources of the respective OS versions if you experience any issues. > **Please take note of the following terminology that will be used in code examples and instructions of the guide sections below:** @@ -55,480 +68,500 @@ Concerning different distribution releases, please note that the proper procedur In the examples below, we will use the `nano` text editor. With some operating systems, you will need to install it first before using it. If this is the case, you will be prompted to do so. You can, of course, use the text editor of your choice. -### Debian 11 - -By default, the configuration files are located in `/etc/network/interfaces.d/`. We recommend that you start by backing up the relevant configuration file. - -#### Step 1: Create a backup - -In our example, our file is called `50-cloud-init`, so we make a copy of the `50-cloud-init` file using the following command: - -```bash -sudo cp /etc/network/interfaces.d/50-cloud-init /etc/network/interfaces.d/50-cloud-init.bak -``` - -In case of a mistake, you will be able to revert the changes, using the commands below: - -```bash -sudo rm -f /etc/network/interfaces.d/50-cloud-init -sudo cp /etc/network/interfaces.d/50-cloud-init.bak /etc/network/interfaces.d/50-cloud-init -``` - -#### Step 2: Edit the configuration file - -> [!primary] -> -Note that the names of the network interfaces in our examples may differ from your own. Please adjust to your appropriate interface names. -> - -You can now modify the configuration file: - -```bash -sudo nano /etc/network/interfaces.d/50-cloud-init -``` - -Next, you need to add a virtual interface or ethernet alias. In our example, our interface is called `eth0`, so our alias is `eth0:0`. Do this for each additional IP you wish to configure. - -Do not modify the existing lines in the configuration file, simply add your Additional IP to the file as follows, replacing `ADDITIONAL_IP/32` as well as the virtual interface (if your server is not using **eth0:0**) wih your own values: - -```console -auto eth0:0 -iface eth0:0 inet static -address ADDITIONAL_IP -netmask 255.255.255.255 -``` - -Alternatively, you can configure your Additional IP by adding the following lines in the configuration file: - -```console -post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP netmask 255.255.255.255 broadcast ADDITIONAL_IP -pre-down /sbin/ifconfig eth0:0 down -``` - -With the configuration above, the virtual interface is enabled or disabled whenever the `eth0` interface is enabled or disabled. - -If you have two Additional IPs to configure, the `/etc/network/interfaces.d/50-cloud-init` file should look like this: - -```console -auto eth0 -iface eth0 inet dhcp - -auto eth0:0 -iface eth0:0 inet static -address ADDITIONAL_IP1 -netmask 255.255.255.255 - -auto eth0:1 -iface eth0:1 inet static -address ADDITIONAL_IP2 -netmask 255.255.255.255 -``` - -Or like this: - -```console -auto eth0 -iface eth0 inet dhcp - -# IP 1 -post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP1 netmask 255.255.255.255 broadcast ADDITIONAL_IP1 -pre-down /sbin/ifconfig eth0:0 down - -# IP 2 -post-up /sbin/ifconfig eth0:1 ADDITIONAL_IP2 netmask 255.255.255.255 broadcast ADDITIONAL_IP2 -pre-down /sbin/ifconfig eth0:1 down -``` - -Configuration example: - -```console -auto eth0 -iface eth0 inet dhcp - -auto eth0:0 -iface eth0:0 inet static -address 203.0.113.1 -netmask 255.255.255.255 -``` - -Or : - -```console -auto eth0 -iface eth0 inet dhcp - -# IP 1 -post-up /sbin/ifconfig eth0:0 203.0.113.1 netmask 255.255.255.255 broadcast 203.0.113.1 -pre-down /sbin/ifconfig eth0:0 down -``` - -#### Step 3: Restart the interface - -To restart the interface, use the following command: - -```bash -sudo /etc/init.d/networking restart -``` - -### Fedora 39 and following - -Fedora now uses keyfiles. NetworkManager previously stored network profiles in ifcfg format in this directory: `/etc/sysconfig/network-scripts/`. However, the ifcfg format is now deprecated. By default, NetworkManager no longer creates new profiles in this format. The configuration file is now found in `/etc/NetworkManager/system-connections/`. - -#### Step 1: Create a backup - -> [!primary] -> -> Note that the name of the network file in our example may differ from your own. Please adjust to your appropriate name. -> - -First, make a copy of the configuration file, so that you can revert at any time. In our example, our configuration file is called `cloud-init-eno1.nmconnection`. - -```bash -sudo cp -r /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak -``` - -#### Step 2: Edit the config file - -> [!primary] -> Please note that the name of the network file in our example may differ from yours. Please adapt the commands to your file name. -> - -To obtain the name of your network interface in order to edit the appropriate network file, you can run one of the following commands: - -```bash -ip a -``` - -```bash -nmcli connection show -``` - -Do not modify the existing lines in the configuration file, add your Additional IP to the file as follows, replacing `ADDITIONAL_IP/32` wih your own values: - -```bash -sudo nano /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -``` - -```console -[ipv4] -method=auto -may-fail=false -address1=ADDITIONAL_IP/32 -``` - -If you have two Additional IPs to configure, the configuration should look like this: - -```console -[ipv4] -method=auto -may-fail=false -address1=ADDITIONAL_IP1/32 -address2=ADDITIONAL_IP2/32 -``` - -Configuration example: - -```console -[ipv4] -method=auto -may-fail=false -address1=203.0.113.1/32 -``` - -#### Step 3: Restart the interface - -You now need to restart your interface: - -```bash -sudo systemctl restart NetworkManager -``` - -### Debian 12, Ubuntu 20.04 and following - -By default, the configuration files are located in the `/etc/netplan` directory. - -The best practice approach is to create a separate configuration file to set up Additional IP addresses. This way, you can easily revert the changes in case of an error. - -#### Step 1: Determine the interface - -```bash -ip a -``` - -Note the name of the interface (the one on which your server's main IP address is configured). - -#### Step 2: Create and edit the configuration file - -Next, create a configuration file with a `.yaml` extension. In our example, our file is called `51-cloud-init.yaml`. - -```bash -sudo nano /etc/netplan/51-cloud-init.yaml -``` - -Edit the file with the content below, replacing `INTERFACE_NAME` and `ADDITIONAL_IP` with your own values: - -```yaml -network: - version: 2 - ethernets: - INTERFACE_NAME: - dhcp4: true - addresses: - - ADDITIONAL_IP/32 -``` - -If you have two Additional IPs to configure, the configuration file should look like this: - -```yaml -network: - version: 2 - ethernets: - INTERFACE_NAME: - dhcp4: true - addresses: - - ADDITIONAL_IP1/32 - - ADDITIONAL_IP2/32 -``` - -> [!warning] -> It is important to respect the alignment of each element in this file as represented in the example above. Do not use the tab key to create your spacing. Only the space key is needed. +> [!success] +> Select the tab corresponding to your operating system. > -Configuration example: - -```yaml -network: - version: 2 - ethernets: - eth0: - dhcp4: true - addresses: - - 203.0.113.1/32 -``` - -Save and close the file. You can test the configuration with the following command: - -```bash -sudo netplan try -``` - -#### Step 3: Apply the change - -If it is correct, apply it using the following command: - -```bash -sudo netplan apply -``` - -> [!primary] -> When using the `netplan try` command, it is possible that the system returns a warning message such as `Permissions for /etc/netplan/xx-cloud-init.yaml are too open. Netplan configuration should NOT be accessible by others`. This simply means that the file does not have restrictive permissions. This does not affect the configuration of your Additional IP. For more information about file permissions, consult the [official documentation of ubuntu](https://help.ubuntu.com/community/FilePermissions). -> - -### AlmaLinux (8 & 9), Rocky Linux (8 & 9) - -The main configuration file is located in `/etc/sysconfig/network-scripts/`. In this example it is called `ifcfg-eth0`. Before making changes, verify the actual file name in this folder. - -For each Additional IP to be configured, we create a seperate configuration file with the following parameters: `ifcfg-NETWORK_INTERFACE:ID`. Where `NETWORK_INTERFACE` is the physical interface and `ID` is the virtual network interface or ethernet alias starting with a value of 0. For example, for our interface named `eth0` the first alias is `eth0:0`, the second alias is `eth0:1`, etc... - -#### Step 1: Determine the interface - -```bash -ip a -``` - -Note the name of the interface (the one on which your server's main IP address is configured). - -#### Step 2: Create the configuration file - -First, create the configuration file. Replace `NETWORK_INTERFACE:ID` with your own values. - -```bash -sudo nano /etc/sysconfig/network-scripts/ifcfg-NETWORK_INTERFACE:ID -``` - -Next, edit the file with the content below, replacing `NETWORK_INTERFACE:ID`, and `ADDITIONAL_IP` with your own values: - -```console -DEVICE=NETWORK_INTERFACE:ID -ONBOOT=yes -BOOTPROTO=none # For CentOS use "static" -IPADDR=ADDITIONAL_IP -NETMASK=255.255.255.255 -BROADCAST=ADDITIONAL_IP -``` - -Configuration example: - -```console -DEVICE=eth0:0 -ONBOOT=yes -BOOTPROTO=none # For CentOS use "static" -IPADDR=203.0.113.1 -NETMASK=255.255.255.255 -BROADCAST=203.0.113.1 -``` - -#### Step 3: Restart the interface - -Next, restart the network interface with the following command: - -```bash -sudo systemctl restart NetworkManager -``` - -### cPanel - -#### Step 1: Access the WHM IP management section - -In the WHM control panel, click on `IP Functions`{.action} and select `Add a New IP Address`{.action} in the left-hand sidebar. - -![Add new IP](images/Cpanel-1.png){.thumbnail} - -#### Step 2: Add the Additional IP information - -Enter your Additional IP in the form `xxx.xxx.xxx.xxx` into the field “New IP or IP range to add”. - -Select `255.255.255.255` as your subnet mask, then click on `Submit`{.action}. - -![enter new IP information](images/Cpanel-2024.png){.thumbnail} - -> [!warning] -> -> Please note that if you have more than one IP to configure on the same block and you add them all at once, the WHM system will force you to use the subnet mask `255.255.255.0`. We do not recommend using this configuration. Instead, you need to add each IP individually in order to use the proper subnet mask `255.255.255.255`. -> - -#### Step 3: Check the current IP configuration - -Back in the section `IP Functions`{.action}, click on `Show or Delete Current IP Addresses`{.action} to verify that the Additional IP address was added correctly. - -![check configured IP](images/Cpanel-2024-1.png){.thumbnail} - -### Windows Servers - -Windows servers are often DHCP-enabled in the network configuration. If you have already set up an Additional IP or switched your configuration to a fixed IP, go directly to the next step. - -Otherwise, you need to first switch from a network-level DHCP configuration to a fixed IP configuration. - -Open the command prompt `cmd`{.action} or `powershell`{.action}, then type the following command: - -```powershell -ipconfig -``` - -This will return a result similar to the following example: - -![Result of "ipconfig" command](images/ipconfig.png){.thumbnail} - -Identify and write down your IPv4, subnet mask, default gateway and the name of the network interface controller (network adapter). - -In our example, the server IP is **192.0.2.28**. - -You can perform the next steps via either a command-line interface or the graphical user interface. - -#### Via a command-line interface (recommended) - -In the commands below, you need to replace: - -|Command|Value| -|---|---| -|NETWORK_ADAPTER| Name of the network adapter (in our example: Ethernet 2)| -|IP_ADDRESS| Server IP address (in our example: 192.0.2.28)| -|SUBNET_MASK| Subnet mask (in our example: 255.255.255.0)| -|GATEWAY| Default gateway (in our example: 192.0.2.254)| -|ADDITIONAL_IP| Address of Additional IP you want to add (in our example 203.0.113.1)| - -> [!warning] -> -> Be careful – the server will no longer be accessible if you enter incorrect information. You will then have to make the corrections in [Winrescue mode](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) or via the [IPMI](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). -> - -In the command prompt: - -1\. Switch to a fixed IP - -```powershell -netsh interface ipv4 set address name="NETWORK_ADAPTER" static IP_ADDRESS SUBNET_MASK GATEWAY -``` - -2\. Set the DNS server - -```powershell -netsh interface ipv4 set dns name="NETWORK_ADAPTER" static 213.186.33.99 -``` - -3\. Add an Additional IP - -```powershell -netsh interface ipv4 add address "NETWORK_ADAPTER" ADDITIONAL_IP 255.255.255.255 -``` - -Your Additional IP is now functional. - -#### Via the graphical user interface - -1. Go to `Start`{.action}> `Control Panel`{.action}>` Network and Internet`{.action}> `Network and Sharing Centre`{.action}> `Change Adapter Settings `{.action}(in the left-hand menu). -2. Right-click on your network connection, in our example `Ethernet 2`{.action}. -3. Click on `Properties`{.action}. -4. Select `Internet Protocol Version 4 (TCP/IPv4)`{.action}, then click on `Properties`{.action}. -5. Click on `Use the following IP address`{.action} and type in your server’s primary IP, subnet mask and default gateway information obtained by using the `ipconfig`{.action} command above. In the "Preferred DNS Server" box, type 213.186.33.99. - -![Internet Protocol Version 4 (TCP/IPv4) Properties](images/configure-main-ip.png){.thumbnail} - -> [!warning] -> -> Be careful – the server will no longer be accessible if you enter incorrect information. You will then have to make the corrections in [Winrescue mode](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) or via the [IPMI](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). -> - -Then click on `Advanced`{.action} (still in the `TCP/IP Settings`{.action}). - -![Internet Protocol Version 4 (TCP/IPv4) Properties](images/configure-main-ip-1.png){.thumbnail} - -In the `IP Address`{.action} section, click `Add`{.action}: - -![Advanced TCP/IPv4 Settings](images/add-additional-ip.png){.thumbnail} - -Type in your Additional IP and the subnet mask **255.255.255.255**. Then click on `Add`{.action} - -![TCP/IP Address](images/configure-additional-ip.png){.thumbnail} - - -Click on `OK`{.action} to apply your configuration. - -Your Additional IP is now functional, you can verify the configuration with the following command: - -```powershell -ipconfig -``` - -This will return a result similar to the following example: - -![Final configuration](images/final-ip-configuration.png){.thumbnail} - -### Plesk - -#### Step 1: Access the Plesk IP management section - -In the Plesk control panel, choose `Tools & Settings`{.action} from the left-hand sidebar. - -![acces to the ip addresses management](images/pleskip1.png){.thumbnail} - -Click on `IP Addresses`{.action} under **Tools & Resources**. - -#### Step 2: Add the Additional IP information - -In this section, click on the button `Add IP Address`{.action}. - -![add ip information](images/Plesk-2024.png){.thumbnail} - -Enter your Additional IP in the form `xxx.xxx.xxx.xxx/32` into the field "IP address and subnet mask", then click on `OK`{.action}. - -![add ip information](images/Plesk-2024-1.png){.thumbnail} - -#### Step 3: Check the current IP configuration - -Back in the section "IP Addresses", verify that the Additional IP address was added correctly. - -![current IP configuration](images/Plesk-2024-2.png){.thumbnail} +> [!tabs] +> Debian 11 +>> **Debian 11** +>> +>> By default, the configuration files are located in `/etc/network/interfaces.d/`. We recommend that you start by backing up the relevant configuration file. +>> +>> Step 1: Create a backup +>> +>> In our example, our file is called `50-cloud-init`, so we make a copy of the `50-cloud-init` file using the following command: +>> +>> ```bash +>> sudo cp /etc/network/interfaces.d/50-cloud-init /etc/network/interfaces.d/50-cloud-init.bak +>> ``` +>> +>> In case of a mistake, you will be able to revert the changes, using the commands below: +>> +>> ```bash +>> sudo rm -f /etc/network/interfaces.d/50-cloud-init +>> sudo cp /etc/network/interfaces.d/50-cloud-init.bak /etc/network/interfaces.d/50-cloud-init +>> ``` +>> +>> Step 2: Edit the configuration file +>> +>> > [!primary] +>> > Note that the names of the network interfaces in our examples may differ from your own. Please adjust to your appropriate interface names. +>> > +>> +>> You can now modify the configuration file: +>> +>> ```bash +>> sudo nano /etc/network/interfaces.d/50-cloud-init +>> ``` +>> +>> Next, you need to add a virtual interface or ethernet alias. In our example, our interface is called `eth0`, so our alias is `eth0:0`. Do this for each additional IP you wish to configure. +>> +>> Do not modify the existing lines in the configuration file, simply add your Additional IP to the file as follows, replacing `ADDITIONAL_IP/32` as well as the virtual interface (if your server is not using **eth0:0**) wih your own values: +>> +>> ```console +>> auto eth0:0 +>> iface eth0:0 inet static +>> address ADDITIONAL_IP +>> netmask 255.255.255.255 +>> ``` +>> +>> Alternatively, you can configure your Additional IP by adding the following lines in the configuration file: +>> +>> ```console +>> post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP netmask 255.255.255.255 broadcast ADDITIONAL_IP +>> pre-down /sbin/ifconfig eth0:0 down +>> ``` +>> +>> With the configuration above, the virtual interface is enabled or disabled whenever the `eth0` interface is enabled or disabled. +>> +>> If you have two Additional IPs to configure, the `/etc/network/interfaces.d/50-cloud-init` file should look like this: +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> auto eth0:0 +>> iface eth0:0 inet static +>> address ADDITIONAL_IP1 +>> netmask 255.255.255.255 +>> +>> auto eth0:1 +>> iface eth0:1 inet static +>> address ADDITIONAL_IP2 +>> netmask 255.255.255.255 +>> ``` +>> +>> Or like this: +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> # IP 1 +>> post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP1 netmask 255.255.255.255 broadcast ADDITIONAL_IP1 +>> pre-down /sbin/ifconfig eth0:0 down +>> +>> # IP 2 +>> post-up /sbin/ifconfig eth0:1 ADDITIONAL_IP2 netmask 255.255.255.255 broadcast ADDITIONAL_IP2 +>> pre-down /sbin/ifconfig eth0:1 down +>> ``` +>> +>> /// details | **Configuration example** +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> auto eth0:0 +>> iface eth0:0 inet static +>> address 203.0.113.1 +>> netmask 255.255.255.255 +>> ``` +>> +>> Or: +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> # IP 1 +>> post-up /sbin/ifconfig eth0:0 203.0.113.1 netmask 255.255.255.255 broadcast 203.0.113.1 +>> pre-down /sbin/ifconfig eth0:0 down +>> ``` +>> /// +>> +>> Step 3: Restart the interface +>> +>> To restart the interface, use the following command: +>> +>> ```bash +>> sudo /etc/init.d/networking restart +>> ``` +>> +> Fedora 41+ +>> **Fedora 41 and following** +>> +>> Fedora now uses keyfiles. NetworkManager previously stored network profiles in ifcfg format in this directory: `/etc/sysconfig/network-scripts/`. However, the ifcfg format is now deprecated. By default, NetworkManager no longer creates new profiles in this format. The configuration file is now found in `/etc/NetworkManager/system-connections/`. +>> +>> Step 1: Create a backup +>> +>> > [!primary] +>> > +>> > Note that the name of the network file in our example may differ from your own. Please adjust to your appropriate name. +>> > +>> +>> First, make a copy of the configuration file, so that you can revert at any time. In our example, our configuration file is called `cloud-init-eno1.nmconnection`. +>> +>> ```bash +>> sudo cp -r /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak +>> ``` +>> +>> Step 2: Edit the config file +>> +>> > [!primary] +>> > Please note that the name of the network file in our example may differ from yours. Please adapt the commands to your file name. +>> > +>> +>> To obtain the name of your network interface in order to edit the appropriate network file, you can run one of the following commands: +>> +>> ```bash +>> ip a +>> ``` +>> +>> ```bash +>> nmcli connection show +>> ``` +>> +>> Do not modify the existing lines in the configuration file, add your Additional IP to the file as follows, replacing `ADDITIONAL_IP/32` wih your own values: +>> +>> ```bash +>> sudo nano /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> ``` +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=ADDITIONAL_IP/32 +>> ``` +>> +>> If you have two Additional IPs to configure, the configuration should look like this: +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=ADDITIONAL_IP1/32 +>> address2=ADDITIONAL_IP2/32 +>> ``` +>> +>> /// details | **Configuration example** +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=203.0.113.1/32 +>> ``` +>> /// +>> +>> Step 3: Restart the interface +>> +>> You now need to restart your interface: +>> +>> ```bash +>> sudo systemctl restart NetworkManager +>> ``` +>> +> Debian 12 and Ubuntu 20.04+ +>> **Debian 12, Ubuntu 20.04 and following** +>> +>> By default, the configuration files are located in the `/etc/netplan` directory. +>> +>> The best practice approach is to create a separate configuration file to set up Additional IP addresses. This way, you can easily revert the changes in case of an error. +>> +>> Step 1: Determine the interface +>> +>> ```bash +>> ip a +>> ``` +>> +>> Note the name of the interface (the one on which your server's main IP address is configured). +>> +>> Step 2: Create and edit the configuration file +>> +>> Next, create a configuration file with a `.yaml` extension. In our example, our file is called `51-cloud-init.yaml`. +>> +>> ```bash +>> sudo nano /etc/netplan/51-cloud-init.yaml +>> ``` +>> +>> Edit the file with the content below, replacing `INTERFACE_NAME` and `ADDITIONAL_IP` with your own values: +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> INTERFACE_NAME: +>> dhcp4: true +>> addresses: +>> - ADDITIONAL_IP/32 +>> ``` +>> +>> If you have two Additional IPs to configure, the configuration file should look like this: +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> INTERFACE_NAME: +>> dhcp4: true +>> addresses: +>> - ADDITIONAL_IP1/32 +>> - ADDITIONAL_IP2/32 +>> ``` +>> +>> +>> > [!warning] +>> > It is important to respect the alignment of each element in this file as represented in the example above. Do not use the tab key to create your spacing. Only the space key is needed. +>> > +>> +>> /// details | **Configuration example** +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> eth0: +>> dhcp4: true +>> addresses: +>> - 203.0.113.1/32 +>> ``` +>> /// +>> +>> Save and close the file. You can test the configuration with the following command: +>> +>> ```bash +>> sudo netplan try +>> ``` +>> +>> Step 3: Apply the change +>> +>> If it is correct, apply it using the following command: +>> +>> ```bash +>> sudo netplan apply +>> ``` +>> +>> > [!primary] +>> > When using the `netplan try` command, it is possible that the system returns a warning message such as `Permissions for /etc/netplan/xx-cloud-init.yaml are too open. Netplan configuration should NOT be accessible by others`. This simply means that the file does not have restrictive permissions. This does not affect the configuration of your Additional IP. For more information about file permissions, consult the [official documentation of ubuntu](https://help.ubuntu.com/community/FilePermissions). +>> > +>> +> AlmaLinux / Rocky Linux +>> **AlmaLinux (8 & 9), Rocky Linux (8 & 9)** +>> +>> The main configuration file is located in `/etc/sysconfig/network-scripts/`. In this example it is called `ifcfg-eth0`. Before making changes, verify the actual file name in this folder. +>> +>> For each Additional IP to be configured, we create a seperate configuration file with the following parameters: `ifcfg-NETWORK_INTERFACE:ID`. Where `NETWORK_INTERFACE` is the physical interface and `ID` is the virtual network interface or ethernet alias starting with a value of 0. For example, for our interface named `eth0` the first alias is `eth0:0`, the second alias is `eth0:1`, etc... +>> +>> Step 1: Determine the interface +>> +>> ```bash +>> ip a +>> ``` +>> +>> Note the name of the interface (the one on which your server's main IP address is configured). +>> +>> Step 2: Create the configuration file +>> +>> First, create the configuration file. Replace `NETWORK_INTERFACE:ID` with your own values. +>> +>> ```bash +>> sudo nano /etc/sysconfig/network-scripts/ifcfg-NETWORK_INTERFACE:ID +>> ``` +>> +>> Next, edit the file with the content below, replacing `NETWORK_INTERFACE:ID`, and `ADDITIONAL_IP` with your own values: +>> +>> ```console +>> DEVICE=NETWORK_INTERFACE:ID +>> ONBOOT=yes +>> BOOTPROTO=none # For CentOS use "static" +>> IPADDR=ADDITIONAL_IP +>> NETMASK=255.255.255.255 +>> BROADCAST=ADDITIONAL_IP +>> ``` +>> +>> /// details | **Configuration example** +>> +>> ```console +>> DEVICE=eth0:0 +>> ONBOOT=yes +>> BOOTPROTO=none # For CentOS use "static" +>> IPADDR=203.0.113.1 +>> NETMASK=255.255.255.255 +>> BROADCAST=203.0.113.1 +>> ``` +>> /// +>> +>> Step 3: Restart the interface +>> +>> Next, restart the network interface with the following command: +>> +>> ```bash +>> sudo systemctl restart NetworkManager +>> ``` +>> +> cPanel +>> **cPanel** +>> +>> Step 1: Access the WHM IP management section +>> +>> In the WHM control panel, click on `IP Functions`{.action} and select `Add a New IP Address`{.action} in the left-hand sidebar. +>> +>> ![Add new IP](images/Cpanel-1.png){.thumbnail} +>> +>> Step 2: Add the Additional IP information +>> +>> Enter your Additional IP in the form `xxx.xxx.xxx.xxx` into the field “New IP or IP range to add”. +>> +>> Select `255.255.255.255` as your subnet mask, then click on `Submit`{.action}. +>> +>> ![enter new IP information](images/Cpanel-2024.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Please note that if you have more than one IP to configure on the same block and you add them all at once, the WHM system will force you to use the subnet mask `255.255.255.0`. We do not recommend using this configuration. Instead, you need to add each IP individually in order to use the proper subnet mask `255.255.255.255`. +>> > +>> +>> Step 3: Check the current IP configuration +>> +>> Back in the section `IP Functions`{.action}, click on `Show or Delete Current IP Addresses`{.action} to verify that the Additional IP address was added correctly. +>> +>> ![check configured IP](images/Cpanel-2024-1.png){.thumbnail} +>> +> Windows Servers +>> **Windows Servers** +>> +>> Windows servers are often DHCP-enabled in the network configuration. If you have already set up an Additional IP or switched your configuration to a fixed IP, go directly to the next step. +>> +>> Otherwise, you need to first switch from a network-level DHCP configuration to a fixed IP configuration. +>> +>> Open the command prompt `cmd`{.action} or `powershell`{.action}, then type the following command: +>> +>> ```powershell +>> ipconfig +>> ``` +>> +>> This will return a result similar to the following example: +>> +>> ![Result of "ipconfig" command](images/ipconfig.png){.thumbnail} +>> +>> Identify and write down your IPv4, subnet mask, default gateway and the name of the network interface controller (network adapter). +>> +>> In our example, the server IP is **192.0.2.28**. +>> +>> You can perform the next steps via either a command-line interface or the graphical user interface. +>> +>> **Via a command-line interface (recommended)** +>> +>> In the commands below, you need to replace: +>> +>> |Command|Value| +>> |---|---| +>> |NETWORK_ADAPTER| Name of the network adapter (in our example: Ethernet 2)| +>> |IP_ADDRESS| Server IP address (in our example: 192.0.2.28)| +>> |SUBNET_MASK| Subnet mask (in our example: 255.255.255.0)| +>> |GATEWAY| Default gateway (in our example: 192.0.2.254)| +>> |ADDITIONAL_IP| Address of Additional IP you want to add (in our example 203.0.113.1)| +>> +>> > [!warning] +>> > +>> > Be careful – the server will no longer be accessible if you enter incorrect information. You will then have to make the corrections in [Winrescue mode](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) or via the [IPMI](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). +>> > +>> +>> In the command prompt: +>> +>> 1\. Switch to a fixed IP +>> +>> ```powershell +>> netsh interface ipv4 set address name="NETWORK_ADAPTER" static IP_ADDRESS SUBNET_MASK GATEWAY +>> ``` +>> +>> 2\. Set the DNS server +>> +>> ```powershell +>> netsh interface ipv4 set dns name="NETWORK_ADAPTER" static 213.186.33.99 +>> ``` +>> +>> 3\. Add an Additional IP +>> +>> ```powershell +>> netsh interface ipv4 add address "NETWORK_ADAPTER" ADDITIONAL_IP 255.255.255.255 +>> ``` +>> +>> Your Additional IP is now functional. +>> +>> /// details | **Via the graphical user interface** +>> +>> 1. Go to `Start`{.action}> `Control Panel`{.action}>` Network and Internet`{.action}> `Network and Sharing Centre`{.action}> `Change Adapter Settings `{.action}(in the left-hand menu). +>> 2. Right-click on your network connection, in our example `Ethernet 2`{.action}. +>> 3. Click on `Properties`{.action}. +>> 4. Select `Internet Protocol Version 4 (TCP/IPv4)`{.action}, then click on `Properties`{.action}. +>> 5. Click on `Use the following IP address`{.action} and type in your server’s primary IP, subnet mask and default gateway information obtained by using the `ipconfig`{.action} command above. In the "Preferred DNS Server" box, type 213.186.33.99. +>> +>> ![Internet Protocol Version 4 (TCP/IPv4) Properties](images/configure-main-ip.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Be careful – the server will no longer be accessible if you enter incorrect information. You will then have to make the corrections in [Winrescue mode](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) or via the [IPMI](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). +>> > +>> +>> Then click on `Advanced`{.action} (still in the `TCP/IP Settings`{.action}). +>> +>> ![Internet Protocol Version 4 (TCP/IPv4) Properties](images/configure-main-ip-1.png){.thumbnail} +>> +>> In the `IP Address`{.action} section, click `Add`{.action}: +>> +>> ![Advanced TCP/IPv4 Settings](images/add-additional-ip.png){.thumbnail} +>> +>> Type in your Additional IP and the subnet mask **255.255.255.255**. Then click on `Add`{.action} +>> +>> ![TCP/IP Address](images/configure-additional-ip.png){.thumbnail} +>> +>> +>> Click on `OK`{.action} to apply your configuration. +>> +>> +>> Your Additional IP is now functional, you can verify the configuration with the following command: +>> +>> ```powershell +>> ipconfig +>> ``` +>> +>> This will return a result similar to the following example: +>> +>> ![Final configuration](images/final-ip-configuration.png){.thumbnail} +>> +>> /// +>> +> Plesk +>> **Plesk** +>> +>> Step 1: Access the Plesk IP management section +>> +>> In the Plesk control panel, choose `Tools & Settings`{.action} from the left-hand sidebar. +>> +>> ![acces to the ip addresses management](images/pleskip1.png){.thumbnail} +>> +>> Click on `IP Addresses`{.action} under **Tools & Resources**. +>> +>> Step 2: Add the Additional IP information +>> +>> In this section, click on the button `Add IP Address`{.action}. +>> +>> ![add ip information](images/Plesk-2024.png){.thumbnail} +>> +>> Enter your Additional IP in the form `xxx.xxx.xxx.xxx/32` into the field "IP address and subnet mask", then click on `OK`{.action}. +>> +>> ![add ip information](images/Plesk-2024-1.png){.thumbnail} +>> +>> Step 3: Check the current IP configuration +>> +>> Back in the section "IP Addresses", verify that the Additional IP address was added correctly. +>> +>> ![current IP configuration](images/Plesk-2024-2.png){.thumbnail} +>> ### Troubleshooting diff --git a/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.en-gb.md b/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.en-gb.md index 638be487b1a..4e9c7201a42 100644 --- a/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.en-gb.md +++ b/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.en-gb.md @@ -1,9 +1,23 @@ --- title: 'Configuring IP aliasing' excerpt: 'Find out how to add Additional IP addresses to your server configuration' -updated: 2025-07-22 +updated: 2025-11-12 --- + + > [!primary] > This article is about Additional IPv4 configuration on a public interface. You can also configure Primary IPv6 addresses on your dedicated servers using [this guide](/pages/bare_metal_cloud/dedicated_servers/network_ipv6). > @@ -41,8 +55,7 @@ IP aliasing is a special network configuration for your OVHcloud dedicated serve The following sections contain configurations for the distributions we currently offer and the most commonly used distributions/operating systems. The first step is always to log in to your server via SSH or a GUI login session (RDP for a Windows server). > [!primary] -> -Concerning different distribution releases, please note that the proper procedure to configure your network interface as well as the file names may have been subject to change. We recommend to consult the manuals and knowledge resources of the respective OS versions if you experience any issues. +> Concerning different distribution releases, please note that the proper procedure to configure your network interface as well as the file names may have been subject to change. We recommend to consult the manuals and knowledge resources of the respective OS versions if you experience any issues. > **Please take note of the following terminology that will be used in code examples and instructions of the guide sections below:** @@ -55,480 +68,500 @@ Concerning different distribution releases, please note that the proper procedur In the examples below, we will use the `nano` text editor. With some operating systems, you will need to install it first before using it. If this is the case, you will be prompted to do so. You can, of course, use the text editor of your choice. -### Debian 11 - -By default, the configuration files are located in `/etc/network/interfaces.d/`. We recommend that you start by backing up the relevant configuration file. - -#### Step 1: Create a backup - -In our example, our file is called `50-cloud-init`, so we make a copy of the `50-cloud-init` file using the following command: - -```bash -sudo cp /etc/network/interfaces.d/50-cloud-init /etc/network/interfaces.d/50-cloud-init.bak -``` - -In case of a mistake, you will be able to revert the changes, using the commands below: - -```bash -sudo rm -f /etc/network/interfaces.d/50-cloud-init -sudo cp /etc/network/interfaces.d/50-cloud-init.bak /etc/network/interfaces.d/50-cloud-init -``` - -#### Step 2: Edit the configuration file - -> [!primary] -> -Note that the names of the network interfaces in our examples may differ from your own. Please adjust to your appropriate interface names. -> - -You can now modify the configuration file: - -```bash -sudo nano /etc/network/interfaces.d/50-cloud-init -``` - -Next, you need to add a virtual interface or ethernet alias. In our example, our interface is called `eth0`, so our alias is `eth0:0`. Do this for each additional IP you wish to configure. - -Do not modify the existing lines in the configuration file, simply add your Additional IP to the file as follows, replacing `ADDITIONAL_IP/32` as well as the virtual interface (if your server is not using **eth0:0**) wih your own values: - -```console -auto eth0:0 -iface eth0:0 inet static -address ADDITIONAL_IP -netmask 255.255.255.255 -``` - -Alternatively, you can configure your Additional IP by adding the following lines in the configuration file: - -```console -post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP netmask 255.255.255.255 broadcast ADDITIONAL_IP -pre-down /sbin/ifconfig eth0:0 down -``` - -With the configuration above, the virtual interface is enabled or disabled whenever the `eth0` interface is enabled or disabled. - -If you have two Additional IPs to configure, the `/etc/network/interfaces.d/50-cloud-init` file should look like this: - -```console -auto eth0 -iface eth0 inet dhcp - -auto eth0:0 -iface eth0:0 inet static -address ADDITIONAL_IP1 -netmask 255.255.255.255 - -auto eth0:1 -iface eth0:1 inet static -address ADDITIONAL_IP2 -netmask 255.255.255.255 -``` - -Or like this: - -```console -auto eth0 -iface eth0 inet dhcp - -# IP 1 -post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP1 netmask 255.255.255.255 broadcast ADDITIONAL_IP1 -pre-down /sbin/ifconfig eth0:0 down - -# IP 2 -post-up /sbin/ifconfig eth0:1 ADDITIONAL_IP2 netmask 255.255.255.255 broadcast ADDITIONAL_IP2 -pre-down /sbin/ifconfig eth0:1 down -``` - -Configuration example: - -```console -auto eth0 -iface eth0 inet dhcp - -auto eth0:0 -iface eth0:0 inet static -address 203.0.113.1 -netmask 255.255.255.255 -``` - -Or : - -```console -auto eth0 -iface eth0 inet dhcp - -# IP 1 -post-up /sbin/ifconfig eth0:0 203.0.113.1 netmask 255.255.255.255 broadcast 203.0.113.1 -pre-down /sbin/ifconfig eth0:0 down -``` - -#### Step 3: Restart the interface - -To restart the interface, use the following command: - -```bash -sudo /etc/init.d/networking restart -``` - -### Fedora 39 and following - -Fedora now uses keyfiles. NetworkManager previously stored network profiles in ifcfg format in this directory: `/etc/sysconfig/network-scripts/`. However, the ifcfg format is now deprecated. By default, NetworkManager no longer creates new profiles in this format. The configuration file is now found in `/etc/NetworkManager/system-connections/`. - -#### Step 1: Create a backup - -> [!primary] -> -> Note that the name of the network file in our example may differ from your own. Please adjust to your appropriate name. -> - -First, make a copy of the configuration file, so that you can revert at any time. In our example, our configuration file is called `cloud-init-eno1.nmconnection`. - -```bash -sudo cp -r /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak -``` - -#### Step 2: Edit the config file - -> [!primary] -> Please note that the name of the network file in our example may differ from yours. Please adapt the commands to your file name. -> - -To obtain the name of your network interface in order to edit the appropriate network file, you can run one of the following commands: - -```bash -ip a -``` - -```bash -nmcli connection show -``` - -Do not modify the existing lines in the configuration file, add your Additional IP to the file as follows, replacing `ADDITIONAL_IP/32` wih your own values: - -```bash -sudo nano /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -``` - -```console -[ipv4] -method=auto -may-fail=false -address1=ADDITIONAL_IP/32 -``` - -If you have two Additional IPs to configure, the configuration should look like this: - -```console -[ipv4] -method=auto -may-fail=false -address1=ADDITIONAL_IP1/32 -address2=ADDITIONAL_IP2/32 -``` - -Configuration example: - -```console -[ipv4] -method=auto -may-fail=false -address1=203.0.113.1/32 -``` - -#### Step 3: Restart the interface - -You now need to restart your interface: - -```bash -sudo systemctl restart NetworkManager -``` - -### Debian 12, Ubuntu 20.04 and following - -By default, the configuration files are located in the `/etc/netplan` directory. - -The best practice approach is to create a separate configuration file to set up Additional IP addresses. This way, you can easily revert the changes in case of an error. - -#### Step 1: Determine the interface - -```bash -ip a -``` - -Note the name of the interface (the one on which your server's main IP address is configured). - -#### Step 2: Create and edit the configuration file - -Next, create a configuration file with a `.yaml` extension. In our example, our file is called `51-cloud-init.yaml`. - -```bash -sudo nano /etc/netplan/51-cloud-init.yaml -``` - -Edit the file with the content below, replacing `INTERFACE_NAME` and `ADDITIONAL_IP` with your own values: - -```yaml -network: - version: 2 - ethernets: - INTERFACE_NAME: - dhcp4: true - addresses: - - ADDITIONAL_IP/32 -``` - -If you have two Additional IPs to configure, the configuration file should look like this: - -```yaml -network: - version: 2 - ethernets: - INTERFACE_NAME: - dhcp4: true - addresses: - - ADDITIONAL_IP1/32 - - ADDITIONAL_IP2/32 -``` - -> [!warning] -> It is important to respect the alignment of each element in this file as represented in the example above. Do not use the tab key to create your spacing. Only the space key is needed. +> [!success] +> Select the tab corresponding to your operating system. > -Configuration example: - -```yaml -network: - version: 2 - ethernets: - eth0: - dhcp4: true - addresses: - - 203.0.113.1/32 -``` - -Save and close the file. You can test the configuration with the following command: - -```bash -sudo netplan try -``` - -#### Step 3: Apply the change - -If it is correct, apply it using the following command: - -```bash -sudo netplan apply -``` - -> [!primary] -> When using the `netplan try` command, it is possible that the system returns a warning message such as `Permissions for /etc/netplan/xx-cloud-init.yaml are too open. Netplan configuration should NOT be accessible by others`. This simply means that the file does not have restrictive permissions. This does not affect the configuration of your Additional IP. For more information about file permissions, consult the [official documentation of ubuntu](https://help.ubuntu.com/community/FilePermissions). -> - -### AlmaLinux (8 & 9), Rocky Linux (8 & 9) - -The main configuration file is located in `/etc/sysconfig/network-scripts/`. In this example it is called `ifcfg-eth0`. Before making changes, verify the actual file name in this folder. - -For each Additional IP to be configured, we create a seperate configuration file with the following parameters: `ifcfg-NETWORK_INTERFACE:ID`. Where `NETWORK_INTERFACE` is the physical interface and `ID` is the virtual network interface or ethernet alias starting with a value of 0. For example, for our interface named `eth0` the first alias is `eth0:0`, the second alias is `eth0:1`, etc... - -#### Step 1: Determine the interface - -```bash -ip a -``` - -Note the name of the interface (the one on which your server's main IP address is configured). - -#### Step 2: Create the configuration file - -First, create the configuration file. Replace `NETWORK_INTERFACE:ID` with your own values. - -```bash -sudo nano /etc/sysconfig/network-scripts/ifcfg-NETWORK_INTERFACE:ID -``` - -Next, edit the file with the content below, replacing `NETWORK_INTERFACE:ID`, and `ADDITIONAL_IP` with your own values: - -```console -DEVICE=NETWORK_INTERFACE:ID -ONBOOT=yes -BOOTPROTO=none # For CentOS use "static" -IPADDR=ADDITIONAL_IP -NETMASK=255.255.255.255 -BROADCAST=ADDITIONAL_IP -``` - -Configuration example: - -```console -DEVICE=eth0:0 -ONBOOT=yes -BOOTPROTO=none # For CentOS use "static" -IPADDR=203.0.113.1 -NETMASK=255.255.255.255 -BROADCAST=203.0.113.1 -``` - -#### Step 3: Restart the interface - -Next, restart the network interface with the following command: - -```bash -sudo systemctl restart NetworkManager -``` - -### cPanel - -#### Step 1: Access the WHM IP management section - -In the WHM control panel, click on `IP Functions`{.action} and select `Add a New IP Address`{.action} in the left-hand sidebar. - -![Add new IP](images/Cpanel-1.png){.thumbnail} - -#### Step 2: Add the Additional IP information - -Enter your Additional IP in the form `xxx.xxx.xxx.xxx` into the field “New IP or IP range to add”. - -Select `255.255.255.255` as your subnet mask, then click on `Submit`{.action}. - -![enter new IP information](images/Cpanel-2024.png){.thumbnail} - -> [!warning] -> -> Please note that if you have more than one IP to configure on the same block and you add them all at once, the WHM system will force you to use the subnet mask `255.255.255.0`. We do not recommend using this configuration. Instead, you need to add each IP individually in order to use the proper subnet mask `255.255.255.255`. -> - -#### Step 3: Check the current IP configuration - -Back in the section `IP Functions`{.action}, click on `Show or Delete Current IP Addresses`{.action} to verify that the Additional IP address was added correctly. - -![check configured IP](images/Cpanel-2024-1.png){.thumbnail} - -### Windows Servers - -Windows servers are often DHCP-enabled in the network configuration. If you have already set up an Additional IP or switched your configuration to a fixed IP, go directly to the next step. - -Otherwise, you need to first switch from a network-level DHCP configuration to a fixed IP configuration. - -Open the command prompt `cmd`{.action} or `powershell`{.action}, then type the following command: - -```powershell -ipconfig -``` - -This will return a result similar to the following example: - -![Result of "ipconfig" command](images/ipconfig.png){.thumbnail} - -Identify and write down your IPv4, subnet mask, default gateway and the name of the network interface controller (network adapter). - -In our example, the server IP is **192.0.2.28**. - -You can perform the next steps via either a command-line interface or the graphical user interface. - -#### Via a command-line interface (recommended) - -In the commands below, you need to replace: - -|Command|Value| -|---|---| -|NETWORK_ADAPTER| Name of the network adapter (in our example: Ethernet 2)| -|IP_ADDRESS| Server IP address (in our example: 192.0.2.28)| -|SUBNET_MASK| Subnet mask (in our example: 255.255.255.0)| -|GATEWAY| Default gateway (in our example: 192.0.2.254)| -|ADDITIONAL_IP| Address of Additional IP you want to add (in our example 203.0.113.1)| - -> [!warning] -> -> Be careful – the server will no longer be accessible if you enter incorrect information. You will then have to make the corrections in [Winrescue mode](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) or via the [IPMI](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). -> - -In the command prompt: - -1\. Switch to a fixed IP - -```powershell -netsh interface ipv4 set address name="NETWORK_ADAPTER" static IP_ADDRESS SUBNET_MASK GATEWAY -``` - -2\. Set the DNS server - -```powershell -netsh interface ipv4 set dns name="NETWORK_ADAPTER" static 213.186.33.99 -``` - -3\. Add an Additional IP - -```powershell -netsh interface ipv4 add address "NETWORK_ADAPTER" ADDITIONAL_IP 255.255.255.255 -``` - -Your Additional IP is now functional. - -#### Via the graphical user interface - -1. Go to `Start`{.action}> `Control Panel`{.action}>` Network and Internet`{.action}> `Network and Sharing Centre`{.action}> `Change Adapter Settings `{.action}(in the left-hand menu). -2. Right-click on your network connection, in our example `Ethernet 2`{.action}. -3. Click on `Properties`{.action}. -4. Select `Internet Protocol Version 4 (TCP/IPv4)`{.action}, then click on `Properties`{.action}. -5. Click on `Use the following IP address`{.action} and type in your server’s primary IP, subnet mask and default gateway information obtained by using the `ipconfig`{.action} command above. In the "Preferred DNS Server" box, type 213.186.33.99. - -![Internet Protocol Version 4 (TCP/IPv4) Properties](images/configure-main-ip.png){.thumbnail} - -> [!warning] -> -> Be careful – the server will no longer be accessible if you enter incorrect information. You will then have to make the corrections in [Winrescue mode](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) or via the [IPMI](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). -> - -Then click on `Advanced`{.action} (still in the `TCP/IP Settings`{.action}). - -![Internet Protocol Version 4 (TCP/IPv4) Properties](images/configure-main-ip-1.png){.thumbnail} - -In the `IP Address`{.action} section, click `Add`{.action}: - -![Advanced TCP/IPv4 Settings](images/add-additional-ip.png){.thumbnail} - -Type in your Additional IP and the subnet mask **255.255.255.255**. Then click on `Add`{.action} - -![TCP/IP Address](images/configure-additional-ip.png){.thumbnail} - - -Click on `OK`{.action} to apply your configuration. - -Your Additional IP is now functional, you can verify the configuration with the following command: - -```powershell -ipconfig -``` - -This will return a result similar to the following example: - -![Final configuration](images/final-ip-configuration.png){.thumbnail} - -### Plesk - -#### Step 1: Access the Plesk IP management section - -In the Plesk control panel, choose `Tools & Settings`{.action} from the left-hand sidebar. - -![acces to the ip addresses management](images/pleskip1.png){.thumbnail} - -Click on `IP Addresses`{.action} under **Tools & Resources**. - -#### Step 2: Add the Additional IP information - -In this section, click on the button `Add IP Address`{.action}. - -![add ip information](images/Plesk-2024.png){.thumbnail} - -Enter your Additional IP in the form `xxx.xxx.xxx.xxx/32` into the field "IP address and subnet mask", then click on `OK`{.action}. - -![add ip information](images/Plesk-2024-1.png){.thumbnail} - -#### Step 3: Check the current IP configuration - -Back in the section "IP Addresses", verify that the Additional IP address was added correctly. - -![current IP configuration](images/Plesk-2024-2.png){.thumbnail} +> [!tabs] +> Debian 11 +>> **Debian 11** +>> +>> By default, the configuration files are located in `/etc/network/interfaces.d/`. We recommend that you start by backing up the relevant configuration file. +>> +>> Step 1: Create a backup +>> +>> In our example, our file is called `50-cloud-init`, so we make a copy of the `50-cloud-init` file using the following command: +>> +>> ```bash +>> sudo cp /etc/network/interfaces.d/50-cloud-init /etc/network/interfaces.d/50-cloud-init.bak +>> ``` +>> +>> In case of a mistake, you will be able to revert the changes, using the commands below: +>> +>> ```bash +>> sudo rm -f /etc/network/interfaces.d/50-cloud-init +>> sudo cp /etc/network/interfaces.d/50-cloud-init.bak /etc/network/interfaces.d/50-cloud-init +>> ``` +>> +>> Step 2: Edit the configuration file +>> +>> > [!primary] +>> > Note that the names of the network interfaces in our examples may differ from your own. Please adjust to your appropriate interface names. +>> > +>> +>> You can now modify the configuration file: +>> +>> ```bash +>> sudo nano /etc/network/interfaces.d/50-cloud-init +>> ``` +>> +>> Next, you need to add a virtual interface or ethernet alias. In our example, our interface is called `eth0`, so our alias is `eth0:0`. Do this for each additional IP you wish to configure. +>> +>> Do not modify the existing lines in the configuration file, simply add your Additional IP to the file as follows, replacing `ADDITIONAL_IP/32` as well as the virtual interface (if your server is not using **eth0:0**) wih your own values: +>> +>> ```console +>> auto eth0:0 +>> iface eth0:0 inet static +>> address ADDITIONAL_IP +>> netmask 255.255.255.255 +>> ``` +>> +>> Alternatively, you can configure your Additional IP by adding the following lines in the configuration file: +>> +>> ```console +>> post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP netmask 255.255.255.255 broadcast ADDITIONAL_IP +>> pre-down /sbin/ifconfig eth0:0 down +>> ``` +>> +>> With the configuration above, the virtual interface is enabled or disabled whenever the `eth0` interface is enabled or disabled. +>> +>> If you have two Additional IPs to configure, the `/etc/network/interfaces.d/50-cloud-init` file should look like this: +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> auto eth0:0 +>> iface eth0:0 inet static +>> address ADDITIONAL_IP1 +>> netmask 255.255.255.255 +>> +>> auto eth0:1 +>> iface eth0:1 inet static +>> address ADDITIONAL_IP2 +>> netmask 255.255.255.255 +>> ``` +>> +>> Or like this: +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> # IP 1 +>> post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP1 netmask 255.255.255.255 broadcast ADDITIONAL_IP1 +>> pre-down /sbin/ifconfig eth0:0 down +>> +>> # IP 2 +>> post-up /sbin/ifconfig eth0:1 ADDITIONAL_IP2 netmask 255.255.255.255 broadcast ADDITIONAL_IP2 +>> pre-down /sbin/ifconfig eth0:1 down +>> ``` +>> +>> /// details | **Configuration example** +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> auto eth0:0 +>> iface eth0:0 inet static +>> address 203.0.113.1 +>> netmask 255.255.255.255 +>> ``` +>> +>> Or: +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> # IP 1 +>> post-up /sbin/ifconfig eth0:0 203.0.113.1 netmask 255.255.255.255 broadcast 203.0.113.1 +>> pre-down /sbin/ifconfig eth0:0 down +>> ``` +>> /// +>> +>> Step 3: Restart the interface +>> +>> To restart the interface, use the following command: +>> +>> ```bash +>> sudo /etc/init.d/networking restart +>> ``` +>> +> Fedora 41+ +>> **Fedora 41 and following** +>> +>> Fedora now uses keyfiles. NetworkManager previously stored network profiles in ifcfg format in this directory: `/etc/sysconfig/network-scripts/`. However, the ifcfg format is now deprecated. By default, NetworkManager no longer creates new profiles in this format. The configuration file is now found in `/etc/NetworkManager/system-connections/`. +>> +>> Step 1: Create a backup +>> +>> > [!primary] +>> > +>> > Note that the name of the network file in our example may differ from your own. Please adjust to your appropriate name. +>> > +>> +>> First, make a copy of the configuration file, so that you can revert at any time. In our example, our configuration file is called `cloud-init-eno1.nmconnection`. +>> +>> ```bash +>> sudo cp -r /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak +>> ``` +>> +>> Step 2: Edit the config file +>> +>> > [!primary] +>> > Please note that the name of the network file in our example may differ from yours. Please adapt the commands to your file name. +>> > +>> +>> To obtain the name of your network interface in order to edit the appropriate network file, you can run one of the following commands: +>> +>> ```bash +>> ip a +>> ``` +>> +>> ```bash +>> nmcli connection show +>> ``` +>> +>> Do not modify the existing lines in the configuration file, add your Additional IP to the file as follows, replacing `ADDITIONAL_IP/32` wih your own values: +>> +>> ```bash +>> sudo nano /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> ``` +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=ADDITIONAL_IP/32 +>> ``` +>> +>> If you have two Additional IPs to configure, the configuration should look like this: +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=ADDITIONAL_IP1/32 +>> address2=ADDITIONAL_IP2/32 +>> ``` +>> +>> /// details | **Configuration example** +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=203.0.113.1/32 +>> ``` +>> /// +>> +>> Step 3: Restart the interface +>> +>> You now need to restart your interface: +>> +>> ```bash +>> sudo systemctl restart NetworkManager +>> ``` +>> +> Debian 12 and Ubuntu 20.04+ +>> **Debian 12, Ubuntu 20.04 and following** +>> +>> By default, the configuration files are located in the `/etc/netplan` directory. +>> +>> The best practice approach is to create a separate configuration file to set up Additional IP addresses. This way, you can easily revert the changes in case of an error. +>> +>> Step 1: Determine the interface +>> +>> ```bash +>> ip a +>> ``` +>> +>> Note the name of the interface (the one on which your server's main IP address is configured). +>> +>> Step 2: Create and edit the configuration file +>> +>> Next, create a configuration file with a `.yaml` extension. In our example, our file is called `51-cloud-init.yaml`. +>> +>> ```bash +>> sudo nano /etc/netplan/51-cloud-init.yaml +>> ``` +>> +>> Edit the file with the content below, replacing `INTERFACE_NAME` and `ADDITIONAL_IP` with your own values: +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> INTERFACE_NAME: +>> dhcp4: true +>> addresses: +>> - ADDITIONAL_IP/32 +>> ``` +>> +>> If you have two Additional IPs to configure, the configuration file should look like this: +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> INTERFACE_NAME: +>> dhcp4: true +>> addresses: +>> - ADDITIONAL_IP1/32 +>> - ADDITIONAL_IP2/32 +>> ``` +>> +>> +>> > [!warning] +>> > It is important to respect the alignment of each element in this file as represented in the example above. Do not use the tab key to create your spacing. Only the space key is needed. +>> > +>> +>> /// details | **Configuration example** +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> eth0: +>> dhcp4: true +>> addresses: +>> - 203.0.113.1/32 +>> ``` +>> /// +>> +>> Save and close the file. You can test the configuration with the following command: +>> +>> ```bash +>> sudo netplan try +>> ``` +>> +>> Step 3: Apply the change +>> +>> If it is correct, apply it using the following command: +>> +>> ```bash +>> sudo netplan apply +>> ``` +>> +>> > [!primary] +>> > When using the `netplan try` command, it is possible that the system returns a warning message such as `Permissions for /etc/netplan/xx-cloud-init.yaml are too open. Netplan configuration should NOT be accessible by others`. This simply means that the file does not have restrictive permissions. This does not affect the configuration of your Additional IP. For more information about file permissions, consult the [official documentation of ubuntu](https://help.ubuntu.com/community/FilePermissions). +>> > +>> +> AlmaLinux / Rocky Linux +>> **AlmaLinux (8 & 9), Rocky Linux (8 & 9)** +>> +>> The main configuration file is located in `/etc/sysconfig/network-scripts/`. In this example it is called `ifcfg-eth0`. Before making changes, verify the actual file name in this folder. +>> +>> For each Additional IP to be configured, we create a seperate configuration file with the following parameters: `ifcfg-NETWORK_INTERFACE:ID`. Where `NETWORK_INTERFACE` is the physical interface and `ID` is the virtual network interface or ethernet alias starting with a value of 0. For example, for our interface named `eth0` the first alias is `eth0:0`, the second alias is `eth0:1`, etc... +>> +>> Step 1: Determine the interface +>> +>> ```bash +>> ip a +>> ``` +>> +>> Note the name of the interface (the one on which your server's main IP address is configured). +>> +>> Step 2: Create the configuration file +>> +>> First, create the configuration file. Replace `NETWORK_INTERFACE:ID` with your own values. +>> +>> ```bash +>> sudo nano /etc/sysconfig/network-scripts/ifcfg-NETWORK_INTERFACE:ID +>> ``` +>> +>> Next, edit the file with the content below, replacing `NETWORK_INTERFACE:ID`, and `ADDITIONAL_IP` with your own values: +>> +>> ```console +>> DEVICE=NETWORK_INTERFACE:ID +>> ONBOOT=yes +>> BOOTPROTO=none # For CentOS use "static" +>> IPADDR=ADDITIONAL_IP +>> NETMASK=255.255.255.255 +>> BROADCAST=ADDITIONAL_IP +>> ``` +>> +>> /// details | **Configuration example** +>> +>> ```console +>> DEVICE=eth0:0 +>> ONBOOT=yes +>> BOOTPROTO=none # For CentOS use "static" +>> IPADDR=203.0.113.1 +>> NETMASK=255.255.255.255 +>> BROADCAST=203.0.113.1 +>> ``` +>> /// +>> +>> Step 3: Restart the interface +>> +>> Next, restart the network interface with the following command: +>> +>> ```bash +>> sudo systemctl restart NetworkManager +>> ``` +>> +> cPanel +>> **cPanel** +>> +>> Step 1: Access the WHM IP management section +>> +>> In the WHM control panel, click on `IP Functions`{.action} and select `Add a New IP Address`{.action} in the left-hand sidebar. +>> +>> ![Add new IP](images/Cpanel-1.png){.thumbnail} +>> +>> Step 2: Add the Additional IP information +>> +>> Enter your Additional IP in the form `xxx.xxx.xxx.xxx` into the field “New IP or IP range to add”. +>> +>> Select `255.255.255.255` as your subnet mask, then click on `Submit`{.action}. +>> +>> ![enter new IP information](images/Cpanel-2024.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Please note that if you have more than one IP to configure on the same block and you add them all at once, the WHM system will force you to use the subnet mask `255.255.255.0`. We do not recommend using this configuration. Instead, you need to add each IP individually in order to use the proper subnet mask `255.255.255.255`. +>> > +>> +>> Step 3: Check the current IP configuration +>> +>> Back in the section `IP Functions`{.action}, click on `Show or Delete Current IP Addresses`{.action} to verify that the Additional IP address was added correctly. +>> +>> ![check configured IP](images/Cpanel-2024-1.png){.thumbnail} +>> +> Windows Servers +>> **Windows Servers** +>> +>> Windows servers are often DHCP-enabled in the network configuration. If you have already set up an Additional IP or switched your configuration to a fixed IP, go directly to the next step. +>> +>> Otherwise, you need to first switch from a network-level DHCP configuration to a fixed IP configuration. +>> +>> Open the command prompt `cmd`{.action} or `powershell`{.action}, then type the following command: +>> +>> ```powershell +>> ipconfig +>> ``` +>> +>> This will return a result similar to the following example: +>> +>> ![Result of "ipconfig" command](images/ipconfig.png){.thumbnail} +>> +>> Identify and write down your IPv4, subnet mask, default gateway and the name of the network interface controller (network adapter). +>> +>> In our example, the server IP is **192.0.2.28**. +>> +>> You can perform the next steps via either a command-line interface or the graphical user interface. +>> +>> **Via a command-line interface (recommended)** +>> +>> In the commands below, you need to replace: +>> +>> |Command|Value| +>> |---|---| +>> |NETWORK_ADAPTER| Name of the network adapter (in our example: Ethernet 2)| +>> |IP_ADDRESS| Server IP address (in our example: 192.0.2.28)| +>> |SUBNET_MASK| Subnet mask (in our example: 255.255.255.0)| +>> |GATEWAY| Default gateway (in our example: 192.0.2.254)| +>> |ADDITIONAL_IP| Address of Additional IP you want to add (in our example 203.0.113.1)| +>> +>> > [!warning] +>> > +>> > Be careful – the server will no longer be accessible if you enter incorrect information. You will then have to make the corrections in [Winrescue mode](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) or via the [IPMI](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). +>> > +>> +>> In the command prompt: +>> +>> 1\. Switch to a fixed IP +>> +>> ```powershell +>> netsh interface ipv4 set address name="NETWORK_ADAPTER" static IP_ADDRESS SUBNET_MASK GATEWAY +>> ``` +>> +>> 2\. Set the DNS server +>> +>> ```powershell +>> netsh interface ipv4 set dns name="NETWORK_ADAPTER" static 213.186.33.99 +>> ``` +>> +>> 3\. Add an Additional IP +>> +>> ```powershell +>> netsh interface ipv4 add address "NETWORK_ADAPTER" ADDITIONAL_IP 255.255.255.255 +>> ``` +>> +>> Your Additional IP is now functional. +>> +>> /// details | **Via the graphical user interface** +>> +>> 1. Go to `Start`{.action}> `Control Panel`{.action}>` Network and Internet`{.action}> `Network and Sharing Centre`{.action}> `Change Adapter Settings `{.action}(in the left-hand menu). +>> 2. Right-click on your network connection, in our example `Ethernet 2`{.action}. +>> 3. Click on `Properties`{.action}. +>> 4. Select `Internet Protocol Version 4 (TCP/IPv4)`{.action}, then click on `Properties`{.action}. +>> 5. Click on `Use the following IP address`{.action} and type in your server’s primary IP, subnet mask and default gateway information obtained by using the `ipconfig`{.action} command above. In the "Preferred DNS Server" box, type 213.186.33.99. +>> +>> ![Internet Protocol Version 4 (TCP/IPv4) Properties](images/configure-main-ip.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Be careful – the server will no longer be accessible if you enter incorrect information. You will then have to make the corrections in [Winrescue mode](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) or via the [IPMI](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). +>> > +>> +>> Then click on `Advanced`{.action} (still in the `TCP/IP Settings`{.action}). +>> +>> ![Internet Protocol Version 4 (TCP/IPv4) Properties](images/configure-main-ip-1.png){.thumbnail} +>> +>> In the `IP Address`{.action} section, click `Add`{.action}: +>> +>> ![Advanced TCP/IPv4 Settings](images/add-additional-ip.png){.thumbnail} +>> +>> Type in your Additional IP and the subnet mask **255.255.255.255**. Then click on `Add`{.action} +>> +>> ![TCP/IP Address](images/configure-additional-ip.png){.thumbnail} +>> +>> +>> Click on `OK`{.action} to apply your configuration. +>> +>> +>> Your Additional IP is now functional, you can verify the configuration with the following command: +>> +>> ```powershell +>> ipconfig +>> ``` +>> +>> This will return a result similar to the following example: +>> +>> ![Final configuration](images/final-ip-configuration.png){.thumbnail} +>> +>> /// +>> +> Plesk +>> **Plesk** +>> +>> Step 1: Access the Plesk IP management section +>> +>> In the Plesk control panel, choose `Tools & Settings`{.action} from the left-hand sidebar. +>> +>> ![acces to the ip addresses management](images/pleskip1.png){.thumbnail} +>> +>> Click on `IP Addresses`{.action} under **Tools & Resources**. +>> +>> Step 2: Add the Additional IP information +>> +>> In this section, click on the button `Add IP Address`{.action}. +>> +>> ![add ip information](images/Plesk-2024.png){.thumbnail} +>> +>> Enter your Additional IP in the form `xxx.xxx.xxx.xxx/32` into the field "IP address and subnet mask", then click on `OK`{.action}. +>> +>> ![add ip information](images/Plesk-2024-1.png){.thumbnail} +>> +>> Step 3: Check the current IP configuration +>> +>> Back in the section "IP Addresses", verify that the Additional IP address was added correctly. +>> +>> ![current IP configuration](images/Plesk-2024-2.png){.thumbnail} +>> ### Troubleshooting @@ -540,7 +573,7 @@ Once you are connected to your server via SSH, enter the following command: ifconfig eth0:0 ADDITIONAL_IP netmask 255.255.255.255 broadcast ADDITIONAL_IP up ``` -To test the connection, simply ping your Additional IP from the outside. If it responds in rescue mode, that probably means that there is a configuration error. If, however, the IP is still not working, please open a ticket with the support team via the [OVHcloud Help Centre](https://help.ovhcloud.com/csm?id=csm_get_help) with the following information: +To test the connection, simply ping your Additional IP from the outside. If it responds in rescue mode, that probably means that there is a configuration error. If, however, the IP is still not working, please open a ticket with the support team via the [OVHcloud Help Center](https://help.ovhcloud.com/csm?id=csm_get_help) with the following information: It is necessary to provide: diff --git a/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.en-ie.md b/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.en-ie.md index 638be487b1a..4e9c7201a42 100644 --- a/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.en-ie.md +++ b/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.en-ie.md @@ -1,9 +1,23 @@ --- title: 'Configuring IP aliasing' excerpt: 'Find out how to add Additional IP addresses to your server configuration' -updated: 2025-07-22 +updated: 2025-11-12 --- + + > [!primary] > This article is about Additional IPv4 configuration on a public interface. You can also configure Primary IPv6 addresses on your dedicated servers using [this guide](/pages/bare_metal_cloud/dedicated_servers/network_ipv6). > @@ -41,8 +55,7 @@ IP aliasing is a special network configuration for your OVHcloud dedicated serve The following sections contain configurations for the distributions we currently offer and the most commonly used distributions/operating systems. The first step is always to log in to your server via SSH or a GUI login session (RDP for a Windows server). > [!primary] -> -Concerning different distribution releases, please note that the proper procedure to configure your network interface as well as the file names may have been subject to change. We recommend to consult the manuals and knowledge resources of the respective OS versions if you experience any issues. +> Concerning different distribution releases, please note that the proper procedure to configure your network interface as well as the file names may have been subject to change. We recommend to consult the manuals and knowledge resources of the respective OS versions if you experience any issues. > **Please take note of the following terminology that will be used in code examples and instructions of the guide sections below:** @@ -55,480 +68,500 @@ Concerning different distribution releases, please note that the proper procedur In the examples below, we will use the `nano` text editor. With some operating systems, you will need to install it first before using it. If this is the case, you will be prompted to do so. You can, of course, use the text editor of your choice. -### Debian 11 - -By default, the configuration files are located in `/etc/network/interfaces.d/`. We recommend that you start by backing up the relevant configuration file. - -#### Step 1: Create a backup - -In our example, our file is called `50-cloud-init`, so we make a copy of the `50-cloud-init` file using the following command: - -```bash -sudo cp /etc/network/interfaces.d/50-cloud-init /etc/network/interfaces.d/50-cloud-init.bak -``` - -In case of a mistake, you will be able to revert the changes, using the commands below: - -```bash -sudo rm -f /etc/network/interfaces.d/50-cloud-init -sudo cp /etc/network/interfaces.d/50-cloud-init.bak /etc/network/interfaces.d/50-cloud-init -``` - -#### Step 2: Edit the configuration file - -> [!primary] -> -Note that the names of the network interfaces in our examples may differ from your own. Please adjust to your appropriate interface names. -> - -You can now modify the configuration file: - -```bash -sudo nano /etc/network/interfaces.d/50-cloud-init -``` - -Next, you need to add a virtual interface or ethernet alias. In our example, our interface is called `eth0`, so our alias is `eth0:0`. Do this for each additional IP you wish to configure. - -Do not modify the existing lines in the configuration file, simply add your Additional IP to the file as follows, replacing `ADDITIONAL_IP/32` as well as the virtual interface (if your server is not using **eth0:0**) wih your own values: - -```console -auto eth0:0 -iface eth0:0 inet static -address ADDITIONAL_IP -netmask 255.255.255.255 -``` - -Alternatively, you can configure your Additional IP by adding the following lines in the configuration file: - -```console -post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP netmask 255.255.255.255 broadcast ADDITIONAL_IP -pre-down /sbin/ifconfig eth0:0 down -``` - -With the configuration above, the virtual interface is enabled or disabled whenever the `eth0` interface is enabled or disabled. - -If you have two Additional IPs to configure, the `/etc/network/interfaces.d/50-cloud-init` file should look like this: - -```console -auto eth0 -iface eth0 inet dhcp - -auto eth0:0 -iface eth0:0 inet static -address ADDITIONAL_IP1 -netmask 255.255.255.255 - -auto eth0:1 -iface eth0:1 inet static -address ADDITIONAL_IP2 -netmask 255.255.255.255 -``` - -Or like this: - -```console -auto eth0 -iface eth0 inet dhcp - -# IP 1 -post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP1 netmask 255.255.255.255 broadcast ADDITIONAL_IP1 -pre-down /sbin/ifconfig eth0:0 down - -# IP 2 -post-up /sbin/ifconfig eth0:1 ADDITIONAL_IP2 netmask 255.255.255.255 broadcast ADDITIONAL_IP2 -pre-down /sbin/ifconfig eth0:1 down -``` - -Configuration example: - -```console -auto eth0 -iface eth0 inet dhcp - -auto eth0:0 -iface eth0:0 inet static -address 203.0.113.1 -netmask 255.255.255.255 -``` - -Or : - -```console -auto eth0 -iface eth0 inet dhcp - -# IP 1 -post-up /sbin/ifconfig eth0:0 203.0.113.1 netmask 255.255.255.255 broadcast 203.0.113.1 -pre-down /sbin/ifconfig eth0:0 down -``` - -#### Step 3: Restart the interface - -To restart the interface, use the following command: - -```bash -sudo /etc/init.d/networking restart -``` - -### Fedora 39 and following - -Fedora now uses keyfiles. NetworkManager previously stored network profiles in ifcfg format in this directory: `/etc/sysconfig/network-scripts/`. However, the ifcfg format is now deprecated. By default, NetworkManager no longer creates new profiles in this format. The configuration file is now found in `/etc/NetworkManager/system-connections/`. - -#### Step 1: Create a backup - -> [!primary] -> -> Note that the name of the network file in our example may differ from your own. Please adjust to your appropriate name. -> - -First, make a copy of the configuration file, so that you can revert at any time. In our example, our configuration file is called `cloud-init-eno1.nmconnection`. - -```bash -sudo cp -r /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak -``` - -#### Step 2: Edit the config file - -> [!primary] -> Please note that the name of the network file in our example may differ from yours. Please adapt the commands to your file name. -> - -To obtain the name of your network interface in order to edit the appropriate network file, you can run one of the following commands: - -```bash -ip a -``` - -```bash -nmcli connection show -``` - -Do not modify the existing lines in the configuration file, add your Additional IP to the file as follows, replacing `ADDITIONAL_IP/32` wih your own values: - -```bash -sudo nano /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -``` - -```console -[ipv4] -method=auto -may-fail=false -address1=ADDITIONAL_IP/32 -``` - -If you have two Additional IPs to configure, the configuration should look like this: - -```console -[ipv4] -method=auto -may-fail=false -address1=ADDITIONAL_IP1/32 -address2=ADDITIONAL_IP2/32 -``` - -Configuration example: - -```console -[ipv4] -method=auto -may-fail=false -address1=203.0.113.1/32 -``` - -#### Step 3: Restart the interface - -You now need to restart your interface: - -```bash -sudo systemctl restart NetworkManager -``` - -### Debian 12, Ubuntu 20.04 and following - -By default, the configuration files are located in the `/etc/netplan` directory. - -The best practice approach is to create a separate configuration file to set up Additional IP addresses. This way, you can easily revert the changes in case of an error. - -#### Step 1: Determine the interface - -```bash -ip a -``` - -Note the name of the interface (the one on which your server's main IP address is configured). - -#### Step 2: Create and edit the configuration file - -Next, create a configuration file with a `.yaml` extension. In our example, our file is called `51-cloud-init.yaml`. - -```bash -sudo nano /etc/netplan/51-cloud-init.yaml -``` - -Edit the file with the content below, replacing `INTERFACE_NAME` and `ADDITIONAL_IP` with your own values: - -```yaml -network: - version: 2 - ethernets: - INTERFACE_NAME: - dhcp4: true - addresses: - - ADDITIONAL_IP/32 -``` - -If you have two Additional IPs to configure, the configuration file should look like this: - -```yaml -network: - version: 2 - ethernets: - INTERFACE_NAME: - dhcp4: true - addresses: - - ADDITIONAL_IP1/32 - - ADDITIONAL_IP2/32 -``` - -> [!warning] -> It is important to respect the alignment of each element in this file as represented in the example above. Do not use the tab key to create your spacing. Only the space key is needed. +> [!success] +> Select the tab corresponding to your operating system. > -Configuration example: - -```yaml -network: - version: 2 - ethernets: - eth0: - dhcp4: true - addresses: - - 203.0.113.1/32 -``` - -Save and close the file. You can test the configuration with the following command: - -```bash -sudo netplan try -``` - -#### Step 3: Apply the change - -If it is correct, apply it using the following command: - -```bash -sudo netplan apply -``` - -> [!primary] -> When using the `netplan try` command, it is possible that the system returns a warning message such as `Permissions for /etc/netplan/xx-cloud-init.yaml are too open. Netplan configuration should NOT be accessible by others`. This simply means that the file does not have restrictive permissions. This does not affect the configuration of your Additional IP. For more information about file permissions, consult the [official documentation of ubuntu](https://help.ubuntu.com/community/FilePermissions). -> - -### AlmaLinux (8 & 9), Rocky Linux (8 & 9) - -The main configuration file is located in `/etc/sysconfig/network-scripts/`. In this example it is called `ifcfg-eth0`. Before making changes, verify the actual file name in this folder. - -For each Additional IP to be configured, we create a seperate configuration file with the following parameters: `ifcfg-NETWORK_INTERFACE:ID`. Where `NETWORK_INTERFACE` is the physical interface and `ID` is the virtual network interface or ethernet alias starting with a value of 0. For example, for our interface named `eth0` the first alias is `eth0:0`, the second alias is `eth0:1`, etc... - -#### Step 1: Determine the interface - -```bash -ip a -``` - -Note the name of the interface (the one on which your server's main IP address is configured). - -#### Step 2: Create the configuration file - -First, create the configuration file. Replace `NETWORK_INTERFACE:ID` with your own values. - -```bash -sudo nano /etc/sysconfig/network-scripts/ifcfg-NETWORK_INTERFACE:ID -``` - -Next, edit the file with the content below, replacing `NETWORK_INTERFACE:ID`, and `ADDITIONAL_IP` with your own values: - -```console -DEVICE=NETWORK_INTERFACE:ID -ONBOOT=yes -BOOTPROTO=none # For CentOS use "static" -IPADDR=ADDITIONAL_IP -NETMASK=255.255.255.255 -BROADCAST=ADDITIONAL_IP -``` - -Configuration example: - -```console -DEVICE=eth0:0 -ONBOOT=yes -BOOTPROTO=none # For CentOS use "static" -IPADDR=203.0.113.1 -NETMASK=255.255.255.255 -BROADCAST=203.0.113.1 -``` - -#### Step 3: Restart the interface - -Next, restart the network interface with the following command: - -```bash -sudo systemctl restart NetworkManager -``` - -### cPanel - -#### Step 1: Access the WHM IP management section - -In the WHM control panel, click on `IP Functions`{.action} and select `Add a New IP Address`{.action} in the left-hand sidebar. - -![Add new IP](images/Cpanel-1.png){.thumbnail} - -#### Step 2: Add the Additional IP information - -Enter your Additional IP in the form `xxx.xxx.xxx.xxx` into the field “New IP or IP range to add”. - -Select `255.255.255.255` as your subnet mask, then click on `Submit`{.action}. - -![enter new IP information](images/Cpanel-2024.png){.thumbnail} - -> [!warning] -> -> Please note that if you have more than one IP to configure on the same block and you add them all at once, the WHM system will force you to use the subnet mask `255.255.255.0`. We do not recommend using this configuration. Instead, you need to add each IP individually in order to use the proper subnet mask `255.255.255.255`. -> - -#### Step 3: Check the current IP configuration - -Back in the section `IP Functions`{.action}, click on `Show or Delete Current IP Addresses`{.action} to verify that the Additional IP address was added correctly. - -![check configured IP](images/Cpanel-2024-1.png){.thumbnail} - -### Windows Servers - -Windows servers are often DHCP-enabled in the network configuration. If you have already set up an Additional IP or switched your configuration to a fixed IP, go directly to the next step. - -Otherwise, you need to first switch from a network-level DHCP configuration to a fixed IP configuration. - -Open the command prompt `cmd`{.action} or `powershell`{.action}, then type the following command: - -```powershell -ipconfig -``` - -This will return a result similar to the following example: - -![Result of "ipconfig" command](images/ipconfig.png){.thumbnail} - -Identify and write down your IPv4, subnet mask, default gateway and the name of the network interface controller (network adapter). - -In our example, the server IP is **192.0.2.28**. - -You can perform the next steps via either a command-line interface or the graphical user interface. - -#### Via a command-line interface (recommended) - -In the commands below, you need to replace: - -|Command|Value| -|---|---| -|NETWORK_ADAPTER| Name of the network adapter (in our example: Ethernet 2)| -|IP_ADDRESS| Server IP address (in our example: 192.0.2.28)| -|SUBNET_MASK| Subnet mask (in our example: 255.255.255.0)| -|GATEWAY| Default gateway (in our example: 192.0.2.254)| -|ADDITIONAL_IP| Address of Additional IP you want to add (in our example 203.0.113.1)| - -> [!warning] -> -> Be careful – the server will no longer be accessible if you enter incorrect information. You will then have to make the corrections in [Winrescue mode](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) or via the [IPMI](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). -> - -In the command prompt: - -1\. Switch to a fixed IP - -```powershell -netsh interface ipv4 set address name="NETWORK_ADAPTER" static IP_ADDRESS SUBNET_MASK GATEWAY -``` - -2\. Set the DNS server - -```powershell -netsh interface ipv4 set dns name="NETWORK_ADAPTER" static 213.186.33.99 -``` - -3\. Add an Additional IP - -```powershell -netsh interface ipv4 add address "NETWORK_ADAPTER" ADDITIONAL_IP 255.255.255.255 -``` - -Your Additional IP is now functional. - -#### Via the graphical user interface - -1. Go to `Start`{.action}> `Control Panel`{.action}>` Network and Internet`{.action}> `Network and Sharing Centre`{.action}> `Change Adapter Settings `{.action}(in the left-hand menu). -2. Right-click on your network connection, in our example `Ethernet 2`{.action}. -3. Click on `Properties`{.action}. -4. Select `Internet Protocol Version 4 (TCP/IPv4)`{.action}, then click on `Properties`{.action}. -5. Click on `Use the following IP address`{.action} and type in your server’s primary IP, subnet mask and default gateway information obtained by using the `ipconfig`{.action} command above. In the "Preferred DNS Server" box, type 213.186.33.99. - -![Internet Protocol Version 4 (TCP/IPv4) Properties](images/configure-main-ip.png){.thumbnail} - -> [!warning] -> -> Be careful – the server will no longer be accessible if you enter incorrect information. You will then have to make the corrections in [Winrescue mode](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) or via the [IPMI](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). -> - -Then click on `Advanced`{.action} (still in the `TCP/IP Settings`{.action}). - -![Internet Protocol Version 4 (TCP/IPv4) Properties](images/configure-main-ip-1.png){.thumbnail} - -In the `IP Address`{.action} section, click `Add`{.action}: - -![Advanced TCP/IPv4 Settings](images/add-additional-ip.png){.thumbnail} - -Type in your Additional IP and the subnet mask **255.255.255.255**. Then click on `Add`{.action} - -![TCP/IP Address](images/configure-additional-ip.png){.thumbnail} - - -Click on `OK`{.action} to apply your configuration. - -Your Additional IP is now functional, you can verify the configuration with the following command: - -```powershell -ipconfig -``` - -This will return a result similar to the following example: - -![Final configuration](images/final-ip-configuration.png){.thumbnail} - -### Plesk - -#### Step 1: Access the Plesk IP management section - -In the Plesk control panel, choose `Tools & Settings`{.action} from the left-hand sidebar. - -![acces to the ip addresses management](images/pleskip1.png){.thumbnail} - -Click on `IP Addresses`{.action} under **Tools & Resources**. - -#### Step 2: Add the Additional IP information - -In this section, click on the button `Add IP Address`{.action}. - -![add ip information](images/Plesk-2024.png){.thumbnail} - -Enter your Additional IP in the form `xxx.xxx.xxx.xxx/32` into the field "IP address and subnet mask", then click on `OK`{.action}. - -![add ip information](images/Plesk-2024-1.png){.thumbnail} - -#### Step 3: Check the current IP configuration - -Back in the section "IP Addresses", verify that the Additional IP address was added correctly. - -![current IP configuration](images/Plesk-2024-2.png){.thumbnail} +> [!tabs] +> Debian 11 +>> **Debian 11** +>> +>> By default, the configuration files are located in `/etc/network/interfaces.d/`. We recommend that you start by backing up the relevant configuration file. +>> +>> Step 1: Create a backup +>> +>> In our example, our file is called `50-cloud-init`, so we make a copy of the `50-cloud-init` file using the following command: +>> +>> ```bash +>> sudo cp /etc/network/interfaces.d/50-cloud-init /etc/network/interfaces.d/50-cloud-init.bak +>> ``` +>> +>> In case of a mistake, you will be able to revert the changes, using the commands below: +>> +>> ```bash +>> sudo rm -f /etc/network/interfaces.d/50-cloud-init +>> sudo cp /etc/network/interfaces.d/50-cloud-init.bak /etc/network/interfaces.d/50-cloud-init +>> ``` +>> +>> Step 2: Edit the configuration file +>> +>> > [!primary] +>> > Note that the names of the network interfaces in our examples may differ from your own. Please adjust to your appropriate interface names. +>> > +>> +>> You can now modify the configuration file: +>> +>> ```bash +>> sudo nano /etc/network/interfaces.d/50-cloud-init +>> ``` +>> +>> Next, you need to add a virtual interface or ethernet alias. In our example, our interface is called `eth0`, so our alias is `eth0:0`. Do this for each additional IP you wish to configure. +>> +>> Do not modify the existing lines in the configuration file, simply add your Additional IP to the file as follows, replacing `ADDITIONAL_IP/32` as well as the virtual interface (if your server is not using **eth0:0**) wih your own values: +>> +>> ```console +>> auto eth0:0 +>> iface eth0:0 inet static +>> address ADDITIONAL_IP +>> netmask 255.255.255.255 +>> ``` +>> +>> Alternatively, you can configure your Additional IP by adding the following lines in the configuration file: +>> +>> ```console +>> post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP netmask 255.255.255.255 broadcast ADDITIONAL_IP +>> pre-down /sbin/ifconfig eth0:0 down +>> ``` +>> +>> With the configuration above, the virtual interface is enabled or disabled whenever the `eth0` interface is enabled or disabled. +>> +>> If you have two Additional IPs to configure, the `/etc/network/interfaces.d/50-cloud-init` file should look like this: +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> auto eth0:0 +>> iface eth0:0 inet static +>> address ADDITIONAL_IP1 +>> netmask 255.255.255.255 +>> +>> auto eth0:1 +>> iface eth0:1 inet static +>> address ADDITIONAL_IP2 +>> netmask 255.255.255.255 +>> ``` +>> +>> Or like this: +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> # IP 1 +>> post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP1 netmask 255.255.255.255 broadcast ADDITIONAL_IP1 +>> pre-down /sbin/ifconfig eth0:0 down +>> +>> # IP 2 +>> post-up /sbin/ifconfig eth0:1 ADDITIONAL_IP2 netmask 255.255.255.255 broadcast ADDITIONAL_IP2 +>> pre-down /sbin/ifconfig eth0:1 down +>> ``` +>> +>> /// details | **Configuration example** +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> auto eth0:0 +>> iface eth0:0 inet static +>> address 203.0.113.1 +>> netmask 255.255.255.255 +>> ``` +>> +>> Or: +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> # IP 1 +>> post-up /sbin/ifconfig eth0:0 203.0.113.1 netmask 255.255.255.255 broadcast 203.0.113.1 +>> pre-down /sbin/ifconfig eth0:0 down +>> ``` +>> /// +>> +>> Step 3: Restart the interface +>> +>> To restart the interface, use the following command: +>> +>> ```bash +>> sudo /etc/init.d/networking restart +>> ``` +>> +> Fedora 41+ +>> **Fedora 41 and following** +>> +>> Fedora now uses keyfiles. NetworkManager previously stored network profiles in ifcfg format in this directory: `/etc/sysconfig/network-scripts/`. However, the ifcfg format is now deprecated. By default, NetworkManager no longer creates new profiles in this format. The configuration file is now found in `/etc/NetworkManager/system-connections/`. +>> +>> Step 1: Create a backup +>> +>> > [!primary] +>> > +>> > Note that the name of the network file in our example may differ from your own. Please adjust to your appropriate name. +>> > +>> +>> First, make a copy of the configuration file, so that you can revert at any time. In our example, our configuration file is called `cloud-init-eno1.nmconnection`. +>> +>> ```bash +>> sudo cp -r /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak +>> ``` +>> +>> Step 2: Edit the config file +>> +>> > [!primary] +>> > Please note that the name of the network file in our example may differ from yours. Please adapt the commands to your file name. +>> > +>> +>> To obtain the name of your network interface in order to edit the appropriate network file, you can run one of the following commands: +>> +>> ```bash +>> ip a +>> ``` +>> +>> ```bash +>> nmcli connection show +>> ``` +>> +>> Do not modify the existing lines in the configuration file, add your Additional IP to the file as follows, replacing `ADDITIONAL_IP/32` wih your own values: +>> +>> ```bash +>> sudo nano /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> ``` +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=ADDITIONAL_IP/32 +>> ``` +>> +>> If you have two Additional IPs to configure, the configuration should look like this: +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=ADDITIONAL_IP1/32 +>> address2=ADDITIONAL_IP2/32 +>> ``` +>> +>> /// details | **Configuration example** +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=203.0.113.1/32 +>> ``` +>> /// +>> +>> Step 3: Restart the interface +>> +>> You now need to restart your interface: +>> +>> ```bash +>> sudo systemctl restart NetworkManager +>> ``` +>> +> Debian 12 and Ubuntu 20.04+ +>> **Debian 12, Ubuntu 20.04 and following** +>> +>> By default, the configuration files are located in the `/etc/netplan` directory. +>> +>> The best practice approach is to create a separate configuration file to set up Additional IP addresses. This way, you can easily revert the changes in case of an error. +>> +>> Step 1: Determine the interface +>> +>> ```bash +>> ip a +>> ``` +>> +>> Note the name of the interface (the one on which your server's main IP address is configured). +>> +>> Step 2: Create and edit the configuration file +>> +>> Next, create a configuration file with a `.yaml` extension. In our example, our file is called `51-cloud-init.yaml`. +>> +>> ```bash +>> sudo nano /etc/netplan/51-cloud-init.yaml +>> ``` +>> +>> Edit the file with the content below, replacing `INTERFACE_NAME` and `ADDITIONAL_IP` with your own values: +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> INTERFACE_NAME: +>> dhcp4: true +>> addresses: +>> - ADDITIONAL_IP/32 +>> ``` +>> +>> If you have two Additional IPs to configure, the configuration file should look like this: +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> INTERFACE_NAME: +>> dhcp4: true +>> addresses: +>> - ADDITIONAL_IP1/32 +>> - ADDITIONAL_IP2/32 +>> ``` +>> +>> +>> > [!warning] +>> > It is important to respect the alignment of each element in this file as represented in the example above. Do not use the tab key to create your spacing. Only the space key is needed. +>> > +>> +>> /// details | **Configuration example** +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> eth0: +>> dhcp4: true +>> addresses: +>> - 203.0.113.1/32 +>> ``` +>> /// +>> +>> Save and close the file. You can test the configuration with the following command: +>> +>> ```bash +>> sudo netplan try +>> ``` +>> +>> Step 3: Apply the change +>> +>> If it is correct, apply it using the following command: +>> +>> ```bash +>> sudo netplan apply +>> ``` +>> +>> > [!primary] +>> > When using the `netplan try` command, it is possible that the system returns a warning message such as `Permissions for /etc/netplan/xx-cloud-init.yaml are too open. Netplan configuration should NOT be accessible by others`. This simply means that the file does not have restrictive permissions. This does not affect the configuration of your Additional IP. For more information about file permissions, consult the [official documentation of ubuntu](https://help.ubuntu.com/community/FilePermissions). +>> > +>> +> AlmaLinux / Rocky Linux +>> **AlmaLinux (8 & 9), Rocky Linux (8 & 9)** +>> +>> The main configuration file is located in `/etc/sysconfig/network-scripts/`. In this example it is called `ifcfg-eth0`. Before making changes, verify the actual file name in this folder. +>> +>> For each Additional IP to be configured, we create a seperate configuration file with the following parameters: `ifcfg-NETWORK_INTERFACE:ID`. Where `NETWORK_INTERFACE` is the physical interface and `ID` is the virtual network interface or ethernet alias starting with a value of 0. For example, for our interface named `eth0` the first alias is `eth0:0`, the second alias is `eth0:1`, etc... +>> +>> Step 1: Determine the interface +>> +>> ```bash +>> ip a +>> ``` +>> +>> Note the name of the interface (the one on which your server's main IP address is configured). +>> +>> Step 2: Create the configuration file +>> +>> First, create the configuration file. Replace `NETWORK_INTERFACE:ID` with your own values. +>> +>> ```bash +>> sudo nano /etc/sysconfig/network-scripts/ifcfg-NETWORK_INTERFACE:ID +>> ``` +>> +>> Next, edit the file with the content below, replacing `NETWORK_INTERFACE:ID`, and `ADDITIONAL_IP` with your own values: +>> +>> ```console +>> DEVICE=NETWORK_INTERFACE:ID +>> ONBOOT=yes +>> BOOTPROTO=none # For CentOS use "static" +>> IPADDR=ADDITIONAL_IP +>> NETMASK=255.255.255.255 +>> BROADCAST=ADDITIONAL_IP +>> ``` +>> +>> /// details | **Configuration example** +>> +>> ```console +>> DEVICE=eth0:0 +>> ONBOOT=yes +>> BOOTPROTO=none # For CentOS use "static" +>> IPADDR=203.0.113.1 +>> NETMASK=255.255.255.255 +>> BROADCAST=203.0.113.1 +>> ``` +>> /// +>> +>> Step 3: Restart the interface +>> +>> Next, restart the network interface with the following command: +>> +>> ```bash +>> sudo systemctl restart NetworkManager +>> ``` +>> +> cPanel +>> **cPanel** +>> +>> Step 1: Access the WHM IP management section +>> +>> In the WHM control panel, click on `IP Functions`{.action} and select `Add a New IP Address`{.action} in the left-hand sidebar. +>> +>> ![Add new IP](images/Cpanel-1.png){.thumbnail} +>> +>> Step 2: Add the Additional IP information +>> +>> Enter your Additional IP in the form `xxx.xxx.xxx.xxx` into the field “New IP or IP range to add”. +>> +>> Select `255.255.255.255` as your subnet mask, then click on `Submit`{.action}. +>> +>> ![enter new IP information](images/Cpanel-2024.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Please note that if you have more than one IP to configure on the same block and you add them all at once, the WHM system will force you to use the subnet mask `255.255.255.0`. We do not recommend using this configuration. Instead, you need to add each IP individually in order to use the proper subnet mask `255.255.255.255`. +>> > +>> +>> Step 3: Check the current IP configuration +>> +>> Back in the section `IP Functions`{.action}, click on `Show or Delete Current IP Addresses`{.action} to verify that the Additional IP address was added correctly. +>> +>> ![check configured IP](images/Cpanel-2024-1.png){.thumbnail} +>> +> Windows Servers +>> **Windows Servers** +>> +>> Windows servers are often DHCP-enabled in the network configuration. If you have already set up an Additional IP or switched your configuration to a fixed IP, go directly to the next step. +>> +>> Otherwise, you need to first switch from a network-level DHCP configuration to a fixed IP configuration. +>> +>> Open the command prompt `cmd`{.action} or `powershell`{.action}, then type the following command: +>> +>> ```powershell +>> ipconfig +>> ``` +>> +>> This will return a result similar to the following example: +>> +>> ![Result of "ipconfig" command](images/ipconfig.png){.thumbnail} +>> +>> Identify and write down your IPv4, subnet mask, default gateway and the name of the network interface controller (network adapter). +>> +>> In our example, the server IP is **192.0.2.28**. +>> +>> You can perform the next steps via either a command-line interface or the graphical user interface. +>> +>> **Via a command-line interface (recommended)** +>> +>> In the commands below, you need to replace: +>> +>> |Command|Value| +>> |---|---| +>> |NETWORK_ADAPTER| Name of the network adapter (in our example: Ethernet 2)| +>> |IP_ADDRESS| Server IP address (in our example: 192.0.2.28)| +>> |SUBNET_MASK| Subnet mask (in our example: 255.255.255.0)| +>> |GATEWAY| Default gateway (in our example: 192.0.2.254)| +>> |ADDITIONAL_IP| Address of Additional IP you want to add (in our example 203.0.113.1)| +>> +>> > [!warning] +>> > +>> > Be careful – the server will no longer be accessible if you enter incorrect information. You will then have to make the corrections in [Winrescue mode](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) or via the [IPMI](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). +>> > +>> +>> In the command prompt: +>> +>> 1\. Switch to a fixed IP +>> +>> ```powershell +>> netsh interface ipv4 set address name="NETWORK_ADAPTER" static IP_ADDRESS SUBNET_MASK GATEWAY +>> ``` +>> +>> 2\. Set the DNS server +>> +>> ```powershell +>> netsh interface ipv4 set dns name="NETWORK_ADAPTER" static 213.186.33.99 +>> ``` +>> +>> 3\. Add an Additional IP +>> +>> ```powershell +>> netsh interface ipv4 add address "NETWORK_ADAPTER" ADDITIONAL_IP 255.255.255.255 +>> ``` +>> +>> Your Additional IP is now functional. +>> +>> /// details | **Via the graphical user interface** +>> +>> 1. Go to `Start`{.action}> `Control Panel`{.action}>` Network and Internet`{.action}> `Network and Sharing Centre`{.action}> `Change Adapter Settings `{.action}(in the left-hand menu). +>> 2. Right-click on your network connection, in our example `Ethernet 2`{.action}. +>> 3. Click on `Properties`{.action}. +>> 4. Select `Internet Protocol Version 4 (TCP/IPv4)`{.action}, then click on `Properties`{.action}. +>> 5. Click on `Use the following IP address`{.action} and type in your server’s primary IP, subnet mask and default gateway information obtained by using the `ipconfig`{.action} command above. In the "Preferred DNS Server" box, type 213.186.33.99. +>> +>> ![Internet Protocol Version 4 (TCP/IPv4) Properties](images/configure-main-ip.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Be careful – the server will no longer be accessible if you enter incorrect information. You will then have to make the corrections in [Winrescue mode](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) or via the [IPMI](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). +>> > +>> +>> Then click on `Advanced`{.action} (still in the `TCP/IP Settings`{.action}). +>> +>> ![Internet Protocol Version 4 (TCP/IPv4) Properties](images/configure-main-ip-1.png){.thumbnail} +>> +>> In the `IP Address`{.action} section, click `Add`{.action}: +>> +>> ![Advanced TCP/IPv4 Settings](images/add-additional-ip.png){.thumbnail} +>> +>> Type in your Additional IP and the subnet mask **255.255.255.255**. Then click on `Add`{.action} +>> +>> ![TCP/IP Address](images/configure-additional-ip.png){.thumbnail} +>> +>> +>> Click on `OK`{.action} to apply your configuration. +>> +>> +>> Your Additional IP is now functional, you can verify the configuration with the following command: +>> +>> ```powershell +>> ipconfig +>> ``` +>> +>> This will return a result similar to the following example: +>> +>> ![Final configuration](images/final-ip-configuration.png){.thumbnail} +>> +>> /// +>> +> Plesk +>> **Plesk** +>> +>> Step 1: Access the Plesk IP management section +>> +>> In the Plesk control panel, choose `Tools & Settings`{.action} from the left-hand sidebar. +>> +>> ![acces to the ip addresses management](images/pleskip1.png){.thumbnail} +>> +>> Click on `IP Addresses`{.action} under **Tools & Resources**. +>> +>> Step 2: Add the Additional IP information +>> +>> In this section, click on the button `Add IP Address`{.action}. +>> +>> ![add ip information](images/Plesk-2024.png){.thumbnail} +>> +>> Enter your Additional IP in the form `xxx.xxx.xxx.xxx/32` into the field "IP address and subnet mask", then click on `OK`{.action}. +>> +>> ![add ip information](images/Plesk-2024-1.png){.thumbnail} +>> +>> Step 3: Check the current IP configuration +>> +>> Back in the section "IP Addresses", verify that the Additional IP address was added correctly. +>> +>> ![current IP configuration](images/Plesk-2024-2.png){.thumbnail} +>> ### Troubleshooting @@ -540,7 +573,7 @@ Once you are connected to your server via SSH, enter the following command: ifconfig eth0:0 ADDITIONAL_IP netmask 255.255.255.255 broadcast ADDITIONAL_IP up ``` -To test the connection, simply ping your Additional IP from the outside. If it responds in rescue mode, that probably means that there is a configuration error. If, however, the IP is still not working, please open a ticket with the support team via the [OVHcloud Help Centre](https://help.ovhcloud.com/csm?id=csm_get_help) with the following information: +To test the connection, simply ping your Additional IP from the outside. If it responds in rescue mode, that probably means that there is a configuration error. If, however, the IP is still not working, please open a ticket with the support team via the [OVHcloud Help Center](https://help.ovhcloud.com/csm?id=csm_get_help) with the following information: It is necessary to provide: diff --git a/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.en-sg.md b/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.en-sg.md index 2c6e95eaf10..4e9c7201a42 100644 --- a/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.en-sg.md +++ b/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.en-sg.md @@ -1,9 +1,23 @@ --- title: 'Configuring IP aliasing' excerpt: 'Find out how to add Additional IP addresses to your server configuration' -updated: 2025-07-22 +updated: 2025-11-12 --- + + > [!primary] > This article is about Additional IPv4 configuration on a public interface. You can also configure Primary IPv6 addresses on your dedicated servers using [this guide](/pages/bare_metal_cloud/dedicated_servers/network_ipv6). > @@ -41,8 +55,7 @@ IP aliasing is a special network configuration for your OVHcloud dedicated serve The following sections contain configurations for the distributions we currently offer and the most commonly used distributions/operating systems. The first step is always to log in to your server via SSH or a GUI login session (RDP for a Windows server). > [!primary] -> -Concerning different distribution releases, please note that the proper procedure to configure your network interface as well as the file names may have been subject to change. We recommend to consult the manuals and knowledge resources of the respective OS versions if you experience any issues. +> Concerning different distribution releases, please note that the proper procedure to configure your network interface as well as the file names may have been subject to change. We recommend to consult the manuals and knowledge resources of the respective OS versions if you experience any issues. > **Please take note of the following terminology that will be used in code examples and instructions of the guide sections below:** @@ -55,480 +68,500 @@ Concerning different distribution releases, please note that the proper procedur In the examples below, we will use the `nano` text editor. With some operating systems, you will need to install it first before using it. If this is the case, you will be prompted to do so. You can, of course, use the text editor of your choice. -### Debian 11 - -By default, the configuration files are located in `/etc/network/interfaces.d/`. We recommend that you start by backing up the relevant configuration file. - -#### Step 1: Create a backup - -In our example, our file is called `50-cloud-init`, so we make a copy of the `50-cloud-init` file using the following command: - -```bash -sudo cp /etc/network/interfaces.d/50-cloud-init /etc/network/interfaces.d/50-cloud-init.bak -``` - -In case of a mistake, you will be able to revert the changes, using the commands below: - -```bash -sudo rm -f /etc/network/interfaces.d/50-cloud-init -sudo cp /etc/network/interfaces.d/50-cloud-init.bak /etc/network/interfaces.d/50-cloud-init -``` - -#### Step 2: Edit the configuration file - -> [!primary] -> -Note that the names of the network interfaces in our examples may differ from your own. Please adjust to your appropriate interface names. -> - -You can now modify the configuration file: - -```bash -sudo nano /etc/network/interfaces.d/50-cloud-init -``` - -Next, you need to add a virtual interface or ethernet alias. In our example, our interface is called `eth0`, so our alias is `eth0:0`. Do this for each additional IP you wish to configure. - -Do not modify the existing lines in the configuration file, simply add your Additional IP to the file as follows, replacing `ADDITIONAL_IP/32` as well as the virtual interface (if your server is not using **eth0:0**) wih your own values: - -```console -auto eth0:0 -iface eth0:0 inet static -address ADDITIONAL_IP -netmask 255.255.255.255 -``` - -Alternatively, you can configure your Additional IP by adding the following lines in the configuration file: - -```console -post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP netmask 255.255.255.255 broadcast ADDITIONAL_IP -pre-down /sbin/ifconfig eth0:0 down -``` - -With the configuration above, the virtual interface is enabled or disabled whenever the `eth0` interface is enabled or disabled. - -If you have two Additional IPs to configure, the `/etc/network/interfaces.d/50-cloud-init` file should look like this: - -```console -auto eth0 -iface eth0 inet dhcp - -auto eth0:0 -iface eth0:0 inet static -address ADDITIONAL_IP1 -netmask 255.255.255.255 - -auto eth0:1 -iface eth0:1 inet static -address ADDITIONAL_IP2 -netmask 255.255.255.255 -``` - -Or like this: - -```console -auto eth0 -iface eth0 inet dhcp - -# IP 1 -post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP1 netmask 255.255.255.255 broadcast ADDITIONAL_IP1 -pre-down /sbin/ifconfig eth0:0 down - -# IP 2 -post-up /sbin/ifconfig eth0:1 ADDITIONAL_IP2 netmask 255.255.255.255 broadcast ADDITIONAL_IP2 -pre-down /sbin/ifconfig eth0:1 down -``` - -Configuration example: - -```console -auto eth0 -iface eth0 inet dhcp - -auto eth0:0 -iface eth0:0 inet static -address 203.0.113.1 -netmask 255.255.255.255 -``` - -Or : - -```console -auto eth0 -iface eth0 inet dhcp - -# IP 1 -post-up /sbin/ifconfig eth0:0 203.0.113.1 netmask 255.255.255.255 broadcast 203.0.113.1 -pre-down /sbin/ifconfig eth0:0 down -``` - -#### Step 3: Restart the interface - -To restart the interface, use the following command: - -```bash -sudo /etc/init.d/networking restart -``` - -### Fedora 39 and following - -Fedora now uses keyfiles. NetworkManager previously stored network profiles in ifcfg format in this directory: `/etc/sysconfig/network-scripts/`. However, the ifcfg format is now deprecated. By default, NetworkManager no longer creates new profiles in this format. The configuration file is now found in `/etc/NetworkManager/system-connections/`. - -#### Step 1: Create a backup - -> [!primary] -> -> Note that the name of the network file in our example may differ from your own. Please adjust to your appropriate name. -> - -First, make a copy of the configuration file, so that you can revert at any time. In our example, our configuration file is called `cloud-init-eno1.nmconnection`. - -```bash -sudo cp -r /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak -``` - -#### Step 2: Edit the config file - -> [!primary] -> Please note that the name of the network file in our example may differ from yours. Please adapt the commands to your file name. -> - -To obtain the name of your network interface in order to edit the appropriate network file, you can run one of the following commands: - -```bash -ip a -``` - -```bash -nmcli connection show -``` - -Do not modify the existing lines in the configuration file, add your Additional IP to the file as follows, replacing `ADDITIONAL_IP/32` wih your own values: - -```bash -sudo nano /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -``` - -```console -[ipv4] -method=auto -may-fail=false -address1=ADDITIONAL_IP/32 -``` - -If you have two Additional IPs to configure, the configuration should look like this: - -```console -[ipv4] -method=auto -may-fail=false -address1=ADDITIONAL_IP1/32 -address2=ADDITIONAL_IP2/32 -``` - -Configuration example: - -```console -[ipv4] -method=auto -may-fail=false -address1=203.0.113.1/32 -``` - -#### Step 3: Restart the interface - -You now need to restart your interface: - -```bash -sudo systemctl restart NetworkManager -``` - -### Debian 12, Ubuntu 20.04 and following - -By default, the configuration files are located in the `/etc/netplan` directory. - -The best practice approach is to create a separate configuration file to set up Additional IP addresses. This way, you can easily revert the changes in case of an error. - -#### Step 1: Determine the interface - -```bash -ip a -``` - -Note the name of the interface (the one on which your server's main IP address is configured). - -#### Step 2: Create and edit the configuration file - -Next, create a configuration file with a `.yaml` extension. In our example, our file is called `51-cloud-init.yaml`. - -```bash -sudo nano /etc/netplan/51-cloud-init.yaml -``` - -Edit the file with the content below, replacing `INTERFACE_NAME` and `ADDITIONAL_IP` with your own values: - -```yaml -network: - version: 2 - ethernets: - INTERFACE_NAME: - dhcp4: true - addresses: - - ADDITIONAL_IP/32 -``` - -If you have two Additional IPs to configure, the configuration file should look like this: - -```yaml -network: - version: 2 - ethernets: - INTERFACE_NAME: - dhcp4: true - addresses: - - ADDITIONAL_IP1/32 - - ADDITIONAL_IP2/32 -``` - -> [!warning] -> It is important to respect the alignment of each element in this file as represented in the example above. Do not use the tab key to create your spacing. Only the space key is needed. +> [!success] +> Select the tab corresponding to your operating system. > -Configuration example: - -```yaml -network: - version: 2 - ethernets: - eth0: - dhcp4: true - addresses: - - 203.0.113.1/32 -``` - -Save and close the file. You can test the configuration with the following command: - -```bash -sudo netplan try -``` - -#### Step 3: Apply the change - -If it is correct, apply it using the following command: - -```bash -sudo netplan apply -``` - -> [!primary] -> When using the `netplan try` command, it is possible that the system returns a warning message such as `Permissions for /etc/netplan/xx-cloud-init.yaml are too open. Netplan configuration should NOT be accessible by others`. This simply means that the file does not have restrictive permissions. This does not affect the configuration of your Additional IP. For more information about file permissions, consult the [official documentation of ubuntu](https://help.ubuntu.com/community/FilePermissions). -> - -### AlmaLinux (8 & 9), Rocky Linux (8 & 9) - -The main configuration file is located in `/etc/sysconfig/network-scripts/`. In this example it is called `ifcfg-eth0`. Before making changes, verify the actual file name in this folder. - -For each Additional IP to be configured, we create a seperate configuration file with the following parameters: `ifcfg-NETWORK_INTERFACE:ID`. Where `NETWORK_INTERFACE` is the physical interface and `ID` is the virtual network interface or ethernet alias starting with a value of 0. For example, for our interface named `eth0` the first alias is `eth0:0`, the second alias is `eth0:1`, etc... - -#### Step 1: Determine the interface - -```bash -ip a -``` - -Note the name of the interface (the one on which your server's main IP address is configured). - -#### Step 2: Create the configuration file - -First, create the configuration file. Replace `NETWORK_INTERFACE:ID` with your own values. - -```bash -sudo nano /etc/sysconfig/network-scripts/ifcfg-NETWORK_INTERFACE:ID -``` - -Next, edit the file with the content below, replacing `NETWORK_INTERFACE:ID`, and `ADDITIONAL_IP` with your own values: - -```console -DEVICE=NETWORK_INTERFACE:ID -ONBOOT=yes -BOOTPROTO=none # For CentOS use "static" -IPADDR=ADDITIONAL_IP -NETMASK=255.255.255.255 -BROADCAST=ADDITIONAL_IP -``` - -Configuration example: - -```console -DEVICE=eth0:0 -ONBOOT=yes -BOOTPROTO=none # For CentOS use "static" -IPADDR=203.0.113.1 -NETMASK=255.255.255.255 -BROADCAST=203.0.113.1 -``` - -#### Step 3: Restart the interface - -Next, restart the network interface with the following command: - -```bash -sudo systemctl restart NetworkManager -``` - -### cPanel - -#### Step 1: Access the WHM IP management section - -In the WHM control panel, click on `IP Functions`{.action} and select `Add a New IP Address`{.action} in the left-hand sidebar. - -![Add new IP](images/Cpanel-1.png){.thumbnail} - -#### Step 2: Add the Additional IP information - -Enter your Additional IP in the form `xxx.xxx.xxx.xxx` into the field “New IP or IP range to add”. - -Select `255.255.255.255` as your subnet mask, then click on `Submit`{.action}. - -![enter new IP information](images/Cpanel-2024.png){.thumbnail} - -> [!warning] -> -> Please note that if you have more than one IP to configure on the same block and you add them all at once, the WHM system will force you to use the subnet mask `255.255.255.0`. We do not recommend using this configuration. Instead, you need to add each IP individually in order to use the proper subnet mask `255.255.255.255`. -> - -#### Step 3: Check the current IP configuration - -Back in the section `IP Functions`{.action}, click on `Show or Delete Current IP Addresses`{.action} to verify that the Additional IP address was added correctly. - -![check configured IP](images/Cpanel-2024-1.png){.thumbnail} - -### Windows Servers - -Windows servers are often DHCP-enabled in the network configuration. If you have already set up an Additional IP or switched your configuration to a fixed IP, go directly to the next step. - -Otherwise, you need to first switch from a network-level DHCP configuration to a fixed IP configuration. - -Open the command prompt `cmd`{.action} or `powershell`{.action}, then type the following command: - -```powershell -ipconfig -``` - -This will return a result similar to the following example: - -![Result of "ipconfig" command](images/ipconfig.png){.thumbnail} - -Identify and write down your IPv4, subnet mask, default gateway and the name of the network interface controller (network adapter). - -In our example, the server IP is **192.0.2.28**. - -You can perform the next steps via either a command-line interface or the graphical user interface. - -#### Via a command-line interface (recommended) - -In the commands below, you need to replace: - -|Command|Value| -|---|---| -|NETWORK_ADAPTER| Name of the network adapter (in our example: Ethernet 2)| -|IP_ADDRESS| Server IP address (in our example: 192.0.2.28)| -|SUBNET_MASK| Subnet mask (in our example: 255.255.255.0)| -|GATEWAY| Default gateway (in our example: 192.0.2.254)| -|ADDITIONAL_IP| Address of Additional IP you want to add (in our example 203.0.113.1)| - -> [!warning] -> -> Be careful – the server will no longer be accessible if you enter incorrect information. You will then have to make the corrections in [Winrescue mode](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) or via the [IPMI](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). -> - -In the command prompt: - -1\. Switch to a fixed IP - -```powershell -netsh interface ipv4 set address name="NETWORK_ADAPTER" static IP_ADDRESS SUBNET_MASK GATEWAY -``` - -2\. Set the DNS server - -```powershell -netsh interface ipv4 set dns name="NETWORK_ADAPTER" static 213.186.33.99 -``` - -3\. Add an Additional IP - -```powershell -netsh interface ipv4 add address "NETWORK_ADAPTER" ADDITIONAL_IP 255.255.255.255 -``` - -Your Additional IP is now functional. - -#### Via the graphical user interface - -1. Go to `Start`{.action}> `Control Panel`{.action}>` Network and Internet`{.action}> `Network and Sharing Centre`{.action}> `Change Adapter Settings `{.action}(in the left-hand menu). -2. Right-click on your network connection, in our example `Ethernet 2`{.action}. -3. Click on `Properties`{.action}. -4. Select `Internet Protocol Version 4 (TCP/IPv4)`{.action}, then click on `Properties`{.action}. -5. Click on `Use the following IP address`{.action} and type in your server’s primary IP, subnet mask and default gateway information obtained by using the `ipconfig`{.action} command above. In the "Preferred DNS Server" box, type 213.186.33.99. - -![Internet Protocol Version 4 (TCP/IPv4) Properties](images/configure-main-ip.png){.thumbnail} - -> [!warning] -> -> Be careful – the server will no longer be accessible if you enter incorrect information. You will then have to make the corrections in [Winrescue mode](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) or via the [IPMI](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). -> - -Then click on `Advanced`{.action} (still in the `TCP/IP Settings`{.action}). - -![Internet Protocol Version 4 (TCP/IPv4) Properties](images/configure-main-ip-1.png){.thumbnail} - -In the `IP Address`{.action} section, click `Add`{.action}: - -![Advanced TCP/IPv4 Settings](images/add-additional-ip.png){.thumbnail} - -Type in your Additional IP and the subnet mask **255.255.255.255**. Then click on `Add`{.action} - -![TCP/IP Address](images/configure-additional-ip.png){.thumbnail} - - -Click on `OK`{.action} to apply your configuration. - -Your Additional IP is now functional, you can verify the configuration with the following command: - -```powershell -ipconfig -``` - -This will return a result similar to the following example: - -![Final configuration](images/final-ip-configuration.png){.thumbnail} - -### Plesk - -#### Step 1: Access the Plesk IP management section - -In the Plesk control panel, choose `Tools & Settings`{.action} from the left-hand sidebar. - -![acces to the ip addresses management](images/pleskip1.png){.thumbnail} - -Click on `IP Addresses`{.action} under **Tools & Resources**. - -#### Step 2: Add the Additional IP information - -In this section, click on the button `Add IP Address`{.action}. - -![add ip information](images/Plesk-2024.png){.thumbnail} - -Enter your Additional IP in the form `xxx.xxx.xxx.xxx/32` into the field "IP address and subnet mask", then click on `OK`{.action}. - -![add ip information](images/Plesk-2024-1.png){.thumbnail} - -#### Step 3: Check the current IP configuration - -Back in the section "IP Addresses", verify that the Additional IP address was added correctly. - -![current IP configuration](images/Plesk-2024-2.png){.thumbnail} +> [!tabs] +> Debian 11 +>> **Debian 11** +>> +>> By default, the configuration files are located in `/etc/network/interfaces.d/`. We recommend that you start by backing up the relevant configuration file. +>> +>> Step 1: Create a backup +>> +>> In our example, our file is called `50-cloud-init`, so we make a copy of the `50-cloud-init` file using the following command: +>> +>> ```bash +>> sudo cp /etc/network/interfaces.d/50-cloud-init /etc/network/interfaces.d/50-cloud-init.bak +>> ``` +>> +>> In case of a mistake, you will be able to revert the changes, using the commands below: +>> +>> ```bash +>> sudo rm -f /etc/network/interfaces.d/50-cloud-init +>> sudo cp /etc/network/interfaces.d/50-cloud-init.bak /etc/network/interfaces.d/50-cloud-init +>> ``` +>> +>> Step 2: Edit the configuration file +>> +>> > [!primary] +>> > Note that the names of the network interfaces in our examples may differ from your own. Please adjust to your appropriate interface names. +>> > +>> +>> You can now modify the configuration file: +>> +>> ```bash +>> sudo nano /etc/network/interfaces.d/50-cloud-init +>> ``` +>> +>> Next, you need to add a virtual interface or ethernet alias. In our example, our interface is called `eth0`, so our alias is `eth0:0`. Do this for each additional IP you wish to configure. +>> +>> Do not modify the existing lines in the configuration file, simply add your Additional IP to the file as follows, replacing `ADDITIONAL_IP/32` as well as the virtual interface (if your server is not using **eth0:0**) wih your own values: +>> +>> ```console +>> auto eth0:0 +>> iface eth0:0 inet static +>> address ADDITIONAL_IP +>> netmask 255.255.255.255 +>> ``` +>> +>> Alternatively, you can configure your Additional IP by adding the following lines in the configuration file: +>> +>> ```console +>> post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP netmask 255.255.255.255 broadcast ADDITIONAL_IP +>> pre-down /sbin/ifconfig eth0:0 down +>> ``` +>> +>> With the configuration above, the virtual interface is enabled or disabled whenever the `eth0` interface is enabled or disabled. +>> +>> If you have two Additional IPs to configure, the `/etc/network/interfaces.d/50-cloud-init` file should look like this: +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> auto eth0:0 +>> iface eth0:0 inet static +>> address ADDITIONAL_IP1 +>> netmask 255.255.255.255 +>> +>> auto eth0:1 +>> iface eth0:1 inet static +>> address ADDITIONAL_IP2 +>> netmask 255.255.255.255 +>> ``` +>> +>> Or like this: +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> # IP 1 +>> post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP1 netmask 255.255.255.255 broadcast ADDITIONAL_IP1 +>> pre-down /sbin/ifconfig eth0:0 down +>> +>> # IP 2 +>> post-up /sbin/ifconfig eth0:1 ADDITIONAL_IP2 netmask 255.255.255.255 broadcast ADDITIONAL_IP2 +>> pre-down /sbin/ifconfig eth0:1 down +>> ``` +>> +>> /// details | **Configuration example** +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> auto eth0:0 +>> iface eth0:0 inet static +>> address 203.0.113.1 +>> netmask 255.255.255.255 +>> ``` +>> +>> Or: +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> # IP 1 +>> post-up /sbin/ifconfig eth0:0 203.0.113.1 netmask 255.255.255.255 broadcast 203.0.113.1 +>> pre-down /sbin/ifconfig eth0:0 down +>> ``` +>> /// +>> +>> Step 3: Restart the interface +>> +>> To restart the interface, use the following command: +>> +>> ```bash +>> sudo /etc/init.d/networking restart +>> ``` +>> +> Fedora 41+ +>> **Fedora 41 and following** +>> +>> Fedora now uses keyfiles. NetworkManager previously stored network profiles in ifcfg format in this directory: `/etc/sysconfig/network-scripts/`. However, the ifcfg format is now deprecated. By default, NetworkManager no longer creates new profiles in this format. The configuration file is now found in `/etc/NetworkManager/system-connections/`. +>> +>> Step 1: Create a backup +>> +>> > [!primary] +>> > +>> > Note that the name of the network file in our example may differ from your own. Please adjust to your appropriate name. +>> > +>> +>> First, make a copy of the configuration file, so that you can revert at any time. In our example, our configuration file is called `cloud-init-eno1.nmconnection`. +>> +>> ```bash +>> sudo cp -r /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak +>> ``` +>> +>> Step 2: Edit the config file +>> +>> > [!primary] +>> > Please note that the name of the network file in our example may differ from yours. Please adapt the commands to your file name. +>> > +>> +>> To obtain the name of your network interface in order to edit the appropriate network file, you can run one of the following commands: +>> +>> ```bash +>> ip a +>> ``` +>> +>> ```bash +>> nmcli connection show +>> ``` +>> +>> Do not modify the existing lines in the configuration file, add your Additional IP to the file as follows, replacing `ADDITIONAL_IP/32` wih your own values: +>> +>> ```bash +>> sudo nano /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> ``` +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=ADDITIONAL_IP/32 +>> ``` +>> +>> If you have two Additional IPs to configure, the configuration should look like this: +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=ADDITIONAL_IP1/32 +>> address2=ADDITIONAL_IP2/32 +>> ``` +>> +>> /// details | **Configuration example** +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=203.0.113.1/32 +>> ``` +>> /// +>> +>> Step 3: Restart the interface +>> +>> You now need to restart your interface: +>> +>> ```bash +>> sudo systemctl restart NetworkManager +>> ``` +>> +> Debian 12 and Ubuntu 20.04+ +>> **Debian 12, Ubuntu 20.04 and following** +>> +>> By default, the configuration files are located in the `/etc/netplan` directory. +>> +>> The best practice approach is to create a separate configuration file to set up Additional IP addresses. This way, you can easily revert the changes in case of an error. +>> +>> Step 1: Determine the interface +>> +>> ```bash +>> ip a +>> ``` +>> +>> Note the name of the interface (the one on which your server's main IP address is configured). +>> +>> Step 2: Create and edit the configuration file +>> +>> Next, create a configuration file with a `.yaml` extension. In our example, our file is called `51-cloud-init.yaml`. +>> +>> ```bash +>> sudo nano /etc/netplan/51-cloud-init.yaml +>> ``` +>> +>> Edit the file with the content below, replacing `INTERFACE_NAME` and `ADDITIONAL_IP` with your own values: +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> INTERFACE_NAME: +>> dhcp4: true +>> addresses: +>> - ADDITIONAL_IP/32 +>> ``` +>> +>> If you have two Additional IPs to configure, the configuration file should look like this: +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> INTERFACE_NAME: +>> dhcp4: true +>> addresses: +>> - ADDITIONAL_IP1/32 +>> - ADDITIONAL_IP2/32 +>> ``` +>> +>> +>> > [!warning] +>> > It is important to respect the alignment of each element in this file as represented in the example above. Do not use the tab key to create your spacing. Only the space key is needed. +>> > +>> +>> /// details | **Configuration example** +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> eth0: +>> dhcp4: true +>> addresses: +>> - 203.0.113.1/32 +>> ``` +>> /// +>> +>> Save and close the file. You can test the configuration with the following command: +>> +>> ```bash +>> sudo netplan try +>> ``` +>> +>> Step 3: Apply the change +>> +>> If it is correct, apply it using the following command: +>> +>> ```bash +>> sudo netplan apply +>> ``` +>> +>> > [!primary] +>> > When using the `netplan try` command, it is possible that the system returns a warning message such as `Permissions for /etc/netplan/xx-cloud-init.yaml are too open. Netplan configuration should NOT be accessible by others`. This simply means that the file does not have restrictive permissions. This does not affect the configuration of your Additional IP. For more information about file permissions, consult the [official documentation of ubuntu](https://help.ubuntu.com/community/FilePermissions). +>> > +>> +> AlmaLinux / Rocky Linux +>> **AlmaLinux (8 & 9), Rocky Linux (8 & 9)** +>> +>> The main configuration file is located in `/etc/sysconfig/network-scripts/`. In this example it is called `ifcfg-eth0`. Before making changes, verify the actual file name in this folder. +>> +>> For each Additional IP to be configured, we create a seperate configuration file with the following parameters: `ifcfg-NETWORK_INTERFACE:ID`. Where `NETWORK_INTERFACE` is the physical interface and `ID` is the virtual network interface or ethernet alias starting with a value of 0. For example, for our interface named `eth0` the first alias is `eth0:0`, the second alias is `eth0:1`, etc... +>> +>> Step 1: Determine the interface +>> +>> ```bash +>> ip a +>> ``` +>> +>> Note the name of the interface (the one on which your server's main IP address is configured). +>> +>> Step 2: Create the configuration file +>> +>> First, create the configuration file. Replace `NETWORK_INTERFACE:ID` with your own values. +>> +>> ```bash +>> sudo nano /etc/sysconfig/network-scripts/ifcfg-NETWORK_INTERFACE:ID +>> ``` +>> +>> Next, edit the file with the content below, replacing `NETWORK_INTERFACE:ID`, and `ADDITIONAL_IP` with your own values: +>> +>> ```console +>> DEVICE=NETWORK_INTERFACE:ID +>> ONBOOT=yes +>> BOOTPROTO=none # For CentOS use "static" +>> IPADDR=ADDITIONAL_IP +>> NETMASK=255.255.255.255 +>> BROADCAST=ADDITIONAL_IP +>> ``` +>> +>> /// details | **Configuration example** +>> +>> ```console +>> DEVICE=eth0:0 +>> ONBOOT=yes +>> BOOTPROTO=none # For CentOS use "static" +>> IPADDR=203.0.113.1 +>> NETMASK=255.255.255.255 +>> BROADCAST=203.0.113.1 +>> ``` +>> /// +>> +>> Step 3: Restart the interface +>> +>> Next, restart the network interface with the following command: +>> +>> ```bash +>> sudo systemctl restart NetworkManager +>> ``` +>> +> cPanel +>> **cPanel** +>> +>> Step 1: Access the WHM IP management section +>> +>> In the WHM control panel, click on `IP Functions`{.action} and select `Add a New IP Address`{.action} in the left-hand sidebar. +>> +>> ![Add new IP](images/Cpanel-1.png){.thumbnail} +>> +>> Step 2: Add the Additional IP information +>> +>> Enter your Additional IP in the form `xxx.xxx.xxx.xxx` into the field “New IP or IP range to add”. +>> +>> Select `255.255.255.255` as your subnet mask, then click on `Submit`{.action}. +>> +>> ![enter new IP information](images/Cpanel-2024.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Please note that if you have more than one IP to configure on the same block and you add them all at once, the WHM system will force you to use the subnet mask `255.255.255.0`. We do not recommend using this configuration. Instead, you need to add each IP individually in order to use the proper subnet mask `255.255.255.255`. +>> > +>> +>> Step 3: Check the current IP configuration +>> +>> Back in the section `IP Functions`{.action}, click on `Show or Delete Current IP Addresses`{.action} to verify that the Additional IP address was added correctly. +>> +>> ![check configured IP](images/Cpanel-2024-1.png){.thumbnail} +>> +> Windows Servers +>> **Windows Servers** +>> +>> Windows servers are often DHCP-enabled in the network configuration. If you have already set up an Additional IP or switched your configuration to a fixed IP, go directly to the next step. +>> +>> Otherwise, you need to first switch from a network-level DHCP configuration to a fixed IP configuration. +>> +>> Open the command prompt `cmd`{.action} or `powershell`{.action}, then type the following command: +>> +>> ```powershell +>> ipconfig +>> ``` +>> +>> This will return a result similar to the following example: +>> +>> ![Result of "ipconfig" command](images/ipconfig.png){.thumbnail} +>> +>> Identify and write down your IPv4, subnet mask, default gateway and the name of the network interface controller (network adapter). +>> +>> In our example, the server IP is **192.0.2.28**. +>> +>> You can perform the next steps via either a command-line interface or the graphical user interface. +>> +>> **Via a command-line interface (recommended)** +>> +>> In the commands below, you need to replace: +>> +>> |Command|Value| +>> |---|---| +>> |NETWORK_ADAPTER| Name of the network adapter (in our example: Ethernet 2)| +>> |IP_ADDRESS| Server IP address (in our example: 192.0.2.28)| +>> |SUBNET_MASK| Subnet mask (in our example: 255.255.255.0)| +>> |GATEWAY| Default gateway (in our example: 192.0.2.254)| +>> |ADDITIONAL_IP| Address of Additional IP you want to add (in our example 203.0.113.1)| +>> +>> > [!warning] +>> > +>> > Be careful – the server will no longer be accessible if you enter incorrect information. You will then have to make the corrections in [Winrescue mode](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) or via the [IPMI](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). +>> > +>> +>> In the command prompt: +>> +>> 1\. Switch to a fixed IP +>> +>> ```powershell +>> netsh interface ipv4 set address name="NETWORK_ADAPTER" static IP_ADDRESS SUBNET_MASK GATEWAY +>> ``` +>> +>> 2\. Set the DNS server +>> +>> ```powershell +>> netsh interface ipv4 set dns name="NETWORK_ADAPTER" static 213.186.33.99 +>> ``` +>> +>> 3\. Add an Additional IP +>> +>> ```powershell +>> netsh interface ipv4 add address "NETWORK_ADAPTER" ADDITIONAL_IP 255.255.255.255 +>> ``` +>> +>> Your Additional IP is now functional. +>> +>> /// details | **Via the graphical user interface** +>> +>> 1. Go to `Start`{.action}> `Control Panel`{.action}>` Network and Internet`{.action}> `Network and Sharing Centre`{.action}> `Change Adapter Settings `{.action}(in the left-hand menu). +>> 2. Right-click on your network connection, in our example `Ethernet 2`{.action}. +>> 3. Click on `Properties`{.action}. +>> 4. Select `Internet Protocol Version 4 (TCP/IPv4)`{.action}, then click on `Properties`{.action}. +>> 5. Click on `Use the following IP address`{.action} and type in your server’s primary IP, subnet mask and default gateway information obtained by using the `ipconfig`{.action} command above. In the "Preferred DNS Server" box, type 213.186.33.99. +>> +>> ![Internet Protocol Version 4 (TCP/IPv4) Properties](images/configure-main-ip.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Be careful – the server will no longer be accessible if you enter incorrect information. You will then have to make the corrections in [Winrescue mode](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) or via the [IPMI](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). +>> > +>> +>> Then click on `Advanced`{.action} (still in the `TCP/IP Settings`{.action}). +>> +>> ![Internet Protocol Version 4 (TCP/IPv4) Properties](images/configure-main-ip-1.png){.thumbnail} +>> +>> In the `IP Address`{.action} section, click `Add`{.action}: +>> +>> ![Advanced TCP/IPv4 Settings](images/add-additional-ip.png){.thumbnail} +>> +>> Type in your Additional IP and the subnet mask **255.255.255.255**. Then click on `Add`{.action} +>> +>> ![TCP/IP Address](images/configure-additional-ip.png){.thumbnail} +>> +>> +>> Click on `OK`{.action} to apply your configuration. +>> +>> +>> Your Additional IP is now functional, you can verify the configuration with the following command: +>> +>> ```powershell +>> ipconfig +>> ``` +>> +>> This will return a result similar to the following example: +>> +>> ![Final configuration](images/final-ip-configuration.png){.thumbnail} +>> +>> /// +>> +> Plesk +>> **Plesk** +>> +>> Step 1: Access the Plesk IP management section +>> +>> In the Plesk control panel, choose `Tools & Settings`{.action} from the left-hand sidebar. +>> +>> ![acces to the ip addresses management](images/pleskip1.png){.thumbnail} +>> +>> Click on `IP Addresses`{.action} under **Tools & Resources**. +>> +>> Step 2: Add the Additional IP information +>> +>> In this section, click on the button `Add IP Address`{.action}. +>> +>> ![add ip information](images/Plesk-2024.png){.thumbnail} +>> +>> Enter your Additional IP in the form `xxx.xxx.xxx.xxx/32` into the field "IP address and subnet mask", then click on `OK`{.action}. +>> +>> ![add ip information](images/Plesk-2024-1.png){.thumbnail} +>> +>> Step 3: Check the current IP configuration +>> +>> Back in the section "IP Addresses", verify that the Additional IP address was added correctly. +>> +>> ![current IP configuration](images/Plesk-2024-2.png){.thumbnail} +>> ### Troubleshooting diff --git a/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.en-us.md b/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.en-us.md index 877837b43a8..4e9c7201a42 100644 --- a/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.en-us.md +++ b/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.en-us.md @@ -1,9 +1,23 @@ --- title: 'Configuring IP aliasing' excerpt: 'Find out how to add Additional IP addresses to your server configuration' -updated: 2025-07-22 +updated: 2025-11-12 --- + + > [!primary] > This article is about Additional IPv4 configuration on a public interface. You can also configure Primary IPv6 addresses on your dedicated servers using [this guide](/pages/bare_metal_cloud/dedicated_servers/network_ipv6). > @@ -32,7 +46,7 @@ IP aliasing is a special network configuration for your OVHcloud dedicated serve - Basic networking and administration knowledge > [!warning] -> This feature might be unavailable or limited on servers of the [**Eco** product line](/links/bare-metal/eco-about) +> This feature might be unavailable or limited on servers of the [**Eco** product line](/links/bare-metal/eco-about). > > Please visit our [comparison page](/links/bare-metal/eco-compare) for more information. @@ -41,8 +55,7 @@ IP aliasing is a special network configuration for your OVHcloud dedicated serve The following sections contain configurations for the distributions we currently offer and the most commonly used distributions/operating systems. The first step is always to log in to your server via SSH or a GUI login session (RDP for a Windows server). > [!primary] -> -Concerning different distribution releases, please note that the proper procedure to configure your network interface as well as the file names may have been subject to change. We recommend to consult the manuals and knowledge resources of the respective OS versions if you experience any issues. +> Concerning different distribution releases, please note that the proper procedure to configure your network interface as well as the file names may have been subject to change. We recommend to consult the manuals and knowledge resources of the respective OS versions if you experience any issues. > **Please take note of the following terminology that will be used in code examples and instructions of the guide sections below:** @@ -55,479 +68,500 @@ Concerning different distribution releases, please note that the proper procedur In the examples below, we will use the `nano` text editor. With some operating systems, you will need to install it first before using it. If this is the case, you will be prompted to do so. You can, of course, use the text editor of your choice. -### Debian 11 - -By default, the configuration files are located in `/etc/network/interfaces.d/`. We recommend that you start by backing up the relevant configuration file. - -#### Step 1: Create a backup - -In our example, our file is called `50-cloud-init`, so we make a copy of the `50-cloud-init` file using the following command: - -```bash -sudo cp /etc/network/interfaces.d/50-cloud-init /etc/network/interfaces.d/50-cloud-init.bak -``` - -In case of a mistake, you will be able to revert the changes, using the commands below: - -```bash -sudo rm -f /etc/network/interfaces.d/50-cloud-init -sudo cp /etc/network/interfaces.d/50-cloud-init.bak /etc/network/interfaces.d/50-cloud-init -``` - -#### Step 2: Edit the configuration file - -> [!primary] -> -Note that the names of the network interfaces in our examples may differ from your own. Please adjust to your appropriate interface names. -> - -You can now modify the configuration file: - -```bash -sudo nano /etc/network/interfaces.d/50-cloud-init -``` - -Next, you need to add a virtual interface or ethernet alias. In our example, our interface is called `eth0`, so our alias is `eth0:0`. Do this for each additional IP you wish to configure. - -Do not modify the existing lines in the configuration file, simply add your Additional IP to the file as follows, replacing `ADDITIONAL_IP/32` as well as the virtual interface (if your server is not using **eth0:0**) wih your own values: - -```console -auto eth0:0 -iface eth0:0 inet static -address ADDITIONAL_IP -netmask 255.255.255.255 -``` - -Alternatively, you can configure your Additional IP by adding the following lines in the configuration file: - -```console -post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP netmask 255.255.255.255 broadcast ADDITIONAL_IP -pre-down /sbin/ifconfig eth0:0 down -``` - -With the configuration above, the virtual interface is enabled or disabled whenever the `eth0` interface is enabled or disabled. - -If you have two Additional IPs to configure, the `/etc/network/interfaces.d/50-cloud-init` file should look like this: - -```console -auto eth0 -iface eth0 inet dhcp - -auto eth0:0 -iface eth0:0 inet static -address ADDITIONAL_IP1 -netmask 255.255.255.255 - -auto eth0:1 -iface eth0:1 inet static -address ADDITIONAL_IP2 -netmask 255.255.255.255 -``` - -Or like this: - -```console -auto eth0 -iface eth0 inet dhcp - -# IP 1 -post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP1 netmask 255.255.255.255 broadcast ADDITIONAL_IP1 -pre-down /sbin/ifconfig eth0:0 down - -# IP 2 -post-up /sbin/ifconfig eth0:1 ADDITIONAL_IP2 netmask 255.255.255.255 broadcast ADDITIONAL_IP2 -pre-down /sbin/ifconfig eth0:1 down -``` - -Configuration example: - -```console -auto eth0 -iface eth0 inet dhcp - -auto eth0:0 -iface eth0:0 inet static -address 203.0.113.1 -netmask 255.255.255.255 -``` - -Or : - -```console -auto eth0 -iface eth0 inet dhcp - -# IP 1 -post-up /sbin/ifconfig eth0:0 203.0.113.1 netmask 255.255.255.255 broadcast 203.0.113.1 -pre-down /sbin/ifconfig eth0:0 down -``` - -#### Step 3: Restart the interface - -To restart the interface, use the following command: - -```bash -sudo /etc/init.d/networking restart -``` - -### Fedora 39 and following - -Fedora now uses keyfiles. NetworkManager previously stored network profiles in ifcfg format in this directory: `/etc/sysconfig/network-scripts/`. However, the ifcfg format is now deprecated. By default, NetworkManager no longer creates new profiles in this format. The configuration file is now found in `/etc/NetworkManager/system-connections/`. - -#### Step 1: Create a backup - -> [!primary] -> -> Note that the name of the network file in our example may differ from your own. Please adjust to your appropriate name. -> - -First, make a copy of the configuration file, so that you can revert at any time. In our example, our configuration file is called `cloud-init-eno1.nmconnection`. - -```bash -sudo cp -r /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak -``` - -#### Step 2: Edit the config file - -> [!primary] -> Please note that the name of the network file in our example may differ from yours. Please adapt the commands to your file name. -> - -To obtain the name of your network interface in order to edit the appropriate network file, you can run one of the following commands: - -```bash -ip a -``` - -```bash -nmcli connection show -``` - -Do not modify the existing lines in the configuration file, add your Additional IP to the file as follows, replacing `ADDITIONAL_IP/32` wih your own values: - -```bash -sudo nano /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -``` - -```console -[ipv4] -method=auto -may-fail=false -address1=ADDITIONAL_IP/32 -``` - -If you have two Additional IPs to configure, the configuration should look like this: - -```console -[ipv4] -method=auto -may-fail=false -address1=ADDITIONAL_IP1/32 -address2=ADDITIONAL_IP2/32 -``` - -Configuration example: - -```console -[ipv4] -method=auto -may-fail=false -address1=203.0.113.1/32 -``` - -#### Step 3: Restart the interface - -You now need to restart your interface: - -```bash -sudo systemctl restart NetworkManager -``` - -### Debian 12, Ubuntu 20.04 and following - -By default, the configuration files are located in the `/etc/netplan` directory. - -The best practice approach is to create a separate configuration file to set up Additional IP addresses. This way, you can easily revert the changes in case of an error. - -#### Step 1: Determine the interface - -```bash -ip a -``` - -Note the name of the interface (the one on which your server's main IP address is configured). - -#### Step 2: Create and edit the configuration file - -Next, create a configuration file with a `.yaml` extension. In our example, our file is called `51-cloud-init.yaml`. - -```bash -sudo nano /etc/netplan/51-cloud-init.yaml -``` - -Edit the file with the content below, replacing `INTERFACE_NAME` and `ADDITIONAL_IP` with your own values: - -```yaml -network: - version: 2 - ethernets: - INTERFACE_NAME: - dhcp4: true - addresses: - - ADDITIONAL_IP/32 -``` - -If you have two Additional IPs to configure, the configuration file should look like this: - -```yaml -network: - version: 2 - ethernets: - INTERFACE_NAME: - dhcp4: true - addresses: - - ADDITIONAL_IP1/32 - - ADDITIONAL_IP2/32 -``` - -> [!warning] -> It is important to respect the alignment of each element in this file as represented in the example above. Do not use the tab key to create your spacing. Only the space key is needed. -> - -Configuration example: - -```yaml -network: - version: 2 - ethernets: - eth0: - dhcp4: true - addresses: - - 203.0.113.1/32 -``` - -Save and close the file. You can test the configuration with the following command: - -```bash -sudo netplan try -``` - -#### Step 3: Apply the change - -If it is correct, apply it using the following command: - -```bash -sudo netplan apply -``` - -> [!primary] -> When using the `netplan try` command, it is possible that the system returns a warning message such as `Permissions for /etc/netplan/xx-cloud-init.yaml are too open. Netplan configuration should NOT be accessible by others`. This simply means that the file does not have restrictive permissions. This does not affect the configuration of your Additional IP. For more information about file permissions, consult the [official documentation of ubuntu](https://help.ubuntu.com/community/FilePermissions). +> [!success] +> Select the tab corresponding to your operating system. > -### AlmaLinux (8 & 9), Rocky Linux (8 & 9) - -The main configuration file is located in `/etc/sysconfig/network-scripts/`. In this example it is called `ifcfg-eth0`. Before making changes, verify the actual file name in this folder. - -For each Additional IP to be configured, we create a seperate configuration file with the following parameters: `ifcfg-NETWORK_INTERFACE:ID`. Where `NETWORK_INTERFACE` is the physical interface and `ID` is the virtual network interface or ethernet alias starting with a value of 0. For example, for our interface named `eth0` the first alias is `eth0:0`, the second alias is `eth0:1`, etc... - -#### Step 1: Determine the interface - -```bash -ip a -``` - -Note the name of the interface (the one on which your server's main IP address is configured). - -#### Step 2: Create the configuration file - -First, create the configuration file. Replace `NETWORK_INTERFACE:ID` with your own values. - -```bash -sudo nano /etc/sysconfig/network-scripts/ifcfg-NETWORK_INTERFACE:ID -``` - -Next, edit the file with the content below, replacing `NETWORK_INTERFACE:ID`, and `ADDITIONAL_IP` with your own values: - -```console -DEVICE=NETWORK_INTERFACE:ID -ONBOOT=yes -BOOTPROTO=none # For CentOS use "static" -IPADDR=ADDITIONAL_IP -NETMASK=255.255.255.255 -BROADCAST=ADDITIONAL_IP -``` - -Configuration example: - -```console -DEVICE=eth0:0 -ONBOOT=yes -BOOTPROTO=none # For CentOS use "static" -IPADDR=203.0.113.1 -NETMASK=255.255.255.255 -BROADCAST=203.0.113.1 -``` - -#### Step 3: Restart the interface - -Next, restart the network interface with the following command: - -```bash -sudo systemctl restart NetworkManager -``` - -### cPanel - -#### Step 1: Access the WHM IP management section - -In the WHM control panel, click on `IP Functions`{.action} and select `Add a New IP Address`{.action} in the left-hand sidebar. - -![Add new IP](images/Cpanel-1.png){.thumbnail} - -#### Step 2: Add the Additional IP information - -Enter your Additional IP in the form `xxx.xxx.xxx.xxx` into the field “New IP or IP range to add”. - -Select `255.255.255.255` as your subnet mask, then click on `Submit`{.action}. - -![enter new IP information](images/Cpanel-2024.png){.thumbnail} - -> [!warning] -> -> Please note that if you have more than one IP to configure on the same block and you add them all at once, the WHM system will force you to use the subnet mask `255.255.255.0`. We do not recommend using this configuration. Instead, you need to add each IP individually in order to use the proper subnet mask `255.255.255.255`. -> - -#### Step 3: Check the current IP configuration - -Back in the section `IP Functions`{.action}, click on `Show or Delete Current IP Addresses`{.action} to verify that the Additional IP address was added correctly. - -![check configured IP](images/Cpanel-2024-1.png){.thumbnail} - -### Windows Servers - -Windows servers are often DHCP-enabled in the network configuration. If you have already set up an Additional IP or switched your configuration to a fixed IP, go directly to the next step. - -Otherwise, you need to first switch from a network-level DHCP configuration to a fixed IP configuration. - -Open the command prompt `cmd`{.action} or `powershell`{.action}, then type the following command: - -```powershell -ipconfig -``` - -This will return a result similar to the following example: - -![Result of "ipconfig" command](images/ipconfig.png){.thumbnail} - -Identify and write down your IPv4, subnet mask, default gateway and the name of the network interface controller (network adapter). - -In our example, the server IP is **192.0.2.28**. - -You can perform the next steps via either a command-line interface or the graphical user interface. - -#### Via a command-line interface (recommended) - -In the commands below, you need to replace: - -|Command|Value| -|---|---| -|NETWORK_ADAPTER| Name of the network adapter (in our example: Ethernet 2)| -|IP_ADDRESS| Server IP address (in our example: 192.0.2.28)| -|SUBNET_MASK| Subnet mask (in our example: 255.255.255.0)| -|GATEWAY| Default gateway (in our example: 192.0.2.254)| -|ADDITIONAL_IP| Address of Additional IP you want to add (in our example 203.0.113.1)| - -> [!warning] -> -> Be careful – the server will no longer be accessible if you enter incorrect information. You will then have to make the corrections in [Winrescue mode](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) or via the [IPMI](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). -> - -In the command prompt: - -1\. Switch to a fixed IP - -```powershell -netsh interface ipv4 set address name="NETWORK_ADAPTER" static IP_ADDRESS SUBNET_MASK GATEWAY -``` - -2\. Set the DNS server - -```powershell -netsh interface ipv4 set dns name="NETWORK_ADAPTER" static 213.186.33.99 -``` - -3\. Add an Additional IP - -```powershell -netsh interface ipv4 add address "NETWORK_ADAPTER" ADDITIONAL_IP 255.255.255.255 -``` - -Your Additional IP is now functional. - -#### Via the graphical user interface - -1. Go to `Start`{.action}> `Control Panel`{.action}>` Network and Internet`{.action}> `Network and Sharing Centre`{.action}> `Change Adapter Settings `{.action}(in the left-hand menu). -2. Right-click on your network connection, in our example `Ethernet 2`{.action}. -3. Click on `Properties`{.action}. -4. Select `Internet Protocol Version 4 (TCP/IPv4)`{.action}, then click on `Properties`{.action}. -5. Click on `Use the following IP address`{.action} and type in your server’s primary IP, subnet mask and default gateway information obtained by using the `ipconfig`{.action} command above. In the "Preferred DNS Server" box, type 213.186.33.99. - -![Internet Protocol Version 4 (TCP/IPv4) Properties](images/configure-main-ip.png){.thumbnail} - -> [!warning] -> -> Be careful – the server will no longer be accessible if you enter incorrect information. You will then have to make the corrections in [Winrescue mode](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) or via the [IPMI](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). -> - -Then click on `Advanced`{.action} (still in the `TCP/IP Settings`{.action}). - -![Internet Protocol Version 4 (TCP/IPv4) Properties](images/configure-main-ip-1.png){.thumbnail} - -In the `IP Address`{.action} section, click `Add`{.action}: - -![Advanced TCP/IPv4 Settings](images/add-additional-ip.png){.thumbnail} - -Type in your Additional IP and the subnet mask **255.255.255.255**. Then click on `Add`{.action} - -![TCP/IP Address](images/configure-additional-ip.png){.thumbnail} - -Click on `OK`{.action} to apply your configuration. - -Your Additional IP is now functional, you can verify the configuration with the following command: - -```powershell -ipconfig -``` - -This will return a result similar to the following example: - -![Final configuration](images/final-ip-configuration.png){.thumbnail} - -### Plesk - -#### Step 1: Access the Plesk IP management section - -In the Plesk control panel, choose `Tools & Settings`{.action} from the left-hand sidebar. - -![acces to the ip addresses management](images/pleskip1.png){.thumbnail} - -Click on `IP Addresses`{.action} under **Tools & Resources**. - -#### Step 2: Add the Additional IP information - -In this section, click on the button `Add IP Address`{.action}. - -![add ip information](images/Plesk-2024.png){.thumbnail} - -Enter your Additional IP in the form `xxx.xxx.xxx.xxx/32` into the field "IP address and subnet mask", then click on `OK`{.action}. - -![add ip information](images/Plesk-2024-1.png){.thumbnail} - -#### Step 3: Check the current IP configuration - -Back in the section "IP Addresses", verify that the Additional IP address was added correctly. - -![current IP configuration](images/Plesk-2024-2.png){.thumbnail} +> [!tabs] +> Debian 11 +>> **Debian 11** +>> +>> By default, the configuration files are located in `/etc/network/interfaces.d/`. We recommend that you start by backing up the relevant configuration file. +>> +>> Step 1: Create a backup +>> +>> In our example, our file is called `50-cloud-init`, so we make a copy of the `50-cloud-init` file using the following command: +>> +>> ```bash +>> sudo cp /etc/network/interfaces.d/50-cloud-init /etc/network/interfaces.d/50-cloud-init.bak +>> ``` +>> +>> In case of a mistake, you will be able to revert the changes, using the commands below: +>> +>> ```bash +>> sudo rm -f /etc/network/interfaces.d/50-cloud-init +>> sudo cp /etc/network/interfaces.d/50-cloud-init.bak /etc/network/interfaces.d/50-cloud-init +>> ``` +>> +>> Step 2: Edit the configuration file +>> +>> > [!primary] +>> > Note that the names of the network interfaces in our examples may differ from your own. Please adjust to your appropriate interface names. +>> > +>> +>> You can now modify the configuration file: +>> +>> ```bash +>> sudo nano /etc/network/interfaces.d/50-cloud-init +>> ``` +>> +>> Next, you need to add a virtual interface or ethernet alias. In our example, our interface is called `eth0`, so our alias is `eth0:0`. Do this for each additional IP you wish to configure. +>> +>> Do not modify the existing lines in the configuration file, simply add your Additional IP to the file as follows, replacing `ADDITIONAL_IP/32` as well as the virtual interface (if your server is not using **eth0:0**) wih your own values: +>> +>> ```console +>> auto eth0:0 +>> iface eth0:0 inet static +>> address ADDITIONAL_IP +>> netmask 255.255.255.255 +>> ``` +>> +>> Alternatively, you can configure your Additional IP by adding the following lines in the configuration file: +>> +>> ```console +>> post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP netmask 255.255.255.255 broadcast ADDITIONAL_IP +>> pre-down /sbin/ifconfig eth0:0 down +>> ``` +>> +>> With the configuration above, the virtual interface is enabled or disabled whenever the `eth0` interface is enabled or disabled. +>> +>> If you have two Additional IPs to configure, the `/etc/network/interfaces.d/50-cloud-init` file should look like this: +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> auto eth0:0 +>> iface eth0:0 inet static +>> address ADDITIONAL_IP1 +>> netmask 255.255.255.255 +>> +>> auto eth0:1 +>> iface eth0:1 inet static +>> address ADDITIONAL_IP2 +>> netmask 255.255.255.255 +>> ``` +>> +>> Or like this: +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> # IP 1 +>> post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP1 netmask 255.255.255.255 broadcast ADDITIONAL_IP1 +>> pre-down /sbin/ifconfig eth0:0 down +>> +>> # IP 2 +>> post-up /sbin/ifconfig eth0:1 ADDITIONAL_IP2 netmask 255.255.255.255 broadcast ADDITIONAL_IP2 +>> pre-down /sbin/ifconfig eth0:1 down +>> ``` +>> +>> /// details | **Configuration example** +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> auto eth0:0 +>> iface eth0:0 inet static +>> address 203.0.113.1 +>> netmask 255.255.255.255 +>> ``` +>> +>> Or: +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> # IP 1 +>> post-up /sbin/ifconfig eth0:0 203.0.113.1 netmask 255.255.255.255 broadcast 203.0.113.1 +>> pre-down /sbin/ifconfig eth0:0 down +>> ``` +>> /// +>> +>> Step 3: Restart the interface +>> +>> To restart the interface, use the following command: +>> +>> ```bash +>> sudo /etc/init.d/networking restart +>> ``` +>> +> Fedora 41+ +>> **Fedora 41 and following** +>> +>> Fedora now uses keyfiles. NetworkManager previously stored network profiles in ifcfg format in this directory: `/etc/sysconfig/network-scripts/`. However, the ifcfg format is now deprecated. By default, NetworkManager no longer creates new profiles in this format. The configuration file is now found in `/etc/NetworkManager/system-connections/`. +>> +>> Step 1: Create a backup +>> +>> > [!primary] +>> > +>> > Note that the name of the network file in our example may differ from your own. Please adjust to your appropriate name. +>> > +>> +>> First, make a copy of the configuration file, so that you can revert at any time. In our example, our configuration file is called `cloud-init-eno1.nmconnection`. +>> +>> ```bash +>> sudo cp -r /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak +>> ``` +>> +>> Step 2: Edit the config file +>> +>> > [!primary] +>> > Please note that the name of the network file in our example may differ from yours. Please adapt the commands to your file name. +>> > +>> +>> To obtain the name of your network interface in order to edit the appropriate network file, you can run one of the following commands: +>> +>> ```bash +>> ip a +>> ``` +>> +>> ```bash +>> nmcli connection show +>> ``` +>> +>> Do not modify the existing lines in the configuration file, add your Additional IP to the file as follows, replacing `ADDITIONAL_IP/32` wih your own values: +>> +>> ```bash +>> sudo nano /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> ``` +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=ADDITIONAL_IP/32 +>> ``` +>> +>> If you have two Additional IPs to configure, the configuration should look like this: +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=ADDITIONAL_IP1/32 +>> address2=ADDITIONAL_IP2/32 +>> ``` +>> +>> /// details | **Configuration example** +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=203.0.113.1/32 +>> ``` +>> /// +>> +>> Step 3: Restart the interface +>> +>> You now need to restart your interface: +>> +>> ```bash +>> sudo systemctl restart NetworkManager +>> ``` +>> +> Debian 12 and Ubuntu 20.04+ +>> **Debian 12, Ubuntu 20.04 and following** +>> +>> By default, the configuration files are located in the `/etc/netplan` directory. +>> +>> The best practice approach is to create a separate configuration file to set up Additional IP addresses. This way, you can easily revert the changes in case of an error. +>> +>> Step 1: Determine the interface +>> +>> ```bash +>> ip a +>> ``` +>> +>> Note the name of the interface (the one on which your server's main IP address is configured). +>> +>> Step 2: Create and edit the configuration file +>> +>> Next, create a configuration file with a `.yaml` extension. In our example, our file is called `51-cloud-init.yaml`. +>> +>> ```bash +>> sudo nano /etc/netplan/51-cloud-init.yaml +>> ``` +>> +>> Edit the file with the content below, replacing `INTERFACE_NAME` and `ADDITIONAL_IP` with your own values: +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> INTERFACE_NAME: +>> dhcp4: true +>> addresses: +>> - ADDITIONAL_IP/32 +>> ``` +>> +>> If you have two Additional IPs to configure, the configuration file should look like this: +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> INTERFACE_NAME: +>> dhcp4: true +>> addresses: +>> - ADDITIONAL_IP1/32 +>> - ADDITIONAL_IP2/32 +>> ``` +>> +>> +>> > [!warning] +>> > It is important to respect the alignment of each element in this file as represented in the example above. Do not use the tab key to create your spacing. Only the space key is needed. +>> > +>> +>> /// details | **Configuration example** +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> eth0: +>> dhcp4: true +>> addresses: +>> - 203.0.113.1/32 +>> ``` +>> /// +>> +>> Save and close the file. You can test the configuration with the following command: +>> +>> ```bash +>> sudo netplan try +>> ``` +>> +>> Step 3: Apply the change +>> +>> If it is correct, apply it using the following command: +>> +>> ```bash +>> sudo netplan apply +>> ``` +>> +>> > [!primary] +>> > When using the `netplan try` command, it is possible that the system returns a warning message such as `Permissions for /etc/netplan/xx-cloud-init.yaml are too open. Netplan configuration should NOT be accessible by others`. This simply means that the file does not have restrictive permissions. This does not affect the configuration of your Additional IP. For more information about file permissions, consult the [official documentation of ubuntu](https://help.ubuntu.com/community/FilePermissions). +>> > +>> +> AlmaLinux / Rocky Linux +>> **AlmaLinux (8 & 9), Rocky Linux (8 & 9)** +>> +>> The main configuration file is located in `/etc/sysconfig/network-scripts/`. In this example it is called `ifcfg-eth0`. Before making changes, verify the actual file name in this folder. +>> +>> For each Additional IP to be configured, we create a seperate configuration file with the following parameters: `ifcfg-NETWORK_INTERFACE:ID`. Where `NETWORK_INTERFACE` is the physical interface and `ID` is the virtual network interface or ethernet alias starting with a value of 0. For example, for our interface named `eth0` the first alias is `eth0:0`, the second alias is `eth0:1`, etc... +>> +>> Step 1: Determine the interface +>> +>> ```bash +>> ip a +>> ``` +>> +>> Note the name of the interface (the one on which your server's main IP address is configured). +>> +>> Step 2: Create the configuration file +>> +>> First, create the configuration file. Replace `NETWORK_INTERFACE:ID` with your own values. +>> +>> ```bash +>> sudo nano /etc/sysconfig/network-scripts/ifcfg-NETWORK_INTERFACE:ID +>> ``` +>> +>> Next, edit the file with the content below, replacing `NETWORK_INTERFACE:ID`, and `ADDITIONAL_IP` with your own values: +>> +>> ```console +>> DEVICE=NETWORK_INTERFACE:ID +>> ONBOOT=yes +>> BOOTPROTO=none # For CentOS use "static" +>> IPADDR=ADDITIONAL_IP +>> NETMASK=255.255.255.255 +>> BROADCAST=ADDITIONAL_IP +>> ``` +>> +>> /// details | **Configuration example** +>> +>> ```console +>> DEVICE=eth0:0 +>> ONBOOT=yes +>> BOOTPROTO=none # For CentOS use "static" +>> IPADDR=203.0.113.1 +>> NETMASK=255.255.255.255 +>> BROADCAST=203.0.113.1 +>> ``` +>> /// +>> +>> Step 3: Restart the interface +>> +>> Next, restart the network interface with the following command: +>> +>> ```bash +>> sudo systemctl restart NetworkManager +>> ``` +>> +> cPanel +>> **cPanel** +>> +>> Step 1: Access the WHM IP management section +>> +>> In the WHM control panel, click on `IP Functions`{.action} and select `Add a New IP Address`{.action} in the left-hand sidebar. +>> +>> ![Add new IP](images/Cpanel-1.png){.thumbnail} +>> +>> Step 2: Add the Additional IP information +>> +>> Enter your Additional IP in the form `xxx.xxx.xxx.xxx` into the field “New IP or IP range to add”. +>> +>> Select `255.255.255.255` as your subnet mask, then click on `Submit`{.action}. +>> +>> ![enter new IP information](images/Cpanel-2024.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Please note that if you have more than one IP to configure on the same block and you add them all at once, the WHM system will force you to use the subnet mask `255.255.255.0`. We do not recommend using this configuration. Instead, you need to add each IP individually in order to use the proper subnet mask `255.255.255.255`. +>> > +>> +>> Step 3: Check the current IP configuration +>> +>> Back in the section `IP Functions`{.action}, click on `Show or Delete Current IP Addresses`{.action} to verify that the Additional IP address was added correctly. +>> +>> ![check configured IP](images/Cpanel-2024-1.png){.thumbnail} +>> +> Windows Servers +>> **Windows Servers** +>> +>> Windows servers are often DHCP-enabled in the network configuration. If you have already set up an Additional IP or switched your configuration to a fixed IP, go directly to the next step. +>> +>> Otherwise, you need to first switch from a network-level DHCP configuration to a fixed IP configuration. +>> +>> Open the command prompt `cmd`{.action} or `powershell`{.action}, then type the following command: +>> +>> ```powershell +>> ipconfig +>> ``` +>> +>> This will return a result similar to the following example: +>> +>> ![Result of "ipconfig" command](images/ipconfig.png){.thumbnail} +>> +>> Identify and write down your IPv4, subnet mask, default gateway and the name of the network interface controller (network adapter). +>> +>> In our example, the server IP is **192.0.2.28**. +>> +>> You can perform the next steps via either a command-line interface or the graphical user interface. +>> +>> **Via a command-line interface (recommended)** +>> +>> In the commands below, you need to replace: +>> +>> |Command|Value| +>> |---|---| +>> |NETWORK_ADAPTER| Name of the network adapter (in our example: Ethernet 2)| +>> |IP_ADDRESS| Server IP address (in our example: 192.0.2.28)| +>> |SUBNET_MASK| Subnet mask (in our example: 255.255.255.0)| +>> |GATEWAY| Default gateway (in our example: 192.0.2.254)| +>> |ADDITIONAL_IP| Address of Additional IP you want to add (in our example 203.0.113.1)| +>> +>> > [!warning] +>> > +>> > Be careful – the server will no longer be accessible if you enter incorrect information. You will then have to make the corrections in [Winrescue mode](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) or via the [IPMI](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). +>> > +>> +>> In the command prompt: +>> +>> 1\. Switch to a fixed IP +>> +>> ```powershell +>> netsh interface ipv4 set address name="NETWORK_ADAPTER" static IP_ADDRESS SUBNET_MASK GATEWAY +>> ``` +>> +>> 2\. Set the DNS server +>> +>> ```powershell +>> netsh interface ipv4 set dns name="NETWORK_ADAPTER" static 213.186.33.99 +>> ``` +>> +>> 3\. Add an Additional IP +>> +>> ```powershell +>> netsh interface ipv4 add address "NETWORK_ADAPTER" ADDITIONAL_IP 255.255.255.255 +>> ``` +>> +>> Your Additional IP is now functional. +>> +>> /// details | **Via the graphical user interface** +>> +>> 1. Go to `Start`{.action}> `Control Panel`{.action}>` Network and Internet`{.action}> `Network and Sharing Centre`{.action}> `Change Adapter Settings `{.action}(in the left-hand menu). +>> 2. Right-click on your network connection, in our example `Ethernet 2`{.action}. +>> 3. Click on `Properties`{.action}. +>> 4. Select `Internet Protocol Version 4 (TCP/IPv4)`{.action}, then click on `Properties`{.action}. +>> 5. Click on `Use the following IP address`{.action} and type in your server’s primary IP, subnet mask and default gateway information obtained by using the `ipconfig`{.action} command above. In the "Preferred DNS Server" box, type 213.186.33.99. +>> +>> ![Internet Protocol Version 4 (TCP/IPv4) Properties](images/configure-main-ip.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Be careful – the server will no longer be accessible if you enter incorrect information. You will then have to make the corrections in [Winrescue mode](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) or via the [IPMI](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). +>> > +>> +>> Then click on `Advanced`{.action} (still in the `TCP/IP Settings`{.action}). +>> +>> ![Internet Protocol Version 4 (TCP/IPv4) Properties](images/configure-main-ip-1.png){.thumbnail} +>> +>> In the `IP Address`{.action} section, click `Add`{.action}: +>> +>> ![Advanced TCP/IPv4 Settings](images/add-additional-ip.png){.thumbnail} +>> +>> Type in your Additional IP and the subnet mask **255.255.255.255**. Then click on `Add`{.action} +>> +>> ![TCP/IP Address](images/configure-additional-ip.png){.thumbnail} +>> +>> +>> Click on `OK`{.action} to apply your configuration. +>> +>> +>> Your Additional IP is now functional, you can verify the configuration with the following command: +>> +>> ```powershell +>> ipconfig +>> ``` +>> +>> This will return a result similar to the following example: +>> +>> ![Final configuration](images/final-ip-configuration.png){.thumbnail} +>> +>> /// +>> +> Plesk +>> **Plesk** +>> +>> Step 1: Access the Plesk IP management section +>> +>> In the Plesk control panel, choose `Tools & Settings`{.action} from the left-hand sidebar. +>> +>> ![acces to the ip addresses management](images/pleskip1.png){.thumbnail} +>> +>> Click on `IP Addresses`{.action} under **Tools & Resources**. +>> +>> Step 2: Add the Additional IP information +>> +>> In this section, click on the button `Add IP Address`{.action}. +>> +>> ![add ip information](images/Plesk-2024.png){.thumbnail} +>> +>> Enter your Additional IP in the form `xxx.xxx.xxx.xxx/32` into the field "IP address and subnet mask", then click on `OK`{.action}. +>> +>> ![add ip information](images/Plesk-2024-1.png){.thumbnail} +>> +>> Step 3: Check the current IP configuration +>> +>> Back in the section "IP Addresses", verify that the Additional IP address was added correctly. +>> +>> ![current IP configuration](images/Plesk-2024-2.png){.thumbnail} +>> ### Troubleshooting diff --git a/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.es-es.md b/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.es-es.md index 2de3c75b0f2..ee224f2aea2 100644 --- a/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.es-es.md +++ b/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.es-es.md @@ -1,9 +1,23 @@ --- title: 'Configurar una IP como alias' excerpt: 'Descubra cómo añadir direcciones Additional IP a la configuración de un servidor' -updated: 2025-07-22 +updated: 2025-11-12 --- + + > [!primary] > Este artículo explica cómo configurar direcciones Additional IPv4 en una interfaz pública. También puede configurar direcciones IPv6 en sus servidores dedicados utilizando [esta guía](/pages/bare_metal_cloud/dedicated_servers/network_ipv6). > @@ -48,489 +62,510 @@ Las siguientes secciones contienen las configuraciones de distribuciones que ofr En los ejemplos siguientes utilizaremos el editor de texto `nano`. En algunos sistemas operativos, es necesario instalarlo antes de utilizarlo. En ese caso, se le pedirá que lo haga. Por supuesto, puede utilizar el editor de texto que prefiera. -### Debian 11 - -Por defecto, el fichero de configuración se encuentra en `/etc/network/interfaces.d/`. Se recomienda realizar una copia de seguridad del archivo de configuración correspondiente. - -#### 1. Crear una copia de seguridad del archivo de configuración - -En nuestro ejemplo, nuestro archivo se llama `50-cloud-init`, por lo que copiamos el archivo `50-cloud-init` utilizando el siguiente comando: - -```sh -sudo cp /etc/network/interfaces.d/50-cloud-init /etc/network/interfaces.d/50-cloud-init.bak -``` - -Si comete algún error, puede volver atrás con los siguientes comandos: - -```sh -sudo rm -f /etc/network/interfaces.d/50-cloud-init -sudo cp /etc/network/interfaces.d/50-cloud-init.bak /etc/network/interfaces.d/50-cloud-init -``` - -#### 2. Editar el archivo de configuración - -> [!primary] -> -> Los nombres de las interfaces de red de esta guía pueden ser diferentes de los suyos. Por favor, adapte las operaciones en consecuencia. -> - -Ya puede editar el archivo. - -```sh -sudo nano /etc/network/interfaces.d/50-cloud-init -``` - -A continuación, debe agregar una interfaz virtual o un alias Ethernet. En nuestro ejemplo, nuestra interfaz se llama `eth0`, por lo que nuestro alias es `eth0:0`. Haga esto para cada dirección Additional IP que quiera configurar. - -No modifique las líneas existentes en el archivo de configuración, simplemente añada su Additional IP al archivo como se indica a continuación, sustituyendo `ADDITIONAL_IP/32` y la interfaz virtual (si su servidor no utiliza **eth0:0**) por sus propios valores: - -```console -auto eth0:0 -iface eth0:0 inet static -address ADDITIONAL_IP -netmask 255.255.255.255 -``` - -También puede configurar su Additional IP añadiendo las siguientes líneas al fichero de configuración: - -```console -post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP netmask 255.255.255.255 broadcast ADDITIONAL_IP -pre-down /sbin/ifconfig eth0:0 down -``` - -Con la configuración anterior, la interfaz virtual se activa o desactiva cada vez que la interfaz «eth0» se activa o desactiva. - -Si tiene que configurar dos direcciones Additional IP, el archivo `/etc/network/interfaces.d/50-cloud-init` debe tener el siguiente aspecto: - -```console -auto eth0 -iface eth0 inet dhcp - -auto eth0:0 -iface eth0:0 inet static -address ADDITIONAL_IP1 -netmask 255.255.255.255 - -auto eth0:1 -iface eth0:1 inet static -address ADDITIONAL_IP2 -netmask 255.255.255.255 -``` - -O como esto: - -```console -auto eth0 -iface eth0 inet dhcp - -# IP 1 -post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP1 netmask 255.255.255.255 broadcast ADDITIONAL_IP1 -pre-down /sbin/ifconfig eth0:0 down - -# IP 2 -post-up /sbin/ifconfig eth0:1 ADDITIONAL_IP2 netmask 255.255.255.255 broadcast ADDITIONAL_IP2 -pre-down /sbin/ifconfig eth0:1 down -``` - -**Ejemplo** - -```console -auto eth0 -iface eth0 inet dhcp - -auto eth0:0 -iface eth0:0 inet static -address 203.0.113.1 -netmask 255.255.255.255 -``` - -O bien: - -```console -auto eth0 -iface eth0 inet dhcp - -# IP 1 -post-up /sbin/ifconfig eth0:0 203.0.113.1 netmask 255.255.255.255 broadcast 203.0.113.1 -pre-down /sbin/ifconfig eth0:0 down -``` - -#### 3. Reiniciar la interfaz - -Por último, reinicie la interfaz con el siguiente comando: - -```sh -sudo /etc/init.d/networking restart -``` - -### Fedora 39 y versiones posteriores - -Fedora ahora utiliza archivos clave (*keyfiles*). -Fedora solía utilizar perfiles de red almacenados por NetworkManager en formato ifcfg en el directorio `/etc/sysconfig/network-scripts/`.
-Como el ifcfg ya no está actualizado, NetworkManager ya no crea nuevos perfiles en este formato de forma predeterminada. El archivo de configuración se encuentra ahora en `/etc/NetworkManager/system-connections/`. - -#### 1. Crear una copia de seguridad del archivo de configuración - -> [!primary] -> -> Tenga en cuenta que el nombre del archivo de red en nuestro ejemplo puede ser diferente del suyo. Por favor, ajuste los ejemplos con el nombre correcto. -> - -Se recomienda realizar una copia de seguridad del archivo de configuración correspondiente. En nuestro ejemplo, nuestro archivo de configuración se llama `cloud-init-eno1.nmconnection`: - -```sh -sudo cp -r /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak -``` - -Si comete algún error, puede volver atrás con los siguientes comandos: - -```sh -sudo rm -f /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -sudo cp /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -``` - -#### 2. Editar el archivo de configuración - -> [!primary] -> Tenga en cuenta que el nombre del archivo de red en nuestro ejemplo puede ser diferente del suyo. Adapte los comandos a su nombre de archivo. -> - -Para obtener el nombre de la interfaz de red y editar el archivo de red adecuado, ejecute uno de los siguientes comandos: - -```sh -ip a -``` - -```sh -nmcli connection show -``` - -No modifique las líneas existentes en el fichero de configuración, añada su Additional IP en el fichero como sigue, sustituyendo `ADDITIONAL_IP/32` por sus propios valores: - -```sh -sudo nano /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -``` - -```console -[ipv4] -method=auto -may-fail=false -address1=ADDITIONAL_IP/32 -``` - -Si tiene dos direcciones Additional IP que configurar, la configuración debería ser similar a la siguiente: - -```console -[ipv4] -method=auto -may-fail=false -address1=ADDITIONAL_IP1/32 -address2=ADDITIONAL_IP2/32 -``` - -**Ejemplo** - -```console -[ipv4] -method=auto -may-fail=false -address1=203.0.113.1/32 -``` - -#### 3. Reiniciar la interfaz - -A continuación, reinicie la interfaz: - -```sh -sudo systemctl restart NetworkManager -``` - -### Debian 12, Ubuntu 20.04 y versiones posteriores - -Por defecto, los ficheros de configuración se encuentran en el directorio `/etc/netplan`. - -El mejor enfoque consiste en crear un archivo de configuración independiente para configurar las direcciones Additional IP. Esto facilita el retroceso en caso de error. - -#### 1. Determinar la interfaz - -```sh -ip a -``` - -Anote el nombre de la interfaz (la interfaz en la que está configurada la dirección IP principal del servidor). - -#### 2. Crear el archivo de configuración - -A continuación, cree un archivo de configuración con la extensión `.yaml`. En nuestro ejemplo, nuestro archivo se llama `51-cloud-init.yaml` - -```sh -sudo nano /etc/netplan/51-cloud-init.yaml -``` - -A continuación, edite el fichero con el siguiente contenido, sustituyendo `INTERFACE_NAME` y `ADDITIONAL_IP` por sus propios valores: - -```yaml -network: - version: 2 - ethernets: - INTERFACE_NAME: - dhcp4: true - addresses: - - ADDITIONAL_IP/32 -``` - -Si tiene dos direcciones Additional IP que configurar, el archivo de configuración debería tener el siguiente aspecto: - -```yaml -network: - version: 2 - ethernets: - INTERFACE_NAME: - dhcp4: true - addresses: - - ADDITIONAL_IP1/32 - - ADDITIONAL_IP2/32 -``` - -> [!warning] -> -> Es importante mantener la alineación de cada elemento de este archivo, como se muestra en el ejemplo anterior. No utilice el tabulador para crear el espacio. Sólo es necesaria la tecla de espacio. -> - -**Ejemplo** - -```yaml -network: - version: 2 - ethernets: - eth0: - dhcp4: true - addresses: - - 203.0.113.1/32 -``` - -Guarde y cierre el archivo. Puede probar la configuración con el siguiente comando: - -```sh -sudo netplan try -``` - -#### 3. Aplicar la configuración - -Por último, reinicie la interfaz con el siguiente comando: - -```sh -sudo netplan apply -``` - -> [!primary] -> Al utilizar el comando `netplan try`, es posible que el sistema envíe un mensaje de advertencia como `Permissions for /etc/netplan/xx-cloud-init.yaml are too open. Netplan configuration should NOT be accessible by others`. Simplemente significa que el archivo no tiene permisos restrictivos. Esto no afecta a la configuración de su Additional IP. Para obtener más información sobre los permisos de archivo, consulte la [documentación oficial de ubuntu](https://help.ubuntu.com/community/FilePermissions). +> [!success] +> Seleccione la pestaña correspondiente a su sistema operativo. > -### AlmaLinux (8 & 9), Rocky Linux (8 & 9) - -El archivo de configuración principal se encuentra en `/etc/sysconfig/network-scripts/`. En nuestro ejemplo, se denomina `ifcfg-eth0`. Antes de realizar cualquier cambio, compruebe el nombre de archivo real en esta carpeta. - -Para cada Additional IP que vaya a configurar, crearemos un fichero de configuración independiente con los siguientes parámetros: `ifcfg-NETWORK_INTERFACE:ID`. Donde `NETWORK_INTERFACE` representa la interfaz física y `ID` es la interfaz de red virtual o el alias ethernet que empieza por un valor de 0. Por ejemplo, para nuestra interfaz llamada `eth0`, el primer alias es `eth0:0`, el segundo alias es `eth0:1`, etc... - -#### 1. Crear una copia de seguridad del archivo de configuración - -```sh -ip a -``` - -Anote el nombre de la interfaz (el nombre en el que está configurada la dirección IP principal del servidor). - -#### 2. Crear el archivo de configuración - -En primer lugar, cree el archivo de configuración. Sustituya `NETWORK_INTERFACE:ID` por sus propios valores. - -```sh -sudo nano /etc/sysconfig/network-scripts/ifcfg-NETWORK_INTERFACE:ID -``` - -A continuación, edite el archivo con el siguiente contenido, sustituyendo `NETWORK_INTERFACE:ID` y `ADDITIONAL_IP` por sus propios valores: - -```console -DEVICE=NETWORK_INTERFACE:ID -ONBOOT=yes -BOOTPROTO=none # For CentOS use "static" -IPADDR=ADDITIONAL_IP -NETMASK=255.255.255.255 -BROADCAST=ADDITIONAL_IP -``` - -**Ejemplo** - -```console -DEVICE=eth0:0 -ONBOOT=yes -BOOTPROTO=none # For CentOS use "static" -IPADDR=203.0.113.1 -NETMASK=255.255.255.255 -BROADCAST=203.0.113.1 -``` - -#### 3. Reinicio de la interfaz - -A continuación, reinicie la interfaz: - -```sh -sudo systemctl restart NetworkManager -``` - -### cPanel - -#### 1. Acceder a la sección Gestión IP de WHM - -En el área de cliente WHM, haga clic en `IP Functions`{.action} y seleccione `Add a New IP Address`{.action} en el menú de la izquierda. - -![Añadir una nueva dirección IP](images/Cpanel-1.png){.thumbnail} - -#### 2. Añadir la información de las Direcciones IP - -Introduzca su dirección IP adicional como "xxx.xxx.xxx.xxx" en el campo "New IP or IP range to add". - -Seleccione `255.255.255.255` como máscara de subred y haga clic en `Submit`{.action}. - -![Introduzca nueva información sobre la nueva dirección IP](images/Cpanel-2024.png){.thumbnail} - -> [!warning] -> -> Atención: Si tiene varias IP que configurar en un mismo bloque y las añade todas al mismo tiempo, el sistema WHM le obligará a utilizar la máscara de subred `255.255.255.0`. No es recomendable utilizar esta configuración. Es necesario añadir cada IP individualmente para poder utilizar la máscara de subred adecuada `255.255.255.255`. -> - -#### 3. Comprobar la configuración IP actual - -En la sección `IP Functions`{.action}, haga clic en `Show or Delete Current IP Addresses`{.action} para comprobar que la dirección Aditional IP se ha añadido correctamente. - -![check configurado por IP](images/Cpanel-2024-1.png){.thumbnail} - -### Windows Server - -Los servidores Windows suelen usar DHCP para la configuración de red. Si ya ha configurado una Additional IP, o si ha cambiado su configuración a IP fija, vaya directamente al siguiente paso. - -De lo contrario, debe cambiar primero la configuración de red de DHCP a configuración de IP fija. - -Abra la consola de comandos **CMD** o **PowerShell** e introduzca el siguiente comando: - -```powershell -ipconfig -``` - -La respuesta tendrá el formato de la imagen: - -![Respuesta del comando ipconfig](images/ipconfig.png){.thumbnail} - -En ella puede consultar su IPv4, la máscara de subred, la puerta de enlace predeterminada y el nombre de la tarjeta de red. - -En nuestro ejemplo, la dirección IP del servidor es **192.0.2.28**. - -Los siguientes pasos pueden realizarse, bien mediante línea comandos, o bien a través de la interfaz gráfica. - -#### Mediante línea de comandos (recomendado) - -En los comandos indicados más abajo, sustituya los siguientes valores: - -|Comando|Valor| -|---|---| -|NETWORK_ADAPTER| Nombre de la tarjeta de red (en el ejemplo, «Ethernet 2»)| -|IP_ADDRESS| Dirección IP del servidor (en el ejemplo, 192.0.2.28)| -|SUBNET_MASK| Máscara de subred (en el ejemplo, 255.255.255.0)| -|GATEWAY| Puerta de enlace predeterminada (en el ejemplo, 192.0.2.254)| -|ADDITIONAL_IP| Dirección Additional IP que quiera añadir| - -> [!warning] -> -> Atención: Si introduce información incorrecta, no será posible acceder al servidor. En ese caso, deberá realizar las correcciones oportunas en modo [WinRescue](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) o a través del [IPMI](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). -> - -Realice las acciones que se indican a continuación en la consola de comandos. - -Cambie a IP fija. - -```powershell -netsh interface ipv4 set address name="NETWORK_ADAPTER" static IP_ADDRESS SUBNET_MASK GATEWAY -``` - -Indique el servidor DNS. - -```powershell -netsh interface ipv4 set dns name="NETWORK_ADAPTER" static 213.186.33.99 -``` - -Añada una Additional IP. - -```powershell -netsh interface ipv4 add address "NETWORK_ADAPTER" ADDITIONAL_IP 255.255.255.255 -``` - -Su Additional IP ya estará activa. - -#### A través de la interfaz gráfica - -1. Vaya a `Start`{.action} > `Control Panel`{.action} > `Network and Internet`{.action} > `Network and Sharing Centre`{.action}. En el menú izquierdo, seleccione `Change Adapter Settings`{.action}. -2. Haga clic derecho en su conexión de red, en el ejemplo `Ethernet 2`{.action}. -3. Haga clic en `Properties`{.action}. -4. Seleccione `Internet Protocol Version 4 (TCP/IPv4)`{.action} y, a continuación, haga clic en el botón `Properties`{.action}. -5. Marque la opción `Use the following IP address`{.action} e introduzca la IP principal del servidor, la máscara de subred y la puerta de enlace predeterminada obtenidas anteriormente con el comando `ipconfig`. En **Preferred DNS Server**, introduzca **213.186.33.99**. - -![Propiedades del protocolo de internet versión 4 (TCP/IPv4)](images/configure-main-ip.png){.thumbnail} - -> [!warning] -> -> Atención: Si introduce información incorrecta, no será posible acceder al servidor. En ese caso, deberá realizar las correcciones oportunas en modo [WinRescue](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) o a través del [IPMI](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). -> - -A continuación, haga clic en `Advanced`{.action} (todavía en las `TCP/IP Settings`{.action}). - -![Propiedades del protocolo de internet versión 4 (TCP/IPv4)](images/configure-main-ip-1.png){.thumbnail} - -En la sección **IP Address**, haga clic en `Add`{.action}. - -![Opciones avanzadas TCP/IPv4](images/add-additional-ip.png){.thumbnail} - -Introduzca ahí su Additional IP y la máscara de subred **255.255.255.255**. Haga clic en `Add`{.action}. - -![Dirección TCP/IP](images/configure-additional-ip.png){.thumbnail} - -Haga clic en `OK`{.action} para validar la configuración. - -Su Additional IP ya está operativa. Para comprobar la configuración, ejecute el siguiente comando: - -```powershell -ipconfig -``` - -Esto le dará un resultado similar al siguiente ejemplo: - -![Final configuration](images/final-ip-configuration.png){.thumbnail} - -### Plesk - -#### 1. Acceder a la gestión de IP de Plesk - -En el panel de configuración de Plesk, seleccione `Tools & Settings`{.action} en la columna izquierda. - -![acceso a la gestión de las direcciones IP](images/pleskip1.png){.thumbnail} - -Haga clic en `IP Addresses`{.action} bajo **Tools & Settings**. - -#### 2. Añadir la información IP adicional - -En esta sección, haga clic en el botón `Add IP Address`{.action}. - -![añadir información IP](images/Plesk-2024.png){.thumbnail} - -Introduzca su dirección Additional IP como `xxx.xxx.xxx.xxx/32` en el campo "IP address and subnet mask" y haga clic en `OK`{.action}. - -![añadir información IP](images/Plesk-2024-1.png){.thumbnail} - -#### Paso 3: comprobar la configuración IP actual - -En la sección "IP Addresses", compruebe que la dirección Additional IP se haya añadido correctamente. - -![configuración IP actual](images/Plesk-2024-2.png){.thumbnail} +> [!tabs] +> Debian 11 +>> **Debian 11** +>> +>> Por defecto, el fichero de configuración se encuentra en `/etc/network/interfaces.d/`. Se recomienda realizar una copia de seguridad del archivo de configuración correspondiente. +>> +>> 1\. Crear una copia de seguridad del archivo de configuración +>> +>> En nuestro ejemplo, nuestro archivo se llama `50-cloud-init`, por lo que copiamos el archivo `50-cloud-init` utilizando el siguiente comando: +>> +>> ```sh +>> sudo cp /etc/network/interfaces.d/50-cloud-init /etc/network/interfaces.d/50-cloud-init.bak +>> ``` +>> +>> Si comete algún error, puede volver atrás con los siguientes comandos: +>> +>> ```sh +>> sudo rm -f /etc/network/interfaces.d/50-cloud-init +>> sudo cp /etc/network/interfaces.d/50-cloud-init.bak /etc/network/interfaces.d/50-cloud-init +>> ``` +>> +>> 2\. Editar el archivo de configuración +>> +>> > [!primary] +>> > +>> > Los nombres de las interfaces de red de esta guía pueden ser diferentes de los suyos. Por favor, adapte las operaciones en consecuencia. +>> > +>> +>> Ya puede editar el archivo. +>> +>> ```bash +>> sudo nano /etc/network/interfaces.d/50-cloud-init +>> ``` +>> +>> A continuación, debe agregar una interfaz virtual o un alias Ethernet. En nuestro ejemplo, nuestra interfaz se llama `eth0`, por lo que nuestro alias es `eth0:0`. Haga esto para cada dirección Additional IP que quiera configurar. +>> +>> No modifique las líneas existentes en el archivo de configuración, simplemente añada su Additional IP al archivo como se indica a continuación, sustituyendo `ADDITIONAL_IP/32` y la interfaz virtual (si su servidor no utiliza **eth0:0**) por sus propios valores: +>> +>> ```console +>> auto eth0:0 +>> iface eth0:0 inet static +>> address ADDITIONAL_IP +>> netmask 255.255.255.255 +>> ``` +>> +>> También puede configurar su Additional IP añadiendo las siguientes líneas al fichero de configuración: +>> +>> ```console +>> post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP netmask 255.255.255.255 broadcast ADDITIONAL_IP +>> pre-down /sbin/ifconfig eth0:0 down +>> ``` +>> +>> Con la configuración anterior, la interfaz virtual se activa o desactiva cada vez que la interfaz «eth0» se activa o desactiva. +>> +>> Si tiene que configurar dos direcciones Additional IP, el archivo `/etc/network/interfaces.d/50-cloud-init` debe tener el siguiente aspecto: +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> auto eth0:0 +>> iface eth0:0 inet static +>> address ADDITIONAL_IP1 +>> netmask 255.255.255.255 +>> +>> auto eth0:1 +>> iface eth0:1 inet static +>> address ADDITIONAL_IP2 +>> netmask 255.255.255.255 +>> ``` +>> +>> O como esto: +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> # IP 1 +>> post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP1 netmask 255.255.255.255 broadcast ADDITIONAL_IP1 +>> pre-down /sbin/ifconfig eth0:0 down +>> +>> # IP 2 +>> post-up /sbin/ifconfig eth0:1 ADDITIONAL_IP2 netmask 255.255.255.255 broadcast ADDITIONAL_IP2 +>> pre-down /sbin/ifconfig eth0:1 down +>> ``` +>> +>> /// details | **Ejemplo** +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> auto eth0:0 +>> iface eth0:0 inet static +>> address 203.0.113.1 +>> netmask 255.255.255.255 +>> ``` +>> +>> O bien: +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> # IP 1 +>> post-up /sbin/ifconfig eth0:0 203.0.113.1 netmask 255.255.255.255 broadcast 203.0.113.1 +>> pre-down /sbin/ifconfig eth0:0 down +>> ``` +>> /// +>> +>> 3\. Reiniciar la interfaz +>> +>> Por último, reinicie la interfaz con el siguiente comando: +>> +>> ```sh +>> sudo /etc/init.d/networking restart +>> ``` +>> +> Fedora 41+ +>> **Fedora 41 y versiones posteriores** +>> +>> Fedora ahora utiliza archivos clave (*keyfiles*). +>> Fedora solía utilizar perfiles de red almacenados por NetworkManager en formato ifcfg en el directorio `/etc/sysconfig/network-scripts/`.
+>> Como el ifcfg ya no está actualizado, NetworkManager ya no crea nuevos perfiles en este formato de forma predeterminada. El archivo de configuración se encuentra ahora en `/etc/NetworkManager/system-connections/`. +>> +>> 1\. Crear una copia de seguridad del archivo de configuración +>> +>> > [!primary] +>> > +>> > Tenga en cuenta que el nombre del archivo de red en nuestro ejemplo puede ser diferente del suyo. Por favor, ajuste los ejemplos con el nombre correcto. +>> > +>> +>> Se recomienda realizar una copia de seguridad del archivo de configuración correspondiente. En nuestro ejemplo, nuestro archivo de configuración se llama `cloud-init-eno1.nmconnection`: +>> +>> ```bash +>> sudo cp -r /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak +>> ``` +>> +>> Si comete algún error, puede volver atrás con los siguientes comandos: +>> +>> ```bash +>> sudo rm -f /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> sudo cp /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> ``` +>> +>> 2\. Editar el archivo de configuración +>> +>> > [!primary] +>> > Tenga en cuenta que el nombre del archivo de red en nuestro ejemplo puede ser diferente del suyo. Adapte los comandos a su nombre de archivo. +>> > +>> +>> Para obtener el nombre de la interfaz de red y editar el archivo de red adecuado, ejecute uno de los siguientes comandos: +>> +>> ```sh +>> ip a +>> ``` +>> +>> ```sh +>> nmcli connection show +>> ``` +>> +>> No modifique las líneas existentes en el fichero de configuración, añada su Additional IP en el fichero como sigue, sustituyendo `ADDITIONAL_IP/32` por sus propios valores: +>> +>> ```bash +>> sudo nano /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> ``` +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=ADDITIONAL_IP/32 +>> ``` +>> +>> Si tiene dos direcciones Additional IP que configurar, la configuración debería ser similar a la siguiente: +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=ADDITIONAL_IP1/32 +>> address2=ADDITIONAL_IP2/32 +>> ``` +>> +>> /// details | **Ejemplo** +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=203.0.113.1/32 +>> ``` +>> /// +>> +>> 3\. Reiniciar la interfaz +>> +>> A continuación, reinicie la interfaz: +>> +>> ```sh +>> sudo systemctl restart NetworkManager +>> ``` +>> +> Debian 12 y Ubuntu 20.04+ +>> **Debain 12, Ubuntu 20.04 y versiones posteriores** +>> +>> Por defecto, los ficheros de configuración se encuentran en el directorio `/etc/netplan`. +>> +>> El mejor enfoque consiste en crear un archivo de configuración independiente para configurar las direcciones Additional IP. Esto facilita el retroceso en caso de error. +>> +>> 1\. Determinar la interfaz +>> +>> ```sh +>> ip a +>> ``` +>> +>> Anote el nombre de la interfaz (la interfaz en la que está configurada la dirección IP principal del servidor). +>> +>> 2\. Crear el archivo de configuración +>> +>> A continuación, cree un archivo de configuración con la extensión `.yaml`. En nuestro ejemplo, nuestro archivo se llama `51-cloud-init.yaml` +>> +>> ```sh +>> sudo nano /etc/netplan/51-cloud-init.yaml +>> ``` +>> +>> A continuación, edite el fichero con el siguiente contenido, sustituyendo `INTERFACE_NAME` y `ADDITIONAL_IP` por sus propios valores: +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> INTERFACE_NAME: +>> dhcp4: true +>> addresses: +>> - ADDITIONAL_IP/32 +>> ``` +>> +>> Si tiene dos direcciones Additional IP que configurar, el archivo de configuración debería tener el siguiente aspecto: +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> INTERFACE_NAME: +>> dhcp4: true +>> addresses: +>> - ADDITIONAL_IP1/32 +>> - ADDITIONAL_IP2/32 +>> ``` +>> +>> > [!warning] +>> > +>> > Es importante mantener la alineación de cada elemento de este archivo, como se muestra en el ejemplo anterior. No utilice el tabulador para crear el espacio. Sólo es necesaria la tecla de espacio. +>> > +>> +>>/// details | **Ejemplo** +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> eth0: +>> dhcp4: true +>> addresses: +>> - 203.0.113.1/32 +>> ``` +>> /// +>> +>> Guarde y cierre el archivo. Puede probar la configuración con el siguiente comando: +>> +>> ```sh +>> sudo netplan try +>> ``` +>> +>> 3\. Aplicar la configuración +>> +>> Por último, reinicie la interfaz con el siguiente comando: +>> +>> ```sh +>> sudo netplan apply +>> ``` +>> +>> > [!primary] +>> > Al utilizar el comando `netplan try`, es posible que el sistema envíe un mensaje de advertencia como `Permissions for /etc/netplan/xx-cloud-init.yaml are too open. Netplan configuration should NOT be accessible by others`. Simplemente significa que el archivo no tiene permisos restrictivos. Esto no afecta a la configuración de su Additional IP. Para obtener más información sobre los permisos de archivo, consulte la [documentación oficial de ubuntu](https://help.ubuntu.com/community/FilePermissions). +>> > +>> +> AlmaLinux / Rocky Linux +>> **AlmaLinux (8 & 9), Rocky Linux (8 & 9)** +>> +>> El archivo de configuración principal se encuentra en `/etc/sysconfig/network-scripts/`. En nuestro ejemplo, se denomina `ifcfg-eth0`. Antes de realizar cualquier cambio, compruebe el nombre de archivo real en esta carpeta. +>> +>> Para cada Additional IP que vaya a configurar, crearemos un fichero de configuración independiente con los siguientes parámetros: `ifcfg-NETWORK_INTERFACE:ID`. Donde `NETWORK_INTERFACE` representa la interfaz física y `ID` es la interfaz de red virtual o el alias ethernet que empieza por un valor de 0. Por ejemplo, para nuestra interfaz llamada `eth0`, el primer alias es `eth0:0`, el segundo alias es `eth0:1`, etc... +>> +>> 1\. Crear una copia de seguridad del archivo de configuración +>> +>> ```sh +>> ip a +>> ``` +>> +>> Anote el nombre de la interfaz (el nombre en el que está configurada la dirección IP principal del servidor). +>> +>> 2\. Crear el archivo de configuración +>> +>> En primer lugar, cree el archivo de configuración. Sustituya `NETWORK_INTERFACE:ID` por sus propios valores. +>> +>> ```sh +>> sudo nano /etc/sysconfig/network-scripts/ifcfg-NETWORK_INTERFACE:ID +>> ``` +>> +>> A continuación, edite el archivo con el siguiente contenido, sustituyendo `NETWORK_INTERFACE:ID` y `ADDITIONAL_IP` por sus propios valores: +>> +>> ```console +>> DEVICE=NETWORK_INTERFACE:ID +>> ONBOOT=yes +>> BOOTPROTO=none # For CentOS use "static" +>> IPADDR=ADDITIONAL_IP +>> NETMASK=255.255.255.255 +>> BROADCAST=ADDITIONAL_IP +>> ``` +>> +>> /// details | **Ejemplo** +>> +>> ```console +>> DEVICE=eth0:0 +>> ONBOOT=yes +>> BOOTPROTO=none # For CentOS use "static" +>> IPADDR=203.0.113.1 +>> NETMASK=255.255.255.255 +>> BROADCAST=203.0.113.1 +>> ``` +>> /// +>> +>> 3\. Reinicio de la interfaz +>> +>> A continuación, reinicie la interfaz: +>> +>> ```sh +>> sudo systemctl restart NetworkManager +>> ``` +>> +> cPanel +>> **cPanel** +>> +>> 1\. Acceder a la sección Gestión IP de WHM +>> +>> En el área de cliente WHM, haga clic en `IP Functions`{.action} y seleccione `Add a New IP Address`{.action} en el menú de la izquierda. +>> +>> ![Añadir una nueva dirección IP](images/Cpanel-1.png){.thumbnail} +>> +>> 2\. Añadir la información de las Direcciones IP +>> +>> Introduzca su dirección IP adicional como "xxx.xxx.xxx.xxx" en el campo "New IP or IP range to add". +>> +>> Seleccione `255.255.255.255` como máscara de subred y haga clic en `Submit`{.action}. +>> +>> ![Introduzca nueva información sobre la nueva dirección IP](images/Cpanel-2024.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Atención: Si tiene varias IP que configurar en un mismo bloque y las añade todas al mismo tiempo, el sistema WHM le obligará a utilizar la máscara de subred `255.255.255.0`. No es recomendable utilizar esta configuración. Es necesario añadir cada IP individualmente para poder utilizar la máscara de subred adecuada `255.255.255.255`. +>> > +>> +>> 3\. Comprobar la configuración IP actual +>> +>> En la sección `IP Functions`{.action}, haga clic en `Show or Delete Current IP Addresses`{.action} para comprobar que la dirección Aditional IP se ha añadido correctamente. +>> +>> ![check configurado por IP](images/Cpanel-2024-1.png){.thumbnail} +>> +> Windows Server +>> **Windows Server** +>> +>> Los servidores Windows suelen usar DHCP para la configuración de red. Si ya ha configurado una Additional IP, o si ha cambiado su configuración a IP fija, vaya directamente al siguiente paso. +>> +>> De lo contrario, debe cambiar primero la configuración de red de DHCP a configuración de IP fija. +>> +>> Abra la consola de comandos **CMD** o **PowerShell** e introduzca el siguiente comando: +>> +>> ```powershell +>> ipconfig +>> ``` +>> +>> La respuesta tendrá el formato de la imagen: +>> +>> ![Respuesta del comando ipconfig](images/ipconfig.png){.thumbnail} +>> +>> En ella puede consultar su IPv4, la máscara de subred, la puerta de enlace predeterminada y el nombre de la tarjeta de red. +>> +>> En nuestro ejemplo, la dirección IP del servidor es **192.0.2.28**. +>> +>> Los siguientes pasos pueden realizarse, bien mediante línea comandos, o bien a través de la interfaz gráfica. +>> +>> **Mediante línea de comandos (recomendado)** +>> +>> En los comandos indicados más abajo, sustituya los siguientes valores: +>> +>> |Comando|Valor| +>> |---|---| +>> |NETWORK_ADAPTER| Nombre de la tarjeta de red (en el ejemplo, «Ethernet 2»)| +>> |IP_ADDRESS| Dirección IP del servidor (en el ejemplo, 192.0.2.28)| +>> |SUBNET_MASK| Máscara de subred (en el ejemplo, 255.255.255.0)| +>> |GATEWAY| Puerta de enlace predeterminada (en el ejemplo, 192.0.2.254)| +>> |ADDITIONAL_IP| Dirección Additional IP que quiera añadir| +>> +>> > [!warning] +>> > +>> > Atención: Si introduce información incorrecta, no será posible acceder al servidor. En ese caso, deberá realizar las correcciones oportunas en modo [WinRescue](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) o a través del [IPMI](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). +>> > +>> +>> Realice las acciones que se indican a continuación en la consola de comandos. +>> +>> Cambie a IP fija. +>> +>> ```powershell +>> netsh interface ipv4 set address name="NETWORK_ADAPTER" static IP_ADDRESS SUBNET_MASK GATEWAY +>> ``` +>> +>> Indique el servidor DNS. +>> +>> ```powershell +>> netsh interface ipv4 set dns name="NETWORK_ADAPTER" static 213.186.33.99 +>> ``` +>> +>> Añada una Additional IP. +>> +>> ```powershell +>> netsh interface ipv4 add address "NETWORK_ADAPTER" ADDITIONAL_IP 255.255.255.255 +>> ``` +>> +>> Su Additional IP ya estará activa. +>> +>> /// details | **A través de la interfaz gráfica** +>> +>> 1\. Vaya a `Start`{.action} > `Control Panel`{.action} > `Network and Internet`{.action} > `Network and Sharing Centre`{.action}. En el menú izquierdo, seleccione `Change Adapter Settings`{.action}. +>> +>> 2\. Haga clic derecho en su conexión de red, en el ejemplo `Ethernet 2`{.action}. +>> +>> 3\. Haga clic en `Properties`{.action}. +>> +>> 4\. Seleccione `Internet Protocol Version 4 (TCP/IPv4)`{.action} y, a continuación, haga clic en el botón `Properties`{.action}. +>> +>> 5\. Marque la opción `Use the following IP address`{.action} e introduzca la IP principal del servidor, la máscara de subred y la puerta de enlace predeterminada obtenidas anteriormente con el comando `ipconfig`. En **Preferred DNS Server**, introduzca **213.186.33.99**. +>> +>> ![Propiedades del protocolo de internet versión 4 (TCP/IPv4)](images/configure-main-ip.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Atención: Si introduce información incorrecta, no será posible acceder al servidor. En ese caso, deberá realizar las correcciones oportunas en modo [WinRescue](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) o a través del [IPMI](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). +>> > +>> +>> A continuación, haga clic en `Advanced`{.action} (todavía en las `TCP/IP Settings`{.action}). +>> +>> ![Propiedades del protocolo de internet versión 4 (TCP/IPv4)](images/configure-main-ip-1.png){.thumbnail} +>> +>> En la sección **IP Address**, haga clic en `Add`{.action}. +>> +>> ![Opciones avanzadas TCP/IPv4](images/add-additional-ip.png){.thumbnail} +>> +>> Introduzca ahí su Additional IP y la máscara de subred **255.255.255.255**. Haga clic en `Add`{.action}. +>> +>> ![Dirección TCP/IP](images/configure-additional-ip.png){.thumbnail} +>> +>> Haga clic en `OK`{.action} para validar la configuración. +>> +>> Su Additional IP ya está operativa. Para comprobar la configuración, ejecute el siguiente comando: +>> +>> ```powershell +>> ipconfig +>> ``` +>> +>> Esto le dará un resultado similar al siguiente ejemplo: +>> +>> ![Final configuration](images/final-ip-configuration.png){.thumbnail} +>> +> Plesk +>> **Plesk** +>> +>> 1\. Acceder a la gestión de IP de Plesk +>> +>> En el panel de configuración de Plesk, seleccione `Tools & Settings`{.action} en la columna izquierda. +>> +>> ![acceso a la gestión de las direcciones IP](images/pleskip1.png){.thumbnail} +>> +>> Haga clic en `IP Addresses`{.action} bajo **Tools & Settings**. +>> +>> 2\. Añadir la información IP adicional +>> +>> En esta sección, haga clic en el botón `Add IP Address`{.action}. +>> +>> ![añadir información IP](images/Plesk-2024.png){.thumbnail} +>> +>> Introduzca su dirección Additional IP como `xxx.xxx.xxx.xxx/32` en el campo "IP address and subnet mask" y haga clic en `OK`{.action}. +>> +>> ![añadir información IP](images/Plesk-2024-1.png){.thumbnail} +>> +>> 3\. comprobar la configuración IP actual +>> +>> En la sección "IP Addresses", compruebe que la dirección Additional IP se haya añadido correctamente. +>> +>> ![configuración IP actual](images/Plesk-2024-2.png){.thumbnail} +>> #### Resolución de fallos diff --git a/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.es-us.md b/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.es-us.md index 2de3c75b0f2..ee224f2aea2 100644 --- a/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.es-us.md +++ b/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.es-us.md @@ -1,9 +1,23 @@ --- title: 'Configurar una IP como alias' excerpt: 'Descubra cómo añadir direcciones Additional IP a la configuración de un servidor' -updated: 2025-07-22 +updated: 2025-11-12 --- + + > [!primary] > Este artículo explica cómo configurar direcciones Additional IPv4 en una interfaz pública. También puede configurar direcciones IPv6 en sus servidores dedicados utilizando [esta guía](/pages/bare_metal_cloud/dedicated_servers/network_ipv6). > @@ -48,489 +62,510 @@ Las siguientes secciones contienen las configuraciones de distribuciones que ofr En los ejemplos siguientes utilizaremos el editor de texto `nano`. En algunos sistemas operativos, es necesario instalarlo antes de utilizarlo. En ese caso, se le pedirá que lo haga. Por supuesto, puede utilizar el editor de texto que prefiera. -### Debian 11 - -Por defecto, el fichero de configuración se encuentra en `/etc/network/interfaces.d/`. Se recomienda realizar una copia de seguridad del archivo de configuración correspondiente. - -#### 1. Crear una copia de seguridad del archivo de configuración - -En nuestro ejemplo, nuestro archivo se llama `50-cloud-init`, por lo que copiamos el archivo `50-cloud-init` utilizando el siguiente comando: - -```sh -sudo cp /etc/network/interfaces.d/50-cloud-init /etc/network/interfaces.d/50-cloud-init.bak -``` - -Si comete algún error, puede volver atrás con los siguientes comandos: - -```sh -sudo rm -f /etc/network/interfaces.d/50-cloud-init -sudo cp /etc/network/interfaces.d/50-cloud-init.bak /etc/network/interfaces.d/50-cloud-init -``` - -#### 2. Editar el archivo de configuración - -> [!primary] -> -> Los nombres de las interfaces de red de esta guía pueden ser diferentes de los suyos. Por favor, adapte las operaciones en consecuencia. -> - -Ya puede editar el archivo. - -```sh -sudo nano /etc/network/interfaces.d/50-cloud-init -``` - -A continuación, debe agregar una interfaz virtual o un alias Ethernet. En nuestro ejemplo, nuestra interfaz se llama `eth0`, por lo que nuestro alias es `eth0:0`. Haga esto para cada dirección Additional IP que quiera configurar. - -No modifique las líneas existentes en el archivo de configuración, simplemente añada su Additional IP al archivo como se indica a continuación, sustituyendo `ADDITIONAL_IP/32` y la interfaz virtual (si su servidor no utiliza **eth0:0**) por sus propios valores: - -```console -auto eth0:0 -iface eth0:0 inet static -address ADDITIONAL_IP -netmask 255.255.255.255 -``` - -También puede configurar su Additional IP añadiendo las siguientes líneas al fichero de configuración: - -```console -post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP netmask 255.255.255.255 broadcast ADDITIONAL_IP -pre-down /sbin/ifconfig eth0:0 down -``` - -Con la configuración anterior, la interfaz virtual se activa o desactiva cada vez que la interfaz «eth0» se activa o desactiva. - -Si tiene que configurar dos direcciones Additional IP, el archivo `/etc/network/interfaces.d/50-cloud-init` debe tener el siguiente aspecto: - -```console -auto eth0 -iface eth0 inet dhcp - -auto eth0:0 -iface eth0:0 inet static -address ADDITIONAL_IP1 -netmask 255.255.255.255 - -auto eth0:1 -iface eth0:1 inet static -address ADDITIONAL_IP2 -netmask 255.255.255.255 -``` - -O como esto: - -```console -auto eth0 -iface eth0 inet dhcp - -# IP 1 -post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP1 netmask 255.255.255.255 broadcast ADDITIONAL_IP1 -pre-down /sbin/ifconfig eth0:0 down - -# IP 2 -post-up /sbin/ifconfig eth0:1 ADDITIONAL_IP2 netmask 255.255.255.255 broadcast ADDITIONAL_IP2 -pre-down /sbin/ifconfig eth0:1 down -``` - -**Ejemplo** - -```console -auto eth0 -iface eth0 inet dhcp - -auto eth0:0 -iface eth0:0 inet static -address 203.0.113.1 -netmask 255.255.255.255 -``` - -O bien: - -```console -auto eth0 -iface eth0 inet dhcp - -# IP 1 -post-up /sbin/ifconfig eth0:0 203.0.113.1 netmask 255.255.255.255 broadcast 203.0.113.1 -pre-down /sbin/ifconfig eth0:0 down -``` - -#### 3. Reiniciar la interfaz - -Por último, reinicie la interfaz con el siguiente comando: - -```sh -sudo /etc/init.d/networking restart -``` - -### Fedora 39 y versiones posteriores - -Fedora ahora utiliza archivos clave (*keyfiles*). -Fedora solía utilizar perfiles de red almacenados por NetworkManager en formato ifcfg en el directorio `/etc/sysconfig/network-scripts/`.
-Como el ifcfg ya no está actualizado, NetworkManager ya no crea nuevos perfiles en este formato de forma predeterminada. El archivo de configuración se encuentra ahora en `/etc/NetworkManager/system-connections/`. - -#### 1. Crear una copia de seguridad del archivo de configuración - -> [!primary] -> -> Tenga en cuenta que el nombre del archivo de red en nuestro ejemplo puede ser diferente del suyo. Por favor, ajuste los ejemplos con el nombre correcto. -> - -Se recomienda realizar una copia de seguridad del archivo de configuración correspondiente. En nuestro ejemplo, nuestro archivo de configuración se llama `cloud-init-eno1.nmconnection`: - -```sh -sudo cp -r /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak -``` - -Si comete algún error, puede volver atrás con los siguientes comandos: - -```sh -sudo rm -f /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -sudo cp /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -``` - -#### 2. Editar el archivo de configuración - -> [!primary] -> Tenga en cuenta que el nombre del archivo de red en nuestro ejemplo puede ser diferente del suyo. Adapte los comandos a su nombre de archivo. -> - -Para obtener el nombre de la interfaz de red y editar el archivo de red adecuado, ejecute uno de los siguientes comandos: - -```sh -ip a -``` - -```sh -nmcli connection show -``` - -No modifique las líneas existentes en el fichero de configuración, añada su Additional IP en el fichero como sigue, sustituyendo `ADDITIONAL_IP/32` por sus propios valores: - -```sh -sudo nano /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -``` - -```console -[ipv4] -method=auto -may-fail=false -address1=ADDITIONAL_IP/32 -``` - -Si tiene dos direcciones Additional IP que configurar, la configuración debería ser similar a la siguiente: - -```console -[ipv4] -method=auto -may-fail=false -address1=ADDITIONAL_IP1/32 -address2=ADDITIONAL_IP2/32 -``` - -**Ejemplo** - -```console -[ipv4] -method=auto -may-fail=false -address1=203.0.113.1/32 -``` - -#### 3. Reiniciar la interfaz - -A continuación, reinicie la interfaz: - -```sh -sudo systemctl restart NetworkManager -``` - -### Debian 12, Ubuntu 20.04 y versiones posteriores - -Por defecto, los ficheros de configuración se encuentran en el directorio `/etc/netplan`. - -El mejor enfoque consiste en crear un archivo de configuración independiente para configurar las direcciones Additional IP. Esto facilita el retroceso en caso de error. - -#### 1. Determinar la interfaz - -```sh -ip a -``` - -Anote el nombre de la interfaz (la interfaz en la que está configurada la dirección IP principal del servidor). - -#### 2. Crear el archivo de configuración - -A continuación, cree un archivo de configuración con la extensión `.yaml`. En nuestro ejemplo, nuestro archivo se llama `51-cloud-init.yaml` - -```sh -sudo nano /etc/netplan/51-cloud-init.yaml -``` - -A continuación, edite el fichero con el siguiente contenido, sustituyendo `INTERFACE_NAME` y `ADDITIONAL_IP` por sus propios valores: - -```yaml -network: - version: 2 - ethernets: - INTERFACE_NAME: - dhcp4: true - addresses: - - ADDITIONAL_IP/32 -``` - -Si tiene dos direcciones Additional IP que configurar, el archivo de configuración debería tener el siguiente aspecto: - -```yaml -network: - version: 2 - ethernets: - INTERFACE_NAME: - dhcp4: true - addresses: - - ADDITIONAL_IP1/32 - - ADDITIONAL_IP2/32 -``` - -> [!warning] -> -> Es importante mantener la alineación de cada elemento de este archivo, como se muestra en el ejemplo anterior. No utilice el tabulador para crear el espacio. Sólo es necesaria la tecla de espacio. -> - -**Ejemplo** - -```yaml -network: - version: 2 - ethernets: - eth0: - dhcp4: true - addresses: - - 203.0.113.1/32 -``` - -Guarde y cierre el archivo. Puede probar la configuración con el siguiente comando: - -```sh -sudo netplan try -``` - -#### 3. Aplicar la configuración - -Por último, reinicie la interfaz con el siguiente comando: - -```sh -sudo netplan apply -``` - -> [!primary] -> Al utilizar el comando `netplan try`, es posible que el sistema envíe un mensaje de advertencia como `Permissions for /etc/netplan/xx-cloud-init.yaml are too open. Netplan configuration should NOT be accessible by others`. Simplemente significa que el archivo no tiene permisos restrictivos. Esto no afecta a la configuración de su Additional IP. Para obtener más información sobre los permisos de archivo, consulte la [documentación oficial de ubuntu](https://help.ubuntu.com/community/FilePermissions). +> [!success] +> Seleccione la pestaña correspondiente a su sistema operativo. > -### AlmaLinux (8 & 9), Rocky Linux (8 & 9) - -El archivo de configuración principal se encuentra en `/etc/sysconfig/network-scripts/`. En nuestro ejemplo, se denomina `ifcfg-eth0`. Antes de realizar cualquier cambio, compruebe el nombre de archivo real en esta carpeta. - -Para cada Additional IP que vaya a configurar, crearemos un fichero de configuración independiente con los siguientes parámetros: `ifcfg-NETWORK_INTERFACE:ID`. Donde `NETWORK_INTERFACE` representa la interfaz física y `ID` es la interfaz de red virtual o el alias ethernet que empieza por un valor de 0. Por ejemplo, para nuestra interfaz llamada `eth0`, el primer alias es `eth0:0`, el segundo alias es `eth0:1`, etc... - -#### 1. Crear una copia de seguridad del archivo de configuración - -```sh -ip a -``` - -Anote el nombre de la interfaz (el nombre en el que está configurada la dirección IP principal del servidor). - -#### 2. Crear el archivo de configuración - -En primer lugar, cree el archivo de configuración. Sustituya `NETWORK_INTERFACE:ID` por sus propios valores. - -```sh -sudo nano /etc/sysconfig/network-scripts/ifcfg-NETWORK_INTERFACE:ID -``` - -A continuación, edite el archivo con el siguiente contenido, sustituyendo `NETWORK_INTERFACE:ID` y `ADDITIONAL_IP` por sus propios valores: - -```console -DEVICE=NETWORK_INTERFACE:ID -ONBOOT=yes -BOOTPROTO=none # For CentOS use "static" -IPADDR=ADDITIONAL_IP -NETMASK=255.255.255.255 -BROADCAST=ADDITIONAL_IP -``` - -**Ejemplo** - -```console -DEVICE=eth0:0 -ONBOOT=yes -BOOTPROTO=none # For CentOS use "static" -IPADDR=203.0.113.1 -NETMASK=255.255.255.255 -BROADCAST=203.0.113.1 -``` - -#### 3. Reinicio de la interfaz - -A continuación, reinicie la interfaz: - -```sh -sudo systemctl restart NetworkManager -``` - -### cPanel - -#### 1. Acceder a la sección Gestión IP de WHM - -En el área de cliente WHM, haga clic en `IP Functions`{.action} y seleccione `Add a New IP Address`{.action} en el menú de la izquierda. - -![Añadir una nueva dirección IP](images/Cpanel-1.png){.thumbnail} - -#### 2. Añadir la información de las Direcciones IP - -Introduzca su dirección IP adicional como "xxx.xxx.xxx.xxx" en el campo "New IP or IP range to add". - -Seleccione `255.255.255.255` como máscara de subred y haga clic en `Submit`{.action}. - -![Introduzca nueva información sobre la nueva dirección IP](images/Cpanel-2024.png){.thumbnail} - -> [!warning] -> -> Atención: Si tiene varias IP que configurar en un mismo bloque y las añade todas al mismo tiempo, el sistema WHM le obligará a utilizar la máscara de subred `255.255.255.0`. No es recomendable utilizar esta configuración. Es necesario añadir cada IP individualmente para poder utilizar la máscara de subred adecuada `255.255.255.255`. -> - -#### 3. Comprobar la configuración IP actual - -En la sección `IP Functions`{.action}, haga clic en `Show or Delete Current IP Addresses`{.action} para comprobar que la dirección Aditional IP se ha añadido correctamente. - -![check configurado por IP](images/Cpanel-2024-1.png){.thumbnail} - -### Windows Server - -Los servidores Windows suelen usar DHCP para la configuración de red. Si ya ha configurado una Additional IP, o si ha cambiado su configuración a IP fija, vaya directamente al siguiente paso. - -De lo contrario, debe cambiar primero la configuración de red de DHCP a configuración de IP fija. - -Abra la consola de comandos **CMD** o **PowerShell** e introduzca el siguiente comando: - -```powershell -ipconfig -``` - -La respuesta tendrá el formato de la imagen: - -![Respuesta del comando ipconfig](images/ipconfig.png){.thumbnail} - -En ella puede consultar su IPv4, la máscara de subred, la puerta de enlace predeterminada y el nombre de la tarjeta de red. - -En nuestro ejemplo, la dirección IP del servidor es **192.0.2.28**. - -Los siguientes pasos pueden realizarse, bien mediante línea comandos, o bien a través de la interfaz gráfica. - -#### Mediante línea de comandos (recomendado) - -En los comandos indicados más abajo, sustituya los siguientes valores: - -|Comando|Valor| -|---|---| -|NETWORK_ADAPTER| Nombre de la tarjeta de red (en el ejemplo, «Ethernet 2»)| -|IP_ADDRESS| Dirección IP del servidor (en el ejemplo, 192.0.2.28)| -|SUBNET_MASK| Máscara de subred (en el ejemplo, 255.255.255.0)| -|GATEWAY| Puerta de enlace predeterminada (en el ejemplo, 192.0.2.254)| -|ADDITIONAL_IP| Dirección Additional IP que quiera añadir| - -> [!warning] -> -> Atención: Si introduce información incorrecta, no será posible acceder al servidor. En ese caso, deberá realizar las correcciones oportunas en modo [WinRescue](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) o a través del [IPMI](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). -> - -Realice las acciones que se indican a continuación en la consola de comandos. - -Cambie a IP fija. - -```powershell -netsh interface ipv4 set address name="NETWORK_ADAPTER" static IP_ADDRESS SUBNET_MASK GATEWAY -``` - -Indique el servidor DNS. - -```powershell -netsh interface ipv4 set dns name="NETWORK_ADAPTER" static 213.186.33.99 -``` - -Añada una Additional IP. - -```powershell -netsh interface ipv4 add address "NETWORK_ADAPTER" ADDITIONAL_IP 255.255.255.255 -``` - -Su Additional IP ya estará activa. - -#### A través de la interfaz gráfica - -1. Vaya a `Start`{.action} > `Control Panel`{.action} > `Network and Internet`{.action} > `Network and Sharing Centre`{.action}. En el menú izquierdo, seleccione `Change Adapter Settings`{.action}. -2. Haga clic derecho en su conexión de red, en el ejemplo `Ethernet 2`{.action}. -3. Haga clic en `Properties`{.action}. -4. Seleccione `Internet Protocol Version 4 (TCP/IPv4)`{.action} y, a continuación, haga clic en el botón `Properties`{.action}. -5. Marque la opción `Use the following IP address`{.action} e introduzca la IP principal del servidor, la máscara de subred y la puerta de enlace predeterminada obtenidas anteriormente con el comando `ipconfig`. En **Preferred DNS Server**, introduzca **213.186.33.99**. - -![Propiedades del protocolo de internet versión 4 (TCP/IPv4)](images/configure-main-ip.png){.thumbnail} - -> [!warning] -> -> Atención: Si introduce información incorrecta, no será posible acceder al servidor. En ese caso, deberá realizar las correcciones oportunas en modo [WinRescue](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) o a través del [IPMI](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). -> - -A continuación, haga clic en `Advanced`{.action} (todavía en las `TCP/IP Settings`{.action}). - -![Propiedades del protocolo de internet versión 4 (TCP/IPv4)](images/configure-main-ip-1.png){.thumbnail} - -En la sección **IP Address**, haga clic en `Add`{.action}. - -![Opciones avanzadas TCP/IPv4](images/add-additional-ip.png){.thumbnail} - -Introduzca ahí su Additional IP y la máscara de subred **255.255.255.255**. Haga clic en `Add`{.action}. - -![Dirección TCP/IP](images/configure-additional-ip.png){.thumbnail} - -Haga clic en `OK`{.action} para validar la configuración. - -Su Additional IP ya está operativa. Para comprobar la configuración, ejecute el siguiente comando: - -```powershell -ipconfig -``` - -Esto le dará un resultado similar al siguiente ejemplo: - -![Final configuration](images/final-ip-configuration.png){.thumbnail} - -### Plesk - -#### 1. Acceder a la gestión de IP de Plesk - -En el panel de configuración de Plesk, seleccione `Tools & Settings`{.action} en la columna izquierda. - -![acceso a la gestión de las direcciones IP](images/pleskip1.png){.thumbnail} - -Haga clic en `IP Addresses`{.action} bajo **Tools & Settings**. - -#### 2. Añadir la información IP adicional - -En esta sección, haga clic en el botón `Add IP Address`{.action}. - -![añadir información IP](images/Plesk-2024.png){.thumbnail} - -Introduzca su dirección Additional IP como `xxx.xxx.xxx.xxx/32` en el campo "IP address and subnet mask" y haga clic en `OK`{.action}. - -![añadir información IP](images/Plesk-2024-1.png){.thumbnail} - -#### Paso 3: comprobar la configuración IP actual - -En la sección "IP Addresses", compruebe que la dirección Additional IP se haya añadido correctamente. - -![configuración IP actual](images/Plesk-2024-2.png){.thumbnail} +> [!tabs] +> Debian 11 +>> **Debian 11** +>> +>> Por defecto, el fichero de configuración se encuentra en `/etc/network/interfaces.d/`. Se recomienda realizar una copia de seguridad del archivo de configuración correspondiente. +>> +>> 1\. Crear una copia de seguridad del archivo de configuración +>> +>> En nuestro ejemplo, nuestro archivo se llama `50-cloud-init`, por lo que copiamos el archivo `50-cloud-init` utilizando el siguiente comando: +>> +>> ```sh +>> sudo cp /etc/network/interfaces.d/50-cloud-init /etc/network/interfaces.d/50-cloud-init.bak +>> ``` +>> +>> Si comete algún error, puede volver atrás con los siguientes comandos: +>> +>> ```sh +>> sudo rm -f /etc/network/interfaces.d/50-cloud-init +>> sudo cp /etc/network/interfaces.d/50-cloud-init.bak /etc/network/interfaces.d/50-cloud-init +>> ``` +>> +>> 2\. Editar el archivo de configuración +>> +>> > [!primary] +>> > +>> > Los nombres de las interfaces de red de esta guía pueden ser diferentes de los suyos. Por favor, adapte las operaciones en consecuencia. +>> > +>> +>> Ya puede editar el archivo. +>> +>> ```bash +>> sudo nano /etc/network/interfaces.d/50-cloud-init +>> ``` +>> +>> A continuación, debe agregar una interfaz virtual o un alias Ethernet. En nuestro ejemplo, nuestra interfaz se llama `eth0`, por lo que nuestro alias es `eth0:0`. Haga esto para cada dirección Additional IP que quiera configurar. +>> +>> No modifique las líneas existentes en el archivo de configuración, simplemente añada su Additional IP al archivo como se indica a continuación, sustituyendo `ADDITIONAL_IP/32` y la interfaz virtual (si su servidor no utiliza **eth0:0**) por sus propios valores: +>> +>> ```console +>> auto eth0:0 +>> iface eth0:0 inet static +>> address ADDITIONAL_IP +>> netmask 255.255.255.255 +>> ``` +>> +>> También puede configurar su Additional IP añadiendo las siguientes líneas al fichero de configuración: +>> +>> ```console +>> post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP netmask 255.255.255.255 broadcast ADDITIONAL_IP +>> pre-down /sbin/ifconfig eth0:0 down +>> ``` +>> +>> Con la configuración anterior, la interfaz virtual se activa o desactiva cada vez que la interfaz «eth0» se activa o desactiva. +>> +>> Si tiene que configurar dos direcciones Additional IP, el archivo `/etc/network/interfaces.d/50-cloud-init` debe tener el siguiente aspecto: +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> auto eth0:0 +>> iface eth0:0 inet static +>> address ADDITIONAL_IP1 +>> netmask 255.255.255.255 +>> +>> auto eth0:1 +>> iface eth0:1 inet static +>> address ADDITIONAL_IP2 +>> netmask 255.255.255.255 +>> ``` +>> +>> O como esto: +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> # IP 1 +>> post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP1 netmask 255.255.255.255 broadcast ADDITIONAL_IP1 +>> pre-down /sbin/ifconfig eth0:0 down +>> +>> # IP 2 +>> post-up /sbin/ifconfig eth0:1 ADDITIONAL_IP2 netmask 255.255.255.255 broadcast ADDITIONAL_IP2 +>> pre-down /sbin/ifconfig eth0:1 down +>> ``` +>> +>> /// details | **Ejemplo** +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> auto eth0:0 +>> iface eth0:0 inet static +>> address 203.0.113.1 +>> netmask 255.255.255.255 +>> ``` +>> +>> O bien: +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> # IP 1 +>> post-up /sbin/ifconfig eth0:0 203.0.113.1 netmask 255.255.255.255 broadcast 203.0.113.1 +>> pre-down /sbin/ifconfig eth0:0 down +>> ``` +>> /// +>> +>> 3\. Reiniciar la interfaz +>> +>> Por último, reinicie la interfaz con el siguiente comando: +>> +>> ```sh +>> sudo /etc/init.d/networking restart +>> ``` +>> +> Fedora 41+ +>> **Fedora 41 y versiones posteriores** +>> +>> Fedora ahora utiliza archivos clave (*keyfiles*). +>> Fedora solía utilizar perfiles de red almacenados por NetworkManager en formato ifcfg en el directorio `/etc/sysconfig/network-scripts/`.
+>> Como el ifcfg ya no está actualizado, NetworkManager ya no crea nuevos perfiles en este formato de forma predeterminada. El archivo de configuración se encuentra ahora en `/etc/NetworkManager/system-connections/`. +>> +>> 1\. Crear una copia de seguridad del archivo de configuración +>> +>> > [!primary] +>> > +>> > Tenga en cuenta que el nombre del archivo de red en nuestro ejemplo puede ser diferente del suyo. Por favor, ajuste los ejemplos con el nombre correcto. +>> > +>> +>> Se recomienda realizar una copia de seguridad del archivo de configuración correspondiente. En nuestro ejemplo, nuestro archivo de configuración se llama `cloud-init-eno1.nmconnection`: +>> +>> ```bash +>> sudo cp -r /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak +>> ``` +>> +>> Si comete algún error, puede volver atrás con los siguientes comandos: +>> +>> ```bash +>> sudo rm -f /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> sudo cp /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> ``` +>> +>> 2\. Editar el archivo de configuración +>> +>> > [!primary] +>> > Tenga en cuenta que el nombre del archivo de red en nuestro ejemplo puede ser diferente del suyo. Adapte los comandos a su nombre de archivo. +>> > +>> +>> Para obtener el nombre de la interfaz de red y editar el archivo de red adecuado, ejecute uno de los siguientes comandos: +>> +>> ```sh +>> ip a +>> ``` +>> +>> ```sh +>> nmcli connection show +>> ``` +>> +>> No modifique las líneas existentes en el fichero de configuración, añada su Additional IP en el fichero como sigue, sustituyendo `ADDITIONAL_IP/32` por sus propios valores: +>> +>> ```bash +>> sudo nano /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> ``` +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=ADDITIONAL_IP/32 +>> ``` +>> +>> Si tiene dos direcciones Additional IP que configurar, la configuración debería ser similar a la siguiente: +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=ADDITIONAL_IP1/32 +>> address2=ADDITIONAL_IP2/32 +>> ``` +>> +>> /// details | **Ejemplo** +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=203.0.113.1/32 +>> ``` +>> /// +>> +>> 3\. Reiniciar la interfaz +>> +>> A continuación, reinicie la interfaz: +>> +>> ```sh +>> sudo systemctl restart NetworkManager +>> ``` +>> +> Debian 12 y Ubuntu 20.04+ +>> **Debain 12, Ubuntu 20.04 y versiones posteriores** +>> +>> Por defecto, los ficheros de configuración se encuentran en el directorio `/etc/netplan`. +>> +>> El mejor enfoque consiste en crear un archivo de configuración independiente para configurar las direcciones Additional IP. Esto facilita el retroceso en caso de error. +>> +>> 1\. Determinar la interfaz +>> +>> ```sh +>> ip a +>> ``` +>> +>> Anote el nombre de la interfaz (la interfaz en la que está configurada la dirección IP principal del servidor). +>> +>> 2\. Crear el archivo de configuración +>> +>> A continuación, cree un archivo de configuración con la extensión `.yaml`. En nuestro ejemplo, nuestro archivo se llama `51-cloud-init.yaml` +>> +>> ```sh +>> sudo nano /etc/netplan/51-cloud-init.yaml +>> ``` +>> +>> A continuación, edite el fichero con el siguiente contenido, sustituyendo `INTERFACE_NAME` y `ADDITIONAL_IP` por sus propios valores: +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> INTERFACE_NAME: +>> dhcp4: true +>> addresses: +>> - ADDITIONAL_IP/32 +>> ``` +>> +>> Si tiene dos direcciones Additional IP que configurar, el archivo de configuración debería tener el siguiente aspecto: +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> INTERFACE_NAME: +>> dhcp4: true +>> addresses: +>> - ADDITIONAL_IP1/32 +>> - ADDITIONAL_IP2/32 +>> ``` +>> +>> > [!warning] +>> > +>> > Es importante mantener la alineación de cada elemento de este archivo, como se muestra en el ejemplo anterior. No utilice el tabulador para crear el espacio. Sólo es necesaria la tecla de espacio. +>> > +>> +>>/// details | **Ejemplo** +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> eth0: +>> dhcp4: true +>> addresses: +>> - 203.0.113.1/32 +>> ``` +>> /// +>> +>> Guarde y cierre el archivo. Puede probar la configuración con el siguiente comando: +>> +>> ```sh +>> sudo netplan try +>> ``` +>> +>> 3\. Aplicar la configuración +>> +>> Por último, reinicie la interfaz con el siguiente comando: +>> +>> ```sh +>> sudo netplan apply +>> ``` +>> +>> > [!primary] +>> > Al utilizar el comando `netplan try`, es posible que el sistema envíe un mensaje de advertencia como `Permissions for /etc/netplan/xx-cloud-init.yaml are too open. Netplan configuration should NOT be accessible by others`. Simplemente significa que el archivo no tiene permisos restrictivos. Esto no afecta a la configuración de su Additional IP. Para obtener más información sobre los permisos de archivo, consulte la [documentación oficial de ubuntu](https://help.ubuntu.com/community/FilePermissions). +>> > +>> +> AlmaLinux / Rocky Linux +>> **AlmaLinux (8 & 9), Rocky Linux (8 & 9)** +>> +>> El archivo de configuración principal se encuentra en `/etc/sysconfig/network-scripts/`. En nuestro ejemplo, se denomina `ifcfg-eth0`. Antes de realizar cualquier cambio, compruebe el nombre de archivo real en esta carpeta. +>> +>> Para cada Additional IP que vaya a configurar, crearemos un fichero de configuración independiente con los siguientes parámetros: `ifcfg-NETWORK_INTERFACE:ID`. Donde `NETWORK_INTERFACE` representa la interfaz física y `ID` es la interfaz de red virtual o el alias ethernet que empieza por un valor de 0. Por ejemplo, para nuestra interfaz llamada `eth0`, el primer alias es `eth0:0`, el segundo alias es `eth0:1`, etc... +>> +>> 1\. Crear una copia de seguridad del archivo de configuración +>> +>> ```sh +>> ip a +>> ``` +>> +>> Anote el nombre de la interfaz (el nombre en el que está configurada la dirección IP principal del servidor). +>> +>> 2\. Crear el archivo de configuración +>> +>> En primer lugar, cree el archivo de configuración. Sustituya `NETWORK_INTERFACE:ID` por sus propios valores. +>> +>> ```sh +>> sudo nano /etc/sysconfig/network-scripts/ifcfg-NETWORK_INTERFACE:ID +>> ``` +>> +>> A continuación, edite el archivo con el siguiente contenido, sustituyendo `NETWORK_INTERFACE:ID` y `ADDITIONAL_IP` por sus propios valores: +>> +>> ```console +>> DEVICE=NETWORK_INTERFACE:ID +>> ONBOOT=yes +>> BOOTPROTO=none # For CentOS use "static" +>> IPADDR=ADDITIONAL_IP +>> NETMASK=255.255.255.255 +>> BROADCAST=ADDITIONAL_IP +>> ``` +>> +>> /// details | **Ejemplo** +>> +>> ```console +>> DEVICE=eth0:0 +>> ONBOOT=yes +>> BOOTPROTO=none # For CentOS use "static" +>> IPADDR=203.0.113.1 +>> NETMASK=255.255.255.255 +>> BROADCAST=203.0.113.1 +>> ``` +>> /// +>> +>> 3\. Reinicio de la interfaz +>> +>> A continuación, reinicie la interfaz: +>> +>> ```sh +>> sudo systemctl restart NetworkManager +>> ``` +>> +> cPanel +>> **cPanel** +>> +>> 1\. Acceder a la sección Gestión IP de WHM +>> +>> En el área de cliente WHM, haga clic en `IP Functions`{.action} y seleccione `Add a New IP Address`{.action} en el menú de la izquierda. +>> +>> ![Añadir una nueva dirección IP](images/Cpanel-1.png){.thumbnail} +>> +>> 2\. Añadir la información de las Direcciones IP +>> +>> Introduzca su dirección IP adicional como "xxx.xxx.xxx.xxx" en el campo "New IP or IP range to add". +>> +>> Seleccione `255.255.255.255` como máscara de subred y haga clic en `Submit`{.action}. +>> +>> ![Introduzca nueva información sobre la nueva dirección IP](images/Cpanel-2024.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Atención: Si tiene varias IP que configurar en un mismo bloque y las añade todas al mismo tiempo, el sistema WHM le obligará a utilizar la máscara de subred `255.255.255.0`. No es recomendable utilizar esta configuración. Es necesario añadir cada IP individualmente para poder utilizar la máscara de subred adecuada `255.255.255.255`. +>> > +>> +>> 3\. Comprobar la configuración IP actual +>> +>> En la sección `IP Functions`{.action}, haga clic en `Show or Delete Current IP Addresses`{.action} para comprobar que la dirección Aditional IP se ha añadido correctamente. +>> +>> ![check configurado por IP](images/Cpanel-2024-1.png){.thumbnail} +>> +> Windows Server +>> **Windows Server** +>> +>> Los servidores Windows suelen usar DHCP para la configuración de red. Si ya ha configurado una Additional IP, o si ha cambiado su configuración a IP fija, vaya directamente al siguiente paso. +>> +>> De lo contrario, debe cambiar primero la configuración de red de DHCP a configuración de IP fija. +>> +>> Abra la consola de comandos **CMD** o **PowerShell** e introduzca el siguiente comando: +>> +>> ```powershell +>> ipconfig +>> ``` +>> +>> La respuesta tendrá el formato de la imagen: +>> +>> ![Respuesta del comando ipconfig](images/ipconfig.png){.thumbnail} +>> +>> En ella puede consultar su IPv4, la máscara de subred, la puerta de enlace predeterminada y el nombre de la tarjeta de red. +>> +>> En nuestro ejemplo, la dirección IP del servidor es **192.0.2.28**. +>> +>> Los siguientes pasos pueden realizarse, bien mediante línea comandos, o bien a través de la interfaz gráfica. +>> +>> **Mediante línea de comandos (recomendado)** +>> +>> En los comandos indicados más abajo, sustituya los siguientes valores: +>> +>> |Comando|Valor| +>> |---|---| +>> |NETWORK_ADAPTER| Nombre de la tarjeta de red (en el ejemplo, «Ethernet 2»)| +>> |IP_ADDRESS| Dirección IP del servidor (en el ejemplo, 192.0.2.28)| +>> |SUBNET_MASK| Máscara de subred (en el ejemplo, 255.255.255.0)| +>> |GATEWAY| Puerta de enlace predeterminada (en el ejemplo, 192.0.2.254)| +>> |ADDITIONAL_IP| Dirección Additional IP que quiera añadir| +>> +>> > [!warning] +>> > +>> > Atención: Si introduce información incorrecta, no será posible acceder al servidor. En ese caso, deberá realizar las correcciones oportunas en modo [WinRescue](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) o a través del [IPMI](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). +>> > +>> +>> Realice las acciones que se indican a continuación en la consola de comandos. +>> +>> Cambie a IP fija. +>> +>> ```powershell +>> netsh interface ipv4 set address name="NETWORK_ADAPTER" static IP_ADDRESS SUBNET_MASK GATEWAY +>> ``` +>> +>> Indique el servidor DNS. +>> +>> ```powershell +>> netsh interface ipv4 set dns name="NETWORK_ADAPTER" static 213.186.33.99 +>> ``` +>> +>> Añada una Additional IP. +>> +>> ```powershell +>> netsh interface ipv4 add address "NETWORK_ADAPTER" ADDITIONAL_IP 255.255.255.255 +>> ``` +>> +>> Su Additional IP ya estará activa. +>> +>> /// details | **A través de la interfaz gráfica** +>> +>> 1\. Vaya a `Start`{.action} > `Control Panel`{.action} > `Network and Internet`{.action} > `Network and Sharing Centre`{.action}. En el menú izquierdo, seleccione `Change Adapter Settings`{.action}. +>> +>> 2\. Haga clic derecho en su conexión de red, en el ejemplo `Ethernet 2`{.action}. +>> +>> 3\. Haga clic en `Properties`{.action}. +>> +>> 4\. Seleccione `Internet Protocol Version 4 (TCP/IPv4)`{.action} y, a continuación, haga clic en el botón `Properties`{.action}. +>> +>> 5\. Marque la opción `Use the following IP address`{.action} e introduzca la IP principal del servidor, la máscara de subred y la puerta de enlace predeterminada obtenidas anteriormente con el comando `ipconfig`. En **Preferred DNS Server**, introduzca **213.186.33.99**. +>> +>> ![Propiedades del protocolo de internet versión 4 (TCP/IPv4)](images/configure-main-ip.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Atención: Si introduce información incorrecta, no será posible acceder al servidor. En ese caso, deberá realizar las correcciones oportunas en modo [WinRescue](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) o a través del [IPMI](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). +>> > +>> +>> A continuación, haga clic en `Advanced`{.action} (todavía en las `TCP/IP Settings`{.action}). +>> +>> ![Propiedades del protocolo de internet versión 4 (TCP/IPv4)](images/configure-main-ip-1.png){.thumbnail} +>> +>> En la sección **IP Address**, haga clic en `Add`{.action}. +>> +>> ![Opciones avanzadas TCP/IPv4](images/add-additional-ip.png){.thumbnail} +>> +>> Introduzca ahí su Additional IP y la máscara de subred **255.255.255.255**. Haga clic en `Add`{.action}. +>> +>> ![Dirección TCP/IP](images/configure-additional-ip.png){.thumbnail} +>> +>> Haga clic en `OK`{.action} para validar la configuración. +>> +>> Su Additional IP ya está operativa. Para comprobar la configuración, ejecute el siguiente comando: +>> +>> ```powershell +>> ipconfig +>> ``` +>> +>> Esto le dará un resultado similar al siguiente ejemplo: +>> +>> ![Final configuration](images/final-ip-configuration.png){.thumbnail} +>> +> Plesk +>> **Plesk** +>> +>> 1\. Acceder a la gestión de IP de Plesk +>> +>> En el panel de configuración de Plesk, seleccione `Tools & Settings`{.action} en la columna izquierda. +>> +>> ![acceso a la gestión de las direcciones IP](images/pleskip1.png){.thumbnail} +>> +>> Haga clic en `IP Addresses`{.action} bajo **Tools & Settings**. +>> +>> 2\. Añadir la información IP adicional +>> +>> En esta sección, haga clic en el botón `Add IP Address`{.action}. +>> +>> ![añadir información IP](images/Plesk-2024.png){.thumbnail} +>> +>> Introduzca su dirección Additional IP como `xxx.xxx.xxx.xxx/32` en el campo "IP address and subnet mask" y haga clic en `OK`{.action}. +>> +>> ![añadir información IP](images/Plesk-2024-1.png){.thumbnail} +>> +>> 3\. comprobar la configuración IP actual +>> +>> En la sección "IP Addresses", compruebe que la dirección Additional IP se haya añadido correctamente. +>> +>> ![configuración IP actual](images/Plesk-2024-2.png){.thumbnail} +>> #### Resolución de fallos diff --git a/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.fr-ca.md b/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.fr-ca.md index 564bef34f46..4def527ee91 100644 --- a/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.fr-ca.md +++ b/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.fr-ca.md @@ -1,9 +1,23 @@ --- title: 'Configurer son adresse IP en alias' excerpt: 'Découvrez comment ajouter des Additional IP à votre configuration' -updated: 2025-07-22 +updated: 2025-11-12 --- + + > [!primary] > Cet article concerne la configuration d'adresses Additional IPv4 sur une interface publique. Vous pouvez également configurer des adresses IPv6 sur vos serveurs dédiés en utilisant [ce guide](/pages/bare_metal_cloud/dedicated_servers/network_ipv6). > @@ -42,9 +56,9 @@ L'alias d'IP (*IP aliasing* en anglais) est une configuration spéciale du rése Les sections suivantes contiennent les configurations des distributions que nous proposons actuellement et les distributions/systèmes d’exploitation les plus couramment utilisés. La première étape consiste toujours à vous connecter à votre serveur en SSH ou via une session de connexion GUI (RDP pour un serveur Windows). -> [!primary] -> ->Si vous souhaitez utiliser une distribution récente, la procédure adéquate pour configurer votre interface réseau peut nécessiter des adaptations. Si vous rencontrez des difficultés, nous vous recommandons de consulter la documentation relative à votre système d’exploitation. +> [!primary] +> Si vous souhaitez utiliser une distribution récente, la procédure adéquate pour configurer votre interface réseau peut nécessiter des adaptations. Si vous rencontrez des difficultés, nous vous recommandons de consulter la documentation relative à votre système d’exploitation. +> **Veuillez prendre note de la terminologie suivante qui sera utilisée dans les exemples de code et les instructions des sections du guide ci-dessous :** @@ -56,485 +70,509 @@ Les sections suivantes contiennent les configurations des distributions que nous Dans les exemples ci-dessous, nous utiliserons l'éditeur de texte `nano`. Avec certains systèmes d'exploitation, vous devrez d'abord l'installer avant de l'utiliser. Si c'est le cas, vous serez invité à le faire. Vous pouvez bien sûr utiliser l'éditeur de texte de votre choix. -### Debian 11 - -Par défaut, le fichier de configuration est situé dans `/etc/network/interfaces.d/`. Il est recommandé de commencer par sauvegarder le fichier de configuration correspondant. - -#### Étape 1 : créer une sauvegarde - -Dans notre exemple, notre fichier s'appelle `50-cloud-init`, nous copions donc le fichier `50-cloud-init` en utilisant la commande suivante : - -```bash -sudo cp /etc/network/interfaces.d/50-cloud-init /etc/network/interfaces.d/50-cloud-init.bak -``` - -En cas d'erreur, vous pourrez alors revenir en arrière grâce aux commandes ci-dessous : - -```bash -sudo rm -f /etc/network/interfaces.d/50-cloud-init -sudo cp /etc/network/interfaces.d/50-cloud-init.bak /etc/network/interfaces.d/50-cloud-init -``` - -#### Étape 2 : éditer le fichier de configuration - -> [!primary] -> -> Les noms donnés aux interfaces réseau dans ce guide peuvent différer des vôtres. Veuillez adapter les manipulations en conséquence. - -Vous pouvez désormais modifier le fichier de configuration : - -```bash -sudo nano /etc/network/interfaces.d/50-cloud-init -``` - -Vous devez ensuite ajouter une interface virtuelle ou un alias ethernet. Dans notre exemple, notre interface s'appelle `eth0`, donc notre alias est `eth0:0`. Faites ceci pour chaque adresse Additional IP que vous souhaitez configurer. - -Ne modifiez pas les lignes existantes dans le fichier de configuration, ajoutez simplement votre Additional IP au fichier comme indiqué ci-dessous, en remplaçant `ADDITIONAL_IP/32` ainsi que l'interface virtuelle (si votre serveur n'utilise pas **eth0:0**) par vos propres valeurs : - -```console -auto eth0:0 -iface eth0:0 inet static -address ADDITIONAL_IP -netmask 255.255.255.255 -``` - -Vous pouvez également configurer votre Additional IP en ajoutant les lignes suivantes dans le fichier de configuration : - -```console -post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP netmask 255.255.255.255 broadcast ADDITIONAL_IP -pre-down /sbin/ifconfig eth0:0 down -``` - -Avec la configuration ci-dessus, l'interface virtuelle est activée ou désactivée chaque fois que l'interface `eth0` est activée ou désactivée. - -Si vous avez deux Additional IP à configurer, le fichier `/etc/network/interfaces.d/50-cloud-init` doit ressembler à ceci : - -```console -auto eth0 -iface eth0 inet dhcp - -auto eth0:0 -iface eth0:0 inet static -address ADDITIONAL_IP1 -netmask 255.255.255.255 - -auto eth0:1 -iface eth0:1 inet static -address ADDITIONAL_IP2 -netmask 255.255.255.255 -``` - -Ou à cela : - -```console -auto eth0 -iface eth0 inet dhcp - -# IP 1 -post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP1 netmask 255.255.255.255 broadcast ADDITIONAL_IP1 -pre-down /sbin/ifconfig eth0:0 down - -# IP 2 -post-up /sbin/ifconfig eth0:1 ADDITIONAL_IP2 netmask 255.255.255.255 broadcast ADDITIONAL_IP2 -pre-down /sbin/ifconfig eth0:1 down -``` - -Exemple de configuration : - -```console -auto eth0 -iface eth0 inet dhcp - -auto eth0:0 -iface eth0:0 inet static -address 203.0.113.1 -netmask 255.255.255.255 -``` - -Ou : - -```console -auto eth0 -iface eth0 inet dhcp - -# IP 1 -post-up /sbin/ifconfig eth0:0 203.0.113.1 netmask 255.255.255.255 broadcast 203.0.113.1 -pre-down /sbin/ifconfig eth0:0 down -``` - -#### Étape 3 : redémarrer l’interface - -Pour redémarrer l'interface, utilisez la commande suivante : - -```bash -sudo /etc/init.d/networking restart -``` - -### Fedora 39 et versions ultérieures - -Fedora utilise dorénavant des fichiers clés (*keyfiles*). -Fedora utilisait auparavant des profils réseau stockés par NetworkManager au format ifcfg dans le répertoire `/etc/sysconfig/network-scripts/`.
-Le ifcfg étant à présent déprécié, NetworkManager ne crée plus par défaut les nouveaux profils dans ce format. Le fichier de configuration se trouve à présent dans `/etc/NetworkManager/system-connections/`. - -#### Étape 1 : créer une sauvegarde - -> [!primary] -> -> Notez que le nom du fichier réseau dans notre exemple peut différer du vôtre. Veuillez adapter les exemples avec le nom approprié. -> - -Il est recommandé de commencer par sauvegarder le fichier de configuration correspondant. Dans notre exemple, notre fichier de configuration s'appelle `cloud-init-eno1.nmconnection` : - -```bash -sudo cp -r /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak -``` -En cas d'erreur, vous pourrez alors revenir en arrière grâce aux commandes ci-dessous : - -```bash -sudo rm -f /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -sudo cp /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -``` - -#### Étape 2 : éditer le fichier de configuration - -> [!primary] -> Veuillez noter que le nom du fichier réseau dans notre exemple peut être différent du vôtre. Veuillez adapter les commandes à votre nom de fichier. -> - -Pour obtenir le nom de votre interface réseau afin d'éditer le fichier réseau approprié, vous pouvez exécuter l'une des commandes suivantes : - -```bash -ip a -``` - -```bash -nmcli connection show -``` - -Ne modifiez pas les lignes existantes dans le fichier de configuration, ajoutez votre Additional IP dans le fichier comme suit, en remplaçant `ADDITIONAL_IP/32` par vos propres valeurs : - -```bash -sudo nano /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -``` - -```console -[ipv4] -method=auto -may-fail=false -address1=ADDITIONAL_IP/32 -``` -Si vous avez deux adresses Additional IP à configurer, la configuration devrait ressembler à ceci : - -```console -[ipv4] -method=auto -may-fail=false -address1=ADDITIONAL_IP1/32 -address2=ADDITIONAL_IP2/32 -``` - -Exemple de configuration : - -```console -[ipv4] -method=auto -may-fail=false -address1=203.0.113.1/32 -``` - -#### Étape 3 : redémarrer l'interface - -Vous devez maintenant redémarrer votre interface : - -```bash -sudo systemctl restart NetworkManager -``` - -### Debian 12, Ubuntu 20.04 et versions suivantes - -Par défaut, les fichiers de configuration sont situés dans le répertoire `/etc/netplan`. - -La meilleure approche consiste à créer un fichier de configuration séparé pour configurer les adresses Additional IP. Cela permet de revenir facilement en arrière en cas d'erreur. - -#### Étape 1 : déterminer l’interface - -```bash -ip a -``` - -Notez le nom de l'interface (celle sur laquelle est configurée l'adresse IP principale de votre serveur). - -#### Étape 2 : créer le fichier de configuration - -Ensuite, créez un fichier de configuration avec une extension `.yaml`. Dans notre exemple, notre fichier s'appelle `51-cloud-init.yaml`. - -```bash -sudo nano /etc/netplan/51-cloud-init.yaml -``` - -Ensuite, éditez le fichier avec le contenu ci-dessous, en remplaçant `INTERFACE_NAME` et `ADDITIONAL_IP` par vos propres valeurs : - -```yaml -network: - version: 2 - ethernets: - INTERFACE_NAME: - dhcp4: true - addresses: - - ADDITIONAL_IP/32 -``` - -Si vous avez deux adresses Additional IP à configurer, le fichier de configuration devrait ressembler à ceci : - -```yaml -network: - version: 2 - ethernets: - INTERFACE_NAME: - dhcp4: true - addresses: - - ADDITIONAL_IP1/32 - - ADDITIONAL_IP2/32 -``` - -> [!warning] -> -> Il est important de respecter l’alignement de chaque élément de ce fichier, tel que représenté dans l’exemple ci-dessus. N’utilisez pas la touche de tabulation pour créer votre espacement. Seule la touche espace est nécessaire. -> - -Exemple de configuration : - -```yaml -network: - version: 2 - ethernets: - eth0: - dhcp4: true - addresses: - - 203.0.113.1/32 -``` - -Enregistrez et fermez le fichier. Vous pouvez tester la configuration avec la commande suivante : - -```bash -sudo netplan try -``` - -#### Étape 3 : appliquer la configuration - -Si elle est correcte, appliquez-la à l'aide de la commande suivante : - -```bash -sudo netplan apply -``` - -> [!primary] -> Lors de l'utilisation de la commande `netplan try`, il est possible que le système renvoie un message d'avertissement tel que `Permissions for /etc/netplan/xx-cloud-init.yaml are too open. Netplan configuration should NOT be accessible by others`. Cela signifie simplement que le fichier n'a pas de permissions restrictives. Cela n'affecte pas la configuration de votre Additional IP. Pour plus d'informations sur les permissions de fichiers, consultez la [documentation officielle d'ubuntu](https://help.ubuntu.com/community/FilePermissions). - -### AlmaLinux (8 & 9), Rocky Linux (8 & 9) - -Le fichier de configuration principal se trouve dans `/etc/sysconfig/network-scripts/`. Dans notre exemple, il est appelé `ifcfg-eth0`. Avant d'apporter des modifications, vérifiez le nom de fichier réel dans ce dossier. - -Pour chaque Additional IP à configurer, nous créons un fichier de configuration séparé avec les paramètres suivants : `ifcfg-NETWORK_INTERFACE:ID`. Où `NETWORK_INTERFACE` représente l'interface physique et `ID` est l'interface réseau virtuelle ou l'alias ethernet commençant par une valeur de 0. Par exemple, pour notre interface nommée `eth0`, le premier alias est `eth0:0`, le second alias est `eth0:1`, etc... - -#### Étape 1 : déterminer l'interface - -```bash -ip a -``` - -Notez le nom de l'interface (celle sur laquelle l'adresse IP principale de votre serveur est configurée). - -#### Étape 2 : créer le fichier de configuration - -Commencez par créer le fichier de configuration. Remplacez `NETWORK_INTERFACE:ID` par vos propres valeurs. - -```bash -sudo nano /etc/sysconfig/network-scripts/ifcfg-NETWORK_INTERFACE:ID -``` - -Ensuite, modifiez le fichier avec le contenu ci-dessous, en remplaçant `NETWORK_INTERFACE:ID` et `ADDITIONAL_IP` par vos propres valeurs : - -```console -DEVICE=NETWORK_INTERFACE:ID -ONBOOT=yes -BOOTPROTO=none # Pour CentOS utilisez "static" -IPADDR=ADDITIONAL_IP -NETMASK=255.255.255.255 -BROADCAST=ADDITIONAL_IP -``` - -Exemple de configuration : - -```console -DEVICE=eth0:0 -ONBOOT=yes -BOOTPROTO=none # Pour CentOS utilisez "static" -IPADDR=203.0.113.1 -NETMASK=255.255.255.255 -BROADCAST=203.0.113.1 -``` - -#### Étape 3 : redémarrer l'interface - -Vous devez maintenant redémarrer votre interface : - -```bash -sudo systemctl restart NetworkManager -``` - -### cPanel - -#### Étape 1 : accéder à la section Gestion IP de WHM - -Dans l'espace client WHM, cliquez sur `IP Functions`{.action} et sélectionnez `Add a New IP Address`{.action} dans le menu de gauche. - -![Ajouter une nouvelle adresse IP](images/Cpanel-1.png){.thumbnail} - -#### Étape 2 : Ajouter les informations des Additional IP - -Renseignez votre adresse Additional IP sous la forme « xxx.xxx.xxx.xxx » dans le champ « New IP or IP range to add ». - -Sélectionnez `255.255.255.255` comme masque de sous-réseau puis cliquez sur `Submit`{.action}. - -![renseigner de nouvelles informations sur la nouvelle adresse IP](images/Cpanel-2024.png){.thumbnail} - -> [!warning] -> -> Attention, si vous avez plusieurs IP à configurer sur un même bloc et que vous les ajoutez toutes en même temps, le système WHM vous forcera à utiliser le masque de sous-réseau `255.255.255.0`. Il n'est pas recommandé d'utiliser cette configuration, il faut ajouter chaque IP individuellement pour pouvoir utiliser le masque de sous-réseau approprié `255.255.255.255`. -> - -#### Étape 3 : Vérifier la configuration IP actuelle - -De retour dans la section `IP Functions`{.action}, cliquez sur `Show or Delete Current IP Addresses`{.action} pour vérifier que l'adresse Additional IP a été correctement ajoutée. - -![check configured IP](images/Cpanel-2024-1.png){.thumbnail} - -### Windows Servers - -Les serveurs sous Windows sont souvent en DHCP au niveau de la configuration réseau. Si vous avez déjà paramétré une Additional IP ou passé votre configuration en IP fixe, rendez-vous directement à l’étape suivante. - -Sinon, vous devez d’abord passer d’une configuration DHCP au niveau du réseau à une configuration IP fixe. - -Ouvrez l’invite de commande `cmd`{.action} ou `powershell`{.action}, puis tapez la commande suivante : - -```powershell -ipconfig -``` - -Cela vous donnera un résultat similaire à l’exemple suivant : - -![Result of "ipconfig" command](images/ipconfig.png){.thumbnail} - -Identifiez et notez votre adresse IPv4, votre masque de sous-réseau, votre passerelle par défaut et le nom du contrôleur d'interface réseau (carte réseau). - -Dans notre exemple, l’adresse IP du serveur est **192.0.2.28**. - -Vous pouvez effectuer les prochaines étapes via des lignes de commande ou l’interface graphique. - -#### En lignes de commande (recommandé) - -Dans les commandes ci-dessous, vous devez remplacer les informations suivantes : - -|Commande|Valeur| -|---|---| -|NETWORK_ADAPTER| Nom de la carte réseau (dans notre exemple : « Ethernet 2 »).| -|IP_ADDRESS| Adresse IP du serveur (dans notre exemple : « 192.0.2.28 »).| -|SUBNET_MASK| Masque de sous-réseau (dans notre exemple : « 255.255.255.0 »).| -|GATEWAY| Passerelle par défaut (dans notre exemple : « 192.0.2.254 »).| -|ADDITIONAL_IP| Adresse Additional IP que vous voulez ajouter.| - -> [!warning] +> [!success] +> Sélectionnez l'onglet correspondant à votre système d'exploitation. > -> Attention, le serveur ne sera plus accessible si vous entrez des informations incorrectes. Vous devrez alors effectuer les corrections en mode WinRescue ou via le KVM. -> - -Dans l’invite de commande : - -Passez en premier lieu en IP fixe : - -```powershell -netsh interface ipv4 set address name="NETWORK_ADAPTER" static IP_ADDRESS SUBNET_MASK GATEWAY -``` - -Définissez ensuite le serveur DNS : - -```powershell -netsh interface ipv4 set dns name="NETWORK_ADAPTER" static 213.186.33.99 -``` - -Puis ajoutez une adresse Additional IP : - -```powershell -netsh interface ipv4 add address "NETWORK_ADAPTER" ADDITIONAL_IP 255.255.255.255 -``` - -Votre Additional IP est désormais fonctionnelle. - -#### Via l’interface graphique d’utilisateur - -1. Allez dans le menu `Démarrer`{.action}, puis `Panneau de gestion`{.action}, `Réseau et Internet`{.action}, `Centre de réseau et Partage`{.action} et `Modifier les paramètres de la carte`{.action} dans la barre de gauche ; -2. Effectuez un clic droit sur votre connexion réseau, dans notre exemple `Ethernet 2`{.action} ; -3. Cliquez sur `Propriétés`{.action} ; -4. Sélectionnez `Protocole Internet Version 4 (TCP/IPv4)`{.action}, puis cliquez sur `Propriétés`{.action} ; -5. Cliquez sur `Utiliser l’adresse IP suivante`{.action} et renseignez l’IP principale de votre serveur, le masque sous-réseau et la passerelle par défaut obtenus grâce à la commande `ipconfig`{.action} ci-dessus. Dans la case « Serveur DNS Préféré », tapez « 213.186.33.99 ». - -![Propriétés Protocole Internet Version 4 (TCP/IPv4)](images/configure-main-ip.png){.thumbnail} - -> [!warning] -> -> Attention, le serveur ne sera plus accessible si vous entrez des informations incorrectes. Vous serez alors obligé d’effectuer les corrections en mode [WinRescue](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) ou via le [KVM](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). -> - -Ensuite, cliquez sur `Avancé`{.action} en étant toujours positionné dans les `Paramètres TCP/IP`{.action}. - -![Propriétés Protocole Internet Version 4 (TCP/IPv4)](images/configure-main-ip-1.png){.thumbnail} - -Dans la partie « Adresse IP », cliquez sur `Ajouter`{.action} : - -![Paramètres avancés TCP/IPv4](images/add-additional-ip.png){.thumbnail} - -Renseignez alors votre Additional IP et le masque de sous-réseau « **255.255.255.255** ». Cliquez sur `Ajouter`{.action}. - -![Adresses TCP/IP](images/configure-additional-ip.png){.thumbnail} - -Cliquez sur `OK`{.action} pour valider votre configuration. - -Votre Additional IP est désormais fonctionnelle, vous pouvez vérifier la configuration avec la commande suivante : - -```powershell -ipconfig -``` - -Cela vous donnera un résultat similaire à l’exemple suivant : - -![Final configuration](images/final-ip-configuration.png){.thumbnail} - -### Plesk - -#### Etape 1 : accéder à la section Gestion de Plesk IP - -Dans le panneau de configuration Plesk, choisissez `Outils et paramètres`{.action} dans la barre latérale gauche. - -![accès à la gestion des adresses IP](images/pleskip1.png){.thumbnail} - -Cliquez sur `Adresses IP`{.action} sous **Outils et ressources**. - -#### Etape 2 : ajouter les informations IP supplémentaires - -Dans cette section, cliquez sur le bouton `Add IP Address`{.action}. - -![ajouter des informations IP](images/Plesk-2024.png){.thumbnail} - -Entrez votre adresse Additional IP sous la forme `xxx.xxx.xxx.xxx/32` dans le champ « Adresse IP et masque de sous-réseau », puis cliquez sur `OK`{.action}. - -![ajouter des informations IP](images/Plesk-2024-1.png){.thumbnail} - -#### Etape 3 : vérifier la configuration IP actuelle - -Dans la section « Adresses IP », vérifiez que l'adresse Additional IP a été correctement ajoutée. -![configuration IP actuelle](images/Plesk-2024-2.png){.thumbnail} +> [!tabs] +> Debian 11 +>> **Debian 11** +>> +>> Par défaut, le fichier de configuration est situé dans `/etc/network/interfaces.d/`. Il est recommandé de commencer par sauvegarder le fichier de configuration correspondant. +>> +>> Étape 1 : créer une sauvegarde +>> +>> Dans notre exemple, notre fichier s'appelle `50-cloud-init`, nous copions donc le fichier `50-cloud-init` en utilisant la commande suivante : +>> +>> ```bash +>> sudo cp /etc/network/interfaces.d/50-cloud-init /etc/network/interfaces.d/50-cloud-init.bak +>> ``` +>> +>> En cas d'erreur, vous pourrez alors revenir en arrière grâce aux commandes ci-dessous : +>> +>> ```bash +>> sudo rm -f /etc/network/interfaces.d/50-cloud-init +>> sudo cp /etc/network/interfaces.d/50-cloud-init.bak /etc/network/interfaces.d/50-cloud-init +>> ``` +>> +>> Étape 2 : éditer le fichier de configuration +>> +>> > [!primary] +>> > +>> > Les noms donnés aux interfaces réseau dans ce guide peuvent différer des vôtres. Veuillez adapter les manipulations en conséquence. +>> +>> Vous pouvez désormais modifier le fichier de configuration : +>> +>> ```bash +>> sudo nano /etc/network/interfaces.d/50-cloud-init +>> ``` +>> +>> Vous devez ensuite ajouter une interface virtuelle ou un alias ethernet. Dans notre exemple, notre interface s'appelle `eth0`, donc notre alias est `eth0:0`. Faites ceci pour chaque adresse Additional IP que vous souhaitez configurer. +>> +>> Ne modifiez pas les lignes existantes dans le fichier de configuration, ajoutez simplement votre Additional IP au fichier comme indiqué ci-dessous, en remplaçant `ADDITIONAL_IP/32` ainsi que l'interface virtuelle (si votre serveur n'utilise pas **eth0:0**) par vos propres valeurs : +>> +>> ```console +>> auto eth0:0 +>> iface eth0:0 inet static +>> address ADDITIONAL_IP +>> netmask 255.255.255.255 +>> ``` +>> +>> Vous pouvez également configurer votre Additional IP en ajoutant les lignes suivantes dans le fichier de configuration : +>> +>> ```console +>> post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP netmask 255.255.255.255 broadcast ADDITIONAL_IP +>> pre-down /sbin/ifconfig eth0:0 down +>> ``` +>> +>> Avec la configuration ci-dessus, l'interface virtuelle est activée ou désactivée chaque fois que l'interface `eth0` est activée ou désactivée. +>> +>> Si vous avez deux Additional IP à configurer, le fichier `/etc/network/interfaces.d/50-cloud-init` doit ressembler à ceci : +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> auto eth0:0 +>> iface eth0:0 inet static +>> address ADDITIONAL_IP1 +>> netmask 255.255.255.255 +>> +>> auto eth0:1 +>> iface eth0:1 inet static +>> address ADDITIONAL_IP2 +>> netmask 255.255.255.255 +>> ``` +>> +>> Ou à cela : +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> # IP 1 +>> post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP1 netmask 255.255.255.255 broadcast ADDITIONAL_IP1 +>> pre-down /sbin/ifconfig eth0:0 down +>> +>> # IP 2 +>> post-up /sbin/ifconfig eth0:1 ADDITIONAL_IP2 netmask 255.255.255.255 broadcast ADDITIONAL_IP2 +>> pre-down /sbin/ifconfig eth0:1 down +>> ``` +>> +>> /// details | **Exemple de configuration** +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> auto eth0:0 +>> iface eth0:0 inet static +>> address 203.0.113.1 +>> netmask 255.255.255.255 +>> ``` +>> +>> Ou : +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> # IP 1 +>> post-up /sbin/ifconfig eth0:0 203.0.113.1 netmask 255.255.255.255 broadcast 203.0.113.1 +>> pre-down /sbin/ifconfig eth0:0 down +>> ``` +>> /// +>> +>> Étape 3 : redémarrer l’interface +>> +>> Pour redémarrer l'interface, utilisez la commande suivante : +>> +>> ```bash +>> sudo /etc/init.d/networking restart +>> ``` +>> +> Fedora 41+ +>> **Fedora 41 et versions ultérieures** +>> +>> Fedora utilise dorénavant des fichiers clés (*keyfiles*). +>> Fedora utilisait auparavant des profils réseau stockés par NetworkManager au format ifcfg dans le répertoire `/etc/sysconfig/network-scripts/`.
+>> Le ifcfg étant à présent déprécié, NetworkManager ne crée plus par défaut les nouveaux profils dans ce format. Le fichier de configuration se trouve à présent dans `/etc/NetworkManager/system-connections/`. +>> +>> Étape 1 : créer une sauvegarde +>> +>> > [!primary] +>> > +>> > Notez que le nom du fichier réseau dans notre exemple peut différer du vôtre. Veuillez adapter les exemples avec le nom approprié. +>> > +>> +>> Il est recommandé de commencer par sauvegarder le fichier de configuration correspondant. Dans notre exemple, notre fichier de configuration s'appelle `cloud-init-eno1.nmconnection` : +>> +>> ```bash +>> sudo cp -r /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak +>> ``` +>> +>> En cas d'erreur, vous pourrez alors revenir en arrière grâce aux commandes ci-dessous : +>> +>> ```bash +>> sudo rm -f /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> sudo cp /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> ``` +>> +>> Étape 2 : éditer le fichier de configuration +>> +>> > [!primary] +>> > Veuillez noter que le nom du fichier réseau dans notre exemple peut être différent du vôtre. Veuillez adapter les commandes à votre nom de fichier. +>> > +>> +>> Pour obtenir le nom de votre interface réseau afin d'éditer le fichier réseau approprié, vous pouvez exécuter l'une des commandes suivantes : +>> +>> ```bash +>> ip a +>> ``` +>> +>> ```bash +>> nmcli connection show +>> ``` +>> +>> Ne modifiez pas les lignes existantes dans le fichier de configuration, ajoutez votre Additional IP dans le fichier comme suit, en remplaçant `ADDITIONAL_IP/32` par vos propres valeurs : +>> +>> ```bash +>> sudo nano /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> ``` +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=ADDITIONAL_IP/32 +>> ``` +>> +>> Si vous avez deux adresses Additional IP à configurer, la configuration devrait ressembler à ceci : +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=ADDITIONAL_IP1/32 +>> address2=ADDITIONAL_IP2/32 +>> ``` +>> +>> /// details | **Exemple de configuration** +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=203.0.113.1/32 +>> ``` +>> /// +>> +>> Étape 3 : redémarrer l'interface +>> +>> Vous devez maintenant redémarrer votre interface : +>> +>> ```bash +>> sudo systemctl restart NetworkManager +>> ``` +>> +> Debian 12 et Ubuntu 20.04+ +>> **Debian 12, Ubuntu 20.04 et versions suivantes** +>> +>> Par défaut, les fichiers de configuration sont situés dans le répertoire `/etc/netplan`. +>> +>> La meilleure approche consiste à créer un fichier de configuration séparé pour configurer les adresses Additional IP. Cela permet de revenir facilement en arrière en cas d'erreur. +>> +>> Étape 1 : déterminer l’interface +>> +>> ```bash +>> ip a +>> ``` +>> +>> Notez le nom de l'interface (celle sur laquelle est configurée l'adresse IP principale de votre serveur). +>> +>> Étape 2 : créer le fichier de configuration +>> +>> Ensuite, créez un fichier de configuration avec une extension `.yaml`. Dans notre exemple, notre fichier s'appelle `51-cloud-init.yaml`. +>> +>> ```bash +>> sudo nano /etc/netplan/51-cloud-init.yaml +>> ``` +>> +>> Ensuite, éditez le fichier avec le contenu ci-dessous, en remplaçant `INTERFACE_NAME` et `ADDITIONAL_IP` par vos propres valeurs : +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> INTERFACE_NAME: +>> dhcp4: true +>> addresses: +>> - ADDITIONAL_IP/32 +>> ``` +>> +>> Si vous avez deux adresses Additional IP à configurer, le fichier de configuration devrait ressembler à ceci : +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> INTERFACE_NAME: +>> dhcp4: true +>> addresses: +>> - ADDITIONAL_IP1/32 +>> - ADDITIONAL_IP2/32 +>> ``` +>> +>> > [!warning] +>> > +>> > Il est important de respecter l’alignement de chaque élément de ce fichier, tel que représenté dans l’exemple ci-dessus. N’utilisez pas la touche de tabulation pour créer votre espacement. Seule la touche espace est nécessaire. +>> > +>> +>> /// details | **Exemple de configuration** +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> eth0: +>> dhcp4: true +>> addresses: +>> - 203.0.113.1/32 +>> ``` +>> /// +>> +>> Enregistrez et fermez le fichier. Vous pouvez tester la configuration avec la commande suivante : +>> +>> ```bash +>> sudo netplan try +>> ``` +>> +>> Étape 3 : appliquer la configuration +>> +>> Si elle est correcte, appliquez-la à l'aide de la commande suivante : +>> +>> ```bash +>> sudo netplan apply +>> ``` +>> +>> > [!primary] +>> > Lors de l'utilisation de la commande `netplan try`, il est possible que le système renvoie un message d'avertissement tel que `Permissions for /etc/netplan/xx-cloud-init.yaml are too open. Netplan configuration should NOT be accessible by others`. Cela signifie simplement que le fichier n'a pas de permissions restrictives. Cela n'affecte pas la configuration de votre Additional IP. Pour plus d'informations sur les permissions de fichiers, consultez la [documentation officielle d'ubuntu](https://help.ubuntu.com/community/FilePermissions). +>> > +>> +> AlmaLinux / Rocky Linux +>> **AlmaLinux (8 & 9), Rocky Linux (8 & 9)** +>> +>> Le fichier de configuration principal se trouve dans `/etc/sysconfig/network-scripts/`. Dans notre exemple, il est appelé `ifcfg-eth0`. Avant d'apporter des modifications, vérifiez le nom de fichier réel dans ce dossier. +>> +>> Pour chaque Additional IP à configurer, nous créons un fichier de configuration séparé avec les paramètres suivants : `ifcfg-NETWORK_INTERFACE:ID`. Où `NETWORK_INTERFACE` représente l'interface physique et `ID` est l'interface réseau virtuelle ou l'alias ethernet commençant par une valeur de 0. Par exemple, pour notre interface nommée `eth0`, le premier alias est `eth0:0`, le second alias est `eth0:1`, etc... +>> +>> Étape 1 : déterminer l'interface +>> +>> ```bash +>> ip a +>> ``` +>> +>> Notez le nom de l'interface (celle sur laquelle l'adresse IP principale de votre serveur est configurée). +>> +>> Étape 2 : créer le fichier de configuration +>> +>> Commencez par créer le fichier de configuration. Remplacez `NETWORK_INTERFACE:ID` par vos propres valeurs. +>> +>> ```bash +>> sudo nano /etc/sysconfig/network-scripts/ifcfg-NETWORK_INTERFACE:ID +>> ``` +>> +>> Ensuite, modifiez le fichier avec le contenu ci-dessous, en remplaçant `NETWORK_INTERFACE:ID` et `ADDITIONAL_IP` par vos propres valeurs : +>> +>> ```console +>> DEVICE=NETWORK_INTERFACE:ID +>> ONBOOT=yes +>> BOOTPROTO=none # For CentOS use "static" +>> IPADDR=ADDITIONAL_IP +>> NETMASK=255.255.255.255 +>> BROADCAST=ADDITIONAL_IP +>> ``` +>> +>> /// details | **Exemple de configuration** +>> +>> ```console +>> DEVICE=eth0:0 +>> ONBOOT=yes +>> BOOTPROTO=none # For CentOS use "static" +>> IPADDR=203.0.113.1 +>> NETMASK=255.255.255.255 +>> BROADCAST=203.0.113.1 +>> ``` +>> /// +>> +>> Étape 3 : redémarrer l'interface alias +>> +>> Vous devez maintenant redémarrer votre interface : +>> +>> ```bash +>> sudo systemctl restart NetworkManager +>> ``` +>> +> cPanel +>> **cPanel** +>> +>> Étape 1 : accéder à la section Gestion IP de WHM +>> +>> Dans l'espace client WHM, cliquez sur `IP Functions`{.action} et sélectionnez `Add a New IP Address`{.action} dans le menu de gauche. +>> +>> ![Ajouter une nouvelle adresse IP](images/Cpanel-1.png){.thumbnail} +>> +>> Étape 2 : Ajouter les informations des Additional IP +>> +>> Renseignez votre adresse Additional IP sous la forme « xxx.xxx.xxx.xxx » dans le champ « New IP or IP range to add ». +>> +>> Sélectionnez `255.255.255.255` comme masque de sous-réseau puis cliquez sur `Submit`{.action}. +>> +>> ![renseigner de nouvelles informations sur la nouvelle adresse IP](images/Cpanel-2024.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Attention, si vous avez plusieurs IP à configurer sur un même bloc et que vous les ajoutez toutes en même temps, le système WHM vous forcera à utiliser le masque de sous-réseau `255.255.255.0`. Il n'est pas recommandé d'utiliser cette configuration, il faut ajouter chaque IP individuellement pour pouvoir utiliser le masque de sous-réseau approprié `255.255.255.255`. +>> > +>> +>> Étape 3 : Vérifier la configuration IP actuelle +>> +>> De retour dans la section `IP Functions`{.action}, cliquez sur `Show or Delete Current IP Addresses`{.action} pour vérifier que l'adresse Additional IP a été correctement ajoutée. +>> +>> ![check configured IP](images/Cpanel-2024-1.png){.thumbnail} +>> +> Windows Servers +>> **Windows Servers** +>> +>> Les serveurs sous Windows sont souvent en DHCP au niveau de la configuration réseau. Si vous avez déjà paramétré une Additional IP ou passé votre configuration en IP fixe, rendez-vous directement à l’étape suivante. +>> +>> Sinon, vous devez d’abord passer d’une configuration DHCP au niveau du réseau à une configuration IP fixe. +>> +>> Ouvrez l’invite de commande `cmd`{.action} ou `powershell`{.action}, puis tapez la commande suivante : +>> +>> ```powershell +>> ipconfig +>> ``` +>> +>> Cela vous donnera un résultat similaire à l’exemple suivant : +>> +>> ![Result of "ipconfig" command](images/ipconfig.png){.thumbnail} +>> +>> Identifiez et notez votre adresse IPv4, votre masque de sous-réseau, votre passerelle par défaut et le nom du contrôleur d'interface réseau (carte réseau). +>> +>> Dans notre exemple, l’adresse IP du serveur est **192.0.2.28**. +>> +>> Vous pouvez effectuer les prochaines étapes via des lignes de commande ou l’interface graphique. +>> +>> **En lignes de commande (recommandé)** +>> +>> Dans les commandes ci-dessous, vous devez remplacer les informations suivantes : +>> +>> |Commande|Valeur| +>> |---|---| +>> |NETWORK_ADAPTER| Nom de la carte réseau (dans notre exemple : « Ethernet 2 »).| +>> |IP_ADDRESS| Adresse IP du serveur (dans notre exemple : « 192.0.2.28 »).| +>> |SUBNET_MASK| Masque de sous-réseau (dans notre exemple : « 255.255.255.0 »).| +>> |GATEWAY| Passerelle par défaut (dans notre exemple : « 192.0.2.254 »).| +>> |ADDITIONAL_IP| Adresse Additional IP que vous voulez ajouter.| +>> +>> > [!warning] +>> > +>> > Attention, le serveur ne sera plus accessible si vous entrez des informations incorrectes. Vous devrez alors effectuer les corrections en mode [WinRescue](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) ou via l'[IPMI](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). +>> > +>> +>> Dans l’invite de commande : +>> +>> Passez en premier lieu en IP fixe : +>> +>> ```powershell +>> netsh interface ipv4 set address name="NETWORK_ADAPTER" static IP_ADDRESS SUBNET_MASK GATEWAY +>> ``` +>> +>> Définissez ensuite le serveur DNS : +>> +>> ```powershell +>> netsh interface ipv4 set dns name="NETWORK_ADAPTER" static 213.186.33.99 +>> ``` +>> +>> Puis ajoutez une adresse Additional IP : +>> +>> ```powershell +>> netsh interface ipv4 add address "NETWORK_ADAPTER" ADDITIONAL_IP 255.255.255.255 +>> ``` +>> +>> Votre Additional IP est désormais fonctionnelle. +>> +>> /// details | **Via l’interface graphique d’utilisateur** +>> +>> 1\. Allez dans le menu `Démarrer`{.action}, puis `Panneau de gestion`{.action}, `Réseau et Internet`{.action}, `Centre de réseau et Partage`{.action} et `Modifier les paramètres de la carte`{.action} dans la barre de gauche ; +>> +>> 2\. Effectuez un clic droit sur votre connexion réseau, dans notre exemple `Ethernet 2`{.action} ; +>> +>> 3\. Cliquez sur `Propriétés`{.action} ; +>> +>> 4\. Sélectionnez `Protocole Internet Version 4 (TCP/IPv4)`{.action}, puis cliquez sur `Propriétés`{.action} ; +>> +>> 5\. Cliquez sur `Utiliser l’adresse IP suivante`{.action} et renseignez l’IP principale de votre serveur, le masque sous-réseau et la passerelle par défaut obtenus grâce à la commande `ipconfig`{.action} ci-dessus. Dans la case « Serveur DNS Préféré », tapez « 213.186.33.99 ». +>> +>> ![Propriétés Protocole Internet Version 4 (TCP/IPv4)](images/configure-main-ip.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Attention, le serveur ne sera plus accessible si vous entrez des informations incorrectes. Vous serez alors obligé d’effectuer les corrections en mode [WinRescue](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) ou via l'[IPMI](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). +>> > +>> +>> Ensuite, cliquez sur `Avancé`{.action} en étant toujours positionné dans les `Paramètres TCP/IP`{.action}. +>> +>> ![Propriétés Protocole Internet Version 4 (TCP/IPv4)](images/configure-main-ip-1.png){.thumbnail} +>> +>> Dans la partie « Adresse IP », cliquez sur `Ajouter`{.action} : +>> +>> ![Paramètres avancés TCP/IPv4](images/add-additional-ip.png){.thumbnail} +>> +>> Renseignez alors votre Additional IP et le masque de sous-réseau « **255.255.255.255** ». Cliquez sur `Ajouter`{.action}. +>> +>> ![Adresses TCP/IP](images/configure-additional-ip.png){.thumbnail} +>> +>> Cliquez sur `OK`{.action} pour valider votre configuration. +>> +>> Votre Additional IP est désormais fonctionnelle, vous pouvez vérifier la configuration avec la commande suivante : +>> +>> ```powershell +>> ipconfig +>> ``` +>> +>> Cela vous donnera un résultat similaire à l’exemple suivant : +>> +>> ![Final configuration](images/final-ip-configuration.png){.thumbnail} +>> +> Plesk +>> **Plesk** +>> +>> Étape 1 : accéder à la section Gestion de Plesk IP +>> +>> Dans le panneau de configuration Plesk, choisissez `Outils et paramètres`{.action} dans la barre latérale gauche. +>> +>> ![accès à la gestion des adresses IP](images/pleskip1.png){.thumbnail} +>> +>> Cliquez sur `Adresses IP`{.action} sous **Outils et ressources**. +>> +>> Étape 2 : ajouter les informations IP supplémentaires +>> +>> Dans cette section, cliquez sur le bouton `Add IP Address`{.action}. +>> +>> ![ajouter des informations IP](images/Plesk-2024.png){.thumbnail} +>> +>> Entrez votre adresse Additional IP sous la forme `xxx.xxx.xxx.xxx/32` dans le champ « Adresse IP et masque de sous-réseau », puis cliquez sur `OK`{.action}. +>> +>> ![ajouter des informations IP](images/Plesk-2024-1.png){.thumbnail} +>> +>> Étape 3 : vérifier la configuration IP actuelle +>> +>> Dans la section « Adresses IP », vérifiez que l'adresse Additional IP a été correctement ajoutée. +>> +>> ![configuration IP actuelle](images/Plesk-2024-2.png){.thumbnail} +>> #### Résolution des défauts @@ -558,4 +596,4 @@ Il vous suffit ensuite d'effectuer un ping depuis votre Additional IP vers l'ext [Mode bridge IP](/pages/bare_metal_cloud/dedicated_servers/network_bridging) -Échangez avec notre [communauté d'utilisateurs](/links/community). +Échangez avec notre [communauté d'utilisateurs](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.fr-fr.md b/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.fr-fr.md index 3b037ae1eed..4def527ee91 100644 --- a/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.fr-fr.md +++ b/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.fr-fr.md @@ -1,9 +1,23 @@ --- title: 'Configurer son adresse IP en alias' excerpt: 'Découvrez comment ajouter des Additional IP à votre configuration' -updated: 2025-07-22 +updated: 2025-11-12 --- + + > [!primary] > Cet article concerne la configuration d'adresses Additional IPv4 sur une interface publique. Vous pouvez également configurer des adresses IPv6 sur vos serveurs dédiés en utilisant [ce guide](/pages/bare_metal_cloud/dedicated_servers/network_ipv6). > @@ -42,9 +56,9 @@ L'alias d'IP (*IP aliasing* en anglais) est une configuration spéciale du rése Les sections suivantes contiennent les configurations des distributions que nous proposons actuellement et les distributions/systèmes d’exploitation les plus couramment utilisés. La première étape consiste toujours à vous connecter à votre serveur en SSH ou via une session de connexion GUI (RDP pour un serveur Windows). -> [!primary] -> ->Si vous souhaitez utiliser une distribution récente, la procédure adéquate pour configurer votre interface réseau peut nécessiter des adaptations. Si vous rencontrez des difficultés, nous vous recommandons de consulter la documentation relative à votre système d’exploitation. +> [!primary] +> Si vous souhaitez utiliser une distribution récente, la procédure adéquate pour configurer votre interface réseau peut nécessiter des adaptations. Si vous rencontrez des difficultés, nous vous recommandons de consulter la documentation relative à votre système d’exploitation. +> **Veuillez prendre note de la terminologie suivante qui sera utilisée dans les exemples de code et les instructions des sections du guide ci-dessous :** @@ -56,485 +70,509 @@ Les sections suivantes contiennent les configurations des distributions que nous Dans les exemples ci-dessous, nous utiliserons l'éditeur de texte `nano`. Avec certains systèmes d'exploitation, vous devrez d'abord l'installer avant de l'utiliser. Si c'est le cas, vous serez invité à le faire. Vous pouvez bien sûr utiliser l'éditeur de texte de votre choix. -### Debian 11 - -Par défaut, le fichier de configuration est situé dans `/etc/network/interfaces.d/`. Il est recommandé de commencer par sauvegarder le fichier de configuration correspondant. - -#### Étape 1 : créer une sauvegarde - -Dans notre exemple, notre fichier s'appelle `50-cloud-init`, nous copions donc le fichier `50-cloud-init` en utilisant la commande suivante : - -```bash -sudo cp /etc/network/interfaces.d/50-cloud-init /etc/network/interfaces.d/50-cloud-init.bak -``` - -En cas d'erreur, vous pourrez alors revenir en arrière grâce aux commandes ci-dessous : - -```bash -sudo rm -f /etc/network/interfaces.d/50-cloud-init -sudo cp /etc/network/interfaces.d/50-cloud-init.bak /etc/network/interfaces.d/50-cloud-init -``` - -#### Étape 2 : éditer le fichier de configuration - -> [!primary] -> -> Les noms donnés aux interfaces réseau dans ce guide peuvent différer des vôtres. Veuillez adapter les manipulations en conséquence. - -Vous pouvez désormais modifier le fichier de configuration : - -```bash -sudo nano /etc/network/interfaces.d/50-cloud-init -``` - -Vous devez ensuite ajouter une interface virtuelle ou un alias ethernet. Dans notre exemple, notre interface s'appelle `eth0`, donc notre alias est `eth0:0`. Faites ceci pour chaque adresse Additional IP que vous souhaitez configurer. - -Ne modifiez pas les lignes existantes dans le fichier de configuration, ajoutez simplement votre Additional IP au fichier comme indiqué ci-dessous, en remplaçant `ADDITIONAL_IP/32` ainsi que l'interface virtuelle (si votre serveur n'utilise pas **eth0:0**) par vos propres valeurs : - -```console -auto eth0:0 -iface eth0:0 inet static -address ADDITIONAL_IP -netmask 255.255.255.255 -``` - -Vous pouvez également configurer votre Additional IP en ajoutant les lignes suivantes dans le fichier de configuration : - -```console -post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP netmask 255.255.255.255 broadcast ADDITIONAL_IP -pre-down /sbin/ifconfig eth0:0 down -``` - -Avec la configuration ci-dessus, l'interface virtuelle est activée ou désactivée chaque fois que l'interface `eth0` est activée ou désactivée. - -Si vous avez deux Additional IP à configurer, le fichier `/etc/network/interfaces.d/50-cloud-init` doit ressembler à ceci : - -```console -auto eth0 -iface eth0 inet dhcp - -auto eth0:0 -iface eth0:0 inet static -address ADDITIONAL_IP1 -netmask 255.255.255.255 - -auto eth0:1 -iface eth0:1 inet static -address ADDITIONAL_IP2 -netmask 255.255.255.255 -``` - -Ou à cela : - -```console -auto eth0 -iface eth0 inet dhcp - -# IP 1 -post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP1 netmask 255.255.255.255 broadcast ADDITIONAL_IP1 -pre-down /sbin/ifconfig eth0:0 down - -# IP 2 -post-up /sbin/ifconfig eth0:1 ADDITIONAL_IP2 netmask 255.255.255.255 broadcast ADDITIONAL_IP2 -pre-down /sbin/ifconfig eth0:1 down -``` - -Exemple de configuration : - -```console -auto eth0 -iface eth0 inet dhcp - -auto eth0:0 -iface eth0:0 inet static -address 203.0.113.1 -netmask 255.255.255.255 -``` - -Ou : - -```console -auto eth0 -iface eth0 inet dhcp - -# IP 1 -post-up /sbin/ifconfig eth0:0 203.0.113.1 netmask 255.255.255.255 broadcast 203.0.113.1 -pre-down /sbin/ifconfig eth0:0 down -``` - -#### Étape 3 : redémarrer l’interface - -Pour redémarrer l'interface, utilisez la commande suivante : - -```bash -sudo /etc/init.d/networking restart -``` - -### Fedora 39 et versions ultérieures - -Fedora utilise dorénavant des fichiers clés (*keyfiles*). -Fedora utilisait auparavant des profils réseau stockés par NetworkManager au format ifcfg dans le répertoire `/etc/sysconfig/network-scripts/`.
-Le ifcfg étant à présent déprécié, NetworkManager ne crée plus par défaut les nouveaux profils dans ce format. Le fichier de configuration se trouve à présent dans `/etc/NetworkManager/system-connections/`. - -#### Étape 1 : créer une sauvegarde - -> [!primary] -> -> Notez que le nom du fichier réseau dans notre exemple peut différer du vôtre. Veuillez adapter les exemples avec le nom approprié. -> - -Il est recommandé de commencer par sauvegarder le fichier de configuration correspondant. Dans notre exemple, notre fichier de configuration s'appelle `cloud-init-eno1.nmconnection` : - -```bash -sudo cp -r /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak -``` -En cas d'erreur, vous pourrez alors revenir en arrière grâce aux commandes ci-dessous : - -```bash -sudo rm -f /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -sudo cp /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -``` - -#### Étape 2 : éditer le fichier de configuration - -> [!primary] -> Veuillez noter que le nom du fichier réseau dans notre exemple peut être différent du vôtre. Veuillez adapter les commandes à votre nom de fichier. -> - -Pour obtenir le nom de votre interface réseau afin d'éditer le fichier réseau approprié, vous pouvez exécuter l'une des commandes suivantes : - -```bash -ip a -``` - -```bash -nmcli connection show -``` - -Ne modifiez pas les lignes existantes dans le fichier de configuration, ajoutez votre Additional IP dans le fichier comme suit, en remplaçant `ADDITIONAL_IP/32` par vos propres valeurs : - -```bash -sudo nano /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -``` - -```console -[ipv4] -method=auto -may-fail=false -address1=ADDITIONAL_IP/32 -``` -Si vous avez deux adresses Additional IP à configurer, la configuration devrait ressembler à ceci : - -```console -[ipv4] -method=auto -may-fail=false -address1=ADDITIONAL_IP1/32 -address2=ADDITIONAL_IP2/32 -``` - -Exemple de configuration : - -```console -[ipv4] -method=auto -may-fail=false -address1=203.0.113.1/32 -``` - -#### Étape 3 : redémarrer l'interface - -Vous devez maintenant redémarrer votre interface : - -```bash -sudo systemctl restart NetworkManager -``` - -### Debian 12, Ubuntu 20.04 et versions suivantes - -Par défaut, les fichiers de configuration sont situés dans le répertoire `/etc/netplan`. - -La meilleure approche consiste à créer un fichier de configuration séparé pour configurer les adresses Additional IP. Cela permet de revenir facilement en arrière en cas d'erreur. - -#### Étape 1 : déterminer l’interface - -```bash -ip a -``` - -Notez le nom de l'interface (celle sur laquelle est configurée l'adresse IP principale de votre serveur). - -#### Étape 2 : créer le fichier de configuration - -Ensuite, créez un fichier de configuration avec une extension `.yaml`. Dans notre exemple, notre fichier s'appelle `51-cloud-init.yaml`. - -```bash -sudo nano /etc/netplan/51-cloud-init.yaml -``` - -Ensuite, éditez le fichier avec le contenu ci-dessous, en remplaçant `INTERFACE_NAME` et `ADDITIONAL_IP` par vos propres valeurs : - -```yaml -network: - version: 2 - ethernets: - INTERFACE_NAME: - dhcp4: true - addresses: - - ADDITIONAL_IP/32 -``` - -Si vous avez deux adresses Additional IP à configurer, le fichier de configuration devrait ressembler à ceci : - -```yaml -network: - version: 2 - ethernets: - INTERFACE_NAME: - dhcp4: true - addresses: - - ADDITIONAL_IP1/32 - - ADDITIONAL_IP2/32 -``` - -> [!warning] -> -> Il est important de respecter l’alignement de chaque élément de ce fichier, tel que représenté dans l’exemple ci-dessus. N’utilisez pas la touche de tabulation pour créer votre espacement. Seule la touche espace est nécessaire. -> - -Exemple de configuration : - -```yaml -network: - version: 2 - ethernets: - eth0: - dhcp4: true - addresses: - - 203.0.113.1/32 -``` - -Enregistrez et fermez le fichier. Vous pouvez tester la configuration avec la commande suivante : - -```bash -sudo netplan try -``` - -#### Étape 3 : appliquer la configuration - -Si elle est correcte, appliquez-la à l'aide de la commande suivante : - -```bash -sudo netplan apply -``` - -> [!primary] -> Lors de l'utilisation de la commande `netplan try`, il est possible que le système renvoie un message d'avertissement tel que `Permissions for /etc/netplan/xx-cloud-init.yaml are too open. Netplan configuration should NOT be accessible by others`. Cela signifie simplement que le fichier n'a pas de permissions restrictives. Cela n'affecte pas la configuration de votre Additional IP. Pour plus d'informations sur les permissions de fichiers, consultez la [documentation officielle d'ubuntu](https://help.ubuntu.com/community/FilePermissions). - -### AlmaLinux (8 & 9), Rocky Linux (8 & 9) - -Le fichier de configuration principal se trouve dans `/etc/sysconfig/network-scripts/`. Dans notre exemple, il est appelé `ifcfg-eth0`. Avant d'apporter des modifications, vérifiez le nom de fichier réel dans ce dossier. - -Pour chaque Additional IP à configurer, nous créons un fichier de configuration séparé avec les paramètres suivants : `ifcfg-NETWORK_INTERFACE:ID`. Où `NETWORK_INTERFACE` représente l'interface physique et `ID` est l'interface réseau virtuelle ou l'alias ethernet commençant par une valeur de 0. Par exemple, pour notre interface nommée `eth0`, le premier alias est `eth0:0`, le second alias est `eth0:1`, etc... - -#### Étape 1 : déterminer l'interface - -```bash -ip a -``` - -Notez le nom de l'interface (celle sur laquelle l'adresse IP principale de votre serveur est configurée). - -#### Étape 2 : créer le fichier de configuration - -Commencez par créer le fichier de configuration. Remplacez `NETWORK_INTERFACE:ID` par vos propres valeurs. - -```bash -sudo nano /etc/sysconfig/network-scripts/ifcfg-NETWORK_INTERFACE:ID -``` - -Ensuite, modifiez le fichier avec le contenu ci-dessous, en remplaçant `NETWORK_INTERFACE:ID` et `ADDITIONAL_IP` par vos propres valeurs : - -```console -DEVICE=NETWORK_INTERFACE:ID -ONBOOT=yes -BOOTPROTO=none # Pour CentOS utilisez "static" -IPADDR=ADDITIONAL_IP -NETMASK=255.255.255.255 -BROADCAST=ADDITIONAL_IP -``` - -Exemple de configuration : - -```console -DEVICE=eth0:0 -ONBOOT=yes -BOOTPROTO=none # Pour CentOS utilisez "static" -IPADDR=203.0.113.1 -NETMASK=255.255.255.255 -BROADCAST=203.0.113.1 -``` - -#### Étape 3 : redémarrer l'interface alias - -Vous devez maintenant redémarrer votre interface : - -```bash -sudo systemctl restart NetworkManager -``` - -### cPanel - -#### Étape 1 : accéder à la section Gestion IP de WHM - -Dans l'espace client WHM, cliquez sur `IP Functions`{.action} et sélectionnez `Add a New IP Address`{.action} dans le menu de gauche. - -![Ajouter une nouvelle adresse IP](images/Cpanel-1.png){.thumbnail} - -#### Étape 2 : Ajouter les informations des Additional IP - -Renseignez votre adresse Additional IP sous la forme « xxx.xxx.xxx.xxx » dans le champ « New IP or IP range to add ». - -Sélectionnez `255.255.255.255` comme masque de sous-réseau puis cliquez sur `Submit`{.action}. - -![renseigner de nouvelles informations sur la nouvelle adresse IP](images/Cpanel-2024.png){.thumbnail} - -> [!warning] -> -> Attention, si vous avez plusieurs IP à configurer sur un même bloc et que vous les ajoutez toutes en même temps, le système WHM vous forcera à utiliser le masque de sous-réseau `255.255.255.0`. Il n'est pas recommandé d'utiliser cette configuration, il faut ajouter chaque IP individuellement pour pouvoir utiliser le masque de sous-réseau approprié `255.255.255.255`. -> - -#### Étape 3 : Vérifier la configuration IP actuelle - -De retour dans la section `IP Functions`{.action}, cliquez sur `Show or Delete Current IP Addresses`{.action} pour vérifier que l'adresse Additional IP a été correctement ajoutée. - -![check configured IP](images/Cpanel-2024-1.png){.thumbnail} - -### Windows Servers - -Les serveurs sous Windows sont souvent en DHCP au niveau de la configuration réseau. Si vous avez déjà paramétré une Additional IP ou passé votre configuration en IP fixe, rendez-vous directement à l’étape suivante. - -Sinon, vous devez d’abord passer d’une configuration DHCP au niveau du réseau à une configuration IP fixe. - -Ouvrez l’invite de commande `cmd`{.action} ou `powershell`{.action}, puis tapez la commande suivante : - -```powershell -ipconfig -``` - -Cela vous donnera un résultat similaire à l’exemple suivant : - -![Result of "ipconfig" command](images/ipconfig.png){.thumbnail} - -Identifiez et notez votre adresse IPv4, votre masque de sous-réseau, votre passerelle par défaut et le nom du contrôleur d'interface réseau (carte réseau). - -Dans notre exemple, l’adresse IP du serveur est **192.0.2.28**. - -Vous pouvez effectuer les prochaines étapes via des lignes de commande ou l’interface graphique. - -#### En lignes de commande (recommandé) - -Dans les commandes ci-dessous, vous devez remplacer les informations suivantes : - -|Commande|Valeur| -|---|---| -|NETWORK_ADAPTER| Nom de la carte réseau (dans notre exemple : « Ethernet 2 »).| -|IP_ADDRESS| Adresse IP du serveur (dans notre exemple : « 192.0.2.28 »).| -|SUBNET_MASK| Masque de sous-réseau (dans notre exemple : « 255.255.255.0 »).| -|GATEWAY| Passerelle par défaut (dans notre exemple : « 192.0.2.254 »).| -|ADDITIONAL_IP| Adresse Additional IP que vous voulez ajouter.| - -> [!warning] +> [!success] +> Sélectionnez l'onglet correspondant à votre système d'exploitation. > -> Attention, le serveur ne sera plus accessible si vous entrez des informations incorrectes. Vous devrez alors effectuer les corrections en mode WinRescue ou via le KVM. -> - -Dans l’invite de commande : - -Passez en premier lieu en IP fixe : - -```powershell -netsh interface ipv4 set address name="NETWORK_ADAPTER" static IP_ADDRESS SUBNET_MASK GATEWAY -``` - -Définissez ensuite le serveur DNS : - -```powershell -netsh interface ipv4 set dns name="NETWORK_ADAPTER" static 213.186.33.99 -``` - -Puis ajoutez une adresse Additional IP : - -```powershell -netsh interface ipv4 add address "NETWORK_ADAPTER" ADDITIONAL_IP 255.255.255.255 -``` - -Votre Additional IP est désormais fonctionnelle. - -#### Via l’interface graphique d’utilisateur - -1. Allez dans le menu `Démarrer`{.action}, puis `Panneau de gestion`{.action}, `Réseau et Internet`{.action}, `Centre de réseau et Partage`{.action} et `Modifier les paramètres de la carte`{.action} dans la barre de gauche ; -2. Effectuez un clic droit sur votre connexion réseau, dans notre exemple `Ethernet 2`{.action} ; -3. Cliquez sur `Propriétés`{.action} ; -4. Sélectionnez `Protocole Internet Version 4 (TCP/IPv4)`{.action}, puis cliquez sur `Propriétés`{.action} ; -5. Cliquez sur `Utiliser l’adresse IP suivante`{.action} et renseignez l’IP principale de votre serveur, le masque sous-réseau et la passerelle par défaut obtenus grâce à la commande `ipconfig`{.action} ci-dessus. Dans la case « Serveur DNS Préféré », tapez « 213.186.33.99 ». - -![Propriétés Protocole Internet Version 4 (TCP/IPv4)](images/configure-main-ip.png){.thumbnail} - -> [!warning] -> -> Attention, le serveur ne sera plus accessible si vous entrez des informations incorrectes. Vous serez alors obligé d’effectuer les corrections en mode [WinRescue](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) ou via le [KVM](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). -> - -Ensuite, cliquez sur `Avancé`{.action} en étant toujours positionné dans les `Paramètres TCP/IP`{.action}. - -![Propriétés Protocole Internet Version 4 (TCP/IPv4)](images/configure-main-ip-1.png){.thumbnail} - -Dans la partie « Adresse IP », cliquez sur `Ajouter`{.action} : - -![Paramètres avancés TCP/IPv4](images/add-additional-ip.png){.thumbnail} - -Renseignez alors votre Additional IP et le masque de sous-réseau « **255.255.255.255** ». Cliquez sur `Ajouter`{.action}. - -![Adresses TCP/IP](images/configure-additional-ip.png){.thumbnail} - -Cliquez sur `OK`{.action} pour valider votre configuration. - -Votre Additional IP est désormais fonctionnelle, vous pouvez vérifier la configuration avec la commande suivante : - -```powershell -ipconfig -``` - -Cela vous donnera un résultat similaire à l’exemple suivant : - -![Final configuration](images/final-ip-configuration.png){.thumbnail} - -### Plesk - -#### Etape 1 : accéder à la section Gestion de Plesk IP - -Dans le panneau de configuration Plesk, choisissez `Outils et paramètres`{.action} dans la barre latérale gauche. - -![accès à la gestion des adresses IP](images/pleskip1.png){.thumbnail} - -Cliquez sur `Adresses IP`{.action} sous **Outils et ressources**. - -#### Etape 2 : ajouter les informations IP supplémentaires - -Dans cette section, cliquez sur le bouton `Add IP Address`{.action}. - -![ajouter des informations IP](images/Plesk-2024.png){.thumbnail} - -Entrez votre adresse Additional IP sous la forme `xxx.xxx.xxx.xxx/32` dans le champ « Adresse IP et masque de sous-réseau », puis cliquez sur `OK`{.action}. - -![ajouter des informations IP](images/Plesk-2024-1.png){.thumbnail} - -#### Etape 3 : vérifier la configuration IP actuelle - -Dans la section « Adresses IP », vérifiez que l'adresse Additional IP a été correctement ajoutée. -![configuration IP actuelle](images/Plesk-2024-2.png){.thumbnail} +> [!tabs] +> Debian 11 +>> **Debian 11** +>> +>> Par défaut, le fichier de configuration est situé dans `/etc/network/interfaces.d/`. Il est recommandé de commencer par sauvegarder le fichier de configuration correspondant. +>> +>> Étape 1 : créer une sauvegarde +>> +>> Dans notre exemple, notre fichier s'appelle `50-cloud-init`, nous copions donc le fichier `50-cloud-init` en utilisant la commande suivante : +>> +>> ```bash +>> sudo cp /etc/network/interfaces.d/50-cloud-init /etc/network/interfaces.d/50-cloud-init.bak +>> ``` +>> +>> En cas d'erreur, vous pourrez alors revenir en arrière grâce aux commandes ci-dessous : +>> +>> ```bash +>> sudo rm -f /etc/network/interfaces.d/50-cloud-init +>> sudo cp /etc/network/interfaces.d/50-cloud-init.bak /etc/network/interfaces.d/50-cloud-init +>> ``` +>> +>> Étape 2 : éditer le fichier de configuration +>> +>> > [!primary] +>> > +>> > Les noms donnés aux interfaces réseau dans ce guide peuvent différer des vôtres. Veuillez adapter les manipulations en conséquence. +>> +>> Vous pouvez désormais modifier le fichier de configuration : +>> +>> ```bash +>> sudo nano /etc/network/interfaces.d/50-cloud-init +>> ``` +>> +>> Vous devez ensuite ajouter une interface virtuelle ou un alias ethernet. Dans notre exemple, notre interface s'appelle `eth0`, donc notre alias est `eth0:0`. Faites ceci pour chaque adresse Additional IP que vous souhaitez configurer. +>> +>> Ne modifiez pas les lignes existantes dans le fichier de configuration, ajoutez simplement votre Additional IP au fichier comme indiqué ci-dessous, en remplaçant `ADDITIONAL_IP/32` ainsi que l'interface virtuelle (si votre serveur n'utilise pas **eth0:0**) par vos propres valeurs : +>> +>> ```console +>> auto eth0:0 +>> iface eth0:0 inet static +>> address ADDITIONAL_IP +>> netmask 255.255.255.255 +>> ``` +>> +>> Vous pouvez également configurer votre Additional IP en ajoutant les lignes suivantes dans le fichier de configuration : +>> +>> ```console +>> post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP netmask 255.255.255.255 broadcast ADDITIONAL_IP +>> pre-down /sbin/ifconfig eth0:0 down +>> ``` +>> +>> Avec la configuration ci-dessus, l'interface virtuelle est activée ou désactivée chaque fois que l'interface `eth0` est activée ou désactivée. +>> +>> Si vous avez deux Additional IP à configurer, le fichier `/etc/network/interfaces.d/50-cloud-init` doit ressembler à ceci : +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> auto eth0:0 +>> iface eth0:0 inet static +>> address ADDITIONAL_IP1 +>> netmask 255.255.255.255 +>> +>> auto eth0:1 +>> iface eth0:1 inet static +>> address ADDITIONAL_IP2 +>> netmask 255.255.255.255 +>> ``` +>> +>> Ou à cela : +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> # IP 1 +>> post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP1 netmask 255.255.255.255 broadcast ADDITIONAL_IP1 +>> pre-down /sbin/ifconfig eth0:0 down +>> +>> # IP 2 +>> post-up /sbin/ifconfig eth0:1 ADDITIONAL_IP2 netmask 255.255.255.255 broadcast ADDITIONAL_IP2 +>> pre-down /sbin/ifconfig eth0:1 down +>> ``` +>> +>> /// details | **Exemple de configuration** +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> auto eth0:0 +>> iface eth0:0 inet static +>> address 203.0.113.1 +>> netmask 255.255.255.255 +>> ``` +>> +>> Ou : +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> # IP 1 +>> post-up /sbin/ifconfig eth0:0 203.0.113.1 netmask 255.255.255.255 broadcast 203.0.113.1 +>> pre-down /sbin/ifconfig eth0:0 down +>> ``` +>> /// +>> +>> Étape 3 : redémarrer l’interface +>> +>> Pour redémarrer l'interface, utilisez la commande suivante : +>> +>> ```bash +>> sudo /etc/init.d/networking restart +>> ``` +>> +> Fedora 41+ +>> **Fedora 41 et versions ultérieures** +>> +>> Fedora utilise dorénavant des fichiers clés (*keyfiles*). +>> Fedora utilisait auparavant des profils réseau stockés par NetworkManager au format ifcfg dans le répertoire `/etc/sysconfig/network-scripts/`.
+>> Le ifcfg étant à présent déprécié, NetworkManager ne crée plus par défaut les nouveaux profils dans ce format. Le fichier de configuration se trouve à présent dans `/etc/NetworkManager/system-connections/`. +>> +>> Étape 1 : créer une sauvegarde +>> +>> > [!primary] +>> > +>> > Notez que le nom du fichier réseau dans notre exemple peut différer du vôtre. Veuillez adapter les exemples avec le nom approprié. +>> > +>> +>> Il est recommandé de commencer par sauvegarder le fichier de configuration correspondant. Dans notre exemple, notre fichier de configuration s'appelle `cloud-init-eno1.nmconnection` : +>> +>> ```bash +>> sudo cp -r /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak +>> ``` +>> +>> En cas d'erreur, vous pourrez alors revenir en arrière grâce aux commandes ci-dessous : +>> +>> ```bash +>> sudo rm -f /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> sudo cp /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> ``` +>> +>> Étape 2 : éditer le fichier de configuration +>> +>> > [!primary] +>> > Veuillez noter que le nom du fichier réseau dans notre exemple peut être différent du vôtre. Veuillez adapter les commandes à votre nom de fichier. +>> > +>> +>> Pour obtenir le nom de votre interface réseau afin d'éditer le fichier réseau approprié, vous pouvez exécuter l'une des commandes suivantes : +>> +>> ```bash +>> ip a +>> ``` +>> +>> ```bash +>> nmcli connection show +>> ``` +>> +>> Ne modifiez pas les lignes existantes dans le fichier de configuration, ajoutez votre Additional IP dans le fichier comme suit, en remplaçant `ADDITIONAL_IP/32` par vos propres valeurs : +>> +>> ```bash +>> sudo nano /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> ``` +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=ADDITIONAL_IP/32 +>> ``` +>> +>> Si vous avez deux adresses Additional IP à configurer, la configuration devrait ressembler à ceci : +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=ADDITIONAL_IP1/32 +>> address2=ADDITIONAL_IP2/32 +>> ``` +>> +>> /// details | **Exemple de configuration** +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=203.0.113.1/32 +>> ``` +>> /// +>> +>> Étape 3 : redémarrer l'interface +>> +>> Vous devez maintenant redémarrer votre interface : +>> +>> ```bash +>> sudo systemctl restart NetworkManager +>> ``` +>> +> Debian 12 et Ubuntu 20.04+ +>> **Debian 12, Ubuntu 20.04 et versions suivantes** +>> +>> Par défaut, les fichiers de configuration sont situés dans le répertoire `/etc/netplan`. +>> +>> La meilleure approche consiste à créer un fichier de configuration séparé pour configurer les adresses Additional IP. Cela permet de revenir facilement en arrière en cas d'erreur. +>> +>> Étape 1 : déterminer l’interface +>> +>> ```bash +>> ip a +>> ``` +>> +>> Notez le nom de l'interface (celle sur laquelle est configurée l'adresse IP principale de votre serveur). +>> +>> Étape 2 : créer le fichier de configuration +>> +>> Ensuite, créez un fichier de configuration avec une extension `.yaml`. Dans notre exemple, notre fichier s'appelle `51-cloud-init.yaml`. +>> +>> ```bash +>> sudo nano /etc/netplan/51-cloud-init.yaml +>> ``` +>> +>> Ensuite, éditez le fichier avec le contenu ci-dessous, en remplaçant `INTERFACE_NAME` et `ADDITIONAL_IP` par vos propres valeurs : +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> INTERFACE_NAME: +>> dhcp4: true +>> addresses: +>> - ADDITIONAL_IP/32 +>> ``` +>> +>> Si vous avez deux adresses Additional IP à configurer, le fichier de configuration devrait ressembler à ceci : +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> INTERFACE_NAME: +>> dhcp4: true +>> addresses: +>> - ADDITIONAL_IP1/32 +>> - ADDITIONAL_IP2/32 +>> ``` +>> +>> > [!warning] +>> > +>> > Il est important de respecter l’alignement de chaque élément de ce fichier, tel que représenté dans l’exemple ci-dessus. N’utilisez pas la touche de tabulation pour créer votre espacement. Seule la touche espace est nécessaire. +>> > +>> +>> /// details | **Exemple de configuration** +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> eth0: +>> dhcp4: true +>> addresses: +>> - 203.0.113.1/32 +>> ``` +>> /// +>> +>> Enregistrez et fermez le fichier. Vous pouvez tester la configuration avec la commande suivante : +>> +>> ```bash +>> sudo netplan try +>> ``` +>> +>> Étape 3 : appliquer la configuration +>> +>> Si elle est correcte, appliquez-la à l'aide de la commande suivante : +>> +>> ```bash +>> sudo netplan apply +>> ``` +>> +>> > [!primary] +>> > Lors de l'utilisation de la commande `netplan try`, il est possible que le système renvoie un message d'avertissement tel que `Permissions for /etc/netplan/xx-cloud-init.yaml are too open. Netplan configuration should NOT be accessible by others`. Cela signifie simplement que le fichier n'a pas de permissions restrictives. Cela n'affecte pas la configuration de votre Additional IP. Pour plus d'informations sur les permissions de fichiers, consultez la [documentation officielle d'ubuntu](https://help.ubuntu.com/community/FilePermissions). +>> > +>> +> AlmaLinux / Rocky Linux +>> **AlmaLinux (8 & 9), Rocky Linux (8 & 9)** +>> +>> Le fichier de configuration principal se trouve dans `/etc/sysconfig/network-scripts/`. Dans notre exemple, il est appelé `ifcfg-eth0`. Avant d'apporter des modifications, vérifiez le nom de fichier réel dans ce dossier. +>> +>> Pour chaque Additional IP à configurer, nous créons un fichier de configuration séparé avec les paramètres suivants : `ifcfg-NETWORK_INTERFACE:ID`. Où `NETWORK_INTERFACE` représente l'interface physique et `ID` est l'interface réseau virtuelle ou l'alias ethernet commençant par une valeur de 0. Par exemple, pour notre interface nommée `eth0`, le premier alias est `eth0:0`, le second alias est `eth0:1`, etc... +>> +>> Étape 1 : déterminer l'interface +>> +>> ```bash +>> ip a +>> ``` +>> +>> Notez le nom de l'interface (celle sur laquelle l'adresse IP principale de votre serveur est configurée). +>> +>> Étape 2 : créer le fichier de configuration +>> +>> Commencez par créer le fichier de configuration. Remplacez `NETWORK_INTERFACE:ID` par vos propres valeurs. +>> +>> ```bash +>> sudo nano /etc/sysconfig/network-scripts/ifcfg-NETWORK_INTERFACE:ID +>> ``` +>> +>> Ensuite, modifiez le fichier avec le contenu ci-dessous, en remplaçant `NETWORK_INTERFACE:ID` et `ADDITIONAL_IP` par vos propres valeurs : +>> +>> ```console +>> DEVICE=NETWORK_INTERFACE:ID +>> ONBOOT=yes +>> BOOTPROTO=none # For CentOS use "static" +>> IPADDR=ADDITIONAL_IP +>> NETMASK=255.255.255.255 +>> BROADCAST=ADDITIONAL_IP +>> ``` +>> +>> /// details | **Exemple de configuration** +>> +>> ```console +>> DEVICE=eth0:0 +>> ONBOOT=yes +>> BOOTPROTO=none # For CentOS use "static" +>> IPADDR=203.0.113.1 +>> NETMASK=255.255.255.255 +>> BROADCAST=203.0.113.1 +>> ``` +>> /// +>> +>> Étape 3 : redémarrer l'interface alias +>> +>> Vous devez maintenant redémarrer votre interface : +>> +>> ```bash +>> sudo systemctl restart NetworkManager +>> ``` +>> +> cPanel +>> **cPanel** +>> +>> Étape 1 : accéder à la section Gestion IP de WHM +>> +>> Dans l'espace client WHM, cliquez sur `IP Functions`{.action} et sélectionnez `Add a New IP Address`{.action} dans le menu de gauche. +>> +>> ![Ajouter une nouvelle adresse IP](images/Cpanel-1.png){.thumbnail} +>> +>> Étape 2 : Ajouter les informations des Additional IP +>> +>> Renseignez votre adresse Additional IP sous la forme « xxx.xxx.xxx.xxx » dans le champ « New IP or IP range to add ». +>> +>> Sélectionnez `255.255.255.255` comme masque de sous-réseau puis cliquez sur `Submit`{.action}. +>> +>> ![renseigner de nouvelles informations sur la nouvelle adresse IP](images/Cpanel-2024.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Attention, si vous avez plusieurs IP à configurer sur un même bloc et que vous les ajoutez toutes en même temps, le système WHM vous forcera à utiliser le masque de sous-réseau `255.255.255.0`. Il n'est pas recommandé d'utiliser cette configuration, il faut ajouter chaque IP individuellement pour pouvoir utiliser le masque de sous-réseau approprié `255.255.255.255`. +>> > +>> +>> Étape 3 : Vérifier la configuration IP actuelle +>> +>> De retour dans la section `IP Functions`{.action}, cliquez sur `Show or Delete Current IP Addresses`{.action} pour vérifier que l'adresse Additional IP a été correctement ajoutée. +>> +>> ![check configured IP](images/Cpanel-2024-1.png){.thumbnail} +>> +> Windows Servers +>> **Windows Servers** +>> +>> Les serveurs sous Windows sont souvent en DHCP au niveau de la configuration réseau. Si vous avez déjà paramétré une Additional IP ou passé votre configuration en IP fixe, rendez-vous directement à l’étape suivante. +>> +>> Sinon, vous devez d’abord passer d’une configuration DHCP au niveau du réseau à une configuration IP fixe. +>> +>> Ouvrez l’invite de commande `cmd`{.action} ou `powershell`{.action}, puis tapez la commande suivante : +>> +>> ```powershell +>> ipconfig +>> ``` +>> +>> Cela vous donnera un résultat similaire à l’exemple suivant : +>> +>> ![Result of "ipconfig" command](images/ipconfig.png){.thumbnail} +>> +>> Identifiez et notez votre adresse IPv4, votre masque de sous-réseau, votre passerelle par défaut et le nom du contrôleur d'interface réseau (carte réseau). +>> +>> Dans notre exemple, l’adresse IP du serveur est **192.0.2.28**. +>> +>> Vous pouvez effectuer les prochaines étapes via des lignes de commande ou l’interface graphique. +>> +>> **En lignes de commande (recommandé)** +>> +>> Dans les commandes ci-dessous, vous devez remplacer les informations suivantes : +>> +>> |Commande|Valeur| +>> |---|---| +>> |NETWORK_ADAPTER| Nom de la carte réseau (dans notre exemple : « Ethernet 2 »).| +>> |IP_ADDRESS| Adresse IP du serveur (dans notre exemple : « 192.0.2.28 »).| +>> |SUBNET_MASK| Masque de sous-réseau (dans notre exemple : « 255.255.255.0 »).| +>> |GATEWAY| Passerelle par défaut (dans notre exemple : « 192.0.2.254 »).| +>> |ADDITIONAL_IP| Adresse Additional IP que vous voulez ajouter.| +>> +>> > [!warning] +>> > +>> > Attention, le serveur ne sera plus accessible si vous entrez des informations incorrectes. Vous devrez alors effectuer les corrections en mode [WinRescue](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) ou via l'[IPMI](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). +>> > +>> +>> Dans l’invite de commande : +>> +>> Passez en premier lieu en IP fixe : +>> +>> ```powershell +>> netsh interface ipv4 set address name="NETWORK_ADAPTER" static IP_ADDRESS SUBNET_MASK GATEWAY +>> ``` +>> +>> Définissez ensuite le serveur DNS : +>> +>> ```powershell +>> netsh interface ipv4 set dns name="NETWORK_ADAPTER" static 213.186.33.99 +>> ``` +>> +>> Puis ajoutez une adresse Additional IP : +>> +>> ```powershell +>> netsh interface ipv4 add address "NETWORK_ADAPTER" ADDITIONAL_IP 255.255.255.255 +>> ``` +>> +>> Votre Additional IP est désormais fonctionnelle. +>> +>> /// details | **Via l’interface graphique d’utilisateur** +>> +>> 1\. Allez dans le menu `Démarrer`{.action}, puis `Panneau de gestion`{.action}, `Réseau et Internet`{.action}, `Centre de réseau et Partage`{.action} et `Modifier les paramètres de la carte`{.action} dans la barre de gauche ; +>> +>> 2\. Effectuez un clic droit sur votre connexion réseau, dans notre exemple `Ethernet 2`{.action} ; +>> +>> 3\. Cliquez sur `Propriétés`{.action} ; +>> +>> 4\. Sélectionnez `Protocole Internet Version 4 (TCP/IPv4)`{.action}, puis cliquez sur `Propriétés`{.action} ; +>> +>> 5\. Cliquez sur `Utiliser l’adresse IP suivante`{.action} et renseignez l’IP principale de votre serveur, le masque sous-réseau et la passerelle par défaut obtenus grâce à la commande `ipconfig`{.action} ci-dessus. Dans la case « Serveur DNS Préféré », tapez « 213.186.33.99 ». +>> +>> ![Propriétés Protocole Internet Version 4 (TCP/IPv4)](images/configure-main-ip.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Attention, le serveur ne sera plus accessible si vous entrez des informations incorrectes. Vous serez alors obligé d’effectuer les corrections en mode [WinRescue](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) ou via l'[IPMI](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). +>> > +>> +>> Ensuite, cliquez sur `Avancé`{.action} en étant toujours positionné dans les `Paramètres TCP/IP`{.action}. +>> +>> ![Propriétés Protocole Internet Version 4 (TCP/IPv4)](images/configure-main-ip-1.png){.thumbnail} +>> +>> Dans la partie « Adresse IP », cliquez sur `Ajouter`{.action} : +>> +>> ![Paramètres avancés TCP/IPv4](images/add-additional-ip.png){.thumbnail} +>> +>> Renseignez alors votre Additional IP et le masque de sous-réseau « **255.255.255.255** ». Cliquez sur `Ajouter`{.action}. +>> +>> ![Adresses TCP/IP](images/configure-additional-ip.png){.thumbnail} +>> +>> Cliquez sur `OK`{.action} pour valider votre configuration. +>> +>> Votre Additional IP est désormais fonctionnelle, vous pouvez vérifier la configuration avec la commande suivante : +>> +>> ```powershell +>> ipconfig +>> ``` +>> +>> Cela vous donnera un résultat similaire à l’exemple suivant : +>> +>> ![Final configuration](images/final-ip-configuration.png){.thumbnail} +>> +> Plesk +>> **Plesk** +>> +>> Étape 1 : accéder à la section Gestion de Plesk IP +>> +>> Dans le panneau de configuration Plesk, choisissez `Outils et paramètres`{.action} dans la barre latérale gauche. +>> +>> ![accès à la gestion des adresses IP](images/pleskip1.png){.thumbnail} +>> +>> Cliquez sur `Adresses IP`{.action} sous **Outils et ressources**. +>> +>> Étape 2 : ajouter les informations IP supplémentaires +>> +>> Dans cette section, cliquez sur le bouton `Add IP Address`{.action}. +>> +>> ![ajouter des informations IP](images/Plesk-2024.png){.thumbnail} +>> +>> Entrez votre adresse Additional IP sous la forme `xxx.xxx.xxx.xxx/32` dans le champ « Adresse IP et masque de sous-réseau », puis cliquez sur `OK`{.action}. +>> +>> ![ajouter des informations IP](images/Plesk-2024-1.png){.thumbnail} +>> +>> Étape 3 : vérifier la configuration IP actuelle +>> +>> Dans la section « Adresses IP », vérifiez que l'adresse Additional IP a été correctement ajoutée. +>> +>> ![configuration IP actuelle](images/Plesk-2024-2.png){.thumbnail} +>> #### Résolution des défauts @@ -558,4 +596,4 @@ Il vous suffit ensuite d'effectuer un ping depuis votre Additional IP vers l'ext [Mode bridge IP](/pages/bare_metal_cloud/dedicated_servers/network_bridging) -Échangez avec notre [communauté d'utilisateurs](/links/community). +Échangez avec notre [communauté d'utilisateurs](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.it-it.md b/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.it-it.md index 8ba2816f591..a29d23996ae 100644 --- a/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.it-it.md +++ b/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.it-it.md @@ -1,9 +1,23 @@ --- title: Configurare un Alias IP excerpt: 'Scopri come aggiungere uno o più Additional IP alla tua configurazione' -updated: 2025-07-22 +updated: 2025-11-12 --- + + > [!primary] > Questo articolo riguarda la configurazione di indirizzi Additional IPv4 su un'interfaccia pubblica. È inoltre possibile configurare indirizzi IPv6 sui server dedicati utilizzando [questa guida](/pages/bare_metal_cloud/dedicated_servers/network_ipv6). > @@ -55,494 +69,513 @@ Nelle sezioni seguenti vengono illustrate le configurazioni delle distribuzioni Negli esempi che seguono, utilizzeremo l’editor di testo `nano`. Con alcuni sistemi operativi, sarà necessario installarlo prima di utilizzarlo. In tal caso, verrà richiesto di farlo. È ovviamente possibile utilizzare qualsiasi editor di testo. -### Debian 11 - -Per impostazione predefinita, il file di configurazione si trova in `/etc/network/interfaces.d/`. È consigliabile iniziare effettuando il backup del file di configurazione corrispondente. - -#### Step 1: crea un backup - -Nel nostro esempio, il nostro file si chiama `50-cloud-init`, quindi copiamo il file `50-cloud-init` utilizzando il seguente comando: - -```sh -sudo cp /etc/network/interfaces.d/50-cloud-init /etc/network/interfaces.d/50-cloud-init.bak -``` - -In caso di errore, è possibile annullare l’operazione eseguendo questi comandi: - -```sh -sudo rm -f /etc/network/interfaces.d/50-cloud-init -sudo cp /etc/network/interfaces.d/50-cloud-init.bak /etc/network/interfaces.d/50-cloud-init -``` - -#### Step 2: modifica il file di configurazione - -> [!primary] -> -> I nomi forniti alle interfacce di rete in questa guida potrebbero essere diversi dai tuoi. Adattare le operazioni di conseguenza. -> - -Ora è possibile modificare il file sorgente: - -```sh -sudo nano /etc/network/interfaces.d/50-cloud-init -``` - -È quindi necessario aggiungere un'interfaccia virtuale o un alias ethernet. Nel nostro esempio, la nostra interfaccia si chiama `eth0`, quindi il nostro alias è `eth0:0`. Per ogni indirizzo Additional IP che vuoi configurare. - -Non modificare le linee esistenti nel file di configurazione, è sufficiente aggiungere l’Additional IP al file come indicato qui di seguito, sostituendo `ADDITIONAL_IP/32` e l’interfaccia virtuale (se il server non utilizza **eth0:0**) con i tuoi valori: - -```console -auto eth0:0 -iface eth0:0 inet static -address ADDITIONAL_IP -netmask 255.255.255.255 -``` - -È inoltre possibile configurare l’Additional IP aggiungendo le righe seguenti al file di configurazione: - -```console -post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP netmask 255.255.255.255 broadcast ADDITIONAL_IP -pre-down /sbin/ifconfig eth0:0 down -``` - -Con la configurazione di cui sopra, l’interfaccia virtuale viene attivata o disattivata ogni volta che l’interfaccia `eth0` viene attivata o disattivata. - -Per configurare due Additional IP, il file `/etc/network/interfaces.d/50-cloud-init` deve essere di questo tipo: - -```console -auto eth0 -iface eth0 inet dhcp - -auto eth0:0 -iface eth0:0 inet static -address ADDITIONAL_IP1 -netmask 255.255.255.255 - -auto eth0:1 -iface eth0:1 inet static -address ADDITIONAL_IP2 -netmask 255.255.255.255 -``` - -O così: - -```console -auto eth0 -iface eth0 inet dhcp - -# IP 1 -post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP1 netmask 255.255.255.255 broadcast ADDITIONAL_IP1 -pre-down /sbin/ifconfig eth0:0 down - -# IP 2 -post-up /sbin/ifconfig eth0:1 ADDITIONAL_IP2 netmask 255.255.255.255 broadcast ADDITIONAL_IP2 -pre-down /sbin/ifconfig eth0:1 down -``` - -**Esempio di configurazione:** - -```console -auto eth0 -iface eth0 inet dhcp - -auto eth0:0 -iface eth0:0 inet static -address 203.0.113.1 -netmask 255.255.255.255 -``` - -O così: - -```console -auto eth0 -iface eth0 inet dhcp - -# IP 1 -post-up /sbin/ifconfig eth0:0 203.0.113.1 netmask 255.255.255.255 broadcast 203.0.113.1 -pre-down /sbin/ifconfig eth0:0 down -``` - -#### Step 3: riavvia l’interfaccia - -Per riavviare l’interfaccia esegui il comando: - -```sh -sudo /etc/init.d/networking restart -``` - -### Fedora 39 e versioni successive - -Da questo momento, Fedora utilizza file chiave (*keyfiles*). -In precedenza Fedora utilizzava profili di rete memorizzati da NetworkManager in formato ifcfg nella directory `/etc/sysconfig/network-scripts/`.
-Poiché l'ifcfg ha subito una riduzione di valore, NetworkManager non crea di default i nuovi profili in questo formato. Il file di configurazione è disponibile in `/etc/NetworkManager/system-connections/`. - -#### Step 1: crea un backup - -> [!primary] -> -> Tieni presente che il nome del file di rete nel nostro esempio potrebbe essere diverso dal tuo. Adattare gli esempi con il nome appropriato. -> - -È consigliabile iniziare effettuando il backup del file di configurazione corrispondente. Nel nostro esempio, il file di configurazione si chiama `cloud-init-eno1.nmconnection`: - - -```sh -sudo cp -r /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak -``` - -In caso di errore, è possibile annullare l’operazione eseguendo questi comandi: - -```sh -sudo rm -f /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -sudo cp /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -``` - -#### Step 2: modifica il file sorgente - -> [!primary] +> [!success] +> Seleziona la scheda corrispondente al tuo sistema operativo. > -> Ti ricordiamo che il nome del file di rete nel nostro esempio può differire dal tuo. Adatta i comandi in base al nome del tuo file. -> - -Per ottenere il nome dell'interfaccia di rete per modificare il file di rete appropriato, eseguire uno dei comandi seguenti: - -```sh -ip a -``` - -```sh -nmcli connection show -``` - -Non modificare le righe esistenti nel file di configurazione, aggiungi l’Additional IP nel file come segue, sostituendo `ADDITIONAL_IP/32` con i tuoi valori: - -```sh -sudo nano /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -``` - -```console -[ipv4] -method=auto -may-fail=false -address1=ADDITIONAL_IP/32 -``` - -Se hai due indirizzi Additional IP da configurare, il file di configurazione dovrebbe essere di questo tipo: - -```console -[ipv4] -method=auto -may-fail=false -address1=ADDITIONAL_IP1/32 -address2=ADDITIONAL_IP2/32 -``` - -**Esempio di configurazione** - -```console -[ipv4] -method=auto -may-fail=false -address1=203.0.113.1/32 -``` - -#### Step 3: riavvia l’interfaccia - -Per riavviare l’interfaccia esegui il comando: - -```sh -sudo systemctl restart NetworkManager -``` - -### Debian 12, Ubuntu 20.04 e versioni successive - -Per impostazione predefinita, i file di configurazione si trovano nella directory `/etc/netplan`. - -L’approccio migliore consiste nel creare un file di configurazione separato per configurare gli indirizzi Additional IP. Questo permette di tornare facilmente indietro in caso di errore. - -#### Step 1: determina l’interfaccia - -```sh -ip a -``` - -Annota il nome dell’interfaccia (quella su cui è configurato l’indirizzo IP principale del tuo server). - -#### Step 2: crea il file di configurazione - -Creare quindi un file di configurazione con l'estensione `.yaml`. Nel nostro esempio, il nome del nostro file è `51-cloud-init.yaml`. - - -```sh -sudo nano /etc/netplan/51-cloud-init.yaml -``` - -Successivamente, modifica il file con il contenuto seguente, sostituendo `INTERFACE_NAME` e `ADDITIONAL_IP` con i tuoi valori: - -```yaml -network: - version: 2 - ethernets: - INTERFACE_NAME: - dhcp4: true - addresses: - - ADDITIONAL_IP/32 -``` - -Se è necessario configurare due indirizzi Additional IP, il file di configurazione dovrebbe essere simile al seguente: - -```yaml -network: - version: 2 - ethernets: - INTERFACE_NAME: - dhcp4: true - addresses: - - ADDITIONAL_IP1/32 - - ADDITIONAL_IP2/32 -``` - -> [!warning] -> -> È importante allineare ogni elemento del file, come illustrato nell'esempio precedente. Non utilizzare il tasto Tab per creare la spaziatura. È necessario solo il tasto spazio. -> - -**Esempio di configurazione:** - -```yaml -network: - version: 2 - ethernets: - eth0: - dhcp4: true - addresses: - - 203.0.113.1/32 -``` - -Salvare e chiudere il file. Per testare la configurazione esegui questo comando: - - -```sh -sudo netplan try -``` - -#### Step 3: applica la configurazione - -Se è corretta, applicala utilizzando il comando seguente: - -```sh -sudo netplan apply -``` - -> [!primary] -> Quando si utilizza il comando `netplan try`, è possibile che il sistema restituisca un messaggio di avviso, ad esempio `Permissions for /etc/netplan/xx-cloud-init.yaml are too open. Netplan configuration should NOT be accessible by others`. Significa semplicemente che il file non dispone di autorizzazioni restrittive. e la configurazione dell’Additional IP resta invariata. Per maggiori informazioni sui permessi dei file, consulta la [documentazione ufficiale di ubuntu](https://help.ubuntu.com/community/FilePermissions). -> - -### AlmaLinux (8 & 9), Rocky Linux (8 & 9) - -Il file di configurazione principale si trova in `/etc/sysconfig/network-scripts/`. Nel nostro esempio, si chiama `ifcfg-eth0`. Prima di apportare modifiche, verificare il nome file effettivo nella cartella. - -Per ogni Additional IP da configurare, creiamo un file di configurazione separato con i seguenti parametri: `ifcfg-NETWORK_INTERFACE:ID`. Dove `NETWORK_INTERFACE` rappresenta l’interfaccia fisica e `ID` è l’interfaccia di rete virtuale o l’alias ethernet che inizia con un valore di 0. Ad esempio, per la nostra interfaccia chiamata `eth0`, il primo alias è `eth0:0`, il secondo alias è `eth0:1`, ecc... - -#### Step 1: determina l’interfaccia - -```sh -ip a -``` - -Annota il nome dell’interfaccia (quella su cui è configurato l’indirizzo IP principale del tuo server). - -#### Step 2: crea il file di configurazione - -Iniziare creando il file di configurazione. Sostituisci `NETWORK_INTERFACE:ID` con i tuoi valori. - -```sh -sudo nano /etc/sysconfig/network-scripts/ifcfg-NETWORK_INTERFACE:ID -``` - -Successivamente, modifica il file con il contenuto seguente, sostituendo `NETWORK_INTERFACE:ID` e `ADDITIONAL_IP` con i tuoi valori: - -```console -DEVICE=NETWORK_INTERFACE:ID -ONBOOT=yes -BOOTPROTO=none # For CentOS use "static" -IPADDR=ADDITIONAL_IP -NETMASK=255.255.255.255 -BROADCAST=ADDITIONAL_IP -``` - -**Esempio di configurazione:** - -```console -DEVICE=eth0:0 -ONBOOT=yes -BOOTPROTO=none # For CentOS use "static" -IPADDR=203.0.113.1 -NETMASK=255.255.255.255 -BROADCAST=203.0.113.1 -``` - -#### Step 3: riavvia l’interfaccia - -Per riavviare l’interfaccia esegui il comando: - -```sh -sudo systemctl restart NetworkManager -``` - -### cPanel - -#### Step 1: accedi alla gestione IP di WHM - -Nello Spazio Cliente WHM, clicca su `IP Functions`{.action} e seleziona `Add a New IP Address`{.action} nel menu a sinistra. - -![Aggiungere un nuovo indirizzo IP](images/Cpanel-1.png){.thumbnail} - -#### Step 2: aggiungi le informazioni degli Additional IP - -Inserisci il tuo indirizzo Additional IP nella forma `xxx.xxx.xxx.xxx` nel campo "New IP or IP range to add". - -Seleziona `255.255.255.255` come subnet mask e clicca su `Submit`{.action}. - -![inserire nuove informazioni sul nuovo indirizzo IP](images/Cpanel-2024.png){.thumbnail} - -> [!warning] -> -> Attenzione: se si hanno più IP da configurare sullo stesso blocco e li si aggiunge tutti insieme, il sistema WHM obbliga a utilizzare la subnet mask `255.255.255.0`. Non si consiglia di utilizzare questa configurazione; è necessario aggiungere ogni IP singolarmente per utilizzare la subnet mask `255.255.255.255` appropriata. -> - -#### Step 3: verifica la configurazione IP corrente - -Di ritorno alla sezione `IP Functions`{.action}, clicca su `Show or Delete Current IP Addresses`{.action} per verificare che l'indirizzo Additional IP sia stato aggiunto correttamente. - -![check configured IP](images/Cpanel-2024-1.png){.thumbnail} - -### Windows Server - -I server Windows vengono forniti solitamente con una configurazione di rete con DHCP abilitato di default. Se hai già aggiunto un Additional IP o modificato la tua configurazione per utilizzare un IP statico, passa direttamente allo step successivo. - -In caso contrario sarà necessario modificare la configurazione di rete per impostare IP statico al posto del DHCP. - -Apri il prompt dei comandi `cmd`{.action} o `powershell`{.action} e digita il comando: - -```powershell -ipconfig -``` - -Il risultato restituito sarà, ad esempio: - -![Result of "ipconfig" command](images/ipconfig.png){.thumbnail} - -Recupera il tuo IPv4, la subnet mask, il gateway predefinito e il nome della scheda di rete. - -Nel nostro esempio, l’IP del server è: **192.0.2.28** - -Per continuare, è possibile effettuare le operazioni sia da riga di comando che tramite interfaccia grafica: - -#### Da riga di comando (consigliato) - -Nei comandi seguenti, è necessario sostituire: - -|Comando|Valore| -|---|---| -|NETWORK_ADAPTER|Nome della scheda di rete (nel nostro esempio, "Ethernet 2")| -|IP_ADDRESS|Indirizzo IP del server (nel nostro esempio, 192.0.2.28)| -|SUBNET_MASK| Maschera di sottorete (nel nostro esempio, 255.255.255.0)| -|GATEWAY| Gateway predefinito (nel nostro esempio, 192.0.2.254)| -|ADDITIONAL_IP|Indirizzo Additional IP da aggiungere| - -> [!warning] -> -> Attenzione: se le informazioni inserite non sono corrette, il server non sarà più raggiungibile e sarà necessario effettuare le correzioni accedendo in modalità [WinRescue](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) o tramite il [IPMI](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). -> - -Nel prompt dei comandi: - -* Passare a un IP statico - -```powershell -netsh interface ipv4 set address name="NETWORK_ADAPTER" static IP_ADDRESS SUBNET_MASK GATEWAY -``` - -* Definire il server DNS - -```powershell -netsh interface ipv4 set dns name="NETWORK_ADAPTER" static 213.186.33.99 -``` - -* Aggiungere un Additional IP - -```powershell -netsh interface ipv4 add address "NETWORK_ADAPTER" ADDITIONAL_IP 255.255.255.255 -``` - -Da questo momento, il tuo Additional IP è attivo. - -#### Da interfaccia grafica - -1. Accedi al menu `Start`{.action} > `Control Panel`{.action} > `Network and Internet`{.action} > `Network and Sharing Centre`{.action} > `Change Adapter Settings`{.action} (nel menu a sinistra) -2. Clicca con il tasto destro su Connessione alla rete local, nel nostro esempio `Ethernet 2`{.action} -3. Clicca su `Properties`{.action} -4. Seleziona `Internet Protocol Version 4 (TCP/IPv4)`{.action} e clicca su `Properties`{.action} -5. Clicca su `Use the following IP address`{.action} e inserisci l'IP principale del tuo server, la subnet mask e il gateway predefinito ottenuto precedentemente con il comando `ipconfig`{.action} . In `Preferred DNS Server`, inserisci 213.186.33.99. - -![Internet Protocol Version 4 (TCP/IPv4) Properties](images/configure-main-ip.png){.thumbnail} - -> [!warning] -> -> Attenzione: se le informazioni inserite non sono corrette, il server non sarà più raggiungibile e sarà necessario effettuare le correzioni accedendo in modalità [WinRescue](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) o tramite il [IPMI](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). -> - -In seguito, clicca su `Advanced`{.action} (sempre nelle `TCP/IP Settings`{.action}). - -![Internet Protocol Version 4 (TCP/IPv4) Properties](images/configure-main-ip-1.png){.thumbnail} - -Nella parte `IP Address`{.action}, clicca su `Add`{.action}: - -![Advanced TCP/IPv4 Settings](images/add-additional-ip.png){.thumbnail} - -Inserisci il tuo Additional IP e la subnet mask **255.255.255.255**. Clicca su `Add`{.action}. - -![TCP/IP Address](images/configure-additional-ip.png){.thumbnail} - -Clicca su `OK`{.action} per confermare la configurazione. - -A questo punto l’Additional IP è operativo ed è possibile verificare la configurazione eseguendo questo comando: - -```powershell -ipconfig -``` - -Il risultato sarà simile a quello dell'esempio seguente: - -![Final configuration](images/final-ip-configuration.png){.thumbnail} - -### Plesk - -#### Step 1: accedi alla sezione Gestione di Plesk IP - -Nel pannello di configurazione Plesk, seleziona `Tools & Settings`{.action} nella barra laterale sinistra. - -![accesso alla gestione degli indirizzi IP](images/pleskip1.png){.thumbnail} - -Clicca su `IP Indirizzi`{.action} con **Tools & Settings**. - -#### Step 2: aggiungi le informazioni IP supplementari - -In questa sezione, clicca sul pulsante `Add IP Address`{.action}. - -![aggiungi informazioni IP](images/Plesk-2024.png){.thumbnail} - -Inserisci il tuo indirizzo Additional IP nella forma `xxx.xxx.xxx.xxx/32` nel campo "IP address and subnet mask" e clicca su `OK`{.action}. - -![aggiungi informazioni IP](images/Plesk-2024-1.png){.thumbnail} - -#### Step 3: verifica la configurazione IP corrente - -Per verificare che l'indirizzo Additional IP sia stato aggiunto correttamente, accedi alla sezione "Indirizzi IP". - -![configurazione IP attuale](images/Plesk-2024-2.png){.thumbnail} +> [!tabs] +> Debian 11 +>> **Debian 11** +>> +>> Per impostazione predefinita, il file di configurazione si trova in `/etc/network/interfaces.d/`. È consigliabile iniziare effettuando il backup del file di configurazione corrispondente. +>> +>> Step 1: crea un backup +>> +>> Nel nostro esempio, il nostro file si chiama `50-cloud-init`, quindi copiamo il file `50-cloud-init` utilizzando il seguente comando: +>> +>> ```sh +>> sudo cp /etc/network/interfaces.d/50-cloud-init /etc/network/interfaces.d/50-cloud-init.bak +>> ``` +>> +>> In caso di errore, è possibile annullare l’operazione eseguendo questi comandi: +>> +>> ```sh +>> sudo rm -f /etc/network/interfaces.d/50-cloud-init +>> sudo cp /etc/network/interfaces.d/50-cloud-init.bak /etc/network/interfaces.d/50-cloud-init +>> ``` +>> +>> Step 2: modifica il file di configurazione +>> +>> > [!primary] +>> > +>> > I nomi forniti alle interfacce di rete in questa guida potrebbero essere diversi dai tuoi. Adattare le operazioni di conseguenza. +>> > +>> +>> Ora è possibile modificare il file sorgente: +>> +>> ```sh +>> sudo nano /etc/network/interfaces.d/50-cloud-init +>> ``` +>> +>> È quindi necessario aggiungere un'interfaccia virtuale o un alias ethernet. Nel nostro esempio, la nostra interfaccia si chiama `eth0`, quindi il nostro alias è `eth0:0`. Per ogni indirizzo Additional IP che vuoi configurare. +>> +>> Non modificare le linee esistenti nel file di configurazione, è sufficiente aggiungere l’Additional IP al file come indicato qui di seguito, sostituendo `ADDITIONAL_IP/32` e l’interfaccia virtuale (se il server non utilizza **eth0:0**) con i tuoi valori: +>> +>> ```console +>> auto eth0:0 +>> iface eth0:0 inet static +>> address ADDITIONAL_IP +>> netmask 255.255.255.255 +>> ``` +>> +>> È inoltre possibile configurare l’Additional IP aggiungendo le righe seguenti al file di configurazione: +>> +>> ```console +>> post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP netmask 255.255.255.255 broadcast ADDITIONAL_IP +>> pre-down /sbin/ifconfig eth0:0 down +>> ``` +>> +>> Con la configurazione di cui sopra, l’interfaccia virtuale viene attivata o disattivata ogni volta che l’interfaccia `eth0` viene attivata o disattivata. +>> +>> Per configurare due Additional IP, il file `/etc/network/interfaces.d/50-cloud-init` deve essere di questo tipo: +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> auto eth0:0 +>> iface eth0:0 inet static +>> address ADDITIONAL_IP1 +>> netmask 255.255.255.255 +>> +>> auto eth0:1 +>> iface eth0:1 inet static +>> address ADDITIONAL_IP2 +>> netmask 255.255.255.255 +>> ``` +>> +>> O così: +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> # IP 1 +>> post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP1 netmask 255.255.255.255 broadcast ADDITIONAL_IP1 +>> pre-down /sbin/ifconfig eth0:0 down +>> +>> # IP 2 +>> post-up /sbin/ifconfig eth0:1 ADDITIONAL_IP2 netmask 255.255.255.255 broadcast ADDITIONAL_IP2 +>> pre-down /sbin/ifconfig eth0:1 down +>> ``` +>> +>> /// details | **Esempio di configurazione** +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> auto eth0:0 +>> iface eth0:0 inet static +>> address 203.0.113.1 +>> netmask 255.255.255.255 +>> ``` +>> +>> O così: +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> # IP 1 +>> post-up /sbin/ifconfig eth0:0 203.0.113.1 netmask 255.255.255.255 broadcast 203.0.113.1 +>> pre-down /sbin/ifconfig eth0:0 down +>> ``` +>> /// +>> +>> Step 3: riavvia l’interfaccia +>> +>> Per riavviare l’interfaccia esegui il comando: +>> +>> ```sh +>> sudo /etc/init.d/networking restart +>> ``` +>> +> Fedora 41+ +>> **Fedora 41 e versioni successive** +>> +>> Da questo momento, Fedora utilizza file chiave (*keyfiles*). +>> In precedenza Fedora utilizzava profili di rete memorizzati da NetworkManager in formato ifcfg nella directory `/etc/sysconfig/network-scripts/`.
+>> Poiché l'ifcfg ha subito una riduzione di valore, NetworkManager non crea di default i nuovi profili in questo formato. Il file di configurazione è disponibile in `/etc/NetworkManager/system-connections/`. +>> +>> Step 1: crea un backup +>> +>> > [!primary] +>> > +>> > Tieni presente che il nome del file di rete nel nostro esempio potrebbe essere diverso dal tuo. Adattare gli esempi con il nome appropriato. +>> > +>> +>> È consigliabile iniziare effettuando il backup del file di configurazione corrispondente. Nel nostro esempio, il file di configurazione si chiama `cloud-init-eno1.nmconnection`: +>> +>> ```sh +>> sudo cp -r /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak +>> ``` +>> +>> In caso di errore, è possibile annullare l’operazione eseguendo questi comandi: +>> +>> ```sh +>> sudo rm -f /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> sudo cp /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> ``` +>> +>> Step 2: modifica il file sorgente +>> +>> > [!primary] +>> > +>> > Ti ricordiamo che il nome del file di rete nel nostro esempio può differire dal tuo. Adatta i comandi in base al nome del tuo file. +>> > +>> +>> Per ottenere il nome dell'interfaccia di rete per modificare il file di rete appropriato, eseguire uno dei comandi seguenti: +>> +>> ```sh +>> ip a +>> ``` +>> +>> ```sh +>> nmcli connection show +>> ``` +>> +>> Non modificare le righe esistenti nel file di configurazione, aggiungi l’Additional IP nel file come segue, sostituendo `ADDITIONAL_IP/32` con i tuoi valori: +>> +>> ```sh +>> sudo nano /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> ``` +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=ADDITIONAL_IP/32 +>> ``` +>> +>> Se hai due indirizzi Additional IP da configurare, il file di configurazione dovrebbe essere di questo tipo: +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=ADDITIONAL_IP1/32 +>> address2=ADDITIONAL_IP2/32 +>> ``` +>> +>> /// details | **Esempio di configurazione** +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=203.0.113.1/32 +>> ``` +>> /// +>> +>> Step 3: riavvia l’interfaccia +>> +>> Per riavviare l’interfaccia esegui il comando: +>> +>> ```sh +>> sudo systemctl restart NetworkManager +>> ``` +>> +> Debian 12 e Ubuntu 20.04+ +>> **Debian 12, Ubuntu 20.04 e versioni successive** +>> +>> Per impostazione predefinita, i file di configurazione si trovano nella directory `/etc/netplan`. +>> +>> L’approccio migliore consiste nel creare un file di configurazione separato per configurare gli indirizzi Additional IP. Questo permette di tornare facilmente indietro in caso di errore. +>> +>> Step 1: determina l’interfaccia +>> +>> ```sh +>> ip a +>> ``` +>> +>> Annota il nome dell’interfaccia (quella su cui è configurato l’indirizzo IP principale del tuo server). +>> +>> Step 2: crea il file di configurazione +>> +>> Creare quindi un file di configurazione con l'estensione `.yaml`. Nel nostro esempio, il nome del nostro file è `51-cloud-init.yaml`. +>> +>> ```sh +>> sudo nano /etc/netplan/51-cloud-init.yaml +>> ``` +>> +>> Successivamente, modifica il file con il contenuto seguente, sostituendo `INTERFACE_NAME` e `ADDITIONAL_IP` con i tuoi valori: +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> INTERFACE_NAME: +>> dhcp4: true +>> addresses: +>> - ADDITIONAL_IP/32 +>> ``` +>> +>> Se è necessario configurare due indirizzi Additional IP, il file di configurazione dovrebbe essere simile al seguente: +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> INTERFACE_NAME: +>> dhcp4: true +>> addresses: +>> - ADDITIONAL_IP1/32 +>> - ADDITIONAL_IP2/32 +>> ``` +>> +>> > [!warning] +>> > +>> > È importante allineare ogni elemento del file, come illustrato nell'esempio precedente. Non utilizzare il tasto Tab per creare la spaziatura. È necessario solo il tasto spazio. +>> > +>> +>> /// details | **Esempio di configurazione** +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> eth0: +>> dhcp4: true +>> addresses: +>> - 203.0.113.1/32 +>> ``` +>> /// +>> +>> Salvare e chiudere il file. Per testare la configurazione esegui questo comando: +>> +>> ```sh +>> sudo netplan try +>> ``` +>> +>> Step 3: applica la configurazione +>> +>> Se è corretta, applicala utilizzando il comando seguente: +>> +>> ```sh +>> sudo netplan apply +>> ``` +>> +>> > [!primary] +>> > Quando si utilizza il comando `netplan try`, è possibile che il sistema restituisca un messaggio di avviso, ad esempio `Permissions for /etc/netplan/xx-cloud-init.yaml are too open. Netplan configuration should NOT be accessible by others`. Significa semplicemente che il file non dispone di autorizzazioni restrittive. e la configurazione dell’Additional IP resta invariata. Per maggiori informazioni sui permessi dei file, consulta la [documentazione ufficiale di ubuntu](https://help.ubuntu.com/community/FilePermissions). +>> > +>> +> AlmaLinux / Rocky Linux +>> **AlmaLinux (8 & 9), Rocky Linux (8 & 9)** +>> +>> Il file di configurazione principale si trova in `/etc/sysconfig/network-scripts/`. Nel nostro esempio, si chiama `ifcfg-eth0`. Prima di apportare modifiche, verificare il nome file effettivo nella cartella. +>> +>> Per ogni Additional IP da configurare, creiamo un file di configurazione separato con i seguenti parametri: `ifcfg-NETWORK_INTERFACE:ID`. Dove `NETWORK_INTERFACE` rappresenta l’interfaccia fisica e `ID` è l’interfaccia di rete virtuale o l’alias ethernet che inizia con un valore di 0. Ad esempio, per la nostra interfaccia chiamata `eth0`, il primo alias è `eth0:0`, il secondo alias è `eth0:1`, ecc... +>> +>> Step 1: determina l’interfaccia +>> +>> ```sh +>> ip a +>> ``` +>> +>> Annota il nome dell’interfaccia (quella su cui è configurato l’indirizzo IP principale del tuo server). +>> +>> Step 2: crea il file di configurazione +>> +>> Iniziare creando il file di configurazione. Sostituisci `NETWORK_INTERFACE:ID` con i tuoi valori. +>> +>> ```sh +>> sudo nano /etc/sysconfig/network-scripts/ifcfg-NETWORK_INTERFACE:ID +>> ``` +>> +>> Successivamente, modifica il file con il contenuto seguente, sostituendo `NETWORK_INTERFACE:ID` e `ADDITIONAL_IP` con i tuoi valori: +>> +>> ```console +>> DEVICE=NETWORK_INTERFACE:ID +>> ONBOOT=yes +>> BOOTPROTO=none # For CentOS use "static" +>> IPADDR=ADDITIONAL_IP +>> NETMASK=255.255.255.255 +>> BROADCAST=ADDITIONAL_IP +>> ``` +>> +>> /// details | **Esempio di configurazione** +>> +>> ```console +>> DEVICE=eth0:0 +>> ONBOOT=yes +>> BOOTPROTO=none # For CentOS use "static" +>> IPADDR=203.0.113.1 +>> NETMASK=255.255.255.255 +>> BROADCAST=203.0.113.1 +>> ``` +>> /// +>> +>> Step 3: riavvia l’interfaccia +>> +>> Per riavviare l’interfaccia esegui il comando: +>> +>> ```sh +>> sudo systemctl restart NetworkManager +>> ``` +>> +> cPanel +>> **cPanel** +>> +>> Step 1: accedi alla gestione IP di WHM +>> +>> Nello Spazio Cliente WHM, clicca su `IP Functions`{.action} e seleziona `Add a New IP Address`{.action} nel menu a sinistra. +>> +>> ![Aggiungere un nuovo indirizzo IP](images/Cpanel-1.png){.thumbnail} +>> +>> Step 2: aggiungi le informazioni degli Additional IP +>> +>> Inserisci il tuo indirizzo Additional IP nella forma `xxx.xxx.xxx.xxx` nel campo "New IP or IP range to add". +>> +>> Seleziona `255.255.255.255` come subnet mask e clicca su `Submit`{.action}. +>> +>> ![inserire nuove informazioni sul nuovo indirizzo IP](images/Cpanel-2024.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Attenzione: se si hanno più IP da configurare sullo stesso blocco e li si aggiunge tutti insieme, il sistema WHM obbliga a utilizzare la subnet mask `255.255.255.0`. Non si consiglia di utilizzare questa configurazione; è necessario aggiungere ogni IP singolarmente per utilizzare la subnet mask `255.255.255.255` appropriata. +>> > +>> +>> Step 3: verifica la configurazione IP corrente +>> +>> Di ritorno alla sezione `IP Functions`{.action}, clicca su `Show or Delete Current IP Addresses`{.action} per verificare che l'indirizzo Additional IP sia stato aggiunto correttamente. +>> +>> ![check configured IP](images/Cpanel-2024-1.png){.thumbnail} +>> +> Windows Server +>> **Windows Server** +>> +>> I server Windows vengono forniti solitamente con una configurazione di rete con DHCP abilitato di default. Se hai già aggiunto un Additional IP o modificato la tua configurazione per utilizzare un IP statico, passa direttamente allo step successivo. +>> +>> In caso contrario sarà necessario modificare la configurazione di rete per impostare IP statico al posto del DHCP. +>> +>> Apri il prompt dei comandi `cmd`{.action} o `powershell`{.action} e digita il comando: +>> +>> ```powershell +>> ipconfig +>> ``` +>> +>> Il risultato restituito sarà, ad esempio: +>> +>> ![Result of "ipconfig" command](images/ipconfig.png){.thumbnail} +>> +>> Recupera il tuo IPv4, la subnet mask, il gateway predefinito e il nome della scheda di rete. +>> +>> Nel nostro esempio, l’IP del server è: **192.0.2.28** +>> +>> Per continuare, è possibile effettuare le operazioni sia da riga di comando che tramite interfaccia grafica: +>> +>> **Da riga di comando (consigliato)** +>> +>> Nei comandi seguenti, è necessario sostituire: +>> +>> |Comando|Valore| +>> |---|---| +>> |NETWORK_ADAPTER|Nome della scheda di rete (nel nostro esempio, "Ethernet 2")| +>> |IP_ADDRESS|Indirizzo IP del server (nel nostro esempio, 192.0.2.28)| +>> |SUBNET_MASK| Maschera di sottorete (nel nostro esempio, 255.255.255.0)| +>> |GATEWAY| Gateway predefinito (nel nostro esempio, 192.0.2.254)| +>> |ADDITIONAL_IP|Indirizzo Additional IP da aggiungere| +>> +>> > [!warning] +>> > +>> > Attenzione: se le informazioni inserite non sono corrette, il server non sarà più raggiungibile e sarà necessario effettuare le correzioni accedendo in modalità [WinRescue](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) o tramite il [IPMI](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). +>> > +>> +>> Nel prompt dei comandi: +>> +>> * Passare a un IP statico +>> +>> ```powershell +>> netsh interface ipv4 set address name="NETWORK_ADAPTER" static IP_ADDRESS SUBNET_MASK GATEWAY +>> ``` +>> +>> * Definire il server DNS +>> +>> ```powershell +>> netsh interface ipv4 set dns name="NETWORK_ADAPTER" static 213.186.33.99 +>> ``` +>> +>> * Aggiungere un Additional IP +>> +>> ```powershell +>> netsh interface ipv4 add address "NETWORK_ADAPTER" ADDITIONAL_IP 255.255.255.255 +>> ``` +>> +>> Da questo momento, il tuo Additional IP è attivo. +>> +>> /// details | **Da interfaccia grafica** +>> +>> 1\. Accedi al menu `Start`{.action} > `Control Panel`{.action} > `Network and Internet`{.action} > `Network and Sharing Centre`{.action} > `Change Adapter Settings`{.action} (nel menu a sinistra) +>> +>> 2\. Clicca con il tasto destro su Connessione alla rete local, nel nostro esempio `Ethernet 2`{.action} +>> +>> 3\. Clicca su `Properties`{.action} +>> +>> 4\. Seleziona `Internet Protocol Version 4 (TCP/IPv4)`{.action} e clicca su `Properties`{.action} +>> +>> 5\. Clicca su `Use the following IP address`{.action} e inserisci l'IP principale del tuo server, la subnet mask e il gateway predefinito ottenuto precedentemente con il comando `ipconfig`{.action} . In `Preferred DNS Server`, inserisci 213.186.33.99. +>> +>> ![Internet Protocol Version 4 (TCP/IPv4) Properties](images/configure-main-ip.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Attenzione: se le informazioni inserite non sono corrette, il server non sarà più raggiungibile e sarà necessario effettuare le correzioni accedendo in modalità [WinRescue](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) o tramite il [IPMI](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). +>> > +>> +>> In seguito, clicca su `Advanced`{.action} (sempre nelle `TCP/IP Settings`{.action}). +>> +>> ![Internet Protocol Version 4 (TCP/IPv4) Properties](images/configure-main-ip-1.png){.thumbnail} +>> +>> Nella parte `IP Address`{.action}, clicca su `Add`{.action}: +>> +>> ![Advanced TCP/IPv4 Settings](images/add-additional-ip.png){.thumbnail} +>> +>> Inserisci il tuo Additional IP e la subnet mask **255.255.255.255**. Clicca su `Add`{.action}. +>> +>> ![TCP/IP Address](images/configure-additional-ip.png){.thumbnail} +>> +>> Clicca su `OK`{.action} per confermare la configurazione. +>> +>> A questo punto l’Additional IP è operativo ed è possibile verificare la configurazione eseguendo questo comando: +>> +>> ```powershell +>> ipconfig +>> ``` +>> +>> Il risultato sarà simile a quello dell'esempio seguente: +>> +>> ![Final configuration](images/final-ip-configuration.png){.thumbnail} +>> +>> /// +>> +> Plesk +>> **Plesk** +>> +>> Step 1: accedi alla sezione Gestione di Plesk IP +>> +>> Nel pannello di configurazione Plesk, seleziona `Tools & Settings`{.action} nella barra laterale sinistra. +>> +>> ![accesso alla gestione degli indirizzi IP](images/pleskip1.png){.thumbnail} +>> +>> Clicca su `IP Indirizzi`{.action} con **Tools & Settings**. +>> +>> Step 2: aggiungi le informazioni IP supplementari +>> +>> In questa sezione, clicca sul pulsante `Add IP Address`{.action}. +>> +>> ![aggiungi informazioni IP](images/Plesk-2024.png){.thumbnail} +>> +>> Inserisci il tuo indirizzo Additional IP nella forma `xxx.xxx.xxx.xxx/32` nel campo "IP address and subnet mask" e clicca su `OK`{.action}. +>> +>> ![aggiungi informazioni IP](images/Plesk-2024-1.png){.thumbnail} +>> +>> Step 3: verifica la configurazione IP corrente +>> +>> Per verificare che l'indirizzo Additional IP sia stato aggiunto correttamente, accedi alla sezione "Indirizzi IP". +>> +>> ![configurazione IP attuale](images/Plesk-2024-2.png){.thumbnail} +>> #### Risoluzione dei difetti diff --git a/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.pl-pl.md b/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.pl-pl.md index e37d2e77730..73bdbddae7c 100644 --- a/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.pl-pl.md +++ b/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.pl-pl.md @@ -1,9 +1,23 @@ --- title: 'Konfiguracja adresu Additional IP jako aliasu' excerpt: 'Dowiedz się, jak dodać kilka adresów Additional IP do interfejsu' -updated: 2025-07-22 +updated: 2025-11-12 --- + + > [!primary] > Ten artykuł dotyczy konfiguracji adresów Additional IPv4 w interfejsie publicznym. Możesz również skonfigurować adresy IPv6 na swoich serwerach dedykowanych, korzystając z [tego przewodnika](/pages/bare_metal_cloud/dedicated_servers/network_ipv6). > @@ -38,7 +52,7 @@ Alias IP (po angielsku IP aliasing) to specjalna konfiguracja sieci serwera dedy ## W praktyce -Poniższe sekcje zawierają konfiguracje aktualnie oferowanych przez nas dystrybucji oraz najczęściej używane dystrybucje/systemy operacyjne. Pierwszy etap polega zawsze na połączeniu się z Twoim serwerem przez SSH lub za pomocą sesji połączenia GUI (RDP w przypadku serwera Windows). +Poniższe sekcje zawierają konfiguracje aktualnie oferowanych przez nas dystrybucji oraz najczęściej używane dystrybucje/systemy operacyjne. Pierwszy Kror polega zawsze na połączeniu się z Twoim serwerem przez SSH lub za pomocą sesji połączenia GUI (RDP w przypadku serwera Windows). > [!primary] > @@ -55,487 +69,512 @@ Poniższe sekcje zawierają konfiguracje aktualnie oferowanych przez nas dystryb W poniższych przykładach użyjemy edytora tekstu `nano`. W przypadku niektórych systemów operacyjnych należy zainstalować go przed użyciem. Jeśli tak będzie, zostaniesz poproszony o jego wykonanie. Możesz użyć dowolnego edytora tekstu. -### Debian 11 - -Domyślnie plik konfiguracyjny znajduje się w katalogu`/etc/network/interfaces.d/`. Zaleca się, aby najpierw wykonać kopię zapasową odpowiedniego pliku konfiguracyjnego. - -#### Krok 1: tworzenie kopii zapasowej - -W naszym przykładzie nasz plik nosi nazwę `50-cloud-init`, dlatego kopiujemy plik `50-cloud-init` za pomocą następującego polecenia: - -```sh -sudo cp /etc/network/interfaces.d/50-cloud-init /etc/network/interfaces.d/50-cloud-init.bak -``` - -W przypadku błędu będziesz mógł wrócić do poprzedniej wersji za pomocą poniższych poleceń: - -```sh -sudo rm -f /etc/network/interfaces.d/50-cloud-init -sudo cp /etc/network/interfaces.d/50-cloud-init.bak /etc/network/interfaces.d/50-cloud-init -``` - -#### Krok 2: modyfikacja pliku konfiguracyjnego - -> [!primary] -> -> Nazwy interfejsów sieciowych podane w tym przewodniku mogą różnić się od Twoich. Prosimy o odpowiednie dostosowanie sposobu postępowania. -> - -Teraz można zmodyfikować plik konfiguracyjny: - -```sh -sudo nano /etc/network/interfaces.d/50-cloud- -``` - -Następnie dodaj wirtualny interfejs lub alias ethernet. W naszym przykładzie nasz interfejs nosi nazwę `eth0`, więc nasz alias to `eth0:0`. Zrób to dla każdego adresu Additional IP, który chcesz skonfigurować. - -Nie zmieniaj istniejących linii w pliku konfiguracyjnym, dodaj Additional IP do pliku, jak pokazano poniżej, zastępując `ADDITIONAL_IP/32` oraz wirtualny interfejs (jeśli Twój serwer nie używa **eth0:0**) własnymi wartościami: - -```console -auto eth0:0 -iface eth0:0 inet static -address ADDITIONAL_IP -netmask 255.255.255.255 -``` - -Możesz również skonfigurować Additional IP, dodając następujące wiersze poleceń w pliku konfiguracyjnym: - -```console -post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP netmask 255.255.255.255 broadcast ADDITIONAL_IP -pre-down /sbin/ifconfig eth0:0 down -``` - -W przypadku powyższej konfiguracji wirtualny interfejs jest aktywowany lub dezaktywowany za każdym razem, gdy interfejs `eth0` jest włączony lub wyłączony. - -Jeśli masz do skonfigurowania dwa adresy Additional IP, plik `/etc/network/interfaces.d/50-cloud-init` musi wyglądać w taki sposób: - -```console -auto eth0 -iface eth0 inet dhcp - -auto eth0:0 -iface eth0:0 inet static -address ADDITIONAL_IP1 -netmask 255.255.255.255 - -auto eth0:1 -iface eth0:1 inet static -address ADDITIONAL_IP2 -netmask 255.255.255.255 -``` - -Lub tak: - -```console -auto eth0 -iface eth0 inet dhcp - -# IP 1 -post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP1 netmask 255.255.255.255 broadcast ADDITIONAL_IP1 -pre-down /sbin/ifconfig eth0:0 down - -# IP 2 -post-up /sbin/ifconfig eth0:1 ADDITIONAL_IP2 netmask 255.255.255.255 broadcast ADDITIONAL_IP2 -pre-down /sbin/ifconfig eth0:1 down -``` - -**Przykład konfiguracji:** - -```console -auto eth0:0 -iface eth0:0 inet static -address 203.0.113.1 -netmask 255.255.255.255 -``` - -Lub: - -```console -auto eth0 -iface eth0 inet dhcp - -# IP 1 -post-up /sbin/ifconfig eth0:0 203.0.113.1 netmask 255.255.255.255 broadcast 203.0.113.1 -pre-down /sbin/ifconfig eth0:0 down -``` - -#### Krok 3: restart interfejsu - -Pozostaje tylko zrestartować interfejs: - -```sh -sudo /etc/init.d/networking restart -``` - -### Fedora 39 i kolejne wersje - -Fedora korzysta teraz z kluczowych plików (*keyfiles*). -Fedora korzystała wcześniej z profili sieci przechowywanych przez NetworkManager w formacie ifcfg w katalogu `/etc/sysconfig/network-scripts/`.
-NetworkManager nie tworzy już domyślnie nowych profili w tym formacie. Plik konfiguracyjny znajduje się w `/etc/NetworkManager/system-connections/`. - -#### Krok 1: tworzenie kopii zapasowej - -> [!primary] -> -> Pamiętaj, że nazwa pliku sieciowego w naszym przykładzie może różnić się od Twojej. Dostosuj przykłady pod odpowiednią nazwą. -> - -Zaleca się, aby najpierw wykonać kopię zapasową odpowiedniego pliku konfiguracyjnego. W poniższym przykładzie nasz plik konfiguracyjny nosi nazwę `cloud-init-eno1.nmconnection`: - - -```sh -sudo cp -r /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak -``` - -W przypadku błędu będziesz mógł wrócić do poprzedniej wersji za pomocą poniższych poleceń: - -```sh -sudo rm -f /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -sudo cp /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -``` - -#### Krok 2: modyfikacja pliku konfiguracyjny - -> [!primary] -> Pamiętaj, że nazwa pliku sieciowego w naszym przykładzie może się różnić od Twojej. Dostosuj polecenia do nazwy pliku. -> - -Aby uzyskać nazwę interfejsu sieciowego umożliwiającą edytowanie odpowiedniego pliku sieciowego, możesz wykonać jedną z następujących czynności: - -```sh -ip a -``` - -```sh -nmcli connection show -``` - -Nie zmieniaj istniejących wierszy w pliku konfiguracyjnym, dodaj Additional IP w następującym pliku, zastępując `ADDITIONAL_IP/32` własnymi wartościami: - -```sh -sudo nano /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -``` - -```console -[ipv4] -method=auto -may-fail=false -address1=ADDITIONAL_IP/32 -``` - -Jeśli masz dwa dodatkowe adresy Additional IP do skonfigurowania, plik konfiguracyjny powinien wyglądać następująco: - -```console -[ipv4] -method=auto -may-fail=false -address1=ADDITIONAL_IP1/32 -address2=ADDITIONAL_IP2/32 -``` - -**Przykład konfiguracji:** - -```console -[ipv4] -method=auto -may-fail=false -address1=203.0.113.1/32 -``` - -#### Krok 3: restart interfejsu - -Pozostaje tylko zrestartować interfejs: - -```sh -sudo systemctl restart NetworkManager -``` - -### Debian 12, Ubuntu 20.04 i kolejne wersje - -Domyślnie pliki konfiguracyjne znajdują się w katalogu`/etc/netplan`. - -Najlepszym rozwiązaniem jest utworzenie oddzielnego pliku konfiguracyjnego do konfiguracji adresów Additional IP. Ułatwia to powrót do poprzedniej wersji w przypadku błędu. - -#### Krok 1: określenie interfejsu - -```sh -ip a -``` - -Zanotuj nazwę interfejsu (interfejsu, na którym skonfigurowany jest główny adres IP Twojego serwera). - -#### Krok 2: modyfikacja pliku konfiguracyjnego - -Następnie utwórz plik konfiguracyjny z rozszerzeniem`.yaml`. W naszym przykładzie nasz plik nosi nazwę `51-cloud-init.yaml`. - -```sh -sudo nano /etc/netplan/51-cloud-init.yaml -``` - -Następnie edytuj plik, zastępując polecenia `INTERFACE_NAME` i `ADDITIONAL_IP` własnymi wartościami: - -```yaml -network: - version: 2 - ethernets: - INTERFACE_NAME: - dhcp4: true - addresses: - - ADDITIONAL_IP/32 -``` - -Jeśli chcesz skonfigurować dwa adresy Additional IP, plik konfiguracyjny powinien wyglądać następująco: - -```yaml -network: - version: 2 - ethernets: - INTERFACE_NAME: - dhcp4: true - addresses: - - ADDITIONAL_IP1/32 - - ADDITIONAL_IP2/32 -``` - - -> [!warning] -> -> Pamiętaj, aby zachować wyrównanie każdego elementu w tym pliku, tak jak zostało to pokazane w powyższym przykładzie. Nie należy używać klawisza Tab do tworzenia odstępów. Wymagany jest tylko klawisz spacji. -> - -**Przykład konfiguracji:** - -```yaml -network: - version: 2 - ethernets: - eth0: - dhcp4: true - addresses: - - 203.0.113.1/32 -``` - -Zapisz i zamknij plik. Możesz przetestować konfigurację za pomocą polecenia: - -```sh -sudo netplan try -``` - -#### Krok 3: konfiguracja usługi - -Jeśli jest poprawna, zastosuj ją za pomocą polecenia: - -```sh -sudo netplan apply -``` - -> [!primary] -> Używając polecenia `netplan try`, system może zwrócić komunikat ostrzegawczy, taki jak `Permissions for /etc/netplan/xx-cloud-init.yaml are too open. Netplan configuration should NOT be accessible by others`. Oznacza to po prostu, że plik nie ma ograniczonych uprawnień. Nie ma to wpływu na konfigurację Additional IP. Aby uzyskać więcej informacji na temat uprawnień do plików, zobacz [oficjalną dokumentację Ubuntu](https://help.ubuntu.com/community/FilePermissions). +> [!success] +> Wybierz zakładkę odpowiadającą Twojemu systemowi operacyjnemu. > -### AlmaLinux (8 & 9), Rocky Linux (8 & 9) - -łówny plik konfiguracyjny znajduje się w `/etc/sysconfig/network-scripts/`. W naszym przykładzie nazywa się `ifcfg-eth0`. Przed wprowadzeniem zmian sprawdź rzeczywistą nazwę pliku w tym folderze. - -Dla każdego dodatkowego adresu IP, który ma zostać skonfigurowany, tworzymy oddzielny plik konfiguracyjny z następującymi parametrami: `ifcfg-NETWORK_INTERFACE:ID`. Gdzie `NETWORK_INTERFACE` reprezentuje interfejs fizyczny, a `ID` jest wirtualnym interfejsem sieciowym lub aliasem ethernetowym rozpoczynającym się od wartości 0. Na przykład w przypadku interfejsu o nazwie `eth0` pierwszy alias to `eth0:0`, drugi alias to `eth0:1`, etc... - -#### Krok 1: określenie interfejsu - -```sh -ip a -``` - -Zanotuj nazwę interfejsu (interfejsu, w którym skonfigurowany jest główny adres IP Twojego serwera). - -#### Krok 2: modyfikacja pliku konfiguracyjny - -Zacznij od utworzenia pliku konfiguracyjnego. Zastąp `NETWORK_INTERFACE:ID` własnymi wartościami. - -```sh -sudo nano /etc/sysconfig/network-scripts/ifcfg-NETWORK_INTERFACE:ID -``` - -Następnie zmodyfikuj plik, zastępując `NETWORK_INTERFACE:ID` oraz `ADDITIONAL_IP` własnymi wartościami: - -```console -DEVICE=NETWORK_INTERFACE:ID -ONBOOT=yes -BOOTPROTO=none # For CentOS use "static" -IPADDR=ADDITIONAL_IP -NETMASK=255.255.255.255 -BROADCAST=ADDITIONAL_IP -``` - -**Przykład konfiguracji:** - -```console -DEVICE=eth0:0 -ONBOOT=yes -BOOTPROTO=none # For CentOS use "static" -IPADDR=203.0.113.1 -NETMASK=255.255.255.255 -BROADCAST=203.0.113.1 -``` - -#### Krok 3: restart interfejsu - -Pozostaje tylko zrestartować interfejs: - -```sh -sudo systemctl restart NetworkManager -``` - -### cPanel - -#### Kror 1: dostęp do sekcji Zarządzanie IP WHM - -W Panelu klienta WHM kliknij `IP Functions`{.action} i wybierz `Add a New IP Address`{.action} z menu po lewej stronie. - -![Dodaj nowy adres IP](images/Cpanel-1.png){.thumbnail} - -#### Kror 2: dodaj informacje dotyczące Additional IP - -Wpisz swój adres IP additional w formie "xxx.xxx.xxx.xxx" w polu "New IP or IP range to add". - -Wybierz `255.255.255.255` jako maskę podsieci, po czym kliknij `Submit`{.action}. - -![wprowadź nowe informacje dotyczące nowego adresu IP](images/Cpanel-2024.png){.thumbnail} - -> [!warning] -> -> Uwaga: Jeśli masz kilka adresów IP, które chcesz skonfigurować na tym samym bloku i jednocześnie je dodajesz, system WHM zmusi cię do użycia maski podsieci `255.255.255.0`. Nie zaleca się korzystania z tej konfiguracji, aby każdy adres IP był dodany oddzielnie, aby móc używać odpowiedniej maski podsieci `255.255.255.255`. -> - -#### Kror 3: Sprawdź aktualną konfigurację IP - -W sekcji `IP Functions`{.action} kliknij `Show or Delete Current IP Addresses`{.action}, aby sprawdzić, czy adres Additional IP został poprawnie dodany. - -![check configured IP](images/Cpanel-2024-1.png){.thumbnail} - -### Windows Server - -Serwery pod Windows często wykorzystują DHCP w konfiguracji sieci. Jeśli masz już skonfigurowany adres Additional IP lub zmieniłeś konfigurację na stały adres IP, przejdź od razu do kolejnego kroku. - -Jeśli nie, musisz najpierw zmienić konfigurację sieci z DHCP na stały adres IP. - -Otwórz wiersz poleceń `cmd`{.action} lub `powershell`{.action}, a następnie wpisz poniższe polecenie: - -```powershell -ipconfig -``` - -W rezultacie pojawi się na przykład to: - -![Result of "ipconfig" command](images/ipconfig.png){.thumbnail} - -Spisz następnie Twój adres IPv4, maskę podsieci, bramę domyślną oraz nazwę karty sieciowej. - -Adres IP serwera w naszym przypadku to: **192.0.2.28** - -Kolejne kroki możesz przeprowadzić poprzez wiersz poleceń albo poprzez interfejs graficzny: - -#### W wierszu poleceń (zalecane) - -W poniższych poleceniach należy zastąpić: - -|Polecenie|Wartość| -|---|---| -|NETWORK_ADAPTER| Nazwa karty sieciowej (w naszym przypadku: Ethernet 2)| -|IP_ADDRESS| Adres IP serwera (w naszym przypadku: 192.0.2.28)| -|SUBNET_MASK| Maska podsieci (w naszym przypadku: 255.255.255.0)| -|GATEWAY| Brama domyślna (w naszym przypadku: 192.0.2.254)| -|ADDITIONAL_IP| Adres Additional IP, który chcesz dodać| - -> [!warning] -> -> Uwaga! Jeśli wprowadzisz błędne parametry, serwer przestanie być dostępny. Wówczas trzeba będzie dokonać poprawek w trybie Winrescue lub poprzez KVM. -> - -W wierszu poleceń: - -1\. Zmiana ustawień na stały adres IP - -```powershell -netsh interface ipv4 set address name="NETWORK_ADAPTER" static IP_ADDRESS SUBNET_MASK GATEWAY -``` - -2\. Zdefiniowanie serwera DNS - -```powershell -netsh interface ipv4 set dns name="NETWORK_ADAPTER" static 213.186.33.99 -``` -3\. Dodanie adresu Additional IP - -```powershell -netsh interface ipv4 add address "NETWORK_ADAPTER" ADDITIONAL_IP 255.255.255.255 -``` - -Od tej pory Twój adres Additional IP będzie działać. - -#### Przez interfejs graficzny - -1. Przejdź do menu `Start`{.action} > `Control Panel`{.action} > `Network and Internet`{.action} > `Network and Sharing Centre`{.action} > `Change Adapter Settings`{.action} (w lewym menu). -2. Kliknij prawym przyciskiem myszy połączenie sieciowe w naszym przykładzie `Ethernet 2`{.action}. -3. Kliknij `Properties`{.action}. -4. Wybierz `Internet Protocol Version 4 (TCP/IPv4)`{.action}, a następnie kliknij `Properties`{.action}. -5. Kliknij `Use the following IP address`{.action} i wprowadź dane adresu głównego Twojego serwera, maski podsieci i bramy domyślnej uzyskane powyżej po wpisaniu polecenia `ipconfig`{.action}. (W polu `Preferred DNS Server` wpisz 213.186.33.99.) - -![Internet Protocol Version 4 (TCP/IPv4) Properties](images/configure-main-ip.png){.thumbnail} - -> [!warning] -> -> Uwaga! Jeśli wprowadzisz błędne parametry, serwer przestanie być dostępny. Wówczas trzeba będzie dokonać poprawek w trybie [Winrescue](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) lub poprzez [IPMI](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). -> - -Następnie kliknij `Advanced`{.action} ciągle w `TCP/IP Settings`{.action}. - -![Internet Protocol Version 4 (TCP/IPv4) Properties](images/configure-main-ip-1.png){.thumbnail} - -W sekcji `IP Address`{.action} kliknij `Add`{.action}: - -![Advanced TCP/IPv4 Settings](images/add-additional-ip.png){.thumbnail} - -Następnie wprowadź adres Additional IP oraz maskę podsieci **255.255.255.255**. Następnie kliknij przycisk `Add`{.action}. - -![Advanced TCP/IPv4 Settings](images/configure-additional-ip.png){.thumbnail} - -Kliknij przycisk `OK`{.action}, aby zatwierdzić konfigurację. - -Twój Additional IP działa. Możesz sprawdzić konfigurację za pomocą polecenia: - -```powershell -ipconfig -``` - -Daje to wynik podobny do poniższego przykładu: - -![Final configuration](images/final-ip-configuration.png){.thumbnail} - -### Plesk - -#### Etap 1: dostęp do interfejsu zarządzania adresami IP Plesk - -W panelu konfiguracyjnym Plesk wybierz `Tools & Settings`{.action} na pasku bocznym po lewej stronie. - -![dostęp do zarządzania adresami IP](images/pleskip1.png){.thumbnail} - -Kliknij `IP Addresses`{.action} w **Tools & Settings**. - -#### Etap 2: dodaj dodatkowe informacje IP - -W tej sekcji kliknij przycisk `Add IP Address`{.action}. - -![dodaj informacje IP](images/Plesk-2024.png){.thumbnail} - -Wprowadź adres Additional IP w formie `xxx.xxx.xxx.xxx/32` w polu "IP address and subnet mask", a następnie kliknij `OK`{.action}. - -![dodaj informacje IP](images/Plesk-2024-1.png){.thumbnail} - -#### Etap 3: sprawdź aktualną konfigurację IP - -W sekcji "IP Addresses" sprawdź, czy adres Additional IP został poprawnie dodany. - -![aktualna konfiguracja IP](images/Plesk-2024-2.png){.thumbnail} +> [!tabs] +> Debian 11 +>> **Debian 11** +>> +>> Domyślnie plik konfiguracyjny znajduje się w katalogu`/etc/network/interfaces.d/`. Zaleca się, aby najpierw wykonać kopię zapasową odpowiedniego pliku konfiguracyjnego. +>> +>> Krok 1: tworzenie kopii zapasowej +>> +>> W naszym przykładzie nasz plik nosi nazwę `50-cloud-init`, dlatego kopiujemy plik `50-cloud-init` za pomocą następującego polecenia: +>> +>> ```sh +>> sudo cp /etc/network/interfaces.d/50-cloud-init /etc/network/interfaces.d/50-cloud-init.bak +>> ``` +>> +>> W przypadku błędu będziesz mógł wrócić do poprzedniej wersji za pomocą poniższych poleceń: +>> +>> ```sh +>> sudo rm -f /etc/network/interfaces.d/50-cloud-init +>> sudo cp /etc/network/interfaces.d/50-cloud-init.bak /etc/network/interfaces.d/50-cloud-init +>> ``` +>> +>> Krok 2: modyfikacja pliku konfiguracyjnego +>> +>> > [!primary] +>> > +>> > Nazwy interfejsów sieciowych podane w tym przewodniku mogą różnić się od Twoich. Prosimy o odpowiednie dostosowanie sposobu postępowania. +>> > +>> +>> Teraz można zmodyfikować plik konfiguracyjny: +>> +>> ```sh +>> sudo nano /etc/network/interfaces.d/50-cloud- +>> ``` +>> +>> Następnie dodaj wirtualny interfejs lub alias ethernet. W naszym przykładzie nasz interfejs nosi nazwę `eth0`, więc nasz alias to `eth0:0`. Zrób to dla każdego adresu Additional IP, który chcesz skonfigurować. +>> +>> Nie zmieniaj istniejących linii w pliku konfiguracyjnym, dodaj Additional IP do pliku, jak pokazano poniżej, zastępując `ADDITIONAL_IP/32` oraz wirtualny interfejs (jeśli Twój serwer nie używa **eth0:0**) własnymi wartościami: +>> +>> ```console +>> auto eth0:0 +>> iface eth0:0 inet static +>> address ADDITIONAL_IP +>> netmask 255.255.255.255 +>> ``` +>> +>> Możesz również skonfigurować Additional IP, dodając następujące wiersze poleceń w pliku konfiguracyjnym: +>> +>> ```console +>> post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP netmask 255.255.255.255 broadcast ADDITIONAL_IP +>> pre-down /sbin/ifconfig eth0:0 down +>> ``` +>> +>> W przypadku powyższej konfiguracji wirtualny interfejs jest aktywowany lub dezaktywowany za każdym razem, gdy interfejs `eth0` jest włączony lub wyłączony. +>> +>> Jeśli masz do skonfigurowania dwa adresy Additional IP, plik `/etc/network/interfaces.d/50-cloud-init` musi wyglądać w taki sposób: +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> auto eth0:0 +>> iface eth0:0 inet static +>> address ADDITIONAL_IP1 +>> netmask 255.255.255.255 +>> +>> auto eth0:1 +>> iface eth0:1 inet static +>> address ADDITIONAL_IP2 +>> netmask 255.255.255.255 +>> ``` +>> +>> Lub tak: +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> # IP 1 +>> post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP1 netmask 255.255.255.255 broadcast ADDITIONAL_IP1 +>> pre-down /sbin/ifconfig eth0:0 down +>> +>> # IP 2 +>> post-up /sbin/ifconfig eth0:1 ADDITIONAL_IP2 netmask 255.255.255.255 broadcast ADDITIONAL_IP2 +>> pre-down /sbin/ifconfig eth0:1 down +>> ``` +>> +>> +>> /// details | **Przykład konfiguracji** +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> auto eth0:0 +>> iface eth0:0 inet static +>> address 203.0.113.1 +>> netmask 255.255.255.255 +>> ``` +>> +>> Lub: +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> # IP 1 +>> post-up /sbin/ifconfig eth0:0 203.0.113.1 netmask 255.255.255.255 broadcast 203.0.113.1 +>> pre-down /sbin/ifconfig eth0:0 down +>> ``` +>> /// +>> +>> Krok 3: restart interfejsu +>> +>> Pozostaje tylko zrestartować interfejs: +>> +>> ```sh +>> sudo /etc/init.d/networking restart +>> ``` +>> +> Fedora 41+ +>> **Fedora 41+ i kolejne wersje** +>> +>> Fedora korzysta teraz z kluczowych plików (*keyfiles*). +>> Fedora korzystała wcześniej z profili sieci przechowywanych przez NetworkManager w formacie ifcfg w katalogu `/etc/sysconfig/network-scripts/`.
+>> NetworkManager nie tworzy już domyślnie nowych profili w tym formacie. Plik konfiguracyjny znajduje się w `/etc/NetworkManager/system-connections/`. +>> +>> Krok 1: tworzenie kopii zapasowej +>> +>> > [!primary] +>> > +>> > Pamiętaj, że nazwa pliku sieciowego w naszym przykładzie może różnić się od Twojej. Dostosuj przykłady pod odpowiednią nazwą. +>> > +>> +>> Zaleca się, aby najpierw wykonać kopię zapasową odpowiedniego pliku konfiguracyjnego. W poniższym przykładzie nasz plik konfiguracyjny nosi nazwę `cloud-init-eno1.nmconnection`: +>> +>> ```bash +>> sudo cp -r /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak +>> ``` +>> +>> W przypadku błędu będziesz mógł wrócić do poprzedniej wersji za pomocą poniższych poleceń: +>> +>> ```bash +>> sudo rm -f /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> sudo cp /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> ``` +>> +>> Krok 2: modyfikacja pliku konfiguracyjny +>> +>> > [!primary] +>> > Pamiętaj, że nazwa pliku sieciowego w naszym przykładzie może się różnić od Twojej. Dostosuj polecenia do nazwy pliku. +>> > +>> +>> Aby uzyskać nazwę interfejsu sieciowego umożliwiającą edytowanie odpowiedniego pliku sieciowego, możesz wykonać jedną z następujących czynności: +>> +>> ```sh +>> ip a +>> ``` +>> +>> ```sh +>> nmcli connection show +>> ``` +>> +>> Nie zmieniaj istniejących wierszy w pliku konfiguracyjnym, dodaj Additional IP w następującym pliku, zastępując `ADDITIONAL_IP/32` własnymi wartościami: +>> +>> ```bash +>> sudo nano /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> ``` +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=ADDITIONAL_IP/32 +>> ``` +>> +>> Jeśli masz dwa dodatkowe adresy Additional IP do skonfigurowania, plik konfiguracyjny powinien wyglądać następująco: +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=ADDITIONAL_IP1/32 +>> address2=ADDITIONAL_IP2/32 +>> ``` +>> +>> /// details | **Przykład konfiguracji** +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=203.0.113.1/32 +>> ``` +>> /// +>> +>> Krok 3: restart interfejsu +>> +>> Pozostaje tylko zrestartować interfejs: +>> +>> ```bash +>> sudo systemctl restart NetworkManager +>> ``` +>> +> Debian 12 e Ubuntu 20.04+ +>> **Debian 12, Ubuntu 20.04 i kolejne wersje** +>> +>> Domyślnie pliki konfiguracyjne znajdują się w katalogu`/etc/netplan`. +>> +>> Najlepszym rozwiązaniem jest utworzenie oddzielnego pliku konfiguracyjnego do konfiguracji adresów Additional IP. Ułatwia to powrót do poprzedniej wersji w przypadku błędu. +>> +>> Krok 1: określenie interfejsu +>> +>> ```sh +>> ip a +>> ``` +>> +>> Zanotuj nazwę interfejsu (interfejsu, na którym skonfigurowany jest główny adres IP Twojego serwera). +>> +>> Krok 2: modyfikacja pliku konfiguracyjnego +>> +>> Następnie utwórz plik konfiguracyjny z rozszerzeniem`.yaml`. W naszym przykładzie nasz plik nosi nazwę `51-cloud-init.yaml`. +>> +>> ```sh +>> sudo nano /etc/netplan/51-cloud-init.yaml +>> ``` +>> +>> Następnie edytuj plik, zastępując polecenia `INTERFACE_NAME` i `ADDITIONAL_IP` własnymi wartościami: +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> INTERFACE_NAME: +>> dhcp4: true +>> addresses: +>> - ADDITIONAL_IP/32 +>> ``` +>> +>> Jeśli chcesz skonfigurować dwa adresy Additional IP, plik konfiguracyjny powinien wyglądać następująco: +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> INTERFACE_NAME: +>> dhcp4: true +>> addresses: +>> - ADDITIONAL_IP1/32 +>> - ADDITIONAL_IP2/32 +>> ``` +>> +>> > [!warning] +>> > +>> > Pamiętaj, aby zachować wyrównanie każdego elementu w tym pliku, tak jak zostało to pokazane w powyższym przykładzie. Nie należy używać klawisza Tab do tworzenia odstępów. Wymagany jest tylko klawisz spacji. +>> > +>> +>> /// details | **Przykład konfiguracji** +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> eth0: +>> dhcp4: true +>> addresses: +>> - 203.0.113.1/32 +>> ``` +>> /// +>> +>> Zapisz i zamknij plik. Możesz przetestować konfigurację za pomocą polecenia: +>> +>> ```sh +>> sudo netplan try +>> ``` +>> +>> Krok 3: konfiguracja usługi +>> +>> Jeśli jest poprawna, zastosuj ją za pomocą polecenia: +>> +>> ```sh +>> sudo netplan apply +>> ``` +>> +>> > [!primary] +>> > Używając polecenia `netplan try`, system może zwrócić komunikat ostrzegawczy, taki jak `Permissions for /etc/netplan/xx-cloud-init.yaml are too open. Netplan configuration should NOT be accessible by others`. Oznacza to po prostu, że plik nie ma ograniczonych uprawnień. Nie ma to wpływu na konfigurację Additional IP. Aby uzyskać więcej informacji na temat uprawnień do plików, zobacz [oficjalną dokumentację Ubuntu](https://help.ubuntu.com/community/FilePermissions). +>> > +>> +> AlmaLinux / Rocky Linux +>> **AlmaLinux (8 & 9), Rocky Linux (8 & 9)** +>> +>> łówny plik konfiguracyjny znajduje się w `/etc/sysconfig/network-scripts/`. W naszym przykładzie nazywa się `ifcfg-eth0`. Przed wprowadzeniem zmian sprawdź rzeczywistą nazwę pliku w tym folderze. +>> +>> Dla każdego dodatkowego adresu IP, który ma zostać skonfigurowany, tworzymy oddzielny plik konfiguracyjny z następującymi parametrami: `ifcfg-NETWORK_INTERFACE:ID`. Gdzie `NETWORK_INTERFACE` reprezentuje interfejs fizyczny, a `ID` jest wirtualnym interfejsem sieciowym lub aliasem ethernetowym rozpoczynającym się od wartości 0. Na przykład w przypadku interfejsu o nazwie `eth0` pierwszy alias to `eth0:0`, drugi alias to `eth0:1`, etc... +>> +>> Krok 1: określenie interfejsu +>> +>> ```sh +>> ip a +>> ``` +>> +>> Zanotuj nazwę interfejsu (interfejsu, w którym skonfigurowany jest główny adres IP Twojego serwera). +>> +>> Krok 2: modyfikacja pliku konfiguracyjny +>> +>> Zacznij od utworzenia pliku konfiguracyjnego. Zastąp `NETWORK_INTERFACE:ID` własnymi wartościami. +>> +>> ```sh +>> sudo nano /etc/sysconfig/network-scripts/ifcfg-NETWORK_INTERFACE:ID +>> ``` +>> +>> Następnie zmodyfikuj plik, zastępując `NETWORK_INTERFACE:ID` oraz `ADDITIONAL_IP` własnymi wartościami: +>> +>> ```console +>> DEVICE=NETWORK_INTERFACE:ID +>> ONBOOT=yes +>> BOOTPROTO=none # For CentOS use "static" +>> IPADDR=ADDITIONAL_IP +>> NETMASK=255.255.255.255 +>> BROADCAST=ADDITIONAL_IP +>> ``` +>> +>> /// details | **Przykład konfiguracji** +>> +>> ```console +>> DEVICE=eth0:0 +>> ONBOOT=yes +>> BOOTPROTO=none # For CentOS use "static" +>> IPADDR=203.0.113.1 +>> NETMASK=255.255.255.255 +>> BROADCAST=203.0.113.1 +>> ``` +>> /// +>> +>> Krok 3: restart interfejsu +>> +>> Pozostaje tylko zrestartować interfejs: +>> +>> ```sh +>> sudo systemctl restart NetworkManager +>> ``` +>> +> cPanel +>> **cPanel** +>> +>> Kror 1: dostęp do sekcji Zarządzanie IP WHM +>> +>> W Panelu klienta WHM kliknij `IP Functions`{.action} i wybierz `Add a New IP Address`{.action} z menu po lewej stronie. +>> +>> ![Dodaj nowy adres IP](images/Cpanel-1.png){.thumbnail} +>> +>> Kror 2: dodaj informacje dotyczące Additional IP +>> +>> Wpisz swój adres IP additional w formie "xxx.xxx.xxx.xxx" w polu "New IP or IP range to add". +>> +>> Wybierz `255.255.255.255` jako maskę podsieci, po czym kliknij `Submit`{.action}. +>> +>> ![wprowadź nowe informacje dotyczące nowego adresu IP](images/Cpanel-2024.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Uwaga: Jeśli masz kilka adresów IP, które chcesz skonfigurować na tym samym bloku i jednocześnie je dodajesz, system WHM zmusi cię do użycia maski podsieci `255.255.255.0`. Nie zaleca się korzystania z tej konfiguracji, aby każdy adres IP był dodany oddzielnie, aby móc używać odpowiedniej maski podsieci `255.255.255.255`. +>> > +>> +>> Kror 3: Sprawdź aktualną konfigurację IP +>> +>> W sekcji `IP Functions`{.action} kliknij `Show or Delete Current IP Addresses`{.action}, aby sprawdzić, czy adres Additional IP został poprawnie dodany. +>> +>> ![check configured IP](images/Cpanel-2024-1.png){.thumbnail} +>> +> Windows Server +>> **Windows Server** +>> +>> Serwery pod Windows często wykorzystują DHCP w konfiguracji sieci. Jeśli masz już skonfigurowany adres Additional IP lub zmieniłeś konfigurację na stały adres IP, przejdź od razu do kolejnego kroku. +>> +>> Jeśli nie, musisz najpierw zmienić konfigurację sieci z DHCP na stały adres IP. +>> +>> Otwórz wiersz poleceń `cmd`{.action} lub `powershell`{.action}, a następnie wpisz poniższe polecenie: +>> +>> ``` powershell +>> ipconfig +>> ``` +>> +>> W rezultacie pojawi się na przykład to: +>> +>> ![Result of "ipconfig" command](images/ipconfig.png){.thumbnail} +>> +>> Spisz następnie Twój adres IPv4, maskę podsieci, bramę domyślną oraz nazwę karty sieciowej. +>> +>> Adres IP serwera w naszym przypadku to: **192.0.2.28** +>> +>> Kolejne kroki możesz przeprowadzić poprzez wiersz poleceń albo poprzez interfejs graficzny: +>> +>> **W wierszu poleceń (zalecane)** +>> +>> W poniższych poleceniach należy zastąpić: +>> +>> |Polecenie|Wartość| +>> |---|---| +>> |NETWORK_ADAPTER| Nazwa karty sieciowej (w naszym przypadku: Ethernet 2)| +>> |IP_ADDRESS| Adres IP serwera (w naszym przypadku: 192.0.2.28)| +>> |SUBNET_MASK| Maska podsieci (w naszym przypadku: 255.255.255.0)| +>> |GATEWAY| Brama domyślna (w naszym przypadku: 192.0.2.254)| +>> |ADDITIONAL_IP| Adres Additional IP, który chcesz dodać| +>> +>> > [!warning] +>> > +>> > Uwaga! Jeśli wprowadzisz błędne parametry, serwer przestanie być dostępny. Wówczas trzeba będzie dokonać poprawek w trybie Winrescue lub poprzez KVM. +>> > +>> +>> W wierszu poleceń: +>> +>> 1\. Zmiana ustawień na stały adres IP +>> +>> ```powershell +>> netsh interface ipv4 set address name="NETWORK_ADAPTER" static IP_ADDRESS SUBNET_MASK GATEWAY +>> ``` +>> +>> 2\. Zdefiniowanie serwera DNS +>> +>> ```powershell +>> netsh interface ipv4 set dns name="NETWORK_ADAPTER" static 213.186.33.99 +>> ``` +>> 3\. Dodanie adresu Additional IP +>> +>> ```powershell +>> netsh interface ipv4 add address "NETWORK_ADAPTER" ADDITIONAL_IP 255.255.255.255 +>> ``` +>> +>> Od tej pory Twój adres Additional IP będzie działać. +>> +>> /// details | **Przez interfejs graficzny** +>> +>> 1\. Przejdź do menu `Start`{.action} > `Control Panel`{.action} > `Network and Internet`{.action} > `Network and Sharing Centre`{.action} > `Change Adapter Settings`{.action} (w lewym menu). +>> +>> 2\. Kliknij prawym przyciskiem myszy połączenie sieciowe w naszym przykładzie `Ethernet 2`{.action}. +>> +>> 3\. Kliknij `Properties`{.action}. +>> +>> 4\. Wybierz `Internet Protocol Version 4 (TCP/IPv4)`{.action}, a następnie kliknij `Properties`{.action}. +>> +>> 5\. Kliknij `Use the following IP address`{.action} i wprowadź dane adresu głównego Twojego serwera, maski podsieci i bramy domyślnej uzyskane powyżej po wpisaniu polecenia `ipconfig`{.action}. (W polu `Preferred DNS Server` wpisz 213.186.33.99.) +>> +>> ![Internet Protocol Version 4 (TCP/IPv4) Properties](images/configure-main-ip.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Uwaga! Jeśli wprowadzisz błędne parametry, serwer przestanie być dostępny. Wówczas trzeba będzie dokonać poprawek w trybie [Winrescue](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) lub poprzez [IPMI](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). +>> > +>> +>> Następnie kliknij `Advanced`{.action} ciągle w `TCP/IP Settings`{.action}. +>> +>> ![Internet Protocol Version 4 (TCP/IPv4) Properties](images/configure-main-ip-1.png){.thumbnail} +>> +>> W sekcji `IP Address`{.action} kliknij `Add`{.action}: +>> +>> ![Advanced TCP/IPv4 Settings](images/add-additional-ip.png){.thumbnail} +>> +>> Następnie wprowadź adres Additional IP oraz maskę podsieci **255.255.255.255**. Następnie kliknij przycisk `Add`{.action}. +>> +>> ![Advanced TCP/IPv4 Settings](images/configure-additional-ip.png){.thumbnail} +>> +>> Kliknij przycisk `OK`{.action}, aby zatwierdzić konfigurację. +>> +>> Twój Additional IP działa. Możesz sprawdzić konfigurację za pomocą polecenia: +>> +>> ```powershell +>> ipconfig +>> ``` +>> +>> Daje to wynik podobny do poniższego przykładu: +>> +>> ![Final configuration](images/final-ip-configuration.png){.thumbnail} +>> +>> /// +>> +> Plesk +>> **Plesk** +>> +>> Kror 1: dostęp do interfejsu zarządzania adresami IP Plesk +>> +>> W panelu konfiguracyjnym Plesk wybierz `Tools & Settings`{.action} na pasku bocznym po lewej stronie. +>> +>> ![dostęp do zarządzania adresami IP](images/pleskip1.png){.thumbnail} +>> +>> Kliknij `IP Addresses`{.action} w **Tools & Settings**. +>> +>> Kror 2: dodaj dodatkowe informacje IP +>> +>> W tej sekcji kliknij przycisk `Add IP Address`{.action}. +>> +>> ![dodaj informacje IP](images/Plesk-2024.png){.thumbnail} +>> +>> Wprowadź adres Additional IP w formie `xxx.xxx.xxx.xxx/32` w polu "IP address and subnet mask", a następnie kliknij `OK`{.action}. +>> +>> ![dodaj informacje IP](images/Plesk-2024-1.png){.thumbnail} +>> +>> Kror 3: sprawdź aktualną konfigurację IP +>> +>> W sekcji "IP Addresses" sprawdź, czy adres Additional IP został poprawnie dodany. +>> +>> ![aktualna konfiguracja IP](images/Plesk-2024-2.png){.thumbnail} +>> #### Rozwiązywanie problemów diff --git a/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.pt-pt.md b/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.pt-pt.md index d97af009209..f4f30f2ae62 100644 --- a/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.pt-pt.md +++ b/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/guide.pt-pt.md @@ -1,9 +1,23 @@ --- title: Como configurar um IP alias excerpt: Descubra como adicionar endereços Additional IP à configuração de rede -updated: 2025-07-22 +updated: 2025-11-12 --- + + > [!primary] > Este artigo diz respeito à configuração de endereços Additional IPv4 numa interface pública. Pode igualmente configurar endereços IPv6 nos seus servidores dedicados utilizando [este manual](/pages/bare_metal_cloud/dedicated_servers/network_ipv6). > @@ -55,494 +69,512 @@ As secções seguintes contêm as configurações das distribuições que dispon Nos exemplos abaixo, utilizaremos o editor de texto `nano`. Para alguns sistemas operativos, primeiro é necessário instalá-lo antes de o utilizar. Se for o caso, ser-lhe-á pedido que o faça. Pode, claro, utilizar o editor de texto que preferir. -### Debian 11 - -Por predefinição, o ficheiro de configuração está situado em `/etc/network/interfaces.d/`. Recomendamos começar por realizar uma cópia de segurança do ficheiro de configuração correspondente. - -#### 1 - Fazer cópia do ficheiro de configuração (*source file*) - -No nosso exemplo, o nosso ficheiro chama-se `50-cloud-init`, pelo que copiamos o ficheiro `50-cloud-init` utilizando o seguinte comando: - -```sh -sudo cp /etc/network/interfaces.d/50-cloud-init /etc/network/interfaces.d/50-cloud-init.bak -``` - -Em caso de erro, poderá então reverter a operação através dos seguintes comandos: - -```bash -sudo rm -f /etc/network/interfaces.d/50-cloud-init -sudo cp /etc/network/interfaces.d/50-cloud-init.bak /etc/network/interfaces.d/50-cloud-init -``` - -#### 2 - Editar o ficheiro de configuração - -> [!primary] -> -> Os nomes das interfaces de rede indicados neste manual podem ser diferentes dos seus. Adapte as operações em conformidade. -> - -Já pode modificar o ficheiro de configuração: - - -```sh -sudo nano /etc/network/interfaces.d/50-cloud-init -``` - -De seguida, deverá adicionar uma interface virtual ou um alias ethernet. No nosso exemplo, a nossa interface chama-se `eth0`, pelo que o nosso alias é `eth0:0`. Faça isso para cada endereço Additional IP que deseja configurar. - -Não modifique as linhas existentes no ficheiro de configuração. Adicione simplesmente o seu Additional IP ao ficheiro como indicado abaixo, substituindo `ADDITIONAL_IP/32` assim como a interface virtual (se o seu servidor não utilizar **eth0:0**) pelos seus próprios valores: - -```console -auto eth0:0 -iface eth0:0 inet static -address ADDITIONAL_IP -netmask 255.255.255.255 -``` - -Também pode configurar o seu Additional IP adicionando as seguintes linhas ao ficheiro de configuração: - -```console -post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP netmask 255.255.255.255 broadcast ADDITIONAL_IP -pre-down /sbin/ifconfig eth0:0 down -``` - -Com a configuração acima, a interface virtual é ativada ou desativada sempre que a interface `eth0` é ativada ou desativada. - -Se tem dois Additional IP a configurar, o ficheiro `/etc/network/interfaces.d/50-cloud-init` deve ter o seguinte formato: - -```console -auto eth0 -iface eth0 inet dhcp - -auto eth0:0 -iface eth0:0 inet static -address ADDITIONAL_IP1 -netmask 255.255.255.255 - -auto eth0:1 -iface eth0:1 inet static -address ADDITIONAL_IP2 -netmask 255.255.255.255 -``` - -Ou assim: - -```console -auto eth0 -iface eth0 inet dhcp - -# IP 1 -post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP1 netmask 255.255.255.255 broadcast ADDITIONAL_IP1 -pre-down /sbin/ifconfig eth0:0 down - -# IP 2 -post-up /sbin/ifconfig eth0:1 ADDITIONAL_IP2 netmask 255.255.255.255 broadcast ADDITIONAL_IP2 -pre-down /sbin/ifconfig eth0:1 down -``` - -**Exemplo de configuração:** - -```console -auto eth0 -iface eth0 inet dhcp - -auto eth0:0 -iface eth0:0 inet static -address 203.0.113.1 -netmask 255.255.255.255 -``` - -Ou: - -```console -auto eth0 -iface eth0 inet dhcp - -# IP 1 -post-up /sbin/ifconfig eth0:0 203.0.113.1 netmask 255.255.255.255 broadcast 203.0.113.1 -pre-down /sbin/ifconfig eth0:0 down -``` - -#### 3 - Reiniciar a interface de rede - -Agora, execute este comando para reiniciar a interface: - -```sh -sudo /etc/init.d/networking restart -``` - -### Fedora 39 e versões posteriores - -Fedora utiliza agora ficheiros chave (*keyfiles*). -Fedora utilizava anteriormente perfis de rede armazenados pela NetworkManager no formato ifcfg no diretório `/etc/sysconfig/network-scripts/`.
-Uma vez que o ifcfg se encontra agora em imparidade, NetworkManager não cria de forma padrão os novos perfis neste formato. O ficheiro de configuração encontra-se agora no `/etc/NetworkManager/system-connections/`. - -#### 1 - Fazer cópia do ficheiro de configuração (*source file*) - -> [!primary] -> -> Tenha em atenção que o nome do ficheiro de rede no nosso exemplo pode ser diferente do seu. Adapte os exemplos com o nome apropriado. -> - -Recomendamos começar por realizar uma cópia de segurança do ficheiro de configuração correspondente. No nosso exemplo, o nosso ficheiro de configuração chama-se `cloud-init-eno1.nmconnection`: - -```sh -sudo cp -r /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak -``` - -Em caso de erro, poderá então reverter a operação através dos seguintes comandos: - -```sh -sudo rm -f /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -sudo cp /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -``` - -#### 2 - Editar o ficheiro de configuração - -> [!primary] -> Tenha em conta que o nome do ficheiro de rede no nosso exemplo pode ser diferente do seu. Adapte os comandos ao seu nome de ficheiro. -> - -Para obter o nome da interface de rede para editar o ficheiro de rede adequado, pode executar um dos seguintes comandos: - -```sh -ip a -``` - -```sh -nmcli connection show -``` - -Não altere as linhas existentes no ficheiro de configuração. Adicione o seu Additional IP ao ficheiro da seguinte forma, substituindo `ADDITIONAL_IP/32` pelos seus próprios valores: - -```sh -sudo nano /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -``` - -```console -[ipv4] -method=auto -may-fail=false -address1=ADDITIONAL_IP/32 -``` - -Se tem dois endereços Additional IP a configurar, o ficheiro de configuração deverá ser o seguinte: - -```console -[ipv4] -method=auto -may-fail=false -address1=ADDITIONAL_IP1/32 -address2=ADDITIONAL_IP2/32 -``` - -**Exemplo de configuração:** - -```console -[ipv4] -method=auto -may-fail=false -address1=203.0.113.1/32 -``` - -#### 3 - Reiniciar a interface - -Agora, reinicie a sua interface: - -```sh -sudo systemctl restart NetworkManager -``` - -### Debian 12, Ubuntu 20.04 e versões seguintes - -Por padrão, os arquivos de configuração estão localizados no diretório `/etc/netplan`. - -A melhor abordagem é criar um ficheiro de configuração separado para configurar os endereços Additional IP. Isto permite um retrocesso fácil em caso de erro. - -#### 1 - Determinar a interface - -```sh -ip a -``` - -Anote o nome da interface (a interface na qual está configurado o endereço IP principal do servidor). - -#### 2 - Criar o ficheiro de configuração - -De seguida, crie um ficheiro de configuração com uma extensão `.yaml`. No nosso exemplo, o nosso ficheiro chama-se `51-cloud-init.yaml`. - -```sh -sudo nano /etc/netplan/50-cloud-init.yaml -``` - -De seguida, edite o ficheiro com o conteúdo abaixo, substituindo `INTERFACE_NAME` e `ADDITIONAL_IP` pelos seus próprios valores: - -```yaml -network: - version: 2 - ethernets: - INTERFACE_NAME: - dhcp4: true - addresses: - - ADDITIONAL_IP/32 -``` - -Se tiver dois endereços Additional IP a configurar, o ficheiro de configuração deve ter o seguinte formato: - - -```yaml -network: - version: 2 - ethernets: - INTERFACE_NAME: - dhcp4: true - addresses: - - ADDITIONAL_IP1/32 - - ADDITIONAL_IP2/32 -``` - -> [!warning] -> -> É importante respeitar o alinhamento de cada elemento deste ficheiro, tal como é representado no exemplo acima. Não utilize a tecla de tabulação para criar o seu espaçamento. Apenas é necessário tecla de espaço. -> - -**Exemplo de configuração:** - -```yaml -network: - version: 2 - ethernets: - eth0: - dhcp4: true - addresses: - - 203.0.113.1/32 -``` - -Guarde e feche o ficheiro. Pode testar a configuração com o seguinte comando: - -```sh -sudo netplan try -``` - -#### 3 - Aplicar a alteração - -De seguida, execute os seguintes comandos para aplicar a configuração: - -```sh -sudo netplan apply -``` - -> [!primary] -> Quando utilizar o comando `netplan try`, é possível que o sistema envie uma mensagem de aviso tal como `Permissions for /etc/netplan/xx-cloud-init.yaml are too open. Netplan configuration should NOT be access by others`. Isso simplesmente significa que o arquivo não tem permissões restritivas. Isto não afeta a configuração do seu Additional IP. Para mais informações sobre as permissões dos ficheiros, consulte a [documentação oficial do ubuntu](https://help.ubuntu.com/community/FilePermissions). -> - -### AlmaLinux (8 & 9), Rocky Linux (8 & 9) - - -O ficheiro de configuração principal encontra-se em `/etc/sysconfig/network-scripts/`. No nosso exemplo, é chamado `ifcfg-eth0`. Antes de fazer alterações, verifique o nome real do arquivo nessa pasta. - -Para cada Additional IP a configurar, criamos um ficheiro de configuração separado com os seguintes parâmetros: `ifcfg-NETWORK_INTERFACE:ID`. Onde "NETWORK_INTERFACE" representa a interface física e "ID" é a interface de rede virtual ou o alias ethernet que começa por um valor de 0. Por exemplo, para a nossa interface chamada `eth0`, o primeiro alias é `eth0:0`, o segundo alias é `eth0:1`, etc... - -#### 1 - Determinar a interface - -```sh -ip a -``` - -Anote o nome da interface (aquela em que o endereço IP principal do seu servidor está configurado). - -#### 2 - Criar o ficheiro de configuração - - -Comece por criar o ficheiro de configuração. Substitua `NETWORK_INTERFACE:ID` pelos seus próprios valores. - -```sh -sudo nano /etc/sysconfig/network-scripts/ifcfg-NETWORK_INTERFACE:ID -``` - -De seguida, modifique o ficheiro com o conteúdo abaixo, substituindo `NETWORK_INTERFACE:ID` e `ADDITIONAL_IP` pelos seus próprios valores: - -```console -DEVICE=NETWORK_INTERFACE:ID -ONBOOT=yes -BOOTPROTO=none # For CentOS use "static" -IPADDR=ADDITIONAL_IP -NETMASK=255.255.255.255 -BROADCAST=ADDITIONAL_IP -``` - -**Exemplo de configuração:** - -```console -DEVICE=eth0:0 -ONBOOT=yes -BOOTPROTO=none # For CentOS use "static" -IPADDR=203.0.113.1 -NETMASK=255.255.255.255 -BROADCAST=203.0.113.1 -``` - -#### 3 - Reiniciar a interface - -Agora, reinicie a sua interface: - -```sh -sudo systemctl restart NetworkManager -``` - -### cPanel - -#### 1 - Aceder à secção gestão IP da WHM - -Na Área de Cliente WHM, clique em `IP Functions`{.action} e selecione `Add a New IP Address`{.action} no menu à esquerda. - -![Adicionar um novo endereço IP](images/Cpanel-1.png){.thumbnail} - -#### 2 - Adicionar as informações dos Adicionais IP - -Insira o seu endereço Additional IP sob a forma "xxx.xxx.xxx.xxx" no campo "New IP or IP range to add". - -Selecione `255.255.255.255` como máscara de sub-rede e clique em `Submit`{.action}. - -![indicar novas informações sobre o novo endereço IP](images/Cpanel-2024.png){.thumbnail} - -> [!warning] -> -> Atenção: se tiver vários endereços IP a configurar num bloco e os adicionar ao mesmo tempo, o sistema WHM irá obrigar-lo a utilizar a máscara de sub-rede `255.255.255.0`.Não é recomendado que utilize esta configuração, deve adicionar cada IP individualmente para utilizar a máscara de sub-rede apropriada `255.255.255.255`. -> - -#### 3 - Verificar a configuração IP atual - -De volta para a secção `IP Functions`{.action}, clique em `Show or Delete Current IPs`{.action} para verificar que o endereço Additional IP foi corretamente adicionado. - -![check configurgured IP](images/Cpanel-2024-1.png){.thumbnail} - -### Windows Server - -Os servidores Windows costumam usar a configuração de rede DHCP (configuração predefinida). Caso tenha configurado um Additional IP ou alterado a configuração para usar um IP fixo, ignore esta etapa. - -Se não, tem que alterar a configuração de rede para usar IP fixo em vez da configuração DHCP. - -Abra a linha de comando `cmd`{.action} ou o `powershell`{.action} e introduza este comando: - -```powershell -ipconfig -``` - -A seguir, irá visualizar a seguinte informação: - -![Result of "ipconfig" command](images/ipconfig.png){.thumbnail} - -Guarde os dados relativos ao IPv4, à máscara de sub-rede, ao *gateway* predefinido e ao nome da placa de rede. - -No nosso exemplo, o IP do servidor é: **192.0.2.28** - -Os próximos passos pode ser efetuados através da linha de comandos ou da interface gráfica: - -#### Através da linha de comandos (recomendado) - -Nos comandos indicados abaixo, deve substituir: - -|Comando|Valor| -|---|---| -|NETWORK_ADAPTER| Nome da placa de rede (no nosso exemplo: Local Area Connection)| -|IP_ADDRESS| Endereço IP do servidor (no nosso exemplo: 192.0.2.28)| -|SUBNET_MASK| Máscara de sub-rede (no nosso exemplo: 255.255.255.0)| -|GATEWAY| *Gateway* predefinido (no nosso exemplo: 192.0.2.254)| -|ADDITIONAL_IP| Endereço Additional IP que deseja adicionar| - -> [!warning] -> -> Atenção: se introduzir informação incorreta, o servidor ficará inacessível. Neste caso, terá de usar o modo Winrescue ou o KVM para corrigir os dados. -> - -Execute as seguintes ações na linha de comandos: - -- Passar para IP fixo - -```powershell -netsh interface ipv4 set address name="NETWORK_ADAPTER" static IP_ADDRESS SUBNET_MASK GATEWAY -``` - -- Definir servidor DNS - -```powershell -netsh interface ipv4 set dns name="NETWORK_ADAPTER" static 213.186.33.99 -``` -- Adicionar Additional IP - -```powershell -netsh interface ipv4 add address "NETWORK_ADAPTER" ADDITIONAL_IP 255.255.255.255 -``` - -O Additional IP está a funcionar. - -#### Através da interface gráfica - -1. Aceda ao menu `Start`{.action} > `Control Panel`{.action} > `Network and Internet`{.action} > `Network and Sharing Centre`{.action} > `Change Adapter Settings`{.action} (no menu à esquerda). -2. Clique com o botão direito do rato na sua ligação de rede, no nosso exemplo `Ethernet 2`{.action}. -3. Clique em `Properties`{.action}. -4. Selecione o `Internet Protocol Version 4 (TCP/IPv4)`{.action}, e clique em `Properties`{.action}. -5. Clique em `Use the following IP address`{.action} e introduza o IP principal do servidor, a máscara de sub-rede e o *gateway* predefinido, apresentados após a execução do comando `ipconfig`{.action} (ver exemplo acima). Em `Preferred DNS Server`, introduza 213.186.33.99. - -![Internet Protocol Version 4 (TCP/IPv4) Properties](images/guides-network-ipaliasing-windows-2008-2.png){.thumbnail} - -> [!warning] +> [!success] +> Selecione o separador correspondente ao seu sistema operativo. > -> Atenção: se introduzir informação incorreta, o servidor ficará inacessível. Será obrigado a efetuar as correções em modo [WinRescue](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) ou através do [KVM](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). -> - -Depois, clique em `Advanced`{.action} (nas `TCP/IP Settings`{.action}). - -![Internet Protocol Version 4 (TCP/IPv4) Properties](images/configure-main-ip-1.png){.thumbnail} - -Na parte `IP Address`{.action}, clique em `Add`{.action}: - -![Advanced TCP/IPv4 Settings](images/add-additional-ip.png){.thumbnail} - -Introduza o Additional IP e a máscara de sub-rede **255.255.255.255**. Em seguida, clique em `Add`{.action}. - -![TCP/IP Address](images/configure-additional-ip.png){.thumbnail} - -Clique em `OK`{.action} para validar a sua configuração. - -O seu Additional IP está agora funcional, pode verificar a configuração com o seguinte comando: - -```powershell -ipconfig -``` - -Terá um resultado semelhante ao seguinte exemplo: - -![Final configuration](images/final-ip-configuration.png){.thumbnail} - - -### Plesk - -#### Etapa 1: aceder à gestão de IP do Plesk - -No painel de configuração Plesk, selecione `Tools & Settings`{.action} na barra lateral esquerda. - -![acesso à gestão dos endereços IP](images/pleskip1.png){.thumbnail} - -Clique em `IP Addresses`{.action} em **Tools & Settings**. - -#### Etapa 2: adicionar informações IP suplementares - -Nesta secção, clique no botão `Add IP Address`{.action}. - -![adicionar informações IP](images/Plesk-2024.png){.thumbnail} - -Introduza o seu endereço Additional IP sob a forma `xxx.xxx.xxx.xxx/32` no campo "IP address and subnet mask", e clique em `OK`{.action}. - -![adicionar informações IP](images/Plesk-2024-1.png){.thumbnail} - -#### Etapa 3: verificar a configuração IP atual - -Na secção "IP Addresses", verifique se o endereço Additional IP foi adicionado corretamente. - -![configuração IP atual](images/Plesk-2024-2.png){.thumbnail} +> [!tabs] +> Debian 11 +>> **Debian 11** +>> +>> Por predefinição, o ficheiro de configuração está situado em `/etc/network/interfaces.d/`. Recomendamos começar por realizar uma cópia de segurança do ficheiro de configuração correspondente. +>> +>> 1 - Fazer cópia do ficheiro de configuração (*source file*) +>> +>> No nosso exemplo, o nosso ficheiro chama-se `50-cloud-init`, pelo que copiamos o ficheiro `50-cloud-init` utilizando o seguinte comando: +>> +>> ```sh +>> sudo cp /etc/network/interfaces.d/50-cloud-init /etc/network/interfaces.d/50-cloud-init.bak +>> ``` +>> +>> Em caso de erro, poderá então reverter a operação através dos seguintes comandos: +>> +>> ```bash +>> sudo rm -f /etc/network/interfaces.d/50-cloud-init +>> sudo cp /etc/network/interfaces.d/50-cloud-init.bak /etc/network/interfaces.d/50-cloud-init +>> ``` +>> +>> 2 - Editar o ficheiro de configuração +>> +>> > [!primary] +>> > +>> > Os nomes das interfaces de rede indicados neste manual podem ser diferentes dos seus. Adapte as operações em conformidade. +>> > +>> +>> Já pode modificar o ficheiro de configuração: +>> +>> ```sh +>> sudo nano /etc/network/interfaces.d/50-cloud-init +>> ``` +>> +>> De seguida, deverá adicionar uma interface virtual ou um alias ethernet. No nosso exemplo, a nossa interface chama-se `eth0`, pelo que o nosso alias é `eth0:0`. Faça isso para cada endereço Additional IP que deseja configurar. +>> +>> Não modifique as linhas existentes no ficheiro de configuração. Adicione simplesmente o seu Additional IP ao ficheiro como indicado abaixo, substituindo `ADDITIONAL_IP/32` assim como a interface virtual (se o seu servidor não utilizar **eth0:0**) pelos seus próprios valores: +>> +>> ```console +>> auto eth0:0 +>> iface eth0:0 inet static +>> address ADDITIONAL_IP +>> netmask 255.255.255.255 +>> ``` +>> +>> Também pode configurar o seu Additional IP adicionando as seguintes linhas ao ficheiro de configuração: +>> +>> ```console +>> post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP netmask 255.255.255.255 broadcast ADDITIONAL_IP +>> pre-down /sbin/ifconfig eth0:0 down +>> ``` +>> +>> Com a configuração acima, a interface virtual é ativada ou desativada sempre que a interface `eth0` é ativada ou desativada. +>> +>> Se tem dois Additional IP a configurar, o ficheiro `/etc/network/interfaces.d/50-cloud-init` deve ter o seguinte formato: +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> auto eth0:0 +>> iface eth0:0 inet static +>> address ADDITIONAL_IP1 +>> netmask 255.255.255.255 +>> +>> auto eth0:1 +>> iface eth0:1 inet static +>> address ADDITIONAL_IP2 +>> netmask 255.255.255.255 +>> ``` +>> +>> Ou assim: +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> # IP 1 +>> post-up /sbin/ifconfig eth0:0 ADDITIONAL_IP1 netmask 255.255.255.255 broadcast ADDITIONAL_IP1 +>> pre-down /sbin/ifconfig eth0:0 down +>> +>> # IP 2 +>> post-up /sbin/ifconfig eth0:1 ADDITIONAL_IP2 netmask 255.255.255.255 broadcast ADDITIONAL_IP2 +>> pre-down /sbin/ifconfig eth0:1 down +>> ``` +>> +>> /// details | **Exemplo de configuração** +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> auto eth0:0 +>> iface eth0:0 inet static +>> address 203.0.113.1 +>> netmask 255.255.255.255 +>> ``` +>> +>> Ou: +>> +>> ```console +>> auto eth0 +>> iface eth0 inet dhcp +>> +>> # IP 1 +>> post-up /sbin/ifconfig eth0:0 203.0.113.1 netmask 255.255.255.255 broadcast 203.0.113.1 +>> pre-down /sbin/ifconfig eth0:0 down +>> ``` +>> /// +>> +>> 3 - Reiniciar a interface de rede +>> +>> Agora, execute este comando para reiniciar a interface: +>> +>> ```sh +>> sudo /etc/init.d/networking restart +>> ``` +>> +> Fedora 41+ +>> **Fedora 41 e versões posteriores** +>> +>> Fedora utiliza agora ficheiros chave (*keyfiles*). +>> Fedora utilizava anteriormente perfis de rede armazenados pela NetworkManager no formato ifcfg no diretório `/etc/sysconfig/network-scripts/`.
+>> Uma vez que o ifcfg se encontra agora em imparidade, NetworkManager não cria de forma padrão os novos perfis neste formato. O ficheiro de configuração encontra-se agora no `/etc/NetworkManager/system-connections/`. +>> +>> 1 - Fazer cópia do ficheiro de configuração (*source file*) +>> +>> > [!primary] +>> > +>> > Tenha em atenção que o nome do ficheiro de rede no nosso exemplo pode ser diferente do seu. Adapte os exemplos com o nome apropriado. +>> > +>> +>> Recomendamos começar por realizar uma cópia de segurança do ficheiro de configuração correspondente. No nosso exemplo, o nosso ficheiro de configuração chama-se `cloud-init-eno1.nmconnection`: +>> +>> ```sh +>> sudo cp -r /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak +>> ``` +>> +>> Em caso de erro, poderá então reverter a operação através dos seguintes comandos: +>> +>> ```sh +>> sudo rm -f /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> sudo cp /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> ``` +>> +>> 2 - Editar o ficheiro de configuração +>> +>> > [!primary] +>> > Tenha em conta que o nome do ficheiro de rede no nosso exemplo pode ser diferente do seu. Adapte os comandos ao seu nome de ficheiro. +>> > +>> +>> Para obter o nome da interface de rede para editar o ficheiro de rede adequado, pode executar um dos seguintes comandos: +>> +>> ```sh +>> ip a +>> ``` +>> +>> ```sh +>> nmcli connection show +>> ``` +>> +>> Não altere as linhas existentes no ficheiro de configuração. Adicione o seu Additional IP ao ficheiro da seguinte forma, substituindo `ADDITIONAL_IP/32` pelos seus próprios valores: +>> +>> ```sh +>> sudo nano /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> ``` +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=ADDITIONAL_IP/32 +>> ``` +>> +>> Se tem dois endereços Additional IP a configurar, o ficheiro de configuração deverá ser o seguinte: +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=ADDITIONAL_IP1/32 +>> address2=ADDITIONAL_IP2/32 +>> ``` +>> +>> /// details | **Exemplo de configuração** +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=203.0.113.1/32 +>> ``` +>> /// +>> +>> 3 - Reiniciar a interface +>> +>> Agora, reinicie a sua interface: +>> +>> ```sh +>> sudo systemctl restart NetworkManager +>> ``` +>> +> Debian 12 e Ubuntu 20.04+ +>> **Debian 12, Ubuntu 20.04 e versões seguintes** +>> +>> Por padrão, os arquivos de configuração estão localizados no diretório `/etc/netplan`. +>> +>> A melhor abordagem é criar um ficheiro de configuração separado para configurar os endereços Additional IP. Isto permite um retrocesso fácil em caso de erro. +>> +>> 1 - Determinar a interface +>> +>> ```sh +>> ip a +>> ``` +>> +>> Anote o nome da interface (a interface na qual está configurado o endereço IP principal do servidor). +>> +>> 2 - Criar o ficheiro de configuração +>> +>> De seguida, crie um ficheiro de configuração com uma extensão `.yaml`. No nosso exemplo, o nosso ficheiro chama-se `51-cloud-init.yaml`. +>> +>> ```sh +>> sudo nano /etc/netplan/50-cloud-init.yaml +>> ``` +>> +>> De seguida, edite o ficheiro com o conteúdo abaixo, substituindo `INTERFACE_NAME` e `ADDITIONAL_IP` pelos seus próprios valores: +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> INTERFACE_NAME: +>> dhcp4: true +>> addresses: +>> - ADDITIONAL_IP/32 +>> ``` +>> +>> Se tiver dois endereços Additional IP a configurar, o ficheiro de configuração deve ter o seguinte formato: +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> INTERFACE_NAME: +>> dhcp4: true +>> addresses: +>> - ADDITIONAL_IP1/32 +>> - ADDITIONAL_IP2/32 +>> ``` +>> +>> > [!warning] +>> > +>> > É importante respeitar o alinhamento de cada elemento deste ficheiro, tal como é representado no exemplo acima. Não utilize a tecla de tabulação para criar o seu espaçamento. Apenas é necessário tecla de espaço. +>> > +>> +>> /// details | **Exemplo de configuração** +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> eth0: +>> dhcp4: true +>> addresses: +>> - 203.0.113.1/32 +>> ``` +>> /// +>> +>> Guarde e feche o ficheiro. Pode testar a configuração com o seguinte comando: +>> +>> ```sh +>> sudo netplan try +>> ``` +>> +>> 3 - Aplicar a alteração +>> +>> De seguida, execute os seguintes comandos para aplicar a configuração: +>> +>> ```sh +>> sudo netplan apply +>> ``` +>> +>> > [!primary] +>> > Quando utilizar o comando `netplan try`, é possível que o sistema envie uma mensagem de aviso tal como `Permissions for /etc/netplan/xx-cloud-init.yaml are too open. Netplan configuration should NOT be access by others`. Isso simplesmente significa que o arquivo não tem permissões restritivas. Isto não afeta a configuração do seu Additional IP. Para mais informações sobre as permissões dos ficheiros, consulte a [documentação oficial do ubuntu](https://help.ubuntu.com/community/FilePermissions). +>> > +>> +> AlmaLinux / Rocky Linux +>> **AlmaLinux (8 & 9), Rocky Linux (8 & 9)** +>> +>> O ficheiro de configuração principal encontra-se em `/etc/sysconfig/network-scripts/`. No nosso exemplo, é chamado `ifcfg-eth0`. Antes de fazer alterações, verifique o nome real do arquivo nessa pasta. +>> +>> Para cada Additional IP a configurar, criamos um ficheiro de configuração separado com os seguintes parâmetros: `ifcfg-NETWORK_INTERFACE:ID`. Onde "NETWORK_INTERFACE" representa a interface física e "ID" é a interface de rede virtual ou o alias ethernet que começa por um valor de 0. Por exemplo, para a nossa interface chamada `eth0`, o primeiro alias é `eth0:0`, o segundo alias é `eth0:1`, etc... +>> +>> 1 - Determinar a interface +>> +>> ```sh +>> ip a +>> ``` +>> +>> Anote o nome da interface (aquela em que o endereço IP principal do seu servidor está configurado). +>> +>> 2 - Criar o ficheiro de configuração +>> +>> Comece por criar o ficheiro de configuração. Substitua `NETWORK_INTERFACE:ID` pelos seus próprios valores. +>> +>> ```sh +>> sudo nano /etc/sysconfig/network-scripts/ifcfg-NETWORK_INTERFACE:ID +>> ``` +>> +>> De seguida, modifique o ficheiro com o conteúdo abaixo, substituindo `NETWORK_INTERFACE:ID` e `ADDITIONAL_IP` pelos seus próprios valores: +>> +>> ```console +>> DEVICE=NETWORK_INTERFACE:ID +>> ONBOOT=yes +>> BOOTPROTO=none # For CentOS use "static" +>> IPADDR=ADDITIONAL_IP +>> NETMASK=255.255.255.255 +>> BROADCAST=ADDITIONAL_IP +>> ``` +>> +>> +>> /// details | **Exemplo de configuração** +>> +>> ```console +>> DEVICE=eth0:0 +>> ONBOOT=yes +>> BOOTPROTO=none # For CentOS use "static" +>> IPADDR=203.0.113.1 +>> NETMASK=255.255.255.255 +>> BROADCAST=203.0.113.1 +>> ``` +>> /// +>> +>> 3 - Reiniciar a interface +>> +>> Agora, reinicie a sua interface: +>> +>> ```sh +>> sudo systemctl restart NetworkManager +>> ``` +>> +> cPanel +>> **cPanel** +>> +>> 1 - Aceder à secção gestão IP da WHM +>> +>> Na Área de Cliente WHM, clique em `IP Functions`{.action} e selecione `Add a New IP Address`{.action} no menu à esquerda. +>> +>> ![Adicionar um novo endereço IP](images/Cpanel-1.png){.thumbnail} +>> +>> 2 - Adicionar as informações dos Adicionais IP +>> +>> Insira o seu endereço Additional IP sob a forma "xxx.xxx.xxx.xxx" no campo "New IP or IP range to add". +>> +>> Selecione `255.255.255.255` como máscara de sub-rede e clique em `Submit`{.action}. +>> +>> ![indicar novas informações sobre o novo endereço IP](images/Cpanel-2024.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Atenção: se tiver vários endereços IP a configurar num bloco e os adicionar ao mesmo tempo, o sistema WHM irá obrigar-lo a utilizar a máscara de sub-rede `255.255.255.0`.Não é recomendado que utilize esta configuração, deve adicionar cada IP individualmente para utilizar a máscara de sub-rede apropriada `255.255.255.255`. +>> > +>> +>> 3 - Verificar a configuração IP atual +>> +>> De volta para a secção `IP Functions`{.action}, clique em `Show or Delete Current IPs`{.action} para verificar que o endereço Additional IP foi corretamente adicionado. +>> +>> ![check configurgured IP](images/Cpanel-2024-1.png){.thumbnail} +>> +> Windows Server +>> **Windows Server** +>> +>> Os servidores Windows costumam usar a configuração de rede DHCP (configuração predefinida). Caso tenha configurado um Additional IP ou alterado a configuração para usar um IP fixo, ignore esta etapa. +>> +>> Se não, tem que alterar a configuração de rede para usar IP fixo em vez da configuração DHCP. +>> +>> Abra a linha de comando `cmd`{.action} ou o `powershell`{.action} e introduza este comando: +>> +>> ```powershell +>> ipconfig +>> ``` +>> +>> A seguir, irá visualizar a seguinte informação: +>> +>> ![Result of "ipconfig" command](images/ipconfig.png){.thumbnail} +>> +>> Guarde os dados relativos ao IPv4, à máscara de sub-rede, ao *gateway* predefinido e ao nome da placa de rede. +>> +>> No nosso exemplo, o IP do servidor é: **192.0.2.28** +>> +>> Os próximos passos pode ser efetuados através da linha de comandos ou da interface gráfica: +>> +>> **Através da linha de comandos (recomendado)** +>> +>> Nos comandos indicados abaixo, deve substituir: +>> +>> |Comando|Valor| +>> |---|---| +>> |NETWORK_ADAPTER| Nome da placa de rede (no nosso exemplo: Local Area Connection)| +>> |IP_ADDRESS| Endereço IP do servidor (no nosso exemplo: 192.0.2.28)| +>> |SUBNET_MASK| Máscara de sub-rede (no nosso exemplo: 255.255.255.0)| +>> |GATEWAY| *Gateway* predefinido (no nosso exemplo: 192.0.2.254)| +>> |ADDITIONAL_IP| Endereço Additional IP que deseja adicionar| +>> +>> > [!warning] +>> > +>> > Atenção: se introduzir informação incorreta, o servidor ficará inacessível. Neste caso, terá de usar o modo Winrescue ou o KVM para corrigir os dados. +>> > +>> +>> Execute as seguintes ações na linha de comandos: +>> +>> - Passar para IP fixo +>> +>> ```powershell +>> netsh interface ipv4 set address name="NETWORK_ADAPTER" static IP_ADDRESS SUBNET_MASK GATEWAY +>> ``` +>> +>> - Definir servidor DNS +>> +>> ```powershell +>> netsh interface ipv4 set dns name="NETWORK_ADAPTER" static 213.186.33.99 +>> ``` +>> - Adicionar Additional IP +>> +>> ```powershell +>> netsh interface ipv4 add address "NETWORK_ADAPTER" ADDITIONAL_IP 255.255.255.255 +>> ``` +>> +>> O Additional IP está a funcionar. +>> +>> /// details | **Através da interface gráfica** +>> +>> 1\. Aceda ao menu `Start`{.action} > `Control Panel`{.action} > `Network and Internet`{.action} > `Network and Sharing Centre`{.action} > `Change Adapter Settings`{.action} (no menu à esquerda). +>> +>> 2\. Clique com o botão direito do rato na sua ligação de rede, no nosso exemplo `Ethernet 2`{.action}. +>> +>> 3\. Clique em `Properties`{.action}. +>> +>> 4\. Selecione o `Internet Protocol Version 4 (TCP/IPv4)`{.action}, e clique em `Properties`{.action}. +>> +>> 5\. Clique em `Use the following IP address`{.action} e introduza o IP principal do servidor, a máscara de sub-rede e o *gateway* predefinido, apresentados após a execução do comando `ipconfig`{.action} (ver exemplo acima). Em `Preferred DNS Server`, introduza 213.186.33.99. +>> +>> ![Internet Protocol Version 4 (TCP/IPv4) Properties](images/guides-network-ipaliasing-windows-2008-2.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Atenção: se introduzir informação incorreta, o servidor ficará inacessível. Será obrigado a efetuar as correções em modo [WinRescue](/pages/bare_metal_cloud/dedicated_servers/rescue_mode#windows) ou através do [KVM](/pages/bare_metal_cloud/dedicated_servers/using_ipmi_on_dedicated_servers). +>> > +>> +>> Depois, clique em `Advanced`{.action} (nas `TCP/IP Settings`{.action}). +>> +>> ![Internet Protocol Version 4 (TCP/IPv4) Properties](images/configure-main-ip-1.png){.thumbnail} +>> +>> Na parte `IP Address`{.action}, clique em `Add`{.action}: +>> +>> ![Advanced TCP/IPv4 Settings](images/add-additional-ip.png){.thumbnail} +>> +>> Introduza o Additional IP e a máscara de sub-rede **255.255.255.255**. Em seguida, clique em `Add`{.action}. +>> +>> ![TCP/IP Address](images/configure-additional-ip.png){.thumbnail} +>> +>> Clique em `OK`{.action} para validar a sua configuração. +>> +>> O seu Additional IP está agora funcional, pode verificar a configuração com o seguinte comando: +>> +>> ```powershell +>> ipconfig +>> ``` +>> +>> Terá um resultado semelhante ao seguinte exemplo: +>> +>> ![Final configuration](images/final-ip-configuration.png){.thumbnail} +>> +>> /// +>> +> Plesk +>> **Plesk** +>> +>> 1 - aceder à gestão de IP do Plesk +>> +>> No painel de configuração Plesk, selecione `Tools & Settings`{.action} na barra lateral esquerda. +>> +>> ![acesso à gestão dos endereços IP](images/pleskip1.png){.thumbnail} +>> +>> Clique em `IP Addresses`{.action} em **Tools & Settings**. +>> +>> 2 - adicionar informações IP suplementares +>> +>> Nesta secção, clique no botão `Add IP Address`{.action}. +>> +>> ![adicionar informações IP](images/Plesk-2024.png){.thumbnail} +>> +>> Introduza o seu endereço Additional IP sob a forma `xxx.xxx.xxx.xxx/32` no campo "IP address and subnet mask", e clique em `OK`{.action}. +>> +>> ![adicionar informações IP](images/Plesk-2024-1.png){.thumbnail} +>> +>> 3 - verificar a configuração IP atual +>> +>> Na secção "IP Addresses", verifique se o endereço Additional IP foi adicionado corretamente. +>> +>> ![configuração IP atual](images/Plesk-2024-2.png){.thumbnail} +>> ### Resolução das deficiências diff --git a/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/images/Cpanel-2.png b/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/images/Cpanel-2.png deleted file mode 100644 index 7bb5fb6c9a7..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/images/Cpanel-2.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/images/Cpanel-3.png b/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/images/Cpanel-3.png deleted file mode 100644 index 4cf1ad0593a..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/images/Cpanel-3.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/images/guides-network-ipaliasing-windows-2008-1.png b/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/images/guides-network-ipaliasing-windows-2008-1.png deleted file mode 100644 index c8e899e8252..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/images/guides-network-ipaliasing-windows-2008-1.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/images/guides-network-ipaliasing-windows-2008-2.0.png b/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/images/guides-network-ipaliasing-windows-2008-2.0.png deleted file mode 100644 index 32e1d3f4510..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/images/guides-network-ipaliasing-windows-2008-2.0.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/images/guides-network-ipaliasing-windows-2008-3.png b/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/images/guides-network-ipaliasing-windows-2008-3.png deleted file mode 100644 index c575fcdc434..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/images/guides-network-ipaliasing-windows-2008-3.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/images/guides-network-ipaliasing-windows-2008-4.png b/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/images/guides-network-ipaliasing-windows-2008-4.png deleted file mode 100644 index 3d786529f2f..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/network_ipaliasing/images/guides-network-ipaliasing-windows-2008-4.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.de-de.md b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.de-de.md index b651f00229a..78fd331d9db 100644 --- a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.de-de.md +++ b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.de-de.md @@ -1,7 +1,7 @@ --- title: Monitoring von DDoS-Angriffen mit dem Network Security Dashboard excerpt: Erfahren Sie hier, wie Sie das Network Security Dashboard im OVHcloud Kundencenter verwenden -updated: 2025-09-08 +updated: 2025-10-31 --- ## Ziel @@ -78,6 +78,8 @@ In der Tabelle sind die folgenden Spalten vorhanden: - **Ziel-IP** - Die IP, die Ziel des Angriffs war - **Angriffsvektoren** - Stellt Informationen über erkannte Angriffstypen bereit, wie UDP- oder TCP-Angriffe etc. +**Die Aufbewahrungsfrist für die Log-Dateien des Scrubbing-Centers beträgt 1 Jahr.** + > [!warning] > > Beachten Sie, dass Quell-IP-Adressen für erkannte Ereignisse nicht angezeigt werden, da sie in der Regel gefälscht sind (DDoS-Angriffe können auf Quellen verweisen, von denen Sie nicht stammen). Solche Informationen wären also irreführend oder nicht verwendbar. @@ -89,6 +91,8 @@ Auf **Traffic Chart** sehen Sie ein Diagramm, das den Traffic zu Ihrer IP-Adress Sie zeigt schädlichen Datenverkehr, der verworfen wurde (**in rot**) und gesäuberten Datenverkehr, der an Ihre IP-Adresse übertragen wurde (**in grün**). Darüber hinaus werden grundlegende Abwehrstatistiken angezeigt, z.B. wie viele Angriffe für eine ausgewählte IP entdeckt wurden, wie viel Traffic (oder Pakete) während der Angriffe gesäubert wurde oder wie oft die Scrubbing Center in einem bestimmten Zeitraum eine Aktion zur Überprüfung Ihres Traffics (Anzahl der Ereignisse) durchgeführt haben. +**Die Aufbewahrungsfrist für den Traffic-Chart beträgt 2 Monate.** + ## FAQ ### Warum werden nicht alle Angriffe auf das Network Security Dashboard angezeigt? @@ -108,7 +112,7 @@ Solche Daten stehen nur für öffentliche IP-Adressen zur Verfügung, wenn autom ### Das Traffic-Diagramm ist für einige Positionen in den Scrubbing Center-Protokollen nicht verfügbar. -Traffic-Chart-Daten sind nur für die letzten zwei Wochen verfügbar, während Log-Einträge für das vergangene Jahr überprüft werden können. +Traffic-Chart-Daten sind nur für die letzten zwei Monate verfügbar, während Log-Einträge für das letzte Jahr überprüft werden können. ### Ein Angriff auf meinen Dienst hält an. Wie kann ich meinen Server besser schützen? diff --git a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.en-asia.md b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.en-asia.md index adb7c89bb09..650eec226da 100644 --- a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.en-asia.md +++ b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.en-asia.md @@ -1,7 +1,7 @@ --- title: "Monitoring DDoS attacks with the Network Security Dashboard" excerpt: "Learn how to navigate through the Network Security Dashboard" -updated: 2025-09-08 +updated: 2025-10-31 --- ## Objective @@ -78,6 +78,8 @@ In the table, the following columns are present: - **Destination IP** - The IP that was the target of the attack - **Attack vectors** - Provides information about detected types of attacks, such as UDP or TCP attack, etc. +**The data retention period for scrubbing centre logs is 1 year.** + > [!warning] > > Please note that source IP addresses for detected events are not displayed because they are usually spoofed (DDoS attacks may point to other sources than the ones really comes from) and such information would be misleading or not usable. @@ -89,6 +91,8 @@ In the **Traffic chart** tab, you can see a graph showing traffic to your IP add It presents malicious traffic that was dropped (**in red**) and clean traffic delivered to your IP address (**in green**). There are also basic mitigation statistics displayed, i.e.: how many attacks were detected for a selected IP, how much traffic (or packets) was cleaned during attacks or how many times scrubbing centres took an action to inspect your traffic (number of events) in a selected period of time. +**The data retention period for the traffic chart is 2 months.** + ## FAQ ### Why do I see not all of the attacks on the Network Security Dashboard? @@ -108,7 +112,7 @@ Such data is available only for public IP addresses during automatic Anti-DDoS i ### The traffic chart for some positions in the scrubbing centre logs is not available. -Traffic chart data is available only for the past two weeks, while log entries can be reviewed for the past year. +Traffic chart data is available only for the past two months, while log entries can be reviewed for the past year. ### An attack on my service is persisting, how can I better protect my server? @@ -165,4 +169,4 @@ In any case where adjustments to our Anti-DDoS system will be necessary, it is m [Protecting a game server with the application firewall](/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos) -Join our [community of users](/links/community). \ No newline at end of file +Join our [community of users](/links/community). diff --git a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.en-au.md b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.en-au.md index 69894e482a4..c308e51edd2 100644 --- a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.en-au.md +++ b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.en-au.md @@ -1,7 +1,7 @@ --- title: "Monitoring DDoS attacks with the Network Security Dashboard" excerpt: "Learn how to navigate through the Network Security Dashboard" -updated: 2025-09-08 +updated: 2025-10-31 --- ## Objective @@ -78,6 +78,8 @@ In the table, the following columns are present: - **Destination IP** - The IP that was the target of the attack - **Attack vectors** - Provides information about detected types of attacks, such as UDP or TCP attack, etc. +**The data retention period for scrubbing centre logs is 1 year.** + > [!warning] > > Please note that source IP addresses for detected events are not displayed because they are usually spoofed (DDoS attacks may point to other sources than the ones really comes from) and such information would be misleading or not usable. @@ -89,6 +91,8 @@ In the **Traffic chart** tab, you can see a graph showing traffic to your IP add It presents malicious traffic that was dropped (**in red**) and clean traffic delivered to your IP address (**in green**). There are also basic mitigation statistics displayed, i.e.: how many attacks were detected for a selected IP, how much traffic (or packets) was cleaned during attacks or how many times scrubbing centres took an action to inspect your traffic (number of events) in a selected period of time. +**The data retention period for the traffic chart is 2 months.** + ## FAQ ### Why do I see not all of the attacks on the Network Security Dashboard? @@ -108,7 +112,7 @@ Such data is available only for public IP addresses during automatic Anti-DDoS i ### The traffic chart for some positions in the scrubbing centre logs is not available. -Traffic chart data is available only for the past two weeks, while log entries can be reviewed for the past year. +Traffic chart data is available only for the past two months, while log entries can be reviewed for the past year. ### An attack on my service is persisting, how can I better protect my server? @@ -165,4 +169,4 @@ In any case where adjustments to our Anti-DDoS system will be necessary, it is m [Protecting a game server with the application firewall](/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos) -Join our [community of users](/links/community). \ No newline at end of file +Join our [community of users](/links/community). diff --git a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.en-ca.md b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.en-ca.md index 1547b8b30c6..6d3f15e0b90 100644 --- a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.en-ca.md +++ b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.en-ca.md @@ -1,7 +1,7 @@ --- title: "Monitoring DDoS attacks with the Network Security Dashboard" excerpt: "Learn how to navigate through the Network Security Dashboard" -updated: 2025-09-08 +updated: 2025-10-31 --- ## Objective @@ -78,6 +78,8 @@ In the table, the following columns are present: - **Destination IP** - The IP that was the target of the attack - **Attack vectors** - Provides information about detected types of attacks, such as UDP or TCP attack, etc. +**The data retention period for scrubbing centre logs is 1 year.** + > [!warning] > > Please note that source IP addresses for detected events are not displayed because they are usually spoofed (DDoS attacks may point to other sources than the ones really comes from) and such information would be misleading or not usable. @@ -89,6 +91,8 @@ In the **Traffic chart** tab, you can see a graph showing traffic to your IP add It presents malicious traffic that was dropped (**in red**) and clean traffic delivered to your IP address (**in green**). There are also basic mitigation statistics displayed, i.e.: how many attacks were detected for a selected IP, how much traffic (or packets) was cleaned during attacks or how many times scrubbing centres took an action to inspect your traffic (number of events) in a selected period of time. +**The data retention period for the traffic chart is 2 months.** + ## FAQ ### Why do I see not all of the attacks on the Network Security Dashboard? @@ -108,7 +112,7 @@ Such data is available only for public IP addresses during automatic Anti-DDoS i ### The traffic chart for some positions in the scrubbing centre logs is not available. -Traffic chart data is available only for the past two weeks, while log entries can be reviewed for the past year. +Traffic chart data is available only for the past two months, while log entries can be reviewed for the past year. ### An attack on my service is persisting, how can I better protect my server? @@ -165,4 +169,4 @@ In any case where adjustments to our Anti-DDoS system will be necessary, it is m [Protecting a game server with the application firewall](/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos) -Join our [community of users](/links/community). \ No newline at end of file +Join our [community of users](/links/community). diff --git a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.en-gb.md b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.en-gb.md index 2057f74ca4e..de0b2c1312c 100644 --- a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.en-gb.md +++ b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.en-gb.md @@ -1,7 +1,7 @@ --- title: "Monitoring DDoS attacks with the Network Security Dashboard" excerpt: "Learn how to navigate through the Network Security Dashboard" -updated: 2025-09-08 +updated: 2025-10-31 --- ## Objective @@ -78,6 +78,8 @@ In the table, the following columns are present: - **Destination IP** - The IP that was the target of the attack - **Attack vectors** - Provides information about detected types of attacks, such as UDP or TCP attack, etc. +**The data retention period for scrubbing centre logs is 1 year.** + > [!warning] > > Please note that source IP addresses for detected events are not displayed because they are usually spoofed (DDoS attacks may point to other sources than the ones really comes from) and such information would be misleading or not usable. @@ -89,6 +91,8 @@ In the **Traffic chart** tab, you can see a graph showing traffic to your IP add It presents malicious traffic that was dropped (**in red**) and clean traffic delivered to your IP address (**in green**). There are also basic mitigation statistics displayed, i.e.: how many attacks were detected for a selected IP, how much traffic (or packets) was cleaned during attacks or how many times scrubbing centres took an action to inspect your traffic (number of events) in a selected period of time. +**The data retention period for the traffic chart is 2 months.** + ## FAQ ### Why do I see not all of the attacks on the Network Security Dashboard? @@ -108,7 +112,7 @@ Such data is available only for public IP addresses during automatic Anti-DDoS i ### The traffic chart for some positions in the scrubbing centre logs is not available. -Traffic chart data is available only for the past two weeks, while log entries can be reviewed for the past year. +Traffic chart data is available only for the past two months, while log entries can be reviewed for the past year. ### An attack on my service is persisting, how can I better protect my server? diff --git a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.en-ie.md b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.en-ie.md index 53cc631abd2..433bd9e0fae 100644 --- a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.en-ie.md +++ b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.en-ie.md @@ -1,7 +1,7 @@ --- title: "Monitoring DDoS attacks with the Network Security Dashboard" excerpt: "Learn how to navigate through the Network Security Dashboard" -updated: 2025-09-08 +updated: 2025-10-31 --- ## Objective @@ -78,6 +78,8 @@ In the table, the following columns are present: - **Destination IP** - The IP that was the target of the attack - **Attack vectors** - Provides information about detected types of attacks, such as UDP or TCP attack, etc. +**The data retention period for scrubbing centre logs is 1 year.** + > [!warning] > > Please note that source IP addresses for detected events are not displayed because they are usually spoofed (DDoS attacks may point to other sources than the ones really comes from) and such information would be misleading or not usable. @@ -89,6 +91,8 @@ In the **Traffic chart** tab, you can see a graph showing traffic to your IP add It presents malicious traffic that was dropped (**in red**) and clean traffic delivered to your IP address (**in green**). There are also basic mitigation statistics displayed, i.e.: how many attacks were detected for a selected IP, how much traffic (or packets) was cleaned during attacks or how many times scrubbing centres took an action to inspect your traffic (number of events) in a selected period of time. +**The data retention period for the traffic chart is 2 months.** + ## FAQ ### Why do I see not all of the attacks on the Network Security Dashboard? @@ -108,7 +112,7 @@ Such data is available only for public IP addresses during automatic Anti-DDoS i ### The traffic chart for some positions in the scrubbing centre logs is not available. -Traffic chart data is available only for the past two weeks, while log entries can be reviewed for the past year. +Traffic chart data is available only for the past two months, while log entries can be reviewed for the past year. ### An attack on my service is persisting, how can I better protect my server? @@ -165,4 +169,4 @@ In any case where adjustments to our Anti-DDoS system will be necessary, it is m [Protecting a game server with the application firewall](/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos) -Join our [community of users](/links/community). \ No newline at end of file +Join our [community of users](/links/community). diff --git a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.en-sg.md b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.en-sg.md index 58065feead8..58afa657302 100644 --- a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.en-sg.md +++ b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.en-sg.md @@ -1,7 +1,7 @@ --- title: "Monitoring DDoS attacks with the Network Security Dashboard" excerpt: "Learn how to navigate through the Network Security Dashboard" -updated: 2025-09-08 +updated: 2025-10-31 --- ## Objective @@ -78,6 +78,8 @@ In the table, the following columns are present: - **Destination IP** - The IP that was the target of the attack - **Attack vectors** - Provides information about detected types of attacks, such as UDP or TCP attack, etc. +**The data retention period for scrubbing centre logs is 1 year.** + > [!warning] > > Please note that source IP addresses for detected events are not displayed because they are usually spoofed (DDoS attacks may point to other sources than the ones really comes from) and such information would be misleading or not usable. @@ -89,6 +91,8 @@ In the **Traffic chart** tab, you can see a graph showing traffic to your IP add It presents malicious traffic that was dropped (**in red**) and clean traffic delivered to your IP address (**in green**). There are also basic mitigation statistics displayed, i.e.: how many attacks were detected for a selected IP, how much traffic (or packets) was cleaned during attacks or how many times scrubbing centres took an action to inspect your traffic (number of events) in a selected period of time. +**The data retention period for the traffic chart is 2 months.** + ## FAQ ### Why do I see not all of the attacks on the Network Security Dashboard? @@ -108,7 +112,7 @@ Such data is available only for public IP addresses during automatic Anti-DDoS i ### The traffic chart for some positions in the scrubbing centre logs is not available. -Traffic chart data is available only for the past two weeks, while log entries can be reviewed for the past year. +Traffic chart data is available only for the past two months, while log entries can be reviewed for the past year. ### An attack on my service is persisting, how can I better protect my server? @@ -165,4 +169,4 @@ In any case where adjustments to our Anti-DDoS system will be necessary, it is m [Protecting a game server with the application firewall](/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos) -Join our [community of users](/links/community). \ No newline at end of file +Join our [community of users](/links/community). diff --git a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.en-us.md b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.en-us.md index 14e68c7f2c4..b243d067359 100644 --- a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.en-us.md +++ b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.en-us.md @@ -1,7 +1,7 @@ --- title: "Monitoring DDoS attacks with the Network Security Dashboard" excerpt: "Learn how to navigate through the Network Security Dashboard" -updated: 2025-09-08 +updated: 2025-10-31 --- ## Objective @@ -78,6 +78,8 @@ In the table, the following columns are present: - **Destination IP** - The IP that was the target of the attack - **Attack vectors** - Provides information about detected types of attacks, such as UDP or TCP attack, etc. +**The data retention period for scrubbing centre logs is 1 year.** + > [!warning] > > Please note that source IP addresses for detected events are not displayed because they are usually spoofed (DDoS attacks may point to other sources than the ones really comes from) and such information would be misleading or not usable. @@ -89,6 +91,8 @@ In the **Traffic chart** tab, you can see a graph showing traffic to your IP add It presents malicious traffic that was dropped (**in red**) and clean traffic delivered to your IP address (**in green**). There are also basic mitigation statistics displayed, i.e.: how many attacks were detected for a selected IP, how much traffic (or packets) was cleaned during attacks or how many times scrubbing centres took an action to inspect your traffic (number of events) in a selected period of time. +**The data retention period for the traffic chart is 2 months.** + ## FAQ ### Why do I see not all of the attacks on the Network Security Dashboard? @@ -108,7 +112,7 @@ Such data is available only for public IP addresses during automatic Anti-DDoS i ### The traffic chart for some positions in the scrubbing centre logs is not available. -Traffic chart data is available only for the past two weeks, while log entries can be reviewed for the past year. +Traffic chart data is available only for the past two months, while log entries can be reviewed for the past year. ### An attack on my service is persisting, how can I better protect my server? @@ -165,4 +169,4 @@ In any case where adjustments to our Anti-DDoS system will be necessary, it is m [Protecting a game server with the application firewall](/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos) -Join our [community of users](/links/community). \ No newline at end of file +Join our [community of users](/links/community). diff --git a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.es-es.md b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.es-es.md index d42b733e306..a087a4c0864 100644 --- a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.es-es.md +++ b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.es-es.md @@ -1,7 +1,7 @@ --- title: "Monitorización de los ataques DDoS con el Network Security Dashboard" excerpt: "Aprenda a navegar por el panel de control de seguridad de red" -updated: 2025-09-08 +updated: 2025-10-31 --- ## Objetivo @@ -79,6 +79,8 @@ En la tabla, están presentes las siguientes columnas: - **IP de destino**: la IP que ha sido el objetivo del ataque - **Vectores de ataque**: proporciona información sobre los tipos de ataques detectados, como ataques UDP o TCP, etc. +**El período de retención de datos para los registros del centro de filtrado es de 1 año.** + > [!warning] > > Tenga en cuenta que las direcciones IP de origen de los eventos detectados no se muestran porque suelen ser simuladas (los ataques DDoS pueden apuntar a otras fuentes distintas de las que proceden en realidad) y que dicha información puede ser engañosa o no utilizable. @@ -90,6 +92,8 @@ En la pestaña **Gráfico de tráfico**, puede ver un gráfico que muestra el tr Presenta tráfico malintencionado que se descartó (**en rojo**) y tráfico limpio entregado a su dirección IP (**en verde**). También se muestran estadísticas básicas de mitigación, por ejemplo: cuántos ataques se detectaron para una IP seleccionada, cuánto tráfico (o paquetes) se limpió durante los ataques o cuántas veces los centros de limpieza realizaron una acción para inspeccionar su tráfico (número de eventos) en un período de tiempo seleccionado. +**El período de retención de datos para el gráfico de tráfico es de 2 meses.** + ## FAQ ### ¿Por qué no veo todos los ataques en el panel de seguridad de la red? @@ -109,7 +113,7 @@ Estos datos solo están disponibles para las direcciones IP públicas durante lo ### El gráfico de tráfico para algunas posiciones en los registros del centro de limpieza no está disponible. -Los datos del gráfico de tráfico sólo están disponibles durante las últimas dos semanas, mientras que las entradas del registro pueden revisarse durante el año pasado. +Los datos del gráfico de tráfico solo están disponibles para los últimos dos meses, mientras que las entradas de registro se pueden revisar durante el último año. ### Persiste un ataque a mi servicio, ¿cómo puedo proteger mejor mi servidor? diff --git a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.es-us.md b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.es-us.md index d5c19e36407..7c8a55a4b16 100644 --- a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.es-us.md +++ b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.es-us.md @@ -1,17 +1,13 @@ --- title: "Monitorización de los ataques DDoS con el Network Security Dashboard" excerpt: "Aprenda a navegar por el panel de control de seguridad de red" -updated: 2025-09-08 +updated: 2025-10-31 --- ## Objetivo Esta guía explica el panel de control de seguridad de la red y proporciona una visión general de las medidas de respuesta activadas por nuestra infraestructura de protección DDoS cuando se detecta actividad de red malintencionada. Puede encontrar información detallada sobre las protecciones adicionales activadas que se deben implementar para mantener sus servicios activos y en funcionamiento. Además, hay gráficos de tráfico disponibles en el tablero de mandos para limpiar los periodos de actividad del centro a fin de visualizar mejor la situación. -> [!warning] -> -> **Advertencia**: La mitigación permanente está llegando a su fin de vida útil (EOL) y se desactivará permanentemente el 8 de septiembre de 2025. -> ## Requisitos @@ -83,6 +79,8 @@ En la tabla, están presentes las siguientes columnas: - **IP de destino**: la IP que ha sido el objetivo del ataque - **Vectores de ataque**: proporciona información sobre los tipos de ataques detectados, como ataques UDP o TCP, etc. +**El período de retención de datos para los registros del centro de filtrado es de 1 año.** + > [!warning] > > Tenga en cuenta que las direcciones IP de origen de los eventos detectados no se muestran porque suelen ser simuladas (los ataques DDoS pueden apuntar a otras fuentes distintas de las que proceden en realidad) y que dicha información puede ser engañosa o no utilizable. @@ -94,6 +92,8 @@ En la pestaña **Gráfico de tráfico**, puede ver un gráfico que muestra el tr Presenta tráfico malintencionado que se descartó (**en rojo**) y tráfico limpio entregado a su dirección IP (**en verde**). También se muestran estadísticas básicas de mitigación, por ejemplo: cuántos ataques se detectaron para una IP seleccionada, cuánto tráfico (o paquetes) se limpió durante los ataques o cuántas veces los centros de limpieza realizaron una acción para inspeccionar su tráfico (número de eventos) en un período de tiempo seleccionado. +**El período de retención de datos para el gráfico de tráfico es de 2 meses.** + ## FAQ ### ¿Por qué no veo todos los ataques en el panel de seguridad de la red? @@ -113,7 +113,7 @@ Estos datos solo están disponibles para las direcciones IP públicas durante lo ### El gráfico de tráfico para algunas posiciones en los registros del centro de limpieza no está disponible. -Los datos del gráfico de tráfico sólo están disponibles durante las últimas dos semanas, mientras que las entradas del registro pueden revisarse durante el año pasado. +Los datos del gráfico de tráfico solo están disponibles para los últimos dos meses, mientras que las entradas de registro se pueden revisar durante el último año. ### Persiste un ataque a mi servicio, ¿cómo puedo proteger mejor mi servidor? @@ -170,4 +170,4 @@ En cualquier caso en el que sea necesario realizar ajustes en nuestro sistema an [Protección de un servidor GAME con el firewall de aplicaciones](/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos) -Interactúe con nuestra [comunidad de usuarios](/links/community). \ No newline at end of file +Interactúe con nuestra [comunidad de usuarios](/links/community). diff --git a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.fr-ca.md b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.fr-ca.md index 4ca9b91a834..4973c45a57d 100644 --- a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.fr-ca.md +++ b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.fr-ca.md @@ -1,7 +1,7 @@ --- title: "Monitoring des attaques DDoS avec le Network Security Dashboard" excerpt: "Apprenez à naviguer dans le Network Security Dashboard" -updated: 2025-09-08 +updated: 2025-10-31 --- ## Objectif @@ -78,6 +78,8 @@ Dans le tableau, les colonnes suivantes sont présentes : - **IP de destination** - l'IP qui a été la cible de l'attaque. - **Vecteurs d’attaque** - gournit des informations sur les types d’attaques détectés, tels que les attaques UDP ou TCP, etc. +**La durée de rétention des logs du centre de nettoyage est d'un an.** + > [!warning] > > Veuillez noter que les adresses IP sources des événements détectés ne sont pas affichées. C'est intentionnel de notre part car, la plupart du temps, elles sont usurpées (*spoofed*) (les attaques DDoS peuvent pointer vers des sources autres que celles dont elles proviennent réellement) et ces informations seraient trompeuses ou inutilisables. @@ -89,6 +91,8 @@ Dans l'onglet **Graphique du trafic**, vous pouvez voir un graphique illustrant Il présente le trafic malveillant qui a été supprimé (**en rouge**) et le trafic « propre » livré à votre adresse IP (**en vert**). Des statistiques de mitigation de base sont également affichées, c'est-à-dire : combien d'attaques ont été détectées pour une IP sélectionnée, quel volume de trafic (ou de paquets) a été nettoyé pendant les attaques ou combien de fois les centres de nettoyage ont entrepris une action pour inspecter votre trafic (nombre d'événements) dans une période de temps sélectionnée. +**La durée de rétention des données de trafic est de deux mois.** + ## FAQ ### Pourquoi toutes les attaques ne sont-elles pas visibles sur le Network Security Dashboard ? @@ -108,7 +112,7 @@ Ces données ne sont disponibles que pour les adresses IP publiques lors des év ### Je ne peux pas afficher le graphique de trafic pour certains périodes dans les logs du centre de nettoyage -Les données du Network Security Dashboard ne sont disponibles que pour les deux dernières semaines, tandis que les entrées du journal peuvent être examinées pour l'année écoulée. +Le graphique de trafic n'est disponible que pour les deux derniers mois, tandis que les logs peuvent être examinés pour l'année écoulée. ### Je suis attaqué, comment protéger au mieux mon serveur ? @@ -165,4 +169,4 @@ Dans tous les cas de figure où des ajustements de notre système Anti-DDoS sero - [Protéger un serveur GAME avec le pare-feu applicatif](/pages/bare_metal_cloud/dedicated_servers/firewall_game_ddos) -Échangez avec notre [communauté d'utilisateurs](/links/community). \ No newline at end of file +Échangez avec notre [communauté d'utilisateurs](/links/community). diff --git a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.fr-fr.md b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.fr-fr.md index 6f8eee73081..beaec205c5e 100644 --- a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.fr-fr.md +++ b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.fr-fr.md @@ -1,7 +1,7 @@ --- title: "Monitoring des attaques DDoS avec le Network Security Dashboard" excerpt: "Apprenez à naviguer dans le Network Security Dashboard" -updated: 2025-09-08 +updated: 2025-10-31 --- ## Objectif @@ -78,6 +78,8 @@ Dans le tableau, les colonnes suivantes sont présentes : - **IP de destination** - l'IP qui a été la cible de l'attaque. - **Vecteurs d’attaque** - gournit des informations sur les types d’attaques détectés, tels que les attaques UDP ou TCP, etc. +**La durée de rétention des logs du centre de nettoyage est d'un an.** + > [!warning] > > Veuillez noter que les adresses IP sources des événements détectés ne sont pas affichées. C'est intentionnel de notre part car, la plupart du temps, elles sont usurpées (*spoofed*) (les attaques DDoS peuvent pointer vers des sources autres que celles dont elles proviennent réellement) et ces informations seraient trompeuses ou inutilisables. @@ -89,6 +91,8 @@ Dans l'onglet **Graphique du trafic**, vous pouvez voir un graphique illustrant Il présente le trafic malveillant qui a été supprimé (**en rouge**) et le trafic « propre » livré à votre adresse IP (**en vert**). Des statistiques de mitigation de base sont également affichées, c'est-à-dire : combien d'attaques ont été détectées pour une IP sélectionnée, quel volume de trafic (ou de paquets) a été nettoyé pendant les attaques ou combien de fois les centres de nettoyage ont entrepris une action pour inspecter votre trafic (nombre d'événements) dans une période de temps sélectionnée. +**La durée de rétention des données de trafic est de deux mois.** + ## FAQ ### Pourquoi toutes les attaques ne sont-elles pas visibles sur le Network Security Dashboard ? @@ -108,7 +112,7 @@ Ces données ne sont disponibles que pour les adresses IP publiques lors des év ### Je ne peux pas afficher le graphique de trafic pour certains périodes dans les logs du centre de nettoyage -Les données du Network Security Dashboard ne sont disponibles que pour les deux dernières semaines, tandis que les entrées du journal peuvent être examinées pour l'année écoulée. +Le graphique de trafic n'est disponible que pour les deux derniers mois, tandis que les logs peuvent être examinés pour l'année écoulée. ### Je suis attaqué, comment protéger au mieux mon serveur ? diff --git a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.it-it.md b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.it-it.md index 98316905d0b..1350b527d99 100644 --- a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.it-it.md +++ b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.it-it.md @@ -1,7 +1,7 @@ --- title: "Monitoraggio degli attacchi DDoS con il Network Security Dashboard" excerpt: "Scopri come navigare attraverso il dashboard di sicurezza di rete" -updated: 2025-09-08 +updated: 2025-10-31 --- ## Obiettivo @@ -78,6 +78,8 @@ Nella tabella sono presenti le seguenti colonne: - **IP di destinazione** - L'IP che è stato l'obiettivo dell'attacco - **Vettori di attacco** - Fornisce informazioni sui tipi di attacco rilevati, ad esempio UDP, TCP e così via. +**Il periodo di conservazione dei dati per i log del centro di pulizia è di 1 anno.** + > [!warning] > > Si noti che gli indirizzi IP sorgente per gli eventi rilevati non vengono visualizzati perché sono solitamente falsificati (gli attacchi DDoS possono puntare a fonti diverse da quelle da cui provengono davvero) e che tali informazioni sono fuorvianti o inutilizzabili. @@ -89,6 +91,8 @@ Nella scheda **Traffic chart**, è possibile visualizzare un grafico che mostra Presenta il traffico malevolo che è caduto (**in rosso**) e il traffico pulito recapitato al tuo indirizzo IP (**in verde**). Vengono inoltre visualizzate le statistiche di base relative alla mitigazione, ad esempio il numero di attacchi rilevati per un IP selezionato, la quantità di traffico (o pacchetti) pulito durante gli attacchi o il numero di volte che i centri di pulitura hanno eseguito un'azione per ispezionare il traffico (il numero di eventi) in un determinato periodo di tempo. +**Il periodo di conservazione dei dati per il grafico del traffico è di 2 mesi.** + ## FAQ ### Perché non vengono visualizzati tutti gli attacchi al dashboard di sicurezza di rete? @@ -108,7 +112,7 @@ Questi dati sono disponibili solo per gli indirizzi IP pubblici durante gli even ### Il grafico del traffico per alcune posizioni nei registri del centro di pulitura non è disponibile. -I dati dei grafici del traffico sono disponibili solo per le ultime due settimane, mentre le voci dei log possono essere riviste per l'anno precedente. +I dati del grafico del traffico sono disponibili solo per gli ultimi due mesi, mentre le voci dei log possono essere visionate per l'ultimo anno. ### Un attacco al mio servizio persiste, come posso proteggere meglio il mio server? diff --git a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.pl-pl.md b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.pl-pl.md index a2b5206449b..0348be39a99 100644 --- a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.pl-pl.md +++ b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.pl-pl.md @@ -1,7 +1,7 @@ --- title: "Monitoring ataków DDoS za pomocą Network Security Dashboard" excerpt: "Dowiedz się, jak nawigować za pomocą pulpitu nawigacyjnego zabezpieczeń sieciowych" -updated: 2025-09-08 +updated: 2025-10-31 --- ## Wprowadzenie @@ -78,6 +78,8 @@ W tabeli występują następujące kolumny: - **IP docelowe** - IP, które było celem ataku. - **Wektory ataków** - Dostarcza informacji o wykrytych typach ataków, takich jak ataki UDP lub TCP, itp. +**Okres przechowywania danych dla logów centrum oczyszczania wynosi 1 rok.** + > [!warning] > > Uwaga: źródłowe adresy IP dla wykrytych zdarzeń nie są wyświetlane, ponieważ są zazwyczaj zafałszowane (ataki DDoS mogą wskazywać na inne źródła niż te, które w rzeczywistości pochodzą z danego serwera). Informacje te mogą być mylące lub nie nadawać się do użytku. @@ -89,6 +91,8 @@ W karcie **Traffic chart** możesz wyświetlić wykres przedstawiający ruch do Jest to złośliwy ruch, który został porzucony (**na czerwono**) i ruch wyczyszczony dostarczony do Twojego adresu IP (**zielony**). Dostępne są również podstawowe statystyki mitygacji, czyli: ile ataków zostało wykrytych dla wybranego adresu IP, ile ruchu (lub pakietów) zostało oczyszczonych podczas ataku lub ile razy centra szybkiej kontroli podjęły działanie w celu sprawdzenia ruchu (liczba zdarzeń) w wybranym okresie czasu. +**Okres przechowywania danych dla wykresu ruchu wynosi 2 miesiące.** + ## FAQ ### Dlaczego nie widzę wszystkich ataków na pulpicie nawigacyjnym zabezpieczeń sieci? @@ -108,7 +112,7 @@ Dane te są dostępne wyłącznie dla publicznych adresów IP w przypadku wykryc ### Wykres ruchu dla niektórych pozycji w dziennikach centrum oczyszczania jest niedostępny. -Dane z wykresów ruchu dostępne są tylko w ciągu ostatnich dwóch tygodni, a wpisy w dziennikach mogą być weryfikowane w ciągu ostatniego roku. +Dane wykresu ruchu są dostępne tylko dla ostatnich dwóch miesięcy, podczas gdy wpisy w logach można przeglądać przez ostatni rok. ### Atak na moją usługę trwa, w jaki sposób mogę lepiej chronić swój serwer? diff --git a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.pt-pt.md b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.pt-pt.md index 8d24aafee53..da74d2b86ac 100644 --- a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.pt-pt.md +++ b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/guide.pt-pt.md @@ -1,7 +1,7 @@ --- title: "Monitorização dos ataques DDoS com o Network Security Dashboard" excerpt: "Saiba como navegar no Dashboard de Segurança da Rede" -updated: 2025-09-08 +updated: 2025-10-31 --- ## Objetivo @@ -78,6 +78,8 @@ Na tabela, estão presentes as seguintes colunas: - **IP de destino** - O IP que foi alvo do ataque - **Vetores de ataque** - Fornece informações sobre tipos de ataque detetados, tais como ataques UDP ou TCP, etc. +**O período de retenção de dados para os registos do centro de filtragem é de 1 ano.** + > [!warning] > > Tenha em conta que os endereços IP de origem dos eventos detetados não são apresentados porque são normalmente alvo de spoofing (os ataques DDoS podem apontar para outras fontes que não aquelas de onde realmente provêm) e tal informação seria enganosa ou não seria utilizável. @@ -89,6 +91,8 @@ No separador **Gráfico de tráfego**, pode ver um gráfico que mostra o tráfeg Apresenta tráfego malicioso que foi eliminado (**em vermelho**) e tráfego limpo enviado para o seu endereço IP (**em verde**). Também são apresentadas estatísticas básicas de mitigação, ou seja: o número de ataques detetados para um IP selecionado, o volume de tráfego (ou pacotes) limpo durante os ataques ou o número de vezes que os centros de limpeza efetuaram uma ação para inspecionar o tráfego (número de eventos) num período de tempo selecionado. +**O período de retenção de dados para o gráfico de tráfego é de 2 meses.** + ## FAQ ### Porque não vejo todos os ataques no Network Security Dashboard? @@ -108,7 +112,7 @@ Estes dados só estão disponíveis para os endereços IP públicos durante os e ### O gráfico de tráfego para algumas posições nos logs do centro de limpeza não está disponível. -Os dados do gráfico de tráfego só estão disponíveis para as duas últimas semanas, enquanto que as entradas de registo podem ser revistas para o ano passado. +Os dados do gráfico de tráfego estão disponíveis apenas para os últimos dois meses, enquanto as entradas de registo podem ser revistas durante o último ano. ### Um ataque ao meu serviço persiste, como posso proteger melhor o meu servidor? diff --git a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/07d020ee-a50c-4312-bf46-6efc912a5f02.PNG b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/07d020ee-a50c-4312-bf46-6efc912a5f02.PNG deleted file mode 100644 index b13f6c7231a..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/07d020ee-a50c-4312-bf46-6efc912a5f02.PNG and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/1bd1417e-cb9d-45ec-aa93-c1a5ea649ca3.PNG b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/1bd1417e-cb9d-45ec-aa93-c1a5ea649ca3.PNG deleted file mode 100644 index 4014882e46a..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/1bd1417e-cb9d-45ec-aa93-c1a5ea649ca3.PNG and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/3eb029ca-9be4-48dc-80c5-584ba7f13bd1.PNG b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/3eb029ca-9be4-48dc-80c5-584ba7f13bd1.PNG deleted file mode 100644 index 7e0e7eeb71e..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/3eb029ca-9be4-48dc-80c5-584ba7f13bd1.PNG and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/5dc5c019-bf45-4a56-836e-8d1877fe0c26.PNG b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/5dc5c019-bf45-4a56-836e-8d1877fe0c26.PNG deleted file mode 100644 index d00579be160..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/5dc5c019-bf45-4a56-836e-8d1877fe0c26.PNG and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/971995d7-26fd-49a4-b76f-918a86642110.PNG b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/971995d7-26fd-49a4-b76f-918a86642110.PNG deleted file mode 100644 index fa457959c1c..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/971995d7-26fd-49a4-b76f-918a86642110.PNG and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/ENF-full-rules.gif b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/ENF-full-rules.gif deleted file mode 100644 index ae2c0e98a5b..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/ENF-full-rules.gif and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/a2359621-aceb-468b-8c2a-e595819fff0a.PNG b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/a2359621-aceb-468b-8c2a-e595819fff0a.PNG deleted file mode 100644 index 0ab566de786..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/a2359621-aceb-468b-8c2a-e595819fff0a.PNG and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/a40332a2-abf5-4978-9652-6b42fea1757f.PNG b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/a40332a2-abf5-4978-9652-6b42fea1757f.PNG deleted file mode 100644 index afd27b50a64..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/a40332a2-abf5-4978-9652-6b42fea1757f.PNG and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/a4da0294-6506-4345-8192-047fb57e2f69.PNG b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/a4da0294-6506-4345-8192-047fb57e2f69.PNG deleted file mode 100644 index 94a812f111d..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/a4da0294-6506-4345-8192-047fb57e2f69.PNG and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/c57bdd6f-6cdd-447c-bff4-829d8e9aac8c.PNG b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/c57bdd6f-6cdd-447c-bff4-829d8e9aac8c.PNG deleted file mode 100644 index 2ca517c6902..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/c57bdd6f-6cdd-447c-bff4-829d8e9aac8c.PNG and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/d2cbd11c-78db-4698-bb18-2b3cb3dde026.PNG b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/d2cbd11c-78db-4698-bb18-2b3cb3dde026.PNG deleted file mode 100644 index 11351beaad4..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/d2cbd11c-78db-4698-bb18-2b3cb3dde026.PNG and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/e9b8c9d8-dfe5-4c6c-96de-d5dc6281241d.PNG b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/e9b8c9d8-dfe5-4c6c-96de-d5dc6281241d.PNG deleted file mode 100644 index e5f98a8f6aa..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/e9b8c9d8-dfe5-4c6c-96de-d5dc6281241d.PNG and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/nsd-left-menu.png b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/nsd-left-menu.png deleted file mode 100644 index cf52e23c4fb..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/nsd-left-menu.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/nsd_02.png b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/nsd_02.png deleted file mode 100644 index 3667d269807..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/nsd_02.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/nsd_02_blur.png b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/nsd_02_blur.png deleted file mode 100644 index 81009ac3274..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/nsd_02_blur.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/nsd_02_crop.png b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/nsd_02_crop.png deleted file mode 100644 index ba62d7d1608..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/nsd_02_crop.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/nsd_03.png b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/nsd_03.png deleted file mode 100644 index 990e329b4ce..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/nsd_03.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/nsd_04.PNG b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/nsd_04.PNG deleted file mode 100644 index 8fb6b444b0b..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/nsd_04.PNG and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/nsd_05.png b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/nsd_05.png deleted file mode 100644 index 3667d269807..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/nsd_05.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/nsd_06.PNG b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/nsd_06.PNG deleted file mode 100644 index 203ea7b0b90..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/nsd_06.PNG and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/nsd_07.PNG b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/nsd_07.PNG deleted file mode 100644 index 9f347a83d61..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/nsd_07.PNG and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/nsd_from_other_screen.png b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/nsd_from_other_screen.png deleted file mode 100644 index 49f42d305d7..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/images/nsd_from_other_screen.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/meta.yaml b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/meta.yaml index 1b443f9b8e3..2d90e10e7f3 100644 --- a/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/meta.yaml +++ b/pages/bare_metal_cloud/dedicated_servers/network_security_dashboard/meta.yaml @@ -1,4 +1,4 @@ id: afdc732a-649e-4492-bf91-81411c5b4ca4 full_slug: network-security-dashboard -reference_category: bare-metal-cloud-dedicated-servers-network-and-ip-management +reference_category: bare-metal-cloud-dedicated-servers-security-network translation_banner: true \ No newline at end of file diff --git a/pages/bare_metal_cloud/dedicated_servers/network_virtual_mac/images/BlocFO.png b/pages/bare_metal_cloud/dedicated_servers/network_virtual_mac/images/BlocFO.png deleted file mode 100644 index 031f8cdf440..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/network_virtual_mac/images/BlocFO.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/network_virtual_mac/images/IPFO.png b/pages/bare_metal_cloud/dedicated_servers/network_virtual_mac/images/IPFO.png deleted file mode 100644 index f49d758b4b4..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/network_virtual_mac/images/IPFO.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/network_virtual_mac/images/ipsection.png b/pages/bare_metal_cloud/dedicated_servers/network_virtual_mac/images/ipsection.png deleted file mode 100644 index 277ff35cb07..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/network_virtual_mac/images/ipsection.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/network_virtual_mac/images/mac.png b/pages/bare_metal_cloud/dedicated_servers/network_virtual_mac/images/mac.png deleted file mode 100644 index d49e5127263..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/network_virtual_mac/images/mac.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/network_virtual_mac/images/manageIPOVHcloud.png b/pages/bare_metal_cloud/dedicated_servers/network_virtual_mac/images/manageIPOVHcloud.png deleted file mode 100644 index e0ebe99132e..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/network_virtual_mac/images/manageIPOVHcloud.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/network_virtual_mac/images/virtual_mac_01.png b/pages/bare_metal_cloud/dedicated_servers/network_virtual_mac/images/virtual_mac_01.png deleted file mode 100644 index 6421993b10b..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/network_virtual_mac/images/virtual_mac_01.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/network_virtual_mac/images/virtual_mac_01_2020.png b/pages/bare_metal_cloud/dedicated_servers/network_virtual_mac/images/virtual_mac_01_2020.png deleted file mode 100644 index 18dab259621..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/network_virtual_mac/images/virtual_mac_01_2020.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/network_virtual_mac/images/virtual_mac_02.png b/pages/bare_metal_cloud/dedicated_servers/network_virtual_mac/images/virtual_mac_02.png deleted file mode 100644 index 06bfe9664a9..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/network_virtual_mac/images/virtual_mac_02.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/network_virtual_mac/images/virtual_mac_03.png b/pages/bare_metal_cloud/dedicated_servers/network_virtual_mac/images/virtual_mac_03.png deleted file mode 100644 index d4a7839db2c..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/network_virtual_mac/images/virtual_mac_03.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/ola-enable-debian9/images/remote_kvm.png b/pages/bare_metal_cloud/dedicated_servers/ola-enable-debian9/images/remote_kvm.png deleted file mode 100644 index 29ae16b6ee0..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/ola-enable-debian9/images/remote_kvm.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/ola-enable-debian9/images/remote_kvm2021.png b/pages/bare_metal_cloud/dedicated_servers/ola-enable-debian9/images/remote_kvm2021.png deleted file mode 100644 index 6eec79935ee..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/ola-enable-debian9/images/remote_kvm2021.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/ola-enable-debian9/images/remote_kvm_2020.png b/pages/bare_metal_cloud/dedicated_servers/ola-enable-debian9/images/remote_kvm_2020.png deleted file mode 100644 index 0c29bcb4fa4..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/ola-enable-debian9/images/remote_kvm_2020.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/ola-enable-manager/images/configure.png b/pages/bare_metal_cloud/dedicated_servers/ola-enable-manager/images/configure.png deleted file mode 100644 index 406983c6f48..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/ola-enable-manager/images/configure.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/ola-enable-manager/images/configure_2020.png b/pages/bare_metal_cloud/dedicated_servers/ola-enable-manager/images/configure_2020.png deleted file mode 100644 index fd6d9072f32..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/ola-enable-manager/images/configure_2020.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/ola-enable-manager/images/interface_select.png b/pages/bare_metal_cloud/dedicated_servers/ola-enable-manager/images/interface_select.png deleted file mode 100644 index ccdd86edcf7..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/ola-enable-manager/images/interface_select.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/ola-enable-manager/images/interface_select_2020.png b/pages/bare_metal_cloud/dedicated_servers/ola-enable-manager/images/interface_select_2020.png deleted file mode 100644 index 56c3d2f94a1..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/ola-enable-manager/images/interface_select_2020.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/ola-enable-manager/images/network_interfaces.png b/pages/bare_metal_cloud/dedicated_servers/ola-enable-manager/images/network_interfaces.png deleted file mode 100644 index 1142da615d7..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/ola-enable-manager/images/network_interfaces.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/ola-enable-manager/images/network_interfaces2021.png b/pages/bare_metal_cloud/dedicated_servers/ola-enable-manager/images/network_interfaces2021.png deleted file mode 100644 index e7abd9eef4c..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/ola-enable-manager/images/network_interfaces2021.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/ola-enable-manager/images/network_interfaces_2020.png b/pages/bare_metal_cloud/dedicated_servers/ola-enable-manager/images/network_interfaces_2020.png deleted file mode 100644 index a457015f1ca..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/ola-enable-manager/images/network_interfaces_2020.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/ola-enable-manager/images/overview.png b/pages/bare_metal_cloud/dedicated_servers/ola-enable-manager/images/overview.png deleted file mode 100644 index 13dda4167e9..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/ola-enable-manager/images/overview.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/ola-enable-manager/images/overview_2020.png b/pages/bare_metal_cloud/dedicated_servers/ola-enable-manager/images/overview_2020.png deleted file mode 100644 index 85bf232d855..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/ola-enable-manager/images/overview_2020.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/ola-enable-manager/images/private_aggregation.png b/pages/bare_metal_cloud/dedicated_servers/ola-enable-manager/images/private_aggregation.png deleted file mode 100644 index ecad8a9cbd2..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/ola-enable-manager/images/private_aggregation.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/ola-enable-manager/images/private_aggregation_2020.png b/pages/bare_metal_cloud/dedicated_servers/ola-enable-manager/images/private_aggregation_2020.png deleted file mode 100644 index fe7b2801071..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/ola-enable-manager/images/private_aggregation_2020.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/ola-enable-w2k19/images/remote_kvm.png b/pages/bare_metal_cloud/dedicated_servers/ola-enable-w2k19/images/remote_kvm.png deleted file mode 100644 index 29ae16b6ee0..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/ola-enable-w2k19/images/remote_kvm.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/ola-enable-w2k19/images/remote_kvm2021.png b/pages/bare_metal_cloud/dedicated_servers/ola-enable-w2k19/images/remote_kvm2021.png deleted file mode 100644 index 57a6e62a63f..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/ola-enable-w2k19/images/remote_kvm2021.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/ola-enable-w2k19/images/remote_kvm_2020.png b/pages/bare_metal_cloud/dedicated_servers/ola-enable-w2k19/images/remote_kvm_2020.png deleted file mode 100644 index f03dcb92a50..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/ola-enable-w2k19/images/remote_kvm_2020.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/ovh_ssh_key/meta.yaml b/pages/bare_metal_cloud/dedicated_servers/ovh_ssh_key/meta.yaml index e408b0f9cbd..cfb01ffde9e 100755 --- a/pages/bare_metal_cloud/dedicated_servers/ovh_ssh_key/meta.yaml +++ b/pages/bare_metal_cloud/dedicated_servers/ovh_ssh_key/meta.yaml @@ -1,3 +1,3 @@ id: 6c0f49ac-babb-4d43-874d-cc2b5049e991 full_slug: dedicated-servers-ovhcloud-ssh-key -reference_category: bare-metal-cloud-dedicated-servers-troubleshooting \ No newline at end of file +reference_category: bare-metal-cloud-dedicated-servers-configuration-network \ No newline at end of file diff --git a/pages/bare_metal_cloud/dedicated_servers/pfSense_bridging/images/pfsense-vm-apply.png b/pages/bare_metal_cloud/dedicated_servers/pfSense_bridging/images/pfsense-vm-apply.png deleted file mode 100644 index ae7a94a221a..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/pfSense_bridging/images/pfsense-vm-apply.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/pfSense_bridging/images/virtual_mac.png b/pages/bare_metal_cloud/dedicated_servers/pfSense_bridging/images/virtual_mac.png deleted file mode 100644 index d4a7839db2c..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/pfSense_bridging/images/virtual_mac.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/pfSense_bridging/images/virtual_mac_01.png b/pages/bare_metal_cloud/dedicated_servers/pfSense_bridging/images/virtual_mac_01.png deleted file mode 100644 index 6421993b10b..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/pfSense_bridging/images/virtual_mac_01.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/pfSense_bridging/images/virtual_mac_01_2020.png b/pages/bare_metal_cloud/dedicated_servers/pfSense_bridging/images/virtual_mac_01_2020.png deleted file mode 100644 index 18dab259621..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/pfSense_bridging/images/virtual_mac_01_2020.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/pfSense_bridging/images/virtual_mac_02.png b/pages/bare_metal_cloud/dedicated_servers/pfSense_bridging/images/virtual_mac_02.png deleted file mode 100644 index 06bfe9664a9..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/pfSense_bridging/images/virtual_mac_02.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/pfSense_bridging/images/virtual_mac_03.png b/pages/bare_metal_cloud/dedicated_servers/pfSense_bridging/images/virtual_mac_03.png deleted file mode 100644 index d4a7839db2c..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/pfSense_bridging/images/virtual_mac_03.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/pxe-with-full-private-dedicated/images/schema_basic.png b/pages/bare_metal_cloud/dedicated_servers/pxe-with-full-private-dedicated/images/schema_basic.png deleted file mode 100644 index 0f9c587688c..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/pxe-with-full-private-dedicated/images/schema_basic.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/raid_soft/images/add_mirroir.png b/pages/bare_metal_cloud/dedicated_servers/raid_soft/images/add_mirroir.png deleted file mode 100644 index eaf45654553..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/raid_soft/images/add_mirroir.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/raid_soft/images/computer_management.png b/pages/bare_metal_cloud/dedicated_servers/raid_soft/images/computer_management.png deleted file mode 100644 index bcb9b7bfda8..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/raid_soft/images/computer_management.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/raid_soft/images/disk_management_panel.png b/pages/bare_metal_cloud/dedicated_servers/raid_soft/images/disk_management_panel.png deleted file mode 100644 index 0edd592f977..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/raid_soft/images/disk_management_panel.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/raid_soft/images/ouvrir_computer_manager.png b/pages/bare_metal_cloud/dedicated_servers/raid_soft/images/ouvrir_computer_manager.png deleted file mode 100644 index 275dd6534f7..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/raid_soft/images/ouvrir_computer_manager.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/raid_soft/images/resync_en_cours.png b/pages/bare_metal_cloud/dedicated_servers/raid_soft/images/resync_en_cours.png deleted file mode 100644 index 5916b765e51..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/raid_soft/images/resync_en_cours.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/raid_soft/images/resynchroniser_raid_soft.png b/pages/bare_metal_cloud/dedicated_servers/raid_soft/images/resynchroniser_raid_soft.png deleted file mode 100644 index 1dec3289c53..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/raid_soft/images/resynchroniser_raid_soft.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.de-de.md b/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.de-de.md index bf7176c97dc..6d952114ddf 100644 --- a/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.de-de.md +++ b/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.de-de.md @@ -1,7 +1,7 @@ --- title: "Administrator-Passwort eines Windows Servers mit dem Windows Customer Rescue System zurücksetzen" excerpt: "Erfahren Sie hier, wie Sie den OVHcloud Windows-Rescue-Modus verwenden, um das Passwort des Administrator-Accounts auf einem Windows Dedicated Server zurückzusetzen" -updated: 2025-03-06 +updated: 2025-10-22 --- ## Ziel @@ -11,6 +11,7 @@ Diese Anleitung erklärt, wie Sie das Passwort für den Administrator-Account mi ## Voraussetzungen - Sie haben einen [Dedicated Server](/links/bare-metal/bare-metal), auf dem Microsoft Windows Server 2016 oder höher installiert ist. +- Der Server verfügt über mindestens 16 GB RAM. - Sie haben Zugriff auf Ihr [OVHcloud Kundencenter](/links/manager). > [!warning] diff --git a/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.en-asia.md b/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.en-asia.md deleted file mode 100644 index 964de61bca2..00000000000 --- a/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.en-asia.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -title: "How to reset the Windows Administrator password with the Windows customer rescue system" -excerpt: "Find out how to use the OVHcloud Windows rescue mode to reset the password of the Administrator account on a Windows dedicated server" -updated: 2025-03-06 ---- - -## Objective - -This guide will help you to reset your `Administrator` account password with the **Windows customer rescue system**. - -## Requirements - -- Microsoft Windows Server 2016 or greater installed on your [dedicated server](/links/bare-metal/bare-metal) -- Access to the [OVHcloud Control Panel](/links/manager) - -> [!warning] -> -> This guide is not applicable to the **legacy Windows rescue system (WinPE rescue mode)** (see the [rescue mode guide](/pages/bare_metal_cloud/dedicated_servers/rescue_mode) for details). -> -> If your Windows Server version is out of support, you might not be able to activate the current rescue system for Windows. In this case, please refer to our guide page on [how to reset the Windows Administrator password with the legacy Windows rescue system](/pages/bare_metal_cloud/dedicated_servers/changing-admin-password-on-windows) instead. -> The same guide explains an alternative method for resetting the Administrator password using the OVHcloud customer rescue system based on Debian. - -## Instructions - -### Step 1 - Reboot the server into rescue mode - -The system has to be started into the **Windows customer rescue system** before the admin password can be changed. - -For detailed instructions, please refer to the [rescue mode guide](/pages/bare_metal_cloud/dedicated_servers/rescue-customer-windows). - -### Step 2 - Clear the current password - -Connect to your server in Remote Desktop using the credentials provided by email. - -Please note that the user name for the rescue mode is `Administrator`. - -- If your server uses software RAID on your Windows disk, you have to import your Windows local disk to be able to access it: Follow the instructions of the [section A](#sectionA) below. -- If your server does not use software RAID on your Windows disk, you should be able to directly access the local Windows disk as explained in the [section B](#sectionB) of this guide. - -#### A - Importing your local Windows disk - -##### 1. Access disk management - -Right-click the `Start`{.action} menu and select `Disk Management`{.action}. - -![disk_manager_menu](images/disk_manager_menu.png){.thumbnail} - -You can then see the disks and volumes of the server. - -![disk_manager_window](images/disk_manager_window1.png){.thumbnail} - -Your server's Windows disk is probably *Disk 1*. You must import it to be able to access it. - -Please note that if you have several disk groups, the number of the Windows disk may vary. You may have to import several disks to get the Windows one. - -You also have to import the second disk to properly import your software RAID volume. - -##### 2. Import local disks - -Right-click *Disk 1* and select `Online`{.action}. - -![disk_import_disk1](images/disk_manager_disk1on.png){.thumbnail} - -Do the same thing for the second disk (*Disk 2*) to properly import your software RAID volume. - -Right-click *Disk 2* and select `Online`{.action}. - -![disk_import_disk2](images/disk_manager_disk2on.png){.thumbnail} - -Disks are now seen as "Dynamic" and "Foreign". - -Right-click *Disk 1* again and select `Import Foreign Disks`{.action}. - -![disk_import_menu](images/disk_manager_diskimport.png){.thumbnail} - -Click `OK` twice. - -![disk_import1](images/disk_import1.png){.thumbnail} - -![disk_import2](images/disk_import2.png){.thumbnail} - -You can see that the local disk is now accessible and that the Windows disk is drive `(E:)` (spreading on two software RAID disks with Mirrored volume type). - -![disk_import_sync](images/disk_import_sync.png){.thumbnail} - -> [!primary] -> In this example, the volume status is "Resynching" because the server was hard-rebooted into rescue mode. This is an expected status and it is not caused by the rescue mode itself. -> This will not affect data on the volume and resynchronisation will continue once the server is rebooted into its installed OS. - -> [!warning] -> -> You must then use the path of your local Windows directory (here it is `E:\Windows`) when browsing to find the "SAM" configuration file below. - -You can now reset the password by following the instructions below. - -#### B - Reset the password - -To reset passwords, the tool NTPWEdit is required.
-Once you are connected via Remote Desktop, open the browser and download it from its [official website](http://www.cdslow.org.ru/files/ntpwedit/ntpwed07.zip).
-Navigate to the folder where the downloaded ZIP file is located and extract its content.
-Next, open the `ntpwedit64` executable to start the application. - -In this interface, you can manipulate the SAM file in order to clear the admin user's password. - -You must browse the local Windows drive to find your system's SAM file. - -Click the three dots button (`...`{.action}) to browse the drive containing your server's local Windows folder. - -It usually is the `Windows (E:\)` drive. - -![ntpwedit1](images/ntpwedit_1.png){.thumbnail} - -Browse to `E:\WINDOWS\SYSTEM32\CONFIG\`. - -Select and open the SAM file to display the user accounts by clicking `Open`{.action}. - -![ntpwedit_sam](images/SAM.png){.thumbnail} - -Select the user account "admin" and click on `Change password`{.action}. - -![ntpwedit2](images/ntpwedit_2.png){.thumbnail} - -In the popup window, enter your new password in both fields and click `OK`{.action}. - -> [!warning] -> -> The new password will be accepted regardless of any password complexity. -> -> Keep in mind that this password will allow remote connection to the server once rebooted on its operating system. - -Finish by clicking `Save changes`{.action} and `Exit`{.action}. - -After this, the server needs to be rebooted on the normal operating system. - -### Step 3 - Reboot the server - -First, change the netboot back to "Boot from the hard disk" in your OVHcloud Control Panel (see [step 1](#step1)). - -Then restart the server from the Control Panel. - -Click the `...`{.action} button near "Status" in the "Service Status" section and click `Restart`{.action}. - -![reboot](/pages/assets/screens/control_panel/product-selection/bare-metal-cloud/dedicated-servers/general-information/cp_dedicated_restart.png){.thumbnail} - -## Go further - -Join our [community of users](/links/community). diff --git a/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.en-au.md b/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.en-au.md deleted file mode 100644 index 964de61bca2..00000000000 --- a/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.en-au.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -title: "How to reset the Windows Administrator password with the Windows customer rescue system" -excerpt: "Find out how to use the OVHcloud Windows rescue mode to reset the password of the Administrator account on a Windows dedicated server" -updated: 2025-03-06 ---- - -## Objective - -This guide will help you to reset your `Administrator` account password with the **Windows customer rescue system**. - -## Requirements - -- Microsoft Windows Server 2016 or greater installed on your [dedicated server](/links/bare-metal/bare-metal) -- Access to the [OVHcloud Control Panel](/links/manager) - -> [!warning] -> -> This guide is not applicable to the **legacy Windows rescue system (WinPE rescue mode)** (see the [rescue mode guide](/pages/bare_metal_cloud/dedicated_servers/rescue_mode) for details). -> -> If your Windows Server version is out of support, you might not be able to activate the current rescue system for Windows. In this case, please refer to our guide page on [how to reset the Windows Administrator password with the legacy Windows rescue system](/pages/bare_metal_cloud/dedicated_servers/changing-admin-password-on-windows) instead. -> The same guide explains an alternative method for resetting the Administrator password using the OVHcloud customer rescue system based on Debian. - -## Instructions - -### Step 1 - Reboot the server into rescue mode - -The system has to be started into the **Windows customer rescue system** before the admin password can be changed. - -For detailed instructions, please refer to the [rescue mode guide](/pages/bare_metal_cloud/dedicated_servers/rescue-customer-windows). - -### Step 2 - Clear the current password - -Connect to your server in Remote Desktop using the credentials provided by email. - -Please note that the user name for the rescue mode is `Administrator`. - -- If your server uses software RAID on your Windows disk, you have to import your Windows local disk to be able to access it: Follow the instructions of the [section A](#sectionA) below. -- If your server does not use software RAID on your Windows disk, you should be able to directly access the local Windows disk as explained in the [section B](#sectionB) of this guide. - -#### A - Importing your local Windows disk - -##### 1. Access disk management - -Right-click the `Start`{.action} menu and select `Disk Management`{.action}. - -![disk_manager_menu](images/disk_manager_menu.png){.thumbnail} - -You can then see the disks and volumes of the server. - -![disk_manager_window](images/disk_manager_window1.png){.thumbnail} - -Your server's Windows disk is probably *Disk 1*. You must import it to be able to access it. - -Please note that if you have several disk groups, the number of the Windows disk may vary. You may have to import several disks to get the Windows one. - -You also have to import the second disk to properly import your software RAID volume. - -##### 2. Import local disks - -Right-click *Disk 1* and select `Online`{.action}. - -![disk_import_disk1](images/disk_manager_disk1on.png){.thumbnail} - -Do the same thing for the second disk (*Disk 2*) to properly import your software RAID volume. - -Right-click *Disk 2* and select `Online`{.action}. - -![disk_import_disk2](images/disk_manager_disk2on.png){.thumbnail} - -Disks are now seen as "Dynamic" and "Foreign". - -Right-click *Disk 1* again and select `Import Foreign Disks`{.action}. - -![disk_import_menu](images/disk_manager_diskimport.png){.thumbnail} - -Click `OK` twice. - -![disk_import1](images/disk_import1.png){.thumbnail} - -![disk_import2](images/disk_import2.png){.thumbnail} - -You can see that the local disk is now accessible and that the Windows disk is drive `(E:)` (spreading on two software RAID disks with Mirrored volume type). - -![disk_import_sync](images/disk_import_sync.png){.thumbnail} - -> [!primary] -> In this example, the volume status is "Resynching" because the server was hard-rebooted into rescue mode. This is an expected status and it is not caused by the rescue mode itself. -> This will not affect data on the volume and resynchronisation will continue once the server is rebooted into its installed OS. - -> [!warning] -> -> You must then use the path of your local Windows directory (here it is `E:\Windows`) when browsing to find the "SAM" configuration file below. - -You can now reset the password by following the instructions below. - -#### B - Reset the password - -To reset passwords, the tool NTPWEdit is required.
-Once you are connected via Remote Desktop, open the browser and download it from its [official website](http://www.cdslow.org.ru/files/ntpwedit/ntpwed07.zip).
-Navigate to the folder where the downloaded ZIP file is located and extract its content.
-Next, open the `ntpwedit64` executable to start the application. - -In this interface, you can manipulate the SAM file in order to clear the admin user's password. - -You must browse the local Windows drive to find your system's SAM file. - -Click the three dots button (`...`{.action}) to browse the drive containing your server's local Windows folder. - -It usually is the `Windows (E:\)` drive. - -![ntpwedit1](images/ntpwedit_1.png){.thumbnail} - -Browse to `E:\WINDOWS\SYSTEM32\CONFIG\`. - -Select and open the SAM file to display the user accounts by clicking `Open`{.action}. - -![ntpwedit_sam](images/SAM.png){.thumbnail} - -Select the user account "admin" and click on `Change password`{.action}. - -![ntpwedit2](images/ntpwedit_2.png){.thumbnail} - -In the popup window, enter your new password in both fields and click `OK`{.action}. - -> [!warning] -> -> The new password will be accepted regardless of any password complexity. -> -> Keep in mind that this password will allow remote connection to the server once rebooted on its operating system. - -Finish by clicking `Save changes`{.action} and `Exit`{.action}. - -After this, the server needs to be rebooted on the normal operating system. - -### Step 3 - Reboot the server - -First, change the netboot back to "Boot from the hard disk" in your OVHcloud Control Panel (see [step 1](#step1)). - -Then restart the server from the Control Panel. - -Click the `...`{.action} button near "Status" in the "Service Status" section and click `Restart`{.action}. - -![reboot](/pages/assets/screens/control_panel/product-selection/bare-metal-cloud/dedicated-servers/general-information/cp_dedicated_restart.png){.thumbnail} - -## Go further - -Join our [community of users](/links/community). diff --git a/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.en-ca.md b/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.en-ca.md deleted file mode 100644 index 964de61bca2..00000000000 --- a/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.en-ca.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -title: "How to reset the Windows Administrator password with the Windows customer rescue system" -excerpt: "Find out how to use the OVHcloud Windows rescue mode to reset the password of the Administrator account on a Windows dedicated server" -updated: 2025-03-06 ---- - -## Objective - -This guide will help you to reset your `Administrator` account password with the **Windows customer rescue system**. - -## Requirements - -- Microsoft Windows Server 2016 or greater installed on your [dedicated server](/links/bare-metal/bare-metal) -- Access to the [OVHcloud Control Panel](/links/manager) - -> [!warning] -> -> This guide is not applicable to the **legacy Windows rescue system (WinPE rescue mode)** (see the [rescue mode guide](/pages/bare_metal_cloud/dedicated_servers/rescue_mode) for details). -> -> If your Windows Server version is out of support, you might not be able to activate the current rescue system for Windows. In this case, please refer to our guide page on [how to reset the Windows Administrator password with the legacy Windows rescue system](/pages/bare_metal_cloud/dedicated_servers/changing-admin-password-on-windows) instead. -> The same guide explains an alternative method for resetting the Administrator password using the OVHcloud customer rescue system based on Debian. - -## Instructions - -### Step 1 - Reboot the server into rescue mode - -The system has to be started into the **Windows customer rescue system** before the admin password can be changed. - -For detailed instructions, please refer to the [rescue mode guide](/pages/bare_metal_cloud/dedicated_servers/rescue-customer-windows). - -### Step 2 - Clear the current password - -Connect to your server in Remote Desktop using the credentials provided by email. - -Please note that the user name for the rescue mode is `Administrator`. - -- If your server uses software RAID on your Windows disk, you have to import your Windows local disk to be able to access it: Follow the instructions of the [section A](#sectionA) below. -- If your server does not use software RAID on your Windows disk, you should be able to directly access the local Windows disk as explained in the [section B](#sectionB) of this guide. - -#### A - Importing your local Windows disk - -##### 1. Access disk management - -Right-click the `Start`{.action} menu and select `Disk Management`{.action}. - -![disk_manager_menu](images/disk_manager_menu.png){.thumbnail} - -You can then see the disks and volumes of the server. - -![disk_manager_window](images/disk_manager_window1.png){.thumbnail} - -Your server's Windows disk is probably *Disk 1*. You must import it to be able to access it. - -Please note that if you have several disk groups, the number of the Windows disk may vary. You may have to import several disks to get the Windows one. - -You also have to import the second disk to properly import your software RAID volume. - -##### 2. Import local disks - -Right-click *Disk 1* and select `Online`{.action}. - -![disk_import_disk1](images/disk_manager_disk1on.png){.thumbnail} - -Do the same thing for the second disk (*Disk 2*) to properly import your software RAID volume. - -Right-click *Disk 2* and select `Online`{.action}. - -![disk_import_disk2](images/disk_manager_disk2on.png){.thumbnail} - -Disks are now seen as "Dynamic" and "Foreign". - -Right-click *Disk 1* again and select `Import Foreign Disks`{.action}. - -![disk_import_menu](images/disk_manager_diskimport.png){.thumbnail} - -Click `OK` twice. - -![disk_import1](images/disk_import1.png){.thumbnail} - -![disk_import2](images/disk_import2.png){.thumbnail} - -You can see that the local disk is now accessible and that the Windows disk is drive `(E:)` (spreading on two software RAID disks with Mirrored volume type). - -![disk_import_sync](images/disk_import_sync.png){.thumbnail} - -> [!primary] -> In this example, the volume status is "Resynching" because the server was hard-rebooted into rescue mode. This is an expected status and it is not caused by the rescue mode itself. -> This will not affect data on the volume and resynchronisation will continue once the server is rebooted into its installed OS. - -> [!warning] -> -> You must then use the path of your local Windows directory (here it is `E:\Windows`) when browsing to find the "SAM" configuration file below. - -You can now reset the password by following the instructions below. - -#### B - Reset the password - -To reset passwords, the tool NTPWEdit is required.
-Once you are connected via Remote Desktop, open the browser and download it from its [official website](http://www.cdslow.org.ru/files/ntpwedit/ntpwed07.zip).
-Navigate to the folder where the downloaded ZIP file is located and extract its content.
-Next, open the `ntpwedit64` executable to start the application. - -In this interface, you can manipulate the SAM file in order to clear the admin user's password. - -You must browse the local Windows drive to find your system's SAM file. - -Click the three dots button (`...`{.action}) to browse the drive containing your server's local Windows folder. - -It usually is the `Windows (E:\)` drive. - -![ntpwedit1](images/ntpwedit_1.png){.thumbnail} - -Browse to `E:\WINDOWS\SYSTEM32\CONFIG\`. - -Select and open the SAM file to display the user accounts by clicking `Open`{.action}. - -![ntpwedit_sam](images/SAM.png){.thumbnail} - -Select the user account "admin" and click on `Change password`{.action}. - -![ntpwedit2](images/ntpwedit_2.png){.thumbnail} - -In the popup window, enter your new password in both fields and click `OK`{.action}. - -> [!warning] -> -> The new password will be accepted regardless of any password complexity. -> -> Keep in mind that this password will allow remote connection to the server once rebooted on its operating system. - -Finish by clicking `Save changes`{.action} and `Exit`{.action}. - -After this, the server needs to be rebooted on the normal operating system. - -### Step 3 - Reboot the server - -First, change the netboot back to "Boot from the hard disk" in your OVHcloud Control Panel (see [step 1](#step1)). - -Then restart the server from the Control Panel. - -Click the `...`{.action} button near "Status" in the "Service Status" section and click `Restart`{.action}. - -![reboot](/pages/assets/screens/control_panel/product-selection/bare-metal-cloud/dedicated-servers/general-information/cp_dedicated_restart.png){.thumbnail} - -## Go further - -Join our [community of users](/links/community). diff --git a/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.en-gb.md b/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.en-gb.md index e6dc5758412..10840bea282 100644 --- a/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.en-gb.md +++ b/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.en-gb.md @@ -1,7 +1,7 @@ --- title: "How to reset the Windows Administrator password with the Windows customer rescue system" excerpt: "Find out how to use the OVHcloud Windows rescue mode to reset the password of the Administrator account on a Windows dedicated server" -updated: 2025-03-06 +updated: 2025-10-22 --- ## Objective @@ -11,6 +11,7 @@ This guide will help you to reset your `Administrator` account password with the ## Requirements - Microsoft Windows Server 2016 or greater installed on your [dedicated server](/links/bare-metal/bare-metal) +- At least 16 GB of RAM installed on the server - Access to the [OVHcloud Control Panel](/links/manager) > [!warning] diff --git a/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.en-ie.md b/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.en-ie.md deleted file mode 100644 index 964de61bca2..00000000000 --- a/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.en-ie.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -title: "How to reset the Windows Administrator password with the Windows customer rescue system" -excerpt: "Find out how to use the OVHcloud Windows rescue mode to reset the password of the Administrator account on a Windows dedicated server" -updated: 2025-03-06 ---- - -## Objective - -This guide will help you to reset your `Administrator` account password with the **Windows customer rescue system**. - -## Requirements - -- Microsoft Windows Server 2016 or greater installed on your [dedicated server](/links/bare-metal/bare-metal) -- Access to the [OVHcloud Control Panel](/links/manager) - -> [!warning] -> -> This guide is not applicable to the **legacy Windows rescue system (WinPE rescue mode)** (see the [rescue mode guide](/pages/bare_metal_cloud/dedicated_servers/rescue_mode) for details). -> -> If your Windows Server version is out of support, you might not be able to activate the current rescue system for Windows. In this case, please refer to our guide page on [how to reset the Windows Administrator password with the legacy Windows rescue system](/pages/bare_metal_cloud/dedicated_servers/changing-admin-password-on-windows) instead. -> The same guide explains an alternative method for resetting the Administrator password using the OVHcloud customer rescue system based on Debian. - -## Instructions - -### Step 1 - Reboot the server into rescue mode - -The system has to be started into the **Windows customer rescue system** before the admin password can be changed. - -For detailed instructions, please refer to the [rescue mode guide](/pages/bare_metal_cloud/dedicated_servers/rescue-customer-windows). - -### Step 2 - Clear the current password - -Connect to your server in Remote Desktop using the credentials provided by email. - -Please note that the user name for the rescue mode is `Administrator`. - -- If your server uses software RAID on your Windows disk, you have to import your Windows local disk to be able to access it: Follow the instructions of the [section A](#sectionA) below. -- If your server does not use software RAID on your Windows disk, you should be able to directly access the local Windows disk as explained in the [section B](#sectionB) of this guide. - -#### A - Importing your local Windows disk - -##### 1. Access disk management - -Right-click the `Start`{.action} menu and select `Disk Management`{.action}. - -![disk_manager_menu](images/disk_manager_menu.png){.thumbnail} - -You can then see the disks and volumes of the server. - -![disk_manager_window](images/disk_manager_window1.png){.thumbnail} - -Your server's Windows disk is probably *Disk 1*. You must import it to be able to access it. - -Please note that if you have several disk groups, the number of the Windows disk may vary. You may have to import several disks to get the Windows one. - -You also have to import the second disk to properly import your software RAID volume. - -##### 2. Import local disks - -Right-click *Disk 1* and select `Online`{.action}. - -![disk_import_disk1](images/disk_manager_disk1on.png){.thumbnail} - -Do the same thing for the second disk (*Disk 2*) to properly import your software RAID volume. - -Right-click *Disk 2* and select `Online`{.action}. - -![disk_import_disk2](images/disk_manager_disk2on.png){.thumbnail} - -Disks are now seen as "Dynamic" and "Foreign". - -Right-click *Disk 1* again and select `Import Foreign Disks`{.action}. - -![disk_import_menu](images/disk_manager_diskimport.png){.thumbnail} - -Click `OK` twice. - -![disk_import1](images/disk_import1.png){.thumbnail} - -![disk_import2](images/disk_import2.png){.thumbnail} - -You can see that the local disk is now accessible and that the Windows disk is drive `(E:)` (spreading on two software RAID disks with Mirrored volume type). - -![disk_import_sync](images/disk_import_sync.png){.thumbnail} - -> [!primary] -> In this example, the volume status is "Resynching" because the server was hard-rebooted into rescue mode. This is an expected status and it is not caused by the rescue mode itself. -> This will not affect data on the volume and resynchronisation will continue once the server is rebooted into its installed OS. - -> [!warning] -> -> You must then use the path of your local Windows directory (here it is `E:\Windows`) when browsing to find the "SAM" configuration file below. - -You can now reset the password by following the instructions below. - -#### B - Reset the password - -To reset passwords, the tool NTPWEdit is required.
-Once you are connected via Remote Desktop, open the browser and download it from its [official website](http://www.cdslow.org.ru/files/ntpwedit/ntpwed07.zip).
-Navigate to the folder where the downloaded ZIP file is located and extract its content.
-Next, open the `ntpwedit64` executable to start the application. - -In this interface, you can manipulate the SAM file in order to clear the admin user's password. - -You must browse the local Windows drive to find your system's SAM file. - -Click the three dots button (`...`{.action}) to browse the drive containing your server's local Windows folder. - -It usually is the `Windows (E:\)` drive. - -![ntpwedit1](images/ntpwedit_1.png){.thumbnail} - -Browse to `E:\WINDOWS\SYSTEM32\CONFIG\`. - -Select and open the SAM file to display the user accounts by clicking `Open`{.action}. - -![ntpwedit_sam](images/SAM.png){.thumbnail} - -Select the user account "admin" and click on `Change password`{.action}. - -![ntpwedit2](images/ntpwedit_2.png){.thumbnail} - -In the popup window, enter your new password in both fields and click `OK`{.action}. - -> [!warning] -> -> The new password will be accepted regardless of any password complexity. -> -> Keep in mind that this password will allow remote connection to the server once rebooted on its operating system. - -Finish by clicking `Save changes`{.action} and `Exit`{.action}. - -After this, the server needs to be rebooted on the normal operating system. - -### Step 3 - Reboot the server - -First, change the netboot back to "Boot from the hard disk" in your OVHcloud Control Panel (see [step 1](#step1)). - -Then restart the server from the Control Panel. - -Click the `...`{.action} button near "Status" in the "Service Status" section and click `Restart`{.action}. - -![reboot](/pages/assets/screens/control_panel/product-selection/bare-metal-cloud/dedicated-servers/general-information/cp_dedicated_restart.png){.thumbnail} - -## Go further - -Join our [community of users](/links/community). diff --git a/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.en-sg.md b/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.en-sg.md deleted file mode 100644 index 964de61bca2..00000000000 --- a/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.en-sg.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -title: "How to reset the Windows Administrator password with the Windows customer rescue system" -excerpt: "Find out how to use the OVHcloud Windows rescue mode to reset the password of the Administrator account on a Windows dedicated server" -updated: 2025-03-06 ---- - -## Objective - -This guide will help you to reset your `Administrator` account password with the **Windows customer rescue system**. - -## Requirements - -- Microsoft Windows Server 2016 or greater installed on your [dedicated server](/links/bare-metal/bare-metal) -- Access to the [OVHcloud Control Panel](/links/manager) - -> [!warning] -> -> This guide is not applicable to the **legacy Windows rescue system (WinPE rescue mode)** (see the [rescue mode guide](/pages/bare_metal_cloud/dedicated_servers/rescue_mode) for details). -> -> If your Windows Server version is out of support, you might not be able to activate the current rescue system for Windows. In this case, please refer to our guide page on [how to reset the Windows Administrator password with the legacy Windows rescue system](/pages/bare_metal_cloud/dedicated_servers/changing-admin-password-on-windows) instead. -> The same guide explains an alternative method for resetting the Administrator password using the OVHcloud customer rescue system based on Debian. - -## Instructions - -### Step 1 - Reboot the server into rescue mode - -The system has to be started into the **Windows customer rescue system** before the admin password can be changed. - -For detailed instructions, please refer to the [rescue mode guide](/pages/bare_metal_cloud/dedicated_servers/rescue-customer-windows). - -### Step 2 - Clear the current password - -Connect to your server in Remote Desktop using the credentials provided by email. - -Please note that the user name for the rescue mode is `Administrator`. - -- If your server uses software RAID on your Windows disk, you have to import your Windows local disk to be able to access it: Follow the instructions of the [section A](#sectionA) below. -- If your server does not use software RAID on your Windows disk, you should be able to directly access the local Windows disk as explained in the [section B](#sectionB) of this guide. - -#### A - Importing your local Windows disk - -##### 1. Access disk management - -Right-click the `Start`{.action} menu and select `Disk Management`{.action}. - -![disk_manager_menu](images/disk_manager_menu.png){.thumbnail} - -You can then see the disks and volumes of the server. - -![disk_manager_window](images/disk_manager_window1.png){.thumbnail} - -Your server's Windows disk is probably *Disk 1*. You must import it to be able to access it. - -Please note that if you have several disk groups, the number of the Windows disk may vary. You may have to import several disks to get the Windows one. - -You also have to import the second disk to properly import your software RAID volume. - -##### 2. Import local disks - -Right-click *Disk 1* and select `Online`{.action}. - -![disk_import_disk1](images/disk_manager_disk1on.png){.thumbnail} - -Do the same thing for the second disk (*Disk 2*) to properly import your software RAID volume. - -Right-click *Disk 2* and select `Online`{.action}. - -![disk_import_disk2](images/disk_manager_disk2on.png){.thumbnail} - -Disks are now seen as "Dynamic" and "Foreign". - -Right-click *Disk 1* again and select `Import Foreign Disks`{.action}. - -![disk_import_menu](images/disk_manager_diskimport.png){.thumbnail} - -Click `OK` twice. - -![disk_import1](images/disk_import1.png){.thumbnail} - -![disk_import2](images/disk_import2.png){.thumbnail} - -You can see that the local disk is now accessible and that the Windows disk is drive `(E:)` (spreading on two software RAID disks with Mirrored volume type). - -![disk_import_sync](images/disk_import_sync.png){.thumbnail} - -> [!primary] -> In this example, the volume status is "Resynching" because the server was hard-rebooted into rescue mode. This is an expected status and it is not caused by the rescue mode itself. -> This will not affect data on the volume and resynchronisation will continue once the server is rebooted into its installed OS. - -> [!warning] -> -> You must then use the path of your local Windows directory (here it is `E:\Windows`) when browsing to find the "SAM" configuration file below. - -You can now reset the password by following the instructions below. - -#### B - Reset the password - -To reset passwords, the tool NTPWEdit is required.
-Once you are connected via Remote Desktop, open the browser and download it from its [official website](http://www.cdslow.org.ru/files/ntpwedit/ntpwed07.zip).
-Navigate to the folder where the downloaded ZIP file is located and extract its content.
-Next, open the `ntpwedit64` executable to start the application. - -In this interface, you can manipulate the SAM file in order to clear the admin user's password. - -You must browse the local Windows drive to find your system's SAM file. - -Click the three dots button (`...`{.action}) to browse the drive containing your server's local Windows folder. - -It usually is the `Windows (E:\)` drive. - -![ntpwedit1](images/ntpwedit_1.png){.thumbnail} - -Browse to `E:\WINDOWS\SYSTEM32\CONFIG\`. - -Select and open the SAM file to display the user accounts by clicking `Open`{.action}. - -![ntpwedit_sam](images/SAM.png){.thumbnail} - -Select the user account "admin" and click on `Change password`{.action}. - -![ntpwedit2](images/ntpwedit_2.png){.thumbnail} - -In the popup window, enter your new password in both fields and click `OK`{.action}. - -> [!warning] -> -> The new password will be accepted regardless of any password complexity. -> -> Keep in mind that this password will allow remote connection to the server once rebooted on its operating system. - -Finish by clicking `Save changes`{.action} and `Exit`{.action}. - -After this, the server needs to be rebooted on the normal operating system. - -### Step 3 - Reboot the server - -First, change the netboot back to "Boot from the hard disk" in your OVHcloud Control Panel (see [step 1](#step1)). - -Then restart the server from the Control Panel. - -Click the `...`{.action} button near "Status" in the "Service Status" section and click `Restart`{.action}. - -![reboot](/pages/assets/screens/control_panel/product-selection/bare-metal-cloud/dedicated-servers/general-information/cp_dedicated_restart.png){.thumbnail} - -## Go further - -Join our [community of users](/links/community). diff --git a/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.en-us.md b/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.en-us.md deleted file mode 100644 index 964de61bca2..00000000000 --- a/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.en-us.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -title: "How to reset the Windows Administrator password with the Windows customer rescue system" -excerpt: "Find out how to use the OVHcloud Windows rescue mode to reset the password of the Administrator account on a Windows dedicated server" -updated: 2025-03-06 ---- - -## Objective - -This guide will help you to reset your `Administrator` account password with the **Windows customer rescue system**. - -## Requirements - -- Microsoft Windows Server 2016 or greater installed on your [dedicated server](/links/bare-metal/bare-metal) -- Access to the [OVHcloud Control Panel](/links/manager) - -> [!warning] -> -> This guide is not applicable to the **legacy Windows rescue system (WinPE rescue mode)** (see the [rescue mode guide](/pages/bare_metal_cloud/dedicated_servers/rescue_mode) for details). -> -> If your Windows Server version is out of support, you might not be able to activate the current rescue system for Windows. In this case, please refer to our guide page on [how to reset the Windows Administrator password with the legacy Windows rescue system](/pages/bare_metal_cloud/dedicated_servers/changing-admin-password-on-windows) instead. -> The same guide explains an alternative method for resetting the Administrator password using the OVHcloud customer rescue system based on Debian. - -## Instructions - -### Step 1 - Reboot the server into rescue mode - -The system has to be started into the **Windows customer rescue system** before the admin password can be changed. - -For detailed instructions, please refer to the [rescue mode guide](/pages/bare_metal_cloud/dedicated_servers/rescue-customer-windows). - -### Step 2 - Clear the current password - -Connect to your server in Remote Desktop using the credentials provided by email. - -Please note that the user name for the rescue mode is `Administrator`. - -- If your server uses software RAID on your Windows disk, you have to import your Windows local disk to be able to access it: Follow the instructions of the [section A](#sectionA) below. -- If your server does not use software RAID on your Windows disk, you should be able to directly access the local Windows disk as explained in the [section B](#sectionB) of this guide. - -#### A - Importing your local Windows disk - -##### 1. Access disk management - -Right-click the `Start`{.action} menu and select `Disk Management`{.action}. - -![disk_manager_menu](images/disk_manager_menu.png){.thumbnail} - -You can then see the disks and volumes of the server. - -![disk_manager_window](images/disk_manager_window1.png){.thumbnail} - -Your server's Windows disk is probably *Disk 1*. You must import it to be able to access it. - -Please note that if you have several disk groups, the number of the Windows disk may vary. You may have to import several disks to get the Windows one. - -You also have to import the second disk to properly import your software RAID volume. - -##### 2. Import local disks - -Right-click *Disk 1* and select `Online`{.action}. - -![disk_import_disk1](images/disk_manager_disk1on.png){.thumbnail} - -Do the same thing for the second disk (*Disk 2*) to properly import your software RAID volume. - -Right-click *Disk 2* and select `Online`{.action}. - -![disk_import_disk2](images/disk_manager_disk2on.png){.thumbnail} - -Disks are now seen as "Dynamic" and "Foreign". - -Right-click *Disk 1* again and select `Import Foreign Disks`{.action}. - -![disk_import_menu](images/disk_manager_diskimport.png){.thumbnail} - -Click `OK` twice. - -![disk_import1](images/disk_import1.png){.thumbnail} - -![disk_import2](images/disk_import2.png){.thumbnail} - -You can see that the local disk is now accessible and that the Windows disk is drive `(E:)` (spreading on two software RAID disks with Mirrored volume type). - -![disk_import_sync](images/disk_import_sync.png){.thumbnail} - -> [!primary] -> In this example, the volume status is "Resynching" because the server was hard-rebooted into rescue mode. This is an expected status and it is not caused by the rescue mode itself. -> This will not affect data on the volume and resynchronisation will continue once the server is rebooted into its installed OS. - -> [!warning] -> -> You must then use the path of your local Windows directory (here it is `E:\Windows`) when browsing to find the "SAM" configuration file below. - -You can now reset the password by following the instructions below. - -#### B - Reset the password - -To reset passwords, the tool NTPWEdit is required.
-Once you are connected via Remote Desktop, open the browser and download it from its [official website](http://www.cdslow.org.ru/files/ntpwedit/ntpwed07.zip).
-Navigate to the folder where the downloaded ZIP file is located and extract its content.
-Next, open the `ntpwedit64` executable to start the application. - -In this interface, you can manipulate the SAM file in order to clear the admin user's password. - -You must browse the local Windows drive to find your system's SAM file. - -Click the three dots button (`...`{.action}) to browse the drive containing your server's local Windows folder. - -It usually is the `Windows (E:\)` drive. - -![ntpwedit1](images/ntpwedit_1.png){.thumbnail} - -Browse to `E:\WINDOWS\SYSTEM32\CONFIG\`. - -Select and open the SAM file to display the user accounts by clicking `Open`{.action}. - -![ntpwedit_sam](images/SAM.png){.thumbnail} - -Select the user account "admin" and click on `Change password`{.action}. - -![ntpwedit2](images/ntpwedit_2.png){.thumbnail} - -In the popup window, enter your new password in both fields and click `OK`{.action}. - -> [!warning] -> -> The new password will be accepted regardless of any password complexity. -> -> Keep in mind that this password will allow remote connection to the server once rebooted on its operating system. - -Finish by clicking `Save changes`{.action} and `Exit`{.action}. - -After this, the server needs to be rebooted on the normal operating system. - -### Step 3 - Reboot the server - -First, change the netboot back to "Boot from the hard disk" in your OVHcloud Control Panel (see [step 1](#step1)). - -Then restart the server from the Control Panel. - -Click the `...`{.action} button near "Status" in the "Service Status" section and click `Restart`{.action}. - -![reboot](/pages/assets/screens/control_panel/product-selection/bare-metal-cloud/dedicated-servers/general-information/cp_dedicated_restart.png){.thumbnail} - -## Go further - -Join our [community of users](/links/community). diff --git a/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.es-es.md b/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.es-es.md index a0c86dfb631..a15bca11a42 100644 --- a/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.es-es.md +++ b/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.es-es.md @@ -1,7 +1,7 @@ --- title: "Cómo restablecer la contraseña de administrador con Rescue-Customer-Windows" excerpt: "Cómo restablecer la contraseña de administrador con Rescue-Customer-Windows" -updated: 2025-03-06 +updated: 2025-10-22 --- ## Objetivo @@ -11,6 +11,7 @@ Esta guía explica cómo restaurar la contraseña de `Administrator` con **Windo ## Requisitos - Microsoft Windows Server 2016 o superior instalado en su [servidor dedicado](/links/bare-metal/bare-metal) +- Al menos 16 GB de RAM instalados en el servidor - Acceso al [área de cliente de OVHcloud](/links/manager) > [!warning] diff --git a/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.es-us.md b/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.es-us.md deleted file mode 100644 index a0c86dfb631..00000000000 --- a/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.es-us.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -title: "Cómo restablecer la contraseña de administrador con Rescue-Customer-Windows" -excerpt: "Cómo restablecer la contraseña de administrador con Rescue-Customer-Windows" -updated: 2025-03-06 ---- - -## Objetivo - -Esta guía explica cómo restaurar la contraseña de `Administrator` con **Windows customer rescue system**. - -## Requisitos - -- Microsoft Windows Server 2016 o superior instalado en su [servidor dedicado](/links/bare-metal/bare-metal) -- Acceso al [área de cliente de OVHcloud](/links/manager) - -> [!warning] -> -> Esta guía no se aplica al sistema Windows rescue antiguo (modo de rescate WinPE)** (consulte la [guía del modo de rescate](/pages/bare_metal_cloud/dedicated_servers/rescue_mode) para obtener más información). -> -> Si su versión de Windows Server no es compatible, es posible que no pueda activar el sistema de rescate actual para Windows. En este caso, consulte [nuestra guía sobre cómo restaurar la contraseña de administrador de Windows con el sistema Windows rescue *legacy*](/pages/bare_metal_cloud/dedicated_servers/changing-admin-password-on-windows). -> También encontrará un método alternativo para restaurar la contraseña de administrador con el sistema de rescate customer de OVHcloud basado en Debian. - -## Procedimiento - -### Paso 1 - Reiniciar el servidor en modo de rescate - -El sistema se debe iniciar en modo **Windows customer rescue system** para poder cambiar la contraseña. - -Para más información, consulte la [guide sur le mode rescue](/pages/bare_metal_cloud/dedicated_servers/rescue-customer-windows). - -### Paso 2 - Borrar la contraseña actual - -Conéctese al servidor con la conexión a Escritorio remoto (RDP) y las credenciales de correo electrónico. - -Tenga en cuenta que el nombre de usuario es `Administrator`. - -- Si su servidor utiliza un RAID por software en el disco del sistema, deberá importarlo antes de poder restablecer la contraseña: siga las instrucciones de la [sección A](#sectionA) de esta guía. -- Si su servidor no utiliza RAID por software en el disco del sistema, puede restablecer directamente la contraseña siguiendo las instrucciones de la [sección B](#sectionB) de esta guía. - -#### A - Importar el disco local de Windows - -##### 1. Acceder a la gestión de discos - -Haga clic derecho en el menú `Inicio`{.action} y seleccione `Disk Management`{.action}. - -![disk_manager_menu](images/disk_manager_menu.png){.thumbnail} - -Ahora puede ver los discos y volúmenes del servidor. - -![disk_manager_window](images/disk_manager_window1.png){.thumbnail} - -El disco que contiene Windows en su servidor es probablemente el *disk 1*, por lo que deberá importarlo para poder acceder a él. - -Tenga en cuenta que si su servidor tiene varios grupos de discos, el número de disco que contiene Windows puede ser diferente y es posible que tenga que importar varios discos antes de encontrarlo. - -También debe importar el segundo disco para importar correctamente el volumen de RAID por software. - -##### 2. Importar discos - -Haga clic derecho en *Disk 1* y seleccione `Online`{.action}. - -![disk_import_disk1](images/disk_manager_disk1on.png){.thumbnail} - -Haga lo mismo con el segundo disco (Disk 2) para importar correctamente el volumen de RAID por software. - -Haga clic derecho en *Disk 2* y seleccione`Online`{.action}. - -![disk_import_disk2](images/disk_manager_disk2on.png){.thumbnail} - -Los discos ahora aparecen como "*Dynamic*" y "*Foreign*". - -Haga clic derecho en *Disk 1* y seleccione `Import Foreign Disks`{.action}. - -![disk_import_menu](images/disk_manager_diskimport.png){.thumbnail} - -Haga doble clic en `OK`{.action}. - -![disk_import1](images/disk_import1.png){.thumbnail} - -![disk_import2](images/disk_import2.png){.thumbnail} - -El disco local ya está accesible y el disco Windows corresponde al volumen `(E:)` (que se extiende en dos discos configurados en RAID por software de tipo Mirrored volume). - -![disk_import_sync](images/disk_import_sync.png){.thumbnail} - -> [!primary] -> -> En este ejemplo, el estado del volumen es "Resynching" porque el servidor se reinició de forma inesperada en modo de rescate. Es un estado normal que no es causado por el rescate en sí. -> Esto no afectará a los datos del volumen y la resincronización continuará después de reiniciar el servidor en su sistema instalado. - -> [!warning] -> -> Debe utilizar la ruta de acceso a la carpeta local de Windows (en este caso, E:\Windows) cuando vaya a buscar el archivo de configuración _SAM_ en la siguiente sección. - -Ahora puede restablecer la contraseña siguiendo las instrucciones de la siguiente sección. - -#### B - Restablecer la contraseña - -Para restablecer una contraseña, es necesario utilizar la utilidad NTPWEdit. - -Una vez conectado a través del Escritorio remoto (RDP), abra el explorador de Internet (MS Edge) y descargue la utilidad desde el [sitio web oficial](http://www.cdslow.org.ru/files/ntpwedit/ntpwed07.zip). - -Desplácese hasta la carpeta en la que se encuentra el archivo ZIP descargado y extraiga el contenido. - -A continuación, abra el ejecutable `ntpwedit64.exe` para iniciar la aplicación. - -En esta interfaz, puede manipular el archivo *SAM* para borrar la contraseña del usuario admin. - -Debe explorar la carpeta local de Windows para encontrar el archivo *SAM* del sistema. - -Haga clic en el botón `...`{.action} para navegar a la unidad en la que se encuentra la carpeta local de Windows. - -Normalmente, es la unidad `Windows (E:\)` - -![ntpwedit1](images/ntpwedit_1.png){.thumbnail} - -Desplácese hasta `E:\WINDOWS\SYSTEM32\CONFIG\`. - -Seleccione y abra el archivo *SAM* para ver las cuentas de usuario seleccionando `Open`{.action}. - -![ntpwedit_sam](images/SAM.png) - -Seleccione la cuenta de usuario "admin" y haga clic en `Change password`{.action}. - -![ntpwedit2](images/ntpwedit_2.png){.thumbnail} - -En la nueva ventana, escriba la nueva contraseña en ambos campos y haga clic en `OK`{.action}. - -> [!warning] -> -> Se aceptará la nueva contraseña sin comprobar su complejidad. -> -> Tenga en cuenta que esta contraseña le permitirá conectarse de forma remota al servidor una vez reiniciado en su sistema operativo. - -Finalice haciendo clic en `Save changes`{.action} y luego en `Exit`{.action}. - -El servidor debe reiniciarse en el sistema operativo normal. - -### Paso 3 - Reiniciar el servidor - -En primer lugar, sustituya el netboot por `Booter en el disco duro`{.action} en el área de cliente de OVHcloud (ver [Paso 1](#step1)). - -A continuación, reinicie el servidor desde el área de cliente. Haga clic en el botón `...`{.action} junto a "Estado de los servicios" y seleccione `Reiniciar`{.action}. - -![reboot](/pages/assets/screens/control_panel/product-selection/bare-metal-cloud/dedicated-servers/general-information/cp_dedicated_restart.png){.thumbnail} - -## Más información - -Interactúe con nuestra [comunidad de usuarios](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.fr-ca.md b/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.fr-ca.md deleted file mode 100644 index f34125cbbaf..00000000000 --- a/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.fr-ca.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -title: "Comment réinitialiser le mot de passe administrateur avec Rescue-Customer-Windows" -excerpt: "Comment réinitialiser le mot de passe administrateur avec Rescue-Customer-Windows" -updated: 2025-03-06 ---- - -## Objectif - -Ce guide vous explique comment réinitialiser le mot de passe `Administrator` grâce au **Windows customer rescue system**. - -## Prérequis - -- Microsoft Windows Server 2016 ou supérieur installé sur votre [serveur dédié](/links/bare-metal/bare-metal) -- Accès à l’[espace client OVHcloud](/links/manager) - -> [!warning] -> -> Ce guide n’est pas applicable à l'**ancien système Windows rescue (mode rescue WinPE)** (voir le [guide du mode rescue](/pages/bare_metal_cloud/dedicated_servers/rescue_mode) pour plus de détails). -> -> Si votre version de Windows Server n'est pas prise en charge, vous ne pourrez peut-être pas activer le système rescue actuel pour Windows. Dans ce cas, veuillez consulter notre guide expliquant [comment réinitialiser le mot de passe administrateur Windows avec le système Windows rescue *legacy*](/pages/bare_metal_cloud/dedicated_servers/changing-admin-password-on-windows). -> Vous y trouverez également une méthode alternative pour réinitialiser le mot de passe administrateur à l’aide du système rescue customer OVHcloud basé sur Debian. - -## En pratique - -### Étape 1 - Redémarrer le serveur en mode rescue - -Le système doit être démarré en mode **Windows customer rescue system** avant que le mot de passe puisse être changé. - -Pour plus de détails, référez-vous au [guide sur le mode rescue](/pages/bare_metal_cloud/dedicated_servers/rescue-customer-windows). - -### Étape 2 - Effacer le mot de passe courant - -Connectez-vous au serveur grace à la « Connexion Bureau à distance » (RDP) et aux informations d'identification transmises par e-mail. - -Notez que le nom d'utilisateur est `Administrator`. - -- Si votre serveur utilise un RAID logiciel sur le disque système, vous devez d'abord l'importer avant de pouvoir réinitialiser le mot de passe : suivez les instructions de la [section A](#sectionA) de ce guide. -- Si votre serveur n'utilise pas de RAID logiciel sur le disque système, vous pouvez directement réinitialiser le mot de passe en suivant les instructions de la [section B](#sectionB) de ce guide. - -#### A - Importer votre disque local Windows - -##### 1. Accéder à la gestion des disques - -Faites un clic droit sur le menu `Démarrer`{.action} et selectionnez `Disk Management`{.action}. - -![disk_manager_menu](images/disk_manager_menu.png){.thumbnail} - -Vous pouvez désormais visualiser les disques et volumes du serveur. - -![disk_manager_window](images/disk_manager_window1.png){.thumbnail} - -Le disque contenant Windows sur votre serveur est probablement le *disk 1*, vous devez donc l'importer pour pouvoir y accéder. - -Notez que si votre serveur comporte plusieurs groupes de disques, le numéro de disque contenant Windows peut être différent et vous pourriez avoir à importer plusieurs disques avant de trouver celui-ci. - -Vous devez également importer le deuxième disque pour importer correctement le volume de RAID logiciel. - -##### 2. Importer les disques - -Faites un clic droit sur *Disk 1* et sélectionnez `Online`{.action}. - -![disk_import_disk1](images/disk_manager_disk1on.png){.thumbnail} - -Faites la même chose avec le deuxième disque (Disk 2) pour importer correctement le volume de RAID logiciel. - -Faites un clic droit sur *Disk 2* et sélectionnez`Online`{.action}. - -![disk_import_disk2](images/disk_manager_disk2on.png){.thumbnail} - -Les disques sont maintenant vus comme « *Dynamic* » et « *Foreign* ». - -Faites un clic droit sur *Disk 1* et sélectionnez `Import Foreign Disks`{.action}. - -![disk_import_menu](images/disk_manager_diskimport.png){.thumbnail} - -Cliquez deux fois sur `OK`{.action}. - -![disk_import1](images/disk_import1.png){.thumbnail} - -![disk_import2](images/disk_import2.png){.thumbnail} - -Le disque local est désormais accessible et le disque Windows correpsond au volume "(E:)" (qui s'étale sur deux disques configurés en RAID logiciel de type Mirrored volume). - -![disk_import_sync](images/disk_import_sync.png){.thumbnail} - -> [!primary] -> Dans cet exemple, l'état du volume est "Resynching" car le serveur a été brutalement redémarré en mode rescue. C'est un état normal qui n'est pas causé par le rescue en lui-même. -> Cela n'affectera pas les données du volume et la resynchronisation continuera une fois le serveur redémarré sur son système installé. - -> [!warning] -> -> Vous devez utiliser le chemin vers votre dossier local Windows (ici c'est E:\Windows) quand vous naviguerez pour trouver le fichier de configuration _SAM_ dans la section suivante. - -Vous pouvez maintenant réinitialiser le mot de passe en suivant les instruction de la section suivante. - -#### B - - Réinitialiser le mot de passe - -Pour réinitialiser un mot de passe, l'utilitaire NTPWEdit est nécessaire. - -Un fois connecté via le Bureau à distance (RDP) ouvrez le navigateur internet (MS Edge) et téléchargez l'utilitaire à partir du [site web officiel](http://www.cdslow.org.ru/files/ntpwedit/ntpwed07.zip). - -Naviguez jusqu'au dossier où se trouve le fichier ZIP téléchargé et extrayez le contenu. - -Ouvrez ensuite l'exécutable `ntpwedit64.exe` pour démarrer l'application. - -Sur cette interface, vous pouvez manipuler le fichier *SAM* afin d'effacer le mot de passe de l'utilisateur admin. - -Vous devez naviguer dans le dossier local Windows pour y trouver le fichier *SAM* de votre système. - -Cliquez sur le bouton `...`{.action} pour naviguer dans le lecteur où se trouve le dossier local Windows. - -Généralement, c'est le lecteur `Windows (E:\)` - -![ntpwedit1](images/ntpwedit_1.png){.thumbnail} - -Naviguez jusqu'à `E:\WINDOWS\SYSTEM32\CONFIG\`. - -Sélectionnez et ouvrez le fichier *SAM* pour voir les comptes utilisateurs en sélectionnant `Open`{.action}. - -![ntpwedit_sam](images/SAM.png) - -Sélectionnez le compte utilisateur « admin » puis cliquez sur `Change password`{.action}. - -![ntpwedit2](images/ntpwedit_2.png){.thumbnail} - -Dans la fenêtre qui apparaît, tapez votre nouveau mot de passe dans les deux champs et cliquez sur `OK`{.action}. - -> [!warning] -> -> Le nouveau mot de passe sera accepté sans vérification de sa complexité. -> -> Gardez à l'esprit que ce mot de passe permettra de se connecter à distance sur le serveur, une fois redémarré sur son système d'exploitation. - -Terminez en cliquant sur `Save changes`{.action} puis sur `Exit`{.action}. - -Le serveur doit alors être redémarré sur le système d'exploitation normal. - -### Étape 3 - Redémarrer le serveur - -Commencez par changer le netboot en `Booter sur le disque dur`{.action} dans l'espace client OVHcloud (voir [Etape 1](#step1)). - -Puis redémarrez le serveur à partir de l'espace client. Cliquez sur le bouton `...`{.action} près de la section « État des services » et sélectionnez `Redémarrer`{.action}. - -![reboot](/pages/assets/screens/control_panel/product-selection/bare-metal-cloud/dedicated-servers/general-information/cp_dedicated_restart.png){.thumbnail} - -## Aller plus loin - -Rejoignez notre [communauté d'utilisateurs](/links/community) diff --git a/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.fr-fr.md b/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.fr-fr.md index f34125cbbaf..3a6f1c7c865 100644 --- a/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.fr-fr.md +++ b/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.fr-fr.md @@ -1,7 +1,7 @@ --- title: "Comment réinitialiser le mot de passe administrateur avec Rescue-Customer-Windows" excerpt: "Comment réinitialiser le mot de passe administrateur avec Rescue-Customer-Windows" -updated: 2025-03-06 +updated: 2025-10-22 --- ## Objectif @@ -11,6 +11,7 @@ Ce guide vous explique comment réinitialiser le mot de passe `Administrator` gr ## Prérequis - Microsoft Windows Server 2016 ou supérieur installé sur votre [serveur dédié](/links/bare-metal/bare-metal) +- Au moins 16 Go de RAM installés sur le serveur - Accès à l’[espace client OVHcloud](/links/manager) > [!warning] diff --git a/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.it-it.md b/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.it-it.md index d9882645cd9..abc9cc4390f 100644 --- a/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.it-it.md +++ b/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.it-it.md @@ -1,7 +1,7 @@ --- title: "Come reimpostare la password amministratore con Rescue-Customer-Windows" excerpt: "Come reimpostare la password amministratore con Rescue-Customer-Windows" -updated: 2025-03-06 +updated: 2025-10-22 --- ## Obiettivo @@ -11,6 +11,7 @@ Questa guida ti mostra come ripristinare la password `Administrator` con **Windo ## Prerequisiti - Microsoft Windows Server 2016 o versione successiva installata sul tuo [server dedicato](/links/bare-metal/bare-metal) +- Almeno 16 GB di RAM installati sul server - Accesso allo [Spazio Cliente OVHcloud](/links/manager) > [!warning] diff --git a/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.pl-pl.md b/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.pl-pl.md index d2de6a02445..41b0aed2d5f 100644 --- a/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.pl-pl.md +++ b/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.pl-pl.md @@ -1,7 +1,7 @@ --- title: "Jak zresetować hasło administratora za pomocą Rescue-Customer-Windows" excerpt: "Jak zresetować hasło administratora za pomocą Rescue-Customer-Windows" -updated: 2025-03-06 +updated: 2025-10-22 --- @@ -12,6 +12,7 @@ Niniejszy przewodnik wyjaśnia, jak zresetować hasło `Administrator` przy uży ## Wymagania początkowe - Microsoft Windows Server 2016 lub nowszy zainstalowany na Twoim [serwerze dedykowanym](/links/bare-metal/bare-metal) +- Co najmniej 16 GB RAM zainstalowanych na serwerze - Dostęp do [panelu klienta OVHcloud](/links/manager) > [!warning] diff --git a/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.pt-pt.md b/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.pt-pt.md index 190e46db667..afc16f5c122 100644 --- a/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.pt-pt.md +++ b/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows/guide.pt-pt.md @@ -1,7 +1,7 @@ --- title: "Como redefinir a palavra-passe de administrador com o Rescue-Customer-Windows" excerpt: "Como redefinir a palavra-passe de administrador com o Rescue-Customer-Windows" -updated: 2025-03-06 +updated: 2025-10-22 --- ## Objetivo @@ -11,6 +11,7 @@ Este manual explica como reinicializar a palavra-passe "Administrator" graças a ## Requisitos - Microsoft Windows Server 2016 ou superior instalado no seu [servidor dedicado](/links/bare-metal/bare-metal) +- Pelo menos 16 GB de RAM instaladas no servidor - Acesso à [Área de Cliente OVHcloud](/links/manager) > [!warning] diff --git a/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.de-de.md b/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.de-de.md index c6470670ef1..5cae471b956 100644 --- a/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.de-de.md +++ b/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.de-de.md @@ -1,13 +1,9 @@ --- title: "Wiederherstellen des Serverzugriffs bei Passwortverlust" excerpt: "Erfahren Sie hier, wie Sie mit dem OVHcloud Rescue-Modus ein neues Passwort für einen Benutzer-Account auf einem GNU/Linux-Betriebssystem einrichten" -updated: 2024-02-19 +updated: 2025-10-02 --- -> [!primary] -> Diese Übersetzung wurde durch unseren Partner SYSTRAN automatisch erstellt. In manchen Fällen können ungenaue Formulierungen verwendet worden sein, z.B. bei der Beschriftung von Schaltflächen oder technischen Details. Bitte ziehen Sie im Zweifelsfall die englische oder französische Fassung der Anleitung zu Rate. Möchten Sie mithelfen, diese Übersetzung zu verbessern? Dann nutzen Sie dazu bitte den Button "Beitragen" auf dieser Seite. -> - ## Ziel Ohne eine alternative Authentifizierungsmethode oder einen anderen Benutzer-Account bedeutet der Verlust Ihres Passworts, dass Sie sich nicht mehr auf regulärem Weg bei Ihrem Server einloggen können. @@ -28,7 +24,7 @@ In diesem Fall können Sie sich über den OVHcloud Rescue-Modus mit Ihrem Server > [!primary] > -> Diese Anleitung gilt nicht für Installationen von **Windows** Server. Folgen Sie stattdessen unserer Anleitung zum [Ändern des Administratorpassworts auf einem Windows Dedicated Server](/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows) oder [Ändern des Administratorpassworts auf einem Windows VPS](/pages/bare_metal_cloud/virtual_private_servers/resetting_a_windows_password). +> Diese Anleitung gilt nicht für Installationen von **Windows** Server. Folgen Sie stattdessen unserer Anleitung zum [Ändern des Administrator-Passworts auf einem Windows Dedicated Server](/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows) oder [Ändern des Administrator-Passworts auf einem Windows VPS](/pages/bare_metal_cloud/virtual_private_servers/resetting_a_windows_password). > ## In der praktischen Anwendung @@ -39,8 +35,8 @@ Lesen Sie ggf. auch unsere Anleitung zu den ersten Schritten für Ihren Dienst: - Für einen [Dedicated Server der Reihe **Eco**](/pages/bare_metal_cloud/dedicated_servers/getting-started-with-dedicated-server-eco) - Für einen [VPS](/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps) - > [!warning] +> > OVHcloud stellt Ihnen Dienstleistungen zur Verfügung, für deren Konfiguration und Verwaltung Sie die alleinige Verantwortung tragen. Es liegt somit bei Ihnen, sicherzustellen, dass diese ordnungsgemäß funktionieren. > > Wir stellen Ihnen diese Anleitung zur Verfügung, um Ihnen bei der Bewältigung alltäglicher Verwaltungsaufgaben zu helfen. Dennoch empfehlen wir Ihnen, einen [spezialisierten Dienstleister](/links/partner) zu kontaktieren oder Ihre Fragen an die [OVHcloud Community](https://community.ovh.com/en/) zu richten, wenn Sie Schwierigkeiten oder Zweifel hinsichtlich der Verwaltung, Nutzung oder Implementierung der Dienste auf einem Server haben. @@ -48,7 +44,7 @@ Lesen Sie ggf. auch unsere Anleitung zu den ersten Schritten für Ihren Dienst: -### Schritt 1: Server im Rescue-Modus neu starten +### Schritt 1 - Server im Rescue-Modus neu starten Folgen Sie den Schritten unserer Anleitungen zum Rescue-Modus, um sich mit Ihrem Server zu verbinden und Ihre Partitionen zu mounten: @@ -69,27 +65,59 @@ Der exakte Befehl hängt vom verwendeten Mountpunkt ab. Wenn Sie Ihre Partition chroot /mnt/ ``` -### Schritt 2: Benutzer-Passwort zurücksetzen +### Schritt 2 - Identifizieren der Benutzer-Accounts und Zurücksetzen des Passworts -Hinweis: Bei einer GNU/Linux-Distribution **zeigt eine Passworteingabeaufforderung keine Tastatureingaben an**. +Nachdem Sie die Partition gemountet und `chroot /mnt` (oder den entsprechenden Befehl) ausgeführt haben, verfügen Sie über **root**-Berechtigungen auf dem System. -Ändern Sie das Passwort des Benutzers mit folgendem Befehl (ersetzen Sie `username` durch den Namen des Benutzer-Accounts): +Ermitteln Sie ggf. alle relevanten Benutzer-Accounts mithilfe des folgenden Befehls: ```bash -passwd username +cat /etc/passwd ``` -```text -New password: -Retype new password: -passwd: password updated successfully +Beispielausgabe (gekürzt): + +```console +daemon:x:1:1:daemon:/usr/sbin:/usr/sbin/nologin +bin:x:2:2:bin:/bin:/usr/sbin/nologin +sys:x:3:3:sys:/dev:/usr/sbin/nologin +. +nobody:x:65534:65534:nobody:/nonexistent:/usr/sbin/nologin +systemd-network:x:998:998:systemd Network Management:/:/usr/sbin/nologin +syslog:x:102:102::/nonexistent:/usr/sbin/nologin +sshd:x:105:65534::/run/sshd:/usr/sbin/nologin +. +user1:x:1000:1000:Ubuntu:/home/ubuntu:/bin/bash ``` -Denken Sie daran, den regulären Startmodus zu verwenden, wenn Sie Ihren Server im [OVHcloud Kundencenter](/links/manager) neu starten. +Finden Sie Ihre(n) zu bearbeitenden Benutzernamen in der Liste der Accounts. + +Geben Sie folgenden Befehl ein, um das Kennwort für einen bestimmten Account zu ändern (z. B. **user1**): + +```bash +passwd user1 +``` + +Geben Sie das neue Kennwort zweimal ein und bestätigen Sie: + +```console +# New password: +# Retype new password: +# passwd: password updated successfully +``` + +Bei einer GNU/Linux-Distribution zeigt **die Eingabeaufforderung für Passwörter Ihre Tastatureingabe nicht an**. + +> [!primary] +> +> Vermeiden Sie es, den Befehl `passwd` ohne Argumente auszuführen: Dieser Befehl ändert das Passwort des aktuellen Kontos (**root** nach der Ausführung von `chroot` ist). +> Verwenden Sie deshalb `passwd `. + +Denken Sie daran, den regulären Startmodus zu aktivieren, bevor Sie Ihren Server im [OVHcloud Kundencenter](/links/manager) neu starten. Folgen Sie bei Bedarf der passenden [Anleitung zum Rescue-Modus](#step1). -Sie haben nun mit Ihrem neuen Passwort Zugriff auf den Server. +Der bearbeitete Benutzer-Account hat nun Zugriff auf den Server mit dem neuen Passwort. ## Weiterführende Informationen @@ -101,4 +129,4 @@ Sie haben nun mit Ihrem neuen Passwort Zugriff auf den Server. [Konfigurieren von Benutzer-Accounts und Root-Zugriff auf einem Server](/pages/bare_metal_cloud/dedicated_servers/changing_root_password_linux_ds) -Für den Austausch mit unserer User Community gehen Sie auf . \ No newline at end of file +Für den Austausch mit unserer User Community gehen Sie auf . diff --git a/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.en-asia.md b/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.en-asia.md index e2a756b89ca..c40afb03379 100644 --- a/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.en-asia.md +++ b/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.en-asia.md @@ -1,10 +1,9 @@ --- title: How to recover server access if your user password is lost excerpt: Find out how to configure a new password for a user account on a GNU/Linux operating system with the OVHcloud rescue mode -updated: 2024-02-19 +updated: 2025-10-02 --- - ## Objective Without a different mode of authentication or another user account, losing your password means you can no longer log in to your server in a regular way. @@ -24,6 +23,7 @@ To recover access to a server that you log in to with an SSH key, refer to our g - Access to the [OVHcloud Control Panel](/links/manager) > [!primary] +> > This guide is not applicable for **Windows** server installations. Please refer to our guides on [How to change the admin password on a Windows dedicated server](/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows) and [How to change the admin password on a Windows VPS](/pages/bare_metal_cloud/virtual_private_servers/resetting_a_windows_password). > @@ -36,14 +36,15 @@ Be sure to consult our "Getting started" guides as well: - For a [VPS](/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps) > [!warning] ->OVHcloud is providing you with services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they function correctly. > ->This guide is designed to assist you in common tasks as much as possible. Nevertheless, we recommend that you contact a [specialist service provider](/links/partner) or reach out to [our community](https://community.ovh.com/en/) if you face difficulties or doubts concerning the administration, usage or implementation of services on a server. +> OVHcloud is providing you with services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they function correctly. +> +> This guide is designed to assist you in common tasks as much as possible. Nevertheless, we recommend that you contact a [specialist service provider](/links/partner) or reach out to [our community](https://community.ovh.com/en/) if you face difficulties or doubts concerning the administration, usage or implementation of services on a server. > -### Step 1: Restart the server into rescue mode +### Step 1 - Restart the server into rescue mode Use the corresponding rescue mode guide to connect to your server and mount your partitions: @@ -64,28 +65,58 @@ The exact command depends on the mountpoint you used. For example, if you have m chroot /mnt/ ``` -### Step 2: Reset the user password +### Step 2 - Identify the user account(s) and reset the password -Note: On a GNU/Linux distribution, **a password prompt will not display your keyboard inputs**. +After mounting the partition and running `chroot /mnt` (or the equivalent), you have **root** privileges on the mounted system. -Change the user password with the following command (replace `username` with the actual name of the user account): +If needed, before changing a password, **identify existing accounts** using the following command: ```bash -passwd username +cat /etc/passwd +``` + +Example output (shortened): + +```console +daemon:x:1:1:daemon:/usr/sbin:/usr/sbin/nologin +bin:x:2:2:bin:/bin:/usr/sbin/nologin +sys:x:3:3:sys:/dev:/usr/sbin/nologin +. +nobody:x:65534:65534:nobody:/nonexistent:/usr/sbin/nologin +systemd-network:x:998:998:systemd Network Management:/:/usr/sbin/nologin +syslog:x:102:102::/nonexistent:/usr/sbin/nologin +sshd:x:105:65534::/run/sshd:/usr/sbin/nologin +. +user1:x:1000:1000:Ubuntu:/home/ubuntu:/bin/bash ``` -```text -New password: -Retype new password: -passwd: password updated successfully +Find your user name(s) in the list of accounts. +To change the password for a specific account (e.g. **user1**), enter this command: + +```bash +passwd user1 ``` +Enter the new password twice and confirm: + +```console +# New password: +# Retype new password: +# passwd: password updated successfully +``` + +On a GNU/Linux distribution, **a password prompt does not display your keyboard input**. + +> [!primary] +> +> Avoid running the `passwd` command without arguments: This command modifies the password of the current account (which is **root** after executing `chroot`). +> Always specify `passwd `. + Remember to use the regular boot mode of your server when restarting it in your [OVHcloud Control Panel](/links/manager). Refer to the corresponding [rescue mode guide](#step1) if necessary. -You have now access to the server with your new password. - +The modified user account has now access to the server with the new password. ## Go further diff --git a/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.en-au.md b/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.en-au.md index e2a756b89ca..c40afb03379 100644 --- a/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.en-au.md +++ b/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.en-au.md @@ -1,10 +1,9 @@ --- title: How to recover server access if your user password is lost excerpt: Find out how to configure a new password for a user account on a GNU/Linux operating system with the OVHcloud rescue mode -updated: 2024-02-19 +updated: 2025-10-02 --- - ## Objective Without a different mode of authentication or another user account, losing your password means you can no longer log in to your server in a regular way. @@ -24,6 +23,7 @@ To recover access to a server that you log in to with an SSH key, refer to our g - Access to the [OVHcloud Control Panel](/links/manager) > [!primary] +> > This guide is not applicable for **Windows** server installations. Please refer to our guides on [How to change the admin password on a Windows dedicated server](/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows) and [How to change the admin password on a Windows VPS](/pages/bare_metal_cloud/virtual_private_servers/resetting_a_windows_password). > @@ -36,14 +36,15 @@ Be sure to consult our "Getting started" guides as well: - For a [VPS](/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps) > [!warning] ->OVHcloud is providing you with services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they function correctly. > ->This guide is designed to assist you in common tasks as much as possible. Nevertheless, we recommend that you contact a [specialist service provider](/links/partner) or reach out to [our community](https://community.ovh.com/en/) if you face difficulties or doubts concerning the administration, usage or implementation of services on a server. +> OVHcloud is providing you with services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they function correctly. +> +> This guide is designed to assist you in common tasks as much as possible. Nevertheless, we recommend that you contact a [specialist service provider](/links/partner) or reach out to [our community](https://community.ovh.com/en/) if you face difficulties or doubts concerning the administration, usage or implementation of services on a server. > -### Step 1: Restart the server into rescue mode +### Step 1 - Restart the server into rescue mode Use the corresponding rescue mode guide to connect to your server and mount your partitions: @@ -64,28 +65,58 @@ The exact command depends on the mountpoint you used. For example, if you have m chroot /mnt/ ``` -### Step 2: Reset the user password +### Step 2 - Identify the user account(s) and reset the password -Note: On a GNU/Linux distribution, **a password prompt will not display your keyboard inputs**. +After mounting the partition and running `chroot /mnt` (or the equivalent), you have **root** privileges on the mounted system. -Change the user password with the following command (replace `username` with the actual name of the user account): +If needed, before changing a password, **identify existing accounts** using the following command: ```bash -passwd username +cat /etc/passwd +``` + +Example output (shortened): + +```console +daemon:x:1:1:daemon:/usr/sbin:/usr/sbin/nologin +bin:x:2:2:bin:/bin:/usr/sbin/nologin +sys:x:3:3:sys:/dev:/usr/sbin/nologin +. +nobody:x:65534:65534:nobody:/nonexistent:/usr/sbin/nologin +systemd-network:x:998:998:systemd Network Management:/:/usr/sbin/nologin +syslog:x:102:102::/nonexistent:/usr/sbin/nologin +sshd:x:105:65534::/run/sshd:/usr/sbin/nologin +. +user1:x:1000:1000:Ubuntu:/home/ubuntu:/bin/bash ``` -```text -New password: -Retype new password: -passwd: password updated successfully +Find your user name(s) in the list of accounts. +To change the password for a specific account (e.g. **user1**), enter this command: + +```bash +passwd user1 ``` +Enter the new password twice and confirm: + +```console +# New password: +# Retype new password: +# passwd: password updated successfully +``` + +On a GNU/Linux distribution, **a password prompt does not display your keyboard input**. + +> [!primary] +> +> Avoid running the `passwd` command without arguments: This command modifies the password of the current account (which is **root** after executing `chroot`). +> Always specify `passwd `. + Remember to use the regular boot mode of your server when restarting it in your [OVHcloud Control Panel](/links/manager). Refer to the corresponding [rescue mode guide](#step1) if necessary. -You have now access to the server with your new password. - +The modified user account has now access to the server with the new password. ## Go further diff --git a/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.en-ca.md b/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.en-ca.md index e2a756b89ca..c40afb03379 100644 --- a/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.en-ca.md +++ b/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.en-ca.md @@ -1,10 +1,9 @@ --- title: How to recover server access if your user password is lost excerpt: Find out how to configure a new password for a user account on a GNU/Linux operating system with the OVHcloud rescue mode -updated: 2024-02-19 +updated: 2025-10-02 --- - ## Objective Without a different mode of authentication or another user account, losing your password means you can no longer log in to your server in a regular way. @@ -24,6 +23,7 @@ To recover access to a server that you log in to with an SSH key, refer to our g - Access to the [OVHcloud Control Panel](/links/manager) > [!primary] +> > This guide is not applicable for **Windows** server installations. Please refer to our guides on [How to change the admin password on a Windows dedicated server](/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows) and [How to change the admin password on a Windows VPS](/pages/bare_metal_cloud/virtual_private_servers/resetting_a_windows_password). > @@ -36,14 +36,15 @@ Be sure to consult our "Getting started" guides as well: - For a [VPS](/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps) > [!warning] ->OVHcloud is providing you with services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they function correctly. > ->This guide is designed to assist you in common tasks as much as possible. Nevertheless, we recommend that you contact a [specialist service provider](/links/partner) or reach out to [our community](https://community.ovh.com/en/) if you face difficulties or doubts concerning the administration, usage or implementation of services on a server. +> OVHcloud is providing you with services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they function correctly. +> +> This guide is designed to assist you in common tasks as much as possible. Nevertheless, we recommend that you contact a [specialist service provider](/links/partner) or reach out to [our community](https://community.ovh.com/en/) if you face difficulties or doubts concerning the administration, usage or implementation of services on a server. > -### Step 1: Restart the server into rescue mode +### Step 1 - Restart the server into rescue mode Use the corresponding rescue mode guide to connect to your server and mount your partitions: @@ -64,28 +65,58 @@ The exact command depends on the mountpoint you used. For example, if you have m chroot /mnt/ ``` -### Step 2: Reset the user password +### Step 2 - Identify the user account(s) and reset the password -Note: On a GNU/Linux distribution, **a password prompt will not display your keyboard inputs**. +After mounting the partition and running `chroot /mnt` (or the equivalent), you have **root** privileges on the mounted system. -Change the user password with the following command (replace `username` with the actual name of the user account): +If needed, before changing a password, **identify existing accounts** using the following command: ```bash -passwd username +cat /etc/passwd +``` + +Example output (shortened): + +```console +daemon:x:1:1:daemon:/usr/sbin:/usr/sbin/nologin +bin:x:2:2:bin:/bin:/usr/sbin/nologin +sys:x:3:3:sys:/dev:/usr/sbin/nologin +. +nobody:x:65534:65534:nobody:/nonexistent:/usr/sbin/nologin +systemd-network:x:998:998:systemd Network Management:/:/usr/sbin/nologin +syslog:x:102:102::/nonexistent:/usr/sbin/nologin +sshd:x:105:65534::/run/sshd:/usr/sbin/nologin +. +user1:x:1000:1000:Ubuntu:/home/ubuntu:/bin/bash ``` -```text -New password: -Retype new password: -passwd: password updated successfully +Find your user name(s) in the list of accounts. +To change the password for a specific account (e.g. **user1**), enter this command: + +```bash +passwd user1 ``` +Enter the new password twice and confirm: + +```console +# New password: +# Retype new password: +# passwd: password updated successfully +``` + +On a GNU/Linux distribution, **a password prompt does not display your keyboard input**. + +> [!primary] +> +> Avoid running the `passwd` command without arguments: This command modifies the password of the current account (which is **root** after executing `chroot`). +> Always specify `passwd `. + Remember to use the regular boot mode of your server when restarting it in your [OVHcloud Control Panel](/links/manager). Refer to the corresponding [rescue mode guide](#step1) if necessary. -You have now access to the server with your new password. - +The modified user account has now access to the server with the new password. ## Go further diff --git a/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.en-gb.md b/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.en-gb.md index e2a756b89ca..c40afb03379 100644 --- a/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.en-gb.md +++ b/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.en-gb.md @@ -1,10 +1,9 @@ --- title: How to recover server access if your user password is lost excerpt: Find out how to configure a new password for a user account on a GNU/Linux operating system with the OVHcloud rescue mode -updated: 2024-02-19 +updated: 2025-10-02 --- - ## Objective Without a different mode of authentication or another user account, losing your password means you can no longer log in to your server in a regular way. @@ -24,6 +23,7 @@ To recover access to a server that you log in to with an SSH key, refer to our g - Access to the [OVHcloud Control Panel](/links/manager) > [!primary] +> > This guide is not applicable for **Windows** server installations. Please refer to our guides on [How to change the admin password on a Windows dedicated server](/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows) and [How to change the admin password on a Windows VPS](/pages/bare_metal_cloud/virtual_private_servers/resetting_a_windows_password). > @@ -36,14 +36,15 @@ Be sure to consult our "Getting started" guides as well: - For a [VPS](/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps) > [!warning] ->OVHcloud is providing you with services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they function correctly. > ->This guide is designed to assist you in common tasks as much as possible. Nevertheless, we recommend that you contact a [specialist service provider](/links/partner) or reach out to [our community](https://community.ovh.com/en/) if you face difficulties or doubts concerning the administration, usage or implementation of services on a server. +> OVHcloud is providing you with services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they function correctly. +> +> This guide is designed to assist you in common tasks as much as possible. Nevertheless, we recommend that you contact a [specialist service provider](/links/partner) or reach out to [our community](https://community.ovh.com/en/) if you face difficulties or doubts concerning the administration, usage or implementation of services on a server. > -### Step 1: Restart the server into rescue mode +### Step 1 - Restart the server into rescue mode Use the corresponding rescue mode guide to connect to your server and mount your partitions: @@ -64,28 +65,58 @@ The exact command depends on the mountpoint you used. For example, if you have m chroot /mnt/ ``` -### Step 2: Reset the user password +### Step 2 - Identify the user account(s) and reset the password -Note: On a GNU/Linux distribution, **a password prompt will not display your keyboard inputs**. +After mounting the partition and running `chroot /mnt` (or the equivalent), you have **root** privileges on the mounted system. -Change the user password with the following command (replace `username` with the actual name of the user account): +If needed, before changing a password, **identify existing accounts** using the following command: ```bash -passwd username +cat /etc/passwd +``` + +Example output (shortened): + +```console +daemon:x:1:1:daemon:/usr/sbin:/usr/sbin/nologin +bin:x:2:2:bin:/bin:/usr/sbin/nologin +sys:x:3:3:sys:/dev:/usr/sbin/nologin +. +nobody:x:65534:65534:nobody:/nonexistent:/usr/sbin/nologin +systemd-network:x:998:998:systemd Network Management:/:/usr/sbin/nologin +syslog:x:102:102::/nonexistent:/usr/sbin/nologin +sshd:x:105:65534::/run/sshd:/usr/sbin/nologin +. +user1:x:1000:1000:Ubuntu:/home/ubuntu:/bin/bash ``` -```text -New password: -Retype new password: -passwd: password updated successfully +Find your user name(s) in the list of accounts. +To change the password for a specific account (e.g. **user1**), enter this command: + +```bash +passwd user1 ``` +Enter the new password twice and confirm: + +```console +# New password: +# Retype new password: +# passwd: password updated successfully +``` + +On a GNU/Linux distribution, **a password prompt does not display your keyboard input**. + +> [!primary] +> +> Avoid running the `passwd` command without arguments: This command modifies the password of the current account (which is **root** after executing `chroot`). +> Always specify `passwd `. + Remember to use the regular boot mode of your server when restarting it in your [OVHcloud Control Panel](/links/manager). Refer to the corresponding [rescue mode guide](#step1) if necessary. -You have now access to the server with your new password. - +The modified user account has now access to the server with the new password. ## Go further diff --git a/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.en-ie.md b/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.en-ie.md index e2a756b89ca..c40afb03379 100644 --- a/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.en-ie.md +++ b/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.en-ie.md @@ -1,10 +1,9 @@ --- title: How to recover server access if your user password is lost excerpt: Find out how to configure a new password for a user account on a GNU/Linux operating system with the OVHcloud rescue mode -updated: 2024-02-19 +updated: 2025-10-02 --- - ## Objective Without a different mode of authentication or another user account, losing your password means you can no longer log in to your server in a regular way. @@ -24,6 +23,7 @@ To recover access to a server that you log in to with an SSH key, refer to our g - Access to the [OVHcloud Control Panel](/links/manager) > [!primary] +> > This guide is not applicable for **Windows** server installations. Please refer to our guides on [How to change the admin password on a Windows dedicated server](/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows) and [How to change the admin password on a Windows VPS](/pages/bare_metal_cloud/virtual_private_servers/resetting_a_windows_password). > @@ -36,14 +36,15 @@ Be sure to consult our "Getting started" guides as well: - For a [VPS](/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps) > [!warning] ->OVHcloud is providing you with services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they function correctly. > ->This guide is designed to assist you in common tasks as much as possible. Nevertheless, we recommend that you contact a [specialist service provider](/links/partner) or reach out to [our community](https://community.ovh.com/en/) if you face difficulties or doubts concerning the administration, usage or implementation of services on a server. +> OVHcloud is providing you with services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they function correctly. +> +> This guide is designed to assist you in common tasks as much as possible. Nevertheless, we recommend that you contact a [specialist service provider](/links/partner) or reach out to [our community](https://community.ovh.com/en/) if you face difficulties or doubts concerning the administration, usage or implementation of services on a server. > -### Step 1: Restart the server into rescue mode +### Step 1 - Restart the server into rescue mode Use the corresponding rescue mode guide to connect to your server and mount your partitions: @@ -64,28 +65,58 @@ The exact command depends on the mountpoint you used. For example, if you have m chroot /mnt/ ``` -### Step 2: Reset the user password +### Step 2 - Identify the user account(s) and reset the password -Note: On a GNU/Linux distribution, **a password prompt will not display your keyboard inputs**. +After mounting the partition and running `chroot /mnt` (or the equivalent), you have **root** privileges on the mounted system. -Change the user password with the following command (replace `username` with the actual name of the user account): +If needed, before changing a password, **identify existing accounts** using the following command: ```bash -passwd username +cat /etc/passwd +``` + +Example output (shortened): + +```console +daemon:x:1:1:daemon:/usr/sbin:/usr/sbin/nologin +bin:x:2:2:bin:/bin:/usr/sbin/nologin +sys:x:3:3:sys:/dev:/usr/sbin/nologin +. +nobody:x:65534:65534:nobody:/nonexistent:/usr/sbin/nologin +systemd-network:x:998:998:systemd Network Management:/:/usr/sbin/nologin +syslog:x:102:102::/nonexistent:/usr/sbin/nologin +sshd:x:105:65534::/run/sshd:/usr/sbin/nologin +. +user1:x:1000:1000:Ubuntu:/home/ubuntu:/bin/bash ``` -```text -New password: -Retype new password: -passwd: password updated successfully +Find your user name(s) in the list of accounts. +To change the password for a specific account (e.g. **user1**), enter this command: + +```bash +passwd user1 ``` +Enter the new password twice and confirm: + +```console +# New password: +# Retype new password: +# passwd: password updated successfully +``` + +On a GNU/Linux distribution, **a password prompt does not display your keyboard input**. + +> [!primary] +> +> Avoid running the `passwd` command without arguments: This command modifies the password of the current account (which is **root** after executing `chroot`). +> Always specify `passwd `. + Remember to use the regular boot mode of your server when restarting it in your [OVHcloud Control Panel](/links/manager). Refer to the corresponding [rescue mode guide](#step1) if necessary. -You have now access to the server with your new password. - +The modified user account has now access to the server with the new password. ## Go further diff --git a/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.en-sg.md b/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.en-sg.md index e2a756b89ca..c40afb03379 100644 --- a/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.en-sg.md +++ b/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.en-sg.md @@ -1,10 +1,9 @@ --- title: How to recover server access if your user password is lost excerpt: Find out how to configure a new password for a user account on a GNU/Linux operating system with the OVHcloud rescue mode -updated: 2024-02-19 +updated: 2025-10-02 --- - ## Objective Without a different mode of authentication or another user account, losing your password means you can no longer log in to your server in a regular way. @@ -24,6 +23,7 @@ To recover access to a server that you log in to with an SSH key, refer to our g - Access to the [OVHcloud Control Panel](/links/manager) > [!primary] +> > This guide is not applicable for **Windows** server installations. Please refer to our guides on [How to change the admin password on a Windows dedicated server](/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows) and [How to change the admin password on a Windows VPS](/pages/bare_metal_cloud/virtual_private_servers/resetting_a_windows_password). > @@ -36,14 +36,15 @@ Be sure to consult our "Getting started" guides as well: - For a [VPS](/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps) > [!warning] ->OVHcloud is providing you with services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they function correctly. > ->This guide is designed to assist you in common tasks as much as possible. Nevertheless, we recommend that you contact a [specialist service provider](/links/partner) or reach out to [our community](https://community.ovh.com/en/) if you face difficulties or doubts concerning the administration, usage or implementation of services on a server. +> OVHcloud is providing you with services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they function correctly. +> +> This guide is designed to assist you in common tasks as much as possible. Nevertheless, we recommend that you contact a [specialist service provider](/links/partner) or reach out to [our community](https://community.ovh.com/en/) if you face difficulties or doubts concerning the administration, usage or implementation of services on a server. > -### Step 1: Restart the server into rescue mode +### Step 1 - Restart the server into rescue mode Use the corresponding rescue mode guide to connect to your server and mount your partitions: @@ -64,28 +65,58 @@ The exact command depends on the mountpoint you used. For example, if you have m chroot /mnt/ ``` -### Step 2: Reset the user password +### Step 2 - Identify the user account(s) and reset the password -Note: On a GNU/Linux distribution, **a password prompt will not display your keyboard inputs**. +After mounting the partition and running `chroot /mnt` (or the equivalent), you have **root** privileges on the mounted system. -Change the user password with the following command (replace `username` with the actual name of the user account): +If needed, before changing a password, **identify existing accounts** using the following command: ```bash -passwd username +cat /etc/passwd +``` + +Example output (shortened): + +```console +daemon:x:1:1:daemon:/usr/sbin:/usr/sbin/nologin +bin:x:2:2:bin:/bin:/usr/sbin/nologin +sys:x:3:3:sys:/dev:/usr/sbin/nologin +. +nobody:x:65534:65534:nobody:/nonexistent:/usr/sbin/nologin +systemd-network:x:998:998:systemd Network Management:/:/usr/sbin/nologin +syslog:x:102:102::/nonexistent:/usr/sbin/nologin +sshd:x:105:65534::/run/sshd:/usr/sbin/nologin +. +user1:x:1000:1000:Ubuntu:/home/ubuntu:/bin/bash ``` -```text -New password: -Retype new password: -passwd: password updated successfully +Find your user name(s) in the list of accounts. +To change the password for a specific account (e.g. **user1**), enter this command: + +```bash +passwd user1 ``` +Enter the new password twice and confirm: + +```console +# New password: +# Retype new password: +# passwd: password updated successfully +``` + +On a GNU/Linux distribution, **a password prompt does not display your keyboard input**. + +> [!primary] +> +> Avoid running the `passwd` command without arguments: This command modifies the password of the current account (which is **root** after executing `chroot`). +> Always specify `passwd `. + Remember to use the regular boot mode of your server when restarting it in your [OVHcloud Control Panel](/links/manager). Refer to the corresponding [rescue mode guide](#step1) if necessary. -You have now access to the server with your new password. - +The modified user account has now access to the server with the new password. ## Go further diff --git a/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.en-us.md b/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.en-us.md index e2a756b89ca..c40afb03379 100644 --- a/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.en-us.md +++ b/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.en-us.md @@ -1,10 +1,9 @@ --- title: How to recover server access if your user password is lost excerpt: Find out how to configure a new password for a user account on a GNU/Linux operating system with the OVHcloud rescue mode -updated: 2024-02-19 +updated: 2025-10-02 --- - ## Objective Without a different mode of authentication or another user account, losing your password means you can no longer log in to your server in a regular way. @@ -24,6 +23,7 @@ To recover access to a server that you log in to with an SSH key, refer to our g - Access to the [OVHcloud Control Panel](/links/manager) > [!primary] +> > This guide is not applicable for **Windows** server installations. Please refer to our guides on [How to change the admin password on a Windows dedicated server](/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows) and [How to change the admin password on a Windows VPS](/pages/bare_metal_cloud/virtual_private_servers/resetting_a_windows_password). > @@ -36,14 +36,15 @@ Be sure to consult our "Getting started" guides as well: - For a [VPS](/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps) > [!warning] ->OVHcloud is providing you with services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they function correctly. > ->This guide is designed to assist you in common tasks as much as possible. Nevertheless, we recommend that you contact a [specialist service provider](/links/partner) or reach out to [our community](https://community.ovh.com/en/) if you face difficulties or doubts concerning the administration, usage or implementation of services on a server. +> OVHcloud is providing you with services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they function correctly. +> +> This guide is designed to assist you in common tasks as much as possible. Nevertheless, we recommend that you contact a [specialist service provider](/links/partner) or reach out to [our community](https://community.ovh.com/en/) if you face difficulties or doubts concerning the administration, usage or implementation of services on a server. > -### Step 1: Restart the server into rescue mode +### Step 1 - Restart the server into rescue mode Use the corresponding rescue mode guide to connect to your server and mount your partitions: @@ -64,28 +65,58 @@ The exact command depends on the mountpoint you used. For example, if you have m chroot /mnt/ ``` -### Step 2: Reset the user password +### Step 2 - Identify the user account(s) and reset the password -Note: On a GNU/Linux distribution, **a password prompt will not display your keyboard inputs**. +After mounting the partition and running `chroot /mnt` (or the equivalent), you have **root** privileges on the mounted system. -Change the user password with the following command (replace `username` with the actual name of the user account): +If needed, before changing a password, **identify existing accounts** using the following command: ```bash -passwd username +cat /etc/passwd +``` + +Example output (shortened): + +```console +daemon:x:1:1:daemon:/usr/sbin:/usr/sbin/nologin +bin:x:2:2:bin:/bin:/usr/sbin/nologin +sys:x:3:3:sys:/dev:/usr/sbin/nologin +. +nobody:x:65534:65534:nobody:/nonexistent:/usr/sbin/nologin +systemd-network:x:998:998:systemd Network Management:/:/usr/sbin/nologin +syslog:x:102:102::/nonexistent:/usr/sbin/nologin +sshd:x:105:65534::/run/sshd:/usr/sbin/nologin +. +user1:x:1000:1000:Ubuntu:/home/ubuntu:/bin/bash ``` -```text -New password: -Retype new password: -passwd: password updated successfully +Find your user name(s) in the list of accounts. +To change the password for a specific account (e.g. **user1**), enter this command: + +```bash +passwd user1 ``` +Enter the new password twice and confirm: + +```console +# New password: +# Retype new password: +# passwd: password updated successfully +``` + +On a GNU/Linux distribution, **a password prompt does not display your keyboard input**. + +> [!primary] +> +> Avoid running the `passwd` command without arguments: This command modifies the password of the current account (which is **root** after executing `chroot`). +> Always specify `passwd `. + Remember to use the regular boot mode of your server when restarting it in your [OVHcloud Control Panel](/links/manager). Refer to the corresponding [rescue mode guide](#step1) if necessary. -You have now access to the server with your new password. - +The modified user account has now access to the server with the new password. ## Go further diff --git a/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.es-es.md b/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.es-es.md index 05f2ad69e81..fc8b0e72470 100644 --- a/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.es-es.md +++ b/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.es-es.md @@ -1,13 +1,9 @@ --- title: "Cómo recuperar el acceso al servidor en caso de pérdida de la contraseña del usuario" excerpt: "Cómo configurar una nueva contraseña para una cuenta de usuario en un sistema operativo GNU/Linux con el modo de rescate de OVHcloud" -updated: 2024-02-19 +updated: 2025-10-02 --- -> [!primary] -> Esta traducción ha sido generada de forma automática por nuestro partner SYSTRAN. En algunos casos puede contener términos imprecisos, como en las etiquetas de los botones o los detalles técnicos. En caso de duda, le recomendamos que consulte la versión inglesa o francesa de la guía. Si quiere ayudarnos a mejorar esta traducción, por favor, utilice el botón «Contribuir» de esta página. -> - ## Objetivo Sin otro modo de autenticación u otra cuenta de usuario, la pérdida de su contraseña significa que no podrá conectarse a su servidor de forma normal. @@ -47,7 +43,7 @@ No olvide consultar también nuestras guías de primeros pasos: -### Paso 1: reiniciar el servidor en modo de rescate +### Paso 1 - Reiniciar el servidor en modo de rescate Siga los pasos de nuestras guías sobre el modo de rescate para conectarse a su servidor y montar sus particiones: @@ -69,27 +65,59 @@ El comando exacto depende del punto de montaje utilizado. Por ejemplo, si ha mon chroot /mnt/ ``` -### Paso 2: restablecer la contraseña del usuario +### Paso 2 - Identificar la(s) cuenta(s) de usuario y restablecer la contraseña + +Después de montar la partición y ejecutar `chroot /mnt` (o el equivalente), dispone de privilegios **root** en el sistema montado. + +Si es necesario, antes de modificar una contraseña, **identifique las cuentas existentes** con el siguiente comando: + +```bash +cat /etc/passwd +``` + +Ejemplo de resultado (abreviado): + +```console +daemon:x:1:1:daemon:/usr/sbin:/usr/sbin/nologin +bin:x:2:2:bin:/bin:/usr/sbin/nologin +sys:x:3:3:sys:/dev:/usr/sbin/nologin +. +nobody:x:65534:65534:nobody:/nonexistent:/usr/sbin/nologin +systemd-network:x:998:998:systemd Network Management:/:/usr/sbin/nologin +syslog:x:102:102::/nonexistent:/usr/sbin/nologin +sshd:x:105:65534::/run/sshd:/usr/sbin/nologin +. +user1:x:1000:1000:Ubuntu:/home/ubuntu:/bin/bash +``` -Nota: en una distribución GNU/Linux, **una petición de contraseña no muestra las entradas de teclado**. +Encuentre el nombre del usuario en la lista de cuentas. -Cambie la contraseña del usuario con el siguiente comando (sustituya `username` por el nombre real de la cuenta de usuario): +Para cambiar la contraseña de una cuenta específica (por ejemplo, **user1**), utilice este comando: ```bash -passwd username +passwd user1 ``` -```text -New password: -Retype new password: -passwd: password updated successfully +Introduzca la nueva contraseña dos veces: + +```console +# New password: +# Retype new password: +# passwd: password updated successfully ``` +En una distribución GNU/Linux, **una petición de contraseña no muestra las entradas de teclado**. + +> [!primary] +> +> Evite ejecutar el comando `passwd` sin argumentos: este comando modifica la contraseña de la cuenta actual (que suele ser **root** después de ejecutar `chroot`). +> Indiquez systématiquement `passwd `. + Recuerde utilizar el modo de arranque **normal** del servidor al reiniciarlo desde el [área de cliente de OVHcloud](/links/manager). Consulte la [guía del modo de rescate](#step1) si es necesario. -Ya puede acceder al servidor con su nueva contraseña. +La cuenta de usuario modificada ahora tiene acceso al servidor con la nueva contraseña. ## Más información @@ -101,4 +129,4 @@ Ya puede acceder al servidor con su nueva contraseña. [Configuración de las cuentas de usuario y del acceso root en un servidor](/pages/bare_metal_cloud/dedicated_servers/changing_root_password_linux_ds) -Interactúe con nuestra comunidad de usuarios en . +Interactúe con nuestra comunidad de usuarios en . \ No newline at end of file diff --git a/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.es-us.md b/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.es-us.md index 20976dd2a5e..4a93f768d0e 100644 --- a/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.es-us.md +++ b/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.es-us.md @@ -1,13 +1,9 @@ --- title: "Cómo recuperar el acceso al servidor en caso de pérdida de la contraseña del usuario" excerpt: "Cómo configurar una nueva contraseña para una cuenta de usuario en un sistema operativo GNU/Linux con el modo de rescate de OVHcloud" -updated: 2024-02-19 +updated: 2025-10-02 --- -> [!primary] -> Esta traducción ha sido generada de forma automática por nuestro partner SYSTRAN. En algunos casos puede contener términos imprecisos, como en las etiquetas de los botones o los detalles técnicos. En caso de duda, le recomendamos que consulte la versión inglesa o francesa de la guía. Si quiere ayudarnos a mejorar esta traducción, por favor, utilice el botón «Contribuir» de esta página. -> - ## Objetivo Sin otro modo de autenticación u otra cuenta de usuario, la pérdida de su contraseña significa que no podrá conectarse a su servidor de forma normal. @@ -47,7 +43,7 @@ No olvide consultar también nuestras guías de primeros pasos: -### Paso 1: reiniciar el servidor en modo de rescate +### Paso 1 - Reiniciar el servidor en modo de rescate Siga los pasos de nuestras guías sobre el modo de rescate para conectarse a su servidor y montar sus particiones: @@ -69,27 +65,59 @@ El comando exacto depende del punto de montaje utilizado. Por ejemplo, si ha mon chroot /mnt/ ``` -### Paso 2: restablecer la contraseña del usuario +### Paso 2 - Identificar la(s) cuenta(s) de usuario y restablecer la contraseña + +Después de montar la partición y ejecutar `chroot /mnt` (o el equivalente), dispone de privilegios **root** en el sistema montado. + +Si es necesario, antes de modificar una contraseña, **identifique las cuentas existentes** con el siguiente comando: + +```bash +cat /etc/passwd +``` + +Ejemplo de resultado (abreviado): + +```console +daemon:x:1:1:daemon:/usr/sbin:/usr/sbin/nologin +bin:x:2:2:bin:/bin:/usr/sbin/nologin +sys:x:3:3:sys:/dev:/usr/sbin/nologin +. +nobody:x:65534:65534:nobody:/nonexistent:/usr/sbin/nologin +systemd-network:x:998:998:systemd Network Management:/:/usr/sbin/nologin +syslog:x:102:102::/nonexistent:/usr/sbin/nologin +sshd:x:105:65534::/run/sshd:/usr/sbin/nologin +. +user1:x:1000:1000:Ubuntu:/home/ubuntu:/bin/bash +``` -Nota: en una distribución GNU/Linux, **una petición de contraseña no muestra las entradas de teclado**. +Encuentre el nombre del usuario en la lista de cuentas. -Cambie la contraseña del usuario con el siguiente comando (sustituya `username` por el nombre real de la cuenta de usuario): +Para cambiar la contraseña de una cuenta específica (por ejemplo, **user1**), utilice este comando: ```bash -passwd username +passwd user1 ``` -```text -New password: -Retype new password: -passwd: password updated successfully +Introduzca la nueva contraseña dos veces: + +```console +# New password: +# Retype new password: +# passwd: password updated successfully ``` +En una distribución GNU/Linux, **una petición de contraseña no muestra las entradas de teclado**. + +> [!primary] +> +> Evite ejecutar el comando `passwd` sin argumentos: este comando modifica la contraseña de la cuenta actual (que suele ser **root** después de ejecutar `chroot`). +> Indiquez systématiquement `passwd `. + Recuerde utilizar el modo de arranque **normal** del servidor al reiniciarlo desde el [área de cliente de OVHcloud](/links/manager). Consulte la [guía del modo de rescate](#step1) si es necesario. -Ya puede acceder al servidor con su nueva contraseña. +La cuenta de usuario modificada ahora tiene acceso al servidor con la nueva contraseña. ## Más información diff --git a/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.fr-ca.md b/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.fr-ca.md index 3250b97ed82..3936c875b11 100644 --- a/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.fr-ca.md +++ b/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.fr-ca.md @@ -1,7 +1,7 @@ --- title: "Comment récupérer l'accès au serveur en cas de perte du mot de passe de l'utilisateur" excerpt: "Découvrez comment configurer un nouveau mot de passe pour un compte utilisateur sur un système d'exploitation GNU/Linux avec le mode rescue OVHcloud" -updated: 2024-02-19 +updated: 2025-10-02 --- ## Objectif @@ -23,6 +23,7 @@ Dans ce cas, vous pouvez vous connecter à votre serveur via le mode rescue d’ - Être connecté à votre [espace client OVHcloud](/links/manager) > [!primary] +> > Ce guide ne s'applique pas aux installations de **Windows** Server. Consultez nos guides « [Comment changer le mot de passe administrateur sur un serveur dédié Windows](/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows) » et « [Comment changer le mot de passe administrateur sur un VPS Windows](/pages/bare_metal_cloud/virtual_private_servers/resetting_a_windows_password) ». > @@ -43,7 +44,7 @@ N'oubliez pas de consulter également nos guides de premiers pas : -### Étape 1 : redémarrer le serveur en mode rescue +### Étape 1 - Redémarrer le serveur en mode rescue Suivez les étapes de nos guides sur le mode rescue pour vous connecter à votre serveur et monter vos partitions : @@ -64,27 +65,59 @@ La commande exacte dépend du point de montage utilisé. Par exemple, si vous av chroot /mnt/ ``` -### Étape 2 : réinitialiser le mot de passe de l'utilisateur +### Étape 2 - Identifier le(s) compte(s) utilisateur et réinitialiser le mot de passe -Remarque : sur une distribution GNU/Linux, **une invite de mot de passe n'affiche pas vos entrées clavier**. +Après avoir monté la partition et exécuté `chroot /mnt` (ou l'équivalent), vous disposez des privilèges **root** sur le système monté. -Changez le mot de passe de l'utilisateur avec la commande suivante (remplacez `username` par le nom réel du compte utilisateur) : +Si besoin, avant de modifier un mot de passe, **identifiez les comptes existants** avec la commande suivante : ```bash -passwd username +cat /etc/passwd ``` -```text -New password: -Retype new password: -passwd: password updated successfully +Exemple de résultat (raccourci) : + +```console +daemon:x:1:1:daemon:/usr/sbin:/usr/sbin/nologin +bin:x:2:2:bin:/bin:/usr/sbin/nologin +sys:x:3:3:sys:/dev:/usr/sbin/nologin +. +nobody:x:65534:65534:nobody:/nonexistent:/usr/sbin/nologin +systemd-network:x:998:998:systemd Network Management:/:/usr/sbin/nologin +syslog:x:102:102::/nonexistent:/usr/sbin/nologin +sshd:x:105:65534::/run/sshd:/usr/sbin/nologin +. +user1:x:1000:1000:Ubuntu:/home/ubuntu:/bin/bash ``` +Retrouvez le nom de l'utilisateur dans la liste des comptes. + +Pour changer le mot de passe d’un compte précis (par exemple : **user1**), utilisez cette commande : + +```bash +passwd user1 +``` + +Renseignez deux fois le nouveau mot de passe : + +```console +# New password: +# Retype new password: +# passwd: password updated successfully +``` + +Sur une distribution GNU/Linux, **une invite de mot de passe n'affiche pas vos entrées clavier**. + +> [!primary] +> +> Évitez d'exécuter la commande `passwd` sans argument : cette commande modifie le mot de passe du compte courant (qui est souvent **root** après l'exécution d'un `chroot`). +> Indiquez systématiquement `passwd `. + Pensez à utiliser le mode de démarrage **normal** de votre serveur lorsque vous le redémarrez depuis votre [espace client OVHcloud](/links/manager). Consultez le [guide du mode rescue](#step1) si nécessaire. -Vous avez maintenant accès au serveur avec votre nouveau mot de passe. +Le compte utilisateur modifié a désormais accès au serveur avec le nouveau mot de passe. ## Aller plus loin diff --git a/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.fr-fr.md b/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.fr-fr.md index 3250b97ed82..3936c875b11 100644 --- a/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.fr-fr.md +++ b/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.fr-fr.md @@ -1,7 +1,7 @@ --- title: "Comment récupérer l'accès au serveur en cas de perte du mot de passe de l'utilisateur" excerpt: "Découvrez comment configurer un nouveau mot de passe pour un compte utilisateur sur un système d'exploitation GNU/Linux avec le mode rescue OVHcloud" -updated: 2024-02-19 +updated: 2025-10-02 --- ## Objectif @@ -23,6 +23,7 @@ Dans ce cas, vous pouvez vous connecter à votre serveur via le mode rescue d’ - Être connecté à votre [espace client OVHcloud](/links/manager) > [!primary] +> > Ce guide ne s'applique pas aux installations de **Windows** Server. Consultez nos guides « [Comment changer le mot de passe administrateur sur un serveur dédié Windows](/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows) » et « [Comment changer le mot de passe administrateur sur un VPS Windows](/pages/bare_metal_cloud/virtual_private_servers/resetting_a_windows_password) ». > @@ -43,7 +44,7 @@ N'oubliez pas de consulter également nos guides de premiers pas : -### Étape 1 : redémarrer le serveur en mode rescue +### Étape 1 - Redémarrer le serveur en mode rescue Suivez les étapes de nos guides sur le mode rescue pour vous connecter à votre serveur et monter vos partitions : @@ -64,27 +65,59 @@ La commande exacte dépend du point de montage utilisé. Par exemple, si vous av chroot /mnt/ ``` -### Étape 2 : réinitialiser le mot de passe de l'utilisateur +### Étape 2 - Identifier le(s) compte(s) utilisateur et réinitialiser le mot de passe -Remarque : sur une distribution GNU/Linux, **une invite de mot de passe n'affiche pas vos entrées clavier**. +Après avoir monté la partition et exécuté `chroot /mnt` (ou l'équivalent), vous disposez des privilèges **root** sur le système monté. -Changez le mot de passe de l'utilisateur avec la commande suivante (remplacez `username` par le nom réel du compte utilisateur) : +Si besoin, avant de modifier un mot de passe, **identifiez les comptes existants** avec la commande suivante : ```bash -passwd username +cat /etc/passwd ``` -```text -New password: -Retype new password: -passwd: password updated successfully +Exemple de résultat (raccourci) : + +```console +daemon:x:1:1:daemon:/usr/sbin:/usr/sbin/nologin +bin:x:2:2:bin:/bin:/usr/sbin/nologin +sys:x:3:3:sys:/dev:/usr/sbin/nologin +. +nobody:x:65534:65534:nobody:/nonexistent:/usr/sbin/nologin +systemd-network:x:998:998:systemd Network Management:/:/usr/sbin/nologin +syslog:x:102:102::/nonexistent:/usr/sbin/nologin +sshd:x:105:65534::/run/sshd:/usr/sbin/nologin +. +user1:x:1000:1000:Ubuntu:/home/ubuntu:/bin/bash ``` +Retrouvez le nom de l'utilisateur dans la liste des comptes. + +Pour changer le mot de passe d’un compte précis (par exemple : **user1**), utilisez cette commande : + +```bash +passwd user1 +``` + +Renseignez deux fois le nouveau mot de passe : + +```console +# New password: +# Retype new password: +# passwd: password updated successfully +``` + +Sur une distribution GNU/Linux, **une invite de mot de passe n'affiche pas vos entrées clavier**. + +> [!primary] +> +> Évitez d'exécuter la commande `passwd` sans argument : cette commande modifie le mot de passe du compte courant (qui est souvent **root** après l'exécution d'un `chroot`). +> Indiquez systématiquement `passwd `. + Pensez à utiliser le mode de démarrage **normal** de votre serveur lorsque vous le redémarrez depuis votre [espace client OVHcloud](/links/manager). Consultez le [guide du mode rescue](#step1) si nécessaire. -Vous avez maintenant accès au serveur avec votre nouveau mot de passe. +Le compte utilisateur modifié a désormais accès au serveur avec le nouveau mot de passe. ## Aller plus loin diff --git a/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.it-it.md b/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.it-it.md index dfcdcb43766..dd4d86ca8eb 100644 --- a/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.it-it.md +++ b/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.it-it.md @@ -1,14 +1,9 @@ --- title: "Come recuperare l'accesso al server in caso di perdita della password dell'utente" excerpt: "Scopri come configurare una nuova password per un account utente su un sistema operativo GNU/Linux in modalità Rescue OVHcloud" -updated: 2024-02-19 +updated: 2025-10-02 --- - -> [!primary] -> Questa traduzione è stata generata automaticamente dal nostro partner SYSTRAN. I contenuti potrebbero presentare imprecisioni, ad esempio la nomenclatura dei pulsanti o alcuni dettagli tecnici. In caso di dubbi consigliamo di fare riferimento alla versione inglese o francese della guida. Per aiutarci a migliorare questa traduzione, utilizza il pulsante "Contribuisci" di questa pagina. -> - ## Obiettivo Senza un’altra modalità di autenticazione o un altro account utente, la perdita della password significa che non è più possibile connettersi al server in modo normale. @@ -28,6 +23,7 @@ In questo caso, è possibile accedere al server tramite la modalità Rescue di O - Avere accesso allo [Spazio Cliente OVHcloud](/links/manager) > [!primary] +> > Questa guida non si applica alle installazioni di **Windows** Server. Consulta le nostre guide "[Come cambiare la password amministratore su un server dedicato Windows](/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows)" e "[Come cambiare la password amministratore su un VPS Windows](/pages/bare_metal_cloud/virtual_private_servers/resetting_a_windows_password)". > @@ -48,7 +44,7 @@ Non dimenticare di consultare anche le nostre guide di primo passo: -### Step 1: riavvia il server in modalità Rescue +### Step 1 - Riavvia il server in modalità Rescue Segui gli step delle nostre guide in modalità Rescue per connetterti al tuo server e montare le tue partizioni: @@ -69,28 +65,59 @@ Il comando esatto dipende dal punto di montaggio utilizzato. Ad esempio, se la p chroot /mnt/ ``` -### Step 2: reimposta la password dell'utente +### Step 2 - Identificare gli account utente e reimpostare la password + +Dopo aver montato la partizione ed eseguito `chroot /mnt` (o l’equivalente), disporrai dei privilegi **root** sul sistema montato. + +Se necessario, prima di modificare una password, **identifica gli account esistenti** utilizzando questo comando: + +```bash +cat /etc/passwd +``` + +Esempio di risultato (collegamento): + +```console +daemon:x:1:1:daemon:/usr/sbin:/usr/sbin/nologin +bin:x:2:2:bin:/bin:/usr/sbin/nologin +sys:x:3:3:sys:/dev:/usr/sbin/nologin +. +nobody:x:65534:65534:nobody:/nonexistent:/usr/sbin/nologin +systemd-network:x:998:998:systemd Network Management:/:/usr/sbin/nologin +syslog:x:102:102::/nonexistent:/usr/sbin/nologin +sshd:x:105:65534::/run/sshd:/usr/sbin/nologin +. +user1:x:1000:1000:Ubuntu:/home/ubuntu:/bin/bash +``` -Nota: in una distribuzione GNU/Linux, **il prompt della password non visualizza le voci della tastiera**. +Il nome dell'utente è disponibile nell'elenco degli account. -Modifica la password dell’utente con questo comando (sostituisci `username` con il nome reale dell’account utente): +Per modificare la password di un account specifico (ad esempio: **user1**), utilizza questo comando: ```bash -passwd username +passwd user1 ``` -```text -New password: -Retype new password: -passwd: password updated successfully +Inserisci due volte la nuova password: + +```console +# New password: +# Retype new password: +# passwd: password updated successfully ``` +In una distribuzione GNU/Linux, **il prompt della password non visualizza le voci della tastiera**. + +> [!primary] +> +> Evita di eseguire il comando `passwd` senza argomenti: questo comando modifica la password dell'account corrente (che è spesso **root** dopo l'esecuzione di `chroot`). +> Specifica sempre `passwd `. + Utilizza la modalità di avvio **normal** del tuo server quando lo riavvii dallo [Spazio Cliente OVHcloud](/links/manager). Se necessario, consulta la [guida del Rescue mode](#step1). -A questo punto, sarà possibile accedere al server con la nuova password. - +L'account utente modificato ora ha accesso al server con la nuova password. ## Per saperne di più diff --git a/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.pl-pl.md b/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.pl-pl.md index d7b9c232933..459ec8c3fde 100644 --- a/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.pl-pl.md +++ b/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.pl-pl.md @@ -1,14 +1,9 @@ --- title: "Jak odzyskać dostęp do serwera w przypadku utraty hasła użytkownika" excerpt: "Dowiedz się, jak skonfigurować nowe hasło dla konta użytkownika w systemie operacyjnym GNU/Linux w trybie rescue OVHcloud" -updated: 2024-02-19 +updated: 2025-10-02 --- - -> [!primary] -> Tłumaczenie zostało wygenerowane automatycznie przez system naszego partnera SYSTRAN. W niektórych przypadkach mogą wystąpić nieprecyzyjne sformułowania, na przykład w tłumaczeniu nazw przycisków lub szczegółów technicznych. W przypadku jakichkolwiek wątpliwości zalecamy zapoznanie się z angielską/francuską wersją przewodnika. Jeśli chcesz przyczynić się do ulepszenia tłumaczenia, kliknij przycisk "Zgłoś propozycję modyfikacji” na tej stronie. -> - ## Wprowadzenie Bez alternatywnego uwierzytelniania lub innego konta użytkownika utrata hasła oznacza, że nie można się normalnie połączyć z serwerem. @@ -28,6 +23,7 @@ W takim przypadku możesz zalogować się do Twojego serwera za pomocą trybu Re - Dostęp do [Panelu klienta OVHcloud](/links/manager) > [!primary] +> > Ten przewodnik nie dotyczy instalacji **Windows* Server. Zapoznaj się z naszymi przewodnikami "[Jak zmienić hasło administratora na serwerze dedykowanym Windows](/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows)" i "[Jak zmienić hasło administratora na serwerze VPS Windows](/pages/bare_metal_cloud/virtual_private_servers/resetting_a_windows_password)". > @@ -48,7 +44,7 @@ Sprawdź również nasze przewodniki: -### Etap 1: restart serwera w trybie rescue +### Etap 1 - Restart serwera w trybie rescue Postępuj zgodnie z instrukcjami zawartymi w przewodnikach dotyczących trybu Rescue, aby połączyć się z serwerem i zamontować partycje: @@ -69,28 +65,59 @@ Dokładne sterowanie zależy od użytego punktu montowania. Na przykład, jeśli chroot /mnt/ ``` -### Etap 2: resetowanie hasła użytkownika +### Etap 2 - Identyfikacja konta użytkownika (kont użytkowników) i resetowanie hasła + +Po zamontowaniu partycji i uruchomieniu `chroot /mnt` (lub odpowiednika), masz uprawnienia **root** w zainstalowanym systemie. + +Jeśli to konieczne, przed zmianą hasła **zidentyfikuj istniejące konta** za pomocą następującego polecenia: + +```bash +cat /etc/passwd +``` + +Przykład wyniku (skrócony): + +```console +daemon:x:1:1:daemon:/usr/sbin:/usr/sbin/nologin +bin:x:2:2:bin:/bin:/usr/sbin/nologin +sys:x:3:3:sys:/dev:/usr/sbin/nologin +. +nobody:x:65534:65534:nobody:/nonexistent:/usr/sbin/nologin +systemd-network:x:998:998:systemd Network Management:/:/usr/sbin/nologin +syslog:x:102:102::/nonexistent:/usr/sbin/nologin +sshd:x:105:65534::/run/sshd:/usr/sbin/nologin +. +user1:x:1000:1000:Ubuntu:/home/ubuntu:/bin/bash +``` -Uwaga: w dystrybucji GNU/Linux **wiersz hasła nie wyświetla wpisów klawiaturowych**. +Znajdź Twoją nazwę użytkownika (lub nazwy użytkowników) na liście kont. -Zmień hasło użytkownika za pomocą następującego polecenia (zastąp `username` rzeczywistą nazwą konta użytkownika): +Aby zmienić hasło dla wybranego konta (na przykład: **user1**), wpisz poniższe polecenie: ```bash -passwd username +passwd user1 ``` -```text -New password: -Retype new password: -passwd: password updated successfully +Dwukrotnie wpisz nowe hasło i potwierdź: + +```console +# New password: +# Retype new password: +# passwd: password updated successfully ``` +W dystrybucji GNU/Linux **monit o hasło nie wyświetla danych wejściowych z klawiatury**. + +> [!primary] +> +> Unikaj uruchamiania polecenia `passwd` bez argumentów: to polecenie zmienia hasło dla konta bieżącego (które często jest **root** po uruchomieniu `chroot`). +> Zawsze podawaj `passwd `. + Pamiętaj, aby podczas restartu serwera z poziomu [Panelu klienta OVHcloud](/links/manager) użyć trybu uruchamiania **normalnego** Twojego serwera. W razie potrzeby sprawdź przewodnik [Tryb ratunkowy](#step1). -Teraz masz dostęp do serwera za pomocą nowego hasła. - +Zmodyfikowane konto użytkownika ma teraz dostęp do serwera z nowym hasłem. ## Sprawdź również diff --git a/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.pt-pt.md b/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.pt-pt.md index 597e4ef4656..429e389311f 100644 --- a/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.pt-pt.md +++ b/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/guide.pt-pt.md @@ -1,13 +1,9 @@ --- title: "Como recuperar o acesso ao servidor em caso de perda da palavra-passe do utilizador" excerpt: "Saiba como configurar uma nova palavra-passe para uma conta de utilizador num sistema operativo GNU/Linux com o modo rescue OVHcloud" -updated: 2024-02-19 +updated: 2025-10-02 --- -> [!primary] -> Esta tradução foi automaticamente gerada pelo nosso parceiro SYSTRAN. Em certos casos, poderão ocorrer formulações imprecisas, como por exemplo nomes de botões ou detalhes técnicos. Recomendamos que consulte a versão inglesa ou francesa do manual, caso tenha alguma dúvida. Se nos quiser ajudar a melhorar esta tradução, clique em "Contribuir" nesta página. -> - ## Objetivo Sem um outro modo de autenticação ou uma conta de utilizador, a perda da palavra-passe significa que não é possível iniciar sessão no servidor normalmente. @@ -27,6 +23,7 @@ Neste caso, pode ligar-se ao seu servidor através do modo rescue da OVHcloud, q - Ter acesso à [Área de Cliente OVHcloud](/links/manager) > [!primary] +> > Este manual não se aplica a instalações do **Windows** Server. Consulte os nossos manuais "[Como alterar a palavra-passe de administrador num servidor dedicado Windows](/pages/bare_metal_cloud/dedicated_servers/rcw-changing-admin-password-on-windows)" e "[Como alterar a palavra-passe de administrador num VPS Windows](/pages/bare_metal_cloud/virtual_private_servers/resetting_a_windows_password)". > @@ -47,7 +44,7 @@ Não se esqueça de consultar também os nossos guias de primeiros passos: -### Etapa 1: reiniciar o servidor em modo rescue +### Etapa 1 - Reiniciar o servidor em modo rescue Siga as etapas dos nossos manuais sobre o modo rescue para se ligar ao seu servidor e montar as suas partições: @@ -68,27 +65,59 @@ O comando exato depende do ponto de montagem utilizado. Por exemplo, se tiver mo chroot /mnt/ ``` -### Etapa 2: reinicializar a palavra-passe do utilizador +### Etapa 2 - Identificar a(s) conta(s) de usuário e redefinir a senha + +Depois de montar a partição e executar `chroot /mnt` (ou equivalente), dispõe dos privilégios **root** no sistema montado. + +Se necessário, antes de alterar uma senha, **identifique as contas existentes** com o seguinte comando: + +```bash +cat /etc/passwd +``` + +Exemplo de resultado (atalho): + +```console +daemon:x:1:1:daemon:/usr/sbin:/usr/sbin/nologin +bin:x:2:2:bin:/bin:/usr/sbin/nologin +sys:x:3:3:sys:/dev:/usr/sbin/nologin +. +nobody:x:65534:65534:nobody:/nonexistent:/usr/sbin/nologin +systemd-network:x:998:998:systemd Network Management:/:/usr/sbin/nologin +syslog:x:102:102::/nonexistent:/usr/sbin/nologin +sshd:x:105:65534::/run/sshd:/usr/sbin/nologin +. +user1:x:1000:1000:Ubuntu:/home/ubuntu:/bin/bash +``` -Nota: numa distribuição GNU/Linux, **uma linha de comandos de palavra-passe não apresenta as suas entradas de teclado**. +Encontre o nome do utilizador na lista das contas. -Altere a palavra-passe do utilizador com o seguinte comando (substitua `username` pelo nome real da conta de utilizador): +Para alterar a palavra-passe de uma conta específica (por exemplo: **user1**), utilize este comando: ```bash -passwd username +passwd user1 ``` -```text -New password: -Retype new password: -passwd: password updated successfully +Introduza a nova palavra-passe duas vezes: + +```console +# New password: +# Retype new password: +# passwd: password updated successfully ``` +Numa distribuição GNU/Linux, **uma indicação de palavra-passe não apresenta as suas entradas de teclado**. + +> [!primary] +> +> Evite executar o comando `passwd` sem argumentos: este comando modifica a senha da conta atual (que é frequentemente **root** após a execução de `chroot`). +> Sempre especifique `passwd `. + Lembre-se de utilizar o modo de arranque **normal** do seu servidor quando o reiniciar a partir da sua [Área de Cliente OVHcloud](/links/manager). Consulte [manual do modo rescue](#step1) se necessário. -Agora já tem acesso ao servidor com a sua nova palavra-passe. +A conta de utilizador modificada terá acesso ao servidor com a nova palavra-passe. ## Quer saber mais? diff --git a/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/meta.yaml b/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/meta.yaml index cbae36c2fa4..72e61cd0690 100644 --- a/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/meta.yaml +++ b/pages/bare_metal_cloud/dedicated_servers/replacing-user-password/meta.yaml @@ -1,3 +1,4 @@ id: 0486fca9-8510-41dd-96be-f534a74aed1c full_slug: dedicated-servers-change-password +translation_banner: true reference_category: bare-metal-cloud-dedicated-servers-troubleshooting \ No newline at end of file diff --git a/pages/bare_metal_cloud/dedicated_servers/rescue-customer-windows/images/rescue-mode-02.png b/pages/bare_metal_cloud/dedicated_servers/rescue-customer-windows/images/rescue-mode-02.png deleted file mode 100644 index 381463961af..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/rescue-customer-windows/images/rescue-mode-02.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/resource-tag-assign/meta.yaml b/pages/bare_metal_cloud/dedicated_servers/resource-tag-assign/meta.yaml index 043ef8bd3f3..de0a25527e0 100644 --- a/pages/bare_metal_cloud/dedicated_servers/resource-tag-assign/meta.yaml +++ b/pages/bare_metal_cloud/dedicated_servers/resource-tag-assign/meta.yaml @@ -1,4 +1,4 @@ id: 3dd48d0d-df08-49f7-89d7-44d61b84d53b full_slug: dedicated-servers-resource-tag-assign translation_banner: true -reference_category: bare-metal-cloud-dedicated-servers-troubleshooting +reference_category: bare-metal-cloud-dedicated-servers-configuration-system diff --git a/pages/bare_metal_cloud/dedicated_servers/restore-bdd-rescue/meta.yaml b/pages/bare_metal_cloud/dedicated_servers/restore-bdd-rescue/meta.yaml index 3b4ddde4ed7..5311b4158cc 100644 --- a/pages/bare_metal_cloud/dedicated_servers/restore-bdd-rescue/meta.yaml +++ b/pages/bare_metal_cloud/dedicated_servers/restore-bdd-rescue/meta.yaml @@ -1,3 +1,3 @@ id: c2e980b7-7054-45df-8d9f-a37a1bd56bf1 full_slug: dedicated-servers-retrieve-database -reference_category: bare-metal-cloud-dedicated-servers-tutorials \ No newline at end of file +reference_category: bare-metal-cloud-dedicated-servers-troubleshooting \ No newline at end of file diff --git a/pages/bare_metal_cloud/dedicated_servers/save_datas_database_on_storage_ds/images/partition_customization.png b/pages/bare_metal_cloud/dedicated_servers/save_datas_database_on_storage_ds/images/partition_customization.png deleted file mode 100644 index e75b1d39790..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/save_datas_database_on_storage_ds/images/partition_customization.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.de-de.md b/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.de-de.md index 1ebbdaf6915..2a886944f20 100644 --- a/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.de-de.md +++ b/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.de-de.md @@ -1,7 +1,7 @@ --- title: 'Backup Storage auf einem Dedicated Server verwenden' excerpt: 'Erfahren Sie hier, wie Sie zusätzlichen Speicherplatz aktivieren und auf diesen zugreifen' -updated: 2025-07-21 +updated: 2025-10-09 --- ## Ziel @@ -345,7 +345,11 @@ System error 1272 has occurred. You can't access this shared folder because your organization's security policies block unauthenticated guest access. These policies help protect your PC from unsafe or malicious devices on the network. ``` -Dieser Fehler sollte durch Bearbeiten der Windows-Registrierung lösbar sein: Öffnen Sie das Windows-Dienstprogramm *regedit*, und suchen Sie nach dem Eintrag `HKLM\SYSTEM\CurrentControlSet\Services\LanmanWorkstation\Parameters`. Setzen Sie den Wert von `AllowInsecureGuestAuth` auf "1". Weitere Informationen zu diesem Thema finden Sie auf den [Microsoft Support-Seiten](https://answer.microsoft.com/en-us/windows/forum/all/you-cant-access-this-shared-folder-because-your/01d15775-2cbe-41f8-beb8-84ce588b34ab). +> [!primary] +> +> Dieser Fehler sollte durch Bearbeiten der Windows Registry behebbar sein: Öffnen Sie das Windows Dienstprogramm *regedit*, und suchen Sie nach dem Eintrag `HKLM\SYSTEM\CurrentControlSet\Services\LanmanWorkstation\Parameters`. +> Setzen Sie den Wert des Parameters `AllowInsecureGuestAuth` auf "1". +> Weitere Informationen zu diesem Thema finden Sie auf den [Microsoft Supportseiten](https://learn.microsoft.com/de-de/windows-server/storage/file-server/enable-insecure-guest-logons-smb2-and-smb3). ##### Linux diff --git a/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.en-asia.md b/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.en-asia.md index 2b48a1189b9..99528ff377f 100644 --- a/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.en-asia.md +++ b/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.en-asia.md @@ -1,7 +1,7 @@ --- title: How to use the backup storage on a dedicated server excerpt: 'Find out how to enable and access your additional storage space' -updated: 2025-07-21 +updated: 2025-10-09 --- ## Objective @@ -341,7 +341,11 @@ System error 1272 has occurred. You can't access this shared folder because your organization's security policies block unauthenticated guest access. These policies help protect your PC from unsafe or malicious devices on the network. ``` -This error should be resolvable by modifying the Windows Registry: Open the Windows utility *regedit* and locate the entry `HKLM\SYSTEM\CurrentControlSet\Services\LanmanWorkstation\Parameters`. Set the value of `AllowInsecureGuestAuth` to "1". You can find more information on this issue on the [Microsoft support pages](https://answers.microsoft.com/en-us/windows/forum/all/you-cant-access-this-shared-folder-because-your/01d15775-2cbe-41f8-beb8-84ce588b34ab). +> [!primary] +> +> To correct this error, you need to modify the Windows registry. To do this, open the Registry Editor (regedit), then navigate to the key `HKLM\SYSTEM\CurrentControlSet\Services\LanmanWorkstation\Parameters`.
+> Then set the value of the parameter `AllowInsecureGuestAuth` to "1".
+> Find more information on this topic on the [Microsoft support pages](https://learn.microsoft.com/en-in/windows-server/storage/file-server/enable-insecure-guest-logons-smb2-and-smb3). ##### Linux diff --git a/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.en-au.md b/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.en-au.md index 5030385f4be..208e344fd71 100644 --- a/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.en-au.md +++ b/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.en-au.md @@ -1,7 +1,7 @@ --- title: How to use the backup storage on a dedicated server excerpt: 'Find out how to enable and access your additional storage space' -updated: 2025-07-21 +updated: 2025-10-09 --- ## Objective @@ -339,7 +339,11 @@ System error 1272 has occurred. You can't access this shared folder because your organization's security policies block unauthenticated guest access. These policies help protect your PC from unsafe or malicious devices on the network. ``` -This error should be resolvable by modifying the Windows Registry: Open the Windows utility *regedit* and locate the entry `HKLM\SYSTEM\CurrentControlSet\Services\LanmanWorkstation\Parameters`. Set the value of `AllowInsecureGuestAuth` to "1". You can find more information on this issue on the [Microsoft support pages](https://answers.microsoft.com/en-us/windows/forum/all/you-cant-access-this-shared-folder-because-your/01d15775-2cbe-41f8-beb8-84ce588b34ab). +> [!primary] +> +> To correct this error, you need to modify the Windows registry. To do this, open the Registry Editor (regedit), then navigate to the key `HKLM\SYSTEM\CurrentControlSet\Services\LanmanWorkstation\Parameters`.
+> Then set the value of the parameter `AllowInsecureGuestAuth` to "1".
+> Find more information on this topic on the [Microsoft support pages](https://learn.microsoft.com/en-au/windows-server/storage/file-server/enable-insecure-guest-logons-smb2-and-smb3). ##### Linux diff --git a/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.en-ca.md b/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.en-ca.md index 5030385f4be..15749a0118e 100644 --- a/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.en-ca.md +++ b/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.en-ca.md @@ -1,7 +1,7 @@ --- title: How to use the backup storage on a dedicated server excerpt: 'Find out how to enable and access your additional storage space' -updated: 2025-07-21 +updated: 2025-10-09 --- ## Objective @@ -339,7 +339,11 @@ System error 1272 has occurred. You can't access this shared folder because your organization's security policies block unauthenticated guest access. These policies help protect your PC from unsafe or malicious devices on the network. ``` -This error should be resolvable by modifying the Windows Registry: Open the Windows utility *regedit* and locate the entry `HKLM\SYSTEM\CurrentControlSet\Services\LanmanWorkstation\Parameters`. Set the value of `AllowInsecureGuestAuth` to "1". You can find more information on this issue on the [Microsoft support pages](https://answers.microsoft.com/en-us/windows/forum/all/you-cant-access-this-shared-folder-because-your/01d15775-2cbe-41f8-beb8-84ce588b34ab). +> [!primary] +> +> To correct this error, you need to modify the Windows registry. To do this, open the Registry Editor (regedit), then navigate to the key `HKLM\SYSTEM\CurrentControlSet\Services\LanmanWorkstation\Parameters`.
+> Then set the value of the parameter `AllowInsecureGuestAuth` to "1".
+> Find more information on this topic on the [Microsoft support pages](https://learn.microsoft.com/en-ca/windows-server/storage/file-server/enable-insecure-guest-logons-smb2-and-smb3). ##### Linux diff --git a/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.en-gb.md b/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.en-gb.md index 5030385f4be..6d9c2e9bdae 100644 --- a/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.en-gb.md +++ b/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.en-gb.md @@ -1,7 +1,7 @@ --- title: How to use the backup storage on a dedicated server excerpt: 'Find out how to enable and access your additional storage space' -updated: 2025-07-21 +updated: 2025-10-09 --- ## Objective @@ -339,7 +339,11 @@ System error 1272 has occurred. You can't access this shared folder because your organization's security policies block unauthenticated guest access. These policies help protect your PC from unsafe or malicious devices on the network. ``` -This error should be resolvable by modifying the Windows Registry: Open the Windows utility *regedit* and locate the entry `HKLM\SYSTEM\CurrentControlSet\Services\LanmanWorkstation\Parameters`. Set the value of `AllowInsecureGuestAuth` to "1". You can find more information on this issue on the [Microsoft support pages](https://answers.microsoft.com/en-us/windows/forum/all/you-cant-access-this-shared-folder-because-your/01d15775-2cbe-41f8-beb8-84ce588b34ab). +> [!primary] +> +> To correct this error, you need to modify the Windows registry. To do this, open the Registry Editor (regedit), then navigate to the key `HKLM\SYSTEM\CurrentControlSet\Services\LanmanWorkstation\Parameters`.
+> Then set the value of the parameter `AllowInsecureGuestAuth` to "1".
+> Find more information on this topic on the [Microsoft support pages](https://learn.microsoft.com/en-gb/windows-server/storage/file-server/enable-insecure-guest-logons-smb2-and-smb3). ##### Linux @@ -374,4 +378,4 @@ The code example above contains variables, which you will need to substitute wit ## Go further -Join our [community of users](/links/community). \ No newline at end of file +Join our [community of users](/links/community). diff --git a/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.en-ie.md b/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.en-ie.md index 5030385f4be..f1d96b2e689 100644 --- a/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.en-ie.md +++ b/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.en-ie.md @@ -1,7 +1,7 @@ --- title: How to use the backup storage on a dedicated server excerpt: 'Find out how to enable and access your additional storage space' -updated: 2025-07-21 +updated: 2025-10-09 --- ## Objective @@ -339,7 +339,11 @@ System error 1272 has occurred. You can't access this shared folder because your organization's security policies block unauthenticated guest access. These policies help protect your PC from unsafe or malicious devices on the network. ``` -This error should be resolvable by modifying the Windows Registry: Open the Windows utility *regedit* and locate the entry `HKLM\SYSTEM\CurrentControlSet\Services\LanmanWorkstation\Parameters`. Set the value of `AllowInsecureGuestAuth` to "1". You can find more information on this issue on the [Microsoft support pages](https://answers.microsoft.com/en-us/windows/forum/all/you-cant-access-this-shared-folder-because-your/01d15775-2cbe-41f8-beb8-84ce588b34ab). +> [!primary] +> +> To correct this error, you need to modify the Windows registry. To do this, open the Registry Editor (regedit), then navigate to the key `HKLM\SYSTEM\CurrentControlSet\Services\LanmanWorkstation\Parameters`.
+> Then set the value of the parameter `AllowInsecureGuestAuth` to "1".
+> Find more information on this topic on the [Microsoft support pages](https://learn.microsoft.com/en-ie/windows-server/storage/file-server/enable-insecure-guest-logons-smb2-and-smb3). ##### Linux diff --git a/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.en-sg.md b/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.en-sg.md index 5030385f4be..8e1fd40652d 100644 --- a/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.en-sg.md +++ b/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.en-sg.md @@ -1,7 +1,7 @@ --- title: How to use the backup storage on a dedicated server excerpt: 'Find out how to enable and access your additional storage space' -updated: 2025-07-21 +updated: 2025-10-09 --- ## Objective @@ -339,7 +339,11 @@ System error 1272 has occurred. You can't access this shared folder because your organization's security policies block unauthenticated guest access. These policies help protect your PC from unsafe or malicious devices on the network. ``` -This error should be resolvable by modifying the Windows Registry: Open the Windows utility *regedit* and locate the entry `HKLM\SYSTEM\CurrentControlSet\Services\LanmanWorkstation\Parameters`. Set the value of `AllowInsecureGuestAuth` to "1". You can find more information on this issue on the [Microsoft support pages](https://answers.microsoft.com/en-us/windows/forum/all/you-cant-access-this-shared-folder-because-your/01d15775-2cbe-41f8-beb8-84ce588b34ab). +> [!primary] +> +> To correct this error, you need to modify the Windows registry. To do this, open the Registry Editor (regedit), then navigate to the key `HKLM\SYSTEM\CurrentControlSet\Services\LanmanWorkstation\Parameters`.
+> Then set the value of the parameter `AllowInsecureGuestAuth` to "1".
+> Find more information on this topic on the [Microsoft support pages](https://learn.microsoft.com/en-sg/windows-server/storage/file-server/enable-insecure-guest-logons-smb2-and-smb3). ##### Linux diff --git a/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.en-us.md b/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.en-us.md index 5030385f4be..5d75bcb9567 100644 --- a/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.en-us.md +++ b/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.en-us.md @@ -1,7 +1,7 @@ --- title: How to use the backup storage on a dedicated server excerpt: 'Find out how to enable and access your additional storage space' -updated: 2025-07-21 +updated: 2025-10-09 --- ## Objective @@ -339,7 +339,11 @@ System error 1272 has occurred. You can't access this shared folder because your organization's security policies block unauthenticated guest access. These policies help protect your PC from unsafe or malicious devices on the network. ``` -This error should be resolvable by modifying the Windows Registry: Open the Windows utility *regedit* and locate the entry `HKLM\SYSTEM\CurrentControlSet\Services\LanmanWorkstation\Parameters`. Set the value of `AllowInsecureGuestAuth` to "1". You can find more information on this issue on the [Microsoft support pages](https://answers.microsoft.com/en-us/windows/forum/all/you-cant-access-this-shared-folder-because-your/01d15775-2cbe-41f8-beb8-84ce588b34ab). +> [!primary] +> +> To correct this error, you need to modify the Windows registry. To do this, open the Registry Editor (regedit), then navigate to the key `HKLM\SYSTEM\CurrentControlSet\Services\LanmanWorkstation\Parameters`.
+> Then set the value of the parameter `AllowInsecureGuestAuth` to "1".
+> Find more information on this topic on the [Microsoft support pages](https://learn.microsoft.com/en-us/windows-server/storage/file-server/enable-insecure-guest-logons-smb2-and-smb3). ##### Linux diff --git a/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.es-es.md b/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.es-es.md index 124fa33a5a9..fdd4cef8be7 100644 --- a/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.es-es.md +++ b/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.es-es.md @@ -1,7 +1,7 @@ --- title: 'Utilizar Backup Storage en un servidor dedicado' excerpt: 'Cómo activar y acceder al espacio de almacenamiento adicional' -updated: 2025-07-21 +updated: 2025-10-09 --- ## Objetivo @@ -345,8 +345,11 @@ System error 1272 has occurred. You can't access this shared folder because your organization's security policies block unauthenticated guest access. These policies help protect your PC from unsafe or malicious devices on the network. ``` -Este problema se puede solucionar editando el Registro de Windows: abra la utilidad Windows *regedit* y busque la entrada `HKLM\SYSTEM\CurrentControlSet\Services\LanmanWorkstation\Parameters`. Establezca el valor de `AllowInsecureGuestAuth` en "1". Más información sobre este tema en [páginas de soporte técnico de Microsoft](https://answer.microsoft.com/en-us/windows/forum/all/you-cant-access-this-shared-folder-because-your/01d15775-2cbe-41f8-beb8-84ce588b34ab). - +> [!primary] +> +> Para corregir este error, es necesario modificar el registro de Windows. Para ello, abra el editor del registro (regedit) y acceda a la clave `HKLM\SYSTEM\CurrentControlSet\Services\LanmanWorkstation\Parameters`.
+> Asigne el valor "1" al parámetro `AllowInsecureGuestAuth`.
+> Encuentre más información sobre este tema en las [páginas de asistencia de Microsoft](https://learn.microsoft.com/es-es/windows-server/storage/file-server/enable-insecure-guest-logons-smb2-and-smb3). ##### Linux diff --git a/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.es-us.md b/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.es-us.md index 124fa33a5a9..dd9fbf56704 100644 --- a/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.es-us.md +++ b/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.es-us.md @@ -1,7 +1,7 @@ --- title: 'Utilizar Backup Storage en un servidor dedicado' excerpt: 'Cómo activar y acceder al espacio de almacenamiento adicional' -updated: 2025-07-21 +updated: 2025-10-09 --- ## Objetivo @@ -345,7 +345,11 @@ System error 1272 has occurred. You can't access this shared folder because your organization's security policies block unauthenticated guest access. These policies help protect your PC from unsafe or malicious devices on the network. ``` -Este problema se puede solucionar editando el Registro de Windows: abra la utilidad Windows *regedit* y busque la entrada `HKLM\SYSTEM\CurrentControlSet\Services\LanmanWorkstation\Parameters`. Establezca el valor de `AllowInsecureGuestAuth` en "1". Más información sobre este tema en [páginas de soporte técnico de Microsoft](https://answer.microsoft.com/en-us/windows/forum/all/you-cant-access-this-shared-folder-because-your/01d15775-2cbe-41f8-beb8-84ce588b34ab). +> [!primary] +> +> Para corregir este error, es necesario modificar el registro de Windows. Para ello, abra el editor del registro (regedit) y acceda a la clave `HKLM\SYSTEM\CurrentControlSet\Services\LanmanWorkstation\Parameters`.
+> Asigne el valor "1" al parámetro `AllowInsecureGuestAuth`.
+> Encuentre más información sobre este tema en las [páginas de asistencia de Microsoft](https://learn.microsoft.com/es-mx/windows-server/storage/file-server/enable-insecure-guest-logons-smb2-and-smb3). ##### Linux diff --git a/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.fr-ca.md b/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.fr-ca.md index 21ef095849c..0984e351791 100644 --- a/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.fr-ca.md +++ b/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.fr-ca.md @@ -1,7 +1,7 @@ --- title: 'Utiliser Backup Storage sur un serveur dédié' excerpt: 'Découvrez comment activer et accéder à votre espace de stockage supplémentaire' -updated: 2025-07-21 +updated: 2025-10-09 --- ## Objectif @@ -346,7 +346,11 @@ System error 1272 has occurred. You can't access this shared folder because your organization's security policies block unauthenticated guest access. These policies help protect your PC from unsafe or malicious devices on the network. ``` -Ce problème peut être résolu en modifiant le Registre Windows : ouvrez l'utilitaire Windows *regedit* et recherchez l'entrée `HKLM\SYSTEM\CurrentControlSet\Services\LanmanWorkstation\Parameters`. Définissez la valeur de `AllowInsecureGuestAuth` sur « 1 ». Retrouvez plus d'informations sur ce sujet sur les [pages de support Microsoft](https://answer.microsoft.com/en-us/windows/forum/all/you-cant-access-this-shared-folder-because-your/01d15775-2cbe-41f8-beb8-84ce588b34ab). +> [!primary] +> +> Pour corriger cette erreur, il convient de modifier le registre Windows. Pour cela, ouvrez l’éditeur de registre (regedit), puis accédez à la clé `HKLM\SYSTEM\CurrentControlSet\Services\LanmanWorkstation\Parameters`.
+> Attribuez ensuite la valeur « 1 » au paramètre `AllowInsecureGuestAuth`.
+> Retrouvez plus d'informations sur ce sujet sur les [pages d'assistance de Microsoft](https://learn.microsoft.com/fr-ca/windows-server/storage/file-server/enable-insecure-guest-logons-smb2-and-smb3). ##### Linux diff --git a/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.fr-fr.md b/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.fr-fr.md index 4435af47fa1..f6ce4f78b81 100644 --- a/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.fr-fr.md +++ b/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.fr-fr.md @@ -1,7 +1,7 @@ --- title: 'Utiliser Backup Storage sur un serveur dédié' excerpt: 'Découvrez comment activer et accéder à votre espace de stockage supplémentaire' -updated: 2025-07-21 +updated: 2025-10-09 --- ## Objectif @@ -346,7 +346,11 @@ System error 1272 has occurred. You can't access this shared folder because your organization's security policies block unauthenticated guest access. These policies help protect your PC from unsafe or malicious devices on the network. ``` -Ce problème peut être résolu en modifiant le Registre Windows : ouvrez l'utilitaire Windows *regedit* et recherchez l'entrée `HKLM\SYSTEM\CurrentControlSet\Services\LanmanWorkstation\Parameters`. Définissez la valeur de `AllowInsecureGuestAuth` sur « 1 ». Retrouvez plus d'informations sur ce sujet sur les [pages de support Microsoft](https://answer.microsoft.com/en-us/windows/forum/all/you-cant-access-this-shared-folder-because-your/01d15775-2cbe-41f8-beb8-84ce588b34ab). +> [!primary] +> +> Pour corriger cette erreur, il convient de modifier la base de registre de Windows. Pour cela, ouvrez l’éditeur de registre (regedit), puis accédez à la clé `HKLM\SYSTEM\CurrentControlSet\Services\LanmanWorkstation\Parameters`.
+> Attribuez ensuite la valeur « 1 » au paramètre `AllowInsecureGuestAuth`.
+> Retrouvez plus d'informations sur ce sujet sur les [pages d'assistance de Microsoft](https://learn.microsoft.com/fr-fr/windows-server/storage/file-server/enable-insecure-guest-logons-smb2-and-smb3). ##### Linux diff --git a/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.it-it.md b/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.it-it.md index 187e4a55295..d6886f5eafd 100644 --- a/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.it-it.md +++ b/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.it-it.md @@ -1,7 +1,7 @@ --- title: Utilizzare il Backup Storage su un server dedicato excerpt: Come attivare e accedere allo spazio di storage aggiuntivo -updated: 2025-07-21 +updated: 2025-10-09 --- ## Obiettivo @@ -345,7 +345,11 @@ System error 1272 has occurred. You can't access this shared folder because your organization's security policies block unauthenticated guest access. These policies help protect your PC from unsafe or malicious devices on the network. ``` -Questo problema può essere risolto modificando il Registro di sistema di Windows: aprire l'utilità Windows *regedit* e cercare la voce `HKLM\SYSTEM\CurrentControlSet\Services\LanmanWorkstation\Parameters`. Impostare il valore di `AllowInsecureGuestAuth` su "1". Per maggiori informazioni al riguardo, visitare le [pagine di supporto Microsoft](https://answer.microsoft.com/en-us/windows/forum/all/you-cant-access-this-shared-folder-because-your/01d15775-2cbe-41f8-beb8-84ce588b34ab). +> [!primary] +> +> Per correggere questo errore, è necessario modificare il registro di sistema di Windows. A tal fine, aprire l'editor del registro (regedit), quindi accedere alla chiave `HKLM\SYSTEM\CurrentControlSet\Services\LanmanWorkstation\Parameters`.
+> Assegnare il valore "1" al parametro `AllowInsecureGuestAuth`.
+> Trova ulteriori informazioni su questo argomento sulle [pagine di supporto Microsoft](https://learn.microsoft.com/it-it/windows-server/storage/file-server/enable-insecure-guest-logons-smb2-and-smb3). ##### Linux diff --git a/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.pl-pl.md b/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.pl-pl.md index 3df3486935f..861dbcaf550 100644 --- a/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.pl-pl.md +++ b/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.pl-pl.md @@ -1,7 +1,7 @@ --- title: 'Korzystanie z Backup Storage na serwerze dedykowanym' excerpt: 'Dowiedz się, jak aktywować i uzyskać dostęp do dodatkowej przestrzeni dyskowej' -updated: 2025-07-21 +updated: 2025-10-09 --- ## Wprowadzenie @@ -347,7 +347,11 @@ System error 1272 has occurred. You can't access this shared folder because your organization's security policies block unauthenticated guest access. These policies help protect your PC from unsafe or malicious devices on the network. ``` -Ten problem można rozwiązać, modyfikując rejestr systemu Windows: otwórz narzędzie systemu Windows *regedit* i wyszukaj wpis `HKLM\SYSTEM\CurrentControlSet\Services\LanmanWorkstation\Parameters`. Ustaw dla parametru `AllowInsecureGuestAuth` wartość "1". Więcej informacji na ten temat można znaleźć na [stronach pomocy technicznej firmy Microsoft](https://answer.microsoft.com/en-us/windows/forum/all/you-cant-access-this-shared-folder-because-your/01d15775-2cbe-41f8-beb8-84ce588b34ab). +> [!primary] +> +> Aby skorygować ten błąd, należy zmodyfikować rejestr systemu Windows. W tym celu należy otworzyć Edytor rejestru (regedit), a następnie przejść do klucza `HKLM\SYSTEM\CurrentControlSet\Services\LanmanWorkstation\Parameters`.
+> Ustaw wartość parametru `AllowInsecureGuestAuth` na "1".
+> Znajdź więcej informacji na ten temat na [stronach pomocy Microsoft](https://learn.microsoft.com/pl-pl/windows-server/storage/file-server/enable-insecure-guest-logons-smb2-and-smb3). ##### Linux diff --git a/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.pt-pt.md b/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.pt-pt.md index ee4c74a9d6b..b9435fb474a 100644 --- a/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.pt-pt.md +++ b/pages/bare_metal_cloud/dedicated_servers/services_backup_storage/guide.pt-pt.md @@ -1,7 +1,7 @@ --- title: 'Utilizar o Backup Storage num servidor dedicado' excerpt: 'Saiba como ativar e aceder ao espaço de armazenamento adicional' -updated: 2025-07-21 +updated: 2025-10-09 --- ## Objetivo @@ -345,7 +345,11 @@ System error 1272 has occurred. You can't access this shared folder because your organization's security policies block unauthenticated guest access. These policies help protect your PC from unsafe or malicious devices on the network. ``` -É possível resolver este problema alterando o registo do Windows: abra o utilitário Windows *regedit* e procure a entrada `HKLM\SYSTEM\CurrentControlSet\Services\LanmanWorkstation\Parameters`. Defina o valor de `AllowInsecureGuestAuth` como "1". Encontre mais informações sobre este assumpto nas [páginas de suporte da Microsoft](https://answer.microsoft.com/en-us/windows/forum/all/you-cant-access-this-shared-folder-because-your/01d15775-2cbe-41f8-beb8-84ce588b34ab). +> [!primary] +> +> Para corrigir este erro, é necessário alterar o registo do Windows. Para tal, abra o editor do registo (regedit) e aceda à chave `HKLM\SYSTEM\CurrentControlSet\Services\LanmanWorkstation\Parameters`.
+> Atribua o valor "1" ao parâmetro `AllowInsecureGuestAuth`.
+> Encontre mais informações sobre este tópico nas [páginas de suporte da Microsoft](https://learn.microsoft.com/pt-pt/windows-server/storage/file-server/enable-insecure-guest-logons-smb2-and-smb3). ##### Linux diff --git a/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.de-de.md b/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.de-de.md index fe13c66ff85..37b25a79a1b 100644 --- a/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.de-de.md +++ b/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.de-de.md @@ -1,210 +1,233 @@ --- -title: 'Intel SGX auf Ihrem Dedicated Server aktivieren' -excerpt: 'SGX auf Ihrem Dedicated Server aktivieren und den Linux-SGX-Software-Stack installieren' -updated: 2022-08-31 +title: "Intel SGX auf Ihrem Dedicated Server aktivieren" +excerpt: "Erfahren Sie, wie Sie SGX auf Ihrem dedizierten Server aktivieren und den Linux SGX-Software-Stack installieren" +updated: 2025-11-20 --- -> [!primary] -> Diese Übersetzung wurde durch unseren Partner SYSTRAN automatisch erstellt. In manchen Fällen können ungenaue Formulierungen verwendet worden sein, z.B. bei der Beschriftung von Schaltflächen oder technischen Details. Bitte ziehen Sie im Zweifelsfall die englische oder französische Fassung der Anleitung zu Rate. Möchten Sie mithelfen, diese Übersetzung zu verbessern? Dann nutzen Sie dazu bitte den Button "Beitragen" auf dieser Seite. -> - ## Ziel Die Aktivierung der Intel Software Guard Extensions (SGX) auf Ihrem Server erlaubt es Ihnen, SGX-kompatible Anwendungen auszuführen. Intel SGX bietet erweiterte Hardware- und RAM-Verschlüsselungsfunktionen, um anwendungsspezifische Code- und Datenbereiche zu isolieren. +**Diese Anleitung erklärt, wie Sie die SGX-Funktion aktivieren können.** + ## Voraussetzungen -- Sie haben einen Dedicated Server kompatibel mit der Option [SGX](https://www.ovhcloud.com/de/bare-metal/intel-software-guard-extensions/) in Ihrem Kunden-Account. - Sie haben Zugriff auf Ihr [OVHcloud Kundencenter](/links/manager) oder die [OVHcloud API](/links/api). +- Sie haben einen Dedicated Server kompatibel mit der Option [SGX](/links/bare-metal/sgx) in Ihrem Kunden-Account. - Sie verfügen über die Zugangsdaten, die Sie nach der Installation per E-Mail erhalten haben. +- Ubuntu 24.04 oder equivalent ist auf dem Server installiert. ## In der praktischen Anwendung -### Über das OVHcloud Kundencenter - -Loggen Sie sich im [OVHcloud Kundencenter](/links/manager) ein, gehen Sie in den Bereich `Bare Metal Cloud`{.action} und wählen Sie dann links im Menü unter **Dedicated Servers** den Server aus, auf dem Sie SGX aktivieren möchten. - -#### Aktivierung der Option - -Scrollen Sie bis zum Bereich "Fortgeschrittene Funktionen" und klicken Sie auf `...`{.action} bei "Sicherheit - Intel SGX (Software Guard Extensions)". Wählen Sie im `SGX aktivieren`{.action} im Dropdown-Menü aus. - -![SGX Aktivierung](images/enable_sgx.png){.thumbnail} - -Klicken Sie im neuen Bereich auf den Button `Aktivieren`{.action}. - -![SGX Aktivierung](images/enable_sgx2.png){.thumbnail} - -Sie können SGX mit einer bestimmten reservierten Speichermenge aktivieren oder Ihrem Programm erlauben, den benötigten Speicher automatisch zu reservieren. Wenn Sie Ihre Wahl getroffen haben, klicken Sie auf `Bestätigen`{.action}. - -![SGX Aktivierung](images/manage_sgx.png){.thumbnail} - -Es erscheint ein Fenster, um zu bestätigen, dass die Aktivierung von Intel SGX einen Neustart Ihres Servers erfordert. - -![SGX Aktivierung](images/confirmation-popup_sgx.png){.thumbnail} - -> [!warning] -> -> Je nach Server führt diese Aktion zu mehreren Neustarts des Servers. - -#### Die Option deaktivieren - -Scrollen Sie bis zum Bereich "Fortgeschrittene Funktionen" und klicken Sie auf `...`{.action} bei "Sicherheit - Intel SGX (Software Guard Extensions)". Klicken Sie auf `SGX bearbeiten`{.action} im Dropdown-Menü. Wählen Sie die Option `Deaktivieren`{.action} aus und klicken Sie dann auf `Bestätigen`{.action}. - -![SGX deaktivieren](images/disable_sgx.png){.thumbnail} - -> [!warning] -> -> Je nach Server führt diese Aktion zu mehreren Neustarts des Servers. - -Folgen Sie der Anleitung weiter ab [Schritt 3](#sgx-softwares). - -### Über die OVHcloud API - -#### Schritt 1: In der API-Konsole anmelden - -Klicken Sie auf der [OVHcloud API Seite](/links/api) auf `Login`{.action} oben rechts. -Melden Sie sich auf der folgenden Seite mit den Logindaten Ihres OVHcloud Kunden-Accounts an. - -#### Schritt 2: SGX aktivieren - -Erhalten Sie den Namen Ihres Servers von der Liste, die von diesem Call zurückgegeben wird: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server - -Um zu überprüfen, ob Ihr Dienst über die SGX-Option verfügt, nutzen Sie folgenden Aufruf: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/biosSettings/sgx - -![SGX deaktiviert](images/get-disabled.png){.thumbnail} - -Aktivieren Sie SGX unter Verwendung des Servernamens: - -> [!warning] -> -> Je nach Server führt diese Aktion zu mehreren Neustarts des Servers. - -> [!api] -> -> @api {v1} /dedicated/server POST /dedicated/server/{serviceName}/biosSettings/sgx/configure - -![SGX aktivieren](images/post-configure.png){.thumbnail} - -Überprüfen Sie den Fortschritt des Konfigurationstasks, indem Sie diesen Endpunkt mit der *taskId* aufrufen, die vom vorherigen Aufruf zurückgegeben wurde: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/task/{taskId} - -![SGX Konfigurationsaufgabe abrufen](images/get-task.png){.thumbnail} - -Sie können überprüfen, ob der Status jetzt aktiviert ist: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/biosSettings/sgx - -![SGX aktiviert](images/get-enabled.png){.thumbnail} - -### Schritt 3: Den SGX Softwarestack installieren - -Verwenden Sie die folgenden Befehle, um den Intel-Treiber und das Software-Kit (SDK) zu installieren, um SGX-Anwendungen entwickeln und ausführen zu können. - -Installieren Sie zunächst mehrere Dependencies: +### SGX aktivieren + +Die Aktivierung von SGX ist über das OVHcloud Kundencenter, die OVHcloud API oder den BIOS Ihres Servers möglich. + +> [!tabs] +> Über das OVHcloud Kundencenter +>> +>> **1 - Anmeldung im OVHcloud Kundencenter** +>> +>> Loggen Sie sich im [OVHcloud Kundencenter](/links/manager) ein, gehen Sie in den Bereich `Bare Metal Cloud`{.action} und klicken Sie auf `Dedicated Servers`{.action}. Wählen Sie anschließend den Server aus, auf dem Sie SGX aktivieren möchten. +>> +>> **2 - SGX aktivieren** +>> +>> Wählen Sie im Tab `Allgemeine Informationen`{.action} im Bereich **Erweiterte Funktionen** die Schaltfläche `...`{.action} neben dem Eintrag **Sicherheit - Intel SGX (Software Guard Extensions)** aus und klicken Sie auf `SGX aktivieren`{.action} im Dropdown-Menü. +>> +>> ![SGX aktivieren](images/enable_sgx.png){.thumbnail} +>> +>> Klicken Sie auf der nächsten Seite auf die Schaltfläche `Aktivieren`{.action}. +>> +>> ![SGX aktivieren](images/enable_sgx2.png){.thumbnail} +>> +>> Sie können entweder SGX mit einer bestimmten Menge reservierten Speichers aktivieren oder SGX aktivieren, indem Sie Ihrem Software-System erlauben, den benötigten Speicher automatisch zu reservieren. Nachdem Sie Ihre Wahl getroffen haben, klicken Sie auf `Bestätigen`{.action}. +>> +>> ![SGX aktivieren](images/manage_sgx.png){.thumbnail} +>> +>> Es erscheint ein Fenster, um zu bestätigen, dass die Aktivierung von Intel SGX einen Neustart Ihres Servers erfordert. +>> +>> ![SGX aktivieren](images/confirmation-popup_sgx.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Dies wird dazu führen, dass Ihr Server einmal oder mehrmals neu gestartet wird, abhängig vom Server-Modell. +>> +> **Über die OVHcloud API** +>> +>> **1 - Anmeldung in der API-Konsole** +>> +>> Klicken Sie auf der [OVHcloud API Seite](/links/console): +>> +>> - Klicken Sie oben rechts auf `Authentication`{.action}. +>> - Klicken Sie anschließend auf `Login with OVHcloud SSO`{.action}. +>> - Geben Sie Ihre OVHcloud Kunden-Zugangsdaten ein. +>> - Klicken Sie auf den Button `Authorize`{.action}, um API-Aufrufe von dieser Seite aus zuzulassen. +>> +>> **2 - SGX aktivieren** +>> +>> Rufen Sie den Namen Ihres Servers aus der Liste ab, die durch folgenden Aufruf zurückgegeben wird: +>> +>> > [!api] +>> > +>> > @api {v1} /dedicated/server GET /dedicated/server +>> +>> Um zu überprüfen, ob Ihr Dienst über die SGX-Option verfügt, nutzen Sie folgenden Aufruf: +>> +>> > [!api] +>> > +>> > @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/biosSettings/sgx +>> +>> ![SGX deaktiviert](images/get-disabled.png){.thumbnail} +>> +>> Aktivieren Sie SGX unter Verwendung des Servernamens: +>> +>> > [!warning] +>> > +>> > Dies wird dazu führen, dass Ihr Server einmal oder mehrmals neu gestartet wird, abhängig vom Servermodell. +>> +>> > [!api] +>> > +>> > @api {v1} /dedicated/server POST /dedicated/server/{serviceName}/biosSettings/sgx/configure +>> +>> ![SGX konfigurieren](images/post-configure.png){.thumbnail} +>> +>> Überprüfen Sie den Fortschritt des Konfigurationstasks, indem Sie diesen Endpunkt mit der *taskId* aufrufen, die vom vorherigen Aufruf zurückgegeben wurde: +>> +>> > [!api] +>> > +>> > @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/task/{taskId} +>> +>> ![SGX-Konfigurationsaufgabe abrufen](images/get-task.png){.thumbnail} +>> +>> Sie können bestätigen, dass der Status auf aktiviert gesetzt ist, indem Sie folgenden Aufruf ausführen: +>> +>> > [!api] +>> > +>> > @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/biosSettings/sgx +>> +>> ![SGX aktiviert](images/get-enabled.png){.thumbnail} +>> +> **Manuelle Konfiguration im BIOS** +>> +>> **1 - Starten Sie eine Remote KVM-Sitzung** +>> +>> Loggen Sie sich im [OVHcloud Kundencenter](/links/manager) ein, gehen Sie in den Bereich `Bare Metal Cloud`{.action} und klicken Sie auf `Dedicated Servers`{.action}. Wählen Sie anschließend den Server aus, auf dem Sie SGX aktivieren möchten. +>> +>> Wählen Sie im Tab `IPMI/KMV`{.action}, Starten Sie anschließend eine Remote KVM-Sitzung: +>> +>> ![Starten Sie eine Remote KVM-Sitzung](images/manager.png){.thumbnail} +>> +>> **2 - SGX aktivieren** +>> +>> Starten Sie den Server neu und öffnen Sie das BIOS (meist durch Drücken von `DEL`{.action} oder `F2`{.action}). +>> +>> Im BIOS wechseln Sie zu `Advanced` > `Processor Configuration`. +>> +>> Aktivieren Sie die Optionen TME und SGX und konfigurieren Sie die gewünschte PRMRR-Größe: +>> +>> ![SGX aktivieren](images/sgx_bios.png){.thumbnail} +>> +>> Speichern Sie die Änderungen, indem Sie die Taste `F10`{.action} drücken. Eine Bestätigung wird angezeigt; wählen Sie `Yes`. +>> +>> Ihr Server wird anschließend neu starten und in Ihr Betriebssystem booten. +>> + +### Installation des SGX-Software-Stacks + +Verwenden Sie die folgenden Befehle, um Intels SDK zu installieren, um SGX-Anwendungen entwickeln und ausführen zu können. + +Zunächst installieren Sie diese Dependencies: ```bash -sudo apt-get install build-essential ocaml ocamlbuild automake autoconf libtool wget python libssl-dev libcurl4-openssl-dev protobuf-compiler libprotobuf-dev debhelper cmake git +sudo apt update +sudo apt install autoconf automake build-essential cmake debhelper git libcurl4-openssl-dev libprotobuf-dev libssl-dev libtool lsb-release ocaml ocamlbuild protobuf-compiler python-is-python3 reprepro wget perl unzip pkgconf libboost-dev libboost-system-dev libboost-thread-dev libsystemd0 ``` -Danach können sie den SGX Softwarestack herunterladen, erstellen und installieren: +Laden Sie anschließend den Quellcode herunter und bereiten Sie die Submodule und Binärdateien vor: ```bash BASE_DIR=/opt/intel [[ -d $BASE_DIR ]] || sudo mkdir -p $BASE_DIR && sudo chown `whoami` $BASE_DIR cd $BASE_DIR - + git clone https://github.com/intel/linux-sgx.git - + cd linux-sgx -git checkout sgx_2.6 -./download_prebuilt.sh -make -j 6 -make sdk_install_pkg -j 6 -make deb_pkg -j 6 -$BASE_DIR/linux-sgx/linux/installer/bin/sgx_linux_x64_sdk_2.6.100.51363.bin --prefix=$BASE_DIR/ - -sudo dpkg -i $BASE_DIR/linux-sgx/linux/installer/deb/libsgx-urts_2.6.100.51363-bionic1_amd64.deb $BASE_DIR/linux-sgx/linux/installer/deb/libsgx-enclave-common_2.6.100.51363-bionic1_amd64.deb +git checkout sgx_2.26 +make preparation ``` -Laden Sie den Treiber herunter und installieren Sie ihn: +Installieren Sie das SGX SDK: ```bash -wget https://download.01.org/intel-sgx/linux-2.6/ubuntu18.04-server/sgx_linux_x64_driver_2.5.0_2605efa.bin -chmod +x sgx_linux_x64_driver_2.5.0_2605efa.bin -sudo ./sgx_linux_x64_driver_2.5.0_2605efa.bin +make sdk_install_pkg +$ ./linux/installer/bin/sgx_linux_x64_sdk_2.26.100.0.bin --prefix=$BASE_DIR/ ``` -### Schritt 4: Neu starten, um die Installation abzuschließen - -Der Server muss neu gestartet werden, um fortzufahren. +### Testen der Beispielanwendung im Simulator-Modus -### Schritt 5: Die Installation validieren (optional) - -Sie können eine Beispielanwendung verwenden, um die Installation zu validieren. Erstellen Sie eine der bereitgestellten Beispiel-Apps: +Um die Beispielanwendung LocalAttestation im Simulator-Modus zu erstellen und auszuführen: ```bash BASE_DIR=/opt/intel cd $BASE_DIR/sgxsdk/SampleCode/LocalAttestation/ source $BASE_DIR/sgxsdk/environment -make SGX_DEBUG=0 SGX_MODE=HW SGX_PRERELEASE=1 + +make clean +SGX_MODE=SIM make +cd bin +./app +succeed to load enclaves. +succeed to establish secure channel. +Succeed to exchange secure message... +Succeed to close Session... ``` -Führen Sie die App aus: - -```bash -ovh@nsXXXX:/opt/intel/sgxsdk/SampleCode/LocalAttestation$ ./app - -Available Enclaves -Enclave1 - EnclaveID 2 -Enclave2 - EnclaveID 3 -Enclave3 - EnclaveID 4 - -Secure Channel Establishment between Source (E1) and Destination (E2) Enclaves successful !!! - -Enclave to Enclave Call between Source (E1) and Destination (E2) Enclaves successful !!! - -Message Exchange between Source (E1) and Destination (E2) Enclaves successful !!! - -Secure Channel Establishment between Source (E1) and Destination (E3) Enclaves successful !!! +### Erstellen und installieren von Intel SGX PSW -Enclave to Enclave Call between Source (E1) and Destination (E3) Enclaves successful !!! +Intel SGX Platform Software (PSW) stellt Software-Bibliotheken bereit, um SGX-Anwendungen im Hardware-Modus auszuführen. Um das lokale Debian-Repository zu erstellen, das die Pakete hostet, führen Sie folgende Befehle aus: -Message Exchange between Source (E1) and Destination (E3) Enclaves successful !!! - -Secure Channel Establishment between Source (E2) and Destination (E3) Enclaves successful !!! - -Enclave to Enclave Call between Source (E2) and Destination (E3) Enclaves successful !!! - -Message Exchange between Source (E2) and Destination (E3) Enclaves successful !!! - -Secure Channel Establishment between Source (E3) and Destination (E1) Enclaves successful !!! +```bash +BASE_DIR=/opt/intel +cd $BASE_DIR/linux-sgx +make deb_local_repo +``` -Enclave to Enclave Call between Source (E3) and Destination (E1) Enclaves successful !!! +Erstellen Sie folgende Datei, um das lokale Repository zur System-Repository-Konfiguration hinzuzufügen: -Message Exchange between Source (E3) and Destination (E1) Enclaves successful !!! +```bash +$ cat /etc/apt/sources.list.d/sgx.sources +Types: deb +URIs: file:/opt/intel/linux-sgx/linux/installer/deb/sgx_debian_local_repo +Suites: noble +Components: main +trusted: yes +``` -Close Session between Source (E1) and Destination (E2) Enclaves successful !!! +Installieren Sie anschließend folgende Pakete: -Close Session between Source (E1) and Destination (E3) Enclaves successful !!! +```bash +sudo apt update +sudo apt-get install libsgx-epid libsgx-quote-ex libsgx-dcap-ql +``` -Close Session between Source (E2) and Destination (E3) Enclaves successful !!! +### Testen der Beispielanwendung im Hardware-Modus (optional) -Close Session between Source (E3) and Destination (E1) Enclaves successful !!! +Um die Beispielanwendung LocalAttestation im Hardware-Modus zu erstellen und auszuführen: -Hit a key.... +```bash +BASE_DIR=/opt/intel +cd $BASE_DIR/sgxsdk/SampleCode/LocalAttestation/ +source $BASE_DIR/sgxsdk/environment + +make clean +SGX_MODE=HW make +cd bin +./app +succeed to load enclaves. +succeed to establish secure channel. +Succeed to exchange secure message... +Succeed to close Session... ``` ## Weiterführende Informationen @@ -213,9 +236,5 @@ Für die weiteren Schritte (Ihre eigene Anwendung entwickeln, sich für die Remo - [Intel SGX](https://software.intel.com/en-us/sgx) - [Intel SGX Attestation services](https://software.intel.com/en-us/sgx/attestation-services) -- [Intel SGX linux-2.6 documentation](https://download.01.org/intel-sgx/linux-2.6/docs/) +- [Intel SGX linux-2.26 documentation](https://download.01.org/intel-sgx/sgx-linux/2.26/docs/) - [github.com/intel/linux-sgx](https://github.com/intel/linux-sgx) -- [github.com/intel/linux-sgx-driver](https://github.com/intel/linux-sgx-driver) -- [github.com/intel/sgx-ra-sample](https://github.com/intel/sgx-ra-sample) - -Für den Austausch mit unserer Community gehen Sie auf . diff --git a/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.en-asia.md b/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.en-asia.md deleted file mode 100644 index ce9812f7656..00000000000 --- a/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.en-asia.md +++ /dev/null @@ -1,219 +0,0 @@ ---- -title: 'Managing Intel SGX on a dedicated server' -excerpt: 'Find out how to enable SGX on your dedicated server and install the Linux SGX software stack' -updated: 2022-08-31 ---- - -## Objective - -Enabling Intel Software Guard Extensions (SGX) on your server allows you to run SGX-ready applications. Intel SGX delivers advanced hardware and RAM security encryption features, in order to isolate parts of code and data that are specific to each application. - -**This guide explains how to enable the SGX feature, in the OVHcloud Control Panel or via the OVHcloud API.** - -## Requirements - -- A dedicated server compatible with the [SGX option](https://www.ovhcloud.com/asia/bare-metal/intel-software-guard-extensions/) in your OVHcloud account -- Access to the [OVHcloud Control Panel](/links/manager) or the [OVHcloud API](/links/api) -- Login credentials received via email after the installation -- Ubuntu 18.04 or equivalent installed on the server - -## Instructions - -### From the OVHcloud Control Panel - -Log in to the [OVHcloud Control Panel](/links/manager), go to the `Bare Metal Cloud`{.action} section and then select the server on which you wish to enable SGX from **Dedicated Servers** in the left-hand sidebar. - -#### Enabling the option - -Scroll down to the "Advanced features" box and click on `...`{.action} next to "Security - Intel SGX (Software Guard Extensions)". Select `Enable SGX`{.action} from the drop-down menu. - -![SGX enabling](images/enable_sgx.png){.thumbnail} - -On the following screen, click the `Enable`{.action} button. - -![SGX enabling](images/enable_sgx2.png){.thumbnail} - -You can either choose to enable SGX with a specific amount of reserved memory or enable it by allowing your software to automatically reserve the memory it needs. Once you have made your choice, click `Confirm`{.action}. - -![SGX enabling](images/manage_sgx.png){.thumbnail} - -A confirmation pop-up will appear. Please confirm you have understood that activating Intel SGX technology will make your server reboot. - -![activation SGX](images/confirmation-popup_sgx.png){.thumbnail} - -> [!warning] -> -> This will cause your server to reboot once or several times, depending on your server model. - -#### Disabling the option - -Scroll down to the "Advanced features" box and click on `...`{.action} next to "Security - Intel SGX (Software Guard Extensions)". Select `Modify SGX`{.action} from the drop-down menu. Choose the `Disable`{.action} option and then click `Confirm`{.action}. - -![SGX disabling](images/disable_sgx.png){.thumbnail} - -> [!warning] -> -> This will cause your server to reboot once or several times, depending on your server model. - -Continue with [Step 3](#sgx-softwares) of the instructions below. - -### Using the OVHcloud API - -#### Step 1: Logging in to the API console - -On the [OVHcloud API page](/links/api) click on `Login`{.action} in the top-right corner. On the following page, enter the credentials of your OVHcloud account. - -#### Step 2: Enabling SGX - -Retrieve the name of your server from the list returned from this call: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server - -Verify that your service has the SGX option, by calling: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/biosSettings/sgx - -![SGX disabled](images/get-disabled.png){.thumbnail} - -Enable SGX using the server name: - -> [!warning] -> -> This will cause your server to reboot once or several times, depending on your server model. - -> [!api] -> -> @api {v1} /dedicated/server POST /dedicated/server/{serviceName}/biosSettings/sgx/configure - -![Configure SGX](images/post-configure.png){.thumbnail} - -Check the progress of the configuration task by calling this endpoint with the *taskId* returned by the previous call: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/task/{taskId} - -![Get SGX configuration task](images/get-task.png){.thumbnail} - -You can verify that the status is set to enabled: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/biosSettings/sgx - -![SGX enabled](images/get-enabled.png){.thumbnail} - -### Step 3: Installing the SGX software stack - -Use the following commands to install Intel's driver and SDK to be able to develop and run SGX applications. - -First, install some dependencies: - -```bash -sudo apt-get install build-essential ocaml ocamlbuild automake autoconf libtool wget python libssl-dev libcurl4-openssl-dev protobuf-compiler libprotobuf-dev debhelper cmake git -``` - -Then, download, build and install the SGX software stack: - -```bash -BASE_DIR=/opt/intel -[[ -d $BASE_DIR ]] || sudo mkdir -p $BASE_DIR && sudo chown `whoami` $BASE_DIR -cd $BASE_DIR - -git clone https://github.com/intel/linux-sgx.git - -cd linux-sgx -git checkout sgx_2.6 -./download_prebuilt.sh -make -j 6 -make sdk_install_pkg -j 6 -make deb_pkg -j 6 -$BASE_DIR/linux-sgx/linux/installer/bin/sgx_linux_x64_sdk_2.6.100.51363.bin --prefix=$BASE_DIR/ - -sudo dpkg -i $BASE_DIR/linux-sgx/linux/installer/deb/libsgx-urts_2.6.100.51363-bionic1_amd64.deb $BASE_DIR/linux-sgx/linux/installer/deb/libsgx-enclave-common_2.6.100.51363-bionic1_amd64.deb -``` - -Download and install the driver: - -```bash -wget https://download.01.org/intel-sgx/linux-2.6/ubuntu18.04-server/sgx_linux_x64_driver_2.5.0_2605efa.bin -chmod +x sgx_linux_x64_driver_2.5.0_2605efa.bin -sudo ./sgx_linux_x64_driver_2.5.0_2605efa.bin -``` - -### Step 4: Rebooting to finish the installation - -The server needs to reboot before continuing. - -### Step 5: Validating the installation (optional) - -You can use a sample application to validate the installation. Build one of the sample apps provided: - -```bash -BASE_DIR=/opt/intel -cd $BASE_DIR/sgxsdk/SampleCode/LocalAttestation/ -source $BASE_DIR/sgxsdk/environment -make SGX_DEBUG=0 SGX_MODE=HW SGX_PRERELEASE=1 -``` - -Run the app: - -```bash -ovh@nsXXXX:/opt/intel/sgxsdk/SampleCode/LocalAttestation$ ./app - -Available Enclaves -Enclave1 - EnclaveID 2 -Enclave2 - EnclaveID 3 -Enclave3 - EnclaveID 4 - -Secure Channel Establishment between Source (E1) and Destination (E2) Enclaves successful !!! - -Enclave to Enclave Call between Source (E1) and Destination (E2) Enclaves successful !!! - -Message Exchange between Source (E1) and Destination (E2) Enclaves successful !!! - -Secure Channel Establishment between Source (E1) and Destination (E3) Enclaves successful !!! - -Enclave to Enclave Call between Source (E1) and Destination (E3) Enclaves successful !!! - -Message Exchange between Source (E1) and Destination (E3) Enclaves successful !!! - -Secure Channel Establishment between Source (E2) and Destination (E3) Enclaves successful !!! - -Enclave to Enclave Call between Source (E2) and Destination (E3) Enclaves successful !!! - -Message Exchange between Source (E2) and Destination (E3) Enclaves successful !!! - -Secure Channel Establishment between Source (E3) and Destination (E1) Enclaves successful !!! - -Enclave to Enclave Call between Source (E3) and Destination (E1) Enclaves successful !!! - -Message Exchange between Source (E3) and Destination (E1) Enclaves successful !!! - -Close Session between Source (E1) and Destination (E2) Enclaves successful !!! - -Close Session between Source (E1) and Destination (E3) Enclaves successful !!! - -Close Session between Source (E2) and Destination (E3) Enclaves successful !!! - -Close Session between Source (E3) and Destination (E1) Enclaves successful !!! - -Hit a key.... -``` - -## Go further - -To go further (develop your own application, register for remote attestation, etc.), here are some useful resources: - -- [Intel SGX](https://software.intel.com/en-us/sgx) -- [Intel SGX Attestation services](https://software.intel.com/en-us/sgx/attestation-services) -- [Intel SGX linux-2.6 documentation](https://download.01.org/intel-sgx/linux-2.6/docs/) -- [github.com/intel/linux-sgx](https://github.com/intel/linux-sgx) -- [github.com/intel/linux-sgx-driver](https://github.com/intel/linux-sgx-driver) -- [github.com/intel/sgx-ra-sample](https://github.com/intel/sgx-ra-sample) - -Join our [community of users](/links/community). diff --git a/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.en-au.md b/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.en-au.md deleted file mode 100644 index 4d96850cae8..00000000000 --- a/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.en-au.md +++ /dev/null @@ -1,219 +0,0 @@ ---- -title: 'Managing Intel SGX on a dedicated server' -excerpt: 'Find out how to enable SGX on your dedicated server and install the Linux SGX software stack' -updated: 2022-08-31 ---- - -## Objective - -Enabling Intel Software Guard Extensions (SGX) on your server allows you to run SGX-ready applications. Intel SGX delivers advanced hardware and RAM security encryption features, in order to isolate parts of code and data that are specific to each application. - -**This guide explains how to enable the SGX feature, in the OVHcloud Control Panel or via the OVHcloud API.** - -## Requirements - -- A dedicated server compatible with the [SGX option](https://www.ovhcloud.com/en-au/bare-metal/intel-software-guard-extensions/) in your OVHcloud account -- Access to the [OVHcloud Control Panel](/links/manager) or the [OVHcloud API](/links/api) -- Login credentials received via email after the installation -- Ubuntu 18.04 or equivalent installed on the server - -## Instructions - -### From the OVHcloud Control Panel - -Log in to the [OVHcloud Control Panel](/links/manager), go to the `Bare Metal Cloud`{.action} section and then select the server on which you wish to enable SGX from **Dedicated Servers** in the left-hand sidebar. - -#### Enabling the option - -Scroll down to the "Advanced features" box and click on `...`{.action} next to "Security - Intel SGX (Software Guard Extensions)". Select `Enable SGX`{.action} from the drop-down menu. - -![SGX enabling](images/enable_sgx.png){.thumbnail} - -On the following screen, click the `Enable`{.action} button. - -![SGX enabling](images/enable_sgx2.png){.thumbnail} - -You can either choose to enable SGX with a specific amount of reserved memory or enable it by allowing your software to automatically reserve the memory it needs. Once you have made your choice, click `Confirm`{.action}. - -![SGX enabling](images/manage_sgx.png){.thumbnail} - -A confirmation pop-up will appear. Please confirm you have understood that activating Intel SGX technology will make your server reboot. - -![activation SGX](images/confirmation-popup_sgx.png){.thumbnail} - -> [!warning] -> -> This will cause your server to reboot once or several times, depending on your server model. - -#### Disabling the option - -Scroll down to the "Advanced features" box and click on `...`{.action} next to "Security - Intel SGX (Software Guard Extensions)". Select `Modify SGX`{.action} from the drop-down menu. Choose the `Disable`{.action} option and then click `Confirm`{.action}. - -![SGX disabling](images/disable_sgx.png){.thumbnail} - -> [!warning] -> -> This will cause your server to reboot once or several times, depending on your server model. - -Continue with [Step 3](#sgx-softwares) of the instructions below. - -### Using the OVHcloud API - -#### Step 1: Logging in to the API console - -On the [OVHcloud API page](/links/api) click on `Login`{.action} in the top-right corner. On the following page, enter the credentials of your OVHcloud account. - -#### Step 2: Enabling SGX - -Retrieve the name of your server from the list returned from this call: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server - -Verify that your service has the SGX option, by calling: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/biosSettings/sgx - -![SGX disabled](images/get-disabled.png){.thumbnail} - -Enable SGX using the server name: - -> [!warning] -> -> This will cause your server to reboot once or several times, depending on your server model. - -> [!api] -> -> @api {v1} /dedicated/server POST /dedicated/server/{serviceName}/biosSettings/sgx/configure - -![Configure SGX](images/post-configure.png){.thumbnail} - -Check the progress of the configuration task by calling this endpoint with the *taskId* returned by the previous call: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/task/{taskId} - -![Get SGX configuration task](images/get-task.png){.thumbnail} - -You can verify that the status is set to enabled: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/biosSettings/sgx - -![SGX enabled](images/get-enabled.png){.thumbnail} - -### Step 3: Installing the SGX software stack - -Use the following commands to install Intel's driver and SDK to be able to develop and run SGX applications. - -First, install some dependencies: - -```bash -sudo apt-get install build-essential ocaml ocamlbuild automake autoconf libtool wget python libssl-dev libcurl4-openssl-dev protobuf-compiler libprotobuf-dev debhelper cmake git -``` - -Then, download, build and install the SGX software stack: - -```bash -BASE_DIR=/opt/intel -[[ -d $BASE_DIR ]] || sudo mkdir -p $BASE_DIR && sudo chown `whoami` $BASE_DIR -cd $BASE_DIR - -git clone https://github.com/intel/linux-sgx.git - -cd linux-sgx -git checkout sgx_2.6 -./download_prebuilt.sh -make -j 6 -make sdk_install_pkg -j 6 -make deb_pkg -j 6 -$BASE_DIR/linux-sgx/linux/installer/bin/sgx_linux_x64_sdk_2.6.100.51363.bin --prefix=$BASE_DIR/ - -sudo dpkg -i $BASE_DIR/linux-sgx/linux/installer/deb/libsgx-urts_2.6.100.51363-bionic1_amd64.deb $BASE_DIR/linux-sgx/linux/installer/deb/libsgx-enclave-common_2.6.100.51363-bionic1_amd64.deb -``` - -Download and install the driver: - -```bash -wget https://download.01.org/intel-sgx/linux-2.6/ubuntu18.04-server/sgx_linux_x64_driver_2.5.0_2605efa.bin -chmod +x sgx_linux_x64_driver_2.5.0_2605efa.bin -sudo ./sgx_linux_x64_driver_2.5.0_2605efa.bin -``` - -### Step 4: Rebooting to finish the installation - -The server needs to reboot before continuing. - -### Step 5: Validating the installation (optional) - -You can use a sample application to validate the installation. Build one of the sample apps provided: - -```bash -BASE_DIR=/opt/intel -cd $BASE_DIR/sgxsdk/SampleCode/LocalAttestation/ -source $BASE_DIR/sgxsdk/environment -make SGX_DEBUG=0 SGX_MODE=HW SGX_PRERELEASE=1 -``` - -Run the app: - -```bash -ovh@nsXXXX:/opt/intel/sgxsdk/SampleCode/LocalAttestation$ ./app - -Available Enclaves -Enclave1 - EnclaveID 2 -Enclave2 - EnclaveID 3 -Enclave3 - EnclaveID 4 - -Secure Channel Establishment between Source (E1) and Destination (E2) Enclaves successful !!! - -Enclave to Enclave Call between Source (E1) and Destination (E2) Enclaves successful !!! - -Message Exchange between Source (E1) and Destination (E2) Enclaves successful !!! - -Secure Channel Establishment between Source (E1) and Destination (E3) Enclaves successful !!! - -Enclave to Enclave Call between Source (E1) and Destination (E3) Enclaves successful !!! - -Message Exchange between Source (E1) and Destination (E3) Enclaves successful !!! - -Secure Channel Establishment between Source (E2) and Destination (E3) Enclaves successful !!! - -Enclave to Enclave Call between Source (E2) and Destination (E3) Enclaves successful !!! - -Message Exchange between Source (E2) and Destination (E3) Enclaves successful !!! - -Secure Channel Establishment between Source (E3) and Destination (E1) Enclaves successful !!! - -Enclave to Enclave Call between Source (E3) and Destination (E1) Enclaves successful !!! - -Message Exchange between Source (E3) and Destination (E1) Enclaves successful !!! - -Close Session between Source (E1) and Destination (E2) Enclaves successful !!! - -Close Session between Source (E1) and Destination (E3) Enclaves successful !!! - -Close Session between Source (E2) and Destination (E3) Enclaves successful !!! - -Close Session between Source (E3) and Destination (E1) Enclaves successful !!! - -Hit a key.... -``` - -## Go further - -To go further (develop your own application, register for remote attestation, etc.), here are some useful resources: - -- [Intel SGX](https://software.intel.com/en-us/sgx) -- [Intel SGX Attestation services](https://software.intel.com/en-us/sgx/attestation-services) -- [Intel SGX linux-2.6 documentation](https://download.01.org/intel-sgx/linux-2.6/docs/) -- [github.com/intel/linux-sgx](https://github.com/intel/linux-sgx) -- [github.com/intel/linux-sgx-driver](https://github.com/intel/linux-sgx-driver) -- [github.com/intel/sgx-ra-sample](https://github.com/intel/sgx-ra-sample) - -Join our [community of users](/links/community). diff --git a/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.en-ca.md b/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.en-ca.md deleted file mode 100644 index e39e4cbe86b..00000000000 --- a/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.en-ca.md +++ /dev/null @@ -1,219 +0,0 @@ ---- -title: 'Managing Intel SGX on a dedicated server' -excerpt: 'Find out how to enable SGX on your dedicated server and install the Linux SGX software stack' -updated: 2022-08-31 ---- - -## Objective - -Enabling Intel Software Guard Extensions (SGX) on your server allows you to run SGX-ready applications. Intel SGX delivers advanced hardware and RAM security encryption features, in order to isolate parts of code and data that are specific to each application. - -**This guide explains how to enable the SGX feature, in the OVHcloud Control Panel or via the OVHcloud API.** - -## Requirements - -- A dedicated server compatible with the [SGX option](https://www.ovhcloud.com/en-ca/bare-metal/intel-software-guard-extensions/) in your OVHcloud account -- Access to the [OVHcloud Control Panel](/links/manager) or the [OVHcloud API](/links/api) -- Login credentials received via email after the installation -- Ubuntu 18.04 or equivalent installed on the server - -## Instructions - -### From the OVHcloud Control Panel - -Log in to the [OVHcloud Control Panel](/links/manager), go to the `Bare Metal Cloud`{.action} section and then select the server on which you wish to enable SGX from **Dedicated Servers** in the left-hand sidebar. - -#### Enabling the option - -Scroll down to the "Advanced features" box and click on `...`{.action} next to "Security - Intel SGX (Software Guard Extensions)". Select `Enable SGX`{.action} from the drop-down menu. - -![SGX enabling](images/enable_sgx.png){.thumbnail} - -On the following screen, click the `Enable`{.action} button. - -![SGX enabling](images/enable_sgx2.png){.thumbnail} - -You can either choose to enable SGX with a specific amount of reserved memory or enable it by allowing your software to automatically reserve the memory it needs. Once you have made your choice, click `Confirm`{.action}. - -![SGX enabling](images/manage_sgx.png){.thumbnail} - -A confirmation pop-up will appear. Please confirm you have understood that activating Intel SGX technology will make your server reboot. - -![activation SGX](images/confirmation-popup_sgx.png){.thumbnail} - -> [!warning] -> -> This will cause your server to reboot once or several times, depending on your server model. - -#### Disabling the option - -Scroll down to the "Advanced features" box and click on `...`{.action} next to "Security - Intel SGX (Software Guard Extensions)". Select `Modify SGX`{.action} from the drop-down menu. Choose the `Disable`{.action} option and then click `Confirm`{.action}. - -![SGX disabling](images/disable_sgx.png){.thumbnail} - -> [!warning] -> -> This will cause your server to reboot once or several times, depending on your server model. - -Continue with [Step 3](#sgx-softwares) of the instructions below. - -### Using the OVHcloud API - -#### Step 1: Logging in to the API console - -On the [OVHcloud API page](/links/api) click on `Login`{.action} in the top-right corner. On the following page, enter the credentials of your OVHcloud account. - -#### Step 2: Enabling SGX - -Retrieve the name of your server from the list returned from this call: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server - -Verify that your service has the SGX option, by calling: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/biosSettings/sgx - -![SGX disabled](images/get-disabled.png){.thumbnail} - -Enable SGX using the server name: - -> [!warning] -> -> This will cause your server to reboot once or several times, depending on your server model. - -> [!api] -> -> @api {v1} /dedicated/server POST /dedicated/server/{serviceName}/biosSettings/sgx/configure - -![Configure SGX](images/post-configure.png){.thumbnail} - -Check the progress of the configuration task by calling this endpoint with the *taskId* returned by the previous call: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/task/{taskId} - -![Get SGX configuration task](images/get-task.png){.thumbnail} - -You can verify that the status is set to enabled: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/biosSettings/sgx - -![SGX enabled](images/get-enabled.png){.thumbnail} - -### Step 3: Installing the SGX software stack - -Use the following commands to install Intel's driver and SDK to be able to develop and run SGX applications. - -First, install some dependencies: - -```bash -sudo apt-get install build-essential ocaml ocamlbuild automake autoconf libtool wget python libssl-dev libcurl4-openssl-dev protobuf-compiler libprotobuf-dev debhelper cmake git -``` - -Then, download, build and install the SGX software stack: - -```bash -BASE_DIR=/opt/intel -[[ -d $BASE_DIR ]] || sudo mkdir -p $BASE_DIR && sudo chown `whoami` $BASE_DIR -cd $BASE_DIR - -git clone https://github.com/intel/linux-sgx.git - -cd linux-sgx -git checkout sgx_2.6 -./download_prebuilt.sh -make -j 6 -make sdk_install_pkg -j 6 -make deb_pkg -j 6 -$BASE_DIR/linux-sgx/linux/installer/bin/sgx_linux_x64_sdk_2.6.100.51363.bin --prefix=$BASE_DIR/ - -sudo dpkg -i $BASE_DIR/linux-sgx/linux/installer/deb/libsgx-urts_2.6.100.51363-bionic1_amd64.deb $BASE_DIR/linux-sgx/linux/installer/deb/libsgx-enclave-common_2.6.100.51363-bionic1_amd64.deb -``` - -Download and install the driver: - -```bash -wget https://download.01.org/intel-sgx/linux-2.6/ubuntu18.04-server/sgx_linux_x64_driver_2.5.0_2605efa.bin -chmod +x sgx_linux_x64_driver_2.5.0_2605efa.bin -sudo ./sgx_linux_x64_driver_2.5.0_2605efa.bin -``` - -### Step 4: Rebooting to finish the installation - -The server needs to reboot before continuing. - -### Step 5: Validating the installation (optional) - -You can use a sample application to validate the installation. Build one of the sample apps provided: - -```bash -BASE_DIR=/opt/intel -cd $BASE_DIR/sgxsdk/SampleCode/LocalAttestation/ -source $BASE_DIR/sgxsdk/environment -make SGX_DEBUG=0 SGX_MODE=HW SGX_PRERELEASE=1 -``` - -Run the app: - -```bash -ovh@nsXXXX:/opt/intel/sgxsdk/SampleCode/LocalAttestation$ ./app - -Available Enclaves -Enclave1 - EnclaveID 2 -Enclave2 - EnclaveID 3 -Enclave3 - EnclaveID 4 - -Secure Channel Establishment between Source (E1) and Destination (E2) Enclaves successful !!! - -Enclave to Enclave Call between Source (E1) and Destination (E2) Enclaves successful !!! - -Message Exchange between Source (E1) and Destination (E2) Enclaves successful !!! - -Secure Channel Establishment between Source (E1) and Destination (E3) Enclaves successful !!! - -Enclave to Enclave Call between Source (E1) and Destination (E3) Enclaves successful !!! - -Message Exchange between Source (E1) and Destination (E3) Enclaves successful !!! - -Secure Channel Establishment between Source (E2) and Destination (E3) Enclaves successful !!! - -Enclave to Enclave Call between Source (E2) and Destination (E3) Enclaves successful !!! - -Message Exchange between Source (E2) and Destination (E3) Enclaves successful !!! - -Secure Channel Establishment between Source (E3) and Destination (E1) Enclaves successful !!! - -Enclave to Enclave Call between Source (E3) and Destination (E1) Enclaves successful !!! - -Message Exchange between Source (E3) and Destination (E1) Enclaves successful !!! - -Close Session between Source (E1) and Destination (E2) Enclaves successful !!! - -Close Session between Source (E1) and Destination (E3) Enclaves successful !!! - -Close Session between Source (E2) and Destination (E3) Enclaves successful !!! - -Close Session between Source (E3) and Destination (E1) Enclaves successful !!! - -Hit a key.... -``` - -## Go further - -To go further (develop your own application, register for remote attestation, etc.), here are some useful resources: - -- [Intel SGX](https://software.intel.com/en-us/sgx) -- [Intel SGX Attestation services](https://software.intel.com/en-us/sgx/attestation-services) -- [Intel SGX linux-2.6 documentation](https://download.01.org/intel-sgx/linux-2.6/docs/) -- [github.com/intel/linux-sgx](https://github.com/intel/linux-sgx) -- [github.com/intel/linux-sgx-driver](https://github.com/intel/linux-sgx-driver) -- [github.com/intel/sgx-ra-sample](https://github.com/intel/sgx-ra-sample) - -Join our [community of users](/links/community). diff --git a/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.en-gb.md b/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.en-gb.md index 7353b8596d9..73fcd86dba1 100644 --- a/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.en-gb.md +++ b/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.en-gb.md @@ -1,208 +1,233 @@ --- -title: 'Managing Intel SGX on a dedicated server' -excerpt: 'Find out how to enable SGX on your dedicated server and install the Linux SGX software stack' -updated: 2022-08-31 +title: "How to manage Intel SGX on a dedicated server" +excerpt: "Find out how to enable the SGX option on your dedicated server and install the SGX software stack for Linux" +updated: 2025-11-20 --- ## Objective -Enabling Intel Software Guard Extensions (SGX) on your server allows you to run SGX-ready applications. Intel SGX delivers advanced hardware and RAM security encryption features, in order to isolate parts of code and data that are specific to each application. +Enabling Intel Software Guard Extensions (SGX) on your server allows you to run SGX-ready applications. Intel SGX provides advanced hardware and RAM security encryption features, in order to isolate specific parts of code and data for each application. -**This guide explains how to enable the SGX feature, in the OVHcloud Control Panel or via the OVHcloud API.** +**This guide explains how to enable the SGX feature, via the OVHcloud Control Panel or via the OVHcloud API.** ## Requirements -- A dedicated server compatible with the [SGX option](https://www.ovhcloud.com/en-gb/bare-metal/intel-software-guard-extensions/) in your OVHcloud account -- Access to the [OVHcloud Control Panel](/links/manager) or the [OVHcloud API](/links/api) -- Login credentials received via email after the installation -- Ubuntu 18.04 or equivalent installed on the server +- Access to the [OVHcloud Control Panel](/links/manager) or to the [OVHcloud API](/links/api) +- A dedicated server compatible with the [SGX option](/links/bare-metal/sgx) in your OVHcloud account +- The credentials received by email after installation +- Ubuntu 24.04 or equivalent is installed on the server ## Instructions -### From the OVHcloud Control Panel - -Log in to the [OVHcloud Control Panel](/links/manager), go to the `Bare Metal Cloud`{.action} section and then select the server on which you wish to enable SGX from **Dedicated Servers** in the left-hand sidebar. - -#### Enabling the option - -Scroll down to the "Advanced features" box and click on `...`{.action} next to "Security - Intel SGX (Software Guard Extensions)". Select `Enable SGX`{.action} from the drop-down menu. - -![SGX enabling](images/enable_sgx.png){.thumbnail} - -On the following screen, click the `Enable`{.action} button. - -![SGX enabling](images/enable_sgx2.png){.thumbnail} - -You can either choose to enable SGX with a specific amount of reserved memory or enable it by allowing your software to automatically reserve the memory it needs. Once you have made your choice, click `Confirm`{.action}. - -![SGX enabling](images/manage_sgx.png){.thumbnail} - -A confirmation pop-up will appear. Please confirm you have understood that activating Intel SGX technology will make your server reboot. - -![activation SGX](images/confirmation-popup_sgx.png){.thumbnail} - -> [!warning] -> -> This will cause your server to reboot once or several times, depending on your server model. - -#### Disabling the option - -Scroll down to the "Advanced features" box and click on `...`{.action} next to "Security - Intel SGX (Software Guard Extensions)". Select `Modify SGX`{.action} from the drop-down menu. Choose the `Disable`{.action} option and then click `Confirm`{.action}. - -![SGX disabling](images/disable_sgx.png){.thumbnail} - -> [!warning] -> -> This will cause your server to reboot once or several times, depending on your server model. - -Continue with [Step 3](#sgx-softwares) of the instructions below. - -### Using the OVHcloud API - -#### Step 1: Logging in to the API console - -On the [OVHcloud API page](/links/api) click on `Login`{.action} in the top-right corner. On the following page, enter the credentials of your OVHcloud account. - -#### Step 2: Enabling SGX - -Retrieve the name of your server from the list returned from this call: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server - -Verify that your service has the SGX option, by calling: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/biosSettings/sgx - -![SGX disabled](images/get-disabled.png){.thumbnail} - -Enable SGX using the server name: - -> [!warning] -> -> This will cause your server to reboot once or several times, depending on your server model. - -> [!api] -> -> @api {v1} /dedicated/server POST /dedicated/server/{serviceName}/biosSettings/sgx/configure - -![Configure SGX](images/post-configure.png){.thumbnail} - -Check the progress of the configuration task by calling this endpoint with the *taskId* returned by the previous call: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/task/{taskId} - -![Get SGX configuration task](images/get-task.png){.thumbnail} - -You can verify that the status is set to enabled: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/biosSettings/sgx - -![SGX enabled](images/get-enabled.png){.thumbnail} - -### Step 3: Installing the SGX software stack - -Use the following commands to install Intel's driver and SDK to be able to develop and run SGX applications. +### Enabling SGX + +The activation of SGX is possible from the OVHcloud Control Panel, the OVHcloud API, or your server's BIOS. + +> [!tabs] +> **Via the OVHcloud Control Panel** +>> +>> **1 - Logging in to the OVHcloud Control Panel** +>> +>> Log in to the [OVHcloud Control Panel](/links/manager), go to the `Bare Metal Cloud`{.action} section and click on `Dedicated Servers`{.action}. Select the server on which you want to enable SGX. +>> +>> **2 - Enabling SGX** +>> +>> From the `General Information`{.action} tab, in the **Advanced Features** box, click on `...`{.action} next to the **Security - Intel SGX (Software Guard Extensions)** entry and select `Enable SGX`{.action} from the dropdown menu. +>> +>> ![Enable SGX](images/enable_sgx.png){.thumbnail} +>> +>> On the next screen, click on the `Enable`{.action} button. +>> +>> ![Enable SGX](images/enable_sgx2.png){.thumbnail} +>> +>> You can choose to enable SGX with a specific amount of reserved memory or allow your application to automatically reserve the memory it needs. Once your choice is made, click on `Confirm`{.action}. +>> +>> ![Manage SGX](images/manage_sgx.png){.thumbnail} +>> +>> A confirmation window will appear. Please confirm that you understand that enabling Intel SGX technology will result in a server reboot. +>> +>> ![Enable SGX](images/confirmation-popup_sgx.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > This will result in one or more server reboots, depending on its model. +>> +> **Via the OVHcloud API** +>> +>> **1 - Logging in to the API console** +>> +>> On the [OVHcloud API page](/links/console): +>> +>> - Click on `Authentication`{.action} in the top left. +>> - Then click on `Login with OVHcloud SSO`{.action}. +>> - Enter your OVHcloud credentials. +>> - Click on the `Authorize`{.action} button to authorise API calls from this site. +>> +>> **2 - Enabling SGX** +>> +>> Retrieve the name of your server from the list returned by the following call: +>> +>> > [!api] +>> > +>> > @api {v1} /dedicated/server GET /dedicated/server +>> +>> Check that your service has the SGX option using this call: +>> +>> > [!api] +>> > +>> > @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/biosSettings/sgx +>> +>> ![SGX disabled](images/get-disabled.png){.thumbnail} +>> +>> Enable SGX using the server name: +>> +>> > [!warning] +>> > +>> > This will result in one or more server reboots, depending on its model. +>> +>> > [!api] +>> > +>> > @api {v1} /dedicated/server POST /dedicated/server/{serviceName}/biosSettings/sgx/configure +>> +>> ![Configure SGX](images/post-configure.png){.thumbnail} +>> +>> Check the progress of the configuration task by calling this endpoint with the *taskId* returned by the previous call: +>> +>> > [!api] +>> > +>> > @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/task/{taskId} +>> +>> ![Get SGX configuration task](images/get-task.png){.thumbnail} +>> +>> You can verify that the status is enabled: +>> +>> > [!api] +>> > +>> > @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/biosSettings/sgx +>> +>> ![SGX enabled](images/get-enabled.png){.thumbnail} +>> +> **Manual configuration in the BIOS** +>> +>> **1 - Start a Remote KVM session** +>> +>> Log in to the [OVHcloud Control Panel](/links/manager), go to the `Bare Metal Cloud`{.action} section and click on `Dedicated Servers`{.action}. Select the server on which you want to enable SGX. +>> +>> From the `IPMI/KMV`{.action} tab, start a Remote KVM session: +>> +>> ![Start a Remote KVM session](images/manager.png){.thumbnail} +>> +>> **2 - Enabling SGX** +>> +>> Then, from the KVM, initiate a server reboot and enter the BIOS (usually by pressing the `DEL`{.action} or `F2`{.action} key). +>> +>> In the BIOS, go to the `Advanced` > `Processor Configuration` section. +>> +>> Enable the TME and SGX options and configure the desired PRMRR size: +>> +>> ![Enable SGX](images/sgx_bios.png){.thumbnail} +>> +>> Save the changes by pressing the `F10`{.action} key. A confirmation window will appear, please confirm with the `Yes` option. +>> +>> Your server will then reboot into your operating system. +>> + +### Installing the SGX software stack + +Use the following commands to install the Intel SDK in order to develop and run SGX applications. First, install some dependencies: ```bash -sudo apt-get install build-essential ocaml ocamlbuild automake autoconf libtool wget python libssl-dev libcurl4-openssl-dev protobuf-compiler libprotobuf-dev debhelper cmake git +sudo apt update +sudo apt install autoconf automake build-Essential cmake debhelper git libcurl4-openssl-dev libprotobuf-dev libssl-dev libtool lsb-release ocaml ocamlbuild protobuf-compiler python-is-python3 reprepro wget perl unzip pkgconf libboost-dev libboost-system-dev libboost-thread-dev libsystemd0 ``` -Then, download, build and install the SGX software stack: +Next, download the source code and prepare the submodules and prebuilt binaries: ```bash BASE_DIR=/opt/intel [[ -d $BASE_DIR ]] || sudo mkdir -p $BASE_DIR && sudo chown `whoami` $BASE_DIR cd $BASE_DIR - + git clone https://github.com/intel/linux-sgx.git - + cd linux-sgx -git checkout sgx_2.6 -./download_prebuilt.sh -make -j 6 -make sdk_install_pkg -j 6 -make deb_pkg -j 6 -$BASE_DIR/linux-sgx/linux/installer/bin/sgx_linux_x64_sdk_2.6.100.51363.bin --prefix=$BASE_DIR/ - -sudo dpkg -i $BASE_DIR/linux-sgx/linux/installer/deb/libsgx-urts_2.6.100.51363-bionic1_amd64.deb $BASE_DIR/linux-sgx/linux/installer/deb/libsgx-enclave-common_2.6.100.51363-bionic1_amd64.deb +git checkout sgx_2.26 +make preparation ``` -Download and install the driver: +Build and install the SGX SDK: ```bash -wget https://download.01.org/intel-sgx/linux-2.6/ubuntu18.04-server/sgx_linux_x64_driver_2.5.0_2605efa.bin -chmod +x sgx_linux_x64_driver_2.5.0_2605efa.bin -sudo ./sgx_linux_x64_driver_2.5.0_2605efa.bin +make sdk_install_pkg +$ ./linux/installer/bin/sgx_linux_x64_sdk_2.26.100.0.bin --prefix=$BASE_DIR/ ``` -### Step 4: Rebooting to finish the installation - -The server needs to reboot before continuing. +### Test the sample application in simulation mode -### Step 5: Validating the installation (optional) - -You can use a sample application to validate the installation. Build one of the sample apps provided: +To build and run the *LocalAttestation* sample code in simulation mode: ```bash BASE_DIR=/opt/intel cd $BASE_DIR/sgxsdk/SampleCode/LocalAttestation/ source $BASE_DIR/sgxsdk/environment -make SGX_DEBUG=0 SGX_MODE=HW SGX_PRERELEASE=1 + +make clean +SGX_MODE=SIM make +cd bin +sudo ./app +succeed to load enclaves. +succeed to establish secure channel. +Succeed to exchange secure message... +Succeed to close Session... ``` -Run the app: - -```bash -ovh@nsXXXX:/opt/intel/sgxsdk/SampleCode/LocalAttestation$ ./app - -Available Enclaves -Enclave1 - EnclaveID 2 -Enclave2 - EnclaveID 3 -Enclave3 - EnclaveID 4 - -Secure Channel Establishment between Source (E1) and Destination (E2) Enclaves successful !!! - -Enclave to Enclave Call between Source (E1) and Destination (E2) Enclaves successful !!! - -Message Exchange between Source (E1) and Destination (E2) Enclaves successful !!! - -Secure Channel Establishment between Source (E1) and Destination (E3) Enclaves successful !!! +### Build and install the Intel SGX PSW -Enclave to Enclave Call between Source (E1) and Destination (E3) Enclaves successful !!! +The Intel SGX Platform Software (PSW) provides software libraries to run SGX applications in hardware mode. To create the local Debian repository that hosts the packages, run the following commands: -Message Exchange between Source (E1) and Destination (E3) Enclaves successful !!! - -Secure Channel Establishment between Source (E2) and Destination (E3) Enclaves successful !!! - -Enclave to Enclave Call between Source (E2) and Destination (E3) Enclaves successful !!! - -Message Exchange between Source (E2) and Destination (E3) Enclaves successful !!! - -Secure Channel Establishment between Source (E3) and Destination (E1) Enclaves successful !!! +```bash +BASE_DIR=/opt/intel +cd $BASE_DIR/linux-sgx +make deb_local_repo +``` -Enclave to Enclave Call between Source (E3) and Destination (E1) Enclaves successful !!! +Create the following file to add the local Debian package repository to the repository configuration system: -Message Exchange between Source (E3) and Destination (E1) Enclaves successful !!! +```bash +$ cat /etc/apt/sources.list.d/sgx.sources +Types: deb +URIs: file:/opt/intel/linux-sgx/linux/installer/deb/sgx_debian_local_repo +Suites: noble +Components: main +trusted: yes +``` -Close Session between Source (E1) and Destination (E2) Enclaves successful !!! +Then, install the following packages: -Close Session between Source (E1) and Destination (E3) Enclaves successful !!! +```bash +sudo apt update +sudo apt-get install libsgx-epid libsgx-quote-ex libsgx-dcap-ql +``` -Close Session between Source (E2) and Destination (E3) Enclaves successful !!! +### Test the sample application in hardware mode (optional) -Close Session between Source (E3) and Destination (E1) Enclaves successful !!! +To build and run the *LocalAttestation* sample code in hardware mode: -Hit a key.... +```bash +BASE_DIR=/opt/intel +cd $BASE_DIR/sgxsdk/SampleCode/LocalAttestation/ +source $BASE_DIR/sgxsdk/environment + +make clean +SGX_MODE=HW make +cd bin +sudo ./app +succeed to load enclaves. +succeed to establish secure channel. +Succeed to exchange secure message... +Succeed to close Session... ``` ## Go further @@ -211,9 +236,5 @@ To go further (develop your own application, register for remote attestation, et - [Intel SGX](https://software.intel.com/en-us/sgx) - [Intel SGX Attestation services](https://software.intel.com/en-us/sgx/attestation-services) -- [Intel SGX linux-2.6 documentation](https://download.01.org/intel-sgx/linux-2.6/docs/) +- [Intel SGX linux-2.26 documentation](https://download.01.org/intel-sgx/sgx-linux/2.26/docs/) - [github.com/intel/linux-sgx](https://github.com/intel/linux-sgx) -- [github.com/intel/linux-sgx-driver](https://github.com/intel/linux-sgx-driver) -- [github.com/intel/sgx-ra-sample](https://github.com/intel/sgx-ra-sample) - -Join our [community of users](/links/community). diff --git a/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.en-ie.md b/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.en-ie.md deleted file mode 100644 index 6258c429543..00000000000 --- a/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.en-ie.md +++ /dev/null @@ -1,219 +0,0 @@ ---- -title: 'Managing Intel SGX on a dedicated server' -excerpt: 'Find out how to enable SGX on your dedicated server and install the Linux SGX software stack' -updated: 2022-08-31 ---- - -## Objective - -Enabling Intel Software Guard Extensions (SGX) on your server allows you to run SGX-ready applications. Intel SGX delivers advanced hardware and RAM security encryption features, in order to isolate parts of code and data that are specific to each application. - -**This guide explains how to enable the SGX feature, in the OVHcloud Control Panel or via the OVHcloud API.** - -## Requirements - -- A dedicated server compatible with the [SGX option](https://www.ovhcloud.com/en-ie/bare-metal/intel-software-guard-extensions/) in your OVHcloud account -- Access to the [OVHcloud Control Panel](/links/manager) or the [OVHcloud API](/links/api) -- Login credentials received via email after the installation -- Ubuntu 18.04 or equivalent installed on the server - -## Instructions - -### From the OVHcloud Control Panel - -Log in to the [OVHcloud Control Panel](/links/manager), go to the `Bare Metal Cloud`{.action} section and then select the server on which you wish to enable SGX from **Dedicated Servers** in the left-hand sidebar. - -#### Enabling the option - -Scroll down to the "Advanced features" box and click on `...`{.action} next to "Security - Intel SGX (Software Guard Extensions)". Select `Enable SGX`{.action} from the drop-down menu. - -![SGX enabling](images/enable_sgx.png){.thumbnail} - -On the following screen, click the `Enable`{.action} button. - -![SGX enabling](images/enable_sgx2.png){.thumbnail} - -You can either choose to enable SGX with a specific amount of reserved memory or enable it by allowing your software to automatically reserve the memory it needs. Once you have made your choice, click `Confirm`{.action}. - -![SGX enabling](images/manage_sgx.png){.thumbnail} - -A confirmation pop-up will appear. Please confirm you have understood that activating Intel SGX technology will make your server reboot. - -![activation SGX](images/confirmation-popup_sgx.png){.thumbnail} - -> [!warning] -> -> This will cause your server to reboot once or several times, depending on your server model. - -#### Disabling the option - -Scroll down to the "Advanced features" box and click on `...`{.action} next to "Security - Intel SGX (Software Guard Extensions)". Select `Modify SGX`{.action} from the drop-down menu. Choose the `Disable`{.action} option and then click `Confirm`{.action}. - -![SGX disabling](images/disable_sgx.png){.thumbnail} - -> [!warning] -> -> This will cause your server to reboot once or several times, depending on your server model. - -Continue with [Step 3](#sgx-softwares) of the instructions below. - -### Using the OVHcloud API - -#### Step 1: Logging in to the API console - -On the [OVHcloud API page](/links/api) click on `Login`{.action} in the top-right corner. On the following page, enter the credentials of your OVHcloud account. - -#### Step 2: Enabling SGX - -Retrieve the name of your server from the list returned from this call: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server - -Verify that your service has the SGX option, by calling: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/biosSettings/sgx - -![SGX disabled](images/get-disabled.png){.thumbnail} - -Enable SGX using the server name: - -> [!warning] -> -> This will cause your server to reboot once or several times, depending on your server model. - -> [!api] -> -> @api {v1} /dedicated/server POST /dedicated/server/{serviceName}/biosSettings/sgx/configure - -![Configure SGX](images/post-configure.png){.thumbnail} - -Check the progress of the configuration task by calling this endpoint with the *taskId* returned by the previous call: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/task/{taskId} - -![Get SGX configuration task](images/get-task.png){.thumbnail} - -You can verify that the status is set to enabled: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/biosSettings/sgx - -![SGX enabled](images/get-enabled.png){.thumbnail} - -### Step 3: Installing the SGX software stack - -Use the following commands to install Intel's driver and SDK to be able to develop and run SGX applications. - -First, install some dependencies: - -```bash -sudo apt-get install build-essential ocaml ocamlbuild automake autoconf libtool wget python libssl-dev libcurl4-openssl-dev protobuf-compiler libprotobuf-dev debhelper cmake git -``` - -Then, download, build and install the SGX software stack: - -```bash -BASE_DIR=/opt/intel -[[ -d $BASE_DIR ]] || sudo mkdir -p $BASE_DIR && sudo chown `whoami` $BASE_DIR -cd $BASE_DIR - -git clone https://github.com/intel/linux-sgx.git - -cd linux-sgx -git checkout sgx_2.6 -./download_prebuilt.sh -make -j 6 -make sdk_install_pkg -j 6 -make deb_pkg -j 6 -$BASE_DIR/linux-sgx/linux/installer/bin/sgx_linux_x64_sdk_2.6.100.51363.bin --prefix=$BASE_DIR/ - -sudo dpkg -i $BASE_DIR/linux-sgx/linux/installer/deb/libsgx-urts_2.6.100.51363-bionic1_amd64.deb $BASE_DIR/linux-sgx/linux/installer/deb/libsgx-enclave-common_2.6.100.51363-bionic1_amd64.deb -``` - -Download and install the driver: - -```bash -wget https://download.01.org/intel-sgx/linux-2.6/ubuntu18.04-server/sgx_linux_x64_driver_2.5.0_2605efa.bin -chmod +x sgx_linux_x64_driver_2.5.0_2605efa.bin -sudo ./sgx_linux_x64_driver_2.5.0_2605efa.bin -``` - -### Step 4: Rebooting to finish the installation - -The server needs to reboot before continuing. - -### Step 5: Validating the installation (optional) - -You can use a sample application to validate the installation. Build one of the sample apps provided: - -```bash -BASE_DIR=/opt/intel -cd $BASE_DIR/sgxsdk/SampleCode/LocalAttestation/ -source $BASE_DIR/sgxsdk/environment -make SGX_DEBUG=0 SGX_MODE=HW SGX_PRERELEASE=1 -``` - -Run the app: - -```bash -ovh@nsXXXX:/opt/intel/sgxsdk/SampleCode/LocalAttestation$ ./app - -Available Enclaves -Enclave1 - EnclaveID 2 -Enclave2 - EnclaveID 3 -Enclave3 - EnclaveID 4 - -Secure Channel Establishment between Source (E1) and Destination (E2) Enclaves successful !!! - -Enclave to Enclave Call between Source (E1) and Destination (E2) Enclaves successful !!! - -Message Exchange between Source (E1) and Destination (E2) Enclaves successful !!! - -Secure Channel Establishment between Source (E1) and Destination (E3) Enclaves successful !!! - -Enclave to Enclave Call between Source (E1) and Destination (E3) Enclaves successful !!! - -Message Exchange between Source (E1) and Destination (E3) Enclaves successful !!! - -Secure Channel Establishment between Source (E2) and Destination (E3) Enclaves successful !!! - -Enclave to Enclave Call between Source (E2) and Destination (E3) Enclaves successful !!! - -Message Exchange between Source (E2) and Destination (E3) Enclaves successful !!! - -Secure Channel Establishment between Source (E3) and Destination (E1) Enclaves successful !!! - -Enclave to Enclave Call between Source (E3) and Destination (E1) Enclaves successful !!! - -Message Exchange between Source (E3) and Destination (E1) Enclaves successful !!! - -Close Session between Source (E1) and Destination (E2) Enclaves successful !!! - -Close Session between Source (E1) and Destination (E3) Enclaves successful !!! - -Close Session between Source (E2) and Destination (E3) Enclaves successful !!! - -Close Session between Source (E3) and Destination (E1) Enclaves successful !!! - -Hit a key.... -``` - -## Go further - -To go further (develop your own application, register for remote attestation, etc.), here are some useful resources: - -- [Intel SGX](https://software.intel.com/en-us/sgx) -- [Intel SGX Attestation services](https://software.intel.com/en-us/sgx/attestation-services) -- [Intel SGX linux-2.6 documentation](https://download.01.org/intel-sgx/linux-2.6/docs/) -- [github.com/intel/linux-sgx](https://github.com/intel/linux-sgx) -- [github.com/intel/linux-sgx-driver](https://github.com/intel/linux-sgx-driver) -- [github.com/intel/sgx-ra-sample](https://github.com/intel/sgx-ra-sample) - -Join our [community of users](/links/community). diff --git a/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.en-sg.md b/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.en-sg.md deleted file mode 100644 index 8e7ed26d42c..00000000000 --- a/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.en-sg.md +++ /dev/null @@ -1,219 +0,0 @@ ---- -title: 'Managing Intel SGX on a dedicated server' -excerpt: 'Find out how to enable SGX on your dedicated server and install the Linux SGX software stack' -updated: 2022-08-31 ---- - -## Objective - -Enabling Intel Software Guard Extensions (SGX) on your server allows you to run SGX-ready applications. Intel SGX delivers advanced hardware and RAM security encryption features, in order to isolate parts of code and data that are specific to each application. - -**This guide explains how to enable the SGX feature, in the OVHcloud Control Panel or via the OVHcloud API.** - -## Requirements - -- A dedicated server compatible with the [SGX option](https://www.ovhcloud.com/en-sg/bare-metal/intel-software-guard-extensions/) in your OVHcloud account -- Access to the [OVHcloud Control Panel](/links/manager) or the [OVHcloud API](/links/api) -- Login credentials received via email after the installation -- Ubuntu 18.04 or equivalent installed on the server - -## Instructions - -### From the OVHcloud Control Panel - -Log in to the [OVHcloud Control Panel](/links/manager), go to the `Bare Metal Cloud`{.action} section and then select the server on which you wish to enable SGX from **Dedicated Servers** in the left-hand sidebar. - -#### Enabling the option - -Scroll down to the "Advanced features" box and click on `...`{.action} next to "Security - Intel SGX (Software Guard Extensions)". Select `Enable SGX`{.action} from the drop-down menu. - -![SGX enabling](images/enable_sgx.png){.thumbnail} - -On the following screen, click the `Enable`{.action} button. - -![SGX enabling](images/enable_sgx2.png){.thumbnail} - -You can either choose to enable SGX with a specific amount of reserved memory or enable it by allowing your software to automatically reserve the memory it needs. Once you have made your choice, click `Confirm`{.action}. - -![SGX enabling](images/manage_sgx.png){.thumbnail} - -A confirmation pop-up will appear. Please confirm you have understood that activating Intel SGX technology will make your server reboot. - -![activation SGX](images/confirmation-popup_sgx.png){.thumbnail} - -> [!warning] -> -> This will cause your server to reboot once or several times, depending on your server model. - -#### Disabling the option - -Scroll down to the "Advanced features" box and click on `...`{.action} next to "Security - Intel SGX (Software Guard Extensions)". Select `Modify SGX`{.action} from the drop-down menu. Choose the `Disable`{.action} option and then click `Confirm`{.action}. - -![SGX disabling](images/disable_sgx.png){.thumbnail} - -> [!warning] -> -> This will cause your server to reboot once or several times, depending on your server model. - -Continue with [Step 3](#sgx-softwares) of the instructions below. - -### Using the OVHcloud API - -#### Step 1: Logging in to the API console - -On the [OVHcloud API page](/links/api) click on `Login`{.action} in the top-right corner. On the following page, enter the credentials of your OVHcloud account. - -#### Step 2: Enabling SGX - -Retrieve the name of your server from the list returned from this call: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server - -Verify that your service has the SGX option, by calling: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/biosSettings/sgx - -![SGX disabled](images/get-disabled.png){.thumbnail} - -Enable SGX using the server name: - -> [!warning] -> -> This will cause your server to reboot once or several times, depending on your server model. - -> [!api] -> -> @api {v1} /dedicated/server POST /dedicated/server/{serviceName}/biosSettings/sgx/configure - -![Configure SGX](images/post-configure.png){.thumbnail} - -Check the progress of the configuration task by calling this endpoint with the *taskId* returned by the previous call: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/task/{taskId} - -![Get SGX configuration task](images/get-task.png){.thumbnail} - -You can verify that the status is set to enabled: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/biosSettings/sgx - -![SGX enabled](images/get-enabled.png){.thumbnail} - -### Step 3: Installing the SGX software stack - -Use the following commands to install Intel's driver and SDK to be able to develop and run SGX applications. - -First, install some dependencies: - -```bash -sudo apt-get install build-essential ocaml ocamlbuild automake autoconf libtool wget python libssl-dev libcurl4-openssl-dev protobuf-compiler libprotobuf-dev debhelper cmake git -``` - -Then, download, build and install the SGX software stack: - -```bash -BASE_DIR=/opt/intel -[[ -d $BASE_DIR ]] || sudo mkdir -p $BASE_DIR && sudo chown `whoami` $BASE_DIR -cd $BASE_DIR - -git clone https://github.com/intel/linux-sgx.git - -cd linux-sgx -git checkout sgx_2.6 -./download_prebuilt.sh -make -j 6 -make sdk_install_pkg -j 6 -make deb_pkg -j 6 -$BASE_DIR/linux-sgx/linux/installer/bin/sgx_linux_x64_sdk_2.6.100.51363.bin --prefix=$BASE_DIR/ - -sudo dpkg -i $BASE_DIR/linux-sgx/linux/installer/deb/libsgx-urts_2.6.100.51363-bionic1_amd64.deb $BASE_DIR/linux-sgx/linux/installer/deb/libsgx-enclave-common_2.6.100.51363-bionic1_amd64.deb -``` - -Download and install the driver: - -```bash -wget https://download.01.org/intel-sgx/linux-2.6/ubuntu18.04-server/sgx_linux_x64_driver_2.5.0_2605efa.bin -chmod +x sgx_linux_x64_driver_2.5.0_2605efa.bin -sudo ./sgx_linux_x64_driver_2.5.0_2605efa.bin -``` - -### Step 4: Rebooting to finish the installation - -The server needs to reboot before continuing. - -### Step 5: Validating the installation (optional) - -You can use a sample application to validate the installation. Build one of the sample apps provided: - -```bash -BASE_DIR=/opt/intel -cd $BASE_DIR/sgxsdk/SampleCode/LocalAttestation/ -source $BASE_DIR/sgxsdk/environment -make SGX_DEBUG=0 SGX_MODE=HW SGX_PRERELEASE=1 -``` - -Run the app: - -```bash -ovh@nsXXXX:/opt/intel/sgxsdk/SampleCode/LocalAttestation$ ./app - -Available Enclaves -Enclave1 - EnclaveID 2 -Enclave2 - EnclaveID 3 -Enclave3 - EnclaveID 4 - -Secure Channel Establishment between Source (E1) and Destination (E2) Enclaves successful !!! - -Enclave to Enclave Call between Source (E1) and Destination (E2) Enclaves successful !!! - -Message Exchange between Source (E1) and Destination (E2) Enclaves successful !!! - -Secure Channel Establishment between Source (E1) and Destination (E3) Enclaves successful !!! - -Enclave to Enclave Call between Source (E1) and Destination (E3) Enclaves successful !!! - -Message Exchange between Source (E1) and Destination (E3) Enclaves successful !!! - -Secure Channel Establishment between Source (E2) and Destination (E3) Enclaves successful !!! - -Enclave to Enclave Call between Source (E2) and Destination (E3) Enclaves successful !!! - -Message Exchange between Source (E2) and Destination (E3) Enclaves successful !!! - -Secure Channel Establishment between Source (E3) and Destination (E1) Enclaves successful !!! - -Enclave to Enclave Call between Source (E3) and Destination (E1) Enclaves successful !!! - -Message Exchange between Source (E3) and Destination (E1) Enclaves successful !!! - -Close Session between Source (E1) and Destination (E2) Enclaves successful !!! - -Close Session between Source (E1) and Destination (E3) Enclaves successful !!! - -Close Session between Source (E2) and Destination (E3) Enclaves successful !!! - -Close Session between Source (E3) and Destination (E1) Enclaves successful !!! - -Hit a key.... -``` - -## Go further - -To go further (develop your own application, register for remote attestation, etc.), here are some useful resources: - -- [Intel SGX](https://software.intel.com/en-us/sgx) -- [Intel SGX Attestation services](https://software.intel.com/en-us/sgx/attestation-services) -- [Intel SGX linux-2.6 documentation](https://download.01.org/intel-sgx/linux-2.6/docs/) -- [github.com/intel/linux-sgx](https://github.com/intel/linux-sgx) -- [github.com/intel/linux-sgx-driver](https://github.com/intel/linux-sgx-driver) -- [github.com/intel/sgx-ra-sample](https://github.com/intel/sgx-ra-sample) - -Join our [community of users](/links/community). diff --git a/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.en-us.md b/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.en-us.md deleted file mode 100644 index 8512ffab156..00000000000 --- a/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.en-us.md +++ /dev/null @@ -1,219 +0,0 @@ ---- -title: 'Managing Intel SGX on a dedicated server' -excerpt: 'Find out how to enable SGX on your dedicated server and install the Linux SGX software stack' -updated: 2022-08-31 ---- - -## Objective - -Enabling Intel Software Guard Extensions (SGX) on your server allows you to run SGX-ready applications. Intel SGX delivers advanced hardware and RAM security encryption features, in order to isolate parts of code and data that are specific to each application. - -**This guide explains how to enable the SGX feature, in the OVHcloud Control Panel or via the OVHcloud API.** - -## Requirements - -- A dedicated server compatible with the [SGX option](https://www.ovhcloud.com/en/bare-metal/intel-software-guard-extensions/) in your OVHcloud account -- Access to the [OVHcloud Control Panel](/links/manager) or the [OVHcloud API](/links/api) -- Login credentials received via email after the installation -- Ubuntu 18.04 or equivalent installed on the server - -## Instructions - -### From the OVHcloud Control Panel - -Log in to the [OVHcloud Control Panel](/links/manager), go to the `Bare Metal Cloud`{.action} section and then select the server on which you wish to enable SGX from **Dedicated Servers** in the left-hand sidebar. - -#### Enabling the option - -Scroll down to the "Advanced features" box and click on `...`{.action} next to "Security - Intel SGX (Software Guard Extensions)". Select `Enable SGX`{.action} from the drop-down menu. - -![SGX enabling](images/enable_sgx.png){.thumbnail} - -On the following screen, click the `Enable`{.action} button. - -![SGX enabling](images/enable_sgx2.png){.thumbnail} - -You can either choose to enable SGX with a specific amount of reserved memory or enable it by allowing your software to automatically reserve the memory it needs. Once you have made your choice, click `Confirm`{.action}. - -![SGX enabling](images/manage_sgx.png){.thumbnail} - -A confirmation pop-up will appear. Please confirm you have understood that activating Intel SGX technology will make your server reboot. - -![activation SGX](images/confirmation-popup_sgx.png){.thumbnail} - -> [!warning] -> -> This will cause your server to reboot once or several times, depending on your server model. - -#### Disabling the option - -Scroll down to the "Advanced features" box and click on `...`{.action} next to "Security - Intel SGX (Software Guard Extensions)". Select `Modify SGX`{.action} from the drop-down menu. Choose the `Disable`{.action} option and then click `Confirm`{.action}. - -![SGX disabling](images/disable_sgx.png){.thumbnail} - -> [!warning] -> -> This will cause your server to reboot once or several times, depending on your server model. - -Continue with [Step 3](#sgx-softwares) of the instructions below. - -### Using the OVHcloud API - -#### Step 1: Logging in to the API console - -On the [OVHcloud API page](/links/api) click on `Login`{.action} in the top-right corner. On the following page, enter the credentials of your OVHcloud account. - -#### Step 2: Enabling SGX - -Retrieve the name of your server from the list returned from this call: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server - -Verify that your service has the SGX option, by calling: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/biosSettings/sgx - -![SGX disabled](images/get-disabled.png){.thumbnail} - -Enable SGX using the server name: - -> [!warning] -> -> This will cause your server to reboot once or several times, depending on your server model. - -> [!api] -> -> @api {v1} /dedicated/server POST /dedicated/server/{serviceName}/biosSettings/sgx/configure - -![Configure SGX](images/post-configure.png){.thumbnail} - -Check the progress of the configuration task by calling this endpoint with the *taskId* returned by the previous call: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/task/{taskId} - -![Get SGX configuration task](images/get-task.png){.thumbnail} - -You can verify that the status is set to enabled: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/biosSettings/sgx - -![SGX enabled](images/get-enabled.png){.thumbnail} - -### Step 3: Installing the SGX software stack - -Use the following commands to install Intel's driver and SDK to be able to develop and run SGX applications. - -First, install some dependencies: - -```bash -sudo apt-get install build-essential ocaml ocamlbuild automake autoconf libtool wget python libssl-dev libcurl4-openssl-dev protobuf-compiler libprotobuf-dev debhelper cmake git -``` - -Then, download, build and install the SGX software stack: - -```bash -BASE_DIR=/opt/intel -[[ -d $BASE_DIR ]] || sudo mkdir -p $BASE_DIR && sudo chown `whoami` $BASE_DIR -cd $BASE_DIR - -git clone https://github.com/intel/linux-sgx.git - -cd linux-sgx -git checkout sgx_2.6 -./download_prebuilt.sh -make -j 6 -make sdk_install_pkg -j 6 -make deb_pkg -j 6 -$BASE_DIR/linux-sgx/linux/installer/bin/sgx_linux_x64_sdk_2.6.100.51363.bin --prefix=$BASE_DIR/ - -sudo dpkg -i $BASE_DIR/linux-sgx/linux/installer/deb/libsgx-urts_2.6.100.51363-bionic1_amd64.deb $BASE_DIR/linux-sgx/linux/installer/deb/libsgx-enclave-common_2.6.100.51363-bionic1_amd64.deb -``` - -Download and install the driver: - -```bash -wget https://download.01.org/intel-sgx/linux-2.6/ubuntu18.04-server/sgx_linux_x64_driver_2.5.0_2605efa.bin -chmod +x sgx_linux_x64_driver_2.5.0_2605efa.bin -sudo ./sgx_linux_x64_driver_2.5.0_2605efa.bin -``` - -### Step 4: Rebooting to finish the installation - -The server needs to reboot before continuing. - -### Step 5: Validating the installation (optional) - -You can use a sample application to validate the installation. Build one of the sample apps provided: - -```bash -BASE_DIR=/opt/intel -cd $BASE_DIR/sgxsdk/SampleCode/LocalAttestation/ -source $BASE_DIR/sgxsdk/environment -make SGX_DEBUG=0 SGX_MODE=HW SGX_PRERELEASE=1 -``` - -Run the app: - -```bash -ovh@nsXXXX:/opt/intel/sgxsdk/SampleCode/LocalAttestation$ ./app - -Available Enclaves -Enclave1 - EnclaveID 2 -Enclave2 - EnclaveID 3 -Enclave3 - EnclaveID 4 - -Secure Channel Establishment between Source (E1) and Destination (E2) Enclaves successful !!! - -Enclave to Enclave Call between Source (E1) and Destination (E2) Enclaves successful !!! - -Message Exchange between Source (E1) and Destination (E2) Enclaves successful !!! - -Secure Channel Establishment between Source (E1) and Destination (E3) Enclaves successful !!! - -Enclave to Enclave Call between Source (E1) and Destination (E3) Enclaves successful !!! - -Message Exchange between Source (E1) and Destination (E3) Enclaves successful !!! - -Secure Channel Establishment between Source (E2) and Destination (E3) Enclaves successful !!! - -Enclave to Enclave Call between Source (E2) and Destination (E3) Enclaves successful !!! - -Message Exchange between Source (E2) and Destination (E3) Enclaves successful !!! - -Secure Channel Establishment between Source (E3) and Destination (E1) Enclaves successful !!! - -Enclave to Enclave Call between Source (E3) and Destination (E1) Enclaves successful !!! - -Message Exchange between Source (E3) and Destination (E1) Enclaves successful !!! - -Close Session between Source (E1) and Destination (E2) Enclaves successful !!! - -Close Session between Source (E1) and Destination (E3) Enclaves successful !!! - -Close Session between Source (E2) and Destination (E3) Enclaves successful !!! - -Close Session between Source (E3) and Destination (E1) Enclaves successful !!! - -Hit a key.... -``` - -## Go further - -To go further (develop your own application, register for remote attestation, etc.), here are some useful resources: - -- [Intel SGX](https://software.intel.com/en-us/sgx) -- [Intel SGX Attestation services](https://software.intel.com/en-us/sgx/attestation-services) -- [Intel SGX linux-2.6 documentation](https://download.01.org/intel-sgx/linux-2.6/docs/) -- [github.com/intel/linux-sgx](https://github.com/intel/linux-sgx) -- [github.com/intel/linux-sgx-driver](https://github.com/intel/linux-sgx-driver) -- [github.com/intel/sgx-ra-sample](https://github.com/intel/sgx-ra-sample) - -Join our [community of users](/links/community). diff --git a/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.es-es.md b/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.es-es.md index ae19a3c6484..ec2fb38bee5 100644 --- a/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.es-es.md +++ b/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.es-es.md @@ -1,219 +1,240 @@ --- -title: 'Intel SGX en un servidor dedicado' -excerpt: 'Active la funcionalidad SGX en su servidor Infrastructure o Advance e instale la pila de software SGX para linux' -updated: 2022-08-31 +title: "Cómo gestionar Intel SGX en un servidor dedicado" +excerpt: "Descubra cómo activar la opción SGX en su servidor dedicado e instalar la pila de software SGX para Linux" +updated: 2025-11-20 --- -> [!primary] -> Esta traducción ha sido generada de forma automática por nuestro partner SYSTRAN. En algunos casos puede contener términos imprecisos, como en las etiquetas de los botones o los detalles técnicos. En caso de duda, le recomendamos que consulte la versión inglesa o francesa de la guía. Si quiere ayudarnos a mejorar esta traducción, por favor, utilice el botón «Contribuir» de esta página. -> - ## Objetivo -Active Intel Software Guard Extensions en su servidor para poder ejecutar las aplicaciones SGX-ready. -La tecnología Intel SGX proporciona funciones avanzadas de seguridad mediante el cifrado por hardware de la memoria, que permite aislar fragmentos de código y datos específicos de una aplicación. +La activación de las Intel Software Guard Extensions (SGX) en su servidor le permite ejecutar aplicaciones compatibles con SGX. Intel SGX proporciona funciones avanzadas de cifrado de seguridad de hardware y memoria RAM, para aislar partes específicas del código y los datos para cada aplicación. + +**Este guía explica cómo activar la función SGX, a través del área de cliente de OVHcloud o a través de la API de OVHcloud.** ## Requisitos -- Tener un servidor dedicado compatible con la opción [SGX](https://www.ovhcloud.com/es-es/bare-metal/intel-software-guard-extensions/) -- Disponer de las claves de conexión recibidas por correo electrónico tras la instalación - Tener acceso al [área de cliente de OVHcloud](/links/manager) o a la [API de OVHcloud](/links/api) -- Tener instalado Ubuntu 18.04 o similar en el servidor +- Tener un servidor dedicado compatible con la [opción SGX](/links/bare-metal/sgx) en su cuenta de OVHcloud +- Disponer de las credenciales recibidas por correo electrónico tras la instalación +- Tener instalado Ubuntu 24.04 o equivalente en el servidor ## Procedimiento -### Desde el área de cliente de OVHcloud - -Conéctese al [área de cliente de OVHcloud](/links/manager), acceda a la sección `Bare Metal Cloud`{.action} y seleccione el servidor al que quiere activar SGX en la sección **Servidores dedicados** del menú de la izquierda. - -#### Activación de la opción - -Descienda hasta la zona `Funcionalidades avanzadas` y haga clic en `...`{.action} en frente de "Seguridad - Intel SGX (Software Guard Extensions)". Seleccione `Activar SGX`{.action} en el menú desplegable. - -![activación SGX](images/enable_sgx.png){.thumbnail} - -En la siguiente pantalla, haga clic en el botón `Activar`{.action}. - -![activación SGX](images/enable_sgx2.png){.thumbnail} - -Puede activar o activar SGX con una cantidad específica de memoria reservada, permitiendo a su software guardar automáticamente la memoria que necesite. Una vez que haya elegido, haga clic en `Confirmar`{.action}. - -![activación SGX](images/manage_sgx.png){.thumbnail} - -Se mostrará una ventana de confirmación confirmando que, para activar la tecnología Intel SGX, es necesario reiniciar el servidor. - -![activación SGX](images/confirmation-popup_sgx.png){.thumbnail} - -> [!warning] -> -> En función del servidor, esta acción se reiniciará de 1 a más. - -#### Desactivación de la opción - -Descienda hasta la zona `Funcionalidades avanzadas` y haga clic en `...`{.action} en frente de "Seguridad - Intel SGX (Software Guard Extensions)". Seleccione `Editar SGX`{.action} en el menú desplegable. Seleccione la opción `Desactivar`{.action} y haga clic en `Confirmar`{.action}. - -![Desactivación de SGX](images/disable_sgx.png){.thumbnail} - -> [!warning] -> -> En función del servidor, esta acción se reiniciará de 1 a más. - -Siga leyendo esta guía en [el paso 3](#sgx-softwares). - -### Desde la API de OVHcloud - -#### Paso 1: acceder a la API - -Acceda a y, a continuación, haga clic en el botón `Login`{.action} situado en la esquina superior derecha de la página. -Identifíquese con los datos de acceso de su cuenta de OVHcloud en la página siguiente. - -#### Paso 2: Activar SGX - -Obtenga el nombre de su servidor de la lista que devuelve la siguiente llamada: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server - -Compruebe que su servicio tiene la opción SGX con la siguiente llamada: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/biosSettings/sgx - -![SGX disabled](images/get-disabled.png){.thumbnail} - -A continuación, active la opción SGX: - -> [!warning] -> -> En función del servidor, esta acción se reiniciará de 1 a más. - -> [!api] -> -> @api {v1} /dedicated/server POST /dedicated/server/{serviceName}/biosSettings/sgx/configure - -![Configure SGX](images/post-configure.png){.thumbnail} - -Compruebe el progreso de la tarea de configuración llamando al siguiente endpoint con el taskId devuelto en la llamada anterior: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/task/{taskId} - -![Get SGX configuration task](images/get-task.png){.thumbnail} - -Puede comprobar que el estado ahora es «Activo»: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/biosSettings/sgx - -![SGX enabled](images/get-enabled.png){.thumbnail} - -#### Paso 3: Instalar la pila de software SGX - -Ahora instalaremos el driver de Intel y SDK para poder desarrollar y ejecutar aplicaciones SGX. - -Primero, instalaremos algunas dependencias: +### Activar SGX + +La activación de SGX es posible desde el área de cliente de OVHcloud, la API de OVHcloud o el BIOS de su servidor. + +> [!tabs] +> **A través del área de cliente de OVHcloud** +>> +>> **1 - Conexión al área de cliente de OVHcloud** +>> +>> Inicie sesión en el [área de cliente de OVHcloud](/links/manager), vaya a la sección `Bare Metal Cloud`{.action} y haga clic en `Servidores dedicados`{.action}. Seleccione a continuación el servidor en el que desea activar SGX. +>> +>> **2 - Activar SGX** +>> +>> Desde la pestaña `Información general`{.action}, en el marco **Funcionalidades avanzadas**, haga clic en `...`{.action} junto a la mención **Seguridad - Intel SGX (Software Guard Extensions)** y seleccione `Activar SGX`{.action} en el menú desplegable. +>> +>> ![Activación SGX](images/enable_sgx.png){.thumbnail} +>> +>> En la pantalla siguiente, haga clic en el botón `Activar`{.action}. +>> +>> ![Activación SGX](images/enable_sgx2.png){.thumbnail} +>> +>> Puede elegir activar SGX con una cantidad específica de memoria reservada o permitiendo que su aplicación reserve automáticamente la memoria que necesita. Una vez realizado su elección, haga clic en `Confirmar`{.action}. +>> +>> ![Gestión SGX](images/manage_sgx.png){.thumbnail} +>> +>> Aparecerá una ventana de confirmación. Confirme que ha entendido que la activación de la tecnología Intel SGX provocará un reinicio de su servidor. +>> +>> ![Activación SGX](images/confirmation-popup_sgx.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Esto provocará uno o varios reinicios de su servidor, según su modelo. +>> +> **A través de la API de OVHcloud** +>> +>> **1 - Conexión a la consola API** +>> +>> En la página de las [API de OVHcloud](/links/console): +>> +>> - Haga clic en `Authentication`{.action} en la esquina superior izquierda. +>> - Haga clic a continuación en `Login with OVHcloud SSO`{.action}. +>> - Introduzca sus credenciales de OVHcloud. +>> - Haga clic en el botón `Authorize`{.action} para autorizar las llamadas a las API desde este sitio. +>> +>> **2 - Activar SGX** +>> +>> Recupere el nombre de su servidor en la lista devuelta por la llamada siguiente: +>> +>> > [!api] +>> > +>> > @api {v1} /dedicated/server GET /dedicated/server +>> +>> Compruebe que su servicio dispone de la opción SGX utilizando esta llamada: +>> +>> > [!api] +>> > +>> > @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/biosSettings/sgx +>> +>> ![SGX desactivado](images/get-disabled.png){.thumbnail} +>> +>> Active SGX utilizando el nombre del servidor: +>> +>> > [!warning] +>> > +>> > Esto provocará uno o varios reinicios de su servidor, según su modelo. +>> +>> > [!api] +>> > +>> > @api {v1} /dedicated/server POST /dedicated/server/{serviceName}/biosSettings/sgx/configure +>> +>> ![Configuración SGX](images/post-configure.png){.thumbnail} +>> +>> Compruebe el progreso de la tarea de configuración llamando a este punto de finalización con el *taskId* devuelto por la llamada anterior: +>> +>> > [!api] +>> > +>> > @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/task/{taskId} +>> +>> ![Obtener la tarea de configuración SGX](images/get-task.png){.thumbnail} +>> +>> Puede comprobar que el estado está activado: +>> +>> > [!api] +>> > +>> > @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/biosSettings/sgx +>> +>> ![SGX activado](images/get-enabled.png){.thumbnail} +>> +> **Configuración manual en el BIOS** +>> +>> **1 - Iniciar una sesión Remote KVM** +>> +>> Inicie sesión en el [área de cliente de OVHcloud](/links/manager), vaya a la sección `Bare Metal Cloud`{.action} y haga clic en `Servidores dedicados`{.action}. Seleccione a continuación el servidor en el que desea activar SGX. +>> +>> Desde la pestaña `IPMI / KMV`{.action}, inicie una sesión Remote KVM: +>> +>> ![Iniciar una sesión Remote KVM](images/manager.png){.thumbnail} +>> +>> **2 - Activar SGX** +>> +>> A continuación, desde el KVM, inicie un reinicio del servidor y entre en el BIOS (normalmente pulsando la tecla `DEL`{.action} o `F2`{.action}). +>> +>> En el BIOS, vaya a la parte `Advanced` > `Processor Configuration`. +>> +>> Active las opciones TME y SGX y configure el tamaño PRMRR deseado: +>> +>> ![Activar SGX](images/sgx_bios.png){.thumbnail} +>> +>> Guarde los cambios pulsando la tecla `F10`{.action}. Aparecerá una ventana de confirmación, confirme con la opción `Yes`. +>> +>> Su servidor reiniciará a continuación en su sistema operativo. +>> + +### Instalar la pila de software SGX + +Utilice los siguientes comandos para instalar el SDK de Intel para poder desarrollar y ejecutar aplicaciones SGX. + +En primer lugar, instale algunas dependencias: ```bash -sudo apt-get install build-essential ocaml ocamlbuild automake autoconf libtool wget python libssl-dev libcurl4-openssl-dev protobuf-compiler libprotobuf-dev debhelper cmake git +sudo apt update +sudo apt install autoconf automake build-Essential cmake debhelper git libcurl4-openssl-dev libprotobuf-dev libssl-dev libtool lsb-release ocaml ocamlbuild protobuf-compiler python-is-python3 reprepro wget perl unzip pkgconf libboost-dev libboost-system-dev libboost-thread-dev libsystemd0 ``` -Después, descargue, cree e instale la pila de software SGX: +A continuación, descargue el código fuente y prepare los submódulos y los binarios listos para usar: ```bash BASE_DIR=/opt/intel [[ -d $BASE_DIR ]] || sudo mkdir -p $BASE_DIR && sudo chown `whoami` $BASE_DIR cd $BASE_DIR - + git clone https://github.com/intel/linux-sgx.git - + cd linux-sgx -git checkout sgx_2.6 -./download_prebuilt.sh -make -j 6 -make sdk_install_pkg -j 6 -make deb_pkg -j 6 -$BASE_DIR/linux-sgx/linux/installer/bin/sgx_linux_x64_sdk_2.6.100.51363.bin --prefix=$BASE_DIR/ - -sudo dpkg -i $BASE_DIR/linux-sgx/linux/installer/deb/libsgx-urts_2.6.100.51363-bionic1_amd64.deb $BASE_DIR/linux-sgx/linux/installer/deb/libsgx-enclave-common_2.6.100.51363-bionic1_amd64.deb +git checkout sgx_2.26 +make preparation ``` -Descargue e instale el driver: +Construya e instale el SDK SGX: ```bash -wget https://download.01.org/intel-sgx/linux-2.6/ubuntu18.04-server/sgx_linux_x64_driver_2.5.0_2605efa.bin -chmod +x sgx_linux_x64_driver_2.5.0_2605efa.bin -sudo ./sgx_linux_x64_driver_2.5.0_2605efa.bin +make sdk_install_pkg +$ ./linux/installer/bin/sgx_linux_x64_sdk_2.26.100.0.bin --prefix=$BASE_DIR/ ``` -#### Paso 4: Reinicie para terminar la instalación - -#### Paso 5: Utilice una plantilla de aplicación para validar la instalación +### Probar la aplicación de ejemplo en modo simulador -Cree una aplicación con una de las plantillas proporcionadas: +Para construir y ejecutar el código de ejemplo *LocalAttestation* en modo simulador: ```bash BASE_DIR=/opt/intel cd $BASE_DIR/sgxsdk/SampleCode/LocalAttestation/ source $BASE_DIR/sgxsdk/environment -make SGX_DEBUG=0 SGX_MODE=HW SGX_PRERELEASE=1 + +make clean +SGX_MODE=SIM make +cd bin +./app +succeed to load enclaves. +succeed to establish secure channel. +Succeed to exchange secure message... +Succeed to close Session... ``` -Ejecútela: - -```bash -ovh@nsXXXX:/opt/intel/sgxsdk/SampleCode/LocalAttestation$ ./app - -Available Enclaves -Enclave1 - EnclaveID 2 -Enclave2 - EnclaveID 3 -Enclave3 - EnclaveID 4 - -Secure Channel Establishment between Source (E1) and Destination (E2) Enclaves successful !!! - -Enclave to Enclave Call between Source (E1) and Destination (E2) Enclaves successful !!! - -Message Exchange between Source (E1) and Destination (E2) Enclaves successful !!! +### Construir e instalar el PSW Intel SGX -Secure Channel Establishment between Source (E1) and Destination (E3) Enclaves successful !!! +El software Intel SGX Platform Software (PSW) proporciona bibliotecas de software que permiten ejecutar aplicaciones SGX en modo hardware. Para crear el repositorio local Debian que aloje los paquetes, ejecute los siguientes comandos: -Enclave to Enclave Call between Source (E1) and Destination (E3) Enclaves successful !!! - -Message Exchange between Source (E1) and Destination (E3) Enclaves successful !!! - -Secure Channel Establishment between Source (E2) and Destination (E3) Enclaves successful !!! - -Enclave to Enclave Call between Source (E2) and Destination (E3) Enclaves successful !!! - -Message Exchange between Source (E2) and Destination (E3) Enclaves successful !!! - -Secure Channel Establishment between Source (E3) and Destination (E1) Enclaves successful !!! +```bash +BASE_DIR=/opt/intel +cd $BASE_DIR/linux-sgx +make deb_local_repo +``` -Enclave to Enclave Call between Source (E3) and Destination (E1) Enclaves successful !!! +Cree el siguiente archivo para añadir el repositorio local de paquetes Debian al sistema de configuración de repositorios: -Message Exchange between Source (E3) and Destination (E1) Enclaves successful !!! +```bash +$ cat /etc/apt/sources.list.d/sgx.sources +Types: deb +URIs: file:/opt/intel/linux-sgx/linux/installer/deb/sgx_debian_local_repo +Suites: noble +Components: main +trusted: yes +``` -Close Session between Source (E1) and Destination (E2) Enclaves successful !!! +A continuación, instale los siguientes paquetes: -Close Session between Source (E1) and Destination (E3) Enclaves successful !!! +```bash +sudo apt update +sudo apt-get install libsgx-epid libsgx-quote-ex libsgx-dcap-ql +``` -Close Session between Source (E2) and Destination (E3) Enclaves successful !!! +### Probar la aplicación de ejemplo en modo hardware (opcional) -Close Session between Source (E3) and Destination (E1) Enclaves successful !!! +Para construir y ejecutar el código de ejemplo *LocalAttestation* en modo hardware: -Hit a key.... +```bash +BASE_DIR=/opt/intel +cd $BASE_DIR/sgxsdk/SampleCode/LocalAttestation/ +source $BASE_DIR/sgxsdk/environment + +make clean +SGX_MODE=HW make +cd bin +./app +succeed to load enclaves. +succeed to establish secure channel. +Succeed to exchange secure message... +Succeed to close Session... ``` ## Más información -Si desea seguir avanzando (desarrollar su propia aplicación, obtener una certificación a distancia, etc), aquí tiene algunos recursos que pueden resultarle útiles: +Para ir más lejos (desarrollar su propia aplicación, registrarse en la atestación remota, etc.), aquí hay algunas fuentes útiles: - [Intel SGX](https://software.intel.com/en-us/sgx) - [Intel SGX Attestation services](https://software.intel.com/en-us/sgx/attestation-services) -- [Intel SGX linux-2.6 documentation](https://download.01.org/intel-sgx/linux-2.6/docs/) -- [github.com/intel/linux-sgx](https://github.com/intel/linux-sgx) -- [github.com/intel/linux-sgx-driver](https://github.com/intel/linux-sgx-driver) -- [github.com/intel/sgx-ra-sample](https://github.com/intel/sgx-ra-sample) +- [Intel SGX linux-2.26 documentation](https://download.01.org/intel-sgx/sgx-linux/2.26/docs/) +- [github.com/intel/linux-sgx](https://github.com/intel/linux-sgx) \ No newline at end of file diff --git a/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.es-us.md b/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.es-us.md deleted file mode 100644 index 0e1078ce326..00000000000 --- a/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.es-us.md +++ /dev/null @@ -1,219 +0,0 @@ ---- -title: 'Intel SGX en un servidor dedicado' -excerpt: 'Active la funcionalidad SGX en su servidor Infrastructure o Advance e instale la pila de software SGX para linux' -updated: 2022-08-31 ---- - -> [!primary] -> Esta traducción ha sido generada de forma automática por nuestro partner SYSTRAN. En algunos casos puede contener términos imprecisos, como en las etiquetas de los botones o los detalles técnicos. En caso de duda, le recomendamos que consulte la versión inglesa o francesa de la guía. Si quiere ayudarnos a mejorar esta traducción, por favor, utilice el botón «Contribuir» de esta página. -> - -## Objetivo - -Active Intel Software Guard Extensions en su servidor para poder ejecutar las aplicaciones SGX-ready. -La tecnología Intel SGX proporciona funciones avanzadas de seguridad mediante el cifrado por hardware de la memoria, que permite aislar fragmentos de código y datos específicos de una aplicación. - -## Requisitos - -- Tener un servidor dedicado compatible con la opción [SGX](https://www.ovhcloud.com/es/bare-metal/intel-software-guard-extensions/) -- Disponer de las claves de conexión recibidas por correo electrónico tras la instalación -- Tener acceso al [área de cliente de OVHcloud](/links/manager) o a la [API de OVHcloud](/links/api) -- Tener instalado Ubuntu 18.04 o similar en el servidor - -## Procedimiento - -### Desde el área de cliente de OVHcloud - -Conéctese al [área de cliente de OVHcloud](/links/manager), acceda a la sección `Bare Metal Cloud`{.action} y seleccione el servidor al que quiere activar SGX en la sección **Servidores dedicados** del menú de la izquierda. - -#### Activación de la opción - -Descienda hasta la zona `Funcionalidades avanzadas` y haga clic en `...`{.action} en frente de "Seguridad - Intel SGX (Software Guard Extensions)". Seleccione `Activar SGX`{.action} en el menú desplegable. - -![activación SGX](images/enable_sgx.png){.thumbnail} - -En la siguiente pantalla, haga clic en el botón `Activar`{.action}. - -![activación SGX](images/enable_sgx2.png){.thumbnail} - -Puede activar o activar SGX con una cantidad específica de memoria reservada, permitiendo a su software guardar automáticamente la memoria que necesite. Una vez que haya elegido, haga clic en `Confirmar`{.action}. - -![activación SGX](images/manage_sgx.png){.thumbnail} - -Se mostrará una ventana de confirmación confirmando que, para activar la tecnología Intel SGX, es necesario reiniciar el servidor. - -![activación SGX](images/confirmation-popup_sgx.png){.thumbnail} - -> [!warning] -> -> En función del servidor, esta acción se reiniciará de 1 a más. - -#### Desactivación de la opción - -Descienda hasta la zona `Funcionalidades avanzadas` y haga clic en `...`{.action} en frente de "Seguridad - Intel SGX (Software Guard Extensions)". Seleccione `Editar SGX`{.action} en el menú desplegable. Seleccione la opción `Desactivar`{.action} y haga clic en `Confirmar`{.action}. - -![Desactivación de SGX](images/disable_sgx.png){.thumbnail} - -> [!warning] -> -> En función del servidor, esta acción se reiniciará de 1 a más. - -Siga leyendo esta guía en [el paso 3](#sgx-softwares). - -### Desde la API de OVHcloud - -#### Paso 1: acceder a la API - -Acceda a y, a continuación, haga clic en el botón `Login`{.action} situado en la esquina superior derecha de la página. -Identifíquese con los datos de acceso de su cuenta de OVHcloud en la página siguiente. - -#### Paso 2: Activar SGX - -Obtenga el nombre de su servidor de la lista que devuelve la siguiente llamada: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server - -Compruebe que su servicio tiene la opción SGX con la siguiente llamada: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/biosSettings/sgx - -![SGX disabled](images/get-disabled.png){.thumbnail} - -A continuación, active la opción SGX: - -> [!warning] -> -> En función del servidor, esta acción se reiniciará de 1 a más. - -> [!api] -> -> @api {v1} /dedicated/server POST /dedicated/server/{serviceName}/biosSettings/sgx/configure - -![Configure SGX](images/post-configure.png){.thumbnail} - -Compruebe el progreso de la tarea de configuración llamando al siguiente endpoint con el taskId devuelto en la llamada anterior: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/task/{taskId} - -![Get SGX configuration task](images/get-task.png){.thumbnail} - -Puede comprobar que el estado ahora es «Activo»: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/biosSettings/sgx - -![SGX enabled](images/get-enabled.png){.thumbnail} - -#### Paso 3: Instalar la pila de software SGX - -Ahora instalaremos el driver de Intel y SDK para poder desarrollar y ejecutar aplicaciones SGX. - -Primero, instalaremos algunas dependencias: - -```bash -sudo apt-get install build-essential ocaml ocamlbuild automake autoconf libtool wget python libssl-dev libcurl4-openssl-dev protobuf-compiler libprotobuf-dev debhelper cmake git -``` - -Después, descargue, cree e instale la pila de software SGX: - -```bash -BASE_DIR=/opt/intel -[[ -d $BASE_DIR ]] || sudo mkdir -p $BASE_DIR && sudo chown `whoami` $BASE_DIR -cd $BASE_DIR - -git clone https://github.com/intel/linux-sgx.git - -cd linux-sgx -git checkout sgx_2.6 -./download_prebuilt.sh -make -j 6 -make sdk_install_pkg -j 6 -make deb_pkg -j 6 -$BASE_DIR/linux-sgx/linux/installer/bin/sgx_linux_x64_sdk_2.6.100.51363.bin --prefix=$BASE_DIR/ - -sudo dpkg -i $BASE_DIR/linux-sgx/linux/installer/deb/libsgx-urts_2.6.100.51363-bionic1_amd64.deb $BASE_DIR/linux-sgx/linux/installer/deb/libsgx-enclave-common_2.6.100.51363-bionic1_amd64.deb -``` - -Descargue e instale el driver: - -```bash -wget https://download.01.org/intel-sgx/linux-2.6/ubuntu18.04-server/sgx_linux_x64_driver_2.5.0_2605efa.bin -chmod +x sgx_linux_x64_driver_2.5.0_2605efa.bin -sudo ./sgx_linux_x64_driver_2.5.0_2605efa.bin -``` - -#### Paso 4: Reinicie para terminar la instalación - -#### Paso 5: Utilice una plantilla de aplicación para validar la instalación - -Cree una aplicación con una de las plantillas proporcionadas: - -```bash -BASE_DIR=/opt/intel -cd $BASE_DIR/sgxsdk/SampleCode/LocalAttestation/ -source $BASE_DIR/sgxsdk/environment -make SGX_DEBUG=0 SGX_MODE=HW SGX_PRERELEASE=1 -``` - -Ejecútela: - -```bash -ovh@nsXXXX:/opt/intel/sgxsdk/SampleCode/LocalAttestation$ ./app - -Available Enclaves -Enclave1 - EnclaveID 2 -Enclave2 - EnclaveID 3 -Enclave3 - EnclaveID 4 - -Secure Channel Establishment between Source (E1) and Destination (E2) Enclaves successful !!! - -Enclave to Enclave Call between Source (E1) and Destination (E2) Enclaves successful !!! - -Message Exchange between Source (E1) and Destination (E2) Enclaves successful !!! - -Secure Channel Establishment between Source (E1) and Destination (E3) Enclaves successful !!! - -Enclave to Enclave Call between Source (E1) and Destination (E3) Enclaves successful !!! - -Message Exchange between Source (E1) and Destination (E3) Enclaves successful !!! - -Secure Channel Establishment between Source (E2) and Destination (E3) Enclaves successful !!! - -Enclave to Enclave Call between Source (E2) and Destination (E3) Enclaves successful !!! - -Message Exchange between Source (E2) and Destination (E3) Enclaves successful !!! - -Secure Channel Establishment between Source (E3) and Destination (E1) Enclaves successful !!! - -Enclave to Enclave Call between Source (E3) and Destination (E1) Enclaves successful !!! - -Message Exchange between Source (E3) and Destination (E1) Enclaves successful !!! - -Close Session between Source (E1) and Destination (E2) Enclaves successful !!! - -Close Session between Source (E1) and Destination (E3) Enclaves successful !!! - -Close Session between Source (E2) and Destination (E3) Enclaves successful !!! - -Close Session between Source (E3) and Destination (E1) Enclaves successful !!! - -Hit a key.... -``` - -## Más información - -Si desea seguir avanzando (desarrollar su propia aplicación, obtener una certificación a distancia, etc), aquí tiene algunos recursos que pueden resultarle útiles: - -- [Intel SGX](https://software.intel.com/en-us/sgx) -- [Intel SGX Attestation services](https://software.intel.com/en-us/sgx/attestation-services) -- [Intel SGX linux-2.6 documentation](https://download.01.org/intel-sgx/linux-2.6/docs/) -- [github.com/intel/linux-sgx](https://github.com/intel/linux-sgx) -- [github.com/intel/linux-sgx-driver](https://github.com/intel/linux-sgx-driver) -- [github.com/intel/sgx-ra-sample](https://github.com/intel/sgx-ra-sample) diff --git a/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.fr-ca.md b/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.fr-ca.md deleted file mode 100644 index f843ad6575f..00000000000 --- a/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.fr-ca.md +++ /dev/null @@ -1,215 +0,0 @@ ---- -title: 'Activer Intel SGX sur votre serveur dédié' -excerpt: 'Activez l’option SGX sur votre serveur Infrastructure ou Advance et installez la pile de logiciels SGX pour Linux' -updated: 2022-08-31 ---- - -## Objectif - -Activez Intel Software Guard Extensions sur votre serveur, pour pouvoir exécuter les applications SGX-ready. -La technologie Intel SGX fournit des fonctions de sécurité avancées de chiffrement matériel de la mémoire. Cela permet d’isoler des parties de code et des données spécifiques d'une application. - -## Prérequis - -- Avoir un serveur dédié compatible avec l’option [SGX](https://www.ovhcloud.com/fr-ca/bare-metal/intel-software-guard-extensions/) -- Disposer des identifiants de connexion reçus par e-mail suite à l'installation -- Avoir accès à l'[espace client OVHcloud](/links/manager) ou l’[API OVHcloud](/links/api) -- Ubuntu 18.04 ou équivalent installé sur le serveur - -## En pratique - -### Depuis l'espace client OVHcloud - -Connectez-vous à l'[espace client OVHcloud](/links/manager), accédez à la section `Bare Metal Cloud`{.action}, puis sélectionnez le serveur sur lequel vous souhaitez activer SGX dans la section **Serveurs dédiés** du menu de gauche. - -#### Activation de l'option - -Descendez jusqu'à la zone `Fonctionnalités avancées` et cliquez sur `...`{.action} en face de « Sécurité - Intel SGX (Software Guard Extensions) ». Sélectionnez `Activer SGX`{.action} dans le menu déroulant. - -![activation SGX](images/enable_sgx.png){.thumbnail} - -Sur l'écran suivant, cliquez sur le bouton `Activer`{.action}. - -![activation SGX](images/enable_sgx2.png){.thumbnail} - -Vous pouvez choisir d'activer SGX avec une quantité spécifique de mémoire réservée ou de l'activer en permettant à votre logiciel de réserver automatiquement la mémoire dont il a besoin. Une fois que vous avez fait votre choix, cliquez sur `Confirmer`{.action}. - -![activation SGX](images/manage_sgx.png){.thumbnail} - -Une pop-up de confirmation apparaît, confirmez alors que vous avez bien pris connaissance que l'activation de la technologie Intel SGX nécessite le(s) redémarrage(s) de votre serveur. - -![activation SGX](images/confirmation-popup_sgx.png){.thumbnail} - -> [!warning] -> -> En fonction du serveur, cette action entraînera 1 à plusieurs redémarrages de celui-ci. - -#### Désactivation de l'option - -Descendez jusqu'à la zone `Fonctionnalités avancées` et cliquez sur `...`{.action} en face de « Sécurité - Intel SGX (Software Guard Extensions) ». Sélectionnez `Modifier SGX`{.action} dans le menu déroulant. Choisissez l'option `Désactiver`{.action}, puis cliquez sur `Confirmer`{.action}. - -![Désactivation de SGX](images/disable_sgx.png){.thumbnail} - -> [!warning] -> -> En fonction du serveur, cette action entraînera 1 à plusieurs redémarrages de celui-ci. - -Continuez la lecture de ce guide à [l'étape 3](#sgx-softwares) ci-dessous. - -### Depuis l'API OVHcloud - -#### Étape 1 : Se connecter à l’API - -Allez sur et cliquez sur `Login`{.action} dans le coin supérieur droit de la page. -Sur la page suivante, connectez-vous avec les identifiants de votre compte OVHcloud. - -#### Étape 2 : Activer SGX - -Obtenez le nom de votre serveur de la liste renvoyée par cet appel : - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server - -Vérifiez que votre service dispose de l’option SGX, avec l’appel suivant : - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/biosSettings/sgx - -![SGX disabled](images/get-disabled.png){.thumbnail} - -Maintenant, activez SGX. - -> [!warning] -> -> En fonction du serveur, cette action entraînera 1 à plusieurs redémarrages de celui-ci. - -> [!api] -> -> @api {v1} /dedicated/server POST /dedicated/server/{serviceName}/biosSettings/sgx/configure - -![Configure SGX](images/post-configure.png){.thumbnail} - -Vérifiez le progrès de la tâche de configuration en appelant cet endpoint avec le taskId renvoyé par l’appel précédent : - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/task/{taskId} - -![Get SGX configuration task](images/get-task.png){.thumbnail} - -Vous pouvez vérifier que l’état est maintenant «activé» : - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/biosSettings/sgx - -![SGX enabled](images/get-enabled.png){.thumbnail} - -#### Étape 3 : Installer la pile de logiciels SGX - -Il faut maintenant installer le driver Intel et SDK pour pouvoir développer et exécuter des applications SGX. - -En premier lieu, il faut installer quelques dépendances : - -```bash -sudo apt-get install build-essential ocaml ocamlbuild automake autoconf libtool wget python libssl-dev libcurl4-openssl-dev protobuf-compiler libprotobuf-dev debhelper cmake git -``` - -Ensuite, téléchargez, créez et installez la pile logicielle SGX : - -```bash -BASE_DIR=/opt/intel -[[ -d $BASE_DIR ]] || sudo mkdir -p $BASE_DIR && sudo chown `whoami` $BASE_DIR -cd $BASE_DIR - -git clone https://github.com/intel/linux-sgx.git - -cd linux-sgx -git checkout sgx_2.6 -./download_prebuilt.sh -make -j 6 -make sdk_install_pkg -j 6 -make deb_pkg -j 6 -$BASE_DIR/linux-sgx/linux/installer/bin/sgx_linux_x64_sdk_2.6.100.51363.bin --prefix=$BASE_DIR/ - -sudo dpkg -i $BASE_DIR/linux-sgx/linux/installer/deb/libsgx-urts_2.6.100.51363-bionic1_amd64.deb $BASE_DIR/linux-sgx/linux/installer/deb/libsgx-enclave-common_2.6.100.51363-bionic1_amd64.deb -``` - -Téléchargez et installez le driver : - -```bash -wget https://download.01.org/intel-sgx/linux-2.6/ubuntu18.04-server/sgx_linux_x64_driver_2.5.0_2605efa.bin -chmod +x sgx_linux_x64_driver_2.5.0_2605efa.bin -sudo ./sgx_linux_x64_driver_2.5.0_2605efa.bin -``` - -#### Étape 4 : Redémarrer pour finir l’installation - -#### Étape 5 : Utiliser un modèle d’application pour valider l’installation - -Créez une application avec un des modèles fournis : - -```bash -BASE_DIR=/opt/intel -cd $BASE_DIR/sgxsdk/SampleCode/LocalAttestation/ -source $BASE_DIR/sgxsdk/environment -make SGX_DEBUG=0 SGX_MODE=HW SGX_PRERELEASE=1 -``` - -Exécutez-la : - -```bash -ovh@nsXXXX:/opt/intel/sgxsdk/SampleCode/LocalAttestation$ ./app - -Available Enclaves -Enclave1 - EnclaveID 2 -Enclave2 - EnclaveID 3 -Enclave3 - EnclaveID 4 - -Secure Channel Establishment between Source (E1) and Destination (E2) Enclaves successful !!! - -Enclave to Enclave Call between Source (E1) and Destination (E2) Enclaves successful !!! - -Message Exchange between Source (E1) and Destination (E2) Enclaves successful !!! - -Secure Channel Establishment between Source (E1) and Destination (E3) Enclaves successful !!! - -Enclave to Enclave Call between Source (E1) and Destination (E3) Enclaves successful !!! - -Message Exchange between Source (E1) and Destination (E3) Enclaves successful !!! - -Secure Channel Establishment between Source (E2) and Destination (E3) Enclaves successful !!! - -Enclave to Enclave Call between Source (E2) and Destination (E3) Enclaves successful !!! - -Message Exchange between Source (E2) and Destination (E3) Enclaves successful !!! - -Secure Channel Establishment between Source (E3) and Destination (E1) Enclaves successful !!! - -Enclave to Enclave Call between Source (E3) and Destination (E1) Enclaves successful !!! - -Message Exchange between Source (E3) and Destination (E1) Enclaves successful !!! - -Close Session between Source (E1) and Destination (E2) Enclaves successful !!! - -Close Session between Source (E1) and Destination (E3) Enclaves successful !!! - -Close Session between Source (E2) and Destination (E3) Enclaves successful !!! - -Close Session between Source (E3) and Destination (E1) Enclaves successful !!! - -Hit a key.... -``` - -## Aller plus loin - -Pour aller plus loin (développer votre propre application, s’inscrire pour obtenir une certification à distance, ...), voici quelques ressources utiles : - -- [Intel SGX](https://software.intel.com/en-us/sgx) -- [Intel SGX Attestation services](https://software.intel.com/en-us/sgx/attestation-services) -- [Intel SGX linux-2.6 documentation](https://download.01.org/intel-sgx/linux-2.6/docs/) -- [github.com/intel/linux-sgx](https://github.com/intel/linux-sgx) -- [github.com/intel/linux-sgx-driver](https://github.com/intel/linux-sgx-driver) -- [github.com/intel/sgx-ra-sample](https://github.com/intel/sgx-ra-sample) diff --git a/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.fr-fr.md b/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.fr-fr.md index 055a9671311..d83a4366a0b 100644 --- a/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.fr-fr.md +++ b/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.fr-fr.md @@ -1,217 +1,240 @@ --- -title: 'Activer Intel SGX sur votre serveur dédié' -excerpt: 'Activez l’option SGX sur votre serveur Infrastructure ou Advance et installez la pile de logiciels SGX pour Linux' -updated: 2022-08-31 +title: "Comment gérer Intel SGX sur un serveur dédié" +excerpt: "Découvrez comment activer l'option SGX sur votre serveur dédié et installer la pile logicielle SGX pour Linux" +updated: 2025-11-20 --- ## Objectif -Activez Intel Software Guard Extensions sur votre serveur, pour pouvoir exécuter les applications SGX-ready. -La technologie Intel SGX fournit des fonctions de sécurité avancées de chiffrement matériel de la mémoire. Cela permet d’isoler des parties de code et des données spécifiques d'une application. +L'activation des Intel Software Guard Extensions (SGX) sur votre serveur vous permet d'exécuter des applications compatibles SGX. Intel SGX offre des fonctionnalités avancées de chiffrement matériel et de sécurité de la mémoire vive, afin d'isoler les parties de code et de données spécifiques à chaque application. -**Ce guide détaille comment activer la fonctionnalité SGX, depuis l'espace client OVHcloud ou via l'API OVHcloud.** +**Ce guide explique comment activer la fonctionnalité SGX, via l'espace client OVHcloud ou via l'API OVHcloud.** ## Prérequis -- Avoir un serveur dédié compatible avec l’option [SGX](https://www.ovhcloud.com/fr/bare-metal/intel-software-guard-extensions/) -- Disposer des identifiants de connexion reçus par e-mail suite à l'installation -- Avoir accès à l'[espace client OVHcloud](/links/manager) ou l’[API OVHcloud](/links/api) -- Ubuntu 18.04 ou équivalent installé sur le serveur +- Avoir accès à [l'espace client OVHcloud](/links/manager) ou à [l'API OVHcloud](/links/api) +- Avoir un serveur dédié compatible avec [l'option SGX](/links/bare-metal/sgx) dans votre compte OVHcloud +- Disposer des identifiants reçus par e-mail après l'installation +- Ubuntu 24.04 ou équivalent est installé sur le serveur ## En pratique -### Depuis l'espace client OVHcloud - -Connectez-vous à l'[espace client OVHcloud](/links/manager), accédez à la section `Bare Metal Cloud`{.action}, puis sélectionnez le serveur sur lequel vous souhaitez activer SGX dans la section **Serveurs dédiés** du menu de gauche. - -#### Activation de l'option - -Descendez jusqu'à la zone `Fonctionnalités avancées` et cliquez sur `...`{.action} en face de « Sécurité - Intel SGX (Software Guard Extensions) ». Sélectionnez `Activer SGX`{.action} dans le menu déroulant. - -![activation SGX](images/enable_sgx.png){.thumbnail} - -Sur l'écran suivant, cliquez sur le bouton `Activer`{.action}. - -![activation SGX](images/enable_sgx2.png){.thumbnail} - -Vous pouvez choisir d'activer SGX avec une quantité spécifique de mémoire réservée ou de l'activer en permettant à votre logiciel de réserver automatiquement la mémoire dont il a besoin. Une fois que vous avez fait votre choix, cliquez sur `Confirmer`{.action}. - -![activation SGX](images/manage_sgx.png){.thumbnail} - -Une pop-up de confirmation apparaît, confirmez alors que vous avez bien pris connaissance que l'activation de la technologie Intel SGX nécessite le(s) redémarrage(s) de votre serveur. - -![activation SGX](images/confirmation-popup_sgx.png){.thumbnail} - -> [!warning] -> -> En fonction du serveur, cette action entraînera 1 à plusieurs redémarrages de celui-ci. - -#### Désactivation de l'option - -Descendez jusqu'à la zone `Fonctionnalités avancées` et cliquez sur `...`{.action} en face de « Sécurité - Intel SGX (Software Guard Extensions) ». Sélectionnez `Modifier SGX`{.action} dans le menu déroulant. Choisissez l'option `Désactiver`{.action}, puis cliquez sur `Confirmer`{.action}. - -![Désactivation de SGX](images/disable_sgx.png){.thumbnail} - -> [!warning] -> -> En fonction du serveur, cette action entraînera 1 à plusieurs redémarrages de celui-ci. - -Continuez la lecture de ce guide à [l'étape 3](#sgx-softwares) ci-dessous. - -### Depuis l'API OVHcloud - -#### Étape 1 : Se connecter à l’API - -Allez sur et cliquez sur `Login`{.action} dans le coin supérieur droit de la page. -Sur la page suivante, connectez-vous avec les identifiants de votre compte OVHcloud. - -#### Étape 2 : Activer SGX - -Obtenez le nom de votre serveur de la liste renvoyée par cet appel : - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server - -Vérifiez que votre service dispose de l’option SGX, avec l’appel suivant : - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/biosSettings/sgx - -![SGX disabled](images/get-disabled.png){.thumbnail} - -Maintenant, activez SGX. - -> [!warning] -> -> En fonction du serveur, cette action entraînera 1 à plusieurs redémarrages de celui-ci. - -> [!api] -> -> @api {v1} /dedicated/server POST /dedicated/server/{serviceName}/biosSettings/sgx/configure - -![Configure SGX](images/post-configure.png){.thumbnail} - -Vérifiez le progrès de la tâche de configuration en appelant cet endpoint avec le taskId renvoyé par l’appel précédent : - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/task/{taskId} - -![Get SGX configuration task](images/get-task.png){.thumbnail} - -Vous pouvez vérifier que l’état est maintenant «activé» : - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/biosSettings/sgx - -![SGX enabled](images/get-enabled.png){.thumbnail} - -#### Étape 3 : Installer la pile de logiciels SGX - -Il faut maintenant installer le driver Intel et SDK pour pouvoir développer et exécuter des applications SGX. - -En premier lieu, il faut installer quelques dépendances : +### Activer SGX + +L'activation de SGX est possible depuis l'espace client OVHcloud, l'API OVHcloud ou le BIOS de votre serveur. + +> [!tabs] +> **Via l'espace client OVHcloud** +>> +>> **1 - Connexion à l'espace client OVHcloud** +>> +>> Connectez-vous à [l'espace client OVHcloud](/links/manager), accédez à la section `Bare Metal Cloud`{.action} et cliquez sur `Serveurs dédiés`{.action}. Sélectionnez ensuite le serveur sur lequel vous souhaitez activer SGX. +>> +>> **2 - Activer SGX** +>> +>> Depuis l'onglet `Informations générales`{.action}, dans le cadre **Fonctionnalités avancées**, cliquez sur `...`{.action} à côté de la mention **Sécurité - Intel SGX (Software Guard Extensions)** et sélectionnez `Activer SGX`{.action} dans le menu déroulant. +>> +>> ![Activation SGX](images/enable_sgx.png){.thumbnail} +>> +>> Sur l'écran suivant, cliquez sur le bouton `Activer`{.action}. +>> +>> ![Activation SGX](images/enable_sgx2.png){.thumbnail} +>> +>> Vous pouvez choisir d'activer SGX avec une quantité spécifique de mémoire réservée ou en permettant à votre application de réserver automatiquement la mémoire dont elle a besoin. Une fois votre choix fait, cliquez sur `Confirmer`{.action}. +>> +>> ![Gestion SGX](images/manage_sgx.png){.thumbnail} +>> +>> Une fenêtre de confirmation apparaîtra. Veuillez confirmer que vous avez compris que l'activation de la technologie Intel SGX entraînera un redémarrage de votre serveur. +>> +>> ![Activation SGX](images/confirmation-popup_sgx.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Cela entraînera un ou plusieurs redémarrages de votre serveur, selon son modèle. +>> +> **Via l'API OVHcloud** +>> +>> **1 - Connexion à la console API** +>> +>> Sur la page des [API OVHcloud](/links/console) : +>> +>> - Cliquez sur `Authentication`{.action} en haut à gauche. +>> - Cliquez ensuite sur `Login with OVHcloud SSO`{.action}. +>> - Saisissez vos identifiants OVHcloud. +>> - Cliquez sur le bouton `Authorize`{.action} pour autoriser les appels aux API depuis ce site. +>> +>> **2 - Activer SGX** +>> +>> Récupérez le nom de votre serveur dans la liste retournée par l'appel suivant : +>> +>> > [!api] +>> > +>> > @api {v1} /dedicated/server GET /dedicated/server +>> +>> Vérifiez que votre service dispose de l'option SGX en utilisant cet appel : +>> +>> > [!api] +>> > +>> > @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/biosSettings/sgx +>> +>> ![SGX désactivé](images/get-disabled.png){.thumbnail} +>> +>> Activez SGX en utilisant le nom du serveur : +>> +>> > [!warning] +>> > +>> > Cela entraînera un ou plusieurs redémarrages de votre serveur, selon son modèle. +>> +>> > [!api] +>> > +>> > @api {v1} /dedicated/server POST /dedicated/server/{serviceName}/biosSettings/sgx/configure +>> +>> ![Configuration SGX](images/post-configure.png){.thumbnail} +>> +>> Vérifiez l'avancement de la tâche de configuration en appelant ce point de terminaison avec le *taskId* retourné par l'appel précédent : +>> +>> > [!api] +>> > +>> > @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/task/{taskId} +>> +>> ![Obtenir la tâche de configuration SGX](images/get-task.png){.thumbnail} +>> +>> Vous pouvez vérifier que l'état est activé : +>> +>> > [!api] +>> > +>> > @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/biosSettings/sgx +>> +>> ![SGX activé](images/get-enabled.png){.thumbnail} +>> +> **Configuration manuelle dans le BIOS** +>> +>> **1 - Démarrer une session Remote KVM** +>> +>> Connectez-vous à [l'espace client OVHcloud](/links/manager), accédez à la section `Bare Metal Cloud`{.action} et cliquez sur `Serveurs dédiés`{.action}. Sélectionnez ensuite le serveur sur lequel vous souhaitez activer SGX. +>> +>> Depuis l'onglet `IPMI / KMV`{.action}, démarrez une session Remote KVM : +>> +>> ![Démarrer une session Remote KVM](images/manager.png){.thumbnail} +>> +>> **2 - Activer SGX** +>> +>> Ensuite, depuis le KVM, initiez un redémarrage du serveur et entrez dans le BIOS (généralement en appuyant sur la touche `DEL`{.action} ou `F2`{.action}). +>> +>> Dans le BIOS, rendez-vous dans la partie `Advanced` > `Processor Configuration`. +>> +>> Activez les options TME et SGX et configurez la taille PRMRR souhaitée : +>> +>> ![Activer SGX](images/sgx_bios.png){.thumbnail} +>> +>> Sauvegardez les modifications en appuyant sur la touche `F10`{.action}. Une fenêtre de confirmation apparaîtra, veuillez confirmer avec l'option `Yes`. +>> +>> Votre serveur redémarrera ensuite sur votre système d'exploitation. +>> + +### Installer la pile logicielle SGX + +Utilisez les commandes suivantes pour installer le SDK d'Intel afin de pouvoir développer et exécuter des applications SGX. + +Tout d'abord, installez quelques dépendances : ```bash -sudo apt-get install build-essential ocaml ocamlbuild automake autoconf libtool wget python libssl-dev libcurl4-openssl-dev protobuf-compiler libprotobuf-dev debhelper cmake git +sudo apt update +sudo apt install autoconf automake build-essential cmake debhelper git libcurl4-openssl-dev libprotobuf-dev libssl-dev libtool lsb-release ocaml ocamlbuild protobuf-compiler python-is-python3 reprepro wget perl unzip pkgconf libboost-dev libboost-system-dev libboost-thread-dev libsystemd0 ``` -Ensuite, téléchargez, créez et installez la pile logicielle SGX : +Ensuite, téléchargez le code source et préparez les sous-modules et les binaires prêts à l'emploi : ```bash BASE_DIR=/opt/intel [[ -d $BASE_DIR ]] || sudo mkdir -p $BASE_DIR && sudo chown `whoami` $BASE_DIR cd $BASE_DIR - + git clone https://github.com/intel/linux-sgx.git - + cd linux-sgx -git checkout sgx_2.6 -./download_prebuilt.sh -make -j 6 -make sdk_install_pkg -j 6 -make deb_pkg -j 6 -$BASE_DIR/linux-sgx/linux/installer/bin/sgx_linux_x64_sdk_2.6.100.51363.bin --prefix=$BASE_DIR/ - -sudo dpkg -i $BASE_DIR/linux-sgx/linux/installer/deb/libsgx-urts_2.6.100.51363-bionic1_amd64.deb $BASE_DIR/linux-sgx/linux/installer/deb/libsgx-enclave-common_2.6.100.51363-bionic1_amd64.deb +git checkout sgx_2.26 +make preparation ``` -Téléchargez et installez le driver : +Construisez et installez le SDK SGX : ```bash -wget https://download.01.org/intel-sgx/linux-2.6/ubuntu18.04-server/sgx_linux_x64_driver_2.5.0_2605efa.bin -chmod +x sgx_linux_x64_driver_2.5.0_2605efa.bin -sudo ./sgx_linux_x64_driver_2.5.0_2605efa.bin +make sdk_install_pkg +$ ./linux/installer/bin/sgx_linux_x64_sdk_2.26.100.0.bin --prefix=$BASE_DIR/ ``` -#### Étape 4 : Redémarrer pour finir l’installation +### Tester l'application d'exemple en mode simulateur -#### Étape 5 : Utiliser un modèle d’application pour valider l’installation - -Créez une application avec un des modèles fournis : +Pour construire et exécuter le code d'exemple *LocalAttestation* en mode simulateur : ```bash BASE_DIR=/opt/intel cd $BASE_DIR/sgxsdk/SampleCode/LocalAttestation/ source $BASE_DIR/sgxsdk/environment -make SGX_DEBUG=0 SGX_MODE=HW SGX_PRERELEASE=1 + +make clean +SGX_MODE=SIM make +cd bin +./app +succeed to load enclaves. +succeed to establish secure channel. +Succeed to exchange secure message... +Succeed to close Session... ``` -Exécutez-la : - -```bash -ovh@nsXXXX:/opt/intel/sgxsdk/SampleCode/LocalAttestation$ ./app - -Available Enclaves -Enclave1 - EnclaveID 2 -Enclave2 - EnclaveID 3 -Enclave3 - EnclaveID 4 - -Secure Channel Establishment between Source (E1) and Destination (E2) Enclaves successful !!! - -Enclave to Enclave Call between Source (E1) and Destination (E2) Enclaves successful !!! - -Message Exchange between Source (E1) and Destination (E2) Enclaves successful !!! - -Secure Channel Establishment between Source (E1) and Destination (E3) Enclaves successful !!! +### Construire et installer le PSW Intel SGX -Enclave to Enclave Call between Source (E1) and Destination (E3) Enclaves successful !!! +Le logiciel Intel SGX Platform Software (PSW) fournit des bibliothèques logicielles permettant d'exécuter des applications SGX en mode matériel. Pour créer le référentiel Debian local qui héberge les paquets, exécutez les commandes suivantes : -Message Exchange between Source (E1) and Destination (E3) Enclaves successful !!! - -Secure Channel Establishment between Source (E2) and Destination (E3) Enclaves successful !!! - -Enclave to Enclave Call between Source (E2) and Destination (E3) Enclaves successful !!! - -Message Exchange between Source (E2) and Destination (E3) Enclaves successful !!! - -Secure Channel Establishment between Source (E3) and Destination (E1) Enclaves successful !!! +```bash +BASE_DIR=/opt/intel +cd $BASE_DIR/linux-sgx +make deb_local_repo +``` -Enclave to Enclave Call between Source (E3) and Destination (E1) Enclaves successful !!! +Créez le fichier suivant pour ajouter le dépôt local de paquets Debian au système de configuration des dépôts : -Message Exchange between Source (E3) and Destination (E1) Enclaves successful !!! +```bash +$ cat /etc/apt/sources.list.d/sgx.sources +Types: deb +URIs: file:/opt/intel/linux-sgx/linux/installer/deb/sgx_debian_local_repo +Suites: noble +Components: main +trusted: yes +``` -Close Session between Source (E1) and Destination (E2) Enclaves successful !!! +Ensuite, installez les paquets suivants : -Close Session between Source (E1) and Destination (E3) Enclaves successful !!! +```bash +sudo apt update +sudo apt-get install libsgx-epid libsgx-quote-ex libsgx-dcap-ql +``` -Close Session between Source (E2) and Destination (E3) Enclaves successful !!! +### Tester l'application d'exemple en mode matériel (facultatif) -Close Session between Source (E3) and Destination (E1) Enclaves successful !!! +Pour construire et exécuter le code d'exemple *LocalAttestation* en mode matériel : -Hit a key.... +```bash +BASE_DIR=/opt/intel +cd $BASE_DIR/sgxsdk/SampleCode/LocalAttestation/ +source $BASE_DIR/sgxsdk/environment + +make clean +SGX_MODE=HW make +cd bin +./app +succeed to load enclaves. +succeed to establish secure channel. +Succeed to exchange secure message... +Succeed to close Session... ``` ## Aller plus loin -Pour aller plus loin (développer votre propre application, s’inscrire pour obtenir une certification à distance, ...), voici quelques ressources utiles : +Pour aller plus loin (développer votre propre application, vous inscrire à l'attestation distante, etc.), voici quelques ressources utiles : - [Intel SGX](https://software.intel.com/en-us/sgx) - [Intel SGX Attestation services](https://software.intel.com/en-us/sgx/attestation-services) -- [Intel SGX linux-2.6 documentation](https://download.01.org/intel-sgx/linux-2.6/docs/) +- [Intel SGX linux-2.26 documentation](https://download.01.org/intel-sgx/sgx-linux/2.26/docs/) - [github.com/intel/linux-sgx](https://github.com/intel/linux-sgx) -- [github.com/intel/linux-sgx-driver](https://github.com/intel/linux-sgx-driver) -- [github.com/intel/sgx-ra-sample](https://github.com/intel/sgx-ra-sample) diff --git a/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.it-it.md b/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.it-it.md index f19be1bd20c..31550786f1f 100644 --- a/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.it-it.md +++ b/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.it-it.md @@ -1,219 +1,240 @@ --- -title: 'Attiva Intel SGX sul tuo server dedicato' -excerpt: 'Come attivare SGX sul tuo server Infrastructure o Advance e installare lo stack software Linux SGX' -updated: 2022-08-31 +title: "Come gestire Intel SGX su un server dedicato" +excerpt: "Scopri come attivare l'opzione SGX sul tuo server dedicato e installare la pila software SGX per Linux" +updated: 2025-11-20 --- -> [!primary] -> Questa traduzione è stata generata automaticamente dal nostro partner SYSTRAN. I contenuti potrebbero presentare imprecisioni, ad esempio la nomenclatura dei pulsanti o alcuni dettagli tecnici. In caso di dubbi consigliamo di fare riferimento alla versione inglese o francese della guida. Per aiutarci a migliorare questa traduzione, utilizza il pulsante "Contribuisci" di questa pagina. -> - ## Obiettivo -Questa guida ti mostra come attivare Intel Software Guard Extension sul tuo server per poter utilizzare le applicazioni SGX-ready. -Intel SGX offre funzionalità avanzate di crittografia di sicurezza hardware e RAM allo scopo di isolare parti di codice e dati specifici per ogni applicazione. +L'abilitazione delle Intel Software Guard Extensions (SGX) sul tuo server ti permette di eseguire applicazioni compatibili con SGX. Intel SGX fornisce funzionalità avanzate di crittografia della sicurezza hardware e della memoria RAM, al fine di isolare parti specifiche di codice e dati per ogni applicazione. + +**Questa guida spiega come attivare la funzionalità SGX, tramite lo Spazio Cliente OVHcloud o tramite l'API OVHcloud.** ## Prerequisiti -- Un server dedicato compatibile con l'opzione [SGX](https://www.ovhcloud.com/it/bare-metal/intel-software-guard-extensions/) -- Disporre delle credenziali di accesso ricevute via email in seguito all’installazione -- Avere accesso allo [Spazio Cliente OVHcloud](/links/manager) o all’[API OVHcloud](/links/api) -- Aver installato Ubuntu 18.04 (o un sistema operativo simile) sul server +- Avere accesso allo [Spazio Cliente OVHcloud](/links/manager) o all'[API OVHcloud](/links/api) +- Avere un server dedicato compatibile con [l'opzione SGX](/links/bare-metal/sgx) nel tuo account OVHcloud +- Disporre delle credenziali ricevute via e-mail dopo l'installazione +- Ubuntu 24.04 o equivalente installato sul server ## Procedura -### Dallo Spazio Cliente - -Accedi allo [Spazio Cliente OVHcloud](/links/manager), accedi alla sezione `Bare Metal Cloud`{.action} e seleziona il server su cui vuoi attivare SGX nella sezione **Server dedicati** del menu a sinistra. - -#### Attiva l'opzione - -Scendi fino alla zona `Funzionalità avanzate` e clicca su `...`{.action} in corrispondenza di "Sicurezza - Intel SGX (Software Guard Extensions)". Seleziona `Attiva SGX`{.action} nel menu a tendina. - -![attivazione SGX](images/enable_sgx.png){.thumbnail} - -Nella finestra successiva clicca sul pulsante `Attiva`{.action}. - -![attivazione SGX](images/enable_sgx2.png){.thumbnail} - -Puoi scegliere di attivare SGX con una quantità specifica di memoria riservata o attivarla permettendo al tuo software di prenotare automaticamente la memoria di cui ha bisogno. Una volta effettuata la scelta, clicca su `Conferma`{.action}. - -![attivazione SGX](images/manage_sgx.png){.thumbnail} - -A questo punto, compare un pop-up di conferma, conferma che per attivare la tecnologia Intel SGX è necessario riavviare il tuo server. - -![attivazione SGX](images/confirmation-popup_sgx.png){.thumbnail} - -> [!warning] -> -> In base al server, questa azione comporta l'avvio da 1 a diversi riavvii. - -#### Disattivazione dell'opzione - -Scendi fino alla zona `Funzionalità avanzate` e clicca su `...`{.action} in corrispondenza di "Sicurezza - Intel SGX (Software Guard Extensions)". Seleziona `Modifica SGX`{.action} nel menu a tendina. Scegli l'opzione `Disattivare`{.action} e clicca su `Conferma`{.action}. - -![Disattivazione di SGX](images/disable_sgx.png){.thumbnail} - -> [!warning] -> -> In base al server, questa azione comporta l'avvio da 1 a diversi riavvii. - -Continua la lettura di questa guida allo [Step 3](#sgx-softwares). - -### Via API OVHcloud - -#### Step 1: accedi alla console API - -Vai sul sito e clicca su`Login`{.action} in alto a destra. -Nella nuova pagina, effettua l’accesso con le credenziali del tuo account OVHcloud. - -#### Step 2: attiva SGX - -Recupera il nome del server dalla lista ottenuta da questa chiamata: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server - -Verifica che il tuo server abbia l’opzione SGX effettuando questa chiamata: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/biosSettings/sgx - -![SGX disabled](images/get-disabled.png){.thumbnail} - -A questo punto, attiva SGX: - -> [!warning] -> -> In base al server, questa azione comporta l'avvio da 1 a diversi riavvii. - -> [!api] -> -> @api {v1} /dedicated/server POST /dedicated/server/{serviceName}/biosSettings/sgx/configure - -![Configure SGX](images/post-configure.png){.thumbnail} - -Controlla lo stato di avanzamento della configurazione chiamando questo endpoint con il taskld ottenuto dalla chiamata precedente: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/task/{taskId} - -![Get SGX configuration task](images/get-task.png){.thumbnail} - -Ora verifica che l’opzione sia attiva: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/biosSettings/sgx - -![SGX enabled](images/get-enabled.png){.thumbnail} - -#### Step 3: installa lo stack software SGX - -A questo punto installa il driver Intel e SDK per sviluppare ed eseguire le applicazioni SGX. - -Per prima cosa, installa alcune dipendenze: +### Attivare SGX + +L'attivazione di SGX è possibile dal pannello clienti di OVHcloud, dall'API di OVHcloud o dal BIOS del tuo server. + +> [!tabs] +> **Tramite lo Spazio Cliente OVHcloud** +>> +>> **1 - Connessione allo Spazio Cliente OVHcloud** +>> +>> Accedi allo [Spazio Cliente OVHcloud](/links/manager), vai alla sezione `Bare Metal Cloud`{.action} e clicca su `Server dedicati`{.action}. Seleziona quindi il server su cui desideri abilitare SGX. +>> +>> **2 - Attivare SGX** +>> +>> Dall'onghetta `Informazioni generali`{.action}, nel riquadro **Funzionalità avanzate**, clicca su `...`{.action} accanto alla voce **Sicurezza - Intel SGX (Software Guard Extensions)** e seleziona `Attiva SGX`{.action} nel menu a discesa. +>> +>> ![Attivazione SGX](images/enable_sgx.png){.thumbnail} +>> +>> Nello schermo successivo, clicca sul pulsante `Attiva`{.action}. +>> +>> ![Attivazione SGX](images/enable_sgx2.png){.thumbnail} +>> +>> Puoi scegliere di abilitare SGX con una quantità specifica di memoria riservata o permettendo all'applicazione di riservare automaticamente la memoria necessaria. Una volta effettuata la scelta, clicca su `Conferma`{.action}. +>> +>> ![Gestione SGX](images/manage_sgx.png){.thumbnail} +>> +>> Verrà visualizzata una finestra di conferma. Conferma di aver compreso che l'abilitazione della tecnologia Intel SGX comporterà un riavvio del tuo server. +>> +>> ![Attivazione SGX](images/confirmation-popup_sgx.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Questo comporterà uno o più riavvii del tuo server, a seconda del modello. +>> +> **Tramite l'API OVHcloud** +>> +>> **1 - Connessione alla console API** +>> +>> Nella pagina delle [API OVHcloud](/links/console): +>> +>> - Clicca su `Authentication`{.action} in alto a sinistra. +>> - Clicca quindi su `Login with OVHcloud SSO`{.action}. +>> - Inserisci le tue credenziali OVHcloud. +>> - Clicca sul pulsante `Authorize`{.action} per autorizzare le chiamate alle API da questo sito. +>> +>> **2 - Attivare SGX** +>> +>> Recupera il nome del tuo server nell'elenco restituito dalla seguente chiamata: +>> +>> > [!api] +>> > +>> > @api {v1} /dedicated/server GET /dedicated/server +>> +>> Verifica che il tuo servizio disponga dell'opzione SGX utilizzando questa chiamata: +>> +>> > [!api] +>> > +>> > @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/biosSettings/sgx +>> +>> ![SGX disabilitato](images/get-disabled.png){.thumbnail} +>> +>> Attiva SGX utilizzando il nome del server: +>> +>> > [!warning] +>> > +>> > Questo comporterà uno o più riavvii del tuo server, a seconda del modello. +>> +>> > [!api] +>> > +>> > @api {v1} /dedicated/server POST /dedicated/server/{serviceName}/biosSettings/sgx/configure +>> +>> ![Configurazione SGX](images/post-configure.png){.thumbnail} +>> +>> Verifica l'avanzamento del compito di configurazione chiamando questo endpoint con l'*taskId* restituito dalla chiamata precedente: +>> +>> > [!api] +>> > +>> > @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/task/{taskId} +>> +>> ![Ottieni il compito di configurazione SGX](images/get-task.png){.thumbnail} +>> +>> Puoi verificare che lo stato sia abilitato: +>> +>> > [!api] +>> > +>> > @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/biosSettings/sgx +>> +>> ![SGX abilitato](images/get-enabled.png){.thumbnail} +>> +> **Configurazione manuale nel BIOS** +>> +>> **1 - Avviare una sessione Remote KVM** +>> +>> Accedi allo [Spazio Cliente OVHcloud](/links/manager), vai alla sezione `Bare Metal Cloud`{.action} e clicca su `Server dedicati`{.action}. Seleziona quindi il server su cui desideri abilitare SGX. +>> +>> Dall'onghetta `IPMI/KMV`{.action}, avvia una sessione Remote KVM: +>> +>> ![Avviare una sessione Remote KVM](images/manager.png){.thumbnail} +>> +>> **2 - Attivare SGX** +>> +>> Successivamente, dal KVM, avvia un riavvio del server e accedi al BIOS (di norma premendo il tasto `DEL`{.action} o `F2`{.action}). +>> +>> Nel BIOS, vai nella sezione `Advanced` > `Processor Configuration`. +>> +>> Attiva le Opzioni TME e SGX e configura la dimensione PRMRR desiderata: +>> +>> ![Attivare SGX](images/sgx_bios.png){.thumbnail} +>> +>> Salva le modifiche premendo il tasto `F10`{.action}. Verrà visualizzata una finestra di conferma, conferma con l'opzione `Yes`. +>> +>> Il tuo server successivamente si riavvierà sul tuo sistema operativo. +>> + +### Installare la pila software SGX + +Utilizza i seguenti comandi per installare l'SDK di Intel in modo da poter sviluppare ed eseguire applicazioni SGX. + +Innanzitutto, installa alcune dipendenze: ```bash -sudo apt-get install build-essential ocaml ocamlbuild automake autoconf libtool wget python libssl-dev libcurl4-openssl-dev protobuf-compiler libprotobuf-dev debhelper cmake git +sudo apt update +sudo apt install autoconf automake build-Essential cmake debhelper git libcurl4-openssl-dev libprotobuf-dev libssl-dev libtool lsb-release ocaml ocamlbuild protobuf-compiler python-is-python3 reprepro wget perl unzip pkgconf libboost-dev libboost-system-dev libboost-thread-dev libsystemd0 ``` -Poi, scarica, costruisci e installa il software SGX: +Successivamente, scarica il codice sorgente e prepara i sottomoduli e i binari pronti all'uso: ```bash BASE_DIR=/opt/intel [[ -d $BASE_DIR ]] || sudo mkdir -p $BASE_DIR && sudo chown `whoami` $BASE_DIR cd $BASE_DIR - + git clone https://github.com/intel/linux-sgx.git - + cd linux-sgx -git checkout sgx_2.6 -./download_prebuilt.sh -make -j 6 -make sdk_install_pkg -j 6 -make deb_pkg -j 6 -$BASE_DIR/linux-sgx/linux/installer/bin/sgx_linux_x64_sdk_2.6.100.51363.bin --prefix=$BASE_DIR/ - -sudo dpkg -i $BASE_DIR/linux-sgx/linux/installer/deb/libsgx-urts_2.6.100.51363-bionic1_amd64.deb $BASE_DIR/linux-sgx/linux/installer/deb/libsgx-enclave-common_2.6.100.51363-bionic1_amd64.deb +git checkout sgx_2.26 +make preparation ``` -Scarica e installa il driver: +Costruisci e installa l'SDK SGX: ```bash -wget https://download.01.org/intel-sgx/linux-2.6/ubuntu18.04-server/sgx_linux_x64_driver_2.5.0_2605efa.bin -chmod +x sgx_linux_x64_driver_2.5.0_2605efa.bin -sudo ./sgx_linux_x64_driver_2.5.0_2605efa.bin +make sdk_install_pkg +$ ./linux/installer/bin/sgx_linux_x64_sdk_2.26.100.0.bin --prefix=$BASE_DIR/ ``` -#### Step 4: riavvia il sistema per completare l’installazione - -#### Step 5: utilizza un’applicazione campione per convalidare l’installazione +### Testare l'applicazione di esempio in modalità simulatore -Costruisci una delle applicazioni campione proposte: +Per costruire ed eseguire il codice di esempio *LocalAttestation* in modalità simulatore: ```bash BASE_DIR=/opt/intel cd $BASE_DIR/sgxsdk/SampleCode/LocalAttestation/ source $BASE_DIR/sgxsdk/environment -make SGX_DEBUG=0 SGX_MODE=HW SGX_PRERELEASE=1 + +make clean +SGX_MODE=SIM make +cd bin +./app +succeed to load enclaves. +succeed to establish secure channel. +Succeed to exchange secure message... +Succeed to close Session... ``` -Esegui l’applicazione: - -```bash -ovh@nsXXXX:/opt/intel/sgxsdk/SampleCode/LocalAttestation$ ./app - -Available Enclaves -Enclave1 - EnclaveID 2 -Enclave2 - EnclaveID 3 -Enclave3 - EnclaveID 4 - -Secure Channel Establishment between Source (E1) and Destination (E2) Enclaves successful !!! - -Enclave to Enclave Call between Source (E1) and Destination (E2) Enclaves successful !!! - -Message Exchange between Source (E1) and Destination (E2) Enclaves successful !!! +### Costruire e installare il PSW Intel SGX -Secure Channel Establishment between Source (E1) and Destination (E3) Enclaves successful !!! +Il software Intel SGX Platform Software (PSW) fornisce librerie software per eseguire applicazioni SGX in modalità hardware. Per creare il repository Debian locale che ospita i pacchetti, esegui i seguenti comandi: -Enclave to Enclave Call between Source (E1) and Destination (E3) Enclaves successful !!! - -Message Exchange between Source (E1) and Destination (E3) Enclaves successful !!! - -Secure Channel Establishment between Source (E2) and Destination (E3) Enclaves successful !!! - -Enclave to Enclave Call between Source (E2) and Destination (E3) Enclaves successful !!! - -Message Exchange between Source (E2) and Destination (E3) Enclaves successful !!! - -Secure Channel Establishment between Source (E3) and Destination (E1) Enclaves successful !!! +```bash +BASE_DIR=/opt/intel +cd $BASE_DIR/linux-sgx +make deb_local_repo +``` -Enclave to Enclave Call between Source (E3) and Destination (E1) Enclaves successful !!! +Crea il seguente file per aggiungere il repository locale dei pacchetti Debian al sistema di configurazione dei repository: -Message Exchange between Source (E3) and Destination (E1) Enclaves successful !!! +```bash +$ cat /etc/apt/sources.list.d/sgx.sources +Types: deb +URIs: file:/opt/intel/linux-sgx/linux/installer/deb/sgx_debian_local_repo +Suites: noble +Components: main +trusted: yes +``` -Message Exchange between Source (E1) and Destination (E2) Enclaves successful !!! +Successivamente, installa i seguenti pacchetti: -Message Exchange between Source (E1) and Destination (E3) Enclaves successful !!! +```bash +sudo apt update +sudo apt-get install libsgx-epid libsgx-quote-ex libsgx-dcap-ql +``` -Message Exchange between Source (E2) and Destination (E3) Enclaves successful !!! +### Testare l'applicazione di esempio in modalità hardware (opzionale) -Message Exchange between Source (E3) and Destination (E1) Enclaves successful !!! +Per costruire ed eseguire il codice di esempio *LocalAttestation* in modalità hardware: -Premi un tasto... +```bash +BASE_DIR=/opt/intel +cd $BASE_DIR/sgxsdk/SampleCode/LocalAttestation/ +source $BASE_DIR/sgxsdk/environment + +make clean +SGX_MODE=HW make +cd bin +./app +succeed to load enclaves. +succeed to establish secure channel. +Succeed to exchange secure message... +Succeed to close Session... ``` -## Spingiti oltre +## Per saperne di più -Per saperne di più (ad esempio, su come sviluppare la tua applicazione o registrarsi per un’attestazione remota, ecc.) ecco alcune risorse utili: +Per approfondire (sviluppare la tua applicazione, iscriverti all'attestazione remota, ecc.), ecco alcune risorse utili: - [Intel SGX](https://software.intel.com/en-us/sgx) -- [Intel SGX Attestation service](https://software.intel.com/en-us/sgx/attestation-services) -- [Intel SGX linux-2.6 documentation](https://download.01.org/intel-sgx/linux-2.6/docs/) -- [github.com/intel/linux-sgx](https://github.com/intel/linux-sgx) -- [github.com/intel/linux-sgx-driver](https://github.com/intel/linux-sgx-driver) -- [github.com/intel/sgx-ra-sample](https://github.com/intel/sgx-ra-sample) +- [Intel SGX Attestation services](https://software.intel.com/en-us/sgx/attestation-services) +- [Intel SGX linux-2.26 documentation](https://download.01.org/intel-sgx/sgx-linux/2.26/docs/) +- [github.com/intel/linux-sgx](https://github.com/intel/linux-sgx) \ No newline at end of file diff --git a/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.pl-pl.md b/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.pl-pl.md index 6034134953e..96c1946580b 100644 --- a/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.pl-pl.md +++ b/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.pl-pl.md @@ -1,219 +1,240 @@ --- -title: 'Włączenie Intel SGX na serwerze dedykowanym' -excerpt: 'Włącz opcję SGX na serwerze Infrastructure lub Advance i zainstaluj stos oprogramowania SGX na Linux' -updated: 2022-08-31 +title: "Jak zarządzać Intel SGX na serwerze dedykowanym" +excerpt: "Odkryj, jak aktywować opcję SGX na swoim serwerze dedykowanym i zainstalować stos oprogramowania SGX dla systemu Linux" +updated: 2025-11-20 --- -> [!primary] -> Tłumaczenie zostało wygenerowane automatycznie przez system naszego partnera SYSTRAN. W niektórych przypadkach mogą wystąpić nieprecyzyjne sformułowania, na przykład w tłumaczeniu nazw przycisków lub szczegółów technicznych. W przypadku jakichkolwiek wątpliwości zalecamy zapoznanie się z angielską/francuską wersją przewodnika. Jeśli chcesz przyczynić się do ulepszenia tłumaczenia, kliknij przycisk "Zgłóś propozycję modyfikacji" na tej stronie. -> - ## Wprowadzenie -Włączenie rozwiązania Intel Software Guard Extensions na serwerze pozwala na uruchamianie aplikacji obsługujących rozszerzenia SGX. -Rozszerzenie Intel SGX zapewnia zaawansowane funkcje szyfrowania sprzętowego oraz zabezpieczenia pamięci RAM, które umożliwiają izolowanie części kodu i danych poszczególnych aplikacji. +Włączenie Intel Software Guard Extensions (SGX) na Twoim serwerze umożliwia uruchamianie aplikacji kompatybilnych z SGX. Intel SGX zapewnia zaawansowane funkcje szyfrowania bezpieczeństwa sprzętu i pamięci RAM, aby izolować określone części kodu i danych dla każdej aplikacji. + +**Ten przewodnik wyjaśnia, jak włączyć funkcję SGX za pomocą Panelu klienta OVHcloud lub za pomocą API OVHcloud.** ## Wymagania początkowe -- Dedykowany serwer kompatybilny z opcją [SGX](https://www.ovhcloud.com/pl/bare-metal/intel-software-guard-extensions/) -- Posiadanie danych do logowania otrzymanych w e-mailu po zakończonej instalacji -- Dostęp do [Panelu klienta OVHcloud](/links/manager) lub [API OVHcloud](/links/api) -- Zainstalowana na serwerze dystrybucja Ubuntu 18.04 lub podobna +- Dostęp do [Panelu klienta OVHcloud](/links/manager) lub do [API OVHcloud](/links/api) +- Serwer dedykowany kompatybilny z [opcją SGX](/links/bare-metal/sgx) w Twoim koncie OVHcloud +- Dane logowania otrzymane e-mailem po instalacji +- Na serwerze zainstalowany jest Ubuntu 24.04 lub równoważny system ## W praktyce -### W Panelu klienta OVHcloud - -Zaloguj się do [Panelu klienta OVHcloud](/links/manager), przejdź do sekcji `Bare Metal Cloud`{.action} i wybierz serwer, na którym chcesz włączyć SGX w sekcji **Serwery Dedykowane** w menu po lewej stronie. - -#### Włączenie opcji - -Przejdź do strefy `Zaawansowane funkcje` funkcje i kliknij `...`{.action} naprzeciwko "Bezpieczeństwo - Intel SGX (Software Guard Extensions)". Wybierz `Włącz SGX`{.action} z rozwijanego menu. - -![activation SGX](images/enable_sgx.png){.thumbnail} - -Na następnym ekranie kliknij przycisk `Włącz`{.action}. - -![activation SGX](images/enable_sgx2.png){.thumbnail} - -Możesz aktywować SGX z określoną ilością pamięci zarezerwowanej lub włączyć ją, pozwalając programowi na automatyczne zarezerwowanie pamięci. Po dokonaniu wyboru kliknij `Zatwierdź`{.action}. - -![activation SGX](images/manage_sgx.png){.thumbnail} - -Pojawi się potwierdzenie pop-up. Potwierdź, że zapoznałeś się z aktywowaniem technologii Intel SGX i wymaga restartu serwera. - -![aktywacja SGX](images/confirmation-popup_sgx.png){.thumbnail} - -> [!warning] -> -> W zależności od serwera, operacja ta spowoduje 1 restartów serwera. - -#### Wyłączenie opcji - -Przejdź do strefy `Zaawansowane funkcje` funkcje i kliknij `...`{.action} naprzeciwko "Bezpieczeństwo - Intel SGX (Software Guard Extensions)". Wybierz `Zmień SGX`{.action} z rozwijanego menu. Wybierz opcję `Wyłącz`{.action}, następnie kliknij `Zatwierdź`{.action}. - -![Wyłączenie funkcji SGX](images/disable_sgx.png){.thumbnail} - -> [!warning] -> -> W zależności od serwera, operacja ta spowoduje 1 restartów serwera. - -Przejdź do poniższego przewodnika [etap 3](#sgx-softwares). - -### Za pośrednictwem API OVHcloud - -#### Krok 1\. Logowanie do konsoli API - -Przejdź do strony i kliknij przycisk `Login`{.action} (Zaloguj) w prawym górnym rogu. -Na następnej stronie zaloguj się przy użyciu danych logowania do konta OVHcloud. - -#### Krok 2\. Włączenie funkcji SGX - -Uzyskaj nazwę swojego serwera z listy zwróconej po wywołaniu następującej procedury: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server - -Sprawdź, czy usługa ma włączoną opcję SGX, wywołując następującą procedurę: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/biosSettings/sgx - -![SGX disabled](images/get-disabled.png){.thumbnail} - -Następnie włącz funkcję SGX: - -> [!warning] -> -> W zależności od serwera, operacja ta spowoduje 1 restartów serwera. - -> [!api] -> -> @api {v1} /dedicated/server POST /dedicated/server/{serviceName}/biosSettings/sgx/configure - -![Configure SGX](images/post-configure.png){.thumbnail} - -Sprawdź postęp zadania konfiguracji, wywołując następujący punkt końcowy przy użyciu identyfikatora zadania (taskid) zwróconego przez poprzednie wywołanie: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/task/{taskId} - -![Get SGX configuration task](images/get-task.png){.thumbnail} - -Teraz można sprawdzić, że status to “włączono” (enabled): - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/biosSettings/sgx - -![SGX enabled](images/get-enabled.png){.thumbnail} - -#### Krok 3\. Zainstalowanie zestawu oprogramowania SGX - -Teraz zostaną zainstalowane sterownik i zestaw SDK Intel, które umożliwiają tworzenie oraz uruchamianie aplikacji SGX. - -Najpierw zainstaluj zależności: +### Włączenie SGX + +Aktywacja SGX jest możliwa za pośrednictwem Panelu Klienta OVHcloud, API OVHcloud lub BIOS serwera. + +> [!tabs] +> **Za pomocą Panelu klienta OVHcloud** +>> +>> **1 - Logowanie do Panelu klienta OVHcloud** +>> +>> Zaloguj się do [Panelu klienta OVHcloud](/links/manager), przejdź do sekcji `Bare Metal Cloud`{.action} i kliknij `Serwery dedykowane`{.action}. Następnie wybierz serwer, na którym chcesz włączyć SGX. +>> +>> **2 - Włączenie SGX** +>> +>> W zakładce `Informacje ogólne`{.action}, w ramce **Zaawansowane funkcje**, kliknij `...`{.action} obok wpisu **Bezpieczeństwo - Intel SGX (Software Guard Extensions)** i wybierz `Włącz SGX`{.action} z menu rozwijanego. +>> +>> ![Włączenie SGX](images/enable_sgx.png){.thumbnail} +>> +>> Na następnym ekranie kliknij przycisk `Włącz`{.action}. +>> +>> ![Włączenie SGX](images/enable_sgx2.png){.thumbnail} +>> +>> Możesz wybrać opcję włączenia SGX z określoną ilością zastrzeżonej pamięci lub pozwolić aplikacji automatycznie rezerwować potrzebną pamięć. Po dokonaniu wyboru kliknij `Potwierdź`{.action}. +>> +>> ![Zarządzanie SGX](images/manage_sgx.png){.thumbnail} +>> +>> Wyświetlony zostanie ekran potwierdzenia. Potwierdź, że rozumiesz, iż włączenie technologii Intel SGX spowoduje ponowne uruchomienie Twojego serwera. +>> +>> ![Włączenie SGX](images/confirmation-popup_sgx.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Spowoduje to jedno lub więcej ponownych uruchomień serwera, w zależności od jego modelu. +>> +> **Za pomocą API OVHcloud** +>> +>> **1 - Logowanie do konsoli API** +>> +>> Na stronie [API OVHcloud](/links/console): +>> +>> - Kliknij `Authentication`{.action} w lewym górnym rogu. +>> - Następnie kliknij `Login with OVHcloud SSO`{.action}. +>> - Wprowadź swoje dane logowania do OVHcloud. +>> - Kliknij przycisk `Authorize`{.action}, aby zezwolić na wywoływanie API z tego miejsca. +>> +>> **2 - Włączenie SGX** +>> +>> Pobierz nazwę swojego serwera z listy zwróconej przez następujące wywołanie: +>> +>> > [!api] +>> > +>> > @api {v1} /dedicated/server GET /dedicated/server +>> +>> Sprawdź, czy Twój serwis obsługuje opcję SGX, korzystając z tego wywołania: +>> +>> > [!api] +>> > +>> > @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/biosSettings/sgx +>> +>> ![SGX wyłączony](images/get-disabled.png){.thumbnail} +>> +>> Włącz SGX, korzystając z nazwy serwera: +>> +>> > [!warning] +>> > +>> > Spowoduje to jedno lub więcej ponownych uruchomień serwera, w zależności od jego modelu. +>> +>> > [!api] +>> > +>> > @api {v1} /dedicated/server POST /dedicated/server/{serviceName}/biosSettings/sgx/configure +>> +>> ![Konfiguracja SGX](images/post-configure.png){.thumbnail} +>> +>> Sprawdź postęp zadania konfiguracji, wywołując ten punkt końcowy z *taskId* zwróconym w poprzednim wywołaniu: +>> +>> > [!api] +>> > +>> > @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/task/{taskId} +>> +>> ![Pobierz zadanie konfiguracji SGX](images/get-task.png){.thumbnail} +>> +>> Możesz sprawdzić, czy stan jest włączony: +>> +>> > [!api] +>> > +>> > @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/biosSettings/sgx +>> +>> ![SGX włączony](images/get-enabled.png){.thumbnail} +>> +> **Ręczna konfiguracja w BIOS-ie** +>> +>> **1 - Uruchom sesję Remote KVM** +>> +>> Zaloguj się do [Panelu klienta OVHcloud](/links/manager), przejdź do sekcji `Bare Metal Cloud`{.action} i kliknij `Serwery dedykowane`{.action}. Następnie wybierz serwer, na którym chcesz włączyć SGX. +>> +>> W zakładce `IPMI / KMV`{.action} uruchom sesję Remote KVM: +>> +>> ![Uruchom sesję Remote KVM](images/manager.png){.thumbnail} +>> +>> **2 - Włączenie SGX** +>> +>> Następnie, z poziomu KVM, uruchom ponownie serwer i wejdź do BIOS-u (zazwyczaj naciskając klawisz `DEL`{.action} lub `F2`{.action}). +>> +>> W BIOS-ie przejdź do sekcji `Advanced` > `Processor Configuration`. +>> +>> Włącz opcje TME i SGX oraz skonfiguruj pożądaną wielkość PRMRR: +>> +>> ![Włączenie SGX](images/sgx_bios.png){.thumbnail} +>> +>> Zapisz zmiany, naciskając klawisz `F10`{.action}. Wyświetlony zostanie ekran potwierdzenia, potwierdź opcję `Yes`. +>> +>> Twój serwer ponownie uruchomi się na systemie operacyjnym. +>> + +### Instalacja oprogramowania SGX + +Użyj poniższych poleceń, aby zainstalować SDK firmy Intel, dzięki czemu będziesz mógł tworzyć i uruchamiać aplikacje SGX. + +Najpierw zainstaluj kilka zależności: ```bash -sudo apt-get install build-essential ocaml ocamlbuild automake autoconf libtool wget python libssl-dev libcurl4-openssl-dev protobuf-compiler libprotobuf-dev debhelper cmake git +sudo apt update +sudo apt install autoconf automake build-Essential cmake debhelper git libcurl4-openssl-dev libprotobuf-dev libssl-dev libtool lsb-release ocaml ocamlbuild protobuf-compiler python-is-python3 reprepro wget perl unzip pkgconf libboost-dev libboost-system-dev libboost-thread-dev libsystemd0 ``` -Następnie pobierz, zbuduj i zainstaluj zestaw oprogramowania SGX: +Następnie pobierz kod źródłowy i przygotuj podmoduły oraz gotowe binarki: ```bash BASE_DIR=/opt/intel [[ -d $BASE_DIR ]] || sudo mkdir -p $BASE_DIR && sudo chown `whoami` $BASE_DIR cd $BASE_DIR - + git clone https://github.com/intel/linux-sgx.git - + cd linux-sgx -git checkout sgx_2.6 -./download_prebuilt.sh -make -j 6 -make sdk_install_pkg -j 6 -make deb_pkg -j 6 -$BASE_DIR/linux-sgx/linux/installer/bin/sgx_linux_x64_sdk_2.6.100.51363.bin --prefix=$BASE_DIR/ - -sudo dpkg -i $BASE_DIR/linux-sgx/linux/installer/deb/libsgx-urts_2.6.100.51363-bionic1_amd64.deb $BASE_DIR/linux-sgx/linux/installer/deb/libsgx-enclave-common_2.6.100.51363-bionic1_amd64.deb +git checkout sgx_2.26 +make preparation ``` -Pobierz i zainstaluj sterownik: +Skompiluj i zainstaluj SDK SGX: ```bash -wget https://download.01.org/intel-sgx/linux-2.6/ubuntu18.04-server/sgx_linux_x64_driver_2.5.0_2605efa.bin -chmod +x sgx_linux_x64_driver_2.5.0_2605efa.bin -sudo ./sgx_linux_x64_driver_2.5.0_2605efa.bin +make sdk_install_pkg +$ ./linux/installer/bin/sgx_linux_x64_sdk_2.26.100.0.bin --prefix=$BASE_DIR/ ``` -#### Krok 4\. Ponowne uruchomienie w celu ukończenia instalacji - -#### Krok 5\. Sprawdzenie poprawności instalacji przy użyciu przykładowej aplikacji +### Testowanie przykładowej aplikacji w trybie symulacji -Zbuduj jedną z udostępnionych przykładowych aplikacji: +Aby skompilować i uruchomić przykładowy kod *LocalAttestation* w trybie symulacji: ```bash BASE_DIR=/opt/intel cd $BASE_DIR/sgxsdk/SampleCode/LocalAttestation/ source $BASE_DIR/sgxsdk/environment -make SGX_DEBUG=0 SGX_MODE=HW SGX_PRERELEASE=1 + +make clean +SGX_MODE=SIM make +cd bin +./app +succeed to load enclaves. +succeed to establish secure channel. +Succeed to exchange secure message... +Succeed to close Session... ``` -Uruchom ją: - -```bash -ovh@nsXXXX:/opt/intel/sgxsdk/SampleCode/LocalAttestation$ ./app - -Available Enclaves -Enclave1 - EnclaveID 2 -Enclave2 - EnclaveID 3 -Enclave3 - EnclaveID 4 - -Secure Channel Establishment between Source (E1) and Destination (E2) Enclaves successful !!! - -Enclave to Enclave Call between Source (E1) and Destination (E2) Enclaves successful !!! - -Message Exchange between Source (E1) and Destination (E2) Enclaves successful !!! +### Budowanie i instalowanie oprogramowania PSW Intel SGX -Secure Channel Establishment between Source (E1) and Destination (E3) Enclaves successful !!! +Oprogramowanie Intel SGX Platform Software (PSW) dostarcza bibliotek, które umożliwiają uruchamianie aplikacji SGX w trybie sprzętowym. Aby utworzyć lokalny repozytorium Debian, które będzie hostować pakiety, uruchom poniższe polecenia: -Enclave to Enclave Call between Source (E1) and Destination (E3) Enclaves successful !!! - -Message Exchange between Source (E1) and Destination (E3) Enclaves successful !!! - -Secure Channel Establishment between Source (E2) and Destination (E3) Enclaves successful !!! - -Enclave to Enclave Call between Source (E2) and Destination (E3) Enclaves successful !!! - -Message Exchange between Source (E2) and Destination (E3) Enclaves successful !!! - -Secure Channel Establishment between Source (E3) and Destination (E1) Enclaves successful !!! +```bash +BASE_DIR=/opt/intel +cd $BASE_DIR/linux-sgx +make deb_local_repo +``` -Enclave to Enclave Call between Source (E3) and Destination (E1) Enclaves successful !!! +Utwórz następujący plik, aby dodać lokalne repozytorium pakietów Debian do systemu konfiguracji repozytoriów: -Message Exchange between Source (E3) and Destination (E1) Enclaves successful !!! +```bash +$ cat /etc/apt/sources.list.d/sgx.sources +Types: deb +URIs: file:/opt/intel/linux-sgx/linux/installer/deb/sgx_debian_local_repo +Suites: noble +Components: main +trusted: yes +``` -Close Session between Source (E1) and Destination (E2) Enclaves successful !!! +Następnie zainstaluj poniższe pakiety: -Close Session between Source (E1) and Destination (E3) Enclaves successful !!! +```bash +sudo apt update +sudo apt-get install libsgx-epid libsgx-quote-ex libsgx-dcap-ql +``` -Close Session between Source (E2) and Destination (E3) Enclaves successful !!! +### Testowanie przykładowej aplikacji w trybie sprzętowym (opcjonalnie) -Close Session between Source (E3) and Destination (E1) Enclaves successful !!! +Aby skompilować i uruchomić przykładowy kod *LocalAttestation* w trybie sprzętowym: -Hit a key.... +```bash +BASE_DIR=/opt/intel +cd $BASE_DIR/sgxsdk/SampleCode/LocalAttestation/ +source $BASE_DIR/sgxsdk/environment + +make clean +SGX_MODE=HW make +cd bin +./app +succeed to load enclaves. +succeed to establish secure channel. +Succeed to exchange secure message... +Succeed to close Session... ``` -## Idź dalej +## Sprawdź również -Oto kilka zasobów przydatnych do dalszych działań (utworzenia własnej aplikacji, rejestracji w usłudze zdalnego zaświadczania itd.): +Aby dowiedzieć się więcej (np. jak opracować własną aplikację, zarejestrować się do zdalnej attestacji itp.), oto przydatne zasoby: -- [Rozwiązanie Intel SGX](https://www.intel.pl/content/www/pl/pl/architecture-and-technology/software-guard-extensions.html) -- [Usługi Intel SGX Attestation](https://software.intel.com/en-us/sgx/attestation-services) -- [Dokumentacja Intel SGX linux-2.6](https://download.01.org/intel-sgx/linux-2.6/docs/) -- [github.com/intel/linux-sgx](https://github.com/intel/linux-sgx) -- [github.com/intel/linux-sgx-driver](https://github.com/intel/linux-sgx-driver) -- [github.com/intel/sgx-ra-sample](https://github.com/intel/sgx-ra-sample) +- [Intel SGX](https://software.intel.com/en-us/sgx) +- [Intel SGX Attestation services](https://software.intel.com/en-us/sgx/attestation-services) +- [Intel SGX linux-2.26 documentation](https://download.01.org/intel-sgx/sgx-linux/2.26/docs/) +- [github.com/intel/linux-sgx](https://github.com/intel/linux-sgx) \ No newline at end of file diff --git a/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.pt-pt.md b/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.pt-pt.md index ce6d22aede4..e53558c7e44 100644 --- a/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.pt-pt.md +++ b/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/guide.pt-pt.md @@ -1,219 +1,240 @@ --- -title: 'Ativar Intel SGX no seu servidor dedicado' -excerpt: 'Ative a opção SGX no seu servidor Infraestrutura ou Advance e instale a pilha de software SGX para Linux' -updated: 2022-08-31 +title: "Como gerir Intel SGX num servidor dedicado" +excerpt: "Descubra como ativar a opção SGX no seu servidor dedicado e instalar a pilha de software SGX para Linux" +updated: 2025-11-20 --- -> [!primary] -> Esta tradução foi automaticamente gerada pelo nosso parceiro SYSTRAN. Em certos casos, poderão ocorrer formulações imprecisas, como por exemplo nomes de botões ou detalhes técnicos. Recomendamos que consulte a versão inglesa ou francesa do manual, caso tenha alguma dúvida. Se nos quiser ajudar a melhorar esta tradução, clique em "Contribuir" nesta página. -> +## Objetivo -## Sumário +A ativação das Intel Software Guard Extensions (SGX) no seu servidor permite executar aplicações compatíveis com SGX. As Intel SGX fornecem funcionalidades avançadas de encriptação de segurança de hardware e memória RAM, para isolar partes específicas de código e dados para cada aplicação. -Ativar o Intel Software Guard Extensions no seu servidor, para poder executar aplicações preparadas para SGX -O Intel SGX oferece funcionalidades avançadas de encriptação de segurança para hardware e RAM, com o objetivo de isolar partes do código e dos dados específicas de cada aplicação. +**Este guia explica como ativar a funcionalidade SGX, através do área de cliente OVHcloud ou através da API OVHcloud.** ## Requisitos -- Um servidor dedicado compatível com a opção [SGX](https://www.ovhcloud.com/pt/bare-metal/intel-software-guard-extensions/) -- Ter acesso a credenciais de início de sessão que recebeu por correio eletrónico após a instalação -- Ter acesso à [Área de Cliente OVHcloud](/links/manager) ou à [API OVHcloud](/links/api) -- Ubuntu 18.04 ou semelhante instalado no servidor +- Aceder ao [área de cliente OVHcloud](/links/manager) ou à [API OVHcloud](/links/api) +- Ter um servidor dedicado compatível com [a opção SGX](/links/bare-metal/sgx) no seu conta OVHcloud +- Dispor das credenciais recebidas por e-mail após a instalação +- Ubuntu 24.04 ou equivalente está instalado no servidor ## Instruções -### A partir da Área de Cliente OVHcloud - -Ligue-se à [Área de Cliente OVHcloud](/links/manager), aceda à secção `Bare Metal Cloud`{.action} e selecione o servidor no qual deseja ativar SGX na secção **Servidores dedicados** do menu à esquerda. - -#### Ativação da opção - -Desça até à zona `Funcionalidades de nível avançado` e clique em `...`{.action} em face de "Segurança - Intel SGX (Software Guard Extension)". Selecione `Ativar SGX`{.action} no menu pendente. - -![ativação SGX](images/enable_sgx.png){.thumbnail} - -No ecrã seguinte, clique no botão `Ativar`{.action}. - -![ativação SGX](images/enable_sgx2.png){.thumbnail} - -Pode optar por ativar SGX com uma quantidade específica de memória reservada ou ativá-la permitindo ao seu software reservar automaticamente a memória de que precisa. Depois de escolher, clique em `Confirmar`{.action}. - -![ativação SGX](images/manage_sgx.png){.thumbnail} - -Aparecerá um pop-up de confirmação, confirme que tomou conhecimento que a ativação da tecnologia Intel SGX requer o(s) reboot(s) do seu servidor. - -![ativação SGX](images/confirmation-popup_sgx.png){.thumbnail} - -> [!warning] -> -> Em função do servidor, esta ação levará 1 a várias reinicializações do mesmo. - -#### Desativação da opção - -Desça até à zona `Funcionalidades de nível avançado` e clique em `...`{.action} em face de "Segurança - Intel SGX (Software Guard Extension)". Selecione `Alterar SGX`{.action} no menu pendente. Escolha a opção `Desativar`{.action} e clique em `Confirmar`{.action}. - -![Desativação do SGX](images/disable_sgx.png){.thumbnail} - -> [!warning] -> -> Em função do servidor, esta ação levará 1 a várias reinicializações do mesmo. - -Consulte este guia na [etapa 3](#sgx-softwares) abaixo. - -### A partir da API OVHcloud - -#### Passo 1 - Aceder à consola da API - -Aceda a e clique em `Iniciar sessão`{.action} no canto superior direito da página. -Na página seguinte, inicie a sessão com as credenciais da sua conta OVHcloud. - -#### Passo 2 - Ativar o SGX - -Obtenha o nome do seu servidor na lista devolvida pela seguinte chamada: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server - -Verifique se o seu serviço tem a opção SGX, chamando: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/biosSettings/sgx - -![SGX disabled](images/get-disabled.png){.thumbnail} - -Em seguida, ative o SGX: - -> [!warning] -> -> Em função do servidor, esta ação levará 1 a várias reinicializações do mesmo. - -> [!api] -> -> @api {v1} /dedicated/server POST /dedicated/server/{serviceName}/biosSettings/sgx/configure - -![Configure SGX](images/post-configure.png){.thumbnail} - -Verifique o progresso da tarefa de configuração, chamando este endpoint com a taskId devolvida pela chamada anterior: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/task/{taskId} - -![Get SGX configuration task](images/get-task.png){.thumbnail} - -Pode verificar se o estado está agora ativado: - -> [!api] -> -> @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/biosSettings/sgx - -![SGX enabled](images/get-enabled.png){.thumbnail} - -#### Passo 3 - Instalar a pilha de software SGX - -Agora iremos instalar o driver Intel e o SDK para poder desenvolver e executar aplicações SGX. - -Primeiro, vamos instalar algumas dependências: +### Ativar SGX + +A ativação do SGX é possível a partir do área de cliente OVHcloud, da API OVHcloud ou do BIOS do seu servidor. + +> [!tabs] +> **Via área de cliente OVHcloud** +>> +>> **1 - Conexão ao área de cliente OVHcloud** +>> +>> Conecte-se ao [área de cliente OVHcloud](/links/manager), aceda à secção `Bare Metal Cloud`{.action} e clique em `Servidores dedicados`{.action}. Selecione em seguida o servidor no qual pretende ativar o SGX. +>> +>> **2 - Ativar SGX** +>> +>> A partir do separador `Informações gerais`{.action}, no quadro **Funcionalidades de nível avançado**, clique em `...`{.action} ao lado da menção **Segurança - Intel SGX (Software Guard Extensions)** e selecione `Ativar SGX`{.action} no menu suspenso. +>> +>> ![Ativação SGX](images/enable_sgx.png){.thumbnail} +>> +>> Na tela seguinte, clique no botão `Ativar`{.action}. +>> +>> ![Ativação SGX](images/enable_sgx2.png){.thumbnail} +>> +>> Pode escolher ativar o SGX com uma quantidade específica de memória reservada ou permitindo que a sua aplicação reserve automaticamente a memória de que necessita. Após a sua escolha, clique em `Confirmar`{.action}. +>> +>> ![Gestão SGX](images/manage_sgx.png){.thumbnail} +>> +>> Uma janela de confirmação aparecerá. Confirme que compreendeu que a ativação da tecnologia Intel SGX provocará um reinício do seu servidor. +>> +>> ![Ativação SGX](images/confirmation-popup_sgx.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Isto provocará um ou mais reinícios do seu servidor, dependendo do seu modelo. +>> +> **Via API OVHcloud** +>> +>> **1 - Conexão à consola API** +>> +>> Na página das [API OVHcloud](/links/console): +>> +>> - Clique em `Authentication`{.action} no canto superior esquerdo. +>> - Clique depois em `Login with OVHcloud SSO`{.action}. +>> - Introduza as suas credenciais OVHcloud. +>> - Clique no botão `Authorize`{.action} para autorizar as chamadas às APIs a partir deste site. +>> +>> **2 - Ativar SGX** +>> +>> Obtenha o nome do seu servidor na lista devolvida pela seguinte chamada: +>> +>> > [!api] +>> > +>> > @api {v1} /dedicated/server GET /dedicated/server +>> +>> Verifique se o seu serviço dispõe da opção SGX utilizando este chamada: +>> +>> > [!api] +>> > +>> > @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/biosSettings/sgx +>> +>> ![SGX desativado](images/get-disabled.png){.thumbnail} +>> +>> Ative o SGX utilizando o nome do servidor: +>> +>> > [!warning] +>> > +>> > Isto provocará um ou mais reinícios do seu servidor, dependendo do seu modelo. +>> +>> > [!api] +>> > +>> > @api {v1} /dedicated/server POST /dedicated/server/{serviceName}/biosSettings/sgx/configure +>> +>> ![Configuração SGX](images/post-configure.png){.thumbnail} +>> +>> Verifique o progresso da tarefa de configuração chamando este ponto final com o *taskId* devolvido pela chamada anterior: +>> +>> > [!api] +>> > +>> > @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/task/{taskId} +>> +>> ![Obter a tarefa de configuração SGX](images/get-task.png){.thumbnail} +>> +>> Pode verificar que o estado está ativado: +>> +>> > [!api] +>> > +>> > @api {v1} /dedicated/server GET /dedicated/server/{serviceName}/biosSettings/sgx +>> +>> ![SGX ativado](images/get-enabled.png){.thumbnail} +>> +> **Configuração manual no BIOS** +>> +>> **1 - Iniciar uma sessão Remote KVM** +>> +>> Conecte-se ao [área de cliente OVHcloud](/links/manager), aceda à secção `Bare Metal Cloud`{.action} e clique em `Servidores dedicados`{.action}. Selecione em seguida o servidor no qual pretende ativar o SGX. +>> +>> A partir do separador `IPMI / KMV`{.action}, inicie uma sessão Remote KVM: +>> +>> ![Iniciar uma sessão Remote KVM](images/manager.png){.thumbnail} +>> +>> **2 - Ativar SGX** +>> +>> Em seguida, a partir do KVM, inicie um reinício do servidor e entre no BIOS (normalmente premindo a tecla `DEL`{.action} ou `F2`{.action}). +>> +>> No BIOS, dirija-se à parte `Advanced` > `Processor Configuration`. +>> +>> Ative as Opções TME e SGX e configure o tamanho PRMRR desejado: +>> +>> ![Ativar SGX](images/sgx_bios.png){.thumbnail} +>> +>> Guarde as alterações premindo a tecla `F10`{.action}. Uma janela de confirmação aparecerá, confirme com a opção `Yes`. +>> +>> O seu servidor reiniciará depois no seu sistema operativo. +>> + +### Instalar a pilha de software SGX + +Use os seguintes comandos para instalar o SDK da Intel para poder desenvolver e executar aplicações SGX. + +Primeiro, instale algumas dependências: ```bash -sudo apt-get install build-essential ocaml ocamlbuild automake autoconf libtool wget python libssl-dev libcurl4-openssl-dev protobuf-compiler libprotobuf-dev debhelper cmake git +sudo apt update +sudo apt install autoconf automake build-Essential cmake debhelper git libcurl4-openssl-dev libprotobuf-dev libssl-dev libtool lsb-release ocaml ocamlbuild protobuf-compiler python-is-python3 reprepro wget perl unzip pkgconf libboost-dev libboost-system-dev libboost-thread-dev libsystemd0 ``` -Em seguida, descarregue, construa e instale a pilha de software SGX: +Em seguida, descarregue o código fonte e prepare os submódulos e os binários prontos a usar: ```bash BASE_DIR=/opt/intel [[ -d $BASE_DIR ]] || sudo mkdir -p $BASE_DIR && sudo chown `whoami` $BASE_DIR cd $BASE_DIR - + git clone https://github.com/intel/linux-sgx.git - + cd linux-sgx -git checkout sgx_2.6 -./download_prebuilt.sh -make -j 6 -make sdk_install_pkg -j 6 -make deb_pkg -j 6 -$BASE_DIR/linux-sgx/linux/installer/bin/sgx_linux_x64_sdk_2.6.100.51363.bin --prefix=$BASE_DIR/ - -sudo dpkg -i $BASE_DIR/linux-sgx/linux/installer/deb/libsgx-urts_2.6.100.51363-bionic1_amd64.deb $BASE_DIR/linux-sgx/linux/installer/deb/libsgx-enclave-common_2.6.100.51363-bionic1_amd64.deb +git checkout sgx_2.26 +make preparation ``` -Descarregue e instale o driver: +Construa e instale o SDK SGX: ```bash -wget https://download.01.org/intel-sgx/linux-2.6/ubuntu18.04-server/sgx_linux_x64_driver_2.5.0_2605efa.bin -chmod +x sgx_linux_x64_driver_2.5.0_2605efa.bin -sudo ./sgx_linux_x64_driver_2.5.0_2605efa.bin +make sdk_install_pkg +$ ./linux/installer/bin/sgx_linux_x64_sdk_2.26.100.0.bin --prefix=$BASE_DIR/ ``` -#### Passo 4 - Reiniciar para concluir a instalação +### Testar a aplicação de exemplo no modo simulador -#### Passo 5 - Utilizar uma aplicação exemplo para validar a instalação - -Construa uma das aplicações exemplo fornecidas: +Para construir e executar o código de exemplo *LocalAttestation* no modo simulador: ```bash BASE_DIR=/opt/intel cd $BASE_DIR/sgxsdk/SampleCode/LocalAttestation/ source $BASE_DIR/sgxsdk/environment -make SGX_DEBUG=0 SGX_MODE=HW SGX_PRERELEASE=1 + +make clean +SGX_MODE=SIM make +cd bin +./app +succeed to load enclaves. +succeed to establish secure channel. +Succeed to exchange secure message... +Succeed to close Session... ``` -Execute-a: - -```bash -ovh@nsXXXX:/opt/intel/sgxsdk/SampleCode/LocalAttestation$ ./app - -Available Enclaves -Enclave1 - EnclaveID 2 -Enclave2 - EnclaveID 3 -Enclave3 - EnclaveID 4 - -Secure Channel Establishment between Source (E1) and Destination (E2) Enclaves successful !!! - -Enclave to Enclave Call between Source (E1) and Destination (E2) Enclaves successful !!! - -Message Exchange between Source (E1) and Destination (E2) Enclaves successful !!! - -Secure Channel Establishment between Source (E1) and Destination (E3) Enclaves successful !!! +### Construir e instalar o PSW Intel SGX -Enclave to Enclave Call between Source (E1) and Destination (E3) Enclaves successful !!! +O software Intel SGX Platform Software (PSW) fornece bibliotecas de software que permitem executar aplicações SGX no modo hardware. Para criar o repositório Debian local que aloja os pacotes, execute os seguintes comandos: -Message Exchange between Source (E1) and Destination (E3) Enclaves successful !!! - -Secure Channel Establishment between Source (E2) and Destination (E3) Enclaves successful !!! - -Enclave to Enclave Call between Source (E2) and Destination (E3) Enclaves successful !!! - -Message Exchange between Source (E2) and Destination (E3) Enclaves successful !!! - -Secure Channel Establishment between Source (E3) and Destination (E1) Enclaves successful !!! +```bash +BASE_DIR=/opt/intel +cd $BASE_DIR/linux-sgx +make deb_local_repo +``` -Enclave to Enclave Call between Source (E3) and Destination (E1) Enclaves successful !!! +Crie o seguinte ficheiro para adicionar o repositório local de pacotes Debian ao sistema de configuração dos repositórios: -Message Exchange between Source (E3) and Destination (E1) Enclaves successful !!! +```bash +$ cat /etc/apt/sources.list.d/sgx.sources +Types: deb +URIs: file:/opt/intel/linux-sgx/linux/installer/deb/sgx_debian_local_repo +Suites: noble +Components: main +trusted: yes +``` -Close Session between Source (E1) and Destination (E2) Enclaves successful !!! +Em seguida, instale os seguintes pacotes: -Close Session between Source (E1) and Destination (E3) Enclaves successful !!! +```bash +sudo apt update +sudo apt-get install libsgx-epid libsgx-quote-ex libsgx-dcap-ql +``` -Close Session between Source (E2) and Destination (E3) Enclaves successful !!! +### Testar a aplicação de exemplo no modo hardware (opcional) -Close Session between Source (E3) and Destination (E1) Enclaves successful !!! +Para construir e executar o código de exemplo *LocalAttestation* no modo hardware: -Hit a key.... +```bash +BASE_DIR=/opt/intel +cd $BASE_DIR/sgxsdk/SampleCode/LocalAttestation/ +source $BASE_DIR/sgxsdk/environment + +make clean +SGX_MODE=HW make +cd bin +./app +succeed to load enclaves. +succeed to establish secure channel. +Succeed to exchange secure message... +Succeed to close Session... ``` ## Quer saber mais? -Seguem-se alguns recursos úteis que lhe permitem ir mais longe (desenvolver a sua própria aplicação, registar-se para atestado remoto...): +Para ir mais longe (desenvolver a sua própria aplicação, inscrever-se na atestado remoto, etc.), aqui estão algumas recursos úteis: - [Intel SGX](https://software.intel.com/en-us/sgx) -- [Serviços de Atestado Intel SGX](https://software.intel.com/en-us/sgx/attestation-services) -- [Documentação Intel SGX Linux-2.6](https://download.01.org/intel-sgx/linux-2.6/docs/) -- [github.com/intel/linux-sgx](https://github.com/intel/linux-sgx) -- [github.com/intel/linux-sgx-driver](https://github.com/intel/linux-sgx-driver) -- [github.com/intel/sgx-ra-sample](https://github.com/intel/sgx-ra-sample) +- [Intel SGX Attestation services](https://software.intel.com/en-us/sgx/attestation-services) +- [Intel SGX linux-2.26 documentation](https://download.01.org/intel-sgx/sgx-linux/2.26/docs/) +- [github.com/intel/linux-sgx](https://github.com/intel/linux-sgx) \ No newline at end of file diff --git a/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/images/disable_sgx.png b/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/images/disable_sgx.png deleted file mode 100644 index a66b7e8f1de..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/images/disable_sgx.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/images/manager.png b/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/images/manager.png new file mode 100644 index 00000000000..86bd51dba3e Binary files /dev/null and b/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/images/manager.png differ diff --git a/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/images/sgx_bios.png b/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/images/sgx_bios.png new file mode 100644 index 00000000000..570eb3891cb Binary files /dev/null and b/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/images/sgx_bios.png differ diff --git a/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/meta.yaml b/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/meta.yaml index c9db315cae4..7644df38a2b 100755 --- a/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/meta.yaml +++ b/pages/bare_metal_cloud/dedicated_servers/sgx-enable-and-use/meta.yaml @@ -1,2 +1,3 @@ id: 9941be24-3b9b-4365-89d1-5188585c40ab -full_slug: dedicated-servers-intel-sgx \ No newline at end of file +full_slug: dedicated-servers-intel-sgx +translation_banner: true \ No newline at end of file diff --git a/pages/bare_metal_cloud/dedicated_servers/sme_sev_enable_and_use/meta.yaml b/pages/bare_metal_cloud/dedicated_servers/sme_sev_enable_and_use/meta.yaml index f5a2e273268..70cec02ef9e 100755 --- a/pages/bare_metal_cloud/dedicated_servers/sme_sev_enable_and_use/meta.yaml +++ b/pages/bare_metal_cloud/dedicated_servers/sme_sev_enable_and_use/meta.yaml @@ -1,3 +1,3 @@ id: fda6da2d-0c4e-4cb0-ba88-6e93d7c00485 full_slug: dedicated-servers-amd-sme-sev -reference_category: bare-metal-cloud-dedicated-servers-tutorials \ No newline at end of file +reference_category: bare-metal-cloud-dedicated-servers-security-hardening \ No newline at end of file diff --git a/pages/bare_metal_cloud/dedicated_servers/veeam-enterprise-server-backup-linux/meta.yaml b/pages/bare_metal_cloud/dedicated_servers/veeam-enterprise-server-backup-linux/meta.yaml index 30696830084..9dc0dd59ddb 100644 --- a/pages/bare_metal_cloud/dedicated_servers/veeam-enterprise-server-backup-linux/meta.yaml +++ b/pages/bare_metal_cloud/dedicated_servers/veeam-enterprise-server-backup-linux/meta.yaml @@ -1,3 +1,3 @@ id: c3bcb18e-79fc-4af6-b846-ea741c36c908 full_slug: veeam-enterprise-server-backup-linux -reference_category: bare-metal-cloud-dedicated-servers-backup-restore \ No newline at end of file +reference_category: bare-metal-cloud-dedicated-servers-security-backup \ No newline at end of file diff --git a/pages/bare_metal_cloud/dedicated_servers/veeam-enterprise-server-backup-preparation/meta.yaml b/pages/bare_metal_cloud/dedicated_servers/veeam-enterprise-server-backup-preparation/meta.yaml index abb4e910671..3b10e850cc0 100644 --- a/pages/bare_metal_cloud/dedicated_servers/veeam-enterprise-server-backup-preparation/meta.yaml +++ b/pages/bare_metal_cloud/dedicated_servers/veeam-enterprise-server-backup-preparation/meta.yaml @@ -1,3 +1,3 @@ id: 32ce6fa5-90d2-4644-bae2-5dd81ff0cea0 full_slug: veeam-enterprise-server-backup-preparation -reference_category: bare-metal-cloud-dedicated-servers-backup-restore \ No newline at end of file +reference_category: bare-metal-cloud-dedicated-servers-security-backup \ No newline at end of file diff --git a/pages/bare_metal_cloud/dedicated_servers/veeam-enterprise-server-backup-windows-agent/meta.yaml b/pages/bare_metal_cloud/dedicated_servers/veeam-enterprise-server-backup-windows-agent/meta.yaml index d76ce973ff8..26f37085b62 100644 --- a/pages/bare_metal_cloud/dedicated_servers/veeam-enterprise-server-backup-windows-agent/meta.yaml +++ b/pages/bare_metal_cloud/dedicated_servers/veeam-enterprise-server-backup-windows-agent/meta.yaml @@ -1,3 +1,3 @@ id: 034859c8-07db-4819-b8e0-9766fbd938e0 full_slug: veeam-enterprise-server-backup-windows -reference_category: bare-metal-cloud-dedicated-servers-backup-restore \ No newline at end of file +reference_category: bare-metal-cloud-dedicated-servers-security-backup \ No newline at end of file diff --git a/pages/bare_metal_cloud/dedicated_servers/veeam-enterprise-server-restore/meta.yaml b/pages/bare_metal_cloud/dedicated_servers/veeam-enterprise-server-restore/meta.yaml index 9bf16b984af..4cf734e137e 100644 --- a/pages/bare_metal_cloud/dedicated_servers/veeam-enterprise-server-restore/meta.yaml +++ b/pages/bare_metal_cloud/dedicated_servers/veeam-enterprise-server-restore/meta.yaml @@ -1,3 +1,3 @@ id: def6660e-d04a-4d85-960f-023b97ed1583 full_slug: veeam-enterprise-server-backup-restore -reference_category: bare-metal-cloud-dedicated-servers-backup-restore \ No newline at end of file +reference_category: bare-metal-cloud-dedicated-servers-security-backup \ No newline at end of file diff --git a/pages/bare_metal_cloud/dedicated_servers/vrack_configuring_on_dedicated_server/images/vrack_selection_2020.png b/pages/bare_metal_cloud/dedicated_servers/vrack_configuring_on_dedicated_server/images/vrack_selection_2020.png deleted file mode 100644 index 3a6d6472ba2..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/vrack_configuring_on_dedicated_server/images/vrack_selection_2020.png and /dev/null differ diff --git a/pages/bare_metal_cloud/dedicated_servers/vulnerability-downfall/meta.yaml b/pages/bare_metal_cloud/dedicated_servers/vulnerability-downfall/meta.yaml index 19384ec6176..f72703d552e 100644 --- a/pages/bare_metal_cloud/dedicated_servers/vulnerability-downfall/meta.yaml +++ b/pages/bare_metal_cloud/dedicated_servers/vulnerability-downfall/meta.yaml @@ -1,3 +1,3 @@ id: df5e29fe-0989-45c4-bfaa-4cbea519e911 full_slug: dedicated-servers-downfall-vulnerability -reference_category: bare-metal-cloud-dedicated-servers-security \ No newline at end of file +reference_category: bare-metal-cloud-dedicated-servers-security-hardening \ No newline at end of file diff --git a/pages/bare_metal_cloud/dedicated_servers/vulnerability-inception/meta.yaml b/pages/bare_metal_cloud/dedicated_servers/vulnerability-inception/meta.yaml index a403707b5b8..57c9ae99962 100644 --- a/pages/bare_metal_cloud/dedicated_servers/vulnerability-inception/meta.yaml +++ b/pages/bare_metal_cloud/dedicated_servers/vulnerability-inception/meta.yaml @@ -1,3 +1,3 @@ id: 36b06efd-f5c1-470c-b407-862752be527a full_slug: dedicated-servers-inception-vulnerability -reference_category: bare-metal-cloud-dedicated-servers-security \ No newline at end of file +reference_category: bare-metal-cloud-dedicated-servers-security-hardening \ No newline at end of file diff --git a/pages/bare_metal_cloud/dedicated_servers/vulnerability-zenbleed/meta.yaml b/pages/bare_metal_cloud/dedicated_servers/vulnerability-zenbleed/meta.yaml index da9b67c3a01..5c6cd9b49f3 100644 --- a/pages/bare_metal_cloud/dedicated_servers/vulnerability-zenbleed/meta.yaml +++ b/pages/bare_metal_cloud/dedicated_servers/vulnerability-zenbleed/meta.yaml @@ -1,3 +1,3 @@ id: 5540420e-8c9e-4b0f-9a1e-c6d50666a91a full_slug: dedicated-servers-zenbleed-vulnerability -reference_category: bare-metal-cloud-dedicated-servers-security \ No newline at end of file +reference_category: bare-metal-cloud-dedicated-servers-security-hardening \ No newline at end of file diff --git a/pages/bare_metal_cloud/dedicated_servers/windows_key/images/Run_cmd.png b/pages/bare_metal_cloud/dedicated_servers/windows_key/images/Run_cmd.png deleted file mode 100644 index 195fb8f7ce0..00000000000 Binary files a/pages/bare_metal_cloud/dedicated_servers/windows_key/images/Run_cmd.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/guide.en-asia.md b/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/guide.en-asia.md index 6528d84fb9a..42770096af9 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/guide.en-asia.md +++ b/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/guide.en-asia.md @@ -42,9 +42,9 @@ Set the storage location (disk space) for this VM. The virtual disk type is on "Thin Provision", which means that a virtual disk will be created but will only use the actual disk space used on the storage, regardless of the disk space previously used on the source VM. -More information about disk types can be found in [this guide](/pages/bare_metal_cloud/managed_bare_metal/choosing-disk-type){.external-link}. +More information about disk types can be found in [this guide](/pages/bare_metal_cloud/managed_bare_metal/choosing-disk-type). -You will be able to choose, via the `VM Storage Policy` row, the default storage policy if you have datastores, or the [VM encryption](/pages/bare_metal_cloud/managed_bare_metal/vm_encrypt){.external-link} option. +You will be able to choose, via the `VM Storage Policy` row, the default storage policy if you have datastores, or the [VM encryption](/pages/bare_metal_cloud/managed_bare_metal/vm_encrypt) option. ![clone a VM](images/clonevm04.png){.thumbnail} diff --git a/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/guide.en-au.md b/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/guide.en-au.md index 96a9179e95d..741e16cbe36 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/guide.en-au.md +++ b/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/guide.en-au.md @@ -42,9 +42,9 @@ Set the storage location (disk space) for this VM. The virtual disk type is on "Thin Provision", which means that a virtual disk will be created but will only use the actual disk space used on the storage, regardless of the disk space previously used on the source VM. -More information about disk types can be found in [this guide](/pages/bare_metal_cloud/managed_bare_metal/choosing-disk-type){.external-link}. +More information about disk types can be found in [this guide](/pages/bare_metal_cloud/managed_bare_metal/choosing-disk-type). -You will be able to choose, via the `VM Storage Policy` row, the default storage policy if you have datastores, or the [VM encryption](/pages/bare_metal_cloud/managed_bare_metal/vm_encrypt){.external-link} option. +You will be able to choose, via the `VM Storage Policy` row, the default storage policy if you have datastores, or the [VM encryption](/pages/bare_metal_cloud/managed_bare_metal/vm_encrypt) option. ![clone a VM](images/clonevm04.png){.thumbnail} diff --git a/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/guide.en-ca.md b/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/guide.en-ca.md index 7758ca51615..0217d9136e6 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/guide.en-ca.md +++ b/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/guide.en-ca.md @@ -42,9 +42,9 @@ Set the storage location (disk space) for this VM. The virtual disk type is on "Thin Provision", which means that a virtual disk will be created but will only use the actual disk space used on the storage, regardless of the disk space previously used on the source VM. -More information about disk types can be found in [this guide](/pages/bare_metal_cloud/managed_bare_metal/choosing-disk-type){.external-link}. +More information about disk types can be found in [this guide](/pages/bare_metal_cloud/managed_bare_metal/choosing-disk-type). -You will be able to choose, via the `VM Storage Policy` row, the default storage policy if you have datastores, or the [VM encryption](/pages/bare_metal_cloud/managed_bare_metal/vm_encrypt){.external-link} option. +You will be able to choose, via the `VM Storage Policy` row, the default storage policy if you have datastores, or the [VM encryption](/pages/bare_metal_cloud/managed_bare_metal/vm_encrypt) option. ![clone a VM](images/clonevm04.png){.thumbnail} diff --git a/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/guide.en-gb.md b/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/guide.en-gb.md index f43b0cd546b..ee15cfc957e 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/guide.en-gb.md +++ b/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/guide.en-gb.md @@ -42,9 +42,9 @@ Set the storage location (disk space) for this VM. The virtual disk type is on "Thin Provision", which means that a virtual disk will be created but will only use the actual disk space used on the storage, regardless of the disk space previously used on the source VM. -More information about disk types can be found in [this guide](/pages/bare_metal_cloud/managed_bare_metal/choosing-disk-type){.external-link}. +More information about disk types can be found in [this guide](/pages/bare_metal_cloud/managed_bare_metal/choosing-disk-type). -You will be able to choose, via the `VM Storage Policy` row, the default storage policy if you have datastores, or the [VM encryption](/pages/bare_metal_cloud/managed_bare_metal/vm_encrypt){.external-link} option. +You will be able to choose, via the `VM Storage Policy` row, the default storage policy if you have datastores, or the [VM encryption](/pages/bare_metal_cloud/managed_bare_metal/vm_encrypt) option. ![clone a VM](images/clonevm04.png){.thumbnail} diff --git a/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/guide.en-ie.md b/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/guide.en-ie.md index b1f44eee0dd..40e4ec6aa91 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/guide.en-ie.md +++ b/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/guide.en-ie.md @@ -42,9 +42,9 @@ Set the storage location (disk space) for this VM. The virtual disk type is on "Thin Provision", which means that a virtual disk will be created but will only use the actual disk space used on the storage, regardless of the disk space previously used on the source VM. -More information about disk types can be found in [this guide](/pages/bare_metal_cloud/managed_bare_metal/choosing-disk-type){.external-link}. +More information about disk types can be found in [this guide](/pages/bare_metal_cloud/managed_bare_metal/choosing-disk-type). -You will be able to choose, via the `VM Storage Policy` row, the default storage policy if you have datastores, or the [VM encryption](/pages/bare_metal_cloud/managed_bare_metal/vm_encrypt){.external-link} option. +You will be able to choose, via the `VM Storage Policy` row, the default storage policy if you have datastores, or the [VM encryption](/pages/bare_metal_cloud/managed_bare_metal/vm_encrypt) option. ![clone a VM](images/clonevm04.png){.thumbnail} diff --git a/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/guide.en-sg.md b/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/guide.en-sg.md index cef4ce3fd65..8e75cd3d595 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/guide.en-sg.md +++ b/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/guide.en-sg.md @@ -42,9 +42,9 @@ Set the storage location (disk space) for this VM. The virtual disk type is on "Thin Provision", which means that a virtual disk will be created but will only use the actual disk space used on the storage, regardless of the disk space previously used on the source VM. -More information about disk types can be found in [this guide](/pages/bare_metal_cloud/managed_bare_metal/choosing-disk-type){.external-link}. +More information about disk types can be found in [this guide](/pages/bare_metal_cloud/managed_bare_metal/choosing-disk-type). -You will be able to choose, via the `VM Storage Policy` row, the default storage policy if you have datastores, or the [VM encryption](/pages/bare_metal_cloud/managed_bare_metal/vm_encrypt){.external-link} option. +You will be able to choose, via the `VM Storage Policy` row, the default storage policy if you have datastores, or the [VM encryption](/pages/bare_metal_cloud/managed_bare_metal/vm_encrypt) option. ![clone a VM](images/clonevm04.png){.thumbnail} diff --git a/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/guide.en-us.md b/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/guide.en-us.md index 0847a42d568..33830b57e1a 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/guide.en-us.md +++ b/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/guide.en-us.md @@ -42,9 +42,9 @@ Set the storage location (disk space) for this VM. The virtual disk type is on "Thin Provision", which means that a virtual disk will be created but will only use the actual disk space used on the storage, regardless of the disk space previously used on the source VM. -More information about disk types can be found in [this guide](/pages/bare_metal_cloud/managed_bare_metal/choosing-disk-type){.external-link}. +More information about disk types can be found in [this guide](/pages/bare_metal_cloud/managed_bare_metal/choosing-disk-type). -You will be able to choose, via the `VM Storage Policy` row, the default storage policy if you have datastores, or the [VM encryption](/pages/bare_metal_cloud/managed_bare_metal/vm_encrypt){.external-link} option. +You will be able to choose, via the `VM Storage Policy` row, the default storage policy if you have datastores, or the [VM encryption](/pages/bare_metal_cloud/managed_bare_metal/vm_encrypt) option. ![clone a VM](images/clonevm04.png){.thumbnail} diff --git a/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/guide.fr-ca.md b/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/guide.fr-ca.md index 20265c9ccaa..df6b85e90bc 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/guide.fr-ca.md +++ b/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/guide.fr-ca.md @@ -42,9 +42,9 @@ Définissez alors l'emplacement de stockage (espace-disque) cette VM. Le format de disque virtuel est de type « Thin Provision » (Provisionnement dynamique), ce qui veut dire qu'un disque virtuel sera créé mais il n'utilisera que l'espace-disque réellement employé sur le stockage, peu importe l'espace-disque précédemment utilisé sur la VM source. -Vous retrouverez plus d'explications sur les formats de disque dans [ce guide](/pages/bare_metal_cloud/managed_bare_metal/choosing-disk-type){.external-link}. +Vous retrouverez plus d'explications sur les formats de disque dans [ce guide](/pages/bare_metal_cloud/managed_bare_metal/choosing-disk-type). -Vous pourrez choisir, via la ligne `VM Storage Policy`, la politique de stockage par défaut si vous avez des datastores, ou l'option [VM encryption](/pages/bare_metal_cloud/managed_bare_metal/vm_encrypt){.external-link}. +Vous pourrez choisir, via la ligne `VM Storage Policy`, la politique de stockage par défaut si vous avez des datastores, ou l'option [VM encryption](/pages/bare_metal_cloud/managed_bare_metal/vm_encrypt). ![stockage vm](images/clonevm04.png){.thumbnail} diff --git a/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/guide.fr-fr.md b/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/guide.fr-fr.md index 657f6bc6220..142aa048f83 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/guide.fr-fr.md +++ b/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/guide.fr-fr.md @@ -42,9 +42,9 @@ Définissez alors l'emplacement de stockage (espace-disque) cette VM. Le format de disque virtuel est de type « Thin Provision » (Provisionnement dynamique), ce qui veut dire qu'un disque virtuel sera créé mais il n'utilisera que l'espace-disque réellement employé sur le stockage, peu importe l'espace-disque précédemment utilisé sur la VM source. -Vous retrouverez plus d'explications sur les formats de disque dans [ce guide](/pages/bare_metal_cloud/managed_bare_metal/choosing-disk-type){.external-link}. +Vous retrouverez plus d'explications sur les formats de disque dans [ce guide](/pages/bare_metal_cloud/managed_bare_metal/choosing-disk-type). -Vous pourrez choisir, via la ligne `VM Storage Policy`, la politique de stockage par défaut si vous avez des datastores, ou l'option [VM encryption](/pages/bare_metal_cloud/managed_bare_metal/vm_encrypt){.external-link}. +Vous pourrez choisir, via la ligne `VM Storage Policy`, la politique de stockage par défaut si vous avez des datastores, ou l'option [VM encryption](/pages/bare_metal_cloud/managed_bare_metal/vm_encrypt). ![stockage vm](images/clonevm04.png){.thumbnail} diff --git a/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/guide.pt-pt.md b/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/guide.pt-pt.md index 31771d25a4b..41229519786 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/guide.pt-pt.md +++ b/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/guide.pt-pt.md @@ -42,9 +42,9 @@ Defina a localização do armazenamento (espaço em disco) desta VM. O formato do disco virtual é de tipo “Thin Provision”, ou seja um disco virtual será criado mas só utilizará o espaço em disco realmente utilizado no armazenamento, independentemente do espaço em disco anteriormente utilizado na VM de origem. -Pode consultar mais informações sobre os formatos de disco [neste manual](/pages/bare_metal_cloud/managed_bare_metal/choosing-disk-type){.external-link}. +Pode consultar mais informações sobre os formatos de disco [neste manual](/pages/bare_metal_cloud/managed_bare_metal/choosing-disk-type). -Poderá escolher, através da linha `VM Storage Policy`, a política de armazenamento predefinida se tiver datastores, ou ainda a opção [VM encryption](/pages/bare_metal_cloud/managed_bare_metal/vm_encrypt){.external-link}. +Poderá escolher, através da linha `VM Storage Policy`, a política de armazenamento predefinida se tiver datastores, ou ainda a opção [VM encryption](/pages/bare_metal_cloud/managed_bare_metal/vm_encrypt). ![armazenamento vm](images/clonevm04.png){.thumbnail} diff --git a/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/images/clone1.jpg b/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/images/clone1.jpg deleted file mode 100644 index ab6b729d0e6..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/images/clone1.jpg and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/images/clone1.png b/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/images/clone1.png deleted file mode 100644 index 065e8c81867..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/images/clone1.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/images/clone2.jpg b/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/images/clone2.jpg deleted file mode 100644 index e4032c4c0c1..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/images/clone2.jpg and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/images/clone2.png b/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/images/clone2.png deleted file mode 100644 index fcbb2fb3832..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/images/clone2.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/images/clone3.jpg b/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/images/clone3.jpg deleted file mode 100644 index bc185a8cec3..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/images/clone3.jpg and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/images/clone3.png b/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/images/clone3.png deleted file mode 100644 index f842ed7a1c1..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/images/clone3.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/images/clone4.jpg b/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/images/clone4.jpg deleted file mode 100644 index 4810aa9ec62..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/images/clone4.jpg and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/images/clone4.png b/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/images/clone4.png deleted file mode 100644 index 45690c81c3e..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/images/clone4.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/images/clone5.png b/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/images/clone5.png deleted file mode 100644 index 9e80511e801..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/images/clone5.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/images/clone6.png b/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/images/clone6.png deleted file mode 100644 index b07aef91c3b..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/clone-a-vm/images/clone6.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.de-de.md b/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.de-de.md index 140bfd8038d..97c71979fb4 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.de-de.md +++ b/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.de-de.md @@ -95,7 +95,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows Configuration](images/config_ip_windows.png){.thumbnail} >> @@ -138,7 +138,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows IPv6 Configuration](images/config_ip_windows_v6.png){.thumbnail} >> diff --git a/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.en-asia.md b/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.en-asia.md index dd2074bc2f0..a7e412be979 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.en-asia.md +++ b/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.en-asia.md @@ -95,7 +95,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows Configuration](images/config_ip_windows.png){.thumbnail} >> @@ -138,7 +138,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows IPv6 Configuration](images/config_ip_windows_v6.png){.thumbnail} >> diff --git a/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.en-au.md b/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.en-au.md index dd2074bc2f0..a7e412be979 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.en-au.md +++ b/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.en-au.md @@ -95,7 +95,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows Configuration](images/config_ip_windows.png){.thumbnail} >> @@ -138,7 +138,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows IPv6 Configuration](images/config_ip_windows_v6.png){.thumbnail} >> diff --git a/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.en-ca.md b/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.en-ca.md index dd2074bc2f0..a7e412be979 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.en-ca.md +++ b/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.en-ca.md @@ -95,7 +95,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows Configuration](images/config_ip_windows.png){.thumbnail} >> @@ -138,7 +138,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows IPv6 Configuration](images/config_ip_windows_v6.png){.thumbnail} >> diff --git a/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.en-gb.md b/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.en-gb.md index 3d44b748686..0eaed7a0db3 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.en-gb.md +++ b/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.en-gb.md @@ -95,7 +95,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows Configuration](images/config_ip_windows.png){.thumbnail} >> @@ -138,7 +138,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows IPv6 Configuration](images/config_ip_windows_v6.png){.thumbnail} >> diff --git a/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.en-ie.md b/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.en-ie.md index dd2074bc2f0..a7e412be979 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.en-ie.md +++ b/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.en-ie.md @@ -95,7 +95,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows Configuration](images/config_ip_windows.png){.thumbnail} >> @@ -138,7 +138,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows IPv6 Configuration](images/config_ip_windows_v6.png){.thumbnail} >> diff --git a/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.en-sg.md b/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.en-sg.md index dd2074bc2f0..a7e412be979 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.en-sg.md +++ b/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.en-sg.md @@ -95,7 +95,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows Configuration](images/config_ip_windows.png){.thumbnail} >> @@ -138,7 +138,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows IPv6 Configuration](images/config_ip_windows_v6.png){.thumbnail} >> diff --git a/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.en-us.md b/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.en-us.md index dd2074bc2f0..a7e412be979 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.en-us.md +++ b/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.en-us.md @@ -95,7 +95,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows Configuration](images/config_ip_windows.png){.thumbnail} >> @@ -138,7 +138,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows IPv6 Configuration](images/config_ip_windows_v6.png){.thumbnail} >> diff --git a/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.es-es.md b/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.es-es.md index 8bbd8eb38ee..8ee52669d0a 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.es-es.md +++ b/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.es-es.md @@ -95,7 +95,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows Configuration](images/config_ip_windows.png){.thumbnail} >> @@ -138,7 +138,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows IPv6 Configuration](images/config_ip_windows_v6.png){.thumbnail} >> diff --git a/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.es-us.md b/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.es-us.md index 8bbd8eb38ee..8ee52669d0a 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.es-us.md +++ b/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.es-us.md @@ -95,7 +95,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows Configuration](images/config_ip_windows.png){.thumbnail} >> @@ -138,7 +138,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows IPv6 Configuration](images/config_ip_windows_v6.png){.thumbnail} >> diff --git a/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.fr-ca.md b/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.fr-ca.md index 78fa2607e42..99674c1eb2b 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.fr-ca.md +++ b/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.fr-ca.md @@ -95,7 +95,7 @@ Afin de configurer une IP publique sur votre machine virtuelle, vous devez au pr >> ncpa.cpl >> ``` >> ->> Il faut ensuite effectuer un clic droit sur la carte réseau correspondant au VMNetwork et sélectionner `Propriétés`{.action). Sélectionnez alors `Protocole TCP/IP v4`{.action} et cliquez de nouveau sur `Properties`{.action) puis renseignez les informations de votre IP comme suit : +>> Il faut ensuite effectuer un clic droit sur la carte réseau correspondant au VMNetwork et sélectionner `Propriétés`{.action}. Sélectionnez alors `Protocole TCP/IP v4`{.action} et cliquez de nouveau sur `Properties`{.action} puis renseignez les informations de votre IP comme suit : >> >> ![Configuration Windows](images/config_ip_windows.png){.thumbnail} >> @@ -138,7 +138,7 @@ Afin de configurer une IP publique sur votre machine virtuelle, vous devez au pr >> ncpa.cpl >> ``` >> ->> Il faut ensuite effectuer un clic droit sur la carte réseau correspondant au VMNetwork et sélectionner `Propriétés`{.action). Sélectionnez alors `Protocole TCP/IP v4`{.action} et cliquez de nouveau sur `Properties`{.action) puis renseignez les informations de votre IP comme suit : +>> Il faut ensuite effectuer un clic droit sur la carte réseau correspondant au VMNetwork et sélectionner `Propriétés`{.action}. Sélectionnez alors `Protocole TCP/IP v4`{.action} et cliquez de nouveau sur `Properties`{.action} puis renseignez les informations de votre IP comme suit : >> >> ![Configuration Windows IPv6](images/config_ip_windows_v6.png){.thumbnail} >> @@ -199,7 +199,7 @@ Pour aller plus vite, vous pouvez cliquer sur le champ de recherche Windows et ncpa.cpl ``` -Il faut ensuite effectuer un clic droit sur la carte réseau correspondant au VMNetwork et `Propriétés`{.action). Sélectionnez ensuite `Protocole TCP/IP v4`{.action} et cliquez de nouveau sur 'Properties' puis renseignez les informations de votre IP comme suit : +Il faut ensuite effectuer un clic droit sur la carte réseau correspondant au VMNetwork et `Propriétés`{.action}. Sélectionnez ensuite `Protocole TCP/IP v4`{.action} et cliquez de nouveau sur 'Properties' puis renseignez les informations de votre IP comme suit : ![Configuration Windows IP publique](images/windows_private.PNG){.thumbnail} diff --git a/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.fr-fr.md b/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.fr-fr.md index 715030b1126..bb185f4fcd9 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.fr-fr.md +++ b/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.fr-fr.md @@ -95,7 +95,7 @@ Afin de configurer une IP publique sur votre machine virtuelle, vous devez au pr >> ncpa.cpl >> ``` >> ->> Il faut ensuite effectuer un clic droit sur la carte réseau correspondant au VMNetwork et sélectionner `Propriétés`{.action). Sélectionnez alors `Protocole TCP/IP v4`{.action} et cliquez de nouveau sur `Properties`{.action) puis renseignez les informations de votre IP comme suit : +>> Il faut ensuite effectuer un clic droit sur la carte réseau correspondant au VMNetwork et sélectionner `Propriétés`{.action}. Sélectionnez alors `Protocole TCP/IP v4`{.action} et cliquez de nouveau sur `Properties`{.action} puis renseignez les informations de votre IP comme suit : >> >> ![Configuration Windows](images/config_ip_windows.png){.thumbnail} >> @@ -138,7 +138,7 @@ Afin de configurer une IP publique sur votre machine virtuelle, vous devez au pr >> ncpa.cpl >> ``` >> ->> Il faut ensuite effectuer un clic droit sur la carte réseau correspondant au VMNetwork et sélectionner `Propriétés`{.action). Sélectionnez alors `Protocole TCP/IP v4`{.action} et cliquez de nouveau sur `Properties`{.action) puis renseignez les informations de votre IP comme suit : +>> Il faut ensuite effectuer un clic droit sur la carte réseau correspondant au VMNetwork et sélectionner `Propriétés`{.action}. Sélectionnez alors `Protocole TCP/IP v4`{.action} et cliquez de nouveau sur `Properties`{.action} puis renseignez les informations de votre IP comme suit : >> >> ![Configuration Windows IPv6](images/config_ip_windows_v6.png){.thumbnail} >> @@ -199,7 +199,7 @@ Pour aller plus vite, vous pouvez cliquer sur le champ de recherche Windows et ncpa.cpl ``` -Il faut ensuite effectuer un clic droit sur la carte réseau correspondant au VMNetwork et `Propriétés`{.action). Sélectionnez ensuite `Protocole TCP/IP v4`{.action} et cliquez de nouveau sur 'Properties' puis renseignez les informations de votre IP comme suit : +Il faut ensuite effectuer un clic droit sur la carte réseau correspondant au VMNetwork et `Propriétés`{.action}. Sélectionnez ensuite `Protocole TCP/IP v4`{.action} et cliquez de nouveau sur 'Properties' puis renseignez les informations de votre IP comme suit : ![Configuration Windows IP publique](images/windows_private.PNG){.thumbnail} diff --git a/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.it-it.md b/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.it-it.md index 41d626aca90..1276423f1a0 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.it-it.md +++ b/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.it-it.md @@ -95,7 +95,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows Configuration](images/config_ip_windows.png){.thumbnail} >> @@ -138,7 +138,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows IPv6 Configuration](images/config_ip_windows_v6.png){.thumbnail} >> diff --git a/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.pl-pl.md b/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.pl-pl.md index eb532d78ff2..baa7243b27e 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.pl-pl.md +++ b/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.pl-pl.md @@ -95,7 +95,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows Configuration](images/config_ip_windows.png){.thumbnail} >> @@ -138,7 +138,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows IPv6 Configuration](images/config_ip_windows_v6.png){.thumbnail} >> diff --git a/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.pt-pt.md b/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.pt-pt.md index 03eb6f7a947..ffa6a876896 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.pt-pt.md +++ b/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/guide.pt-pt.md @@ -95,7 +95,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows Configuration](images/config_ip_windows.png){.thumbnail} >> @@ -138,7 +138,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows IPv6 Configuration](images/config_ip_windows_v6.png){.thumbnail} >> diff --git a/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/images/config_ip_ovh_network.png b/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/images/config_ip_ovh_network.png deleted file mode 100644 index 358f74ee951..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/images/config_ip_ovh_network.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/images/config_ip_ovh_network_advanced.png b/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/images/config_ip_ovh_network_advanced.png deleted file mode 100644 index c7229c1f68e..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/images/config_ip_ovh_network_advanced.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/images/img_32.jpg b/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/images/img_32.jpg deleted file mode 100644 index b5f765a3789..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/images/img_32.jpg and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/images/img_33.jpg b/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/images/img_33.jpg deleted file mode 100644 index a01564629f0..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/images/img_33.jpg and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/images/img_34.jpg b/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/images/img_34.jpg deleted file mode 100644 index dfdc8cfed74..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/images/img_34.jpg and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/images/img_36.jpg b/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/images/img_36.jpg deleted file mode 100644 index 49ffebd9383..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/images/img_36.jpg and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/images/vlan.PNG b/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/images/vlan.PNG deleted file mode 100644 index 169368317eb..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/images/vlan.PNG and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/images/vmnetwork.PNG b/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/images/vmnetwork.PNG deleted file mode 100644 index bf78094bbe9..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/images/vmnetwork.PNG and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/images/vxlan.PNG b/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/images/vxlan.PNG deleted file mode 100644 index 9d481e46eaf..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/configure_ip_on_vm/images/vxlan.PNG and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/create-an-alert/images/alarm1.png b/pages/bare_metal_cloud/managed_bare_metal/create-an-alert/images/alarm1.png deleted file mode 100644 index e59674bb2f4..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/create-an-alert/images/alarm1.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/create-an-alert/images/alarm2.png b/pages/bare_metal_cloud/managed_bare_metal/create-an-alert/images/alarm2.png deleted file mode 100644 index 3995eceb99b..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/create-an-alert/images/alarm2.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/create-an-alert/images/alarm3.png b/pages/bare_metal_cloud/managed_bare_metal/create-an-alert/images/alarm3.png deleted file mode 100644 index 121703364fb..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/create-an-alert/images/alarm3.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/create-an-alert/images/alarm4.png b/pages/bare_metal_cloud/managed_bare_metal/create-an-alert/images/alarm4.png deleted file mode 100644 index 987ac8cf061..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/create-an-alert/images/alarm4.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/create-an-alert/images/alarme1.png b/pages/bare_metal_cloud/managed_bare_metal/create-an-alert/images/alarme1.png deleted file mode 100644 index fdbaee97032..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/create-an-alert/images/alarme1.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/create-an-alert/images/alarme2.png b/pages/bare_metal_cloud/managed_bare_metal/create-an-alert/images/alarme2.png deleted file mode 100644 index ce9571ba728..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/create-an-alert/images/alarme2.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/create-an-alert/images/alarme3.png b/pages/bare_metal_cloud/managed_bare_metal/create-an-alert/images/alarme3.png deleted file mode 100644 index 252d69c14a2..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/create-an-alert/images/alarme3.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/create-an-alert/images/alarme4.png b/pages/bare_metal_cloud/managed_bare_metal/create-an-alert/images/alarme4.png deleted file mode 100644 index d1bd2a3bc92..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/create-an-alert/images/alarme4.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/creating-snapshots/images/snap1.png b/pages/bare_metal_cloud/managed_bare_metal/creating-snapshots/images/snap1.png deleted file mode 100644 index 0fd5d35d317..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/creating-snapshots/images/snap1.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/creating-snapshots/images/snap2.png b/pages/bare_metal_cloud/managed_bare_metal/creating-snapshots/images/snap2.png deleted file mode 100644 index 67696c6c645..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/creating-snapshots/images/snap2.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/creating-snapshots/images/snap3.png b/pages/bare_metal_cloud/managed_bare_metal/creating-snapshots/images/snap3.png deleted file mode 100644 index c26adcaff48..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/creating-snapshots/images/snap3.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/creating-snapshots/images/snapshot1.png b/pages/bare_metal_cloud/managed_bare_metal/creating-snapshots/images/snapshot1.png deleted file mode 100644 index 90ae10800cc..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/creating-snapshots/images/snapshot1.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/creating-snapshots/images/snapshot3.png b/pages/bare_metal_cloud/managed_bare_metal/creating-snapshots/images/snapshot3.png deleted file mode 100644 index 530aceda19a..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/creating-snapshots/images/snapshot3.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/creating-snapshots/images/spashot2.png b/pages/bare_metal_cloud/managed_bare_metal/creating-snapshots/images/spashot2.png deleted file mode 100644 index ac5a61c59d2..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/creating-snapshots/images/spashot2.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/delete_host/images/confirmmaintenanceMode.png b/pages/bare_metal_cloud/managed_bare_metal/delete_host/images/confirmmaintenanceMode.png deleted file mode 100644 index c1dc341f715..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/delete_host/images/confirmmaintenanceMode.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/delete_host/images/hostmaintenancemode.png b/pages/bare_metal_cloud/managed_bare_metal/delete_host/images/hostmaintenancemode.png deleted file mode 100644 index 69cefb2a751..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/delete_host/images/hostmaintenancemode.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/delete_host/images/removeovhhost_01.png b/pages/bare_metal_cloud/managed_bare_metal/delete_host/images/removeovhhost_01.png deleted file mode 100644 index e7fda28fda8..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/delete_host/images/removeovhhost_01.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/delete_host/images/removeovhhost_02.png b/pages/bare_metal_cloud/managed_bare_metal/delete_host/images/removeovhhost_02.png deleted file mode 100644 index b936bf34fa1..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/delete_host/images/removeovhhost_02.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/delete_host/images/removeovhhost_03.png b/pages/bare_metal_cloud/managed_bare_metal/delete_host/images/removeovhhost_03.png deleted file mode 100644 index 3b308f94d15..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/delete_host/images/removeovhhost_03.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/delete_host/images/taskmaintenancemode.png b/pages/bare_metal_cloud/managed_bare_metal/delete_host/images/taskmaintenancemode.png deleted file mode 100644 index b506b647849..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/delete_host/images/taskmaintenancemode.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/delete_host/images/taskremovehost.png b/pages/bare_metal_cloud/managed_bare_metal/delete_host/images/taskremovehost.png deleted file mode 100644 index 6a530cc09ec..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/delete_host/images/taskremovehost.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.de-de.md b/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.de-de.md index 17a821ae99f..5d0c8951bf1 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.de-de.md +++ b/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.de-de.md @@ -42,7 +42,7 @@ Im folgenden Schritt können Sie den Namen Ihrer Maschine sowie deren Speicheror ![Speicherort der virtuellen Maschine](images/vm03.png){.thumbnail} -Anschließend können Sie den Cluster, den Host, [den Ressourcenpool](https://docs.vmware.com/de/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html){.external-link} oder die [vApp](https://docs.vmware.com/de/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html){.external-link} auswählen, um die VM zu platzieren. +Anschließend können Sie den Cluster, den Host, [den Ressourcenpool](https://docs.vmware.com/de/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html) oder die [vApp](https://docs.vmware.com/de/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html) auswählen, um die VM zu platzieren. Im vorliegenden Beispiel wird die virtuelle Maschine entsprechend den konfigurierten DRS-Regeln deployt und im Wurzelverzeichnis des Clusters platziert. diff --git a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.en-asia.md b/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.en-asia.md index 3bc15fade7f..9ac6d1bc71b 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.en-asia.md +++ b/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.en-asia.md @@ -40,7 +40,7 @@ The next step allows you to define a name for the VM and choose a location. If y ![VM location](images/vm03.png){.thumbnail} -You can then choose the cluster, host, [resource pool](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html){.external-link}, or [vApp](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html){.external-link} to place it. +You can then choose the cluster, host, [resource pool](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html), or [vApp](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html) to place it. In this case, the VM will be deployed according to the configured DRS rules, and will be placed at the root of the cluster. diff --git a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.en-au.md b/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.en-au.md index 5afe3dceec1..972d3db5989 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.en-au.md +++ b/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.en-au.md @@ -40,7 +40,7 @@ The next step allows you to define a name for the VM and choose a location. If y ![VM location](images/vm03.png){.thumbnail} -You can then choose the cluster, host, [resource pool](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html){.external-link}, or [vApp](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html){.external-link} to place it. +You can then choose the cluster, host, [resource pool](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html), or [vApp](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html) to place it. In this case, the VM will be deployed according to the configured DRS rules, and will be placed at the root of the cluster. diff --git a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.en-ca.md b/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.en-ca.md index 19a9bca6cf1..cdc222cfda1 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.en-ca.md +++ b/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.en-ca.md @@ -40,7 +40,7 @@ The next step allows you to define a name for the VM and choose a location. If y ![VM location](images/vm03.png){.thumbnail} -You can then choose the cluster, host, [resource pool](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html){.external-link}, or [vApp](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html){.external-link} to place it. +You can then choose the cluster, host, [resource pool](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html), or [vApp](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html) to place it. In this case, the VM will be deployed according to the configured DRS rules, and will be placed at the root of the cluster. diff --git a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.en-gb.md b/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.en-gb.md index b50e73e48f1..c39d3909530 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.en-gb.md +++ b/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.en-gb.md @@ -40,7 +40,7 @@ The next step allows you to define a name for the VM and choose a location. If y ![VM location](images/vm03.png){.thumbnail} -You can then choose the cluster, host, [resource pool](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html){.external-link}, or [vApp](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html){.external-link} to place it. +You can then choose the cluster, host, [resource pool](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html), or [vApp](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html) to place it. In this case, the VM will be deployed according to the configured DRS rules, and will be placed at the root of the cluster. diff --git a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.en-ie.md b/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.en-ie.md index d3836c67500..15bef46002d 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.en-ie.md +++ b/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.en-ie.md @@ -40,7 +40,7 @@ The next step allows you to define a name for the VM and choose a location. If y ![VM location](images/vm03.png){.thumbnail} -You can then choose the cluster, host, [resource pool](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html){.external-link}, or [vApp](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html){.external-link} to place it. +You can then choose the cluster, host, [resource pool](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html), or [vApp](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html) to place it. In this case, the VM will be deployed according to the configured DRS rules, and will be placed at the root of the cluster. diff --git a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.en-sg.md b/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.en-sg.md index ffb1300a82f..99411bea43e 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.en-sg.md +++ b/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.en-sg.md @@ -40,7 +40,7 @@ The next step allows you to define a name for the VM and choose a location. If y ![VM location](images/vm03.png){.thumbnail} -You can then choose the cluster, host, [resource pool](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html){.external-link}, or [vApp](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html){.external-link} to place it. +You can then choose the cluster, host, [resource pool](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html), or [vApp](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html) to place it. In this case, the VM will be deployed according to the configured DRS rules, and will be placed at the root of the cluster. diff --git a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.en-us.md b/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.en-us.md index d5fb66ec375..070c8b933a2 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.en-us.md +++ b/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.en-us.md @@ -40,7 +40,7 @@ The next step allows you to define a name for the VM and choose a location. If y ![VM location](images/vm03.png){.thumbnail} -You can then choose the cluster, host, [resource pool](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html){.external-link}, or [vApp](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html){.external-link} to place it. +You can then choose the cluster, host, [resource pool](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html), or [vApp](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html) to place it. In this case, the VM will be deployed according to the configured DRS rules, and will be placed at the root of the cluster. diff --git a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.es-es.md b/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.es-es.md index 74b12c97491..f6c6c428b9b 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.es-es.md +++ b/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.es-es.md @@ -42,7 +42,7 @@ El siguiente paso le permite definir el nombre de su máquina y elegir su locali ![emplacement de la machine virtuelle](images/vm03.png){.thumbnail} -Luego, podrá elegir el clúster, el servidor, [el grupo de recursos](https://docs.vmware.com/fr/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html){.external-link} o [la vApp](https://docs.vmware.com/fr/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html){.external-link} donde desee colocarla. +Luego, podrá elegir el clúster, el servidor, [el grupo de recursos](https://docs.vmware.com/fr/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html) o [la vApp](https://docs.vmware.com/fr/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html) donde desee colocarla. En este caso, la máquina virtual se instrumentará según las reglas DRS configuradas y se colocará en la raíz del clúster. diff --git a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.es-us.md b/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.es-us.md index a793e5d792f..76e2ff8460c 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.es-us.md +++ b/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.es-us.md @@ -42,7 +42,7 @@ El siguiente paso le permite definir el nombre de su máquina y elegir su locali ![emplacement de la machine virtuelle](images/vm03.png){.thumbnail} -Luego, podrá elegir el clúster, el servidor, [el grupo de recursos](https://docs.vmware.com/fr/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html){.external-link} o [la vApp](https://docs.vmware.com/fr/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html){.external-link} donde desee colocarla. +Luego, podrá elegir el clúster, el servidor, [el grupo de recursos](https://docs.vmware.com/fr/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html) o [la vApp](https://docs.vmware.com/fr/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html) donde desee colocarla. En este caso, la máquina virtual se instrumentará según las reglas DRS configuradas y se colocará en la raíz del clúster. diff --git a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.fr-ca.md b/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.fr-ca.md index d5a236045c7..350f29efec5 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.fr-ca.md +++ b/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.fr-ca.md @@ -42,7 +42,7 @@ L'étape suivante vous permet de définir le nom de votre machine et de choisir ![emplacement de la machine virtuelle](images/vm03.png){.thumbnail} -Vous pouvez ensuite choisir le cluster, l’hôte, [le pool de ressources](https://docs.vmware.com/fr/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html){.external-link}, ou [la vApp](https://docs.vmware.com/fr/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html){.external-link} où vous souhaitez la placer. +Vous pouvez ensuite choisir le cluster, l’hôte, [le pool de ressources](https://docs.vmware.com/fr/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html), ou [la vApp](https://docs.vmware.com/fr/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html) où vous souhaitez la placer. Dans ce cas, la machine virtuelle sera déployée selon les règles DRS configurées, et sera placée à la racine du cluster. diff --git a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.fr-fr.md b/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.fr-fr.md index 2f5a8f5d249..cef160a169a 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.fr-fr.md +++ b/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.fr-fr.md @@ -42,7 +42,7 @@ L'étape suivante vous permet de définir le nom de votre machine et de choisir ![emplacement de la machine virtuelle](images/vm03.png){.thumbnail} -Vous pouvez ensuite choisir le cluster, l’hôte, [le pool de ressources](https://docs.vmware.com/fr/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html){.external-link}, ou [la vApp](https://docs.vmware.com/fr/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html){.external-link} où vous souhaitez la placer. +Vous pouvez ensuite choisir le cluster, l’hôte, [le pool de ressources](https://docs.vmware.com/fr/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html), ou [la vApp](https://docs.vmware.com/fr/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html) où vous souhaitez la placer. Dans ce cas, la machine virtuelle sera déployée selon les règles DRS configurées, et sera placée à la racine du cluster. diff --git a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.it-it.md b/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.it-it.md index aef8d51a76b..63de67b40a9 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.it-it.md +++ b/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.it-it.md @@ -42,7 +42,7 @@ Lo step successivo consente di definire il nome della propria macchina e sceglie ![Localizzazione della macchina virtuale](images/vm03.png){.thumbnail} -In seguito è possibile scegliere il cluster, l’host, il [pool di risorse](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html){.external-link} o la [vApp](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html){.external-link}di destinazione. +In seguito è possibile scegliere il cluster, l’host, il [pool di risorse](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html) o la [vApp](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html)di destinazione. Nel nostro caso, la macchina virtuale sarà implementata secondo le regole DRS configurate e localizzata nella root del cluster. diff --git a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.pt-pt.md b/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.pt-pt.md index 6bdd34da326..4eba2029857 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.pt-pt.md +++ b/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/guide.pt-pt.md @@ -42,7 +42,7 @@ A etapa seguinte permite-lhe definir o nome da sua máquina e escolher a sua loc ![localização da máquina virtual](images/vm03.png){.thumbnail} -De seguida, pode escolher o cluster, o host, [o pool de recursos](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html){.external-link}, ou [a vApp](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html){.external-link} onde a quer colocar. +De seguida, pode escolher o cluster, o host, [o pool de recursos](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html), ou [a vApp](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html) onde a quer colocar. Neste caso, a máquina virtual será implementada segundo as regras DRS configuradas, e será colocada na raiz do cluster. diff --git a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/images/deploy_vm2.png b/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/images/deploy_vm2.png deleted file mode 100644 index a3e750ad701..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/images/deploy_vm2.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/images/deploy_vm3.png b/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/images/deploy_vm3.png deleted file mode 100644 index d21babaad6e..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/images/deploy_vm3.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/images/deploy_vm_cluster.png b/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/images/deploy_vm_cluster.png deleted file mode 100644 index 1b0f2cf5a7e..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/images/deploy_vm_cluster.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/images/deploy_vm_compatibility.png b/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/images/deploy_vm_compatibility.png deleted file mode 100644 index deee42a0bfc..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/images/deploy_vm_compatibility.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/images/deploy_vm_customize.png b/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/images/deploy_vm_customize.png deleted file mode 100644 index f73a560136f..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/images/deploy_vm_customize.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/images/deploy_vm_customize_with_iso.png b/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/images/deploy_vm_customize_with_iso.png deleted file mode 100644 index e9f4830501b..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/images/deploy_vm_customize_with_iso.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/images/deploy_vm_datastore.png b/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/images/deploy_vm_datastore.png deleted file mode 100644 index 4a42d2da20f..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/images/deploy_vm_datastore.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/images/deploy_vm_finish.png b/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/images/deploy_vm_finish.png deleted file mode 100644 index aa5a687f60c..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/images/deploy_vm_finish.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/images/deploy_vm_guest_os.png b/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/images/deploy_vm_guest_os.png deleted file mode 100644 index 472bc9642a4..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/images/deploy_vm_guest_os.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/images/deploy_vm_iso.png b/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/images/deploy_vm_iso.png deleted file mode 100644 index 701763bc5ac..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/images/deploy_vm_iso.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/images/deploy_vm_ready.png b/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/images/deploy_vm_ready.png deleted file mode 100644 index 1e6aff03e04..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/deploy-a-vm/images/deploy_vm_ready.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/ip-block-addition/guide.de-de.md b/pages/bare_metal_cloud/managed_bare_metal/ip-block-addition/guide.de-de.md index f82592826cd..8ea3e683075 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/ip-block-addition/guide.de-de.md +++ b/pages/bare_metal_cloud/managed_bare_metal/ip-block-addition/guide.de-de.md @@ -40,7 +40,7 @@ Zur Erstellung Ihres IP-Blocks sind zunächst mehrere Felder auszufüllen: > [!primary] > -> Welche IPs Ihres Blocks reserviert sind und wofür sie verwendet werden, können Sie in unserer Anleitung zum [OVHcloud Network Plugin](/pages/bare_metal_cloud/managed_bare_metal/plugin_ovh_network){.external-link} nachlesen. +> Welche IPs Ihres Blocks reserviert sind und wofür sie verwendet werden, können Sie in unserer Anleitung zum [OVHcloud Network Plugin](/pages/bare_metal_cloud/managed_bare_metal/plugin_ovh_network) nachlesen. > - Land des IP-Blocks. Dieses kann für das SEO-Ranking Ihrer Dienste von Bedeutung sein (zum Beispiel ist die Referenzierung einer deutschen Website in Deutschland besser, wenn auch ihre IP deutsch ist) diff --git a/pages/bare_metal_cloud/managed_bare_metal/ip-block-addition/guide.en-gb.md b/pages/bare_metal_cloud/managed_bare_metal/ip-block-addition/guide.en-gb.md index 813b9dc8108..a5ab3316464 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/ip-block-addition/guide.en-gb.md +++ b/pages/bare_metal_cloud/managed_bare_metal/ip-block-addition/guide.en-gb.md @@ -40,7 +40,7 @@ You will need to fill in several fields in order to create your IP block. > [!primary] > -> Please feel free to refer to our guide on the [OVHcloud Network plugin](/pages/bare_metal_cloud/managed_bare_metal/plugin_ovh_network){.external-link} to find out which IPs are reserved for your block, as well as how they are used. +> Please feel free to refer to our guide on the [OVHcloud Network plugin](/pages/bare_metal_cloud/managed_bare_metal/plugin_ovh_network) to find out which IPs are reserved for your block, as well as how they are used. > - The country an IP block is hosted in is important in some cases, for your services’ SEO ranking (a website based in France will have a higher SEO ranking in France if the IP address is French, too). diff --git a/pages/bare_metal_cloud/managed_bare_metal/ip-block-addition/guide.fr-ca.md b/pages/bare_metal_cloud/managed_bare_metal/ip-block-addition/guide.fr-ca.md index 2a0c9afec90..380a5213322 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/ip-block-addition/guide.fr-ca.md +++ b/pages/bare_metal_cloud/managed_bare_metal/ip-block-addition/guide.fr-ca.md @@ -40,7 +40,7 @@ Plusieurs champs seront à remplir pour la création de votre bloc IP > [!primary] > -> N'hésitez pas à consulter notre guide sur le [plugin OVHcloud Network](/pages/bare_metal_cloud/managed_bare_metal/plugin_ovh_network){.external-link} afin de savoir quelles sont les IPs réservées de votre bloc ainsi que leur utilisation. +> N'hésitez pas à consulter notre guide sur le [plugin OVHcloud Network](/pages/bare_metal_cloud/managed_bare_metal/plugin_ovh_network) afin de savoir quelles sont les IPs réservées de votre bloc ainsi que leur utilisation. > - Pays du bloc IP, important dans certains cas pour le référencement de vos services (un site à affluence française aura un meilleur référencement en France si l'IP est française également) diff --git a/pages/bare_metal_cloud/managed_bare_metal/ip-block-addition/guide.fr-fr.md b/pages/bare_metal_cloud/managed_bare_metal/ip-block-addition/guide.fr-fr.md index c27add0e133..78698109c85 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/ip-block-addition/guide.fr-fr.md +++ b/pages/bare_metal_cloud/managed_bare_metal/ip-block-addition/guide.fr-fr.md @@ -40,7 +40,7 @@ Plusieurs champs seront à remplir pour la création de votre bloc IP > [!primary] > -> N'hésitez pas à consulter notre guide sur le [plugin OVHcloud Network](/pages/bare_metal_cloud/managed_bare_metal/plugin_ovh_network){.external-link} afin de savoir quelles sont les IPs réservées de votre bloc ainsi que leur utilisation. +> N'hésitez pas à consulter notre guide sur le [plugin OVHcloud Network](/pages/bare_metal_cloud/managed_bare_metal/plugin_ovh_network) afin de savoir quelles sont les IPs réservées de votre bloc ainsi que leur utilisation. > - Pays du bloc IP, important dans certains cas pour le référencement de vos services (un site à affluence française aura un meilleur référencement en France si l'IP est française également) diff --git a/pages/bare_metal_cloud/managed_bare_metal/ip-block-addition/guide.pl-pl.md b/pages/bare_metal_cloud/managed_bare_metal/ip-block-addition/guide.pl-pl.md index e8738aca9c6..a8450c86e7e 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/ip-block-addition/guide.pl-pl.md +++ b/pages/bare_metal_cloud/managed_bare_metal/ip-block-addition/guide.pl-pl.md @@ -40,7 +40,7 @@ Utworzenie bloku IP wymaga wypełnienia następujących pól > [!primary] > -> Zapoznaj się z naszym przewodnikiem dotyczącym [wtyczki OVHcloud Network](/pages/bare_metal_cloud/managed_bare_metal/plugin_ovh_network){.external-link}, aby dowiedzieć się, jakie IP zarezerwowano dla Twojego bloku oraz jak są wykorzystywane. +> Zapoznaj się z naszym przewodnikiem dotyczącym [wtyczki OVHcloud Network](/pages/bare_metal_cloud/managed_bare_metal/plugin_ovh_network), aby dowiedzieć się, jakie IP zarezerwowano dla Twojego bloku oraz jak są wykorzystywane. > - Kraj bloku IP, ważny w niektórych przypadkach dla pozycjonowania Twoich witryn (strona internetowa skierowana do Polaków będzie lepiej pozycjonowana, jeśli ma polski adres IP). diff --git a/pages/bare_metal_cloud/managed_bare_metal/ip-block-addition/guide.pt-pt.md b/pages/bare_metal_cloud/managed_bare_metal/ip-block-addition/guide.pt-pt.md index 54cd218aec9..6a7ab998119 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/ip-block-addition/guide.pt-pt.md +++ b/pages/bare_metal_cloud/managed_bare_metal/ip-block-addition/guide.pt-pt.md @@ -40,7 +40,7 @@ Vários campos deverão ser preenchidos para criar o seu bloco IP > [!primary] > -> Não hesite em consultar o nosso manual sobre o [plugin OVHcloud Network](/pages/bare_metal_cloud/managed_bare_metal/plugin_ovh_network){.external-link} para saber quais são os IP reservados do seu bloco, assim como a sua utilização. +> Não hesite em consultar o nosso manual sobre o [plugin OVHcloud Network](/pages/bare_metal_cloud/managed_bare_metal/plugin_ovh_network) para saber quais são os IP reservados do seu bloco, assim como a sua utilização. > - País do bloco IP: importante em certos casos para o referenciamento dos seus serviços (um site português terá um melhor SEO em Portugal se o IP também for português) diff --git a/pages/bare_metal_cloud/managed_bare_metal/ip-block-addition/images/AddInfos.PNG b/pages/bare_metal_cloud/managed_bare_metal/ip-block-addition/images/AddInfos.PNG deleted file mode 100644 index 292b21fa67a..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/ip-block-addition/images/AddInfos.PNG and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/ip-block-addition/images/CGV.PNG b/pages/bare_metal_cloud/managed_bare_metal/ip-block-addition/images/CGV.PNG deleted file mode 100644 index 61ac7ed11c6..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/ip-block-addition/images/CGV.PNG and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/ip-block-addition/images/ConfirmPrice.PNG b/pages/bare_metal_cloud/managed_bare_metal/ip-block-addition/images/ConfirmPrice.PNG deleted file mode 100644 index da9b43a168c..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/ip-block-addition/images/ConfirmPrice.PNG and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/ip-block-addition/images/Order.PNG b/pages/bare_metal_cloud/managed_bare_metal/ip-block-addition/images/Order.PNG deleted file mode 100644 index 31895e892e4..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/ip-block-addition/images/Order.PNG and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/ip-block-addition/images/OrderAdditionalIps.PNG b/pages/bare_metal_cloud/managed_bare_metal/ip-block-addition/images/OrderAdditionalIps.PNG deleted file mode 100644 index 6574c5c11bd..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/ip-block-addition/images/OrderAdditionalIps.PNG and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/ip-block-addition/images/SelectService.PNG b/pages/bare_metal_cloud/managed_bare_metal/ip-block-addition/images/SelectService.PNG deleted file mode 100644 index 8d8bd059f28..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/ip-block-addition/images/SelectService.PNG and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/modify-hardware-configuration-of-vm/images/add_ressources_cd_dvd.png b/pages/bare_metal_cloud/managed_bare_metal/modify-hardware-configuration-of-vm/images/add_ressources_cd_dvd.png deleted file mode 100644 index 57e775b0044..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/modify-hardware-configuration-of-vm/images/add_ressources_cd_dvd.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/modify-hardware-configuration-of-vm/images/add_ressources_cpu.png b/pages/bare_metal_cloud/managed_bare_metal/modify-hardware-configuration-of-vm/images/add_ressources_cpu.png deleted file mode 100644 index acb9834f048..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/modify-hardware-configuration-of-vm/images/add_ressources_cpu.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/modify-hardware-configuration-of-vm/images/add_ressources_disk.png b/pages/bare_metal_cloud/managed_bare_metal/modify-hardware-configuration-of-vm/images/add_ressources_disk.png deleted file mode 100644 index d74acb4fe79..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/modify-hardware-configuration-of-vm/images/add_ressources_disk.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/modify-hardware-configuration-of-vm/images/add_ressources_edit.png b/pages/bare_metal_cloud/managed_bare_metal/modify-hardware-configuration-of-vm/images/add_ressources_edit.png deleted file mode 100644 index 0b3fff5dbda..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/modify-hardware-configuration-of-vm/images/add_ressources_edit.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/modify-hardware-configuration-of-vm/images/add_ressources_network.png b/pages/bare_metal_cloud/managed_bare_metal/modify-hardware-configuration-of-vm/images/add_ressources_network.png deleted file mode 100644 index 7a079d0eb99..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/modify-hardware-configuration-of-vm/images/add_ressources_network.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/modify-hardware-configuration-of-vm/images/add_ressources_new_device.png b/pages/bare_metal_cloud/managed_bare_metal/modify-hardware-configuration-of-vm/images/add_ressources_new_device.png deleted file mode 100644 index b51f2e636b2..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/modify-hardware-configuration-of-vm/images/add_ressources_new_device.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/modify-hardware-configuration-of-vm/images/add_ressources_ram.png b/pages/bare_metal_cloud/managed_bare_metal/modify-hardware-configuration-of-vm/images/add_ressources_ram.png deleted file mode 100644 index c459e6c1b9b..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/modify-hardware-configuration-of-vm/images/add_ressources_ram.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/modify-hardware-configuration-of-vm/images/add_ressources_video.png b/pages/bare_metal_cloud/managed_bare_metal/modify-hardware-configuration-of-vm/images/add_ressources_video.png deleted file mode 100644 index 93e2d8ea0d4..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/modify-hardware-configuration-of-vm/images/add_ressources_video.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/vcenter-authorise-ip-access/guide.de-de.md b/pages/bare_metal_cloud/managed_bare_metal/vcenter-authorise-ip-access/guide.de-de.md index 43f9e934ed4..4be752e7868 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vcenter-authorise-ip-access/guide.de-de.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vcenter-authorise-ip-access/guide.de-de.md @@ -18,7 +18,7 @@ Der Zugang zum vCenter kann eingeschränkt werden. Dazu wird nur bestimmten IP A Wenn die [ Regeln für den Zugang zum vCenter Einschränkungen vorsehen](/pages/bare_metal_cloud/managed_bare_metal/vcenter-modify-access-policy), müssen die IPs hinzugefügt werden, die sich mit dem Dienst verbinden dürfen. -Dies erfolgt im [OVHcloud Kundencenter](/links/manager){.external-link}. Klicken Sie im Abschnitt `Bare Metal Cloud` auf die Rubrik `Managed Bare Metal`. Wählen Sie die Infrastruktur aus. Klicken Sie dann auf den Tab `Sicherheit` und danach auf `Neuen IP-Bereich hinzufügen`{.action}. +Dies erfolgt im [OVHcloud Kundencenter](/links/manager). Klicken Sie im Abschnitt `Bare Metal Cloud` auf die Rubrik `Managed Bare Metal`. Wählen Sie die Infrastruktur aus. Klicken Sie dann auf den Tab `Sicherheit` und danach auf `Neuen IP-Bereich hinzufügen`{.action}. ![vCenter](images/restrictIP.png){.thumbnail} diff --git a/pages/bare_metal_cloud/managed_bare_metal/vcenter-authorise-ip-access/guide.es-es.md b/pages/bare_metal_cloud/managed_bare_metal/vcenter-authorise-ip-access/guide.es-es.md index ab2a9301ee4..4403229bce9 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vcenter-authorise-ip-access/guide.es-es.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vcenter-authorise-ip-access/guide.es-es.md @@ -18,7 +18,7 @@ Es posible limitar el acceso al vCenter autorizando solo la conexión de determi Cuando [la política de acceso al vCenter está restringida](/pages/bare_metal_cloud/managed_bare_metal/vcenter-modify-access-policy), es necesario añadir las direcciones IP autorizadas a conectarse al servicio. -Esta operación se realiza desde el [área de cliente de OVHcloud](/links/manager){.external-link}. En el menú `Servidores`, acceda a la sección `Managed Bare Metal`. Seleccione la infraestructura y, a continuación, abra la pestaña `Seguridad`. Por último, haga clic en `Añadir un nuevo rango de direcciones IP`{.action}. +Esta operación se realiza desde el [área de cliente de OVHcloud](/links/manager). En el menú `Servidores`, acceda a la sección `Managed Bare Metal`. Seleccione la infraestructura y, a continuación, abra la pestaña `Seguridad`. Por último, haga clic en `Añadir un nuevo rango de direcciones IP`{.action}. ![vCenter](images/restrictIP.png){.thumbnail} diff --git a/pages/bare_metal_cloud/managed_bare_metal/vcenter-authorise-ip-access/guide.es-us.md b/pages/bare_metal_cloud/managed_bare_metal/vcenter-authorise-ip-access/guide.es-us.md index 0d29de09765..62d4419a3fe 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vcenter-authorise-ip-access/guide.es-us.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vcenter-authorise-ip-access/guide.es-us.md @@ -18,7 +18,7 @@ Es posible limitar el acceso al vCenter autorizando solo la conexión de determi Cuando [la política de acceso al vCenter está restringida](/pages/bare_metal_cloud/managed_bare_metal/vcenter-modify-access-policy), es necesario añadir las direcciones IP autorizadas a conectarse al servicio. -Esta operación se realiza desde el [área de cliente de OVHcloud](/links/manager){.external-link}. En el menú `Servidores`, acceda a la sección `Managed Bare Metal`. Seleccione la infraestructura y, a continuación, abra la pestaña `Seguridad`. Por último, haga clic en `Añadir un nuevo rango de direcciones IP`{.action}. +Esta operación se realiza desde el [área de cliente de OVHcloud](/links/manager). En el menú `Servidores`, acceda a la sección `Managed Bare Metal`. Seleccione la infraestructura y, a continuación, abra la pestaña `Seguridad`. Por último, haga clic en `Añadir un nuevo rango de direcciones IP`{.action}. ![vCenter](images/restrictIP.png){.thumbnail} diff --git a/pages/bare_metal_cloud/managed_bare_metal/vcenter-authorise-ip-access/guide.fr-ca.md b/pages/bare_metal_cloud/managed_bare_metal/vcenter-authorise-ip-access/guide.fr-ca.md index 8c6d83650e5..88d528a03c5 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vcenter-authorise-ip-access/guide.fr-ca.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vcenter-authorise-ip-access/guide.fr-ca.md @@ -18,7 +18,7 @@ Il est possible de restreindre l'accès au vCenter en autorisant uniquement cert Lorsque [la politique d'accès au vCenter est restreinte](/pages/bare_metal_cloud/managed_bare_metal/vcenter-modify-access-policy), il est nécessaire d'ajouter les IPs qui seront autorisées à se connecter au service. -L'opération se réalise dans [l'espace client OVHcloud](/links/manager){.external-link}. Dans la section `Bare Metal Cloud`, cliquez sur la rubrique `Managed Bare Metal`. Sélectionnez l'infrastructure puis rendez-vous dans l'onglet `Sécurité` et enfin cliquez sur `Ajouter une nouvelle plage d'adresses IP`{.action}. +L'opération se réalise dans [l'espace client OVHcloud](/links/manager). Dans la section `Bare Metal Cloud`, cliquez sur la rubrique `Managed Bare Metal`. Sélectionnez l'infrastructure puis rendez-vous dans l'onglet `Sécurité` et enfin cliquez sur `Ajouter une nouvelle plage d'adresses IP`{.action}. ![vCenter](images/restrictIP.png){.thumbnail} diff --git a/pages/bare_metal_cloud/managed_bare_metal/vcenter-authorise-ip-access/guide.fr-fr.md b/pages/bare_metal_cloud/managed_bare_metal/vcenter-authorise-ip-access/guide.fr-fr.md index 04c61ba53a4..ce2845d8a1d 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vcenter-authorise-ip-access/guide.fr-fr.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vcenter-authorise-ip-access/guide.fr-fr.md @@ -18,7 +18,7 @@ Il est possible de restreindre l'accès au vCenter en autorisant uniquement cert Lorsque [la politique d'accès au vCenter est restreinte](/pages/bare_metal_cloud/managed_bare_metal/vcenter-modify-access-policy), il est nécessaire d'ajouter les IPs qui seront autorisées à se connecter au service. -L'opération se réalise dans [l'espace client OVHcloud](/links/manager){.external-link}. Dans la section `Bare Metal Cloud`, cliquez sur la rubrique `Managed Bare Metal`. Sélectionnez l'infrastructure puis rendez-vous dans l'onglet `Sécurité` et enfin cliquez sur `Ajouter une nouvelle plage d'adresses IP`{.action}. +L'opération se réalise dans [l'espace client OVHcloud](/links/manager). Dans la section `Bare Metal Cloud`, cliquez sur la rubrique `Managed Bare Metal`. Sélectionnez l'infrastructure puis rendez-vous dans l'onglet `Sécurité` et enfin cliquez sur `Ajouter une nouvelle plage d'adresses IP`{.action}. ![vCenter](images/restrictIP.png){.thumbnail} diff --git a/pages/bare_metal_cloud/managed_bare_metal/vcenter-authorise-ip-access/guide.it-it.md b/pages/bare_metal_cloud/managed_bare_metal/vcenter-authorise-ip-access/guide.it-it.md index 90d399c635f..619f94f6bb7 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vcenter-authorise-ip-access/guide.it-it.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vcenter-authorise-ip-access/guide.it-it.md @@ -18,7 +18,7 @@ Impostare restrizioni di accesso al vCenter consente di limitare la connessione Se la [politica di accesso al vCenter è configurata come limitata](/pages/bare_metal_cloud/managed_bare_metal/vcenter-modify-access-policy), è necessario aggiungere gli IP che saranno autorizzati a connettersi al servizio. -Questa operazione può essere effettuata dallo [Spazio Cliente OVHcloud](/links/manager){.external-link}: nella sezione `Bare Metal Cloud`, clicca su `Managed Bare Metal` nella colonna a sinistra. Seleziona l’infrastruttura, clicca sulla scheda `Sicurezza` e poi su `Aggiungi una nuova classe di indirizzi IP`{.action}. +Questa operazione può essere effettuata dallo [Spazio Cliente OVHcloud](/links/manager): nella sezione `Bare Metal Cloud`, clicca su `Managed Bare Metal` nella colonna a sinistra. Seleziona l’infrastruttura, clicca sulla scheda `Sicurezza` e poi su `Aggiungi una nuova classe di indirizzi IP`{.action}. ![vCenter](images/restrictIP.png){.thumbnail} diff --git a/pages/bare_metal_cloud/managed_bare_metal/vcenter-authorise-ip-access/guide.pl-pl.md b/pages/bare_metal_cloud/managed_bare_metal/vcenter-authorise-ip-access/guide.pl-pl.md index da98042bcd3..ab2a55645bd 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vcenter-authorise-ip-access/guide.pl-pl.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vcenter-authorise-ip-access/guide.pl-pl.md @@ -18,7 +18,7 @@ Możesz ograniczyć dostęp do vCenter, pozwalając na łączenie się z nim tyl Kiedy polityka dostępu do vCenter jest ograniczona, konieczne jest dodanie adresów IP, które będą mogły łączyć się z usługą. -Operacja ta przeprowadzana jest w [Panelu klienta](/links/manager){.external-link}. W sekcji `Bare Metal Cloud`, kliknij sekcję `Managed Bare Metal`. Wybierz infrastrukturę, przejdź do zakładki `Bezpieczeństwo`, po czym kliknij `Dodaj nowy zakres adresów IP`{.action}. +Operacja ta przeprowadzana jest w [Panelu klienta](/links/manager). W sekcji `Bare Metal Cloud`, kliknij sekcję `Managed Bare Metal`. Wybierz infrastrukturę, przejdź do zakładki `Bezpieczeństwo`, po czym kliknij `Dodaj nowy zakres adresów IP`{.action}. ![vCenter](images/restrictIP.png){.thumbnail} diff --git a/pages/bare_metal_cloud/managed_bare_metal/vcenter-authorise-ip-access/guide.pt-pt.md b/pages/bare_metal_cloud/managed_bare_metal/vcenter-authorise-ip-access/guide.pt-pt.md index 604267f46bc..0edcbda45b2 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vcenter-authorise-ip-access/guide.pt-pt.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vcenter-authorise-ip-access/guide.pt-pt.md @@ -18,7 +18,7 @@ updated: 2020-11-18 Quando [a política de acesso ao vCenter é limitada](/pages/bare_metal_cloud/managed_bare_metal/vcenter-modify-access-policy), é necessário adicionar os IP que serão autorizados a ligar-se ao serviço. -A operação pode ser realizada a partir da [Área de Cliente OVHcloud](/links/manager){.external-link}. Na secção `Bare Metal Cloud`, clique na opção `Managed Bare Metal`. Selecione a infraestrutura e aceda ao separador `Segurança` e clique em `Adicionar um novo intervalo de endereços IP`{.action}. +A operação pode ser realizada a partir da [Área de Cliente OVHcloud](/links/manager). Na secção `Bare Metal Cloud`, clique na opção `Managed Bare Metal`. Selecione a infraestrutura e aceda ao separador `Segurança` e clique em `Adicionar um novo intervalo de endereços IP`{.action}. ![vCenter](images/restrictIP.png){.thumbnail} diff --git a/pages/bare_metal_cloud/managed_bare_metal/vlan-creation/guide.fr-ca.md b/pages/bare_metal_cloud/managed_bare_metal/vlan-creation/guide.fr-ca.md index e3e20aff115..8eeb7fe7a93 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vlan-creation/guide.fr-ca.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vlan-creation/guide.fr-ca.md @@ -26,7 +26,7 @@ Le premier vDS dispose d'un seul type de *portGroup*, le VMnetwork permettant de Le second vDS dispose également d'un seul type de *portGroup* , des VLAN permettant d'isoler des communications privées à l'intérieur du Managed Bare Metal et entre les différents services OVHcloud compatibles vRack (Serveur dédié, Public Cloud...). -Sur ce switch, 11 VLANs sont créés de base (VLAN10 à VLAN20). En donnant le droit `administrateur` sur l'`Accès au VLAN` dans [la gestion des utilisateurs de votre espace client](/pages/bare_metal_cloud/managed_bare_metal/manager-ovhcloud#utilisateurs){.external-link}, vous pourrez créer des VLAN supplémentaires. +Sur ce switch, 11 VLANs sont créés de base (VLAN10 à VLAN20). En donnant le droit `administrateur` sur l'`Accès au VLAN` dans [la gestion des utilisateurs de votre espace client](/pages/bare_metal_cloud/managed_bare_metal/manager-ovhcloud#utilisateurs), vous pourrez créer des VLAN supplémentaires. En premier lieu, rendez vous dans la vue `mise en réseau` de votre client vSphere. Déployez le dossier **vrack** puis faites un clic droit sur le **dVS** finissant par *-vrack* et enfin cliquez sur `New Distributed Port Group`{.action}. diff --git a/pages/bare_metal_cloud/managed_bare_metal/vlan-creation/guide.fr-fr.md b/pages/bare_metal_cloud/managed_bare_metal/vlan-creation/guide.fr-fr.md index e3e20aff115..8eeb7fe7a93 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vlan-creation/guide.fr-fr.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vlan-creation/guide.fr-fr.md @@ -26,7 +26,7 @@ Le premier vDS dispose d'un seul type de *portGroup*, le VMnetwork permettant de Le second vDS dispose également d'un seul type de *portGroup* , des VLAN permettant d'isoler des communications privées à l'intérieur du Managed Bare Metal et entre les différents services OVHcloud compatibles vRack (Serveur dédié, Public Cloud...). -Sur ce switch, 11 VLANs sont créés de base (VLAN10 à VLAN20). En donnant le droit `administrateur` sur l'`Accès au VLAN` dans [la gestion des utilisateurs de votre espace client](/pages/bare_metal_cloud/managed_bare_metal/manager-ovhcloud#utilisateurs){.external-link}, vous pourrez créer des VLAN supplémentaires. +Sur ce switch, 11 VLANs sont créés de base (VLAN10 à VLAN20). En donnant le droit `administrateur` sur l'`Accès au VLAN` dans [la gestion des utilisateurs de votre espace client](/pages/bare_metal_cloud/managed_bare_metal/manager-ovhcloud#utilisateurs), vous pourrez créer des VLAN supplémentaires. En premier lieu, rendez vous dans la vue `mise en réseau` de votre client vSphere. Déployez le dossier **vrack** puis faites un clic droit sur le **dVS** finissant par *-vrack* et enfin cliquez sur `New Distributed Port Group`{.action}. diff --git a/pages/bare_metal_cloud/managed_bare_metal/vlan-creation/guide.pl-pl.md b/pages/bare_metal_cloud/managed_bare_metal/vlan-creation/guide.pl-pl.md index 00c8da7c8ff..31ca6653e40 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vlan-creation/guide.pl-pl.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vlan-creation/guide.pl-pl.md @@ -30,7 +30,7 @@ Pierwszy vDS dysponuje jednym rodzajem *portGroup*, VMnetwork pozwalający na ko Drugi serwer vDS dysponuje również jednym rodzajem *portGroup*, czyli siecią VLAN pozwalającą na odizolowanie prywatnej komunikacji wewnątrz Managed Bare Metal oraz między różnymi usługami OVHcloud kompatybilnymi z vRack (Serwer dedykowany, Public Cloud...). -W tym switchu 11 sieci VLAN są tworzone w oparciu o podstawowe projekty (VLAN10 w VLAN20). Dzięki uprawnieniu `administratora` do `dostępu do sieci VLAN` w [zarządzaniu użytkownikami w Panelu klienta](/pages/bare_metal_cloud/managed_bare_metal/manager-ovhcloud#uzytkownicy){.external-link}, będziesz mógł utworzyć dodatkowe sieci VLAN. +W tym switchu 11 sieci VLAN są tworzone w oparciu o podstawowe projekty (VLAN10 w VLAN20). Dzięki uprawnieniu `administratora` do `dostępu do sieci VLAN` w [zarządzaniu użytkownikami w Panelu klienta](/pages/bare_metal_cloud/managed_bare_metal/manager-ovhcloud#uzytkownicy), będziesz mógł utworzyć dodatkowe sieci VLAN. Po pierwsze, przejdź do widoku `tworzenia sieci` Twojego klienta vSphere. Uruchom folder **vrack**, kliknij prawym przyciskiem myszy na serwer **dVS** kończący się *-vrack*, a następnie kliknij `New Distributed Port Group`{.action}. diff --git a/pages/bare_metal_cloud/managed_bare_metal/vm_encrypt/images/image2018-3-15 10_27_49(1).png b/pages/bare_metal_cloud/managed_bare_metal/vm_encrypt/images/image2018-3-15 10_27_49(1).png deleted file mode 100644 index e7c4ca493bf..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/vm_encrypt/images/image2018-3-15 10_27_49(1).png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/vm_encrypt/images/vm-encrypt_manager_01.png b/pages/bare_metal_cloud/managed_bare_metal/vm_encrypt/images/vm-encrypt_manager_01.png deleted file mode 100644 index 024f8e52523..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/vm_encrypt/images/vm-encrypt_manager_01.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/vm_encrypt/images/vm-encrypt_manager_02.png b/pages/bare_metal_cloud/managed_bare_metal/vm_encrypt/images/vm-encrypt_manager_02.png deleted file mode 100644 index 1fd95f20747..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/vm_encrypt/images/vm-encrypt_manager_02.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/vmware_drs_distributed_ressource_scheduler/images/drs04.png b/pages/bare_metal_cloud/managed_bare_metal/vmware_drs_distributed_ressource_scheduler/images/drs04.png deleted file mode 100644 index ec15194924b..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/vmware_drs_distributed_ressource_scheduler/images/drs04.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/vmware_drs_distributed_ressource_scheduler/images/drs1.png b/pages/bare_metal_cloud/managed_bare_metal/vmware_drs_distributed_ressource_scheduler/images/drs1.png deleted file mode 100644 index 85c4ab852f6..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/vmware_drs_distributed_ressource_scheduler/images/drs1.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/vmware_drs_distributed_ressource_scheduler/images/drs2.png b/pages/bare_metal_cloud/managed_bare_metal/vmware_drs_distributed_ressource_scheduler/images/drs2.png deleted file mode 100644 index f534011d7b0..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/vmware_drs_distributed_ressource_scheduler/images/drs2.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/vmware_drs_distributed_ressource_scheduler/images/drs3.png b/pages/bare_metal_cloud/managed_bare_metal/vmware_drs_distributed_ressource_scheduler/images/drs3.png deleted file mode 100644 index a6bfd7606ff..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/vmware_drs_distributed_ressource_scheduler/images/drs3.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/vmware_drs_distributed_ressource_scheduler/images/drs4.png b/pages/bare_metal_cloud/managed_bare_metal/vmware_drs_distributed_ressource_scheduler/images/drs4.png deleted file mode 100644 index 48c0e917e84..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/vmware_drs_distributed_ressource_scheduler/images/drs4.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/vmware_drs_distributed_ressource_scheduler/images/drs5.png b/pages/bare_metal_cloud/managed_bare_metal/vmware_drs_distributed_ressource_scheduler/images/drs5.png deleted file mode 100644 index 3a99295fb2f..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/vmware_drs_distributed_ressource_scheduler/images/drs5.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.de-de.md b/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.de-de.md index 74a48b0a2a1..6314cd53cc8 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.de-de.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.de-de.md @@ -52,7 +52,7 @@ Nun haben Sie je nach Bedarf die Auswahl zwischen verschiedenen Aktionen. Ist **Fault Tolerance** bei einer virtuellen Maschine aktiviert, so sind einige Aktionen und der Gebrauch bestimmter Peripheriegeräte nicht mehr möglich. -Die Liste der nun nicht mehr unterstützten Aktionen finden Sie auf [dieser Seite](https://docs.vmware.com/de/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-F5264795-11DA-4242-B774-8C3450997033.html){.external-link}, eine Auflistung von Fällen von Inkompatibilität auf [dieser Seite](https://docs.vmware.com/de/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-C1749AD4-70E2-406C-864C-719F54BF1BC1.html){.external-link}. +Die Liste der nun nicht mehr unterstützten Aktionen finden Sie auf [dieser Seite](https://docs.vmware.com/de/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-F5264795-11DA-4242-B774-8C3450997033.html), eine Auflistung von Fällen von Inkompatibilität auf [dieser Seite](https://docs.vmware.com/de/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-C1749AD4-70E2-406C-864C-719F54BF1BC1.html). ## Weiterführende Informationen diff --git a/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.en-asia.md b/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.en-asia.md index 04948a05ea6..90130ca84ca 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.en-asia.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.en-asia.md @@ -52,7 +52,7 @@ Several operations are now available according to your needs. On a virtual machine with **Fault Tolerance** enabled, it is no longer possible to perform certain actions or to use certain devices. -Please refer to [this documentation](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-F5264795-11DA-4242-B774-8C3450997033.html){.external-link} for more details on the topic. A list of incompatible features and devices is available on [this page](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-C1749AD4-70E2-406C-864C-719F54BF1BC1.html){.external-link}. +Please refer to [this documentation](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-F5264795-11DA-4242-B774-8C3450997033.html) for more details on the topic. A list of incompatible features and devices is available on [this page](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-C1749AD4-70E2-406C-864C-719F54BF1BC1.html). ## Go further diff --git a/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.en-au.md b/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.en-au.md index 04948a05ea6..90130ca84ca 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.en-au.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.en-au.md @@ -52,7 +52,7 @@ Several operations are now available according to your needs. On a virtual machine with **Fault Tolerance** enabled, it is no longer possible to perform certain actions or to use certain devices. -Please refer to [this documentation](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-F5264795-11DA-4242-B774-8C3450997033.html){.external-link} for more details on the topic. A list of incompatible features and devices is available on [this page](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-C1749AD4-70E2-406C-864C-719F54BF1BC1.html){.external-link}. +Please refer to [this documentation](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-F5264795-11DA-4242-B774-8C3450997033.html) for more details on the topic. A list of incompatible features and devices is available on [this page](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-C1749AD4-70E2-406C-864C-719F54BF1BC1.html). ## Go further diff --git a/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.en-ca.md b/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.en-ca.md index 04948a05ea6..90130ca84ca 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.en-ca.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.en-ca.md @@ -52,7 +52,7 @@ Several operations are now available according to your needs. On a virtual machine with **Fault Tolerance** enabled, it is no longer possible to perform certain actions or to use certain devices. -Please refer to [this documentation](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-F5264795-11DA-4242-B774-8C3450997033.html){.external-link} for more details on the topic. A list of incompatible features and devices is available on [this page](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-C1749AD4-70E2-406C-864C-719F54BF1BC1.html){.external-link}. +Please refer to [this documentation](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-F5264795-11DA-4242-B774-8C3450997033.html) for more details on the topic. A list of incompatible features and devices is available on [this page](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-C1749AD4-70E2-406C-864C-719F54BF1BC1.html). ## Go further diff --git a/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.en-gb.md b/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.en-gb.md index 04948a05ea6..90130ca84ca 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.en-gb.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.en-gb.md @@ -52,7 +52,7 @@ Several operations are now available according to your needs. On a virtual machine with **Fault Tolerance** enabled, it is no longer possible to perform certain actions or to use certain devices. -Please refer to [this documentation](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-F5264795-11DA-4242-B774-8C3450997033.html){.external-link} for more details on the topic. A list of incompatible features and devices is available on [this page](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-C1749AD4-70E2-406C-864C-719F54BF1BC1.html){.external-link}. +Please refer to [this documentation](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-F5264795-11DA-4242-B774-8C3450997033.html) for more details on the topic. A list of incompatible features and devices is available on [this page](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-C1749AD4-70E2-406C-864C-719F54BF1BC1.html). ## Go further diff --git a/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.en-ie.md b/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.en-ie.md index 04948a05ea6..90130ca84ca 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.en-ie.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.en-ie.md @@ -52,7 +52,7 @@ Several operations are now available according to your needs. On a virtual machine with **Fault Tolerance** enabled, it is no longer possible to perform certain actions or to use certain devices. -Please refer to [this documentation](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-F5264795-11DA-4242-B774-8C3450997033.html){.external-link} for more details on the topic. A list of incompatible features and devices is available on [this page](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-C1749AD4-70E2-406C-864C-719F54BF1BC1.html){.external-link}. +Please refer to [this documentation](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-F5264795-11DA-4242-B774-8C3450997033.html) for more details on the topic. A list of incompatible features and devices is available on [this page](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-C1749AD4-70E2-406C-864C-719F54BF1BC1.html). ## Go further diff --git a/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.en-sg.md b/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.en-sg.md index 04948a05ea6..90130ca84ca 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.en-sg.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.en-sg.md @@ -52,7 +52,7 @@ Several operations are now available according to your needs. On a virtual machine with **Fault Tolerance** enabled, it is no longer possible to perform certain actions or to use certain devices. -Please refer to [this documentation](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-F5264795-11DA-4242-B774-8C3450997033.html){.external-link} for more details on the topic. A list of incompatible features and devices is available on [this page](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-C1749AD4-70E2-406C-864C-719F54BF1BC1.html){.external-link}. +Please refer to [this documentation](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-F5264795-11DA-4242-B774-8C3450997033.html) for more details on the topic. A list of incompatible features and devices is available on [this page](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-C1749AD4-70E2-406C-864C-719F54BF1BC1.html). ## Go further diff --git a/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.en-us.md b/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.en-us.md index 04948a05ea6..90130ca84ca 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.en-us.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.en-us.md @@ -52,7 +52,7 @@ Several operations are now available according to your needs. On a virtual machine with **Fault Tolerance** enabled, it is no longer possible to perform certain actions or to use certain devices. -Please refer to [this documentation](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-F5264795-11DA-4242-B774-8C3450997033.html){.external-link} for more details on the topic. A list of incompatible features and devices is available on [this page](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-C1749AD4-70E2-406C-864C-719F54BF1BC1.html){.external-link}. +Please refer to [this documentation](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-F5264795-11DA-4242-B774-8C3450997033.html) for more details on the topic. A list of incompatible features and devices is available on [this page](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-C1749AD4-70E2-406C-864C-719F54BF1BC1.html). ## Go further diff --git a/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.fr-ca.md b/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.fr-ca.md index 4b194543c5e..c2778ac4a71 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.fr-ca.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.fr-ca.md @@ -52,7 +52,7 @@ Plusieurs opérations sont dès lors disponibles en fonction de votre besoin. Sur une machine virtuelle avec **Fault Tolerance** activé, il n'est plus possible d'effectuer certaines actions, ni d'utiliser certains périphériques. -Vous retrouverez la liste des actions devenues impossibles sur [cette page](https://docs.vmware.com/fr/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-F5264795-11DA-4242-B774-8C3450997033.html){.external-link} et la liste des incompatibilités sur [celle-ci](https://docs.vmware.com/fr/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-C1749AD4-70E2-406C-864C-719F54BF1BC1.html){.external-link}. +Vous retrouverez la liste des actions devenues impossibles sur [cette page](https://docs.vmware.com/fr/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-F5264795-11DA-4242-B774-8C3450997033.html) et la liste des incompatibilités sur [celle-ci](https://docs.vmware.com/fr/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-C1749AD4-70E2-406C-864C-719F54BF1BC1.html). ## Aller plus loin diff --git a/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.fr-fr.md b/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.fr-fr.md index 4b194543c5e..c2778ac4a71 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.fr-fr.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.fr-fr.md @@ -52,7 +52,7 @@ Plusieurs opérations sont dès lors disponibles en fonction de votre besoin. Sur une machine virtuelle avec **Fault Tolerance** activé, il n'est plus possible d'effectuer certaines actions, ni d'utiliser certains périphériques. -Vous retrouverez la liste des actions devenues impossibles sur [cette page](https://docs.vmware.com/fr/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-F5264795-11DA-4242-B774-8C3450997033.html){.external-link} et la liste des incompatibilités sur [celle-ci](https://docs.vmware.com/fr/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-C1749AD4-70E2-406C-864C-719F54BF1BC1.html){.external-link}. +Vous retrouverez la liste des actions devenues impossibles sur [cette page](https://docs.vmware.com/fr/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-F5264795-11DA-4242-B774-8C3450997033.html) et la liste des incompatibilités sur [celle-ci](https://docs.vmware.com/fr/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-C1749AD4-70E2-406C-864C-719F54BF1BC1.html). ## Aller plus loin diff --git a/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.it-it.md b/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.it-it.md index e40f35377d5..744b4fabc5a 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.it-it.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.it-it.md @@ -52,7 +52,7 @@ In base alle necessità, sono disponibili diverse operazioni: Su una macchina virtuale con **Fault Tolerance** attivo non è possibile effettuare determinate operazioni né utilizzare alcune periferiche. -La lista delle azioni non supportate da questo servizio è disponibile in [questa pagina](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-F5264795-11DA-4242-B774-8C3450997033.html){.external-link}. Per visualizzare invece funzionalità e dispositivi non compatibili, clicca [qui](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-C1749AD4-70E2-406C-864C-719F54BF1BC1.html){.external-link}. +La lista delle azioni non supportate da questo servizio è disponibile in [questa pagina](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-F5264795-11DA-4242-B774-8C3450997033.html). Per visualizzare invece funzionalità e dispositivi non compatibili, clicca [qui](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-C1749AD4-70E2-406C-864C-719F54BF1BC1.html). ## Per saperne di più diff --git a/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.pl-pl.md b/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.pl-pl.md index 3484963352e..3cd49b145c8 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.pl-pl.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.pl-pl.md @@ -52,7 +52,7 @@ W zależności od Twoich potrzeb, dostępnych jest teraz kilka operacji. Na maszynie wirtualnej z włączoną funkcją **Fault Tolerance** nie jest możliwe wykonywanie pewnych działań ani korzystanie z niektórych urządzeń. -Lista niemożliwych do przeprowadzenia działań dostępna jest [na tej stronie](https://docs.vmware.com/fr/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-F5264795-11DA-4242-B774-8C3450997033.html){.external-link}, a lista niekompatybilności na [tej stronie](https://docs.vmware.com/fr/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-C1749AD4-70E2-406C-864C-719F54BF1BC1.html){.external-link}. +Lista niemożliwych do przeprowadzenia działań dostępna jest [na tej stronie](https://docs.vmware.com/fr/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-F5264795-11DA-4242-B774-8C3450997033.html), a lista niekompatybilności na [tej stronie](https://docs.vmware.com/fr/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-C1749AD4-70E2-406C-864C-719F54BF1BC1.html). ## Sprawdź również diff --git a/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.pt-pt.md b/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.pt-pt.md index 7daaf40f12f..95d6ba4d597 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.pt-pt.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/guide.pt-pt.md @@ -52,7 +52,7 @@ Estão disponíveis várias operações em função das suas necessidades. Numa máquina virtual com **Fault Tolerance** ativado, já não é possível efetuar certas ações, nem utilizar determinados periféricos. -Consulte a lista das ações impossíveis [nesta página](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-F5264795-11DA-4242-B774-8C3450997033.html){.external-link} e a lista das incompatibilidades [aqui](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-C1749AD4-70E2-406C-864C-719F54BF1BC1.html){.external-link}. +Consulte a lista das ações impossíveis [nesta página](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-F5264795-11DA-4242-B774-8C3450997033.html) e a lista das incompatibilidades [aqui](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-C1749AD4-70E2-406C-864C-719F54BF1BC1.html). ## Quer saber mais? diff --git a/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/images/FT10.png b/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/images/FT10.png deleted file mode 100644 index e0b7135f164..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/vmware_fault_tolerance/images/FT10.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/vmware_ha_high_availability/guide.de-de.md b/pages/bare_metal_cloud/managed_bare_metal/vmware_ha_high_availability/guide.de-de.md index ec71f6a5017..e70a15d50d0 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vmware_ha_high_availability/guide.de-de.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vmware_ha_high_availability/guide.de-de.md @@ -102,11 +102,11 @@ Die Zugangssteuerung legt Einschränkungen für die Ressourcenverwendung fest. A Grundlage der Zugangssteuerung von vSphere HA ist die Anzahl der Hostfehler, die das Cluster tolerieren darf, während die Failover-Funktion weiterhin gewährleistet bleibt. Die Failover-Kapazität der Hosts kann auf drei verschiedene Arten definiert werden: -- [Prozentsatz der Clusterressourcen](https://docs.vmware.com/de/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-FAFEFEFF-56F7-4CDF-A682-FC3C62A29A95.html){.external-link} +- [Prozentsatz der Clusterressourcen](https://docs.vmware.com/de/VMware-vSphere/6.7/com.vmware.vsphere.avail.doc/GUID-FAFEFEFF-56F7-4CDF-A682-FC3C62A29A95.html) -- [Richtlinie für die Steckplatzgröße](https://docs.vmware.com/de/VMware-vSphere/6.5/com.vmware.vsphere.avail.doc/GUID-85D9737E-769C-40B6-AB73-F58DA1A451F0.html){.external-link} +- [Richtlinie für die Steckplatzgröße](https://docs.vmware.com/de/VMware-vSphere/6.5/com.vmware.vsphere.avail.doc/GUID-85D9737E-769C-40B6-AB73-F58DA1A451F0.html) -- [dedizierte Failover-Hosts](https://docs.vmware.com/de/VMware-vSphere/6.5/com.vmware.vsphere.avail.doc/GUID-C4F5F9EE-4235-4151-BEBE-FCB2A752407B.html){.external-link} +- [dedizierte Failover-Hosts](https://docs.vmware.com/de/VMware-vSphere/6.5/com.vmware.vsphere.avail.doc/GUID-C4F5F9EE-4235-4151-BEBE-FCB2A752407B.html) #### Taktsignal-Datenspeicher @@ -116,7 +116,7 @@ Wenn der Master-Host in einem HA-Cluster nicht über das Verwaltungsnetzwerk mit Sie können mehrere erweiterte Konfigurationseinstellungen in Ihrem Cluster verwenden. -Die Einstellungen finden Sie auf [dieser Seite](https://docs.vmware.com/de/VMware-vSphere/6.5/com.vmware.vsphere.avail.doc/GUID-E0161CB5-BD3F-425F-A7E0-BF83B005FECA.html){.external-link}. +Die Einstellungen finden Sie auf [dieser Seite](https://docs.vmware.com/de/VMware-vSphere/6.5/com.vmware.vsphere.avail.doc/GUID-E0161CB5-BD3F-425F-A7E0-BF83B005FECA.html). ### HA-Regel diff --git a/pages/bare_metal_cloud/managed_bare_metal/vmware_ha_high_availability/guide.es-es.md b/pages/bare_metal_cloud/managed_bare_metal/vmware_ha_high_availability/guide.es-es.md index 9ba5d1df2e6..31a8cfdef03 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vmware_ha_high_availability/guide.es-es.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vmware_ha_high_availability/guide.es-es.md @@ -102,11 +102,11 @@ El control de admisión impone restricciones sobre el uso de recursos. No se per El control de admisión de vSphere HA se basa en la cantidad de errores de host que el clúster puede tolerar sin perder la capacidad de conmutación por error. La capacidad de conmutación por error del host puede definirse de tres formas: -- [Porcentaje de recursos del cluster](https://docs.vmware.com/es/VMware-vSphere/6.5/com.vmware.vsphere.avail.doc/GUID-FAFEFEFF-56F7-4CDF-A682-FC3C62A29A95.html){.external-link} +- [Porcentaje de recursos del cluster](https://docs.vmware.com/es/VMware-vSphere/6.5/com.vmware.vsphere.avail.doc/GUID-FAFEFEFF-56F7-4CDF-A682-FC3C62A29A95.html) -- [Directiva de ranuras](https://docs.vmware.com/es/VMware-vSphere/6.5/com.vmware.vsphere.avail.doc/GUID-85D9737E-769C-40B6-AB73-F58DA1A451F0.html){.external-link} +- [Directiva de ranuras](https://docs.vmware.com/es/VMware-vSphere/6.5/com.vmware.vsphere.avail.doc/GUID-85D9737E-769C-40B6-AB73-F58DA1A451F0.html) -- [Hosts de conmutación por error dedicados](https://docs.vmware.com/es/VMware-vSphere/6.5/com.vmware.vsphere.avail.doc/GUID-C4F5F9EE-4235-4151-BEBE-FCB2A752407B.html){.external-link} +- [Hosts de conmutación por error dedicados](https://docs.vmware.com/es/VMware-vSphere/6.5/com.vmware.vsphere.avail.doc/GUID-C4F5F9EE-4235-4151-BEBE-FCB2A752407B.html) #### Almacén de datos de latidos @@ -116,7 +116,7 @@ Cuando el host principal de un cluster HA no puede comunicarse con un host subor Es posible realizar varios ajustes de configuración avanzada en el cluster. -Para ello, debe dirigirse a [esta página](https://docs.vmware.com/es/VMware-vSphere/6.5/com.vmware.vsphere.avail.doc/GUID-E0161CB5-BD3F-425F-A7E0-BF83B005FECA.html){.external-link}. +Para ello, debe dirigirse a [esta página](https://docs.vmware.com/es/VMware-vSphere/6.5/com.vmware.vsphere.avail.doc/GUID-E0161CB5-BD3F-425F-A7E0-BF83B005FECA.html). ### Regla HA diff --git a/pages/bare_metal_cloud/managed_bare_metal/vmware_ha_high_availability/guide.es-us.md b/pages/bare_metal_cloud/managed_bare_metal/vmware_ha_high_availability/guide.es-us.md index 9ba5d1df2e6..31a8cfdef03 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vmware_ha_high_availability/guide.es-us.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vmware_ha_high_availability/guide.es-us.md @@ -102,11 +102,11 @@ El control de admisión impone restricciones sobre el uso de recursos. No se per El control de admisión de vSphere HA se basa en la cantidad de errores de host que el clúster puede tolerar sin perder la capacidad de conmutación por error. La capacidad de conmutación por error del host puede definirse de tres formas: -- [Porcentaje de recursos del cluster](https://docs.vmware.com/es/VMware-vSphere/6.5/com.vmware.vsphere.avail.doc/GUID-FAFEFEFF-56F7-4CDF-A682-FC3C62A29A95.html){.external-link} +- [Porcentaje de recursos del cluster](https://docs.vmware.com/es/VMware-vSphere/6.5/com.vmware.vsphere.avail.doc/GUID-FAFEFEFF-56F7-4CDF-A682-FC3C62A29A95.html) -- [Directiva de ranuras](https://docs.vmware.com/es/VMware-vSphere/6.5/com.vmware.vsphere.avail.doc/GUID-85D9737E-769C-40B6-AB73-F58DA1A451F0.html){.external-link} +- [Directiva de ranuras](https://docs.vmware.com/es/VMware-vSphere/6.5/com.vmware.vsphere.avail.doc/GUID-85D9737E-769C-40B6-AB73-F58DA1A451F0.html) -- [Hosts de conmutación por error dedicados](https://docs.vmware.com/es/VMware-vSphere/6.5/com.vmware.vsphere.avail.doc/GUID-C4F5F9EE-4235-4151-BEBE-FCB2A752407B.html){.external-link} +- [Hosts de conmutación por error dedicados](https://docs.vmware.com/es/VMware-vSphere/6.5/com.vmware.vsphere.avail.doc/GUID-C4F5F9EE-4235-4151-BEBE-FCB2A752407B.html) #### Almacén de datos de latidos @@ -116,7 +116,7 @@ Cuando el host principal de un cluster HA no puede comunicarse con un host subor Es posible realizar varios ajustes de configuración avanzada en el cluster. -Para ello, debe dirigirse a [esta página](https://docs.vmware.com/es/VMware-vSphere/6.5/com.vmware.vsphere.avail.doc/GUID-E0161CB5-BD3F-425F-A7E0-BF83B005FECA.html){.external-link}. +Para ello, debe dirigirse a [esta página](https://docs.vmware.com/es/VMware-vSphere/6.5/com.vmware.vsphere.avail.doc/GUID-E0161CB5-BD3F-425F-A7E0-BF83B005FECA.html). ### Regla HA diff --git a/pages/bare_metal_cloud/managed_bare_metal/vmware_ha_high_availability/guide.fr-ca.md b/pages/bare_metal_cloud/managed_bare_metal/vmware_ha_high_availability/guide.fr-ca.md index 584ed63b424..4377058df49 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vmware_ha_high_availability/guide.fr-ca.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vmware_ha_high_availability/guide.fr-ca.md @@ -102,11 +102,11 @@ Le contrôle d'admission impose des contraintes sur l'utilisation des ressources La base du contrôle d'admission vSphere HA est le nombre de défaillances d'hôte que le cluster est autorisé à tolérer et qui continue à garantir le basculement. La capacité de basculement des hôtes peut être définie de trois manières différentes : -- [Pourcentage de ressources du cluster](https://docs.vmware.com/fr/VMware-vSphere/6.5/com.vmware.vsphere.avail.doc/GUID-FAFEFEFF-56F7-4CDF-A682-FC3C62A29A95.html){.external-link} +- [Pourcentage de ressources du cluster](https://docs.vmware.com/fr/VMware-vSphere/6.5/com.vmware.vsphere.avail.doc/GUID-FAFEFEFF-56F7-4CDF-A682-FC3C62A29A95.html) -- [Stratégie d'emplacement](https://docs.vmware.com/fr/VMware-vSphere/6.5/com.vmware.vsphere.avail.doc/GUID-85D9737E-769C-40B6-AB73-F58DA1A451F0.html){.external-link} +- [Stratégie d'emplacement](https://docs.vmware.com/fr/VMware-vSphere/6.5/com.vmware.vsphere.avail.doc/GUID-85D9737E-769C-40B6-AB73-F58DA1A451F0.html) -- [Hôtes de basculement dédiés](https://docs.vmware.com/fr/VMware-vSphere/6.5/com.vmware.vsphere.avail.doc/GUID-C4F5F9EE-4235-4151-BEBE-FCB2A752407B.html){.external-link} +- [Hôtes de basculement dédiés](https://docs.vmware.com/fr/VMware-vSphere/6.5/com.vmware.vsphere.avail.doc/GUID-C4F5F9EE-4235-4151-BEBE-FCB2A752407B.html) #### Banques de données de signal de pulsation @@ -116,7 +116,7 @@ Lorsque l'hôte principal d'un cluster HA ne peut pas communiquer avec un hôte Plusieurs paramètres de configuration avancée peuvent être utilisés dans votre cluster. -Vous pouvez retrouver des paramètres sur [cette page](https://docs.vmware.com/fr/VMware-vSphere/6.5/com.vmware.vsphere.avail.doc/GUID-E0161CB5-BD3F-425F-A7E0-BF83B005FECA.html){.external-link}. +Vous pouvez retrouver des paramètres sur [cette page](https://docs.vmware.com/fr/VMware-vSphere/6.5/com.vmware.vsphere.avail.doc/GUID-E0161CB5-BD3F-425F-A7E0-BF83B005FECA.html). ### Règle HA diff --git a/pages/bare_metal_cloud/managed_bare_metal/vmware_ha_high_availability/guide.fr-fr.md b/pages/bare_metal_cloud/managed_bare_metal/vmware_ha_high_availability/guide.fr-fr.md index ac93febe79a..3cba2d4272e 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vmware_ha_high_availability/guide.fr-fr.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vmware_ha_high_availability/guide.fr-fr.md @@ -102,11 +102,11 @@ Le contrôle d'admission impose des contraintes sur l'utilisation des ressources La base du contrôle d'admission vSphere HA est le nombre de défaillances d'hôte que le cluster est autorisé à tolérer et qui continue à garantir le basculement. La capacité de basculement des hôtes peut être définie de trois manières différentes : -- [Pourcentage de ressources du cluster](https://docs.vmware.com/fr/VMware-vSphere/6.5/com.vmware.vsphere.avail.doc/GUID-FAFEFEFF-56F7-4CDF-A682-FC3C62A29A95.html){.external-link} +- [Pourcentage de ressources du cluster](https://docs.vmware.com/fr/VMware-vSphere/6.5/com.vmware.vsphere.avail.doc/GUID-FAFEFEFF-56F7-4CDF-A682-FC3C62A29A95.html) -- [Stratégie d'emplacement](https://docs.vmware.com/fr/VMware-vSphere/6.5/com.vmware.vsphere.avail.doc/GUID-85D9737E-769C-40B6-AB73-F58DA1A451F0.html){.external-link} +- [Stratégie d'emplacement](https://docs.vmware.com/fr/VMware-vSphere/6.5/com.vmware.vsphere.avail.doc/GUID-85D9737E-769C-40B6-AB73-F58DA1A451F0.html) -- [Hôtes de basculement dédiés](https://docs.vmware.com/fr/VMware-vSphere/6.5/com.vmware.vsphere.avail.doc/GUID-C4F5F9EE-4235-4151-BEBE-FCB2A752407B.html){.external-link} +- [Hôtes de basculement dédiés](https://docs.vmware.com/fr/VMware-vSphere/6.5/com.vmware.vsphere.avail.doc/GUID-C4F5F9EE-4235-4151-BEBE-FCB2A752407B.html) #### Banques de données de signal de pulsation @@ -116,7 +116,7 @@ Lorsque l'hôte principal d'un cluster HA ne peut pas communiquer avec un hôte Plusieurs paramètres de configuration avancée peuvent être utilisés dans votre cluster. -Vous pouvez retrouver des paramètres sur [cette page](https://docs.vmware.com/fr/VMware-vSphere/6.5/com.vmware.vsphere.avail.doc/GUID-E0161CB5-BD3F-425F-A7E0-BF83B005FECA.html){.external-link}. +Vous pouvez retrouver des paramètres sur [cette page](https://docs.vmware.com/fr/VMware-vSphere/6.5/com.vmware.vsphere.avail.doc/GUID-E0161CB5-BD3F-425F-A7E0-BF83B005FECA.html). ### Règle HA diff --git a/pages/bare_metal_cloud/managed_bare_metal/vmware_ha_high_availability/guide.pt-pt.md b/pages/bare_metal_cloud/managed_bare_metal/vmware_ha_high_availability/guide.pt-pt.md index 3f7dfcc4833..cdcd8dfc968 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vmware_ha_high_availability/guide.pt-pt.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vmware_ha_high_availability/guide.pt-pt.md @@ -102,11 +102,11 @@ O controlo de admissão impõe limites à utilização dos recursos. Não são a A base do controlo de admissão da HA do vSphere é o número de falhas de hosts que o cluster é autorizado a tolerar e que continua a garantir o fail-over. A capacidade de fail-over dos hosts pode ser definida de três formas distintas: -- [Percentagem de recursos do cluster](https://docs.vmware.com/en/VMware-vSphere/6.5/com.vmware.vsphere.avail.doc/GUID-FAFEFEFF-56F7-4CDF-A682-FC3C62A29A95.html){.external-link} +- [Percentagem de recursos do cluster](https://docs.vmware.com/en/VMware-vSphere/6.5/com.vmware.vsphere.avail.doc/GUID-FAFEFEFF-56F7-4CDF-A682-FC3C62A29A95.html) -- [Estratégia de slot](https://docs.vmware.com/en/VMware-vSphere/6.5/com.vmware.vsphere.avail.doc/GUID-85D9737E-769C-40B6-AB73-F58DA1A451F0.html){.external-link} +- [Estratégia de slot](https://docs.vmware.com/en/VMware-vSphere/6.5/com.vmware.vsphere.avail.doc/GUID-85D9737E-769C-40B6-AB73-F58DA1A451F0.html) -- [Hosts de fail-over dedicados](https://docs.vmware.com/en/VMware-vSphere/6.5/com.vmware.vsphere.avail.doc/GUID-C4F5F9EE-4235-4151-BEBE-FCB2A752407B.html){.external-link} +- [Hosts de fail-over dedicados](https://docs.vmware.com/en/VMware-vSphere/6.5/com.vmware.vsphere.avail.doc/GUID-C4F5F9EE-4235-4151-BEBE-FCB2A752407B.html) #### Datastore de sinal de pulsação @@ -116,7 +116,7 @@ Quando o host principal de um cluster HA não consegue comunicar com um host sub O seu cluster pode ser sujeito a vários parâmetros de configuração avançada. -Encontre esses parâmetros [nesta página](https://docs.vmware.com/en/VMware-vSphere/6.5/com.vmware.vsphere.avail.doc/GUID-E0161CB5-BD3F-425F-A7E0-BF83B005FECA.html){.external-link}. +Encontre esses parâmetros [nesta página](https://docs.vmware.com/en/VMware-vSphere/6.5/com.vmware.vsphere.avail.doc/GUID-E0161CB5-BD3F-425F-A7E0-BF83B005FECA.html). ### Regra HA diff --git a/pages/bare_metal_cloud/managed_bare_metal/vmware_ha_high_availability/images/HA4.png b/pages/bare_metal_cloud/managed_bare_metal/vmware_ha_high_availability/images/HA4.png deleted file mode 100644 index 10d69cde591..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/vmware_ha_high_availability/images/HA4.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/vmware_ha_high_availability/images/HArule.PNG b/pages/bare_metal_cloud/managed_bare_metal/vmware_ha_high_availability/images/HArule.PNG deleted file mode 100644 index b2675ae4913..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/vmware_ha_high_availability/images/HArule.PNG and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/vmware_ha_high_availability/images/ha5.png b/pages/bare_metal_cloud/managed_bare_metal/vmware_ha_high_availability/images/ha5.png deleted file mode 100644 index 020547a5b2d..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/vmware_ha_high_availability/images/ha5.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/vmware_ha_high_availability/images/ha6.png b/pages/bare_metal_cloud/managed_bare_metal/vmware_ha_high_availability/images/ha6.png deleted file mode 100644 index 1a96de92f3d..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/vmware_ha_high_availability/images/ha6.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/vmware_ha_high_availability/images/ha7.png b/pages/bare_metal_cloud/managed_bare_metal/vmware_ha_high_availability/images/ha7.png deleted file mode 100644 index 96d478f93a3..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/vmware_ha_high_availability/images/ha7.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.de-de.md b/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.de-de.md index 1decf8d8159..9c552cab45a 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.de-de.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.de-de.md @@ -20,13 +20,13 @@ VMware Tools verbessern die Performance einer virtuellen Maschine und ermöglich ## In der praktischen Anwendung -Die Vorgehensweise zur Installation von VMware Tools variiert je nach Betriebssystem der virtuellen Maschine. Für Informationen zur genauen Vorgehensweise entsprechend dem Betriebssystem lesen Sie die [VMware-Dokumentation zu VMware Tools](https://kb.vmware.com/s/article/1014294){.external-link}. +Die Vorgehensweise zur Installation von VMware Tools variiert je nach Betriebssystem der virtuellen Maschine. Für Informationen zur genauen Vorgehensweise entsprechend dem Betriebssystem lesen Sie die [VMware-Dokumentation zu VMware Tools](https://kb.vmware.com/s/article/1014294). ### Linux #### Neueste Versionen -Bei den meisten Linux-Distributionen ist die Installation der VMware Tools über die Linux-Paketverwaltungssysteme unter dem Namen [*Open VM Tools*](https://kb.vmware.com/s/article/2073803){.external-link} möglich. +Bei den meisten Linux-Distributionen ist die Installation der VMware Tools über die Linux-Paketverwaltungssysteme unter dem Namen [*Open VM Tools*](https://kb.vmware.com/s/article/2073803) möglich. So können die VMware Tools genauso auf dem aktuellen Stand gehalten werden wie die anderen Betriebssystemkomponenten der virtuellen Maschine. diff --git a/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.en-asia.md b/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.en-asia.md index 11545a3e8ce..0401ae63a9d 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.en-asia.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.en-asia.md @@ -16,13 +16,13 @@ VMware Tools improve the performance of a virtual machine and enable many of its ## Instructions -The procedure for installing VMware Tools varies depending on the operating system of the virtual machine. For information about the specific procedure for each OS, see the VMware [documentation for VMware Tools](https://kb.vmware.com/s/article/1014294){.external-link}. +The procedure for installing VMware Tools varies depending on the operating system of the virtual machine. For information about the specific procedure for each OS, see the VMware [documentation for VMware Tools](https://kb.vmware.com/s/article/1014294). ### Linux #### Recent versions -Most recent Linux distributions offer the installation of VMware Tools via their package management systems, under the name [*Open VM Tools*](https://kb.vmware.com/s/article/2073803){.external-link}. +Most recent Linux distributions offer the installation of VMware Tools via their package management systems, under the name [*Open VM Tools*](https://kb.vmware.com/s/article/2073803). This allows VMware Tools to be kept up-to-date in the same way as other components of the VM's operating system. diff --git a/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.en-au.md b/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.en-au.md index 11545a3e8ce..0401ae63a9d 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.en-au.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.en-au.md @@ -16,13 +16,13 @@ VMware Tools improve the performance of a virtual machine and enable many of its ## Instructions -The procedure for installing VMware Tools varies depending on the operating system of the virtual machine. For information about the specific procedure for each OS, see the VMware [documentation for VMware Tools](https://kb.vmware.com/s/article/1014294){.external-link}. +The procedure for installing VMware Tools varies depending on the operating system of the virtual machine. For information about the specific procedure for each OS, see the VMware [documentation for VMware Tools](https://kb.vmware.com/s/article/1014294). ### Linux #### Recent versions -Most recent Linux distributions offer the installation of VMware Tools via their package management systems, under the name [*Open VM Tools*](https://kb.vmware.com/s/article/2073803){.external-link}. +Most recent Linux distributions offer the installation of VMware Tools via their package management systems, under the name [*Open VM Tools*](https://kb.vmware.com/s/article/2073803). This allows VMware Tools to be kept up-to-date in the same way as other components of the VM's operating system. diff --git a/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.en-ca.md b/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.en-ca.md index 11545a3e8ce..0401ae63a9d 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.en-ca.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.en-ca.md @@ -16,13 +16,13 @@ VMware Tools improve the performance of a virtual machine and enable many of its ## Instructions -The procedure for installing VMware Tools varies depending on the operating system of the virtual machine. For information about the specific procedure for each OS, see the VMware [documentation for VMware Tools](https://kb.vmware.com/s/article/1014294){.external-link}. +The procedure for installing VMware Tools varies depending on the operating system of the virtual machine. For information about the specific procedure for each OS, see the VMware [documentation for VMware Tools](https://kb.vmware.com/s/article/1014294). ### Linux #### Recent versions -Most recent Linux distributions offer the installation of VMware Tools via their package management systems, under the name [*Open VM Tools*](https://kb.vmware.com/s/article/2073803){.external-link}. +Most recent Linux distributions offer the installation of VMware Tools via their package management systems, under the name [*Open VM Tools*](https://kb.vmware.com/s/article/2073803). This allows VMware Tools to be kept up-to-date in the same way as other components of the VM's operating system. diff --git a/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.en-gb.md b/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.en-gb.md index 11545a3e8ce..0401ae63a9d 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.en-gb.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.en-gb.md @@ -16,13 +16,13 @@ VMware Tools improve the performance of a virtual machine and enable many of its ## Instructions -The procedure for installing VMware Tools varies depending on the operating system of the virtual machine. For information about the specific procedure for each OS, see the VMware [documentation for VMware Tools](https://kb.vmware.com/s/article/1014294){.external-link}. +The procedure for installing VMware Tools varies depending on the operating system of the virtual machine. For information about the specific procedure for each OS, see the VMware [documentation for VMware Tools](https://kb.vmware.com/s/article/1014294). ### Linux #### Recent versions -Most recent Linux distributions offer the installation of VMware Tools via their package management systems, under the name [*Open VM Tools*](https://kb.vmware.com/s/article/2073803){.external-link}. +Most recent Linux distributions offer the installation of VMware Tools via their package management systems, under the name [*Open VM Tools*](https://kb.vmware.com/s/article/2073803). This allows VMware Tools to be kept up-to-date in the same way as other components of the VM's operating system. diff --git a/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.en-ie.md b/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.en-ie.md index 11545a3e8ce..0401ae63a9d 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.en-ie.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.en-ie.md @@ -16,13 +16,13 @@ VMware Tools improve the performance of a virtual machine and enable many of its ## Instructions -The procedure for installing VMware Tools varies depending on the operating system of the virtual machine. For information about the specific procedure for each OS, see the VMware [documentation for VMware Tools](https://kb.vmware.com/s/article/1014294){.external-link}. +The procedure for installing VMware Tools varies depending on the operating system of the virtual machine. For information about the specific procedure for each OS, see the VMware [documentation for VMware Tools](https://kb.vmware.com/s/article/1014294). ### Linux #### Recent versions -Most recent Linux distributions offer the installation of VMware Tools via their package management systems, under the name [*Open VM Tools*](https://kb.vmware.com/s/article/2073803){.external-link}. +Most recent Linux distributions offer the installation of VMware Tools via their package management systems, under the name [*Open VM Tools*](https://kb.vmware.com/s/article/2073803). This allows VMware Tools to be kept up-to-date in the same way as other components of the VM's operating system. diff --git a/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.en-sg.md b/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.en-sg.md index 11545a3e8ce..0401ae63a9d 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.en-sg.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.en-sg.md @@ -16,13 +16,13 @@ VMware Tools improve the performance of a virtual machine and enable many of its ## Instructions -The procedure for installing VMware Tools varies depending on the operating system of the virtual machine. For information about the specific procedure for each OS, see the VMware [documentation for VMware Tools](https://kb.vmware.com/s/article/1014294){.external-link}. +The procedure for installing VMware Tools varies depending on the operating system of the virtual machine. For information about the specific procedure for each OS, see the VMware [documentation for VMware Tools](https://kb.vmware.com/s/article/1014294). ### Linux #### Recent versions -Most recent Linux distributions offer the installation of VMware Tools via their package management systems, under the name [*Open VM Tools*](https://kb.vmware.com/s/article/2073803){.external-link}. +Most recent Linux distributions offer the installation of VMware Tools via their package management systems, under the name [*Open VM Tools*](https://kb.vmware.com/s/article/2073803). This allows VMware Tools to be kept up-to-date in the same way as other components of the VM's operating system. diff --git a/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.en-us.md b/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.en-us.md index 11545a3e8ce..0401ae63a9d 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.en-us.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.en-us.md @@ -16,13 +16,13 @@ VMware Tools improve the performance of a virtual machine and enable many of its ## Instructions -The procedure for installing VMware Tools varies depending on the operating system of the virtual machine. For information about the specific procedure for each OS, see the VMware [documentation for VMware Tools](https://kb.vmware.com/s/article/1014294){.external-link}. +The procedure for installing VMware Tools varies depending on the operating system of the virtual machine. For information about the specific procedure for each OS, see the VMware [documentation for VMware Tools](https://kb.vmware.com/s/article/1014294). ### Linux #### Recent versions -Most recent Linux distributions offer the installation of VMware Tools via their package management systems, under the name [*Open VM Tools*](https://kb.vmware.com/s/article/2073803){.external-link}. +Most recent Linux distributions offer the installation of VMware Tools via their package management systems, under the name [*Open VM Tools*](https://kb.vmware.com/s/article/2073803). This allows VMware Tools to be kept up-to-date in the same way as other components of the VM's operating system. diff --git a/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.es-es.md b/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.es-es.md index 5123f462ef1..c35e8dc2eab 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.es-es.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.es-es.md @@ -20,13 +20,13 @@ VMware Tools mejora el rendimiento de una máquina virtual y permite utilizar mu ## Procedimiento -El procedimiento de instalación de VMware Tools depende del sistema operativo de la máquina virtual. Para consultar el procedimiento específico de cada sistema operativo, consulte la [documentación de VMware sobre VMware Tools](https://kb.vmware.com/s/article/1014294){.external-link}. +El procedimiento de instalación de VMware Tools depende del sistema operativo de la máquina virtual. Para consultar el procedimiento específico de cada sistema operativo, consulte la [documentación de VMware sobre VMware Tools](https://kb.vmware.com/s/article/1014294). ### Linux #### Versiones recientes -La mayoría de las distribuciones Linux recientes permiten instalar VMware Tools a través de sus sistemas de gestión de paquetes, con el nombre [Open VM Tools](https://kb.vmware.com/s/article/2073803){.external-link}. +La mayoría de las distribuciones Linux recientes permiten instalar VMware Tools a través de sus sistemas de gestión de paquetes, con el nombre [Open VM Tools](https://kb.vmware.com/s/article/2073803). Eso permite mantener VMware Tools actualizado del mismo modo que los demás componentes del sistema operativo de la máquina virtual. diff --git a/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.es-us.md b/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.es-us.md index 5123f462ef1..c35e8dc2eab 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.es-us.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.es-us.md @@ -20,13 +20,13 @@ VMware Tools mejora el rendimiento de una máquina virtual y permite utilizar mu ## Procedimiento -El procedimiento de instalación de VMware Tools depende del sistema operativo de la máquina virtual. Para consultar el procedimiento específico de cada sistema operativo, consulte la [documentación de VMware sobre VMware Tools](https://kb.vmware.com/s/article/1014294){.external-link}. +El procedimiento de instalación de VMware Tools depende del sistema operativo de la máquina virtual. Para consultar el procedimiento específico de cada sistema operativo, consulte la [documentación de VMware sobre VMware Tools](https://kb.vmware.com/s/article/1014294). ### Linux #### Versiones recientes -La mayoría de las distribuciones Linux recientes permiten instalar VMware Tools a través de sus sistemas de gestión de paquetes, con el nombre [Open VM Tools](https://kb.vmware.com/s/article/2073803){.external-link}. +La mayoría de las distribuciones Linux recientes permiten instalar VMware Tools a través de sus sistemas de gestión de paquetes, con el nombre [Open VM Tools](https://kb.vmware.com/s/article/2073803). Eso permite mantener VMware Tools actualizado del mismo modo que los demás componentes del sistema operativo de la máquina virtual. diff --git a/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.fr-ca.md b/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.fr-ca.md index 1902c722b96..025a6b48a8d 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.fr-ca.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.fr-ca.md @@ -16,13 +16,13 @@ Les VMware Tools améliorent les performances d'une machine virtuelle et permett ## En pratique -La procédure d'installation des VMware Tools varie en fonction du système d'exploitation de la machine virtuelle. Pour obtenir des informations concernant la procédure spécifique à chaque OS, consultez la [documentation VMware concernant les VMware Tools](https://kb.vmware.com/s/article/1014294){.external-link}. +La procédure d'installation des VMware Tools varie en fonction du système d'exploitation de la machine virtuelle. Pour obtenir des informations concernant la procédure spécifique à chaque OS, consultez la [documentation VMware concernant les VMware Tools](https://kb.vmware.com/s/article/1014294). ### Linux #### Versions récentes -La plupart des distributions Linux récentes proposent l'installation des VMware Tools via leurs systèmes de gestion de paquets, sous le nom [*Open VM Tools*](https://kb.vmware.com/s/article/2073803){.external-link}. +La plupart des distributions Linux récentes proposent l'installation des VMware Tools via leurs systèmes de gestion de paquets, sous le nom [*Open VM Tools*](https://kb.vmware.com/s/article/2073803). Cela permet de maintenir à jour les VMware Tools de la même manière que les autres composants du système d'exploitation de la machine virtuelle. diff --git a/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.fr-fr.md b/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.fr-fr.md index 1902c722b96..025a6b48a8d 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.fr-fr.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.fr-fr.md @@ -16,13 +16,13 @@ Les VMware Tools améliorent les performances d'une machine virtuelle et permett ## En pratique -La procédure d'installation des VMware Tools varie en fonction du système d'exploitation de la machine virtuelle. Pour obtenir des informations concernant la procédure spécifique à chaque OS, consultez la [documentation VMware concernant les VMware Tools](https://kb.vmware.com/s/article/1014294){.external-link}. +La procédure d'installation des VMware Tools varie en fonction du système d'exploitation de la machine virtuelle. Pour obtenir des informations concernant la procédure spécifique à chaque OS, consultez la [documentation VMware concernant les VMware Tools](https://kb.vmware.com/s/article/1014294). ### Linux #### Versions récentes -La plupart des distributions Linux récentes proposent l'installation des VMware Tools via leurs systèmes de gestion de paquets, sous le nom [*Open VM Tools*](https://kb.vmware.com/s/article/2073803){.external-link}. +La plupart des distributions Linux récentes proposent l'installation des VMware Tools via leurs systèmes de gestion de paquets, sous le nom [*Open VM Tools*](https://kb.vmware.com/s/article/2073803). Cela permet de maintenir à jour les VMware Tools de la même manière que les autres composants du système d'exploitation de la machine virtuelle. diff --git a/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.it-it.md b/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.it-it.md index c718b36fc27..ef5c7071da5 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.it-it.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.it-it.md @@ -20,13 +20,13 @@ VMware Tools è un software che migliora le performance di una macchina virtuale ## Procedura -Il processo di installazione di VMware Tools varia in base al sistema operativo della VM. Per maggiori informazioni sul procedimento da seguire sui diversi sistemi operativi, consulta la [documentazione ufficiale VMware](https://kb.vmware.com/s/article/1014294){.external-link}. +Il processo di installazione di VMware Tools varia in base al sistema operativo della VM. Per maggiori informazioni sul procedimento da seguire sui diversi sistemi operativi, consulta la [documentazione ufficiale VMware](https://kb.vmware.com/s/article/1014294). ### Linux #### Versioni recenti -La maggior parte delle distribuzioni Linux recenti permettono di installare VMware Tools direttamente tramite il loro gestore di pacchetti, [*Open VM Tools*](https://kb.vmware.com/s/article/2073803){.external-link}. +La maggior parte delle distribuzioni Linux recenti permettono di installare VMware Tools direttamente tramite il loro gestore di pacchetti, [*Open VM Tools*](https://kb.vmware.com/s/article/2073803). In questo modo viene garantito il regolare aggiornamento sia di MVware Tools che degli altri componenti del sistema operativo della macchina virtuale. diff --git a/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.pt-pt.md b/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.pt-pt.md index a241f8fa3bc..1e32e866617 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.pt-pt.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/guide.pt-pt.md @@ -12,13 +12,13 @@ As VMware Tools melhoram os desempenhos de uma máquina virtual e permitem utili ## Instruções -O processo de instalação das VMware Tools varia em função do sistema operativo da máquina virtual. Para obter informações sobre o procedimento específico de cada SO, consulte a [documentação VMware sobre as VMware Tools](https://kb.vmware.com/s/article/1014294){.external-link}. +O processo de instalação das VMware Tools varia em função do sistema operativo da máquina virtual. Para obter informações sobre o procedimento específico de cada SO, consulte a [documentação VMware sobre as VMware Tools](https://kb.vmware.com/s/article/1014294). ## Linux ### Versões recentes -A maioria das distribuições Linux recentes oferecem a instalação das VMware Tools através dos sistemas de gestão de pacotes, com o nome [*Open VM Tools*](https://kb.vmware.com/s/article/2073803){.external-link}. +A maioria das distribuições Linux recentes oferecem a instalação das VMware Tools através dos sistemas de gestão de pacotes, com o nome [*Open VM Tools*](https://kb.vmware.com/s/article/2073803). Isto permite manter as VMware Tools atualizadas da mesma forma que os outros componentes do sistema operativo da máquina virtual. diff --git a/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/images/tools1.png b/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/images/tools1.png deleted file mode 100644 index bb8637b0e23..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/images/tools1.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/images/tools2.png b/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/images/tools2.png deleted file mode 100644 index 1a8e0bbfa16..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/vmware_tools_install/images/tools2.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/vscope-api/guide.de-de.md b/pages/bare_metal_cloud/managed_bare_metal/vscope-api/guide.de-de.md deleted file mode 100644 index f29014d296d..00000000000 --- a/pages/bare_metal_cloud/managed_bare_metal/vscope-api/guide.de-de.md +++ /dev/null @@ -1,267 +0,0 @@ ---- -title: vScope API verwenden -excerpt: Die vScope API ermöglicht Ihnen, die Monitoringdaten in Ihren Anwendungen zu verwenden -updated: 2020-11-18 ---- - -## Ziel - -OVHcloud stellt Ihnen mit **vScope** ein Überwachungstool für Ihre virtuellen Maschinen und Ihre Infrastruktur zur Verfügung. - -Es handelt sich um eine Website, auf der alle nützlichen Informationen zur Verwendung Ihrer Ressourcen gesammelt sind. - -Diese Informationen sind auch über APIv6 und API Metrics verfügbar. - -**Diese Anleitung beschreibt die Verwendung dieser APIs.** - -## Voraussetzungen - -- Sie verfügen über eine [Managed Bare Metal](https://www.ovhcloud.com/de/managed-bare-metal/) Infrastruktur. -- Sie sind im Verwaltungsinterface von vScope eingeloggt. - -## In der praktischen Anwendung - -Das Tool vScope stellt zwei Arten von Informationen zur Verfügung: - -- Live-Informationen, die den Daten der verschiedenen Komponenten zu einem Zeitpunkt “T” entsprechen. -- Grafiken, die die früheren Leistungsdaten der verschiedenen Komponenten veranschaulichen. Zum Beispiel: CPU und RAM einer virtuellen Maschine. - -### Die Live-Daten sammeln - -Die Live-Daten sind die von der Hauptseite der Benutzeroberfläche vScope aus verfügbaren Daten. - -![vScope-API](images/vScope1.png){.thumbnail} - -Sie können die Live-Daten für die folgenden Komponenten abrufen: - -- Filer -- Hosts -- Virtuelle Maschinen - -Die Verwendung geschieht über drei API-Aufrufe: - -#### Filer - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/filer/{filerId} -> - -#### Hosts - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host/{hostId} -> - -#### VMs - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/vm/{vmId} -> - -### Die historischen Daten sammeln (Grafiken) - -Um die historischen Daten (Grafiken) zu sammeln und zu verwenden, nutzen wir dem Dienst **Metrics Data Platforms**. - -Über das Protokoll Opentsdb oder WARP10 können Sie Ihre Daten in Form von Punkten abrufen. Sie können diese Punkte nach Belieben mit Ihrer Anwendung auswerten oder sie direkt anzeigen. - -Der folgende Abschnitt erklärt die Verwendung des Protokolls OpenTSDB für die unbearbeitete Anzeige von Daten (keine grafische Wiedergabe). - -Um die **Metrics Data Platforms** verwenden zu können, müssen Sie ein Lesetoken (*read*) erhalten. Mit der neuen Version von vScope besitzt jeder Nutzer der Infrastruktur ein Lesetoken. - -Für den jeweiligen Nutzer verwenden Sie den folgenden APIv6-Aufruf für das Lesetoken: - -> [!api] -> -> @api {v1} /dedicatedCloud POST /dedicatedCloud/{serviceName}/user/{userId}/metricsToken -> - -Ihr Token befindet sich im Feld **token** des Ergebnisses. - -```json -{ - "warpEndpoint": "https://warp10.gra1-ovh.metrics.ovh.net", - token: "XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX", - "opentsdbEndpoint": "https://opentsdb.gra1-ovh.metrics.ovh.net" -} -``` - -Für jede Art von Komponenten steht eine metrische Liste zur Verfügung und erfordert eine Anzahl von sehr präzisen Parametern (auch Label genannt). - -#### Filer - -| Messwerte | Beschreibung | Label | -| ----------- | ----------- | ----------- | -| vscope.filer.datastore.diskspace.used | Verwendung des Filers in kB | Rechenzentrum: pcc-37-187-228-180_datacenter869,
datastore : pcc-000443 | - -#### Hosts - -| Messwerte | Beschreibung | Label | -| ----------- | ----------- | ----------- | -| vscope.host.cpu.usage.perc | Verwendung des Prozessors des Hosts in Prozent | \- Rechenzentrum: pcc-37-187-228-180_datacenter869,
Host 172.17.86.51 | -| vscope.host.mem.usage.perc | Verwendung des Speichers des Hosts in Prozent | \- Rechenzentrum: pcc-37-187-228-180_datacenter869,
Host 172.17.86.51 | -| vscope.host.net.tx | Verwendung des Host-Netzwerks beim Senden | \- Rechenzentrum: pcc-37-187-228-180_datacenter869,
Host 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.rx | Verwendung des Host-Netzwerks beim Empfang | \- Rechenzentrum: pcc-37-187-228-180_datacenter869,
Host 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetstx | Anzahl der vom Host gesendeten Netzwerk-Pakete | \- Rechenzentrum: pcc-37-187-228-180_datacenter869,
Host 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetsrx | Anzahl der vom Host empfangenen Netzwerk-Pakete | \- Rechenzentrum: pcc-37-187-228-180_datacenter869,
Host 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | - -#### virtuelle Maschinen - -| Messwerte | Beschreibung | Label | -| ----------- | ----------- | ----------- | -| vscope.vm.cpu.usage.perc | Verwendung des Prozessors der VM in Prozent | \- Rechenzentrum: pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.mem.usage.perc | Verwendung des Speichers der VM in Prozent | \- Rechenzentrum: pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.cpu.ready |CPU ready der VM in Millisekunden | \- Rechenzentrum: pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.rx | Verwendung des Netzwerks der VM beim Empfang | \- Rechenzentrum: pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.tx | Verwendung des Netzwerks der VM bei der Übertragung | \- Rechenzentrum: pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.packetsrx | Anzahl der von der VM empfangenen Netzwerk-Pakete | \- Rechenzentrum: pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.packetstx | Anzahl der von der VM gesendeten Netzwerk-Pakete | \- Rechenzentrum: pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.io.read | Anzahl der IOs der VM im Lesevorgang pro Sekunde | \- Rechenzentrum: pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.io.write | Anzahl der IOs der VM im Schreibvorgang pro Sekunde | \- Rechenzentrum: pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.bandwidth.read | Bandbreite der Festplatte der VM beim Lesevorgang | \- Rechenzentrum: pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.bandwidth.write | Bandbreite der Festplatte der VM beim Schreibvorgang | \- Rechenzentrum: pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.latency.read | Latenz der Festplatte der VM beim Lesevorgang | \- Rechenzentrum: pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.latency.write | Latenz der Festplatte der VM beim Schreibvorgang | \- Rechenzentrum: pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | - -#### Beispiel einer Datensammlung unter Verwendung des OpenTSDB-Protokolls - -Jetzt, da Sie Ihr Token, Ihren Endpunkt und Ihre metrische Liste abgerufen haben, erhalten Sie die Daten zur Speichernutzung über den Zeitraum eines Tages. - -Hier ein Beispiel für eine Abfrage. - -``` -curl -XPOST https://read:XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX@opentsdb.gra1-ovh.metrics.ovh.net/api/query -D - "start":1564407950, - "queries":[ - { - "metric":"vscope.host.mem.usage.perc", - "aggregator":"sum", - "downsample":"20m-max-zero", - "tags": { - "datacenter":"pcc-37-187-228-180_datacenter869", - "host":"172.17.86.51" - } - } - ] -} -``` - -Erläuterung der verschiedenen verwendeten Felder: - -- **read**: der für die Durchführung des Antrags verwendete Nutzer (dies wird immer *read* sein); -- **XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX**: das vorher über APIv6 abgerufene Token; -- **opentsdb.gra1-ovh.metrics.ovh.net**: Endpunkt OpenTSDB, ebenfalls über APIv6 abgerufen. Dieser Endpunkt kann je nach Ihrem Standort variieren; -- **start**: der dem Datum des Beginns der Abfrage entsprechende Zeitstempel; -- **queries**: Tabelle mit den abzufragenden Metriken. Mehrere metrische Werte können in einer einzigen Abfrage abgerufen werden; -- **metric**: Name der abzufragenden Metrik; -- **aggregator**: Name der Aggregationsfunktion (weitere Details entnehmen Sie bitte der Dokumentation zu OpenTSDB); -- **downsample**: Name der Stichprobenfunktion (optional, ermöglicht es, die Zahl der abzurufenden Daten zu reduzieren); -- **tags**: Liste von Labels in der Form Schlüssel/Wert; - -Andere Parameter können auch geliefert werden. Bitte lesen Sie für mehr Details in der Dokumentation der OpenTSDB API nach. - -Sie werden dann ein *json* mit der Zusammenfassung der Abfrage erhalten, sowie die mit dem Wert im Feld **dps** verbundenen Zeitstempel. - -Beispiel: - -```json -[ - { - "metric":"vscope.host.mem.usage.perc", - "tags":{ - "datacenter":"pcc-37-187-228-180_datacenter869", - "env":"prod", - "host":"172.17.86.51" - "servicename":"pcc-37-187-228-180", - "servicetype":"vscope" - }, - "query":{ - "index":0 - }, - "aggregateTags":[], - "dps":{ - "1564409391":4.38, - "1564410591":4.35, - "1564411791":4.37, - "1564412991":4.38, - "1564414191":4.35, - "1564415391":4.38, - "1564416591":4.35, - "1564417791":4.36, - "1564418991":4.36, - "1564420191":4.37, - "1564421391":4.37, - "1564422591":4.37, - "1564423791":4.37, - "1564424991":4.38, - "1564426191":4.36, - "1564427391":4.35, - "1564428591":4.37, - "1564429791":4.36, - "1564430991":4.38, - "1564432191":4.35, - "1564433391":4.37, - "1564434591":4.36, - "1564435791":4.37, - "1564436991":4.37, - "1564438191":4.37, - "1564439391":4.38, - "1564440591":4.36, - "1564441791":4.36, - "1564442991":4.37, - "1564444191":4.37, - "1564445391":4.35, - "1564446591":4.36, - "1564447791":4.36, - "1564448991":4.36, - "1564450191":4.35, - "1564451391":4.37, - "1564452591":4.37, - "1564453791":4.35, - "1564454991":4.36, - "1564456191":4.37, - "1564457391":4.37, - "1564458591":4.36, - "1564459791":4.37, - "1564460991":4.34, - "1564462191":4.36, - "1564463391":4.34, - "1564464591":4.37, - "1564465791":4.34, - "1564466991":4.37, - "1564468191":4.34, - "1564469391":4.36, - "1564470591":4.36, - "1564471791":4.36, - "1564472991":4.37, - "1564474191":4.37, - "1564475391":4.36, - "1564476591":4.35, - "1564477791":4.36, - "1564478991":4.35, - "1564480191":4.35, - "1564481391":4.37, - "1564482591":4.36, - "1564483791":4.34, - "1564484991":4.37, - "1564486191":4.38, - "1564487391":4.35, - "1564488591":4.34, - "1564489791":4.36, - "1564490991":4.35, - "1564492191":4.36, - "1564493391":4.36, - "1564494591":4.36 - } - } -] -``` - -Für mehr Details zu API Calls mit OpenTSDB können Sie in der folgenden Dokumentation nachlesen: [OpenTSDB API query](http://opentsdb.net/docs/build/html/api_http/query/index.html) - -## Weiterführende Informationen - -Für den Austausch mit unserer User Community gehen Sie auf . diff --git a/pages/bare_metal_cloud/managed_bare_metal/vscope-api/guide.en-asia.md b/pages/bare_metal_cloud/managed_bare_metal/vscope-api/guide.en-asia.md deleted file mode 100644 index 92bc62fdbff..00000000000 --- a/pages/bare_metal_cloud/managed_bare_metal/vscope-api/guide.en-asia.md +++ /dev/null @@ -1,266 +0,0 @@ ---- -title: 'Using the vScope API' -excerpt: 'Find out how to use the vScope API to collect monitoring data in your applications' -updated: 2020-11-18 ---- - -## Objective - -OVHcloud provides you with a tool called **vScope**, for supervising and monitoring your virtual machines and infrastructures. - -It is a webpage that displays useful information on your resource usage. - -You can also access this information via the APIv6 and Metrics API. - -**This guide explains how to use these APIs.** - -## Requirements - -- a [Managed Bare Metal infrastructure](https://www.ovhcloud.com/asia/managed-bare-metal/) -- access to the management interface (vScope) - -## Instructions - -vScope provides two types of information: - -- **Live** information which corresponds to the information on different components at a given time. -- Graphs presenting logged performance data for different components, such as a virtual machine’s CPU and RAM. - -### Collecting **live** data - -**Live** data is the data available via the vScope interface’s main page. - -![vScope-API](images/vScope1.png){.thumbnail} - -You can retrieve **live** data for the following components: - -- filers -- hosts -- virtual machines - -You can use the API via the following three APIv6 calls: - -#### Filers - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/filer/{filerId} -> - -#### Hosts - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host/{hostId} -> - -#### Virtual machines - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/vm/{vmId} -> - -### Collecting logged data (graphs) - -To collect and use logged data (graphs), we use the **Metrics Data Platforms** product. - -Via OpenTSDB or WARP10 protocol, you will be able to retrieve your data as points. You can use these points via your application, or directly display them in your choice of rendering. - -The following instructions cover the use of the OpenTSDB protocol for a raw data display (no graph rendering). - -To use **Metrics Data Platforms**, you will need to get a *read* token. With the new version of vScope, each infrastructure user has a *read* token. - -Use the following APIv6 call to retrieve the read token for the user you want: - -> [!api] -> -> @api {v1} /dedicatedCloud POST /dedicatedCloud/{serviceName}/user/{userId}/metricsToken -> - -Your token will be in the result’s **token** field. - -```json -{ - "warpEndpoint": "https://warp10.gra1-ovh.metrics.ovh.net", - "token": "XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX", - "opentsdbEndpoint": "https://opentsdb.gra1-ovh.metrics.ovh.net" -} -``` - -For each component type, there is a list of metrics, and it requires a number of very precise settings (also called labels). - -#### Filers - -| Metrics | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.filer.datastore.diskspace.used | Filer usage in KB | datacenter : pcc-37-187-228-180_datacenter869,
datastore : pcc-000443 | - -#### Hosts - -| Metrics | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.host.cpu.usage.perc | Host processor usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51 | -| vscope.host.mem.usage.perc | Host RAM usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51 | -| vscope.host.net.tx | Host outgoing network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.rx | Host incoming network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetstx | Number of network packets sent from the host | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetsrx | Number of network packets received from the host | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | - -#### Virtual machines - -| Metrics | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.vm.cpu.usage.perc | VM processor usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.mem.usage.perc | VM RAM usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.cpu.ready |VM’s CPU Ready time in milliseconds | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.rx | VM incoming network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.tx | VM outgoing network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.packetsrx | Number of network packets received from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.packetstx | Number of network packets sent from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.io.read | IO number per second in read mode from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.io.write | IO number per second in write mode from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.bandwidth.read | VM disk bandwidth in read mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.bandwidth.write | VM disk bandwidth in write mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.latency.read | VM disk latency in read mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.latency.write | VM disk latency in write mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | - -#### Example of data gathered using the OpenTSDB protocol - -Now that you have retrieved your token, your endpoint, and your list of metrics, you can retrieve a host’s RAM usage data for a period of 1 day. - -Below is an example query: - -``` -curl -XPOST https://read:XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX@opentsdb.gra1-ovh.metrics.ovh.net/api/query --d '{ - "start":1564407950, - "queries":[ - { - "metric":"vscope.host.mem.usage.perc", - "aggregator":"sum", - "downsample":"20m-max-zero", - "tags": { - "datacenter":"pcc-37-187-228-180_datacenter869", - "host":"172.17.86.51" - } - } - ] -}' -``` - -Below are explanations of the fields used: - -- **read:** user used to send the query (will always be read). -- XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX: the token retrieved earlier via the APIv6. -- **opentsdb.gra1-ovh.metrics.ovh.net:** OpenTSDB endpoint, also retrieved via the APIv6. This endpoint may vary depending on your location. -- **start:** a timestamp corresponding to the query’s start date. -- **queries:** a table containing the metrics to retrieve. Several metrics may be retrieved in a single query. -- **metric:** the name of the metric to retrieve. -- **aggregator:** the name of the aggregation feature (please refer to OpenTSDB documentation for further details). -- **downsample:** the name of the downsampling feature (can be used to reduce the amount of data to retrieve. Optional setting). -- **tags:** a list of labels in the form of key/value. - -Other settings may also be provided. Please refer to the documentation for the OpenTSDB API for further details. - -You will then receive a *json* with the query summary, as well as the timestamps associated with their value in the **dps** field. -For example: - -```json -[ - { - "metric":"vscope.host.mem.usage.perc", - "tags":{ - "datacenter":"pcc-37-187-228-180_datacenter869", - "env":"prod", - "host":"172.17.86.51", - "servicename":"pcc-37-187-228-180", - "servicetype":"vscope" - }, - "query":{ - "index":0 - }, - "aggregateTags":[], - "dps":{ - "1564409391":4.38, - "1564410591":4.35, - "1564411791":4.37, - "1564412991":4.38, - "1564414191":4.35, - "1564415391":4.38, - "1564416591":4.35, - "1564417791":4.36, - "1564418991":4.36, - "1564420191":4.37, - "1564421391":4.37, - "1564422591":4.37, - "1564423791":4.37, - "1564424991":4.38, - "1564426191":4.36, - "1564427391":4.35, - "1564428591":4.37, - "1564429791":4.36, - "1564430991":4.38, - "1564432191":4.35, - "1564433391":4.37, - "1564434591":4.36, - "1564435791":4.37, - "1564436991":4.37, - "1564438191":4.37, - "1564439391":4.38, - "1564440591":4.36, - "1564441791":4.36, - "1564442991":4.37, - "1564444191":4.37, - "1564445391":4.35, - "1564446591":4.36, - "1564447791":4.36, - "1564448991":4.36, - "1564450191":4.35, - "1564451391":4.37, - "1564452591":4.37, - "1564453791":4.35, - "1564454991":4.36, - "1564456191":4.37, - "1564457391":4.37, - "1564458591":4.36, - "1564459791":4.37, - "1564460991":4.34, - "1564462191":4.36, - "1564463391":4.34, - "1564464591":4.37, - "1564465791":4.34, - "1564466991":4.37, - "1564468191":4.34, - "1564469391":4.36, - "1564470591":4.36, - "1564471791":4.36, - "1564472991":4.37, - "1564474191":4.37, - "1564475391":4.36, - "1564476591":4.35, - "1564477791":4.36, - "1564478991":4.35, - "1564480191":4.35, - "1564481391":4.37, - "1564482591":4.36, - "1564483791":4.34, - "1564484991":4.37, - "1564486191":4.38, - "1564487391":4.35, - "1564488591":4.34, - "1564489791":4.36, - "1564490991":4.35, - "1564492191":4.36, - "1564493391":4.36, - "1564494591":4.36 - } - } -] -``` - -For further details on OpenTSDB queries, please refer to the following documentation: [OpenTSDB API query](http://opentsdb.net/docs/build/html/api_http/query/index.html) - -## Go further - -Join our community of users on . diff --git a/pages/bare_metal_cloud/managed_bare_metal/vscope-api/guide.en-au.md b/pages/bare_metal_cloud/managed_bare_metal/vscope-api/guide.en-au.md deleted file mode 100644 index 772fadd0019..00000000000 --- a/pages/bare_metal_cloud/managed_bare_metal/vscope-api/guide.en-au.md +++ /dev/null @@ -1,266 +0,0 @@ ---- -title: 'Using the vScope API' -excerpt: 'Find out how to use the vScope API to collect monitoring data in your applications' -updated: 2020-11-18 ---- - -## Objective - -OVHcloud provides you with a tool called **vScope**, for supervising and monitoring your virtual machines and infrastructures. - -It is a webpage that displays useful information on your resource usage. - -You can also access this information via the APIv6 and Metrics API. - -**This guide explains how to use these APIs.** - -## Requirements - -- a [Managed Bare Metal infrastructure](https://www.ovhcloud.com/en-au/managed-bare-metal/) -- access to the management interface (vScope) - -## Instructions - -vScope provides two types of information: - -- **Live** information which corresponds to the information on different components at a given time. -- Graphs presenting logged performance data for different components, such as a virtual machine’s CPU and RAM. - -### Collecting **live** data - -**Live** data is the data available via the vScope interface’s main page. - -![vScope-API](images/vScope1.png){.thumbnail} - -You can retrieve **live** data for the following components: - -- filers -- hosts -- virtual machines - -You can use the API via the following three APIv6 calls: - -#### Filers - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/filer/{filerId} -> - -#### Hosts - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host/{hostId} -> - -#### Virtual machines - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/vm/{vmId} -> - -### Collecting logged data (graphs) - -To collect and use logged data (graphs), we use the **Metrics Data Platforms** product. - -Via OpenTSDB or WARP10 protocol, you will be able to retrieve your data as points. You can use these points via your application, or directly display them in your choice of rendering. - -The following instructions cover the use of the OpenTSDB protocol for a raw data display (no graph rendering). - -To use **Metrics Data Platforms**, you will need to get a *read* token. With the new version of vScope, each infrastructure user has a *read* token. - -Use the following APIv6 call to retrieve the read token for the user you want: - -> [!api] -> -> @api {v1} /dedicatedCloud POST /dedicatedCloud/{serviceName}/user/{userId}/metricsToken -> - -Your token will be in the result’s **token** field. - -```json -{ - "warpEndpoint": "https://warp10.gra1-ovh.metrics.ovh.net", - "token": "XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX", - "opentsdbEndpoint": "https://opentsdb.gra1-ovh.metrics.ovh.net" -} -``` - -For each component type, there is a list of metrics, and it requires a number of very precise settings (also called labels). - -#### Filers - -| Metrics | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.filer.datastore.diskspace.used | Filer usage in KB | datacenter : pcc-37-187-228-180_datacenter869,
datastore : pcc-000443 | - -#### Hosts - -| Metrics | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.host.cpu.usage.perc | Host processor usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51 | -| vscope.host.mem.usage.perc | Host RAM usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51 | -| vscope.host.net.tx | Host outgoing network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.rx | Host incoming network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetstx | Number of network packets sent from the host | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetsrx | Number of network packets received from the host | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | - -#### Virtual machines - -| Metrics | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.vm.cpu.usage.perc | VM processor usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.mem.usage.perc | VM RAM usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.cpu.ready |VM’s CPU Ready time in milliseconds | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.rx | VM incoming network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.tx | VM outgoing network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.packetsrx | Number of network packets received from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.packetstx | Number of network packets sent from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.io.read | IO number per second in read mode from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.io.write | IO number per second in write mode from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.bandwidth.read | VM disk bandwidth in read mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.bandwidth.write | VM disk bandwidth in write mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.latency.read | VM disk latency in read mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.latency.write | VM disk latency in write mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | - -#### Example of data gathered using the OpenTSDB protocol - -Now that you have retrieved your token, your endpoint, and your list of metrics, you can retrieve a host’s RAM usage data for a period of 1 day. - -Below is an example query: - -``` -curl -XPOST https://read:XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX@opentsdb.gra1-ovh.metrics.ovh.net/api/query --d '{ - "start":1564407950, - "queries":[ - { - "metric":"vscope.host.mem.usage.perc", - "aggregator":"sum", - "downsample":"20m-max-zero", - "tags": { - "datacenter":"pcc-37-187-228-180_datacenter869", - "host":"172.17.86.51" - } - } - ] -}' -``` - -Below are explanations of the fields used: - -- **read:** user used to send the query (will always be read). -- XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX: the token retrieved earlier via the APIv6. -- **opentsdb.gra1-ovh.metrics.ovh.net:** OpenTSDB endpoint, also retrieved via the APIv6. This endpoint may vary depending on your location. -- **start:** a timestamp corresponding to the query’s start date. -- **queries:** a table containing the metrics to retrieve. Several metrics may be retrieved in a single query. -- **metric:** the name of the metric to retrieve. -- **aggregator:** the name of the aggregation feature (please refer to OpenTSDB documentation for further details). -- **downsample:** the name of the downsampling feature (can be used to reduce the amount of data to retrieve. Optional setting). -- **tags:** a list of labels in the form of key/value. - -Other settings may also be provided. Please refer to the documentation for the OpenTSDB API for further details. - -You will then receive a *json* with the query summary, as well as the timestamps associated with their value in the **dps** field. -For example: - -```json -[ - { - "metric":"vscope.host.mem.usage.perc", - "tags":{ - "datacenter":"pcc-37-187-228-180_datacenter869", - "env":"prod", - "host":"172.17.86.51", - "servicename":"pcc-37-187-228-180", - "servicetype":"vscope" - }, - "query":{ - "index":0 - }, - "aggregateTags":[], - "dps":{ - "1564409391":4.38, - "1564410591":4.35, - "1564411791":4.37, - "1564412991":4.38, - "1564414191":4.35, - "1564415391":4.38, - "1564416591":4.35, - "1564417791":4.36, - "1564418991":4.36, - "1564420191":4.37, - "1564421391":4.37, - "1564422591":4.37, - "1564423791":4.37, - "1564424991":4.38, - "1564426191":4.36, - "1564427391":4.35, - "1564428591":4.37, - "1564429791":4.36, - "1564430991":4.38, - "1564432191":4.35, - "1564433391":4.37, - "1564434591":4.36, - "1564435791":4.37, - "1564436991":4.37, - "1564438191":4.37, - "1564439391":4.38, - "1564440591":4.36, - "1564441791":4.36, - "1564442991":4.37, - "1564444191":4.37, - "1564445391":4.35, - "1564446591":4.36, - "1564447791":4.36, - "1564448991":4.36, - "1564450191":4.35, - "1564451391":4.37, - "1564452591":4.37, - "1564453791":4.35, - "1564454991":4.36, - "1564456191":4.37, - "1564457391":4.37, - "1564458591":4.36, - "1564459791":4.37, - "1564460991":4.34, - "1564462191":4.36, - "1564463391":4.34, - "1564464591":4.37, - "1564465791":4.34, - "1564466991":4.37, - "1564468191":4.34, - "1564469391":4.36, - "1564470591":4.36, - "1564471791":4.36, - "1564472991":4.37, - "1564474191":4.37, - "1564475391":4.36, - "1564476591":4.35, - "1564477791":4.36, - "1564478991":4.35, - "1564480191":4.35, - "1564481391":4.37, - "1564482591":4.36, - "1564483791":4.34, - "1564484991":4.37, - "1564486191":4.38, - "1564487391":4.35, - "1564488591":4.34, - "1564489791":4.36, - "1564490991":4.35, - "1564492191":4.36, - "1564493391":4.36, - "1564494591":4.36 - } - } -] -``` - -For further details on OpenTSDB queries, please refer to the following documentation: [OpenTSDB API query](http://opentsdb.net/docs/build/html/api_http/query/index.html) - -## Go further - -Join our community of users on . diff --git a/pages/bare_metal_cloud/managed_bare_metal/vscope-api/guide.en-ca.md b/pages/bare_metal_cloud/managed_bare_metal/vscope-api/guide.en-ca.md deleted file mode 100644 index 11bd2209888..00000000000 --- a/pages/bare_metal_cloud/managed_bare_metal/vscope-api/guide.en-ca.md +++ /dev/null @@ -1,266 +0,0 @@ ---- -title: 'Using the vScope API' -excerpt: 'Find out how to use the vScope API to collect monitoring data in your applications' -updated: 2020-11-18 ---- - -## Objective - -OVHcloud provides you with a tool called **vScope**, for supervising and monitoring your virtual machines and infrastructures. - -It is a webpage that displays useful information on your resource usage. - -You can also access this information via the APIv6 and Metrics API. - -**This guide explains how to use these APIs.** - -## Requirements - -- a [Managed Bare Metal infrastructure](https://www.ovhcloud.com/en-ca/managed-bare-metal/) -- access to the management interface (vScope) - -## Instructions - -vScope provides two types of information: - -- **Live** information which corresponds to the information on different components at a given time. -- Graphs presenting logged performance data for different components, such as a virtual machine’s CPU and RAM. - -### Collecting **live** data - -**Live** data is the data available via the vScope interface’s main page. - -![vScope-API](images/vScope1.png){.thumbnail} - -You can retrieve **live** data for the following components: - -- filers -- hosts -- virtual machines - -You can use the API via the following three APIv6 calls: - -#### Filers - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/filer/{filerId} -> - -#### Hosts - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host/{hostId} -> - -#### Virtual machines - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/vm/{vmId} -> - -### Collecting logged data (graphs) - -To collect and use logged data (graphs), we use the **Metrics Data Platforms** product. - -Via OpenTSDB or WARP10 protocol, you will be able to retrieve your data as points. You can use these points via your application, or directly display them in your choice of rendering. - -The following instructions cover the use of the OpenTSDB protocol for a raw data display (no graph rendering). - -To use **Metrics Data Platforms**, you will need to get a *read* token. With the new version of vScope, each infrastructure user has a *read* token. - -Use the following APIv6 call to retrieve the read token for the user you want: - -> [!api] -> -> @api {v1} /dedicatedCloud POST /dedicatedCloud/{serviceName}/user/{userId}/metricsToken -> - -Your token will be in the result’s **token** field. - -```json -{ - "warpEndpoint": "https://warp10.gra1-ovh.metrics.ovh.net", - "token": "XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX", - "opentsdbEndpoint": "https://opentsdb.gra1-ovh.metrics.ovh.net" -} -``` - -For each component type, there is a list of metrics, and it requires a number of very precise settings (also called labels). - -#### Filers - -| Metrics | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.filer.datastore.diskspace.used | Filer usage in KB | datacenter : pcc-37-187-228-180_datacenter869,
datastore : pcc-000443 | - -#### Hosts - -| Metrics | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.host.cpu.usage.perc | Host processor usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51 | -| vscope.host.mem.usage.perc | Host RAM usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51 | -| vscope.host.net.tx | Host outgoing network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.rx | Host incoming network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetstx | Number of network packets sent from the host | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetsrx | Number of network packets received from the host | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | - -#### Virtual machines - -| Metrics | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.vm.cpu.usage.perc | VM processor usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.mem.usage.perc | VM RAM usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.cpu.ready |VM’s CPU Ready time in milliseconds | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.rx | VM incoming network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.tx | VM outgoing network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.packetsrx | Number of network packets received from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.packetstx | Number of network packets sent from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.io.read | IO number per second in read mode from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.io.write | IO number per second in write mode from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.bandwidth.read | VM disk bandwidth in read mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.bandwidth.write | VM disk bandwidth in write mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.latency.read | VM disk latency in read mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.latency.write | VM disk latency in write mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | - -#### Example of data gathered using the OpenTSDB protocol - -Now that you have retrieved your token, your endpoint, and your list of metrics, you can retrieve a host’s RAM usage data for a period of 1 day. - -Below is an example query: - -``` -curl -XPOST https://read:XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX@opentsdb.gra1-ovh.metrics.ovh.net/api/query --d '{ - "start":1564407950, - "queries":[ - { - "metric":"vscope.host.mem.usage.perc", - "aggregator":"sum", - "downsample":"20m-max-zero", - "tags": { - "datacenter":"pcc-37-187-228-180_datacenter869", - "host":"172.17.86.51" - } - } - ] -}' -``` - -Below are explanations of the fields used: - -- **read:** user used to send the query (will always be read). -- XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX: the token retrieved earlier via the APIv6. -- **opentsdb.gra1-ovh.metrics.ovh.net:** OpenTSDB endpoint, also retrieved via the APIv6. This endpoint may vary depending on your location. -- **start:** a timestamp corresponding to the query’s start date. -- **queries:** a table containing the metrics to retrieve. Several metrics may be retrieved in a single query. -- **metric:** the name of the metric to retrieve. -- **aggregator:** the name of the aggregation feature (please refer to OpenTSDB documentation for further details). -- **downsample:** the name of the downsampling feature (can be used to reduce the amount of data to retrieve. Optional setting). -- **tags:** a list of labels in the form of key/value. - -Other settings may also be provided. Please refer to the documentation for the OpenTSDB API for further details. - -You will then receive a *json* with the query summary, as well as the timestamps associated with their value in the **dps** field. -For example: - -```json -[ - { - "metric":"vscope.host.mem.usage.perc", - "tags":{ - "datacenter":"pcc-37-187-228-180_datacenter869", - "env":"prod", - "host":"172.17.86.51", - "servicename":"pcc-37-187-228-180", - "servicetype":"vscope" - }, - "query":{ - "index":0 - }, - "aggregateTags":[], - "dps":{ - "1564409391":4.38, - "1564410591":4.35, - "1564411791":4.37, - "1564412991":4.38, - "1564414191":4.35, - "1564415391":4.38, - "1564416591":4.35, - "1564417791":4.36, - "1564418991":4.36, - "1564420191":4.37, - "1564421391":4.37, - "1564422591":4.37, - "1564423791":4.37, - "1564424991":4.38, - "1564426191":4.36, - "1564427391":4.35, - "1564428591":4.37, - "1564429791":4.36, - "1564430991":4.38, - "1564432191":4.35, - "1564433391":4.37, - "1564434591":4.36, - "1564435791":4.37, - "1564436991":4.37, - "1564438191":4.37, - "1564439391":4.38, - "1564440591":4.36, - "1564441791":4.36, - "1564442991":4.37, - "1564444191":4.37, - "1564445391":4.35, - "1564446591":4.36, - "1564447791":4.36, - "1564448991":4.36, - "1564450191":4.35, - "1564451391":4.37, - "1564452591":4.37, - "1564453791":4.35, - "1564454991":4.36, - "1564456191":4.37, - "1564457391":4.37, - "1564458591":4.36, - "1564459791":4.37, - "1564460991":4.34, - "1564462191":4.36, - "1564463391":4.34, - "1564464591":4.37, - "1564465791":4.34, - "1564466991":4.37, - "1564468191":4.34, - "1564469391":4.36, - "1564470591":4.36, - "1564471791":4.36, - "1564472991":4.37, - "1564474191":4.37, - "1564475391":4.36, - "1564476591":4.35, - "1564477791":4.36, - "1564478991":4.35, - "1564480191":4.35, - "1564481391":4.37, - "1564482591":4.36, - "1564483791":4.34, - "1564484991":4.37, - "1564486191":4.38, - "1564487391":4.35, - "1564488591":4.34, - "1564489791":4.36, - "1564490991":4.35, - "1564492191":4.36, - "1564493391":4.36, - "1564494591":4.36 - } - } -] -``` - -For further details on OpenTSDB queries, please refer to the following documentation: [OpenTSDB API query](http://opentsdb.net/docs/build/html/api_http/query/index.html) - -## Go further - -Join our community of users on . diff --git a/pages/bare_metal_cloud/managed_bare_metal/vscope-api/guide.en-gb.md b/pages/bare_metal_cloud/managed_bare_metal/vscope-api/guide.en-gb.md deleted file mode 100644 index 9e314d5b70c..00000000000 --- a/pages/bare_metal_cloud/managed_bare_metal/vscope-api/guide.en-gb.md +++ /dev/null @@ -1,266 +0,0 @@ ---- -title: 'Using the vScope API' -excerpt: 'Find out how to use the vScope API to collect monitoring data in your applications' -updated: 2020-11-18 ---- - -## Objective - -OVHcloud provides you with a tool called **vScope**, for supervising and monitoring your virtual machines and infrastructures. - -It is a webpage that displays useful information on your resource usage. - -You can also access this information via the APIv6 and Metrics API. - -**This guide explains how to use these APIs.** - -## Requirements - -- a [Managed Bare Metal infrastructure](https://www.ovhcloud.com/en-gb/managed-bare-metal/) -- access to the management interface (vScope) - -## Instructions - -vScope provides two types of information: - -- **Live** information which corresponds to the information on different components at a given time. -- Graphs presenting logged performance data for different components, such as a virtual machine’s CPU and RAM. - -### Collecting **live** data - -**Live** data is the data available via the vScope interface’s main page. - -![vScope-API](images/vScope1.png){.thumbnail} - -You can retrieve **live** data for the following components: - -- filers -- hosts -- virtual machines - -You can use the API via the following three APIv6 calls: - -#### Filers - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/filer/{filerId} -> - -#### Hosts - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host/{hostId} -> - -#### Virtual machines - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/vm/{vmId} -> - -### Collecting logged data (graphs) - -To collect and use logged data (graphs), we use the **Metrics Data Platforms** product. - -Via OpenTSDB or WARP10 protocol, you will be able to retrieve your data as points. You can use these points via your application, or directly display them in your choice of rendering. - -The following instructions cover the use of the OpenTSDB protocol for a raw data display (no graph rendering). - -To use **Metrics Data Platforms**, you will need to get a *read* token. With the new version of vScope, each infrastructure user has a *read* token. - -Use the following APIv6 call to retrieve the read token for the user you want: - -> [!api] -> -> @api {v1} /dedicatedCloud POST /dedicatedCloud/{serviceName}/user/{userId}/metricsToken -> - -Your token will be in the result’s **token** field. - -```json -{ - "warpEndpoint": "https://warp10.gra1-ovh.metrics.ovh.net", - "token": "XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX", - "opentsdbEndpoint": "https://opentsdb.gra1-ovh.metrics.ovh.net" -} -``` - -For each component type, there is a list of metrics, and it requires a number of very precise settings (also called labels). - -#### Filers - -| Metrics | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.filer.datastore.diskspace.used | Filer usage in KB | datacenter : pcc-37-187-228-180_datacenter869,
datastore : pcc-000443 | - -#### Hosts - -| Metrics | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.host.cpu.usage.perc | Host processor usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51 | -| vscope.host.mem.usage.perc | Host RAM usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51 | -| vscope.host.net.tx | Host outgoing network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.rx | Host incoming network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetstx | Number of network packets sent from the host | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetsrx | Number of network packets received from the host | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | - -#### Virtual machines - -| Metrics | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.vm.cpu.usage.perc | VM processor usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.mem.usage.perc | VM RAM usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.cpu.ready |VM’s CPU Ready time in milliseconds | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.rx | VM incoming network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.tx | VM outgoing network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.packetsrx | Number of network packets received from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.packetstx | Number of network packets sent from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.io.read | IO number per second in read mode from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.io.write | IO number per second in write mode from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.bandwidth.read | VM disk bandwidth in read mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.bandwidth.write | VM disk bandwidth in write mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.latency.read | VM disk latency in read mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.latency.write | VM disk latency in write mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | - -#### Example of data gathered using the OpenTSDB protocol - -Now that you have retrieved your token, your endpoint, and your list of metrics, you can retrieve a host’s RAM usage data for a period of 1 day. - -Below is an example query: - -``` -curl -XPOST https://read:XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX@opentsdb.gra1-ovh.metrics.ovh.net/api/query --d '{ - "start":1564407950, - "queries":[ - { - "metric":"vscope.host.mem.usage.perc", - "aggregator":"sum", - "downsample":"20m-max-zero", - "tags": { - "datacenter":"pcc-37-187-228-180_datacenter869", - "host":"172.17.86.51" - } - } - ] -}' -``` - -Below are explanations of the fields used: - -- **read:** user used to send the query (will always be read). -- XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX: the token retrieved earlier via the APIv6. -- **opentsdb.gra1-ovh.metrics.ovh.net:** OpenTSDB endpoint, also retrieved via the APIv6. This endpoint may vary depending on your location. -- **start:** a timestamp corresponding to the query’s start date. -- **queries:** a table containing the metrics to retrieve. Several metrics may be retrieved in a single query. -- **metric:** the name of the metric to retrieve. -- **aggregator:** the name of the aggregation feature (please refer to OpenTSDB documentation for further details). -- **downsample:** the name of the downsampling feature (can be used to reduce the amount of data to retrieve. Optional setting). -- **tags:** a list of labels in the form of key/value. - -Other settings may also be provided. Please refer to the documentation for the OpenTSDB API for further details. - -You will then receive a *json* with the query summary, as well as the timestamps associated with their value in the **dps** field. -For example: - -```json -[ - { - "metric":"vscope.host.mem.usage.perc", - "tags":{ - "datacenter":"pcc-37-187-228-180_datacenter869", - "env":"prod", - "host":"172.17.86.51", - "servicename":"pcc-37-187-228-180", - "servicetype":"vscope" - }, - "query":{ - "index":0 - }, - "aggregateTags":[], - "dps":{ - "1564409391":4.38, - "1564410591":4.35, - "1564411791":4.37, - "1564412991":4.38, - "1564414191":4.35, - "1564415391":4.38, - "1564416591":4.35, - "1564417791":4.36, - "1564418991":4.36, - "1564420191":4.37, - "1564421391":4.37, - "1564422591":4.37, - "1564423791":4.37, - "1564424991":4.38, - "1564426191":4.36, - "1564427391":4.35, - "1564428591":4.37, - "1564429791":4.36, - "1564430991":4.38, - "1564432191":4.35, - "1564433391":4.37, - "1564434591":4.36, - "1564435791":4.37, - "1564436991":4.37, - "1564438191":4.37, - "1564439391":4.38, - "1564440591":4.36, - "1564441791":4.36, - "1564442991":4.37, - "1564444191":4.37, - "1564445391":4.35, - "1564446591":4.36, - "1564447791":4.36, - "1564448991":4.36, - "1564450191":4.35, - "1564451391":4.37, - "1564452591":4.37, - "1564453791":4.35, - "1564454991":4.36, - "1564456191":4.37, - "1564457391":4.37, - "1564458591":4.36, - "1564459791":4.37, - "1564460991":4.34, - "1564462191":4.36, - "1564463391":4.34, - "1564464591":4.37, - "1564465791":4.34, - "1564466991":4.37, - "1564468191":4.34, - "1564469391":4.36, - "1564470591":4.36, - "1564471791":4.36, - "1564472991":4.37, - "1564474191":4.37, - "1564475391":4.36, - "1564476591":4.35, - "1564477791":4.36, - "1564478991":4.35, - "1564480191":4.35, - "1564481391":4.37, - "1564482591":4.36, - "1564483791":4.34, - "1564484991":4.37, - "1564486191":4.38, - "1564487391":4.35, - "1564488591":4.34, - "1564489791":4.36, - "1564490991":4.35, - "1564492191":4.36, - "1564493391":4.36, - "1564494591":4.36 - } - } -] -``` - -For further details on OpenTSDB queries, please refer to the following documentation: [OpenTSDB API query](http://opentsdb.net/docs/build/html/api_http/query/index.html) - -## Go further - -Join our community of users on . diff --git a/pages/bare_metal_cloud/managed_bare_metal/vscope-api/guide.en-ie.md b/pages/bare_metal_cloud/managed_bare_metal/vscope-api/guide.en-ie.md deleted file mode 100644 index 2de051175fb..00000000000 --- a/pages/bare_metal_cloud/managed_bare_metal/vscope-api/guide.en-ie.md +++ /dev/null @@ -1,266 +0,0 @@ ---- -title: 'Using the vScope API' -excerpt: 'Find out how to use the vScope API to collect monitoring data in your applications' -updated: 2020-11-18 ---- - -## Objective - -OVHcloud provides you with a tool called **vScope**, for supervising and monitoring your virtual machines and infrastructures. - -It is a webpage that displays useful information on your resource usage. - -You can also access this information via the APIv6 and Metrics API. - -**This guide explains how to use these APIs.** - -## Requirements - -- a [Managed Bare Metal infrastructure](https://www.ovhcloud.com/en-ie/managed-bare-metal/) -- access to the management interface (vScope) - -## Instructions - -vScope provides two types of information: - -- **Live** information which corresponds to the information on different components at a given time. -- Graphs presenting logged performance data for different components, such as a virtual machine’s CPU and RAM. - -### Collecting **live** data - -**Live** data is the data available via the vScope interface’s main page. - -![vScope-API](images/vScope1.png){.thumbnail} - -You can retrieve **live** data for the following components: - -- filers -- hosts -- virtual machines - -You can use the API via the following three APIv6 calls: - -#### Filers - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/filer/{filerId} -> - -#### Hosts - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host/{hostId} -> - -#### Virtual machines - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/vm/{vmId} -> - -### Collecting logged data (graphs) - -To collect and use logged data (graphs), we use the **Metrics Data Platforms** product. - -Via OpenTSDB or WARP10 protocol, you will be able to retrieve your data as points. You can use these points via your application, or directly display them in your choice of rendering. - -The following instructions cover the use of the OpenTSDB protocol for a raw data display (no graph rendering). - -To use **Metrics Data Platforms**, you will need to get a *read* token. With the new version of vScope, each infrastructure user has a *read* token. - -Use the following APIv6 call to retrieve the read token for the user you want: - -> [!api] -> -> @api {v1} /dedicatedCloud POST /dedicatedCloud/{serviceName}/user/{userId}/metricsToken -> - -Your token will be in the result’s **token** field. - -```json -{ - "warpEndpoint": "https://warp10.gra1-ovh.metrics.ovh.net", - "token": "XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX", - "opentsdbEndpoint": "https://opentsdb.gra1-ovh.metrics.ovh.net" -} -``` - -For each component type, there is a list of metrics, and it requires a number of very precise settings (also called labels). - -#### Filers - -| Metrics | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.filer.datastore.diskspace.used | Filer usage in KB | datacenter : pcc-37-187-228-180_datacenter869,
datastore : pcc-000443 | - -#### Hosts - -| Metrics | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.host.cpu.usage.perc | Host processor usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51 | -| vscope.host.mem.usage.perc | Host RAM usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51 | -| vscope.host.net.tx | Host outgoing network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.rx | Host incoming network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetstx | Number of network packets sent from the host | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetsrx | Number of network packets received from the host | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | - -#### Virtual machines - -| Metrics | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.vm.cpu.usage.perc | VM processor usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.mem.usage.perc | VM RAM usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.cpu.ready |VM’s CPU Ready time in milliseconds | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.rx | VM incoming network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.tx | VM outgoing network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.packetsrx | Number of network packets received from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.packetstx | Number of network packets sent from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.io.read | IO number per second in read mode from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.io.write | IO number per second in write mode from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.bandwidth.read | VM disk bandwidth in read mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.bandwidth.write | VM disk bandwidth in write mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.latency.read | VM disk latency in read mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.latency.write | VM disk latency in write mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | - -#### Example of data gathered using the OpenTSDB protocol - -Now that you have retrieved your token, your endpoint, and your list of metrics, you can retrieve a host’s RAM usage data for a period of 1 day. - -Below is an example query: - -``` -curl -XPOST https://read:XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX@opentsdb.gra1-ovh.metrics.ovh.net/api/query --d '{ - "start":1564407950, - "queries":[ - { - "metric":"vscope.host.mem.usage.perc", - "aggregator":"sum", - "downsample":"20m-max-zero", - "tags": { - "datacenter":"pcc-37-187-228-180_datacenter869", - "host":"172.17.86.51" - } - } - ] -}' -``` - -Below are explanations of the fields used: - -- **read:** user used to send the query (will always be read). -- XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX: the token retrieved earlier via the APIv6. -- **opentsdb.gra1-ovh.metrics.ovh.net:** OpenTSDB endpoint, also retrieved via the APIv6. This endpoint may vary depending on your location. -- **start:** a timestamp corresponding to the query’s start date. -- **queries:** a table containing the metrics to retrieve. Several metrics may be retrieved in a single query. -- **metric:** the name of the metric to retrieve. -- **aggregator:** the name of the aggregation feature (please refer to OpenTSDB documentation for further details). -- **downsample:** the name of the downsampling feature (can be used to reduce the amount of data to retrieve. Optional setting). -- **tags:** a list of labels in the form of key/value. - -Other settings may also be provided. Please refer to the documentation for the OpenTSDB API for further details. - -You will then receive a *json* with the query summary, as well as the timestamps associated with their value in the **dps** field. -For example: - -```json -[ - { - "metric":"vscope.host.mem.usage.perc", - "tags":{ - "datacenter":"pcc-37-187-228-180_datacenter869", - "env":"prod", - "host":"172.17.86.51", - "servicename":"pcc-37-187-228-180", - "servicetype":"vscope" - }, - "query":{ - "index":0 - }, - "aggregateTags":[], - "dps":{ - "1564409391":4.38, - "1564410591":4.35, - "1564411791":4.37, - "1564412991":4.38, - "1564414191":4.35, - "1564415391":4.38, - "1564416591":4.35, - "1564417791":4.36, - "1564418991":4.36, - "1564420191":4.37, - "1564421391":4.37, - "1564422591":4.37, - "1564423791":4.37, - "1564424991":4.38, - "1564426191":4.36, - "1564427391":4.35, - "1564428591":4.37, - "1564429791":4.36, - "1564430991":4.38, - "1564432191":4.35, - "1564433391":4.37, - "1564434591":4.36, - "1564435791":4.37, - "1564436991":4.37, - "1564438191":4.37, - "1564439391":4.38, - "1564440591":4.36, - "1564441791":4.36, - "1564442991":4.37, - "1564444191":4.37, - "1564445391":4.35, - "1564446591":4.36, - "1564447791":4.36, - "1564448991":4.36, - "1564450191":4.35, - "1564451391":4.37, - "1564452591":4.37, - "1564453791":4.35, - "1564454991":4.36, - "1564456191":4.37, - "1564457391":4.37, - "1564458591":4.36, - "1564459791":4.37, - "1564460991":4.34, - "1564462191":4.36, - "1564463391":4.34, - "1564464591":4.37, - "1564465791":4.34, - "1564466991":4.37, - "1564468191":4.34, - "1564469391":4.36, - "1564470591":4.36, - "1564471791":4.36, - "1564472991":4.37, - "1564474191":4.37, - "1564475391":4.36, - "1564476591":4.35, - "1564477791":4.36, - "1564478991":4.35, - "1564480191":4.35, - "1564481391":4.37, - "1564482591":4.36, - "1564483791":4.34, - "1564484991":4.37, - "1564486191":4.38, - "1564487391":4.35, - "1564488591":4.34, - "1564489791":4.36, - "1564490991":4.35, - "1564492191":4.36, - "1564493391":4.36, - "1564494591":4.36 - } - } -] -``` - -For further details on OpenTSDB queries, please refer to the following documentation: [OpenTSDB API query](http://opentsdb.net/docs/build/html/api_http/query/index.html) - -## Go further - -Join our community of users on . diff --git a/pages/bare_metal_cloud/managed_bare_metal/vscope-api/guide.en-sg.md b/pages/bare_metal_cloud/managed_bare_metal/vscope-api/guide.en-sg.md deleted file mode 100644 index bdefae7e0f4..00000000000 --- a/pages/bare_metal_cloud/managed_bare_metal/vscope-api/guide.en-sg.md +++ /dev/null @@ -1,266 +0,0 @@ ---- -title: 'Using the vScope API' -excerpt: 'Find out how to use the vScope API to collect monitoring data in your applications' -updated: 2020-11-18 ---- - -## Objective - -OVHcloud provides you with a tool called **vScope**, for supervising and monitoring your virtual machines and infrastructures. - -It is a webpage that displays useful information on your resource usage. - -You can also access this information via the APIv6 and Metrics API. - -**This guide explains how to use these APIs.** - -## Requirements - -- a [Managed Bare Metal infrastructure](https://www.ovhcloud.com/en-sg/managed-bare-metal/) -- access to the management interface (vScope) - -## Instructions - -vScope provides two types of information: - -- **Live** information which corresponds to the information on different components at a given time. -- Graphs presenting logged performance data for different components, such as a virtual machine’s CPU and RAM. - -### Collecting **live** data - -**Live** data is the data available via the vScope interface’s main page. - -![vScope-API](images/vScope1.png){.thumbnail} - -You can retrieve **live** data for the following components: - -- filers -- hosts -- virtual machines - -You can use the API via the following three APIv6 calls: - -#### Filers - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/filer/{filerId} -> - -#### Hosts - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host/{hostId} -> - -#### Virtual machines - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/vm/{vmId} -> - -### Collecting logged data (graphs) - -To collect and use logged data (graphs), we use the **Metrics Data Platforms** product. - -Via OpenTSDB or WARP10 protocol, you will be able to retrieve your data as points. You can use these points via your application, or directly display them in your choice of rendering. - -The following instructions cover the use of the OpenTSDB protocol for a raw data display (no graph rendering). - -To use **Metrics Data Platforms**, you will need to get a *read* token. With the new version of vScope, each infrastructure user has a *read* token. - -Use the following APIv6 call to retrieve the read token for the user you want: - -> [!api] -> -> @api {v1} /dedicatedCloud POST /dedicatedCloud/{serviceName}/user/{userId}/metricsToken -> - -Your token will be in the result’s **token** field. - -```json -{ - "warpEndpoint": "https://warp10.gra1-ovh.metrics.ovh.net", - "token": "XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX", - "opentsdbEndpoint": "https://opentsdb.gra1-ovh.metrics.ovh.net" -} -``` - -For each component type, there is a list of metrics, and it requires a number of very precise settings (also called labels). - -#### Filers - -| Metrics | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.filer.datastore.diskspace.used | Filer usage in KB | datacenter : pcc-37-187-228-180_datacenter869,
datastore : pcc-000443 | - -#### Hosts - -| Metrics | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.host.cpu.usage.perc | Host processor usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51 | -| vscope.host.mem.usage.perc | Host RAM usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51 | -| vscope.host.net.tx | Host outgoing network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.rx | Host incoming network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetstx | Number of network packets sent from the host | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetsrx | Number of network packets received from the host | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | - -#### Virtual machines - -| Metrics | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.vm.cpu.usage.perc | VM processor usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.mem.usage.perc | VM RAM usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.cpu.ready |VM’s CPU Ready time in milliseconds | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.rx | VM incoming network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.tx | VM outgoing network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.packetsrx | Number of network packets received from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.packetstx | Number of network packets sent from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.io.read | IO number per second in read mode from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.io.write | IO number per second in write mode from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.bandwidth.read | VM disk bandwidth in read mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.bandwidth.write | VM disk bandwidth in write mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.latency.read | VM disk latency in read mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.latency.write | VM disk latency in write mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | - -#### Example of data gathered using the OpenTSDB protocol - -Now that you have retrieved your token, your endpoint, and your list of metrics, you can retrieve a host’s RAM usage data for a period of 1 day. - -Below is an example query: - -``` -curl -XPOST https://read:XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX@opentsdb.gra1-ovh.metrics.ovh.net/api/query --d '{ - "start":1564407950, - "queries":[ - { - "metric":"vscope.host.mem.usage.perc", - "aggregator":"sum", - "downsample":"20m-max-zero", - "tags": { - "datacenter":"pcc-37-187-228-180_datacenter869", - "host":"172.17.86.51" - } - } - ] -}' -``` - -Below are explanations of the fields used: - -- **read:** user used to send the query (will always be read). -- XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX: the token retrieved earlier via the APIv6. -- **opentsdb.gra1-ovh.metrics.ovh.net:** OpenTSDB endpoint, also retrieved via the APIv6. This endpoint may vary depending on your location. -- **start:** a timestamp corresponding to the query’s start date. -- **queries:** a table containing the metrics to retrieve. Several metrics may be retrieved in a single query. -- **metric:** the name of the metric to retrieve. -- **aggregator:** the name of the aggregation feature (please refer to OpenTSDB documentation for further details). -- **downsample:** the name of the downsampling feature (can be used to reduce the amount of data to retrieve. Optional setting). -- **tags:** a list of labels in the form of key/value. - -Other settings may also be provided. Please refer to the documentation for the OpenTSDB API for further details. - -You will then receive a *json* with the query summary, as well as the timestamps associated with their value in the **dps** field. -For example: - -```json -[ - { - "metric":"vscope.host.mem.usage.perc", - "tags":{ - "datacenter":"pcc-37-187-228-180_datacenter869", - "env":"prod", - "host":"172.17.86.51", - "servicename":"pcc-37-187-228-180", - "servicetype":"vscope" - }, - "query":{ - "index":0 - }, - "aggregateTags":[], - "dps":{ - "1564409391":4.38, - "1564410591":4.35, - "1564411791":4.37, - "1564412991":4.38, - "1564414191":4.35, - "1564415391":4.38, - "1564416591":4.35, - "1564417791":4.36, - "1564418991":4.36, - "1564420191":4.37, - "1564421391":4.37, - "1564422591":4.37, - "1564423791":4.37, - "1564424991":4.38, - "1564426191":4.36, - "1564427391":4.35, - "1564428591":4.37, - "1564429791":4.36, - "1564430991":4.38, - "1564432191":4.35, - "1564433391":4.37, - "1564434591":4.36, - "1564435791":4.37, - "1564436991":4.37, - "1564438191":4.37, - "1564439391":4.38, - "1564440591":4.36, - "1564441791":4.36, - "1564442991":4.37, - "1564444191":4.37, - "1564445391":4.35, - "1564446591":4.36, - "1564447791":4.36, - "1564448991":4.36, - "1564450191":4.35, - "1564451391":4.37, - "1564452591":4.37, - "1564453791":4.35, - "1564454991":4.36, - "1564456191":4.37, - "1564457391":4.37, - "1564458591":4.36, - "1564459791":4.37, - "1564460991":4.34, - "1564462191":4.36, - "1564463391":4.34, - "1564464591":4.37, - "1564465791":4.34, - "1564466991":4.37, - "1564468191":4.34, - "1564469391":4.36, - "1564470591":4.36, - "1564471791":4.36, - "1564472991":4.37, - "1564474191":4.37, - "1564475391":4.36, - "1564476591":4.35, - "1564477791":4.36, - "1564478991":4.35, - "1564480191":4.35, - "1564481391":4.37, - "1564482591":4.36, - "1564483791":4.34, - "1564484991":4.37, - "1564486191":4.38, - "1564487391":4.35, - "1564488591":4.34, - "1564489791":4.36, - "1564490991":4.35, - "1564492191":4.36, - "1564493391":4.36, - "1564494591":4.36 - } - } -] -``` - -For further details on OpenTSDB queries, please refer to the following documentation: [OpenTSDB API query](http://opentsdb.net/docs/build/html/api_http/query/index.html) - -## Go further - -Join our community of users on . diff --git a/pages/bare_metal_cloud/managed_bare_metal/vscope-api/guide.en-us.md b/pages/bare_metal_cloud/managed_bare_metal/vscope-api/guide.en-us.md deleted file mode 100644 index e70f289cc5a..00000000000 --- a/pages/bare_metal_cloud/managed_bare_metal/vscope-api/guide.en-us.md +++ /dev/null @@ -1,266 +0,0 @@ ---- -title: 'Using the vScope API' -excerpt: 'Find out how to use the vScope API to collect monitoring data in your applications' -updated: 2020-11-18 ---- - -## Objective - -OVHcloud provides you with a tool called **vScope**, for supervising and monitoring your virtual machines and infrastructures. - -It is a webpage that displays useful information on your resource usage. - -You can also access this information via the APIv6 and Metrics API. - -**This guide explains how to use these APIs.** - -## Requirements - -- a [Managed Bare Metal infrastructure](https://www.ovhcloud.com/en/managed-bare-metal/) -- access to the management interface (vScope) - -## Instructions - -vScope provides two types of information: - -- **Live** information which corresponds to the information on different components at a given time. -- Graphs presenting logged performance data for different components, such as a virtual machine’s CPU and RAM. - -### Collecting **live** data - -**Live** data is the data available via the vScope interface’s main page. - -![vScope-API](images/vScope1.png){.thumbnail} - -You can retrieve **live** data for the following components: - -- filers -- hosts -- virtual machines - -You can use the API via the following three APIv6 calls: - -#### Filers - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/filer/{filerId} -> - -#### Hosts - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host/{hostId} -> - -#### Virtual machines - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/vm/{vmId} -> - -### Collecting logged data (graphs) - -To collect and use logged data (graphs), we use the **Metrics Data Platforms** product. - -Via OpenTSDB or WARP10 protocol, you will be able to retrieve your data as points. You can use these points via your application, or directly display them in your choice of rendering. - -The following instructions cover the use of the OpenTSDB protocol for a raw data display (no graph rendering). - -To use **Metrics Data Platforms**, you will need to get a *read* token. With the new version of vScope, each infrastructure user has a *read* token. - -Use the following APIv6 call to retrieve the read token for the user you want: - -> [!api] -> -> @api {v1} /dedicatedCloud POST /dedicatedCloud/{serviceName}/user/{userId}/metricsToken -> - -Your token will be in the result’s **token** field. - -```json -{ - "warpEndpoint": "https://warp10.gra1-ovh.metrics.ovh.net", - "token": "XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX", - "opentsdbEndpoint": "https://opentsdb.gra1-ovh.metrics.ovh.net" -} -``` - -For each component type, there is a list of metrics, and it requires a number of very precise settings (also called labels). - -#### Filers - -| Metrics | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.filer.datastore.diskspace.used | Filer usage in KB | datacenter : pcc-37-187-228-180_datacenter869,
datastore : pcc-000443 | - -#### Hosts - -| Metrics | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.host.cpu.usage.perc | Host processor usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51 | -| vscope.host.mem.usage.perc | Host RAM usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51 | -| vscope.host.net.tx | Host outgoing network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.rx | Host incoming network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetstx | Number of network packets sent from the host | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetsrx | Number of network packets received from the host | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | - -#### Virtual machines - -| Metrics | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.vm.cpu.usage.perc | VM processor usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.mem.usage.perc | VM RAM usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.cpu.ready |VM’s CPU Ready time in milliseconds | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.rx | VM incoming network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.tx | VM outgoing network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.packetsrx | Number of network packets received from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.packetstx | Number of network packets sent from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.io.read | IO number per second in read mode from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.io.write | IO number per second in write mode from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.bandwidth.read | VM disk bandwidth in read mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.bandwidth.write | VM disk bandwidth in write mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.latency.read | VM disk latency in read mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.latency.write | VM disk latency in write mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | - -#### Example of data gathered using the OpenTSDB protocol - -Now that you have retrieved your token, your endpoint, and your list of metrics, you can retrieve a host’s RAM usage data for a period of 1 day. - -Below is an example query: - -``` -curl -XPOST https://read:XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX@opentsdb.gra1-ovh.metrics.ovh.net/api/query --d '{ - "start":1564407950, - "queries":[ - { - "metric":"vscope.host.mem.usage.perc", - "aggregator":"sum", - "downsample":"20m-max-zero", - "tags": { - "datacenter":"pcc-37-187-228-180_datacenter869", - "host":"172.17.86.51" - } - } - ] -}' -``` - -Below are explanations of the fields used: - -- **read:** user used to send the query (will always be read). -- XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX: the token retrieved earlier via the APIv6. -- **opentsdb.gra1-ovh.metrics.ovh.net:** OpenTSDB endpoint, also retrieved via the APIv6. This endpoint may vary depending on your location. -- **start:** a timestamp corresponding to the query’s start date. -- **queries:** a table containing the metrics to retrieve. Several metrics may be retrieved in a single query. -- **metric:** the name of the metric to retrieve. -- **aggregator:** the name of the aggregation feature (please refer to OpenTSDB documentation for further details). -- **downsample:** the name of the downsampling feature (can be used to reduce the amount of data to retrieve. Optional setting). -- **tags:** a list of labels in the form of key/value. - -Other settings may also be provided. Please refer to the documentation for the OpenTSDB API for further details. - -You will then receive a *json* with the query summary, as well as the timestamps associated with their value in the **dps** field. -For example: - -```json -[ - { - "metric":"vscope.host.mem.usage.perc", - "tags":{ - "datacenter":"pcc-37-187-228-180_datacenter869", - "env":"prod", - "host":"172.17.86.51", - "servicename":"pcc-37-187-228-180", - "servicetype":"vscope" - }, - "query":{ - "index":0 - }, - "aggregateTags":[], - "dps":{ - "1564409391":4.38, - "1564410591":4.35, - "1564411791":4.37, - "1564412991":4.38, - "1564414191":4.35, - "1564415391":4.38, - "1564416591":4.35, - "1564417791":4.36, - "1564418991":4.36, - "1564420191":4.37, - "1564421391":4.37, - "1564422591":4.37, - "1564423791":4.37, - "1564424991":4.38, - "1564426191":4.36, - "1564427391":4.35, - "1564428591":4.37, - "1564429791":4.36, - "1564430991":4.38, - "1564432191":4.35, - "1564433391":4.37, - "1564434591":4.36, - "1564435791":4.37, - "1564436991":4.37, - "1564438191":4.37, - "1564439391":4.38, - "1564440591":4.36, - "1564441791":4.36, - "1564442991":4.37, - "1564444191":4.37, - "1564445391":4.35, - "1564446591":4.36, - "1564447791":4.36, - "1564448991":4.36, - "1564450191":4.35, - "1564451391":4.37, - "1564452591":4.37, - "1564453791":4.35, - "1564454991":4.36, - "1564456191":4.37, - "1564457391":4.37, - "1564458591":4.36, - "1564459791":4.37, - "1564460991":4.34, - "1564462191":4.36, - "1564463391":4.34, - "1564464591":4.37, - "1564465791":4.34, - "1564466991":4.37, - "1564468191":4.34, - "1564469391":4.36, - "1564470591":4.36, - "1564471791":4.36, - "1564472991":4.37, - "1564474191":4.37, - "1564475391":4.36, - "1564476591":4.35, - "1564477791":4.36, - "1564478991":4.35, - "1564480191":4.35, - "1564481391":4.37, - "1564482591":4.36, - "1564483791":4.34, - "1564484991":4.37, - "1564486191":4.38, - "1564487391":4.35, - "1564488591":4.34, - "1564489791":4.36, - "1564490991":4.35, - "1564492191":4.36, - "1564493391":4.36, - "1564494591":4.36 - } - } -] -``` - -For further details on OpenTSDB queries, please refer to the following documentation: [OpenTSDB API query](http://opentsdb.net/docs/build/html/api_http/query/index.html) - -## Go further - -Join our community of users on . diff --git a/pages/bare_metal_cloud/managed_bare_metal/vscope-api/guide.es-es.md b/pages/bare_metal_cloud/managed_bare_metal/vscope-api/guide.es-es.md deleted file mode 100644 index 52bb1be340a..00000000000 --- a/pages/bare_metal_cloud/managed_bare_metal/vscope-api/guide.es-es.md +++ /dev/null @@ -1,266 +0,0 @@ ---- -title: 'Cómo utilizar la API de vScope' -excerpt: 'Con la API vScope podrá utilizar los datos de monitorización en sus aplicaciones' -updated: 2020-11-18 ---- - -## Objetivo - -OVHcloud pone a su disposición una herramienta de supervisión y monitorización de sus máquinas virtuales y de su infraestructura llamada **vScope**. - -Se trata de una página web en la que se recopila toda la información necesaria sobre el uso de sus recursos. - -Esta información también se encuentra disponible en la APIv6 y la API Metrics. - -**Esta guía explica cómo utilizar estas API**. - -## Requisitos - -- Tener [una infraestructura Managed Bare Metal](https://www.ovhcloud.com/es-es/managed-bare-metal/). -- Estar conectado a la interfaz vScope. - -## Procedimiento - -La herramienta vScope proporciona dos tipos de información: - -- Información **live**, que corresponde a los datos de los diferentes componentes en un momento determinado. -- Gráficos que presentan los datos históricos de rendimiento de los diferentes componentes como, por ejemplo, la CPU y la RAM de una máquina virtual. - -### Recopilar los datos **live** - -Los datos **live** son aquellos que se encuentran disponibles en la página principal de la interfaz vScope. - -![vScope-API](images/vScope1.png){.thumbnail} - -Podrá obtener los datos **live** para los siguientes componentes: - -- filers; -- hosts; -- máquinas virtuales. - -El uso de la API se realiza a través de estas tres llamadas APIv6: - -#### Filers - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/filer/{filerId} -> - -#### Hosts - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host/{hostId} -> - -#### Máquina virtual - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/vm/{vmId} -> - -### Recopilar los datos históricos (Graphs) - -Para recopilar y utilizar los datos históricos (Graphs), puede utilizar la solución **Metrics Data Platform**. - -Mediante el protocolo Opentsdb o WARP10, podrá obtener sus datos en forma de puntos. Asimismo, podrá utilizarlos a través de su aplicación o verlos directamente según el renderizado deseado. - -En esta guía explicaremos el uso del protocolo Opentsdb para obtener una visualización de datos en bruto (sin renderizado gráfico). - -Para poder utilizar **Metrics Data Platform**, necesitará un token de lectura. Con la nueva versión del vScope, cada usuario de la infraestructura dispone de un token de lectura. - -Para el usuario deseado, utilice la siguiente llamada a la APIv6 y obtenga el token de lectura: - -> [!api] -> -> @api {v1} /dedicatedCloud POST /dedicatedCloud/{serviceName}/user/{userId}/metricsToken -> - -Su token se encuentra en el campo **token** del resultado. - -```json -{ - "warpEndpoint": "https://warp10.gra1-ovh.metrics.ovh.net", - "token": "XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX", - "opentsdbEndpoint": "https://opentsdb.gra1-ovh.metrics.ovh.net" -} -``` - -Para cada tipo de componente, existe una lista de métricas y necesita un número muy preciso de parámetros (también llamados labels). - -#### Filers - -| Métricas | Descripción | Labels | -| ----------- | ----------- | ----------- | -| vscope.filer.datastore.diskspace.used | Uso del filer en kB | datacenter: pcc-37-187-228-180_datacenter869,
datastore: pcc-000443 | - -#### Hosts - -| Métricas | Descripción | Labels | -| ----------- | ----------- | ----------- | -| vscope.host.cpu.usage.perc | Uso del procesador del host en porcentaje | \- datacenter: pcc-37-187-228-180_datacenter869,
\- host: 172.17.86.51 | -| vscope.host.mem.usage.perc | Uso de la memoria del host en porcentaje | \- datacenter: pcc-37-187-228-180_datacenter869,
\- host: 172.17.86.51 | -| vscope.host.net.tx | Uso de la red del host de emisión | \- datacenter: pcc-37-187-228-180_datacenter869,
\- host: 172.17.86.51
\- nicname: vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.rx | Uso de la red del host de recepción | \- datacenter: pcc-37-187-228-180_datacenter869,
\- host: 172.17.86.51
\- nicname: vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetstx | Número de paquetes de red transmitidos por el host | \- datacenter: pcc-37-187-228-180_datacenter869,
\- host: 172.17.86.51
\- nicname: vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetsrx | Número de paquetes de red recibidos por el host | \- datacenter: pcc-37-187-228-180_datacenter869,
\- host: 172.17.86.51
\- nicname: vmnic0/vmnic1/vmnic2/vmnic3 | - -#### Máquinas virtuales - -| Métricas | Descripción | Labels | -| ----------- | ----------- | ----------- | -| vscope.vm.cpu.usage.perc | Uso del procesador de la MV en porcentaje | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.mem.usage.perc | Uso de la memoria de la MV en porcentaje | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.cpu.ready |CPU Ready de la MV en milisegundos | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.net.rx | Uso de la red de la MV de recepción | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.net.tx | Uso de la red de la MV de transmisión | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.net.packetsrx | Número de paquetes de red recibidos por la MV | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.net.packetstx | Número de paquetes de red transmitidos por la MV | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.disk.io.read | Número de IO en lectura por segundo de la MV | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.disk.io.write | Número de IO en escritura por segundo de la MV | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.disk.bandwidth.read | Ancho de banda del disco de la MV en modo lectura | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.disk.bandwidth.write | Ancho de banda del disco de la MV en modo escritura | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.disk.latency.read | Latencia del disco de la MV en modo lectura | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.disk.latency.write | Latencia del disco de la MV en modo escritura | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | - -#### Ejemplo de recopilación con el protocolo OpenTSDB - -Una vez que obtuvo su token, su endpoint y su lista de métricas, recuperará los datos de uso de memoria de un host en un día. - -A continuación, encontrará un ejemplo de petición. - -``` -curl -XPOST https://read:XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX@opentsdb.gra1-ovh.metrics.ovh.net/api/query --d '{ - "start":1564407950, - "queries":[ - { - "metric":"vscope.host.mem.usage.perc", - "aggregator":"sum", - "downsample":"20m-max-zero", - "tags": { - "datacenter":"pcc-37-187-228-180_datacenter869", - "host":"172.17.86.51" - } - } - ] -}' -``` - -Explicación de los diferentes campos utilizados: - -- read: usuario utilizado para efectuar la petición (siempre será read); -- XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX: token previamente obtenido mediante la APIv6; -- opentsdb.gra1-ovh.metrics.ovh.net: endpoint OpenTSDB, también obtenido mediante la APIv6. Este endpoint puede variar según su localización; -- start: marcas de tiempo que corresponden a la fecha de inicio de la petición; -- queries: tabla que contiene las métricas por obtener. Se pueden recuperar varias métricas en una sola petición; -- metric: nombre de la métrica por obtener; -- aggregator: nombre de la función de agregación (consultar la documentación OpenTSDB para más información); -- downsample: nombre de la función de muestreo (permite reducir el número de datos por recuperar. Parámetro optativo); -- tags: lista de labels (etiquetas) en forma de llave / valor; - -También pueden suministrarse otros parámetros. Por favor, consulte la documentación de la API OpenTSDB para más información. - -A su vez, recibirá un JSON con el resumen de la petición, como también las marcas de tiempo asociadas a su valor en el campo**dps**. -Ejemplo: - -```json -[ - { - "metric":"vscope.host.mem.usage.perc", - "tags":{ - "datacenter":"pcc-37-187-228-180_datacenter869", - "env":"prod", - "host":"172.17.86.51", - "servicename":"pcc-37-187-228-180", - "servicetype":"vscope" - }, - "query":{ - "index":0 - }, - "aggregateTags":[], - "dps":{ - "1564409391":4.38, - "1564410591":4.35, - "1564411791":4.37, - "1564412991":4.38, - "1564414191":4.35, - "1564415391":4.38, - "1564416591":4.35, - "1564417791":4.36, - "1564418991":4.36, - "1564420191":4.37, - "1564421391":4.37, - "1564422591":4.37, - "1564423791":4.37, - "1564424991":4.38, - "1564426191":4.36, - "1564427391":4.35, - "1564428591":4.37, - "1564429791":4.36, - "1564430991":4.38, - "1564432191":4.35, - "1564433391":4.37, - "1564434591":4.36, - "1564435791":4.37, - "1564436991":4.37, - "1564438191":4.37, - "1564439391":4.38, - "1564440591":4.36, - "1564441791":4.36, - "1564442991":4.37, - "1564444191":4.37, - "1564445391":4.35, - "1564446591":4.36, - "1564447791":4.36, - "1564448991":4.36, - "1564450191":4.35, - "1564451391":4.37, - "1564452591":4.37, - "1564453791":4.35, - "1564454991":4.36, - "1564456191":4.37, - "1564457391":4.37, - "1564458591":4.36, - "1564459791":4.37, - "1564460991":4.34, - "1564462191":4.36, - "1564463391":4.34, - "1564464591":4.37, - "1564465791":4.34, - "1564466991":4.37, - "1564468191":4.34, - "1564469391":4.36, - "1564470591":4.36, - "1564471791":4.36, - "1564472991":4.37, - "1564474191":4.37, - "1564475391":4.36, - "1564476591":4.35, - "1564477791":4.36, - "1564478991":4.35, - "1564480191":4.35, - "1564481391":4.37, - "1564482591":4.36, - "1564483791":4.34, - "1564484991":4.37, - "1564486191":4.38, - "1564487391":4.35, - "1564488591":4.34, - "1564489791":4.36, - "1564490991":4.35, - "1564492191":4.36, - "1564493391":4.36, - "1564494591":4.36 - } - } -] -``` - -Para más información sobre las peticiones OpenTSDB, consulte la siguiente documentación: [OpenTSDB api query](http://opentsdb.net/docs/build/html/api_http/query/index.html) - -## Más información - -Interactúe con nuestra comunidad de usuarios en . diff --git a/pages/bare_metal_cloud/managed_bare_metal/vscope-api/guide.es-us.md b/pages/bare_metal_cloud/managed_bare_metal/vscope-api/guide.es-us.md deleted file mode 100644 index 23b7f8ec349..00000000000 --- a/pages/bare_metal_cloud/managed_bare_metal/vscope-api/guide.es-us.md +++ /dev/null @@ -1,266 +0,0 @@ ---- -title: 'Cómo utilizar la API de vScope' -excerpt: 'Con la API vScope podrá utilizar los datos de monitorización en sus aplicaciones' -updated: 2020-11-18 ---- - -## Objetivo - -OVHcloud pone a su disposición una herramienta de supervisión y monitorización de sus máquinas virtuales y de su infraestructura llamada **vScope**. - -Se trata de una página web en la que se recopila toda la información necesaria sobre el uso de sus recursos. - -Esta información también se encuentra disponible en la APIv6 y la API Metrics. - -**Esta guía explica cómo utilizar estas API**. - -## Requisitos - -- Tener [una infraestructura Managed Bare Metal](https://www.ovhcloud.com/es/managed-bare-metal/). -- Estar conectado a la interfaz vScope. - -## Procedimiento - -La herramienta vScope proporciona dos tipos de información: - -- Información **live**, que corresponde a los datos de los diferentes componentes en un momento determinado. -- Gráficos que presentan los datos históricos de rendimiento de los diferentes componentes como, por ejemplo, la CPU y la RAM de una máquina virtual. - -### Recopilar los datos **live** - -Los datos **live** son aquellos que se encuentran disponibles en la página principal de la interfaz vScope. - -![vScope-API](images/vScope1.png){.thumbnail} - -Podrá obtener los datos **live** para los siguientes componentes: - -- filers; -- hosts; -- máquinas virtuales. - -El uso de la API se realiza a través de estas tres llamadas APIv6: - -#### Filers - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/filer/{filerId} -> - -#### Hosts - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host/{hostId} -> - -#### Máquina virtual - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/vm/{vmId} -> - -### Recopilar los datos históricos (Graphs) - -Para recopilar y utilizar los datos históricos (Graphs), puede utilizar la solución **Metrics Data Platform**. - -Mediante el protocolo Opentsdb o WARP10, podrá obtener sus datos en forma de puntos. Asimismo, podrá utilizarlos a través de su aplicación o verlos directamente según el renderizado deseado. - -En esta guía explicaremos el uso del protocolo Opentsdb para obtener una visualización de datos en bruto (sin renderizado gráfico). - -Para poder utilizar **Metrics Data Platform**, necesitará un token de lectura. Con la nueva versión del vScope, cada usuario de la infraestructura dispone de un token de lectura. - -Para el usuario deseado, utilice la siguiente llamada a la APIv6 y obtenga el token de lectura: - -> [!api] -> -> @api {v1} /dedicatedCloud POST /dedicatedCloud/{serviceName}/user/{userId}/metricsToken -> - -Su token se encuentra en el campo **token** del resultado. - -```json -{ - "warpEndpoint": "https://warp10.gra1-ovh.metrics.ovh.net", - "token": "XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX", - "opentsdbEndpoint": "https://opentsdb.gra1-ovh.metrics.ovh.net" -} -``` - -Para cada tipo de componente, existe una lista de métricas y necesita un número muy preciso de parámetros (también llamados labels). - -#### Filers - -| Métricas | Descripción | Labels | -| ----------- | ----------- | ----------- | -| vscope.filer.datastore.diskspace.used | Uso del filer en kB | datacenter: pcc-37-187-228-180_datacenter869,
datastore: pcc-000443 | - -#### Hosts - -| Métricas | Descripción | Labels | -| ----------- | ----------- | ----------- | -| vscope.host.cpu.usage.perc | Uso del procesador del host en porcentaje | \- datacenter: pcc-37-187-228-180_datacenter869,
\- host: 172.17.86.51 | -| vscope.host.mem.usage.perc | Uso de la memoria del host en porcentaje | \- datacenter: pcc-37-187-228-180_datacenter869,
\- host: 172.17.86.51 | -| vscope.host.net.tx | Uso de la red del host de emisión | \- datacenter: pcc-37-187-228-180_datacenter869,
\- host: 172.17.86.51
\- nicname: vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.rx | Uso de la red del host de recepción | \- datacenter: pcc-37-187-228-180_datacenter869,
\- host: 172.17.86.51
\- nicname: vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetstx | Número de paquetes de red transmitidos por el host | \- datacenter: pcc-37-187-228-180_datacenter869,
\- host: 172.17.86.51
\- nicname: vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetsrx | Número de paquetes de red recibidos por el host | \- datacenter: pcc-37-187-228-180_datacenter869,
\- host: 172.17.86.51
\- nicname: vmnic0/vmnic1/vmnic2/vmnic3 | - -#### Máquinas virtuales - -| Métricas | Descripción | Labels | -| ----------- | ----------- | ----------- | -| vscope.vm.cpu.usage.perc | Uso del procesador de la MV en porcentaje | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.mem.usage.perc | Uso de la memoria de la MV en porcentaje | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.cpu.ready |CPU Ready de la MV en milisegundos | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.net.rx | Uso de la red de la MV de recepción | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.net.tx | Uso de la red de la MV de transmisión | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.net.packetsrx | Número de paquetes de red recibidos por la MV | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.net.packetstx | Número de paquetes de red transmitidos por la MV | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.disk.io.read | Número de IO en lectura por segundo de la MV | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.disk.io.write | Número de IO en escritura por segundo de la MV | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.disk.bandwidth.read | Ancho de banda del disco de la MV en modo lectura | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.disk.bandwidth.write | Ancho de banda del disco de la MV en modo escritura | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.disk.latency.read | Latencia del disco de la MV en modo lectura | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.disk.latency.write | Latencia del disco de la MV en modo escritura | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | - -#### Ejemplo de recopilación con el protocolo OpenTSDB - -Una vez que obtuvo su token, su endpoint y su lista de métricas, recuperará los datos de uso de memoria de un host en un día. - -A continuación, encontrará un ejemplo de petición. - -``` -curl -XPOST https://read:XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX@opentsdb.gra1-ovh.metrics.ovh.net/api/query --d '{ - "start":1564407950, - "queries":[ - { - "metric":"vscope.host.mem.usage.perc", - "aggregator":"sum", - "downsample":"20m-max-zero", - "tags": { - "datacenter":"pcc-37-187-228-180_datacenter869", - "host":"172.17.86.51" - } - } - ] -}' -``` - -Explicación de los diferentes campos utilizados: - -- read: usuario utilizado para efectuar la petición (siempre será read); -- XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX: token previamente obtenido mediante la APIv6; -- opentsdb.gra1-ovh.metrics.ovh.net: endpoint OpenTSDB, también obtenido mediante la APIv6. Este endpoint puede variar según su localización; -- start: marcas de tiempo que corresponden a la fecha de inicio de la petición; -- queries: tabla que contiene las métricas por obtener. Se pueden recuperar varias métricas en una sola petición; -- metric: nombre de la métrica por obtener; -- aggregator: nombre de la función de agregación (consultar la documentación OpenTSDB para más información); -- downsample: nombre de la función de muestreo (permite reducir el número de datos por recuperar. Parámetro optativo); -- tags: lista de labels (etiquetas) en forma de llave / valor; - -También pueden suministrarse otros parámetros. Por favor, consulte la documentación de la API OpenTSDB para más información. - -A su vez, recibirá un JSON con el resumen de la petición, como también las marcas de tiempo asociadas a su valor en el campo**dps**. -Ejemplo: - -```json -[ - { - "metric":"vscope.host.mem.usage.perc", - "tags":{ - "datacenter":"pcc-37-187-228-180_datacenter869", - "env":"prod", - "host":"172.17.86.51", - "servicename":"pcc-37-187-228-180", - "servicetype":"vscope" - }, - "query":{ - "index":0 - }, - "aggregateTags":[], - "dps":{ - "1564409391":4.38, - "1564410591":4.35, - "1564411791":4.37, - "1564412991":4.38, - "1564414191":4.35, - "1564415391":4.38, - "1564416591":4.35, - "1564417791":4.36, - "1564418991":4.36, - "1564420191":4.37, - "1564421391":4.37, - "1564422591":4.37, - "1564423791":4.37, - "1564424991":4.38, - "1564426191":4.36, - "1564427391":4.35, - "1564428591":4.37, - "1564429791":4.36, - "1564430991":4.38, - "1564432191":4.35, - "1564433391":4.37, - "1564434591":4.36, - "1564435791":4.37, - "1564436991":4.37, - "1564438191":4.37, - "1564439391":4.38, - "1564440591":4.36, - "1564441791":4.36, - "1564442991":4.37, - "1564444191":4.37, - "1564445391":4.35, - "1564446591":4.36, - "1564447791":4.36, - "1564448991":4.36, - "1564450191":4.35, - "1564451391":4.37, - "1564452591":4.37, - "1564453791":4.35, - "1564454991":4.36, - "1564456191":4.37, - "1564457391":4.37, - "1564458591":4.36, - "1564459791":4.37, - "1564460991":4.34, - "1564462191":4.36, - "1564463391":4.34, - "1564464591":4.37, - "1564465791":4.34, - "1564466991":4.37, - "1564468191":4.34, - "1564469391":4.36, - "1564470591":4.36, - "1564471791":4.36, - "1564472991":4.37, - "1564474191":4.37, - "1564475391":4.36, - "1564476591":4.35, - "1564477791":4.36, - "1564478991":4.35, - "1564480191":4.35, - "1564481391":4.37, - "1564482591":4.36, - "1564483791":4.34, - "1564484991":4.37, - "1564486191":4.38, - "1564487391":4.35, - "1564488591":4.34, - "1564489791":4.36, - "1564490991":4.35, - "1564492191":4.36, - "1564493391":4.36, - "1564494591":4.36 - } - } -] -``` - -Para más información sobre las peticiones OpenTSDB, consulte la siguiente documentación: [OpenTSDB api query](http://opentsdb.net/docs/build/html/api_http/query/index.html) - -## Más información - -Interactúe con nuestra comunidad de usuarios en . diff --git a/pages/bare_metal_cloud/managed_bare_metal/vscope-api/guide.fr-ca.md b/pages/bare_metal_cloud/managed_bare_metal/vscope-api/guide.fr-ca.md deleted file mode 100644 index f745c0ee137..00000000000 --- a/pages/bare_metal_cloud/managed_bare_metal/vscope-api/guide.fr-ca.md +++ /dev/null @@ -1,266 +0,0 @@ ---- -title: 'Comment utiliser l’API de vScope' -excerpt: 'L’API vScope vous permet d’utiliser les données de monitoring dans vos applications' -updated: 2020-11-18 ---- - -## Objectif - -OVHcloud vous met à disposition un outil de supervision et de monitoring de vos machines virtuelles et de votre infrastructure qui se nomme **vScope**. - -Il s’agit d’une page web où sont rassemblées toutes les informations utiles concernant l'usage de vos ressources. - -Ces informations sont également disponibles via l'APIv6 et l'API Metrics. - -**Ce guide décrit l'utilisation de ces APIs**. - -## Prérequis - -- une [infrastructure Managed Bare Metal](https://www.ovhcloud.com/fr-ca/managed-bare-metal/) -- être connecté à l'interface de gestion vScope - -## En pratique - -L'outil vScope met à disposition deux types d'informations : - -- des informations **live**, qui correspondent aux données des différents composants à un instant T. -- des graphiques présentant les données historiques de performance des différents composants. Par exemple : CPU, RAM d'une machine virtuelle. - -### Collecter les données **live** - -Les données **live** sont les données disponibles depuis la page principale de l'interface vScope. - -![vScope-API](images/vScope1.png){.thumbnail} - -Vous pourrez récupérer ces données **live** pour les composants suivants : - -- filers -- hosts -- virtual machines - -L'utilisation de l'API se fait via ces trois appels APIv6 : - -#### Filers - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/filer/{filerId} -> - -#### Hosts - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host/{hostId} -> - -#### Machine virtuelles - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/vm/{vmId} -> - -### Collecter les données historiques (Graphs) - -Pour collecter et utiliser les données historiques (Graphs), nous utilisons le produit **Metrics Data Platforms**. - -Via les protocoles Opentsdb ou WARP10, vous allez pouvoir récupérer vos données sous forme de points. Vous pourrez exploiter ces points via votre application ou directement les afficher selon le rendu souhaité. - -Cet article couvrira l'utilisation du protocole Opentsdb pour un affichage brut des données (pas de rendu graphique). - -Pour pouvoir utiliser **Metrics Data Platforms**, vous aurez besoin d'obtenir un token de lecture. Avec la nouvelle version du vScope, chaque utilisateur de l'infrastructure possède un token de lecture. - -Pour l'utilisateur souhaité, utilisez l'appel APIv6 suivant pour récupérer le token de lecture : - -> [!api] -> -> @api {v1} /dedicatedCloud POST /dedicatedCloud/{serviceName}/user/{userId}/metricsToken -> - -Votre token se trouve dans le champ **token** du résultat. - -```json -{ - "warpEndpoint": "https://warp10.gra1-ovh.metrics.ovh.net", - "token": "XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX", - "opentsdbEndpoint": "https://opentsdb.gra1-ovh.metrics.ovh.net" -} -``` - -Pour chaque type de composant, une liste de métriques est disponible et nécessite un nombre de paramètres (aussi appelé labels) très précis. - -#### Filers - -| Métriques | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.filer.datastore.diskspace.used | Utilisation du filer en kB | datacenter : pcc-37-187-228-180\_datacenter869,
datastore : pcc-000443 | - -#### Hosts - -| Métriques | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.host.cpu.usage.perc | Utilisation processeur du host en pourcent | - datacenter : pcc-37-187-228-180\_datacenter869,
- host : 172.17.86.51 | -| vscope.host.mem.usage.perc | Utilisation mémoire du host en pourcent | - datacenter : pcc-37-187-228-180\_datacenter869,
- host : 172.17.86.51 | -| vscope.host.net.tx | Utilisation réseau du host en émission | - datacenter : pcc-37-187-228-180\_datacenter869,
- host : 172.17.86.51
- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.rx | Utilisation réseau du host en réception | - datacenter : pcc-37-187-228-180\_datacenter869,
- host : 172.17.86.51
- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetstx | Nombre de packets réseau transmis du host | - datacenter : pcc-37-187-228-180\_datacenter869,
- host : 172.17.86.51
- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetsrx | Nombre de packets réseau reçus du host | - datacenter : pcc-37-187-228-180\_datacenter869,
- host : 172.17.86.51
- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | - -#### Machine Virtuelles - -| Métriques | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.vm.cpu.usage.perc | Utilisation processeur de la vm en pourcent | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | -| vscope.vm.mem.usage.perc | Utilisation mémoire de la vm en pourcent | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | -| vscope.vm.cpu.ready |CPU Ready de la vm en millisecond | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | -| vscope.vm.net.rx | Utilisation réseau de la vm en réception | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | -| vscope.vm.net.tx | Utilisation réseau de la vm en transmission | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | -| vscope.vm.net.packetsrx | Nombre de packets réseau reçus de la vm | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | -| vscope.vm.net.packetstx | Nombre de packets réseau transmis de la vm | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | -| vscope.vm.disk.io.read | Nombre d'IO en lecture par seconde de la vm | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | -| vscope.vm.disk.io.write | Nombre d'IO en écriture par seconde de la vm | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | -| vscope.vm.disk.bandwidth.read | Bande passante du disk de la vm en lecture | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | -| vscope.vm.disk.bandwidth.write | Bande passante du disk de la vm en écriture | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | -| vscope.vm.disk.latency.read | Latence du disque de la vm en lecture | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | -| vscope.vm.disk.latency.write | Latence du disque de la vm en écriture | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | - -#### Exemple de collecte en utilisant le protocol OpenTSDB - -Maintenant que vous avez récupéré votre token, votre endpoint, et que vous avez la liste des métriques, vous allez récupérer les données d'utilisation mémoire d'un host sur une période de 1 jour. - -Veuillez trouver ci-dessous un exemple de requête. - -``` -curl -XPOST https://read:XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX@opentsdb.gra1-ovh.metrics.ovh.net/api/query --d '{ - "start":1564407950, - "queries":[ - { - "metric":"vscope.host.mem.usage.perc", - "aggregator":"sum", - "downsample":"20m-max-zero", - "tags": { - "datacenter":"pcc-37-187-228-180_datacenter869", - "host":"172.17.86.51" - } - } - ] -}' -``` - -Explication des différents champs utilisés : - -- read : user utilisé pour effectuer la requête (sera toujours read); -- XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX : token précédemment récupéré via l'APIv6; -- opentsdb.gra1-ovh.metrics.ovh.net : endpoint OpenTSDB, également récupéré via l'APIv6. Ce endpoint peut varier selon votre localisation; -- start : timestamp correspondant à la date de début de la requête; -- queries : tableau contenant les metriques à récupérer. Plusieurs métriques peuvent être récupérées en une seule requête; -- metric : nom de la métrique à récupérer; -- aggregator : nom de la fonction d'agrégation (se reporter à la documentation OpenTSDB pour plus de détails); -- downsample : nom de la fonction d'échantillonnage (permet de réduire le nombre de donnée à récupérer. Paramètre optionnel); -- tags : liste des labels sous la forme clé / valeur; - -D'autres paramètres peuvent également être fournis. Veuillez vous reporter à la documentation de l'api OpenTSDB pour plus de détails. - -Vous aurez alors en retour un json avec le récapitulatif de la requête, ainsi que les timestamps associés à leur valeur dans le champ **dps**. -Exemple : - -```json -[ - { - "metric":"vscope.host.mem.usage.perc", - "tags":{ - "datacenter":"pcc-37-187-228-180_datacenter869", - "env":"prod", - "host":"172.17.86.51", - "servicename":"pcc-37-187-228-180", - "servicetype":"vscope" - }, - "query":{ - "index":0 - }, - "aggregateTags":[], - "dps":{ - "1564409391":4.38, - "1564410591":4.35, - "1564411791":4.37, - "1564412991":4.38, - "1564414191":4.35, - "1564415391":4.38, - "1564416591":4.35, - "1564417791":4.36, - "1564418991":4.36, - "1564420191":4.37, - "1564421391":4.37, - "1564422591":4.37, - "1564423791":4.37, - "1564424991":4.38, - "1564426191":4.36, - "1564427391":4.35, - "1564428591":4.37, - "1564429791":4.36, - "1564430991":4.38, - "1564432191":4.35, - "1564433391":4.37, - "1564434591":4.36, - "1564435791":4.37, - "1564436991":4.37, - "1564438191":4.37, - "1564439391":4.38, - "1564440591":4.36, - "1564441791":4.36, - "1564442991":4.37, - "1564444191":4.37, - "1564445391":4.35, - "1564446591":4.36, - "1564447791":4.36, - "1564448991":4.36, - "1564450191":4.35, - "1564451391":4.37, - "1564452591":4.37, - "1564453791":4.35, - "1564454991":4.36, - "1564456191":4.37, - "1564457391":4.37, - "1564458591":4.36, - "1564459791":4.37, - "1564460991":4.34, - "1564462191":4.36, - "1564463391":4.34, - "1564464591":4.37, - "1564465791":4.34, - "1564466991":4.37, - "1564468191":4.34, - "1564469391":4.36, - "1564470591":4.36, - "1564471791":4.36, - "1564472991":4.37, - "1564474191":4.37, - "1564475391":4.36, - "1564476591":4.35, - "1564477791":4.36, - "1564478991":4.35, - "1564480191":4.35, - "1564481391":4.37, - "1564482591":4.36, - "1564483791":4.34, - "1564484991":4.37, - "1564486191":4.38, - "1564487391":4.35, - "1564488591":4.34, - "1564489791":4.36, - "1564490991":4.35, - "1564492191":4.36, - "1564493391":4.36, - "1564494591":4.36 - } - } -] -``` - -Pour plus de détails sur les requêtes OpenTSDB, vous pouvez vous reporter à la documentation suivante : [OpenTSDB api query](http://opentsdb.net/docs/build/html/api_http/query/index.html) - -## Aller plus loin - -Échangez avec notre [communauté d'utilisateurs](/links/community). diff --git a/pages/bare_metal_cloud/managed_bare_metal/vscope-api/guide.fr-fr.md b/pages/bare_metal_cloud/managed_bare_metal/vscope-api/guide.fr-fr.md deleted file mode 100644 index c299dca39e2..00000000000 --- a/pages/bare_metal_cloud/managed_bare_metal/vscope-api/guide.fr-fr.md +++ /dev/null @@ -1,266 +0,0 @@ ---- -title: 'Comment utiliser l’API de vScope' -excerpt: 'L’API vScope vous permet d’utiliser les données de monitoring dans vos applications' -updated: 2020-11-18 ---- - -## Objectif - -OVHcloud vous met à disposition un outil de supervision et de monitoring de vos machines virtuelles et de votre infrastructure qui se nomme **vScope**. - -Il s’agit d’une page web où sont rassemblées toutes les informations utiles concernant l'usage de vos ressources. - -Ces informations sont également disponibles via l'APIv6 et l'API Metrics. - -**Ce guide décrit l'utilisation de ces APIs**. - -## Prérequis - -- une [infrastructure Managed Bare Metal](https://www.ovhcloud.com/fr/managed-bare-metal/) -- être connecté à l'interface de gestion vScope - -## En pratique - -L'outil vScope met à disposition deux types d'informations : - -- des informations **live**, qui correspondent aux données des différents composants à un instant T. -- des graphiques présentant les données historiques de performance des différents composants. Par exemple : CPU, RAM d'une machine virtuelle. - -### Collecter les données **live** - -Les données **live** sont les données disponibles depuis la page principale de l'interface vScope. - -![vScope-API](images/vScope1.png){.thumbnail} - -Vous pourrez récupérer ces données **live** pour les composants suivants : - -- filers -- hosts -- virtual machines - -L'utilisation de l'API se fait via ces trois appels APIv6 : - -#### Filers - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/filer/{filerId} -> - -#### Hosts - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host/{hostId} -> - -#### Machine virtuelles - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/vm/{vmId} -> - -### Collecter les données historiques (Graphs) - -Pour collecter et utiliser les données historiques (Graphs), nous utilisons le produit **Metrics Data Platforms**. - -Via les protocoles Opentsdb ou WARP10, vous allez pouvoir récupérer vos données sous forme de points. Vous pourrez exploiter ces points via votre application ou directement les afficher selon le rendu souhaité. - -Cet article couvrira l'utilisation du protocole Opentsdb pour un affichage brut des données (pas de rendu graphique). - -Pour pouvoir utiliser **Metrics Data Platforms**, vous aurez besoin d'obtenir un token de lecture. Avec la nouvelle version du vScope, chaque utilisateur de l'infrastructure possède un token de lecture. - -Pour l'utilisateur souhaité, utilisez l'appel APIv6 suivant pour récupérer le token de lecture : - -> [!api] -> -> @api {v1} /dedicatedCloud POST /dedicatedCloud/{serviceName}/user/{userId}/metricsToken -> - -Votre token se trouve dans le champ **token** du résultat. - -```json -{ - "warpEndpoint": "https://warp10.gra1-ovh.metrics.ovh.net", - "token": "XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX", - "opentsdbEndpoint": "https://opentsdb.gra1-ovh.metrics.ovh.net" -} -``` - -Pour chaque type de composant, une liste de métriques est disponible et nécessite un nombre de paramètres (aussi appelé labels) très précis. - -#### Filers - -| Métriques | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.filer.datastore.diskspace.used | Utilisation du filer en kB | datacenter : pcc-37-187-228-180\_datacenter869,
datastore : pcc-000443 | - -#### Hosts - -| Métriques | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.host.cpu.usage.perc | Utilisation processeur du host en pourcent | - datacenter : pcc-37-187-228-180\_datacenter869,
- host : 172.17.86.51 | -| vscope.host.mem.usage.perc | Utilisation mémoire du host en pourcent | - datacenter : pcc-37-187-228-180\_datacenter869,
- host : 172.17.86.51 | -| vscope.host.net.tx | Utilisation réseau du host en émission | - datacenter : pcc-37-187-228-180\_datacenter869,
- host : 172.17.86.51
- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.rx | Utilisation réseau du host en réception | - datacenter : pcc-37-187-228-180\_datacenter869,
- host : 172.17.86.51
- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetstx | Nombre de packets réseau transmis du host | - datacenter : pcc-37-187-228-180\_datacenter869,
- host : 172.17.86.51
- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetsrx | Nombre de packets réseau reçus du host | - datacenter : pcc-37-187-228-180\_datacenter869,
- host : 172.17.86.51
- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | - -#### Machine Virtuelles - -| Métriques | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.vm.cpu.usage.perc | Utilisation processeur de la vm en pourcent | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | -| vscope.vm.mem.usage.perc | Utilisation mémoire de la vm en pourcent | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | -| vscope.vm.cpu.ready |CPU Ready de la vm en millisecond | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | -| vscope.vm.net.rx | Utilisation réseau de la vm en réception | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | -| vscope.vm.net.tx | Utilisation réseau de la vm en transmission | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | -| vscope.vm.net.packetsrx | Nombre de packets réseau reçus de la vm | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | -| vscope.vm.net.packetstx | Nombre de packets réseau transmis de la vm | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | -| vscope.vm.disk.io.read | Nombre d'IO en lecture par seconde de la vm | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | -| vscope.vm.disk.io.write | Nombre d'IO en écriture par seconde de la vm | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | -| vscope.vm.disk.bandwidth.read | Bande passante du disk de la vm en lecture | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | -| vscope.vm.disk.bandwidth.write | Bande passante du disk de la vm en écriture | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | -| vscope.vm.disk.latency.read | Latence du disque de la vm en lecture | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | -| vscope.vm.disk.latency.write | Latence du disque de la vm en écriture | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | - -#### Exemple de collecte en utilisant le protocol OpenTSDB - -Maintenant que vous avez récupéré votre token, votre endpoint, et que vous avez la liste des métriques, vous allez récupérer les données d'utilisation mémoire d'un host sur une période de 1 jour. - -Veuillez trouver ci-dessous un exemple de requête. - -``` -curl -XPOST https://read:XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX@opentsdb.gra1-ovh.metrics.ovh.net/api/query --d '{ - "start":1564407950, - "queries":[ - { - "metric":"vscope.host.mem.usage.perc", - "aggregator":"sum", - "downsample":"20m-max-zero", - "tags": { - "datacenter":"pcc-37-187-228-180_datacenter869", - "host":"172.17.86.51" - } - } - ] -}' -``` - -Explication des différents champs utilisés : - -- read : user utilisé pour effectuer la requête (sera toujours read); -- XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX : token précédemment récupéré via l'APIv6; -- opentsdb.gra1-ovh.metrics.ovh.net : endpoint OpenTSDB, également récupéré via l'APIv6. Ce endpoint peut varier selon votre localisation; -- start : timestamp correspondant à la date de début de la requête; -- queries : tableau contenant les metriques à récupérer. Plusieurs métriques peuvent être récupérées en une seule requête; -- metric : nom de la métrique à récupérer; -- aggregator : nom de la fonction d'agrégation (se reporter à la documentation OpenTSDB pour plus de détails); -- downsample : nom de la fonction d'échantillonnage (permet de réduire le nombre de donnée à récupérer. Paramètre optionnel); -- tags : liste des labels sous la forme clé / valeur; - -D'autres paramètres peuvent également être fournis. Veuillez vous reporter à la documentation de l'api OpenTSDB pour plus de détails. - -Vous aurez alors en retour un json avec le récapitulatif de la requête, ainsi que les timestamps associés à leur valeur dans le champ **dps**. -Exemple : - -```json -[ - { - "metric":"vscope.host.mem.usage.perc", - "tags":{ - "datacenter":"pcc-37-187-228-180_datacenter869", - "env":"prod", - "host":"172.17.86.51", - "servicename":"pcc-37-187-228-180", - "servicetype":"vscope" - }, - "query":{ - "index":0 - }, - "aggregateTags":[], - "dps":{ - "1564409391":4.38, - "1564410591":4.35, - "1564411791":4.37, - "1564412991":4.38, - "1564414191":4.35, - "1564415391":4.38, - "1564416591":4.35, - "1564417791":4.36, - "1564418991":4.36, - "1564420191":4.37, - "1564421391":4.37, - "1564422591":4.37, - "1564423791":4.37, - "1564424991":4.38, - "1564426191":4.36, - "1564427391":4.35, - "1564428591":4.37, - "1564429791":4.36, - "1564430991":4.38, - "1564432191":4.35, - "1564433391":4.37, - "1564434591":4.36, - "1564435791":4.37, - "1564436991":4.37, - "1564438191":4.37, - "1564439391":4.38, - "1564440591":4.36, - "1564441791":4.36, - "1564442991":4.37, - "1564444191":4.37, - "1564445391":4.35, - "1564446591":4.36, - "1564447791":4.36, - "1564448991":4.36, - "1564450191":4.35, - "1564451391":4.37, - "1564452591":4.37, - "1564453791":4.35, - "1564454991":4.36, - "1564456191":4.37, - "1564457391":4.37, - "1564458591":4.36, - "1564459791":4.37, - "1564460991":4.34, - "1564462191":4.36, - "1564463391":4.34, - "1564464591":4.37, - "1564465791":4.34, - "1564466991":4.37, - "1564468191":4.34, - "1564469391":4.36, - "1564470591":4.36, - "1564471791":4.36, - "1564472991":4.37, - "1564474191":4.37, - "1564475391":4.36, - "1564476591":4.35, - "1564477791":4.36, - "1564478991":4.35, - "1564480191":4.35, - "1564481391":4.37, - "1564482591":4.36, - "1564483791":4.34, - "1564484991":4.37, - "1564486191":4.38, - "1564487391":4.35, - "1564488591":4.34, - "1564489791":4.36, - "1564490991":4.35, - "1564492191":4.36, - "1564493391":4.36, - "1564494591":4.36 - } - } -] -``` - -Pour plus de détails sur les requêtes OpenTSDB, vous pouvez vous reporter à la documentation suivante : [OpenTSDB api query](http://opentsdb.net/docs/build/html/api_http/query/index.html) - -## Aller plus loin - -Échangez avec notre [communauté d'utilisateurs](/links/community). diff --git a/pages/bare_metal_cloud/managed_bare_metal/vscope-api/guide.it-it.md b/pages/bare_metal_cloud/managed_bare_metal/vscope-api/guide.it-it.md deleted file mode 100644 index 1f7e1f0cdc6..00000000000 --- a/pages/bare_metal_cloud/managed_bare_metal/vscope-api/guide.it-it.md +++ /dev/null @@ -1,263 +0,0 @@ ---- -title: Utilizzare l’API di vScope -excerpt: 'Come utilizzare i dati di monitoraggio nelle tue applicazioni tramite l’API vScope' -updated: 2020-11-18 ---- - -## Obiettivo - -Per ogni servizio Managed Bare Metal, OVHcloud mette a disposizione il tool **vScope**, uno strumento di monitoraggio per macchine virtuali e infrastrutture. - -È una pagina Web che contiene tutte le informazioni utili relative alle proprie risorse, disponibili anche via APIv6 e API Metrics. - -**Questa guida ti mostra come recuperare i valori monitorati via API.** - -## Prerequisiti - -- Un’[infrastruttura Managed Bare Metal](https://www.ovhcloud.com/it/managed-bare-metal/) -- Essere connesso all’interfaccia di gestione vScope - -## Procedura - -vScope mette a disposizione due tipi di informazioni: - -- **dati live**, relativi allo stato dei diversi componenti in un istante T -- grafici, che rappresentano lo storico delle prestazioni dei diversi componenti (ad esempio, CPU e RAM di una macchina virtuale) - -### Raccogli i dati live - -I dati live sono disponibili nella pagina principale dell’interfaccia vScope. - -![vScope-API](images/vScope1.png){.thumbnail} - -Queste informazioni sono relative ai seguenti componenti: - -- filer -- host -- macchine virtuali - -Per recuperarle tramite APIv6 è necessario eseguire queste tre chiamate: - -#### Filer - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/filer/{filerId} -> - -#### Host - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host/{hostId} -> - -#### Macchine virtuali - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/vm/{vmId} -> - -### Ottieni lo storico dei dati (Graphs) - -Per effettuare questa operazione è possibile utilizzare il servizio **Metrics Data Platforms**: grazie ai protocolli Opentsdb e WARP10 i dati possono essere recuperati sotto forma di punti utilizzabili tramite applicazione o visualizzabili direttamente con il rendering desiderato. - -La procedura descritta in questa guida è relativa all’utilizzo del protocollo Opentsdb per la visualizzazione grezza dei dati acquisiti, senza rappresentazione grafica. - -Per accedere al servizio **Metrics Data Platforms** è necessario disporre di un token di lettura: la nuova versione di vScope, infatti, ne prevede uno per ogni utilizzatore dell’infrastruttura. - -Per recuperare il codice di un utente specifico, effettua questa chiamata APIv6: - -> [!api] -> -> @api {v1} /dedicatedCloud POST /dedicatedCloud/{serviceName}/user/{userId}/metricsToken -> - -L’informazione richiesta viene mostrata nel campo **token** del risultato. - -```json -{ - "warpEndpoint": "https://warp10.gra1-ovh.metrics.ovh.net", - "token": "XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX", - "opentsdbEndpoint": "https://opentsdb.gra1-ovh.metrics.ovh.net" -} -``` - -Per ogni tipo di componente è disponibile una lista di metriche, che richiede un numero di parametri (detti label) molto preciso. - -#### Filer - -| Metriche | Descrizione | Label | -| ----------- | ----------- | ----------- | -| vscope.filer.datastore.diskspace.used | Utilizzo del filer in kB | datacenter: pcc-37-187-228-180_datacenter869,
datastore: pcc-000443 | - -#### Host - -| Metriche | Descrizione | Label | -| ----------- | ----------- | ----------- | -| vscope.host.cpu.usage.perc | Percentuale di utilizzo del processore dell’host | \- datacenter: pcc-37-187-228-180_datacenter869,
\- host: 172.17.86.51 | -| vscope.host.mem.usage.perc | Percentuale di utilizzo della memoria dell’host | \- datacenter: pcc-37-187-228-180_datacenter869,
\- host: 172.17.86.51 | -| vscope.host.net.tx | Utilizzo della rete dell’host in uscita | \- datacenter: pcc-37-187-228-180_datacenter869,
\- host: 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.rx | Utilizzo della rete dell’host in entrata | \- datacenter: pcc-37-187-228-180_datacenter869,
\- host: 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetstx | Numero di pacchetti di rete trasmessi dall’host | \- datacenter: pcc-37-187-228-180_datacenter869,
\- host: 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetsrx | Numero di pacchetti di rete ricevuti dall’host | \- datacenter: pcc-37-187-228-180_datacenter869,
\- host: 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | - -#### Macchine Virtuali - -| Metriche | Descrizione | Label | -| ----------- | ----------- | ----------- | -| vscope.vm.cpu.usage.perc | Percentuale di utilizzo del processore della VM | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.mem.usage.perc | Percentuale di utilizzo della memoria dell’host | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.cpu.ready |CPU Ready della VM in millisecondi | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.net.rx | Utilizzo della rete della VM in ricezione | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.net.tx | Utilizzo della rete della VM in trasmissione | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.net.packetsrx | Numero di pacchetti di rete ricevuti dalla VM | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.net.packetstx | Numero di pacchetti di rete trasmessi dalla VM | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.disk.io.read | Numero di IOPS della VM in lettura | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.disk.io.write | Numero di IOPS della VM in scrittura | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.disk.bandwidth.read | Banda passante del disco della VM in lettura | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.disk.bandwidth.write | Banda passante del disco della VM in scrittura | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.disk.latency.read | Latenza del disco della VM in lettura | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.disk.latency.write | Latenza del disco della VM in scrittura | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | - -#### Esempio di raccolta con il protocollo OpenTSDB - -Una volta recuperati il token, l’endpoint e la lista delle metriche è possibile estrarre, ad esempio, i dati relativi all’utilizzo della memoria di un host su base giornaliera. - -La richiesta sarà di questo tipo: - -``` -curl -XPOST https://read:XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX@opentsdb.gra1-ovh.metrics.ovh.net/api/query --d '{ - "start":1564407950, - "queries":[ - { - "metric":"vscope.host.mem.usage.perc", - "aggregator":"sum", - "downsample":"20m-max-zero", - "tags": { - "datacenter":"pcc-37-187-228-180_datacenter869", - "host":"172.17.86.51" - } - } - ] -}' -``` - -Ecco la descrizione dei campi impiegati: - -- read: user utilizzato per effettuare la richiesta (sarà sempre “read”) -- XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX: token recuperato precedentemente via APIv6 -- opentsdb.gra1-ovh.metrics.ovh.net: endpoint OpenTSDB, anch’esso recuperato via APIv6. Questo endpoint può variare in base alla localizzazione. -- start: timestamp corrispondente alla data di inizio della richiesta -- queries: tabella con le metriche da recuperare (con una sola richiesta è possibile recuperare più metriche) -- metric: nome della metrica da recuperare -- aggregator: nome della fuzione di aggregazione (per maggiori dettagli, consulta la documentazione ufficiale OpenTSDB) -- downsample: nome della funzione di campionamento (parametro opzionale che permette di ridurre il numero di dati da recuperare) -- tags: lista dei label in formato chiave/valore - -Questa lista di parametri non è esaustiva e, oltre a quelli indicati, ne sono disponibili altri. Per maggiori informazioni, consulta la documentazione ufficiale dell’API OpenTSDB. - -Il risultato restituito sarà un file json con il riepilogo della richiesta e, nei campi **dps**, i timestamp associati ai diversi valori. -Esempio: - -```json -[ - { - "metric":"vscope.host.mem.usage.perc", - "tags":{ - "datacenter":"pcc-37-187-228-180_datacenter869", - "env":"prod", - "host":"172.17.86.51", - "servicename":"pcc-37-187-228-180", - "servicetype":"vscope" - }, - "query":{ - "index":0 - }, - "aggregateTags":[], - "dps":{ - "1564409391":4.38, - "1564410591":4.35, - "1564411791":4.37, - "1564412991":4.38, - "1564414191":4.35, - "1564415391":4.38, - "1564416591":4.35, - "1564417791":4.36, - "1564418991":4.36, - "1564420191":4.37, - "1564421391":4.37, - "1564422591":4.37, - "1564423791":4.37, - "1564424991":4.38, - "1564426191":4.36, - "1564427391":4.35, - "1564428591":4.37, - "1564429791":4.36, - "1564430991":4.38, - "1564432191":4.35, - "1564433391":4.37, - "1564434591":4.36, - "1564435791":4.37, - "1564436991":4.37, - "1564438191":4.37, - "1564439391":4.38, - "1564440591":4.36, - "1564441791":4.36, - "1564442991":4.37, - "1564444191":4.37, - "1564445391":4.35, - "1564446591":4.36, - "1564447791":4.36, - "1564448991":4.36, - "1564450191":4.35, - "1564451391":4.37, - "1564452591":4.37, - "1564453791":4.35, - "1564454991":4.36, - "1564456191":4.37, - "1564457391":4.37, - "1564458591":4.36, - "1564459791":4.37, - "1564460991":4.34, - "1564462191":4.36, - "1564463391":4.34, - "1564464591":4.37, - "1564465791":4.34, - "1564466991":4.37, - "1564468191":4.34, - "1564469391":4.36, - "1564470591":4.36, - "1564471791":4.36, - "1564472991":4.37, - "1564474191":4.37, - "1564475391":4.36, - "1564476591":4.35, - "1564477791":4.36, - "1564478991":4.35, - "1564480191":4.35, - "1564481391":4.37, - "1564482591":4.36, - "1564483791":4.34, - "1564484991":4.37, - "1564486191":4.38, - "1564487391":4.35, - "1564488591":4.34, - "1564489791":4.36, - "1564490991":4.35, - "1564492191":4.36, - "1564493391":4.36, - "1564494591":4.36 - } - } -] -``` - -Per maggiori informazioni sulle richieste OpenTSDB, consulta la documentazione disponibile alla pagina [OpenTSDB api query](http://opentsdb.net/docs/build/html/api_http/query/index.html) - -## Per saperne di più - -Contatta la nostra Community di utenti all’indirizzo . - diff --git a/pages/bare_metal_cloud/managed_bare_metal/vscope-api/guide.pl-pl.md b/pages/bare_metal_cloud/managed_bare_metal/vscope-api/guide.pl-pl.md deleted file mode 100644 index d3eee55ad47..00000000000 --- a/pages/bare_metal_cloud/managed_bare_metal/vscope-api/guide.pl-pl.md +++ /dev/null @@ -1,266 +0,0 @@ ---- -title: 'Jak korzystać z API vScope' -excerpt: 'API vScope pozwala wykorzystywać dane z monitorowania zasobów w aplikacjach' -updated: 2020-11-18 ---- - -## Wprowadzenie - -OVHcloud udostępnia narzędzie **vScope** do nadzoru i monitorowania wirtualnych maszyn i infrastruktury. - -Jest to strona internetowa, na której zebrane są wszelkie użyteczne informacje dotyczące wykorzystania Twoich zasobów. - -Informacje te są dostępne także poprzez APIv6 i API Metrics. - -**Niniejszy przewodnik opisuje sposób korzystania z tych API**. - -## Wymagania początkowe - -- [Infrastructure Managed Bare Metal](https://www.ovhcloud.com/pl/managed-bare-metal/) -- Dostęp do interfejsu zarządzania vScope - -## W praktyce - -vScope udostępnia dwa rodzaje informacji: - -- informacje**w czasie rzeczywistym**, które odpowiadają danym z różnych elementów w danej chwili. -- wykresy przedstawiające dane historyczne dotyczące wydajności poszczególnych elementów, Przykład: procesora lub pamięci RAM maszyny wirtualnej. - -### Zbieranie danych**w czasie rzeczywistym** - -Dane **w czasie rzeczywistym** są dostępne z poziomu strony głównej interfejsu vScope. - -![vScope-API](images/vScope1.png){.thumbnail} - -Możesz przeglądać dane**w czasie rzeczywistym** dotyczące następujących elementów: - -- serwery plików, -- hosty, -- maszyny wirtualne. - -Z API można korzystać dzięki następujących trzem wywołaniom APIv6: - -#### Serwery plików - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/filer/{filerId} -> - -#### Hosty - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host/{hostId} -> - -#### Maszyny wirtualne - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/vm/{vmId} -> - -### Zbieranie danych historycznych (wykresy) - -Do zbierania i wykorzystywania danych historycznych (wykresy) wykorzystujemy produkt **Metrics Data Platforms**. - -Możesz zbierać dane w formie kropek za pośrednictwem protokołów Opentsdb lub WARP10. Kropki można wykorzystywać w aplikacji lub też wyświetlać je bezpośrednio w zależności od oczekiwanego rezultatu. - -Niniejszy artykuł przedstawia wykorzystanie protokołu Opentsdb do nieuporządkowanego wyświetlania danych (bez formy graficznej). - -Aby móc korzystać z narzędzia **Metrics Data Platforms**, musisz najpierw uzyskać token odczytu. W nowej wersji vScope każdy użytkownik infrastruktury otrzymuje taki token. - -Aby uzyskać token odczytu dla danego użytkownika, należy użyć następującego wywołania przez APIv6: - -> [!api] -> -> @api {v1} /dedicatedCloud POST /dedicatedCloud/{serviceName}/user/{userId}/metricsToken -> - -Twój token znajduje się w polu wyników**token**. - -```json -{ - "warpEndpoint": "https://warp10.gra1-ovh.metrics.ovh.net", - "token": "XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX", - "opentsdbEndpoint": "https://opentsdb.gra1-ovh.metrics.ovh.net" -} -``` - -Dla każdego rodzaju elementu dostępna jest lista statusów (zwanych również etykietami) wymagająca bardzo precyzyjnych parametrów. - -#### Serwery plików (Filers) - -| Statusy (Metrics) | Opis (Description) | Etykiety (Labels) | -| ----------- | ----------- | ----------- | -| vscope.filer.datastore.diskspace.used | Wykorzystanie serwera plików w kB | datacenter : pcc-37-187-228-180_datacenter869,
datastore : pcc-000443 | - -#### Hosty - -| Statusy (Metrics) | Opis (Description) | Etykiety (Labels) | -| ----------- | ----------- | ----------- | -| vscope.host.cpu.usage.perc | Wykorzystanie procentowe procesora hosta | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51 | -| vscope.host.mem.usage.perc | Wyrażone procentowo wykorzystanie pamięci hosta | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51 | -| vscope.host.net.tx | Wykorzystanie sieci hosta podczas przesyłania | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.rx | Wykorzystanie sieci hosta podczas odbioru | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetstx | Liczba pakietów sieciowych przesłanych przez hosta | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetsrx | Liczba pakietów sieciowych odebranych przez hosta | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | - -#### Maszyny wirtualne - -| Statusy (Metrics) | Opis (Description) | Etykiety (Labels) | -| ----------- | ----------- | ----------- | -| vscope.vm.cpu.usage.perc | Wykorzystanie procentowe procesora maszyny wirtualnej | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.mem.usage.perc | Wykorzystanie procentowe pamięci maszyny wirtualnej | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.cpu.ready |Status CPU Ready serwera wirtualnego w milisekundach | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.rx | Wykorzystanie sieci serwera wirtualnego podczas odbioru | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.tx | Wykorzystanie sieci serwera wirtualnego podczas przesyłania | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.packetsrx | Liczba pakietów sieciowych odebranych przez maszynę wirtualną | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.packetstx | Liczba pakietów sieciowych przesłanych przez maszynę wirtualną | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.io.read | Liczba operacji wejścia/wyjścia na sekundę przy odczycie dla maszyny wirtualnej | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.io.write | Liczba operacji wejścia/wyjścia na sekundę przy zapisie dla maszyny wirtualnej | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.bandwidth.read | Przepustowość dysku maszyny wirtualnej w trybie odczytu | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.bandwidth.write | Przepustowość dysku maszyny wirtualnej w trybie zapisu | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.latency.read | Opóźnienie dysku maszyny wirtualnej podczas odczytu | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.latency.write | Opóźnienie dysku maszyny wirtualnej podczas zapisu | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | - -#### Przykład zbierania danych z wykorzystaniem protokołu OpenTSDB - -Teraz, kiedy już uzyskałeś swój token (endpoint) i dysponujesz listą statusów, możesz pozyskać dane dotyczące wykorzystania pamięci hosta w okresie 1 dnia. - -Poniżej znajdziesz przykładowe zapytanie. - -``` -curl -XPOST https://read:XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX@opentsdb.gra1-ovh.metrics.ovh.net/api/query --d '{ - "start":1564407950, - "queries":[ - { - "metric":"vscope.host.mem.usage.perc", - "aggregator":"sum", - "downsample":"20m-max-zero", - "tags": { - "datacenter":"pcc-37-187-228-180_datacenter869", - "host":"172.17.86.51" - } - } - ] -}' -``` - -Wyjaśnienie różnych wykorzystanych pól: - -- read: użytkownik służący do przeprowadzenia zapytania (będzie mieć zawsze status read); -- XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX : token pozyskany uprzednio przez APIv6; -- opentsdb.gra1-ovh.metrics.ovh.net: endpoint OpenTSDB, również uzyskiwany przez APIv6. Ten endpoint może różnić się w zależności od Twojej lokalizacji; -- start: znacznik czasowy odpowiadający dacie rozpoczęcia zapytania; -- queries: tabela zawierająca statusy do pozyskania. Za pomocą pojedynczego zapytania można uzyskać wiele statusów; -- metric: nazwa statusu do uzyskania; -- aggregator: nazwa funkcji agregacji (zapoznaj się z dokumentacją OpenTSDB, aby uzyskać więcej szczegółów); -- downsample: nazwa funkcji próbkowania (pozwala zmniejszyć ilość danych do pozyskania. Parametr opcjonalny); -- tags: lista etykiet w formie klucza / wartości; - -Można uzyskać też inne parametry. Zapoznaj się z dokumentacją API OpenTSDB, by uzyskać więcej szczegółów. - -Otrzymasz wówczas plik json z podsumowaniem zapytania, a także znaczniki czasowe powiązane z wartościami w polu **dps**. -Przykład: - -```json -[ - { - "metric":"vscope.host.mem.usage.perc", - "tags":{ - "datacenter":"pcc-37-187-228-180_datacenter869", - "env":"prod", - "host":"172.17.86.51", - "servicename":"pcc-37-187-228-180", - "servicetype":"vscope" - }, - "query":{ - "index":0 - }, - "aggregateTags":[], - "dps":{ - "1564409391":4.38, - "1564410591":4.35, - "1564411791":4.37, - "1564412991":4.38, - "1564414191":4.35, - "1564415391":4.38, - "1564416591":4.35, - "1564417791":4.36, - "1564418991":4.36, - "1564420191":4.37, - "1564421391":4.37, - "1564422591":4.37, - "1564423791":4.37, - "1564424991":4.38, - "1564426191":4.36, - "1564427391":4.35, - "1564428591":4.37, - "1564429791":4.36, - "1564430991":4.38, - "1564432191":4.35, - "1564433391":4.37, - "1564434591":4.36, - "1564435791":4.37, - "1564436991":4.37, - "1564438191":4.37, - "1564439391":4.38, - "1564440591":4.36, - "1564441791":4.36, - "1564442991":4.37, - "1564444191":4.37, - "1564445391":4.35, - "1564446591":4.36, - "1564447791":4.36, - "1564448991":4.36, - "1564450191":4.35, - "1564451391":4.37, - "1564452591":4.37, - "1564453791":4.35, - "1564454991":4.36, - "1564456191":4.37, - "1564457391":4.37, - "1564458591":4.36, - "1564459791":4.37, - "1564460991":4.34, - "1564462191":4.36, - "1564463391":4.34, - "1564464591":4.37, - "1564465791":4.34, - "1564466991":4.37, - "1564468191":4.34, - "1564469391":4.36, - "1564470591":4.36, - "1564471791":4.36, - "1564472991":4.37, - "1564474191":4.37, - "1564475391":4.36, - "1564476591":4.35, - "1564477791":4.36, - "1564478991":4.35, - "1564480191":4.35, - "1564481391":4.37, - "1564482591":4.36, - "1564483791":4.34, - "1564484991":4.37, - "1564486191":4.38, - "1564487391":4.35, - "1564488591":4.34, - "1564489791":4.36, - "1564490991":4.35, - "1564492191":4.36, - "1564493391":4.36, - "1564494591":4.36 - } - } -] -``` - -Więcej informacji na temat zapytań OpenTSDB znajdziesz w dokumentacji: [OpenTSDB api query](http://opentsdb.net/docs/build/html/api_http/query/index.html) - -## Sprawdź również - -Dołącz do społeczności naszych użytkowników na stronie. diff --git a/pages/bare_metal_cloud/managed_bare_metal/vscope-api/guide.pt-pt.md b/pages/bare_metal_cloud/managed_bare_metal/vscope-api/guide.pt-pt.md deleted file mode 100644 index 4def882ff66..00000000000 --- a/pages/bare_metal_cloud/managed_bare_metal/vscope-api/guide.pt-pt.md +++ /dev/null @@ -1,266 +0,0 @@ ---- -title: 'Como utilizar a API de vScope' -excerpt: 'A API vScope permite-lhe utilizar os dados de monitorização nas suas aplicações' -updated: 2020-11-18 ---- - -## Sumário - -A OVHcloud coloca à sua disposição uma ferramenta de supervisão e monitorização das suas máquinas virtuais e da sua infraestrutura, designada por **vScope**. - -Trata-se de uma página Internet onde estão reunidas todas as informações úteis relativas à utilização dos seus recursos. - -Estas informações encontram-se também disponíveis através da APIv6 e da API Metrics. - -**Este guia descreve a utilização destas APIs**. - -## Requisitos - -- Uma [infraestrutura Managed Bare Metal](https://www.ovhcloud.com/pt/managed-bare-metal/) -- Ter acesso à interface de gestão vScope - -## Instruções - -A ferramenta vScope disponibiliza dois tipos de informações: - -- informações **live**, que correspondem aos dados dos vários componentes num determinado instante T; -- gráficos que apresentam os dados históricos de desempenho dos vários componentes. Por exemplo: CPU, RAM de uma máquina virtual. - -### Recolher os dados **live** - -Os dados **live** são os dados disponíveis a partir da página principal da interface vScope. - -![vScope-API](images/vScope1.png){.thumbnail} - -Pode recuperar estes dados **live** para os seguintes componentes: - -- filers -- hosts -- virtual machines - -A utilização da API faz-se através destas três chamadas APIv6: - -#### Filers - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/filer/{filerId} -> - -#### Hosts - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host/{hostId} -> - -#### Máquinas virtuais - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/vm/{vmId} -> - -### Recolher os dados históricos (Graphs) - -Para recolher e utilizar os dados históricos (Graphs), usamos o produto **Metrics Data Platforms**. - -Através dos protocolos Opentsdb ou WARP10, vai poder recuperar os seus dados sob a forma de pontos. Poderá explorar estes pontos através da sua aplicação ou apresentá-los diretamente em função do resultado pretendido. - -Este artigo diz respeito à utilização do protocolo Opentsdb para uma apresentação bruta dos dados (sem resultado gráfico). - -Para poder utilizar **Metrics Data Platforms**, terá de obter um token de leitura. Com a nova versão do vScope, cada utilizador da infraestrutura tem um token de leitura. - -Para o utilizador pretendido, utilize a chamada APIv6 seguinte para recuperar o token de leitura: - -> [!api] -> -> @api {v1} /dedicatedCloud POST /dedicatedCloud/{serviceName}/user/{userId}/metricsToken -> - -O seu token encontra-se no campo **token** do resultado. - -```json -{ - "warpEndpoint": "https://warp10.gra1-ovh.metrics.ovh.net", - "token": "XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX", - "opentsdbEndpoint": "https://opentsdb.gra1-ovh.metrics.ovh.net" -} -``` - -Para cada tipo de componente, está disponível uma lista de métricas que precisa de um conjunto de parâmetros (também chamado "etiquetas") muito precisos. - -#### Filers - -| Métricas | Descrição | Etiquetas | -| ----------- | ----------- | ----------- | -| vscope.filer.datastore.diskspace.used | Utilização do filer em kB | datacenter : pcc-37-187-228-180_datacenter869,
datastore: pcc-000443 | - -#### Hosts - -| Métricas | Descrição | Etiquetas | -| ----------- | ----------- | ----------- | -| vscope.host.cpu.usage.perc | Utilização do processador do host em percentagem | \- datacenter: pcc-37-187-228-180_datacenter869,
\- host: 172.17.86.51 | -| vscope.host.mem.usage.perc | Utilização da memória do host em percentagem | \- datacenter: pcc-37-187-228-180_datacenter869,
\- host: 172.17.86.51 | -| vscope.host.net.tx | Utilização da rede do host em emissão | \- datacenter: pcc-37-187-228-180_datacenter869,
\- host: 172.17.86.51
\- nicname: vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.rx | Utilização da rede do host em receção | \- datacenter: pcc-37-187-228-180_datacenter869,
\- host: 172.17.86.51
\- nicname: vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetstx | Número de packs de rede transmitidos do host | \- datacenter: pcc-37-187-228-180_datacenter869,
\- host: 172.17.86.51
\- nicname: vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetsrx | Número de packs de rede recebidos do host | \- datacenter: pcc-37-187-228-180_datacenter869,
\- host: 172.17.86.51
\- nicname: vmnic0/vmnic1/vmnic2/vmnic3 | - -#### Máquinas virtuais - -| Métricas | Descrição | Etiquetas | -| ----------- | ----------- | ----------- | -| vscope.vm.cpu.usage.perc | Utilização do processador da vm em percentagem | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.mem.usage.perc | Utilização da memória da vm em percentagem | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.cpu.ready |CPU Ready da vm em milissegundos | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.net.rx | Utilização da rede da vm em receção | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.net.tx | Utilização da rede da vm em transmissão | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.net.packetsrx | Número de packs de rede recebidos da vm | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.net.packetstx | Número de packs de rede transmitidos da vm | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.disk.io.read | Número de IO em leitura por segundo da vm | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.disk.io.write | Número de IO em escrita por segundo da vm | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.disk.bandwidth.read | Largura de banda do disco da vm em leitura | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.disk.bandwidth.write | Largura de banda do disco da vm em escrita | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.disk.latency.read | Latência do disco da vm em leitura | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.disk.latency.write | Latência do disco da vm em escrita | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | - -#### Exemplo de recolha com a utilização do protocolo OpenTSDB - -Agora que recuperou o seu token, o seu endpoint e que tem a lista das métricas, vai recuperar os dados de utilização da memória de um host ao longo de 1 dia. - -Em seguida, encontre um exemplo de pedido. - -``` -curl -XPOST https://read:XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX@opentsdb.gra1-ovh.metrics.ovh.net/api/query --d '{ - "start":1564407950, - "queries":[ - { - "metric":"vscope.host.mem.usage.perc", - "aggregator":"sum", - "downsample":"20m-max-zero", - "tags": { - "datacenter":"pcc-37-187-228-180_datacenter869", - "host":"172.17.86.51" - } - } - ] -}' -``` - -Explicação dos vários campos utilizados: - -- read: utilizador utilizado para realizar o pedido (será sempre read); -- XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX: token anteriormente recuperado com a APIv6; -- opentsdb.gra1-ovh.metrics.ovh.net: endpoint OpenTSDB, também recuperado com a APIv6. Este endpoint pode variar em função da sua localização; -- start: carimbo de hora correspondente à data de início do pedido; -- queries: quadro com as métricas a recuperar. Várias métricas podem ser recuperadas num único pedido; -- métrica: nome da métrica a recuperar; -- agregador: nome da função de agregação (consultar a documentação OpenTSDB para mais pormenores); -- downsample: nome da função de escalonagem (permite reduzir a quantidade de dados a recuperar. Parâmetro opcional); -- tags: lista das etiquetas sob a forma de chave/valor; - -Podem também ser fornecidos outros parâmetros. Consulte a documentação da api OpenTSDB para mais pormenores. - -Receberá então um json com o resumo do pedido, bem como os carimbos de hora associados ao respetivo valor no campo **dps**. -Por exemplo: - -```json -[ - { - "metric":"vscope.host.mem.usage.perc", - "tags":{ - "datacenter":"pcc-37-187-228-180_datacenter869", - "env":"prod", - "host":"172.17.86.51", - "servicename":"pcc-37-187-228-180", - "servicetype":"vscope" - }, - "query":{ - "index":0 - }, - "aggregateTags":[], - "dps":{ - "1564409391":4.38, - "1564410591":4.35, - "1564411791":4.37, - "1564412991":4.38, - "1564414191":4.35, - "1564415391":4.38, - "1564416591":4.35, - "1564417791":4.36, - "1564418991":4.36, - "1564420191":4.37, - "1564421391":4.37, - "1564422591":4.37, - "1564423791":4.37, - "1564424991":4.38, - "1564426191":4.36, - "1564427391":4.35, - "1564428591":4.37, - "1564429791":4.36, - "1564430991":4.38, - "1564432191":4.35, - "1564433391":4.37, - "1564434591":4.36, - "1564435791":4.37, - "1564436991":4.37, - "1564438191":4.37, - "1564439391":4.38, - "1564440591":4.36, - "1564441791":4.36, - "1564442991":4.37, - "1564444191":4.37, - "1564445391":4.35, - "1564446591":4.36, - "1564447791":4.36, - "1564448991":4.36, - "1564450191":4.35, - "1564451391":4.37, - "1564452591":4.37, - "1564453791":4.35, - "1564454991":4.36, - "1564456191":4.37, - "1564457391":4.37, - "1564458591":4.36, - "1564459791":4.37, - "1564460991":4.34, - "1564462191":4.36, - "1564463391":4.34, - "1564464591":4.37, - "1564465791":4.34, - "1564466991":4.37, - "1564468191":4.34, - "1564469391":4.36, - "1564470591":4.36, - "1564471791":4.36, - "1564472991":4.37, - "1564474191":4.37, - "1564475391":4.36, - "1564476591":4.35, - "1564477791":4.36, - "1564478991":4.35, - "1564480191":4.35, - "1564481391":4.37, - "1564482591":4.36, - "1564483791":4.34, - "1564484991":4.37, - "1564486191":4.38, - "1564487391":4.35, - "1564488591":4.34, - "1564489791":4.36, - "1564490991":4.35, - "1564492191":4.36, - "1564493391":4.36, - "1564494591":4.36 - } - } -] -``` - -Para mais pormenores sobre os pedidos OpenTSDB, pode consultar a seguinte documentação: [OpenTSDB api query](http://opentsdb.net/docs/build/html/api_http/query/index.html) - -## Quer saber mais? - -Fale com a nossa comunidade de utilizadores em . diff --git a/pages/bare_metal_cloud/managed_bare_metal/vscope-api/images/vScope1.png b/pages/bare_metal_cloud/managed_bare_metal/vscope-api/images/vScope1.png deleted file mode 100644 index 92b2a1bdb7f..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/vscope-api/images/vScope1.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/vscope-api/meta.yaml b/pages/bare_metal_cloud/managed_bare_metal/vscope-api/meta.yaml deleted file mode 100755 index a441bd1358b..00000000000 --- a/pages/bare_metal_cloud/managed_bare_metal/vscope-api/meta.yaml +++ /dev/null @@ -1,2 +0,0 @@ -id: cd467103-c04a-4492-a6e6-3c377a778023 -full_slug: managed-bare-metal-vscope-api \ No newline at end of file diff --git a/pages/bare_metal_cloud/managed_bare_metal/vsphere-interface/guide.de-de.md b/pages/bare_metal_cloud/managed_bare_metal/vsphere-interface/guide.de-de.md index db517eb7750..96a71d7d989 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vsphere-interface/guide.de-de.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vsphere-interface/guide.de-de.md @@ -23,7 +23,7 @@ Die Kennungen werden während der Erstellung der Public Cloud per E-Mail versand IP-Adresse/Name: pcc-xxx-xxx-xxx-xxx.ovh.com Nutzername: admin Passwort: xxxxxx ``` -Dieses Dokument von VMware führt die verschiedenen Ports auf, die Sie in Ihrer Firewall öffnen müssen, um z.B. Zugriff auf die Konsole zu haben: [Zugang zur Konsole](https://kb.vmware.com/s/article/1012382?lang=de){.external-link} +Dieses Dokument von VMware führt die verschiedenen Ports auf, die Sie in Ihrer Firewall öffnen müssen, um z.B. Zugriff auf die Konsole zu haben: [Zugang zur Konsole](https://kb.vmware.com/s/article/1012382?lang=de) ### Verwendung des Webclients HTML5 diff --git a/pages/bare_metal_cloud/managed_bare_metal/vsphere-interface/guide.es-es.md b/pages/bare_metal_cloud/managed_bare_metal/vsphere-interface/guide.es-es.md index fc8b885b425..529e30d44f6 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vsphere-interface/guide.es-es.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vsphere-interface/guide.es-es.md @@ -23,7 +23,7 @@ Las claves de acceso se envían por correo electrónico al activar un servicio H Dirección IP/Nombre: pcc-xxx-xxx-xxx-xxx.ovh.com Nombre de usuario: admin Contraseña: xxxxxx ``` -El siguiente documento de VMware incluye los diferentes puertos que debe abrir en su firewall para, por ejemplo, acceder a la consola: [Acceso a la consola](https://kb.vmware.com/kb/1012382){.external-link}. +El siguiente documento de VMware incluye los diferentes puertos que debe abrir en su firewall para, por ejemplo, acceder a la consola: [Acceso a la consola](https://kb.vmware.com/kb/1012382). ### Utilizar el cliente web HTML5 diff --git a/pages/bare_metal_cloud/managed_bare_metal/vsphere-interface/guide.es-us.md b/pages/bare_metal_cloud/managed_bare_metal/vsphere-interface/guide.es-us.md index fc8b885b425..529e30d44f6 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vsphere-interface/guide.es-us.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vsphere-interface/guide.es-us.md @@ -23,7 +23,7 @@ Las claves de acceso se envían por correo electrónico al activar un servicio H Dirección IP/Nombre: pcc-xxx-xxx-xxx-xxx.ovh.com Nombre de usuario: admin Contraseña: xxxxxx ``` -El siguiente documento de VMware incluye los diferentes puertos que debe abrir en su firewall para, por ejemplo, acceder a la consola: [Acceso a la consola](https://kb.vmware.com/kb/1012382){.external-link}. +El siguiente documento de VMware incluye los diferentes puertos que debe abrir en su firewall para, por ejemplo, acceder a la consola: [Acceso a la consola](https://kb.vmware.com/kb/1012382). ### Utilizar el cliente web HTML5 diff --git a/pages/bare_metal_cloud/managed_bare_metal/vsphere-interface/guide.fr-ca.md b/pages/bare_metal_cloud/managed_bare_metal/vsphere-interface/guide.fr-ca.md index 09996d9f514..18d7d3b239d 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vsphere-interface/guide.fr-ca.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vsphere-interface/guide.fr-ca.md @@ -23,7 +23,7 @@ Les identifiants sont envoyés par e-mail durant la création du Managed Bare Me adresse IP/Nom : pcc-xxx-xxx-xxx-xxx.ovh.com nom d’utilisateur : admin mot de passe : xxxxxx ``` -Ce document de VMware répertorie les différents ports que vous devez ouvrir sur votre pare-feu pour, par exemple, accéder à la console : [Accès console](https://kb.vmware.com/kb/1012382){.external-link} +Ce document de VMware répertorie les différents ports que vous devez ouvrir sur votre pare-feu pour, par exemple, accéder à la console : [Accès console](https://kb.vmware.com/kb/1012382) ### Utilisation du web client HTML5 diff --git a/pages/bare_metal_cloud/managed_bare_metal/vsphere-interface/guide.fr-fr.md b/pages/bare_metal_cloud/managed_bare_metal/vsphere-interface/guide.fr-fr.md index 09996d9f514..18d7d3b239d 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vsphere-interface/guide.fr-fr.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vsphere-interface/guide.fr-fr.md @@ -23,7 +23,7 @@ Les identifiants sont envoyés par e-mail durant la création du Managed Bare Me adresse IP/Nom : pcc-xxx-xxx-xxx-xxx.ovh.com nom d’utilisateur : admin mot de passe : xxxxxx ``` -Ce document de VMware répertorie les différents ports que vous devez ouvrir sur votre pare-feu pour, par exemple, accéder à la console : [Accès console](https://kb.vmware.com/kb/1012382){.external-link} +Ce document de VMware répertorie les différents ports que vous devez ouvrir sur votre pare-feu pour, par exemple, accéder à la console : [Accès console](https://kb.vmware.com/kb/1012382) ### Utilisation du web client HTML5 diff --git a/pages/bare_metal_cloud/managed_bare_metal/vsphere-interface/guide.it-it.md b/pages/bare_metal_cloud/managed_bare_metal/vsphere-interface/guide.it-it.md index aaf8f5106ee..f5fbc1c51fe 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vsphere-interface/guide.it-it.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vsphere-interface/guide.it-it.md @@ -23,7 +23,7 @@ Le credenziali di accesso vengono inviate via email durante la creazione di un s Indirizzo IP/Nome: pcc-xxx-xxx-xxx-xxx.ovh.com Nome utente: admin Password: xxxxxx ``` -Per assicurarsi di poter effettuare l’accesso, consulta la documentazione VMware in cui sono elencate le diverse porte da aprire nel firewall: [Accesso al terminale](https://kb.vmware.com/kb/1012382){.external-link} +Per assicurarsi di poter effettuare l’accesso, consulta la documentazione VMware in cui sono elencate le diverse porte da aprire nel firewall: [Accesso al terminale](https://kb.vmware.com/kb/1012382) ### Utilizza il client Web HTML5 diff --git a/pages/bare_metal_cloud/managed_bare_metal/vsphere-interface/guide.pt-pt.md b/pages/bare_metal_cloud/managed_bare_metal/vsphere-interface/guide.pt-pt.md index 61828d752a9..6e9bd8e1e5d 100644 --- a/pages/bare_metal_cloud/managed_bare_metal/vsphere-interface/guide.pt-pt.md +++ b/pages/bare_metal_cloud/managed_bare_metal/vsphere-interface/guide.pt-pt.md @@ -23,7 +23,7 @@ As credenciais são enviadas por e-mail durante a criação do Hosted Managed Ba endereço IP/Nome: pcc-xxx-xxx-xxx-xxx.ovh.com nome de utilizador: admin palavra-passe: xxxxxx ``` -Este documento da VMware especifica as diferentes portas que deve abrir na sua firewall para, por exemplo, aceder à consola: [Acesso consola](https://kb.vmware.com/kb/1012382){.external-link} +Este documento da VMware especifica as diferentes portas que deve abrir na sua firewall para, por exemplo, aceder à consola: [Acesso consola](https://kb.vmware.com/kb/1012382) ### Utilização do web client HTML5 diff --git a/pages/bare_metal_cloud/managed_bare_metal/vsphere-interface/images/connexion_client_l2.png b/pages/bare_metal_cloud/managed_bare_metal/vsphere-interface/images/connexion_client_l2.png deleted file mode 100644 index 19ebc86113a..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/vsphere-interface/images/connexion_client_l2.png and /dev/null differ diff --git a/pages/bare_metal_cloud/managed_bare_metal/zerto-virtual-replication-customer-to-ovhcloud/images/image-EN-2.png b/pages/bare_metal_cloud/managed_bare_metal/zerto-virtual-replication-customer-to-ovhcloud/images/image-EN-2.png deleted file mode 100644 index 5e1532d9a6d..00000000000 Binary files a/pages/bare_metal_cloud/managed_bare_metal/zerto-virtual-replication-customer-to-ovhcloud/images/image-EN-2.png and /dev/null differ diff --git a/pages/bare_metal_cloud/virtual_private_servers/activate-port-firewall-soft-win/images/step7_01.PNG b/pages/bare_metal_cloud/virtual_private_servers/activate-port-firewall-soft-win/images/step7_01.PNG deleted file mode 100644 index 9e844d4fd7b..00000000000 Binary files a/pages/bare_metal_cloud/virtual_private_servers/activate-port-firewall-soft-win/images/step7_01.PNG and /dev/null differ diff --git a/pages/bare_metal_cloud/virtual_private_servers/config_additional_disk/guide.en-asia.md b/pages/bare_metal_cloud/virtual_private_servers/config_additional_disk/guide.en-asia.md deleted file mode 100644 index 72ce3fcaab7..00000000000 --- a/pages/bare_metal_cloud/virtual_private_servers/config_additional_disk/guide.en-asia.md +++ /dev/null @@ -1,306 +0,0 @@ ---- -title: "How to configure an additional disk" -excerpt: "Find out how to add and configure additional storage space on a VPS" -updated: 2025-07-24 ---- - -## Objective - -With OVHcloud Virtual Private Servers you have the possibility to add a secure storage space as a service option. This storage is separated from the internal storage capacity of the VPS solution which makes it a secure place for your backups or other static data. The additional disk will only be accessible from the server's IP address and data stored on it will remain unaffected, even if the VPS is reinstalled or should suffer data loss. - -**This guide explains how to enable the additional disk option and configure the storage space for use with the VPS.** - -## Requirements - -- A [VPS](/links/bare-metal/vps) in your OVHcloud account -- Access to the [OVHcloud Control Panel](/links/manager) -- Administrative access via SSH or RDP to your VPS - -> [!warning] -> This feature is currently unavailable for Virtual Private Servers in [Local Zones](/links/bare-metal/vps-lz). -> - -## Instructions - -Log in to the [OVHcloud Control Panel](/links/manager), go to the `Bare Metal Cloud`{.action} section and select your server from `Virtual Private Servers`{.action}. - -### Subscribing to the additional disk option - -After selecting your VPS, click on the `Additional disk`{.action} tab in the horizontal menu. Click on `Order an additional disk`{.action} and choose a disk size from the selection that appears. - -![adddiskvps](images/disk_vps01.png){.thumbnail} - -Take note of the pricing information, then click on `Order`{.action}. You will be guided through the order process and receive a confirmation email as soon as the disk is installed. - -### Mounting the new storage space - -> [!warning] -> OVHcloud provides services for which you are responsible with regard to their configuration and management. It is therefore your responsibility to ensure that they function correctly. -> -> This guide is designed to assist you in common tasks as much as possible. Nevertheless, we recommend contacting a [specialist service provider](/links/partner) or reaching out to [our community of users](/links/community) if you experience any issues. -> - -#### On a Linux VPS - -If a GNU/Linux distribution is installed on your VPS, establish an SSH connection to your server from the command line terminal or by using a SSH client application. - -The examples below presume you are logged in as a user with elevated permissions. - -You can use the following command to verify the name of the new device: - -```bash -$ lsblk - -sda 8:0 0 80G 0 disk -├─sda1 8:1 0 79.9G 0 part / -├─sda14 8:14 0 4M 0 part -└─sda15 8:15 0 106M 0 part /boot/efi -sdb 8:16 0 50G 0 disk -``` - -In this example, the additional disk is named `sdb`. - -Execute `fdisk` to create a partition on the disk; when prompted, enter `n` for a new partition and accept the subsequent defaults by pressing Enter. Finally, use the `w` command to write the changes to the disk. - -```bash -$ sudo fdisk /dev/sdb - -Welcome to fdisk (util-linux 2.34). -Changes will remain in memory only, until you decide to write them. -Be careful before using the write command. -``` - -```bash -Command (m for help): n - -Partition type - p primary (0 primary, 0 extended, 4 free) - e extended (container for logical partitions) - -Select (default p): -``` - -```bash -Partition number (1-4, default 1): - -First sector (2048-104857599, default 2048): -Last sector, +/-sectors or +/-size{K,M,G,T,P} (2048-104857599, default 104857599): - -Created a new partition 1 of type 'Linux' and of size 50 GiB. -``` - -```bash -Command (m for help): w - -The partition table has been altered. -Calling ioctl() to re-read partition table. -Syncing disks. -``` - -Now that the partition `sdb1` is created, you can format it with ext4: - -```bash -$ sudo mkfs.ext4 /dev/sdb1 - -Creating filesystem with 13106944 4k blocks and 3276800 inodes -Filesystem UUID: a667d351-cf36-49f2-94b4-daf03d7a86a6 -Superblock backups stored on blocks: -32768, 98304, 163840, 229376, 294912, 819200, 884736, 1605632, 2654208, -4096000, 7962624, 11239424 - -Allocating group tables: done -Writing inode tables: done -Creating journal (65536 blocks): done -Writing superblocks and filesystem accounting information: done -``` - -The final step is to mount the disk: - -```bash -$ sudo mkdir /mnt/disk -$ sudo mount /dev/sdb1 /mnt/disk -``` - -You can see in the last line that the additional disk is now mounted at `/mnt/disk`: - -```bash -$ df -h -Filesystem Size Used Avail Use% Mounted on -udev 1.9G 0 1.9G 0% /dev -tmpfs 385M 1.1M 384M 1% /run -/dev/sda1 78G 2.4G 75G 4% / -tmpfs 1.9G 0 1.9G 0% /dev/shm -tmpfs 5.0M 0 5.0M 0% /run/lock -tmpfs 1.9G 0 1.9G 0% /sys/fs/cgroup -/dev/sda15 105M 3.9M 101M 4% /boot/efi -/dev/loop1 68M 68M 0 100% /snap/lxd/18150 -/dev/loop3 32M 32M 0 100% /snap/snapd/10707 -/dev/loop4 56M 56M 0 100% /snap/core18/1944 -/dev/loop5 70M 70M 0 100% /snap/lxd/19188 -tmpfs 385M 0 385M 0% /run/user/0 -/dev/loop6 56M 56M 0 100% /snap/core18/1988 -/dev/loop2 32M 32M 0 100% /snap/snapd/11036 -tmpfs 385M 0 385M 0% /run/user/1000 -/dev/sdb1 49G 53M 47G 1% /mnt/disk -``` - -> [!primary] -> -This previous step is not persistent because the disk will be detached if the VPS is restarted. In order to automate the mounting process, the `fstab` file needs to be edited. -> - -First, retrieve the UUID (block ID) of the device: - -```bash -$ sudo blkid -/dev/sda1: LABEL="cloudimg-rootfs" UUID="e616a2cd-3c02-4c79-9823-9b1bb5c13b26" TYPE="ext4" PARTUUID="a44089a3-f407-41e6-b7a5-1ed7672cef20" -/dev/sda15: LABEL_FATBOOT="UEFI" LABEL="UEFI" UUID="4411-1580" TYPE="vfat" PARTUUID="e1746ac7-80c1-4859-9b4d-fa6ce11b3ae9" -/dev/loop1: TYPE="squashfs" -/dev/loop2: TYPE="squashfs" -/dev/loop3: TYPE="squashfs" -/dev/loop4: TYPE="squashfs" -/dev/loop5: TYPE="squashfs" -/dev/loop6: TYPE="squashfs" -/dev/sda14: PARTUUID="7d19a2c9-75df-443e-8301-0bb85931df7d" -/dev/sdb1: UUID="87571b68-30e1-498b-a64c-49ec5cd4f31c" TYPE="ext4" PARTUUID="c965cbdf-01" -``` - -Open `/etc/fstab` with a text editor: - -```bash -$ sudo nano /etc/fstab -``` - -Add the line below to the file and replace the UUID with your own: - -```console -UUID=87571b68-30e1-498b-a64c-49ec5cd4f31c /mnt/disk ext4 nofail 0 0 -``` - -Save and exit the editor. The disk should be automatically mounted after every reboot from now on. - -#### On a Windows VPS - -If a Windows OS is installed on your VPS, establish a remote desktop (RDP) connection to your server. - -Once logged in, right-click on the `Start Menu`{.action} button and open `Disk Management`{.action}. - -![winmountdiskvps](images/disk_vps_win01.png){.thumbnail} - -The new disk will be displayed as an unknown volume with unallocated space. - -![winmountdiskvps](images/disk_vps_win02.png){.thumbnail} - -If the disk is marked as offline here, it needs to be initialised first. You can use the [Windows GUI](#initDiskManagement) or the [DISKPART utility](#initDiskpart) to achieve this. Otherwise, proceed with [formatting the disk in Disk Management](#formatDiskManagement). - -##### **Initialising the disk in Disk Management** - -Right-click on the disk and select `Online`{.action}. - -![winmountdiskvps](images/disk_vps_win03.png){.thumbnail} - -Then right-click on the disk again and this time select `Initialise Disk`{.action}. - -![winmountdiskvps](images/disk_vps_win04.png){.thumbnail} - -Select `MBR`{.action} in the new window and click `OK`{.action}. - -![winmountdiskvps](images/disk_vps_win05.png){.thumbnail} - -##### **Initialising the disk with DISKPART** - -Right-click on the `Start Menu`{.action} button and open `Run`{.action}. - -![winmountdiskvps](images/disk_vps_win06.png){.thumbnail} - -Type `cmd` and click `OK`{.action} to open the command line application. - -![winmountdiskvps](images/disk_vps_win07.png){.thumbnail} - -At the command prompt, open DISKPART: - -```console -C:\> diskpart -``` - -Use the following series of DISKPART commands to set the disk to online: - -```console -DISKPART> san - -SAN Policy : Offline Shared -``` - -```console -DISKPART> san policy = OnlineAll - -DiskPart successfully changed the SAN policy for the current operating system. - -- Implementation of the strategy on the extra disk: -[Code] DISKPART> list disk - -Disk ### Status Size Free Dyn Gpt --------- ------------- ------- ------- --- --- -Disk 0 Online 200 GB 0 B -* Disk 1 Offline 10 GB 1024 KB -``` - -```console -DISKPART> select disk 1 - -Disk 1 is now the selected disk. -``` - -```console -DISKPART> attributes disk clear readonly - -Disk attributes cleared successfully. -``` - -```console -DISKPART> attributes disk - -Current Read-only State : No -Read-only : No -Boot Disk : No -Pagefile Disk : No -Hibernation File Disk : No -Crashdump Disk : No -Clustered Disk : No -``` - -```console -DISKPART> online disk - -DiskPart successfully onlined the selected disk. -``` - -##### **Formatting the disk** - -In `Disk Management`{.action}, right-click on the new disk and select `New Simple Volume...`{.action}. - -![winmountdiskvps](images/disk_vps_win08.png){.thumbnail} - -In the wizard, click `Next`{.action} to specify the volume size. It should be set to maximum by default. Click `Next`{.action} to continue. - -![winmountdiskvps](images/disk_vps_win09.png){.thumbnail} - -Leave the new drive letter at default or select a different one, then click `Next`{.action}. - -![winmountdiskvps](images/disk_vps_win10.png){.thumbnail} - -Label the volume (optional) and confirm the formatting options by clicking `Next`{.action}. - -![winmountdiskvps](images/disk_vps_win11.png){.thumbnail} - -In the last window, click `Finish`{.action} to format the disk. It will be available as a drive in File Explorer after the operation. - -### Cancelling the additional disk option - -From the `Home`{.action} tab, scroll down to the box labelled **Summary of options**. Click on `...`{.action} next to the option "Additional disks" and in the context menu click on `Cancel`{.action}. - -![canceldiskvps](images/disk_vps02.png){.thumbnail} - -## Go further - -Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/config_additional_disk/guide.en-au.md b/pages/bare_metal_cloud/virtual_private_servers/config_additional_disk/guide.en-au.md deleted file mode 100644 index 72ce3fcaab7..00000000000 --- a/pages/bare_metal_cloud/virtual_private_servers/config_additional_disk/guide.en-au.md +++ /dev/null @@ -1,306 +0,0 @@ ---- -title: "How to configure an additional disk" -excerpt: "Find out how to add and configure additional storage space on a VPS" -updated: 2025-07-24 ---- - -## Objective - -With OVHcloud Virtual Private Servers you have the possibility to add a secure storage space as a service option. This storage is separated from the internal storage capacity of the VPS solution which makes it a secure place for your backups or other static data. The additional disk will only be accessible from the server's IP address and data stored on it will remain unaffected, even if the VPS is reinstalled or should suffer data loss. - -**This guide explains how to enable the additional disk option and configure the storage space for use with the VPS.** - -## Requirements - -- A [VPS](/links/bare-metal/vps) in your OVHcloud account -- Access to the [OVHcloud Control Panel](/links/manager) -- Administrative access via SSH or RDP to your VPS - -> [!warning] -> This feature is currently unavailable for Virtual Private Servers in [Local Zones](/links/bare-metal/vps-lz). -> - -## Instructions - -Log in to the [OVHcloud Control Panel](/links/manager), go to the `Bare Metal Cloud`{.action} section and select your server from `Virtual Private Servers`{.action}. - -### Subscribing to the additional disk option - -After selecting your VPS, click on the `Additional disk`{.action} tab in the horizontal menu. Click on `Order an additional disk`{.action} and choose a disk size from the selection that appears. - -![adddiskvps](images/disk_vps01.png){.thumbnail} - -Take note of the pricing information, then click on `Order`{.action}. You will be guided through the order process and receive a confirmation email as soon as the disk is installed. - -### Mounting the new storage space - -> [!warning] -> OVHcloud provides services for which you are responsible with regard to their configuration and management. It is therefore your responsibility to ensure that they function correctly. -> -> This guide is designed to assist you in common tasks as much as possible. Nevertheless, we recommend contacting a [specialist service provider](/links/partner) or reaching out to [our community of users](/links/community) if you experience any issues. -> - -#### On a Linux VPS - -If a GNU/Linux distribution is installed on your VPS, establish an SSH connection to your server from the command line terminal or by using a SSH client application. - -The examples below presume you are logged in as a user with elevated permissions. - -You can use the following command to verify the name of the new device: - -```bash -$ lsblk - -sda 8:0 0 80G 0 disk -├─sda1 8:1 0 79.9G 0 part / -├─sda14 8:14 0 4M 0 part -└─sda15 8:15 0 106M 0 part /boot/efi -sdb 8:16 0 50G 0 disk -``` - -In this example, the additional disk is named `sdb`. - -Execute `fdisk` to create a partition on the disk; when prompted, enter `n` for a new partition and accept the subsequent defaults by pressing Enter. Finally, use the `w` command to write the changes to the disk. - -```bash -$ sudo fdisk /dev/sdb - -Welcome to fdisk (util-linux 2.34). -Changes will remain in memory only, until you decide to write them. -Be careful before using the write command. -``` - -```bash -Command (m for help): n - -Partition type - p primary (0 primary, 0 extended, 4 free) - e extended (container for logical partitions) - -Select (default p): -``` - -```bash -Partition number (1-4, default 1): - -First sector (2048-104857599, default 2048): -Last sector, +/-sectors or +/-size{K,M,G,T,P} (2048-104857599, default 104857599): - -Created a new partition 1 of type 'Linux' and of size 50 GiB. -``` - -```bash -Command (m for help): w - -The partition table has been altered. -Calling ioctl() to re-read partition table. -Syncing disks. -``` - -Now that the partition `sdb1` is created, you can format it with ext4: - -```bash -$ sudo mkfs.ext4 /dev/sdb1 - -Creating filesystem with 13106944 4k blocks and 3276800 inodes -Filesystem UUID: a667d351-cf36-49f2-94b4-daf03d7a86a6 -Superblock backups stored on blocks: -32768, 98304, 163840, 229376, 294912, 819200, 884736, 1605632, 2654208, -4096000, 7962624, 11239424 - -Allocating group tables: done -Writing inode tables: done -Creating journal (65536 blocks): done -Writing superblocks and filesystem accounting information: done -``` - -The final step is to mount the disk: - -```bash -$ sudo mkdir /mnt/disk -$ sudo mount /dev/sdb1 /mnt/disk -``` - -You can see in the last line that the additional disk is now mounted at `/mnt/disk`: - -```bash -$ df -h -Filesystem Size Used Avail Use% Mounted on -udev 1.9G 0 1.9G 0% /dev -tmpfs 385M 1.1M 384M 1% /run -/dev/sda1 78G 2.4G 75G 4% / -tmpfs 1.9G 0 1.9G 0% /dev/shm -tmpfs 5.0M 0 5.0M 0% /run/lock -tmpfs 1.9G 0 1.9G 0% /sys/fs/cgroup -/dev/sda15 105M 3.9M 101M 4% /boot/efi -/dev/loop1 68M 68M 0 100% /snap/lxd/18150 -/dev/loop3 32M 32M 0 100% /snap/snapd/10707 -/dev/loop4 56M 56M 0 100% /snap/core18/1944 -/dev/loop5 70M 70M 0 100% /snap/lxd/19188 -tmpfs 385M 0 385M 0% /run/user/0 -/dev/loop6 56M 56M 0 100% /snap/core18/1988 -/dev/loop2 32M 32M 0 100% /snap/snapd/11036 -tmpfs 385M 0 385M 0% /run/user/1000 -/dev/sdb1 49G 53M 47G 1% /mnt/disk -``` - -> [!primary] -> -This previous step is not persistent because the disk will be detached if the VPS is restarted. In order to automate the mounting process, the `fstab` file needs to be edited. -> - -First, retrieve the UUID (block ID) of the device: - -```bash -$ sudo blkid -/dev/sda1: LABEL="cloudimg-rootfs" UUID="e616a2cd-3c02-4c79-9823-9b1bb5c13b26" TYPE="ext4" PARTUUID="a44089a3-f407-41e6-b7a5-1ed7672cef20" -/dev/sda15: LABEL_FATBOOT="UEFI" LABEL="UEFI" UUID="4411-1580" TYPE="vfat" PARTUUID="e1746ac7-80c1-4859-9b4d-fa6ce11b3ae9" -/dev/loop1: TYPE="squashfs" -/dev/loop2: TYPE="squashfs" -/dev/loop3: TYPE="squashfs" -/dev/loop4: TYPE="squashfs" -/dev/loop5: TYPE="squashfs" -/dev/loop6: TYPE="squashfs" -/dev/sda14: PARTUUID="7d19a2c9-75df-443e-8301-0bb85931df7d" -/dev/sdb1: UUID="87571b68-30e1-498b-a64c-49ec5cd4f31c" TYPE="ext4" PARTUUID="c965cbdf-01" -``` - -Open `/etc/fstab` with a text editor: - -```bash -$ sudo nano /etc/fstab -``` - -Add the line below to the file and replace the UUID with your own: - -```console -UUID=87571b68-30e1-498b-a64c-49ec5cd4f31c /mnt/disk ext4 nofail 0 0 -``` - -Save and exit the editor. The disk should be automatically mounted after every reboot from now on. - -#### On a Windows VPS - -If a Windows OS is installed on your VPS, establish a remote desktop (RDP) connection to your server. - -Once logged in, right-click on the `Start Menu`{.action} button and open `Disk Management`{.action}. - -![winmountdiskvps](images/disk_vps_win01.png){.thumbnail} - -The new disk will be displayed as an unknown volume with unallocated space. - -![winmountdiskvps](images/disk_vps_win02.png){.thumbnail} - -If the disk is marked as offline here, it needs to be initialised first. You can use the [Windows GUI](#initDiskManagement) or the [DISKPART utility](#initDiskpart) to achieve this. Otherwise, proceed with [formatting the disk in Disk Management](#formatDiskManagement). - -##### **Initialising the disk in Disk Management** - -Right-click on the disk and select `Online`{.action}. - -![winmountdiskvps](images/disk_vps_win03.png){.thumbnail} - -Then right-click on the disk again and this time select `Initialise Disk`{.action}. - -![winmountdiskvps](images/disk_vps_win04.png){.thumbnail} - -Select `MBR`{.action} in the new window and click `OK`{.action}. - -![winmountdiskvps](images/disk_vps_win05.png){.thumbnail} - -##### **Initialising the disk with DISKPART** - -Right-click on the `Start Menu`{.action} button and open `Run`{.action}. - -![winmountdiskvps](images/disk_vps_win06.png){.thumbnail} - -Type `cmd` and click `OK`{.action} to open the command line application. - -![winmountdiskvps](images/disk_vps_win07.png){.thumbnail} - -At the command prompt, open DISKPART: - -```console -C:\> diskpart -``` - -Use the following series of DISKPART commands to set the disk to online: - -```console -DISKPART> san - -SAN Policy : Offline Shared -``` - -```console -DISKPART> san policy = OnlineAll - -DiskPart successfully changed the SAN policy for the current operating system. - -- Implementation of the strategy on the extra disk: -[Code] DISKPART> list disk - -Disk ### Status Size Free Dyn Gpt --------- ------------- ------- ------- --- --- -Disk 0 Online 200 GB 0 B -* Disk 1 Offline 10 GB 1024 KB -``` - -```console -DISKPART> select disk 1 - -Disk 1 is now the selected disk. -``` - -```console -DISKPART> attributes disk clear readonly - -Disk attributes cleared successfully. -``` - -```console -DISKPART> attributes disk - -Current Read-only State : No -Read-only : No -Boot Disk : No -Pagefile Disk : No -Hibernation File Disk : No -Crashdump Disk : No -Clustered Disk : No -``` - -```console -DISKPART> online disk - -DiskPart successfully onlined the selected disk. -``` - -##### **Formatting the disk** - -In `Disk Management`{.action}, right-click on the new disk and select `New Simple Volume...`{.action}. - -![winmountdiskvps](images/disk_vps_win08.png){.thumbnail} - -In the wizard, click `Next`{.action} to specify the volume size. It should be set to maximum by default. Click `Next`{.action} to continue. - -![winmountdiskvps](images/disk_vps_win09.png){.thumbnail} - -Leave the new drive letter at default or select a different one, then click `Next`{.action}. - -![winmountdiskvps](images/disk_vps_win10.png){.thumbnail} - -Label the volume (optional) and confirm the formatting options by clicking `Next`{.action}. - -![winmountdiskvps](images/disk_vps_win11.png){.thumbnail} - -In the last window, click `Finish`{.action} to format the disk. It will be available as a drive in File Explorer after the operation. - -### Cancelling the additional disk option - -From the `Home`{.action} tab, scroll down to the box labelled **Summary of options**. Click on `...`{.action} next to the option "Additional disks" and in the context menu click on `Cancel`{.action}. - -![canceldiskvps](images/disk_vps02.png){.thumbnail} - -## Go further - -Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/config_additional_disk/guide.en-ca.md b/pages/bare_metal_cloud/virtual_private_servers/config_additional_disk/guide.en-ca.md deleted file mode 100644 index 72ce3fcaab7..00000000000 --- a/pages/bare_metal_cloud/virtual_private_servers/config_additional_disk/guide.en-ca.md +++ /dev/null @@ -1,306 +0,0 @@ ---- -title: "How to configure an additional disk" -excerpt: "Find out how to add and configure additional storage space on a VPS" -updated: 2025-07-24 ---- - -## Objective - -With OVHcloud Virtual Private Servers you have the possibility to add a secure storage space as a service option. This storage is separated from the internal storage capacity of the VPS solution which makes it a secure place for your backups or other static data. The additional disk will only be accessible from the server's IP address and data stored on it will remain unaffected, even if the VPS is reinstalled or should suffer data loss. - -**This guide explains how to enable the additional disk option and configure the storage space for use with the VPS.** - -## Requirements - -- A [VPS](/links/bare-metal/vps) in your OVHcloud account -- Access to the [OVHcloud Control Panel](/links/manager) -- Administrative access via SSH or RDP to your VPS - -> [!warning] -> This feature is currently unavailable for Virtual Private Servers in [Local Zones](/links/bare-metal/vps-lz). -> - -## Instructions - -Log in to the [OVHcloud Control Panel](/links/manager), go to the `Bare Metal Cloud`{.action} section and select your server from `Virtual Private Servers`{.action}. - -### Subscribing to the additional disk option - -After selecting your VPS, click on the `Additional disk`{.action} tab in the horizontal menu. Click on `Order an additional disk`{.action} and choose a disk size from the selection that appears. - -![adddiskvps](images/disk_vps01.png){.thumbnail} - -Take note of the pricing information, then click on `Order`{.action}. You will be guided through the order process and receive a confirmation email as soon as the disk is installed. - -### Mounting the new storage space - -> [!warning] -> OVHcloud provides services for which you are responsible with regard to their configuration and management. It is therefore your responsibility to ensure that they function correctly. -> -> This guide is designed to assist you in common tasks as much as possible. Nevertheless, we recommend contacting a [specialist service provider](/links/partner) or reaching out to [our community of users](/links/community) if you experience any issues. -> - -#### On a Linux VPS - -If a GNU/Linux distribution is installed on your VPS, establish an SSH connection to your server from the command line terminal or by using a SSH client application. - -The examples below presume you are logged in as a user with elevated permissions. - -You can use the following command to verify the name of the new device: - -```bash -$ lsblk - -sda 8:0 0 80G 0 disk -├─sda1 8:1 0 79.9G 0 part / -├─sda14 8:14 0 4M 0 part -└─sda15 8:15 0 106M 0 part /boot/efi -sdb 8:16 0 50G 0 disk -``` - -In this example, the additional disk is named `sdb`. - -Execute `fdisk` to create a partition on the disk; when prompted, enter `n` for a new partition and accept the subsequent defaults by pressing Enter. Finally, use the `w` command to write the changes to the disk. - -```bash -$ sudo fdisk /dev/sdb - -Welcome to fdisk (util-linux 2.34). -Changes will remain in memory only, until you decide to write them. -Be careful before using the write command. -``` - -```bash -Command (m for help): n - -Partition type - p primary (0 primary, 0 extended, 4 free) - e extended (container for logical partitions) - -Select (default p): -``` - -```bash -Partition number (1-4, default 1): - -First sector (2048-104857599, default 2048): -Last sector, +/-sectors or +/-size{K,M,G,T,P} (2048-104857599, default 104857599): - -Created a new partition 1 of type 'Linux' and of size 50 GiB. -``` - -```bash -Command (m for help): w - -The partition table has been altered. -Calling ioctl() to re-read partition table. -Syncing disks. -``` - -Now that the partition `sdb1` is created, you can format it with ext4: - -```bash -$ sudo mkfs.ext4 /dev/sdb1 - -Creating filesystem with 13106944 4k blocks and 3276800 inodes -Filesystem UUID: a667d351-cf36-49f2-94b4-daf03d7a86a6 -Superblock backups stored on blocks: -32768, 98304, 163840, 229376, 294912, 819200, 884736, 1605632, 2654208, -4096000, 7962624, 11239424 - -Allocating group tables: done -Writing inode tables: done -Creating journal (65536 blocks): done -Writing superblocks and filesystem accounting information: done -``` - -The final step is to mount the disk: - -```bash -$ sudo mkdir /mnt/disk -$ sudo mount /dev/sdb1 /mnt/disk -``` - -You can see in the last line that the additional disk is now mounted at `/mnt/disk`: - -```bash -$ df -h -Filesystem Size Used Avail Use% Mounted on -udev 1.9G 0 1.9G 0% /dev -tmpfs 385M 1.1M 384M 1% /run -/dev/sda1 78G 2.4G 75G 4% / -tmpfs 1.9G 0 1.9G 0% /dev/shm -tmpfs 5.0M 0 5.0M 0% /run/lock -tmpfs 1.9G 0 1.9G 0% /sys/fs/cgroup -/dev/sda15 105M 3.9M 101M 4% /boot/efi -/dev/loop1 68M 68M 0 100% /snap/lxd/18150 -/dev/loop3 32M 32M 0 100% /snap/snapd/10707 -/dev/loop4 56M 56M 0 100% /snap/core18/1944 -/dev/loop5 70M 70M 0 100% /snap/lxd/19188 -tmpfs 385M 0 385M 0% /run/user/0 -/dev/loop6 56M 56M 0 100% /snap/core18/1988 -/dev/loop2 32M 32M 0 100% /snap/snapd/11036 -tmpfs 385M 0 385M 0% /run/user/1000 -/dev/sdb1 49G 53M 47G 1% /mnt/disk -``` - -> [!primary] -> -This previous step is not persistent because the disk will be detached if the VPS is restarted. In order to automate the mounting process, the `fstab` file needs to be edited. -> - -First, retrieve the UUID (block ID) of the device: - -```bash -$ sudo blkid -/dev/sda1: LABEL="cloudimg-rootfs" UUID="e616a2cd-3c02-4c79-9823-9b1bb5c13b26" TYPE="ext4" PARTUUID="a44089a3-f407-41e6-b7a5-1ed7672cef20" -/dev/sda15: LABEL_FATBOOT="UEFI" LABEL="UEFI" UUID="4411-1580" TYPE="vfat" PARTUUID="e1746ac7-80c1-4859-9b4d-fa6ce11b3ae9" -/dev/loop1: TYPE="squashfs" -/dev/loop2: TYPE="squashfs" -/dev/loop3: TYPE="squashfs" -/dev/loop4: TYPE="squashfs" -/dev/loop5: TYPE="squashfs" -/dev/loop6: TYPE="squashfs" -/dev/sda14: PARTUUID="7d19a2c9-75df-443e-8301-0bb85931df7d" -/dev/sdb1: UUID="87571b68-30e1-498b-a64c-49ec5cd4f31c" TYPE="ext4" PARTUUID="c965cbdf-01" -``` - -Open `/etc/fstab` with a text editor: - -```bash -$ sudo nano /etc/fstab -``` - -Add the line below to the file and replace the UUID with your own: - -```console -UUID=87571b68-30e1-498b-a64c-49ec5cd4f31c /mnt/disk ext4 nofail 0 0 -``` - -Save and exit the editor. The disk should be automatically mounted after every reboot from now on. - -#### On a Windows VPS - -If a Windows OS is installed on your VPS, establish a remote desktop (RDP) connection to your server. - -Once logged in, right-click on the `Start Menu`{.action} button and open `Disk Management`{.action}. - -![winmountdiskvps](images/disk_vps_win01.png){.thumbnail} - -The new disk will be displayed as an unknown volume with unallocated space. - -![winmountdiskvps](images/disk_vps_win02.png){.thumbnail} - -If the disk is marked as offline here, it needs to be initialised first. You can use the [Windows GUI](#initDiskManagement) or the [DISKPART utility](#initDiskpart) to achieve this. Otherwise, proceed with [formatting the disk in Disk Management](#formatDiskManagement). - -##### **Initialising the disk in Disk Management** - -Right-click on the disk and select `Online`{.action}. - -![winmountdiskvps](images/disk_vps_win03.png){.thumbnail} - -Then right-click on the disk again and this time select `Initialise Disk`{.action}. - -![winmountdiskvps](images/disk_vps_win04.png){.thumbnail} - -Select `MBR`{.action} in the new window and click `OK`{.action}. - -![winmountdiskvps](images/disk_vps_win05.png){.thumbnail} - -##### **Initialising the disk with DISKPART** - -Right-click on the `Start Menu`{.action} button and open `Run`{.action}. - -![winmountdiskvps](images/disk_vps_win06.png){.thumbnail} - -Type `cmd` and click `OK`{.action} to open the command line application. - -![winmountdiskvps](images/disk_vps_win07.png){.thumbnail} - -At the command prompt, open DISKPART: - -```console -C:\> diskpart -``` - -Use the following series of DISKPART commands to set the disk to online: - -```console -DISKPART> san - -SAN Policy : Offline Shared -``` - -```console -DISKPART> san policy = OnlineAll - -DiskPart successfully changed the SAN policy for the current operating system. - -- Implementation of the strategy on the extra disk: -[Code] DISKPART> list disk - -Disk ### Status Size Free Dyn Gpt --------- ------------- ------- ------- --- --- -Disk 0 Online 200 GB 0 B -* Disk 1 Offline 10 GB 1024 KB -``` - -```console -DISKPART> select disk 1 - -Disk 1 is now the selected disk. -``` - -```console -DISKPART> attributes disk clear readonly - -Disk attributes cleared successfully. -``` - -```console -DISKPART> attributes disk - -Current Read-only State : No -Read-only : No -Boot Disk : No -Pagefile Disk : No -Hibernation File Disk : No -Crashdump Disk : No -Clustered Disk : No -``` - -```console -DISKPART> online disk - -DiskPart successfully onlined the selected disk. -``` - -##### **Formatting the disk** - -In `Disk Management`{.action}, right-click on the new disk and select `New Simple Volume...`{.action}. - -![winmountdiskvps](images/disk_vps_win08.png){.thumbnail} - -In the wizard, click `Next`{.action} to specify the volume size. It should be set to maximum by default. Click `Next`{.action} to continue. - -![winmountdiskvps](images/disk_vps_win09.png){.thumbnail} - -Leave the new drive letter at default or select a different one, then click `Next`{.action}. - -![winmountdiskvps](images/disk_vps_win10.png){.thumbnail} - -Label the volume (optional) and confirm the formatting options by clicking `Next`{.action}. - -![winmountdiskvps](images/disk_vps_win11.png){.thumbnail} - -In the last window, click `Finish`{.action} to format the disk. It will be available as a drive in File Explorer after the operation. - -### Cancelling the additional disk option - -From the `Home`{.action} tab, scroll down to the box labelled **Summary of options**. Click on `...`{.action} next to the option "Additional disks" and in the context menu click on `Cancel`{.action}. - -![canceldiskvps](images/disk_vps02.png){.thumbnail} - -## Go further - -Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/config_additional_disk/guide.en-ie.md b/pages/bare_metal_cloud/virtual_private_servers/config_additional_disk/guide.en-ie.md deleted file mode 100644 index eeac77948e6..00000000000 --- a/pages/bare_metal_cloud/virtual_private_servers/config_additional_disk/guide.en-ie.md +++ /dev/null @@ -1,306 +0,0 @@ ---- -title: "How to configure an additional disk" -excerpt: "Find out how to add and configure additional storage space on a VPS" -updated: 2025-07-24 ---- - -## Objective - -With OVHcloud Virtual Private Servers you have the possibility to add a secure storage space as a service option. This storage is separated from the internal storage capacity of the VPS solution which makes it a secure place for your backups or other static data. The additional disk will only be accessible from the server's IP address and data stored on it will remain unaffected, even if the VPS is reinstalled or should suffer data loss. - -**This guide explains how to enable the additional disk option and configure the storage space for use with the VPS.** - -## Requirements - -- A [VPS](/links/bare-metal/vps) in your OVHcloud account -- Access to the [OVHcloud Control Panel](/links/manager) -- Administrative access via SSH or RDP to your VPS - -> [!warning] -> This feature is currently unavailable for Virtual Private Servers in [Local Zones](/links/bare-metal/vps-lz). -> - -## Instructions - -Log in to the [OVHcloud Control Panel](/links/manager), go to the `Bare Metal Cloud`{.action} section and select your server from `Virtual Private Servers`{.action}. - -### Subscribing to the additional disk option - -After selecting your VPS, click on the `Additional disk`{.action} tab in the horizontal menu. Click on `Order an additional disk`{.action} and choose a disk size from the selection that appears. - -![adddiskvps](images/disk_vps01.png){.thumbnail} - -Take note of the pricing information, then click on `Order`{.action}. You will be guided through the order process and receive a confirmation email as soon as the disk is installed. - -### Mounting the new storage space - -> [!warning] -> OVHcloud provides services for which you are responsible with regard to their configuration and management. It is therefore your responsibility to ensure that they function correctly. -> -> This guide is designed to assist you in common tasks as much as possible. Nevertheless, we recommend contacting a [specialist service provider](/links/partner) or reaching out to [our community of users](/links/community) if you experience any issues. -> - -#### On a Linux VPS - -If a GNU/Linux distribution is installed on your VPS, establish an SSH connection to your server from the command line terminal or by using a SSH client application. - -The examples below presume you are logged in as a user with elevated permissions. - -You can use the following command to verify the name of the new device: - -```bash -$ lsblk - -sda 8:0 0 80G 0 disk -├─sda1 8:1 0 79.9G 0 part / -├─sda14 8:14 0 4M 0 part -└─sda15 8:15 0 106M 0 part /boot/efi -sdb 8:16 0 50G 0 disk -``` - -In this example, the additional disk is named `sdb`. - -Execute `fdisk` to create a partition on the disk; when prompted, enter `n` for a new partition and accept the subsequent defaults by pressing Enter. Finally, use the `w` command to write the changes to the disk. - -```bash -$ sudo fdisk /dev/sdb - -Welcome to fdisk (util-linux 2.34). -Changes will remain in memory only, until you decide to write them. -Be careful before using the write command. -``` - -```bash -Command (m for help): n - -Partition type - p primary (0 primary, 0 extended, 4 free) - e extended (container for logical partitions) - -Select (default p): -``` - -```bash -Partition number (1-4, default 1): - -First sector (2048-104857599, default 2048): -Last sector, +/-sectors or +/-size{K,M,G,T,P} (2048-104857599, default 104857599): - -Created a new partition 1 of type 'Linux' and of size 50 GiB. -``` - -```bash -Command (m for help): w - -The partition table has been altered. -Calling ioctl() to re-read partition table. -Syncing disks. -``` - -Now that the partition `sdb1` is created, you can format it with ext4: - -```bash -$ sudo mkfs.ext4 /dev/sdb1 - -Creating filesystem with 13106944 4k blocks and 3276800 inodes -Filesystem UUID: a667d351-cf36-49f2-94b4-daf03d7a86a6 -Superblock backups stored on blocks: -32768, 98304, 163840, 229376, 294912, 819200, 884736, 1605632, 2654208, -4096000, 7962624, 11239424 - -Allocating group tables: done -Writing inode tables: done -Creating journal (65536 blocks): done -Writing superblocks and filesystem accounting information: done -``` - -The final step is to mount the disk: - -```bash -$ sudo mkdir /mnt/disk -$ sudo mount /dev/sdb1 /mnt/disk -``` - -You can see in the last line that the additional disk is now mounted at `/mnt/disk`: - -```bash -$ df -h -Filesystem Size Used Avail Use% Mounted on -udev 1.9G 0 1.9G 0% /dev -tmpfs 385M 1.1M 384M 1% /run -/dev/sda1 78G 2.4G 75G 4% / -tmpfs 1.9G 0 1.9G 0% /dev/shm -tmpfs 5.0M 0 5.0M 0% /run/lock -tmpfs 1.9G 0 1.9G 0% /sys/fs/cgroup -/dev/sda15 105M 3.9M 101M 4% /boot/efi -/dev/loop1 68M 68M 0 100% /snap/lxd/18150 -/dev/loop3 32M 32M 0 100% /snap/snapd/10707 -/dev/loop4 56M 56M 0 100% /snap/core18/1944 -/dev/loop5 70M 70M 0 100% /snap/lxd/19188 -tmpfs 385M 0 385M 0% /run/user/0 -/dev/loop6 56M 56M 0 100% /snap/core18/1988 -/dev/loop2 32M 32M 0 100% /snap/snapd/11036 -tmpfs 385M 0 385M 0% /run/user/1000 -/dev/sdb1 49G 53M 47G 1% /mnt/disk -``` - -> [!primary] -> -This previous step is not persistent because the disk will be detached if the VPS is restarted. In order to automate the mounting process, the `fstab` file needs to be edited. -> - -First, retrieve the UUID (block ID) of the device: - -```bash -$ sudo blkid -/dev/sda1: LABEL="cloudimg-rootfs" UUID="e616a2cd-3c02-4c79-9823-9b1bb5c13b26" TYPE="ext4" PARTUUID="a44089a3-f407-41e6-b7a5-1ed7672cef20" -/dev/sda15: LABEL_FATBOOT="UEFI" LABEL="UEFI" UUID="4411-1580" TYPE="vfat" PARTUUID="e1746ac7-80c1-4859-9b4d-fa6ce11b3ae9" -/dev/loop1: TYPE="squashfs" -/dev/loop2: TYPE="squashfs" -/dev/loop3: TYPE="squashfs" -/dev/loop4: TYPE="squashfs" -/dev/loop5: TYPE="squashfs" -/dev/loop6: TYPE="squashfs" -/dev/sda14: PARTUUID="7d19a2c9-75df-443e-8301-0bb85931df7d" -/dev/sdb1: UUID="87571b68-30e1-498b-a64c-49ec5cd4f31c" TYPE="ext4" PARTUUID="c965cbdf-01" -``` - -Open `/etc/fstab` with a text editor: - -```bash -$ sudo nano /etc/fstab -``` - -Add the line below to the file and replace the UUID with your own: - -```console -UUID=87571b68-30e1-498b-a64c-49ec5cd4f31c /mnt/disk ext4 nofail 0 0 -``` - -Save and exit the editor. The disk should be automatically mounted after every reboot from now on. - -#### On a Windows VPS - -If a Windows OS is installed on your VPS, establish a remote desktop (RDP) connection to your server. - -Once logged in, right-click on the `Start Menu`{.action} button and open `Disk Management`{.action}. - -![winmountdiskvps](images/disk_vps_win01.png){.thumbnail} - -The new disk will be displayed as an unknown volume with unallocated space. - -![winmountdiskvps](images/disk_vps_win02.png){.thumbnail} - -If the disk is marked as offline here, it needs to be initialised first. You can use the [Windows GUI](#initDiskManagement) or the [DISKPART utility](#initDiskpart) to achieve this. Otherwise, proceed with [formatting the disk in Disk Management](#formatDiskManagement). - -##### **Initialising the disk in Disk Management** - -Right-click on the disk and select `Online`{.action}. - -![winmountdiskvps](images/disk_vps_win03.png){.thumbnail} - -Then right-click on the disk again and this time select `Initialise Disk`{.action}. - -![winmountdiskvps](images/disk_vps_win04.png){.thumbnail} - -Select `MBR`{.action} in the new window and click `OK`{.action}. - -![winmountdiskvps](images/disk_vps_win05.png){.thumbnail} - -##### **Initialising the disk with DISKPART** - -Right-click on the `Start Menu`{.action} button and open `Run`{.action}. - -![winmountdiskvps](images/disk_vps_win06.png){.thumbnail} - -Type `cmd` and click `OK`{.action} to open the command line application. - -![winmountdiskvps](images/disk_vps_win07.png){.thumbnail} - -At the command prompt, open DISKPART: - -```console -C:\> diskpart -``` - -Use the following series of DISKPART commands to set the disk to online: - -```console -DISKPART> san - -SAN Policy : Offline Shared -``` - -```console -DISKPART> san policy = OnlineAll - -DiskPart successfully changed the SAN policy for the current operating system. - -- Implementation of the strategy on the extra disk: -[Code] DISKPART> list disk - -Disk ### Status Size Free Dyn Gpt --------- ------------- ------- ------- --- --- -Disk 0 Online 200 GB 0 B -* Disk 1 Offline 10 GB 1024 KB -``` - -```console -DISKPART> select disk 1 - -Disk 1 is now the selected disk. -``` - -```console -DISKPART> attributes disk clear readonly - -Disk attributes cleared successfully. -``` - -```console -DISKPART> attributes disk - -Current Read-only State : No -Read-only : No -Boot Disk : No -Pagefile Disk : No -Hibernation File Disk : No -Crashdump Disk : No -Clustered Disk : No -``` - -```console -DISKPART> online disk - -DiskPart successfully onlined the selected disk. -``` - -##### **Formatting the disk** - -In `Disk Management`{.action}, right-click on the new disk and select `New Simple Volume...`{.action}. - -![winmountdiskvps](images/disk_vps_win08.png){.thumbnail} - -In the wizard, click `Next`{.action} to specify the volume size. It should be set to maximum by default. Click `Next`{.action} to continue. - -![winmountdiskvps](images/disk_vps_win09.png){.thumbnail} - -Leave the new drive letter at default or select a different one, then click `Next`{.action}. - -![winmountdiskvps](images/disk_vps_win10.png){.thumbnail} - -Label the volume (optional) and confirm the formatting options by clicking `Next`{.action}. - -![winmountdiskvps](images/disk_vps_win11.png){.thumbnail} - -In the last window, click `Finish`{.action} to format the disk. It will be available as a drive in File Explorer after the operation. - -### Cancelling the additional disk option - -From the `Home`{.action} tab, scroll down to the box labelled **Summary of options**. Click on `...`{.action} next to the option "Additional disks" and in the context menu click on `Cancel`{.action}. - -![canceldiskvps](images/disk_vps02.png){.thumbnail} - -## Go further - -Join our [community of users](/links/community). diff --git a/pages/bare_metal_cloud/virtual_private_servers/config_additional_disk/guide.en-sg.md b/pages/bare_metal_cloud/virtual_private_servers/config_additional_disk/guide.en-sg.md deleted file mode 100644 index 72ce3fcaab7..00000000000 --- a/pages/bare_metal_cloud/virtual_private_servers/config_additional_disk/guide.en-sg.md +++ /dev/null @@ -1,306 +0,0 @@ ---- -title: "How to configure an additional disk" -excerpt: "Find out how to add and configure additional storage space on a VPS" -updated: 2025-07-24 ---- - -## Objective - -With OVHcloud Virtual Private Servers you have the possibility to add a secure storage space as a service option. This storage is separated from the internal storage capacity of the VPS solution which makes it a secure place for your backups or other static data. The additional disk will only be accessible from the server's IP address and data stored on it will remain unaffected, even if the VPS is reinstalled or should suffer data loss. - -**This guide explains how to enable the additional disk option and configure the storage space for use with the VPS.** - -## Requirements - -- A [VPS](/links/bare-metal/vps) in your OVHcloud account -- Access to the [OVHcloud Control Panel](/links/manager) -- Administrative access via SSH or RDP to your VPS - -> [!warning] -> This feature is currently unavailable for Virtual Private Servers in [Local Zones](/links/bare-metal/vps-lz). -> - -## Instructions - -Log in to the [OVHcloud Control Panel](/links/manager), go to the `Bare Metal Cloud`{.action} section and select your server from `Virtual Private Servers`{.action}. - -### Subscribing to the additional disk option - -After selecting your VPS, click on the `Additional disk`{.action} tab in the horizontal menu. Click on `Order an additional disk`{.action} and choose a disk size from the selection that appears. - -![adddiskvps](images/disk_vps01.png){.thumbnail} - -Take note of the pricing information, then click on `Order`{.action}. You will be guided through the order process and receive a confirmation email as soon as the disk is installed. - -### Mounting the new storage space - -> [!warning] -> OVHcloud provides services for which you are responsible with regard to their configuration and management. It is therefore your responsibility to ensure that they function correctly. -> -> This guide is designed to assist you in common tasks as much as possible. Nevertheless, we recommend contacting a [specialist service provider](/links/partner) or reaching out to [our community of users](/links/community) if you experience any issues. -> - -#### On a Linux VPS - -If a GNU/Linux distribution is installed on your VPS, establish an SSH connection to your server from the command line terminal or by using a SSH client application. - -The examples below presume you are logged in as a user with elevated permissions. - -You can use the following command to verify the name of the new device: - -```bash -$ lsblk - -sda 8:0 0 80G 0 disk -├─sda1 8:1 0 79.9G 0 part / -├─sda14 8:14 0 4M 0 part -└─sda15 8:15 0 106M 0 part /boot/efi -sdb 8:16 0 50G 0 disk -``` - -In this example, the additional disk is named `sdb`. - -Execute `fdisk` to create a partition on the disk; when prompted, enter `n` for a new partition and accept the subsequent defaults by pressing Enter. Finally, use the `w` command to write the changes to the disk. - -```bash -$ sudo fdisk /dev/sdb - -Welcome to fdisk (util-linux 2.34). -Changes will remain in memory only, until you decide to write them. -Be careful before using the write command. -``` - -```bash -Command (m for help): n - -Partition type - p primary (0 primary, 0 extended, 4 free) - e extended (container for logical partitions) - -Select (default p): -``` - -```bash -Partition number (1-4, default 1): - -First sector (2048-104857599, default 2048): -Last sector, +/-sectors or +/-size{K,M,G,T,P} (2048-104857599, default 104857599): - -Created a new partition 1 of type 'Linux' and of size 50 GiB. -``` - -```bash -Command (m for help): w - -The partition table has been altered. -Calling ioctl() to re-read partition table. -Syncing disks. -``` - -Now that the partition `sdb1` is created, you can format it with ext4: - -```bash -$ sudo mkfs.ext4 /dev/sdb1 - -Creating filesystem with 13106944 4k blocks and 3276800 inodes -Filesystem UUID: a667d351-cf36-49f2-94b4-daf03d7a86a6 -Superblock backups stored on blocks: -32768, 98304, 163840, 229376, 294912, 819200, 884736, 1605632, 2654208, -4096000, 7962624, 11239424 - -Allocating group tables: done -Writing inode tables: done -Creating journal (65536 blocks): done -Writing superblocks and filesystem accounting information: done -``` - -The final step is to mount the disk: - -```bash -$ sudo mkdir /mnt/disk -$ sudo mount /dev/sdb1 /mnt/disk -``` - -You can see in the last line that the additional disk is now mounted at `/mnt/disk`: - -```bash -$ df -h -Filesystem Size Used Avail Use% Mounted on -udev 1.9G 0 1.9G 0% /dev -tmpfs 385M 1.1M 384M 1% /run -/dev/sda1 78G 2.4G 75G 4% / -tmpfs 1.9G 0 1.9G 0% /dev/shm -tmpfs 5.0M 0 5.0M 0% /run/lock -tmpfs 1.9G 0 1.9G 0% /sys/fs/cgroup -/dev/sda15 105M 3.9M 101M 4% /boot/efi -/dev/loop1 68M 68M 0 100% /snap/lxd/18150 -/dev/loop3 32M 32M 0 100% /snap/snapd/10707 -/dev/loop4 56M 56M 0 100% /snap/core18/1944 -/dev/loop5 70M 70M 0 100% /snap/lxd/19188 -tmpfs 385M 0 385M 0% /run/user/0 -/dev/loop6 56M 56M 0 100% /snap/core18/1988 -/dev/loop2 32M 32M 0 100% /snap/snapd/11036 -tmpfs 385M 0 385M 0% /run/user/1000 -/dev/sdb1 49G 53M 47G 1% /mnt/disk -``` - -> [!primary] -> -This previous step is not persistent because the disk will be detached if the VPS is restarted. In order to automate the mounting process, the `fstab` file needs to be edited. -> - -First, retrieve the UUID (block ID) of the device: - -```bash -$ sudo blkid -/dev/sda1: LABEL="cloudimg-rootfs" UUID="e616a2cd-3c02-4c79-9823-9b1bb5c13b26" TYPE="ext4" PARTUUID="a44089a3-f407-41e6-b7a5-1ed7672cef20" -/dev/sda15: LABEL_FATBOOT="UEFI" LABEL="UEFI" UUID="4411-1580" TYPE="vfat" PARTUUID="e1746ac7-80c1-4859-9b4d-fa6ce11b3ae9" -/dev/loop1: TYPE="squashfs" -/dev/loop2: TYPE="squashfs" -/dev/loop3: TYPE="squashfs" -/dev/loop4: TYPE="squashfs" -/dev/loop5: TYPE="squashfs" -/dev/loop6: TYPE="squashfs" -/dev/sda14: PARTUUID="7d19a2c9-75df-443e-8301-0bb85931df7d" -/dev/sdb1: UUID="87571b68-30e1-498b-a64c-49ec5cd4f31c" TYPE="ext4" PARTUUID="c965cbdf-01" -``` - -Open `/etc/fstab` with a text editor: - -```bash -$ sudo nano /etc/fstab -``` - -Add the line below to the file and replace the UUID with your own: - -```console -UUID=87571b68-30e1-498b-a64c-49ec5cd4f31c /mnt/disk ext4 nofail 0 0 -``` - -Save and exit the editor. The disk should be automatically mounted after every reboot from now on. - -#### On a Windows VPS - -If a Windows OS is installed on your VPS, establish a remote desktop (RDP) connection to your server. - -Once logged in, right-click on the `Start Menu`{.action} button and open `Disk Management`{.action}. - -![winmountdiskvps](images/disk_vps_win01.png){.thumbnail} - -The new disk will be displayed as an unknown volume with unallocated space. - -![winmountdiskvps](images/disk_vps_win02.png){.thumbnail} - -If the disk is marked as offline here, it needs to be initialised first. You can use the [Windows GUI](#initDiskManagement) or the [DISKPART utility](#initDiskpart) to achieve this. Otherwise, proceed with [formatting the disk in Disk Management](#formatDiskManagement). - -##### **Initialising the disk in Disk Management** - -Right-click on the disk and select `Online`{.action}. - -![winmountdiskvps](images/disk_vps_win03.png){.thumbnail} - -Then right-click on the disk again and this time select `Initialise Disk`{.action}. - -![winmountdiskvps](images/disk_vps_win04.png){.thumbnail} - -Select `MBR`{.action} in the new window and click `OK`{.action}. - -![winmountdiskvps](images/disk_vps_win05.png){.thumbnail} - -##### **Initialising the disk with DISKPART** - -Right-click on the `Start Menu`{.action} button and open `Run`{.action}. - -![winmountdiskvps](images/disk_vps_win06.png){.thumbnail} - -Type `cmd` and click `OK`{.action} to open the command line application. - -![winmountdiskvps](images/disk_vps_win07.png){.thumbnail} - -At the command prompt, open DISKPART: - -```console -C:\> diskpart -``` - -Use the following series of DISKPART commands to set the disk to online: - -```console -DISKPART> san - -SAN Policy : Offline Shared -``` - -```console -DISKPART> san policy = OnlineAll - -DiskPart successfully changed the SAN policy for the current operating system. - -- Implementation of the strategy on the extra disk: -[Code] DISKPART> list disk - -Disk ### Status Size Free Dyn Gpt --------- ------------- ------- ------- --- --- -Disk 0 Online 200 GB 0 B -* Disk 1 Offline 10 GB 1024 KB -``` - -```console -DISKPART> select disk 1 - -Disk 1 is now the selected disk. -``` - -```console -DISKPART> attributes disk clear readonly - -Disk attributes cleared successfully. -``` - -```console -DISKPART> attributes disk - -Current Read-only State : No -Read-only : No -Boot Disk : No -Pagefile Disk : No -Hibernation File Disk : No -Crashdump Disk : No -Clustered Disk : No -``` - -```console -DISKPART> online disk - -DiskPart successfully onlined the selected disk. -``` - -##### **Formatting the disk** - -In `Disk Management`{.action}, right-click on the new disk and select `New Simple Volume...`{.action}. - -![winmountdiskvps](images/disk_vps_win08.png){.thumbnail} - -In the wizard, click `Next`{.action} to specify the volume size. It should be set to maximum by default. Click `Next`{.action} to continue. - -![winmountdiskvps](images/disk_vps_win09.png){.thumbnail} - -Leave the new drive letter at default or select a different one, then click `Next`{.action}. - -![winmountdiskvps](images/disk_vps_win10.png){.thumbnail} - -Label the volume (optional) and confirm the formatting options by clicking `Next`{.action}. - -![winmountdiskvps](images/disk_vps_win11.png){.thumbnail} - -In the last window, click `Finish`{.action} to format the disk. It will be available as a drive in File Explorer after the operation. - -### Cancelling the additional disk option - -From the `Home`{.action} tab, scroll down to the box labelled **Summary of options**. Click on `...`{.action} next to the option "Additional disks" and in the context menu click on `Cancel`{.action}. - -![canceldiskvps](images/disk_vps02.png){.thumbnail} - -## Go further - -Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/config_additional_disk/guide.es-us.md b/pages/bare_metal_cloud/virtual_private_servers/config_additional_disk/guide.es-us.md deleted file mode 100755 index 6ac89f33655..00000000000 --- a/pages/bare_metal_cloud/virtual_private_servers/config_additional_disk/guide.es-us.md +++ /dev/null @@ -1,306 +0,0 @@ ---- -title: 'Configurar un disco adicional' -excerpt: 'Cómo añadir y configurar espacio de almacenamiento adicional en un VPS' -updated: 2025-07-24 ---- - -## Objetivo - -Con los VPS de OVHcloud, puede añadir un espacio de almacenamiento seguro como opción de servicio. Este almacenamiento está separado de la capacidad de almacenamiento interna de la solución VPS, lo que lo convierte en un lugar seguro para sus copias de seguridad u otros datos estáticos. Solo podrá acceder al disco adicional desde la dirección IP del servidor y los datos que contiene no se verán afectados, aunque el VPS sea reinstalado o deba perderse los datos. - -**Esta guía explica cómo activar la opción de disco adicional y configurar el espacio de almacenamiento para utilizarlo con el VPS.** - -## Requisitos - -- Tener un [VPS](/links/bare-metal/vps) en su cuenta de OVHcloud. -- Haber iniciado sesión en el [área de cliente de OVHcloud](/links/manager). -- Tener acceso administrativo a su VPS por SSH o RDP. - -> [!warning] -> Esta funcionalidad no está disponible actualmente para los servidores virtuales en las [Local Zones](/links/bare-metal/vps-lz). -> - -## Procedimiento - -Conéctese al [Panel de configuración de OVHcloud](/links/manager), acceda a la sección `Bare Metal Cloud`{.action} y seleccione el servidor en la sección `Servidores Privados Virtuales`{.action}. - -### Contratar un disco adicional - -Una vez seleccionado el VPS, abra la pestaña `Disco adicional`{.action} del menú horizontal. Haga clic en `Contratar un disco adicional`{.action} y seleccione el tamaño del disco en la selección que se muestra. - -![adddiskvps](images/disk_vps01.png){.thumbnail} - -Tome nota de la información sobre los precios y haga clic en `Contratar`{.action}. Le guiaremos en el proceso de pedido y recibirá un mensaje de correo electrónico de confirmación una vez instalado el disco. - -### Montar el nuevo espacio de almacenamiento - -> [!warning] -> OVHcloud pone a su disposición servicios cuya configuración, gestión y responsabilidad recaen sobre usted. Por lo tanto, usted deberá asegurarse de que estos funcionen correctamente. -> -> Si tiene problemas para realizar estas acciones, póngase en contacto con un [proveedor de servicios especializado](/links/partner) o hable del problema con nuestra [comunidad de usuarios](/links/community). OVHcloud no puede proporcionarle soporte técnico sobre este tema. -> - -#### En un VPS Linux - -Si tiene instalada una distribución GNU/Linux en su VPS, conéctese por SSH al servidor desde el terminal de línea de comandos o utilizando una aplicación cliente SSH. - -Los siguientes ejemplos suponen que está conectado como usuario con altos permisos. - -Puede utilizar el siguiente comando para comprobar el nombre del nuevo dispositivo: - -```bash -$ lsblk - -sda 8:0 0 80G 0 disk -├─sda1 8:1 0 79.9G 0 part / -├─sda14 8:14 0 4M 0 part -└─sda15 8:15 0 106M 0 part /boot/efi -sdb 8:16 0 50G 0 disk -``` - -En este ejemplo, el disco adicional se llama `sdb`. - -Ejecute `fdisk` para crear una partición en el disco. Cuando se le pida, introduzca `n` para una nueva partición y acepte los siguientes valores predeterminados pulsando "Enter". Por último, utilice el comando `w` para escribir los cambios en el disco. - -```bash -$ sudo fdisk /dev/sdb - -Welcome to fdisk (util-linux 2.34). -Changes will remain in memory only, until you decide to write them. -Be careful before using the write command. -``` - -```bash -Command (m for help): n - -Partition type - p primary (0 primary, 0 extended, 4 free) - e extended (container for logical partitions) - -Select (default p): -``` - -```bash -Partition number (1-4, default 1): - -First sector (2048-104857599, default 2048): -Last sector, +/-sectors or +/-size{K,M,G,T,P} (2048-104857599, default 104857599): - -Created a new partition 1 of type 'Linux' and of size 50 GiB. -``` - -```bash -Command (m for help): w - -The partition table has been altered. -Calling ioctl() to re-read partition table. -Syncing disks. -``` - -Una vez creada la partición `sdb1`, puede formatearla con ext4: - -```bash -$ sudo mkfs.ext4 /dev/sdb1 - -Creating filesystem with 13106944 4k blocks and 3276800 inodes -Filesystem UUID: a667d351-cf36-49f2-94b4-daf03d7a86a6 -Superblock backups stored on blocks: -32768, 98304, 163840, 229376, 294912, 819200, 884736, 1605632, 2654208, -4096000, 7962624, 11239424 - -Allocating group tables: done -Writing inode tables: done -Creating journal (65536 blocks): done -Writing superblocks and filesystem accounting information: done -``` - -Para terminar, montar el disco: - -```bash -$ sudo mkdir /mnt/disk -$ sudo mount /dev/sdb1 /mnt/disk -``` - -En la última línea, puede ver que el disco adicional está ahora montado a `/mnt/disk`: - -```bash -$ df -h -Filesystem Size Used Avail Use% Mounted on -udev 1.9G 0 1.9G 0% /dev -tmpfs 385M 1.1M 384M 1% /run -/dev/sda1 78G 2.4G 75G 4% / -tmpfs 1.9G 0 1.9G 0% /dev/shm -tmpfs 5.0M 0 5.0M 0% /run/lock -tmpfs 1.9G 0 1.9G 0% /sys/fs/cgroup -/dev/sda15 105M 3.9M 101M 4% /boot/efi -/dev/loop1 68M 68M 0 100% /snap/lxd/18150 -/dev/loop3 32M 32M 0 100% /snap/snapd/10707 -/dev/loop4 56M 56M 0 100% /snap/core18/1944 -/dev/loop5 70M 70M 0 100% /snap/lxd/19188 -tmpfs 385M 0 385M 0% /run/user/0 -/dev/loop6 56M 56M 0 100% /snap/core18/1988 -/dev/loop2 32M 32M 0 100% /snap/snapd/11036 -tmpfs 385M 0 385M 0% /run/user/1000 -/dev/sdb1 49G 53M 47G 1% /mnt/disk -``` - -> [!primary] -> -Este paso anterior no es persistente, ya que el disco se desvinculará si se reinicia el VPS. Para automatizar el proceso de montaje, debe modificar el archivo "fstab". -> - -En primer lugar, obtenga el UUID (ID de bloque) del periférico: - -```bash -$ sudo blkid -/dev/sda1: LABEL="cloudimg-rootfs" UUID="e616a2cd-3c02-4c79-9823-9b1bb5c13b26" TYPE="ext4" PARTUUID="a44089a3-f407-41e6-b7a5-1ed7672cef20" -/dev/sda15: LABEL_FATBOOT="UEFI" LABEL="UEFI" UUID="4411-1580" TYPE="vfat" PARTUUID="e1746ac7-80c1-4859-9b4d-fa6ce11b3ae9" -/dev/loop1: TYPE="squashfs" -/dev/loop2: TYPE="squashfs" -/dev/loop3: TYPE="squashfs" -/dev/loop4: TYPE="squashfs" -/dev/loop5: TYPE="squashfs" -/dev/loop6: TYPE="squashfs" -/dev/sda14: PARTUUID="7d19a2c9-75df-443e-8301-0bb85931df7d" -/dev/sdb1: UUID="87571b68-30e1-498b-a64c-49ec5cd4f31c" TYPE="ext4" PARTUUID="c965cbdf-01" -``` - -Abra `/etc/fstab` con un editor de texto: - -```bash -$ sudo nano /etc/fstab -``` - -Añada la siguiente línea al archivo y sustituya el UUID por el suyo: - -```console -UUID=87571b68-30e1-498b-a64c-49ec5cd4f31c /mnt/disk ext4 nofail 0 0 -``` - -Guarde y salga del editor. A continuación, el disco debe montarse automáticamente tras cada reinicio. - -#### En un VPS Windows - -Si tiene instalado un sistema operativo Windows en su VPS, conéctese al servidor mediante un escritorio remoto (RDP). - -Una vez que se haya conectado, haga clic derecho en el botón `Menú Iniciar`{.action} y abra la herramienta de `gestión de discos`{.action}. - -![winmountdiskvps](images/disk_vps_win01.png){.thumbnail} - -El nuevo disco se muestra en forma de volumen desconocido con espacio no destinado. - -![winmountdiskvps](images/disk_vps_win02.png){.thumbnail} - -Si el disco está marcado como desconectado, primero debe inicializarse. Para ello, puede utilizar la [interfaz gráfica Windows](#initDiskManagement) o la [utilidad DISKPART](#initDiskpart). De lo contrario, realice el [formateo del disco en la herramienta "Gestión de discos"](#formatDiskManagement). - -##### **Inicializar el disco en la herramienta de gestión de discos** - - Haga clic derecho en el disco y seleccione `En línea`{.action}. - -![winmountdiskvps](images/disk_vps_win03.png){.thumbnail} - -Haga clic derecho en el disco y seleccione `Inicializar disco`{.action}. - -![winmountdiskvps](images/disk_vps_win04.png){.thumbnail} - -Seleccione `MBR`{.action} (Sector de inicio principal) en la nueva ventana y haga clic en `Aceptar`{.action}. - -![winmountdiskvps](images/disk_vps_win05.png){.thumbnail} - -##### **Iniciar el disco con DISKPART** - -Haga clic derecho en el `menú Inicio`{.action} y abra `Ejecutar`{.action}. - -![winmountdiskvps](images/disk_vps_win06.png){.thumbnail} - -Pulse `cmd` y haga clic en `Aceptar`{.action} para abrir la aplicación de línea de órdenes. - -![winmountdiskvps](images/disk_vps_win07.png){.thumbnail} - -En la línea de comandos, abra DISKPART: - -```console -C:\> diskpart -``` - -Utilice la siguiente serie de comandos DISKPART para configurar el disco en línea: - -```console -DISKPART> san - -SAN Policy: Offline Shared -``` - -```console -DISKPART> san policy = OnlineAll - -DiskPart successfully changed the SAN policy for the current operating system. - -- Implementation of the strategy on the extra disk: -[Code] DISKPART> list disk - -Disk ### Status Size Free Dyn Gpt --------- ------------- ------- ------- --- --- -Disk 0 Online 200 GB 0 B -* Disk 1 Offline 10 GB 1024 KB -``` - -```console -DISKPART> select disk 1 - -Disk 1 is now the selected disk -``` - -```console -DISKPART> attributes disk clear readonly - -Disk attributes cleared successfully. -``` - -```console -DISKPART> attributes disk - -Current Read-only State : No -Read-only : No -Boot Disk : No -Pagefile Disk : No -Hibernation File Disk : No -Crashdump Disk : No -Clustered Disk : No -``` - -```console -DISKPART> online disk - -DiskPart successfully onlined the selected disk. -``` - -##### **Formatear el disco en la herramienta de gestión de discos** - -En `Gestión de discos`{.action}, haga clic derecho en el nuevo disco y seleccione `Nuevo volumen simple...`{.action}. - -![winmountdiskvps](images/disk_vps_win08.png){.thumbnail} - -En el Asistente, haga clic en `Siguiente`{.action} para especificar el tamaño del volumen. Debe estar definido por defecto en el máximo. Haga clic en `Siguiente`{.action} para continuar. - -![winmountdiskvps](images/disk_vps_win09.png){.thumbnail} - -Guarde la nueva letra predeterminada del reproductor o seleccione otra y haga clic en `Siguiente`{.action}. - -![winmountdiskvps](images/disk_vps_win10.png){.thumbnail} - -Asigne un nombre al volumen (opcional) y confirme las opciones de formato haciendo clic en `Siguiente`{.action}. - -![winmountdiskvps](images/disk_vps_win11.png){.thumbnail} - -En la última ventana, haga clic en `Finalizar`{.action} para dar formato al disco. Estará disponible como reproductor en el Explorador de archivos después de la operación. - -### Dar de baja la opción de disco adicional - -En la pestaña `Inicio`{.action}, en la sección **Su configuración**, haga clic en `...`{.action} junto a la opción `Discos adicionales` y seleccione `Dar de baja`{.action}. - -![baja del disco adicional](images/disk_vps02.png){.thumbnail} - -## Más información - -Interactúe con nuestra [comunidad de usuarios](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/config_additional_disk/guide.fr-ca.md b/pages/bare_metal_cloud/virtual_private_servers/config_additional_disk/guide.fr-ca.md deleted file mode 100644 index ccc4d19261d..00000000000 --- a/pages/bare_metal_cloud/virtual_private_servers/config_additional_disk/guide.fr-ca.md +++ /dev/null @@ -1,306 +0,0 @@ ---- -title: 'Configurer un disque additionnel' -excerpt: "Découvrez comment ajouter et configurer de l'espace de stockage supplémentaire sur un VPS" -updated: 2025-07-24 ---- - -## Objectif - -Avec les VPS OVHcloud, vous avez la possibilité d'ajouter un espace de stockage sécurisé en tant qu'option de service. Ce stockage est séparé de la capacité de stockage interne de la solution VPS, ce qui en fait un endroit sûr pour vos sauvegardes ou autres données statiques. Le disque additionnel sera uniquement accessible à partir de l'adresse IP du serveur et les données qu'il contient ne seront pas affectées, même si le VPS est réinstallé ou doit subir une perte de données. - -**Découvrez comment activer l'option de disque additionnel et configurer l'espace de stockage pour l'utiliser avec le VPS.** - -## Prérequis - -- Disposer d'un [VPS](/links/bare-metal/vps) dans votre compte OVHcloud -- Être connecté à votre [espace client OVHcloud](/links/manager) -- Disposer d'un accès administratif via SSH ou RDP à votre VPS - -> [!warning] -> Cette fonctionnalité est actuellement indisponible pour les serveurs privés virtuels dans les [Local Zones](/links/bare-metal/vps-lz). -> - -## En pratique - -Connectez-vous à votre [espace client OVHcloud](/links/manager), rendez-vous dans la section `Bare Metal Cloud`{.action} et sélectionnez votre serveur sous la partie `Serveur privés virtuels`{.action}. - -### Commander un disque additionnel - -Après avoir sélectionné votre VPS, cliquez sur l'onglet `Disque additionnel`{.action} dans le menu horizontal. Cliquez sur `Commander un disque supplémentaire`{.action} et choisissez une taille de disque dans la sélection qui s'affiche. - -![adddiskvps](images/disk_vps01.png){.thumbnail} - -Prenez note des informations de tarification, puis cliquez sur `Commander`{.action}. Vous serez guidé dans le processus de commande et recevrez un e-mail de confirmation dès que le disque sera installé. - -### Monter le nouvel espace de stockage - -> [!warning] -> OVHcloud met à votre disposition des services dont la configuration, la gestion et la responsabilité vous incombent. Il vous revient de ce fait d'en assurer le bon fonctionnement. -> -> Si vous rencontrez des difficultés pour effectuer ces actions, veuillez contacter un [prestataire de services spécialisé](/links/partner) et/ou discuter du problème avec notre [communauté d'utilisateurs](/links/community). OVHcloud ne peut pas vous fournir de support technique sur ce sujet. -> - -#### Sur un VPS Linux - -Si une distribution GNU/Linux est installée sur votre VPS, établissez une connexion SSH à votre serveur à partir du terminal de ligne de commande ou en utilisant une application cliente SSH. - -Les exemples ci-dessous supposent que vous êtes connecté en tant qu'utilisateur avec des droits élevés. - -Vous pouvez utiliser la commande suivante pour vérifier le nom du nouveau périphérique : - -```bash -$ lsblk - -sda 8:0 0 80G 0 disk -├─sda1 8:1 0 79.9G 0 part / -├─sda14 8:14 0 4M 0 part -└─sda15 8:15 0 106M 0 part /boot/efi -sdb 8:16 0 50G 0 disk -``` - -Dans cet exemple, le disque supplémentaire est nommé `sdb`. - -Exécutez `fdisk` pour créer une partition sur le disque. Lorsque vous y êtes invité, entrez `n` pour une nouvelle partition et acceptez les valeurs par défaut suivantes en appuyant sur Entrée (« ↩ »). Enfin, utilisez la commande `w` pour écrire les modifications sur le disque. - -```bash -$ sudo fdisk /dev/sdb - -Welcome to fdisk (util-linux 2.34). -Changes will remain in memory only, until you decide to write them. -Be careful before using the write command. -``` - -```bash -Command (m for help): n - -Partition type - p primary (0 primary, 0 extended, 4 free) - e extended (container for logical partitions) - -Select (default p): -``` - -```bash -Partition number (1-4, default 1): - -First sector (2048-104857599, default 2048): -Last sector, +/-sectors or +/-size{K,M,G,T,P} (2048-104857599, default 104857599): - -Created a new partition 1 of type 'Linux' and of size 50 GiB. -``` - -```bash -Command (m for help): w - -The partition table has been altered. -Calling ioctl() to re-read partition table. -Syncing disks. -``` - -Maintenant que la partition `sdb1` est créée, vous pouvez la formater avec ext4 : - -```bash -$ sudo mkfs.ext4 /dev/sdb1 - -Creating filesystem with 13106944 4k blocks and 3276800 inodes -Filesystem UUID: a667d351-cf36-49f2-94b4-daf03d7a86a6 -Superblock backups stored on blocks: -32768, 98304, 163840, 229376, 294912, 819200, 884736, 1605632, 2654208, -4096000, 7962624, 11239424 - -Allocating group tables: done -Writing inode tables: done -Creating journal (65536 blocks): done -Writing superblocks and filesystem accounting information: done -``` - -La dernière étape consiste à monter le disque : - -```bash -$ sudo mkdir /mnt/disk -$ sudo mount /dev/sdb1 /mnt/disk -``` - -Vous pouvez voir sur la dernière ligne que le disque additionnel est maintenant monté à `/mnt/disk` : - -```bash -$ df -h -Filesystem Size Used Avail Use% Mounted on -udev 1.9G 0 1.9G 0% /dev -tmpfs 385M 1.1M 384M 1% /run -/dev/sda1 78G 2.4G 75G 4% / -tmpfs 1.9G 0 1.9G 0% /dev/shm -tmpfs 5.0M 0 5.0M 0% /run/lock -tmpfs 1.9G 0 1.9G 0% /sys/fs/cgroup -/dev/sda15 105M 3.9M 101M 4% /boot/efi -/dev/loop1 68M 68M 0 100% /snap/lxd/18150 -/dev/loop3 32M 32M 0 100% /snap/snapd/10707 -/dev/loop4 56M 56M 0 100% /snap/core18/1944 -/dev/loop5 70M 70M 0 100% /snap/lxd/19188 -tmpfs 385M 0 385M 0% /run/user/0 -/dev/loop6 56M 56M 0 100% /snap/core18/1988 -/dev/loop2 32M 32M 0 100% /snap/snapd/11036 -tmpfs 385M 0 385M 0% /run/user/1000 -/dev/sdb1 49G 53M 47G 1% /mnt/disk -``` - -> [!primary] -> -Cette étape précédente n'est pas persistante car le disque sera détaché si le VPS est redémarré. Pour automatiser le processus de montage, le fichier « fstab » doit être modifié. -> - -Tout d'abord, récupérez l'UUID (ID de bloc) du périphérique : - -```bash -$ sudo blkid -/dev/sda1: LABEL="cloudimg-rootfs" UUID="e616a2cd-3c02-4c79-9823-9b1bb5c13b26" TYPE="ext4" PARTUUID="a44089a3-f407-41e6-b7a5-1ed7672cef20" -/dev/sda15: LABEL_FATBOOT="UEFI" LABEL="UEFI" UUID="4411-1580" TYPE="vfat" PARTUUID="e1746ac7-80c1-4859-9b4d-fa6ce11b3ae9" -/dev/loop1: TYPE="squashfs" -/dev/loop2: TYPE="squashfs" -/dev/loop3: TYPE="squashfs" -/dev/loop4: TYPE="squashfs" -/dev/loop5: TYPE="squashfs" -/dev/loop6: TYPE="squashfs" -/dev/sda14: PARTUUID="7d19a2c9-75df-443e-8301-0bb85931df7d" -/dev/sdb1: UUID="87571b68-30e1-498b-a64c-49ec5cd4f31c" TYPE="ext4" PARTUUID="c965cbdf-01" -``` - -Ouvrez `/etc/fstab` avec un éditeur de texte : - -```bash -$ sudo nano /etc/fstab -``` - -Ajoutez la ligne ci-dessous au fichier et remplacez l'UUID par le vôtre : - -```console -UUID=87571b68-30e1-498b-a64c-49ec5cd4f31c /mnt/disk ext4 nofail 0 0 -``` - -Enregistrez et quittez l'éditeur. Dès lors, le disque devrait être automatiquement monté après chaque redémarrage. - -#### Sur un VPS Windows - -Si un système d'exploitation Windows est installé sur votre VPS, établissez une connexion Bureau à distance (RDP) à votre serveur. - -Une fois connecté, faites un clic droit sur le bouton `Menu Démarrer`{.action} et ouvrez l'outil de `Gestion des disques`{.action}. - -![winmountdiskvps](images/disk_vps_win01.png){.thumbnail} - -Le nouveau disque s'affiche sous la forme d'un volume inconnu avec de l'espace non alloué. - -![winmountdiskvps](images/disk_vps_win02.png){.thumbnail} - -Si le disque est marqué comme hors connexion, il doit d'abord être initialisé. Pour ce faire, vous pouvez utiliser l'[interface graphique Windows](#initDiskManagement) ou l'[utilitaire DISKPART](#initDiskpart). Sinon, procédez au [formatage du disque dans l'outil « Gestion des disques »](#formatDiskManagement). - -##### **Initialiser le disque dans l'outil « Gestion des disques »** - -Faites un clic droit sur le disque et sélectionnez `En ligne`{.action}. - -![winmountdiskvps](images/disk_vps_win03.png){.thumbnail} - -Faites un nouveau clic droit sur le disque et sélectionnez cette fois `Initialiser le disque`{.action}. - -![winmountdiskvps](images/disk_vps_win04.png){.thumbnail} - -Sélectionnez `MBR`{.action} (Secteur de démarrage principal) dans la nouvelle fenêtre et cliquez sur `OK`{.action}. - -![winmountdiskvps](images/disk_vps_win05.png){.thumbnail} - -##### **Initialiser le disque avec DISKPART** - -Faites un clic droit sur le `Menu Démarrer`{.action} et ouvrez `Exécuter`{.action}. - -![winmountdiskvps](images/disk_vps_win06.png){.thumbnail} - -Tapez `cmd` et cliquez sur `OK`{.action} pour ouvrir l'application de ligne de commande. - -![winmountdiskvps](images/disk_vps_win07.png){.thumbnail} - -Dans l'invite de commandes, ouvrez DISKPART : - -```console -C:\> diskpart -``` - -Utilisez la série de commandes DISKPART suivante pour configurer le disque en ligne : - -```console -DISKPART> san - -SAN Policy : Offline Shared -``` - -```console -DISKPART> san policy = OnlineAll - -DiskPart successfully changed the SAN policy for the current operating system. - -- Implementation of the strategy on the extra disk: -[Code] DISKPART> list disk - -Disk ### Status Size Free Dyn Gpt --------- ------------- ------- ------- --- --- -Disk 0 Online 200 GB 0 B -* Disk 1 Offline 10 GB 1024 KB -``` - -```console -DISKPART> select disk 1 - -Disk 1 is now the selected disk. -``` - -```console -DISKPART> attributes disk clear readonly - -Disk attributes cleared successfully. -``` - -```console -DISKPART> attributes disk - -Current Read-only State : No -Read-only : No -Boot Disk : No -Pagefile Disk : No -Hibernation File Disk : No -Crashdump Disk : No -Clustered Disk : No -``` - -```console -DISKPART> online disk - -DiskPart successfully onlined the selected disk. -``` - -##### **Formater le disque dans l'outil « Gestion des disques »** - -Dans `Gestion des disques`{.action}, faites un clic droit sur le nouveau disque et sélectionnez `Nouveau volume simple...`{.action}. - -![winmountdiskvps](images/disk_vps_win08.png){.thumbnail} - -Dans l'Assistant, cliquez sur `Suivant`{.action} pour spécifier la taille du volume. Il devrait être défini par défaut sur le maximum. Cliquez sur `Suivant`{.action} pour continuer. - -![winmountdiskvps](images/disk_vps_win09.png){.thumbnail} - -Conservez la nouvelle lettre de lecteur par défaut ou sélectionnez-en une autre, puis cliquez sur `Suivant`{.action}. - -![winmountdiskvps](images/disk_vps_win10.png){.thumbnail} - -Nommez le volume (facultatif) et confirmez les options de formatage en cliquant sur `Suivant`{.action}. - -![winmountdiskvps](images/disk_vps_win11.png){.thumbnail} - -Dans la dernière fenêtre, cliquez sur `Terminer`{.action} pour formater le disque. Il sera disponible en tant que lecteur dans l'Explorateur de fichiers après l'opération. - -### Résilier l'option de disque additionnel - -Depuis l'onglet `Accueil`{.action}, dans la section **Votre configuration**, cliquez sur `...`{.action} à côté de l'option `Disques additionnels` puis cliquez sur `Résilier`{.action}. - -![résiliation disque additionnel](images/disk_vps02.png){.thumbnail} - -## Allez plus loin - -Échangez avec notre [communauté d'utilisateurs](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.de-de.md b/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.de-de.md index ef209853d64..d414885f075 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.de-de.md +++ b/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.de-de.md @@ -1,16 +1,12 @@ --- title: "IPv6 auf einem VPS einrichten" excerpt: "Erfahren Sie hier, wie Sie IPv6 auf Ihrem OVHcloud VPS konfigurieren" -updated: 2025-08-07 +updated: 2025-09-30 --- > [!primary] > In dieser Anleitung wird die Konfiguration primärer IPv6-Adressen auf einer öffentlichen Schnittstelle erläutert. Sie können auch Additional IP-Adressen auf Ihrem VPS konfigurieren, indem Sie [diese Anleitung](/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing) verwenden. > -> Beachten Sie, dass Additional IPs auch in einem vRack (privates Netzwerk) konfiguriert werden können, was die Anbindung eines breiten Spektrums von OVHcloud Diensten ermöglicht und so für mehr Flexibilität sorgt. -> -> Erfahren Sie mithilfe unserer Anleitungen, wie Sie Additional IPs in einem vRack für [IPv4](/pages/bare_metal_cloud/dedicated_servers/configuring-an-ip-block-in-a-vrack) und [IPv6](/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack) konfigurieren. -> ## Ziel diff --git a/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.en-asia.md b/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.en-asia.md index 5c372bd3d1d..e185a1e9353 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.en-asia.md +++ b/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.en-asia.md @@ -1,16 +1,12 @@ --- title: "How to configure IPv6 on a VPS" excerpt: "Find out how to configure IPv6 on your OVHcloud VPS" -updated: 2025-08-07 +updated: 2025-09-30 --- > [!primary] > This article is about Primary IPv6 configuration on a public interface. You can also configure Additional IP addresses on your VPS using [this guide](/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing). -> -> Please note that Additional IP addresses can also be configured in a vRack (private network), which allows interconnection over a wide range of OVHcloud services, offering more flexibility. -> -> Learn how to configure Additional IP addresses in a vRack with our guides for [IPv4](/pages/bare_metal_cloud/dedicated_servers/configuring-an-ip-block-in-a-vrack) and [IPv6](/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack). -> +> ## Objective diff --git a/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.en-au.md b/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.en-au.md index 5c372bd3d1d..e185a1e9353 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.en-au.md +++ b/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.en-au.md @@ -1,16 +1,12 @@ --- title: "How to configure IPv6 on a VPS" excerpt: "Find out how to configure IPv6 on your OVHcloud VPS" -updated: 2025-08-07 +updated: 2025-09-30 --- > [!primary] > This article is about Primary IPv6 configuration on a public interface. You can also configure Additional IP addresses on your VPS using [this guide](/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing). -> -> Please note that Additional IP addresses can also be configured in a vRack (private network), which allows interconnection over a wide range of OVHcloud services, offering more flexibility. -> -> Learn how to configure Additional IP addresses in a vRack with our guides for [IPv4](/pages/bare_metal_cloud/dedicated_servers/configuring-an-ip-block-in-a-vrack) and [IPv6](/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack). -> +> ## Objective diff --git a/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.en-ca.md b/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.en-ca.md index 5c372bd3d1d..e185a1e9353 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.en-ca.md +++ b/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.en-ca.md @@ -1,16 +1,12 @@ --- title: "How to configure IPv6 on a VPS" excerpt: "Find out how to configure IPv6 on your OVHcloud VPS" -updated: 2025-08-07 +updated: 2025-09-30 --- > [!primary] > This article is about Primary IPv6 configuration on a public interface. You can also configure Additional IP addresses on your VPS using [this guide](/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing). -> -> Please note that Additional IP addresses can also be configured in a vRack (private network), which allows interconnection over a wide range of OVHcloud services, offering more flexibility. -> -> Learn how to configure Additional IP addresses in a vRack with our guides for [IPv4](/pages/bare_metal_cloud/dedicated_servers/configuring-an-ip-block-in-a-vrack) and [IPv6](/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack). -> +> ## Objective diff --git a/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.en-gb.md b/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.en-gb.md index 5c372bd3d1d..e185a1e9353 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.en-gb.md +++ b/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.en-gb.md @@ -1,16 +1,12 @@ --- title: "How to configure IPv6 on a VPS" excerpt: "Find out how to configure IPv6 on your OVHcloud VPS" -updated: 2025-08-07 +updated: 2025-09-30 --- > [!primary] > This article is about Primary IPv6 configuration on a public interface. You can also configure Additional IP addresses on your VPS using [this guide](/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing). -> -> Please note that Additional IP addresses can also be configured in a vRack (private network), which allows interconnection over a wide range of OVHcloud services, offering more flexibility. -> -> Learn how to configure Additional IP addresses in a vRack with our guides for [IPv4](/pages/bare_metal_cloud/dedicated_servers/configuring-an-ip-block-in-a-vrack) and [IPv6](/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack). -> +> ## Objective diff --git a/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.en-ie.md b/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.en-ie.md index 5c372bd3d1d..e185a1e9353 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.en-ie.md +++ b/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.en-ie.md @@ -1,16 +1,12 @@ --- title: "How to configure IPv6 on a VPS" excerpt: "Find out how to configure IPv6 on your OVHcloud VPS" -updated: 2025-08-07 +updated: 2025-09-30 --- > [!primary] > This article is about Primary IPv6 configuration on a public interface. You can also configure Additional IP addresses on your VPS using [this guide](/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing). -> -> Please note that Additional IP addresses can also be configured in a vRack (private network), which allows interconnection over a wide range of OVHcloud services, offering more flexibility. -> -> Learn how to configure Additional IP addresses in a vRack with our guides for [IPv4](/pages/bare_metal_cloud/dedicated_servers/configuring-an-ip-block-in-a-vrack) and [IPv6](/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack). -> +> ## Objective diff --git a/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.en-sg.md b/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.en-sg.md index 5c372bd3d1d..e185a1e9353 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.en-sg.md +++ b/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.en-sg.md @@ -1,16 +1,12 @@ --- title: "How to configure IPv6 on a VPS" excerpt: "Find out how to configure IPv6 on your OVHcloud VPS" -updated: 2025-08-07 +updated: 2025-09-30 --- > [!primary] > This article is about Primary IPv6 configuration on a public interface. You can also configure Additional IP addresses on your VPS using [this guide](/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing). -> -> Please note that Additional IP addresses can also be configured in a vRack (private network), which allows interconnection over a wide range of OVHcloud services, offering more flexibility. -> -> Learn how to configure Additional IP addresses in a vRack with our guides for [IPv4](/pages/bare_metal_cloud/dedicated_servers/configuring-an-ip-block-in-a-vrack) and [IPv6](/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack). -> +> ## Objective diff --git a/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.en-us.md b/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.en-us.md index 5c372bd3d1d..e185a1e9353 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.en-us.md +++ b/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.en-us.md @@ -1,16 +1,12 @@ --- title: "How to configure IPv6 on a VPS" excerpt: "Find out how to configure IPv6 on your OVHcloud VPS" -updated: 2025-08-07 +updated: 2025-09-30 --- > [!primary] > This article is about Primary IPv6 configuration on a public interface. You can also configure Additional IP addresses on your VPS using [this guide](/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing). -> -> Please note that Additional IP addresses can also be configured in a vRack (private network), which allows interconnection over a wide range of OVHcloud services, offering more flexibility. -> -> Learn how to configure Additional IP addresses in a vRack with our guides for [IPv4](/pages/bare_metal_cloud/dedicated_servers/configuring-an-ip-block-in-a-vrack) and [IPv6](/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack). -> +> ## Objective diff --git a/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.es-es.md b/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.es-es.md index 0a0a5f0433f..3bcf5a3916f 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.es-es.md +++ b/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.es-es.md @@ -1,16 +1,12 @@ --- title: "Configurar la IPv6 en un VPS" excerpt: 'Cómo configurar la IPv6 en un VPS de OVHcloud' -updated: 2025-08-07 +updated: 2025-09-30 --- > [!primary] > Este artículo explica cómo configurar las direcciones IPv6 principales en una interfaz pública. También puede configurar direcciones Additional IP en su VPS utilizando [esta guía](/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing). > -> Tenga en cuenta que las direcciones Additional IP también pueden configurarse en un vRack (red privada), lo que permite interconectar una amplia gama de servicios de OVHcloud, ofreciendo mayor flexibilidad. -> -> Cómo configurar direcciones Additional IP en un vRack con nuestras guías para [IPv4](/pages/bare_metal_cloud/dedicated_servers/configuring-an-ip-block-in-a-vrack) y [IPv6](/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack). -> ## Objetivo diff --git a/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.es-us.md b/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.es-us.md index ba9869e5917..d91279a8f98 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.es-us.md +++ b/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.es-us.md @@ -1,16 +1,12 @@ --- title: "Configurar la IPv6 en un VPS" excerpt: "Cómo configurar la IPv6 en un VPS de OVHcloud" -updated: 2025-08-07 +updated: 2025-09-30 --- > [!primary] > Este artículo explica cómo configurar las direcciones IPv6 principales en una interfaz pública. También puede configurar direcciones Additional IP en su VPS utilizando [esta guía](/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing). > -> Tenga en cuenta que las direcciones Additional IP también pueden configurarse en un vRack (red privada), lo que permite interconectar una amplia gama de servicios de OVHcloud, ofreciendo mayor flexibilidad. -> -> Cómo configurar direcciones Additional IP en un vRack con nuestras guías para [IPv4](/pages/bare_metal_cloud/dedicated_servers/configuring-an-ip-block-in-a-vrack) y [IPv6](/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack). -> ## Objetivo diff --git a/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.fr-ca.md b/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.fr-ca.md index 80f8fcb7728..74196e4fa8f 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.fr-ca.md +++ b/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.fr-ca.md @@ -1,15 +1,11 @@ --- title: "Configurer l'IPv6 sur un serveur VPS" excerpt: "Apprenez à configurer l'IPv6 sur votre serveur VPS OVHcloud" -updated: 2025-08-07 +updated: 2025-09-30 --- > [!primary] > Cet article concerne la configuration d'adresses IPv6 principales sur une interface publique. Vous pouvez également configurer des adresses Additional IP sur votre VPS en utilisant [ce guide](/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing). -> -> Veuillez noter que les Additional IP peuvent également être configurées dans un vRack (réseau privé), ce qui permet d'interconnecter une large gamme de services OVHcloud, offrant plus de flexibilité. -> -> Apprenez à configurer des Additional IP dans un vRack avec nos guides pour [IPv4](/pages/bare_metal_cloud/dedicated_servers/configuring-an-ip-block-in-a-vrack) et [IPv6](/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack). > ## Objectif diff --git a/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.fr-fr.md b/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.fr-fr.md index f32e5c0da27..17daf563dde 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.fr-fr.md +++ b/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.fr-fr.md @@ -1,15 +1,11 @@ --- title: "Configurer l'IPv6 sur un serveur VPS" excerpt: "Apprenez à configurer l'IPv6 sur votre serveur VPS OVHcloud" -updated: 2025-08-07 +updated: 2025-09-30 --- > [!primary] > Cet article concerne la configuration d'adresses IPv6 principales sur une interface publique. Vous pouvez également configurer des adresses Additional IP sur votre VPS en utilisant [ce guide](/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing). -> -> Veuillez noter que les Additional IP peuvent également être configurées dans un vRack (réseau privé), ce qui permet d'interconnecter une large gamme de services OVHcloud, offrant plus de flexibilité. -> -> Apprenez à configurer des Additional IP dans un vRack avec nos guides pour [IPv4](/pages/bare_metal_cloud/dedicated_servers/configuring-an-ip-block-in-a-vrack) et [IPv6](/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack). > ## Objectif diff --git a/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.it-it.md b/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.it-it.md index c9b088b5f6f..54001e11e46 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.it-it.md +++ b/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.it-it.md @@ -1,16 +1,12 @@ --- title: "Configurare IPv6 su un server VPS" excerpt: "Come configurare IPv6 sul tuo VPS OVHcloud" -updated: 2025-08-07 +updated: 2025-09-30 --- > [!primary] > Questo articolo riguarda la configurazione di indirizzi IPv6 principali su un'interfaccia pubblica. È inoltre possibile configurare gli indirizzi Additional IP sul VPS utilizzando [questa guida](/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing). > -> Ti ricordiamo che gli Additional IP possono essere configurati anche in una vRack (rete privata), per consentire l'interconnessione di un'ampia gamma di servizi OVHcloud e offrire una maggiore flessibilità. -> -> Scopri come configurare gli Additional IP in una vRack utilizzando le nostre guide per [IPv4](/pages/bare_metal_cloud/dedicated_servers/configuring-an-ip-block-in-a-vrack) e [IPv6](/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack). -> ## Obiettivo diff --git a/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.pl-pl.md b/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.pl-pl.md index 749e53ae47d..05f4f23b3ec 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.pl-pl.md +++ b/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.pl-pl.md @@ -1,16 +1,12 @@ --- title: "Konfiguracja IPv6 na serwerze VPS" excerpt: "Dowiedz się, jak skonfigurować IPv6 na VPS OVHcloud" -updated: 2025-08-07 +updated: 2025-09-30 --- > [!primary] > Ten artykuł dotyczy konfiguracji głównych adresów IPv6 w interfejsie publicznym. Możesz również skonfigurować adresy Additional IP na Twoim serwerze VPS, używając [tego przewodnika](/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing). > -> Pamiętaj, że adresy Additional IP mogą być również skonfigurowane w sieci vRack (sieć prywatna), co pozwala na połączenie szerokiej gamy usług OVHcloud i zapewnia większą elastyczność. -> -> Dowiedz się, jak skonfigurować dodatkowe adresy IP w sieci vRack za pomocą przewodników dla [IPv4](/pages/bare_metal_cloud/dedicated_servers/configuring-an-ip-block-in-a-vrack) i [IPv6](/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack). -> ## Wprowadzenie diff --git a/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.pt-pt.md b/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.pt-pt.md index ae7aa9476da..e88740dffba 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.pt-pt.md +++ b/pages/bare_metal_cloud/virtual_private_servers/configure-ipv6/guide.pt-pt.md @@ -1,16 +1,12 @@ --- title: "Configurar o IPv6 num VPS" excerpt: "Saiba como configurar o IPv6 num VPS da OVHcloud" -updated: 2025-08-07 +updated: 2025-09-30 --- > [!primary] > Este artigo é sobre a configuração de endereços IPv6 principais em uma interface pública. Também pode configurar endereços Additional IP no seu VPS utilizando [este manual](/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing). > -> Tenha em conta que os Additional IP podem igualmente ser configurados num vRack (rede privada), o que permite interligar uma vasta gama de serviços OVHcloud, oferecendo uma maior flexibilidade. -> -> Saiba como configurar o Additional IP num vRack com os nossos manuais para [IPv4](/pages/bare_metal_cloud/dedicated_servers/configuring-an-ip-block-in-a-vrack) e [IPv6](/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack). -> ## Objetivo diff --git a/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/guide.de-de.md b/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/guide.de-de.md index e6e9c5fa708..30a11c7f539 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/guide.de-de.md +++ b/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/guide.de-de.md @@ -1,9 +1,23 @@ --- title: "IP-Adresse als Alias konfigurieren" excerpt: "Erfahren Sie hier, wie Sie Additional IPs in Ihre VPS-Konfiguration einbinden" -updated: 2025-09-11 +updated: 2025-11-12 --- + + ## Ziel Bei *IP Aliasing* handelt es sich um eine spezielle Netzwerkkonfiguration für bestimme OVHcloud Dienste, mit der Sie mehrere IP-Adressen über ein einziges Netzwerkinterface verbinden können. @@ -44,423 +58,449 @@ Bitte beachten Sie, dass sich bei unterschiedlichen Distributionen die korrekte |NETWORK_INTERFACE|Name des Netzwerkinterfaces|*eth*, *ens3*| |ID|ID der Alias-IP, beginnend mit *0* (abhängig von der Anzahl der zu konfigurierenden zusätzlichen IP-Adressen)|*0*, *1*| -### Debian 11 - -#### Schritt 1: Automatische Netzwerkkonfiguration deaktivieren - -Öffnen Sie diesen Dateipfad mit einem Texteditor: - -```bash -sudo nano /etc/cloud/cloud.cfg.d/99-disable-network-config.cfg -``` - -Fügen Sie die folgende Zeile ein, speichern Sie und schließen Sie dann den Editor. - -```console -network: {config: disabled} -``` - -Die Erstellung dieser Konfigurationsdatei verhindert die automatische Ausführung von Änderungen an der Konfiguration Ihres Netzwerks. - -#### Schritt 2: Backup erstellen - -Standardmäßig ist der Pfad zur Konfigurationsdatei: `etc/network/interfaces.d`. - -In unserem Beispiel heißt die Datei `50-cloud-init`, also erstellen wir eine Kopie der Datei `50-cloud-init` mit folgenden Befehlen: - -```bash -sudo rm -f /etc/network/interfaces.d/50-cloud-init -sudo cp /etc/network/interfaces.d/50-cloud-init.bak /etc/network/interfaces.d/50-cloud-init -``` - -#### Schritt 3: Netzwerkkonfigurationsdatei bearbeiten - -Um den Namen Ihres Netzwerkinterfaces zu überprüfen, verwenden Sie folgenden Befehl: - -```bash -ip a -``` - -Öffnen Sie die Netzwerkkonfigurationsdatei zur Bearbeitung: - -```bash -sudo nano /etc/network/interfaces.d/50-cloud-init -``` - -Um Ihre Additional IP-Adresse zu konfigurieren, fügen Sie ein virtuelles Interface oder einen Ethernet-Alias zu Ihrem Netzwerkinterface hinzu. In unserem Beispiel heißt das Interface `eth0`, also ist unser erster Alias `eth0:0`. Tun Sie dies für jede Additional IP-Adresse, die Sie konfigurieren möchten. - -Ändern Sie keine vorhandenen Zeilen in der Konfigurationsdatei, sondern fügen Sie der Datei nur Ihre Additional IP-Adresse hinzu, indem Sie `NETWORK_INTERFACE`, `ID` und `ADDITIONAL_IP` durch eigene Werte ersetzen: - -```console -auto NETWORK_INTERFACE:ID -iface NETWORK_INTERFACE:ID inet static -address ADDITIONAL_IP -netmask 255.255.255.255 -``` - -Wenn Sie mehr als eine Additional IP-Adresse konfigurieren, sollte die Konfigurationsdatei wie folgt aussehen: - -```console -auto NETWORK_INTERFACE:ID -iface NETWORK_INTERFACE:ID inet static -address ADDITIONAL_IP1 -address ADDITIONAL_IP2 -netmask 255.255.255.255 -``` - -**Beispiel** - -```console -auto eth0:0 -iface eth0:0 inet static -address 203.0.113.0 -netmask 255.255.255.255 -``` - -#### Schritt 4: Interface neu starten - -Wenden Sie die Änderungen mit folgendem Befehl an: - -```bash -sudo systemctl restart networking -``` - -### Debian 12, Ubuntu 20.04 und höher - -Die Konfigurationsdatei für Ihre Additional IPs befindet sich in `/etc/netplan/`. In diesem Beispiel heißt sie `50-cloud-init.yaml`. - -Es empfiehlt sich, eine separate Konfigurationsdatei zu erstellen, in der die Additional IP-Adressen definiert werden. Auf diese Weise können Sie die Änderungen im Falle eines Fehlers leicht rückgängig machen. - -#### Schritt 1: Netzwerkkonfigurationsdatei erstellen - -In unserem Beispiel heißt die Datei `51-cloud-init.yaml`: - -```bash -sudo touch /etc/netplan/51-cloud-init.yaml -``` - -#### Schritt 2: Netzwerkkonfigurationsdatei bearbeiten +In den folgenden Beispielen verwenden wir den Texteditor `nano`. Auf einigen Betriebssystemen müssen Sie diesen erst installieren, bevor Sie ihn verwenden können. In diesem Fall werden Sie dazu aufgefordert. Sie können natürlich auch einen Texteditor Ihrer Wahl verwenden. -Um den Namen Ihres Netzwerkinterfaces zu überprüfen, verwenden Sie folgenden Befehl: - -```bash -ip a -``` - -Öffnen Sie die Netzwerkkonfigurationsdatei zur Bearbeitung: - -```bash -sudo nano /etc/netplan/51-cloud-init.yaml -``` - -Editieren Sie die Datei mit dem unten stehenden Inhalt und ersetzen Sie `INTERFACE_NAME` und `ADDITIONAL_IP` durch Ihre eigenen Werte: - -```yaml -network: - version: 2 - ethernets: - INTERFACE_NAME: - dhcp4: true - addresses: - - ADDITIONAL_IP/32 -``` - -Wenn Sie mehr als eine Additional IP-Adresse konfigurieren müssen, sollte die Konfigurationsdatei wie folgt aussehen: - -```yaml -network: - version: 2 - ethernets: - INTERFACE_NAME: - dhcp4: true - addresses: - - ADDITIONAL_IP1/32 - - ADDITIONAL_IP2/32 -``` - -> [!warning] +> [!success] +> Wählen Sie den Tab für Ihr Betriebssystem. > -> Es ist wichtig, dass die Zeilenausrichtung jedes Elements dieser Datei, wie im Beispiel dargestellt, eingehalten wird. Verwenden Sie nicht die Tabulationstaste, um den Abstand zu erzeugen. -> - -**Beispiel** - -```yaml -network: - version: 2 - ethernets: - eth0: - dhcp4: true - addresses: - - 203.0.113.0/32 -``` - -Speichern und schließen Sie die Datei. - -#### Schritt 3: Neue Netzwerkkonfiguration anwenden - -Sie können Ihre Konfiguration mit folgendem Befehl testen: - -```bash -sudo netplan try -``` - -Ist die Änderung korrekt, verwenden Sie folgenden Befehl, um sie anzuwenden: - -```bash -sudo netplan apply -``` - -Wiederholen Sie diesen Vorgang für jede Additional IP-Adresse. - -### AlmaLinux (8 & 9), Rocky Linux (8 & 9) - -Die Hauptkonfigurationsdatei befindet sich im Ordner `/etc/sysconfig/network-scripts/`. In diesem Beispiel ist es `ifcfg-eth0`. Überprüfen Sie den Dateinamen in Ihrem Ordner, bevor Sie Änderungen vornehmen. - -Erstellen Sie für jede zu konfigurierende Additional IP-Adresse eine separate Konfigurationsdatei mit den folgenden Einstellungen: `ifcfg-NETWORK_INTERFACE:ID`. Dabei steht `NETWORK_INTERFACE` für die physische Schnittstelle und `ID` für die virtuelle Netzwerkschnittstelle oder den Ethernet-Alias, der mit einem Wert von 0 beginnt. Für unsere Schnittstelle `eth0` ist der erste Alias beispielsweise `eth0:0`, der zweite Alias ist `eth0:1` usw. - -#### Schritt 1: Netzwerkkonfigurationsdatei bearbeiten - -Um den Namen Ihres Netzwerkinterfaces zu überprüfen, verwenden Sie folgenden Befehl: - -```bash -ip a -``` - -#### Schritt 2: Netzwerkkonfigurationsdatei erstellen - -Erstellen Sie zuerst die Konfigurationsdatei. Ersetzen Sie `NETWORK_INTERFACE:ID` durch eigene Werte. - -```bash -sudo nano /etc/sysconfig/network-scripts/ifcfg-NETWORK_INTERFACE:ID -``` - -Bearbeiten Sie anschließend die Datei mit folgendem Inhalt und ersetzen Sie `NETWORK_INTERFACE:ID` und `ADDITIONAL_IP` durch Ihre eigenen Werte: - -```console -DEVICE=NETWORK_INTERFACE:ID -BOOTPROTO=static -IPADDR=ADDITIONAL_IP -NETMASK=255.255.255.255 -BROADCAST=ADDITIONAL_IP -ONBOOT=yes -``` - -**Beispiel** -```console -DEVICE=eth0:0 -ONBOOT=yes -BOOTPROTO=static -IPADDR=203.0.113.0 -NETMASK=255.255.255.255 -BROADCAST=203.0.113.0 -``` -#### Schritt 3: Interface neu starten - -Wenden Sie die Änderungen mit folgendem Befehl an: - -```bash -sudo systemctl restart network -``` - -#### AlmaLinux und Rocky Linux - -```bash -sudo systemctl restart NetworkManager -``` - -### Fedora 37 und höher - -Fedora verwendet Schlüsseldateien. NetworkManager hat zuvor Netzwerkprofile im Format ifcfg in diesem Verzeichnis gespeichert: `/etc/sysconfig/network-scripts/`. Da ifcfg nicht mehr unterstützt wird, erstellt NetworkManager keine neuen Profile mehr in diesem Format. Die Konfigurationsdatei befindet sich nun in `/etc/NetworkManager/system-connections/`. - -#### Schritt 1: Backup erstellen - -In unserem Beispiel heißt die Datei `cloud-init-eno1.nmconnection`, daher erstellen wir eine Kopie der Datei `cloud-init-eno1.nmconnection` mit folgendem Befehl: - -```bash -sudo cp -r /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak -``` - -Wenn Sie einen Fehler gemacht haben, können Sie die Änderungen mit den folgenden Befehlen rückgängig machen: - -```bash -sudo rm -f /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -sudo cp /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -``` - -#### Schritt 2: Netzwerkkonfigurationsdatei bearbeiten - -> [!primary] -> Beachten Sie, dass der Name der Netzwerkdatei in unserem Beispiel von Ihrem Namen abweichen kann. Passen Sie die Befehle an Ihren Dateinamen an. -> - -```bash -sudo nano /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -``` - -Ändern Sie keine bestehenden Zeilen in der Konfigurationsdatei. Fügen Sie Ihre Additional IP wie folgt zur Datei hinzu und ersetzen Sie `ADDITIONAL_IP/32` durch Ihre eigenen Werte: - -```console -[ipv4] -method=auto -may-fail=false -address1=ADDITIONAL_IP/32 -``` - -Wenn Sie zwei Additional IPs konfigurieren müssen, sollte die Konfiguration folgendermaßen aussehen: - -```console -[ipv4] -method=auto -may-fail=false -address1=ADDITIONAL_IP1/32 -address2=ADDITIONAL_IP2/32 -``` - -**Beispiel** - -```console -[ipv4] -method=auto -may-fail=false -address1=203.0.113.0/32 -``` - -#### Schritt 3: Interface neu starten - -Starten Sie Ihr Interface neu: - -```bash -sudo systemctl restart NetworkManager -``` - -### cPanel - -#### Schritt 1: Auf den Bereich IP-Verwaltung des WHM zugreifen - -Klicken Sie im WHM Interface auf `IP Functions`{.action} und wählen Sie `Add a New IP Address`{.action} im Menü auf der linken Seite. - -![Add new IP](images/cpanel-alma-1.png){.thumbnail} - -#### Schritt 2: Additional IP-Informationen hinzufügen - -Geben Sie Ihre Additional IP-Adresse in der Form "xxx.xxx.xxx.xxx" in das Feld "New IP or IP range to add" ein. - -Wählen Sie `255.255.255.255` als Subnetzmaske aus, und klicken Sie dann auf `Submit`{.action}. - -![Enter new IP information](images/cpanel-alma-2.png){.thumbnail} - -> [!warning] -> -> Achtung: Wenn Sie mehrere IP-Adressen auf einem Block konfigurieren müssen und alle gleichzeitig hinzufügen, erzwingt das WHM-System die Subnetzmaske `255.255.255.0`. Es wird nicht empfohlen, diese Konfiguration zu verwenden. Sie müssen jede IP einzeln hinzufügen, um die entsprechende Subnetzmaske `255.255.255.255` verwenden zu können. -> - -#### Schritt 3: Aktuelle IP-Konfiguration überprüfen - -Zurück im Abschnitt `IP Functions`{.action}, klicken Sie auf `Show or Delete Current IP Addresses`{.action}, um zu überprüfen, dass die Additional IP korrekt hinzugefügt wurde. - -![check configured IP](images/cpanel-alma-3.png){.thumbnail} - -### Plesk - -#### Schritt 1: Auf die IP-Verwaltung von Plesk zugreifen - -Wählen Sie im Plesk Konfigurationspanel `Tools & Settings`{.action} im linken Menü aus. - -![Zugang zur Verwaltung der IP-Adressen](images/pleskip1.png){.thumbnail} - -Klicken Sie auf `IP Addresses`{.action} unter **Tools & Resources**. - -#### Schritt 2: Die zusätzliche IP-Information hinzufügen - -Klicken Sie in diesem Abschnitt auf den Button `Add IP Address`{.action}. - -![IP-Informationen hinzufügen](images/Plesk-2024-vps.png){.thumbnail} - -Geben Sie Ihre Additional IP in der Form `xxx.xxx.xxx.xxx/32` in das Feld "IP address and subnet mask" ein und klicken Sie dann auf `OK`{.action}. - -![IP-Informationen hinzufügen](images/Plesk-additional-ip.png){.thumbnail} - -#### Schritt 3: Aktuelle IP-Konfiguration überprüfen - -Überprüfen Sie im Bereich "IP Addresses" ob die Additional IP korrekt hinzugefügt wurde. - -![aktuelle IP-Konfiguration](images/plesk-final-configuration.png){.thumbnail} - -### Windows Server - -#### Schritt 1: Netzwerkkonfiguration überprüfen - -Klicken Sie mit der rechten Maustaste auf `Start`{.action} und öffnen Sie `Run`{.action}. - -Geben Sie `cmd` ein und klicken Sie auf `OK`{.action}, um die Eingabeaufforderung zu öffnen. - -![cmdprompt](images/vps_win07.png){.thumbnail} - -Um die aktuelle IP-Konfiguration anzuzeigen, geben Sie `ipconfig` ein. - -```console -C:\Users\Administrator>ipconfig -Windows IP Configuration -Ethernet adapter Ethernet: - Connection-specific DNS Suffix . : openstacklocal - Link-local IPv6 Address . . . . . : fe90::30gf:258a:84d6:abcf%5 - IPv4 Address. . . . . . . . . . . : 192.0.2.29 - Subnet Mask . . . . . . . . . . . : 255.255.255.255 - Default Gateway . . . . . . . . . : 192.0.2.1 -``` - -#### Schritt 2: IPv4 Eigenschaften ändern - -Die IP-Eigenschaften müssen nun zu einer statischen Konfiguration geändert werden. - -1. Gehen Sie in das Menü `Start`{.action}, dann `Control Panel`{.action}, `Network and Internet`{.action}, `Network and Sharing Centre`{.action} und `Change Adapter Settings`{.action} in der linken Leiste. -2. Klicken Sie mit der rechten Maustaste auf `Ethernet`{.action}. -3. Klicken Sie auf `Properties`{.action}; -4. Wählen Sie `Internet Protocol Version 4 (TCP/IPv4)`{.action} aus, und klicken Sie auf `Properties`{.action}; -5. Klicken Sie auf `Use the following IP address`{.action} und geben Sie die Haupt-IP Ihres Servers, die Subnetzmaske und das Standardgateway ein, die Sie über den Befehl `ipconfig`{.action} erhalten haben. Geben Sie im Feld "Preferred DNS Server" `213.186.33.99` ein. - -![change the IP configuration](images/configure-main-ip.png){.thumbnail} - -> [!warning] -> -> Achtung, der Server wird unerreichbar, wenn Sie falsche Informationen eingeben. In diesem Fall sind Korrekturen über das KVM-Interface erforderlich. -> - -#### Schritt 3: Die Additional IP in "Erweiterte TCP/IP Einstellungen" hinzufügen - -Klicken Sie im neuen Fenster auf `Add...`{.action} unter "IP addresses". Geben Sie Ihre Additional IP und die Subnetzmaske (255.255.255.255) ein. - -![Advance Configuration section](images/configure-additional-ip.png){.thumbnail} - -Bestätigen Sie, indem Sie auf `Add`{.action} klicken. - -![Additional IP configuration](images/additional-ip-config.png){.thumbnail} - -Klicken Sie dann auf `OK`{.action}, um die Konfiguration zu übernehmen. - -![Additional IP configuration](images/final-configuration.png){.thumbnail} - -Die Verbindung zu Ihrem Server wird für einige Sekunden unterbrochen. - -#### Schritt 4: Neue Netzwerkkonfiguration überprüfen - -Öffnen Sie die Eingabeaufforderung (cmd), und geben Sie `ipconfig` ein. Die Konfiguration muss nun die neue Additional IP-Adresse enthalten. - -```console -C:\Users\Administrator>ipconfig -Windows IP Configuration -Ethernet adapter Ethernet: - Connection-specific DNS Suffix . : - Link-local IPv6 Address . . . . . : fe90::30gf:258a:84d6:abcf%5 - IPv4 Address. . . . . . . . . . . : 192.0.2.29 - Subnet Mask . . . . . . . . . . . : 255.255.255.255 - IPv4 Address. . . . . . . . . . . : 203.0.113.0 - Subnet Mask . . . . . . . . . . . : 255.255.255.255 - Default Gateway . . . . . . . . . : 192.0.2.1 -``` +> [!tabs] +> **Debian 11** +>> Debian 11 +>> +>> **Schritt 1: Automatische Netzwerkkonfiguration deaktivieren** +>> +>> Öffnen Sie diesen Dateipfad mit einem Texteditor: +>> +>> ```bash +>> sudo nano /etc/cloud/cloud.cfg.d/99-disable-network-config.cfg +>> ``` +>> +>> Fügen Sie die folgende Zeile ein, speichern Sie und schließen Sie dann den Editor. +>> +>> ```console +>> network: {config: disabled} +>> ``` +>> +>> Die Erstellung dieser Konfigurationsdatei verhindert die automatische Ausführung von Änderungen an der Konfiguration Ihres Netzwerks. +>> +>> **Schritt 2: Backup erstellen** +>> +>> Standardmäßig ist der Pfad zur Konfigurationsdatei: `etc/network/interfaces.d`. +>> +>> In unserem Beispiel heißt die Datei `50-cloud-init`, also erstellen wir eine Kopie der Datei `50-cloud-init` mit folgenden Befehlen: +>> +>> ```bash +>> sudo rm -f /etc/network/interfaces.d/50-cloud-init +>> sudo cp /etc/network/interfaces.d/50-cloud-init.bak /etc/network/interfaces.d/50-cloud-init +>> ``` +>> +>> **Schritt 3: Netzwerkkonfigurationsdatei bearbeiten** +>> +>> Um den Namen Ihres Netzwerkinterfaces zu überprüfen, verwenden Sie folgenden Befehl: +>> +>> ```bash +>> ip a +>> ``` +>> +>> Öffnen Sie die Netzwerkkonfigurationsdatei zur Bearbeitung: +>> +>> ```bash +>> sudo nano /etc/network/interfaces.d/50-cloud-init +>> ``` +>> +>> Um Ihre Additional IP-Adresse zu konfigurieren, fügen Sie ein virtuelles Interface oder einen Ethernet-Alias zu Ihrem Netzwerkinterface hinzu. In unserem Beispiel heißt das Interface `eth0`, also ist unser erster Alias `eth0:0`. Tun Sie dies für jede Additional IP-Adresse, die Sie konfigurieren möchten. +>> +>> Ändern Sie keine vorhandenen Zeilen in der Konfigurationsdatei, sondern fügen Sie der Datei nur Ihre Additional IP-Adresse hinzu, indem Sie `NETWORK_INTERFACE`, `ID` und `ADDITIONAL_IP` durch eigene Werte ersetzen: +>> +>> ```console +>> auto NETWORK_INTERFACE:ID +>> iface NETWORK_INTERFACE:ID inet static +>> address ADDITIONAL_IP +>> netmask 255.255.255.255 +>> ``` +>> +>> Wenn Sie mehr als eine Additional IP-Adresse konfigurieren, sollte die Konfigurationsdatei wie folgt aussehen: +>> +>> ```console +>> auto NETWORK_INTERFACE:ID +>> iface NETWORK_INTERFACE:ID inet static +>> address ADDITIONAL_IP1 +>> address ADDITIONAL_IP2 +>> netmask 255.255.255.255 +>> ``` +>> +>> /// details | **Beispiel** +>> +>> ```console +>> auto eth0:0 +>> iface eth0:0 inet static +>> address 203.0.113.0 +>> netmask 255.255.255.255 +>> ``` +>> +>> /// +>> +>> **Schritt 4: Interface neu starten** +>> +>> Wenden Sie die Änderungen mit folgendem Befehl an: +>> +>> ```bash +>> sudo systemctl restart networking +>> ``` +>> +> **Debian 12, Ubuntu 22.04+** +>> Debian 12, Ubuntu 22.04 und höher +>> +>> Die Konfigurationsdatei für Ihre Additional IPs befindet sich in `/etc/netplan/`. In diesem Beispiel heißt sie `50-cloud-init.yaml`. +>> +>> Es empfiehlt sich, eine separate Konfigurationsdatei zu erstellen, in der die Additional IP-Adressen definiert werden. Auf diese Weise können Sie die Änderungen im Falle eines Fehlers leicht rückgängig machen. +>> +>> **Schritt 1: Netzwerkkonfigurationsdatei erstellen** +>> +>> In unserem Beispiel heißt die Datei `51-cloud-init.yaml`: +>> +>> ```bash +>> sudo touch /etc/netplan/51-cloud-init.yaml +>> ``` +>> +>> **Schritt 2: Netzwerkkonfigurationsdatei bearbeiten** +>> +>> Um den Namen Ihres Netzwerkinterfaces zu überprüfen, verwenden Sie folgenden Befehl: +>> +>> ```bash +>> ip a +>> ``` +>> +>> Öffnen Sie die Netzwerkkonfigurationsdatei zur Bearbeitung: +>> +>> ```bash +>> sudo nano /etc/netplan/51-cloud-init.yaml +>> ``` +>> +>> Editieren Sie die Datei mit dem unten stehenden Inhalt und ersetzen Sie `INTERFACE_NAME` und `ADDITIONAL_IP` durch Ihre eigenen Werte: +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> INTERFACE_NAME: +>> dhcp4: true +>> addresses: +>> - ADDITIONAL_IP1/32 +>> ``` +>> +>> Wenn Sie mehr als eine Additional IP-Adresse konfigurieren müssen, sollte die Konfigurationsdatei wie folgt aussehen: +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> INTERFACE_NAME: +>> dhcp4: true +>> addresses: +>> - ADDITIONAL_IP1/32 +>> - ADDITIONAL_IP2/32 +>> ``` +>> +>> > [!warning] +>> > +>> > Es ist wichtig, dass die Zeilenausrichtung jedes Elements dieser Datei, wie im Beispiel dargestellt, eingehalten wird. Verwenden Sie nicht die Tabulationstaste, um den Abstand zu erzeugen. +>> > +>> +>> /// details | **Beispiel** +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> eth0: +>> dhcp4: true +>> addresses: +>> - 203.0.113.0/32 +>> ``` +>> /// +>> +>> Speichern und schließen Sie die Datei. +>> +>> **Schritt 3: Neue Netzwerkkonfiguration anwenden** +>> +>> Sie können Ihre Konfiguration mit folgendem Befehl testen: +>> +>> ```bash +>> sudo netplan try +>> ``` +>> +>> Ist die Änderung korrekt, verwenden Sie folgenden Befehl, um sie anzuwenden: +>> +>> ```bash +>> sudo netplan apply +>> ``` +>> +>> Wiederholen Sie diesen Vorgang für jede Additional IP-Adresse. +>> +> **AlmaLinux / Rocky Linux** +>> AlmaLinux (8/9/10), Rocky Linux (8/9/10) +>> +>> Die Hauptkonfigurationsdatei befindet sich im Ordner `/etc/sysconfig/network-scripts/`. In diesem Beispiel ist es `ifcfg-eth0`. Überprüfen Sie den Dateinamen in Ihrem Ordner, bevor Sie Änderungen vornehmen. +>> +>> Erstellen Sie für jede zu konfigurierende Additional IP-Adresse eine separate Konfigurationsdatei mit den folgenden Einstellungen: `ifcfg-NETWORK_INTERFACE:ID`. Dabei steht `NETWORK_INTERFACE` für die physische Schnittstelle und `ID` für die virtuelle Netzwerkschnittstelle oder den Ethernet-Alias, der mit einem Wert von 0 beginnt. Für unsere Schnittstelle `eth0` ist der erste Alias beispielsweise `eth0:0`, der zweite Alias ist `eth0:1` usw. +>> +>> **Schritt 1: Netzwerkkonfigurationsdatei bearbeiten** +>> +>> Um den Namen Ihres Netzwerkinterfaces zu überprüfen, verwenden Sie folgenden Befehl: +>> +>> ```bash +>> ip a +>> ``` +>> +>> **Schritt 2: Netzwerkkonfigurationsdatei erstellen** +>> +>> Erstellen Sie zuerst die Konfigurationsdatei. Ersetzen Sie `NETWORK_INTERFACE:ID` durch eigene Werte. +>> +>> ```bash +>> sudo nano /etc/sysconfig/network-scripts/ifcfg-NETWORK_INTERFACE:ID +>> ``` +>> +>> Bearbeiten Sie anschließend die Datei mit folgendem Inhalt und ersetzen Sie `NETWORK_INTERFACE:ID` und `ADDITIONAL_IP` durch Ihre eigenen Werte: +>> +>> ```console +>> DEVICE=NETWORK_INTERFACE:ID +>> BOOTPROTO=static +>> IPADDR=ADDITIONAL_IP +>> NETMASK=255.255.255.255 +>> BROADCAST=ADDITIONAL_IP +>> ONBOOT=yes +>> ``` +>> +>> /// details | **Beispiel** +>> +>> ```console +>> DEVICE=eth0:0 +>> ONBOOT=yes +>> BOOTPROTO=none # For CentOS use "static" +>> IPADDR=203.0.113.0 +>> NETMASK=255.255.255.255 +>> BROADCAST=203.0.113.0 +>> ``` +>> /// +>> +>> **Schritt 3: Interface neu starten** +>> +>> Wenden Sie die Änderungen mit folgendem Befehl an: +>> +>> ```bash +>> sudo systemctl restart network +>> ``` +>> +>> AlmaLinux und Rocky Linux +>> +>> ```bash +>> sudo systemctl restart NetworkManager +>> ``` +>> +> **Fedora 42** +>> Fedora 42 +>> +>> Fedora verwendet Schlüsseldateien. NetworkManager hat zuvor Netzwerkprofile im Format ifcfg in diesem Verzeichnis gespeichert: `/etc/sysconfig/network-scripts/`. Da ifcfg nicht mehr unterstützt wird, erstellt NetworkManager keine neuen Profile mehr in diesem Format. Die Konfigurationsdatei befindet sich nun in `/etc/NetworkManager/system-connections/`. +>> +>> **Schritt 1: Backup erstellen** +>> +>> In unserem Beispiel heißt die Datei `cloud-init-eno1.nmconnection`, daher erstellen wir eine Kopie der Datei `cloud-init-eno1.nmconnection` mit folgendem Befehl: +>> +>> ```bash +>> sudo cp -r /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak +>> ``` +>> +>> Wenn Sie einen Fehler gemacht haben, können Sie die Änderungen mit den folgenden Befehlen rückgängig machen: +>> +>> ```bash +>> sudo rm -f /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> sudo cp /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> ``` +>> +>> **Schritt 2: Netzwerkkonfigurationsdatei bearbeiten** +>> +>> > [!primary] +>> > Beachten Sie, dass der Name der Netzwerkdatei in unserem Beispiel von Ihrem Namen abweichen kann. Passen Sie die Befehle an Ihren Dateinamen an. +>> > +>> +>> ```bash +>> sudo nano /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> ``` +>> +>> Ändern Sie keine bestehenden Zeilen in der Konfigurationsdatei. Fügen Sie Ihre Additional IP wie folgt zur Datei hinzu und ersetzen Sie `ADDITIONAL_IP/32` durch Ihre eigenen Werte: +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=ADDITIONAL_IP/32 +>> ``` +>> +>> Wenn Sie zwei Additional IPs konfigurieren müssen, sollte die Konfiguration folgendermaßen aussehen: +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=ADDITIONAL_IP1/32 +>> address2=ADDITIONAL_IP2/32 +>> ``` +>> +>> /// details | **Beispiel** +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=203.0.113.0/32 +>> ``` +>> /// +>> +>> **Schritt 3: Interface neu starten** +>> +>> Starten Sie Ihr Interface neu: +>> +>> ```bash +>> sudo systemctl restart NetworkManager +>> ``` +>> +> **cPanel** +>> cPanel +>> +>> **Schritt 1: Auf den Bereich IP-Verwaltung des WHM zugreifen** +>> +>> Klicken Sie im WHM Interface auf `IP Functions`{.action} und wählen Sie `Add a New IP Address`{.action} im Menü auf der linken Seite. +>> +>> ![Add new IP](images/cpanel-alma-1.png){.thumbnail} +>> +>> **Schritt 2: Additional IP-Informationen hinzufügen** +>> +>> Geben Sie Ihre Additional IP-Adresse in der Form "xxx.xxx.xxx.xxx" in das Feld "New IP or IP range to add" ein. +>> +>> Wählen Sie `255.255.255.255` als Subnetzmaske aus, und klicken Sie dann auf `Submit`{.action}. +>> +>> ![Enter new IP information](images/cpanel-alma-2.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Achtung: Wenn Sie mehrere IP-Adressen auf einem Block konfigurieren müssen und alle gleichzeitig hinzufügen, erzwingt das WHM-System die Subnetzmaske `255.255.255.0`. Es wird nicht empfohlen, diese Konfiguration zu verwenden. Sie müssen jede IP einzeln hinzufügen, um die entsprechende Subnetzmaske `255.255.255.255` verwenden zu können. +>> > +>> +>> **Schritt 3: Aktuelle IP-Konfiguration überprüfen** +>> +>> Zurück im Abschnitt `IP Functions`{.action}, klicken Sie auf `Show or Delete Current IP Addresses`{.action}, um zu überprüfen, dass die Additional IP korrekt hinzugefügt wurde. +>> +>> ![check configured IP](images/cpanel-alma-3.png){.thumbnail} +>> +> **Plesk** +>> Plesk +>> +>> **Schritt 1: Auf die IP-Verwaltung von Plesk zugreifen** +>> +>> Wählen Sie im Plesk Konfigurationspanel `Tools & Settings`{.action} im linken Menü aus. +>> +>> ![Zugang zur Verwaltung der IP-Adressen](images/pleskip1.png){.thumbnail} +>> +>> Klicken Sie auf `IP Addresses`{.action} unter **Tools & Resources**. +>> +>> **Schritt 2: Die zusätzliche IP-Information hinzufügen** +>> +>> Klicken Sie in diesem Abschnitt auf den Button `Add IP Address`{.action}. +>> +>> ![IP-Informationen hinzufügen](images/Plesk-2024-vps.png){.thumbnail} +>> +>> Geben Sie Ihre Additional IP in der Form `xxx.xxx.xxx.xxx/32` in das Feld "IP address and subnet mask" ein und klicken Sie dann auf `OK`{.action}. +>> +>> ![IP-Informationen hinzufügen](images/Plesk-additional-ip.png){.thumbnail} +>> +>> **Schritt 3: Aktuelle IP-Konfiguration überprüfen** +>> +>> Überprüfen Sie im Bereich "IP Addresses" ob die Additional IP korrekt hinzugefügt wurde. +>> +>> ![aktuelle IP-Konfiguration](images/plesk-final-configuration.png){.thumbnail} +>> +> **Windows Server** +>> Windows Server +>> +>> **Schritt 1: Netzwerkkonfiguration überprüfen** +>> +>> Klicken Sie mit der rechten Maustaste auf `Start`{.action} und öffnen Sie `Run`{.action}. +>> +>> Geben Sie `cmd` ein und klicken Sie auf `OK`{.action}, um die Eingabeaufforderung zu öffnen. +>> +>> ![cmdprompt](images/vps_win07.png){.thumbnail} +>> +>> Um die aktuelle IP-Konfiguration anzuzeigen, geben Sie `ipconfig` ein. +>> +>> ```console +>> C:\Users\Administrator>ipconfig +>> +>> Windows IP Configuration +>> +>> Ethernet adapter Ethernet: +>> +>> Connection-specific DNS Suffix . : openstacklocal +>> Link-local IPv6 Address . . . . . : fe90::30gf:258a:84d6:abcf%5 +>> IPv4 Address. . . . . . . . . . . : 192.0.2.29 +>> Subnet Mask . . . . . . . . . . . : 255.255.255.255 +>> Default Gateway . . . . . . . . . : 192.0.2.1 +>> ``` +>> +>> **Schritt 2: IPv4 Eigenschaften ändern** +>> +>> Die IP-Eigenschaften müssen nun zu einer statischen Konfiguration geändert werden. +>> +>> 1. Gehen Sie in das Menü `Start`{.action}, dann `Control Panel`{.action}, `Network and Internet`{.action}, `Network and Sharing Centre`{.action} und `Change Adapter Settings`{.action} in der linken Leiste. +>> 2. Klicken Sie mit der rechten Maustaste auf `Ethernet`{.action}. +>> 3. Klicken Sie auf `Properties`{.action}; +>> 4. Wählen Sie `Internet Protocol Version 4 (TCP/IPv4)`{.action} aus, und klicken Sie auf `Properties`{.action}; +>> 5. Klicken Sie auf `Use the following IP address`{.action} und geben Sie die Haupt-IP Ihres Servers, die Subnetzmaske und das Standardgateway ein, die Sie über den Befehl `ipconfig`{.action} erhalten haben. Geben Sie im Feld "Preferred DNS Server" `213.186.33.99` ein. +>> +>> ![change the IP configuration](images/configure-main-ip.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Achtung, der Server wird unerreichbar, wenn Sie falsche Informationen eingeben. In diesem Fall sind Korrekturen über das KVM-Interface erforderlich. +>> > +>> +>> **Schritt 3: Die Additional IP in "Erweiterte TCP/IP Einstellungen" hinzufügen** +>> +>> Klicken Sie im neuen Fenster auf `Add...`{.action} unter "IP addresses". Geben Sie Ihre Additional IP und die Subnetzmaske (255.255.255.255) ein. +>> +>> ![Advance Configuration section](images/configure-additional-ip.png){.thumbnail} +>> +>> Bestätigen Sie, indem Sie auf `Add`{.action} klicken. +>> +>> ![Additional IP configuration](images/additional-ip-config.png){.thumbnail} +>> +>> Klicken Sie dann auf `OK`{.action}, um die Konfiguration zu übernehmen. +>> +>> ![Additional IP configuration](images/final-configuration.png){.thumbnail} +>> +>> Die Verbindung zu Ihrem Server wird für einige Sekunden unterbrochen. +>> +>> **Schritt 4: Neue Netzwerkkonfiguration überprüfen** +>> +>> Öffnen Sie die Eingabeaufforderung (cmd), und geben Sie `ipconfig` ein. Die Konfiguration muss nun die neue Additional IP-Adresse enthalten. +>> +>> ```console +>> C:\Users\Administrator>ipconfig +>> +>> Windows IP Configuration +>> +>> Ethernet adapter Ethernet: +>> +>> Connection-specific DNS Suffix . : +>> Link-local IPv6 Address . . . . . : fe90::30gf:258a:84d6:abcf%5 +>> IPv4 Address. . . . . . . . . . . : 192.0.2.29 +>> Subnet Mask . . . . . . . . . . . : 255.255.255.255 +>> IPv4 Address. . . . . . . . . . . : 203.0.113.0 +>> Subnet Mask . . . . . . . . . . . : 255.255.255.255 +>> Default Gateway . . . . . . . . . : 192.0.2.1 +>> ``` ### Diagnose @@ -480,4 +520,4 @@ Um die Verbindung zu testen senden Sie einfach von außerhalb einen Ping an Ihre Wenn Sie Hilfe bei der Nutzung und Konfiguration Ihrer OVHcloud Lösungen benötigen, beachten Sie unsere [Support-Angebote](/links/support). -Für den Austausch mit unserer User Community gehen Sie auf +Für den Austausch mit unserer [User Community](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/guide.en-gb.md b/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/guide.en-gb.md index f801884c19d..d446c8dd27c 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/guide.en-gb.md +++ b/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/guide.en-gb.md @@ -1,9 +1,23 @@ --- title: How to configure IP aliasing excerpt: Find out how to add Additional IP addresses to your VPS configuration -updated: 2025-09-11 +updated: 2025-11-12 --- + + ## Objective IP aliasing refers to a special network configuration for certain OVHcloud services. Additional IPs allow you to associate multiple IP addresses with a single network interface. @@ -44,432 +58,449 @@ Concerning different distribution releases, please note that the proper procedur |NETWORK_INTERFACE|The name of the network interface|*eth0*, *ens3*| |ID|ID of the IP alias, starting with *0* (depending on the number of additional IPs there are to configure)|*0*, *1*| -### Debian 11 - -#### Step 1: Disable automatic network configuration - -Open the following file path with a text editor, in our example, we are using `nano`. - -```bash -sudo nano /etc/cloud/cloud.cfg.d/99-disable-network-config.cfg -``` -Enter the following line, then save and exit the editor. - -```console -network: {config: disabled} -``` -Creating this configuration file will prevent changes to your network configuration from being made automatically. - -#### Step 2: Create a backup - -By default, the configuration file is located in the path `etc\network\interfaces.d`. - -In our example, our file is called `50-cloud-init`, so we make a copy of the `50-cloud-init` file using the following command: - -```bash -sudo cp /etc/network/interfaces.d/50-cloud-init /etc/network/interfaces.d/50-cloud-init.bak -``` - -In case of a mistake, you will be able to revert the changes, using the commands below: - -```bash -sudo rm -f /etc/network/interfaces.d/50-cloud-init -sudo cp /etc/network/interfaces.d/50-cloud-init.bak /etc/network/interfaces.d/50-cloud-init -``` -#### Step 3: Edit the configuration file - -The first step is to verify your network interface name with this command: - -```bash -ip a -``` - -Next, open the network configuration file for editing with the following command: - -```bash -sudo nano /etc/network/interfaces.d/50-cloud-init -``` - -To configure your Additional IP, you need to add a virtual interface or ethernet alias to your network interface. In our example, our interface is called `eth0`, so our first alias is `eth0:0`. Do this for each Additional IP you wish to configure. - -Do not modify the existing lines in the configuration file, simply add your Additional IP to the file as follows, replacing `NETWORK_INTERFACE`, `ID` and `ADDITIONAL_IP` wih your own values: - - -```console -auto NETWORK_INTERFACE:ID -iface NETWORK_INTERFACE:ID inet static -address ADDITIONAL_IP -netmask 255.255.255.255 -``` - -If you are configuring more than one Additional IP, your configuration file should look like this: - -```console -auto NETWORK_INTERFACE:ID -iface NETWORK_INTERFACE:ID inet static -address ADDITIONAL_IP1 -address ADDITIONAL_IP2 -netmask 255.255.255.255 -``` - -**Configuration example:** - -```console -auto eth0:0 -iface eth0:0 inet static -address 203.0.113.0 -netmask 255.255.255.255 -``` - -#### Step 4: Restart the interface - -Apply the changes with the following command: - -```bash -sudo systemctl restart networking -``` - -### Debian 12, Ubuntu 20.04 and following - -The configuration file for your Additional IP addresses is located in the folder `/etc/netplan/`. In this example it is called `50-cloud-init.yaml`. - -The best practice approach is to create a separate configuration file to set up Additional IP addresses. This way, you can easily revert the changes in case of an error. - -#### Step 1: Create the network configuration file - -In our example, our file is call `51-cloud-init.yaml`: - -```bash -sudo touch /etc/netplan/51-cloud-init.yaml -``` - -#### Step 2: Edit the configuration file +In the examples below, we will use the `nano` text editor. With some operating systems, you will need to install it first before using it. If this is the case, you will be prompted to do so. You can, of course, use the text editor of your choice. -You can verify your network interface name with this command: - -```bash -ip a -``` - -Next, open the network configuration file for editing with the following command: - -```bash -sudo nano /etc/netplan/51-cloud-init.yaml -``` - -Edit the file with the content below, replacing `INTERFACE_NAME` and `ADDITIONAL_IP` with your own values: - -```yaml -network: - version: 2 - ethernets: - INTERFACE_NAME: - dhcp4: true - addresses: - - ADDITIONAL_IP/32 -``` - -If you have more Additional IPs to configure, the configuration file should look like this: - -```yaml -network: - version: 2 - ethernets: - INTERFACE_NAME: - dhcp4: true - addresses: - - ADDITIONAL_IP1/32 - - ADDITIONAL_IP2/32 -``` - -> [!warning] +> [!success] +> Select the tab corresponding to your operating system. > -> It is important to respect the alignment of each element in this file as represented in the example above. Do not use the tab key to create your spacing. -> - -**Configuration example:** - -```yaml -network: - version: 2 - ethernets: - eth0: - dhcp4: true - addresses: - - 203.0.113.0/32 -``` - -Save and close the file. - -#### Step 3: Apply the new network configuration - -You can test your configuration using this command: - -```bash -sudo netplan try -``` - -If it is correct, apply it using the following command: - -```bash -sudo netplan apply -``` - -### AlmaLinux (8 & 9), Rocky Linux (8 & 9) - -The main configuration file is located in `/etc/sysconfig/network-scripts/`. In this example it is called `ifcfg-eth0`. Before making changes, verify the actual file name in this folder. - -For each Additional IP to be configured, we create a seperate configuration file with the following parameters: `ifcfg-NETWORK_INTERFACE:ID`. Where `NETWORK_INTERFACE` is the physical interface and `ID` is the virtual network interface or ethernet alias starting with a value of 0. For example, for our interface named `eth0` the first alias is `eth0:0`, the second alias is `eth0:1`, etc... - -#### Step 1: Determine the interface - -```bash -ip a -``` - -#### Step 2: Create the configuration file - -First, create the configuration file. Replace `NETWORK_INTERFACE:ID` with your own values. - -```bash -sudo nano /etc/sysconfig/network-scripts/ifcfg-NETWORK_INTERFACE:ID -``` - -Next, edit the file with the content below, replacing `NETWORK_INTERFACE:ID`, and `ADDITIONAL_IP` with your own values: - -```console -DEVICE=NETWORK_INTERFACE:ID -ONBOOT=yes -BOOTPROTO=none # For CentOS use "static" -IPADDR=ADDITIONAL_IP -NETMASK=255.255.255.255 -BROADCAST=ADDITIONAL_IP -``` - -**Configuration example:** - -```console -DEVICE=eth0:0 -ONBOOT=yes -BOOTPROTO=none # For CentOS use "static" -IPADDR=203.0.113.0 -NETMASK=255.255.255.255 -BROADCAST=203.0.113.0 -``` - -#### Step 3: Restart the interface - -```bash -sudo systemctl restart network -``` -#### For AlmaLinux and Rocky Linux - -```bash -sudo systemctl restart NetworkManager -``` - -### Fedora 37 and following - -Fedora now uses keyfiles. NetworkManager previously stored network profiles in ifcfg format in this directory: `/etc/sysconfig/network-scripts/`. However, the ifcfg format is now deprecated. By default, NetworkManager no longer creates new profiles in this format. The configuration file is now found in `/etc/NetworkManager/system-connections/`. - -#### Step 1: Create a backup - -In our example, our file is called `cloud-init-eno1.nmconnection`, so we make a copy of the `cloud-init-eno1.nmconnection` file using the following command: - -```bash -sudo cp -r /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak -``` - -In case of a mistake, you will be able to revert the changes, using the commands below: - -```bash -sudo rm -f /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -sudo cp /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -``` - -#### Step 2: Edit the config file - -> [!primary] -> Please note that the name of the network file in our example may differ from yours. Please adapt the commands to your file name. -> - -```bash -sudo nano /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -``` - -Do not modify the existing lines in the configuration file, add your Additional IP to the file as follows, replacing `ADDITIONAL_IP/32` wih your own values: - -```console -[ipv4] -method=auto -may-fail=false -address1=ADDITIONAL_IP/32 -``` - -If you have two Additional IPs to configure, the configuration should look like this: - -```console -[ipv4] -method=auto -may-fail=false -address1=ADDITIONAL_IP1/32 -address2=ADDITIONAL_IP2/32 -``` - -**Configuration example:** - -```console -[ipv4] -method=auto -may-fail=false -address1=203.0.113.0/32 -``` - -#### Step 3: Restart the interface - -You now need to restart your interface: - -```bash -sudo systemctl restart NetworkManager -``` - -### cPanel - -#### Step 1: Access the WHM IP management section - -In the WHM control panel, click on `IP Functions`{.action} and select `Add a New IP Address`{.action} in the left-hand sidebar. - -![Add new IP](images/cpanel-alma-1.png){.thumbnail} - -#### Step 2: Add the Additional IP information - -Enter your Additional IP in the form `xxx.xxx.xxx.xxx` into the field “New IP or IP range to add”. - -Select `255.255.255.255` as your subnet mask, then click on `Submit`{.action}. - -![enter new IP information](images/cpanel-alma-2.png){.thumbnail} - -> [!warning] -> -> Please note that if you have more than one IP to configure on the same block and you add them all at once, the WHM system will force you to use the subnet mask `255.255.255.0`. We do not recommend using this configuration. Instead, you need to add each IP individually in order to use the proper subnet mask `255.255.255.255`. -> - -#### Step 3: Check the current IP configuration - -Back in the section `IP Functions`{.action}, click on `Show or Delete Current IP Addresses`{.action} to verify that the Additional IP address was added correctly. - -![check configured IP](images/cpanel-alma-3.png){.thumbnail} - -### Plesk - -#### Step 1: Access the Plesk IP management section - -In the Plesk control panel, choose `Tools & Settings`{.action} from the left-hand sidebar. - -![acces to the ip addresses management](images/pleskip1.png){.thumbnail} - -Click on `IP Addresses`{.action} under **Tools & Resources**. - -#### Step 2: Add the additional IP information - -In this section, click on the button `Add IP Address`{.action}. - -![add ip information](images/Plesk-2024-vps.png){.thumbnail} - -Enter your Additional IP in the form `xxx.xxx.xxx.xxx/32` into the field "IP address and subnet mask", then click on `OK`{.action}. - -![add ip information](images/Plesk-additional-ip.png){.thumbnail} - -#### Step 3: Check the current IP configuration - -Back in the section "IP Addresses", verify that the Additional IP address was added correctly. - -![current IP configuration](images/plesk-final-configuration.png){.thumbnail} - -### Windows Servers - -#### Step 1: Verify the network configuration - -Right-click on the `Start Menu`{.action} button and open `Run`{.action}. - -Type `cmd` and click `OK`{.action} to open the command line application. - -![cmdprompt](images/vps_win07.png){.thumbnail} - -In order to retrieve the current IP configuration, enter `ipconfig` at the command prompt. - -```console -C:\Users\Administrator>ipconfig - -Windows IP Configuration - - -Ethernet adapter Ethernet: - - Connection-specific DNS Suffix . : openstacklocal - Link-local IPv6 Address . . . . . : fe90::30gf:258a:84d6:abcf%5 - IPv4 Address. . . . . . . . . . . : 192.0.2.29 - Subnet Mask . . . . . . . . . . . : 255.255.255.255 - Default Gateway . . . . . . . . . : 192.0.2.1 -``` - -#### Step 2: Change the IPv4 Properties - -Now you need to change the IP properties to a static configuration. - -1. Go to `Start`{.action}> `Control Panel`{.action}>` Network and Internet`{.action}> `Network and Sharing Centre`{.action}> `Change Adapter Settings`{.action}(in the left-hand menu). -2. Right-click on `Ethernet`{.action}. -3. Click on `Properties`{.action}. -4. Select `Internet Protocol Version 4 (TCP/IPv4)`{.action}, then click on `Properties`{.action}. -5. Click on `Use the following IP address`{.action} and type in your server’s primary IP, subnet mask and default gateway information obtained by using the `ipconfig`{.action} command above. In the "Preferred DNS Server" box, type `213.186.33.99`. - - -![change the ip configuration](images/configure-main-ip.png){.thumbnail} - -> [!warning] -> -> Be careful – the server will no longer be accessible if you enter incorrect information. You will then have to make the corrections in the KVM. -> - -Once done, click on `Advanced`{.action}. - -#### Step 3: Add the Additional IP in the "Advanced TCP/IP Settings" - -In the new window, click on `Add...`{.action} under "IP addresses". Enter your Additional IP address and the subnet mask (255.255.255.255). - -![advance configuration section](images/configure-additional-ip.png){.thumbnail} - -Confirm by clicking on `Add`{.action}. - -![Additional IP configuration](images/additional-ip-config.png){.thumbnail} - -Once done, click on `OK`{.action} to apply the configuration. - -![Additional IP configuration](images/final-configuration.png){.thumbnail} - -You will lose the connection to the server for a few seconds. - -#### Step 4: Check the new network configuration - -Open the command prompt (cmd) and enter `ipconfig`. The configuration should now include the new Additional IP address. - -```console -C:\Users\Administrator>ipconfig - -Windows IP Configuration - - -Ethernet adapter Ethernet: - - Connection-specific DNS Suffix . : - Link-local IPv6 Address . . . . . : fe90::30gf:258a:84d6:abcf%5 - IPv4 Address. . . . . . . . . . . : 192.0.2.29 - Subnet Mask . . . . . . . . . . . : 255.255.255.255 - IPv4 Address. . . . . . . . . . . : 203.0.113.0 - Subnet Mask . . . . . . . . . . . : 255.255.255.255 - Default Gateway . . . . . . . . . : 192.0.2.1 -``` +> [!tabs] +> **Debian 11** +>> Debian 11 +>> +>> **Step 1: Disable automatic network configuration** +>> +>> Open the following file path with a text editor: +>> +>> ```bash +>> sudo nano /etc/cloud/cloud.cfg.d/99-disable-network-config.cfg +>> ``` +>> +>> Enter the following line, then save and exit the editor: +>> +>> ```bash +>> network: {config:disabled} +>> ``` +>> +>> Creating this configuration file will prevent changes to your network configuration from being made automatically. +>> +>> **Step 2: Create a backup** +>> +>> By default, the configuration file is located in the path `etc\network\interfaces.d`. +>> +>> In our example, our file is called `50-cloud-init`, so we make a copy of the `50-cloud-init` file using the following command: +>> +>> ```bash +>> sudo cp /etc/network/interfaces.d/50-cloud-init /etc/network/interfaces.d/50-cloud-init.bak +>> ``` +>> In case of a mistake, you will be able to revert the changes, using the commands below: +>> +>> ```bash +>> sudo rm -f /etc/network/interfaces.d/50-cloud-init +>> sudo cp /etc/network/interfaces.d/50-cloud-init.bak /etc/network/interfaces.d/50-cloud-init +>> ``` +>> +>> **Step 3: Edit the configuration file** +>> +>> The first step is to verify your network interface name with this command: +>> +>> ```bash +>> ip a +>> ``` +>> +>> Next, open the network configuration file for editing with the following command: +>> +>> ```bash +>> sudo nano /etc/network/interfaces.d/50-cloud-init +>> ``` +>> +>> To configure your Additional IP, you need to add a virtual interface or ethernet alias to your network interface. In our example, our interface is called `eth0`, so our first alias is `eth0:0`. Do this for each Additional IP you wish to configure. +>> +>> Do not modify the existing lines in the configuration file, simply add your Additional IP to the file as follows, replacing `NETWORK_INTERFACE`, `ID` and `ADDITIONAL_IP` wih your own values: +>> +>> ```console +>> auto NETWORK_INTERFACE:ID +>> iface NETWORK_INTERFACE:ID inet static +>> address ADDITIONAL_IP +>> netmask 255.255.255.255 +>> ``` +>> +>> If you are configuring more than one Additional IP, your configuration file should look like this: +>> +>> ```console +>> auto NETWORK_INTERFACE:ID +>> iface NETWORK_INTERFACE:ID inet static +>> address ADDITIONAL_IP1 +>> address ADDITIONAL_IP2 +>> netmask 255.255.255.255 +>> ``` +>> +>> /// details | **Configuration example:** +>> +>> ```console +>> auto eth0:0 +>> iface eth0:0 inet static +>> address 203.0.113.0 +>> netmask 255.255.255.255 +>> ``` +>> +>> /// +>> +>> **Step 4: Restart the interface** +>> +>> Apply the changes with the following command: +>> +>> ```bash +>> sudo systemctl restart networking +>> ``` +>> +> Debian 12, Ubuntu 20.04+ +>> **Debian 12, Ubuntu 20.04 and following** +>> +>> The configuration file for your Additional IP addresses is located in the folder `/etc/netplan/`. In this example it is called `50-cloud-init.yaml`. +>> +>> The best practice approach is to create a separate configuration file to set up Additional IP addresses. This way, you can easily revert the changes in case of an error. +>> +>> **Step 1: Create the network configuration file** +>> +>> In our example, our file is call `51-cloud-init.yaml`: +>> +>> ```bash +>> sudo touch /etc/netplan/51-cloud-init.yaml +>> ``` +>> +>> **Step 2: Edit the configuration file** +>> +>> You can verify your network interface name with this command: +>> +>> ```bash +>> ip a +>> ``` +>> +>> Next, open the network configuration file for editing with the following command: +>> +>> ```bash +>> sudo nano /etc/netplan/51-cloud-init.yaml +>> ``` +>> +>> Edit the file with the content below, replacing `INTERFACE_NAME` and `ADDITIONAL_IP` with your own values: +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> INTERFACE_NAME: +>> dhcp4: true +>> addresses: +>> - ADDITIONAL_IP/32 +>> ``` +>> +>> If you have more Additional IPs to configure, the configuration file should look like this: +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> INTERFACE_NAME: +>> dhcp4: true +>> addresses: +>> - ADDITIONAL_IP1/32 +>> - ADDITIONAL_IP2/32 +>> ``` +>> +>> > [!warning] +>> > +>> > It is important to respect the alignment of each element in this file as represented in the example above. Do not use the tab key to create your spacing. +>> > +>> +>> /// details | **Configuration example:** +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> eth0: +>> dhcp4: true +>> addresses: +>> - 203.0.113.0/32 +>> ``` +>> /// +>> +>> Save and close the file. +>> +>> **Step 3: Apply the new network configuration** +>> +>> You can test your configuration using this command: +>> +>> ```bash +>> sudo netplan try +>> ``` +>> +>> If it is correct, apply it using the following command: +>> +>> ```bash +>> sudo netplan apply +>> ``` +>> +> **AlmaLinux / Rocky Linux (8/9)** +>> AlmaLinux (8/9/10), Rocky Linux (8/9/10) +>> +>> The main configuration file is located in `/etc/sysconfig/network-scripts/`. In this example it is called `ifcfg-eth0`. Before making changes, verify the actual file name in this folder. +>> +>> For each Additional IP to be configured, we create a seperate configuration file with the following parameters: `ifcfg-NETWORK_INTERFACE:ID`. Where `NETWORK_INTERFACE` is the physical interface and `ID` is the virtual network interface or ethernet alias starting with a value of 0. For example, for our interface named `eth0` the first alias is `eth0:0`, the second alias is `eth0:1`, etc... +>> +>> **Step 1: Determine the interface** +>> +>> ```bash +>> ip a +>> ``` +>> +>> **Step 2: Create the configuration file** +>> +>> First, create the configuration file. Replace `NETWORK_INTERFACE:ID` with your own values. +>> +>> ```bash +>> sudo nano /etc/sysconfig/network-scripts/ifcfg-NETWORK_INTERFACE:ID +>> ``` +>> +>> Next, edit the file with the content below, replacing `NETWORK_INTERFACE:ID`, and `ADDITIONAL_IP` with your own values: +>> +>> ```console +>> DEVICE=NETWORK_INTERFACE:ID +>> ONBOOT=yes +>> BOOTPROTO=none # For CentOS use "static" +>> IPADDR=ADDITIONAL_IP +>> NETMASK=255.255.255.255 +>> BROADCAST=ADDITIONAL_IP +>> ``` +>> +>> /// details | **Configuration example:** +>> +>> ```console +>> DEVICE=eth0:0 +>> ONBOOT=yes +>> BOOTPROTO=none # For CentOS use "static" +>> IPADDR=203.0.113.0 +>> NETMASK=255.255.255.255 +>> BROADCAST=203.0.113.0 +>> ``` +>> /// +>> +>> **Step 3: Restart the interface** +>> +>> ```bash +>> sudo systemctl restart network +>> ``` +>> +>> For AlmaLinux and Rocky Linux +>> +>> ```bash +>> sudo systemctl restart NetworkManager +>> ``` +>> +> **Fedora 42** +>> Fedora 42 +>> +>> Fedora now uses keyfiles. NetworkManager previously stored network profiles in ifcfg format in this directory: `/etc/sysconfig/network-scripts/`. However, the ifcfg format is now deprecated. By default, NetworkManager no longer creates new profiles in this format. The configuration file is now found in `/etc/NetworkManager/system-connections/`. +>> +>> **Step 1: Create a backup** +>> +>> In our example, our file is called `cloud-init-eno1.nmconnection`, so we make a copy of the `cloud-init-eno1.nmconnection` file using the following command: +>> +>> ```bash +>> sudo cp -r /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak +>> ``` +>> +>> In case of a mistake, you will be able to revert the changes, using the commands below: +>> +>> ```bash +>> sudo rm -f /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> sudo cp /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> ``` +>> +>> **Step 2: Edit the config file** +>> +>> > [!primary] +>> > Please note that the name of the network file in our example may differ from yours. Please adapt the commands to your file name. +>> > +>> +>> ```bash +>> sudo nano /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> ``` +>> +>> Do not modify the existing lines in the configuration file, add your Additional IP to the file as follows, replacing `ADDITIONAL_IP/32` wih your own values: +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=ADDITIONAL_IP/32 +>> ``` +>> +>> If you have two Additional IPs to configure, the configuration should look like this: +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=ADDITIONAL_IP1/32 +>> address2=ADDITIONAL_IP2/32 +>> ``` +>> +>> /// details | **Configuration example:** +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=203.0.113.0/32 +>> ``` +>> /// +>> +>> **Step 3: Restart the interface** +>> +>> You now need to restart your interface: +>> +>> ```bash +>> sudo systemctl restart NetworkManager +>> ``` +>> +> **cPanel** +>> cPanel +>> +>> **Step 1: Access the WHM IP management section** +>> +>> In the WHM control panel, click on `IP Functions`{.action} and select `Add a New IP Address`{.action} in the left-hand sidebar. +>> +>> ![Add new IP](images/cpanel-alma-1.png){.thumbnail} +>> +>> **Step 2: Add the Additional IP information** +>> +>> Enter your Additional IP in the form `xxx.xxx.xxx.xxx` into the field “New IP or IP range to add”. +>> +>> Select `255.255.255.255` as your subnet mask, then click on `Submit`{.action}. +>> +>> ![enter new IP information](images/cpanel-alma-2.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Please note that if you have more than one IP to configure on the same block and you add them all at once, the WHM system will force you to use the subnet mask `255.255.255.0`. We do not recommend using this configuration. Instead, you need to add each IP individually in order to use the proper subnet mask `255.255.255.255`. +>> > +>> +>> **Step 3: Check the current IP configuration** +>> +>> Back in the section `IP Functions`{.action}, click on `Show or Delete Current IP Addresses`{.action} to verify that the Additional IP address was added correctly. +>> +>> ![check configured IP](images/cpanel-alma-3.png){.thumbnail} +>> +> **Plesk** +>> Plesk +>> +>> **Step 1: Access the Plesk IP management section** +>> +>> In the Plesk control panel, choose `Tools & Settings`{.action} from the left-hand sidebar. +>> +>> ![acces to the ip addresses management](images/pleskip1.png){.thumbnail} +>> +>> Click on `IP Addresses`{.action} under **Tools & Resources**. +>> +>> **Step 2: Add the additional IP information** +>> +>> In this section, click on the button `Add IP Address`{.action}. +>> +>> ![add ip information](images/Plesk-2024-vps.png){.thumbnail} +>> +>> Enter your Additional IP in the form `xxx.xxx.xxx.xxx/32` into the field "IP address and subnet mask", then click on `OK`{.action}. +>> +>> ![add ip information](images/Plesk-additional-ip.png){.thumbnail} +>> +>> **Step 3: Check the current IP configuration** +>> +>> Back in the section "IP Addresses", verify that the Additional IP address was added correctly. +>> +>> ![current IP configuration](images/plesk-final-configuration.png){.thumbnail} +>> +> **Windows Servers** +>> Windows Servers +>> +>> **Step 1: Verify the network configuration** +>> +>> Right-click on the `Start Menu`{.action} button and open `Run`{.action}. +>> +>> Type `cmd` and click `OK`{.action} to open the command line application. +>> +>> ![cmdprompt](images/vps_win07.png){.thumbnail} +>> +>> In order to retrieve the current IP configuration, enter `ipconfig` at the command prompt. +>> +>> ```console +>> C:\Users\Administrator>ipconfig +>> +>> Windows IP Configuration +>> +>> Ethernet adapter Ethernet: +>> +>> Connection-specific DNS Suffix . : openstacklocal +>> Link-local IPv6 Address . . . . . : fe90::30gf:258a:84d6:abcf%5 +>> IPv4 Address. . . . . . . . . . . : 192.0.2.29 +>> Subnet Mask . . . . . . . . . . . : 255.255.255.255 +>> Default Gateway . . . . . . . . . : 192.0.2.1 +>> ``` +>> +>> **Step 2: Change the IPv4 Properties** +>> +>> Now you need to change the IP properties to a static configuration. +>> +>> 1. Go to `Start`{.action}> `Control Panel`{.action}>` Network and Internet`{.action}> `Network and Sharing Centre`{.action}> `Change Adapter Settings`{.action}(in the left-hand menu). +>> 2. Right-click on `Ethernet`{.action}. +>> 3. Click on `Properties`{.action}. +>> 4. Select `Internet Protocol Version 4 (TCP/IPv4)`{.action}, then click on `Properties`{.action}. +>> 5. Click on `Use the following IP address`{.action} and type in your server’s primary IP, subnet mask and default gateway information obtained by using the `ipconfig`{.action} command above. In the "Preferred DNS Server" box, type `213.186.33.99`. +>> +>> ![change the ip configuration](images/configure-main-ip.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Be careful – the server will no longer be accessible if you enter incorrect information. You will then have to make the corrections in the KVM. +>> > +>> +>> Once done, click on `Advanced`{.action}. +>> +>> Step 3: Add the Additional IP in the "Advanced TCP/IP Settings" +>> +>> In the new window, click on `Add...`{.action} under "IP addresses". Enter your Additional IP address and the subnet mask (255.255.255.255). +>> +>> ![advance configuration section](images/configure-additional-ip.png){.thumbnail} +>> +>> Confirm by clicking on `Add`{.action}. +>> +>> ![Additional IP configuration](images/additional-ip-config.png){.thumbnail} +>> +>> Once done, click on `OK`{.action} to apply the configuration. +>> +>> ![Additional IP configuration](images/final-configuration.png){.thumbnail} +>> +>> You will lose the connection to the server for a few seconds. +>> +>> **Step 4: Check the new network configuration** +>> +>> Open the command prompt (cmd) and enter `ipconfig`. The configuration should now include the new Additional IP address. +>> +>> ```console +>> C:\Users\Administrator>ipconfig +>> +>> Windows IP Configuration +>> +>> Ethernet adapter Ethernet: +>> +>> Connection-specific DNS Suffix . : +>> Link-local IPv6 Address . . . . . : fe90::30gf:258a:84d6:abcf%5 +>> IPv4 Address. . . . . . . . . . . : 192.0.2.29 +>> Subnet Mask . . . . . . . . . . . : 255.255.255.255 +>> IPv4 Address. . . . . . . . . . . : 203.0.113.0 +>> Subnet Mask . . . . . . . . . . . : 255.255.255.255 +>> Default Gateway . . . . . . . . . : 192.0.2.1 +>> ``` ### Troubleshooting diff --git a/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/guide.es-es.md b/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/guide.es-es.md index 44a5ca8088e..ebe15e918bd 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/guide.es-es.md +++ b/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/guide.es-es.md @@ -1,9 +1,23 @@ --- title: 'Configurar una dirección IP como alias' excerpt: 'Cómo añadir direcciones Additional IP a su configuración VPS' -updated: 2025-09-11 +updated: 2025-11-12 --- + + ## Objetivo El alias de IP (*IP aliasing* en inglés) es una configuración especial de red para los servidores de OVHcloud, que permite asociar varias direcciones IP a una única interfaz de red. @@ -45,429 +59,449 @@ En cuanto a las distintas versiones de distribuciones, tenga en cuenta que puede |NETWORK_INTERFACE|Nombre de la interfaz de red|*eth0*, *ens3*| |ID|ID del alias IP, comenzando por *0* (en función del número de direcciones IP adicionales a configurar)|*0*, *1*| -### Debian 11 - -#### 1\. desactivar la configuración automática de red - -Abra la ruta al siguiente archivo con un editor de texto, en nuestro ejemplo utilizamos `nano` : - -```bash -sudo nano /etc/cloud/cloud.cfg.d/99-disable-network-config.cfg -``` - -Introduzca la siguiente línea y, a continuación, guarde y cierre el editor. - -```console -network: {config: disabled} -``` - -La creación de este archivo de configuración impide la ejecución automática de los cambios realizados en la configuración de su red. - -#### 2\. crear una copia de seguridad - -Por defecto, el fichero de configuración se encuentra en la ruta `/etc/network/interfaces.d`. - -En nuestro ejemplo, nuestro archivo se llama `50-cloud-init`, por lo que hacemos una copia del archivo `50-cloud-init` utilizando el siguiente comando: - -```bash -sudo cp /etc/network/interfaces.d/50-cloud-init /etc/network/interfaces.d/50-cloud-init.bak -``` - -Si comete algún error, puede revertir los cambios utilizando los siguientes comandos: - -```bash -sudo rm -f /etc/network/interfaces.d/50-cloud-init -sudo cp /etc/network/interfaces.d/50-cloud-init.bak /etc/network/interfaces.d/50-cloud-init -``` - -#### 3\. editar el archivo de configuración de red - -Para comprobar el nombre de la interfaz de red, utilice el siguiente comando: - -```bash -ip a -``` - -Abra el archivo de configuración de red para modificarlo con el siguiente comando: - -```bash -sudo nano /etc/network/interfaces.d/50-cloud-init -``` - -Para configurar su dirección Additional IP, añada una interfaz virtual o un alias Ethernet a su interfaz de red. En nuestro ejemplo, nuestra interfaz se llama `eth0`, por lo que nuestro primer alias es `eth0:0`. Haga esto para cada dirección Additional IP que quiera configurar. - -No modifique las líneas existentes en el fichero de configuración, añada únicamente su dirección Additional IP al fichero, sustituyendo `NETWORK_INTERFACE`, `ID` y `ADDITIONAL_IP` por sus propios valores: - - -```console -auto NETWORK_INTERFACE:ID -iface NETWORK_INTERFACE:ID inet static -address ADDITIONAL_IP -netmask 255.255.255.255 -``` - -Si configura más de una dirección Additional IP, su archivo de configuración debería tener el siguiente aspecto: - -```console -auto NETWORK_INTERFACE:ID -iface NETWORK_INTERFACE:ID inet static -address ADDITIONAL_IP1 -address ADDITIONAL_IP2 -netmask 255.255.255.255 -``` - -**Ejemplo** - -```console -auto eth0:0 -iface eth0:0 inet static -address 203.0.113.0 -netmask 255.255.255.255 -``` - -#### 4\. reiniciar la interfaz - -Aplique los cambios con el siguiente comando: - -```bash -sudo systemctl restart networking -``` - -### Debian 12, Ubuntu 20.04 y posteriores - -El archivo de configuración de las direcciones Additional IP se encuentra en `/etc/netplan/`. En este ejemplo, se llama `50-cloud-init.yaml`. - -La práctica recomendada es crear un archivo de configuración independiente para definir las direcciones Additional IP. De este modo, podrá volver a revisar fácilmente los cambios en caso de que se produzca un error. - - -#### 1\. crear el archivo de configuración de red - -En nuestro ejemplo, nuestro archivo se llama `51-cloud-init.yaml`: - -```bash -sudo touch /etc/netplan/51-cloud-init.yaml -``` - -#### 2\. editar el archivo de configuración - -Para comprobar el nombre de la interfaz de red, utilice el siguiente comando: - -```bash -ip a -``` - -Abra el archivo de configuración de red para modificarlo con el siguiente comando: - -```bash -sudo nano /etc/netplan/51-cloud-init.yaml -``` - -Edite el fichero con el siguiente contenido, sustituyendo `INTERFACE_NAME` y `ADDITIONAL_IP` por sus propios valores: - -```yaml -network: - version: 2 - ethernets: - INTERFACE_NAME: - dhcp4: true - addresses: - - ADDITIONAL_IP/32 -``` - -Si tiene que configurar más de una dirección Additional IP, el archivo de configuración debería tener el siguiente aspecto: - -```yaml -network: - version: 2 - ethernets: - INTERFACE_NAME: - dhcp4: true - addresses: - - ADDITIONAL_IP1/32 - - ADDITIONAL_IP2/32 -``` - -> [!warning] -> -> Es importante mantener la alineación de cada elemento del archivo, tal y como se muestra en el ejemplo anterior. No use la tecla de tabulación para crear el espacio. -> - -**Ejemplo** - -```yaml -network: - version: 2 - ethernets: - eth0: - dhcp4: true - addresses: - - 203.0.113.0/32 -``` - -Guarde y cierre el archivo. - -#### 3\. aplicar la nueva configuración de red - -Para probar su configuración, utilice el siguiente comando: - -```bash -sudo netplan try -``` - -Si es correcta, puede aplicarla con el siguiente comando: - -```bash -sudo netplan apply -``` - -Repita este procedimiento para cada dirección Additional IP. - -### AlmaLinux (8 y 9), Rocky Linux (8 y 9) - -El archivo de configuración principal se encuentra en la carpeta `/etc/sysconfig/network-scripts/`. En este ejemplo, se denomina `ifcfg-eth0`. Antes de realizar cualquier cambio, compruebe el nombre real del archivo en esta carpeta. - -Para cada dirección Additional IP que desee configurar, cree un archivo de configuración independiente con los siguientes parámetros: `ifcfg-NETWORK_INTERFACE:ID`. Donde `NETWORK_INTERFACE` representa la interfaz física y `ID` representa la interfaz de red virtual o el alias ethernet que empieza por un valor de 0. Por ejemplo, para nuestra interfaz llamada `eth0` el primer alias es `eth0:0`, el segundo alias es `eth0:1`, etc. - -#### 1\. determinar la interfaz - -Para comprobar el nombre de la interfaz de red, utilice el siguiente comando: - -```bash -ip a -``` - -#### 2\. crear el archivo de configuración - -En primer lugar, cree el archivo de configuración. Sustituya `NETWORK_INTERFACE:ID` por sus propios valores. - -```bash -sudo nano /etc/sysconfig/network-scripts/ifcfg-NETWORK_INTERFACE:ID -``` - -A continuación, edite el archivo con el siguiente contenido, sustituyendo `NETWORK_INTERFACE:ID` y `ADDITIONAL_IP` por sus propios valores: - -```console -DEVICE=NETWORK_INTERFACE:ID -BOOTPROTO=static -IPADDR=ADDITIONAL_IP -NETMASK=255.255.255.255 -BROADCAST=ADDITIONAL_IP -ONBOOT=yes -``` - -**Ejemplo** - -```console -DEVICE=NETWORK_INTERFACE:ID -BOOTPROTO=static -IPADDR=203.0.113.0 -NETMASK=255.255.255.255 -BROADCAST=203.0.113.0 -ONBOOT=yes -``` - -#### 3\. reiniciar la interfaz - -Aplique los cambios con el siguiente comando: - -```bash -sudo systemctl restart network -``` - -#### Para AlmaLinux y Rocky Linux - -```bash -sudo systemctl restart NetworkManager -``` - -### Fedora 37 y versiones posteriores - -Fedora ahora utiliza archivos clave. NetworkManager almacenaba previamente los perfiles de red en formato ifcfg en este directorio: `/etc/sysconfig/network-scripts/`. Sin embargo, el formato ifcfg está obsoleto. De forma predeterminada, NetworkManager ya no crea nuevos perfiles en este formato. El archivo de configuración se encuentra ahora en `/etc/NetworkManager/system-connections/`. - -#### 1\. crear una copia de seguridad - -En nuestro ejemplo, nuestro archivo se llama `cloud-init-eno1.nmconnection`, por lo que hacemos una copia del archivo `cloud-init-eno1.nmconnection` utilizando el siguiente comando: - -```bash -sudo cp -r /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak -``` - -Si comete algún error, puede revertir los cambios utilizando los siguientes comandos: - -```bash -sudo rm -f /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -sudo cp /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -``` - -#### 2\. modificar el archivo de configuración - -> [!primary] -> Tenga en cuenta que el nombre del archivo de red en nuestro ejemplo puede ser diferente del suyo. Adapte los comandos a su nombre de archivo. -> - -```bash -sudo nano /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -``` - -No modifique las líneas existentes en el fichero de configuración, añada su Additional IP al fichero como sigue, sustituyendo `ADDITIONAL_IP/32` por sus propios valores: - -```console -[ipv4] -method=auto -may-fail=false -address1=ADDITIONAL_IP/32 -``` - -Si tiene dos direcciones Additional IP que configurar, la configuración debería ser similar a la siguiente: - -```console -[ipv4] -method=auto -may-fail=false -address1=ADDITIONAL_IP1/32 -address2=ADDITIONAL_IP2/32 -``` - -**Ejemplo** - -```console -[ipv4] -method=auto -may-fail=false -address1=203.0.113.0/32 -``` - -#### 3\. reiniciar la interfaz - -```bash -sudo systemctl restart NetworkManager -``` - -### cPanel - -#### 1\. acceder a la sección de gestión de las IP del WHM - -En el área de cliente de WHM, haga clic en `IP Functions`{.action} y seleccione `Add a New IP Address`{.action} en el menú de la izquierda. - -![Add new IP](images/cpanel-alma-1.png){.thumbnail} +En los ejemplos siguientes, utilizaremos el editor de texto `nano`. En algunos sistemas operativos, deberá instalarlo antes de poder utilizarlo. Si es así, se le pedirá que lo haga. Por supuesto, puede utilizar el editor de texto que prefiera. -#### 2\. añadir la información de las direcciones Additional IP - -Introduzca su dirección Additional IP con el formato `xxx.xxx.xxx.xxx` en el campo `New IP or IP range to add`. - -Seleccione `255.255.255.255` como máscara de subred y haga clic en `Submit`{.action}. - -![enter new IP information](images/cpanel-alma-2.png){.thumbnail} - -> [!warning] -> -> Atención, si tiene varias IP que configurar en un mismo bloque y las añade todas al mismo tiempo, el sistema WHM le obligará a utilizar la máscara de subred `255.255.255.0`. No se recomienda utilizar esta configuración, es necesario añadir cada IP individualmente para poder utilizar la máscara de subred adecuada `255.255.255.255`. -> - -#### 3\. comprobar la configuración IP actual - -Vuelva a la sección `IP Functions`{.action} y haga clic en `Show or Delete Current IP Addresses`{.action} para comprobar que la dirección Additional IP se ha añadido correctamente. - -![check configured IP](images/cpanel-alma-3.png){.thumbnail} - - -### Plesk - -#### 1\. acceder a la gestión de IP de Plesk - -En el panel de configuración de Plesk, seleccione `Tools & Settings`{.action} en la columna izquierda. - -![acceso a la gestión de las direcciones IP](images/pleskip1.png){.thumbnail} - -Haga clic en `IP Addresses`{.action} bajo **Tools & Settings**. - -#### 2\. añadir la información IP adicional - -En esta sección, haga clic en el botón `Add IP Address`{.action}. - -![añadir información IP](images/Plesk-2024-vps.png){.thumbnail} - -Introduzca su dirección Additional IP como `xxx.xxx.xxx.xxx/32` en el campo "IP address and subnet mask" y haga clic en `OK`{.action}. - -![añadir información IP](images/Plesk-additional-ip.png){.thumbnail} - -#### 3\. comprobar la configuración IP actual - -En la sección "IP Addresses", compruebe que la dirección Additional IP se haya añadido correctamente. - -![configuración IP actual](images/plesk-final-configuration.png){.thumbnail} - - -### Windows Server - -#### 1\. comprobar la configuración de red - -Haga clic derecho en el botón `Start`{.action} y abra `Run`{.action}. - -Pulse `cmd` y haga clic en `OK`{.action} para abrir la aplicación de línea de órdenes. - -![cmdprompt](images/vps_win07.png){.thumbnail} - -Para obtener la configuración de IP actual, introduzca `ipconfig` en la consola de comandos. - -```console -C:\Users\Administrator>ipconfig -Windows IP Configuration -Ethernet adapter Ethernet: - Connection-specific DNS Suffix . : openstacklocal - Link-local IPv6 Address . . . . . : fe90::30gf:258a:84d6:abcf%5 - IPv4 Address. . . . . . . . . . . : 192.0.2.29 - Subnet Mask . . . . . . . . . . . : 255.255.255.255 - Default Gateway . . . . . . . . . : 192.0.2.1 -``` - -#### 2\. modificar las propiedades IPv4 - -1. Vaya al menú `Start`{.action}, luego `Control Panel`{.action}, `Network and Internet`{.action}, `Network and Sharing Centre`{.action} y `Change Adapter Settings`{.action} en la barra de la izquierda. -2. Haga clic derecho en `Ethernet`{.action}; -3. Haga clic en `Properties`{.action}; -4. Seleccione `Internet Protocol Version 4 (TCP/IPv4)`{.action} y haga clic en `Properties`{.action}; -5. Haga clic en `Use the following IP address`{.action} e introduzca la IP principal del servidor, la máscara de subred y la puerta de enlace por defecto obtenidas con el comando `ipconfig`{.action} anterior. En el cuadro "Preferred DNS Server", escriba "213.186.33.99". - -![change the ip configuration](images/configure-main-ip.png){.thumbnail} - -> [!warning] +> [!success] +> Seleccione la pestaña correspondiente a su sistema operativo. > -> Atención: si introduce información incorrecta, no podrá acceder al servidor. En ese caso, deberá realizar las correcciones oportunas a través del KVM. -> - -#### 3\. añadir la dirección Additional IP en los Parámetros TCP/IP avanzados - -En la nueva ventana, haga clic en `Add...`{.action} en "IP addresses". Introduzca su dirección Additional IP y la máscara de subred (255.255.255.255). - -![sección de configuración avanzada](images/configure-additional-ip.png){.thumbnail} - -Confirme haciendo clic en `Add`{.action}. - -![Additional IP configuration](images/additional-ip-config.png){.thumbnail} -A continuación, haga clic en `OK`{.action} para aplicar la configuración. - -![Configuración del cambio de IP](images/final-configuration.png){.thumbnail} - -Perderá la conexión con su servidor durante unos segundos. - -#### 4\. comprobar la configuración IP actual - -Abra el símbolo del sistema (cmd) e introduzca `ipconfig`. La configuración debe incluir ahora la nueva dirección Additional IP. - -```console -C:\Users\Administrator>ipconfig -Windows IP Configuration -Ethernet adapter Ethernet: - Connection-specific DNS Suffix . : - Link-local IPv6 Address . . . . . : fe90::30gf:258a:84d6:abcf%5 - IPv4 Address. . . . . . . . . . . : 192.0.2.29 - Subnet Mask . . . . . . . . . . . : 255.255.255.255 - IPv4 Address. . . . . . . . . . . : 203.0.113.0 - Subnet Mask . . . . . . . . . . . : 255.255.255.255 - Default Gateway . . . . . . . . . : 192.0.2.1 -``` +> [!tabs] +> Debian 11 +>> **Debian 11** +>> +>> **1\. desactivar la configuración automática de red** +>> +>> Abra la ruta al siguiente archivo con un editor de texto, en nuestro ejemplo utilizamos `nano`: +>> +>> ```bash +>> sudo nano /etc/cloud/cloud.cfg.d/99-disable-network-config.cfg +>> ``` +>> +>> Introduzca la siguiente línea y, a continuación, guarde y cierre el editor. +>> +>> ```console +>> network: {config: disabled} +>> ``` +>> +>> La creación de este archivo de configuración impide la ejecución automática de los cambios realizados en la configuración de su red. +>> +>> **2\. crear una copia de seguridad** +>> +>> Por defecto, el fichero de configuración se encuentra en la ruta `/etc/network/interfaces.d`. +>> +>> En nuestro ejemplo, nuestro archivo se llama `50-cloud-init`, por lo que hacemos una copia del archivo `50-cloud-init` utilizando el siguiente comando: +>> +>> ```bash +>> sudo cp /etc/network/interfaces.d/50-cloud-init /etc/network/interfaces.d/50-cloud-init.bak +>> ``` +>> +>> Si comete algún error, puede revertir los cambios utilizando los siguientes comandos: +>> +>> ```bash +>> sudo rm -f /etc/network/interfaces.d/50-cloud-init +>> sudo cp /etc/network/interfaces.d/50-cloud-init.bak /etc/network/interfaces.d/50-cloud-init +>> ``` +>> +>> **3\. editar el archivo de configuración de red** +>> +>> Para comprobar el nombre de la interfaz de red, utilice el siguiente comando: +>> +>> ```bash +>> ip a +>> ``` +>> +>> Abra el archivo de configuración de red para modificarlo con el siguiente comando: +>> +>> ```bash +>> sudo nano /etc/network/interfaces.d/50-cloud-init +>> ``` +>> +>> Para configurar su dirección Additional IP, añada una interfaz virtual o un alias Ethernet a su interfaz de red. En nuestro ejemplo, nuestra interfaz se llama `eth0`, por lo que nuestro primer alias es `eth0:0`. Haga esto para cada dirección Additional IP que quiera configurar. +>> +>> No modifique las líneas existentes en el fichero de configuración, añada únicamente su dirección Additional IP al fichero, sustituyendo `NETWORK_INTERFACE`, `ID` y `ADDITIONAL_IP` por sus propios valores: +>> +>> ```console +>> auto NETWORK_INTERFACE:ID +>> iface NETWORK_INTERFACE:ID inet static +>> address ADDITIONAL_IP +>> netmask 255.255.255.255 +>> ``` +>> +>> Si configura más de una dirección Additional IP, su archivo de configuración debería tener el siguiente aspecto: +>> +>> ```console +>> auto NETWORK_INTERFACE:ID +>> iface NETWORK_INTERFACE:ID inet static +>> address ADDITIONAL_IP1 +>> address ADDITIONAL_IP2 +>> netmask 255.255.255.255 +>> ``` +>> +>> /// details | **Ejemplo** +>> +>> ```console +>> auto eth0:0 +>> iface eth0:0 inet static +>> address 203.0.113.0 +>> netmask 255.255.255.255 +>> ``` +>> /// +>> +>> **4\. reiniciar la interfaz** +>> +>> Aplique los cambios con el siguiente comando: +>> +>> ```bash +>> sudo systemctl restart networking +>> ``` +>> +> Debian 12, Ubuntu 20.04+ +>> **Debian 12, Ubuntu 20.04 y versiones posteriores** +>> +>> El archivo de configuración de las direcciones Additional IP se encuentra en `/etc/netplan/`. En este ejemplo, se llama `50-cloud-init.yaml`. +>> +>> La práctica recomendada es crear un archivo de configuración independiente para definir las direcciones Additional IP. De este modo, podrá volver a revisar fácilmente los cambios en caso de que se produzca un error. +>> +>> **1\. crear el archivo de configuración de red** +>> +>> En nuestro ejemplo, nuestro archivo se llama `51-cloud-init.yaml`: +>> +>> ```bash +>> sudo touch /etc/netplan/51-cloud-init.yaml +>> ``` +>> +>> **2\. editar el archivo de configuración** +>> +>> Para comprobar el nombre de la interfaz de red, utilice el siguiente comando: +>> +>> ```bash +>> ip a +>> ``` +>> +>> Abra el archivo de configuración de red para modificarlo con el siguiente comando: +>> +>> ```bash +>> sudo nano /etc/netplan/51-cloud-init.yaml +>> ``` +>> +>> Edite el fichero con el siguiente contenido, sustituyendo `INTERFACE_NAME` y `ADDITIONAL_IP` por sus propios valores: +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> INTERFACE_NAME: +>> dhcp4: true +>> addresses: +>> - ADDITIONAL_IP1/32 +>> ``` +>> +>> Si tiene que configurar más de una dirección Additional IP, el archivo de configuración debería tener el siguiente aspecto: +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> INTERFACE_NAME: +>> dhcp4: true +>> addresses: +>> - ADDITIONAL_IP1/32 +>> - ADDITIONAL_IP2/32 +>> ``` +>> +>> > [!warning] +>> > +>> > Es importante mantener la alineación de cada elemento del archivo, tal y como se muestra en el ejemplo anterior. No use la tecla de tabulación para crear el espacio. +>> > +>> +>> /// details | **Ejemplo** +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> eth0: +>> dhcp4: true +>> addresses: +>> - 203.0.113.0/32 +>> ``` +>> /// +>> +>> Guarde y cierre el archivo. +>> +>> **3\. aplicar la nueva configuración de red** +>> +>> Para probar su configuración, utilice el siguiente comando: +>> +>> ```bash +>> sudo netplan try +>> ``` +>> +>> Si es correcta, puede aplicarla con el siguiente comando: +>> +>> ```bash +>> sudo netplan apply +>> ``` +>> +>> Repita este procedimiento para cada dirección Additional IP. +>> +> AlmaLinux / Rocky Linux +>> **AlmaLinux (8 y 9), Rocky Linux (8 y 9)** +>> +>> El archivo de configuración principal se encuentra en la carpeta `/etc/sysconfig/network-scripts/`. En este ejemplo, se denomina `ifcfg-eth0`. Antes de realizar cualquier cambio, compruebe el nombre real del archivo en esta carpeta. +>> +>> Para cada dirección Additional IP que desee configurar, cree un archivo de configuración independiente con los siguientes parámetros: `ifcfg-NETWORK_INTERFACE:ID`. Donde `NETWORK_INTERFACE` representa la interfaz física y `ID` representa la interfaz de red virtual o el alias ethernet que empieza por un valor de 0. Por ejemplo, para nuestra interfaz llamada `eth0` el primer alias es `eth0:0`, el segundo alias es `eth0:1`, etc. +>> +>> **1\. determinar la interfaz** +>> +>> Para comprobar el nombre de la interfaz de red, utilice el siguiente comando: +>> +>> ```bash +>> ip a +>> ``` +>> +>> **2\. crear el archivo de configuración** +>> +>> En primer lugar, cree el archivo de configuración. Sustituya `NETWORK_INTERFACE:ID` por sus propios valores. +>> +>> ```bash +>> sudo nano /etc/sysconfig/network-scripts/ifcfg-NETWORK_INTERFACE:ID +>> ``` +>> +>> A continuación, edite el archivo con el siguiente contenido, sustituyendo `NETWORK_INTERFACE:ID` y `ADDITIONAL_IP` por sus propios valores: +>> +>> ```console +>> DEVICE=NETWORK_INTERFACE:ID +>> ONBOOT=yes +>> BOOTPROTO=none # For CentOS use "static" +>> IPADDR=ADDITIONAL_IP +>> NETMASK=255.255.255.255 +>> BROADCAST=ADDITIONAL_IP +>> ``` +>> +>> /// details | **Ejemplo** +>> +>> ```console +>> DEVICE=eth0:0 +>> ONBOOT=yes +>> BOOTPROTO=none # For CentOS use "static" +>> IPADDR=203.0.113.0 +>> NETMASK=255.255.255.255 +>> BROADCAST=203.0.113.0 +>> ``` +>> /// +>> +>> **3\. reiniciar la interfaz** +>> +>> Aplique los cambios con el siguiente comando: +>> +>> ```bash +>> sudo systemctl restart network +>> ``` +>> +>> Para AlmaLinux y Rocky Linux +>> +>> ```bash +>> sudo systemctl restart NetworkManager +>> ``` +>> +> Fedora 42 +>> **Fedora 42** +>> +>> Fedora ahora utiliza archivos clave. NetworkManager almacenaba previamente los perfiles de red en formato ifcfg en este directorio: `/etc/sysconfig/network-scripts/`. Sin embargo, el formato ifcfg está obsoleto. De forma predeterminada, NetworkManager ya no crea nuevos perfiles en este formato. El archivo de configuración se encuentra ahora en `/etc/NetworkManager/system-connections/`. +>> +>> **1\. crear una copia de seguridad** +>> +>> En nuestro ejemplo, nuestro archivo se llama `cloud-init-eno1.nmconnection`, por lo que hacemos una copia del archivo `cloud-init-eno1.nmconnection` utilizando el siguiente comando: +>> +>> ```bash +>> sudo cp -r /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak +>> ``` +>> +>> Si comete algún error, puede revertir los cambios utilizando los siguientes comandos: +>> +>> ```bash +>> sudo rm -f /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> sudo cp /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> ``` +>> +>> **2\. modificar el archivo de configuración** +>> +>> > [!primary] +>> > Tenga en cuenta que el nombre del archivo de red en nuestro ejemplo puede ser diferente del suyo. Adapte los comandos a su nombre de archivo. +>> > +>> +>> ```bash +>> sudo nano /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> ``` +>> +>> No modifique las líneas existentes en el fichero de configuración, añada su Additional IP al fichero como sigue, sustituyendo `ADDITIONAL_IP/32` por sus propios valores: +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=ADDITIONAL_IP/32 +>> ``` +>> +>> Si tiene dos direcciones Additional IP que configurar, la configuración debería ser similar a la siguiente: +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=ADDITIONAL_IP1/32 +>> address2=ADDITIONAL_IP2/32 +>> ``` +>> +>> /// details | **Ejemplo** +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=203.0.113.0/32 +>> ``` +>> /// +>> +>> **3\. reiniciar la interfaz** +>> +>> ```bash +>> sudo systemctl restart NetworkManager +>> ``` +>> +> cPanel +>> **cPanel** +>> +>> **1\. acceder a la sección de gestión de las IP del WHM** +>> +>> En el área de cliente de WHM, haga clic en `IP Functions`{.action} y seleccione `Add a New IP Address`{.action} en el menú de la izquierda. +>> +>> ![Add new IP](images/cpanel-alma-1.png){.thumbnail} +>> +>> **2\. añadir la información de las direcciones Additional IP** +>> +>> Introduzca su dirección Additional IP con el formato `xxx.xxx.xxx.xxx` en el campo `New IP or IP range to add`. +>> +>> Seleccione `255.255.255.255` como máscara de subred y haga clic en `Submit`{.action}. +>> +>> ![enter new IP information](images/cpanel-alma-2.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Atención, si tiene varias IP que configurar en un mismo bloque y las añade todas al mismo tiempo, el sistema WHM le obligará a utilizar la máscara de subred `255.255.255.0`. No se recomienda utilizar esta configuración, es necesario añadir cada IP individualmente para poder utilizar la máscara de subred adecuada `255.255.255.255`. +>> > +>> +>> **3\. comprobar la configuración IP actual** +>> +>> Vuelva a la sección `IP Functions`{.action} y haga clic en `Show or Delete Current IP Addresses`{.action} para comprobar que la dirección Additional IP se ha añadido correctamente. +>> +>> ![check configured IP](images/cpanel-alma-3.png){.thumbnail} +>> +> Plesk +>> **Plesk** +>> +>> **1\. acceder a la gestión de IP de Plesk** +>> +>> En el panel de configuración de Plesk, seleccione `Tools & Settings`{.action} en la columna izquierda. +>> +>> ![acceso a la gestión de las direcciones IP](images/pleskip1.png){.thumbnail} +>> +>> Haga clic en `IP Addresses`{.action} bajo **Tools & Settings**. +>> +>> **2\. añadir la información IP adicional** +>> +>> En esta sección, haga clic en el botón `Add IP Address`{.action}. +>> +>> ![añadir información IP](images/Plesk-2024-vps.png){.thumbnail} +>> +>> Introduzca su dirección Additional IP como `xxx.xxx.xxx.xxx/32` en el campo "IP address and subnet mask" y haga clic en `OK`{.action}. +>> +>> ![añadir información IP](images/Plesk-additional-ip.png){.thumbnail} +>> +>> **3\. comprobar la configuración IP actual** +>> +>> En la sección "IP Addresses", compruebe que la dirección Additional IP se haya añadido correctamente. +>> +>> ![configuración IP actual](images/plesk-final-configuration.png){.thumbnail} +>> +> Windows Server +>> **Windows Server** +>> +>> **1\. comprobar la configuración de red** +>> +>> Haga clic derecho en el botón `Start`{.action} y abra `Run`{.action}. +>> +>> Pulse `cmd` y haga clic en `OK`{.action} para abrir la aplicación de línea de órdenes. +>> +>> ![cmdprompt](images/vps_win07.png){.thumbnail} +>> +>> Para obtener la configuración de IP actual, introduzca `ipconfig` en la consola de comandos. +>> +>> ```console +>> C:\Users\Administrator>ipconfig +>> +>> Windows IP Configuration +>> +>> Ethernet adapter Ethernet: +>> +>> Connection-specific DNS Suffix . : openstacklocal +>> Link-local IPv6 Address . . . . . : fe90::30gf:258a:84d6:abcf%5 +>> IPv4 Address. . . . . . . . . . . : 192.0.2.29 +>> Subnet Mask . . . . . . . . . . . : 255.255.255.255 +>> Default Gateway . . . . . . . . . : 192.0.2.1 +>> ``` +>> +>> **2\. modificar las propiedades IPv4** +>> +>> 1. Vaya al menú `Start`{.action}, luego `Control Panel`{.action}, `Network and Internet`{.action}, `Network and Sharing Centre`{.action} y `Change Adapter Settings`{.action} en la barra de la izquierda. +>> 2. Haga clic derecho en `Ethernet`{.action}; +>> 3. Haga clic en `Properties`{.action}; +>> 4. Seleccione `Internet Protocol Version 4 (TCP/IPv4)`{.action} y haga clic en `Properties`{.action}; +>> 5. Haga clic en `Use the following IP address`{.action} e introduzca la IP principal del servidor, la máscara de subred y la puerta de enlace por defecto obtenidas con el comando `ipconfig`{.action} anterior. En el cuadro "Preferred DNS Server", escriba "213.186.33.99". +>> +>> ![change the ip configuration](images/configure-main-ip.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Atención: si introduce información incorrecta, no podrá acceder al servidor. En ese caso, deberá realizar las correcciones oportunas a través del KVM. +>> > +>> +>> **3\. añadir la dirección Additional IP en los Parámetros TCP/IP avanzados** +>> +>> En la nueva ventana, haga clic en `Add...`{.action} en "IP addresses". Introduzca su dirección Additional IP y la máscara de subred (255.255.255.255). +>> +>> ![sección de configuración avanzada](images/configure-additional-ip.png){.thumbnail} +>> +>> Confirme haciendo clic en `Add`{.action}. +>> +>> ![Additional IP configuration](images/additional-ip-config.png){.thumbnail} +>> +>> A continuación, haga clic en `OK`{.action} para aplicar la configuración. +>> +>> ![Configuración del cambio de IP](images/final-configuration.png){.thumbnail} +>> +>> Perderá la conexión con su servidor durante unos segundos. +>> +>> **4\. comprobar la configuración IP actual** +>> +>> Abra el símbolo del sistema (cmd) e introduzca `ipconfig`. La configuración debe incluir ahora la nueva dirección Additional IP. +>> +>> ```console +>> C:\Users\Administrator>ipconfig +>> +>> Windows IP Configuration +>> +>> Ethernet adapter Ethernet: +>> +>> Connection-specific DNS Suffix . : +>> Link-local IPv6 Address . . . . . : fe90::30gf:258a:84d6:abcf%5 +>> IPv4 Address. . . . . . . . . . . : 192.0.2.29 +>> Subnet Mask . . . . . . . . . . . : 255.255.255.255 +>> IPv4 Address. . . . . . . . . . . : 203.0.113.0 +>> Subnet Mask . . . . . . . . . . . : 255.255.255.255 +>> Default Gateway . . . . . . . . . : 192.0.2.1 +>> ``` ### Diagnóstico @@ -487,4 +521,4 @@ Para probar la conexión, solo tiene que enviar un ping a su dirección Addition Si quiere disfrutar de ayuda para utilizar y configurar sus soluciones de OVHcloud, puede consultar nuestras distintas soluciones [pestañas de soporte](/links/support). -Interactúe con nuestra comunidad de usuarios en . +Interactúe con nuestra [comunidad de usuarios](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/guide.fr-fr.md b/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/guide.fr-fr.md index 61bf4916112..9f8d5dccb87 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/guide.fr-fr.md +++ b/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/guide.fr-fr.md @@ -1,9 +1,23 @@ --- title: 'Configurer une adresse IP en alias' excerpt: 'Découvrez comment ajouter des adresses Additional IP à votre configuration VPS' -updated: 2025-09-11 +updated: 2025-11-12 --- + + ## Objectif L'alias d'IP (*IP aliasing* en anglais) est une configuration spéciale du réseau pour vos serveurs OVHcloud. Elle vous permet d'associer plusieurs adresses IP sur une seule interface réseau. @@ -14,7 +28,7 @@ L'alias d'IP (*IP aliasing* en anglais) est une configuration spéciale du rése > > OVHcloud met à votre disposition des services dont la configuration, la gestion et la responsabilité vous incombent. En effet, n’ayant aucun accès à ces machines, nous n’en sommes pas les administrateurs et nous ne pourrons pas vous fournir d'assistance. Il vous appartient de ce fait d’en assurer la gestion logicielle et la sécurisation au quotidien. > -> Nous mettons à votre disposition ce guide afin de vous accompagner au mieux sur des tâches courantes. Néanmoins, nous vous recommandons de faire appel à un [prestataire spécialisé](https://marketplace.ovhcloud.com/) si vous éprouvez des difficultés ou des doutes concernant l’administration, l’utilisation ou la sécurisation d’un serveur. Plus d’informations dans la section « Aller plus loin » de ce guide. +> Nous mettons à votre disposition ce guide afin de vous accompagner au mieux sur des tâches courantes. Néanmoins, nous vous recommandons de faire appel à un [prestataire spécialisé](/links/transversal/marketplace) si vous éprouvez des difficultés ou des doutes concernant l’administration, l’utilisation ou la sécurisation d’un serveur. Plus d’informations dans la section « Aller plus loin » de ce guide. > ## Prérequis @@ -45,426 +59,447 @@ En ce qui concerne les différentes versions de distributions, veuillez noter qu |NETWORK_INTERFACE|Nom de l'interface réseau|*eth0*, *ens3*| |ID|ID de l'alias IP, commençant par *0* (en fonction du nombre d'adresses IP supplémentaires à configurer)|*0*, *1*| -### Debian 11 - -#### Étape 1 : désactiver la configuration automatique du réseau - -Ouvrez le chemin d'accès au fichier suivant avec un éditeur de texte, dans notre exemple nous utilisons `nano`. : - -```bash -sudo nano /etc/cloud/cloud.cfg.d/99-disable-network-config.cfg -``` - -Entrez la ligne suivante, puis enregistrez et quittez l'éditeur. - -```console -network: {config: disabled} -``` - -La création de ce fichier de configuration empêche l'exécution automatique des modifications apportées à la configuration de votre réseau. - -#### Étape 2 : créer une sauvegarde - -Par défaut, le fichier de configuration est situé dans le chemin `etc/network/interfaces.d`. - -Dans notre exemple, notre fichier s'appelle `50-cloud-init`, donc nous faisons une copie du fichier `50-cloud-init` en utilisant la commande suivante : - -```bash -sudo cp /etc/network/interfaces.d/50-cloud-init /etc/network/interfaces.d/50-cloud-init.bak -``` - -En cas d'erreur, vous pourrez revenir sur les modifications en utilisant les commandes ci-dessous : - -```bash -sudo rm -f /etc/network/interfaces.d/50-cloud-init -sudo cp /etc/network/interfaces.d/50-cloud-init.bak /etc/network/interfaces.d/50-cloud-init -``` - -#### Étape 3 : éditer le fichier de configuration - -Vérifiez le nom de votre interface réseau à l'aide de la commande suivante : - -```bash -ip a -``` - -Ouvrez le fichier de configuration réseau pour le modifier à l'aide de la commande suivante : - -```bash -sudo nano /etc/network/interfaces.d/50-cloud-init -``` +Dans les exemples ci-dessous, nous utiliserons l'éditeur de texte `nano`. Sur certains systèmes d'exploitation, vous devrez l'installer avant de pouvoir l'utiliser. Si c'est le cas, vous serez invité à le faire. Vous pouvez bien sûr utiliser l'éditeur de texte de votre choix. -Pour configurer votre adresse Additional IP, ajoutez une interface virtuelle ou un alias Ethernet à votre interface réseau. Dans notre exemple, notre interface s'appelle `eth0`, donc notre premier alias est `eth0:0`. Faites ceci pour chaque adresse Additional IP que vous souhaitez configurer. - -Ne modifiez pas les lignes existantes dans le fichier de configuration, ajoutez uniquement votre adresse Additional IP au fichier comme suit, en remplaçant `NETWORK_INTERFACE`, `ID` et `ADDITIONAL_IP` par vos propres valeurs : - -```console -auto NETWORK_INTERFACE:ID -iface NETWORK_INTERFACE:ID inet static -address ADDITIONAL_IP -netmask 255.255.255.255 -``` - -Si vous configurez plus d'une adresse Additional IP, votre fichier de configuration devrait ressembler à ceci : - -```console -auto NETWORK_INTERFACE:ID -iface NETWORK_INTERFACE:ID inet static -address ADDITIONAL_IP1 -address ADDITIONAL_IP2 -netmask 255.255.255.255 -``` - -**Exemple** - -```console -auto eth0:0 -iface eth0:0 inet static -address 203.0.113.0 -netmask 255.255.255.255 -``` - -#### Étape 4 : redémarrer l'interface - -Appliquez les modifications à l'aide de la commande suivante : - -```bash -sudo systemctl restart networking -``` - -### Debian 12, Ubuntu 20.04 et versions ultérieures - -Le fichier de configuration de vos adresses Additional IP se trouve dans le fichier `/etc/netplan/`. Dans cet exemple, il s'appelle `50-cloud-init.yaml`. - -La meilleure pratique consiste à créer un fichier de configuration distinct pour définir les adresses Additional IP. De cette manière, vous pouvez facilement revenir sur les modifications en cas d'erreur. - -#### Étape 1 : créer le fichier de configuration du réseau - -Dans notre exemple, notre fichier s'appelle `51-cloud-init.yaml` : - -```bash -sudo touch /etc/netplan/51-cloud-init.yaml -``` - -#### Étape 2 : modifier le fichier de configuration - -Vérifiez le nom de votre interface réseau à l'aide de la commande suivante : - -```bash -ip a -``` - -Ouvrez le fichier de configuration réseau pour le modifier à l'aide de la commande suivante : - -```bash -sudo nano /etc/netplan/51-cloud-init.yaml -``` - -Editez le fichier avec le contenu ci-dessous, en remplaçant `INTERFACE_NAME` et `ADDITIONAL_IP` par vos propres valeurs : - -```yaml -network: - version: 2 - ethernets: - INTERFACE_NAME: - dhcp4: true - addresses: - - ADDITIONAL_IP1/32 -``` - -Si vous avez plus d'une adresse Additional IP à configurer, le fichier de configuration devrait ressembler à ceci : - -```yaml -network: - version: 2 - ethernets: - INTERFACE_NAME: - dhcp4: true - addresses: - - ADDITIONAL_IP1/32 - - ADDITIONAL_IP2/32 -``` - - -> [!warning] +> [!success] +> Sélectionnez l'onglet correspondant à votre système d'exploitation. > -> Il est important de respecter l'alignement de chaque élément de ce fichier tel que représenté dans l'exemple ci-dessus. N'utilisez pas la touche de tabulation pour créer votre espacement. -> - -**Exemple** - -```yaml -network: - version: 2 - ethernets: - eth0: - dhcp4: true - addresses: - - 203.0.113.0/32 -``` - -Enregistrez et fermez le fichier. - -#### Étape 3 : appliquer la nouvelle configuration réseau -Testez votre configuration à l'aide de la commande suivante : - -```bash -sudo netplan try -``` - -Si elle est correcte, appliquez-la à l'aide de la commande suivante : - -```bash -sudo netplan apply -``` - -Répétez cette procédure pour chaque adresse Additional IP. - -### AlmaLinux (8 & 9), Rocky Linux (8 & 9) - -Le fichier de configuration principal est situé dans le dossier `/etc/sysconfig/network-scripts/`. Dans cet exemple, il est appelé `ifcfg-eth0`. Avant de faire des changements, vérifiez le nom réel du fichier dans ce dossier. - -Pour chaque adresse Additional IP à configurer, créez un fichier de configuration séparé avec les paramètres suivants : `ifcfg-NETWORK_INTERFACE:ID`. Où `NETWORK_INTERFACE` représente l'interface physique et `ID` représente l'interface réseau virtuelle ou l'alias ethernet commençant par une valeur de 0. Par exemple, pour notre interface nommée `eth0` le premier alias est `eth0:0`, le second alias est `eth0:1`, etc. - -#### Étape 1 : déterminer l'interface - -Vérifiez le nom de votre interface réseau à l'aide de la commande suivante : - -```bash -ip a -``` - -#### Étape 2 : créer le fichier de configuration - -Tout d'abord, créez le fichier de configuration. Remplacez `NETWORK_INTERFACE:ID` par vos propres valeurs. - -```bash -sudo nano /etc/sysconfig/network-scripts/ifcfg-NETWORK_INTERFACE:ID -``` - -Ensuite, éditez le fichier avec le contenu ci-dessous, en remplaçant `NETWORK_INTERFACE:ID`, et `ADDITIONAL_IP` par vos propres valeurs : - -```console -DEVICE=NETWORK_INTERFACE:ID -ONBOOT=yes -BOOTPROTO=none # For CentOS use "static" -IPADDR=ADDITIONAL_IP -NETMASK=255.255.255.255 -BROADCAST=ADDITIONAL_IP -``` - -**Exemple** - -```console -DEVICE=eth0:0 -ONBOOT=yes -BOOTPROTO=none # For CentOS use "static" -IPADDR=203.0.113.0 -NETMASK=255.255.255.255 -BROADCAST=203.0.113.0 -``` - -#### Étape 3 : redémarrer l'interface - -```bash -sudo systemctl restart network -``` - -#### Pour AlmaLinux et Rocky Linux - -```bash -sudo systemctl restart NetworkManager -``` - -### Fedora 37 et versions ultérieures - -Fedora utilise maintenant des fichiers clés. NetworkManager stockait auparavant les profils réseau au format ifcfg dans ce répertoire : `/etc/sysconfig/network-scripts/`. Cependant, le format ifcfg est maintenant obsolète. Par défaut, NetworkManager ne crée plus de nouveaux profils dans ce format. Le fichier de configuration se trouve maintenant dans `/etc/NetworkManager/system-connections/`. - -#### Étape 1 : créer une sauvegarde - -Dans notre exemple, notre fichier s'appelle `cloud-init-eno1.nmconnection`, donc nous faisons une copie du fichier `cloud-init-eno1.nmconnection` en utilisant la commande suivante : - -```bash -sudo cp -r /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak -``` - -En cas d'erreur, vous pourrez revenir sur les modifications en utilisant les commandes ci-dessous : - -```bash -sudo rm -f /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -sudo cp /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -``` - -#### Étape 2 : modifier le fichier de configuration - -> [!primary] -> Veuillez noter que le nom du fichier réseau dans notre exemple peut être différent du vôtre. Veuillez adapter les commandes à votre nom de fichier. -> - -```bash -sudo nano /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -``` - -Ne modifiez pas les lignes existantes dans le fichier de configuration, ajoutez votre Additional IP au fichier comme suit, en remplaçant `ADDITIONAL_IP/32` par vos propres valeurs : - -```console -[ipv4] -method=auto -may-fail=false -address1=ADDITIONAL_IP/32 -``` - -Si vous avez deux adresses Additional IP à configurer, la configuration devrait ressembler à ceci : - -```console -[ipv4] -method=auto -may-fail=false -address1=ADDITIONAL_IP1/32 -address2=ADDITIONAL_IP2/32 -``` - -**Exemple** - -```console -[ipv4] -method=auto -may-fail=false -address1=203.0.113.0/32 -``` - -#### Étape 3 : redémarrer l'interface - -Redémarrez votre interface : - -```bash -sudo systemctl restart NetworkManager -``` - -### cPanel - -#### Étape 1 : accéder à la section de gestion des IP du WHM - -Dans l'espace client WHM, cliquez sur `IP Functions`{.action} et sélectionnez `Add a New IP Address`{.action} dans le menu de gauche. - -![Add new IP](images/cpanel-alma-1.png){.thumbnail} - -#### Étape 2 : ajouter les informations des Additional IP - -Renseignez votre adresse Additional IP sous la forme « xxx.xxx.xxx.xxx » dans le champ « New IP or IP range to add ». - -Sélectionnez `255.255.255.255` comme masque de sous-réseau puis cliquez sur `Submit`{.action}. - -![enter new IP information](images/cpanel-alma-2.png){.thumbnail} - -> [!warning] -> -> Attention, si vous avez plusieurs IP à configurer sur un même bloc et que vous les ajoutez toutes en même temps, le système WHM vous forcera à utiliser le masque de sous-réseau `255.255.255.0`. Il n'est pas recommandé d'utiliser cette configuration, il faut ajouter chaque IP individuellement pour pouvoir utiliser le masque de sous-réseau approprié `255.255.255.255`. -> - -#### Étape 3 : vérifier la configuration IP actuelle - -De retour dans la section `IP Functions`{.action}, cliquez sur `Show or Delete Current IP Addresses`{.action} pour vérifier que l'adresse Additional IP a été correctement ajoutée. - -![check configured IP](images/cpanel-alma-3.png){.thumbnail} - -### Plesk - -#### Étape 1 : accéder à la gestion d'IP de Plesk - -Dans le panneau de configuration Plesk, choisissez `Tools & Settings`{.action} dans la barre latérale gauche. - -![accès à la gestion des adresses IP](images/pleskip1.png){.thumbnail} - -Cliquez sur `IP Addresses`{.action} sous **Tools & Settings**. - -#### Étape 2 : ajouter les informations des Additional IP - -Dans cette section, cliquez sur le bouton `Add IP Address`{.action}. - -![ajouter des informations IP](images/Plesk-2024-vps.png){.thumbnail} - -Entrez votre adresse Additional IP sous la forme `xxx.xxx.xxx.xxx/32` dans le champ « IP address and subnet mask », puis cliquez sur `OK`{.action}. - -![ajouter des informations IP](images/Plesk-additional-ip.png){.thumbnail} - -#### Étape 3 : vérifier la configuration IP actuelle - -Dans la section « IP Addresses », vérifiez que l'adresse Additional IP a été correctement ajoutée. - -![configuration IP actuelle](images/plesk-final-configuration.png){.thumbnail} - -### Windows Server - -#### Étape 1 : vérifier la configuration réseau - -Faites un clic droit sur le bouton `Menu Démarrer`{.action} et ouvrez `Exécuter`{.action}. - -Tapez `cmd` et cliquez sur `OK`{.action} pour ouvrir l'application de ligne de commande. - -![cmdprompt](images/vps_win07.png){.thumbnail} - -Pour récupérer la configuration IP actuelle, entrez `ipconfig` dans l'invite de commande. - -```console -C:\Users\Administrator>ipconfig -Windows IP Configuration -Ethernet adapter Ethernet: - Connection-specific DNS Suffix . : openstacklocal - Link-local IPv6 Address . . . . . : fe90::30gf:258a:84d6:abcf%5 - IPv4 Address. . . . . . . . . . . : 192.0.2.29 - Subnet Mask . . . . . . . . . . . : 255.255.255.255 - Default Gateway . . . . . . . . . : 192.0.2.1 -``` - -#### Étape 2 : modifier les propriétés IPv4 - -1. Allez dans le menu `Démarrer`{.action}, puis `Panneau de gestion`{.action}, `Réseau et Internet`{.action}, `Centre de réseau et Partage`{.action} et `Modifier les paramètres de la carte`{.action} dans la barre de gauche ; -2. Effectuez un clic droit sur `Connexion au réseau local`{.action} ; -3. Cliquez sur `Propriétés`{.action} ; -4. Sélectionnez `Protocole Internet Version 4 (TCP/IPv4)`{.action}, puis cliquez sur `Propriétés`{.action} ; -5. Cliquez sur `Utiliser l’adresse IP suivante`{.action} et renseignez l’IP principale de votre serveur, le masque sous-réseau et la passerelle par défaut obtenus grâce à la commande `ipconfig`{.action} ci-dessus. Dans la case « Serveur DNS Préféré », tapez « 213.186.33.99 ». - -![change the ip configuration](images/configure-main-ip.png){.thumbnail} - -> [!warning] -> -> Attention, le serveur ne sera plus accessible si vous entrez des informations incorrectes. Vous serez alors obligé d’effectuer les corrections via le KVM. -> - -#### Étape 3 : ajouter l'adresse Additional IP dans les Paramètres TCP/IP avancés - -Dans la nouvelle fenêtre, cliquez sur `Ajouter...`{.action} sous « Adresses IP ». Entrez votre adresse Additional IP et le masque de sous-réseau (255.255.255.255). - -![advance configuration section](images/configure-additional-ip.png){.thumbnail} - -Confirmez en cliquant sur `Ajouter`{.action}. - -![Additional IP configuration](images/additional-ip-config.png){.thumbnail} - -Cliquez ensuite sur `OK`{.action} pour appliquer la configuration. - -![Additional IP configuration](images/final-configuration.png){.thumbnail} - -Vous perdrez la connexion à votre serveur pendant quelques secondes. - -#### Étape 4 : vérifier la nouvelle configuration réseau - -Ouvrez l'invite de commandes (cmd) et entrez `ipconfig`. La configuration doit maintenant inclure la nouvelle adresse Additional IP. - -```console -C:\Users\Administrator>ipconfig -Windows IP Configuration -Ethernet adapter Ethernet: - Connection-specific DNS Suffix . : - Link-local IPv6 Address . . . . . : fe90::30gf:258a:84d6:abcf%5 - IPv4 Address. . . . . . . . . . . : 192.0.2.29 - Subnet Mask . . . . . . . . . . . : 255.255.255.255 - IPv4 Address. . . . . . . . . . . : 203.0.113.0 - Subnet Mask . . . . . . . . . . . : 255.255.255.255 - Default Gateway . . . . . . . . . : 192.0.2.1 -``` +> [!tabs] +> Debian 11 +>> **Debian 11** +>> +>> **Étape 1 : désactiver la configuration automatique du réseau** +>> +>> Ouvrez le chemin d'accès au fichier suivant avec un éditeur de texte. +>> +>> ```bash +>> sudo nano /etc/cloud/cloud.cfg.d/99-disable-network-config.cfg +>> ``` +>> +>> Entrez la ligne suivante, puis enregistrez et quittez l'éditeur. +>> +>> ```console +>> network: {config: disabled} +>> ``` +>> +>> La création de ce fichier de configuration empêche l'exécution automatique des modifications apportées à la configuration de votre réseau. +>> +>> **Étape 2 : créer une sauvegarde** +>> +>> Par défaut, le fichier de configuration est situé dans le chemin `etc/network/interfaces.d`. +>> +>> Dans notre exemple, notre fichier s'appelle `50-cloud-init`, donc nous faisons une copie du fichier `50-cloud-init` en utilisant la commande suivante : +>> +>> ```bash +>> sudo cp /etc/network/interfaces.d/50-cloud-init /etc/network/interfaces.d/50-cloud-init.bak +>> ``` +>> +>> En cas d'erreur, vous pourrez revenir sur les modifications en utilisant les commandes ci-dessous : +>> +>> ```bash +>> sudo rm -f /etc/network/interfaces.d/50-cloud-init +>> sudo cp /etc/network/interfaces.d/50-cloud-init.bak /etc/network/interfaces.d/50-cloud-init +>> ``` +>> +>> **Étape 3 : éditer le fichier de configuration** +>> +>> Vérifiez le nom de votre interface réseau à l'aide de la commande suivante : +>> +>> ```bash +>> ip a +>> ``` +>> +>> Ouvrez le fichier de configuration réseau pour le modifier à l'aide de la commande suivante : +>> +>> ```bash +>> sudo nano /etc/network/interfaces.d/50-cloud-init +>> ``` +>> +>> Pour configurer votre adresse Additional IP, ajoutez une interface virtuelle ou un alias Ethernet à votre interface réseau. Dans notre exemple, notre interface s'appelle `eth0`, donc notre premier alias est `eth0:0`. Faites ceci pour chaque adresse Additional IP que vous souhaitez configurer. +>> +>> Ne modifiez pas les lignes existantes dans le fichier de configuration, ajoutez uniquement votre adresse Additional IP au fichier comme suit, en remplaçant `NETWORK_INTERFACE`, `ID` et `ADDITIONAL_IP` par vos propres valeurs : +>> +>> ```console +>> auto NETWORK_INTERFACE:ID +>> iface NETWORK_INTERFACE:ID inet static +>> address ADDITIONAL_IP +>> netmask 255.255.255.255 +>> ``` +>> +>> Si vous configurez plus d'une adresse Additional IP, votre fichier de configuration devrait ressembler à ceci : +>> +>> ```console +>> auto NETWORK_INTERFACE:ID +>> iface NETWORK_INTERFACE:ID inet static +>> address ADDITIONAL_IP1 +>> address ADDITIONAL_IP2 +>> netmask 255.255.255.255 +>> ``` +>> +>> /// details | **Exemple** +>> +>> ```console +>> auto eth0:0 +>> iface eth0:0 inet static +>> address 203.0.113.0 +>> netmask 255.255.255.255 +>> ``` +>> /// +>> +>> **Étape 4 : redémarrer l'interface** +>> +>> Appliquez les modifications à l'aide de la commande suivante : +>> +>> ```bash +>> sudo systemctl restart networking +>> ``` +>> +> Debian 12, Ubuntu 20.04+ +>> **Debian 12, Ubuntu 20.04 et versions ultérieures** +>> +>> Le fichier de configuration de vos adresses Additional IP se trouve dans le fichier `/etc/netplan/`. Dans cet exemple, il s'appelle `50-cloud-init.yaml`. +>> +>> La meilleure pratique consiste à créer un fichier de configuration distinct pour définir les adresses Additional IP. De cette manière, vous pouvez facilement revenir sur les modifications en cas d'erreur. +>> +>> **Étape 1 : créer le fichier de configuration du réseau** +>> +>> Dans notre exemple, notre fichier s'appelle `51-cloud-init.yaml` : +>> +>> ```bash +>> sudo touch /etc/netplan/51-cloud-init.yaml +>> ``` +>> +>> **Étape 2 : modifier le fichier de configuration** +>> +>> Vérifiez le nom de votre interface réseau à l'aide de la commande suivante : +>> +>> ```bash +>> ip a +>> ``` +>> +>> Ouvrez le fichier de configuration réseau pour le modifier à l'aide de la commande suivante : +>> +>> ```bash +>> sudo nano /etc/netplan/51-cloud-init.yaml +>> ``` +>> +>> Editez le fichier avec le contenu ci-dessous, en remplaçant `INTERFACE_NAME` et `ADDITIONAL_IP` par vos propres valeurs : +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> INTERFACE_NAME: +>> dhcp4: true +>> addresses: +>> - ADDITIONAL_IP1/32 +>> ``` +>> +>> Si vous avez plus d'une adresse Additional IP à configurer, le fichier de configuration devrait ressembler à ceci : +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> INTERFACE_NAME: +>> dhcp4: true +>> addresses: +>> - ADDITIONAL_IP1/32 +>> - ADDITIONAL_IP2/32 +>> ``` +>> +>> > [!warning] +>> > Il est important de respecter l'alignement de chaque élément de ce fichier tel que représenté dans l'exemple ci-dessus. N'utilisez pas la touche de tabulation pour créer votre espacement. +>> > +>> +>> /// details | **Exemple** +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> eth0: +>> dhcp4: true +>> addresses: +>> - 203.0.113.0/32 +>> ``` +>> /// +>> +>> Enregistrez et fermez le fichier. +>> +>> **Étape 3 : appliquer la nouvelle configuration réseau** +>> +>> Testez votre configuration à l'aide de la commande suivante : +>> +>> ```bash +>> sudo netplan try +>> ``` +>> +>> Si elle est correcte, appliquez-la à l'aide de la commande suivante : +>> +>> ```bash +>> sudo netplan apply +>> ``` +>> +>> Répétez cette procédure pour chaque adresse Additional IP. +>> +> AlmaLinux / Rocky Linux (8/9) +>> **AlmaLinux (8/9), Rocky Linux (8/9)** +>> +>> Le fichier de configuration principal est situé dans le dossier `/etc/sysconfig/network-scripts/`. Dans cet exemple, il est appelé `ifcfg-eth0`. Avant de faire des changements, vérifiez le nom réel du fichier dans ce dossier. +>> +>> Pour chaque adresse Additional IP à configurer, créez un fichier de configuration séparé avec les paramètres suivants : `ifcfg-NETWORK_INTERFACE:ID`. Où `NETWORK_INTERFACE` représente l'interface physique et `ID` représente l'interface réseau virtuelle ou l'alias ethernet commençant par une valeur de 0. Par exemple, pour notre interface nommée `eth0` le premier alias est `eth0:0`, le second alias est `eth0:1`, etc. +>> +>> **Étape 1 : déterminer l'interface** +>> +>> Vérifiez le nom de votre interface réseau à l'aide de la commande suivante : +>> +>> ```bash +>> ip a +>> ``` +>> +>> **Étape 2 : créer le fichier de configuration** +>> +>> Tout d'abord, créez le fichier de configuration. Remplacez `NETWORK_INTERFACE:ID` par vos propres valeurs. +>> +>> ```bash +>> sudo nano /etc/sysconfig/network-scripts/ifcfg-NETWORK_INTERFACE:ID +>> ``` +>> +>> Ensuite, éditez le fichier avec le contenu ci-dessous, en remplaçant `NETWORK_INTERFACE:ID`, et `ADDITIONAL_IP` par vos propres valeurs : +>> +>> ```console +>> DEVICE=NETWORK_INTERFACE:ID +>> ONBOOT=yes +>> BOOTPROTO=none # For CentOS use "static" +>> IPADDR=ADDITIONAL_IP +>> NETMASK=255.255.255.255 +>> BROADCAST=ADDITIONAL_IP +>> ``` +>> +>> /// details | **Exemple** +>> +>> ```console +>> DEVICE=eth0:0 +>> ONBOOT=yes +>> BOOTPROTO=none # For CentOS use "static" +>> IPADDR=203.0.113.0 +>> NETMASK=255.255.255.255 +>> BROADCAST=203.0.113.0 +>> ``` +>> /// +>> +>> **Étape 3 : redémarrer l'interface** +>> +>> ```bash +>> sudo systemctl restart network +>> ``` +>> +>> Pour AlmaLinux et Rocky Linux +>> +>> ```bash +>> sudo systemctl restart NetworkManager +>> ``` +>> +> Fedora 42 +>> **Fedora 42** +>> +>> Fedora utilise maintenant des fichiers clés. NetworkManager stockait auparavant les profils réseau au format ifcfg dans ce répertoire : `/etc/sysconfig/network-scripts/`. Cependant, le format ifcfg est maintenant obsolète. Par défaut, NetworkManager ne crée plus de nouveaux profils dans ce format. Le fichier de configuration se trouve maintenant dans `/etc/NetworkManager/system-connections/`. +>> +>> **Étape 1 : créer une sauvegarde** +>> +>> Dans notre exemple, notre fichier s'appelle `cloud-init-eno1.nmconnection`, donc nous faisons une copie du fichier `cloud-init-eno1.nmconnection` en utilisant la commande suivante : +>> +>> ```bash +>> sudo cp -r /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak +>> ``` +>> +>> En cas d'erreur, vous pourrez revenir sur les modifications en utilisant les commandes ci-dessous : +>> +>> ```bash +>> sudo rm -f /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> sudo cp /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> ``` +>> +>> **Étape 2 : modifier le fichier de configuration** +>> +>> > [!primary] +>> > Veuillez noter que le nom du fichier réseau dans notre exemple peut être différent du vôtre. Veuillez adapter les commandes à votre nom de fichier. +>> > +>> +>> ```bash +>> sudo nano /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> ``` +>> +>> Ne modifiez pas les lignes existantes dans le fichier de configuration, ajoutez votre Additional IP au fichier comme suit, en remplaçant `ADDITIONAL_IP/32` par vos propres valeurs : +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=ADDITIONAL_IP/32 +>> ``` +>> +>> Si vous avez deux adresses Additional IP à configurer, la configuration devrait ressembler à ceci : +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=ADDITIONAL_IP1/32 +>> address2=ADDITIONAL_IP2/32 +>> ``` +>> +>> /// details | **Exemple** +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=203.0.113.0/32 +>> ``` +>> /// +>> +>> **Étape 3 : redémarrer l'interface** +>> +>> Redémarrez votre interface : +>> +>> ```bash +>> sudo systemctl restart NetworkManager +>> ``` +>> +> cPanel +>> **cPanel** +>> +>> **Étape 1 : accéder à la section de gestion des IP du WHM.** +>> +>> Dans l'espace client WHM, cliquez sur `IP Functions`{.action} et sélectionnez `Add a New IP Address`{.action} dans le menu de gauche. +>> +>> ![Add new IP](images/cpanel-alma-1.png){.thumbnail} +>> +>> **Étape 2 : ajouter les informations des Additional IP.** +>> +>> Renseignez votre adresse Additional IP sous la forme « xxx.xxx.xxx.xxx » dans le champ « New IP or IP range to add ». +>> +>> Sélectionnez `255.255.255.255` comme masque de sous-réseau puis cliquez sur `Submit`{.action}. +>> +>> ![enter new IP information](images/cpanel-alma-2.png){.thumbnail} +>> +>> > [!warning] +>> > Attention, si vous avez plusieurs IP à configurer sur un même bloc et que vous les ajoutez toutes en même temps, le système WHM vous forcera à utiliser le masque de sous-réseau `255.255.255.0`. Il n'est pas recommandé d'utiliser cette configuration, il faut ajouter chaque IP individuellement pour pouvoir utiliser le masque de sous-réseau approprié `255.255.255.255`. +>> > +>> +>> **Étape 3 : vérifier la configuration IP actuelle.** +>> +>> De retour dans la section `IP Functions`{.action}, cliquez sur `Show or Delete Current IP Addresses`{.action} pour vérifier que l'adresse Additional IP a été correctement ajoutée. +>> +>> ![check configured IP](images/cpanel-alma-3.png){.thumbnail} +>> +> Plesk +>> **Plesk** +>> +>> **Étape 1 : accéder à la gestion d'IP de Plesk** +>> +>> Dans le panneau de configuration Plesk, choisissez `Tools & Settings`{.action} dans la barre latérale gauche. +>> +>> ![accès à la gestion des adresses IP](images/pleskip1.png){.thumbnail} +>> +>> Cliquez sur `IP Addresses`{.action} sous **Tools & Settings**. +>> +>> **Étape 2 : ajouter les informations des Additional IP** +>> +>> Dans cette section, cliquez sur le bouton `Add IP Address`{.action}. +>> +>> ![ajouter des informations IP](images/Plesk-2024-vps.png){.thumbnail} +>> +>> Entrez votre adresse Additional IP sous la forme `xxx.xxx.xxx.xxx/32` dans le champ « IP address and subnet mask », puis cliquez sur `OK`{.action}. +>> +>> ![ajouter des informations IP](images/Plesk-additional-ip.png){.thumbnail} +>> +>> **Étape 3 : vérifier la configuration IP actuelle** +>> +>> Dans la section « IP Addresses », vérifiez que l'adresse Additional IP a été correctement ajoutée. +>> +>> ![configuration IP actuelle](images/plesk-final-configuration.png){.thumbnail} +>> +> Windows Server +>> **Windows Server** +>> +>> **Étape 1 : vérifier la configuration réseau** +>> +>> Faites un clic droit sur le bouton `Menu Démarrer`{.action} et ouvrez `Exécuter`{.action}. +>> +>> Tapez `cmd` et cliquez sur `OK`{.action} pour ouvrir l'application de ligne de commande. +>> +>> ![cmdprompt](images/vps_win07.png){.thumbnail} +>> +>> Pour récupérer la configuration IP actuelle, entrez `ipconfig` dans l'invite de commande. +>> +>> ```console +>> C:\Users\Administrator>ipconfig +>> +>> Windows IP Configuration +>> +>> Ethernet adapter Ethernet: +>> +>> Connection-specific DNS Suffix . : openstacklocal +>> Link-local IPv6 Address . . . . . : fe90::30gf:258a:84d6:abcf%5 +>> IPv4 Address. . . . . . . . . . . : 192.0.2.29 +>> Subnet Mask . . . . . . . . . . . : 255.255.255.255 +>> Default Gateway . . . . . . . . . : 192.0.2.1 +>> ``` +>> +>> **Étape 2 : modifier les propriétés IPv4** +>> +>> 1. Allez dans le menu `Démarrer`{.action}, puis `Panneau de gestion`{.action}, `Réseau et Internet`{.action}, `Centre de réseau et Partage`{.action} et `Modifier les paramètres de la carte`{.action} dans la barre de gauche ; +>> 2. Effectuez un clic droit sur `Connexion au réseau local`{.action} ; +>> 3. Cliquez sur `Propriétés`{.action} ; +>> 4. Sélectionnez `Protocole Internet Version 4 (TCP/IPv4)`{.action}, puis cliquez sur `Propriétés`{.action} ; +>> 5. Cliquez sur `Utiliser l’adresse IP suivante`{.action} et renseignez l’IP principale de votre serveur, le masque sous-réseau et la passerelle par défaut obtenus grâce à la commande `ipconfig`{.action} ci-dessus. Dans la case « Serveur DNS Préféré », tapez « 213.186.33.99 ». +>> +>> ![change the ip configuration](images/configure-main-ip.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Attention, le serveur ne sera plus accessible si vous entrez des informations incorrectes. Vous serez alors obligé d’effectuer les corrections via le KVM. +>> > +>> +>> Étape 3 : ajouter l'adresse Additional IP dans les Paramètres TCP/IP avancés +>> +>> Dans la nouvelle fenêtre, cliquez sur `Ajouter...`{.action} sous « Adresses IP ». Entrez votre adresse Additional IP et le masque de sous-réseau (255.255.255.255). +>> +>> ![advance configuration section](images/configure-additional-ip.png){.thumbnail} +>> +>> Confirmez en cliquant sur `Ajouter`{.action}. +>> +>> ![Additional IP configuration](images/additional-ip-config.png){.thumbnail} +>> +>> Cliquez ensuite sur `OK`{.action} pour appliquer la configuration. +>> +>> ![Additional IP configuration](images/final-configuration.png){.thumbnail} +>> +>> Vous perdrez la connexion à votre serveur pendant quelques secondes. +>> +>> **Étape 4 : vérifier la nouvelle configuration réseau** +>> +>> Ouvrez l'invite de commandes (cmd) et entrez `ipconfig`. La configuration doit maintenant inclure la nouvelle adresse Additional IP. +>> +>> ```console +>> C:\Users\Administrator>ipconfig +>> +>> Windows IP Configuration +>> +>> Ethernet adapter Ethernet: +>> +>> Connection-specific DNS Suffix . : +>> Link-local IPv6 Address . . . . . : fe90::30gf:258a:84d6:abcf%5 +>> IPv4 Address. . . . . . . . . . . : 192.0.2.29 +>> Subnet Mask . . . . . . . . . . . : 255.255.255.255 +>> IPv4 Address. . . . . . . . . . . : 203.0.113.0 +>> Subnet Mask . . . . . . . . . . . : 255.255.255.255 +>> Default Gateway . . . . . . . . . : 192.0.2.1 +>> ``` ### Diagnostic @@ -482,8 +517,8 @@ Pour tester la connexion, envoyez un ping à votre adresse Additional IP depuis [Activer le mode rescue sur un VPS](/pages/bare_metal_cloud/virtual_private_servers/rescue) -[OVHcloud Marketplace](https://marketplace.ovhcloud.com/) +[OVHcloud Marketplace](/links/transversal/marketplace) Si vous souhaitez bénéficier d'une assistance à l'usage et à la configuration de vos solutions OVHcloud, nous vous proposons de consulter nos différentes [offres de support](/links/support). -Échangez avec notre [communauté d'utilisateurs](/links/community). +Échangez avec notre [communauté d'utilisateurs](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/guide.it-it.md b/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/guide.it-it.md index 2cc95fb8167..ae50f289f52 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/guide.it-it.md +++ b/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/guide.it-it.md @@ -1,9 +1,23 @@ --- title: Configurare un indirizzo IP in alias excerpt: Come aggiungere indirizzi Additional IP alla tua configurazione VPS -updated: 2025-09-11 +updated: 2025-11-12 --- + + ## Obiettivo L'alias IP (*IP aliasing* in inglese) è una configurazione di rete speciale per i tuoi server OVHcloud, che ti permette di associare più indirizzi IP su un'unica interfaccia di rete. @@ -45,426 +59,449 @@ Per quanto riguarda le diverse versioni di distribuzione, ti ricordiamo che la p |NETWORK_INTERFACE|Nome dell'interfaccia di rete|*eth0*, *ens3*| |ID|ID dell'alias IP, che inizia con *0* (in base al numero di indirizzi IP aggiuntivi da configurare)|*0*, *1*| -### Debian 11 - -#### Step 1: disattiva la configurazione automatica della rete - -Apri il percorso per accedere al file seguente con un editor di testo: - -```bash -sudo nano /etc/cloud/cloud.cfg.d/99-disable-network-config.cfg -``` - -Inserisci la riga seguente, poi registra e lascia l'editor. - -```console -network: {config: disabled} -``` - -La creazione di questo file di configurazione impedisce l'esecuzione automatica delle modifiche apportate alla configurazione della tua rete. - -#### Step 2: crea un backup - -Per impostazione predefinita, il file di configurazione si trova nel percorso `etc/network/interfaces.d`. - -Nel nostro esempio, il nostro file si chiama `50-cloud-init`, quindi facciamo una copia del file `50-cloud-init` utilizzando il seguente comando: - -```bash -sudo cp /etc/network/interfaces.d/50-cloud-init /etc/network/interfaces.d/50-cloud-init.bak -``` - -In caso di errore, è possibile annullare le modifiche utilizzando i comandi seguenti: - -```bash -sudo rm -f /etc/network/interfaces.d/50-cloud-init -sudo cp /etc/network/interfaces.d/50-cloud-init.bak /etc/network/interfaces.d/50-cloud-init -``` - -#### Step 3: modifica il file di configurazione - -Verifica il nome dell’interfaccia di rete con questo comando: - -```bash -ip a -``` - -Aprire il file di configurazione di rete per modificarlo con il comando seguente: - -```bash -sudo nano /etc/network/interfaces.d/50-cloud-init -``` +Negli esempi riportati di seguito utilizzeremo l'editor di testo `nano`. Su alcuni sistemi operativi sarà necessario installarlo prima di poterlo utilizzare. In tal caso, verrà richiesto di procedere all'installazione. È ovviamente possibile utilizzare l'editor di testo preferito. -Per configurare l'indirizzo Additional IP, aggiungere un'interfaccia virtuale o un alias Ethernet all'interfaccia di rete. Nel nostro esempio, la nostra interfaccia si chiama `eth0`, quindi il nostro primo alias è `eth0:0`. Per ogni indirizzo Additional IP che vuoi configurare. - -Non modificare le righe esistenti nel file di configurazione, aggiungi il tuo indirizzo Additional IP al file come segue, sostituendo `NETWORK_INTERFACE`, `ID` e `ADDITIONAL_IP` con i tuoi valori: - -```console -auto NETWORK_INTERFACE:ID -iface NETWORK_INTERFACE:ID inet static -address ADDITIONAL_IP -netmask 255.255.255.255 -``` - -Se si configura più di un indirizzo Additional IP, il file di configurazione dovrebbe essere simile al seguente: - -```console -auto NETWORK_INTERFACE:ID -iface NETWORK_INTERFACE:ID inet static -address ADDITIONAL_IP1 -address ADDITIONAL_IP2 -netmask 255.255.255.255 -``` - -**Esempio** - -```console -auto eth0:0 -iface eth0:0 inet static -address 203.0.113.0 -netmask 255.255.255.255 -``` - -#### Step 4: riavvia l'interfaccia - -Applica le modifiche utilizzando il seguente comando: - -```bash -sudo systemctl restart networking -``` - -### Debian 12, Ubuntu 20.04 e versioni successive - -Il file di configurazione degli indirizzi Additional IP si trova nel file `/etc/netplan/`. In questo esempio, si chiama `50-cloud-init.yaml`. - -È consigliabile creare un file di configurazione separato per definire gli indirizzi Additional IP. In questo modo è possibile annullare le modifiche in caso di errore. - -#### Step 1: Crea il file di configurazione di rete - -Nel nostro esempio, il nostro file si chiama `51-cloud-init.yaml`: - -```bash -sudo touch /etc/netplan/51-cloud-init.yaml -``` - -#### Step 2: modifica il file di configurazione - -Per verificare il nome della tua interfaccia di rete, esegui questo comando: - -```bash -ip a -``` - -Apri il file di configurazione di rete per modificarlo con questo comando: - -```bash -sudo nano /etc/netplan/51-cloud-init.yaml -``` - -Non modificare le linee esistenti nel file di configurazione. Aggiungi il tuo indirizzo Additional IP aggiungendo un secondo blocco di configurazione per l'interfaccia pubblica, come nell'esempio seguente: - -```yaml -network: - version: 2 - ethernets: - INTERFACE_NAME: - dhcp4: true - addresses: - - ADDITIONAL_IP/32 -``` - -Se è necessario configurare più di un indirizzo Additional IP, il file di configurazione dovrebbe essere simile al seguente: - -```yaml -network: - version: 2 - ethernets: - INTERFACE_NAME: - dhcp4: true - addresses: - - ADDITIONAL_IP1/32 - - ADDITIONAL_IP2/32 -``` - -> [!warning] -> -> È importante rispettare l'allineamento di ciascun elemento del file, come indicato nell'esempio di cui sopra. Non utilizzare il tasto di tabulazione per creare la tua spaziatura. +> [!success] +> Selezionare la scheda corrispondente al proprio sistema operativo. > -**Esempio** - -```yaml -network: - version: 2 - ethernets: - eth0: - dhcp4: true - addresses: - - 203.0.113.0/32 -``` - -Salva e chiudi il file. - -#### Step 3: applicare la nuova configurazione di rete - -Per testare la tua configurazione utilizza questo comando: - -```bash -sudo netplan try -``` - -Se è corretta, applicala utilizzando il seguente comando: - -```bash -sudo netplan apply -``` - -Ripeti questa procedura per ogni indirizzo Additional IP. - -### AlmaLinux (8 & 9), Rocky Linux (8 & 9) - -Il file di configurazione principale si trova nella cartella `/etc/sysconfig/network-scripts/`. In questo esempio, si chiama `ifcfg-eth0`. Prima di apportare modifiche, verificare il nome effettivo del file nella cartella. - -Per ogni indirizzo Additional IP da configurare, crea un file di configurazione separato con le seguenti impostazioni: `ifcfg-NETWORK_INTERFACE:ID`. Dove `NETWORK_INTERFACE` rappresenta l’interfaccia fisica e `ID` rappresenta l’interfaccia di rete virtuale o l’alias ethernet che inizia con un valore di 0. Ad esempio, per la nostra interfaccia chiamata `eth0` il primo alias è `eth0:0`, il secondo alias è `eth0:1`, ecc. - -#### Step 1: determina l’interfaccia - -Verifica il nome dell’interfaccia di rete con questo comando: - -```bash -ip a -``` - -#### Step 2: crea il file di configurazione - -Creare innanzitutto il file di configurazione. Sostituisci `NETWORK_INTERFACE:ID` con i tuoi valori. - -```bash -sudo nano /etc/sysconfig/network-scripts/ifcfg-NETWORK_INTERFACE:ID -``` - - -Successivamente, modifica il file con il contenuto seguente, sostituendo `NETWORK_INTERFACE:ID` e `ADDITIONAL_IP` con i tuoi valori: - -```console -DEVICE=NETWORK_INTERFACE:ID -BOOTPROTO=static -IPADDR=ADDITIONAL_IP -NETMASK=255.255.255.255 -BROADCAST=ADDITIONAL_IP -ONBOOT=yes -``` - -**Esempio** - -```console -DEVICE=NETWORK_INTERFACE:ID -BOOTPROTO=static -IPADDR=203.0.113.0 -NETMASK=255.255.255.255 -BROADCAST=203.0.113.0 -ONBOOT=yes -``` - -#### Step 3: riavvia l’interfaccia - -```bash -sudo systemctl restart network -``` - -#### Per AlmaLinux e Rocky Linux - -```bash -sudo systemctl restart Network Manager -``` - -### Fedora 37 e versioni successive - -Fedora ora utilizza i file chiave. In precedenza NetworkManager memorizzava i profili di rete in formato ifcfg in questa directory: `/etc/sysconfig/network-scripts/`. Tuttavia, il formato ifcfg è ora obsoleto. Per impostazione predefinita, NetworkManager non crea più nuovi profili in questo formato. Il file di configurazione è ora disponibile in `/etc/NetworkManager/system-connections/`. - -#### Step 1: crea un backup - -Nel nostro esempio, il nostro file si chiama `cloud-init-eno1.nmconnection`, quindi facciamo una copia del file `cloud-init-eno1.nmconnection` utilizzando il seguente comando: - -```bash -sudo cp -r /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak -``` - -In caso di errore, è possibile annullare le modifiche utilizzando i comandi seguenti: - -```bash -sudo rm -f /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -sudo cp /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -``` - -#### Step 2: modifica il file di configurazione - -> [!primary] -> Ti ricordiamo che il nome del file di rete nel nostro esempio potrebbe essere diverso dal tuo. Adatta i comandi al tuo nome di file. -> - -```bash -sudo nano /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -``` - -Non modificare le righe esistenti nel file di configurazione, aggiungi l’Additional IP al file come segue, sostituendo `ADDITIONAL_IP/32` con i tuoi valori: - -```console -[ipv4] -method=auto -may-fail=false -address1=ADDITIONAL_IP/32 -``` - -Per configurare due indirizzi Additional IP, la configurazione dovrebbe essere simile alla seguente: - -```console -[ipv4] -method=auto -may-fail=false -address1=ADDITIONAL_IP1/32 -address2=ADDITIONAL_IP2/32 -``` - -**Esempio** - -```console -[ipv4] -method=auto -may-fail=false -address1=203.0.113.0/32 -``` - -#### Step 3: riavvia l’interfaccia - -Riavvia l’interfaccia: - -```bash -sudo systemctl restart Network Manager -``` - -### cPanel - -#### Step 1: accedi alla sezione di gestione degli IP del WHM - -Dallo Spazio Cliente WHM, clicca su `IP Functions`{.action} e seleziona `Add a New IP Address`{.action} nel menu a sinistra. - -![Add new IP](images/cpanel-alma-1.png){.thumbnail} - -#### Step 2: aggiungi le informazioni degli Additional IP - -Inserisci il tuo indirizzo Additional IP nel campo "New IP or IP range to add" nel formato "xxx.xxx.xxx.xxx". - -Seleziona `255.255.255.255` come subnet mask e clicca su `Submit`{.action}. - -![enter new IP information](images/cpanel-alma-2.png){.thumbnail} - -> [!warning] -> -> Attenzione: se hai diversi IP da configurare sullo stesso blocco e li aggiungi tutti contemporaneamente, il sistema WHM ti obbligherà a utilizzare la subnet mask `255.255.255.0`. Non è consigliabile utilizzare questa configurazione, è necessario aggiungere ogni IP singolarmente per poter utilizzare la subnet mask appropriata `255.255.255.255`. -> - -#### Step 3: verifica la configurazione IP corrente - -Nella sezione `IP Functions`{.action}, clicca su `Show or Delete Current IP Addresses`{.action} per verificare che l’indirizzo Additional IP sia stato aggiunto correttamente. - -![check configured IP](images/cpanel-alma-3.png){.thumbnail} - -### Plesk - -#### Step 1: accedere alla gestione IP di Plesk - -Nel pannello di configurazione Plesk, seleziona `Tools & Settings`{.action} nella barra laterale sinistra. - -![accesso alla gestione degli indirizzi IP](images/pleskip1.png){.thumbnail} - -Clicca su `IP Addresses`{.action} con **Tools & Settings**. - -#### Step 2: aggiungi le informazioni IP supplementari - -In questa sezione, clicca sul pulsante `Add IP Address`{.action}. - -![aggiungi informazioni IP](images/Plesk-2024-vps.png){.thumbnail} - -Inserisci il tuo indirizzo Additional IP nella forma `xxx.xxx.xxx.xxx/32` nel campo "IP address and subnet mask" e clicca su `OK`{.action}. - -![aggiungi informazioni IP](images/Plesk-additional-ip.png){.thumbnail} - -#### Step 3: verifica la configurazione IP corrente - -Per verificare che l'indirizzo Additional IP sia stato aggiunto correttamente, accedi alla sezione "IP Addresses". - -![configurazione IP attuale](images/plesk-final-configuration.png){.thumbnail} - -### Windows Server 2016 - -#### Step 1: verifica la configurazione di rete - -Clicca con il tasto destro sul pulsante `Start Menu`{.action} e apri `Run`{.action}. - -Clicca su `cmd` e clicca su `OK`{.action} per aprire l'applicazione della riga di comando. - -![compromesso](images/vps_win07.png){.thumbnail} - -Per recuperare la configurazione IP corrente, inserisci `ipconfig` nel prompt dei comandi. - -```console -C:\Users\Administrator>ipconfig -Windows IP Configuration -Ethernet adapter Ethernet: - Connection-specific DNS Suffix . : openstacklocal - Link-local IPv6 Address . . . . . : fe90::30gf:258a:84d6:abcf%5 - IPv4 Address. . . . . . . . . . . : 192.0.2.29 - Subnet Mask . . . . . . . . . . . : 255.255.255.255 - Default Gateway . . . . . . . . . : 192.0.2.1 -``` - -#### Step 2: modifica le proprietà IPv4 - -1. Accedi al menu `Start`{.action}, poi `Control Panel`{.action}, `Network and Internet`{.action}, `Network and Sharing Centre`{.action} e `Change Adapter Settings`{.action} nella barra di sinistra; -2. clicca con il tasto destro su `Ethernet`{.action}; -3. clicca su `Properties`{.action}; -4. Seleziona `Internet Protocol Version 4 (TCP/IPv4)`{.action} e clicca su `Properties`{.action}; -5. Clicca su `Use the following IP address`{.action} e inserisci l'IP principale del tuo server, la subnet mask e il gateway predefinito ottenuto con il comando `ipconfig`{.action} qui sopra. Nella casella "Preferred DNS Server" digitare "213.186.33.99". - -![change the ip configuration](images/configure-main-ip.png){.thumbnail} - -> [!warning] -> -> Attenzione: se le informazioni inserite non sono corrette, il server non sarà più raggiungibile. Sarà necessario effettuare le correzioni tramite il KVM. -> - -#### Step 3: aggiungi l'indirizzo Additional IP nelle Impostazioni TCP/IP avanzate - -Nella nuova finestra, clicca su `Add...`{.action} sotto "IP addresses". Inserisci il tuo indirizzo Additional IP e la subnet mask (255.255.255.255). - -![sezione di configurazione avanzata](images/configure-additional-ip.png){.thumbnail} - -Per confermare, clicca su `Add`{.action}. - -![Additional IP configuration](images/additional-ip-config.png){.thumbnail} - -Fare quindi clic su `OK`{.action} per applicare la configurazione. - -![Configurazione del trasferimento IP](images/final-configuration.png){.thumbnail} - -Si perderà la connessione al server per alcuni secondi. - -#### Step 4: verifica la nuova configurazione di rete - -Apri il prompt dei comandi (cmd) e inserisci `ipconfig`. La configurazione deve includere il nuovo indirizzo Additional IP. - -```console -C:\Users\Administrator>ipconfig -Windows IP Configuration -Ethernet adapter Ethernet: - Connection-specific DNS Suffix . : - Link-local IPv6 Address . . . . . : fe90::30gf:258a:84d6:abcf%5 - IPv4 Address. . . . . . . . . . . : 192.0.2.29 - Subnet Mask . . . . . . . . . . . : 255.255.255.255 - IPv4 Address. . . . . . . . . . . : 203.0.113.0 - Subnet Mask . . . . . . . . . . . : 255.255.255.255 - Default Gateway . . . . . . . . . : 192.0.2.1 -``` +> [!tabs] +> Debian 11 +>> **Debian 11** +>> +>> **Step 1: disattiva la configurazione automatica della rete** +>> +>> Apri il percorso per accedere al file seguente con un editor di testo: +>> +>> ```bash +>> sudo nano /etc/cloud/cloud.cfg.d/99-disable-network-config.cfg +>> ``` +>> +>> Inserisci la riga seguente, poi registra e lascia l'editor. +>> +>> ```console +>> network: {config: disabled} +>> ``` +>> +>> La creazione di questo file di configurazione impedisce l'esecuzione automatica delle modifiche apportate alla configurazione della tua rete. +>> +>> **Step 2: crea un backup** +>> +>> Per impostazione predefinita, il file di configurazione si trova nel percorso `etc/network/interfaces.d`. +>> +>> Nel nostro esempio, il nostro file si chiama `50-cloud-init`, quindi facciamo una copia del file `50-cloud-init` utilizzando il seguente comando: +>> +>> ```bash +>> sudo cp /etc/network/interfaces.d/50-cloud-init /etc/network/interfaces.d/50-cloud-init.bak +>> ``` +>> +>> In caso di errore, è possibile annullare le modifiche utilizzando i comandi seguenti: +>> +>> ```bash +>> sudo rm -f /etc/network/interfaces.d/50-cloud-init +>> sudo cp /etc/network/interfaces.d/50-cloud-init.bak /etc/network/interfaces.d/50-cloud-init +>> ``` +>> +>> **Step 3: modifica il file di configurazione** +>> +>> Verifica il nome dell’interfaccia di rete con questo comando: +>> +>> ```bash +>> ip a +>> ``` +>> +>> Aprire il file di configurazione di rete per modificarlo con il comando seguente: +>> +>> ```bash +>> sudo nano /etc/network/interfaces.d/50-cloud-init +>> ``` +>> +>> Per configurare l'indirizzo Additional IP, aggiungere un'interfaccia virtuale o un alias Ethernet all'interfaccia di rete. Nel nostro esempio, la nostra interfaccia si chiama `eth0`, quindi il nostro primo alias è `eth0:0`. Per ogni indirizzo Additional IP che vuoi configurare. +>> +>> Non modificare le righe esistenti nel file di configurazione, aggiungi il tuo indirizzo Additional IP al file come segue, sostituendo `NETWORK_INTERFACE`, `ID` e `ADDITIONAL_IP` con i tuoi valori: +>> +>> ```console +>> auto NETWORK_INTERFACE:ID +>> iface NETWORK_INTERFACE:ID inet static +>> address ADDITIONAL_IP +>> netmask 255.255.255.255 +>> ``` +>> +>> Se si configura più di un indirizzo Additional IP, il file di configurazione dovrebbe essere simile al seguente: +>> +>> ```console +>> auto NETWORK_INTERFACE:ID +>> iface NETWORK_INTERFACE:ID inet static +>> address ADDITIONAL_IP1 +>> address ADDITIONAL_IP2 +>> netmask 255.255.255.255 +>> ``` +>> +>> /// details | **Esempio** +>> +>> ```console +>> auto eth0:0 +>> iface eth0:0 inet static +>> address 203.0.113.0 +>> netmask 255.255.255.255 +>> ``` +>> /// +>> +>> **Step 4: riavvia l'interfaccia** +>> +>> Applica le modifiche utilizzando il seguente comando: +>> +>> ```bash +>> sudo systemctl restart networking +>> ``` +>> +> Debian 12, Ubuntu 20.04 +>> **Debian 12, Ubuntu 20.04 e versioni successive** +>> +>> Il file di configurazione degli indirizzi Additional IP si trova nel file `/etc/netplan/`. In questo esempio, si chiama `50-cloud-init.yaml`. +>> +>> È consigliabile creare un file di configurazione separato per definire gli indirizzi Additional IP. In questo modo è possibile annullare le modifiche in caso di errore. +>> +>> Step 1: Crea il file di configurazione di rete +>> +>> Nel nostro esempio, il nostro file si chiama `51-cloud-init.yaml`: +>> +>> ```bash +>> sudo touch /etc/netplan/51-cloud-init.yaml +>> ``` +>> +>> Step 2: modifica il file di configurazione +>> +>> Per verificare il nome della tua interfaccia di rete, esegui questo comando: +>> +>> ```bash +>> ip a +>> ``` +>> +>> Apri il file di configurazione di rete per modificarlo con questo comando: +>> +>> ```bash +>> sudo nano /etc/netplan/51-cloud-init.yaml +>> ``` +>> +>> Non modificare le linee esistenti nel file di configurazione. Aggiungi il tuo indirizzo Additional IP aggiungendo un secondo blocco di configurazione per l'interfaccia pubblica, come nell'esempio seguente: +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> INTERFACE_NAME: +>> dhcp4: true +>> addresses: +>> - ADDITIONAL_IP1/32 +>> ``` +>> +>> Se è necessario configurare più di un indirizzo Additional IP, il file di configurazione dovrebbe essere simile al seguente: +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> INTERFACE_NAME: +>> dhcp4: true +>> addresses: +>> - ADDITIONAL_IP1/32 +>> - ADDITIONAL_IP2/32 +>> ``` +>> +>> > [!warning] +>> > +>> > È importante rispettare l'allineamento di ciascun elemento del file, come indicato nell'esempio di cui sopra. Non utilizzare il tasto di tabulazione per creare la tua spaziatura. +>> > +>> +>> /// details | **Esempio** +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> eth0: +>> dhcp4: true +>> addresses: +>> - 203.0.113.0/32 +>> ``` +>> /// +>> +>> Salva e chiudi il file. +>> +>> **Step 3: applicare la nuova configurazione di rete** +>> +>> Per testare la tua configurazione utilizza questo comando: +>> +>> ```bash +>> sudo netplan try +>> ``` +>> +>> Se è corretta, applicala utilizzando il seguente comando: +>> +>> ```bash +>> sudo netplan apply +>> ``` +>> +>> Ripeti questa procedura per ogni indirizzo Additional IP. +>> +> AlmaLinux / Rocky Linux +>> **AlmaLinux (8/9), Rocky Linux (8/9)** +>> +>> Il file di configurazione principale si trova nella cartella `/etc/sysconfig/network-scripts/`. In questo esempio, si chiama `ifcfg-eth0`. Prima di apportare modifiche, verificare il nome effettivo del file nella cartella. +>> +>> Per ogni indirizzo Additional IP da configurare, crea un file di configurazione separato con le seguenti impostazioni: `ifcfg-NETWORK_INTERFACE:ID`. Dove `NETWORK_INTERFACE` rappresenta l’interfaccia fisica e `ID` rappresenta l’interfaccia di rete virtuale o l’alias ethernet che inizia con un valore di 0. Ad esempio, per la nostra interfaccia chiamata `eth0` il primo alias è `eth0:0`, il secondo alias è `eth0:1`, ecc. +>> +>> **Step 1: determina l’interfaccia** +>> +>> Verifica il nome dell’interfaccia di rete con questo comando: +>> +>> ```bash +>> ip a +>> ``` +>> +>> **Step 2: crea il file di configurazione** +>> +>> Creare innanzitutto il file di configurazione. Sostituisci `NETWORK_INTERFACE:ID` con i tuoi valori. +>> +>> ```bash +>> sudo nano /etc/sysconfig/network-scripts/ifcfg-NETWORK_INTERFACE:ID +>> ``` +>> +>> Successivamente, modifica il file con il contenuto seguente, sostituendo `NETWORK_INTERFACE:ID` e `ADDITIONAL_IP` con i tuoi valori: +>> +>> ```console +>> DEVICE=NETWORK_INTERFACE:ID +>> ONBOOT=yes +>> BOOTPROTO=none # For CentOS use "static" +>> IPADDR=ADDITIONAL_IP +>> NETMASK=255.255.255.255 +>> BROADCAST=ADDITIONAL_IP +>> ``` +>> +>> /// details | **Esempio** +>> +>> ```console +>> DEVICE=eth0:0 +>> ONBOOT=yes +>> BOOTPROTO=none # For CentOS use "static" +>> IPADDR=203.0.113.0 +>> NETMASK=255.255.255.255 +>> BROADCAST=203.0.113.0 +>> ``` +>> /// +>> +>> **Step 3: riavvia l’interfaccia** +>> +>> ```bash +>> sudo systemctl restart network +>> ``` +>> +>> Per AlmaLinux e Rocky Linux +>> +>> ```bash +>> sudo systemctl restart Network Manager +>> ``` +>> +> Fedora 42 +>> **Fedora 42** +>> +>> Fedora ora utilizza i file chiave. In precedenza NetworkManager memorizzava i profili di rete in formato ifcfg in questa directory: `/etc/sysconfig/network-scripts/`. Tuttavia, il formato ifcfg è ora obsoleto. Per impostazione predefinita, NetworkManager non crea più nuovi profili in questo formato. Il file di configurazione è ora disponibile in `/etc/NetworkManager/system-connections/`. +>> +>> **Step 1: crea un backup** +>> +>> Nel nostro esempio, il nostro file si chiama `cloud-init-eno1.nmconnection`, quindi facciamo una copia del file `cloud-init-eno1.nmconnection` utilizzando il seguente comando: +>> +>> ```bash +>> sudo cp -r /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak +>> ``` +>> +>> In caso di errore, è possibile annullare le modifiche utilizzando i comandi seguenti: +>> +>> ```bash +>> sudo rm -f /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> sudo cp /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> ``` +>> +>> **Step 2: modifica il file di configurazione** +>> +>> > [!primary] +>> > Ti ricordiamo che il nome del file di rete nel nostro esempio potrebbe essere diverso dal tuo. Adatta i comandi al tuo nome di file. +>> > +>> +>> ```bash +>> sudo nano /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> ``` +>> +>> Non modificare le righe esistenti nel file di configurazione, aggiungi l’Additional IP al file come segue, sostituendo `ADDITIONAL_IP/32` con i tuoi valori: +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=ADDITIONAL_IP/32 +>> ``` +>> +>> Per configurare due indirizzi Additional IP, la configurazione dovrebbe essere simile alla seguente: +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=ADDITIONAL_IP1/32 +>> address2=ADDITIONAL_IP2/32 +>> ``` +>> +>> /// details | **Esempio** +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=203.0.113.0/32 +>> ``` +>> /// +>> +>> **Step 3: riavvia l’interfaccia** +>> +>> Riavvia l’interfaccia: +>> +>> ```bash +>> sudo systemctl restart Network Manager +>> ``` +>> +> cPanel +>> **cPanel** +>> +>> **Step 1: accedi alla sezione di gestione degli IP del WHM** +>> +>> Dallo Spazio Cliente WHM, clicca su `IP Functions`{.action} e seleziona `Add a New IP Address`{.action} nel menu a sinistra. +>> +>> ![Add new IP](images/cpanel-alma-1.png){.thumbnail} +>> +>> Step 2: aggiungi le informazioni degli Additional IP +>> +>> Inserisci il tuo indirizzo Additional IP nel campo "New IP or IP range to add" nel formato "xxx.xxx.xxx.xxx". +>> +>> Seleziona `255.255.255.255` come subnet mask e clicca su `Submit`{.action}. +>> +>> ![enter new IP information](images/cpanel-alma-2.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Attenzione: se hai diversi IP da configurare sullo stesso blocco e li aggiungi tutti contemporaneamente, il sistema WHM ti obbligherà a utilizzare la subnet mask `255.255.255.0`. Non è consigliabile utilizzare questa configurazione, è necessario aggiungere ogni IP singolarmente per poter utilizzare la subnet mask appropriata `255.255.255.255`. +>> > +>> +>> **Step 3: verifica la configurazione IP corrente** +>> +>> Nella sezione `IP Functions`{.action}, clicca su `Show or Delete Current IP Addresses`{.action} per verificare che l’indirizzo Additional IP sia stato aggiunto correttamente. +>> +>> ![check configured IP](images/cpanel-alma-3.png){.thumbnail} +>> +> Plesk +>> **Plesk** +>> +>> **Step 1: accedere alla gestione IP di Plesk** +>> +>> Nel pannello di configurazione Plesk, seleziona `Tools & Settings`{.action} nella barra laterale sinistra. +>> +>> ![accesso alla gestione degli indirizzi IP](images/pleskip1.png){.thumbnail} +>> +>> Clicca su `IP Addresses`{.action} con **Tools & Settings**. +>> +>> **Step 2: aggiungi le informazioni IP supplementari** +>> +>> In questa sezione, clicca sul pulsante `Add IP Address`{.action}. +>> +>> ![aggiungi informazioni IP](images/Plesk-2024-vps.png){.thumbnail} +>> +>> Inserisci il tuo indirizzo Additional IP nella forma `xxx.xxx.xxx.xxx/32` nel campo "IP address and subnet mask" e clicca su `OK`{.action}. +>> +>> ![aggiungi informazioni IP](images/Plesk-additional-ip.png){.thumbnail} +>> +>> **Step 3: verifica la configurazione IP corrente** +>> +>> Per verificare che l'indirizzo Additional IP sia stato aggiunto correttamente, accedi alla sezione "IP Addresses". +>> +>> ![configurazione IP attuale](images/plesk-final-configuration.png){.thumbnail} +>> +> Windows Server +>> **Windows Server** +>> +>> **Step 1: verifica la configurazione di rete** +>> +>> Clicca con il tasto destro sul pulsante `Start Menu`{.action} e apri `Run`{.action}. +>> +>> Clicca su `cmd` e clicca su `OK`{.action} per aprire l'applicazione della riga di comando. +>> +>> ![compromesso](images/vps_win07.png){.thumbnail} +>> +>> Per recuperare la configurazione IP corrente, inserisci `ipconfig` nel prompt dei comandi. +>> +>> ```console +>> C:\Users\Administrator>ipconfig +>> +>> Windows IP Configuration +>> +>> Ethernet adapter Ethernet: +>> +>> Connection-specific DNS Suffix . : openstacklocal +>> Link-local IPv6 Address . . . . . : fe90::30gf:258a:84d6:abcf%5 +>> IPv4 Address. . . . . . . . . . . : 192.0.2.29 +>> Subnet Mask . . . . . . . . . . . : 255.255.255.255 +>> Default Gateway . . . . . . . . . : 192.0.2.1 +>> ``` +>> +>> **Step 2: modifica le proprietà IPv4** +>> +>> 1. Accedi al menu `Start`{.action}, poi `Control Panel`{.action}, `Network and Internet`{.action}, `Network and Sharing Centre`{.action} e `Change Adapter Settings`{.action} nella barra di sinistra; +>> 2. clicca con il tasto destro su `Ethernet`{.action}; +>> 3. clicca su `Properties`{.action}; +>> 4. Seleziona `Internet Protocol Version 4 (TCP/IPv4)`{.action} e clicca su `Properties`{.action}; +>> 5. Clicca su `Use the following IP address`{.action} e inserisci l'IP principale del tuo server, la subnet mask e il gateway predefinito ottenuto con il comando `ipconfig`{.action} qui sopra. Nella casella "Preferred DNS Server" digitare "213.186.33.99". +>> +>> ![change the ip configuration](images/configure-main-ip.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Attenzione: se le informazioni inserite non sono corrette, il server non sarà più raggiungibile. Sarà necessario effettuare le correzioni tramite il KVM. +>> > +>> +>> **Step 3: aggiungi l'indirizzo Additional IP nelle Impostazioni TCP/IP avanzate** +>> +>> Nella nuova finestra, clicca su `Add...`{.action} sotto "IP addresses". Inserisci il tuo indirizzo Additional IP e la subnet mask (255.255.255.255). +>> +>> ![sezione di configurazione avanzata](images/configure-additional-ip.png){.thumbnail} +>> +>> Per confermare, clicca su `Add`{.action}. +>> +>> ![Additional IP configuration](images/additional-ip-config.png){.thumbnail} +>> +>> Fare quindi clic su `OK`{.action} per applicare la configurazione. +>> +>> ![Configurazione del trasferimento IP](images/final-configuration.png){.thumbnail} +>> +>> Si perderà la connessione al server per alcuni secondi. +>> +>> **Step 4: verifica la nuova configurazione di rete** +>> +>> Apri il prompt dei comandi (cmd) e inserisci `ipconfig`. La configurazione deve includere il nuovo indirizzo Additional IP. +>> +>> ```console +>> C:\Users\Administrator>ipconfig +>> +>> Windows IP Configuration +>> +>> Ethernet adapter Ethernet: +>> +>> Connection-specific DNS Suffix . : +>> Link-local IPv6 Address . . . . . : fe90::30gf:258a:84d6:abcf%5 +>> IPv4 Address. . . . . . . . . . . : 192.0.2.29 +>> Subnet Mask . . . . . . . . . . . : 255.255.255.255 +>> IPv4 Address. . . . . . . . . . . : 203.0.113.0 +>> Subnet Mask . . . . . . . . . . . : 255.255.255.255 +>> Default Gateway . . . . . . . . . : 192.0.2.1 +>> ``` ### Diagnostica @@ -484,4 +521,4 @@ Per testare la connessione, ti basta inviare un ping al tuo indirizzo Additional Per usufruire di un supporto per l'utilizzo e la configurazione delle soluzioni OVHcloud, è possibile consultare le nostre soluzioni [offerte di supporto](/links/support). -Contatta la nostra Community di utenti all'indirizzo . \ No newline at end of file +Contatta la nostra [Community di utenti](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/guide.pl-pl.md b/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/guide.pl-pl.md index 5b46ce8741b..a470db269f1 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/guide.pl-pl.md +++ b/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/guide.pl-pl.md @@ -1,9 +1,23 @@ --- title: 'Skonfiguruj adres IP jako alias' excerpt: 'Dowiedz się, jak dodać adresy Additional IP do konfiguracji VPS' -updated: 2025-09-11 +updated: 2025-11-12 --- + + ## Wprowadzenie Alias IP (*IP aliasing* w języku angielskim) to specjalna konfiguracja sieci dla serwerów OVHcloud, która pozwala na przypisanie kilku adresów IP do jednego interfejsu sieciowego. @@ -45,428 +59,451 @@ Jeśli chodzi o różne wersje dystrybucji, należy pamiętać, że można zmody |NETWORK_INTERFACE|Nazwa interfejsu sieciowego|*eth0*, *ens3*| |ID|ID aliasu IP, zaczynające się od *0* (w zależności od liczby dodatkowych adresów IP do skonfigurowania)|*0*, *1*| -### Debian 11 - -#### Etap 1: wyłącz automatyczną konfigurację sieci - -Otwórz ścieżkę dostępu do następującego pliku z edytorem tekstu: - -```bash -sudo nano /etc/cloud/cloud.cfg.d/99-disable-network-config.cfg -``` - -Wprowadź następującą linię, następnie zapisz i wyjdź z edytora. - -```console -network: {config: disabled} -``` - -Utworzenie tego pliku konfiguracyjnego zapobiega automatycznemu wprowadzaniu zmian w konfiguracji Twojej sieci. - -#### Etap 2: zmień plik konfiguracyjny sieci - -Domyślnie plik konfiguracyjny znajduje się w ścieżce `etc/network/interfaces.d`. - -W naszym przykładzie nasz plik nosi nazwę `50-cloud-init`, dlatego wykonujemy kopię pliku `50-cloud-init`, używając następującego polecenia: - -```bash -sudo cp /etc/network/interfaces.d/50-cloud-init /etc/network/interfaces.d/50-cloud-init.bak -``` - -W przypadku błędu będziesz mógł wrócić do wprowadzonych zmian, używając następujących poleceń: - -```bash -sudo rm -f /etc/network/interfaces.d/50-cloud-init -sudo cp /etc/network/interfaces.d/50-cloud-init.bak /etc/network/interfaces.d/50-cloud-init -``` - -#### Etap 3: zmień plik konfiguracyjny sieci - -Nazwy interfejsu sieciowego możesz sprawdzić za pomocą polecenia: - -```bash -ip a -``` - -Otwórz plik konfiguracyjny sieci, aby go zmienić za pomocą następującego polecenia: - -```bash -sudo nano /etc/network/interfaces.d/50-cloud-init -``` - -Aby skonfigurować adres Additional IP, dodaj interfejs wirtualny lub alias Ethernet do interfejsu sieciowego. W naszym przykładzie nasz interfejs nosi nazwę `eth0`, więc nasz pierwszy alias to `eth0:0`. Zrób to dla każdego adresu Additional IP, który chcesz skonfigurować. - -Nie zmieniaj istniejących wierszy w pliku konfiguracyjnym, dodaj tylko adres Additional IP do następującego pliku, zastępując `NETWORK_INTERFACE`, `ID` i `ADDITIONAL_IP` własnymi wartościami: - -```console -auto NETWORK_INTERFACE:ID -iface NETWORK_INTERFACE:ID inet static -address ADDITIONAL_IP -netmask 255.255.255.255 -``` - -Jeśli konfigurujesz więcej niż jeden adres Additional IP, plik konfiguracyjny powinien wyglądać następująco: - -```console -auto NETWORK_INTERFACE:ID -iface NETWORK_INTERFACE:ID inet static -address ADDITIONAL_IP1 -address ADDITIONAL_IP2 -netmask 255.255.255.255 -``` - -**Przykład** - -```console -auto NETWORK_INTERFACE:ID -iface NETWORK_INTERFACE:ID inet static -address 203.0.113.0 -netmask 255.255.255.255 -``` - -#### Etap 4: restart interfejsu - -Zastosuj zmiany za pomocą polecenia: - -```bash -sudo systemctl restart networking -``` - -### Debian 12, Ubuntu 20.04 i późniejsze wersje - -Plik konfiguracyjny adresów Additional IP znajduje się w pliku`/etc/netplan/`. W tym przykładzie nazywa się `50-cloud-init.yaml`. - -Najlepszą praktyką jest utworzenie oddzielnego pliku konfiguracyjnego w celu zdefiniowania adresów Additional IP. W przypadku błędu można łatwo przywrócić modyfikacje. - -#### Etap 1: utworzenie pliku konfiguracji sieci - -W naszym przykładzie nasz plik nosi nazwę `51-cloud-init.yaml`: - -```bash -sudo touch /etc/netplan/51-cloud-init.yaml -``` - -#### Etap 2: modyfikować plik konfiguracji - -Nazwy interfejsu sieciowego możesz sprawdzić za pomocą polecenia: - -```bash -ip a -``` - -Otwórz plik konfiguracyjny sieci, aby go zmienić za pomocą następującego polecenia: - -```bash -sudo nano /etc/netplan/51-cloud-init.yaml -``` - -Edytuj plik, zastępując polecenia `INTERFACE_NAME` i `ADDITIONAL_IP` własnymi wartościami: - -```yaml -network: - version: 2 - ethernets: - INTERFACE_NAME: - dhcp4: true - addresses: - - ADDITIONAL_IP/32 -``` - -Jeśli masz więcej niż jeden adres Additional IP do skonfigurowania, plik konfiguracyjny powinien wyglądać następująco: - -```yaml -network: - version: 2 - ethernets: - INTERFACE_NAME: - dhcp4: true - addresses: - - ADDITIONAL_IP1/32 - - ADDITIONAL_IP2/32 -``` - -> [!warning] -> -> Ważne jest przestrzeganie wyrównania każdego elementu tego pliku, jak pokazano w powyższym przykładzie. Nie używaj przycisku tabulacji do tworzenia odstępów. -> - -**Przykład** - -```yaml -network: - version: 2 - ethernets: - eth0: - dhcp4: true - addresses: - - 203.0.113.0/32 -``` - -Zapisz i zamknij plik. - -#### Etap 3: zastosować nową konfigurację sieci - -Możesz przetestować konfigurację za pomocą polecenia: - -```bash -sudo netplan try -``` - -Jeśli jest poprawna, zastosuj ją za pomocą następującego polecenia: - -```bash -sudo netplan apply -``` - -Powtórz tę procedurę dla każdego adresu Additional IP. - -### AlmaLinux (8 & 9), Rocky Linux (8 & 9) - -Główny plik konfiguracyjny znajduje się w folderze `/etc/sysconfig/network-scripts/`. W tym przykładzie nazywa się `ifcfg-eth0`. Przed wprowadzeniem zmian sprawdź rzeczywistą nazwę pliku w tym folderze. - -Dla każdego adresu Additional IP, który chcesz skonfigurować, utwórz osobny plik konfiguracyjny z następującymi parametrami: `ifcfg-NETWORK_INTERFACE:ID`. Gdzie `NETWORK_INTERFACE` reprezentuje interfejs fizyczny, a `ID` reprezentuje wirtualny interfejs sieciowy lub alias ethernetowy rozpoczynający się od wartości 0. Na przykład w przypadku interfejsu o nazwie `eth0` pierwszy alias to `eth0:0`, drugi alias to `eth0:1`, etc. - - -#### Etap 1: zmień plik konfiguracyjny sieci - -Nazwy interfejsu sieciowego możesz sprawdzić za pomocą polecenia: - -```bash -ip a -``` - -#### Etap 2: tworzenie pliku konfiguracyjnego - -Najpierw utwórz plik konfiguracyjny. Zastąp `NETWORK_INTERFACE:ID` własnymi wartościami. - -```bash -sudo nano /etc/sysconfig/network-scripts/ifcfg-NETWORK_INTERFACE:ID -``` - -Następnie edytuj plik z poniższą zawartością, zastępując `NETWORK_INTERFACE:ID` i `ADDITIONAL_IP` własnymi wartościami: - -```console -DEVICE=NETWORK_INTERFACE:ID -ONBOOT=yes -BOOTPROTO=static -IPADDR=ADDITIONAL_IP -NETMASK=255.255.255.255 -BROADCAST=ADDITIONAL_IP -``` - -**Przykład** - -```console -DEVICE=eth0:0 -ONBOOT=yes -BOOTPROTO=static -IPADDR=203.0.113.0 -NETMASK=255.255.255.255 -BROADCAST=203.0.113.0 -``` - -#### Etap 3: restart interfejsu - -Zastosuj zmiany za pomocą polecenia: - -```bash -sudo systemctl restart network -``` - -#### Dla AlmaLinux i Rocky Linux - -```bash -sudo systemctl restart Network Manager -``` - -### Fedora 37 i późniejsze wersje - -Fedora używa teraz kluczowych plików. NetworkManager przechowywał wcześniej profile sieciowe w formacie ifcfg w tym katalogu: `/etc/sysconfig/network-scripts/`. Jednak format ifcfg jest teraz przestarzały. Domyślnie program NetworkManager nie tworzy już nowych profilów w tym formacie. Plik konfiguracyjny znajduje się teraz w `/etc/NetworkManager/system-connections/`. - -#### Etap 1: tworzenie kopii zapasowej - -W naszym przykładzie nasz plik nosi nazwę `cloud-init-eno1.nmconnection`, wykonujemy zatem kopię pliku `cloud-init-eno1.nmconnection` przy użyciu następującego polecenia: - -```bash -sudo cp -r /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak -``` - -W przypadku błędu będziesz mógł wrócić do wprowadzonych zmian, używając następujących poleceń: - -```bash -sudo rm -f /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -sudo cp /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -``` - -#### Etap 2: modyfikacja pliku konfiguracyjnego +W poniższych przykładach będziemy używać edytora tekstu `nano`. W niektórych systemach operacyjnych konieczne będzie zainstalowanie go przed rozpoczęciem pracy. W takim przypadku pojawi się odpowiedni komunikat. Można oczywiście użyć dowolnego edytora tekstu. -> [!primary] -> Pamiętaj, że nazwa pliku sieciowego w naszym przykładzie może się różnić od Twojej. Dostosuj polecenia do nazwy pliku. +> [!success] +> Wybierz zakładkę odpowiadającą Twojemu systemowi operacyjnemu. > -```bash -sudo nano /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -``` - -Nie zmieniaj istniejących linii w pliku konfiguracyjnym, dodaj adres Additional IP do pliku w następujący sposób, zastępując `ADDITIONAL_IP/32` własnymi wartościami: - -```console -[ipv4] -method=auto -may-fail=false -address1=ADDITIONAL_IP/32 -``` - -Jeśli masz dwa adresy Additional IP do skonfigurowania, konfiguracja powinna wyglądać następująco: - -```console -[ipv4] -method=auto -may-fail=false -address1=ADDITIONAL_IP1/32 -address2=ADDITIONAL_IP2/32 -``` - -**Przykład** - -```console -[ipv4] -method=auto -may-fail=false -address1=203.0.113.0/32 -``` - -#### Etap 3: restart interfejsu - -Uruchom ponownie interfejs: - -```bash -systemctl restart Network Manager -``` - -### cPanel - -#### Etap 1: dostęp do sekcji zarządzania adresami IP w usłudze WHM - -W Panelu klienta WHM kliknij `IP Functions`{.action} i wybierz `Add a New IP Address`{.action} w menu po lewej stronie. - -![Add new IP](images/cpanel-alma-1.png){.thumbnail} - -#### Etap 2: dodawanie informacji o adresach Additional IP - -W polu "New IP or IP range to add" wpisz Twój adres Additional IP w postaci "xxx.xxx.xxx.xxx". - -Wybierz `255.255.255.255` jako maskę podsieci, a następnie kliknij `Submit`{.action}. - -![enter new IP information](images/cpanel-alma-2.png){.thumbnail} - -> [!warning] -> -> Uwaga, jeśli masz kilka adresów IP do skonfigurowania na tym samym bloku i dodajesz je wszystkie jednocześnie, system WHM wymusi użycie maski podsieci `255.255.255.0`. Nie zaleca się używania tej konfiguracji, należy dodać każdy adres IP oddzielnie, aby móc korzystać z odpowiedniej maski podsieci `255.255.255.255`. -> - -#### Etap 3: weryfikacja aktualnej konfiguracji IP - -Wróć do sekcji `IP Functions`{.action}, kliknij `Show or Delete Current IP Addresses`{.action}, aby sprawdzić, czy adres Additional IP został poprawnie dodany. - -![check configured IP](images/cpanel-alma-3.png){.thumbnail} - -### Plesk - -#### Etap 1: dostęp do interfejsu zarządzania IP Plesk - -W panelu sterowania Plesk wybierz `Tools & Settings`{.action} na pasku bocznym po lewej stronie. - -![acces to the ip addresses management](images/pleskip1.png){.thumbnail} - -Kliknij przycisk `IP Addresses`{.action} w obszarze **Tools & Settings**. - -#### Etap 2: dodawanie informacji o adresach Additional IP - -W tej sekcji kliknij przycisk `Add IP Address`{.action}. - -![add ip information](images/Plesk-2024-vps.png){.thumbnail} - -W polu "IP address and subnet mask" wpisz adres Additional IP w postaci `xxx.xxx.xxx.xxx/32`, a następnie kliknij przycisk `OK`{.action}. - -![add ip information](images/Plesk-additional-ip.png){.thumbnail} - -#### Etap 3: weryfikacja aktualnej konfiguracji IP - -W sekcji "IP Addresses" sprawdź, czy adres Additional IP został poprawnie dodany. - -![current IP configuration](images/plesk-final-configuration.png){.thumbnail} - -### Windows Server - -#### Etap 1: sprawdź konfigurację sieci - -Kliknij prawym przyciskiem myszy przycisk `Start Menu`{.action} i otwórz `Run`{.action}. - -Wpisz `cmd` i kliknij `OK`{.action}, aby otworzyć aplikację wiersza poleceń. - -![cmdprompt](images/vps_win07.png){.thumbnail} - -Aby pobrać aktualną konfigurację IP, wprowadź `ipconfig` w wierszu poleceń. - -```console -C:\Users\Administrator>ipconfig -Windows IP Configuration -Ethernet adapter Ethernet: - Connection-specific DNS Suffix . : openstacklocal - Link-local IPv6 Address . . . . . : fe90::30gf:258a:84d6:abcf%5 - IPv4 Address. . . . . . . . . . . : 192.0.2.29 - Subnet Mask . . . . . . . . . . . : 255.255.255.255 - Default Gateway . . . . . . . . . : 192.0.2.1 -``` - -#### Etap 2: zmień właściwości IPv4 - -1. Przejdź do menu `Start`{.action}, następnie `Control Panel`{.action}, `Network and Internet`{.action}, `Network and Sharing Centre`{.action} oraz `Change Adapter Settings`{.action} na pasku po lewej stronie. -2. Kliknij prawym przyciskiem myszy `Ethernet`{.action}; -3. Kliknij `Properties`{.action}; -4. Wybierz `Internet Protocol Version 4 (TCP/IPv4)`{.action}, następnie kliknij `Properties`{.action}; -5. Kliknij przycisk `Use the following IP address`{.action} i wpisz główny adres IP Twojego serwera, maskę podsieci oraz bramę domyślną, które uzyskasz za pomocą polecenia `ipconfig`{.action} powyżej. W polu "Preferred DNS Server" wpisz `213.186.33.99`. - -![change the ip configuration](images/configure-main-ip.png){.thumbnail} - -> [!warning] -> -> Uwaga: jeśli wprowadzisz niepoprawne informacje, serwer nie będzie dostępny. Będziesz więc musiał wprowadzić poprawki za pośrednictwem KVM. -> - -#### Etap 3: dodać adres Additional IP do zaawansowanych ustawień TCP/IP - -W nowym oknie kliknij `Add...`{.action} pod "IP addresses". Wpisz adres Additional IP i maskę podsieci (255.255.255.255). - -![Advance Configuration section](images/configure-additional-ip.png){.thumbnail} - -Potwierdź klikając `Add`{.action}. - -![Additional IP configuration](images/additional-ip-config.png){.thumbnail} - -Po zakończeniu kliknij `OK`{.action}, aby zastosować konfigurację. - -![Additional IP configuration](images/final-configuration.png){.thumbnail} - -Połączenie z serwerem zostanie utracone na kilka sekund. - -#### Etap 4: weryfikacja nowej konfiguracji sieci - -Otwórz wiersz poleceń (cmd) i wprowadź `ipconfig`. Konfiguracja musi teraz obejmować nowy adres Additional IP. - -```console -C:\Users\Administrator>ipconfig -Windows IP Configuration -Ethernet adapter Ethernet: - Connection-specific DNS Suffix . : - Link-local IPv6 Address . . . . . : fe90::30gf:258a:84d6:abcf%5 - IPv4 Address. . . . . . . . . . . : 192.0.2.29 - Subnet Mask . . . . . . . . . . . : 255.255.255.255 - IPv4 Address. . . . . . . . . . . : 203.0.113.0 - Subnet Mask . . . . . . . . . . . : 255.255.255.255 - Default Gateway . . . . . . . . . : 192.0.2.1 -``` +> [!tabs] +> Debian 11 +>> **Debian 11** +>> +>> **Etap 1: wyłącz automatyczną konfigurację sieci** +>> +>> Otwórz ścieżkę dostępu do następującego pliku z edytorem tekstu: +>> +>> ```bash +>> sudo nano /etc/cloud/cloud.cfg.d/99-disable-network-config.cfg +>> ``` +>> +>> Wprowadź następującą linię, następnie zapisz i wyjdź z edytora. +>> +>> ```console +>> network: {config: disabled} +>> ``` +>> +>> Utworzenie tego pliku konfiguracyjnego zapobiega automatycznemu wprowadzaniu zmian w konfiguracji Twojej sieci. +>> +>> **Etap 2: zmień plik konfiguracyjny sieci** +>> +>> Domyślnie plik konfiguracyjny znajduje się w ścieżce `etc/network/interfaces.d`. +>> +>> W naszym przykładzie nasz plik nosi nazwę `50-cloud-init`, dlatego wykonujemy kopię pliku `50-cloud-init`, używając następującego polecenia: +>> +>> ```bash +>> sudo cp /etc/network/interfaces.d/50-cloud-init /etc/network/interfaces.d/50-cloud-init.bak +>> ``` +>> +>> W przypadku błędu będziesz mógł wrócić do wprowadzonych zmian, używając następujących poleceń: +>> +>> ```bash +>> sudo rm -f /etc/network/interfaces.d/50-cloud-init +>> sudo cp /etc/network/interfaces.d/50-cloud-init.bak /etc/network/interfaces.d/50-cloud-init +>> ``` +>> +>> **Etap 3: zmień plik konfiguracyjny sieci** +>> +>> Nazwy interfejsu sieciowego możesz sprawdzić za pomocą polecenia: +>> +>> ```bash +>> ip a +>> ``` +>> +>> Otwórz plik konfiguracyjny sieci, aby go zmienić za pomocą następującego polecenia: +>> +>> ```bash +>> sudo nano /etc/network/interfaces.d/50-cloud-init +>> ``` +>> +>> Aby skonfigurować adres Additional IP, dodaj interfejs wirtualny lub alias Ethernet do interfejsu sieciowego. W naszym przykładzie nasz interfejs nosi nazwę `eth0`, więc nasz pierwszy alias to `eth0:0`. Zrób to dla każdego adresu Additional IP, który chcesz skonfigurować. +>> +>> Nie zmieniaj istniejących wierszy w pliku konfiguracyjnym, dodaj tylko adres Additional IP do następującego pliku, zastępując `NETWORK_INTERFACE`, `ID` i `ADDITIONAL_IP` własnymi wartościami: +>> +>> ```console +>> auto NETWORK_INTERFACE:ID +>> iface NETWORK_INTERFACE:ID inet static +>> address ADDITIONAL_IP +>> netmask 255.255.255.255 +>> ``` +>> +>> Jeśli konfigurujesz więcej niż jeden adres Additional IP, plik konfiguracyjny powinien wyglądać następująco: +>> +>> ```console +>> auto NETWORK_INTERFACE:ID +>> iface NETWORK_INTERFACE:ID inet static +>> address ADDITIONAL_IP1 +>> address ADDITIONAL_IP2 +>> netmask 255.255.255.255 +>> ``` +>> +>> /// details | **Przykład** +>> +>> ```console +>> auto eth0:0 +>> iface eth0:0 inet static +>> address 203.0.113.0 +>> netmask 255.255.255.255 +>> ``` +>> /// +>> +>> **Etap 4: restart interfejsu** +>> +>> Zastosuj zmiany za pomocą polecenia: +>> +>> ```bash +>> sudo systemctl restart networking +>> ``` +>> +> Debian 12, Ubuntu 20.04 +>> **Debian 12, Ubuntu 20.04 i późniejsze wersje** +>> +>> Plik konfiguracyjny adresów Additional IP znajduje się w pliku`/etc/netplan/`. W tym przykładzie nazywa się `50-cloud-init.yaml`. +>> +>> Najlepszą praktyką jest utworzenie oddzielnego pliku konfiguracyjnego w celu zdefiniowania adresów Additional IP. W przypadku błędu można łatwo przywrócić modyfikacje. +>> +>> **Etap 1: utworzenie pliku konfiguracji sieci** +>> +>> W naszym przykładzie nasz plik nosi nazwę `51-cloud-init.yaml`: +>> +>> ```bash +>> sudo touch /etc/netplan/51-cloud-init.yaml +>> ``` +>> +>> **Etap 2: modyfikować plik konfiguracji** +>> +>> Nazwy interfejsu sieciowego możesz sprawdzić za pomocą polecenia: +>> +>> ```bash +>> ip a +>> ``` +>> +>> Otwórz plik konfiguracyjny sieci, aby go zmienić za pomocą następującego polecenia: +>> +>> ```bash +>> sudo nano /etc/netplan/51-cloud-init.yaml +>> ``` +>> +>> Edytuj plik, zastępując polecenia `INTERFACE_NAME` i `ADDITIONAL_IP` własnymi wartościami: +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> INTERFACE_NAME: +>> dhcp4: true +>> addresses: +>> - ADDITIONAL_IP1/32 +>> ``` +>> +>> Jeśli masz więcej niż jeden adres Additional IP do skonfigurowania, plik konfiguracyjny powinien wyglądać następująco: +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> INTERFACE_NAME: +>> dhcp4: true +>> addresses: +>> - ADDITIONAL_IP1/32 +>> - ADDITIONAL_IP2/32 +>> ``` +>> +>> > [!warning] +>> > +>> > Ważne jest przestrzeganie wyrównania każdego elementu tego pliku, jak pokazano w powyższym przykładzie. Nie używaj przycisku tabulacji do tworzenia odstępów. +>> > +>> +>> /// details | **Przykład** +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> eth0: +>> dhcp4: true +>> addresses: +>> - 203.0.113.0/32 +>> ``` +>> /// +>> +>> Zapisz i zamknij plik. +>> +>> **Etap 3: zastosować nową konfigurację sieci** +>> +>> Możesz przetestować konfigurację za pomocą polecenia: +>> +>> ```bash +>> sudo netplan try +>> ``` +>> +>> Jeśli jest poprawna, zastosuj ją za pomocą następującego polecenia: +>> +>> ```bash +>> sudo netplan apply +>> ``` +>> +>> Powtórz tę procedurę dla każdego adresu Additional IP. +>> +> AlmaLinux / Rocky Linux +>> **AlmaLinux (8 & 9), Rocky Linux (8 & 9)** +>> +>> Główny plik konfiguracyjny znajduje się w folderze `/etc/sysconfig/network-scripts/`. W tym przykładzie nazywa się `ifcfg-eth0`. Przed wprowadzeniem zmian sprawdź rzeczywistą nazwę pliku w tym folderze. +>> +>> Dla każdego adresu Additional IP, który chcesz skonfigurować, utwórz osobny plik konfiguracyjny z następującymi parametrami: `ifcfg-NETWORK_INTERFACE:ID`. Gdzie `NETWORK_INTERFACE` reprezentuje interfejs fizyczny, a `ID` reprezentuje wirtualny interfejs sieciowy lub alias ethernetowy rozpoczynający się od wartości 0. Na przykład w przypadku interfejsu o nazwie `eth0` pierwszy alias to `eth0:0`, drugi alias to `eth0:1`, etc. +>> +>> **Etap 1: zmień plik konfiguracyjny sieci** +>> +>> Nazwy interfejsu sieciowego możesz sprawdzić za pomocą polecenia: +>> +>> ```bash +>> ip a +>> ``` +>> +>> **Etap 2: tworzenie pliku konfiguracyjnego** +>> +>> Najpierw utwórz plik konfiguracyjny. Zastąp `NETWORK_INTERFACE:ID` własnymi wartościami. +>> +>> ```bash +>> sudo nano /etc/sysconfig/network-scripts/ifcfg-NETWORK_INTERFACE:ID +>> ``` +>> +>> Następnie edytuj plik z poniższą zawartością, zastępując `NETWORK_INTERFACE:ID` i `ADDITIONAL_IP` własnymi wartościami: +>> +>> ```console +>> DEVICE=NETWORK_INTERFACE:ID +>> ONBOOT=yes +>> BOOTPROTO=none # For CentOS use "static" +>> IPADDR=ADDITIONAL_IP +>> NETMASK=255.255.255.255 +>> BROADCAST=ADDITIONAL_IP +>> ``` +>> +>> /// details | **Przykład** +>> +>> ```console +>> DEVICE=eth0:0 +>> ONBOOT=yes +>> BOOTPROTO=none # For CentOS use "static" +>> IPADDR=203.0.113.0 +>> NETMASK=255.255.255.255 +>> BROADCAST=203.0.113.0 +>> ``` +>> /// +>> +>> **Etap 3: restart interfejsu** +>> +>> Zastosuj zmiany za pomocą polecenia: +>> +>> ```bash +>> sudo systemctl restart network +>> ``` +>> +>> Dla AlmaLinux i Rocky Linux +>> +>> ```bash +>> sudo systemctl restart Network Manager +>> ``` +>> +> Fedora 42 +>> **Fedora 42** +>> +>> Fedora używa teraz kluczowych plików. NetworkManager przechowywał wcześniej profile sieciowe w formacie ifcfg w tym katalogu: `/etc/sysconfig/network-scripts/`. Jednak format ifcfg jest teraz przestarzały. Domyślnie program NetworkManager nie tworzy już nowych profilów w tym formacie. Plik konfiguracyjny znajduje się teraz w `/etc/NetworkManager/system-connections/`. +>> +>> **Etap 1: tworzenie kopii zapasowej** +>> +>> W naszym przykładzie nasz plik nosi nazwę `cloud-init-eno1.nmconnection`, wykonujemy zatem kopię pliku `cloud-init-eno1.nmconnection` przy użyciu następującego polecenia: +>> +>> ```bash +>> sudo cp -r /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak +>> ``` +>> +>> W przypadku błędu będziesz mógł wrócić do wprowadzonych zmian, używając następujących poleceń: +>> +>> ```bash +>> sudo rm -f /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> sudo cp /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> ``` +>> +>> **Etap 2: modyfikacja pliku konfiguracyjnego** +>> +>> > [!primary] +>> > Pamiętaj, że nazwa pliku sieciowego w naszym przykładzie może się różnić od Twojej. Dostosuj polecenia do nazwy pliku. +>> > +>> +>> ```bash +>> sudo nano /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> ``` +>> +>> Nie zmieniaj istniejących linii w pliku konfiguracyjnym, dodaj adres Additional IP do pliku w następujący sposób, zastępując `ADDITIONAL_IP/32` własnymi wartościami: +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=ADDITIONAL_IP/32 +>> ``` +>> +>> Jeśli masz dwa adresy Additional IP do skonfigurowania, konfiguracja powinna wyglądać następująco: +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=ADDITIONAL_IP1/32 +>> address2=ADDITIONAL_IP2/32 +>> ``` +>> +>> /// details | **Przykład** +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=203.0.113.0/32 +>> ``` +>> /// +>> +>> **Etap 3: restart interfejsu** +>> +>> Uruchom ponownie interfejs: +>> +>> ```bash +>> systemctl restart Network Manager +>> ``` +>> +> cPanel +>> **cPanel** +>> +>> **Etap 1: dostęp do sekcji zarządzania adresami IP w usłudze WHM** +>> +>> W Panelu klienta WHM kliknij `IP Functions`{.action} i wybierz `Add a New IP Address`{.action} w menu po lewej stronie. +>> +>> ![Add new IP](images/cpanel-alma-1.png){.thumbnail} +>> +>> **Etap 2: dodawanie informacji o adresach Additional IP** +>> +>> W polu "New IP or IP range to add" wpisz Twój adres Additional IP w postaci "xxx.xxx.xxx.xxx". +>> +>> Wybierz `255.255.255.255` jako maskę podsieci, a następnie kliknij `Submit`{.action}. +>> +>> ![enter new IP information](images/cpanel-alma-2.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Uwaga, jeśli masz kilka adresów IP do skonfigurowania na tym samym bloku i dodajesz je wszystkie jednocześnie, system WHM wymusi użycie maski podsieci `255.255.255.0`. Nie zaleca się używania tej konfiguracji, należy dodać każdy adres IP oddzielnie, aby móc korzystać z odpowiedniej maski podsieci `255.255.255.255`. +>> > +>> +>> **Etap 3: weryfikacja aktualnej konfiguracji IP** +>> +>> Wróć do sekcji `IP Functions`{.action}, kliknij `Show or Delete Current IP Addresses`{.action}, aby sprawdzić, czy adres Additional IP został poprawnie dodany. +>> +>> ![check configured IP](images/cpanel-alma-3.png){.thumbnail} +>> +> Plesk +>> **Plesk** +>> +>> **Etap 1: dostęp do interfejsu zarządzania IP Plesk** +>> +>> W panelu sterowania Plesk wybierz `Tools & Settings`{.action} na pasku bocznym po lewej stronie. +>> +>> ![acces to the ip addresses management](images/pleskip1.png){.thumbnail} +>> +>> Kliknij przycisk `IP Addresses`{.action} w obszarze **Tools & Settings**. +>> +>> **Etap 2: dodawanie informacji o adresach Additional IP** +>> +>> W tej sekcji kliknij przycisk `Add IP Address`{.action}. +>> +>> ![add ip information](images/Plesk-2024-vps.png){.thumbnail} +>> +>> W polu "IP address and subnet mask" wpisz adres Additional IP w postaci `xxx.xxx.xxx.xxx/32`, a następnie kliknij przycisk `OK`{.action}. +>> +>> ![add ip information](images/Plesk-additional-ip.png){.thumbnail} +>> +>> **Etap 3: weryfikacja aktualnej konfiguracji IP** +>> +>> W sekcji "IP Addresses" sprawdź, czy adres Additional IP został poprawnie dodany. +>> +>> ![current IP configuration](images/plesk-final-configuration.png){.thumbnail} +>> +> Windows Server +>> **Windows Server** +>> +>> **Etap 1: sprawdź konfigurację sieci** +>> +>> Kliknij prawym przyciskiem myszy przycisk `Start Menu`{.action} i otwórz `Run`{.action}. +>> +>> Wpisz `cmd` i kliknij `OK`{.action}, aby otworzyć aplikację wiersza poleceń. +>> +>> ![cmdprompt](images/vps_win07.png){.thumbnail} +>> +>> Aby pobrać aktualną konfigurację IP, wprowadź `ipconfig` w wierszu poleceń. +>> +>> ```console +>> C:\Users\Administrator>ipconfig +>> +>> Windows IP Configuration +>> +>> Ethernet adapter Ethernet: +>> +>> Connection-specific DNS Suffix . : openstacklocal +>> Link-local IPv6 Address . . . . . : fe90::30gf:258a:84d6:abcf%5 +>> IPv4 Address. . . . . . . . . . . : 192.0.2.29 +>> Subnet Mask . . . . . . . . . . . : 255.255.255.255 +>> Default Gateway . . . . . . . . . : 192.0.2.1 +>> ``` +>> +>> **Etap 2: zmień właściwości IPv4** +>> +>> 1. Przejdź do menu `Start`{.action}, następnie `Control Panel`{.action}, `Network and Internet`{.action}, `Network and Sharing Centre`{.action} oraz `Change Adapter Settings`{.action} na pasku po lewej stronie. +>> 2. Kliknij prawym przyciskiem myszy `Ethernet`{.action}; +>> 3. Kliknij `Properties`{.action}; +>> 4. Wybierz `Internet Protocol Version 4 (TCP/IPv4)`{.action}, następnie kliknij `Properties`{.action}; +>> 5. Kliknij przycisk `Use the following IP address`{.action} i wpisz główny adres IP Twojego serwera, maskę podsieci oraz bramę domyślną, które uzyskasz za pomocą polecenia `ipconfig`{.action} powyżej. W polu "Preferred DNS Server" wpisz `213.186.33.99`. +>> +>> ![change the ip configuration](images/configure-main-ip.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Uwaga: jeśli wprowadzisz niepoprawne informacje, serwer nie będzie dostępny. Będziesz więc musiał wprowadzić poprawki za pośrednictwem KVM. +>> > +>> +>> **Etap 3: dodać adres Additional IP do zaawansowanych ustawień TCP/IP** +>> +>> W nowym oknie kliknij `Add...`{.action} pod "IP addresses". Wpisz adres Additional IP i maskę podsieci (255.255.255.255). +>> +>> ![Advance Configuration section](images/configure-additional-ip.png){.thumbnail} +>> +>> Potwierdź klikając `Add`{.action}. +>> +>> ![Additional IP configuration](images/additional-ip-config.png){.thumbnail} +>> +>> Po zakończeniu kliknij `OK`{.action}, aby zastosować konfigurację. +>> +>> ![Additional IP configuration](images/final-configuration.png){.thumbnail} +>> +>> Połączenie z serwerem zostanie utracone na kilka sekund. +>> +>> **Etap 4: weryfikacja nowej konfiguracji sieci** +>> +>> Otwórz wiersz poleceń (cmd) i wprowadź `ipconfig`. Konfiguracja musi teraz obejmować nowy adres Additional IP. +>> +>> ```console +>> C:\Users\Administrator>ipconfig +>> +>> Windows IP Configuration +>> +>> Ethernet adapter Ethernet: +>> +>> Connection-specific DNS Suffix . : +>> Link-local IPv6 Address . . . . . : fe90::30gf:258a:84d6:abcf%5 +>> IPv4 Address. . . . . . . . . . . : 192.0.2.29 +>> Subnet Mask . . . . . . . . . . . : 255.255.255.255 +>> IPv4 Address. . . . . . . . . . . : 203.0.113.0 +>> Subnet Mask . . . . . . . . . . . : 255.255.255.255 +>> Default Gateway . . . . . . . . . : 192.0.2.1 +>> ``` ### Diagnostyka @@ -486,4 +523,4 @@ Aby przetestować połączenie, wystarczy wysłać ping na adres Additional IP z Jeśli chcesz otrzymywać wsparcie w zakresie konfiguracji i użytkowania Twoich rozwiązań OVHcloud, zapoznaj się z naszymi [ofertami pomocy](/links/support). -Przyłącz się do społeczności naszych użytkowników na stronie . \ No newline at end of file +Dołącz do [grona naszych użytkowników](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/guide.pt-pt.md b/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/guide.pt-pt.md index 8f24932979f..a00b2499796 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/guide.pt-pt.md +++ b/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/guide.pt-pt.md @@ -1,9 +1,23 @@ --- title: 'Configurar um endereço de IP alias' excerpt: 'Saiba como adicionar endereços Additional IP à sua configuração VPS' -updated: 2025-09-11 +updated: 2025-11-12 --- + + ## Objetivo O alias de IP (*IP aliasing* em inglês) é uma configuração especial da rede para os seus servidores OVHcloud, que lhe permite associar vários endereços IP numa única interface de rede. @@ -45,414 +59,447 @@ No que diz respeito às diferentes versões de distribuições, tenha em conta q |NETWORK_INTERFACE|Nome da interface de rede|*eth0*, *ens3*| |ID|ID do alias IP, começando por *0* (em função do número de endereços IP suplementares a configurar)|*0*, *1*| -### Debian 11 - -#### Etapa 1: desativar a configuração automática da rede - -Abra o caminho de acesso ao seguinte ficheiro com um editor de texto: - -```bash -sudo nano /etc/cloud/cloud.cfg.d/99-disable-network-config.cfg -``` - -Introduza a linha seguinte e registe e saia do editor. - -```console -network: {config: disabled} -``` - -A criação deste ficheiro de configuração impede a execução automática das modificações efetuadas na configuração da sua rede. - -#### Etapa 2: criar um backup - -Por predefinição, o ficheiro de configuração está localizado no caminho `etc/network/interfaces.d`. - -No nosso exemplo, o nosso ficheiro chama-se `50-cloud-init`, pelo que fazemos uma cópia do ficheiro `50-cloud-init` utilizando o seguinte comando: - -```bash -sudo cp /etc/network/interfaces.d/50-cloud-init /etc/network/interfaces.d/50-cloud-init.bak -``` - -Em caso de erro, poderá voltar às modificações utilizando os comandos abaixo : - -```bash -sudo rm -f /etc/network/interfaces.d/50-cloud-init -sudo cp /etc/network/interfaces.d/50-cloud-init.bak /etc/network/interfaces.d/50-cloud-init -``` - -#### Etapa 3: alterar o ficheiro de configuração de rede - -Para verificar o nome da interface de rede, utilize o seguinte comando: - -```bash -ip a -``` - -Abra o ficheiro de configuração de rede para o modificar através do seguinte comando: - -```bash -sudo nano /etc/network/interfaces.d/50-cloud-init -``` - -Para configurar o seu endereço Additional IP, adicione uma interface virtual ou um alias Ethernet à sua interface de rede. No nosso exemplo, a nossa interface chama-se `eth0`, pelo que o nosso primeiro alias é `eth0:0`. Faça isso para cada endereço Additional IP que deseja configurar. - -Não altere as linhas existentes no ficheiro de configuração. Adicione apenas o seu endereço Additional IP ao ficheiro da seguinte forma, substituindo `NETWORK_INTERFACE`, `ID` e `ADDITIONAL_IP` pelos seus próprios valores: - -```console -auto NETWORK_INTERFACE:ID -iface NETWORK_INTERFACE:ID inet static -address ADDITIONAL_IP -netmask 255.255.255.255 -``` - -Se configurar mais do que um endereço Additional IP, o ficheiro de configuração deve ter o seguinte formato: - -```console -auto NETWORK_INTERFACE:ID -iface NETWORK_INTERFACE:ID inet static -address ADDITIONAL_IP1 -address ADDITIONAL_IP2 -netmask 255.255.255.255 -``` - -#### Etapa 4: reiniciar a interface - -Execute as alterações através do seguinte comando: - -```bash -sudo systemctl restart networking -``` - -### Debian 12, Ubuntu 20.04 e posteriores - -O ficheiro de configuração dos seus endereços Additional IP encontra-se no ficheiro `/etc/netplan/`. Neste exemplo, chama-se `50-cloud-init.yaml`. - -A melhor prática consiste em criar um ficheiro de configuração distinto para definir os endereços Additional IP. Desta forma, poderá facilmente reverter as alterações em caso de erro. - -#### Etapa 1: criar o ficheiro de configuração de rede - -No nosso exemplo, o nosso ficheiro chama-se `51-cloud-init.yaml`: - -```bash -sudo touch /etc/netplan/51-cloud-init.yaml -``` - -#### Etapa 2: modificar o ficheiro de configuração - -Para verificar o nome da interface de rede, utilize o seguinte comando: - -```bash -ip a -``` - -Abra o ficheiro de configuração de rede para o modificar através do seguinte comando: - -```bash -sudo nano /etc/netplan/51-cloud-init.yaml -``` - -Edite o ficheiro com o conteúdo abaixo, substituindo `INTERFACE_NAME` e `ADDITIONAL_IP` pelos seus próprios valores: - -```yaml -network: - version: 2 - ethernets: - INTERFACE_NAME: - dhcp4: true - addresses: - - ADDITIONAL_IP/32 -``` - -Se tiver mais do que um endereço Additional IP a configurar, o ficheiro de configuração deve ter o seguinte formato: - -```yaml -network: - version: 2 - ethernets: - INTERFACE_NAME: - dhcp4: true - addresses: - - ADDITIONAL_IP1/32 - - ADDITIONAL_IP2/32 -``` - -> [!warning] -> -> É importante respeitar o alinhamento de cada elemento deste ficheiro tal como representado no exemplo acima. Não utilize a tecla de tabulação para criar o seu espaçamento. -> - -**Exemplo** - -```yaml -network: - version: 2 - ethernets: - eth0: - dhcp4: true - addresses: - - 203.0.113.0/32 -``` - -Registe e feche o ficheiro. - -#### Etapa 3: aplicar a nova configuração de rede - -Pode testar a sua configuração através do seguinte comando: - -```bash -sudo netplan try -``` - -Se a configuração estiver correta, execute-a através do seguinte comando: - -```bash -sudo netplan apply -``` - -Repita este procedimento para cada endereço Additional IP. - -### AlmaLinux (8 & 9), Rocky Linux (8 & 9) - -O ficheiro de configuração principal está situado na pasta `/etc/sysconfig/network-scripts/`. Neste exemplo, é chamado `ifcfg-eth0`. Antes de fazer qualquer alteração, verifique o nome real do arquivo nessa pasta. - -Para cada endereço Additional IP a configurar, crie um ficheiro de configuração separado com os seguintes parâmetros: `ifcfg-NETWORK_INTERFACE:ID`. Onde "NETWORK_INTERFACE" representa a interface física, "ID" representa a interface de rede virtual ou o alias ethernet que começa por um valor de 0. Por exemplo, para a nossa interface chamada `eth0` o primeiro alias é `eth0:0`, o segundo alias é `eth0:1`, etc. - -#### Etapa 1: determinar a interface - -Verifique o nome da sua interface de rede através do seguinte comando: - -```bash -ip a -``` - -#### Etapa 2: criar o ficheiro de configuração - -Em primeiro lugar, crie o ficheiro de configuração. Substitua `NETWORK_INTERFACE:ID` pelos seus próprios valores. - -```bash -sudo nano /etc/sysconfig/network-scripts/ifcfg-NETWORK_INTERFACE:ID -``` - -De seguida, edite o ficheiro com o conteúdo abaixo, substituindo `NETWORK_INTERFACE:ID` e `ADDITIONAL_IP` pelos seus próprios valores: +Nos exemplos abaixo, utilizaremos o editor de texto `nano`. Em alguns sistemas operacionais, será necessário instalá-lo antes de poder utilizá-lo. Se for esse o caso, será solicitado que o faça. É claro que pode utilizar o editor de texto de sua preferência. -```console -DEVICE=NETWORK_INTERFACE:ID -ONBOOT=yes -BOOTPROTO=none # For CentOS use "static" -IPADDR=ADDITIONAL_IP -NETMASK=255.255.255.255 -BROADCAST=ADDITIONAL_IP -``` - -**Exemplo** - -```console -DEVICE=eth0:0 -ONBOOT=yes -BOOTPROTO=none # For CentOS use "static" -IPADDR=203.0.113.0 -NETMASK=255.255.255.255 -BROADCAST=203.0.113.0 -``` - -#### Etapa 3: reiniciar a interface - -```bash -sudo systemctl restart network -``` - -#### Para AlmaLinux e Rocky Linux - -```bash -sudo systemctl restart NetworkManager -``` - -### Fedora 37 e versões posteriores - -O Fedora utiliza agora ficheiros-chave. Antes, o NetworkManager armazenava os perfis de rede em formato ifcfg nesse diretório: `/etc/sysconfig/network-scripts/`. No entanto, o formato ifcfg tornou-se obsoleto. Por predefinição, o NetworkManager não cria novos perfis neste formato. O ficheiro de configuração encontra-se agora em `/etc/NetworkManager/system-connections/`. - -#### Etapa 1: criar um backup - -No nosso exemplo, o nosso ficheiro chama-se `cloud-init-eno1.nmconnection`, pelo que fazemos uma cópia do ficheiro `cloud-init-eno1.nmconnection` utilizando o seguinte comando: - -```bash -sudo cp -r /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak -``` - -Em caso de erro, poderá voltar às modificações utilizando os comandos abaixo : - -```bash -sudo rm -f /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -sudo cp /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -``` - -#### Etapa 2: alterar o ficheiro de configuração - -> [!primary] -> Tenha em conta que o nome do ficheiro de rede no nosso exemplo pode ser diferente do seu. Adapte os comandos ao seu nome de ficheiro. -> - -```bash -sudo nano /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection -``` - -Não altere as linhas existentes no ficheiro de configuração. Adicione o seu Additional IP ao ficheiro da seguinte forma, substituindo `ADDITIONAL_IP/32` pelos seus próprios valores: - -```console -[ipv4] -method=auto -may-fail=false -address1=ADDITIONAL_IP/32 -``` - -Se tiver dois endereços Additional IP a configurar, a configuração deve ser semelhante a esta: - -```console -[ipv4] -method=auto -may-fail=false -address1=ADDITIONAL_IP1/32 -address2=ADDITIONAL_IP2/32 -``` - -**Exemplo** - -```console -[ipv4] -method=auto -may-fail=false -address1=203.0.113.0/32 -``` - -#### Etapa 3: reiniciar a interface - -```bash -sudo systemctl restart NetworkManager -``` - -### cPanel - -#### Etapa 1: aceder à secção de gestão dos IP do WHM - -Na Área de Cliente WHM, clique em `IP Functions`{.action} e selecione `Add a New IP Address`{.action} no menu à esquerda. - -![Add new IP](images/cpanel-alma-1.png){.thumbnail} - -#### Etapa 2: adicionar as informações dos Additional IP - -Introduza o seu endereço Additional IP na forma "xxx.xxx.xxx.xxx" no campo "New IP or IP range to add". - -Selecione `255.255.255.255` como máscara de sub-rede e clique em `Submit`{.action}. - -![enter new IP information](images/cpanel-alma-2.png){.thumbnail} - -> [!warning] -> -> Atenção: se tiver vários IP a configurar num mesmo bloco e os adicionar todos ao mesmo tempo, o sistema WHM obriga-o a utilizar a máscara de sub-rede `255.255.255.0`. Não é recomendado utilizar esta configuração, é preciso adicionar cada IP individualmente para poder utilizar a máscara de sub-rede apropriada `255.255.255.255`. -> - -#### Etapa 3: verificar a configuração IP atual - -De volta à secção `IP Functions`{.action}, clique em `Show or Delete Current IP Addresses`{.action} para verificar se o endereço Additional IP foi corretamente adicionado. - -![check configured IP](images/cpanel-alma-3.png){.thumbnail} - -### Plesk - -#### Etapa 1: aceder à gestão do IP do Plesk - -No painel de configuração Plesk, selecione `Tools & Settings`{.action} na barra lateral esquerda. - -![acces to the ip addresses management](images/pleskip1.png){.thumbnail} - -Clique em `IP Addresses`{.action} em **Tools & Settings**. - -#### Etapa 2: adicionar as informações dos Additional IP - -Nesta secção, clique no botão `Add IP Address`{.action}. - -![add ip information](images/Plesk-2024-vps.png){.thumbnail} - -Introduza o seu endereço Additional IP sob a forma `xxx.xxx.xxx.xxx/32` no campo "IP address and subnet mask" e, em seguida, clique em `OK`{.action}. - -![add ip information](images/Plesk-additional-ip.png){.thumbnail} - -#### Etapa 3: verificar a configuração IP atual - -Na secção "IP Addresses", verifique se o endereço Additional IP foi adicionado com êxito. - -![current IP configuration](images/plesk-final-configuration.png){.thumbnail} - -### Windows Server - -#### Etapa 1: verificar a configuração de rede - -Clique com o botão `Start Menu`{.action} e abra a `Run`{.action}. - -Introduza `cmd` e clique em `OK`{.action} para abrir a aplicação de linha de comando. - -![cmdprompt](images/vps_win07.png){.thumbnail} - -Para obter a configuração IP atual, insira o `ipconfig` na encomenda. - -```console -C:\Users\Administrator>ipconfig -Windows IP Configuration -Ethernet adapter Ethernet: - Connection-specific DNS Suffix . : openstacklocal - Link-local IPv6 Address . . . . . : fe90::30gf:258a:84d6:abcf%5 - IPv4 Address. . . . . . . . . . . : 192.0.2.29 - Subnet Mask . . . . . . . . . . . : 255.255.255.255 - Default Gateway . . . . . . . . . : 192.0.2.1 -``` - -#### Etapa 2: modificar as propriedades IPv4 - -1. Aceda ao menu `Start`{.action} e depois ao `Control Panel`{.action}, `Network and Internet`{.action}, `Network and Sharing Centre`{.action} e `Change Adapter Settings`{.action} na barra à esquerda. -2. Clique com o botão direito do rato em `Ethernet`{.action} -3. Clique em `Properties`{.action} -4. Selecione `Internet Protocol Version 4 (TCP/IPv4)`{.action} e clique em `Properties`{.action}; -5. Clique em `Use the following IP address`{.action} e digite o IP principal do seu servidor, a máscara de sub-rede e o gateway padrão obtidos com o comando `ipconfig`{.action} acima. Na caixa "Preferred DNS Server", digite `213.186.33.99`. - -![change the ip configuration](images/configure-main-ip.png){.thumbnail} - -> [!warning] +> [!success] +> Selecione a guia correspondente ao seu sistema operacional. > -> Atenção: se introduzir informação incorreta, o servidor ficará inacessível. Será obrigado a efetuar as correções através do KVM. -> - -#### Etapa 3: adicionar o endereço Additional IP nos Parâmetros TCP/IP avançados - -Na nova janela, clique em `Add...`{.action} em "IP addresses". Introduza o seu endereço Additional IP e a máscara de sub-rede (255.255.255.255). - -![advance configuration section](images/configure-additional-ip.png){.thumbnail} - -Confirme ao clicar em `Add`{.action}. - -![Additional IP configuration](images/additional-ip-config.png){.thumbnail} -Uma vez concluído, clique em `OK`{.action} para aplicar a configuração. - -![Additional IP configuration](images/final-configuration.png){.thumbnail} - -A ligação ao seu servidor será interrompida durante alguns segundos. - -#### Etapa 4: verificar a nova configuração de rede - -Abra a linha de comandos (cmd) e introduza o `ipconfig`. A configuração deve agora incluir o novo endereço Additional IP. - -```console -C:\Users\Administrator>ipconfig -Windows IP Configuration -Ethernet adapter Ethernet: - Connection-specific DNS Suffix . : - Link-local IPv6 Address . . . . . : fe90::30gf:258a:84d6:abcf%5 - IPv4 Address. . . . . . . . . . . : 192.0.2.29 - Subnet Mask . . . . . . . . . . . : 255.255.255.255 - IPv4 Address. . . . . . . . . . . : 203.0.113.0 - Subnet Mask . . . . . . . . . . . : 255.255.255.255 - Default Gateway . . . . . . . . . : 192.0.2.1 -``` +> [!tabs] +> Debian 11 +>> **Debian 11** +>> +>> **Etapa 1: desativar a configuração automática da rede** +>> +>> Abra o caminho de acesso ao seguinte ficheiro com um editor de texto: +>> +>> ```bash +>> sudo nano /etc/cloud/cloud.cfg.d/99-disable-network-config.cfg +>> ``` +>> +>> Introduza a linha seguinte e registe e saia do editor. +>> +>> ```console +>> network: {config: disabled} +>> ``` +>> +>> A criação deste ficheiro de configuração impede a execução automática das modificações efetuadas na configuração da sua rede. +>> +>> **Etapa 2: criar um backup** +>> +>> Por predefinição, o ficheiro de configuração está localizado no caminho `etc/network/interfaces.d`. +>> +>> No nosso exemplo, o nosso ficheiro chama-se `50-cloud-init`, pelo que fazemos uma cópia do ficheiro `50-cloud-init` utilizando o seguinte comando: +>> +>> ```bash +>> sudo cp /etc/network/interfaces.d/50-cloud-init /etc/network/interfaces.d/50-cloud-init.bak +>> ``` +>> +>> Em caso de erro, poderá voltar às modificações utilizando os comandos abaixo : +>> +>> ```bash +>> sudo rm -f /etc/network/interfaces.d/50-cloud-init +>> sudo cp /etc/network/interfaces.d/50-cloud-init.bak /etc/network/interfaces.d/50-cloud-init +>> ``` +>> +>> **Etapa 3: alterar o ficheiro de configuração de rede** +>> +>> Para verificar o nome da interface de rede, utilize o seguinte comando: +>> +>> ```bash +>> ip a +>> ``` +>> +>> Abra o ficheiro de configuração de rede para o modificar através do seguinte comando: +>> +>> ```bash +>> sudo nano /etc/network/interfaces.d/50-cloud-init +>> ``` +>> +>> Para configurar o seu endereço Additional IP, adicione uma interface virtual ou um alias Ethernet à sua interface de rede. No nosso exemplo, a nossa interface chama-se `eth0`, pelo que o nosso primeiro alias é `eth0:0`. Faça isso para cada endereço Additional IP que deseja configurar. +>> +>> Não altere as linhas existentes no ficheiro de configuração. Adicione apenas o seu endereço Additional IP ao ficheiro da seguinte forma, substituindo `NETWORK_INTERFACE`, `ID` e `ADDITIONAL_IP` pelos seus próprios valores: +>> +>> ```console +>> auto NETWORK_INTERFACE:ID +>> iface NETWORK_INTERFACE:ID inet static +>> address ADDITIONAL_IP +>> netmask 255.255.255.255 +>> ``` +>> +>> Se configurar mais do que um endereço Additional IP, o ficheiro de configuração deve ter o seguinte formato: +>> +>> ```console +>> auto NETWORK_INTERFACE:ID +>> iface NETWORK_INTERFACE:ID inet static +>> address ADDITIONAL_IP1 +>> address ADDITIONAL_IP2 +>> netmask 255.255.255.255 +>> ``` +>> +>> /// details | **Exemplo** +>> +>> ```console +>> auto eth0:0 +>> iface eth0:0 inet static +>> address 203.0.113.0 +>> netmask 255.255.255.255 +>> ``` +>> /// +>> +>> **Etapa 4: reiniciar a interface** +>> +>> Execute as alterações através do seguinte comando: +>> +>> ```bash +>> sudo systemctl restart networking +>> ``` +>> +> Debian 12, Ubuntu 20.04+ +>> **Debian 12, Ubuntu 20.04 e posteriores** +>> +>> O ficheiro de configuração dos seus endereços Additional IP encontra-se no ficheiro `/etc/netplan/`. Neste exemplo, chama-se `50-cloud-init.yaml`. +>> +>> A melhor prática consiste em criar um ficheiro de configuração distinto para definir os endereços Additional IP. Desta forma, poderá facilmente reverter as alterações em caso de erro. +>> +>> **Etapa 1: criar o ficheiro de configuração de rede** +>> +>> No nosso exemplo, o nosso ficheiro chama-se `51-cloud-init.yaml`: +>> +>> ```bash +>> sudo touch /etc/netplan/51-cloud-init.yaml +>> ``` +>> +>> **Etapa 2: modificar o ficheiro de configuração** +>> +>> Para verificar o nome da interface de rede, utilize o seguinte comando: +>> +>> ```bash +>> ip a +>> ``` +>> +>> Abra o ficheiro de configuração de rede para o modificar através do seguinte comando: +>> +>> ```bash +>> sudo nano /etc/netplan/51-cloud-init.yaml +>> ``` +>> +>> Edite o ficheiro com o conteúdo abaixo, substituindo `INTERFACE_NAME` e `ADDITIONAL_IP` pelos seus próprios valores: +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> INTERFACE_NAME: +>> dhcp4: true +>> addresses: +>> - ADDITIONAL_IP1/32 +>> ``` +>> +>> Se tiver mais do que um endereço Additional IP a configurar, o ficheiro de configuração deve ter o seguinte formato: +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> INTERFACE_NAME: +>> dhcp4: true +>> addresses: +>> - ADDITIONAL_IP1/32 +>> - ADDITIONAL_IP2/32 +>> ``` +>> +>> > [!warning] +>> > +>> > É importante respeitar o alinhamento de cada elemento deste ficheiro tal como representado no exemplo acima. Não utilize a tecla de tabulação para criar o seu espaçamento. +>> > +>> +>> /// details | **Exemplo** +>> +>> ```yaml +>> network: +>> version: 2 +>> ethernets: +>> eth0: +>> dhcp4: true +>> addresses: +>> - 203.0.113.0/32 +>> ``` +>> /// +>> +>> Registe e feche o ficheiro. +>> +>> **Etapa 3: aplicar a nova configuração de rede** +>> +>> Pode testar a sua configuração através do seguinte comando: +>> +>> ```bash +>> sudo netplan try +>> ``` +>> +>> Se a configuração estiver correta, execute-a através do seguinte comando: +>> +>> ```bash +>> sudo netplan apply +>> ``` +>> +>> Repita este procedimento para cada endereço Additional IP. +>> +> AlmaLinux / Rocky Linux +>> **AlmaLinux (8 & 9), Rocky Linux (8 & 9)** +>> +>> O ficheiro de configuração principal está situado na pasta `/etc/sysconfig/network-scripts/`. Neste exemplo, é chamado `ifcfg-eth0`. Antes de fazer qualquer alteração, verifique o nome real do arquivo nessa pasta. +>> +>> Para cada endereço Additional IP a configurar, crie um ficheiro de configuração separado com os seguintes parâmetros: `ifcfg-NETWORK_INTERFACE:ID`. Onde "NETWORK_INTERFACE" representa a interface física, "ID" representa a interface de rede virtual ou o alias ethernet que começa por um valor de 0. Por exemplo, para a nossa interface chamada `eth0` o primeiro alias é `eth0:0`, o segundo alias é `eth0:1`, etc. +>> +>> **Etapa 1: determinar a interface** +>> +>> Verifique o nome da sua interface de rede através do seguinte comando: +>> +>> ```bash +>> ip a +>> ``` +>> +>> **Etapa 2: criar o ficheiro de configuração** +>> +>> Em primeiro lugar, crie o ficheiro de configuração. Substitua `NETWORK_INTERFACE:ID` pelos seus próprios valores. +>> +>> ```bash +>> sudo nano /etc/sysconfig/network-scripts/ifcfg-NETWORK_INTERFACE:ID +>> ``` +>> +>> De seguida, edite o ficheiro com o conteúdo abaixo, substituindo `NETWORK_INTERFACE:ID` e `ADDITIONAL_IP` pelos seus próprios valores: +>> +>> ```console +>> DEVICE=NETWORK_INTERFACE:ID +>> ONBOOT=yes +>> BOOTPROTO=none # For CentOS use "static" +>> IPADDR=ADDITIONAL_IP +>> NETMASK=255.255.255.255 +>> BROADCAST=ADDITIONAL_IP +>> ``` +>> +>> /// details | **Exemplo** +>> +>> ```console +>> DEVICE=eth0:0 +>> ONBOOT=yes +>> BOOTPROTO=none # For CentOS use "static" +>> IPADDR=203.0.113.0 +>> NETMASK=255.255.255.255 +>> BROADCAST=203.0.113.0 +>> ``` +>> /// +>> +>> **Etapa 3: reiniciar a interface** +>> +>> ```bash +>> sudo systemctl restart network +>> ``` +>> +>> Para AlmaLinux e Rocky Linux +>> +>> ```bash +>> sudo systemctl restart NetworkManager +>> ``` +>> +> Fedora 42 +>> **Fedora 42** +>> +>> O Fedora utiliza agora ficheiros-chave. Antes, o NetworkManager armazenava os perfis de rede em formato ifcfg nesse diretório: `/etc/sysconfig/network-scripts/`. No entanto, o formato ifcfg tornou-se obsoleto. Por predefinição, o NetworkManager não cria novos perfis neste formato. O ficheiro de configuração encontra-se agora em `/etc/NetworkManager/system-connections/`. +>> +>> **Etapa 1: criar um backup** +>> +>> No nosso exemplo, o nosso ficheiro chama-se `cloud-init-eno1.nmconnection`, pelo que fazemos uma cópia do ficheiro `cloud-init-eno1.nmconnection` utilizando o seguinte comando: +>> +>> ```bash +>> sudo cp -r /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak +>> ``` +>> +>> Em caso de erro, poderá voltar às modificações utilizando os comandos abaixo : +>> +>> ```bash +>> sudo rm -f /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> sudo cp /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection.bak /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> ``` +>> +>> **Etapa 2: alterar o ficheiro de configuração** +>> +>> > [!primary] +>> > Tenha em conta que o nome do ficheiro de rede no nosso exemplo pode ser diferente do seu. Adapte os comandos ao seu nome de ficheiro. +>> > +>> +>> ```bash +>> sudo nano /etc/NetworkManager/system-connections/cloud-init-eno1.nmconnection +>> ``` +>> +>> Não altere as linhas existentes no ficheiro de configuração. Adicione o seu Additional IP ao ficheiro da seguinte forma, substituindo `ADDITIONAL_IP/32` pelos seus próprios valores: +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=ADDITIONAL_IP/32 +>> ``` +>> +>> Se tiver dois endereços Additional IP a configurar, a configuração deve ser semelhante a esta: +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=ADDITIONAL_IP1/32 +>> address2=ADDITIONAL_IP2/32 +>> ``` +>> +>> /// details | **Exemplo** +>> +>> ```console +>> [ipv4] +>> method=auto +>> may-fail=false +>> address1=203.0.113.0/32 +>> ``` +>> /// +>> +>> **Etapa 3: reiniciar a interface** +>> +>> ```bash +>> sudo systemctl restart NetworkManager +>> ``` +>> +> cPanel +>> **cPanel** +>> +>> **Etapa 1: aceder à secção de gestão dos IP do WHM** +>> +>> Na Área de Cliente WHM, clique em `IP Functions`{.action} e selecione `Add a New IP Address`{.action} no menu à esquerda. +>> +>> ![Add new IP](images/cpanel-alma-1.png){.thumbnail} +>> +>> **Etapa 2: adicionar as informações dos Additional IP** +>> +>> Introduza o seu endereço Additional IP na forma "xxx.xxx.xxx.xxx" no campo "New IP or IP range to add". +>> +>> Selecione `255.255.255.255` como máscara de sub-rede e clique em `Submit`{.action}. +>> +>> ![enter new IP information](images/cpanel-alma-2.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Atenção: se tiver vários IP a configurar num mesmo bloco e os adicionar todos ao mesmo tempo, o sistema WHM obriga-o a utilizar a máscara de sub-rede `255.255.255.0`. Não é recomendado utilizar esta configuração, é preciso adicionar cada IP individualmente para poder utilizar a máscara de sub-rede apropriada `255.255.255.255`. +>> > +>> +>> **Etapa 3: verificar a configuração IP atual** +>> +>> De volta à secção `IP Functions`{.action}, clique em `Show or Delete Current IP Addresses`{.action} para verificar se o endereço Additional IP foi corretamente adicionado. +>> +>> ![check configured IP](images/cpanel-alma-3.png){.thumbnail} +>> +> Plesk +>> **Plesk** +>> +>> **Etapa 1: aceder à gestão do IP do Plesk** +>> +>> No painel de configuração Plesk, selecione `Tools & Settings`{.action} na barra lateral esquerda. +>> +>> ![acces to the ip addresses management](images/pleskip1.png){.thumbnail} +>> +>> Clique em `IP Addresses`{.action} em **Tools & Settings**. +>> +>> **Etapa 2: adicionar as informações dos Additional IP** +>> +>> Nesta secção, clique no botão `Add IP Address`{.action}. +>> +>> ![add ip information](images/Plesk-2024-vps.png){.thumbnail} +>> +>> Introduza o seu endereço Additional IP sob a forma `xxx.xxx.xxx.xxx/32` no campo "IP address and subnet mask" e, em seguida, clique em `OK`{.action}. +>> +>> ![add ip information](images/Plesk-additional-ip.png){.thumbnail} +>> +>> **Etapa 3: verificar a configuração IP atual** +>> +>> Na secção "IP Addresses", verifique se o endereço Additional IP foi adicionado com êxito. +>> +>> ![current IP configuration](images/plesk-final-configuration.png){.thumbnail} +>> +> Windows Server +>> **Windows Server** +>> +>> **Etapa 1: verificar a configuração de rede** +>> +>> Clique com o botão `Start Menu`{.action} e abra a `Run`{.action}. +>> +>> Introduza `cmd` e clique em `OK`{.action} para abrir a aplicação de linha de comando. +>> +>> ![cmdprompt](images/vps_win07.png){.thumbnail} +>> +>> Para obter a configuração IP atual, insira o `ipconfig` na encomenda. +>> +>> ```console +>> C:\Users\Administrator>ipconfig +>> +>> Windows IP Configuration +>> +>> Ethernet adapter Ethernet: +>> +>> Connection-specific DNS Suffix . : openstacklocal +>> Link-local IPv6 Address . . . . . : fe90::30gf:258a:84d6:abcf%5 +>> IPv4 Address. . . . . . . . . . . : 192.0.2.29 +>> Subnet Mask . . . . . . . . . . . : 255.255.255.255 +>> Default Gateway . . . . . . . . . : 192.0.2.1 +>> ``` +>> +>> **Etapa 2: modificar as propriedades IPv4** +>> +>> 1. Aceda ao menu `Start`{.action} e depois ao `Control Panel`{.action}, `Network and Internet`{.action}, `Network and Sharing Centre`{.action} e `Change Adapter Settings`{.action} na barra à esquerda. +>> 2. Clique com o botão direito do rato em `Ethernet`{.action} +>> 3. Clique em `Properties`{.action} +>> 4. Selecione `Internet Protocol Version 4 (TCP/IPv4)`{.action} e clique em `Properties`{.action}; +>> 5. Clique em `Use the following IP address`{.action} e digite o IP principal do seu servidor, a máscara de sub-rede e o gateway padrão obtidos com o comando `ipconfig`{.action} acima. Na caixa "Preferred DNS Server", digite `213.186.33.99`. +>> +>> ![change the ip configuration](images/configure-main-ip.png){.thumbnail} +>> +>> > [!warning] +>> > +>> > Atenção: se introduzir informação incorreta, o servidor ficará inacessível. Será obrigado a efetuar as correções através do KVM. +>> > +>> +>> **Etapa 3: adicionar o endereço Additional IP nos Parâmetros TCP/IP avançados** +>> +>> Na nova janela, clique em `Add...`{.action} em "IP addresses". Introduza o seu endereço Additional IP e a máscara de sub-rede (255.255.255.255). +>> +>> ![advance configuration section](images/configure-additional-ip.png){.thumbnail} +>> +>> Confirme ao clicar em `Add`{.action}. +>> +>> ![Additional IP configuration](images/additional-ip-config.png){.thumbnail} +>> +>> Uma vez concluído, clique em `OK`{.action} para aplicar a configuração. +>> +>> ![Additional IP configuration](images/final-configuration.png){.thumbnail} +>> +>> A ligação ao seu servidor será interrompida durante alguns segundos. +>> +>> **Etapa 4: verificar a nova configuração de rede** +>> +>> Abra a linha de comandos (cmd) e introduza o `ipconfig`. A configuração deve agora incluir o novo endereço Additional IP. +>> +>> ```console +>> C:\Users\Administrator>ipconfig +>> +>> Windows IP Configuration +>> +>> Ethernet adapter Ethernet: +>> +>> Connection-specific DNS Suffix . : +>> Link-local IPv6 Address . . . . . : fe90::30gf:258a:84d6:abcf%5 +>> IPv4 Address. . . . . . . . . . . : 192.0.2.29 +>> Subnet Mask . . . . . . . . . . . : 255.255.255.255 +>> IPv4 Address. . . . . . . . . . . : 203.0.113.0 +>> Subnet Mask . . . . . . . . . . . : 255.255.255.255 +>> Default Gateway . . . . . . . . . : 192.0.2.1 +>> ``` ### Diagnóstico diff --git a/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/images/Plesk-final-config.PNG b/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/images/Plesk-final-config.PNG deleted file mode 100644 index fa3c7097f51..00000000000 Binary files a/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/images/Plesk-final-config.PNG and /dev/null differ diff --git a/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/images/image3-3.png b/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/images/image3-3.png deleted file mode 100644 index 68214219fe9..00000000000 Binary files a/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/images/image3-3.png and /dev/null differ diff --git a/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/images/image4.png b/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/images/image4.png deleted file mode 100644 index d7b1642d30d..00000000000 Binary files a/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/images/image4.png and /dev/null differ diff --git a/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/images/image5.png b/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/images/image5.png deleted file mode 100644 index 28dc7efe5c6..00000000000 Binary files a/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/images/image5.png and /dev/null differ diff --git a/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/images/image8.png b/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/images/image8.png deleted file mode 100644 index b7c3866fd96..00000000000 Binary files a/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/images/image8.png and /dev/null differ diff --git a/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/images/pleskip2.png b/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/images/pleskip2.png deleted file mode 100644 index 69b42afe1da..00000000000 Binary files a/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/images/pleskip2.png and /dev/null differ diff --git a/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/images/pleskip3.png b/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/images/pleskip3.png deleted file mode 100644 index b95cbcefd53..00000000000 Binary files a/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/images/pleskip3.png and /dev/null differ diff --git a/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/images/pleskip4.png b/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/images/pleskip4.png deleted file mode 100644 index 85d0a004336..00000000000 Binary files a/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing/images/pleskip4.png and /dev/null differ diff --git a/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.de-de.md b/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.de-de.md index 8fc6cb30f1a..13022dbb776 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.de-de.md +++ b/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.de-de.md @@ -1,13 +1,9 @@ --- title: Reverse DNS Ihres Servers konfigurieren (PTR record) excerpt: Erfahren Sie hier, wie Sie die Reverse DNS-Auflösung Ihrer IP-Adresse über Ihr Kundencenter einrichten -updated: 2025-04-28 +updated: 2025-09-18 --- -> [!primary] -> Diese Übersetzung wurde durch unseren Partner SYSTRAN automatisch erstellt. In manchen Fällen können ungenaue Formulierungen verwendet worden sein, z.B. bei der Beschriftung von Schaltflächen oder technischen Details. Bitte ziehen Sie im Zweifelsfall die englische oder französische Fassung der Anleitung zu Rate. Möchten Sie mithelfen, diese Übersetzung zu verbessern? Dann nutzen Sie dazu bitte den Button "Beitragen" auf dieser Seite. -> - ## Ziel Reverse DNS (*rDNS*) ist das ergänzende Gegenstück zur "*Forward*" DNS-Auflösung, die Domainnamen zu IP-Adressen auflöst. Mit Reverse DNS-Auflösung kann eine IP-Adresse zu dem Domainnamen (oder Hostnamen) aufgelöst werden, dem sie zugeordnet ist. Das bedeutet, dass DNS-Abfragen (*DNS Lookup*) der entsprechenden IP-Adresse diesen Domainnamen zurückgeben. @@ -48,7 +44,7 @@ Sie können den Reverse-Pfad auch direkt mithilfe des Stift-Icons in der Spalte > - Der *Reverse* darf keine Großbuchstaben enthalten. > - Der *Reverse* muss mit einem `.` enden. > -> Beispiel: Für "domain.tld" wäre der *Reverse*: **domain.tld.** +> Beispiel: Für "domain.tld" wäre der *Reverse* `domain.tld.` > > [!primary] diff --git a/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.en-asia.md b/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.en-asia.md deleted file mode 100644 index 4733d38f858..00000000000 --- a/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.en-asia.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: How to configure reverse DNS for your server (PTR record) -excerpt: Find out how to set up the reverse DNS resolution for your IP address in the OVHcloud Control Panel -updated: 2025-04-28 ---- - -## Objective - -Reverse DNS (*rDNS*) is the complement to "forward" DNS resolution which resolves domain names into IP addresses. With reverse DNS resolution, an IP address can resolve into the domain name (or host name) it is mapped to. This means that DNS queries of the associated IP address will return this domain name. - -Configuring the reverse DNS resolution for a server is especially useful when sending emails. A mail server's validation by spam protection systems will improve if a DNS lookup of the IP address resolves properly. - -**This guide explains how to configure the reverse DNS path for your IP address in the OVHcloud Control Panel.** - -## Requirements - -- An IP address attached to a service in your OVHcloud account -- A domain name with its `A` record mapped to your service -- Access to the [OVHcloud Control Panel](/links/manager) - -## Instructions - -Log in to the [OVHcloud Control Panel](/links/manager), open the `Network`{.action} menu in the left-hand sidebar and click `Public IP Addresses`{.action}. - -The drop-down menus in the section **My public IP addresses and associated services** allow you to filter the table items for services and find your desired IP address quickly. - -![Reverse DNS](/pages/assets/screens/control_panel/product-selection/bare-metal-cloud/network/filterip.png){.thumbnail} - -Click on `...`{.action} in the row of the IP address concerned and select `Modify the reverse path`{.action}. - -![Reverse DNS](/pages/assets/screens/control_panel/product-selection/bare-metal-cloud/network/modifyreverse.png){.thumbnail} - -In the new window, enter your reverse path and click on `Validate`{.action}. - -![Reverse DNS](/pages/assets/screens/control_panel/product-selection/bare-metal-cloud/network/enterreverse.png){.thumbnail} - -You can also edit the reverse path directly via the pen icon in the **Reverse DNS** column of the table. - -> [!warning] -> When you enter your domain name in the reverse, it double checks immediately if the A record is referring back to the same IP. This is used in anti-spam procedures, so your A record must be valid and propagated. There are certain rules to follow while entering the reverse: -> -> - It cannot start with a `-`. -> - It cannot be longer than 63 characters. -> - It cannot contain uppercase characters. -> - It must end with a `.`. -> -> Example: "domain.tld" in the reverse record would be **"domain.tld"**. -> - -> [!primary] -> -If the modification does not work as expected, verify that the `A` record is correctly configured in the DNS zone of your domain name. Bear in mind that it might take up to 24 hours for DNS zone changes to be effective, in case you have only recently edited the `A` record. -> -If the domain name is managed by OVHcloud as its registrar **and it uses OVHcloud DNS servers**, you can refer to [this guide](/pages/web_cloud/domains/dns_zone_edit). -> - -## Go further - -[How to edit an OVHcloud DNS zone](/pages/web_cloud/domains/dns_zone_edit) - -[How to modify the DNS servers of an OVHcloud domain name](/pages/web_cloud/domains/dns_server_edit) - -Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.en-au.md b/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.en-au.md deleted file mode 100644 index 4733d38f858..00000000000 --- a/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.en-au.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: How to configure reverse DNS for your server (PTR record) -excerpt: Find out how to set up the reverse DNS resolution for your IP address in the OVHcloud Control Panel -updated: 2025-04-28 ---- - -## Objective - -Reverse DNS (*rDNS*) is the complement to "forward" DNS resolution which resolves domain names into IP addresses. With reverse DNS resolution, an IP address can resolve into the domain name (or host name) it is mapped to. This means that DNS queries of the associated IP address will return this domain name. - -Configuring the reverse DNS resolution for a server is especially useful when sending emails. A mail server's validation by spam protection systems will improve if a DNS lookup of the IP address resolves properly. - -**This guide explains how to configure the reverse DNS path for your IP address in the OVHcloud Control Panel.** - -## Requirements - -- An IP address attached to a service in your OVHcloud account -- A domain name with its `A` record mapped to your service -- Access to the [OVHcloud Control Panel](/links/manager) - -## Instructions - -Log in to the [OVHcloud Control Panel](/links/manager), open the `Network`{.action} menu in the left-hand sidebar and click `Public IP Addresses`{.action}. - -The drop-down menus in the section **My public IP addresses and associated services** allow you to filter the table items for services and find your desired IP address quickly. - -![Reverse DNS](/pages/assets/screens/control_panel/product-selection/bare-metal-cloud/network/filterip.png){.thumbnail} - -Click on `...`{.action} in the row of the IP address concerned and select `Modify the reverse path`{.action}. - -![Reverse DNS](/pages/assets/screens/control_panel/product-selection/bare-metal-cloud/network/modifyreverse.png){.thumbnail} - -In the new window, enter your reverse path and click on `Validate`{.action}. - -![Reverse DNS](/pages/assets/screens/control_panel/product-selection/bare-metal-cloud/network/enterreverse.png){.thumbnail} - -You can also edit the reverse path directly via the pen icon in the **Reverse DNS** column of the table. - -> [!warning] -> When you enter your domain name in the reverse, it double checks immediately if the A record is referring back to the same IP. This is used in anti-spam procedures, so your A record must be valid and propagated. There are certain rules to follow while entering the reverse: -> -> - It cannot start with a `-`. -> - It cannot be longer than 63 characters. -> - It cannot contain uppercase characters. -> - It must end with a `.`. -> -> Example: "domain.tld" in the reverse record would be **"domain.tld"**. -> - -> [!primary] -> -If the modification does not work as expected, verify that the `A` record is correctly configured in the DNS zone of your domain name. Bear in mind that it might take up to 24 hours for DNS zone changes to be effective, in case you have only recently edited the `A` record. -> -If the domain name is managed by OVHcloud as its registrar **and it uses OVHcloud DNS servers**, you can refer to [this guide](/pages/web_cloud/domains/dns_zone_edit). -> - -## Go further - -[How to edit an OVHcloud DNS zone](/pages/web_cloud/domains/dns_zone_edit) - -[How to modify the DNS servers of an OVHcloud domain name](/pages/web_cloud/domains/dns_server_edit) - -Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.en-ca.md b/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.en-ca.md deleted file mode 100644 index 4733d38f858..00000000000 --- a/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.en-ca.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: How to configure reverse DNS for your server (PTR record) -excerpt: Find out how to set up the reverse DNS resolution for your IP address in the OVHcloud Control Panel -updated: 2025-04-28 ---- - -## Objective - -Reverse DNS (*rDNS*) is the complement to "forward" DNS resolution which resolves domain names into IP addresses. With reverse DNS resolution, an IP address can resolve into the domain name (or host name) it is mapped to. This means that DNS queries of the associated IP address will return this domain name. - -Configuring the reverse DNS resolution for a server is especially useful when sending emails. A mail server's validation by spam protection systems will improve if a DNS lookup of the IP address resolves properly. - -**This guide explains how to configure the reverse DNS path for your IP address in the OVHcloud Control Panel.** - -## Requirements - -- An IP address attached to a service in your OVHcloud account -- A domain name with its `A` record mapped to your service -- Access to the [OVHcloud Control Panel](/links/manager) - -## Instructions - -Log in to the [OVHcloud Control Panel](/links/manager), open the `Network`{.action} menu in the left-hand sidebar and click `Public IP Addresses`{.action}. - -The drop-down menus in the section **My public IP addresses and associated services** allow you to filter the table items for services and find your desired IP address quickly. - -![Reverse DNS](/pages/assets/screens/control_panel/product-selection/bare-metal-cloud/network/filterip.png){.thumbnail} - -Click on `...`{.action} in the row of the IP address concerned and select `Modify the reverse path`{.action}. - -![Reverse DNS](/pages/assets/screens/control_panel/product-selection/bare-metal-cloud/network/modifyreverse.png){.thumbnail} - -In the new window, enter your reverse path and click on `Validate`{.action}. - -![Reverse DNS](/pages/assets/screens/control_panel/product-selection/bare-metal-cloud/network/enterreverse.png){.thumbnail} - -You can also edit the reverse path directly via the pen icon in the **Reverse DNS** column of the table. - -> [!warning] -> When you enter your domain name in the reverse, it double checks immediately if the A record is referring back to the same IP. This is used in anti-spam procedures, so your A record must be valid and propagated. There are certain rules to follow while entering the reverse: -> -> - It cannot start with a `-`. -> - It cannot be longer than 63 characters. -> - It cannot contain uppercase characters. -> - It must end with a `.`. -> -> Example: "domain.tld" in the reverse record would be **"domain.tld"**. -> - -> [!primary] -> -If the modification does not work as expected, verify that the `A` record is correctly configured in the DNS zone of your domain name. Bear in mind that it might take up to 24 hours for DNS zone changes to be effective, in case you have only recently edited the `A` record. -> -If the domain name is managed by OVHcloud as its registrar **and it uses OVHcloud DNS servers**, you can refer to [this guide](/pages/web_cloud/domains/dns_zone_edit). -> - -## Go further - -[How to edit an OVHcloud DNS zone](/pages/web_cloud/domains/dns_zone_edit) - -[How to modify the DNS servers of an OVHcloud domain name](/pages/web_cloud/domains/dns_server_edit) - -Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.en-gb.md b/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.en-gb.md index 4733d38f858..4789374d0fe 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.en-gb.md +++ b/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.en-gb.md @@ -1,7 +1,7 @@ --- title: How to configure reverse DNS for your server (PTR record) excerpt: Find out how to set up the reverse DNS resolution for your IP address in the OVHcloud Control Panel -updated: 2025-04-28 +updated: 2025-09-18 --- ## Objective @@ -44,7 +44,7 @@ You can also edit the reverse path directly via the pen icon in the **Reverse DN > - It cannot contain uppercase characters. > - It must end with a `.`. > -> Example: "domain.tld" in the reverse record would be **"domain.tld"**. +> Example: "domain.tld" in the reverse record would be `domain.tld.`. > > [!primary] diff --git a/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.en-ie.md b/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.en-ie.md deleted file mode 100644 index 4733d38f858..00000000000 --- a/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.en-ie.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: How to configure reverse DNS for your server (PTR record) -excerpt: Find out how to set up the reverse DNS resolution for your IP address in the OVHcloud Control Panel -updated: 2025-04-28 ---- - -## Objective - -Reverse DNS (*rDNS*) is the complement to "forward" DNS resolution which resolves domain names into IP addresses. With reverse DNS resolution, an IP address can resolve into the domain name (or host name) it is mapped to. This means that DNS queries of the associated IP address will return this domain name. - -Configuring the reverse DNS resolution for a server is especially useful when sending emails. A mail server's validation by spam protection systems will improve if a DNS lookup of the IP address resolves properly. - -**This guide explains how to configure the reverse DNS path for your IP address in the OVHcloud Control Panel.** - -## Requirements - -- An IP address attached to a service in your OVHcloud account -- A domain name with its `A` record mapped to your service -- Access to the [OVHcloud Control Panel](/links/manager) - -## Instructions - -Log in to the [OVHcloud Control Panel](/links/manager), open the `Network`{.action} menu in the left-hand sidebar and click `Public IP Addresses`{.action}. - -The drop-down menus in the section **My public IP addresses and associated services** allow you to filter the table items for services and find your desired IP address quickly. - -![Reverse DNS](/pages/assets/screens/control_panel/product-selection/bare-metal-cloud/network/filterip.png){.thumbnail} - -Click on `...`{.action} in the row of the IP address concerned and select `Modify the reverse path`{.action}. - -![Reverse DNS](/pages/assets/screens/control_panel/product-selection/bare-metal-cloud/network/modifyreverse.png){.thumbnail} - -In the new window, enter your reverse path and click on `Validate`{.action}. - -![Reverse DNS](/pages/assets/screens/control_panel/product-selection/bare-metal-cloud/network/enterreverse.png){.thumbnail} - -You can also edit the reverse path directly via the pen icon in the **Reverse DNS** column of the table. - -> [!warning] -> When you enter your domain name in the reverse, it double checks immediately if the A record is referring back to the same IP. This is used in anti-spam procedures, so your A record must be valid and propagated. There are certain rules to follow while entering the reverse: -> -> - It cannot start with a `-`. -> - It cannot be longer than 63 characters. -> - It cannot contain uppercase characters. -> - It must end with a `.`. -> -> Example: "domain.tld" in the reverse record would be **"domain.tld"**. -> - -> [!primary] -> -If the modification does not work as expected, verify that the `A` record is correctly configured in the DNS zone of your domain name. Bear in mind that it might take up to 24 hours for DNS zone changes to be effective, in case you have only recently edited the `A` record. -> -If the domain name is managed by OVHcloud as its registrar **and it uses OVHcloud DNS servers**, you can refer to [this guide](/pages/web_cloud/domains/dns_zone_edit). -> - -## Go further - -[How to edit an OVHcloud DNS zone](/pages/web_cloud/domains/dns_zone_edit) - -[How to modify the DNS servers of an OVHcloud domain name](/pages/web_cloud/domains/dns_server_edit) - -Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.en-sg.md b/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.en-sg.md deleted file mode 100644 index 4733d38f858..00000000000 --- a/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.en-sg.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: How to configure reverse DNS for your server (PTR record) -excerpt: Find out how to set up the reverse DNS resolution for your IP address in the OVHcloud Control Panel -updated: 2025-04-28 ---- - -## Objective - -Reverse DNS (*rDNS*) is the complement to "forward" DNS resolution which resolves domain names into IP addresses. With reverse DNS resolution, an IP address can resolve into the domain name (or host name) it is mapped to. This means that DNS queries of the associated IP address will return this domain name. - -Configuring the reverse DNS resolution for a server is especially useful when sending emails. A mail server's validation by spam protection systems will improve if a DNS lookup of the IP address resolves properly. - -**This guide explains how to configure the reverse DNS path for your IP address in the OVHcloud Control Panel.** - -## Requirements - -- An IP address attached to a service in your OVHcloud account -- A domain name with its `A` record mapped to your service -- Access to the [OVHcloud Control Panel](/links/manager) - -## Instructions - -Log in to the [OVHcloud Control Panel](/links/manager), open the `Network`{.action} menu in the left-hand sidebar and click `Public IP Addresses`{.action}. - -The drop-down menus in the section **My public IP addresses and associated services** allow you to filter the table items for services and find your desired IP address quickly. - -![Reverse DNS](/pages/assets/screens/control_panel/product-selection/bare-metal-cloud/network/filterip.png){.thumbnail} - -Click on `...`{.action} in the row of the IP address concerned and select `Modify the reverse path`{.action}. - -![Reverse DNS](/pages/assets/screens/control_panel/product-selection/bare-metal-cloud/network/modifyreverse.png){.thumbnail} - -In the new window, enter your reverse path and click on `Validate`{.action}. - -![Reverse DNS](/pages/assets/screens/control_panel/product-selection/bare-metal-cloud/network/enterreverse.png){.thumbnail} - -You can also edit the reverse path directly via the pen icon in the **Reverse DNS** column of the table. - -> [!warning] -> When you enter your domain name in the reverse, it double checks immediately if the A record is referring back to the same IP. This is used in anti-spam procedures, so your A record must be valid and propagated. There are certain rules to follow while entering the reverse: -> -> - It cannot start with a `-`. -> - It cannot be longer than 63 characters. -> - It cannot contain uppercase characters. -> - It must end with a `.`. -> -> Example: "domain.tld" in the reverse record would be **"domain.tld"**. -> - -> [!primary] -> -If the modification does not work as expected, verify that the `A` record is correctly configured in the DNS zone of your domain name. Bear in mind that it might take up to 24 hours for DNS zone changes to be effective, in case you have only recently edited the `A` record. -> -If the domain name is managed by OVHcloud as its registrar **and it uses OVHcloud DNS servers**, you can refer to [this guide](/pages/web_cloud/domains/dns_zone_edit). -> - -## Go further - -[How to edit an OVHcloud DNS zone](/pages/web_cloud/domains/dns_zone_edit) - -[How to modify the DNS servers of an OVHcloud domain name](/pages/web_cloud/domains/dns_server_edit) - -Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.en-us.md b/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.en-us.md deleted file mode 100644 index 4733d38f858..00000000000 --- a/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.en-us.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: How to configure reverse DNS for your server (PTR record) -excerpt: Find out how to set up the reverse DNS resolution for your IP address in the OVHcloud Control Panel -updated: 2025-04-28 ---- - -## Objective - -Reverse DNS (*rDNS*) is the complement to "forward" DNS resolution which resolves domain names into IP addresses. With reverse DNS resolution, an IP address can resolve into the domain name (or host name) it is mapped to. This means that DNS queries of the associated IP address will return this domain name. - -Configuring the reverse DNS resolution for a server is especially useful when sending emails. A mail server's validation by spam protection systems will improve if a DNS lookup of the IP address resolves properly. - -**This guide explains how to configure the reverse DNS path for your IP address in the OVHcloud Control Panel.** - -## Requirements - -- An IP address attached to a service in your OVHcloud account -- A domain name with its `A` record mapped to your service -- Access to the [OVHcloud Control Panel](/links/manager) - -## Instructions - -Log in to the [OVHcloud Control Panel](/links/manager), open the `Network`{.action} menu in the left-hand sidebar and click `Public IP Addresses`{.action}. - -The drop-down menus in the section **My public IP addresses and associated services** allow you to filter the table items for services and find your desired IP address quickly. - -![Reverse DNS](/pages/assets/screens/control_panel/product-selection/bare-metal-cloud/network/filterip.png){.thumbnail} - -Click on `...`{.action} in the row of the IP address concerned and select `Modify the reverse path`{.action}. - -![Reverse DNS](/pages/assets/screens/control_panel/product-selection/bare-metal-cloud/network/modifyreverse.png){.thumbnail} - -In the new window, enter your reverse path and click on `Validate`{.action}. - -![Reverse DNS](/pages/assets/screens/control_panel/product-selection/bare-metal-cloud/network/enterreverse.png){.thumbnail} - -You can also edit the reverse path directly via the pen icon in the **Reverse DNS** column of the table. - -> [!warning] -> When you enter your domain name in the reverse, it double checks immediately if the A record is referring back to the same IP. This is used in anti-spam procedures, so your A record must be valid and propagated. There are certain rules to follow while entering the reverse: -> -> - It cannot start with a `-`. -> - It cannot be longer than 63 characters. -> - It cannot contain uppercase characters. -> - It must end with a `.`. -> -> Example: "domain.tld" in the reverse record would be **"domain.tld"**. -> - -> [!primary] -> -If the modification does not work as expected, verify that the `A` record is correctly configured in the DNS zone of your domain name. Bear in mind that it might take up to 24 hours for DNS zone changes to be effective, in case you have only recently edited the `A` record. -> -If the domain name is managed by OVHcloud as its registrar **and it uses OVHcloud DNS servers**, you can refer to [this guide](/pages/web_cloud/domains/dns_zone_edit). -> - -## Go further - -[How to edit an OVHcloud DNS zone](/pages/web_cloud/domains/dns_zone_edit) - -[How to modify the DNS servers of an OVHcloud domain name](/pages/web_cloud/domains/dns_server_edit) - -Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.es-es.md b/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.es-es.md index 210793536cc..26fc239c7fe 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.es-es.md +++ b/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.es-es.md @@ -1,13 +1,9 @@ --- title: "Cómo configurar el registro DNS inverso de su servidor (registro PTR)" excerpt: Cómo implementar la resolución inversa DNS de su dirección IP desde el área de cliente de OVHcloud -updated: 2025-04-28 +updated: 2025-09-18 --- -> [!primary] -> Esta traducción ha sido generada de forma automática por nuestro partner SYSTRAN. En algunos casos puede contener términos imprecisos, como en las etiquetas de los botones o los detalles técnicos. En caso de duda, le recomendamos que consulte la versión inglesa o francesa de la guía. Si quiere ayudarnos a mejorar esta traducción, por favor, utilice el botón «Contribuir» de esta página. -> - ## Objetivo El registro inverso (*rDNS*) es el complemento de la resolución DNS "*forward*" que permite resolver los nombres de dominio en direcciones IP. Con el registro DNS inverso, una dirección IP puede resolverse en el nombre de dominio (o nombre de host) al que está conectada. Esto significa que las consultas DNS de la dirección IP asociada devolverán este nombre de dominio. @@ -48,7 +44,7 @@ También puede editar el registro inverso directamente a través del icono con f > - el registro inverso no puede contener caracteres en mayúscula. > - el registro inverso debe terminar en un `.` > -> Por ejemplo: "MyDomain.ca" en el registro inverso sería **mydomain.ca.** +> Por ejemplo: "domain.tld" en el registro inverso sería `domain.tld.`. > > [!primary] diff --git a/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.es-us.md b/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.es-us.md deleted file mode 100644 index 9a60a9d2802..00000000000 --- a/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.es-us.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: "Cómo configurar el registro DNS inverso de su servidor (registro PTR)" -excerpt: Cómo implementar la resolución inversa DNS de su dirección IP desde el área de cliente de OVHcloud -updated: 2025-04-28 ---- - -> [!primary] -> Esta traducción ha sido generada de forma automática por nuestro partner SYSTRAN. En algunos casos puede contener términos imprecisos, como en las etiquetas de los botones o los detalles técnicos. En caso de duda, le recomendamos que consulte la versión inglesa o francesa de la guía. Si quiere ayudarnos a mejorar esta traducción, por favor, utilice el botón «Contribuir» de esta página. -> - -## Objetivo - -El registro inverso (*rDNS*) es el complemento de la resolución DNS "*forward*" que permite resolver los nombres de dominio en direcciones IP. Con el registro DNS inverso, una dirección IP puede resolverse en el nombre de dominio (o nombre de host) al que está conectada. Esto significa que las consultas DNS de la dirección IP asociada devolverán este nombre de dominio. - -La configuración del registro DNS inverso de un servidor es especialmente útil cuando se envían mensajes de correo. La validación de un servidor de correo por los sistemas de protección antispam mejora si una petición DNS de la dirección IP se resuelve correctamente. - -Esta guía explica cómo configurar el registro DNS inverso de su dirección IP desde el área de cliente.** - -## Requisitos - -- Una dirección IP asociada a un servicio de su cuenta de OVHcloud -- Un dominio con su registro `A` asociado a su servicio -- Estar conectado a su [área de cliente de OVHcloud](/links/manager) - -## Procedimiento - -Conéctese a su [área de cliente de OVHcloud](/links/manager), haga clic en `Network`{.action} en el menú situado a la izquierda de la pantalla y seleccione `Direcciones IP públicas`{.action}. - -Los menús desplegables de la sección **Mis direcciones IP públicas y servicios asociados** le permiten filtrar los elementos de la tabla para los servicios y encontrar rápidamente la dirección IP deseada. - -![Reverse DNS](/pages/assets/screens/control_panel/product-selection/bare-metal-cloud/network/filterip.png){.thumbnail} - -Haga clic en `...`{.action} en la línea de la dirección IP correspondiente y seleccione `Modificar el registro inverso`{.action}. - -![Reverse DNS](/pages/assets/screens/control_panel/product-selection/bare-metal-cloud/network/modifyreverse.png){.thumbnail} - -En la nueva ventana, introduzca el registro inverso y haga clic en `Aceptar`{.action}. - -![Reverse DNS](/pages/assets/screens/control_panel/product-selection/bare-metal-cloud/network/enterreverse.png){.thumbnail} - -También puede editar el registro inverso directamente a través del icono con forma de pluma de la columna **registro inverso** de la tabla. - -> [!warning] -> Al introducir su dominio en el registro inverso, comprueba de inmediato si el registro A devuelve la misma IP. Se utiliza en los procedimientos antispam, por lo que el registro A debe ser válido y propagado. Existen algunas reglas a seguir al introducir el registro inverso: -> -> - el registro inverso no puede empezar por un `-` -> - el registro inverso no puede tener más de 63 caracteres. -> - el registro inverso no puede contener caracteres en mayúscula. -> - el registro inverso debe terminar en un `.` -> -> Por ejemplo: "MyDomain.ca" en el registro inverso sería **mydomain.ca.** -> - -> [!primary] -> -> Si el cambio no funciona según lo previsto, compruebe que el registro A esté correctamente configurado en la zona DNS del dominio. La aplicación de los cambios en la zona DNS puede tardar hasta 24 horas en caso de que acabe de modificar el registro `A`. -> -> Si el dominio está gestionado por OVHcloud como agente registrador **y utiliza los servidores DNS de OVHcloud**, consulte la guía [esta guía](/pages/web_cloud/domains/dns_zone_edit). -> - -## Más información - -[Editar una zona DNS de OVHcloud](/pages/web_cloud/domains/dns_zone_edit) - -[Modificar los servidores DNS de un dominio de OVHcloud](/pages/web_cloud/domains/dns_server_edit) - -Interactúe con nuestra [comunidad de usuarios](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.fr-ca.md b/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.fr-ca.md deleted file mode 100644 index bbcd7fffa2f..00000000000 --- a/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.fr-ca.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: "Comment configurer le reverse DNS de votre serveur (enregistrement PTR)" -excerpt: Découvrez comment mettre en place la résolution reverse DNS de votre adresse IP depuis votre espace client -updated: 2025-04-28 ---- - -## Objectif - -Le Reverse DNS (*rDNS*) est le complément de la résolution DNS « *forward* » qui permet de résoudre les noms de domaine en adresses IP. Grâce au reverse DNS, une adresse IP peut être résolue en nom de domaine (ou nom d’hôte) auquel elle est reliée. Cela signifie que les requêtes DNS de l'adresse IP associée retourneront ce nom de domaine. - -La configuration du reverse DNS d'un serveur est particulièrement utile lors de l'envoi d'e-mails. La validation d'un serveur e-mail par les systèmes de protection antispam s'améliore si une requête DNS de l'adresse IP se résout correctement. - -**Ce guide vous explique comment configurer le reverse DNS de votre adresse IP depuis votre espace client.** - -## Prérequis - -- Une adresse IP attachée à un service de votre compte OVHcloud -- Un nom de domaine avec son enregistrement `A` relié à votre service -- Être connecté à votre [espace client OVHcloud](/links/manager) - -## En pratique - -Connectez-vous à votre [espace client OVHcloud](/links/manager), cliquez sur `Network`{.action} dans le menu situé à gauche de l'écran, puis sur `Adresses IP Publiques`{.action}. - -Les menus déroulants de la section **Mes adresses IP publiques et services associés** vous permettent de filtrer les éléments du tableau pour les services et de trouver rapidement l’adresse IP souhaitée. - -![Reverse DNS](/pages/assets/screens/control_panel/product-selection/bare-metal-cloud/network/filterip.png){.thumbnail} - -Cliquez sur `...`{.action} dans la ligne de l'adresse IP concernée et sélectionnez `Modifier le reverse`{.action}. - -![Reverse DNS](/pages/assets/screens/control_panel/product-selection/bare-metal-cloud/network/modifyreverse.png){.thumbnail} - -Dans la nouvelle fenêtre, renseignez votre reverse et cliquez sur `Valider`{.action}. - -![Reverse DNS](/pages/assets/screens/control_panel/product-selection/bare-metal-cloud/network/enterreverse.png){.thumbnail} - -Vous pouvez également éditer le reverse directement via l'icône en forme de plume dans la colonne **Reverse DNS** du tableau. - -> [!warning] -> Lorsque vous entrez votre nom de domaine dans le *reverse*, il vérifie immédiatement si l'enregistrement A renvoie à la même IP. Ceci est utilisé dans les procédures anti-spam, donc votre enregistrement A doit être valide et propagé. Il y a certaines règles à suivre lors de la saisie du *reverse* : -> -> - le *reverse* ne peut pas commencer par un `-` -> - le *reverse* ne peut pas comporter plus de 63 caractères -> - le *reverse* ne peut pas contenir de caractères majuscules -> - le *reverse* doit se terminer par un `.` -> -> Exemple : « mydomain.ca » dans l'enregistrement *reverse* serait **mydomain.ca.** -> - -> [!primary] -> -> Si la modification ne fonctionne pas comme prévu, vérifiez que l'enregistrement « A » est correctement configuré dans la zone DNS de votre nom de domaine. L'application des changements dans la zone DNS peut prendre jusqu'à 24 heures, dans le cas où vous venez de modifier l'enregistrement « A ». -> -> Si le nom de domaine est géré par OVHcloud en tant que bureau d’enregistrement **et qu’il utilise les serveurs DNS OVHcloud**, vous pouvez vous référer à [ce guide](/pages/web_cloud/domains/dns_zone_edit). -> - -## Aller plus loin - -[Éditer une zone DNS OVHcloud](/pages/web_cloud/domains/dns_zone_edit) - -[Modifier les serveurs DNS d'un nom de domaine OVHcloud](/pages/web_cloud/domains/dns_server_edit) - -Échangez avec notre [communauté d'utilisateurs](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.fr-fr.md b/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.fr-fr.md index bbcd7fffa2f..2c979dedb52 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.fr-fr.md +++ b/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.fr-fr.md @@ -1,7 +1,7 @@ --- title: "Comment configurer le reverse DNS de votre serveur (enregistrement PTR)" excerpt: Découvrez comment mettre en place la résolution reverse DNS de votre adresse IP depuis votre espace client -updated: 2025-04-28 +updated: 2025-09-18 --- ## Objectif @@ -44,7 +44,7 @@ Vous pouvez également éditer le reverse directement via l'icône en forme de p > - le *reverse* ne peut pas contenir de caractères majuscules > - le *reverse* doit se terminer par un `.` > -> Exemple : « mydomain.ca » dans l'enregistrement *reverse* serait **mydomain.ca.** +> Exemple : « domain.tld » dans l'enregistrement *reverse* serait `domain.tld.`. > > [!primary] diff --git a/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.it-it.md b/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.it-it.md index f657055fb3f..7ee19faafcc 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.it-it.md +++ b/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.it-it.md @@ -1,13 +1,9 @@ --- title: "Come configurare il reverse DNS del tuo server (record PTR)" excerpt: Copri come impostare la risoluzione reverse DNS del tuo indirizzo IP dal tuo Spazio Cliente OVHcloud -updated: 2025-04-28 +updated: 2025-09-18 --- -> [!primary] -> Questa traduzione è stata generata automaticamente dal nostro partner SYSTRAN. I contenuti potrebbero presentare imprecisioni, ad esempio la nomenclatura dei pulsanti o alcuni dettagli tecnici. In caso di dubbi consigliamo di fare riferimento alla versione inglese o francese della guida. Per aiutarci a migliorare questa traduzione, utilizza il pulsante "Contribuisci" di questa pagina. -> - ## Obiettivo Il Reverse DNS (*rDNS*) è il complemento della risoluzione DNS "*forward*" che permette di risolvere i nomi di dominio in indirizzi IP. Grazie al reverse DNS, un indirizzo IP può essere risolto in nome di dominio (o nome host) a cui è associato. Questo significa che le richieste DNS dell'indirizzo IP associato restituiranno questo nome di dominio. @@ -48,7 +44,7 @@ Nella nuova finestra, inserisci il reverse e clicca su `Conferma`{.action}. > - il reverse non può contenere caratteri maiuscoli > - il reverse deve terminare con un `.` > -> Esempio: "MyDomain.ca" nel campo reverse sarebbe **mydomain.ca.** +> Esempio: "domain.tld" nel campo reverse sarebbe `domain.tld.`. > > [!primary] diff --git a/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.pl-pl.md b/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.pl-pl.md index 890e407e152..7475ad4c230 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.pl-pl.md +++ b/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.pl-pl.md @@ -1,13 +1,9 @@ --- title: "Jak skonfigurować rewers DNS Twojego serwera (rekord PTR)" excerpt: Dowiedz się, jak skonfigurować rewers DNS dla adresu IP z poziomu Panelu klienta OVHcloud -updated: 2025-04-28 +updated: 2025-09-18 --- -> [!primary] -> Tłumaczenie zostało wygenerowane automatycznie przez system naszego partnera SYSTRAN. W niektórych przypadkach mogą wystąpić nieprecyzyjne sformułowania, na przykład w tłumaczeniu nazw przycisków lub szczegółów technicznych. W przypadku jakichkolwiek wątpliwości zalecamy zapoznanie się z angielską/francuską wersją przewodnika. Jeśli chcesz przyczynić się do ulepszenia tłumaczenia, kliknij przycisk "Zgłóś propozycję modyfikacji" na tej stronie. -> - ## Wprowadzenie Rewers DNS (*rDNS*) jest uzupełnieniem rozpoznawania DNS "*forward*", który pozwala na rozpoznawanie nazw domen na adresy IP. Dzięki rewersowi DNS adres IP może zostać rozpoznany jako domena (lub nazwa hosta), z którą jest powiązany. Oznacza to, że zapytania DNS skojarzonego adresu IP zwrócą tę domenę. @@ -48,7 +44,7 @@ Możesz również edytować rewers bezpośrednio za pomocą ikony pióra w kolum > - rewers nie może zawierać wielkich liter > - rewers musi się kończyć znakiem `.` > -> Przykład: "MyDomain.ca" w polu rewers byłoby **mydomain.ca.** +> Przykład: "domain.tld" w polu rewers byłoby `domain.tld.`. > > [!primary] diff --git a/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.pt-pt.md b/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.pt-pt.md index a2b3bcf8bb9..8dfc9ee2125 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.pt-pt.md +++ b/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/guide.pt-pt.md @@ -1,13 +1,9 @@ --- title: "Como configurar a reverse DNS do seu servidor (registo PTR)" excerpt: Descubra como configurar a resolução reverse DNS do seu endereço IP a partir da Área de Cliente OVHcloud -updated: 2025-04-28 +updated: 2025-09-18 --- -> [!primary] -> Esta tradução foi automaticamente gerada pelo nosso parceiro SYSTRAN. Em certos casos, poderão ocorrer formulações imprecisas, como por exemplo nomes de botões ou detalhes técnicos. Recomendamos que consulte a versão inglesa ou francesa do manual, caso tenha alguma dúvida. Se nos quiser ajudar a melhorar esta tradução, clique em "Contribuir" nesta página. -> - ## Objetivo O Reverse DNS (*rDNS*) é o complemento da resolução DNS « *forward* » que permite resolver os nomes de domínio em endereços IP. Graças à reverse DNS, um endereço IP pode ser resolvido com um nome de domínio (ou nome de host) ao qual está associado. Isto significa que os pedidos DNS do endereço IP associado retornarão este domínio. @@ -48,7 +44,7 @@ Pode igualmente editar a reverse diretamente a partir do ícone em forma de cane > - a reverse não pode conter caracteres maiúsculos > - a reverse deve terminar com um `.` > -> Por exemplo: "MyDomain.ca" no registo reverse seria **mydomain.ca.** +> Por exemplo: "domain.tld" no registo reverse seria `domain.tld.`. > > [!primary] diff --git a/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/meta.yaml b/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/meta.yaml index 51671fb23a8..23138d2ce5f 100755 --- a/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/meta.yaml +++ b/pages/bare_metal_cloud/virtual_private_servers/configuring-reverse-dns/meta.yaml @@ -1,3 +1,4 @@ id: a78e6a05-c8d7-4820-8b84-624fdb21fb78 full_slug: vps-configure-reverse-dns -reference_category: bare-metal-cloud-virtual-private-servers-network-and-ip-management \ No newline at end of file +reference_category: bare-metal-cloud-virtual-private-servers-configuration-network-and-ip-management +translation_banner: true \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/cpanel/images/cpanel_order.png b/pages/bare_metal_cloud/virtual_private_servers/cpanel/images/cpanel_order.png deleted file mode 100644 index 869355d4031..00000000000 Binary files a/pages/bare_metal_cloud/virtual_private_servers/cpanel/images/cpanel_order.png and /dev/null differ diff --git a/pages/bare_metal_cloud/virtual_private_servers/eos-cpanel-plesk/guide.de-de.md b/pages/bare_metal_cloud/virtual_private_servers/eos-cpanel-plesk/guide.de-de.md index 427026dd048..d0427076862 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/eos-cpanel-plesk/guide.de-de.md +++ b/pages/bare_metal_cloud/virtual_private_servers/eos-cpanel-plesk/guide.de-de.md @@ -1,7 +1,7 @@ --- title: "Plesk und cPanel: End of Support für VPS - Gewährleistung der Kontinuität Ihrer Dienste" excerpt: "Erfahren Sie, ab wann die Plesk- und cPanel-Betriebssysteme Ihres OVHcloud VPS nicht mehr unterstützt werden" -updated: 2025-07-22 +updated: 2025-09-29 --- ## Ziel @@ -20,10 +20,10 @@ Die Herausgeber von **Plesk** und **cPanel** kündigen das Ende der Unterstützu | Betriebssystem | Produkt | Ende des Supports | | -------------- | ------------ | ------------------ | -| Ubuntu 18.04 | Plesk | **1. Januar 2026** | -| Debian 10 | Plesk | **1. Januar 2026** | -| CentOS 7 | Plesk/cPanel | **1. Januar 2026** | -| CloudLinux 7 | Plesk/cPanel | **1. Januar 2026** | +| Ubuntu 18.04 | Plesk | **1. Januar 2027** | +| Debian 10 | Plesk | **1. Januar 2027** | +| CentOS 7 | Plesk/cPanel | **1. Januar 2027** | +| CloudLinux 7 | Plesk/cPanel | **1. Januar 2027** | Weitere Informationen zum Support finden Sie in der offiziellen Dokumentation: @@ -87,7 +87,13 @@ Wenn Sie keinen neuen VPS bereitstellen können, können Sie bestimmte Tools ver > [!primary] > -> Für diese Tools wird keine Garantie übernommen und sollten nicht ohne vorherige vollständige genutzt werden. Stellen Sie außerdem sicher, dass Ihr VPS über ausreichende Ressourcen verfügt (RAM, CPU, Storage). +> Für diese Tools wird keine Garantie übernommen und sie sollten nicht ohne vorheriges Erzeugen von Backups genutzt werden. Stellen Sie außerdem sicher, dass Ihr VPS über ausreichende Ressourcen verfügt (RAM, CPU, Storage). + +### Best Practices Sicherheit + +Unabhängig von Plesk/cPanel ist es wichtig, das Betriebssystem Ihres VPS auf dem neuesten Stand zu halten, um Sicherheitsupdates, Softwarekompatibilität und Herstellersupport zu erhalten. Wenn Ihre Distribution **End-of-Life (EOL)** ist, planen Sie eine **Aktualisierung** oder eine **Migration** auf eine weiterhin unterstützte Version. + +Um die Terminierung von End-of-Life und End-of-Support für Images und Betriebssysteme (VPS & Public Cloud) zu erfahren, konsultieren Sie: "[Public Cloud & VPS - Lebenszyklus und End-of-Life-/Support für Images und Distributionen](/pages/public_cloud/compute/image-life-cycle)". ## Weiterführende Informationen diff --git a/pages/bare_metal_cloud/virtual_private_servers/eos-cpanel-plesk/guide.en-gb.md b/pages/bare_metal_cloud/virtual_private_servers/eos-cpanel-plesk/guide.en-gb.md index 4746787d14a..87f033ee152 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/eos-cpanel-plesk/guide.en-gb.md +++ b/pages/bare_metal_cloud/virtual_private_servers/eos-cpanel-plesk/guide.en-gb.md @@ -1,7 +1,7 @@ --- title: "End of Plesk and cPanel support for VPS - Ensuring continuity of your services" excerpt: "Find out the end-of-support dates for the operating systems on your OVHcloud VPS that affect Plesk and cPanel licenses" -updated: 2025-07-22 +updated: 2025-09-29 --- ## Objective @@ -20,10 +20,10 @@ The **Plesk** and **cPanel** publishers announce the end of support for the foll | Operating system | Product | End of Support | | ---------------- | ------------ | -------------------- | -| Ubuntu 18.04 | Plesk | **1st January 2026** | -| Debian 10 | Plesk | **1st January 2026** | -| CentOS 7 | Plesk/cPanel | **1st January 2026** | -| CloudLinux 7 | Plesk/cPanel | **1st January 2026** | +| Ubuntu 18.04 | Plesk | **1st January 2027** | +| Debian 10 | Plesk | **1st January 2027** | +| CentOS 7 | Plesk/cPanel | **1st January 2027** | +| CloudLinux 7 | Plesk/cPanel | **1st January 2027** | For more details on support purposes, please refer to the official documentation: @@ -89,6 +89,12 @@ If you cannot deploy a new VPS, you can use certain tools to **upgrade your oper > > These tools are not 100% guaranteed and require full backups before proceeding. Also make sure that your VPS has sufficient resources (RAM, CPU, disk). +### Security Best Practices + +Regardless of Plesk/cPanel, it is essential to **keep your VPS operating system up to date** to benefit from security patches, software compatibility, and vendor support. If your distribution is **end of life (EOL)**, plan an **upgrade** or **migration** to a still-supported version. + +To find out the end-of-life and end-of-support dates for images and operating systems (VPS & Public Cloud), refer to our guide [Public Cloud & VPS - Lifecycle and End-of-Life/Support Announcements for Images and Distributions](/pages/public_cloud/compute/image-life-cycle). + ## Go further For specialized services (SEO, development, etc.), contact the [OVHcloud partners](/links/partner). diff --git a/pages/bare_metal_cloud/virtual_private_servers/eos-cpanel-plesk/guide.es-es.md b/pages/bare_metal_cloud/virtual_private_servers/eos-cpanel-plesk/guide.es-es.md index 486cbfc0a9c..82fa4d45a9a 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/eos-cpanel-plesk/guide.es-es.md +++ b/pages/bare_metal_cloud/virtual_private_servers/eos-cpanel-plesk/guide.es-es.md @@ -1,7 +1,7 @@ --- title: "Fin del soporte Plesk y cPanel para VPS - Garantizar la continuidad de sus servicios" excerpt: "Descubra las fechas de finalización del soporte de los sistemas operativos de su VPS OVHcloud que afectan a las licencias Plesk y cPanel" -updated: 2025-07-22 +updated: 2025-09-29 --- ## Objetivo @@ -20,10 +20,10 @@ Los editores **Plesk** y **cPanel** anuncian el fin del soporte para los siguien | Sistema operativo | Producto | Fin del soporte | | ----------------- | -------------- | ---------------------- | -| Ubuntu 18.04 | Plesk | **1 de enero de 2026** | -| Debian 10 | Plesk | **1 de enero de 2026** | -| CentOS 7 | Plesk / cPanel | **1 de enero de 2026** | -| CloudLinux 7 | Plesk / cPanel | **1 de enero de 2026** | +| Ubuntu 18.04 | Plesk | **1 de enero de 2027** | +| Debian 10 | Plesk | **1 de enero de 2027** | +| CentOS 7 | Plesk / cPanel | **1 de enero de 2027** | +| CloudLinux 7 | Plesk / cPanel | **1 de enero de 2027** | Para obtener más información sobre los fines de soporte técnico, consulte la documentación oficial: @@ -89,6 +89,12 @@ Si no puede desplegar un nuevo VPS, algunas herramientas permiten **actualizar d > > Estas herramientas no están garantizadas al 100% y requieren copias de seguridad completas antes de proceder. Asimismo, asegúrese de que su VPS dispone de recursos suficientes (RAM, CPU y disco). +### Buenas prácticas de seguridad + +Independientemente de Plesk/cPanel, es esencial **mantener el sistema operativo de su VPS actualizado** para beneficiarse de los parches de seguridad, la compatibilidad del software y el soporte del editor. Si su distribución está en **fin de vida (EOL)**, planifique una **actualización** o una **migración** a una versión aún soportada. + +Para conocer las fechas de fin de vida y de fin de soporte de las imágenes y los sistemas operativos (VPS & Public Cloud), consulte nuestro guía "[Public Cloud & VPS - Ciclo de vida y anuncios de fin de vida y soporte de imágenes y distribuciones](/pages/public_cloud/compute/image-life-cycle)". + ## Más información Para servicios especializados (posicionamiento, desarrollo, etc.), contacte con [partners de OVHcloud](/links/partner). diff --git a/pages/bare_metal_cloud/virtual_private_servers/eos-cpanel-plesk/guide.fr-fr.md b/pages/bare_metal_cloud/virtual_private_servers/eos-cpanel-plesk/guide.fr-fr.md index dc6a88d876c..43b7993728c 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/eos-cpanel-plesk/guide.fr-fr.md +++ b/pages/bare_metal_cloud/virtual_private_servers/eos-cpanel-plesk/guide.fr-fr.md @@ -1,7 +1,7 @@ --- title: "Fin du support Plesk et cPanel pour VPS - Assurer la continuité de vos services" excerpt: "Découvrez les dates de fin de support des systèmes d'exploitation de votre VPS OVHcloud affectant les licences Plesk et cPanel" -updated: 2025-07-22 +updated: 2025-09-29 --- ## Objectif @@ -20,10 +20,10 @@ Les éditeurs **Plesk** et **cPanel** annoncent la fin du support des systèmes | Système d'exploitation | Produit | Fin du support | | ---------------------- | -------------- | -------------------- | -| Ubuntu 18.04 | Plesk | **1er janvier 2026** | -| Debian 10 | Plesk | **1er janvier 2026** | -| CentOS 7 | Plesk / cPanel | **1er janvier 2026** | -| CloudLinux 7 | Plesk / cPanel | **1er janvier 2026** | +| Ubuntu 18.04 | Plesk | **1er janvier 2027** | +| Debian 10 | Plesk | **1er janvier 2027** | +| CentOS 7 | Plesk / cPanel | **1er janvier 2027** | +| CloudLinux 7 | Plesk / cPanel | **1er janvier 2027** | Pour plus de détails concernant les fins de support, consultez les documentations officielles : @@ -89,6 +89,12 @@ Si vous ne pouvez pas déployer un nouveau de VPS, certains outils permettent de > > Ces outils ne sont pas garantis à 100 % et nécessitent des sauvegardes complètes avant de procéder. Assurez-vous également que votre VPS dispose de ressources suffisantes (RAM, CPU, disque). +### Bonnes pratiques de sécurité + +Indépendamment de Plesk/cPanel, il est essentiel de **maintenir le système d’exploitation de votre VPS** à jour afin de bénéficier des correctifs de sécurité, de la compatibilité logicielle et du support éditeur. Si votre distribution est en **fin de vie (EOL)**, planifiez une **mise à niveau** ou une **migration** vers une version encore supportée. + +Pour connaître les dates de fin de vie et de fin de support des images et des OS (VPS & Public Cloud), consultez notre guide « [Public Cloud & VPS - Cycle de vie et annonces de fin de vie/support des images et distributions](/pages/public_cloud/compute/image-life-cycle) ». + ## Aller plus loin Pour des prestations spécialisées (référencement, développement, etc.), contactez les [partenaires OVHcloud](/links/partner). diff --git a/pages/bare_metal_cloud/virtual_private_servers/eos-cpanel-plesk/guide.it-it.md b/pages/bare_metal_cloud/virtual_private_servers/eos-cpanel-plesk/guide.it-it.md index fb23c743d24..62cdb55a05d 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/eos-cpanel-plesk/guide.it-it.md +++ b/pages/bare_metal_cloud/virtual_private_servers/eos-cpanel-plesk/guide.it-it.md @@ -1,7 +1,7 @@ --- title: "Fine del supporto Plesk e cPanel per VPS - Garantire la continuità dei servizi" excerpt: "Scopri le date di fine del supporto dei sistemi operativi del tuo VPS OVHcloud che interessano le licenze Plesk e cPanel" -updated: 2025-07-22 +updated: 2025-09-29 --- ## Obiettivo @@ -20,10 +20,10 @@ I software **Plesk** e **cPanel** annunciano la fine del supporto per i seguenti | Sistema operativo | Prodotto | Fine del support | | ----------------- | -------------- | ------------------ | -| Ubuntu 18.04 | Plesk | **1 gennaio 2026** | -| Debian 10 | Plesk | **1 gennaio 2026** | -| CentOS 7 | Plesk / cPanel | **1 gennaio 2026** | -| CloudLinux 7 | Plesk / cPanel | **1 gennaio 2026** | +| Ubuntu 18.04 | Plesk | **1 gennaio 2027** | +| Debian 10 | Plesk | **1 gennaio 2027** | +| CentOS 7 | Plesk / cPanel | **1 gennaio 2027** | +| CloudLinux 7 | Plesk / cPanel | **1 gennaio 2027** | Per ulteriori informazioni sul supporto, consultare la documentazione ufficiale: @@ -89,6 +89,12 @@ Se non riesci a creare un nuovo VPS, è possibile utilizzare alcuni strumenti pe > > Questi strumenti non sono garantiti al 100% e richiedono backup completi prima di procedere. Assicurati che il tuo VPS disponga di risorse sufficienti (RAM, CPU, disco). +### Buone pratiche di sicurezza + +Indipendentemente da Plesk/cPanel, è essenziale **mantenere aggiornato il sistema operativo del VPS** per beneficiare degli aggiornamenti di sicurezza, della compatibilità software e del supporto del produttore. Se la tua distribuzione è in **fine vita (EOL)**, pianifica un **aggiornamento** o una **migrazione** verso una versione ancora supportata. + +Per conoscere le date di fine vita e di fine supporto delle immagini e dei sistemi operativi (VPS & Public Cloud), consulta la nostra guida "[Public Cloud & VPS - Ciclo di vita e annunci di fine vita e supporto per immagini e distribuzioni](/pages/public_cloud/compute/image-life-cycle)". + ## Per saperne di più Per prestazioni specializzate (referenziamento, sviluppo, ecc.), contatta i [partner OVHcloud](/links/partner). diff --git a/pages/bare_metal_cloud/virtual_private_servers/eos-cpanel-plesk/guide.pl-pl.md b/pages/bare_metal_cloud/virtual_private_servers/eos-cpanel-plesk/guide.pl-pl.md index 0ea6bab53f9..f41bd1fe2b8 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/eos-cpanel-plesk/guide.pl-pl.md +++ b/pages/bare_metal_cloud/virtual_private_servers/eos-cpanel-plesk/guide.pl-pl.md @@ -1,7 +1,7 @@ --- title: "Zakończenie wsparcia Plesk i cPanel dla serwerów VPS - Jak zapewnić ciągłość działania usług" excerpt: "Dowiesz się, kiedy dobiega końca okres wsparcia dla systemów operacyjnych na VPS OVHcloud, które mają wpływ na licencje Plesk i cPanel" -updated: 2025-07-22 +updated: 2025-09-29 --- ## Cel @@ -20,10 +20,10 @@ Producenci **Plesk** i **cPanel** ogłaszają zakończenie wsparcia dla następu | System operacyjny | Produkt | Fin del Soporte | | ----------------- | -------------- | ------------------- | -| Ubuntu 18.04 | Plesk | **stycznia 2026 r** | -| Debian 10 | Plesk | **stycznia 2026 r** | -| CentOS 7 | Plesk / cPanel | **stycznia 2026 r** | -| CloudLinux 7 | Plesk / cPanel | **stycznia 2026 r** | +| Ubuntu 18.04 | Plesk | **stycznia 2027 r** | +| Debian 10 | Plesk | **stycznia 2027 r** | +| CentOS 7 | Plesk / cPanel | **stycznia 2027 r** | +| CloudLinux 7 | Plesk / cPanel | **stycznia 2027 r** | Więcej informacji na temat pomocy znajdziesz w oficjalnej dokumentacji: @@ -89,6 +89,12 @@ Jeśli nie możesz uruchomić nowego VPS, skorzystaj z narzędzi, dzięki który > > Narzędzia te nie są w 100% gwarantowane i wymagają pełnej kopii zapasowej przed kontynuowaniem. upewnij się również, że Twój VPS ma wystarczającą ilość zasobów (RAM, CPU, dysk). +### Dobre praktyki bezpieczeństwa + +Niezależnie od Plesk/cPanel, ważne jest **utrzymanie systemu operacyjnego VPS na aktualnym poziomie**, aby skorzystać z poprawek bezpieczeństwa, kompatybilności oprogramowania i wsparcia producenta. Jeśli Twoja dystrybucja jest w **fazie końca wsparcia (EOL)**, zaplanuj **aktualizację** lub **migrację** na wersję nadal obsługiwana. + +Aby poznać daty końca życia i końca wsparcia dla obrazów i systemów operacyjnych (VPS & Public Cloud), skorzystaj z naszego przewodnika "[Public Cloud & VPS - Cykl życia i ogłoszenia o końcu wsparcia oraz życia dla obrazów i dystrybucji](/pages/public_cloud/compute/image-life-cycle)". + ## Sprawdź również W przypadku wyspecjalizowanych usług (pozycjonowanie, rozwój, itp.) skontaktuj się z [partnerami OVHcloud](/links/partner). diff --git a/pages/bare_metal_cloud/virtual_private_servers/eos-cpanel-plesk/guide.pt-pt.md b/pages/bare_metal_cloud/virtual_private_servers/eos-cpanel-plesk/guide.pt-pt.md index 35eb93753c6..befc4f82075 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/eos-cpanel-plesk/guide.pt-pt.md +++ b/pages/bare_metal_cloud/virtual_private_servers/eos-cpanel-plesk/guide.pt-pt.md @@ -1,7 +1,7 @@ --- title: "Fim do suporte Plesk e cPanel para VPS - Assegurar a continuidade dos seus serviços" excerpt: "Descubra as datas de fim do suporte dos sistemas operativos do seu VPS OVHcloud que afetam as licenças Plesk e cPanel" -updated: 2025-07-22 +updated: 2025-09-29 --- ## Objetivo @@ -20,10 +20,10 @@ Os editores **Plesk** e **cPanel** anunciam o fim do suporte para os seguintes s | Sistema operativo | Produto | Fim do suporte | | ----------------- | -------------- | ------------------------ | -| Ubuntu 18.04 | Plesk | **1 de janeiro de 2026** | -| Debian 10 | Plesk | **1 de janeiro de 2026** | -| CentOS 7 | Plesk / cPanel | **1 de janeiro de 2026** | -| CloudLinux 7 | Plesk / cPanel | **1 de janeiro de 2026** | +| Ubuntu 18.04 | Plesk | **1 de janeiro de 2027** | +| Debian 10 | Plesk | **1 de janeiro de 2027** | +| CentOS 7 | Plesk / cPanel | **1 de janeiro de 2027** | +| CloudLinux 7 | Plesk / cPanel | **1 de janeiro de 2027** | Para obter mais informações de apoio, consulte a documentação oficial: @@ -89,6 +89,12 @@ Se não conseguir implementar um novo servidor VPS, algumas ferramentas permitem > > Estas ferramentas não têm uma garantia de 100% e necessitam de backups completos antes de serem utilizadas. Certifique-se igualmente de que o seu VPS dispõe de recursos suficientes (RAM, CPU, disco). +### Boas práticas de segurança + +Independentemente do Plesk/cPanel, é essencial **manter o sistema operacional do seu VPS atualizado** para beneficiar-se dos patches de segurança, compatibilidade de software e suporte do editor. Se a sua distribuição estiver em **fim de vida (EOL)**, planeje uma **atualização** ou uma **migração** para uma versão ainda suportada. + +Para conhecer as datas de fim de vida e de fim de suporte das imagens e dos sistemas operacionais (VPS & Public Cloud), consulte nosso guia "[Public Cloud & VPS - Ciclo de vida e anúncios de fim de vida e suporte para imagens e distribuições](/pages/public_cloud/compute/image-life-cycle)". + ## Quer saber mais? Para serviços especializados (referenciamento, desenvolvimento, etc.), contacte os [parceiros OVHcloud](/links/partner). diff --git a/pages/bare_metal_cloud/virtual_private_servers/import-export-n8n/guide.en-gb.md b/pages/bare_metal_cloud/virtual_private_servers/import-export-n8n/guide.en-gb.md index 51d529af879..42d93c0698a 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/import-export-n8n/guide.en-gb.md +++ b/pages/bare_metal_cloud/virtual_private_servers/import-export-n8n/guide.en-gb.md @@ -1,7 +1,7 @@ --- title: "How to migrate an n8n configuration between two VPS" excerpt: "Find out how to export and import a complete n8n configuration (workflows and credentials) from an external VPS to an OVHcloud VPS, and vice versa." -updated: 2025-09-04 +updated: 2025-09-23 --- ## Objective @@ -15,6 +15,10 @@ This guide explains how to transfer an existing n8n configuration to an OVHcloud ## Instructions +> [!success] +> +> If you are starting from scratch, opt for an [OVHcloud preinstalled n8n VPS](/links/bare-metal/vps-n8n) to get started quickly. + ### Summary - [Method 1: Export and import via n8n CLI](#method1) diff --git a/pages/bare_metal_cloud/virtual_private_servers/import-export-n8n/guide.fr-fr.md b/pages/bare_metal_cloud/virtual_private_servers/import-export-n8n/guide.fr-fr.md index 96adeda5232..f2042ff13b7 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/import-export-n8n/guide.fr-fr.md +++ b/pages/bare_metal_cloud/virtual_private_servers/import-export-n8n/guide.fr-fr.md @@ -1,7 +1,7 @@ --- title: "Comment migrer une configuration n8n entre deux VPS" excerpt: "Découvrez comment exporter et importer une configuration n8n complète (workflows et identifiants) d’un VPS externe vers un VPS OVHcloud, et inversement." -updated: 2025-09-04 +updated: 2025-09-23 --- ## Objectif @@ -15,6 +15,10 @@ Ce guide vous explique comment transférer une configuration n8n existante vers ## En pratique +> [!success] +> +> Si vous devez commencer une nouvelle installation, optez pour un [VPS n8n OVHcloud préinstallé](/links/bare-metal/vps-n8n) pour démarrer rapidement. + ### Sommaire - [Méthode 1 : Exporter et importer via la CLI n8n](#method1) diff --git a/pages/bare_metal_cloud/virtual_private_servers/install_cloudpanel/guide.en-gb.md b/pages/bare_metal_cloud/virtual_private_servers/install_cloudpanel/guide.en-gb.md new file mode 100644 index 00000000000..e282f4bf46d --- /dev/null +++ b/pages/bare_metal_cloud/virtual_private_servers/install_cloudpanel/guide.en-gb.md @@ -0,0 +1,192 @@ +--- +title: 'How to install CloudPanel on a VPS or a Dedicated Server' +excerpt: "Find out how to install the CloudPanel administration interface on a VPS or a Dedicated Server" +updated: 2025-12-03 +--- + + + +## Objective + +CloudPanel is a modern, lightweight, and high-performance hosting control panel, offering a web interface to deploy and manage: + +- websites using PHP or Node.js; +- databases; +- SSL/TLS certificates (Let’s Encrypt); +- users; +- a firewall. + +This guide explains how to install CloudPanel on a VPS or a Dedicated Server and how to connect to it to perform the initial configuration. + +> [!warning] +> +> OVHcloud provides services for which you are responsible for the configuration, management, and operation. It is therefore your responsibility to ensure their proper functioning. +> +> We provide this tutorial to assist you with common tasks. However, we recommend that you contact a [specialist service provider](/links/partner) and/or the service publisher if you encounter difficulties. Indeed, we will not be able to provide you with support. More information is available in the "[Go further](#go-further)" section of this tutorial. + +## Requirements + +- A [VPS](/links/bare-metal/vps) or a [Dedicated Server](/links/bare-metal/bare-metal) with a [recommended configuration](https://www.cloudpanel.io/docs/v2/requirements/) in your [OVHcloud Control Panel](/links/manager). +- An administrative access (sudo) via SSH to your server. + +## Instructions + +### Step 1 — Connect and update the system + +#### Connect to the server + +Open a terminal and connect to your VPS (or Dedicated Server) using the following command: + +````bash +ssh user@IP_VPS +```` + +Replace: + +- `user` with your username. +- `IP_VPS` with your VPS's IP address. + +#### Update the system + +Update your operating system. This operation may take several minutes. + +> [!tabs] +> Debian and Ubuntu +>> +>> ```bash +>> sudo apt update && sudo apt -y upgrade +>> ``` +>> +> AlmaLinux 9 and Rocky Linux 8 +>> +>> ```bash +>> sudo dnf -y update +>> ``` + +### Step 2 — Open required ports (firewall) + +To allow incoming and outgoing connections, refer to the **Port Firewall** section of the [official CloudPanel documentation](https://www.cloudpanel.io/docs/v2/guides/best-practices/security/) to find out which ports to open based on your needs. + +#### Example of port opening for Debian and Ubuntu + +1\. Install `UFW`: + +```bash +sudo apt -y install ufw +``` + +2\. Open the necessary ports (examples: SSH, CloudPanel panel, HTTP/HTTPS): + +```bash +sudo ufw allow 22/tcp +sudo ufw allow 8443/tcp +sudo ufw allow 80/tcp +sudo ufw allow 443/tcp +``` + +3\. Enable `UFW` and check its status (the value "ALLOW" is expected): + +```bash +sudo ufw enable +sudo ufw status +``` + +#### Example of port opening for AlmaLinux 9 and Rocky Linux 8 + +1\. Install `firewalld`: + +```bash +sudo dnf -y install firewalld +``` + +2\. Enable and start the service: + +```bash +sudo systemctl enable --now firewalld +``` + +3\. Open the necessary ports (examples: SSH, CloudPanel panel, HTTP/HTTPS): + +```bash +sudo firewall-cmd --add-service=ssh --permanent +sudo firewall-cmd --add-service=http --permanent +sudo firewall-cmd --add-service=https --permanent +sudo firewall-cmd --add-port=8443/tcp --permanent +``` + +4\. Apply the configuration: + +```bash +sudo firewall-cmd --reload +sudo firewall-cmd --list-all +``` + +### Step 3 — Install CloudPanel + +1\. Install `wget`: + +> [!tabs] +> Debian and Ubuntu +>> +>> ```bash +>> sudo apt -y install wget +>> ``` +>> +> AlmaLinux 9 and Rocky Linux 8 +>> +>> ```bash +>> sudo dnf -y install wget +>> ``` +>> + +2\. Download the CloudPanel installation script: + +```bash +wget https://installer.cloudpanel.io/ce/v2/install.sh -O install.sh +``` + +3\. Run the installer with the desired database engine: + +Run the script specifying the database you want to install (MySQL or MariaDB). + +- Example with MySQL 8.4: + +```bash +sudo DB_ENGINE=MYSQL_8.4 bash install.sh +``` + +- Example with MariaDB 11.4: + +```bash +sudo DB_ENGINE=MARIADB_11.4 bash install.sh +``` + +The installation may take several minutes, as the script automatically installs the necessary dependencies. + +### Step 4 — First connection + +Once the installation is complete, enter the URL `https://:8443` in your browser, replacing `` with your VPS's IP address. + +> [!primary] +> +> On the first access, a self-signed certificate is used. Accept the browser warning to continue. + +The following interface appears: + +![cloudpanel install](images/cloudpanel-setup-interface.png){.thumbnail .w-600} + +On the first launch, CloudPanel asks you to create the administrator account by providing a username, an email address, and a password. After completing this step, enter the username and password you just set to log in. You then arrive at the CloudPanel administration interface. + +## Go further + +[How to secure a VPS](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps) + +[How to secure a Dedicated Server](/pages/bare_metal_cloud/dedicated_servers/securing-a-dedicated-server) + +For specialized services (SEO, development, etc.), contact [OVHcloud partners](/links/partner) + +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/install_cloudpanel/guide.fr-fr.md b/pages/bare_metal_cloud/virtual_private_servers/install_cloudpanel/guide.fr-fr.md new file mode 100644 index 00000000000..091399138c3 --- /dev/null +++ b/pages/bare_metal_cloud/virtual_private_servers/install_cloudpanel/guide.fr-fr.md @@ -0,0 +1,191 @@ +--- +title: 'Installer CloudPanel sur un VPS ou un serveur dédié' +excerpt: "Découvrez comment installer l'interface d’administration CloudPanel sur un VPS ou un serveur dédié" +updated: 2025-12-03 +--- + + + +## Objectif + +CloudPanel est un panneau de contrôle d’hébergement moderne, léger et performant, offrant une interface web pour déployer et gérer : + +- des sites web utilisant PHP ou Node.js ; +- des bases de données ; +- des certificats SSL/TLS (Let’s Encrypt) ; +- des utilisateurs ; +- un pare-feu. + +Ce guide explique comment installer CloudPanel sur un VPS ou un serveur dédié et comment vous y connecter pour réaliser la configuration initiale. + +> [!warning] +> +> OVHcloud met à votre disposition des services dont la configuration, la gestion et la responsabilité vous incombent. Il vous revient de ce fait d’en assurer le bon fonctionnement. +> +> Nous mettons à votre disposition ce tutoriel afin de vous accompagner au mieux sur des tâches courantes. Néanmoins, nous vous recommandons de faire appel à un [prestataire spécialisé](/links/partner) et/ou de contacter l’éditeur du service si vous éprouvez des difficultés. En effet, nous ne serons pas en mesure de vous fournir une assistance. Plus d’informations dans la section « [Aller plus loin](#go-further) » de ce tutoriel. + +## Prérequis + +- Disposer d’un [VPS](/links/bare-metal/vps) ou d’un [serveur dédié](/links/bare-metal/bare-metal) avec une [configuration recommandée](https://www.cloudpanel.io/docs/v2/requirements/) dans votre [espace client OVHcloud](/links/manager). +- Disposer d’un accès administrateur (sudo) via SSH à votre serveur. + +## En pratique + +### Étape 1 — Connexion et mise à jour du système + +#### Se connecter au serveur + +Ouvrez un terminal et connectez-vous à votre VPS (ou à votre serveur dédié) avec la commande suivante : + +```bash +ssh user@IP_VPS +``` + +Remplacez : + +- `user` par votre nom d’utilisateur. +- `IP_VPS` par l’adresse IP de votre VPS. + +#### Mettre à jour le système + +Mettez votre système d’exploitation à jour. Cette opération peut prendre plusieurs minutes. + +> [!tabs] +> Debian et Ubuntu +>> +>> ```bash +>> sudo apt update && sudo apt -y upgrade +>> ``` +>> +> AlmaLinux 9 et Rocky Linux 8 +>> +>> ```bash +>> sudo dnf -y update +>> ``` + +### Étape 2 — Ouvrir les ports nécessaires (pare-feu) + +Pour autoriser les connexions entrantes et sortantes, référez-vous à la section **Port Firewall** de la [documentation officielle de CloudPanel](https://www.cloudpanel.io/docs/v2/guides/best-practices/security/) pour connaître les ports à ouvrir selon vos besoins. + +#### Exemple d’ouverture de ports pour Debian et Ubuntu + +1\. Installez `UFW` : + +```bash +sudo apt -y install ufw +``` + +2\. Ouvrez les ports nécessaires (exemples : SSH, panneau CloudPanel, HTTP/HTTPS) : + +```bash +sudo ufw allow 22/tcp +sudo ufw allow 8443/tcp +sudo ufw allow 80/tcp +sudo ufw allow 443/tcp +``` + +3\. Activez `UFW` et vérifiez son statut (la valeur « ALLOW » est attendue) : + +```bash +sudo ufw enable +sudo ufw status +``` + +#### Exemple d’ouverture de ports pour AlmaLinux 9 et Rocky Linux 8 + +1\. Installez `firewalld` : + +```bash +sudo dnf -y install firewalld +``` + +2\. Activez et démarrez le service : + +```bash +sudo systemctl enable --now firewalld +``` + +3\. Ouvrez les ports nécessaires (exemples : SSH, panneau CloudPanel, HTTP/HTTPS) : + +```bash +sudo firewall-cmd --add-service=ssh --permanent +sudo firewall-cmd --add-service=http --permanent +sudo firewall-cmd --add-service=https --permanent +sudo firewall-cmd --add-port=8443/tcp --permanent +``` + +4\. Appliquez la configuration : + +```bash +sudo firewall-cmd --reload +sudo firewall-cmd --list-all +``` + +### Étape 3 — Installer CloudPanel + +1\. Installez `wget` : + +> [!tabs] +> Debian et Ubuntu +>> +>> ```bash +>> sudo apt -y install wget +>> ``` +>> +> AlmaLinux 9 et Rocky Linux 8 +>> +>> ```bash +>> sudo dnf -y install wget +>> ``` + +2\. Téléchargez le script d’installation de CloudPanel : + +```bash +wget https://installer.cloudpanel.io/ce/v2/install.sh -O install.sh +``` + +3\. Lancez l’installateur avec le moteur de base de données souhaité : + +Exécutez le script en indiquant la base de données que vous souhaitez installer (MySQL ou MariaDB). + +- Exemple avec MySQL 8.4 : + +```bash +sudo DB_ENGINE=MYSQL_8.4 bash install.sh +``` + +- Exemple avec MariaDB 11.4 : + +```bash +sudo DB_ENGINE=MARIADB_11.4 bash install.sh +``` + +L’installation peut durer plusieurs minutes, car le script installe automatiquement les dépendances nécessaires. + +### Étape 4 — Première connexion + +Une fois l’installation terminée, entrez l’URL `https://:8443` dans votre navigateur en remplaçant `` par l’adresse IP de votre VPS. + +> [!primary] +> +> Lors du premier accès, un certificat autosigné est utilisé. Acceptez l’avertissement du navigateur pour continuer. + +L’interface ci-dessous s’affiche : + +![cloudpanel install](images/cloudpanel-setup-interface.png){.thumbnail .w-600} + +Au premier lancement, CloudPanel vous demande de créer le compte administrateur en renseignant un nom d'utilisateur, une adresse e-mail et un mot de passe. Après avoir effectué cette étape, entrez le nom d'utilisateur et le mot de passe que vous venez de définir pour vous connecter. Vous arrivez ensuite sur l’interface d’administration CloudPanel. + +## Aller plus loin + +[Sécuriser un VPS](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps) + +[Sécuriser un serveur dédié](/pages/bare_metal_cloud/dedicated_servers/securing-a-dedicated-server) + +Pour des prestations spécialisées (référencement, développement, etc.), contactez les [partenaires OVHcloud](/links/partner) + +Échangez avec notre [communauté d’utilisateurs](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/install_cloudpanel/images/cloudpanel-setup-interface.png b/pages/bare_metal_cloud/virtual_private_servers/install_cloudpanel/images/cloudpanel-setup-interface.png new file mode 100644 index 00000000000..3f5d0667217 Binary files /dev/null and b/pages/bare_metal_cloud/virtual_private_servers/install_cloudpanel/images/cloudpanel-setup-interface.png differ diff --git a/pages/bare_metal_cloud/virtual_private_servers/install_cloudpanel/meta.yaml b/pages/bare_metal_cloud/virtual_private_servers/install_cloudpanel/meta.yaml new file mode 100644 index 00000000000..f92292b9248 --- /dev/null +++ b/pages/bare_metal_cloud/virtual_private_servers/install_cloudpanel/meta.yaml @@ -0,0 +1,3 @@ +id: 2763c97a-8a32-4a77-8f07-f5c9075d20f7 +full_slug: vps-install-cloudpanel +reference_category: bare-metal-cloud-virtual-private-servers-tutorials \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/install_env_web_dev_on_vps/guide.en-asia.md b/pages/bare_metal_cloud/virtual_private_servers/install_env_web_dev_on_vps/guide.en-asia.md index a1fb9bc3f04..1d84d25161f 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/install_env_web_dev_on_vps/guide.en-asia.md +++ b/pages/bare_metal_cloud/virtual_private_servers/install_env_web_dev_on_vps/guide.en-asia.md @@ -1,7 +1,7 @@ --- title: "How to install a web development environment on a VPS or a dedicated server" excerpt: "Find out how to install a web development environment on a VPS or an OVHcloud dedicated server" -updated: 2024-03-13 +updated: 2025-10-15 --- ## Objective @@ -22,24 +22,38 @@ If you would like to install a CMS (**C**ontent **M**anagement **S**ystem) on yo ## Requirements -- A [VPS] solution (https://www.ovhcloud.com/asia/vps) or a [dedicated server](/links/bare-metal/bare-metal) in your [OVHcloud Control Panel](/links/manager) +- A [VPS] solution (/links/bare-metal/vps) or a [dedicated server](/links/bare-metal/bare-metal) in your [OVHcloud Control Panel](/links/manager) - Administrative (sudo) access to your server via SSH ## Instructions Log in to your VPS via SSH with your username and password. +### Update the package index + +Before installing the components, update the package list: + +```bash +sudo apt update +``` + +Apply the available updates: + +```bash +sudo apt -y upgrade +``` + ### Install PHP Install PHP: -```sh -sudo apt install php php-cli php-mysql php-xml php-gd php-curl -y +```bash +sudo apt install -y php php-cli php-fpm php-xml php-gd php-curl ``` To check that PHP is installed properly, enter the following command: -```sh +```bash sudo php -v ``` @@ -56,13 +70,13 @@ If PHP is correctly installed, you should see this message: Install Nginx: -```sh +```bash sudo apt install nginx -y ``` To verify that Nginx is installed properly, enter the following command: -```sh +```bash sudo nginx -v ``` @@ -76,28 +90,44 @@ If you have any queries, please refer to [Nginx official website](https://www.ng > [!primary] > -> For this guide, we choose MariaDB, but you are free to install the DBMS of your choice. -> - -Install MariaDB: - -```sh -sudo apt install mariadb-server -y -``` - -Secure and configure MariaDB: - -```sh -sudo mysql_secure_installation -``` - -Set a password for your DBMS and follow the instructions on the screen. Once the MariaDB installation is complete, you should see the following message: - -![env dev web](images/success_msg_mariadb.png){.thumbnail} +> Select the tab corresponding to the DBMS you want to use. The appropriate PHP extension will be installed in each case. + +> [!tabs] +> MySQL / MariaDB +>> Install MariaDB (or MySQL) and the associated PHP extension: +>> +>> ```bash +>> sudo apt install -y mariadb-server php-mysql +>> ``` +>> +>> Secure the installation: +>> +>> ```bash +>> sudo mysql_secure_installation +>> ``` +>> +>> Set a password for your DBMS and follow the on-screen instructions. Once the MariaDB (or MySQL) installation is complete, the following message should appear: +>> +>> ![env dev web](images/success_msg_mariadb.png){.thumbnail} +>> +> PostgreSQL +>> Install PostgreSQL and the corresponding PHP extension: +>> +>> ```bash +>> sudo apt install -y postgresql postgresql-contrib php-pgsql +>> ``` +>> +>> Create a database and a user (example): +>> +>> ```bash +>> sudo -u postgres psql -c "CREATE DATABASE db_name;" +>> sudo -u postgres psql -c "CREATE USER db_user WITH ENCRYPTED PASSWORD 'strong_password';" +>> sudo -u postgres psql -c "GRANT ALL PRIVILEGES ON DATABASE db_name TO db_user;" +>> ``` ### Conclusion -You have just installed PHP, an Nginx server and MariaDB DBMS. You now have a functional web development environment on your VPS or OVHcloud dedicated server. If you wish, you can now install the CMS (**C**ontent **M**anagement **S**ystem) of your choice, such as WordPress. To find out more, please read the guides “[How to install WordPress with WP-CLI on a VPS or a dedicated server](/pages/bare_metal_cloud/virtual_private_servers/install_wordpress_site_on_vps)” and “[How to install WordPress with Docker on a VPS or a dedicated server](/pages/bare_metal_cloud/virtual_private_servers/install_wordpress_docker_on_vps)”. +You have just installed PHP, an Nginx server, and a DBMS (MariaDB/MySQL or PostgreSQL). You now have a functional web development environment on your VPS or OVHcloud dedicated server. If you wish, you can now install the CMS (**C**ontent **M**anagement **S**ystem) of your choice, such as WordPress. To find out more, please read the guides “[How to install WordPress with WP-CLI on a VPS or a dedicated server](/pages/bare_metal_cloud/virtual_private_servers/install_wordpress_site_on_vps)” and “[How to install WordPress with Docker on a VPS or a dedicated server](/pages/bare_metal_cloud/virtual_private_servers/install_wordpress_docker_on_vps)”. For some general tips on securing a GNU/Linux-based server, see our guides: diff --git a/pages/bare_metal_cloud/virtual_private_servers/install_env_web_dev_on_vps/guide.en-au.md b/pages/bare_metal_cloud/virtual_private_servers/install_env_web_dev_on_vps/guide.en-au.md index 23e852405b2..1d84d25161f 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/install_env_web_dev_on_vps/guide.en-au.md +++ b/pages/bare_metal_cloud/virtual_private_servers/install_env_web_dev_on_vps/guide.en-au.md @@ -1,7 +1,7 @@ --- title: "How to install a web development environment on a VPS or a dedicated server" excerpt: "Find out how to install a web development environment on a VPS or an OVHcloud dedicated server" -updated: 2024-03-13 +updated: 2025-10-15 --- ## Objective @@ -29,17 +29,31 @@ If you would like to install a CMS (**C**ontent **M**anagement **S**ystem) on yo Log in to your VPS via SSH with your username and password. +### Update the package index + +Before installing the components, update the package list: + +```bash +sudo apt update +``` + +Apply the available updates: + +```bash +sudo apt -y upgrade +``` + ### Install PHP Install PHP: -```sh -sudo apt install php php-cli php-mysql php-xml php-gd php-curl -y +```bash +sudo apt install -y php php-cli php-fpm php-xml php-gd php-curl ``` To check that PHP is installed properly, enter the following command: -```sh +```bash sudo php -v ``` @@ -56,13 +70,13 @@ If PHP is correctly installed, you should see this message: Install Nginx: -```sh +```bash sudo apt install nginx -y ``` To verify that Nginx is installed properly, enter the following command: -```sh +```bash sudo nginx -v ``` @@ -76,28 +90,44 @@ If you have any queries, please refer to [Nginx official website](https://www.ng > [!primary] > -> For this guide, we choose MariaDB, but you are free to install the DBMS of your choice. -> - -Install MariaDB: - -```sh -sudo apt install mariadb-server -y -``` - -Secure and configure MariaDB: - -```sh -sudo mysql_secure_installation -``` - -Set a password for your DBMS and follow the instructions on the screen. Once the MariaDB installation is complete, you should see the following message: - -![env dev web](images/success_msg_mariadb.png){.thumbnail} +> Select the tab corresponding to the DBMS you want to use. The appropriate PHP extension will be installed in each case. + +> [!tabs] +> MySQL / MariaDB +>> Install MariaDB (or MySQL) and the associated PHP extension: +>> +>> ```bash +>> sudo apt install -y mariadb-server php-mysql +>> ``` +>> +>> Secure the installation: +>> +>> ```bash +>> sudo mysql_secure_installation +>> ``` +>> +>> Set a password for your DBMS and follow the on-screen instructions. Once the MariaDB (or MySQL) installation is complete, the following message should appear: +>> +>> ![env dev web](images/success_msg_mariadb.png){.thumbnail} +>> +> PostgreSQL +>> Install PostgreSQL and the corresponding PHP extension: +>> +>> ```bash +>> sudo apt install -y postgresql postgresql-contrib php-pgsql +>> ``` +>> +>> Create a database and a user (example): +>> +>> ```bash +>> sudo -u postgres psql -c "CREATE DATABASE db_name;" +>> sudo -u postgres psql -c "CREATE USER db_user WITH ENCRYPTED PASSWORD 'strong_password';" +>> sudo -u postgres psql -c "GRANT ALL PRIVILEGES ON DATABASE db_name TO db_user;" +>> ``` ### Conclusion -You have just installed PHP, an Nginx server and MariaDB DBMS. You now have a functional web development environment on your VPS or OVHcloud dedicated server. If you wish, you can now install the CMS (**C**ontent **M**anagement **S**ystem) of your choice, such as WordPress. To find out more, please read the guides “[How to install WordPress with WP-CLI on a VPS or a dedicated server](/pages/bare_metal_cloud/virtual_private_servers/install_wordpress_site_on_vps)” and “[How to install WordPress with Docker on a VPS or a dedicated server](/pages/bare_metal_cloud/virtual_private_servers/install_wordpress_docker_on_vps)”. +You have just installed PHP, an Nginx server, and a DBMS (MariaDB/MySQL or PostgreSQL). You now have a functional web development environment on your VPS or OVHcloud dedicated server. If you wish, you can now install the CMS (**C**ontent **M**anagement **S**ystem) of your choice, such as WordPress. To find out more, please read the guides “[How to install WordPress with WP-CLI on a VPS or a dedicated server](/pages/bare_metal_cloud/virtual_private_servers/install_wordpress_site_on_vps)” and “[How to install WordPress with Docker on a VPS or a dedicated server](/pages/bare_metal_cloud/virtual_private_servers/install_wordpress_docker_on_vps)”. For some general tips on securing a GNU/Linux-based server, see our guides: diff --git a/pages/bare_metal_cloud/virtual_private_servers/install_env_web_dev_on_vps/guide.en-ca.md b/pages/bare_metal_cloud/virtual_private_servers/install_env_web_dev_on_vps/guide.en-ca.md index 23e852405b2..1d84d25161f 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/install_env_web_dev_on_vps/guide.en-ca.md +++ b/pages/bare_metal_cloud/virtual_private_servers/install_env_web_dev_on_vps/guide.en-ca.md @@ -1,7 +1,7 @@ --- title: "How to install a web development environment on a VPS or a dedicated server" excerpt: "Find out how to install a web development environment on a VPS or an OVHcloud dedicated server" -updated: 2024-03-13 +updated: 2025-10-15 --- ## Objective @@ -29,17 +29,31 @@ If you would like to install a CMS (**C**ontent **M**anagement **S**ystem) on yo Log in to your VPS via SSH with your username and password. +### Update the package index + +Before installing the components, update the package list: + +```bash +sudo apt update +``` + +Apply the available updates: + +```bash +sudo apt -y upgrade +``` + ### Install PHP Install PHP: -```sh -sudo apt install php php-cli php-mysql php-xml php-gd php-curl -y +```bash +sudo apt install -y php php-cli php-fpm php-xml php-gd php-curl ``` To check that PHP is installed properly, enter the following command: -```sh +```bash sudo php -v ``` @@ -56,13 +70,13 @@ If PHP is correctly installed, you should see this message: Install Nginx: -```sh +```bash sudo apt install nginx -y ``` To verify that Nginx is installed properly, enter the following command: -```sh +```bash sudo nginx -v ``` @@ -76,28 +90,44 @@ If you have any queries, please refer to [Nginx official website](https://www.ng > [!primary] > -> For this guide, we choose MariaDB, but you are free to install the DBMS of your choice. -> - -Install MariaDB: - -```sh -sudo apt install mariadb-server -y -``` - -Secure and configure MariaDB: - -```sh -sudo mysql_secure_installation -``` - -Set a password for your DBMS and follow the instructions on the screen. Once the MariaDB installation is complete, you should see the following message: - -![env dev web](images/success_msg_mariadb.png){.thumbnail} +> Select the tab corresponding to the DBMS you want to use. The appropriate PHP extension will be installed in each case. + +> [!tabs] +> MySQL / MariaDB +>> Install MariaDB (or MySQL) and the associated PHP extension: +>> +>> ```bash +>> sudo apt install -y mariadb-server php-mysql +>> ``` +>> +>> Secure the installation: +>> +>> ```bash +>> sudo mysql_secure_installation +>> ``` +>> +>> Set a password for your DBMS and follow the on-screen instructions. Once the MariaDB (or MySQL) installation is complete, the following message should appear: +>> +>> ![env dev web](images/success_msg_mariadb.png){.thumbnail} +>> +> PostgreSQL +>> Install PostgreSQL and the corresponding PHP extension: +>> +>> ```bash +>> sudo apt install -y postgresql postgresql-contrib php-pgsql +>> ``` +>> +>> Create a database and a user (example): +>> +>> ```bash +>> sudo -u postgres psql -c "CREATE DATABASE db_name;" +>> sudo -u postgres psql -c "CREATE USER db_user WITH ENCRYPTED PASSWORD 'strong_password';" +>> sudo -u postgres psql -c "GRANT ALL PRIVILEGES ON DATABASE db_name TO db_user;" +>> ``` ### Conclusion -You have just installed PHP, an Nginx server and MariaDB DBMS. You now have a functional web development environment on your VPS or OVHcloud dedicated server. If you wish, you can now install the CMS (**C**ontent **M**anagement **S**ystem) of your choice, such as WordPress. To find out more, please read the guides “[How to install WordPress with WP-CLI on a VPS or a dedicated server](/pages/bare_metal_cloud/virtual_private_servers/install_wordpress_site_on_vps)” and “[How to install WordPress with Docker on a VPS or a dedicated server](/pages/bare_metal_cloud/virtual_private_servers/install_wordpress_docker_on_vps)”. +You have just installed PHP, an Nginx server, and a DBMS (MariaDB/MySQL or PostgreSQL). You now have a functional web development environment on your VPS or OVHcloud dedicated server. If you wish, you can now install the CMS (**C**ontent **M**anagement **S**ystem) of your choice, such as WordPress. To find out more, please read the guides “[How to install WordPress with WP-CLI on a VPS or a dedicated server](/pages/bare_metal_cloud/virtual_private_servers/install_wordpress_site_on_vps)” and “[How to install WordPress with Docker on a VPS or a dedicated server](/pages/bare_metal_cloud/virtual_private_servers/install_wordpress_docker_on_vps)”. For some general tips on securing a GNU/Linux-based server, see our guides: diff --git a/pages/bare_metal_cloud/virtual_private_servers/install_env_web_dev_on_vps/guide.en-gb.md b/pages/bare_metal_cloud/virtual_private_servers/install_env_web_dev_on_vps/guide.en-gb.md index 23e852405b2..1d84d25161f 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/install_env_web_dev_on_vps/guide.en-gb.md +++ b/pages/bare_metal_cloud/virtual_private_servers/install_env_web_dev_on_vps/guide.en-gb.md @@ -1,7 +1,7 @@ --- title: "How to install a web development environment on a VPS or a dedicated server" excerpt: "Find out how to install a web development environment on a VPS or an OVHcloud dedicated server" -updated: 2024-03-13 +updated: 2025-10-15 --- ## Objective @@ -29,17 +29,31 @@ If you would like to install a CMS (**C**ontent **M**anagement **S**ystem) on yo Log in to your VPS via SSH with your username and password. +### Update the package index + +Before installing the components, update the package list: + +```bash +sudo apt update +``` + +Apply the available updates: + +```bash +sudo apt -y upgrade +``` + ### Install PHP Install PHP: -```sh -sudo apt install php php-cli php-mysql php-xml php-gd php-curl -y +```bash +sudo apt install -y php php-cli php-fpm php-xml php-gd php-curl ``` To check that PHP is installed properly, enter the following command: -```sh +```bash sudo php -v ``` @@ -56,13 +70,13 @@ If PHP is correctly installed, you should see this message: Install Nginx: -```sh +```bash sudo apt install nginx -y ``` To verify that Nginx is installed properly, enter the following command: -```sh +```bash sudo nginx -v ``` @@ -76,28 +90,44 @@ If you have any queries, please refer to [Nginx official website](https://www.ng > [!primary] > -> For this guide, we choose MariaDB, but you are free to install the DBMS of your choice. -> - -Install MariaDB: - -```sh -sudo apt install mariadb-server -y -``` - -Secure and configure MariaDB: - -```sh -sudo mysql_secure_installation -``` - -Set a password for your DBMS and follow the instructions on the screen. Once the MariaDB installation is complete, you should see the following message: - -![env dev web](images/success_msg_mariadb.png){.thumbnail} +> Select the tab corresponding to the DBMS you want to use. The appropriate PHP extension will be installed in each case. + +> [!tabs] +> MySQL / MariaDB +>> Install MariaDB (or MySQL) and the associated PHP extension: +>> +>> ```bash +>> sudo apt install -y mariadb-server php-mysql +>> ``` +>> +>> Secure the installation: +>> +>> ```bash +>> sudo mysql_secure_installation +>> ``` +>> +>> Set a password for your DBMS and follow the on-screen instructions. Once the MariaDB (or MySQL) installation is complete, the following message should appear: +>> +>> ![env dev web](images/success_msg_mariadb.png){.thumbnail} +>> +> PostgreSQL +>> Install PostgreSQL and the corresponding PHP extension: +>> +>> ```bash +>> sudo apt install -y postgresql postgresql-contrib php-pgsql +>> ``` +>> +>> Create a database and a user (example): +>> +>> ```bash +>> sudo -u postgres psql -c "CREATE DATABASE db_name;" +>> sudo -u postgres psql -c "CREATE USER db_user WITH ENCRYPTED PASSWORD 'strong_password';" +>> sudo -u postgres psql -c "GRANT ALL PRIVILEGES ON DATABASE db_name TO db_user;" +>> ``` ### Conclusion -You have just installed PHP, an Nginx server and MariaDB DBMS. You now have a functional web development environment on your VPS or OVHcloud dedicated server. If you wish, you can now install the CMS (**C**ontent **M**anagement **S**ystem) of your choice, such as WordPress. To find out more, please read the guides “[How to install WordPress with WP-CLI on a VPS or a dedicated server](/pages/bare_metal_cloud/virtual_private_servers/install_wordpress_site_on_vps)” and “[How to install WordPress with Docker on a VPS or a dedicated server](/pages/bare_metal_cloud/virtual_private_servers/install_wordpress_docker_on_vps)”. +You have just installed PHP, an Nginx server, and a DBMS (MariaDB/MySQL or PostgreSQL). You now have a functional web development environment on your VPS or OVHcloud dedicated server. If you wish, you can now install the CMS (**C**ontent **M**anagement **S**ystem) of your choice, such as WordPress. To find out more, please read the guides “[How to install WordPress with WP-CLI on a VPS or a dedicated server](/pages/bare_metal_cloud/virtual_private_servers/install_wordpress_site_on_vps)” and “[How to install WordPress with Docker on a VPS or a dedicated server](/pages/bare_metal_cloud/virtual_private_servers/install_wordpress_docker_on_vps)”. For some general tips on securing a GNU/Linux-based server, see our guides: diff --git a/pages/bare_metal_cloud/virtual_private_servers/install_env_web_dev_on_vps/guide.en-ie.md b/pages/bare_metal_cloud/virtual_private_servers/install_env_web_dev_on_vps/guide.en-ie.md index 23e852405b2..1d84d25161f 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/install_env_web_dev_on_vps/guide.en-ie.md +++ b/pages/bare_metal_cloud/virtual_private_servers/install_env_web_dev_on_vps/guide.en-ie.md @@ -1,7 +1,7 @@ --- title: "How to install a web development environment on a VPS or a dedicated server" excerpt: "Find out how to install a web development environment on a VPS or an OVHcloud dedicated server" -updated: 2024-03-13 +updated: 2025-10-15 --- ## Objective @@ -29,17 +29,31 @@ If you would like to install a CMS (**C**ontent **M**anagement **S**ystem) on yo Log in to your VPS via SSH with your username and password. +### Update the package index + +Before installing the components, update the package list: + +```bash +sudo apt update +``` + +Apply the available updates: + +```bash +sudo apt -y upgrade +``` + ### Install PHP Install PHP: -```sh -sudo apt install php php-cli php-mysql php-xml php-gd php-curl -y +```bash +sudo apt install -y php php-cli php-fpm php-xml php-gd php-curl ``` To check that PHP is installed properly, enter the following command: -```sh +```bash sudo php -v ``` @@ -56,13 +70,13 @@ If PHP is correctly installed, you should see this message: Install Nginx: -```sh +```bash sudo apt install nginx -y ``` To verify that Nginx is installed properly, enter the following command: -```sh +```bash sudo nginx -v ``` @@ -76,28 +90,44 @@ If you have any queries, please refer to [Nginx official website](https://www.ng > [!primary] > -> For this guide, we choose MariaDB, but you are free to install the DBMS of your choice. -> - -Install MariaDB: - -```sh -sudo apt install mariadb-server -y -``` - -Secure and configure MariaDB: - -```sh -sudo mysql_secure_installation -``` - -Set a password for your DBMS and follow the instructions on the screen. Once the MariaDB installation is complete, you should see the following message: - -![env dev web](images/success_msg_mariadb.png){.thumbnail} +> Select the tab corresponding to the DBMS you want to use. The appropriate PHP extension will be installed in each case. + +> [!tabs] +> MySQL / MariaDB +>> Install MariaDB (or MySQL) and the associated PHP extension: +>> +>> ```bash +>> sudo apt install -y mariadb-server php-mysql +>> ``` +>> +>> Secure the installation: +>> +>> ```bash +>> sudo mysql_secure_installation +>> ``` +>> +>> Set a password for your DBMS and follow the on-screen instructions. Once the MariaDB (or MySQL) installation is complete, the following message should appear: +>> +>> ![env dev web](images/success_msg_mariadb.png){.thumbnail} +>> +> PostgreSQL +>> Install PostgreSQL and the corresponding PHP extension: +>> +>> ```bash +>> sudo apt install -y postgresql postgresql-contrib php-pgsql +>> ``` +>> +>> Create a database and a user (example): +>> +>> ```bash +>> sudo -u postgres psql -c "CREATE DATABASE db_name;" +>> sudo -u postgres psql -c "CREATE USER db_user WITH ENCRYPTED PASSWORD 'strong_password';" +>> sudo -u postgres psql -c "GRANT ALL PRIVILEGES ON DATABASE db_name TO db_user;" +>> ``` ### Conclusion -You have just installed PHP, an Nginx server and MariaDB DBMS. You now have a functional web development environment on your VPS or OVHcloud dedicated server. If you wish, you can now install the CMS (**C**ontent **M**anagement **S**ystem) of your choice, such as WordPress. To find out more, please read the guides “[How to install WordPress with WP-CLI on a VPS or a dedicated server](/pages/bare_metal_cloud/virtual_private_servers/install_wordpress_site_on_vps)” and “[How to install WordPress with Docker on a VPS or a dedicated server](/pages/bare_metal_cloud/virtual_private_servers/install_wordpress_docker_on_vps)”. +You have just installed PHP, an Nginx server, and a DBMS (MariaDB/MySQL or PostgreSQL). You now have a functional web development environment on your VPS or OVHcloud dedicated server. If you wish, you can now install the CMS (**C**ontent **M**anagement **S**ystem) of your choice, such as WordPress. To find out more, please read the guides “[How to install WordPress with WP-CLI on a VPS or a dedicated server](/pages/bare_metal_cloud/virtual_private_servers/install_wordpress_site_on_vps)” and “[How to install WordPress with Docker on a VPS or a dedicated server](/pages/bare_metal_cloud/virtual_private_servers/install_wordpress_docker_on_vps)”. For some general tips on securing a GNU/Linux-based server, see our guides: diff --git a/pages/bare_metal_cloud/virtual_private_servers/install_env_web_dev_on_vps/guide.en-sg.md b/pages/bare_metal_cloud/virtual_private_servers/install_env_web_dev_on_vps/guide.en-sg.md index 23e852405b2..1d84d25161f 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/install_env_web_dev_on_vps/guide.en-sg.md +++ b/pages/bare_metal_cloud/virtual_private_servers/install_env_web_dev_on_vps/guide.en-sg.md @@ -1,7 +1,7 @@ --- title: "How to install a web development environment on a VPS or a dedicated server" excerpt: "Find out how to install a web development environment on a VPS or an OVHcloud dedicated server" -updated: 2024-03-13 +updated: 2025-10-15 --- ## Objective @@ -29,17 +29,31 @@ If you would like to install a CMS (**C**ontent **M**anagement **S**ystem) on yo Log in to your VPS via SSH with your username and password. +### Update the package index + +Before installing the components, update the package list: + +```bash +sudo apt update +``` + +Apply the available updates: + +```bash +sudo apt -y upgrade +``` + ### Install PHP Install PHP: -```sh -sudo apt install php php-cli php-mysql php-xml php-gd php-curl -y +```bash +sudo apt install -y php php-cli php-fpm php-xml php-gd php-curl ``` To check that PHP is installed properly, enter the following command: -```sh +```bash sudo php -v ``` @@ -56,13 +70,13 @@ If PHP is correctly installed, you should see this message: Install Nginx: -```sh +```bash sudo apt install nginx -y ``` To verify that Nginx is installed properly, enter the following command: -```sh +```bash sudo nginx -v ``` @@ -76,28 +90,44 @@ If you have any queries, please refer to [Nginx official website](https://www.ng > [!primary] > -> For this guide, we choose MariaDB, but you are free to install the DBMS of your choice. -> - -Install MariaDB: - -```sh -sudo apt install mariadb-server -y -``` - -Secure and configure MariaDB: - -```sh -sudo mysql_secure_installation -``` - -Set a password for your DBMS and follow the instructions on the screen. Once the MariaDB installation is complete, you should see the following message: - -![env dev web](images/success_msg_mariadb.png){.thumbnail} +> Select the tab corresponding to the DBMS you want to use. The appropriate PHP extension will be installed in each case. + +> [!tabs] +> MySQL / MariaDB +>> Install MariaDB (or MySQL) and the associated PHP extension: +>> +>> ```bash +>> sudo apt install -y mariadb-server php-mysql +>> ``` +>> +>> Secure the installation: +>> +>> ```bash +>> sudo mysql_secure_installation +>> ``` +>> +>> Set a password for your DBMS and follow the on-screen instructions. Once the MariaDB (or MySQL) installation is complete, the following message should appear: +>> +>> ![env dev web](images/success_msg_mariadb.png){.thumbnail} +>> +> PostgreSQL +>> Install PostgreSQL and the corresponding PHP extension: +>> +>> ```bash +>> sudo apt install -y postgresql postgresql-contrib php-pgsql +>> ``` +>> +>> Create a database and a user (example): +>> +>> ```bash +>> sudo -u postgres psql -c "CREATE DATABASE db_name;" +>> sudo -u postgres psql -c "CREATE USER db_user WITH ENCRYPTED PASSWORD 'strong_password';" +>> sudo -u postgres psql -c "GRANT ALL PRIVILEGES ON DATABASE db_name TO db_user;" +>> ``` ### Conclusion -You have just installed PHP, an Nginx server and MariaDB DBMS. You now have a functional web development environment on your VPS or OVHcloud dedicated server. If you wish, you can now install the CMS (**C**ontent **M**anagement **S**ystem) of your choice, such as WordPress. To find out more, please read the guides “[How to install WordPress with WP-CLI on a VPS or a dedicated server](/pages/bare_metal_cloud/virtual_private_servers/install_wordpress_site_on_vps)” and “[How to install WordPress with Docker on a VPS or a dedicated server](/pages/bare_metal_cloud/virtual_private_servers/install_wordpress_docker_on_vps)”. +You have just installed PHP, an Nginx server, and a DBMS (MariaDB/MySQL or PostgreSQL). You now have a functional web development environment on your VPS or OVHcloud dedicated server. If you wish, you can now install the CMS (**C**ontent **M**anagement **S**ystem) of your choice, such as WordPress. To find out more, please read the guides “[How to install WordPress with WP-CLI on a VPS or a dedicated server](/pages/bare_metal_cloud/virtual_private_servers/install_wordpress_site_on_vps)” and “[How to install WordPress with Docker on a VPS or a dedicated server](/pages/bare_metal_cloud/virtual_private_servers/install_wordpress_docker_on_vps)”. For some general tips on securing a GNU/Linux-based server, see our guides: diff --git a/pages/bare_metal_cloud/virtual_private_servers/install_env_web_dev_on_vps/guide.en-us.md b/pages/bare_metal_cloud/virtual_private_servers/install_env_web_dev_on_vps/guide.en-us.md index 23e852405b2..1d84d25161f 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/install_env_web_dev_on_vps/guide.en-us.md +++ b/pages/bare_metal_cloud/virtual_private_servers/install_env_web_dev_on_vps/guide.en-us.md @@ -1,7 +1,7 @@ --- title: "How to install a web development environment on a VPS or a dedicated server" excerpt: "Find out how to install a web development environment on a VPS or an OVHcloud dedicated server" -updated: 2024-03-13 +updated: 2025-10-15 --- ## Objective @@ -29,17 +29,31 @@ If you would like to install a CMS (**C**ontent **M**anagement **S**ystem) on yo Log in to your VPS via SSH with your username and password. +### Update the package index + +Before installing the components, update the package list: + +```bash +sudo apt update +``` + +Apply the available updates: + +```bash +sudo apt -y upgrade +``` + ### Install PHP Install PHP: -```sh -sudo apt install php php-cli php-mysql php-xml php-gd php-curl -y +```bash +sudo apt install -y php php-cli php-fpm php-xml php-gd php-curl ``` To check that PHP is installed properly, enter the following command: -```sh +```bash sudo php -v ``` @@ -56,13 +70,13 @@ If PHP is correctly installed, you should see this message: Install Nginx: -```sh +```bash sudo apt install nginx -y ``` To verify that Nginx is installed properly, enter the following command: -```sh +```bash sudo nginx -v ``` @@ -76,28 +90,44 @@ If you have any queries, please refer to [Nginx official website](https://www.ng > [!primary] > -> For this guide, we choose MariaDB, but you are free to install the DBMS of your choice. -> - -Install MariaDB: - -```sh -sudo apt install mariadb-server -y -``` - -Secure and configure MariaDB: - -```sh -sudo mysql_secure_installation -``` - -Set a password for your DBMS and follow the instructions on the screen. Once the MariaDB installation is complete, you should see the following message: - -![env dev web](images/success_msg_mariadb.png){.thumbnail} +> Select the tab corresponding to the DBMS you want to use. The appropriate PHP extension will be installed in each case. + +> [!tabs] +> MySQL / MariaDB +>> Install MariaDB (or MySQL) and the associated PHP extension: +>> +>> ```bash +>> sudo apt install -y mariadb-server php-mysql +>> ``` +>> +>> Secure the installation: +>> +>> ```bash +>> sudo mysql_secure_installation +>> ``` +>> +>> Set a password for your DBMS and follow the on-screen instructions. Once the MariaDB (or MySQL) installation is complete, the following message should appear: +>> +>> ![env dev web](images/success_msg_mariadb.png){.thumbnail} +>> +> PostgreSQL +>> Install PostgreSQL and the corresponding PHP extension: +>> +>> ```bash +>> sudo apt install -y postgresql postgresql-contrib php-pgsql +>> ``` +>> +>> Create a database and a user (example): +>> +>> ```bash +>> sudo -u postgres psql -c "CREATE DATABASE db_name;" +>> sudo -u postgres psql -c "CREATE USER db_user WITH ENCRYPTED PASSWORD 'strong_password';" +>> sudo -u postgres psql -c "GRANT ALL PRIVILEGES ON DATABASE db_name TO db_user;" +>> ``` ### Conclusion -You have just installed PHP, an Nginx server and MariaDB DBMS. You now have a functional web development environment on your VPS or OVHcloud dedicated server. If you wish, you can now install the CMS (**C**ontent **M**anagement **S**ystem) of your choice, such as WordPress. To find out more, please read the guides “[How to install WordPress with WP-CLI on a VPS or a dedicated server](/pages/bare_metal_cloud/virtual_private_servers/install_wordpress_site_on_vps)” and “[How to install WordPress with Docker on a VPS or a dedicated server](/pages/bare_metal_cloud/virtual_private_servers/install_wordpress_docker_on_vps)”. +You have just installed PHP, an Nginx server, and a DBMS (MariaDB/MySQL or PostgreSQL). You now have a functional web development environment on your VPS or OVHcloud dedicated server. If you wish, you can now install the CMS (**C**ontent **M**anagement **S**ystem) of your choice, such as WordPress. To find out more, please read the guides “[How to install WordPress with WP-CLI on a VPS or a dedicated server](/pages/bare_metal_cloud/virtual_private_servers/install_wordpress_site_on_vps)” and “[How to install WordPress with Docker on a VPS or a dedicated server](/pages/bare_metal_cloud/virtual_private_servers/install_wordpress_docker_on_vps)”. For some general tips on securing a GNU/Linux-based server, see our guides: diff --git a/pages/bare_metal_cloud/virtual_private_servers/install_env_web_dev_on_vps/guide.fr-ca.md b/pages/bare_metal_cloud/virtual_private_servers/install_env_web_dev_on_vps/guide.fr-ca.md index 8412a4f490c..ef2122be672 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/install_env_web_dev_on_vps/guide.fr-ca.md +++ b/pages/bare_metal_cloud/virtual_private_servers/install_env_web_dev_on_vps/guide.fr-ca.md @@ -1,7 +1,7 @@ --- title: 'Installer un environnement de développement web sur un VPS ou un serveur dédié' excerpt: 'Découvrez comment installer un environnement de développement web sur un VPS ou un serveur dédié OVHcloud' -updated: 2024-03-13 +updated: 2025-10-15 --- ## Objectif @@ -9,7 +9,7 @@ updated: 2024-03-13 Si vous souhaitez installer un CMS (**C**ontent **M**anagement **S**ystem) sur votre VPS (comme WordPress par exemple), vous devez au préalable installer un environnement de développement web sur votre VPS ou votre serveur dédié. Les principaux services à installer sont : - **PHP** : PHP est l'un des langages les plus utilisés pour créer des sites web. Il est nécessaire d'installer PHP pour que votre site web puisse exécuter des scripts et des fonctionnalités dynamiques. Installez de préférence la version de PHP la plus récente. -- **Serveur Web** : Le serveur web est essentiel pour servir les pages de votre site web. Les serveurs web les plus populaires incluent Apache et Nginx, chacun ayant leurs propres avantages en termes de flexibilité, de performance et de facilité de configuration. +- **Serveur web** : Le serveur web est essentiel pour servir les pages de votre site web. Les serveurs web les plus populaires incluent Apache et Nginx, chacun ayant leurs propres avantages en termes de flexibilité, de performance et de facilité de configuration. - **SGBD** : Pour stocker, gérer, et récupérer vos données efficacement, vous aurez besoin d'un SGBD (**S**ystème de **G**estion de **B**ase de **D**onnées). MySQL, PostgreSQL ou encore MariaDB sont les SGBD les plus utilisés dans le développement web. **Découvrez comment installer manuellement un environnement de développement web sur un VPS ou un serveur dédié OVHcloud.** @@ -30,18 +30,32 @@ Si vous souhaitez installer un CMS (**C**ontent **M**anagement **S**ystem) sur v Connectez-vous en SSH à votre VPS à l'aide de votre nom d'utilisateur et de votre mot de passe. +### Mettre à jour l’index des paquets + +Avant d’installer les composants, mettez à jour la liste des paquets : + +```bash +sudo apt update +``` + +Appliquez les mises à jour disponibles : + +```bash +sudo apt -y upgrade +``` + ### Installer PHP Installez PHP : -```sh -~$ sudo apt install php php-cli php-mysql php-xml php-gd php-curl -y +```bash +sudo apt install -y php php-cli php-fpm php-xml php-gd php-curl ``` Pour vérifier que PHP est bien installé, entrez la commande suivante : -```sh -~$ sudo php -v +```bash +sudo php -v ``` Si PHP est bien installé, un message de ce type doit apparaître : @@ -57,14 +71,14 @@ Si PHP est bien installé, un message de ce type doit apparaître : Installez Nginx : -```sh -~$ sudo apt install nginx -y +```bash +sudo apt install nginx -y ``` Pour vérifier que Nginx est bien installé, entrez la commande suivante : -```sh -~$ sudo nginx -v +```bash +sudo nginx -v ``` Si Nginx est bien installé, un message de ce type doit apparaître : @@ -77,28 +91,44 @@ En cas de besoin, n'hésitez pas à consulter le [site officiel de Nginx](https: > [!primary] > -> Pour ce guide, nous choisissons MariaDB mais vous êtes libre d'installer le SGBD de votre choix. -> - -Installez MariaDB : - -```sh -~$ sudo apt install mariadb-server -y -``` - -Sécurisez et configurez MariaDB : - -```sh -~$ sudo mysql_secure_installation -``` - -Définissez un mot de passe pour votre SGBD et suivez les instructions à l'écran. Une fois l'installation de MariaDB terminée, le message suivant doit s'afficher : - -![env dev web](images/success_msg_mariadb.png){.thumbnail} +> Choisissez l’onglet correspondant au SGBD que vous souhaitez utiliser. L’extension PHP adéquate est installée dans chaque cas. + +> [!tabs] +> MySQL / MariaDB +>> Installez MariaDB (ou MySQL) et l’extension PHP associée : +>> +>> ```bash +>> sudo apt install -y mariadb-server php-mysql +>> ``` +>> +>> Sécurisez l'installation : +>> +>> ```bash +>> sudo mysql_secure_installation +>> ``` +>> +>> Définissez un mot de passe pour votre SGBD et suivez les instructions à l'écran. Une fois l'installation de MariaDB (ou MySQL) terminée, le message suivant doit s'afficher : +>> +>> ![env dev web](images/success_msg_mariadb.png){.thumbnail} +>> +> PostgreSQL +>> Installez PostgreSQL et l’extension PHP correspondante : +>> +>> ```bash +>> sudo apt install -y postgresql postgresql-contrib php-pgsql +>> ``` +>> +>> Créez une base et un utilisateur (exemple) : +>> +>> ```bash +>> sudo -u postgres psql -c "CREATE DATABASE db_name;" +>> sudo -u postgres psql -c "CREATE USER db_user WITH ENCRYPTED PASSWORD 'mot_de_passe_fort';" +>> sudo -u postgres psql -c "GRANT ALL PRIVILEGES ON DATABASE db_name TO db_user;" +>> ``` ### Conclusion -Vous venez d'installer PHP, un serveur Nginx et le SGBD MariaDB. Vous possédez désormais un environnement de développement web fonctionnel sur votre VPS ou votre serveur dédié OVHcloud. Si vous le souhaitez, vous pouvez maintenant installer le CMS (**C**ontent **M**anagement **S**ystem) de votre choix, comme WordPress par exemple. Pour en savoir plus, consultez les guides « [Installer WordPress avec WP-CLI sur un VPS ou un serveur dédié](/pages/bare_metal_cloud/virtual_private_servers/install_wordpress_site_on_vps) » et « [Installer WordPress avec Docker sur un VPS ou un serveur dédié](/pages/bare_metal_cloud/virtual_private_servers/install_wordpress_docker_on_vps) ». +Vous venez d'installer PHP, un serveur Nginx et un SGBD (MariaDB/MySQL ou PostgreSQL). Vous possédez désormais un environnement de développement web fonctionnel sur votre VPS ou votre serveur dédié OVHcloud. Si vous le souhaitez, vous pouvez maintenant installer le CMS (**C**ontent **M**anagement **S**ystem) de votre choix, comme WordPress par exemple. Pour en savoir plus, consultez les guides « [Installer WordPress avec WP-CLI sur un VPS ou un serveur dédié](/pages/bare_metal_cloud/virtual_private_servers/install_wordpress_site_on_vps) » et « [Installer WordPress avec Docker sur un VPS ou un serveur dédié](/pages/bare_metal_cloud/virtual_private_servers/install_wordpress_docker_on_vps) ». Pour obtenir quelques conseils généraux pour sécuriser un serveur basé sur GNU/Linux, consultez nos guides : @@ -117,4 +147,4 @@ Pour obtenir quelques conseils généraux pour sécuriser un serveur basé sur G Pour des prestations spécialisées (référencement, développement, etc), contactez les [partenaires OVHcloud](/links/partner) -Échangez avec notre [communauté d'utilisateurs](/links/community). \ No newline at end of file +Échangez avec notre [communauté d'utilisateurs](/links/community). diff --git a/pages/bare_metal_cloud/virtual_private_servers/install_env_web_dev_on_vps/guide.fr-fr.md b/pages/bare_metal_cloud/virtual_private_servers/install_env_web_dev_on_vps/guide.fr-fr.md index 8412a4f490c..d4763a1625a 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/install_env_web_dev_on_vps/guide.fr-fr.md +++ b/pages/bare_metal_cloud/virtual_private_servers/install_env_web_dev_on_vps/guide.fr-fr.md @@ -1,7 +1,7 @@ --- title: 'Installer un environnement de développement web sur un VPS ou un serveur dédié' excerpt: 'Découvrez comment installer un environnement de développement web sur un VPS ou un serveur dédié OVHcloud' -updated: 2024-03-13 +updated: 2025-10-15 --- ## Objectif @@ -9,7 +9,7 @@ updated: 2024-03-13 Si vous souhaitez installer un CMS (**C**ontent **M**anagement **S**ystem) sur votre VPS (comme WordPress par exemple), vous devez au préalable installer un environnement de développement web sur votre VPS ou votre serveur dédié. Les principaux services à installer sont : - **PHP** : PHP est l'un des langages les plus utilisés pour créer des sites web. Il est nécessaire d'installer PHP pour que votre site web puisse exécuter des scripts et des fonctionnalités dynamiques. Installez de préférence la version de PHP la plus récente. -- **Serveur Web** : Le serveur web est essentiel pour servir les pages de votre site web. Les serveurs web les plus populaires incluent Apache et Nginx, chacun ayant leurs propres avantages en termes de flexibilité, de performance et de facilité de configuration. +- **Serveur web** : Le serveur web est essentiel pour servir les pages de votre site web. Les serveurs web les plus populaires incluent Apache et Nginx, chacun ayant leurs propres avantages en termes de flexibilité, de performance et de facilité de configuration. - **SGBD** : Pour stocker, gérer, et récupérer vos données efficacement, vous aurez besoin d'un SGBD (**S**ystème de **G**estion de **B**ase de **D**onnées). MySQL, PostgreSQL ou encore MariaDB sont les SGBD les plus utilisés dans le développement web. **Découvrez comment installer manuellement un environnement de développement web sur un VPS ou un serveur dédié OVHcloud.** @@ -30,18 +30,32 @@ Si vous souhaitez installer un CMS (**C**ontent **M**anagement **S**ystem) sur v Connectez-vous en SSH à votre VPS à l'aide de votre nom d'utilisateur et de votre mot de passe. +### Mettre à jour l’index des paquets + +Avant d’installer les composants, mettez à jour la liste des paquets : + +```bash +sudo apt update +``` + +Appliquez les mises à jour disponibles : + +```bash +sudo apt -y upgrade +``` + ### Installer PHP Installez PHP : -```sh -~$ sudo apt install php php-cli php-mysql php-xml php-gd php-curl -y +```bash +sudo apt install -y php php-cli php-fpm php-xml php-gd php-curl ``` Pour vérifier que PHP est bien installé, entrez la commande suivante : -```sh -~$ sudo php -v +```bash +sudo php -v ``` Si PHP est bien installé, un message de ce type doit apparaître : @@ -57,14 +71,14 @@ Si PHP est bien installé, un message de ce type doit apparaître : Installez Nginx : -```sh -~$ sudo apt install nginx -y +```bash +sudo apt install nginx -y ``` Pour vérifier que Nginx est bien installé, entrez la commande suivante : -```sh -~$ sudo nginx -v +```bash +sudo nginx -v ``` Si Nginx est bien installé, un message de ce type doit apparaître : @@ -77,28 +91,44 @@ En cas de besoin, n'hésitez pas à consulter le [site officiel de Nginx](https: > [!primary] > -> Pour ce guide, nous choisissons MariaDB mais vous êtes libre d'installer le SGBD de votre choix. -> - -Installez MariaDB : - -```sh -~$ sudo apt install mariadb-server -y -``` - -Sécurisez et configurez MariaDB : - -```sh -~$ sudo mysql_secure_installation -``` - -Définissez un mot de passe pour votre SGBD et suivez les instructions à l'écran. Une fois l'installation de MariaDB terminée, le message suivant doit s'afficher : - -![env dev web](images/success_msg_mariadb.png){.thumbnail} +> Choisissez l’onglet correspondant au SGBD que vous souhaitez utiliser. L’extension PHP adéquate est installée dans chaque cas. + +> [!tabs] +> MySQL / MariaDB +>> Installez MariaDB (ou MySQL) et l’extension PHP associée : +>> +>> ```bash +>> sudo apt install -y mariadb-server php-mysql +>> ``` +>> +>> Sécurisez l'installation : +>> +>> ```bash +>> sudo mysql_secure_installation +>> ``` +>> +>> Définissez un mot de passe pour votre SGBD et suivez les instructions à l'écran. Une fois l'installation de MariaDB (ou MySQL) terminée, le message suivant doit s'afficher : +>> +>> ![env dev web](images/success_msg_mariadb.png){.thumbnail} +>> +> PostgreSQL +>> Installez PostgreSQL et l’extension PHP correspondante : +>> +>> ```bash +>> sudo apt install -y postgresql postgresql-contrib php-pgsql +>> ``` +>> +>> Créez une base et un utilisateur (exemple) : +>> +>> ```bash +>> sudo -u postgres psql -c "CREATE DATABASE db_name;" +>> sudo -u postgres psql -c "CREATE USER db_user WITH ENCRYPTED PASSWORD 'mot_de_passe_fort';" +>> sudo -u postgres psql -c "GRANT ALL PRIVILEGES ON DATABASE db_name TO db_user;" +>> ``` ### Conclusion -Vous venez d'installer PHP, un serveur Nginx et le SGBD MariaDB. Vous possédez désormais un environnement de développement web fonctionnel sur votre VPS ou votre serveur dédié OVHcloud. Si vous le souhaitez, vous pouvez maintenant installer le CMS (**C**ontent **M**anagement **S**ystem) de votre choix, comme WordPress par exemple. Pour en savoir plus, consultez les guides « [Installer WordPress avec WP-CLI sur un VPS ou un serveur dédié](/pages/bare_metal_cloud/virtual_private_servers/install_wordpress_site_on_vps) » et « [Installer WordPress avec Docker sur un VPS ou un serveur dédié](/pages/bare_metal_cloud/virtual_private_servers/install_wordpress_docker_on_vps) ». +Vous venez d'installer PHP, un serveur Nginx et un SGBD (MariaDB/MySQL ou PostgreSQL). Vous possédez désormais un environnement de développement web fonctionnel sur votre VPS ou votre serveur dédié OVHcloud. Si vous le souhaitez, vous pouvez maintenant installer le CMS (**C**ontent **M**anagement **S**ystem) de votre choix, comme WordPress par exemple. Pour en savoir plus, consultez les guides « [Installer WordPress avec WP-CLI sur un VPS ou un serveur dédié](/pages/bare_metal_cloud/virtual_private_servers/install_wordpress_site_on_vps) » et « [Installer WordPress avec Docker sur un VPS ou un serveur dédié](/pages/bare_metal_cloud/virtual_private_servers/install_wordpress_docker_on_vps) ». Pour obtenir quelques conseils généraux pour sécuriser un serveur basé sur GNU/Linux, consultez nos guides : diff --git a/pages/bare_metal_cloud/virtual_private_servers/install_ispmanager/guide.en-gb.md b/pages/bare_metal_cloud/virtual_private_servers/install_ispmanager/guide.en-gb.md new file mode 100644 index 00000000000..2605a3a2882 --- /dev/null +++ b/pages/bare_metal_cloud/virtual_private_servers/install_ispmanager/guide.en-gb.md @@ -0,0 +1,213 @@ +--- +title: 'How to install ISPmanager on a VPS or Dedicated Server' +excerpt: 'Discover how to install ISPmanager on your OVHcloud VPS or Dedicated Server and manage your websites, databases, and associated services' +updated: 2025-10-27 +--- + +## Objective + +[ISPmanager](https://www.ispmanager.com/) is an all-in-one web hosting panel that simplifies the management of websites, databases, accounts, TLS/Let’s Encrypt certificates, and associated services via a web interface. This guide explains how to install ISPmanager on a clean VPS or Dedicated Server and access the interface for initial configuration. + +**Discover how to install ISPmanager on an OVHcloud VPS or Dedicated Server.** + +> [!warning] +> +> OVHcloud provides services whose configuration, management, and responsibility fall to you. It is your responsibility to ensure their proper operation. +> +> We provide this tutorial to assist you with common tasks. However, we recommend contacting a [specialized provider](/links/partner) and/or the service publisher if you encounter difficulties. Indeed, we will not be able to provide assistance. For more information, see the [Go further](#go-further) section of this tutorial. +> + +## Requirements + +- A [VPS](/links/bare-metal/vps) or a [Dedicated Server](/links/bare-metal/bare-metal) in your [OVHcloud Control Panel](/links/manager) with a [recommended configuration for ISPmanager](https://www.ispmanager.com/docs/ispmanager/system-requirements). +- Administrator access (sudo) via SSH to your server. + +## Instructions + +### Step 1 — Connect and update the system + +#### Connect to the server + +Open a terminal and connect to your VPS (or Dedicated Server) using the following command: + +```bash +ssh user@IP_VPS +``` + +Replace: + +- `user` with your username. +- `IP_VPS` with your VPS's IP address. + +#### Update the system + +Update your operating system. This process may take several minutes. + +> [!tabs] +> Debian and Ubuntu +>> +>> ```bash +>> sudo apt update && sudo apt -y upgrade +>> ``` +>> +> AlmaLinux and Rocky Linux +>> +>> ```bash +>> sudo dnf -y update +>> ``` +>> + +### Step 2 — Open required ports on the firewall + +To allow incoming and outgoing connections, consult the [official ISPmanager documentation](https://www.ispmanager.com/docs/ispmanager/system-requirements#firewall) to determine which ports to open based on your needs. + +#### Example of opening ports for Debian / Ubuntu + +1\. Install `UFW`: + +```bash +sudo apt -y install ufw +``` + +2\. Open the necessary ports (examples: SSH, ISPmanager panel, HTTP/HTTPS): + +```bash +sudo ufw allow 22/tcp +sudo ufw allow 1500/tcp +sudo ufw allow 80/tcp +sudo ufw allow 443/tcp +``` + +3\. Enable `UFW` and check its status (the value "ALLOW" is expected): + +```bash +sudo ufw enable +sudo ufw status +``` + +#### Example of opening ports for AlmaLinux + +1\. Install `firewalld`: + +```bash +sudo dnf -y install firewalld +``` + +2\. Enable and start the service: + +```bash +sudo systemctl enable --now firewalld +``` + +3\. Open the necessary ports (examples: SSH, ISPmanager panel, HTTP/HTTPS): + +```bash +sudo firewall-cmd --add-service=ssh --permanent +sudo firewall-cmd --add-service=http --permanent +sudo firewall-cmd --add-service=https --permanent +sudo firewall-cmd --add-port=1500/tcp --permanent +``` + +4\. Apply the configuration: + +```bash +sudo firewall-cmd --reload +sudo firewall-cmd --list-all +``` + +### Step 3 — Install ISPmanager + +1\. Install `wget`: + +> [!tabs] +> Debian and Ubuntu +>> +>> ```bash +>> sudo apt -y install wget +>> ``` +>> +> AlmaLinux 9 and Rocky Linux 8 +>> +>> ```bash +>> sudo dnf -y install wget +>> +>> ``` + +2\. Download the ISPmanager installation script: + +```bash +wget https://download.ispmanager.com/install.eu.sh -O install.eu.sh +``` + +3\. Run the installer: + +```bash +sudo sh install.eu.sh +``` + +During installation: + +- Choose the stable branch. +- Select the edition (Lite/Pro/Host) with recommended components. +- Choose your preferred web server and database. +- The installer installs necessary dependencies (this may take several minutes). + +#### "Incorrect hostname" message during installation + +If the following message appears during installation: + +```console +You have incorrect hostname: vps-xxxx-vps-ovh-net +Enter new hostname (or Ctrl+C to exit): +``` + +This means your server's hostname is not a fully qualified domain name (FQDN). To proceed, enter a valid domain name pointing to your server, for example: + +```console +ispmanager.mondomaine.ovh +``` + +If you do not yet have a domain name linked to your VPS, consult our guide "[Edit an OVHcloud DNS zone](/pages/web_cloud/domains/dns_zone_edit)" to point your domain name to your VPS's IP address. + +### Step 4 — First connection + +Once installation is complete, enter the URL `https://:1500/ispmgr` in your browser, replacing `` with your VPS's IP address. + +> [!primary] +> +> On first access, a self-signed certificate is used. Accept the browser warning to continue. + +The following interface appears: + +![ispmanager install](images/ispmanager-setup-interface.png){.thumbnail} + +By default, the first connection to the ISPmanager interface uses the server's `root` system account. If you connect via SSH with a non-root user (e.g., `almalinux`, `debian`, `ubuntu`) and `root` has no password, run the following commands: + +Switch to root: + +```bash +sudo -i +``` + +Set a password for the root user: + +```bash +passwd root +``` + +On the ISPmanager login interface, enter the following: + +- Username: **root**. +- Password: the password for the **root** account you just set. + +Accept the license agreement that appears to continue. Installation is complete, and the ISPmanager administration interface is accessible at `https://:1500/ispmgr`. + +## Go further + +[Secure a VPS](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps) + +[Secure a Dedicated Server](/pages/bare_metal_cloud/dedicated_servers/securing-a-dedicated-server) + +For specialized services (SEO, development, etc.), contact [OVHcloud partners](/links/partner) + +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/install_ispmanager/guide.fr-fr.md b/pages/bare_metal_cloud/virtual_private_servers/install_ispmanager/guide.fr-fr.md new file mode 100644 index 00000000000..27919f9c206 --- /dev/null +++ b/pages/bare_metal_cloud/virtual_private_servers/install_ispmanager/guide.fr-fr.md @@ -0,0 +1,213 @@ +--- +title: 'Comment installer ISPmanager sur un VPS ou un Serveur Dédié' +excerpt: 'Découvrez comment installer ISPmanager sur votre VPS ou Serveur Dédié OVHcloud et gérer vos sites web, bases de données et services associés' +updated: 2025-10-27 +--- + +## Objectif + +[ISPmanager](https://www.ispmanager.com/) est un panneau d’hébergement web tout-en-un qui facilite la gestion des sites web, bases de données, comptes, certificats TLS/Let’s Encrypt et services associés via une interface web. Ce guide vous explique comment installer ISPmanager sur un VPS ou un serveur dédié vierge et accéder à l’interface pour la configuration initiale. + +**Découvrez comment installer ISPmanager sur un VPS ou un Serveur Dédié OVHcloud.** + +> [!warning] +> +> OVHcloud met à votre disposition des services dont la configuration, la gestion et la responsabilité vous incombent. Il vous revient de ce fait d’en assurer le bon fonctionnement. +> +> Nous mettons à votre disposition ce tutoriel afin de vous accompagner au mieux sur des tâches courantes. Néanmoins, nous vous recommandons de faire appel à un [prestataire spécialisé](/links/partner) et/ou de contacter l’éditeur du service si vous éprouvez des difficultés. En effet, nous ne serons pas en mesure de vous fournir une assistance. Plus d’informations dans la section [Aller plus loin](#go-further) de ce tutoriel. +> + +## Prérequis + +- Disposer d’une offre [VPS](/links/bare-metal/vps) ou d’un [Serveur Dédié](/links/bare-metal/bare-metal) dans votre [espace client OVHcloud](/links/manager) avec une [configuration recommandée pour ISPmanager](https://www.ispmanager.com/docs/ispmanager/system-requirements). +- Disposer d’un accès administrateur (sudo) via SSH à votre serveur. + +## En pratique + +### Étape 1 — Connexion et mise à jour du système + +#### Se connecter au serveur + +Ouvrez un terminal et connectez-vous à votre VPS (ou à votre serveur dédié) avec la commande suivante : + +```bash +ssh user@IP_VPS +``` + +Remplacez : + +- `user` par votre nom d’utilisateur. +- `IP_VPS` par l’adresse IP de votre VPS. + +#### Mettre à jour le système + +Mettez votre système d’exploitation à jour. Cette opération peut prendre plusieurs minutes. + +> [!tabs] +> Debian et Ubuntu +>> +>> ```bash +>> sudo apt update && sudo apt -y upgrade +>> ``` +>> +> AlmaLinux et Rocky Linux +>> +>> ```bash +>> sudo dnf -y update +>> ``` +>> + +### Étape 2 — Ouvrir les ports nécessaires sur le pare-feu + +Pour autoriser les connexions entrantes et sortantes, consultez la [documentation officielle d’ISPmanager](https://www.ispmanager.com/docs/ispmanager/system-requirements#firewall) pour connaître les ports à ouvrir selon vos besoins. + +#### Exemple d’ouverture de ports pour Debian / Ubuntu + +1\. Installez `UFW` : + +```bash +sudo apt -y install ufw +``` + +2\. Ouvrez les ports nécessaires (exemples : SSH, panneau ISPmanager, HTTP/HTTPS) : + +```bash +sudo ufw allow 22/tcp +sudo ufw allow 1500/tcp +sudo ufw allow 80/tcp +sudo ufw allow 443/tcp +``` + +3\. Activez `UFW` et vérifiez son statut (la valeur « ALLOW » est attendue) : + +```bash +sudo ufw enable +sudo ufw status +``` + +#### Exemple d’ouverture de ports pour AlmaLinux + +1\. Installez `firewalld` : + +```bash +sudo dnf -y install firewalld +``` + +2\. Activez et démarrez le service : + +```bash +sudo systemctl enable --now firewalld +``` + +3\. Ouvrez les ports nécessaires (exemples : SSH, panneau ISPmanager, HTTP/HTTPS) : + +```bash +sudo firewall-cmd --add-service=ssh --permanent +sudo firewall-cmd --add-service=http --permanent +sudo firewall-cmd --add-service=https --permanent +sudo firewall-cmd --add-port=1500/tcp --permanent +``` + +4\. Appliquez la configuration : + +```bash +sudo firewall-cmd --reload +sudo firewall-cmd --list-all +``` + +### Étape 3 — Installer ISPmanager + +1\. Installez `wget` : + +> [!tabs] +> Debian et Ubuntu +>> +>> ```bash +>> sudo apt -y install wget +>> ``` +>> +> AlmaLinux 9 et Rocky Linux 8 +>> +>> ```bash +>> sudo dnf -y install wget +>> +>> ``` + +2\. Téléchargez le script d’installation d'ISPmanager : + +```bash +wget https://download.ispmanager.com/install.eu.sh -O install.eu.sh +``` + +3\. Lancez l’installeur : + +```bash +sudo sh install.eu.sh +``` + +Pendant l’installation : + +- Choisissez la branche stable. +- Sélectionnez l’édition (Lite/Pro/Host) avec les composants recommandés. +- Choisissez le serveur web et la base de données de votre choix. +- L’installeur installe les dépendances nécessaires (cela peut prendre plusieurs minutes). + +#### Message « Incorrect hostname » pendant l’installation + +Si le message suivant s’affiche pendant l’installation : + +```console +You have incorrect hostname: vps-xxxx-vps-ovh-net +Enter new hostname (or Ctrl+C to exit): +``` + +Cela signifie que le nom d’hôte (hostname) de votre serveur n’est pas un nom de domaine complet (FQDN). Pour continuer, entrez un nom de domaine valide qui pointe vers votre serveur, par exemple : + +```console +ispmanager.mondomaine.ovh +``` + +Si vous ne disposez pas encore d’un nom de domaine lié à votre VPS, consultez notre guide « [Éditer une zone DNS OVHcloud](/pages/web_cloud/domains/dns_zone_edit) » pour faire pointer votre nom de domaine vers l’adresse IP de votre VPS. + +### Étape 4 — Première connexion + +Une fois l’installation terminée, entrez l’URL `https://:1500/ispmgr` dans votre navigateur en remplaçant `` par l’adresse IP de votre VPS. + +> [!primary] +> +> Au premier accès, un certificat auto-signé est utilisé. Acceptez l’avertissement du navigateur pour continuer. + +L’interface ci-dessous s’affiche : + +![ispmanager install](images/ispmanager-setup-interface.png){.thumbnail} + +Par défaut, la première connexion à l’interface d’ISPmanager se fait avec le compte système `root` du serveur. Si vous vous connectez en SSH avec un utilisateur non-root (ex : `almalinux`, `debian`, `ubuntu`) et que `root` n’a pas de mot de passe, exécutez les lignes de commande suivantes : + +Passez en root : + +```bash +sudo -i +``` + +Définissez un mot de passe pour l’utilisateur root : + +```bash +passwd root +``` + +Sur l’interface de connexion d’ISPmanager, entrez les valeurs suivantes : + +- Identifiant : **root**. +- Mot de passe : le mot de passe du compte **root** que vous venez de définir. + +Acceptez le contrat de licence qui s’affiche pour continuer. L’installation est terminée et l’interface d’administration d’ISPmanager est accessible à l’adresse `https://:1500/ispmgr`. + +## Aller plus loin + +[Sécuriser un VPS](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps) + +[Sécuriser un serveur dédié](/pages/bare_metal_cloud/dedicated_servers/securing-a-dedicated-server) + +Pour des prestations spécialisées (référencement, développement, etc.), contactez les [partenaires OVHcloud](/links/partner) + +Échangez avec notre [communauté d’utilisateurs](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/install_ispmanager/images/ispmanager-setup-interface.png b/pages/bare_metal_cloud/virtual_private_servers/install_ispmanager/images/ispmanager-setup-interface.png new file mode 100644 index 00000000000..fb450e91b27 Binary files /dev/null and b/pages/bare_metal_cloud/virtual_private_servers/install_ispmanager/images/ispmanager-setup-interface.png differ diff --git a/pages/bare_metal_cloud/virtual_private_servers/install_ispmanager/meta.yaml b/pages/bare_metal_cloud/virtual_private_servers/install_ispmanager/meta.yaml new file mode 100644 index 00000000000..7789f5641e6 --- /dev/null +++ b/pages/bare_metal_cloud/virtual_private_servers/install_ispmanager/meta.yaml @@ -0,0 +1,3 @@ +id: 71517ef2-d81a-4f38-9385-9aaf6b279e46 +full_slug: vps-install-ispmanager +reference_category: bare-metal-cloud-virtual-private-servers-tutorials \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/install_n8n_on_vps/guide.en-gb.md b/pages/bare_metal_cloud/virtual_private_servers/install_n8n_on_vps/guide.en-gb.md index 2773b618f72..96b0436da67 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/install_n8n_on_vps/guide.en-gb.md +++ b/pages/bare_metal_cloud/virtual_private_servers/install_n8n_on_vps/guide.en-gb.md @@ -1,12 +1,12 @@ --- title: "How to install n8n on an OVHcloud VPS" excerpt: "Find out how to host the n8n automation platform on an OVHcloud VPS using Docker and Traefik" -updated: 2025-08-25 +updated: 2025-09-23 --- ## Objective -This guide explains how to install and run [n8n](https://n8n.io), an open-source platform for workflow automation, on an OVHcloud VPS. The installation relies on [Docker](https://www.docker.com/), with the server [Traefik](https://doc.traefik.io/traefik/) to automatically manage SSL certificates. +This guide explains how to install and run [n8n](https://n8n.io), an open-source platform for workflow automation, on an OVHcloud VPS. [Manual installation](#step3) relies on [Docker](https://www.docker.com/), with the server [Traefik](https://doc.traefik.io/traefik/) to automatically manage SSL certificates. For a [turn-key setup](#step2), opt for an [OVHcloud preinstalled n8n VPS](/links/bare-metal/vps-n8n). ## Requirements @@ -37,15 +37,22 @@ ssh @IP_VPS If you have chosen an OVHcloud **VPS with the n8n image pre-installed**, **you do not need to install Docker or Docker Compose** : these tools are already present and configured. -Find all the necessary files (including `docker-compose.yml` and `.env`) in the `/debian/n8n/` folder on your VPS. +Find all the necessary files (including `docker-compose.yml` and `.env`) in the `/home/debian/n8n/` folder on your VPS. -Edit the file `.env` located in this folder to enter the following information: +Navigate to the `/home/debian/n8n/` folder and edit the `.env` file: + +```bash +cd /home/debian/n8n/ +nano .env +``` + +Enter the following information: - `DOMAIN_NAME`: your domain name (e.g. `vps.ovh.net`). - `SUBDOMAIN`: the subdomain used to access n8n (e.g. `vps-xxxxxxx`). -- `EMAIL`: the email address used to generate SSL certificates via Let’s Encrypt. +- `SSL_EMAIL`: the email address used to generate SSL certificates via Let’s Encrypt. -Once you have updated the file `.env`, run the following command from the directory `/root/n8n-traefik/`: +Once you have updated the file `.env`, run the following command from the directory `/home/debian/n8n/`: ```bash docker compose up -d @@ -121,10 +128,10 @@ nano .env Paste the following content into it: -```console +```ini DOMAIN_NAME=example.com SUBDOMAIN=n8n -EMAIL=admin@example.com +SSL_EMAIL=admin@example.com ``` Replace `example.com` with your real domain name and `admin@example.com` with the email of your choice. @@ -148,7 +155,7 @@ nano docker-compose.yml Paste the following content: -```console +```yaml services: traefik: image: traefik:v2.11 @@ -161,7 +168,7 @@ services: - "--entrypoints.websecure.address=:443" - "--certificatesresolvers.myresolver.acme.httpchallenge=true" - "--certificatesresolvers.myresolver.acme.httpchallenge.entrypoint=web" - - "--certificatesresolvers.myresolver.acme.email=${EMAIL}" + - "--certificatesresolvers.myresolver.acme.email=${SSL_EMAIL}" - "--certificatesresolvers.myresolver.acme.storage=/letsencrypt/acme.json" ports: - "80:80" diff --git a/pages/bare_metal_cloud/virtual_private_servers/install_n8n_on_vps/guide.fr-fr.md b/pages/bare_metal_cloud/virtual_private_servers/install_n8n_on_vps/guide.fr-fr.md index 25645759a11..a8da48b5b6f 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/install_n8n_on_vps/guide.fr-fr.md +++ b/pages/bare_metal_cloud/virtual_private_servers/install_n8n_on_vps/guide.fr-fr.md @@ -1,12 +1,12 @@ --- title: "Comment installer n8n sur un VPS OVHcloud" excerpt: "Découvrez comment héberger la plateforme d’automatisation n8n sur un VPS OVHcloud à l’aide de Docker et Traefik" -updated: 2025-08-25 +updated: 2025-09-23 --- ## Objectif -Ce guide vous explique comment installer et exécuter [n8n](https://n8n.io), une plateforme open source d’automatisation de workflows, sur un VPS OVHcloud. L’installation s’appuie sur [Docker](https://www.docker.com/), avec le serveur [Traefik](https://doc.traefik.io/traefik/) pour gérer automatiquement les certificats SSL. +Ce guide vous explique comment installer et exécuter [n8n](https://n8n.io), une plateforme open source d’automatisation de workflows, sur un VPS OVHcloud. [L’installation manuelle](#step3) s’appuie sur [Docker](https://www.docker.com/), avec le serveur [Traefik](https://doc.traefik.io/traefik/) pour gérer automatiquement les certificats SSL. Pour une [mise en route clé en main](#step2), optez pour un [VPS n8n préinstallé OVHcloud](/links/bare-metal/vps-n8n). ## Prérequis @@ -37,15 +37,22 @@ ssh @IP_VPS Si vous avez choisi un **VPS OVHcloud avec l’image n8n préinstallée**, **vous n’avez pas besoin d’installer Docker ni Docker Compose** : ces outils sont déjà présents et configurés. -Retrouvez tous les fichiers nécessaires (y compris `docker-compose.yml` et `.env`) dans le dossier `/debian/n8n/` sur votre VPS. +Retrouvez tous les fichiers nécessaires (y compris `docker-compose.yml` et `.env`) dans le dossier `/home/debian/n8n/` sur votre VPS. -Modifiez le fichier `.env` situé dans ce dossier pour y renseigner les informations suivantes : +Dirigez-vous dans le dossier `/home/debian/n8n/` et modifiez le fichier `.env` : + +```bash +cd /home/debian/n8n/ +nano .env +``` + +Renseignez-y les informations suivantes : - `DOMAIN_NAME` : votre nom de domaine (ex : `vps.ovh.net`). - `SUBDOMAIN` : le sous-domaine utilisé pour accéder à n8n (ex : `vps-xxxxxxx`). -- `EMAIL` : l’adresse e-mail utilisée pour générer les certificats SSL via Let’s Encrypt. +- `SSL_EMAIL` : l’adresse e-mail utilisée pour générer les certificats SSL via Let’s Encrypt. -Une fois le fichier `.env` mis à jour, exécutez la commande suivante depuis le dossier `/root/n8n-traefik/` : +Une fois le fichier `.env` mis à jour, exécutez la commande suivante (depuis le dossier `/home/debian/n8n/`) : ```bash docker compose up -d @@ -121,10 +128,10 @@ nano .env Collez-y le contenu suivant : -```console +```ini DOMAIN_NAME=exemple.com SUBDOMAIN=n8n -EMAIL=admin@exemple.com +SSL_EMAIL=admin@exemple.com ``` Remplacez `exemple.com` par votre véritable nom de domaine et `admin@exemple.com` par l'e-mail de votre choix. @@ -148,7 +155,7 @@ nano docker-compose.yml Collez le contenu suivant : -```console +```yaml services: traefik: image: traefik:v2.11 @@ -161,7 +168,7 @@ services: - "--entrypoints.websecure.address=:443" - "--certificatesresolvers.myresolver.acme.httpchallenge=true" - "--certificatesresolvers.myresolver.acme.httpchallenge.entrypoint=web" - - "--certificatesresolvers.myresolver.acme.email=${EMAIL}" + - "--certificatesresolvers.myresolver.acme.email=${SSL_EMAIL}" - "--certificatesresolvers.myresolver.acme.storage=/letsencrypt/acme.json" ports: - "80:80" diff --git a/pages/bare_metal_cloud/virtual_private_servers/minecraft_server_on_vps/images/download_jar.png b/pages/bare_metal_cloud/virtual_private_servers/minecraft_server_on_vps/images/download_jar.png deleted file mode 100644 index 090ef452c52..00000000000 Binary files a/pages/bare_metal_cloud/virtual_private_servers/minecraft_server_on_vps/images/download_jar.png and /dev/null differ diff --git a/pages/bare_metal_cloud/virtual_private_servers/n8n_sms/guide.en-gb.md b/pages/bare_metal_cloud/virtual_private_servers/n8n_sms/guide.en-gb.md new file mode 100644 index 00000000000..ed2fddd7eee --- /dev/null +++ b/pages/bare_metal_cloud/virtual_private_servers/n8n_sms/guide.en-gb.md @@ -0,0 +1,245 @@ +--- +title: "Automate SMS sending with n8n via the OVHcloud API" +excerpt: "Find out how to send SMS from n8n using the OVHcloud API" +updated: 2025-12-02 +--- + +## Objective + +This guide explains how to integrate the OVHcloud SMS API into **n8n**, in order to automatically send SMS from your workflows. You will learn how to configure a signed HTTP call via the OVHcloud API to trigger the sending of a message. + +**Find out how to send SMS from n8n using the OVHcloud API.** + +## Requirements + +- An [OVHcloud SMS account](/links/telecom/sms) and a valid [SMS sender](/pages/web_cloud/messaging/sms/tout_savoir_sur_les_expediteurs_sms). +- An [OVHcloud VPS](/links/bare-metal/vps), a server, or a local machine with [n8n](https://n8n.io/) installed and accessible. + +## Instructions + +If you have not yet installed [n8n](https://n8n.io/) on your VPS, follow the instructions in our guide "[How to install n8n on an OVHcloud VPS](/pages/bare_metal_cloud/virtual_private_servers/install_n8n_on_vps)". + +### Step 1 – Generate OVHcloud API credentials + +Before you can send SMS via the OVHcloud API, you must have the following three identifiers: + +- Application key +- Application secret +- Consumer key + +To do this, consult the section **Advanced usage: pair OVHcloud APIs with an application** in our guide "[First Steps with the OVHcloud APIs](/pages/manage_and_operate/api/first-steps)", then copy and save the three identifiers `Application key`, `Application secret` and `Consumer key`. + +### Step 2 – Create the workflow and nodes + +Log in to your n8n interface and click the **Create Workflow** button. + +Create the following nodes (empty for now): + +- `Set - Credentials`: of type **Edit Fields (Set)**. +- `Set - Request Details`: of type **Edit Fields (Set)**. +- `Merge`: of type **Merge**. +- `Sign - Generate Signature`: of type **Code**. +- `SMS - Send`: of type **HTTP Request**. + +For more details on creating nodes, see the [official n8n documentation](https://docs.n8n.io/integrations/creating-nodes/overview/). + +Connect the nodes in this order: + +![N8N SMS](images/nodes.png){.thumbnail} + +The `Merge` node receives the outputs from the two `Set - Credentials` and `Set - Request Details` nodes, then feeds into `Sign - Generate Signature`, which feeds into `SMS - Send`. + +### Step 3 – Configure the `Set – Credentials` node + +Add the following parameters to your `Set - Credentials` node: + +- Mode: `Manual Mapping`. + +| Name | Value | +| ----------------- | ----------------------------------------------------------- | +| applicationKey | "YOUR_APPLICATION_KEY" | +| consumerKey | "YOUR_CONSUMER_KEY" | +| serviceName | "YOUR_OVHCLOUD_SMS_ACCOUNT" (e.g. "sms-ab12345-1") | +| applicationSecret | "YOUR_APPLICATION_SECRET" | +| timestamp | {{ Math.floor(Date.now() / 1000) }} | + +### Step 4 – Configure the `Set – Request Details` node + +Configure the `Set - Request Details` node: + +- Mode: `Manual Mapping`. +- Add a field named `body` of type `Object` with the content below (minimal example). + +```json +{ + "charset": "UTF-8", + "coding": "7bit", + "message": "Test message", + "noStopClause": true, + "priority": "high", + "receivers": ["+33612345678"], + "sender": "Your_sender" +} +``` + +> [!primary] +> +> - The recipient's number (`receivers`) must be in international format and for example start with "+336" or "+337" for a French mobile number. +> - [The sender must be defined in your OVHcloud account](/pages/web_cloud/messaging/sms/tout_savoir_sur_les_expediteurs_sms). To perform a test without declaring a sender and using a short number, replace `"sender": "Your_sender"` with `"senderForResponse": true`. + +### Step 5 – Configure the `Merge` node + +Configure the `Merge` node: + +- Mode: `Combine`. +- Combine by: `Position`. +- Number of Inputs: `2`. + +Connect `Set - Credentials` to **Input 1** and `Set - Request Details` to **Input 2**.
+At the output (output), you should have at the same level: `applicationKey`, `applicationSecret`, `consumerKey`, `serviceName`, `timestamp` and `body`. + +### Step 6 – Configure the `Sign – Generate Signature` node + +Configure the `Sign - Generate Signature` node: + +- Mode: `Run once for each item`. +- Language: `JavaScript`. + +Paste the code below: + +```js +// --- SHA1 pure (not HMAC) --- +function sha1(input) { + function rotl(n, s) { return (n << s) | (n >>> (32 - s)); } + function hex(v){ let s=''; for(let i=7;i>=0;i--) s+=((v >>> (i*4)) & 0xf).toString(16); return s; } + function utf8(str){ + str=str.replace(/\r\n/g,'\n'); + let out=''; for (let i=0;i>6)|192, (c&63)|128); + else out+=String.fromCharCode((c>>12)|224, ((c>>6)&63)|128, (c&63)|128); + } return out; + } + let i,j,A,B,C,D,E,temp,H0=0x67452301,H1=0xEFCDAB89,H2=0x98BADCFE,H3=0x10325476,H4=0xC3D2E1F0; + const W=new Array(80), m=utf8(input), ml=m.length, wa=[]; + for(i=0;i>>29); wa.push((ml<<3)&0x0ffffffff); + for(let bs=0; bs [!warning] +> +> Do not use **HMAC** here (OVHcloud expects `"$1$" + SHA1(AppSecret + … + Timestamp)`). The `bodyString` parameter is **exactly** the JSON that will be sent next (no other `stringify`). The signed URL must be **strictly identical** to the sending URL (same host, no extra `/` at the end). + +### Step 7 – Configure the `SMS - Send` node + +Configure the `SMS - Send` node: + +- Method: `POST`. +- URL: `{{$json.url}}`. +- Authentication: `None`. +- Send Headers: `ON`. +- Specify Headers: `Using fields below`. + +Add the following header parameters: + +| Name | Value | +| ------------------ | -------------------------- | +| Content-Type | application/json | +| X-Ovh-Application | {{$json.applicationKey}} | +| X-Ovh-Consumer | {{$json.consumerKey}} | +| X-Ovh-Timestamp | {{$json.timestamp}} | +| X-Ovh-Signature | {{$json.signature}} | + +Enable `Send Body` and add the following body parameters: + +| Name | Value | +| ----------------- | -------------------- | +| Body Content Type | Raw | +| Content Type | application/json | +| Body | {{$json.bodyString}} | + +### Test your workflow + +Run your workflow. The following steps are executed: + +1. Set - Credentials: provides applicationKey, consumerKey, serviceName (and optionally applicationSecret if you have not externalized it). +2. Set - Request Details: prepares the body object containing the SMS body. +3. Merge (Combine/Position): merges the outputs of the previous two nodes. +4. Sign - Generate Signature (Code): calculates bodyString, timestamp, signature (simple SHA-1) and the call URL. +5. SMS - Send (HTTP Request): sends the POST to the URL with the body {{$json.bodyString}} and the X-Ovh-* headers. + +The message is then transmitted via the OVHcloud API to your recipient. + +### Common errors + +#### **Invalid_signature (400)** + +- The signed URL is different from the sent URL (different host, extra `/` at the end). +- The signed body is different from the sent body (re-`stringify`, spaces, order, etc.). +- The local clock is too far off. Rather use the OVHcloud server time (see the section [Industrialization and security](#industrialisation)). + +#### **SMS sender ... does not exist (403)** + +The `sender` (sender) is not declared/validated in your OVHcloud Control Panel. Test with `"senderForResponse": true` or validate your sender. + +#### **Bad Request** + +- Check in each node the name and value of your parameters. +- Make sure that the headers and body are complete. +- Check that the URL of the `SMS - Send` node follows the following format: `https://eu.api.ovh.com/1.0/sms/sms-ab12345-1/jobs` + +#### **Code node errors** + +- Do not use `require('crypto')` in n8n but rather the **pure JavaScript SHA-1** above. +- Use the *per item* mode and avoid calling `$input.all()` in your code. + +### Industrialization and security + +If you want to industrialize your workflow and make it more secure, apply the following tips. + +#### OVHcloud server time + +Add a **HTTP Request** node before the signature: + +- `GET https://eu.api.ovh.com/1.0/auth/time` +- Retrieve the value and replace `timestamp` with this **exact** value. + +#### Do not pass the `applicationSecret` + +- Store it as an **environment variable** (e.g. `OVH_APP_SECRET`) and read it in the Code node (Sign - Generate Signature) via `$env.OVH_APP_SECRET`, or via the **Secrets/Credentials** feature of n8n. +- Failing that, **never return** the secret at the output of the node. + +#### Character management + +If your message contains emojis/accents not in GSM, use `"coding": "ucs2"`. + +## Go further + +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/n8n_sms/guide.es-es.md b/pages/bare_metal_cloud/virtual_private_servers/n8n_sms/guide.es-es.md new file mode 100644 index 00000000000..f39730d7bae --- /dev/null +++ b/pages/bare_metal_cloud/virtual_private_servers/n8n_sms/guide.es-es.md @@ -0,0 +1,245 @@ +--- +title: "Automatizar el envío de SMS con n8n a través de la API de OVHcloud" +excerpt: "Descubra cómo enviar SMS desde n8n utilizando la API de OVHcloud" +updated: 2025-12-02 +--- + +## Objetivo + +Esta guía explica cómo integrar la API SMS de OVHcloud en **n8n**, para enviar automáticamente SMS desde sus workflows. Aprenderá a configurar una llamada HTTP firmada a través de la API de OVHcloud para desencadenar el envío de un mensaje. + +**Descubra cómo enviar SMS desde n8n utilizando la API de OVHcloud.** + +## Requisitos + +- Tener una [cuenta SMS de OVHcloud](/links/telecom/sms) y un [remitente SMS](/pages/web_cloud/messaging/sms/tout_savoir_sur_les_expediteurs_sms) válido. +- Tener un [VPS de OVHcloud](/links/bare-metal/vps), un servidor o una máquina local con [n8n](https://n8n.io/) instalado y accesible. + +## Procedimiento + +Si aún no ha instalado [n8n](https://n8n.io/) en su VPS, siga las instrucciones de nuestro tutorial "[Instalar n8n en un VPS de OVHcloud](/pages/bare_metal_cloud/virtual_private_servers/install_n8n_on_vps)". + +### Paso 1 – Generar las credenciales de la API de OVHcloud + +Antes de poder enviar SMS a través de la API de OVHcloud, debe disponer de los tres identificadores siguientes: + +- Application key +- Application secret +- Consumer key + +Para ello, consulte la sección **Uso avanzado: combinar las API de OVHcloud con una aplicación** de nuestro tutorial "[Primeros pasos con las API de OVHcloud](/pages/manage_and_operate/api/first-steps)", y copie y guarde los tres identificadores `Application key`, `Application secret` y `Consumer key`. + +### Paso 2 — Crear el workflow y los nodos + +Conéctese a su interfaz de n8n y haga clic en el botón **Create Workflow**. + +Cree los siguientes nodos (vacíos por ahora): + +- `Set - Credentials`: de tipo **Edit Fields (Set)**. +- `Set - Request Details`: de tipo **Edit Fields (Set)**. +- `Merge`: de tipo **Merge**. +- `Sign - Generate Signature`: de tipo **Code**. +- `SMS - Send`: de tipo **HTTP Request**. + +Para más detalles sobre la creación de nodos, consulte la [documentación oficial de n8n](https://docs.n8n.io/integrations/creating-nodes/overview/). + +Conecte los nodos en este orden: + +![N8N SMS](images/nodes.png){.thumbnail} + +El nodo `Merge` recibe las salidas de los dos nodos `Set - Credentials` y `Set - Request Details`, y luego alimenta `Sign - Generate Signature`, que alimenta `SMS - Send`. + +### Paso 3 — Configurar el nodo `Set – Credentials` + +Agregue los siguientes parámetros en su nodo `Set - Credentials`: + +- Mode: `Manual Mapping`. + +| Nombre | Valor | +| ----------------- | ----------------------------------------------------------- | +| applicationKey | "SU_APPLICATION_KEY" | +| consumerKey | "SU_CONSUMER_KEY" | +| serviceName | "SU_CUENTA_SMS_DE_OVHCLOUD" (por ejemplo: "sms-ab12345-1") | +| applicationSecret | "SU_APPLICATION_SECRET" | +| timestamp | {{ Math.floor(Date.now() / 1000) }} | + +### Paso 4 — Configurar el nodo `Set – Request Details` + +Configure el nodo `Set - Request Details`: + +- Mode: `Manual Mapping`. +- Agregue un campo llamado `body` de tipo `Object` con el contenido siguiente (ejemplo mínimo). + +```json +{ + "charset": "UTF-8", + "coding": "7bit", + "message": "Message test", + "noStopClause": true, + "priority": "high", + "receivers": ["+33612345678"], + "sender": "Your_sender" +} +``` + +> [!primary] +> +> - El número del destinatario (`receivers`) debe estar en formato internacional y comenzar, por ejemplo, por "+336" o "+337" para un número de móvil francés. +> - [El remitente debe estar definido en su cuenta de OVHcloud](/pages/web_cloud/messaging/sms/tout_savoir_sur_les_expediteurs_sms). Para realizar una prueba sin declarar un remitente y utilizar un número corto, reemplace `"sender": "Your_sender"` por `"senderForResponse": true`. + +### Paso 5 — Configurar el nodo `Merge` + +Configure el nodo `Merge`: + +- Mode: `Combine`. +- Combine by: `Position`. +- Number of Inputs: `2`. + +Conecte `Set - Credentials` en **Input 1** y `Set - Request Details` en **Input 2**.
+En salida (output), debe tener al mismo nivel: `applicationKey`, `applicationSecret`, `consumerKey`, `serviceName`, `timestamp` y `body`. + +### Paso 6 — Configurar el nodo `Sign – Generate Signature` + +Configure el nodo `Sign - Generate Signature`: + +- Mode: `Run once for each item`. +- Language: `JavaScript`. + +Pegue el código siguiente: + +```js +// --- SHA1 pure (not HMAC) --- +function sha1(input) { + function rotl(n, s) { return (n << s) | (n >>> (32 - s)); } + function hex(v){ let s=''; for(let i=7;i>=0;i--) s+=((v >>> (i*4)) & 0xf).toString(16); return s; } + function utf8(str){ + str=str.replace(/\r\n/g,'\n'); + let out=''; for (let i=0;i>6)|192, (c&63)|128); + else out+=String.fromCharCode((c>>12)|224, ((c>>6)&63)|128, (c&63)|128); + } return out; + } + let i,j,A,B,C,D,E,temp,H0=0x67452301,H1=0xEFCDAB89,H2=0x98BADCFE,H3=0x10325476,H4=0xC3D2E1F0; + const W=new Array(80), m=utf8(input), ml=m.length, wa=[]; + for(i=0;i>>29); wa.push((ml<<3)&0x0ffffffff); + for(let bs=0; bs [!warning] +> +> No utilice **HMAC** aquí (OVHcloud espera `"$1$" + SHA1(AppSecret + … + Timestamp)`). El parámetro `bodyString` es **exactamente** el JSON que se enviará después (sin otro `stringify`). La URL firmada debe ser **estrictamente idéntica** a la del envío (mismo host, sin `/` final adicional). + +### Paso 7 — Configurar el nodo `SMS - Send` + +Configure el nodo `SMS - Send`: + +- Method: `POST`. +- URL: `{{$json.url}}`. +- Authentication: `None`. +- Send Headers: `ON`. +- Specify Headers: `Using fields below`. + +Agregue los siguientes parámetros de header: + +| Nombre | Valor | +| ------------------ | -------------------------- | +| Content-Type | application/json | +| X-Ovh-Application | {{$json.applicationKey}} | +| X-Ovh-Consumer | {{$json.consumerKey}} | +| X-Ovh-Timestamp | {{$json.timestamp}} | +| X-Ovh-Signature | {{$json.signature}} | + +Active el `Send Body` y agregue los siguientes parámetros de body: + +| Nombre | Valor | +| ----------------- | -------------------- | +| Body Content Type | Raw | +| Content Type | application/json | +| Body | {{$json.bodyString}} | + +### Probar su workflow + +Ejecute su workflow. Los siguientes pasos se ejecutan: + +1. Set - Credentials: pone a disposición applicationKey, consumerKey, serviceName (y eventualmente applicationSecret si no lo ha externalizado). +2. Set - Request Details: prepara el objeto body conteniendo el cuerpo del SMS. +3. Merge (Combine/Position): fusiona las dos salidas de los nodos anteriores. +4. Sign - Generate Signature (Code): calcula bodyString, timestamp, signature (SHA‑1 simple) y la URL de llamada. +5. SMS - Send (HTTP Request): envía el POST hacia la URL con el body {{$json.bodyString}} y los headers X-Ovh-*. + +El mensaje se transmite entonces a través de la API de OVHcloud a su destinatario. + +### Errores frecuentes + +#### **Invalid_signature (400)** + +- La URL firmada es diferente de la URL enviada (host diferente, `/` final de más). +- El cuerpo firmado es diferente del cuerpo enviado (re-`stringify`, espacios, orden, etc.). +- El reloj local está demasiado desincronizado. Utilice mejor la hora del servidor OVHcloud (ver la parte [Industrialización y seguridad](#industrialisation)). + +#### **SMS sender ... does not exist (403)** + +El `sender` (remitente) no está declarado/validado en su área de cliente de OVHcloud. Pruebe con `"senderForResponse": true` o valide su remitente. + +#### **Bad Request** + +- Compruebe en cada nodo el nombre y el valor de sus parámetros. +- Asegúrese de que los headers y los body sean completos. +- Compruebe que la URL del nodo `SMS - Send` respete bien el siguiente formato: `https://eu.api.ovh.com/1.0/sms/sms-ab12345-1/jobs` + +#### **Errores de nodo Code** + +- No utilice `require('crypto')` en n8n sino más bien **SHA-1 pur JavaScript** arriba. +- Utilice el modo *por item* y evite llamar a `$input.all()` en su código. + +### Industrialización y seguridad + +Si desea industrializar su workflow y protegerlo más, aplique los siguientes consejos. + +#### Hora del servidor OVHcloud + +Agregue un nodo de tipo **HTTP Request** antes de la firma: + +- `GET https://eu.api.ovh.com/1.0/auth/time` +- Recupere el valor y reemplace `timestamp` por este valor **exacto**. + +#### No hacer transitar el `applicationSecret` + +- Almacénelo como **variable de entorno** (por ejemplo: `OVH_APP_SECRET`) y léalo en el nodo de tipo Code (Sign - Generate Signature) a través de `$env.OVH_APP_SECRET`, o a través de la funcionalidad **Secrets/Credentials** de n8n. +- A falta de ello, **nunca devuelva** el secreto en la salida del nodo. + +#### Gestión de caracteres + +Si su mensaje contiene emojis/acentos no GSM, utilice `"coding": "ucs2"`. + +## Más información + +Interactúe con nuestra [comunidad de usuarios](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/n8n_sms/guide.fr-fr.md b/pages/bare_metal_cloud/virtual_private_servers/n8n_sms/guide.fr-fr.md new file mode 100644 index 00000000000..d3b9099bffa --- /dev/null +++ b/pages/bare_metal_cloud/virtual_private_servers/n8n_sms/guide.fr-fr.md @@ -0,0 +1,245 @@ +--- +title: "Automatiser l'envoi de SMS avec n8n via l'API OVHcloud" +excerpt: "Découvrez comment envoyer des SMS depuis n8n en utilisant l'API OVHcloud" +updated: 2025-12-02 +--- + +## Objectif + +Ce guide vous explique comment intégrer l'API SMS d'OVHcloud dans **n8n**, afin d'envoyer automatiquement des SMS depuis vos workflows. Vous apprendrez à configurer un appel HTTP signé via l'API OVHcloud pour déclencher l'envoi d’un message. + +**Découvrez comment envoyer des SMS depuis n8n en utilisant l'API OVHcloud.** + +## Prérequis + +- Disposer d'un [compte SMS OVHcloud](/links/telecom/sms) et d'un [expéditeur SMS](/pages/web_cloud/messaging/sms/tout_savoir_sur_les_expediteurs_sms) valide. +- Disposer d'un [VPS OVHcloud](/links/bare-metal/vps), d'un serveur ou d'un poste local avec [n8n](https://n8n.io/) installé et accessible. + +## En pratique + +Si vous n'avez pas encore installé [n8n](https://n8n.io/) sur votre VPS, suivez les instructions de notre guide « [Installer n8n sur un VPS OVHcloud](/pages/bare_metal_cloud/virtual_private_servers/install_n8n_on_vps) ». + +### Étape 1 – Générer les identifiants API OVHcloud + +Avant de pouvoir envoyer des SMS via l’API OVHcloud, vous devez être en possession des trois identifiants suivants : + +- Application key +- Application secret +- Consumer key + +Pour cela, consultez la section **Utilisation avancée : coupler les API OVHcloud avec une application** de notre guide « [Premiers pas avec les API OVHcloud](/pages/manage_and_operate/api/first-steps) », puis copiez et conservez les trois identifiants `Application key`, `Application secret` et `Consumer key`. + +### Étape 2 — Créer le workflow et les nœuds + +Connectez-vous à votre interface n8n puis cliquez sur le bouton **Create Workflow**. + +Créez les nœuds suivants (vides pour le moment) : + +- `Set - Credentials` : de type **Edit Fields (Set)**. +- `Set - Request Details` : de type **Edit Fields (Set)**. +- `Merge` : de type **Merge**. +- `Sign - Generate Signature` : de type **Code**. +- `SMS - Send` : de type **HTTP Request**. + +Pour plus de détails concernant la création de nœuds, consultez la [documentation officielle de n8n](https://docs.n8n.io/integrations/creating-nodes/overview/). + +Reliez les nœuds dans cet ordre : + +![N8N SMS](images/nodes.png){.thumbnail} + +Le nœud `Merge` reçoit les sorties des deux nœuds `Set - Credentials` et `Set - Request Details`, puis alimente `Sign - Generate Signature`, qui alimente `SMS - Send`. + +### Étape 3 — Paramétrer le nœud `Set – Credentials` + +Ajoutez les paramètres suivants dans votre nœud `Set - Credentials` : + +- Mode : `Manual Mapping`. + +| Nom | Valeur | +| ----------------- | ----------------------------------------------------------- | +| applicationKey | "VOTRE_APPLICATION_KEY" | +| consumerKey | "VOTRE_CONSUMER_KEY" | +| serviceName | "VOTRE_COMPTE_SMS_OVHCLOUD" (par exemple : "sms-ab12345-1") | +| applicationSecret | "VOTRE_APPLICATION_SECRET" | +| timestamp | {{ Math.floor(Date.now() / 1000) }} | + +### Étape 4 — Paramétrer le nœud `Set – Request Details` + +Paramétrez le nœud `Set - Request Details` : + +- Mode : `Manual Mapping`. +- Ajoutez un champ nommé `body` de type `Object` avec le contenu ci-dessous (exemple minimal). + +```json +{ + "charset": "UTF-8", + "coding": "7bit", + "message": "Message test", + "noStopClause": true, + "priority": "high", + "receivers": ["+33612345678"], + "sender": "Your_sender" +} +``` + +> [!primary] +> +> - Le numéro du destinataire (`receivers`) doit être au format international et commencer par exemple par « +336 » ou « +337 » pour un numéro de mobile français. +> - [L'expéditeur doit être défini dans votre compte OVHcloud](/pages/web_cloud/messaging/sms/tout_savoir_sur_les_expediteurs_sms). Pour réaliser un test sans déclarer d'expéditeur et utiliser un numéro court, remplacez `"sender": "Your_sender"` par `"senderForResponse": true`. + +### Étape 5 — Paramétrer le nœud `Merge` + +Paramétrez le nœud `Merge` : + +- Mode : `Combine`. +- Combine by : `Position`. +- Number of Inputs : `2`. + +Reliez `Set - Credentials` en **Input 1** et `Set - Request Details` en **Input 2**.
+En sortie (output), vous devez avoir au même niveau : `applicationKey`, `applicationSecret`, `consumerKey`, `serviceName`, `timestamp` et `body`. + +### Étape 6 — Paramétrer le nœud `Sign – Generate Signature` + +Paramétrez le nœud `Sign - Generate Signature` : + +- Mode : `Run once for each item`. +- Language : `JavaScript`. + +Collez le code ci-dessous : + +```js +// --- SHA1 pur (pas HMAC) --- +function sha1(input) { + function rotl(n, s) { return (n << s) | (n >>> (32 - s)); } + function hex(v){ let s=''; for(let i=7;i>=0;i--) s+=((v >>> (i*4)) & 0xf).toString(16); return s; } + function utf8(str){ + str=str.replace(/\r\n/g,'\n'); + let out=''; for (let i=0;i>6)|192, (c&63)|128); + else out+=String.fromCharCode((c>>12)|224, ((c>>6)&63)|128, (c&63)|128); + } return out; + } + let i,j,A,B,C,D,E,temp,H0=0x67452301,H1=0xEFCDAB89,H2=0x98BADCFE,H3=0x10325476,H4=0xC3D2E1F0; + const W=new Array(80), m=utf8(input), ml=m.length, wa=[]; + for(i=0;i>>29); wa.push((ml<<3)&0x0ffffffff); + for(let bs=0; bs [!warning] +> +> N'utilisez pas de **HMAC** ici (OVHcloud attend `"$1$" + SHA1(AppSecret + … + Timestamp)`). Le paramètre `bodyString` est **exactement** le JSON qui sera envoyé ensuite (pas d’autre `stringify`). L’URL signée doit être **strictement identique** à celle de l’envoi (même host, pas de `/` final en plus). + +### Étape 7 — Paramétrer le nœud `SMS - Send` + +Paramétrez le nœud `SMS - Send` : + +- Method : `POST`. +- URL : `{{$json.url}}`. +- Authentication : `None`. +- Send Headers : `ON`. +- Specify Headers : `Using fields below`. + +Ajoutez les paramètres de header suivants : + +| Nom | Valeur | +| ------------------ | -------------------------- | +| Content-Type | application/json | +| X-Ovh-Application | {{$json.applicationKey}} | +| X-Ovh-Consumer | {{$json.consumerKey}} | +| X-Ovh-Timestamp | {{$json.timestamp}} | +| X-Ovh-Signature | {{$json.signature}} | + +Activez le `Send Body` et ajoutez les paramètres de body suivants : + +| Nom | Valeur | +| ----------------- | -------------------- | +| Body Content Type | Raw | +| Content Type | application/json | +| Body | {{$json.bodyString}} | + +### Tester votre workflow + +Exécutez votre workflow. Les étapes suivantes s'exécutent : + +1. Set - Credentials : met à disposition applicationKey, consumerKey, serviceName (et éventuellement applicationSecret si vous ne l’avez pas externalisé). +2. Set - Request Details : prépare l’objet body contenant le corps du SMS. +3. Merge (Combine/Position) : fusionne les deux sorties des nœuds précédents. +4. Sign - Generate Signature (Code) : calcule bodyString, timestamp, signature (SHA‑1 simple) et l’URL d’appel. +5. SMS - Send (HTTP Request) : envoie le POST vers l'URL avec le body {{$json.bodyString}} et les headers X-Ovh-*. + +Le message est alors transmis via l’API OVHcloud à votre destinataire. + +### Erreurs fréquentes + +#### **Invalid_signature (400)** + +- L’URL signée est différente de l'URL envoyée (host différent, `/` final en trop). +- Le body signé est différent du body envoyé (re-`stringify`, espaces, ordre, etc.). +- L'horloge locale est trop décalée. Utilisez plutôt l’heure serveur OVHcloud (voir la partie [Industrialisation et sécurité](#industrialisation)). + +#### **Sms sender ... does not exist (403)** + +Le `sender` (expéditeur) n’est pas déclaré/validé dans votre espace client OVHcloud. Testez avec `"senderForResponse": true` ou validez votre expéditeur. + +#### **Bad Request** + +- Vérifiez dans chaque nœud le nom et la valeur de vos paramètres. +- Assurez-vous que les headers et les body soient complets. +- Vérifiez que l'URL du nœud `SMS - Send` respecte bien le format suivant : `https://eu.api.ovh.com/1.0/sms/sms-ab12345-1/jobs` + +#### **Erreurs de nœud Code** + +- N'utilisez pas de `require('crypto')` dans n8n mais plutôt **SHA-1 pur JavaScript** ci-dessus. +- Utilisez le mode *par item* et évitez d'appeler `$input.all()` dans votre code. + +### Industrialisation et sécurité + +Si vous souhaitez industrialiser votre workflow et le sécuriser davantage, appliquez les conseils suivants. + +#### Heure serveur OVHcloud + +Ajoutez un nœud de type **HTTP Request** avant la signature : + +- `GET https://eu.api.ovh.com/1.0/auth/time` +- Récupérez la valeur et remplacez `timestamp` par cette valeur **exacte**. + +#### Ne pas faire transiter l’`applicationSecret` + +- Stockez-le comme **variable d’environnement** (par exemple : `OVH_APP_SECRET`) et lisez-le dans le nœud de type Code (Sign - Generate Signature) via `$env.OVH_APP_SECRET`, ou via la fonctionnalité **Secrets/Credentials** de n8n. +- À défaut, **ne retournez jamais** le secret en sortie du nœud. + +#### Gestion des caractères + +Si votre message contient des emojis/accents non GSM, utilisez `"coding": "ucs2"`. + +## Aller plus loin + +Échangez avec notre [communauté d'utilisateurs](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/n8n_sms/guide.it-it.md b/pages/bare_metal_cloud/virtual_private_servers/n8n_sms/guide.it-it.md new file mode 100644 index 00000000000..1bfe74c84f0 --- /dev/null +++ b/pages/bare_metal_cloud/virtual_private_servers/n8n_sms/guide.it-it.md @@ -0,0 +1,245 @@ +--- +title: "Automatizzare l'invio di SMS con n8n tramite l'API OVHcloud" +excerpt: "Scopri come inviare SMS da n8n utilizzando l'API OVHcloud" +updated: 2025-12-02 +--- + +## Obiettivo + +Questa guida ti spiega come integrare l'API SMS di OVHcloud in **n8n**, per inviare automaticamente SMS dai tuoi workflow. Imparerai a configurare una chiamata HTTP firmata tramite l'API OVHcloud per attivare l'invio di un messaggio. + +**Scopri come inviare SMS da n8n utilizzando l'API OVHcloud.** + +## Prerequisiti + +- Disporre di un [account SMS OVHcloud](/links/telecom/sms) e un [mittente SMS](/pages/web_cloud/messaging/sms/tout_savoir_sur_les_expediteurs_sms) valido. +- Disporre di un [VPS OVHcloud](/links/bare-metal/vps), di un server o di un computer locale con [n8n](https://n8n.io/) installato e accessibile. + +## Procedura + +Se non hai ancora installato [n8n](https://n8n.io/) sul tuo VPS, segui le istruzioni del nostro tutorial "[Installare n8n su un VPS OVHcloud](/pages/bare_metal_cloud/virtual_private_servers/install_n8n_on_vps)". + +### Passo 1 – Generare le credenziali API OVHcloud + +Prima di poter inviare SMS tramite l'API OVHcloud, devi disporre dei seguenti tre identificatori: + +- Application key +- Application secret +- Consumer key + +Per farlo, consulta la sezione **Utilizzo avanzato: associare le API OVHcloud con un'applicazione** del nostro tutorial "[Iniziare a utilizzare le API OVHcloud](/pages/manage_and_operate/api/first-steps)", quindi copia e conserva i tre identificatori `Application key`, `Application secret` e `Consumer key`. + +### Passo 2 — Creare il workflow e i nodi + +Accedi alla tua interfaccia n8n e clicca sul pulsante **Create Workflow**. + +Crea i seguenti nodi (vuoti per il momento): + +- `Set - Credentials`: di tipo **Edit Fields (Set)**. +- `Set - Request Details`: di tipo **Edit Fields (Set)**. +- `Merge`: di tipo **Merge**. +- `Sign - Generate Signature`: di tipo **Code**. +- `SMS - Send`: di tipo **HTTP Request**. + +Per ulteriori informazioni sulla creazione dei nodi, consulta la [documentazione ufficiale di n8n](https://docs.n8n.io/integrations/creating-nodes/overview/). + +Collega i nodi in questo ordine: + +![N8N SMS](images/nodes.png){.thumbnail} + +Il nodo `Merge` riceve le uscite dei due nodi `Set - Credentials` e `Set - Request Details`, quindi alimenta `Sign - Generate Signature`, che alimenta `SMS - Send`. + +### Passo 3 — Configurare il nodo `Set – Credentials` + +Aggiungi i seguenti parametri nel tuo nodo `Set - Credentials`: + +- Mode: `Manual Mapping`. + +| Nome | Valore | +| ----------------- | ------------------------------------------------------------ | +| applicationKey | "IL_TUO_APPLICATION_KEY" | +| consumerKey | "IL_TUO_CONSUMER_KEY" | +| serviceName | "IL_TUO_ACCOUNT_SMS_OVHCLOUD" (ad esempio: "sms-ab12345-1") | +| applicationSecret | "IL_TUO_APPLICATION_SECRET" | +| timestamp | {{ Math.floor(Date.now() / 1000) }} | + +### Passo 4 — Configurare il nodo `Set – Request Details` + +Configura il nodo `Set - Request Details`: + +- Mode: `Manual Mapping`. +- Aggiungi un campo denominato `body` di tipo `Object` con il contenuto seguente (esempio minimo). + +```json +{ + "charset": "UTF-8", + "coding": "7bit", + "message": "Message test", + "noStopClause": true, + "priority": "high", + "receivers": ["+33612345678"], + "sender": "Your_sender" +} +``` + +> [!primary] +> +> - Il numero del destinatario (`receivers`) deve essere nel formato internazionale e iniziare ad esempio con "+336" o "+337" per un numero mobile francese. +> - [Il mittente deve essere definito nel tuo account OVHcloud](/pages/web_cloud/messaging/sms/tout_savoir_sur_les_expediteurs_sms). Per effettuare un test senza dichiarare un mittente e utilizzare un numero corto, sostituisci `"sender": "Your_sender"` con `"senderForResponse": true`. + +### Passo 5 — Configurare il nodo `Merge` + +Configura il nodo `Merge`: + +- Mode: `Combine`. +- Combine by: `Position`. +- Number of Inputs: `2`. + +Collega `Set - Credentials` in **Input 1** e `Set - Request Details` in **Input 2**.
+In uscita (output), dovresti ottenere a livello identico: `applicationKey`, `applicationSecret`, `consumerKey`, `serviceName`, `timestamp` e `body`. + +### Passo 6 — Configurare il nodo `Sign – Generate Signature` + +Configura il nodo `Sign - Generate Signature`: + +- Mode: `Run once for each item`. +- Language: `JavaScript`. + +Incolla il codice seguente: + +```js +// --- SHA1 pure (not HMAC) --- +function sha1(input) { + function rotl(n, s) { return (n << s) | (n >>> (32 - s)); } + function hex(v){ let s=''; for(let i=7;i>=0;i--) s+=((v >>> (i*4)) & 0xf).toString(16); return s; } + function utf8(str){ + str=str.replace(/\r\n/g,'\n'); + let out=''; for (let i=0;i>6)|192, (c&63)|128); + else out+=String.fromCharCode((c>>12)|224, ((c>>6)&63)|128, (c&63)|128); + } return out; + } + let i,j,A,B,C,D,E,temp,H0=0x67452301,H1=0xEFCDAB89,H2=0x98BADCFE,H3=0x10325476,H4=0xC3D2E1F0; + const W=new Array(80), m=utf8(input), ml=m.length, wa=[]; + for(i=0;i>>29); wa.push((ml<<3)&0x0ffffffff); + for(let bs=0; bs [!warning] +> +> Non utilizzare **HMAC** qui (OVHcloud aspetta `"$1$" + SHA1(AppSecret + … + Timestamp)`). Il parametro `bodyString` è **esattamente** il JSON che verrà inviato successivamente (nessun altro `stringify`). L'URL firmata deve essere **strettamente identica** a quella dell'invio (stesso host, non aggiungere `/` finale). + +### Passo 7 — Configurare il nodo `SMS - Send` + +Configura il nodo `SMS - Send`: + +- Method: `POST`. +- URL: `{{$json.url}}`. +- Authentication: `None`. +- Send Headers: `ON`. +- Specify Headers: `Using fields below`. + +Aggiungi i seguenti parametri di header: + +| Nome | Valore | +| ------------------ | -------------------------- | +| Content-Type | application/json | +| X-Ovh-Application | {{$json.applicationKey}} | +| X-Ovh-Consumer | {{$json.consumerKey}} | +| X-Ovh-Timestamp | {{$json.timestamp}} | +| X-Ovh-Signature | {{$json.signature}} | + +Attiva il `Send Body` e aggiungi i seguenti parametri di body: + +| Nome | Valore | +| ----------------- | -------------------- | +| Body Content Type | Raw | +| Content Type | application/json | +| Body | {{$json.bodyString}} | + +### Testa il tuo workflow + +Esegui il tuo workflow. Le seguenti fasi vengono eseguite: + +1. Set - Credentials: mette a disposizione applicationKey, consumerKey, serviceName (e eventualmente applicationSecret se non l'hai esternalizzato). +2. Set - Request Details: prepara l'oggetto body contenente il corpo del SMS. +3. Merge (Combine/Position): unisce le due uscite dei nodi precedenti. +4. Sign - Generate Signature (Code): calcola bodyString, timestamp, signature (SHA-1 semplice) e l'URL di chiamata. +5. SMS - Send (HTTP Request): invia il POST verso l'URL con il body {{$json.bodyString}} e gli header X-Ovh-*. + +Il messaggio viene quindi trasmesso tramite l'API OVHcloud al tuo destinatario. + +### Errori frequenti + +#### **Invalid_signature (400)** + +- L'URL firmata è diversa dall'URL inviata (host diverso, `/` finale in più). +- Il body firmato è diverso dal body inviato (re-`stringify`, spazi, ordine, ecc.). +- L'orologio locale è troppo fuori sincrono. Utilizza invece l'ora del server OVHcloud (vedi la sezione [Industrializzazione e sicurezza](#industrialisation)). + +#### **SMS sender ... does not exist (403)** + +Il `sender` (mittente) non è dichiarato/validato nel tuo Spazio Cliente OVHcloud. Testa con `"senderForResponse": true` o valida il tuo mittente. + +#### **Bad Request** + +- Controlla in ogni nodo il nome e il valore dei tuoi parametri. +- Assicurati che gli header e i body siano completi. +- Verifica che l'URL del nodo `SMS - Send` rispetti bene il formato seguente: `https://eu.api.ovh.com/1.0/sms/sms-ab12345-1/jobs` + +#### **Errori del nodo Code** + +- Non utilizzare `require('crypto')` in n8n ma piuttosto **SHA-1 puro JavaScript** sopra. +- Utilizza la modalità *per item* e evita di chiamare `$input.all()` nel tuo codice. + +### Industrializzazione e sicurezza + +Se desideri industrializzare il tuo workflow e renderlo più sicuro, applica i seguenti consigli. + +#### Ora del server OVHcloud + +Aggiungi un nodo di tipo **HTTP Request** prima della firma: + +- `GET https://eu.api.ovh.com/1.0/auth/time` +- Recupera il valore e sostituisci `timestamp` con questo valore **esatto**. + +#### Non far transitare l’`applicationSecret` + +- Conservalo come **variabile d'ambiente** (ad esempio: `OVH_APP_SECRET`) e leggilo nel nodo di tipo Code (Sign - Generate Signature) tramite `$env.OVH_APP_SECRET`, o tramite la funzionalità **Secrets/Credentials** di n8n. +- In alternativa, **non restituirlo mai** in uscita dal nodo. + +#### Gestione dei caratteri + +Se il tuo messaggio contiene emoji/accents non GSM, utilizza `"coding": "ucs2"`. + +## Per saperne di più + +Contatta la nostra [Community di utenti](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/n8n_sms/guide.pl-pl.md b/pages/bare_metal_cloud/virtual_private_servers/n8n_sms/guide.pl-pl.md new file mode 100644 index 00000000000..c45275a3123 --- /dev/null +++ b/pages/bare_metal_cloud/virtual_private_servers/n8n_sms/guide.pl-pl.md @@ -0,0 +1,245 @@ +--- +title: "Automatyzacja wysyłania SMS za pomocą n8n za pośrednictwem API OVHcloud" +excerpt: "Dowiedz się, jak wysyłać SMS z n8n, korzystając z API OVHcloud" +updated: 2025-12-02 +--- + +## Wprowadzenie + +Ten przewodnik wyjaśnia, jak zintegrować API SMS OVHcloud z **n8n**, aby automatycznie wysyłać SMS z poziomu swoich workflowów. Nauczysz się, jak skonfigurować podpisany wywołania HTTP za pomocą API OVHcloud, aby uruchomić wysyłkę wiadomości. + +**Dowiedz się, jak wysyłać SMS z n8n, korzystając z API OVHcloud.** + +## Wymagania początkowe + +- Posiadanie [konta SMS OVHcloud](/links/telecom/sms) oraz [walidnego nadawcy SMS](/pages/web_cloud/messaging/sms/tout_savoir_sur_les_expediteurs_sms). +- Posiadanie [VPS OVHcloud](/links/bare-metal/vps), serwera lub lokalnego komputera z zainstalowanym i dostępnych [n8n](https://n8n.io/). + +## W praktyce + +Jeśli jeszcze nie zainstalowałeś [n8n](https://n8n.io/) na swoim VPS, postępuj zgodnie z instrukcjami w naszym przewodniku "[Instalacja n8n na VPS OVHcloud](/pages/bare_metal_cloud/virtual_private_servers/install_n8n_on_vps)". + +### Krok 1 – Wygenerowanie identyfikatorów API OVHcloud + +Przed wysłaniem SMS za pomocą API OVHcloud musisz mieć do dyspozycji trzy następujące identyfikatory: + +- Application key +- Application secret +- Consumer key + +Aby tego dokonać, odwiedź sekcję **Zaawansowane wykorzystanie: łączenie API OVHcloud z aplikacją** w naszym przewodniku "[Pierwsze kroki z API OVHcloud](/pages/manage_and_operate/api/first-steps)", a następnie skopiuj i zapisz trzy identyfikatory `Application key`, `Application secret` i `Consumer key`. + +### Krok 2 — Tworzenie workflowu i węzłów + +Zaloguj się do swojej interfejsu n8n i kliknij przycisk **Create Workflow**. + +Utwórz następujące węzły (puste na razie): + +- `Set - Credentials`: typu **Edit Fields (Set)**. +- `Set - Request Details`: typu **Edit Fields (Set)**. +- `Merge`: typu **Merge**. +- `Sign - Generate Signature`: typu **Code**. +- `SMS - Send`: typu **HTTP Request**. + +Aby uzyskać więcej informacji na temat tworzenia węzłów, odwiedź [oficjalną dokumentację n8n](https://docs.n8n.io/integrations/creating-nodes/overview/). + +Połącz węzły w tej kolejności: + +![N8N SMS](images/nodes.png){.thumbnail} + +Węzeł `Merge` otrzymuje wyjścia z dwóch węzłów `Set - Credentials` i `Set - Request Details`, a następnie zasila `Sign - Generate Signature`, który zasila `SMS - Send`. + +### Krok 3 — Konfiguracja węzła `Set – Credentials` + +Dodaj następujące parametry do swojego węzła `Set - Credentials`: + +- Mode: `Manual Mapping`. + +| Nazwa | Artość | +| ------------------- | ------------------------------------------------- | +| applicationKey | "TWÓJ_APPLICATION_KEY" | +| consumerKey | "TWÓJ_CONSUMER_KEY" | +| serviceName | "TWÓJ_KONTA_SMS_OVHCLOUD" (np. "sms-ab12345-1") | +| applicationSecret | "TWÓJ_APPLICATION_SECRET" | +| timestamp | {{ Math.floor(Date.now() /1000) }} | + +### Krok 4 — Konfiguracja węzła `Set – Request Details` + +Skonfiguruj węzeł `Set - Request Details`: + +- Mode: `Manual Mapping`. +- Dodaj pole o nazwie `body` typu `Object` z poniższym zawartością (przykład minimalny). + +```json +{ + "charset": "UTF-8", + "coding": "7bit", + "message": "Message test", + "noStopClause": true, + "priority": "high", + "receivers": ["+33612345678"], + "sender": "Your_sender" +} +``` + +> [!primary] +> +> - Numer odbiorcy (`receivers`) musi być w formacie międzynarodowym i zaczynać się np. od "+336" lub "+337" dla francuskiego numeru komórkowego. +> - [Nadawca musi być zdefiniowany w Twoim koncie OVHcloud](/pages/web_cloud/messaging/sms/tout_savoir_sur_les_expediteurs_sms). Aby przeprowadzić test bez deklaracji nadawcy i używania krótkiego numeru, zastąp `"sender": "Your_sender"` przez `"senderForResponse": true`. + +### Krok 5 — Konfiguracja węzła `Merge` + +Skonfiguruj węzeł `Merge`: + +- Mode: `Combine`. +- Combine by: `Position`. +- Number of Inputs: `2`. + +Połącz `Set - Credentials` w **Input 1** i `Set - Request Details` w **Input 2**.
+W wyjściu (output) powinieneś mieć na tym samym poziomie: `applicationKey`, `applicationSecret`, `consumerKey`, `serviceName`, `timestamp` i `body`. + +### Krok 6 — Konfiguracja węzła `Sign – Generate Signature` + +Skonfiguruj węzeł `Sign - Generate Signature`: + +- Mode: `Run once for each item`. +- Language: `JavaScript`. + +Wklej poniższy kod: + +```js +// --- SHA1 pure (not HMAC) --- +function sha1(input) { + function rotl(n, s) { return (n << s) | (n >>> (32 - s)); } + function hex(v){ let s=''; for(let i=7;i>=0;i--) s+=((v >>> (i*4)) & 0xf).toString(16); return s; } + function utf8(str){ + str=str.replace(/\r\n/g,'\n'); + let out=''; for (let i=0;i>6)|192, (c&63)|128); + else out+=String.fromCharCode((c>>12)|224, ((c>>6)&63)|128, (c&63)|128); + } return out; + } + let i,j,A,B,C,D,E,temp,H0=0x67452301,H1=0xEFCDAB89,H2=0x98BADCFE,H3=0x10325476,H4=0xC3D2E1F0; + const W=new Array(80), m=utf8(input), ml=m.length, wa=[]; + for(i=0;i>>29); wa.push((ml<<3)&0x0ffffffff); + for(let bs=0; bs [!warning] +> +> Nie używaj **HMAC** tutaj (OVHcloud oczekuje `"$1$" + SHA1(AppSecret + … + Timestamp)`). Parametr `bodyString` jest **dokładnie** JSON, który zostanie wysłany później (bez dodatkowego `stringify`). Podpisana URL musi być **ściśle identyczna** jak URL wysyłki (taki sam host, bez dodatkowego `/` na końcu). + +### Krok 7 — Konfiguracja węzła `SMS - Send` + +Skonfiguruj węzeł `SMS - Send`: + +- Method: `POST`. +- URL: `{{$json.url}}`. +- Authentication: `None`. +- Send Headers: `ON`. +- Specify Headers: `Using fields below`. + +Dodaj następujące parametry nagłówka: + +| Nazwa | Wartość | +| -------------------- | --------------------------- | +| Content-Type | application/json | +| X-Ovh-Application | {{$json.applicationKey}} | +| X-Ovh-Consumer | {{$json.consumerKey}} | +| X-Ovh-Timestamp | {{$json.timestamp}} | +| X-Ovh-Signature | {{$json.signature}} | + +Włącz `Send Body` i dodaj następujące parametry ciała: + +| Nazwa | Wartość | +| ------------------- | -------------------- | +| Body Content Type | Raw | +| Content Type | application/json | +| Body | {{$json.bodyString}} | + +### Testowanie swojego workflowu + +Uruchom swój workflow. Następujące kroki zostaną wykonane: + +1. Set - Credentials: udostępnia applicationKey, consumerKey, serviceName (i ewentualnie applicationSecret, jeśli nie został zewnętrzny). +2. Set - Request Details: przygotowuje obiekt body zawierający treść SMS. +3. Merge (Combine/Position): łączy dwa wyjścia z poprzednich węzłów. +4. Sign - Generate Signature (Code): oblicza bodyString, timestamp, signature (SHA-1 czysty JavaScript) i URL wywołania. +5. SMS - Send (HTTP Request): wysyła POST do URL z ciałem {{$json.bodyString}} i nagłówkami X-Ovh-*. + +Wiadomość zostaje następnie przekazana przez API OVHcloud do odbiorcy. + +### Częste błędy + +#### **Invalid_signature (400)** + +- Podpisana URL różni się od wysłanej URL (inny host, dodatkowy `/` na końcu). +- Podpisane ciało różni się od wysłanego ciała (ponowne `stringify`, spacje, kolejność itp.). +- Zegar lokalny jest zbyt odstający. Zamiast tego użyj godziny serwera OVHcloud (patrz sekcja [Industrializacja i bezpieczeństwo](#industrialisation)). + +#### **SMS sender ... does not exist (403)** + +Nadawca `sender` nie jest zadeklarowany/zweryfikowany w Twoim Panelu klienta OVHcloud. Przetestuj z `"senderForResponse": true` lub zweryfikuj swojego nadawcę. + +#### **Bad Request** + +- Sprawdź w każdym węźle nazwę i wartość swoich parametrów. +- Upewnij się, że nagłówki i ciała są pełne. +- Sprawdź, czy URL węzła `SMS - Send` spełnia następujący format: `https://eu.api.ovh.com/1.0/sms/sms-ab12345-1/jobs` + +#### **Błędy węzła Code** + +- Nie używaj `require('crypto')` w n8n, ale zamiast tego użyj **czystego JavaScript SHA-1** powyżej. +- Użyj trybu *po jednym elemencie* i unikaj wywoływania `$input.all()` w swoim kodzie. + +### Industrializacja i bezpieczeństwo + +Jeśli chcesz przemysłowo wykorzystać swój workflow i zwiększyć jego bezpieczeństwo, zastosuj poniższe wskazówki. + +#### Godzina serwera OVHcloud + +Dodaj węzeł typu **HTTP Request** przed podpisem: + +- `GET https://eu.api.ovh.com/1.0/auth/time` +- Pobierz wartość i zastąp `timestamp` tą **dokładną** wartością. + +#### Nie przesyłaj `applicationSecret` + +- Zapisz go jako **zmienną środowiskową** (np. `OVH_APP_SECRET`) i odczytaj w węźle typu Code (Sign - Generate Signature) za pomocą `$env.OVH_APP_SECRET`, lub za pomocą funkcji **Secrets/Credentials** w n8n. +- W przeciwnym razie **nigdy nie zwracaj** sekretu w wyjściu węzła. + +#### Zarządzanie znakami + +Jeśli wiadomość zawiera emoji/akcenty nie-GSM, użyj `"coding": "ucs2"`. + +## Sprawdź również + +Dołącz do [grona naszych użytkowników](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/n8n_sms/images/nodes.png b/pages/bare_metal_cloud/virtual_private_servers/n8n_sms/images/nodes.png new file mode 100644 index 00000000000..54217192532 Binary files /dev/null and b/pages/bare_metal_cloud/virtual_private_servers/n8n_sms/images/nodes.png differ diff --git a/pages/bare_metal_cloud/virtual_private_servers/n8n_sms/meta.yaml b/pages/bare_metal_cloud/virtual_private_servers/n8n_sms/meta.yaml new file mode 100644 index 00000000000..633790cd519 --- /dev/null +++ b/pages/bare_metal_cloud/virtual_private_servers/n8n_sms/meta.yaml @@ -0,0 +1,14 @@ +id: 828aa026-4a8c-4351-93b2-d0b32dc0ee6c +full_slug: vps-n8n-sms +reference_category: bare-metal-cloud-virtual-private-servers-tutorials +disable_languages: +- de-de +- fr-ca +- en-ca +- en-asia +- en-in +- en-au +- en-sg +- en-us +- es-us +- pt-pt \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.de-de.md b/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.de-de.md index 3275d50db0c..6ba5321d44f 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.de-de.md +++ b/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.de-de.md @@ -1,7 +1,7 @@ --- title: "Einen VPS absichern" excerpt: "Erfahren Sie hier, wie Sie grundsätzliche Sicherheitsmaßnahmen anwenden, um Ihren VPS vor Angriffen und unbefugtem Zugriff zu schützen" -updated: 2024-10-07 +updated: 2025-11-04 --- > [!primary] @@ -101,7 +101,13 @@ Sie sollten diese oder ähnliche Zeilen vorfinden: ``` Ersetzen Sie die Nummer **22** mit der Port-Nummer Ihrer Wahl.
-**Geben Sie keine bereits auf Ihrem System verwendete Port-Nummer ein**. Um sicher zu gehen, verwenden Sie eine Zahl zwischen 49152 und 65535.
Speichern und schließen Sie die Konfigurationsdatei. +**Geben Sie keine bereits auf Ihrem System verwendete Port-Nummer ein**. Um sicher zu gehen, verwenden Sie eine Zahl zwischen 49152 und 65535. + +Sie können die Ihrem System zugewiesenen Ports auch mit dem folgenden Befehl anzeigen: + +```bash +sudo cat /etc/services +``` Wenn die Zeile "auskommentiert" ist (d. h. wenn ihr ein "#" vorangestellt ist) wie im Beispiel oben zu sehen, achten Sie darauf, das "#" vor dem Speichern der Datei zu entfernen, damit die Änderung wirksam wird. Beispiel: @@ -111,37 +117,68 @@ Port 49152 #ListenAddress 0.0.0.0 ``` +> [!warning] +> Wenn auf Ihrem Betriebssystem eine Firewall konfiguriert ist (UFW oder iptables), müssen Sie deren Einstellungen anpassen, um den Datenverkehr auf dem neuen Port zuzulassen, bevor Sie den Dienst neu starten. Wenn Sie iptables verwenden, lesen Sie diese Anleitung: [Konfiguration der Linux Firewall mit iptables](/pages/bare_metal_cloud/dedicated_servers/firewall-Linux-iptable/). Wenn standardmäßig keine Firewall konfiguriert ist, starten Sie den Dienst neu. +> + +Speichern und schließen Sie die Konfigurationsdatei. + Starten Sie den Dienst neu: ```bash -systemctl restart sshd +sudo systemctl restart sshd ``` Dies sollte ausreichen, um die Änderungen umzusetzen. Sie können alternativ den VPS neu starten (`sudo reboot`). -**Für Ubuntu 23.04 und höher** +**Für Ubuntu 24.04 und höher** Für die neuesten Ubuntu Versionen wird die SSH-Konfiguration nun in der Datei `ssh.socket` verwaltet. Um den SSH-Port zu aktualisieren, bearbeiten Sie die Zeile `ListenStream` in der Konfigurationsdatei mit einem Texteditor Ihrer Wahl (`nano` in diesem Beispiel verwendet): +```bash +sudo nano /lib/systemd/system/ssh.socket +``` + +Ihre Datei sollte je nach der von Ihnen installierten Ubuntu-Version wie in den folgenden Beispielen aussehen: + ```console [Socket] ListenStream=49152 Accept=no ``` +oder + +```console +[Socket] +ListenStream=0.0.0.0:49152 +ListenStream=[::]:22 +BindIPv6Only=ipv6-only +Accept=no +FreeBind=yes +``` + Speichern Sie die Änderungen, und führen Sie die folgenden Befehle aus: ```bash sudo systemctl daemon-reload ``` +Starten Sie den Dienst neu: + ```bash sudo systemctl restart ssh.service ``` -Wenn Sie die Betriebssystemfirewall aktiviert haben, stellen Sie sicher, dass der neue Port in den Firewallregeln zugelassen ist. +**Ubuntu 25.04** + +Starten Sie den Dienst neu: + +```bash +sudo systemctl restart ssh.socket +``` Denken Sie daran, dass Sie nun den neuen Port immer angeben müssen, wenn Sie eine [SSH-Verbindung mit Ihrem Server aufbauen](/pages/bare_metal_cloud/dedicated_servers/ssh_introduction): @@ -155,6 +192,8 @@ Beispiel: ssh ubuntu@203.0.113.100 -p 49152 ``` +Wenn Sie aus Ihrem System ausgesperrt sind, können Sie unsere [Rescue-Modus](/pages/bare_metal_cloud/virtual_private_servers/rescue/) verwenden, um Ihre Änderungen wiederherzustellen. + ### Erstellen eines Benutzers mit eingeschränkten Rechten Im Allgemeinen sollten Aufgaben, die keine Root-Rechte erfordern, über einen Standardbenutzer ausgeführt werden. Weitere Informationen finden Sie in [dieser Anleitung](/pages/bare_metal_cloud/dedicated_servers/changing_root_password_linux_ds). diff --git a/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.en-asia.md b/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.en-asia.md index 0e82b3ff349..33c16823a97 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.en-asia.md +++ b/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.en-asia.md @@ -1,7 +1,7 @@ --- title: "How to secure a VPS" excerpt: "Find out how to apply basic security measures to protect your VPS against attacks and unauthorised access" -updated: 2024-10-07 +updated: 2025-11-04 --- ## Objective @@ -94,8 +94,13 @@ Find the following or similar lines: #ListenAddress 0.0.0.0 ``` -Replace the number **22** with the port number of your choice. **Please do not enter a port number already used on your system**. To be safe, use a number between 49152 and 65535. -Save and exit the configuration file. +Replace the number **22** with the port number of your choice. **Please do not enter a port number already used on your system**. To be safe, use a number between 49152 and 65535. + +Alternatively, you can view the ports assigned on your system with the following command: + +```bash +sudo cat /etc/services +``` If the line is "commented out" (i.e. if it is preceded by a "#") as shown in the example above, make sure to remove the "#" before saving the file so that the change takes effect. Example: @@ -105,6 +110,12 @@ Port 49152 #ListenAddress 0.0.0.0 ``` +> [!warning] +> If a firewall is configured on your operating system (UFW or iptables), you must adjust its settings to allow traffic on the new port before restarting the service. If you are using iptables, refer to this guide: [Configuring the firewall on Linux with iptables](/pages/bare_metal_cloud/dedicated_servers/firewall-Linux-iptable/). If no firewall is configured by default, restart the service. +> + +Save and exit the configuration file. + Restart the service: ```bash @@ -113,7 +124,7 @@ sudo systemctl restart sshd This should be sufficient to apply the changes. Alternatively, reboot the VPS (`sudo reboot`). -**For Ubuntu 23.04 and later** +**For Ubuntu 24.04 and later** For the latest Ubuntu versions, the SSH configuration is now managed in the `ssh.socket` file. @@ -123,23 +134,44 @@ To update the SSH port, edit the `Listenstream` line in the configuration file w sudo nano /lib/systemd/system/ssh.socket ``` +Your file should resemble the following examples, depending on the version of Ubuntu you have installed: + ```console [Socket] ListenStream=49152 Accept=no ``` +or + +```console +[Socket] +ListenStream=0.0.0.0:49152 +ListenStream=[::]:22 +BindIPv6Only=ipv6-only +Accept=no +FreeBind=yes +``` + Save your changes and run the following commands: ```bash sudo systemctl daemon-reload ``` +Restart the service: + ```bash sudo systemctl restart ssh.service ``` -If you have enabled your operating system's firewall, make sure you allow the new port in your firewall rules. +**Ubuntu 25.04** + +Restart the service: + +```bash +sudo systemctl restart ssh.socket +``` Remember that you will have to indicate the new port any time you [establish an SSH connection to your server](/pages/bare_metal_cloud/dedicated_servers/ssh_introduction): @@ -153,6 +185,8 @@ Example: ssh ubuntu@203.0.113.100 -p 49152 ``` +If you are locked out of your system, you can use our [rescue mode](/pages/bare_metal_cloud/virtual_private_servers/rescue/) environment to revert your changes. + ### Creating a user with restricted rights In general, tasks that do not require root privileges should be performed via a standard user. Please refer to the information in [this guide](/pages/bare_metal_cloud/dedicated_servers/changing_root_password_linux_ds) for details. diff --git a/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.en-au.md b/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.en-au.md index 0e82b3ff349..33c16823a97 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.en-au.md +++ b/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.en-au.md @@ -1,7 +1,7 @@ --- title: "How to secure a VPS" excerpt: "Find out how to apply basic security measures to protect your VPS against attacks and unauthorised access" -updated: 2024-10-07 +updated: 2025-11-04 --- ## Objective @@ -94,8 +94,13 @@ Find the following or similar lines: #ListenAddress 0.0.0.0 ``` -Replace the number **22** with the port number of your choice. **Please do not enter a port number already used on your system**. To be safe, use a number between 49152 and 65535. -Save and exit the configuration file. +Replace the number **22** with the port number of your choice. **Please do not enter a port number already used on your system**. To be safe, use a number between 49152 and 65535. + +Alternatively, you can view the ports assigned on your system with the following command: + +```bash +sudo cat /etc/services +``` If the line is "commented out" (i.e. if it is preceded by a "#") as shown in the example above, make sure to remove the "#" before saving the file so that the change takes effect. Example: @@ -105,6 +110,12 @@ Port 49152 #ListenAddress 0.0.0.0 ``` +> [!warning] +> If a firewall is configured on your operating system (UFW or iptables), you must adjust its settings to allow traffic on the new port before restarting the service. If you are using iptables, refer to this guide: [Configuring the firewall on Linux with iptables](/pages/bare_metal_cloud/dedicated_servers/firewall-Linux-iptable/). If no firewall is configured by default, restart the service. +> + +Save and exit the configuration file. + Restart the service: ```bash @@ -113,7 +124,7 @@ sudo systemctl restart sshd This should be sufficient to apply the changes. Alternatively, reboot the VPS (`sudo reboot`). -**For Ubuntu 23.04 and later** +**For Ubuntu 24.04 and later** For the latest Ubuntu versions, the SSH configuration is now managed in the `ssh.socket` file. @@ -123,23 +134,44 @@ To update the SSH port, edit the `Listenstream` line in the configuration file w sudo nano /lib/systemd/system/ssh.socket ``` +Your file should resemble the following examples, depending on the version of Ubuntu you have installed: + ```console [Socket] ListenStream=49152 Accept=no ``` +or + +```console +[Socket] +ListenStream=0.0.0.0:49152 +ListenStream=[::]:22 +BindIPv6Only=ipv6-only +Accept=no +FreeBind=yes +``` + Save your changes and run the following commands: ```bash sudo systemctl daemon-reload ``` +Restart the service: + ```bash sudo systemctl restart ssh.service ``` -If you have enabled your operating system's firewall, make sure you allow the new port in your firewall rules. +**Ubuntu 25.04** + +Restart the service: + +```bash +sudo systemctl restart ssh.socket +``` Remember that you will have to indicate the new port any time you [establish an SSH connection to your server](/pages/bare_metal_cloud/dedicated_servers/ssh_introduction): @@ -153,6 +185,8 @@ Example: ssh ubuntu@203.0.113.100 -p 49152 ``` +If you are locked out of your system, you can use our [rescue mode](/pages/bare_metal_cloud/virtual_private_servers/rescue/) environment to revert your changes. + ### Creating a user with restricted rights In general, tasks that do not require root privileges should be performed via a standard user. Please refer to the information in [this guide](/pages/bare_metal_cloud/dedicated_servers/changing_root_password_linux_ds) for details. diff --git a/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.en-ca.md b/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.en-ca.md index 0e82b3ff349..33c16823a97 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.en-ca.md +++ b/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.en-ca.md @@ -1,7 +1,7 @@ --- title: "How to secure a VPS" excerpt: "Find out how to apply basic security measures to protect your VPS against attacks and unauthorised access" -updated: 2024-10-07 +updated: 2025-11-04 --- ## Objective @@ -94,8 +94,13 @@ Find the following or similar lines: #ListenAddress 0.0.0.0 ``` -Replace the number **22** with the port number of your choice. **Please do not enter a port number already used on your system**. To be safe, use a number between 49152 and 65535. -Save and exit the configuration file. +Replace the number **22** with the port number of your choice. **Please do not enter a port number already used on your system**. To be safe, use a number between 49152 and 65535. + +Alternatively, you can view the ports assigned on your system with the following command: + +```bash +sudo cat /etc/services +``` If the line is "commented out" (i.e. if it is preceded by a "#") as shown in the example above, make sure to remove the "#" before saving the file so that the change takes effect. Example: @@ -105,6 +110,12 @@ Port 49152 #ListenAddress 0.0.0.0 ``` +> [!warning] +> If a firewall is configured on your operating system (UFW or iptables), you must adjust its settings to allow traffic on the new port before restarting the service. If you are using iptables, refer to this guide: [Configuring the firewall on Linux with iptables](/pages/bare_metal_cloud/dedicated_servers/firewall-Linux-iptable/). If no firewall is configured by default, restart the service. +> + +Save and exit the configuration file. + Restart the service: ```bash @@ -113,7 +124,7 @@ sudo systemctl restart sshd This should be sufficient to apply the changes. Alternatively, reboot the VPS (`sudo reboot`). -**For Ubuntu 23.04 and later** +**For Ubuntu 24.04 and later** For the latest Ubuntu versions, the SSH configuration is now managed in the `ssh.socket` file. @@ -123,23 +134,44 @@ To update the SSH port, edit the `Listenstream` line in the configuration file w sudo nano /lib/systemd/system/ssh.socket ``` +Your file should resemble the following examples, depending on the version of Ubuntu you have installed: + ```console [Socket] ListenStream=49152 Accept=no ``` +or + +```console +[Socket] +ListenStream=0.0.0.0:49152 +ListenStream=[::]:22 +BindIPv6Only=ipv6-only +Accept=no +FreeBind=yes +``` + Save your changes and run the following commands: ```bash sudo systemctl daemon-reload ``` +Restart the service: + ```bash sudo systemctl restart ssh.service ``` -If you have enabled your operating system's firewall, make sure you allow the new port in your firewall rules. +**Ubuntu 25.04** + +Restart the service: + +```bash +sudo systemctl restart ssh.socket +``` Remember that you will have to indicate the new port any time you [establish an SSH connection to your server](/pages/bare_metal_cloud/dedicated_servers/ssh_introduction): @@ -153,6 +185,8 @@ Example: ssh ubuntu@203.0.113.100 -p 49152 ``` +If you are locked out of your system, you can use our [rescue mode](/pages/bare_metal_cloud/virtual_private_servers/rescue/) environment to revert your changes. + ### Creating a user with restricted rights In general, tasks that do not require root privileges should be performed via a standard user. Please refer to the information in [this guide](/pages/bare_metal_cloud/dedicated_servers/changing_root_password_linux_ds) for details. diff --git a/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.en-gb.md b/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.en-gb.md index 0e82b3ff349..33c16823a97 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.en-gb.md +++ b/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.en-gb.md @@ -1,7 +1,7 @@ --- title: "How to secure a VPS" excerpt: "Find out how to apply basic security measures to protect your VPS against attacks and unauthorised access" -updated: 2024-10-07 +updated: 2025-11-04 --- ## Objective @@ -94,8 +94,13 @@ Find the following or similar lines: #ListenAddress 0.0.0.0 ``` -Replace the number **22** with the port number of your choice. **Please do not enter a port number already used on your system**. To be safe, use a number between 49152 and 65535. -Save and exit the configuration file. +Replace the number **22** with the port number of your choice. **Please do not enter a port number already used on your system**. To be safe, use a number between 49152 and 65535. + +Alternatively, you can view the ports assigned on your system with the following command: + +```bash +sudo cat /etc/services +``` If the line is "commented out" (i.e. if it is preceded by a "#") as shown in the example above, make sure to remove the "#" before saving the file so that the change takes effect. Example: @@ -105,6 +110,12 @@ Port 49152 #ListenAddress 0.0.0.0 ``` +> [!warning] +> If a firewall is configured on your operating system (UFW or iptables), you must adjust its settings to allow traffic on the new port before restarting the service. If you are using iptables, refer to this guide: [Configuring the firewall on Linux with iptables](/pages/bare_metal_cloud/dedicated_servers/firewall-Linux-iptable/). If no firewall is configured by default, restart the service. +> + +Save and exit the configuration file. + Restart the service: ```bash @@ -113,7 +124,7 @@ sudo systemctl restart sshd This should be sufficient to apply the changes. Alternatively, reboot the VPS (`sudo reboot`). -**For Ubuntu 23.04 and later** +**For Ubuntu 24.04 and later** For the latest Ubuntu versions, the SSH configuration is now managed in the `ssh.socket` file. @@ -123,23 +134,44 @@ To update the SSH port, edit the `Listenstream` line in the configuration file w sudo nano /lib/systemd/system/ssh.socket ``` +Your file should resemble the following examples, depending on the version of Ubuntu you have installed: + ```console [Socket] ListenStream=49152 Accept=no ``` +or + +```console +[Socket] +ListenStream=0.0.0.0:49152 +ListenStream=[::]:22 +BindIPv6Only=ipv6-only +Accept=no +FreeBind=yes +``` + Save your changes and run the following commands: ```bash sudo systemctl daemon-reload ``` +Restart the service: + ```bash sudo systemctl restart ssh.service ``` -If you have enabled your operating system's firewall, make sure you allow the new port in your firewall rules. +**Ubuntu 25.04** + +Restart the service: + +```bash +sudo systemctl restart ssh.socket +``` Remember that you will have to indicate the new port any time you [establish an SSH connection to your server](/pages/bare_metal_cloud/dedicated_servers/ssh_introduction): @@ -153,6 +185,8 @@ Example: ssh ubuntu@203.0.113.100 -p 49152 ``` +If you are locked out of your system, you can use our [rescue mode](/pages/bare_metal_cloud/virtual_private_servers/rescue/) environment to revert your changes. + ### Creating a user with restricted rights In general, tasks that do not require root privileges should be performed via a standard user. Please refer to the information in [this guide](/pages/bare_metal_cloud/dedicated_servers/changing_root_password_linux_ds) for details. diff --git a/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.en-ie.md b/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.en-ie.md index 0e82b3ff349..33c16823a97 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.en-ie.md +++ b/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.en-ie.md @@ -1,7 +1,7 @@ --- title: "How to secure a VPS" excerpt: "Find out how to apply basic security measures to protect your VPS against attacks and unauthorised access" -updated: 2024-10-07 +updated: 2025-11-04 --- ## Objective @@ -94,8 +94,13 @@ Find the following or similar lines: #ListenAddress 0.0.0.0 ``` -Replace the number **22** with the port number of your choice. **Please do not enter a port number already used on your system**. To be safe, use a number between 49152 and 65535. -Save and exit the configuration file. +Replace the number **22** with the port number of your choice. **Please do not enter a port number already used on your system**. To be safe, use a number between 49152 and 65535. + +Alternatively, you can view the ports assigned on your system with the following command: + +```bash +sudo cat /etc/services +``` If the line is "commented out" (i.e. if it is preceded by a "#") as shown in the example above, make sure to remove the "#" before saving the file so that the change takes effect. Example: @@ -105,6 +110,12 @@ Port 49152 #ListenAddress 0.0.0.0 ``` +> [!warning] +> If a firewall is configured on your operating system (UFW or iptables), you must adjust its settings to allow traffic on the new port before restarting the service. If you are using iptables, refer to this guide: [Configuring the firewall on Linux with iptables](/pages/bare_metal_cloud/dedicated_servers/firewall-Linux-iptable/). If no firewall is configured by default, restart the service. +> + +Save and exit the configuration file. + Restart the service: ```bash @@ -113,7 +124,7 @@ sudo systemctl restart sshd This should be sufficient to apply the changes. Alternatively, reboot the VPS (`sudo reboot`). -**For Ubuntu 23.04 and later** +**For Ubuntu 24.04 and later** For the latest Ubuntu versions, the SSH configuration is now managed in the `ssh.socket` file. @@ -123,23 +134,44 @@ To update the SSH port, edit the `Listenstream` line in the configuration file w sudo nano /lib/systemd/system/ssh.socket ``` +Your file should resemble the following examples, depending on the version of Ubuntu you have installed: + ```console [Socket] ListenStream=49152 Accept=no ``` +or + +```console +[Socket] +ListenStream=0.0.0.0:49152 +ListenStream=[::]:22 +BindIPv6Only=ipv6-only +Accept=no +FreeBind=yes +``` + Save your changes and run the following commands: ```bash sudo systemctl daemon-reload ``` +Restart the service: + ```bash sudo systemctl restart ssh.service ``` -If you have enabled your operating system's firewall, make sure you allow the new port in your firewall rules. +**Ubuntu 25.04** + +Restart the service: + +```bash +sudo systemctl restart ssh.socket +``` Remember that you will have to indicate the new port any time you [establish an SSH connection to your server](/pages/bare_metal_cloud/dedicated_servers/ssh_introduction): @@ -153,6 +185,8 @@ Example: ssh ubuntu@203.0.113.100 -p 49152 ``` +If you are locked out of your system, you can use our [rescue mode](/pages/bare_metal_cloud/virtual_private_servers/rescue/) environment to revert your changes. + ### Creating a user with restricted rights In general, tasks that do not require root privileges should be performed via a standard user. Please refer to the information in [this guide](/pages/bare_metal_cloud/dedicated_servers/changing_root_password_linux_ds) for details. diff --git a/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.en-sg.md b/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.en-sg.md index 0e82b3ff349..33c16823a97 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.en-sg.md +++ b/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.en-sg.md @@ -1,7 +1,7 @@ --- title: "How to secure a VPS" excerpt: "Find out how to apply basic security measures to protect your VPS against attacks and unauthorised access" -updated: 2024-10-07 +updated: 2025-11-04 --- ## Objective @@ -94,8 +94,13 @@ Find the following or similar lines: #ListenAddress 0.0.0.0 ``` -Replace the number **22** with the port number of your choice. **Please do not enter a port number already used on your system**. To be safe, use a number between 49152 and 65535. -Save and exit the configuration file. +Replace the number **22** with the port number of your choice. **Please do not enter a port number already used on your system**. To be safe, use a number between 49152 and 65535. + +Alternatively, you can view the ports assigned on your system with the following command: + +```bash +sudo cat /etc/services +``` If the line is "commented out" (i.e. if it is preceded by a "#") as shown in the example above, make sure to remove the "#" before saving the file so that the change takes effect. Example: @@ -105,6 +110,12 @@ Port 49152 #ListenAddress 0.0.0.0 ``` +> [!warning] +> If a firewall is configured on your operating system (UFW or iptables), you must adjust its settings to allow traffic on the new port before restarting the service. If you are using iptables, refer to this guide: [Configuring the firewall on Linux with iptables](/pages/bare_metal_cloud/dedicated_servers/firewall-Linux-iptable/). If no firewall is configured by default, restart the service. +> + +Save and exit the configuration file. + Restart the service: ```bash @@ -113,7 +124,7 @@ sudo systemctl restart sshd This should be sufficient to apply the changes. Alternatively, reboot the VPS (`sudo reboot`). -**For Ubuntu 23.04 and later** +**For Ubuntu 24.04 and later** For the latest Ubuntu versions, the SSH configuration is now managed in the `ssh.socket` file. @@ -123,23 +134,44 @@ To update the SSH port, edit the `Listenstream` line in the configuration file w sudo nano /lib/systemd/system/ssh.socket ``` +Your file should resemble the following examples, depending on the version of Ubuntu you have installed: + ```console [Socket] ListenStream=49152 Accept=no ``` +or + +```console +[Socket] +ListenStream=0.0.0.0:49152 +ListenStream=[::]:22 +BindIPv6Only=ipv6-only +Accept=no +FreeBind=yes +``` + Save your changes and run the following commands: ```bash sudo systemctl daemon-reload ``` +Restart the service: + ```bash sudo systemctl restart ssh.service ``` -If you have enabled your operating system's firewall, make sure you allow the new port in your firewall rules. +**Ubuntu 25.04** + +Restart the service: + +```bash +sudo systemctl restart ssh.socket +``` Remember that you will have to indicate the new port any time you [establish an SSH connection to your server](/pages/bare_metal_cloud/dedicated_servers/ssh_introduction): @@ -153,6 +185,8 @@ Example: ssh ubuntu@203.0.113.100 -p 49152 ``` +If you are locked out of your system, you can use our [rescue mode](/pages/bare_metal_cloud/virtual_private_servers/rescue/) environment to revert your changes. + ### Creating a user with restricted rights In general, tasks that do not require root privileges should be performed via a standard user. Please refer to the information in [this guide](/pages/bare_metal_cloud/dedicated_servers/changing_root_password_linux_ds) for details. diff --git a/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.en-us.md b/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.en-us.md index 0e82b3ff349..33c16823a97 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.en-us.md +++ b/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.en-us.md @@ -1,7 +1,7 @@ --- title: "How to secure a VPS" excerpt: "Find out how to apply basic security measures to protect your VPS against attacks and unauthorised access" -updated: 2024-10-07 +updated: 2025-11-04 --- ## Objective @@ -94,8 +94,13 @@ Find the following or similar lines: #ListenAddress 0.0.0.0 ``` -Replace the number **22** with the port number of your choice. **Please do not enter a port number already used on your system**. To be safe, use a number between 49152 and 65535. -Save and exit the configuration file. +Replace the number **22** with the port number of your choice. **Please do not enter a port number already used on your system**. To be safe, use a number between 49152 and 65535. + +Alternatively, you can view the ports assigned on your system with the following command: + +```bash +sudo cat /etc/services +``` If the line is "commented out" (i.e. if it is preceded by a "#") as shown in the example above, make sure to remove the "#" before saving the file so that the change takes effect. Example: @@ -105,6 +110,12 @@ Port 49152 #ListenAddress 0.0.0.0 ``` +> [!warning] +> If a firewall is configured on your operating system (UFW or iptables), you must adjust its settings to allow traffic on the new port before restarting the service. If you are using iptables, refer to this guide: [Configuring the firewall on Linux with iptables](/pages/bare_metal_cloud/dedicated_servers/firewall-Linux-iptable/). If no firewall is configured by default, restart the service. +> + +Save and exit the configuration file. + Restart the service: ```bash @@ -113,7 +124,7 @@ sudo systemctl restart sshd This should be sufficient to apply the changes. Alternatively, reboot the VPS (`sudo reboot`). -**For Ubuntu 23.04 and later** +**For Ubuntu 24.04 and later** For the latest Ubuntu versions, the SSH configuration is now managed in the `ssh.socket` file. @@ -123,23 +134,44 @@ To update the SSH port, edit the `Listenstream` line in the configuration file w sudo nano /lib/systemd/system/ssh.socket ``` +Your file should resemble the following examples, depending on the version of Ubuntu you have installed: + ```console [Socket] ListenStream=49152 Accept=no ``` +or + +```console +[Socket] +ListenStream=0.0.0.0:49152 +ListenStream=[::]:22 +BindIPv6Only=ipv6-only +Accept=no +FreeBind=yes +``` + Save your changes and run the following commands: ```bash sudo systemctl daemon-reload ``` +Restart the service: + ```bash sudo systemctl restart ssh.service ``` -If you have enabled your operating system's firewall, make sure you allow the new port in your firewall rules. +**Ubuntu 25.04** + +Restart the service: + +```bash +sudo systemctl restart ssh.socket +``` Remember that you will have to indicate the new port any time you [establish an SSH connection to your server](/pages/bare_metal_cloud/dedicated_servers/ssh_introduction): @@ -153,6 +185,8 @@ Example: ssh ubuntu@203.0.113.100 -p 49152 ``` +If you are locked out of your system, you can use our [rescue mode](/pages/bare_metal_cloud/virtual_private_servers/rescue/) environment to revert your changes. + ### Creating a user with restricted rights In general, tasks that do not require root privileges should be performed via a standard user. Please refer to the information in [this guide](/pages/bare_metal_cloud/dedicated_servers/changing_root_password_linux_ds) for details. diff --git a/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.es-es.md b/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.es-es.md index 3e91f1b5160..77cfe9b5583 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.es-es.md +++ b/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.es-es.md @@ -1,7 +1,7 @@ --- title: "Proteger un VPS" excerpt: "Esta guía explica cómo aplicar medidas de seguridad básicas para proteger su VPS de ataques y accesos no autorizados" -updated: 2024-10-07 +updated: 2025-11-04 --- > [!primary] @@ -96,14 +96,19 @@ sudo nano /etc/ssh/sshd_config Encontrará las siguientes líneas o equivalentes: ```console -#Port 49152 +#Port 22 #AddressFamily any #ListenAddress 0.0.0.0 ``` Sustituya el número **22** por el número de puerto que desee. -**Recuerde que no debe indicar un número de puerto que ya esté en uso en su sistema**. Para mayor seguridad, utilice un número entre 49152 y 65535. -Guarde y cierre el archivo de configuración. +**Recuerde que no debe indicar un número de puerto que ya esté en uso en su sistema**. Para mayor seguridad, utilice un número entre 49152 y 65535. + +También puede ver los puertos asignados a su sistema con el siguiente comando: + +```bash +sudo cat /etc/services +``` Si la línea está "comentada" (es decir, precedida de un "#") como en el ejemplo anterior, asegúrese de eliminar el "#" antes de guardar el archivo para que se tenga en cuenta el cambio. Ejemplo: @@ -113,6 +118,12 @@ Port 49152 #ListenAddress 0.0.0.0 ``` +> [!warning] +> Si hay un cortafuegos configurado en su sistema operativo (UFW o iptables), debe ajustar su configuración para permitir el tráfico en el nuevo puerto antes de reiniciar el servicio. Si utiliza iptables, consulte esta guía: [Configurar el firewall de Linux con iptables](/pages/bare_metal_cloud/dedicated_servers/firewall-Linux-iptable/). Si no hay ningún cortafuegos configurado por defecto, reinicie el servicio. +> + +Guarde y cierre el archivo de configuración. + Reinicie el servicio: ```bash @@ -121,29 +132,54 @@ sudo systemctl restart sshd Esto debería ser suficiente para aplicar los cambios. En caso contrario, reinicie el VPS (`sudo reboot`). -**Para Ubuntu 23.04 y versiones posteriores** +**Para Ubuntu 24.04 y versiones posteriores** Para las últimas versiones de Ubuntu, la configuración SSH se gestiona ahora en el archivo /ssh.socket`. Para actualizar el puerto SSH, edite la línea `ListenStream` en el archivo de configuración con un editor de texto de su elección (`nano` utilizado en este ejemplo): +```bash +sudo nano /lib/systemd/system/ssh.socket +``` + +Su archivo debería parecerse a los siguientes ejemplos, dependiendo de la versión de Ubuntu que tenga instalada: + ```console [Socket] ListenStream=49152 Accept=no ``` +o + +```console +[Socket] +ListenStream=0.0.0.0:49152 +ListenStream=[::]:22 +BindIPv6Only=ipv6-only +Accept=no +FreeBind=yes +``` + Guarde los cambios y ejecute los siguientes comandos: ```bash sudo systemctl daemon-reload ``` +Reinicie el servicio: + ```bash sudo systemctl restart ssh.service ``` -Si ha activado el cortafuegos del sistema operativo, asegúrese de autorizar el nuevo puerto en las reglas del cortafuegos. +**Ubuntu 25.04** + +Reinicie el servicio: + +```bash +sudo systemctl restart ssh.socket +``` Recuerde que deberá indicar el nuevo puerto en cada solicitud de [conexión SSH al servidor](/pages/bare_metal_cloud/dedicated_servers/ssh_introduction): @@ -157,6 +193,8 @@ Ejemplo: ssh ubuntu@203.0.113.100 -p 49152 ``` +Si no puede acceder a su sistema, puede utilizar nuestro entorno [modo de rescate](/pages/bare_metal_cloud/virtual_private_servers/rescue/) para cancelar los cambios. + ### Crear un usuario con permisos restringidos Por lo general, las tareas que no requieran privilegios root deben realizarse a través de un usuario estándar. Para más información, consulte [esta guía](/pages/bare_metal_cloud/dedicated_servers/changing_root_password_linux_ds). @@ -294,4 +332,4 @@ En la [página de producto](/links/bare-metal/vps-options) y en las [respectivas [Configurar el firewall de red](/pages/bare_metal_cloud/dedicated_servers/firewall_network) -Interactúe con nuestra [comunidad de usuarios](/links/community). +Interactúe con nuestra [comunidad de usuarios](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.es-us.md b/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.es-us.md index 3e91f1b5160..77cfe9b5583 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.es-us.md +++ b/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.es-us.md @@ -1,7 +1,7 @@ --- title: "Proteger un VPS" excerpt: "Esta guía explica cómo aplicar medidas de seguridad básicas para proteger su VPS de ataques y accesos no autorizados" -updated: 2024-10-07 +updated: 2025-11-04 --- > [!primary] @@ -96,14 +96,19 @@ sudo nano /etc/ssh/sshd_config Encontrará las siguientes líneas o equivalentes: ```console -#Port 49152 +#Port 22 #AddressFamily any #ListenAddress 0.0.0.0 ``` Sustituya el número **22** por el número de puerto que desee. -**Recuerde que no debe indicar un número de puerto que ya esté en uso en su sistema**. Para mayor seguridad, utilice un número entre 49152 y 65535. -Guarde y cierre el archivo de configuración. +**Recuerde que no debe indicar un número de puerto que ya esté en uso en su sistema**. Para mayor seguridad, utilice un número entre 49152 y 65535. + +También puede ver los puertos asignados a su sistema con el siguiente comando: + +```bash +sudo cat /etc/services +``` Si la línea está "comentada" (es decir, precedida de un "#") como en el ejemplo anterior, asegúrese de eliminar el "#" antes de guardar el archivo para que se tenga en cuenta el cambio. Ejemplo: @@ -113,6 +118,12 @@ Port 49152 #ListenAddress 0.0.0.0 ``` +> [!warning] +> Si hay un cortafuegos configurado en su sistema operativo (UFW o iptables), debe ajustar su configuración para permitir el tráfico en el nuevo puerto antes de reiniciar el servicio. Si utiliza iptables, consulte esta guía: [Configurar el firewall de Linux con iptables](/pages/bare_metal_cloud/dedicated_servers/firewall-Linux-iptable/). Si no hay ningún cortafuegos configurado por defecto, reinicie el servicio. +> + +Guarde y cierre el archivo de configuración. + Reinicie el servicio: ```bash @@ -121,29 +132,54 @@ sudo systemctl restart sshd Esto debería ser suficiente para aplicar los cambios. En caso contrario, reinicie el VPS (`sudo reboot`). -**Para Ubuntu 23.04 y versiones posteriores** +**Para Ubuntu 24.04 y versiones posteriores** Para las últimas versiones de Ubuntu, la configuración SSH se gestiona ahora en el archivo /ssh.socket`. Para actualizar el puerto SSH, edite la línea `ListenStream` en el archivo de configuración con un editor de texto de su elección (`nano` utilizado en este ejemplo): +```bash +sudo nano /lib/systemd/system/ssh.socket +``` + +Su archivo debería parecerse a los siguientes ejemplos, dependiendo de la versión de Ubuntu que tenga instalada: + ```console [Socket] ListenStream=49152 Accept=no ``` +o + +```console +[Socket] +ListenStream=0.0.0.0:49152 +ListenStream=[::]:22 +BindIPv6Only=ipv6-only +Accept=no +FreeBind=yes +``` + Guarde los cambios y ejecute los siguientes comandos: ```bash sudo systemctl daemon-reload ``` +Reinicie el servicio: + ```bash sudo systemctl restart ssh.service ``` -Si ha activado el cortafuegos del sistema operativo, asegúrese de autorizar el nuevo puerto en las reglas del cortafuegos. +**Ubuntu 25.04** + +Reinicie el servicio: + +```bash +sudo systemctl restart ssh.socket +``` Recuerde que deberá indicar el nuevo puerto en cada solicitud de [conexión SSH al servidor](/pages/bare_metal_cloud/dedicated_servers/ssh_introduction): @@ -157,6 +193,8 @@ Ejemplo: ssh ubuntu@203.0.113.100 -p 49152 ``` +Si no puede acceder a su sistema, puede utilizar nuestro entorno [modo de rescate](/pages/bare_metal_cloud/virtual_private_servers/rescue/) para cancelar los cambios. + ### Crear un usuario con permisos restringidos Por lo general, las tareas que no requieran privilegios root deben realizarse a través de un usuario estándar. Para más información, consulte [esta guía](/pages/bare_metal_cloud/dedicated_servers/changing_root_password_linux_ds). @@ -294,4 +332,4 @@ En la [página de producto](/links/bare-metal/vps-options) y en las [respectivas [Configurar el firewall de red](/pages/bare_metal_cloud/dedicated_servers/firewall_network) -Interactúe con nuestra [comunidad de usuarios](/links/community). +Interactúe con nuestra [comunidad de usuarios](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.fr-ca.md b/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.fr-ca.md index 0688ce7f076..3b5fa75088a 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.fr-ca.md +++ b/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.fr-ca.md @@ -1,7 +1,7 @@ --- title: "Sécuriser un VPS" excerpt: "Découvrez comment mettre en place des mesures de sécurité basiques pour protéger votre VPS des attaques et des accès non autorisés" -updated: 2024-10-07 +updated: 2025-11-04 --- ## Objectif @@ -92,15 +92,20 @@ sudo nano /etc/ssh/sshd_config Vous devriez trouver les lignes suivantes ou équivalentes : ```console -#Port 49152 +#Port 22 #AddressFamily any #ListenAddress 0.0.0.0 ``` Remplacez le nombre **22** par le numéro de port de votre choix.
**Veillez toutefois à ne pas renseigner un numéro de port déjà utilisé sur votre système**. -Pour plus de sécurité, utilisez un numéro entre 49152 et 65535.
Enregistrez et quittez le fichier de configuration. +Pour plus de sécurité, utilisez un numéro entre 49152 et 65535. +Vous pouvez également afficher les ports attribués à votre système à l'aide de la commande suivante : + +```bash +sudo cat /etc/services +``` Si la ligne est "commentée" (c'est-à-dire si elle est précédée d'un "#") comme dans l'exemple ci-dessus, veillez à supprimer le "#" avant d'enregistrer le fichier pour que la modification soit prise en compte. Exemple : @@ -110,6 +115,12 @@ Port 49152 #ListenAddress 0.0.0.0 ``` +> [!warning] +> Si un pare-feu est configuré sur votre système d'exploitation (UFW ou iptables), vous devez ajuster ses paramètres pour autoriser le trafic sur le nouveau port avant de redémarrer le service. Si vous utilisez iptables, consultez ce guide : [Configurer le pare-feu sous Linux avec Iptables](/pages/bare_metal_cloud/dedicated_servers/firewall-Linux-iptable/). Si aucun pare-feu n'est configuré par défaut, redémarrez le service. +> + +Enregistrez et quittez le fichier de configuration. + Redémarrez le service : ```bash @@ -118,29 +129,54 @@ sudo systemctl restart sshd Cela devrait être suffisant pour appliquer les changements. Dans le cas contraire, redémarrez le VPS (`sudo reboot`). -**Pour Ubuntu 23.04 et versions ultérieures** +**Pour Ubuntu 24.04 et versions ultérieures** Pour les dernières versions d'Ubuntu, la configuration SSH est désormais gérée dans le fichier `ssh.socket`. Pour mettre à jour le port SSH, éditez la ligne `Listenstream` dans le fichier de configuration avec un éditeur de texte de votre choix (`nano` utilisé dans cet exemple) : +```bash +sudo nano /lib/systemd/system/ssh.socket +``` + +Votre fichier devrait ressembler aux exemples suivants, en fonction de la version d'Ubuntu que vous avez installée : + ```console [Socket] ListenStream=49152 Accept=no ``` +ou + +```console +[Socket] +ListenStream=0.0.0.0:49152 +ListenStream=[::]:22 +BindIPv6Only=ipv6-only +Accept=no +FreeBind=yes +``` + Enregistrez vos modifications et exécutez les commandes suivantes : ```bash sudo systemctl daemon-reload ``` +Redémarrez le service : + ```bash sudo systemctl restart ssh.service ``` -Si vous avez activé le pare-feu de votre système d'exploitation, assurez-vous d'autoriser le nouveau port dans les règles du pare-feu. +**Ubuntu 25.04** + +Redémarrez le service : + +```bash +sudo systemctl restart ssh.socket +``` N'oubliez pas que vous devrez indiquer le nouveau port à chaque demande de [connexion SSH à votre serveur](/pages/bare_metal_cloud/dedicated_servers/ssh_introduction) : @@ -154,6 +190,8 @@ Exemple : ssh ubuntu@203.0.113.100 -p 49152 ``` +Si vous êtes bloqué hors de votre système, vous pouvez utiliser notre [mode rescue](/pages/bare_metal_cloud/virtual_private_servers/rescue/) pour annuler vos modifications. + ### Créer un utilisateur avec des droits restreints En général, les tâches qui ne requièrent pas de privilèges root doivent être effectuées via un utilisateur standard. Pour plus d'informations, consultez [ce guide](/pages/bare_metal_cloud/dedicated_servers/changing_root_password_linux_ds). diff --git a/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.fr-fr.md b/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.fr-fr.md index 3923ae822cb..5f9b4636312 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.fr-fr.md +++ b/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.fr-fr.md @@ -1,7 +1,7 @@ --- title: "Sécuriser un VPS" -excerpt: "Découvrez comment mettre en place des mesures de sécurité basiques pour protéger votre VPS contre les attaques et les accès non autorisés" -updated: 2024-10-07 +excerpt: "Découvrez comment mettre en place des mesures de sécurité basiques pour protéger votre VPS des attaques et des accès non autorisés" +updated: 2025-11-04 --- ## Objectif @@ -92,15 +92,20 @@ sudo nano /etc/ssh/sshd_config Vous devriez trouver les lignes suivantes ou équivalentes : ```console -#Port 49152 +#Port 22 #AddressFamily any #ListenAddress 0.0.0.0 ``` Remplacez le nombre **22** par le numéro de port de votre choix.
**Veillez toutefois à ne pas renseigner un numéro de port déjà utilisé sur votre système**. -Pour plus de sécurité, utilisez un numéro entre 49152 et 65535.
Enregistrez et quittez le fichier de configuration. +Pour plus de sécurité, utilisez un numéro entre 49152 et 65535. +Vous pouvez également afficher les ports attribués à votre système à l'aide de la commande suivante : + +```bash +sudo cat /etc/services +``` Si la ligne est "commentée" (c'est-à-dire si elle est précédée d'un "#") comme dans l'exemple ci-dessus, veillez à supprimer le "#" avant d'enregistrer le fichier pour que la modification soit prise en compte. Exemple : @@ -110,6 +115,12 @@ Port 49152 #ListenAddress 0.0.0.0 ``` +> [!warning] +> Si un pare-feu est configuré sur votre système d'exploitation (UFW ou iptables), vous devez ajuster ses paramètres pour autoriser le trafic sur le nouveau port avant de redémarrer le service. Si vous utilisez iptables, consultez ce guide : [Configurer le pare-feu sous Linux avec Iptables](/pages/bare_metal_cloud/dedicated_servers/firewall-Linux-iptable/). Si aucun pare-feu n'est configuré par défaut, redémarrez le service. +> + +Enregistrez et quittez le fichier de configuration. + Redémarrez le service : ```bash @@ -118,29 +129,54 @@ sudo systemctl restart sshd Cela devrait être suffisant pour appliquer les changements. Dans le cas contraire, redémarrez le VPS (`sudo reboot`). -**Pour Ubuntu 23.04 et versions ultérieures** +**Pour Ubuntu 24.04 et versions ultérieures** Pour les dernières versions d'Ubuntu, la configuration SSH est désormais gérée dans le fichier `ssh.socket`. Pour mettre à jour le port SSH, éditez la ligne `Listenstream` dans le fichier de configuration avec un éditeur de texte de votre choix (`nano` utilisé dans cet exemple) : +```bash +sudo nano /lib/systemd/system/ssh.socket +``` + +Votre fichier devrait ressembler aux exemples suivants, en fonction de la version d'Ubuntu que vous avez installée : + ```console [Socket] ListenStream=49152 Accept=no ``` +ou + +```console +[Socket] +ListenStream=0.0.0.0:49152 +ListenStream=[::]:22 +BindIPv6Only=ipv6-only +Accept=no +FreeBind=yes +``` + Enregistrez vos modifications et exécutez les commandes suivantes : ```bash sudo systemctl daemon-reload ``` +Redémarrez le service : + ```bash sudo systemctl restart ssh.service ``` -Si vous avez activé le pare-feu de votre système d'exploitation, assurez-vous d'autoriser le nouveau port dans les règles du pare-feu. +**Ubuntu 25.04** + +Redémarrez le service : + +```bash +sudo systemctl restart ssh.socket +``` N'oubliez pas que vous devrez indiquer le nouveau port à chaque demande de [connexion SSH à votre serveur](/pages/bare_metal_cloud/dedicated_servers/ssh_introduction) : @@ -154,6 +190,8 @@ Exemple : ssh ubuntu@203.0.113.100 -p 49152 ``` +Si vous êtes bloqué hors de votre système, vous pouvez utiliser notre [mode rescue](/pages/bare_metal_cloud/virtual_private_servers/rescue/) pour annuler vos modifications. + ### Créer un utilisateur avec des droits restreints En général, les tâches qui ne requièrent pas de privilèges root doivent être effectuées via un utilisateur standard. Pour plus d'informations, consultez [ce guide](/pages/bare_metal_cloud/dedicated_servers/changing_root_password_linux_ds). @@ -291,4 +329,4 @@ Vous trouverez toutes les informations sur les solutions de sauvegarde disponibl [Configurer le Network Firewall](/pages/bare_metal_cloud/dedicated_servers/firewall_network) -Échangez avec notre [communauté d'utilisateurs](/links/community). +Échangez avec notre [communauté d'utilisateurs](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.it-it.md b/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.it-it.md index 8f483a473a6..e6dc1bd311f 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.it-it.md +++ b/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.it-it.md @@ -1,7 +1,7 @@ --- title: "Mettere in sicurezza un VPS" excerpt: "Come impostare misure di sicurezza di base per proteggere il VPS da attacchi e accessi non autorizzati" -updated: 2024-10-07 +updated: 2025-11-04 --- > [!primary] @@ -94,15 +94,20 @@ sudo nano /etc/ssh/sshd_config Dovrai trovare queste linee o equivalenti: ```console -#Port 49152 +#Port 22 #AddressFamily any #ListenAddress 0.0.0.0 ``` Sostituisci il numero **22** con il numero di porta che preferisci.
**Ricordati di non inserire un numero di porta già utilizzato sul tuo sistema**. -Per una maggiore sicurezza, utilizza un numero tra 49152 e 65535.
Salva e lascia il file di configurazione. +Per una maggiore sicurezza, utilizza un numero tra 49152 e 65535. +È inoltre possibile visualizzare le porte assegnate al proprio sistema utilizzando il seguente comando: + +```bash +sudo cat /etc/services +``` Se la riga è "commentata" (cioè preceduta da un "#") come nell'esempio precedente, assicurarsi di rimuovere il "#" prima di salvare il file, in modo che la modifica venga presa in considerazione. Esempio: @@ -112,6 +117,12 @@ Port 49152 #ListenAddress 0.0.0.0 ``` +> [!warning] +> Se sul sistema operativo è configurato un firewall (UFW o iptables), è necessario modificarne le impostazioni per consentire il traffico sulla nuova porta prima di riavviare il servizio. Se si utilizza iptables, consultare questa guida: [Configura il firewall su Linux con iptables](/pages/bare_metal_cloud/dedicated_servers/firewall-Linux-iptable/). Se non è configurato alcun firewall predefinito, riavviare il servizio. +> + +Salva e lascia il file di configurazione. + Riavvia il servizio: ```bash @@ -120,29 +131,54 @@ sudo systemctl restart sshd Ciò dovrebbe essere sufficiente per attuare le modifiche. In caso contrario, riavvia il VPS (`sudo reboot`). -**Per Ubuntu 23.04 e versioni successive** +**Per Ubuntu 24.04 e versioni successive** Per le ultime versioni di Ubuntu, la configurazione SSH viene gestita nel file `ssh.socket`. Per aggiornare la porta SSH, modifica la riga `ListenStream` nel file di configurazione con un editor di testo a tua scelta (`nano` utilizzato in questo esempio): +```bash +sudo nano /lib/systemd/system/ssh.socket +``` + +Il tuo file dovrebbe essere simile ai seguenti esempi, a seconda della versione di Ubuntu che hai installato: + ```console [Socket] ListenStream=49152 Accept=no ``` +oppure + +```console +[Socket] +ListenStream=0.0.0.0:49152 +ListenStream=[::]:22 +BindIPv6Only=ipv6-only +Accept=no +FreeBind=yes +``` + Salvare le modifiche ed eseguire i comandi seguenti: ```bash sudo systemctl daemon-reload ``` +Riavvia il servizio: + ```bash sudo systemctl restart ssh.service ``` -Se è stato attivato il firewall del sistema operativo, assicurarsi di consentire la nuova porta secondo le regole del firewall. +**Ubuntu 25.04** + +Riavvia il servizio: + +```bash +sudo systemctl restart ssh.socket +``` Ricordati di indicare la nuova porta ad ogni richiesta di [connessione SSH al tuo server](/pages/bare_metal_cloud/dedicated_servers/ssh_introduction): @@ -156,6 +192,8 @@ Esempio: ssh ubuntu@203.0.113.100 -p 49152 ``` +Se sei bloccato fuori dal tuo sistema, puoi utilizzare il nostro ambiente [Rescue mode](/pages/bare_metal_cloud/virtual_private_servers/rescue/) per annullare le modifiche apportate. + ### Crea un account con diritti utente limitati In genere, i compiti che non richiedono privilegi root devono essere eseguiti tramite un utente standard. Per maggiori informazioni, consulta [questa guida](/pages/bare_metal_cloud/dedicated_servers/changing_root_password_linux_ds). diff --git a/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.pl-pl.md b/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.pl-pl.md index 38e9f422279..4f3eb339e33 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.pl-pl.md +++ b/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.pl-pl.md @@ -1,7 +1,7 @@ --- title: "Zabezpieczenie serwera VPS" excerpt: "Dowiedz się, jak wdrożyć podstawowe środki bezpieczeństwa, aby chronić Twój serwer VPS przed atakami i nieautoryzowanym dostępem" -updated: 2024-10-07 +updated: 2025-11-04 --- > [!primary] @@ -17,7 +17,7 @@ Kiedy zamawiasz serwer VPS, możesz wybrać dystrybucję lub system operacyjny d > [!warning] > OVHcloud świadczy usługi, za które jesteś odpowiedzialny w związku z ich konfiguracją i zarządzaniem. Jesteś więc odpowiedzialny za ich prawidłowe funkcjonowanie. > ->Jeśli napotkasz trudności z przeprowadzeniem tych operacji, skontaktuj się z wyspecjalizowanym dostawcą usług i/lub przedyskutuj problem z naszą społecznością użytkowników na stronie https://community.ovh.com/en/. OVHcloud nie może udzielić Ci wsparcia technicznego w tym zakresie. +> Jeśli napotkasz trudności z przeprowadzeniem tych operacji, skontaktuj się z wyspecjalizowanym dostawcą usług i/lub przedyskutuj problem z naszą społecznością użytkowników na stronie https://community.ovh.com/en/. OVHcloud nie może udzielić Ci wsparcia technicznego w tym zakresie. > ## Wymagania początkowe @@ -95,14 +95,20 @@ sudo nano /etc/ssh/sshd_config Należy znaleźć następujące lub równoważne linie: ```console -#Port 49152 +#Port 22 #AddressFamily any #ListenAddress 0.0.0.0 ``` Zamień liczbę **22** na wybrany numer portu.
**Pamiętaj, aby nie wpisywać numeru portu już używanego w systemie**. -Aby zwiększyć bezpieczeństwo, wprowadź numer 49152 i 65535.
Zapisz i wyjdź z pliku konfiguracyjnego. +Aby zwiększyć bezpieczeństwo, wprowadź numer 49152 i 65535. + +Możesz również wyświetlić porty przypisane do Twojego systemu za pomocą następującego polecenia: + +```bash +sudo cat /etc/services +``` Jeśli linia jest "zakomentowana" (tj. poprzedzona znakiem "#"), jak w powyższym przykładzie, należy usunąć znak "#" przed zapisaniem pliku, aby zmiana została uwzględniona. Przykład: @@ -112,6 +118,12 @@ Port 49152 #ListenAddress 0.0.0.0 ``` +> [!warning] +> Jeśli w systemie operacyjnym skonfigurowano zaporę ogniową (UFW lub iptables), przed ponownym uruchomieniem usługi należy dostosować jej ustawienia, aby zezwolić na ruch w nowym porcie. Jeśli używasz iptables, zapoznaj się z tym przewodnikiem: [Konfiguracja firewalla w systemie Linux z systemem iptables](/pages/bare_metal_cloud/dedicated_servers/firewall-Linux-iptable/). Jeśli domyślnie nie skonfigurowano żadnej zapory ogniowej, uruchom ponownie usługę. +> + +Zapisz i wyjdź z pliku konfiguracyjnego. + Zrestartuj usługę: ```bash @@ -120,29 +132,54 @@ sudo systemctl restart sshd Powinno to wystarczyć do wdrożenia zmian. W przeciwnym razie zrestartuj serwer VPS (`sudo reboot`). -**Dla systemu Ubuntu 23.04 i nowszych wersji** +**Dla systemu Ubuntu 24.04 i nowszych wersji** W przypadku najnowszych wersji Ubuntu, konfiguracja SSH jest zarządzana w pliku `ssh.socket`. Aby zaktualizować port SSH, edytuj wiersz `ListenStream` w pliku konfiguracyjnym za pomocą wybranego edytora tekstu (`nano` użyty w tym przykładzie): +```bash +sudo nano /lib/systemd/system/ssh.socket +``` + +Twój plik powinien wyglądać podobnie do poniższych przykładów, w zależności od zainstalowanej wersji Ubuntu: + ```console [Socket] ListenStream=49152 Accept=no ``` +lub + +```console +[Socket] +ListenStream=0.0.0.0:49152 +ListenStream=[::]:22 +BindIPv6Only=ipv6-only +Accept=no +FreeBind=yes +``` + Zapisz zmiany i wykonaj następujące polecenia: ```bash sudo systemctl daemon-reload ``` +Uruchom ponownie usługę: + ```bash sudo systemctl restart ssh.service ``` -Jeśli włączona jest zapora systemu operacyjnego, upewnij się, że zezwalasz na nowy port w regułach zapory. +**Ubuntu 25.04** + +Uruchom ponownie usługę: + +```bash +sudo systemctl restart ssh.socket +``` Pamiętaj, że podczas każdego zlecenia [połączenia SSH z Twoim serwerem](/pages/bare_metal_cloud/dedicated_servers/ssh_introduction) należy wskazać nowy port: @@ -156,6 +193,8 @@ Przykład: ssh ubuntu@203.0.113.100 -p 49152 ``` +Jeśli nie masz dostępu do swojego systemu, możesz skorzystać z naszego środowiska [trybu Rescue](/pages/bare_metal_cloud/virtual_private_servers/rescue/), aby anulować wprowadzone zmiany. + ### Utworzenie użytkownika z ograniczonymi prawami Zadania, które nie wymagają uprawnień root, powinny być wykonywane za pomocą standardowego użytkownika. Więcej informacji znajdziesz w [tym przewodniku](/pages/bare_metal_cloud/dedicated_servers/changing_root_password_linux_ds). diff --git a/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.pt-pt.md b/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.pt-pt.md index f18264e724f..f0df6c6bbb9 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.pt-pt.md +++ b/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps/guide.pt-pt.md @@ -1,7 +1,7 @@ --- title: "Proteger um VPS" excerpt: "Saiba como implementar medidas básicas de segurança para proteger o seu VPS de ataques e acessos não autorizados" -updated: 2024-10-07 +updated: 2025-11-04 --- > [!primary] @@ -95,7 +95,7 @@ sudo nano /etc/ssh/sshd_config Deve encontrar as seguintes linhas ou equivalentes: ```console -#Port 49152 +#Port 22 #AddressFamily any #ListenAddress 0.0.0.0 ``` @@ -104,6 +104,12 @@ Substitua o número **22** pelo número de porta à sua escolha.
**No entanto, certifique-se de que não indica um número de porta já utilizado no seu sistema**. Para uma maior segurança, utilize um número entre 49152 e 65535.
+Você também pode visualizar as portas atribuídas ao seu sistema usando o seguinte comando: + +```bash +sudo cat /etc/services +``` + Se a linha estiver "comentada" (ou seja, precedida por um "#") como no exemplo acima, certifique-se de que remove o "#" antes de guardar o ficheiro para que a alteração seja tida em conta. Exemplo: ```console @@ -112,7 +118,11 @@ Port 49152 #ListenAddress 0.0.0.0 ``` -Registe e saia do ficheiro de configuração. +> [!warning] +> Se estiver configurado um firewall no seu sistema operativo (UFW ou iptables), terá de ajustar as suas definições para autorizar o tráfego na nova porta antes de reiniciar o serviço. Se estiver a utilizar o iptables, consulte este guia: [Configurar a firewall em Linux com iptables](/pages/bare_metal_cloud/dedicated_servers/firewall-Linux-iptable/). Se não estiver configurado nenhum firewall por predefinição, reinicie o serviço. +> + +Guarde e saia do ficheiro de configuração. Reinicie o serviço: @@ -122,29 +132,55 @@ sudo systemctl restart sshd Isto deveria ser suficiente para aplicar as alterações. Caso contrário, reinicie o VPS (`sudo reboot`). -**Para Ubuntu 23.04 e versões posteriores** +**Para Ubuntu 24.04 e versões posteriores** Para as últimas versões de Ubuntu, a configuração SSH é agora gerida no ficheiro `ssh.socket`. Para atualizar a porta SSH, edite a linha `Listenstream` no ficheiro de configuração com um editor de texto à sua escolha (`nano` utilizado neste exemplo): -```consola + +```bash +sudo nano /lib/systemd/system/ssh.socket +``` + +O seu ficheiro deve ser semelhante aos exemplos a seguir, dependendo da versão do Ubuntu que você instalou: + +```console [Socket] ListenStream=49152 Accept=no ``` +ou + +```console +[Socket] +ListenStream=0.0.0.0:49152 +ListenStream=[::]:22 +BindIPv6Only=ipv6-only +Accept=no +FreeBind=yes +``` + Guarde as alterações e execute os seguintes comandos: ```bash sudo systemctl daemon-reload ``` +Reinicie o serviço: + ```bash sudo systemctl restart ssh.service ``` -Se tiver ativado a firewall do sistema operativo, certifique-se de que a nova porta está autorizada nas regras da firewall. +**Ubuntu 25.04** + +Reinicie o serviço: + +```bash +sudo systemctl restart ssh.socket +``` Lembre-se de que deve indicar a nova porta a cada pedido de [ligação SSH ao seu servidor](/pages/bare_metal_cloud/dedicated_servers/ssh_introduction): @@ -158,6 +194,8 @@ Exemplo: ssh ubuntu@203.0.113.100 -p 49152 ``` +Se você estiver bloqueado fora do seu sistema, pode usar o nosso ambiente [modo rescue](/pages/bare_metal_cloud/virtual_private_servers/rescue/) para anular as suas alterações. + ### Criar um utilizador com direitos restritos Em geral, as tarefas que não exijam privilégios root devem ser realizadas através de um utilizador standard. Para mais informações consulte [este guia](/pages/bare_metal_cloud/dedicated_servers/changing_root_password_linux_ds). diff --git a/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.de-de.md b/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.de-de.md index 57a147fe6be..9b672b91004 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.de-de.md +++ b/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.de-de.md @@ -130,7 +130,7 @@ Diese Optionen beziehen sich auf zusätzliche VPS-Dienste für Backups und die W Im Vergleich zu manuellen Snapshots erhöht diese Funktion die Datensicherheit, indem mehrere Wiederherstellungspunkte in regelmäßigen Abständen erstellt werden. >> -Genaue Informationen zu den für Ihren Dienst verfügbaren Backup-Lösungen finden Sie auf der [Produktseite](/links/bare-metal/vps-options) und in den entsprechenden [Anleitungen](/products/bare-metal-cloud-virtual-private-servers-backups). +Genaue Informationen zu den für Ihren Dienst verfügbaren Backup-Lösungen finden Sie auf der [Produktseite](/links/bare-metal/vps-options) und in den entsprechenden [Anleitungen](/products/bare-metal-cloud-virtual-private-configuration-servers-backups). #### Mein Angebot diff --git a/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.en-asia.md b/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.en-asia.md index ba361252da4..4e8a3d6d0e5 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.en-asia.md +++ b/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.en-asia.md @@ -128,7 +128,7 @@ These options refer to additional VPS services for backups and restoration of yo >> Compared to manual snapshots, this feature increases data security by creating several restore points at regular intervals. >> -You can find all information on the available backup solutions for your service on the [VPS product page](/links/bare-metal/vps-options) and in the [respective guides](/products/bare-metal-cloud-virtual-private-servers-backups). +You can find all information on the available backup solutions for your service on the [VPS product page](/links/bare-metal/vps-options) and in the [respective guides](/products/bare-metal-cloud-virtual-private-configuration-servers-backups). #### My offer diff --git a/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.en-au.md b/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.en-au.md index 183c5861f3d..663f34a115c 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.en-au.md +++ b/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.en-au.md @@ -128,7 +128,7 @@ These options refer to additional VPS services for backups and restoration of yo >> Compared to manual snapshots, this feature increases data security by creating several restore points at regular intervals. >> -You can find all information on the available backup solutions for your service on the [VPS product page](/links/bare-metal/vps-options) and in the [respective guides](/products/bare-metal-cloud-virtual-private-servers-backups). +You can find all information on the available backup solutions for your service on the [VPS product page](/links/bare-metal/vps-options) and in the [respective guides](/products/bare-metal-cloud-virtual-private-configuration-servers-backups). #### My offer diff --git a/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.en-ca.md b/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.en-ca.md index 183c5861f3d..663f34a115c 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.en-ca.md +++ b/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.en-ca.md @@ -128,7 +128,7 @@ These options refer to additional VPS services for backups and restoration of yo >> Compared to manual snapshots, this feature increases data security by creating several restore points at regular intervals. >> -You can find all information on the available backup solutions for your service on the [VPS product page](/links/bare-metal/vps-options) and in the [respective guides](/products/bare-metal-cloud-virtual-private-servers-backups). +You can find all information on the available backup solutions for your service on the [VPS product page](/links/bare-metal/vps-options) and in the [respective guides](/products/bare-metal-cloud-virtual-private-configuration-servers-backups). #### My offer diff --git a/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.en-gb.md b/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.en-gb.md index 183c5861f3d..663f34a115c 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.en-gb.md +++ b/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.en-gb.md @@ -128,7 +128,7 @@ These options refer to additional VPS services for backups and restoration of yo >> Compared to manual snapshots, this feature increases data security by creating several restore points at regular intervals. >> -You can find all information on the available backup solutions for your service on the [VPS product page](/links/bare-metal/vps-options) and in the [respective guides](/products/bare-metal-cloud-virtual-private-servers-backups). +You can find all information on the available backup solutions for your service on the [VPS product page](/links/bare-metal/vps-options) and in the [respective guides](/products/bare-metal-cloud-virtual-private-configuration-servers-backups). #### My offer diff --git a/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.en-ie.md b/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.en-ie.md index 183c5861f3d..663f34a115c 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.en-ie.md +++ b/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.en-ie.md @@ -128,7 +128,7 @@ These options refer to additional VPS services for backups and restoration of yo >> Compared to manual snapshots, this feature increases data security by creating several restore points at regular intervals. >> -You can find all information on the available backup solutions for your service on the [VPS product page](/links/bare-metal/vps-options) and in the [respective guides](/products/bare-metal-cloud-virtual-private-servers-backups). +You can find all information on the available backup solutions for your service on the [VPS product page](/links/bare-metal/vps-options) and in the [respective guides](/products/bare-metal-cloud-virtual-private-configuration-servers-backups). #### My offer diff --git a/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.en-sg.md b/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.en-sg.md index ba361252da4..4e8a3d6d0e5 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.en-sg.md +++ b/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.en-sg.md @@ -128,7 +128,7 @@ These options refer to additional VPS services for backups and restoration of yo >> Compared to manual snapshots, this feature increases data security by creating several restore points at regular intervals. >> -You can find all information on the available backup solutions for your service on the [VPS product page](/links/bare-metal/vps-options) and in the [respective guides](/products/bare-metal-cloud-virtual-private-servers-backups). +You can find all information on the available backup solutions for your service on the [VPS product page](/links/bare-metal/vps-options) and in the [respective guides](/products/bare-metal-cloud-virtual-private-configuration-servers-backups). #### My offer diff --git a/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.en-us.md b/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.en-us.md index 183c5861f3d..663f34a115c 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.en-us.md +++ b/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.en-us.md @@ -128,7 +128,7 @@ These options refer to additional VPS services for backups and restoration of yo >> Compared to manual snapshots, this feature increases data security by creating several restore points at regular intervals. >> -You can find all information on the available backup solutions for your service on the [VPS product page](/links/bare-metal/vps-options) and in the [respective guides](/products/bare-metal-cloud-virtual-private-servers-backups). +You can find all information on the available backup solutions for your service on the [VPS product page](/links/bare-metal/vps-options) and in the [respective guides](/products/bare-metal-cloud-virtual-private-configuration-servers-backups). #### My offer diff --git a/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.es-es.md b/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.es-es.md index 3b886944c6f..4f5f7a14d87 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.es-es.md +++ b/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.es-es.md @@ -128,7 +128,7 @@ Estas opciones hacen referencia a servicios VPS adicionales que pueden solicitar En comparación con las copias instantáneas manuales, esta función aumenta la seguridad de los datos al crear varios puntos de restauración a intervalos regulares. >> -Para más información sobre las soluciones de backup disponibles para su servicio, consulte la [página del producto VPS](/links/bare-metal/vps-options) y nuestras [guías respectivas](/products/bare-metal-cloud-virtual-private-servers-backups). +Para más información sobre las soluciones de backup disponibles para su servicio, consulte la [página del producto VPS](/links/bare-metal/vps-options) y nuestras [guías respectivas](/products/bare-metal-cloud-virtual-private-configuration-servers-backups). #### Mi solución diff --git a/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.es-us.md b/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.es-us.md index 3b886944c6f..4f5f7a14d87 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.es-us.md +++ b/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.es-us.md @@ -128,7 +128,7 @@ Estas opciones hacen referencia a servicios VPS adicionales que pueden solicitar En comparación con las copias instantáneas manuales, esta función aumenta la seguridad de los datos al crear varios puntos de restauración a intervalos regulares. >> -Para más información sobre las soluciones de backup disponibles para su servicio, consulte la [página del producto VPS](/links/bare-metal/vps-options) y nuestras [guías respectivas](/products/bare-metal-cloud-virtual-private-servers-backups). +Para más información sobre las soluciones de backup disponibles para su servicio, consulte la [página del producto VPS](/links/bare-metal/vps-options) y nuestras [guías respectivas](/products/bare-metal-cloud-virtual-private-configuration-servers-backups). #### Mi solución diff --git a/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.fr-ca.md b/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.fr-ca.md index ed561e8ea5c..5aafb6cd259 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.fr-ca.md +++ b/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.fr-ca.md @@ -129,7 +129,7 @@ Ces options font référence à des services VPS supplémentaires pour les sauve >> Par rapport aux snapshots manuels, cette fonctionnalité augmente la sécurité des données en créant plusieurs points de restauration à intervalles réguliers. >> -Retrouvez toutes les informations sur les solutions de sauvegarde disponibles pour votre service sur la [page produit VPS](/links/bare-metal/vps-options) et dans nos [guides respectifs](/products/bare-metal-cloud-virtual-private-servers-backups). +Retrouvez toutes les informations sur les solutions de sauvegarde disponibles pour votre service sur la [page produit VPS](/links/bare-metal/vps-options) et dans nos [guides respectifs](/products/bare-metal-cloud-virtual-private-configuration-servers-backups). #### Mon offre diff --git a/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.fr-fr.md b/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.fr-fr.md index ed561e8ea5c..5aafb6cd259 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.fr-fr.md +++ b/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.fr-fr.md @@ -129,7 +129,7 @@ Ces options font référence à des services VPS supplémentaires pour les sauve >> Par rapport aux snapshots manuels, cette fonctionnalité augmente la sécurité des données en créant plusieurs points de restauration à intervalles réguliers. >> -Retrouvez toutes les informations sur les solutions de sauvegarde disponibles pour votre service sur la [page produit VPS](/links/bare-metal/vps-options) et dans nos [guides respectifs](/products/bare-metal-cloud-virtual-private-servers-backups). +Retrouvez toutes les informations sur les solutions de sauvegarde disponibles pour votre service sur la [page produit VPS](/links/bare-metal/vps-options) et dans nos [guides respectifs](/products/bare-metal-cloud-virtual-private-configuration-servers-backups). #### Mon offre diff --git a/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.it-it.md b/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.it-it.md index 86eff6109e2..47dda480f22 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.it-it.md +++ b/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.it-it.md @@ -128,7 +128,7 @@ Queste opzioni si riferiscono a servizi VPS aggiuntivi per il backup e il ripris Rispetto alle copie istantanee manuali, questa funzione aumenta la sicurezza dei dati creando diversi punti di ripristino a intervalli regolari. >> -Tutte le informazioni sulle soluzioni di backup disponibili per il servizio sono disponibili nella [pagina dei prodotti VPS](/links/bare-metal/vps-options) e nelle nostre [guide rispettive](/products/bare-metal-cloud-virtual-private-servers-backups). +Tutte le informazioni sulle soluzioni di backup disponibili per il servizio sono disponibili nella [pagina dei prodotti VPS](/links/bare-metal/vps-options) e nelle nostre [guide rispettive](/products/bare-metal-cloud-virtual-private-configuration-servers-backups). #### Il mio servizio diff --git a/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.pl-pl.md b/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.pl-pl.md index b260d8cc911..0be5c794286 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.pl-pl.md +++ b/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.pl-pl.md @@ -128,7 +128,7 @@ Opcje te odnoszą się do dodatkowych usług VPS służących do wykonywania kop W porównaniu z migawkami ręcznymi funkcja ta zwiększa bezpieczeństwo danych, tworząc kilka punktów przywracania w regularnych odstępach czasu. >> -Wszystkie informacje dotyczące dostępnych dla Twojej usługi rozwiązań do tworzenia kopii zapasowych znajdują się na stronie [produkt VPS](/links/bare-metal/vps-options) oraz w naszych [przewodnikach](/products/bare-metal-cloud-virtual-private-servers-backups). +Wszystkie informacje dotyczące dostępnych dla Twojej usługi rozwiązań do tworzenia kopii zapasowych znajdują się na stronie [produkt VPS](/links/bare-metal/vps-options) oraz w naszych [przewodnikach](/products/bare-metal-cloud-virtual-private-configuration-servers-backups). ### Moja oferta diff --git a/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.pt-pt.md b/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.pt-pt.md index 556359de747..82a97305cab 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.pt-pt.md +++ b/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps/guide.pt-pt.md @@ -128,7 +128,7 @@ Estas opções referem-se a serviços VPS adicionais para backups e restauro do Em comparação com instantâneos manuais, esta funcionalidade aumenta a segurança dos dados através da criação de vários pontos de restauro em intervalos regulares. >> -Encontre todas as informações sobre as soluções de backup disponíveis para o seu serviço na [página do produto VPS](/links/bare-metal/vps-options) e nos nossos [guias respetivos](/products/bare-metal-cloud-virtual-private-servers-backups). +Encontre todas as informações sobre as soluções de backup disponíveis para o seu serviço na [página do produto VPS](/links/bare-metal/vps-options) e nos nossos [guias respetivos](/products/bare-metal-cloud-virtual-private-configuration-servers-backups). ### A minha oferta diff --git a/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.de-de.md b/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.de-de.md index 7fe2ff53463..8c14bc454f4 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.de-de.md +++ b/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.de-de.md @@ -1,7 +1,7 @@ --- title: VPS-Partitionierung nach einem Storage-Upgrade excerpt: Erfahren Sie hier, wie Sie den verwendbaren Speicherplatz nach einem Upgrade vergrößern -updated: 2023-09-05 +updated: 2025-11-05 --- > [!primary] @@ -172,6 +172,18 @@ Last sector, +sectors or +size{K,M,G} (2048-41943039, default 41943039): 4194303 Vergewissern Sie sich, dass der Standardwert in der Zeile `First sector` mit dem Wert übereinstimmt, den Sie zuvor notiert haben. Stimmt er nicht überein, verwenden Sie den von Ihnen aufgeschriebenen Wert. +Wenn die folgende Meldung angezeigt wird: + +```console +Partition #1 contains a ext4 signature. + +Do you want to remove the signature? [Y]es/[N]o: +``` + +Geben Sie `n` ein und fahren Sie fort. + +Die Antwort `y` bewirkt, dass das vorhandene ext4-Dateisystem auf Partition 1 überschrieben und die darin enthaltenen Daten gelöscht werden. + ### Die Partition bootfähig machen Jetzt muss sichergestellt werden, dass die Partition bootfähig ist. Das ist über den Befehl `a`{.action} möglich. @@ -209,7 +221,7 @@ The filesystem on /dev/sdb1 is now 5242624 blocks long. ### Überprüfung der Ergebnisse -Um zu überprüfen, ob das Erweitern funktioniert hat, können Sie die neu erstellte Partition einhängen und sich die Größe ansehen. +Um zu überprüfen, ob das Erweitern funktioniert hat, können Sie die neu erstellte Partition mounten und sich die Größe ansehen. ```sh mount /dev/sdb1 /mnt diff --git a/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.en-asia.md b/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.en-asia.md index c96e8f74342..90338edecd9 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.en-asia.md +++ b/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.en-asia.md @@ -1,7 +1,7 @@ --- title: Repartitioning a VPS after a storage upgrade excerpt: Find out how to increase the usable disk space following an upgrade -updated: 2023-09-05 +updated: 2025-11-05 --- ## Objective @@ -162,6 +162,18 @@ Last sector, +sectors or +size{K,M,G} (2048-41943039, default 41943039): 4194303 On the `First sector` line, check that the default value is the same as the one you have previously written down. If it is different, use the value you have written down. +If you see the following message: + +```console +Partition #1 contains a ext4 signature. + +Do you want to remove the signature? [Y]es/[N]o: +``` + +Enter `n` and proceed. + +Answering `y` would mean overwriting the existing ext4 file system on Partition 1 and agreeing to destroy the data on it. + #### Make the partition bootable You now need to ensure that the partition is bootable. You can do this using the command `a`{.action}. @@ -274,4 +286,4 @@ Enter your desired size and click `OK`{.action}. Your volume will now be extende ## Go further -Join our community of users at . +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.en-au.md b/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.en-au.md index c198d6ecba9..90338edecd9 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.en-au.md +++ b/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.en-au.md @@ -1,7 +1,7 @@ --- title: Repartitioning a VPS after a storage upgrade excerpt: Find out how to increase the usable disk space following an upgrade -updated: 2023-09-05 +updated: 2025-11-05 --- ## Objective @@ -145,7 +145,7 @@ Selected partition 1 The single partition will automatically be deleted. -### Create a new partition +#### Create a new partition You now need to create a new partition with the command `n`{.action}. It is recommended that you use the default values. @@ -162,7 +162,19 @@ Last sector, +sectors or +size{K,M,G} (2048-41943039, default 41943039): 4194303 On the `First sector` line, check that the default value is the same as the one you have previously written down. If it is different, use the value you have written down. -### Make the partition bootable +If you see the following message: + +```console +Partition #1 contains a ext4 signature. + +Do you want to remove the signature? [Y]es/[N]o: +``` + +Enter `n` and proceed. + +Answering `y` would mean overwriting the existing ext4 file system on Partition 1 and agreeing to destroy the data on it. + +#### Make the partition bootable You now need to ensure that the partition is bootable. You can do this using the command `a`{.action}. @@ -274,4 +286,4 @@ Enter your desired size and click `OK`{.action}. Your volume will now be extende ## Go further -Join our community of users at . +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.en-ca.md b/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.en-ca.md index c96e8f74342..90338edecd9 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.en-ca.md +++ b/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.en-ca.md @@ -1,7 +1,7 @@ --- title: Repartitioning a VPS after a storage upgrade excerpt: Find out how to increase the usable disk space following an upgrade -updated: 2023-09-05 +updated: 2025-11-05 --- ## Objective @@ -162,6 +162,18 @@ Last sector, +sectors or +size{K,M,G} (2048-41943039, default 41943039): 4194303 On the `First sector` line, check that the default value is the same as the one you have previously written down. If it is different, use the value you have written down. +If you see the following message: + +```console +Partition #1 contains a ext4 signature. + +Do you want to remove the signature? [Y]es/[N]o: +``` + +Enter `n` and proceed. + +Answering `y` would mean overwriting the existing ext4 file system on Partition 1 and agreeing to destroy the data on it. + #### Make the partition bootable You now need to ensure that the partition is bootable. You can do this using the command `a`{.action}. @@ -274,4 +286,4 @@ Enter your desired size and click `OK`{.action}. Your volume will now be extende ## Go further -Join our community of users at . +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.en-gb.md b/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.en-gb.md index 06ce1d4ffdb..a99b84bba04 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.en-gb.md +++ b/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.en-gb.md @@ -1,7 +1,7 @@ --- title: Repartitioning a VPS after a storage upgrade excerpt: Find out how to increase the usable disk space following an upgrade -updated: 2023-09-05 +updated: 2025-11-05 --- ## Objective @@ -162,6 +162,18 @@ Last sector, +sectors or +size{K,M,G} (2048-41943039, default 41943039): 4194303 On the `First sector` line, check that the default value is the same as the one you have previously written down. If it is different, use the value you have written down. +If you see the following message: + +```console +Partition #1 contains a ext4 signature. + +Do you want to remove the signature? [Y]es/[N]o: +``` + +Enter `n` and proceed. + +Answering `y` would mean overwriting the existing ext4 file system on Partition 1 and agreeing to destroy the data on it. + #### Make the partition bootable You now need to ensure that the partition is bootable. You can do this using the command `a`{.action}. diff --git a/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.en-ie.md b/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.en-ie.md index 6d7a9f8b93f..90338edecd9 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.en-ie.md +++ b/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.en-ie.md @@ -1,7 +1,7 @@ --- title: Repartitioning a VPS after a storage upgrade excerpt: Find out how to increase the usable disk space following an upgrade -updated: 2023-09-05 +updated: 2025-11-05 --- ## Objective @@ -160,7 +160,19 @@ First sector (2048-41943039, default 2048): 2048 Last sector, +sectors or +size{K,M,G} (2048-41943039, default 41943039): 41943039. ``` -On the `First sector` line, check that the default value is the same as the one you have previously written down. If it is different, use the value you have written down instead. +On the `First sector` line, check that the default value is the same as the one you have previously written down. If it is different, use the value you have written down. + +If you see the following message: + +```console +Partition #1 contains a ext4 signature. + +Do you want to remove the signature? [Y]es/[N]o: +``` + +Enter `n` and proceed. + +Answering `y` would mean overwriting the existing ext4 file system on Partition 1 and agreeing to destroy the data on it. #### Make the partition bootable @@ -274,4 +286,4 @@ Enter your desired size and click `OK`{.action}. Your volume will now be extende ## Go further -Join our community of users at . +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.en-sg.md b/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.en-sg.md index c96e8f74342..90338edecd9 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.en-sg.md +++ b/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.en-sg.md @@ -1,7 +1,7 @@ --- title: Repartitioning a VPS after a storage upgrade excerpt: Find out how to increase the usable disk space following an upgrade -updated: 2023-09-05 +updated: 2025-11-05 --- ## Objective @@ -162,6 +162,18 @@ Last sector, +sectors or +size{K,M,G} (2048-41943039, default 41943039): 4194303 On the `First sector` line, check that the default value is the same as the one you have previously written down. If it is different, use the value you have written down. +If you see the following message: + +```console +Partition #1 contains a ext4 signature. + +Do you want to remove the signature? [Y]es/[N]o: +``` + +Enter `n` and proceed. + +Answering `y` would mean overwriting the existing ext4 file system on Partition 1 and agreeing to destroy the data on it. + #### Make the partition bootable You now need to ensure that the partition is bootable. You can do this using the command `a`{.action}. @@ -274,4 +286,4 @@ Enter your desired size and click `OK`{.action}. Your volume will now be extende ## Go further -Join our community of users at . +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.en-us.md b/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.en-us.md index c96e8f74342..90338edecd9 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.en-us.md +++ b/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.en-us.md @@ -1,7 +1,7 @@ --- title: Repartitioning a VPS after a storage upgrade excerpt: Find out how to increase the usable disk space following an upgrade -updated: 2023-09-05 +updated: 2025-11-05 --- ## Objective @@ -162,6 +162,18 @@ Last sector, +sectors or +size{K,M,G} (2048-41943039, default 41943039): 4194303 On the `First sector` line, check that the default value is the same as the one you have previously written down. If it is different, use the value you have written down. +If you see the following message: + +```console +Partition #1 contains a ext4 signature. + +Do you want to remove the signature? [Y]es/[N]o: +``` + +Enter `n` and proceed. + +Answering `y` would mean overwriting the existing ext4 file system on Partition 1 and agreeing to destroy the data on it. + #### Make the partition bootable You now need to ensure that the partition is bootable. You can do this using the command `a`{.action}. @@ -274,4 +286,4 @@ Enter your desired size and click `OK`{.action}. Your volume will now be extende ## Go further -Join our community of users at . +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.es-es.md b/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.es-es.md index 21fe97a89bf..188bfff9d2e 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.es-es.md +++ b/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.es-es.md @@ -1,7 +1,7 @@ --- title: Reparticionar un VPS tras un upgrade de almacenamiento excerpt: "Cómo aumentar el espacio en disco útil después de una actualización" -updated: 2023-09-05 +updated: 2025-11-05 --- ## Objetivo @@ -163,7 +163,19 @@ First sector (2048-41943039, default 2048): 2048 Last sector, +sectors or +size{K,M,G} (2048-41943039, default 41943039): 41943039 ``` -En la línea «First sector», asegúrese de que el valor por defecto coincide con el que ha anotado anteriormente. Si es diferente, utilice el valor anotado. +En la línea `First sector`, asegúrese de que el valor por defecto coincide con el que ha anotado anteriormente. Si es diferente, utilice el valor anotado. + +Si aparece el siguiente mensaje: + +```console +Partition #1 contains a ext4 signature. + +Do you want to remove the signature? [Y]es/[N]o: +``` + +Introduzca `n` y continúe. + +Responder `y` significaría sobrescribir el sistema de archivos ext4 existente en la Partition 1 y aceptar destruir los datos que contiene. ### Hacer que la partición sea de arranque @@ -278,4 +290,4 @@ Escriba el tamaño deseado y haga clic en `Aceptar`{.action}. El volumen se ampl ## Más información -Interactúe con nuestra comunidad de usuarios en . +Interactúe con nuestra [comunidad de usuarios](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.es-us.md b/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.es-us.md index 21fe97a89bf..188bfff9d2e 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.es-us.md +++ b/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.es-us.md @@ -1,7 +1,7 @@ --- title: Reparticionar un VPS tras un upgrade de almacenamiento excerpt: "Cómo aumentar el espacio en disco útil después de una actualización" -updated: 2023-09-05 +updated: 2025-11-05 --- ## Objetivo @@ -163,7 +163,19 @@ First sector (2048-41943039, default 2048): 2048 Last sector, +sectors or +size{K,M,G} (2048-41943039, default 41943039): 41943039 ``` -En la línea «First sector», asegúrese de que el valor por defecto coincide con el que ha anotado anteriormente. Si es diferente, utilice el valor anotado. +En la línea `First sector`, asegúrese de que el valor por defecto coincide con el que ha anotado anteriormente. Si es diferente, utilice el valor anotado. + +Si aparece el siguiente mensaje: + +```console +Partition #1 contains a ext4 signature. + +Do you want to remove the signature? [Y]es/[N]o: +``` + +Introduzca `n` y continúe. + +Responder `y` significaría sobrescribir el sistema de archivos ext4 existente en la Partition 1 y aceptar destruir los datos que contiene. ### Hacer que la partición sea de arranque @@ -278,4 +290,4 @@ Escriba el tamaño deseado y haga clic en `Aceptar`{.action}. El volumen se ampl ## Más información -Interactúe con nuestra comunidad de usuarios en . +Interactúe con nuestra [comunidad de usuarios](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.fr-ca.md b/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.fr-ca.md index b7dc2d7e376..94a94194ff0 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.fr-ca.md +++ b/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.fr-ca.md @@ -1,7 +1,7 @@ --- title: Repartitionner un VPS après un upgrade de stockage excerpt: "Découvrez comment augmenter l'espace disque utilisable suite à une mise à niveau" -updated: 2023-09-05 +updated: 2025-11-05 --- ## Objectif @@ -163,6 +163,18 @@ Last sector, +sectors or +size{K,M,G} (2048-41943039, default 41943039): 4194303 Dans la ligne `First sector`, assurez-vous que la valeur par défaut est la même que celle que vous avez notée précédemment. Si elle diffère, utilisez la valeur que vous avez notée. +Si le message suivant s'affiche : + +```console +Partition #1 contains a ext4 signature. + +Do you want to remove the signature? [Y]es/[N]o: +``` + +Entrez « n » et continuez. + +Répondre « y » signifierait écraser le système de fichiers ext4 existant sur la Partition 1 et accepter de détruire les données qu'elle contient. + ### Rendre la partition amorçable (bootable) Vous devez maintenant vous assurer que la partition est amorçable (bootable). Pour ce faire, utilisez la commande `a`{.action} : @@ -275,4 +287,4 @@ Entrez la taille souhaitée et cliquez sur `OK`{.action}. Votre volume sera alor ## Aller plus loin -Échangez avec notre [communauté d'utilisateurs](/links/community). +Échangez avec notre [communauté d'utilisateurs](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.fr-fr.md b/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.fr-fr.md index dbc41a07d1e..9802b5c16f0 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.fr-fr.md +++ b/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.fr-fr.md @@ -1,7 +1,7 @@ --- title: Repartitionner un VPS après un upgrade de stockage excerpt: "Découvrez comment augmenter l'espace disque utilisable suite à une mise à niveau" -updated: 2023-09-05 +updated: 2025-11-05 --- ## Objectif @@ -163,7 +163,19 @@ Last sector, +sectors or +size{K,M,G} (2048-41943039, default 41943039): 4194303 Dans la ligne `First sector`, assurez-vous que la valeur par défaut est la même que celle que vous avez notée précédemment. Si elle diffère, utilisez la valeur que vous avez notée. -#### Rendre la partition amorçable (bootable) +Si le message suivant s'affiche : + +```console +Partition #1 contains a ext4 signature. + +Do you want to remove the signature? [Y]es/[N]o: +``` + +Entrez `n` et continuez. + +Répondre `y` signifierait écraser le système de fichiers ext4 existant sur la Partition 1 et accepter de détruire les données qu'elle contient. + +### Rendre la partition amorçable (bootable) Vous devez maintenant vous assurer que la partition est amorçable (bootable). Pour ce faire, utilisez la commande `a`{.action} : @@ -275,4 +287,4 @@ Entrez la taille souhaitée et cliquez sur `OK`{.action}. Votre volume sera alor ## Aller plus loin -Échangez avec notre [communauté d'utilisateurs](/links/community). +Échangez avec notre [communauté d'utilisateurs](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.it-it.md b/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.it-it.md index 13a12d64298..10959a29686 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.it-it.md +++ b/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.it-it.md @@ -1,7 +1,7 @@ --- title: Partizionare un VPS dopo un upgrade di storage excerpt: "Come aumentare lo spazio su disco utilizzabile in seguito a un aggiornamento" -updated: 2023-09-05 +updated: 2025-11-05 --- ## Obiettivo @@ -166,6 +166,18 @@ Last sector, +sectors or +size{K,M,G} (2048-41943039, default 41943039): 4194303 Assicurati che il valore predefinito indicato nella riga `First sector` corrisponda a quello annotato precedentemente (se differente, utilizza quest’ultimo). +Se viene visualizzato il seguente messaggio: + +```console +Partition #1 contains a ext4 signature. + +Do you want to remove the signature? [Y]es/[N]o: +``` + +Digita `n` e continua. + +Rispondere `y` significherebbe sovrascrivere il file system ext4 esistente sulla partizione 1 e accettare di distruggere i dati in essa contenuti. + ### Rendi la partizione avviabile (bootable) Per assicurarti che la partizione sia avviabile, esegui il comando `a`{.action}: @@ -279,4 +291,4 @@ Inserisci la dimensione desiderata e clicca su `OK`{.action}. Il volume verrà p ## Per saperne di più -Contatta la nostra Community di utenti all’indirizzo . +Contatta la nostra [Community di utenti](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.pl-pl.md b/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.pl-pl.md index 74733c6454e..be8a5a03c88 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.pl-pl.md +++ b/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.pl-pl.md @@ -1,7 +1,7 @@ --- title: Zmiana rozmiaru partycji serwera VPS po zmianie oferty przestrzeni dyskowej excerpt: "Dowiedz się, jak zwiększyć przestrzeń dyskową po aktualizacji" -updated: 2023-09-05 +updated: 2025-11-05 --- ## Wprowadzenie @@ -165,9 +165,21 @@ Last sector, +sectors or +size{K,M,G} (2048-41943039, default 41943039): 4194303 Musisz upewnić się, że wartość domyślna w wierszu `First sector` jest taka sama, jak wartość zanotowana wcześniej. Jeśli jest inna, należy użyć zanotowanej wartości. -### Ustawianie partycji bootowalnej +Jeśli pojawi się następujący komunikat: -Teraz należy upewnić się, że partycja jest bootowalna. Możesz to zrobić za pomocą polecenia `a`{.action}. +```console +Partition #1 contains a ext4 signature. + +Do you want to remove the signature? [Y]es/[N]o: +``` + +Wpisz `n` i kontynuuj. + +Odpowiedź `y` oznaczałaby nadpisanie istniejącego systemu plików ext4 na Partition 1 i zgodę na zniszczenie zawartych na niej danych. + +### Ustawianie partycji bootowalnej (bootable) + +Teraz należy upewnić się, że partycja jest bootowalna (bootable). Możesz to zrobić za pomocą polecenia `a`{.action}. ```console Command (m for help): a @@ -278,4 +290,4 @@ Wprowadź żądany rozmiar i kliknij `OK`{.action}. Wolumen zostanie wówczas ro ## Sprawdź również -Przyłącz się do społeczności naszych użytkowników na stronie . +Dołącz do [grona naszych użytkowników](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.pt-pt.md b/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.pt-pt.md index 72eddcdb565..536f87e8c81 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.pt-pt.md +++ b/pages/bare_metal_cloud/virtual_private_servers/upsize_vps_partition/guide.pt-pt.md @@ -1,7 +1,7 @@ --- title: Reparticionar um VPS após um upgrade de armazenamento excerpt: "Saiba como aumentar a quantidade de espaço útil no disco após uma atualização" -updated: 2023-09-05 +updated: 2025-11-05 --- ## Objetivo @@ -165,6 +165,18 @@ Last sector, +sectors or +size{K,M,G} (2048-41943039, default 41943039): 4194303 Na linha `First sector`, certifique-se que o valor predefinido é igual ao que foi anotado anteriormente. Se for diferente, use o valor que anotou antes. +Se a seguinte mensagem for exibida: + +```console +Partition #1 contains a ext4 signature. + +Do you want to remove the signature? [Y]es/[N]o: +``` + +Digite `n` e continue. + +Responder `y` significaria sobrescrever o sistema de ficheiros ext4 existente na partição 1 e aceitar destruir os dados nela contidos. + ### Configurar uma partição de arranque (bootable) A seguir, certifique-se de que a partição seja de arranque (bootable). Para tal, utilize o comando `a`{.action}. @@ -278,4 +290,4 @@ Introduza o tamanho pretendido e clique em `OK`{.action}. O seu volume será ent ## Quer saber mais? -Fale com a nossa comunidade de utilizadores em [https://community.ovh.com/en/](https://community.ovh.com/en/). +Fale com nossa [comunidade de utilizadores](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/using-automated-backups-on-a-vps/guide.de-de.md b/pages/bare_metal_cloud/virtual_private_servers/using-automated-backups-on-a-vps/guide.de-de.md index bb2e2e6d965..8b2bbc64614 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/using-automated-backups-on-a-vps/guide.de-de.md +++ b/pages/bare_metal_cloud/virtual_private_servers/using-automated-backups-on-a-vps/guide.de-de.md @@ -1,9 +1,22 @@ --- title: "Automatische Backups auf einem VPS verwenden" excerpt: "Erfahren Sie, wie Sie im OVHcloud Kundencenter die Backup-Option verwenden, um Ihre Daten zu sichern" -updated: 2025-09-11 +updated: 2025-10-17 --- + + ## Ziel Die Option für automatische Backups bietet eine komfortable Möglichkeit, vollständige Systemsicherungen über Ihr OVHcloud Kundencenter verfügbar zu machen, ohne eine Verbindung zum Server herstellen zu müssen, um sie manuell anzulegen und wiederherzustellen. Ein weiterer Vorteil ist, dass Sie auch wahlweise ein Backup erzeugen und dann über Remote-Verbindung darauf zugreifen können. @@ -41,7 +54,6 @@ Bevor Sie Backup-Optionen anwenden, empfehlen wir, die [Produktseiten und FAQ](/ - [Redhat Distributionen](#red) - [Windows](#win) -Loggen Sie sich in Ihr [OVHcloud Kundencenter](/links/manager) ein, gehen Sie in den Bereich `Bare Metal Cloud`{.action} und wählen Sie unter `Virtual Private Server`{.action} Ihren Server aus. Bei der Bestellung eines VPS ist ein tägliches automatisches Backup als kostenlose Service-Option inklusive. Mit dieser Standard-Option können Sie: @@ -52,15 +64,23 @@ Für mehr Flexibilität bei Ihren Backups können Sie die Option "Automatisches -### Upgrade auf Automatisches Backup Premium +### Automatisches Backup Premium abonnieren + +Die Option Automatisches Backup Premium erzeugt alle 24 Stunden zum ausgewählten Zeitpunkt ein Backup Ihres VPS. +Sie haben Zugriff auf alle täglichen Backups der letzten 7 Tage. Sobald 7 Backups erstellt wurden, ersetzt jedes neue Backup das älteste. -Mit einem Upgrade zu "Premium" erweitern Sie Ihre automatische Backup-Option auf ein tägliches Backup mit einer Verfügbarkeit von 7 Tagen. Dadurch können Sie im Vergleich zur 24-Stunden-Rotation der Standardoption auf ältere Backup-Versionen zurückgreifen. +Loggen Sie sich in Ihr [OVHcloud Kundencenter](/links/manager) ein, gehen Sie in den Bereich `Bare Metal Cloud`{.action}, wählen Sie `Virtual Private Server`{.action} aus und klicken Sie auf Ihren VPS-Namen. Nach der Auswahl Ihres VPS klicken Sie im horizontalen Menü auf den Tab `Automatisches Backup`{.action}. -Klicken Sie auf den Link `Premium Backup bestellen`{.action}. +Klicken Sie auf den Link `Premium Backup bestellen`{.action} (für Dienste, die seit dem 07.08.25 bestellt wurden) oder den Button `Automatisches Backup aktivieren`{.action}. + +
+ autobackup vps2025 + autobackup vps +
-![autobackupvps](images/backup_vps.png){.thumbnail} +Beachten Sie im nächsten Schritt die Preisinformationen und klicken Sie dann auf `Bestellen`{.action}. Sie werden durch den Bestellprozesses geführt und erhalten eine E-Mail zur Bestätigung. diff --git a/pages/bare_metal_cloud/virtual_private_servers/using-automated-backups-on-a-vps/guide.en-gb.md b/pages/bare_metal_cloud/virtual_private_servers/using-automated-backups-on-a-vps/guide.en-gb.md index 72938b69ae0..12b607f7964 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/using-automated-backups-on-a-vps/guide.en-gb.md +++ b/pages/bare_metal_cloud/virtual_private_servers/using-automated-backups-on-a-vps/guide.en-gb.md @@ -1,9 +1,22 @@ --- title: "How to use automated backups on a VPS" excerpt: "Find out how to use the Automated backup option in the OVHcloud Control Panel to secure your data" -updated: 2025-09-11 +updated: 2025-10-17 --- + + ## Objective The Automated backup option for VPS offers a convenient way to have complete system backups available from your OVHcloud Control Panel without having to connect to the server to create and restore them manually. Another advantage is that you can also choose to mount a backup and then access its files remotely. @@ -40,7 +53,6 @@ The Automated backup option for VPS offers a convenient way to have complete sys - [Redhat-based distributions](#red) - [Windows](#win) -Log in to your [OVHcloud Control Panel](/links/manager), open the `Bare Metal Cloud`{.action} section, and select your server under `Virtual Private Servers`{.action}. When you order a VPS, a single daily Automated backup is included as a free service option. This standard backup option allows you to: @@ -51,15 +63,21 @@ For more flexiblity with your backups, you can activate the Premium Automated Ba -### How to upgrade to Premium Automated Backup +### How to subscribe to Premium Automated Backup -Upgrading to Premium Automated Backup enhances your Automated backup option to a 7-day rolling daily backup. This allows you to revert to older backup versions compared to the 24-hour rotation of the standard option. +The Premium Automated Backup option creates a backup of your VPS every 24 hours at the specified time. +You will have access to all daily backups of the last 7 days. Once 7 backups are created, each new backup will replace the oldest one. -After selecting your VPS, click on the `Automated backup`{.action} tab in the horizontal menu. +Log in to your [OVHcloud Control Panel](/links/manager), open the `Bare Metal Cloud`{.action} section, select `Virtual Private Servers`{.action} and then click the name of your VPS. + +Click the `Automated backup`{.action} tab in the horizontal menu. -Click the link `Order a premium backup`{.action}. +Click the link `Order a premium backup`{.action} (for services ordered from 7 AUG, 2025) or the button `Enable Automated backup`{.action}. -![autobackupvps](images/backup_vps.png){.thumbnail} +
+ autobackup vps2025 + autobackup vps +
In the next step, please take note of the pricing information, then click on `Order`{.action}. You will be guided through the order process and receive a confirmation email. diff --git a/pages/bare_metal_cloud/virtual_private_servers/using-automated-backups-on-a-vps/guide.es-es.md b/pages/bare_metal_cloud/virtual_private_servers/using-automated-backups-on-a-vps/guide.es-es.md index be6847c2853..fe09652ddc7 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/using-automated-backups-on-a-vps/guide.es-es.md +++ b/pages/bare_metal_cloud/virtual_private_servers/using-automated-backups-on-a-vps/guide.es-es.md @@ -1,9 +1,22 @@ --- title: "Cómo utilizar los backups automatizados en un VPS" excerpt: "Descubra cómo utilizar la opción de backup automatizado desde el área de cliente de OVHcloud para proteger los datos" -updated: 2025-09-11 +updated: 2025-10-17 --- + + ## Objetivo La opción backup automatizado para VPS es una forma cómoda de tener copias de seguridad completas del sistema disponibles desde el área de cliente de OVHcloud sin tener que conectarse al servidor para crearlas y restaurarlas manualmente. Otra ventaja es que también puede optar por montar una copia de seguridad y acceder a sus archivos de forma remota. @@ -42,8 +55,6 @@ La opción backup automatizado para VPS es una forma cómoda de tener copias de - [Windows](#win) -Conéctese al [área de cliente de OVHcloud](/links/manager), acceda a la sección `Bare Metal Cloud`{.action} y seleccione el servidor en la sección `Servidores Privados Virtuales`{.action}. - Al contratar un VPS, la opción de servicio gratuito incluye una única copia de seguridad automática diaria. Esta opción de backup estándar le permite: - Montar y restaurar la copia de seguridad diaria. @@ -53,15 +64,23 @@ Para mayor flexibilidad en sus backups, puede activar la opción backup automati -### Cómo actualizar a backup automatizado Premium +### Cómo suscribirse al backup automatizado Premium -La actualización a backup automatizado Premium mejora su opción de backup automático a un backup diario continuo de 7 días. Esto le permite volver a versiones de backup más antiguas en comparación con la rotación de 24 horas de la opción estándar. +La opción de backup automatizado Premium crea una copia de seguridad de su VPS cada 24 horas en la hora especificada. +Tendrá acceso a todas las copias de seguridad diarias de los últimos 7 días. Una vez creadas 7 copias de seguridad, cada nueva copia de seguridad reemplazará a la más antigua. -Una vez seleccionado el VPS, haga clic en la pestaña `Backup automatizado`{.action} del menú horizontal. +Inicie sesión en el [área de cliente de OVHcloud](/links/manager), abra la sección `Bare Metal Cloud`{.action}, seleccione `Servidores Privados Virtuales`{.action} y luego haga clic en el nombre de su VPS. + +Haga clic en la pestaña `Backup automatizado`{.action} en el menú horizontal. + +Haga clic en el enlace `Contratar un backup automatizado premium`{.action} (para servicios pedidos desde el 7 de agosto de 2025) o en el botón `Activar el backup automatizado`{.action}. -Haga clic en el enlace `Contratar un backup automatizado premium`{.action}. +
+ autobackup vps2025 + autobackup vps +
-![autobackupvps](images/backup_vps.png){.thumbnail} +En el siguiente paso, anote la información de precios y haga clic en `Contratar`{.action}. Se le guiará a través del proceso de pedido y recibirá un mensaje de correo electrónico de confirmación. diff --git a/pages/bare_metal_cloud/virtual_private_servers/using-automated-backups-on-a-vps/guide.fr-fr.md b/pages/bare_metal_cloud/virtual_private_servers/using-automated-backups-on-a-vps/guide.fr-fr.md index 83fe4c395d4..6c5b1da15aa 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/using-automated-backups-on-a-vps/guide.fr-fr.md +++ b/pages/bare_metal_cloud/virtual_private_servers/using-automated-backups-on-a-vps/guide.fr-fr.md @@ -1,9 +1,22 @@ --- title: "Comment utiliser les sauvegardes automatisées sur un VPS" excerpt: "Découvrez comment utiliser l'option Backup automatisé depuis l'espace client OVHcloud pour sécuriser vos données" -updated: 2025-09-11 +updated: 2025-10-17 --- + + ## Objectif L'option Backup Automatisé pour les VPS offre un moyen pratique de disposer de sauvegardes complètes du système depuis votre espace client OVHcloud sans avoir à vous connecter au serveur pour créer et restaurer manuellement vos sauvegardes. Un autre avantage est que vous pouvez également choisir de monter une sauvegarde et accéder ensuite à ses fichiers à distance. @@ -42,7 +55,6 @@ L'option Backup Automatisé pour les VPS offre un moyen pratique de disposer de - [Distributions Debian](#red) - [Windows](#win) -Connectez-vous à votre [espace client OVHcloud](/links/manager), rendez-vous dans la section `Bare Metal Cloud`{.action} et sélectionnez votre serveur sous la partie `Serveurs privés virtuels`{.action}. Lorsque vous commandez un VPS, une seule sauvegarde automatique quotidienne est incluse en option de service gratuite. Cette option de sauvegarde standard vous permet de : @@ -53,15 +65,21 @@ Pour plus de flexibilité avec vos sauvegardes, vous pouvez activer l'option Bac -### Comment passer au Backup automatisé Premium +### Comment souscrire au Backup automatisé Premium -La mise à niveau vers le Backup automatisé Premium améliore votre option de sauvegarde automatique vers une sauvegarde quotidienne sur 7 jours glissants. Cela vous permet de revenir à des versions de sauvegardes plus anciennes par rapport à la rotation sur 24 heures de l'option standard. +Avec l'option Backup automatisé Premium, une sauvegarde de votre VPS est créée toutes les 24 heures à l'heure spécifiée. +Vous aurez accès à toutes les sauvegardes quotidiennes des 7 derniers jours. Une fois les 7 premières sauvegardes créées, chaque nouvelle sauvegarde remplacera la plus ancienne. -Après avoir sélectionné votre VPS, cliquez sur l'onglet `Backup automatisé`{.action} dans le menu horizontal. +Connectez-vous à votre [espace client OVHcloud](/links/manager), rendez-vous dans la section `Bare Metal Cloud`{.action}, sélectionnez `Serveurs privés virtuels`{.action}, puis cliquez sur le nom de votre VPS. + +Cliquez sur l'onglet `Backup automatisé`{.action} dans le menu horizontal. -Cliquez sur le lien `Commander un backup premium`{.action}. +Cliquez sur le lien `Commander un backup premium`{.action} (services commandés à partir du 7 août 2025) ou le bouton `Activer le Backup Automatisé`{.action}. -![autobackupvps](images/backup_vps.png){.thumbnail} +
+ autobackup vps2025 + autobackup vps +
Lors de l'étape suivante, veuillez prendre note des informations de tarification, puis cliquez sur `Commander`{.action}. Vous serez guidé tout au long du processus de commande et recevrez un e-mail de confirmation. diff --git a/pages/bare_metal_cloud/virtual_private_servers/using-automated-backups-on-a-vps/guide.it-it.md b/pages/bare_metal_cloud/virtual_private_servers/using-automated-backups-on-a-vps/guide.it-it.md index ca935219c2d..e09bd142ad9 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/using-automated-backups-on-a-vps/guide.it-it.md +++ b/pages/bare_metal_cloud/virtual_private_servers/using-automated-backups-on-a-vps/guide.it-it.md @@ -1,9 +1,22 @@ --- title: "Come utilizzare i backup automatizzati su un VPS" excerpt: "Come utilizzare l’opzione di Backup automatico nello Spazio Cliente OVHcloud per proteggere i dati" -updated: 2025-09-11 +updated: 2025-10-17 --- + + ## Obiettivo L’opzione di Backup automatico per VPS offre un modo pratico per avere backup di sistema completi disponibili dallo Spazio Cliente OVHcloud senza doversi connettere al server per crearli e ripristinarli manualmente. Un altro vantaggio consiste nella possibilità di scegliere di montare un backup e quindi di accedere ai file in remoto. @@ -42,8 +55,6 @@ Prima di applicare le opzioni di backup, consigliamo di fare riferimento alle pa - [Windows](#win) -Accedi allo [Spazio Cliente OVHcloud](/links/manager), clicca su `Bare Metal Cloud`{.action} e seleziona il tuo server nella sezione `Server Privati Virtuali`{.action}. - Quando ordini un VPS, come opzione di servizio gratuito è incluso un backup automatico giornaliero. Questa opzione di backup standard consente di: - Montare e ripristinare il backup giornaliero. @@ -53,15 +64,21 @@ Per una maggiore flessibilità con i backup, è possibile attivare l'opzione Bac -### Come passare a Backup automatico Premium +### Come sottoscrivere Backup automatico Premium -L'aggiornamento a Backup automatico Premium migliora l'opzione di backup automatico a un backup giornaliero attivo di 7 giorni. In questo modo è possibile ripristinare le versioni di backup precedenti rispetto alla rotazione di 24 ore dell'opzione standard. +L'opzione di Backup automatico Premium crea un backup del tuo VPS ogni 24 ore all'ora specificata. +Avrai accesso a tutti i backup giornalieri degli ultimi 7 giorni. Una volta creati 7 backup, ogni nuovo backup sostituirà il più vecchio. -Dopo aver selezionato il VPS, clicca sulla scheda `Backup automatico`{.action} nel menu orizzontale. +Accedi al tuo [Spazio Cliente OVHcloud](/links/manager), apri la sezione `Bare Metal Cloud`{.action}, seleziona `Server Privati Virtual`{.action} e clicca quindi sul nome del tuo VPS. + +Clicca sulla scheda `Backup automatico`{.action} nel menu orizzontale. -Clicca sul link `Ordina un backup Premium`{.action}. +Clicca sul link `Ordina un backup Premium`{.action} (per i servizi ordinati a partire dal 7 AGO, 2025) o sul pulsante `Attiva il Backup automatico`{.action}. -![autobackupvps](images/backup_vps.png){.thumbnail} +
+ autobackup vps2025 + autobackup vps +
Nello step successivo, esamina le informazioni sul prezzo, quindi clicca su `Ordina`{.action}. Sarai guidato attraverso la procedura d’ordine e riceverai una email di conferma. diff --git a/pages/bare_metal_cloud/virtual_private_servers/using-automated-backups-on-a-vps/guide.pl-pl.md b/pages/bare_metal_cloud/virtual_private_servers/using-automated-backups-on-a-vps/guide.pl-pl.md index 4caa0ee4681..83ab99c51c7 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/using-automated-backups-on-a-vps/guide.pl-pl.md +++ b/pages/bare_metal_cloud/virtual_private_servers/using-automated-backups-on-a-vps/guide.pl-pl.md @@ -1,9 +1,22 @@ --- title: "Jak korzystać z automatycznych kopii zapasowych na serwerze VPS" excerpt: "Dowiedz się, jak korzystać z opcji zautomatyzowany backup zapasowych z poziomu Panelu klienta OVHcloud do zabezpieczania danych" -updated: 2025-09-11 +updated: 2025-10-17 --- + + ## Wprowadzenie Opcja zautomatyzowany backup zapasowych dla serwerów VPS pozwala na udostępnienie pełnej kopii zapasowej systemu w Panelu klienta OVHcloud bez konieczności łączenia się z serwerem w celu ich ręcznego utworzenia i przywrócenia. Kolejną korzyścią jest możliwość zdalnego dostępu do plików kopii zapasowej przy jej wcześniejszym zamontowaniu. @@ -40,7 +53,6 @@ Opcja zautomatyzowany backup zapasowych dla serwerów VPS pozwala na udostępnie - [Dystrybucje Redhat](#red) - [Windows](#win) -Zaloguj się do [Panelu klienta OVHcloud](/links/manager), przejdź do sekcji `Bare Metal Cloud`{.action} i wybierz Twój serwer w części `Prywatne serwery wirtualne`{.action}. W przypadku zamówienia VPS codzienna automatyczna kopia zapasowa jest zawarta w cenie. Ta opcja kopii zapasowych pozwala na: @@ -51,15 +63,21 @@ Aby uzyskać większą elastyczność w zakresie kopii zapasowych, możesz włą -### Jak zmienić ofertę na zautomatyzowany backup Premium +### Jak subskrybować zautomatyzowany backup Premium -Migracja na ofertę zautomatyzowany backup Premium pozwoli na automatyczne tworzenie kopii zapasowych przez 7 kolejnych dni. Pozwala to na przywrócenie starszych wersji backupu w porównaniu z 24-godzinną rotacją opcji standardowej. +Opcja zautomatyzowany backup Premium tworzy kopię zapasową Twojego VPS co 24 godziny w wyznaczonym czasie. +Będziesz miał dostęp do wszystkich dziennych kopii zapasowych z ostatnich 7 dni. Po utworzeniu 7 kopii zapasowych, każda nowa kopia zastąpi najstarszą. -Po wybraniu prywatnego serwera wirtualnego kliknij kartę `Zautomatyzowany backup`{.action} w menu poziomym. +Zaloguj się do [Panelu klienta OVHcloud](/links/manager), otwórz sekcję `Bare Metal Cloud`{.action}, wybierz `Prywatne serwery wirtualne`{.action} a następnie kliknij nazwę swojego VPS. + +Kliknij kartę `Zautomatyzowany backup`{.action} w poziomym menu. -Kliknij link `Wła̧cz zautomatyzowany backup premium`{.action}. +Kliknij link `Wła̧cz zautomatyzowany backup premium`{.action} (dla usług zamówionych od 7 sierpnia 2025) lub przycisk `Włącz zautomatyzowany backup`{.action}. -![automatyczne kopie zapasowe](images/backup_vps.png){.thumbnail} +
+ autobackup vps2025 + autobackup vps +
W następnym kroku przeczytaj informację o cenie i kliknij pozycję `Zamów`{.action}. Po przejściu kolejnych kroków procesu zamówienia otrzymasz wiadomość e-mail z potwierdzeniem. diff --git a/pages/bare_metal_cloud/virtual_private_servers/using-automated-backups-on-a-vps/guide.pt-pt.md b/pages/bare_metal_cloud/virtual_private_servers/using-automated-backups-on-a-vps/guide.pt-pt.md index ed7278b8137..e6be1ce003a 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/using-automated-backups-on-a-vps/guide.pt-pt.md +++ b/pages/bare_metal_cloud/virtual_private_servers/using-automated-backups-on-a-vps/guide.pt-pt.md @@ -1,9 +1,22 @@ --- title: "Como utilizar os backups automatizados num VPS" excerpt: "Descubra como utilizar a opção Backup automatizado a partir da Área de Cliente OVHcloud para proteger os seus dados" -updated: 2025-09-11 +updated: 2025-10-17 --- + + ## Objetivo A opção de Backup automatizado para VPS oferece uma forma prática de ter backups do sistema completos disponíveis na Área de Cliente OVHcloud sem ter de se conectar ao servidor para os criar e restaurar manualmente. Outra vantagem é que também pode optar por montar um backup e depois aceder aos seus ficheiros remotamente. @@ -40,7 +53,6 @@ A opção de Backup automatizado para VPS oferece uma forma prática de ter back - [Distributions Redhat](#red) - [Windows](#win) -Ligue-se à sua [Área de Cliente OVHcloud](/links/manager), vá à secção `Bare Metal Cloud`{.action} e selecione o seu servidor na secção `Servidor privado virtual`{.action}. Quando adquire um VPS, é incluído um backup automático diário como opção de serviço gratuito. Esta opção de backup standard permite: @@ -51,15 +63,21 @@ Para uma maior flexibilidade dos seus backups, pode ativar a opção Backup auto -### Como passar para o Backup automatizado Premium +### Como assinar o Backup automatizado Premium + +A opção de Backup automatizado Premium cria um backup do seu VPS a cada 24 horas no horário especificado. +Você terá acesso a todos os backups diários dos últimos 7 dias. Uma vez criados 7 backups, cada novo backup substituirá o mais antigo. -A atualização para o Backup automatizado Premium melhora a sua opção de backup automático para um backup diário de atualização de 7 dias. Isto permite-lhe voltar às versões de backup mais antigas em comparação com a rotação de 24 horas da opção standard. +Faça login no seu [Área de Cliente OVHcloud](/links/manager), abra a seção `Bare Metal Cloud`{.action}, selecione `Servidor privado virtual`{.action} e, em seguida, clique no nome do seu VPS. -Após selecionar o seu alojamento VPS, clique no separador `Backup automatizado`{.action} no menu horizontal. +Clique na aba `Backup automatizado`{.action} no menu horizontal. -Clique no link `Encomendar uma cópia de segurança premium`{.action}. +Clique no link `Encomendar uma cópia de segurança premium`{.action} (para serviços encomendados a partir de 7 AGO, 2025) ou no botão `Ativar o Backup Automatizado`{.action}. -![autobackupvps](images/backup_vps.png){.thumbnail} +
+ autobackup vps2025 + autobackup vps +
Na etapa seguinte, tome nota da informação relativa ao preço e depois clique em `Encomendar`{.action}. Será então guiado através do processo de encomenda que será confirmado com o envio de um e-mail. diff --git a/pages/bare_metal_cloud/virtual_private_servers/using-automated-backups-on-a-vps/images/backup_vps.png b/pages/bare_metal_cloud/virtual_private_servers/using-automated-backups-on-a-vps/images/backup_vps.png deleted file mode 100644 index 31cd81a3033..00000000000 Binary files a/pages/bare_metal_cloud/virtual_private_servers/using-automated-backups-on-a-vps/images/backup_vps.png and /dev/null differ diff --git a/pages/bare_metal_cloud/virtual_private_servers/using-automated-backups-on-a-vps/images/backup_vps2025.png b/pages/bare_metal_cloud/virtual_private_servers/using-automated-backups-on-a-vps/images/backup_vps2025.png new file mode 100644 index 00000000000..0985c06e783 Binary files /dev/null and b/pages/bare_metal_cloud/virtual_private_servers/using-automated-backups-on-a-vps/images/backup_vps2025.png differ diff --git a/pages/bare_metal_cloud/virtual_private_servers/using-automated-backups-on-a-vps/images/backup_vps_leg.png b/pages/bare_metal_cloud/virtual_private_servers/using-automated-backups-on-a-vps/images/backup_vps_leg.png new file mode 100644 index 00000000000..35002c742d7 Binary files /dev/null and b/pages/bare_metal_cloud/virtual_private_servers/using-automated-backups-on-a-vps/images/backup_vps_leg.png differ diff --git a/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps/guide.de-de.md b/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps/guide.de-de.md index 6818e633b25..14fa4552622 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps/guide.de-de.md +++ b/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps/guide.de-de.md @@ -1,7 +1,7 @@ --- title: "Snapshots auf einem VPS verwenden" excerpt: "Erfahren Sie hier, wie Sie im OVHcloud Kundencenter die Snapshot-Option aktivieren und verwenden" -updated: 2025-09-11 +updated: 2025-10-17 --- ## Ziel @@ -30,7 +30,7 @@ Loggen Sie sich in Ihr [OVHcloud Kundencenter](/links/manager) ein, gehen Sie in ### Schritt 1: Snapshot-Option aktivieren -Scrollen Sie im Tab `Start`{.action} nach unten zum Feld mit der Bezeichnung **Zusammenfassung der Optionen**. +Scrollen Sie im Tab `Start`{.action} nach unten zum Feld mit der Bezeichnung **Backup**. Wenn sich die Option bereits im Status "Aktiviert" befindet, fahren Sie direkt mit Schritt 2 fort. Wenn "Snapshot" noch nicht aktiviert ist, klicken Sie auf `...`{.action} neben "Snapshot". Im Kontextmenü klicken Sie auf `Bestellen`{.action}. ![snapshotvps](images/snapshot_vps_step1b.png){.thumbnail} @@ -43,7 +43,7 @@ Um die Dienstoption zu kündigen, klicken Sie auf `...`{.action} neben "Snapshot ### Schritt 2: Einen Snapshot erstellen -Sobald die Option aktiviert ist, klicken Sie auf `...`{.action} neben der Option "Snapshot". Im Kontextmenü klicken Sie auf `Snapshot erstellen`{.action}. Sie können eine Beschreibung eingeben, die an Ihren Snapshot angehängt wird. Die Dauer der Erstellung des Snapshots hängt vom verwendeten Speicherplatz ab. Anschließend wird der Zeitstempel der Erstellung im Bereich **Zusammenfassung der Optionen** angezeigt. +Sobald die Option aktiviert ist, klicken Sie auf `...`{.action} neben der Option "Snapshot". Im Kontextmenü klicken Sie auf `Snapshot erstellen`{.action}. Sie können eine Beschreibung eingeben, die an Ihren Snapshot angehängt wird. Die Dauer der Erstellung des Snapshots hängt vom verwendeten Speicherplatz ab. Anschließend wird der Zeitstempel der Erstellung im Bereich **Backup** angezeigt. ### Schritt 3: Einen Snapshot löschen/wiederherstellen @@ -105,7 +105,7 @@ temp_url_sig=f508cacda60256d5f211dddf3f81130e935f0e4&temp_url_expres=1678247579" > Wir empfehlen, Snapshots nicht direkt auf den VPS herunterzuladen, um die Auslastung des Speicherplatzes zu vermeiden. > -> Die heruntergeladene Datei kann über [OpenStack](products/public-cloud-compute-instance-management) als Image (QCOW2) in ein Public Cloud Projekt importiert werden. (Nutzungsbeispiele finden Sie z.B. in [dieser Anleitung](/pages/public_cloud/compute/upload_own_image).) +> Die heruntergeladene Datei kann über [OpenStack](/products/public-cloud-compute-instance-management) als Image (QCOW2) in ein Public Cloud Projekt importiert werden. (Nutzungsbeispiele finden Sie z.B. in [dieser Anleitung](/pages/public_cloud/compute/upload_own_image).) > ### Optimale Vorgehensweise zur Snapshot-Erstellung diff --git a/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps/guide.en-gb.md b/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps/guide.en-gb.md index 32abe26852b..609d3ce2089 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps/guide.en-gb.md +++ b/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps/guide.en-gb.md @@ -1,7 +1,7 @@ --- title: "How to use snapshots on a VPS" excerpt: "Find out how to enable and use the Snapshot option in the OVHcloud Control Panel" -updated: 2025-09-11 +updated: 2025-10-17 --- ## Objective @@ -30,7 +30,7 @@ Log in to your [OVHcloud Control Panel](/links/manager), open the `Bare Metal Cl ### Step 1: Subscribing to the snapshot option -From the `Home`{.action} tab, scroll down to the box labelled **Summary of options**. +From the `Home`{.action} tab, scroll down to the box labelled **Backup**. If "Snapshot" is already set to "Enabled", go directly to step 2. If "Snapshot" is not yet enabled, click on `...`{.action} next to the option "Snapshot" and in the context menu click on `Order`{.action}. ![snapshotvps](images/snapshot_vps_step1b.png){.thumbnail} @@ -43,7 +43,7 @@ To cancel the service option, click on the button `...`{.action} next to the opt ### Step 2: Taking a snapshot -Once the option is enabled, click on `...`{.action} next to the option "Snapshot" and in the context menu click `Take a snapshot`{.action}. You can write a description that will be attached to your snapshot. The time it takes to create the snapshot depends on the storage space in use. Afterwards, refresh your page to see the timestamp of the creation in the **Summary of options** box. +Once the option is enabled, click on `...`{.action} next to the option "Snapshot" and in the context menu click `Take a snapshot`{.action}. You can write a description that will be attached to your snapshot. The time it takes to create the snapshot depends on the storage space in use. Afterwards, refresh your page to see the timestamp of the creation in the **Backup** box. ### Step 3: Deleting or restoring a snapshot @@ -104,7 +104,7 @@ temp_url_sig=f508cacda60256d5f211ddddf3f81130e935f0e4&temp_url_expires=167824757 > > We recommend not to download snapshots directly to the VPS, to avoid using up the storage space. > -> The downloaded file can be imported into your Public Cloud Project as an image (QCOW2) via [OpenStack](products/public-cloud-compute-instance-management). (Find an example of use in [this guide](/pages/public_cloud/compute/upload_own_image).) +> The downloaded file can be imported into your Public Cloud Project as an image (QCOW2) via [OpenStack](/products/public-cloud-compute-instance-management). (Find an example of use in [this guide](/pages/public_cloud/compute/upload_own_image).) > ### Best practice for using snapshots diff --git a/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps/guide.es-es.md b/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps/guide.es-es.md index adf8569f40a..8aea2828c79 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps/guide.es-es.md +++ b/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps/guide.es-es.md @@ -1,7 +1,7 @@ --- title: "Uso de instantáneas Snapshots en un servidor virtual privado (VPS)" excerpt: "Cómo activar y usar la opción Instantáneas en el panel de control de OVHcloud" -updated: 2025-09-11 +updated: 2025-10-17 --- ## Objetivo @@ -30,7 +30,7 @@ Conéctese al [Panel de configuración de OVHcloud](/links/manager), acceda a la ### Paso 1: Suscribirse a la opción "Snapshot" -Acceda a la pestaña `Inicio`{.action} y desplácese hacia abajo hasta el cuadro **Resumen de opciones** +Acceda a la pestaña `Inicio`{.action} y desplácese hacia abajo hasta el cuadro **Copia de seguridad** . Si el estado de "Snapshot" ya es "Activado", vaya directamente al paso 2. Si "Snapshot" todavía no está activado, haga clic en `...`{.action} junto a la opción "Snapshot" y, seguidamente, en `Contratar`{.action} (en el menú contextual). ![snapshotvps](images/snapshot_vps_step1b.png){.thumbnail} @@ -43,7 +43,7 @@ Para dar de baja la opción de servicio, haga clic en el botón `...`{.action} s ### Paso 2: Tomar una instantánea -Una vez activada la opción, haga clic en `...`{.action} junto a la opción «Instantáneas» y, seguidamente, en «Tomar una instantánea» (en el menú contextual). Puede escribir una descripción que se asociará al snapshot. El tiempo de creación del snapshot depende del espacio de almacenamiento utilizado. Después, aparecerá la fecha y hora de su creación en el cuadro «Resumen de opciones». +Una vez activada la opción, haga clic en `...`{.action} junto a la opción «Instantáneas» y, seguidamente, en «Tomar una instantánea» (en el menú contextual). Puede escribir una descripción que se asociará al snapshot. El tiempo de creación del snapshot depende del espacio de almacenamiento utilizado. Después, aparecerá la fecha y hora de su creación en el cuadro «Copia de seguridad». ### Paso 3: Eliminar o restaurar una instantánea @@ -103,7 +103,7 @@ temp_url_sig=f508cacda60256d5f211ddddf3f81130e935f0e4&temp_url_expires=167824757 > > No obstante, para no consumir demasiado espacio de almacenamiento, le recomendamos que no descargue los snapshots directamente en el VPS. > -> El archivo cargado puede importarse en un proyecto de Public Cloud como imagen (QCOW2) mediante [OpenStack](products/public-cloud-compute-instance-management). (Consulte un ejemplo de uso en [esta guía](/pages/public_cloud/compute/upload_own_image).) +> El archivo cargado puede importarse en un proyecto de Public Cloud como imagen (QCOW2) mediante [OpenStack](/products/public-cloud-compute-instance-management). (Consulte un ejemplo de uso en [esta guía](/pages/public_cloud/compute/upload_own_image).) > ### Buenas prácticas para la creación de un snapshot diff --git a/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps/guide.fr-fr.md b/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps/guide.fr-fr.md index a04bab7dd5f..7bbbc6bbc05 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps/guide.fr-fr.md +++ b/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps/guide.fr-fr.md @@ -1,7 +1,7 @@ --- title: "Utiliser le snapshot" excerpt: "Découvrez comment activer et utiliser l’option snapshot depuis l’espace client OVHcloud" -updated: 2025-09-11 +updated: 2025-10-17 --- ## Objectif @@ -32,7 +32,7 @@ Connectez-vous à votre [espace client OVHcloud](/links/manager), rendez-vous da ### Étape 1 : souscrire l'option snapshot -Depuis l'onglet `Accueil`{.action}, descendez jusqu'au menu « Résumé des options ». +Depuis l'onglet `Accueil`{.action}, descendez jusqu'au cadre « Sauvegarde ». Si « Snapshot » est déjà sur l'état « Activé », passez directement à l'étape 2. Si « Snapshot » n'est pas encore activé, cliquez sur `...`{.action} à droite de l'option « Snapshot » puis cliquez sur `Commander`{.action} dans le menu qui s'affiche. ![snapshotvps](images/snapshot_vps_step1b.png){.thumbnail} @@ -45,7 +45,7 @@ Pour résilier l'option, cliquez sur le bouton `...`{.action} à côté de « Sn ### Étape 2 : prendre un snapshot -Une fois l'option activée, cliquez sur `...`{.action} à droite de l'option « Snapshot » puis cliquez sur `Prendre un Snapshot`{.action} dans le menu qui apparaît. Vous pouvez tapez une description qui sera attachée à votre snapshot. La durée de création du snapshot dépend de l'espace de stockage utilisé. Par la suite, l'horodatage de la création s'affiche dans le menu « Résumé des options ». +Une fois l'option activée, cliquez sur `...`{.action} à droite de l'option « Snapshot » puis cliquez sur `Prendre un Snapshot`{.action} dans le menu qui apparaît. Vous pouvez renseigner une description qui sera attachée à votre snapshot. La durée de création du snapshot dépend de l'espace de stockage utilisé. Par la suite, l'horodatage de la création s'affichera le cadre « Sauvegarde ». ### Étape 3 : supprimer/restaurer un snapshot @@ -105,7 +105,7 @@ temp_url_sig=f508cacda60256d5f211ddddf3f81130e935f0e4&temp_url_expires=167824757 > > Pour éviter de consommer trop d'espace de stockage, nous vous déconseillons de télécharger les snapshots directement sur le VPS. > -> Le fichier téléchargé peut être importé dans un Projet Public Cloud en tant qu'image (QCOW2) via [OpenStack](products/public-cloud-compute-instance-management). (Retrouvez un exemple d'utilisation dans [ce guide](/pages/public_cloud/compute/upload_own_image).) +> Le fichier téléchargé peut être importé dans un Projet Public Cloud en tant qu'image (QCOW2) via [OpenStack](/products/public-cloud-compute-instance-management). (Retrouvez un exemple d'utilisation dans [ce guide](/pages/public_cloud/compute/upload_own_image).) > ### Bonnes pratiques pour la création d'un snapshot diff --git a/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps/guide.it-it.md b/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps/guide.it-it.md index 15e29ee4c2a..aa30cabeb85 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps/guide.it-it.md +++ b/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps/guide.it-it.md @@ -1,7 +1,7 @@ --- title: "Usare snapshot su un VPS" excerpt: "Scopri come abilitare e utilizzare l’opzione Snapshot nello Spazio Cliente OVHcloud" -updated: 2025-09-11 +updated: 2025-10-17 --- ## Obiettivo @@ -30,7 +30,7 @@ Accedi allo [Spazio Cliente OVHcloud](/links/manager), clicca su `Bare Metal Clo ### Step 1: Attivare l’opzione snapshot -Partendo dalla scheda `Home`{.action}, scorri verso il basso fino al riquadro **Riassunto opzioni**. +Partendo dalla scheda `Home`{.action}, scorri verso il basso fino al riquadro **Backup**. Se "Snapshot" è già in stato "Attivato", passa direttamente allo Step 2. Se "Snapshot" non è ancora attivo, clicca su `...`{.action} accanto all’opzione "Snapshot" e nel menu di scelta rapida clicca su `Ordina`{.action}. ![snapshotvps](images/snapshot_vps_step1b.png){.thumbnail} @@ -43,7 +43,7 @@ Per disattivare l’opzione di servizio, clicca sul pulsante `...`{.action} acca ### Step 2: Acquisire uno snapshot -Una volta attivata l’opzione, clicca su `...`{.action} accanto all’opzione "Snapshot" e nel menu a scelta rapida clicca su `Scatta uno snapshot`{.action}. È possibile digitare una descrizione che verrà allegata allo Snapshot. La durata della creazione dello Snapshot dipende dallo spazio di storage utilizzato. In seguito, nel riquadro “Sintesi opzioni” appariranno la data e l’ora dello scatto. +Una volta attivata l’opzione, clicca su `...`{.action} accanto all’opzione "Snapshot" e nel menu a scelta rapida clicca su `Scatta uno snapshot`{.action}. È possibile digitare una descrizione che verrà allegata allo Snapshot. La durata della creazione dello Snapshot dipende dallo spazio di storage utilizzato. In seguito, nel riquadro “Backup” appariranno la data e l’ora dello scatto. ### Step 3: Cancellare/ripristinare uno snapshot @@ -103,7 +103,7 @@ temp_url_sig=f508cacda60256d5f211ddddf3f81130e935f0e4&temp_url_expires=167824757 > > Per evitare di consumare troppo spazio di storage, ti consigliamo di scaricare gli Snapshot direttamente sul VPS. > -> Il file scaricato può essere importato in un Progetto Public Cloud come immagine (QCOW2) tramite [OpenStack](products/public-cloud-compute-instance-management). (Un esempio di utilizzo è disponibile in [questa guida](/pages/public_cloud/compute/upload_own_image).) +> Il file scaricato può essere importato in un Progetto Public Cloud come immagine (QCOW2) tramite [OpenStack](/products/public-cloud-compute-instance-management). (Un esempio di utilizzo è disponibile in [questa guida](/pages/public_cloud/compute/upload_own_image).) > ### Best practice per la creazione di uno Snapshot diff --git a/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps/guide.pl-pl.md b/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps/guide.pl-pl.md index 6dceed4f717..2e8885ccb29 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps/guide.pl-pl.md +++ b/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps/guide.pl-pl.md @@ -1,7 +1,7 @@ --- title: "Korzystanie z migawek na prywatnym serwerze wirtualnym" excerpt: "Dowiedz się, jak włączyć opcję migawki w Panelu klienta OVHcloud i korzystać z niej" -updated: 2025-09-11 +updated: 2025-10-17 --- ## Wprowadzenie @@ -30,7 +30,7 @@ Zaloguj się do [Panelu client OVHcloud](/links/manager), przejdź do sekcji `Ba ### Krok 1: subskrybowanie opcji kopii zapasowej -Na karcie `Strona główna`{.action} przewiń do obszaru z nagłówkiem **Podsumowanie opcji**. +Na karcie `Strona główna`{.action} przewiń do obszaru z nagłówkiem **Kopia zapasowa**. Jeśli opcja "Snapshot" jest już w stanie "Włączona", przejdź od razu do etapu 2. Jeśli "Snapshot" nie jest jeszcze aktywny, kliknij na `...`{.action} obok opcji "Snapshot" i wybierz z menu kontekstowego pozycję `Zamówienie`{.action}. ![snapshotvps](images/snapshot_vps_step1b.png){.thumbnail} @@ -43,7 +43,7 @@ Aby zrezygnować z opcji usługi, kliknij przycisk `...`{.action} obok "Snapshot ### Krok 2: tworzenie migawki -Po włączeniu opcji kliknij ikonę `...`{.action} obok opcji “Migawka” i wybierz z menu kontekstowego pozycję `Utwórz migawkę`{.action}. Możesz wpisać opis, który będzie dołączony do kopii zapasowej snapshot. Czas tworzenia snapshota zależy od użytej przestrzeni dyskowej. Po utworzeniu migawki w obszarze “Podsumowanie opcji” pojawi się jej znacznik czasu. +Po włączeniu opcji kliknij ikonę `...`{.action} obok opcji “Migawka” i wybierz z menu kontekstowego pozycję `Utwórz migawkę`{.action}. Możesz wpisać opis, który będzie dołączony do kopii zapasowej snapshot. Czas tworzenia snapshota zależy od użytej przestrzeni dyskowej. Po utworzeniu migawki w obszarze “Kopia zapasowa” pojawi się jej znacznik czasu. ### Krok 3: usuwanie / przywracanie migawki @@ -103,7 +103,7 @@ temp_url_sig=f508cacda60256d5f211ddddf3f81130e935f0e4&temp_url_expires=167824757 > > Aby uniknąć utraty zbyt dużej ilości przestrzeni dyskowej, zalecamy usunięcie kopii zapasowych snapshot bezpośrednio z serwera VPS. > -> Pobrany plik można zaimportować do projektu Public Cloud (QCOW2) jako obraz za pośrednictwem [OpenStack](products/public-cloud-compute-instance-management). (Przykład zastosowania znajduje się w [tym przewodniku](/pages/public_cloud/compute/upload_own_image).) +> Pobrany plik można zaimportować do projektu Public Cloud (QCOW2) jako obraz za pośrednictwem [OpenStack](/products/public-cloud-compute-instance-management). (Przykład zastosowania znajduje się w [tym przewodniku](/pages/public_cloud/compute/upload_own_image).) > ### Dobre praktyki dotyczące tworzenia migawek diff --git a/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps/guide.pt-pt.md b/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps/guide.pt-pt.md index 65ae931c97f..ba44e6502ff 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps/guide.pt-pt.md +++ b/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps/guide.pt-pt.md @@ -1,7 +1,7 @@ --- title: "Utilizar snapshots num alojamento VPS" excerpt: "Saiba como ativar e utilizar a opção Snapshot na Área de Cliente OVHcloud" -updated: 2025-09-11 +updated: 2025-10-17 --- ## Sumário @@ -30,7 +30,7 @@ Ligue-se à sua [Área de Cliente OVHcloud](/links/manager), vá à secção `Ba ### Passo 1: Subscrever a opção snapshot -No separador `Inicial`{.action}, procure a caixa **Sumário de opções**. +No separador `Inicial`{.action}, procure a caixa **Backup**. Se "Snapshot" já estiver no estado "Ativada", passe diretamente para a etapa 2. Se "Snapshot" ainda não estiver ativado, clique em `...`{.action} ao lado da opção "Snapshot" e no respetivo menu clique em `Encomendar`{.action}. ![snapshotvps](images/snapshot_vps_step1b.png){.thumbnail} @@ -43,7 +43,7 @@ Para rescindir a opção de serviço, clique no botão `...`{.action} ao lado de ### Passo 2: Obter um snapshot -Uma vez ativada esta opção, clique em `...`{.action} junto à opção "Snapshot" e no respetivo menu clique em `Obter snapshot`{.action}. Pode introduzir uma descrição que será associada à sua snapshot. A duração da criação da snapshot depende do espaço de armazenamento utilizado. No final, o tempo de duração será indicado na caixa “Sumário de opções”. +Uma vez ativada esta opção, clique em `...`{.action} junto à opção "Snapshot" e no respetivo menu clique em `Obter snapshot`{.action}. Pode introduzir uma descrição que será associada à sua snapshot. A duração da criação da snapshot depende do espaço de armazenamento utilizado. No final, o tempo de duração será indicado na caixa “Backup”. ### Passo 3: Apagar/restaurar um snapshot @@ -103,7 +103,7 @@ temp_url_sig=f508cacda60256d5f211ddddf3f81130e935f0e4&temp_url_expires=167824757 > > Para evitar o consumo de espaço de armazenamento excessivo, desaconselhamos o download das snapshots diretamente para o VPS. > -> O ficheiro descarregado pode ser importado para um Projeto Public Cloud enquanto imagem (QCOW2) via [OpenStack](products/public-cloud-compute-instance-management). (Consulte um exemplo de utilização em [este manual](/pages/public_cloud/compute/upload_own_image).) +> O ficheiro descarregado pode ser importado para um Projeto Public Cloud enquanto imagem (QCOW2) via [OpenStack](/products/public-cloud-compute-instance-management). (Consulte um exemplo de utilização em [este manual](/pages/public_cloud/compute/upload_own_image).) > ### Boas práticas para a criação de uma snapshot diff --git a/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps/images/snapshot_vps03.png b/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps/images/snapshot_vps03.png index 5c8f42e518d..0c28e8bf6ed 100644 Binary files a/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps/images/snapshot_vps03.png and b/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps/images/snapshot_vps03.png differ diff --git a/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps/images/snapshot_vps_step1b.png b/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps/images/snapshot_vps_step1b.png index bb1573909ec..102a772cfce 100644 Binary files a/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps/images/snapshot_vps_step1b.png and b/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps/images/snapshot_vps_step1b.png differ diff --git a/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps/images/snapshot_vps_step2.png b/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps/images/snapshot_vps_step2.png index 9a43b059d93..0a4e4a62936 100644 Binary files a/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps/images/snapshot_vps_step2.png and b/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps/images/snapshot_vps_step2.png differ diff --git a/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.de-de.md b/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.de-de.md index ecfd9428e97..619ea2743bc 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.de-de.md +++ b/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.de-de.md @@ -1,100 +1,401 @@ --- -title: FAQ VPS OVHcloud -updated: 2025-08-07 +title: "OVHcloud VPS FAQ" +excerpt: "Finden Sie Antworten auf die am häufigsten gestellten Fragen zu unseren VPS-Angeboten" +updated: 2025-10-30 --- -## VPS FAQ + -### Was ist ein VPS und wozu dient er? -Auf einem virtuellen Server können Webseiten (Präsentationsseiten, E-Commerce, Inhalte, Medien) gehostet werden, sowie auch Software-Anwendungen (Portale, Lösungen für Extranet und zur Gemeinschaftsarbeit, Wikis, CRM). Anders als beim Shared Hosting sind die Daten auf einer virtuellen und dem Nutzer vorbehaltenen Maschine isoliert. +## Allgemeine Fragen zu VPS-Angeboten -Unserer Server verbinden ideal die Vorzüge von Webhosting und einem physischen Server. Sie kombinieren die Verlässlichkeit und Leistungsfähigkeit eines dedizierten Servers ohne dessen physische Einschränkungen. +/// details | Was ist ein VPS und wofür wird er verwendet? -### VPS oder Webhosting? +Ein Virtual Private Server (VPS) wird zur Bereitstellung von Webseiten (E-Commerce, Inhalte, visuelle Medien) und Softwareanwendungen (Portale, Extranets, kooperative Lösungen, Wikis, CRM) verwendet. Im Gegensatz zu Shared Hosting bietet ein VPS eine isolierte Umgebung, die dem Kunden zugeordnet ist. Unsere VPS-Lösungen schließen die Lücke zwischen Webhosting und dedizierten Servern, indem sie Leistung und Zuverlässigkeit ohne die Notwendigkeit der Hardwareverwaltung kombinieren. Sie können Ihre Konfiguration außerdem leicht aufrüsten, ohne Server zu wechseln. -Die Verwendung eines VPS ist die logische Fortführung einer Webhosting-Nutzung. Die virtuellen privaten Server bieten mehr Möglichkeiten und eine größere Freiheit bei Einstellung, Zugang und Funktionen (Root-Zugang, freie Wahl der Software von Drittanbietern wie Apache Webserver oder PHP). Sie können außerdem ein SSL-Zertifikat oder jedes andere Programm Ihrer Wahl installieren. +/// -Ein VPS muss mit Sorgfalt gewählt werden. Die Konfiguration muss den Anforderungen der Anwendungen entsprechen, und der VPS muss sich dem Wachstum Ihrer Nutzung anpassen können. +/// details | Welche Vorteile bietet ein OVHcloud VPS? -### Was sind die Vorteile eines VPS im Vergleich zu einem Dedicated Server? +OVHcloud VPS-Angebote bieten hervorragenden Leistungspreis, mit unbegrenztem Datenverkehr und mehreren globalen Standorten für geringe Latenz und verbesserte Zugänglichkeit, abhängig von Ihren Anforderungen. -Die VPS bieten den Vorteil, dass Sie sich nicht mehr um die Verwaltung der Hardware kümmern müssen: Überwachung des Zustands der Festplatten, des Arbeitsspeichers (RAM), der CPU. Sie sind für die meisten Arten von Internetnutzung ausgelegt, sowie für Projekte von bestimmter Größe. -Wann ist ein Dedicated Server ratsam? Wenn Sie die Hardware verwalten und komplexere Infrastrukturen aufbauen möchten. Diese können z.B. ein privates Netzwerk (vRack) beinhalten. Oder aber wenn Sie außer Webservices komplexe Lösungen einsetzen möchten. +/// -Bei stark ansteigenden Nutzerzahlen empfehlen sich entweder Dedicated Server oder Public Cloud Lösungen. Diese Dienstleistungen bieten umfassendere und flexiblere Infrastrukturen an, die ein starkes Wachstum begleiten können. +/// details | Ist eine VPS-Lösung die richtige Wahl für mich? -### Was sind die Unterschiede zwischen den Lösungen für VPS und für Public Cloud? +Die Nutzung eines VPS erfordert grundlegende Kenntnisse der Server-Administration. Dies zu berücksichtigen ist entscheidend, um Ihr Betriebssystem (Linux oder Windows) effektiv zu verwalten und Ihre Anwendungen einzurichten, z. B. PrestaShop oder WordPress. -Der VPS ist ein Dienst, der auf Umgebungen der Produktion und deren Vorstufen ausgerichtet ist, die keine konstanten Leistungen benötigen. -Die OVHcloud Public Cloud bietet eine Multi-Server-Infrastruktur mit hoher Verfügbarkeit der Maschinen. Mit dieser Lösung ist ebenfalls ein privates Netzwerk, das vRack, verfügbar. +Wenn Sie einen VPS benötigen, aber nicht über die technischen Kenntnisse verfügen, um ihn zu verwalten, wenden Sie sich an einen unserer [Partner](/links/partner) für Unterstützung. -### Wie finde ich den richtigen OVHcloud VPS? +Wenn Sie Ressourcen benötigen, aber nicht mit der Server-Administration umgehen möchten, empfehlen wir Ihnen, unsere Performance-Webhosting-Pläne in Betracht zu ziehen. -Um einen VPS zu wählen, der Ihren Anforderungen entspricht, prüfen Sie zunächst folgende Aspekte: +/// -- Die erforderliche Ressourcenmenge (Prozessor, RAM, Speicherplatz, Bandbreite) -- Das erforderliche Betriebssystem (Linux oder Windows) -- Die technischen Voraussetzungen, die für das reibungslose Funktionieren der Anwendung von wesentlicher Bedeutung sind (z.B. Lese-/Schreibgeschwindigkeit für Datenbanken) +/// details | Kann ich meinen VPS einfach in eine höhere Leistungsklasse aufrüsten oder in eine geringere Konfiguration herunterskalieren? -So können Sie die richtige Wahl zwischen unseren VPS Lösungen treffen: +Ja, Sie können Ihre Konfiguration über das OVHcloud Kundencenter aufrüsten, ohne Ihre Daten zu migrieren. Die verfügbaren Ugrade-Optionen hängen von der Reihe und dem Modell des VPS ab. -- **VPS Starter**: Für Einsteiger, zum Testen unseres Angebots (nur mit Linux-Distribution). -- **VPS Value, Essential und Comfort**: Ideale Lösungen für das Hosting von Webseiten, E-Commerce-Dienstleistungen oder Monitoringsystemen. -- **VPS Elite**: Für E-Commerce-Seiten und Anwendungen mit hohem CPU- und RAM-Ressourcenbedarf geeignet. -- **VPS Limited Edition** (in begrenzter Stückzahl): Diese VPS bieten eine höhere Performance. Sie bieten einen deutlichen Vorteil beim Hosting komplexer Websites, ressourcenintensiver Anwendungen oder sogar von Gameservern. Dieses Angebot ist limitiert und gilt nur, bis der Vorrat aufgebraucht ist. +Um Ihre Konfiguration herunterstufen zu können, müssen Sie jedoch einen neuen Dienst abonnieren, Ihre Daten übertragen und anschließend Ihren alten Dienst stornieren. Unser Support-Team steht Ihnen bei Bedarf zur Verfügung. -> [!primary] -> Sie können einen VPS Limited Edition auf einen anderen VPS derselben Reihe upgraden. Aus technischen Gründen ist es jedoch nicht möglich, einen VPS Limited Edition auf einen VPS einer anderen Reihe (Starter, Value, Essential oder Comfort) upgraden zu lassen. +/// -### Wer kann einen VPS nutzen? +/// details | Welche Region oder welches Land sollte ich für meinen VPS wählen? -Die Verwaltung eines VPS setzt Grundkenntnisse der Serveradministration voraus. Diese Kenntnisse sind für die Verwaltung des auf der Maschine installierten Betriebssystems (Linux oder Windows) und die Verwaltung der Anwendungen unerlässlich. Sie brauchen einen VPS, aber haben möglicherweise nicht die notwendigen Kenntnisse? Kontaktieren Sie einen unserer [Partner](/links/partner). +Ihr Rechenzentrum näher an Ihren Nutzern zu verorten führt zu geringerer Latenz und damit besserer Benutzererfahrung und einem erhöhten Vertrauen in Ihre Dienste. -Wenn Sie garantierte Ressourcen ohne Kenntnisse in der Serveradministration nutzen möchten, empfehlen wir Ihnen unser [Performance Webhosting](/links/web/hosting-performance-offer). +/// -### Wie kann ich mich mit meinem VPS verbinden? +/// details | Welchen Vorteil bietet ein in Europa gelegener VPS? -Sie können sich mit den nach der Servicebereitstellung per E-Mail bereitgestellten Anmeldeinformationen mittels Remote-Verbindung bei Ihrem VPS anmelden. -Die Verbindungsmethode hängt von den verwendeten Betriebssystemen ab. +Die Einrichtung Ihres VPS bei OVHcloud in Frankreich oder allgemein innerhalb der EU bietet Vorteile wie wettbewerbsfähige Preise und verstärkten Datenschutz. Ihr Service unterliegt nicht dem US CLOUD Act und ist somit vor nicht-europäischer Einflussnahme geschützt. -Alle Details finden hierzu Sie in [unserer Anleitung zu den ersten Schritten mit einem VPS](/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps)". +/// -### Kann ich mehrere Websites auf einem VPS hosten? +/// details | Sind Backups mit meinem VPS inkludiert? -Ja. Ein VPS kann partitioniert und Ihren Anforderungen entsprechend strukturiert werden. So können Sie mehrere Webseiten oder Projekte hosten: Weisen Sie jeweils einen gesonderten und größendefinierten Speicherplatz zu. Vereinfachen Sie diese Prozesse, indem Sie eine Verwaltungssoftware für die Webseiten installieren, z.B. Plesk oder cPanel. +Ja, bei der Bestellung eines VPS ist eine tägliche Backup-Option kostenlos enthalten. -### Ist mein VPS gesichert? +Für eine noch bessere Sicherheit können Sie auch unsere Backup-Option Premium aktivieren. Diese bietet: -Es ist ratsam, eine angemessene Backup-Strategie entsprechend der Sensibilität Ihrer Daten anzuwenden. -Genauere Informationen zu den verfügbaren Optionen finden Sie auf unserer [VPS Webseite](/links/bare-metal/vps-options). +- Die Möglichkeit, auf ein Backup zurückzugreifen, das bis zu eine Woche alt ist. +- Die Möglichkeit, Backups zu planen, um die Datenerfassung zu optimieren und den Einfluss auf Geschäftsprozesse zu minimieren. -### Wie kann ich meinen VPS schützen? +Zusätzlich bieten wir: -Ein VPS wird im "Rohzustand" ausgeliefert, in dem keine Sicherheitskonfiguration vorhanden ist. Die Absicherung des VPS sollte daher Priorität haben. -Lesen Sie hierzu die Anleitung "[VPS absichern](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps)". +- Snapshots: Sie können manuelle, schnelle Snapshots erstellen, die den genauen Zustand Ihres VPS vor einem Update oder einer kritischen Änderung erfassen. +- Externes Backup: Speichern Sie Ihre Daten auf einem separaten, sicheren Datenträger, um bei einem größeren Ausfall eine einfache Wiederherstellung zu ermöglichen. -### Welche Bandbreite ist meinem VPS zugewiesen? Ist sie garantiert? +Durch die Nutzung dieser Lösungen können Sie Ihre Backup-Verwaltung an Ihre Sicherheits- und Kontinuitätsanforderungen anpassen. -Die auf den Angebotswebseiten angezeigte Bandbreite ist garantiert. Es handelt sich um die garantierte Mindestbandbreite, die Ihnen zugewiesen wird. +Besuchen Sie unsere [VPS-Webseite](/links/bare-metal/vps), um mehr über die verfügbaren Optionen zu erfahren. -### Welches SLA wird auf meinen VPS angewendet? +/// -Für alle VPS Reihen bietet OVHcloud ein SLA von 99,9%. +/// details | Kann ich mehrere Webseiten auf einem VPS hosten? -### Wie kann ich von einer IP-Adresse außerhalb meines Dienstes auf meinen Backup Storage zugreifen? +Ja, ein VPS kann so konfiguriert werden, dass mehrere Webseiten oder Projekte darauf gehostet werden. Sie können Ihren Speicherplatz entsprechend Ihren Anforderungen aufteilen und spezialisierte Oberflächen wie Plesk oder cPanel nutzen, um die Verwaltung Ihrer Webseiten zu vereinfachen. - +/// -Der Zugriff auf den Backup-Speicher Ihres VPS (FTP-Speicher) kann auf IP-Adressen beschränkt sein, die mit Diensten in Ihrem OVHcloud Kunden-Account verbunden sind. -Um weitere IP-Adressen hinzuzufügen, von denen aus zugegriffen werden kann, können Sie die OVHcloud API verwenden. -Auf diese Weise können Sie Ihre Backup-Daten von einem anderen Dienst über verschiedene Protokolle (FTP, NFS, CIFS) abrufen. +/// details | Erhalte ich mit meinem VPS einen Domainnamen und E-Mail-Dienst? + +Nein, unsere VPS-Lösungen enthalten keinen Domainnamen oder E-Mail-Dienst. Diese Dienste können separat im OVHcloud Kundencenter bestellt werden. + +/// + +/// details | Wie wähle ich zwischen einem VPS und einem Hosting-Paket? + +**Hosting-Paket** + +- Ideal für grundlegende Hosting-Anforderungen mit einer vorab konfigurierten Einrichtung. + +**VPS** + +- Mehr Flexibilität und Kontrolle, perfekt für skalierbare Projekte mit komplexen Konfigurationsanforderungen. + +Die Einrichtung von Webdiensten auf einem VPS ermöglicht es Ihnen, Ihre bevorzugte Software zu installieren, Servereinstellungen zu anpassen und mehrere Webseiten mit dedizierten Ressourcen zu hosten. Beachten Sie, dass ein VPS so konfiguriert werden muss, dass er Ihren Anforderungen entspricht und sich an Ihr Wachstum anpasst. + +/// + +/// details | Was ist der Unterschied zwischen einem VPS und Public Cloud Lösungen? + +**VPS** + +- Eine optimierte und dedizierte virtuelle Maschine, geeignet sowohl für Präproduktion als auch für Produktion, die mehrere Webprojekte hosten kann. + +**OVHcloud Public Cloud** + +- Bietet eine Multi-Server-Infrastruktur mit hoher Verfügbarkeit und einem privaten Netzwerk (vRack) und ist für komplexe, skalierbare Architekturen konzipiert. + +/// + +/// details | Welche Vorteile bietet ein VPS im Vergleich zu einem dedizierten Server? + +**VPS** + +- Bietet vereinfachte Administration ohne Hardware-Verwaltung, ideal für Projekte, die strikte Kontrolle benötigen. + +**Dedicated Server** + +- Wird für komplexe Infrastrukturen empfohlen, die eine vollständige Hardware-Kontrolle und garantierte Leistung erfordern. + +Ein VPS beseitigt die Notwendigkeit, physische Hardware wie Speicher, RAM und CPU zu verwalten, wodurch er sich gut für die meisten Webanwendungen eignet. Wenn Ihr Unternehmen wächst, können Sie Ihren VPS upgraden oder auf einen dedizierten Server oder eine Public Cloud Lösung migrieren, um eine flexiblere und leistungsfähigere Infrastruktur zu erhalten. + +/// + +/// details | Welche Bandbreite ist meinem VPS zugeordnet? Ist sie garantiert? + +Die Bandbreite, die auf unserer [VPS-Webseite](/links/bare-metal/vps) aufgelistet ist, ist garantiert. Es handelt sich um den minimalen Wert, der Ihrem Dienst zugeordnet wird. + +/// + +/// details | Welche SLA gilt für meinen VPS? + +Ein OVHcloud VPS beinhaltet eine SLA von 99,9 %. + +/// + + +/// details | Welche einzigartigen Merkmale hat ein Local Zone VPS? + +Mit einem Local Zone VPS können Sie die Zugriffszeiten auf Ihre Webseiten und Anwendungen erheblich reduzieren, da Ihre Daten näher an Ihren Benutzern gehostet werden. Dies verbessert die Benutzererfahrung, indem die Latenz reduziert wird, sobald Anwendungen eine minimierte Antwortzeit erfordern. Wählen Sie einfach einen unserer weltweiten Standorte im Bestellvorgang. + +Beachten Sie, dass ein Local Zone VPS im Gegensatz zu einem regulären VPS keine Sicherheitsfunktionen wie Anti-DDoS oder erweiterte Optionen wie Additional IP und Load Balancer enthält. + +Ein Local Zone VPS erfüllt auch die Anforderungen von Projekten mit Datenresidenz- und Souveränitätsbedürfnissen. Durch das Hosten Ihrer Dienste in einer bestimmten Region können Sie lokale Vorschriften zum Datenverarbeitungs- und -speicherung leicht erfüllen, wie z. B. die europäische DSGVO. + +/// + +/// details | Kann ich meinen VPS von einer Local Zone in ein Rechenzentrum und umgekehrt migrieren? + +Nein, Sie können Dienste nicht direkt migrieren. Sie müssen Ihren gewünschten VPS bestellen, Ihre Daten übertragen und anschließend Ihren alten Dienst stornieren. Unser Support-Team kann Sie bei Bedarf durch diese Schritte führen. + +/// + +/// details | Welche Risiken bestehen bei der Nutzung eines VPS ohne DDoS-Schutz? + +VPS ohne Anti-DDoS-Schutz sind automatischen Angriffen durch Distributed Denial-of-Service (DDoS) ausgesetzt, was zu Dienstunterbrechungen und schwerwiegenden Sicherheitsverletzungen führen kann. + +- Direkte Exposition: Wenn Ihr Server Ziel eines DDoS-Angriffs wird, kann der Ansturm an schädlichen Anfragen ihn überlasten, wodurch Ihre Webseiten und Anwendungen nicht mehr zugänglich sind. +- Keine automatische Abwehr: Um Ihren Server zu schützen, müssen Sie Angriffe mithilfe von Drittanbieter-Sicherheitssoftware oder spezifischen Konfigurationen abwehren. +- Zusätzliche Verwaltungsaufwand: Das Fehlen robuster, eingebauter Sicherheitsfunktionen stellt ein großes Risiko dar und unterstreicht die Notwendigkeit einer sorgfältigen Überwachung und proaktiver Strategien, insbesondere für Projekte mit hohem Datenverkehr. + +Wenn die Resilienz gegenüber DDoS-Angriffen für Ihr Projekt von entscheidender Bedeutung ist, empfehlen wir Ihnen, einen OVHcloud VPS in einem unserer Rechenzentren zu wählen, der mit eingebauter Schutzfunktion ausgestattet ist. + +/// + +## Fragen zur VPS-Administration + +/// details | Wie verbinde ich mich mit meinem VPS? + +Sie können sich mithilfe der per E-Mail bereitgestellten Anmeldeinformationen nach der Dienstauslieferung *remote* mit Ihrem VPS verbinden. +Die Verbindungsart hängt davon ab, welche Betriebssysteme verwendet werden. + +Alle Details finden Sie in unserer Anleitung zu [den ersten Schritten mit einem VPS](/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps). + +/// + +/// details | Bietet OVHcloud Unterstützung bei der Softwarekonfiguration für meinen VPS? + +Wir können zwar keine Unterstützung bei der Softwarekonfiguration oder -verwaltung anbieten, doch stellen wir einige Tools und Ressourcen bereit, um Ihnen den Einstieg zu erleichtern. + +Zum Beispiel bieten wir eine Vielzahl vorab konfigurierter Vorlagen und Images für beliebte Betriebssysteme und Anwendungen an, um Ihnen die schnelle Einrichtung Ihres VPS zu ermöglichen. Wir stellen außerdem das OVHcloud Kundencenter bereit, in dem Sie Ihren VPS verwalten können, z. B. Neustart, Reinstallation und Ressourcenüberwachung. + +Außerdem bietet unsere Dokumentation und Wissensdatenbank eine Fülle von Informationen zur Konfiguration und Verwaltung Ihres VPS. + +Für spezifische Unterstützung bei der Softwarekonfiguration empfehlen wir Ihnen, sich an unsere [Community](/links/community) zu wenden oder die Hilfe eines qualifizierten Systemadministrators oder Entwicklers über unser [Partnerportal](/links/partner) in Anspruch zu nehmen. + +/// + +/// details | Kann ich auf meinem VPS mehrere Betriebssysteme installieren? + +OVHcloud Templates erlauben die Installation eines einzigen Betriebssystems. +Individuelle Anpassungen können vom Kunden vorgenommen werden und liegen in der Verantwortung des Server-Administrators. OVHcloud Dienste umfassen keine Verwaltungsaufgaben, wie z. B. Softwarekonfiguration oder externe Tools. + +Falls Sie bei der Konfiguration und Verwaltung Probleme haben, empfehlen wir Ihnen, sich an unsere [Community](/links/community) zu wenden oder die Hilfe eines qualifizierten Systemadministrators oder Entwicklers über unser [Partnerportal](/links/partner) in Anspruch zu nehmen. + +/// + +/// details | Kann ich auf einem VPS mithilfe von Virtualisierungssoftware (z. B. Proxmox) virtuelle Maschinen installieren? + +OVHcloud Templates für VPS enthalten weder das Proxmox-Betriebssystem noch ein ähnliches Betriebssystem für Virtualisierung. + +Anpassungen können vom Kunden vorgenommen werden und liegen in der Verantwortung des Server-Administrators. OVHcloud Dienste umfassen keine Verwaltungsaufgaben, wie z. B. Softwarekonfiguration oder die Nutzung externer Tools. + +Falls Sie bei der Konfiguration und Verwaltung Schwierigkeiten haben, empfehlen wir Ihnen, sich an unsere [Community](/links/community) zu wenden oder die Hilfe eines qualifizierten Systemadministrators oder Entwicklers über unser [Partnerportal](/links/partner) in Anspruch zu nehmen. + +/// + +/// details | Ist es möglich, die Hardware meines VPS (GPU, CPU etc.) auszuwählen oder zu aktualisieren? + +Ein VPS kann nicht auf der Hardware-Ebene angepasst oder geändert werden. +Wählen Sie im Bestellprozess ein [VPS-Modell](/links/bare-metal/vps) aus, das Ihre Mindestanforderungen erfüllt, und stufen Sie es bei Bedarf hoch. + +/// + +/// details | Mein VPS ist zu langsam, kann ich meinen VPS auf einen anderen Host verschieben? + +Um Leistungsprobleme auf Ihrem VPS zu beheben, müssen Sie unserem Support-Team spezifische Testergebnisse vorlegen. + +Beachten Sie, dass Ihr VPS in den [Rescue-Modus](/pages/bare_metal_cloud/virtual_private_servers/rescue) gebootet werden muss, um mögliche Softwareprobleme auszuschließen. + +Wenden Sie sich an unser Support-Team, indem Sie [eine Anfrage im OVHcloud Help Center erstellen](https://help.ovhcloud.com/csm?id=csm_get_help), damit wir Ihnen die vollständige Liste der erforderlichen Tests für eine ordnungsgemäße Begutachtung bereitstellen können. + +/// + +/// details | Ich habe einen neuen VPS bestellt, kann ich die verbleibende Vertragszeit meines alten VPS übertragen oder eine Rückerstattung erhalten? + +Dies ist in der Regel möglich, doch der Prozess erfordert eine [Anfrage an unser Support-Team über das OVHcloud Help Center](https://help.ovhcloud.com/csm?id=csm_get_help). + +Bevor Sie fortfahren, stellen Sie sicher, dass Sie [alle noch benötigten Daten migriert haben](/pages/bare_metal_cloud/dedicated_servers/migrate_a_server_to_another) oder erstellen Sie Backups Ihrer Daten. + +/// + +/// details | Kann ich meinen VPS in einen anderen OVHcloud Rechenzentrum in einem anderen Land verschieben? + +Eine Migration eines VPS in ein anderes Rechenzentrum ist nicht möglich. Um dies zu erreichen, können Sie eine [manuelle Migration](/pages/bare_metal_cloud/dedicated_servers/migrate_a_server_to_another) durchführen: + +- Laden Sie Ihre Daten vom aktuellen VPS herunter. +- Bestellen Sie einen neuen VPS. +- Laden Sie Ihre Daten auf den neuen VPS hoch. +- [Stornieren Sie den alten VPS](/pages/account_and_service_management/managing_billing_payments_and_services/how_to_cancel_services). + +/// + +/// details | Wie viele zusätzliche IPs kann ich auf einem VPS konfigurieren? + +Ein VPS ist auf [16 zusätzliche IP-Adressen](/links/network/additional-ip) beschränkt. + +Weitere Informationen zur IP-Konfiguration finden Sie in unserer Anleitung zur [Konfiguration von IP-Alias](/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing). + +/// + +/// details | Kann ich IP-Blöcke zu meinem VPS hinzufügen? + +Es ist nicht möglich, IP-Blöcke zu einem VPS hinzuzufügen. +Auf einem VPS können bis zu [16 zusätzliche IP-Adressen](/links/network/additional-ip) konfiguriert werden. + +/// + +/// details | Kann ich den VPS, der mit meiner Lizenz verknüpft ist, wechseln (Plesk, cPanel)? + +Lizenzen können zwischen Servern übertragen werden, es gibt jedoch Einschränkungen. + +Die beste Option besteht darin, sich mit Ihren Login-Daten in unserer [API-Konsole](/links/api) einzuloggen und zu prüfen, ob Ihre Lizenz auf einen anderen VPS übertragen werden kann. Weitere Informationen finden Sie in unserer Anleitung zu [den ersten Schritten mit der OVHcloud API](/pages/manage_and_operate/api/first-steps). + +Sobald Sie verbunden sind, verwenden Sie die folgenden Aufrufe, abhängig von der verwendeten Software: + +**Plesk** + +> [!api] +> +> @api {v1} /license/plesk GET /license/plesk/{serviceName}/canLicenseBeMovedTo +> + +**cPanel** + +> [!api] +> +> @api {v1} /license/cpanel GET /license/cpanel/{serviceName}/canLicenseBeMovedTo +> + +![API-Lizenz](images/getlicense.png){.thumbnail} + +Geben Sie die Parameter wie folgt ein: + +- `serviceName`: Geben Sie den internen Namen Ihrer Lizenz ein (siehe Abschnitt `Lizenzen` in Ihrem [OVHcloud Kundencenter](/links/manager)). +- `destinationIp`: Geben Sie die IPv4-Adresse des Ziel-Dienstes ein. + +Klicken Sie auf die Schaltfläche `EXECUTE`{.action}. + +Wenn das Ergebnis negativ ist (`false`), wird der Grund im Feld `RESPONSE` angezeigt. + +![API-Lizenz](images/getlicense_response.png){.thumbnail} + +Wenn die Ziel-IP mit Ihrer Lizenz kompatibel ist (`true`), können Sie den entsprechenden Aufruf verwenden, um sie zu übertragen: + +**Plesk** + +> [!api] +> +> @api {v1} /license/plesk POST /license/plesk/{serviceName}/changeIp +> + +**cPanel** + +> [!api] +> +> @api {v1} /license/cpanel POST /license/cpanel/{serviceName}/changeIp +> + +/// + +## Fragen zu Sicherheit und Backup + +/// details | Wie sichere ich meinen VPS? + +Standardmäßig wird der VPS nur mit dem ausgewählten Betriebssystem ausgeliefert. Der VPS-Administrator ist für die Anwendung einer geeigneten Sicherheitskonfiguration nach der Auslieferung des VPS verantwortlich. +Beachten Sie auch unserere Anleitung zur [Absicherung eines VPS](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps). + +/// + +/// details | Wie kann ich meine Dateien oder ein Backup des VPS herunterladen? + +Es gibt mehrere Optionen, z. B.: + +- Download über SFTP: Verbinden Sie sich mit Ihrem VPS mit einem Software-Client, der SFTP unterstützt (z. B. [FileZilla](/pages/bare_metal_cloud/dedicated_servers/comment-deposer-ou-recuperer-des-donnees-sur-un-serveur-dedie-via-sftp)), und übertragen Sie alle Dateien im Root-Verzeichnis des Systems. +- Download über `rsync` (Kommandozeilentool): Verwenden Sie den Befehl `rsync -avz -e ssh username@vps_ip_address:/ /local_directory/`, um alle Dateien und Ordner Ihres VPS herunterzuladen. +- Download über die Option **Automatisches Backup**: Folgen Sie unserer Anleitung zur [Verwendung von automatischen Backups auf einem VPS](/pages/bare_metal_cloud/virtual_private_servers/using-automated-backups-on-a-vps), um Dateien aus einem Backup herunterzuladen. +- Download über die Option **Snapshot**: Folgen Sie unserer Anleitung zur [Verwendung von Snapshots auf einem VPS](/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps), um einen VPS-Snapshot herunterzuladen. + +/// + +/// details | Wie kann ich meinen VPS als VM-Datei herunterladen? + +Es ist nicht möglich, eine VM-Datei eines OVHcloud VPS herunterzuladen. Sie können jedoch die VPS-Option **Snapshot** in Ihrem OVHcloud Kundencenter verwenden, um eine Bilddatei abzurufen. + +Folgen Sie unserer Anleitung zur [Verwendung von Snapshots auf einem VPS](/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps), um einen VPS-Snapshot zu erstellen und herunterzuladen. + +Sie können die heruntergeladene Snapshot-Datei anschließend lokal in ein Format umwandeln, das Ihren Anforderungen entspricht. + +Für weitergehende Unterstützung können Sie sich an einen unserer [Partner](/links/partner) wenden. + +/// + +/// details | Wie kann ich auf meinen Backup-Speicher von einer IP-Adresse außerhalb meines Dienstes zugreifen? + +Der Zugriff auf den Backup-Speicherplatz Ihres VPS (FTP-Speicherplatz) kann auf IP-Adressen beschränkt sein, die mit einem Dienst in Ihrem OVHcloud Kundencenter verknüpft sind. + +Um weitere IP-Adressen hinzuzufügen, von denen aus Sie zugreifen können, können Sie die OVHcloud API verwenden. +Dies ermöglicht es Ihnen, Ihre Backup-Daten über verschiedene Protokolle (FTP, NFS, CIFS) von einem anderen aus Dienst abzurufen. > [!warning] -> Nur IP-Adressen von OVHcloud können autorisiert werden. +> Nur OVHcloud IP-Adressen können autorisiert werden. > -Loggen Sie sich mit den Zugangsdaten Ihres Kunden-Accounts in der [OVHcloud API-Konsole](/links/api) ein und verwenden Sie den folgenden Aufruf: +Loggen Sie sich in die [OVHcloud API-Konsole](/links/api) mit Ihren Login-Daten ein und verwenden Sie den folgenden Aufruf: > [!api] > @@ -104,23 +405,54 @@ Loggen Sie sich mit den Zugangsdaten Ihres Kunden-Accounts in der [OVHcloud API- Bearbeiten Sie die Parameter wie folgt: - `serviceName`: Geben Sie den internen Namen Ihres VPS ein (`vps-x11x11xyy.vps.ovh.net`). -- `cifs`: Auf `true` setzen, wenn zutreffend. -- `ftp`: Auf `true` setzen, wenn zutreffend. -- `ipBlock`: Geben Sie die IP-Adresse ein, die Zugriff erhalten soll, in der Form `203.0.113.100/32`. -- `nfs`: Auf `true` setzen, wenn zutreffend. +- `cifs`: Setzen Sie dies auf `true`, wenn zutreffend. +- `ftp`: Setzen Sie dies auf `true`, wenn zutreffend. +- `ipBlock`: Geben Sie die IP-Adresse ein, die Zugriff haben soll, im Format `203.0.113.100/32`. +- `nfs`: Setzen Sie dies auf `true`, wenn zutreffend. -Klicken Sie auf `EXECUTE`{.action}. +Klicken Sie auf die Schaltfläche `EXECUTE`{.action}. -Verwenden Sie den folgenden Aufruf, um zu überprüfen, ob Ihre IP-Adresse autorisiert ist: +Um zu überprüfen, ob Ihre IP-Adresse autorisiert ist, verwenden Sie den folgenden Aufruf: > [!api] > > @api {v1} /vps GET /vps/{serviceName}/backupftp/access > +/// + + +/// details | Ist mein VPS vor externen Angriffen geschützt? + +Obwohl OVHcloud Sicherheitsmaßnahmen anwendet, um die gesamte Infrastruktur zu schützen, ist der Administrator eines VPS für die Sicherheit der darauf gehosteten Anwendungen und Daten verantwortlich. + +- Folgen Sie unserer Anleitung zur [Konfiguration der OVHcloud Edge Network Firewall](/pages/bare_metal_cloud/dedicated_servers/firewall_network), die in unserer Anti-DDoS-Infrastruktur integriert ist und die Exposition Ihrer Dienste gegenüber DDoS-Angriffen begrenzt. +- Darüber hinaus können Sie unsere Anleitungen zur [Firewall-Konfiguration](/pages/bare_metal_cloud/virtual_private_servers/firewall-Linux-iptable) mit `iptables` auf Linux-basierten Distributionen und zur [Windows-Firewall](/pages/bare_metal_cloud/virtual_private_servers/activate-port-firewall-soft-win) verwenden. +- Für Linux-basierte Distributionen auf einem VPS können Sie die Anweisungen in unserer Anleitung zur [Absicherung eines VPS](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps) befolgen, um zusätzliche Sicherheitsmaßnahmen anzuwenden. + +/// + +/// details | Wie sichere ich meinen VPS vor DDoS-Angriffen? + +OVHcloud bietet mehrere Sicherheitsfunktionen, um Ihren VPS vor schädlichem Traffic zu schützen: + +- Anti-DDoS-Schutz: Unsere VPS-Dienste sind standardmäßig durch unsere [Anti-DDoS-Infrastruktur](/links/security/antiddos) geschützt, die DDoS-Angriffe in Echtzeit erkennt und abmildert. +- IP-Blockierung: Sie können [spezifische IP-Adressen oder IP-Bereiche](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps) blockieren, die auf Ihren VPS zugreifen. +- Firewall-Regeln: Sie können [benutzerdefinierte Firewall-Regeln konfigurieren](/pages/bare_metal_cloud/dedicated_servers/firewall_network), um den eingehenden und ausgehenden Traffic direkt auf Ihrem VPS zu steuern. +- VAC (VPS Anti-DDoS): Unser VAC-System bietet einen zusätzlichen Schutz vor DDoS-Angriffen, einschließlich Traffic-Filterung und Rate-Limiting. + +/// + +/// details | Ich möchte einen VPS als Game Server verwenden, profitiert er vom gleichen Firewall-Schutz wie die Game Dedicated Server? + +Der OVHcloud Game DDoS-Schutz ist nur für unsere Game Dedicated Server verfügbar. Wenn Sie einen VPS für Game-Hosting nutzen möchten, müssen Sie die Firewall direkt auf Ihrem System konfigurieren, angepasst an das gewünschte Spiel. Weitere Informationen finden Sie in unserer Anleitung zur [Firewall-Konfiguration](/pages/bare_metal_cloud/virtual_private_servers/firewall-Linux-iptable). + +Der Vorteil eines VPS gegenüber einem Dedicated Server ist die Möglichkeit, dessen Ressourcen entsprechend Ihrer tatsächlichen Nutzung zu skalieren. Sie können Ihren VPS mit nur wenigen Klicks upgraden, um von einem leistungsfähigeren System zu profitieren. + +/// ## Weiterführende Informationen Wenn Sie Hilfe bei der Nutzung und Konfiguration Ihrer OVHcloud Lösungen benötigen, beachten Sie unsere [Support-Angebote](/links/support). -Treten Sie unserer [User Community](/links/community) bei. \ No newline at end of file +Treten Sie unserer [User Community](/links/community) bei. diff --git a/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.en-asia.md b/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.en-asia.md deleted file mode 100755 index 48c051d169b..00000000000 --- a/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.en-asia.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -title: FAQ VPS OVHcloud -updated: 2025-08-07 ---- - -## FAQ VPS - -### What is a VPS, and what is it used for? - -A virtual private server (VPS) is used for hosting websites (e-commerce, content, visual media) and software applications (portals, extranets, collaborative solutions, wikis, CRM). Unlike shared hosting, the data is isolated onto a virtual machine which is dedicated to the user. - -The VPS is a perfect compromise between web hosting plans and physical servers, combining reliability with the high performance of a dedicated server — but without the difficulty of managing a server's physical hardware. - -### How do I choose between a VPS and a web hosting plan? - -Using a VPS is the next logical step up from using a web hosting plan. Virtual private servers offer a wider range of options, and more flexibility in terms of configuration, access and features (root access, Apache PHP.init). You can also install an SSL certificate and any other software you want. - -However, we would like to emphasize the importance of choosing the right VPS for you. A VPS needs to be configured in a way that suits your application requirements, and the growth of your business. - -### What are the advantages of a VPS, compared to a dedicated server? - -The advantage of a VPS is that you don’t have to worry about hardware management — so you would not need to monitor the status of disks, RAM, and CPU. They are adapted to host most types of web projects that are moderately sized. -We recommend using a dedicated server if you want to manage the hardware aspects yourself, build more elaborate architectures, create an infrastructure that includes a private network (vRack), and deploy other complex solutions that are not web services. - -As a general rule, users with a growing volume of web activity either move up to dedicated servers, or Public Cloud solutions. These services offer more complex, flexible infrastructures that can adapt to a high level of growth. - -### What are the differences between VPS and Public Cloud solutions? - -A VPS is a solution adapted for pre-production and production environments that don’t need constant performance. -The OVHcloud Public Cloud offers a multi-server infrastructure, with high availability for servers. vRack, a private network service, is also available with this service. - -### How do I choose my OVHcloud VPS? - -To choose a VPS adapted to your needs, please check the following: - -- The quantity of resources required (processor, memory, disk space, bandwidth, etc.) -- The operating system required (Linux or Windows) -- The technical requirements that are essential for the application to work properly (for example: a database's read/write speed requirement) - -This will help you make the right choice from our VPS solutions: - -- **VPS Starter**: Entry-level server to test our solution (with a Linux distribution only). -- **VPS Value, Essential and Comfort**: Ideal for hosting websites, e-commerce services or monitoring systems. -- **VPS Elite**: Adapted for e-commerce websites and applications that require more CPU and memory resources. -- **VPS Limited Edition** (Limited quantities): This VPS solution offers increased performance, which is a major advantage when it comes to hosting complex websites, resource-intensive applications, and even game servers. This offer is limited and only valid until stocks run out. - -> [!primary] -> You can upgrade a Limited Edition VPS to another VPS from the same range, but for technical reasons, you cannot upgrade a Limited Edition VPS to a VPS from another range (Starter, Value, Essential or Comfort). - -### Who can use a VPS? - -Using a VPS requires basic knowledge of server administration. It is essential for managing the operating system (Linux or Windows) installed on the machine, and configuring the applications. Think you might need a VPS, but don’t have the technical knowledge required? We recommend getting in touch with one of our [partners](/links/partner). - -If you would like to get guaranteed resources but don't know how to manage servers, we would recommend [Performance web hosting plans](/links/web/hosting-performance-offer). - -### How do I connect to my VPS? - -You can log in to your VPS remotely, using the credentials provided by email after the service delivery. -The connection method depends on which operating systems are in use. - -All the details are set out in our guide on [how to get started with a VPS](/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps). - -### Can I host several websites on a VPS? - -Yes. A VPS can be partitioned, and organised to suit your requirements. This means you can use it to host several websites or projects, by allocating a private space to each one. You choose the volume of each space, too. To simplify how you do this, you can install a web hosting control panel like Plesk or cPanel. - -### Is my VPS backed up? - -It is advisable to apply an appropriate backup strategy according to the sensibility of your data. -Visit our [VPS web page](/links/bare-metal/vps-options) to learn more about the available options. - -### How do I secure my VPS? - -By default, the VPS is provided "bare", and there is no security configuration applied. For this reason, the first thing you need to do when you receive a VPS is configure security measures for it. -To do this, please refer to our guide on [Securing a VPS](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps). - -### What bandwidth is allocated to my VPS? Is it guaranteed? - -The bandwidth listed on our solution pages is guaranteed. It is the minimum amount allocated to you. - -### Which SLA is applied to my VPS? - -OVHcloud offers a 99.9% SLA across the VPS ranges. - - - -### How can I access my backup storage from an IP address outside my service? - -Access to the backup storage of your VPS (FTP storage) might be restricted to IP addresses linked to a service within your OVHcloud customer acccount. - -In order to add other IP addresses from which to access, you can use the OVHcloud API. -This will allow you to retrieve your backup data from a different service through various protocols (FTP, NFS, CIFS). - -> [!warning] -> Only OVHcloud IP addresses can be authorized. -> - -Log in to the [OVHcloud API console](/links/api) with your customer account credentials and use the following call: - -> [!api] -> -> @api {v1} /vps POST /vps/{serviceName}/backupftp/access -> - -Edit the parameters as follows: - -- `serviceName`: Enter the internal name of your VPS (`vps-x11x11xyy.vps.ovh.net`). -- `cifs`: Set to `true` if applicable. -- `ftp`: Set to `true` if applicable. -- `ipBlock`: Enter the IP address that will have access, in the form `203.0.113.100/32`. -- `nfs`: Set to `true` if applicable. - -Click the button `EXECUTE`{.action}. - -To verify that your IP address is authorized, use the following call: - -> [!api] -> -> @api {v1} /vps GET /vps/{serviceName}/backupftp/access -> - -## Go further - -If you would like assistance using and configuring your OVHcloud solutions, please refer to our [support offers](/links/support). - -Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.en-au.md b/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.en-au.md deleted file mode 100755 index 48c051d169b..00000000000 --- a/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.en-au.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -title: FAQ VPS OVHcloud -updated: 2025-08-07 ---- - -## FAQ VPS - -### What is a VPS, and what is it used for? - -A virtual private server (VPS) is used for hosting websites (e-commerce, content, visual media) and software applications (portals, extranets, collaborative solutions, wikis, CRM). Unlike shared hosting, the data is isolated onto a virtual machine which is dedicated to the user. - -The VPS is a perfect compromise between web hosting plans and physical servers, combining reliability with the high performance of a dedicated server — but without the difficulty of managing a server's physical hardware. - -### How do I choose between a VPS and a web hosting plan? - -Using a VPS is the next logical step up from using a web hosting plan. Virtual private servers offer a wider range of options, and more flexibility in terms of configuration, access and features (root access, Apache PHP.init). You can also install an SSL certificate and any other software you want. - -However, we would like to emphasize the importance of choosing the right VPS for you. A VPS needs to be configured in a way that suits your application requirements, and the growth of your business. - -### What are the advantages of a VPS, compared to a dedicated server? - -The advantage of a VPS is that you don’t have to worry about hardware management — so you would not need to monitor the status of disks, RAM, and CPU. They are adapted to host most types of web projects that are moderately sized. -We recommend using a dedicated server if you want to manage the hardware aspects yourself, build more elaborate architectures, create an infrastructure that includes a private network (vRack), and deploy other complex solutions that are not web services. - -As a general rule, users with a growing volume of web activity either move up to dedicated servers, or Public Cloud solutions. These services offer more complex, flexible infrastructures that can adapt to a high level of growth. - -### What are the differences between VPS and Public Cloud solutions? - -A VPS is a solution adapted for pre-production and production environments that don’t need constant performance. -The OVHcloud Public Cloud offers a multi-server infrastructure, with high availability for servers. vRack, a private network service, is also available with this service. - -### How do I choose my OVHcloud VPS? - -To choose a VPS adapted to your needs, please check the following: - -- The quantity of resources required (processor, memory, disk space, bandwidth, etc.) -- The operating system required (Linux or Windows) -- The technical requirements that are essential for the application to work properly (for example: a database's read/write speed requirement) - -This will help you make the right choice from our VPS solutions: - -- **VPS Starter**: Entry-level server to test our solution (with a Linux distribution only). -- **VPS Value, Essential and Comfort**: Ideal for hosting websites, e-commerce services or monitoring systems. -- **VPS Elite**: Adapted for e-commerce websites and applications that require more CPU and memory resources. -- **VPS Limited Edition** (Limited quantities): This VPS solution offers increased performance, which is a major advantage when it comes to hosting complex websites, resource-intensive applications, and even game servers. This offer is limited and only valid until stocks run out. - -> [!primary] -> You can upgrade a Limited Edition VPS to another VPS from the same range, but for technical reasons, you cannot upgrade a Limited Edition VPS to a VPS from another range (Starter, Value, Essential or Comfort). - -### Who can use a VPS? - -Using a VPS requires basic knowledge of server administration. It is essential for managing the operating system (Linux or Windows) installed on the machine, and configuring the applications. Think you might need a VPS, but don’t have the technical knowledge required? We recommend getting in touch with one of our [partners](/links/partner). - -If you would like to get guaranteed resources but don't know how to manage servers, we would recommend [Performance web hosting plans](/links/web/hosting-performance-offer). - -### How do I connect to my VPS? - -You can log in to your VPS remotely, using the credentials provided by email after the service delivery. -The connection method depends on which operating systems are in use. - -All the details are set out in our guide on [how to get started with a VPS](/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps). - -### Can I host several websites on a VPS? - -Yes. A VPS can be partitioned, and organised to suit your requirements. This means you can use it to host several websites or projects, by allocating a private space to each one. You choose the volume of each space, too. To simplify how you do this, you can install a web hosting control panel like Plesk or cPanel. - -### Is my VPS backed up? - -It is advisable to apply an appropriate backup strategy according to the sensibility of your data. -Visit our [VPS web page](/links/bare-metal/vps-options) to learn more about the available options. - -### How do I secure my VPS? - -By default, the VPS is provided "bare", and there is no security configuration applied. For this reason, the first thing you need to do when you receive a VPS is configure security measures for it. -To do this, please refer to our guide on [Securing a VPS](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps). - -### What bandwidth is allocated to my VPS? Is it guaranteed? - -The bandwidth listed on our solution pages is guaranteed. It is the minimum amount allocated to you. - -### Which SLA is applied to my VPS? - -OVHcloud offers a 99.9% SLA across the VPS ranges. - - - -### How can I access my backup storage from an IP address outside my service? - -Access to the backup storage of your VPS (FTP storage) might be restricted to IP addresses linked to a service within your OVHcloud customer acccount. - -In order to add other IP addresses from which to access, you can use the OVHcloud API. -This will allow you to retrieve your backup data from a different service through various protocols (FTP, NFS, CIFS). - -> [!warning] -> Only OVHcloud IP addresses can be authorized. -> - -Log in to the [OVHcloud API console](/links/api) with your customer account credentials and use the following call: - -> [!api] -> -> @api {v1} /vps POST /vps/{serviceName}/backupftp/access -> - -Edit the parameters as follows: - -- `serviceName`: Enter the internal name of your VPS (`vps-x11x11xyy.vps.ovh.net`). -- `cifs`: Set to `true` if applicable. -- `ftp`: Set to `true` if applicable. -- `ipBlock`: Enter the IP address that will have access, in the form `203.0.113.100/32`. -- `nfs`: Set to `true` if applicable. - -Click the button `EXECUTE`{.action}. - -To verify that your IP address is authorized, use the following call: - -> [!api] -> -> @api {v1} /vps GET /vps/{serviceName}/backupftp/access -> - -## Go further - -If you would like assistance using and configuring your OVHcloud solutions, please refer to our [support offers](/links/support). - -Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.en-ca.md b/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.en-ca.md deleted file mode 100755 index 48c051d169b..00000000000 --- a/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.en-ca.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -title: FAQ VPS OVHcloud -updated: 2025-08-07 ---- - -## FAQ VPS - -### What is a VPS, and what is it used for? - -A virtual private server (VPS) is used for hosting websites (e-commerce, content, visual media) and software applications (portals, extranets, collaborative solutions, wikis, CRM). Unlike shared hosting, the data is isolated onto a virtual machine which is dedicated to the user. - -The VPS is a perfect compromise between web hosting plans and physical servers, combining reliability with the high performance of a dedicated server — but without the difficulty of managing a server's physical hardware. - -### How do I choose between a VPS and a web hosting plan? - -Using a VPS is the next logical step up from using a web hosting plan. Virtual private servers offer a wider range of options, and more flexibility in terms of configuration, access and features (root access, Apache PHP.init). You can also install an SSL certificate and any other software you want. - -However, we would like to emphasize the importance of choosing the right VPS for you. A VPS needs to be configured in a way that suits your application requirements, and the growth of your business. - -### What are the advantages of a VPS, compared to a dedicated server? - -The advantage of a VPS is that you don’t have to worry about hardware management — so you would not need to monitor the status of disks, RAM, and CPU. They are adapted to host most types of web projects that are moderately sized. -We recommend using a dedicated server if you want to manage the hardware aspects yourself, build more elaborate architectures, create an infrastructure that includes a private network (vRack), and deploy other complex solutions that are not web services. - -As a general rule, users with a growing volume of web activity either move up to dedicated servers, or Public Cloud solutions. These services offer more complex, flexible infrastructures that can adapt to a high level of growth. - -### What are the differences between VPS and Public Cloud solutions? - -A VPS is a solution adapted for pre-production and production environments that don’t need constant performance. -The OVHcloud Public Cloud offers a multi-server infrastructure, with high availability for servers. vRack, a private network service, is also available with this service. - -### How do I choose my OVHcloud VPS? - -To choose a VPS adapted to your needs, please check the following: - -- The quantity of resources required (processor, memory, disk space, bandwidth, etc.) -- The operating system required (Linux or Windows) -- The technical requirements that are essential for the application to work properly (for example: a database's read/write speed requirement) - -This will help you make the right choice from our VPS solutions: - -- **VPS Starter**: Entry-level server to test our solution (with a Linux distribution only). -- **VPS Value, Essential and Comfort**: Ideal for hosting websites, e-commerce services or monitoring systems. -- **VPS Elite**: Adapted for e-commerce websites and applications that require more CPU and memory resources. -- **VPS Limited Edition** (Limited quantities): This VPS solution offers increased performance, which is a major advantage when it comes to hosting complex websites, resource-intensive applications, and even game servers. This offer is limited and only valid until stocks run out. - -> [!primary] -> You can upgrade a Limited Edition VPS to another VPS from the same range, but for technical reasons, you cannot upgrade a Limited Edition VPS to a VPS from another range (Starter, Value, Essential or Comfort). - -### Who can use a VPS? - -Using a VPS requires basic knowledge of server administration. It is essential for managing the operating system (Linux or Windows) installed on the machine, and configuring the applications. Think you might need a VPS, but don’t have the technical knowledge required? We recommend getting in touch with one of our [partners](/links/partner). - -If you would like to get guaranteed resources but don't know how to manage servers, we would recommend [Performance web hosting plans](/links/web/hosting-performance-offer). - -### How do I connect to my VPS? - -You can log in to your VPS remotely, using the credentials provided by email after the service delivery. -The connection method depends on which operating systems are in use. - -All the details are set out in our guide on [how to get started with a VPS](/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps). - -### Can I host several websites on a VPS? - -Yes. A VPS can be partitioned, and organised to suit your requirements. This means you can use it to host several websites or projects, by allocating a private space to each one. You choose the volume of each space, too. To simplify how you do this, you can install a web hosting control panel like Plesk or cPanel. - -### Is my VPS backed up? - -It is advisable to apply an appropriate backup strategy according to the sensibility of your data. -Visit our [VPS web page](/links/bare-metal/vps-options) to learn more about the available options. - -### How do I secure my VPS? - -By default, the VPS is provided "bare", and there is no security configuration applied. For this reason, the first thing you need to do when you receive a VPS is configure security measures for it. -To do this, please refer to our guide on [Securing a VPS](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps). - -### What bandwidth is allocated to my VPS? Is it guaranteed? - -The bandwidth listed on our solution pages is guaranteed. It is the minimum amount allocated to you. - -### Which SLA is applied to my VPS? - -OVHcloud offers a 99.9% SLA across the VPS ranges. - - - -### How can I access my backup storage from an IP address outside my service? - -Access to the backup storage of your VPS (FTP storage) might be restricted to IP addresses linked to a service within your OVHcloud customer acccount. - -In order to add other IP addresses from which to access, you can use the OVHcloud API. -This will allow you to retrieve your backup data from a different service through various protocols (FTP, NFS, CIFS). - -> [!warning] -> Only OVHcloud IP addresses can be authorized. -> - -Log in to the [OVHcloud API console](/links/api) with your customer account credentials and use the following call: - -> [!api] -> -> @api {v1} /vps POST /vps/{serviceName}/backupftp/access -> - -Edit the parameters as follows: - -- `serviceName`: Enter the internal name of your VPS (`vps-x11x11xyy.vps.ovh.net`). -- `cifs`: Set to `true` if applicable. -- `ftp`: Set to `true` if applicable. -- `ipBlock`: Enter the IP address that will have access, in the form `203.0.113.100/32`. -- `nfs`: Set to `true` if applicable. - -Click the button `EXECUTE`{.action}. - -To verify that your IP address is authorized, use the following call: - -> [!api] -> -> @api {v1} /vps GET /vps/{serviceName}/backupftp/access -> - -## Go further - -If you would like assistance using and configuring your OVHcloud solutions, please refer to our [support offers](/links/support). - -Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.en-gb.md b/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.en-gb.md index 48c051d169b..05be145b4ac 100755 --- a/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.en-gb.md +++ b/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.en-gb.md @@ -1,90 +1,391 @@ --- -title: FAQ VPS OVHcloud -updated: 2025-08-07 +title: "OVHcloud VPS FAQ" +excerpt: "Find the answers to the most frequently asked questions about our VPS offers" +updated: 2025-10-30 --- -## FAQ VPS + -### What is a VPS, and what is it used for? +## General questions about VPS offers -A virtual private server (VPS) is used for hosting websites (e-commerce, content, visual media) and software applications (portals, extranets, collaborative solutions, wikis, CRM). Unlike shared hosting, the data is isolated onto a virtual machine which is dedicated to the user. +/// details | What is a VPS, and what is it used for? -The VPS is a perfect compromise between web hosting plans and physical servers, combining reliability with the high performance of a dedicated server — but without the difficulty of managing a server's physical hardware. +A virtual private server (VPS) is used for hosting websites (e-commerce, content, visual media) and software applications (portals, extranets, collaborative solutions, wikis, CRM). Unlike shared hosting, a VPS offers an isolated environment, dedicated to the customer. Our VPS solutions bridge the gap between shared web hosting and dedicated servers, combining performance and reliability without the burden of hardware management. You can also easily upgrade your configuration without changing servers. -### How do I choose between a VPS and a web hosting plan? +/// -Using a VPS is the next logical step up from using a web hosting plan. Virtual private servers offer a wider range of options, and more flexibility in terms of configuration, access and features (root access, Apache PHP.init). You can also install an SSL certificate and any other software you want. +/// details | What are the advantages of an OVHcloud VPS? -However, we would like to emphasize the importance of choosing the right VPS for you. A VPS needs to be configured in a way that suits your application requirements, and the growth of your business. +OVHcloud VPS offers provide excellent value for performance, with unlimited traffic and several global locations for low latency and improved accessibility, depending on your needs. -### What are the advantages of a VPS, compared to a dedicated server? +/// -The advantage of a VPS is that you don’t have to worry about hardware management — so you would not need to monitor the status of disks, RAM, and CPU. They are adapted to host most types of web projects that are moderately sized. -We recommend using a dedicated server if you want to manage the hardware aspects yourself, build more elaborate architectures, create an infrastructure that includes a private network (vRack), and deploy other complex solutions that are not web services. +/// details | Is a VPS solution the right choice for me? -As a general rule, users with a growing volume of web activity either move up to dedicated servers, or Public Cloud solutions. These services offer more complex, flexible infrastructures that can adapt to a high level of growth. +Using a VPS requires basic knowledge of server administration. To bear this in mind is crucial for effectively managing your OS (Linux or Windows), and setting up your applications, like PrestaShop or WordPress, for example. -### What are the differences between VPS and Public Cloud solutions? +If you need a VPS but lack the technical expertise to manage it, consider reaching out to one of our [partners](/links/partner) for assistance. -A VPS is a solution adapted for pre-production and production environments that don’t need constant performance. -The OVHcloud Public Cloud offers a multi-server infrastructure, with high availability for servers. vRack, a private network service, is also available with this service. +If you require provisioned resources but prefer not to deal with server administration, we recommend opting for our Performance web hosting plans. -### How do I choose my OVHcloud VPS? +/// -To choose a VPS adapted to your needs, please check the following: +/// details | Can I easily upgrade my VPS to a higher range or downgrade to a lower configuration? -- The quantity of resources required (processor, memory, disk space, bandwidth, etc.) -- The operating system required (Linux or Windows) -- The technical requirements that are essential for the application to work properly (for example: a database's read/write speed requirement) +Yes, you can upgrade your configuration from the OVHcloud Control Panel, without manually migrating your data. The upgrade options available depend on the range and model of the VPS. -This will help you make the right choice from our VPS solutions: +However, to downgrade your configuration, you will need to subscribe to a new plan, transfer your data, then cancel your old service. Our support team is available to assist you if necessary. -- **VPS Starter**: Entry-level server to test our solution (with a Linux distribution only). -- **VPS Value, Essential and Comfort**: Ideal for hosting websites, e-commerce services or monitoring systems. -- **VPS Elite**: Adapted for e-commerce websites and applications that require more CPU and memory resources. -- **VPS Limited Edition** (Limited quantities): This VPS solution offers increased performance, which is a major advantage when it comes to hosting complex websites, resource-intensive applications, and even game servers. This offer is limited and only valid until stocks run out. +/// -> [!primary] -> You can upgrade a Limited Edition VPS to another VPS from the same range, but for technical reasons, you cannot upgrade a Limited Edition VPS to a VPS from another range (Starter, Value, Essential or Comfort). +/// details | What region or country should I choose for my VPS? -### Who can use a VPS? +The closer your data centre is to your audience, the lower the latency will be, leading to a better user experience and increased trust in your services. -Using a VPS requires basic knowledge of server administration. It is essential for managing the operating system (Linux or Windows) installed on the machine, and configuring the applications. Think you might need a VPS, but don’t have the technical knowledge required? We recommend getting in touch with one of our [partners](/links/partner). +/// -If you would like to get guaranteed resources but don't know how to manage servers, we would recommend [Performance web hosting plans](/links/web/hosting-performance-offer). +/// details | What is the advantage of a VPS located in Europe? -### How do I connect to my VPS? +Hosting your VPS with OVHcloud in France or generally within the EU offers advantages such as competitive pricing and reinforced data protection. Your service is not subject to the US CLOUD Act, shielding it from non-European interference. -You can log in to your VPS remotely, using the credentials provided by email after the service delivery. +/// + +/// details | Are backups included with my VPS? + +Yes, when you order a VPS, a daily backup option is included free of charge. + +For even better protection, you can also opt for our Premium backup option. It offers: + +- The option to revert to a backup that is up to a week old. +- The option to schedule backups, optimizing data management and minimizing impact on business operations. + +In addition, we offer: + +- Snapshots: You can create manual, instant snapshots that capture the exact state of your VPS just before an update or critical change. +- An external backup: Store your data on a separate, secure disk, allowing for easy recovery if a major incident occurs. + +By using these solutions, you can customize your backup management to fit your security and business continuity needs. + +Visit our [VPS web page](/links/bare-metal/vps) to learn more about the available options. + +/// + +/// details | Can I host several websites on a VPS? + +Yes, a VPS can be configured to host multiple websites or projects. You can partition your storage space to suit your needs, and use specialized interfaces such as Plesk or cPanel to simplify your website management. + +/// + +/// details | Will I get a domain name and email service included with my VPS? + +No, our VPS solutions do not include a domain name or email service. These services can be ordered separately in the OVHcloud Control Panel. + +/// + +/// details | How do I choose between a VPS and a web hosting plan? + +**Web hosting plan** + +- Ideal for basic hosting needs with a pre-configured setup. + +**VPS** + +- More flexibility and control, perfect for scaling projects with complex configuration needs. + +If you host web services on a VPS, you can install your preferred software, customize server settings, and host multiple websites with dedicated resources. Please note that a VPS needs to be configured in a way that suits your application requirements and is adapted to your business growth. + +/// + +/// details | What is the difference between a VPS and Public Cloud solutions? + +**VPS** + +- An optimized and dedicated virtual machine suitable for both pre-production and production, designed to host several web projects. + +**OVHcloud Public Cloud** + +- Offers a multi-server infrastructure with high availability and a private network (vRack), and is designed for complex, scalable architectures. + +/// + +/// details | What are the advantages of a VPS, compared to a dedicated server? + +**VPS** + +- Offers simplified management without hardware maintenance, ideal for projects needing tight control. + +**Dedicated server** + +- Recommended for complex infrastructure that require full hardware control and guaranteed performance. + +A VPS eliminates the need to manage physical hardware such as storage, RAM, and CPU, making it well-suited for most web applications. As your business grows, you can upgrade your VPS, or migrate to a dedicated server or a Public Cloud solution for a more flexible and powerful infrastructure. + +/// + +/// details | What bandwidth is allocated to my VPS? Is it guaranteed? + +The bandwidth listed on our [VPS web page](/links/bare-metal/vps) is guaranteed. It is the minimum amount allocated to your service. + +/// + +/// details | Which SLA is applied to my VPS? + +An OVHcloud VPS includes a 99.9% SLA. + +/// + + +/// details | What are the unique features of a Local Zone VPS? + +With a Local Zone VPS, you can significantly reduce access times to your sites and applications, because your data is hosted closer to your users. This creates a better user experience by reducing latency whenever applications require a minimized response time. Simply select one of our worldwide locations when placing an order. + +Keep in mind that a Local Zone VPS, unlike a regular VPS, does not include security features like Anti-DDoS, or advanced options such as Additional IP and Load Balancer. + +A Local Zone VPS also meets the needs of projects with data residency and sovereignty requirements. By hosting your services in a specific region, you can easily meet local regulations relating to data processing and storage, such as the European GDPR. + +/// + +/// details | Can I migrate my VPS from a Local Zone to a data centre, and vice versa? + +No, you cannot migrate services directly. You will need to order a new VPS, transfer your data, then cancel your old service. Our support team can guide you through these steps if needed. + +/// + +/// details | What are the risks of using a VPS without DDoS protection? + +Virtual private servers without anti-DDoS protection are automatically exposed to distributed denial-of-service (DDoS) attacks, potentially resulting in service outages and serious security breaches. + +- Direct exposure: If your server is targeted by a DDoS attack, the influx of malicious requests may overwhelm it, causing your sites and applications to become inaccessible. +- No automatic mitigation: To protect your server, you will need to fend off attacks using third-party security software or specific configurations. +- Additional management burden: The lack of robust, built-in security presents a major risk, highlighting the need for vigilant monitoring and proactive strategies, particularly for high-traffic projects. + +If resilience against DDoS attacks is a critical factor for your project, we recommend opting for an OVHcloud VPS hosted in one of our data centres, which comes with built-in protection. + +/// + + +## Questions related to VPS administration + +/// details | How do I connect to my VPS? + +You can log in to your VPS remotely, using the credentials provided by email after service delivery. The connection method depends on which operating systems are in use. All the details are set out in our guide on [how to get started with a VPS](/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps). -### Can I host several websites on a VPS? +/// + +/// details | Does OVHcloud provide software configuration assistance for my VPS? + +While we cannot offer software configuration or administration assistance, we do provide some tools and resources to help you get started. + +For example, we offer a range of pre-configured templates and images for popular operating systems and applications to help to quickly deploy your VPS. We also provide the OVHcloud Control Panel, where you can manage your VPS, including tasks such as restarting, reinstalling, and monitoring resources. + +Additionally, our documentation and knowledge base contain a wealth of information on configuring and managing your VPS. + +However, for specific software configuration assistance, we recommend reaching out to our [community](/links/community) or seeking the help of a qualified system administrator or developer via our [partner portal](/links/partner). + +/// + +/// details | Can I install more than one operating system on my VPS? + +OVHcloud installation templates only allow for one operating system. +Custom configurations can be applied from the customer's side and are the responsibility of the server's administrator. OVHcloud services do not include administration tasks, such as software configuration or external tools. + +If you encounter configuration and administration issues, we recommend reaching out to our [community](/links/community) or seeking the help of a qualified system administrator or developer via our [partner portal](/links/partner). + +/// + +/// details | Can I install virtual machines on a VPS by using virtualization software (such as Proxmox)? + +OVHcloud installation templates for VPS do not include the Proxmox Operating System or a similar OS for virtualization. + +Custom configurations can be applied from the customer's side and are the responsibility of the server's administrator. OVHcloud services do not include administration tasks, such as software configuration or using external tools. + +If you encounter configuration and administration issues, we recommend reaching out to our [community](/links/community) or seeking the help of a qualified system administrator or developer via our [partner portal](/links/partner). + +/// + +/// details | Is is possible to choose the hardware for my VPS (GPU, CPU, etc.) or upgrade it? -Yes. A VPS can be partitioned, and organised to suit your requirements. This means you can use it to host several websites or projects, by allocating a private space to each one. You choose the volume of each space, too. To simplify how you do this, you can install a web hosting control panel like Plesk or cPanel. +A VPS cannot be customized or modified at the hardware level. +Select a [VPS model](/links/bare-metal/vps) in the order process that meets you minimum requirements, then you can upgrade it as required. -### Is my VPS backed up? +/// -It is advisable to apply an appropriate backup strategy according to the sensibility of your data. -Visit our [VPS web page](/links/bare-metal/vps-options) to learn more about the available options. +/// details | My VPS is too slow, can I move my VPS to another host? -### How do I secure my VPS? +To resolve performance issues on your VPS, you will need to provide specific test results to our support team. -By default, the VPS is provided "bare", and there is no security configuration applied. For this reason, the first thing you need to do when you receive a VPS is configure security measures for it. -To do this, please refer to our guide on [Securing a VPS](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps). +Note that your VPS must be booted into [rescue mode](/pages/bare_metal_cloud/virtual_private_servers/rescue) to rule out any possible software issues. -### What bandwidth is allocated to my VPS? Is it guaranteed? +Contact our support team by [creating a request in the OVHcloud Help Centre](https://help.ovhcloud.com/csm?id=csm_get_help) so we can provide you with the complete list of tests required for a proper assessment. -The bandwidth listed on our solution pages is guaranteed. It is the minimum amount allocated to you. +/// -### Which SLA is applied to my VPS? +/// details | I ordered a new VPS, can I move the remaining subscription time from my old VPS or have it refunded? -OVHcloud offers a 99.9% SLA across the VPS ranges. +This is generally possible but the process requires a [request to our support team via the OVHcloud Help Centre](https://help.ovhcloud.com/csm?id=csm_get_help). - +Before you proceed, ensure that you have [migrated any data still needed](/pages/bare_metal_cloud/dedicated_servers/migrate_a_server_to_another) to your new service or create backups of your data. -### How can I access my backup storage from an IP address outside my service? +/// + +/// details | Can I move my VPS to a different OVHcloud data centre in a different country? + +It is not possible to migrate a VPS to another data centre. To achieve this, you can perform a [manual migration](/pages/bare_metal_cloud/dedicated_servers/migrate_a_server_to_another): + +- Download your data from the current VPS. +- Order a new VPS. +- Upload your data to the new VPS. +- [Cancel the old VPS](/pages/account_and_service_management/managing_billing_payments_and_services/how_to_cancel_services). + +/// + +/// details | How many Additional IPs can I configure on a VPS? + +A VPS is limited to [16 Additional IP addresses](/links/network/additional-ip). + +Please refer to our guide on [how to configure IP aliasing](/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing) for IP address configuration examples. + +/// + +/// details | Can I add IP blocks to my VPS? + +It is not possible to add IP blocks to a VPS. +You can configure up to [16 Additional IP addresses](/links/network/additional-ip) on a VPS. + +/// + +/// details | Can I change the VPS associated with my license (Plesk, cPanel)? + +Licenses can be moved between servers but there are limitations. + +The best option is to log in to our [API console](/links/api) with your customer account credentials and check if your license can be moved to a different VPS. Find the basics in our guide on [hot to get started with the OVHcloud API](/pages/manage_and_operate/api/first-steps). + +Once connected, use the following calls depending on the software in use: + +**Plesk** + +> [!api] +> +> @api {v1} /license/plesk GET /license/plesk/{serviceName}/canLicenseBeMovedTo +> + +**cPanel** + +> [!api] +> +> @api {v1} /license/cpanel GET /license/cpanel/{serviceName}/canLicenseBeMovedTo +> + +![API license](images/getlicense.png){.thumbnail} + +Enter the parameters as follows: + +- `serviceName`: Enter the internal name of your license (see the section `Licences` in your [OVHcloud Control Panel](/links/manager)). +- `destinationIp`: Enter the IPv4 address of the destination service. + +Click the button `EXECUTE`{.action}. + +If the result is negative (`false`), the reason will be included in the `RESPONSE` field. + +![API license](images/getlicense_response.png){.thumbnail} + +If the destination IP is compatible with your license (`true`), you can use the corresponding call to move it: + +**Plesk** + +> [!api] +> +> @api {v1} /license/plesk POST /license/plesk/{serviceName}/changeIp +> + +**cPanel** + +> [!api] +> +> @api {v1} /license/cpanel POST /license/cpanel/{serviceName}/changeIp +> + +/// + + +## Questions regarding security and backup + +/// details | How do I secure my VPS? + +By default, the VPS is provided with only the selected operating system installed. The VPS administrator is responsible for applying an appropriate security configuration once the VPS is delivered. +To do this, please refer to our guide on [how to secure a VPS](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps). + +/// + +/// details | How can I download my files or a backup of the VPS? + +There are several options available, for example: + +- Download via SFTP: Connect to your VPS with a software client capable of SFTP (for example [FileZilla](/pages/bare_metal_cloud/dedicated_servers/comment-deposer-ou-recuperer-des-donnees-sur-un-serveur-dedie-via-sftp)), then transfer all files in the system's root directory. +- Download via `rsync` (command line tool): Use the command `rsync -avz -e ssh username@vps_ip_address:/ /local_directory/` to download all files and folders from your VPS. +- Download via the option **Automated Backup**: Follow our guide on [how to use automated backups on a VPS](/pages/bare_metal_cloud/virtual_private_servers/using-automated-backups-on-a-vps) to download files from a backup. +- Download via the option **Snapshot**: Follow our guide on [how to use snapshots on a VPS](/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps) to download a VPS snapshot. + +/// + +/// details | How can I download my VPS as a VM file? + +It is not possible to download a VM file of a OVHcloud VPS. However, you can utilize the VPS option **Snapshot** in your OVHcloud Control Panel to retrieve an image file. + +Follow our guide on [how to use snapshots on a VPS](/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps) to create and download a VPS snapshot. + +You can then locally convert the downloaded snapshot file into a format corresponding to your needs. + +Consider reaching out to one of our [partners](/links/partner) for further assistance. + +/// + +/// details | How can I access my backup storage from an IP address outside my service? Access to the backup storage of your VPS (FTP storage) might be restricted to IP addresses linked to a service within your OVHcloud customer acccount. @@ -119,6 +420,38 @@ To verify that your IP address is authorized, use the following call: > @api {v1} /vps GET /vps/{serviceName}/backupftp/access > +/// + + +/// details | Is my VPS protected from external attacks? + +Although OVHcloud applies security measures to protect the entire infrastructure, the administrator of a VPS is responsible for the security of the applications and data hosted on it. + +- Follow our guide on [how to configure the OVHcloud Edge Network Firewall](/pages/bare_metal_cloud/dedicated_servers/firewall_network) which is integrated in our Anti-DDoS infrastructure, limiting the exposure of your services to DDoS attacks. +- In addition, you can use our guides on [how to configure your own firewall](/pages/bare_metal_cloud/virtual_private_servers/firewall-Linux-iptable) with `iptables` on Linux-based distributions and [how to enable the firewall on Windows](/pages/bare_metal_cloud/virtual_private_servers/activate-port-firewall-soft-win). +- For Linux-based distributions on a VPS, you can follow the instructions in our guide on [how to secure a VPS](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps) to apply additional security measures. + +/// + +/// details | How do I secure my VPS against DDoS attacks? + +OVHcloud provides several security features to protect your VPS against malicious traffic: + +- Anti-DDoS protection: Our VPS services are protected by default by our [Anti-DDoS infrastructure](/links/security/antiddos) that detects and mitigates DDoS attacks in real time. +- IP blocking: You can [prevent specific IP addresses or IP ranges](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps) from reaching your VPS. +- Firewall rules: You can [configure custom firewall rules](/pages/bare_metal_cloud/dedicated_servers/firewall_network) to control incoming and outgoing traffic directly on your VPS. +- VAC (VPS Anti-DDoS): Our VAC system provides an additional layer of protection against DDoS attacks, including traffic filtering and rate limiting. + +/// + +/// details | I want to use a VPS as a game server, will it benefit from the same firewall that protects Game Dedicated Servers? + +The OVHcloud Game DDoS Protection is only available for our Game Dedicated Servers. If you order a VPS for game hosting, you will need to configure the firewall directly on your system, tailored to the desired game. You can find further information in our guide on [how to configure the firewall on Linux with iptables](/pages/bare_metal_cloud/virtual_private_servers/firewall-Linux-iptable). + +The advantage of a VPS compared to a dedicated server is the possibility to scale its resources according your actual usage. You can upgrade your VPS with only a few clicks to benefit from a more capable system. + +/// + ## Go further If you would like assistance using and configuring your OVHcloud solutions, please refer to our [support offers](/links/support). diff --git a/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.en-ie.md b/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.en-ie.md deleted file mode 100755 index 48c051d169b..00000000000 --- a/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.en-ie.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -title: FAQ VPS OVHcloud -updated: 2025-08-07 ---- - -## FAQ VPS - -### What is a VPS, and what is it used for? - -A virtual private server (VPS) is used for hosting websites (e-commerce, content, visual media) and software applications (portals, extranets, collaborative solutions, wikis, CRM). Unlike shared hosting, the data is isolated onto a virtual machine which is dedicated to the user. - -The VPS is a perfect compromise between web hosting plans and physical servers, combining reliability with the high performance of a dedicated server — but without the difficulty of managing a server's physical hardware. - -### How do I choose between a VPS and a web hosting plan? - -Using a VPS is the next logical step up from using a web hosting plan. Virtual private servers offer a wider range of options, and more flexibility in terms of configuration, access and features (root access, Apache PHP.init). You can also install an SSL certificate and any other software you want. - -However, we would like to emphasize the importance of choosing the right VPS for you. A VPS needs to be configured in a way that suits your application requirements, and the growth of your business. - -### What are the advantages of a VPS, compared to a dedicated server? - -The advantage of a VPS is that you don’t have to worry about hardware management — so you would not need to monitor the status of disks, RAM, and CPU. They are adapted to host most types of web projects that are moderately sized. -We recommend using a dedicated server if you want to manage the hardware aspects yourself, build more elaborate architectures, create an infrastructure that includes a private network (vRack), and deploy other complex solutions that are not web services. - -As a general rule, users with a growing volume of web activity either move up to dedicated servers, or Public Cloud solutions. These services offer more complex, flexible infrastructures that can adapt to a high level of growth. - -### What are the differences between VPS and Public Cloud solutions? - -A VPS is a solution adapted for pre-production and production environments that don’t need constant performance. -The OVHcloud Public Cloud offers a multi-server infrastructure, with high availability for servers. vRack, a private network service, is also available with this service. - -### How do I choose my OVHcloud VPS? - -To choose a VPS adapted to your needs, please check the following: - -- The quantity of resources required (processor, memory, disk space, bandwidth, etc.) -- The operating system required (Linux or Windows) -- The technical requirements that are essential for the application to work properly (for example: a database's read/write speed requirement) - -This will help you make the right choice from our VPS solutions: - -- **VPS Starter**: Entry-level server to test our solution (with a Linux distribution only). -- **VPS Value, Essential and Comfort**: Ideal for hosting websites, e-commerce services or monitoring systems. -- **VPS Elite**: Adapted for e-commerce websites and applications that require more CPU and memory resources. -- **VPS Limited Edition** (Limited quantities): This VPS solution offers increased performance, which is a major advantage when it comes to hosting complex websites, resource-intensive applications, and even game servers. This offer is limited and only valid until stocks run out. - -> [!primary] -> You can upgrade a Limited Edition VPS to another VPS from the same range, but for technical reasons, you cannot upgrade a Limited Edition VPS to a VPS from another range (Starter, Value, Essential or Comfort). - -### Who can use a VPS? - -Using a VPS requires basic knowledge of server administration. It is essential for managing the operating system (Linux or Windows) installed on the machine, and configuring the applications. Think you might need a VPS, but don’t have the technical knowledge required? We recommend getting in touch with one of our [partners](/links/partner). - -If you would like to get guaranteed resources but don't know how to manage servers, we would recommend [Performance web hosting plans](/links/web/hosting-performance-offer). - -### How do I connect to my VPS? - -You can log in to your VPS remotely, using the credentials provided by email after the service delivery. -The connection method depends on which operating systems are in use. - -All the details are set out in our guide on [how to get started with a VPS](/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps). - -### Can I host several websites on a VPS? - -Yes. A VPS can be partitioned, and organised to suit your requirements. This means you can use it to host several websites or projects, by allocating a private space to each one. You choose the volume of each space, too. To simplify how you do this, you can install a web hosting control panel like Plesk or cPanel. - -### Is my VPS backed up? - -It is advisable to apply an appropriate backup strategy according to the sensibility of your data. -Visit our [VPS web page](/links/bare-metal/vps-options) to learn more about the available options. - -### How do I secure my VPS? - -By default, the VPS is provided "bare", and there is no security configuration applied. For this reason, the first thing you need to do when you receive a VPS is configure security measures for it. -To do this, please refer to our guide on [Securing a VPS](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps). - -### What bandwidth is allocated to my VPS? Is it guaranteed? - -The bandwidth listed on our solution pages is guaranteed. It is the minimum amount allocated to you. - -### Which SLA is applied to my VPS? - -OVHcloud offers a 99.9% SLA across the VPS ranges. - - - -### How can I access my backup storage from an IP address outside my service? - -Access to the backup storage of your VPS (FTP storage) might be restricted to IP addresses linked to a service within your OVHcloud customer acccount. - -In order to add other IP addresses from which to access, you can use the OVHcloud API. -This will allow you to retrieve your backup data from a different service through various protocols (FTP, NFS, CIFS). - -> [!warning] -> Only OVHcloud IP addresses can be authorized. -> - -Log in to the [OVHcloud API console](/links/api) with your customer account credentials and use the following call: - -> [!api] -> -> @api {v1} /vps POST /vps/{serviceName}/backupftp/access -> - -Edit the parameters as follows: - -- `serviceName`: Enter the internal name of your VPS (`vps-x11x11xyy.vps.ovh.net`). -- `cifs`: Set to `true` if applicable. -- `ftp`: Set to `true` if applicable. -- `ipBlock`: Enter the IP address that will have access, in the form `203.0.113.100/32`. -- `nfs`: Set to `true` if applicable. - -Click the button `EXECUTE`{.action}. - -To verify that your IP address is authorized, use the following call: - -> [!api] -> -> @api {v1} /vps GET /vps/{serviceName}/backupftp/access -> - -## Go further - -If you would like assistance using and configuring your OVHcloud solutions, please refer to our [support offers](/links/support). - -Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.en-sg.md b/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.en-sg.md deleted file mode 100755 index 48c051d169b..00000000000 --- a/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.en-sg.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -title: FAQ VPS OVHcloud -updated: 2025-08-07 ---- - -## FAQ VPS - -### What is a VPS, and what is it used for? - -A virtual private server (VPS) is used for hosting websites (e-commerce, content, visual media) and software applications (portals, extranets, collaborative solutions, wikis, CRM). Unlike shared hosting, the data is isolated onto a virtual machine which is dedicated to the user. - -The VPS is a perfect compromise between web hosting plans and physical servers, combining reliability with the high performance of a dedicated server — but without the difficulty of managing a server's physical hardware. - -### How do I choose between a VPS and a web hosting plan? - -Using a VPS is the next logical step up from using a web hosting plan. Virtual private servers offer a wider range of options, and more flexibility in terms of configuration, access and features (root access, Apache PHP.init). You can also install an SSL certificate and any other software you want. - -However, we would like to emphasize the importance of choosing the right VPS for you. A VPS needs to be configured in a way that suits your application requirements, and the growth of your business. - -### What are the advantages of a VPS, compared to a dedicated server? - -The advantage of a VPS is that you don’t have to worry about hardware management — so you would not need to monitor the status of disks, RAM, and CPU. They are adapted to host most types of web projects that are moderately sized. -We recommend using a dedicated server if you want to manage the hardware aspects yourself, build more elaborate architectures, create an infrastructure that includes a private network (vRack), and deploy other complex solutions that are not web services. - -As a general rule, users with a growing volume of web activity either move up to dedicated servers, or Public Cloud solutions. These services offer more complex, flexible infrastructures that can adapt to a high level of growth. - -### What are the differences between VPS and Public Cloud solutions? - -A VPS is a solution adapted for pre-production and production environments that don’t need constant performance. -The OVHcloud Public Cloud offers a multi-server infrastructure, with high availability for servers. vRack, a private network service, is also available with this service. - -### How do I choose my OVHcloud VPS? - -To choose a VPS adapted to your needs, please check the following: - -- The quantity of resources required (processor, memory, disk space, bandwidth, etc.) -- The operating system required (Linux or Windows) -- The technical requirements that are essential for the application to work properly (for example: a database's read/write speed requirement) - -This will help you make the right choice from our VPS solutions: - -- **VPS Starter**: Entry-level server to test our solution (with a Linux distribution only). -- **VPS Value, Essential and Comfort**: Ideal for hosting websites, e-commerce services or monitoring systems. -- **VPS Elite**: Adapted for e-commerce websites and applications that require more CPU and memory resources. -- **VPS Limited Edition** (Limited quantities): This VPS solution offers increased performance, which is a major advantage when it comes to hosting complex websites, resource-intensive applications, and even game servers. This offer is limited and only valid until stocks run out. - -> [!primary] -> You can upgrade a Limited Edition VPS to another VPS from the same range, but for technical reasons, you cannot upgrade a Limited Edition VPS to a VPS from another range (Starter, Value, Essential or Comfort). - -### Who can use a VPS? - -Using a VPS requires basic knowledge of server administration. It is essential for managing the operating system (Linux or Windows) installed on the machine, and configuring the applications. Think you might need a VPS, but don’t have the technical knowledge required? We recommend getting in touch with one of our [partners](/links/partner). - -If you would like to get guaranteed resources but don't know how to manage servers, we would recommend [Performance web hosting plans](/links/web/hosting-performance-offer). - -### How do I connect to my VPS? - -You can log in to your VPS remotely, using the credentials provided by email after the service delivery. -The connection method depends on which operating systems are in use. - -All the details are set out in our guide on [how to get started with a VPS](/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps). - -### Can I host several websites on a VPS? - -Yes. A VPS can be partitioned, and organised to suit your requirements. This means you can use it to host several websites or projects, by allocating a private space to each one. You choose the volume of each space, too. To simplify how you do this, you can install a web hosting control panel like Plesk or cPanel. - -### Is my VPS backed up? - -It is advisable to apply an appropriate backup strategy according to the sensibility of your data. -Visit our [VPS web page](/links/bare-metal/vps-options) to learn more about the available options. - -### How do I secure my VPS? - -By default, the VPS is provided "bare", and there is no security configuration applied. For this reason, the first thing you need to do when you receive a VPS is configure security measures for it. -To do this, please refer to our guide on [Securing a VPS](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps). - -### What bandwidth is allocated to my VPS? Is it guaranteed? - -The bandwidth listed on our solution pages is guaranteed. It is the minimum amount allocated to you. - -### Which SLA is applied to my VPS? - -OVHcloud offers a 99.9% SLA across the VPS ranges. - - - -### How can I access my backup storage from an IP address outside my service? - -Access to the backup storage of your VPS (FTP storage) might be restricted to IP addresses linked to a service within your OVHcloud customer acccount. - -In order to add other IP addresses from which to access, you can use the OVHcloud API. -This will allow you to retrieve your backup data from a different service through various protocols (FTP, NFS, CIFS). - -> [!warning] -> Only OVHcloud IP addresses can be authorized. -> - -Log in to the [OVHcloud API console](/links/api) with your customer account credentials and use the following call: - -> [!api] -> -> @api {v1} /vps POST /vps/{serviceName}/backupftp/access -> - -Edit the parameters as follows: - -- `serviceName`: Enter the internal name of your VPS (`vps-x11x11xyy.vps.ovh.net`). -- `cifs`: Set to `true` if applicable. -- `ftp`: Set to `true` if applicable. -- `ipBlock`: Enter the IP address that will have access, in the form `203.0.113.100/32`. -- `nfs`: Set to `true` if applicable. - -Click the button `EXECUTE`{.action}. - -To verify that your IP address is authorized, use the following call: - -> [!api] -> -> @api {v1} /vps GET /vps/{serviceName}/backupftp/access -> - -## Go further - -If you would like assistance using and configuring your OVHcloud solutions, please refer to our [support offers](/links/support). - -Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.en-us.md b/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.en-us.md deleted file mode 100755 index 48c051d169b..00000000000 --- a/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.en-us.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -title: FAQ VPS OVHcloud -updated: 2025-08-07 ---- - -## FAQ VPS - -### What is a VPS, and what is it used for? - -A virtual private server (VPS) is used for hosting websites (e-commerce, content, visual media) and software applications (portals, extranets, collaborative solutions, wikis, CRM). Unlike shared hosting, the data is isolated onto a virtual machine which is dedicated to the user. - -The VPS is a perfect compromise between web hosting plans and physical servers, combining reliability with the high performance of a dedicated server — but without the difficulty of managing a server's physical hardware. - -### How do I choose between a VPS and a web hosting plan? - -Using a VPS is the next logical step up from using a web hosting plan. Virtual private servers offer a wider range of options, and more flexibility in terms of configuration, access and features (root access, Apache PHP.init). You can also install an SSL certificate and any other software you want. - -However, we would like to emphasize the importance of choosing the right VPS for you. A VPS needs to be configured in a way that suits your application requirements, and the growth of your business. - -### What are the advantages of a VPS, compared to a dedicated server? - -The advantage of a VPS is that you don’t have to worry about hardware management — so you would not need to monitor the status of disks, RAM, and CPU. They are adapted to host most types of web projects that are moderately sized. -We recommend using a dedicated server if you want to manage the hardware aspects yourself, build more elaborate architectures, create an infrastructure that includes a private network (vRack), and deploy other complex solutions that are not web services. - -As a general rule, users with a growing volume of web activity either move up to dedicated servers, or Public Cloud solutions. These services offer more complex, flexible infrastructures that can adapt to a high level of growth. - -### What are the differences between VPS and Public Cloud solutions? - -A VPS is a solution adapted for pre-production and production environments that don’t need constant performance. -The OVHcloud Public Cloud offers a multi-server infrastructure, with high availability for servers. vRack, a private network service, is also available with this service. - -### How do I choose my OVHcloud VPS? - -To choose a VPS adapted to your needs, please check the following: - -- The quantity of resources required (processor, memory, disk space, bandwidth, etc.) -- The operating system required (Linux or Windows) -- The technical requirements that are essential for the application to work properly (for example: a database's read/write speed requirement) - -This will help you make the right choice from our VPS solutions: - -- **VPS Starter**: Entry-level server to test our solution (with a Linux distribution only). -- **VPS Value, Essential and Comfort**: Ideal for hosting websites, e-commerce services or monitoring systems. -- **VPS Elite**: Adapted for e-commerce websites and applications that require more CPU and memory resources. -- **VPS Limited Edition** (Limited quantities): This VPS solution offers increased performance, which is a major advantage when it comes to hosting complex websites, resource-intensive applications, and even game servers. This offer is limited and only valid until stocks run out. - -> [!primary] -> You can upgrade a Limited Edition VPS to another VPS from the same range, but for technical reasons, you cannot upgrade a Limited Edition VPS to a VPS from another range (Starter, Value, Essential or Comfort). - -### Who can use a VPS? - -Using a VPS requires basic knowledge of server administration. It is essential for managing the operating system (Linux or Windows) installed on the machine, and configuring the applications. Think you might need a VPS, but don’t have the technical knowledge required? We recommend getting in touch with one of our [partners](/links/partner). - -If you would like to get guaranteed resources but don't know how to manage servers, we would recommend [Performance web hosting plans](/links/web/hosting-performance-offer). - -### How do I connect to my VPS? - -You can log in to your VPS remotely, using the credentials provided by email after the service delivery. -The connection method depends on which operating systems are in use. - -All the details are set out in our guide on [how to get started with a VPS](/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps). - -### Can I host several websites on a VPS? - -Yes. A VPS can be partitioned, and organised to suit your requirements. This means you can use it to host several websites or projects, by allocating a private space to each one. You choose the volume of each space, too. To simplify how you do this, you can install a web hosting control panel like Plesk or cPanel. - -### Is my VPS backed up? - -It is advisable to apply an appropriate backup strategy according to the sensibility of your data. -Visit our [VPS web page](/links/bare-metal/vps-options) to learn more about the available options. - -### How do I secure my VPS? - -By default, the VPS is provided "bare", and there is no security configuration applied. For this reason, the first thing you need to do when you receive a VPS is configure security measures for it. -To do this, please refer to our guide on [Securing a VPS](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps). - -### What bandwidth is allocated to my VPS? Is it guaranteed? - -The bandwidth listed on our solution pages is guaranteed. It is the minimum amount allocated to you. - -### Which SLA is applied to my VPS? - -OVHcloud offers a 99.9% SLA across the VPS ranges. - - - -### How can I access my backup storage from an IP address outside my service? - -Access to the backup storage of your VPS (FTP storage) might be restricted to IP addresses linked to a service within your OVHcloud customer acccount. - -In order to add other IP addresses from which to access, you can use the OVHcloud API. -This will allow you to retrieve your backup data from a different service through various protocols (FTP, NFS, CIFS). - -> [!warning] -> Only OVHcloud IP addresses can be authorized. -> - -Log in to the [OVHcloud API console](/links/api) with your customer account credentials and use the following call: - -> [!api] -> -> @api {v1} /vps POST /vps/{serviceName}/backupftp/access -> - -Edit the parameters as follows: - -- `serviceName`: Enter the internal name of your VPS (`vps-x11x11xyy.vps.ovh.net`). -- `cifs`: Set to `true` if applicable. -- `ftp`: Set to `true` if applicable. -- `ipBlock`: Enter the IP address that will have access, in the form `203.0.113.100/32`. -- `nfs`: Set to `true` if applicable. - -Click the button `EXECUTE`{.action}. - -To verify that your IP address is authorized, use the following call: - -> [!api] -> -> @api {v1} /vps GET /vps/{serviceName}/backupftp/access -> - -## Go further - -If you would like assistance using and configuring your OVHcloud solutions, please refer to our [support offers](/links/support). - -Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.es-es.md b/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.es-es.md index 73d7cd44291..d07c44e48e9 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.es-es.md +++ b/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.es-es.md @@ -1,125 +1,461 @@ --- -title: FAQ VPS OVHcloud -updated: 2025-08-07 +title: "OVHcloud VPS FAQ" +excerpt: "Encuentre las respuestas a las preguntas más frecuentes sobre nuestras ofertas de VPS" +updated: 2025-10-30 --- -## FAQ VPS + -## ¿Qué es un VPS y para qué sirve? +## Preguntas generales sobre las ofertas de VPS -Un servidor privado virtual (VPS) permite alojar sitios web (sitio corporativo, e-commerce, contenidos, multimedia) y aplicaciones de software (portales, Extranet, soluciones colaborativas, wikis, CRM). A diferencia del alojamiento compartido, los datos están aislados en una máquina virtual dedicada al usuario. +/// details | ¿Qué es un VPS y para qué se utiliza? -Los VPS, situados estratégicamente entre un alojamiento web y un servidor físico, combinan la fiabilidad y el rendimiento de un servidor dedicado sin tener que gestionar las cargas de hardware. +Un servidor privado virtual (VPS) se utiliza para alojar sitios web (comercio electrónico, contenido, medios visuales) y aplicaciones de software (portales, extranets, soluciones colaborativas, wikis, CRM). A diferencia del alojamiento compartido, un VPS ofrece un entorno aislado, dedicado al cliente. Nuestras soluciones de VPS cubren la brecha entre el alojamiento web compartido y los servidores dedicados, combinando rendimiento y fiabilidad sin la carga de la gestión de hardware. También puede actualizar fácilmente su configuración sin cambiar de servidores. -## ¿Qué elegir entre un VPS y un alojamiento web? +/// -La utilización de un VPS se inscribe en la continuidad lógica de la de un alojamiento web. Los servidores privados virtuales ofrecen más posibilidades y mayor libertad de acción en cuanto a la configuración, el acceso y las funcionalidades (root, Apache PHP.init). También puede instalar un certificado SSL o cualquier otro programa de software que desee. +/// details | ¿Cuáles son las ventajas de un VPS de OVHcloud? -No obstante, tenga en cuenta la necesidad de seleccionar correctamente su VPS. ya que requiere una configuración acorde a las necesidades de las aplicaciones y una adaptación al crecimiento de su actividad. +Las ofertas de VPS de OVHcloud ofrecen un excelente rendimiento por precio, con tráfico ilimitado y varias ubicaciones globales para baja latencia y mayor accesibilidad, según sus necesidades. -## ¿Qué ventajas tiene un VPS con respecto a un servidor dedicado? +/// -La ventaja de los VPS es que permiten liberarse de la gestión del hardware, como el seguimiento del estado de los discos duros, la memoria RAM y la CPU. Son adecuados para la mayoría de los usos web, para proyectos cuyo tamaño sea controlado. -El uso de un servidor dedicado está recomendado para gestionar usted mismo la parte del hardware, construir arquitecturas más elaboradas, crear una infraestructura que incluya una red privada (vRack) o desplegar soluciones complejas que no sean servicios web. +/// details | ¿Es la solución VPS la adecuada para mí? -Por regla general, los usuarios y usuarios que desarrollan su actividad web evolucionan hacia servidores dedicados o soluciones de Public Cloud. Estos servicios ofrecen infraestructuras más complejas y flexibles, adaptadas a un crecimiento fuerte. +El uso de un VPS requiere conocimientos básicos de administración de servidores. Es crucial tener esto en cuenta para gestionar eficazmente su sistema operativo (Linux o Windows) y configurar sus aplicaciones, como por ejemplo PrestaShop o WordPress. -## ¿Qué diferencia hay entre las soluciones VPS y Public Cloud? +Si necesita un VPS pero carece de la experiencia técnica para administrarlo, considere contactar con uno de nuestros [partners](/links/partner) para recibir ayuda. -El VPS es una solución adaptada a los entornos de preproducción y producción, que no necesitan un rendimiento constante. -El Public Cloud de OVHcloud ofrece una infraestructura multiservidor con alta disponibilidad de las máquinas. Esta solución también incluye una red privada, el vRack. +Si requiere recursos provisionados pero prefiere no ocuparse de la administración del servidor, le recomendamos optar por nuestros planes de alojamiento web Performance. -## ¿Cómo elegir un VPS de OVHcloud? +/// -Para elegir un VPS que se ajuste a sus necesidades, compruebe que: +/// details | ¿Puedo actualizar fácilmente mi VPS a una gama superior o reducir su configuración a una inferior? -- la cantidad de recursos necesarios (procesador, memoria, espacio en disco, ancho de banda...); -- el sistema operativo requerido (Linux o Windows); -- los requisitos técnicos esenciales para el buen funcionamiento de la aplicación (por ejemplo, una base de datos requiere velocidad de lectura-escritura). +Sí, puede actualizar su configuración desde el área de cliente de OVHcloud, sin migrar manualmente sus datos. Las opciones de actualización disponibles dependen de la gama y el modelo del VPS. -Esto le permitirá elegir entre nuestras soluciones de VPS: +Sin embargo, para reducir su configuración, deberá suscribirse a un nuevo plan, transferir sus datos y luego cancelar su servicio anterior. Nuestro equipo de soporte está disponible para ayudarle si es necesario. -- **VPS Starter**: máquina de entrada para probar nuestra solución (solo con una distribución Linux). -- **VPS Value, Essential y Comfort**: ideales para el alojamiento de sitios web, servicios de e-commerce o sistemas de monitorización; -- **VPS Elite**: adecuado para portales de e-commerce y aplicaciones que requieren más recursos de CPU y memoria. -- **VPS Limited Edition** (cantidad limitada): estos VPS ofrecen un rendimiento mejorado, una gran ventaja para alojar sitios web complejos, aplicaciones que consumen muchos recursos o incluso servidores de juego. Esta oferta es válida hasta agotar stock. +/// -> [!primary] -> Es posible pasar de un VPS Limited Edition a otro VPS de la misma gama, pero, por motivos técnicos, no es posible pasar de un VPS Limited Edition a un VPS de otra gama (Starter, Value, Essential o Comfort). +/// details | ¿Qué región o país debería elegir para mi VPS? -### ¿Quién puede utilizar un VPS? +Cuanto más cerca esté su centro de datos de su audiencia, menor será la latencia, lo que se traduce en una mejor experiencia del usuario y mayor confianza en sus servicios. -Para gestionar un VPS, es necesario tener conocimientos básicos de administración de servidores. Estos conocimientos son esenciales para gestionar el sistema operativo (Linux o Windows) instalado en la máquina y configurar las aplicaciones. ¿Cree que necesita un VPS, pero considera que no dispone de los conocimientos necesarios? Le invitamos a que se ponga en contacto con uno de nuestros [partners](/links/partner). +/// -Si desea disfrutar de recursos garantizados sin tener conocimientos de administración de servidores, le recomendamos nuestros [planes de hosting Performance](/links/web/hosting-performance-offer). +/// details | ¿Cuál es la ventaja de un VPS ubicado en Europa? -## ¿Cómo conectarme a mi VPS? +Alojar su VPS en Francia o, en general, dentro de la UE con OVHcloud ofrece ventajas como precios competitivos y protección reforzada de los datos. Su servicio no está sujeto al Acta CLOUD de EE. UU., protegiéndolo de interferencias no europeas. -Puede conectarse a distancia a su VPS con las claves que le facilitemos por correo electrónico tras la entrega del servicio. -El método de conexión depende de los sistemas operativos utilizados. +/// -En la guía ["Primeros pasos con un VPS"](/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps) encontrará todos los detalles. +/// details | ¿Incluyen copias de seguridad mis VPS? -## ¿Es posible alojar varios sitios web en un VPS? +Sí, al encargar un VPS, se incluye una opción de copia de seguridad diaria de forma gratuita. -Sí. Un VPS puede particionarse y organizarse en función de sus necesidades. De este modo, puede alojar varios sitios web o proyectos, asignando a cada uno de ellos un espacio privado cuyo volumen elija. Para simplificar estas operaciones, puede instalar un panel de control de sitios web, como Plesk o cPanel. +Para una protección aún mayor, también puede optar por nuestra opción de copia de seguridad Premium. Ofrece: -### ¿Se guarda un VPS? +- La posibilidad de revertir a una copia de seguridad de hasta una semana anterior. +- La posibilidad de programar copias de seguridad, optimizando la gestión de datos y minimizando el impacto en las operaciones comerciales. -Es recomendable aplicar una estrategia de backup adecuada en función de la sensibilidad de sus datos. -Visite nuestra [página web del VPS](/links/bare-metal/vps-options) para saber más sobre las opciones disponibles. +Además, ofrecemos: -## ¿Cómo proteger mi VPS? +- Instantáneas: Puede crear instantáneas manuales e inmediatas que capturan el estado exacto de su VPS justo antes de una actualización o cambio crítico. +- Una copia de seguridad externa: Almacene sus datos en un disco separado y seguro, permitiendo una recuperación fácil en caso de un incidente grave. -Por defecto, el VPS se entrega "desnudo", por lo que no incluye ninguna configuración de seguridad. Es lo primero que tienes que hacer en la recepción. -Para ello, no dude en consultar la guía ["Proteger un VPS"](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps). +Al utilizar estas soluciones, puede personalizar su gestión de copias de seguridad para adaptarla a sus necesidades de seguridad y continuidad empresarial. -### ¿Cuál es el ancho de banda asignado a mi VPS? ¿Está garantizada? +Visite nuestra [página web de VPS](/links/bare-metal/vps) para obtener más información sobre las opciones disponibles. -El ancho de banda que aparece en la página de nuestros productos está garantizado. Es la tasa de transferencia mínima que se le ha asignado. +/// -### ¿Qué SLA se aplica a mi VPS? +/// details | ¿Puedo alojar varios sitios web en un VPS? -En todas las gamas de VPS, OVHcloud ofrece un SLA del 99,9%. +Sí, un VPS puede configurarse para alojar múltiples sitios web o proyectos. Puede particionar su espacio de almacenamiento según sus necesidades y utilizar interfaces especializadas como Plesk o cPanel para simplificar la gestión de sus sitios web. -### ¿Cómo acceder al Backup Storage desde una dirección IP distinta de mi servicio? +/// -El acceso al backup FTP puede restringirse al servicio al que esté asociado desde el área de cliente de OVHcloud. +/// details | ¿Recibiré un nombre de dominio y un servicio de correo electrónico incluido con mi VPS? -Para autorizar direcciones IP adicionales desde las que quiere acceder a su Backup Storage, puede utilizar la API de OVHcloud. -Esto le permitirá recuperar sus copias de seguridad de datos desde un servicio diferente a través de diferentes protocolos (FTP, NFS, CIFS). +No, nuestras soluciones de VPS no incluyen un nombre de dominio ni un servicio de correo electrónico. Estos servicios se pueden encargar por separado en el área de cliente de OVHcloud. + +/// + +/// details | ¿Cómo elijo entre un VPS y un plan de alojamiento web? + +**Plan de alojamiento web** + +- Ideal para necesidades básicas de alojamiento con una configuración preestablecida. + +**VPS** + +- Mayor flexibilidad y control, perfecto para proyectos escalables con necesidades de configuración complejas. + +Alojar servicios web en un VPS le permite instalar su software preferido, personalizar la configuración del servidor y alojar múltiples sitios web con recursos dedicados. Tenga en cuenta que un VPS debe configurarse de manera que se adapte a los requisitos de su aplicación y a su crecimiento empresarial. + +/// + +/// details | ¿Cuál es la diferencia entre un VPS y las soluciones de Public Cloud? + +**VPS** + +- Una máquina virtual optimizada y dedicada adecuada tanto para preproducción como para producción, diseñada para alojar varios proyectos web. + +**Public Cloud de OVHcloud** + +- Ofrece una infraestructura multi-servidor con alta disponibilidad y una red privada (vRack), y está diseñada para arquitecturas complejas y escalables. + +/// + +/// details | ¿Cuáles son las ventajas de un VPS en comparación con un servidor dedicado? + +**VPS** + +- Ofrece una gestión simplificada sin mantenimiento de hardware, ideal para proyectos que necesitan un control ajustado. + +**Servidor dedicado** + +- Recomendado para infraestructuras complejas que requieren un control completo del hardware y un rendimiento garantizado. + +Un VPS elimina la necesidad de gestionar hardware físico como el almacenamiento, la RAM y el CPU, lo que lo hace adecuado para la mayoría de las aplicaciones web. A medida que su negocio crece, puede actualizar su VPS o migrar a un servidor dedicado o a una solución de Public Cloud para una infraestructura más flexible y potente. + +/// + +/// details | ¿Qué ancho de banda se asigna a mi VPS? ¿Está garantizado? + +El ancho de banda que aparece en nuestra [página web de VPS](/links/bare-metal/vps) está garantizado. Es la cantidad mínima asignada a su servicio. + +/// + +/// details | ¿Qué SLA se aplica a mi VPS? + +Un VPS de OVHcloud incluye un SLA del 99,9%. + +/// + + +/// details | ¿Cuáles son las características únicas de un VPS de Zona Local? + +Con un VPS de Zona Local, puede reducir significativamente los tiempos de acceso a sus sitios y aplicaciones, ya que sus datos están alojados más cerca de sus usuarios. Esto crea una mejor experiencia del usuario al reducir la latencia cada vez que las aplicaciones requieren un tiempo de respuesta mínimo. Simplemente seleccione una de nuestras ubicaciones mundiales al realizar el pedido. + +Tenga en cuenta que un VPS de Zona Local, a diferencia de un VPS normal, no incluye características de seguridad como Anti-DDoS, ni opciones avanzadas como IP adicional y Balanceador de carga. + +Un VPS de Zona Local también cumple con las necesidades de proyectos con requisitos de residencia y soberanía de datos. Al alojar sus servicios en una región específica, puede cumplir fácilmente con las regulaciones locales relacionadas con el procesamiento y almacenamiento de datos, como el GDPR europeo. + +/// + +/// details | ¿Puedo migrar mi VPS de una Zona Local a un centro de datos, y viceversa? + +No, no puede migrar servicios directamente. Deberá suscribirse al VPS elegido, transferir sus datos y luego cancelar su servicio anterior. Nuestro equipo de soporte puede guiarle a través de estos pasos si es necesario. + +/// + +/// details | ¿Cuáles son los riesgos de utilizar un VPS sin protección contra DDoS? + +Los servidores privados virtuales sin protección anti-DDoS están expuestos automáticamente a ataques de denegación de servicio distribuidos (DDoS), lo que puede provocar interrupciones del servicio y brechas de seguridad graves. + +- Exposición directa: Si su servidor es objetivo de un ataque DDoS, el flujo de solicitudes maliciosas puede abrumarlo, haciendo que sus sitios y aplicaciones se vuelvan inaccesibles. +- No hay mitigación automática: Para proteger su servidor, deberá defenderse de los ataques utilizando software de seguridad de terceros o configuraciones específicas. +- Mayor carga de gestión: La falta de seguridad robusta integrada presenta un riesgo importante, destacando la necesidad de un monitoreo vigilante y estrategias proactivas, especialmente para proyectos con alto tráfico. + +Si la resiliencia frente a ataques DDoS es un factor crítico para su proyecto, le recomendamos optar por un VPS de OVHcloud alojado en uno de nuestros centros de datos, que incluye protección integrada. + +/// + + +## Preguntas relacionadas con la administración de VPS + +/// details | ¿Cómo me conecto a mi VPS? + +Puede iniciar sesión en su VPS de forma remota, utilizando las credenciales proporcionadas por correo electrónico tras la entrega del servicio. +El método de conexión depende de los sistemas operativos que se utilicen. + +Todos los detalles se detallan en nuestra guía sobre [cómo empezar con un VPS](/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps). + +/// + +/// details | ¿Proporciona OVHcloud asistencia para la configuración de software en mi VPS? + +Aunque no podemos ofrecer asistencia para la configuración o administración de software, sí proporcionamos algunas herramientas y recursos para ayudarte a comenzar. + +Por ejemplo, ofrecemos una gama de plantillas y imágenes preconfiguradas para sistemas operativos y aplicaciones populares para ayudarte a desplegar rápidamente tu VPS. También proporcionamos el área de cliente de OVHcloud, donde puedes gestionar tu VPS, incluyendo tareas como reiniciar, reinstalar y supervisar recursos. + +Además, nuestra documentación y base de conocimientos contienen una gran cantidad de información sobre la configuración y gestión de tu VPS. + +Sin embargo, para asistencia específica en la configuración de software, te recomendamos contactar con nuestra [comunidad](/links/community) o buscar la ayuda de un administrador de sistemas o desarrollador cualificado a través de nuestro [portal de socios](/links/partner). + +/// + +/// details | ¿Puedo instalar más de un sistema operativo en mi VPS? + +Las plantillas de instalación de OVHcloud solo permiten un sistema operativo. +Las configuraciones personalizadas pueden aplicarse desde el lado del cliente y son responsabilidad del administrador del servidor. Los servicios de OVHcloud no incluyen tareas de administración, como la configuración de software o el uso de herramientas externas. + +Si tienes problemas de configuración y administración, te recomendamos contactar con nuestra [comunidad](/links/community) o buscar la ayuda de un administrador de sistemas o desarrollador cualificado a través de nuestro [portal de socios](/links/partner). + +/// + +/// details | ¿Puedo instalar máquinas virtuales en un VPS utilizando software de virtualización (como Proxmox)? + +Las plantillas de instalación de VPS de OVHcloud no incluyen el Proxmox Operating System ni un sistema operativo similar para virtualización. + +Las configuraciones personalizadas pueden aplicarse desde el lado del cliente y son responsabilidad del administrador del servidor. Los servicios de OVHcloud no incluyen tareas de administración, como la configuración de software o el uso de herramientas externas. + +Si tienes problemas de configuración y administración, te recomendamos contactar con nuestra [comunidad](/links/community) o buscar la ayuda de un administrador de sistemas o desarrollador cualificado a través de nuestro [portal de socios](/links/partner). + +/// + +/// details | ¿Es posible elegir el hardware para mi VPS (GPU, CPU, etc.) o actualizarlo? + +Un VPS no se puede personalizar ni modificar a nivel de hardware. +Selecciona un [modelo de VPS](/links/bare-metal/vps) en el proceso de pedido que cumpla con tus requisitos mínimos, y luego podrás actualizarlo según sea necesario. + +/// + +/// details | Mi VPS es demasiado lento, ¿puedo mover mi VPS a otro host? + +Para resolver problemas de rendimiento en tu VPS, deberás proporcionar resultados de pruebas específicas a nuestro equipo de soporte. + +Ten en cuenta que tu VPS debe arrancarse en [modo de rescate](/pages/bare_metal_cloud/virtual_private_servers/rescue) para descartar cualquier posible problema de software. + +Contacta con nuestro equipo de soporte creando una [solicitud en el Centro de ayuda de OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help) para que podamos proporcionarte la lista completa de pruebas necesarias para una evaluación adecuada. + +/// + + +/// details | He pedido un nuevo VPS, ¿puedo trasladar el tiempo restante de mi antiguo VPS o recibir un reembolso? + +Esto es generalmente posible, pero el proceso requiere una [solicitud a nuestro equipo de soporte a través del Centro de ayuda de OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help). + +Antes de proceder, asegúrate de que hayas [migrado cualquier dato aún necesario](/pages/bare_metal_cloud/dedicated_servers/migrate_a_server_to_another) a tu nuevo servicio o hayas creado copias de seguridad de tus datos. + +/// + +/// details | ¿Puedo mover mi VPS a un centro de datos de OVHcloud diferente en otro país? + +No es posible migrar un VPS a otro centro de datos. Para lograrlo, puedes realizar una [migración manual](/pages/bare_metal_cloud/dedicated_servers/migrate_a_server_to_another): + +- Descarga tus datos del VPS actual. +- Pide un nuevo VPS. +- Sube tus datos al nuevo VPS. +- [Cancela el VPS antiguo](/pages/account_and_service_management/managing_billing_payments_and_services/how_to_cancel_services). + +/// + +/// details | ¿Cuántas IPs adicionales puedo configurar en un VPS? + +Un VPS está limitado a [16 direcciones IP adicionales](/links/network/additional-ip). + +Consulta nuestra guía sobre [cómo configurar alias de IP](/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing) para ejemplos de configuración de direcciones IP. + +/// + +/// details | ¿Puedo añadir bloques de IP a mi VPS? + +No es posible añadir bloques de IP a un VPS. +Puedes configurar hasta [16 direcciones IP adicionales](/links/network/additional-ip) en un VPS. + +/// + +/// details | ¿Puedo cambiar el VPS asociado a mi licencia (Plesk, cPanel)? + +Las licencias pueden moverse entre servidores, pero existen limitaciones. + +La mejor opción es iniciar sesión en nuestra [consola de API](/links/api) con tus credenciales de cuenta de cliente y comprobar si tu licencia puede ser trasladada a un VPS diferente. Encuentra las bases en nuestra guía sobre [cómo empezar con la API de OVHcloud](/pages/manage_and_operate/api/first-steps). + +Una vez conectado, utiliza las siguientes llamadas según el software que uses: + +**Plesk** + +> [!api] +> +> @api {v1} /license/plesk GET /license/plesk/{serviceName}/canLicenseBeMovedTo +> + +**cPanel** + +> [!api] +> +> @api {v1} /license/cpanel GET /license/cpanel/{serviceName}/canLicenseBeMovedTo +> + +![API license](images/getlicense.png){.thumbnail} + +Introduce los parámetros de la siguiente manera: + +- `serviceName`: Introduce el nombre interno de tu licencia (ver la sección `Licencias` en tu [área de cliente de OVHcloud](/links/manager)). +- `destinationIp`: Introduce la dirección IPv4 del servicio de destino. + +Haz clic en el botón `EXECUTE`{.action}. + +Si el resultado es negativo (`false`), la razón se incluirá en el campo `RESPONSE`. + +![API license](images/getlicense_response.png){.thumbnail} + +Si la dirección IP de destino es compatible con tu licencia (`true`), puedes utilizar la llamada correspondiente para moverla: + +**Plesk** + +> [!api] +> +> @api {v1} /license/plesk POST /license/plesk/{serviceName}/changeIp +> + +**cPanel** + +> [!api] +> +> @api {v1} /license/cpanel POST /license/cpanel/{serviceName}/changeIp +> + +/// + + +## Preguntas sobre seguridad y backup + +/// details | ¿Cómo puedo asegurar mi VPS? + +De forma predeterminada, el VPS se entrega con solo el sistema operativo seleccionado instalado. El administrador del VPS es responsable de aplicar una configuración de seguridad adecuada una vez que se entrega el VPS. +Para ello, consulte nuestra guía sobre [cómo asegurar un VPS](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps). + +/// + +/// details | ¿Cómo puedo descargar mis archivos o una copia de seguridad del VPS? + +Hay varias opciones disponibles, por ejemplo: + +- Descarga mediante SFTP: Conéctate a tu VPS con un cliente de software capaz de SFTP (por ejemplo [FileZilla](/pages/bare_metal_cloud/dedicated_servers/comment-deposer-ou-recuperer-des-donnees-sur-un-serveur-dedie-via-sftp)), y luego transfiere todos los archivos en el directorio raíz del sistema. +- Descarga mediante `rsync` (herramienta de línea de comandos): Utiliza el comando `rsync -avz -e ssh username@vps_ip_address:/ /local_directory/` para descargar todos los archivos y carpetas de tu VPS. +- Descarga mediante la opción **Copia de seguridad automática**: Sigue nuestra guía sobre [cómo usar copias de seguridad automáticas en un VPS](/pages/bare_metal_cloud/virtual_private_servers/using-automated-backups-on-a-vps) para descargar archivos desde una copia de seguridad. +- Descarga mediante la opción **Snapshot**: Sigue nuestra guía sobre [cómo usar instantáneas en un VPS](/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps) para descargar una instantánea del VPS. + +/// + +/// details | ¿Cómo puedo descargar mi VPS como un archivo de máquina virtual? + +No es posible descargar un archivo de máquina virtual de un VPS de OVHcloud. Sin embargo, puedes utilizar la opción **Snapshot** de tu VPS en el área de cliente de OVHcloud para recuperar un archivo de imagen. + +Sigue nuestra guía sobre [cómo usar instantáneas en un VPS](/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps) para crear y descargar una instantánea del VPS. + +Luego puedes convertir localmente el archivo de instantánea descargado en un formato correspondiente a tus necesidades. + +Considera contactar con uno de nuestros [socios](/links/partner) para obtener más ayuda. + +/// + +/// details | ¿Cómo puedo acceder a mi almacenamiento de copias de seguridad desde una dirección IP fuera de mi servicio? + +El acceso al almacenamiento de copias de seguridad de tu VPS (almacenamiento FTP) puede estar restringido a direcciones IP vinculadas a un servicio dentro de tu cuenta de cliente de OVHcloud. + +Para añadir otras direcciones IP desde las que acceder, puedes utilizar la API de OVHcloud. +Esto te permitirá recuperar tus datos de copia de seguridad desde un servicio diferente a través de varios protocolos (FTP, NFS, CIFS). > [!warning] -> Solo es posible autorizar las direcciones IP de OVHcloud. +> Solo se pueden autorizar direcciones IP de OVHcloud. > -Conéctese a la [consola API de OVHcloud](/links/api) con las claves de su cuenta de cliente y utilice la siguiente llamada: +Inicia sesión en la [consola de API de OVHcloud](/links/api) con tus credenciales de cuenta de cliente y utiliza la siguiente llamada: > [!api] > > @api {v1} /vps POST /vps/{serviceName}/backupftp/access > -Cambie la configuración de la siguiente manera: +Edita los parámetros de la siguiente manera: -- `serviceName`: introduzca el nombre interno de su VPS (`vps-x11x11xyy.vps.ovh.net`). -- `cifs`: establezca este parámetro en `true` si utiliza este protocolo. -- `ftp`: establezca este parámetro en `true` si utiliza este protocolo. -- `ipBlock`: introduzca la dirección IP que tendrá acceso, con el formato `203.0.113.100/32`. -- `nfs`: establezca este parámetro en `true` si utiliza este protocolo. +- `serviceName`: Introduce el nombre interno de tu VPS (`vps-x11x11xyy.vps.ovh.net`). +- `cifs`: Establece en `true` si es aplicable. +- `ftp`: Establece en `true` si es aplicable. +- `ipBlock`: Introduce la dirección IP que tendrá acceso, en el formato `203.0.113.100/32`. +- `nfs`: Establece en `true` si es aplicable. -Pulse el botón `EXECUTE`{.action}. +Haz clic en el botón `EXECUTE`{.action}. -Para comprobar que su dirección IP está autorizada, utilice la siguiente llamada: +Para verificar que tu dirección IP está autorizada, utiliza la siguiente llamada: > [!api] > > @api {v1} /vps GET /vps/{serviceName}/backupftp/access > +/// + + +/// details | ¿Está mi VPS protegido contra ataques externos? + +Aunque OVHcloud aplica medidas de seguridad para proteger toda la infraestructura, el administrador de un VPS es responsable de la seguridad de las aplicaciones y datos alojados en él. + +- Sigue nuestra guía sobre [cómo configurar el Firewall de la Red Edge de OVHcloud](/pages/bare_metal_cloud/dedicated_servers/firewall_network) que está integrado en nuestra infraestructura Anti-DDoS, limitando la exposición de tus servicios a ataques DDoS. +- Además, puedes utilizar nuestras guías sobre [cómo configurar tu propio firewall](/pages/bare_metal_cloud/virtual_private_servers/firewall-Linux-iptable) con `iptables` en distribuciones basadas en Linux y [cómo activar el firewall en Windows](/pages/bare_metal_cloud/virtual_private_servers/activate-port-firewall-soft-win). +- Para distribuciones basadas en Linux en un VPS, puedes seguir las instrucciones de nuestra guía sobre [cómo proteger un VPS](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps) para aplicar medidas de seguridad adicionales. + +/// + +/// details | ¿Cómo puedo proteger mi VPS contra ataques DDoS? + +OVHcloud ofrece varias características de seguridad para proteger tu VPS contra tráfico malicioso: + +- Protección Anti-DDoS: Nuestros servicios de VPS están protegidos por defecto por nuestra [infraestructura Anti-DDoS](/links/security/antiddos) que detecta y mitiga ataques DDoS en tiempo real. +- Bloqueo de IP: Puedes [evitar que direcciones IP específicas o rangos de IP](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps) lleguen a tu VPS. +- Reglas de firewall: Puedes [configurar reglas de firewall personalizadas](/pages/bare_metal_cloud/dedicated_servers/firewall_network) para controlar el tráfico entrante y saliente directamente en tu VPS. +- VAC (VPS Anti-DDoS): Nuestro sistema VAC proporciona una capa adicional de protección contra ataques DDoS, incluyendo filtrado de tráfico y limitación de velocidad. + +/// + +/// details | Quiero usar un VPS como servidor de juego, ¿beneficiará del mismo firewall que protege los servidores dedicados de juego? + +La protección contra DDoS de OVHcloud para juegos solo está disponible para nuestros servidores dedicados de juego. Si contrata un VPS para alojamiento de juegos, deberá configurar directamente el firewall en su sistema, adaptado al juego deseado. Puede encontrar más información en nuestra guía sobre [cómo configurar el firewall en Linux con iptables](/pages/bare_metal_cloud/virtual_private_servers/firewall-Linux-iptable). + +La ventaja de un VPS frente a un servidor dedicado es la posibilidad de escalar sus recursos según su uso real. Puede actualizar su VPS con solo unos clics para beneficiarse de un sistema más potente. + +/// + ## Más información Si quiere disfrutar de ayuda para utilizar y configurar sus soluciones de OVHcloud, puede consultar nuestras distintas soluciones [pestañas de soporte](/links/support). -Interactúe con nuestra [comunidad de usuarios](/links/community). \ No newline at end of file +Interactúe con nuestra [comunidad de usuarios](/links/community). diff --git a/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.es-us.md b/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.es-us.md deleted file mode 100644 index 73d7cd44291..00000000000 --- a/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.es-us.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -title: FAQ VPS OVHcloud -updated: 2025-08-07 ---- - -## FAQ VPS - -## ¿Qué es un VPS y para qué sirve? - -Un servidor privado virtual (VPS) permite alojar sitios web (sitio corporativo, e-commerce, contenidos, multimedia) y aplicaciones de software (portales, Extranet, soluciones colaborativas, wikis, CRM). A diferencia del alojamiento compartido, los datos están aislados en una máquina virtual dedicada al usuario. - -Los VPS, situados estratégicamente entre un alojamiento web y un servidor físico, combinan la fiabilidad y el rendimiento de un servidor dedicado sin tener que gestionar las cargas de hardware. - -## ¿Qué elegir entre un VPS y un alojamiento web? - -La utilización de un VPS se inscribe en la continuidad lógica de la de un alojamiento web. Los servidores privados virtuales ofrecen más posibilidades y mayor libertad de acción en cuanto a la configuración, el acceso y las funcionalidades (root, Apache PHP.init). También puede instalar un certificado SSL o cualquier otro programa de software que desee. - -No obstante, tenga en cuenta la necesidad de seleccionar correctamente su VPS. ya que requiere una configuración acorde a las necesidades de las aplicaciones y una adaptación al crecimiento de su actividad. - -## ¿Qué ventajas tiene un VPS con respecto a un servidor dedicado? - -La ventaja de los VPS es que permiten liberarse de la gestión del hardware, como el seguimiento del estado de los discos duros, la memoria RAM y la CPU. Son adecuados para la mayoría de los usos web, para proyectos cuyo tamaño sea controlado. -El uso de un servidor dedicado está recomendado para gestionar usted mismo la parte del hardware, construir arquitecturas más elaboradas, crear una infraestructura que incluya una red privada (vRack) o desplegar soluciones complejas que no sean servicios web. - -Por regla general, los usuarios y usuarios que desarrollan su actividad web evolucionan hacia servidores dedicados o soluciones de Public Cloud. Estos servicios ofrecen infraestructuras más complejas y flexibles, adaptadas a un crecimiento fuerte. - -## ¿Qué diferencia hay entre las soluciones VPS y Public Cloud? - -El VPS es una solución adaptada a los entornos de preproducción y producción, que no necesitan un rendimiento constante. -El Public Cloud de OVHcloud ofrece una infraestructura multiservidor con alta disponibilidad de las máquinas. Esta solución también incluye una red privada, el vRack. - -## ¿Cómo elegir un VPS de OVHcloud? - -Para elegir un VPS que se ajuste a sus necesidades, compruebe que: - -- la cantidad de recursos necesarios (procesador, memoria, espacio en disco, ancho de banda...); -- el sistema operativo requerido (Linux o Windows); -- los requisitos técnicos esenciales para el buen funcionamiento de la aplicación (por ejemplo, una base de datos requiere velocidad de lectura-escritura). - -Esto le permitirá elegir entre nuestras soluciones de VPS: - -- **VPS Starter**: máquina de entrada para probar nuestra solución (solo con una distribución Linux). -- **VPS Value, Essential y Comfort**: ideales para el alojamiento de sitios web, servicios de e-commerce o sistemas de monitorización; -- **VPS Elite**: adecuado para portales de e-commerce y aplicaciones que requieren más recursos de CPU y memoria. -- **VPS Limited Edition** (cantidad limitada): estos VPS ofrecen un rendimiento mejorado, una gran ventaja para alojar sitios web complejos, aplicaciones que consumen muchos recursos o incluso servidores de juego. Esta oferta es válida hasta agotar stock. - -> [!primary] -> Es posible pasar de un VPS Limited Edition a otro VPS de la misma gama, pero, por motivos técnicos, no es posible pasar de un VPS Limited Edition a un VPS de otra gama (Starter, Value, Essential o Comfort). - -### ¿Quién puede utilizar un VPS? - -Para gestionar un VPS, es necesario tener conocimientos básicos de administración de servidores. Estos conocimientos son esenciales para gestionar el sistema operativo (Linux o Windows) instalado en la máquina y configurar las aplicaciones. ¿Cree que necesita un VPS, pero considera que no dispone de los conocimientos necesarios? Le invitamos a que se ponga en contacto con uno de nuestros [partners](/links/partner). - -Si desea disfrutar de recursos garantizados sin tener conocimientos de administración de servidores, le recomendamos nuestros [planes de hosting Performance](/links/web/hosting-performance-offer). - -## ¿Cómo conectarme a mi VPS? - -Puede conectarse a distancia a su VPS con las claves que le facilitemos por correo electrónico tras la entrega del servicio. -El método de conexión depende de los sistemas operativos utilizados. - -En la guía ["Primeros pasos con un VPS"](/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps) encontrará todos los detalles. - -## ¿Es posible alojar varios sitios web en un VPS? - -Sí. Un VPS puede particionarse y organizarse en función de sus necesidades. De este modo, puede alojar varios sitios web o proyectos, asignando a cada uno de ellos un espacio privado cuyo volumen elija. Para simplificar estas operaciones, puede instalar un panel de control de sitios web, como Plesk o cPanel. - -### ¿Se guarda un VPS? - -Es recomendable aplicar una estrategia de backup adecuada en función de la sensibilidad de sus datos. -Visite nuestra [página web del VPS](/links/bare-metal/vps-options) para saber más sobre las opciones disponibles. - -## ¿Cómo proteger mi VPS? - -Por defecto, el VPS se entrega "desnudo", por lo que no incluye ninguna configuración de seguridad. Es lo primero que tienes que hacer en la recepción. -Para ello, no dude en consultar la guía ["Proteger un VPS"](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps). - -### ¿Cuál es el ancho de banda asignado a mi VPS? ¿Está garantizada? - -El ancho de banda que aparece en la página de nuestros productos está garantizado. Es la tasa de transferencia mínima que se le ha asignado. - -### ¿Qué SLA se aplica a mi VPS? - -En todas las gamas de VPS, OVHcloud ofrece un SLA del 99,9%. - -### ¿Cómo acceder al Backup Storage desde una dirección IP distinta de mi servicio? - -El acceso al backup FTP puede restringirse al servicio al que esté asociado desde el área de cliente de OVHcloud. - -Para autorizar direcciones IP adicionales desde las que quiere acceder a su Backup Storage, puede utilizar la API de OVHcloud. -Esto le permitirá recuperar sus copias de seguridad de datos desde un servicio diferente a través de diferentes protocolos (FTP, NFS, CIFS). - -> [!warning] -> Solo es posible autorizar las direcciones IP de OVHcloud. -> - -Conéctese a la [consola API de OVHcloud](/links/api) con las claves de su cuenta de cliente y utilice la siguiente llamada: - -> [!api] -> -> @api {v1} /vps POST /vps/{serviceName}/backupftp/access -> - -Cambie la configuración de la siguiente manera: - -- `serviceName`: introduzca el nombre interno de su VPS (`vps-x11x11xyy.vps.ovh.net`). -- `cifs`: establezca este parámetro en `true` si utiliza este protocolo. -- `ftp`: establezca este parámetro en `true` si utiliza este protocolo. -- `ipBlock`: introduzca la dirección IP que tendrá acceso, con el formato `203.0.113.100/32`. -- `nfs`: establezca este parámetro en `true` si utiliza este protocolo. - -Pulse el botón `EXECUTE`{.action}. - -Para comprobar que su dirección IP está autorizada, utilice la siguiente llamada: - -> [!api] -> -> @api {v1} /vps GET /vps/{serviceName}/backupftp/access -> - - -## Más información - -Si quiere disfrutar de ayuda para utilizar y configurar sus soluciones de OVHcloud, puede consultar nuestras distintas soluciones [pestañas de soporte](/links/support). - -Interactúe con nuestra [comunidad de usuarios](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.fr-ca.md b/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.fr-ca.md deleted file mode 100644 index 9ddcbafca57..00000000000 --- a/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.fr-ca.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -title: FAQ VPS OVHcloud -updated: 2025-08-07 ---- - -## FAQ VPS - -### Qu'est-ce qu'un VPS et à quoi sert-il ? - -Un serveur privé virtuel (VPS) permet d’héberger des sites web (vitrine, e-commerce, contenus, médias) et des applications logicielles (portails, Extranet, solutions collaboratives, wikis, CRM). Contrairement à l’hébergement mutualisé, les données sont isolées sur une machine virtuelle dédiée à l’utilisateur. - -Idéalement situés entre un hébergement web et un serveur physique, nos VPS conjuguent la fiabilité et la performance d’un serveur dédié sans la gestion des contraintes matérielles. - -### Quels sont les avantages d'un VPS par rapport à un serveur dédié ? - -Les VPS ont pour avantage de vous libérer de la gestion hardware, comme le suivi de l’état des disques durs, de la mémoire vive (RAM) et du CPU. Ils sont adaptés à la plupart des usages web, pour des projets dont la taille est maîtrisée. -L’utilisation d’un serveur dédié est quant à elle conseillée si vous souhaitez gérer vous-même la partie matérielle, bâtir des architectures plus élaborées, créer une infrastructure incluant un réseau privé (vRack) ou encore déployer des solutions complexes autres que des services web. - -En règle générale, les utilisateurs dont l’activité web se développe évoluent vers des serveurs dédiés ou des solutions Public Cloud. Ces services proposent des infrastructures plus complexes et flexibles, adaptées à une croissance forte. - -### Quelles sont les différences entre les solutions VPS et Public Cloud ? - -Le VPS est une solution adaptée aux environnements de préproduction et production qui ne nécessitent pas de performances constantes. -Le Public Cloud d'OVHcloud propose quant à lui une infrastructure multiserveur avec une haute disponibilité des machines. Un réseau privé, le vRack, est également disponible avec cette solution. - -### Comment choisir mon VPS OVHcloud ? - -Pour choisir un VPS adapté à vos besoins, nous vous invitons à vérifier les aspects suivants : - -- la quantité de ressources nécessaire (processeur, mémoire, espace disque, bande passante) ; -- le système d'exploitation requis (Linux ou Windows) ; -- les prérequis techniques essentiels au bon fonctionnement de l’application (par exemple, une base de données demande de la vitesse en lecture/écriture). - -Cela vous permettra de faire le bon choix parmi nos solutions VPS : - -- **VPS Starter** : machine d'entrée de gamme pour tester notre offre (avec une distribution Linux uniquement) ; -- **VPS Value, Essential et Comfort** : idéal pour l’hébergement de sites web, de services e-commerce ou de systèmes de monitoring ; -- **VPS Elite** : adapté aux sites e-commerce et applications plus exigeants en ressources CPU et mémoire ; -- **VPS Limited Edition** (quantités limitées) : ces VPS offrent des performances accrues, un atout majeur pour l’hébergement de sites complexes, d’applications gourmandes en ressources ou même de serveurs de jeu. Cette offre est valide jusqu’à l'épuisement des stocks. - -> [!primary] -> Vous pouvez faire évoluer un VPS Limited Edition vers un autre VPS de cette même gamme mais, pour des raisons techniques, il est impossible de faire évoluer un VPS Limited Edition vers un VPS d'une autre gamme (Starter, Value, Essential ou Comfort). - -### Qui peut se servir d'un VPS ? - -Gérer un VPS nécessite des connaissances de base en administration de serveurs. Ces notions sont essentielles pour gérer le système d’exploitation (Linux ou Windows) installé sur la machine et paramétrer les applications. Vous pensez avoir besoin d’un VPS, mais estimez ne pas posséder les compétences requises ? Nous vous invitons à vous rapprocher de l’un de nos [partenaires](https://marketplace.ovhcloud.com/). - -Si vous souhaitez bénéficier de ressources garanties sans connaissances en administration de serveurs, nous vous conseillons nos [hébergements web Performance](/links/web/hosting-performance-offer). - -### Comment me connecter à mon VPS ? - -Vous pouvez vous connecter à distance à votre VPS grâce aux identifiants fournis par e-mail après la livraison du service. -La méthode de connexion dépend des systèmes d'exploitation utilisés. - -Tous les détails vous sont présentés dans le guide « [Débuter avec un VPS](/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps) ». - -### Est-il possible d'héberger plusieurs sites internet sur un VPS ? - -Oui. Un VPS peut être partitionné et organisé en fonction de vos besoins. Vous pouvez ainsi y héberger plusieurs sites ou projets, en allouant à chacun un espace privé dont vous choisissez le volume. Pour simplifier ces manipulations, vous avez la possibilité d'installer un panneau de gestion de sites web, comme Plesk ou cPanel. - -### Mon VPS est-il sauvegardé ? - -Il est conseillé d'appliquer une stratégie de sauvegarde appropriée en fonction de la sensibilité de vos données. -Rendez-vous sur notre [page web VPS](/links/bare-metal/vps-options) pour en savoir plus sur les options disponibles. - -### Comment sécuriser mon VPS ? - -Par défaut le VPS est fourni « nu », aucune configuration de sécurité n’est présente sur ce dernier. C’est donc la première action que vous devez entreprendre dès la livraison de votre VPS. -Pour ce faire, n’hésitez pas à consulter le guide « [Sécuriser un VPS](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps) ». - -### Quelle est la bande passante allouée à mon VPS ? Est-elle garantie ? - -La bande passante affichée sur la page de nos offres est garantie. Il s'agit du débit minimum qui vous est alloué. - -### Quel SLA est appliqué sur mon VPS ? - -OVHcloud propose un SLA de 99,9% sur l’ensemble des gammes VPS. - -### Comment accéder à mon Backup Storage depuis une adresse IP différente de mon service ? - -L'accès à votre Backup Storage (backup FTP) peut être restreint au service auquel il est lié via votre espace client OVHcloud. - -Afin d'autoriser des adresses IP supplémentaires depuis lesquelles vous souhaitez accéder à votre Backup Storage, vous pouvez utiliser l'API OVHcloud. -Cela vous permettra de récupérer vos sauvegardes de données depuis un service différent via différents protocoles (FTP, NFS, CIFS). - -> [!warning] -> Seules les adresses IP OVHcloud peuvent être autorisées. -> - -Connectez-vous à la [console API OVHcloud](/links/api) avec les identifiants de votre compte client et utilisez l'appel suivant : - -> [!api] -> -> @api {v1} /vps POST /vps/{serviceName}/backupftp/access -> - -Modifiez les paramètres comme suit : - -- `serviceName` : renseignez le nom interne de votre VPS (`vps-x11x11xyy.vps.ovh.net`). -- `cifs` : définissez ce paramètre sur `true` si vous utilisez ce protocole. -- `ftp` : définissez ce paramètre sur `true` si vous utilisez ce protocole. -- `ipBlock` : renseignez l'adresse IP qui y aura accès, sous la forme `203.0.113.100/32`. -- `nfs` : définissez ce paramètre sur `true` si vous utilisez ce protocole. - -Cliquez sur le bouton `EXECUTE`{.action}. - -Afin de vérifier que votre adresse IP est bien autorisée, utilisez l'appel suivant : - -> [!api] -> -> @api {v1} /vps GET /vps/{serviceName}/backupftp/access -> - -## Aller plus loin - -Si vous souhaitez bénéficier d'une assistance à l'usage et à la configuration de vos solutions OVHcloud, nous vous proposons de consulter nos différentes [offres de support](/links/support). - -Échangez avec notre [communauté d'utilisateurs](/links/community). \ No newline at end of file diff --git a/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.fr-fr.md b/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.fr-fr.md index 9ddcbafca57..64173bd61f2 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.fr-fr.md +++ b/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.fr-fr.md @@ -1,93 +1,406 @@ --- -title: FAQ VPS OVHcloud -updated: 2025-08-07 +title: "FAQ sur les VPS OVHcloud" +excerpt: "Trouvez les réponses aux questions les plus fréquemment posées sur nos offres VPS" +updated: 2025-10-30 --- -## FAQ VPS + -### Qu'est-ce qu'un VPS et à quoi sert-il ? +## Questions générales sur les offres VPS -Un serveur privé virtuel (VPS) permet d’héberger des sites web (vitrine, e-commerce, contenus, médias) et des applications logicielles (portails, Extranet, solutions collaboratives, wikis, CRM). Contrairement à l’hébergement mutualisé, les données sont isolées sur une machine virtuelle dédiée à l’utilisateur. +/// details | Qu'est-ce qu'un VPS et à quoi sert-il ? -Idéalement situés entre un hébergement web et un serveur physique, nos VPS conjuguent la fiabilité et la performance d’un serveur dédié sans la gestion des contraintes matérielles. +Un serveur privé virtuel (VPS) est utilisé pour héberger des sites web (e-commerce, contenu, médias visuels) et des applications logicielles (portails, extranets, solutions collaboratives, wikis, CRM). Contrairement à un hébergement mutualisé, un VPS offre un environnement isolé, dédié au client. Nos solutions VPS combinent performance et fiabilité sans la charge de gestion du matériel. Vous pouvez également facilement mettre à niveau votre configuration sans changer de serveur. -### Quels sont les avantages d'un VPS par rapport à un serveur dédié ? +/// -Les VPS ont pour avantage de vous libérer de la gestion hardware, comme le suivi de l’état des disques durs, de la mémoire vive (RAM) et du CPU. Ils sont adaptés à la plupart des usages web, pour des projets dont la taille est maîtrisée. -L’utilisation d’un serveur dédié est quant à elle conseillée si vous souhaitez gérer vous-même la partie matérielle, bâtir des architectures plus élaborées, créer une infrastructure incluant un réseau privé (vRack) ou encore déployer des solutions complexes autres que des services web. +/// details | Quels sont les avantages du VPS OVHcloud ? -En règle générale, les utilisateurs dont l’activité web se développe évoluent vers des serveurs dédiés ou des solutions Public Cloud. Ces services proposent des infrastructures plus complexes et flexibles, adaptées à une croissance forte. +Les VPS OVHcloud offrent un excellent rapport performance/prix, avec un trafic illimité et plusieurs emplacements mondiaux pour une faible latence et une accessibilité améliorée, en fonction de vos besoins. -### Quelles sont les différences entre les solutions VPS et Public Cloud ? +/// -Le VPS est une solution adaptée aux environnements de préproduction et production qui ne nécessitent pas de performances constantes. -Le Public Cloud d'OVHcloud propose quant à lui une infrastructure multiserveur avec une haute disponibilité des machines. Un réseau privé, le vRack, est également disponible avec cette solution. +/// details | Une solution VPS est-elle le bon choix pour moi ? -### Comment choisir mon VPS OVHcloud ? +L’utilisation d’un VPS nécessite des connaissances de base en administration de serveur. Garder cela à l’esprit est crucial pour gérer efficacement votre système d’exploitation (Linux ou Windows) et pour mettre en place vos applications, comme PrestaShop ou WordPress par exemple. -Pour choisir un VPS adapté à vos besoins, nous vous invitons à vérifier les aspects suivants : +Si vous avez besoin d’un VPS mais que vous n’avez pas les compétences techniques pour le gérer, contactez l’un de nos [partenaires](/links/partner) pour obtenir de l’aide. -- la quantité de ressources nécessaire (processeur, mémoire, espace disque, bande passante) ; -- le système d'exploitation requis (Linux ou Windows) ; -- les prérequis techniques essentiels au bon fonctionnement de l’application (par exemple, une base de données demande de la vitesse en lecture/écriture). +Si vous avez besoin de ressources allouées, mais que vous préférez ne pas vous occuper de l’administration du serveur, nous vous recommandons d’opter pour nos offres d’hébergement web Performance. -Cela vous permettra de faire le bon choix parmi nos solutions VPS : +/// -- **VPS Starter** : machine d'entrée de gamme pour tester notre offre (avec une distribution Linux uniquement) ; -- **VPS Value, Essential et Comfort** : idéal pour l’hébergement de sites web, de services e-commerce ou de systèmes de monitoring ; -- **VPS Elite** : adapté aux sites e-commerce et applications plus exigeants en ressources CPU et mémoire ; -- **VPS Limited Edition** (quantités limitées) : ces VPS offrent des performances accrues, un atout majeur pour l’hébergement de sites complexes, d’applications gourmandes en ressources ou même de serveurs de jeu. Cette offre est valide jusqu’à l'épuisement des stocks. +/// details | Puis-je facilement faire évoluer mon VPS vers une gamme supérieure ou vers une configuration inférieure ? -> [!primary] -> Vous pouvez faire évoluer un VPS Limited Edition vers un autre VPS de cette même gamme mais, pour des raisons techniques, il est impossible de faire évoluer un VPS Limited Edition vers un VPS d'une autre gamme (Starter, Value, Essential ou Comfort). +Oui, vous pouvez mettre à niveau votre configuration depuis votre espace client, sans migration manuelle de vos données. Les options de mise à niveau disponibles dépendent de la gamme et du modèle du VPS. -### Qui peut se servir d'un VPS ? +Cependant, pour downgrader votre configuration, vous devrez souscrire une nouvelle offre, transférer vos données, puis résilier votre ancien service. Notre support est à votre disposition si nécessaire. -Gérer un VPS nécessite des connaissances de base en administration de serveurs. Ces notions sont essentielles pour gérer le système d’exploitation (Linux ou Windows) installé sur la machine et paramétrer les applications. Vous pensez avoir besoin d’un VPS, mais estimez ne pas posséder les compétences requises ? Nous vous invitons à vous rapprocher de l’un de nos [partenaires](https://marketplace.ovhcloud.com/). +/// -Si vous souhaitez bénéficier de ressources garanties sans connaissances en administration de serveurs, nous vous conseillons nos [hébergements web Performance](/links/web/hosting-performance-offer). +/// details | Quelle région ou pays choisir pour mon VPS ? -### Comment me connecter à mon VPS ? +Plus votre datacentre est proche de votre audience, plus la latence est faible. Cela permet une meilleure expérience utilisateur et une confiance accrue dans vos services. + +/// + +/// details | Quel est l'avantage d'un VPS situé en Europe ? + +L’hébergement de votre VPS chez OVHcloud en France ou plus généralement au sein de l’UE offre des avantages tels que des prix compétitifs et une protection renforcée des données. Votre service n'est pas soumis au CLOUD Act américain, le protégeant des interférences non européennes. + +/// + +/// details | Les sauvegardes sont-elles incluses avec mon VPS ? + +Oui, lors de la commande d'un VPS, une option de sauvegarde quotidienne est incluse gratuitement. + +Pour une protection encore meilleure, vous pouvez également opter pour notre option de sauvegarde Premium. Elle offre : + +- La possibilité de revenir à une sauvegarde datant d'une semaine. +- La possibilité de planifier des sauvegardes, d'optimiser la gestion des données et de minimiser l'impact sur les opérations commerciales. + +De plus, nous vous proposons : + +- Des snapshots : Vous pouvez créer des snapshots manuels et instantanés qui capturent l'état exact de votre VPS juste avant une mise à jour ou un changement critique. +- Une sauvegarde externe : Stockez vos données sur un disque séparé et sécurisé, permettant une récupération facile en cas d'incident majeur. + +Grâce à ces solutions, vous pouvez personnaliser la gestion de vos sauvegardes en fonction de vos besoins en matière de sécurité et de continuité d’activité. + +Rendez-vous sur notre [page web VPS](/links/bare-metal/vps) pour en savoir plus sur les options disponibles. + +/// + +/// details | Puis-je héberger plusieurs sites web sur un VPS ? + +Oui, un VPS peut être configuré pour héberger plusieurs sites web ou projets. Vous pouvez partitionner votre espace de stockage selon vos besoins et utiliser des interfaces spécialisées comme Plesk ou cPanel pour simplifier la gestion de votre site web. + +/// + +/// details | Un nom de domaine et un service e-mail sont-ils inclus avec mon VPS ? + +Non, nos VPS n’incluent pas de nom de domaine ni de service e-mail. Ces services peuvent être commandés séparément dans votre espace client. + +/// + +/// details | Comment choisir entre un VPS et un hébergement web ? + +**Hébergement web** + +- Idéal pour vos besoins de base avec une installation préconfigurée. + +**VPS** + +- Davantage de flexibilité et de contrôle, idéal pour faire évoluer des projets avec des besoins de configuration complexes. + +L’hébergement de services web sur un VPS vous permet d’installer le logiciel de votre choix, de personnaliser les paramètres du serveur et d’héberger plusieurs sites web avec des ressources dédiées. À noter qu’un VPS nécessite d’être configuré de manière à répondre aux besoins de vos applications et à s’adapter à la croissance de votre activité. + +/// + +/// details | Quelle est la différence entre un VPS et une solution Public Cloud ? + +**VPS** + +- Une machine virtuelle optimisée et dédiée, adaptée à la préproduction comme à la production, conçue pour héberger plusieurs projets web. + +**Public Cloud OVHcloud** + +- Offre une infrastructure multi-serveurs à haute disponibilité et un réseau privé (vRack), conçue pour les architectures complexes et évolutives. + +/// + +/// details | Quels sont les avantages d’un VPS par rapport à un serveur dédié ? + +**VPS** + +- Offre une gestion simplifiée sans maintenance matérielle, idéale pour les projets nécessitant un contrôle strict. + +**Serveur dédié** + +- Recommandé pour les infrastructures complexes qui nécessitent un contrôle matériel complet et des performances garanties. + +Le VPS élimine la nécessité de gérer le matériel physique, comme le stockage, la RAM et le CPU, ce qui le rend bien adapté à la plupart des applications web. Au fur et à mesure que votre entreprise se développe, vous pouvez faire évoluer votre VPS ou migrer vers un serveur dédié ou une solution Public Cloud pour bénéficier d’une infrastructure plus flexible et plus puissante. + +/// + +/// details | Quelle bande passante est allouée à mon VPS ? Est-elle garantie ? + +La bande passante indiquée sur notre [page web VPS](/links/bare-metal/vps) est garantie. Il s’agit de la valeur minimale allouée à votre service. + +/// + +/// details | Quel SLA est appliqué à mon VPS ? + +Un VPS OVHcloud inclut un SLA de 99,9 %. + +/// + + +/// details | Quelles sont les spécificités d’un VPS Local Zone ? + +Grâce au VPS Local Zone, vous réduisez significativement les temps d’accès à vos sites et applications, car vos données sont hébergées au plus près de vos utilisateurs. L’utilisateur bénéficie ainsi d’une meilleure expérience, car la latence est réduite pour chaque application nécessitent un temps de réponse minimal. Il vous suffit de sélectionner l'une de nos implantations mondiales lors de votre commande. + +Gardez à l'esprit qu’un VPS Local Zone, contrairement à un VPS ordinaire, n’inclut pas de fonctionnalités de sécurité, comme l’anti-DDoS, ni d’options avancées, comme l’Additional IP et le Load Balancer. + +Un VPS Local Zone répond également aux besoins des projets ayant des exigences de localisation des données et de souveraineté. En hébergeant vos services dans une région spécifique, vous pouvez facilement respecter les réglementations locales relatives au traitement et au stockage des données, comme le RGPD européen. + +/// + +/// details | Puis-je migrer mon VPS d’une Local Zone vers un datacentre, et vice versa ? + +Non, il n’est pas possible de migrer les services directement. Vous devez souscrire au VPS de votre choix, transférer vos données, puis résilier votre ancien service. Notre support peut vous guider dans ces étapes si nécessaire. + +/// + +/// details | Quels sont les risques d'utiliser un VPS sans protection DDoS ? + +Les serveurs privés virtuels sans protection anti-DDoS sont automatiquement exposés à des attaques par déni de service distribué (DDoS), qui peuvent entraîner des pannes de service et de graves violations de la sécurité. + +- Exposition directe : Si votre serveur est la cible d’une attaque DDoS, l’afflux de requêtes malveillantes peut le submerger, rendant vos sites et applications inaccessibles. +- Pas de mitigation automatique : Pour protéger votre serveur, vous devrez repousser les attaques à l'aide de logiciels de sécurité tiers ou de configurations spécifiques. +- Charge de gestion supplémentaire : L’absence d’une sécurité intégrée robuste présente un risque majeur, soulignant la nécessité d’un suivi vigilant et de stratégies proactives, en particulier pour les projets à fort trafic. + +Si la résilience face aux attaques DDoS est un facteur critique pour votre projet, nous vous recommandons d'opter pour un VPS OVHcloud hébergé dans l'un de nos datacentres, afin qu'il bénéficie d'une protection intégrée. + +/// + + +## Questions relatives à l’administration du VPS + +/// details | Comment me connecter à mon VPS ? + +Vous pouvez vous connecter à votre VPS à distance grâce aux identifiants fournis par e-mail après livraison du service. -Vous pouvez vous connecter à distance à votre VPS grâce aux identifiants fournis par e-mail après la livraison du service. La méthode de connexion dépend des systèmes d'exploitation utilisés. -Tous les détails vous sont présentés dans le guide « [Débuter avec un VPS](/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps) ». +Tous les détails sont présentés dans notre guide « [Premiers pas avec un VPS](/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps) ». + +/// + +/// details | Est-ce qu'OVHcloud fournit une assistance à la configuration logicielle de mon VPS ? + +Bien que nous ne puissions pas vous offrir d'assistance en matière de configuration ou d'administration de logiciels, nous mettons à votre disposition des outils et des ressources pour vous aider à démarrer. + +Par exemple, nous proposons une gamme de modèles et d'images préconfigurés pour les systèmes d'exploitation et les applications les plus populaires afin de vous aider à déployer rapidement votre VPS. Nous fournissons également l'espace client OVHcloud, où vous pouvez gérer votre VPS, y compris les tâches telles que le redémarrage, la réinstallation et la surveillance des ressources. + +De plus, notre documentation et notre base de connaissances contiennent de nombreuses informations sur la configuration et la gestion de votre VPS. + +Toutefois, pour obtenir une assistance spécifique en matière de configuration logicielle, nous vous recommandons de contacter notre [communauté d'utilisateurs](/links/community) ou de demander l'aide d'un administrateur système ou d'un développeur qualifié via notre [Portail Partenaires](/links/partner). + +/// + +/// details | Puis-je installer plus d’un système d’exploitation sur mon VPS ? + +Les modèles d'installation d'OVHcloud ne permettent qu'un seul système d'exploitation. +Les configurations personnalisées peuvent être appliquées du côté client et relèvent de la responsabilité de l'administrateur du serveur. Les services OVHcloud n'incluent pas de tâches d'administration, telles que la configuration logicielle ou des outils externes. + +Si vous rencontrez des problèmes de configuration et d'administration, nous vous recommandons de contacter notre [communauté d'utilisateurs](/links/community) ou de demander l'aide d'un administrateur système ou d'un développeur qualifié via notre [Portail Partenaires](/links/partner). + +/// + +/// details | Puis-je installer des machines virtuelles sur un VPS en utilisant un logiciel de virtualisation (comme Proxmox) ? + +Les modèles d'installation OVHcloud pour VPS n'incluent pas le système d'exploitation Proxmox ou un système d'exploitation similaire pour la virtualisation. + +Les configurations personnalisées peuvent être appliquées du côté client et relèvent de la responsabilité de l'administrateur du serveur. Les services OVHcloud n'incluent pas de tâches d'administration, telles que la configuration logicielle ou l'utilisation d'outils externes. + +Si vous rencontrez des problèmes de configuration et d'administration, nous vous recommandons de contacter notre [communauté d'utilisateurs](/links/community) ou de demander l'aide d'un administrateur système ou d'un développeur qualifié via notre [Portail Partenaires](/links/partner). + +/// -### Est-il possible d'héberger plusieurs sites internet sur un VPS ? +/// details | Est-il possible de choisir le matériel de mon VPS (GPU, CPU, etc.) ou de le faire évoluer ? -Oui. Un VPS peut être partitionné et organisé en fonction de vos besoins. Vous pouvez ainsi y héberger plusieurs sites ou projets, en allouant à chacun un espace privé dont vous choisissez le volume. Pour simplifier ces manipulations, vous avez la possibilité d'installer un panneau de gestion de sites web, comme Plesk ou cPanel. +Un VPS ne peut être ni personnalisé, ni modifié au niveau du matériel. -### Mon VPS est-il sauvegardé ? +Sélectionnez un [modèle de VPS](/links/bare-metal/vps) dans le processus de commande qui répond à vos exigences minimales, vous pourrez ensuite le mettre à niveau si nécessaire. -Il est conseillé d'appliquer une stratégie de sauvegarde appropriée en fonction de la sensibilité de vos données. -Rendez-vous sur notre [page web VPS](/links/bare-metal/vps-options) pour en savoir plus sur les options disponibles. +/// -### Comment sécuriser mon VPS ? +/// details | Mon VPS est trop lent, puis-je déplacer mon VPS sur un autre hôte ? -Par défaut le VPS est fourni « nu », aucune configuration de sécurité n’est présente sur ce dernier. C’est donc la première action que vous devez entreprendre dès la livraison de votre VPS. -Pour ce faire, n’hésitez pas à consulter le guide « [Sécuriser un VPS](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps) ». +Pour résoudre les problèmes de performance de votre VPS, vous devrez fournir des résultats de tests spécifiques à notre équipe de support. -### Quelle est la bande passante allouée à mon VPS ? Est-elle garantie ? +Notez que votre VPS doit être démarré en [mode rescue](/pages/bare_metal_cloud/virtual_private_servers/rescue) pour exclure tout problème logiciel éventuel. -La bande passante affichée sur la page de nos offres est garantie. Il s'agit du débit minimum qui vous est alloué. +Contactez notre support en [créant une demande dans le centre d’aide d’OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help) afin que nous puissions vous fournir la liste complète des tests nécessaires pour une évaluation correcte. -### Quel SLA est appliqué sur mon VPS ? +/// -OVHcloud propose un SLA de 99,9% sur l’ensemble des gammes VPS. +/// details | J’ai commandé un nouveau VPS, puis-je déplacer le temps d’engagement restant de mon ancien VPS ou me le faire rembourser ? -### Comment accéder à mon Backup Storage depuis une adresse IP différente de mon service ? +Cela est généralement possible, mais le processus nécessite une demande à notre équipe support via le [centre d’aide d’OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help). -L'accès à votre Backup Storage (backup FTP) peut être restreint au service auquel il est lié via votre espace client OVHcloud. +Avant de continuer, assurez-vous d’avoir [migré les données encore nécessaires](/pages/bare_metal_cloud/dedicated_servers/migrate_a_server_to_another) vers votre nouveau service ou créé des sauvegardes de vos données. -Afin d'autoriser des adresses IP supplémentaires depuis lesquelles vous souhaitez accéder à votre Backup Storage, vous pouvez utiliser l'API OVHcloud. -Cela vous permettra de récupérer vos sauvegardes de données depuis un service différent via différents protocoles (FTP, NFS, CIFS). +/// + +/// details | Puis-je déplacer mon VPS vers un autre datacentre OVHcloud dans un autre pays ? + +Il n’est pas possible de migrer un VPS vers un autre datacentre. Pour ce faire, vous pouvez effectuer une [migration manuelle](/pages/bare_metal_cloud/dedicated_servers/migrate_a_server_to_another) : + +1. Téléchargez vos données depuis le VPS actuel. +1. Commandez un nouveau VPS. +1. Déposez vos données sur le nouveau VPS. +1. [Résiliez l'ancien VPS](/pages/account_and_service_management/managing_billing_payments_and_services/how_to_cancel_services). + +/// + +/// details | Combien d'Additional IP puis-je configurer sur un VPS ? + +Un VPS est limité à [16 Additional IP](/links/network/additional-ip). + +Consultez notre guide « [Configurer une adresse IP en alias](/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing) » pour des exemples de configuration d'adresses IP. + +/// + +/// details | Puis-je ajouter des blocs d’adresses IP à mon VPS ? + +Il n'est pas possible d'ajouter des blocs d’adresses IP à un VPS. + +Vous pouvez configurer jusqu'à [16 Additional IPs](/links/network/additional-ip) sur un VPS. + +/// + +/// details | Puis-je changer le VPS associé à ma licence (Plesk, cPanel) ? + +Les licences peuvent être déplacées d’un serveur à l’autre, mais il existe des limitations. + +La meilleure option consiste à vous connecter à notre [console API](/links/console) avec les informations d'identification de votre compte client OVHcloud et à vérifier si votre licence peut être déplacée vers un autre VPS. Retrouvez les bases dans notre guide « [Premiers pas avec les API OVHcloud](/pages/manage_and_operate/api/first-steps) ». + +Une fois connecté, utilisez les appels suivants en fonction du logiciel utilisé : + +**Plesk** + +> [!api] +> +> @api {v1} /license/plesk GET /license/plesk/{serviceName}/canLicenseBeMovedTo +> + +**cPanel** + +> [!api] +> +> @api {v1} /license/cpanel GET /license/cpanel/{serviceName}/canLicenseBeMovedTo +> + +![Licence API](images/getlicense.png){.thumbnail} + +Entrez les paramètres comme suit : + +- `serviceName` : Renseignez le nom interne de votre licence (voir la section `Licences` dans votre [espace client OVHcloud](/links/manager)). +- `destinationIp` : Renseignez l'adresse IPv4 du service de destination. + +Cliquez sur le bouton `EXECUTE`{.action}. + +Si le résultat est négatif (`false`), la raison sera indiquée dans le champ `RESPONSE`. + +![Licence API](images/getlicense_response.png){.thumbnail} + +Si l'adresse IP de destination est compatible avec votre licence (`true`), vous pouvez utiliser l'appel correspondant pour la déplacer : + +**Plesk** + +> [!api] +> +> @api {v1} /license/plesk POST /license/plesk/{serviceName}/changeIp +> + +**cPanel** + +> [!api] +> +> @api {v1} /license/cpanel POST /license/cpanel/{serviceName}/changeIp +> + +/// + + +## Questions sur la sécurité et la sauvegarde + +/// details | Comment sécuriser mon VPS ? + +Par défaut, seul le système d’exploitation sélectionné est installé sur le VPS. L’administrateur du VPS est responsable de l’application d’une configuration de sécurité appropriée une fois le VPS livré. + +Pour cela, aidez-vous de notre guide « [Sécuriser un VPS](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps) ». + +/// + +/// details | Comment puis-je télécharger mes fichiers ou une sauvegarde du VPS ? + +Plusieurs possibilités s'offrent à vous, par exemple : + +- Téléchargement via SFTP : Connectez-vous à votre VPS avec un logiciel client SFTP (par exemple [FileZilla](/pages/bare_metal_cloud/dedicated_servers/comment-deposer-ou-recuperer-des-donnees-sur-un-serveur-dedie-via-sftp)), puis transférez tous les fichiers du répertoire racine du système. +- Téléchargement via `rsync` (outil en ligne de commande) : Utilisez la commande `rsync -avz -e ssh username@vps_ip_address:/ /local_directory/` pour télécharger tous les fichiers et dossiers de votre VPS. +- Téléchargement via l'option **Backup automatisé** : Suivez notre guide sur [l'utilisation des sauvegardes automatisées sur un VPS](/pages/bare_metal_cloud/virtual_private_servers/using-automated-backups-on-a-vps) pour télécharger des fichiers à partir d'une sauvegarde. +- Téléchargement via l'option **Snapshot** : Suivez notre guide sur [l'utilisation des snapshots sur un VPS](/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps) pour télécharger un snapshot du VPS. + +/// + +/// details | Comment puis-je télécharger mon VPS en tant que fichier VM ? + +Il n'est pas possible de télécharger un fichier VM d'un VPS OVHcloud. Vous pouvez cependant utiliser l’option **Snapshot** de votre VPS depuis votre espace client OVHcloud pour récupérer un fichier image. + +Suivez notre guide « [Utiliser les snapshots sur un VPS](/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-VPS) » pour créer et télécharger un snapshot du VPS. + +Vous pouvez ensuite convertir localement le fichier de snapshot téléchargé dans un format correspondant à vos besoins. + +Envisagez de contacter l'un de nos [partenaires](/links/partner) pour obtenir de l'aide. + +/// + +/// details | Comment accéder à mon Backup Storage depuis une adresse IP extérieure à mon service ? + +L'accès au Backup Storage de votre VPS (stockage FTP) peut être limité aux adresses IP liées à un service au sein de votre compte client OVHcloud. + +Afin d’autoriser l’accès depuis d’autres adresses IP, vous pouvez utiliser l'API OVHcloud. +Cela vous permettra de récupérer vos données de sauvegarde depuis un service différent via différents protocoles (FTP, NFS, CIFS). > [!warning] > Seules les adresses IP OVHcloud peuvent être autorisées. > -Connectez-vous à la [console API OVHcloud](/links/api) avec les identifiants de votre compte client et utilisez l'appel suivant : +Connectez-vous à la [console API OVHcloud](/links/console) avec les identifiants de votre compte client et utilisez l'appel suivant : > [!api] > @@ -96,23 +409,58 @@ Connectez-vous à la [console API OVHcloud](/links/api) avec les identifiants de Modifiez les paramètres comme suit : -- `serviceName` : renseignez le nom interne de votre VPS (`vps-x11x11xyy.vps.ovh.net`). -- `cifs` : définissez ce paramètre sur `true` si vous utilisez ce protocole. -- `ftp` : définissez ce paramètre sur `true` si vous utilisez ce protocole. -- `ipBlock` : renseignez l'adresse IP qui y aura accès, sous la forme `203.0.113.100/32`. -- `nfs` : définissez ce paramètre sur `true` si vous utilisez ce protocole. +- `serviceName` : Renseignez le nom interne de votre VPS (`vps-x11x11xyy.vps.ovh.net`). +- `cifs` : Défini sur `true` le cas échéant. +- `ftp` : Défini sur `true` le cas échéant. +- `ipBlock` : Renseignez l'adresse IP qui y aura accès, sous la forme `203.0.113.100/32`. +- `nfs` : Défini sur `true` le cas échéant. Cliquez sur le bouton `EXECUTE`{.action}. -Afin de vérifier que votre adresse IP est bien autorisée, utilisez l'appel suivant : +Pour vérifier que votre adresse IP est autorisée, utilisez l'appel suivant : > [!api] > > @api {v1} /vps GET /vps/{serviceName}/backupftp/access > +/// + + +/// details | Mon VPS est-il protégé contre les attaques externes ? + +Bien qu’OVHcloud applique des mesures de sécurité pour protéger l’ensemble de l’infrastructure, l’administrateur d’un VPS est responsable de la sécurité des applications et des données qui y sont hébergées. + +- Suivez notre guide « [Comment configurer le Edge Network Firewall OVHcloud](/pages/bare_metal_cloud/dedicated_servers/firewall_network) », service intégré à notre infrastructure Anti-DDoS afin de limiter l'exposition de vos services aux attaques DDoS. +- De plus, vous pouvez utiliser nos guides : + - [Configurer le pare-feu sous Linux avec Iptables](/pages/bare_metal_cloud/virtual_private_servers/firewall-Linux-iptable) + - [Configurer le pare-feu sous Windows](/pages/bare_metal_cloud/virtual_private_servers/activate-port-firewall-soft-win). +- Pour les distributions Linux sur un VPS, vous pouvez suivre les instructions de notre guide « [Sécuriser un VPS](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps) » pour appliquer des mesures de sécurité supplémentaires. + +/// + +/// details | Comment sécuriser mon VPS contre les attaques DDoS ? + +OVHcloud fournit plusieurs fonctionnalités de sécurité pour protéger votre VPS contre le trafic malveillant : + +- Protection anti-DDoS : Nos services VPS sont protégés par défaut par notre [infrastructure anti-DDoS](/links/security/antiddos) qui détecte et mitige les attaques DDoS en temps réel. +- Blocage d'adresses IP : Vous pouvez [empêcher des adresses IP ou plages d’adresses IP spécifiques](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps) d’atteindre votre VPS. +- Règles de pare-feu : Vous pouvez [configurer des règles de pare-feu personnalisées](/pages/bare_metal_cloud/dedicated_servers/firewall_network) pour contrôler le trafic entrant et sortant directement sur votre VPS. +- VAC (VPS Anti-DDoS) : Notre système VAC fournit une couche supplémentaire de protection contre les attaques DDoS, y compris le filtrage du trafic et la limitation du débit. + +/// + +/// details | Je souhaite utiliser un VPS comme serveur de jeu, bénéficiera-t-il du même pare-feu que celui qui protège les serveurs dédiés Game ? + +La protection anti-DDoS Game d’OVHcloud est disponible uniquement pour nos serveurs dédiés Game. Si vous commandez un VPS pour l’hébergement de jeux, vous devrez configurer le pare-feu directement sur votre système, en fonction du jeu souhaité. Retrouvez plus d'informations dans notre guide sur [la configuration du pare-feu sous Linux avec Iptables](/pages/bare_metal_cloud/virtual_private_servers/firewall-Linux-iptable). + +L’avantage d’un VPS par rapport à un serveur dédié est la possibilité d’adapter ses ressources à votre utilisation réelle. Vous pouvez faire évoluer votre VPS en quelques clics pour bénéficier d’un système plus performant. + +/// + + ## Aller plus loin Si vous souhaitez bénéficier d'une assistance à l'usage et à la configuration de vos solutions OVHcloud, nous vous proposons de consulter nos différentes [offres de support](/links/support). -Échangez avec notre [communauté d'utilisateurs](/links/community). \ No newline at end of file +Échangez avec notre [communauté d'utilisateurs](/links/community). diff --git a/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.it-it.md b/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.it-it.md index 687231f4c80..955d8bd1c70 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.it-it.md +++ b/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.it-it.md @@ -1,124 +1,458 @@ --- -title: FAQ VPS OVHcloud -updated: 2025-08-07 +title: "FAQ su VPS OVHcloud" +excerpt: "Trovate le risposte alle domande più frequenti sulle nostre offerte VPS" +updated: 2025-10-30 --- -## FAQ VPS + -### Cos'è un VPS e a cosa serve? +## Domande generali sulle offerte VPS -Un VPS è un server virtuale (Virtual Private Server) su cui è possibile caricare siti (vetrina, e-commerce, contenuti, media...) e applicazioni software (portali, extranet, soluzioni collaborative, wiki, CRM...). Diversamente dall'hosting condiviso, permette di isolare i dati in una macchina virtuale dedicata al cliente. +/// details | Cos'è un VPS e a cosa viene utilizzato? -I VPS costituiscono il compromesso perfetto tra hosting Web e server fisici: combinano l'affidabilità e le performance di un ambiente dedicato e al tempo stesso permettono di liberarsi dal pensiero della gestione hardware. +Un server privato virtuale (VPS) viene utilizzato per ospitare siti web (e-commerce, contenuti, media visivi) e applicazioni software (portali, extranet, soluzioni collaborative, wiki, CRM). A differenza dell'hosting condiviso, un VPS offre un ambiente isolato, dedicato al cliente. Le nostre soluzioni VPS colmano il divario tra l'hosting web condiviso e i server dedicati, combinando prestazioni e affidabilità senza il peso della gestione dell'hardware. Potrai anche aggiornare facilmente la tua configurazione senza dover cambiare server. -### Come scegliere tra VPS e hosting Web? +/// -Il VPS rappresenta un’evoluzione logica alle soluzioni di hosting Web. Garantisce maggiori possibilità e libertà d’azione relativamente a configurazione, accesso e funzionalità (root, Apache, file PHP.init). Permette inoltre di installare certificati SSL e qualsiasi altro tipo di software. +/// details | Quali sono i vantaggi di un VPS OVHcloud? -È però fondamentale scegliere il VPS con la massima attenzione, optando per la configurazione più adatta alle esigenze delle applicazioni utilizzate e modificandola in base alla crescita del proprio progetto. +Le offerte VPS OVHcloud offrono un ottimo rapporto qualità/prestazione, con traffico illimitato e diverse localizzazioni globali per una latenza ridotta e una maggiore accessibilità, a seconda delle tue esigenze. -### Quali sono i vantaggi di un VPS rispetto a un server dedicato? +/// -I VPS offrono il vantaggio di liberare l’utente da pensieri legati alla gestione hardware (ad esempio monitoraggio dello stato di dischi, RAM e CPU) e sono adatti alla maggior parte degli utilizzi Web, per progetti di dimensioni contenute. -I server dedicati sono consigliati per gestire in autonomia l’aspetto hardware, costruire architetture elaborate, creare infrastrutture con rete privata (vRack) integrata, implementare soluzioni complesse diverse dai servizi Web. +/// details | Una soluzione VPS è la scelta giusta per me? -In generale, si può affermare che gli utenti con un’attività Web in crescita si evolvono verso server dedicati o soluzioni Public Cloud: questi servizi offrono infrastrutture più complesse e flessibili, adeguate a una forte crescita. +Utilizzare un VPS richiede conoscenze di base nella gestione dei server. È fondamentale tenerne conto per gestire efficacemente il tuo sistema operativo (Linux o Windows) e configurare le tue applicazioni, come ad esempio PrestaShop o WordPress. -### Quali sono le differenze tra le soluzioni VPS e Public Cloud? +Se hai bisogno di un VPS ma ti mancano le competenze tecniche per gestirlo, valuta l'opzione di contattare uno dei nostri [partner](/links/partner) per ottenere assistenza. -Il VPS è una soluzione adatta ad ambienti di preproduzione e produzione che richiedono prestazioni costanti. -Il Public Cloud di OVHcloud propone invece un'infrastruttura multiserver con macchine high availability e con rete privata vRack disponibile. +Se hai bisogno di risorse allocate ma preferisci non occuparti della gestione del server, ti consigliamo di optare per i nostri piani di hosting web Performance. -### Come scegliere il proprio VPS OVHcloud? +/// -Per scegliere un VPS adatto alle proprie esigenze, ti consigliamo di verificare: +/// details | Posso facilmente aggiornare il mio VPS a un livello superiore o declassarlo a una configurazione inferiore? -- la quantità di risorse necessarie (processore, memoria, spazio disco, banda passante...). -- il sistema operativo richiesto (Linux o Windows). -- i prerequisiti tecnici essenziali per il corretto funzionamento dell'applicazione (ad esempio, un database richiede velocità in lettura/scrittura). +Sì, puoi aggiornare la tua configurazione dal pannello di controllo OVHcloud senza dover migrare manualmente i tuoi dati. Le opzioni di aggiornamento disponibili dipendono dalla gamma e dal modello del VPS. -Per effettuare questa operazione, scegli tra le nostre soluzioni VPS: +Tuttavia, per declassare la tua configurazione, dovrai sottoscrivere un nuovo piano, trasferire i tuoi dati e poi annullare il vecchio servizio. Il nostro team di supporto è a disposizione per assisterti se necessario. -- **VPS Starter**: macchine entry level per testare la nostra offerta (esclusivamente con distribuzione Linux). -- **VPS Value, Essential e Comfort**: ideali per l'hosting di siti Web, servizi di e-commerce o sistemi di monitoring. -- **VPS Elite**: adattato a siti e-commerce e applicazioni che richiedono molte risorse CPU e memoria. -- **VPS Limited Edition** (Quantità limitate): i VPS offrono performance potenziate, una risorsa importante per l'hosting di siti complessi, applicazioni che richiedono molte risorse o anche server di gioco. Questa offerta è valida fino a esaurimento delle scorte. +/// -> [!primary] -> Puoi far evolvere un VPS Limited Edition verso un altro VPS della stessa gamma ma, per ragioni tecniche, non è possibile far evolvere un VPS Limited Edition verso un VPS di un'altra gamma (Starter, Value, Essential o Comfort). +/// details | Quale regione o paese dovrei scegliere per il mio VPS? -### Chi può utilizzare un VPS? +Più il data center è vicino al tuo pubblico, minore sarà la latenza, garantendo una migliore esperienza utente e una maggiore fiducia nei tuoi servizi. -L’utilizzo di un VPS richiede competenze di base in amministrazione di server. Queste nozioni sono essenziali per gestire il sistema operativo (Linux o Windows) installato sulla macchina e configurare le applicazioni. Come fare per utilizzare un VPS senza possedere le competenze necessarie? È possibile contattare uno dei nostri [partner](/links/partner). +/// -Per usufruire di risorse garantite anche senza conoscenze specifiche nell'amministrazione di server, ti consigliamo di optare per i nostri [hosting Web Performance](/links/web/hosting-performance-offer). +/// details | Qual è il vantaggio di un VPS ubicato in Europa? -### Come connettermi al tuo VPS? +Ospitare il tuo VPS con OVHcloud in Francia o in generale nell'UE offre vantaggi come prezzi competitivi e una maggiore protezione dei dati. Il tuo servizio non è soggetto al CLOUD Act statunitense, proteggendolo da ingerenze non europee. -È possibile connettersi a distanza al VPS grazie alle credenziali fornite via email dopo la consegna del servizio. -Il metodo di connessione dipende dai sistemi operativi utilizzati. +/// -Per maggiori informazioni, consulta la guida Iniziare [a utilizzare un VPS](/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps). +/// details | I backup sono inclusi con il mio VPS? -### È possibile ospitare più siti Internet su un VPS? +Sì, quando ordini un VPS, è incluso un'opzione di backup giornaliero gratuito. -Sì, un VPS può essere suddiviso in partizioni e organizzato in base a necessità specifiche. Può essere utilizzato per ospitare più siti o progetti, assegnando a ciascuno uno spazio privato di dimensioni definite. Per semplificare queste operazioni è possibile installare un’interfaccia di gestione di siti Web, come Plesk o cPanel. +Per una protezione ancora migliore, puoi anche optare per la nostra opzione di backup Premium. Questa offre: -### Viene eseguito regolarmente un backup del VPS? +- La possibilità di ripristinare un backup fino a una settimana indietro. +- La possibilità di pianificare i backup, ottimizzando la gestione dei dati e minimizzando l'impatto sulle operazioni aziendali. -È consigliabile adottare una strategia di backup adeguata in base alla sensibilità dei dati. -Per maggiori informazioni sulle opzioni disponibili, consulta la nostra [pagina Web sui VPS](/links/bare-metal/vps-options). +Inoltre, offriamo: -### Come proteggere un VPS? +- Snapshot: puoi creare snapshot manuali e istantanei che catturano lo stato esatto del tuo VPS prima di un aggiornamento o modifica critica. +- Backup esterno: archivia i tuoi dati su un disco separato e sicuro, permettendo un facile ripristino in caso di incidenti gravi. -Il VPS è fornito di default come "nudo", senza alcuna configurazione di sicurezza. E' la prima cosa che devi fare al ricevimento. -Per effettuare questa operazione, consulta la guida ["Mettere in sicurezza un VPS"](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps). +Utilizzando queste soluzioni, puoi personalizzare la gestione dei backup in base alle tue esigenze di sicurezza e continuità aziendale. -### Qual è la banda passante assegnata al tuo VPS? È garantita? +Visita la nostra [pagina web dei VPS](/links/bare-metal/vps) per saperne di più sulle opzioni disponibili. -La banda passante indicata nel nostro sito Web è garantita e si riferisce alla velocità di trasmissione minima assegnata. +/// -### Qual è lo SLA applicato sul tuo VPS? +/// details | Posso ospitare più siti web su un VPS? -Su tutte le gamme VPS, OVHcloud propone uno SLA del 99,9%. +Sì, un VPS può essere configurato per ospitare più siti web o progetti. Puoi dividere lo spazio di archiviazione secondo le tue necessità e utilizzare interfacce specializzate come Plesk o cPanel per semplificare la gestione dei tuoi siti. -### Come accedere al backup storage da un indirizzo IP diverso dal mio servizio? +/// -L'accesso al backup FTP può essere limitato al servizio associato tramite lo Spazio Cliente OVHcloud. +/// details | Riceverò un nome di dominio e un servizio email incluso con il mio VPS? -Per autorizzare indirizzi IP aggiuntivi da cui accedere al Backup Storage, utilizza l’API OVHcloud. -Questo ti permetterà di recuperare i tuoi backup di dati da un servizio differente tramite diversi protocolli (FTP, NFS, CIFS). +No, le nostre soluzioni VPS non includono un nome di dominio o un servizio email. Questi servizi possono essere ordinati separatamente nel pannello di controllo OVHcloud. + +/// + +/// details | Come scelgo tra un VPS e un piano di hosting web? + +**Piano di hosting web** + +- Deale per esigenze di hosting di base con una configurazione predefinita. + +**VPS** + +- Maggiore flessibilità e controllo, perfetto per progetti scalabili con esigenze di configurazione complesse. + +Ospitare servizi web su un VPS ti consente di installare il software preferito, personalizzare le impostazioni del server e ospitare più siti web con risorse dedicate. Si prega di notare che un VPS deve essere configurato in modo adatto alle tue esigenze di applicazione e adattato alla crescita della tua attività. + +/// + +/// details | Qual è la differenza tra un VPS e le soluzioni Public Cloud? + +**VPS** + +- Macchina virtuale dedicata e ottimizzata adatta sia alla pre-produzione che alla produzione, progettata per ospitare più progetti web. + +**OVHcloud Public Cloud** + +- Offre un'infrastruttura multi-server con alta disponibilità e rete privata (vRack), progettata per architetture complesse e scalabili. + +/// + +/// details | Quali sono i vantaggi di un VPS rispetto a un server dedicato? + +**VPS** + +- Offre una gestione semplificata senza manutenzione hardware, ideale per progetti che richiedono un controllo stretto. + +**Server dedicato** + +- Consigliato per infrastrutture complesse che richiedono il pieno controllo dell'hardware e prestazioni garantite. + +Un VPS elimina la necessità di gestire hardware fisico come archiviazione, RAM e CPU, rendendolo adatto per la maggior parte delle applicazioni web. Man mano che la tua attività cresce, puoi aggiornare il tuo VPS o migrare verso un server dedicato o una soluzione Public Cloud per un'infrastruttura più flessibile e potente. + +/// + +/// details | Quale larghezza di banda è allocata al mio VPS? È garantita? + +La larghezza di banda indicata nella nostra [pagina web dei VPS](/links/bare-metal/vps) è garantita. Si tratta della quantità minima allocata al tuo servizio. + +/// + +/// details | Quale SLA si applica al mio VPS? + +Un VPS OVHcloud include un SLA del 99,9%. + +/// + + +/// details | Quali sono le caratteristiche uniche di un VPS Local Zone? + +Con un VPS Local Zone, puoi ridurre significativamente i tempi di accesso ai tuoi siti e applicazioni, poiché i tuoi dati vengono ospitati più vicino ai tuoi utenti. Ciò crea una migliore esperienza utente riducendo la latenza ogni volta che le applicazioni richiedono un tempo di risposta minimizzato. Basta selezionare una delle nostre sedi in tutto il mondo al momento dell'ordine. + +Tieni presente che un VPS Local Zone, a differenza di un VPS regolare, non include funzionalità di sicurezza come Anti-DDoS o opzioni avanzate come Additional IP e Load Balancer. + +Un VPS Local Zone soddisfa anche le esigenze di progetti con requisiti di residenza e sovranità dei dati. Ospitando i tuoi servizi in una regione specifica, puoi facilmente soddisfare le normative locali relative all'elaborazione e archiviazione dei dati, come il GDPR europeo. + +/// + +/// details | Posso migrare il mio VPS da una Local Zone a un data center e viceversa? + +No, non puoi migrare direttamente i servizi. Dovrai sottoscrivere il VPS scelto, trasferire i tuoi dati e poi annullare il vecchio servizio. Il nostro team di supporto può guidarti attraverso questi passaggi se necessario. + +/// + +/// details | Quali sono i rischi dell'utilizzo di un VPS senza protezione DDoS? + +I server privati virtuali senza protezione Anti-DDoS sono esposti automaticamente agli attacchi distribuiti di negazione del servizio (DDoS), potenzialmente causando interruzioni del servizio e gravi violazioni della sicurezza. + +- Esposizione diretta: se il tuo server è bersaglio di un attacco DDoS, l'afflusso di richieste maliziose potrebbe sopraffarlo, rendendo i tuoi siti e applicazioni inaccessibili. +- Nessun mitigazione automatica: per proteggere il tuo server, dovrai difenderlo utilizzando software di sicurezza di terze parti o configurazioni specifiche. +- Ulteriore carico di gestione: la mancanza di una sicurezza robusta e integrata presenta un rischio significativo, evidenziando la necessità di un monitoraggio vigile e strategie proattive, in particolare per progetti ad alto traffico. + +Se la resilienza agli attacchi DDoS è un fattore critico per il tuo progetto, ti consigliamo di optare per un VPS OVHcloud ospitato in uno dei nostri data center, che include una protezione integrata. + +/// + +## Domande relative all'amministrazione del VPS + +/// details | Come posso accedere al mio VPS? + +Puoi accedere al tuo VPS in remoto utilizzando le credenziali fornite via email dopo la consegna del servizio. +Il metodo di connessione dipende dal sistema operativo in uso. + +Tutti i dettagli sono riportati nella nostra guida su [come iniziare con un VPS](/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps). + +/// + +/// details | OVHcloud fornisce assistenza per la configurazione del software del mio VPS? + +Sebbene non possiamo offrire assistenza per la configurazione o l'amministrazione del software, forniamo alcuni strumenti e risorse per aiutarti a iniziare. + +Ad esempio, offriamo una gamma di modelli e immagini preconfigurati per sistemi operativi e applicazioni popolari per aiutarti a distribuire rapidamente il tuo VPS. Inoltre, forniamo il pannello di controllo OVHcloud, dove puoi gestire il tuo VPS, incluse attività come riavvio, reinstallazione e monitoraggio delle risorse. + +Inoltre, la nostra documentazione e la knowledge base contengono una vasta gamma di informazioni sulla configurazione e gestione del tuo VPS. + +Tuttavia, per assistenza specifica alla configurazione del software, ti consigliamo di contattare la nostra [community](/links/community) o di cercare l'aiuto di un amministratore di sistema o sviluppatore qualificato tramite il nostro [portale partner](/links/partner). + +/// + +/// details | Posso installare più di un sistema operativo sul mio VPS? + +I modelli di installazione OVHcloud consentono solo un singolo sistema operativo. +Le configurazioni personalizzate possono essere applicate dal lato del cliente e sono responsabilità dell'amministratore del server. I servizi OVHcloud non includono attività di amministrazione, come la configurazione del software o l'uso di strumenti esterni. + +Se incontri problemi di configurazione e amministrazione, ti consigliamo di contattare la nostra [community](/links/community) o di cercare l'aiuto di un amministratore di sistema o sviluppatore qualificato tramite il nostro [portale partner](/links/partner). + +/// + +/// details | Posso installare macchine virtuali su un VPS utilizzando software di virtualizzazione (come Proxmox)? + +I modelli di installazione OVHcloud per VPS non includono il sistema operativo Proxmox o un sistema operativo simile per la virtualizzazione. + +Le configurazioni personalizzate possono essere applicate dal lato del cliente e sono responsabilità dell'amministratore del server. I servizi OVHcloud non includono attività di amministrazione, come la configurazione del software o l'uso di strumenti esterni. + +Se incontri problemi di configurazione e amministrazione, ti consigliamo di contattare la nostra [community](/links/community) o di cercare l'aiuto di un amministratore di sistema o sviluppatore qualificato tramite il nostro [portale partner](/links/partner). + +/// + +/// details | È possibile scegliere l'hardware del tuo VPS (GPU, CPU, ecc.) o effettuarne l'upgrade? + +Un VPS non può essere personalizzato o modificato a livello hardware. +Seleziona un [modello VPS](/links/bare-metal/vps) nel processo d’ordine che soddisfi i tuoi requisiti minimi, poi puoi aggiornarlo in base alle tue necessità. + +/// + +/// details | Il mio VPS è troppo lento, posso spostarlo su un altro host? + +Per risolvere i problemi di prestazioni del tuo VPS, dovrai fornire risultati di test specifici al nostro team di supporto. + +Nota che il tuo VPS deve essere avviato in [modalità di recupero](/pages/bare_metal_cloud/virtual_private_servers/rescue) per escludere eventuali problemi software. + +Contatta il nostro team di supporto [creando una richiesta nel Centro assistenza di OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help) affinché possiamo fornirti l'elenco completo dei test richiesti per una valutazione corretta. + +/// + +/// details | Ho ordinato un nuovo VPS, posso trasferire il tempo residuo della sottoscrizione del mio vecchio VPS o ottenerne un rimborso? + +Questo è generalmente possibile ma il processo richiede una [richiesta al nostro team di supporto tramite il Centro assistenza di OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help). + +Prima di procedere, assicurati di aver [migrato i dati ancora necessari](/pages/bare_metal_cloud/dedicated_servers/migrate_a_server_to_another) al tuo nuovo servizio o di aver creato backup dei tuoi dati. + +/// + +/// details | Posso spostare il mio VPS in un diverso data center OVHcloud in un paese diverso? + +Non è possibile migrare un VPS in un altro data center. Per ottenere questo risultato, puoi eseguire una [migrazione manuale](/pages/bare_metal_cloud/dedicated_servers/migrate_a_server_to_another): + +- Scarica i tuoi dati dal VPS corrente. +- Ordina un nuovo VPS. +- Carica i tuoi dati sul nuovo VPS. +- [Annulla il vecchio VPS](/pages/account_and_service_management/managing_billing_payments_and_services/how_to_cancel_services). + +/// + +/// details | Quanti Indirizzi Additional IP posso configurare su un VPS? + +Un VPS è limitato a [16 Indirizzi Additional IP](/links/network/additional-ip). + +Consulta la nostra guida su [come configurare l'aliasing IP](/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing) per esempi di configurazione degli indirizzi IP. + +/// + +/// details | Posso aggiungere blocchi IP al mio VPS? + +Non è possibile aggiungere blocchi IP a un VPS. +Puoi configurare fino a [16 Indirizzi Additional IP](/links/network/additional-ip) su un VPS. + +/// + +/// details | Posso modificare il VPS associato alla mia licenza (Plesk, cPanel)? + +Le licenze possono essere spostate tra server ma esistono limitazioni. + +L'opzione migliore è accedere alla nostra [console API](/links/api) con le credenziali del tuo account cliente e verificare se la tua licenza può essere spostata su un diverso VPS. Trova le basi nella nostra guida su [come iniziare con l'API di OVHcloud](/pages/manage_and_operate/api/first-steps). + +Una volta connesso, utilizza le seguenti chiamate in base al software utilizzato: + +**Plesk** + +> [!api] +> +> @api {v1} /license/plesk GET /license/plesk/{serviceName}/canLicenseBeMovedTo +> + +**cPanel** + +> [!api] +> +> @api {v1} /license/cpanel GET /license/cpanel/{serviceName}/canLicenseBeMovedTo +> + +![API license](images/getlicense.png){.thumbnail} + +Inserisci i parametri come segue: + +- `serviceName`: Inserisci il nome interno della tua licenza (vedi la sezione `Licenze` nel tuo [Spazio Cliente OVHcloud](/links/manager)). +- `destinationIp`: Inserisci l'indirizzo IPv4 del servizio di destinazione. + +Clicca sul pulsante `EXECUTE`{.action}. + +Se il risultato è negativo (`false`), la motivazione sarà inclusa nel campo `RESPONSE`. + +![API license](images/getlicense_response.png){.thumbnail} + +Se l'indirizzo IP di destinazione è compatibile con la tua licenza (`true`), puoi utilizzare la chiamata corrispondente per spostarla: + +**Plesk** + +> [!api] +> +> @api {v1} /license/plesk POST /license/plesk/{serviceName}/changeIp +> + +**cPanel** + +> [!api] +> +> @api {v1} /license/cpanel POST /license/cpanel/{serviceName}/changeIp +> + +/// + + +## Domande relative alla sicurezza e al backup + +/// details | Come posso proteggere il mio VPS? + +Per impostazione predefinita, il VPS viene fornito con solo il sistema operativo selezionato installato. L'amministratore del VPS è responsabile dell'applicazione di una configurazione di sicurezza appropriata una volta consegnato il VPS. +Per farlo, si prega di fare riferimento alla nostra guida su [come proteggere un VPS](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps). + +/// + +/// details | Come posso scaricare i miei file o un backup del VPS? + +Sono disponibili diverse opzioni, ad esempio: + +- Scarica via SFTP: Connetti il tuo VPS con un client software in grado di utilizzare SFTP (ad esempio [FileZilla](/pages/bare_metal_cloud/dedicated_servers/comment-deposer-ou-recuperer-des-donnees-sur-un-serveur-dedie-via-sftp)), quindi trasferisci tutti i file nella directory radice del sistema. +- Scarica via `rsync` (strumento da riga di comando): Utilizza il comando `rsync -avz -e ssh username@vps_ip_address:/ /local_directory/` per scaricare tutti i file e le cartelle dal tuo VPS. +- Scarica tramite l'opzione **Backup automatico**: Segui la nostra guida su [come utilizzare i backup automatici su un VPS](/pages/bare_metal_cloud/virtual_private_servers/using-automated-backups-on-a-vps) per scaricare file da un backup. +- Scarica tramite l'opzione **Snapshot**: Segui la nostra guida su [come utilizzare gli snapshot su un VPS](/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps) per scaricare uno snapshot del VPS. + +/// + +/// details | Come posso scaricare il mio VPS come file VM? + +Non è possibile scaricare un file VM di un VPS di OVHcloud. Tuttavia, puoi utilizzare l'opzione **Snapshot** del tuo VPS nel [Spazio Cliente OVHcloud](/links/manager) per recuperare un file immagine. + +Segui la nostra guida su [come utilizzare gli snapshot su un VPS](/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps) per creare e scaricare uno snapshot del VPS. + +Puoi quindi convertire localmente il file snapshot scaricato in un formato corrispondente alle tue esigenze. + +Considera di contattare uno dei nostri [partner](/links/partner) per ulteriore assistenza. + +/// + +/// details | Come posso accedere al mio storage di backup da un indirizzo IP esterno al mio servizio? + +L'accesso allo storage di backup del tuo VPS (FTP storage) potrebbe essere limitato agli indirizzi IP collegati a un servizio nel tuo account cliente OVHcloud. + +Per aggiungere altri indirizzi IP da cui accedere, puoi utilizzare l'API di OVHcloud. +Questo ti permetterà di recuperare i tuoi dati di backup da un servizio diverso tramite vari protocolli (FTP, NFS, CIFS). > [!warning] -> Possono essere autorizzati solo gli indirizzi IP OVHcloud. +> Solo gli indirizzi IP di OVHcloud possono essere autorizzati. > -Accedi alla [console API OVHcloud](/links/api) con le credenziali del tuo account cliente e utilizza la chiamata seguente: +Accedi alla [console API di OVHcloud](/links/api) con le credenziali del tuo account cliente e utilizza la seguente chiamata: > [!api] > > @api {v1} /vps POST /vps/{serviceName}/backupftp/access > -Modificare le impostazioni come indicato di seguito: +Modifica i parametri come segue: -- `serviceName`: inserisci il nome interno del tuo VPS (`vps-x11x11xyy.vps.ovh.net`). -- `cifs`: se utilizzate questo protocollo, impostate questo parametro su `true`. -- `ftp`: se utilizzate questo protocollo, impostate questo parametro su `true`. -- `ipBlock`: inserisci l’indirizzo IP che vi avrà accesso, nella forma `203.0.113.100/32`. -- `nfs`: se utilizzate questo protocollo, impostate questo parametro su `true`. +- `serviceName`: Inserisci il nome interno del tuo VPS (`vps-x11x11xyy.vps.ovh.net`). +- `cifs`: Imposta su `true` se applicabile. +- `ftp`: Imposta su `true` se applicabile. +- `ipBlock`: Inserisci l'indirizzo IP che avrà accesso, nel formato `203.0.113.100/32`. +- `nfs`: Imposta su `true` se applicabile. Clicca sul pulsante `EXECUTE`{.action}. -Per verificare che il tuo indirizzo IP sia autorizzato, utilizza questa chiamata: +Per verificare che il tuo indirizzo IP sia autorizzato, utilizza la seguente chiamata: > [!api] > > @api {v1} /vps GET /vps/{serviceName}/backupftp/access > +/// + + +/// details | Il mio VPS è protetto dagli attacchi esterni? + +Sebbene OVHcloud applichi misure di sicurezza per proteggere l'intera infrastruttura, l'amministratore di un VPS è responsabile della sicurezza delle applicazioni e dei dati ospitati su di esso. + +- Segui la nostra guida su [come configurare il firewall della rete Edge di OVHcloud](/pages/bare_metal_cloud/dedicated_servers/firewall_network) integrato nella nostra infrastruttura Anti-DDoS, limitando l'esposizione dei tuoi servizi agli attacchi DDoS. +- Inoltre, puoi utilizzare le nostre guide su [come configurare il tuo firewall](/pages/bare_metal_cloud/virtual_private_servers/firewall-Linux-iptable) con `iptables` su distribuzioni basate su Linux e [come abilitare il firewall su Windows](/pages/bare_metal_cloud/virtual_private_servers/activate-port-firewall-soft-win). +- Per distribuzioni basate su Linux su un VPS, puoi seguire le istruzioni nella nostra guida su [come proteggere un VPS](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps) per applicare misure di sicurezza aggiuntive. + +/// + +/// details | Come posso proteggere il mio VPS dagli attacchi DDoS? + +OVHcloud fornisce diverse funzionalità di sicurezza per proteggere il tuo VPS dal traffico dannoso: + +- Protezione Anti-DDoS: I nostri servizi VPS sono protetti di default dalla nostra [infrastruttura Anti-DDoS](/links/security/antiddos) che rileva e mitiga gli attacchi DDoS in tempo reale. +- Blocco IP: Puoi [prevenire l'accesso da indirizzi IP specifici o da intervalli di IP](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps) al tuo VPS. +- Regole del firewall: Puoi [configurare regole personalizzate del firewall](/pages/bare_metal_cloud/dedicated_servers/firewall_network) per controllare il traffico in entrata e in uscita direttamente sul tuo VPS. +- VAC (VPS Anti-DDoS): Il nostro sistema VAC fornisce un ulteriore livello di protezione dagli attacchi DDoS, incluso il filtraggio del traffico e il limitatore di velocità. + +/// + +/// details | Voglio utilizzare un VPS come server per giochi, beneficerà dello stesso firewall che protegge i Game Dedicated Servers? + +La protezione Anti-DDoS per i server di gioco di OVHcloud è disponibile solo per i nostri Game Dedicated Servers. Se ordini un VPS per l'hosting di giochi, dovrai configurare il firewall direttamente sul tuo sistema, personalizzato in base al gioco desiderato. Puoi trovare ulteriori informazioni nella nostra guida su [come configurare il firewall su Linux con iptables](/pages/bare_metal_cloud/virtual_private_servers/firewall-Linux-iptable). + +Il vantaggio di un VPS rispetto a un server dedicato è la possibilità di scalare le sue risorse in base all'utilizzo effettivo. Puoi aggiornare il tuo VPS con pochi clic per beneficiare di un sistema più potente. + +/// + ## Per saperne di più Per usufruire di un supporto per l'utilizzo e la configurazione delle soluzioni OVHcloud, è possibile consultare le nostre soluzioni [offerte di supporto](/links/support). -Contatta la nostra [Community di utenti](/links/community). \ No newline at end of file +Contatta la nostra [Community di utenti](/links/community). diff --git a/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.pl-pl.md b/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.pl-pl.md index 9485f21ea1d..3690810aaf4 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.pl-pl.md +++ b/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.pl-pl.md @@ -1,126 +1,459 @@ --- -title: FAQ VPS OVHcloud -updated: 2025-08-07 +title: "OVHcloud VPS - często zadawane pytania" +excerpt: "Znajdź odpowiedzi na najczęściej zadawane pytania dotyczące ofert VPS" +updated: 2025-10-30 --- -## FAQ VPS + -### Do czego służy serwer? +## Ogólne pytania dotyczące oferty VPS -VPS to serwer wirtualny (Virtual Private Server), na którym można instalować strony WWW (witryny, serwisy e-commerce, treści...) oraz aplikacje (portale wewnątrzfirmowe, rozwiązania do pracy zespołowej, wiki, CRM, ...). - W przeciwieństwie do hostingu, VPS umożliwia odizolowanie od siebie kilku aplikacji utrzymywanych na jednej wirtualnej maszynie, która należy do jednego klienta. +/// details | Co to jest VPS i do czego służy? -VPS, rozwiązanie pośrednie między hostingiem a serwerem fizycznym, charakteryzuje się niezawodnością i wydajnością sprzętu dedykowanego, różni się jednak tym, że nie musisz nim zarządzać. +Serwer wirtualny prywatny (VPS) służy do hostowania stron internetowych (e-commerce, treści, media wizualne) oraz aplikacji oprogramowania (portale, ekstranety, rozwiązania wspólne, wiki, CRM). Na odmienną od hostingu współdzielonego, VPS oferuje izolowane środowisko, dedykowane klientowi. Nasze rozwiązania VPS wypełniają lukę między hostingu webowym a serwerami dedykowanymi, łącząc w sobie wydajność i niezawodność bez obciążenia zarządzania sprzętem. Możesz również łatwo uaktualnić swoją konfigurację bez zmieniania serwerów. -### VPS czy hosting? +/// -Serwer VPS jest kolejnym wyborem po hostingu. Daje Ci więcej swobody w zakresie konfiguracji i korzystania z różnych funkcjonalności (dostęp root, Apache PHP,init). Możesz również zainstalować własny certyfikat SSL i dowolne oprogramowanie. +/// details | Jakie są zalety VPS od OVHcloud? -Pamiętaj jednak, żeby wybrać odpowiedni VPS. Potrzebujesz konfiguracji dopasowanej do wymagań Twoich aplikacji oraz możliwości dostosowywania jej wraz z rozwojem Twoich projektów. +Oferty VPS od OVHcloud oferują świetną wartość dla wydajności, z nieograniczonym ruchem i kilkoma globalnymi lokalizacjami, aby zapewnić niską opóźnienie i poprawić dostępność, w zależności od Twoich potrzeb. -### VPS czy serwer dedykowany? +/// -Zaletą VPS jest to, że nie musisz zarządzać sprzętem, np. monitorować stanu dysków twardych, pamięci RAM i CPU. Oferta VPS jest odpowiednia dla większości zastosowań WWW wchodzących w zakres projektów o średniej wielkości. +/// details | Czy rozwiązanie VPS to właściwy wybór dla mnie? -Serwer dedykowany jest zalecany, jeśli chcesz: całkowicie administrować środowiskiem, budować rozwiązania na bazie bardziej kompleksowych architektur, tworzyć infrastrukturę obejmującą sieć prywatną (vRack) czy wdrażać zaawansowane rozwiązania niezwiązane z usługami WWW. +Użycie VPS wymaga podstawowej wiedzy na temat administracji serwerem. Ważne jest, aby to uwzględnić, skutecznie zarządzając swoim systemem operacyjnym (Linux lub Windows) oraz konfigurować swoje aplikacje, np. PrestaShop lub WordPress. -Użytkownicy VPS, których projekty szybko się rozwijają, w kolejnym kroku mogą wybrać serwer dedykowany lub rozwiązania Public Cloud. W ramach tych usług zyskają bardziej złożoną i elastyczną infrastrukturę dostosowaną do dynamicznego wzrostu działalności. +Jeśli potrzebujesz VPS, ale brakuje Ci technicznej wiedzy, aby go zarządzać, rozważ kontakt z jednym z naszych [partnerów](/links/partner) w celu uzyskania pomocy. -### Jakie są różnice między rozwiązaniami VPS a Public Cloud? +Jeśli potrzebujesz przydzielonych zasobów, ale nie chcesz mieć do czynienia z administracją serwerem, zalecamy wybór naszych planów hostingu webowego Performance. -VPS to rozwiązanie przewidziane dla środowisk preprodukcyjnych i produkcyjnych, które nie wymagają stałej wydajności. -OVHcloud oferuje infrastrukturę z wieloma serwerami o wysokiej dostępności. W przeciwieństwie do VPS, Public Cloud obejmuje również usługę vRack. +/// -### Jak wybrać serwer VPS? +/// details | Czy mogę łatwo uaktualnić swój VPS do wyższego zakresu lub obniżyć konfigurację do niższego poziomu? -Aby wybrać serwer VPS dostosowany do Twoich potrzeb, sprawdź: +Tak, możesz uaktualnić swoją konfigurację z poziomu Panelu Kontrolnego OVHcloud, bez ręcznego migracji danych. Dostępne opcje uaktualnienia zależą od zakresu i modelu VPS. -- ilość niezbędnych zasobów (procesor, pamięć, przestrzeń dyskowa, przepustowość,...); -- wymagany system operacyjny (Linux lub Windows); -- wymagania techniczne niezbędne do prawidłowego działania aplikacji (np. baza danych wymaga prędkości odczytu/zapisu). +Jednak aby obniżyć konfigurację, musisz zasubskrybować nowy plan, przenieść swoje dane, a następnie anulować stary usługę. Nasz zespół wsparcia jest dostępny, aby pomóc Ci w razie potrzeby. -Pozwoli Ci to dokonać właściwego wyboru spośród naszych rozwiązań VPS: +/// -- **VPS Starter**: ekskluzywna maszyna do testowania naszej oferty (tylko z dystrybucją Linux); -- **VPS Value, Essential i Comfort**: idealne do hostingu stron WWW, usług e-commerce lub systemów monitoringu; -- **VPS Elite**: dostosowane do sklepów internetowych i aplikacji wymagających większych zasobów procesora i pamięci. -- **VPS Limited Edition** (Ilość ograniczona): serwery VPS zapewniają większą wydajność i dużą zaletę w hostowaniu złożonych stron WWW, aplikacji wymagających ogromnych zasobów, a nawet serwerów gier. Ta oferta jest ważna do wyczerpania zapasów. +/// details | Jaką lokalizację lub kraj powinienem wybrać dla mojego VPS? -> [!primary] -> Możesz zmienić VPS Limited Edition na inny VPS z tej samej gamy, ale ze względów technicznych nie można zmienić VPS Limited Edition na VPS z innej gamy (Starter, Value, Essential lub Comfort). +Im bliżej Twojego centrum danych znajduje się Twoja odbiorców, tym niższe będzie opóźnienie, prowadząc do lepszego doświadczenia użytkownika i zwiększając zaufanie do Twoich usług. -### Kto może korzystać z serwera VPS? +/// -Każda osoba posiadająca podstawową wiedzę techniczną z zakresu administracji serwerami może korzystać z VPS. Kompetencje te są niezbędne do zarządzania zainstalowanym na maszynie systemem operacyjnym (Linux lub Windows) i do konfigurowania aplikacji. Myślisz, że potrzebujesz serwera VPS, ale czy nie posiadasz wymaganych kompetencji? Prosimy o kontakt z jednym z naszych [partnerów](/links/partner). +/// details | Jakie są zalety VPS zlokalizowanego w Europie? -Jeśli chcesz korzystać z gwarantowanych zasobów bez znajomości administrowania serwerami, zalecamy nasze [hosting Performance](/links/web/hosting-performance-offer). +Hosting VPS w Francji lub ogólnie w UE oferuje zalety takie jak konkurencyjne ceny i wzmocnione ochrony danych. Twoja usługa nie podlega amerykańskiemu aktowi CLOUD, co chroni ją przed wpływami poza Europą. -### Jak się zalogować do mojego VPS? +/// -Możesz łączyć się zdalnie z Twoim serwerem VPS, używając danych dostarczonych w wiadomości e-mail po udostępnieniu usługi. -Sposób połączenia zależy od używanego systemu operacyjnego. +/// details | Czy kopie zapasowe są dołączone do mojego VPS? -Szczegóły znajdziesz w przewodniku ["Pierwsze kroki z serwerem VPS"](/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps). +Tak, przy zamówieniu VPS, opcja codziennego backupu jest dołączona bezpłatnie. -### Czy mogę zainstalować kilka stron WWW na jednym serwerze VPS? +Dla jeszcze lepszej ochrony możesz również wybrać naszą opcję premium backupu. Oferuje ona: -Tak Możesz podzielić serwer VPS i dostosować go do Twoich potrzeb. Możesz zainstalować kilka stron lub projektów, przydzielając każdemu prywatną przestrzeń o wybranym rozmiarze. Realizacja tych operacji będzie prostsza, jeśli zainstalujesz panel administracyjny Plesk lub cPanel. +- Możliwość powrotu do kopii zapasowej, która może być starsza o do tygodnia. +- Możliwość zaplanowania kopii zapasowych, optymalizując zarządzanie danymi i minimalizując wpływ na operacje biznesowe. -### Czy mój VPS ma kopię zapasową? +Dodatkowo oferujemy: -W zależności od wrażliwości danych zalecamy zastosowanie odpowiedniej strategii tworzenia kopii zapasowych. -Przejdź na naszą [stronę WWW VPS](/links/bare-metal/vps-options), aby uzyskać więcej informacji na temat dostępnych opcji. +- Zrzuty ekranu: Możesz tworzyć ręczne, natychmiastowe zrzuty ekranu, które przechwytują dokładny stan Twojego VPS tuż przed aktualizacją lub istotną zmianą. +- Zewnętrzny backup: Przechowuj swoje dane na osobnym, zabezpieczonym dysku, umożliwiając łatwe odzyskanie w przypadku dużego incydentu. -### Jak zabezpieczyć serwer VPS? +Korzystając z tych rozwiązań, możesz dostosować zarządzanie kopiami zapasowymi do swoich potrzeb bezpieczeństwa i ciągłości działania. -VPS jest dostarczany jako "goły" i nie ma na nim żadnej konfiguracji bezpieczeństwa. To pierwsza rzecz, którą musisz zrobić w recepcji -W tym celu zapoznaj się z przewodnikiem ["Zabezpieczenie serwera VPS"](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps). +Wizytuj naszą [stronę internetową VPS](/links/bare-metal/vps), aby dowiedzieć się więcej o dostępnych opcjach. -### Jaka jest przepustowość przypisana do mojego VPS? Czy jest gwarantowana? +/// -Przepustowość podana na stronie produktowej VPS jest gwarantowana. Jest to minimalna przydzielona przepustowość. +/// details | Czy mogę hostować kilka stron internetowych na VPS? -### Jakie warunki SLA są stosowane na moim serwerze VPS? +Tak, VPS można skonfigurować w taki sposób, aby obsługiwał wiele stron internetowych lub projektów. Możesz podzielić przestrzeń dyskową zgodnie z własnymi potrzebami i używać specjalistycznych interfejsów, takich jak Plesk lub cPanel, aby uprościć zarządzanie swoimi stronami internetowymi. -OVHcloud oferuje SLA na poziomie 99,9% dla wszystkich ofert VPS. +/// -### Jak uzyskać dostęp do usługi backup storage z innego adresu IP niż moja usługa? +/// details | Czy otrzymam nazwę domeny i usługę poczty e-mail wraz z moim VPS? -Dostęp do backupu FTP może być ograniczony do usługi, do której jest on przypisany za pośrednictwem Panelu klienta OVHcloud. +Nie, nasze rozwiązania VPS nie obejmują nazwy domeny ani usługi poczty e-mail. Te usługi można zamówić oddzielnie w Panelu Kontrolnym OVHcloud. -Aby autoryzować dodatkowe adresy IP, z których chcesz uzyskać dostęp do Backup Storage, skorzystaj z API OVHcloud. -Dzięki temu będziesz mógł pobierać kopie zapasowe danych z innej usługi za pomocą różnych protokołów (FTP, NFS, CIFS). +/// + +/// details | Jak wybrać między VPS a planem hostingu webowego? + +**Plan hostingu webowego** + +- Idealny dla podstawowych potrzeb hostingu z gotową konfiguracją. + +**VPS** + +- Większa elastyczność i kontrola, idealny do skalowania projektów z złożonymi potrzebami konfiguracji. + +Hosting usług webowych na VPS pozwala Ci zainstalować preferowane oprogramowanie, dostosować ustawienia serwera i hostować wiele stron internetowych z dedykowanymi zasobami. Pamiętaj, że VPS należy skonfigurować w taki sposób, który odpowiada Twoim wymaganiom aplikacji i jest dostosowany do wzrostu Twojej działalności. + +/// + +/// details | Jakie jest różnice między VPS a rozwiązaniami Public Cloud? + +**VPS** + +- Zoptymalizowana i dedykowana maszyna wirtualna odpowiednia zarówno do preprodukcji, jak i produkcji, zaprojektowana do hostowania kilku projektów internetowych. + +**Public Cloud od OVHcloud** + +- Oferuje infrastrukturę wielu serwerów z wysoką dostępnością i prywatną siecią (vRack), zaprojektowaną do złożonych, skalowalnych architektur. + +/// + +/// details | Jakie są zalety VPS w porównaniu do serwera dedykowanego? + +**VPS** + +- Oferuje uproszczone zarządzanie bez konserwacji sprzętu, idealny dla projektów wymagających ścisłej kontroli. + +**Serwer dedykowany** + +- Zalecany dla złożonej infrastruktury, która wymaga pełnej kontroli nad sprzętem i gwarantowanej wydajności. + +VPS eliminuje konieczność zarządzania sprzętem fizycznym, takim jak pamięć, RAM i CPU, co sprawia, że jest dobrze dopasowany do większości aplikacji internetowych. W miarę wzrostu Twojej działalności możesz uaktualnić swój VPS lub przenieść się na serwer dedykowany lub rozwiązanie Public Cloud, aby uzyskać bardziej elastyczną i potężną infrastrukturę. + +/// + +/// details | Jaka przepustowość jest przydzielona do mojego VPS? Czy jest ona gwarantowana? + +Przepustowość wymieniona na naszej [stronie internetowej VPS](/links/bare-metal/vps) jest gwarantowana. Jest to minimalna ilość przydzielona do Twojej usługi. + +/// + +/// details | Który SLA jest stosowany do mojego VPS? + +VPS od OVHcloud obejmuje SLA na poziomie 99,9%. + +/// + + +/// details | Jakie są unikalne cechy VPS z Local Zone? + +Z VPS z Local Zone możesz znacznie zmniejszyć czas dostępu do swoich stron i aplikacji, ponieważ dane są hostowane bliżej Twoich użytkowników. Tworzy to lepsze doświadczenie użytkownika, zmniejszając opóźnienie, kiedy aplikacje wymagają minimalnego czasu odpowiedzi. Po prostu wybierz jedną z naszych lokalizacji na całym świecie podczas składania zamówienia. + +Pamiętaj, że VPS z Local Zone, w przeciwieństwie do zwykłego VPS, nie obejmuje funkcji bezpieczeństwa, takich jak Anti-DDoS, czy zaawansowane opcje, takie jak Additional IP i Load Balancer. + +VPS z Local Zone spełnia również potrzeby projektów z wymaganiami dotyczącymi lokalizacji danych i suwerenności. Hostując swoje usługi w określonej lokalizacji, możesz łatwo spełnić lokalne przepisy dotyczące przetwarzania i przechowywania danych, takie jak europejski RODO. + +/// + +/// details | Czy mogę przenieść swój VPS z Local Zone do centrum danych i odwrotnie? + +Nie, nie możesz bezpośrednio migrować usług. Musisz zasubskrybować wybrany VPS, przenieść swoje dane, a następnie anulować stary usługę. Nasz zespół wsparcia może Ci w tym pomóc, jeśli to konieczne. + +/// + +/// details | Jakie są ryzyka korzystania z VPS bez ochrony przed DDoS? + +Wirtualne serwery prywatne bez ochrony przed atakami DDoS automatycznie narażają się na ataki dystrybuowane (DDoS), co może prowadzić do awarii usług i poważnych luk w zabezpieczeniach. + +- Bezpośrednie narażenie: Jeśli Twój serwer zostanie zaatakowany przez atak DDoS, strumień żądań może go zatopić, powodując, że Twoje strony i aplikacje staną się niedostępne. +- Brak automatycznej neutralizacji: Aby chronić swój serwer, będziesz musiał odpierać ataki za pomocą oprogramowania zabezpieczeniowego trzecich firm lub konkretnych konfiguracji. +- Dodatkowe obciążenie zarządzania: Brak solidnych, wbudowanych zabezpieczeń przedstawia poważne ryzyko, podkreślając konieczność czujnego monitorowania i strategii proaktywnych, szczególnie dla projektów o dużym ruchu. + +Jeśli odporność na ataki DDoS jest kluczowym czynnikiem dla Twojego projektu, zalecamy wybór VPS od OVHcloud hostowanego w jednym z naszych centrów danych, które oferują wbudowaną ochronę. + +/// + + +## Pytania dotyczące administrowania serwerem VPS + +/// details | Jak się zalogować do mojego VPS? + +Możesz zalogować się zdalnie do Twojego serwera VPS, korzystając z danych przesłanych w e-mailu po dostarczeniu usługi. +Metoda połączenia zależy od używanych systemów operacyjnych. + +Szczegóły znajdziesz w przewodniku [Jak rozpocząć pracę z VPS](/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps). + +/// + +/// details | Czy OVHcloud zapewnia mi pomoc w konfiguracji oprogramowania do mojego serwera VPS? + +Chociaż nie możemy zaoferować pomocy w konfiguracji oprogramowania ani w administrowaniu, zapewniamy narzędzia i zasoby, które pomogą Ci rozpocząć pracę. + +Oferujemy na przykład gamę wstępnie skonfigurowanych szablonów i obrazów dla popularnych systemów operacyjnych i aplikacji, aby pomóc Ci szybko wdrożyć Twój VPS. Udostępniamy również Panel klienta OVHcloud, w którym możesz zarządzać serwerami VPS i wykonywać zadania, takie jak restart, reinstalacja i monitoring zasobów. + +Ponadto, nasza dokumentacja i baza wiedzy zawierają wiele informacji dotyczących konfiguracji i zarządzania serwerem VPS. + +Jednak w przypadku specyficznej pomocy w konfiguracji oprogramowania, zalecamy skontaktowanie się z naszą [społecznością](/links/community) lub uzyskanie pomocy wykwalifikowanego administratora systemu lub programisty poprzez nasz [portal partnera](/links/partner). + +/// + +/// details | Czy mogę zainstalować kilka systemów operacyjnych na moim serwerze VPS? + +Instalacja OVHcloud jest możliwa tylko dla jednego systemu operacyjnego. +Konfiguracje spersonalizowane mogą być wdrażane po stronie klienta, za co odpowiedzialność ponosi administrator serwera. Usługi OVHcloud nie obejmują zadań administracyjnych, takich jak konfiguracja oprogramowania lub narzędzia zewnętrzne. + +W przypadku problemów z konfiguracją i administracją zalecamy kontakt z naszą [społecznością](/links/community) lub uzyskanie pomocy wykwalifikowanego administratora systemu lub programisty poprzez nasz [portal partnera](/links/partner). + +/// + +/// details | Czy mogę zainstalować wirtualne maszyny na serwerze VPS za pomocą oprogramowania do wirtualizacji (takiego jak Proxmox)? + +Szablony instalacyjne OVHcloud dla serwerów VPS nie zawierają systemu operacyjnego Proxmox ani podobnego systemu operacyjnego do wirtualizacji. + +Konfiguracje spersonalizowane mogą być wdrażane po stronie klienta, za co odpowiedzialność ponosi administrator serwera. Usługi OVHcloud nie obejmują zadań administracyjnych, takich jak konfiguracja oprogramowania lub korzystanie z narzędzi zewnętrznych. + +W przypadku problemów z konfiguracją i administracją zalecamy kontakt z naszą [społecznością](/links/community) lub uzyskanie pomocy wykwalifikowanego administratora systemu lub programisty poprzez nasz [portal partnera](/links/partner). + +/// + +/// details | Czy mogę wybrać odpowiedni sprzęt dla mojego VPS (GPU, CPU, itp.) i wykonać upgrade? + +Nie można spersonalizować ani zmodyfikować serwera VPS na poziomie sprzętowym. +Wybierz serwer [VPS model](/links/bare-metal/vps) zgodnie z Twoimi minimalnymi potrzebami i zaktualizuj go zgodnie z Twoimi potrzebami. + +/// + +/// details | Mój VPS jest zbyt wolny, czy mogę przenieść swój VPS na inny host? + +Aby rozwiązać problemy z wydajnością na serwerze VPS, przekaż naszemu zespołowi obsługi klienta konkretne wyniki testów. + +Należy pamiętać, że serwer VPS musi zostać uruchomiony w [tryb rescue](/pages/bare_metal_cloud/virtual_private_servers/rescue), aby wykluczyć ewentualne problemy z oprogramowaniem. + +Skontaktuj się z zespołem pomocy, [tworząc zgłoszenie w Centrum pomocy OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help), aby uzyskać pełną listę testów niezbędnych do prawidłowej oceny. + +/// + +/// details | Czy mogę zamówić nowy VPS, przenieść niewykorzystany abonament na stary VPS czy zwrócić należność? + +Jest to zazwyczaj możliwe, ale proces ten wymaga [zapytania do naszego zespołu wsparcia za pośrednictwem Centrum pomocy OVHcloud](https://help.ovhcloud.com/csm?id=csm_get_help). + +Zanim przystąpisz do tej operacji, upewnij się, że [przeniosłeś wszystkie dane, których nadal potrzebujesz](/pages/bare_metal_cloud/dedicated_servers/migrate_a_server_to_another) do nowej usługi lub utworzyłeś kopie zapasowe danych. + +/// + +/// details | Czy mogę przenieść mój VPS do innego centrum danych OVHcloud w innym kraju? + +Nie można przenieść VPS do innego centrum danych. W tym celu możesz przeprowadzić [migrację ręczną](/pages/bare_metal_cloud/dedicated_servers/migrate_a_server_to_another): + +- Pobierz dane z aktualnego VPS. +- Zamów nowy VPS. +- Zapisanie danych na nowym VPS. +- [Rezygnacja z serwera VPS poprzedniej generacji](/pages/account_and_service_management/managing_billing_payments_and_services/how_to_cancel_services). + +/// + +/// details | Ile dodatkowych adresów IP mogę skonfigurować na serwerze VPS? + +Liczba adresów VPS jest ograniczona do [16 Additional IP](/links/network/additional-ip). + +Zapoznaj się z przewodnikiem [Skonfiguruj adres IP jako alias](/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing) aby uzyskać przykłady konfiguracji adresów IP. + +/// + +/// details | Czy mogę dodać bloki adresów IP do mojego serwera VPS? + +Nie można dodawać bloków IP do serwera VPS. +Na serwerze VPS można skonfigurować do [16 dodatkowych adresów IP](/links/network/additional-ip). + +/// + +/// details | Czy mogę zmienić serwer VPS przypisany do mojej licencji (Plesk, cPanel)? + +Licencje mogą być przenoszone między serwerami, ale istnieją ograniczenia. + +Najlepszą opcją jest zalogowanie się do naszego [API console](/links/api) za pomocą danych identyfikacyjnych konta klienta i sprawdzenie, czy licencja może zostać przeniesiona na inny VPS. [Pierwsze kroki z API OVHcloud](/pages/manage_and_operate/api/first-steps). + +Po zalogowaniu, skorzystaj z następujących wywołań w zależności od używanego programu: + +**Plesk** + +> [!api] +> +> @api {v1} /license/plesk GET /license/plesk/{serviceName}/canLicenseBeMovedTo +> + +**cPanel** + +> [!api] +> +> @api {v1} /license/cpanel GET /license/cpanel/{serviceName}/canLicenseBeMovedTo +> + +![Licencja API](images/getlicense.png){.thumbnail} + +Wpisz parametry w następujący sposób: + +- `serviceName`: wpisz wewnętrzną nazwę licencji (patrz sekcja `Licencje` w [Panelu klienta OVHcloud](/links/manager)). +- `destinationIp`: Wpisz adres IPv4 usługi docelowej. + +Kliknij przycisk `EXECUTE`{.action}. + +Jeśli wynik jest ujemny (`false`), powód zostanie uwzględniony w polu `RESPONSE`. + +![Licencja API](images/getlicense_response.png){.thumbnail} + +Jeśli IP docelowe jest kompatybilne z Twoją licencją ('true`), możesz przenieść je za pomocą odpowiedniego wywołania: + +**Plesk** + +> [!api] +> +> @api {v1} /license/plesk POST /license/plesk/{serviceName}/changeIp +> + +**cPanel** + +> [!api] +> +> @api {v1} /license/cpanel POST /license/cpanel/{serviceName}/changeIp +> + +/// + + +## Pytania dotyczące bezpieczeństwa i kopii zapasowych + +/// details | Jak zabezpieczyć serwer VPS? + +Domyślnie VPS jest dostarczany z zainstalowanym tylko wybranym systemem operacyjnym. Po dostarczeniu serwera VPS administrator serwera VPS wprowadził odpowiednią konfigurację zabezpieczeń. +W tym celu zapoznaj się z przewodnikiem [Zabezpieczenie serwera VPS](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps). + +/// + +/// details | Jak mogę pobrać pliki lub kopię danych z serwera VPS? + +Istnieje kilka możliwości, na przykład: + +- Pobranie przez SFTP: Połącz się z prywatnym serwerem wirtualnym za pomocą klienta programowego dysponującego dostępem SFTP (na przykład [FileZilla](/pages/bare_metal_cloud/dedicated_servers/comment-deposer-ou-recuperer-des-donnees-sur-un-serveur-dedie-via-sftp)), następnie prześlij wszystkie pliki z katalogu głównego systemu. +- Pobierz za pomocą `rsync` (narzędzie wiersza poleceń): Wpisz polecenie `rsync -avz -e ssh nazwa użytkownika@vps_ip_address:/ /local_directory/`, aby pobrać z Twojego serwera VPS wszystkie pliki i foldery. +- Pobierz za pomocą opcji **Automatyczne kopie zapasowe**: Zapoznaj się z przewodnikiem [Jak korzystać ze zautomatyzowanych kopii zapasowych na serwerze VPS](/pages/bare_metal_cloud/virtual_private_servers/using-automated-backups-on-a-vps), aby pobrać pliki z kopii zapasowej. +- Pobierz za pomocą opcji **Snapshot**: Zapoznaj się z przewodnikiem [Jak korzystać z Snapshotów na serwerze VPS](/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps), aby pobrać snapshot z serwera VPS. + +/// + +/// details | Jak mogę pobrać plik VPS jako plik VM? + +Nie można pobrać pliku VM z VPS OVHcloud. Do pobrania pliku obrazu możesz użyć opcji VPS **Snapshot** z poziomu Panelu klienta OVHcloud. + +Zapoznaj się z przewodnikiem [Jak używać migawek na serwerze VPS](/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps), aby utworzyć i pobrać migawkę serwera VPS. + +Następnie możesz lokalnie przekonwertować pobrany plik snapshot na format odpowiadający Twoim potrzebom. + +Zastanów się nad skontaktowaniem z jednym z naszych [partnerów](/links/partner) w celu uzyskania dalszej pomocy. + +/// + +/// details | Jak uzyskać dostęp do usługi backup storage z adresu IP spoza mojej usługi? + +Dostęp do usługi backup storage na serwerze VPS (przestrzeń FTP) może być ograniczony do adresów IP przypisanych do usługi w ramach konta klienta OVHcloud. + +Aby dodać inne adresy IP, z których można uzyskać dostęp, możesz skorzystać z interfejsu API OVHcloud. +Kopia zapasowa może być pobrana z innej usługi za pomocą różnych protokołów (FTP, NFS, CIFS). > [!warning] -> Zezwala się wyłącznie na adresy IP OVHcloud. +> Można autoryzować wyłącznie adresy IP OVHcloud. > -Zaloguj się do [konsoli API OVHcloud](/links/api) przy użyciu danych logowania do konta klienta i wykonaj następujące wywołanie: +Zaloguj się do [OVHcloud API console](/links/api) za pomocą danych identyfikacyjnych konta klienta i użyj następującego wywołania: > [!api] > > @api {v1} /vps POST /vps/{serviceName}/backupftp/access > -Zmień parametry w następujący sposób: +Edytuj parametry w następujący sposób: -- `serviceName`: wprowadź wewnętrzną nazwę Twojego serwera VPS (`vps-x11x11xyy.vps.ovh.net`). -- `cifs`: Jeśli używasz tego protokołu, ustaw dla tego parametru wartość `true`. -- `ftp`: ustaw dla tego parametru wartość `true`, jeśli używasz tego protokołu. -- `ipBlock`: wprowadź adres IP, który będzie miał do niego dostęp, w formie `203.0.113.100/32`. -- `nfs`: Jeśli używasz tego protokołu, ustaw dla tego parametru wartość `true`. +- `serviceName`: wpisz wewnętrzną nazwę serwera VPS (`vps-x11x11xyy.vps.ovh.net`). +- `cifs`: Ustaw na `true`, jeśli dotyczy. +- `ftp`: Ustaw na `true`, jeśli jest potrzebny. +- `ipBlock`: w formie `203.0.113.100/32` wpisz adres IP, który będzie miał dostęp. +- `nfs`: Ustaw na `true`, jeśli dotyczy. Kliknij przycisk `EXECUTE`{.action}. -Aby sprawdzić, czy Twój adres IP jest poprawnie autoryzowany, użyj następującego połączenia: +Aby sprawdzić, czy adres IP jest dozwolony, użyj następującego wywołania: > [!api] > > @api {v1} /vps GET /vps/{serviceName}/backupftp/access > +/// + + +/// details | Czy mój VPS jest chroniony przed zewnętrznymi atakami? + +Chociaż OVHcloud stosuje środki bezpieczeństwa w celu ochrony całej infrastruktury, administrator serwera VPS jest odpowiedzialny za bezpieczeństwo aplikacji i danych na nim hostowanych. + +- Zapoznaj się z przewodnikiem [Aktywacja i konfiguracja Edge Network Firewall](/pages/bare_metal_cloud/dedicated_servers/firewall_network), który jest zintegrowany z naszą infrastrukturą Anty-DDoS, ograniczając ekspozycję Twoich usług na ataki DDoS. +- Ponadto, zapoznaj się z naszymi przewodnikami dotyczącymi [jak skonfigurować własny firewall](/pages/bare_metal_cloud/virtual_private_servers/firewall-Linux-iptable) z `iptable` dla dystrybucji opartych na systemie Linux oraz [jak włączyć firewall w systemie Windows](/pages/bare_metal_cloud/virtual_private_servers/activate-port-firewall-soft-win). +- W przypadku dystrybucji opartych na systemie Linux na serwerze VPS należy postępować zgodnie z instrukcjami zawartymi w przewodniku [How to secure a VPS](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps), aby zastosować dodatkowe środki bezpieczeństwa. + +/// + +/// details | Jak zabezpieczyć swój VPS przed atakami DDoS? + +OVHcloud zapewnia kilka funkcji bezpieczeństwa, które chronią Twój VPS przed złośliwym ruchem: + +- Ochrona Anty-DDoS: nasze usługi VPS są domyślnie chronione przez naszą [infrastrukturę Anty-DDoS](/links/security/antiddos), która wykrywa i mityguje ataki DDoS w czasie rzeczywistym. +- Blokowanie IP: [Uniemożliwienie określonym adresom IP lub zakresom IP](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps) połączenia z Twoim VPS. +- Reguły firewall: [skonfiguruj spersonalizowane reguły firewall](/pages/bare_metal_cloud/dedicated_servers/firewall_network) w celu monitorowania ruchu przychodzącego i wychodzącego bezpośrednio na serwerze VPS. +- VAC (VPS Anty-DDoS): System VAC zapewnia dodatkową warstwę ochrony przed atakami DDoS, w tym filtrowanie ruchu i ograniczenie szybkości. + +/// + +/// details | Czy chcę używać serwera VPS jako serwera gier. Czy będzie on korzystał z tego samego firewalla, który chroni serwery dedykowane Game? + +Ochrona DDoS Game OVHcloud jest dostępna tylko na serwerach dedykowanych Game. Jeśli zamawiasz VPS do hostingu gier, będziesz musiał skonfigurować firewall bezpośrednio w systemie, w zależności od wybranej gry. Więcej informacji zawiera przewodnik [Konfiguracja firewalla w systemie Linux z systemem iptables](/pages/bare_metal_cloud/virtual_private_servers/firewall-Linux-iptable). + +Zaletą VPS w porównaniu do serwera dedykowanego jest możliwość skalowania zasobów w zależności od rzeczywistych zastosowań. Aby skorzystać z mocniejszego systemu, wystarczy kilka kliknięć, aby przejść na wyższy model VPS. + +/// + ## Sprawdź również Jeśli chcesz otrzymywać wsparcie w zakresie konfiguracji i użytkowania Twoich rozwiązań OVHcloud, zapoznaj się z naszymi [ofertami pomocy](/links/support). -Dołącz do [grona naszych użytkowników](/links/community). \ No newline at end of file +Dołącz do [grona naszych użytkowników](/links/community). diff --git a/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.pt-pt.md b/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.pt-pt.md index 366f44c5cd5..c00535286f4 100644 --- a/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.pt-pt.md +++ b/pages/bare_metal_cloud/virtual_private_servers/vps-faq/guide.pt-pt.md @@ -1,125 +1,460 @@ --- -title: FAQ VPS OVHcloud -updated: 2025-08-07 +title: "OVHcloud VPS Perguntas frequentes" +excerpt: "Encontre as respostas às perguntas mais frequentes sobre nossas ofertas de VPS" +updated: 2025-10-30 --- -## FAQ VPS + -### O que é e para que serve um VPS? +## Perguntas gerais sobre as ofertas de VPS -Um servidor privado virtual (VPS) permite alojar websites (lojas online, sites de e-commerce, conteúdos, media) e aplicações de software (portais, Extranet, soluções de trabalho colaborativo, wikis, CRM). Ao contrário do alojamento partilhado, os dados são isolados numa máquina virtual dedicada ao utilizador. +/// details | O que é um VPS e para que serve? -Os nossos VPS são o compromisso ideal entre o alojamento web e um servidor físico, combinando a fiabilidade e o desempenho de um servidor dedicado, sem as limitações associadas ao hardware. +Um servidor virtual privado (VPS) é usado para hospedar sites (comércio eletrônico, conteúdo, mídia visual) e aplicações de software (portais, extranets, soluções colaborativas, wikis, CRM). Ao contrário do hospedagem compartilhada, um VPS oferece um ambiente isolado, dedicado ao cliente. Nossas soluções de VPS preenchem a lacuna entre a hospedagem web compartilhada e os servidores dedicados, combinando desempenho e confiabilidade sem a carga de gerenciamento de hardware. Você também pode atualizar facilmente sua configuração sem trocar de servidores. -### Qual a melhor opção: VPS ou alojamento web? +/// -Depois de um alojamento web, o VPS é a evolução lógica como solução de alojamento. Os VPS oferecem mais possibilidades e uma maior liberdade em matéria de configuração, acesso e funcionalidade (root, Apache, PHP.init). Também poderá instalar um certificado SSL ou qualquer outro software à sua escolha. +/// details | Quais são as vantagens de um VPS da OVHcloud? -Neste sentido, recomendamos que preste especial atenção no momento de escolher o seu VPS, uma vez requererá uma configuração adaptada às necessidades das aplicações alojadas assim como o crescimento da sua atividade. +As ofertas de VPS da OVHcloud oferecem um excelente custo-benefício, com tráfego ilimitado e várias localizações globais para baixa latência e acessibilidade aprimorada, dependendo das suas necessidades. -### Quais são as vantagens de um VPS relativamente a um servidor dedicado? +/// -Os VPS têm a vantagem de o libertar da gestão de hardware, como o acompanhamento do estado dos discos rígidos, da memória viva (RAM) e da CPU. Esta solução é adaptada à maior parte das utilizações web, em projetos de dimensão controlada. -Um servidor dedicado é a solução ideal para os utilizadores que pretendem gerir eles próprios a paret de hardware, construir arquiteturas mais elaboradas, criar uma infraestrutura que inclua uma rede privada (vRack) ou ainda implementar soluções complexas diferentes dos serviços web. +/// details | Uma solução VPS é a escolha certa para mim? -Em geral, quando a atividade web dos clientes cresce, estes só evoluem para soluções de servidores dedicados e Public Cloud, já que oferecem infraestruturas mais complexas e flexíveis, capazes de se adaptar a um forte crescimento. +Usar um VPS requer conhecimentos básicos de administração de servidores. Lembrar disso é crucial para gerenciar efetivamente seu sistema operacional (Linux ou Windows) e configurar suas aplicações, como o PrestaShop ou o WordPress, por exemplo. -### Quais são as diferenças entre VPS e Public Cloud? +Se você precisa de um VPS, mas não tem a expertise técnica para gerenciá-lo, considere entrar em contato com um de nossos [parceiros](/links/partner) para obter assistência. -O VPS é uma solução adaptada aos ambientes de pré-produção e produção, que não requerem desempenhos constantes. -O Public Cloud da OVHcloud oferece uma infraestrutura multiservidor com uma alta disponibilidade das máquinas. Além disso, o vRack (uma rede privada) também está disponível com esta solução. +Se você precisa de recursos provisionados, mas prefere não lidar com a administração do servidor, recomendamos optar por nossos planos de hospedagem web Performance. -### Como escolher o meu VPS OVHcloud? +/// -Para escolher um VPS adaptado às suas necessidades, convidamo-lo a verificar os seguintes aspetos: +/// details | Posso atualizar facilmente meu VPS para uma faixa superior ou reduzir para uma configuração inferior? -- a quantidade de recursos necessária (processadores, memória, espaço em disco, largura de banda...) ; -- o sistema operativo necessário (Linux ou Windows); -- os requisitos técnicos essenciais para o bom funcionamento da aplicação (por exemplo, uma base de dados requer velocidade de leitura/escrita). +Sim, você pode atualizar sua configuração pelo OVHcloud Control Panel, sem migrar manualmente seus dados. As opções de atualização disponíveis dependem da faixa e do modelo do VPS. -Isto permitir-lhe-á escolher entre as nossas soluções VPS: +No entanto, para reduzir sua configuração, você precisará assinar um novo plano, transferir seus dados e, em seguida, cancelar seu serviço antigo. Nossa equipe de suporte está disponível para ajudá-lo, se necessário. -- **VPS Starter**: máquina de entrada de gama para testar a nossa oferta (com uma distribuição Linux apenas); -- **VPS Value, Essential e Comfort**: ideais para o alojamento de websites, de serviços de e-commerce ou de sistemas de monitorização; -- **VPS Elite**: adaptado aos sites de e-commerce e aplicações mais exigentes em recursos CPU e memória. -- **VPS Limited Edition** (quantidades limitadas): estes VPS oferecem desempenhos acrescidos, um trunfo importante para o alojamento de sites complexos, de aplicações exigentes em recursos ou mesmo de servidores de jogo. Esta oferta é válida até ao esgotamento das existências. +/// -> [!primary] -> Pode fazer evoluir uma VPS Limited Edition para outra VPS da mesma gama mas, por razões técnicas, é impossível fazer evoluir uma VPS Limited Edition para uma VPS de outra gama (Starter, Value, Essential ou Comfort). +/// details | Qual região ou país devo escolher para meu VPS? -### Quem pode usar um VPS? +Quanto mais próximo seu centro de dados estiver de sua audiência, menor será a latência, resultando em uma melhor experiência do usuário e maior confiança em seus serviços. -Gerir um VPS requer conhecimentos básicos de administração de servidores. Estas noções são essenciais para gerir o sistema operativo (Linux ou Windows) instalado na máquina e configurar as aplicações. Acha que precisa de um VPS, mas considera não possuir as competências necessárias? Convidamo-lo a contactar um dos nossos [parceiros](/links/partner). +/// -Se deseja usufruir de recursos garantidos sem conhecimentos em administração de servidores, aconselhamos os nossos [alojamentos web Performance](/links/web/hosting-performance-offer). +/// details | Qual é a vantagem de um VPS localizado na Europa? -### Como aceder ao meu VPS? +Hospedar seu VPS com a OVHcloud na França ou, em geral, dentro da UE oferece vantagens como preços competitivos e proteção de dados reforçada. Seu serviço não está sujeito ao CLOUD Act dos EUA, protegendo-o de interferências fora da Europa. -Pode ligar-se remotamente ao seu VPS graças aos identificadores fornecidos por e-mail após a entrega do serviço. -O método de ligação depende dos sistemas operativos utilizados. +/// -Para mais informações, consulte o manual ["VPS - primeira utilização"](/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps). +/// details | Os backups estão incluídos com meu VPS? -### É possível alojar vários websites num VPS? +Sim, ao adquirir um VPS, uma opção de backup diário é incluída gratuitamente. -Sim. Um VPS pode ser particionado e organizado em função das suas necessidades. Assim, poderá alojar vários sites ou projetos, atribuindo a cada um deles um espaço privado com um determinado volume. Para simplificar estas operações, pode instalar um painel de gestão de websites, como Plesk ou cPanel. +Para uma proteção ainda melhor, você também pode optar por nossa opção de backup Premium. Ela oferece: -### São realizados backups do meu VPS? +- A opção de reverter para um backup com até uma semana de idade. +- A opção de agendar backups, otimizando o gerenciamento de dados e minimizando o impacto nas operações comerciais. -É aconselhável implementar uma estratégia de backup adequada, de acordo com a sensibilidade dos seus dados. -Visite a nossa [página web da VPS](/links/bare-metal/vps-options) para saber mais sobre as opções disponíveis. +Além disso, oferecemos: -### Como proteger o meu VPS? +- Snapshots: Você pode criar snapshots manuais e instantâneos que capturam o estado exato do seu VPS antes de uma atualização ou mudança crítica. +- Um backup externo: Armazene seus dados em um disco separado e seguro, permitindo uma recuperação fácil em caso de incidente grave. -Por predefinição, o VPS é fornecido "nu", não existindo nenhuma configuração de segurança neste último. Portanto, esta é a primeira coisa que têm de fazer quando recebem. -Para isso, não hesite em consultar o guia ["Proteger um VPS"](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps). +Ao usar essas soluções, você pode personalizar o gerenciamento de backup para atender às suas necessidades de segurança e continuidade do negócio. -### Qual é a largura de banda atribuída ao meu VPS? Ela está garantida? +Visite nossa [página web de VPS](/links/bare-metal/vps) para saber mais sobre as opções disponíveis. -A largura de banda apresentada na página das nossas ofertas é garantida. Trata-se da velocidade mínima que lhe é atribuída. +/// -### Qual é o SLA aplicado ao meu VPS? +/// details | Posso hospedar vários sites em um VPS? -No conjunto das gamas VPS, a OVHcloud propõe um SLA de 99,9%. +Sim, um VPS pode ser configurado para hospedar vários sites ou projetos. Você pode particionar seu espaço de armazenamento conforme suas necessidades e usar interfaces especializadas, como o Plesk ou o cPanel, para simplificar o gerenciamento de seus sites. -### Como aceder ao backup storage a partir de um endereço de IP diferente do meu serviço? +/// -O acesso ao seu backup FTP pode ser restringido ao serviço a que está associado através da Área de Cliente OVHcloud. +/// details | Vou receber um nome de domínio e serviço de e-mail incluído com meu VPS? -Para autorizar endereços IP suplementares a partir dos quais deseja aceder ao Backup Storage, pode utilizar a API OVHcloud. -Isto permite-lhe recuperar os seus backups de dados de um serviço diferente através de diferentes protocolos (FTP, NFS, CIFS). +Não, nossas soluções de VPS não incluem um nome de domínio ou serviço de e-mail. Esses serviços podem ser adquiridos separadamente no OVHcloud Control Panel. + +/// + +/// details | Como escolher entre um VPS e um plano de alojamento web? + +**Plano de alojamento web** + +- Iideal para necessidades básicas de alojamento com uma configuração pré-configurada. + +**VPS** + +- Mais flexibilidade e controle, perfeito para projetos escaláveis com necessidades de configuração complexa. + +Hospedar serviços web em um VPS permite que você instale seu software preferido, personalize as configurações do servidor e hospede vários sites com recursos dedicados. Observe que um VPS precisa ser configurado de forma a atender às necessidades de sua aplicação e ser adaptado ao crescimento do seu negócio. + +/// + +/// details | Qual é a diferença entre um VPS e soluções de Public Cloud? + +**VPS** + +- Uma máquina virtual otimizada e dedicada adequada tanto para pré-produção quanto para produção, projetada para hospedar vários projetos web. + +**OVHcloud Public Cloud** + +- Oferece uma infraestrutura multi-servidor com alta disponibilidade e uma rede privada (vRack), projetada para arquiteturas complexas e escaláveis. + +/// + +/// details | Quais são as vantagens de um VPS em comparação com um servidor dedicado? + +**VPS** + +- Oferece gerenciamento simplificado sem manutenção de hardware, ideal para projetos que precisam de controle rigoroso. + +**Servidor dedicado** + +- Recomendado para infraestruturas complexas que exigem controle total de hardware e desempenho garantido. + +Um VPS elimina a necessidade de gerenciar hardware físico, como armazenamento, RAM e CPU, tornando-o adequado para a maioria das aplicações web. À medida que seu negócio cresce, você pode atualizar seu VPS ou migrar para um servidor dedicado ou uma solução de Public Cloud para uma infraestrutura mais flexível e poderosa. + +/// + + +/// details | Qual largura de banda é alocada para meu VPS? É garantida? + +A largura de banda listada em nossa [página web de VPS](/links/bare-metal/vps) é garantida. É a quantidade mínima alocada para seu serviço. + +/// + +/// details | Qual SLA é aplicado ao meu VPS? + +Um VPS da OVHcloud inclui um SLA de 99,9%. + +/// + +/// details | Quais são os recursos exclusivos de um VPS da Zona Local? + +Com um VPS da Zona Local, você pode reduzir significativamente os tempos de acesso aos seus sites e aplicações, pois seus dados são hospedados mais próximos de seus usuários. Isso cria uma melhor experiência do usuário ao reduzir a latência sempre que as aplicações exigirem um tempo de resposta mínimo. Basta selecionar uma de nossas localizações globais ao fazer o pedido. + +Lembre-se de que um VPS da Zona Local, ao contrário de um VPS comum, não inclui recursos de segurança como Anti-DDoS, ou opções avançadas como IP Adicional e Balanceador de Carga. + +Um VPS da Zona Local também atende às necessidades de projetos com requisitos de residência e soberania de dados. Ao hospedar seus serviços em uma região específica, você pode facilmente atender às regulamentações locais relacionadas ao processamento e armazenamento de dados, como o GDPR europeu. + +/// + +/// details | Posso migrar meu VPS de uma Zona Local para um centro de dados, e vice-versa? + +Não, você não pode migrar serviços diretamente. Você precisará assinar o VPS escolhido, transferir seus dados e, em seguida, cancelar seu serviço antigo. Nossa equipe de suporte pode guiá-lo por essas etapas, se necessário. + +/// + +/// details | Quais são os riscos de usar um VPS sem proteção contra DDoS? + +Servidores virtuais privados sem proteção contra DDoS estão automaticamente expostos a ataques de negação de serviço distribuídos (DDoS), potencialmente resultando em interrupções de serviço e brechas de segurança graves. + +- Exposição direta: Se seu servidor for alvo de um ataque DDoS, o influxo de solicitações maliciosas pode sobrecarregar o servidor, tornando seus sites e aplicações inacessíveis. +- Nenhuma mitigação automática: Para proteger seu servidor, você precisará se defender dos ataques usando software de segurança de terceiros ou configurações específicas. +- Carga adicional de gerenciamento: A falta de segurança robusta integrada apresenta um risco significativo, destacando a necessidade de monitoramento vigilante e estratégias proativas, especialmente para projetos com alto tráfego. + +Se a resiliência contra ataques DDoS for um fator crítico para seu projeto, recomendamos optar por um VPS da OVHcloud hospedado em um dos nossos centros de dados, que vem com proteção integrada. + +/// + + +## Perguntas relacionadas à administração do VPS + +/// details | Como faço para me conectar ao meu VPS? + +Você pode fazer login no seu VPS remotamente, usando as credenciais fornecidas por e-mail após a entrega do serviço. +O método de conexão depende dos sistemas operacionais em uso. + +Todos os detalhes estão descritos em nosso guia sobre [como começar com um VPS](/pages/bare_metal_cloud/virtual_private_servers/starting_with_a_vps). + +/// + +/// details | A OVHcloud fornece assistência na configuração de software para meu VPS? + +Embora não possamos oferecer assistência na configuração ou administração de software, fornecemos algumas ferramentas e recursos para ajudá-lo a começar. + +Por exemplo, oferecemos uma gama de modelos e imagens pré-configurados para sistemas operacionais e aplicações populares para ajudá-lo a implantar rapidamente seu VPS. Também oferecemos o OVHcloud Control Panel, onde você pode gerenciar seu VPS, incluindo tarefas como reiniciar, reinstalar e monitorar recursos. + +Além disso, nossa documentação e base de conhecimento contêm uma riqueza de informações sobre como configurar e gerenciar seu VPS. + +No entanto, para assistência específica na configuração de software, recomendamos entrar em contato com nossa [comunidade](/links/community) ou buscar a ajuda de um administrador de sistema ou desenvolvedor qualificado por meio de nosso [portal de parceiros](/links/partner). + +/// + +/// details | Posso instalar mais de um sistema operacional no meu VPS? + +Os modelos de instalação da OVHcloud permitem apenas um sistema operacional. +Configurações personalizadas podem ser aplicadas do lado do cliente e são de responsabilidade do administrador do servidor. Os serviços da OVHcloud não incluem tarefas de administração, como configuração de software ou uso de ferramentas externas. + +Se você encontrar problemas de configuração e administração, recomendamos entrar em contato com nossa [comunidade](/links/community) ou buscar a ajuda de um administrador de sistema ou desenvolvedor qualificado por meio de nosso [portal de parceiros](/links/partner). + +/// + + +/// details | Posso instalar máquinas virtuais em um VPS usando software de virtualização (como o Proxmox)? + +Os modelos de instalação da OVHcloud para VPS não incluem o Proxmox Operating System ou um sistema operacional semelhante para virtualização. + +Configurações personalizadas podem ser aplicadas do lado do cliente e são de responsabilidade do administrador do servidor. Os serviços da OVHcloud não incluem tarefas de administração, como configuração de software ou uso de ferramentas externas. + +Se você encontrar problemas de configuração e administração, recomendamos entrar em contato com nossa [comunidade](/links/community) ou buscar a ajuda de um administrador de sistema ou desenvolvedor qualificado por meio de nosso [portal de parceiros](/links/partner). + +/// + +/// details | É possível escolher o hardware para meu VPS (GPU, CPU, etc.) ou atualizá-lo? + +Um VPS não pode ser personalizado ou modificado no nível de hardware. +Selecione um [modelo de VPS](/links/bare-metal/vps) no processo de pedido que atenda aos seus requisitos mínimos, e depois você poderá atualizá-lo conforme necessário. + +/// + +/// details | Meu VPS está muito lento, posso mover meu VPS para outro host? + +Para resolver problemas de desempenho no seu VPS, você precisará fornecer resultados de testes específicos à nossa equipe de suporte. + +Observe que seu VPS deve ser inicializado no [modo de recuperação](/pages/bare_metal_cloud/virtual_private_servers/rescue) para descartar quaisquer possíveis problemas de software. + +Entre em contato com nossa equipe de suporte ao [criar uma solicitação no OVHcloud Centro de Ajuda](https://help.ovhcloud.com/csm?id=csm_get_help) para que possamos fornecer a você a lista completa de testes necessários para uma avaliação adequada. + +/// + +/// details | Comprei um novo VPS, posso transferir o tempo restante da assinatura do meu VPS antigo ou terei um reembolso? + +Isso geralmente é possível, mas o processo requer uma [solicitação à nossa equipe de suporte via OVHcloud Centro de Ajuda](https://help.ovhcloud.com/csm?id=csm_get_help). + +Antes de prosseguir, certifique-se de que você tenha [migrado qualquer dado ainda necessário](/pages/bare_metal_cloud/dedicated_servers/migrate_a_server_to_another) para seu novo serviço ou crie cópias de segurança dos seus dados. + +/// + +/// details | Posso mover meu VPS para um centro de dados da OVHcloud em outro país? + +Não é possível migrar um VPS para outro centro de dados. Para isso, você pode realizar uma [migração manual](/pages/bare_metal_cloud/dedicated_servers/migrate_a_server_to_another): + +- Faça o download dos seus dados do VPS atual. +- Compre um novo VPS. +- Faça o upload dos seus dados para o novo VPS. +- [Cancela o VPS antigo](/pages/account_and_service_management/managing_billing_payments_and_services/how_to_cancel_services). + +/// + +/// details | Quantos IPs Adicionais posso configurar em um VPS? + +Um VPS é limitado a [16 IPs Adicionais](/links/network/additional-ip). + +Consulte nosso guia sobre [como configurar alias de IP](/pages/bare_metal_cloud/virtual_private_servers/configuring-ip-aliasing) para exemplos de configuração de endereços IP. + +/// + +/// details | Posso adicionar blocos de IP ao meu VPS? + +Não é possível adicionar blocos de IP a um VPS. +Você pode configurar até [16 IPs Adicionais](/links/network/additional-ip) em um VPS. + +/// + +/// details | Posso alterar o VPS associado à minha licença (Plesk, cPanel)? + +Licenças podem ser movidas entre servidores, mas existem limitações. + +A melhor opção é fazer login em nossa [console da API](/links/api) com suas credenciais de conta de cliente e verificar se sua licença pode ser movida para um VPS diferente. Encontre as bases em nosso guia sobre [como começar com a API da OVHcloud](/pages/manage_and_operate/api/first-steps). + +Uma vez conectado, use as seguintes chamadas dependendo do software em uso: + +**Plesk** + +> [!api] +> +> @api {v1} /license/plesk GET /license/plesk/{serviceName}/canLicenseBeMovedTo +> + +**cPanel** + +> [!api] +> +> @api {v1} /license/cpanel GET /license/cpanel/{serviceName}/canLicenseBeMovedTo +> + +![Licença da API](images/getlicense.png){.thumbnail} + +Insira os parâmetros da seguinte forma: + +- `serviceName`: Insira o nome interno da sua licença (consulte a seção `Licenças` no seu [OVHcloud Control Panel](/links/manager)). +- `destinationIp`: Insira o endereço IPv4 do serviço de destino. + +Clique no botão `EXECUTE`{.action}. + +Se o resultado for negativo (`false`), o motivo será incluído no campo `RESPONSE`. + +![Licença da API](images/getlicense_response.png){.thumbnail} + +Se o IP de destino for compatível com sua licença (`true`), você poderá usar a chamada correspondente para movê-la: + +**Plesk** + +> [!api] +> +> @api {v1} /license/plesk POST /license/plesk/{serviceName}/changeIp +> + +**cPanel** + +> [!api] +> +> @api {v1} /license/cpanel POST /license/cpanel/{serviceName}/changeIp +> + +/// + + +## Perguntas sobre segurança e backup + +/// details | Como faço para proteger meu VPS? + +Por padrão, o VPS é fornecido com apenas o sistema operacional selecionado instalado. O administrador do VPS é responsável por aplicar uma configuração de segurança apropriada após a entrega do VPS. +Para isso, consulte nosso guia sobre [como proteger um VPS](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps). + +/// + +/// details | Como posso baixar meus arquivos ou um backup do VPS? + +Existem várias opções disponíveis, por exemplo: + +- Baixar via SFTP: Conecte-se ao seu VPS com um cliente de software capaz de SFTP (por exemplo, [FileZilla](/pages/bare_metal_cloud/dedicated_servers/comment-deposer-ou-recuperer-des-donnees-sur-un-serveur-dedie-via-sftp)), depois transfira todos os arquivos no diretório raiz do sistema. +- Baixar via `rsync` (ferramenta de linha de comando): Use o comando `rsync -avz -e ssh username@vps_ip_address:/ /local_directory/` para baixar todos os arquivos e pastas do seu VPS. +- Baixar via a opção **Backup Automático**: Siga nosso guia sobre [como usar backups automáticos em um VPS](/pages/bare_metal_cloud/virtual_private_servers/using-automated-backups-on-a-vps) para baixar arquivos de um backup. +- Baixar via a opção **Snapshot**: Siga nosso guia sobre [como usar snapshots em um VPS](/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps) para baixar um snapshot do VPS. + +/// + +/// details | Como posso baixar meu VPS como um arquivo de VM? + +Não é possível baixar um arquivo de VM de um VPS da OVHcloud. No entanto, você pode utilizar a opção **Snapshot** do seu OVHcloud Control Panel para recuperar um arquivo de imagem. + +Siga nosso guia sobre [como usar snapshots em um VPS](/pages/bare_metal_cloud/virtual_private_servers/using-snapshots-on-a-vps) para criar e baixar um snapshot do VPS. + +Você pode então converter localmente o arquivo de snapshot baixado em um formato correspondente às suas necessidades. + +Considere entrar em contato com um de nossos [parceiros](/links/partner) para obter assistência adicional. + +/// + +/// details | Como posso acessar meu armazenamento de backup a partir de um endereço IP fora do meu serviço? + +O acesso ao armazenamento de backup do seu VPS (armazenamento FTP) pode estar restrito a endereços IP vinculados a um serviço dentro da sua conta de cliente OVHcloud. + +Para adicionar outros endereços IP a partir dos quais acessar, você pode usar a API da OVHcloud. +Isso permitirá recuperar seus dados de backup a partir de um serviço diferente por meio de vários protocolos (FTP, NFS, CIFS). > [!warning] -> Apenas os endereços IP OVHcloud podem ser autorizados. +> Apenas endereços IP da OVHcloud podem ser autorizados. > -Aceda à [consola API OVHcloud](/links/api) com os identificadores da sua conta de cliente e utilize a seguinte chamada: +Faça login na [console da API da OVHcloud](/links/api) com suas credenciais de conta de cliente e use a seguinte chamada: > [!api] > > @api {v1} /vps POST /vps/{serviceName}/backupftp/access > -Modifique as configurações da seguinte forma: +Edite os parâmetros da seguinte forma: -- `serviceName`: indique o nome interno do seu VPS (`vps-x11x11xyy.vps.ovh.net`). -- `cifs`: defina este parâmetro como `true` se utilizar este protocolo. -- `ftp`: defina este parâmetro como `true` se utilizar este protocolo. -- `ipBlock`: indique o endereço IP que terá acesso, sob a forma `203.0.113.100/32`. -- `nfs`: defina este parâmetro como `true` se utilizar este protocolo. +- `serviceName`: Insira o nome interno do seu VPS (`vps-x11x11xyy.vps.ovh.net`). +- `cifs`: Defina como `true` se aplicável. +- `ftp`: Defina como `true` se aplicável. +- `ipBlock`: Insira o endereço IP que terá acesso, no formato `203.0.113.100/32`. +- `nfs`: Defina como `true` se aplicável. Clique no botão `EXECUTE`{.action}. -Para verificar se o seu endereço IP está corretamente autorizado, utilize a seguinte chamada: +Para verificar se seu endereço IP está autorizado, use a seguinte chamada: > [!api] > > @api {v1} /vps GET /vps/{serviceName}/backupftp/access > +/// + + +/// details | Meu VPS está protegido contra ataques externos? + +Embora a OVHcloud aplique medidas de segurança para proteger toda a infraestrutura, o administrador de um VPS é responsável pela segurança das aplicações e dados hospedados nele. + +- Siga nosso guia sobre [como configurar a firewall da OVHcloud Edge Network](/pages/bare_metal_cloud/dedicated_servers/firewall_network), integrada em nossa infraestrutura Anti-DDoS, limitando a exposição dos seus serviços a ataques DDoS. +- Além disso, você pode usar nossos guias sobre [como configurar sua própria firewall](/pages/bare_metal_cloud/virtual_private_servers/firewall-Linux-iptable) com `iptables` em distribuições baseadas em Linux e [como ativar a firewall no Windows](/pages/bare_metal_cloud/virtual_private_servers/activate-port-firewall-soft-win). +- Para distribuições baseadas em Linux em um VPS, você pode seguir as instruções em nosso guia sobre [como proteger um VPS](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps) para aplicar medidas de segurança adicionais. + +/// + +/// details | Como faço para proteger meu VPS contra ataques DDoS? + +A OVHcloud oferece várias funcionalidades de segurança para proteger seu VPS contra tráfego malicioso: + +- Proteção Anti-DDoS: Nossos serviços de VPS são protegidos por padrão pela nossa [infraestrutura Anti-DDoS](/links/security/antiddos), que detecta e mitiga ataques DDoS em tempo real. +- Bloqueio de IP: Você pode [impedir endereços IP ou faixas específicas](/pages/bare_metal_cloud/virtual_private_servers/secure_your_vps) de acessar seu VPS. +- Regras de firewall: Você pode [configurar regras de firewall personalizadas](/pages/bare_metal_cloud/dedicated_servers/firewall_network) para controlar o tráfego de entrada e saída diretamente no seu VPS. +- VAC (VPS Anti-DDoS): Nosso sistema VAC oferece uma camada adicional de proteção contra ataques DDoS, incluindo filtragem de tráfego e limitação de taxa. + +/// + +/// details | Quero usar um VPS como um servidor de jogo, ele beneficiará da mesma firewall que protege os Servidores Dedicados de Jogo? + +A Proteção contra DDoS de Jogo da OVHcloud está disponível apenas para nossos Servidores Dedicados de Jogo. Se você adquirir um VPS para hospedagem de jogos, será necessário configurar a firewall diretamente no seu sistema, adaptada ao jogo desejado. Você pode encontrar mais informações em nosso guia sobre [como configurar a firewall no Linux com iptables](/pages/bare_metal_cloud/virtual_private_servers/firewall-Linux-iptable). + +A vantagem de um VPS em comparação com um servidor dedicado é a possibilidade de escalar seus recursos de acordo com o uso real. Você pode atualizar seu VPS com apenas alguns cliques para beneficiar-se de um sistema mais potente. + +/// ## Quer saber mais? Se pretender usufruir de uma assistência na utilização e na configuração das suas soluções OVHcloud, consulte as nossas diferentes [ofertas de suporte](/links/support). -Fale com nossa [comunidade de utilizadores](/links/community). \ No newline at end of file +Fale com nossa [comunidade de utilizadores](/links/community). diff --git a/pages/bare_metal_cloud/virtual_private_servers/vps-faq/images/getlicense.png b/pages/bare_metal_cloud/virtual_private_servers/vps-faq/images/getlicense.png new file mode 100644 index 00000000000..e1838867f3d Binary files /dev/null and b/pages/bare_metal_cloud/virtual_private_servers/vps-faq/images/getlicense.png differ diff --git a/pages/bare_metal_cloud/virtual_private_servers/vps-faq/images/getlicense_response.png b/pages/bare_metal_cloud/virtual_private_servers/vps-faq/images/getlicense_response.png new file mode 100644 index 00000000000..c0b70885ff0 Binary files /dev/null and b/pages/bare_metal_cloud/virtual_private_servers/vps-faq/images/getlicense_response.png differ diff --git a/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/guide.en-gb.md b/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/guide.en-gb.md new file mode 100644 index 00000000000..244c7838c1b --- /dev/null +++ b/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/guide.en-gb.md @@ -0,0 +1,145 @@ +--- +title: "Getting started with your Bare Metal Pod SecNumCloud" +excerpt: "Discover how to get started and configure your Bare Metal Pod SecNumCloud environment" +updated: 2025-12-01 +--- + +## Objective + +This guide has been designed to introduce you to how to connect to the graphical interfaces of **Bare Metal Pod** as an administrator of this service. + +## Requirements + +To follow this guide, you will need the following information: + +- The **url** address of the management interface provided when the service was delivered. +- The credentials (login and password) provided when the service was delivered. + +## Instructions + +### Composition of the user interface + +The provided **url** address allows you to access the **Bare Metal Pod** user interface. + +![Keycloak login page](images/keycloak_login.png){.thumbnail} + +Once you have entered your credentials to register, you will have access to the product dashboard. + +![Dashboard visible once identified](images/dashboard.png){.thumbnail} + +Your interface allows you to access: + +- User configuration within *Keycloak* via the menu under your identifier. +- The OpenStack management interface, *Horizon*. This is a web-based graphical interface for managing the entire OpenStack infrastructure. It allows users to use the machine resources made available by administrators. This includes creating, launching and stopping instances, configuring networks, and managing instance accessibility. + +The administration interface of **Bare Metal Pod** also includes access to various APIs such as: Keystone (authentication and identity management), Glance (image management), Nova (compute service), Neutron (network management), Ironic (Bare Metal hardware management), which can be used within your automations. + +### Overview of the OpenStack Horizon Interface + +The OpenStack Horizon graphical interface offers the possibility to perform different actions depending on their permissions and the project to which they belong. Among the main features available to an end user, we can mention: instance management, network management, and resource monitoring. + +#### Access to the OpenStack Horizon administration interface + +From the **Bare Metal Pod** Control Panel, the OpenStack Horizon interface is accessible via the link on the dashboard. + +![Location of the shortcut to Horizon](images/dashboard_login_horizon.png){.thumbnail} + +After logging in, the Horizon OpenStack interface appears as follows: + +![Horizon OpenStack interface](images/horizon_dashboard.png){.thumbnail} + +The side menu located on the left side of the interface provides access to the different elements of the interface. There are two parent entries in this menu: + +![Menu of the OpenStack Horizon interface](images/horizon_menu.png){.thumbnail} + +- **Project** which includes four elements: Overview, API Access, Compute and Network. These elements group all the dedicated server management features, their networks, within the defined quotas. +- **Identity** which includes the elements Projects, Users and Application Credentials that contain the user management features. + +#### Project view + +The main element *Project* is composed of various sub-elements that allow access to all the resource management features. The first sub-element, called *Overview*, provides a global view of the resource quotas assigned to the project, as well as a visual tracking of the overall resource consumption. + +##### Overview section + +![Screenshot of the Overview section](images/horizon_project_overview.png){.thumbnail} + +The *Overview* section is composed of two main parts: + +- **Limit Summary**: The quota limits assigned to the project for each type of resource. This also allows you to visualize the level of resource consumption in relation to the available capacity. + + The quotas are grouped into two categories, as shown in the image below: + + ![Screenshot of the Limit Summary section](images/horizon_quota_categories.png){.thumbnail} + + - **Compute** which includes the instance limits, vCPUs and RAM. + - **Network** which monitors the network resource quotas: Floating IP addresses, security groups, security group rules, networks and ports. + +- **Usage Summary** (Usage summary): historical resource usage over a period that allows you to observe the evolution of resource usage over time. + +![Screenshot of the Usage Summary section](images/horizon_quota_historical.png){.thumbnail} + +##### API Access section + +The **API-Access** tab groups the 10 services available via API such as Bare-Metal, Compute, identity, image and network, as well as their endpoints URLs. + +![Screenshot of the API-Access section](images/horizon_project_apiaccess.png){.thumbnail} + +Thanks to these Endpoints, it is possible to communicate directly with the OpenStack components using API requests. This information is necessary if you are required to implement your own HTTP requests with the OpenStack APIs. + +If you use existing OpenStack integrations, these will retrieve this information during the first connection to the OpenStack Keystone component. This one is responsible for providing this information programmatically. + +#### Compute view + +The **Compute** view groups the features allowing you to configure the dedicated servers of your product. This view is divided into different sections: + +##### Instances section + +Interface allowing you to list and manage already configured dedicated servers. An *Instance* corresponds to a dedicated server. + +![Screenshot of the Instances section](images/horizon_instance_list.png){.thumbnail} + +##### Images section + +You have the possibility to manage the OS images available to create instances. It is also possible to download new images or select from already available images to set up instances. You can thus generate your own images to manage additional operating systems. + +> [!warning] +> +> The images must take into account the drivers of the hardware delivered in your product. Many images available for Glance are only available for virtual environments based on qemu or kvm drivers. +> + +![Screenshot of the Images section](images/horizon_image_list.png){.thumbnail} + +##### Key Pairs section + +In order to authenticate via SSH on your machines after installation, you need to use asymmetric encryption keys. This interface allows you to import public keys that will be deployed during the installation of the dedicated servers to ensure an SSH connection. + +![Screenshot of the Key Pairs section](images/horizon_sshkey_list.png){.thumbnail} + +#### Network view + +The Network view allows you to visualize and manage the networks of your **Bare Metal Pod** service. This interface allows you to create shared or distinct networks between your dedicated servers. + +> [!primary] +> +> All of your network configuration is managed by this graphical interface or via the **OpenStack** APIs with the network component named **Neutron**. The switches in your infrastructure will be automatically configured from the OpenStack information. +> + +##### Network Topology section + +This section shows you all the networks created on this Pod via a vertical line of color. The squares correspond to services or dedicated servers connected to one or more of these networks. + +![Screenshot of the Network Topology section](images/horizon_network_topology.png){.thumbnail} + +##### Networks section + +This section contains the list of available networks for the dedicated servers on your **Bare Metal Pod**. + +![Screenshot of the Networks section](images/horizon_network_list.png){.thumbnail} + +For more information on how networks work with OpenStack, we recommend you consult the [OpenStack Networking](https://docs.openstack.org/neutron/2024.1/admin/intro-os-networking.html) documentation. + +## Go further + +If you need training or technical assistance for the implementation of our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and request a custom analysis of your project from our Professional Services team experts. + +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/guide.fr-fr.md b/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/guide.fr-fr.md new file mode 100644 index 00000000000..ddea7d1a618 --- /dev/null +++ b/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/guide.fr-fr.md @@ -0,0 +1,145 @@ +--- +title: "Mise en route de votre Bare Metal Pod SecNumCloud" +excerpt: "Découvrez comment prendre en main et configurer votre environnement Bare Metal Pod SecNumCloud" +updated: 2025-12-01 +--- + +## Objectif + +Ce guide a été conçu pour vous présenter comment vous connecter aux interfaces graphiques de **Bare Metal Pod** en tant que qu'administrateur de ce service. + +## Prérequis + +Afin de suivre ce guide, vous aurez besoin des informations suivantes : + +- L'adresse **url** de l'interface de gestion fournie lors de la livraison du service. +- Les identifiants (login et mot de passe) fournies lors de la livraison du service. + +## En pratique + +### Composition de l'interface utilisateur + +L'adresse **url** fournie vous permet d'accéder à l'interface utilisateur de **Bare Metal Pod**. + +![Page de connexion Keycloak](images/keycloak_login.png){.thumbnail} + +Une fois vos identifiants saisis pour vous enregistrer, vous aurez accès au tableau de bord du produit. + +![Dashboard visible une fois identifié](images/dashboard.png){.thumbnail} + +Votre interface vous permet d'accéder à : + +- La configuration des utilisateurs au sein de *Keycloak* via le menu sous votre identifiant. +- L'interface de gestion de OpenStack, *Horizon*. C’est une interface web graphique pour gérer l'ensemble de l'infrastructure OpenStack. Elle permet à l’utilisateur d’exploiter les ressources machines mises à disposition par les administrateurs. Ceci passe par la création, le lancement et l’arrêt des instances, la configuration des réseaux, la gestion de l’accessibilité des instances. + +L’interface d’administration de **Bare Metal Pod** regroupe également les accès aux différentes APIs telles que : Keystone (authentification et gestion des identités), Glance (gestion des images), Nova (service de calcul), Neutron (gestion du réseau), Ironic (gestion du matériel "Bare Metal") qui peuvent être utilisées au sein de vos automatisations. + +### Présentation de l'Interface OpenStack Horizon + +L'interface graphique d'OpenStack Horizon offre la possibilité de réaliser différentes actions en fonction de leurs autorisations et du projet auquel elles appartiennent. Parmi les principales fonctionnalités disponibles pour un utilisateur final, on peut citer : la gestion des instances, la gestion des réseaux, le suivi des ressources. + +#### Accès à l'interface d'administration OpenStack Horizon + +Depuis l'espace client de **Bare Metal Pod**, l’interface OpenStack Horizon est accessible via le lien dans le tableau de bord. + +![Emplacement du raccourci vers Horizon](images/dashboard_login_horizon.png){.thumbnail} + +Après s’être connecté, l'interface Horizon OpenStack se présente ainsi : + +![Interface Horizon OpenStack](images/horizon_dashboard.png){.thumbnail} + +Le menu latéral situé à gauche de l'interface offre un accès aux différents éléments de l'interface. Il y a deux entrées parentes dans ce menu : + +![Menu de l’interface OpenStack Horizon](images/horizon_menu.png){.thumbnail} + +- **Projet** qui comprend quatre éléments : Aperçu (Overview), Accès à l'API (API Access), Compute et Réseau (Network). Ces éléments regroupent l'ensemble des fonctionnalités de gestion des serveurs dédiés, de leurs réseaux, dans les limites de quotas définis. +- **Identité (Identity)** qui inclut les éléments Projets, Utilisateurs et identifiants d'application qui contiennent les fonctionnalités de gestion des utilisateurs. + +#### Vue projet + +L'élément principal *Projet* est composé de divers sous-éléments qui permettent d'accéder à toutes les fonctionnalités de gestion des ressources. Le premier sous-élément, appelé *Aperçu* (Overview), offre une vision globale des quotas de ressources attribuées au projet, ainsi qu’un suivi visuel de la consommation globale des ressources. + +##### Section Overview + +![Capture d'écran de la section Overview (vue d'ensemble)](images/horizon_project_overview.png){.thumbnail} + +La section *Overview* (Aperçu) est composée de deux parties principales : + +- **Limit Summary** : Les limites de quotas attribuées au projet pour chaque type de ressource. Ceci permet également de visualiser le niveau de consommation des ressources par rapport aux capacités disponibles. + + Les quotas sont regroupés en deux catégories, telles que représentées dans l'image ci-dessous : + + ![Capture d'écran de la section Limit Summary](images/horizon_quota_categories.png){.thumbnail} + + - **Compute** qui comprend les limites des instances, les vCPUs et la RAM. + - **Network** qui surveille les quotas des ressources réseau : les adresses Floating IP, les groupes de sécurité, les règles de sécurité des groupes, les réseaux et les ports. + +- **Usage Summary** (Résumé de l'utilisation) : historique d’utilisation des ressources sur une période qui permet d'observer l'évolution de l'usage des ressources dans le temps. + +![Capture d'écran de la section Usage Summary](images/horizon_quota_historical.png){.thumbnail} + +##### Section API Access + +L'onglet **API-Access** regroupe les 10 services disponibles via API tels que Bare-Metal, Compute, identité, image et réseau, ainsi que leurs URL de points d'accès. + +![Capture d'écran de la section API-Access](images/horizon_project_apiaccess.png){.thumbnail} + +Grâce à ces *Endpoints*, il est possible de communiquer directement avec les composants OpenStack en utilisant des requêtes API. Ces informations vous sont nécessaires si vous êtes amenés à implémenter vous même des requêtes HTTP avec les API de OpenStack. + +Si vous utilisez des intégrations OpenStack existantes, ces dernières récupéreront ces informations lors de la première connexion au composant OpenStack Keystone. Ce dernier se charge de fournir de manière programmatique ces informations. + +#### Vue Compute + +La vue **Compute** regroupe les fonctionnalités permettant de configurer les serveurs dédiés de votre produit. Cette vue est divisée en différentes sections : + +##### Section Instances + +Interface permettant de lister et de gérer les serveurs dédiés déjà configurés. Une *Instance* correspond à un serveur dédié. + +![Capture d'écran de la section Instances](images/horizon_instance_list.png){.thumbnail} + +##### Section Images + +Vous avez la possibilité de gérer les images des OS disponibles pour créer des instances. Il est aussi possible de télécharger de nouvelles images ou de sélectionner parmi les images déjà disponibles afin de mettre en place des instances. Vous pouvez ainsi générer vos propres images pour gérer des systèmes d'exploitation supplémentaires. + +> [!warning] +> +> Les images doivent prendre en compte les drivers du hardware délivré dans votre produit. De nombreuses images disponible pour Glance ne sont disponibles que pour des environnements virtuels basés sur les drivers de qemu ou de kvm. +> + +![Capture d'écran de la section Images](images/horizon_image_list.png){.thumbnail} + +##### Section Key Pairs + +Afin de vous authentifier en SSH sur vos machines après l'installation, il faut utiliser des clés de chiffrement asymétriques. Cette interface permet d'importer les clés publiques qui seront déployées durant l'installation des serveurs dédiés afin de vous assurer une connexion SSH. + +![Capture d'écran de la section Key Pairs](images/horizon_sshkey_list.png){.thumbnail} + +#### Vue Network + +La Vue Network (réseau) vous permet de visualiser et gérer les réseaux de votre service **Bare Metal Pod**. Cette interface permet de créer des réseaux mutualisés ou distincts entre vos serveurs dédiés. + +> [!primary] +> +> L'ensemble de votre configuration réseau est pilotée par cette interface graphique ou via les API de **OpenStack** avec le composant réseau nommé **Neutron**. Les switchs de votre infrastructure seront automatiquement configurés à partir des informations de OpenStack. +> + +##### Section Network Topology + +Cette section vous présente l'ensemble des réseaux créés sur ce Pod via une ligne verticale de couleur. Les carrés correspondent à des services ou des serveurs dédiés connectés à un ou plusieurs de ces réseaux. + +![Capture d'écran de la section Network Topology](images/horizon_network_topology.png){.thumbnail} + +##### Section Networks + +Cette section contient la liste des réseaux disponibles pour les serveurs dédiés sur votre **Bare Metal Pod**. + +![Capture d'écran de la section Networks](images/horizon_network_list.png){.thumbnail} + +Pour en savoir plus sur le fonctionnement des réseaux avec OpenStack, nous vous conseillons de consulter la documentation [OpenStack Networking](https://docs.openstack.org/neutron/2024.1/admin/intro-os-networking.html). + +## Aller plus loin + +Si vous avez besoin d'une formation ou d'une assistance technique pour la mise en oeuvre de nos solutions, contactez votre commercial ou cliquez sur [ce lien](/links/professional-services) pour obtenir un devis et demander une analyse personnalisée de votre projet à nos experts de l’équipe Professional Services. + +Échangez avec notre [communauté d'utilisateurs](/links/community). diff --git a/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/images/dashboard.png b/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/images/dashboard.png new file mode 100644 index 00000000000..932b7ddd32b Binary files /dev/null and b/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/images/dashboard.png differ diff --git a/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/images/dashboard_login_horizon.png b/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/images/dashboard_login_horizon.png new file mode 100644 index 00000000000..1974754b1f3 Binary files /dev/null and b/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/images/dashboard_login_horizon.png differ diff --git a/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/images/horizon_dashboard.png b/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/images/horizon_dashboard.png new file mode 100644 index 00000000000..f9621766dd8 Binary files /dev/null and b/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/images/horizon_dashboard.png differ diff --git a/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/images/horizon_image_list.png b/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/images/horizon_image_list.png new file mode 100644 index 00000000000..97f4f9bffda Binary files /dev/null and b/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/images/horizon_image_list.png differ diff --git a/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/images/horizon_instance_list.png b/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/images/horizon_instance_list.png new file mode 100644 index 00000000000..27177ffba93 Binary files /dev/null and b/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/images/horizon_instance_list.png differ diff --git a/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/images/horizon_menu.png b/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/images/horizon_menu.png new file mode 100644 index 00000000000..e027b837227 Binary files /dev/null and b/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/images/horizon_menu.png differ diff --git a/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/images/horizon_network_list.png b/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/images/horizon_network_list.png new file mode 100644 index 00000000000..dd4572d5992 Binary files /dev/null and b/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/images/horizon_network_list.png differ diff --git a/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/images/horizon_network_topology.png b/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/images/horizon_network_topology.png new file mode 100644 index 00000000000..26a0efb5a07 Binary files /dev/null and b/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/images/horizon_network_topology.png differ diff --git a/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/images/horizon_project_apiaccess.png b/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/images/horizon_project_apiaccess.png new file mode 100644 index 00000000000..975b45bc17a Binary files /dev/null and b/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/images/horizon_project_apiaccess.png differ diff --git a/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/images/horizon_project_overview.png b/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/images/horizon_project_overview.png new file mode 100644 index 00000000000..c42bbb8c0b3 Binary files /dev/null and b/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/images/horizon_project_overview.png differ diff --git a/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/images/horizon_quota_categories.png b/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/images/horizon_quota_categories.png new file mode 100644 index 00000000000..8935b792ca4 Binary files /dev/null and b/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/images/horizon_quota_categories.png differ diff --git a/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/images/horizon_quota_historical.png b/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/images/horizon_quota_historical.png new file mode 100644 index 00000000000..d30b83778cd Binary files /dev/null and b/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/images/horizon_quota_historical.png differ diff --git a/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/images/horizon_sshkey_list.png b/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/images/horizon_sshkey_list.png new file mode 100644 index 00000000000..82d4636b5ca Binary files /dev/null and b/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/images/horizon_sshkey_list.png differ diff --git a/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/images/keycloak_login.png b/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/images/keycloak_login.png new file mode 100644 index 00000000000..a5ded17bda2 Binary files /dev/null and b/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/images/keycloak_login.png differ diff --git a/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/meta.yaml b/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/meta.yaml new file mode 100644 index 00000000000..b176f4b2e33 --- /dev/null +++ b/pages/hosted_private_cloud/baremetal_pod/snc_getting_started/meta.yaml @@ -0,0 +1,2 @@ +id: ab6d1ee4-b6e7-4cff-976e-e0025881f866 +full_slug: bmpod-secnumcloud-getting-started \ No newline at end of file diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/activer_l_option_hds_hipaa_ou_pci_dss/images/AdminPass.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/activer_l_option_hds_hipaa_ou_pci_dss/images/AdminPass.png deleted file mode 100644 index 4b9b11c3007..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/activer_l_option_hds_hipaa_ou_pci_dss/images/AdminPass.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/activer_l_option_hds_hipaa_ou_pci_dss/images/HDSPrerequisContact.PNG b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/activer_l_option_hds_hipaa_ou_pci_dss/images/HDSPrerequisContact.PNG deleted file mode 100644 index 715d2cdd4ff..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/activer_l_option_hds_hipaa_ou_pci_dss/images/HDSPrerequisContact.PNG and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/activer_l_option_hds_hipaa_ou_pci_dss/images/HDSPrerequisHost.PNG b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/activer_l_option_hds_hipaa_ou_pci_dss/images/HDSPrerequisHost.PNG deleted file mode 100644 index 81d0b30ff51..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/activer_l_option_hds_hipaa_ou_pci_dss/images/HDSPrerequisHost.PNG and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/activer_l_option_hds_hipaa_ou_pci_dss/images/HDSPrerequisIP.PNG b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/activer_l_option_hds_hipaa_ou_pci_dss/images/HDSPrerequisIP.PNG deleted file mode 100644 index 58e1dd6d77b..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/activer_l_option_hds_hipaa_ou_pci_dss/images/HDSPrerequisIP.PNG and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/activer_l_option_hds_hipaa_ou_pci_dss/images/HDSprerequisOptions.PNG b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/activer_l_option_hds_hipaa_ou_pci_dss/images/HDSprerequisOptions.PNG deleted file mode 100644 index 60fdf6a922f..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/activer_l_option_hds_hipaa_ou_pci_dss/images/HDSprerequisOptions.PNG and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/activer_l_option_hds_hipaa_ou_pci_dss/images/TokenValidation.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/activer_l_option_hds_hipaa_ou_pci_dss/images/TokenValidation.png deleted file mode 100644 index 3c35136c57c..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/activer_l_option_hds_hipaa_ou_pci_dss/images/TokenValidation.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip/guide.en-gb.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip/guide.en-gb.md index 6a9685e7967..0355600f47a 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip/guide.en-gb.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip/guide.en-gb.md @@ -40,7 +40,7 @@ You will need to fill in several fields in order to create your IP block. > [!primary] > -> Please feel free to refer to our guide on the [OVHcloud Network plugin](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/plugin_ovh_network){.external-link} to find out which IPs are reserved for your block, as well as how they are used. +> Please feel free to refer to our guide on the [OVHcloud Network plugin](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/plugin_ovh_network) to find out which IPs are reserved for your block, as well as how they are used. > - The country an IP block is hosted in is important in some cases, for your services’ SEO ranking (a website based in France will have a higher SEO ranking in France if the IP address is French, too). diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip/guide.fr-ca.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip/guide.fr-ca.md index 90dd2912807..84cfd4a8d2a 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip/guide.fr-ca.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip/guide.fr-ca.md @@ -40,7 +40,7 @@ Plusieurs champs seront à remplir pour la création de votre bloc IP > [!primary] > -> N'hésitez pas à consulter notre guide sur le [plugin OVHcloud Network](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/plugin_ovh_network){.external-link} afin de savoir quelles sont les IPs réservées de votre bloc ainsi que leur utilisation. +> N'hésitez pas à consulter notre guide sur le [plugin OVHcloud Network](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/plugin_ovh_network) afin de savoir quelles sont les IPs réservées de votre bloc ainsi que leur utilisation. > - Pays du bloc IP, important dans certains cas pour le référencement de vos services (un site à affluence française aura un meilleur référencement en France si l'IP est française également) diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip/guide.fr-fr.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip/guide.fr-fr.md index 87690104eed..6f00398a18d 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip/guide.fr-fr.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip/guide.fr-fr.md @@ -40,7 +40,7 @@ Plusieurs champs seront à remplir pour la création de votre bloc IP > [!primary] > -> N'hésitez pas à consulter notre guide sur le [plugin OVHcloud Network](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/plugin_ovh_network){.external-link} afin de savoir quelles sont les IPs réservées de votre bloc ainsi que leur utilisation. +> N'hésitez pas à consulter notre guide sur le [plugin OVHcloud Network](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/plugin_ovh_network) afin de savoir quelles sont les IPs réservées de votre bloc ainsi que leur utilisation. > - Pays du bloc IP, important dans certains cas pour le référencement de vos services (un site à affluence française aura un meilleur référencement en France si l'IP est française également) diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip/guide.pl-pl.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip/guide.pl-pl.md index 1f6f3bda97e..4238cfb8c18 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip/guide.pl-pl.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip/guide.pl-pl.md @@ -40,7 +40,7 @@ Utworzenie bloku IP wymaga wypełnienia następujących pól > [!primary] > -> Zapoznaj się z naszym przewodnikiem dotyczącym [wtyczki OVHcloud Network](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/plugin_ovh_network){.external-link}, aby dowiedzieć się, jakie IP zarezerwowano dla Twojego bloku oraz jak są wykorzystywane. +> Zapoznaj się z naszym przewodnikiem dotyczącym [wtyczki OVHcloud Network](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/plugin_ovh_network), aby dowiedzieć się, jakie IP zarezerwowano dla Twojego bloku oraz jak są wykorzystywane. > - Kraj bloku IP, ważny w niektórych przypadkach dla pozycjonowania Twoich witryn (strona internetowa skierowana do Polaków będzie lepiej pozycjonowana, jeśli ma polski adres IP). diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip/guide.pt-pt.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip/guide.pt-pt.md index 05e3772e3c0..85d5747454f 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip/guide.pt-pt.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip/guide.pt-pt.md @@ -40,7 +40,7 @@ Vários campos deverão ser preenchidos para criar o seu bloco IP > [!primary] > -> Não hesite em consultar o nosso manual sobre o [plugin OVHcloud Network](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/plugin_ovh_network){.external-link} para saber quais são os IP reservados do seu bloco, assim como a sua utilização. +> Não hesite em consultar o nosso manual sobre o [plugin OVHcloud Network](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/plugin_ovh_network) para saber quais são os IP reservados do seu bloco, assim como a sua utilização. > - País do bloco IP: importante em certos casos para o referenciamento dos seus serviços (um site português terá um melhor SEO em Portugal se o IP também for português) diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip/images/AddInfos.PNG b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip/images/AddInfos.PNG deleted file mode 100644 index 292b21fa67a..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip/images/AddInfos.PNG and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip/images/CGV.PNG b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip/images/CGV.PNG deleted file mode 100644 index 61ac7ed11c6..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip/images/CGV.PNG and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip/images/ConfirmPrice.PNG b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip/images/ConfirmPrice.PNG deleted file mode 100644 index da9b43a168c..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip/images/ConfirmPrice.PNG and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip/images/Order.PNG b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip/images/Order.PNG deleted file mode 100644 index 31895e892e4..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip/images/Order.PNG and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip/images/OrderAdditionalIps.PNG b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip/images/OrderAdditionalIps.PNG deleted file mode 100644 index 6574c5c11bd..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip/images/OrderAdditionalIps.PNG and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip/images/SelectService.PNG b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip/images/SelectService.PNG deleted file mode 100644 index 8d8bd059f28..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip/images/SelectService.PNG and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/autoriser_des_ip_a_se_connecter_au_vcenter/guide.pl-pl.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/autoriser_des_ip_a_se_connecter_au_vcenter/guide.pl-pl.md index 7ab1fcf19c7..96bb4d8724b 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/autoriser_des_ip_a_se_connecter_au_vcenter/guide.pl-pl.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/autoriser_des_ip_a_se_connecter_au_vcenter/guide.pl-pl.md @@ -18,7 +18,7 @@ Dostęp do vCenter jest ograniczony wyłącznie do uprawnionych adresów IP. Dostęp do vCenter jest domyślnie ograniczony. Należy zatem dodać adresy IP, które będą mogły łączyć się z usługą. -Operacja ta przeprowadzana jest w [Panelu klienta OVHcloud](/links/manager){.external-link}. W sekcji `Hosted Private Cloud`{.action}, kliknij sekcję `VMware`{.action}. +Operacja ta przeprowadzana jest w [Panelu klienta OVHcloud](/links/manager). W sekcji `Hosted Private Cloud`{.action}, kliknij sekcję `VMware`{.action}. Wybierz infrastrukturę, przejdź do zakładki `Bezpieczeństwo`{.action}, po czym kliknij `Dodaj nowy zakres adresów IP`{.action}. diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/autoriser_des_ip_a_se_connecter_au_vcenter/images/AjoutIP.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/autoriser_des_ip_a_se_connecter_au_vcenter/images/AjoutIP.png deleted file mode 100644 index 34682169e81..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/autoriser_des_ip_a_se_connecter_au_vcenter/images/AjoutIP.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/autoriser_des_ip_a_se_connecter_au_vcenter/images/AjoutIP1.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/autoriser_des_ip_a_se_connecter_au_vcenter/images/AjoutIP1.png deleted file mode 100644 index 76b00e48154..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/autoriser_des_ip_a_se_connecter_au_vcenter/images/AjoutIP1.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/changement_du_mot_de_passe_utilisateur/images/addMailOnUser.JPG b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/changement_du_mot_de_passe_utilisateur/images/addMailOnUser.JPG deleted file mode 100644 index 331c3afe8a8..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/changement_du_mot_de_passe_utilisateur/images/addMailOnUser.JPG and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/changement_du_mot_de_passe_utilisateur/images/change-password-popup.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/changement_du_mot_de_passe_utilisateur/images/change-password-popup.png deleted file mode 100644 index e5a664e54ed..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/changement_du_mot_de_passe_utilisateur/images/change-password-popup.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/changement_du_mot_de_passe_utilisateur/images/change-password.jpg b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/changement_du_mot_de_passe_utilisateur/images/change-password.jpg deleted file mode 100644 index 51dbc4f9f96..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/changement_du_mot_de_passe_utilisateur/images/change-password.jpg and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/changement_du_mot_de_passe_utilisateur/images/change-password.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/changement_du_mot_de_passe_utilisateur/images/change-password.png deleted file mode 100644 index 0f01d0cad88..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/changement_du_mot_de_passe_utilisateur/images/change-password.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/changement_du_mot_de_passe_utilisateur/images/changePassword.JPG b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/changement_du_mot_de_passe_utilisateur/images/changePassword.JPG deleted file mode 100644 index 976a6fc8761..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/changement_du_mot_de_passe_utilisateur/images/changePassword.JPG and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/changement_du_mot_de_passe_utilisateur/images/pass1.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/changement_du_mot_de_passe_utilisateur/images/pass1.png deleted file mode 100644 index cdd6ab4587f..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/changement_du_mot_de_passe_utilisateur/images/pass1.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/changement_du_mot_de_passe_utilisateur/images/users-rights.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/changement_du_mot_de_passe_utilisateur/images/users-rights.png deleted file mode 100644 index 766cbe72574..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/changement_du_mot_de_passe_utilisateur/images/users-rights.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.de-de.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.de-de.md index a66b6f539a3..bac80c47e8c 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.de-de.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.de-de.md @@ -56,7 +56,7 @@ Dieser Prozess wird in 4 Phasen unterteilt. Das Update für vCenter wird von OVHcloud durchgeführt. Der Patch für die ESXi-Hosts wird von Ihnen selbst durchgeführt und ist im [Update Manager](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vmware_update_manager) verfügbar. -Die Liste mit den Patches für ESXi-Hosts finden Sie in [diesem Dokument](https://www.vmware.com/security/advisories/VMSA-2018-0020.html){.external-link}. +Die Liste mit den Patches für ESXi-Hosts finden Sie in [diesem Dokument](https://www.vmware.com/security/advisories/VMSA-2018-0020.html). Nach dem Update der Hosts wird die folgende Warnung in der Zusammenfassung Ihres Hosts angezeigt: @@ -66,7 +66,7 @@ Nach dem Update der Hosts wird die folgende Warnung in der Zusammenfassung Ihres Wenn die ESXi-Hosts aktualisiert wurden, ist der Patch noch nicht umgesetzt. -Bevor Sie diesen jedoch ausführen, sollten Sie die möglichen Probleme, die in der bereits erwähnten [Knowledge Base](https://kb.vmware.com/s/article/55806){.external-link} aufgeführt werden, sowie die in einer anderen Knowledge Base aufgeführten Leistungseinschränkungen beachten: [https://kb.vmware.com/s/article/55767](https://kb.vmware.com/s/article/55767). +Bevor Sie diesen jedoch ausführen, sollten Sie die möglichen Probleme, die in der bereits erwähnten [Knowledge Base](https://kb.vmware.com/s/article/55806) aufgeführt werden, sowie die in einer anderen Knowledge Base aufgeführten Leistungseinschränkungen beachten: [https://kb.vmware.com/s/article/55767](https://kb.vmware.com/s/article/55767). ### 3. Aktivierungsphase @@ -78,11 +78,11 @@ In dem Fenster ist rechts oben ein Filter verfügbar. Dieser Vorgang muss für jeden Host durchgeführt werden. -Weitere Informationen finden Sie in Schritt 3 im Bereich „Resolution“ in dieser [VMware Knowledge Base](https://kb.vmware.com/s/article/55806){.external-link}. +Weitere Informationen finden Sie in Schritt 3 im Bereich „Resolution“ in dieser [VMware Knowledge Base](https://kb.vmware.com/s/article/55806). > [!warning] > -> Wenn Sie die verschiedenen Elemente überprüft haben und zu dem Schluss gekommen sind, dass Sie Hyperthreading nicht deaktivieren möchten, können Sie, wie in dieser [Knowledge Base](https://kb.vmware.com/s/article/57374){.external-link} beschrieben, die Warnung löschen. +> Wenn Sie die verschiedenen Elemente überprüft haben und zu dem Schluss gekommen sind, dass Sie Hyperthreading nicht deaktivieren möchten, können Sie, wie in dieser [Knowledge Base](https://kb.vmware.com/s/article/57374) beschrieben, die Warnung löschen. > > ![](images/deleteWarning.png){.thumbnail} > Dies wird von OVHcloud keinesfalls empfohlen. OVHcloud kann daher nicht für mögliche Folgen verantwortlich gemacht werden. diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.en-asia.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.en-asia.md index 5033dca59ae..9053c35ae7e 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.en-asia.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.en-asia.md @@ -37,7 +37,7 @@ As a reminder: For **Private Cloud** solutions, only SDDC packs are affected by this vulnerability. -For further information, you can refer to our [news article](https://www.ovh.co.uk/news/articles/al479.ovh-l1-terminal-fault-l1tf-foreshadow-disclosure){.external-link}. +For further information, you can refer to our [news article](https://www.ovh.co.uk/news/articles/al479.ovh-l1-terminal-fault-l1tf-foreshadow-disclosure). ## Mitigation process @@ -48,15 +48,15 @@ For further information, you can refer to our [news article](https://www.ovh.co. > The actions describe how to disable hyper-threading on your ESXi hosts. But since the L1TF vulnerability requires hyper-threading to work, disabling it protects your infrastructure from being exploited by this vulnerability. > -The mitigation process is described in this VMware knowledge base: [https://kb.vmware.com/s/article/55806](https://kb.vmware.com/s/article/55806){.external-link}. +The mitigation process is described in this VMware knowledge base: [https://kb.vmware.com/s/article/55806](https://kb.vmware.com/s/article/55806). This procedure is divided into three distinct steps. ### Step 1: Update. -The vCenter update is managed by OVHcloud, however, it is your responsibility to install the patch for ESXi hosts. This is available in the [the Update Manager](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vmware_update_manager){.external-link}. +The vCenter update is managed by OVHcloud, however, it is your responsibility to install the patch for ESXi hosts. This is available in the [the Update Manager](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vmware_update_manager). -You will find the list of patches for ESXi hosts in [this document](https://www.vmware.com/security/advisories/VMSA-2018-0020.html){.external-link}. +You will find the list of patches for ESXi hosts in [this document](https://www.vmware.com/security/advisories/VMSA-2018-0020.html). After the hosts have been updated, the following alert message will appear in your host summary: @@ -66,7 +66,7 @@ After the hosts have been updated, the following alert message will appear in yo After the ESXi hosts have been updated, the patch has not yet been applied. -It is important to be aware of the potential problems listed in the [knowledge base](https://kb.vmware.com/s/article/55806){.external-link} mentioned above, as well as the performance loss observed in this other knowledge base: [https://kb.vmware.com/s/article/55767](https://kb.vmware.com/s/article/55767){.external-link}. +It is important to be aware of the potential problems listed in the [knowledge base](https://kb.vmware.com/s/article/55806) mentioned above, as well as the performance loss observed in this other knowledge base: [https://kb.vmware.com/s/article/55767](https://kb.vmware.com/s/article/55767). ### Step 3: Enable. @@ -78,11 +78,11 @@ A filter is available in the top right-hand corner of the window. You will need to do this for each host. -To find out more, you can go to step 3 in the ‘Resolution’ section of this [VMware knowledge base](https://kb.vmware.com/s/article/55806){.external-link}. +To find out more, you can go to step 3 in the ‘Resolution’ section of this [VMware knowledge base](https://kb.vmware.com/s/article/55806). > [!warning] > -> If you do not want to disable hyper-threading on these elements, you can remove the alert message by following this [knowledge base](https://kb.vmware.com/s/article/57374){.external-link}. +> If you do not want to disable hyper-threading on these elements, you can remove the alert message by following this [knowledge base](https://kb.vmware.com/s/article/57374). > > ![](images/deleteWarning.png){.thumbnail} > OVHcloud does not recommend doing this, and cannot be held responsible for this risk or any resulting consequences. diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.en-au.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.en-au.md index 5033dca59ae..9053c35ae7e 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.en-au.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.en-au.md @@ -37,7 +37,7 @@ As a reminder: For **Private Cloud** solutions, only SDDC packs are affected by this vulnerability. -For further information, you can refer to our [news article](https://www.ovh.co.uk/news/articles/al479.ovh-l1-terminal-fault-l1tf-foreshadow-disclosure){.external-link}. +For further information, you can refer to our [news article](https://www.ovh.co.uk/news/articles/al479.ovh-l1-terminal-fault-l1tf-foreshadow-disclosure). ## Mitigation process @@ -48,15 +48,15 @@ For further information, you can refer to our [news article](https://www.ovh.co. > The actions describe how to disable hyper-threading on your ESXi hosts. But since the L1TF vulnerability requires hyper-threading to work, disabling it protects your infrastructure from being exploited by this vulnerability. > -The mitigation process is described in this VMware knowledge base: [https://kb.vmware.com/s/article/55806](https://kb.vmware.com/s/article/55806){.external-link}. +The mitigation process is described in this VMware knowledge base: [https://kb.vmware.com/s/article/55806](https://kb.vmware.com/s/article/55806). This procedure is divided into three distinct steps. ### Step 1: Update. -The vCenter update is managed by OVHcloud, however, it is your responsibility to install the patch for ESXi hosts. This is available in the [the Update Manager](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vmware_update_manager){.external-link}. +The vCenter update is managed by OVHcloud, however, it is your responsibility to install the patch for ESXi hosts. This is available in the [the Update Manager](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vmware_update_manager). -You will find the list of patches for ESXi hosts in [this document](https://www.vmware.com/security/advisories/VMSA-2018-0020.html){.external-link}. +You will find the list of patches for ESXi hosts in [this document](https://www.vmware.com/security/advisories/VMSA-2018-0020.html). After the hosts have been updated, the following alert message will appear in your host summary: @@ -66,7 +66,7 @@ After the hosts have been updated, the following alert message will appear in yo After the ESXi hosts have been updated, the patch has not yet been applied. -It is important to be aware of the potential problems listed in the [knowledge base](https://kb.vmware.com/s/article/55806){.external-link} mentioned above, as well as the performance loss observed in this other knowledge base: [https://kb.vmware.com/s/article/55767](https://kb.vmware.com/s/article/55767){.external-link}. +It is important to be aware of the potential problems listed in the [knowledge base](https://kb.vmware.com/s/article/55806) mentioned above, as well as the performance loss observed in this other knowledge base: [https://kb.vmware.com/s/article/55767](https://kb.vmware.com/s/article/55767). ### Step 3: Enable. @@ -78,11 +78,11 @@ A filter is available in the top right-hand corner of the window. You will need to do this for each host. -To find out more, you can go to step 3 in the ‘Resolution’ section of this [VMware knowledge base](https://kb.vmware.com/s/article/55806){.external-link}. +To find out more, you can go to step 3 in the ‘Resolution’ section of this [VMware knowledge base](https://kb.vmware.com/s/article/55806). > [!warning] > -> If you do not want to disable hyper-threading on these elements, you can remove the alert message by following this [knowledge base](https://kb.vmware.com/s/article/57374){.external-link}. +> If you do not want to disable hyper-threading on these elements, you can remove the alert message by following this [knowledge base](https://kb.vmware.com/s/article/57374). > > ![](images/deleteWarning.png){.thumbnail} > OVHcloud does not recommend doing this, and cannot be held responsible for this risk or any resulting consequences. diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.en-ca.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.en-ca.md index 5033dca59ae..9053c35ae7e 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.en-ca.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.en-ca.md @@ -37,7 +37,7 @@ As a reminder: For **Private Cloud** solutions, only SDDC packs are affected by this vulnerability. -For further information, you can refer to our [news article](https://www.ovh.co.uk/news/articles/al479.ovh-l1-terminal-fault-l1tf-foreshadow-disclosure){.external-link}. +For further information, you can refer to our [news article](https://www.ovh.co.uk/news/articles/al479.ovh-l1-terminal-fault-l1tf-foreshadow-disclosure). ## Mitigation process @@ -48,15 +48,15 @@ For further information, you can refer to our [news article](https://www.ovh.co. > The actions describe how to disable hyper-threading on your ESXi hosts. But since the L1TF vulnerability requires hyper-threading to work, disabling it protects your infrastructure from being exploited by this vulnerability. > -The mitigation process is described in this VMware knowledge base: [https://kb.vmware.com/s/article/55806](https://kb.vmware.com/s/article/55806){.external-link}. +The mitigation process is described in this VMware knowledge base: [https://kb.vmware.com/s/article/55806](https://kb.vmware.com/s/article/55806). This procedure is divided into three distinct steps. ### Step 1: Update. -The vCenter update is managed by OVHcloud, however, it is your responsibility to install the patch for ESXi hosts. This is available in the [the Update Manager](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vmware_update_manager){.external-link}. +The vCenter update is managed by OVHcloud, however, it is your responsibility to install the patch for ESXi hosts. This is available in the [the Update Manager](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vmware_update_manager). -You will find the list of patches for ESXi hosts in [this document](https://www.vmware.com/security/advisories/VMSA-2018-0020.html){.external-link}. +You will find the list of patches for ESXi hosts in [this document](https://www.vmware.com/security/advisories/VMSA-2018-0020.html). After the hosts have been updated, the following alert message will appear in your host summary: @@ -66,7 +66,7 @@ After the hosts have been updated, the following alert message will appear in yo After the ESXi hosts have been updated, the patch has not yet been applied. -It is important to be aware of the potential problems listed in the [knowledge base](https://kb.vmware.com/s/article/55806){.external-link} mentioned above, as well as the performance loss observed in this other knowledge base: [https://kb.vmware.com/s/article/55767](https://kb.vmware.com/s/article/55767){.external-link}. +It is important to be aware of the potential problems listed in the [knowledge base](https://kb.vmware.com/s/article/55806) mentioned above, as well as the performance loss observed in this other knowledge base: [https://kb.vmware.com/s/article/55767](https://kb.vmware.com/s/article/55767). ### Step 3: Enable. @@ -78,11 +78,11 @@ A filter is available in the top right-hand corner of the window. You will need to do this for each host. -To find out more, you can go to step 3 in the ‘Resolution’ section of this [VMware knowledge base](https://kb.vmware.com/s/article/55806){.external-link}. +To find out more, you can go to step 3 in the ‘Resolution’ section of this [VMware knowledge base](https://kb.vmware.com/s/article/55806). > [!warning] > -> If you do not want to disable hyper-threading on these elements, you can remove the alert message by following this [knowledge base](https://kb.vmware.com/s/article/57374){.external-link}. +> If you do not want to disable hyper-threading on these elements, you can remove the alert message by following this [knowledge base](https://kb.vmware.com/s/article/57374). > > ![](images/deleteWarning.png){.thumbnail} > OVHcloud does not recommend doing this, and cannot be held responsible for this risk or any resulting consequences. diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.en-gb.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.en-gb.md index 5033dca59ae..9053c35ae7e 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.en-gb.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.en-gb.md @@ -37,7 +37,7 @@ As a reminder: For **Private Cloud** solutions, only SDDC packs are affected by this vulnerability. -For further information, you can refer to our [news article](https://www.ovh.co.uk/news/articles/al479.ovh-l1-terminal-fault-l1tf-foreshadow-disclosure){.external-link}. +For further information, you can refer to our [news article](https://www.ovh.co.uk/news/articles/al479.ovh-l1-terminal-fault-l1tf-foreshadow-disclosure). ## Mitigation process @@ -48,15 +48,15 @@ For further information, you can refer to our [news article](https://www.ovh.co. > The actions describe how to disable hyper-threading on your ESXi hosts. But since the L1TF vulnerability requires hyper-threading to work, disabling it protects your infrastructure from being exploited by this vulnerability. > -The mitigation process is described in this VMware knowledge base: [https://kb.vmware.com/s/article/55806](https://kb.vmware.com/s/article/55806){.external-link}. +The mitigation process is described in this VMware knowledge base: [https://kb.vmware.com/s/article/55806](https://kb.vmware.com/s/article/55806). This procedure is divided into three distinct steps. ### Step 1: Update. -The vCenter update is managed by OVHcloud, however, it is your responsibility to install the patch for ESXi hosts. This is available in the [the Update Manager](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vmware_update_manager){.external-link}. +The vCenter update is managed by OVHcloud, however, it is your responsibility to install the patch for ESXi hosts. This is available in the [the Update Manager](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vmware_update_manager). -You will find the list of patches for ESXi hosts in [this document](https://www.vmware.com/security/advisories/VMSA-2018-0020.html){.external-link}. +You will find the list of patches for ESXi hosts in [this document](https://www.vmware.com/security/advisories/VMSA-2018-0020.html). After the hosts have been updated, the following alert message will appear in your host summary: @@ -66,7 +66,7 @@ After the hosts have been updated, the following alert message will appear in yo After the ESXi hosts have been updated, the patch has not yet been applied. -It is important to be aware of the potential problems listed in the [knowledge base](https://kb.vmware.com/s/article/55806){.external-link} mentioned above, as well as the performance loss observed in this other knowledge base: [https://kb.vmware.com/s/article/55767](https://kb.vmware.com/s/article/55767){.external-link}. +It is important to be aware of the potential problems listed in the [knowledge base](https://kb.vmware.com/s/article/55806) mentioned above, as well as the performance loss observed in this other knowledge base: [https://kb.vmware.com/s/article/55767](https://kb.vmware.com/s/article/55767). ### Step 3: Enable. @@ -78,11 +78,11 @@ A filter is available in the top right-hand corner of the window. You will need to do this for each host. -To find out more, you can go to step 3 in the ‘Resolution’ section of this [VMware knowledge base](https://kb.vmware.com/s/article/55806){.external-link}. +To find out more, you can go to step 3 in the ‘Resolution’ section of this [VMware knowledge base](https://kb.vmware.com/s/article/55806). > [!warning] > -> If you do not want to disable hyper-threading on these elements, you can remove the alert message by following this [knowledge base](https://kb.vmware.com/s/article/57374){.external-link}. +> If you do not want to disable hyper-threading on these elements, you can remove the alert message by following this [knowledge base](https://kb.vmware.com/s/article/57374). > > ![](images/deleteWarning.png){.thumbnail} > OVHcloud does not recommend doing this, and cannot be held responsible for this risk or any resulting consequences. diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.en-ie.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.en-ie.md index 5033dca59ae..9053c35ae7e 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.en-ie.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.en-ie.md @@ -37,7 +37,7 @@ As a reminder: For **Private Cloud** solutions, only SDDC packs are affected by this vulnerability. -For further information, you can refer to our [news article](https://www.ovh.co.uk/news/articles/al479.ovh-l1-terminal-fault-l1tf-foreshadow-disclosure){.external-link}. +For further information, you can refer to our [news article](https://www.ovh.co.uk/news/articles/al479.ovh-l1-terminal-fault-l1tf-foreshadow-disclosure). ## Mitigation process @@ -48,15 +48,15 @@ For further information, you can refer to our [news article](https://www.ovh.co. > The actions describe how to disable hyper-threading on your ESXi hosts. But since the L1TF vulnerability requires hyper-threading to work, disabling it protects your infrastructure from being exploited by this vulnerability. > -The mitigation process is described in this VMware knowledge base: [https://kb.vmware.com/s/article/55806](https://kb.vmware.com/s/article/55806){.external-link}. +The mitigation process is described in this VMware knowledge base: [https://kb.vmware.com/s/article/55806](https://kb.vmware.com/s/article/55806). This procedure is divided into three distinct steps. ### Step 1: Update. -The vCenter update is managed by OVHcloud, however, it is your responsibility to install the patch for ESXi hosts. This is available in the [the Update Manager](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vmware_update_manager){.external-link}. +The vCenter update is managed by OVHcloud, however, it is your responsibility to install the patch for ESXi hosts. This is available in the [the Update Manager](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vmware_update_manager). -You will find the list of patches for ESXi hosts in [this document](https://www.vmware.com/security/advisories/VMSA-2018-0020.html){.external-link}. +You will find the list of patches for ESXi hosts in [this document](https://www.vmware.com/security/advisories/VMSA-2018-0020.html). After the hosts have been updated, the following alert message will appear in your host summary: @@ -66,7 +66,7 @@ After the hosts have been updated, the following alert message will appear in yo After the ESXi hosts have been updated, the patch has not yet been applied. -It is important to be aware of the potential problems listed in the [knowledge base](https://kb.vmware.com/s/article/55806){.external-link} mentioned above, as well as the performance loss observed in this other knowledge base: [https://kb.vmware.com/s/article/55767](https://kb.vmware.com/s/article/55767){.external-link}. +It is important to be aware of the potential problems listed in the [knowledge base](https://kb.vmware.com/s/article/55806) mentioned above, as well as the performance loss observed in this other knowledge base: [https://kb.vmware.com/s/article/55767](https://kb.vmware.com/s/article/55767). ### Step 3: Enable. @@ -78,11 +78,11 @@ A filter is available in the top right-hand corner of the window. You will need to do this for each host. -To find out more, you can go to step 3 in the ‘Resolution’ section of this [VMware knowledge base](https://kb.vmware.com/s/article/55806){.external-link}. +To find out more, you can go to step 3 in the ‘Resolution’ section of this [VMware knowledge base](https://kb.vmware.com/s/article/55806). > [!warning] > -> If you do not want to disable hyper-threading on these elements, you can remove the alert message by following this [knowledge base](https://kb.vmware.com/s/article/57374){.external-link}. +> If you do not want to disable hyper-threading on these elements, you can remove the alert message by following this [knowledge base](https://kb.vmware.com/s/article/57374). > > ![](images/deleteWarning.png){.thumbnail} > OVHcloud does not recommend doing this, and cannot be held responsible for this risk or any resulting consequences. diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.en-sg.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.en-sg.md index 5033dca59ae..9053c35ae7e 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.en-sg.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.en-sg.md @@ -37,7 +37,7 @@ As a reminder: For **Private Cloud** solutions, only SDDC packs are affected by this vulnerability. -For further information, you can refer to our [news article](https://www.ovh.co.uk/news/articles/al479.ovh-l1-terminal-fault-l1tf-foreshadow-disclosure){.external-link}. +For further information, you can refer to our [news article](https://www.ovh.co.uk/news/articles/al479.ovh-l1-terminal-fault-l1tf-foreshadow-disclosure). ## Mitigation process @@ -48,15 +48,15 @@ For further information, you can refer to our [news article](https://www.ovh.co. > The actions describe how to disable hyper-threading on your ESXi hosts. But since the L1TF vulnerability requires hyper-threading to work, disabling it protects your infrastructure from being exploited by this vulnerability. > -The mitigation process is described in this VMware knowledge base: [https://kb.vmware.com/s/article/55806](https://kb.vmware.com/s/article/55806){.external-link}. +The mitigation process is described in this VMware knowledge base: [https://kb.vmware.com/s/article/55806](https://kb.vmware.com/s/article/55806). This procedure is divided into three distinct steps. ### Step 1: Update. -The vCenter update is managed by OVHcloud, however, it is your responsibility to install the patch for ESXi hosts. This is available in the [the Update Manager](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vmware_update_manager){.external-link}. +The vCenter update is managed by OVHcloud, however, it is your responsibility to install the patch for ESXi hosts. This is available in the [the Update Manager](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vmware_update_manager). -You will find the list of patches for ESXi hosts in [this document](https://www.vmware.com/security/advisories/VMSA-2018-0020.html){.external-link}. +You will find the list of patches for ESXi hosts in [this document](https://www.vmware.com/security/advisories/VMSA-2018-0020.html). After the hosts have been updated, the following alert message will appear in your host summary: @@ -66,7 +66,7 @@ After the hosts have been updated, the following alert message will appear in yo After the ESXi hosts have been updated, the patch has not yet been applied. -It is important to be aware of the potential problems listed in the [knowledge base](https://kb.vmware.com/s/article/55806){.external-link} mentioned above, as well as the performance loss observed in this other knowledge base: [https://kb.vmware.com/s/article/55767](https://kb.vmware.com/s/article/55767){.external-link}. +It is important to be aware of the potential problems listed in the [knowledge base](https://kb.vmware.com/s/article/55806) mentioned above, as well as the performance loss observed in this other knowledge base: [https://kb.vmware.com/s/article/55767](https://kb.vmware.com/s/article/55767). ### Step 3: Enable. @@ -78,11 +78,11 @@ A filter is available in the top right-hand corner of the window. You will need to do this for each host. -To find out more, you can go to step 3 in the ‘Resolution’ section of this [VMware knowledge base](https://kb.vmware.com/s/article/55806){.external-link}. +To find out more, you can go to step 3 in the ‘Resolution’ section of this [VMware knowledge base](https://kb.vmware.com/s/article/55806). > [!warning] > -> If you do not want to disable hyper-threading on these elements, you can remove the alert message by following this [knowledge base](https://kb.vmware.com/s/article/57374){.external-link}. +> If you do not want to disable hyper-threading on these elements, you can remove the alert message by following this [knowledge base](https://kb.vmware.com/s/article/57374). > > ![](images/deleteWarning.png){.thumbnail} > OVHcloud does not recommend doing this, and cannot be held responsible for this risk or any resulting consequences. diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.en-us.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.en-us.md index 5033dca59ae..9053c35ae7e 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.en-us.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.en-us.md @@ -37,7 +37,7 @@ As a reminder: For **Private Cloud** solutions, only SDDC packs are affected by this vulnerability. -For further information, you can refer to our [news article](https://www.ovh.co.uk/news/articles/al479.ovh-l1-terminal-fault-l1tf-foreshadow-disclosure){.external-link}. +For further information, you can refer to our [news article](https://www.ovh.co.uk/news/articles/al479.ovh-l1-terminal-fault-l1tf-foreshadow-disclosure). ## Mitigation process @@ -48,15 +48,15 @@ For further information, you can refer to our [news article](https://www.ovh.co. > The actions describe how to disable hyper-threading on your ESXi hosts. But since the L1TF vulnerability requires hyper-threading to work, disabling it protects your infrastructure from being exploited by this vulnerability. > -The mitigation process is described in this VMware knowledge base: [https://kb.vmware.com/s/article/55806](https://kb.vmware.com/s/article/55806){.external-link}. +The mitigation process is described in this VMware knowledge base: [https://kb.vmware.com/s/article/55806](https://kb.vmware.com/s/article/55806). This procedure is divided into three distinct steps. ### Step 1: Update. -The vCenter update is managed by OVHcloud, however, it is your responsibility to install the patch for ESXi hosts. This is available in the [the Update Manager](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vmware_update_manager){.external-link}. +The vCenter update is managed by OVHcloud, however, it is your responsibility to install the patch for ESXi hosts. This is available in the [the Update Manager](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vmware_update_manager). -You will find the list of patches for ESXi hosts in [this document](https://www.vmware.com/security/advisories/VMSA-2018-0020.html){.external-link}. +You will find the list of patches for ESXi hosts in [this document](https://www.vmware.com/security/advisories/VMSA-2018-0020.html). After the hosts have been updated, the following alert message will appear in your host summary: @@ -66,7 +66,7 @@ After the hosts have been updated, the following alert message will appear in yo After the ESXi hosts have been updated, the patch has not yet been applied. -It is important to be aware of the potential problems listed in the [knowledge base](https://kb.vmware.com/s/article/55806){.external-link} mentioned above, as well as the performance loss observed in this other knowledge base: [https://kb.vmware.com/s/article/55767](https://kb.vmware.com/s/article/55767){.external-link}. +It is important to be aware of the potential problems listed in the [knowledge base](https://kb.vmware.com/s/article/55806) mentioned above, as well as the performance loss observed in this other knowledge base: [https://kb.vmware.com/s/article/55767](https://kb.vmware.com/s/article/55767). ### Step 3: Enable. @@ -78,11 +78,11 @@ A filter is available in the top right-hand corner of the window. You will need to do this for each host. -To find out more, you can go to step 3 in the ‘Resolution’ section of this [VMware knowledge base](https://kb.vmware.com/s/article/55806){.external-link}. +To find out more, you can go to step 3 in the ‘Resolution’ section of this [VMware knowledge base](https://kb.vmware.com/s/article/55806). > [!warning] > -> If you do not want to disable hyper-threading on these elements, you can remove the alert message by following this [knowledge base](https://kb.vmware.com/s/article/57374){.external-link}. +> If you do not want to disable hyper-threading on these elements, you can remove the alert message by following this [knowledge base](https://kb.vmware.com/s/article/57374). > > ![](images/deleteWarning.png){.thumbnail} > OVHcloud does not recommend doing this, and cannot be held responsible for this risk or any resulting consequences. diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.es-es.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.es-es.md index 3020e15fa20..c8bc77f5872 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.es-es.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.es-es.md @@ -37,7 +37,7 @@ A continuación recordamos las distintas variantes de L1 Terminal Fault: En lo que respecta a la solución **Private Cloud**, la gama SDDC es la única que puede verse afectada por esta vulnerabilidad. -En [este artículo](https://www.ovh.es/noticias/articulos/al516.l1-terminal-fault-l1tf-o-foreshadow-ultima-vulnerabilidad){.external-link} explicamos el fallo en profundidad. +En [este artículo](https://www.ovh.es/noticias/articulos/al516.l1-terminal-fault-l1tf-o-foreshadow-ultima-vulnerabilidad) explicamos el fallo en profundidad. ## Mitigación de la vulnerabilidad @@ -48,15 +48,15 @@ En [este artículo](https://www.ovh.es/noticias/articulos/al516.l1-terminal-faul > Debido a que la vulnerabilidad L1TF necesita el hyperthreading para poder funcionar, desactivarlo previene que el fallo sea explotado en su infraestructura. > -El procedimiento de mitigación se describe en el siguiente artículo de VMware: [https://kb.vmware.com/s/article/55806](https://kb.vmware.com/s/article/55806){.external-link}. +El procedimiento de mitigación se describe en el siguiente artículo de VMware: [https://kb.vmware.com/s/article/55806](https://kb.vmware.com/s/article/55806). Consta de tres fases, que se explican a continuación. ### 1. Actualización -Aunque OVHcloud actualiza el vCenter, usted deberá encargarse de actualizar los hosts ESXi. El parche está disponible en el [Update Manager](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vmware_update_manager){.external-link}. +Aunque OVHcloud actualiza el vCenter, usted deberá encargarse de actualizar los hosts ESXi. El parche está disponible en el [Update Manager](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vmware_update_manager). -Puede consultar la lista de parches para los hosts ESXi en las [recomendaciones de seguridad de VMware](https://www.vmware.com/security/advisories/VMSA-2018-0020.html){.external-link}. +Puede consultar la lista de parches para los hosts ESXi en las [recomendaciones de seguridad de VMware](https://www.vmware.com/security/advisories/VMSA-2018-0020.html). Tras la actualización, aparecerá el siguiente mensaje de alerta en el resumen del host: @@ -66,7 +66,7 @@ Tras la actualización, aparecerá el siguiente mensaje de alerta en el resumen Los hosts ESXi ya están actualizados, pero el parche todavía no se ha aplicado. -Antes de hacerlo, debe considerar los posibles problemas que se explican en el [artículo de VMware](https://kb.vmware.com/s/article/55806){.external-link} anteriormente citado, así como la disminución del rendimiento observada, que se detalla en [este artículo](https://kb.vmware.com/s/article/55767){.external-link}. +Antes de hacerlo, debe considerar los posibles problemas que se explican en el [artículo de VMware](https://kb.vmware.com/s/article/55806) anteriormente citado, así como la disminución del rendimiento observada, que se detalla en [este artículo](https://kb.vmware.com/s/article/55767). ### 3. Activación @@ -78,11 +78,11 @@ Puede utilizar el filtro situado en la parte superior derecha de la pantalla. Realice esta operación en cada host. -Para más información, consulte el apartado «Resolution», punto 3, de [este artículo de VMware](https://kb.vmware.com/s/article/55806){.external-link}. +Para más información, consulte el apartado «Resolution», punto 3, de [este artículo de VMware](https://kb.vmware.com/s/article/55806). > [!warning] > -> Si, teniendo en cuenta todo lo anterior, no desea desactivar el hyperthreading, puede eliminar el mensaje de alerta siguiendo los pasos que se indican en [este artículo](https://kb.vmware.com/s/article/57374){.external-link}. +> Si, teniendo en cuenta todo lo anterior, no desea desactivar el hyperthreading, puede eliminar el mensaje de alerta siguiendo los pasos que se indican en [este artículo](https://kb.vmware.com/s/article/57374). > > ![Borrar mensaje de alerta](images/deleteWarning.png){.thumbnail} > No obstante, OVHcloud no lo recomienda y no podrá ser considerada responsable de las consecuencias que de ello se deriven. diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.fr-ca.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.fr-ca.md index 476f6a768db..af8d15e24e2 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.fr-ca.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.fr-ca.md @@ -37,7 +37,7 @@ Pour rappel : Concernant l'offre **Private Cloud**, seules les offres SDDC sont impactées par cette vulnérabilité. -Vous retrouverez les informations de cette faille sur notre [article de blog](https://www.ovh.com/fr/blog/ovh-l1-terminal-fault-l1ft-foreshadow-disclosure/){.external-link}. +Vous retrouverez les informations de cette faille sur notre [article de blog](https://www.ovh.com/fr/blog/ovh-l1-terminal-fault-l1ft-foreshadow-disclosure/). ## Processus de mitigation @@ -48,15 +48,15 @@ Vous retrouverez les informations de cette faille sur notre [article de blog](ht > Les actions décrivent uniquement comment désactiver l'hyperthreading sur vos hôtes ESXi. Cependant, la faille L1TF nécesitant l'hyperthreading pour fonctionner, sa désactivation protège votre infrastructure de l'exploitation de cette vulnérabilité. > -Le processus de mitigation est décrit dans cette base de connaissance VMware : [https://kb.vmware.com/s/article/55806](https://kb.vmware.com/s/article/55806){.external-link}. +Le processus de mitigation est décrit dans cette base de connaissance VMware : [https://kb.vmware.com/s/article/55806](https://kb.vmware.com/s/article/55806). Cette procédure se divise en 3 phases distinctes. ### Étape 1: Phase de mise à jour -La mise à jour du vCenter est réalisée par OVHcloud, cependant, le patch des hôtes ESXi est à effectuer par vos soins et est disponible dans [l'update manager](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vmware_update_manager){.external-link}. +La mise à jour du vCenter est réalisée par OVHcloud, cependant, le patch des hôtes ESXi est à effectuer par vos soins et est disponible dans [l'update manager](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vmware_update_manager). -Vous retrouverez la liste des patchs pour les hôtes ESXi dans [ce document](https://www.vmware.com/security/advisories/VMSA-2018-0020.html){.external-link}. +Vous retrouverez la liste des patchs pour les hôtes ESXi dans [ce document](https://www.vmware.com/security/advisories/VMSA-2018-0020.html). Suite à la phase de mise à jour des hôtes, le message d'alerte suivant sera présent dans le résumé de votre hôte : @@ -66,7 +66,7 @@ Suite à la phase de mise à jour des hôtes, le message d'alerte suivant sera p Une fois les hôtes ESXi à jour, le correctif n'est pas encore appliqué. -Il est important d'être conscient des potentiels problèmes listés dans la [base de connaissances](https://kb.vmware.com/s/article/55806){.external-link} mentionnée précedemment, ainsi que les baisses de performances constatées dans cette autre base de connaissance : [https://kb.vmware.com/s/article/55767](https://kb.vmware.com/s/article/55767){.external-link}. +Il est important d'être conscient des potentiels problèmes listés dans la [base de connaissances](https://kb.vmware.com/s/article/55806) mentionnée précedemment, ainsi que les baisses de performances constatées dans cette autre base de connaissance : [https://kb.vmware.com/s/article/55767](https://kb.vmware.com/s/article/55767). ### Étape 3 : Phase d'activation @@ -78,11 +78,11 @@ Un filtre est disponible en haut à droite de la fenêtre. Cette manipulation est à réaliser sur chaque hôte. -Pour en savoir plus, vous pouvez vous rendre à l'étape 3 de la partie résolution présente dans [cette base de connaissance VMware](https://kb.vmware.com/s/article/55806){.external-link}. +Pour en savoir plus, vous pouvez vous rendre à l'étape 3 de la partie résolution présente dans [cette base de connaissance VMware](https://kb.vmware.com/s/article/55806). > [!warning] > -> Si, à la vue de ces différents éléments, vous ne souhaitez pas désactiver l'hyperthreading, vous pouvez supprimer le message d'alerte en suivant cette [base de connaissance](https://kb.vmware.com/s/article/57374){.external-link}. +> Si, à la vue de ces différents éléments, vous ne souhaitez pas désactiver l'hyperthreading, vous pouvez supprimer le message d'alerte en suivant cette [base de connaissance](https://kb.vmware.com/s/article/57374). > > ![](images/deleteWarning.png){.thumbnail} > OVHcloud ne recommande pas cette solution et se dégage de toute responsabilité concernant cette prise de risque. diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.fr-fr.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.fr-fr.md index 476f6a768db..af8d15e24e2 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.fr-fr.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.fr-fr.md @@ -37,7 +37,7 @@ Pour rappel : Concernant l'offre **Private Cloud**, seules les offres SDDC sont impactées par cette vulnérabilité. -Vous retrouverez les informations de cette faille sur notre [article de blog](https://www.ovh.com/fr/blog/ovh-l1-terminal-fault-l1ft-foreshadow-disclosure/){.external-link}. +Vous retrouverez les informations de cette faille sur notre [article de blog](https://www.ovh.com/fr/blog/ovh-l1-terminal-fault-l1ft-foreshadow-disclosure/). ## Processus de mitigation @@ -48,15 +48,15 @@ Vous retrouverez les informations de cette faille sur notre [article de blog](ht > Les actions décrivent uniquement comment désactiver l'hyperthreading sur vos hôtes ESXi. Cependant, la faille L1TF nécesitant l'hyperthreading pour fonctionner, sa désactivation protège votre infrastructure de l'exploitation de cette vulnérabilité. > -Le processus de mitigation est décrit dans cette base de connaissance VMware : [https://kb.vmware.com/s/article/55806](https://kb.vmware.com/s/article/55806){.external-link}. +Le processus de mitigation est décrit dans cette base de connaissance VMware : [https://kb.vmware.com/s/article/55806](https://kb.vmware.com/s/article/55806). Cette procédure se divise en 3 phases distinctes. ### Étape 1: Phase de mise à jour -La mise à jour du vCenter est réalisée par OVHcloud, cependant, le patch des hôtes ESXi est à effectuer par vos soins et est disponible dans [l'update manager](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vmware_update_manager){.external-link}. +La mise à jour du vCenter est réalisée par OVHcloud, cependant, le patch des hôtes ESXi est à effectuer par vos soins et est disponible dans [l'update manager](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vmware_update_manager). -Vous retrouverez la liste des patchs pour les hôtes ESXi dans [ce document](https://www.vmware.com/security/advisories/VMSA-2018-0020.html){.external-link}. +Vous retrouverez la liste des patchs pour les hôtes ESXi dans [ce document](https://www.vmware.com/security/advisories/VMSA-2018-0020.html). Suite à la phase de mise à jour des hôtes, le message d'alerte suivant sera présent dans le résumé de votre hôte : @@ -66,7 +66,7 @@ Suite à la phase de mise à jour des hôtes, le message d'alerte suivant sera p Une fois les hôtes ESXi à jour, le correctif n'est pas encore appliqué. -Il est important d'être conscient des potentiels problèmes listés dans la [base de connaissances](https://kb.vmware.com/s/article/55806){.external-link} mentionnée précedemment, ainsi que les baisses de performances constatées dans cette autre base de connaissance : [https://kb.vmware.com/s/article/55767](https://kb.vmware.com/s/article/55767){.external-link}. +Il est important d'être conscient des potentiels problèmes listés dans la [base de connaissances](https://kb.vmware.com/s/article/55806) mentionnée précedemment, ainsi que les baisses de performances constatées dans cette autre base de connaissance : [https://kb.vmware.com/s/article/55767](https://kb.vmware.com/s/article/55767). ### Étape 3 : Phase d'activation @@ -78,11 +78,11 @@ Un filtre est disponible en haut à droite de la fenêtre. Cette manipulation est à réaliser sur chaque hôte. -Pour en savoir plus, vous pouvez vous rendre à l'étape 3 de la partie résolution présente dans [cette base de connaissance VMware](https://kb.vmware.com/s/article/55806){.external-link}. +Pour en savoir plus, vous pouvez vous rendre à l'étape 3 de la partie résolution présente dans [cette base de connaissance VMware](https://kb.vmware.com/s/article/55806). > [!warning] > -> Si, à la vue de ces différents éléments, vous ne souhaitez pas désactiver l'hyperthreading, vous pouvez supprimer le message d'alerte en suivant cette [base de connaissance](https://kb.vmware.com/s/article/57374){.external-link}. +> Si, à la vue de ces différents éléments, vous ne souhaitez pas désactiver l'hyperthreading, vous pouvez supprimer le message d'alerte en suivant cette [base de connaissance](https://kb.vmware.com/s/article/57374). > > ![](images/deleteWarning.png){.thumbnail} > OVHcloud ne recommande pas cette solution et se dégage de toute responsabilité concernant cette prise de risque. diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.it-it.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.it-it.md index 3b1a539c6a0..0b698292765 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.it-it.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.it-it.md @@ -37,7 +37,7 @@ La vulnerabilità L1TF si presenta in tre varianti: Relativamente al servizio **Private Cloud**, le soluzioni SDDC sono le uniche che potrebbero essere affette da questa vulnerabilità. -Per maggiori informazioni sul bug di sicurezza L1TF, leggi [questo articolo](https://www.ovh.com/world/news/articles/al479.ovh-l1-terminal-fault-l1tf-foreshadow-disclosure){.external-link}. +Per maggiori informazioni sul bug di sicurezza L1TF, leggi [questo articolo](https://www.ovh.com/world/news/articles/al479.ovh-l1-terminal-fault-l1tf-foreshadow-disclosure). ## Processo di mitigazione @@ -45,13 +45,13 @@ Per maggiori informazioni sul bug di sicurezza L1TF, leggi [questo articolo](htt > > Ti ricordiamo che le azioni descritte in questo paragrafo non permettono la correzione della falla di sicurezza, ma esclusivamente la disattivazione dell’Hyper-Threading sugli host ESXi. Per funzionare L1TF ha infatti bisogno di questa tecnologia e disabilitarla protegge pertanto l’infrastruttura dall’esposizione alla vulnerabilità. -Il processo di mitigazione, descritto in [questo articolo](https://kb.vmware.com/s/article/55806){.external-link} di VMware, comprende 3 fasi distinte. +Il processo di mitigazione, descritto in [questo articolo](https://kb.vmware.com/s/article/55806) di VMware, comprende 3 fasi distinte. ### 1. Aggiornamento -OVHcloud si occupa dell’aggiornamento del vCenter, ma l’applicazione del software correttivo sugli host ESXi è di responsabilità dell’utente. La patch è disponibile nell’[Update Manager](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vmware_update_manager){.external-link}. +OVHcloud si occupa dell’aggiornamento del vCenter, ma l’applicazione del software correttivo sugli host ESXi è di responsabilità dell’utente. La patch è disponibile nell’[Update Manager](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vmware_update_manager). -Per visualizzare la lista completa delle patch rilasciate per gli host ESXi, consulta le [raccomandazioni sulla sicurezza di VMware](https://www.vmware.com/security/advisories/VMSA-2018-0020.html){.external-link}. +Per visualizzare la lista completa delle patch rilasciate per gli host ESXi, consulta le [raccomandazioni sulla sicurezza di VMware](https://www.vmware.com/security/advisories/VMSA-2018-0020.html). Una volta completato l’aggiornamento, nel riepilogo dell’host compare questo messaggio di alert: @@ -61,7 +61,7 @@ Una volta completato l’aggiornamento, nel riepilogo dell’host compare questo A questo punto gli host ESXi sono aggiornati, ma la patch non è stata ancora applicata. -Prima di procedere con questa operazione è importante essere consapevoli dei potenziali problemi descritti nell’[articolo di VMware](https://kb.vmware.com/s/article/55806){.external-link} citato precedentemente, e della probabile diminuzione delle prestazioni constatata ed esposta in [questo altro articolo](https://kb.vmware.com/s/article/55767){.external-link}. +Prima di procedere con questa operazione è importante essere consapevoli dei potenziali problemi descritti nell’[articolo di VMware](https://kb.vmware.com/s/article/55806) citato precedentemente, e della probabile diminuzione delle prestazioni constatata ed esposta in [questo altro articolo](https://kb.vmware.com/s/article/55767). ### 3. Attivazione @@ -73,11 +73,11 @@ Se necessario, è possibile utilizzare il filtro disponibile in alto a destra ne L’operazione deve essere ripetuta su ogni host. -Per maggiori informazioni, consulta il punto 3 del paragrafo “Resolution” di [questo articolo di VMware](https://kb.vmware.com/s/article/55806){.external-link}. +Per maggiori informazioni, consulta il punto 3 del paragrafo “Resolution” di [questo articolo di VMware](https://kb.vmware.com/s/article/55806). > [!warning] > -> Se, dopo le opportune valutazioni, decidi di mantenere attivo l’Hyper-Threading, è possibile eliminare il messaggio di alert seguendo i passaggi descritti in [questo articolo](https://kb.vmware.com/s/article/57374){.external-link}. +> Se, dopo le opportune valutazioni, decidi di mantenere attivo l’Hyper-Threading, è possibile eliminare il messaggio di alert seguendo i passaggi descritti in [questo articolo](https://kb.vmware.com/s/article/57374). > > ![](images/deleteWarning.png){.thumbnail} > OVHcloud sconsiglia una soluzione di questo tipo e non potrà in nessun modo essere ritenuta responsabile delle eventuali conseguenze di questa scelta. diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.pl-pl.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.pl-pl.md index 92e655102eb..2996d1aa873 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.pl-pl.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.pl-pl.md @@ -37,7 +37,7 @@ Przypomnienie: Jeśli chodzi o ofertę **Private Cloud**, jedynie pakiety SDDC są zagrożone tą podatnością. -Więcej informacji o tej luce znajdziesz w naszym [artykule na blogu](https://www.ovh.com/fr/blog/ovh-l1-terminal-fault-l1ft-foreshadow-disclosure/){.external-link}. +Więcej informacji o tej luce znajdziesz w naszym [artykule na blogu](https://www.ovh.com/fr/blog/ovh-l1-terminal-fault-l1ft-foreshadow-disclosure/). ## Proces mitygacji zagrożenia @@ -48,15 +48,15 @@ Więcej informacji o tej luce znajdziesz w naszym [artykule na blogu](https://ww > Operacje umożliwiają jedynie wyłączenie opcji Hyper-Threading na Twoich hostach ESXi. Ponieważ jednak podatność L1TF potrzebuje do działania opcji Hyper-Threading, jej wyłączenie chroni Twoją infrastrukturę przed wykorzystaniem podatności. > -Proces neutralizacji jest opisany w bazie wiedzy VMware : [https://kb.vmware.com/s/article/55806](https://kb.vmware.com/s/article/55806){.external-link}. +Proces neutralizacji jest opisany w bazie wiedzy VMware : [https://kb.vmware.com/s/article/55806](https://kb.vmware.com/s/article/55806). Procedura dzieli się na trzy różne fazy. ### Etap 1: aktualizacja -Aktualizacja vCenter jest wykonywana przez OVHcloud, jednak łatkę hostów ESXi instaluje samodzielnie użytkownik. Jest ona dostępna [w menedżerze aktualizacji](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vmware_update_manager){.external-link}. +Aktualizacja vCenter jest wykonywana przez OVHcloud, jednak łatkę hostów ESXi instaluje samodzielnie użytkownik. Jest ona dostępna [w menedżerze aktualizacji](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vmware_update_manager). -Listę łatek dla hostów ESXi znajdziesz w [tym dokumencie](https://www.vmware.com/security/advisories/VMSA-2018-0020.html){.external-link}. +Listę łatek dla hostów ESXi znajdziesz w [tym dokumencie](https://www.vmware.com/security/advisories/VMSA-2018-0020.html). Po aktualizacji hostów w podsumowaniu hosta pojawi się następujący alert: @@ -66,7 +66,7 @@ Po aktualizacji hostów w podsumowaniu hosta pojawi się następujący alert: W tej fazie hosty ESXi są zaktualizowane, ale poprawka nie jest jeszcze zastosowana. -Ważne, abyś był świadomy, że mogą wystąpić potencjalne problemy wymienione we wspomnianej wyżej [bazie wiedzy](https://kb.vmware.com/s/article/55806){.external-link} oraz spadki wydajności opisane w tej bazie: [https://kb.vmware.com/s/article/55767](https://kb.vmware.com/s/article/55767){.external-link}. +Ważne, abyś był świadomy, że mogą wystąpić potencjalne problemy wymienione we wspomnianej wyżej [bazie wiedzy](https://kb.vmware.com/s/article/55806) oraz spadki wydajności opisane w tej bazie: [https://kb.vmware.com/s/article/55767](https://kb.vmware.com/s/article/55767). ### Etap 3: aktywacja @@ -78,11 +78,11 @@ Na górze po prawej stronie okna dostępny jest filtr. Operację tę należy wykonać na każdym hoście. -Aby dowiedzieć się więcej, możesz przejść do etapu 3 dotyczącego rozwiązania zaprezentowanego w [tej bazie wiedzy VMware](https://kb.vmware.com/s/article/55806){.external-link}. +Aby dowiedzieć się więcej, możesz przejść do etapu 3 dotyczącego rozwiązania zaprezentowanego w [tej bazie wiedzy VMware](https://kb.vmware.com/s/article/55806). > [!warning] > -> Jeśli po przejrzeniu poszczególnych elementów nie chcesz wyłączyć Hyper-threadingu, możesz usunąć wiadomość z alertem, postępując zgodnie z instrukcjami z tej [bazy wiedzy](https://kb.vmware.com/s/article/57374){.external-link}. +> Jeśli po przejrzeniu poszczególnych elementów nie chcesz wyłączyć Hyper-threadingu, możesz usunąć wiadomość z alertem, postępując zgodnie z instrukcjami z tej [bazy wiedzy](https://kb.vmware.com/s/article/57374). > > ![](images/deleteWarning.png){.thumbnail} > OVHcloud nie zaleca tego rozwiązania i nie ponosi odpowiedzialności za ryzyko podjęte przez użytkownika. diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.pt-pt.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.pt-pt.md index f955c5712fc..6bf6f8750dc 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.pt-pt.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/check-and-block-l1tf/guide.pt-pt.md @@ -37,7 +37,7 @@ Lembrete: No que diz respeito ao **Private Cloud**, a gama SDDC é a única a poder ficar afetada por esta vulnerabilidade. -Explicamos esta falha neste [artigo](https://www.ovh.pt/news/artigos/al516.ovh-l1-terminal-fault-l1tfforeshadow-disclosure){.external-link}. +Explicamos esta falha neste [artigo](https://www.ovh.pt/news/artigos/al516.ovh-l1-terminal-fault-l1tfforeshadow-disclosure). ## Processo de mitigação @@ -46,15 +46,15 @@ Explicamos esta falha neste [artigo](https://www.ovh.pt/news/artigos/al516.ovh-l > Tenha em conta que as ações descritas abaixo não permitem corrigir a falha, servem apenas para desativar o hyperthreading nos hosts ESXi. No entanto, visto que a falha L1TF necessita do hyperthreading para funcionar, a sua desativação irá proteger a sua infraestrutura da exploração desta vulnerabilidade. > -O processo de mitigação está descrito no seguinte artigo da VMware: [https://kb.vmware.com/s/article/55806](https://kb.vmware.com/s/article/55806){.external-link}. +O processo de mitigação está descrito no seguinte artigo da VMware: [https://kb.vmware.com/s/article/55806](https://kb.vmware.com/s/article/55806). Este procedimento divide-se em 3 partes. ### 1 - Atualização -Embora a OVHcloud atualize o vCenter, deverá encarregar-se da atualização dos hosts ESXi. O patch está disponível no [Update Manager](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vmware_update_manager){.external-link}. +Embora a OVHcloud atualize o vCenter, deverá encarregar-se da atualização dos hosts ESXi. O patch está disponível no [Update Manager](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vmware_update_manager). -Poderá consultar a lista de patches para os hosts ESXi neste [documento](https://www.vmware.com/security/advisories/VMSA-2018-0020.html){.external-link}. +Poderá consultar a lista de patches para os hosts ESXi neste [documento](https://www.vmware.com/security/advisories/VMSA-2018-0020.html). Após a atualização, aparecerá a seguinte mensagem de alerta no resumo do host: @@ -64,7 +64,7 @@ Após a atualização, aparecerá a seguinte mensagem de alerta no resumo do hos Os hosts ESXi já estão atualizados, mas a correção não foi aplicada. -Antes de o fazer, deve considerar os possíveis problemas que são explicados no [artigo da VMware](https://kb.vmware.com/s/article/55806){.external-link} anteriormente referido, assim como a diminuição do rendimento observada, que é detalhada [neste artigo](https://kb.vmware.com/s/article/55767){.external-link}. +Antes de o fazer, deve considerar os possíveis problemas que são explicados no [artigo da VMware](https://kb.vmware.com/s/article/55806) anteriormente referido, assim como a diminuição do rendimento observada, que é detalhada [neste artigo](https://kb.vmware.com/s/article/55767). ### 3 - Ativação @@ -76,11 +76,11 @@ Tem à sua disposição um filtro no canto superior direito. Esta operação deve ser realizada para cada um dos hosts. -Para obter mais informações, pode consultar a secção “Resolution”, artigo n.º 3, deste [artigo da VMware](https://kb.vmware.com/s/article/55806){.external-link}. +Para obter mais informações, pode consultar a secção “Resolution”, artigo n.º 3, deste [artigo da VMware](https://kb.vmware.com/s/article/55806). > [!warning] > -> Se, tendo em conta a informação referida anteriormente, não pretender desativar o hyperthreading, pode eliminar a mensagem de alerta seguindo os passos indicados [neste artigo](https://kb.vmware.com/s/article/57374){.external-link}. +> Se, tendo em conta a informação referida anteriormente, não pretender desativar o hyperthreading, pode eliminar a mensagem de alerta seguindo os passos indicados [neste artigo](https://kb.vmware.com/s/article/57374). > > ![](images/deleteWarning.png){.thumbnail} > A OVHcloud não recomenda esta solução e não se responsabiliza pelas consequências que possam advir. diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/clone_a_vm/images/clone1.jpg b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/clone_a_vm/images/clone1.jpg deleted file mode 100644 index ab6b729d0e6..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/clone_a_vm/images/clone1.jpg and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/clone_a_vm/images/clone1.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/clone_a_vm/images/clone1.png deleted file mode 100644 index 065e8c81867..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/clone_a_vm/images/clone1.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/clone_a_vm/images/clone2.jpg b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/clone_a_vm/images/clone2.jpg deleted file mode 100644 index e4032c4c0c1..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/clone_a_vm/images/clone2.jpg and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/clone_a_vm/images/clone2.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/clone_a_vm/images/clone2.png deleted file mode 100644 index fcbb2fb3832..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/clone_a_vm/images/clone2.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/clone_a_vm/images/clone3.jpg b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/clone_a_vm/images/clone3.jpg deleted file mode 100644 index bc185a8cec3..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/clone_a_vm/images/clone3.jpg and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/clone_a_vm/images/clone3.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/clone_a_vm/images/clone3.png deleted file mode 100644 index f842ed7a1c1..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/clone_a_vm/images/clone3.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/clone_a_vm/images/clone4.jpg b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/clone_a_vm/images/clone4.jpg deleted file mode 100644 index 4810aa9ec62..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/clone_a_vm/images/clone4.jpg and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/clone_a_vm/images/clone4.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/clone_a_vm/images/clone4.png deleted file mode 100644 index 45690c81c3e..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/clone_a_vm/images/clone4.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/clone_a_vm/images/clone5.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/clone_a_vm/images/clone5.png deleted file mode 100644 index 9e80511e801..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/clone_a_vm/images/clone5.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/clone_a_vm/images/clone6.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/clone_a_vm/images/clone6.png deleted file mode 100644 index b07aef91c3b..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/clone_a_vm/images/clone6.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.de-de.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.de-de.md index 88fb402bde1..993d8c9433b 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.de-de.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.de-de.md @@ -95,7 +95,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows Configuration](images/config_ip_windows.png){.thumbnail} >> @@ -138,7 +138,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows IPv6 Configuration](images/config_ip_windows_v6.png){.thumbnail} >> diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.en-asia.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.en-asia.md index 4f971e67880..4cfad624313 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.en-asia.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.en-asia.md @@ -95,7 +95,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows Configuration](images/config_ip_windows.png){.thumbnail} >> @@ -138,7 +138,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows IPv6 Configuration](images/config_ip_windows_v6.png){.thumbnail} >> diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.en-au.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.en-au.md index 4f971e67880..4cfad624313 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.en-au.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.en-au.md @@ -95,7 +95,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows Configuration](images/config_ip_windows.png){.thumbnail} >> @@ -138,7 +138,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows IPv6 Configuration](images/config_ip_windows_v6.png){.thumbnail} >> diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.en-ca.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.en-ca.md index 4f971e67880..4cfad624313 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.en-ca.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.en-ca.md @@ -95,7 +95,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows Configuration](images/config_ip_windows.png){.thumbnail} >> @@ -138,7 +138,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows IPv6 Configuration](images/config_ip_windows_v6.png){.thumbnail} >> diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.en-gb.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.en-gb.md index 7dab05a5c66..806bc0c6d81 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.en-gb.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.en-gb.md @@ -95,7 +95,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows Configuration](images/config_ip_windows.png){.thumbnail} >> @@ -138,7 +138,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows IPv6 Configuration](images/config_ip_windows_v6.png){.thumbnail} >> diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.en-ie.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.en-ie.md index 4f971e67880..4cfad624313 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.en-ie.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.en-ie.md @@ -95,7 +95,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows Configuration](images/config_ip_windows.png){.thumbnail} >> @@ -138,7 +138,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows IPv6 Configuration](images/config_ip_windows_v6.png){.thumbnail} >> diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.en-sg.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.en-sg.md index 4f971e67880..4cfad624313 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.en-sg.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.en-sg.md @@ -95,7 +95,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows Configuration](images/config_ip_windows.png){.thumbnail} >> @@ -138,7 +138,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows IPv6 Configuration](images/config_ip_windows_v6.png){.thumbnail} >> diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.en-us.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.en-us.md index 4f971e67880..4cfad624313 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.en-us.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.en-us.md @@ -95,7 +95,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows Configuration](images/config_ip_windows.png){.thumbnail} >> @@ -138,7 +138,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows IPv6 Configuration](images/config_ip_windows_v6.png){.thumbnail} >> diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.es-es.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.es-es.md index fe92182a45d..fd6d7c1dfa4 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.es-es.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.es-es.md @@ -95,7 +95,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows Configuration](images/config_ip_windows.png){.thumbnail} >> @@ -138,7 +138,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows IPv6 Configuration](images/config_ip_windows_v6.png){.thumbnail} >> diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.es-us.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.es-us.md index fe92182a45d..fd6d7c1dfa4 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.es-us.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.es-us.md @@ -95,7 +95,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows Configuration](images/config_ip_windows.png){.thumbnail} >> @@ -138,7 +138,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows IPv6 Configuration](images/config_ip_windows_v6.png){.thumbnail} >> diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.fr-ca.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.fr-ca.md index 8d112402e70..3e87fad355a 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.fr-ca.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.fr-ca.md @@ -95,7 +95,7 @@ Afin de configurer une IP publique sur votre machine virtuelle, vous devez au pr >> ncpa.cpl >> ``` >> ->> Il faut ensuite effectuer un clic droit sur la carte réseau correspondant au VMNetwork et sélectionner `Propriétés`{.action). Sélectionnez alors `Protocole TCP/IP v4`{.action} et cliquez de nouveau sur `Properties`{.action) puis renseignez les informations de votre IP comme suit : +>> Il faut ensuite effectuer un clic droit sur la carte réseau correspondant au VMNetwork et sélectionner `Propriétés`{.action}. Sélectionnez alors `Protocole TCP/IP v4`{.action} et cliquez de nouveau sur `Properties`{.action} puis renseignez les informations de votre IP comme suit : >> >> ![Configuration Windows](images/config_ip_windows.png){.thumbnail} >> @@ -138,7 +138,7 @@ Afin de configurer une IP publique sur votre machine virtuelle, vous devez au pr >> ncpa.cpl >> ``` >> ->> Il faut ensuite effectuer un clic droit sur la carte réseau correspondant au VMNetwork et sélectionner `Propriétés`{.action). Sélectionnez alors `Protocole TCP/IP v4`{.action} et cliquez de nouveau sur `Properties`{.action) puis renseignez les informations de votre IP comme suit : +>> Il faut ensuite effectuer un clic droit sur la carte réseau correspondant au VMNetwork et sélectionner `Propriétés`{.action}. Sélectionnez alors `Protocole TCP/IP v4`{.action} et cliquez de nouveau sur `Properties`{.action} puis renseignez les informations de votre IP comme suit : >> >> ![Configuration Windows IPv6](images/config_ip_windows_v6.png){.thumbnail} >> @@ -199,7 +199,7 @@ Pour aller plus vite, vous pouvez cliquer sur le champ de recherche Windows et ncpa.cpl ``` -Il faut ensuite effectuer un clic droit sur la carte réseau correspondant au VMNetwork et `Propriétés`{.action). Sélectionnez ensuite `Protocole TCP/IP v4`{.action} et cliquez de nouveau sur 'Properties' puis renseignez les informations de votre IP comme suit : +Il faut ensuite effectuer un clic droit sur la carte réseau correspondant au VMNetwork et `Propriétés`{.action}. Sélectionnez ensuite `Protocole TCP/IP v4`{.action} et cliquez de nouveau sur 'Properties' puis renseignez les informations de votre IP comme suit : ![Configuration Windows IP publique](images/windows_private.PNG){.thumbnail} diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.fr-fr.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.fr-fr.md index 8d112402e70..3e87fad355a 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.fr-fr.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.fr-fr.md @@ -95,7 +95,7 @@ Afin de configurer une IP publique sur votre machine virtuelle, vous devez au pr >> ncpa.cpl >> ``` >> ->> Il faut ensuite effectuer un clic droit sur la carte réseau correspondant au VMNetwork et sélectionner `Propriétés`{.action). Sélectionnez alors `Protocole TCP/IP v4`{.action} et cliquez de nouveau sur `Properties`{.action) puis renseignez les informations de votre IP comme suit : +>> Il faut ensuite effectuer un clic droit sur la carte réseau correspondant au VMNetwork et sélectionner `Propriétés`{.action}. Sélectionnez alors `Protocole TCP/IP v4`{.action} et cliquez de nouveau sur `Properties`{.action} puis renseignez les informations de votre IP comme suit : >> >> ![Configuration Windows](images/config_ip_windows.png){.thumbnail} >> @@ -138,7 +138,7 @@ Afin de configurer une IP publique sur votre machine virtuelle, vous devez au pr >> ncpa.cpl >> ``` >> ->> Il faut ensuite effectuer un clic droit sur la carte réseau correspondant au VMNetwork et sélectionner `Propriétés`{.action). Sélectionnez alors `Protocole TCP/IP v4`{.action} et cliquez de nouveau sur `Properties`{.action) puis renseignez les informations de votre IP comme suit : +>> Il faut ensuite effectuer un clic droit sur la carte réseau correspondant au VMNetwork et sélectionner `Propriétés`{.action}. Sélectionnez alors `Protocole TCP/IP v4`{.action} et cliquez de nouveau sur `Properties`{.action} puis renseignez les informations de votre IP comme suit : >> >> ![Configuration Windows IPv6](images/config_ip_windows_v6.png){.thumbnail} >> @@ -199,7 +199,7 @@ Pour aller plus vite, vous pouvez cliquer sur le champ de recherche Windows et ncpa.cpl ``` -Il faut ensuite effectuer un clic droit sur la carte réseau correspondant au VMNetwork et `Propriétés`{.action). Sélectionnez ensuite `Protocole TCP/IP v4`{.action} et cliquez de nouveau sur 'Properties' puis renseignez les informations de votre IP comme suit : +Il faut ensuite effectuer un clic droit sur la carte réseau correspondant au VMNetwork et `Propriétés`{.action}. Sélectionnez ensuite `Protocole TCP/IP v4`{.action} et cliquez de nouveau sur 'Properties' puis renseignez les informations de votre IP comme suit : ![Configuration Windows IP publique](images/windows_private.PNG){.thumbnail} diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.it-it.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.it-it.md index 2cf2f311ee3..a34c655e9f9 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.it-it.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.it-it.md @@ -95,7 +95,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows Configuration](images/config_ip_windows.png){.thumbnail} >> @@ -138,7 +138,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows IPv6 Configuration](images/config_ip_windows_v6.png){.thumbnail} >> diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.pl-pl.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.pl-pl.md index 41510dea5d1..a9fa44270f7 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.pl-pl.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.pl-pl.md @@ -95,7 +95,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows Configuration](images/config_ip_windows.png){.thumbnail} >> @@ -138,7 +138,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows IPv6 Configuration](images/config_ip_windows_v6.png){.thumbnail} >> diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.pt-pt.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.pt-pt.md index d19f48a12df..c7515007d4f 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.pt-pt.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/guide.pt-pt.md @@ -95,7 +95,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows Configuration](images/config_ip_windows.png){.thumbnail} >> @@ -138,7 +138,7 @@ To configure a public IP address on your virtual machine, you must first choose >> ncpa.cpl >> ``` >> ->> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action). Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action) and enter your IP information as follows: +>> Then right-click the network adapter corresponding to the VMNetwork and select `Properties`{.action}. Then select `TCP/IP v4 protocol`{.action} and click on `Properties`{.action} and enter your IP information as follows: >> >> ![Windows IPv6 Configuration](images/config_ip_windows_v6.png){.thumbnail} >> diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/images/config_ip_ovh_network.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/images/config_ip_ovh_network.png deleted file mode 100644 index 358f74ee951..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/images/config_ip_ovh_network.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/images/config_ip_ovh_network_advanced.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/images/config_ip_ovh_network_advanced.png deleted file mode 100644 index c7229c1f68e..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/images/config_ip_ovh_network_advanced.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/images/img_32.jpg b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/images/img_32.jpg deleted file mode 100644 index b5f765a3789..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/images/img_32.jpg and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/images/img_33.jpg b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/images/img_33.jpg deleted file mode 100644 index a01564629f0..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/images/img_33.jpg and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/images/img_34.jpg b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/images/img_34.jpg deleted file mode 100644 index dfdc8cfed74..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/images/img_34.jpg and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/images/img_36.jpg b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/images/img_36.jpg deleted file mode 100644 index 49ffebd9383..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/images/img_36.jpg and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/images/vlan.PNG b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/images/vlan.PNG deleted file mode 100644 index 169368317eb..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/images/vlan.PNG and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/images/vmnetwork.PNG b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/images/vmnetwork.PNG deleted file mode 100644 index bf78094bbe9..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/images/vmnetwork.PNG and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/images/vxlan.PNG b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/images/vxlan.PNG deleted file mode 100644 index 9d481e46eaf..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/configure_ip_on_vm/images/vxlan.PNG and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/connexion_a_l_api_ovh/guide.fr-fr.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/connexion_a_l_api_ovh/guide.fr-fr.md index 8e1812b95a1..59f970b3823 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/connexion_a_l_api_ovh/guide.fr-fr.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/connexion_a_l_api_ovh/guide.fr-fr.md @@ -14,7 +14,7 @@ Elle permet également d’automatiser certaines actions. ## Connexion à L’API -Rendez-vous sur l’API [ovh.com](http://ovh.com){.external-link} : [http://api.ovh.com](http://api.ovh.com/){.external-link} +Rendez-vous sur l’API [ovh.com](http://ovh.com) : [http://api.ovh.com](http://api.ovh.com/) ![](images/connection_api_1.jpg){.thumbnail} diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/connexion_a_l_api_ovh/images/API.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/connexion_a_l_api_ovh/images/API.png deleted file mode 100644 index beb986a424c..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/connexion_a_l_api_ovh/images/API.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/connexion_a_l_api_ovh/images/API1.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/connexion_a_l_api_ovh/images/API1.png deleted file mode 100644 index 00ade908669..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/connexion_a_l_api_ovh/images/API1.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/connexion_a_l_api_ovh/images/API2.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/connexion_a_l_api_ovh/images/API2.png deleted file mode 100644 index c3497600aeb..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/connexion_a_l_api_ovh/images/API2.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/connexion_a_l_api_ovh/images/API3.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/connexion_a_l_api_ovh/images/API3.png deleted file mode 100644 index 45f6ed526e0..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/connexion_a_l_api_ovh/images/API3.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/connexion_a_l_api_ovh/images/API4.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/connexion_a_l_api_ovh/images/API4.png deleted file mode 100644 index 89ab63490d9..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/connexion_a_l_api_ovh/images/API4.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/connexion_a_l_api_ovh/images/connection_api_1.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/connexion_a_l_api_ovh/images/connection_api_1.png deleted file mode 100644 index 5ed65404a98..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/connexion_a_l_api_ovh/images/connection_api_1.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/connexion_a_l_api_ovh/images/connection_api_call.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/connexion_a_l_api_ovh/images/connection_api_call.png deleted file mode 100644 index cc165e6e22d..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/connexion_a_l_api_ovh/images/connection_api_call.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/connexion_a_l_api_ovh/images/connection_api_example.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/connexion_a_l_api_ovh/images/connection_api_example.png deleted file mode 100644 index c2cf84152c1..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/connexion_a_l_api_ovh/images/connection_api_example.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/connexion_a_l_api_ovh/images/connection_api_log.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/connexion_a_l_api_ovh/images/connection_api_log.png deleted file mode 100644 index 6fda010b24f..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/connexion_a_l_api_ovh/images/connection_api_log.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/connexion_a_l_api_ovh/images/connection_api_login.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/connexion_a_l_api_ovh/images/connection_api_login.png deleted file mode 100644 index 84f88d195bd..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/connexion_a_l_api_ovh/images/connection_api_login.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/connexion_a_l_api_ovh/images/image2017-9-6%2016%253A22%253A40.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/connexion_a_l_api_ovh/images/image2017-9-6%2016%253A22%253A40.png deleted file mode 100644 index 1ba8d81ecc1..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/connexion_a_l_api_ovh/images/image2017-9-6%2016%253A22%253A40.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/connexion_a_l_api_ovh/images/image2017-9-6%2016%3A22%3A40.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/connexion_a_l_api_ovh/images/image2017-9-6%2016%3A22%3A40.png deleted file mode 100644 index 1ba8d81ecc1..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/connexion_a_l_api_ovh/images/image2017-9-6%2016%3A22%3A40.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/create_an_alert/images/alarm1.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/create_an_alert/images/alarm1.png deleted file mode 100644 index e59674bb2f4..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/create_an_alert/images/alarm1.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/create_an_alert/images/alarm2.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/create_an_alert/images/alarm2.png deleted file mode 100644 index 3995eceb99b..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/create_an_alert/images/alarm2.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/create_an_alert/images/alarm3.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/create_an_alert/images/alarm3.png deleted file mode 100644 index 121703364fb..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/create_an_alert/images/alarm3.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/create_an_alert/images/alarm4.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/create_an_alert/images/alarm4.png deleted file mode 100644 index 987ac8cf061..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/create_an_alert/images/alarm4.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/create_an_alert/images/alarme1.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/create_an_alert/images/alarme1.png deleted file mode 100644 index fdbaee97032..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/create_an_alert/images/alarme1.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/create_an_alert/images/alarme2.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/create_an_alert/images/alarme2.png deleted file mode 100644 index ce9571ba728..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/create_an_alert/images/alarme2.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/create_an_alert/images/alarme3.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/create_an_alert/images/alarme3.png deleted file mode 100644 index 252d69c14a2..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/create_an_alert/images/alarme3.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/create_an_alert/images/alarme4.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/create_an_alert/images/alarme4.png deleted file mode 100644 index d1bd2a3bc92..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/create_an_alert/images/alarme4.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/01createVxLAN.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/01createVxLAN.png deleted file mode 100644 index 4c03bbc27ef..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/01createVxLAN.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/02nameVxLAN.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/02nameVxLAN.png deleted file mode 100644 index 51a05720cd5..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/02nameVxLAN.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/03transportZone.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/03transportZone.png deleted file mode 100644 index fe65e8f04f3..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/03transportZone.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/04ConfirmVxLAN.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/04ConfirmVxLAN.png deleted file mode 100644 index 212b150e8b5..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/04ConfirmVxLAN.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/05VxLANcreated.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/05VxLANcreated.png deleted file mode 100644 index 7cca24c0c6c..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/05VxLANcreated.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/06VxLANnetworking.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/06VxLANnetworking.png deleted file mode 100644 index dd8645016c1..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/06VxLANnetworking.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/ConfirmVxLAN.PNG b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/ConfirmVxLAN.PNG deleted file mode 100644 index eb2e1c79a29..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/ConfirmVxLAN.PNG and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/VxLANcreated.PNG b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/VxLANcreated.PNG deleted file mode 100644 index 38e223f4bf7..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/VxLANcreated.PNG and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/VxLANnetworking.PNG b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/VxLANnetworking.PNG deleted file mode 100644 index 037e6c8f4c9..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/VxLANnetworking.PNG and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/createVxLAN.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/createVxLAN.png deleted file mode 100644 index 8a490391753..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/createVxLAN.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/nameVxLAN.PNG b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/nameVxLAN.PNG deleted file mode 100644 index bb3e72928f6..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/nameVxLAN.PNG and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/network.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/network.png deleted file mode 100644 index da2093192b3..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/network.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/network1.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/network1.png deleted file mode 100644 index 793aa6aa958..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/network1.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/network10.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/network10.png deleted file mode 100644 index 064a43ccb71..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/network10.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/network11.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/network11.png deleted file mode 100644 index 35380999b75..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/network11.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/network2.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/network2.png deleted file mode 100644 index a74f44596bb..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/network2.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/network3.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/network3.png deleted file mode 100644 index a3fbbd42163..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/network3.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/network4.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/network4.png deleted file mode 100644 index 5cd0a2d90f0..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/network4.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/network5.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/network5.png deleted file mode 100644 index b6c7175b8ce..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/network5.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/network6.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/network6.png deleted file mode 100644 index 86ad726f33e..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/network6.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/network7.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/network7.png deleted file mode 100644 index b68aba294b2..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/network7.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/network9.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/network9.png deleted file mode 100644 index 9fe9c9f5ce5..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/network9.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/transportZone.PNG b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/transportZone.PNG deleted file mode 100644 index f07c6aefae9..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creation_vlan/images/transportZone.PNG and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creer_un_snapshot/images/snap1.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creer_un_snapshot/images/snap1.png deleted file mode 100644 index 0fd5d35d317..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creer_un_snapshot/images/snap1.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creer_un_snapshot/images/snap2.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creer_un_snapshot/images/snap2.png deleted file mode 100644 index 67696c6c645..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creer_un_snapshot/images/snap2.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creer_un_snapshot/images/snap3.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creer_un_snapshot/images/snap3.png deleted file mode 100644 index c26adcaff48..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creer_un_snapshot/images/snap3.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creer_un_snapshot/images/snapshot1.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creer_un_snapshot/images/snapshot1.png deleted file mode 100644 index 90ae10800cc..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creer_un_snapshot/images/snapshot1.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creer_un_snapshot/images/snapshot3.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creer_un_snapshot/images/snapshot3.png deleted file mode 100644 index 530aceda19a..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creer_un_snapshot/images/snapshot3.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creer_un_snapshot/images/spashot2.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creer_un_snapshot/images/spashot2.png deleted file mode 100644 index ac5a61c59d2..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/creer_un_snapshot/images/spashot2.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/delete_host/images/confirmmaintenanceMode.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/delete_host/images/confirmmaintenanceMode.png deleted file mode 100644 index c1dc341f715..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/delete_host/images/confirmmaintenanceMode.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/delete_host/images/hostmaintenancemode.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/delete_host/images/hostmaintenancemode.png deleted file mode 100644 index 69cefb2a751..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/delete_host/images/hostmaintenancemode.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/delete_host/images/removeovhhost_01.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/delete_host/images/removeovhhost_01.png deleted file mode 100644 index e7fda28fda8..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/delete_host/images/removeovhhost_01.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/delete_host/images/removeovhhost_02.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/delete_host/images/removeovhhost_02.png deleted file mode 100644 index b936bf34fa1..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/delete_host/images/removeovhhost_02.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/delete_host/images/removeovhhost_03.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/delete_host/images/removeovhhost_03.png deleted file mode 100644 index 3b308f94d15..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/delete_host/images/removeovhhost_03.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/delete_host/images/taskmaintenancemode.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/delete_host/images/taskmaintenancemode.png deleted file mode 100644 index b506b647849..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/delete_host/images/taskmaintenancemode.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/delete_host/images/taskremovehost.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/delete_host/images/taskremovehost.png deleted file mode 100644 index 6a530cc09ec..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/delete_host/images/taskremovehost.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.de-de.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.de-de.md index 66ee9f38e7c..e0ec7df55b8 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.de-de.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.de-de.md @@ -42,7 +42,7 @@ Im folgenden Schritt können Sie den Namen Ihrer Maschine sowie deren Speicheror ![Speicherort der virtuellen Maschine](images/vm03.png){.thumbnail} -Anschließend können Sie den Cluster, den Host, [den Ressourcenpool](https://docs.vmware.com/de/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html){.external-link} oder die [vApp](https://docs.vmware.com/de/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html){.external-link} auswählen, um die VM zu platzieren. +Anschließend können Sie den Cluster, den Host, [den Ressourcenpool](https://docs.vmware.com/de/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html) oder die [vApp](https://docs.vmware.com/de/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html) auswählen, um die VM zu platzieren. Im vorliegenden Beispiel wird die virtuelle Maschine entsprechend den konfigurierten DRS-Regeln deployt und im Wurzelverzeichnis des Clusters platziert. diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.en-asia.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.en-asia.md index 70c4becd188..eb4a5fd274a 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.en-asia.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.en-asia.md @@ -40,7 +40,7 @@ The next step allows you to define a name for the VM and choose a location. If y ![VM location](images/vm03.png){.thumbnail} -You can then choose the cluster, host, [resource pool](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html){.external-link}, or [vApp](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html){.external-link} to place it. +You can then choose the cluster, host, [resource pool](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html), or [vApp](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html) to place it. In this case, the VM will be deployed according to the configured DRS rules, and will be placed at the root of the cluster. diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.en-au.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.en-au.md index bea9bb0abaf..5ecbe8952ed 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.en-au.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.en-au.md @@ -40,7 +40,7 @@ The next step allows you to define a name for the VM and choose a location. If y ![VM location](images/vm03.png){.thumbnail} -You can then choose the cluster, host, [resource pool](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html){.external-link}, or [vApp](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html){.external-link} to place it. +You can then choose the cluster, host, [resource pool](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html), or [vApp](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html) to place it. In this case, the VM will be deployed according to the configured DRS rules, and will be placed at the root of the cluster. diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.en-ca.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.en-ca.md index eef3134ee3c..1282b6cb11d 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.en-ca.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.en-ca.md @@ -40,7 +40,7 @@ The next step allows you to define a name for the VM and choose a location. If y ![VM location](images/vm03.png){.thumbnail} -You can then choose the cluster, host, [resource pool](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html){.external-link}, or [vApp](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html){.external-link} to place it. +You can then choose the cluster, host, [resource pool](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html), or [vApp](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html) to place it. In this case, the VM will be deployed according to the configured DRS rules, and will be placed at the root of the cluster. diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.en-gb.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.en-gb.md index 8daa14d8300..90fa86ed91c 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.en-gb.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.en-gb.md @@ -40,7 +40,7 @@ The next step allows you to define a name for the VM and choose a location. If y ![VM location](images/vm03.png){.thumbnail} -You can then choose the cluster, host, [resource pool](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html){.external-link}, or [vApp](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html){.external-link} to place it. +You can then choose the cluster, host, [resource pool](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html), or [vApp](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html) to place it. In this case, the VM will be deployed according to the configured DRS rules, and will be placed at the root of the cluster. diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.en-ie.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.en-ie.md index 1a65715abf4..d32529ba0b6 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.en-ie.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.en-ie.md @@ -40,7 +40,7 @@ The next step allows you to define a name for the VM and choose a location. If y ![VM location](images/vm03.png){.thumbnail} -You can then choose the cluster, host, [resource pool](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html){.external-link}, or [vApp](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html){.external-link} to place it. +You can then choose the cluster, host, [resource pool](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html), or [vApp](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html) to place it. In this case, the VM will be deployed according to the configured DRS rules, and will be placed at the root of the cluster. diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.en-sg.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.en-sg.md index 034f0200517..e1576cdf41d 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.en-sg.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.en-sg.md @@ -40,7 +40,7 @@ The next step allows you to define a name for the VM and choose a location. If y ![VM location](images/vm03.png){.thumbnail} -You can then choose the cluster, host, [resource pool](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html){.external-link}, or [vApp](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html){.external-link} to place it. +You can then choose the cluster, host, [resource pool](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html), or [vApp](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html) to place it. In this case, the VM will be deployed according to the configured DRS rules, and will be placed at the root of the cluster. diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.en-us.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.en-us.md index f05ee7ceae2..a6f4d9ea7a4 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.en-us.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.en-us.md @@ -40,7 +40,7 @@ The next step allows you to define a name for the VM and choose a location. If y ![VM location](images/vm03.png){.thumbnail} -You can then choose the cluster, host, [resource pool](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html){.external-link}, or [vApp](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html){.external-link} to place it. +You can then choose the cluster, host, [resource pool](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html), or [vApp](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html) to place it. In this case, the VM will be deployed according to the configured DRS rules, and will be placed at the root of the cluster. diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.es-es.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.es-es.md index 97422bdc0b0..a579d622b46 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.es-es.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.es-es.md @@ -42,7 +42,7 @@ El siguiente paso le permite definir el nombre de su máquina y elegir su locali ![emplacement de la machine virtuelle](images/vm03.png){.thumbnail} -Luego, podrá elegir el clúster, el servidor, [el grupo de recursos](https://docs.vmware.com/fr/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html){.external-link} o [la vApp](https://docs.vmware.com/fr/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html){.external-link} donde desee colocarla. +Luego, podrá elegir el clúster, el servidor, [el grupo de recursos](https://docs.vmware.com/fr/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html) o [la vApp](https://docs.vmware.com/fr/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html) donde desee colocarla. En este caso, la máquina virtual se instrumentará según las reglas DRS configuradas y se colocará en la raíz del clúster. diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.es-us.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.es-us.md index 7c9bb776a14..3331ed23f6b 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.es-us.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.es-us.md @@ -42,7 +42,7 @@ El siguiente paso le permite definir el nombre de su máquina y elegir su locali ![emplacement de la machine virtuelle](images/vm03.png){.thumbnail} -Luego, podrá elegir el clúster, el servidor, [el grupo de recursos](https://docs.vmware.com/fr/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html){.external-link} o [la vApp](https://docs.vmware.com/fr/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html){.external-link} donde desee colocarla. +Luego, podrá elegir el clúster, el servidor, [el grupo de recursos](https://docs.vmware.com/fr/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html) o [la vApp](https://docs.vmware.com/fr/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html) donde desee colocarla. En este caso, la máquina virtual se instrumentará según las reglas DRS configuradas y se colocará en la raíz del clúster. diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.fr-ca.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.fr-ca.md index fd4459b8bb4..1bfc6f092fb 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.fr-ca.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.fr-ca.md @@ -42,7 +42,7 @@ L'étape suivante vous permet de définir le nom de votre machine et de choisir ![emplacement de la machine virtuelle](images/vm03.png){.thumbnail} -Vous pouvez ensuite choisir le cluster, l’hôte, [le pool de ressources](https://docs.vmware.com/fr/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html){.external-link}, ou [la vApp](https://docs.vmware.com/fr/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html){.external-link} où vous souhaitez la placer. +Vous pouvez ensuite choisir le cluster, l’hôte, [le pool de ressources](https://docs.vmware.com/fr/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html), ou [la vApp](https://docs.vmware.com/fr/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html) où vous souhaitez la placer. Dans ce cas, la machine virtuelle sera déployée selon les règles DRS configurées, et sera placée à la racine du cluster. diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.fr-fr.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.fr-fr.md index 345e4cc4251..39662a151c6 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.fr-fr.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.fr-fr.md @@ -42,7 +42,7 @@ L'étape suivante vous permet de définir le nom de votre machine et de choisir ![emplacement de la machine virtuelle](images/vm03.png){.thumbnail} -Vous pouvez ensuite choisir le cluster, l’hôte, [le pool de ressources](https://docs.vmware.com/fr/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html){.external-link}, ou [la vApp](https://docs.vmware.com/fr/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html){.external-link} où vous souhaitez la placer. +Vous pouvez ensuite choisir le cluster, l’hôte, [le pool de ressources](https://docs.vmware.com/fr/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html), ou [la vApp](https://docs.vmware.com/fr/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html) où vous souhaitez la placer. Dans ce cas, la machine virtuelle sera déployée selon les règles DRS configurées, et sera placée à la racine du cluster. diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.it-it.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.it-it.md index fd77bc5a2b5..f755c19386e 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.it-it.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.it-it.md @@ -42,7 +42,7 @@ Lo step successivo consente di definire il nome della propria macchina e sceglie ![Localizzazione della macchina virtuale](images/vm03.png){.thumbnail} -In seguito è possibile scegliere il cluster, l’host, il [pool di risorse](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html){.external-link} o la [vApp](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html){.external-link}di destinazione. +In seguito è possibile scegliere il cluster, l’host, il [pool di risorse](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html) o la [vApp](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html)di destinazione. Nel nostro caso, la macchina virtuale sarà implementata secondo le regole DRS configurate e localizzata nella root del cluster. diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.pl-pl.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.pl-pl.md index b544911b476..9e7d336bf07 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.pl-pl.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.pl-pl.md @@ -42,7 +42,7 @@ Następny etap umożliwia określenie nazwy Twojej maszyny wirtualnej i wybór j ![emplacement de la machine virtuelle](images/vm03.png){.thumbnail} -Następnie możesz wybrać klaster, hosta,[pulę zasobów](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html){.external-link} lub [vApp](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html){.external-link}, w której chcesz ją umieścić. +Następnie możesz wybrać klaster, hosta,[pulę zasobów](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html) lub [vApp](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html), w której chcesz ją umieścić. W takim przypadku maszyna wirtualna zostanie wdrożona zgodnie ze skonfigurowanymi regułami DRS i umieszczona w katalogu głównym klastra. diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.pt-pt.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.pt-pt.md index f7b8d5ee083..754a1d5d993 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.pt-pt.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/guide.pt-pt.md @@ -42,7 +42,7 @@ A etapa seguinte permite-lhe definir o nome da sua máquina e escolher a sua loc ![localização da máquina virtual](images/vm03.png){.thumbnail} -De seguida, pode escolher o cluster, o host, [o pool de recursos](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html){.external-link}, ou [a vApp](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html){.external-link} onde a quer colocar. +De seguida, pode escolher o cluster, o host, [o pool de recursos](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html), ou [a vApp](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.vm_admin.doc/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html) onde a quer colocar. Neste caso, a máquina virtual será implementada segundo as regras DRS configuradas, e será colocada na raiz do cluster. diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/images/deploy_vm2.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/images/deploy_vm2.png deleted file mode 100644 index a3e750ad701..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/images/deploy_vm2.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/images/deploy_vm3.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/images/deploy_vm3.png deleted file mode 100644 index d21babaad6e..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/images/deploy_vm3.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/images/deploy_vm_cluster.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/images/deploy_vm_cluster.png deleted file mode 100644 index 1b0f2cf5a7e..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/images/deploy_vm_cluster.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/images/deploy_vm_compatibility.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/images/deploy_vm_compatibility.png deleted file mode 100644 index deee42a0bfc..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/images/deploy_vm_compatibility.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/images/deploy_vm_customize.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/images/deploy_vm_customize.png deleted file mode 100644 index f73a560136f..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/images/deploy_vm_customize.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/images/deploy_vm_customize_with_iso.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/images/deploy_vm_customize_with_iso.png deleted file mode 100644 index e9f4830501b..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/images/deploy_vm_customize_with_iso.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/images/deploy_vm_datastore.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/images/deploy_vm_datastore.png deleted file mode 100644 index 4a42d2da20f..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/images/deploy_vm_datastore.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/images/deploy_vm_finish.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/images/deploy_vm_finish.png deleted file mode 100644 index aa5a687f60c..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/images/deploy_vm_finish.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/images/deploy_vm_guest_os.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/images/deploy_vm_guest_os.png deleted file mode 100644 index 472bc9642a4..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/images/deploy_vm_guest_os.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/images/deploy_vm_iso.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/images/deploy_vm_iso.png deleted file mode 100644 index 701763bc5ac..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/images/deploy_vm_iso.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/images/deploy_vm_ready.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/images/deploy_vm_ready.png deleted file mode 100644 index 1e6aff03e04..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle/images/deploy_vm_ready.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/eviter_le_freeze_de_vm_avec_l_option_veeam_backup/images/image0_28.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/eviter_le_freeze_de_vm_avec_l_option_veeam_backup/images/image0_28.png deleted file mode 100644 index 1e890abc6a5..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/eviter_le_freeze_de_vm_avec_l_option_veeam_backup/images/image0_28.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/eviter_le_freeze_de_vm_avec_l_option_veeam_backup/images/image0_7.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/eviter_le_freeze_de_vm_avec_l_option_veeam_backup/images/image0_7.png deleted file mode 100644 index 790f2c73256..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/eviter_le_freeze_de_vm_avec_l_option_veeam_backup/images/image0_7.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/eviter_le_freeze_de_vm_avec_l_option_veeam_backup/images/image1_9.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/eviter_le_freeze_de_vm_avec_l_option_veeam_backup/images/image1_9.png deleted file mode 100644 index b50cc1a1d6e..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/eviter_le_freeze_de_vm_avec_l_option_veeam_backup/images/image1_9.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/guide.de-de.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/guide.de-de.md deleted file mode 100644 index f333d6a1d8a..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/guide.de-de.md +++ /dev/null @@ -1,267 +0,0 @@ ---- -title: vScope API verwenden -excerpt: Die vScope API ermöglicht Ihnen, die Monitoringdaten in Ihren Anwendungen zu verwenden -updated: 2020-06-29 ---- - -## Ziel - -OVHcloud stellt Ihnen mit **vScope** ein Überwachungstool für Ihre virtuellen Maschinen und Ihre Infrastruktur zur Verfügung. - -Es handelt sich um eine Website, auf der alle nützlichen Informationen zur Verwendung Ihrer Ressourcen gesammelt sind. - -Diese Informationen sind auch über APIv6 und API Metrics verfügbar. - -**Diese Anleitung beschreibt die Verwendung dieser APIs.** - -## Voraussetzungen - -- Sie verfügen über eine [Hosted Private Cloud](https://www.ovhcloud.com/de/enterprise/products/hosted-private-cloud/) Infrastruktur. -- Sie sind im Verwaltungsinterface von vScope eingeloggt. - -## In der praktischen Anwendung - -Das Tool vScope stellt zwei Arten von Informationen zur Verfügung: - -- Live-Informationen, die den Daten der verschiedenen Komponenten zu einem Zeitpunkt „T“ entsprechen. -- Grafiken, die die früheren Leistungsdaten der verschiedenen Komponenten veranschaulichen. Zum Beispiel: CPU und RAM einer virtuellen Maschine. - -### Die Live-Daten sammeln - -Die Live-Daten sind die von der Hauptseite der Benutzeroberfläche vScope aus verfügbaren Daten. - -![vScope-API](images/vScope1.png){.thumbnail} - -Sie können die Live-Daten für die folgenden Komponenten abrufen: - -- Filer -- Hosts -- Virtuelle Maschinen - -Die Verwendung geschieht über drei API-Aufrufe: - -#### Filer - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/filer/{filerId} -> - -#### Hosts - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host/{hostId} -> - -#### VMs - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/vm/{vmId} -> - -### Die historischen Daten sammeln (Grafiken) - -Um die historischen Daten (Grafiken) zu sammeln und zu verwenden, nutzen wir dem Dienst **Metrics Data Platforms**. - -Über das Protokoll Opentsdb oder WARP10 können Sie Ihre Daten in Form von Punkten abrufen. Sie können diese Punkte nach Belieben mit Ihrer Anwendung auswerten oder sie direkt anzeigen. - -Der folgende Abschnitt erklärt die Verwendung des Protokolls OpenTSDB für die unbearbeitete Anzeige von Daten (keine grafische Wiedergabe). - -Um die **Metrics Data Platforms** verwenden zu können, müssen Sie ein Lesetoken (*read*) erhalten. Mit der neuen Version von vScope besitzt jeder Nutzer der Infrastruktur ein Lesetoken. - -Für den jeweiligen Nutzer verwenden Sie den folgenden APIv6-Aufruf für das Lesetoken: - -> [!api] -> -> @api {v1} /dedicatedCloud POST /dedicatedCloud/{serviceName}/user/{userId}/metricsToken -> - -Ihr Token befindet sich im Feld **token** des Ergebnisses. - -```json -{ - "warpEndpoint": "https://warp10.gra1-ovh.metrics.ovh.net", - token: "XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX", - "opentsdbEndpoint": "https://opentsdb.gra1-ovh.metrics.ovh.net" -} -``` - -Für jede Art von Komponenten steht eine metrische Liste zur Verfügung und erfordert eine Anzahl von sehr präzisen Parametern (auch Label genannt). - -#### Filer - -| Messwerte | Beschreibung | Label | -| ----------- | ----------- | ----------- | -| vscope.filer.datastore.diskspace.used | Verwendung des Filers in kB | Rechenzentrum: pcc-37-187-228-180_datacenter869,
datastore : pcc-000443 | - -#### Hosts - -| Messwerte | Beschreibung | Label | -| ----------- | ----------- | ----------- | -| vscope.host.cpu.usage.perc | Verwendung des Prozessors des Hosts in Prozent | \- Rechenzentrum: pcc-37-187-228-180_datacenter869,
Host 172.17.86.51 | -| vscope.host.mem.usage.perc | Verwendung des Speichers des Hosts in Prozent | \- Rechenzentrum: pcc-37-187-228-180_datacenter869,
Host 172.17.86.51 | -| vscope.host.net.tx | Verwendung des Host-Netzwerks beim Senden | \- Rechenzentrum: pcc-37-187-228-180_datacenter869,
Host 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.rx | Verwendung des Host-Netzwerks beim Empfang | \- Rechenzentrum: pcc-37-187-228-180_datacenter869,
Host 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetstx | Anzahl der vom Host gesendeten Netzwerk-Pakete | \- Rechenzentrum: pcc-37-187-228-180_datacenter869,
Host 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetsrx | Anzahl der vom Host empfangenen Netzwerk-Pakete | \- Rechenzentrum: pcc-37-187-228-180_datacenter869,
Host 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | - -#### virtuelle Maschinen - -| Messwerte | Beschreibung | Label | -| ----------- | ----------- | ----------- | -| vscope.vm.cpu.usage.perc | Verwendung des Prozessors der VM in Prozent | \- Rechenzentrum: pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.mem.usage.perc | Verwendung des Speichers der VM in Prozent | \- Rechenzentrum: pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.cpu.ready |CPU ready der VM in Millisekunden | \- Rechenzentrum: pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.rx | Verwendung des Netzwerks der VM beim Empfang | \- Rechenzentrum: pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.tx | Verwendung des Netzwerks der VM bei der Übertragung | \- Rechenzentrum: pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.packetsrx | Anzahl der von der VM empfangenen Netzwerk-Pakete | \- Rechenzentrum: pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.packetstx | Anzahl der von der VM gesendeten Netzwerk-Pakete | \- Rechenzentrum: pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.io.read | Anzahl der IOs der VM im Lesevorgang pro Sekunde | \- Rechenzentrum: pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.io.write | Anzahl der IOs der VM im Schreibvorgang pro Sekunde | \- Rechenzentrum: pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.bandwidth.read | Bandbreite der Festplatte der VM beim Lesevorgang | \- Rechenzentrum: pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.bandwidth.write | Bandbreite der Festplatte der VM beim Schreibvorgang | \- Rechenzentrum: pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.latency.read | Latenz der Festplatte der VM beim Lesevorgang | \- Rechenzentrum: pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.latency.write | Latenz der Festplatte der VM beim Schreibvorgang | \- Rechenzentrum: pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | - -#### Beispiel einer Datensammlung unter Verwendung des OpenTSDB-Protokolls - -Jetzt, da Sie Ihr Token, Ihren Endpunkt und Ihre metrische Liste abgerufen haben, erhalten Sie die Daten zur Speichernutzung über den Zeitraum eines Tages. - -Hier ein Beispiel für eine Abfrage. - -``` -curl -XPOST https://read:XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX@opentsdb.gra1-ovh.metrics.ovh.net/api/query -D - "start":1564407950, - "queries":[ - { - "metric":"vscope.host.mem.usage.perc", - "aggregator":"sum", - "downsample":"20m-max-zero", - "tags": { - "datacenter":"pcc-37-187-228-180_datacenter869", - "host":"172.17.86.51" - } - } - ] -} -``` - -Erläuterung der verschiedenen verwendeten Felder: - -- **read**: der für die Durchführung des Antrags verwendete Nutzer (dies wird immer *read* sein); -- **XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX**: das vorher über APIv6 abgerufene Token; -- **opentsdb.gra1-ovh.metrics.ovh.net**: Endpunkt OpenTSDB, ebenfalls über APIv6 abgerufen. Dieser Endpunkt kann je nach Ihrem Standort variieren; -- **start**: der dem Datum des Beginns der Abfrage entsprechende Zeitstempel; -- **queries**: Tabelle mit den abzufragenden Metriken. Mehrere metrische Werte können in einer einzigen Abfrage abgerufen werden; -- **metric**: Name der abzufragenden Metrik; -- **aggregator**: Name der Aggregationsfunktion (weitere Details entnehmen Sie bitte der Dokumentation zu OpenTSDB); -- **downsample**: Name der Stichprobenfunktion (optional, ermöglicht es, die Zahl der abzurufenden Daten zu reduzieren); -- **tags**: Liste von Labels in der Form Schlüssel/Wert; - -Andere Parameter können auch geliefert werden. Bitte lesen Sie für mehr Details in der Dokumentation der OpenTSDB API nach. - -Sie werden dann ein *json* mit der Zusammenfassung der Abfrage erhalten, sowie die mit dem Wert im Feld **dps** verbundenen Zeitstempel. - -Beispiel: - -```json -[ - { - "metric":"vscope.host.mem.usage.perc", - "tags":{ - "datacenter":"pcc-37-187-228-180_datacenter869", - "env":"prod", - "host":"172.17.86.51" - "servicename":"pcc-37-187-228-180", - "servicetype":"vscope" - }, - "query":{ - "index":0 - }, - "aggregateTags":[], - "dps":{ - "1564409391":4.38, - "1564410591":4.35, - "1564411791":4.37, - "1564412991":4.38, - "1564414191":4.35, - "1564415391":4.38, - "1564416591":4.35, - "1564417791":4.36, - "1564418991":4.36, - "1564420191":4.37, - "1564421391":4.37, - "1564422591":4.37, - "1564423791":4.37, - "1564424991":4.38, - "1564426191":4.36, - "1564427391":4.35, - "1564428591":4.37, - "1564429791":4.36, - "1564430991":4.38, - "1564432191":4.35, - "1564433391":4.37, - "1564434591":4.36, - "1564435791":4.37, - "1564436991":4.37, - "1564438191":4.37, - "1564439391":4.38, - "1564440591":4.36, - "1564441791":4.36, - "1564442991":4.37, - "1564444191":4.37, - "1564445391":4.35, - "1564446591":4.36, - "1564447791":4.36, - "1564448991":4.36, - "1564450191":4.35, - "1564451391":4.37, - "1564452591":4.37, - "1564453791":4.35, - "1564454991":4.36, - "1564456191":4.37, - "1564457391":4.37, - "1564458591":4.36, - "1564459791":4.37, - "1564460991":4.34, - "1564462191":4.36, - "1564463391":4.34, - "1564464591":4.37, - "1564465791":4.34, - "1564466991":4.37, - "1564468191":4.34, - "1564469391":4.36, - "1564470591":4.36, - "1564471791":4.36, - "1564472991":4.37, - "1564474191":4.37, - "1564475391":4.36, - "1564476591":4.35, - "1564477791":4.36, - "1564478991":4.35, - "1564480191":4.35, - "1564481391":4.37, - "1564482591":4.36, - "1564483791":4.34, - "1564484991":4.37, - "1564486191":4.38, - "1564487391":4.35, - "1564488591":4.34, - "1564489791":4.36, - "1564490991":4.35, - "1564492191":4.36, - "1564493391":4.36, - "1564494591":4.36 - } - } -] -``` - -Für mehr Details zu API Calls mit OpenTSDB können Sie in der folgenden Dokumentation nachlesen: [OpenTSDB API query](http://opentsdb.net/docs/build/html/api_http/query/index.html) - -## Weiterführende Informationen - -Für den Austausch mit unserer User Community gehen Sie auf . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/guide.en-asia.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/guide.en-asia.md deleted file mode 100644 index e8906f09116..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/guide.en-asia.md +++ /dev/null @@ -1,266 +0,0 @@ ---- -title: 'Using the vScope API' -excerpt: 'Find out how to use the vScope API to collect monitoring data in your applications' -updated: 2020-06-29 ---- - -## Objective - -OVHcloud provides you with a tool called **vScope**, for supervising and monitoring your virtual machines and infrastructures. - -It is a webpage that displays useful information on your resource usage. - -You can also access this information via the APIv6 and Metrics API. - -**This guide explains how to use these APIs.** - -## Requirements - -- a [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/asia/enterprise/products/hosted-private-cloud/) -- access to the management interface (vScope) - -## Instructions - -vScope provides two types of information: - -- **Live** information which corresponds to the information on different components at a given time. -- Graphs presenting logged performance data for different components, such as a virtual machine’s CPU and RAM. - -### Collecting **live** data - -**Live** data is is the data available via the vScope interface’s main page. - -![vScope-API](images/vScope1.png){.thumbnail} - -You can retrieve **live** data for the following components: - -- filers -- hosts -- virtual machines - -You can use the API via the following three APIv6 calls: - -#### Filers - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/filer/{filerId} -> - -#### Hosts - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host/{hostId} -> - -#### Virtual machines - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/vm/{vmId} -> - -### Collecting logged data (graphs) - -To collect and use logged data (graphs), we use the **Metrics Data Platforms** product. - -Via OpenTSDB or WARP10 protocol, you will be able to retrieve your data as points. You can use these points via your application, or directly display them in your choice of rendering. - -The following instructions cover the use of the OpenTSDB protocol for a raw data display (no graph rendering). - -To use **Metrics Data Platforms**, you will need to get a *read* token. With the new version of vScope, each infrastructure user has a *read* token. - -Use the following APIv6 call to retrieve the read token for the user you want: - -> [!api] -> -> @api {v1} /dedicatedCloud POST /dedicatedCloud/{serviceName}/user/{userId}/metricsToken -> - -Your token will be in the result’s **token** field. - -```json -{ - "warpEndpoint": "https://warp10.gra1-ovh.metrics.ovh.net", - "token": "XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX", - "opentsdbEndpoint": "https://opentsdb.gra1-ovh.metrics.ovh.net" -} -``` - -For each component type, there is a list of metrics, and it requires a number of very precise settings (also called labels). - -#### Filers - -| Metrics | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.filer.datastore.diskspace.used | Filer usage in KB | datacenter : pcc-37-187-228-180_datacenter869,
datastore : pcc-000443 | - -#### Hosts - -| Metrics | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.host.cpu.usage.perc | Host processor usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51 | -| vscope.host.mem.usage.perc | Host RAM usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51 | -| vscope.host.net.tx | Host outgoing network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.rx | Host incoming network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetstx | Number of network packets sent from the host | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetsrx | Number of network packets received from the host | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | - -#### Virtual machines - -| Metrics | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.vm.cpu.usage.perc | VM processor usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.mem.usage.perc | VM RAM usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.cpu.ready |VM’s CPU Ready time in milliseconds | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.rx | VM incoming network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.tx | VM outgoing network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.packetsrx | Number of network packets received from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.packetstx | Number of network packets sent from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.io.read | IO number per second in read mode from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.io.write | IO number per second in write mode from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.bandwidth.read | VM disk bandwidth in read mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.bandwidth.write | VM disk bandwidth in write mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.latency.read | VM disk latency in read mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.latency.write | VM disk latency in write mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | - -#### Example of data gathered using the OpenTSDB protocol - -Now that you have retrieved your token, your endpoint, and your list of metrics, you can retrieve a host’s RAM usage data for a period of 1 day. - -Below is an example query: - -``` -curl -XPOST https://read:XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX@opentsdb.gra1-ovh.metrics.ovh.net/api/query --d '{ - "start":1564407950, - "queries":[ - { - "metric":"vscope.host.mem.usage.perc", - "aggregator":"sum", - "downsample":"20m-max-zero", - "tags": { - "datacenter":"pcc-37-187-228-180_datacenter869", - "host":"172.17.86.51" - } - } - ] -}' -``` - -Below are explanations of the fields used: - -- **read:** user used to send the query (will always be read). -- XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX: the token retrieved earlier via the APIv6. -- **opentsdb.gra1-ovh.metrics.ovh.net:** OpenTSDB endpoint, also retrieved via the APIv6. This endpoint may vary depending on your location. -- **start:** a timestamp corresponding to the query’s start date. -- **queries:** a table containing the metrics to retrieve. Several metrics may be retrieved in a single query. -- **metric:** the name of the metric to retrieve. -- **aggregator:** the name of the aggregation feature (please refer to OpenTSDB documentation for further details). -- **downsample:** the name of the downsampling feature (can be used to reduce the amount of data to retrieve. Optional setting). -- **tags:** a list of labels in the form of key/value. - -Other settings may also be provided. Please refer to the documentation for the OpenTSDB API for further details. - -You will then receive a *json* with the query summary, as well as the timestamps associated with their value in the **dps** field. -For example: - -```json -[ - { - "metric":"vscope.host.mem.usage.perc", - "tags":{ - "datacenter":"pcc-37-187-228-180_datacenter869", - "env":"prod", - "host":"172.17.86.51", - "servicename":"pcc-37-187-228-180", - "servicetype":"vscope" - }, - "query":{ - "index":0 - }, - "aggregateTags":[], - "dps":{ - "1564409391":4.38, - "1564410591":4.35, - "1564411791":4.37, - "1564412991":4.38, - "1564414191":4.35, - "1564415391":4.38, - "1564416591":4.35, - "1564417791":4.36, - "1564418991":4.36, - "1564420191":4.37, - "1564421391":4.37, - "1564422591":4.37, - "1564423791":4.37, - "1564424991":4.38, - "1564426191":4.36, - "1564427391":4.35, - "1564428591":4.37, - "1564429791":4.36, - "1564430991":4.38, - "1564432191":4.35, - "1564433391":4.37, - "1564434591":4.36, - "1564435791":4.37, - "1564436991":4.37, - "1564438191":4.37, - "1564439391":4.38, - "1564440591":4.36, - "1564441791":4.36, - "1564442991":4.37, - "1564444191":4.37, - "1564445391":4.35, - "1564446591":4.36, - "1564447791":4.36, - "1564448991":4.36, - "1564450191":4.35, - "1564451391":4.37, - "1564452591":4.37, - "1564453791":4.35, - "1564454991":4.36, - "1564456191":4.37, - "1564457391":4.37, - "1564458591":4.36, - "1564459791":4.37, - "1564460991":4.34, - "1564462191":4.36, - "1564463391":4.34, - "1564464591":4.37, - "1564465791":4.34, - "1564466991":4.37, - "1564468191":4.34, - "1564469391":4.36, - "1564470591":4.36, - "1564471791":4.36, - "1564472991":4.37, - "1564474191":4.37, - "1564475391":4.36, - "1564476591":4.35, - "1564477791":4.36, - "1564478991":4.35, - "1564480191":4.35, - "1564481391":4.37, - "1564482591":4.36, - "1564483791":4.34, - "1564484991":4.37, - "1564486191":4.38, - "1564487391":4.35, - "1564488591":4.34, - "1564489791":4.36, - "1564490991":4.35, - "1564492191":4.36, - "1564493391":4.36, - "1564494591":4.36 - } - } -] -``` - -For further details on OpenTSDB queries, please refer to the following documentation: [OpenTSDB API query](http://opentsdb.net/docs/build/html/api_http/query/index.html) - -## Go further - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/guide.en-au.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/guide.en-au.md deleted file mode 100644 index daf133a49b6..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/guide.en-au.md +++ /dev/null @@ -1,266 +0,0 @@ ---- -title: 'Using the vScope API' -excerpt: 'Find out how to use the vScope API to collect monitoring data in your applications' -updated: 2020-06-29 ---- - -## Objective - -OVHcloud provides you with a tool called **vScope**, for supervising and monitoring your virtual machines and infrastructures. - -It is a webpage that displays useful information on your resource usage. - -You can also access this information via the APIv6 and Metrics API. - -**This guide explains how to use these APIs.** - -## Requirements - -- a [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/en-au/enterprise/products/hosted-private-cloud/) -- access to the management interface (vScope) - -## Instructions - -vScope provides two types of information: - -- **Live** information which corresponds to the information on different components at a given time. -- Graphs presenting logged performance data for different components, such as a virtual machine’s CPU and RAM. - -### Collecting **live** data - -**Live** data is is the data available via the vScope interface’s main page. - -![vScope-API](images/vScope1.png){.thumbnail} - -You can retrieve **live** data for the following components: - -- filers -- hosts -- virtual machines - -You can use the API via the following three APIv6 calls: - -#### Filers - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/filer/{filerId} -> - -#### Hosts - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host/{hostId} -> - -#### Virtual machines - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/vm/{vmId} -> - -### Collecting logged data (graphs) - -To collect and use logged data (graphs), we use the **Metrics Data Platforms** product. - -Via OpenTSDB or WARP10 protocol, you will be able to retrieve your data as points. You can use these points via your application, or directly display them in your choice of rendering. - -The following instructions cover the use of the OpenTSDB protocol for a raw data display (no graph rendering). - -To use **Metrics Data Platforms**, you will need to get a *read* token. With the new version of vScope, each infrastructure user has a *read* token. - -Use the following APIv6 call to retrieve the read token for the user you want: - -> [!api] -> -> @api {v1} /dedicatedCloud POST /dedicatedCloud/{serviceName}/user/{userId}/metricsToken -> - -Your token will be in the result’s **token** field. - -```json -{ - "warpEndpoint": "https://warp10.gra1-ovh.metrics.ovh.net", - "token": "XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX", - "opentsdbEndpoint": "https://opentsdb.gra1-ovh.metrics.ovh.net" -} -``` - -For each component type, there is a list of metrics, and it requires a number of very precise settings (also called labels). - -#### Filers - -| Metrics | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.filer.datastore.diskspace.used | Filer usage in KB | datacenter : pcc-37-187-228-180_datacenter869,
datastore : pcc-000443 | - -#### Hosts - -| Metrics | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.host.cpu.usage.perc | Host processor usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51 | -| vscope.host.mem.usage.perc | Host RAM usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51 | -| vscope.host.net.tx | Host outgoing network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.rx | Host incoming network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetstx | Number of network packets sent from the host | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetsrx | Number of network packets received from the host | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | - -#### Virtual machines - -| Metrics | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.vm.cpu.usage.perc | VM processor usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.mem.usage.perc | VM RAM usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.cpu.ready |VM’s CPU Ready time in milliseconds | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.rx | VM incoming network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.tx | VM outgoing network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.packetsrx | Number of network packets received from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.packetstx | Number of network packets sent from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.io.read | IO number per second in read mode from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.io.write | IO number per second in write mode from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.bandwidth.read | VM disk bandwidth in read mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.bandwidth.write | VM disk bandwidth in write mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.latency.read | VM disk latency in read mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.latency.write | VM disk latency in write mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | - -#### Example of data gathered using the OpenTSDB protocol - -Now that you have retrieved your token, your endpoint, and your list of metrics, you can retrieve a host’s RAM usage data for a period of 1 day. - -Below is an example query: - -``` -curl -XPOST https://read:XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX@opentsdb.gra1-ovh.metrics.ovh.net/api/query --d '{ - "start":1564407950, - "queries":[ - { - "metric":"vscope.host.mem.usage.perc", - "aggregator":"sum", - "downsample":"20m-max-zero", - "tags": { - "datacenter":"pcc-37-187-228-180_datacenter869", - "host":"172.17.86.51" - } - } - ] -}' -``` - -Below are explanations of the fields used: - -- **read:** user used to send the query (will always be read). -- XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX: the token retrieved earlier via the APIv6. -- **opentsdb.gra1-ovh.metrics.ovh.net:** OpenTSDB endpoint, also retrieved via the APIv6. This endpoint may vary depending on your location. -- **start:** a timestamp corresponding to the query’s start date. -- **queries:** a table containing the metrics to retrieve. Several metrics may be retrieved in a single query. -- **metric:** the name of the metric to retrieve. -- **aggregator:** the name of the aggregation feature (please refer to OpenTSDB documentation for further details). -- **downsample:** the name of the downsampling feature (can be used to reduce the amount of data to retrieve. Optional setting). -- **tags:** a list of labels in the form of key/value. - -Other settings may also be provided. Please refer to the documentation for the OpenTSDB API for further details. - -You will then receive a *json* with the query summary, as well as the timestamps associated with their value in the **dps** field. -For example: - -```json -[ - { - "metric":"vscope.host.mem.usage.perc", - "tags":{ - "datacenter":"pcc-37-187-228-180_datacenter869", - "env":"prod", - "host":"172.17.86.51", - "servicename":"pcc-37-187-228-180", - "servicetype":"vscope" - }, - "query":{ - "index":0 - }, - "aggregateTags":[], - "dps":{ - "1564409391":4.38, - "1564410591":4.35, - "1564411791":4.37, - "1564412991":4.38, - "1564414191":4.35, - "1564415391":4.38, - "1564416591":4.35, - "1564417791":4.36, - "1564418991":4.36, - "1564420191":4.37, - "1564421391":4.37, - "1564422591":4.37, - "1564423791":4.37, - "1564424991":4.38, - "1564426191":4.36, - "1564427391":4.35, - "1564428591":4.37, - "1564429791":4.36, - "1564430991":4.38, - "1564432191":4.35, - "1564433391":4.37, - "1564434591":4.36, - "1564435791":4.37, - "1564436991":4.37, - "1564438191":4.37, - "1564439391":4.38, - "1564440591":4.36, - "1564441791":4.36, - "1564442991":4.37, - "1564444191":4.37, - "1564445391":4.35, - "1564446591":4.36, - "1564447791":4.36, - "1564448991":4.36, - "1564450191":4.35, - "1564451391":4.37, - "1564452591":4.37, - "1564453791":4.35, - "1564454991":4.36, - "1564456191":4.37, - "1564457391":4.37, - "1564458591":4.36, - "1564459791":4.37, - "1564460991":4.34, - "1564462191":4.36, - "1564463391":4.34, - "1564464591":4.37, - "1564465791":4.34, - "1564466991":4.37, - "1564468191":4.34, - "1564469391":4.36, - "1564470591":4.36, - "1564471791":4.36, - "1564472991":4.37, - "1564474191":4.37, - "1564475391":4.36, - "1564476591":4.35, - "1564477791":4.36, - "1564478991":4.35, - "1564480191":4.35, - "1564481391":4.37, - "1564482591":4.36, - "1564483791":4.34, - "1564484991":4.37, - "1564486191":4.38, - "1564487391":4.35, - "1564488591":4.34, - "1564489791":4.36, - "1564490991":4.35, - "1564492191":4.36, - "1564493391":4.36, - "1564494591":4.36 - } - } -] -``` - -For further details on OpenTSDB queries, please refer to the following documentation: [OpenTSDB API query](http://opentsdb.net/docs/build/html/api_http/query/index.html) - -## Go further - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/guide.en-ca.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/guide.en-ca.md deleted file mode 100644 index 5e5b780cc31..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/guide.en-ca.md +++ /dev/null @@ -1,266 +0,0 @@ ---- -title: 'Using the vScope API' -excerpt: 'Find out how to use the vScope API to collect monitoring data in your applications' -updated: 2020-06-29 ---- - -## Objective - -OVHcloud provides you with a tool called **vScope**, for supervising and monitoring your virtual machines and infrastructures. - -It is a webpage that displays useful information on your resource usage. - -You can also access this information via the APIv6 and Metrics API. - -**This guide explains how to use these APIs.** - -## Requirements - -- a [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/en-ca/enterprise/products/hosted-private-cloud/) -- access to the management interface (vScope) - -## Instructions - -vScope provides two types of information: - -- **Live** information which corresponds to the information on different components at a given time. -- Graphs presenting logged performance data for different components, such as a virtual machine’s CPU and RAM. - -### Collecting **live** data - -**Live** data is is the data available via the vScope interface’s main page. - -![vScope-API](images/vScope1.png){.thumbnail} - -You can retrieve **live** data for the following components: - -- filers -- hosts -- virtual machines - -You can use the API via the following three APIv6 calls: - -#### Filers - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/filer/{filerId} -> - -#### Hosts - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host/{hostId} -> - -#### Virtual machines - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/vm/{vmId} -> - -### Collecting logged data (graphs) - -To collect and use logged data (graphs), we use the **Metrics Data Platforms** product. - -Via OpenTSDB or WARP10 protocol, you will be able to retrieve your data as points. You can use these points via your application, or directly display them in your choice of rendering. - -The following instructions cover the use of the OpenTSDB protocol for a raw data display (no graph rendering). - -To use **Metrics Data Platforms**, you will need to get a *read* token. With the new version of vScope, each infrastructure user has a *read* token. - -Use the following APIv6 call to retrieve the read token for the user you want: - -> [!api] -> -> @api {v1} /dedicatedCloud POST /dedicatedCloud/{serviceName}/user/{userId}/metricsToken -> - -Your token will be in the result’s **token** field. - -```json -{ - "warpEndpoint": "https://warp10.gra1-ovh.metrics.ovh.net", - "token": "XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX", - "opentsdbEndpoint": "https://opentsdb.gra1-ovh.metrics.ovh.net" -} -``` - -For each component type, there is a list of metrics, and it requires a number of very precise settings (also called labels). - -#### Filers - -| Metrics | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.filer.datastore.diskspace.used | Filer usage in KB | datacenter : pcc-37-187-228-180_datacenter869,
datastore : pcc-000443 | - -#### Hosts - -| Metrics | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.host.cpu.usage.perc | Host processor usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51 | -| vscope.host.mem.usage.perc | Host RAM usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51 | -| vscope.host.net.tx | Host outgoing network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.rx | Host incoming network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetstx | Number of network packets sent from the host | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetsrx | Number of network packets received from the host | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | - -#### Virtual machines - -| Metrics | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.vm.cpu.usage.perc | VM processor usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.mem.usage.perc | VM RAM usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.cpu.ready |VM’s CPU Ready time in milliseconds | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.rx | VM incoming network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.tx | VM outgoing network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.packetsrx | Number of network packets received from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.packetstx | Number of network packets sent from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.io.read | IO number per second in read mode from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.io.write | IO number per second in write mode from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.bandwidth.read | VM disk bandwidth in read mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.bandwidth.write | VM disk bandwidth in write mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.latency.read | VM disk latency in read mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.latency.write | VM disk latency in write mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | - -#### Example of data gathered using the OpenTSDB protocol - -Now that you have retrieved your token, your endpoint, and your list of metrics, you can retrieve a host’s RAM usage data for a period of 1 day. - -Below is an example query: - -``` -curl -XPOST https://read:XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX@opentsdb.gra1-ovh.metrics.ovh.net/api/query --d '{ - "start":1564407950, - "queries":[ - { - "metric":"vscope.host.mem.usage.perc", - "aggregator":"sum", - "downsample":"20m-max-zero", - "tags": { - "datacenter":"pcc-37-187-228-180_datacenter869", - "host":"172.17.86.51" - } - } - ] -}' -``` - -Below are explanations of the fields used: - -- **read:** user used to send the query (will always be read). -- XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX: the token retrieved earlier via the APIv6. -- **opentsdb.gra1-ovh.metrics.ovh.net:** OpenTSDB endpoint, also retrieved via the APIv6. This endpoint may vary depending on your location. -- **start:** a timestamp corresponding to the query’s start date. -- **queries:** a table containing the metrics to retrieve. Several metrics may be retrieved in a single query. -- **metric:** the name of the metric to retrieve. -- **aggregator:** the name of the aggregation feature (please refer to OpenTSDB documentation for further details). -- **downsample:** the name of the downsampling feature (can be used to reduce the amount of data to retrieve. Optional setting). -- **tags:** a list of labels in the form of key/value. - -Other settings may also be provided. Please refer to the documentation for the OpenTSDB API for further details. - -You will then receive a *json* with the query summary, as well as the timestamps associated with their value in the **dps** field. -For example: - -```json -[ - { - "metric":"vscope.host.mem.usage.perc", - "tags":{ - "datacenter":"pcc-37-187-228-180_datacenter869", - "env":"prod", - "host":"172.17.86.51", - "servicename":"pcc-37-187-228-180", - "servicetype":"vscope" - }, - "query":{ - "index":0 - }, - "aggregateTags":[], - "dps":{ - "1564409391":4.38, - "1564410591":4.35, - "1564411791":4.37, - "1564412991":4.38, - "1564414191":4.35, - "1564415391":4.38, - "1564416591":4.35, - "1564417791":4.36, - "1564418991":4.36, - "1564420191":4.37, - "1564421391":4.37, - "1564422591":4.37, - "1564423791":4.37, - "1564424991":4.38, - "1564426191":4.36, - "1564427391":4.35, - "1564428591":4.37, - "1564429791":4.36, - "1564430991":4.38, - "1564432191":4.35, - "1564433391":4.37, - "1564434591":4.36, - "1564435791":4.37, - "1564436991":4.37, - "1564438191":4.37, - "1564439391":4.38, - "1564440591":4.36, - "1564441791":4.36, - "1564442991":4.37, - "1564444191":4.37, - "1564445391":4.35, - "1564446591":4.36, - "1564447791":4.36, - "1564448991":4.36, - "1564450191":4.35, - "1564451391":4.37, - "1564452591":4.37, - "1564453791":4.35, - "1564454991":4.36, - "1564456191":4.37, - "1564457391":4.37, - "1564458591":4.36, - "1564459791":4.37, - "1564460991":4.34, - "1564462191":4.36, - "1564463391":4.34, - "1564464591":4.37, - "1564465791":4.34, - "1564466991":4.37, - "1564468191":4.34, - "1564469391":4.36, - "1564470591":4.36, - "1564471791":4.36, - "1564472991":4.37, - "1564474191":4.37, - "1564475391":4.36, - "1564476591":4.35, - "1564477791":4.36, - "1564478991":4.35, - "1564480191":4.35, - "1564481391":4.37, - "1564482591":4.36, - "1564483791":4.34, - "1564484991":4.37, - "1564486191":4.38, - "1564487391":4.35, - "1564488591":4.34, - "1564489791":4.36, - "1564490991":4.35, - "1564492191":4.36, - "1564493391":4.36, - "1564494591":4.36 - } - } -] -``` - -For further details on OpenTSDB queries, please refer to the following documentation: [OpenTSDB API query](http://opentsdb.net/docs/build/html/api_http/query/index.html) - -## Go further - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/guide.en-gb.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/guide.en-gb.md deleted file mode 100644 index c3bbaabe2bf..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/guide.en-gb.md +++ /dev/null @@ -1,266 +0,0 @@ ---- -title: 'Using the vScope API' -excerpt: 'Find out how to use the vScope API to collect monitoring data in your applications' -updated: 2020-06-29 ---- - -## Objective - -OVHcloud provides you with a tool called **vScope**, for supervising and monitoring your virtual machines and infrastructures. - -It is a webpage that displays useful information on your resource usage. - -You can also access this information via the APIv6 and Metrics API. - -**This guide explains how to use these APIs.** - -## Requirements - -- a [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/en-gb/enterprise/products/hosted-private-cloud/) -- access to the management interface (vScope) - -## Instructions - -vScope provides two types of information: - -- **Live** information which corresponds to the information on different components at a given time. -- Graphs presenting logged performance data for different components, such as a virtual machine’s CPU and RAM. - -### Collecting **live** data - -**Live** data is is the data available via the vScope interface’s main page. - -![vScope-API](images/vScope1.png){.thumbnail} - -You can retrieve **live** data for the following components: - -- filers -- hosts -- virtual machines - -You can use the API via the following three APIv6 calls: - -#### Filers - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/filer/{filerId} -> - -#### Hosts - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host/{hostId} -> - -#### Virtual machines - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/vm/{vmId} -> - -### Collecting logged data (graphs) - -To collect and use logged data (graphs), we use the **Metrics Data Platforms** product. - -Via OpenTSDB or WARP10 protocol, you will be able to retrieve your data as points. You can use these points via your application, or directly display them in your choice of rendering. - -The following instructions cover the use of the OpenTSDB protocol for a raw data display (no graph rendering). - -To use **Metrics Data Platforms**, you will need to get a *read* token. With the new version of vScope, each infrastructure user has a *read* token. - -Use the following APIv6 call to retrieve the read token for the user you want: - -> [!api] -> -> @api {v1} /dedicatedCloud POST /dedicatedCloud/{serviceName}/user/{userId}/metricsToken -> - -Your token will be in the result’s **token** field. - -```json -{ - "warpEndpoint": "https://warp10.gra1-ovh.metrics.ovh.net", - "token": "XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX", - "opentsdbEndpoint": "https://opentsdb.gra1-ovh.metrics.ovh.net" -} -``` - -For each component type, there is a list of metrics, and it requires a number of very precise settings (also called labels). - -#### Filers - -| Metrics | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.filer.datastore.diskspace.used | Filer usage in KB | datacenter : pcc-37-187-228-180_datacenter869,
datastore : pcc-000443 | - -#### Hosts - -| Metrics | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.host.cpu.usage.perc | Host processor usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51 | -| vscope.host.mem.usage.perc | Host RAM usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51 | -| vscope.host.net.tx | Host outgoing network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.rx | Host incoming network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetstx | Number of network packets sent from the host | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetsrx | Number of network packets received from the host | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | - -#### Virtual machines - -| Metrics | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.vm.cpu.usage.perc | VM processor usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.mem.usage.perc | VM RAM usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.cpu.ready |VM’s CPU Ready time in milliseconds | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.rx | VM incoming network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.tx | VM outgoing network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.packetsrx | Number of network packets received from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.packetstx | Number of network packets sent from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.io.read | IO number per second in read mode from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.io.write | IO number per second in write mode from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.bandwidth.read | VM disk bandwidth in read mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.bandwidth.write | VM disk bandwidth in write mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.latency.read | VM disk latency in read mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.latency.write | VM disk latency in write mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | - -#### Example of data gathered using the OpenTSDB protocol - -Now that you have retrieved your token, your endpoint, and your list of metrics, you can retrieve a host’s RAM usage data for a period of 1 day. - -Below is an example query: - -``` -curl -XPOST https://read:XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX@opentsdb.gra1-ovh.metrics.ovh.net/api/query --d '{ - "start":1564407950, - "queries":[ - { - "metric":"vscope.host.mem.usage.perc", - "aggregator":"sum", - "downsample":"20m-max-zero", - "tags": { - "datacenter":"pcc-37-187-228-180_datacenter869", - "host":"172.17.86.51" - } - } - ] -}' -``` - -Below are explanations of the fields used: - -- **read:** user used to send the query (will always be read). -- XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX: the token retrieved earlier via the APIv6. -- **opentsdb.gra1-ovh.metrics.ovh.net:** OpenTSDB endpoint, also retrieved via the APIv6. This endpoint may vary depending on your location. -- **start:** a timestamp corresponding to the query’s start date. -- **queries:** a table containing the metrics to retrieve. Several metrics may be retrieved in a single query. -- **metric:** the name of the metric to retrieve. -- **aggregator:** the name of the aggregation feature (please refer to OpenTSDB documentation for further details). -- **downsample:** the name of the downsampling feature (can be used to reduce the amount of data to retrieve. Optional setting). -- **tags:** a list of labels in the form of key/value. - -Other settings may also be provided. Please refer to the documentation for the OpenTSDB API for further details. - -You will then receive a *json* with the query summary, as well as the timestamps associated with their value in the **dps** field. -For example: - -```json -[ - { - "metric":"vscope.host.mem.usage.perc", - "tags":{ - "datacenter":"pcc-37-187-228-180_datacenter869", - "env":"prod", - "host":"172.17.86.51", - "servicename":"pcc-37-187-228-180", - "servicetype":"vscope" - }, - "query":{ - "index":0 - }, - "aggregateTags":[], - "dps":{ - "1564409391":4.38, - "1564410591":4.35, - "1564411791":4.37, - "1564412991":4.38, - "1564414191":4.35, - "1564415391":4.38, - "1564416591":4.35, - "1564417791":4.36, - "1564418991":4.36, - "1564420191":4.37, - "1564421391":4.37, - "1564422591":4.37, - "1564423791":4.37, - "1564424991":4.38, - "1564426191":4.36, - "1564427391":4.35, - "1564428591":4.37, - "1564429791":4.36, - "1564430991":4.38, - "1564432191":4.35, - "1564433391":4.37, - "1564434591":4.36, - "1564435791":4.37, - "1564436991":4.37, - "1564438191":4.37, - "1564439391":4.38, - "1564440591":4.36, - "1564441791":4.36, - "1564442991":4.37, - "1564444191":4.37, - "1564445391":4.35, - "1564446591":4.36, - "1564447791":4.36, - "1564448991":4.36, - "1564450191":4.35, - "1564451391":4.37, - "1564452591":4.37, - "1564453791":4.35, - "1564454991":4.36, - "1564456191":4.37, - "1564457391":4.37, - "1564458591":4.36, - "1564459791":4.37, - "1564460991":4.34, - "1564462191":4.36, - "1564463391":4.34, - "1564464591":4.37, - "1564465791":4.34, - "1564466991":4.37, - "1564468191":4.34, - "1564469391":4.36, - "1564470591":4.36, - "1564471791":4.36, - "1564472991":4.37, - "1564474191":4.37, - "1564475391":4.36, - "1564476591":4.35, - "1564477791":4.36, - "1564478991":4.35, - "1564480191":4.35, - "1564481391":4.37, - "1564482591":4.36, - "1564483791":4.34, - "1564484991":4.37, - "1564486191":4.38, - "1564487391":4.35, - "1564488591":4.34, - "1564489791":4.36, - "1564490991":4.35, - "1564492191":4.36, - "1564493391":4.36, - "1564494591":4.36 - } - } -] -``` - -For further details on OpenTSDB queries, please refer to the following documentation: [OpenTSDB API query](http://opentsdb.net/docs/build/html/api_http/query/index.html) - -## Go further - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/guide.en-ie.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/guide.en-ie.md deleted file mode 100644 index 105121a5a1d..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/guide.en-ie.md +++ /dev/null @@ -1,266 +0,0 @@ ---- -title: 'Using the vScope API' -excerpt: 'Find out how to use the vScope API to collect monitoring data in your applications' -updated: 2020-06-29 ---- - -## Objective - -OVHcloud provides you with a tool called **vScope**, for supervising and monitoring your virtual machines and infrastructures. - -It is a webpage that displays useful information on your resource usage. - -You can also access this information via the APIv6 and Metrics API. - -**This guide explains how to use these APIs.** - -## Requirements - -- a [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/en-ie/enterprise/products/hosted-private-cloud/) -- access to the management interface (vScope) - -## Instructions - -vScope provides two types of information: - -- **Live** information which corresponds to the information on different components at a given time. -- Graphs presenting logged performance data for different components, such as a virtual machine’s CPU and RAM. - -### Collecting **live** data - -**Live** data is is the data available via the vScope interface’s main page. - -![vScope-API](images/vScope1.png){.thumbnail} - -You can retrieve **live** data for the following components: - -- filers -- hosts -- virtual machines - -You can use the API via the following three APIv6 calls: - -#### Filers - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/filer/{filerId} -> - -#### Hosts - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host/{hostId} -> - -#### Virtual machines - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/vm/{vmId} -> - -### Collecting logged data (graphs) - -To collect and use logged data (graphs), we use the **Metrics Data Platforms** product. - -Via OpenTSDB or WARP10 protocol, you will be able to retrieve your data as points. You can use these points via your application, or directly display them in your choice of rendering. - -The following instructions cover the use of the OpenTSDB protocol for a raw data display (no graph rendering). - -To use **Metrics Data Platforms**, you will need to get a *read* token. With the new version of vScope, each infrastructure user has a *read* token. - -Use the following APIv6 call to retrieve the read token for the user you want: - -> [!api] -> -> @api {v1} /dedicatedCloud POST /dedicatedCloud/{serviceName}/user/{userId}/metricsToken -> - -Your token will be in the result’s **token** field. - -```json -{ - "warpEndpoint": "https://warp10.gra1-ovh.metrics.ovh.net", - "token": "XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX", - "opentsdbEndpoint": "https://opentsdb.gra1-ovh.metrics.ovh.net" -} -``` - -For each component type, there is a list of metrics, and it requires a number of very precise settings (also called labels). - -#### Filers - -| Metrics | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.filer.datastore.diskspace.used | Filer usage in KB | datacenter : pcc-37-187-228-180_datacenter869,
datastore : pcc-000443 | - -#### Hosts - -| Metrics | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.host.cpu.usage.perc | Host processor usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51 | -| vscope.host.mem.usage.perc | Host RAM usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51 | -| vscope.host.net.tx | Host outgoing network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.rx | Host incoming network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetstx | Number of network packets sent from the host | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetsrx | Number of network packets received from the host | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | - -#### Virtual machines - -| Metrics | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.vm.cpu.usage.perc | VM processor usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.mem.usage.perc | VM RAM usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.cpu.ready |VM’s CPU Ready time in milliseconds | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.rx | VM incoming network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.tx | VM outgoing network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.packetsrx | Number of network packets received from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.packetstx | Number of network packets sent from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.io.read | IO number per second in read mode from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.io.write | IO number per second in write mode from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.bandwidth.read | VM disk bandwidth in read mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.bandwidth.write | VM disk bandwidth in write mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.latency.read | VM disk latency in read mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.latency.write | VM disk latency in write mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | - -#### Example of data gathered using the OpenTSDB protocol - -Now that you have retrieved your token, your endpoint, and your list of metrics, you can retrieve a host’s RAM usage data for a period of 1 day. - -Below is an example query: - -``` -curl -XPOST https://read:XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX@opentsdb.gra1-ovh.metrics.ovh.net/api/query --d '{ - "start":1564407950, - "queries":[ - { - "metric":"vscope.host.mem.usage.perc", - "aggregator":"sum", - "downsample":"20m-max-zero", - "tags": { - "datacenter":"pcc-37-187-228-180_datacenter869", - "host":"172.17.86.51" - } - } - ] -}' -``` - -Below are explanations of the fields used: - -- **read:** user used to send the query (will always be read). -- XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX: the token retrieved earlier via the APIv6. -- **opentsdb.gra1-ovh.metrics.ovh.net:** OpenTSDB endpoint, also retrieved via the APIv6. This endpoint may vary depending on your location. -- **start:** a timestamp corresponding to the query’s start date. -- **queries:** a table containing the metrics to retrieve. Several metrics may be retrieved in a single query. -- **metric:** the name of the metric to retrieve. -- **aggregator:** the name of the aggregation feature (please refer to OpenTSDB documentation for further details). -- **downsample:** the name of the downsampling feature (can be used to reduce the amount of data to retrieve. Optional setting). -- **tags:** a list of labels in the form of key/value. - -Other settings may also be provided. Please refer to the documentation for the OpenTSDB API for further details. - -You will then receive a *json* with the query summary, as well as the timestamps associated with their value in the **dps** field. -For example: - -```json -[ - { - "metric":"vscope.host.mem.usage.perc", - "tags":{ - "datacenter":"pcc-37-187-228-180_datacenter869", - "env":"prod", - "host":"172.17.86.51", - "servicename":"pcc-37-187-228-180", - "servicetype":"vscope" - }, - "query":{ - "index":0 - }, - "aggregateTags":[], - "dps":{ - "1564409391":4.38, - "1564410591":4.35, - "1564411791":4.37, - "1564412991":4.38, - "1564414191":4.35, - "1564415391":4.38, - "1564416591":4.35, - "1564417791":4.36, - "1564418991":4.36, - "1564420191":4.37, - "1564421391":4.37, - "1564422591":4.37, - "1564423791":4.37, - "1564424991":4.38, - "1564426191":4.36, - "1564427391":4.35, - "1564428591":4.37, - "1564429791":4.36, - "1564430991":4.38, - "1564432191":4.35, - "1564433391":4.37, - "1564434591":4.36, - "1564435791":4.37, - "1564436991":4.37, - "1564438191":4.37, - "1564439391":4.38, - "1564440591":4.36, - "1564441791":4.36, - "1564442991":4.37, - "1564444191":4.37, - "1564445391":4.35, - "1564446591":4.36, - "1564447791":4.36, - "1564448991":4.36, - "1564450191":4.35, - "1564451391":4.37, - "1564452591":4.37, - "1564453791":4.35, - "1564454991":4.36, - "1564456191":4.37, - "1564457391":4.37, - "1564458591":4.36, - "1564459791":4.37, - "1564460991":4.34, - "1564462191":4.36, - "1564463391":4.34, - "1564464591":4.37, - "1564465791":4.34, - "1564466991":4.37, - "1564468191":4.34, - "1564469391":4.36, - "1564470591":4.36, - "1564471791":4.36, - "1564472991":4.37, - "1564474191":4.37, - "1564475391":4.36, - "1564476591":4.35, - "1564477791":4.36, - "1564478991":4.35, - "1564480191":4.35, - "1564481391":4.37, - "1564482591":4.36, - "1564483791":4.34, - "1564484991":4.37, - "1564486191":4.38, - "1564487391":4.35, - "1564488591":4.34, - "1564489791":4.36, - "1564490991":4.35, - "1564492191":4.36, - "1564493391":4.36, - "1564494591":4.36 - } - } -] -``` - -For further details on OpenTSDB queries, please refer to the following documentation: [OpenTSDB API query](http://opentsdb.net/docs/build/html/api_http/query/index.html) - -## Go further - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/guide.en-sg.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/guide.en-sg.md deleted file mode 100644 index 8d69e74127f..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/guide.en-sg.md +++ /dev/null @@ -1,266 +0,0 @@ ---- -title: 'Using the vScope API' -excerpt: 'Find out how to use the vScope API to collect monitoring data in your applications' -updated: 2020-06-29 ---- - -## Objective - -OVHcloud provides you with a tool called **vScope**, for supervising and monitoring your virtual machines and infrastructures. - -It is a webpage that displays useful information on your resource usage. - -You can also access this information via the APIv6 and Metrics API. - -**This guide explains how to use these APIs.** - -## Requirements - -- a [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/en-sg/enterprise/products/hosted-private-cloud/) -- access to the management interface (vScope) - -## Instructions - -vScope provides two types of information: - -- **Live** information which corresponds to the information on different components at a given time. -- Graphs presenting logged performance data for different components, such as a virtual machine’s CPU and RAM. - -### Collecting **live** data - -**Live** data is is the data available via the vScope interface’s main page. - -![vScope-API](images/vScope1.png){.thumbnail} - -You can retrieve **live** data for the following components: - -- filers -- hosts -- virtual machines - -You can use the API via the following three APIv6 calls: - -#### Filers - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/filer/{filerId} -> - -#### Hosts - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host/{hostId} -> - -#### Virtual machines - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/vm/{vmId} -> - -### Collecting logged data (graphs) - -To collect and use logged data (graphs), we use the **Metrics Data Platforms** product. - -Via OpenTSDB or WARP10 protocol, you will be able to retrieve your data as points. You can use these points via your application, or directly display them in your choice of rendering. - -The following instructions cover the use of the OpenTSDB protocol for a raw data display (no graph rendering). - -To use **Metrics Data Platforms**, you will need to get a *read* token. With the new version of vScope, each infrastructure user has a *read* token. - -Use the following APIv6 call to retrieve the read token for the user you want: - -> [!api] -> -> @api {v1} /dedicatedCloud POST /dedicatedCloud/{serviceName}/user/{userId}/metricsToken -> - -Your token will be in the result’s **token** field. - -```json -{ - "warpEndpoint": "https://warp10.gra1-ovh.metrics.ovh.net", - "token": "XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX", - "opentsdbEndpoint": "https://opentsdb.gra1-ovh.metrics.ovh.net" -} -``` - -For each component type, there is a list of metrics, and it requires a number of very precise settings (also called labels). - -#### Filers - -| Metrics | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.filer.datastore.diskspace.used | Filer usage in KB | datacenter : pcc-37-187-228-180_datacenter869,
datastore : pcc-000443 | - -#### Hosts - -| Metrics | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.host.cpu.usage.perc | Host processor usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51 | -| vscope.host.mem.usage.perc | Host RAM usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51 | -| vscope.host.net.tx | Host outgoing network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.rx | Host incoming network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetstx | Number of network packets sent from the host | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetsrx | Number of network packets received from the host | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | - -#### Virtual machines - -| Metrics | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.vm.cpu.usage.perc | VM processor usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.mem.usage.perc | VM RAM usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.cpu.ready |VM’s CPU Ready time in milliseconds | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.rx | VM incoming network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.tx | VM outgoing network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.packetsrx | Number of network packets received from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.packetstx | Number of network packets sent from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.io.read | IO number per second in read mode from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.io.write | IO number per second in write mode from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.bandwidth.read | VM disk bandwidth in read mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.bandwidth.write | VM disk bandwidth in write mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.latency.read | VM disk latency in read mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.latency.write | VM disk latency in write mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | - -#### Example of data gathered using the OpenTSDB protocol - -Now that you have retrieved your token, your endpoint, and your list of metrics, you can retrieve a host’s RAM usage data for a period of 1 day. - -Below is an example query: - -``` -curl -XPOST https://read:XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX@opentsdb.gra1-ovh.metrics.ovh.net/api/query --d '{ - "start":1564407950, - "queries":[ - { - "metric":"vscope.host.mem.usage.perc", - "aggregator":"sum", - "downsample":"20m-max-zero", - "tags": { - "datacenter":"pcc-37-187-228-180_datacenter869", - "host":"172.17.86.51" - } - } - ] -}' -``` - -Below are explanations of the fields used: - -- **read:** user used to send the query (will always be read). -- XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX: the token retrieved earlier via the APIv6. -- **opentsdb.gra1-ovh.metrics.ovh.net:** OpenTSDB endpoint, also retrieved via the APIv6. This endpoint may vary depending on your location. -- **start:** a timestamp corresponding to the query’s start date. -- **queries:** a table containing the metrics to retrieve. Several metrics may be retrieved in a single query. -- **metric:** the name of the metric to retrieve. -- **aggregator:** the name of the aggregation feature (please refer to OpenTSDB documentation for further details). -- **downsample:** the name of the downsampling feature (can be used to reduce the amount of data to retrieve. Optional setting). -- **tags:** a list of labels in the form of key/value. - -Other settings may also be provided. Please refer to the documentation for the OpenTSDB API for further details. - -You will then receive a *json* with the query summary, as well as the timestamps associated with their value in the **dps** field. -For example: - -```json -[ - { - "metric":"vscope.host.mem.usage.perc", - "tags":{ - "datacenter":"pcc-37-187-228-180_datacenter869", - "env":"prod", - "host":"172.17.86.51", - "servicename":"pcc-37-187-228-180", - "servicetype":"vscope" - }, - "query":{ - "index":0 - }, - "aggregateTags":[], - "dps":{ - "1564409391":4.38, - "1564410591":4.35, - "1564411791":4.37, - "1564412991":4.38, - "1564414191":4.35, - "1564415391":4.38, - "1564416591":4.35, - "1564417791":4.36, - "1564418991":4.36, - "1564420191":4.37, - "1564421391":4.37, - "1564422591":4.37, - "1564423791":4.37, - "1564424991":4.38, - "1564426191":4.36, - "1564427391":4.35, - "1564428591":4.37, - "1564429791":4.36, - "1564430991":4.38, - "1564432191":4.35, - "1564433391":4.37, - "1564434591":4.36, - "1564435791":4.37, - "1564436991":4.37, - "1564438191":4.37, - "1564439391":4.38, - "1564440591":4.36, - "1564441791":4.36, - "1564442991":4.37, - "1564444191":4.37, - "1564445391":4.35, - "1564446591":4.36, - "1564447791":4.36, - "1564448991":4.36, - "1564450191":4.35, - "1564451391":4.37, - "1564452591":4.37, - "1564453791":4.35, - "1564454991":4.36, - "1564456191":4.37, - "1564457391":4.37, - "1564458591":4.36, - "1564459791":4.37, - "1564460991":4.34, - "1564462191":4.36, - "1564463391":4.34, - "1564464591":4.37, - "1564465791":4.34, - "1564466991":4.37, - "1564468191":4.34, - "1564469391":4.36, - "1564470591":4.36, - "1564471791":4.36, - "1564472991":4.37, - "1564474191":4.37, - "1564475391":4.36, - "1564476591":4.35, - "1564477791":4.36, - "1564478991":4.35, - "1564480191":4.35, - "1564481391":4.37, - "1564482591":4.36, - "1564483791":4.34, - "1564484991":4.37, - "1564486191":4.38, - "1564487391":4.35, - "1564488591":4.34, - "1564489791":4.36, - "1564490991":4.35, - "1564492191":4.36, - "1564493391":4.36, - "1564494591":4.36 - } - } -] -``` - -For further details on OpenTSDB queries, please refer to the following documentation: [OpenTSDB API query](http://opentsdb.net/docs/build/html/api_http/query/index.html) - -## Go further - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/guide.en-us.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/guide.en-us.md deleted file mode 100644 index 1eb431487ea..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/guide.en-us.md +++ /dev/null @@ -1,266 +0,0 @@ ---- -title: 'Using the vScope API' -excerpt: 'Find out how to use the vScope API to collect monitoring data in your applications' -updated: 2020-06-29 ---- - -## Objective - -OVHcloud provides you with a tool called **vScope**, for supervising and monitoring your virtual machines and infrastructures. - -It is a webpage that displays useful information on your resource usage. - -You can also access this information via the APIv6 and Metrics API. - -**This guide explains how to use these APIs.** - -## Requirements - -- a [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/en/enterprise/products/hosted-private-cloud/) -- access to the management interface (vScope) - -## Instructions - -vScope provides two types of information: - -- **Live** information which corresponds to the information on different components at a given time. -- Graphs presenting logged performance data for different components, such as a virtual machine’s CPU and RAM. - -### Collecting **live** data - -**Live** data is is the data available via the vScope interface’s main page. - -![vScope-API](images/vScope1.png){.thumbnail} - -You can retrieve **live** data for the following components: - -- filers -- hosts -- virtual machines - -You can use the API via the following three APIv6 calls: - -#### Filers - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/filer/{filerId} -> - -#### Hosts - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host/{hostId} -> - -#### Virtual machines - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/vm/{vmId} -> - -### Collecting logged data (graphs) - -To collect and use logged data (graphs), we use the **Metrics Data Platforms** product. - -Via OpenTSDB or WARP10 protocol, you will be able to retrieve your data as points. You can use these points via your application, or directly display them in your choice of rendering. - -The following instructions cover the use of the OpenTSDB protocol for a raw data display (no graph rendering). - -To use **Metrics Data Platforms**, you will need to get a *read* token. With the new version of vScope, each infrastructure user has a *read* token. - -Use the following APIv6 call to retrieve the read token for the user you want: - -> [!api] -> -> @api {v1} /dedicatedCloud POST /dedicatedCloud/{serviceName}/user/{userId}/metricsToken -> - -Your token will be in the result’s **token** field. - -```json -{ - "warpEndpoint": "https://warp10.gra1-ovh.metrics.ovh.net", - "token": "XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX", - "opentsdbEndpoint": "https://opentsdb.gra1-ovh.metrics.ovh.net" -} -``` - -For each component type, there is a list of metrics, and it requires a number of very precise settings (also called labels). - -#### Filers - -| Metrics | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.filer.datastore.diskspace.used | Filer usage in KB | datacenter : pcc-37-187-228-180_datacenter869,
datastore : pcc-000443 | - -#### Hosts - -| Metrics | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.host.cpu.usage.perc | Host processor usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51 | -| vscope.host.mem.usage.perc | Host RAM usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51 | -| vscope.host.net.tx | Host outgoing network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.rx | Host incoming network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetstx | Number of network packets sent from the host | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetsrx | Number of network packets received from the host | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | - -#### Virtual machines - -| Metrics | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.vm.cpu.usage.perc | VM processor usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.mem.usage.perc | VM RAM usage in percent | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.cpu.ready |VM’s CPU Ready time in milliseconds | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.rx | VM incoming network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.tx | VM outgoing network usage | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.packetsrx | Number of network packets received from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.packetstx | Number of network packets sent from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.io.read | IO number per second in read mode from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.io.write | IO number per second in write mode from the VM | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.bandwidth.read | VM disk bandwidth in read mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.bandwidth.write | VM disk bandwidth in write mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.latency.read | VM disk latency in read mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.latency.write | VM disk latency in write mode | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | - -#### Example of data gathered using the OpenTSDB protocol - -Now that you have retrieved your token, your endpoint, and your list of metrics, you can retrieve a host’s RAM usage data for a period of 1 day. - -Below is an example query: - -``` -curl -XPOST https://read:XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX@opentsdb.gra1-ovh.metrics.ovh.net/api/query --d '{ - "start":1564407950, - "queries":[ - { - "metric":"vscope.host.mem.usage.perc", - "aggregator":"sum", - "downsample":"20m-max-zero", - "tags": { - "datacenter":"pcc-37-187-228-180_datacenter869", - "host":"172.17.86.51" - } - } - ] -}' -``` - -Below are explanations of the fields used: - -- **read:** user used to send the query (will always be read). -- XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX: the token retrieved earlier via the APIv6. -- **opentsdb.gra1-ovh.metrics.ovh.net:** OpenTSDB endpoint, also retrieved via the APIv6. This endpoint may vary depending on your location. -- **start:** a timestamp corresponding to the query’s start date. -- **queries:** a table containing the metrics to retrieve. Several metrics may be retrieved in a single query. -- **metric:** the name of the metric to retrieve. -- **aggregator:** the name of the aggregation feature (please refer to OpenTSDB documentation for further details). -- **downsample:** the name of the downsampling feature (can be used to reduce the amount of data to retrieve. Optional setting). -- **tags:** a list of labels in the form of key/value. - -Other settings may also be provided. Please refer to the documentation for the OpenTSDB API for further details. - -You will then receive a *json* with the query summary, as well as the timestamps associated with their value in the **dps** field. -For example: - -```json -[ - { - "metric":"vscope.host.mem.usage.perc", - "tags":{ - "datacenter":"pcc-37-187-228-180_datacenter869", - "env":"prod", - "host":"172.17.86.51", - "servicename":"pcc-37-187-228-180", - "servicetype":"vscope" - }, - "query":{ - "index":0 - }, - "aggregateTags":[], - "dps":{ - "1564409391":4.38, - "1564410591":4.35, - "1564411791":4.37, - "1564412991":4.38, - "1564414191":4.35, - "1564415391":4.38, - "1564416591":4.35, - "1564417791":4.36, - "1564418991":4.36, - "1564420191":4.37, - "1564421391":4.37, - "1564422591":4.37, - "1564423791":4.37, - "1564424991":4.38, - "1564426191":4.36, - "1564427391":4.35, - "1564428591":4.37, - "1564429791":4.36, - "1564430991":4.38, - "1564432191":4.35, - "1564433391":4.37, - "1564434591":4.36, - "1564435791":4.37, - "1564436991":4.37, - "1564438191":4.37, - "1564439391":4.38, - "1564440591":4.36, - "1564441791":4.36, - "1564442991":4.37, - "1564444191":4.37, - "1564445391":4.35, - "1564446591":4.36, - "1564447791":4.36, - "1564448991":4.36, - "1564450191":4.35, - "1564451391":4.37, - "1564452591":4.37, - "1564453791":4.35, - "1564454991":4.36, - "1564456191":4.37, - "1564457391":4.37, - "1564458591":4.36, - "1564459791":4.37, - "1564460991":4.34, - "1564462191":4.36, - "1564463391":4.34, - "1564464591":4.37, - "1564465791":4.34, - "1564466991":4.37, - "1564468191":4.34, - "1564469391":4.36, - "1564470591":4.36, - "1564471791":4.36, - "1564472991":4.37, - "1564474191":4.37, - "1564475391":4.36, - "1564476591":4.35, - "1564477791":4.36, - "1564478991":4.35, - "1564480191":4.35, - "1564481391":4.37, - "1564482591":4.36, - "1564483791":4.34, - "1564484991":4.37, - "1564486191":4.38, - "1564487391":4.35, - "1564488591":4.34, - "1564489791":4.36, - "1564490991":4.35, - "1564492191":4.36, - "1564493391":4.36, - "1564494591":4.36 - } - } -] -``` - -For further details on OpenTSDB queries, please refer to the following documentation: [OpenTSDB API query](http://opentsdb.net/docs/build/html/api_http/query/index.html) - -## Go further - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/guide.es-es.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/guide.es-es.md deleted file mode 100644 index 2693406f9ba..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/guide.es-es.md +++ /dev/null @@ -1,266 +0,0 @@ ---- -title: 'Cómo utilizar la API de vScope' -excerpt: 'Con la API vScope podrá utilizar los datos de monitorización en sus aplicaciones' -updated: 2020-06-29 ---- - -## Objetivo - -OVHcloud pone a su disposición una herramienta de supervisión y monitorización de sus máquinas virtuales y de su infraestructura llamada **vScope**. - -Se trata de una página web en la que se recopila toda la información necesaria sobre el uso de sus recursos. - -Esta información también se encuentra disponible en la APIv6 y la API Metrics. - -**Esta guía explica cómo utilizar estas API**. - -## Requisitos - -- Tener [una infraestructura Hosted Private Cloud](https://www.ovhcloud.com/es-es/enterprise/products/hosted-private-cloud/). -- Estar conectado a la interfaz vScope. - -## Procedimiento - -La herramienta vScope proporciona dos tipos de información: - -- Información **live**, que corresponde a los datos de los diferentes componentes en un momento determinado. -- Gráficos que presentan los datos históricos de rendimiento de los diferentes componentes como, por ejemplo, la CPU y la RAM de una máquina virtual. - -### Recopilar los datos **live** - -Los datos **live** son aquellos que se encuentran disponibles en la página principal de la interfaz vScope. - -![vScope-API](images/vScope1.png){.thumbnail} - -Podrá obtener los datos **live** para los siguientes componentes: - -- filers; -- hosts; -- máquinas virtuales. - -El uso de la API se realiza a través de estas tres llamadas APIv6: - -#### Filers - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/filer/{filerId} -> - -#### Hosts - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host/{hostId} -> - -#### Máquina virtual - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/vm/{vmId} -> - -### Recopilar los datos históricos (Graphs) - -Para recopilar y utilizar los datos históricos (Graphs), puede utilizar la solución **Metrics Data Platform**. - -Mediante el protocolo Opentsdb o WARP10, podrá obtener sus datos en forma de puntos. Asimismo, podrá utilizarlos a través de su aplicación o verlos directamente según el renderizado deseado. - -En esta guía explicaremos el uso del protocolo Opentsdb para obtener una visualización de datos en bruto (sin renderizado gráfico). - -Para poder utilizar **Metrics Data Platform**, necesitará un token de lectura. Con la nueva versión del vScope, cada usuario de la infraestructura dispone de un token de lectura. - -Para el usuario deseado, utilice la siguiente llamada a la APIv6 y obtenga el token de lectura: - -> [!api] -> -> @api {v1} /dedicatedCloud POST /dedicatedCloud/{serviceName}/user/{userId}/metricsToken -> - -Su token se encuentra en el campo **token** del resultado. - -```json -{ - "warpEndpoint": "https://warp10.gra1-ovh.metrics.ovh.net", - "token": "XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX", - "opentsdbEndpoint": "https://opentsdb.gra1-ovh.metrics.ovh.net" -} -``` - -Para cada tipo de componente, existe una lista de métricas y necesita un número muy preciso de parámetros (también llamados labels). - -#### Filers - -| Métricas | Descripción | Labels | -| ----------- | ----------- | ----------- | -| vscope.filer.datastore.diskspace.used | Uso del filer en kB | datacenter: pcc-37-187-228-180_datacenter869,
datastore: pcc-000443 | - -#### Hosts - -| Métricas | Descripción | Labels | -| ----------- | ----------- | ----------- | -| vscope.host.cpu.usage.perc | Uso del procesador del host en porcentaje | \- datacenter: pcc-37-187-228-180_datacenter869,
\- host: 172.17.86.51 | -| vscope.host.mem.usage.perc | Uso de la memoria del host en porcentaje | \- datacenter: pcc-37-187-228-180_datacenter869,
\- host: 172.17.86.51 | -| vscope.host.net.tx | Uso de la red del host de emisión | \- datacenter: pcc-37-187-228-180_datacenter869,
\- host: 172.17.86.51
\- nicname: vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.rx | Uso de la red del host de recepción | \- datacenter: pcc-37-187-228-180_datacenter869,
\- host: 172.17.86.51
\- nicname: vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetstx | Número de paquetes de red transmitidos por el host | \- datacenter: pcc-37-187-228-180_datacenter869,
\- host: 172.17.86.51
\- nicname: vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetsrx | Número de paquetes de red recibidos por el host | \- datacenter: pcc-37-187-228-180_datacenter869,
\- host: 172.17.86.51
\- nicname: vmnic0/vmnic1/vmnic2/vmnic3 | - -#### Máquinas virtuales - -| Métricas | Descripción | Labels | -| ----------- | ----------- | ----------- | -| vscope.vm.cpu.usage.perc | Uso del procesador de la MV en porcentaje | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.mem.usage.perc | Uso de la memoria de la MV en porcentaje | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.cpu.ready |CPU Ready de la MV en milisegundos | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.net.rx | Uso de la red de la MV de recepción | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.net.tx | Uso de la red de la MV de transmisión | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.net.packetsrx | Número de paquetes de red recibidos por la MV | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.net.packetstx | Número de paquetes de red transmitidos por la MV | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.disk.io.read | Número de IO en lectura por segundo de la MV | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.disk.io.write | Número de IO en escritura por segundo de la MV | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.disk.bandwidth.read | Ancho de banda del disco de la MV en modo lectura | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.disk.bandwidth.write | Ancho de banda del disco de la MV en modo escritura | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.disk.latency.read | Latencia del disco de la MV en modo lectura | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.disk.latency.write | Latencia del disco de la MV en modo escritura | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | - -#### Ejemplo de recopilación con el protocolo OpenTSDB - -Una vez que obtuvo su token, su endpoint y su lista de métricas, recuperará los datos de uso de memoria de un host en un día. - -A continuación, encontrará un ejemplo de petición. - -``` -curl -XPOST https://read:XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX@opentsdb.gra1-ovh.metrics.ovh.net/api/query --d '{ - "start":1564407950, - "queries":[ - { - "metric":"vscope.host.mem.usage.perc", - "aggregator":"sum", - "downsample":"20m-max-zero", - "tags": { - "datacenter":"pcc-37-187-228-180_datacenter869", - "host":"172.17.86.51" - } - } - ] -}' -``` - -Explicación de los diferentes campos utilizados: - -- read: usuario utilizado para efectuar la petición (siempre será read); -- XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX: token previamente obtenido mediante la APIv6; -- opentsdb.gra1-ovh.metrics.ovh.net: endpoint OpenTSDB, también obtenido mediante la APIv6. Este endpoint puede variar según su localización; -- start: marcas de tiempo que corresponden a la fecha de inicio de la petición; -- queries: tabla que contiene las métricas por obtener. Se pueden recuperar varias métricas en una sola petición; -- metric: nombre de la métrica por obtener; -- aggregator: nombre de la función de agregación (consultar la documentación OpenTSDB para más información); -- downsample: nombre de la función de muestreo (permite reducir el número de datos por recuperar. Parámetro optativo); -- tags: lista de labels (etiquetas) en forma de llave / valor; - -También pueden suministrarse otros parámetros. Por favor, consulte la documentación de la API OpenTSDB para más información. - -A su vez, recibirá un JSON con el resumen de la petición, como también las marcas de tiempo asociadas a su valor en el campo**dps**. -Ejemplo: - -```json -[ - { - "metric":"vscope.host.mem.usage.perc", - "tags":{ - "datacenter":"pcc-37-187-228-180_datacenter869", - "env":"prod", - "host":"172.17.86.51", - "servicename":"pcc-37-187-228-180", - "servicetype":"vscope" - }, - "query":{ - "index":0 - }, - "aggregateTags":[], - "dps":{ - "1564409391":4.38, - "1564410591":4.35, - "1564411791":4.37, - "1564412991":4.38, - "1564414191":4.35, - "1564415391":4.38, - "1564416591":4.35, - "1564417791":4.36, - "1564418991":4.36, - "1564420191":4.37, - "1564421391":4.37, - "1564422591":4.37, - "1564423791":4.37, - "1564424991":4.38, - "1564426191":4.36, - "1564427391":4.35, - "1564428591":4.37, - "1564429791":4.36, - "1564430991":4.38, - "1564432191":4.35, - "1564433391":4.37, - "1564434591":4.36, - "1564435791":4.37, - "1564436991":4.37, - "1564438191":4.37, - "1564439391":4.38, - "1564440591":4.36, - "1564441791":4.36, - "1564442991":4.37, - "1564444191":4.37, - "1564445391":4.35, - "1564446591":4.36, - "1564447791":4.36, - "1564448991":4.36, - "1564450191":4.35, - "1564451391":4.37, - "1564452591":4.37, - "1564453791":4.35, - "1564454991":4.36, - "1564456191":4.37, - "1564457391":4.37, - "1564458591":4.36, - "1564459791":4.37, - "1564460991":4.34, - "1564462191":4.36, - "1564463391":4.34, - "1564464591":4.37, - "1564465791":4.34, - "1564466991":4.37, - "1564468191":4.34, - "1564469391":4.36, - "1564470591":4.36, - "1564471791":4.36, - "1564472991":4.37, - "1564474191":4.37, - "1564475391":4.36, - "1564476591":4.35, - "1564477791":4.36, - "1564478991":4.35, - "1564480191":4.35, - "1564481391":4.37, - "1564482591":4.36, - "1564483791":4.34, - "1564484991":4.37, - "1564486191":4.38, - "1564487391":4.35, - "1564488591":4.34, - "1564489791":4.36, - "1564490991":4.35, - "1564492191":4.36, - "1564493391":4.36, - "1564494591":4.36 - } - } -] -``` - -Para más información sobre las peticiones OpenTSDB, consulte la siguiente documentación: [OpenTSDB api query](http://opentsdb.net/docs/build/html/api_http/query/index.html) - -## Más información - -Interactúe con nuestra comunidad de usuarios en . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/guide.es-us.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/guide.es-us.md deleted file mode 100644 index e66f3329e86..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/guide.es-us.md +++ /dev/null @@ -1,266 +0,0 @@ ---- -title: 'Cómo utilizar la API de vScope' -excerpt: 'Con la API vScope podrá utilizar los datos de monitorización en sus aplicaciones' -updated: 2020-06-29 ---- - -## Objetivo - -OVHcloud pone a su disposición una herramienta de supervisión y monitorización de sus máquinas virtuales y de su infraestructura llamada **vScope**. - -Se trata de una página web en la que se recopila toda la información necesaria sobre el uso de sus recursos. - -Esta información también se encuentra disponible en la APIv6 y la API Metrics. - -**Esta guía explica cómo utilizar estas API**. - -## Requisitos - -- Tener [una infraestructura Hosted Private Cloud](https://www.ovhcloud.com/es/enterprise/products/hosted-private-cloud/). -- Estar conectado a la interfaz vScope. - -## Procedimiento - -La herramienta vScope proporciona dos tipos de información: - -- Información **live**, que corresponde a los datos de los diferentes componentes en un momento determinado. -- Gráficos que presentan los datos históricos de rendimiento de los diferentes componentes como, por ejemplo, la CPU y la RAM de una máquina virtual. - -### Recopilar los datos **live** - -Los datos **live** son aquellos que se encuentran disponibles en la página principal de la interfaz vScope. - -![vScope-API](images/vScope1.png){.thumbnail} - -Podrá obtener los datos **live** para los siguientes componentes: - -- filers; -- hosts; -- máquinas virtuales. - -El uso de la API se realiza a través de estas tres llamadas APIv6: - -#### Filers - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/filer/{filerId} -> - -#### Hosts - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host/{hostId} -> - -#### Máquina virtual - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/vm/{vmId} -> - -### Recopilar los datos históricos (Graphs) - -Para recopilar y utilizar los datos históricos (Graphs), puede utilizar la solución **Metrics Data Platform**. - -Mediante el protocolo Opentsdb o WARP10, podrá obtener sus datos en forma de puntos. Asimismo, podrá utilizarlos a través de su aplicación o verlos directamente según el renderizado deseado. - -En esta guía explicaremos el uso del protocolo Opentsdb para obtener una visualización de datos en bruto (sin renderizado gráfico). - -Para poder utilizar **Metrics Data Platform**, necesitará un token de lectura. Con la nueva versión del vScope, cada usuario de la infraestructura dispone de un token de lectura. - -Para el usuario deseado, utilice la siguiente llamada a la APIv6 y obtenga el token de lectura: - -> [!api] -> -> @api {v1} /dedicatedCloud POST /dedicatedCloud/{serviceName}/user/{userId}/metricsToken -> - -Su token se encuentra en el campo **token** del resultado. - -```json -{ - "warpEndpoint": "https://warp10.gra1-ovh.metrics.ovh.net", - "token": "XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX", - "opentsdbEndpoint": "https://opentsdb.gra1-ovh.metrics.ovh.net" -} -``` - -Para cada tipo de componente, existe una lista de métricas y necesita un número muy preciso de parámetros (también llamados labels). - -#### Filers - -| Métricas | Descripción | Labels | -| ----------- | ----------- | ----------- | -| vscope.filer.datastore.diskspace.used | Uso del filer en kB | datacenter: pcc-37-187-228-180_datacenter869,
datastore: pcc-000443 | - -#### Hosts - -| Métricas | Descripción | Labels | -| ----------- | ----------- | ----------- | -| vscope.host.cpu.usage.perc | Uso del procesador del host en porcentaje | \- datacenter: pcc-37-187-228-180_datacenter869,
\- host: 172.17.86.51 | -| vscope.host.mem.usage.perc | Uso de la memoria del host en porcentaje | \- datacenter: pcc-37-187-228-180_datacenter869,
\- host: 172.17.86.51 | -| vscope.host.net.tx | Uso de la red del host de emisión | \- datacenter: pcc-37-187-228-180_datacenter869,
\- host: 172.17.86.51
\- nicname: vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.rx | Uso de la red del host de recepción | \- datacenter: pcc-37-187-228-180_datacenter869,
\- host: 172.17.86.51
\- nicname: vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetstx | Número de paquetes de red transmitidos por el host | \- datacenter: pcc-37-187-228-180_datacenter869,
\- host: 172.17.86.51
\- nicname: vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetsrx | Número de paquetes de red recibidos por el host | \- datacenter: pcc-37-187-228-180_datacenter869,
\- host: 172.17.86.51
\- nicname: vmnic0/vmnic1/vmnic2/vmnic3 | - -#### Máquinas virtuales - -| Métricas | Descripción | Labels | -| ----------- | ----------- | ----------- | -| vscope.vm.cpu.usage.perc | Uso del procesador de la MV en porcentaje | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.mem.usage.perc | Uso de la memoria de la MV en porcentaje | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.cpu.ready |CPU Ready de la MV en milisegundos | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.net.rx | Uso de la red de la MV de recepción | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.net.tx | Uso de la red de la MV de transmisión | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.net.packetsrx | Número de paquetes de red recibidos por la MV | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.net.packetstx | Número de paquetes de red transmitidos por la MV | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.disk.io.read | Número de IO en lectura por segundo de la MV | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.disk.io.write | Número de IO en escritura por segundo de la MV | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.disk.bandwidth.read | Ancho de banda del disco de la MV en modo lectura | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.disk.bandwidth.write | Ancho de banda del disco de la MV en modo escritura | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.disk.latency.read | Latencia del disco de la MV en modo lectura | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.disk.latency.write | Latencia del disco de la MV en modo escritura | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | - -#### Ejemplo de recopilación con el protocolo OpenTSDB - -Una vez que obtuvo su token, su endpoint y su lista de métricas, recuperará los datos de uso de memoria de un host en un día. - -A continuación, encontrará un ejemplo de petición. - -``` -curl -XPOST https://read:XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX@opentsdb.gra1-ovh.metrics.ovh.net/api/query --d '{ - "start":1564407950, - "queries":[ - { - "metric":"vscope.host.mem.usage.perc", - "aggregator":"sum", - "downsample":"20m-max-zero", - "tags": { - "datacenter":"pcc-37-187-228-180_datacenter869", - "host":"172.17.86.51" - } - } - ] -}' -``` - -Explicación de los diferentes campos utilizados: - -- read: usuario utilizado para efectuar la petición (siempre será read); -- XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX: token previamente obtenido mediante la APIv6; -- opentsdb.gra1-ovh.metrics.ovh.net: endpoint OpenTSDB, también obtenido mediante la APIv6. Este endpoint puede variar según su localización; -- start: marcas de tiempo que corresponden a la fecha de inicio de la petición; -- queries: tabla que contiene las métricas por obtener. Se pueden recuperar varias métricas en una sola petición; -- metric: nombre de la métrica por obtener; -- aggregator: nombre de la función de agregación (consultar la documentación OpenTSDB para más información); -- downsample: nombre de la función de muestreo (permite reducir el número de datos por recuperar. Parámetro optativo); -- tags: lista de labels (etiquetas) en forma de llave / valor; - -También pueden suministrarse otros parámetros. Por favor, consulte la documentación de la API OpenTSDB para más información. - -A su vez, recibirá un JSON con el resumen de la petición, como también las marcas de tiempo asociadas a su valor en el campo**dps**. -Ejemplo: - -```json -[ - { - "metric":"vscope.host.mem.usage.perc", - "tags":{ - "datacenter":"pcc-37-187-228-180_datacenter869", - "env":"prod", - "host":"172.17.86.51", - "servicename":"pcc-37-187-228-180", - "servicetype":"vscope" - }, - "query":{ - "index":0 - }, - "aggregateTags":[], - "dps":{ - "1564409391":4.38, - "1564410591":4.35, - "1564411791":4.37, - "1564412991":4.38, - "1564414191":4.35, - "1564415391":4.38, - "1564416591":4.35, - "1564417791":4.36, - "1564418991":4.36, - "1564420191":4.37, - "1564421391":4.37, - "1564422591":4.37, - "1564423791":4.37, - "1564424991":4.38, - "1564426191":4.36, - "1564427391":4.35, - "1564428591":4.37, - "1564429791":4.36, - "1564430991":4.38, - "1564432191":4.35, - "1564433391":4.37, - "1564434591":4.36, - "1564435791":4.37, - "1564436991":4.37, - "1564438191":4.37, - "1564439391":4.38, - "1564440591":4.36, - "1564441791":4.36, - "1564442991":4.37, - "1564444191":4.37, - "1564445391":4.35, - "1564446591":4.36, - "1564447791":4.36, - "1564448991":4.36, - "1564450191":4.35, - "1564451391":4.37, - "1564452591":4.37, - "1564453791":4.35, - "1564454991":4.36, - "1564456191":4.37, - "1564457391":4.37, - "1564458591":4.36, - "1564459791":4.37, - "1564460991":4.34, - "1564462191":4.36, - "1564463391":4.34, - "1564464591":4.37, - "1564465791":4.34, - "1564466991":4.37, - "1564468191":4.34, - "1564469391":4.36, - "1564470591":4.36, - "1564471791":4.36, - "1564472991":4.37, - "1564474191":4.37, - "1564475391":4.36, - "1564476591":4.35, - "1564477791":4.36, - "1564478991":4.35, - "1564480191":4.35, - "1564481391":4.37, - "1564482591":4.36, - "1564483791":4.34, - "1564484991":4.37, - "1564486191":4.38, - "1564487391":4.35, - "1564488591":4.34, - "1564489791":4.36, - "1564490991":4.35, - "1564492191":4.36, - "1564493391":4.36, - "1564494591":4.36 - } - } -] -``` - -Para más información sobre las peticiones OpenTSDB, consulte la siguiente documentación: [OpenTSDB api query](http://opentsdb.net/docs/build/html/api_http/query/index.html) - -## Más información - -Interactúe con nuestra comunidad de usuarios en . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/guide.fr-ca.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/guide.fr-ca.md deleted file mode 100644 index 4d15b667c01..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/guide.fr-ca.md +++ /dev/null @@ -1,266 +0,0 @@ ---- -title: 'Comment utiliser l’API de vScope' -excerpt: 'L’API vScope vous permet d’utiliser les données de monitoring dans vos applications' -updated: 2020-06-29 ---- - -## Objectif - -OVHcloud vous met à disposition un outil de supervision et de monitoring de vos machines virtuelles et de votre infrastructure qui se nomme **vScope**. - -Il s’agit d’une page web où sont rassemblées toutes les informations utiles concernant l'usage de vos ressources. - -Ces informations sont également disponibles via l'APIv6 et l'API Metrics. - -**Ce guide décrit l'utilisation de ces APIs**. - -## Prérequis - -- une [infrastructure Hosted Private Cloud](https://www.ovhcloud.com/fr-ca/enterprise/products/hosted-private-cloud/) -- être connecté à l'interface de gestion vScope - -## En pratique - -L'outil vScope met à disposition deux types d'informations : - -- des informations **live**, qui correspondent aux données des différents composants à un instant T. -- des graphiques présentant les données historiques de performance des différents composants. Par exemple : CPU, RAM d'une machine virtuelle. - -### Collecter les données **live** - -Les données **live** sont les données disponibles depuis la page principale de l'interface vScope. - -![vScope-API](images/vScope1.png){.thumbnail} - -Vous pourrez récupérer ces données **live** pour les composants suivants : - -- filers -- hosts -- virtual machines - -L'utilisation de l'API se fait via ces trois appels APIv6 : - -#### Filers - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/filer/{filerId} -> - -#### Hosts - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host/{hostId} -> - -#### Machine virtuelles - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/vm/{vmId} -> - -### Collecter les données historiques (Graphs) - -Pour collecter et utiliser les données historiques (Graphs), nous utilisons le produit **Metrics Data Platforms**. - -Via les protocoles Opentsdb ou WARP10, vous allez pouvoir récupérer vos données sous forme de points. Vous pourrez exploiter ces points via votre application ou directement les afficher selon le rendu souhaité. - -Cet article couvrira l'utilisation du protocole Opentsdb pour un affichage brut des données (pas de rendu graphique). - -Pour pouvoir utiliser **Metrics Data Platforms**, vous aurez besoin d'obtenir un token de lecture. Avec la nouvelle version du vScope, chaque utilisateur de l'infrastructure possède un token de lecture. - -Pour l'utilisateur souhaité, utilisez l'appel APIv6 suivant pour récupérer le token de lecture : - -> [!api] -> -> @api {v1} /dedicatedCloud POST /dedicatedCloud/{serviceName}/user/{userId}/metricsToken -> - -Votre token se trouve dans le champ **token** du résultat. - -```json -{ - "warpEndpoint": "https://warp10.gra1-ovh.metrics.ovh.net", - "token": "XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX", - "opentsdbEndpoint": "https://opentsdb.gra1-ovh.metrics.ovh.net" -} -``` - -Pour chaque type de composant, une liste de métriques est disponible et nécessite un nombre de paramètres (aussi appelé labels) très précis. - -#### Filers - -| Métriques | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.filer.datastore.diskspace.used | Utilisation du filer en kB | datacenter : pcc-37-187-228-180\_datacenter869,
datastore : pcc-000443 | - -#### Hosts - -| Métriques | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.host.cpu.usage.perc | Utilisation processeur du host en pourcent | - datacenter : pcc-37-187-228-180\_datacenter869,
- host : 172.17.86.51 | -| vscope.host.mem.usage.perc | Utilisation mémoire du host en pourcent | - datacenter : pcc-37-187-228-180\_datacenter869,
- host : 172.17.86.51 | -| vscope.host.net.tx | Utilisation réseau du host en émission | - datacenter : pcc-37-187-228-180\_datacenter869,
- host : 172.17.86.51
- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.rx | Utilisation réseau du host en réception | - datacenter : pcc-37-187-228-180\_datacenter869,
- host : 172.17.86.51
- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetstx | Nombre de packets réseau transmis du host | - datacenter : pcc-37-187-228-180\_datacenter869,
- host : 172.17.86.51
- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetsrx | Nombre de packets réseau reçus du host | - datacenter : pcc-37-187-228-180\_datacenter869,
- host : 172.17.86.51
- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | - -#### Machine Virtuelles - -| Métriques | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.vm.cpu.usage.perc | Utilisation processeur de la vm en pourcent | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | -| vscope.vm.mem.usage.perc | Utilisation mémoire de la vm en pourcent | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | -| vscope.vm.cpu.ready |CPU Ready de la vm en millisecond | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | -| vscope.vm.net.rx | Utilisation réseau de la vm en réception | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | -| vscope.vm.net.tx | Utilisation réseau de la vm en transmission | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | -| vscope.vm.net.packetsrx | Nombre de packets réseau reçus de la vm | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | -| vscope.vm.net.packetstx | Nombre de packets réseau transmis de la vm | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | -| vscope.vm.disk.io.read | Nombre d'IO en lecture par seconde de la vm | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | -| vscope.vm.disk.io.write | Nombre d'IO en écriture par seconde de la vm | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | -| vscope.vm.disk.bandwidth.read | Bande passante du disk de la vm en lecture | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | -| vscope.vm.disk.bandwidth.write | Bande passante du disk de la vm en écriture | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | -| vscope.vm.disk.latency.read | Latence du disque de la vm en lecture | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | -| vscope.vm.disk.latency.write | Latence du disque de la vm en écriture | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | - -#### Exemple de collecte en utilisant le protocol OpenTSDB - -Maintenant que vous avez récupéré votre token, votre endpoint, et que vous avez la liste des métriques, vous allez récupérer les données d'utilisation mémoire d'un host sur une période de 1 jour. - -Veuillez trouver ci-dessous un exemple de requête. - -``` -curl -XPOST https://read:XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX@opentsdb.gra1-ovh.metrics.ovh.net/api/query --d '{ - "start":1564407950, - "queries":[ - { - "metric":"vscope.host.mem.usage.perc", - "aggregator":"sum", - "downsample":"20m-max-zero", - "tags": { - "datacenter":"pcc-37-187-228-180_datacenter869", - "host":"172.17.86.51" - } - } - ] -}' -``` - -Explication des différents champs utilisés : - -- read : user utilisé pour effectuer la requête (sera toujours read); -- XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX : token précédemment récupéré via l'APIv6; -- opentsdb.gra1-ovh.metrics.ovh.net : endpoint OpenTSDB, également récupéré via l'APIv6. Ce endpoint peut varier selon votre localisation; -- start : timestamp correspondant à la date de début de la requête; -- queries : tableau contenant les metriques à récupérer. Plusieurs métriques peuvent être récupérées en une seule requête; -- metric : nom de la métrique à récupérer; -- aggregator : nom de la fonction d'agrégation (se reporter à la documentation OpenTSDB pour plus de détails); -- downsample : nom de la fonction d'échantillonnage (permet de réduire le nombre de donnée à récupérer. Paramètre optionnel); -- tags : liste des labels sous la forme clé / valeur; - -D'autres paramètres peuvent également être fournis. Veuillez vous reporter à la documentation de l'api OpenTSDB pour plus de détails. - -Vous aurez alors en retour un json avec le récapitulatif de la requête, ainsi que les timestamps associés à leur valeur dans le champ **dps**. -Exemple : - -```json -[ - { - "metric":"vscope.host.mem.usage.perc", - "tags":{ - "datacenter":"pcc-37-187-228-180_datacenter869", - "env":"prod", - "host":"172.17.86.51", - "servicename":"pcc-37-187-228-180", - "servicetype":"vscope" - }, - "query":{ - "index":0 - }, - "aggregateTags":[], - "dps":{ - "1564409391":4.38, - "1564410591":4.35, - "1564411791":4.37, - "1564412991":4.38, - "1564414191":4.35, - "1564415391":4.38, - "1564416591":4.35, - "1564417791":4.36, - "1564418991":4.36, - "1564420191":4.37, - "1564421391":4.37, - "1564422591":4.37, - "1564423791":4.37, - "1564424991":4.38, - "1564426191":4.36, - "1564427391":4.35, - "1564428591":4.37, - "1564429791":4.36, - "1564430991":4.38, - "1564432191":4.35, - "1564433391":4.37, - "1564434591":4.36, - "1564435791":4.37, - "1564436991":4.37, - "1564438191":4.37, - "1564439391":4.38, - "1564440591":4.36, - "1564441791":4.36, - "1564442991":4.37, - "1564444191":4.37, - "1564445391":4.35, - "1564446591":4.36, - "1564447791":4.36, - "1564448991":4.36, - "1564450191":4.35, - "1564451391":4.37, - "1564452591":4.37, - "1564453791":4.35, - "1564454991":4.36, - "1564456191":4.37, - "1564457391":4.37, - "1564458591":4.36, - "1564459791":4.37, - "1564460991":4.34, - "1564462191":4.36, - "1564463391":4.34, - "1564464591":4.37, - "1564465791":4.34, - "1564466991":4.37, - "1564468191":4.34, - "1564469391":4.36, - "1564470591":4.36, - "1564471791":4.36, - "1564472991":4.37, - "1564474191":4.37, - "1564475391":4.36, - "1564476591":4.35, - "1564477791":4.36, - "1564478991":4.35, - "1564480191":4.35, - "1564481391":4.37, - "1564482591":4.36, - "1564483791":4.34, - "1564484991":4.37, - "1564486191":4.38, - "1564487391":4.35, - "1564488591":4.34, - "1564489791":4.36, - "1564490991":4.35, - "1564492191":4.36, - "1564493391":4.36, - "1564494591":4.36 - } - } -] -``` - -Pour plus de détails sur les requêtes OpenTSDB, vous pouvez vous reporter à la documentation suivante : [OpenTSDB api query](http://opentsdb.net/docs/build/html/api_http/query/index.html) - -## Aller plus loin - -Échangez avec notre [communauté d'utilisateurs](/links/community). diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/guide.fr-fr.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/guide.fr-fr.md deleted file mode 100644 index 40d5d221606..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/guide.fr-fr.md +++ /dev/null @@ -1,266 +0,0 @@ ---- -title: 'Comment utiliser l’API de vScope' -excerpt: 'L’API vScope vous permet d’utiliser les données de monitoring dans vos applications' -updated: 2020-06-29 ---- - -## Objectif - -OVHcloud vous met à disposition un outil de supervision et de monitoring de vos machines virtuelles et de votre infrastructure qui se nomme **vScope**. - -Il s’agit d’une page web où sont rassemblées toutes les informations utiles concernant l'usage de vos ressources. - -Ces informations sont également disponibles via l'APIv6 et l'API Metrics. - -**Ce guide décrit l'utilisation de ces APIs**. - -## Prérequis - -- une [infrastructure Hosted Private Cloud](https://www.ovhcloud.com/fr/enterprise/products/hosted-private-cloud/) -- être connecté à l'interface de gestion vScope - -## En pratique - -L'outil vScope met à disposition deux types d'informations : - -- des informations **live**, qui correspondent aux données des différents composants à un instant T. -- des graphiques présentant les données historiques de performance des différents composants. Par exemple : CPU, RAM d'une machine virtuelle. - -### Collecter les données **live** - -Les données **live** sont les données disponibles depuis la page principale de l'interface vScope. - -![vScope-API](images/vScope1.png){.thumbnail} - -Vous pourrez récupérer ces données **live** pour les composants suivants : - -- filers -- hosts -- virtual machines - -L'utilisation de l'API se fait via ces trois appels APIv6 : - -#### Filers - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/filer/{filerId} -> - -#### Hosts - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host/{hostId} -> - -#### Machine virtuelles - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/vm/{vmId} -> - -### Collecter les données historiques (Graphs) - -Pour collecter et utiliser les données historiques (Graphs), nous utilisons le produit **Metrics Data Platforms**. - -Via les protocoles Opentsdb ou WARP10, vous allez pouvoir récupérer vos données sous forme de points. Vous pourrez exploiter ces points via votre application ou directement les afficher selon le rendu souhaité. - -Cet article couvrira l'utilisation du protocole Opentsdb pour un affichage brut des données (pas de rendu graphique). - -Pour pouvoir utiliser **Metrics Data Platforms**, vous aurez besoin d'obtenir un token de lecture. Avec la nouvelle version du vScope, chaque utilisateur de l'infrastructure possède un token de lecture. - -Pour l'utilisateur souhaité, utilisez l'appel APIv6 suivant pour récupérer le token de lecture : - -> [!api] -> -> @api {v1} /dedicatedCloud POST /dedicatedCloud/{serviceName}/user/{userId}/metricsToken -> - -Votre token se trouve dans le champ **token** du résultat. - -```json -{ - "warpEndpoint": "https://warp10.gra1-ovh.metrics.ovh.net", - "token": "XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX", - "opentsdbEndpoint": "https://opentsdb.gra1-ovh.metrics.ovh.net" -} -``` - -Pour chaque type de composant, une liste de métriques est disponible et nécessite un nombre de paramètres (aussi appelé labels) très précis. - -#### Filers - -| Métriques | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.filer.datastore.diskspace.used | Utilisation du filer en kB | datacenter : pcc-37-187-228-180\_datacenter869,
datastore : pcc-000443 | - -#### Hosts - -| Métriques | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.host.cpu.usage.perc | Utilisation processeur du host en pourcent | - datacenter : pcc-37-187-228-180\_datacenter869,
- host : 172.17.86.51 | -| vscope.host.mem.usage.perc | Utilisation mémoire du host en pourcent | - datacenter : pcc-37-187-228-180\_datacenter869,
- host : 172.17.86.51 | -| vscope.host.net.tx | Utilisation réseau du host en émission | - datacenter : pcc-37-187-228-180\_datacenter869,
- host : 172.17.86.51
- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.rx | Utilisation réseau du host en réception | - datacenter : pcc-37-187-228-180\_datacenter869,
- host : 172.17.86.51
- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetstx | Nombre de packets réseau transmis du host | - datacenter : pcc-37-187-228-180\_datacenter869,
- host : 172.17.86.51
- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetsrx | Nombre de packets réseau reçus du host | - datacenter : pcc-37-187-228-180\_datacenter869,
- host : 172.17.86.51
- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | - -#### Machine Virtuelles - -| Métriques | Description | Labels | -| ----------- | ----------- | ----------- | -| vscope.vm.cpu.usage.perc | Utilisation processeur de la vm en pourcent | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | -| vscope.vm.mem.usage.perc | Utilisation mémoire de la vm en pourcent | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | -| vscope.vm.cpu.ready |CPU Ready de la vm en millisecond | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | -| vscope.vm.net.rx | Utilisation réseau de la vm en réception | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | -| vscope.vm.net.tx | Utilisation réseau de la vm en transmission | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | -| vscope.vm.net.packetsrx | Nombre de packets réseau reçus de la vm | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | -| vscope.vm.net.packetstx | Nombre de packets réseau transmis de la vm | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | -| vscope.vm.disk.io.read | Nombre d'IO en lecture par seconde de la vm | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | -| vscope.vm.disk.io.write | Nombre d'IO en écriture par seconde de la vm | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | -| vscope.vm.disk.bandwidth.read | Bande passante du disk de la vm en lecture | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | -| vscope.vm.disk.bandwidth.write | Bande passante du disk de la vm en écriture | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | -| vscope.vm.disk.latency.read | Latence du disque de la vm en lecture | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | -| vscope.vm.disk.latency.write | Latence du disque de la vm en écriture | - datacenter : pcc-37-187-228-180\_datacenter869,
- vm : vm-01254 | - -#### Exemple de collecte en utilisant le protocol OpenTSDB - -Maintenant que vous avez récupéré votre token, votre endpoint, et que vous avez la liste des métriques, vous allez récupérer les données d'utilisation mémoire d'un host sur une période de 1 jour. - -Veuillez trouver ci-dessous un exemple de requête. - -``` -curl -XPOST https://read:XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX@opentsdb.gra1-ovh.metrics.ovh.net/api/query --d '{ - "start":1564407950, - "queries":[ - { - "metric":"vscope.host.mem.usage.perc", - "aggregator":"sum", - "downsample":"20m-max-zero", - "tags": { - "datacenter":"pcc-37-187-228-180_datacenter869", - "host":"172.17.86.51" - } - } - ] -}' -``` - -Explication des différents champs utilisés : - -- read : user utilisé pour effectuer la requête (sera toujours read); -- XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX : token précédemment récupéré via l'APIv6; -- opentsdb.gra1-ovh.metrics.ovh.net : endpoint OpenTSDB, également récupéré via l'APIv6. Ce endpoint peut varier selon votre localisation; -- start : timestamp correspondant à la date de début de la requête; -- queries : tableau contenant les metriques à récupérer. Plusieurs métriques peuvent être récupérées en une seule requête; -- metric : nom de la métrique à récupérer; -- aggregator : nom de la fonction d'agrégation (se reporter à la documentation OpenTSDB pour plus de détails); -- downsample : nom de la fonction d'échantillonnage (permet de réduire le nombre de donnée à récupérer. Paramètre optionnel); -- tags : liste des labels sous la forme clé / valeur; - -D'autres paramètres peuvent également être fournis. Veuillez vous reporter à la documentation de l'api OpenTSDB pour plus de détails. - -Vous aurez alors en retour un json avec le récapitulatif de la requête, ainsi que les timestamps associés à leur valeur dans le champ **dps**. -Exemple : - -```json -[ - { - "metric":"vscope.host.mem.usage.perc", - "tags":{ - "datacenter":"pcc-37-187-228-180_datacenter869", - "env":"prod", - "host":"172.17.86.51", - "servicename":"pcc-37-187-228-180", - "servicetype":"vscope" - }, - "query":{ - "index":0 - }, - "aggregateTags":[], - "dps":{ - "1564409391":4.38, - "1564410591":4.35, - "1564411791":4.37, - "1564412991":4.38, - "1564414191":4.35, - "1564415391":4.38, - "1564416591":4.35, - "1564417791":4.36, - "1564418991":4.36, - "1564420191":4.37, - "1564421391":4.37, - "1564422591":4.37, - "1564423791":4.37, - "1564424991":4.38, - "1564426191":4.36, - "1564427391":4.35, - "1564428591":4.37, - "1564429791":4.36, - "1564430991":4.38, - "1564432191":4.35, - "1564433391":4.37, - "1564434591":4.36, - "1564435791":4.37, - "1564436991":4.37, - "1564438191":4.37, - "1564439391":4.38, - "1564440591":4.36, - "1564441791":4.36, - "1564442991":4.37, - "1564444191":4.37, - "1564445391":4.35, - "1564446591":4.36, - "1564447791":4.36, - "1564448991":4.36, - "1564450191":4.35, - "1564451391":4.37, - "1564452591":4.37, - "1564453791":4.35, - "1564454991":4.36, - "1564456191":4.37, - "1564457391":4.37, - "1564458591":4.36, - "1564459791":4.37, - "1564460991":4.34, - "1564462191":4.36, - "1564463391":4.34, - "1564464591":4.37, - "1564465791":4.34, - "1564466991":4.37, - "1564468191":4.34, - "1564469391":4.36, - "1564470591":4.36, - "1564471791":4.36, - "1564472991":4.37, - "1564474191":4.37, - "1564475391":4.36, - "1564476591":4.35, - "1564477791":4.36, - "1564478991":4.35, - "1564480191":4.35, - "1564481391":4.37, - "1564482591":4.36, - "1564483791":4.34, - "1564484991":4.37, - "1564486191":4.38, - "1564487391":4.35, - "1564488591":4.34, - "1564489791":4.36, - "1564490991":4.35, - "1564492191":4.36, - "1564493391":4.36, - "1564494591":4.36 - } - } -] -``` - -Pour plus de détails sur les requêtes OpenTSDB, vous pouvez vous reporter à la documentation suivante : [OpenTSDB api query](http://opentsdb.net/docs/build/html/api_http/query/index.html) - -## Aller plus loin - -Échangez avec notre [communauté d'utilisateurs](/links/community). diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/guide.it-it.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/guide.it-it.md deleted file mode 100644 index a4926cb8387..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/guide.it-it.md +++ /dev/null @@ -1,263 +0,0 @@ ---- -title: Utilizzare l’API di vScope -excerpt: 'Come utilizzare i dati di monitoraggio nelle tue applicazioni tramite l’API vScope' -updated: 2020-06-29 ---- - -## Obiettivo - -Per ogni servizio Private Cloud, OVHcloud mette a disposizione il tool **vScope**, uno strumento di monitoraggio per macchine virtuali e infrastrutture. - -È una pagina Web che contiene tutte le informazioni utili relative alle proprie risorse, disponibili anche via APIv6 e API Metrics. - -**Questa guida ti mostra come recuperare i valori monitorati via API.** - -## Prerequisiti - -- Un’[infrastruttura Hosted Private Cloud](https://www.ovhcloud.com/it/enterprise/products/hosted-private-cloud/) -- Essere connesso all’interfaccia di gestione vScope - -## Procedura - -vScope mette a disposizione due tipi di informazioni: - -- **dati live**, relativi allo stato dei diversi componenti in un istante T -- grafici, che rappresentano lo storico delle prestazioni dei diversi componenti (ad esempio, CPU e RAM di una macchina virtuale) - -### Raccogli i dati live - -I dati live sono disponibili nella pagina principale dell’interfaccia vScope. - -![vScope-API](images/vScope1.png){.thumbnail} - -Queste informazioni sono relative ai seguenti componenti: - -- filer -- host -- macchine virtuali - -Per recuperarle tramite APIv6 è necessario eseguire queste tre chiamate: - -#### Filer - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/filer/{filerId} -> - -#### Host - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host/{hostId} -> - -#### Macchine virtuali - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/vm/{vmId} -> - -### Ottieni lo storico dei dati (Graphs) - -Per effettuare questa operazione è possibile utilizzare il servizio **Metrics Data Platforms**: grazie ai protocolli Opentsdb e WARP10 i dati possono essere recuperati sotto forma di punti utilizzabili tramite applicazione o visualizzabili direttamente con il rendering desiderato. - -La procedura descritta in questa guida è relativa all’utilizzo del protocollo Opentsdb per la visualizzazione grezza dei dati acquisiti, senza rappresentazione grafica. - -Per accedere al servizio **Metrics Data Platforms** è necessario disporre di un token di lettura: la nuova versione di vScope, infatti, ne prevede uno per ogni utilizzatore dell’infrastruttura. - -Per recuperare il codice di un utente specifico, effettua questa chiamata APIv6: - -> [!api] -> -> @api {v1} /dedicatedCloud POST /dedicatedCloud/{serviceName}/user/{userId}/metricsToken -> - -L’informazione richiesta viene mostrata nel campo **token** del risultato. - -```json -{ - "warpEndpoint": "https://warp10.gra1-ovh.metrics.ovh.net", - "token": "XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX", - "opentsdbEndpoint": "https://opentsdb.gra1-ovh.metrics.ovh.net" -} -``` - -Per ogni tipo di componente è disponibile una lista di metriche, che richiede un numero di parametri (detti label) molto preciso. - -#### Filer - -| Metriche | Descrizione | Label | -| ----------- | ----------- | ----------- | -| vscope.filer.datastore.diskspace.used | Utilizzo del filer in kB | datacenter: pcc-37-187-228-180_datacenter869,
datastore: pcc-000443 | - -#### Host - -| Metriche | Descrizione | Label | -| ----------- | ----------- | ----------- | -| vscope.host.cpu.usage.perc | Percentuale di utilizzo del processore dell’host | \- datacenter: pcc-37-187-228-180_datacenter869,
\- host: 172.17.86.51 | -| vscope.host.mem.usage.perc | Percentuale di utilizzo della memoria dell’host | \- datacenter: pcc-37-187-228-180_datacenter869,
\- host: 172.17.86.51 | -| vscope.host.net.tx | Utilizzo della rete dell’host in uscita | \- datacenter: pcc-37-187-228-180_datacenter869,
\- host: 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.rx | Utilizzo della rete dell’host in entrata | \- datacenter: pcc-37-187-228-180_datacenter869,
\- host: 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetstx | Numero di pacchetti di rete trasmessi dall’host | \- datacenter: pcc-37-187-228-180_datacenter869,
\- host: 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetsrx | Numero di pacchetti di rete ricevuti dall’host | \- datacenter: pcc-37-187-228-180_datacenter869,
\- host: 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | - -#### Macchine Virtuali - -| Metriche | Descrizione | Label | -| ----------- | ----------- | ----------- | -| vscope.vm.cpu.usage.perc | Percentuale di utilizzo del processore della VM | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.mem.usage.perc | Percentuale di utilizzo della memoria dell’host | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.cpu.ready |CPU Ready della VM in millisecondi | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.net.rx | Utilizzo della rete della VM in ricezione | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.net.tx | Utilizzo della rete della VM in trasmissione | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.net.packetsrx | Numero di pacchetti di rete ricevuti dalla VM | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.net.packetstx | Numero di pacchetti di rete trasmessi dalla VM | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.disk.io.read | Numero di IOPS della VM in lettura | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.disk.io.write | Numero di IOPS della VM in scrittura | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.disk.bandwidth.read | Banda passante del disco della VM in lettura | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.disk.bandwidth.write | Banda passante del disco della VM in scrittura | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.disk.latency.read | Latenza del disco della VM in lettura | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.disk.latency.write | Latenza del disco della VM in scrittura | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | - -#### Esempio di raccolta con il protocollo OpenTSDB - -Una volta recuperati il token, l’endpoint e la lista delle metriche è possibile estrarre, ad esempio, i dati relativi all’utilizzo della memoria di un host su base giornaliera. - -La richiesta sarà di questo tipo: - -``` -curl -XPOST https://read:XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX@opentsdb.gra1-ovh.metrics.ovh.net/api/query --d '{ - "start":1564407950, - "queries":[ - { - "metric":"vscope.host.mem.usage.perc", - "aggregator":"sum", - "downsample":"20m-max-zero", - "tags": { - "datacenter":"pcc-37-187-228-180_datacenter869", - "host":"172.17.86.51" - } - } - ] -}' -``` - -Ecco la descrizione dei campi impiegati: - -- read: user utilizzato per effettuare la richiesta (sarà sempre “read”) -- XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX: token recuperato precedentemente via APIv6 -- opentsdb.gra1-ovh.metrics.ovh.net: endpoint OpenTSDB, anch’esso recuperato via APIv6. Questo endpoint può variare in base alla localizzazione. -- start: timestamp corrispondente alla data di inizio della richiesta -- queries: tabella con le metriche da recuperare (con una sola richiesta è possibile recuperare più metriche) -- metric: nome della metrica da recuperare -- aggregator: nome della fuzione di aggregazione (per maggiori dettagli, consulta la documentazione ufficiale OpenTSDB) -- downsample: nome della funzione di campionamento (parametro opzionale che permette di ridurre il numero di dati da recuperare) -- tags: lista dei label in formato chiave/valore - -Questa lista di parametri non è esaustiva e, oltre a quelli indicati, ne sono disponibili altri. Per maggiori informazioni, consulta la documentazione ufficiale dell’API OpenTSDB. - -Il risultato restituito sarà un file json con il riepilogo della richiesta e, nei campi **dps**, i timestamp associati ai diversi valori. -Esempio: - -```json -[ - { - "metric":"vscope.host.mem.usage.perc", - "tags":{ - "datacenter":"pcc-37-187-228-180_datacenter869", - "env":"prod", - "host":"172.17.86.51", - "servicename":"pcc-37-187-228-180", - "servicetype":"vscope" - }, - "query":{ - "index":0 - }, - "aggregateTags":[], - "dps":{ - "1564409391":4.38, - "1564410591":4.35, - "1564411791":4.37, - "1564412991":4.38, - "1564414191":4.35, - "1564415391":4.38, - "1564416591":4.35, - "1564417791":4.36, - "1564418991":4.36, - "1564420191":4.37, - "1564421391":4.37, - "1564422591":4.37, - "1564423791":4.37, - "1564424991":4.38, - "1564426191":4.36, - "1564427391":4.35, - "1564428591":4.37, - "1564429791":4.36, - "1564430991":4.38, - "1564432191":4.35, - "1564433391":4.37, - "1564434591":4.36, - "1564435791":4.37, - "1564436991":4.37, - "1564438191":4.37, - "1564439391":4.38, - "1564440591":4.36, - "1564441791":4.36, - "1564442991":4.37, - "1564444191":4.37, - "1564445391":4.35, - "1564446591":4.36, - "1564447791":4.36, - "1564448991":4.36, - "1564450191":4.35, - "1564451391":4.37, - "1564452591":4.37, - "1564453791":4.35, - "1564454991":4.36, - "1564456191":4.37, - "1564457391":4.37, - "1564458591":4.36, - "1564459791":4.37, - "1564460991":4.34, - "1564462191":4.36, - "1564463391":4.34, - "1564464591":4.37, - "1564465791":4.34, - "1564466991":4.37, - "1564468191":4.34, - "1564469391":4.36, - "1564470591":4.36, - "1564471791":4.36, - "1564472991":4.37, - "1564474191":4.37, - "1564475391":4.36, - "1564476591":4.35, - "1564477791":4.36, - "1564478991":4.35, - "1564480191":4.35, - "1564481391":4.37, - "1564482591":4.36, - "1564483791":4.34, - "1564484991":4.37, - "1564486191":4.38, - "1564487391":4.35, - "1564488591":4.34, - "1564489791":4.36, - "1564490991":4.35, - "1564492191":4.36, - "1564493391":4.36, - "1564494591":4.36 - } - } -] -``` - -Per maggiori informazioni sulle richieste OpenTSDB, consulta la documentazione disponibile alla pagina [OpenTSDB api query](http://opentsdb.net/docs/build/html/api_http/query/index.html) - -## Per saperne di più - -Contatta la nostra Community di utenti all’indirizzo . - diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/guide.pl-pl.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/guide.pl-pl.md deleted file mode 100644 index 6edca088647..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/guide.pl-pl.md +++ /dev/null @@ -1,266 +0,0 @@ ---- -title: 'Jak korzystać z API vScope' -excerpt: 'API vScope pozwala wykorzystywać dane z monitorowania zasobów w aplikacjach' -updated: 2020-06-29 ---- - -## Wprowadzenie - -OVHcloud udostępnia narzędzie **vScope** do nadzoru i monitorowania wirtualnych maszyn i infrastruktury. - -Jest to strona internetowa, na której zebrane są wszelkie użyteczne informacje dotyczące wykorzystania Twoich zasobów. - -Informacje te są dostępne także poprzez APIv6 i API Metrics. - -**Niniejszy przewodnik opisuje sposób korzystania z tych API**. - -## Wymagania początkowe - -- [Infrastructure Hosted Private Cloud](https://www.ovhcloud.com/pl/enterprise/products/hosted-private-cloud/) -- Dostęp do interfejsu zarządzania vScope - -## W praktyce - -vScope udostępnia dwa rodzaje informacji: - -- informacje**w czasie rzeczywistym**, które odpowiadają danym z różnych elementów w danej chwili. -- wykresy przedstawiające dane historyczne dotyczące wydajności poszczególnych elementów, Przykład: procesora lub pamięci RAM maszyny wirtualnej. - -### Zbieranie danych**w czasie rzeczywistym** - -Dane **w czasie rzeczywistym** są dostępne z poziomu strony głównej interfejsu vScope. - -![vScope-API](images/vScope1.png){.thumbnail} - -Możesz przeglądać dane**w czasie rzeczywistym** dotyczące następujących elementów: - -- serwery plików, -- hosty, -- maszyny wirtualne. - -Z API można korzystać dzięki następujących trzem wywołaniom APIv6: - -#### Serwery plików - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/filer/{filerId} -> - -#### Hosty - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host/{hostId} -> - -#### Maszyny wirtualne - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/vm/{vmId} -> - -### Zbieranie danych historycznych (wykresy) - -Do zbierania i wykorzystywania danych historycznych (wykresy) wykorzystujemy produkt **Metrics Data Platforms**. - -Możesz zbierać dane w formie kropek za pośrednictwem protokołów Opentsdb lub WARP10. Kropki można wykorzystywać w aplikacji lub też wyświetlać je bezpośrednio w zależności od oczekiwanego rezultatu. - -Niniejszy artykuł przedstawia wykorzystanie protokołu Opentsdb do nieuporządkowanego wyświetlania danych (bez formy graficznej). - -Aby móc korzystać z narzędzia **Metrics Data Platforms**, musisz najpierw uzyskać token odczytu. W nowej wersji vScope każdy użytkownik infrastruktury otrzymuje taki token. - -Aby uzyskać token odczytu dla danego użytkownika, należy użyć następującego wywołania przez APIv6: - -> [!api] -> -> @api {v1} /dedicatedCloud POST /dedicatedCloud/{serviceName}/user/{userId}/metricsToken -> - -Twój token znajduje się w polu wyników**token**. - -```json -{ - "warpEndpoint": "https://warp10.gra1-ovh.metrics.ovh.net", - "token": "XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX", - "opentsdbEndpoint": "https://opentsdb.gra1-ovh.metrics.ovh.net" -} -``` - -Dla każdego rodzaju elementu dostępna jest lista statusów (zwanych również etykietami) wymagająca bardzo precyzyjnych parametrów. - -#### Serwery plików (Filers) - -| Statusy (Metrics) | Opis (Description) | Etykiety (Labels) | -| ----------- | ----------- | ----------- | -| vscope.filer.datastore.diskspace.used | Wykorzystanie serwera plików w kB | datacenter : pcc-37-187-228-180_datacenter869,
datastore : pcc-000443 | - -#### Hosty - -| Statusy (Metrics) | Opis (Description) | Etykiety (Labels) | -| ----------- | ----------- | ----------- | -| vscope.host.cpu.usage.perc | Wykorzystanie procentowe procesora hosta | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51 | -| vscope.host.mem.usage.perc | Wyrażone procentowo wykorzystanie pamięci hosta | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51 | -| vscope.host.net.tx | Wykorzystanie sieci hosta podczas przesyłania | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.rx | Wykorzystanie sieci hosta podczas odbioru | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetstx | Liczba pakietów sieciowych przesłanych przez hosta | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetsrx | Liczba pakietów sieciowych odebranych przez hosta | \- datacenter : pcc-37-187-228-180_datacenter869,
\- host : 172.17.86.51
\- nicname : vmnic0/vmnic1/vmnic2/vmnic3 | - -#### Maszyny wirtualne - -| Statusy (Metrics) | Opis (Description) | Etykiety (Labels) | -| ----------- | ----------- | ----------- | -| vscope.vm.cpu.usage.perc | Wykorzystanie procentowe procesora maszyny wirtualnej | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.mem.usage.perc | Wykorzystanie procentowe pamięci maszyny wirtualnej | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.cpu.ready |Status CPU Ready serwera wirtualnego w milisekundach | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.rx | Wykorzystanie sieci serwera wirtualnego podczas odbioru | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.tx | Wykorzystanie sieci serwera wirtualnego podczas przesyłania | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.packetsrx | Liczba pakietów sieciowych odebranych przez maszynę wirtualną | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.net.packetstx | Liczba pakietów sieciowych przesłanych przez maszynę wirtualną | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.io.read | Liczba operacji wejścia/wyjścia na sekundę przy odczycie dla maszyny wirtualnej | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.io.write | Liczba operacji wejścia/wyjścia na sekundę przy zapisie dla maszyny wirtualnej | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.bandwidth.read | Przepustowość dysku maszyny wirtualnej w trybie odczytu | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.bandwidth.write | Przepustowość dysku maszyny wirtualnej w trybie zapisu | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.latency.read | Opóźnienie dysku maszyny wirtualnej podczas odczytu | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | -| vscope.vm.disk.latency.write | Opóźnienie dysku maszyny wirtualnej podczas zapisu | \- datacenter : pcc-37-187-228-180_datacenter869,
\- vm : vm-01254 | - -#### Przykład zbierania danych z wykorzystaniem protokołu OpenTSDB - -Teraz, kiedy już uzyskałeś swój token (endpoint) i dysponujesz listą statusów, możesz pozyskać dane dotyczące wykorzystania pamięci hosta w okresie 1 dnia. - -Poniżej znajdziesz przykładowe zapytanie. - -``` -curl -XPOST https://read:XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX@opentsdb.gra1-ovh.metrics.ovh.net/api/query --d '{ - "start":1564407950, - "queries":[ - { - "metric":"vscope.host.mem.usage.perc", - "aggregator":"sum", - "downsample":"20m-max-zero", - "tags": { - "datacenter":"pcc-37-187-228-180_datacenter869", - "host":"172.17.86.51" - } - } - ] -}' -``` - -Wyjaśnienie różnych wykorzystanych pól: - -- read: użytkownik służący do przeprowadzenia zapytania (będzie mieć zawsze status read); -- XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX : token pozyskany uprzednio przez APIv6; -- opentsdb.gra1-ovh.metrics.ovh.net: endpoint OpenTSDB, również uzyskiwany przez APIv6. Ten endpoint może różnić się w zależności od Twojej lokalizacji; -- start: znacznik czasowy odpowiadający dacie rozpoczęcia zapytania; -- queries: tabela zawierająca statusy do pozyskania. Za pomocą pojedynczego zapytania można uzyskać wiele statusów; -- metric: nazwa statusu do uzyskania; -- aggregator: nazwa funkcji agregacji (zapoznaj się z dokumentacją OpenTSDB, aby uzyskać więcej szczegółów); -- downsample: nazwa funkcji próbkowania (pozwala zmniejszyć ilość danych do pozyskania. Parametr opcjonalny); -- tags: lista etykiet w formie klucza / wartości; - -Można uzyskać też inne parametry. Zapoznaj się z dokumentacją API OpenTSDB, by uzyskać więcej szczegółów. - -Otrzymasz wówczas plik json z podsumowaniem zapytania, a także znaczniki czasowe powiązane z wartościami w polu **dps**. -Przykład: - -```json -[ - { - "metric":"vscope.host.mem.usage.perc", - "tags":{ - "datacenter":"pcc-37-187-228-180_datacenter869", - "env":"prod", - "host":"172.17.86.51", - "servicename":"pcc-37-187-228-180", - "servicetype":"vscope" - }, - "query":{ - "index":0 - }, - "aggregateTags":[], - "dps":{ - "1564409391":4.38, - "1564410591":4.35, - "1564411791":4.37, - "1564412991":4.38, - "1564414191":4.35, - "1564415391":4.38, - "1564416591":4.35, - "1564417791":4.36, - "1564418991":4.36, - "1564420191":4.37, - "1564421391":4.37, - "1564422591":4.37, - "1564423791":4.37, - "1564424991":4.38, - "1564426191":4.36, - "1564427391":4.35, - "1564428591":4.37, - "1564429791":4.36, - "1564430991":4.38, - "1564432191":4.35, - "1564433391":4.37, - "1564434591":4.36, - "1564435791":4.37, - "1564436991":4.37, - "1564438191":4.37, - "1564439391":4.38, - "1564440591":4.36, - "1564441791":4.36, - "1564442991":4.37, - "1564444191":4.37, - "1564445391":4.35, - "1564446591":4.36, - "1564447791":4.36, - "1564448991":4.36, - "1564450191":4.35, - "1564451391":4.37, - "1564452591":4.37, - "1564453791":4.35, - "1564454991":4.36, - "1564456191":4.37, - "1564457391":4.37, - "1564458591":4.36, - "1564459791":4.37, - "1564460991":4.34, - "1564462191":4.36, - "1564463391":4.34, - "1564464591":4.37, - "1564465791":4.34, - "1564466991":4.37, - "1564468191":4.34, - "1564469391":4.36, - "1564470591":4.36, - "1564471791":4.36, - "1564472991":4.37, - "1564474191":4.37, - "1564475391":4.36, - "1564476591":4.35, - "1564477791":4.36, - "1564478991":4.35, - "1564480191":4.35, - "1564481391":4.37, - "1564482591":4.36, - "1564483791":4.34, - "1564484991":4.37, - "1564486191":4.38, - "1564487391":4.35, - "1564488591":4.34, - "1564489791":4.36, - "1564490991":4.35, - "1564492191":4.36, - "1564493391":4.36, - "1564494591":4.36 - } - } -] -``` - -Więcej informacji na temat zapytań OpenTSDB znajdziesz w dokumentacji: [OpenTSDB api query](http://opentsdb.net/docs/build/html/api_http/query/index.html) - -## Sprawdź również - -Dołącz do społeczności naszych użytkowników na stronie. diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/guide.pt-pt.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/guide.pt-pt.md deleted file mode 100644 index 3ca70523a83..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/guide.pt-pt.md +++ /dev/null @@ -1,266 +0,0 @@ ---- -title: 'Como utilizar a API de vScope' -excerpt: 'A API vScope permite-lhe utilizar os dados de monitorização nas suas aplicações' -updated: 2020-06-29 ---- - -## Sumário - -A OVHcloud coloca à sua disposição uma ferramenta de supervisão e monitorização das suas máquinas virtuais e da sua infraestrutura, designada por **vScope**. - -Trata-se de uma página Internet onde estão reunidas todas as informações úteis relativas à utilização dos seus recursos. - -Estas informações encontram-se também disponíveis através da APIv6 e da API Metrics. - -**Este guia descreve a utilização destas APIs**. - -## Requisitos - -- Uma [infraestrutura Hosted Private Cloud](https://www.ovhcloud.com/pt/enterprise/products/hosted-private-cloud/) -- Ter acesso à interface de gestão vScope - -## Instruções - -A ferramenta vScope disponibiliza dois tipos de informações: - -- informações **live**, que correspondem aos dados dos vários componentes num determinado instante T; -- gráficos que apresentam os dados históricos de desempenho dos vários componentes. Por exemplo: CPU, RAM de uma máquina virtual. - -### Recolher os dados **live** - -Os dados **live** são os dados disponíveis a partir da página principal da interface vScope. - -![vScope-API](images/vScope1.png){.thumbnail} - -Pode recuperar estes dados **live** para os seguintes componentes: - -- filers -- hosts -- virtual machines - -A utilização da API faz-se através destas três chamadas APIv6: - -#### Filers - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/filer/{filerId} -> - -#### Hosts - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host/{hostId} -> - -#### Máquinas virtuais - -> [!api] -> -> @api {v1} /dedicatedCloud GET /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/vm/{vmId} -> - -### Recolher os dados históricos (Graphs) - -Para recolher e utilizar os dados históricos (Graphs), usamos o produto **Metrics Data Platforms**. - -Através dos protocolos Opentsdb ou WARP10, vai poder recuperar os seus dados sob a forma de pontos. Poderá explorar estes pontos através da sua aplicação ou apresentá-los diretamente em função do resultado pretendido. - -Este artigo diz respeito à utilização do protocolo Opentsdb para uma apresentação bruta dos dados (sem resultado gráfico). - -Para poder utilizar **Metrics Data Platforms**, terá de obter um token de leitura. Com a nova versão do vScope, cada utilizador da infraestrutura tem um token de leitura. - -Para o utilizador pretendido, utilize a chamada APIv6 seguinte para recuperar o token de leitura: - -> [!api] -> -> @api {v1} /dedicatedCloud POST /dedicatedCloud/{serviceName}/user/{userId}/metricsToken -> - -O seu token encontra-se no campo **token** do resultado. - -```json -{ - "warpEndpoint": "https://warp10.gra1-ovh.metrics.ovh.net", - "token": "XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX", - "opentsdbEndpoint": "https://opentsdb.gra1-ovh.metrics.ovh.net" -} -``` - -Para cada tipo de componente, está disponível uma lista de métricas que precisa de um conjunto de parâmetros (também chamado "etiquetas") muito precisos. - -#### Filers - -| Métricas | Descrição | Etiquetas | -| ----------- | ----------- | ----------- | -| vscope.filer.datastore.diskspace.used | Utilização do filer em kB | datacenter : pcc-37-187-228-180_datacenter869,
datastore: pcc-000443 | - -#### Hosts - -| Métricas | Descrição | Etiquetas | -| ----------- | ----------- | ----------- | -| vscope.host.cpu.usage.perc | Utilização do processador do host em percentagem | \- datacenter: pcc-37-187-228-180_datacenter869,
\- host: 172.17.86.51 | -| vscope.host.mem.usage.perc | Utilização da memória do host em percentagem | \- datacenter: pcc-37-187-228-180_datacenter869,
\- host: 172.17.86.51 | -| vscope.host.net.tx | Utilização da rede do host em emissão | \- datacenter: pcc-37-187-228-180_datacenter869,
\- host: 172.17.86.51
\- nicname: vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.rx | Utilização da rede do host em receção | \- datacenter: pcc-37-187-228-180_datacenter869,
\- host: 172.17.86.51
\- nicname: vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetstx | Número de packs de rede transmitidos do host | \- datacenter: pcc-37-187-228-180_datacenter869,
\- host: 172.17.86.51
\- nicname: vmnic0/vmnic1/vmnic2/vmnic3 | -| vscope.host.net.packetsrx | Número de packs de rede recebidos do host | \- datacenter: pcc-37-187-228-180_datacenter869,
\- host: 172.17.86.51
\- nicname: vmnic0/vmnic1/vmnic2/vmnic3 | - -#### Máquinas virtuais - -| Métricas | Descrição | Etiquetas | -| ----------- | ----------- | ----------- | -| vscope.vm.cpu.usage.perc | Utilização do processador da vm em percentagem | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.mem.usage.perc | Utilização da memória da vm em percentagem | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.cpu.ready |CPU Ready da vm em milissegundos | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.net.rx | Utilização da rede da vm em receção | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.net.tx | Utilização da rede da vm em transmissão | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.net.packetsrx | Número de packs de rede recebidos da vm | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.net.packetstx | Número de packs de rede transmitidos da vm | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.disk.io.read | Número de IO em leitura por segundo da vm | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.disk.io.write | Número de IO em escrita por segundo da vm | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.disk.bandwidth.read | Largura de banda do disco da vm em leitura | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.disk.bandwidth.write | Largura de banda do disco da vm em escrita | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.disk.latency.read | Latência do disco da vm em leitura | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | -| vscope.vm.disk.latency.write | Latência do disco da vm em escrita | \- datacenter: pcc-37-187-228-180_datacenter869,
\- vm: vm-01254 | - -#### Exemplo de recolha com a utilização do protocolo OpenTSDB - -Agora que recuperou o seu token, o seu endpoint e que tem a lista das métricas, vai recuperar os dados de utilização da memória de um host ao longo de 1 dia. - -Em seguida, encontre um exemplo de pedido. - -``` -curl -XPOST https://read:XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX@opentsdb.gra1-ovh.metrics.ovh.net/api/query --d '{ - "start":1564407950, - "queries":[ - { - "metric":"vscope.host.mem.usage.perc", - "aggregator":"sum", - "downsample":"20m-max-zero", - "tags": { - "datacenter":"pcc-37-187-228-180_datacenter869", - "host":"172.17.86.51" - } - } - ] -}' -``` - -Explicação dos vários campos utilizados: - -- read: utilizador utilizado para realizar o pedido (será sempre read); -- XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX: token anteriormente recuperado com a APIv6; -- opentsdb.gra1-ovh.metrics.ovh.net: endpoint OpenTSDB, também recuperado com a APIv6. Este endpoint pode variar em função da sua localização; -- start: carimbo de hora correspondente à data de início do pedido; -- queries: quadro com as métricas a recuperar. Várias métricas podem ser recuperadas num único pedido; -- métrica: nome da métrica a recuperar; -- agregador: nome da função de agregação (consultar a documentação OpenTSDB para mais pormenores); -- downsample: nome da função de escalonagem (permite reduzir a quantidade de dados a recuperar. Parâmetro opcional); -- tags: lista das etiquetas sob a forma de chave/valor; - -Podem também ser fornecidos outros parâmetros. Consulte a documentação da api OpenTSDB para mais pormenores. - -Receberá então um json com o resumo do pedido, bem como os carimbos de hora associados ao respetivo valor no campo **dps**. -Por exemplo: - -```json -[ - { - "metric":"vscope.host.mem.usage.perc", - "tags":{ - "datacenter":"pcc-37-187-228-180_datacenter869", - "env":"prod", - "host":"172.17.86.51", - "servicename":"pcc-37-187-228-180", - "servicetype":"vscope" - }, - "query":{ - "index":0 - }, - "aggregateTags":[], - "dps":{ - "1564409391":4.38, - "1564410591":4.35, - "1564411791":4.37, - "1564412991":4.38, - "1564414191":4.35, - "1564415391":4.38, - "1564416591":4.35, - "1564417791":4.36, - "1564418991":4.36, - "1564420191":4.37, - "1564421391":4.37, - "1564422591":4.37, - "1564423791":4.37, - "1564424991":4.38, - "1564426191":4.36, - "1564427391":4.35, - "1564428591":4.37, - "1564429791":4.36, - "1564430991":4.38, - "1564432191":4.35, - "1564433391":4.37, - "1564434591":4.36, - "1564435791":4.37, - "1564436991":4.37, - "1564438191":4.37, - "1564439391":4.38, - "1564440591":4.36, - "1564441791":4.36, - "1564442991":4.37, - "1564444191":4.37, - "1564445391":4.35, - "1564446591":4.36, - "1564447791":4.36, - "1564448991":4.36, - "1564450191":4.35, - "1564451391":4.37, - "1564452591":4.37, - "1564453791":4.35, - "1564454991":4.36, - "1564456191":4.37, - "1564457391":4.37, - "1564458591":4.36, - "1564459791":4.37, - "1564460991":4.34, - "1564462191":4.36, - "1564463391":4.34, - "1564464591":4.37, - "1564465791":4.34, - "1564466991":4.37, - "1564468191":4.34, - "1564469391":4.36, - "1564470591":4.36, - "1564471791":4.36, - "1564472991":4.37, - "1564474191":4.37, - "1564475391":4.36, - "1564476591":4.35, - "1564477791":4.36, - "1564478991":4.35, - "1564480191":4.35, - "1564481391":4.37, - "1564482591":4.36, - "1564483791":4.34, - "1564484991":4.37, - "1564486191":4.38, - "1564487391":4.35, - "1564488591":4.34, - "1564489791":4.36, - "1564490991":4.35, - "1564492191":4.36, - "1564493391":4.36, - "1564494591":4.36 - } - } -] -``` - -Para mais pormenores sobre os pedidos OpenTSDB, pode consultar a seguinte documentação: [OpenTSDB api query](http://opentsdb.net/docs/build/html/api_http/query/index.html) - -## Quer saber mais? - -Fale com a nossa comunidade de utilizadores em . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/images/vScope1.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/images/vScope1.png deleted file mode 100644 index 92b2a1bdb7f..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/images/vScope1.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/meta.yaml b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/meta.yaml deleted file mode 100755 index 76211a3590b..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how-to-use-vscope-api/meta.yaml +++ /dev/null @@ -1,2 +0,0 @@ -id: 93e2acc5-065d-482f-bb20-38c533af4a4d -full_slug: vmware-vscope-api \ No newline at end of file diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.de-de.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.de-de.md index 2657d728829..701600bef0b 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.de-de.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.de-de.md @@ -1,76 +1,99 @@ --- title: Das vScope-Interface verstehen (EN) excerpt: The vScope interface allows you to monitor your infrastructure -updated: 2022-01-28 +updated: 2025-10-01 --- ## Objective -OVHcloud puts an infrastructure **supervision** and **monitoring** tool called **vScope** at your disposal. +OVHcloud provides you with a **supervision** and **monitoring** tool for your virtual machines and infrastructure: **vScope**. -It's a web based utility gathering and presenting all the **useful** information on your resources. +This web interface gathers all the essential information about your resources. -**This guide describes the functionalities of the vScope interface.** +**This guide explains how to read and use the vScope interface.** ## Requirements -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/de/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account (created in the [OVHcloud Control Panel](/links/manager)) +- You must be an administrator contact of the [Hosted Private Cloud](/links/hosted-private-cloud/vmware) infrastructure, in order to receive login credentials. +- An active user ID (created in the [OVHcloud Control Panel](/links/manager)). ## Instructions -To access the vScope interface, click the vScope icon in the login window of your Hosted Private Cloud. +### Accessing vScope -![vscope access](images/gatewayPCC.png){.thumbnail} +1. In the [OVHcloud Control Panel](/links/manager), click `Hosted Private Cloud`{.action}. -A **vScope** access link is also available in your OVHcloud Control Panel. +2. In the left-hand menu, click `Managed VMware vSphere`{.action}. -![vscope access](images/managerLink.png){.thumbnail} +3. Select your PCC service. -In both cases, you'll be directed to a new browser tab with this URL. +4. In the `General information` tab, scroll down and click the `vScope`{.action} link. -![vscope](images/vScope12.png){.thumbnail} +![vScope](images/gatewayPCC.png){.thumbnail} -Use your vSphere **username** and **password** to log on the interface. +The interface opens in a new tab in your browser. -![vscope](images/vScope11.png){.thumbnail} +![vScope](images/vScope12.png){.thumbnail} -You are now connected to **vScope** and can monitor your resources. For example, you can see in the main window the number of Cores and VMs on each host as well as CPU and RAM consumption or network traffic. +Log in with your **user** and **password** - the same credentials you use to connect to the vSphere client. -![vscope](images/vScope.png){.thumbnail} +![vScope](images/vScope11.png){.thumbnail} -In case of multiple **datacenters** inside a single **Hosted Private Cloud**, you can select them in the scrolling menu. **Last refresh** is the last **web page** refresh, not the **vScope** one. vScope refreshes every **2 to 5 minutes**. +You are now connected to **vScope**. This page centralises the key information about your resources. -![vscope](images/vScope1.png){.thumbnail} +For example, for each host, you can immediately view: -The **Filer** menu gives an insight on datastore usage in terms of VMs and storage space. +- The number of cores and VMs +- CPU and RAM usage +- Network traffic + +![vScope](images/vScope.png){.thumbnail} + +### Browsing vScope + +#### Selecting the datacenter + +If your Hosted Private Cloud contains several datacenters, select the one you want to display from the drop-down menu. -![vscope](images/vScope2.png){.thumbnail} +The **Last refresh** field corresponds to the last refresh of the web page, not of vScope data. vScope data is automatically updated every 2 to 5 minutes. -Clicking on the **Graphs** icon, you can see more details on the chosen resource. +![vScope](images/vScope1.png){.thumbnail} -![vscope](images/vScope7.png){.thumbnail} +#### Filer menu -The Hosts menu offers all the characteristics for each host in your datacenter (**Cores, vCPUs, VM**) and the usage percentage as well as network connectivity on all physical network cards (**VMNic**). +The **Filer** menu shows the usage of your datastores: number of virtual machines and consumed storage space. -![vscope](images/vScope4.png){.thumbnail} +Use this view to anticipate extension needs or monitor load balancing. -The detailed view also shows historical data over a day, week, month or year as needed. +![vScope](images/vScope2.png){.thumbnail} -![vscope](images/vScope8.png){.thumbnail} +### Hosts menu -The last section details each VM's usage with the following data : +The **Hosts** menu details the characteristics of each host in your datacenter: -- VMtools state +- Number of cores, vCPUs and VMs +- CPU and RAM usage percentages +- Network connectivity +- Number of physical network cards (VMNic) + +![vScope](images/vScope4.png){.thumbnail} + +### Virtual machines menu + +This section provides a detailed view of each virtual machine: + +- Status of VMware Tools - Network traffic - VM size -- FT (Fault Tolerance) activation state +- FT (Fault Tolerance) activation - CPU Ready Time - Disk IO -- Disk Latency +- Disk latency -![vscope](images/vScope6.png){.thumbnail} +![vScope](images/vScope6.png){.thumbnail} ## Go further -Join our community of users on . +If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. + +Join our [community of users](/links/community). diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.en-asia.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.en-asia.md index 51a758a6e75..5519bc411d1 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.en-asia.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.en-asia.md @@ -1,76 +1,99 @@ --- title: Understanding vScope excerpt: The vScope interface allows you to monitor your infrastructure -updated: 2022-01-28 +updated: 2025-10-01 --- ## Objective -OVHcloud puts an infrastructure **supervision** and **monitoring** tool called **vScope** at your disposal. +OVHcloud provides you with a **supervision** and **monitoring** tool for your virtual machines and infrastructure: **vScope**. -It's a web based utility gathering and presenting all the **useful** information on your resources. +This web interface gathers all the essential information about your resources. -**This guide describes the functionalities of the vScope interface.** +**This guide explains how to read and use the vScope interface.** ## Requirements -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/asia/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account (created in the [OVHcloud Control Panel](/links/manager)) +- You must be an administrator contact of the [Hosted Private Cloud](/links/hosted-private-cloud/vmware) infrastructure, in order to receive login credentials. +- An active user ID (created in the [OVHcloud Control Panel](/links/manager)). ## Instructions -To access the vScope interface, click the vScope icon in the login window of your Hosted Private Cloud. +### Accessing vScope -![vscope access](images/gatewayPCC.png){.thumbnail} +1. In the [OVHcloud Control Panel](/links/manager), click `Hosted Private Cloud`{.action}. -A **vScope** access link is also available in your OVHcloud Control Panel. +2. In the left-hand menu, click `Managed VMware vSphere`{.action}. -![vscope access](images/managerLink.png){.thumbnail} +3. Select your PCC service. -In both cases, you'll be directed to a new browser tab with this URL. +4. In the `General information` tab, scroll down and click the `vScope`{.action} link. -![vscope](images/vScope12.png){.thumbnail} +![vScope](images/gatewayPCC.png){.thumbnail} -Use your vSphere **username** and **password** to log on the interface. +The interface opens in a new tab in your browser. -![vscope](images/vScope11.png){.thumbnail} +![vScope](images/vScope12.png){.thumbnail} -You are now connected to **vScope** and can monitor your resources. For example, you can see in the main window the number of Cores and VMs on each host as well as CPU and RAM consumption or network traffic. +Log in with your **user** and **password** - the same credentials you use to connect to the vSphere client. -![vscope](images/vScope.png){.thumbnail} +![vScope](images/vScope11.png){.thumbnail} -In case of multiple **datacenters** inside a single **Hosted Private Cloud**, you can select them in the scrolling menu. **Last refresh** is the last **web page** refresh, not the **vScope** one. vScope refreshes every **2 to 5 minutes**. +You are now connected to **vScope**. This page centralises the key information about your resources. -![vscope](images/vScope1.png){.thumbnail} +For example, for each host, you can immediately view: -The **Filer** menu gives an insight on datastore usage in terms of VMs and storage space. +- The number of cores and VMs +- CPU and RAM usage +- Network traffic + +![vScope](images/vScope.png){.thumbnail} + +### Browsing vScope + +#### Selecting the datacenter + +If your Hosted Private Cloud contains several datacenters, select the one you want to display from the drop-down menu. -![vscope](images/vScope2.png){.thumbnail} +The **Last refresh** field corresponds to the last refresh of the web page, not of vScope data. vScope data is automatically updated every 2 to 5 minutes. -Clicking on the **Graphs** icon, you can see more details on the chosen resource. +![vScope](images/vScope1.png){.thumbnail} -![vscope](images/vScope7.png){.thumbnail} +#### Filer menu -The Hosts menu offers all the characteristics for each host in your datacenter (**Cores, vCPUs, VM**) and the usage percentage as well as network connectivity on all physical network cards (**VMNic**). +The **Filer** menu shows the usage of your datastores: number of virtual machines and consumed storage space. -![vscope](images/vScope4.png){.thumbnail} +Use this view to anticipate extension needs or monitor load balancing. -The detailed view also shows historical data over a day, week, month or year as needed. +![vScope](images/vScope2.png){.thumbnail} -![vscope](images/vScope8.png){.thumbnail} +### Hosts menu -The last section details each VM's usage with the following data : +The **Hosts** menu details the characteristics of each host in your datacenter: -- VMtools state +- Number of cores, vCPUs and VMs +- CPU and RAM usage percentages +- Network connectivity +- Number of physical network cards (VMNic) + +![vScope](images/vScope4.png){.thumbnail} + +### Virtual machines menu + +This section provides a detailed view of each virtual machine: + +- Status of VMware Tools - Network traffic - VM size -- FT (Fault Tolerance) activation state +- FT (Fault Tolerance) activation - CPU Ready Time - Disk IO -- Disk Latency +- Disk latency -![vscope](images/vScope6.png){.thumbnail} +![vScope](images/vScope6.png){.thumbnail} ## Go further -Join our community of users on . +If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. + +Join our [community of users](/links/community). diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.en-au.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.en-au.md index f8357d6c21d..5519bc411d1 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.en-au.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.en-au.md @@ -1,76 +1,99 @@ --- title: Understanding vScope excerpt: The vScope interface allows you to monitor your infrastructure -updated: 2022-01-28 +updated: 2025-10-01 --- ## Objective -OVHcloud puts an infrastructure **supervision** and **monitoring** tool called **vScope** at your disposal. +OVHcloud provides you with a **supervision** and **monitoring** tool for your virtual machines and infrastructure: **vScope**. -It's a web based utility gathering and presenting all the **useful** information on your resources. +This web interface gathers all the essential information about your resources. -**This guide describes the functionalities of the vScope interface.** +**This guide explains how to read and use the vScope interface.** ## Requirements -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/en-au/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account (created in the [OVHcloud Control Panel](/links/manager)) +- You must be an administrator contact of the [Hosted Private Cloud](/links/hosted-private-cloud/vmware) infrastructure, in order to receive login credentials. +- An active user ID (created in the [OVHcloud Control Panel](/links/manager)). ## Instructions -To access the vScope interface, click the vScope icon in the login window of your Hosted Private Cloud. +### Accessing vScope -![vscope access](images/gatewayPCC.png){.thumbnail} +1. In the [OVHcloud Control Panel](/links/manager), click `Hosted Private Cloud`{.action}. -A **vScope** access link is also available in your OVHcloud Control Panel. +2. In the left-hand menu, click `Managed VMware vSphere`{.action}. -![vscope access](images/managerLink.png){.thumbnail} +3. Select your PCC service. -In both cases, you'll be directed to a new browser tab with this URL. +4. In the `General information` tab, scroll down and click the `vScope`{.action} link. -![vscope](images/vScope12.png){.thumbnail} +![vScope](images/gatewayPCC.png){.thumbnail} -Use your vSphere **username** and **password** to log on the interface. +The interface opens in a new tab in your browser. -![vscope](images/vScope11.png){.thumbnail} +![vScope](images/vScope12.png){.thumbnail} -You are now connected to **vScope** and can monitor your resources. For example, you can see in the main window the number of Cores and VMs on each host as well as CPU and RAM consumption or network traffic. +Log in with your **user** and **password** - the same credentials you use to connect to the vSphere client. -![vscope](images/vScope.png){.thumbnail} +![vScope](images/vScope11.png){.thumbnail} -In case of multiple **datacenters** inside a single **Hosted Private Cloud**, you can select them in the scrolling menu. **Last refresh** is the last **web page** refresh, not the **vScope** one. vScope refreshes every **2 to 5 minutes**. +You are now connected to **vScope**. This page centralises the key information about your resources. -![vscope](images/vScope1.png){.thumbnail} +For example, for each host, you can immediately view: -The **Filer** menu gives an insight on datastore usage in terms of VMs and storage space. +- The number of cores and VMs +- CPU and RAM usage +- Network traffic + +![vScope](images/vScope.png){.thumbnail} + +### Browsing vScope + +#### Selecting the datacenter + +If your Hosted Private Cloud contains several datacenters, select the one you want to display from the drop-down menu. -![vscope](images/vScope2.png){.thumbnail} +The **Last refresh** field corresponds to the last refresh of the web page, not of vScope data. vScope data is automatically updated every 2 to 5 minutes. -Clicking on the **Graphs** icon, you can see more details on the chosen resource. +![vScope](images/vScope1.png){.thumbnail} -![vscope](images/vScope7.png){.thumbnail} +#### Filer menu -The Hosts menu offers all the characteristics for each host in your datacenter (**Cores, vCPUs, VM**) and the usage percentage as well as network connectivity on all physical network cards (**VMNic**). +The **Filer** menu shows the usage of your datastores: number of virtual machines and consumed storage space. -![vscope](images/vScope4.png){.thumbnail} +Use this view to anticipate extension needs or monitor load balancing. -The detailed view also shows historical data over a day, week, month or year as needed. +![vScope](images/vScope2.png){.thumbnail} -![vscope](images/vScope8.png){.thumbnail} +### Hosts menu -The last section details each VM's usage with the following data : +The **Hosts** menu details the characteristics of each host in your datacenter: -- VMtools state +- Number of cores, vCPUs and VMs +- CPU and RAM usage percentages +- Network connectivity +- Number of physical network cards (VMNic) + +![vScope](images/vScope4.png){.thumbnail} + +### Virtual machines menu + +This section provides a detailed view of each virtual machine: + +- Status of VMware Tools - Network traffic - VM size -- FT (Fault Tolerance) activation state +- FT (Fault Tolerance) activation - CPU Ready Time - Disk IO -- Disk Latency +- Disk latency -![vscope](images/vScope6.png){.thumbnail} +![vScope](images/vScope6.png){.thumbnail} ## Go further -Join our community of users on . +If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. + +Join our [community of users](/links/community). diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.en-ca.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.en-ca.md index e586785f755..5519bc411d1 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.en-ca.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.en-ca.md @@ -1,76 +1,99 @@ --- title: Understanding vScope excerpt: The vScope interface allows you to monitor your infrastructure -updated: 2022-01-28 +updated: 2025-10-01 --- ## Objective -OVHcloud puts an infrastructure **supervision** and **monitoring** tool called **vScope** at your disposal. +OVHcloud provides you with a **supervision** and **monitoring** tool for your virtual machines and infrastructure: **vScope**. -It's a web based utility gathering and presenting all the **useful** information on your resources. +This web interface gathers all the essential information about your resources. -**This guide describes the functionalities of the vScope interface.** +**This guide explains how to read and use the vScope interface.** ## Requirements -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/en-ca/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account (created in the [OVHcloud Control Panel](/links/manager)) +- You must be an administrator contact of the [Hosted Private Cloud](/links/hosted-private-cloud/vmware) infrastructure, in order to receive login credentials. +- An active user ID (created in the [OVHcloud Control Panel](/links/manager)). ## Instructions -To access the vScope interface, click the vScope icon in the login window of your Hosted Private Cloud. +### Accessing vScope -![vscope access](images/gatewayPCC.png){.thumbnail} +1. In the [OVHcloud Control Panel](/links/manager), click `Hosted Private Cloud`{.action}. -A **vScope** access link is also available in your OVHcloud Control Panel. +2. In the left-hand menu, click `Managed VMware vSphere`{.action}. -![vscope access](images/managerLink.png){.thumbnail} +3. Select your PCC service. -In both cases, you'll be directed to a new browser tab with this URL. +4. In the `General information` tab, scroll down and click the `vScope`{.action} link. -![vscope](images/vScope12.png){.thumbnail} +![vScope](images/gatewayPCC.png){.thumbnail} -Use your vSphere **username** and **password** to log on the interface. +The interface opens in a new tab in your browser. -![vscope](images/vScope11.png){.thumbnail} +![vScope](images/vScope12.png){.thumbnail} -You are now connected to **vScope** and can monitor your resources. For example, you can see in the main window the number of Cores and VMs on each host as well as CPU and RAM consumption or network traffic. +Log in with your **user** and **password** - the same credentials you use to connect to the vSphere client. -![vscope](images/vScope.png){.thumbnail} +![vScope](images/vScope11.png){.thumbnail} -In case of multiple **datacenters** inside a single **Hosted Private Cloud**, you can select them in the scrolling menu. **Last refresh** is the last **web page** refresh, not the **vScope** one. vScope refreshes every **2 to 5 minutes**. +You are now connected to **vScope**. This page centralises the key information about your resources. -![vscope](images/vScope1.png){.thumbnail} +For example, for each host, you can immediately view: -The **Filer** menu gives an insight on datastore usage in terms of VMs and storage space. +- The number of cores and VMs +- CPU and RAM usage +- Network traffic + +![vScope](images/vScope.png){.thumbnail} + +### Browsing vScope + +#### Selecting the datacenter + +If your Hosted Private Cloud contains several datacenters, select the one you want to display from the drop-down menu. -![vscope](images/vScope2.png){.thumbnail} +The **Last refresh** field corresponds to the last refresh of the web page, not of vScope data. vScope data is automatically updated every 2 to 5 minutes. -Clicking on the **Graphs** icon, you can see more details on the chosen resource. +![vScope](images/vScope1.png){.thumbnail} -![vscope](images/vScope7.png){.thumbnail} +#### Filer menu -The Hosts menu offers all the characteristics for each host in your datacenter (**Cores, vCPUs, VM**) and the usage percentage as well as network connectivity on all physical network cards (**VMNic**). +The **Filer** menu shows the usage of your datastores: number of virtual machines and consumed storage space. -![vscope](images/vScope4.png){.thumbnail} +Use this view to anticipate extension needs or monitor load balancing. -The detailed view also shows historical data over a day, week, month or year as needed. +![vScope](images/vScope2.png){.thumbnail} -![vscope](images/vScope8.png){.thumbnail} +### Hosts menu -The last section details each VM's usage with the following data : +The **Hosts** menu details the characteristics of each host in your datacenter: -- VMtools state +- Number of cores, vCPUs and VMs +- CPU and RAM usage percentages +- Network connectivity +- Number of physical network cards (VMNic) + +![vScope](images/vScope4.png){.thumbnail} + +### Virtual machines menu + +This section provides a detailed view of each virtual machine: + +- Status of VMware Tools - Network traffic - VM size -- FT (Fault Tolerance) activation state +- FT (Fault Tolerance) activation - CPU Ready Time - Disk IO -- Disk Latency +- Disk latency -![vscope](images/vScope6.png){.thumbnail} +![vScope](images/vScope6.png){.thumbnail} ## Go further -Join our community of users on . +If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. + +Join our [community of users](/links/community). diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.en-gb.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.en-gb.md index 70132e2febd..d817bdaf26e 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.en-gb.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.en-gb.md @@ -1,76 +1,99 @@ --- -title: Understanding vScope -excerpt: The vScope interface allows you to monitor your infrastructure -updated: 2022-01-28 +title: "Understanding vScope" +excerpt: "The vScope interface allows you to monitor your infrastructure" +updated: 2025-10-01 --- ## Objective -OVHcloud puts an infrastructure **supervision** and **monitoring** tool called **vScope** at your disposal. +OVHcloud provides you with a **supervision** and **monitoring** tool for your virtual machines and infrastructure: **vScope**. -It's a web based utility gathering and presenting all the **useful** information on your resources. +This web interface gathers all the essential information about your resources. -**This guide describes the functionalities of the vScope interface.** +**This guide explains how to read and use the vScope interface.** ## Requirements -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/en-gb/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account (created in the [OVHcloud Control Panel](/links/manager)) +- You must be an administrator contact of the [Hosted Private Cloud](/links/hosted-private-cloud/vmware) infrastructure, in order to receive login credentials. +- An active user ID (created in the [OVHcloud Control Panel](/links/manager)). ## Instructions -To access the vScope interface, click the vScope icon in the login window of your Hosted Private Cloud. +### Accessing vScope -![vscope access](images/gatewayPCC.png){.thumbnail} +1. In the [OVHcloud Control Panel](/links/manager), click `Hosted Private Cloud`{.action}. -A **vScope** access link is also available in your OVHcloud Control Panel. +2. In the left-hand menu, click `Managed VMware vSphere`{.action}. -![vscope access](images/managerLink.png){.thumbnail} +3. Select your PCC service. -In both cases, you'll be directed to a new browser tab with this URL. +4. In the `General information` tab, scroll down and click the `vScope`{.action} link. -![vscope](images/vScope12.png){.thumbnail} +![vScope](images/gatewayPCC.png){.thumbnail} -Use your vSphere **username** and **password** to log on the interface. +The interface opens in a new tab in your browser. -![vscope](images/vScope11.png){.thumbnail} +![vScope](images/vScope12.png){.thumbnail} -You are now connected to **vScope** and can monitor your resources. For example, you can see in the main window the number of Cores and VMs on each host as well as CPU and RAM consumption or network traffic. +Log in with your **user** and **password** - the same credentials you use to connect to the vSphere client. -![vscope](images/vScope.png){.thumbnail} +![vScope](images/vScope11.png){.thumbnail} -In case of multiple **datacenters** inside a single **Hosted Private Cloud**, you can select them in the scrolling menu. **Last refresh** is the last **web page** refresh, not the **vScope** one. vScope refreshes every **2 to 5 minutes**. +You are now connected to **vScope**. This page centralises the key information about your resources. -![vscope](images/vScope1.png){.thumbnail} +For example, for each host, you can immediately view: -The **Filer** menu gives an insight on datastore usage in terms of VMs and storage space. +- The number of cores and VMs +- CPU and RAM usage +- Network traffic + +![vScope](images/vScope.png){.thumbnail} + +### Browsing vScope + +#### Selecting the datacenter + +If your Hosted Private Cloud contains several datacenters, select the one you want to display from the drop-down menu. -![vscope](images/vScope2.png){.thumbnail} +The **Last refresh** field corresponds to the last refresh of the web page, not of vScope data. vScope data is automatically updated every 2 to 5 minutes. -Clicking on the **Graphs** icon, you can see more details on the chosen resource. +![vScope](images/vScope1.png){.thumbnail} -![vscope](images/vScope7.png){.thumbnail} +#### Filer menu -The Hosts menu offers all the characteristics for each host in your datacenter (**Cores, vCPUs, VM**) and the usage percentage as well as network connectivity on all physical network cards (**VMNic**). +The **Filer** menu shows the usage of your datastores: number of virtual machines and consumed storage space. -![vscope](images/vScope4.png){.thumbnail} +Use this view to anticipate extension needs or monitor load balancing. -The detailed view also shows historical data over a day, week, month or year as needed. +![vScope](images/vScope2.png){.thumbnail} -![vscope](images/vScope8.png){.thumbnail} +### Hosts menu -The last section details each VM's usage with the following data : +The **Hosts** menu details the characteristics of each host in your datacenter: -- VMtools state +- Number of cores, vCPUs and VMs +- CPU and RAM usage percentages +- Network connectivity +- Number of physical network cards (VMNic) + +![vScope](images/vScope4.png){.thumbnail} + +### Virtual machines menu + +This section provides a detailed view of each virtual machine: + +- Status of VMware Tools - Network traffic - VM size -- FT (Fault Tolerance) activation state +- FT (Fault Tolerance) activation - CPU Ready Time - Disk IO -- Disk Latency +- Disk latency -![vscope](images/vScope6.png){.thumbnail} +![vScope](images/vScope6.png){.thumbnail} ## Go further -Join our community of users on . +If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. + +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.en-ie.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.en-ie.md index 1309e723ceb..5519bc411d1 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.en-ie.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.en-ie.md @@ -1,76 +1,99 @@ --- title: Understanding vScope excerpt: The vScope interface allows you to monitor your infrastructure -updated: 2022-01-28 +updated: 2025-10-01 --- ## Objective -OVHcloud puts an infrastructure **supervision** and **monitoring** tool called **vScope** at your disposal. +OVHcloud provides you with a **supervision** and **monitoring** tool for your virtual machines and infrastructure: **vScope**. -It's a web based utility gathering and presenting all the **useful** information on your resources. +This web interface gathers all the essential information about your resources. -**This guide describes the functionalities of the vScope interface.** +**This guide explains how to read and use the vScope interface.** ## Requirements -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/en-ie/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account (created in the [OVHcloud Control Panel](/links/manager)) +- You must be an administrator contact of the [Hosted Private Cloud](/links/hosted-private-cloud/vmware) infrastructure, in order to receive login credentials. +- An active user ID (created in the [OVHcloud Control Panel](/links/manager)). ## Instructions -To access the vScope interface, click the vScope icon in the login window of your Hosted Private Cloud. +### Accessing vScope -![vscope access](images/gatewayPCC.png){.thumbnail} +1. In the [OVHcloud Control Panel](/links/manager), click `Hosted Private Cloud`{.action}. -A **vScope** access link is also available in your OVHcloud Control Panel. +2. In the left-hand menu, click `Managed VMware vSphere`{.action}. -![vscope access](images/managerLink.png){.thumbnail} +3. Select your PCC service. -In both cases, you'll be directed to a new browser tab with this URL. +4. In the `General information` tab, scroll down and click the `vScope`{.action} link. -![vscope](images/vScope12.png){.thumbnail} +![vScope](images/gatewayPCC.png){.thumbnail} -Use your vSphere **username** and **password** to log on the interface. +The interface opens in a new tab in your browser. -![vscope](images/vScope11.png){.thumbnail} +![vScope](images/vScope12.png){.thumbnail} -You are now connected to **vScope** and can monitor your resources. For example, you can see in the main window the number of Cores and VMs on each host as well as CPU and RAM consumption or network traffic. +Log in with your **user** and **password** - the same credentials you use to connect to the vSphere client. -![vscope](images/vScope.png){.thumbnail} +![vScope](images/vScope11.png){.thumbnail} -In case of multiple **datacenters** inside a single **Hosted Private Cloud**, you can select them in the scrolling menu. **Last refresh** is the last **web page** refresh, not the **vScope** one. vScope refreshes every **2 to 5 minutes**. +You are now connected to **vScope**. This page centralises the key information about your resources. -![vscope](images/vScope1.png){.thumbnail} +For example, for each host, you can immediately view: -The **Filer** menu gives an insight on datastore usage in terms of VMs and storage space. +- The number of cores and VMs +- CPU and RAM usage +- Network traffic + +![vScope](images/vScope.png){.thumbnail} + +### Browsing vScope + +#### Selecting the datacenter + +If your Hosted Private Cloud contains several datacenters, select the one you want to display from the drop-down menu. -![vscope](images/vScope2.png){.thumbnail} +The **Last refresh** field corresponds to the last refresh of the web page, not of vScope data. vScope data is automatically updated every 2 to 5 minutes. -Clicking on the **Graphs** icon, you can see more details on the chosen resource. +![vScope](images/vScope1.png){.thumbnail} -![vscope](images/vScope7.png){.thumbnail} +#### Filer menu -The Hosts menu offers all the characteristics for each host in your datacenter (**Cores, vCPUs, VM**) and the usage percentage as well as network connectivity on all physical network cards (**VMNic**). +The **Filer** menu shows the usage of your datastores: number of virtual machines and consumed storage space. -![vscope](images/vScope4.png){.thumbnail} +Use this view to anticipate extension needs or monitor load balancing. -The detailed view also shows historical data over a day, week, month or year as needed. +![vScope](images/vScope2.png){.thumbnail} -![vscope](images/vScope8.png){.thumbnail} +### Hosts menu -The last section details each VM's usage with the following data : +The **Hosts** menu details the characteristics of each host in your datacenter: -- VMtools state +- Number of cores, vCPUs and VMs +- CPU and RAM usage percentages +- Network connectivity +- Number of physical network cards (VMNic) + +![vScope](images/vScope4.png){.thumbnail} + +### Virtual machines menu + +This section provides a detailed view of each virtual machine: + +- Status of VMware Tools - Network traffic - VM size -- FT (Fault Tolerance) activation state +- FT (Fault Tolerance) activation - CPU Ready Time - Disk IO -- Disk Latency +- Disk latency -![vscope](images/vScope6.png){.thumbnail} +![vScope](images/vScope6.png){.thumbnail} ## Go further -Join our community of users on . +If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. + +Join our [community of users](/links/community). diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.en-sg.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.en-sg.md index 5587206860e..5519bc411d1 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.en-sg.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.en-sg.md @@ -1,76 +1,99 @@ --- title: Understanding vScope excerpt: The vScope interface allows you to monitor your infrastructure -updated: 2022-01-28 +updated: 2025-10-01 --- ## Objective -OVHcloud puts an infrastructure **supervision** and **monitoring** tool called **vScope** at your disposal. +OVHcloud provides you with a **supervision** and **monitoring** tool for your virtual machines and infrastructure: **vScope**. -It's a web based utility gathering and presenting all the **useful** information on your resources. +This web interface gathers all the essential information about your resources. -**This guide describes the functionalities of the vScope interface.** +**This guide explains how to read and use the vScope interface.** ## Requirements -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/en-sg/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account (created in the [OVHcloud Control Panel](/links/manager)) +- You must be an administrator contact of the [Hosted Private Cloud](/links/hosted-private-cloud/vmware) infrastructure, in order to receive login credentials. +- An active user ID (created in the [OVHcloud Control Panel](/links/manager)). ## Instructions -To access the vScope interface, click the vScope icon in the login window of your Hosted Private Cloud. +### Accessing vScope -![vscope access](images/gatewayPCC.png){.thumbnail} +1. In the [OVHcloud Control Panel](/links/manager), click `Hosted Private Cloud`{.action}. -A **vScope** access link is also available in your OVHcloud Control Panel. +2. In the left-hand menu, click `Managed VMware vSphere`{.action}. -![vscope access](images/managerLink.png){.thumbnail} +3. Select your PCC service. -In both cases, you'll be directed to a new browser tab with this URL. +4. In the `General information` tab, scroll down and click the `vScope`{.action} link. -![vscope](images/vScope12.png){.thumbnail} +![vScope](images/gatewayPCC.png){.thumbnail} -Use your vSphere **username** and **password** to log on the interface. +The interface opens in a new tab in your browser. -![vscope](images/vScope11.png){.thumbnail} +![vScope](images/vScope12.png){.thumbnail} -You are now connected to **vScope** and can monitor your resources. For example, you can see in the main window the number of Cores and VMs on each host as well as CPU and RAM consumption or network traffic. +Log in with your **user** and **password** - the same credentials you use to connect to the vSphere client. -![vscope](images/vScope.png){.thumbnail} +![vScope](images/vScope11.png){.thumbnail} -In case of multiple **datacenters** inside a single **Hosted Private Cloud**, you can select them in the scrolling menu. **Last refresh** is the last **web page** refresh, not the **vScope** one. vScope refreshes every **2 to 5 minutes**. +You are now connected to **vScope**. This page centralises the key information about your resources. -![vscope](images/vScope1.png){.thumbnail} +For example, for each host, you can immediately view: -The **Filer** menu gives an insight on datastore usage in terms of VMs and storage space. +- The number of cores and VMs +- CPU and RAM usage +- Network traffic + +![vScope](images/vScope.png){.thumbnail} + +### Browsing vScope + +#### Selecting the datacenter + +If your Hosted Private Cloud contains several datacenters, select the one you want to display from the drop-down menu. -![vscope](images/vScope2.png){.thumbnail} +The **Last refresh** field corresponds to the last refresh of the web page, not of vScope data. vScope data is automatically updated every 2 to 5 minutes. -Clicking on the **Graphs** icon, you can see more details on the chosen resource. +![vScope](images/vScope1.png){.thumbnail} -![vscope](images/vScope7.png){.thumbnail} +#### Filer menu -The Hosts menu offers all the characteristics for each host in your datacenter (**Cores, vCPUs, VM**) and the usage percentage as well as network connectivity on all physical network cards (**VMNic**). +The **Filer** menu shows the usage of your datastores: number of virtual machines and consumed storage space. -![vscope](images/vScope4.png){.thumbnail} +Use this view to anticipate extension needs or monitor load balancing. -The detailed view also shows historical data over a day, week, month or year as needed. +![vScope](images/vScope2.png){.thumbnail} -![vscope](images/vScope8.png){.thumbnail} +### Hosts menu -The last section details each VM's usage with the following data : +The **Hosts** menu details the characteristics of each host in your datacenter: -- VMtools state +- Number of cores, vCPUs and VMs +- CPU and RAM usage percentages +- Network connectivity +- Number of physical network cards (VMNic) + +![vScope](images/vScope4.png){.thumbnail} + +### Virtual machines menu + +This section provides a detailed view of each virtual machine: + +- Status of VMware Tools - Network traffic - VM size -- FT (Fault Tolerance) activation state +- FT (Fault Tolerance) activation - CPU Ready Time - Disk IO -- Disk Latency +- Disk latency -![vscope](images/vScope6.png){.thumbnail} +![vScope](images/vScope6.png){.thumbnail} ## Go further -Join our community of users on . +If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. + +Join our [community of users](/links/community). diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.en-us.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.en-us.md index db5a986c5ea..5519bc411d1 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.en-us.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.en-us.md @@ -1,76 +1,99 @@ --- title: Understanding vScope excerpt: The vScope interface allows you to monitor your infrastructure -updated: 2022-01-28 +updated: 2025-10-01 --- ## Objective -OVHcloud puts an infrastructure **supervision** and **monitoring** tool called **vScope** at your disposal. +OVHcloud provides you with a **supervision** and **monitoring** tool for your virtual machines and infrastructure: **vScope**. -It's a web based utility gathering and presenting all the **useful** information on your resources. +This web interface gathers all the essential information about your resources. -**This guide describes the functionalities of the vScope interface.** +**This guide explains how to read and use the vScope interface.** ## Requirements -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/en/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account (created in the [OVHcloud Control Panel](/links/manager)) +- You must be an administrator contact of the [Hosted Private Cloud](/links/hosted-private-cloud/vmware) infrastructure, in order to receive login credentials. +- An active user ID (created in the [OVHcloud Control Panel](/links/manager)). ## Instructions -To access the vScope interface, click the vScope icon in the login window of your Hosted Private Cloud. +### Accessing vScope -![vscope access](images/gatewayPCC.png){.thumbnail} +1. In the [OVHcloud Control Panel](/links/manager), click `Hosted Private Cloud`{.action}. -A **vScope** access link is also available in your OVHcloud Control Panel. +2. In the left-hand menu, click `Managed VMware vSphere`{.action}. -![vscope access](images/managerLink.png){.thumbnail} +3. Select your PCC service. -In both cases, you'll be directed to a new browser tab with this URL. +4. In the `General information` tab, scroll down and click the `vScope`{.action} link. -![vscope](images/vScope12.png){.thumbnail} +![vScope](images/gatewayPCC.png){.thumbnail} -Use your vSphere **username** and **password** to log on the interface. +The interface opens in a new tab in your browser. -![vscope](images/vScope11.png){.thumbnail} +![vScope](images/vScope12.png){.thumbnail} -You are now connected to **vScope** and can monitor your resources. For example, you can see in the main window the number of Cores and VMs on each host as well as CPU and RAM consumption or network traffic. +Log in with your **user** and **password** - the same credentials you use to connect to the vSphere client. -![vscope](images/vScope.png){.thumbnail} +![vScope](images/vScope11.png){.thumbnail} -In case of multiple **datacenters** inside a single **Hosted Private Cloud**, you can select them in the scrolling menu. **Last refresh** is the last **web page** refresh, not the **vScope** one. vScope refreshes every **2 to 5 minutes**. +You are now connected to **vScope**. This page centralises the key information about your resources. -![vscope](images/vScope1.png){.thumbnail} +For example, for each host, you can immediately view: -The **Filer** menu gives an insight on datastore usage in terms of VMs and storage space. +- The number of cores and VMs +- CPU and RAM usage +- Network traffic + +![vScope](images/vScope.png){.thumbnail} + +### Browsing vScope + +#### Selecting the datacenter + +If your Hosted Private Cloud contains several datacenters, select the one you want to display from the drop-down menu. -![vscope](images/vScope2.png){.thumbnail} +The **Last refresh** field corresponds to the last refresh of the web page, not of vScope data. vScope data is automatically updated every 2 to 5 minutes. -Clicking on the **Graphs** icon, you can see more details on the chosen resource. +![vScope](images/vScope1.png){.thumbnail} -![vscope](images/vScope7.png){.thumbnail} +#### Filer menu -The Hosts menu offers all the characteristics for each host in your datacenter (**Cores, vCPUs, VM**) and the usage percentage as well as network connectivity on all physical network cards (**VMNic**). +The **Filer** menu shows the usage of your datastores: number of virtual machines and consumed storage space. -![vscope](images/vScope4.png){.thumbnail} +Use this view to anticipate extension needs or monitor load balancing. -The detailed view also shows historical data over a day, week, month or year as needed. +![vScope](images/vScope2.png){.thumbnail} -![vscope](images/vScope8.png){.thumbnail} +### Hosts menu -The last section details each VM's usage with the following data : +The **Hosts** menu details the characteristics of each host in your datacenter: -- VMtools state +- Number of cores, vCPUs and VMs +- CPU and RAM usage percentages +- Network connectivity +- Number of physical network cards (VMNic) + +![vScope](images/vScope4.png){.thumbnail} + +### Virtual machines menu + +This section provides a detailed view of each virtual machine: + +- Status of VMware Tools - Network traffic - VM size -- FT (Fault Tolerance) activation state +- FT (Fault Tolerance) activation - CPU Ready Time - Disk IO -- Disk Latency +- Disk latency -![vscope](images/vScope6.png){.thumbnail} +![vScope](images/vScope6.png){.thumbnail} ## Go further -Join our community of users on . +If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. + +Join our [community of users](/links/community). diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.es-es.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.es-es.md index 6ff88944986..1943d6bdbb9 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.es-es.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.es-es.md @@ -1,76 +1,99 @@ --- title: Entender la interfaz vScope (EN) excerpt: The vScope interface allows you to monitor your infrastructure -updated: 2022-01-28 +updated: 2025-10-01 --- ## Objective -OVHcloud puts an infrastructure **supervision** and **monitoring** tool called **vScope** at your disposal. +OVHcloud provides you with a **supervision** and **monitoring** tool for your virtual machines and infrastructure: **vScope**. -It's a web based utility gathering and presenting all the **useful** information on your resources. +This web interface gathers all the essential information about your resources. -**This guide describes the functionalities of the vScope interface.** +**This guide explains how to read and use the vScope interface.** ## Requirements -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/es-es/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account (created in the [OVHcloud Control Panel](/links/manager)) +- You must be an administrator contact of the [Hosted Private Cloud](/links/hosted-private-cloud/vmware) infrastructure, in order to receive login credentials. +- An active user ID (created in the [OVHcloud Control Panel](/links/manager)). ## Instructions -To access the vScope interface, click the vScope icon in the login window of your Hosted Private Cloud. +### Accessing vScope -![vscope access](images/gatewayPCC.png){.thumbnail} +1. In the [OVHcloud Control Panel](/links/manager), click `Hosted Private Cloud`{.action}. -A **vScope** access link is also available in your OVHcloud Control Panel. +2. In the left-hand menu, click `Managed VMware vSphere`{.action}. -![vscope access](images/managerLink.png){.thumbnail} +3. Select your PCC service. -In both cases, you'll be directed to a new browser tab with this URL. +4. In the `General information` tab, scroll down and click the `vScope`{.action} link. -![vscope](images/vScope12.png){.thumbnail} +![vScope](images/gatewayPCC.png){.thumbnail} -Use your vSphere **username** and **password** to log on the interface. +The interface opens in a new tab in your browser. -![vscope](images/vScope11.png){.thumbnail} +![vScope](images/vScope12.png){.thumbnail} -You are now connected to **vScope** and can monitor your resources. For example, you can see in the main window the number of Cores and VMs on each host as well as CPU and RAM consumption or network traffic. +Log in with your **user** and **password** - the same credentials you use to connect to the vSphere client. -![vscope](images/vScope.png){.thumbnail} +![vScope](images/vScope11.png){.thumbnail} -In case of multiple **datacenters** inside a single **Hosted Private Cloud**, you can select them in the scrolling menu. **Last refresh** is the last **web page** refresh, not the **vScope** one. vScope refreshes every **2 to 5 minutes**. +You are now connected to **vScope**. This page centralises the key information about your resources. -![vscope](images/vScope1.png){.thumbnail} +For example, for each host, you can immediately view: -The **Filer** menu gives an insight on datastore usage in terms of VMs and storage space. +- The number of cores and VMs +- CPU and RAM usage +- Network traffic + +![vScope](images/vScope.png){.thumbnail} + +### Browsing vScope + +#### Selecting the datacenter + +If your Hosted Private Cloud contains several datacenters, select the one you want to display from the drop-down menu. -![vscope](images/vScope2.png){.thumbnail} +The **Last refresh** field corresponds to the last refresh of the web page, not of vScope data. vScope data is automatically updated every 2 to 5 minutes. -Clicking on the **Graphs** icon, you can see more details on the chosen resource. +![vScope](images/vScope1.png){.thumbnail} -![vscope](images/vScope7.png){.thumbnail} +#### Filer menu -The Hosts menu offers all the characteristics for each host in your datacenter (**Cores, vCPUs, VM**) and the usage percentage as well as network connectivity on all physical network cards (**VMNic**). +The **Filer** menu shows the usage of your datastores: number of virtual machines and consumed storage space. -![vscope](images/vScope4.png){.thumbnail} +Use this view to anticipate extension needs or monitor load balancing. -The detailed view also shows historical data over a day, week, month or year as needed. +![vScope](images/vScope2.png){.thumbnail} -![vscope](images/vScope8.png){.thumbnail} +### Hosts menu -The last section details each VM's usage with the following data : +The **Hosts** menu details the characteristics of each host in your datacenter: -- VMtools state +- Number of cores, vCPUs and VMs +- CPU and RAM usage percentages +- Network connectivity +- Number of physical network cards (VMNic) + +![vScope](images/vScope4.png){.thumbnail} + +### Virtual machines menu + +This section provides a detailed view of each virtual machine: + +- Status of VMware Tools - Network traffic - VM size -- FT (Fault Tolerance) activation state +- FT (Fault Tolerance) activation - CPU Ready Time - Disk IO -- Disk Latency +- Disk latency -![vscope](images/vScope6.png){.thumbnail} +![vScope](images/vScope6.png){.thumbnail} ## Go further -Join our community of users on . +If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. + +Join our [community of users](/links/community). diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.es-us.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.es-us.md index f63590d5938..1943d6bdbb9 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.es-us.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.es-us.md @@ -1,76 +1,99 @@ --- title: Entender la interfaz vScope (EN) excerpt: The vScope interface allows you to monitor your infrastructure -updated: 2022-01-28 +updated: 2025-10-01 --- ## Objective -OVHcloud puts an infrastructure **supervision** and **monitoring** tool called **vScope** at your disposal. +OVHcloud provides you with a **supervision** and **monitoring** tool for your virtual machines and infrastructure: **vScope**. -It's a web based utility gathering and presenting all the **useful** information on your resources. +This web interface gathers all the essential information about your resources. -**This guide describes the functionalities of the vScope interface.** +**This guide explains how to read and use the vScope interface.** ## Requirements -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/es/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account (created in the [OVHcloud Control Panel](/links/manager)) +- You must be an administrator contact of the [Hosted Private Cloud](/links/hosted-private-cloud/vmware) infrastructure, in order to receive login credentials. +- An active user ID (created in the [OVHcloud Control Panel](/links/manager)). ## Instructions -To access the vScope interface, click the vScope icon in the login window of your Hosted Private Cloud. +### Accessing vScope -![vscope access](images/gatewayPCC.png){.thumbnail} +1. In the [OVHcloud Control Panel](/links/manager), click `Hosted Private Cloud`{.action}. -A **vScope** access link is also available in your OVHcloud Control Panel. +2. In the left-hand menu, click `Managed VMware vSphere`{.action}. -![vscope access](images/managerLink.png){.thumbnail} +3. Select your PCC service. -In both cases, you'll be directed to a new browser tab with this URL. +4. In the `General information` tab, scroll down and click the `vScope`{.action} link. -![vscope](images/vScope12.png){.thumbnail} +![vScope](images/gatewayPCC.png){.thumbnail} -Use your vSphere **username** and **password** to log on the interface. +The interface opens in a new tab in your browser. -![vscope](images/vScope11.png){.thumbnail} +![vScope](images/vScope12.png){.thumbnail} -You are now connected to **vScope** and can monitor your resources. For example, you can see in the main window the number of Cores and VMs on each host as well as CPU and RAM consumption or network traffic. +Log in with your **user** and **password** - the same credentials you use to connect to the vSphere client. -![vscope](images/vScope.png){.thumbnail} +![vScope](images/vScope11.png){.thumbnail} -In case of multiple **datacenters** inside a single **Hosted Private Cloud**, you can select them in the scrolling menu. **Last refresh** is the last **web page** refresh, not the **vScope** one. vScope refreshes every **2 to 5 minutes**. +You are now connected to **vScope**. This page centralises the key information about your resources. -![vscope](images/vScope1.png){.thumbnail} +For example, for each host, you can immediately view: -The **Filer** menu gives an insight on datastore usage in terms of VMs and storage space. +- The number of cores and VMs +- CPU and RAM usage +- Network traffic + +![vScope](images/vScope.png){.thumbnail} + +### Browsing vScope + +#### Selecting the datacenter + +If your Hosted Private Cloud contains several datacenters, select the one you want to display from the drop-down menu. -![vscope](images/vScope2.png){.thumbnail} +The **Last refresh** field corresponds to the last refresh of the web page, not of vScope data. vScope data is automatically updated every 2 to 5 minutes. -Clicking on the **Graphs** icon, you can see more details on the chosen resource. +![vScope](images/vScope1.png){.thumbnail} -![vscope](images/vScope7.png){.thumbnail} +#### Filer menu -The Hosts menu offers all the characteristics for each host in your datacenter (**Cores, vCPUs, VM**) and the usage percentage as well as network connectivity on all physical network cards (**VMNic**). +The **Filer** menu shows the usage of your datastores: number of virtual machines and consumed storage space. -![vscope](images/vScope4.png){.thumbnail} +Use this view to anticipate extension needs or monitor load balancing. -The detailed view also shows historical data over a day, week, month or year as needed. +![vScope](images/vScope2.png){.thumbnail} -![vscope](images/vScope8.png){.thumbnail} +### Hosts menu -The last section details each VM's usage with the following data : +The **Hosts** menu details the characteristics of each host in your datacenter: -- VMtools state +- Number of cores, vCPUs and VMs +- CPU and RAM usage percentages +- Network connectivity +- Number of physical network cards (VMNic) + +![vScope](images/vScope4.png){.thumbnail} + +### Virtual machines menu + +This section provides a detailed view of each virtual machine: + +- Status of VMware Tools - Network traffic - VM size -- FT (Fault Tolerance) activation state +- FT (Fault Tolerance) activation - CPU Ready Time - Disk IO -- Disk Latency +- Disk latency -![vscope](images/vScope6.png){.thumbnail} +![vScope](images/vScope6.png){.thumbnail} ## Go further -Join our community of users on . +If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. + +Join our [community of users](/links/community). diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.fr-ca.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.fr-ca.md index fe7adeae608..17d8cc94cd5 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.fr-ca.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.fr-ca.md @@ -1,72 +1,90 @@ --- title: "Comprendre l'interface vScope" excerpt: "Découvrez comment utiliser l'interface vScope pour surveiller votre infrastructure" -updated: 2022-01-28 +updated: 2025-10-01 --- ## Objectif -OVHcloud vous met à disposition un outil de **supervision** et **monitoring** de vos machines virtuelles et de votre infrastructure qui se nomme **vScope**. +OVHcloud met à votre disposition un outil de **supervision** et de **monitoring** de vos machines virtuelles et de votre infrastructure : **vScope**. -Il s’agit d’une page web où sont rassemblées toutes les informations **utiles** sur vos ressources. +Cette interface web rassemble toutes les informations essentielles sur vos ressources. -**Ce guide décrit la lecture de l'interface vScope.** +**Ce guide explique comment lire et utiliser l'interface vScope.** ## Prérequis -- Être contact administrateur de l'infrastructure [Hosted Private Cloud](https://www.ovhcloud.com/fr-ca/enterprise/products/hosted-private-cloud/), afin de recevoir des identifiants de connexion. -- Avoir un identifiant utilisateur actif (créé dans l'[espace client OVHcloud](/links/manager)) +- Être contact administrateur de l'infrastructure [Hosted Private Cloud](/links/hosted-private-cloud/vmware), afin de recevoir des identifiants de connexion. +- Disposer d’un identifiant utilisateur actif (créé dans l’[espace client OVHcloud](/links/manager)). ## En pratique -Pour accèder à l'interface vScope, rendez vous sur le portail de votre Hosted Private Cloud et cliquez sur l'icone vScope. +### Accéder à vScope -![vScope](images/gatewayPCC.png){.thumbnail} +1. Dans l’[espace client OVHcloud](/links/manager), cliquez sur `Hosted Private Cloud`{.action}. + +2. Dans le menu de gauche, sélectionnez `Managed VMware vSphere`{.action}. + +3. Choisissez votre service PCC. -Un lien d'accès à l'interface **vScope** est aussi disponible dans votre espace client OVHcloud. +4. Dans l’onglet `Informations générales`{.action}, descendez puis cliquez sur le lien `vScope`{.action}. -![vScope](images/managerLink.png){.thumbnail} +![vScope](images/gatewayPCC.png){.thumbnail} -Dans les deux cas, vous ouvrirez un nouvel onglet dans votre navigateur avec cette URL. +L’interface s’ouvre dans un nouvel onglet de votre navigateur. ![vScope](images/vScope12.png){.thumbnail} -Munissez-vous de votre **utilisateur** et votre **mot de passe**, servant habituellement à la connexion de votre client vSphere, afin de vous connecter à cette interface. +Identifiez-vous avec votre **utilisateur** et votre **mot de passe**, les mêmes que ceux utilisés pour vous connecter au client vSphere. ![vScope](images/vScope11.png){.thumbnail} -Vous êtes maintenant connecté sur la page de votre **vScope** qui regroupe l'ensemble des informations utiles de vos ressources. Par exemple, pour chaque host, vous visualisez immédiatement le nombre de Cores et de VM, la charge CPU et RAM, ainsi que le trafic réseau. +Vous êtes désormais connecté à **vScope**. Cette page centralise les informations clés de vos ressources. + +Par exemple, pour chaque hôte, vous visualisez immédiatement : +- le nombre de cœurs et de VM +- la charge CPU et RAM +- le trafic réseau ![vScope](images/vScope.png){.thumbnail} -Nous allons détailler chaque élément de cette page. +### Navigation dans vScope + +#### Choix du datacenter -En cas de différents **data-centres** dans un même **Hosted Private Cloud**, vous pouvez le choisir dans le menu déroulant. Concernant le **Last refresh**, il correspond au dernier rafraîchissement de la **page Web** et non du **vScope** qui lui est mis à jour toutes les **2 à 5 minutes**. +Si votre Hosted Private Cloud contient plusieurs datacenters, sélectionnez celui que vous souhaitez afficher dans le menu déroulant. + +Le champ **Last refresh** correspond au dernier rafraîchissement de la page web (et non du vScope). Les données vScope sont mises à jour automatiquement toutes les 2 à 5 minutes. ![vScope](images/vScope1.png){.thumbnail} -Le menu **Filer** renseigne sur l'utilisation de vos data-stores, que ce soit au niveau du nombre de machines virtuelles ainsi que de l'espace consommé. +#### Menu Filer + +Le menu **Filer** indique l’utilisation de vos datastores : nombre de machines virtuelles et espace consommé. + +Utilisez cette vue pour anticiper un besoin d’extension ou surveiller l’équilibre de charge. ![vScope](images/vScope2.png){.thumbnail} -En cliquant sur l'icône **Graphs**, vous pouvez obtenir des données **précises** concernant la ressource. +### Menu Hosts -![vScope](images/vScope7.png){.thumbnail} +Le menu **Hosts** détaille les caractéristiques de chaque hôte dans votre datacenter : -Le menu pour les hosts affiche en détails les caractéristiques de chaque host dans votre data-centre (**Cores, vCPUs, VM**) ainsi que leurs pourcentages d'utilisation et enfin la connectivité réseau et le nombre de cartes réseau physiques (**VMNic**). +- nombre de cœurs, vCPUs et VM +- pourcentage d’utilisation CPU et RAM +- connectivité réseau +- nombre de cartes réseau physiques (VMNic) ![vScope](images/vScope4.png){.thumbnail} -Voici la page qui détaille précisément la ressource. Vous avez également accès à un historique d’utilisation sur un jour, une semaine, un mois ou même un an. +### Menu Machines virtuelles -![vScope](images/vScope8.png){.thumbnail} +Cette section fournit une vue détaillée de chaque machine virtuelle : -Voici la dernière catégorie qui détaille l'utilisation de chaque **machine virtuelle** dans votre data-centre avec notamment les informations suivantes : - -- Etat des VMtools +- État des VMware Tools - Trafic réseau - Taille de la VM -- Activation FT (Fault Tolerance) +- Activation de FT (Fault Tolerance) - CPU Ready Time - Disk IO - Disk Latency @@ -75,4 +93,6 @@ Voici la dernière catégorie qui détaille l'utilisation de chaque **machine vi ## Aller plus loin +Si vous avez besoin d'une formation ou d'une assistance technique pour la mise en oeuvre de nos solutions, contactez votre commercial ou cliquez sur [ce lien](/links/professional-services) pour obtenir un devis et demander une analyse personnalisée de votre projet à nos experts de l’équipe Professional Services. + Échangez avec notre [communauté d'utilisateurs](/links/community). diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.fr-fr.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.fr-fr.md index fc728a1428e..9c434ac5014 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.fr-fr.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.fr-fr.md @@ -1,72 +1,90 @@ --- title: "Comprendre l'interface vScope" excerpt: "Découvrez comment utiliser l'interface vScope pour surveiller votre infrastructure" -updated: 2022-01-28 +updated: 2025-10-01 --- ## Objectif -OVHcloud vous met à disposition un outil de **supervision** et **monitoring** de vos machines virtuelles et de votre infrastructure qui se nomme **vScope**. +OVHcloud met à votre disposition un outil de **supervision** et de **monitoring** de vos machines virtuelles et de votre infrastructure : **vScope**. -Il s’agit d’une page web où sont rassemblées toutes les informations **utiles** sur vos ressources. +Cette interface web rassemble toutes les informations essentielles sur vos ressources. -**Ce guide décrit la lecture de l'interface vScope.** +**Ce guide explique comment lire et utiliser l'interface vScope.** ## Prérequis -- Être contact administrateur de l'infrastructure [Hosted Private Cloud](https://www.ovhcloud.com/fr/enterprise/products/hosted-private-cloud/), afin de recevoir des identifiants de connexion. -- Avoir un identifiant utilisateur actif (créé dans l'[espace client OVHcloud](/links/manager)) +- Être contact administrateur de l'infrastructure [Hosted Private Cloud](/links/hosted-private-cloud/vmware), afin de recevoir des identifiants de connexion. +- Disposer d’un identifiant utilisateur actif (créé dans l’[espace client OVHcloud](/links/manager)). ## En pratique -Pour accèder à l'interface vScope, rendez vous sur le portail de votre Hosted Private Cloud et cliquez sur l'icone vScope. +### Accéder à vScope -![vScope](images/gatewayPCC.png){.thumbnail} +1. Dans l’[espace client OVHcloud](/links/manager), cliquez sur `Hosted Private Cloud`{.action}. + +2. Dans le menu de gauche, sélectionnez `Managed VMware vSphere`{.action}. + +3. Choisissez votre service PCC. -Un lien d'accès à l'interface **vScope** est aussi disponible dans votre espace client OVHcloud. +4. Dans l’onglet `Informations générales`{.action}, descendez puis cliquez sur le lien `vScope`{.action}. -![vScope](images/managerLink.png){.thumbnail} +![vScope](images/gatewayPCC.png){.thumbnail} -Dans les deux cas, vous ouvrirez un nouvel onglet dans votre navigateur avec cette URL. +L’interface s’ouvre dans un nouvel onglet de votre navigateur. ![vScope](images/vScope12.png){.thumbnail} -Munissez-vous de votre **utilisateur** et votre **mot de passe**, servant habituellement à la connexion de votre client vSphere, afin de vous connecter à cette interface. +Identifiez-vous avec votre **utilisateur** et votre **mot de passe**, les mêmes que ceux utilisés pour vous connecter au client vSphere. ![vScope](images/vScope11.png){.thumbnail} -Vous êtes maintenant connecté sur la page de votre **vScope** qui regroupe l'ensemble des informations utiles de vos ressources. Par exemple, pour chaque host, vous visualisez immédiatement le nombre de Cores et de VM, la charge CPU et RAM, ainsi que le trafic réseau. +Vous êtes désormais connecté à **vScope**. Cette page centralise les informations clés de vos ressources. + +Par exemple, pour chaque hôte, vous visualisez immédiatement : +- le nombre de cœurs et de VM +- la charge CPU et RAM +- le trafic réseau ![vScope](images/vScope.png){.thumbnail} -Nous allons détailler chaque élément de cette page. +### Navigation dans vScope + +#### Choix du datacenter -En cas de différents **data-centres** dans un même **Hosted Private Cloud**, vous pouvez le choisir dans le menu déroulant. Concernant le **Last refresh**, il correspond au dernier rafraîchissement de la **page Web** et non du **vScope** qui lui est mis à jour toutes les **2 à 5 minutes**. +Si votre Hosted Private Cloud contient plusieurs datacenters, sélectionnez celui que vous souhaitez afficher dans le menu déroulant. + +Le champ **Last refresh** correspond au dernier rafraîchissement de la page web (et non du vScope). Les données vScope sont mises à jour automatiquement toutes les 2 à 5 minutes. ![vScope](images/vScope1.png){.thumbnail} -Le menu **Filer** renseigne sur l'utilisation de vos data-stores, que ce soit au niveau du nombre de machines virtuelles ainsi que de l'espace consommé. +#### Menu Filer + +Le menu **Filer** indique l’utilisation de vos datastores : nombre de machines virtuelles et espace consommé. + +Utilisez cette vue pour anticiper un besoin d’extension ou surveiller l’équilibre de charge. ![vScope](images/vScope2.png){.thumbnail} -En cliquant sur l'icône **Graphs**, vous pouvez obtenir des données **précises** concernant la ressource. +### Menu Hosts -![vScope](images/vScope7.png){.thumbnail} +Le menu **Hosts** détaille les caractéristiques de chaque hôte dans votre datacenter : -Le menu pour les hosts affiche en détails les caractéristiques de chaque host dans votre data-centre (**Cores, vCPUs, VM**) ainsi que leurs pourcentages d'utilisation et enfin la connectivité réseau et le nombre de cartes réseau physiques (**VMNic**). +- nombre de cœurs, vCPUs et VM +- pourcentage d’utilisation CPU et RAM +- connectivité réseau +- nombre de cartes réseau physiques (VMNic) ![vScope](images/vScope4.png){.thumbnail} -Voici la page qui détaille précisément la ressource. Vous avez également accès à un historique d’utilisation sur un jour, une semaine, un mois ou même un an. +### Menu Machines virtuelles -![vScope](images/vScope8.png){.thumbnail} +Cette section fournit une vue détaillée de chaque machine virtuelle : -Voici la dernière catégorie qui détaille l'utilisation de chaque **machine virtuelle** dans votre data-centre avec notamment les informations suivantes : - -- Etat des VMtools +- État des VMware Tools - Trafic réseau - Taille de la VM -- Activation FT (Fault Tolerance) +- Activation de FT (Fault Tolerance) - CPU Ready Time - Disk IO - Disk Latency @@ -75,4 +93,6 @@ Voici la dernière catégorie qui détaille l'utilisation de chaque **machine vi ## Aller plus loin -Échangez avec notre [communauté d'utilisateurs](/links/community). +Si vous avez besoin d'une formation ou d'une assistance technique pour la mise en oeuvre de nos solutions, contactez votre commercial ou cliquez sur [ce lien](/links/professional-services) pour obtenir un devis et demander une analyse personnalisée de votre projet à nos experts de l’équipe Professional Services. + +Échangez avec notre [communauté d'utilisateurs](/links/community). \ No newline at end of file diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.it-it.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.it-it.md index 49c9911b006..74eaa59efe7 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.it-it.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.it-it.md @@ -1,76 +1,99 @@ --- title: "Capire l'interfaccia vScope (EN)" excerpt: The vScope interface allows you to monitor your infrastructure -updated: 2022-01-28 +updated: 2025-10-01 --- ## Objective -OVHcloud puts an infrastructure **supervision** and **monitoring** tool called **vScope** at your disposal. +OVHcloud provides you with a **supervision** and **monitoring** tool for your virtual machines and infrastructure: **vScope**. -It's a web based utility gathering and presenting all the **useful** information on your resources. +This web interface gathers all the essential information about your resources. -**This guide describes the functionalities of the vScope interface.** +**This guide explains how to read and use the vScope interface.** ## Requirements -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/it/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account (created in the [OVHcloud Control Panel](/links/manager)) +- You must be an administrator contact of the [Hosted Private Cloud](/links/hosted-private-cloud/vmware) infrastructure, in order to receive login credentials. +- An active user ID (created in the [OVHcloud Control Panel](/links/manager)). ## Instructions -To access the vScope interface, click the vScope icon in the login window of your Hosted Private Cloud. +### Accessing vScope -![vscope access](images/gatewayPCC.png){.thumbnail} +1. In the [OVHcloud Control Panel](/links/manager), click `Hosted Private Cloud`{.action}. -A **vScope** access link is also available in your OVHcloud Control Panel. +2. In the left-hand menu, click `Managed VMware vSphere`{.action}. -![vscope access](images/managerLink.png){.thumbnail} +3. Select your PCC service. -In both cases, you'll be directed to a new browser tab with this URL. +4. In the `General information` tab, scroll down and click the `vScope`{.action} link. -![vscope](images/vScope12.png){.thumbnail} +![vScope](images/gatewayPCC.png){.thumbnail} -Use your vSphere **username** and **password** to log on the interface. +The interface opens in a new tab in your browser. -![vscope](images/vScope11.png){.thumbnail} +![vScope](images/vScope12.png){.thumbnail} -You are now connected to **vScope** and can monitor your resources. For example, you can see in the main window the number of Cores and VMs on each host as well as CPU and RAM consumption or network traffic. +Log in with your **user** and **password** - the same credentials you use to connect to the vSphere client. -![vscope](images/vScope.png){.thumbnail} +![vScope](images/vScope11.png){.thumbnail} -In case of multiple **datacenters** inside a single **Hosted Private Cloud**, you can select them in the scrolling menu. **Last refresh** is the last **web page** refresh, not the **vScope** one. vScope refreshes every **2 to 5 minutes**. +You are now connected to **vScope**. This page centralises the key information about your resources. -![vscope](images/vScope1.png){.thumbnail} +For example, for each host, you can immediately view: -The **Filer** menu gives an insight on datastore usage in terms of VMs and storage space. +- The number of cores and VMs +- CPU and RAM usage +- Network traffic + +![vScope](images/vScope.png){.thumbnail} + +### Browsing vScope + +#### Selecting the datacenter + +If your Hosted Private Cloud contains several datacenters, select the one you want to display from the drop-down menu. -![vscope](images/vScope2.png){.thumbnail} +The **Last refresh** field corresponds to the last refresh of the web page, not of vScope data. vScope data is automatically updated every 2 to 5 minutes. -Clicking on the **Graphs** icon, you can see more details on the chosen resource. +![vScope](images/vScope1.png){.thumbnail} -![vscope](images/vScope7.png){.thumbnail} +#### Filer menu -The Hosts menu offers all the characteristics for each host in your datacenter (**Cores, vCPUs, VM**) and the usage percentage as well as network connectivity on all physical network cards (**VMNic**). +The **Filer** menu shows the usage of your datastores: number of virtual machines and consumed storage space. -![vscope](images/vScope4.png){.thumbnail} +Use this view to anticipate extension needs or monitor load balancing. -The detailed view also shows historical data over a day, week, month or year as needed. +![vScope](images/vScope2.png){.thumbnail} -![vscope](images/vScope8.png){.thumbnail} +### Hosts menu -The last section details each VM's usage with the following data : +The **Hosts** menu details the characteristics of each host in your datacenter: -- VMtools state +- Number of cores, vCPUs and VMs +- CPU and RAM usage percentages +- Network connectivity +- Number of physical network cards (VMNic) + +![vScope](images/vScope4.png){.thumbnail} + +### Virtual machines menu + +This section provides a detailed view of each virtual machine: + +- Status of VMware Tools - Network traffic - VM size -- FT (Fault Tolerance) activation state +- FT (Fault Tolerance) activation - CPU Ready Time - Disk IO -- Disk Latency +- Disk latency -![vscope](images/vScope6.png){.thumbnail} +![vScope](images/vScope6.png){.thumbnail} ## Go further -Join our community of users on . +If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. + +Join our [community of users](/links/community). diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.pl-pl.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.pl-pl.md index 3ea55440e85..7d543735ee0 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.pl-pl.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.pl-pl.md @@ -1,77 +1,99 @@ --- title: Poznaj interfejs vScope (EN) excerpt: The vScope interface allows you to monitor your infrastructure -updated: 2022-01-28 +updated: 2025-10-01 --- ## Objective -OVHcloud puts an infrastructure **supervision** and **monitoring** tool called **vScope** at your disposal. +OVHcloud provides you with a **supervision** and **monitoring** tool for your virtual machines and infrastructure: **vScope**. -It's a web based utility gathering and presenting all the **useful** information on your resources. +This web interface gathers all the essential information about your resources. -**This guide describes the functionalities of the vScope interface.** +**This guide explains how to read and use the vScope interface.** ## Requirements -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/pl/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account (created in the [OVHcloud Control Panel](/links/manager)) +- You must be an administrator contact of the [Hosted Private Cloud](/links/hosted-private-cloud/vmware) infrastructure, in order to receive login credentials. +- An active user ID (created in the [OVHcloud Control Panel](/links/manager)). ## Instructions -To access the vScope interface, click the vScope icon in the login window of your Hosted Private Cloud. +### Accessing vScope -![vscope access](images/gatewayPCC.png){.thumbnail} +1. In the [OVHcloud Control Panel](/links/manager), click `Hosted Private Cloud`{.action}. -A **vScope** access link is also available in your OVHcloud Control Panel. +2. In the left-hand menu, click `Managed VMware vSphere`{.action}. -![vscope access](images/managerLink.png){.thumbnail} +3. Select your PCC service. -In both cases, you'll be directed to a new browser tab with this URL. +4. In the `General information` tab, scroll down and click the `vScope`{.action} link. -![vscope](images/vScope12.png){.thumbnail} +![vScope](images/gatewayPCC.png){.thumbnail} -Use your vSphere **username** and **password** to log on the interface. +The interface opens in a new tab in your browser. -![vscope](images/vScope11.png){.thumbnail} +![vScope](images/vScope12.png){.thumbnail} -You are now connected to **vScope** and can monitor your resources. For example, you can see in the main window the number of Cores and VMs on each host as well as CPU and RAM consumption or network traffic. +Log in with your **user** and **password** - the same credentials you use to connect to the vSphere client. -![vscope](images/vScope.png){.thumbnail} +![vScope](images/vScope11.png){.thumbnail} -In case of multiple **datacenters** inside a single **Hosted Private Cloud**, you can select them in the scrolling menu. **Last refresh** is the last **web page** refresh, not the **vScope** one. vScope refreshes every **2 to 5 minutes**. +You are now connected to **vScope**. This page centralises the key information about your resources. -![vscope](images/vScope1.png){.thumbnail} +For example, for each host, you can immediately view: -The **Filer** menu gives an insight on datastore usage in terms of VMs and storage space. +- The number of cores and VMs +- CPU and RAM usage +- Network traffic + +![vScope](images/vScope.png){.thumbnail} + +### Browsing vScope + +#### Selecting the datacenter + +If your Hosted Private Cloud contains several datacenters, select the one you want to display from the drop-down menu. + +The **Last refresh** field corresponds to the last refresh of the web page, not of vScope data. vScope data is automatically updated every 2 to 5 minutes. + +![vScope](images/vScope1.png){.thumbnail} + +#### Filer menu + +The **Filer** menu shows the usage of your datastores: number of virtual machines and consumed storage space. -![vscope](images/vScope2.png){.thumbnail} +Use this view to anticipate extension needs or monitor load balancing. -Clicking on the **Graphs** icon, you can see more details on the chosen resource. +![vScope](images/vScope2.png){.thumbnail} -![vscope](images/vScope7.png){.thumbnail} +### Hosts menu -The Hosts menu offers all the characteristics for each host in your datacenter (**Cores, vCPUs, VM**) and the usage percentage as well as network connectivity on all physical network cards (**VMNic**). +The **Hosts** menu details the characteristics of each host in your datacenter: -![vscope](images/vScope4.png){.thumbnail} +- Number of cores, vCPUs and VMs +- CPU and RAM usage percentages +- Network connectivity +- Number of physical network cards (VMNic) -The detailed view also shows historical data over a day, week, month or year as needed. +![vScope](images/vScope4.png){.thumbnail} -![vscope](images/vScope8.png){.thumbnail} +### Virtual machines menu -The last section details each VM's usage with the following data : +This section provides a detailed view of each virtual machine: -- VMtools state +- Status of VMware Tools - Network traffic - VM size -- FT (Fault Tolerance) activation state +- FT (Fault Tolerance) activation - CPU Ready Time - Disk IO -- Disk Latency +- Disk latency -![vscope](images/vScope6.png){.thumbnail} +![vScope](images/vScope6.png){.thumbnail} ## Go further -Join our community of users on . +If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. +Join our [community of users](/links/community). diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.pt-pt.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.pt-pt.md index 567f6f08f2d..b3ae60f8ec7 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.pt-pt.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/guide.pt-pt.md @@ -1,76 +1,99 @@ --- title: Compreender a interface vScope (EN) excerpt: The vScope interface allows you to monitor your infrastructure -updated: 2022-01-28 +updated: 2025-10-01 --- ## Objective -OVHcloud puts an infrastructure **supervision** and **monitoring** tool called **vScope** at your disposal. +OVHcloud provides you with a **supervision** and **monitoring** tool for your virtual machines and infrastructure: **vScope**. -It's a web based utility gathering and presenting all the **useful** information on your resources. +This web interface gathers all the essential information about your resources. -**This guide describes the functionalities of the vScope interface.** +**This guide explains how to read and use the vScope interface.** ## Requirements -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/pt/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account (created in the [OVHcloud Control Panel](/links/manager)) +- You must be an administrator contact of the [Hosted Private Cloud](/links/hosted-private-cloud/vmware) infrastructure, in order to receive login credentials. +- An active user ID (created in the [OVHcloud Control Panel](/links/manager)). ## Instructions -To access the vScope interface, click the vScope icon in the login window of your Hosted Private Cloud. +### Accessing vScope -![vscope access](images/gatewayPCC.png){.thumbnail} +1. In the [OVHcloud Control Panel](/links/manager), click `Hosted Private Cloud`{.action}. -A **vScope** access link is also available in your OVHcloud Control Panel. +2. In the left-hand menu, click `Managed VMware vSphere`{.action}. -![vscope access](images/managerLink.png){.thumbnail} +3. Select your PCC service. -In both cases, you'll be directed to a new browser tab with this URL. +4. In the `General information` tab, scroll down and click the `vScope`{.action} link. -![vscope](images/vScope12.png){.thumbnail} +![vScope](images/gatewayPCC.png){.thumbnail} -Use your vSphere **username** and **password** to log on the interface. +The interface opens in a new tab in your browser. -![vscope](images/vScope11.png){.thumbnail} +![vScope](images/vScope12.png){.thumbnail} -You are now connected to **vScope** and can monitor your resources. For example, you can see in the main window the number of Cores and VMs on each host as well as CPU and RAM consumption or network traffic. +Log in with your **user** and **password** - the same credentials you use to connect to the vSphere client. -![vscope](images/vScope.png){.thumbnail} +![vScope](images/vScope11.png){.thumbnail} -In case of multiple **datacenters** inside a single **Hosted Private Cloud**, you can select them in the scrolling menu. **Last refresh** is the last **web page** refresh, not the **vScope** one. vScope refreshes every **2 to 5 minutes**. +You are now connected to **vScope**. This page centralises the key information about your resources. -![vscope](images/vScope1.png){.thumbnail} +For example, for each host, you can immediately view: -The **Filer** menu gives an insight on datastore usage in terms of VMs and storage space. +- The number of cores and VMs +- CPU and RAM usage +- Network traffic + +![vScope](images/vScope.png){.thumbnail} + +### Browsing vScope + +#### Selecting the datacenter + +If your Hosted Private Cloud contains several datacenters, select the one you want to display from the drop-down menu. -![vscope](images/vScope2.png){.thumbnail} +The **Last refresh** field corresponds to the last refresh of the web page, not of vScope data. vScope data is automatically updated every 2 to 5 minutes. -Clicking on the **Graphs** icon, you can see more details on the chosen resource. +![vScope](images/vScope1.png){.thumbnail} -![vscope](images/vScope7.png){.thumbnail} +#### Filer menu -The Hosts menu offers all the characteristics for each host in your datacenter (**Cores, vCPUs, VM**) and the usage percentage as well as network connectivity on all physical network cards (**VMNic**). +The **Filer** menu shows the usage of your datastores: number of virtual machines and consumed storage space. -![vscope](images/vScope4.png){.thumbnail} +Use this view to anticipate extension needs or monitor load balancing. -The detailed view also shows historical data over a day, week, month or year as needed. +![vScope](images/vScope2.png){.thumbnail} -![vscope](images/vScope8.png){.thumbnail} +### Hosts menu -The last section details each VM's usage with the following data : +The **Hosts** menu details the characteristics of each host in your datacenter: -- VMtools state +- Number of cores, vCPUs and VMs +- CPU and RAM usage percentages +- Network connectivity +- Number of physical network cards (VMNic) + +![vScope](images/vScope4.png){.thumbnail} + +### Virtual machines menu + +This section provides a detailed view of each virtual machine: + +- Status of VMware Tools - Network traffic - VM size -- FT (Fault Tolerance) activation state +- FT (Fault Tolerance) activation - CPU Ready Time - Disk IO -- Disk Latency +- Disk latency -![vscope](images/vScope6.png){.thumbnail} +![vScope](images/vScope6.png){.thumbnail} ## Go further -Join our community of users on . +If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. + +Join our [community of users](/links/community). diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/images/gatewayPCC.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/images/gatewayPCC.png index 1bbcb43e237..13ced60b9de 100644 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/images/gatewayPCC.png and b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/images/gatewayPCC.png differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/images/img_364.jpg b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/images/img_364.jpg deleted file mode 100644 index 5704e60b59a..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/images/img_364.jpg and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/images/img_366.jpg b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/images/img_366.jpg deleted file mode 100644 index baf0a024dfd..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/images/img_366.jpg and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/images/img_367.jpg b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/images/img_367.jpg deleted file mode 100644 index bb01bd2fb5e..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/images/img_367.jpg and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/images/img_368.jpg b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/images/img_368.jpg deleted file mode 100644 index c06de477204..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/images/img_368.jpg and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/images/managerLink.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/images/managerLink.png deleted file mode 100644 index 49fe2c8399e..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/images/managerLink.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/images/vScope.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/images/vScope.png index 92b2a1bdb7f..86a226ed271 100644 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/images/vScope.png and b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/images/vScope.png differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/images/vScope1.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/images/vScope1.png index f08067392f8..41a9e50b998 100644 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/images/vScope1.png and b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/images/vScope1.png differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/images/vScope10.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/images/vScope10.png deleted file mode 100644 index a8e477438b4..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/images/vScope10.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/images/vScope2.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/images/vScope2.png index e0d15650abb..afe28465393 100644 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/images/vScope2.png and b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/images/vScope2.png differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/images/vScope4.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/images/vScope4.png index 6d8188b5451..b90f1f3b83e 100644 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/images/vScope4.png and b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/images/vScope4.png differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/images/vScope6.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/images/vScope6.png index d85f8d7ad83..df5ac0610b5 100644 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/images/vScope6.png and b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/images/vScope6.png differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/images/vScope7.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/images/vScope7.png deleted file mode 100644 index 8eb4fd8d229..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/images/vScope7.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/images/vScope8.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/images/vScope8.png deleted file mode 100644 index a36a8f04eea..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/how_to_use_vscope/images/vScope8.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/interface-secure/images/passwordReset.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/interface-secure/images/passwordReset.png deleted file mode 100644 index 45361e8faf4..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/interface-secure/images/passwordReset.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/interface-secure/images/startProcess.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/interface-secure/images/startProcess.png deleted file mode 100644 index 76b101a7ca8..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/interface-secure/images/startProcess.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/kms_cipher_trust/images/kms_cipher_trust_vm_07.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/kms_cipher_trust/images/kms_cipher_trust_vm_07.png deleted file mode 100644 index 6a47bc17ce5..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/kms_cipher_trust/images/kms_cipher_trust_vm_07.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/kms_cipher_trust/images/kms_cipher_trust_vm_09.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/kms_cipher_trust/images/kms_cipher_trust_vm_09.png deleted file mode 100644 index cf9c56acc86..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/kms_cipher_trust/images/kms_cipher_trust_vm_09.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.de-de.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.de-de.md index cd4e4eb3302..78f7c0e10e0 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.de-de.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.de-de.md @@ -1,7 +1,7 @@ --- title: "Hosted Private Cloud VMware Lifecycle Policy" excerpt: "Lifecycle policy for VMware on OVHcloud" -updated: 2025-07-18 +updated: 2025-09-24 --- > [!warning] @@ -28,8 +28,6 @@ This lifecycle policy is provided to help clients understand the underlying reas **Hosted Private Cloud VMware on OVHcloud**: -- DC2011 & DC2013 (AMD Opteron, AMD Bulldozer). -- DC2014 & DC2016 (AMD PileDriver). - SDDC2014 & SDDC2016 (Intel Ivy Bridge, Intel Haswell). - SDDC2018 (Intel Broadwell, Intel Haswell). - Essentials (Intel Broadwell). @@ -92,16 +90,12 @@ This table presents a summary of the different phases of the lifecycle of the se ### Hosts (compute) | Commercial Range | General Availability | End of Sales | End of Growth | End of Life | -|:-----------------------------------------------------:|:----------------------:|:------------:|:-------------:|:-----------:| -| DC2011 (AMD Opteron) | 2011 | 2015-02-28 | 2022-02-28 | 2022-09-30 | -| DC2013 (AMD Bulldozer) | 2013 | 2015-02-28 | 2022-02-28 | 2022-09-30 | -| DC2014 (AMD PileDriver) | 2014 | 2017-08-31 | 2022-02-28 | 2022-09-30 | -| DC2016 (AMD PileDriver) | 2016 | 2018-11-30 | 2022-02-28 | 2022-09-30 | -| SDDC2014 & SDDC2016 (Intel Ivy Bridge, Intel Haswell) | 2016 | 2017-04-30 | 2026-03-30 | 2027-07-31 | -| SDDC2018 (Intel Broadwell) | 2018 | 2018-11-30 | 2026-03-30 | 2027-07-31 | -| Essentials (Intel Broadwell) | 2020 | 2026-01-15 | 2026-03-30 | 2027-07-31 | -| Premier (Intel Xeon Gold) | 2020 | 2026-01-15 | | | -| Gen2 hardware (Intel Emerald Rapids) | 2025 | 2026-01-15 | | | +|:-----------------------------------------------------:|:--------------------:|:------------:|:-------------:|:-----------:| +| SDDC2014 & SDDC2016 (Intel Ivy Bridge, Intel Haswell) | 2016 | 2017-04-30 | 2026-03-30 | 2027-07-31 | +| SDDC2018 (Intel Broadwell) | 2018 | 2018-11-30 | 2026-03-30 | 2027-07-31 | +| Essentials (Intel Broadwell) | 2020 | 2026-02-28 | 2026-03-30 | 2027-07-31 | +| Premier (Intel Xeon Gold) | 2020 | 2026-02-28 | 2027-03-31 | 2028-10-31 | +| Gen2 hardware (Intel Emerald Rapids) | 2026 | | | | ## Integrated Software diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.en-asia.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.en-asia.md index cd4e4eb3302..78f7c0e10e0 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.en-asia.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.en-asia.md @@ -1,7 +1,7 @@ --- title: "Hosted Private Cloud VMware Lifecycle Policy" excerpt: "Lifecycle policy for VMware on OVHcloud" -updated: 2025-07-18 +updated: 2025-09-24 --- > [!warning] @@ -28,8 +28,6 @@ This lifecycle policy is provided to help clients understand the underlying reas **Hosted Private Cloud VMware on OVHcloud**: -- DC2011 & DC2013 (AMD Opteron, AMD Bulldozer). -- DC2014 & DC2016 (AMD PileDriver). - SDDC2014 & SDDC2016 (Intel Ivy Bridge, Intel Haswell). - SDDC2018 (Intel Broadwell, Intel Haswell). - Essentials (Intel Broadwell). @@ -92,16 +90,12 @@ This table presents a summary of the different phases of the lifecycle of the se ### Hosts (compute) | Commercial Range | General Availability | End of Sales | End of Growth | End of Life | -|:-----------------------------------------------------:|:----------------------:|:------------:|:-------------:|:-----------:| -| DC2011 (AMD Opteron) | 2011 | 2015-02-28 | 2022-02-28 | 2022-09-30 | -| DC2013 (AMD Bulldozer) | 2013 | 2015-02-28 | 2022-02-28 | 2022-09-30 | -| DC2014 (AMD PileDriver) | 2014 | 2017-08-31 | 2022-02-28 | 2022-09-30 | -| DC2016 (AMD PileDriver) | 2016 | 2018-11-30 | 2022-02-28 | 2022-09-30 | -| SDDC2014 & SDDC2016 (Intel Ivy Bridge, Intel Haswell) | 2016 | 2017-04-30 | 2026-03-30 | 2027-07-31 | -| SDDC2018 (Intel Broadwell) | 2018 | 2018-11-30 | 2026-03-30 | 2027-07-31 | -| Essentials (Intel Broadwell) | 2020 | 2026-01-15 | 2026-03-30 | 2027-07-31 | -| Premier (Intel Xeon Gold) | 2020 | 2026-01-15 | | | -| Gen2 hardware (Intel Emerald Rapids) | 2025 | 2026-01-15 | | | +|:-----------------------------------------------------:|:--------------------:|:------------:|:-------------:|:-----------:| +| SDDC2014 & SDDC2016 (Intel Ivy Bridge, Intel Haswell) | 2016 | 2017-04-30 | 2026-03-30 | 2027-07-31 | +| SDDC2018 (Intel Broadwell) | 2018 | 2018-11-30 | 2026-03-30 | 2027-07-31 | +| Essentials (Intel Broadwell) | 2020 | 2026-02-28 | 2026-03-30 | 2027-07-31 | +| Premier (Intel Xeon Gold) | 2020 | 2026-02-28 | 2027-03-31 | 2028-10-31 | +| Gen2 hardware (Intel Emerald Rapids) | 2026 | | | | ## Integrated Software diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.en-au.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.en-au.md index cd4e4eb3302..78f7c0e10e0 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.en-au.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.en-au.md @@ -1,7 +1,7 @@ --- title: "Hosted Private Cloud VMware Lifecycle Policy" excerpt: "Lifecycle policy for VMware on OVHcloud" -updated: 2025-07-18 +updated: 2025-09-24 --- > [!warning] @@ -28,8 +28,6 @@ This lifecycle policy is provided to help clients understand the underlying reas **Hosted Private Cloud VMware on OVHcloud**: -- DC2011 & DC2013 (AMD Opteron, AMD Bulldozer). -- DC2014 & DC2016 (AMD PileDriver). - SDDC2014 & SDDC2016 (Intel Ivy Bridge, Intel Haswell). - SDDC2018 (Intel Broadwell, Intel Haswell). - Essentials (Intel Broadwell). @@ -92,16 +90,12 @@ This table presents a summary of the different phases of the lifecycle of the se ### Hosts (compute) | Commercial Range | General Availability | End of Sales | End of Growth | End of Life | -|:-----------------------------------------------------:|:----------------------:|:------------:|:-------------:|:-----------:| -| DC2011 (AMD Opteron) | 2011 | 2015-02-28 | 2022-02-28 | 2022-09-30 | -| DC2013 (AMD Bulldozer) | 2013 | 2015-02-28 | 2022-02-28 | 2022-09-30 | -| DC2014 (AMD PileDriver) | 2014 | 2017-08-31 | 2022-02-28 | 2022-09-30 | -| DC2016 (AMD PileDriver) | 2016 | 2018-11-30 | 2022-02-28 | 2022-09-30 | -| SDDC2014 & SDDC2016 (Intel Ivy Bridge, Intel Haswell) | 2016 | 2017-04-30 | 2026-03-30 | 2027-07-31 | -| SDDC2018 (Intel Broadwell) | 2018 | 2018-11-30 | 2026-03-30 | 2027-07-31 | -| Essentials (Intel Broadwell) | 2020 | 2026-01-15 | 2026-03-30 | 2027-07-31 | -| Premier (Intel Xeon Gold) | 2020 | 2026-01-15 | | | -| Gen2 hardware (Intel Emerald Rapids) | 2025 | 2026-01-15 | | | +|:-----------------------------------------------------:|:--------------------:|:------------:|:-------------:|:-----------:| +| SDDC2014 & SDDC2016 (Intel Ivy Bridge, Intel Haswell) | 2016 | 2017-04-30 | 2026-03-30 | 2027-07-31 | +| SDDC2018 (Intel Broadwell) | 2018 | 2018-11-30 | 2026-03-30 | 2027-07-31 | +| Essentials (Intel Broadwell) | 2020 | 2026-02-28 | 2026-03-30 | 2027-07-31 | +| Premier (Intel Xeon Gold) | 2020 | 2026-02-28 | 2027-03-31 | 2028-10-31 | +| Gen2 hardware (Intel Emerald Rapids) | 2026 | | | | ## Integrated Software diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.en-ca.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.en-ca.md index cd4e4eb3302..78f7c0e10e0 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.en-ca.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.en-ca.md @@ -1,7 +1,7 @@ --- title: "Hosted Private Cloud VMware Lifecycle Policy" excerpt: "Lifecycle policy for VMware on OVHcloud" -updated: 2025-07-18 +updated: 2025-09-24 --- > [!warning] @@ -28,8 +28,6 @@ This lifecycle policy is provided to help clients understand the underlying reas **Hosted Private Cloud VMware on OVHcloud**: -- DC2011 & DC2013 (AMD Opteron, AMD Bulldozer). -- DC2014 & DC2016 (AMD PileDriver). - SDDC2014 & SDDC2016 (Intel Ivy Bridge, Intel Haswell). - SDDC2018 (Intel Broadwell, Intel Haswell). - Essentials (Intel Broadwell). @@ -92,16 +90,12 @@ This table presents a summary of the different phases of the lifecycle of the se ### Hosts (compute) | Commercial Range | General Availability | End of Sales | End of Growth | End of Life | -|:-----------------------------------------------------:|:----------------------:|:------------:|:-------------:|:-----------:| -| DC2011 (AMD Opteron) | 2011 | 2015-02-28 | 2022-02-28 | 2022-09-30 | -| DC2013 (AMD Bulldozer) | 2013 | 2015-02-28 | 2022-02-28 | 2022-09-30 | -| DC2014 (AMD PileDriver) | 2014 | 2017-08-31 | 2022-02-28 | 2022-09-30 | -| DC2016 (AMD PileDriver) | 2016 | 2018-11-30 | 2022-02-28 | 2022-09-30 | -| SDDC2014 & SDDC2016 (Intel Ivy Bridge, Intel Haswell) | 2016 | 2017-04-30 | 2026-03-30 | 2027-07-31 | -| SDDC2018 (Intel Broadwell) | 2018 | 2018-11-30 | 2026-03-30 | 2027-07-31 | -| Essentials (Intel Broadwell) | 2020 | 2026-01-15 | 2026-03-30 | 2027-07-31 | -| Premier (Intel Xeon Gold) | 2020 | 2026-01-15 | | | -| Gen2 hardware (Intel Emerald Rapids) | 2025 | 2026-01-15 | | | +|:-----------------------------------------------------:|:--------------------:|:------------:|:-------------:|:-----------:| +| SDDC2014 & SDDC2016 (Intel Ivy Bridge, Intel Haswell) | 2016 | 2017-04-30 | 2026-03-30 | 2027-07-31 | +| SDDC2018 (Intel Broadwell) | 2018 | 2018-11-30 | 2026-03-30 | 2027-07-31 | +| Essentials (Intel Broadwell) | 2020 | 2026-02-28 | 2026-03-30 | 2027-07-31 | +| Premier (Intel Xeon Gold) | 2020 | 2026-02-28 | 2027-03-31 | 2028-10-31 | +| Gen2 hardware (Intel Emerald Rapids) | 2026 | | | | ## Integrated Software diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.en-gb.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.en-gb.md index cd4e4eb3302..78f7c0e10e0 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.en-gb.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.en-gb.md @@ -1,7 +1,7 @@ --- title: "Hosted Private Cloud VMware Lifecycle Policy" excerpt: "Lifecycle policy for VMware on OVHcloud" -updated: 2025-07-18 +updated: 2025-09-24 --- > [!warning] @@ -28,8 +28,6 @@ This lifecycle policy is provided to help clients understand the underlying reas **Hosted Private Cloud VMware on OVHcloud**: -- DC2011 & DC2013 (AMD Opteron, AMD Bulldozer). -- DC2014 & DC2016 (AMD PileDriver). - SDDC2014 & SDDC2016 (Intel Ivy Bridge, Intel Haswell). - SDDC2018 (Intel Broadwell, Intel Haswell). - Essentials (Intel Broadwell). @@ -92,16 +90,12 @@ This table presents a summary of the different phases of the lifecycle of the se ### Hosts (compute) | Commercial Range | General Availability | End of Sales | End of Growth | End of Life | -|:-----------------------------------------------------:|:----------------------:|:------------:|:-------------:|:-----------:| -| DC2011 (AMD Opteron) | 2011 | 2015-02-28 | 2022-02-28 | 2022-09-30 | -| DC2013 (AMD Bulldozer) | 2013 | 2015-02-28 | 2022-02-28 | 2022-09-30 | -| DC2014 (AMD PileDriver) | 2014 | 2017-08-31 | 2022-02-28 | 2022-09-30 | -| DC2016 (AMD PileDriver) | 2016 | 2018-11-30 | 2022-02-28 | 2022-09-30 | -| SDDC2014 & SDDC2016 (Intel Ivy Bridge, Intel Haswell) | 2016 | 2017-04-30 | 2026-03-30 | 2027-07-31 | -| SDDC2018 (Intel Broadwell) | 2018 | 2018-11-30 | 2026-03-30 | 2027-07-31 | -| Essentials (Intel Broadwell) | 2020 | 2026-01-15 | 2026-03-30 | 2027-07-31 | -| Premier (Intel Xeon Gold) | 2020 | 2026-01-15 | | | -| Gen2 hardware (Intel Emerald Rapids) | 2025 | 2026-01-15 | | | +|:-----------------------------------------------------:|:--------------------:|:------------:|:-------------:|:-----------:| +| SDDC2014 & SDDC2016 (Intel Ivy Bridge, Intel Haswell) | 2016 | 2017-04-30 | 2026-03-30 | 2027-07-31 | +| SDDC2018 (Intel Broadwell) | 2018 | 2018-11-30 | 2026-03-30 | 2027-07-31 | +| Essentials (Intel Broadwell) | 2020 | 2026-02-28 | 2026-03-30 | 2027-07-31 | +| Premier (Intel Xeon Gold) | 2020 | 2026-02-28 | 2027-03-31 | 2028-10-31 | +| Gen2 hardware (Intel Emerald Rapids) | 2026 | | | | ## Integrated Software diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.en-ie.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.en-ie.md index cd4e4eb3302..78f7c0e10e0 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.en-ie.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.en-ie.md @@ -1,7 +1,7 @@ --- title: "Hosted Private Cloud VMware Lifecycle Policy" excerpt: "Lifecycle policy for VMware on OVHcloud" -updated: 2025-07-18 +updated: 2025-09-24 --- > [!warning] @@ -28,8 +28,6 @@ This lifecycle policy is provided to help clients understand the underlying reas **Hosted Private Cloud VMware on OVHcloud**: -- DC2011 & DC2013 (AMD Opteron, AMD Bulldozer). -- DC2014 & DC2016 (AMD PileDriver). - SDDC2014 & SDDC2016 (Intel Ivy Bridge, Intel Haswell). - SDDC2018 (Intel Broadwell, Intel Haswell). - Essentials (Intel Broadwell). @@ -92,16 +90,12 @@ This table presents a summary of the different phases of the lifecycle of the se ### Hosts (compute) | Commercial Range | General Availability | End of Sales | End of Growth | End of Life | -|:-----------------------------------------------------:|:----------------------:|:------------:|:-------------:|:-----------:| -| DC2011 (AMD Opteron) | 2011 | 2015-02-28 | 2022-02-28 | 2022-09-30 | -| DC2013 (AMD Bulldozer) | 2013 | 2015-02-28 | 2022-02-28 | 2022-09-30 | -| DC2014 (AMD PileDriver) | 2014 | 2017-08-31 | 2022-02-28 | 2022-09-30 | -| DC2016 (AMD PileDriver) | 2016 | 2018-11-30 | 2022-02-28 | 2022-09-30 | -| SDDC2014 & SDDC2016 (Intel Ivy Bridge, Intel Haswell) | 2016 | 2017-04-30 | 2026-03-30 | 2027-07-31 | -| SDDC2018 (Intel Broadwell) | 2018 | 2018-11-30 | 2026-03-30 | 2027-07-31 | -| Essentials (Intel Broadwell) | 2020 | 2026-01-15 | 2026-03-30 | 2027-07-31 | -| Premier (Intel Xeon Gold) | 2020 | 2026-01-15 | | | -| Gen2 hardware (Intel Emerald Rapids) | 2025 | 2026-01-15 | | | +|:-----------------------------------------------------:|:--------------------:|:------------:|:-------------:|:-----------:| +| SDDC2014 & SDDC2016 (Intel Ivy Bridge, Intel Haswell) | 2016 | 2017-04-30 | 2026-03-30 | 2027-07-31 | +| SDDC2018 (Intel Broadwell) | 2018 | 2018-11-30 | 2026-03-30 | 2027-07-31 | +| Essentials (Intel Broadwell) | 2020 | 2026-02-28 | 2026-03-30 | 2027-07-31 | +| Premier (Intel Xeon Gold) | 2020 | 2026-02-28 | 2027-03-31 | 2028-10-31 | +| Gen2 hardware (Intel Emerald Rapids) | 2026 | | | | ## Integrated Software diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.en-sg.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.en-sg.md index cd4e4eb3302..78f7c0e10e0 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.en-sg.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.en-sg.md @@ -1,7 +1,7 @@ --- title: "Hosted Private Cloud VMware Lifecycle Policy" excerpt: "Lifecycle policy for VMware on OVHcloud" -updated: 2025-07-18 +updated: 2025-09-24 --- > [!warning] @@ -28,8 +28,6 @@ This lifecycle policy is provided to help clients understand the underlying reas **Hosted Private Cloud VMware on OVHcloud**: -- DC2011 & DC2013 (AMD Opteron, AMD Bulldozer). -- DC2014 & DC2016 (AMD PileDriver). - SDDC2014 & SDDC2016 (Intel Ivy Bridge, Intel Haswell). - SDDC2018 (Intel Broadwell, Intel Haswell). - Essentials (Intel Broadwell). @@ -92,16 +90,12 @@ This table presents a summary of the different phases of the lifecycle of the se ### Hosts (compute) | Commercial Range | General Availability | End of Sales | End of Growth | End of Life | -|:-----------------------------------------------------:|:----------------------:|:------------:|:-------------:|:-----------:| -| DC2011 (AMD Opteron) | 2011 | 2015-02-28 | 2022-02-28 | 2022-09-30 | -| DC2013 (AMD Bulldozer) | 2013 | 2015-02-28 | 2022-02-28 | 2022-09-30 | -| DC2014 (AMD PileDriver) | 2014 | 2017-08-31 | 2022-02-28 | 2022-09-30 | -| DC2016 (AMD PileDriver) | 2016 | 2018-11-30 | 2022-02-28 | 2022-09-30 | -| SDDC2014 & SDDC2016 (Intel Ivy Bridge, Intel Haswell) | 2016 | 2017-04-30 | 2026-03-30 | 2027-07-31 | -| SDDC2018 (Intel Broadwell) | 2018 | 2018-11-30 | 2026-03-30 | 2027-07-31 | -| Essentials (Intel Broadwell) | 2020 | 2026-01-15 | 2026-03-30 | 2027-07-31 | -| Premier (Intel Xeon Gold) | 2020 | 2026-01-15 | | | -| Gen2 hardware (Intel Emerald Rapids) | 2025 | 2026-01-15 | | | +|:-----------------------------------------------------:|:--------------------:|:------------:|:-------------:|:-----------:| +| SDDC2014 & SDDC2016 (Intel Ivy Bridge, Intel Haswell) | 2016 | 2017-04-30 | 2026-03-30 | 2027-07-31 | +| SDDC2018 (Intel Broadwell) | 2018 | 2018-11-30 | 2026-03-30 | 2027-07-31 | +| Essentials (Intel Broadwell) | 2020 | 2026-02-28 | 2026-03-30 | 2027-07-31 | +| Premier (Intel Xeon Gold) | 2020 | 2026-02-28 | 2027-03-31 | 2028-10-31 | +| Gen2 hardware (Intel Emerald Rapids) | 2026 | | | | ## Integrated Software diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.en-us.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.en-us.md index cd4e4eb3302..78f7c0e10e0 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.en-us.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.en-us.md @@ -1,7 +1,7 @@ --- title: "Hosted Private Cloud VMware Lifecycle Policy" excerpt: "Lifecycle policy for VMware on OVHcloud" -updated: 2025-07-18 +updated: 2025-09-24 --- > [!warning] @@ -28,8 +28,6 @@ This lifecycle policy is provided to help clients understand the underlying reas **Hosted Private Cloud VMware on OVHcloud**: -- DC2011 & DC2013 (AMD Opteron, AMD Bulldozer). -- DC2014 & DC2016 (AMD PileDriver). - SDDC2014 & SDDC2016 (Intel Ivy Bridge, Intel Haswell). - SDDC2018 (Intel Broadwell, Intel Haswell). - Essentials (Intel Broadwell). @@ -92,16 +90,12 @@ This table presents a summary of the different phases of the lifecycle of the se ### Hosts (compute) | Commercial Range | General Availability | End of Sales | End of Growth | End of Life | -|:-----------------------------------------------------:|:----------------------:|:------------:|:-------------:|:-----------:| -| DC2011 (AMD Opteron) | 2011 | 2015-02-28 | 2022-02-28 | 2022-09-30 | -| DC2013 (AMD Bulldozer) | 2013 | 2015-02-28 | 2022-02-28 | 2022-09-30 | -| DC2014 (AMD PileDriver) | 2014 | 2017-08-31 | 2022-02-28 | 2022-09-30 | -| DC2016 (AMD PileDriver) | 2016 | 2018-11-30 | 2022-02-28 | 2022-09-30 | -| SDDC2014 & SDDC2016 (Intel Ivy Bridge, Intel Haswell) | 2016 | 2017-04-30 | 2026-03-30 | 2027-07-31 | -| SDDC2018 (Intel Broadwell) | 2018 | 2018-11-30 | 2026-03-30 | 2027-07-31 | -| Essentials (Intel Broadwell) | 2020 | 2026-01-15 | 2026-03-30 | 2027-07-31 | -| Premier (Intel Xeon Gold) | 2020 | 2026-01-15 | | | -| Gen2 hardware (Intel Emerald Rapids) | 2025 | 2026-01-15 | | | +|:-----------------------------------------------------:|:--------------------:|:------------:|:-------------:|:-----------:| +| SDDC2014 & SDDC2016 (Intel Ivy Bridge, Intel Haswell) | 2016 | 2017-04-30 | 2026-03-30 | 2027-07-31 | +| SDDC2018 (Intel Broadwell) | 2018 | 2018-11-30 | 2026-03-30 | 2027-07-31 | +| Essentials (Intel Broadwell) | 2020 | 2026-02-28 | 2026-03-30 | 2027-07-31 | +| Premier (Intel Xeon Gold) | 2020 | 2026-02-28 | 2027-03-31 | 2028-10-31 | +| Gen2 hardware (Intel Emerald Rapids) | 2026 | | | | ## Integrated Software diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.es-es.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.es-es.md index cd4e4eb3302..78f7c0e10e0 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.es-es.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.es-es.md @@ -1,7 +1,7 @@ --- title: "Hosted Private Cloud VMware Lifecycle Policy" excerpt: "Lifecycle policy for VMware on OVHcloud" -updated: 2025-07-18 +updated: 2025-09-24 --- > [!warning] @@ -28,8 +28,6 @@ This lifecycle policy is provided to help clients understand the underlying reas **Hosted Private Cloud VMware on OVHcloud**: -- DC2011 & DC2013 (AMD Opteron, AMD Bulldozer). -- DC2014 & DC2016 (AMD PileDriver). - SDDC2014 & SDDC2016 (Intel Ivy Bridge, Intel Haswell). - SDDC2018 (Intel Broadwell, Intel Haswell). - Essentials (Intel Broadwell). @@ -92,16 +90,12 @@ This table presents a summary of the different phases of the lifecycle of the se ### Hosts (compute) | Commercial Range | General Availability | End of Sales | End of Growth | End of Life | -|:-----------------------------------------------------:|:----------------------:|:------------:|:-------------:|:-----------:| -| DC2011 (AMD Opteron) | 2011 | 2015-02-28 | 2022-02-28 | 2022-09-30 | -| DC2013 (AMD Bulldozer) | 2013 | 2015-02-28 | 2022-02-28 | 2022-09-30 | -| DC2014 (AMD PileDriver) | 2014 | 2017-08-31 | 2022-02-28 | 2022-09-30 | -| DC2016 (AMD PileDriver) | 2016 | 2018-11-30 | 2022-02-28 | 2022-09-30 | -| SDDC2014 & SDDC2016 (Intel Ivy Bridge, Intel Haswell) | 2016 | 2017-04-30 | 2026-03-30 | 2027-07-31 | -| SDDC2018 (Intel Broadwell) | 2018 | 2018-11-30 | 2026-03-30 | 2027-07-31 | -| Essentials (Intel Broadwell) | 2020 | 2026-01-15 | 2026-03-30 | 2027-07-31 | -| Premier (Intel Xeon Gold) | 2020 | 2026-01-15 | | | -| Gen2 hardware (Intel Emerald Rapids) | 2025 | 2026-01-15 | | | +|:-----------------------------------------------------:|:--------------------:|:------------:|:-------------:|:-----------:| +| SDDC2014 & SDDC2016 (Intel Ivy Bridge, Intel Haswell) | 2016 | 2017-04-30 | 2026-03-30 | 2027-07-31 | +| SDDC2018 (Intel Broadwell) | 2018 | 2018-11-30 | 2026-03-30 | 2027-07-31 | +| Essentials (Intel Broadwell) | 2020 | 2026-02-28 | 2026-03-30 | 2027-07-31 | +| Premier (Intel Xeon Gold) | 2020 | 2026-02-28 | 2027-03-31 | 2028-10-31 | +| Gen2 hardware (Intel Emerald Rapids) | 2026 | | | | ## Integrated Software diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.es-us.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.es-us.md index cd4e4eb3302..78f7c0e10e0 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.es-us.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.es-us.md @@ -1,7 +1,7 @@ --- title: "Hosted Private Cloud VMware Lifecycle Policy" excerpt: "Lifecycle policy for VMware on OVHcloud" -updated: 2025-07-18 +updated: 2025-09-24 --- > [!warning] @@ -28,8 +28,6 @@ This lifecycle policy is provided to help clients understand the underlying reas **Hosted Private Cloud VMware on OVHcloud**: -- DC2011 & DC2013 (AMD Opteron, AMD Bulldozer). -- DC2014 & DC2016 (AMD PileDriver). - SDDC2014 & SDDC2016 (Intel Ivy Bridge, Intel Haswell). - SDDC2018 (Intel Broadwell, Intel Haswell). - Essentials (Intel Broadwell). @@ -92,16 +90,12 @@ This table presents a summary of the different phases of the lifecycle of the se ### Hosts (compute) | Commercial Range | General Availability | End of Sales | End of Growth | End of Life | -|:-----------------------------------------------------:|:----------------------:|:------------:|:-------------:|:-----------:| -| DC2011 (AMD Opteron) | 2011 | 2015-02-28 | 2022-02-28 | 2022-09-30 | -| DC2013 (AMD Bulldozer) | 2013 | 2015-02-28 | 2022-02-28 | 2022-09-30 | -| DC2014 (AMD PileDriver) | 2014 | 2017-08-31 | 2022-02-28 | 2022-09-30 | -| DC2016 (AMD PileDriver) | 2016 | 2018-11-30 | 2022-02-28 | 2022-09-30 | -| SDDC2014 & SDDC2016 (Intel Ivy Bridge, Intel Haswell) | 2016 | 2017-04-30 | 2026-03-30 | 2027-07-31 | -| SDDC2018 (Intel Broadwell) | 2018 | 2018-11-30 | 2026-03-30 | 2027-07-31 | -| Essentials (Intel Broadwell) | 2020 | 2026-01-15 | 2026-03-30 | 2027-07-31 | -| Premier (Intel Xeon Gold) | 2020 | 2026-01-15 | | | -| Gen2 hardware (Intel Emerald Rapids) | 2025 | 2026-01-15 | | | +|:-----------------------------------------------------:|:--------------------:|:------------:|:-------------:|:-----------:| +| SDDC2014 & SDDC2016 (Intel Ivy Bridge, Intel Haswell) | 2016 | 2017-04-30 | 2026-03-30 | 2027-07-31 | +| SDDC2018 (Intel Broadwell) | 2018 | 2018-11-30 | 2026-03-30 | 2027-07-31 | +| Essentials (Intel Broadwell) | 2020 | 2026-02-28 | 2026-03-30 | 2027-07-31 | +| Premier (Intel Xeon Gold) | 2020 | 2026-02-28 | 2027-03-31 | 2028-10-31 | +| Gen2 hardware (Intel Emerald Rapids) | 2026 | | | | ## Integrated Software diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.fr-ca.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.fr-ca.md index dd810809759..1f3b6c60448 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.fr-ca.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.fr-ca.md @@ -1,7 +1,7 @@ --- title: "Cycle de vie de la solution VMware on OVHcloud" excerpt: "VMware on OVHcloud" -updated: 2025-07-18 +updated: 2025-09-24 --- > [!warning] @@ -28,8 +28,6 @@ Cette politique de cycle de vie est fournie pour aider les clients à comprendre **Hosted Private Cloud VMware on OVHcloud** : -- DC2011 et DC2013 (AMD Opteron, AMD Bulldozer). -- DC2014 & DC2016 (AMD PileDriver). - SDDC2014 et SDDC2016 (Intel Ivy Bridge, Intel Haswell). - SDDC2018 (Intel Broadwell, Intel Haswell). - Essentials (Intel Broadwell). @@ -92,16 +90,12 @@ Le tableau suivant présente un résumé des différentes phases du cycle de vie ### Hôtes (calcul) | Commercial Range | General Availability | End of Sales | End of Growth | End of Life | -|:-----------------------------------------------------:|:----------------------:|:------------:|:-------------:|:-----------:| -| DC2011 (AMD Opteron) | 2011 | 2015-02-28 | 2022-02-28 | 2022-09-30 | -| DC2013 (AMD Bulldozer) | 2013 | 2015-02-28 | 2022-02-28 | 2022-09-30 | -| DC2014 (AMD PileDriver) | 2014 | 2017-08-31 | 2022-02-28 | 2022-09-30 | -| DC2016 (AMD PileDriver) | 2016 | 2018-11-30 | 2022-02-28 | 2022-09-30 | -| SDDC2014 & SDDC2016 (Intel Ivy Bridge, Intel Haswell) | 2016 | 2017-04-30 | 2026-03-30 | 2027-07-31 | -| SDDC2018 (Intel Broadwell) | 2018 | 2018-11-30 | 2026-03-30 | 2027-07-31 | -| Essentials (Intel Broadwell) | 2020 | 2026-01-15 | 2026-03-30 | 2027-07-31 | -| Premier (Intel Xeon Gold) | 2020 | 2026-01-15 | | | -| Gen2 hardware (Intel Emerald Rapids) | 2025 | 2026-01-15 | | | +|:-----------------------------------------------------:|:--------------------:|:------------:|:-------------:|:-----------:| +| SDDC2014 & SDDC2016 (Intel Ivy Bridge, Intel Haswell) | 2016 | 2017-04-30 | 2026-03-30 | 2027-07-31 | +| SDDC2018 (Intel Broadwell) | 2018 | 2018-11-30 | 2026-03-30 | 2027-07-31 | +| Essentials (Intel Broadwell) | 2020 | 2026-02-28 | 2026-03-30 | 2027-07-31 | +| Premier (Intel Xeon Gold) | 2020 | 2026-02-28 | 2027-03-31 | 2028-10-31 | +| Gen2 hardware (Intel Emerald Rapids) | 2026 | | | | ## Logiciels intégrés diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.fr-fr.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.fr-fr.md index dd810809759..1f3b6c60448 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.fr-fr.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.fr-fr.md @@ -1,7 +1,7 @@ --- title: "Cycle de vie de la solution VMware on OVHcloud" excerpt: "VMware on OVHcloud" -updated: 2025-07-18 +updated: 2025-09-24 --- > [!warning] @@ -28,8 +28,6 @@ Cette politique de cycle de vie est fournie pour aider les clients à comprendre **Hosted Private Cloud VMware on OVHcloud** : -- DC2011 et DC2013 (AMD Opteron, AMD Bulldozer). -- DC2014 & DC2016 (AMD PileDriver). - SDDC2014 et SDDC2016 (Intel Ivy Bridge, Intel Haswell). - SDDC2018 (Intel Broadwell, Intel Haswell). - Essentials (Intel Broadwell). @@ -92,16 +90,12 @@ Le tableau suivant présente un résumé des différentes phases du cycle de vie ### Hôtes (calcul) | Commercial Range | General Availability | End of Sales | End of Growth | End of Life | -|:-----------------------------------------------------:|:----------------------:|:------------:|:-------------:|:-----------:| -| DC2011 (AMD Opteron) | 2011 | 2015-02-28 | 2022-02-28 | 2022-09-30 | -| DC2013 (AMD Bulldozer) | 2013 | 2015-02-28 | 2022-02-28 | 2022-09-30 | -| DC2014 (AMD PileDriver) | 2014 | 2017-08-31 | 2022-02-28 | 2022-09-30 | -| DC2016 (AMD PileDriver) | 2016 | 2018-11-30 | 2022-02-28 | 2022-09-30 | -| SDDC2014 & SDDC2016 (Intel Ivy Bridge, Intel Haswell) | 2016 | 2017-04-30 | 2026-03-30 | 2027-07-31 | -| SDDC2018 (Intel Broadwell) | 2018 | 2018-11-30 | 2026-03-30 | 2027-07-31 | -| Essentials (Intel Broadwell) | 2020 | 2026-01-15 | 2026-03-30 | 2027-07-31 | -| Premier (Intel Xeon Gold) | 2020 | 2026-01-15 | | | -| Gen2 hardware (Intel Emerald Rapids) | 2025 | 2026-01-15 | | | +|:-----------------------------------------------------:|:--------------------:|:------------:|:-------------:|:-----------:| +| SDDC2014 & SDDC2016 (Intel Ivy Bridge, Intel Haswell) | 2016 | 2017-04-30 | 2026-03-30 | 2027-07-31 | +| SDDC2018 (Intel Broadwell) | 2018 | 2018-11-30 | 2026-03-30 | 2027-07-31 | +| Essentials (Intel Broadwell) | 2020 | 2026-02-28 | 2026-03-30 | 2027-07-31 | +| Premier (Intel Xeon Gold) | 2020 | 2026-02-28 | 2027-03-31 | 2028-10-31 | +| Gen2 hardware (Intel Emerald Rapids) | 2026 | | | | ## Logiciels intégrés diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.it-it.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.it-it.md index cd4e4eb3302..78f7c0e10e0 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.it-it.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.it-it.md @@ -1,7 +1,7 @@ --- title: "Hosted Private Cloud VMware Lifecycle Policy" excerpt: "Lifecycle policy for VMware on OVHcloud" -updated: 2025-07-18 +updated: 2025-09-24 --- > [!warning] @@ -28,8 +28,6 @@ This lifecycle policy is provided to help clients understand the underlying reas **Hosted Private Cloud VMware on OVHcloud**: -- DC2011 & DC2013 (AMD Opteron, AMD Bulldozer). -- DC2014 & DC2016 (AMD PileDriver). - SDDC2014 & SDDC2016 (Intel Ivy Bridge, Intel Haswell). - SDDC2018 (Intel Broadwell, Intel Haswell). - Essentials (Intel Broadwell). @@ -92,16 +90,12 @@ This table presents a summary of the different phases of the lifecycle of the se ### Hosts (compute) | Commercial Range | General Availability | End of Sales | End of Growth | End of Life | -|:-----------------------------------------------------:|:----------------------:|:------------:|:-------------:|:-----------:| -| DC2011 (AMD Opteron) | 2011 | 2015-02-28 | 2022-02-28 | 2022-09-30 | -| DC2013 (AMD Bulldozer) | 2013 | 2015-02-28 | 2022-02-28 | 2022-09-30 | -| DC2014 (AMD PileDriver) | 2014 | 2017-08-31 | 2022-02-28 | 2022-09-30 | -| DC2016 (AMD PileDriver) | 2016 | 2018-11-30 | 2022-02-28 | 2022-09-30 | -| SDDC2014 & SDDC2016 (Intel Ivy Bridge, Intel Haswell) | 2016 | 2017-04-30 | 2026-03-30 | 2027-07-31 | -| SDDC2018 (Intel Broadwell) | 2018 | 2018-11-30 | 2026-03-30 | 2027-07-31 | -| Essentials (Intel Broadwell) | 2020 | 2026-01-15 | 2026-03-30 | 2027-07-31 | -| Premier (Intel Xeon Gold) | 2020 | 2026-01-15 | | | -| Gen2 hardware (Intel Emerald Rapids) | 2025 | 2026-01-15 | | | +|:-----------------------------------------------------:|:--------------------:|:------------:|:-------------:|:-----------:| +| SDDC2014 & SDDC2016 (Intel Ivy Bridge, Intel Haswell) | 2016 | 2017-04-30 | 2026-03-30 | 2027-07-31 | +| SDDC2018 (Intel Broadwell) | 2018 | 2018-11-30 | 2026-03-30 | 2027-07-31 | +| Essentials (Intel Broadwell) | 2020 | 2026-02-28 | 2026-03-30 | 2027-07-31 | +| Premier (Intel Xeon Gold) | 2020 | 2026-02-28 | 2027-03-31 | 2028-10-31 | +| Gen2 hardware (Intel Emerald Rapids) | 2026 | | | | ## Integrated Software diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.pl-pl.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.pl-pl.md index cd4e4eb3302..78f7c0e10e0 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.pl-pl.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.pl-pl.md @@ -1,7 +1,7 @@ --- title: "Hosted Private Cloud VMware Lifecycle Policy" excerpt: "Lifecycle policy for VMware on OVHcloud" -updated: 2025-07-18 +updated: 2025-09-24 --- > [!warning] @@ -28,8 +28,6 @@ This lifecycle policy is provided to help clients understand the underlying reas **Hosted Private Cloud VMware on OVHcloud**: -- DC2011 & DC2013 (AMD Opteron, AMD Bulldozer). -- DC2014 & DC2016 (AMD PileDriver). - SDDC2014 & SDDC2016 (Intel Ivy Bridge, Intel Haswell). - SDDC2018 (Intel Broadwell, Intel Haswell). - Essentials (Intel Broadwell). @@ -92,16 +90,12 @@ This table presents a summary of the different phases of the lifecycle of the se ### Hosts (compute) | Commercial Range | General Availability | End of Sales | End of Growth | End of Life | -|:-----------------------------------------------------:|:----------------------:|:------------:|:-------------:|:-----------:| -| DC2011 (AMD Opteron) | 2011 | 2015-02-28 | 2022-02-28 | 2022-09-30 | -| DC2013 (AMD Bulldozer) | 2013 | 2015-02-28 | 2022-02-28 | 2022-09-30 | -| DC2014 (AMD PileDriver) | 2014 | 2017-08-31 | 2022-02-28 | 2022-09-30 | -| DC2016 (AMD PileDriver) | 2016 | 2018-11-30 | 2022-02-28 | 2022-09-30 | -| SDDC2014 & SDDC2016 (Intel Ivy Bridge, Intel Haswell) | 2016 | 2017-04-30 | 2026-03-30 | 2027-07-31 | -| SDDC2018 (Intel Broadwell) | 2018 | 2018-11-30 | 2026-03-30 | 2027-07-31 | -| Essentials (Intel Broadwell) | 2020 | 2026-01-15 | 2026-03-30 | 2027-07-31 | -| Premier (Intel Xeon Gold) | 2020 | 2026-01-15 | | | -| Gen2 hardware (Intel Emerald Rapids) | 2025 | 2026-01-15 | | | +|:-----------------------------------------------------:|:--------------------:|:------------:|:-------------:|:-----------:| +| SDDC2014 & SDDC2016 (Intel Ivy Bridge, Intel Haswell) | 2016 | 2017-04-30 | 2026-03-30 | 2027-07-31 | +| SDDC2018 (Intel Broadwell) | 2018 | 2018-11-30 | 2026-03-30 | 2027-07-31 | +| Essentials (Intel Broadwell) | 2020 | 2026-02-28 | 2026-03-30 | 2027-07-31 | +| Premier (Intel Xeon Gold) | 2020 | 2026-02-28 | 2027-03-31 | 2028-10-31 | +| Gen2 hardware (Intel Emerald Rapids) | 2026 | | | | ## Integrated Software diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.pt-pt.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.pt-pt.md index cd4e4eb3302..78f7c0e10e0 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.pt-pt.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/lifecycle_policy/guide.pt-pt.md @@ -1,7 +1,7 @@ --- title: "Hosted Private Cloud VMware Lifecycle Policy" excerpt: "Lifecycle policy for VMware on OVHcloud" -updated: 2025-07-18 +updated: 2025-09-24 --- > [!warning] @@ -28,8 +28,6 @@ This lifecycle policy is provided to help clients understand the underlying reas **Hosted Private Cloud VMware on OVHcloud**: -- DC2011 & DC2013 (AMD Opteron, AMD Bulldozer). -- DC2014 & DC2016 (AMD PileDriver). - SDDC2014 & SDDC2016 (Intel Ivy Bridge, Intel Haswell). - SDDC2018 (Intel Broadwell, Intel Haswell). - Essentials (Intel Broadwell). @@ -92,16 +90,12 @@ This table presents a summary of the different phases of the lifecycle of the se ### Hosts (compute) | Commercial Range | General Availability | End of Sales | End of Growth | End of Life | -|:-----------------------------------------------------:|:----------------------:|:------------:|:-------------:|:-----------:| -| DC2011 (AMD Opteron) | 2011 | 2015-02-28 | 2022-02-28 | 2022-09-30 | -| DC2013 (AMD Bulldozer) | 2013 | 2015-02-28 | 2022-02-28 | 2022-09-30 | -| DC2014 (AMD PileDriver) | 2014 | 2017-08-31 | 2022-02-28 | 2022-09-30 | -| DC2016 (AMD PileDriver) | 2016 | 2018-11-30 | 2022-02-28 | 2022-09-30 | -| SDDC2014 & SDDC2016 (Intel Ivy Bridge, Intel Haswell) | 2016 | 2017-04-30 | 2026-03-30 | 2027-07-31 | -| SDDC2018 (Intel Broadwell) | 2018 | 2018-11-30 | 2026-03-30 | 2027-07-31 | -| Essentials (Intel Broadwell) | 2020 | 2026-01-15 | 2026-03-30 | 2027-07-31 | -| Premier (Intel Xeon Gold) | 2020 | 2026-01-15 | | | -| Gen2 hardware (Intel Emerald Rapids) | 2025 | 2026-01-15 | | | +|:-----------------------------------------------------:|:--------------------:|:------------:|:-------------:|:-----------:| +| SDDC2014 & SDDC2016 (Intel Ivy Bridge, Intel Haswell) | 2016 | 2017-04-30 | 2026-03-30 | 2027-07-31 | +| SDDC2018 (Intel Broadwell) | 2018 | 2018-11-30 | 2026-03-30 | 2027-07-31 | +| Essentials (Intel Broadwell) | 2020 | 2026-02-28 | 2026-03-30 | 2027-07-31 | +| Premier (Intel Xeon Gold) | 2020 | 2026-02-28 | 2027-03-31 | 2028-10-31 | +| Gen2 hardware (Intel Emerald Rapids) | 2026 | | | | ## Integrated Software diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud/images/backup.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud/images/backup.png deleted file mode 100644 index ef444d6d03f..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud/images/backup.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud/images/buttondots.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud/images/buttondots.png deleted file mode 100644 index 2df3de4e0f5..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud/images/buttondots.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud/images/buttonpen.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud/images/buttonpen.png deleted file mode 100644 index b3d71c2d3e8..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud/images/buttonpen.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud/images/datacenter.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud/images/datacenter.png deleted file mode 100644 index de6595ada60..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud/images/datacenter.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud/images/datacenter_view.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud/images/datacenter_view.png deleted file mode 100644 index 5c5dbc6def4..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud/images/datacenter_view.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud/images/datastores.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud/images/datastores.png deleted file mode 100644 index a18086721eb..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud/images/datastores.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud/images/hosts.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud/images/hosts.png deleted file mode 100644 index 5c4d8874c60..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud/images/hosts.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud/images/manager_general.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud/images/manager_general.png deleted file mode 100644 index e88a56932cb..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud/images/manager_general.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud/images/options.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud/images/options.png deleted file mode 100644 index 1060e71c5b3..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud/images/options.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud/images/options_activation.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud/images/options_activation.png deleted file mode 100644 index 51345927131..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud/images/options_activation.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud/images/rights_user_datacenters.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud/images/rights_user_datacenters.png deleted file mode 100644 index 4250d2def21..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud/images/rights_user_datacenters.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud/images/security.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud/images/security.png deleted file mode 100644 index 5f87be0669e..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud/images/security.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud/images/security_options.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud/images/security_options.png deleted file mode 100644 index 9333896b23b..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud/images/security_options.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud/images/windows_licence.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud/images/windows_licence.png deleted file mode 100644 index 5ea43441f3b..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud/images/windows_licence.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/modify_hardware_configuration_of_vm/images/add_ressources_cd_dvd.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/modify_hardware_configuration_of_vm/images/add_ressources_cd_dvd.png deleted file mode 100644 index 57e775b0044..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/modify_hardware_configuration_of_vm/images/add_ressources_cd_dvd.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/modify_hardware_configuration_of_vm/images/add_ressources_cpu.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/modify_hardware_configuration_of_vm/images/add_ressources_cpu.png deleted file mode 100644 index acb9834f048..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/modify_hardware_configuration_of_vm/images/add_ressources_cpu.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/modify_hardware_configuration_of_vm/images/add_ressources_disk.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/modify_hardware_configuration_of_vm/images/add_ressources_disk.png deleted file mode 100644 index d74acb4fe79..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/modify_hardware_configuration_of_vm/images/add_ressources_disk.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/modify_hardware_configuration_of_vm/images/add_ressources_edit.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/modify_hardware_configuration_of_vm/images/add_ressources_edit.png deleted file mode 100644 index 0b3fff5dbda..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/modify_hardware_configuration_of_vm/images/add_ressources_edit.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/modify_hardware_configuration_of_vm/images/add_ressources_network.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/modify_hardware_configuration_of_vm/images/add_ressources_network.png deleted file mode 100644 index 7a079d0eb99..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/modify_hardware_configuration_of_vm/images/add_ressources_network.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/modify_hardware_configuration_of_vm/images/add_ressources_new_device.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/modify_hardware_configuration_of_vm/images/add_ressources_new_device.png deleted file mode 100644 index b51f2e636b2..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/modify_hardware_configuration_of_vm/images/add_ressources_new_device.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/modify_hardware_configuration_of_vm/images/add_ressources_ram.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/modify_hardware_configuration_of_vm/images/add_ressources_ram.png deleted file mode 100644 index c459e6c1b9b..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/modify_hardware_configuration_of_vm/images/add_ressources_ram.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/modify_hardware_configuration_of_vm/images/add_ressources_video.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/modify_hardware_configuration_of_vm/images/add_ressources_video.png deleted file mode 100644 index 93e2d8ea0d4..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/modify_hardware_configuration_of_vm/images/add_ressources_video.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx-05-manage-distributed-firewall/images/01-create-tag-on-segment05.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx-05-manage-distributed-firewall/images/01-create-tag-on-segment05.png deleted file mode 100644 index b4be5bcdc0a..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx-05-manage-distributed-firewall/images/01-create-tag-on-segment05.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx-05-manage-distributed-firewall/images/01-create-tag-on-segment06.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx-05-manage-distributed-firewall/images/01-create-tag-on-segment06.png deleted file mode 100644 index 15f35fa1eb1..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx-05-manage-distributed-firewall/images/01-create-tag-on-segment06.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx-05-manage-distributed-firewall/images/06-create-distributed-firewall-rules15.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx-05-manage-distributed-firewall/images/06-create-distributed-firewall-rules15.png deleted file mode 100644 index 284e744107c..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx-05-manage-distributed-firewall/images/06-create-distributed-firewall-rules15.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx-06-manage-gateway-firewall/images/01-create-gateway-firewall-rules08.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx-06-manage-gateway-firewall/images/01-create-gateway-firewall-rules08.png deleted file mode 100644 index 00ea9767c1b..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx-06-manage-gateway-firewall/images/01-create-gateway-firewall-rules08.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx-09-configure-loadbalancing/images/06-add-virtual-server04.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx-09-configure-loadbalancing/images/06-add-virtual-server04.png deleted file mode 100644 index eb1742dce1f..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx-09-configure-loadbalancing/images/06-add-virtual-server04.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx-10-add-new-tier1-gateway/images/02-add-segment-on-new-gw04.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx-10-add-new-tier1-gateway/images/02-add-segment-on-new-gw04.png deleted file mode 100644 index 1f5ce1ace08..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx-10-add-new-tier1-gateway/images/02-add-segment-on-new-gw04.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx-13-filter-logs/guide.en-gb.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx-13-filter-logs/guide.en-gb.md new file mode 100644 index 00000000000..f8b8ce4ddf3 --- /dev/null +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx-13-filter-logs/guide.en-gb.md @@ -0,0 +1,110 @@ +--- +title: 'How to read and filter NSX-T logs' +excerpt: 'Learn how to access and filter NSX-T firewall logs to troubleshoot blocked traffic on your Hosted Private Cloud.' +updated: 2025-10-15 +--- + +## Objective + +This guide explains how to extract and analyze key information from NSX-T logs to troubleshoot blocked traffic or monitor firewall activity on your Hosted Private Cloud. + +## Requirements + +- Access to the vSphere interface +- Access to the [OVHcloud Control Panel](/links/manager) with NSX-T enabled, or to your Syslog/log aggregation system +- Basic understanding of NSX-T firewalling and network traffic + +## Instructions + +### Step 1: Identify useful log fields + +When inspecting logs, focus on the following elements: + +| Field | Description | +|----------------|--------------------------------------------------------| +| Timestamp | Time when the event occurred | +| Action | Whether traffic was allowed or dropped (ALLOW or DROP) | +| Rule ID | ID of the NSX-T rule that matched the traffic | +| Source IP | Origin IP address | +| Destination IP | Target IP address | +| Protocol | Protocol used such as TCP, UDP, or ICMP | + +> [!primary] +> The mentioned fields are usually sufficient to identify the most common connectivity issues. + +*Optional: Source and destination ports can help identify application specific issues.* + +### Step 2: Access the logs from a Syslog server + +If NSX-T is configured to forward logs externally: + +1. Connect to your Syslog or log aggregation platform +2. Filter entries using fields such as `DROP`, `ruleId`, `src`, `dst`, `proto`, or `dport` + +Example log lines: + +```bash +ALLOW ruleId=202 src=10.0.0.15 dst=192.168.2.20 proto=UDP dport=53 +DROP ruleId=101 src=192.168.1.10 dst=10.0.0.5 proto=TCP dport=44 +``` + +### Step 3: Filter and analyze logs + +Depending on your toolchain: + +- Use `Log Insight`{.action} to create filters and dashboards +- In tools like Graylog, ELK, or Splunk, build queries to focus on dropped traffic or specific rule IDs +- From CLI exports, filter using: + +```bash +grep "DROP" nsx-logs.log | awk '{print $1, $3, $5, $7}' +``` + +### Advanced: Improving readability in Graylog + +To make NSX-T firewall logs easier to read and closer to the simplicity of NSX-V format, you can configure Graylog extractors and dashboards: + +1. **Create a dedicated input stream** + + Configure a Graylog stream to capture only NSX-T firewall logs (`facility=local6` and `comp="nsx-edge"`) to isolate them from other system messages. + +2. **Normalize timestamps and hosts** + + Use Graylog extractors to clean the raw syslog format, keeping only the event timestamp (e.g. `2024-03-18T06:29:50.837Z`) and source hostname (e.g. `edge27-857b.rbx1a.pcc.ovh.net`). + +3. **Parse firewall action and rule ID** + + Apply a Grok or regex extractor to split entries such as `INET TERM PASS 2025 OUT TCP` into structured fields: + + - `Action = PASS / DROP` + - `Rule ID = 2025` + - `Direction = OUT` + - `Protocol = TCP` + +4. **Extract source and destination fields** + + Parse the IPs and ports (e.g. `10.216.242.234/61790 -> 10.216.240.19/3128`) into structured Graylog fields: + + - `src_ip`, `src_port` + - `dst_ip`, `dst_port` + +5. **Drop useless metadata** + + Remove verbose attributes such as `[nsx@6876 comp="nsx-edge" ...]` that do not help troubleshooting. This keeps logs leaner and more readable. + +6. **Build a simplified log view/dashboard** + + Create a Graylog dashboard showing only the essential fields (Date, Action, Rule ID, Source, Destination, Protocol). + + This replicates the clarity of NSX-V logs and speeds up troubleshooting. + +## Go further + +- [VMware NSX-T official documentation](https://docs.vmware.com/en/VMware-NSX-T-Data-Center/index.html) +- [How to configure Syslog in NSX-T](https://kb.vmware.com/s/article/74656) + +If you require training or technical assistance in implementing our solutions, contact your sales representative or [click here](/links/professional-services) for a quote and request a custom analysis of your project from our Professional Services team experts. + +Ask questions, give your feedback and interact directly with the team building our Hosted Private Cloud services on the dedicated [Discord channel](https://discord.gg/ovhcloud). + +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx-13-filter-logs/guide.fr-fr.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx-13-filter-logs/guide.fr-fr.md new file mode 100644 index 00000000000..70b58a62fac --- /dev/null +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx-13-filter-logs/guide.fr-fr.md @@ -0,0 +1,109 @@ +--- +title: "Comment lire et filtrer les logs NSX-T" +excerpt: "Découvrez comment accéder aux logs du pare-feu NSX-T et les filtrer afin de résoudre les problèmes de trafic bloqué sur votre Hosted Private Cloud" +updated: 2025-10-15 +--- + +## Objectif + +Ce guide explique comment extraire et analyser les informations clés des logs NSX-T pour dépanner le trafic bloqué ou surveiller l'activité du pare-feu sur votre Hosted Private Cloud. + +## Prérequis + +- Disposer d'un accès à l'interface vSphere +- Être connecté à l'[espace client OVHcloud](/links/manager) avec NSX-T activé, ou à votre système Syslog ou plateforme d’agrégation de logs +- Des connaissances de base du pare-feu NSX-T et du trafic réseau + +## En pratique + +### Étape 1 : Identifier les champs de logs utiles + +Lors de l'inspection des logs, concentrez-vous sur les éléments suivants : + +| Champ | Description | +|----------------|---------------------------------------------------------------| +| Timestamp | Heure à laquelle l'événement est survenu | +| Action | Indique si le trafic a été autorisé ou bloqué (ALLOW ou DROP) | +| Rule ID | Identifiant de la règle NSX-T correspondant au trafic | +| Source IP | Adresse IP d'origine | +| Destination IP | Adresse IP cible | +| Protocol | Protocole utilisé, tel que TCP, UDP ou ICMP | + +> [!primary] +> Ces champs sont généralement suffisants pour identifier les problèmes de connectivité les plus courants. + +*Facultatif : les ports source et de destination peuvent aider à identifier les problèmes spécifiques aux applications.* + +### Étape 2 : Accéder aux logs depuis un serveur Syslog + +Si NSX-T est configuré pour transférer les logs vers l’extérieur : + +1. Connectez-vous à votre plateforme Syslog ou à votre agrégateur de logs. +2. Filtrez les entrées à l’aide de champs tels que `DROP`, `ruleId`, `src`, `dst`, `proto` ou `dport`. + +Exemples de lignes de logs : + +```bash +ALLOW ruleId=202 src=10.0.0.15 dst=192.168.2.20 proto=UDP dport=53 +DROP ruleId=101 src=192.168.1.10 dst=10.0.0.5 proto=TCP dport=443 +``` + +### Étape 3 : Filtrer et analyser les logs + +En fonction de votre outil : + +- Avec `Log Insight`{.action}, créez des filtres et des tableaux de bord. +- Avec Graylog, ELK ou Splunk, utilisez des requêtes pour cibler le trafic bloqué ou certains Rule ID. +- Depuis un export CLI, filtrez avec : + +```bash +grep "DROP" nsx-logs.log | awk '{print $1, $3, $5, $7}' +``` +### Avancé : Améliorer la lisibilité dans Graylog + +Pour rendre les logs de pare-feu NSX-T plus faciles à lire et plus proches de la simplicité du format NSX-V, vous pouvez configurer des extracteurs et des tableaux de bord dans Graylog : + +1. **Créer un flux d’entrée dédié** + + Configurez un flux Graylog pour capturer uniquement les logs de pare-feu NSX-T (`facility=local6` et `comp="nsx-edge"`) afin de les isoler des autres messages système. + +2. **Normaliser les horodatages et les hôtes** + + Utilisez des extracteurs Graylog pour nettoyer le format brut des logs syslog, en conservant uniquement l’horodatage de l’événement (par ex. : `2024-03-18T06:29:50.837Z`) et le nom d’hôte source (par ex. : `edge27-857b.rbx1a.pcc.ovh.net`). + +3. **Analyser l’action du pare-feu et l’ID de règle** + + Appliquez un extracteur Grok ou regex pour découper des entrées comme `INET TERM PASS 2025 OUT TCP` en champs structurés : + + - `Action = PASS / DROP` + - `Rule ID = 2025` + - `Direction = OUT` + - `Protocol = TCP` + +4. **Extraire les champs source et destination** + + Analysez les adresses IP et ports (par ex. : `10.216.242.234/61790 -> 10.216.240.19/3128`) en champs Graylog structurés : + + - `src_ip`, `src_port` + - `dst_ip`, `dst_port` + +5. **Supprimer les métadonnées inutiles** + + Retirez les attributs verbeux tels que `[nsx@6876 comp="nsx-edge" ...]` qui n’apportent aucune valeur pour le dépannage. Cela permet d’alléger les logs et de les rendre plus lisibles. + +6. **Créer une vue/console simplifiée des logs** + + Créez un tableau de bord Graylog affichant uniquement les champs essentiels (Date, Action, Rule ID, Source, Destination, Protocol). + + Cela reproduit la clarté des logs NSX-V et accélère le dépannage. + +## Aller plus loin + +- [Documentation officielle de VMware NSX-T](https://docs.vmware.com/fr/VMware-NSX-T-Data-Center/index.html) +- [How to Configure Syslog in NSX-T](https://kb.vmware.com/s/article/74656) + +Si vous rencontrez des difficultés avec le réseau au sein de VCD on OVHcloud, consultez le guide « [VMware Cloud Director on OVHcloud - Network Concepts](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_network_concepts) ». + +Si vous avez besoin d'une formation ou d'une assistance technique pour la mise en oeuvre de nos solutions, contactez votre commercial ou [cliquez ici](/links/professional-services) pour obtenir un devis et demander une analyse personnalisée de votre projet à nos experts de l’équipe Professional Services. + +Posez des questions, donnez votre avis et interagissez directement avec l’équipe qui construit nos services Hosted Private Cloud sur [Discord](https://discord.gg/ovhcloud). \ No newline at end of file diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx-13-filter-logs/meta.yaml b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx-13-filter-logs/meta.yaml new file mode 100644 index 00000000000..1b1332b8528 --- /dev/null +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx-13-filter-logs/meta.yaml @@ -0,0 +1,2 @@ +id: 81944247-28f3-4c75-88e8-d9350c19a8b0 +full_slug: vmware-nsx-filter-logs \ No newline at end of file diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_access-interface/images/AccueilWeb.PNG b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_access-interface/images/AccueilWeb.PNG deleted file mode 100644 index d8ba1e9fb69..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_access-interface/images/AccueilWeb.PNG and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_access-interface/images/content-docs-cloud-private-cloud-nsx_connect_interface-images-interface_nsx_2.JPG b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_access-interface/images/content-docs-cloud-private-cloud-nsx_connect_interface-images-interface_nsx_2.JPG deleted file mode 100644 index 308b0692d56..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_access-interface/images/content-docs-cloud-private-cloud-nsx_connect_interface-images-interface_nsx_2.JPG and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_access-interface/images/content-docs-cloud-private-cloud-nsx_connect_interface-images-interface_nsx_2.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_access-interface/images/content-docs-cloud-private-cloud-nsx_connect_interface-images-interface_nsx_2.png deleted file mode 100644 index 2339e255379..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_access-interface/images/content-docs-cloud-private-cloud-nsx_connect_interface-images-interface_nsx_2.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_access-interface/images/nsx01.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_access-interface/images/nsx01.png deleted file mode 100644 index 336dd09efe6..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_access-interface/images/nsx01.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.de-de.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.de-de.md index 1b449235cbc..24cd1506b61 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.de-de.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.de-de.md @@ -47,7 +47,7 @@ Click on Hosted Private Cloud.

- OVHcloud direct link: https://www.ovh.com/manager/#/dedicated/dedicated_cloud/PCC-XXX-XXX-XXX-XXX > Replace PCC-XXX-XXX-XXX-XXX with the name of your PCC service. -

NSX screenshot

+

NSX screenshot

@@ -63,9 +63,9 @@ On the previously opened page, edit the user with whom you want to access the NS

Click on: VMware > PCC-XX-XX-XX-X > Users > Edit. Activate the button NSX Interface. -

NSX screenshot

-

NSX screenshot

-

NSX screenshot

+

NSX screenshot

+

NSX screenshot

+

NSX screenshot

@@ -78,7 +78,7 @@ Click on: VMware > PCC-XX-XX-XX Click on: VMware > PCC-XX-XX-XX-XX > Users > Edit. -

NSX screenshot

+

NSX screenshot

@@ -102,7 +102,7 @@ Only access to V(X)LANs in Read-onlyRead-only mode.

If you want to make changes in the NSX-T web interface, then additional rights will be required, such as Operator or Administrator. -

NSX screenshot

+

NSX screenshot

### Step 5 - Access NSX-T @@ -110,19 +110,19 @@ If you want to make changes in the NSX-T web interface, then additional rights w #### In the OVHcloud Control Panel
->How to access the NSX-T web console +How to access the NSX-T web console In your Hosted Private Cloud tree view, click VMware > PCC-XX-XX-XX-XX.

- OVHcloud direct link: https://www.ovh.com/manager/#/dedicated/dedicated_cloud/PCC-XX-XX-XX-X > Replace PCC-XX-XX-XX-X with the name of your PCC service.

-NSX screenshot +NSX screenshot

-NSX screenshot +NSX screenshot

-NSX screenshot +NSX screenshot

-NSX screenshot +NSX screenshot
diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.en-asia.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.en-asia.md index ea83fa7d9c3..bd4875c9a6f 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.en-asia.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.en-asia.md @@ -47,7 +47,7 @@ Click on Hosted Private Cloud.

- OVHcloud direct link: https://www.ovh.com/manager/#/dedicated/dedicated_cloud/PCC-XXX-XXX-XXX-XXX > Replace PCC-XXX-XXX-XXX-XXX with the name of your PCC service. -

NSX screenshot

+

NSX screenshot

@@ -63,9 +63,9 @@ On the previously opened page, edit the user with whom you want to access the NS

Click on: VMware > PCC-XX-XX-XX-X > Users > Edit. Activate the button NSX Interface. -

NSX screenshot

-

NSX screenshot

-

NSX screenshot

+

NSX screenshot

+

NSX screenshot

+

NSX screenshot

@@ -78,7 +78,7 @@ Click on: VMware > PCC-XX-XX-XX Click on: VMware > PCC-XX-XX-XX-XX > Users > Edit. -

NSX screenshot

+

NSX screenshot

@@ -102,7 +102,7 @@ Only access to V(X)LANs in Read-onlyRead-only mode.

If you want to make changes in the NSX-T web interface, then additional rights will be required, such as Operator or Administrator. -

NSX screenshot

+

NSX screenshot

### Step 5 - Access NSX-T @@ -110,19 +110,19 @@ If you want to make changes in the NSX-T web interface, then additional rights w #### In the OVHcloud Control Panel
->How to access the NSX-T web console +How to access the NSX-T web console In your Hosted Private Cloud tree view, click VMware > PCC-XX-XX-XX-XX.

- OVHcloud direct link: https://www.ovh.com/manager/#/dedicated/dedicated_cloud/PCC-XX-XX-XX-X > Replace PCC-XX-XX-XX-X with the name of your PCC service.

-NSX screenshot +NSX screenshot

-NSX screenshot +NSX screenshot

-NSX screenshot +NSX screenshot

-NSX screenshot +NSX screenshot
diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.en-au.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.en-au.md index ea83fa7d9c3..bd4875c9a6f 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.en-au.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.en-au.md @@ -47,7 +47,7 @@ Click on Hosted Private Cloud.

- OVHcloud direct link: https://www.ovh.com/manager/#/dedicated/dedicated_cloud/PCC-XXX-XXX-XXX-XXX > Replace PCC-XXX-XXX-XXX-XXX with the name of your PCC service. -

NSX screenshot

+

NSX screenshot

@@ -63,9 +63,9 @@ On the previously opened page, edit the user with whom you want to access the NS

Click on: VMware > PCC-XX-XX-XX-X > Users > Edit. Activate the button NSX Interface. -

NSX screenshot

-

NSX screenshot

-

NSX screenshot

+

NSX screenshot

+

NSX screenshot

+

NSX screenshot

@@ -78,7 +78,7 @@ Click on: VMware > PCC-XX-XX-XX Click on: VMware > PCC-XX-XX-XX-XX > Users > Edit. -

NSX screenshot

+

NSX screenshot

@@ -102,7 +102,7 @@ Only access to V(X)LANs in Read-onlyRead-only mode.

If you want to make changes in the NSX-T web interface, then additional rights will be required, such as Operator or Administrator. -

NSX screenshot

+

NSX screenshot

### Step 5 - Access NSX-T @@ -110,19 +110,19 @@ If you want to make changes in the NSX-T web interface, then additional rights w #### In the OVHcloud Control Panel
->How to access the NSX-T web console +How to access the NSX-T web console In your Hosted Private Cloud tree view, click VMware > PCC-XX-XX-XX-XX.

- OVHcloud direct link: https://www.ovh.com/manager/#/dedicated/dedicated_cloud/PCC-XX-XX-XX-X > Replace PCC-XX-XX-XX-X with the name of your PCC service.

-NSX screenshot +NSX screenshot

-NSX screenshot +NSX screenshot

-NSX screenshot +NSX screenshot

-NSX screenshot +NSX screenshot
diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.en-ca.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.en-ca.md index ea83fa7d9c3..bd4875c9a6f 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.en-ca.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.en-ca.md @@ -47,7 +47,7 @@ Click on Hosted Private Cloud.

- OVHcloud direct link: https://www.ovh.com/manager/#/dedicated/dedicated_cloud/PCC-XXX-XXX-XXX-XXX > Replace PCC-XXX-XXX-XXX-XXX with the name of your PCC service. -

NSX screenshot

+

NSX screenshot

@@ -63,9 +63,9 @@ On the previously opened page, edit the user with whom you want to access the NS

Click on: VMware > PCC-XX-XX-XX-X > Users > Edit. Activate the button NSX Interface. -

NSX screenshot

-

NSX screenshot

-

NSX screenshot

+

NSX screenshot

+

NSX screenshot

+

NSX screenshot

@@ -78,7 +78,7 @@ Click on: VMware > PCC-XX-XX-XX Click on: VMware > PCC-XX-XX-XX-XX > Users > Edit. -

NSX screenshot

+

NSX screenshot

@@ -102,7 +102,7 @@ Only access to V(X)LANs in Read-onlyRead-only mode.

If you want to make changes in the NSX-T web interface, then additional rights will be required, such as Operator or Administrator. -

NSX screenshot

+

NSX screenshot

### Step 5 - Access NSX-T @@ -110,19 +110,19 @@ If you want to make changes in the NSX-T web interface, then additional rights w #### In the OVHcloud Control Panel
->How to access the NSX-T web console +How to access the NSX-T web console In your Hosted Private Cloud tree view, click VMware > PCC-XX-XX-XX-XX.

- OVHcloud direct link: https://www.ovh.com/manager/#/dedicated/dedicated_cloud/PCC-XX-XX-XX-X > Replace PCC-XX-XX-XX-X with the name of your PCC service.

-NSX screenshot +NSX screenshot

-NSX screenshot +NSX screenshot

-NSX screenshot +NSX screenshot

-NSX screenshot +NSX screenshot
diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.en-gb.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.en-gb.md index ea83fa7d9c3..bd4875c9a6f 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.en-gb.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.en-gb.md @@ -47,7 +47,7 @@ Click on Hosted Private Cloud.

- OVHcloud direct link: https://www.ovh.com/manager/#/dedicated/dedicated_cloud/PCC-XXX-XXX-XXX-XXX > Replace PCC-XXX-XXX-XXX-XXX with the name of your PCC service. -

NSX screenshot

+

NSX screenshot

@@ -63,9 +63,9 @@ On the previously opened page, edit the user with whom you want to access the NS

Click on: VMware > PCC-XX-XX-XX-X > Users > Edit. Activate the button NSX Interface. -

NSX screenshot

-

NSX screenshot

-

NSX screenshot

+

NSX screenshot

+

NSX screenshot

+

NSX screenshot

@@ -78,7 +78,7 @@ Click on: VMware > PCC-XX-XX-XX Click on: VMware > PCC-XX-XX-XX-XX > Users > Edit. -

NSX screenshot

+

NSX screenshot

@@ -102,7 +102,7 @@ Only access to V(X)LANs in Read-onlyRead-only mode.

If you want to make changes in the NSX-T web interface, then additional rights will be required, such as Operator or Administrator. -

NSX screenshot

+

NSX screenshot

### Step 5 - Access NSX-T @@ -110,19 +110,19 @@ If you want to make changes in the NSX-T web interface, then additional rights w #### In the OVHcloud Control Panel
->How to access the NSX-T web console +How to access the NSX-T web console In your Hosted Private Cloud tree view, click VMware > PCC-XX-XX-XX-XX.

- OVHcloud direct link: https://www.ovh.com/manager/#/dedicated/dedicated_cloud/PCC-XX-XX-XX-X > Replace PCC-XX-XX-XX-X with the name of your PCC service.

-NSX screenshot +NSX screenshot

-NSX screenshot +NSX screenshot

-NSX screenshot +NSX screenshot

-NSX screenshot +NSX screenshot
diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.en-ie.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.en-ie.md index ea83fa7d9c3..bd4875c9a6f 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.en-ie.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.en-ie.md @@ -47,7 +47,7 @@ Click on Hosted Private Cloud.

- OVHcloud direct link: https://www.ovh.com/manager/#/dedicated/dedicated_cloud/PCC-XXX-XXX-XXX-XXX > Replace PCC-XXX-XXX-XXX-XXX with the name of your PCC service. -

NSX screenshot

+

NSX screenshot

@@ -63,9 +63,9 @@ On the previously opened page, edit the user with whom you want to access the NS

Click on: VMware > PCC-XX-XX-XX-X > Users > Edit. Activate the button NSX Interface. -

NSX screenshot

-

NSX screenshot

-

NSX screenshot

+

NSX screenshot

+

NSX screenshot

+

NSX screenshot

@@ -78,7 +78,7 @@ Click on: VMware > PCC-XX-XX-XX Click on: VMware > PCC-XX-XX-XX-XX > Users > Edit. -

NSX screenshot

+

NSX screenshot

@@ -102,7 +102,7 @@ Only access to V(X)LANs in Read-onlyRead-only mode.

If you want to make changes in the NSX-T web interface, then additional rights will be required, such as Operator or Administrator. -

NSX screenshot

+

NSX screenshot

### Step 5 - Access NSX-T @@ -110,19 +110,19 @@ If you want to make changes in the NSX-T web interface, then additional rights w #### In the OVHcloud Control Panel
->How to access the NSX-T web console +How to access the NSX-T web console In your Hosted Private Cloud tree view, click VMware > PCC-XX-XX-XX-XX.

- OVHcloud direct link: https://www.ovh.com/manager/#/dedicated/dedicated_cloud/PCC-XX-XX-XX-X > Replace PCC-XX-XX-XX-X with the name of your PCC service.

-NSX screenshot +NSX screenshot

-NSX screenshot +NSX screenshot

-NSX screenshot +NSX screenshot

-NSX screenshot +NSX screenshot
diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.en-sg.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.en-sg.md index ea83fa7d9c3..bd4875c9a6f 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.en-sg.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.en-sg.md @@ -47,7 +47,7 @@ Click on Hosted Private Cloud.

- OVHcloud direct link: https://www.ovh.com/manager/#/dedicated/dedicated_cloud/PCC-XXX-XXX-XXX-XXX > Replace PCC-XXX-XXX-XXX-XXX with the name of your PCC service. -

NSX screenshot

+

NSX screenshot

@@ -63,9 +63,9 @@ On the previously opened page, edit the user with whom you want to access the NS

Click on: VMware > PCC-XX-XX-XX-X > Users > Edit. Activate the button NSX Interface. -

NSX screenshot

-

NSX screenshot

-

NSX screenshot

+

NSX screenshot

+

NSX screenshot

+

NSX screenshot

@@ -78,7 +78,7 @@ Click on: VMware > PCC-XX-XX-XX Click on: VMware > PCC-XX-XX-XX-XX > Users > Edit. -

NSX screenshot

+

NSX screenshot

@@ -102,7 +102,7 @@ Only access to V(X)LANs in Read-onlyRead-only mode.

If you want to make changes in the NSX-T web interface, then additional rights will be required, such as Operator or Administrator. -

NSX screenshot

+

NSX screenshot

### Step 5 - Access NSX-T @@ -110,19 +110,19 @@ If you want to make changes in the NSX-T web interface, then additional rights w #### In the OVHcloud Control Panel
->How to access the NSX-T web console +How to access the NSX-T web console In your Hosted Private Cloud tree view, click VMware > PCC-XX-XX-XX-XX.

- OVHcloud direct link: https://www.ovh.com/manager/#/dedicated/dedicated_cloud/PCC-XX-XX-XX-X > Replace PCC-XX-XX-XX-X with the name of your PCC service.

-NSX screenshot +NSX screenshot

-NSX screenshot +NSX screenshot

-NSX screenshot +NSX screenshot

-NSX screenshot +NSX screenshot
diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.en-us.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.en-us.md index ea83fa7d9c3..bd4875c9a6f 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.en-us.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.en-us.md @@ -47,7 +47,7 @@ Click on Hosted Private Cloud.

- OVHcloud direct link: https://www.ovh.com/manager/#/dedicated/dedicated_cloud/PCC-XXX-XXX-XXX-XXX > Replace PCC-XXX-XXX-XXX-XXX with the name of your PCC service. -

NSX screenshot

+

NSX screenshot

@@ -63,9 +63,9 @@ On the previously opened page, edit the user with whom you want to access the NS

Click on: VMware > PCC-XX-XX-XX-X > Users > Edit. Activate the button NSX Interface. -

NSX screenshot

-

NSX screenshot

-

NSX screenshot

+

NSX screenshot

+

NSX screenshot

+

NSX screenshot

@@ -78,7 +78,7 @@ Click on: VMware > PCC-XX-XX-XX Click on: VMware > PCC-XX-XX-XX-XX > Users > Edit. -

NSX screenshot

+

NSX screenshot

@@ -102,7 +102,7 @@ Only access to V(X)LANs in Read-onlyRead-only mode.

If you want to make changes in the NSX-T web interface, then additional rights will be required, such as Operator or Administrator. -

NSX screenshot

+

NSX screenshot

### Step 5 - Access NSX-T @@ -110,19 +110,19 @@ If you want to make changes in the NSX-T web interface, then additional rights w #### In the OVHcloud Control Panel
->How to access the NSX-T web console +How to access the NSX-T web console In your Hosted Private Cloud tree view, click VMware > PCC-XX-XX-XX-XX.

- OVHcloud direct link: https://www.ovh.com/manager/#/dedicated/dedicated_cloud/PCC-XX-XX-XX-X > Replace PCC-XX-XX-XX-X with the name of your PCC service.

-NSX screenshot +NSX screenshot

-NSX screenshot +NSX screenshot

-NSX screenshot +NSX screenshot

-NSX screenshot +NSX screenshot
diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.es-es.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.es-es.md index 1b449235cbc..24cd1506b61 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.es-es.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.es-es.md @@ -47,7 +47,7 @@ Click on Hosted Private Cloud.

- OVHcloud direct link: https://www.ovh.com/manager/#/dedicated/dedicated_cloud/PCC-XXX-XXX-XXX-XXX > Replace PCC-XXX-XXX-XXX-XXX with the name of your PCC service. -

NSX screenshot

+

NSX screenshot

@@ -63,9 +63,9 @@ On the previously opened page, edit the user with whom you want to access the NS

Click on: VMware > PCC-XX-XX-XX-X > Users > Edit. Activate the button NSX Interface. -

NSX screenshot

-

NSX screenshot

-

NSX screenshot

+

NSX screenshot

+

NSX screenshot

+

NSX screenshot

@@ -78,7 +78,7 @@ Click on: VMware > PCC-XX-XX-XX Click on: VMware > PCC-XX-XX-XX-XX > Users > Edit. -

NSX screenshot

+

NSX screenshot

@@ -102,7 +102,7 @@ Only access to V(X)LANs in Read-onlyRead-only mode.

If you want to make changes in the NSX-T web interface, then additional rights will be required, such as Operator or Administrator. -

NSX screenshot

+

NSX screenshot

### Step 5 - Access NSX-T @@ -110,19 +110,19 @@ If you want to make changes in the NSX-T web interface, then additional rights w #### In the OVHcloud Control Panel
->How to access the NSX-T web console +How to access the NSX-T web console In your Hosted Private Cloud tree view, click VMware > PCC-XX-XX-XX-XX.

- OVHcloud direct link: https://www.ovh.com/manager/#/dedicated/dedicated_cloud/PCC-XX-XX-XX-X > Replace PCC-XX-XX-XX-X with the name of your PCC service.

-NSX screenshot +NSX screenshot

-NSX screenshot +NSX screenshot

-NSX screenshot +NSX screenshot

-NSX screenshot +NSX screenshot
diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.es-us.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.es-us.md index 1b449235cbc..24cd1506b61 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.es-us.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.es-us.md @@ -47,7 +47,7 @@ Click on Hosted Private Cloud.

- OVHcloud direct link: https://www.ovh.com/manager/#/dedicated/dedicated_cloud/PCC-XXX-XXX-XXX-XXX > Replace PCC-XXX-XXX-XXX-XXX with the name of your PCC service. -

NSX screenshot

+

NSX screenshot

@@ -63,9 +63,9 @@ On the previously opened page, edit the user with whom you want to access the NS

Click on: VMware > PCC-XX-XX-XX-X > Users > Edit. Activate the button NSX Interface. -

NSX screenshot

-

NSX screenshot

-

NSX screenshot

+

NSX screenshot

+

NSX screenshot

+

NSX screenshot

@@ -78,7 +78,7 @@ Click on: VMware > PCC-XX-XX-XX Click on: VMware > PCC-XX-XX-XX-XX > Users > Edit. -

NSX screenshot

+

NSX screenshot

@@ -102,7 +102,7 @@ Only access to V(X)LANs in Read-onlyRead-only mode.

If you want to make changes in the NSX-T web interface, then additional rights will be required, such as Operator or Administrator. -

NSX screenshot

+

NSX screenshot

### Step 5 - Access NSX-T @@ -110,19 +110,19 @@ If you want to make changes in the NSX-T web interface, then additional rights w #### In the OVHcloud Control Panel
->How to access the NSX-T web console +How to access the NSX-T web console In your Hosted Private Cloud tree view, click VMware > PCC-XX-XX-XX-XX.

- OVHcloud direct link: https://www.ovh.com/manager/#/dedicated/dedicated_cloud/PCC-XX-XX-XX-X > Replace PCC-XX-XX-XX-X with the name of your PCC service.

-NSX screenshot +NSX screenshot

-NSX screenshot +NSX screenshot

-NSX screenshot +NSX screenshot

-NSX screenshot +NSX screenshot
diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.fr-ca.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.fr-ca.md index 6043503a318..fc601b4adeb 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.fr-ca.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.fr-ca.md @@ -44,7 +44,7 @@ Une fois connecté à l'espace client OVHcloud, cliquez sur l'onglet Remplacez-le par le nom de votre service VMware on OVHcloud. -

NSX screenshot

+

NSX screenshot

@@ -59,9 +59,9 @@ Depuis la page précedente, éditez l'utilisateur avec lequel vous souhaitez acc VMware > PCC-XXX.XXX.XXX.XXX > Utilisateur > Modifier puis activez le bouton NSX Interface. -

NSX screenshot

-

NSX screenshot

-

NSX screenshot

+

NSX screenshot

+

NSX screenshot

+

NSX screenshot

@@ -72,7 +72,7 @@ Depuis la page précedente, éditez l'utilisateur avec lequel vous souhaitez acc Cliquez sur : VMware > PCC-XXX-XXX-XXX-XXX > Utilisateur > Modifier. -

NSX screenshot

+

NSX screenshot

@@ -95,7 +95,7 @@ Choisissez Lecture seule.

Si vous voulez faire des modifications dans l'interface Web NSX-T, des droits supplémentaires seront alors nécessaires, tels que Opérateur ou Administrateur. -

NSX screenshot

+

NSX screenshot

@@ -108,10 +108,10 @@ Toujours depuis votre arborescence Hosted Private Cloud, cliquez sur
- Lien OVHcloud : https://www.ovh.com/manager/#/dedicated/dedicated_cloud/PCC-XXX-XXX-XXX-XXX > Remplacez PCC-XXX-XXX-XXX-XXX par le nom de votre service PCC. -

NSX screenshot

-

NSX screenshot

-

NSX screenshot

-

NSX screenshot

+

NSX screenshot

+

NSX screenshot

+

NSX screenshot

+

NSX screenshot

diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.fr-fr.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.fr-fr.md index 6043503a318..fc601b4adeb 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.fr-fr.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.fr-fr.md @@ -44,7 +44,7 @@ Une fois connecté à l'espace client OVHcloud, cliquez sur l'onglet Remplacez-le par le nom de votre service VMware on OVHcloud. -

NSX screenshot

+

NSX screenshot

@@ -59,9 +59,9 @@ Depuis la page précedente, éditez l'utilisateur avec lequel vous souhaitez acc VMware > PCC-XXX.XXX.XXX.XXX > Utilisateur > Modifier puis activez le bouton NSX Interface. -

NSX screenshot

-

NSX screenshot

-

NSX screenshot

+

NSX screenshot

+

NSX screenshot

+

NSX screenshot

@@ -72,7 +72,7 @@ Depuis la page précedente, éditez l'utilisateur avec lequel vous souhaitez acc Cliquez sur : VMware > PCC-XXX-XXX-XXX-XXX > Utilisateur > Modifier. -

NSX screenshot

+

NSX screenshot

@@ -95,7 +95,7 @@ Choisissez Lecture seule.

Si vous voulez faire des modifications dans l'interface Web NSX-T, des droits supplémentaires seront alors nécessaires, tels que Opérateur ou Administrateur. -

NSX screenshot

+

NSX screenshot

@@ -108,10 +108,10 @@ Toujours depuis votre arborescence Hosted Private Cloud, cliquez sur
- Lien OVHcloud : https://www.ovh.com/manager/#/dedicated/dedicated_cloud/PCC-XXX-XXX-XXX-XXX > Remplacez PCC-XXX-XXX-XXX-XXX par le nom de votre service PCC. -

NSX screenshot

-

NSX screenshot

-

NSX screenshot

-

NSX screenshot

+

NSX screenshot

+

NSX screenshot

+

NSX screenshot

+

NSX screenshot

diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.it-it.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.it-it.md index 1b449235cbc..24cd1506b61 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.it-it.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.it-it.md @@ -47,7 +47,7 @@ Click on Hosted Private Cloud.

- OVHcloud direct link: https://www.ovh.com/manager/#/dedicated/dedicated_cloud/PCC-XXX-XXX-XXX-XXX > Replace PCC-XXX-XXX-XXX-XXX with the name of your PCC service. -

NSX screenshot

+

NSX screenshot

@@ -63,9 +63,9 @@ On the previously opened page, edit the user with whom you want to access the NS

Click on: VMware > PCC-XX-XX-XX-X > Users > Edit. Activate the button NSX Interface. -

NSX screenshot

-

NSX screenshot

-

NSX screenshot

+

NSX screenshot

+

NSX screenshot

+

NSX screenshot

@@ -78,7 +78,7 @@ Click on: VMware > PCC-XX-XX-XX Click on: VMware > PCC-XX-XX-XX-XX > Users > Edit. -

NSX screenshot

+

NSX screenshot

@@ -102,7 +102,7 @@ Only access to V(X)LANs in Read-onlyRead-only mode.

If you want to make changes in the NSX-T web interface, then additional rights will be required, such as Operator or Administrator. -

NSX screenshot

+

NSX screenshot

### Step 5 - Access NSX-T @@ -110,19 +110,19 @@ If you want to make changes in the NSX-T web interface, then additional rights w #### In the OVHcloud Control Panel
->How to access the NSX-T web console +How to access the NSX-T web console In your Hosted Private Cloud tree view, click VMware > PCC-XX-XX-XX-XX.

- OVHcloud direct link: https://www.ovh.com/manager/#/dedicated/dedicated_cloud/PCC-XX-XX-XX-X > Replace PCC-XX-XX-XX-X with the name of your PCC service.

-NSX screenshot +NSX screenshot

-NSX screenshot +NSX screenshot

-NSX screenshot +NSX screenshot

-NSX screenshot +NSX screenshot
diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.pl-pl.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.pl-pl.md index 1b449235cbc..24cd1506b61 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.pl-pl.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.pl-pl.md @@ -47,7 +47,7 @@ Click on Hosted Private Cloud.

- OVHcloud direct link: https://www.ovh.com/manager/#/dedicated/dedicated_cloud/PCC-XXX-XXX-XXX-XXX > Replace PCC-XXX-XXX-XXX-XXX with the name of your PCC service. -

NSX screenshot

+

NSX screenshot

@@ -63,9 +63,9 @@ On the previously opened page, edit the user with whom you want to access the NS

Click on: VMware > PCC-XX-XX-XX-X > Users > Edit. Activate the button NSX Interface. -

NSX screenshot

-

NSX screenshot

-

NSX screenshot

+

NSX screenshot

+

NSX screenshot

+

NSX screenshot

@@ -78,7 +78,7 @@ Click on: VMware > PCC-XX-XX-XX Click on: VMware > PCC-XX-XX-XX-XX > Users > Edit. -

NSX screenshot

+

NSX screenshot

@@ -102,7 +102,7 @@ Only access to V(X)LANs in Read-onlyRead-only mode.

If you want to make changes in the NSX-T web interface, then additional rights will be required, such as Operator or Administrator. -

NSX screenshot

+

NSX screenshot

### Step 5 - Access NSX-T @@ -110,19 +110,19 @@ If you want to make changes in the NSX-T web interface, then additional rights w #### In the OVHcloud Control Panel
->How to access the NSX-T web console +How to access the NSX-T web console In your Hosted Private Cloud tree view, click VMware > PCC-XX-XX-XX-XX.

- OVHcloud direct link: https://www.ovh.com/manager/#/dedicated/dedicated_cloud/PCC-XX-XX-XX-X > Replace PCC-XX-XX-XX-X with the name of your PCC service.

-NSX screenshot +NSX screenshot

-NSX screenshot +NSX screenshot

-NSX screenshot +NSX screenshot

-NSX screenshot +NSX screenshot
diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.pt-pt.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.pt-pt.md index 1b449235cbc..24cd1506b61 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.pt-pt.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/guide.pt-pt.md @@ -47,7 +47,7 @@ Click on Hosted Private Cloud.

- OVHcloud direct link: https://www.ovh.com/manager/#/dedicated/dedicated_cloud/PCC-XXX-XXX-XXX-XXX > Replace PCC-XXX-XXX-XXX-XXX with the name of your PCC service. -

NSX screenshot

+

NSX screenshot

@@ -63,9 +63,9 @@ On the previously opened page, edit the user with whom you want to access the NS

Click on: VMware > PCC-XX-XX-XX-X > Users > Edit. Activate the button NSX Interface. -

NSX screenshot

-

NSX screenshot

-

NSX screenshot

+

NSX screenshot

+

NSX screenshot

+

NSX screenshot

@@ -78,7 +78,7 @@ Click on: VMware > PCC-XX-XX-XX Click on: VMware > PCC-XX-XX-XX-XX > Users > Edit. -

NSX screenshot

+

NSX screenshot

@@ -102,7 +102,7 @@ Only access to V(X)LANs in Read-onlyRead-only mode.

If you want to make changes in the NSX-T web interface, then additional rights will be required, such as Operator or Administrator. -

NSX screenshot

+

NSX screenshot

### Step 5 - Access NSX-T @@ -110,19 +110,19 @@ If you want to make changes in the NSX-T web interface, then additional rights w #### In the OVHcloud Control Panel
->How to access the NSX-T web console +How to access the NSX-T web console In your Hosted Private Cloud tree view, click VMware > PCC-XX-XX-XX-XX.

- OVHcloud direct link: https://www.ovh.com/manager/#/dedicated/dedicated_cloud/PCC-XX-XX-XX-X > Replace PCC-XX-XX-XX-X with the name of your PCC service.

-NSX screenshot +NSX screenshot

-NSX screenshot +NSX screenshot

-NSX screenshot +NSX screenshot

-NSX screenshot +NSX screenshot
diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/images/nsx_user_rights_2.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/images/nsx_user_rights_2.png deleted file mode 100644 index d1f56e7c98e..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/images/nsx_user_rights_2.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/images/nsx_user_rights_4.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/images/nsx_user_rights_4.png deleted file mode 100644 index 6754ce1ea63..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/images/nsx_user_rights_4.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/images/nsx_user_rights_5.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/images/nsx_user_rights_5.png deleted file mode 100644 index 852ed41fdfc..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/images/nsx_user_rights_5.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/images/nsx_user_rights_6.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/images/nsx_user_rights_6.png deleted file mode 100644 index 92e615f7b61..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_add_user_rights/images/nsx_user_rights_6.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_controler_deleted_error/images/controllervmdeleted.JPG b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_controler_deleted_error/images/controllervmdeleted.JPG deleted file mode 100644 index dbcf98918ee..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_controler_deleted_error/images/controllervmdeleted.JPG and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_controler_deleted_error/images/controllervmdeleted2.JPG b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_controler_deleted_error/images/controllervmdeleted2.JPG deleted file mode 100644 index 93901e0842f..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_controler_deleted_error/images/controllervmdeleted2.JPG and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_l2vpn_standalone_edge/images/deploy_ovf_1.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_l2vpn_standalone_edge/images/deploy_ovf_1.png deleted file mode 100644 index 87af0e0d956..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_l2vpn_standalone_edge/images/deploy_ovf_1.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_l2vpn_standalone_edge/images/nsx-v-pcc.PNG b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_l2vpn_standalone_edge/images/nsx-v-pcc.PNG deleted file mode 100644 index 6e3229ee176..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_l2vpn_standalone_edge/images/nsx-v-pcc.PNG and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_nsx-v-eos/images/dvs.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_nsx-v-eos/images/dvs.png deleted file mode 100644 index c6ab8cf8369..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_nsx-v-eos/images/dvs.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_nsx-v-eos/images/migrate.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_nsx-v-eos/images/migrate.png deleted file mode 100644 index a1df7578335..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_nsx-v-eos/images/migrate.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_nsx-v-eos/images/network-inferface.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_nsx-v-eos/images/network-inferface.png deleted file mode 100644 index 3d78e3d7d2b..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_nsx-v-eos/images/network-inferface.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_nsx-v-eos/images/vms.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_nsx-v-eos/images/vms.png deleted file mode 100644 index 7ddc0ea2155..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_nsx-v-eos/images/vms.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ovf_tool/guide.fr-ca.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ovf_tool/guide.fr-ca.md index f4beedaccd9..ae7d080f350 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ovf_tool/guide.fr-ca.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ovf_tool/guide.fr-ca.md @@ -6,7 +6,7 @@ updated: 2022-01-31 ## Objectif -[OVFTOOL](https://developer.broadcom.com/tools/open-virtualization-format-ovf-tool/latest){.external-link} est un outil qui permet d'**exporter/importer** des machines virtuelles au format .OVF (compatible Windows, Linux et macOS). +[OVFTOOL](https://developer.broadcom.com/tools/open-virtualization-format-ovf-tool/latest) est un outil qui permet d'**exporter/importer** des machines virtuelles au format .OVF (compatible Windows, Linux et macOS). **Ce guide est un cas d'étude de l'utilisation de cet outil** diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ovf_tool/guide.fr-fr.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ovf_tool/guide.fr-fr.md index c40db05d8fb..5140ea56929 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ovf_tool/guide.fr-fr.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ovf_tool/guide.fr-fr.md @@ -6,7 +6,7 @@ updated: 2022-01-31 ## Objectif -[OVFTOOL](https://developer.broadcom.com/tools/open-virtualization-format-ovf-tool/latest){.external-link} est un outil qui permet d'**exporter/importer** des machines virtuelles au format .OVF (compatible Windows, Linux et macOS). +[OVFTOOL](https://developer.broadcom.com/tools/open-virtualization-format-ovf-tool/latest) est un outil qui permet d'**exporter/importer** des machines virtuelles au format .OVF (compatible Windows, Linux et macOS). **Ce guide est un cas d'étude de l'utilisation de cet outil** diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ovf_tool/images/ovftool10.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ovf_tool/images/ovftool10.png deleted file mode 100644 index f61009314c8..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ovf_tool/images/ovftool10.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ovf_tool/images/ovftool12.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ovf_tool/images/ovftool12.png deleted file mode 100644 index a8802ec78c8..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ovf_tool/images/ovftool12.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ovf_tool/images/ovftool13.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ovf_tool/images/ovftool13.png deleted file mode 100644 index 468c5fc5830..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ovf_tool/images/ovftool13.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ovf_tool/images/ovftool3.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ovf_tool/images/ovftool3.png deleted file mode 100644 index a547dedcd54..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ovf_tool/images/ovftool3.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ovf_tool/images/ovftool4.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ovf_tool/images/ovftool4.png deleted file mode 100644 index 8e268da0beb..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ovf_tool/images/ovftool4.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ovf_tool/images/vScope10.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ovf_tool/images/vScope10.png deleted file mode 100644 index a8e477438b4..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ovf_tool/images/vScope10.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ovf_tool/images/vScope7.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ovf_tool/images/vScope7.png deleted file mode 100644 index 8eb4fd8d229..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ovf_tool/images/vScope7.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ovf_tool/images/vScope8.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ovf_tool/images/vScope8.png deleted file mode 100644 index a36a8f04eea..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ovf_tool/images/vScope8.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/plugin_private_cloud_ovh/images/addhost_01.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/plugin_private_cloud_ovh/images/addhost_01.png deleted file mode 100644 index bf151bc9b57..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/plugin_private_cloud_ovh/images/addhost_01.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/plugin_private_cloud_ovh/images/addhost_02.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/plugin_private_cloud_ovh/images/addhost_02.png deleted file mode 100644 index c95c46f4ab3..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/plugin_private_cloud_ovh/images/addhost_02.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/plugin_private_cloud_ovh/images/addstorage_02.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/plugin_private_cloud_ovh/images/addstorage_02.png deleted file mode 100644 index 0ba873b68ca..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/plugin_private_cloud_ovh/images/addstorage_02.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/plugin_private_cloud_ovh/images/rightclick.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/plugin_private_cloud_ovh/images/rightclick.png deleted file mode 100644 index 8bef4df4ca5..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/plugin_private_cloud_ovh/images/rightclick.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/service-migration-vdc/images/ESSorPRE.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/service-migration-vdc/images/ESSorPRE.png deleted file mode 100644 index b69831e7098..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/service-migration-vdc/images/ESSorPRE.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/guide.es-es.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/guide.es-es.md index 31d561f283a..945fff90e45 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/guide.es-es.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/guide.es-es.md @@ -79,7 +79,7 @@ Se trata de una seguridad normalmente de uso interno de OVHcloud, los snapshots Se trata de una seguridad adicional de uso interno instalada en los datastores que solo debe servir como último recurso para evitar una posible pérdida de datos. -Le recomendamos que utilice una solución de backup completa, como nuestro servicio [Veeam Backup](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/veeam_backup_as_a_service){.external-link} o cualquier otro sistema que realice un backup completo de sus máquinas virtuales. +Le recomendamos que utilice una solución de backup completa, como nuestro servicio [Veeam Backup](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/veeam_backup_as_a_service) o cualquier otro sistema que realice un backup completo de sus máquinas virtuales. ## Más información diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/guide.es-us.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/guide.es-us.md index 31d561f283a..945fff90e45 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/guide.es-us.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/guide.es-us.md @@ -79,7 +79,7 @@ Se trata de una seguridad normalmente de uso interno de OVHcloud, los snapshots Se trata de una seguridad adicional de uso interno instalada en los datastores que solo debe servir como último recurso para evitar una posible pérdida de datos. -Le recomendamos que utilice una solución de backup completa, como nuestro servicio [Veeam Backup](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/veeam_backup_as_a_service){.external-link} o cualquier otro sistema que realice un backup completo de sus máquinas virtuales. +Le recomendamos que utilice una solución de backup completa, como nuestro servicio [Veeam Backup](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/veeam_backup_as_a_service) o cualquier otro sistema que realice un backup completo de sus máquinas virtuales. ## Más información diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/guide.fr-fr.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/guide.fr-fr.md index 21104d9e04e..793d0e0f3f8 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/guide.fr-fr.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/guide.fr-fr.md @@ -75,7 +75,7 @@ Il s'agit là d'une sécurité normalement à usage interne d'OVHcloud, les snap Il s'agit d'une sécurité supplémentaire à usage interne mise en place sur les datastores ne devant servir qu'en dernier recours afin de prévenir une perte de donnée éventuelle. -Nous vous recommandons l'utilisation d'une solution complète de sauvegarde comme notre service [Veeam Backup](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/veeam_backup_as_a_service){.external-link} ou tout autre système réalisant un backup complet de vos machines virtuelles. +Nous vous recommandons l'utilisation d'une solution complète de sauvegarde comme notre service [Veeam Backup](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/veeam_backup_as_a_service) ou tout autre système réalisant un backup complet de vos machines virtuelles. ## Aller plus loin diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/guide.it-it.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/guide.it-it.md index 5068a09871a..f928b96ca9e 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/guide.it-it.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/guide.it-it.md @@ -79,7 +79,7 @@ Si tratta di una sicurezza normalmente utilizzata da OVHcloud, gli Snapshot orar Si tratta di una sicurezza aggiuntiva per uso interno installata sui datastore che deve essere utilizzata solo come ultima risorsa per prevenire una possibile perdita di dati. -Ti consigliamo di utilizzare una soluzione completa di backup, come il servizio [Veeam Backup](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/veeam_backup_as_a_service){.external-link} o qualsiasi altro sistema che effettui un backup completo delle tue macchine virtuali. +Ti consigliamo di utilizzare una soluzione completa di backup, come il servizio [Veeam Backup](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/veeam_backup_as_a_service) o qualsiasi altro sistema che effettui un backup completo delle tue macchine virtuali. ## Per saperne di più diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/guide.pl-pl.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/guide.pl-pl.md index 687ab8d4d58..f0030455f4d 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/guide.pl-pl.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/guide.pl-pl.md @@ -79,7 +79,7 @@ Jest to bezpieczeństwo normalnie używane przez OVHcloud. Snapshoty godzinowe n Jest to dodatkowy system bezpieczeństwa do użytku wewnętrznego wprowadzony w przypadku datastore, który ma być stosowany tylko w ostateczności, aby zapobiec utracie danych. -Zalecamy użycie pełnego rozwiązania do tworzenia kopii zapasowych, takiego jak usługa [Veeam Backup](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/veeam_backup_as_a_service){.external-link} lub inny system realizujący kopię zapasową wirtualnych maszyn. +Zalecamy użycie pełnego rozwiązania do tworzenia kopii zapasowych, takiego jak usługa [Veeam Backup](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/veeam_backup_as_a_service) lub inny system realizujący kopię zapasową wirtualnych maszyn. ## Sprawdź również diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/guide.pt-pt.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/guide.pt-pt.md index 6a7e5958434..d5bbec1655e 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/guide.pt-pt.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/guide.pt-pt.md @@ -79,7 +79,7 @@ Trata-se de uma segurança normalmente de uso interno da OVHcloud, as snapshots Trata-se de uma segurança suplementar de uso interno implementada nos datastores, que apenas deve ser utilizada como último recurso para evitar uma eventual perda de dados. -Recomendamos a utilização de uma solução completa de backup, como o nosso serviço [Veeam Backup](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/veeam_backup_as_a_service){.external-link} ou qualquer outro sistema que realize um backup completo das suas máquinas virtuais. +Recomendamos a utilização de uma solução completa de backup, como o nosso serviço [Veeam Backup](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/veeam_backup_as_a_service) ou qualquer outro sistema que realize um backup completo das suas máquinas virtuais. ## Quer saber mais? diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/images/snapshot1.JPG b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/images/snapshot1.JPG deleted file mode 100644 index 12651728efb..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/images/snapshot1.JPG and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/images/snapshot2.JPG b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/images/snapshot2.JPG deleted file mode 100644 index e18aa3640a1..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/images/snapshot2.JPG and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/images/snapshot3.JPG b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/images/snapshot3.JPG deleted file mode 100644 index 7c2acfcf72c..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/images/snapshot3.JPG and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/images/snapshot4.JPG b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/images/snapshot4.JPG deleted file mode 100644 index b8c9531d8cf..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/images/snapshot4.JPG and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/images/snapshot5.JPG b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/images/snapshot5.JPG deleted file mode 100644 index e4e5b420b32..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/images/snapshot5.JPG and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/images/zfs.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/images/zfs.png deleted file mode 100644 index 27ab7656bc7..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/images/zfs.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/images/zfs1.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/images/zfs1.png deleted file mode 100644 index 008d5c82ba9..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/images/zfs1.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/images/zfs2.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/images/zfs2.png deleted file mode 100644 index 3b556d5ef87..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/images/zfs2.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/images/zfs3.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/images/zfs3.png deleted file mode 100644 index 79a2b4c3fb2..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/images/zfs3.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/images/zfs4.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/images/zfs4.png deleted file mode 100644 index b46bd881834..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/images/zfs4.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/images/zfs5.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/images/zfs5.png deleted file mode 100644 index 1b014ac9b89..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/images/zfs5.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/images/zfs6.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/images/zfs6.png deleted file mode 100644 index 5ce24f096df..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/images/zfs6.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/images/zfs7.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/images/zfs7.png deleted file mode 100644 index a298a83d3f8..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/snapshots_horaires_ovh/images/zfs7.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/guide.de-de.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/guide.de-de.md deleted file mode 100644 index 1706c0197d8..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/guide.de-de.md +++ /dev/null @@ -1,354 +0,0 @@ ---- -title: Installieren Sie Tanzu Community Edition (EN) -excerpt: Integrate Tanzu Community Edition (TCE) on your infrastructure -updated: 2022-11-16 ---- - -## Objective - -VMware Tanzu Community Edition (TCE) is a full-featured, easy-to-manage Kubernetes platform. -You can deploy the product on an OVHcloud infrastructure to leverage its functionality and scalability. - -> [!warning] -> -> Tanzu Community Edition is coming to an end of life at the end of 2022 and will no longer be available. VMware has decided to offer free download of VMware Tanzu Kubernetes Grid. You can use our [introduction to Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation) guide to deploy it. -> - -**This guide offers a step by step example of TCE installation** - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/de/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- A deployed [NSX Edge Services Gateway](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_deploying_edge_gateway) -- [DHCP](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_configurer_le_dhcp_sur_une_edge_gateway) services activated on the NSX Gateway - -## Instructions - -### Network - -As stated in the Requirements (with links to full docs), an NSX Edge Services Gateway is used in our study case for Firewall and DHCP purposes.
-Other Network components can be used as alternative, such as pfSense.
- -To set up your Network, you will need to define a public IP for external access and an internal network with DHCP service activated for your TCE infrastructure.
-Your Datacenter comes with a set of public IPs usable for your different needs. They are visible in the Datacenter `Configure`{.action} tab, in the `Network`{.action} section. You will also see the mask and gateway settings on the page.
-Check out our [Adding an IP block](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip) documentation if you are out of usable public IPs. - -![network](images/en00ipblocks.png){.thumbnail} - -> [!warning] -> -> Public IPs marked as "Reserved" are used for Datacenter functions and cannot be used for other services. -> - -For our study case, the NSX Edge Services Gateway is set up with two interfaces as follows: - -- an external interface (Uplink) with a primary and secondary public IPs (xxx.xxx.xxx.225 and xxx.xxx.xxx.226) -- an internal interface (Internal) with private IP 172.16.13.1 on VLAN13
-![internal interface](images/en01nsxinter.png){.thumbnail} -- DHCP service distributing VLAN13 address scope 172.16.13.10 through 172.16.13.100
-![DHCP](images/en02nsxdhcp.png){.thumbnail} -- a SNAT rule to translate adress range 172.16.13.1/24 into secondary public IP xxx.xxx.xxx.226 for external access
-![SNAT rule](images/en03nsxsnat.png){.thumbnail} - -In the [OVHcloud Control Panel](/links/manager), go to the `Security`{.action} tab of your Hosted Private Cloud and add the public IPs to the allowed adresses to connect.
-The addresses should appear as "Authorised and set up". - -![addresses](images/en00ipsec.png){.thumbnail} - -### Node Template - -The TCE clusters require a template to build the nodes. Those can be dowloaded from the [VMware Customer Connect](https://customerconnect.vmware.com/downloads/get-download?downloadGroup=TCE-0100) website. If you do not own an account, you can create one for free. - -Select the latest version of the OVA you need to use and download it locally. - -![OVA download](images/en22down.png){.thumbnail} - -In vSphere, right-click a host or a cluster and select `Deploy OVF Template`{.action}. - -![Deploy OVF template](images/en23ovfdeploy.png){.thumbnail} - -Browse for the OVA file you downloaded and deploy it. - -![Deploy OVA](images/en24ovfopen.png){.thumbnail} - -Once done, right-click the VM and, in the `Template`{.action} section, select `Convert to Template`{.action}. - -![Convert to template](images/en25template.png){.thumbnail} - -### Bootstrap VM - -Once the Network and template are ready, a Bootstrap VM is needed.
-It will hold the necessary software components (Docker and Kubectl) and pilot the installation of TCE.
-We'll use an Ubuntu VM but any OS allowing the install of the necessary items would work.
-VM prerequisites for TCE is 2 CPUs and 6 GB Ram.
-You can deploy a VM [from an ISO](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle) or [from an OVF template](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ovf_template).
- -Make sure the VM is set on the VLAN that will be used for the TCE clusters (VLAN13 in our case).
- -![VLAN](images/en04bootvlan.png){.thumbnail} - -In a terminal window, start with update commands: - -```bash -sudo apt update -``` - -and - -```bash -sudo apt-get install build-essential -``` - -#### Install [NTP](https://vitux.com/how-to-install-ntp-server-and-client-on-ubuntu/) - -```bash -sudo apt-get install ntp -``` - -#### Install [Homebrew](https://www.how2shout.com/linux/how-to-install-brew-ubuntu-20-04-lts-linux/) - -Start with git: - -```bash -sudo apt install git -y -``` - -Run the Homebrew install script: - -```bash -/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" -``` - -Add Homebrew to your path: - -```bash -eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)" -``` - -Install gcc: - -```bash -brew install gcc -``` - -#### Install [Docker Engine](https://docs.docker.com/engine/install/) - -Start with getting the necessary packages: - -```bash -sudo apt-get install \ -ca-certificates \ -curl \ -gnupg \ -lsb-release -``` - -Add Docker’s official GPG key: - -```bash -curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg -``` - -set up the stable repository: - -```bash -echo \ -"deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu \ -$(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null -``` - -Set up the engine: - -```bash -sudo apt-get install docker-ce docker-ce-cli containerd.io -``` - -Post install, add the current user to the docker group to allow it to run it without rights elevation: - -```bash -sudo usermod -aG docker $USER -``` - -#### Install [Kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/) - -Download the lastest package: - -```bash -curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl" -``` - -Run the installer: - -```bash -sudo install -o root -g root -m 0755 kubectl /usr/local/bin/kubectl -``` - -#### SSH Key Pair - -Run the creation command: - -```bash -ssh-keygen -t rsa -b 4096 -C "youremail@yourdomain.com" -``` - -Press Enter to save the key in default path (/root/.ssh/id_rsa).
-Enter and confirm a password for the key.
-Add the private key to the SSH agent running on your machine, and enter the password you created in the previous step. - -```bash -ssh-add ~/.ssh/id_rsa -``` - -Keep the .ssh/id_rsa.pub file handy as it holds the public key you will need to input later for TCE configuration. - -### Tanzu Management Cluster - -The VM is now ready for TCE deployment. - -#### [Tanzu CLI](https://tanzucommunityedition.io/docs/latest/cli-installation/) - -In a terminal window, run the CLI install command: - -```bash -brew install vmware-tanzu/tanzu/tanzu-community-edition -``` -Note the output install folder and run the post install script: - -```bash -{HOMEBREW-INSTALL-LOCATION}/configure-tce.sh -/home/linuxbrew/.linuxbrew/Cellar/tanzu-community-edition/v0.10.0/libexec/configure-tce.sh -``` - -![Tanzu CLI](images/en05tanzucli.png){.thumbnail} - -#### [Deployment](https://tanzucommunityedition.io/docs/latest/vsphere-install-mgmt/) - -Launch the installer with this command: - -```bash -tanzu management-cluster create --ui -``` - -In the opening browser window, select the vSphere option. - -![vSphere option](images/en06deploy.png){.thumbnail} - -Enter the Hosted Private cloud FQDN and fill in administrative credentials before clicking `Connect`{.action}. - -![credentials](images/en07connect.png){.thumbnail} - -Click `Continue`{.action} to verify the SSL thumbprint. - -![SSL thumbprint](images/en08ssl.png){.thumbnail} - -Select your datacenter and fill in the SSH public key created earlier (.ssh/id_rsa.pub).
-Click `Next`{.action}. - -![SSH](images/en09ssh.png){.thumbnail} - -Choose a type of cluster (Development or Production) and a node size. - -![instance type](images/en10type.png){.thumbnail} - -Fill in the name of your custer, choose a control plane endpoint provider and IP (same subnet but outside of DHCP scope).
-Click `Next`{.action}. - -![cluster](images/en11control.png){.thumbnail} - -NSX Advanced Load Balancer and Metadata sections are optional and we will not edit them.
-Click `Next`{.action} on both of them. - -![NSX - Metadata](images/en12optional.png){.thumbnail} - -Choose your resource locations.
-Click `Next`{.action}. - -![Resources](images/en13resources.png){.thumbnail} - -Enter the Kubernetes Network settings.
-Click `Next`{.action}. - -![Kubernetes](images/en14kubnet.png){.thumbnail} - -Disable Identity Management.
-Click `Next`{.action}. - -![Identity](images/en15identity.png){.thumbnail} - -Select the node template to be used.
-Click `Next`{.action}. - -![node template](images/en16os.png){.thumbnail} - -Click `Review Configuration`{.action}. - -![Review](images/en17review.png){.thumbnail} - -When ready, click `Deploy Management Cluster`{.action}. - -![Deploying cluster](images/en18deploy.png){.thumbnail} - -Upon completion, verify you get a creation message and the nodes are visible in vSphere. - -![Creation message](images/en20created.png){.thumbnail} - -![Visible nodes](images/en21vsphere.png){.thumbnail} - -Get the cluster admin credentials for future interactions: - -```bash -tanzu cluster kubeconfig get "clustername" --admin -``` - -### Tanzu Workload Cluster - -To deploy a workload cluster, we'll duplicate and modify the configuration file for the management cluster.
-Start a terminal window in the bootstrap VM and go to the config file folder. - -```bash -cd .config/tanzu/tkg/clusterconfigs -``` - -Use ls to find the yaml configuration file name and copy it into a new one.
- -```bash -cp existing.yaml new.yaml -``` - -![configuration file name](images/en26copyconf.png){.thumbnail} - -Use a text editor to modify the key fields: - -- CLUSTER_NAME : choose a name for your new cluster -- VSPHERE_CONTROL_PLANE_ENDPOINT : choose an unused IP in the same subnet but not in the DHCP scope -- VSPHERE_FOLDER : this is not mandatory but you can define a different folder for ease of management - -Save and close the file. - -Back in the terminal, run the deploy command calling your new yaml file. - -```bash -tanzu cluster create --file .config/tanzu/tkg/clusterconfigs/new.yaml -``` - -Upon completion, verify you get a creation message and the nodes are visible in vSphere. - -![Creation message](images/en27created.png){.thumbnail} - -![Visible nodes](images/en28vsphere.png){.thumbnail} - -Get the cluster admin credentials for future interactions: - -```bash -tanzu cluster kubeconfig get "clustername" --admin -``` - -TCE is now ready for application install. - -## Go further - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/guide.en-asia.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/guide.en-asia.md deleted file mode 100644 index 8dc9b5e8282..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/guide.en-asia.md +++ /dev/null @@ -1,354 +0,0 @@ ---- -title: Install Tanzu Community Edition -excerpt: Integrate Tanzu Community Edition (TCE) on your infrastructure -updated: 2022-11-16 ---- - -## Objective - -VMware Tanzu Community Edition (TCE) is a full-featured, easy-to-manage Kubernetes platform. -You can deploy the product on an OVHcloud infrastructure to leverage its functionality and scalability. - -> [!warning] -> -> Tanzu Community Edition is coming to an end of life at the end of 2022 and will no longer be available. VMware has decided to offer free download of VMware Tanzu Kubernetes Grid. You can use our [introduction to Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation) guide to deploy it. -> - -**This guide offers a step by step example of TCE installation** - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/asia/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- A deployed [NSX Edge Services Gateway](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_deploying_edge_gateway) -- [DHCP](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_configurer_le_dhcp_sur_une_edge_gateway) services activated on the NSX Gateway - -## Instructions - -### Network - -As stated in the Requirements (with links to full docs), an NSX Edge Services Gateway is used in our study case for Firewall and DHCP purposes.
-Other Network components can be used as alternative, such as pfSense.
- -To set up your Network, you will need to define a public IP for external access and an internal network with DHCP service activated for your TCE infrastructure.
-Your Datacenter comes with a set of public IPs usable for your different needs. They are visible in the Datacenter `Configure`{.action} tab, in the `Network`{.action} section. You will also see the mask and gateway settings on the page.
-Check out our [Adding an IP block](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip) documentation if you are out of usable public IPs. - -![network](images/en00ipblocks.png){.thumbnail} - -> [!warning] -> -> Public IPs marked as "Reserved" are used for Datacenter functions and cannot be used for other services. -> - -For our study case, the NSX Edge Services Gateway is set up with two interfaces as follows: - -- an external interface (Uplink) with a primary and secondary public IPs (xxx.xxx.xxx.225 and xxx.xxx.xxx.226) -- an internal interface (Internal) with private IP 172.16.13.1 on VLAN13
-![internal interface](images/en01nsxinter.png){.thumbnail} -- DHCP service distributing VLAN13 address scope 172.16.13.10 through 172.16.13.100
-![DHCP](images/en02nsxdhcp.png){.thumbnail} -- a SNAT rule to translate adress range 172.16.13.1/24 into secondary public IP xxx.xxx.xxx.226 for external access
-![SNAT rule](images/en03nsxsnat.png){.thumbnail} - -In the [OVHcloud Control Panel](/links/manager), go to the `Security`{.action} tab of your Hosted Private Cloud and add the public IPs to the allowed adresses to connect.
-The addresses should appear as "Authorised and set up". - -![addresses](images/en00ipsec.png){.thumbnail} - -### Node Template - -The TCE clusters require a template to build the nodes. Those can be dowloaded from the [VMware Customer Connect](https://customerconnect.vmware.com/downloads/get-download?downloadGroup=TCE-0100) website. If you do not own an account, you can create one for free. - -Select the latest version of the OVA you need to use and download it locally. - -![OVA download](images/en22down.png){.thumbnail} - -In vSphere, right-click a host or a cluster and select `Deploy OVF Template`{.action}. - -![Deploy OVF template](images/en23ovfdeploy.png){.thumbnail} - -Browse for the OVA file you downloaded and deploy it. - -![Deploy OVA](images/en24ovfopen.png){.thumbnail} - -Once done, right-click the VM and, in the `Template`{.action} section, select `Convert to Template`{.action}. - -![Convert to template](images/en25template.png){.thumbnail} - -### Bootstrap VM - -Once the Network and template are ready, a Bootstrap VM is needed.
-It will hold the necessary software components (Docker and Kubectl) and pilot the installation of TCE.
-We'll use an Ubuntu VM but any OS allowing the install of the necessary items would work.
-VM prerequisites for TCE is 2 CPUs and 6 GB Ram.
-You can deploy a VM [from an ISO](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle) or [from an OVF template](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ovf_template).
- -Make sure the VM is set on the VLAN that will be used for the TCE clusters (VLAN13 in our case).
- -![VLAN](images/en04bootvlan.png){.thumbnail} - -In a terminal window, start with update commands: - -```bash -sudo apt update -``` - -and - -```bash -sudo apt-get install build-essential -``` - -#### Install [NTP](https://vitux.com/how-to-install-ntp-server-and-client-on-ubuntu/) - -```bash -sudo apt-get install ntp -``` - -#### Install [Homebrew](https://www.how2shout.com/linux/how-to-install-brew-ubuntu-20-04-lts-linux/) - -Start with git: - -```bash -sudo apt install git -y -``` - -Run the Homebrew install script: - -```bash -/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" -``` - -Add Homebrew to your path: - -```bash -eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)" -``` - -Install gcc: - -```bash -brew install gcc -``` - -#### Install [Docker Engine](https://docs.docker.com/engine/install/) - -Start with getting the necessary packages: - -```bash -sudo apt-get install \ -ca-certificates \ -curl \ -gnupg \ -lsb-release -``` - -Add Docker’s official GPG key: - -```bash -curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg -``` - -set up the stable repository: - -```bash -echo \ -"deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu \ -$(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null -``` - -Set up the engine: - -```bash -sudo apt-get install docker-ce docker-ce-cli containerd.io -``` - -Post install, add the current user to the docker group to allow it to run it without rights elevation: - -```bash -sudo usermod -aG docker $USER -``` - -#### Install [Kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/) - -Download the lastest package: - -```bash -curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl" -``` - -Run the installer: - -```bash -sudo install -o root -g root -m 0755 kubectl /usr/local/bin/kubectl -``` - -#### SSH Key Pair - -Run the creation command: - -```bash -ssh-keygen -t rsa -b 4096 -C "youremail@yourdomain.com" -``` - -Press Enter to save the key in default path (/root/.ssh/id_rsa).
-Enter and confirm a password for the key.
-Add the private key to the SSH agent running on your machine, and enter the password you created in the previous step. - -```bash -ssh-add ~/.ssh/id_rsa -``` - -Keep the .ssh/id_rsa.pub file handy as it holds the public key you will need to input later for TCE configuration. - -### Tanzu Management Cluster - -The VM is now ready for TCE deployment. - -#### [Tanzu CLI](https://tanzucommunityedition.io/docs/latest/cli-installation/) - -In a terminal window, run the CLI install command: - -```bash -brew install vmware-tanzu/tanzu/tanzu-community-edition -``` -Note the output install folder and run the post install script: - -```bash -{HOMEBREW-INSTALL-LOCATION}/configure-tce.sh -/home/linuxbrew/.linuxbrew/Cellar/tanzu-community-edition/v0.10.0/libexec/configure-tce.sh -``` - -![Tanzu CLI](images/en05tanzucli.png){.thumbnail} - -#### [Deployment](https://tanzucommunityedition.io/docs/latest/vsphere-install-mgmt/) - -Launch the installer with this command: - -```bash -tanzu management-cluster create --ui -``` - -In the opening browser window, select the vSphere option. - -![vSphere option](images/en06deploy.png){.thumbnail} - -Enter the Hosted Private cloud FQDN and fill in administrative credentials before clicking `Connect`{.action}. - -![credentials](images/en07connect.png){.thumbnail} - -Click `Continue`{.action} to verify the SSL thumbprint. - -![SSL thumbprint](images/en08ssl.png){.thumbnail} - -Select your datacenter and fill in the SSH public key created earlier (.ssh/id_rsa.pub).
-Click `Next`{.action}. - -![SSH](images/en09ssh.png){.thumbnail} - -Choose a type of cluster (Development or Production) and a node size. - -![instance type](images/en10type.png){.thumbnail} - -Fill in the name of your custer, choose a control plane endpoint provider and IP (same subnet but outside of DHCP scope).
-Click `Next`{.action}. - -![cluster](images/en11control.png){.thumbnail} - -NSX Advanced Load Balancer and Metadata sections are optional and we will not edit them.
-Click `Next`{.action} on both of them. - -![NSX - Metadata](images/en12optional.png){.thumbnail} - -Choose your resource locations.
-Click `Next`{.action}. - -![Resources](images/en13resources.png){.thumbnail} - -Enter the Kubernetes Network settings.
-Click `Next`{.action}. - -![Kubernetes](images/en14kubnet.png){.thumbnail} - -Disable Identity Management.
-Click `Next`{.action}. - -![Identity](images/en15identity.png){.thumbnail} - -Select the node template to be used.
-Click `Next`{.action}. - -![node template](images/en16os.png){.thumbnail} - -Click `Review Configuration`{.action}. - -![Review](images/en17review.png){.thumbnail} - -When ready, click `Deploy Management Cluster`{.action}. - -![Deploying cluster](images/en18deploy.png){.thumbnail} - -Upon completion, verify you get a creation message and the nodes are visible in vSphere. - -![Creation message](images/en20created.png){.thumbnail} - -![Visible nodes](images/en21vsphere.png){.thumbnail} - -Get the cluster admin credentials for future interactions: - -```bash -tanzu cluster kubeconfig get "clustername" --admin -``` - -### Tanzu Workload Cluster - -To deploy a workload cluster, we'll duplicate and modify the configuration file for the management cluster.
-Start a terminal window in the bootstrap VM and go to the config file folder. - -```bash -cd .config/tanzu/tkg/clusterconfigs -``` - -Use ls to find the yaml configuration file name and copy it into a new one.
- -```bash -cp existing.yaml new.yaml -``` - -![configuration file name](images/en26copyconf.png){.thumbnail} - -Use a text editor to modify the key fields: - -- CLUSTER_NAME : choose a name for your new cluster -- VSPHERE_CONTROL_PLANE_ENDPOINT : choose an unused IP in the same subnet but not in the DHCP scope -- VSPHERE_FOLDER : this is not mandatory but you can define a different folder for ease of management - -Save and close the file. - -Back in the terminal, run the deploy command calling your new yaml file. - -```bash -tanzu cluster create --file .config/tanzu/tkg/clusterconfigs/new.yaml -``` - -Upon completion, verify you get a creation message and the nodes are visible in vSphere. - -![Creation message](images/en27created.png){.thumbnail} - -![Visible nodes](images/en28vsphere.png){.thumbnail} - -Get the cluster admin credentials for future interactions: - -```bash -tanzu cluster kubeconfig get "clustername" --admin -``` - -TCE is now ready for application install. - -## Go further - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/guide.en-au.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/guide.en-au.md deleted file mode 100644 index eafe9398943..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/guide.en-au.md +++ /dev/null @@ -1,354 +0,0 @@ ---- -title: Install Tanzu Community Edition -excerpt: Integrate Tanzu Community Edition (TCE) on your infrastructure -updated: 2022-11-16 ---- - -## Objective - -VMware Tanzu Community Edition (TCE) is a full-featured, easy-to-manage Kubernetes platform. -You can deploy the product on an OVHcloud infrastructure to leverage its functionality and scalability. - -> [!warning] -> -> Tanzu Community Edition is coming to an end of life at the end of 2022 and will no longer be available. VMware has decided to offer free download of VMware Tanzu Kubernetes Grid. You can use our [introduction to Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation) guide to deploy it. -> - -**This guide offers a step by step example of TCE installation** - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/en-au/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- A deployed [NSX Edge Services Gateway](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_deploying_edge_gateway) -- [DHCP](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_configurer_le_dhcp_sur_une_edge_gateway) services activated on the NSX Gateway - -## Instructions - -### Network - -As stated in the Requirements (with links to full docs), an NSX Edge Services Gateway is used in our study case for Firewall and DHCP purposes.
-Other Network components can be used as alternative, such as pfSense.
- -To set up your Network, you will need to define a public IP for external access and an internal network with DHCP service activated for your TCE infrastructure.
-Your Datacenter comes with a set of public IPs usable for your different needs. They are visible in the Datacenter `Configure`{.action} tab, in the `Network`{.action} section. You will also see the mask and gateway settings on the page.
-Check out our [Adding an IP block](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip) documentation if you are out of usable public IPs. - -![network](images/en00ipblocks.png){.thumbnail} - -> [!warning] -> -> Public IPs marked as "Reserved" are used for Datacenter functions and cannot be used for other services. -> - -For our study case, the NSX Edge Services Gateway is set up with two interfaces as follows: - -- an external interface (Uplink) with a primary and secondary public IPs (xxx.xxx.xxx.225 and xxx.xxx.xxx.226) -- an internal interface (Internal) with private IP 172.16.13.1 on VLAN13
-![internal interface](images/en01nsxinter.png){.thumbnail} -- DHCP service distributing VLAN13 address scope 172.16.13.10 through 172.16.13.100
-![DHCP](images/en02nsxdhcp.png){.thumbnail} -- a SNAT rule to translate adress range 172.16.13.1/24 into secondary public IP xxx.xxx.xxx.226 for external access
-![SNAT rule](images/en03nsxsnat.png){.thumbnail} - -In the [OVHcloud Control Panel](/links/manager), go to the `Security`{.action} tab of your Hosted Private Cloud and add the public IPs to the allowed adresses to connect.
-The addresses should appear as "Authorised and set up". - -![addresses](images/en00ipsec.png){.thumbnail} - -### Node Template - -The TCE clusters require a template to build the nodes. Those can be dowloaded from the [VMware Customer Connect](https://customerconnect.vmware.com/downloads/get-download?downloadGroup=TCE-0100) website. If you do not own an account, you can create one for free. - -Select the latest version of the OVA you need to use and download it locally. - -![OVA download](images/en22down.png){.thumbnail} - -In vSphere, right-click a host or a cluster and select `Deploy OVF Template`{.action}. - -![Deploy OVF template](images/en23ovfdeploy.png){.thumbnail} - -Browse for the OVA file you downloaded and deploy it. - -![Deploy OVA](images/en24ovfopen.png){.thumbnail} - -Once done, right-click the VM and, in the `Template`{.action} section, select `Convert to Template`{.action}. - -![Convert to template](images/en25template.png){.thumbnail} - -### Bootstrap VM - -Once the Network and template are ready, a Bootstrap VM is needed.
-It will hold the necessary software components (Docker and Kubectl) and pilot the installation of TCE.
-We'll use an Ubuntu VM but any OS allowing the install of the necessary items would work.
-VM prerequisites for TCE is 2 CPUs and 6 GB Ram.
-You can deploy a VM [from an ISO](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle) or [from an OVF template](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ovf_template).
- -Make sure the VM is set on the VLAN that will be used for the TCE clusters (VLAN13 in our case).
- -![VLAN](images/en04bootvlan.png){.thumbnail} - -In a terminal window, start with update commands: - -```bash -sudo apt update -``` - -and - -```bash -sudo apt-get install build-essential -``` - -#### Install [NTP](https://vitux.com/how-to-install-ntp-server-and-client-on-ubuntu/) - -```bash -sudo apt-get install ntp -``` - -#### Install [Homebrew](https://www.how2shout.com/linux/how-to-install-brew-ubuntu-20-04-lts-linux/) - -Start with git: - -```bash -sudo apt install git -y -``` - -Run the Homebrew install script: - -```bash -/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" -``` - -Add Homebrew to your path: - -```bash -eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)" -``` - -Install gcc: - -```bash -brew install gcc -``` - -#### Install [Docker Engine](https://docs.docker.com/engine/install/) - -Start with getting the necessary packages: - -```bash -sudo apt-get install \ -ca-certificates \ -curl \ -gnupg \ -lsb-release -``` - -Add Docker’s official GPG key: - -```bash -curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg -``` - -set up the stable repository: - -```bash -echo \ -"deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu \ -$(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null -``` - -Set up the engine: - -```bash -sudo apt-get install docker-ce docker-ce-cli containerd.io -``` - -Post install, add the current user to the docker group to allow it to run it without rights elevation: - -```bash -sudo usermod -aG docker $USER -``` - -#### Install [Kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/) - -Download the lastest package: - -```bash -curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl" -``` - -Run the installer: - -```bash -sudo install -o root -g root -m 0755 kubectl /usr/local/bin/kubectl -``` - -#### SSH Key Pair - -Run the creation command: - -```bash -ssh-keygen -t rsa -b 4096 -C "youremail@yourdomain.com" -``` - -Press Enter to save the key in default path (/root/.ssh/id_rsa).
-Enter and confirm a password for the key.
-Add the private key to the SSH agent running on your machine, and enter the password you created in the previous step. - -```bash -ssh-add ~/.ssh/id_rsa -``` - -Keep the .ssh/id_rsa.pub file handy as it holds the public key you will need to input later for TCE configuration. - -### Tanzu Management Cluster - -The VM is now ready for TCE deployment. - -#### [Tanzu CLI](https://tanzucommunityedition.io/docs/latest/cli-installation/) - -In a terminal window, run the CLI install command: - -```bash -brew install vmware-tanzu/tanzu/tanzu-community-edition -``` -Note the output install folder and run the post install script: - -```bash -{HOMEBREW-INSTALL-LOCATION}/configure-tce.sh -/home/linuxbrew/.linuxbrew/Cellar/tanzu-community-edition/v0.10.0/libexec/configure-tce.sh -``` - -![Tanzu CLI](images/en05tanzucli.png){.thumbnail} - -#### [Deployment](https://tanzucommunityedition.io/docs/latest/vsphere-install-mgmt/) - -Launch the installer with this command: - -```bash -tanzu management-cluster create --ui -``` - -In the opening browser window, select the vSphere option. - -![vSphere option](images/en06deploy.png){.thumbnail} - -Enter the Hosted Private cloud FQDN and fill in administrative credentials before clicking `Connect`{.action}. - -![credentials](images/en07connect.png){.thumbnail} - -Click `Continue`{.action} to verify the SSL thumbprint. - -![SSL thumbprint](images/en08ssl.png){.thumbnail} - -Select your datacenter and fill in the SSH public key created earlier (.ssh/id_rsa.pub).
-Click `Next`{.action}. - -![SSH](images/en09ssh.png){.thumbnail} - -Choose a type of cluster (Development or Production) and a node size. - -![instance type](images/en10type.png){.thumbnail} - -Fill in the name of your custer, choose a control plane endpoint provider and IP (same subnet but outside of DHCP scope).
-Click `Next`{.action}. - -![cluster](images/en11control.png){.thumbnail} - -NSX Advanced Load Balancer and Metadata sections are optional and we will not edit them.
-Click `Next`{.action} on both of them. - -![NSX - Metadata](images/en12optional.png){.thumbnail} - -Choose your resource locations.
-Click `Next`{.action}. - -![Resources](images/en13resources.png){.thumbnail} - -Enter the Kubernetes Network settings.
-Click `Next`{.action}. - -![Kubernetes](images/en14kubnet.png){.thumbnail} - -Disable Identity Management.
-Click `Next`{.action}. - -![Identity](images/en15identity.png){.thumbnail} - -Select the node template to be used.
-Click `Next`{.action}. - -![node template](images/en16os.png){.thumbnail} - -Click `Review Configuration`{.action}. - -![Review](images/en17review.png){.thumbnail} - -When ready, click `Deploy Management Cluster`{.action}. - -![Deploying cluster](images/en18deploy.png){.thumbnail} - -Upon completion, verify you get a creation message and the nodes are visible in vSphere. - -![Creation message](images/en20created.png){.thumbnail} - -![Visible nodes](images/en21vsphere.png){.thumbnail} - -Get the cluster admin credentials for future interactions: - -```bash -tanzu cluster kubeconfig get "clustername" --admin -``` - -### Tanzu Workload Cluster - -To deploy a workload cluster, we'll duplicate and modify the configuration file for the management cluster.
-Start a terminal window in the bootstrap VM and go to the config file folder. - -```bash -cd .config/tanzu/tkg/clusterconfigs -``` - -Use ls to find the yaml configuration file name and copy it into a new one.
- -```bash -cp existing.yaml new.yaml -``` - -![configuration file name](images/en26copyconf.png){.thumbnail} - -Use a text editor to modify the key fields: - -- CLUSTER_NAME : choose a name for your new cluster -- VSPHERE_CONTROL_PLANE_ENDPOINT : choose an unused IP in the same subnet but not in the DHCP scope -- VSPHERE_FOLDER : this is not mandatory but you can define a different folder for ease of management - -Save and close the file. - -Back in the terminal, run the deploy command calling your new yaml file. - -```bash -tanzu cluster create --file .config/tanzu/tkg/clusterconfigs/new.yaml -``` - -Upon completion, verify you get a creation message and the nodes are visible in vSphere. - -![Creation message](images/en27created.png){.thumbnail} - -![Visible nodes](images/en28vsphere.png){.thumbnail} - -Get the cluster admin credentials for future interactions: - -```bash -tanzu cluster kubeconfig get "clustername" --admin -``` - -TCE is now ready for application install. - -## Go further - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/guide.en-ca.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/guide.en-ca.md deleted file mode 100644 index 4cce39831b4..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/guide.en-ca.md +++ /dev/null @@ -1,354 +0,0 @@ ---- -title: Install Tanzu Community Edition -excerpt: Integrate Tanzu Community Edition (TCE) on your infrastructure -updated: 2022-11-16 ---- - -## Objective - -VMware Tanzu Community Edition (TCE) is a full-featured, easy-to-manage Kubernetes platform. -You can deploy the product on an OVHcloud infrastructure to leverage its functionality and scalability. - -> [!warning] -> -> Tanzu Community Edition is coming to an end of life at the end of 2022 and will no longer be available. VMware has decided to offer free download of VMware Tanzu Kubernetes Grid. You can use our [introduction to Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation) guide to deploy it. -> - -**This guide offers a step by step example of TCE installation** - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/en-ca/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- A deployed [NSX Edge Services Gateway](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_deploying_edge_gateway) -- [DHCP](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_configurer_le_dhcp_sur_une_edge_gateway) services activated on the NSX Gateway - -## Instructions - -### Network - -As stated in the Requirements (with links to full docs), an NSX Edge Services Gateway is used in our study case for Firewall and DHCP purposes.
-Other Network components can be used as alternative, such as pfSense.
- -To set up your Network, you will need to define a public IP for external access and an internal network with DHCP service activated for your TCE infrastructure.
-Your Datacenter comes with a set of public IPs usable for your different needs. They are visible in the Datacenter `Configure`{.action} tab, in the `Network`{.action} section. You will also see the mask and gateway settings on the page.
-Check out our [Adding an IP block](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip) documentation if you are out of usable public IPs. - -![network](images/en00ipblocks.png){.thumbnail} - -> [!warning] -> -> Public IPs marked as "Reserved" are used for Datacenter functions and cannot be used for other services. -> - -For our study case, the NSX Edge Services Gateway is set up with two interfaces as follows: - -- an external interface (Uplink) with a primary and secondary public IPs (xxx.xxx.xxx.225 and xxx.xxx.xxx.226) -- an internal interface (Internal) with private IP 172.16.13.1 on VLAN13
-![internal interface](images/en01nsxinter.png){.thumbnail} -- DHCP service distributing VLAN13 address scope 172.16.13.10 through 172.16.13.100
-![DHCP](images/en02nsxdhcp.png){.thumbnail} -- a SNAT rule to translate adress range 172.16.13.1/24 into secondary public IP xxx.xxx.xxx.226 for external access
-![SNAT rule](images/en03nsxsnat.png){.thumbnail} - -In the [OVHcloud Control Panel](/links/manager), go to the `Security`{.action} tab of your Hosted Private Cloud and add the public IPs to the allowed adresses to connect.
-The addresses should appear as "Authorised and set up". - -![addresses](images/en00ipsec.png){.thumbnail} - -### Node Template - -The TCE clusters require a template to build the nodes. Those can be dowloaded from the [VMware Customer Connect](https://customerconnect.vmware.com/downloads/get-download?downloadGroup=TCE-0100) website. If you do not own an account, you can create one for free. - -Select the latest version of the OVA you need to use and download it locally. - -![OVA download](images/en22down.png){.thumbnail} - -In vSphere, right-click a host or a cluster and select `Deploy OVF Template`{.action}. - -![Deploy OVF template](images/en23ovfdeploy.png){.thumbnail} - -Browse for the OVA file you downloaded and deploy it. - -![Deploy OVA](images/en24ovfopen.png){.thumbnail} - -Once done, right-click the VM and, in the `Template`{.action} section, select `Convert to Template`{.action}. - -![Convert to template](images/en25template.png){.thumbnail} - -### Bootstrap VM - -Once the Network and template are ready, a Bootstrap VM is needed.
-It will hold the necessary software components (Docker and Kubectl) and pilot the installation of TCE.
-We'll use an Ubuntu VM but any OS allowing the install of the necessary items would work.
-VM prerequisites for TCE is 2 CPUs and 6 GB Ram.
-You can deploy a VM [from an ISO](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle) or [from an OVF template](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ovf_template).
- -Make sure the VM is set on the VLAN that will be used for the TCE clusters (VLAN13 in our case).
- -![VLAN](images/en04bootvlan.png){.thumbnail} - -In a terminal window, start with update commands: - -```bash -sudo apt update -``` - -and - -```bash -sudo apt-get install build-essential -``` - -#### Install [NTP](https://vitux.com/how-to-install-ntp-server-and-client-on-ubuntu/) - -```bash -sudo apt-get install ntp -``` - -#### Install [Homebrew](https://www.how2shout.com/linux/how-to-install-brew-ubuntu-20-04-lts-linux/) - -Start with git: - -```bash -sudo apt install git -y -``` - -Run the Homebrew install script: - -```bash -/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" -``` - -Add Homebrew to your path: - -```bash -eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)" -``` - -Install gcc: - -```bash -brew install gcc -``` - -#### Install [Docker Engine](https://docs.docker.com/engine/install/) - -Start with getting the necessary packages: - -```bash -sudo apt-get install \ -ca-certificates \ -curl \ -gnupg \ -lsb-release -``` - -Add Docker’s official GPG key: - -```bash -curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg -``` - -set up the stable repository: - -```bash -echo \ -"deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu \ -$(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null -``` - -Set up the engine: - -```bash -sudo apt-get install docker-ce docker-ce-cli containerd.io -``` - -Post install, add the current user to the docker group to allow it to run it without rights elevation: - -```bash -sudo usermod -aG docker $USER -``` - -#### Install [Kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/) - -Download the lastest package: - -```bash -curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl" -``` - -Run the installer: - -```bash -sudo install -o root -g root -m 0755 kubectl /usr/local/bin/kubectl -``` - -#### SSH Key Pair - -Run the creation command: - -```bash -ssh-keygen -t rsa -b 4096 -C "youremail@yourdomain.com" -``` - -Press Enter to save the key in default path (/root/.ssh/id_rsa).
-Enter and confirm a password for the key.
-Add the private key to the SSH agent running on your machine, and enter the password you created in the previous step. - -```bash -ssh-add ~/.ssh/id_rsa -``` - -Keep the .ssh/id_rsa.pub file handy as it holds the public key you will need to input later for TCE configuration. - -### Tanzu Management Cluster - -The VM is now ready for TCE deployment. - -#### [Tanzu CLI](https://tanzucommunityedition.io/docs/latest/cli-installation/) - -In a terminal window, run the CLI install command: - -```bash -brew install vmware-tanzu/tanzu/tanzu-community-edition -``` -Note the output install folder and run the post install script: - -```bash -{HOMEBREW-INSTALL-LOCATION}/configure-tce.sh -/home/linuxbrew/.linuxbrew/Cellar/tanzu-community-edition/v0.10.0/libexec/configure-tce.sh -``` - -![Tanzu CLI](images/en05tanzucli.png){.thumbnail} - -#### [Deployment](https://tanzucommunityedition.io/docs/latest/vsphere-install-mgmt/) - -Launch the installer with this command: - -```bash -tanzu management-cluster create --ui -``` - -In the opening browser window, select the vSphere option. - -![vSphere option](images/en06deploy.png){.thumbnail} - -Enter the Hosted Private cloud FQDN and fill in administrative credentials before clicking `Connect`{.action}. - -![credentials](images/en07connect.png){.thumbnail} - -Click `Continue`{.action} to verify the SSL thumbprint. - -![SSL thumbprint](images/en08ssl.png){.thumbnail} - -Select your datacenter and fill in the SSH public key created earlier (.ssh/id_rsa.pub).
-Click `Next`{.action}. - -![SSH](images/en09ssh.png){.thumbnail} - -Choose a type of cluster (Development or Production) and a node size. - -![instance type](images/en10type.png){.thumbnail} - -Fill in the name of your custer, choose a control plane endpoint provider and IP (same subnet but outside of DHCP scope).
-Click `Next`{.action}. - -![cluster](images/en11control.png){.thumbnail} - -NSX Advanced Load Balancer and Metadata sections are optional and we will not edit them.
-Click `Next`{.action} on both of them. - -![NSX - Metadata](images/en12optional.png){.thumbnail} - -Choose your resource locations.
-Click `Next`{.action}. - -![Resources](images/en13resources.png){.thumbnail} - -Enter the Kubernetes Network settings.
-Click `Next`{.action}. - -![Kubernetes](images/en14kubnet.png){.thumbnail} - -Disable Identity Management.
-Click `Next`{.action}. - -![Identity](images/en15identity.png){.thumbnail} - -Select the node template to be used.
-Click `Next`{.action}. - -![node template](images/en16os.png){.thumbnail} - -Click `Review Configuration`{.action}. - -![Review](images/en17review.png){.thumbnail} - -When ready, click `Deploy Management Cluster`{.action}. - -![Deploying cluster](images/en18deploy.png){.thumbnail} - -Upon completion, verify you get a creation message and the nodes are visible in vSphere. - -![Creation message](images/en20created.png){.thumbnail} - -![Visible nodes](images/en21vsphere.png){.thumbnail} - -Get the cluster admin credentials for future interactions: - -```bash -tanzu cluster kubeconfig get "clustername" --admin -``` - -### Tanzu Workload Cluster - -To deploy a workload cluster, we'll duplicate and modify the configuration file for the management cluster.
-Start a terminal window in the bootstrap VM and go to the config file folder. - -```bash -cd .config/tanzu/tkg/clusterconfigs -``` - -Use ls to find the yaml configuration file name and copy it into a new one.
- -```bash -cp existing.yaml new.yaml -``` - -![configuration file name](images/en26copyconf.png){.thumbnail} - -Use a text editor to modify the key fields: - -- CLUSTER_NAME : choose a name for your new cluster -- VSPHERE_CONTROL_PLANE_ENDPOINT : choose an unused IP in the same subnet but not in the DHCP scope -- VSPHERE_FOLDER : this is not mandatory but you can define a different folder for ease of management - -Save and close the file. - -Back in the terminal, run the deploy command calling your new yaml file. - -```bash -tanzu cluster create --file .config/tanzu/tkg/clusterconfigs/new.yaml -``` - -Upon completion, verify you get a creation message and the nodes are visible in vSphere. - -![Creation message](images/en27created.png){.thumbnail} - -![Visible nodes](images/en28vsphere.png){.thumbnail} - -Get the cluster admin credentials for future interactions: - -```bash -tanzu cluster kubeconfig get "clustername" --admin -``` - -TCE is now ready for application install. - -## Go further - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/guide.en-gb.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/guide.en-gb.md deleted file mode 100644 index 3c97a26c972..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/guide.en-gb.md +++ /dev/null @@ -1,354 +0,0 @@ ---- -title: Install Tanzu Community Edition -excerpt: Integrate Tanzu Community Edition (TCE) on your infrastructure -updated: 2022-11-16 ---- - -## Objective - -VMware Tanzu Community Edition (TCE) is a full-featured, easy-to-manage Kubernetes platform. -You can deploy the product on an OVHcloud infrastructure to leverage its functionality and scalability. - -> [!warning] -> -> Tanzu Community Edition is coming to an end of life at the end of 2022 and will no longer be available. VMware has decided to offer free download of VMware Tanzu Kubernetes Grid. You can use our [introduction to Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation) guide to deploy it. -> - -**This guide offers a step by step example of TCE installation** - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/en-gb/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- A deployed [NSX Edge Services Gateway](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_deploying_edge_gateway) -- [DHCP](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_configurer_le_dhcp_sur_une_edge_gateway) services activated on the NSX Gateway - -## Instructions - -### Network - -As stated in the Requirements (with links to full docs), an NSX Edge Services Gateway is used in our study case for Firewall and DHCP purposes.
-Other Network components can be used as alternative, such as pfSense.
- -To set up your Network, you will need to define a public IP for external access and an internal network with DHCP service activated for your TCE infrastructure.
-Your Datacenter comes with a set of public IPs usable for your different needs. They are visible in the Datacenter `Configure`{.action} tab, in the `Network`{.action} section. You will also see the mask and gateway settings on the page.
-Check out our [Adding an IP block](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip) documentation if you are out of usable public IPs. - -![network](images/en00ipblocks.png){.thumbnail} - -> [!warning] -> -> Public IPs marked as "Reserved" are used for Datacenter functions and cannot be used for other services. -> - -For our study case, the NSX Edge Services Gateway is set up with two interfaces as follows: - -- an external interface (Uplink) with a primary and secondary public IPs (xxx.xxx.xxx.225 and xxx.xxx.xxx.226) -- an internal interface (Internal) with private IP 172.16.13.1 on VLAN13
-![internal interface](images/en01nsxinter.png){.thumbnail} -- DHCP service distributing VLAN13 address scope 172.16.13.10 through 172.16.13.100
-![DHCP](images/en02nsxdhcp.png){.thumbnail} -- a SNAT rule to translate adress range 172.16.13.1/24 into secondary public IP xxx.xxx.xxx.226 for external access
-![SNAT rule](images/en03nsxsnat.png){.thumbnail} - -In the [OVHcloud Control Panel](/links/manager), go to the `Security`{.action} tab of your Hosted Private Cloud and add the public IPs to the allowed adresses to connect.
-The addresses should appear as "Authorised and set up". - -![addresses](images/en00ipsec.png){.thumbnail} - -### Node Template - -The TCE clusters require a template to build the nodes. Those can be dowloaded from the [VMware Customer Connect](https://customerconnect.vmware.com/downloads/get-download?downloadGroup=TCE-0100) website. If you do not own an account, you can create one for free. - -Select the latest version of the OVA you need to use and download it locally. - -![OVA download](images/en22down.png){.thumbnail} - -In vSphere, right-click a host or a cluster and select `Deploy OVF Template`{.action}. - -![Deploy OVF template](images/en23ovfdeploy.png){.thumbnail} - -Browse for the OVA file you downloaded and deploy it. - -![Deploy OVA](images/en24ovfopen.png){.thumbnail} - -Once done, right-click the VM and, in the `Template`{.action} section, select `Convert to Template`{.action}. - -![Convert to template](images/en25template.png){.thumbnail} - -### Bootstrap VM - -Once the Network and template are ready, a Bootstrap VM is needed.
-It will hold the necessary software components (Docker and Kubectl) and pilot the installation of TCE.
-We'll use an Ubuntu VM but any OS allowing the install of the necessary items would work.
-VM prerequisites for TCE is 2 CPUs and 6 GB Ram.
-You can deploy a VM [from an ISO](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle) or [from an OVF template](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ovf_template).
- -Make sure the VM is set on the VLAN that will be used for the TCE clusters (VLAN13 in our case).
- -![VLAN](images/en04bootvlan.png){.thumbnail} - -In a terminal window, start with update commands: - -```bash -sudo apt update -``` - -and - -```bash -sudo apt-get install build-essential -``` - -#### Install [NTP](https://vitux.com/how-to-install-ntp-server-and-client-on-ubuntu/) - -```bash -sudo apt-get install ntp -``` - -#### Install [Homebrew](https://www.how2shout.com/linux/how-to-install-brew-ubuntu-20-04-lts-linux/) - -Start with git: - -```bash -sudo apt install git -y -``` - -Run the Homebrew install script: - -```bash -/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" -``` - -Add Homebrew to your path: - -```bash -eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)" -``` - -Install gcc: - -```bash -brew install gcc -``` - -#### Install [Docker Engine](https://docs.docker.com/engine/install/) - -Start with getting the necessary packages: - -```bash -sudo apt-get install \ -ca-certificates \ -curl \ -gnupg \ -lsb-release -``` - -Add Docker’s official GPG key: - -```bash -curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg -``` - -set up the stable repository: - -```bash -echo \ -"deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu \ -$(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null -``` - -Set up the engine: - -```bash -sudo apt-get install docker-ce docker-ce-cli containerd.io -``` - -Post install, add the current user to the docker group to allow it to run it without rights elevation: - -```bash -sudo usermod -aG docker $USER -``` - -#### Install [Kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/) - -Download the lastest package: - -```bash -curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl" -``` - -Run the installer: - -```bash -sudo install -o root -g root -m 0755 kubectl /usr/local/bin/kubectl -``` - -#### SSH Key Pair - -Run the creation command: - -```bash -ssh-keygen -t rsa -b 4096 -C "youremail@yourdomain.com" -``` - -Press Enter to save the key in default path (/root/.ssh/id_rsa).
-Enter and confirm a password for the key.
-Add the private key to the SSH agent running on your machine, and enter the password you created in the previous step. - -```bash -ssh-add ~/.ssh/id_rsa -``` - -Keep the .ssh/id_rsa.pub file handy as it holds the public key you will need to input later for TCE configuration. - -### Tanzu Management Cluster - -The VM is now ready for TCE deployment. - -#### [Tanzu CLI](https://tanzucommunityedition.io/docs/latest/cli-installation/) - -In a terminal window, run the CLI install command: - -```bash -brew install vmware-tanzu/tanzu/tanzu-community-edition -``` -Note the output install folder and run the post install script: - -```bash -{HOMEBREW-INSTALL-LOCATION}/configure-tce.sh -/home/linuxbrew/.linuxbrew/Cellar/tanzu-community-edition/v0.10.0/libexec/configure-tce.sh -``` - -![Tanzu CLI](images/en05tanzucli.png){.thumbnail} - -#### [Deployment](https://tanzucommunityedition.io/docs/latest/vsphere-install-mgmt/) - -Launch the installer with this command: - -```bash -tanzu management-cluster create --ui -``` - -In the opening browser window, select the vSphere option. - -![vSphere option](images/en06deploy.png){.thumbnail} - -Enter the Hosted Private cloud FQDN and fill in administrative credentials before clicking `Connect`{.action}. - -![credentials](images/en07connect.png){.thumbnail} - -Click `Continue`{.action} to verify the SSL thumbprint. - -![SSL thumbprint](images/en08ssl.png){.thumbnail} - -Select your datacenter and fill in the SSH public key created earlier (.ssh/id_rsa.pub).
-Click `Next`{.action}. - -![SSH](images/en09ssh.png){.thumbnail} - -Choose a type of cluster (Development or Production) and a node size. - -![instance type](images/en10type.png){.thumbnail} - -Fill in the name of your custer, choose a control plane endpoint provider and IP (same subnet but outside of DHCP scope).
-Click `Next`{.action}. - -![cluster](images/en11control.png){.thumbnail} - -NSX Advanced Load Balancer and Metadata sections are optional and we will not edit them.
-Click `Next`{.action} on both of them. - -![NSX - Metadata](images/en12optional.png){.thumbnail} - -Choose your resource locations.
-Click `Next`{.action}. - -![Resources](images/en13resources.png){.thumbnail} - -Enter the Kubernetes Network settings.
-Click `Next`{.action}. - -![Kubernetes](images/en14kubnet.png){.thumbnail} - -Disable Identity Management.
-Click `Next`{.action}. - -![Identity](images/en15identity.png){.thumbnail} - -Select the node template to be used.
-Click `Next`{.action}. - -![node template](images/en16os.png){.thumbnail} - -Click `Review Configuration`{.action}. - -![Review](images/en17review.png){.thumbnail} - -When ready, click `Deploy Management Cluster`{.action}. - -![Deploying cluster](images/en18deploy.png){.thumbnail} - -Upon completion, verify you get a creation message and the nodes are visible in vSphere. - -![Creation message](images/en20created.png){.thumbnail} - -![Visible nodes](images/en21vsphere.png){.thumbnail} - -Get the cluster admin credentials for future interactions: - -```bash -tanzu cluster kubeconfig get "clustername" --admin -``` - -### Tanzu Workload Cluster - -To deploy a workload cluster, we'll duplicate and modify the configuration file for the management cluster.
-Start a terminal window in the bootstrap VM and go to the config file folder. - -```bash -cd .config/tanzu/tkg/clusterconfigs -``` - -Use ls to find the yaml configuration file name and copy it into a new one.
- -```bash -cp existing.yaml new.yaml -``` - -![configuration file name](images/en26copyconf.png){.thumbnail} - -Use a text editor to modify the key fields: - -- CLUSTER_NAME : choose a name for your new cluster -- VSPHERE_CONTROL_PLANE_ENDPOINT : choose an unused IP in the same subnet but not in the DHCP scope -- VSPHERE_FOLDER : this is not mandatory but you can define a different folder for ease of management - -Save and close the file. - -Back in the terminal, run the deploy command calling your new yaml file. - -```bash -tanzu cluster create --file .config/tanzu/tkg/clusterconfigs/new.yaml -``` - -Upon completion, verify you get a creation message and the nodes are visible in vSphere. - -![Creation message](images/en27created.png){.thumbnail} - -![Visible nodes](images/en28vsphere.png){.thumbnail} - -Get the cluster admin credentials for future interactions: - -```bash -tanzu cluster kubeconfig get "clustername" --admin -``` - -TCE is now ready for application install. - -## Go further - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/guide.en-ie.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/guide.en-ie.md deleted file mode 100644 index 99c397e454d..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/guide.en-ie.md +++ /dev/null @@ -1,354 +0,0 @@ ---- -title: Install Tanzu Community Edition -excerpt: Integrate Tanzu Community Edition (TCE) on your infrastructure -updated: 2022-11-16 ---- - -## Objective - -VMware Tanzu Community Edition (TCE) is a full-featured, easy-to-manage Kubernetes platform. -You can deploy the product on an OVHcloud infrastructure to leverage its functionality and scalability. - -> [!warning] -> -> Tanzu Community Edition is coming to an end of life at the end of 2022 and will no longer be available. VMware has decided to offer free download of VMware Tanzu Kubernetes Grid. You can use our [introduction to Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation) guide to deploy it. -> - -**This guide offers a step by step example of TCE installation** - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/en-ie/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- A deployed [NSX Edge Services Gateway](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_deploying_edge_gateway) -- [DHCP](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_configurer_le_dhcp_sur_une_edge_gateway) services activated on the NSX Gateway - -## Instructions - -### Network - -As stated in the Requirements (with links to full docs), an NSX Edge Services Gateway is used in our study case for Firewall and DHCP purposes.
-Other Network components can be used as alternative, such as pfSense.
- -To set up your Network, you will need to define a public IP for external access and an internal network with DHCP service activated for your TCE infrastructure.
-Your Datacenter comes with a set of public IPs usable for your different needs. They are visible in the Datacenter `Configure`{.action} tab, in the `Network`{.action} section. You will also see the mask and gateway settings on the page.
-Check out our [Adding an IP block](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip) documentation if you are out of usable public IPs. - -![network](images/en00ipblocks.png){.thumbnail} - -> [!warning] -> -> Public IPs marked as "Reserved" are used for Datacenter functions and cannot be used for other services. -> - -For our study case, the NSX Edge Services Gateway is set up with two interfaces as follows: - -- an external interface (Uplink) with a primary and secondary public IPs (xxx.xxx.xxx.225 and xxx.xxx.xxx.226) -- an internal interface (Internal) with private IP 172.16.13.1 on VLAN13
-![internal interface](images/en01nsxinter.png){.thumbnail} -- DHCP service distributing VLAN13 address scope 172.16.13.10 through 172.16.13.100
-![DHCP](images/en02nsxdhcp.png){.thumbnail} -- a SNAT rule to translate adress range 172.16.13.1/24 into secondary public IP xxx.xxx.xxx.226 for external access
-![SNAT rule](images/en03nsxsnat.png){.thumbnail} - -In the [OVHcloud Control Panel](/links/manager), go to the `Security`{.action} tab of your Hosted Private Cloud and add the public IPs to the allowed adresses to connect.
-The addresses should appear as "Authorised and set up". - -![addresses](images/en00ipsec.png){.thumbnail} - -### Node Template - -The TCE clusters require a template to build the nodes. Those can be dowloaded from the [VMware Customer Connect](https://customerconnect.vmware.com/downloads/get-download?downloadGroup=TCE-0100) website. If you do not own an account, you can create one for free. - -Select the latest version of the OVA you need to use and download it locally. - -![OVA download](images/en22down.png){.thumbnail} - -In vSphere, right-click a host or a cluster and select `Deploy OVF Template`{.action}. - -![Deploy OVF template](images/en23ovfdeploy.png){.thumbnail} - -Browse for the OVA file you downloaded and deploy it. - -![Deploy OVA](images/en24ovfopen.png){.thumbnail} - -Once done, right-click the VM and, in the `Template`{.action} section, select `Convert to Template`{.action}. - -![Convert to template](images/en25template.png){.thumbnail} - -### Bootstrap VM - -Once the Network and template are ready, a Bootstrap VM is needed.
-It will hold the necessary software components (Docker and Kubectl) and pilot the installation of TCE.
-We'll use an Ubuntu VM but any OS allowing the install of the necessary items would work.
-VM prerequisites for TCE is 2 CPUs and 6 GB Ram.
-You can deploy a VM [from an ISO](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle) or [from an OVF template](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ovf_template).
- -Make sure the VM is set on the VLAN that will be used for the TCE clusters (VLAN13 in our case).
- -![VLAN](images/en04bootvlan.png){.thumbnail} - -In a terminal window, start with update commands: - -```bash -sudo apt update -``` - -and - -```bash -sudo apt-get install build-essential -``` - -#### Install [NTP](https://vitux.com/how-to-install-ntp-server-and-client-on-ubuntu/) - -```bash -sudo apt-get install ntp -``` - -#### Install [Homebrew](https://www.how2shout.com/linux/how-to-install-brew-ubuntu-20-04-lts-linux/) - -Start with git: - -```bash -sudo apt install git -y -``` - -Run the Homebrew install script: - -```bash -/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" -``` - -Add Homebrew to your path: - -```bash -eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)" -``` - -Install gcc: - -```bash -brew install gcc -``` - -#### Install [Docker Engine](https://docs.docker.com/engine/install/) - -Start with getting the necessary packages: - -```bash -sudo apt-get install \ -ca-certificates \ -curl \ -gnupg \ -lsb-release -``` - -Add Docker’s official GPG key: - -```bash -curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg -``` - -set up the stable repository: - -```bash -echo \ -"deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu \ -$(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null -``` - -Set up the engine: - -```bash -sudo apt-get install docker-ce docker-ce-cli containerd.io -``` - -Post install, add the current user to the docker group to allow it to run it without rights elevation: - -```bash -sudo usermod -aG docker $USER -``` - -#### Install [Kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/) - -Download the lastest package: - -```bash -curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl" -``` - -Run the installer: - -```bash -sudo install -o root -g root -m 0755 kubectl /usr/local/bin/kubectl -``` - -#### SSH Key Pair - -Run the creation command: - -```bash -ssh-keygen -t rsa -b 4096 -C "youremail@yourdomain.com" -``` - -Press Enter to save the key in default path (/root/.ssh/id_rsa).
-Enter and confirm a password for the key.
-Add the private key to the SSH agent running on your machine, and enter the password you created in the previous step. - -```bash -ssh-add ~/.ssh/id_rsa -``` - -Keep the .ssh/id_rsa.pub file handy as it holds the public key you will need to input later for TCE configuration. - -### Tanzu Management Cluster - -The VM is now ready for TCE deployment. - -#### [Tanzu CLI](https://tanzucommunityedition.io/docs/latest/cli-installation/) - -In a terminal window, run the CLI install command: - -```bash -brew install vmware-tanzu/tanzu/tanzu-community-edition -``` -Note the output install folder and run the post install script: - -```bash -{HOMEBREW-INSTALL-LOCATION}/configure-tce.sh -/home/linuxbrew/.linuxbrew/Cellar/tanzu-community-edition/v0.10.0/libexec/configure-tce.sh -``` - -![Tanzu CLI](images/en05tanzucli.png){.thumbnail} - -#### [Deployment](https://tanzucommunityedition.io/docs/latest/vsphere-install-mgmt/) - -Launch the installer with this command: - -```bash -tanzu management-cluster create --ui -``` - -In the opening browser window, select the vSphere option. - -![vSphere option](images/en06deploy.png){.thumbnail} - -Enter the Hosted Private cloud FQDN and fill in administrative credentials before clicking `Connect`{.action}. - -![credentials](images/en07connect.png){.thumbnail} - -Click `Continue`{.action} to verify the SSL thumbprint. - -![SSL thumbprint](images/en08ssl.png){.thumbnail} - -Select your datacenter and fill in the SSH public key created earlier (.ssh/id_rsa.pub).
-Click `Next`{.action}. - -![SSH](images/en09ssh.png){.thumbnail} - -Choose a type of cluster (Development or Production) and a node size. - -![instance type](images/en10type.png){.thumbnail} - -Fill in the name of your custer, choose a control plane endpoint provider and IP (same subnet but outside of DHCP scope).
-Click `Next`{.action}. - -![cluster](images/en11control.png){.thumbnail} - -NSX Advanced Load Balancer and Metadata sections are optional and we will not edit them.
-Click `Next`{.action} on both of them. - -![NSX - Metadata](images/en12optional.png){.thumbnail} - -Choose your resource locations.
-Click `Next`{.action}. - -![Resources](images/en13resources.png){.thumbnail} - -Enter the Kubernetes Network settings.
-Click `Next`{.action}. - -![Kubernetes](images/en14kubnet.png){.thumbnail} - -Disable Identity Management.
-Click `Next`{.action}. - -![Identity](images/en15identity.png){.thumbnail} - -Select the node template to be used.
-Click `Next`{.action}. - -![node template](images/en16os.png){.thumbnail} - -Click `Review Configuration`{.action}. - -![Review](images/en17review.png){.thumbnail} - -When ready, click `Deploy Management Cluster`{.action}. - -![Deploying cluster](images/en18deploy.png){.thumbnail} - -Upon completion, verify you get a creation message and the nodes are visible in vSphere. - -![Creation message](images/en20created.png){.thumbnail} - -![Visible nodes](images/en21vsphere.png){.thumbnail} - -Get the cluster admin credentials for future interactions: - -```bash -tanzu cluster kubeconfig get "clustername" --admin -``` - -### Tanzu Workload Cluster - -To deploy a workload cluster, we'll duplicate and modify the configuration file for the management cluster.
-Start a terminal window in the bootstrap VM and go to the config file folder. - -```bash -cd .config/tanzu/tkg/clusterconfigs -``` - -Use ls to find the yaml configuration file name and copy it into a new one.
- -```bash -cp existing.yaml new.yaml -``` - -![configuration file name](images/en26copyconf.png){.thumbnail} - -Use a text editor to modify the key fields: - -- CLUSTER_NAME : choose a name for your new cluster -- VSPHERE_CONTROL_PLANE_ENDPOINT : choose an unused IP in the same subnet but not in the DHCP scope -- VSPHERE_FOLDER : this is not mandatory but you can define a different folder for ease of management - -Save and close the file. - -Back in the terminal, run the deploy command calling your new yaml file. - -```bash -tanzu cluster create --file .config/tanzu/tkg/clusterconfigs/new.yaml -``` - -Upon completion, verify you get a creation message and the nodes are visible in vSphere. - -![Creation message](images/en27created.png){.thumbnail} - -![Visible nodes](images/en28vsphere.png){.thumbnail} - -Get the cluster admin credentials for future interactions: - -```bash -tanzu cluster kubeconfig get "clustername" --admin -``` - -TCE is now ready for application install. - -## Go further - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/guide.en-sg.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/guide.en-sg.md deleted file mode 100644 index c7bf0e0f24b..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/guide.en-sg.md +++ /dev/null @@ -1,353 +0,0 @@ ---- -title: Install Tanzu Community Edition -excerpt: Integrate Tanzu Community Edition (TCE) on your infrastructure -updated: 2022-11-16 ---- - -## Objective - -VMware Tanzu Community Edition (TCE) is a full-featured, easy-to-manage Kubernetes platform. -You can deploy the product on an OVHcloud infrastructure to leverage its functionality and scalability. - -> [!warning] -> -> Tanzu Community Edition is coming to an end of life at the end of 2022 and will no longer be available. VMware has decided to offer free download of VMware Tanzu Kubernetes Grid. You can use our [introduction to Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation) guide to deploy it. -> -**This guide offers a step by step example of TCE installation** - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/en-sg/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- A deployed [NSX Edge Services Gateway](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_deploying_edge_gateway) -- [DHCP](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_configurer_le_dhcp_sur_une_edge_gateway) services activated on the NSX Gateway - -## Instructions - -### Network - -As stated in the Requirements (with links to full docs), an NSX Edge Services Gateway is used in our study case for Firewall and DHCP purposes.
-Other Network components can be used as alternative, such as pfSense.
- -To set up your Network, you will need to define a public IP for external access and an internal network with DHCP service activated for your TCE infrastructure.
-Your Datacenter comes with a set of public IPs usable for your different needs. They are visible in the Datacenter `Configure`{.action} tab, in the `Network`{.action} section. You will also see the mask and gateway settings on the page.
-Check out our [Adding an IP block](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip) documentation if you are out of usable public IPs. - -![network](images/en00ipblocks.png){.thumbnail} - -> [!warning] -> -> Public IPs marked as "Reserved" are used for Datacenter functions and cannot be used for other services. -> - -For our study case, the NSX Edge Services Gateway is set up with two interfaces as follows: - -- an external interface (Uplink) with a primary and secondary public IPs (xxx.xxx.xxx.225 and xxx.xxx.xxx.226) -- an internal interface (Internal) with private IP 172.16.13.1 on VLAN13
-![internal interface](images/en01nsxinter.png){.thumbnail} -- DHCP service distributing VLAN13 address scope 172.16.13.10 through 172.16.13.100
-![DHCP](images/en02nsxdhcp.png){.thumbnail} -- a SNAT rule to translate adress range 172.16.13.1/24 into secondary public IP xxx.xxx.xxx.226 for external access
-![SNAT rule](images/en03nsxsnat.png){.thumbnail} - -In the [OVHcloud Control Panel](/links/manager), go to the `Security`{.action} tab of your Hosted Private Cloud and add the public IPs to the allowed adresses to connect.
-The addresses should appear as "Authorised and set up". - -![addresses](images/en00ipsec.png){.thumbnail} - -### Node Template - -The TCE clusters require a template to build the nodes. Those can be dowloaded from the [VMware Customer Connect](https://customerconnect.vmware.com/downloads/get-download?downloadGroup=TCE-0100) website. If you do not own an account, you can create one for free. - -Select the latest version of the OVA you need to use and download it locally. - -![OVA download](images/en22down.png){.thumbnail} - -In vSphere, right-click a host or a cluster and select `Deploy OVF Template`{.action}. - -![Deploy OVF template](images/en23ovfdeploy.png){.thumbnail} - -Browse for the OVA file you downloaded and deploy it. - -![Deploy OVA](images/en24ovfopen.png){.thumbnail} - -Once done, right-click the VM and, in the `Template`{.action} section, select `Convert to Template`{.action}. - -![Convert to template](images/en25template.png){.thumbnail} - -### Bootstrap VM - -Once the Network and template are ready, a Bootstrap VM is needed.
-It will hold the necessary software components (Docker and Kubectl) and pilot the installation of TCE.
-We'll use an Ubuntu VM but any OS allowing the install of the necessary items would work.
-VM prerequisites for TCE is 2 CPUs and 6 GB Ram.
-You can deploy a VM [from an ISO](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle) or [from an OVF template](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ovf_template).
- -Make sure the VM is set on the VLAN that will be used for the TCE clusters (VLAN13 in our case).
- -![VLAN](images/en04bootvlan.png){.thumbnail} - -In a terminal window, start with update commands: - -```bash -sudo apt update -``` - -and - -```bash -sudo apt-get install build-essential -``` - -#### Install [NTP](https://vitux.com/how-to-install-ntp-server-and-client-on-ubuntu/) - -```bash -sudo apt-get install ntp -``` - -#### Install [Homebrew](https://www.how2shout.com/linux/how-to-install-brew-ubuntu-20-04-lts-linux/) - -Start with git: - -```bash -sudo apt install git -y -``` - -Run the Homebrew install script: - -```bash -/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" -``` - -Add Homebrew to your path: - -```bash -eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)" -``` - -Install gcc: - -```bash -brew install gcc -``` - -#### Install [Docker Engine](https://docs.docker.com/engine/install/) - -Start with getting the necessary packages: - -```bash -sudo apt-get install \ -ca-certificates \ -curl \ -gnupg \ -lsb-release -``` - -Add Docker’s official GPG key: - -```bash -curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg -``` - -set up the stable repository: - -```bash -echo \ -"deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu \ -$(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null -``` - -Set up the engine: - -```bash -sudo apt-get install docker-ce docker-ce-cli containerd.io -``` - -Post install, add the current user to the docker group to allow it to run it without rights elevation: - -```bash -sudo usermod -aG docker $USER -``` - -#### Install [Kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/) - -Download the lastest package: - -```bash -curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl" -``` - -Run the installer: - -```bash -sudo install -o root -g root -m 0755 kubectl /usr/local/bin/kubectl -``` - -#### SSH Key Pair - -Run the creation command: - -```bash -ssh-keygen -t rsa -b 4096 -C "youremail@yourdomain.com" -``` - -Press Enter to save the key in default path (/root/.ssh/id_rsa).
-Enter and confirm a password for the key.
-Add the private key to the SSH agent running on your machine, and enter the password you created in the previous step. - -```bash -ssh-add ~/.ssh/id_rsa -``` - -Keep the .ssh/id_rsa.pub file handy as it holds the public key you will need to input later for TCE configuration. - -### Tanzu Management Cluster - -The VM is now ready for TCE deployment. - -#### [Tanzu CLI](https://tanzucommunityedition.io/docs/latest/cli-installation/) - -In a terminal window, run the CLI install command: - -```bash -brew install vmware-tanzu/tanzu/tanzu-community-edition -``` -Note the output install folder and run the post install script: - -```bash -{HOMEBREW-INSTALL-LOCATION}/configure-tce.sh -/home/linuxbrew/.linuxbrew/Cellar/tanzu-community-edition/v0.10.0/libexec/configure-tce.sh -``` - -![Tanzu CLI](images/en05tanzucli.png){.thumbnail} - -#### [Deployment](https://tanzucommunityedition.io/docs/latest/vsphere-install-mgmt/) - -Launch the installer with this command: - -```bash -tanzu management-cluster create --ui -``` - -In the opening browser window, select the vSphere option. - -![vSphere option](images/en06deploy.png){.thumbnail} - -Enter the Hosted Private cloud FQDN and fill in administrative credentials before clicking `Connect`{.action}. - -![credentials](images/en07connect.png){.thumbnail} - -Click `Continue`{.action} to verify the SSL thumbprint. - -![SSL thumbprint](images/en08ssl.png){.thumbnail} - -Select your datacenter and fill in the SSH public key created earlier (.ssh/id_rsa.pub).
-Click `Next`{.action}. - -![SSH](images/en09ssh.png){.thumbnail} - -Choose a type of cluster (Development or Production) and a node size. - -![instance type](images/en10type.png){.thumbnail} - -Fill in the name of your custer, choose a control plane endpoint provider and IP (same subnet but outside of DHCP scope).
-Click `Next`{.action}. - -![cluster](images/en11control.png){.thumbnail} - -NSX Advanced Load Balancer and Metadata sections are optional and we will not edit them.
-Click `Next`{.action} on both of them. - -![NSX - Metadata](images/en12optional.png){.thumbnail} - -Choose your resource locations.
-Click `Next`{.action}. - -![Resources](images/en13resources.png){.thumbnail} - -Enter the Kubernetes Network settings.
-Click `Next`{.action}. - -![Kubernetes](images/en14kubnet.png){.thumbnail} - -Disable Identity Management.
-Click `Next`{.action}. - -![Identity](images/en15identity.png){.thumbnail} - -Select the node template to be used.
-Click `Next`{.action}. - -![node template](images/en16os.png){.thumbnail} - -Click `Review Configuration`{.action}. - -![Review](images/en17review.png){.thumbnail} - -When ready, click `Deploy Management Cluster`{.action}. - -![Deploying cluster](images/en18deploy.png){.thumbnail} - -Upon completion, verify you get a creation message and the nodes are visible in vSphere. - -![Creation message](images/en20created.png){.thumbnail} - -![Visible nodes](images/en21vsphere.png){.thumbnail} - -Get the cluster admin credentials for future interactions: - -```bash -tanzu cluster kubeconfig get "clustername" --admin -``` - -### Tanzu Workload Cluster - -To deploy a workload cluster, we'll duplicate and modify the configuration file for the management cluster.
-Start a terminal window in the bootstrap VM and go to the config file folder. - -```bash -cd .config/tanzu/tkg/clusterconfigs -``` - -Use ls to find the yaml configuration file name and copy it into a new one.
- -```bash -cp existing.yaml new.yaml -``` - -![configuration file name](images/en26copyconf.png){.thumbnail} - -Use a text editor to modify the key fields: - -- CLUSTER_NAME : choose a name for your new cluster -- VSPHERE_CONTROL_PLANE_ENDPOINT : choose an unused IP in the same subnet but not in the DHCP scope -- VSPHERE_FOLDER : this is not mandatory but you can define a different folder for ease of management - -Save and close the file. - -Back in the terminal, run the deploy command calling your new yaml file. - -```bash -tanzu cluster create --file .config/tanzu/tkg/clusterconfigs/new.yaml -``` - -Upon completion, verify you get a creation message and the nodes are visible in vSphere. - -![Creation message](images/en27created.png){.thumbnail} - -![Visible nodes](images/en28vsphere.png){.thumbnail} - -Get the cluster admin credentials for future interactions: - -```bash -tanzu cluster kubeconfig get "clustername" --admin -``` - -TCE is now ready for application install. - -## Go further - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/guide.en-us.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/guide.en-us.md deleted file mode 100644 index 25bdf8d3b5e..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/guide.en-us.md +++ /dev/null @@ -1,354 +0,0 @@ ---- -title: Install Tanzu Community Edition -excerpt: Integrate Tanzu Community Edition (TCE) on your infrastructure -updated: 2022-11-16 ---- - -## Objective - -VMware Tanzu Community Edition (TCE) is a full-featured, easy-to-manage Kubernetes platform. -You can deploy the product on an OVHcloud infrastructure to leverage its functionality and scalability. - -> [!warning] -> -> Tanzu Community Edition is coming to an end of life at the end of 2022 and will no longer be available. VMware has decided to offer free download of VMware Tanzu Kubernetes Grid. You can use our [introduction to Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation) guide to deploy it. -> - -**This guide offers a step by step example of TCE installation** - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/en/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- A deployed [NSX Edge Services Gateway](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_deploying_edge_gateway) -- [DHCP](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_configurer_le_dhcp_sur_une_edge_gateway) services activated on the NSX Gateway - -## Instructions - -### Network - -As stated in the Requirements (with links to full docs), an NSX Edge Services Gateway is used in our study case for Firewall and DHCP purposes.
-Other Network components can be used as alternative, such as pfSense.
- -To set up your Network, you will need to define a public IP for external access and an internal network with DHCP service activated for your TCE infrastructure.
-Your Datacenter comes with a set of public IPs usable for your different needs. They are visible in the Datacenter `Configure`{.action} tab, in the `Network`{.action} section. You will also see the mask and gateway settings on the page.
-Check out our [Adding an IP block](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip) documentation if you are out of usable public IPs. - -![network](images/en00ipblocks.png){.thumbnail} - -> [!warning] -> -> Public IPs marked as "Reserved" are used for Datacenter functions and cannot be used for other services. -> - -For our study case, the NSX Edge Services Gateway is set up with two interfaces as follows: - -- an external interface (Uplink) with a primary and secondary public IPs (xxx.xxx.xxx.225 and xxx.xxx.xxx.226) -- an internal interface (Internal) with private IP 172.16.13.1 on VLAN13
-![internal interface](images/en01nsxinter.png){.thumbnail} -- DHCP service distributing VLAN13 address scope 172.16.13.10 through 172.16.13.100
-![DHCP](images/en02nsxdhcp.png){.thumbnail} -- a SNAT rule to translate adress range 172.16.13.1/24 into secondary public IP xxx.xxx.xxx.226 for external access
-![SNAT rule](images/en03nsxsnat.png){.thumbnail} - -In the [OVHcloud Control Panel](/links/manager), go to the `Security`{.action} tab of your Hosted Private Cloud and add the public IPs to the allowed adresses to connect.
-The addresses should appear as "Authorised and set up". - -![addresses](images/en00ipsec.png){.thumbnail} - -### Node Template - -The TCE clusters require a template to build the nodes. Those can be dowloaded from the [VMware Customer Connect](https://customerconnect.vmware.com/downloads/get-download?downloadGroup=TCE-0100) website. If you do not own an account, you can create one for free. - -Select the latest version of the OVA you need to use and download it locally. - -![OVA download](images/en22down.png){.thumbnail} - -In vSphere, right-click a host or a cluster and select `Deploy OVF Template`{.action}. - -![Deploy OVF template](images/en23ovfdeploy.png){.thumbnail} - -Browse for the OVA file you downloaded and deploy it. - -![Deploy OVA](images/en24ovfopen.png){.thumbnail} - -Once done, right-click the VM and, in the `Template`{.action} section, select `Convert to Template`{.action}. - -![Convert to template](images/en25template.png){.thumbnail} - -### Bootstrap VM - -Once the Network and template are ready, a Bootstrap VM is needed.
-It will hold the necessary software components (Docker and Kubectl) and pilot the installation of TCE.
-We'll use an Ubuntu VM but any OS allowing the install of the necessary items would work.
-VM prerequisites for TCE is 2 CPUs and 6 GB Ram.
-You can deploy a VM [from an ISO](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle) or [from an OVF template](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ovf_template).
- -Make sure the VM is set on the VLAN that will be used for the TCE clusters (VLAN13 in our case).
- -![VLAN](images/en04bootvlan.png){.thumbnail} - -In a terminal window, start with update commands: - -```bash -sudo apt update -``` - -and - -```bash -sudo apt-get install build-essential -``` - -#### Install [NTP](https://vitux.com/how-to-install-ntp-server-and-client-on-ubuntu/) - -```bash -sudo apt-get install ntp -``` - -#### Install [Homebrew](https://www.how2shout.com/linux/how-to-install-brew-ubuntu-20-04-lts-linux/) - -Start with git: - -```bash -sudo apt install git -y -``` - -Run the Homebrew install script: - -```bash -/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" -``` - -Add Homebrew to your path: - -```bash -eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)" -``` - -Install gcc: - -```bash -brew install gcc -``` - -#### Install [Docker Engine](https://docs.docker.com/engine/install/) - -Start with getting the necessary packages: - -```bash -sudo apt-get install \ -ca-certificates \ -curl \ -gnupg \ -lsb-release -``` - -Add Docker’s official GPG key: - -```bash -curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg -``` - -set up the stable repository: - -```bash -echo \ -"deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu \ -$(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null -``` - -Set up the engine: - -```bash -sudo apt-get install docker-ce docker-ce-cli containerd.io -``` - -Post install, add the current user to the docker group to allow it to run it without rights elevation: - -```bash -sudo usermod -aG docker $USER -``` - -#### Install [Kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/) - -Download the lastest package: - -```bash -curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl" -``` - -Run the installer: - -```bash -sudo install -o root -g root -m 0755 kubectl /usr/local/bin/kubectl -``` - -#### SSH Key Pair - -Run the creation command: - -```bash -ssh-keygen -t rsa -b 4096 -C "youremail@yourdomain.com" -``` - -Press Enter to save the key in default path (/root/.ssh/id_rsa).
-Enter and confirm a password for the key.
-Add the private key to the SSH agent running on your machine, and enter the password you created in the previous step. - -```bash -ssh-add ~/.ssh/id_rsa -``` - -Keep the .ssh/id_rsa.pub file handy as it holds the public key you will need to input later for TCE configuration. - -### Tanzu Management Cluster - -The VM is now ready for TCE deployment. - -#### [Tanzu CLI](https://tanzucommunityedition.io/docs/latest/cli-installation/) - -In a terminal window, run the CLI install command: - -```bash -brew install vmware-tanzu/tanzu/tanzu-community-edition -``` -Note the output install folder and run the post install script: - -```bash -{HOMEBREW-INSTALL-LOCATION}/configure-tce.sh -/home/linuxbrew/.linuxbrew/Cellar/tanzu-community-edition/v0.10.0/libexec/configure-tce.sh -``` - -![Tanzu CLI](images/en05tanzucli.png){.thumbnail} - -#### [Deployment](https://tanzucommunityedition.io/docs/latest/vsphere-install-mgmt/) - -Launch the installer with this command: - -```bash -tanzu management-cluster create --ui -``` - -In the opening browser window, select the vSphere option. - -![vSphere option](images/en06deploy.png){.thumbnail} - -Enter the Hosted Private cloud FQDN and fill in administrative credentials before clicking `Connect`{.action}. - -![credentials](images/en07connect.png){.thumbnail} - -Click `Continue`{.action} to verify the SSL thumbprint. - -![SSL thumbprint](images/en08ssl.png){.thumbnail} - -Select your datacenter and fill in the SSH public key created earlier (.ssh/id_rsa.pub).
-Click `Next`{.action}. - -![SSH](images/en09ssh.png){.thumbnail} - -Choose a type of cluster (Development or Production) and a node size. - -![instance type](images/en10type.png){.thumbnail} - -Fill in the name of your custer, choose a control plane endpoint provider and IP (same subnet but outside of DHCP scope).
-Click `Next`{.action}. - -![cluster](images/en11control.png){.thumbnail} - -NSX Advanced Load Balancer and Metadata sections are optional and we will not edit them.
-Click `Next`{.action} on both of them. - -![NSX - Metadata](images/en12optional.png){.thumbnail} - -Choose your resource locations.
-Click `Next`{.action}. - -![Resources](images/en13resources.png){.thumbnail} - -Enter the Kubernetes Network settings.
-Click `Next`{.action}. - -![Kubernetes](images/en14kubnet.png){.thumbnail} - -Disable Identity Management.
-Click `Next`{.action}. - -![Identity](images/en15identity.png){.thumbnail} - -Select the node template to be used.
-Click `Next`{.action}. - -![node template](images/en16os.png){.thumbnail} - -Click `Review Configuration`{.action}. - -![Review](images/en17review.png){.thumbnail} - -When ready, click `Deploy Management Cluster`{.action}. - -![Deploying cluster](images/en18deploy.png){.thumbnail} - -Upon completion, verify you get a creation message and the nodes are visible in vSphere. - -![Creation message](images/en20created.png){.thumbnail} - -![Visible nodes](images/en21vsphere.png){.thumbnail} - -Get the cluster admin credentials for future interactions: - -```bash -tanzu cluster kubeconfig get "clustername" --admin -``` - -### Tanzu Workload Cluster - -To deploy a workload cluster, we'll duplicate and modify the configuration file for the management cluster.
-Start a terminal window in the bootstrap VM and go to the config file folder. - -```bash -cd .config/tanzu/tkg/clusterconfigs -``` - -Use ls to find the yaml configuration file name and copy it into a new one.
- -```bash -cp existing.yaml new.yaml -``` - -![configuration file name](images/en26copyconf.png){.thumbnail} - -Use a text editor to modify the key fields: - -- CLUSTER_NAME : choose a name for your new cluster -- VSPHERE_CONTROL_PLANE_ENDPOINT : choose an unused IP in the same subnet but not in the DHCP scope -- VSPHERE_FOLDER : this is not mandatory but you can define a different folder for ease of management - -Save and close the file. - -Back in the terminal, run the deploy command calling your new yaml file. - -```bash -tanzu cluster create --file .config/tanzu/tkg/clusterconfigs/new.yaml -``` - -Upon completion, verify you get a creation message and the nodes are visible in vSphere. - -![Creation message](images/en27created.png){.thumbnail} - -![Visible nodes](images/en28vsphere.png){.thumbnail} - -Get the cluster admin credentials for future interactions: - -```bash -tanzu cluster kubeconfig get "clustername" --admin -``` - -TCE is now ready for application install. - -## Go further - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/guide.es-es.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/guide.es-es.md deleted file mode 100644 index 1539457c5ad..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/guide.es-es.md +++ /dev/null @@ -1,354 +0,0 @@ ---- -title: Instalar Tanzu Community Edition (EN) -excerpt: Integrate Tanzu Community Edition (TCE) on your infrastructure -updated: 2022-11-16 ---- - -## Objective - -VMware Tanzu Community Edition (TCE) is a full-featured, easy-to-manage Kubernetes platform. -You can deploy the product on an OVHcloud infrastructure to leverage its functionality and scalability. - -> [!warning] -> -> Tanzu Community Edition is coming to an end of life at the end of 2022 and will no longer be available. VMware has decided to offer free download of VMware Tanzu Kubernetes Grid. You can use our [introduction to Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation) guide to deploy it. -> - -**This guide offers a step by step example of TCE installation** - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/es-es/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- A deployed [NSX Edge Services Gateway](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_deploying_edge_gateway) -- [DHCP](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_configurer_le_dhcp_sur_une_edge_gateway) services activated on the NSX Gateway - -## Instructions - -### Network - -As stated in the Requirements (with links to full docs), an NSX Edge Services Gateway is used in our study case for Firewall and DHCP purposes.
-Other Network components can be used as alternative, such as pfSense.
- -To set up your Network, you will need to define a public IP for external access and an internal network with DHCP service activated for your TCE infrastructure.
-Your Datacenter comes with a set of public IPs usable for your different needs. They are visible in the Datacenter `Configure`{.action} tab, in the `Network`{.action} section. You will also see the mask and gateway settings on the page.
-Check out our [Adding an IP block](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip) documentation if you are out of usable public IPs. - -![network](images/en00ipblocks.png){.thumbnail} - -> [!warning] -> -> Public IPs marked as "Reserved" are used for Datacenter functions and cannot be used for other services. -> - -For our study case, the NSX Edge Services Gateway is set up with two interfaces as follows: - -- an external interface (Uplink) with a primary and secondary public IPs (xxx.xxx.xxx.225 and xxx.xxx.xxx.226) -- an internal interface (Internal) with private IP 172.16.13.1 on VLAN13
-![internal interface](images/en01nsxinter.png){.thumbnail} -- DHCP service distributing VLAN13 address scope 172.16.13.10 through 172.16.13.100
-![DHCP](images/en02nsxdhcp.png){.thumbnail} -- a SNAT rule to translate adress range 172.16.13.1/24 into secondary public IP xxx.xxx.xxx.226 for external access
-![SNAT rule](images/en03nsxsnat.png){.thumbnail} - -In the [OVHcloud Control Panel](/links/manager), go to the `Security`{.action} tab of your Hosted Private Cloud and add the public IPs to the allowed adresses to connect.
-The addresses should appear as "Authorised and set up". - -![addresses](images/en00ipsec.png){.thumbnail} - -### Node Template - -The TCE clusters require a template to build the nodes. Those can be dowloaded from the [VMware Customer Connect](https://customerconnect.vmware.com/downloads/get-download?downloadGroup=TCE-0100) website. If you do not own an account, you can create one for free. - -Select the latest version of the OVA you need to use and download it locally. - -![OVA download](images/en22down.png){.thumbnail} - -In vSphere, right-click a host or a cluster and select `Deploy OVF Template`{.action}. - -![Deploy OVF template](images/en23ovfdeploy.png){.thumbnail} - -Browse for the OVA file you downloaded and deploy it. - -![Deploy OVA](images/en24ovfopen.png){.thumbnail} - -Once done, right-click the VM and, in the `Template`{.action} section, select `Convert to Template`{.action}. - -![Convert to template](images/en25template.png){.thumbnail} - -### Bootstrap VM - -Once the Network and template are ready, a Bootstrap VM is needed.
-It will hold the necessary software components (Docker and Kubectl) and pilot the installation of TCE.
-We'll use an Ubuntu VM but any OS allowing the install of the necessary items would work.
-VM prerequisites for TCE is 2 CPUs and 6 GB Ram.
-You can deploy a VM [from an ISO](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle) or [from an OVF template](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ovf_template).
- -Make sure the VM is set on the VLAN that will be used for the TCE clusters (VLAN13 in our case).
- -![VLAN](images/en04bootvlan.png){.thumbnail} - -In a terminal window, start with update commands: - -```bash -sudo apt update -``` - -and - -```bash -sudo apt-get install build-essential -``` - -#### Install [NTP](https://vitux.com/how-to-install-ntp-server-and-client-on-ubuntu/) - -```bash -sudo apt-get install ntp -``` - -#### Install [Homebrew](https://www.how2shout.com/linux/how-to-install-brew-ubuntu-20-04-lts-linux/) - -Start with git: - -```bash -sudo apt install git -y -``` - -Run the Homebrew install script: - -```bash -/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" -``` - -Add Homebrew to your path: - -```bash -eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)" -``` - -Install gcc: - -```bash -brew install gcc -``` - -#### Install [Docker Engine](https://docs.docker.com/engine/install/) - -Start with getting the necessary packages: - -```bash -sudo apt-get install \ -ca-certificates \ -curl \ -gnupg \ -lsb-release -``` - -Add Docker’s official GPG key: - -```bash -curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg -``` - -set up the stable repository: - -```bash -echo \ -"deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu \ -$(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null -``` - -Set up the engine: - -```bash -sudo apt-get install docker-ce docker-ce-cli containerd.io -``` - -Post install, add the current user to the docker group to allow it to run it without rights elevation: - -```bash -sudo usermod -aG docker $USER -``` - -#### Install [Kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/) - -Download the lastest package: - -```bash -curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl" -``` - -Run the installer: - -```bash -sudo install -o root -g root -m 0755 kubectl /usr/local/bin/kubectl -``` - -#### SSH Key Pair - -Run the creation command: - -```bash -ssh-keygen -t rsa -b 4096 -C "youremail@yourdomain.com" -``` - -Press Enter to save the key in default path (/root/.ssh/id_rsa).
-Enter and confirm a password for the key.
-Add the private key to the SSH agent running on your machine, and enter the password you created in the previous step. - -```bash -ssh-add ~/.ssh/id_rsa -``` - -Keep the .ssh/id_rsa.pub file handy as it holds the public key you will need to input later for TCE configuration. - -### Tanzu Management Cluster - -The VM is now ready for TCE deployment. - -#### [Tanzu CLI](https://tanzucommunityedition.io/docs/latest/cli-installation/) - -In a terminal window, run the CLI install command: - -```bash -brew install vmware-tanzu/tanzu/tanzu-community-edition -``` -Note the output install folder and run the post install script: - -```bash -{HOMEBREW-INSTALL-LOCATION}/configure-tce.sh -/home/linuxbrew/.linuxbrew/Cellar/tanzu-community-edition/v0.10.0/libexec/configure-tce.sh -``` - -![Tanzu CLI](images/en05tanzucli.png){.thumbnail} - -#### [Deployment](https://tanzucommunityedition.io/docs/latest/vsphere-install-mgmt/) - -Launch the installer with this command: - -```bash -tanzu management-cluster create --ui -``` - -In the opening browser window, select the vSphere option. - -![vSphere option](images/en06deploy.png){.thumbnail} - -Enter the Hosted Private cloud FQDN and fill in administrative credentials before clicking `Connect`{.action}. - -![credentials](images/en07connect.png){.thumbnail} - -Click `Continue`{.action} to verify the SSL thumbprint. - -![SSL thumbprint](images/en08ssl.png){.thumbnail} - -Select your datacenter and fill in the SSH public key created earlier (.ssh/id_rsa.pub).
-Click `Next`{.action}. - -![SSH](images/en09ssh.png){.thumbnail} - -Choose a type of cluster (Development or Production) and a node size. - -![instance type](images/en10type.png){.thumbnail} - -Fill in the name of your custer, choose a control plane endpoint provider and IP (same subnet but outside of DHCP scope).
-Click `Next`{.action}. - -![cluster](images/en11control.png){.thumbnail} - -NSX Advanced Load Balancer and Metadata sections are optional and we will not edit them.
-Click `Next`{.action} on both of them. - -![NSX - Metadata](images/en12optional.png){.thumbnail} - -Choose your resource locations.
-Click `Next`{.action}. - -![Resources](images/en13resources.png){.thumbnail} - -Enter the Kubernetes Network settings.
-Click `Next`{.action}. - -![Kubernetes](images/en14kubnet.png){.thumbnail} - -Disable Identity Management.
-Click `Next`{.action}. - -![Identity](images/en15identity.png){.thumbnail} - -Select the node template to be used.
-Click `Next`{.action}. - -![node template](images/en16os.png){.thumbnail} - -Click `Review Configuration`{.action}. - -![Review](images/en17review.png){.thumbnail} - -When ready, click `Deploy Management Cluster`{.action}. - -![Deploying cluster](images/en18deploy.png){.thumbnail} - -Upon completion, verify you get a creation message and the nodes are visible in vSphere. - -![Creation message](images/en20created.png){.thumbnail} - -![Visible nodes](images/en21vsphere.png){.thumbnail} - -Get the cluster admin credentials for future interactions: - -```bash -tanzu cluster kubeconfig get "clustername" --admin -``` - -### Tanzu Workload Cluster - -To deploy a workload cluster, we'll duplicate and modify the configuration file for the management cluster.
-Start a terminal window in the bootstrap VM and go to the config file folder. - -```bash -cd .config/tanzu/tkg/clusterconfigs -``` - -Use ls to find the yaml configuration file name and copy it into a new one.
- -```bash -cp existing.yaml new.yaml -``` - -![configuration file name](images/en26copyconf.png){.thumbnail} - -Use a text editor to modify the key fields: - -- CLUSTER_NAME : choose a name for your new cluster -- VSPHERE_CONTROL_PLANE_ENDPOINT : choose an unused IP in the same subnet but not in the DHCP scope -- VSPHERE_FOLDER : this is not mandatory but you can define a different folder for ease of management - -Save and close the file. - -Back in the terminal, run the deploy command calling your new yaml file. - -```bash -tanzu cluster create --file .config/tanzu/tkg/clusterconfigs/new.yaml -``` - -Upon completion, verify you get a creation message and the nodes are visible in vSphere. - -![Creation message](images/en27created.png){.thumbnail} - -![Visible nodes](images/en28vsphere.png){.thumbnail} - -Get the cluster admin credentials for future interactions: - -```bash -tanzu cluster kubeconfig get "clustername" --admin -``` - -TCE is now ready for application install. - -## Go further - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/guide.es-us.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/guide.es-us.md deleted file mode 100644 index da0f9efd373..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/guide.es-us.md +++ /dev/null @@ -1,354 +0,0 @@ ---- -title: Instalar Tanzu Community Edition (EN) -excerpt: Integrate Tanzu Community Edition (TCE) on your infrastructure -updated: 2022-11-16 ---- - -## Objective - -VMware Tanzu Community Edition (TCE) is a full-featured, easy-to-manage Kubernetes platform. -You can deploy the product on an OVHcloud infrastructure to leverage its functionality and scalability. - -> [!warning] -> -> Tanzu Community Edition is coming to an end of life at the end of 2022 and will no longer be available. VMware has decided to offer free download of VMware Tanzu Kubernetes Grid. You can use our [introduction to Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation) guide to deploy it. -> - -**This guide offers a step by step example of TCE installation** - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/es/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- A deployed [NSX Edge Services Gateway](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_deploying_edge_gateway) -- [DHCP](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_configurer_le_dhcp_sur_une_edge_gateway) services activated on the NSX Gateway - -## Instructions - -### Network - -As stated in the Requirements (with links to full docs), an NSX Edge Services Gateway is used in our study case for Firewall and DHCP purposes.
-Other Network components can be used as alternative, such as pfSense.
- -To set up your Network, you will need to define a public IP for external access and an internal network with DHCP service activated for your TCE infrastructure.
-Your Datacenter comes with a set of public IPs usable for your different needs. They are visible in the Datacenter `Configure`{.action} tab, in the `Network`{.action} section. You will also see the mask and gateway settings on the page.
-Check out our [Adding an IP block](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip) documentation if you are out of usable public IPs. - -![network](images/en00ipblocks.png){.thumbnail} - -> [!warning] -> -> Public IPs marked as "Reserved" are used for Datacenter functions and cannot be used for other services. -> - -For our study case, the NSX Edge Services Gateway is set up with two interfaces as follows: - -- an external interface (Uplink) with a primary and secondary public IPs (xxx.xxx.xxx.225 and xxx.xxx.xxx.226) -- an internal interface (Internal) with private IP 172.16.13.1 on VLAN13
-![internal interface](images/en01nsxinter.png){.thumbnail} -- DHCP service distributing VLAN13 address scope 172.16.13.10 through 172.16.13.100
-![DHCP](images/en02nsxdhcp.png){.thumbnail} -- a SNAT rule to translate adress range 172.16.13.1/24 into secondary public IP xxx.xxx.xxx.226 for external access
-![SNAT rule](images/en03nsxsnat.png){.thumbnail} - -In the [OVHcloud Control Panel](/links/manager), go to the `Security`{.action} tab of your Hosted Private Cloud and add the public IPs to the allowed adresses to connect.
-The addresses should appear as "Authorised and set up". - -![addresses](images/en00ipsec.png){.thumbnail} - -### Node Template - -The TCE clusters require a template to build the nodes. Those can be dowloaded from the [VMware Customer Connect](https://customerconnect.vmware.com/downloads/get-download?downloadGroup=TCE-0100) website. If you do not own an account, you can create one for free. - -Select the latest version of the OVA you need to use and download it locally. - -![OVA download](images/en22down.png){.thumbnail} - -In vSphere, right-click a host or a cluster and select `Deploy OVF Template`{.action}. - -![Deploy OVF template](images/en23ovfdeploy.png){.thumbnail} - -Browse for the OVA file you downloaded and deploy it. - -![Deploy OVA](images/en24ovfopen.png){.thumbnail} - -Once done, right-click the VM and, in the `Template`{.action} section, select `Convert to Template`{.action}. - -![Convert to template](images/en25template.png){.thumbnail} - -### Bootstrap VM - -Once the Network and template are ready, a Bootstrap VM is needed.
-It will hold the necessary software components (Docker and Kubectl) and pilot the installation of TCE.
-We'll use an Ubuntu VM but any OS allowing the install of the necessary items would work.
-VM prerequisites for TCE is 2 CPUs and 6 GB Ram.
-You can deploy a VM [from an ISO](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle) or [from an OVF template](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ovf_template).
- -Make sure the VM is set on the VLAN that will be used for the TCE clusters (VLAN13 in our case).
- -![VLAN](images/en04bootvlan.png){.thumbnail} - -In a terminal window, start with update commands: - -```bash -sudo apt update -``` - -and - -```bash -sudo apt-get install build-essential -``` - -#### Install [NTP](https://vitux.com/how-to-install-ntp-server-and-client-on-ubuntu/) - -```bash -sudo apt-get install ntp -``` - -#### Install [Homebrew](https://www.how2shout.com/linux/how-to-install-brew-ubuntu-20-04-lts-linux/) - -Start with git: - -```bash -sudo apt install git -y -``` - -Run the Homebrew install script: - -```bash -/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" -``` - -Add Homebrew to your path: - -```bash -eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)" -``` - -Install gcc: - -```bash -brew install gcc -``` - -#### Install [Docker Engine](https://docs.docker.com/engine/install/) - -Start with getting the necessary packages: - -```bash -sudo apt-get install \ -ca-certificates \ -curl \ -gnupg \ -lsb-release -``` - -Add Docker’s official GPG key: - -```bash -curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg -``` - -set up the stable repository: - -```bash -echo \ -"deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu \ -$(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null -``` - -Set up the engine: - -```bash -sudo apt-get install docker-ce docker-ce-cli containerd.io -``` - -Post install, add the current user to the docker group to allow it to run it without rights elevation: - -```bash -sudo usermod -aG docker $USER -``` - -#### Install [Kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/) - -Download the lastest package: - -```bash -curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl" -``` - -Run the installer: - -```bash -sudo install -o root -g root -m 0755 kubectl /usr/local/bin/kubectl -``` - -#### SSH Key Pair - -Run the creation command: - -```bash -ssh-keygen -t rsa -b 4096 -C "youremail@yourdomain.com" -``` - -Press Enter to save the key in default path (/root/.ssh/id_rsa).
-Enter and confirm a password for the key.
-Add the private key to the SSH agent running on your machine, and enter the password you created in the previous step. - -```bash -ssh-add ~/.ssh/id_rsa -``` - -Keep the .ssh/id_rsa.pub file handy as it holds the public key you will need to input later for TCE configuration. - -### Tanzu Management Cluster - -The VM is now ready for TCE deployment. - -#### [Tanzu CLI](https://tanzucommunityedition.io/docs/latest/cli-installation/) - -In a terminal window, run the CLI install command: - -```bash -brew install vmware-tanzu/tanzu/tanzu-community-edition -``` -Note the output install folder and run the post install script: - -```bash -{HOMEBREW-INSTALL-LOCATION}/configure-tce.sh -/home/linuxbrew/.linuxbrew/Cellar/tanzu-community-edition/v0.10.0/libexec/configure-tce.sh -``` - -![Tanzu CLI](images/en05tanzucli.png){.thumbnail} - -#### [Deployment](https://tanzucommunityedition.io/docs/latest/vsphere-install-mgmt/) - -Launch the installer with this command: - -```bash -tanzu management-cluster create --ui -``` - -In the opening browser window, select the vSphere option. - -![vSphere option](images/en06deploy.png){.thumbnail} - -Enter the Hosted Private cloud FQDN and fill in administrative credentials before clicking `Connect`{.action}. - -![credentials](images/en07connect.png){.thumbnail} - -Click `Continue`{.action} to verify the SSL thumbprint. - -![SSL thumbprint](images/en08ssl.png){.thumbnail} - -Select your datacenter and fill in the SSH public key created earlier (.ssh/id_rsa.pub).
-Click `Next`{.action}. - -![SSH](images/en09ssh.png){.thumbnail} - -Choose a type of cluster (Development or Production) and a node size. - -![instance type](images/en10type.png){.thumbnail} - -Fill in the name of your custer, choose a control plane endpoint provider and IP (same subnet but outside of DHCP scope).
-Click `Next`{.action}. - -![cluster](images/en11control.png){.thumbnail} - -NSX Advanced Load Balancer and Metadata sections are optional and we will not edit them.
-Click `Next`{.action} on both of them. - -![NSX - Metadata](images/en12optional.png){.thumbnail} - -Choose your resource locations.
-Click `Next`{.action}. - -![Resources](images/en13resources.png){.thumbnail} - -Enter the Kubernetes Network settings.
-Click `Next`{.action}. - -![Kubernetes](images/en14kubnet.png){.thumbnail} - -Disable Identity Management.
-Click `Next`{.action}. - -![Identity](images/en15identity.png){.thumbnail} - -Select the node template to be used.
-Click `Next`{.action}. - -![node template](images/en16os.png){.thumbnail} - -Click `Review Configuration`{.action}. - -![Review](images/en17review.png){.thumbnail} - -When ready, click `Deploy Management Cluster`{.action}. - -![Deploying cluster](images/en18deploy.png){.thumbnail} - -Upon completion, verify you get a creation message and the nodes are visible in vSphere. - -![Creation message](images/en20created.png){.thumbnail} - -![Visible nodes](images/en21vsphere.png){.thumbnail} - -Get the cluster admin credentials for future interactions: - -```bash -tanzu cluster kubeconfig get "clustername" --admin -``` - -### Tanzu Workload Cluster - -To deploy a workload cluster, we'll duplicate and modify the configuration file for the management cluster.
-Start a terminal window in the bootstrap VM and go to the config file folder. - -```bash -cd .config/tanzu/tkg/clusterconfigs -``` - -Use ls to find the yaml configuration file name and copy it into a new one.
- -```bash -cp existing.yaml new.yaml -``` - -![configuration file name](images/en26copyconf.png){.thumbnail} - -Use a text editor to modify the key fields: - -- CLUSTER_NAME : choose a name for your new cluster -- VSPHERE_CONTROL_PLANE_ENDPOINT : choose an unused IP in the same subnet but not in the DHCP scope -- VSPHERE_FOLDER : this is not mandatory but you can define a different folder for ease of management - -Save and close the file. - -Back in the terminal, run the deploy command calling your new yaml file. - -```bash -tanzu cluster create --file .config/tanzu/tkg/clusterconfigs/new.yaml -``` - -Upon completion, verify you get a creation message and the nodes are visible in vSphere. - -![Creation message](images/en27created.png){.thumbnail} - -![Visible nodes](images/en28vsphere.png){.thumbnail} - -Get the cluster admin credentials for future interactions: - -```bash -tanzu cluster kubeconfig get "clustername" --admin -``` - -TCE is now ready for application install. - -## Go further - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/guide.fr-ca.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/guide.fr-ca.md deleted file mode 100644 index 0496c7a286a..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/guide.fr-ca.md +++ /dev/null @@ -1,353 +0,0 @@ ---- -title: Installer Tanzu Community Edition -excerpt: Intégrer Tanzu Community Edition (TCE) à votre infrastructure OVHcloud -updated: 2022-11-16 ---- - -## Objectif - -VMware Tanzu Community Edition (TCE) est une plate-forme Kubernetes complète et simple à gérer.
-Vous pouvez déployer ce produit sur votre infrastructure OVHcloud pour profiter de ses fonctionnalités et de son évolutivité. - -> [!warning] -> -> Tanzu Community Edition arrive en End Of Life à la fin de l'année 2022 et ne sera plus disponible. VMware a décidé de proposer le téléchargement gratuit de VMware Tanzu Kubernetes Grid. Vous pouvez consulter notre guide sur la [présentation de Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation) pour le déployer. -> - -**Ce guide est un exemple d'installation étape par étape de TCE.** - -## Prérequis - -- Être contact administrateur de l'infrastructure [Hosted Private Cloud](https://www.ovhcloud.com/fr-ca/enterprise/products/hosted-private-cloud/), afin de recevoir les identifiants de connexion. -- Avoir un identifiant actif dans l'[espace client OVHcloud](/links/manager) -- Avoir un identifiant actif dans vSphere -- Avoir déployé une [NSX Edge Services Gateway](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_deploying_edge_gateway) -- Configurer le service [DHCP](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_configurer_le_dhcp_sur_une_edge_gateway) sur la NSX Gateway - -## En pratique - -### Réseau - -Comme indiqué dans les prérequis ci-dessus, nous utilisons une NSX Edge Gateway pour les services de firewall et de DHCP.
-D'autres composants réseau peuvent servir d'alternative, notament pfSense.
- -Pour paramétrer votre réseau, définissez une adresse IP publique pour l'accès extérieur et un réseau interne avec le service DHCP activé pour l'infrastructure TCE.
-Votre datacenter est livré avec un certain nombre d'IPs publiques utilisables pour vos besoins. Elles sont visibles dans l'onglet `Configurer`{.action} du datacenter, dans la section `Réseau`{.action}. Vous verrez également les paramètres de masque et de passerelle sur la page.
-Consultez notre documentation pour [ajouter un bloc d'IP](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip) si vous n'avez plus d'IP publique utilisable. - -![réseau](images/en00ipblocks.png){.thumbnail} - -> [!warning] -> -> Les adresses IP marquées comme *Reserved* sont utilisées pour les services liés au datacenter et ne sont pas disponibles pour autre chose. -> - -Pour notre exemple, la NSX Edge Services Gateway est paramétrée comme suit avec deux interfaces: - -- une interface externe (*Uplink*) avec une IP publique principale et une secondaire (xxx.xxx.xxx.225 and xxx.xxx.xxx.226) -- une interface interne (*Internal*) avec une IP privée 172.16.13.1 sur le VLAN13
-![internal interface](images/en01nsxinter.png){.thumbnail} -- le service DHCP distribue un pool d'adresses de 172.16.13.10 à 172.16.13.100 sur le VLAN13
-![DHCP](images/en02nsxdhcp.png){.thumbnail} -- Une règle SNAT traduit le réseau 172.16.13.1/24 par l'adresse publique xxx.xxx.xxx.226 pour l'accès externe
-![règle SNAT](images/en03nsxsnat.png){.thumbnail} - -Dans l'[espace client OVHcloud](/links/manager), dans l'onglet `Sécurité`{.action} de votre Hosted Private Cloud, ajoutez les adresses IP publiques utilisées à la liste des adresses autorisées à se connecter.
-Les adresses apparaîtront comme « Autorisé et mis en place ». - -![adresses](images/en00ipsec.png){.thumbnail} - -### Image de noeud - -Les clusters TCE nécessitent l'utilisation d'une image pour créer les nœuds. Cette image peut être téléchargée depuis le site Web [VMware Customer Connect](https://customerconnect.vmware.com/downloads/get-download?downloadGroup=TCE-0100). Si vous ne possédez pas de compte, vous pouvez en créer un gratuitement. - -Sélectionnez la dernière version du fichier OVA à utiliser et téléchargez-la localement. - -![OVA download](images/en22down.png){.thumbnail} - -Dans vSphere, faites un clic-droit sur un hôte ou un cluster et sélectionnez `Déployer un modèle OVF`{.action}. - -![Déploiement modèle OVF](images/en23ovfdeploy.png){.thumbnail} - -Recherchez le fichier OVA téléchargé et déployez-le. - -![Déploiement fichier OVA](images/en24ovfopen.png){.thumbnail} - -Pour finir, faites un clic-droit sur la VM et, dans la section `Modèle`{.action}, sélectionnez `Convertir au modèle`{.action}. - -![Convertir en modèle](images/en25template.png){.thumbnail} - -### VM de Bootstrap - -Une fois le réseau et le modèle prêts, une VM de Bootstrap est nécessaire pour les composants logiciels (Docker et Kubectl) et le pilotage de l'installation de TCE.
-Nous utilisons une machine virtuelle sous Ubuntu, mais tout système d'exploitation permettant l'installation des éléments nécessaires est possible.
-Les prérequis pour TCE sont une VM avec 2 CPU et 6 Go de RAM.
-Vous pouvez déployer une VM [depuis un ISO](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle) ou [depuis un modèle OVF](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ovf_template).
- -Assurez-vous que la machine virtuelle utilise le VLAN défini pour les clusters TCE (VLAN13 dans notre cas).
- -![VLAN](images/en04bootvlan.png){.thumbnail} - -Dans une fenêtre de terminal, commencez par entrer les commandes de mise à jour : - -```bash -sudo apt update -``` - -puis : - -```bash -sudo apt-get install build-essential -``` - -#### Installation de [NTP](https://vitux.com/how-to-install-ntp-server-and-client-on-ubuntu/) - -```bash -sudo apt-get install ntp -``` - -#### Installation de [Homebrew](https://www.how2shout.com/linux/how-to-install-brew-ubuntu-20-04-lts-linux/) - -Installez git : - -```bash -sudo apt install git -y -``` - -Lancez le script d'installation de Homebrew : - -```bash -/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" -``` - -Ajoutez Homebrew à votre path : - -```bash -eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)" -``` - -Installez gcc : - -```bash -brew install gcc -``` - -#### Installation de [Docker Engine](https://docs.docker.com/engine/install/) - -Commencez par les paquets nécessaires : - -```bash -sudo apt-get install \ -ca-certificates \ -curl \ -gnupg \ -lsb-release -``` - -Ajoutez la clé GPG officielle de Docker : - -```bash -curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg -``` - -Paramétrez le repository stable : - -```bash -echo \ -"deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu \ -$(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null -``` - -Paramétrez le moteur : - -```bash -sudo apt-get install docker-ce docker-ce-cli containerd.io -``` - -Après l'installation, ajoutez votre utilisateur au groupe docker pour lui permettre d'exécuter l'application sans élévation de droits : - -```bash -sudo usermod -aG docker $USER -``` - -#### Installation de [Kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/) - -Téléchargez le dernier package : - -```bash -curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl" -``` - -Lancez l'installateur : - -```bash -sudo install -o root -g root -m 0755 kubectl /usr/local/bin/kubectl -``` - -#### SSH Key Pair - -Lancez la commande de création : - -```bash -ssh-keygen -t rsa -b 4096 -C "youremail@yourdomain.com" -``` - -Appuyez sur « Entrée » pour sauvegarder la clé dans le chemin par défaut (/root/.ssh/id_rsa).
-Entrez et confirmez un mot de passe pour la clé.
-Ajoutez la clé privée à l'agent SSH en cours d'exécution sur votre VM et entrez le mot de passe créé à l'étape précédente. - -```bash -ssh-add ~/.ssh/id_rsa -``` - -Gardez le fichier .ssh/id_rsa.pub sous la main, il contient la clé publique nécessaire pour la configuration de TCE. - -### Tanzu Management Cluster - -La VM est maintenant prête pour le déploiement de TCE. - -#### [Tanzu CLI](https://tanzucommunityedition.io/docs/latest/cli-installation/) - -Dans un terminal, lancez la commande d'installation de la CLI : - -```bash -brew install vmware-tanzu/tanzu/tanzu-community-edition -``` - -Notez le dossier d'installation et exécutez le script post-installation : - -```bash -{HOMEBREW-INSTALL-LOCATION}/configure-tce.sh -/home/linuxbrew/.linuxbrew/Cellar/tanzu-community-edition/v0.10.0/libexec/configure-tce.sh -``` - -![Tanzu CLI](images/en05tanzucli.png){.thumbnail} - -#### [Déploiement](https://tanzucommunityedition.io/docs/latest/vsphere-install-mgmt/) - -Lancez le programme d'installation avec la commande suivante : - -```bash -tanzu management-cluster create --ui -``` - -Dans la fenêtre du navigateur qui s'affiche, sélectionnez l'option vSphere. - -![option vSphere](images/en06deploy.png){.thumbnail} - -Entrez le FQDN du Hosted Private Cloud et remplissez les informations d'identification avant de cliquer sur `Connect`{.action}. - -![credentials](images/en07connect.png){.thumbnail} - -Cliquez sur `Continue`{.action} pour verifier la SSL thumbprint. - -![SSL thumbprint](images/en08ssl.png){.thumbnail} - -Sélectionnez votre datacenter et fournissez la clé publique SSH créée précédement (.ssh/id_rsa.pub).
-Cliquez sur `Next`{.action}. - -![SSH](images/en09ssh.png){.thumbnail} - -Choisissez un type de cluster (Development ou Production) et une taille pour les noeuds. - -![type d'instance](images/en10type.png){.thumbnail} - -Entrez un nom de cluster, choisissez un plane endpoint provider et une IP (en dehors du pool DHCP mais dans le même sous-réseau).
-Cliquez sur `Next`{.action}. - -![cluster](images/en11control.png){.thumbnail} - -NSX Advanced Load Balancer et Metadata sont des sections optionelles que nous n'éditerons pas.
-Cliquez sur `Next`{.action} pour les deux. - -![NSX- Metadata](images/en12optional.png){.thumbnail} - -Choisissez vos emplacements de ressource.
-Cliquez sur `Next`{.action}. - -![Ressources](images/en13resources.png){.thumbnail} - -Entrez les paramètres du réseau Kubernetes.
-Cliquez sur `Next`{.action}. - -![Kubernetes](images/en14kubnet.png){.thumbnail} - -Désactivez l'Identity Management.
-Cliquez sur `Next`{.action}. - -![Identity](images/en15identity.png){.thumbnail} - -Selectionnez le modèle pour les noeuds.
-Cliquez sur `Next`{.action}. - -![modèle de noeuds](images/en16os.png){.thumbnail} - -Cliquez sur `Review Configuration`{.action}. - -![Review](images/en17review.png){.thumbnail} - -Cliquez sur `Deploy Management Cluster`{.action}. - -![Déploiement](images/en18deploy.png){.thumbnail} - -Une fois l'opération terminée, vérifiez que vous voyez le message de création et que les nœuds sont visibles dans vSphere. - -![message de création](images/en20created.png){.thumbnail} - -![noeuds visibles](images/en21vsphere.png){.thumbnail} - -Enregistrez les informations d'identification de l'administrateur du cluster : - -```bash -tanzu cluster kubeconfig get "clustername" --admin -``` - -### Tanzu Workload Cluster - -Pour déployer un cluster de workload, dupliquez et modifiez le fichier de configuration du cluster de management.
-Dans un terminal, dans la VM de bootstrap, allez dans le dossier contenant le fichier de configuration.
- -```bash -cd .config/tanzu/tkg/clusterconfigs -``` - -Utilisez ls pour récupérer le nom du fichier yaml puis dupliquez-le avec un nouveau nom.
- -```bash -cp existing.yaml new.yaml -``` - -![nom du fichier yaml](images/en26copyconf.png){.thumbnail} - -Utilisez un éditeur de texte pour modifier les champs clés : - -- CLUSTER_NAME : choisissez un nom pour le nouveau cluster. -- VSPHERE_CONTROL_PLANE_ENDPOINT : choisissez une IP libre sur le même sous réseau mais hors du pool DHCP. -- VSPHERE_FOLDER : ce n'est pas obligatoire mais vous pouvez définir un dossier différent pour faciliter la gestion.
-Sauvegardez et fermez le fichier. - -De retour dans le terminal, exécutez la commande de déploiement avec votre nouveau fichier yaml.
- -```bash -tanzu cluster create --file .config/tanzu/tkg/clusterconfigs/new.yaml -``` - -Une fois l'opération terminée, vérifiez que vous voyez le message de création et que les nœuds sont visibles dans vSphere. - -![message de création](images/en27created.png){.thumbnail} - -![noeuds visibles](images/en28vsphere.png){.thumbnail} - -Enregistrez les informations d'identification de l'administrateur du cluster : - -```bash -tanzu cluster kubeconfig get "clustername" --admin -``` - -TCE est maintenant prêt à recevoir vos applications. - -## Aller plus loin - -Si vous avez besoin d'une formation ou d'une assistance technique pour la mise en oeuvre de nos solutions, contactez votre commercial ou cliquez sur [ce lien](/links/professional-services) pour obtenir un devis et demander une analyse personnalisée de votre projet à nos experts de l’équipe Professional Services. - -Échangez avec notre [communauté d'utilisateurs](/links/community). diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/guide.fr-fr.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/guide.fr-fr.md deleted file mode 100644 index 8183a2e8fd2..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/guide.fr-fr.md +++ /dev/null @@ -1,353 +0,0 @@ ---- -title: Installer Tanzu Community Edition -excerpt: Intégrer Tanzu Community Edition (TCE) à votre infrastructure OVHcloud -updated: 2022-11-16 ---- - -## Objectif - -VMware Tanzu Community Edition (TCE) est une plate-forme Kubernetes complète et simple à gérer.
-Vous pouvez déployer ce produit sur votre infrastructure OVHcloud pour profiter de ses fonctionnalités et de son évolutivité. - -> [!warning] -> -> Tanzu Community Edition arrive en End Of Life à la fin de l'année 2022 et ne sera plus disponible. VMware a décidé de proposer le téléchargement gratuit de VMware Tanzu Kubernetes Grid. Vous pouvez consulter notre guide sur la [présentation de Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation) pour le déployer. -> - -**Ce guide est un exemple d'installation étape par étape de TCE.** - -## Prérequis - -- Être contact administrateur de l'infrastructure [Hosted Private Cloud](https://www.ovhcloud.com/fr/enterprise/products/hosted-private-cloud/), afin de recevoir les identifiants de connexion. -- Avoir un identifiant actif dans l'[espace client OVHcloud](/links/manager) -- Avoir un identifiant actif dans vSphere -- Avoir déployé une [NSX Edge Services Gateway](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_deploying_edge_gateway) -- Configurer le service [DHCP](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_configurer_le_dhcp_sur_une_edge_gateway) sur la NSX Gateway - -## En pratique - -### Réseau - -Comme indiqué dans les prérequis ci-dessus, nous utilisons une NSX Edge Gateway pour les services de firewall et de DHCP.
-D'autres composants réseau peuvent servir d'alternative, notament pfSense.
- -Pour paramétrer votre réseau, définissez une adresse IP publique pour l'accès extérieur et un réseau interne avec le service DHCP activé pour l'infrastructure TCE.
-Votre datacenter est livré avec un certain nombre d'IPs publiques utilisables pour vos besoins. Elles sont visibles dans l'onglet `Configurer`{.action} du datacenter, dans la section `Réseau`{.action}. Vous verrez également les paramètres de masque et de passerelle sur la page.
-Consultez notre documentation pour [ajouter un bloc d'IP](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip) si vous n'avez plus d'IP publique utilisable. - -![réseau](images/en00ipblocks.png){.thumbnail} - -> [!warning] -> -> Les adresses IP marquées comme *Reserved* sont utilisées pour les services liés au datacenter et ne sont pas disponibles pour autre chose. -> - -Pour notre exemple, la NSX Edge Services Gateway est paramétrée comme suit avec deux interfaces: - -- une interface externe (*Uplink*) avec une IP publique principale et une secondaire (xxx.xxx.xxx.225 and xxx.xxx.xxx.226) -- une interface interne (*Internal*) avec une IP privée 172.16.13.1 sur le VLAN13
-![internal interface](images/en01nsxinter.png){.thumbnail} -- le service DHCP distribue un pool d'adresses de 172.16.13.10 à 172.16.13.100 sur le VLAN13
-![DHCP](images/en02nsxdhcp.png){.thumbnail} -- Une règle SNAT traduit le réseau 172.16.13.1/24 par l'adresse publique xxx.xxx.xxx.226 pour l'accès externe
-![règle SNAT](images/en03nsxsnat.png){.thumbnail} - -Dans l'[espace client OVHcloud](/links/manager), dans l'onglet `Sécurité`{.action} de votre Hosted Private Cloud, ajoutez les adresses IP publiques utilisées à la liste des adresses autorisées à se connecter.
-Les adresses apparaîtront comme « Autorisé et mis en place ». - -![adresses](images/en00ipsec.png){.thumbnail} - -### Image de noeud - -Les clusters TCE nécessitent l'utilisation d'une image pour créer les nœuds. Cette image peut être téléchargée depuis le site Web [VMware Customer Connect](https://customerconnect.vmware.com/downloads/get-download?downloadGroup=TCE-0100). Si vous ne possédez pas de compte, vous pouvez en créer un gratuitement. - -Sélectionnez la dernière version du fichier OVA à utiliser et téléchargez-la localement. - -![OVA download](images/en22down.png){.thumbnail} - -Dans vSphere, faites un clic-droit sur un hôte ou un cluster et sélectionnez `Déployer un modèle OVF`{.action}. - -![Déploiement modèle OVF](images/en23ovfdeploy.png){.thumbnail} - -Recherchez le fichier OVA téléchargé et déployez-le. - -![Déploiement fichier OVA](images/en24ovfopen.png){.thumbnail} - -Pour finir, faites un clic-droit sur la VM et, dans la section `Modèle`{.action}, sélectionnez `Convertir au modèle`{.action}. - -![Convertir en modèle](images/en25template.png){.thumbnail} - -### VM de Bootstrap - -Une fois le réseau et le modèle prêts, une VM de Bootstrap est nécessaire pour les composants logiciels (Docker et Kubectl) et le pilotage de l'installation de TCE.
-Nous utilisons une machine virtuelle sous Ubuntu, mais tout système d'exploitation permettant l'installation des éléments nécessaires est possible.
-Les prérequis pour TCE sont une VM avec 2 CPU et 6 Go de RAM.
-Vous pouvez déployer une VM [depuis un ISO](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle) ou [depuis un modèle OVF](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ovf_template).
- -Assurez-vous que la machine virtuelle utilise le VLAN défini pour les clusters TCE (VLAN13 dans notre cas).
- -![VLAN](images/en04bootvlan.png){.thumbnail} - -Dans une fenêtre de terminal, commencez par entrer les commandes de mise à jour : - -```bash -sudo apt update -``` - -puis : - -```bash -sudo apt-get install build-essential -``` - -#### Installation de [NTP](https://vitux.com/how-to-install-ntp-server-and-client-on-ubuntu/) - -```bash -sudo apt-get install ntp -``` - -#### Installation de [Homebrew](https://www.how2shout.com/linux/how-to-install-brew-ubuntu-20-04-lts-linux/) - -Installez git : - -```bash -sudo apt install git -y -``` - -Lancez le script d'installation de Homebrew : - -```bash -/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" -``` - -Ajoutez Homebrew à votre path : - -```bash -eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)" -``` - -Installez gcc : - -```bash -brew install gcc -``` - -#### Installation de [Docker Engine](https://docs.docker.com/engine/install/) - -Commencez par les paquets nécessaires : - -```bash -sudo apt-get install \ -ca-certificates \ -curl \ -gnupg \ -lsb-release -``` - -Ajoutez la clé GPG officielle de Docker : - -```bash -curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg -``` - -Paramétrez le repository stable : - -```bash -echo \ -"deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu \ -$(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null -``` - -Paramétrez le moteur : - -```bash -sudo apt-get install docker-ce docker-ce-cli containerd.io -``` - -Après l'installation, ajoutez votre utilisateur au groupe docker pour lui permettre d'exécuter l'application sans élévation de droits : - -```bash -sudo usermod -aG docker $USER -``` - -#### Installation de [Kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/) - -Téléchargez le dernier package : - -```bash -curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl" -``` - -Lancez l'installateur : - -```bash -sudo install -o root -g root -m 0755 kubectl /usr/local/bin/kubectl -``` - -#### SSH Key Pair - -Lancez la commande de création : - -```bash -ssh-keygen -t rsa -b 4096 -C "youremail@yourdomain.com" -``` - -Appuyez sur « Entrée » pour sauvegarder la clé dans le chemin par défaut (/root/.ssh/id_rsa).
-Entrez et confirmez un mot de passe pour la clé.
-Ajoutez la clé privée à l'agent SSH en cours d'exécution sur votre VM et entrez le mot de passe créé à l'étape précédente. - -```bash -ssh-add ~/.ssh/id_rsa -``` - -Gardez le fichier .ssh/id_rsa.pub sous la main, il contient la clé publique nécessaire pour la configuration de TCE. - -### Tanzu Management Cluster - -La VM est maintenant prête pour le déploiement de TCE. - -#### [Tanzu CLI](https://tanzucommunityedition.io/docs/latest/cli-installation/) - -Dans un terminal, lancez la commande d'installation de la CLI : - -```bash -brew install vmware-tanzu/tanzu/tanzu-community-edition -``` - -Notez le dossier d'installation et exécutez le script post-installation : - -```bash -{HOMEBREW-INSTALL-LOCATION}/configure-tce.sh -/home/linuxbrew/.linuxbrew/Cellar/tanzu-community-edition/v0.10.0/libexec/configure-tce.sh -``` - -![Tanzu CLI](images/en05tanzucli.png){.thumbnail} - -#### [Déploiement](https://tanzucommunityedition.io/docs/latest/vsphere-install-mgmt/) - -Lancez le programme d'installation avec la commande suivante : - -```bash -tanzu management-cluster create --ui -``` - -Dans la fenêtre du navigateur qui s'affiche, sélectionnez l'option vSphere. - -![option vSphere](images/en06deploy.png){.thumbnail} - -Entrez le FQDN du Hosted Private Cloud et remplissez les informations d'identification avant de cliquer sur `Connect`{.action}. - -![credentials](images/en07connect.png){.thumbnail} - -Cliquez sur `Continue`{.action} pour verifier la SSL thumbprint. - -![SSL thumbprint](images/en08ssl.png){.thumbnail} - -Sélectionnez votre datacenter et fournissez la clé publique SSH créée précédement (.ssh/id_rsa.pub).
-Cliquez sur `Next`{.action}. - -![SSH](images/en09ssh.png){.thumbnail} - -Choisissez un type de cluster (Development ou Production) et une taille pour les noeuds. - -![type d'instance](images/en10type.png){.thumbnail} - -Entrez un nom de cluster, choisissez un plane endpoint provider et une IP (en dehors du pool DHCP mais dans le même sous-réseau).
-Cliquez sur `Next`{.action}. - -![cluster](images/en11control.png){.thumbnail} - -NSX Advanced Load Balancer et Metadata sont des sections optionelles que nous n'éditerons pas.
-Cliquez sur `Next`{.action} pour les deux. - -![NSX- Metadata](images/en12optional.png){.thumbnail} - -Choisissez vos emplacements de ressource.
-Cliquez sur `Next`{.action}. - -![Ressources](images/en13resources.png){.thumbnail} - -Entrez les paramètres du réseau Kubernetes.
-Cliquez sur `Next`{.action}. - -![Kubernetes](images/en14kubnet.png){.thumbnail} - -Désactivez l'Identity Management.
-Cliquez sur `Next`{.action}. - -![Identity](images/en15identity.png){.thumbnail} - -Selectionnez le modèle pour les noeuds.
-Cliquez sur `Next`{.action}. - -![modèle de noeuds](images/en16os.png){.thumbnail} - -Cliquez sur `Review Configuration`{.action}. - -![Review](images/en17review.png){.thumbnail} - -Cliquez sur `Deploy Management Cluster`{.action}. - -![Déploiement](images/en18deploy.png){.thumbnail} - -Une fois l'opération terminée, vérifiez que vous voyez le message de création et que les nœuds sont visibles dans vSphere. - -![message de création](images/en20created.png){.thumbnail} - -![noeuds visibles](images/en21vsphere.png){.thumbnail} - -Enregistrez les informations d'identification de l'administrateur du cluster : - -```bash -tanzu cluster kubeconfig get "clustername" --admin -``` - -### Tanzu Workload Cluster - -Pour déployer un cluster de workload, dupliquez et modifiez le fichier de configuration du cluster de management.
-Dans un terminal, dans la VM de bootstrap, allez dans le dossier contenant le fichier de configuration.
- -```bash -cd .config/tanzu/tkg/clusterconfigs -``` - -Utilisez ls pour récupérer le nom du fichier yaml puis dupliquez-le avec un nouveau nom.
- -```bash -cp existing.yaml new.yaml -``` - -![nom du fichier yaml](images/en26copyconf.png){.thumbnail} - -Utilisez un éditeur de texte pour modifier les champs clés : - -- CLUSTER_NAME : choisissez un nom pour le nouveau cluster. -- VSPHERE_CONTROL_PLANE_ENDPOINT : choisissez une IP libre sur le même sous réseau mais hors du pool DHCP. -- VSPHERE_FOLDER : ce n'est pas obligatoire mais vous pouvez définir un dossier différent pour faciliter la gestion.
-Sauvegardez et fermez le fichier. - -De retour dans le terminal, exécutez la commande de déploiement avec votre nouveau fichier yaml.
- -```bash -tanzu cluster create --file .config/tanzu/tkg/clusterconfigs/new.yaml -``` - -Une fois l'opération terminée, vérifiez que vous voyez le message de création et que les nœuds sont visibles dans vSphere. - -![message de création](images/en27created.png){.thumbnail} - -![noeuds visibles](images/en28vsphere.png){.thumbnail} - -Enregistrez les informations d'identification de l'administrateur du cluster : - -```bash -tanzu cluster kubeconfig get "clustername" --admin -``` - -TCE est maintenant prêt à recevoir vos applications. - -## Aller plus loin - -Si vous avez besoin d'une formation ou d'une assistance technique pour la mise en oeuvre de nos solutions, contactez votre commercial ou cliquez sur [ce lien](/links/professional-services) pour obtenir un devis et demander une analyse personnalisée de votre projet à nos experts de l’équipe Professional Services. - -Échangez avec notre [communauté d'utilisateurs](/links/community). diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/guide.it-it.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/guide.it-it.md deleted file mode 100644 index fae65c55fd5..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/guide.it-it.md +++ /dev/null @@ -1,354 +0,0 @@ ---- -title: Installa Tanzu Community Edition (EN) -excerpt: Integrate Tanzu Community Edition (TCE) on your infrastructure -updated: 2022-11-16 ---- - -## Objective - -VMware Tanzu Community Edition (TCE) is a full-featured, easy-to-manage Kubernetes platform. -You can deploy the product on an OVHcloud infrastructure to leverage its functionality and scalability. - -> [!warning] -> -> Tanzu Community Edition is coming to an end of life at the end of 2022 and will no longer be available. VMware has decided to offer free download of VMware Tanzu Kubernetes Grid. You can use our [introduction to Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation) guide to deploy it. -> - -**This guide offers a step by step example of TCE installation** - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/it/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- A deployed [NSX Edge Services Gateway](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_deploying_edge_gateway) -- [DHCP](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_configurer_le_dhcp_sur_une_edge_gateway) services activated on the NSX Gateway - -## Instructions - -### Network - -As stated in the Requirements (with links to full docs), an NSX Edge Services Gateway is used in our study case for Firewall and DHCP purposes.
-Other Network components can be used as alternative, such as pfSense.
- -To set up your Network, you will need to define a public IP for external access and an internal network with DHCP service activated for your TCE infrastructure.
-Your Datacenter comes with a set of public IPs usable for your different needs. They are visible in the Datacenter `Configure`{.action} tab, in the `Network`{.action} section. You will also see the mask and gateway settings on the page.
-Check out our [Adding an IP block](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip) documentation if you are out of usable public IPs. - -![network](images/en00ipblocks.png){.thumbnail} - -> [!warning] -> -> Public IPs marked as "Reserved" are used for Datacenter functions and cannot be used for other services. -> - -For our study case, the NSX Edge Services Gateway is set up with two interfaces as follows: - -- an external interface (Uplink) with a primary and secondary public IPs (xxx.xxx.xxx.225 and xxx.xxx.xxx.226) -- an internal interface (Internal) with private IP 172.16.13.1 on VLAN13
-![internal interface](images/en01nsxinter.png){.thumbnail} -- DHCP service distributing VLAN13 address scope 172.16.13.10 through 172.16.13.100
-![DHCP](images/en02nsxdhcp.png){.thumbnail} -- a SNAT rule to translate adress range 172.16.13.1/24 into secondary public IP xxx.xxx.xxx.226 for external access
-![SNAT rule](images/en03nsxsnat.png){.thumbnail} - -In the [OVHcloud Control Panel](/links/manager), go to the `Security`{.action} tab of your Hosted Private Cloud and add the public IPs to the allowed adresses to connect.
-The addresses should appear as "Authorised and set up". - -![addresses](images/en00ipsec.png){.thumbnail} - -### Node Template - -The TCE clusters require a template to build the nodes. Those can be dowloaded from the [VMware Customer Connect](https://customerconnect.vmware.com/downloads/get-download?downloadGroup=TCE-0100) website. If you do not own an account, you can create one for free. - -Select the latest version of the OVA you need to use and download it locally. - -![OVA download](images/en22down.png){.thumbnail} - -In vSphere, right-click a host or a cluster and select `Deploy OVF Template`{.action}. - -![Deploy OVF template](images/en23ovfdeploy.png){.thumbnail} - -Browse for the OVA file you downloaded and deploy it. - -![Deploy OVA](images/en24ovfopen.png){.thumbnail} - -Once done, right-click the VM and, in the `Template`{.action} section, select `Convert to Template`{.action}. - -![Convert to template](images/en25template.png){.thumbnail} - -### Bootstrap VM - -Once the Network and template are ready, a Bootstrap VM is needed.
-It will hold the necessary software components (Docker and Kubectl) and pilot the installation of TCE.
-We'll use an Ubuntu VM but any OS allowing the install of the necessary items would work.
-VM prerequisites for TCE is 2 CPUs and 6 GB Ram.
-You can deploy a VM [from an ISO](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle) or [from an OVF template](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ovf_template).
- -Make sure the VM is set on the VLAN that will be used for the TCE clusters (VLAN13 in our case).
- -![VLAN](images/en04bootvlan.png){.thumbnail} - -In a terminal window, start with update commands: - -```bash -sudo apt update -``` - -and - -```bash -sudo apt-get install build-essential -``` - -#### Install [NTP](https://vitux.com/how-to-install-ntp-server-and-client-on-ubuntu/) - -```bash -sudo apt-get install ntp -``` - -#### Install [Homebrew](https://www.how2shout.com/linux/how-to-install-brew-ubuntu-20-04-lts-linux/) - -Start with git: - -```bash -sudo apt install git -y -``` - -Run the Homebrew install script: - -```bash -/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" -``` - -Add Homebrew to your path: - -```bash -eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)" -``` - -Install gcc: - -```bash -brew install gcc -``` - -#### Install [Docker Engine](https://docs.docker.com/engine/install/) - -Start with getting the necessary packages: - -```bash -sudo apt-get install \ -ca-certificates \ -curl \ -gnupg \ -lsb-release -``` - -Add Docker’s official GPG key: - -```bash -curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg -``` - -set up the stable repository: - -```bash -echo \ -"deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu \ -$(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null -``` - -Set up the engine: - -```bash -sudo apt-get install docker-ce docker-ce-cli containerd.io -``` - -Post install, add the current user to the docker group to allow it to run it without rights elevation: - -```bash -sudo usermod -aG docker $USER -``` - -#### Install [Kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/) - -Download the lastest package: - -```bash -curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl" -``` - -Run the installer: - -```bash -sudo install -o root -g root -m 0755 kubectl /usr/local/bin/kubectl -``` - -#### SSH Key Pair - -Run the creation command: - -```bash -ssh-keygen -t rsa -b 4096 -C "youremail@yourdomain.com" -``` - -Press Enter to save the key in default path (/root/.ssh/id_rsa).
-Enter and confirm a password for the key.
-Add the private key to the SSH agent running on your machine, and enter the password you created in the previous step. - -```bash -ssh-add ~/.ssh/id_rsa -``` - -Keep the .ssh/id_rsa.pub file handy as it holds the public key you will need to input later for TCE configuration. - -### Tanzu Management Cluster - -The VM is now ready for TCE deployment. - -#### [Tanzu CLI](https://tanzucommunityedition.io/docs/latest/cli-installation/) - -In a terminal window, run the CLI install command: - -```bash -brew install vmware-tanzu/tanzu/tanzu-community-edition -``` -Note the output install folder and run the post install script: - -```bash -{HOMEBREW-INSTALL-LOCATION}/configure-tce.sh -/home/linuxbrew/.linuxbrew/Cellar/tanzu-community-edition/v0.10.0/libexec/configure-tce.sh -``` - -![Tanzu CLI](images/en05tanzucli.png){.thumbnail} - -#### [Deployment](https://tanzucommunityedition.io/docs/latest/vsphere-install-mgmt/) - -Launch the installer with this command: - -```bash -tanzu management-cluster create --ui -``` - -In the opening browser window, select the vSphere option. - -![vSphere option](images/en06deploy.png){.thumbnail} - -Enter the Hosted Private cloud FQDN and fill in administrative credentials before clicking `Connect`{.action}. - -![credentials](images/en07connect.png){.thumbnail} - -Click `Continue`{.action} to verify the SSL thumbprint. - -![SSL thumbprint](images/en08ssl.png){.thumbnail} - -Select your datacenter and fill in the SSH public key created earlier (.ssh/id_rsa.pub).
-Click `Next`{.action}. - -![SSH](images/en09ssh.png){.thumbnail} - -Choose a type of cluster (Development or Production) and a node size. - -![instance type](images/en10type.png){.thumbnail} - -Fill in the name of your custer, choose a control plane endpoint provider and IP (same subnet but outside of DHCP scope).
-Click `Next`{.action}. - -![cluster](images/en11control.png){.thumbnail} - -NSX Advanced Load Balancer and Metadata sections are optional and we will not edit them.
-Click `Next`{.action} on both of them. - -![NSX - Metadata](images/en12optional.png){.thumbnail} - -Choose your resource locations.
-Click `Next`{.action}. - -![Resources](images/en13resources.png){.thumbnail} - -Enter the Kubernetes Network settings.
-Click `Next`{.action}. - -![Kubernetes](images/en14kubnet.png){.thumbnail} - -Disable Identity Management.
-Click `Next`{.action}. - -![Identity](images/en15identity.png){.thumbnail} - -Select the node template to be used.
-Click `Next`{.action}. - -![node template](images/en16os.png){.thumbnail} - -Click `Review Configuration`{.action}. - -![Review](images/en17review.png){.thumbnail} - -When ready, click `Deploy Management Cluster`{.action}. - -![Deploying cluster](images/en18deploy.png){.thumbnail} - -Upon completion, verify you get a creation message and the nodes are visible in vSphere. - -![Creation message](images/en20created.png){.thumbnail} - -![Visible nodes](images/en21vsphere.png){.thumbnail} - -Get the cluster admin credentials for future interactions: - -```bash -tanzu cluster kubeconfig get "clustername" --admin -``` - -### Tanzu Workload Cluster - -To deploy a workload cluster, we'll duplicate and modify the configuration file for the management cluster.
-Start a terminal window in the bootstrap VM and go to the config file folder. - -```bash -cd .config/tanzu/tkg/clusterconfigs -``` - -Use ls to find the yaml configuration file name and copy it into a new one.
- -```bash -cp existing.yaml new.yaml -``` - -![configuration file name](images/en26copyconf.png){.thumbnail} - -Use a text editor to modify the key fields: - -- CLUSTER_NAME : choose a name for your new cluster -- VSPHERE_CONTROL_PLANE_ENDPOINT : choose an unused IP in the same subnet but not in the DHCP scope -- VSPHERE_FOLDER : this is not mandatory but you can define a different folder for ease of management - -Save and close the file. - -Back in the terminal, run the deploy command calling your new yaml file. - -```bash -tanzu cluster create --file .config/tanzu/tkg/clusterconfigs/new.yaml -``` - -Upon completion, verify you get a creation message and the nodes are visible in vSphere. - -![Creation message](images/en27created.png){.thumbnail} - -![Visible nodes](images/en28vsphere.png){.thumbnail} - -Get the cluster admin credentials for future interactions: - -```bash -tanzu cluster kubeconfig get "clustername" --admin -``` - -TCE is now ready for application install. - -## Go further - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/guide.pl-pl.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/guide.pl-pl.md deleted file mode 100644 index 448ef501c61..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/guide.pl-pl.md +++ /dev/null @@ -1,354 +0,0 @@ ---- -title: Zainstaluj Tanzu Community Edition (EN) -excerpt: Integrate Tanzu Community Edition (TCE) on your infrastructure -updated: 2022-11-16 ---- - -## Objective - -VMware Tanzu Community Edition (TCE) is a full-featured, easy-to-manage Kubernetes platform. -You can deploy the product on an OVHcloud infrastructure to leverage its functionality and scalability. - -> [!warning] -> -> Tanzu Community Edition is coming to an end of life at the end of 2022 and will no longer be available. VMware has decided to offer free download of VMware Tanzu Kubernetes Grid. You can use our [introduction to Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation) guide to deploy it. -> - -**This guide offers a step by step example of TCE installation** - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/pl/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- A deployed [NSX Edge Services Gateway](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_deploying_edge_gateway) -- [DHCP](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_configurer_le_dhcp_sur_une_edge_gateway) services activated on the NSX Gateway - -## Instructions - -### Network - -As stated in the Requirements (with links to full docs), an NSX Edge Services Gateway is used in our study case for Firewall and DHCP purposes.
-Other Network components can be used as alternative, such as pfSense.
- -To set up your Network, you will need to define a public IP for external access and an internal network with DHCP service activated for your TCE infrastructure.
-Your Datacenter comes with a set of public IPs usable for your different needs. They are visible in the Datacenter `Configure`{.action} tab, in the `Network`{.action} section. You will also see the mask and gateway settings on the page.
-Check out our [Adding an IP block](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip) documentation if you are out of usable public IPs. - -![network](images/en00ipblocks.png){.thumbnail} - -> [!warning] -> -> Public IPs marked as "Reserved" are used for Datacenter functions and cannot be used for other services. -> - -For our study case, the NSX Edge Services Gateway is set up with two interfaces as follows: - -- an external interface (Uplink) with a primary and secondary public IPs (xxx.xxx.xxx.225 and xxx.xxx.xxx.226) -- an internal interface (Internal) with private IP 172.16.13.1 on VLAN13
-![internal interface](images/en01nsxinter.png){.thumbnail} -- DHCP service distributing VLAN13 address scope 172.16.13.10 through 172.16.13.100
-![DHCP](images/en02nsxdhcp.png){.thumbnail} -- a SNAT rule to translate adress range 172.16.13.1/24 into secondary public IP xxx.xxx.xxx.226 for external access
-![SNAT rule](images/en03nsxsnat.png){.thumbnail} - -In the [OVHcloud Control Panel](/links/manager), go to the `Security`{.action} tab of your Hosted Private Cloud and add the public IPs to the allowed adresses to connect.
-The addresses should appear as "Authorised and set up". - -![addresses](images/en00ipsec.png){.thumbnail} - -### Node Template - -The TCE clusters require a template to build the nodes. Those can be dowloaded from the [VMware Customer Connect](https://customerconnect.vmware.com/downloads/get-download?downloadGroup=TCE-0100) website. If you do not own an account, you can create one for free. - -Select the latest version of the OVA you need to use and download it locally. - -![OVA download](images/en22down.png){.thumbnail} - -In vSphere, right-click a host or a cluster and select `Deploy OVF Template`{.action}. - -![Deploy OVF template](images/en23ovfdeploy.png){.thumbnail} - -Browse for the OVA file you downloaded and deploy it. - -![Deploy OVA](images/en24ovfopen.png){.thumbnail} - -Once done, right-click the VM and, in the `Template`{.action} section, select `Convert to Template`{.action}. - -![Convert to template](images/en25template.png){.thumbnail} - -### Bootstrap VM - -Once the Network and template are ready, a Bootstrap VM is needed.
-It will hold the necessary software components (Docker and Kubectl) and pilot the installation of TCE.
-We'll use an Ubuntu VM but any OS allowing the install of the necessary items would work.
-VM prerequisites for TCE is 2 CPUs and 6 GB Ram.
-You can deploy a VM [from an ISO](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle) or [from an OVF template](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ovf_template).
- -Make sure the VM is set on the VLAN that will be used for the TCE clusters (VLAN13 in our case).
- -![VLAN](images/en04bootvlan.png){.thumbnail} - -In a terminal window, start with update commands: - -```bash -sudo apt update -``` - -and - -```bash -sudo apt-get install build-essential -``` - -#### Install [NTP](https://vitux.com/how-to-install-ntp-server-and-client-on-ubuntu/) - -```bash -sudo apt-get install ntp -``` - -#### Install [Homebrew](https://www.how2shout.com/linux/how-to-install-brew-ubuntu-20-04-lts-linux/) - -Start with git: - -```bash -sudo apt install git -y -``` - -Run the Homebrew install script: - -```bash -/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" -``` - -Add Homebrew to your path: - -```bash -eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)" -``` - -Install gcc: - -```bash -brew install gcc -``` - -#### Install [Docker Engine](https://docs.docker.com/engine/install/) - -Start with getting the necessary packages: - -```bash -sudo apt-get install \ -ca-certificates \ -curl \ -gnupg \ -lsb-release -``` - -Add Docker’s official GPG key: - -```bash -curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg -``` - -set up the stable repository: - -```bash -echo \ -"deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu \ -$(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null -``` - -Set up the engine: - -```bash -sudo apt-get install docker-ce docker-ce-cli containerd.io -``` - -Post install, add the current user to the docker group to allow it to run it without rights elevation: - -```bash -sudo usermod -aG docker $USER -``` - -#### Install [Kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/) - -Download the lastest package: - -```bash -curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl" -``` - -Run the installer: - -```bash -sudo install -o root -g root -m 0755 kubectl /usr/local/bin/kubectl -``` - -#### SSH Key Pair - -Run the creation command: - -```bash -ssh-keygen -t rsa -b 4096 -C "youremail@yourdomain.com" -``` - -Press Enter to save the key in default path (/root/.ssh/id_rsa).
-Enter and confirm a password for the key.
-Add the private key to the SSH agent running on your machine, and enter the password you created in the previous step. - -```bash -ssh-add ~/.ssh/id_rsa -``` - -Keep the .ssh/id_rsa.pub file handy as it holds the public key you will need to input later for TCE configuration. - -### Tanzu Management Cluster - -The VM is now ready for TCE deployment. - -#### [Tanzu CLI](https://tanzucommunityedition.io/docs/latest/cli-installation/) - -In a terminal window, run the CLI install command: - -```bash -brew install vmware-tanzu/tanzu/tanzu-community-edition -``` -Note the output install folder and run the post install script: - -```bash -{HOMEBREW-INSTALL-LOCATION}/configure-tce.sh -/home/linuxbrew/.linuxbrew/Cellar/tanzu-community-edition/v0.10.0/libexec/configure-tce.sh -``` - -![Tanzu CLI](images/en05tanzucli.png){.thumbnail} - -#### [Deployment](https://tanzucommunityedition.io/docs/latest/vsphere-install-mgmt/) - -Launch the installer with this command: - -```bash -tanzu management-cluster create --ui -``` - -In the opening browser window, select the vSphere option. - -![vSphere option](images/en06deploy.png){.thumbnail} - -Enter the Hosted Private cloud FQDN and fill in administrative credentials before clicking `Connect`{.action}. - -![credentials](images/en07connect.png){.thumbnail} - -Click `Continue`{.action} to verify the SSL thumbprint. - -![SSL thumbprint](images/en08ssl.png){.thumbnail} - -Select your datacenter and fill in the SSH public key created earlier (.ssh/id_rsa.pub).
-Click `Next`{.action}. - -![SSH](images/en09ssh.png){.thumbnail} - -Choose a type of cluster (Development or Production) and a node size. - -![instance type](images/en10type.png){.thumbnail} - -Fill in the name of your custer, choose a control plane endpoint provider and IP (same subnet but outside of DHCP scope).
-Click `Next`{.action}. - -![cluster](images/en11control.png){.thumbnail} - -NSX Advanced Load Balancer and Metadata sections are optional and we will not edit them.
-Click `Next`{.action} on both of them. - -![NSX - Metadata](images/en12optional.png){.thumbnail} - -Choose your resource locations.
-Click `Next`{.action}. - -![Resources](images/en13resources.png){.thumbnail} - -Enter the Kubernetes Network settings.
-Click `Next`{.action}. - -![Kubernetes](images/en14kubnet.png){.thumbnail} - -Disable Identity Management.
-Click `Next`{.action}. - -![Identity](images/en15identity.png){.thumbnail} - -Select the node template to be used.
-Click `Next`{.action}. - -![node template](images/en16os.png){.thumbnail} - -Click `Review Configuration`{.action}. - -![Review](images/en17review.png){.thumbnail} - -When ready, click `Deploy Management Cluster`{.action}. - -![Deploying cluster](images/en18deploy.png){.thumbnail} - -Upon completion, verify you get a creation message and the nodes are visible in vSphere. - -![Creation message](images/en20created.png){.thumbnail} - -![Visible nodes](images/en21vsphere.png){.thumbnail} - -Get the cluster admin credentials for future interactions: - -```bash -tanzu cluster kubeconfig get "clustername" --admin -``` - -### Tanzu Workload Cluster - -To deploy a workload cluster, we'll duplicate and modify the configuration file for the management cluster.
-Start a terminal window in the bootstrap VM and go to the config file folder. - -```bash -cd .config/tanzu/tkg/clusterconfigs -``` - -Use ls to find the yaml configuration file name and copy it into a new one.
- -```bash -cp existing.yaml new.yaml -``` - -![configuration file name](images/en26copyconf.png){.thumbnail} - -Use a text editor to modify the key fields: - -- CLUSTER_NAME : choose a name for your new cluster -- VSPHERE_CONTROL_PLANE_ENDPOINT : choose an unused IP in the same subnet but not in the DHCP scope -- VSPHERE_FOLDER : this is not mandatory but you can define a different folder for ease of management - -Save and close the file. - -Back in the terminal, run the deploy command calling your new yaml file. - -```bash -tanzu cluster create --file .config/tanzu/tkg/clusterconfigs/new.yaml -``` - -Upon completion, verify you get a creation message and the nodes are visible in vSphere. - -![Creation message](images/en27created.png){.thumbnail} - -![Visible nodes](images/en28vsphere.png){.thumbnail} - -Get the cluster admin credentials for future interactions: - -```bash -tanzu cluster kubeconfig get "clustername" --admin -``` - -TCE is now ready for application install. - -## Go further - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/guide.pt-pt.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/guide.pt-pt.md deleted file mode 100644 index 9c17047acbb..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/guide.pt-pt.md +++ /dev/null @@ -1,354 +0,0 @@ ---- -title: Instale o Tanzu Community Edition (EN) -excerpt: Integrate Tanzu Community Edition (TCE) on your infrastructure -updated: 2022-11-16 ---- - -## Objective - -VMware Tanzu Community Edition (TCE) is a full-featured, easy-to-manage Kubernetes platform. -You can deploy the product on an OVHcloud infrastructure to leverage its functionality and scalability. - -> [!warning] -> -> Tanzu Community Edition is coming to an end of life at the end of 2022 and will no longer be available. VMware has decided to offer free download of VMware Tanzu Kubernetes Grid. You can use our [introduction to Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation) guide to deploy it. -> - -**This guide offers a step by step example of TCE installation** - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/pt/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- A deployed [NSX Edge Services Gateway](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_deploying_edge_gateway) -- [DHCP](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/nsx_configurer_le_dhcp_sur_une_edge_gateway) services activated on the NSX Gateway - -## Instructions - -### Network - -As stated in the Requirements (with links to full docs), an NSX Edge Services Gateway is used in our study case for Firewall and DHCP purposes.
-Other Network components can be used as alternative, such as pfSense.
- -To set up your Network, you will need to define a public IP for external access and an internal network with DHCP service activated for your TCE infrastructure.
-Your Datacenter comes with a set of public IPs usable for your different needs. They are visible in the Datacenter `Configure`{.action} tab, in the `Network`{.action} section. You will also see the mask and gateway settings on the page.
-Check out our [Adding an IP block](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ajout_de_bloc_ip) documentation if you are out of usable public IPs. - -![network](images/en00ipblocks.png){.thumbnail} - -> [!warning] -> -> Public IPs marked as "Reserved" are used for Datacenter functions and cannot be used for other services. -> - -For our study case, the NSX Edge Services Gateway is set up with two interfaces as follows: - -- an external interface (Uplink) with a primary and secondary public IPs (xxx.xxx.xxx.225 and xxx.xxx.xxx.226) -- an internal interface (Internal) with private IP 172.16.13.1 on VLAN13
-![internal interface](images/en01nsxinter.png){.thumbnail} -- DHCP service distributing VLAN13 address scope 172.16.13.10 through 172.16.13.100
-![DHCP](images/en02nsxdhcp.png){.thumbnail} -- a SNAT rule to translate adress range 172.16.13.1/24 into secondary public IP xxx.xxx.xxx.226 for external access
-![SNAT rule](images/en03nsxsnat.png){.thumbnail} - -In the [OVHcloud Control Panel](/links/manager), go to the `Security`{.action} tab of your Hosted Private Cloud and add the public IPs to the allowed adresses to connect.
-The addresses should appear as "Authorised and set up". - -![addresses](images/en00ipsec.png){.thumbnail} - -### Node Template - -The TCE clusters require a template to build the nodes. Those can be dowloaded from the [VMware Customer Connect](https://customerconnect.vmware.com/downloads/get-download?downloadGroup=TCE-0100) website. If you do not own an account, you can create one for free. - -Select the latest version of the OVA you need to use and download it locally. - -![OVA download](images/en22down.png){.thumbnail} - -In vSphere, right-click a host or a cluster and select `Deploy OVF Template`{.action}. - -![Deploy OVF template](images/en23ovfdeploy.png){.thumbnail} - -Browse for the OVA file you downloaded and deploy it. - -![Deploy OVA](images/en24ovfopen.png){.thumbnail} - -Once done, right-click the VM and, in the `Template`{.action} section, select `Convert to Template`{.action}. - -![Convert to template](images/en25template.png){.thumbnail} - -### Bootstrap VM - -Once the Network and template are ready, a Bootstrap VM is needed.
-It will hold the necessary software components (Docker and Kubectl) and pilot the installation of TCE.
-We'll use an Ubuntu VM but any OS allowing the install of the necessary items would work.
-VM prerequisites for TCE is 2 CPUs and 6 GB Ram.
-You can deploy a VM [from an ISO](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/deploiement_d_une_machine_virtuelle) or [from an OVF template](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/ovf_template).
- -Make sure the VM is set on the VLAN that will be used for the TCE clusters (VLAN13 in our case).
- -![VLAN](images/en04bootvlan.png){.thumbnail} - -In a terminal window, start with update commands: - -```bash -sudo apt update -``` - -and - -```bash -sudo apt-get install build-essential -``` - -#### Install [NTP](https://vitux.com/how-to-install-ntp-server-and-client-on-ubuntu/) - -```bash -sudo apt-get install ntp -``` - -#### Install [Homebrew](https://www.how2shout.com/linux/how-to-install-brew-ubuntu-20-04-lts-linux/) - -Start with git: - -```bash -sudo apt install git -y -``` - -Run the Homebrew install script: - -```bash -/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" -``` - -Add Homebrew to your path: - -```bash -eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)" -``` - -Install gcc: - -```bash -brew install gcc -``` - -#### Install [Docker Engine](https://docs.docker.com/engine/install/) - -Start with getting the necessary packages: - -```bash -sudo apt-get install \ -ca-certificates \ -curl \ -gnupg \ -lsb-release -``` - -Add Docker’s official GPG key: - -```bash -curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg -``` - -set up the stable repository: - -```bash -echo \ -"deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu \ -$(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null -``` - -Set up the engine: - -```bash -sudo apt-get install docker-ce docker-ce-cli containerd.io -``` - -Post install, add the current user to the docker group to allow it to run it without rights elevation: - -```bash -sudo usermod -aG docker $USER -``` - -#### Install [Kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/) - -Download the lastest package: - -```bash -curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl" -``` - -Run the installer: - -```bash -sudo install -o root -g root -m 0755 kubectl /usr/local/bin/kubectl -``` - -#### SSH Key Pair - -Run the creation command: - -```bash -ssh-keygen -t rsa -b 4096 -C "youremail@yourdomain.com" -``` - -Press Enter to save the key in default path (/root/.ssh/id_rsa).
-Enter and confirm a password for the key.
-Add the private key to the SSH agent running on your machine, and enter the password you created in the previous step. - -```bash -ssh-add ~/.ssh/id_rsa -``` - -Keep the .ssh/id_rsa.pub file handy as it holds the public key you will need to input later for TCE configuration. - -### Tanzu Management Cluster - -The VM is now ready for TCE deployment. - -#### [Tanzu CLI](https://tanzucommunityedition.io/docs/latest/cli-installation/) - -In a terminal window, run the CLI install command: - -```bash -brew install vmware-tanzu/tanzu/tanzu-community-edition -``` -Note the output install folder and run the post install script: - -```bash -{HOMEBREW-INSTALL-LOCATION}/configure-tce.sh -/home/linuxbrew/.linuxbrew/Cellar/tanzu-community-edition/v0.10.0/libexec/configure-tce.sh -``` - -![Tanzu CLI](images/en05tanzucli.png){.thumbnail} - -#### [Deployment](https://tanzucommunityedition.io/docs/latest/vsphere-install-mgmt/) - -Launch the installer with this command: - -```bash -tanzu management-cluster create --ui -``` - -In the opening browser window, select the vSphere option. - -![vSphere option](images/en06deploy.png){.thumbnail} - -Enter the Hosted Private cloud FQDN and fill in administrative credentials before clicking `Connect`{.action}. - -![credentials](images/en07connect.png){.thumbnail} - -Click `Continue`{.action} to verify the SSL thumbprint. - -![SSL thumbprint](images/en08ssl.png){.thumbnail} - -Select your datacenter and fill in the SSH public key created earlier (.ssh/id_rsa.pub).
-Click `Next`{.action}. - -![SSH](images/en09ssh.png){.thumbnail} - -Choose a type of cluster (Development or Production) and a node size. - -![instance type](images/en10type.png){.thumbnail} - -Fill in the name of your custer, choose a control plane endpoint provider and IP (same subnet but outside of DHCP scope).
-Click `Next`{.action}. - -![cluster](images/en11control.png){.thumbnail} - -NSX Advanced Load Balancer and Metadata sections are optional and we will not edit them.
-Click `Next`{.action} on both of them. - -![NSX - Metadata](images/en12optional.png){.thumbnail} - -Choose your resource locations.
-Click `Next`{.action}. - -![Resources](images/en13resources.png){.thumbnail} - -Enter the Kubernetes Network settings.
-Click `Next`{.action}. - -![Kubernetes](images/en14kubnet.png){.thumbnail} - -Disable Identity Management.
-Click `Next`{.action}. - -![Identity](images/en15identity.png){.thumbnail} - -Select the node template to be used.
-Click `Next`{.action}. - -![node template](images/en16os.png){.thumbnail} - -Click `Review Configuration`{.action}. - -![Review](images/en17review.png){.thumbnail} - -When ready, click `Deploy Management Cluster`{.action}. - -![Deploying cluster](images/en18deploy.png){.thumbnail} - -Upon completion, verify you get a creation message and the nodes are visible in vSphere. - -![Creation message](images/en20created.png){.thumbnail} - -![Visible nodes](images/en21vsphere.png){.thumbnail} - -Get the cluster admin credentials for future interactions: - -```bash -tanzu cluster kubeconfig get "clustername" --admin -``` - -### Tanzu Workload Cluster - -To deploy a workload cluster, we'll duplicate and modify the configuration file for the management cluster.
-Start a terminal window in the bootstrap VM and go to the config file folder. - -```bash -cd .config/tanzu/tkg/clusterconfigs -``` - -Use ls to find the yaml configuration file name and copy it into a new one.
- -```bash -cp existing.yaml new.yaml -``` - -![configuration file name](images/en26copyconf.png){.thumbnail} - -Use a text editor to modify the key fields: - -- CLUSTER_NAME : choose a name for your new cluster -- VSPHERE_CONTROL_PLANE_ENDPOINT : choose an unused IP in the same subnet but not in the DHCP scope -- VSPHERE_FOLDER : this is not mandatory but you can define a different folder for ease of management - -Save and close the file. - -Back in the terminal, run the deploy command calling your new yaml file. - -```bash -tanzu cluster create --file .config/tanzu/tkg/clusterconfigs/new.yaml -``` - -Upon completion, verify you get a creation message and the nodes are visible in vSphere. - -![Creation message](images/en27created.png){.thumbnail} - -![Visible nodes](images/en28vsphere.png){.thumbnail} - -Get the cluster admin credentials for future interactions: - -```bash -tanzu cluster kubeconfig get "clustername" --admin -``` - -TCE is now ready for application install. - -## Go further - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en00ipblocks.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en00ipblocks.png deleted file mode 100644 index b14a1066f96..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en00ipblocks.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en00ipsec.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en00ipsec.png deleted file mode 100644 index a7bd9b1cfe1..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en00ipsec.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en01nsxinter.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en01nsxinter.png deleted file mode 100644 index ae8960d1f0e..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en01nsxinter.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en02nsxdhcp.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en02nsxdhcp.png deleted file mode 100644 index b25e14402f7..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en02nsxdhcp.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en03nsxsnat.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en03nsxsnat.png deleted file mode 100644 index 14d98d83b59..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en03nsxsnat.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en04bootvlan.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en04bootvlan.png deleted file mode 100644 index c75cc969393..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en04bootvlan.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en05tanzucli.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en05tanzucli.png deleted file mode 100644 index 00259501ca9..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en05tanzucli.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en06deploy.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en06deploy.png deleted file mode 100644 index 0e05d36b008..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en06deploy.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en07connect.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en07connect.png deleted file mode 100644 index 74dab4d7f1d..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en07connect.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en08ssl.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en08ssl.png deleted file mode 100644 index 63ec5bd1a26..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en08ssl.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en09ssh.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en09ssh.png deleted file mode 100644 index aa750ca6451..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en09ssh.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en10type.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en10type.png deleted file mode 100644 index 5cca9c3a5c7..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en10type.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en11control.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en11control.png deleted file mode 100644 index d00035b81a9..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en11control.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en12optional.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en12optional.png deleted file mode 100644 index 6576619419f..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en12optional.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en13resources.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en13resources.png deleted file mode 100644 index 58985841d7e..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en13resources.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en14kubnet.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en14kubnet.png deleted file mode 100644 index b0714565307..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en14kubnet.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en15identity.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en15identity.png deleted file mode 100644 index 5456fa10b12..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en15identity.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en16os.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en16os.png deleted file mode 100644 index 3949416ba00..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en16os.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en17review.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en17review.png deleted file mode 100644 index 068e589906d..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en17review.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en18deploy.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en18deploy.png deleted file mode 100644 index d253f31fe76..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en18deploy.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en19progress.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en19progress.png deleted file mode 100644 index 2a70bc5fb63..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en19progress.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en20created.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en20created.png deleted file mode 100644 index d403994e166..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en20created.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en21vsphere.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en21vsphere.png deleted file mode 100644 index 177ca4063bf..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en21vsphere.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en22down.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en22down.png deleted file mode 100644 index 91483b04911..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en22down.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en23ovfdeploy.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en23ovfdeploy.png deleted file mode 100644 index 8e749e300b9..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en23ovfdeploy.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en24ovfopen.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en24ovfopen.png deleted file mode 100644 index d9e24d17afb..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en24ovfopen.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en25template.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en25template.png deleted file mode 100644 index d8734a66c6c..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en25template.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en26copyconf.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en26copyconf.png deleted file mode 100644 index 189eeb0bf01..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en26copyconf.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en27created.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en27created.png deleted file mode 100644 index 2af9bd24c9c..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en27created.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en28vsphere.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en28vsphere.png deleted file mode 100644 index c877da4262a..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/images/en28vsphere.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/meta.yaml b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/meta.yaml deleted file mode 100755 index b05eefd6f15..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_ce_install/meta.yaml +++ /dev/null @@ -1,2 +0,0 @@ -id: f43c5f4b-a35c-4c76-9ef2-91104f408a6e -full_slug: vmware-tanzu-ce-install \ No newline at end of file diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/guide.de-de.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/guide.de-de.md deleted file mode 100644 index f11d9955d73..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/guide.de-de.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -title: Einführung in Tanzu Kubernetes Grid (EN) -excerpt: Discover the Tanzu Kubernetes Grid solution -updated: 2022-11-15 ---- - -## Objective - -**This guide introduces Tanzu Kubernetes Grid and the possibilities for its integration into your VMware on OVHcloud solution.** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/de/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere - -## Step-by-step introduction to the Tanzu Kubernetes Grid solution - -VMware Tanzu Kubernetes Grid is a Kubernetes platform provided by **VMware** and maintained as part of the **VMware on OVHcloud** solution. - -You can deploy this product on your OVHcloud infrastructure to take advantage of its features and scalability. - -Tanzu Kubernetes Grid enables you to deploy and manage one or more Kubernetes clusters within your VMware infrastructure. The administration tool for these clusters is itself based on Kubernetes. - -### Initial installation of Tanzu Kubernetes Grid - -Please refer to the [Install Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) documentation for installation. - -Running **Tanzu Kubernetes Grid** on the VMware cluster requires six new virtual machines to run the management cluster. Another virtual machine is required for administration, this virtual machine is provided by OVHcloud and is called **Bootstrap**. - -![01 admin cluster diagram](images/01-admin-cluster-diagram01.png){.thumbnail} - -> [!warning] -> -> The management cluster must be used exclusively for **Tanzu Kubernetes Grid** administration. -> - -### Deploying a *Workload* cluster and installing an application - -To deploy an application, you need to create *WorkLoad* clusters that are dedicated to applications. - -All *WorkLoad* clusters are independent from one another, which means you can have different versions of Kubernetes on each of these *Workload* clusters. - -When installing **Tanzu Kubernetes Grid**, we chose **kube-vip** for interconnections between a *Workload* cluster and the VMware cluster network. You can also use the **Nsx Advanced Load Balancer**. - -Read the [Managing Tanzu Kubernete Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) guide to deploy a *Workload* cluster and application. - -For each new *WorkLoad* cluster installed in production mode, six new virtual machines are added to your VMware infrastructure. - -![02 admin and workload cluster diagram](images/02-tkc-mc-wc01.png){.thumbnail} - -An application can consist of multiple **pods** that communicate with each other through the internal network of the *workload* cluster. Some ports are opened on the **VMware** cluster network using the **kube-vip** module. - -![03 apps and load balancing](images/03-internetworkcommunication01.png){.thumbnail} - -### Managing persistent volumes - -By default, when stopping a **pod** of if it crashes, the data in that **pod** is lost. To store data permanently, you need to create persistent volumes and associate them with applications. - -Persistent volumes are stored by default on VMware storage (vSAN or NFS) that was used for the *WorkLoad* cluster deployment, using VMware APIs (vSphere Cloud Native Storage). - -You can create **Custom Storage Classes** to define another location. - -Read the [Managing Persistent Volumes in Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes) guide to add an application that uses an external persistent volume. - -### Application backup - -Various backup solutions compatible with **Tanzu Kubernetes Grid** exist, including **Kasten** from **Veeam**. - -## Go further - -[Installing a Tanzu Kubernetes GRID cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Managing a Tanzu Kubernetes GRID cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) - -[Managing volumes on a Tanzu Kubernetes GRID cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes) - -[Introducing VMware Tanzu Kubernetes Grid](https://tanzu.vmware.com/kubernetes-grid) - -[VMware Tanzu Kubenetes Grid documentation](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/guide.en-asia.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/guide.en-asia.md deleted file mode 100644 index a61c9544aea..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/guide.en-asia.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -title: Introduction to Tanzu Kubernetes Grid -excerpt: Discover the Tanzu Kubernetes Grid solution -updated: 2022-11-15 ---- - -## Objective - -**This guide introduces Tanzu Kubernetes Grid and the possibilities for its integration into your VMware on OVHcloud solution.** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/asia/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere - -## Step-by-step introduction to the Tanzu Kubernetes Grid solution - -VMware Tanzu Kubernetes Grid is a Kubernetes platform provided by **VMware** and maintained as part of the **VMware on OVHcloud** solution. - -You can deploy this product on your OVHcloud infrastructure to take advantage of its features and scalability. - -Tanzu Kubernetes Grid enables you to deploy and manage one or more Kubernetes clusters within your VMware infrastructure. The administration tool for these clusters is itself based on Kubernetes. - -### Initial installation of Tanzu Kubernetes Grid - -Please refer to the [Install Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) documentation for installation. - -Running **Tanzu Kubernetes Grid** on the VMware cluster requires six new virtual machines to run the management cluster. Another virtual machine is required for administration, this virtual machine is provided by OVHcloud and is called **Bootstrap**. - -![01 admin cluster diagram](images/01-admin-cluster-diagram01.png){.thumbnail} - -> [!warning] -> -> The management cluster must be used exclusively for **Tanzu Kubernetes Grid** administration. -> - -### Deploying a *Workload* cluster and installing an application - -To deploy an application, you need to create *WorkLoad* clusters that are dedicated to applications. - -All *WorkLoad* clusters are independent from one another, which means you can have different versions of Kubernetes on each of these *Workload* clusters. - -When installing **Tanzu Kubernetes Grid**, we chose **kube-vip** for interconnections between a *Workload* cluster and the VMware cluster network. You can also use the **Nsx Advanced Load Balancer**. - -Read the [Managing Tanzu Kubernete Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) guide to deploy a *Workload* cluster and application. - -For each new *WorkLoad* cluster installed in production mode, six new virtual machines are added to your VMware infrastructure. - -![02 admin and workload cluster diagram](images/02-tkc-mc-wc01.png){.thumbnail} - -An application can consist of multiple **pods** that communicate with each other through the internal network of the *workload* cluster. Some ports are opened on the **VMware** cluster network using the **kube-vip** module. - -![03 apps and load balancing](images/03-internetworkcommunication01.png){.thumbnail} - -### Managing persistent volumes - -By default, when stopping a **pod** of if it crashes, the data in that **pod** is lost. To store data permanently, you need to create persistent volumes and associate them with applications. - -Persistent volumes are stored by default on VMware storage (vSAN or NFS) that was used for the *WorkLoad* cluster deployment, using VMware APIs (vSphere Cloud Native Storage). - -You can create **Custom Storage Classes** to define another location. - -Read the [Managing Persistent Volumes in Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes) guide to add an application that uses an external persistent volume. - -### Application backup - -Various backup solutions compatible with **Tanzu Kubernetes Grid** exist, including **Kasten** from **Veeam**. - -## Go further - -[Installing a Tanzu Kubernetes GRID cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Managing a Tanzu Kubernetes GRID cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) - -[Managing volumes on a Tanzu Kubernetes GRID cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes) - -[Introducing VMware Tanzu Kubernetes Grid](https://tanzu.vmware.com/kubernetes-grid) - -[VMware Tanzu Kubenetes Grid documentation](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/guide.en-au.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/guide.en-au.md deleted file mode 100644 index 6a4d74541f0..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/guide.en-au.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -title: Introduction to Tanzu Kubernetes Grid -excerpt: Discover the Tanzu Kubernetes Grid solution -updated: 2022-11-15 ---- - -## Objective - -**This guide introduces Tanzu Kubernetes Grid and the possibilities for its integration into your VMware on OVHcloud solution.** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/en-au/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere - -## Step-by-step introduction to the Tanzu Kubernetes Grid solution - -VMware Tanzu Kubernetes Grid is a Kubernetes platform provided by **VMware** and maintained as part of the **VMware on OVHcloud** solution. - -You can deploy this product on your OVHcloud infrastructure to take advantage of its features and scalability. - -Tanzu Kubernetes Grid enables you to deploy and manage one or more Kubernetes clusters within your VMware infrastructure. The administration tool for these clusters is itself based on Kubernetes. - -### Initial installation of Tanzu Kubernetes Grid - -Please refer to the [Install Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) documentation for installation. - -Running **Tanzu Kubernetes Grid** on the VMware cluster requires six new virtual machines to run the management cluster. Another virtual machine is required for administration, this virtual machine is provided by OVHcloud and is called **Bootstrap**. - -![01 admin cluster diagram](images/01-admin-cluster-diagram01.png){.thumbnail} - -> [!warning] -> -> The management cluster must be used exclusively for **Tanzu Kubernetes Grid** administration. -> - -### Deploying a *Workload* cluster and installing an application - -To deploy an application, you need to create *WorkLoad* clusters that are dedicated to applications. - -All *WorkLoad* clusters are independent from one another, which means you can have different versions of Kubernetes on each of these *Workload* clusters. - -When installing **Tanzu Kubernetes Grid**, we chose **kube-vip** for interconnections between a *Workload* cluster and the VMware cluster network. You can also use the **Nsx Advanced Load Balancer**. - -Read the [Managing Tanzu Kubernete Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) guide to deploy a *Workload* cluster and application. - -For each new *WorkLoad* cluster installed in production mode, six new virtual machines are added to your VMware infrastructure. - -![02 admin and workload cluster diagram](images/02-tkc-mc-wc01.png){.thumbnail} - -An application can consist of multiple **pods** that communicate with each other through the internal network of the *workload* cluster. Some ports are opened on the **VMware** cluster network using the **kube-vip** module. - -![03 apps and load balancing](images/03-internetworkcommunication01.png){.thumbnail} - -### Managing persistent volumes - -By default, when stopping a **pod** of if it crashes, the data in that **pod** is lost. To store data permanently, you need to create persistent volumes and associate them with applications. - -Persistent volumes are stored by default on VMware storage (vSAN or NFS) that was used for the *WorkLoad* cluster deployment, using VMware APIs (vSphere Cloud Native Storage). - -You can create **Custom Storage Classes** to define another location. - -Read the [Managing Persistent Volumes in Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes) guide to add an application that uses an external persistent volume. - -### Application backup - -Various backup solutions compatible with **Tanzu Kubernetes Grid** exist, including **Kasten** from **Veeam**. - -## Go further - -[Installing a Tanzu Kubernetes GRID cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Managing a Tanzu Kubernetes GRID cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) - -[Managing volumes on a Tanzu Kubernetes GRID cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes) - -[Introducing VMware Tanzu Kubernetes Grid](https://tanzu.vmware.com/kubernetes-grid) - -[VMware Tanzu Kubenetes Grid documentation](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/guide.en-ca.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/guide.en-ca.md deleted file mode 100644 index 172ecff8b70..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/guide.en-ca.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -title: Introduction to Tanzu Kubernetes Grid -excerpt: Discover the Tanzu Kubernetes Grid solution -updated: 2022-11-15 ---- - -## Objective - -**This guide introduces Tanzu Kubernetes Grid and the possibilities for its integration into your VMware on OVHcloud solution.** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/en-ca/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere - -## Step-by-step introduction to the Tanzu Kubernetes Grid solution - -VMware Tanzu Kubernetes Grid is a Kubernetes platform provided by **VMware** and maintained as part of the **VMware on OVHcloud** solution. - -You can deploy this product on your OVHcloud infrastructure to take advantage of its features and scalability. - -Tanzu Kubernetes Grid enables you to deploy and manage one or more Kubernetes clusters within your VMware infrastructure. The administration tool for these clusters is itself based on Kubernetes. - -### Initial installation of Tanzu Kubernetes Grid - -Please refer to the [Install Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) documentation for installation. - -Running **Tanzu Kubernetes Grid** on the VMware cluster requires six new virtual machines to run the management cluster. Another virtual machine is required for administration, this virtual machine is provided by OVHcloud and is called **Bootstrap**. - -![01 admin cluster diagram](images/01-admin-cluster-diagram01.png){.thumbnail} - -> [!warning] -> -> The management cluster must be used exclusively for **Tanzu Kubernetes Grid** administration. -> - -### Deploying a *Workload* cluster and installing an application - -To deploy an application, you need to create *WorkLoad* clusters that are dedicated to applications. - -All *WorkLoad* clusters are independent from one another, which means you can have different versions of Kubernetes on each of these *Workload* clusters. - -When installing **Tanzu Kubernetes Grid**, we chose **kube-vip** for interconnections between a *Workload* cluster and the VMware cluster network. You can also use the **Nsx Advanced Load Balancer**. - -Read the [Managing Tanzu Kubernete Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) guide to deploy a *Workload* cluster and application. - -For each new *WorkLoad* cluster installed in production mode, six new virtual machines are added to your VMware infrastructure. - -![02 admin and workload cluster diagram](images/02-tkc-mc-wc01.png){.thumbnail} - -An application can consist of multiple **pods** that communicate with each other through the internal network of the *workload* cluster. Some ports are opened on the **VMware** cluster network using the **kube-vip** module. - -![03 apps and load balancing](images/03-internetworkcommunication01.png){.thumbnail} - -### Managing persistent volumes - -By default, when stopping a **pod** of if it crashes, the data in that **pod** is lost. To store data permanently, you need to create persistent volumes and associate them with applications. - -Persistent volumes are stored by default on VMware storage (vSAN or NFS) that was used for the *WorkLoad* cluster deployment, using VMware APIs (vSphere Cloud Native Storage). - -You can create **Custom Storage Classes** to define another location. - -Read the [Managing Persistent Volumes in Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes) guide to add an application that uses an external persistent volume. - -### Application backup - -Various backup solutions compatible with **Tanzu Kubernetes Grid** exist, including **Kasten** from **Veeam**. - -## Go further - -[Installing a Tanzu Kubernetes GRID cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Managing a Tanzu Kubernetes GRID cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) - -[Managing volumes on a Tanzu Kubernetes GRID cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes) - -[Introducing VMware Tanzu Kubernetes Grid](https://tanzu.vmware.com/kubernetes-grid) - -[VMware Tanzu Kubenetes Grid documentation](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/guide.en-gb.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/guide.en-gb.md deleted file mode 100644 index 1b6ce79884d..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/guide.en-gb.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -title: Introduction to Tanzu Kubernetes Grid -excerpt: Discover the Tanzu Kubernetes Grid solution -updated: 2022-11-15 ---- - -## Objective - -**This guide introduces Tanzu Kubernetes Grid and the possibilities for its integration into your VMware on OVHcloud solution.** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/en-gb/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere - -## Step-by-step introduction to the Tanzu Kubernetes Grid solution - -VMware Tanzu Kubernetes Grid is a Kubernetes platform provided by **VMware** and maintained as part of the **VMware on OVHcloud** solution. - -You can deploy this product on your OVHcloud infrastructure to take advantage of its features and scalability. - -Tanzu Kubernetes Grid enables you to deploy and manage one or more Kubernetes clusters within your VMware infrastructure. The administration tool for these clusters is itself based on Kubernetes. - -### Initial installation of Tanzu Kubernetes Grid - -Please refer to the [Install Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) documentation for installation. - -Running **Tanzu Kubernetes Grid** on the VMware cluster requires six new virtual machines to run the management cluster. Another virtual machine is required for administration, this virtual machine is provided by OVHcloud and is called **Bootstrap**. - -![01 admin cluster diagram](images/01-admin-cluster-diagram01.png){.thumbnail} - -> [!warning] -> -> The management cluster must be used exclusively for **Tanzu Kubernetes Grid** administration. -> - -### Deploying a *Workload* cluster and installing an application - -To deploy an application, you need to create *WorkLoad* clusters that are dedicated to applications. - -All *WorkLoad* clusters are independent from one another, which means you can have different versions of Kubernetes on each of these *Workload* clusters. - -When installing **Tanzu Kubernetes Grid**, we chose **kube-vip** for interconnections between a *Workload* cluster and the VMware cluster network. You can also use the **Nsx Advanced Load Balancer**. - -Read the [Managing Tanzu Kubernete Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) guide to deploy a *Workload* cluster and application. - -For each new *WorkLoad* cluster installed in production mode, six new virtual machines are added to your VMware infrastructure. - -![02 admin and workload cluster diagram](images/02-tkc-mc-wc01.png){.thumbnail} - -An application can consist of multiple **pods** that communicate with each other through the internal network of the *workload* cluster. Some ports are opened on the **VMware** cluster network using the **kube-vip** module. - -![03 apps and load balancing](images/03-internetworkcommunication01.png){.thumbnail} - -### Managing persistent volumes - -By default, when stopping a **pod** of if it crashes, the data in that **pod** is lost. To store data permanently, you need to create persistent volumes and associate them with applications. - -Persistent volumes are stored by default on VMware storage (vSAN or NFS) that was used for the *WorkLoad* cluster deployment, using VMware APIs (vSphere Cloud Native Storage). - -You can create **Custom Storage Classes** to define another location. - -Read the [Managing Persistent Volumes in Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes) guide to add an application that uses an external persistent volume. - -### Application backup - -Various backup solutions compatible with **Tanzu Kubernetes Grid** exist, including **Kasten** from **Veeam**. - -## Go further - -[Installing a Tanzu Kubernetes GRID cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Managing a Tanzu Kubernetes GRID cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) - -[Managing volumes on a Tanzu Kubernetes GRID cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes) - -[Introducing VMware Tanzu Kubernetes Grid](https://tanzu.vmware.com/kubernetes-grid) - -[VMware Tanzu Kubenetes Grid documentation](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/guide.en-ie.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/guide.en-ie.md deleted file mode 100644 index 7e4f072243b..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/guide.en-ie.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -title: Introduction to Tanzu Kubernetes Grid -excerpt: Discover the Tanzu Kubernetes Grid solution -updated: 2022-11-15 ---- - -## Objective - -**This guide introduces Tanzu Kubernetes Grid and the possibilities for its integration into your VMware on OVHcloud solution.** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/en-ie/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere - -## Step-by-step introduction to the Tanzu Kubernetes Grid solution - -VMware Tanzu Kubernetes Grid is a Kubernetes platform provided by **VMware** and maintained as part of the **VMware on OVHcloud** solution. - -You can deploy this product on your OVHcloud infrastructure to take advantage of its features and scalability. - -Tanzu Kubernetes Grid enables you to deploy and manage one or more Kubernetes clusters within your VMware infrastructure. The administration tool for these clusters is itself based on Kubernetes. - -### Initial installation of Tanzu Kubernetes Grid - -Please refer to the [Install Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) documentation for installation. - -Running **Tanzu Kubernetes Grid** on the VMware cluster requires six new virtual machines to run the management cluster. Another virtual machine is required for administration, this virtual machine is provided by OVHcloud and is called **Bootstrap**. - -![01 admin cluster diagram](images/01-admin-cluster-diagram01.png){.thumbnail} - -> [!warning] -> -> The management cluster must be used exclusively for **Tanzu Kubernetes Grid** administration. -> - -### Deploying a *Workload* cluster and installing an application - -To deploy an application, you need to create *WorkLoad* clusters that are dedicated to applications. - -All *WorkLoad* clusters are independent from one another, which means you can have different versions of Kubernetes on each of these *Workload* clusters. - -When installing **Tanzu Kubernetes Grid**, we chose **kube-vip** for interconnections between a *Workload* cluster and the VMware cluster network. You can also use the **Nsx Advanced Load Balancer**. - -Read the [Managing Tanzu Kubernete Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) guide to deploy a *Workload* cluster and application. - -For each new *WorkLoad* cluster installed in production mode, six new virtual machines are added to your VMware infrastructure. - -![02 admin and workload cluster diagram](images/02-tkc-mc-wc01.png){.thumbnail} - -An application can consist of multiple **pods** that communicate with each other through the internal network of the *workload* cluster. Some ports are opened on the **VMware** cluster network using the **kube-vip** module. - -![03 apps and load balancing](images/03-internetworkcommunication01.png){.thumbnail} - -### Managing persistent volumes - -By default, when stopping a **pod** of if it crashes, the data in that **pod** is lost. To store data permanently, you need to create persistent volumes and associate them with applications. - -Persistent volumes are stored by default on VMware storage (vSAN or NFS) that was used for the *WorkLoad* cluster deployment, using VMware APIs (vSphere Cloud Native Storage). - -You can create **Custom Storage Classes** to define another location. - -Read the [Managing Persistent Volumes in Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes) guide to add an application that uses an external persistent volume. - -### Application backup - -Various backup solutions compatible with **Tanzu Kubernetes Grid** exist, including **Kasten** from **Veeam**. - -## Go further - -[Installing a Tanzu Kubernetes GRID cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Managing a Tanzu Kubernetes GRID cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) - -[Managing volumes on a Tanzu Kubernetes GRID cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes) - -[Introducing VMware Tanzu Kubernetes Grid](https://tanzu.vmware.com/kubernetes-grid) - -[VMware Tanzu Kubenetes Grid documentation](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/guide.en-sg.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/guide.en-sg.md deleted file mode 100644 index eb067019ecb..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/guide.en-sg.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -title: Introduction to Tanzu Kubernetes Grid -excerpt: Discover the Tanzu Kubernetes Grid solution -updated: 2022-11-15 ---- - -## Objective - -**This guide introduces Tanzu Kubernetes Grid and the possibilities for its integration into your VMware on OVHcloud solution.** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/en-sg/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere - -## Step-by-step introduction to the Tanzu Kubernetes Grid solution - -VMware Tanzu Kubernetes Grid is a Kubernetes platform provided by **VMware** and maintained as part of the **VMware on OVHcloud** solution. - -You can deploy this product on your OVHcloud infrastructure to take advantage of its features and scalability. - -Tanzu Kubernetes Grid enables you to deploy and manage one or more Kubernetes clusters within your VMware infrastructure. The administration tool for these clusters is itself based on Kubernetes. - -### Initial installation of Tanzu Kubernetes Grid - -Please refer to the [Install Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) documentation for installation. - -Running **Tanzu Kubernetes Grid** on the VMware cluster requires six new virtual machines to run the management cluster. Another virtual machine is required for administration, this virtual machine is provided by OVHcloud and is called **Bootstrap**. - -![01 admin cluster diagram](images/01-admin-cluster-diagram01.png){.thumbnail} - -> [!warning] -> -> The management cluster must be used exclusively for **Tanzu Kubernetes Grid** administration. -> - -### Deploying a *Workload* cluster and installing an application - -To deploy an application, you need to create *WorkLoad* clusters that are dedicated to applications. - -All *WorkLoad* clusters are independent from one another, which means you can have different versions of Kubernetes on each of these *Workload* clusters. - -When installing **Tanzu Kubernetes Grid**, we chose **kube-vip** for interconnections between a *Workload* cluster and the VMware cluster network. You can also use the **Nsx Advanced Load Balancer**. - -Read the [Managing Tanzu Kubernete Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) guide to deploy a *Workload* cluster and application. - -For each new *WorkLoad* cluster installed in production mode, six new virtual machines are added to your VMware infrastructure. - -![02 admin and workload cluster diagram](images/02-tkc-mc-wc01.png){.thumbnail} - -An application can consist of multiple **pods** that communicate with each other through the internal network of the *workload* cluster. Some ports are opened on the **VMware** cluster network using the **kube-vip** module. - -![03 apps and load balancing](images/03-internetworkcommunication01.png){.thumbnail} - -### Managing persistent volumes - -By default, when stopping a **pod** of if it crashes, the data in that **pod** is lost. To store data permanently, you need to create persistent volumes and associate them with applications. - -Persistent volumes are stored by default on VMware storage (vSAN or NFS) that was used for the *WorkLoad* cluster deployment, using VMware APIs (vSphere Cloud Native Storage). - -You can create **Custom Storage Classes** to define another location. - -Read the [Managing Persistent Volumes in Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes) guide to add an application that uses an external persistent volume. - -### Application backup - -Various backup solutions compatible with **Tanzu Kubernetes Grid** exist, including **Kasten** from **Veeam**. - -## Go further - -[Installing a Tanzu Kubernetes GRID cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Managing a Tanzu Kubernetes GRID cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) - -[Managing volumes on a Tanzu Kubernetes GRID cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes) - -[Introducing VMware Tanzu Kubernetes Grid](https://tanzu.vmware.com/kubernetes-grid) - -[VMware Tanzu Kubenetes Grid documentation](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/guide.en-us.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/guide.en-us.md deleted file mode 100644 index 9d37206c304..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/guide.en-us.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -title: Introduction to Tanzu Kubernetes Grid -excerpt: Discover the Tanzu Kubernetes Grid solution -updated: 2022-11-15 ---- - -## Objective - -**This guide introduces Tanzu Kubernetes Grid and the possibilities for its integration into your VMware on OVHcloud solution.** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/en/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere - -## Step-by-step introduction to the Tanzu Kubernetes Grid solution - -VMware Tanzu Kubernetes Grid is a Kubernetes platform provided by **VMware** and maintained as part of the **VMware on OVHcloud** solution. - -You can deploy this product on your OVHcloud infrastructure to take advantage of its features and scalability. - -Tanzu Kubernetes Grid enables you to deploy and manage one or more Kubernetes clusters within your VMware infrastructure. The administration tool for these clusters is itself based on Kubernetes. - -### Initial installation of Tanzu Kubernetes Grid - -Please refer to the [Install Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) documentation for installation. - -Running **Tanzu Kubernetes Grid** on the VMware cluster requires six new virtual machines to run the management cluster. Another virtual machine is required for administration, this virtual machine is provided by OVHcloud and is called **Bootstrap**. - -![01 admin cluster diagram](images/01-admin-cluster-diagram01.png){.thumbnail} - -> [!warning] -> -> The management cluster must be used exclusively for **Tanzu Kubernetes Grid** administration. -> - -### Deploying a *Workload* cluster and installing an application - -To deploy an application, you need to create *WorkLoad* clusters that are dedicated to applications. - -All *WorkLoad* clusters are independent from one another, which means you can have different versions of Kubernetes on each of these *Workload* clusters. - -When installing **Tanzu Kubernetes Grid**, we chose **kube-vip** for interconnections between a *Workload* cluster and the VMware cluster network. You can also use the **Nsx Advanced Load Balancer**. - -Read the [Managing Tanzu Kubernete Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) guide to deploy a *Workload* cluster and application. - -For each new *WorkLoad* cluster installed in production mode, six new virtual machines are added to your VMware infrastructure. - -![02 admin and workload cluster diagram](images/02-tkc-mc-wc01.png){.thumbnail} - -An application can consist of multiple **pods** that communicate with each other through the internal network of the *workload* cluster. Some ports are opened on the **VMware** cluster network using the **kube-vip** module. - -![03 apps and load balancing](images/03-internetworkcommunication01.png){.thumbnail} - -### Managing persistent volumes - -By default, when stopping a **pod** of if it crashes, the data in that **pod** is lost. To store data permanently, you need to create persistent volumes and associate them with applications. - -Persistent volumes are stored by default on VMware storage (vSAN or NFS) that was used for the *WorkLoad* cluster deployment, using VMware APIs (vSphere Cloud Native Storage). - -You can create **Custom Storage Classes** to define another location. - -Read the [Managing Persistent Volumes in Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes) guide to add an application that uses an external persistent volume. - -### Application backup - -Various backup solutions compatible with **Tanzu Kubernetes Grid** exist, including **Kasten** from **Veeam**. - -## Go further - -[Installing a Tanzu Kubernetes GRID cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Managing a Tanzu Kubernetes GRID cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) - -[Managing volumes on a Tanzu Kubernetes GRID cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes) - -[Introducing VMware Tanzu Kubernetes Grid](https://tanzu.vmware.com/kubernetes-grid) - -[VMware Tanzu Kubenetes Grid documentation](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/guide.es-es.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/guide.es-es.md deleted file mode 100644 index 4b03dc63461..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/guide.es-es.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -title: Introducción a Tanzu Kubernetes Grid (EN) -excerpt: Discover the Tanzu Kubernetes Grid solution -updated: 2022-11-15 ---- - -## Objective - -**This guide introduces Tanzu Kubernetes Grid and the possibilities for its integration into your VMware on OVHcloud solution.** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/es-es/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere - -## Step-by-step introduction to the Tanzu Kubernetes Grid solution - -VMware Tanzu Kubernetes Grid is a Kubernetes platform provided by **VMware** and maintained as part of the **VMware on OVHcloud** solution. - -You can deploy this product on your OVHcloud infrastructure to take advantage of its features and scalability. - -Tanzu Kubernetes Grid enables you to deploy and manage one or more Kubernetes clusters within your VMware infrastructure. The administration tool for these clusters is itself based on Kubernetes. - -### Initial installation of Tanzu Kubernetes Grid - -Please refer to the [Install Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) documentation for installation. - -Running **Tanzu Kubernetes Grid** on the VMware cluster requires six new virtual machines to run the management cluster. Another virtual machine is required for administration, this virtual machine is provided by OVHcloud and is called **Bootstrap**. - -![01 admin cluster diagram](images/01-admin-cluster-diagram01.png){.thumbnail} - -> [!warning] -> -> The management cluster must be used exclusively for **Tanzu Kubernetes Grid** administration. -> - -### Deploying a *Workload* cluster and installing an application - -To deploy an application, you need to create *WorkLoad* clusters that are dedicated to applications. - -All *WorkLoad* clusters are independent from one another, which means you can have different versions of Kubernetes on each of these *Workload* clusters. - -When installing **Tanzu Kubernetes Grid**, we chose **kube-vip** for interconnections between a *Workload* cluster and the VMware cluster network. You can also use the **Nsx Advanced Load Balancer**. - -Read the [Managing Tanzu Kubernete Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) guide to deploy a *Workload* cluster and application. - -For each new *WorkLoad* cluster installed in production mode, six new virtual machines are added to your VMware infrastructure. - -![02 admin and workload cluster diagram](images/02-tkc-mc-wc01.png){.thumbnail} - -An application can consist of multiple **pods** that communicate with each other through the internal network of the *workload* cluster. Some ports are opened on the **VMware** cluster network using the **kube-vip** module. - -![03 apps and load balancing](images/03-internetworkcommunication01.png){.thumbnail} - -### Managing persistent volumes - -By default, when stopping a **pod** of if it crashes, the data in that **pod** is lost. To store data permanently, you need to create persistent volumes and associate them with applications. - -Persistent volumes are stored by default on VMware storage (vSAN or NFS) that was used for the *WorkLoad* cluster deployment, using VMware APIs (vSphere Cloud Native Storage). - -You can create **Custom Storage Classes** to define another location. - -Read the [Managing Persistent Volumes in Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes) guide to add an application that uses an external persistent volume. - -### Application backup - -Various backup solutions compatible with **Tanzu Kubernetes Grid** exist, including **Kasten** from **Veeam**. - -## Go further - -[Installing a Tanzu Kubernetes GRID cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Managing a Tanzu Kubernetes GRID cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) - -[Managing volumes on a Tanzu Kubernetes GRID cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes) - -[Introducing VMware Tanzu Kubernetes Grid](https://tanzu.vmware.com/kubernetes-grid) - -[VMware Tanzu Kubenetes Grid documentation](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/guide.es-us.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/guide.es-us.md deleted file mode 100644 index 88b43d82658..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/guide.es-us.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -title: Introducción a Tanzu Kubernetes Grid (EN) -excerpt: Discover the Tanzu Kubernetes Grid solution -updated: 2022-11-15 ---- - -## Objective - -**This guide introduces Tanzu Kubernetes Grid and the possibilities for its integration into your VMware on OVHcloud solution.** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/es/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere - -## Step-by-step introduction to the Tanzu Kubernetes Grid solution - -VMware Tanzu Kubernetes Grid is a Kubernetes platform provided by **VMware** and maintained as part of the **VMware on OVHcloud** solution. - -You can deploy this product on your OVHcloud infrastructure to take advantage of its features and scalability. - -Tanzu Kubernetes Grid enables you to deploy and manage one or more Kubernetes clusters within your VMware infrastructure. The administration tool for these clusters is itself based on Kubernetes. - -### Initial installation of Tanzu Kubernetes Grid - -Please refer to the [Install Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) documentation for installation. - -Running **Tanzu Kubernetes Grid** on the VMware cluster requires six new virtual machines to run the management cluster. Another virtual machine is required for administration, this virtual machine is provided by OVHcloud and is called **Bootstrap**. - -![01 admin cluster diagram](images/01-admin-cluster-diagram01.png){.thumbnail} - -> [!warning] -> -> The management cluster must be used exclusively for **Tanzu Kubernetes Grid** administration. -> - -### Deploying a *Workload* cluster and installing an application - -To deploy an application, you need to create *WorkLoad* clusters that are dedicated to applications. - -All *WorkLoad* clusters are independent from one another, which means you can have different versions of Kubernetes on each of these *Workload* clusters. - -When installing **Tanzu Kubernetes Grid**, we chose **kube-vip** for interconnections between a *Workload* cluster and the VMware cluster network. You can also use the **Nsx Advanced Load Balancer**. - -Read the [Managing Tanzu Kubernete Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) guide to deploy a *Workload* cluster and application. - -For each new *WorkLoad* cluster installed in production mode, six new virtual machines are added to your VMware infrastructure. - -![02 admin and workload cluster diagram](images/02-tkc-mc-wc01.png){.thumbnail} - -An application can consist of multiple **pods** that communicate with each other through the internal network of the *workload* cluster. Some ports are opened on the **VMware** cluster network using the **kube-vip** module. - -![03 apps and load balancing](images/03-internetworkcommunication01.png){.thumbnail} - -### Managing persistent volumes - -By default, when stopping a **pod** of if it crashes, the data in that **pod** is lost. To store data permanently, you need to create persistent volumes and associate them with applications. - -Persistent volumes are stored by default on VMware storage (vSAN or NFS) that was used for the *WorkLoad* cluster deployment, using VMware APIs (vSphere Cloud Native Storage). - -You can create **Custom Storage Classes** to define another location. - -Read the [Managing Persistent Volumes in Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes) guide to add an application that uses an external persistent volume. - -### Application backup - -Various backup solutions compatible with **Tanzu Kubernetes Grid** exist, including **Kasten** from **Veeam**. - -## Go further - -[Installing a Tanzu Kubernetes GRID cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Managing a Tanzu Kubernetes GRID cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) - -[Managing volumes on a Tanzu Kubernetes GRID cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes) - -[Introducing VMware Tanzu Kubernetes Grid](https://tanzu.vmware.com/kubernetes-grid) - -[VMware Tanzu Kubenetes Grid documentation](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/guide.fr-ca.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/guide.fr-ca.md deleted file mode 100644 index e30fa7f114a..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/guide.fr-ca.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -title: Présentation de Tanzu Kubernetes Grid -excerpt: Découvrez la solution Tanzu Kubernetes Grid -updated: 2022-11-15 ---- - -## Objectif - -**Ce guide vous présente Tanzu Kubernetes Grid et vous indique les possibilités d'intégration dans votre solution VMware on OVHcloud.** - -> [!warning] -> OVHcloud vous met à disposition des services dont la configuration, la gestion et la responsabilité vous incombent. Il vous appartient donc de ce fait d’en assurer le bon fonctionnement. -> -> Ce guide a pour but de vous accompagner au mieux sur des tâches courantes. Néanmoins, nous vous recommandons de faire appel à un [prestataire spécialisé](https://partner.ovhcloud.com/fr/) si vous éprouvez des difficultés ou des doutes concernant l’administration, l’utilisation ou la mise en place d’un service sur un serveur. -> - -## Prérequis - -- Être contact administrateur de l'infrastructure [Hosted Private Cloud](https://www.ovhcloud.com/fr-ca/enterprise/products/hosted-private-cloud/), afin de recevoir les identifiants de connexion. -- Avoir un identifiant actif dans l'[espace client OVHcloud](/links/manager) -- Avoir un identifiant actif dans vSphere. - -## Présentation pas à pas de la solution Tanzu Kubernetes Grid - -**VMware Tanzu Kubernetes Grid** est une plate-forme Kubernetes fournie par **VMware** et maintenue dans le cadre du support **VMware on OVHcloud**. - -Vous pouvez déployer ce produit sur votre infrastructure OVHcloud pour profiter de ses fonctionnalités et de son évolutivité. - -Tanzu Kubernetes Grid permet de déployer et d'administrer un ou plusieurs clusters Kubernetes au sein de votre infrastructure VMware. L'outil d'administration de ces clusters s'appuie lui-même sur Kubernetes. - -### Installation initiale de Tanzu Kubernetes Grid - -Consultez la documentation « [Installer Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) » pour effectuer l'installation. - -Le fonctionnement de **Tanzu Kubernetes Grid** sur le cluster VMware nécessite six nouvelles machines virtuelles pour faire fonctionner le cluster d'administration. Une autre machine virtuelle est nécessaire pour l'administration, cette machine virtuelle est fournie par OVHcloud et se nomme **Bootstrap**. - -![01 admin cluster diagram](images/01-admin-cluster-diagram01.png){.thumbnail} - -> [!warning] -> -> Le cluster d'administration doit être utilisé exclusivement pour l'administration de **Tanzu Kubernetes Grid**. -> - -### Déploiement d'un cluster de *Workload* et installation d'une application - -Pour pouvoir déployer une application, il est nécessaire de créer des clusters de *WorkLoad* dédiés aux applications. - -Tous les clusters de *WorkLoad* sont indépendants les uns des autres, ce qui permet d'avoir des versions différentes de Kubernetes sur chacun de ces clusters de *Workload*. - -Lors de l'installation de **Tanzu Kubernetes Grid**, nous avons choisi **kube-vip** pour les interconnexions entre un cluster de *Workload* et le réseau du cluster VMware. Il est aussi possible d'utiliser **Nsx Advanced Load Balancer**. - -Consultez le guide « [Administrer Tanzu Kubernete Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) » pour déployer un cluster de *Workload* et une application. - -Pour chaque nouveau cluster *WorkLoad* installé en mode production, six nouvelles machines virtuelles sont rajoutées sur votre infrastructure VMware. - -![02 admin and workload cluster diagram](images/02-tkc-mc-wc01.png){.thumbnail} - -Une application peut être constituée de plusieurs **pods** qui communiquent entre eux au travers du réseau interne du cluster de *workload*. Certains ports sont ouverts sur le réseau du cluster **VMware** grâce au module **kube-vip**. - -![03 apps and load balancing](images/03-internetworkcommunication01.png){.thumbnail} - -### Gestion des volumes persistants - -Par défaut, lors de l'arrêt ou d'un crash d'un **pod**, les données contenues dans ce **pod** sont perdues. Pour pouvoir stocker des données de manière permanente, il est nécessaire de créer des volumes persistants et de les associer aux applications. - -Les volumes persistants sont stockés par défaut sur le stockage VMware (vSAN ou NFS) qui a servi pour le déploiement du cluster de *WorkLoad*, en utilisant les API VMware (vSphere Cloud Native Storage). - -Il est possible de créer des **Custom Storage Class** pour définir un autre emplacement. - -Utilisez le guide « [Gestion des volumes permanents dans Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes) » pour ajouter une application qui utilise un volume permanent externe. - -### Sauvegarde de vos applications - -Diverses solutions de sauvegarde compatibles avec **Tanzu Kubernetes Grid** existent, dont **Kasten** de **Veeam**. - -## Aller plus loin - -[Installation d'un cluster Tanzu Kubernetes GRID](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Administrer un cluster Tanzu Kubernetes GRID](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) - -[Gestion des volumes sur un cluster Tanzu Kubernetes GRID](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes) - -[Présentation de VMware Tanzu Kubernetes Grid](https://tanzu.vmware.com/kubernetes-grid) - -[Documentation de VMware Tanzu Kubenetes Grid](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Installation manuelle de l'outil CLI pour le déploiement de Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -Si vous avez besoin d'une formation ou d'une assistance technique pour la mise en oeuvre de nos solutions, contactez votre commercial ou cliquez sur [ce lien](/links/professional-services) pour obtenir un devis et demander une analyse personnalisée de votre projet à nos experts de l’équipe Professional Services. - -Échangez avec notre [communauté d'utilisateurs](/links/community). diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/guide.fr-fr.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/guide.fr-fr.md deleted file mode 100644 index 6ef9b432328..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/guide.fr-fr.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -title: Présentation de Tanzu Kubernetes Grid -excerpt: Découvrez la solution Tanzu Kubernetes Grid -updated: 2022-11-15 ---- - -## Objectif - -**Ce guide vous présente Tanzu Kubernetes Grid et vous indique les possibilités d'intégration dans votre solution VMware on OVHcloud.** - -> [!warning] -> OVHcloud vous met à disposition des services dont la configuration, la gestion et la responsabilité vous incombent. Il vous appartient donc de ce fait d’en assurer le bon fonctionnement. -> -> Ce guide a pour but de vous accompagner au mieux sur des tâches courantes. Néanmoins, nous vous recommandons de faire appel à un [prestataire spécialisé](https://partner.ovhcloud.com/fr/) si vous éprouvez des difficultés ou des doutes concernant l’administration, l’utilisation ou la mise en place d’un service sur un serveur. -> - -## Prérequis - -- Être contact administrateur de l'infrastructure [Hosted Private Cloud](https://www.ovhcloud.com/fr/enterprise/products/hosted-private-cloud/), afin de recevoir les identifiants de connexion. -- Avoir un identifiant actif dans l'[espace client OVHcloud](/links/manager) -- Avoir un identifiant actif dans vSphere. - -## Présentation pas à pas de la solution Tanzu Kubernetes Grid - -**VMware Tanzu Kubernetes Grid** est une plate-forme Kubernetes fournie par **VMware** et maintenue dans le cadre du support **VMware on OVHcloud**. - -Vous pouvez déployer ce produit sur votre infrastructure OVHcloud pour profiter de ses fonctionnalités et de son évolutivité. - -Tanzu Kubernetes Grid permet de déployer et d'administrer un ou plusieurs clusters Kubernetes au sein de votre infrastructure VMware. L'outil d'administration de ces clusters s'appuie lui-même sur Kubernetes. - -### Installation initiale de Tanzu Kubernetes Grid - -Consultez la documentation « [Installer Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) » pour effectuer l'installation. - -Le fonctionnement de **Tanzu Kubernetes Grid** sur le cluster VMware nécessite six nouvelles machines virtuelles pour faire fonctionner le cluster d'administration. Une autre machine virtuelle est nécessaire pour l'administration, cette machine virtuelle est fournie par OVHcloud et se nomme **Bootstrap**. - -![01 admin cluster diagram](images/01-admin-cluster-diagram01.png){.thumbnail} - -> [!warning] -> -> Le cluster d'administration doit être utilisé exclusivement pour l'administration de **Tanzu Kubernetes Grid**. -> - -### Déploiement d'un cluster de *Workload* et installation d'une application - -Pour pouvoir déployer une application, il est nécessaire de créer des clusters de *WorkLoad* dédiés aux applications. - -Tous les clusters de *WorkLoad* sont indépendants les uns des autres, ce qui permet d'avoir des versions différentes de Kubernetes sur chacun de ces clusters de *Workload*. - -Lors de l'installation de **Tanzu Kubernetes Grid**, nous avons choisi **kube-vip** pour les interconnexions entre un cluster de *Workload* et le réseau du cluster VMware. Il est aussi possible d'utiliser **Nsx Advanced Load Balancer**. - -Consultez le guide « [Administrer Tanzu Kubernete Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) » pour déployer un cluster de *Workload* et une application. - -Pour chaque nouveau cluster *WorkLoad* installé en mode production, six nouvelles machines virtuelles sont rajoutées sur votre infrastructure VMware. - -![02 admin and workload cluster diagram](images/02-tkc-mc-wc01.png){.thumbnail} - -Une application peut être constituée de plusieurs **pods** qui communiquent entre eux au travers du réseau interne du cluster de *Workload*. Certains ports sont ouverts sur le réseau du cluster **VMware** grâce au module **kube-vip**. - -![03 apps and load balancing](images/03-internetworkcommunication01.png){.thumbnail} - -### Gestion des volumes persistants - -Par défaut, lors de l'arrêt ou d'un crash d'un **pod**, les données contenues dans ce **pod** sont perdues. Pour pouvoir stocker des données de manière permanente, il est nécessaire de créer des volumes persistants et de les associer aux applications. - -Les volumes persistants sont stockés par défaut sur le stockage VMware (vSAN ou NFS) qui a servi pour le déploiement du cluster de *WorkLoad*, en utilisant les API VMware (vSphere Cloud Native Storage). - -Il est possible de créer des **Custom Storage Class** pour définir un autre emplacement. - -Utilisez le guide « [Gestion des volumes permanents dans Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes) » pour ajouter une application qui utilise un volume permanent externe. - -### Sauvegarde de vos applications - -Diverses solutions de sauvegarde compatibles avec **Tanzu Kubernetes Grid** existent, dont **Kasten** de **Veeam**. - -## Aller plus loin - -[Installation d'un cluster Tanzu Kubernetes GRID](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Administrer un cluster Tanzu Kubernetes GRID](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) - -[Gestion des volumes sur un cluster Tanzu Kubernetes GRID](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes) - -[Présentation de VMware Tanzu Kubernetes Grid](https://tanzu.vmware.com/kubernetes-grid) - -[Documentation de VMware Tanzu Kubenetes Grid](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Installation manuelle de l'outil CLI pour le déploiement de Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -Si vous avez besoin d'une formation ou d'une assistance technique pour la mise en oeuvre de nos solutions, contactez votre commercial ou cliquez sur [ce lien](/links/professional-services) pour obtenir un devis et demander une analyse personnalisée de votre projet à nos experts de l’équipe Professional Services. - -Échangez avec notre [communauté d'utilisateurs](/links/community). diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/guide.it-it.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/guide.it-it.md deleted file mode 100644 index fbc9f1ae103..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/guide.it-it.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -title: Introduzione alla griglia di Tanzu Kubernetes (EN) -excerpt: Discover the Tanzu Kubernetes Grid solution -updated: 2022-11-15 ---- - -## Objective - -**This guide introduces Tanzu Kubernetes Grid and the possibilities for its integration into your VMware on OVHcloud solution.** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/it/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere - -## Step-by-step introduction to the Tanzu Kubernetes Grid solution - -VMware Tanzu Kubernetes Grid is a Kubernetes platform provided by **VMware** and maintained as part of the **VMware on OVHcloud** solution. - -You can deploy this product on your OVHcloud infrastructure to take advantage of its features and scalability. - -Tanzu Kubernetes Grid enables you to deploy and manage one or more Kubernetes clusters within your VMware infrastructure. The administration tool for these clusters is itself based on Kubernetes. - -### Initial installation of Tanzu Kubernetes Grid - -Please refer to the [Install Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) documentation for installation. - -Running **Tanzu Kubernetes Grid** on the VMware cluster requires six new virtual machines to run the management cluster. Another virtual machine is required for administration, this virtual machine is provided by OVHcloud and is called **Bootstrap**. - -![01 admin cluster diagram](images/01-admin-cluster-diagram01.png){.thumbnail} - -> [!warning] -> -> The management cluster must be used exclusively for **Tanzu Kubernetes Grid** administration. -> - -### Deploying a *Workload* cluster and installing an application - -To deploy an application, you need to create *WorkLoad* clusters that are dedicated to applications. - -All *WorkLoad* clusters are independent from one another, which means you can have different versions of Kubernetes on each of these *Workload* clusters. - -When installing **Tanzu Kubernetes Grid**, we chose **kube-vip** for interconnections between a *Workload* cluster and the VMware cluster network. You can also use the **Nsx Advanced Load Balancer**. - -Read the [Managing Tanzu Kubernete Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) guide to deploy a *Workload* cluster and application. - -For each new *WorkLoad* cluster installed in production mode, six new virtual machines are added to your VMware infrastructure. - -![02 admin and workload cluster diagram](images/02-tkc-mc-wc01.png){.thumbnail} - -An application can consist of multiple **pods** that communicate with each other through the internal network of the *workload* cluster. Some ports are opened on the **VMware** cluster network using the **kube-vip** module. - -![03 apps and load balancing](images/03-internetworkcommunication01.png){.thumbnail} - -### Managing persistent volumes - -By default, when stopping a **pod** of if it crashes, the data in that **pod** is lost. To store data permanently, you need to create persistent volumes and associate them with applications. - -Persistent volumes are stored by default on VMware storage (vSAN or NFS) that was used for the *WorkLoad* cluster deployment, using VMware APIs (vSphere Cloud Native Storage). - -You can create **Custom Storage Classes** to define another location. - -Read the [Managing Persistent Volumes in Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes) guide to add an application that uses an external persistent volume. - -### Application backup - -Various backup solutions compatible with **Tanzu Kubernetes Grid** exist, including **Kasten** from **Veeam**. - -## Go further - -[Installing a Tanzu Kubernetes GRID cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Managing a Tanzu Kubernetes GRID cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) - -[Managing volumes on a Tanzu Kubernetes GRID cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes) - -[Introducing VMware Tanzu Kubernetes Grid](https://tanzu.vmware.com/kubernetes-grid) - -[VMware Tanzu Kubenetes Grid documentation](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/guide.pl-pl.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/guide.pl-pl.md deleted file mode 100644 index 05fdc7d4c43..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/guide.pl-pl.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -title: Wprowadzenie do siatki Tanzu Kubernetes (EN) -excerpt: Discover the Tanzu Kubernetes Grid solution -updated: 2022-11-15 ---- - -## Objective - -**This guide introduces Tanzu Kubernetes Grid and the possibilities for its integration into your VMware on OVHcloud solution.** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/pl/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere - -## Step-by-step introduction to the Tanzu Kubernetes Grid solution - -VMware Tanzu Kubernetes Grid is a Kubernetes platform provided by **VMware** and maintained as part of the **VMware on OVHcloud** solution. - -You can deploy this product on your OVHcloud infrastructure to take advantage of its features and scalability. - -Tanzu Kubernetes Grid enables you to deploy and manage one or more Kubernetes clusters within your VMware infrastructure. The administration tool for these clusters is itself based on Kubernetes. - -### Initial installation of Tanzu Kubernetes Grid - -Please refer to the [Install Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) documentation for installation. - -Running **Tanzu Kubernetes Grid** on the VMware cluster requires six new virtual machines to run the management cluster. Another virtual machine is required for administration, this virtual machine is provided by OVHcloud and is called **Bootstrap**. - -![01 admin cluster diagram](images/01-admin-cluster-diagram01.png){.thumbnail} - -> [!warning] -> -> The management cluster must be used exclusively for **Tanzu Kubernetes Grid** administration. -> - -### Deploying a *Workload* cluster and installing an application - -To deploy an application, you need to create *WorkLoad* clusters that are dedicated to applications. - -All *WorkLoad* clusters are independent from one another, which means you can have different versions of Kubernetes on each of these *Workload* clusters. - -When installing **Tanzu Kubernetes Grid**, we chose **kube-vip** for interconnections between a *Workload* cluster and the VMware cluster network. You can also use the **Nsx Advanced Load Balancer**. - -Read the [Managing Tanzu Kubernete Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) guide to deploy a *Workload* cluster and application. - -For each new *WorkLoad* cluster installed in production mode, six new virtual machines are added to your VMware infrastructure. - -![02 admin and workload cluster diagram](images/02-tkc-mc-wc01.png){.thumbnail} - -An application can consist of multiple **pods** that communicate with each other through the internal network of the *workload* cluster. Some ports are opened on the **VMware** cluster network using the **kube-vip** module. - -![03 apps and load balancing](images/03-internetworkcommunication01.png){.thumbnail} - -### Managing persistent volumes - -By default, when stopping a **pod** of if it crashes, the data in that **pod** is lost. To store data permanently, you need to create persistent volumes and associate them with applications. - -Persistent volumes are stored by default on VMware storage (vSAN or NFS) that was used for the *WorkLoad* cluster deployment, using VMware APIs (vSphere Cloud Native Storage). - -You can create **Custom Storage Classes** to define another location. - -Read the [Managing Persistent Volumes in Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes) guide to add an application that uses an external persistent volume. - -### Application backup - -Various backup solutions compatible with **Tanzu Kubernetes Grid** exist, including **Kasten** from **Veeam**. - -## Go further - -[Installing a Tanzu Kubernetes GRID cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Managing a Tanzu Kubernetes GRID cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) - -[Managing volumes on a Tanzu Kubernetes GRID cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes) - -[Introducing VMware Tanzu Kubernetes Grid](https://tanzu.vmware.com/kubernetes-grid) - -[VMware Tanzu Kubenetes Grid documentation](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/guide.pt-pt.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/guide.pt-pt.md deleted file mode 100644 index 1c000c124e3..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/guide.pt-pt.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -title: Introdução ao Tanzu Kubernetes Grid (EN) -excerpt: Discover the Tanzu Kubernetes Grid solution -updated: 2022-11-15 ---- - -## Objective - -**This guide introduces Tanzu Kubernetes Grid and the possibilities for its integration into your VMware on OVHcloud solution.** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/pt/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere - -## Step-by-step introduction to the Tanzu Kubernetes Grid solution - -VMware Tanzu Kubernetes Grid is a Kubernetes platform provided by **VMware** and maintained as part of the **VMware on OVHcloud** solution. - -You can deploy this product on your OVHcloud infrastructure to take advantage of its features and scalability. - -Tanzu Kubernetes Grid enables you to deploy and manage one or more Kubernetes clusters within your VMware infrastructure. The administration tool for these clusters is itself based on Kubernetes. - -### Initial installation of Tanzu Kubernetes Grid - -Please refer to the [Install Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) documentation for installation. - -Running **Tanzu Kubernetes Grid** on the VMware cluster requires six new virtual machines to run the management cluster. Another virtual machine is required for administration, this virtual machine is provided by OVHcloud and is called **Bootstrap**. - -![01 admin cluster diagram](images/01-admin-cluster-diagram01.png){.thumbnail} - -> [!warning] -> -> The management cluster must be used exclusively for **Tanzu Kubernetes Grid** administration. -> - -### Deploying a *Workload* cluster and installing an application - -To deploy an application, you need to create *WorkLoad* clusters that are dedicated to applications. - -All *WorkLoad* clusters are independent from one another, which means you can have different versions of Kubernetes on each of these *Workload* clusters. - -When installing **Tanzu Kubernetes Grid**, we chose **kube-vip** for interconnections between a *Workload* cluster and the VMware cluster network. You can also use the **Nsx Advanced Load Balancer**. - -Read the [Managing Tanzu Kubernete Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) guide to deploy a *Workload* cluster and application. - -For each new *WorkLoad* cluster installed in production mode, six new virtual machines are added to your VMware infrastructure. - -![02 admin and workload cluster diagram](images/02-tkc-mc-wc01.png){.thumbnail} - -An application can consist of multiple **pods** that communicate with each other through the internal network of the *workload* cluster. Some ports are opened on the **VMware** cluster network using the **kube-vip** module. - -![03 apps and load balancing](images/03-internetworkcommunication01.png){.thumbnail} - -### Managing persistent volumes - -By default, when stopping a **pod** of if it crashes, the data in that **pod** is lost. To store data permanently, you need to create persistent volumes and associate them with applications. - -Persistent volumes are stored by default on VMware storage (vSAN or NFS) that was used for the *WorkLoad* cluster deployment, using VMware APIs (vSphere Cloud Native Storage). - -You can create **Custom Storage Classes** to define another location. - -Read the [Managing Persistent Volumes in Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes) guide to add an application that uses an external persistent volume. - -### Application backup - -Various backup solutions compatible with **Tanzu Kubernetes Grid** exist, including **Kasten** from **Veeam**. - -## Go further - -[Installing a Tanzu Kubernetes GRID cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Managing a Tanzu Kubernetes GRID cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) - -[Managing volumes on a Tanzu Kubernetes GRID cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes) - -[Introducing VMware Tanzu Kubernetes Grid](https://tanzu.vmware.com/kubernetes-grid) - -[VMware Tanzu Kubenetes Grid documentation](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/images/01-admin-cluster-diagram01.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/images/01-admin-cluster-diagram01.png deleted file mode 100644 index 0032d38c4ad..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/images/01-admin-cluster-diagram01.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/images/02-tkc-mc-wc01.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/images/02-tkc-mc-wc01.png deleted file mode 100644 index 3e342e1fef9..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/images/02-tkc-mc-wc01.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/images/03-internetworkcommunication01.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/images/03-internetworkcommunication01.png deleted file mode 100644 index 6f076ffbe73..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/images/03-internetworkcommunication01.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/meta.yaml b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/meta.yaml deleted file mode 100755 index 1a4d03f6f04..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_01presentation/meta.yaml +++ /dev/null @@ -1,2 +0,0 @@ -id: cfb2c4cc-dcf3-46a5-9d26-7ec570a23105 -full_slug: vmware-tanzu-tkgm-presentation \ No newline at end of file diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/guide.de-de.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/guide.de-de.md deleted file mode 100644 index 1b8c74b1b80..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/guide.de-de.md +++ /dev/null @@ -1,366 +0,0 @@ ---- -title: Tanzu Kubernetes Grid installieren (EN) -excerpt: Learn how to integrate Tanzu Kubernetes Grid into your VMware on OVHcloud infrastructure -updated: 2022-11-10 ---- - -## Objective - -**This guide documents how to install Tanzu Kubernetes Grid on your VMware on OVHcloud cluster** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Introduction - -VMware Tanzu Kubernetes Grid is a Kubernetes platform provided by **VMware** and maintained as part of the **VMware on OVHcloud** solution. - -You can install this product on your OVHcloud infrastructure to take advantage of its features and scalability. - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/de/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- A VLAN with internet access and a DHCP server -- You must have these resources: - - 8 GB of memory, 4 vCPUs, and 250 GB of storage for the management virtual machine named **Bootstrap**. - - 16 GB of memory, 4 vCPU, 40 GB of storage per Kubernetes node (it takes 6 nodes to install the management cluster in production mode and 6 nodes per **Workload** cluster in the same mode). - -## Instructions - -We will install **VMware Tanzu Kubernetes Grid** on a **VMware on OVHcloud** cluster and use VLAN 10 with these settings: - -- **LAN**: `192.168.0.0/24`. -- **DHCP Range**: `192.168.0.50 -> 192.168.0.100`. -- **Gateway**: `192.168.0.254`. - -> [!primary] -> This information is given as an example, it is quite possible to use another range and another VLAN. -> - -At the end of the installation, seven additional virtual machines will be on your VMware cluster, six for running the **TKG** management cluster and one for managing it. - -![00 admin cluster diagram](images/00-admin-cluster-diagram01.png){.thumbnail} - -### Importing OVA model for **Tanzu KUBERNETES Grid** into your infrastructure - -VMware provides a virtual machine as an OVA template, which contains all the elements to run a node of the **Tanzu Kubernetes Grid** cluster. This virtual machine is available in **OVH Templates**. - -Log in to the OVHcloud homepage for your VMware cluster, and click `OVH Templates`{.action} to the right. - -![01 integrate TKGM OVA 01](images/01-integrate-tkgm-ova01.png){.thumbnail} - -In the **Select a template** window, choose the fourth template from the top that has this information: - -- **Family**: Linux -- **Distribution**: not specified -- **Version**: 3 - -![01 integrate TKGM OVA 02](images/01-integrate-tkgm-ova02.png){.thumbnail} - -Click the `Copy`{.action} icon to the right to copy the URL which name must end in **photon-3-kube-v1.23.8+vmware.1.ovf**. Then click `Close`{.action}. - -![01 integrate TKGM OVA 03](images/01-integrate-tkgm-ova03.png){.thumbnail} - -Log in to your vSphere console, right-click your cluster and choose `Deploy an OVF Template`{.action}. - -![01 integrate TKGM OVA 03b](images/01-integrate-tkgm-ova03b.png){.thumbnail} - -Select `URL`{.action}, paste the previously copied URL and click `NEXT`{.action}. - -![01 integrate TKGM OVA 04](images/01-integrate-tkgm-ova04.png){.thumbnail} - -Leave the default location and click `NEXT`{.action}. - -![01 integrate TKGM OVA 05](images/01-integrate-tkgm-ova05.png){.thumbnail} - -Choose the cluster and click `NEXT`{.action}. - -![01 integrate TKGM OVA 06](images/01-integrate-tkgm-ova06.png){.thumbnail} - -Review your information and click `NEXT`{.action}. - -![01 integrate TKGM OVA 07](images/01-integrate-tkgm-ova07.png){.thumbnail} - -Check `I accept all licence agreements`{.action} and click `NEXT`{.action}. - -![01 integrate TKGM OVA 08](images/01-integrate-tkgm-ova08.png){.thumbnail} - -Select a shared storage in NFS v3, then click `NEXT`{.action}. - -![01 integrate TKGM OVA 09](images/01-integrate-tkgm-ova09.png){.thumbnail} - -Choose the destination network on `VLAN 10`{.action} and click `NEXT`{.action}. - -![01 integrate TKGM OVA 10](images/01-integrate-tkgm-ova10.png){.thumbnail} - -Click `FINISH`{.action}. - -![01 integrate TKGM OVA 11](images/01-integrate-tkgm-ova11.png){.thumbnail} - -Select the `Monitor`{.action} tab and click `Tasks`{.action}. - -![01 integrate TKGM OVA 12](images/01-integrate-tkgm-ova12.png){.thumbnail} - -Wait for the `Deploy OVF template` and `Import OVF package` tasks to complete. - -![01 integrate TKGM OVA 13](images/01-integrate-tkgm-ova13.png){.thumbnail} - -Right-click the deployed VM and choose `Convert to Template`{.action} from the `Template`{.action} menu. - -![01 integrate TKGM OVA 14](images/01-integrate-tkgm-ova14.png){.thumbnail} - -Answer `YES`{.action} to convert the virtual machine. - -![01 integrate TKGM OVA 15](images/01-integrate-tkgm-ova15.png){.thumbnail} - -Go to `Virtual Machines (and templates)`{.action} to see the template you have created. - -> [!primary] -> -> This template will be used when deploying **Tanzu Kubernetes Grid** clusters. It is used for the initial deployment of the administration cluster and for the installation of additional *WorkLoad* clusters. It should not be deleted from the **VMware** cluster. -> - -![01 integrate TKGM OVA 16](images/01-integrate-tkgm-ova16.png){.thumbnail} - -### Installation of the virtual machine **Bootstrap** provided by OVHcloud - -This virtual machine was created by OVHcloud from the documentation [Installing the CLI tool manually for deploying **Tanzu Kubernetes GRID**](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html). It is available as a template in **OVH Templates**. - -Log in to the OVHcloud homepage for your VMware cluster, and click `OVH Templates`{.action} to the right. - -![02 Add Bootstrapvm 01](images/02-add-bootstrap-vm-from-ova01.png){.thumbnail} - -In the **Select a template** window, choose the third template from the top that contains this information: - -- **Family**: Linux -- **Distribution**: Ubuntu -- **Version**: 22 - -![02 Add Bootstrapvm 02](images/02-add-bootstrap-vm-from-ova02.png){.thumbnail} - -Click the `Copy`{.action} icon to the right to copy the URL, the URL should end with **Ubuntu-22.04_TKGm-1.6_with_x.ovf**. Then click `Close`{.action}. - -![02 Add Bootstrapvm 03](images/02-add-bootstrap-vm-from-ova03.png){.thumbnail} - -In the vSphere interface, right-click the cluster and choose `Deploy an OVF Template`{.action} from the menu. - -![02 Add Bootstrapvm 03b](images/02-add-bootstrap-vm-from-ova03b.png){.thumbnail} - -Select `URL`{.action}, paste the previously copied URL and click `NEXT`{.action}. - -![02 Add Bootstrapvm 04](images/02-add-bootstrap-vm-from-ova04.png){.thumbnail} - -Leave the default positioning and click `NEXT`{.action}. - -![02 Add Bootstrapvm 05](images/02-add-bootstrap-vm-from-ova05.png){.thumbnail} - -Leave `Cluster1` and click `NEXT`{.action}. - -![02 Add Bootstrapvm 06](images/02-add-bootstrap-vm-from-ova06.png){.thumbnail} - -Click `NEXT`{.action} to validate your choices. - -![02 Add Bootstrapvm 07](images/02-add-bootstrap-vm-from-ova07.png){.thumbnail} - -Select a shared storage in NFS v3 and click `NEXT`{.action}. - -![02 Add Bootstrapvm 08](images/02-add-bootstrap-vm-from-ova08.png){.thumbnail} - -Choose `VLAN10` for the destination network and click `NEXT`{.action}. - -![02 Add Bootstrapvm 09](images/02-add-bootstrap-vm-from-ova09.png){.thumbnail} - -Add this information in **Networking**: - -- **Hostname**: `bootstrap` -- **IP Address**: `192.168.0.199` -- **Network CIDR Prefix**: `24` -- **Gateway**: `192.168.0.254` -- **DNS**: `213.186.33.99` - -> [!primary] -> -> The DNS server chosen in this guide is the OVHcloud server. -> - -Enter and confirm the password in **OS Credentials** and click `NEXT`{.action}. - -![02 Add Bootstrapvm 10](images/02-add-bootstrap-vm-from-ova10.png){.thumbnail} - -Click `FINISH`{.action}. - -![02 Add Bootstrapvm 11](images/02-add-bootstrap-vm-from-ova11.png){.thumbnail} - -Right-click the virtual machine you created, go to `Power`{.action} and click `Power On`{.action}. - -![02 Add Bootstrapvm 12](images/02-add-bootstrap-vm-from-ova12.png){.thumbnail} - -The booted virtual machine can be accessed via the console with the graphical interface or via **SSH**. - -Go to the virtual machine you have created, and click `LAUNCH WEB CONSOLE`{.action}. - -![02 Add Bootstrapvm 13](images/02-add-bootstrap-vm-from-ova13.png){.thumbnail} - -The graphical interface for the Linux virtual machine is then available. - -![02 Add Bootstrapvm 14](images/02-add-bootstrap-vm-from-ova14.png){.thumbnail} - -### Allowing access to the PCC cluster from the **Bootstrap** virtual machine - -The configuration and administration tools for **Tanzu Kubernetes Grid** are installed on the **Bootstrap** virtual machine. This virtual machine must be able to connect to the Internet and to the vSphere cluster. - -Write down **the public IP address** you use on this virtual machine and use this guide [Authorise IP addresses to connect to vCenter](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/autoriser_des_ip_a_se_connecter_au_vcenter) to grant access to the vSphere cluster to the new virtual machine. - -### Deploying the **Tanzu Kubernetes Grid** cluster on your infrastructure - -Log in to the `Ubuntu-22.04_TKGm-1.5.4_with_x` virtual machine, open a terminal, and run this command to create an **RSA** key: - -```bash -ssh-keygen -t rsa -b 4096 -C "youremail@yourdomain.com" -``` - -![03 Create TKG CLUSTER 01](images/03-create-tkg-cluster01.png){.thumbnail} - -Two files are created in the **~/.ssh** folder: - -- **id_rsa.pub** -- **id_rsa** - -Stay on the console and run this command: - -```bash -tanzu management-cluster create --ui --bind 192.168.0.199:8080 -``` - -> [!primary] -> -> When you run this command from the Linux console with the graphical interface, the web browser launches and connects to `https://192.168.0.199:8080`. If you have run this command from an **SSH** connection, you will need to connect to `https://192.168.0.199:8080` from a virtual machine on the same network with a graphical interface and an operational web browser. -> - -![03 Create TKG CLUSTER 02](images/03-create-tkg-cluster02.png){.thumbnail} - -Click `Deploy`{.action} below **VMware vSphere**. - -![03 Create TKG CLUSTER 03](images/03-create-tkg-cluster03.png){.thumbnail} - -Enter this information: - -- **VCENTER SERVER**: `VMware cluster FQDN` -- **USERNAME**: `VMware cluster user` -- **PASSWORD**: `VMware cluster user password` - -Then click `CONNECT`{.action}. - -![03 Create TKG CLUSTER 04](images/03-create-tkg-cluster04.png){.thumbnail} - -At the verification step of the **SSL Thumbprint**, click `CONTINUE`{.action}. - -![03 Create TKG CLUSTER 05](images/03-create-tkg-cluster05.png){.thumbnail} - -Click the cross in the top right to close the **vSphere 7.0.3 Environment Detected** window. - -![03 Create TKG CLUSTER 06](images/03-create-tkg-cluster06.png){.thumbnail} - -Paste the contents of the **~.ssh/id_rsa.pub** file into **SSH PUBLIC KEY** and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 07](images/03-create-tkg-cluster07.png){.thumbnail} - -Select `Production`{.action} on the right and select the `large etc...` **INSTANCE TYPE**. - -Enter these values: - -- **MANAGEMENT CLUSTER NAME (OPTIONAL)**: `tkgm-management-cluster`. -- **CONTROL PLANE ENDPOINT**: `192.168.0.10`. - -Click `NEXT`{.action} to proceed to the next step. - -![03 Create TKG CLUSTER 08](images/03-create-tkg-cluster08.png){.thumbnail} - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 09](images/03-create-tkg-cluster09.png){.thumbnail} - -In the **Metadata** option and then in the **LABELS (OPTIONAL)** section, type `tkgm` for the name and its value. - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 10](images/03-create-tkg-cluster10.png){.thumbnail} - -Enter these options: - -- **VM FOLDER**: `Storage folder for virtual machines`. -- **DATASTORE**: `Storage of virtual machines to be placed on a shared storage` . -- **CLUSTERS, HOSTS, AND RESOURCE POOLS**: `Cluster1`. - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 11](images/03-create-tkg-cluster11.png){.thumbnail} - -In **NETWORK NAME** select `VLAN10`{.action}. - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 12](images/03-create-tkg-cluster12.png){.thumbnail} - -Disable the `Activate Identity Management Settings`{.action} option and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 13](images/03-create-tkg-cluster13.png){.thumbnail} - -Select the OVA image integrated into the `photon-3-kube-v1.22.9+vmware.1` cluster from the **OS Image** menu and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 14](images/03-create-tkg-cluster14.png){.thumbnail} - -Uncheck `Participate in the Customer Experience Improvement Program`{.action} and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 15](images/03-create-tkg-cluster15.png){.thumbnail} - -Click `REVIEW CONFIGURATION`{.action}. - -![03 Create TKG CLUSTER 16](images/03-create-tkg-cluster16.png){.thumbnail} - -> [!primary] -> Take note of the name of the yaml file below **CLI Command Equivalent**, it will serve as a template for deploying a **WorkLoad** cluster. -> - -Scroll through the window and click `DEPLOY MANAGEMENT CLUSTER`{.action} - -![03 Create TKG CLUSTER 17](images/03-create-tkg-cluster17.png){.thumbnail} - -The **Tanzu Kubernetes Grid** cluster deployment is started, please wait for it to complete. - -> [!primary] -> The deployment will be completed when you see the **Management cluster created** and **Successfully installed all required plugins** messages in the window. -> -> ![03 Create TKG CLUSTER 18](images/03-create-tkg-cluster18.png){.thumbnail} -> -> Another indication that the installation is complete can be found in the console of the **Bootstrap** virtual machine in which will appear the **Management cluster created** and **You can now create your first workload cluster etc...** messages. - -> [!warning] -> -> Write down or copy the name of the **yaml** file in the `/home/tanzu/.config/tanzu/tkg/clusterconfigs` folder, it will be used to create a configuration file for installing a *WorkLoad cluster* -> - -![03 Create TKG CLUSTER 19](images/03-create-tkg-cluster19.png){.thumbnail} - -Go to the vCenter interface to see the seven virtual machines created. - -![04 VM CREATED ADFTER INSTALLATION 01](images/04-vm-created-after-installation01.png){.thumbnail} - -## Go further - -[Administrating a TKG cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) - -[Introducing VMware Tanzu Kubernetes Grid](https://tanzu.vmware.com/kubernetes-grid) - -[Documentation de VMware Tanzu Kubenetes Grid](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/guide.en-asia.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/guide.en-asia.md deleted file mode 100644 index bc8879bf073..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/guide.en-asia.md +++ /dev/null @@ -1,366 +0,0 @@ ---- -title: Installing Tanzu Kubernetes Grid -excerpt: Learn how to integrate Tanzu Kubernetes Grid into your VMware on OVHcloud infrastructure -updated: 2022-11-10 ---- - -## Objective - -**This guide documents how to install Tanzu Kubernetes Grid on your VMware on OVHcloud cluster** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Introduction - -VMware Tanzu Kubernetes Grid is a Kubernetes platform provided by **VMware** and maintained as part of the **VMware on OVHcloud** solution. - -You can install this product on your OVHcloud infrastructure to take advantage of its features and scalability. - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/asia/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- A VLAN with internet access and a DHCP server -- You must have these resources: - - 8 GB of memory, 4 vCPUs, and 250 GB of storage for the management virtual machine named **Bootstrap**. - - 16 GB of memory, 4 vCPU, 40 GB of storage per Kubernetes node (it takes 6 nodes to install the management cluster in production mode and 6 nodes per **Workload** cluster in the same mode). - -## Instructions - -We will install **VMware Tanzu Kubernetes Grid** on a **VMware on OVHcloud** cluster and use VLAN 10 with these settings: - -- **LAN**: `192.168.0.0/24`. -- **DHCP Range**: `192.168.0.50 -> 192.168.0.100`. -- **Gateway**: `192.168.0.254`. - -> [!primary] -> This information is given as an example, it is quite possible to use another range and another VLAN. -> - -At the end of the installation, seven additional virtual machines will be on your VMware cluster, six for running the **TKG** management cluster and one for managing it. - -![00 admin cluster diagram](images/00-admin-cluster-diagram01.png){.thumbnail} - -### Importing OVA model for **Tanzu KUBERNETES Grid** into your infrastructure - -VMware provides a virtual machine as an OVA template, which contains all the elements to run a node of the **Tanzu Kubernetes Grid** cluster. This virtual machine is available in **OVH Templates**. - -Log in to the OVHcloud homepage for your VMware cluster, and click `OVH Templates`{.action} to the right. - -![01 integrate TKGM OVA 01](images/01-integrate-tkgm-ova01.png){.thumbnail} - -In the **Select a template** window, choose the fourth template from the top that has this information: - -- **Family**: Linux -- **Distribution**: not specified -- **Version**: 3 - -![01 integrate TKGM OVA 02](images/01-integrate-tkgm-ova02.png){.thumbnail} - -Click the `Copy`{.action} icon to the right to copy the URL which name must end in **photon-3-kube-v1.23.8+vmware.1.ovf**. Then click `Close`{.action}. - -![01 integrate TKGM OVA 03](images/01-integrate-tkgm-ova03.png){.thumbnail} - -Log in to your vSphere console, right-click your cluster and choose `Deploy an OVF Template`{.action}. - -![01 integrate TKGM OVA 03b](images/01-integrate-tkgm-ova03b.png){.thumbnail} - -Select `URL`{.action}, paste the previously copied URL and click `NEXT`{.action}. - -![01 integrate TKGM OVA 04](images/01-integrate-tkgm-ova04.png){.thumbnail} - -Leave the default location and click `NEXT`{.action}. - -![01 integrate TKGM OVA 05](images/01-integrate-tkgm-ova05.png){.thumbnail} - -Choose the cluster and click `NEXT`{.action}. - -![01 integrate TKGM OVA 06](images/01-integrate-tkgm-ova06.png){.thumbnail} - -Review your information and click `NEXT`{.action}. - -![01 integrate TKGM OVA 07](images/01-integrate-tkgm-ova07.png){.thumbnail} - -Check `I accept all licence agreements`{.action} and click `NEXT`{.action}. - -![01 integrate TKGM OVA 08](images/01-integrate-tkgm-ova08.png){.thumbnail} - -Select a shared storage in NFS v3, then click `NEXT`{.action}. - -![01 integrate TKGM OVA 09](images/01-integrate-tkgm-ova09.png){.thumbnail} - -Choose the destination network on `VLAN 10`{.action} and click `NEXT`{.action}. - -![01 integrate TKGM OVA 10](images/01-integrate-tkgm-ova10.png){.thumbnail} - -Click `FINISH`{.action}. - -![01 integrate TKGM OVA 11](images/01-integrate-tkgm-ova11.png){.thumbnail} - -Select the `Monitor`{.action} tab and click `Tasks`{.action}. - -![01 integrate TKGM OVA 12](images/01-integrate-tkgm-ova12.png){.thumbnail} - -Wait for the `Deploy OVF template` and `Import OVF package` tasks to complete. - -![01 integrate TKGM OVA 13](images/01-integrate-tkgm-ova13.png){.thumbnail} - -Right-click the deployed VM and choose `Convert to Template`{.action} from the `Template`{.action} menu. - -![01 integrate TKGM OVA 14](images/01-integrate-tkgm-ova14.png){.thumbnail} - -Answer `YES`{.action} to convert the virtual machine. - -![01 integrate TKGM OVA 15](images/01-integrate-tkgm-ova15.png){.thumbnail} - -Go to `Virtual Machines (and templates)`{.action} to see the template you have created. - -> [!primary] -> -> This template will be used when deploying **Tanzu Kubernetes Grid** clusters. It is used for the initial deployment of the administration cluster and for the installation of additional *WorkLoad* clusters. It should not be deleted from the **VMware** cluster. -> - -![01 integrate TKGM OVA 16](images/01-integrate-tkgm-ova16.png){.thumbnail} - -### Installation of the virtual machine **Bootstrap** provided by OVHcloud - -This virtual machine was created by OVHcloud from the documentation [Installing the CLI tool manually for deploying **Tanzu Kubernetes GRID**](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html). It is available as a template in **OVH Templates**. - -Log in to the OVHcloud homepage for your VMware cluster, and click `OVH Templates`{.action} to the right. - -![02 Add Bootstrapvm 01](images/02-add-bootstrap-vm-from-ova01.png){.thumbnail} - -In the **Select a template** window, choose the third template from the top that contains this information: - -- **Family**: Linux -- **Distribution**: Ubuntu -- **Version**: 22 - -![02 Add Bootstrapvm 02](images/02-add-bootstrap-vm-from-ova02.png){.thumbnail} - -Click the `Copy`{.action} icon to the right to copy the URL, the URL should end with **Ubuntu-22.04_TKGm-1.6_with_x.ovf**. Then click `Close`{.action}. - -![02 Add Bootstrapvm 03](images/02-add-bootstrap-vm-from-ova03.png){.thumbnail} - -In the vSphere interface, right-click the cluster and choose `Deploy an OVF Template`{.action} from the menu. - -![02 Add Bootstrapvm 03b](images/02-add-bootstrap-vm-from-ova03b.png){.thumbnail} - -Select `URL`{.action}, paste the previously copied URL and click `NEXT`{.action}. - -![02 Add Bootstrapvm 04](images/02-add-bootstrap-vm-from-ova04.png){.thumbnail} - -Leave the default positioning and click `NEXT`{.action}. - -![02 Add Bootstrapvm 05](images/02-add-bootstrap-vm-from-ova05.png){.thumbnail} - -Leave `Cluster1` and click `NEXT`{.action}. - -![02 Add Bootstrapvm 06](images/02-add-bootstrap-vm-from-ova06.png){.thumbnail} - -Click `NEXT`{.action} to validate your choices. - -![02 Add Bootstrapvm 07](images/02-add-bootstrap-vm-from-ova07.png){.thumbnail} - -Select a shared storage in NFS v3 and click `NEXT`{.action}. - -![02 Add Bootstrapvm 08](images/02-add-bootstrap-vm-from-ova08.png){.thumbnail} - -Choose `VLAN10` for the destination network and click `NEXT`{.action}. - -![02 Add Bootstrapvm 09](images/02-add-bootstrap-vm-from-ova09.png){.thumbnail} - -Add this information in **Networking**: - -- **Hostname**: `bootstrap` -- **IP Address**: `192.168.0.199` -- **Network CIDR Prefix**: `24` -- **Gateway**: `192.168.0.254` -- **DNS**: `213.186.33.99` - -> [!primary] -> -> The DNS server chosen in this guide is the OVHcloud server. -> - -Enter and confirm the password in **OS Credentials** and click `NEXT`{.action}. - -![02 Add Bootstrapvm 10](images/02-add-bootstrap-vm-from-ova10.png){.thumbnail} - -Click `FINISH`{.action}. - -![02 Add Bootstrapvm 11](images/02-add-bootstrap-vm-from-ova11.png){.thumbnail} - -Right-click the virtual machine you created, go to `Power`{.action} and click `Power On`{.action}. - -![02 Add Bootstrapvm 12](images/02-add-bootstrap-vm-from-ova12.png){.thumbnail} - -The booted virtual machine can be accessed via the console with the graphical interface or via **SSH**. - -Go to the virtual machine you have created, and click `LAUNCH WEB CONSOLE`{.action}. - -![02 Add Bootstrapvm 13](images/02-add-bootstrap-vm-from-ova13.png){.thumbnail} - -The graphical interface for the Linux virtual machine is then available. - -![02 Add Bootstrapvm 14](images/02-add-bootstrap-vm-from-ova14.png){.thumbnail} - -### Allowing access to the PCC cluster from the **Bootstrap** virtual machine - -The configuration and administration tools for **Tanzu Kubernetes Grid** are installed on the **Bootstrap** virtual machine. This virtual machine must be able to connect to the Internet and to the vSphere cluster. - -Write down **the public IP address** you use on this virtual machine and use this guide [Authorise IP addresses to connect to vCenter](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/autoriser_des_ip_a_se_connecter_au_vcenter) to grant access to the vSphere cluster to the new virtual machine. - -### Deploying the **Tanzu Kubernetes Grid** cluster on your infrastructure - -Log in to the `Ubuntu-22.04_TKGm-1.5.4_with_x` virtual machine, open a terminal, and run this command to create an **RSA** key: - -```bash -ssh-keygen -t rsa -b 4096 -C "youremail@yourdomain.com" -``` - -![03 Create TKG CLUSTER 01](images/03-create-tkg-cluster01.png){.thumbnail} - -Two files are created in the **~/.ssh** folder: - -- **id_rsa.pub** -- **id_rsa** - -Stay on the console and run this command: - -```bash -tanzu management-cluster create --ui --bind 192.168.0.199:8080 -``` - -> [!primary] -> -> When you run this command from the Linux console with the graphical interface, the web browser launches and connects to `https://192.168.0.199:8080`. If you have run this command from an **SSH** connection, you will need to connect to `https://192.168.0.199:8080` from a virtual machine on the same network with a graphical interface and an operational web browser. -> - -![03 Create TKG CLUSTER 02](images/03-create-tkg-cluster02.png){.thumbnail} - -Click `Deploy`{.action} below **VMware vSphere**. - -![03 Create TKG CLUSTER 03](images/03-create-tkg-cluster03.png){.thumbnail} - -Enter this information: - -- **VCENTER SERVER**: `VMware cluster FQDN` -- **USERNAME**: `VMware cluster user` -- **PASSWORD**: `VMware cluster user password` - -Then click `CONNECT`{.action}. - -![03 Create TKG CLUSTER 04](images/03-create-tkg-cluster04.png){.thumbnail} - -At the verification step of the **SSL Thumbprint**, click `CONTINUE`{.action}. - -![03 Create TKG CLUSTER 05](images/03-create-tkg-cluster05.png){.thumbnail} - -Click the cross in the top right to close the **vSphere 7.0.3 Environment Detected** window. - -![03 Create TKG CLUSTER 06](images/03-create-tkg-cluster06.png){.thumbnail} - -Paste the contents of the **~.ssh/id_rsa.pub** file into **SSH PUBLIC KEY** and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 07](images/03-create-tkg-cluster07.png){.thumbnail} - -Select `Production`{.action} on the right and select the `large etc...` **INSTANCE TYPE**. - -Enter these values: - -- **MANAGEMENT CLUSTER NAME (OPTIONAL)**: `tkgm-management-cluster`. -- **CONTROL PLANE ENDPOINT**: `192.168.0.10`. - -Click `NEXT`{.action} to proceed to the next step. - -![03 Create TKG CLUSTER 08](images/03-create-tkg-cluster08.png){.thumbnail} - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 09](images/03-create-tkg-cluster09.png){.thumbnail} - -In the **Metadata** option and then in the **LABELS (OPTIONAL)** section, type `tkgm` for the name and its value. - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 10](images/03-create-tkg-cluster10.png){.thumbnail} - -Enter these options: - -- **VM FOLDER**: `Storage folder for virtual machines`. -- **DATASTORE**: `Storage of virtual machines to be placed on a shared storage` . -- **CLUSTERS, HOSTS, AND RESOURCE POOLS**: `Cluster1`. - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 11](images/03-create-tkg-cluster11.png){.thumbnail} - -In **NETWORK NAME** select `VLAN10`{.action}. - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 12](images/03-create-tkg-cluster12.png){.thumbnail} - -Disable the `Activate Identity Management Settings`{.action} option and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 13](images/03-create-tkg-cluster13.png){.thumbnail} - -Select the OVA image integrated into the `photon-3-kube-v1.22.9+vmware.1` cluster from the **OS Image** menu and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 14](images/03-create-tkg-cluster14.png){.thumbnail} - -Uncheck `Participate in the Customer Experience Improvement Program`{.action} and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 15](images/03-create-tkg-cluster15.png){.thumbnail} - -Click `REVIEW CONFIGURATION`{.action}. - -![03 Create TKG CLUSTER 16](images/03-create-tkg-cluster16.png){.thumbnail} - -> [!primary] -> Take note of the name of the yaml file below **CLI Command Equivalent**, it will serve as a template for deploying a **WorkLoad** cluster. -> - -Scroll through the window and click `DEPLOY MANAGEMENT CLUSTER`{.action} - -![03 Create TKG CLUSTER 17](images/03-create-tkg-cluster17.png){.thumbnail} - -The **Tanzu Kubernetes Grid** cluster deployment is started, please wait for it to complete. - -> [!primary] -> The deployment will be completed when you see the **Management cluster created** and **Successfully installed all required plugins** messages in the window. -> -> ![03 Create TKG CLUSTER 18](images/03-create-tkg-cluster18.png){.thumbnail} -> -> Another indication that the installation is complete can be found in the console of the **Bootstrap** virtual machine in which will appear the **Management cluster created** and **You can now create your first workload cluster etc...** messages. - -> [!warning] -> -> Write down or copy the name of the **yaml** file in the `/home/tanzu/.config/tanzu/tkg/clusterconfigs` folder, it will be used to create a configuration file for installing a *WorkLoad cluster* -> - -![03 Create TKG CLUSTER 19](images/03-create-tkg-cluster19.png){.thumbnail} - -Go to the vCenter interface to see the seven virtual machines created. - -![04 VM CREATED ADFTER INSTALLATION 01](images/04-vm-created-after-installation01.png){.thumbnail} - -## Go further - -[Administrating a TKG cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) - -[Introducing VMware Tanzu Kubernetes Grid](https://tanzu.vmware.com/kubernetes-grid) - -[Documentation de VMware Tanzu Kubenetes Grid](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/guide.en-au.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/guide.en-au.md deleted file mode 100644 index 90ab406d72d..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/guide.en-au.md +++ /dev/null @@ -1,366 +0,0 @@ ---- -title: Installing Tanzu Kubernetes Grid -excerpt: Learn how to integrate Tanzu Kubernetes Grid into your VMware on OVHcloud infrastructure -updated: 2022-11-10 ---- - -## Objective - -**This guide documents how to install Tanzu Kubernetes Grid on your VMware on OVHcloud cluster** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Introduction - -VMware Tanzu Kubernetes Grid is a Kubernetes platform provided by **VMware** and maintained as part of the **VMware on OVHcloud** solution. - -You can install this product on your OVHcloud infrastructure to take advantage of its features and scalability. - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/en-au/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- A VLAN with internet access and a DHCP server -- You must have these resources: - - 8 GB of memory, 4 vCPUs, and 250 GB of storage for the management virtual machine named **Bootstrap**. - - 16 GB of memory, 4 vCPU, 40 GB of storage per Kubernetes node (it takes 6 nodes to install the management cluster in production mode and 6 nodes per **Workload** cluster in the same mode). - -## Instructions - -We will install **VMware Tanzu Kubernetes Grid** on a **VMware on OVHcloud** cluster and use VLAN 10 with these settings: - -- **LAN**: `192.168.0.0/24`. -- **DHCP Range**: `192.168.0.50 -> 192.168.0.100`. -- **Gateway**: `192.168.0.254`. - -> [!primary] -> This information is given as an example, it is quite possible to use another range and another VLAN. -> - -At the end of the installation, seven additional virtual machines will be on your VMware cluster, six for running the **TKG** management cluster and one for managing it. - -![00 admin cluster diagram](images/00-admin-cluster-diagram01.png){.thumbnail} - -### Importing OVA model for **Tanzu KUBERNETES Grid** into your infrastructure - -VMware provides a virtual machine as an OVA template, which contains all the elements to run a node of the **Tanzu Kubernetes Grid** cluster. This virtual machine is available in **OVH Templates**. - -Log in to the OVHcloud homepage for your VMware cluster, and click `OVH Templates`{.action} to the right. - -![01 integrate TKGM OVA 01](images/01-integrate-tkgm-ova01.png){.thumbnail} - -In the **Select a template** window, choose the fourth template from the top that has this information: - -- **Family**: Linux -- **Distribution**: not specified -- **Version**: 3 - -![01 integrate TKGM OVA 02](images/01-integrate-tkgm-ova02.png){.thumbnail} - -Click the `Copy`{.action} icon to the right to copy the URL which name must end in **photon-3-kube-v1.23.8+vmware.1.ovf**. Then click `Close`{.action}. - -![01 integrate TKGM OVA 03](images/01-integrate-tkgm-ova03.png){.thumbnail} - -Log in to your vSphere console, right-click your cluster and choose `Deploy an OVF Template`{.action}. - -![01 integrate TKGM OVA 03b](images/01-integrate-tkgm-ova03b.png){.thumbnail} - -Select `URL`{.action}, paste the previously copied URL and click `NEXT`{.action}. - -![01 integrate TKGM OVA 04](images/01-integrate-tkgm-ova04.png){.thumbnail} - -Leave the default location and click `NEXT`{.action}. - -![01 integrate TKGM OVA 05](images/01-integrate-tkgm-ova05.png){.thumbnail} - -Choose the cluster and click `NEXT`{.action}. - -![01 integrate TKGM OVA 06](images/01-integrate-tkgm-ova06.png){.thumbnail} - -Review your information and click `NEXT`{.action}. - -![01 integrate TKGM OVA 07](images/01-integrate-tkgm-ova07.png){.thumbnail} - -Check `I accept all licence agreements`{.action} and click `NEXT`{.action}. - -![01 integrate TKGM OVA 08](images/01-integrate-tkgm-ova08.png){.thumbnail} - -Select a shared storage in NFS v3, then click `NEXT`{.action}. - -![01 integrate TKGM OVA 09](images/01-integrate-tkgm-ova09.png){.thumbnail} - -Choose the destination network on `VLAN 10`{.action} and click `NEXT`{.action}. - -![01 integrate TKGM OVA 10](images/01-integrate-tkgm-ova10.png){.thumbnail} - -Click `FINISH`{.action}. - -![01 integrate TKGM OVA 11](images/01-integrate-tkgm-ova11.png){.thumbnail} - -Select the `Monitor`{.action} tab and click `Tasks`{.action}. - -![01 integrate TKGM OVA 12](images/01-integrate-tkgm-ova12.png){.thumbnail} - -Wait for the `Deploy OVF template` and `Import OVF package` tasks to complete. - -![01 integrate TKGM OVA 13](images/01-integrate-tkgm-ova13.png){.thumbnail} - -Right-click the deployed VM and choose `Convert to Template`{.action} from the `Template`{.action} menu. - -![01 integrate TKGM OVA 14](images/01-integrate-tkgm-ova14.png){.thumbnail} - -Answer `YES`{.action} to convert the virtual machine. - -![01 integrate TKGM OVA 15](images/01-integrate-tkgm-ova15.png){.thumbnail} - -Go to `Virtual Machines (and templates)`{.action} to see the template you have created. - -> [!primary] -> -> This template will be used when deploying **Tanzu Kubernetes Grid** clusters. It is used for the initial deployment of the administration cluster and for the installation of additional *WorkLoad* clusters. It should not be deleted from the **VMware** cluster. -> - -![01 integrate TKGM OVA 16](images/01-integrate-tkgm-ova16.png){.thumbnail} - -### Installation of the virtual machine **Bootstrap** provided by OVHcloud - -This virtual machine was created by OVHcloud from the documentation [Installing the CLI tool manually for deploying **Tanzu Kubernetes GRID**](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html). It is available as a template in **OVH Templates**. - -Log in to the OVHcloud homepage for your VMware cluster, and click `OVH Templates`{.action} to the right. - -![02 Add Bootstrapvm 01](images/02-add-bootstrap-vm-from-ova01.png){.thumbnail} - -In the **Select a template** window, choose the third template from the top that contains this information: - -- **Family**: Linux -- **Distribution**: Ubuntu -- **Version**: 22 - -![02 Add Bootstrapvm 02](images/02-add-bootstrap-vm-from-ova02.png){.thumbnail} - -Click the `Copy`{.action} icon to the right to copy the URL, the URL should end with **Ubuntu-22.04_TKGm-1.6_with_x.ovf**. Then click `Close`{.action}. - -![02 Add Bootstrapvm 03](images/02-add-bootstrap-vm-from-ova03.png){.thumbnail} - -In the vSphere interface, right-click the cluster and choose `Deploy an OVF Template`{.action} from the menu. - -![02 Add Bootstrapvm 03b](images/02-add-bootstrap-vm-from-ova03b.png){.thumbnail} - -Select `URL`{.action}, paste the previously copied URL and click `NEXT`{.action}. - -![02 Add Bootstrapvm 04](images/02-add-bootstrap-vm-from-ova04.png){.thumbnail} - -Leave the default positioning and click `NEXT`{.action}. - -![02 Add Bootstrapvm 05](images/02-add-bootstrap-vm-from-ova05.png){.thumbnail} - -Leave `Cluster1` and click `NEXT`{.action}. - -![02 Add Bootstrapvm 06](images/02-add-bootstrap-vm-from-ova06.png){.thumbnail} - -Click `NEXT`{.action} to validate your choices. - -![02 Add Bootstrapvm 07](images/02-add-bootstrap-vm-from-ova07.png){.thumbnail} - -Select a shared storage in NFS v3 and click `NEXT`{.action}. - -![02 Add Bootstrapvm 08](images/02-add-bootstrap-vm-from-ova08.png){.thumbnail} - -Choose `VLAN10` for the destination network and click `NEXT`{.action}. - -![02 Add Bootstrapvm 09](images/02-add-bootstrap-vm-from-ova09.png){.thumbnail} - -Add this information in **Networking**: - -- **Hostname**: `bootstrap` -- **IP Address**: `192.168.0.199` -- **Network CIDR Prefix**: `24` -- **Gateway**: `192.168.0.254` -- **DNS**: `213.186.33.99` - -> [!primary] -> -> The DNS server chosen in this guide is the OVHcloud server. -> - -Enter and confirm the password in **OS Credentials** and click `NEXT`{.action}. - -![02 Add Bootstrapvm 10](images/02-add-bootstrap-vm-from-ova10.png){.thumbnail} - -Click `FINISH`{.action}. - -![02 Add Bootstrapvm 11](images/02-add-bootstrap-vm-from-ova11.png){.thumbnail} - -Right-click the virtual machine you created, go to `Power`{.action} and click `Power On`{.action}. - -![02 Add Bootstrapvm 12](images/02-add-bootstrap-vm-from-ova12.png){.thumbnail} - -The booted virtual machine can be accessed via the console with the graphical interface or via **SSH**. - -Go to the virtual machine you have created, and click `LAUNCH WEB CONSOLE`{.action}. - -![02 Add Bootstrapvm 13](images/02-add-bootstrap-vm-from-ova13.png){.thumbnail} - -The graphical interface for the Linux virtual machine is then available. - -![02 Add Bootstrapvm 14](images/02-add-bootstrap-vm-from-ova14.png){.thumbnail} - -### Allowing access to the PCC cluster from the **Bootstrap** virtual machine - -The configuration and administration tools for **Tanzu Kubernetes Grid** are installed on the **Bootstrap** virtual machine. This virtual machine must be able to connect to the Internet and to the vSphere cluster. - -Write down **the public IP address** you use on this virtual machine and use this guide [Authorise IP addresses to connect to vCenter](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/autoriser_des_ip_a_se_connecter_au_vcenter) to grant access to the vSphere cluster to the new virtual machine. - -### Deploying the **Tanzu Kubernetes Grid** cluster on your infrastructure - -Log in to the `Ubuntu-22.04_TKGm-1.5.4_with_x` virtual machine, open a terminal, and run this command to create an **RSA** key: - -```bash -ssh-keygen -t rsa -b 4096 -C "youremail@yourdomain.com" -``` - -![03 Create TKG CLUSTER 01](images/03-create-tkg-cluster01.png){.thumbnail} - -Two files are created in the **~/.ssh** folder: - -- **id_rsa.pub** -- **id_rsa** - -Stay on the console and run this command: - -```bash -tanzu management-cluster create --ui --bind 192.168.0.199:8080 -``` - -> [!primary] -> -> When you run this command from the Linux console with the graphical interface, the web browser launches and connects to `https://192.168.0.199:8080`. If you have run this command from an **SSH** connection, you will need to connect to `https://192.168.0.199:8080` from a virtual machine on the same network with a graphical interface and an operational web browser. -> - -![03 Create TKG CLUSTER 02](images/03-create-tkg-cluster02.png){.thumbnail} - -Click `Deploy`{.action} below **VMware vSphere**. - -![03 Create TKG CLUSTER 03](images/03-create-tkg-cluster03.png){.thumbnail} - -Enter this information: - -- **VCENTER SERVER**: `VMware cluster FQDN` -- **USERNAME**: `VMware cluster user` -- **PASSWORD**: `VMware cluster user password` - -Then click `CONNECT`{.action}. - -![03 Create TKG CLUSTER 04](images/03-create-tkg-cluster04.png){.thumbnail} - -At the verification step of the **SSL Thumbprint**, click `CONTINUE`{.action}. - -![03 Create TKG CLUSTER 05](images/03-create-tkg-cluster05.png){.thumbnail} - -Click the cross in the top right to close the **vSphere 7.0.3 Environment Detected** window. - -![03 Create TKG CLUSTER 06](images/03-create-tkg-cluster06.png){.thumbnail} - -Paste the contents of the **~.ssh/id_rsa.pub** file into **SSH PUBLIC KEY** and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 07](images/03-create-tkg-cluster07.png){.thumbnail} - -Select `Production`{.action} on the right and select the `large etc...` **INSTANCE TYPE**. - -Enter these values: - -- **MANAGEMENT CLUSTER NAME (OPTIONAL)**: `tkgm-management-cluster`. -- **CONTROL PLANE ENDPOINT**: `192.168.0.10`. - -Click `NEXT`{.action} to proceed to the next step. - -![03 Create TKG CLUSTER 08](images/03-create-tkg-cluster08.png){.thumbnail} - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 09](images/03-create-tkg-cluster09.png){.thumbnail} - -In the **Metadata** option and then in the **LABELS (OPTIONAL)** section, type `tkgm` for the name and its value. - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 10](images/03-create-tkg-cluster10.png){.thumbnail} - -Enter these options: - -- **VM FOLDER**: `Storage folder for virtual machines`. -- **DATASTORE**: `Storage of virtual machines to be placed on a shared storage` . -- **CLUSTERS, HOSTS, AND RESOURCE POOLS**: `Cluster1`. - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 11](images/03-create-tkg-cluster11.png){.thumbnail} - -In **NETWORK NAME** select `VLAN10`{.action}. - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 12](images/03-create-tkg-cluster12.png){.thumbnail} - -Disable the `Activate Identity Management Settings`{.action} option and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 13](images/03-create-tkg-cluster13.png){.thumbnail} - -Select the OVA image integrated into the `photon-3-kube-v1.22.9+vmware.1` cluster from the **OS Image** menu and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 14](images/03-create-tkg-cluster14.png){.thumbnail} - -Uncheck `Participate in the Customer Experience Improvement Program`{.action} and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 15](images/03-create-tkg-cluster15.png){.thumbnail} - -Click `REVIEW CONFIGURATION`{.action}. - -![03 Create TKG CLUSTER 16](images/03-create-tkg-cluster16.png){.thumbnail} - -> [!primary] -> Take note of the name of the yaml file below **CLI Command Equivalent**, it will serve as a template for deploying a **WorkLoad** cluster. -> - -Scroll through the window and click `DEPLOY MANAGEMENT CLUSTER`{.action} - -![03 Create TKG CLUSTER 17](images/03-create-tkg-cluster17.png){.thumbnail} - -The **Tanzu Kubernetes Grid** cluster deployment is started, please wait for it to complete. - -> [!primary] -> The deployment will be completed when you see the **Management cluster created** and **Successfully installed all required plugins** messages in the window. -> -> ![03 Create TKG CLUSTER 18](images/03-create-tkg-cluster18.png){.thumbnail} -> -> Another indication that the installation is complete can be found in the console of the **Bootstrap** virtual machine in which will appear the **Management cluster created** and **You can now create your first workload cluster etc...** messages. - -> [!warning] -> -> Write down or copy the name of the **yaml** file in the `/home/tanzu/.config/tanzu/tkg/clusterconfigs` folder, it will be used to create a configuration file for installing a *WorkLoad cluster* -> - -![03 Create TKG CLUSTER 19](images/03-create-tkg-cluster19.png){.thumbnail} - -Go to the vCenter interface to see the seven virtual machines created. - -![04 VM CREATED ADFTER INSTALLATION 01](images/04-vm-created-after-installation01.png){.thumbnail} - -## Go further - -[Administrating a TKG cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) - -[Introducing VMware Tanzu Kubernetes Grid](https://tanzu.vmware.com/kubernetes-grid) - -[Documentation de VMware Tanzu Kubenetes Grid](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/guide.en-ca.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/guide.en-ca.md deleted file mode 100644 index 12c69953b18..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/guide.en-ca.md +++ /dev/null @@ -1,366 +0,0 @@ ---- -title: Installing Tanzu Kubernetes Grid -excerpt: Learn how to integrate Tanzu Kubernetes Grid into your VMware on OVHcloud infrastructure -updated: 2022-11-10 ---- - -## Objective - -**This guide documents how to install Tanzu Kubernetes Grid on your VMware on OVHcloud cluster** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Introduction - -VMware Tanzu Kubernetes Grid is a Kubernetes platform provided by **VMware** and maintained as part of the **VMware on OVHcloud** solution. - -You can install this product on your OVHcloud infrastructure to take advantage of its features and scalability. - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/en-ca/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- A VLAN with internet access and a DHCP server -- You must have these resources: - - 8 GB of memory, 4 vCPUs, and 250 GB of storage for the management virtual machine named **Bootstrap**. - - 16 GB of memory, 4 vCPU, 40 GB of storage per Kubernetes node (it takes 6 nodes to install the management cluster in production mode and 6 nodes per **Workload** cluster in the same mode). - -## Instructions - -We will install **VMware Tanzu Kubernetes Grid** on a **VMware on OVHcloud** cluster and use VLAN 10 with these settings: - -- **LAN**: `192.168.0.0/24`. -- **DHCP Range**: `192.168.0.50 -> 192.168.0.100`. -- **Gateway**: `192.168.0.254`. - -> [!primary] -> This information is given as an example, it is quite possible to use another range and another VLAN. -> - -At the end of the installation, seven additional virtual machines will be on your VMware cluster, six for running the **TKG** management cluster and one for managing it. - -![00 admin cluster diagram](images/00-admin-cluster-diagram01.png){.thumbnail} - -### Importing OVA model for **Tanzu KUBERNETES Grid** into your infrastructure - -VMware provides a virtual machine as an OVA template, which contains all the elements to run a node of the **Tanzu Kubernetes Grid** cluster. This virtual machine is available in **OVH Templates**. - -Log in to the OVHcloud homepage for your VMware cluster, and click `OVH Templates`{.action} to the right. - -![01 integrate TKGM OVA 01](images/01-integrate-tkgm-ova01.png){.thumbnail} - -In the **Select a template** window, choose the fourth template from the top that has this information: - -- **Family**: Linux -- **Distribution**: not specified -- **Version**: 3 - -![01 integrate TKGM OVA 02](images/01-integrate-tkgm-ova02.png){.thumbnail} - -Click the `Copy`{.action} icon to the right to copy the URL which name must end in **photon-3-kube-v1.23.8+vmware.1.ovf**. Then click `Close`{.action}. - -![01 integrate TKGM OVA 03](images/01-integrate-tkgm-ova03.png){.thumbnail} - -Log in to your vSphere console, right-click your cluster and choose `Deploy an OVF Template`{.action}. - -![01 integrate TKGM OVA 03b](images/01-integrate-tkgm-ova03b.png){.thumbnail} - -Select `URL`{.action}, paste the previously copied URL and click `NEXT`{.action}. - -![01 integrate TKGM OVA 04](images/01-integrate-tkgm-ova04.png){.thumbnail} - -Leave the default location and click `NEXT`{.action}. - -![01 integrate TKGM OVA 05](images/01-integrate-tkgm-ova05.png){.thumbnail} - -Choose the cluster and click `NEXT`{.action}. - -![01 integrate TKGM OVA 06](images/01-integrate-tkgm-ova06.png){.thumbnail} - -Review your information and click `NEXT`{.action}. - -![01 integrate TKGM OVA 07](images/01-integrate-tkgm-ova07.png){.thumbnail} - -Check `I accept all licence agreements`{.action} and click `NEXT`{.action}. - -![01 integrate TKGM OVA 08](images/01-integrate-tkgm-ova08.png){.thumbnail} - -Select a shared storage in NFS v3, then click `NEXT`{.action}. - -![01 integrate TKGM OVA 09](images/01-integrate-tkgm-ova09.png){.thumbnail} - -Choose the destination network on `VLAN 10`{.action} and click `NEXT`{.action}. - -![01 integrate TKGM OVA 10](images/01-integrate-tkgm-ova10.png){.thumbnail} - -Click `FINISH`{.action}. - -![01 integrate TKGM OVA 11](images/01-integrate-tkgm-ova11.png){.thumbnail} - -Select the `Monitor`{.action} tab and click `Tasks`{.action}. - -![01 integrate TKGM OVA 12](images/01-integrate-tkgm-ova12.png){.thumbnail} - -Wait for the `Deploy OVF template` and `Import OVF package` tasks to complete. - -![01 integrate TKGM OVA 13](images/01-integrate-tkgm-ova13.png){.thumbnail} - -Right-click the deployed VM and choose `Convert to Template`{.action} from the `Template`{.action} menu. - -![01 integrate TKGM OVA 14](images/01-integrate-tkgm-ova14.png){.thumbnail} - -Answer `YES`{.action} to convert the virtual machine. - -![01 integrate TKGM OVA 15](images/01-integrate-tkgm-ova15.png){.thumbnail} - -Go to `Virtual Machines (and templates)`{.action} to see the template you have created. - -> [!primary] -> -> This template will be used when deploying **Tanzu Kubernetes Grid** clusters. It is used for the initial deployment of the administration cluster and for the installation of additional *WorkLoad* clusters. It should not be deleted from the **VMware** cluster. -> - -![01 integrate TKGM OVA 16](images/01-integrate-tkgm-ova16.png){.thumbnail} - -### Installation of the virtual machine **Bootstrap** provided by OVHcloud - -This virtual machine was created by OVHcloud from the documentation [Installing the CLI tool manually for deploying **Tanzu Kubernetes GRID**](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html). It is available as a template in **OVH Templates**. - -Log in to the OVHcloud homepage for your VMware cluster, and click `OVH Templates`{.action} to the right. - -![02 Add Bootstrapvm 01](images/02-add-bootstrap-vm-from-ova01.png){.thumbnail} - -In the **Select a template** window, choose the third template from the top that contains this information: - -- **Family**: Linux -- **Distribution**: Ubuntu -- **Version**: 22 - -![02 Add Bootstrapvm 02](images/02-add-bootstrap-vm-from-ova02.png){.thumbnail} - -Click the `Copy`{.action} icon to the right to copy the URL, the URL should end with **Ubuntu-22.04_TKGm-1.6_with_x.ovf**. Then click `Close`{.action}. - -![02 Add Bootstrapvm 03](images/02-add-bootstrap-vm-from-ova03.png){.thumbnail} - -In the vSphere interface, right-click the cluster and choose `Deploy an OVF Template`{.action} from the menu. - -![02 Add Bootstrapvm 03b](images/02-add-bootstrap-vm-from-ova03b.png){.thumbnail} - -Select `URL`{.action}, paste the previously copied URL and click `NEXT`{.action}. - -![02 Add Bootstrapvm 04](images/02-add-bootstrap-vm-from-ova04.png){.thumbnail} - -Leave the default positioning and click `NEXT`{.action}. - -![02 Add Bootstrapvm 05](images/02-add-bootstrap-vm-from-ova05.png){.thumbnail} - -Leave `Cluster1` and click `NEXT`{.action}. - -![02 Add Bootstrapvm 06](images/02-add-bootstrap-vm-from-ova06.png){.thumbnail} - -Click `NEXT`{.action} to validate your choices. - -![02 Add Bootstrapvm 07](images/02-add-bootstrap-vm-from-ova07.png){.thumbnail} - -Select a shared storage in NFS v3 and click `NEXT`{.action}. - -![02 Add Bootstrapvm 08](images/02-add-bootstrap-vm-from-ova08.png){.thumbnail} - -Choose `VLAN10` for the destination network and click `NEXT`{.action}. - -![02 Add Bootstrapvm 09](images/02-add-bootstrap-vm-from-ova09.png){.thumbnail} - -Add this information in **Networking**: - -- **Hostname**: `bootstrap` -- **IP Address**: `192.168.0.199` -- **Network CIDR Prefix**: `24` -- **Gateway**: `192.168.0.254` -- **DNS**: `213.186.33.99` - -> [!primary] -> -> The DNS server chosen in this guide is the OVHcloud server. -> - -Enter and confirm the password in **OS Credentials** and click `NEXT`{.action}. - -![02 Add Bootstrapvm 10](images/02-add-bootstrap-vm-from-ova10.png){.thumbnail} - -Click `FINISH`{.action}. - -![02 Add Bootstrapvm 11](images/02-add-bootstrap-vm-from-ova11.png){.thumbnail} - -Right-click the virtual machine you created, go to `Power`{.action} and click `Power On`{.action}. - -![02 Add Bootstrapvm 12](images/02-add-bootstrap-vm-from-ova12.png){.thumbnail} - -The booted virtual machine can be accessed via the console with the graphical interface or via **SSH**. - -Go to the virtual machine you have created, and click `LAUNCH WEB CONSOLE`{.action}. - -![02 Add Bootstrapvm 13](images/02-add-bootstrap-vm-from-ova13.png){.thumbnail} - -The graphical interface for the Linux virtual machine is then available. - -![02 Add Bootstrapvm 14](images/02-add-bootstrap-vm-from-ova14.png){.thumbnail} - -### Allowing access to the PCC cluster from the **Bootstrap** virtual machine - -The configuration and administration tools for **Tanzu Kubernetes Grid** are installed on the **Bootstrap** virtual machine. This virtual machine must be able to connect to the Internet and to the vSphere cluster. - -Write down **the public IP address** you use on this virtual machine and use this guide [Authorise IP addresses to connect to vCenter](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/autoriser_des_ip_a_se_connecter_au_vcenter) to grant access to the vSphere cluster to the new virtual machine. - -### Deploying the **Tanzu Kubernetes Grid** cluster on your infrastructure - -Log in to the `Ubuntu-22.04_TKGm-1.5.4_with_x` virtual machine, open a terminal, and run this command to create an **RSA** key: - -```bash -ssh-keygen -t rsa -b 4096 -C "youremail@yourdomain.com" -``` - -![03 Create TKG CLUSTER 01](images/03-create-tkg-cluster01.png){.thumbnail} - -Two files are created in the **~/.ssh** folder: - -- **id_rsa.pub** -- **id_rsa** - -Stay on the console and run this command: - -```bash -tanzu management-cluster create --ui --bind 192.168.0.199:8080 -``` - -> [!primary] -> -> When you run this command from the Linux console with the graphical interface, the web browser launches and connects to `https://192.168.0.199:8080`. If you have run this command from an **SSH** connection, you will need to connect to `https://192.168.0.199:8080` from a virtual machine on the same network with a graphical interface and an operational web browser. -> - -![03 Create TKG CLUSTER 02](images/03-create-tkg-cluster02.png){.thumbnail} - -Click `Deploy`{.action} below **VMware vSphere**. - -![03 Create TKG CLUSTER 03](images/03-create-tkg-cluster03.png){.thumbnail} - -Enter this information: - -- **VCENTER SERVER**: `VMware cluster FQDN` -- **USERNAME**: `VMware cluster user` -- **PASSWORD**: `VMware cluster user password` - -Then click `CONNECT`{.action}. - -![03 Create TKG CLUSTER 04](images/03-create-tkg-cluster04.png){.thumbnail} - -At the verification step of the **SSL Thumbprint**, click `CONTINUE`{.action}. - -![03 Create TKG CLUSTER 05](images/03-create-tkg-cluster05.png){.thumbnail} - -Click the cross in the top right to close the **vSphere 7.0.3 Environment Detected** window. - -![03 Create TKG CLUSTER 06](images/03-create-tkg-cluster06.png){.thumbnail} - -Paste the contents of the **~.ssh/id_rsa.pub** file into **SSH PUBLIC KEY** and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 07](images/03-create-tkg-cluster07.png){.thumbnail} - -Select `Production`{.action} on the right and select the `large etc...` **INSTANCE TYPE**. - -Enter these values: - -- **MANAGEMENT CLUSTER NAME (OPTIONAL)**: `tkgm-management-cluster`. -- **CONTROL PLANE ENDPOINT**: `192.168.0.10`. - -Click `NEXT`{.action} to proceed to the next step. - -![03 Create TKG CLUSTER 08](images/03-create-tkg-cluster08.png){.thumbnail} - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 09](images/03-create-tkg-cluster09.png){.thumbnail} - -In the **Metadata** option and then in the **LABELS (OPTIONAL)** section, type `tkgm` for the name and its value. - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 10](images/03-create-tkg-cluster10.png){.thumbnail} - -Enter these options: - -- **VM FOLDER**: `Storage folder for virtual machines`. -- **DATASTORE**: `Storage of virtual machines to be placed on a shared storage` . -- **CLUSTERS, HOSTS, AND RESOURCE POOLS**: `Cluster1`. - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 11](images/03-create-tkg-cluster11.png){.thumbnail} - -In **NETWORK NAME** select `VLAN10`{.action}. - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 12](images/03-create-tkg-cluster12.png){.thumbnail} - -Disable the `Activate Identity Management Settings`{.action} option and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 13](images/03-create-tkg-cluster13.png){.thumbnail} - -Select the OVA image integrated into the `photon-3-kube-v1.22.9+vmware.1` cluster from the **OS Image** menu and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 14](images/03-create-tkg-cluster14.png){.thumbnail} - -Uncheck `Participate in the Customer Experience Improvement Program`{.action} and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 15](images/03-create-tkg-cluster15.png){.thumbnail} - -Click `REVIEW CONFIGURATION`{.action}. - -![03 Create TKG CLUSTER 16](images/03-create-tkg-cluster16.png){.thumbnail} - -> [!primary] -> Take note of the name of the yaml file below **CLI Command Equivalent**, it will serve as a template for deploying a **WorkLoad** cluster. -> - -Scroll through the window and click `DEPLOY MANAGEMENT CLUSTER`{.action} - -![03 Create TKG CLUSTER 17](images/03-create-tkg-cluster17.png){.thumbnail} - -The **Tanzu Kubernetes Grid** cluster deployment is started, please wait for it to complete. - -> [!primary] -> The deployment will be completed when you see the **Management cluster created** and **Successfully installed all required plugins** messages in the window. -> -> ![03 Create TKG CLUSTER 18](images/03-create-tkg-cluster18.png){.thumbnail} -> -> Another indication that the installation is complete can be found in the console of the **Bootstrap** virtual machine in which will appear the **Management cluster created** and **You can now create your first workload cluster etc...** messages. - -> [!warning] -> -> Write down or copy the name of the **yaml** file in the `/home/tanzu/.config/tanzu/tkg/clusterconfigs` folder, it will be used to create a configuration file for installing a *WorkLoad cluster* -> - -![03 Create TKG CLUSTER 19](images/03-create-tkg-cluster19.png){.thumbnail} - -Go to the vCenter interface to see the seven virtual machines created. - -![04 VM CREATED ADFTER INSTALLATION 01](images/04-vm-created-after-installation01.png){.thumbnail} - -## Go further - -[Administrating a TKG cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) - -[Introducing VMware Tanzu Kubernetes Grid](https://tanzu.vmware.com/kubernetes-grid) - -[Documentation de VMware Tanzu Kubenetes Grid](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/guide.en-gb.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/guide.en-gb.md deleted file mode 100644 index 8cc4e33092f..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/guide.en-gb.md +++ /dev/null @@ -1,366 +0,0 @@ ---- -title: Installing Tanzu Kubernetes Grid -excerpt: Learn how to integrate Tanzu Kubernetes Grid into your VMware on OVHcloud infrastructure -updated: 2022-11-10 ---- - -## Objective - -**This guide documents how to install Tanzu Kubernetes Grid on your VMware on OVHcloud cluster** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Introduction - -VMware Tanzu Kubernetes Grid is a Kubernetes platform provided by **VMware** and maintained as part of the **VMware on OVHcloud** solution. - -You can install this product on your OVHcloud infrastructure to take advantage of its features and scalability. - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/en-gb/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- A VLAN with internet access and a DHCP server -- You must have these resources: - - 8 GB of memory, 4 vCPUs, and 250 GB of storage for the management virtual machine named **Bootstrap**. - - 16 GB of memory, 4 vCPU, 40 GB of storage per Kubernetes node (it takes 6 nodes to install the management cluster in production mode and 6 nodes per **Workload** cluster in the same mode). - -## Instructions - -We will install **VMware Tanzu Kubernetes Grid** on a **VMware on OVHcloud** cluster and use VLAN 10 with these settings: - -- **LAN**: `192.168.0.0/24`. -- **DHCP Range**: `192.168.0.50 -> 192.168.0.100`. -- **Gateway**: `192.168.0.254`. - -> [!primary] -> This information is given as an example, it is quite possible to use another range and another VLAN. -> - -At the end of the installation, seven additional virtual machines will be on your VMware cluster, six for running the **TKG** management cluster and one for managing it. - -![00 admin cluster diagram](images/00-admin-cluster-diagram01.png){.thumbnail} - -### Importing OVA model for **Tanzu KUBERNETES Grid** into your infrastructure - -VMware provides a virtual machine as an OVA template, which contains all the elements to run a node of the **Tanzu Kubernetes Grid** cluster. This virtual machine is available in **OVH Templates**. - -Log in to the OVHcloud homepage for your VMware cluster, and click `OVH Templates`{.action} to the right. - -![01 integrate TKGM OVA 01](images/01-integrate-tkgm-ova01.png){.thumbnail} - -In the **Select a template** window, choose the fourth template from the top that has this information: - -- **Family**: Linux -- **Distribution**: not specified -- **Version**: 3 - -![01 integrate TKGM OVA 02](images/01-integrate-tkgm-ova02.png){.thumbnail} - -Click the `Copy`{.action} icon to the right to copy the URL which name must end in **photon-3-kube-v1.23.8+vmware.1.ovf**. Then click `Close`{.action}. - -![01 integrate TKGM OVA 03](images/01-integrate-tkgm-ova03.png){.thumbnail} - -Log in to your vSphere console, right-click your cluster and choose `Deploy an OVF Template`{.action}. - -![01 integrate TKGM OVA 03b](images/01-integrate-tkgm-ova03b.png){.thumbnail} - -Select `URL`{.action}, paste the previously copied URL and click `NEXT`{.action}. - -![01 integrate TKGM OVA 04](images/01-integrate-tkgm-ova04.png){.thumbnail} - -Leave the default location and click `NEXT`{.action}. - -![01 integrate TKGM OVA 05](images/01-integrate-tkgm-ova05.png){.thumbnail} - -Choose the cluster and click `NEXT`{.action}. - -![01 integrate TKGM OVA 06](images/01-integrate-tkgm-ova06.png){.thumbnail} - -Review your information and click `NEXT`{.action}. - -![01 integrate TKGM OVA 07](images/01-integrate-tkgm-ova07.png){.thumbnail} - -Check `I accept all licence agreements`{.action} and click `NEXT`{.action}. - -![01 integrate TKGM OVA 08](images/01-integrate-tkgm-ova08.png){.thumbnail} - -Select a shared storage in NFS v3, then click `NEXT`{.action}. - -![01 integrate TKGM OVA 09](images/01-integrate-tkgm-ova09.png){.thumbnail} - -Choose the destination network on `VLAN 10`{.action} and click `NEXT`{.action}. - -![01 integrate TKGM OVA 10](images/01-integrate-tkgm-ova10.png){.thumbnail} - -Click `FINISH`{.action}. - -![01 integrate TKGM OVA 11](images/01-integrate-tkgm-ova11.png){.thumbnail} - -Select the `Monitor`{.action} tab and click `Tasks`{.action}. - -![01 integrate TKGM OVA 12](images/01-integrate-tkgm-ova12.png){.thumbnail} - -Wait for the `Deploy OVF template` and `Import OVF package` tasks to complete. - -![01 integrate TKGM OVA 13](images/01-integrate-tkgm-ova13.png){.thumbnail} - -Right-click the deployed VM and choose `Convert to Template`{.action} from the `Template`{.action} menu. - -![01 integrate TKGM OVA 14](images/01-integrate-tkgm-ova14.png){.thumbnail} - -Answer `YES`{.action} to convert the virtual machine. - -![01 integrate TKGM OVA 15](images/01-integrate-tkgm-ova15.png){.thumbnail} - -Go to `Virtual Machines (and templates)`{.action} to see the template you have created. - -> [!primary] -> -> This template will be used when deploying **Tanzu Kubernetes Grid** clusters. It is used for the initial deployment of the administration cluster and for the installation of additional *WorkLoad* clusters. It should not be deleted from the **VMware** cluster. -> - -![01 integrate TKGM OVA 16](images/01-integrate-tkgm-ova16.png){.thumbnail} - -### Installation of the virtual machine **Bootstrap** provided by OVHcloud - -This virtual machine was created by OVHcloud from the documentation [Installing the CLI tool manually for deploying **Tanzu Kubernetes GRID**](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html). It is available as a template in **OVH Templates**. - -Log in to the OVHcloud homepage for your VMware cluster, and click `OVH Templates`{.action} to the right. - -![02 Add Bootstrapvm 01](images/02-add-bootstrap-vm-from-ova01.png){.thumbnail} - -In the **Select a template** window, choose the third template from the top that contains this information: - -- **Family**: Linux -- **Distribution**: Ubuntu -- **Version**: 22 - -![02 Add Bootstrapvm 02](images/02-add-bootstrap-vm-from-ova02.png){.thumbnail} - -Click the `Copy`{.action} icon to the right to copy the URL, the URL should end with **Ubuntu-22.04_TKGm-1.6_with_x.ovf**. Then click `Close`{.action}. - -![02 Add Bootstrapvm 03](images/02-add-bootstrap-vm-from-ova03.png){.thumbnail} - -In the vSphere interface, right-click the cluster and choose `Deploy an OVF Template`{.action} from the menu. - -![02 Add Bootstrapvm 03b](images/02-add-bootstrap-vm-from-ova03b.png){.thumbnail} - -Select `URL`{.action}, paste the previously copied URL and click `NEXT`{.action}. - -![02 Add Bootstrapvm 04](images/02-add-bootstrap-vm-from-ova04.png){.thumbnail} - -Leave the default positioning and click `NEXT`{.action}. - -![02 Add Bootstrapvm 05](images/02-add-bootstrap-vm-from-ova05.png){.thumbnail} - -Leave `Cluster1` and click `NEXT`{.action}. - -![02 Add Bootstrapvm 06](images/02-add-bootstrap-vm-from-ova06.png){.thumbnail} - -Click `NEXT`{.action} to validate your choices. - -![02 Add Bootstrapvm 07](images/02-add-bootstrap-vm-from-ova07.png){.thumbnail} - -Select a shared storage in NFS v3 and click `NEXT`{.action}. - -![02 Add Bootstrapvm 08](images/02-add-bootstrap-vm-from-ova08.png){.thumbnail} - -Choose `VLAN10` for the destination network and click `NEXT`{.action}. - -![02 Add Bootstrapvm 09](images/02-add-bootstrap-vm-from-ova09.png){.thumbnail} - -Add this information in **Networking**: - -- **Hostname**: `bootstrap` -- **IP Address**: `192.168.0.199` -- **Network CIDR Prefix**: `24` -- **Gateway**: `192.168.0.254` -- **DNS**: `213.186.33.99` - -> [!primary] -> -> The DNS server chosen in this guide is the OVHcloud server. -> - -Enter and confirm the password in **OS Credentials** and click `NEXT`{.action}. - -![02 Add Bootstrapvm 10](images/02-add-bootstrap-vm-from-ova10.png){.thumbnail} - -Click `FINISH`{.action}. - -![02 Add Bootstrapvm 11](images/02-add-bootstrap-vm-from-ova11.png){.thumbnail} - -Right-click the virtual machine you created, go to `Power`{.action} and click `Power On`{.action}. - -![02 Add Bootstrapvm 12](images/02-add-bootstrap-vm-from-ova12.png){.thumbnail} - -The booted virtual machine can be accessed via the console with the graphical interface or via **SSH**. - -Go to the virtual machine you have created, and click `LAUNCH WEB CONSOLE`{.action}. - -![02 Add Bootstrapvm 13](images/02-add-bootstrap-vm-from-ova13.png){.thumbnail} - -The graphical interface for the Linux virtual machine is then available. - -![02 Add Bootstrapvm 14](images/02-add-bootstrap-vm-from-ova14.png){.thumbnail} - -### Allowing access to the PCC cluster from the **Bootstrap** virtual machine - -The configuration and administration tools for **Tanzu Kubernetes Grid** are installed on the **Bootstrap** virtual machine. This virtual machine must be able to connect to the Internet and to the vSphere cluster. - -Write down **the public IP address** you use on this virtual machine and use this guide [Authorise IP addresses to connect to vCenter](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/autoriser_des_ip_a_se_connecter_au_vcenter) to grant access to the vSphere cluster to the new virtual machine. - -### Deploying the **Tanzu Kubernetes Grid** cluster on your infrastructure - -Log in to the `Ubuntu-22.04_TKGm-1.5.4_with_x` virtual machine, open a terminal, and run this command to create an **RSA** key: - -```bash -ssh-keygen -t rsa -b 4096 -C "youremail@yourdomain.com" -``` - -![03 Create TKG CLUSTER 01](images/03-create-tkg-cluster01.png){.thumbnail} - -Two files are created in the **~/.ssh** folder: - -- **id_rsa.pub** -- **id_rsa** - -Stay on the console and run this command: - -```bash -tanzu management-cluster create --ui --bind 192.168.0.199:8080 -``` - -> [!primary] -> -> When you run this command from the Linux console with the graphical interface, the web browser launches and connects to `https://192.168.0.199:8080`. If you have run this command from an **SSH** connection, you will need to connect to `https://192.168.0.199:8080` from a virtual machine on the same network with a graphical interface and an operational web browser. -> - -![03 Create TKG CLUSTER 02](images/03-create-tkg-cluster02.png){.thumbnail} - -Click `Deploy`{.action} below **VMware vSphere**. - -![03 Create TKG CLUSTER 03](images/03-create-tkg-cluster03.png){.thumbnail} - -Enter this information: - -- **VCENTER SERVER**: `VMware cluster FQDN` -- **USERNAME**: `VMware cluster user` -- **PASSWORD**: `VMware cluster user password` - -Then click `CONNECT`{.action}. - -![03 Create TKG CLUSTER 04](images/03-create-tkg-cluster04.png){.thumbnail} - -At the verification step of the **SSL Thumbprint**, click `CONTINUE`{.action}. - -![03 Create TKG CLUSTER 05](images/03-create-tkg-cluster05.png){.thumbnail} - -Click the cross in the top right to close the **vSphere 7.0.3 Environment Detected** window. - -![03 Create TKG CLUSTER 06](images/03-create-tkg-cluster06.png){.thumbnail} - -Paste the contents of the **~.ssh/id_rsa.pub** file into **SSH PUBLIC KEY** and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 07](images/03-create-tkg-cluster07.png){.thumbnail} - -Select `Production`{.action} on the right and select the `large etc...` **INSTANCE TYPE**. - -Enter these values: - -- **MANAGEMENT CLUSTER NAME (OPTIONAL)**: `tkgm-management-cluster`. -- **CONTROL PLANE ENDPOINT**: `192.168.0.10`. - -Click `NEXT`{.action} to proceed to the next step. - -![03 Create TKG CLUSTER 08](images/03-create-tkg-cluster08.png){.thumbnail} - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 09](images/03-create-tkg-cluster09.png){.thumbnail} - -In the **Metadata** option and then in the **LABELS (OPTIONAL)** section, type `tkgm` for the name and its value. - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 10](images/03-create-tkg-cluster10.png){.thumbnail} - -Enter these options: - -- **VM FOLDER**: `Storage folder for virtual machines`. -- **DATASTORE**: `Storage of virtual machines to be placed on a shared storage` . -- **CLUSTERS, HOSTS, AND RESOURCE POOLS**: `Cluster1`. - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 11](images/03-create-tkg-cluster11.png){.thumbnail} - -In **NETWORK NAME** select `VLAN10`{.action}. - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 12](images/03-create-tkg-cluster12.png){.thumbnail} - -Disable the `Activate Identity Management Settings`{.action} option and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 13](images/03-create-tkg-cluster13.png){.thumbnail} - -Select the OVA image integrated into the `photon-3-kube-v1.22.9+vmware.1` cluster from the **OS Image** menu and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 14](images/03-create-tkg-cluster14.png){.thumbnail} - -Uncheck `Participate in the Customer Experience Improvement Program`{.action} and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 15](images/03-create-tkg-cluster15.png){.thumbnail} - -Click `REVIEW CONFIGURATION`{.action}. - -![03 Create TKG CLUSTER 16](images/03-create-tkg-cluster16.png){.thumbnail} - -> [!primary] -> Take note of the name of the yaml file below **CLI Command Equivalent**, it will serve as a template for deploying a **WorkLoad** cluster. -> - -Scroll through the window and click `DEPLOY MANAGEMENT CLUSTER`{.action} - -![03 Create TKG CLUSTER 17](images/03-create-tkg-cluster17.png){.thumbnail} - -The **Tanzu Kubernetes Grid** cluster deployment is started, please wait for it to complete. - -> [!primary] -> The deployment will be completed when you see the **Management cluster created** and **Successfully installed all required plugins** messages in the window. -> -> ![03 Create TKG CLUSTER 18](images/03-create-tkg-cluster18.png){.thumbnail} -> -> Another indication that the installation is complete can be found in the console of the **Bootstrap** virtual machine in which will appear the **Management cluster created** and **You can now create your first workload cluster etc...** messages. - -> [!warning] -> -> Write down or copy the name of the **yaml** file in the `/home/tanzu/.config/tanzu/tkg/clusterconfigs` folder, it will be used to create a configuration file for installing a *WorkLoad cluster* -> - -![03 Create TKG CLUSTER 19](images/03-create-tkg-cluster19.png){.thumbnail} - -Go to the vCenter interface to see the seven virtual machines created. - -![04 VM CREATED ADFTER INSTALLATION 01](images/04-vm-created-after-installation01.png){.thumbnail} - -## Go further - -[Administrating a TKG cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) - -[Introducing VMware Tanzu Kubernetes Grid](https://tanzu.vmware.com/kubernetes-grid) - -[Documentation de VMware Tanzu Kubenetes Grid](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/guide.en-ie.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/guide.en-ie.md deleted file mode 100644 index ad8b372965e..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/guide.en-ie.md +++ /dev/null @@ -1,366 +0,0 @@ ---- -title: Installing Tanzu Kubernetes Grid -excerpt: Learn how to integrate Tanzu Kubernetes Grid into your VMware on OVHcloud infrastructure -updated: 2022-11-10 ---- - -## Objective - -**This guide documents how to install Tanzu Kubernetes Grid on your VMware on OVHcloud cluster** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Introduction - -VMware Tanzu Kubernetes Grid is a Kubernetes platform provided by **VMware** and maintained as part of the **VMware on OVHcloud** solution. - -You can install this product on your OVHcloud infrastructure to take advantage of its features and scalability. - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/en-ie/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- A VLAN with internet access and a DHCP server -- You must have these resources: - - 8 GB of memory, 4 vCPUs, and 250 GB of storage for the management virtual machine named **Bootstrap**. - - 16 GB of memory, 4 vCPU, 40 GB of storage per Kubernetes node (it takes 6 nodes to install the management cluster in production mode and 6 nodes per **Workload** cluster in the same mode). - -## Instructions - -We will install **VMware Tanzu Kubernetes Grid** on a **VMware on OVHcloud** cluster and use VLAN 10 with these settings: - -- **LAN**: `192.168.0.0/24`. -- **DHCP Range**: `192.168.0.50 -> 192.168.0.100`. -- **Gateway**: `192.168.0.254`. - -> [!primary] -> This information is given as an example, it is quite possible to use another range and another VLAN. -> - -At the end of the installation, seven additional virtual machines will be on your VMware cluster, six for running the **TKG** management cluster and one for managing it. - -![00 admin cluster diagram](images/00-admin-cluster-diagram01.png){.thumbnail} - -### Importing OVA model for **Tanzu KUBERNETES Grid** into your infrastructure - -VMware provides a virtual machine as an OVA template, which contains all the elements to run a node of the **Tanzu Kubernetes Grid** cluster. This virtual machine is available in **OVH Templates**. - -Log in to the OVHcloud homepage for your VMware cluster, and click `OVH Templates`{.action} to the right. - -![01 integrate TKGM OVA 01](images/01-integrate-tkgm-ova01.png){.thumbnail} - -In the **Select a template** window, choose the fourth template from the top that has this information: - -- **Family**: Linux -- **Distribution**: not specified -- **Version**: 3 - -![01 integrate TKGM OVA 02](images/01-integrate-tkgm-ova02.png){.thumbnail} - -Click the `Copy`{.action} icon to the right to copy the URL which name must end in **photon-3-kube-v1.23.8+vmware.1.ovf**. Then click `Close`{.action}. - -![01 integrate TKGM OVA 03](images/01-integrate-tkgm-ova03.png){.thumbnail} - -Log in to your vSphere console, right-click your cluster and choose `Deploy an OVF Template`{.action}. - -![01 integrate TKGM OVA 03b](images/01-integrate-tkgm-ova03b.png){.thumbnail} - -Select `URL`{.action}, paste the previously copied URL and click `NEXT`{.action}. - -![01 integrate TKGM OVA 04](images/01-integrate-tkgm-ova04.png){.thumbnail} - -Leave the default location and click `NEXT`{.action}. - -![01 integrate TKGM OVA 05](images/01-integrate-tkgm-ova05.png){.thumbnail} - -Choose the cluster and click `NEXT`{.action}. - -![01 integrate TKGM OVA 06](images/01-integrate-tkgm-ova06.png){.thumbnail} - -Review your information and click `NEXT`{.action}. - -![01 integrate TKGM OVA 07](images/01-integrate-tkgm-ova07.png){.thumbnail} - -Check `I accept all licence agreements`{.action} and click `NEXT`{.action}. - -![01 integrate TKGM OVA 08](images/01-integrate-tkgm-ova08.png){.thumbnail} - -Select a shared storage in NFS v3, then click `NEXT`{.action}. - -![01 integrate TKGM OVA 09](images/01-integrate-tkgm-ova09.png){.thumbnail} - -Choose the destination network on `VLAN 10`{.action} and click `NEXT`{.action}. - -![01 integrate TKGM OVA 10](images/01-integrate-tkgm-ova10.png){.thumbnail} - -Click `FINISH`{.action}. - -![01 integrate TKGM OVA 11](images/01-integrate-tkgm-ova11.png){.thumbnail} - -Select the `Monitor`{.action} tab and click `Tasks`{.action}. - -![01 integrate TKGM OVA 12](images/01-integrate-tkgm-ova12.png){.thumbnail} - -Wait for the `Deploy OVF template` and `Import OVF package` tasks to complete. - -![01 integrate TKGM OVA 13](images/01-integrate-tkgm-ova13.png){.thumbnail} - -Right-click the deployed VM and choose `Convert to Template`{.action} from the `Template`{.action} menu. - -![01 integrate TKGM OVA 14](images/01-integrate-tkgm-ova14.png){.thumbnail} - -Answer `YES`{.action} to convert the virtual machine. - -![01 integrate TKGM OVA 15](images/01-integrate-tkgm-ova15.png){.thumbnail} - -Go to `Virtual Machines (and templates)`{.action} to see the template you have created. - -> [!primary] -> -> This template will be used when deploying **Tanzu Kubernetes Grid** clusters. It is used for the initial deployment of the administration cluster and for the installation of additional *WorkLoad* clusters. It should not be deleted from the **VMware** cluster. -> - -![01 integrate TKGM OVA 16](images/01-integrate-tkgm-ova16.png){.thumbnail} - -### Installation of the virtual machine **Bootstrap** provided by OVHcloud - -This virtual machine was created by OVHcloud from the documentation [Installing the CLI tool manually for deploying **Tanzu Kubernetes GRID**](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html). It is available as a template in **OVH Templates**. - -Log in to the OVHcloud homepage for your VMware cluster, and click `OVH Templates`{.action} to the right. - -![02 Add Bootstrapvm 01](images/02-add-bootstrap-vm-from-ova01.png){.thumbnail} - -In the **Select a template** window, choose the third template from the top that contains this information: - -- **Family**: Linux -- **Distribution**: Ubuntu -- **Version**: 22 - -![02 Add Bootstrapvm 02](images/02-add-bootstrap-vm-from-ova02.png){.thumbnail} - -Click the `Copy`{.action} icon to the right to copy the URL, the URL should end with **Ubuntu-22.04_TKGm-1.6_with_x.ovf**. Then click `Close`{.action}. - -![02 Add Bootstrapvm 03](images/02-add-bootstrap-vm-from-ova03.png){.thumbnail} - -In the vSphere interface, right-click the cluster and choose `Deploy an OVF Template`{.action} from the menu. - -![02 Add Bootstrapvm 03b](images/02-add-bootstrap-vm-from-ova03b.png){.thumbnail} - -Select `URL`{.action}, paste the previously copied URL and click `NEXT`{.action}. - -![02 Add Bootstrapvm 04](images/02-add-bootstrap-vm-from-ova04.png){.thumbnail} - -Leave the default positioning and click `NEXT`{.action}. - -![02 Add Bootstrapvm 05](images/02-add-bootstrap-vm-from-ova05.png){.thumbnail} - -Leave `Cluster1` and click `NEXT`{.action}. - -![02 Add Bootstrapvm 06](images/02-add-bootstrap-vm-from-ova06.png){.thumbnail} - -Click `NEXT`{.action} to validate your choices. - -![02 Add Bootstrapvm 07](images/02-add-bootstrap-vm-from-ova07.png){.thumbnail} - -Select a shared storage in NFS v3 and click `NEXT`{.action}. - -![02 Add Bootstrapvm 08](images/02-add-bootstrap-vm-from-ova08.png){.thumbnail} - -Choose `VLAN10` for the destination network and click `NEXT`{.action}. - -![02 Add Bootstrapvm 09](images/02-add-bootstrap-vm-from-ova09.png){.thumbnail} - -Add this information in **Networking**: - -- **Hostname**: `bootstrap` -- **IP Address**: `192.168.0.199` -- **Network CIDR Prefix**: `24` -- **Gateway**: `192.168.0.254` -- **DNS**: `213.186.33.99` - -> [!primary] -> -> The DNS server chosen in this guide is the OVHcloud server. -> - -Enter and confirm the password in **OS Credentials** and click `NEXT`{.action}. - -![02 Add Bootstrapvm 10](images/02-add-bootstrap-vm-from-ova10.png){.thumbnail} - -Click `FINISH`{.action}. - -![02 Add Bootstrapvm 11](images/02-add-bootstrap-vm-from-ova11.png){.thumbnail} - -Right-click the virtual machine you created, go to `Power`{.action} and click `Power On`{.action}. - -![02 Add Bootstrapvm 12](images/02-add-bootstrap-vm-from-ova12.png){.thumbnail} - -The booted virtual machine can be accessed via the console with the graphical interface or via **SSH**. - -Go to the virtual machine you have created, and click `LAUNCH WEB CONSOLE`{.action}. - -![02 Add Bootstrapvm 13](images/02-add-bootstrap-vm-from-ova13.png){.thumbnail} - -The graphical interface for the Linux virtual machine is then available. - -![02 Add Bootstrapvm 14](images/02-add-bootstrap-vm-from-ova14.png){.thumbnail} - -### Allowing access to the PCC cluster from the **Bootstrap** virtual machine - -The configuration and administration tools for **Tanzu Kubernetes Grid** are installed on the **Bootstrap** virtual machine. This virtual machine must be able to connect to the Internet and to the vSphere cluster. - -Write down **the public IP address** you use on this virtual machine and use this guide [Authorise IP addresses to connect to vCenter](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/autoriser_des_ip_a_se_connecter_au_vcenter) to grant access to the vSphere cluster to the new virtual machine. - -### Deploying the **Tanzu Kubernetes Grid** cluster on your infrastructure - -Log in to the `Ubuntu-22.04_TKGm-1.5.4_with_x` virtual machine, open a terminal, and run this command to create an **RSA** key: - -```bash -ssh-keygen -t rsa -b 4096 -C "youremail@yourdomain.com" -``` - -![03 Create TKG CLUSTER 01](images/03-create-tkg-cluster01.png){.thumbnail} - -Two files are created in the **~/.ssh** folder: - -- **id_rsa.pub** -- **id_rsa** - -Stay on the console and run this command: - -```bash -tanzu management-cluster create --ui --bind 192.168.0.199:8080 -``` - -> [!primary] -> -> When you run this command from the Linux console with the graphical interface, the web browser launches and connects to `https://192.168.0.199:8080`. If you have run this command from an **SSH** connection, you will need to connect to `https://192.168.0.199:8080` from a virtual machine on the same network with a graphical interface and an operational web browser. -> - -![03 Create TKG CLUSTER 02](images/03-create-tkg-cluster02.png){.thumbnail} - -Click `Deploy`{.action} below **VMware vSphere**. - -![03 Create TKG CLUSTER 03](images/03-create-tkg-cluster03.png){.thumbnail} - -Enter this information: - -- **VCENTER SERVER**: `VMware cluster FQDN` -- **USERNAME**: `VMware cluster user` -- **PASSWORD**: `VMware cluster user password` - -Then click `CONNECT`{.action}. - -![03 Create TKG CLUSTER 04](images/03-create-tkg-cluster04.png){.thumbnail} - -At the verification step of the **SSL Thumbprint**, click `CONTINUE`{.action}. - -![03 Create TKG CLUSTER 05](images/03-create-tkg-cluster05.png){.thumbnail} - -Click the cross in the top right to close the **vSphere 7.0.3 Environment Detected** window. - -![03 Create TKG CLUSTER 06](images/03-create-tkg-cluster06.png){.thumbnail} - -Paste the contents of the **~.ssh/id_rsa.pub** file into **SSH PUBLIC KEY** and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 07](images/03-create-tkg-cluster07.png){.thumbnail} - -Select `Production`{.action} on the right and select the `large etc...` **INSTANCE TYPE**. - -Enter these values: - -- **MANAGEMENT CLUSTER NAME (OPTIONAL)**: `tkgm-management-cluster`. -- **CONTROL PLANE ENDPOINT**: `192.168.0.10`. - -Click `NEXT`{.action} to proceed to the next step. - -![03 Create TKG CLUSTER 08](images/03-create-tkg-cluster08.png){.thumbnail} - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 09](images/03-create-tkg-cluster09.png){.thumbnail} - -In the **Metadata** option and then in the **LABELS (OPTIONAL)** section, type `tkgm` for the name and its value. - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 10](images/03-create-tkg-cluster10.png){.thumbnail} - -Enter these options: - -- **VM FOLDER**: `Storage folder for virtual machines`. -- **DATASTORE**: `Storage of virtual machines to be placed on a shared storage` . -- **CLUSTERS, HOSTS, AND RESOURCE POOLS**: `Cluster1`. - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 11](images/03-create-tkg-cluster11.png){.thumbnail} - -In **NETWORK NAME** select `VLAN10`{.action}. - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 12](images/03-create-tkg-cluster12.png){.thumbnail} - -Disable the `Activate Identity Management Settings`{.action} option and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 13](images/03-create-tkg-cluster13.png){.thumbnail} - -Select the OVA image integrated into the `photon-3-kube-v1.22.9+vmware.1` cluster from the **OS Image** menu and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 14](images/03-create-tkg-cluster14.png){.thumbnail} - -Uncheck `Participate in the Customer Experience Improvement Program`{.action} and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 15](images/03-create-tkg-cluster15.png){.thumbnail} - -Click `REVIEW CONFIGURATION`{.action}. - -![03 Create TKG CLUSTER 16](images/03-create-tkg-cluster16.png){.thumbnail} - -> [!primary] -> Take note of the name of the yaml file below **CLI Command Equivalent**, it will serve as a template for deploying a **WorkLoad** cluster. -> - -Scroll through the window and click `DEPLOY MANAGEMENT CLUSTER`{.action} - -![03 Create TKG CLUSTER 17](images/03-create-tkg-cluster17.png){.thumbnail} - -The **Tanzu Kubernetes Grid** cluster deployment is started, please wait for it to complete. - -> [!primary] -> The deployment will be completed when you see the **Management cluster created** and **Successfully installed all required plugins** messages in the window. -> -> ![03 Create TKG CLUSTER 18](images/03-create-tkg-cluster18.png){.thumbnail} -> -> Another indication that the installation is complete can be found in the console of the **Bootstrap** virtual machine in which will appear the **Management cluster created** and **You can now create your first workload cluster etc...** messages. - -> [!warning] -> -> Write down or copy the name of the **yaml** file in the `/home/tanzu/.config/tanzu/tkg/clusterconfigs` folder, it will be used to create a configuration file for installing a *WorkLoad cluster* -> - -![03 Create TKG CLUSTER 19](images/03-create-tkg-cluster19.png){.thumbnail} - -Go to the vCenter interface to see the seven virtual machines created. - -![04 VM CREATED ADFTER INSTALLATION 01](images/04-vm-created-after-installation01.png){.thumbnail} - -## Go further - -[Administrating a TKG cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) - -[Introducing VMware Tanzu Kubernetes Grid](https://tanzu.vmware.com/kubernetes-grid) - -[Documentation de VMware Tanzu Kubenetes Grid](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/guide.en-sg.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/guide.en-sg.md deleted file mode 100644 index 06a34b00a9a..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/guide.en-sg.md +++ /dev/null @@ -1,366 +0,0 @@ ---- -title: Installing Tanzu Kubernetes Grid -excerpt: Learn how to integrate Tanzu Kubernetes Grid into your VMware on OVHcloud infrastructure -updated: 2022-11-10 ---- - -## Objective - -**This guide documents how to install Tanzu Kubernetes Grid on your VMware on OVHcloud cluster** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Introduction - -VMware Tanzu Kubernetes Grid is a Kubernetes platform provided by **VMware** and maintained as part of the **VMware on OVHcloud** solution. - -You can install this product on your OVHcloud infrastructure to take advantage of its features and scalability. - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/en-sg/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- A VLAN with internet access and a DHCP server -- You must have these resources: - - 8 GB of memory, 4 vCPUs, and 250 GB of storage for the management virtual machine named **Bootstrap**. - - 16 GB of memory, 4 vCPU, 40 GB of storage per Kubernetes node (it takes 6 nodes to install the management cluster in production mode and 6 nodes per **Workload** cluster in the same mode). - -## Instructions - -We will install **VMware Tanzu Kubernetes Grid** on a **VMware on OVHcloud** cluster and use VLAN 10 with these settings: - -- **LAN**: `192.168.0.0/24`. -- **DHCP Range**: `192.168.0.50 -> 192.168.0.100`. -- **Gateway**: `192.168.0.254`. - -> [!primary] -> This information is given as an example, it is quite possible to use another range and another VLAN. -> - -At the end of the installation, seven additional virtual machines will be on your VMware cluster, six for running the **TKG** management cluster and one for managing it. - -![00 admin cluster diagram](images/00-admin-cluster-diagram01.png){.thumbnail} - -### Importing OVA model for **Tanzu KUBERNETES Grid** into your infrastructure - -VMware provides a virtual machine as an OVA template, which contains all the elements to run a node of the **Tanzu Kubernetes Grid** cluster. This virtual machine is available in **OVH Templates**. - -Log in to the OVHcloud homepage for your VMware cluster, and click `OVH Templates`{.action} to the right. - -![01 integrate TKGM OVA 01](images/01-integrate-tkgm-ova01.png){.thumbnail} - -In the **Select a template** window, choose the fourth template from the top that has this information: - -- **Family**: Linux -- **Distribution**: not specified -- **Version**: 3 - -![01 integrate TKGM OVA 02](images/01-integrate-tkgm-ova02.png){.thumbnail} - -Click the `Copy`{.action} icon to the right to copy the URL which name must end in **photon-3-kube-v1.23.8+vmware.1.ovf**. Then click `Close`{.action}. - -![01 integrate TKGM OVA 03](images/01-integrate-tkgm-ova03.png){.thumbnail} - -Log in to your vSphere console, right-click your cluster and choose `Deploy an OVF Template`{.action}. - -![01 integrate TKGM OVA 03b](images/01-integrate-tkgm-ova03b.png){.thumbnail} - -Select `URL`{.action}, paste the previously copied URL and click `NEXT`{.action}. - -![01 integrate TKGM OVA 04](images/01-integrate-tkgm-ova04.png){.thumbnail} - -Leave the default location and click `NEXT`{.action}. - -![01 integrate TKGM OVA 05](images/01-integrate-tkgm-ova05.png){.thumbnail} - -Choose the cluster and click `NEXT`{.action}. - -![01 integrate TKGM OVA 06](images/01-integrate-tkgm-ova06.png){.thumbnail} - -Review your information and click `NEXT`{.action}. - -![01 integrate TKGM OVA 07](images/01-integrate-tkgm-ova07.png){.thumbnail} - -Check `I accept all licence agreements`{.action} and click `NEXT`{.action}. - -![01 integrate TKGM OVA 08](images/01-integrate-tkgm-ova08.png){.thumbnail} - -Select a shared storage in NFS v3, then click `NEXT`{.action}. - -![01 integrate TKGM OVA 09](images/01-integrate-tkgm-ova09.png){.thumbnail} - -Choose the destination network on `VLAN 10`{.action} and click `NEXT`{.action}. - -![01 integrate TKGM OVA 10](images/01-integrate-tkgm-ova10.png){.thumbnail} - -Click `FINISH`{.action}. - -![01 integrate TKGM OVA 11](images/01-integrate-tkgm-ova11.png){.thumbnail} - -Select the `Monitor`{.action} tab and click `Tasks`{.action}. - -![01 integrate TKGM OVA 12](images/01-integrate-tkgm-ova12.png){.thumbnail} - -Wait for the `Deploy OVF template` and `Import OVF package` tasks to complete. - -![01 integrate TKGM OVA 13](images/01-integrate-tkgm-ova13.png){.thumbnail} - -Right-click the deployed VM and choose `Convert to Template`{.action} from the `Template`{.action} menu. - -![01 integrate TKGM OVA 14](images/01-integrate-tkgm-ova14.png){.thumbnail} - -Answer `YES`{.action} to convert the virtual machine. - -![01 integrate TKGM OVA 15](images/01-integrate-tkgm-ova15.png){.thumbnail} - -Go to `Virtual Machines (and templates)`{.action} to see the template you have created. - -> [!primary] -> -> This template will be used when deploying **Tanzu Kubernetes Grid** clusters. It is used for the initial deployment of the administration cluster and for the installation of additional *WorkLoad* clusters. It should not be deleted from the **VMware** cluster. -> - -![01 integrate TKGM OVA 16](images/01-integrate-tkgm-ova16.png){.thumbnail} - -### Installation of the virtual machine **Bootstrap** provided by OVHcloud - -This virtual machine was created by OVHcloud from the documentation [Installing the CLI tool manually for deploying **Tanzu Kubernetes GRID**](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html). It is available as a template in **OVH Templates**. - -Log in to the OVHcloud homepage for your VMware cluster, and click `OVH Templates`{.action} to the right. - -![02 Add Bootstrapvm 01](images/02-add-bootstrap-vm-from-ova01.png){.thumbnail} - -In the **Select a template** window, choose the third template from the top that contains this information: - -- **Family**: Linux -- **Distribution**: Ubuntu -- **Version**: 22 - -![02 Add Bootstrapvm 02](images/02-add-bootstrap-vm-from-ova02.png){.thumbnail} - -Click the `Copy`{.action} icon to the right to copy the URL, the URL should end with **Ubuntu-22.04_TKGm-1.6_with_x.ovf**. Then click `Close`{.action}. - -![02 Add Bootstrapvm 03](images/02-add-bootstrap-vm-from-ova03.png){.thumbnail} - -In the vSphere interface, right-click the cluster and choose `Deploy an OVF Template`{.action} from the menu. - -![02 Add Bootstrapvm 03b](images/02-add-bootstrap-vm-from-ova03b.png){.thumbnail} - -Select `URL`{.action}, paste the previously copied URL and click `NEXT`{.action}. - -![02 Add Bootstrapvm 04](images/02-add-bootstrap-vm-from-ova04.png){.thumbnail} - -Leave the default positioning and click `NEXT`{.action}. - -![02 Add Bootstrapvm 05](images/02-add-bootstrap-vm-from-ova05.png){.thumbnail} - -Leave `Cluster1` and click `NEXT`{.action}. - -![02 Add Bootstrapvm 06](images/02-add-bootstrap-vm-from-ova06.png){.thumbnail} - -Click `NEXT`{.action} to validate your choices. - -![02 Add Bootstrapvm 07](images/02-add-bootstrap-vm-from-ova07.png){.thumbnail} - -Select a shared storage in NFS v3 and click `NEXT`{.action}. - -![02 Add Bootstrapvm 08](images/02-add-bootstrap-vm-from-ova08.png){.thumbnail} - -Choose `VLAN10` for the destination network and click `NEXT`{.action}. - -![02 Add Bootstrapvm 09](images/02-add-bootstrap-vm-from-ova09.png){.thumbnail} - -Add this information in **Networking**: - -- **Hostname**: `bootstrap` -- **IP Address**: `192.168.0.199` -- **Network CIDR Prefix**: `24` -- **Gateway**: `192.168.0.254` -- **DNS**: `213.186.33.99` - -> [!primary] -> -> The DNS server chosen in this guide is the OVHcloud server. -> - -Enter and confirm the password in **OS Credentials** and click `NEXT`{.action}. - -![02 Add Bootstrapvm 10](images/02-add-bootstrap-vm-from-ova10.png){.thumbnail} - -Click `FINISH`{.action}. - -![02 Add Bootstrapvm 11](images/02-add-bootstrap-vm-from-ova11.png){.thumbnail} - -Right-click the virtual machine you created, go to `Power`{.action} and click `Power On`{.action}. - -![02 Add Bootstrapvm 12](images/02-add-bootstrap-vm-from-ova12.png){.thumbnail} - -The booted virtual machine can be accessed via the console with the graphical interface or via **SSH**. - -Go to the virtual machine you have created, and click `LAUNCH WEB CONSOLE`{.action}. - -![02 Add Bootstrapvm 13](images/02-add-bootstrap-vm-from-ova13.png){.thumbnail} - -The graphical interface for the Linux virtual machine is then available. - -![02 Add Bootstrapvm 14](images/02-add-bootstrap-vm-from-ova14.png){.thumbnail} - -### Allowing access to the PCC cluster from the **Bootstrap** virtual machine - -The configuration and administration tools for **Tanzu Kubernetes Grid** are installed on the **Bootstrap** virtual machine. This virtual machine must be able to connect to the Internet and to the vSphere cluster. - -Write down **the public IP address** you use on this virtual machine and use this guide [Authorise IP addresses to connect to vCenter](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/autoriser_des_ip_a_se_connecter_au_vcenter) to grant access to the vSphere cluster to the new virtual machine. - -### Deploying the **Tanzu Kubernetes Grid** cluster on your infrastructure - -Log in to the `Ubuntu-22.04_TKGm-1.5.4_with_x` virtual machine, open a terminal, and run this command to create an **RSA** key: - -```bash -ssh-keygen -t rsa -b 4096 -C "youremail@yourdomain.com" -``` - -![03 Create TKG CLUSTER 01](images/03-create-tkg-cluster01.png){.thumbnail} - -Two files are created in the **~/.ssh** folder: - -- **id_rsa.pub** -- **id_rsa** - -Stay on the console and run this command: - -```bash -tanzu management-cluster create --ui --bind 192.168.0.199:8080 -``` - -> [!primary] -> -> When you run this command from the Linux console with the graphical interface, the web browser launches and connects to `https://192.168.0.199:8080`. If you have run this command from an **SSH** connection, you will need to connect to `https://192.168.0.199:8080` from a virtual machine on the same network with a graphical interface and an operational web browser. -> - -![03 Create TKG CLUSTER 02](images/03-create-tkg-cluster02.png){.thumbnail} - -Click `Deploy`{.action} below **VMware vSphere**. - -![03 Create TKG CLUSTER 03](images/03-create-tkg-cluster03.png){.thumbnail} - -Enter this information: - -- **VCENTER SERVER**: `VMware cluster FQDN` -- **USERNAME**: `VMware cluster user` -- **PASSWORD**: `VMware cluster user password` - -Then click `CONNECT`{.action}. - -![03 Create TKG CLUSTER 04](images/03-create-tkg-cluster04.png){.thumbnail} - -At the verification step of the **SSL Thumbprint**, click `CONTINUE`{.action}. - -![03 Create TKG CLUSTER 05](images/03-create-tkg-cluster05.png){.thumbnail} - -Click the cross in the top right to close the **vSphere 7.0.3 Environment Detected** window. - -![03 Create TKG CLUSTER 06](images/03-create-tkg-cluster06.png){.thumbnail} - -Paste the contents of the **~.ssh/id_rsa.pub** file into **SSH PUBLIC KEY** and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 07](images/03-create-tkg-cluster07.png){.thumbnail} - -Select `Production`{.action} on the right and select the `large etc...` **INSTANCE TYPE**. - -Enter these values: - -- **MANAGEMENT CLUSTER NAME (OPTIONAL)**: `tkgm-management-cluster`. -- **CONTROL PLANE ENDPOINT**: `192.168.0.10`. - -Click `NEXT`{.action} to proceed to the next step. - -![03 Create TKG CLUSTER 08](images/03-create-tkg-cluster08.png){.thumbnail} - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 09](images/03-create-tkg-cluster09.png){.thumbnail} - -In the **Metadata** option and then in the **LABELS (OPTIONAL)** section, type `tkgm` for the name and its value. - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 10](images/03-create-tkg-cluster10.png){.thumbnail} - -Enter these options: - -- **VM FOLDER**: `Storage folder for virtual machines`. -- **DATASTORE**: `Storage of virtual machines to be placed on a shared storage` . -- **CLUSTERS, HOSTS, AND RESOURCE POOLS**: `Cluster1`. - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 11](images/03-create-tkg-cluster11.png){.thumbnail} - -In **NETWORK NAME** select `VLAN10`{.action}. - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 12](images/03-create-tkg-cluster12.png){.thumbnail} - -Disable the `Activate Identity Management Settings`{.action} option and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 13](images/03-create-tkg-cluster13.png){.thumbnail} - -Select the OVA image integrated into the `photon-3-kube-v1.22.9+vmware.1` cluster from the **OS Image** menu and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 14](images/03-create-tkg-cluster14.png){.thumbnail} - -Uncheck `Participate in the Customer Experience Improvement Program`{.action} and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 15](images/03-create-tkg-cluster15.png){.thumbnail} - -Click `REVIEW CONFIGURATION`{.action}. - -![03 Create TKG CLUSTER 16](images/03-create-tkg-cluster16.png){.thumbnail} - -> [!primary] -> Take note of the name of the yaml file below **CLI Command Equivalent**, it will serve as a template for deploying a **WorkLoad** cluster. -> - -Scroll through the window and click `DEPLOY MANAGEMENT CLUSTER`{.action} - -![03 Create TKG CLUSTER 17](images/03-create-tkg-cluster17.png){.thumbnail} - -The **Tanzu Kubernetes Grid** cluster deployment is started, please wait for it to complete. - -> [!primary] -> The deployment will be completed when you see the **Management cluster created** and **Successfully installed all required plugins** messages in the window. -> -> ![03 Create TKG CLUSTER 18](images/03-create-tkg-cluster18.png){.thumbnail} -> -> Another indication that the installation is complete can be found in the console of the **Bootstrap** virtual machine in which will appear the **Management cluster created** and **You can now create your first workload cluster etc...** messages. - -> [!warning] -> -> Write down or copy the name of the **yaml** file in the `/home/tanzu/.config/tanzu/tkg/clusterconfigs` folder, it will be used to create a configuration file for installing a *WorkLoad cluster* -> - -![03 Create TKG CLUSTER 19](images/03-create-tkg-cluster19.png){.thumbnail} - -Go to the vCenter interface to see the seven virtual machines created. - -![04 VM CREATED ADFTER INSTALLATION 01](images/04-vm-created-after-installation01.png){.thumbnail} - -## Go further - -[Administrating a TKG cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) - -[Introducing VMware Tanzu Kubernetes Grid](https://tanzu.vmware.com/kubernetes-grid) - -[Documentation de VMware Tanzu Kubenetes Grid](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/guide.en-us.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/guide.en-us.md deleted file mode 100644 index 7bd5166cd66..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/guide.en-us.md +++ /dev/null @@ -1,366 +0,0 @@ ---- -title: Installing Tanzu Kubernetes Grid -excerpt: Learn how to integrate Tanzu Kubernetes Grid into your VMware on OVHcloud infrastructure -updated: 2022-11-10 ---- - -## Objective - -**This guide documents how to install Tanzu Kubernetes Grid on your VMware on OVHcloud cluster** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Introduction - -VMware Tanzu Kubernetes Grid is a Kubernetes platform provided by **VMware** and maintained as part of the **VMware on OVHcloud** solution. - -You can install this product on your OVHcloud infrastructure to take advantage of its features and scalability. - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/en/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- A VLAN with internet access and a DHCP server -- You must have these resources: - - 8 GB of memory, 4 vCPUs, and 250 GB of storage for the management virtual machine named **Bootstrap**. - - 16 GB of memory, 4 vCPU, 40 GB of storage per Kubernetes node (it takes 6 nodes to install the management cluster in production mode and 6 nodes per **Workload** cluster in the same mode). - -## Instructions - -We will install **VMware Tanzu Kubernetes Grid** on a **VMware on OVHcloud** cluster and use VLAN 10 with these settings: - -- **LAN**: `192.168.0.0/24`. -- **DHCP Range**: `192.168.0.50 -> 192.168.0.100`. -- **Gateway**: `192.168.0.254`. - -> [!primary] -> This information is given as an example, it is quite possible to use another range and another VLAN. -> - -At the end of the installation, seven additional virtual machines will be on your VMware cluster, six for running the **TKG** management cluster and one for managing it. - -![00 admin cluster diagram](images/00-admin-cluster-diagram01.png){.thumbnail} - -### Importing OVA model for **Tanzu KUBERNETES Grid** into your infrastructure - -VMware provides a virtual machine as an OVA template, which contains all the elements to run a node of the **Tanzu Kubernetes Grid** cluster. This virtual machine is available in **OVH Templates**. - -Log in to the OVHcloud homepage for your VMware cluster, and click `OVH Templates`{.action} to the right. - -![01 integrate TKGM OVA 01](images/01-integrate-tkgm-ova01.png){.thumbnail} - -In the **Select a template** window, choose the fourth template from the top that has this information: - -- **Family**: Linux -- **Distribution**: not specified -- **Version**: 3 - -![01 integrate TKGM OVA 02](images/01-integrate-tkgm-ova02.png){.thumbnail} - -Click the `Copy`{.action} icon to the right to copy the URL which name must end in **photon-3-kube-v1.23.8+vmware.1.ovf**. Then click `Close`{.action}. - -![01 integrate TKGM OVA 03](images/01-integrate-tkgm-ova03.png){.thumbnail} - -Log in to your vSphere console, right-click your cluster and choose `Deploy an OVF Template`{.action}. - -![01 integrate TKGM OVA 03b](images/01-integrate-tkgm-ova03b.png){.thumbnail} - -Select `URL`{.action}, paste the previously copied URL and click `NEXT`{.action}. - -![01 integrate TKGM OVA 04](images/01-integrate-tkgm-ova04.png){.thumbnail} - -Leave the default location and click `NEXT`{.action}. - -![01 integrate TKGM OVA 05](images/01-integrate-tkgm-ova05.png){.thumbnail} - -Choose the cluster and click `NEXT`{.action}. - -![01 integrate TKGM OVA 06](images/01-integrate-tkgm-ova06.png){.thumbnail} - -Review your information and click `NEXT`{.action}. - -![01 integrate TKGM OVA 07](images/01-integrate-tkgm-ova07.png){.thumbnail} - -Check `I accept all licence agreements`{.action} and click `NEXT`{.action}. - -![01 integrate TKGM OVA 08](images/01-integrate-tkgm-ova08.png){.thumbnail} - -Select a shared storage in NFS v3, then click `NEXT`{.action}. - -![01 integrate TKGM OVA 09](images/01-integrate-tkgm-ova09.png){.thumbnail} - -Choose the destination network on `VLAN 10`{.action} and click `NEXT`{.action}. - -![01 integrate TKGM OVA 10](images/01-integrate-tkgm-ova10.png){.thumbnail} - -Click `FINISH`{.action}. - -![01 integrate TKGM OVA 11](images/01-integrate-tkgm-ova11.png){.thumbnail} - -Select the `Monitor`{.action} tab and click `Tasks`{.action}. - -![01 integrate TKGM OVA 12](images/01-integrate-tkgm-ova12.png){.thumbnail} - -Wait for the `Deploy OVF template` and `Import OVF package` tasks to complete. - -![01 integrate TKGM OVA 13](images/01-integrate-tkgm-ova13.png){.thumbnail} - -Right-click the deployed VM and choose `Convert to Template`{.action} from the `Template`{.action} menu. - -![01 integrate TKGM OVA 14](images/01-integrate-tkgm-ova14.png){.thumbnail} - -Answer `YES`{.action} to convert the virtual machine. - -![01 integrate TKGM OVA 15](images/01-integrate-tkgm-ova15.png){.thumbnail} - -Go to `Virtual Machines (and templates)`{.action} to see the template you have created. - -> [!primary] -> -> This template will be used when deploying **Tanzu Kubernetes Grid** clusters. It is used for the initial deployment of the administration cluster and for the installation of additional *WorkLoad* clusters. It should not be deleted from the **VMware** cluster. -> - -![01 integrate TKGM OVA 16](images/01-integrate-tkgm-ova16.png){.thumbnail} - -### Installation of the virtual machine **Bootstrap** provided by OVHcloud - -This virtual machine was created by OVHcloud from the documentation [Installing the CLI tool manually for deploying **Tanzu Kubernetes GRID**](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html). It is available as a template in **OVH Templates**. - -Log in to the OVHcloud homepage for your VMware cluster, and click `OVH Templates`{.action} to the right. - -![02 Add Bootstrapvm 01](images/02-add-bootstrap-vm-from-ova01.png){.thumbnail} - -In the **Select a template** window, choose the third template from the top that contains this information: - -- **Family**: Linux -- **Distribution**: Ubuntu -- **Version**: 22 - -![02 Add Bootstrapvm 02](images/02-add-bootstrap-vm-from-ova02.png){.thumbnail} - -Click the `Copy`{.action} icon to the right to copy the URL, the URL should end with **Ubuntu-22.04_TKGm-1.6_with_x.ovf**. Then click `Close`{.action}. - -![02 Add Bootstrapvm 03](images/02-add-bootstrap-vm-from-ova03.png){.thumbnail} - -In the vSphere interface, right-click the cluster and choose `Deploy an OVF Template`{.action} from the menu. - -![02 Add Bootstrapvm 03b](images/02-add-bootstrap-vm-from-ova03b.png){.thumbnail} - -Select `URL`{.action}, paste the previously copied URL and click `NEXT`{.action}. - -![02 Add Bootstrapvm 04](images/02-add-bootstrap-vm-from-ova04.png){.thumbnail} - -Leave the default positioning and click `NEXT`{.action}. - -![02 Add Bootstrapvm 05](images/02-add-bootstrap-vm-from-ova05.png){.thumbnail} - -Leave `Cluster1` and click `NEXT`{.action}. - -![02 Add Bootstrapvm 06](images/02-add-bootstrap-vm-from-ova06.png){.thumbnail} - -Click `NEXT`{.action} to validate your choices. - -![02 Add Bootstrapvm 07](images/02-add-bootstrap-vm-from-ova07.png){.thumbnail} - -Select a shared storage in NFS v3 and click `NEXT`{.action}. - -![02 Add Bootstrapvm 08](images/02-add-bootstrap-vm-from-ova08.png){.thumbnail} - -Choose `VLAN10` for the destination network and click `NEXT`{.action}. - -![02 Add Bootstrapvm 09](images/02-add-bootstrap-vm-from-ova09.png){.thumbnail} - -Add this information in **Networking**: - -- **Hostname**: `bootstrap` -- **IP Address**: `192.168.0.199` -- **Network CIDR Prefix**: `24` -- **Gateway**: `192.168.0.254` -- **DNS**: `213.186.33.99` - -> [!primary] -> -> The DNS server chosen in this guide is the OVHcloud server. -> - -Enter and confirm the password in **OS Credentials** and click `NEXT`{.action}. - -![02 Add Bootstrapvm 10](images/02-add-bootstrap-vm-from-ova10.png){.thumbnail} - -Click `FINISH`{.action}. - -![02 Add Bootstrapvm 11](images/02-add-bootstrap-vm-from-ova11.png){.thumbnail} - -Right-click the virtual machine you created, go to `Power`{.action} and click `Power On`{.action}. - -![02 Add Bootstrapvm 12](images/02-add-bootstrap-vm-from-ova12.png){.thumbnail} - -The booted virtual machine can be accessed via the console with the graphical interface or via **SSH**. - -Go to the virtual machine you have created, and click `LAUNCH WEB CONSOLE`{.action}. - -![02 Add Bootstrapvm 13](images/02-add-bootstrap-vm-from-ova13.png){.thumbnail} - -The graphical interface for the Linux virtual machine is then available. - -![02 Add Bootstrapvm 14](images/02-add-bootstrap-vm-from-ova14.png){.thumbnail} - -### Allowing access to the PCC cluster from the **Bootstrap** virtual machine - -The configuration and administration tools for **Tanzu Kubernetes Grid** are installed on the **Bootstrap** virtual machine. This virtual machine must be able to connect to the Internet and to the vSphere cluster. - -Write down **the public IP address** you use on this virtual machine and use this guide [Authorise IP addresses to connect to vCenter](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/autoriser_des_ip_a_se_connecter_au_vcenter) to grant access to the vSphere cluster to the new virtual machine. - -### Deploying the **Tanzu Kubernetes Grid** cluster on your infrastructure - -Log in to the `Ubuntu-22.04_TKGm-1.5.4_with_x` virtual machine, open a terminal, and run this command to create an **RSA** key: - -```bash -ssh-keygen -t rsa -b 4096 -C "youremail@yourdomain.com" -``` - -![03 Create TKG CLUSTER 01](images/03-create-tkg-cluster01.png){.thumbnail} - -Two files are created in the **~/.ssh** folder: - -- **id_rsa.pub** -- **id_rsa** - -Stay on the console and run this command: - -```bash -tanzu management-cluster create --ui --bind 192.168.0.199:8080 -``` - -> [!primary] -> -> When you run this command from the Linux console with the graphical interface, the web browser launches and connects to `https://192.168.0.199:8080`. If you have run this command from an **SSH** connection, you will need to connect to `https://192.168.0.199:8080` from a virtual machine on the same network with a graphical interface and an operational web browser. -> - -![03 Create TKG CLUSTER 02](images/03-create-tkg-cluster02.png){.thumbnail} - -Click `Deploy`{.action} below **VMware vSphere**. - -![03 Create TKG CLUSTER 03](images/03-create-tkg-cluster03.png){.thumbnail} - -Enter this information: - -- **VCENTER SERVER**: `VMware cluster FQDN` -- **USERNAME**: `VMware cluster user` -- **PASSWORD**: `VMware cluster user password` - -Then click `CONNECT`{.action}. - -![03 Create TKG CLUSTER 04](images/03-create-tkg-cluster04.png){.thumbnail} - -At the verification step of the **SSL Thumbprint**, click `CONTINUE`{.action}. - -![03 Create TKG CLUSTER 05](images/03-create-tkg-cluster05.png){.thumbnail} - -Click the cross in the top right to close the **vSphere 7.0.3 Environment Detected** window. - -![03 Create TKG CLUSTER 06](images/03-create-tkg-cluster06.png){.thumbnail} - -Paste the contents of the **~.ssh/id_rsa.pub** file into **SSH PUBLIC KEY** and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 07](images/03-create-tkg-cluster07.png){.thumbnail} - -Select `Production`{.action} on the right and select the `large etc...` **INSTANCE TYPE**. - -Enter these values: - -- **MANAGEMENT CLUSTER NAME (OPTIONAL)**: `tkgm-management-cluster`. -- **CONTROL PLANE ENDPOINT**: `192.168.0.10`. - -Click `NEXT`{.action} to proceed to the next step. - -![03 Create TKG CLUSTER 08](images/03-create-tkg-cluster08.png){.thumbnail} - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 09](images/03-create-tkg-cluster09.png){.thumbnail} - -In the **Metadata** option and then in the **LABELS (OPTIONAL)** section, type `tkgm` for the name and its value. - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 10](images/03-create-tkg-cluster10.png){.thumbnail} - -Enter these options: - -- **VM FOLDER**: `Storage folder for virtual machines`. -- **DATASTORE**: `Storage of virtual machines to be placed on a shared storage` . -- **CLUSTERS, HOSTS, AND RESOURCE POOLS**: `Cluster1`. - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 11](images/03-create-tkg-cluster11.png){.thumbnail} - -In **NETWORK NAME** select `VLAN10`{.action}. - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 12](images/03-create-tkg-cluster12.png){.thumbnail} - -Disable the `Activate Identity Management Settings`{.action} option and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 13](images/03-create-tkg-cluster13.png){.thumbnail} - -Select the OVA image integrated into the `photon-3-kube-v1.22.9+vmware.1` cluster from the **OS Image** menu and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 14](images/03-create-tkg-cluster14.png){.thumbnail} - -Uncheck `Participate in the Customer Experience Improvement Program`{.action} and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 15](images/03-create-tkg-cluster15.png){.thumbnail} - -Click `REVIEW CONFIGURATION`{.action}. - -![03 Create TKG CLUSTER 16](images/03-create-tkg-cluster16.png){.thumbnail} - -> [!primary] -> Take note of the name of the yaml file below **CLI Command Equivalent**, it will serve as a template for deploying a **WorkLoad** cluster. -> - -Scroll through the window and click `DEPLOY MANAGEMENT CLUSTER`{.action} - -![03 Create TKG CLUSTER 17](images/03-create-tkg-cluster17.png){.thumbnail} - -The **Tanzu Kubernetes Grid** cluster deployment is started, please wait for it to complete. - -> [!primary] -> The deployment will be completed when you see the **Management cluster created** and **Successfully installed all required plugins** messages in the window. -> -> ![03 Create TKG CLUSTER 18](images/03-create-tkg-cluster18.png){.thumbnail} -> -> Another indication that the installation is complete can be found in the console of the **Bootstrap** virtual machine in which will appear the **Management cluster created** and **You can now create your first workload cluster etc...** messages. - -> [!warning] -> -> Write down or copy the name of the **yaml** file in the `/home/tanzu/.config/tanzu/tkg/clusterconfigs` folder, it will be used to create a configuration file for installing a *WorkLoad cluster* -> - -![03 Create TKG CLUSTER 19](images/03-create-tkg-cluster19.png){.thumbnail} - -Go to the vCenter interface to see the seven virtual machines created. - -![04 VM CREATED ADFTER INSTALLATION 01](images/04-vm-created-after-installation01.png){.thumbnail} - -## Go further - -[Administrating a TKG cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) - -[Introducing VMware Tanzu Kubernetes Grid](https://tanzu.vmware.com/kubernetes-grid) - -[Documentation de VMware Tanzu Kubenetes Grid](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/guide.es-es.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/guide.es-es.md deleted file mode 100644 index bbb3833599d..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/guide.es-es.md +++ /dev/null @@ -1,366 +0,0 @@ ---- -title: Instalación de Tanzu Kubernetes Grid (EN) -excerpt: Learn how to integrate Tanzu Kubernetes Grid into your VMware on OVHcloud infrastructure -updated: 2022-11-10 ---- - -## Objective - -**This guide documents how to install Tanzu Kubernetes Grid on your VMware on OVHcloud cluster** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Introduction - -VMware Tanzu Kubernetes Grid is a Kubernetes platform provided by **VMware** and maintained as part of the **VMware on OVHcloud** solution. - -You can install this product on your OVHcloud infrastructure to take advantage of its features and scalability. - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/es-es/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- A VLAN with internet access and a DHCP server -- You must have these resources: - - 8 GB of memory, 4 vCPUs, and 250 GB of storage for the management virtual machine named **Bootstrap**. - - 16 GB of memory, 4 vCPU, 40 GB of storage per Kubernetes node (it takes 6 nodes to install the management cluster in production mode and 6 nodes per **Workload** cluster in the same mode). - -## Instructions - -We will install **VMware Tanzu Kubernetes Grid** on a **VMware on OVHcloud** cluster and use VLAN 10 with these settings: - -- **LAN**: `192.168.0.0/24`. -- **DHCP Range**: `192.168.0.50 -> 192.168.0.100`. -- **Gateway**: `192.168.0.254`. - -> [!primary] -> This information is given as an example, it is quite possible to use another range and another VLAN. -> - -At the end of the installation, seven additional virtual machines will be on your VMware cluster, six for running the **TKG** management cluster and one for managing it. - -![00 admin cluster diagram](images/00-admin-cluster-diagram01.png){.thumbnail} - -### Importing OVA model for **Tanzu KUBERNETES Grid** into your infrastructure - -VMware provides a virtual machine as an OVA template, which contains all the elements to run a node of the **Tanzu Kubernetes Grid** cluster. This virtual machine is available in **OVH Templates**. - -Log in to the OVHcloud homepage for your VMware cluster, and click `OVH Templates`{.action} to the right. - -![01 integrate TKGM OVA 01](images/01-integrate-tkgm-ova01.png){.thumbnail} - -In the **Select a template** window, choose the fourth template from the top that has this information: - -- **Family**: Linux -- **Distribution**: not specified -- **Version**: 3 - -![01 integrate TKGM OVA 02](images/01-integrate-tkgm-ova02.png){.thumbnail} - -Click the `Copy`{.action} icon to the right to copy the URL which name must end in **photon-3-kube-v1.23.8+vmware.1.ovf**. Then click `Close`{.action}. - -![01 integrate TKGM OVA 03](images/01-integrate-tkgm-ova03.png){.thumbnail} - -Log in to your vSphere console, right-click your cluster and choose `Deploy an OVF Template`{.action}. - -![01 integrate TKGM OVA 03b](images/01-integrate-tkgm-ova03b.png){.thumbnail} - -Select `URL`{.action}, paste the previously copied URL and click `NEXT`{.action}. - -![01 integrate TKGM OVA 04](images/01-integrate-tkgm-ova04.png){.thumbnail} - -Leave the default location and click `NEXT`{.action}. - -![01 integrate TKGM OVA 05](images/01-integrate-tkgm-ova05.png){.thumbnail} - -Choose the cluster and click `NEXT`{.action}. - -![01 integrate TKGM OVA 06](images/01-integrate-tkgm-ova06.png){.thumbnail} - -Review your information and click `NEXT`{.action}. - -![01 integrate TKGM OVA 07](images/01-integrate-tkgm-ova07.png){.thumbnail} - -Check `I accept all licence agreements`{.action} and click `NEXT`{.action}. - -![01 integrate TKGM OVA 08](images/01-integrate-tkgm-ova08.png){.thumbnail} - -Select a shared storage in NFS v3, then click `NEXT`{.action}. - -![01 integrate TKGM OVA 09](images/01-integrate-tkgm-ova09.png){.thumbnail} - -Choose the destination network on `VLAN 10`{.action} and click `NEXT`{.action}. - -![01 integrate TKGM OVA 10](images/01-integrate-tkgm-ova10.png){.thumbnail} - -Click `FINISH`{.action}. - -![01 integrate TKGM OVA 11](images/01-integrate-tkgm-ova11.png){.thumbnail} - -Select the `Monitor`{.action} tab and click `Tasks`{.action}. - -![01 integrate TKGM OVA 12](images/01-integrate-tkgm-ova12.png){.thumbnail} - -Wait for the `Deploy OVF template` and `Import OVF package` tasks to complete. - -![01 integrate TKGM OVA 13](images/01-integrate-tkgm-ova13.png){.thumbnail} - -Right-click the deployed VM and choose `Convert to Template`{.action} from the `Template`{.action} menu. - -![01 integrate TKGM OVA 14](images/01-integrate-tkgm-ova14.png){.thumbnail} - -Answer `YES`{.action} to convert the virtual machine. - -![01 integrate TKGM OVA 15](images/01-integrate-tkgm-ova15.png){.thumbnail} - -Go to `Virtual Machines (and templates)`{.action} to see the template you have created. - -> [!primary] -> -> This template will be used when deploying **Tanzu Kubernetes Grid** clusters. It is used for the initial deployment of the administration cluster and for the installation of additional *WorkLoad* clusters. It should not be deleted from the **VMware** cluster. -> - -![01 integrate TKGM OVA 16](images/01-integrate-tkgm-ova16.png){.thumbnail} - -### Installation of the virtual machine **Bootstrap** provided by OVHcloud - -This virtual machine was created by OVHcloud from the documentation [Installing the CLI tool manually for deploying **Tanzu Kubernetes GRID**](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html). It is available as a template in **OVH Templates**. - -Log in to the OVHcloud homepage for your VMware cluster, and click `OVH Templates`{.action} to the right. - -![02 Add Bootstrapvm 01](images/02-add-bootstrap-vm-from-ova01.png){.thumbnail} - -In the **Select a template** window, choose the third template from the top that contains this information: - -- **Family**: Linux -- **Distribution**: Ubuntu -- **Version**: 22 - -![02 Add Bootstrapvm 02](images/02-add-bootstrap-vm-from-ova02.png){.thumbnail} - -Click the `Copy`{.action} icon to the right to copy the URL, the URL should end with **Ubuntu-22.04_TKGm-1.6_with_x.ovf**. Then click `Close`{.action}. - -![02 Add Bootstrapvm 03](images/02-add-bootstrap-vm-from-ova03.png){.thumbnail} - -In the vSphere interface, right-click the cluster and choose `Deploy an OVF Template`{.action} from the menu. - -![02 Add Bootstrapvm 03b](images/02-add-bootstrap-vm-from-ova03b.png){.thumbnail} - -Select `URL`{.action}, paste the previously copied URL and click `NEXT`{.action}. - -![02 Add Bootstrapvm 04](images/02-add-bootstrap-vm-from-ova04.png){.thumbnail} - -Leave the default positioning and click `NEXT`{.action}. - -![02 Add Bootstrapvm 05](images/02-add-bootstrap-vm-from-ova05.png){.thumbnail} - -Leave `Cluster1` and click `NEXT`{.action}. - -![02 Add Bootstrapvm 06](images/02-add-bootstrap-vm-from-ova06.png){.thumbnail} - -Click `NEXT`{.action} to validate your choices. - -![02 Add Bootstrapvm 07](images/02-add-bootstrap-vm-from-ova07.png){.thumbnail} - -Select a shared storage in NFS v3 and click `NEXT`{.action}. - -![02 Add Bootstrapvm 08](images/02-add-bootstrap-vm-from-ova08.png){.thumbnail} - -Choose `VLAN10` for the destination network and click `NEXT`{.action}. - -![02 Add Bootstrapvm 09](images/02-add-bootstrap-vm-from-ova09.png){.thumbnail} - -Add this information in **Networking**: - -- **Hostname**: `bootstrap` -- **IP Address**: `192.168.0.199` -- **Network CIDR Prefix**: `24` -- **Gateway**: `192.168.0.254` -- **DNS**: `213.186.33.99` - -> [!primary] -> -> The DNS server chosen in this guide is the OVHcloud server. -> - -Enter and confirm the password in **OS Credentials** and click `NEXT`{.action}. - -![02 Add Bootstrapvm 10](images/02-add-bootstrap-vm-from-ova10.png){.thumbnail} - -Click `FINISH`{.action}. - -![02 Add Bootstrapvm 11](images/02-add-bootstrap-vm-from-ova11.png){.thumbnail} - -Right-click the virtual machine you created, go to `Power`{.action} and click `Power On`{.action}. - -![02 Add Bootstrapvm 12](images/02-add-bootstrap-vm-from-ova12.png){.thumbnail} - -The booted virtual machine can be accessed via the console with the graphical interface or via **SSH**. - -Go to the virtual machine you have created, and click `LAUNCH WEB CONSOLE`{.action}. - -![02 Add Bootstrapvm 13](images/02-add-bootstrap-vm-from-ova13.png){.thumbnail} - -The graphical interface for the Linux virtual machine is then available. - -![02 Add Bootstrapvm 14](images/02-add-bootstrap-vm-from-ova14.png){.thumbnail} - -### Allowing access to the PCC cluster from the **Bootstrap** virtual machine - -The configuration and administration tools for **Tanzu Kubernetes Grid** are installed on the **Bootstrap** virtual machine. This virtual machine must be able to connect to the Internet and to the vSphere cluster. - -Write down **the public IP address** you use on this virtual machine and use this guide [Authorise IP addresses to connect to vCenter](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/autoriser_des_ip_a_se_connecter_au_vcenter) to grant access to the vSphere cluster to the new virtual machine. - -### Deploying the **Tanzu Kubernetes Grid** cluster on your infrastructure - -Log in to the `Ubuntu-22.04_TKGm-1.5.4_with_x` virtual machine, open a terminal, and run this command to create an **RSA** key: - -```bash -ssh-keygen -t rsa -b 4096 -C "youremail@yourdomain.com" -``` - -![03 Create TKG CLUSTER 01](images/03-create-tkg-cluster01.png){.thumbnail} - -Two files are created in the **~/.ssh** folder: - -- **id_rsa.pub** -- **id_rsa** - -Stay on the console and run this command: - -```bash -tanzu management-cluster create --ui --bind 192.168.0.199:8080 -``` - -> [!primary] -> -> When you run this command from the Linux console with the graphical interface, the web browser launches and connects to `https://192.168.0.199:8080`. If you have run this command from an **SSH** connection, you will need to connect to `https://192.168.0.199:8080` from a virtual machine on the same network with a graphical interface and an operational web browser. -> - -![03 Create TKG CLUSTER 02](images/03-create-tkg-cluster02.png){.thumbnail} - -Click `Deploy`{.action} below **VMware vSphere**. - -![03 Create TKG CLUSTER 03](images/03-create-tkg-cluster03.png){.thumbnail} - -Enter this information: - -- **VCENTER SERVER**: `VMware cluster FQDN` -- **USERNAME**: `VMware cluster user` -- **PASSWORD**: `VMware cluster user password` - -Then click `CONNECT`{.action}. - -![03 Create TKG CLUSTER 04](images/03-create-tkg-cluster04.png){.thumbnail} - -At the verification step of the **SSL Thumbprint**, click `CONTINUE`{.action}. - -![03 Create TKG CLUSTER 05](images/03-create-tkg-cluster05.png){.thumbnail} - -Click the cross in the top right to close the **vSphere 7.0.3 Environment Detected** window. - -![03 Create TKG CLUSTER 06](images/03-create-tkg-cluster06.png){.thumbnail} - -Paste the contents of the **~.ssh/id_rsa.pub** file into **SSH PUBLIC KEY** and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 07](images/03-create-tkg-cluster07.png){.thumbnail} - -Select `Production`{.action} on the right and select the `large etc...` **INSTANCE TYPE**. - -Enter these values: - -- **MANAGEMENT CLUSTER NAME (OPTIONAL)**: `tkgm-management-cluster`. -- **CONTROL PLANE ENDPOINT**: `192.168.0.10`. - -Click `NEXT`{.action} to proceed to the next step. - -![03 Create TKG CLUSTER 08](images/03-create-tkg-cluster08.png){.thumbnail} - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 09](images/03-create-tkg-cluster09.png){.thumbnail} - -In the **Metadata** option and then in the **LABELS (OPTIONAL)** section, type `tkgm` for the name and its value. - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 10](images/03-create-tkg-cluster10.png){.thumbnail} - -Enter these options: - -- **VM FOLDER**: `Storage folder for virtual machines`. -- **DATASTORE**: `Storage of virtual machines to be placed on a shared storage` . -- **CLUSTERS, HOSTS, AND RESOURCE POOLS**: `Cluster1`. - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 11](images/03-create-tkg-cluster11.png){.thumbnail} - -In **NETWORK NAME** select `VLAN10`{.action}. - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 12](images/03-create-tkg-cluster12.png){.thumbnail} - -Disable the `Activate Identity Management Settings`{.action} option and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 13](images/03-create-tkg-cluster13.png){.thumbnail} - -Select the OVA image integrated into the `photon-3-kube-v1.22.9+vmware.1` cluster from the **OS Image** menu and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 14](images/03-create-tkg-cluster14.png){.thumbnail} - -Uncheck `Participate in the Customer Experience Improvement Program`{.action} and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 15](images/03-create-tkg-cluster15.png){.thumbnail} - -Click `REVIEW CONFIGURATION`{.action}. - -![03 Create TKG CLUSTER 16](images/03-create-tkg-cluster16.png){.thumbnail} - -> [!primary] -> Take note of the name of the yaml file below **CLI Command Equivalent**, it will serve as a template for deploying a **WorkLoad** cluster. -> - -Scroll through the window and click `DEPLOY MANAGEMENT CLUSTER`{.action} - -![03 Create TKG CLUSTER 17](images/03-create-tkg-cluster17.png){.thumbnail} - -The **Tanzu Kubernetes Grid** cluster deployment is started, please wait for it to complete. - -> [!primary] -> The deployment will be completed when you see the **Management cluster created** and **Successfully installed all required plugins** messages in the window. -> -> ![03 Create TKG CLUSTER 18](images/03-create-tkg-cluster18.png){.thumbnail} -> -> Another indication that the installation is complete can be found in the console of the **Bootstrap** virtual machine in which will appear the **Management cluster created** and **You can now create your first workload cluster etc...** messages. - -> [!warning] -> -> Write down or copy the name of the **yaml** file in the `/home/tanzu/.config/tanzu/tkg/clusterconfigs` folder, it will be used to create a configuration file for installing a *WorkLoad cluster* -> - -![03 Create TKG CLUSTER 19](images/03-create-tkg-cluster19.png){.thumbnail} - -Go to the vCenter interface to see the seven virtual machines created. - -![04 VM CREATED ADFTER INSTALLATION 01](images/04-vm-created-after-installation01.png){.thumbnail} - -## Go further - -[Administrating a TKG cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) - -[Introducing VMware Tanzu Kubernetes Grid](https://tanzu.vmware.com/kubernetes-grid) - -[Documentation de VMware Tanzu Kubenetes Grid](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/guide.es-us.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/guide.es-us.md deleted file mode 100644 index ab481f1832e..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/guide.es-us.md +++ /dev/null @@ -1,366 +0,0 @@ ---- -title: Instalación de Tanzu Kubernetes Grid (EN) -excerpt: Learn how to integrate Tanzu Kubernetes Grid into your VMware on OVHcloud infrastructure -updated: 2022-11-10 ---- - -## Objective - -**This guide documents how to install Tanzu Kubernetes Grid on your VMware on OVHcloud cluster** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Introduction - -VMware Tanzu Kubernetes Grid is a Kubernetes platform provided by **VMware** and maintained as part of the **VMware on OVHcloud** solution. - -You can install this product on your OVHcloud infrastructure to take advantage of its features and scalability. - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/es/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- A VLAN with internet access and a DHCP server -- You must have these resources: - - 8 GB of memory, 4 vCPUs, and 250 GB of storage for the management virtual machine named **Bootstrap**. - - 16 GB of memory, 4 vCPU, 40 GB of storage per Kubernetes node (it takes 6 nodes to install the management cluster in production mode and 6 nodes per **Workload** cluster in the same mode). - -## Instructions - -We will install **VMware Tanzu Kubernetes Grid** on a **VMware on OVHcloud** cluster and use VLAN 10 with these settings: - -- **LAN**: `192.168.0.0/24`. -- **DHCP Range**: `192.168.0.50 -> 192.168.0.100`. -- **Gateway**: `192.168.0.254`. - -> [!primary] -> This information is given as an example, it is quite possible to use another range and another VLAN. -> - -At the end of the installation, seven additional virtual machines will be on your VMware cluster, six for running the **TKG** management cluster and one for managing it. - -![00 admin cluster diagram](images/00-admin-cluster-diagram01.png){.thumbnail} - -### Importing OVA model for **Tanzu KUBERNETES Grid** into your infrastructure - -VMware provides a virtual machine as an OVA template, which contains all the elements to run a node of the **Tanzu Kubernetes Grid** cluster. This virtual machine is available in **OVH Templates**. - -Log in to the OVHcloud homepage for your VMware cluster, and click `OVH Templates`{.action} to the right. - -![01 integrate TKGM OVA 01](images/01-integrate-tkgm-ova01.png){.thumbnail} - -In the **Select a template** window, choose the fourth template from the top that has this information: - -- **Family**: Linux -- **Distribution**: not specified -- **Version**: 3 - -![01 integrate TKGM OVA 02](images/01-integrate-tkgm-ova02.png){.thumbnail} - -Click the `Copy`{.action} icon to the right to copy the URL which name must end in **photon-3-kube-v1.23.8+vmware.1.ovf**. Then click `Close`{.action}. - -![01 integrate TKGM OVA 03](images/01-integrate-tkgm-ova03.png){.thumbnail} - -Log in to your vSphere console, right-click your cluster and choose `Deploy an OVF Template`{.action}. - -![01 integrate TKGM OVA 03b](images/01-integrate-tkgm-ova03b.png){.thumbnail} - -Select `URL`{.action}, paste the previously copied URL and click `NEXT`{.action}. - -![01 integrate TKGM OVA 04](images/01-integrate-tkgm-ova04.png){.thumbnail} - -Leave the default location and click `NEXT`{.action}. - -![01 integrate TKGM OVA 05](images/01-integrate-tkgm-ova05.png){.thumbnail} - -Choose the cluster and click `NEXT`{.action}. - -![01 integrate TKGM OVA 06](images/01-integrate-tkgm-ova06.png){.thumbnail} - -Review your information and click `NEXT`{.action}. - -![01 integrate TKGM OVA 07](images/01-integrate-tkgm-ova07.png){.thumbnail} - -Check `I accept all licence agreements`{.action} and click `NEXT`{.action}. - -![01 integrate TKGM OVA 08](images/01-integrate-tkgm-ova08.png){.thumbnail} - -Select a shared storage in NFS v3, then click `NEXT`{.action}. - -![01 integrate TKGM OVA 09](images/01-integrate-tkgm-ova09.png){.thumbnail} - -Choose the destination network on `VLAN 10`{.action} and click `NEXT`{.action}. - -![01 integrate TKGM OVA 10](images/01-integrate-tkgm-ova10.png){.thumbnail} - -Click `FINISH`{.action}. - -![01 integrate TKGM OVA 11](images/01-integrate-tkgm-ova11.png){.thumbnail} - -Select the `Monitor`{.action} tab and click `Tasks`{.action}. - -![01 integrate TKGM OVA 12](images/01-integrate-tkgm-ova12.png){.thumbnail} - -Wait for the `Deploy OVF template` and `Import OVF package` tasks to complete. - -![01 integrate TKGM OVA 13](images/01-integrate-tkgm-ova13.png){.thumbnail} - -Right-click the deployed VM and choose `Convert to Template`{.action} from the `Template`{.action} menu. - -![01 integrate TKGM OVA 14](images/01-integrate-tkgm-ova14.png){.thumbnail} - -Answer `YES`{.action} to convert the virtual machine. - -![01 integrate TKGM OVA 15](images/01-integrate-tkgm-ova15.png){.thumbnail} - -Go to `Virtual Machines (and templates)`{.action} to see the template you have created. - -> [!primary] -> -> This template will be used when deploying **Tanzu Kubernetes Grid** clusters. It is used for the initial deployment of the administration cluster and for the installation of additional *WorkLoad* clusters. It should not be deleted from the **VMware** cluster. -> - -![01 integrate TKGM OVA 16](images/01-integrate-tkgm-ova16.png){.thumbnail} - -### Installation of the virtual machine **Bootstrap** provided by OVHcloud - -This virtual machine was created by OVHcloud from the documentation [Installing the CLI tool manually for deploying **Tanzu Kubernetes GRID**](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html). It is available as a template in **OVH Templates**. - -Log in to the OVHcloud homepage for your VMware cluster, and click `OVH Templates`{.action} to the right. - -![02 Add Bootstrapvm 01](images/02-add-bootstrap-vm-from-ova01.png){.thumbnail} - -In the **Select a template** window, choose the third template from the top that contains this information: - -- **Family**: Linux -- **Distribution**: Ubuntu -- **Version**: 22 - -![02 Add Bootstrapvm 02](images/02-add-bootstrap-vm-from-ova02.png){.thumbnail} - -Click the `Copy`{.action} icon to the right to copy the URL, the URL should end with **Ubuntu-22.04_TKGm-1.6_with_x.ovf**. Then click `Close`{.action}. - -![02 Add Bootstrapvm 03](images/02-add-bootstrap-vm-from-ova03.png){.thumbnail} - -In the vSphere interface, right-click the cluster and choose `Deploy an OVF Template`{.action} from the menu. - -![02 Add Bootstrapvm 03b](images/02-add-bootstrap-vm-from-ova03b.png){.thumbnail} - -Select `URL`{.action}, paste the previously copied URL and click `NEXT`{.action}. - -![02 Add Bootstrapvm 04](images/02-add-bootstrap-vm-from-ova04.png){.thumbnail} - -Leave the default positioning and click `NEXT`{.action}. - -![02 Add Bootstrapvm 05](images/02-add-bootstrap-vm-from-ova05.png){.thumbnail} - -Leave `Cluster1` and click `NEXT`{.action}. - -![02 Add Bootstrapvm 06](images/02-add-bootstrap-vm-from-ova06.png){.thumbnail} - -Click `NEXT`{.action} to validate your choices. - -![02 Add Bootstrapvm 07](images/02-add-bootstrap-vm-from-ova07.png){.thumbnail} - -Select a shared storage in NFS v3 and click `NEXT`{.action}. - -![02 Add Bootstrapvm 08](images/02-add-bootstrap-vm-from-ova08.png){.thumbnail} - -Choose `VLAN10` for the destination network and click `NEXT`{.action}. - -![02 Add Bootstrapvm 09](images/02-add-bootstrap-vm-from-ova09.png){.thumbnail} - -Add this information in **Networking**: - -- **Hostname**: `bootstrap` -- **IP Address**: `192.168.0.199` -- **Network CIDR Prefix**: `24` -- **Gateway**: `192.168.0.254` -- **DNS**: `213.186.33.99` - -> [!primary] -> -> The DNS server chosen in this guide is the OVHcloud server. -> - -Enter and confirm the password in **OS Credentials** and click `NEXT`{.action}. - -![02 Add Bootstrapvm 10](images/02-add-bootstrap-vm-from-ova10.png){.thumbnail} - -Click `FINISH`{.action}. - -![02 Add Bootstrapvm 11](images/02-add-bootstrap-vm-from-ova11.png){.thumbnail} - -Right-click the virtual machine you created, go to `Power`{.action} and click `Power On`{.action}. - -![02 Add Bootstrapvm 12](images/02-add-bootstrap-vm-from-ova12.png){.thumbnail} - -The booted virtual machine can be accessed via the console with the graphical interface or via **SSH**. - -Go to the virtual machine you have created, and click `LAUNCH WEB CONSOLE`{.action}. - -![02 Add Bootstrapvm 13](images/02-add-bootstrap-vm-from-ova13.png){.thumbnail} - -The graphical interface for the Linux virtual machine is then available. - -![02 Add Bootstrapvm 14](images/02-add-bootstrap-vm-from-ova14.png){.thumbnail} - -### Allowing access to the PCC cluster from the **Bootstrap** virtual machine - -The configuration and administration tools for **Tanzu Kubernetes Grid** are installed on the **Bootstrap** virtual machine. This virtual machine must be able to connect to the Internet and to the vSphere cluster. - -Write down **the public IP address** you use on this virtual machine and use this guide [Authorise IP addresses to connect to vCenter](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/autoriser_des_ip_a_se_connecter_au_vcenter) to grant access to the vSphere cluster to the new virtual machine. - -### Deploying the **Tanzu Kubernetes Grid** cluster on your infrastructure - -Log in to the `Ubuntu-22.04_TKGm-1.5.4_with_x` virtual machine, open a terminal, and run this command to create an **RSA** key: - -```bash -ssh-keygen -t rsa -b 4096 -C "youremail@yourdomain.com" -``` - -![03 Create TKG CLUSTER 01](images/03-create-tkg-cluster01.png){.thumbnail} - -Two files are created in the **~/.ssh** folder: - -- **id_rsa.pub** -- **id_rsa** - -Stay on the console and run this command: - -```bash -tanzu management-cluster create --ui --bind 192.168.0.199:8080 -``` - -> [!primary] -> -> When you run this command from the Linux console with the graphical interface, the web browser launches and connects to `https://192.168.0.199:8080`. If you have run this command from an **SSH** connection, you will need to connect to `https://192.168.0.199:8080` from a virtual machine on the same network with a graphical interface and an operational web browser. -> - -![03 Create TKG CLUSTER 02](images/03-create-tkg-cluster02.png){.thumbnail} - -Click `Deploy`{.action} below **VMware vSphere**. - -![03 Create TKG CLUSTER 03](images/03-create-tkg-cluster03.png){.thumbnail} - -Enter this information: - -- **VCENTER SERVER**: `VMware cluster FQDN` -- **USERNAME**: `VMware cluster user` -- **PASSWORD**: `VMware cluster user password` - -Then click `CONNECT`{.action}. - -![03 Create TKG CLUSTER 04](images/03-create-tkg-cluster04.png){.thumbnail} - -At the verification step of the **SSL Thumbprint**, click `CONTINUE`{.action}. - -![03 Create TKG CLUSTER 05](images/03-create-tkg-cluster05.png){.thumbnail} - -Click the cross in the top right to close the **vSphere 7.0.3 Environment Detected** window. - -![03 Create TKG CLUSTER 06](images/03-create-tkg-cluster06.png){.thumbnail} - -Paste the contents of the **~.ssh/id_rsa.pub** file into **SSH PUBLIC KEY** and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 07](images/03-create-tkg-cluster07.png){.thumbnail} - -Select `Production`{.action} on the right and select the `large etc...` **INSTANCE TYPE**. - -Enter these values: - -- **MANAGEMENT CLUSTER NAME (OPTIONAL)**: `tkgm-management-cluster`. -- **CONTROL PLANE ENDPOINT**: `192.168.0.10`. - -Click `NEXT`{.action} to proceed to the next step. - -![03 Create TKG CLUSTER 08](images/03-create-tkg-cluster08.png){.thumbnail} - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 09](images/03-create-tkg-cluster09.png){.thumbnail} - -In the **Metadata** option and then in the **LABELS (OPTIONAL)** section, type `tkgm` for the name and its value. - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 10](images/03-create-tkg-cluster10.png){.thumbnail} - -Enter these options: - -- **VM FOLDER**: `Storage folder for virtual machines`. -- **DATASTORE**: `Storage of virtual machines to be placed on a shared storage` . -- **CLUSTERS, HOSTS, AND RESOURCE POOLS**: `Cluster1`. - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 11](images/03-create-tkg-cluster11.png){.thumbnail} - -In **NETWORK NAME** select `VLAN10`{.action}. - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 12](images/03-create-tkg-cluster12.png){.thumbnail} - -Disable the `Activate Identity Management Settings`{.action} option and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 13](images/03-create-tkg-cluster13.png){.thumbnail} - -Select the OVA image integrated into the `photon-3-kube-v1.22.9+vmware.1` cluster from the **OS Image** menu and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 14](images/03-create-tkg-cluster14.png){.thumbnail} - -Uncheck `Participate in the Customer Experience Improvement Program`{.action} and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 15](images/03-create-tkg-cluster15.png){.thumbnail} - -Click `REVIEW CONFIGURATION`{.action}. - -![03 Create TKG CLUSTER 16](images/03-create-tkg-cluster16.png){.thumbnail} - -> [!primary] -> Take note of the name of the yaml file below **CLI Command Equivalent**, it will serve as a template for deploying a **WorkLoad** cluster. -> - -Scroll through the window and click `DEPLOY MANAGEMENT CLUSTER`{.action} - -![03 Create TKG CLUSTER 17](images/03-create-tkg-cluster17.png){.thumbnail} - -The **Tanzu Kubernetes Grid** cluster deployment is started, please wait for it to complete. - -> [!primary] -> The deployment will be completed when you see the **Management cluster created** and **Successfully installed all required plugins** messages in the window. -> -> ![03 Create TKG CLUSTER 18](images/03-create-tkg-cluster18.png){.thumbnail} -> -> Another indication that the installation is complete can be found in the console of the **Bootstrap** virtual machine in which will appear the **Management cluster created** and **You can now create your first workload cluster etc...** messages. - -> [!warning] -> -> Write down or copy the name of the **yaml** file in the `/home/tanzu/.config/tanzu/tkg/clusterconfigs` folder, it will be used to create a configuration file for installing a *WorkLoad cluster* -> - -![03 Create TKG CLUSTER 19](images/03-create-tkg-cluster19.png){.thumbnail} - -Go to the vCenter interface to see the seven virtual machines created. - -![04 VM CREATED ADFTER INSTALLATION 01](images/04-vm-created-after-installation01.png){.thumbnail} - -## Go further - -[Administrating a TKG cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) - -[Introducing VMware Tanzu Kubernetes Grid](https://tanzu.vmware.com/kubernetes-grid) - -[Documentation de VMware Tanzu Kubenetes Grid](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/guide.fr-ca.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/guide.fr-ca.md deleted file mode 100644 index a69403f2520..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/guide.fr-ca.md +++ /dev/null @@ -1,366 +0,0 @@ ---- -title: Installer Tanzu Kubernetes Grid -excerpt: Intégrer Tanzu Kubernetes Grid à votre infrastructure VMware on OVHcloud -updated: 2022-11-10 ---- - -## Objectif - -**Ce guide vous permet d'installer Tanzu Kubernetes Grid sur votre cluster VMware on OVHcloud** - -> [!warning] -> OVHcloud vous met à disposition des services dont la configuration, la gestion et la responsabilité vous incombent. Il vous appartient donc de ce fait d’en assurer le bon fonctionnement. -> -> Ce guide a pour but de vous accompagner au mieux sur des tâches courantes. Néanmoins, nous vous recommandons de faire appel à un [prestataire spécialisé](https://partner.ovhcloud.com/fr/) si vous éprouvez des difficultés ou des doutes concernant l’administration, l’utilisation ou la mise en place d’un service sur un serveur. -> - -## Présentation - -VMware Tanzu Kubernetes Grid est une plate-forme Kubernetes fournie par **VMware** et maintenue dans le cadre du support **VMware on OVHcloud**. - -Vous pouvez installer ce produit sur votre infrastructure OVHcloud pour profiter de ses fonctionnalités et de son évolutivité. - -## Prérequis - -- Être contact administrateur de l'infrastructure [Hosted Private Cloud](https://www.ovhcloud.com/fr-ca/enterprise/products/hosted-private-cloud/), afin de recevoir les identifiants de connexion. -- Avoir un identifiant actif dans l'[espace client OVHcloud](/links/manager) -- Avoir un identifiant actif dans vSphere. -- Avoir un VLAN qui possède un accès à Internet et un serveur DHCP. -- Disposer de ces ressources : - - 8 Go de mémoire, 4 vCPU et 250 Go de stockage pour la machine virtuelle d'administration nommmée **Bootstrap**. - - 16 Go de mémoire, 4 vCPU, 40 Go de stockage par nœud Kubernetes (il faut 6 nœuds pour une installation du cluster d'administration en mode production et 6 nœuds par cluster de **Workload** dans le même mode). - -## En pratique - -Nous allons installer **VMware Tanzu Kubernetes Grid** sur un cluster **VMware on OVHcloud** et utiliser le VLAN 10 avec ces paramètres : - -- **LAN** : `192.168.0.0/24`. -- **Plage DHCP** : `192.168.0.50 -> 192.168.0.100`. -- **Passerelle** : `192.168.0.254`. - -> [!primary] -> Ces informations sont données à titre d'exemple, il est tout à fait possible d'utiliser une autre plage et un autre VLAN. -> - -A la fin de l'installation, sept machines virtuelles supplémentaires seront sur votre cluster VMware, six pour le fonctionnement du cluster d'administration **TKG** et une autre pour son administration. - -![00 admin cluster diagram](images/00-admin-cluster-diagram01.png){.thumbnail} - -### Importation du modèle OVA pour **Tanzu KUBERNETES Grid** dans votre infrastructure - -VMware fournit une machine virtuelle sous forme de modèle OVA, qui contient tous les éléments pour faire fonctionner un nœud du cluster **Tanzu Kubernetes Grid**. Cette machine virtuelle est disponible dans les **OVH Templates** d'OVHcloud. - -Connectez-vous à la page d'accueil OVHcloud de votre cluster VMware et cliquez à droite sur `OVH Templates`{.action}. - -![01 integrate TKGM OVA 01](images/01-integrate-tkgm-ova01.png){.thumbnail} - -Dans la fenêtre **Select a template**, choisissez le quatrième modèle en partant du haut qui a ces informations : - -- **Family** : Linux -- **Distribution** : Information non indiquée -- **Version** : 3 - -![01 integrate TKGM OVA 02](images/01-integrate-tkgm-ova02.png){.thumbnail} - -Cliquez sur l'icône `Copier`{.action} à droite pour copier l'URL dont le nom doit se terminer par **photon-3-kube-v1.23.8+vmware.1.ovf** dans le presse-papier. Cliquez ensuite sur `Close`{.action}. - -![01 integrate TKGM OVA 03](images/01-integrate-tkgm-ova03.png){.thumbnail} - -Connectez-vous à votre console vSphere, faites un clic-droit sur votre cluster et choisissez `Déployer un modèle OVF`{.action}. - -![01 integrate TKGM OVA 03b](images/01-integrate-tkgm-ova03b.png){.thumbnail} - -Sélectionnez `URL`{.action}, collez l'URL précédemment copiée et cliquez sur `SUIVANT`{.action}. - -![01 integrate TKGM OVA 04](images/01-integrate-tkgm-ova04.png){.thumbnail} - -Laissez l'emplacement par défaut et cliquez sur `SUIVANT`{.action}. - -![01 integrate TKGM OVA 05](images/01-integrate-tkgm-ova05.png){.thumbnail} - -Choisissez le cluster et cliquez sur `SUIVANT`{.action}. - -![01 integrate TKGM OVA 06](images/01-integrate-tkgm-ova06.png){.thumbnail} - -Vérifiez vos informations et cliquez sur `SUIVANT`{.action}. - -![01 integrate TKGM OVA 07](images/01-integrate-tkgm-ova07.png){.thumbnail} - -Cochez `J'accepte tous les contrats de licence`{.action} et cliquez sur `SUIVANT`{.action}. - -![01 integrate TKGM OVA 08](images/01-integrate-tkgm-ova08.png){.thumbnail} - -Sélectionnez un stockage partagé en NFS v3 puis cliquez sur `SUIVANT`{.action}. - -![01 integrate TKGM OVA 09](images/01-integrate-tkgm-ova09.png){.thumbnail} - -Choisissez le réseau de destination sur `VLAN 10`{.action} et cliquez sur `SUIVANT`{.action}. - -![01 integrate TKGM OVA 10](images/01-integrate-tkgm-ova10.png){.thumbnail} - -Cliquez sur `TERMINER`{.action}. - -![01 integrate TKGM OVA 11](images/01-integrate-tkgm-ova11.png){.thumbnail} - -Sélectionnez l'onglet `Surveiller`{.action} et cliquez sur `Tâches`{.action}. - -![01 integrate TKGM OVA 12](images/01-integrate-tkgm-ova12.png){.thumbnail} - -Attendez que les tâches `Déployer un modèle OVF` et `Importer un modèle OVF` soient terminées. - -![01 integrate TKGM OVA 13](images/01-integrate-tkgm-ova13.png){.thumbnail} - -Faites un clic-droit sur la machine virtuelle déployée et choisissez l'option `Convertir au modèle`{.action} depuis le menu `Modèle`{.action}. - -![01 integrate TKGM OVA 14](images/01-integrate-tkgm-ova14.png){.thumbnail} - -Répondez `OUI`{.action} pour convertir la machine virtuelle. - -![01 integrate TKGM OVA 15](images/01-integrate-tkgm-ova15.png){.thumbnail} - -Allez dans `Machines virtuelles (et modèles)`{.action} pour voir le modèle créé. - -> [!primary] -> -> Ce modèle sera utilisé lors du déploiement des clusters **Tanzu Kubernetes Grid**. Il sert pour le déploiement initial du cluster d'administration et pour l'installation de clusters de *WorkLoad* supplémentaires. il ne faut pas le supprimer du cluster **VMware**. -> - -![01 integrate TKGM OVA 16](images/01-integrate-tkgm-ova16.png){.thumbnail} - -### Installation de la machine virtuelle **Bootstrap** fournie par OVHcloud - -Cette machine virtuelle a été créée par OVHcloud à partir de la documentation « [Installation manuelle de l'outil CLI pour le déploiement de **Tanzu Kubernetes GRID**](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) ». Ele est disponible sous forme de modèle dans les **OVH Templates** d'OVHcloud. - -Connectez-vous à la page d'accueil OVHcloud de votre cluster VMware et cliquez à droite sur `OVH Templates`{.action}. - -![02 Add Bootstrapvm 01](images/02-add-bootstrap-vm-from-ova01.png){.thumbnail} - -Dans la fenêtre **Select a template**, choisissez le troisième modèle en partant du haut et qui contient ces informations : - -- **Family** : Linux -- **Distribution** : Ubuntu -- **Version** : 22 - -![02 Add Bootstrapvm 02](images/02-add-bootstrap-vm-from-ova02.png){.thumbnail} - -Cliquez sur l'icône `Copier`{.action} à droite pour copier dans le presse-papier l'URL qui doit se terminer par **Ubuntu-22.04_TKGm-1.6_with_x.ovf** . Cliquez ensuite sur `Close`{.action}. - -![02 Add Bootstrapvm 03](images/02-add-bootstrap-vm-from-ova03.png){.thumbnail} - -Dans l'interface vSphere, faites un clic-droit sur le cluster et choisissez `Déployer un modèle OVF`{.action} dans le menu contextuel. - -![02 Add Bootstrapvm 03b](images/02-add-bootstrap-vm-from-ova03b.png){.thumbnail} - -Sélectionnez `URL`{.action}, collez l'URL précédemment copiée et cliquez sur `SUIVANT`{.action}. - -![02 Add Bootstrapvm 04](images/02-add-bootstrap-vm-from-ova04.png){.thumbnail} - -Laissez le positionnement par défaut et cliquez sur `SUIVANT`{.action}. - -![02 Add Bootstrapvm 05](images/02-add-bootstrap-vm-from-ova05.png){.thumbnail} - -Gardez le `Cluster1` et cliquez sur `SUIVANT`{.action}. - -![02 Add Bootstrapvm 06](images/02-add-bootstrap-vm-from-ova06.png){.thumbnail} - -Cliquez sur `SUIVANT`{.action} pour valider les choix. - -![02 Add Bootstrapvm 07](images/02-add-bootstrap-vm-from-ova07.png){.thumbnail} - -Sélectionnez un stockage partagé en NFS v3 et cliquez sur `SUIVANT`{.action}. - -![02 Add Bootstrapvm 08](images/02-add-bootstrap-vm-from-ova08.png){.thumbnail} - -Choisissez `VLAN10` pour le réseau de destination et cliquez sur `SUIVANT`{.action}. - -![02 Add Bootstrapvm 09](images/02-add-bootstrap-vm-from-ova09.png){.thumbnail} - -Ajoutez ces informations dans **Networking** : - -- **Hostname** : `bootstrap` -- **IP Address** : `192.168.0.199` -- **Network CIDR Prefix** : `24` -- **Gateway** : `192.168.0.254` -- **DNS** : `213.186.33.99` - -> [!primary] -> -> Le serveur DNS choisi dans ce guide est celui d'OVHcloud. -> - -Saisissez et confirmez le mot de passe dans **OS Credentials** et cliquez sur `SUIVANT`{.action}. - -![02 Add Bootstrapvm 10](images/02-add-bootstrap-vm-from-ova10.png){.thumbnail} - -Cliquez sur `TERMINER`{.action}. - -![02 Add Bootstrapvm 11](images/02-add-bootstrap-vm-from-ova11.png){.thumbnail} - -Faites un clic-droit sur la machine virtuelle créée, allez dans `Alimentation`{.action} et cliquez sur `Mettre sous tension`{.action}. - -![02 Add Bootstrapvm 12](images/02-add-bootstrap-vm-from-ova12.png){.thumbnail} - -La machine virtuelle démarrée est accessible via la console avec l'interface graphique ou en **SSH**. - -Positionnez-vous sur la machine virtuelle créée et cliquez sur `LANCER LA CONSOLE WEB`{.action}. - -![02 Add Bootstrapvm 13](images/02-add-bootstrap-vm-from-ova13.png){.thumbnail} - -L'interface graphique de la machine virtuelle Linux apparaît. - -![02 Add Bootstrapvm 14](images/02-add-bootstrap-vm-from-ova14.png){.thumbnail} - -### Autorisation d'accès au cluster PCC depuis la machine virtuelle **Bootstrap** - -Les outils de configuration et d'administration de **Tanzu Kubernetes Grid** sont installés sur la machine virtuelle **Bootstrap**. Cette machine virtuelle doit pouvoir se connecter à Internet et au cluster vSphere. - -Notez **l'adresse IP publique** que vous utilisez sur cette machine virtuelle et aidez-vous du guide « [Autoriser des adresses IP à se connecter au vCenter](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/autoriser_des_ip_a_se_connecter_au_vcenter) » pour donner accès au cluster vSphere depuis la nouvelle machine virtuelle. - -### Déploiement du cluster **Tanzu Kubernetes Grid** sur votre infrastructure - -Connectez-vous sur la machine virtuelle `Ubuntu-22.04_TKGm-1.5.4_with_x`, ouvrez un terminal et exécutez cette commande pour créer une clé **RSA** : - -```bash -ssh-keygen -t rsa -b 4096 -C "youremail@yourdomain.com" -``` - -![03 Create TKG CLUSTER 01](images/03-create-tkg-cluster01.png){.thumbnail} - -Deux fichiers sont créés dans le dossier **~/.ssh** : - -- **id_rsa.pub** -- **id_rsa** - -Restez sur la console et lancez cette commande : - -```bash -tanzu management-cluster create --ui --bind 192.168.0.199:8080 -``` - -> [!primary] -> -> Lorsque vous lancez cette commande depuis la console Linux avec l'interface graphique, le navigateur Web se lance et se connecte à l'adresse `https://192.168.0.199:8080`. Si vous avez lancé cette commande depuis une connexion **SSH**, il vous faudra vous connecter à l'adresse `https://192.168.0.199:8080` à partir d'une machine virtuelle qui se trouve sur le même réseau avec une interface graphique et un navigateur web opérationnel. -> - -![03 Create TKG CLUSTER 02](images/03-create-tkg-cluster02.png){.thumbnail} - -Cliquez sur `Deploy`{.action} en dessous de **VMware vSphere**. - -![03 Create TKG CLUSTER 03](images/03-create-tkg-cluster03.png){.thumbnail} - -Saisissez ces informations : - -- **VCENTER SERVER** : `nom FQDN du cluster VMware`. -- **USERNAME** : `utilisateur du cluster VMware`. -- **PASSWORD** : `mot de passe de l'utilisateur du cluster VMware`. - -Cliquez ensuite sur `CONNECT`{.action}. - -![03 Create TKG CLUSTER 04](images/03-create-tkg-cluster04.png){.thumbnail} - -A l'étape de vérification du **SSL Thumbprint**, cliquez sur `CONTINUE`{.action}. - -![03 Create TKG CLUSTER 05](images/03-create-tkg-cluster05.png){.thumbnail} - -Cliquez sur la croix en haut à droite pour fermer la fenêtre **vSphere 7.0.3 Environnement Detected**. - -![03 Create TKG CLUSTER 06](images/03-create-tkg-cluster06.png){.thumbnail} - -Collez le contenu du fichier **~.ssh/id_rsa.pub** dans **SSH PUBLIC KEY** et cliquez sur `NEXT`{.action}. - -![03 Create TKG CLUSTER 07](images/03-create-tkg-cluster07.png){.thumbnail} - -Choisissez à droite `Production`{.action} et sélectionnez l'option `large etc...` dans **INSTANCE TYPE** . - -Saisissez ces valeurs : - -- **MANAGEMEMENT CLUSTER NAME (OPTIONAL)** : `tkgm-management-cluster`. -- **CONTROL PLANE ENDPOINT** : `192.168.0.10`. - -Cliquez sur `NEXT`{.action} pour passer à l'étape suivante. - -![03 Create TKG CLUSTER 08](images/03-create-tkg-cluster08.png){.thumbnail} - -Cliquez sur `NEXT`{.action}. - -![03 Create TKG CLUSTER 09](images/03-create-tkg-cluster09.png){.thumbnail} - -Dans l'option **Metadata** puis dans la partie **LABELS (OPTIONAL)**, saisissez `tkgm` pour le nom et sa valeur. - -Cliquez sur `NEXT`{.action}. - -![03 Create TKG CLUSTER 10](images/03-create-tkg-cluster10.png){.thumbnail} - -Renseignez ces options : - -- **VM FOLDER** : `Dossier de rangement des machines virtuelles`. -- **DATASTORE** : `Stockage des machines virtuelles à mettre sur un stockage partagé`. -- **CLUSTERS , HOSTS, AND RESOURCE POOLS** : `Cluster1`. - -Cliquez sur `NEXT`{.action}. - -![03 Create TKG CLUSTER 11](images/03-create-tkg-cluster11.png){.thumbnail} - -Sélectionnez, dans **NETWORK NAME**, le `VLAN10`{.action}. - -Cliquez sur `NEXT`{.action}. - -![03 Create TKG CLUSTER 12](images/03-create-tkg-cluster12.png){.thumbnail} - -Désactivez l'option `Enable Identity Management Settings`{.action} et cliquez sur `NEXT`{.action}. - -![03 Create TKG CLUSTER 13](images/03-create-tkg-cluster13.png){.thumbnail} - -Sélectionnez l'image OVA intégrée au cluster `photon-3-kube-v1.22.9+vmware.1` dans le menu **OS Image** et cliquez sur `NEXT`{.action}. - -![03 Create TKG CLUSTER 14](images/03-create-tkg-cluster14.png){.thumbnail} - -Décochez `Participate in the Customer Experience Improvement Program`{.action} et cliquez sur `NEXT`{.action}. - -![03 Create TKG CLUSTER 15](images/03-create-tkg-cluster15.png){.thumbnail} - -Cliquez sur `REVIEW CONFIGURATION`{.action}. - -![03 Create TKG CLUSTER 16](images/03-create-tkg-cluster16.png){.thumbnail} - -> [!primary] -> Notez le nom du fichier yaml qui se trouve en dessous de **CLI Command Equivalent**, il servira de modèle pour le déploiement d'un cluster de **WorkLoad**. -> - -Faites défiler la fenêtre et cliquez sur `DEPLOY MANAGEMENT CLUSTER`{.action} - -![03 Create TKG CLUSTER 17](images/03-create-tkg-cluster17.png){.thumbnail} - -Le déploiement du cluster **Tanzu Kubernetes Grid** est lancé, patientez jusqu'à ce qu'il soit terminé. - -> [!primary] -> Le déploiement sera terminé lorsque vous verrez apparaitre dans la fenêtre les messages **Management cluster created** et **Successfully installed all required plugins**. -> -> ![03 Create TKG CLUSTER 18](images/03-create-tkg-cluster18.png){.thumbnail} -> -> Une autre indication qui signale que l'installation est terminée se trouve dans la console de la machine virtuelle de **Bootstrap** où apparaîtront les messages **Management cluster created** et **You can now create your first workload cluster etc...**. - -> [!warning] -> -> Notez ou copier le nom du fichier **yaml** qui se trouve dans le dossier `/home/tanzu/.config/tanzu/tkg/clusterconfigs`, il servira à la création d'un fichier de configuration pour l'installation d'un cluster de *WorkLoad* -> - -![03 Create TKG CLUSTER 19](images/03-create-tkg-cluster19.png){.thumbnail} - -Allez sur l'interface vCenter pour voir les sept machines virtuelles créées. - -![04 VM CREATED ADFTER INSTALLATION 01](images/04-vm-created-after-installation01.png){.thumbnail} - -## Aller plus loin - -[Administrer un cluster TKG](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) - -[Présentation de VMware Tanzu Kubernetes Grid](https://tanzu.vmware.com/kubernetes-grid) - -[Documentation de VMware Tanzu Kubenetes Grid](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Installation manuelle de l'outil CLI pour le déploiement de Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -Si vous avez besoin d'une formation ou d'une assistance technique pour la mise en oeuvre de nos solutions, contactez votre commercial ou cliquez sur [ce lien](/links/professional-services) pour obtenir un devis et demander une analyse personnalisée de votre projet à nos experts de l’équipe Professional Services. - -Échangez avec notre [communauté d'utilisateurs](/links/community). diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/guide.fr-fr.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/guide.fr-fr.md deleted file mode 100644 index f38a85c8be0..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/guide.fr-fr.md +++ /dev/null @@ -1,366 +0,0 @@ ---- -title: Installer Tanzu Kubernetes Grid -excerpt: Intégrer Tanzu Kubernetes Grid à votre infrastructure VMware on OVHcloud -updated: 2022-11-10 ---- - -## Objectif - -**Ce guide vous permet d'installer Tanzu Kubernetes Grid sur votre cluster VMware on OVHcloud** - -> [!warning] -> OVHcloud vous met à disposition des services dont la configuration, la gestion et la responsabilité vous incombent. Il vous appartient donc de ce fait d’en assurer le bon fonctionnement. -> -> Ce guide a pour but de vous accompagner au mieux sur des tâches courantes. Néanmoins, nous vous recommandons de faire appel à un [prestataire spécialisé](https://partner.ovhcloud.com/fr/) si vous éprouvez des difficultés ou des doutes concernant l’administration, l’utilisation ou la mise en place d’un service sur un serveur. -> - -## Présentation - -VMware Tanzu Kubernetes Grid est une plate-forme Kubernetes fournie par **VMware** et maintenue dans le cadre du support **VMware on OVHcloud**. - -Vous pouvez installer ce produit sur votre infrastructure OVHcloud pour profiter de ses fonctionnalités et de son évolutivité. - -## Prérequis - -- Être contact administrateur de l'infrastructure [Hosted Private Cloud](https://www.ovhcloud.com/fr/enterprise/products/hosted-private-cloud/), afin de recevoir les identifiants de connexion. -- Avoir un identifiant actif dans l'[espace client OVHcloud](/links/manager) -- Avoir un identifiant actif dans vSphere. -- Avoir un VLAN qui possède un accès à Internet et un serveur DHCP. -- Disposer de ces ressources : - - 8 Go de mémoire, 4 vCPU et 250 Go de stockage pour la machine virtuelle d'administration nommmée **Bootstrap**. - - 16 Go de mémoire, 4 vCPU, 40 Go de stockage par nœud Kubernetes (il faut 6 nœuds pour une installation du cluster d'administration en mode production et 6 nœuds par cluster de **Workload** dans le même mode). - -## En pratique - -Nous allons installer **VMware Tanzu Kubernetes Grid** sur un cluster **VMware on OVHcloud** et utiliser le VLAN 10 avec ces paramètres : - -- **LAN** : `192.168.0.0/24`. -- **Plage DHCP** : `192.168.0.50 -> 192.168.0.100`. -- **Passerelle** : `192.168.0.254`. - -> [!primary] -> Ces informations sont données à titre d'exemple, il est tout à fait possible d'utiliser une autre plage et un autre VLAN. -> - -A la fin de l'installation, sept machines virtuelles supplémentaires seront sur votre cluster VMware, six pour le fonctionnement du cluster d'administration **TKG** et une autre pour son administration. - -![00 admin cluster diagram](images/00-admin-cluster-diagram01.png){.thumbnail} - -### Importation du modèle OVA pour **Tanzu KUBERNETES Grid** dans votre infrastructure - -VMware fournit une machine virtuelle sous forme de modèle OVA, qui contient tous les éléments pour faire fonctionner un nœud du cluster **Tanzu Kubernetes Grid**. Cette machine virtuelle est disponible dans les **OVH Templates** d'OVHcloud. - -Connectez-vous à la page d'accueil OVHcloud de votre cluster VMware et cliquez à droite sur `OVH Templates`{.action}. - -![01 integrate TKGM OVA 01](images/01-integrate-tkgm-ova01.png){.thumbnail} - -Dans la fenêtre **Select a template**, choisissez le quatrième modèle en partant du haut qui a ces informations : - -- **Family** : Linux -- **Distribution** : Information non indiquée -- **Version** : 3 - -![01 integrate TKGM OVA 02](images/01-integrate-tkgm-ova02.png){.thumbnail} - -Cliquez sur l'icône `Copier`{.action} à droite pour copier l'URL dont le nom doit se terminer par **photon-3-kube-v1.23.8+vmware.1.ovf** dans le presse-papier. Cliquez ensuite sur `Close`{.action}. - -![01 integrate TKGM OVA 03](images/01-integrate-tkgm-ova03.png){.thumbnail} - -Connectez-vous à votre console vSphere, faites un clic-droit sur votre cluster et choisissez `Déployer un modèle OVF`{.action}. - -![01 integrate TKGM OVA 03b](images/01-integrate-tkgm-ova03b.png){.thumbnail} - -Sélectionnez `URL`{.action}, collez l'URL précédemment copiée et cliquez sur `SUIVANT`{.action}. - -![01 integrate TKGM OVA 04](images/01-integrate-tkgm-ova04.png){.thumbnail} - -Laissez l'emplacement par défaut et cliquez sur `SUIVANT`{.action}. - -![01 integrate TKGM OVA 05](images/01-integrate-tkgm-ova05.png){.thumbnail} - -Choisissez le cluster et cliquez sur `SUIVANT`{.action}. - -![01 integrate TKGM OVA 06](images/01-integrate-tkgm-ova06.png){.thumbnail} - -Vérifiez vos informations et cliquez sur `SUIVANT`{.action}. - -![01 integrate TKGM OVA 07](images/01-integrate-tkgm-ova07.png){.thumbnail} - -Cochez `J'accepte tous les contrats de licence`{.action} et cliquez sur `SUIVANT`{.action}. - -![01 integrate TKGM OVA 08](images/01-integrate-tkgm-ova08.png){.thumbnail} - -Sélectionnez un stockage partagé en NFS v3 puis cliquez sur `SUIVANT`{.action}. - -![01 integrate TKGM OVA 09](images/01-integrate-tkgm-ova09.png){.thumbnail} - -Choisissez le réseau de destination sur `VLAN 10`{.action} et cliquez sur `SUIVANT`{.action}. - -![01 integrate TKGM OVA 10](images/01-integrate-tkgm-ova10.png){.thumbnail} - -Cliquez sur `TERMINER`{.action}. - -![01 integrate TKGM OVA 11](images/01-integrate-tkgm-ova11.png){.thumbnail} - -Sélectionnez l'onglet `Surveiller`{.action} et cliquez sur `Tâches`{.action}. - -![01 integrate TKGM OVA 12](images/01-integrate-tkgm-ova12.png){.thumbnail} - -Attendez que les tâches `Déployer un modèle OVF` et `Importer un modèle OVF` soient terminées. - -![01 integrate TKGM OVA 13](images/01-integrate-tkgm-ova13.png){.thumbnail} - -Faites un clic-droit sur la machine virtuelle déployée et choisissez l'option `Convertir au modèle`{.action} depuis le menu `Modèle`{.action}. - -![01 integrate TKGM OVA 14](images/01-integrate-tkgm-ova14.png){.thumbnail} - -Répondez `OUI`{.action} pour convertir la machine virtuelle. - -![01 integrate TKGM OVA 15](images/01-integrate-tkgm-ova15.png){.thumbnail} - -Allez dans `Machines virtuelles (et modèles)`{.action} pour voir le modèle créé. - -> [!primary] -> -> Ce modèle sera utilisé lors du déploiement des clusters **Tanzu Kubernetes Grid**. Il sert pour le déploiement initial du cluster d'administration et pour l'installation de clusters de *WorkLoad* supplémentaires. il ne faut pas le supprimer du cluster **VMware**. -> - -![01 integrate TKGM OVA 16](images/01-integrate-tkgm-ova16.png){.thumbnail} - -### Installation de la machine virtuelle **Bootstrap** fournie par OVHcloud - -Cette machine virtuelle a été créée par OVHcloud à partir de la documentation « [Installation manuelle de l'outil CLI pour le déploiement de **Tanzu Kubernetes GRID**](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) ». Ele est disponible sous forme de modèle dans les **OVH Templates** d'OVHcloud. - -Connectez-vous à la page d'accueil OVHcloud de votre cluster VMware et cliquez à droite sur `OVH Templates`{.action}. - -![02 Add Bootstrapvm 01](images/02-add-bootstrap-vm-from-ova01.png){.thumbnail} - -Dans la fenêtre **Select a template**, choisissez le troisième modèle en partant du haut et qui contient ces informations : - -- **Family** : Linux -- **Distribution** : Ubuntu -- **Version** : 22 - -![02 Add Bootstrapvm 02](images/02-add-bootstrap-vm-from-ova02.png){.thumbnail} - -Cliquez sur l'icône `Copier`{.action} à droite pour copier dans le presse-papier l'URL qui doit se terminer par **Ubuntu-22.04_TKGm-1.6_with_x.ovf** . Cliquez ensuite sur `Close`{.action}. - -![02 Add Bootstrapvm 03](images/02-add-bootstrap-vm-from-ova03.png){.thumbnail} - -Dans l'interface vSphere, faites un clic-droit sur le cluster et choisissez `Déployer un modèle OVF`{.action} dans le menu contextuel. - -![02 Add Bootstrapvm 03b](images/02-add-bootstrap-vm-from-ova03b.png){.thumbnail} - -Sélectionnez `URL`{.action}, collez l'URL précédemment copiée et cliquez sur `SUIVANT`{.action}. - -![02 Add Bootstrapvm 04](images/02-add-bootstrap-vm-from-ova04.png){.thumbnail} - -Laissez le positionnement par défaut et cliquez sur `SUIVANT`{.action}. - -![02 Add Bootstrapvm 05](images/02-add-bootstrap-vm-from-ova05.png){.thumbnail} - -Gardez le `Cluster1` et cliquez sur `SUIVANT`{.action}. - -![02 Add Bootstrapvm 06](images/02-add-bootstrap-vm-from-ova06.png){.thumbnail} - -Cliquez sur `SUIVANT`{.action} pour valider les choix. - -![02 Add Bootstrapvm 07](images/02-add-bootstrap-vm-from-ova07.png){.thumbnail} - -Sélectionnez un stockage partagé en NFS v3 et cliquez sur `SUIVANT`{.action}. - -![02 Add Bootstrapvm 08](images/02-add-bootstrap-vm-from-ova08.png){.thumbnail} - -Choisissez `VLAN10` pour le réseau de destination et cliquez sur `SUIVANT`{.action}. - -![02 Add Bootstrapvm 09](images/02-add-bootstrap-vm-from-ova09.png){.thumbnail} - -Ajoutez ces informations dans **Networking** : - -- **Hostname** : `bootstrap` -- **IP Address** : `192.168.0.199` -- **Network CIDR Prefix** : `24` -- **Gateway** : `192.168.0.254` -- **DNS** : `213.186.33.99` - -> [!primary] -> -> Le serveur DNS choisi dans ce guide est celui d'OVHcloud. -> - -Saisissez et confirmez le mot de passe dans **OS Credentials** et cliquez sur `SUIVANT`{.action}. - -![02 Add Bootstrapvm 10](images/02-add-bootstrap-vm-from-ova10.png){.thumbnail} - -Cliquez sur `TERMINER`{.action}. - -![02 Add Bootstrapvm 11](images/02-add-bootstrap-vm-from-ova11.png){.thumbnail} - -Faites un clic-droit sur la machine virtuelle créée, allez dans `Alimentation`{.action} et cliquez sur `Mettre sous tension`{.action}. - -![02 Add Bootstrapvm 12](images/02-add-bootstrap-vm-from-ova12.png){.thumbnail} - -La machine virtuelle démarrée est accessible via la console avec l'interface graphique ou en **SSH**. - -Positionnez-vous sur la machine virtuelle créée et cliquez sur `LANCER LA CONSOLE WEB`{.action}. - -![02 Add Bootstrapvm 13](images/02-add-bootstrap-vm-from-ova13.png){.thumbnail} - -L'interface graphique de la machine virtuelle Linux apparaît. - -![02 Add Bootstrapvm 14](images/02-add-bootstrap-vm-from-ova14.png){.thumbnail} - -### Autorisation d'accès au cluster PCC depuis la machine virtuelle **Bootstrap** - -Les outils de configuration et d'administration de **Tanzu Kubernetes Grid** sont installés sur la machine virtuelle **Bootstrap**. Cette machine virtuelle doit pouvoir se connecter à Internet et au cluster vSphere. - -Notez **l'adresse IP publique** que vous utilisez sur cette machine virtuelle et aidez-vous du guide « [Autoriser des adresses IP à se connecter au vCenter](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/autoriser_des_ip_a_se_connecter_au_vcenter) » pour donner accès au cluster vSphere depuis la nouvelle machine virtuelle. - -### Déploiement du cluster **Tanzu Kubernetes Grid** sur votre infrastructure - -Connectez-vous sur la machine virtuelle `Ubuntu-22.04_TKGm-1.5.4_with_x`, ouvrez un terminal et exécutez cette commande pour créer une clé **RSA** : - -```bash -ssh-keygen -t rsa -b 4096 -C "youremail@yourdomain.com" -``` - -![03 Create TKG CLUSTER 01](images/03-create-tkg-cluster01.png){.thumbnail} - -Deux fichiers sont créés dans le dossier **~/.ssh** : - -- **id_rsa.pub** -- **id_rsa** - -Restez sur la console et lancez cette commande : - -```bash -tanzu management-cluster create --ui --bind 192.168.0.199:8080 -``` - -> [!primary] -> -> Lorsque vous lancez cette commande depuis la console Linux avec l'interface graphique, le navigateur Web se lance et se connecte à l'adresse `https://192.168.0.199:8080`. Si vous avez lancé cette commande depuis une connexion **SSH**, il vous faudra vous connecter à l'adresse `https://192.168.0.199:8080` à partir d'une machine virtuelle qui se trouve sur le même réseau avec une interface graphique et un navigateur web opérationnel. -> - -![03 Create TKG CLUSTER 02](images/03-create-tkg-cluster02.png){.thumbnail} - -Cliquez sur `Deploy`{.action} en dessous de **VMware vSphere**. - -![03 Create TKG CLUSTER 03](images/03-create-tkg-cluster03.png){.thumbnail} - -Saisissez ces informations : - -- **VCENTER SERVER** : `nom FQDN du cluster VMware`. -- **USERNAME** : `utilisateur du cluster VMware`. -- **PASSWORD** : `mot de passe de l'utilisateur du cluster VMware`. - -Cliquez ensuite sur `CONNECT`{.action}. - -![03 Create TKG CLUSTER 04](images/03-create-tkg-cluster04.png){.thumbnail} - -A l'étape de vérification du **SSL Thumbprint**, cliquez sur `CONTINUE`{.action}. - -![03 Create TKG CLUSTER 05](images/03-create-tkg-cluster05.png){.thumbnail} - -Cliquez sur la croix en haut à droite pour fermer la fenêtre **vSphere 7.0.3 Environnement Detected**. - -![03 Create TKG CLUSTER 06](images/03-create-tkg-cluster06.png){.thumbnail} - -Collez le contenu du fichier **~.ssh/id_rsa.pub** dans **SSH PUBLIC KEY** et cliquez sur `NEXT`{.action}. - -![03 Create TKG CLUSTER 07](images/03-create-tkg-cluster07.png){.thumbnail} - -Choisissez à droite `Production`{.action} et sélectionnez l'option `large etc...` dans **INSTANCE TYPE** . - -Saisissez ces valeurs : - -- **MANAGEMEMENT CLUSTER NAME (OPTIONAL)** : `tkgm-management-cluster`. -- **CONTROL PLANE ENDPOINT** : `192.168.0.10`. - -Cliquez sur `NEXT`{.action} pour passer à l'étape suivante. - -![03 Create TKG CLUSTER 08](images/03-create-tkg-cluster08.png){.thumbnail} - -Cliquez sur `NEXT`{.action}. - -![03 Create TKG CLUSTER 09](images/03-create-tkg-cluster09.png){.thumbnail} - -Dans l'option **Metadata** puis dans la partie **LABELS (OPTIONAL)**, saisissez `tkgm` pour le nom et sa valeur. - -Cliquez sur `NEXT`{.action}. - -![03 Create TKG CLUSTER 10](images/03-create-tkg-cluster10.png){.thumbnail} - -Renseignez ces options : - -- **VM FOLDER** : `Dossier de rangement des machines virtuelles`. -- **DATASTORE** : `Stockage des machines virtuelles à mettre sur un stockage partagé`. -- **CLUSTERS , HOSTS, AND RESOURCE POOLS** : `Cluster1`. - -Cliquez sur `NEXT`{.action}. - -![03 Create TKG CLUSTER 11](images/03-create-tkg-cluster11.png){.thumbnail} - -Sélectionnez, dans **NETWORK NAME**, le `VLAN10`{.action}. - -Cliquez sur `NEXT`{.action}. - -![03 Create TKG CLUSTER 12](images/03-create-tkg-cluster12.png){.thumbnail} - -Désactivez l'option `Enable Identity Management Settings`{.action} et cliquez sur `NEXT`{.action}. - -![03 Create TKG CLUSTER 13](images/03-create-tkg-cluster13.png){.thumbnail} - -Sélectionnez l'image OVA intégrée au cluster `photon-3-kube-v1.22.9+vmware.1` dans le menu **OS Image** et cliquez sur `NEXT`{.action}. - -![03 Create TKG CLUSTER 14](images/03-create-tkg-cluster14.png){.thumbnail} - -Décochez `Participate in the Customer Experience Improvement Program`{.action} et cliquez sur `NEXT`{.action}. - -![03 Create TKG CLUSTER 15](images/03-create-tkg-cluster15.png){.thumbnail} - -Cliquez sur `REVIEW CONFIGURATION`{.action}. - -![03 Create TKG CLUSTER 16](images/03-create-tkg-cluster16.png){.thumbnail} - -> [!primary] -> Notez le nom du fichier yaml qui se trouve en dessous de **CLI Command Equivalent**, il servira de modèle pour le déploiement d'un cluster de **WorkLoad**. -> - -Faites défiler la fenêtre et cliquez sur `DEPLOY MANAGEMENT CLUSTER`{.action} - -![03 Create TKG CLUSTER 17](images/03-create-tkg-cluster17.png){.thumbnail} - -Le déploiement du cluster **Tanzu Kubernetes Grid** est lancé, patientez jusqu'à ce qu'il soit terminé. - -> [!primary] -> Le déploiement sera terminé lorsque vous verrez apparaitre dans la fenêtre les messages **Management cluster created** et **Successfully installed all required plugins**. -> -> ![03 Create TKG CLUSTER 18](images/03-create-tkg-cluster18.png){.thumbnail} -> -> Une autre indication qui signale que l'installation est terminée se trouve dans la console de la machine virtuelle de **Bootstrap** où apparaîtront les messages **Management cluster created** et **You can now create your first workload cluster etc...**. - -> [!warning] -> -> Notez ou copier le nom du fichier **yaml** qui se trouve dans le dossier `/home/tanzu/.config/tanzu/tkg/clusterconfigs`, il servira à la création d'un fichier de configuration pour l'installation d'un cluster de *WorkLoad* -> - -![03 Create TKG CLUSTER 19](images/03-create-tkg-cluster19.png){.thumbnail} - -Allez sur l'interface vCenter pour voir les sept machines virtuelles créées. - -![04 VM CREATED ADFTER INSTALLATION 01](images/04-vm-created-after-installation01.png){.thumbnail} - -## Aller plus loin - -[Administrer un cluster TKG](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) - -[Présentation de VMware Tanzu Kubernetes Grid](https://tanzu.vmware.com/kubernetes-grid) - -[Documentation de VMware Tanzu Kubenetes Grid](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Installation manuelle de l'outil CLI pour le déploiement de Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -Si vous avez besoin d'une formation ou d'une assistance technique pour la mise en oeuvre de nos solutions, contactez votre commercial ou cliquez sur [ce lien](/links/professional-services) pour obtenir un devis et demander une analyse personnalisée de votre projet à nos experts de l’équipe Professional Services. - -Échangez avec notre [communauté d'utilisateurs](/links/community). diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/guide.it-it.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/guide.it-it.md deleted file mode 100644 index f1b9f5ec869..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/guide.it-it.md +++ /dev/null @@ -1,366 +0,0 @@ ---- -title: Installazione della griglia Tanzu Kubernetes (EN) -excerpt: Learn how to integrate Tanzu Kubernetes Grid into your VMware on OVHcloud infrastructure -updated: 2022-11-10 ---- - -## Objective - -**This guide documents how to install Tanzu Kubernetes Grid on your VMware on OVHcloud cluster** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Introduction - -VMware Tanzu Kubernetes Grid is a Kubernetes platform provided by **VMware** and maintained as part of the **VMware on OVHcloud** solution. - -You can install this product on your OVHcloud infrastructure to take advantage of its features and scalability. - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/it/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- A VLAN with internet access and a DHCP server -- You must have these resources: - - 8 GB of memory, 4 vCPUs, and 250 GB of storage for the management virtual machine named **Bootstrap**. - - 16 GB of memory, 4 vCPU, 40 GB of storage per Kubernetes node (it takes 6 nodes to install the management cluster in production mode and 6 nodes per **Workload** cluster in the same mode). - -## Instructions - -We will install **VMware Tanzu Kubernetes Grid** on a **VMware on OVHcloud** cluster and use VLAN 10 with these settings: - -- **LAN**: `192.168.0.0/24`. -- **DHCP Range**: `192.168.0.50 -> 192.168.0.100`. -- **Gateway**: `192.168.0.254`. - -> [!primary] -> This information is given as an example, it is quite possible to use another range and another VLAN. -> - -At the end of the installation, seven additional virtual machines will be on your VMware cluster, six for running the **TKG** management cluster and one for managing it. - -![00 admin cluster diagram](images/00-admin-cluster-diagram01.png){.thumbnail} - -### Importing OVA model for **Tanzu KUBERNETES Grid** into your infrastructure - -VMware provides a virtual machine as an OVA template, which contains all the elements to run a node of the **Tanzu Kubernetes Grid** cluster. This virtual machine is available in **OVH Templates**. - -Log in to the OVHcloud homepage for your VMware cluster, and click `OVH Templates`{.action} to the right. - -![01 integrate TKGM OVA 01](images/01-integrate-tkgm-ova01.png){.thumbnail} - -In the **Select a template** window, choose the fourth template from the top that has this information: - -- **Family**: Linux -- **Distribution**: not specified -- **Version**: 3 - -![01 integrate TKGM OVA 02](images/01-integrate-tkgm-ova02.png){.thumbnail} - -Click the `Copy`{.action} icon to the right to copy the URL which name must end in **photon-3-kube-v1.23.8+vmware.1.ovf**. Then click `Close`{.action}. - -![01 integrate TKGM OVA 03](images/01-integrate-tkgm-ova03.png){.thumbnail} - -Log in to your vSphere console, right-click your cluster and choose `Deploy an OVF Template`{.action}. - -![01 integrate TKGM OVA 03b](images/01-integrate-tkgm-ova03b.png){.thumbnail} - -Select `URL`{.action}, paste the previously copied URL and click `NEXT`{.action}. - -![01 integrate TKGM OVA 04](images/01-integrate-tkgm-ova04.png){.thumbnail} - -Leave the default location and click `NEXT`{.action}. - -![01 integrate TKGM OVA 05](images/01-integrate-tkgm-ova05.png){.thumbnail} - -Choose the cluster and click `NEXT`{.action}. - -![01 integrate TKGM OVA 06](images/01-integrate-tkgm-ova06.png){.thumbnail} - -Review your information and click `NEXT`{.action}. - -![01 integrate TKGM OVA 07](images/01-integrate-tkgm-ova07.png){.thumbnail} - -Check `I accept all licence agreements`{.action} and click `NEXT`{.action}. - -![01 integrate TKGM OVA 08](images/01-integrate-tkgm-ova08.png){.thumbnail} - -Select a shared storage in NFS v3, then click `NEXT`{.action}. - -![01 integrate TKGM OVA 09](images/01-integrate-tkgm-ova09.png){.thumbnail} - -Choose the destination network on `VLAN 10`{.action} and click `NEXT`{.action}. - -![01 integrate TKGM OVA 10](images/01-integrate-tkgm-ova10.png){.thumbnail} - -Click `FINISH`{.action}. - -![01 integrate TKGM OVA 11](images/01-integrate-tkgm-ova11.png){.thumbnail} - -Select the `Monitor`{.action} tab and click `Tasks`{.action}. - -![01 integrate TKGM OVA 12](images/01-integrate-tkgm-ova12.png){.thumbnail} - -Wait for the `Deploy OVF template` and `Import OVF package` tasks to complete. - -![01 integrate TKGM OVA 13](images/01-integrate-tkgm-ova13.png){.thumbnail} - -Right-click the deployed VM and choose `Convert to Template`{.action} from the `Template`{.action} menu. - -![01 integrate TKGM OVA 14](images/01-integrate-tkgm-ova14.png){.thumbnail} - -Answer `YES`{.action} to convert the virtual machine. - -![01 integrate TKGM OVA 15](images/01-integrate-tkgm-ova15.png){.thumbnail} - -Go to `Virtual Machines (and templates)`{.action} to see the template you have created. - -> [!primary] -> -> This template will be used when deploying **Tanzu Kubernetes Grid** clusters. It is used for the initial deployment of the administration cluster and for the installation of additional *WorkLoad* clusters. It should not be deleted from the **VMware** cluster. -> - -![01 integrate TKGM OVA 16](images/01-integrate-tkgm-ova16.png){.thumbnail} - -### Installation of the virtual machine **Bootstrap** provided by OVHcloud - -This virtual machine was created by OVHcloud from the documentation [Installing the CLI tool manually for deploying **Tanzu Kubernetes GRID**](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html). It is available as a template in **OVH Templates**. - -Log in to the OVHcloud homepage for your VMware cluster, and click `OVH Templates`{.action} to the right. - -![02 Add Bootstrapvm 01](images/02-add-bootstrap-vm-from-ova01.png){.thumbnail} - -In the **Select a template** window, choose the third template from the top that contains this information: - -- **Family**: Linux -- **Distribution**: Ubuntu -- **Version**: 22 - -![02 Add Bootstrapvm 02](images/02-add-bootstrap-vm-from-ova02.png){.thumbnail} - -Click the `Copy`{.action} icon to the right to copy the URL, the URL should end with **Ubuntu-22.04_TKGm-1.6_with_x.ovf**. Then click `Close`{.action}. - -![02 Add Bootstrapvm 03](images/02-add-bootstrap-vm-from-ova03.png){.thumbnail} - -In the vSphere interface, right-click the cluster and choose `Deploy an OVF Template`{.action} from the menu. - -![02 Add Bootstrapvm 03b](images/02-add-bootstrap-vm-from-ova03b.png){.thumbnail} - -Select `URL`{.action}, paste the previously copied URL and click `NEXT`{.action}. - -![02 Add Bootstrapvm 04](images/02-add-bootstrap-vm-from-ova04.png){.thumbnail} - -Leave the default positioning and click `NEXT`{.action}. - -![02 Add Bootstrapvm 05](images/02-add-bootstrap-vm-from-ova05.png){.thumbnail} - -Leave `Cluster1` and click `NEXT`{.action}. - -![02 Add Bootstrapvm 06](images/02-add-bootstrap-vm-from-ova06.png){.thumbnail} - -Click `NEXT`{.action} to validate your choices. - -![02 Add Bootstrapvm 07](images/02-add-bootstrap-vm-from-ova07.png){.thumbnail} - -Select a shared storage in NFS v3 and click `NEXT`{.action}. - -![02 Add Bootstrapvm 08](images/02-add-bootstrap-vm-from-ova08.png){.thumbnail} - -Choose `VLAN10` for the destination network and click `NEXT`{.action}. - -![02 Add Bootstrapvm 09](images/02-add-bootstrap-vm-from-ova09.png){.thumbnail} - -Add this information in **Networking**: - -- **Hostname**: `bootstrap` -- **IP Address**: `192.168.0.199` -- **Network CIDR Prefix**: `24` -- **Gateway**: `192.168.0.254` -- **DNS**: `213.186.33.99` - -> [!primary] -> -> The DNS server chosen in this guide is the OVHcloud server. -> - -Enter and confirm the password in **OS Credentials** and click `NEXT`{.action}. - -![02 Add Bootstrapvm 10](images/02-add-bootstrap-vm-from-ova10.png){.thumbnail} - -Click `FINISH`{.action}. - -![02 Add Bootstrapvm 11](images/02-add-bootstrap-vm-from-ova11.png){.thumbnail} - -Right-click the virtual machine you created, go to `Power`{.action} and click `Power On`{.action}. - -![02 Add Bootstrapvm 12](images/02-add-bootstrap-vm-from-ova12.png){.thumbnail} - -The booted virtual machine can be accessed via the console with the graphical interface or via **SSH**. - -Go to the virtual machine you have created, and click `LAUNCH WEB CONSOLE`{.action}. - -![02 Add Bootstrapvm 13](images/02-add-bootstrap-vm-from-ova13.png){.thumbnail} - -The graphical interface for the Linux virtual machine is then available. - -![02 Add Bootstrapvm 14](images/02-add-bootstrap-vm-from-ova14.png){.thumbnail} - -### Allowing access to the PCC cluster from the **Bootstrap** virtual machine - -The configuration and administration tools for **Tanzu Kubernetes Grid** are installed on the **Bootstrap** virtual machine. This virtual machine must be able to connect to the Internet and to the vSphere cluster. - -Write down **the public IP address** you use on this virtual machine and use this guide [Authorise IP addresses to connect to vCenter](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/autoriser_des_ip_a_se_connecter_au_vcenter) to grant access to the vSphere cluster to the new virtual machine. - -### Deploying the **Tanzu Kubernetes Grid** cluster on your infrastructure - -Log in to the `Ubuntu-22.04_TKGm-1.5.4_with_x` virtual machine, open a terminal, and run this command to create an **RSA** key: - -```bash -ssh-keygen -t rsa -b 4096 -C "youremail@yourdomain.com" -``` - -![03 Create TKG CLUSTER 01](images/03-create-tkg-cluster01.png){.thumbnail} - -Two files are created in the **~/.ssh** folder: - -- **id_rsa.pub** -- **id_rsa** - -Stay on the console and run this command: - -```bash -tanzu management-cluster create --ui --bind 192.168.0.199:8080 -``` - -> [!primary] -> -> When you run this command from the Linux console with the graphical interface, the web browser launches and connects to `https://192.168.0.199:8080`. If you have run this command from an **SSH** connection, you will need to connect to `https://192.168.0.199:8080` from a virtual machine on the same network with a graphical interface and an operational web browser. -> - -![03 Create TKG CLUSTER 02](images/03-create-tkg-cluster02.png){.thumbnail} - -Click `Deploy`{.action} below **VMware vSphere**. - -![03 Create TKG CLUSTER 03](images/03-create-tkg-cluster03.png){.thumbnail} - -Enter this information: - -- **VCENTER SERVER**: `VMware cluster FQDN` -- **USERNAME**: `VMware cluster user` -- **PASSWORD**: `VMware cluster user password` - -Then click `CONNECT`{.action}. - -![03 Create TKG CLUSTER 04](images/03-create-tkg-cluster04.png){.thumbnail} - -At the verification step of the **SSL Thumbprint**, click `CONTINUE`{.action}. - -![03 Create TKG CLUSTER 05](images/03-create-tkg-cluster05.png){.thumbnail} - -Click the cross in the top right to close the **vSphere 7.0.3 Environment Detected** window. - -![03 Create TKG CLUSTER 06](images/03-create-tkg-cluster06.png){.thumbnail} - -Paste the contents of the **~.ssh/id_rsa.pub** file into **SSH PUBLIC KEY** and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 07](images/03-create-tkg-cluster07.png){.thumbnail} - -Select `Production`{.action} on the right and select the `large etc...` **INSTANCE TYPE**. - -Enter these values: - -- **MANAGEMENT CLUSTER NAME (OPTIONAL)**: `tkgm-management-cluster`. -- **CONTROL PLANE ENDPOINT**: `192.168.0.10`. - -Click `NEXT`{.action} to proceed to the next step. - -![03 Create TKG CLUSTER 08](images/03-create-tkg-cluster08.png){.thumbnail} - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 09](images/03-create-tkg-cluster09.png){.thumbnail} - -In the **Metadata** option and then in the **LABELS (OPTIONAL)** section, type `tkgm` for the name and its value. - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 10](images/03-create-tkg-cluster10.png){.thumbnail} - -Enter these options: - -- **VM FOLDER**: `Storage folder for virtual machines`. -- **DATASTORE**: `Storage of virtual machines to be placed on a shared storage` . -- **CLUSTERS, HOSTS, AND RESOURCE POOLS**: `Cluster1`. - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 11](images/03-create-tkg-cluster11.png){.thumbnail} - -In **NETWORK NAME** select `VLAN10`{.action}. - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 12](images/03-create-tkg-cluster12.png){.thumbnail} - -Disable the `Activate Identity Management Settings`{.action} option and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 13](images/03-create-tkg-cluster13.png){.thumbnail} - -Select the OVA image integrated into the `photon-3-kube-v1.22.9+vmware.1` cluster from the **OS Image** menu and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 14](images/03-create-tkg-cluster14.png){.thumbnail} - -Uncheck `Participate in the Customer Experience Improvement Program`{.action} and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 15](images/03-create-tkg-cluster15.png){.thumbnail} - -Click `REVIEW CONFIGURATION`{.action}. - -![03 Create TKG CLUSTER 16](images/03-create-tkg-cluster16.png){.thumbnail} - -> [!primary] -> Take note of the name of the yaml file below **CLI Command Equivalent**, it will serve as a template for deploying a **WorkLoad** cluster. -> - -Scroll through the window and click `DEPLOY MANAGEMENT CLUSTER`{.action} - -![03 Create TKG CLUSTER 17](images/03-create-tkg-cluster17.png){.thumbnail} - -The **Tanzu Kubernetes Grid** cluster deployment is started, please wait for it to complete. - -> [!primary] -> The deployment will be completed when you see the **Management cluster created** and **Successfully installed all required plugins** messages in the window. -> -> ![03 Create TKG CLUSTER 18](images/03-create-tkg-cluster18.png){.thumbnail} -> -> Another indication that the installation is complete can be found in the console of the **Bootstrap** virtual machine in which will appear the **Management cluster created** and **You can now create your first workload cluster etc...** messages. - -> [!warning] -> -> Write down or copy the name of the **yaml** file in the `/home/tanzu/.config/tanzu/tkg/clusterconfigs` folder, it will be used to create a configuration file for installing a *WorkLoad cluster* -> - -![03 Create TKG CLUSTER 19](images/03-create-tkg-cluster19.png){.thumbnail} - -Go to the vCenter interface to see the seven virtual machines created. - -![04 VM CREATED ADFTER INSTALLATION 01](images/04-vm-created-after-installation01.png){.thumbnail} - -## Go further - -[Administrating a TKG cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) - -[Introducing VMware Tanzu Kubernetes Grid](https://tanzu.vmware.com/kubernetes-grid) - -[Documentation de VMware Tanzu Kubenetes Grid](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/guide.pl-pl.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/guide.pl-pl.md deleted file mode 100644 index 1ab54ed15b7..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/guide.pl-pl.md +++ /dev/null @@ -1,366 +0,0 @@ ---- -title: Instalowanie siatki Tanzu Kubernetes (EN) -excerpt: Learn how to integrate Tanzu Kubernetes Grid into your VMware on OVHcloud infrastructure -updated: 2022-11-10 ---- - -## Objective - -**This guide documents how to install Tanzu Kubernetes Grid on your VMware on OVHcloud cluster** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Introduction - -VMware Tanzu Kubernetes Grid is a Kubernetes platform provided by **VMware** and maintained as part of the **VMware on OVHcloud** solution. - -You can install this product on your OVHcloud infrastructure to take advantage of its features and scalability. - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/pl/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- A VLAN with internet access and a DHCP server -- You must have these resources: - - 8 GB of memory, 4 vCPUs, and 250 GB of storage for the management virtual machine named **Bootstrap**. - - 16 GB of memory, 4 vCPU, 40 GB of storage per Kubernetes node (it takes 6 nodes to install the management cluster in production mode and 6 nodes per **Workload** cluster in the same mode). - -## Instructions - -We will install **VMware Tanzu Kubernetes Grid** on a **VMware on OVHcloud** cluster and use VLAN 10 with these settings: - -- **LAN**: `192.168.0.0/24`. -- **DHCP Range**: `192.168.0.50 -> 192.168.0.100`. -- **Gateway**: `192.168.0.254`. - -> [!primary] -> This information is given as an example, it is quite possible to use another range and another VLAN. -> - -At the end of the installation, seven additional virtual machines will be on your VMware cluster, six for running the **TKG** management cluster and one for managing it. - -![00 admin cluster diagram](images/00-admin-cluster-diagram01.png){.thumbnail} - -### Importing OVA model for **Tanzu KUBERNETES Grid** into your infrastructure - -VMware provides a virtual machine as an OVA template, which contains all the elements to run a node of the **Tanzu Kubernetes Grid** cluster. This virtual machine is available in **OVH Templates**. - -Log in to the OVHcloud homepage for your VMware cluster, and click `OVH Templates`{.action} to the right. - -![01 integrate TKGM OVA 01](images/01-integrate-tkgm-ova01.png){.thumbnail} - -In the **Select a template** window, choose the fourth template from the top that has this information: - -- **Family**: Linux -- **Distribution**: not specified -- **Version**: 3 - -![01 integrate TKGM OVA 02](images/01-integrate-tkgm-ova02.png){.thumbnail} - -Click the `Copy`{.action} icon to the right to copy the URL which name must end in **photon-3-kube-v1.23.8+vmware.1.ovf**. Then click `Close`{.action}. - -![01 integrate TKGM OVA 03](images/01-integrate-tkgm-ova03.png){.thumbnail} - -Log in to your vSphere console, right-click your cluster and choose `Deploy an OVF Template`{.action}. - -![01 integrate TKGM OVA 03b](images/01-integrate-tkgm-ova03b.png){.thumbnail} - -Select `URL`{.action}, paste the previously copied URL and click `NEXT`{.action}. - -![01 integrate TKGM OVA 04](images/01-integrate-tkgm-ova04.png){.thumbnail} - -Leave the default location and click `NEXT`{.action}. - -![01 integrate TKGM OVA 05](images/01-integrate-tkgm-ova05.png){.thumbnail} - -Choose the cluster and click `NEXT`{.action}. - -![01 integrate TKGM OVA 06](images/01-integrate-tkgm-ova06.png){.thumbnail} - -Review your information and click `NEXT`{.action}. - -![01 integrate TKGM OVA 07](images/01-integrate-tkgm-ova07.png){.thumbnail} - -Check `I accept all licence agreements`{.action} and click `NEXT`{.action}. - -![01 integrate TKGM OVA 08](images/01-integrate-tkgm-ova08.png){.thumbnail} - -Select a shared storage in NFS v3, then click `NEXT`{.action}. - -![01 integrate TKGM OVA 09](images/01-integrate-tkgm-ova09.png){.thumbnail} - -Choose the destination network on `VLAN 10`{.action} and click `NEXT`{.action}. - -![01 integrate TKGM OVA 10](images/01-integrate-tkgm-ova10.png){.thumbnail} - -Click `FINISH`{.action}. - -![01 integrate TKGM OVA 11](images/01-integrate-tkgm-ova11.png){.thumbnail} - -Select the `Monitor`{.action} tab and click `Tasks`{.action}. - -![01 integrate TKGM OVA 12](images/01-integrate-tkgm-ova12.png){.thumbnail} - -Wait for the `Deploy OVF template` and `Import OVF package` tasks to complete. - -![01 integrate TKGM OVA 13](images/01-integrate-tkgm-ova13.png){.thumbnail} - -Right-click the deployed VM and choose `Convert to Template`{.action} from the `Template`{.action} menu. - -![01 integrate TKGM OVA 14](images/01-integrate-tkgm-ova14.png){.thumbnail} - -Answer `YES`{.action} to convert the virtual machine. - -![01 integrate TKGM OVA 15](images/01-integrate-tkgm-ova15.png){.thumbnail} - -Go to `Virtual Machines (and templates)`{.action} to see the template you have created. - -> [!primary] -> -> This template will be used when deploying **Tanzu Kubernetes Grid** clusters. It is used for the initial deployment of the administration cluster and for the installation of additional *WorkLoad* clusters. It should not be deleted from the **VMware** cluster. -> - -![01 integrate TKGM OVA 16](images/01-integrate-tkgm-ova16.png){.thumbnail} - -### Installation of the virtual machine **Bootstrap** provided by OVHcloud - -This virtual machine was created by OVHcloud from the documentation [Installing the CLI tool manually for deploying **Tanzu Kubernetes GRID**](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html). It is available as a template in **OVH Templates**. - -Log in to the OVHcloud homepage for your VMware cluster, and click `OVH Templates`{.action} to the right. - -![02 Add Bootstrapvm 01](images/02-add-bootstrap-vm-from-ova01.png){.thumbnail} - -In the **Select a template** window, choose the third template from the top that contains this information: - -- **Family**: Linux -- **Distribution**: Ubuntu -- **Version**: 22 - -![02 Add Bootstrapvm 02](images/02-add-bootstrap-vm-from-ova02.png){.thumbnail} - -Click the `Copy`{.action} icon to the right to copy the URL, the URL should end with **Ubuntu-22.04_TKGm-1.6_with_x.ovf**. Then click `Close`{.action}. - -![02 Add Bootstrapvm 03](images/02-add-bootstrap-vm-from-ova03.png){.thumbnail} - -In the vSphere interface, right-click the cluster and choose `Deploy an OVF Template`{.action} from the menu. - -![02 Add Bootstrapvm 03b](images/02-add-bootstrap-vm-from-ova03b.png){.thumbnail} - -Select `URL`{.action}, paste the previously copied URL and click `NEXT`{.action}. - -![02 Add Bootstrapvm 04](images/02-add-bootstrap-vm-from-ova04.png){.thumbnail} - -Leave the default positioning and click `NEXT`{.action}. - -![02 Add Bootstrapvm 05](images/02-add-bootstrap-vm-from-ova05.png){.thumbnail} - -Leave `Cluster1` and click `NEXT`{.action}. - -![02 Add Bootstrapvm 06](images/02-add-bootstrap-vm-from-ova06.png){.thumbnail} - -Click `NEXT`{.action} to validate your choices. - -![02 Add Bootstrapvm 07](images/02-add-bootstrap-vm-from-ova07.png){.thumbnail} - -Select a shared storage in NFS v3 and click `NEXT`{.action}. - -![02 Add Bootstrapvm 08](images/02-add-bootstrap-vm-from-ova08.png){.thumbnail} - -Choose `VLAN10` for the destination network and click `NEXT`{.action}. - -![02 Add Bootstrapvm 09](images/02-add-bootstrap-vm-from-ova09.png){.thumbnail} - -Add this information in **Networking**: - -- **Hostname**: `bootstrap` -- **IP Address**: `192.168.0.199` -- **Network CIDR Prefix**: `24` -- **Gateway**: `192.168.0.254` -- **DNS**: `213.186.33.99` - -> [!primary] -> -> The DNS server chosen in this guide is the OVHcloud server. -> - -Enter and confirm the password in **OS Credentials** and click `NEXT`{.action}. - -![02 Add Bootstrapvm 10](images/02-add-bootstrap-vm-from-ova10.png){.thumbnail} - -Click `FINISH`{.action}. - -![02 Add Bootstrapvm 11](images/02-add-bootstrap-vm-from-ova11.png){.thumbnail} - -Right-click the virtual machine you created, go to `Power`{.action} and click `Power On`{.action}. - -![02 Add Bootstrapvm 12](images/02-add-bootstrap-vm-from-ova12.png){.thumbnail} - -The booted virtual machine can be accessed via the console with the graphical interface or via **SSH**. - -Go to the virtual machine you have created, and click `LAUNCH WEB CONSOLE`{.action}. - -![02 Add Bootstrapvm 13](images/02-add-bootstrap-vm-from-ova13.png){.thumbnail} - -The graphical interface for the Linux virtual machine is then available. - -![02 Add Bootstrapvm 14](images/02-add-bootstrap-vm-from-ova14.png){.thumbnail} - -### Allowing access to the PCC cluster from the **Bootstrap** virtual machine - -The configuration and administration tools for **Tanzu Kubernetes Grid** are installed on the **Bootstrap** virtual machine. This virtual machine must be able to connect to the Internet and to the vSphere cluster. - -Write down **the public IP address** you use on this virtual machine and use this guide [Authorise IP addresses to connect to vCenter](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/autoriser_des_ip_a_se_connecter_au_vcenter) to grant access to the vSphere cluster to the new virtual machine. - -### Deploying the **Tanzu Kubernetes Grid** cluster on your infrastructure - -Log in to the `Ubuntu-22.04_TKGm-1.5.4_with_x` virtual machine, open a terminal, and run this command to create an **RSA** key: - -```bash -ssh-keygen -t rsa -b 4096 -C "youremail@yourdomain.com" -``` - -![03 Create TKG CLUSTER 01](images/03-create-tkg-cluster01.png){.thumbnail} - -Two files are created in the **~/.ssh** folder: - -- **id_rsa.pub** -- **id_rsa** - -Stay on the console and run this command: - -```bash -tanzu management-cluster create --ui --bind 192.168.0.199:8080 -``` - -> [!primary] -> -> When you run this command from the Linux console with the graphical interface, the web browser launches and connects to `https://192.168.0.199:8080`. If you have run this command from an **SSH** connection, you will need to connect to `https://192.168.0.199:8080` from a virtual machine on the same network with a graphical interface and an operational web browser. -> - -![03 Create TKG CLUSTER 02](images/03-create-tkg-cluster02.png){.thumbnail} - -Click `Deploy`{.action} below **VMware vSphere**. - -![03 Create TKG CLUSTER 03](images/03-create-tkg-cluster03.png){.thumbnail} - -Enter this information: - -- **VCENTER SERVER**: `VMware cluster FQDN` -- **USERNAME**: `VMware cluster user` -- **PASSWORD**: `VMware cluster user password` - -Then click `CONNECT`{.action}. - -![03 Create TKG CLUSTER 04](images/03-create-tkg-cluster04.png){.thumbnail} - -At the verification step of the **SSL Thumbprint**, click `CONTINUE`{.action}. - -![03 Create TKG CLUSTER 05](images/03-create-tkg-cluster05.png){.thumbnail} - -Click the cross in the top right to close the **vSphere 7.0.3 Environment Detected** window. - -![03 Create TKG CLUSTER 06](images/03-create-tkg-cluster06.png){.thumbnail} - -Paste the contents of the **~.ssh/id_rsa.pub** file into **SSH PUBLIC KEY** and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 07](images/03-create-tkg-cluster07.png){.thumbnail} - -Select `Production`{.action} on the right and select the `large etc...` **INSTANCE TYPE**. - -Enter these values: - -- **MANAGEMENT CLUSTER NAME (OPTIONAL)**: `tkgm-management-cluster`. -- **CONTROL PLANE ENDPOINT**: `192.168.0.10`. - -Click `NEXT`{.action} to proceed to the next step. - -![03 Create TKG CLUSTER 08](images/03-create-tkg-cluster08.png){.thumbnail} - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 09](images/03-create-tkg-cluster09.png){.thumbnail} - -In the **Metadata** option and then in the **LABELS (OPTIONAL)** section, type `tkgm` for the name and its value. - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 10](images/03-create-tkg-cluster10.png){.thumbnail} - -Enter these options: - -- **VM FOLDER**: `Storage folder for virtual machines`. -- **DATASTORE**: `Storage of virtual machines to be placed on a shared storage` . -- **CLUSTERS, HOSTS, AND RESOURCE POOLS**: `Cluster1`. - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 11](images/03-create-tkg-cluster11.png){.thumbnail} - -In **NETWORK NAME** select `VLAN10`{.action}. - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 12](images/03-create-tkg-cluster12.png){.thumbnail} - -Disable the `Activate Identity Management Settings`{.action} option and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 13](images/03-create-tkg-cluster13.png){.thumbnail} - -Select the OVA image integrated into the `photon-3-kube-v1.22.9+vmware.1` cluster from the **OS Image** menu and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 14](images/03-create-tkg-cluster14.png){.thumbnail} - -Uncheck `Participate in the Customer Experience Improvement Program`{.action} and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 15](images/03-create-tkg-cluster15.png){.thumbnail} - -Click `REVIEW CONFIGURATION`{.action}. - -![03 Create TKG CLUSTER 16](images/03-create-tkg-cluster16.png){.thumbnail} - -> [!primary] -> Take note of the name of the yaml file below **CLI Command Equivalent**, it will serve as a template for deploying a **WorkLoad** cluster. -> - -Scroll through the window and click `DEPLOY MANAGEMENT CLUSTER`{.action} - -![03 Create TKG CLUSTER 17](images/03-create-tkg-cluster17.png){.thumbnail} - -The **Tanzu Kubernetes Grid** cluster deployment is started, please wait for it to complete. - -> [!primary] -> The deployment will be completed when you see the **Management cluster created** and **Successfully installed all required plugins** messages in the window. -> -> ![03 Create TKG CLUSTER 18](images/03-create-tkg-cluster18.png){.thumbnail} -> -> Another indication that the installation is complete can be found in the console of the **Bootstrap** virtual machine in which will appear the **Management cluster created** and **You can now create your first workload cluster etc...** messages. - -> [!warning] -> -> Write down or copy the name of the **yaml** file in the `/home/tanzu/.config/tanzu/tkg/clusterconfigs` folder, it will be used to create a configuration file for installing a *WorkLoad cluster* -> - -![03 Create TKG CLUSTER 19](images/03-create-tkg-cluster19.png){.thumbnail} - -Go to the vCenter interface to see the seven virtual machines created. - -![04 VM CREATED ADFTER INSTALLATION 01](images/04-vm-created-after-installation01.png){.thumbnail} - -## Go further - -[Administrating a TKG cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) - -[Introducing VMware Tanzu Kubernetes Grid](https://tanzu.vmware.com/kubernetes-grid) - -[Documentation de VMware Tanzu Kubenetes Grid](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/guide.pt-pt.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/guide.pt-pt.md deleted file mode 100644 index bea60ec9f0a..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/guide.pt-pt.md +++ /dev/null @@ -1,366 +0,0 @@ ---- -title: Instalando o Tanzu Kubernetes Grid (EN) -excerpt: Learn how to integrate Tanzu Kubernetes Grid into your VMware on OVHcloud infrastructure -updated: 2022-11-10 ---- - -## Objective - -**This guide documents how to install Tanzu Kubernetes Grid on your VMware on OVHcloud cluster** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Introduction - -VMware Tanzu Kubernetes Grid is a Kubernetes platform provided by **VMware** and maintained as part of the **VMware on OVHcloud** solution. - -You can install this product on your OVHcloud infrastructure to take advantage of its features and scalability. - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/pt/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- A VLAN with internet access and a DHCP server -- You must have these resources: - - 8 GB of memory, 4 vCPUs, and 250 GB of storage for the management virtual machine named **Bootstrap**. - - 16 GB of memory, 4 vCPU, 40 GB of storage per Kubernetes node (it takes 6 nodes to install the management cluster in production mode and 6 nodes per **Workload** cluster in the same mode). - -## Instructions - -We will install **VMware Tanzu Kubernetes Grid** on a **VMware on OVHcloud** cluster and use VLAN 10 with these settings: - -- **LAN**: `192.168.0.0/24`. -- **DHCP Range**: `192.168.0.50 -> 192.168.0.100`. -- **Gateway**: `192.168.0.254`. - -> [!primary] -> This information is given as an example, it is quite possible to use another range and another VLAN. -> - -At the end of the installation, seven additional virtual machines will be on your VMware cluster, six for running the **TKG** management cluster and one for managing it. - -![00 admin cluster diagram](images/00-admin-cluster-diagram01.png){.thumbnail} - -### Importing OVA model for **Tanzu KUBERNETES Grid** into your infrastructure - -VMware provides a virtual machine as an OVA template, which contains all the elements to run a node of the **Tanzu Kubernetes Grid** cluster. This virtual machine is available in **OVH Templates**. - -Log in to the OVHcloud homepage for your VMware cluster, and click `OVH Templates`{.action} to the right. - -![01 integrate TKGM OVA 01](images/01-integrate-tkgm-ova01.png){.thumbnail} - -In the **Select a template** window, choose the fourth template from the top that has this information: - -- **Family**: Linux -- **Distribution**: not specified -- **Version**: 3 - -![01 integrate TKGM OVA 02](images/01-integrate-tkgm-ova02.png){.thumbnail} - -Click the `Copy`{.action} icon to the right to copy the URL which name must end in **photon-3-kube-v1.23.8+vmware.1.ovf**. Then click `Close`{.action}. - -![01 integrate TKGM OVA 03](images/01-integrate-tkgm-ova03.png){.thumbnail} - -Log in to your vSphere console, right-click your cluster and choose `Deploy an OVF Template`{.action}. - -![01 integrate TKGM OVA 03b](images/01-integrate-tkgm-ova03b.png){.thumbnail} - -Select `URL`{.action}, paste the previously copied URL and click `NEXT`{.action}. - -![01 integrate TKGM OVA 04](images/01-integrate-tkgm-ova04.png){.thumbnail} - -Leave the default location and click `NEXT`{.action}. - -![01 integrate TKGM OVA 05](images/01-integrate-tkgm-ova05.png){.thumbnail} - -Choose the cluster and click `NEXT`{.action}. - -![01 integrate TKGM OVA 06](images/01-integrate-tkgm-ova06.png){.thumbnail} - -Review your information and click `NEXT`{.action}. - -![01 integrate TKGM OVA 07](images/01-integrate-tkgm-ova07.png){.thumbnail} - -Check `I accept all licence agreements`{.action} and click `NEXT`{.action}. - -![01 integrate TKGM OVA 08](images/01-integrate-tkgm-ova08.png){.thumbnail} - -Select a shared storage in NFS v3, then click `NEXT`{.action}. - -![01 integrate TKGM OVA 09](images/01-integrate-tkgm-ova09.png){.thumbnail} - -Choose the destination network on `VLAN 10`{.action} and click `NEXT`{.action}. - -![01 integrate TKGM OVA 10](images/01-integrate-tkgm-ova10.png){.thumbnail} - -Click `FINISH`{.action}. - -![01 integrate TKGM OVA 11](images/01-integrate-tkgm-ova11.png){.thumbnail} - -Select the `Monitor`{.action} tab and click `Tasks`{.action}. - -![01 integrate TKGM OVA 12](images/01-integrate-tkgm-ova12.png){.thumbnail} - -Wait for the `Deploy OVF template` and `Import OVF package` tasks to complete. - -![01 integrate TKGM OVA 13](images/01-integrate-tkgm-ova13.png){.thumbnail} - -Right-click the deployed VM and choose `Convert to Template`{.action} from the `Template`{.action} menu. - -![01 integrate TKGM OVA 14](images/01-integrate-tkgm-ova14.png){.thumbnail} - -Answer `YES`{.action} to convert the virtual machine. - -![01 integrate TKGM OVA 15](images/01-integrate-tkgm-ova15.png){.thumbnail} - -Go to `Virtual Machines (and templates)`{.action} to see the template you have created. - -> [!primary] -> -> This template will be used when deploying **Tanzu Kubernetes Grid** clusters. It is used for the initial deployment of the administration cluster and for the installation of additional *WorkLoad* clusters. It should not be deleted from the **VMware** cluster. -> - -![01 integrate TKGM OVA 16](images/01-integrate-tkgm-ova16.png){.thumbnail} - -### Installation of the virtual machine **Bootstrap** provided by OVHcloud - -This virtual machine was created by OVHcloud from the documentation [Installing the CLI tool manually for deploying **Tanzu Kubernetes GRID**](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html). It is available as a template in **OVH Templates**. - -Log in to the OVHcloud homepage for your VMware cluster, and click `OVH Templates`{.action} to the right. - -![02 Add Bootstrapvm 01](images/02-add-bootstrap-vm-from-ova01.png){.thumbnail} - -In the **Select a template** window, choose the third template from the top that contains this information: - -- **Family**: Linux -- **Distribution**: Ubuntu -- **Version**: 22 - -![02 Add Bootstrapvm 02](images/02-add-bootstrap-vm-from-ova02.png){.thumbnail} - -Click the `Copy`{.action} icon to the right to copy the URL, the URL should end with **Ubuntu-22.04_TKGm-1.6_with_x.ovf**. Then click `Close`{.action}. - -![02 Add Bootstrapvm 03](images/02-add-bootstrap-vm-from-ova03.png){.thumbnail} - -In the vSphere interface, right-click the cluster and choose `Deploy an OVF Template`{.action} from the menu. - -![02 Add Bootstrapvm 03b](images/02-add-bootstrap-vm-from-ova03b.png){.thumbnail} - -Select `URL`{.action}, paste the previously copied URL and click `NEXT`{.action}. - -![02 Add Bootstrapvm 04](images/02-add-bootstrap-vm-from-ova04.png){.thumbnail} - -Leave the default positioning and click `NEXT`{.action}. - -![02 Add Bootstrapvm 05](images/02-add-bootstrap-vm-from-ova05.png){.thumbnail} - -Leave `Cluster1` and click `NEXT`{.action}. - -![02 Add Bootstrapvm 06](images/02-add-bootstrap-vm-from-ova06.png){.thumbnail} - -Click `NEXT`{.action} to validate your choices. - -![02 Add Bootstrapvm 07](images/02-add-bootstrap-vm-from-ova07.png){.thumbnail} - -Select a shared storage in NFS v3 and click `NEXT`{.action}. - -![02 Add Bootstrapvm 08](images/02-add-bootstrap-vm-from-ova08.png){.thumbnail} - -Choose `VLAN10` for the destination network and click `NEXT`{.action}. - -![02 Add Bootstrapvm 09](images/02-add-bootstrap-vm-from-ova09.png){.thumbnail} - -Add this information in **Networking**: - -- **Hostname**: `bootstrap` -- **IP Address**: `192.168.0.199` -- **Network CIDR Prefix**: `24` -- **Gateway**: `192.168.0.254` -- **DNS**: `213.186.33.99` - -> [!primary] -> -> The DNS server chosen in this guide is the OVHcloud server. -> - -Enter and confirm the password in **OS Credentials** and click `NEXT`{.action}. - -![02 Add Bootstrapvm 10](images/02-add-bootstrap-vm-from-ova10.png){.thumbnail} - -Click `FINISH`{.action}. - -![02 Add Bootstrapvm 11](images/02-add-bootstrap-vm-from-ova11.png){.thumbnail} - -Right-click the virtual machine you created, go to `Power`{.action} and click `Power On`{.action}. - -![02 Add Bootstrapvm 12](images/02-add-bootstrap-vm-from-ova12.png){.thumbnail} - -The booted virtual machine can be accessed via the console with the graphical interface or via **SSH**. - -Go to the virtual machine you have created, and click `LAUNCH WEB CONSOLE`{.action}. - -![02 Add Bootstrapvm 13](images/02-add-bootstrap-vm-from-ova13.png){.thumbnail} - -The graphical interface for the Linux virtual machine is then available. - -![02 Add Bootstrapvm 14](images/02-add-bootstrap-vm-from-ova14.png){.thumbnail} - -### Allowing access to the PCC cluster from the **Bootstrap** virtual machine - -The configuration and administration tools for **Tanzu Kubernetes Grid** are installed on the **Bootstrap** virtual machine. This virtual machine must be able to connect to the Internet and to the vSphere cluster. - -Write down **the public IP address** you use on this virtual machine and use this guide [Authorise IP addresses to connect to vCenter](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/autoriser_des_ip_a_se_connecter_au_vcenter) to grant access to the vSphere cluster to the new virtual machine. - -### Deploying the **Tanzu Kubernetes Grid** cluster on your infrastructure - -Log in to the `Ubuntu-22.04_TKGm-1.5.4_with_x` virtual machine, open a terminal, and run this command to create an **RSA** key: - -```bash -ssh-keygen -t rsa -b 4096 -C "youremail@yourdomain.com" -``` - -![03 Create TKG CLUSTER 01](images/03-create-tkg-cluster01.png){.thumbnail} - -Two files are created in the **~/.ssh** folder: - -- **id_rsa.pub** -- **id_rsa** - -Stay on the console and run this command: - -```bash -tanzu management-cluster create --ui --bind 192.168.0.199:8080 -``` - -> [!primary] -> -> When you run this command from the Linux console with the graphical interface, the web browser launches and connects to `https://192.168.0.199:8080`. If you have run this command from an **SSH** connection, you will need to connect to `https://192.168.0.199:8080` from a virtual machine on the same network with a graphical interface and an operational web browser. -> - -![03 Create TKG CLUSTER 02](images/03-create-tkg-cluster02.png){.thumbnail} - -Click `Deploy`{.action} below **VMware vSphere**. - -![03 Create TKG CLUSTER 03](images/03-create-tkg-cluster03.png){.thumbnail} - -Enter this information: - -- **VCENTER SERVER**: `VMware cluster FQDN` -- **USERNAME**: `VMware cluster user` -- **PASSWORD**: `VMware cluster user password` - -Then click `CONNECT`{.action}. - -![03 Create TKG CLUSTER 04](images/03-create-tkg-cluster04.png){.thumbnail} - -At the verification step of the **SSL Thumbprint**, click `CONTINUE`{.action}. - -![03 Create TKG CLUSTER 05](images/03-create-tkg-cluster05.png){.thumbnail} - -Click the cross in the top right to close the **vSphere 7.0.3 Environment Detected** window. - -![03 Create TKG CLUSTER 06](images/03-create-tkg-cluster06.png){.thumbnail} - -Paste the contents of the **~.ssh/id_rsa.pub** file into **SSH PUBLIC KEY** and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 07](images/03-create-tkg-cluster07.png){.thumbnail} - -Select `Production`{.action} on the right and select the `large etc...` **INSTANCE TYPE**. - -Enter these values: - -- **MANAGEMENT CLUSTER NAME (OPTIONAL)**: `tkgm-management-cluster`. -- **CONTROL PLANE ENDPOINT**: `192.168.0.10`. - -Click `NEXT`{.action} to proceed to the next step. - -![03 Create TKG CLUSTER 08](images/03-create-tkg-cluster08.png){.thumbnail} - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 09](images/03-create-tkg-cluster09.png){.thumbnail} - -In the **Metadata** option and then in the **LABELS (OPTIONAL)** section, type `tkgm` for the name and its value. - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 10](images/03-create-tkg-cluster10.png){.thumbnail} - -Enter these options: - -- **VM FOLDER**: `Storage folder for virtual machines`. -- **DATASTORE**: `Storage of virtual machines to be placed on a shared storage` . -- **CLUSTERS, HOSTS, AND RESOURCE POOLS**: `Cluster1`. - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 11](images/03-create-tkg-cluster11.png){.thumbnail} - -In **NETWORK NAME** select `VLAN10`{.action}. - -Click `NEXT`{.action}. - -![03 Create TKG CLUSTER 12](images/03-create-tkg-cluster12.png){.thumbnail} - -Disable the `Activate Identity Management Settings`{.action} option and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 13](images/03-create-tkg-cluster13.png){.thumbnail} - -Select the OVA image integrated into the `photon-3-kube-v1.22.9+vmware.1` cluster from the **OS Image** menu and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 14](images/03-create-tkg-cluster14.png){.thumbnail} - -Uncheck `Participate in the Customer Experience Improvement Program`{.action} and click `NEXT`{.action}. - -![03 Create TKG CLUSTER 15](images/03-create-tkg-cluster15.png){.thumbnail} - -Click `REVIEW CONFIGURATION`{.action}. - -![03 Create TKG CLUSTER 16](images/03-create-tkg-cluster16.png){.thumbnail} - -> [!primary] -> Take note of the name of the yaml file below **CLI Command Equivalent**, it will serve as a template for deploying a **WorkLoad** cluster. -> - -Scroll through the window and click `DEPLOY MANAGEMENT CLUSTER`{.action} - -![03 Create TKG CLUSTER 17](images/03-create-tkg-cluster17.png){.thumbnail} - -The **Tanzu Kubernetes Grid** cluster deployment is started, please wait for it to complete. - -> [!primary] -> The deployment will be completed when you see the **Management cluster created** and **Successfully installed all required plugins** messages in the window. -> -> ![03 Create TKG CLUSTER 18](images/03-create-tkg-cluster18.png){.thumbnail} -> -> Another indication that the installation is complete can be found in the console of the **Bootstrap** virtual machine in which will appear the **Management cluster created** and **You can now create your first workload cluster etc...** messages. - -> [!warning] -> -> Write down or copy the name of the **yaml** file in the `/home/tanzu/.config/tanzu/tkg/clusterconfigs` folder, it will be used to create a configuration file for installing a *WorkLoad cluster* -> - -![03 Create TKG CLUSTER 19](images/03-create-tkg-cluster19.png){.thumbnail} - -Go to the vCenter interface to see the seven virtual machines created. - -![04 VM CREATED ADFTER INSTALLATION 01](images/04-vm-created-after-installation01.png){.thumbnail} - -## Go further - -[Administrating a TKG cluster](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) - -[Introducing VMware Tanzu Kubernetes Grid](https://tanzu.vmware.com/kubernetes-grid) - -[Documentation de VMware Tanzu Kubenetes Grid](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/00-admin-cluster-diagram01.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/00-admin-cluster-diagram01.png deleted file mode 100644 index 0032d38c4ad..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/00-admin-cluster-diagram01.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova01.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova01.png deleted file mode 100644 index 216958f8dd4..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova01.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova02.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova02.png deleted file mode 100644 index bec34e0de18..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova02.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova03.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova03.png deleted file mode 100644 index 4cf4df01482..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova03.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova03b.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova03b.png deleted file mode 100644 index 692420ad220..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova03b.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova04.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova04.png deleted file mode 100644 index 3484d5f170e..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova04.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova05.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova05.png deleted file mode 100644 index cb888d231fb..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova05.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova06.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova06.png deleted file mode 100644 index a9d4bf9b52b..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova06.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova07.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova07.png deleted file mode 100644 index 59123f38aab..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova07.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova08.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova08.png deleted file mode 100644 index f294ea7cbc8..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova08.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova09.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova09.png deleted file mode 100644 index be61da4de78..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova09.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova10.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova10.png deleted file mode 100644 index 738da47dcc2..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova10.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova11.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova11.png deleted file mode 100644 index 1f7e37c1a2f..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova11.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova12.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova12.png deleted file mode 100644 index a5593b74f2b..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova12.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova13.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova13.png deleted file mode 100644 index 2621938b820..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova13.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova14.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova14.png deleted file mode 100644 index 9a3bde953a4..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova14.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova15.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova15.png deleted file mode 100644 index 42298b9c31c..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova15.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova16.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova16.png deleted file mode 100644 index 75cb802a50d..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/01-integrate-tkgm-ova16.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/02-add-bootstrap-vm-from-ova01.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/02-add-bootstrap-vm-from-ova01.png deleted file mode 100644 index 216958f8dd4..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/02-add-bootstrap-vm-from-ova01.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/02-add-bootstrap-vm-from-ova02.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/02-add-bootstrap-vm-from-ova02.png deleted file mode 100644 index 76ebd7a10cc..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/02-add-bootstrap-vm-from-ova02.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/02-add-bootstrap-vm-from-ova03.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/02-add-bootstrap-vm-from-ova03.png deleted file mode 100644 index a0d9fe7ae3d..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/02-add-bootstrap-vm-from-ova03.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/02-add-bootstrap-vm-from-ova03b.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/02-add-bootstrap-vm-from-ova03b.png deleted file mode 100644 index 85db15e3e74..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/02-add-bootstrap-vm-from-ova03b.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/02-add-bootstrap-vm-from-ova04.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/02-add-bootstrap-vm-from-ova04.png deleted file mode 100644 index 7efbb8e9625..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/02-add-bootstrap-vm-from-ova04.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/02-add-bootstrap-vm-from-ova05.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/02-add-bootstrap-vm-from-ova05.png deleted file mode 100644 index 0e0afc84282..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/02-add-bootstrap-vm-from-ova05.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/02-add-bootstrap-vm-from-ova06.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/02-add-bootstrap-vm-from-ova06.png deleted file mode 100644 index a5629d80dc2..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/02-add-bootstrap-vm-from-ova06.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/02-add-bootstrap-vm-from-ova07.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/02-add-bootstrap-vm-from-ova07.png deleted file mode 100644 index dac6be672d1..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/02-add-bootstrap-vm-from-ova07.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/02-add-bootstrap-vm-from-ova08.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/02-add-bootstrap-vm-from-ova08.png deleted file mode 100644 index 685361346d4..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/02-add-bootstrap-vm-from-ova08.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/02-add-bootstrap-vm-from-ova09.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/02-add-bootstrap-vm-from-ova09.png deleted file mode 100644 index 8f9a6985347..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/02-add-bootstrap-vm-from-ova09.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/02-add-bootstrap-vm-from-ova10.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/02-add-bootstrap-vm-from-ova10.png deleted file mode 100644 index c35a3dc6697..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/02-add-bootstrap-vm-from-ova10.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/02-add-bootstrap-vm-from-ova11.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/02-add-bootstrap-vm-from-ova11.png deleted file mode 100644 index cf47f9f70ea..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/02-add-bootstrap-vm-from-ova11.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/02-add-bootstrap-vm-from-ova12.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/02-add-bootstrap-vm-from-ova12.png deleted file mode 100644 index a45d98243d4..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/02-add-bootstrap-vm-from-ova12.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/02-add-bootstrap-vm-from-ova13.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/02-add-bootstrap-vm-from-ova13.png deleted file mode 100644 index 1ef541e3bb5..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/02-add-bootstrap-vm-from-ova13.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/02-add-bootstrap-vm-from-ova14.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/02-add-bootstrap-vm-from-ova14.png deleted file mode 100644 index 3ecf78a7ed4..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/02-add-bootstrap-vm-from-ova14.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster01.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster01.png deleted file mode 100644 index d1ef5db1cb7..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster01.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster02.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster02.png deleted file mode 100644 index 3b32ea78d86..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster02.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster03.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster03.png deleted file mode 100644 index 6b74314fc86..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster03.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster04.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster04.png deleted file mode 100644 index 9d0ef49885b..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster04.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster05.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster05.png deleted file mode 100644 index fa694293c28..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster05.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster06.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster06.png deleted file mode 100644 index c6d009366b8..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster06.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster07.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster07.png deleted file mode 100644 index 73e49a9166b..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster07.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster08.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster08.png deleted file mode 100644 index df87810a0d2..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster08.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster09.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster09.png deleted file mode 100644 index 3724766d0d5..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster09.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster10.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster10.png deleted file mode 100644 index 530aba0e14c..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster10.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster11.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster11.png deleted file mode 100644 index c14ec85a0ec..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster11.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster12.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster12.png deleted file mode 100644 index 04e2b8d509b..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster12.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster13.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster13.png deleted file mode 100644 index fd19078f30b..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster13.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster14.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster14.png deleted file mode 100644 index 911f4d25f39..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster14.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster15.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster15.png deleted file mode 100644 index 174d2107e17..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster15.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster16.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster16.png deleted file mode 100644 index 74e4c25f73f..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster16.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster17.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster17.png deleted file mode 100644 index c20bea2f663..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster17.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster18.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster18.png deleted file mode 100644 index 75f0b64021f..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster18.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster19.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster19.png deleted file mode 100644 index 80be5608d7e..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/03-create-tkg-cluster19.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/04-vm-created-after-installation01.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/04-vm-created-after-installation01.png deleted file mode 100644 index 87e43db9fdb..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/images/04-vm-created-after-installation01.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/meta.yaml b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/meta.yaml deleted file mode 100755 index 0296610e5be..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation/meta.yaml +++ /dev/null @@ -1,2 +0,0 @@ -id: 7eb5386d-0ec4-403d-9f9a-236195a2820c -full_slug: vmware-tanzu-tkgm-installation \ No newline at end of file diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/guide.de-de.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/guide.de-de.md deleted file mode 100644 index 34db3115c50..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/guide.de-de.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -title: Tanzu Management Cluster Grid-Verwaltung (EN) -excerpt: TKG administration to create a Workload cluster and add applications to this cluster -updated: 2022-11-10 ---- - -## Objective - -**This guide documents how to create a *Workload* cluster and add applications to it.** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/de/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- You need to have the **Tanzu Kubernetes GRID** administration cluster installed, using the [Install Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) guide. -- A VLAN with Internet access and a DHCP server -- You must have these resources: - - 16 GB memory, 4 vCPU, 40 GB storage per Kubernetes node (requires 6 nodes per **Workload** cluster in production mode). - -## Instructions - -We will deploy a *Workload* cluster on a **Tanzu Kubernetes Grid** management cluster and add an application. - -At the end of the installation, you will have six new virtual machines in addition to the seven that are required for the management cluster to work. - -![00 Cluster administration & workload Diagram01](images/00-tkc-mc-wc01.png){.thumbnail} - -### Deploying a *Workload cluster* - -The *Workload* cluster can be deployed on the same network as the administration cluster or on another network. In our case, we will deploy it on the same network for demonstration purposes. If you want to change networks, simply put the portgroup in the same configuration YAML of your workload cluster, as explained below in the `VSPHERE_NETWORK` section. Ensure that the management cluster can communicate with the workload cluster. - -Once you have added this cluster, you can then install applications. - -Copy the file that was used to create the administration cluster into a file named **tkg-workload-cluster.yaml**. - -```bash -cp ~/.config/tanzu/tkg/clusterconfigs/tkgmfile.yaml ~/tkg-workload-cluster.yaml -``` - -Edit the contents of the **~/tkg-workload-cluster.yaml** file by changing these values: - -```yaml -CLUSTER_NAME: tkg-workload-cluster -VSPHERE_CONTROL_PLANE_ENDPOINT: 192.168.0.11 -``` - -Run this command to create the cluster: - -```bash -tanzu cluster create --file tkg-workload-cluster.yaml -``` - -Connect to the cluster with these commands: - -```bash -# Authorisation of cluster connection -tanzu cluster kubeconfig get tkg-workload-cluster --admin -# Positioning on tkg-workload-cluster cluster -# Administrative accounts always have this form clustername-admin@clustername -kubectl config use-context tkg-workload-cluster-admin@tkg-workload-cluster -``` - -Log in to your vSphere interface to see the six virtual machines in the *Workload* cluster. - -![01 vm created 01](images/01-vm-created-after-cwl-deployment01.png){.thumbnail} - -### Load Balancer installation - -The **Load Balancer** links the *Workload* cluster network to the external network on the VMware cluster. To do this, we will use the **kube-vip** package, which will act as a *load balancer* between the internal network of the cluster and the VLAN10 network. You can find more information on the [kube-vip](https://kube-vip.io/) documentation. - -Run these commands from the **Bootstrap** virtual machine: - -```bash -# Creating a folder to host the kube-vip application from git -mkdir ~/kube-vip -# Moving into this folder -cd ~/kube-vip -# Data recovery from GitHub -git clone https://github.com/vrabbi/tkgm-customizations.git -# Moving to the application subfolder -cd tkgm-customizations/carvel-packages/kube-vip-package/ -# Applying pre-configuration -kubectl apply -n tanzu-package-repo-global -f metadata.yml -kubectl apply -n tanzu-package-repo-global -f package.yaml -``` - -Create the file **~/kube-vip/tkgm-customizations/carvel-packages/kube-vip-package/values.yaml** with this content that corresponds to the IP addresses that can be used on VLAN10 to deploy an application. - -```yaml -vip_range: 192.168.0.210-192.168.0.250 -``` - -Install the package using these commands: - -```bash -# Installation -tanzu package install kubevip -p kubevip.terasky.com -v 0.3.9 -f values.yaml -# Checking for the kubevip package - kubectl get packages -A -``` - -### Installing an application - -For demonstration purposes, we will deploy an application named **yelb** that uses 4 pods, one of which will be available via the kubevip load balancer. you can find more information on this [example KUBERNETES YELB](https://github.com/mreferre/yelb). - -Run these commands to install a new application in the **Workload** cluster from the **Bootstrap** virtual machine. - -```bash -# Creating a namespace for this application -kubectl create ns yelb -# Deploying the application from a source on the Internet -kubectl\ - -n yelb apply -f\ - https://raw.githubusercontent.com/lamw/yelb/master/deployments/platformdeployment/Kubernetes/yaml/yelb-k8s-loadbalancer.yaml -# Checking that the application is properly installed -kubectl get all -n yelb -``` - -The IP addresses internal to the KUBERNETES cluster appear in the **CLUSTER-IP** column, applications that are visible from outside the cluster have an IP address in the **EXTERNAL-IP** column. - -In this example, the website is accessible via the address **192.168.0.223** on port **80**. - -![02 Verify Application 01](images/02-verify-application-01.png){.thumbnail} - -In the **Bootstrap** console, use the web browser to connect to the URL `http://192.168.0.223`. - -![02 Verify Application 02](images/02-verify-application-02.png){.thumbnail} - -An application can consist of multiple pods that communicate with each other through the internal network of the workflow cluster. Some ports are opened on the VMware cluster network using the kube-vip module. - -![03 apps and load balancing](images/03-internetworkcommunication01.png){.thumbnail} - -## Go further - -[Installing Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Tanzu Kubernetes Grid VMware Overview](https://tanzu.vmware.com/kubernetes-grid) - -[VMware de Tanzu Kubenetes Grid documentation](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/guide.en-asia.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/guide.en-asia.md deleted file mode 100644 index 00a535aaa97..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/guide.en-asia.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -title: Tanzu Management Cluster Grid administration -excerpt: TKG administration to create a Workload cluster and add applications to this cluster -updated: 2022-11-10 ---- - -## Objective - -**This guide documents how to create a *Workload* cluster and add applications to it.** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/asia/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- You need to have the **Tanzu Kubernetes GRID** administration cluster installed, using the [Install Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) guide. -- A VLAN with Internet access and a DHCP server -- You must have these resources: - - 16 GB memory, 4 vCPU, 40 GB storage per Kubernetes node (requires 6 nodes per **Workload** cluster in production mode). - -## Instructions - -We will deploy a *Workload* cluster on a **Tanzu Kubernetes Grid** management cluster and add an application. - -At the end of the installation, you will have six new virtual machines in addition to the seven that are required for the management cluster to work. - -![00 Cluster administration & workload Diagram01](images/00-tkc-mc-wc01.png){.thumbnail} - -### Deploying a *Workload cluster* - -The *Workload* cluster can be deployed on the same network as the administration cluster or on another network. In our case, we will deploy it on the same network for demonstration purposes. If you want to change networks, simply put the portgroup in the same configuration YAML of your workload cluster, as explained below in the `VSPHERE_NETWORK` section. Ensure that the management cluster can communicate with the workload cluster. - -Once you have added this cluster, you can then install applications. - -Copy the file that was used to create the administration cluster into a file named **tkg-workload-cluster.yaml**. - -```bash -cp ~/.config/tanzu/tkg/clusterconfigs/tkgmfile.yaml ~/tkg-workload-cluster.yaml -``` - -Edit the contents of the **~/tkg-workload-cluster.yaml** file by changing these values: - -```yaml -CLUSTER_NAME: tkg-workload-cluster -VSPHERE_CONTROL_PLANE_ENDPOINT: 192.168.0.11 -``` - -Run this command to create the cluster: - -```bash -tanzu cluster create --file tkg-workload-cluster.yaml -``` - -Connect to the cluster with these commands: - -```bash -# Authorisation of cluster connection -tanzu cluster kubeconfig get tkg-workload-cluster --admin -# Positioning on tkg-workload-cluster cluster -# Administrative accounts always have this form clustername-admin@clustername -kubectl config use-context tkg-workload-cluster-admin@tkg-workload-cluster -``` - -Log in to your vSphere interface to see the six virtual machines in the *Workload* cluster. - -![01 vm created 01](images/01-vm-created-after-cwl-deployment01.png){.thumbnail} - -### Load Balancer installation - -The **Load Balancer** links the *Workload* cluster network to the external network on the VMware cluster. To do this, we will use the **kube-vip** package, which will act as a *load balancer* between the internal network of the cluster and the VLAN10 network. You can find more information on the [kube-vip](https://kube-vip.io/) documentation. - -Run these commands from the **Bootstrap** virtual machine: - -```bash -# Creating a folder to host the kube-vip application from git -mkdir ~/kube-vip -# Moving into this folder -cd ~/kube-vip -# Data recovery from GitHub -git clone https://github.com/vrabbi/tkgm-customizations.git -# Moving to the application subfolder -cd tkgm-customizations/carvel-packages/kube-vip-package/ -# Applying pre-configuration -kubectl apply -n tanzu-package-repo-global -f metadata.yml -kubectl apply -n tanzu-package-repo-global -f package.yaml -``` - -Create the file **~/kube-vip/tkgm-customizations/carvel-packages/kube-vip-package/values.yaml** with this content that corresponds to the IP addresses that can be used on VLAN10 to deploy an application. - -```yaml -vip_range: 192.168.0.210-192.168.0.250 -``` - -Install the package using these commands: - -```bash -# Installation -tanzu package install kubevip -p kubevip.terasky.com -v 0.3.9 -f values.yaml -# Checking for the kubevip package - kubectl get packages -A -``` - -### Installing an application - -For demonstration purposes, we will deploy an application named **yelb** that uses 4 pods, one of which will be available via the kubevip load balancer. you can find more information on this [example KUBERNETES YELB](https://github.com/mreferre/yelb). - -Run these commands to install a new application in the **Workload** cluster from the **Bootstrap** virtual machine. - -```bash -# Creating a namespace for this application -kubectl create ns yelb -# Deploying the application from a source on the Internet -kubectl\ - -n yelb apply -f\ - https://raw.githubusercontent.com/lamw/yelb/master/deployments/platformdeployment/Kubernetes/yaml/yelb-k8s-loadbalancer.yaml -# Checking that the application is properly installed -kubectl get all -n yelb -``` - -The IP addresses internal to the KUBERNETES cluster appear in the **CLUSTER-IP** column, applications that are visible from outside the cluster have an IP address in the **EXTERNAL-IP** column. - -In this example, the website is accessible via the address **192.168.0.223** on port **80**. - -![02 Verify Application 01](images/02-verify-application-01.png){.thumbnail} - -In the **Bootstrap** console, use the web browser to connect to the URL `http://192.168.0.223`. - -![02 Verify Application 02](images/02-verify-application-02.png){.thumbnail} - -An application can consist of multiple pods that communicate with each other through the internal network of the workflow cluster. Some ports are opened on the VMware cluster network using the kube-vip module. - -![03 apps and load balancing](images/03-internetworkcommunication01.png){.thumbnail} - -## Go further - -[Installing Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Tanzu Kubernetes Grid VMware Overview](https://tanzu.vmware.com/kubernetes-grid) - -[VMware de Tanzu Kubenetes Grid documentation](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/guide.en-au.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/guide.en-au.md deleted file mode 100644 index b11888220c6..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/guide.en-au.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -title: Tanzu Management Cluster Grid administration -excerpt: TKG administration to create a Workload cluster and add applications to this cluster -updated: 2022-11-10 ---- - -## Objective - -**This guide documents how to create a *Workload* cluster and add applications to it.** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/en-au/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- You need to have the **Tanzu Kubernetes GRID** administration cluster installed, using the [Install Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) guide. -- A VLAN with Internet access and a DHCP server -- You must have these resources: - - 16 GB memory, 4 vCPU, 40 GB storage per Kubernetes node (requires 6 nodes per **Workload** cluster in production mode). - -## Instructions - -We will deploy a *Workload* cluster on a **Tanzu Kubernetes Grid** management cluster and add an application. - -At the end of the installation, you will have six new virtual machines in addition to the seven that are required for the management cluster to work. - -![00 Cluster administration & workload Diagram01](images/00-tkc-mc-wc01.png){.thumbnail} - -### Deploying a *Workload cluster* - -The *Workload* cluster can be deployed on the same network as the administration cluster or on another network. In our case, we will deploy it on the same network for demonstration purposes. If you want to change networks, simply put the portgroup in the same configuration YAML of your workload cluster, as explained below in the `VSPHERE_NETWORK` section. Ensure that the management cluster can communicate with the workload cluster. - -Once you have added this cluster, you can then install applications. - -Copy the file that was used to create the administration cluster into a file named **tkg-workload-cluster.yaml**. - -```bash -cp ~/.config/tanzu/tkg/clusterconfigs/tkgmfile.yaml ~/tkg-workload-cluster.yaml -``` - -Edit the contents of the **~/tkg-workload-cluster.yaml** file by changing these values: - -```yaml -CLUSTER_NAME: tkg-workload-cluster -VSPHERE_CONTROL_PLANE_ENDPOINT: 192.168.0.11 -``` - -Run this command to create the cluster: - -```bash -tanzu cluster create --file tkg-workload-cluster.yaml -``` - -Connect to the cluster with these commands: - -```bash -# Authorisation of cluster connection -tanzu cluster kubeconfig get tkg-workload-cluster --admin -# Positioning on tkg-workload-cluster cluster -# Administrative accounts always have this form clustername-admin@clustername -kubectl config use-context tkg-workload-cluster-admin@tkg-workload-cluster -``` - -Log in to your vSphere interface to see the six virtual machines in the *Workload* cluster. - -![01 vm created 01](images/01-vm-created-after-cwl-deployment01.png){.thumbnail} - -### Load Balancer installation - -The **Load Balancer** links the *Workload* cluster network to the external network on the VMware cluster. To do this, we will use the **kube-vip** package, which will act as a *load balancer* between the internal network of the cluster and the VLAN10 network. You can find more information on the [kube-vip](https://kube-vip.io/) documentation. - -Run these commands from the **Bootstrap** virtual machine: - -```bash -# Creating a folder to host the kube-vip application from git -mkdir ~/kube-vip -# Moving into this folder -cd ~/kube-vip -# Data recovery from GitHub -git clone https://github.com/vrabbi/tkgm-customizations.git -# Moving to the application subfolder -cd tkgm-customizations/carvel-packages/kube-vip-package/ -# Applying pre-configuration -kubectl apply -n tanzu-package-repo-global -f metadata.yml -kubectl apply -n tanzu-package-repo-global -f package.yaml -``` - -Create the file **~/kube-vip/tkgm-customizations/carvel-packages/kube-vip-package/values.yaml** with this content that corresponds to the IP addresses that can be used on VLAN10 to deploy an application. - -```yaml -vip_range: 192.168.0.210-192.168.0.250 -``` - -Install the package using these commands: - -```bash -# Installation -tanzu package install kubevip -p kubevip.terasky.com -v 0.3.9 -f values.yaml -# Checking for the kubevip package - kubectl get packages -A -``` - -### Installing an application - -For demonstration purposes, we will deploy an application named **yelb** that uses 4 pods, one of which will be available via the kubevip load balancer. you can find more information on this [example KUBERNETES YELB](https://github.com/mreferre/yelb). - -Run these commands to install a new application in the **Workload** cluster from the **Bootstrap** virtual machine. - -```bash -# Creating a namespace for this application -kubectl create ns yelb -# Deploying the application from a source on the Internet -kubectl\ - -n yelb apply -f\ - https://raw.githubusercontent.com/lamw/yelb/master/deployments/platformdeployment/Kubernetes/yaml/yelb-k8s-loadbalancer.yaml -# Checking that the application is properly installed -kubectl get all -n yelb -``` - -The IP addresses internal to the KUBERNETES cluster appear in the **CLUSTER-IP** column, applications that are visible from outside the cluster have an IP address in the **EXTERNAL-IP** column. - -In this example, the website is accessible via the address **192.168.0.223** on port **80**. - -![02 Verify Application 01](images/02-verify-application-01.png){.thumbnail} - -In the **Bootstrap** console, use the web browser to connect to the URL `http://192.168.0.223`. - -![02 Verify Application 02](images/02-verify-application-02.png){.thumbnail} - -An application can consist of multiple pods that communicate with each other through the internal network of the workflow cluster. Some ports are opened on the VMware cluster network using the kube-vip module. - -![03 apps and load balancing](images/03-internetworkcommunication01.png){.thumbnail} - -## Go further - -[Installing Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Tanzu Kubernetes Grid VMware Overview](https://tanzu.vmware.com/kubernetes-grid) - -[VMware de Tanzu Kubenetes Grid documentation](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/guide.en-ca.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/guide.en-ca.md deleted file mode 100644 index 51c0c9dc5b9..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/guide.en-ca.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -title: Tanzu Management Cluster Grid administration -excerpt: TKG administration to create a Workload cluster and add applications to this cluster -updated: 2022-11-10 ---- - -## Objective - -**This guide documents how to create a *Workload* cluster and add applications to it.** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/en-ca/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- You need to have the **Tanzu Kubernetes GRID** administration cluster installed, using the [Install Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) guide. -- A VLAN with Internet access and a DHCP server -- You must have these resources: - - 16 GB memory, 4 vCPU, 40 GB storage per Kubernetes node (requires 6 nodes per **Workload** cluster in production mode). - -## Instructions - -We will deploy a *Workload* cluster on a **Tanzu Kubernetes Grid** management cluster and add an application. - -At the end of the installation, you will have six new virtual machines in addition to the seven that are required for the management cluster to work. - -![00 Cluster administration & workload Diagram01](images/00-tkc-mc-wc01.png){.thumbnail} - -### Deploying a *Workload cluster* - -The *Workload* cluster can be deployed on the same network as the administration cluster or on another network. In our case, we will deploy it on the same network for demonstration purposes. If you want to change networks, simply put the portgroup in the same configuration YAML of your workload cluster, as explained below in the `VSPHERE_NETWORK` section. Ensure that the management cluster can communicate with the workload cluster. - -Once you have added this cluster, you can then install applications. - -Copy the file that was used to create the administration cluster into a file named **tkg-workload-cluster.yaml**. - -```bash -cp ~/.config/tanzu/tkg/clusterconfigs/tkgmfile.yaml ~/tkg-workload-cluster.yaml -``` - -Edit the contents of the **~/tkg-workload-cluster.yaml** file by changing these values: - -```yaml -CLUSTER_NAME: tkg-workload-cluster -VSPHERE_CONTROL_PLANE_ENDPOINT: 192.168.0.11 -``` - -Run this command to create the cluster: - -```bash -tanzu cluster create --file tkg-workload-cluster.yaml -``` - -Connect to the cluster with these commands: - -```bash -# Authorisation of cluster connection -tanzu cluster kubeconfig get tkg-workload-cluster --admin -# Positioning on tkg-workload-cluster cluster -# Administrative accounts always have this form clustername-admin@clustername -kubectl config use-context tkg-workload-cluster-admin@tkg-workload-cluster -``` - -Log in to your vSphere interface to see the six virtual machines in the *Workload* cluster. - -![01 vm created 01](images/01-vm-created-after-cwl-deployment01.png){.thumbnail} - -### Load Balancer installation - -The **Load Balancer** links the *Workload* cluster network to the external network on the VMware cluster. To do this, we will use the **kube-vip** package, which will act as a *load balancer* between the internal network of the cluster and the VLAN10 network. You can find more information on the [kube-vip](https://kube-vip.io/) documentation. - -Run these commands from the **Bootstrap** virtual machine: - -```bash -# Creating a folder to host the kube-vip application from git -mkdir ~/kube-vip -# Moving into this folder -cd ~/kube-vip -# Data recovery from GitHub -git clone https://github.com/vrabbi/tkgm-customizations.git -# Moving to the application subfolder -cd tkgm-customizations/carvel-packages/kube-vip-package/ -# Applying pre-configuration -kubectl apply -n tanzu-package-repo-global -f metadata.yml -kubectl apply -n tanzu-package-repo-global -f package.yaml -``` - -Create the file **~/kube-vip/tkgm-customizations/carvel-packages/kube-vip-package/values.yaml** with this content that corresponds to the IP addresses that can be used on VLAN10 to deploy an application. - -```yaml -vip_range: 192.168.0.210-192.168.0.250 -``` - -Install the package using these commands: - -```bash -# Installation -tanzu package install kubevip -p kubevip.terasky.com -v 0.3.9 -f values.yaml -# Checking for the kubevip package - kubectl get packages -A -``` - -### Installing an application - -For demonstration purposes, we will deploy an application named **yelb** that uses 4 pods, one of which will be available via the kubevip load balancer. you can find more information on this [example KUBERNETES YELB](https://github.com/mreferre/yelb). - -Run these commands to install a new application in the **Workload** cluster from the **Bootstrap** virtual machine. - -```bash -# Creating a namespace for this application -kubectl create ns yelb -# Deploying the application from a source on the Internet -kubectl\ - -n yelb apply -f\ - https://raw.githubusercontent.com/lamw/yelb/master/deployments/platformdeployment/Kubernetes/yaml/yelb-k8s-loadbalancer.yaml -# Checking that the application is properly installed -kubectl get all -n yelb -``` - -The IP addresses internal to the KUBERNETES cluster appear in the **CLUSTER-IP** column, applications that are visible from outside the cluster have an IP address in the **EXTERNAL-IP** column. - -In this example, the website is accessible via the address **192.168.0.223** on port **80**. - -![02 Verify Application 01](images/02-verify-application-01.png){.thumbnail} - -In the **Bootstrap** console, use the web browser to connect to the URL `http://192.168.0.223`. - -![02 Verify Application 02](images/02-verify-application-02.png){.thumbnail} - -An application can consist of multiple pods that communicate with each other through the internal network of the workflow cluster. Some ports are opened on the VMware cluster network using the kube-vip module. - -![03 apps and load balancing](images/03-internetworkcommunication01.png){.thumbnail} - -## Go further - -[Installing Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Tanzu Kubernetes Grid VMware Overview](https://tanzu.vmware.com/kubernetes-grid) - -[VMware de Tanzu Kubenetes Grid documentation](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/guide.en-gb.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/guide.en-gb.md deleted file mode 100644 index d785e5398d0..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/guide.en-gb.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -title: Tanzu Management Cluster Grid administration -excerpt: TKG administration to create a Workload cluster and add applications to this cluster -updated: 2022-11-10 ---- - -## Objective - -**This guide documents how to create a *Workload* cluster and add applications to it.** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/en-gb/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- You need to have the **Tanzu Kubernetes GRID** administration cluster installed, using the [Install Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) guide. -- A VLAN with Internet access and a DHCP server -- You must have these resources: - - 16 GB memory, 4 vCPU, 40 GB storage per Kubernetes node (requires 6 nodes per **Workload** cluster in production mode). - -## Instructions - -We will deploy a *Workload* cluster on a **Tanzu Kubernetes Grid** management cluster and add an application. - -At the end of the installation, you will have six new virtual machines in addition to the seven that are required for the management cluster to work. - -![00 Cluster administration & workload Diagram01](images/00-tkc-mc-wc01.png){.thumbnail} - -### Deploying a *Workload cluster* - -The *Workload* cluster can be deployed on the same network as the administration cluster or on another network. In our case, we will deploy it on the same network for demonstration purposes. If you want to change networks, simply put the portgroup in the same configuration YAML of your workload cluster, as explained below in the `VSPHERE_NETWORK` section. Ensure that the management cluster can communicate with the workload cluster. - -Once you have added this cluster, you can then install applications. - -Copy the file that was used to create the administration cluster into a file named **tkg-workload-cluster.yaml**. - -```bash -cp ~/.config/tanzu/tkg/clusterconfigs/tkgmfile.yaml ~/tkg-workload-cluster.yaml -``` - -Edit the contents of the **~/tkg-workload-cluster.yaml** file by changing these values: - -```yaml -CLUSTER_NAME: tkg-workload-cluster -VSPHERE_CONTROL_PLANE_ENDPOINT: 192.168.0.11 -``` - -Run this command to create the cluster: - -```bash -tanzu cluster create --file tkg-workload-cluster.yaml -``` - -Connect to the cluster with these commands: - -```bash -# Authorisation of cluster connection -tanzu cluster kubeconfig get tkg-workload-cluster --admin -# Positioning on tkg-workload-cluster cluster -# Administrative accounts always have this form clustername-admin@clustername -kubectl config use-context tkg-workload-cluster-admin@tkg-workload-cluster -``` - -Log in to your vSphere interface to see the six virtual machines in the *Workload* cluster. - -![01 vm created 01](images/01-vm-created-after-cwl-deployment01.png){.thumbnail} - -### Load Balancer installation - -The **Load Balancer** links the *Workload* cluster network to the external network on the VMware cluster. To do this, we will use the **kube-vip** package, which will act as a *load balancer* between the internal network of the cluster and the VLAN10 network. You can find more information on the [kube-vip](https://kube-vip.io/) documentation. - -Run these commands from the **Bootstrap** virtual machine: - -```bash -# Creating a folder to host the kube-vip application from git -mkdir ~/kube-vip -# Moving into this folder -cd ~/kube-vip -# Data recovery from GitHub -git clone https://github.com/vrabbi/tkgm-customizations.git -# Moving to the application subfolder -cd tkgm-customizations/carvel-packages/kube-vip-package/ -# Applying pre-configuration -kubectl apply -n tanzu-package-repo-global -f metadata.yml -kubectl apply -n tanzu-package-repo-global -f package.yaml -``` - -Create the file **~/kube-vip/tkgm-customizations/carvel-packages/kube-vip-package/values.yaml** with this content that corresponds to the IP addresses that can be used on VLAN10 to deploy an application. - -```yaml -vip_range: 192.168.0.210-192.168.0.250 -``` - -Install the package using these commands: - -```bash -# Installation -tanzu package install kubevip -p kubevip.terasky.com -v 0.3.9 -f values.yaml -# Checking for the kubevip package - kubectl get packages -A -``` - -### Installing an application - -For demonstration purposes, we will deploy an application named **yelb** that uses 4 pods, one of which will be available via the kubevip load balancer. you can find more information on this [example KUBERNETES YELB](https://github.com/mreferre/yelb). - -Run these commands to install a new application in the **Workload** cluster from the **Bootstrap** virtual machine. - -```bash -# Creating a namespace for this application -kubectl create ns yelb -# Deploying the application from a source on the Internet -kubectl\ - -n yelb apply -f\ - https://raw.githubusercontent.com/lamw/yelb/master/deployments/platformdeployment/Kubernetes/yaml/yelb-k8s-loadbalancer.yaml -# Checking that the application is properly installed -kubectl get all -n yelb -``` - -The IP addresses internal to the KUBERNETES cluster appear in the **CLUSTER-IP** column, applications that are visible from outside the cluster have an IP address in the **EXTERNAL-IP** column. - -In this example, the website is accessible via the address **192.168.0.223** on port **80**. - -![02 Verify Application 01](images/02-verify-application-01.png){.thumbnail} - -In the **Bootstrap** console, use the web browser to connect to the URL `http://192.168.0.223`. - -![02 Verify Application 02](images/02-verify-application-02.png){.thumbnail} - -An application can consist of multiple pods that communicate with each other through the internal network of the workflow cluster. Some ports are opened on the VMware cluster network using the kube-vip module. - -![03 apps and load balancing](images/03-internetworkcommunication01.png){.thumbnail} - -## Go further - -[Installing Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Tanzu Kubernetes Grid VMware Overview](https://tanzu.vmware.com/kubernetes-grid) - -[VMware de Tanzu Kubenetes Grid documentation](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/guide.en-ie.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/guide.en-ie.md deleted file mode 100644 index 663414c814f..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/guide.en-ie.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -title: Tanzu Management Cluster Grid administration -excerpt: TKG administration to create a Workload cluster and add applications to this cluster -updated: 2022-11-10 ---- - -## Objective - -**This guide documents how to create a *Workload* cluster and add applications to it.** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/en-ie/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- You need to have the **Tanzu Kubernetes GRID** administration cluster installed, using the [Install Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) guide. -- A VLAN with Internet access and a DHCP server -- You must have these resources: - - 16 GB memory, 4 vCPU, 40 GB storage per Kubernetes node (requires 6 nodes per **Workload** cluster in production mode). - -## Instructions - -We will deploy a *Workload* cluster on a **Tanzu Kubernetes Grid** management cluster and add an application. - -At the end of the installation, you will have six new virtual machines in addition to the seven that are required for the management cluster to work. - -![00 Cluster administration & workload Diagram01](images/00-tkc-mc-wc01.png){.thumbnail} - -### Deploying a *Workload cluster* - -The *Workload* cluster can be deployed on the same network as the administration cluster or on another network. In our case, we will deploy it on the same network for demonstration purposes. If you want to change networks, simply put the portgroup in the same configuration YAML of your workload cluster, as explained below in the `VSPHERE_NETWORK` section. Ensure that the management cluster can communicate with the workload cluster. - -Once you have added this cluster, you can then install applications. - -Copy the file that was used to create the administration cluster into a file named **tkg-workload-cluster.yaml**. - -```bash -cp ~/.config/tanzu/tkg/clusterconfigs/tkgmfile.yaml ~/tkg-workload-cluster.yaml -``` - -Edit the contents of the **~/tkg-workload-cluster.yaml** file by changing these values: - -```yaml -CLUSTER_NAME: tkg-workload-cluster -VSPHERE_CONTROL_PLANE_ENDPOINT: 192.168.0.11 -``` - -Run this command to create the cluster: - -```bash -tanzu cluster create --file tkg-workload-cluster.yaml -``` - -Connect to the cluster with these commands: - -```bash -# Authorisation of cluster connection -tanzu cluster kubeconfig get tkg-workload-cluster --admin -# Positioning on tkg-workload-cluster cluster -# Administrative accounts always have this form clustername-admin@clustername -kubectl config use-context tkg-workload-cluster-admin@tkg-workload-cluster -``` - -Log in to your vSphere interface to see the six virtual machines in the *Workload* cluster. - -![01 vm created 01](images/01-vm-created-after-cwl-deployment01.png){.thumbnail} - -### Load Balancer installation - -The **Load Balancer** links the *Workload* cluster network to the external network on the VMware cluster. To do this, we will use the **kube-vip** package, which will act as a *load balancer* between the internal network of the cluster and the VLAN10 network. You can find more information on the [kube-vip](https://kube-vip.io/) documentation. - -Run these commands from the **Bootstrap** virtual machine: - -```bash -# Creating a folder to host the kube-vip application from git -mkdir ~/kube-vip -# Moving into this folder -cd ~/kube-vip -# Data recovery from GitHub -git clone https://github.com/vrabbi/tkgm-customizations.git -# Moving to the application subfolder -cd tkgm-customizations/carvel-packages/kube-vip-package/ -# Applying pre-configuration -kubectl apply -n tanzu-package-repo-global -f metadata.yml -kubectl apply -n tanzu-package-repo-global -f package.yaml -``` - -Create the file **~/kube-vip/tkgm-customizations/carvel-packages/kube-vip-package/values.yaml** with this content that corresponds to the IP addresses that can be used on VLAN10 to deploy an application. - -```yaml -vip_range: 192.168.0.210-192.168.0.250 -``` - -Install the package using these commands: - -```bash -# Installation -tanzu package install kubevip -p kubevip.terasky.com -v 0.3.9 -f values.yaml -# Checking for the kubevip package - kubectl get packages -A -``` - -### Installing an application - -For demonstration purposes, we will deploy an application named **yelb** that uses 4 pods, one of which will be available via the kubevip load balancer. you can find more information on this [example KUBERNETES YELB](https://github.com/mreferre/yelb). - -Run these commands to install a new application in the **Workload** cluster from the **Bootstrap** virtual machine. - -```bash -# Creating a namespace for this application -kubectl create ns yelb -# Deploying the application from a source on the Internet -kubectl\ - -n yelb apply -f\ - https://raw.githubusercontent.com/lamw/yelb/master/deployments/platformdeployment/Kubernetes/yaml/yelb-k8s-loadbalancer.yaml -# Checking that the application is properly installed -kubectl get all -n yelb -``` - -The IP addresses internal to the KUBERNETES cluster appear in the **CLUSTER-IP** column, applications that are visible from outside the cluster have an IP address in the **EXTERNAL-IP** column. - -In this example, the website is accessible via the address **192.168.0.223** on port **80**. - -![02 Verify Application 01](images/02-verify-application-01.png){.thumbnail} - -In the **Bootstrap** console, use the web browser to connect to the URL `http://192.168.0.223`. - -![02 Verify Application 02](images/02-verify-application-02.png){.thumbnail} - -An application can consist of multiple pods that communicate with each other through the internal network of the workflow cluster. Some ports are opened on the VMware cluster network using the kube-vip module. - -![03 apps and load balancing](images/03-internetworkcommunication01.png){.thumbnail} - -## Go further - -[Installing Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Tanzu Kubernetes Grid VMware Overview](https://tanzu.vmware.com/kubernetes-grid) - -[VMware de Tanzu Kubenetes Grid documentation](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/guide.en-sg.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/guide.en-sg.md deleted file mode 100644 index b9d533ce8ec..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/guide.en-sg.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -title: Tanzu Management Cluster Grid administration -excerpt: TKG administration to create a Workload cluster and add applications to this cluster -updated: 2022-11-10 ---- - -## Objective - -**This guide documents how to create a *Workload* cluster and add applications to it.** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/en-sg/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- You need to have the **Tanzu Kubernetes GRID** administration cluster installed, using the [Install Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) guide. -- A VLAN with Internet access and a DHCP server -- You must have these resources: - - 16 GB memory, 4 vCPU, 40 GB storage per Kubernetes node (requires 6 nodes per **Workload** cluster in production mode). - -## Instructions - -We will deploy a *Workload* cluster on a **Tanzu Kubernetes Grid** management cluster and add an application. - -At the end of the installation, you will have six new virtual machines in addition to the seven that are required for the management cluster to work. - -![00 Cluster administration & workload Diagram01](images/00-tkc-mc-wc01.png){.thumbnail} - -### Deploying a *Workload cluster* - -The *Workload* cluster can be deployed on the same network as the administration cluster or on another network. In our case, we will deploy it on the same network for demonstration purposes. If you want to change networks, simply put the portgroup in the same configuration YAML of your workload cluster, as explained below in the `VSPHERE_NETWORK` section. Ensure that the management cluster can communicate with the workload cluster. - -Once you have added this cluster, you can then install applications. - -Copy the file that was used to create the administration cluster into a file named **tkg-workload-cluster.yaml**. - -```bash -cp ~/.config/tanzu/tkg/clusterconfigs/tkgmfile.yaml ~/tkg-workload-cluster.yaml -``` - -Edit the contents of the **~/tkg-workload-cluster.yaml** file by changing these values: - -```yaml -CLUSTER_NAME: tkg-workload-cluster -VSPHERE_CONTROL_PLANE_ENDPOINT: 192.168.0.11 -``` - -Run this command to create the cluster: - -```bash -tanzu cluster create --file tkg-workload-cluster.yaml -``` - -Connect to the cluster with these commands: - -```bash -# Authorisation of cluster connection -tanzu cluster kubeconfig get tkg-workload-cluster --admin -# Positioning on tkg-workload-cluster cluster -# Administrative accounts always have this form clustername-admin@clustername -kubectl config use-context tkg-workload-cluster-admin@tkg-workload-cluster -``` - -Log in to your vSphere interface to see the six virtual machines in the *Workload* cluster. - -![01 vm created 01](images/01-vm-created-after-cwl-deployment01.png){.thumbnail} - -### Load Balancer installation - -The **Load Balancer** links the *Workload* cluster network to the external network on the VMware cluster. To do this, we will use the **kube-vip** package, which will act as a *load balancer* between the internal network of the cluster and the VLAN10 network. You can find more information on the [kube-vip](https://kube-vip.io/) documentation. - -Run these commands from the **Bootstrap** virtual machine: - -```bash -# Creating a folder to host the kube-vip application from git -mkdir ~/kube-vip -# Moving into this folder -cd ~/kube-vip -# Data recovery from GitHub -git clone https://github.com/vrabbi/tkgm-customizations.git -# Moving to the application subfolder -cd tkgm-customizations/carvel-packages/kube-vip-package/ -# Applying pre-configuration -kubectl apply -n tanzu-package-repo-global -f metadata.yml -kubectl apply -n tanzu-package-repo-global -f package.yaml -``` - -Create the file **~/kube-vip/tkgm-customizations/carvel-packages/kube-vip-package/values.yaml** with this content that corresponds to the IP addresses that can be used on VLAN10 to deploy an application. - -```yaml -vip_range: 192.168.0.210-192.168.0.250 -``` - -Install the package using these commands: - -```bash -# Installation -tanzu package install kubevip -p kubevip.terasky.com -v 0.3.9 -f values.yaml -# Checking for the kubevip package - kubectl get packages -A -``` - -### Installing an application - -For demonstration purposes, we will deploy an application named **yelb** that uses 4 pods, one of which will be available via the kubevip load balancer. you can find more information on this [example KUBERNETES YELB](https://github.com/mreferre/yelb). - -Run these commands to install a new application in the **Workload** cluster from the **Bootstrap** virtual machine. - -```bash -# Creating a namespace for this application -kubectl create ns yelb -# Deploying the application from a source on the Internet -kubectl\ - -n yelb apply -f\ - https://raw.githubusercontent.com/lamw/yelb/master/deployments/platformdeployment/Kubernetes/yaml/yelb-k8s-loadbalancer.yaml -# Checking that the application is properly installed -kubectl get all -n yelb -``` - -The IP addresses internal to the KUBERNETES cluster appear in the **CLUSTER-IP** column, applications that are visible from outside the cluster have an IP address in the **EXTERNAL-IP** column. - -In this example, the website is accessible via the address **192.168.0.223** on port **80**. - -![02 Verify Application 01](images/02-verify-application-01.png){.thumbnail} - -In the **Bootstrap** console, use the web browser to connect to the URL `http://192.168.0.223`. - -![02 Verify Application 02](images/02-verify-application-02.png){.thumbnail} - -An application can consist of multiple pods that communicate with each other through the internal network of the workflow cluster. Some ports are opened on the VMware cluster network using the kube-vip module. - -![03 apps and load balancing](images/03-internetworkcommunication01.png){.thumbnail} - -## Go further - -[Installing Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Tanzu Kubernetes Grid VMware Overview](https://tanzu.vmware.com/kubernetes-grid) - -[VMware de Tanzu Kubenetes Grid documentation](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/guide.en-us.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/guide.en-us.md deleted file mode 100644 index 90eb65f7224..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/guide.en-us.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -title: Tanzu Management Cluster Grid administration -excerpt: TKG administration to create a Workload cluster and add applications to this cluster -updated: 2022-11-10 ---- - -## Objective - -**This guide documents how to create a *Workload* cluster and add applications to it.** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/en/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- You need to have the **Tanzu Kubernetes GRID** administration cluster installed, using the [Install Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) guide. -- A VLAN with Internet access and a DHCP server -- You must have these resources: - - 16 GB memory, 4 vCPU, 40 GB storage per Kubernetes node (requires 6 nodes per **Workload** cluster in production mode). - -## Instructions - -We will deploy a *Workload* cluster on a **Tanzu Kubernetes Grid** management cluster and add an application. - -At the end of the installation, you will have six new virtual machines in addition to the seven that are required for the management cluster to work. - -![00 Cluster administration & workload Diagram01](images/00-tkc-mc-wc01.png){.thumbnail} - -### Deploying a *Workload cluster* - -The *Workload* cluster can be deployed on the same network as the administration cluster or on another network. In our case, we will deploy it on the same network for demonstration purposes. If you want to change networks, simply put the portgroup in the same configuration YAML of your workload cluster, as explained below in the `VSPHERE_NETWORK` section. Ensure that the management cluster can communicate with the workload cluster. - -Once you have added this cluster, you can then install applications. - -Copy the file that was used to create the administration cluster into a file named **tkg-workload-cluster.yaml**. - -```bash -cp ~/.config/tanzu/tkg/clusterconfigs/tkgmfile.yaml ~/tkg-workload-cluster.yaml -``` - -Edit the contents of the **~/tkg-workload-cluster.yaml** file by changing these values: - -```yaml -CLUSTER_NAME: tkg-workload-cluster -VSPHERE_CONTROL_PLANE_ENDPOINT: 192.168.0.11 -``` - -Run this command to create the cluster: - -```bash -tanzu cluster create --file tkg-workload-cluster.yaml -``` - -Connect to the cluster with these commands: - -```bash -# Authorisation of cluster connection -tanzu cluster kubeconfig get tkg-workload-cluster --admin -# Positioning on tkg-workload-cluster cluster -# Administrative accounts always have this form clustername-admin@clustername -kubectl config use-context tkg-workload-cluster-admin@tkg-workload-cluster -``` - -Log in to your vSphere interface to see the six virtual machines in the *Workload* cluster. - -![01 vm created 01](images/01-vm-created-after-cwl-deployment01.png){.thumbnail} - -### Load Balancer installation - -The **Load Balancer** links the *Workload* cluster network to the external network on the VMware cluster. To do this, we will use the **kube-vip** package, which will act as a *load balancer* between the internal network of the cluster and the VLAN10 network. You can find more information on the [kube-vip](https://kube-vip.io/) documentation. - -Run these commands from the **Bootstrap** virtual machine: - -```bash -# Creating a folder to host the kube-vip application from git -mkdir ~/kube-vip -# Moving into this folder -cd ~/kube-vip -# Data recovery from GitHub -git clone https://github.com/vrabbi/tkgm-customizations.git -# Moving to the application subfolder -cd tkgm-customizations/carvel-packages/kube-vip-package/ -# Applying pre-configuration -kubectl apply -n tanzu-package-repo-global -f metadata.yml -kubectl apply -n tanzu-package-repo-global -f package.yaml -``` - -Create the file **~/kube-vip/tkgm-customizations/carvel-packages/kube-vip-package/values.yaml** with this content that corresponds to the IP addresses that can be used on VLAN10 to deploy an application. - -```yaml -vip_range: 192.168.0.210-192.168.0.250 -``` - -Install the package using these commands: - -```bash -# Installation -tanzu package install kubevip -p kubevip.terasky.com -v 0.3.9 -f values.yaml -# Checking for the kubevip package - kubectl get packages -A -``` - -### Installing an application - -For demonstration purposes, we will deploy an application named **yelb** that uses 4 pods, one of which will be available via the kubevip load balancer. you can find more information on this [example KUBERNETES YELB](https://github.com/mreferre/yelb). - -Run these commands to install a new application in the **Workload** cluster from the **Bootstrap** virtual machine. - -```bash -# Creating a namespace for this application -kubectl create ns yelb -# Deploying the application from a source on the Internet -kubectl\ - -n yelb apply -f\ - https://raw.githubusercontent.com/lamw/yelb/master/deployments/platformdeployment/Kubernetes/yaml/yelb-k8s-loadbalancer.yaml -# Checking that the application is properly installed -kubectl get all -n yelb -``` - -The IP addresses internal to the KUBERNETES cluster appear in the **CLUSTER-IP** column, applications that are visible from outside the cluster have an IP address in the **EXTERNAL-IP** column. - -In this example, the website is accessible via the address **192.168.0.223** on port **80**. - -![02 Verify Application 01](images/02-verify-application-01.png){.thumbnail} - -In the **Bootstrap** console, use the web browser to connect to the URL `http://192.168.0.223`. - -![02 Verify Application 02](images/02-verify-application-02.png){.thumbnail} - -An application can consist of multiple pods that communicate with each other through the internal network of the workflow cluster. Some ports are opened on the VMware cluster network using the kube-vip module. - -![03 apps and load balancing](images/03-internetworkcommunication01.png){.thumbnail} - -## Go further - -[Installing Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Tanzu Kubernetes Grid VMware Overview](https://tanzu.vmware.com/kubernetes-grid) - -[VMware de Tanzu Kubenetes Grid documentation](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/guide.es-es.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/guide.es-es.md deleted file mode 100644 index ddb76a3ad91..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/guide.es-es.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -title: Administración de la cuadrícula del clúster de gestión de Tanzu (EN) -excerpt: TKG administration to create a Workload cluster and add applications to this cluster -updated: 2022-11-10 ---- - -## Objective - -**This guide documents how to create a *Workload* cluster and add applications to it.** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/es-es/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- You need to have the **Tanzu Kubernetes GRID** administration cluster installed, using the [Install Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) guide. -- A VLAN with Internet access and a DHCP server -- You must have these resources: - - 16 GB memory, 4 vCPU, 40 GB storage per Kubernetes node (requires 6 nodes per **Workload** cluster in production mode). - -## Instructions - -We will deploy a *Workload* cluster on a **Tanzu Kubernetes Grid** management cluster and add an application. - -At the end of the installation, you will have six new virtual machines in addition to the seven that are required for the management cluster to work. - -![00 Cluster administration & workload Diagram01](images/00-tkc-mc-wc01.png){.thumbnail} - -### Deploying a *Workload cluster* - -The *Workload* cluster can be deployed on the same network as the administration cluster or on another network. In our case, we will deploy it on the same network for demonstration purposes. If you want to change networks, simply put the portgroup in the same configuration YAML of your workload cluster, as explained below in the `VSPHERE_NETWORK` section. Ensure that the management cluster can communicate with the workload cluster. - -Once you have added this cluster, you can then install applications. - -Copy the file that was used to create the administration cluster into a file named **tkg-workload-cluster.yaml**. - -```bash -cp ~/.config/tanzu/tkg/clusterconfigs/tkgmfile.yaml ~/tkg-workload-cluster.yaml -``` - -Edit the contents of the **~/tkg-workload-cluster.yaml** file by changing these values: - -```yaml -CLUSTER_NAME: tkg-workload-cluster -VSPHERE_CONTROL_PLANE_ENDPOINT: 192.168.0.11 -``` - -Run this command to create the cluster: - -```bash -tanzu cluster create --file tkg-workload-cluster.yaml -``` - -Connect to the cluster with these commands: - -```bash -# Authorisation of cluster connection -tanzu cluster kubeconfig get tkg-workload-cluster --admin -# Positioning on tkg-workload-cluster cluster -# Administrative accounts always have this form clustername-admin@clustername -kubectl config use-context tkg-workload-cluster-admin@tkg-workload-cluster -``` - -Log in to your vSphere interface to see the six virtual machines in the *Workload* cluster. - -![01 vm created 01](images/01-vm-created-after-cwl-deployment01.png){.thumbnail} - -### Load Balancer installation - -The **Load Balancer** links the *Workload* cluster network to the external network on the VMware cluster. To do this, we will use the **kube-vip** package, which will act as a *load balancer* between the internal network of the cluster and the VLAN10 network. You can find more information on the [kube-vip](https://kube-vip.io/) documentation. - -Run these commands from the **Bootstrap** virtual machine: - -```bash -# Creating a folder to host the kube-vip application from git -mkdir ~/kube-vip -# Moving into this folder -cd ~/kube-vip -# Data recovery from GitHub -git clone https://github.com/vrabbi/tkgm-customizations.git -# Moving to the application subfolder -cd tkgm-customizations/carvel-packages/kube-vip-package/ -# Applying pre-configuration -kubectl apply -n tanzu-package-repo-global -f metadata.yml -kubectl apply -n tanzu-package-repo-global -f package.yaml -``` - -Create the file **~/kube-vip/tkgm-customizations/carvel-packages/kube-vip-package/values.yaml** with this content that corresponds to the IP addresses that can be used on VLAN10 to deploy an application. - -```yaml -vip_range: 192.168.0.210-192.168.0.250 -``` - -Install the package using these commands: - -```bash -# Installation -tanzu package install kubevip -p kubevip.terasky.com -v 0.3.9 -f values.yaml -# Checking for the kubevip package - kubectl get packages -A -``` - -### Installing an application - -For demonstration purposes, we will deploy an application named **yelb** that uses 4 pods, one of which will be available via the kubevip load balancer. you can find more information on this [example KUBERNETES YELB](https://github.com/mreferre/yelb). - -Run these commands to install a new application in the **Workload** cluster from the **Bootstrap** virtual machine. - -```bash -# Creating a namespace for this application -kubectl create ns yelb -# Deploying the application from a source on the Internet -kubectl\ - -n yelb apply -f\ - https://raw.githubusercontent.com/lamw/yelb/master/deployments/platformdeployment/Kubernetes/yaml/yelb-k8s-loadbalancer.yaml -# Checking that the application is properly installed -kubectl get all -n yelb -``` - -The IP addresses internal to the KUBERNETES cluster appear in the **CLUSTER-IP** column, applications that are visible from outside the cluster have an IP address in the **EXTERNAL-IP** column. - -In this example, the website is accessible via the address **192.168.0.223** on port **80**. - -![02 Verify Application 01](images/02-verify-application-01.png){.thumbnail} - -In the **Bootstrap** console, use the web browser to connect to the URL `http://192.168.0.223`. - -![02 Verify Application 02](images/02-verify-application-02.png){.thumbnail} - -An application can consist of multiple pods that communicate with each other through the internal network of the workflow cluster. Some ports are opened on the VMware cluster network using the kube-vip module. - -![03 apps and load balancing](images/03-internetworkcommunication01.png){.thumbnail} - -## Go further - -[Installing Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Tanzu Kubernetes Grid VMware Overview](https://tanzu.vmware.com/kubernetes-grid) - -[VMware de Tanzu Kubenetes Grid documentation](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/guide.es-us.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/guide.es-us.md deleted file mode 100644 index dda009d4257..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/guide.es-us.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -title: Administración de la cuadrícula del clúster de gestión de Tanzu (EN) -excerpt: TKG administration to create a Workload cluster and add applications to this cluster -updated: 2022-11-10 ---- - -## Objective - -**This guide documents how to create a *Workload* cluster and add applications to it.** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/es/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- You need to have the **Tanzu Kubernetes GRID** administration cluster installed, using the [Install Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) guide. -- A VLAN with Internet access and a DHCP server -- You must have these resources: - - 16 GB memory, 4 vCPU, 40 GB storage per Kubernetes node (requires 6 nodes per **Workload** cluster in production mode). - -## Instructions - -We will deploy a *Workload* cluster on a **Tanzu Kubernetes Grid** management cluster and add an application. - -At the end of the installation, you will have six new virtual machines in addition to the seven that are required for the management cluster to work. - -![00 Cluster administration & workload Diagram01](images/00-tkc-mc-wc01.png){.thumbnail} - -### Deploying a *Workload cluster* - -The *Workload* cluster can be deployed on the same network as the administration cluster or on another network. In our case, we will deploy it on the same network for demonstration purposes. If you want to change networks, simply put the portgroup in the same configuration YAML of your workload cluster, as explained below in the `VSPHERE_NETWORK` section. Ensure that the management cluster can communicate with the workload cluster. - -Once you have added this cluster, you can then install applications. - -Copy the file that was used to create the administration cluster into a file named **tkg-workload-cluster.yaml**. - -```bash -cp ~/.config/tanzu/tkg/clusterconfigs/tkgmfile.yaml ~/tkg-workload-cluster.yaml -``` - -Edit the contents of the **~/tkg-workload-cluster.yaml** file by changing these values: - -```yaml -CLUSTER_NAME: tkg-workload-cluster -VSPHERE_CONTROL_PLANE_ENDPOINT: 192.168.0.11 -``` - -Run this command to create the cluster: - -```bash -tanzu cluster create --file tkg-workload-cluster.yaml -``` - -Connect to the cluster with these commands: - -```bash -# Authorisation of cluster connection -tanzu cluster kubeconfig get tkg-workload-cluster --admin -# Positioning on tkg-workload-cluster cluster -# Administrative accounts always have this form clustername-admin@clustername -kubectl config use-context tkg-workload-cluster-admin@tkg-workload-cluster -``` - -Log in to your vSphere interface to see the six virtual machines in the *Workload* cluster. - -![01 vm created 01](images/01-vm-created-after-cwl-deployment01.png){.thumbnail} - -### Load Balancer installation - -The **Load Balancer** links the *Workload* cluster network to the external network on the VMware cluster. To do this, we will use the **kube-vip** package, which will act as a *load balancer* between the internal network of the cluster and the VLAN10 network. You can find more information on the [kube-vip](https://kube-vip.io/) documentation. - -Run these commands from the **Bootstrap** virtual machine: - -```bash -# Creating a folder to host the kube-vip application from git -mkdir ~/kube-vip -# Moving into this folder -cd ~/kube-vip -# Data recovery from GitHub -git clone https://github.com/vrabbi/tkgm-customizations.git -# Moving to the application subfolder -cd tkgm-customizations/carvel-packages/kube-vip-package/ -# Applying pre-configuration -kubectl apply -n tanzu-package-repo-global -f metadata.yml -kubectl apply -n tanzu-package-repo-global -f package.yaml -``` - -Create the file **~/kube-vip/tkgm-customizations/carvel-packages/kube-vip-package/values.yaml** with this content that corresponds to the IP addresses that can be used on VLAN10 to deploy an application. - -```yaml -vip_range: 192.168.0.210-192.168.0.250 -``` - -Install the package using these commands: - -```bash -# Installation -tanzu package install kubevip -p kubevip.terasky.com -v 0.3.9 -f values.yaml -# Checking for the kubevip package - kubectl get packages -A -``` - -### Installing an application - -For demonstration purposes, we will deploy an application named **yelb** that uses 4 pods, one of which will be available via the kubevip load balancer. you can find more information on this [example KUBERNETES YELB](https://github.com/mreferre/yelb). - -Run these commands to install a new application in the **Workload** cluster from the **Bootstrap** virtual machine. - -```bash -# Creating a namespace for this application -kubectl create ns yelb -# Deploying the application from a source on the Internet -kubectl\ - -n yelb apply -f\ - https://raw.githubusercontent.com/lamw/yelb/master/deployments/platformdeployment/Kubernetes/yaml/yelb-k8s-loadbalancer.yaml -# Checking that the application is properly installed -kubectl get all -n yelb -``` - -The IP addresses internal to the KUBERNETES cluster appear in the **CLUSTER-IP** column, applications that are visible from outside the cluster have an IP address in the **EXTERNAL-IP** column. - -In this example, the website is accessible via the address **192.168.0.223** on port **80**. - -![02 Verify Application 01](images/02-verify-application-01.png){.thumbnail} - -In the **Bootstrap** console, use the web browser to connect to the URL `http://192.168.0.223`. - -![02 Verify Application 02](images/02-verify-application-02.png){.thumbnail} - -An application can consist of multiple pods that communicate with each other through the internal network of the workflow cluster. Some ports are opened on the VMware cluster network using the kube-vip module. - -![03 apps and load balancing](images/03-internetworkcommunication01.png){.thumbnail} - -## Go further - -[Installing Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Tanzu Kubernetes Grid VMware Overview](https://tanzu.vmware.com/kubernetes-grid) - -[VMware de Tanzu Kubenetes Grid documentation](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/guide.fr-ca.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/guide.fr-ca.md deleted file mode 100644 index 34377695f5c..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/guide.fr-ca.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -title: Administrer Tanzu Management Cluster Grid -excerpt: Administration de TKG pour créer un cluster de Workload et ajouter des applications dans ce cluster -updated: 2022-11-10 ---- - -## Objectif - -**Ce guide vous permet de créer un cluster de *Workload* et ajouter des applications dans ce cluster.** - -> [!warning] -> OVHcloud vous met à disposition des services dont la configuration, la gestion et la responsabilité vous incombent. Il vous appartient donc de ce fait d’en assurer le bon fonctionnement. -> -> Ce guide a pour but de vous accompagner au mieux sur des tâches courantes. Néanmoins, nous vous recommandons de faire appel à un [prestataire spécialisé](https://partner.ovhcloud.com/fr/) si vous éprouvez des difficultés ou des doutes concernant l’administration, l’utilisation ou la mise en place d’un service sur un serveur. -> - -## Prérequis - -- Être contact administrateur de [l'infrastructure Hosted Private Cloud](https://www.ovhcloud.com/fr-ca/enterprise/products/hosted-private-cloud/), afin de recevoir les identifiants de connexion. -- Avoir un identifiant actif dans l'[espace client OVHcloud](/links/manager). -- Avoir un identifiant actif dans vSphere. -- Avoir installé le cluster d'administration **Tanzu Kubernetes GRID** à l'aide du guide « [Installer Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) ». -- Avoir un VLAN qui possède un accès à Internet et un serveur DHCP. -- Disposer de ces ressources : - - 16 Go de mémoire, 4 vCPU, 40 Go de stockage par nœud Kubernetes (il faut 6 nœuds par cluster de **Workload** dans le mode de production). - -## En pratique - -Nous allons déployer un cluster de *Workload* sur un cluster d'administration **Tanzu Kubernetes Grid** et ajouter une application. - -A la fin de l'installation, vous aurez six nouvelles machines virtuelles en plus des sept qui sont nécessaires au fonctionnement du cluster de management. - -![00 Cluster administration & workload Diagram01](images/00-tkc-mc-wc01.png){.thumbnail} - -### Déploiement d'un cluster de *Workload* - -Le cluster de *Workload* peut être déployé sur le même réseau que le cluster d'administration ou sur un autre. Dans notre cas, nous allons le déployer sur le même réseau pour la démonstration. Si vous voulez changer de réseau, il suffit de mettre le portgroup dans le même YAML de configuration de votre cluster de workload comme expliqué ci-dessous, dans la section `VSPHERE_NETWORK`. Assurez-vous que le cluster de management peut communiquer avec le cluster de workload. - -Après l'ajout de ce cluster, il sera alors possible d'installer des applications. - -Copiez le fichier qui a servi pour la création du cluster d'administration dans un fichier nommé **tkg-workload-cluster.yaml**. - -```bash -cp ~/.config/tanzu/tkg/clusterconfigs/tkgmfile.yaml ~/tkg-workload-cluster.yaml -``` - -Modifiez le contenu du fichier **~/tkg-workload-cluster.yaml** en changeant ces valeurs : - -```yaml -CLUSTER_NAME: tkg-workload-cluster -VSPHERE_CONTROL_PLANE_ENDPOINT: 192.168.0.11 -``` - -Lancez cette commande pour créer le cluster : - -```bash -tanzu cluster create --file tkg-workload-cluster.yaml -``` - -Connectez-vous au cluster avec ces commandes : - -```bash -# Autorisation de la connexion au cluster -tanzu cluster kubeconfig get tkg-workload-cluster --admin -# Positionnement sur le cluster tkg-workload-cluster -# Les comptes d'administration ont toujours la forme nomcluster-admin@nomcluster -kubectl config use-context tkg-workload-cluster-admin@tkg-workload-cluster -``` - -Connectez-vous à votre interface vSphere pour voir les six machines virtuelles du cluster de *Workload*. - -![01 vm created 01](images/01-vm-created-after-cwl-deployment01.png){.thumbnail} - -### Installation du Load-Balancer - -Le **Load-Balancer** fait le lien entre le réseau du cluster de *Workload* et le réseau externe qui se trouve sur le cluster VMware. Pour cela, nous allons utiliser le package **kube-vip** qui servira de *load-balancer* entre le réseau interne au cluster et le réseau du VLAN10. Vous trouverez plus d'informations sur la [documentation kube-vip](https://kube-vip.io/). - -Exécutez ces commandes à partir de la machine virtuelle de **Bootstrap** : - -```bash -# Création d'un dossier pour accueillir l'application kube-vip depuis git -mkdir ~/kube-vip -# Déplacement dans ce dossier -cd ~/kube-vip -# Récupération des données depuis GitHub -git clone https://github.com/vrabbi/tkgm-customizations.git -# Déplacement dans le sous dossier de l'application -cd tkgm-customizations/carvel-packages/kube-vip-package/ -# Application de la pré-configuration -kubectl apply -n tanzu-package-repo-global -f metadata.yml -kubectl apply -n tanzu-package-repo-global -f package.yaml -``` - -Créez le fichier **~/kube-vip/tkgm-customizations/carvel-packages/kube-vip-package/values.yaml** avec ce contenu qui correspond aux adresses IP utilisables sur le VLAN10 pour déployer une application. - -```yaml -vip_range: 192.168.0.210-192.168.0.250 -``` - -Installez le package à l'aide de ces commandes : - -```bash -# Installation -tanzu package install kubevip -p kubevip.terasky.com -v 0.3.9 -f values.yaml -# Vérification de la présence du package kubevip - kubectl get packages -A -``` - -### Installation d'une application - -A titre d'exemple, nous allons déployer une application nommée **yelb** qui utilise 4 pods dont un qui sera disponible via le load-balancer kubevip. vous trouverez plus d'informations sur cet [exemple KUBERNETES YELB](https://github.com/mreferre/yelb). - -Lancez ces commandes pour installer une nouvelle application dans le cluster de **Workload** à partir de la machine virtuelle de **Bootstrap**. - -```bash -# Création d'un espace de nom pour cette application -kubectl create ns yelb -# Déploiement de l'application depuis une source sur Internet -kubectl\ - -n yelb apply -f\ - https://raw.githubusercontent.com/lamw/yelb/master/deployments/platformdeployment/Kubernetes/yaml/yelb-k8s-loadbalancer.yaml -# Vérification de la bonne installation de l'application -kubectl get all -n yelb -``` - -Les adresses IP internes au cluster KUBERNETES apparaissent dans la colonne **CLUSTER-IP**, les applications qui sont visibles depuis l'extérieur du cluster ont une adresse IP dans la colonne **EXTERNAL-IP**. - -Dans cet exemple, le site web est accessible via l'adresse **192.168.0.223** sur le port **80**. - -![02 Verify Application 01](images/02-verify-application-01.png){.thumbnail} - -Dans la console **Bootstrap**, utilisez le navigateur web pour vous connecter sur l'URL `http://192.168.0.223`. - -![02 Verify Application 02](images/02-verify-application-02.png){.thumbnail} - -Une application peut être constituée de plusieurs pods qui communiquent entre eux au travers du réseau interne du cluster de Workflow. Certains ports sont ouverts sur le réseau du cluster VMware grâce au module kube-vip. - -![03 apps and load balancing](images/03-internetworkcommunication01.png){.thumbnail} - -## Aller plus loin - -[Installer Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Présentation VMware de Tanzu Kubernetes Grid](https://tanzu.vmware.com/kubernetes-grid) - -[Documentation VMware de Tanzu Kubenetes Grid](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Installation manuelle de l'outil CLI pour le déploiement de Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -Si vous avez besoin d'une formation ou d'une assistance technique pour la mise en oeuvre de nos solutions, contactez votre commercial ou cliquez sur [ce lien](/links/professional-services) pour obtenir un devis et demander une analyse personnalisée de votre projet à nos experts de l’équipe Professional Services. - -Échangez avec notre [communauté d'utilisateurs](/links/community). diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/guide.fr-fr.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/guide.fr-fr.md deleted file mode 100644 index 676524ddab3..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/guide.fr-fr.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -title: Administrer Tanzu Management Cluster Grid -excerpt: Administration de TKG pour créer un cluster de Workload et ajouter des applications dans ce cluster -updated: 2022-11-10 ---- - -## Objectif - -**Ce guide vous permet de créer un cluster de *Workload* et ajouter des applications dans ce cluster.** - -> [!warning] -> OVHcloud vous met à disposition des services dont la configuration, la gestion et la responsabilité vous incombent. Il vous appartient donc de ce fait d’en assurer le bon fonctionnement. -> -> Ce guide a pour but de vous accompagner au mieux sur des tâches courantes. Néanmoins, nous vous recommandons de faire appel à un [prestataire spécialisé](https://partner.ovhcloud.com/fr/) si vous éprouvez des difficultés ou des doutes concernant l’administration, l’utilisation ou la mise en place d’un service sur un serveur. -> - -## Prérequis - -- Être contact administrateur de [l'infrastructure Hosted Private Cloud](https://www.ovhcloud.com/fr/enterprise/products/hosted-private-cloud/), afin de recevoir les identifiants de connexion. -- Avoir un identifiant actif dans l'[espace client OVHcloud](/links/manager). -- Avoir un identifiant actif dans vSphere. -- Avoir installé le cluster d'administration **Tanzu Kubernetes GRID** à l'aide du guide « [Installer Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) ». -- Avoir un VLAN qui possède un accès à Internet et un serveur DHCP. -- Disposer de ces ressources : - - 16 Go de mémoire, 4 vCPU, 40 Go de stockage par nœud Kubernetes (il faut 6 nœuds par cluster de **Workload** dans le mode de production). - -## En pratique - -Nous allons déployer un cluster de *Workload* sur un cluster d'administration **Tanzu Kubernetes Grid** et ajouter une application. - -A la fin de l'installation, vous aurez six nouvelles machines virtuelles en plus des sept qui sont nécessaires au fonctionnement du cluster de management. - -![00 Cluster administration & workload Diagram01](images/00-tkc-mc-wc01.png){.thumbnail} - -### Déploiement d'un cluster de *Workload* - -Le cluster de *Workload* peut être déployé sur le même réseau que le cluster d'administration ou sur un autre. Dans notre cas, nous allons le déployer sur le même réseau pour la démonstration. Si vous voulez changer de réseau, il suffit de mettre le portgroup dans le même YAML de configuration de votre cluster de workload comme expliqué ci-dessous, dans la section `VSPHERE_NETWORK`. Assurez-vous que le cluster de management peut communiquer avec le cluster de workload. - -Après l'ajout de ce cluster, il sera alors possible d'installer des applications. - -Copiez le fichier qui a servi pour la création du cluster d'administration dans un fichier nommé **tkg-workload-cluster.yaml**. - -```bash -cp ~/.config/tanzu/tkg/clusterconfigs/tkgmfile.yaml ~/tkg-workload-cluster.yaml -``` - -Modifiez le contenu du fichier **~/tkg-workload-cluster.yaml** en changeant ces valeurs : - -```yaml -CLUSTER_NAME: tkg-workload-cluster -VSPHERE_CONTROL_PLANE_ENDPOINT: 192.168.0.11 -``` - -Lancez cette commande pour créer le cluster : - -```bash -tanzu cluster create --file tkg-workload-cluster.yaml -``` - -Connectez-vous au cluster avec ces commandes : - -```bash -# Autorisation de la connexion au cluster -tanzu cluster kubeconfig get tkg-workload-cluster --admin -# Positionnement sur le cluster tkg-workload-cluster -# Les comptes d'administration ont toujours la forme nomcluster-admin@nomcluster -kubectl config use-context tkg-workload-cluster-admin@tkg-workload-cluster -``` - -Connectez-vous à votre interface vSphere pour voir les six machines virtuelles du cluster de *Workload*. - -![01 vm created 01](images/01-vm-created-after-cwl-deployment01.png){.thumbnail} - -### Installation du Load-Balancer - -Le **Load-Balancer** fait le lien entre le réseau du cluster de *Workload* et le réseau externe qui se trouve sur le cluster VMware. Pour cela, nous allons utiliser le package **kube-vip** qui servira de *load-balancer* entre le réseau interne au cluster et le réseau du VLAN10. Vous trouverez plus d'informations sur la [documentation kube-vip](https://kube-vip.io/). - -Exécutez ces commandes à partir de la machine virtuelle de **Bootstrap** : - -```bash -# Création d'un dossier pour accueillir l'application kube-vip depuis git -mkdir ~/kube-vip -# Déplacement dans ce dossier -cd ~/kube-vip -# Récupération des données depuis GitHub -git clone https://github.com/vrabbi/tkgm-customizations.git -# Déplacement dans le sous dossier de l'application -cd tkgm-customizations/carvel-packages/kube-vip-package/ -# Application de la pré-configuration -kubectl apply -n tanzu-package-repo-global -f metadata.yml -kubectl apply -n tanzu-package-repo-global -f package.yaml -``` - -Créez le fichier **~/kube-vip/tkgm-customizations/carvel-packages/kube-vip-package/values.yaml** avec ce contenu qui correspond aux adresses IP utilisables sur le VLAN10 pour déployer une application. - -```yaml -vip_range: 192.168.0.210-192.168.0.250 -``` - -Installez le package à l'aide de ces commandes : - -```bash -# Installation -tanzu package install kubevip -p kubevip.terasky.com -v 0.3.9 -f values.yaml -# Vérification de la présence du package kubevip - kubectl get packages -A -``` - -### Installation d'une application - -A titre d'exemple, nous allons déployer une application nommée **yelb** qui utilise 4 pods dont un qui sera disponible via le load-balancer kubevip. vous trouverez plus d'informations sur cet [exemple KUBERNETES YELB](https://github.com/mreferre/yelb). - -Lancez ces commandes pour installer une nouvelle application dans le cluster de **Workload** à partir de la machine virtuelle de **Bootstrap**. - -```bash -# Création d'un espace de nom pour cette application -kubectl create ns yelb -# Déploiement de l'application depuis une source sur Internet -kubectl\ - -n yelb apply -f\ - https://raw.githubusercontent.com/lamw/yelb/master/deployments/platformdeployment/Kubernetes/yaml/yelb-k8s-loadbalancer.yaml -# Vérification de la bonne installation de l'application -kubectl get all -n yelb -``` - -Les adresses IP internes au cluster KUBERNETES apparaissent dans la colonne **CLUSTER-IP**, les applications qui sont visibles depuis l'extérieur du cluster ont une adresse IP dans la colonne **EXTERNAL-IP**. - -Dans cet exemple, le site web est accessible via l'adresse **192.168.0.223** sur le port **80**. - -![02 Verify Application 01](images/02-verify-application-01.png){.thumbnail} - -Dans la console **Bootstrap**, utilisez le navigateur web pour vous connecter sur l'URL `http://192.168.0.223`. - -![02 Verify Application 02](images/02-verify-application-02.png){.thumbnail} - -Une application peut être constituée de plusieurs pods qui communiquent entre eux au travers du réseau interne du cluster de Workflow. Certains ports sont ouverts sur le réseau du cluster VMware grâce au module kube-vip. - -![03 apps and load balancing](images/03-internetworkcommunication01.png){.thumbnail} - -## Aller plus loin - -[Installer Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Présentation VMware de Tanzu Kubernetes Grid](https://tanzu.vmware.com/kubernetes-grid) - -[Documentation VMware de Tanzu Kubenetes Grid](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Installation manuelle de l'outil CLI pour le déploiement de Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -Si vous avez besoin d'une formation ou d'une assistance technique pour la mise en oeuvre de nos solutions, contactez votre commercial ou cliquez sur [ce lien](/links/professional-services) pour obtenir un devis et demander une analyse personnalisée de votre projet à nos experts de l’équipe Professional Services. - -Échangez avec notre [communauté d'utilisateurs](/links/community). diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/guide.it-it.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/guide.it-it.md deleted file mode 100644 index 3d2292e8714..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/guide.it-it.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -title: Amministrazione Tanzu Management Cluster Grid (EN) -excerpt: TKG administration to create a Workload cluster and add applications to this cluster -updated: 2022-11-10 ---- - -## Objective - -**This guide documents how to create a *Workload* cluster and add applications to it.** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/it/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- You need to have the **Tanzu Kubernetes GRID** administration cluster installed, using the [Install Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) guide. -- A VLAN with Internet access and a DHCP server -- You must have these resources: - - 16 GB memory, 4 vCPU, 40 GB storage per Kubernetes node (requires 6 nodes per **Workload** cluster in production mode). - -## Instructions - -We will deploy a *Workload* cluster on a **Tanzu Kubernetes Grid** management cluster and add an application. - -At the end of the installation, you will have six new virtual machines in addition to the seven that are required for the management cluster to work. - -![00 Cluster administration & workload Diagram01](images/00-tkc-mc-wc01.png){.thumbnail} - -### Deploying a *Workload cluster* - -The *Workload* cluster can be deployed on the same network as the administration cluster or on another network. In our case, we will deploy it on the same network for demonstration purposes. If you want to change networks, simply put the portgroup in the same configuration YAML of your workload cluster, as explained below in the `VSPHERE_NETWORK` section. Ensure that the management cluster can communicate with the workload cluster. - -Once you have added this cluster, you can then install applications. - -Copy the file that was used to create the administration cluster into a file named **tkg-workload-cluster.yaml**. - -```bash -cp ~/.config/tanzu/tkg/clusterconfigs/tkgmfile.yaml ~/tkg-workload-cluster.yaml -``` - -Edit the contents of the **~/tkg-workload-cluster.yaml** file by changing these values: - -```yaml -CLUSTER_NAME: tkg-workload-cluster -VSPHERE_CONTROL_PLANE_ENDPOINT: 192.168.0.11 -``` - -Run this command to create the cluster: - -```bash -tanzu cluster create --file tkg-workload-cluster.yaml -``` - -Connect to the cluster with these commands: - -```bash -# Authorisation of cluster connection -tanzu cluster kubeconfig get tkg-workload-cluster --admin -# Positioning on tkg-workload-cluster cluster -# Administrative accounts always have this form clustername-admin@clustername -kubectl config use-context tkg-workload-cluster-admin@tkg-workload-cluster -``` - -Log in to your vSphere interface to see the six virtual machines in the *Workload* cluster. - -![01 vm created 01](images/01-vm-created-after-cwl-deployment01.png){.thumbnail} - -### Load Balancer installation - -The **Load Balancer** links the *Workload* cluster network to the external network on the VMware cluster. To do this, we will use the **kube-vip** package, which will act as a *load balancer* between the internal network of the cluster and the VLAN10 network. You can find more information on the [kube-vip](https://kube-vip.io/) documentation. - -Run these commands from the **Bootstrap** virtual machine: - -```bash -# Creating a folder to host the kube-vip application from git -mkdir ~/kube-vip -# Moving into this folder -cd ~/kube-vip -# Data recovery from GitHub -git clone https://github.com/vrabbi/tkgm-customizations.git -# Moving to the application subfolder -cd tkgm-customizations/carvel-packages/kube-vip-package/ -# Applying pre-configuration -kubectl apply -n tanzu-package-repo-global -f metadata.yml -kubectl apply -n tanzu-package-repo-global -f package.yaml -``` - -Create the file **~/kube-vip/tkgm-customizations/carvel-packages/kube-vip-package/values.yaml** with this content that corresponds to the IP addresses that can be used on VLAN10 to deploy an application. - -```yaml -vip_range: 192.168.0.210-192.168.0.250 -``` - -Install the package using these commands: - -```bash -# Installation -tanzu package install kubevip -p kubevip.terasky.com -v 0.3.9 -f values.yaml -# Checking for the kubevip package - kubectl get packages -A -``` - -### Installing an application - -For demonstration purposes, we will deploy an application named **yelb** that uses 4 pods, one of which will be available via the kubevip load balancer. you can find more information on this [example KUBERNETES YELB](https://github.com/mreferre/yelb). - -Run these commands to install a new application in the **Workload** cluster from the **Bootstrap** virtual machine. - -```bash -# Creating a namespace for this application -kubectl create ns yelb -# Deploying the application from a source on the Internet -kubectl\ - -n yelb apply -f\ - https://raw.githubusercontent.com/lamw/yelb/master/deployments/platformdeployment/Kubernetes/yaml/yelb-k8s-loadbalancer.yaml -# Checking that the application is properly installed -kubectl get all -n yelb -``` - -The IP addresses internal to the KUBERNETES cluster appear in the **CLUSTER-IP** column, applications that are visible from outside the cluster have an IP address in the **EXTERNAL-IP** column. - -In this example, the website is accessible via the address **192.168.0.223** on port **80**. - -![02 Verify Application 01](images/02-verify-application-01.png){.thumbnail} - -In the **Bootstrap** console, use the web browser to connect to the URL `http://192.168.0.223`. - -![02 Verify Application 02](images/02-verify-application-02.png){.thumbnail} - -An application can consist of multiple pods that communicate with each other through the internal network of the workflow cluster. Some ports are opened on the VMware cluster network using the kube-vip module. - -![03 apps and load balancing](images/03-internetworkcommunication01.png){.thumbnail} - -## Go further - -[Installing Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Tanzu Kubernetes Grid VMware Overview](https://tanzu.vmware.com/kubernetes-grid) - -[VMware de Tanzu Kubenetes Grid documentation](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/guide.pl-pl.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/guide.pl-pl.md deleted file mode 100644 index eda1d438c7a..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/guide.pl-pl.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -title: Administracja siecią klastra Tanzu Management (EN) -excerpt: TKG administration to create a Workload cluster and add applications to this cluster -updated: 2022-11-10 ---- - -## Objective - -**This guide documents how to create a *Workload* cluster and add applications to it.** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/pl/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- You need to have the **Tanzu Kubernetes GRID** administration cluster installed, using the [Install Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) guide. -- A VLAN with Internet access and a DHCP server -- You must have these resources: - - 16 GB memory, 4 vCPU, 40 GB storage per Kubernetes node (requires 6 nodes per **Workload** cluster in production mode). - -## Instructions - -We will deploy a *Workload* cluster on a **Tanzu Kubernetes Grid** management cluster and add an application. - -At the end of the installation, you will have six new virtual machines in addition to the seven that are required for the management cluster to work. - -![00 Cluster administration & workload Diagram01](images/00-tkc-mc-wc01.png){.thumbnail} - -### Deploying a *Workload cluster* - -The *Workload* cluster can be deployed on the same network as the administration cluster or on another network. In our case, we will deploy it on the same network for demonstration purposes. If you want to change networks, simply put the portgroup in the same configuration YAML of your workload cluster, as explained below in the `VSPHERE_NETWORK` section. Ensure that the management cluster can communicate with the workload cluster. - -Once you have added this cluster, you can then install applications. - -Copy the file that was used to create the administration cluster into a file named **tkg-workload-cluster.yaml**. - -```bash -cp ~/.config/tanzu/tkg/clusterconfigs/tkgmfile.yaml ~/tkg-workload-cluster.yaml -``` - -Edit the contents of the **~/tkg-workload-cluster.yaml** file by changing these values: - -```yaml -CLUSTER_NAME: tkg-workload-cluster -VSPHERE_CONTROL_PLANE_ENDPOINT: 192.168.0.11 -``` - -Run this command to create the cluster: - -```bash -tanzu cluster create --file tkg-workload-cluster.yaml -``` - -Connect to the cluster with these commands: - -```bash -# Authorisation of cluster connection -tanzu cluster kubeconfig get tkg-workload-cluster --admin -# Positioning on tkg-workload-cluster cluster -# Administrative accounts always have this form clustername-admin@clustername -kubectl config use-context tkg-workload-cluster-admin@tkg-workload-cluster -``` - -Log in to your vSphere interface to see the six virtual machines in the *Workload* cluster. - -![01 vm created 01](images/01-vm-created-after-cwl-deployment01.png){.thumbnail} - -### Load Balancer installation - -The **Load Balancer** links the *Workload* cluster network to the external network on the VMware cluster. To do this, we will use the **kube-vip** package, which will act as a *load balancer* between the internal network of the cluster and the VLAN10 network. You can find more information on the [kube-vip](https://kube-vip.io/) documentation. - -Run these commands from the **Bootstrap** virtual machine: - -```bash -# Creating a folder to host the kube-vip application from git -mkdir ~/kube-vip -# Moving into this folder -cd ~/kube-vip -# Data recovery from GitHub -git clone https://github.com/vrabbi/tkgm-customizations.git -# Moving to the application subfolder -cd tkgm-customizations/carvel-packages/kube-vip-package/ -# Applying pre-configuration -kubectl apply -n tanzu-package-repo-global -f metadata.yml -kubectl apply -n tanzu-package-repo-global -f package.yaml -``` - -Create the file **~/kube-vip/tkgm-customizations/carvel-packages/kube-vip-package/values.yaml** with this content that corresponds to the IP addresses that can be used on VLAN10 to deploy an application. - -```yaml -vip_range: 192.168.0.210-192.168.0.250 -``` - -Install the package using these commands: - -```bash -# Installation -tanzu package install kubevip -p kubevip.terasky.com -v 0.3.9 -f values.yaml -# Checking for the kubevip package - kubectl get packages -A -``` - -### Installing an application - -For demonstration purposes, we will deploy an application named **yelb** that uses 4 pods, one of which will be available via the kubevip load balancer. you can find more information on this [example KUBERNETES YELB](https://github.com/mreferre/yelb). - -Run these commands to install a new application in the **Workload** cluster from the **Bootstrap** virtual machine. - -```bash -# Creating a namespace for this application -kubectl create ns yelb -# Deploying the application from a source on the Internet -kubectl\ - -n yelb apply -f\ - https://raw.githubusercontent.com/lamw/yelb/master/deployments/platformdeployment/Kubernetes/yaml/yelb-k8s-loadbalancer.yaml -# Checking that the application is properly installed -kubectl get all -n yelb -``` - -The IP addresses internal to the KUBERNETES cluster appear in the **CLUSTER-IP** column, applications that are visible from outside the cluster have an IP address in the **EXTERNAL-IP** column. - -In this example, the website is accessible via the address **192.168.0.223** on port **80**. - -![02 Verify Application 01](images/02-verify-application-01.png){.thumbnail} - -In the **Bootstrap** console, use the web browser to connect to the URL `http://192.168.0.223`. - -![02 Verify Application 02](images/02-verify-application-02.png){.thumbnail} - -An application can consist of multiple pods that communicate with each other through the internal network of the workflow cluster. Some ports are opened on the VMware cluster network using the kube-vip module. - -![03 apps and load balancing](images/03-internetworkcommunication01.png){.thumbnail} - -## Go further - -[Installing Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Tanzu Kubernetes Grid VMware Overview](https://tanzu.vmware.com/kubernetes-grid) - -[VMware de Tanzu Kubenetes Grid documentation](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/guide.pt-pt.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/guide.pt-pt.md deleted file mode 100644 index 6d37b6c9081..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/guide.pt-pt.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -title: Administração de grade de cluster de gerenciamento Tanzu (EN) -excerpt: TKG administration to create a Workload cluster and add applications to this cluster -updated: 2022-11-10 ---- - -## Objective - -**This guide documents how to create a *Workload* cluster and add applications to it.** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/pt/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- You need to have the **Tanzu Kubernetes GRID** administration cluster installed, using the [Install Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) guide. -- A VLAN with Internet access and a DHCP server -- You must have these resources: - - 16 GB memory, 4 vCPU, 40 GB storage per Kubernetes node (requires 6 nodes per **Workload** cluster in production mode). - -## Instructions - -We will deploy a *Workload* cluster on a **Tanzu Kubernetes Grid** management cluster and add an application. - -At the end of the installation, you will have six new virtual machines in addition to the seven that are required for the management cluster to work. - -![00 Cluster administration & workload Diagram01](images/00-tkc-mc-wc01.png){.thumbnail} - -### Deploying a *Workload cluster* - -The *Workload* cluster can be deployed on the same network as the administration cluster or on another network. In our case, we will deploy it on the same network for demonstration purposes. If you want to change networks, simply put the portgroup in the same configuration YAML of your workload cluster, as explained below in the `VSPHERE_NETWORK` section. Ensure that the management cluster can communicate with the workload cluster. - -Once you have added this cluster, you can then install applications. - -Copy the file that was used to create the administration cluster into a file named **tkg-workload-cluster.yaml**. - -```bash -cp ~/.config/tanzu/tkg/clusterconfigs/tkgmfile.yaml ~/tkg-workload-cluster.yaml -``` - -Edit the contents of the **~/tkg-workload-cluster.yaml** file by changing these values: - -```yaml -CLUSTER_NAME: tkg-workload-cluster -VSPHERE_CONTROL_PLANE_ENDPOINT: 192.168.0.11 -``` - -Run this command to create the cluster: - -```bash -tanzu cluster create --file tkg-workload-cluster.yaml -``` - -Connect to the cluster with these commands: - -```bash -# Authorisation of cluster connection -tanzu cluster kubeconfig get tkg-workload-cluster --admin -# Positioning on tkg-workload-cluster cluster -# Administrative accounts always have this form clustername-admin@clustername -kubectl config use-context tkg-workload-cluster-admin@tkg-workload-cluster -``` - -Log in to your vSphere interface to see the six virtual machines in the *Workload* cluster. - -![01 vm created 01](images/01-vm-created-after-cwl-deployment01.png){.thumbnail} - -### Load Balancer installation - -The **Load Balancer** links the *Workload* cluster network to the external network on the VMware cluster. To do this, we will use the **kube-vip** package, which will act as a *load balancer* between the internal network of the cluster and the VLAN10 network. You can find more information on the [kube-vip](https://kube-vip.io/) documentation. - -Run these commands from the **Bootstrap** virtual machine: - -```bash -# Creating a folder to host the kube-vip application from git -mkdir ~/kube-vip -# Moving into this folder -cd ~/kube-vip -# Data recovery from GitHub -git clone https://github.com/vrabbi/tkgm-customizations.git -# Moving to the application subfolder -cd tkgm-customizations/carvel-packages/kube-vip-package/ -# Applying pre-configuration -kubectl apply -n tanzu-package-repo-global -f metadata.yml -kubectl apply -n tanzu-package-repo-global -f package.yaml -``` - -Create the file **~/kube-vip/tkgm-customizations/carvel-packages/kube-vip-package/values.yaml** with this content that corresponds to the IP addresses that can be used on VLAN10 to deploy an application. - -```yaml -vip_range: 192.168.0.210-192.168.0.250 -``` - -Install the package using these commands: - -```bash -# Installation -tanzu package install kubevip -p kubevip.terasky.com -v 0.3.9 -f values.yaml -# Checking for the kubevip package - kubectl get packages -A -``` - -### Installing an application - -For demonstration purposes, we will deploy an application named **yelb** that uses 4 pods, one of which will be available via the kubevip load balancer. you can find more information on this [example KUBERNETES YELB](https://github.com/mreferre/yelb). - -Run these commands to install a new application in the **Workload** cluster from the **Bootstrap** virtual machine. - -```bash -# Creating a namespace for this application -kubectl create ns yelb -# Deploying the application from a source on the Internet -kubectl\ - -n yelb apply -f\ - https://raw.githubusercontent.com/lamw/yelb/master/deployments/platformdeployment/Kubernetes/yaml/yelb-k8s-loadbalancer.yaml -# Checking that the application is properly installed -kubectl get all -n yelb -``` - -The IP addresses internal to the KUBERNETES cluster appear in the **CLUSTER-IP** column, applications that are visible from outside the cluster have an IP address in the **EXTERNAL-IP** column. - -In this example, the website is accessible via the address **192.168.0.223** on port **80**. - -![02 Verify Application 01](images/02-verify-application-01.png){.thumbnail} - -In the **Bootstrap** console, use the web browser to connect to the URL `http://192.168.0.223`. - -![02 Verify Application 02](images/02-verify-application-02.png){.thumbnail} - -An application can consist of multiple pods that communicate with each other through the internal network of the workflow cluster. Some ports are opened on the VMware cluster network using the kube-vip module. - -![03 apps and load balancing](images/03-internetworkcommunication01.png){.thumbnail} - -## Go further - -[Installing Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Tanzu Kubernetes Grid VMware Overview](https://tanzu.vmware.com/kubernetes-grid) - -[VMware de Tanzu Kubenetes Grid documentation](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/images/00-tkc-mc-wc01.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/images/00-tkc-mc-wc01.png deleted file mode 100644 index 3e342e1fef9..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/images/00-tkc-mc-wc01.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/images/01-vm-created-after-cwl-deployment01.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/images/01-vm-created-after-cwl-deployment01.png deleted file mode 100644 index f3163b1cde7..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/images/01-vm-created-after-cwl-deployment01.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/images/02-verify-application-01.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/images/02-verify-application-01.png deleted file mode 100644 index ac8f075782c..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/images/02-verify-application-01.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/images/02-verify-application-02.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/images/02-verify-application-02.png deleted file mode 100644 index 155cd97a4bc..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/images/02-verify-application-02.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/images/03-internetworkcommunication01.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/images/03-internetworkcommunication01.png deleted file mode 100644 index 6f076ffbe73..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/images/03-internetworkcommunication01.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/meta.yaml b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/meta.yaml deleted file mode 100755 index bbe3f9f777a..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage/meta.yaml +++ /dev/null @@ -1,2 +0,0 @@ -id: d8e50af7-b5f4-42de-b964-97b587c4e7a9 -full_slug: vmware-tanzu-tkgm-management \ No newline at end of file diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/guide.de-de.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/guide.de-de.md deleted file mode 100644 index 711c1c03ff6..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/guide.de-de.md +++ /dev/null @@ -1,225 +0,0 @@ ---- -title: Verwalten persistenter Volumes in Tanzu Kubernetes Grid (EN) -excerpt: How to deploy an application in Tanzu Kubernetes Grid with persistent volumes -updated: 2024-01-10 ---- - -## Objective - -**This guide documents how to manage persistent volumes on a Tanzu Kubernetes Grid cluster.** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/de/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- You need to have deployed the **Workload** **TKG** cluster using the [Tanzu Management Cluster Grid administration guide](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage). - -## Introduction - -Persistent volumes are used to store data permanently on a **Kubernetes** cluster. This mechanism is based on **Storage Classes**. There are various Storage Classes. Read the [Kubernetes Storage Classes](https://kubernetes.io/docs/concepts/storage/storage-classes/) guide for more information. - -When deploying a *WorkLoad* cluster, a Storage Class **CSI provisioner** is created and points to the **Datastore** folder that contains the virtual machines in the *WorkLoad* cluster. - -From your VMware cluster, go to the inventory. Select the storage icon to the left, and go to the datastore where your *WorkLoad* cluster was deployed. Go to the `Files`{.action} tab and click the `fcd`{.action} folder. - -The folder is empty because the *WorkLoad* cluster does not yet use persistent volumes. - -![01 Display FCD folder](images/01-display-fcd-folder01.png){.thumbnail} - -You can create additional Storage Classes for each *WorkLoad* cluster. - -## Instructions - -We will connect to a *WorkLoad* cluster from the console of the **Bootstrap** virtual machine. You can use the [Tanzu Management Cluster Grid administration](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) guide to create and manage a workload cluster. - -From the **Bootstrap** virtual machine console, run this command to view the contexts that can be used on this cluster: - -```bash -# Display all the contexts of your TANZU KUBERNETES GRID cluster -kubectl config get-contexts -``` - -Run this command to use the *WorkLoad* cluster: - -```bash -# Connect to WorkLoad cluster -kubectl config use-context tkgm-workload-cluster-admin@tkgm-workload-cluster -``` - -### Displaying Existing Storage Classes - -For information about the Storage Classes in a *WorkLoad* cluster, run these commands: - -```bash -# Display Storage Classes -kubectl get storageclass -# Storage Class description -kubectl describe storageclass nomclasse -``` - -### Creating a storage class on another datastore - -On our VMware cluster, we have two datastores connected to NFS servers. One of the datastores contains the virtual machines in the *WorkLoad* cluster, as well as the **fcd** folder used by the Storage Class in the *Workload* cluster. - -We will create a new Storage Class on the second datastore. - -Go back to your VMware cluster in storage management, select the second datastore, and click `Summary`{.action} in the tab on the left. - -Copy the `URL`{.action} below "Type: NFS 3". - -![02 Select URL01](images/02-display-datastore-url01.png) - -Go to the console of the **Bootstrap** virtual machine, edit a new file named `secondstorageclass.yaml` with this content: - -```yaml -kind: StorageClass -apiVersion: storage.k8s.io/v1 -metadata: - name: secondstorageclass - annotations: - storageclass.kubernetes.io/is-default-class: "true" -provisioner: csi.vsphere.vmware.com -parameters: - datastoreurl: "ds:///vmfs/volumes/xxxxxxxxxxxxxxxxx/" -``` - -Edit the file by replacing `ds:///vmfs/volumes/xxxxxxxxxxxxxxxxx/` with the URL you just copied. - -Next, run this command: - -```bash -# Creating storageclass from yaml file -kubectl apply -f secondstorageclass.yaml -# Display storageclasses -kubectl get storageclass -``` - -We are now seeing two Storage Classes: - -```bash -NAME PROVISIONER RECLAIMPOLICY VOLUMEBINDINGMODE ALLOWVOLUMEEXPANSION AGE -default (default) csi.vsphere.vmware.com Delete Immediate true 3d18h -secondstorageclass (default) csi.vsphere.vmware.com Delete Immediate false 12s -tanzu@bootstrap:~$ -``` - -### Creating a persistent volume in the default Storage class - -Create a file named `default-pvc-storage.yaml` with this content: - -```yaml -kind: PersistentVolumeClaim -apiVersion: v1 -metadata: - name: default-pvc-storage -spec: - accessModes: - - ReadWriteOnce - storageClassName: "default" - resources: - requests: - storage: 2Gi -``` - -The persistent storage name is next to `name`, `storageClassName` contains the name of the Storage Class that is used for this volume. - -Run this command to create the persistent volume: - -```bash -# Create a namespace that will be used for my persistent volume. -kubectl create namespace myspace -# Applying the configuration file to the created namespace. -kubectl apply -f default-pvc-storage.yaml -n myspace -# Display persistent volumes of created namespace -kubectl get pv,pvc -n myspace -``` - -Go back to the inventory in your **vCenter** interface, click on the `DataCenter`{.action} icon on the left, then go to the `Monitor`{.action} tab on the right, and click on `Container Volumes`{.action} to see the persistent volumes. - -The persistent volume that has been created is displayed, and to the right you can see the name of the datastore on which it is stored. - -![03 Display PV in vCenter 01](images/03-display-pv-vmware01.png){.thumbnail} - -Click the notebook icon to the left of the volume to view the details. - -![03 Display PV in vCenter 02](images/03-display-pv-vmware02.png){.thumbnail} - -The information about this persistent storage is displayed, and corresponds to what was created using Kubernetes commands. - -![03 Display PV in vCenter 03](images/03-display-pv-vmware03.png){.thumbnail} - -Go to the Datastore that is used by default, right-click the `Files`{.action} tab and scroll through the folders in the Datastore to the `fcd` folder. - -You see that the folder contains two files, a vmdk file that contains the persistent volume data and an associated temporary file. - -![03 Display PV in vCenter 04](images/03-display-pv-vmware04.png){.thumbnail} - -### Creating a persistent volume on the second Storage Class - -Return to the **Bootstrap** virtual machine and use the command line. - -Create a file named `second-storage-pvc.yaml`: - -```yaml -kind: PersistentVolumeClaim -apiVersion: v1 -metadata: - name: second-storage-pvc -spec: - accessModes: - - ReadWriteOnce - storageClassName: "secondstorageclass" - resources: - requests: - storage: 2Gi -``` - -The file uses the same syntax as the first persistent storage, but with a different name and **Storage Class**. - -Run this command to create the persistent volume in the **myspace namespace**: - -```bash -# Applying the configuration file to the created namespace. -kubectl apply -f second-storage-pvc.yaml -n myspace -# Display persistent volumes of created namespace -kubectl get pv,pvc -n myspace -``` - -The persistent volume is created on the second **Datastore**. - -Return to the **vCenter** interface. You will see that you do not have any new files in the `fcd` folder. - -![04 Display PV2 in vCenter 01](images/04-display-pv2-vmware01.png){.thumbnail} - -Right-click the second Datastore, go to the `fcd`{.action} folder for that datastore. You will see that you have two new files, as in the first datastore. - -![04 Display PV2 in vCenter 02](images/04-display-pv2-vmware02.png){.thumbnail} - -Go back to the `Datacenter`{.action} at the root of the datacenters, click on the `Monitor`{.action} tab, and choose `Container volumes`{.action} to see the two persistent volumes appear with their locations in the datastores. - -![04 Display PV2 in vCenter 03](images/04-display-pv2-vmware03.png){.thumbnail} - -## Go further - -[Introduction to Tanzu Kubernetes Grid at OVHcloud](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Installing Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Managing Tanzu Management Cluster Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) - -[Introducing VMware Tanzu Kubernetes Grid](https://tanzu.vmware.com/kubernetes-grid) - -[VMware Tanzu Kubenetes Grid documentation](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/guide.en-asia.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/guide.en-asia.md deleted file mode 100644 index 3a4dcbf1205..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/guide.en-asia.md +++ /dev/null @@ -1,225 +0,0 @@ ---- -title: Managing persistent volumes in Tanzu Kubernetes Grid -excerpt: How to deploy an application in Tanzu Kubernetes Grid with persistent volumes -updated: 2024-01-10 ---- - -## Objective - -**This guide documents how to manage persistent volumes on a Tanzu Kubernetes Grid cluster.** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/asia/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- You need to have deployed the **Workload** **TKG** cluster using the [Tanzu Management Cluster Grid administration guide](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage). - -## Introduction - -Persistent volumes are used to store data permanently on a **Kubernetes** cluster. This mechanism is based on **Storage Classes**. There are various Storage Classes. Read the [Kubernetes Storage Classes](https://kubernetes.io/docs/concepts/storage/storage-classes/) guide for more information. - -When deploying a *WorkLoad* cluster, a Storage Class **CSI provisioner** is created and points to the **Datastore** folder that contains the virtual machines in the *WorkLoad* cluster. - -From your VMware cluster, go to the inventory. Select the storage icon to the left, and go to the datastore where your *WorkLoad* cluster was deployed. Go to the `Files`{.action} tab and click the `fcd`{.action} folder. - -The folder is empty because the *WorkLoad* cluster does not yet use persistent volumes. - -![01 Display FCD folder](images/01-display-fcd-folder01.png){.thumbnail} - -You can create additional Storage Classes for each *WorkLoad* cluster. - -## Instructions - -We will connect to a *WorkLoad* cluster from the console of the **Bootstrap** virtual machine. You can use the [Tanzu Management Cluster Grid administration](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) guide to create and manage a workload cluster. - -From the **Bootstrap** virtual machine console, run this command to view the contexts that can be used on this cluster: - -```bash -# Display all the contexts of your TANZU KUBERNETES GRID cluster -kubectl config get-contexts -``` - -Run this command to use the *WorkLoad* cluster: - -```bash -# Connect to WorkLoad cluster -kubectl config use-context tkgm-workload-cluster-admin@tkgm-workload-cluster -``` - -### Displaying Existing Storage Classes - -For information about the Storage Classes in a *WorkLoad* cluster, run these commands: - -```bash -# Display Storage Classes -kubectl get storageclass -# Storage Class description -kubectl describe storageclass nomclasse -``` - -### Creating a storage class on another datastore - -On our VMware cluster, we have two datastores connected to NFS servers. One of the datastores contains the virtual machines in the *WorkLoad* cluster, as well as the **fcd** folder used by the Storage Class in the *Workload* cluster. - -We will create a new Storage Class on the second datastore. - -Go back to your VMware cluster in storage management, select the second datastore, and click `Summary`{.action} in the tab on the left. - -Copy the `URL`{.action} below "Type: NFS 3". - -![02 Select URL01](images/02-display-datastore-url01.png) - -Go to the console of the **Bootstrap** virtual machine, edit a new file named `secondstorageclass.yaml` with this content: - -```yaml -kind: StorageClass -apiVersion: storage.k8s.io/v1 -metadata: - name: secondstorageclass - annotations: - storageclass.kubernetes.io/is-default-class: "true" -provisioner: csi.vsphere.vmware.com -parameters: - datastoreurl: "ds:///vmfs/volumes/xxxxxxxxxxxxxxxxx/" -``` - -Edit the file by replacing `ds:///vmfs/volumes/xxxxxxxxxxxxxxxxx/` with the URL you just copied. - -Next, run this command: - -```bash -# Creating storageclass from yaml file -kubectl apply -f secondstorageclass.yaml -# Display storageclasses -kubectl get storageclass -``` - -We are now seeing two Storage Classes: - -```bash -NAME PROVISIONER RECLAIMPOLICY VOLUMEBINDINGMODE ALLOWVOLUMEEXPANSION AGE -default (default) csi.vsphere.vmware.com Delete Immediate true 3d18h -secondstorageclass (default) csi.vsphere.vmware.com Delete Immediate false 12s -tanzu@bootstrap:~$ -``` - -### Creating a persistent volume in the default Storage class - -Create a file named `default-pvc-storage.yaml` with this content: - -```yaml -kind: PersistentVolumeClaim -apiVersion: v1 -metadata: - name: default-pvc-storage -spec: - accessModes: - - ReadWriteOnce - storageClassName: "default" - resources: - requests: - storage: 2Gi -``` - -The persistent storage name is next to `name`, `storageClassName` contains the name of the Storage Class that is used for this volume. - -Run this command to create the persistent volume: - -```bash -# Create a namespace that will be used for my persistent volume. -kubectl create namespace myspace -# Applying the configuration file to the created namespace. -kubectl apply -f default-pvc-storage.yaml -n myspace -# Display persistent volumes of created namespace -kubectl get pv,pvc -n myspace -``` - -Go back to the inventory in your **vCenter** interface, click on the `DataCenter`{.action} icon on the left, then go to the `Monitor`{.action} tab on the right, and click on `Container Volumes`{.action} to see the persistent volumes. - -The persistent volume that has been created is displayed, and to the right you can see the name of the datastore on which it is stored. - -![03 Display PV in vCenter 01](images/03-display-pv-vmware01.png){.thumbnail} - -Click the notebook icon to the left of the volume to view the details. - -![03 Display PV in vCenter 02](images/03-display-pv-vmware02.png){.thumbnail} - -The information about this persistent storage is displayed, and corresponds to what was created using Kubernetes commands. - -![03 Display PV in vCenter 03](images/03-display-pv-vmware03.png){.thumbnail} - -Go to the Datastore that is used by default, right-click the `Files`{.action} tab and scroll through the folders in the Datastore to the `fcd` folder. - -You see that the folder contains two files, a vmdk file that contains the persistent volume data and an associated temporary file. - -![03 Display PV in vCenter 04](images/03-display-pv-vmware04.png){.thumbnail} - -### Creating a persistent volume on the second Storage Class - -Return to the **Bootstrap** virtual machine and use the command line. - -Create a file named `second-storage-pvc.yaml`: - -```yaml -kind: PersistentVolumeClaim -apiVersion: v1 -metadata: - name: second-storage-pvc -spec: - accessModes: - - ReadWriteOnce - storageClassName: "secondstorageclass" - resources: - requests: - storage: 2Gi -``` - -The file uses the same syntax as the first persistent storage, but with a different name and **Storage Class**. - -Run this command to create the persistent volume in the **myspace namespace**: - -```bash -# Applying the configuration file to the created namespace. -kubectl apply -f second-storage-pvc.yaml -n myspace -# Display persistent volumes of created namespace -kubectl get pv,pvc -n myspace -``` - -The persistent volume is created on the second **Datastore**. - -Return to the **vCenter** interface. You will see that you do not have any new files in the `fcd` folder. - -![04 Display PV2 in vCenter 01](images/04-display-pv2-vmware01.png){.thumbnail} - -Right-click the second Datastore, go to the `fcd`{.action} folder for that datastore. You will see that you have two new files, as in the first datastore. - -![04 Display PV2 in vCenter 02](images/04-display-pv2-vmware02.png){.thumbnail} - -Go back to the `Datacenter`{.action} at the root of the datacenters, click on the `Monitor`{.action} tab, and choose `Container volumes`{.action} to see the two persistent volumes appear with their locations in the datastores. - -![04 Display PV2 in vCenter 03](images/04-display-pv2-vmware03.png){.thumbnail} - -## Go further - -[Introduction to Tanzu Kubernetes Grid at OVHcloud](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Installing Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Managing Tanzu Management Cluster Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) - -[Introducing VMware Tanzu Kubernetes Grid](https://tanzu.vmware.com/kubernetes-grid) - -[VMware Tanzu Kubenetes Grid documentation](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/guide.en-au.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/guide.en-au.md deleted file mode 100644 index 61ae9782da6..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/guide.en-au.md +++ /dev/null @@ -1,225 +0,0 @@ ---- -title: Managing persistent volumes in Tanzu Kubernetes Grid -excerpt: How to deploy an application in Tanzu Kubernetes Grid with persistent volumes -updated: 2024-01-10 ---- - -## Objective - -**This guide documents how to manage persistent volumes on a Tanzu Kubernetes Grid cluster.** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/en-au/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- You need to have deployed the **Workload** **TKG** cluster using the [Tanzu Management Cluster Grid administration guide](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage). - -## Introduction - -Persistent volumes are used to store data permanently on a **Kubernetes** cluster. This mechanism is based on **Storage Classes**. There are various Storage Classes. Read the [Kubernetes Storage Classes](https://kubernetes.io/docs/concepts/storage/storage-classes/) guide for more information. - -When deploying a *WorkLoad* cluster, a Storage Class **CSI provisioner** is created and points to the **Datastore** folder that contains the virtual machines in the *WorkLoad* cluster. - -From your VMware cluster, go to the inventory. Select the storage icon to the left, and go to the datastore where your *WorkLoad* cluster was deployed. Go to the `Files`{.action} tab and click the `fcd`{.action} folder. - -The folder is empty because the *WorkLoad* cluster does not yet use persistent volumes. - -![01 Display FCD folder](images/01-display-fcd-folder01.png){.thumbnail} - -You can create additional Storage Classes for each *WorkLoad* cluster. - -## Instructions - -We will connect to a *WorkLoad* cluster from the console of the **Bootstrap** virtual machine. You can use the [Tanzu Management Cluster Grid administration](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) guide to create and manage a workload cluster. - -From the **Bootstrap** virtual machine console, run this command to view the contexts that can be used on this cluster: - -```bash -# Display all the contexts of your TANZU KUBERNETES GRID cluster -kubectl config get-contexts -``` - -Run this command to use the *WorkLoad* cluster: - -```bash -# Connect to WorkLoad cluster -kubectl config use-context tkgm-workload-cluster-admin@tkgm-workload-cluster -``` - -### Displaying Existing Storage Classes - -For information about the Storage Classes in a *WorkLoad* cluster, run these commands: - -```bash -# Display Storage Classes -kubectl get storageclass -# Storage Class description -kubectl describe storageclass nomclasse -``` - -### Creating a storage class on another datastore - -On our VMware cluster, we have two datastores connected to NFS servers. One of the datastores contains the virtual machines in the *WorkLoad* cluster, as well as the **fcd** folder used by the Storage Class in the *Workload* cluster. - -We will create a new Storage Class on the second datastore. - -Go back to your VMware cluster in storage management, select the second datastore, and click `Summary`{.action} in the tab on the left. - -Copy the `URL`{.action} below "Type: NFS 3". - -![02 Select URL01](images/02-display-datastore-url01.png) - -Go to the console of the **Bootstrap** virtual machine, edit a new file named `secondstorageclass.yaml` with this content: - -```yaml -kind: StorageClass -apiVersion: storage.k8s.io/v1 -metadata: - name: secondstorageclass - annotations: - storageclass.kubernetes.io/is-default-class: "true" -provisioner: csi.vsphere.vmware.com -parameters: - datastoreurl: "ds:///vmfs/volumes/xxxxxxxxxxxxxxxxx/" -``` - -Edit the file by replacing `ds:///vmfs/volumes/xxxxxxxxxxxxxxxxx/` with the URL you just copied. - -Next, run this command: - -```bash -# Creating storageclass from yaml file -kubectl apply -f secondstorageclass.yaml -# Display storageclasses -kubectl get storageclass -``` - -We are now seeing two Storage Classes: - -```bash -NAME PROVISIONER RECLAIMPOLICY VOLUMEBINDINGMODE ALLOWVOLUMEEXPANSION AGE -default (default) csi.vsphere.vmware.com Delete Immediate true 3d18h -secondstorageclass (default) csi.vsphere.vmware.com Delete Immediate false 12s -tanzu@bootstrap:~$ -``` - -### Creating a persistent volume in the default Storage class - -Create a file named `default-pvc-storage.yaml` with this content: - -```yaml -kind: PersistentVolumeClaim -apiVersion: v1 -metadata: - name: default-pvc-storage -spec: - accessModes: - - ReadWriteOnce - storageClassName: "default" - resources: - requests: - storage: 2Gi -``` - -The persistent storage name is next to `name`, `storageClassName` contains the name of the Storage Class that is used for this volume. - -Run this command to create the persistent volume: - -```bash -# Create a namespace that will be used for my persistent volume. -kubectl create namespace myspace -# Applying the configuration file to the created namespace. -kubectl apply -f default-pvc-storage.yaml -n myspace -# Display persistent volumes of created namespace -kubectl get pv,pvc -n myspace -``` - -Go back to the inventory in your **vCenter** interface, click on the `DataCenter`{.action} icon on the left, then go to the `Monitor`{.action} tab on the right, and click on `Container Volumes`{.action} to see the persistent volumes. - -The persistent volume that has been created is displayed, and to the right you can see the name of the datastore on which it is stored. - -![03 Display PV in vCenter 01](images/03-display-pv-vmware01.png){.thumbnail} - -Click the notebook icon to the left of the volume to view the details. - -![03 Display PV in vCenter 02](images/03-display-pv-vmware02.png){.thumbnail} - -The information about this persistent storage is displayed, and corresponds to what was created using Kubernetes commands. - -![03 Display PV in vCenter 03](images/03-display-pv-vmware03.png){.thumbnail} - -Go to the Datastore that is used by default, right-click the `Files`{.action} tab and scroll through the folders in the Datastore to the `fcd` folder. - -You see that the folder contains two files, a vmdk file that contains the persistent volume data and an associated temporary file. - -![03 Display PV in vCenter 04](images/03-display-pv-vmware04.png){.thumbnail} - -### Creating a persistent volume on the second Storage Class - -Return to the **Bootstrap** virtual machine and use the command line. - -Create a file named `second-storage-pvc.yaml`: - -```yaml -kind: PersistentVolumeClaim -apiVersion: v1 -metadata: - name: second-storage-pvc -spec: - accessModes: - - ReadWriteOnce - storageClassName: "secondstorageclass" - resources: - requests: - storage: 2Gi -``` - -The file uses the same syntax as the first persistent storage, but with a different name and **Storage Class**. - -Run this command to create the persistent volume in the **myspace namespace**: - -```bash -# Applying the configuration file to the created namespace. -kubectl apply -f second-storage-pvc.yaml -n myspace -# Display persistent volumes of created namespace -kubectl get pv,pvc -n myspace -``` - -The persistent volume is created on the second **Datastore**. - -Return to the **vCenter** interface. You will see that you do not have any new files in the `fcd` folder. - -![04 Display PV2 in vCenter 01](images/04-display-pv2-vmware01.png){.thumbnail} - -Right-click the second Datastore, go to the `fcd`{.action} folder for that datastore. You will see that you have two new files, as in the first datastore. - -![04 Display PV2 in vCenter 02](images/04-display-pv2-vmware02.png){.thumbnail} - -Go back to the `Datacenter`{.action} at the root of the datacenters, click on the `Monitor`{.action} tab, and choose `Container volumes`{.action} to see the two persistent volumes appear with their locations in the datastores. - -![04 Display PV2 in vCenter 03](images/04-display-pv2-vmware03.png){.thumbnail} - -## Go further - -[Introduction to Tanzu Kubernetes Grid at OVHcloud](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Installing Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Managing Tanzu Management Cluster Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) - -[Introducing VMware Tanzu Kubernetes Grid](https://tanzu.vmware.com/kubernetes-grid) - -[VMware Tanzu Kubenetes Grid documentation](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/guide.en-ca.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/guide.en-ca.md deleted file mode 100644 index 08141ca7d20..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/guide.en-ca.md +++ /dev/null @@ -1,225 +0,0 @@ ---- -title: Managing persistent volumes in Tanzu Kubernetes Grid -excerpt: How to deploy an application in Tanzu Kubernetes Grid with persistent volumes -updated: 2024-01-10 ---- - -## Objective - -**This guide documents how to manage persistent volumes on a Tanzu Kubernetes Grid cluster.** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/en-ca/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- You need to have deployed the **Workload** **TKG** cluster using the [Tanzu Management Cluster Grid administration guide](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage). - -## Introduction - -Persistent volumes are used to store data permanently on a **Kubernetes** cluster. This mechanism is based on **Storage Classes**. There are various Storage Classes. Read the [Kubernetes Storage Classes](https://kubernetes.io/docs/concepts/storage/storage-classes/) guide for more information. - -When deploying a *WorkLoad* cluster, a Storage Class **CSI provisioner** is created and points to the **Datastore** folder that contains the virtual machines in the *WorkLoad* cluster. - -From your VMware cluster, go to the inventory. Select the storage icon to the left, and go to the datastore where your *WorkLoad* cluster was deployed. Go to the `Files`{.action} tab and click the `fcd`{.action} folder. - -The folder is empty because the *WorkLoad* cluster does not yet use persistent volumes. - -![01 Display FCD folder](images/01-display-fcd-folder01.png){.thumbnail} - -You can create additional Storage Classes for each *WorkLoad* cluster. - -## Instructions - -We will connect to a *WorkLoad* cluster from the console of the **Bootstrap** virtual machine. You can use the [Tanzu Management Cluster Grid administration](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) guide to create and manage a workload cluster. - -From the **Bootstrap** virtual machine console, run this command to view the contexts that can be used on this cluster: - -```bash -# Display all the contexts of your TANZU KUBERNETES GRID cluster -kubectl config get-contexts -``` - -Run this command to use the *WorkLoad* cluster: - -```bash -# Connect to WorkLoad cluster -kubectl config use-context tkgm-workload-cluster-admin@tkgm-workload-cluster -``` - -### Displaying Existing Storage Classes - -For information about the Storage Classes in a *WorkLoad* cluster, run these commands: - -```bash -# Display Storage Classes -kubectl get storageclass -# Storage Class description -kubectl describe storageclass nomclasse -``` - -### Creating a storage class on another datastore - -On our VMware cluster, we have two datastores connected to NFS servers. One of the datastores contains the virtual machines in the *WorkLoad* cluster, as well as the **fcd** folder used by the Storage Class in the *Workload* cluster. - -We will create a new Storage Class on the second datastore. - -Go back to your VMware cluster in storage management, select the second datastore, and click `Summary`{.action} in the tab on the left. - -Copy the `URL`{.action} below "Type: NFS 3". - -![02 Select URL01](images/02-display-datastore-url01.png) - -Go to the console of the **Bootstrap** virtual machine, edit a new file named `secondstorageclass.yaml` with this content: - -```yaml -kind: StorageClass -apiVersion: storage.k8s.io/v1 -metadata: - name: secondstorageclass - annotations: - storageclass.kubernetes.io/is-default-class: "true" -provisioner: csi.vsphere.vmware.com -parameters: - datastoreurl: "ds:///vmfs/volumes/xxxxxxxxxxxxxxxxx/" -``` - -Edit the file by replacing `ds:///vmfs/volumes/xxxxxxxxxxxxxxxxx/` with the URL you just copied. - -Next, run this command: - -```bash -# Creating storageclass from yaml file -kubectl apply -f secondstorageclass.yaml -# Display storageclasses -kubectl get storageclass -``` - -We are now seeing two Storage Classes: - -```bash -NAME PROVISIONER RECLAIMPOLICY VOLUMEBINDINGMODE ALLOWVOLUMEEXPANSION AGE -default (default) csi.vsphere.vmware.com Delete Immediate true 3d18h -secondstorageclass (default) csi.vsphere.vmware.com Delete Immediate false 12s -tanzu@bootstrap:~$ -``` - -### Creating a persistent volume in the default Storage class - -Create a file named `default-pvc-storage.yaml` with this content: - -```yaml -kind: PersistentVolumeClaim -apiVersion: v1 -metadata: - name: default-pvc-storage -spec: - accessModes: - - ReadWriteOnce - storageClassName: "default" - resources: - requests: - storage: 2Gi -``` - -The persistent storage name is next to `name`, `storageClassName` contains the name of the Storage Class that is used for this volume. - -Run this command to create the persistent volume: - -```bash -# Create a namespace that will be used for my persistent volume. -kubectl create namespace myspace -# Applying the configuration file to the created namespace. -kubectl apply -f default-pvc-storage.yaml -n myspace -# Display persistent volumes of created namespace -kubectl get pv,pvc -n myspace -``` - -Go back to the inventory in your **vCenter** interface, click on the `DataCenter`{.action} icon on the left, then go to the `Monitor`{.action} tab on the right, and click on `Container Volumes`{.action} to see the persistent volumes. - -The persistent volume that has been created is displayed, and to the right you can see the name of the datastore on which it is stored. - -![03 Display PV in vCenter 01](images/03-display-pv-vmware01.png){.thumbnail} - -Click the notebook icon to the left of the volume to view the details. - -![03 Display PV in vCenter 02](images/03-display-pv-vmware02.png){.thumbnail} - -The information about this persistent storage is displayed, and corresponds to what was created using Kubernetes commands. - -![03 Display PV in vCenter 03](images/03-display-pv-vmware03.png){.thumbnail} - -Go to the Datastore that is used by default, right-click the `Files`{.action} tab and scroll through the folders in the Datastore to the `fcd` folder. - -You see that the folder contains two files, a vmdk file that contains the persistent volume data and an associated temporary file. - -![03 Display PV in vCenter 04](images/03-display-pv-vmware04.png){.thumbnail} - -### Creating a persistent volume on the second Storage Class - -Return to the **Bootstrap** virtual machine and use the command line. - -Create a file named `second-storage-pvc.yaml`: - -```yaml -kind: PersistentVolumeClaim -apiVersion: v1 -metadata: - name: second-storage-pvc -spec: - accessModes: - - ReadWriteOnce - storageClassName: "secondstorageclass" - resources: - requests: - storage: 2Gi -``` - -The file uses the same syntax as the first persistent storage, but with a different name and **Storage Class**. - -Run this command to create the persistent volume in the **myspace namespace**: - -```bash -# Applying the configuration file to the created namespace. -kubectl apply -f second-storage-pvc.yaml -n myspace -# Display persistent volumes of created namespace -kubectl get pv,pvc -n myspace -``` - -The persistent volume is created on the second **Datastore**. - -Return to the **vCenter** interface. You will see that you do not have any new files in the `fcd` folder. - -![04 Display PV2 in vCenter 01](images/04-display-pv2-vmware01.png){.thumbnail} - -Right-click the second Datastore, go to the `fcd`{.action} folder for that datastore. You will see that you have two new files, as in the first datastore. - -![04 Display PV2 in vCenter 02](images/04-display-pv2-vmware02.png){.thumbnail} - -Go back to the `Datacenter`{.action} at the root of the datacenters, click on the `Monitor`{.action} tab, and choose `Container volumes`{.action} to see the two persistent volumes appear with their locations in the datastores. - -![04 Display PV2 in vCenter 03](images/04-display-pv2-vmware03.png){.thumbnail} - -## Go further - -[Introduction to Tanzu Kubernetes Grid at OVHcloud](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Installing Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Managing Tanzu Management Cluster Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) - -[Introducing VMware Tanzu Kubernetes Grid](https://tanzu.vmware.com/kubernetes-grid) - -[VMware Tanzu Kubenetes Grid documentation](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/guide.en-gb.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/guide.en-gb.md deleted file mode 100644 index 752331a2938..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/guide.en-gb.md +++ /dev/null @@ -1,225 +0,0 @@ ---- -title: Managing persistent volumes in Tanzu Kubernetes Grid -excerpt: How to deploy an application in Tanzu Kubernetes Grid with persistent volumes -updated: 2024-01-10 ---- - -## Objective - -**This guide documents how to manage persistent volumes on a Tanzu Kubernetes Grid cluster.** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/en-gb/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- You need to have deployed the **Workload** **TKG** cluster using the [Tanzu Management Cluster Grid administration guide](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage). - -## Introduction - -Persistent volumes are used to store data permanently on a **Kubernetes** cluster. This mechanism is based on **Storage Classes**. There are various Storage Classes. Read the [Kubernetes Storage Classes](https://kubernetes.io/docs/concepts/storage/storage-classes/) guide for more information. - -When deploying a *WorkLoad* cluster, a Storage Class **CSI provisioner** is created and points to the **Datastore** folder that contains the virtual machines in the *WorkLoad* cluster. - -From your VMware cluster, go to the inventory. Select the storage icon to the left, and go to the datastore where your *WorkLoad* cluster was deployed. Go to the `Files`{.action} tab and click the `fcd`{.action} folder. - -The folder is empty because the *WorkLoad* cluster does not yet use persistent volumes. - -![01 Display FCD folder](images/01-display-fcd-folder01.png){.thumbnail} - -You can create additional Storage Classes for each *WorkLoad* cluster. - -## Instructions - -We will connect to a *WorkLoad* cluster from the console of the **Bootstrap** virtual machine. You can use the [Tanzu Management Cluster Grid administration](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) guide to create and manage a workload cluster. - -From the **Bootstrap** virtual machine console, run this command to view the contexts that can be used on this cluster: - -```bash -# Display all the contexts of your TANZU KUBERNETES GRID cluster -kubectl config get-contexts -``` - -Run this command to use the *WorkLoad* cluster: - -```bash -# Connect to WorkLoad cluster -kubectl config use-context tkgm-workload-cluster-admin@tkgm-workload-cluster -``` - -### Displaying Existing Storage Classes - -For information about the Storage Classes in a *WorkLoad* cluster, run these commands: - -```bash -# Display Storage Classes -kubectl get storageclass -# Storage Class description -kubectl describe storageclass nomclasse -``` - -### Creating a storage class on another datastore - -On our VMware cluster, we have two datastores connected to NFS servers. One of the datastores contains the virtual machines in the *WorkLoad* cluster, as well as the **fcd** folder used by the Storage Class in the *Workload* cluster. - -We will create a new Storage Class on the second datastore. - -Go back to your VMware cluster in storage management, select the second datastore, and click `Summary`{.action} in the tab on the left. - -Copy the `URL`{.action} below "Type: NFS 3". - -![02 Select URL01](images/02-display-datastore-url01.png) - -Go to the console of the **Bootstrap** virtual machine, edit a new file named `secondstorageclass.yaml` with this content: - -```yaml -kind: StorageClass -apiVersion: storage.k8s.io/v1 -metadata: - name: secondstorageclass - annotations: - storageclass.kubernetes.io/is-default-class: "true" -provisioner: csi.vsphere.vmware.com -parameters: - datastoreurl: "ds:///vmfs/volumes/xxxxxxxxxxxxxxxxx/" -``` - -Edit the file by replacing `ds:///vmfs/volumes/xxxxxxxxxxxxxxxxx/` with the URL you just copied. - -Next, run this command: - -```bash -# Creating storageclass from yaml file -kubectl apply -f secondstorageclass.yaml -# Display storageclasses -kubectl get storageclass -``` - -We are now seeing two Storage Classes: - -```bash -NAME PROVISIONER RECLAIMPOLICY VOLUMEBINDINGMODE ALLOWVOLUMEEXPANSION AGE -default (default) csi.vsphere.vmware.com Delete Immediate true 3d18h -secondstorageclass (default) csi.vsphere.vmware.com Delete Immediate false 12s -tanzu@bootstrap:~$ -``` - -### Creating a persistent volume in the default Storage class - -Create a file named `default-pvc-storage.yaml` with this content: - -```yaml -kind: PersistentVolumeClaim -apiVersion: v1 -metadata: - name: default-pvc-storage -spec: - accessModes: - - ReadWriteOnce - storageClassName: "default" - resources: - requests: - storage: 2Gi -``` - -The persistent storage name is next to `name`, `storageClassName` contains the name of the Storage Class that is used for this volume. - -Run this command to create the persistent volume: - -```bash -# Create a namespace that will be used for my persistent volume. -kubectl create namespace myspace -# Applying the configuration file to the created namespace. -kubectl apply -f default-pvc-storage.yaml -n myspace -# Display persistent volumes of created namespace -kubectl get pv,pvc -n myspace -``` - -Go back to the inventory in your **vCenter** interface, click on the `DataCenter`{.action} icon on the left, then go to the `Monitor`{.action} tab on the right, and click on `Container Volumes`{.action} to see the persistent volumes. - -The persistent volume that has been created is displayed, and to the right you can see the name of the datastore on which it is stored. - -![03 Display PV in vCenter 01](images/03-display-pv-vmware01.png){.thumbnail} - -Click the notebook icon to the left of the volume to view the details. - -![03 Display PV in vCenter 02](images/03-display-pv-vmware02.png){.thumbnail} - -The information about this persistent storage is displayed, and corresponds to what was created using Kubernetes commands. - -![03 Display PV in vCenter 03](images/03-display-pv-vmware03.png){.thumbnail} - -Go to the Datastore that is used by default, right-click the `Files`{.action} tab and scroll through the folders in the Datastore to the `fcd` folder. - -You see that the folder contains two files, a vmdk file that contains the persistent volume data and an associated temporary file. - -![03 Display PV in vCenter 04](images/03-display-pv-vmware04.png){.thumbnail} - -### Creating a persistent volume on the second Storage Class - -Return to the **Bootstrap** virtual machine and use the command line. - -Create a file named `second-storage-pvc.yaml`: - -```yaml -kind: PersistentVolumeClaim -apiVersion: v1 -metadata: - name: second-storage-pvc -spec: - accessModes: - - ReadWriteOnce - storageClassName: "secondstorageclass" - resources: - requests: - storage: 2Gi -``` - -The file uses the same syntax as the first persistent storage, but with a different name and **Storage Class**. - -Run this command to create the persistent volume in the **myspace namespace**: - -```bash -# Applying the configuration file to the created namespace. -kubectl apply -f second-storage-pvc.yaml -n myspace -# Display persistent volumes of created namespace -kubectl get pv,pvc -n myspace -``` - -The persistent volume is created on the second **Datastore**. - -Return to the **vCenter** interface. You will see that you do not have any new files in the `fcd` folder. - -![04 Display PV2 in vCenter 01](images/04-display-pv2-vmware01.png){.thumbnail} - -Right-click the second Datastore, go to the `fcd`{.action} folder for that datastore. You will see that you have two new files, as in the first datastore. - -![04 Display PV2 in vCenter 02](images/04-display-pv2-vmware02.png){.thumbnail} - -Go back to the `Datacenter`{.action} at the root of the datacenters, click on the `Monitor`{.action} tab, and choose `Container volumes`{.action} to see the two persistent volumes appear with their locations in the datastores. - -![04 Display PV2 in vCenter 03](images/04-display-pv2-vmware03.png){.thumbnail} - -## Go further - -[Introduction to Tanzu Kubernetes Grid at OVHcloud](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Installing Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Managing Tanzu Management Cluster Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) - -[Introducing VMware Tanzu Kubernetes Grid](https://tanzu.vmware.com/kubernetes-grid) - -[VMware Tanzu Kubenetes Grid documentation](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/guide.en-ie.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/guide.en-ie.md deleted file mode 100644 index 0b7c8ce1c97..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/guide.en-ie.md +++ /dev/null @@ -1,225 +0,0 @@ ---- -title: Managing persistent volumes in Tanzu Kubernetes Grid -excerpt: How to deploy an application in Tanzu Kubernetes Grid with persistent volumes -updated: 2024-01-10 ---- - -## Objective - -**This guide documents how to manage persistent volumes on a Tanzu Kubernetes Grid cluster.** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/en-ie/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- You need to have deployed the **Workload** **TKG** cluster using the [Tanzu Management Cluster Grid administration guide](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage). - -## Introduction - -Persistent volumes are used to store data permanently on a **Kubernetes** cluster. This mechanism is based on **Storage Classes**. There are various Storage Classes. Read the [Kubernetes Storage Classes](https://kubernetes.io/docs/concepts/storage/storage-classes/) guide for more information. - -When deploying a *WorkLoad* cluster, a Storage Class **CSI provisioner** is created and points to the **Datastore** folder that contains the virtual machines in the *WorkLoad* cluster. - -From your VMware cluster, go to the inventory. Select the storage icon to the left, and go to the datastore where your *WorkLoad* cluster was deployed. Go to the `Files`{.action} tab and click the `fcd`{.action} folder. - -The folder is empty because the *WorkLoad* cluster does not yet use persistent volumes. - -![01 Display FCD folder](images/01-display-fcd-folder01.png){.thumbnail} - -You can create additional Storage Classes for each *WorkLoad* cluster. - -## Instructions - -We will connect to a *WorkLoad* cluster from the console of the **Bootstrap** virtual machine. You can use the [Tanzu Management Cluster Grid administration](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) guide to create and manage a workload cluster. - -From the **Bootstrap** virtual machine console, run this command to view the contexts that can be used on this cluster: - -```bash -# Display all the contexts of your TANZU KUBERNETES GRID cluster -kubectl config get-contexts -``` - -Run this command to use the *WorkLoad* cluster: - -```bash -# Connect to WorkLoad cluster -kubectl config use-context tkgm-workload-cluster-admin@tkgm-workload-cluster -``` - -### Displaying Existing Storage Classes - -For information about the Storage Classes in a *WorkLoad* cluster, run these commands: - -```bash -# Display Storage Classes -kubectl get storageclass -# Storage Class description -kubectl describe storageclass nomclasse -``` - -### Creating a storage class on another datastore - -On our VMware cluster, we have two datastores connected to NFS servers. One of the datastores contains the virtual machines in the *WorkLoad* cluster, as well as the **fcd** folder used by the Storage Class in the *Workload* cluster. - -We will create a new Storage Class on the second datastore. - -Go back to your VMware cluster in storage management, select the second datastore, and click `Summary`{.action} in the tab on the left. - -Copy the `URL`{.action} below "Type: NFS 3". - -![02 Select URL01](images/02-display-datastore-url01.png) - -Go to the console of the **Bootstrap** virtual machine, edit a new file named `secondstorageclass.yaml` with this content: - -```yaml -kind: StorageClass -apiVersion: storage.k8s.io/v1 -metadata: - name: secondstorageclass - annotations: - storageclass.kubernetes.io/is-default-class: "true" -provisioner: csi.vsphere.vmware.com -parameters: - datastoreurl: "ds:///vmfs/volumes/xxxxxxxxxxxxxxxxx/" -``` - -Edit the file by replacing `ds:///vmfs/volumes/xxxxxxxxxxxxxxxxx/` with the URL you just copied. - -Next, run this command: - -```bash -# Creating storageclass from yaml file -kubectl apply -f secondstorageclass.yaml -# Display storageclasses -kubectl get storageclass -``` - -We are now seeing two Storage Classes: - -```bash -NAME PROVISIONER RECLAIMPOLICY VOLUMEBINDINGMODE ALLOWVOLUMEEXPANSION AGE -default (default) csi.vsphere.vmware.com Delete Immediate true 3d18h -secondstorageclass (default) csi.vsphere.vmware.com Delete Immediate false 12s -tanzu@bootstrap:~$ -``` - -### Creating a persistent volume in the default Storage class - -Create a file named `default-pvc-storage.yaml` with this content: - -```yaml -kind: PersistentVolumeClaim -apiVersion: v1 -metadata: - name: default-pvc-storage -spec: - accessModes: - - ReadWriteOnce - storageClassName: "default" - resources: - requests: - storage: 2Gi -``` - -The persistent storage name is next to `name`, `storageClassName` contains the name of the Storage Class that is used for this volume. - -Run this command to create the persistent volume: - -```bash -# Create a namespace that will be used for my persistent volume. -kubectl create namespace myspace -# Applying the configuration file to the created namespace. -kubectl apply -f default-pvc-storage.yaml -n myspace -# Display persistent volumes of created namespace -kubectl get pv,pvc -n myspace -``` - -Go back to the inventory in your **vCenter** interface, click on the `DataCenter`{.action} icon on the left, then go to the `Monitor`{.action} tab on the right, and click on `Container Volumes`{.action} to see the persistent volumes. - -The persistent volume that has been created is displayed, and to the right you can see the name of the datastore on which it is stored. - -![03 Display PV in vCenter 01](images/03-display-pv-vmware01.png){.thumbnail} - -Click the notebook icon to the left of the volume to view the details. - -![03 Display PV in vCenter 02](images/03-display-pv-vmware02.png){.thumbnail} - -The information about this persistent storage is displayed, and corresponds to what was created using Kubernetes commands. - -![03 Display PV in vCenter 03](images/03-display-pv-vmware03.png){.thumbnail} - -Go to the Datastore that is used by default, right-click the `Files`{.action} tab and scroll through the folders in the Datastore to the `fcd` folder. - -You see that the folder contains two files, a vmdk file that contains the persistent volume data and an associated temporary file. - -![03 Display PV in vCenter 04](images/03-display-pv-vmware04.png){.thumbnail} - -### Creating a persistent volume on the second Storage Class - -Return to the **Bootstrap** virtual machine and use the command line. - -Create a file named `second-storage-pvc.yaml`: - -```yaml -kind: PersistentVolumeClaim -apiVersion: v1 -metadata: - name: second-storage-pvc -spec: - accessModes: - - ReadWriteOnce - storageClassName: "secondstorageclass" - resources: - requests: - storage: 2Gi -``` - -The file uses the same syntax as the first persistent storage, but with a different name and **Storage Class**. - -Run this command to create the persistent volume in the **myspace namespace**: - -```bash -# Applying the configuration file to the created namespace. -kubectl apply -f second-storage-pvc.yaml -n myspace -# Display persistent volumes of created namespace -kubectl get pv,pvc -n myspace -``` - -The persistent volume is created on the second **Datastore**. - -Return to the **vCenter** interface. You will see that you do not have any new files in the `fcd` folder. - -![04 Display PV2 in vCenter 01](images/04-display-pv2-vmware01.png){.thumbnail} - -Right-click the second Datastore, go to the `fcd`{.action} folder for that datastore. You will see that you have two new files, as in the first datastore. - -![04 Display PV2 in vCenter 02](images/04-display-pv2-vmware02.png){.thumbnail} - -Go back to the `Datacenter`{.action} at the root of the datacenters, click on the `Monitor`{.action} tab, and choose `Container volumes`{.action} to see the two persistent volumes appear with their locations in the datastores. - -![04 Display PV2 in vCenter 03](images/04-display-pv2-vmware03.png){.thumbnail} - -## Go further - -[Introduction to Tanzu Kubernetes Grid at OVHcloud](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Installing Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Managing Tanzu Management Cluster Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) - -[Introducing VMware Tanzu Kubernetes Grid](https://tanzu.vmware.com/kubernetes-grid) - -[VMware Tanzu Kubenetes Grid documentation](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/guide.en-sg.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/guide.en-sg.md deleted file mode 100644 index 7ac167d65c0..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/guide.en-sg.md +++ /dev/null @@ -1,225 +0,0 @@ ---- -title: Managing persistent volumes in Tanzu Kubernetes Grid -excerpt: How to deploy an application in Tanzu Kubernetes Grid with persistent volumes -updated: 2024-01-10 ---- - -## Objective - -**This guide documents how to manage persistent volumes on a Tanzu Kubernetes Grid cluster.** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/en-sg/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- You need to have deployed the **Workload** **TKG** cluster using the [Tanzu Management Cluster Grid administration guide](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage). - -## Introduction - -Persistent volumes are used to store data permanently on a **Kubernetes** cluster. This mechanism is based on **Storage Classes**. There are various Storage Classes. Read the [Kubernetes Storage Classes](https://kubernetes.io/docs/concepts/storage/storage-classes/) guide for more information. - -When deploying a *WorkLoad* cluster, a Storage Class **CSI provisioner** is created and points to the **Datastore** folder that contains the virtual machines in the *WorkLoad* cluster. - -From your VMware cluster, go to the inventory. Select the storage icon to the left, and go to the datastore where your *WorkLoad* cluster was deployed. Go to the `Files`{.action} tab and click the `fcd`{.action} folder. - -The folder is empty because the *WorkLoad* cluster does not yet use persistent volumes. - -![01 Display FCD folder](images/01-display-fcd-folder01.png){.thumbnail} - -You can create additional Storage Classes for each *WorkLoad* cluster. - -## Instructions - -We will connect to a *WorkLoad* cluster from the console of the **Bootstrap** virtual machine. You can use the [Tanzu Management Cluster Grid administration](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) guide to create and manage a workload cluster. - -From the **Bootstrap** virtual machine console, run this command to view the contexts that can be used on this cluster: - -```bash -# Display all the contexts of your TANZU KUBERNETES GRID cluster -kubectl config get-contexts -``` - -Run this command to use the *WorkLoad* cluster: - -```bash -# Connect to WorkLoad cluster -kubectl config use-context tkgm-workload-cluster-admin@tkgm-workload-cluster -``` - -### Displaying Existing Storage Classes - -For information about the Storage Classes in a *WorkLoad* cluster, run these commands: - -```bash -# Display Storage Classes -kubectl get storageclass -# Storage Class description -kubectl describe storageclass nomclasse -``` - -### Creating a storage class on another datastore - -On our VMware cluster, we have two datastores connected to NFS servers. One of the datastores contains the virtual machines in the *WorkLoad* cluster, as well as the **fcd** folder used by the Storage Class in the *Workload* cluster. - -We will create a new Storage Class on the second datastore. - -Go back to your VMware cluster in storage management, select the second datastore, and click `Summary`{.action} in the tab on the left. - -Copy the `URL`{.action} below "Type: NFS 3". - -![02 Select URL01](images/02-display-datastore-url01.png) - -Go to the console of the **Bootstrap** virtual machine, edit a new file named `secondstorageclass.yaml` with this content: - -```yaml -kind: StorageClass -apiVersion: storage.k8s.io/v1 -metadata: - name: secondstorageclass - annotations: - storageclass.kubernetes.io/is-default-class: "true" -provisioner: csi.vsphere.vmware.com -parameters: - datastoreurl: "ds:///vmfs/volumes/xxxxxxxxxxxxxxxxx/" -``` - -Edit the file by replacing `ds:///vmfs/volumes/xxxxxxxxxxxxxxxxx/` with the URL you just copied. - -Next, run this command: - -```bash -# Creating storageclass from yaml file -kubectl apply -f secondstorageclass.yaml -# Display storageclasses -kubectl get storageclass -``` - -We are now seeing two Storage Classes: - -```bash -NAME PROVISIONER RECLAIMPOLICY VOLUMEBINDINGMODE ALLOWVOLUMEEXPANSION AGE -default (default) csi.vsphere.vmware.com Delete Immediate true 3d18h -secondstorageclass (default) csi.vsphere.vmware.com Delete Immediate false 12s -tanzu@bootstrap:~$ -``` - -### Creating a persistent volume in the default Storage class - -Create a file named `default-pvc-storage.yaml` with this content: - -```yaml -kind: PersistentVolumeClaim -apiVersion: v1 -metadata: - name: default-pvc-storage -spec: - accessModes: - - ReadWriteOnce - storageClassName: "default" - resources: - requests: - storage: 2Gi -``` - -The persistent storage name is next to `name`, `storageClassName` contains the name of the Storage Class that is used for this volume. - -Run this command to create the persistent volume: - -```bash -# Create a namespace that will be used for my persistent volume. -kubectl create namespace myspace -# Applying the configuration file to the created namespace. -kubectl apply -f default-pvc-storage.yaml -n myspace -# Display persistent volumes of created namespace -kubectl get pv,pvc -n myspace -``` - -Go back to the inventory in your **vCenter** interface, click on the `DataCenter`{.action} icon on the left, then go to the `Monitor`{.action} tab on the right, and click on `Container Volumes`{.action} to see the persistent volumes. - -The persistent volume that has been created is displayed, and to the right you can see the name of the datastore on which it is stored. - -![03 Display PV in vCenter 01](images/03-display-pv-vmware01.png){.thumbnail} - -Click the notebook icon to the left of the volume to view the details. - -![03 Display PV in vCenter 02](images/03-display-pv-vmware02.png){.thumbnail} - -The information about this persistent storage is displayed, and corresponds to what was created using Kubernetes commands. - -![03 Display PV in vCenter 03](images/03-display-pv-vmware03.png){.thumbnail} - -Go to the Datastore that is used by default, right-click the `Files`{.action} tab and scroll through the folders in the Datastore to the `fcd` folder. - -You see that the folder contains two files, a vmdk file that contains the persistent volume data and an associated temporary file. - -![03 Display PV in vCenter 04](images/03-display-pv-vmware04.png){.thumbnail} - -### Creating a persistent volume on the second Storage Class - -Return to the **Bootstrap** virtual machine and use the command line. - -Create a file named `second-storage-pvc.yaml`: - -```yaml -kind: PersistentVolumeClaim -apiVersion: v1 -metadata: - name: second-storage-pvc -spec: - accessModes: - - ReadWriteOnce - storageClassName: "secondstorageclass" - resources: - requests: - storage: 2Gi -``` - -The file uses the same syntax as the first persistent storage, but with a different name and **Storage Class**. - -Run this command to create the persistent volume in the **myspace namespace**: - -```bash -# Applying the configuration file to the created namespace. -kubectl apply -f second-storage-pvc.yaml -n myspace -# Display persistent volumes of created namespace -kubectl get pv,pvc -n myspace -``` - -The persistent volume is created on the second **Datastore**. - -Return to the **vCenter** interface. You will see that you do not have any new files in the `fcd` folder. - -![04 Display PV2 in vCenter 01](images/04-display-pv2-vmware01.png){.thumbnail} - -Right-click the second Datastore, go to the `fcd`{.action} folder for that datastore. You will see that you have two new files, as in the first datastore. - -![04 Display PV2 in vCenter 02](images/04-display-pv2-vmware02.png){.thumbnail} - -Go back to the `Datacenter`{.action} at the root of the datacenters, click on the `Monitor`{.action} tab, and choose `Container volumes`{.action} to see the two persistent volumes appear with their locations in the datastores. - -![04 Display PV2 in vCenter 03](images/04-display-pv2-vmware03.png){.thumbnail} - -## Go further - -[Introduction to Tanzu Kubernetes Grid at OVHcloud](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Installing Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Managing Tanzu Management Cluster Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) - -[Introducing VMware Tanzu Kubernetes Grid](https://tanzu.vmware.com/kubernetes-grid) - -[VMware Tanzu Kubenetes Grid documentation](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/guide.en-us.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/guide.en-us.md deleted file mode 100644 index 7039c955c01..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/guide.en-us.md +++ /dev/null @@ -1,225 +0,0 @@ ---- -title: Managing persistent volumes in Tanzu Kubernetes Grid -excerpt: How to deploy an application in Tanzu Kubernetes Grid with persistent volumes -updated: 2024-01-10 ---- - -## Objective - -**This guide documents how to manage persistent volumes on a Tanzu Kubernetes Grid cluster.** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/en/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- You need to have deployed the **Workload** **TKG** cluster using the [Tanzu Management Cluster Grid administration guide](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage). - -## Introduction - -Persistent volumes are used to store data permanently on a **Kubernetes** cluster. This mechanism is based on **Storage Classes**. There are various Storage Classes. Read the [Kubernetes Storage Classes](https://kubernetes.io/docs/concepts/storage/storage-classes/) guide for more information. - -When deploying a *WorkLoad* cluster, a Storage Class **CSI provisioner** is created and points to the **Datastore** folder that contains the virtual machines in the *WorkLoad* cluster. - -From your VMware cluster, go to the inventory. Select the storage icon to the left, and go to the datastore where your *WorkLoad* cluster was deployed. Go to the `Files`{.action} tab and click the `fcd`{.action} folder. - -The folder is empty because the *WorkLoad* cluster does not yet use persistent volumes. - -![01 Display FCD folder](images/01-display-fcd-folder01.png){.thumbnail} - -You can create additional Storage Classes for each *WorkLoad* cluster. - -## Instructions - -We will connect to a *WorkLoad* cluster from the console of the **Bootstrap** virtual machine. You can use the [Tanzu Management Cluster Grid administration](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) guide to create and manage a workload cluster. - -From the **Bootstrap** virtual machine console, run this command to view the contexts that can be used on this cluster: - -```bash -# Display all the contexts of your TANZU KUBERNETES GRID cluster -kubectl config get-contexts -``` - -Run this command to use the *WorkLoad* cluster: - -```bash -# Connect to WorkLoad cluster -kubectl config use-context tkgm-workload-cluster-admin@tkgm-workload-cluster -``` - -### Displaying Existing Storage Classes - -For information about the Storage Classes in a *WorkLoad* cluster, run these commands: - -```bash -# Display Storage Classes -kubectl get storageclass -# Storage Class description -kubectl describe storageclass nomclasse -``` - -### Creating a storage class on another datastore - -On our VMware cluster, we have two datastores connected to NFS servers. One of the datastores contains the virtual machines in the *WorkLoad* cluster, as well as the **fcd** folder used by the Storage Class in the *Workload* cluster. - -We will create a new Storage Class on the second datastore. - -Go back to your VMware cluster in storage management, select the second datastore, and click `Summary`{.action} in the tab on the left. - -Copy the `URL`{.action} below "Type: NFS 3". - -![02 Select URL01](images/02-display-datastore-url01.png) - -Go to the console of the **Bootstrap** virtual machine, edit a new file named `secondstorageclass.yaml` with this content: - -```yaml -kind: StorageClass -apiVersion: storage.k8s.io/v1 -metadata: - name: secondstorageclass - annotations: - storageclass.kubernetes.io/is-default-class: "true" -provisioner: csi.vsphere.vmware.com -parameters: - datastoreurl: "ds:///vmfs/volumes/xxxxxxxxxxxxxxxxx/" -``` - -Edit the file by replacing `ds:///vmfs/volumes/xxxxxxxxxxxxxxxxx/` with the URL you just copied. - -Next, run this command: - -```bash -# Creating storageclass from yaml file -kubectl apply -f secondstorageclass.yaml -# Display storageclasses -kubectl get storageclass -``` - -We are now seeing two Storage Classes: - -```bash -NAME PROVISIONER RECLAIMPOLICY VOLUMEBINDINGMODE ALLOWVOLUMEEXPANSION AGE -default (default) csi.vsphere.vmware.com Delete Immediate true 3d18h -secondstorageclass (default) csi.vsphere.vmware.com Delete Immediate false 12s -tanzu@bootstrap:~$ -``` - -### Creating a persistent volume in the default Storage class - -Create a file named `default-pvc-storage.yaml` with this content: - -```yaml -kind: PersistentVolumeClaim -apiVersion: v1 -metadata: - name: default-pvc-storage -spec: - accessModes: - - ReadWriteOnce - storageClassName: "default" - resources: - requests: - storage: 2Gi -``` - -The persistent storage name is next to `name`, `storageClassName` contains the name of the Storage Class that is used for this volume. - -Run this command to create the persistent volume: - -```bash -# Create a namespace that will be used for my persistent volume. -kubectl create namespace myspace -# Applying the configuration file to the created namespace. -kubectl apply -f default-pvc-storage.yaml -n myspace -# Display persistent volumes of created namespace -kubectl get pv,pvc -n myspace -``` - -Go back to the inventory in your **vCenter** interface, click on the `DataCenter`{.action} icon on the left, then go to the `Monitor`{.action} tab on the right, and click on `Container Volumes`{.action} to see the persistent volumes. - -The persistent volume that has been created is displayed, and to the right you can see the name of the datastore on which it is stored. - -![03 Display PV in vCenter 01](images/03-display-pv-vmware01.png){.thumbnail} - -Click the notebook icon to the left of the volume to view the details. - -![03 Display PV in vCenter 02](images/03-display-pv-vmware02.png){.thumbnail} - -The information about this persistent storage is displayed, and corresponds to what was created using Kubernetes commands. - -![03 Display PV in vCenter 03](images/03-display-pv-vmware03.png){.thumbnail} - -Go to the Datastore that is used by default, right-click the `Files`{.action} tab and scroll through the folders in the Datastore to the `fcd` folder. - -You see that the folder contains two files, a vmdk file that contains the persistent volume data and an associated temporary file. - -![03 Display PV in vCenter 04](images/03-display-pv-vmware04.png){.thumbnail} - -### Creating a persistent volume on the second Storage Class - -Return to the **Bootstrap** virtual machine and use the command line. - -Create a file named `second-storage-pvc.yaml`: - -```yaml -kind: PersistentVolumeClaim -apiVersion: v1 -metadata: - name: second-storage-pvc -spec: - accessModes: - - ReadWriteOnce - storageClassName: "secondstorageclass" - resources: - requests: - storage: 2Gi -``` - -The file uses the same syntax as the first persistent storage, but with a different name and **Storage Class**. - -Run this command to create the persistent volume in the **myspace namespace**: - -```bash -# Applying the configuration file to the created namespace. -kubectl apply -f second-storage-pvc.yaml -n myspace -# Display persistent volumes of created namespace -kubectl get pv,pvc -n myspace -``` - -The persistent volume is created on the second **Datastore**. - -Return to the **vCenter** interface. You will see that you do not have any new files in the `fcd` folder. - -![04 Display PV2 in vCenter 01](images/04-display-pv2-vmware01.png){.thumbnail} - -Right-click the second Datastore, go to the `fcd`{.action} folder for that datastore. You will see that you have two new files, as in the first datastore. - -![04 Display PV2 in vCenter 02](images/04-display-pv2-vmware02.png){.thumbnail} - -Go back to the `Datacenter`{.action} at the root of the datacenters, click on the `Monitor`{.action} tab, and choose `Container volumes`{.action} to see the two persistent volumes appear with their locations in the datastores. - -![04 Display PV2 in vCenter 03](images/04-display-pv2-vmware03.png){.thumbnail} - -## Go further - -[Introduction to Tanzu Kubernetes Grid at OVHcloud](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Installing Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Managing Tanzu Management Cluster Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) - -[Introducing VMware Tanzu Kubernetes Grid](https://tanzu.vmware.com/kubernetes-grid) - -[VMware Tanzu Kubenetes Grid documentation](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/guide.es-es.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/guide.es-es.md deleted file mode 100644 index ed17169854e..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/guide.es-es.md +++ /dev/null @@ -1,225 +0,0 @@ ---- -title: Gestión de volúmenes persistentes en Tanzu Kubernetes Grid (EN) -excerpt: How to deploy an application in Tanzu Kubernetes Grid with persistent volumes -updated: 2024-01-10 ---- - -## Objective - -**This guide documents how to manage persistent volumes on a Tanzu Kubernetes Grid cluster.** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/es-es/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- You need to have deployed the **Workload** **TKG** cluster using the [Tanzu Management Cluster Grid administration guide](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage). - -## Introduction - -Persistent volumes are used to store data permanently on a **Kubernetes** cluster. This mechanism is based on **Storage Classes**. There are various Storage Classes. Read the [Kubernetes Storage Classes](https://kubernetes.io/docs/concepts/storage/storage-classes/) guide for more information. - -When deploying a *WorkLoad* cluster, a Storage Class **CSI provisioner** is created and points to the **Datastore** folder that contains the virtual machines in the *WorkLoad* cluster. - -From your VMware cluster, go to the inventory. Select the storage icon to the left, and go to the datastore where your *WorkLoad* cluster was deployed. Go to the `Files`{.action} tab and click the `fcd`{.action} folder. - -The folder is empty because the *WorkLoad* cluster does not yet use persistent volumes. - -![01 Display FCD folder](images/01-display-fcd-folder01.png){.thumbnail} - -You can create additional Storage Classes for each *WorkLoad* cluster. - -## Instructions - -We will connect to a *WorkLoad* cluster from the console of the **Bootstrap** virtual machine. You can use the [Tanzu Management Cluster Grid administration](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) guide to create and manage a workload cluster. - -From the **Bootstrap** virtual machine console, run this command to view the contexts that can be used on this cluster: - -```bash -# Display all the contexts of your TANZU KUBERNETES GRID cluster -kubectl config get-contexts -``` - -Run this command to use the *WorkLoad* cluster: - -```bash -# Connect to WorkLoad cluster -kubectl config use-context tkgm-workload-cluster-admin@tkgm-workload-cluster -``` - -### Displaying Existing Storage Classes - -For information about the Storage Classes in a *WorkLoad* cluster, run these commands: - -```bash -# Display Storage Classes -kubectl get storageclass -# Storage Class description -kubectl describe storageclass nomclasse -``` - -### Creating a storage class on another datastore - -On our VMware cluster, we have two datastores connected to NFS servers. One of the datastores contains the virtual machines in the *WorkLoad* cluster, as well as the **fcd** folder used by the Storage Class in the *Workload* cluster. - -We will create a new Storage Class on the second datastore. - -Go back to your VMware cluster in storage management, select the second datastore, and click `Summary`{.action} in the tab on the left. - -Copy the `URL`{.action} below "Type: NFS 3". - -![02 Select URL01](images/02-display-datastore-url01.png) - -Go to the console of the **Bootstrap** virtual machine, edit a new file named `secondstorageclass.yaml` with this content: - -```yaml -kind: StorageClass -apiVersion: storage.k8s.io/v1 -metadata: - name: secondstorageclass - annotations: - storageclass.kubernetes.io/is-default-class: "true" -provisioner: csi.vsphere.vmware.com -parameters: - datastoreurl: "ds:///vmfs/volumes/xxxxxxxxxxxxxxxxx/" -``` - -Edit the file by replacing `ds:///vmfs/volumes/xxxxxxxxxxxxxxxxx/` with the URL you just copied. - -Next, run this command: - -```bash -# Creating storageclass from yaml file -kubectl apply -f secondstorageclass.yaml -# Display storageclasses -kubectl get storageclass -``` - -We are now seeing two Storage Classes: - -```bash -NAME PROVISIONER RECLAIMPOLICY VOLUMEBINDINGMODE ALLOWVOLUMEEXPANSION AGE -default (default) csi.vsphere.vmware.com Delete Immediate true 3d18h -secondstorageclass (default) csi.vsphere.vmware.com Delete Immediate false 12s -tanzu@bootstrap:~$ -``` - -### Creating a persistent volume in the default Storage class - -Create a file named `default-pvc-storage.yaml` with this content: - -```yaml -kind: PersistentVolumeClaim -apiVersion: v1 -metadata: - name: default-pvc-storage -spec: - accessModes: - - ReadWriteOnce - storageClassName: "default" - resources: - requests: - storage: 2Gi -``` - -The persistent storage name is next to `name`, `storageClassName` contains the name of the Storage Class that is used for this volume. - -Run this command to create the persistent volume: - -```bash -# Create a namespace that will be used for my persistent volume. -kubectl create namespace myspace -# Applying the configuration file to the created namespace. -kubectl apply -f default-pvc-storage.yaml -n myspace -# Display persistent volumes of created namespace -kubectl get pv,pvc -n myspace -``` - -Go back to the inventory in your **vCenter** interface, click on the `DataCenter`{.action} icon on the left, then go to the `Monitor`{.action} tab on the right, and click on `Container Volumes`{.action} to see the persistent volumes. - -The persistent volume that has been created is displayed, and to the right you can see the name of the datastore on which it is stored. - -![03 Display PV in vCenter 01](images/03-display-pv-vmware01.png){.thumbnail} - -Click the notebook icon to the left of the volume to view the details. - -![03 Display PV in vCenter 02](images/03-display-pv-vmware02.png){.thumbnail} - -The information about this persistent storage is displayed, and corresponds to what was created using Kubernetes commands. - -![03 Display PV in vCenter 03](images/03-display-pv-vmware03.png){.thumbnail} - -Go to the Datastore that is used by default, right-click the `Files`{.action} tab and scroll through the folders in the Datastore to the `fcd` folder. - -You see that the folder contains two files, a vmdk file that contains the persistent volume data and an associated temporary file. - -![03 Display PV in vCenter 04](images/03-display-pv-vmware04.png){.thumbnail} - -### Creating a persistent volume on the second Storage Class - -Return to the **Bootstrap** virtual machine and use the command line. - -Create a file named `second-storage-pvc.yaml`: - -```yaml -kind: PersistentVolumeClaim -apiVersion: v1 -metadata: - name: second-storage-pvc -spec: - accessModes: - - ReadWriteOnce - storageClassName: "secondstorageclass" - resources: - requests: - storage: 2Gi -``` - -The file uses the same syntax as the first persistent storage, but with a different name and **Storage Class**. - -Run this command to create the persistent volume in the **myspace namespace**: - -```bash -# Applying the configuration file to the created namespace. -kubectl apply -f second-storage-pvc.yaml -n myspace -# Display persistent volumes of created namespace -kubectl get pv,pvc -n myspace -``` - -The persistent volume is created on the second **Datastore**. - -Return to the **vCenter** interface. You will see that you do not have any new files in the `fcd` folder. - -![04 Display PV2 in vCenter 01](images/04-display-pv2-vmware01.png){.thumbnail} - -Right-click the second Datastore, go to the `fcd`{.action} folder for that datastore. You will see that you have two new files, as in the first datastore. - -![04 Display PV2 in vCenter 02](images/04-display-pv2-vmware02.png){.thumbnail} - -Go back to the `Datacenter`{.action} at the root of the datacenters, click on the `Monitor`{.action} tab, and choose `Container volumes`{.action} to see the two persistent volumes appear with their locations in the datastores. - -![04 Display PV2 in vCenter 03](images/04-display-pv2-vmware03.png){.thumbnail} - -## Go further - -[Introduction to Tanzu Kubernetes Grid at OVHcloud](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Installing Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Managing Tanzu Management Cluster Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) - -[Introducing VMware Tanzu Kubernetes Grid](https://tanzu.vmware.com/kubernetes-grid) - -[VMware Tanzu Kubenetes Grid documentation](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/guide.es-us.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/guide.es-us.md deleted file mode 100644 index 6cc1de175fc..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/guide.es-us.md +++ /dev/null @@ -1,225 +0,0 @@ ---- -title: Gestión de volúmenes persistentes en Tanzu Kubernetes Grid (EN) -excerpt: How to deploy an application in Tanzu Kubernetes Grid with persistent volumes -updated: 2024-01-10 ---- - -## Objective - -**This guide documents how to manage persistent volumes on a Tanzu Kubernetes Grid cluster.** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/es/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- You need to have deployed the **Workload** **TKG** cluster using the [Tanzu Management Cluster Grid administration guide](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage). - -## Introduction - -Persistent volumes are used to store data permanently on a **Kubernetes** cluster. This mechanism is based on **Storage Classes**. There are various Storage Classes. Read the [Kubernetes Storage Classes](https://kubernetes.io/docs/concepts/storage/storage-classes/) guide for more information. - -When deploying a *WorkLoad* cluster, a Storage Class **CSI provisioner** is created and points to the **Datastore** folder that contains the virtual machines in the *WorkLoad* cluster. - -From your VMware cluster, go to the inventory. Select the storage icon to the left, and go to the datastore where your *WorkLoad* cluster was deployed. Go to the `Files`{.action} tab and click the `fcd`{.action} folder. - -The folder is empty because the *WorkLoad* cluster does not yet use persistent volumes. - -![01 Display FCD folder](images/01-display-fcd-folder01.png){.thumbnail} - -You can create additional Storage Classes for each *WorkLoad* cluster. - -## Instructions - -We will connect to a *WorkLoad* cluster from the console of the **Bootstrap** virtual machine. You can use the [Tanzu Management Cluster Grid administration](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) guide to create and manage a workload cluster. - -From the **Bootstrap** virtual machine console, run this command to view the contexts that can be used on this cluster: - -```bash -# Display all the contexts of your TANZU KUBERNETES GRID cluster -kubectl config get-contexts -``` - -Run this command to use the *WorkLoad* cluster: - -```bash -# Connect to WorkLoad cluster -kubectl config use-context tkgm-workload-cluster-admin@tkgm-workload-cluster -``` - -### Displaying Existing Storage Classes - -For information about the Storage Classes in a *WorkLoad* cluster, run these commands: - -```bash -# Display Storage Classes -kubectl get storageclass -# Storage Class description -kubectl describe storageclass nomclasse -``` - -### Creating a storage class on another datastore - -On our VMware cluster, we have two datastores connected to NFS servers. One of the datastores contains the virtual machines in the *WorkLoad* cluster, as well as the **fcd** folder used by the Storage Class in the *Workload* cluster. - -We will create a new Storage Class on the second datastore. - -Go back to your VMware cluster in storage management, select the second datastore, and click `Summary`{.action} in the tab on the left. - -Copy the `URL`{.action} below "Type: NFS 3". - -![02 Select URL01](images/02-display-datastore-url01.png) - -Go to the console of the **Bootstrap** virtual machine, edit a new file named `secondstorageclass.yaml` with this content: - -```yaml -kind: StorageClass -apiVersion: storage.k8s.io/v1 -metadata: - name: secondstorageclass - annotations: - storageclass.kubernetes.io/is-default-class: "true" -provisioner: csi.vsphere.vmware.com -parameters: - datastoreurl: "ds:///vmfs/volumes/xxxxxxxxxxxxxxxxx/" -``` - -Edit the file by replacing `ds:///vmfs/volumes/xxxxxxxxxxxxxxxxx/` with the URL you just copied. - -Next, run this command: - -```bash -# Creating storageclass from yaml file -kubectl apply -f secondstorageclass.yaml -# Display storageclasses -kubectl get storageclass -``` - -We are now seeing two Storage Classes: - -```bash -NAME PROVISIONER RECLAIMPOLICY VOLUMEBINDINGMODE ALLOWVOLUMEEXPANSION AGE -default (default) csi.vsphere.vmware.com Delete Immediate true 3d18h -secondstorageclass (default) csi.vsphere.vmware.com Delete Immediate false 12s -tanzu@bootstrap:~$ -``` - -### Creating a persistent volume in the default Storage class - -Create a file named `default-pvc-storage.yaml` with this content: - -```yaml -kind: PersistentVolumeClaim -apiVersion: v1 -metadata: - name: default-pvc-storage -spec: - accessModes: - - ReadWriteOnce - storageClassName: "default" - resources: - requests: - storage: 2Gi -``` - -The persistent storage name is next to `name`, `storageClassName` contains the name of the Storage Class that is used for this volume. - -Run this command to create the persistent volume: - -```bash -# Create a namespace that will be used for my persistent volume. -kubectl create namespace myspace -# Applying the configuration file to the created namespace. -kubectl apply -f default-pvc-storage.yaml -n myspace -# Display persistent volumes of created namespace -kubectl get pv,pvc -n myspace -``` - -Go back to the inventory in your **vCenter** interface, click on the `DataCenter`{.action} icon on the left, then go to the `Monitor`{.action} tab on the right, and click on `Container Volumes`{.action} to see the persistent volumes. - -The persistent volume that has been created is displayed, and to the right you can see the name of the datastore on which it is stored. - -![03 Display PV in vCenter 01](images/03-display-pv-vmware01.png){.thumbnail} - -Click the notebook icon to the left of the volume to view the details. - -![03 Display PV in vCenter 02](images/03-display-pv-vmware02.png){.thumbnail} - -The information about this persistent storage is displayed, and corresponds to what was created using Kubernetes commands. - -![03 Display PV in vCenter 03](images/03-display-pv-vmware03.png){.thumbnail} - -Go to the Datastore that is used by default, right-click the `Files`{.action} tab and scroll through the folders in the Datastore to the `fcd` folder. - -You see that the folder contains two files, a vmdk file that contains the persistent volume data and an associated temporary file. - -![03 Display PV in vCenter 04](images/03-display-pv-vmware04.png){.thumbnail} - -### Creating a persistent volume on the second Storage Class - -Return to the **Bootstrap** virtual machine and use the command line. - -Create a file named `second-storage-pvc.yaml`: - -```yaml -kind: PersistentVolumeClaim -apiVersion: v1 -metadata: - name: second-storage-pvc -spec: - accessModes: - - ReadWriteOnce - storageClassName: "secondstorageclass" - resources: - requests: - storage: 2Gi -``` - -The file uses the same syntax as the first persistent storage, but with a different name and **Storage Class**. - -Run this command to create the persistent volume in the **myspace namespace**: - -```bash -# Applying the configuration file to the created namespace. -kubectl apply -f second-storage-pvc.yaml -n myspace -# Display persistent volumes of created namespace -kubectl get pv,pvc -n myspace -``` - -The persistent volume is created on the second **Datastore**. - -Return to the **vCenter** interface. You will see that you do not have any new files in the `fcd` folder. - -![04 Display PV2 in vCenter 01](images/04-display-pv2-vmware01.png){.thumbnail} - -Right-click the second Datastore, go to the `fcd`{.action} folder for that datastore. You will see that you have two new files, as in the first datastore. - -![04 Display PV2 in vCenter 02](images/04-display-pv2-vmware02.png){.thumbnail} - -Go back to the `Datacenter`{.action} at the root of the datacenters, click on the `Monitor`{.action} tab, and choose `Container volumes`{.action} to see the two persistent volumes appear with their locations in the datastores. - -![04 Display PV2 in vCenter 03](images/04-display-pv2-vmware03.png){.thumbnail} - -## Go further - -[Introduction to Tanzu Kubernetes Grid at OVHcloud](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Installing Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Managing Tanzu Management Cluster Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) - -[Introducing VMware Tanzu Kubernetes Grid](https://tanzu.vmware.com/kubernetes-grid) - -[VMware Tanzu Kubenetes Grid documentation](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/guide.fr-ca.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/guide.fr-ca.md deleted file mode 100644 index ef277dea1df..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/guide.fr-ca.md +++ /dev/null @@ -1,225 +0,0 @@ ---- -title: Gestion des volumes persistants dans Tanzu Kubernetes Grid -excerpt: Comment déployer une application dans Tanzu Kubernetes Grid avec des volumes persistants -updated: 2024-01-10 ---- - -## Objectif - -**Ce guide vous permet de gérer les volumes persistants sur un cluster Tanzu Kubernetes Grid.** - -> [!warning] -> OVHcloud vous met à disposition des services dont la configuration, la gestion et la responsabilité vous incombent. Il vous appartient donc de ce fait d’en assurer le bon fonctionnement. -> -> Ce guide a pour but de vous accompagner au mieux sur des tâches courantes. Néanmoins, nous vous recommandons de faire appel à un [prestataire spécialisé](https://partner.ovhcloud.com/fr/) si vous éprouvez des difficultés ou des doutes concernant l’administration, l’utilisation ou la mise en place d’un service sur un serveur. -> - -## Prérequis - -- Être contact administrateur de [l'infrastructure Hosted Private Cloud](https://www.ovhcloud.com/fr-ca/enterprise/products/hosted-private-cloud/), afin de recevoir les identifiants de connexion. -- Avoir un identifiant actif dans l'[espace client OVHcloud](/links/manager). -- Avoir un identifiant actif dans vSphere. -- Avoir déployé le cluster de **Workload** **TKG** à l'aide du guide « [administrer Tanzu Management Cluster Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) ». - -## Présentation - -Les volumes persistants sont utilisés pour conserver des données de manière permanente sur un cluster **Kubernetes**. Ce mécanisme s'appuie sur des **Storage Classes**. Il existe diverses Storage Classes. Consultez le guide « [Kubernetes Storage Classes](https://kubernetes.io/docs/concepts/storage/storage-classes/) » pour plus d'informations. - -Lors du déploiement d'un cluster de *WorkLoad*, une Storage Class **CSI provisioner** est créée et pointe dans le dossier du **Datastore** qui contient les machines virtuelles du cluster de *WorkLoad*. - -A partir de votre cluster VMware, rendez-vous dans l'inventaire. Sélectionnez à gauche l'icône concernant le stockage, positionnez-vous sur le datastore où a été déployé votre cluster de *WorkLoad*. Allez dans l'onglet `Fichiers`{.action} et cliquez sur le dossier `fcd`{.action}. - -Le dossier est vide car le cluster de *WorkLoad* n'utilise pas encore de volumes persistants. - -![01 Affichage dossier FCD](images/01-display-fcd-folder01.png){.thumbnail} - -Il est possible de créer d'autres Storage Classes pour chaque cluster de *WorkLoad*. - -## En pratique - -Nous allons nous connecter sur un cluster de *WorkLoad* à partir de la console de la machine virtuelle **Bootstrap**. Vous pouvez vous aider du guide « [Administrer Tanzu Management Cluster Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) » pour créer un cluster de workload et l'administrer. - -A partir de la console de la machine virtuelle de **Bootstrap**, utilisez cette commande pour voir les contextes que l'on peut utiliser sur ce cluster : - -```bash -# Affichage de tous les contextes de votre cluster TANZU KUBERNETES GRID -kubectl config get-contexts -``` - -Saisissez cette commande pour utiliser le cluster de *WorkLoad* : - -```bash -# Connexion au cluster de WorkLoad -kubectl config use-context tkgm-workload-cluster-admin@tkgm-workload-cluster -``` - -### Affichage des Storage Classes existantes - -Pour obtenir des informations sur les Storage Classes d'un cluster de *WorkLoad*, saisissez ces commandes : - -```bash -# Affichage des Storage Classes -kubectl get storageclass -# Description d'une Storage Class -kubectl describe storageclass nomclasse -``` - -### Création d'une storage class sur un autre Datastore - -Sur notre cluster VMware, nous avons deux Datastores connectés sur des serveur NFS. Un des datastores contient les machines virtuelles du cluster de *WorkLoad* ainsi que le dossier **fcd** utilisé par la Storage Class du cluster de *Workload*. - -Nous allons créer une nouvelle Storage Class sur le deuxième Datastore. - -Revenez sur votre cluster VMware dans la gestion du stockage, sélectionnez le second datastore et cliquez sur `Résumé`{.action} dans l'onglet à gauche. - -Copiez l'`URL`{.action} en dessous de « Type: NFS 3 ». - -![02 Select URL01](images/02-display-datastore-url01.png) - -Allez dans la console de la machine virtuelle **Bootstrap**, éditez un nouveau fichier nommé `secondstorageclass.yaml` avec ce contenu : - -```yaml -kind: StorageClass -apiVersion: storage.k8s.io/v1 -metadata: - name: secondstorageclass - annotations: - storageclass.kubernetes.io/is-default-class: "true" -provisioner: csi.vsphere.vmware.com -parameters: - datastoreurl: "ds:///vmfs/volumes/xxxxxxxxxxxxxxxxx/" -``` - -Modifiez le fichier en remplaçant `ds:///vmfs/volumes/xxxxxxxxxxxxxxxxx/` par l'URL que vous venez de copier. - -Exécutez ensuite cette commande : - -```bash -# Création du storageclass à partir du fichier yaml -kubectl apply -f secondstorageclass.yaml -# Affichage des storageclass -kubectl get storageclass -``` - -Nous voyons donc apparaitre deux Storage Classes : - -```bash -NAME PROVISIONER RECLAIMPOLICY VOLUMEBINDINGMODE ALLOWVOLUMEEXPANSION AGE -default (default) csi.vsphere.vmware.com Delete Immediate true 3d18h -secondstorageclass (default) csi.vsphere.vmware.com Delete Immediate false 12s -tanzu@bootstrap:~$ -``` - -### Création d'un volume persistant dans la Storage class par défaut - -Créez un fichier nommé `default-pvc-storage.yaml` avec ce contenu : - -```yaml -kind: PersistentVolumeClaim -apiVersion: v1 -metadata: - name: default-pvc-storage -spec: - accessModes: - - ReadWriteOnce - storageClassName: "default" - resources: - requests: - storage: 2Gi -``` - -Le nom du stockage persistant se trouve à coté de `name`, `storageClassName` contient le nom de la Storage Class qui est utilisée pour ce volume. - -Exécutez cette commande pour créer le volume persistant : - -```bash -# Creation d'un espace de nom qui sera utilisé pour mon volume persistant. -kubectl create namespace myspace -# Application du fichier de configuration dans l'espace de nom créé. -kubectl apply -f default-pvc-storage.yaml -n myspace -# Affichage des volumes persistants de l'espace de nom créé -kubectl get pv,pvc -n myspace -``` - -Revenez sur l'inventaire dans votre interface **vCenter**, cliquez à gauche sur l'icône `DataCenter`{.action} puis allez dans l'onglet `Surveiller`{.action} à droite et cliquez sur `Volume de conteneur`{.action} pour voir les volumes persistants. - -Le volume persistant qui a été créé est affiché et l'on voit à sa droite le nom du Datastore sur lequel il est stocké. - -![03 Display PV in vCenter 01](images/03-display-pv-vmware01.png){.thumbnail} - -Cliquez sur l'icône en forme de bloc-notes à gauche du volume pour afficher les détails. - -![03 Display PV in vCenter 02](images/03-display-pv-vmware02.png){.thumbnail} - -Les informations concernant ce stockage persistant sont affichées et correspondent à ce qui a été créé à partir des commandes Kubernetes. - -![03 Display PV in vCenter 03](images/03-display-pv-vmware03.png){.thumbnail} - -Rendez-vous sur le Datastore qui est utilisé par défaut, cliquez à droite sur l'onglet `Fichiers`{.action} et faites défiler les dossiers du Datastore jusqu'au dossier `fcd`. - -Vous constatez que le dossier contient deux fichiers, un fichier vmdk qui contient les données du volumes persistant et un fichier temporaire associé. - -![03 Display PV in vCenter 04](images/03-display-pv-vmware04.png){.thumbnail} - -### Création d'un volume persistant sur le deuxième Storage Class - -Revenez sur la machine virtuelle **Bootstrap** et utilisez la ligne de commande. - -Créez un fichier nommé `second-storage-pvc.yaml` : - -```yaml -kind: PersistentVolumeClaim -apiVersion: v1 -metadata: - name: second-storage-pvc -spec: - accessModes: - - ReadWriteOnce - storageClassName: "secondstorageclass" - resources: - requests: - storage: 2Gi -``` - -Le fichier utilise la même syntaxe que pour le premier stockage persistant mais avec un nom et une **Storage Class** différents. - -Exécutez cette commande pour créer le volume persistant dans l'espace de nom **myspace** : - -```bash -# Application du fichier de configuration dans l'espace de nom créé. -kubectl apply -f second-storage-pvc.yaml -n myspace -# Affichage des volumes persistants de l'espace de nom créé -kubectl get pv,pvc -n myspace -``` - -Le volume persistant est créé sur le deuxième **Datastore**. - -Revenez dans l'interface **vCenter**. Vous constaterez que vous n'avez pas de nouveaux fichiers dans le dossier `fcd`. - -![04 Display PV2 in vCenter 01](images/04-display-pv2-vmware01.png){.thumbnail} - -Cliquez à droite sur le second Datastore, allez dans le dossier `fcd`{.action} de ce datastore. Vous constaterez que vous avez deux nouveaux fichiers comme sur le premier Datastore. - -![04 Display PV2 in vCenter 02](images/04-display-pv2-vmware02.png){.thumbnail} - -Revenez dans le `Datacenter`{.action} à la racine des datacenters, cliquez sur l'onglet `Surveiller`{.action} et choisissez `Volumes de conteneur`{.action} pour voir apparaitre les deux volumes persistants avec leurs emplacements dans les Datastores. - -![04 Display PV2 in vCenter 03](images/04-display-pv2-vmware03.png){.thumbnail} - -## Aller plus loin - -[Présentation de Tanzu Kubernetes Grid au sein d'OVHcloud](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Installer Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Administrer Tanzu Management Cluster Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) - -[Présentation de VMware Tanzu Kubernetes Grid](https://tanzu.vmware.com/kubernetes-grid) - -[Documentation de VMware Tanzu Kubenetes Grid](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Installation manuelle de l'outil CLI pour le déploiement de Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -Si vous avez besoin d'une formation ou d'une assistance technique pour la mise en oeuvre de nos solutions, contactez votre commercial ou cliquez sur [ce lien](/links/professional-services) pour obtenir un devis et demander une analyse personnalisée de votre projet à nos experts de l’équipe Professional Services. - -Échangez avec notre [communauté d'utilisateurs](/links/community). diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/guide.fr-fr.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/guide.fr-fr.md deleted file mode 100644 index bd8f1b7fdef..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/guide.fr-fr.md +++ /dev/null @@ -1,225 +0,0 @@ ---- -title: Gestion des volumes persistants dans Tanzu Kubernetes Grid -excerpt: Comment déployer une application dans Tanzu Kubernetes Grid avec des volumes persistants -updated: 2024-01-10 ---- - -## Objectif - -**Ce guide vous permet de gérer les volumes persistants sur un cluster Tanzu Kubernetes Grid.** - -> [!warning] -> OVHcloud vous met à disposition des services dont la configuration, la gestion et la responsabilité vous incombent. Il vous appartient donc de ce fait d’en assurer le bon fonctionnement. -> -> Ce guide a pour but de vous accompagner au mieux sur des tâches courantes. Néanmoins, nous vous recommandons de faire appel à un [prestataire spécialisé](https://partner.ovhcloud.com/fr/) si vous éprouvez des difficultés ou des doutes concernant l’administration, l’utilisation ou la mise en place d’un service sur un serveur. -> - -## Prérequis - -- Être contact administrateur de [l'infrastructure Hosted Private Cloud](https://www.ovhcloud.com/fr/enterprise/products/hosted-private-cloud/), afin de recevoir les identifiants de connexion. -- Avoir un identifiant actif dans l'[espace client OVHcloud](/links/manager). -- Avoir un identifiant actif dans vSphere. -- Avoir déployé le cluster de **Workload** **TKG** à l'aide du guide « [administrer Tanzu Management Cluster Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) ». - -## Présentation - -Les volumes persistants sont utilisés pour conserver des données de manière permanente sur un cluster **Kubernetes**. Ce mécanisme s'appuie sur des **Storage Classes**. Il existe diverses Storage Classes. Consultez le guide « [Kubernetes Storage Classes](https://kubernetes.io/docs/concepts/storage/storage-classes/) » pour plus d'informations. - -Lors du déploiement d'un cluster de *WorkLoad*, une Storage Class **CSI provisioner** est créée et pointe dans le dossier du **Datastore** qui contient les machines virtuelles du cluster de *WorkLoad*. - -A partir de votre cluster VMware, rendez-vous dans l'inventaire. Sélectionnez à gauche l'icône concernant le stockage, positionnez-vous sur le datastore où a été déployé votre cluster de *WorkLoad*. Allez dans l'onglet `Fichiers`{.action} et cliquez sur le dossier `fcd`{.action}. - -Le dossier est vide car le cluster de *WorkLoad* n'utilise pas encore de volumes persistants. - -![01 Affichage dossier FCD](images/01-display-fcd-folder01.png){.thumbnail} - -Il est possible de créer d'autres Storage Classes pour chaque cluster de *WorkLoad*. - -## En pratique - -Nous allons nous connecter sur un cluster de *WorkLoad* à partir de la console de la machine virtuelle **Bootstrap**. Vous pouvez vous aider du guide « [Administrer Tanzu Management Cluster Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) » pour créer un cluster de workload et l'administrer. - -A partir de la console de la machine virtuelle de **Bootstrap**, utilisez cette commande pour voir les contextes que l'on peut utiliser sur ce cluster : - -```bash -# Affichage de tous les contextes de votre cluster TANZU KUBERNETES GRID -kubectl config get-contexts -``` - -Saisissez cette commande pour utiliser le cluster de *WorkLoad* : - -```bash -# Connexion au cluster de WorkLoad -kubectl config use-context tkgm-workload-cluster-admin@tkgm-workload-cluster -``` - -### Affichage des Storage Classes existantes - -Pour obtenir des informations sur les Storage Classes d'un cluster de *WorkLoad*, saisissez ces commandes : - -```bash -# Affichage des Storage Classes -kubectl get storageclass -# Description d'une Storage Class -kubectl describe storageclass nomclasse -``` - -### Création d'une storage class sur un autre Datastore - -Sur notre cluster VMware, nous avons deux Datastores connectés sur des serveur NFS. Un des datastores contient les machines virtuelles du cluster de *WorkLoad* ainsi que le dossier **fcd** utilisé par la Storage Class du cluster de *Workload*. - -Nous allons créer une nouvelle Storage Class sur le deuxième Datastore. - -Revenez sur votre cluster VMware dans la gestion du stockage, sélectionnez le second datastore et cliquez sur `Résumé`{.action} dans l'onglet à gauche. - -Copiez l'`URL`{.action} en dessous de « Type: NFS 3 ». - -![02 Select URL01](images/02-display-datastore-url01.png) - -Allez dans la console de la machine virtuelle **Bootstrap**, éditez un nouveau fichier nommé `secondstorageclass.yaml` avec ce contenu : - -```yaml -kind: StorageClass -apiVersion: storage.k8s.io/v1 -metadata: - name: secondstorageclass - annotations: - storageclass.kubernetes.io/is-default-class: "true" -provisioner: csi.vsphere.vmware.com -parameters: - datastoreurl: "ds:///vmfs/volumes/xxxxxxxxxxxxxxxxx/" -``` - -Modifiez le fichier en remplaçant `ds:///vmfs/volumes/xxxxxxxxxxxxxxxxx/` par l'URL que vous venez de copier. - -Exécutez ensuite cette commande : - -```bash -# Création du storageclass à partir du fichier yaml -kubectl apply -f secondstorageclass.yaml -# Affichage des storageclass -kubectl get storageclass -``` - -Nous voyons donc apparaitre deux Storage Classes : - -```bash -NAME PROVISIONER RECLAIMPOLICY VOLUMEBINDINGMODE ALLOWVOLUMEEXPANSION AGE -default (default) csi.vsphere.vmware.com Delete Immediate true 3d18h -secondstorageclass (default) csi.vsphere.vmware.com Delete Immediate false 12s -tanzu@bootstrap:~$ -``` - -### Création d'un volume persistant dans la Storage class par défaut - -Créez un fichier nommé `default-pvc-storage.yaml` avec ce contenu : - -```yaml -kind: PersistentVolumeClaim -apiVersion: v1 -metadata: - name: default-pvc-storage -spec: - accessModes: - - ReadWriteOnce - storageClassName: "default" - resources: - requests: - storage: 2Gi -``` - -Le nom du stockage persistant se trouve à coté de `name`, `storageClassName` contient le nom de la Storage Class qui est utilisée pour ce volume. - -Exécutez cette commande pour créer le volume persistant : - -```bash -# Creation d'un espace de nom qui sera utilisé pour mon volume persistant. -kubectl create namespace myspace -# Application du fichier de configuration dans l'espace de nom créé. -kubectl apply -f default-pvc-storage.yaml -n myspace -# Affichage des volumes persistants de l'espace de nom créé -kubectl get pv,pvc -n myspace -``` - -Revenez sur l'inventaire dans votre interface **vCenter**, cliquez à gauche sur l'icône `DataCenter`{.action} puis allez dans l'onglet `Surveiller`{.action} à droite et cliquez sur `Volume de conteneur`{.action} pour voir les volumes persistants. - -Le volume persistant qui a été créé est affiché et l'on voit à sa droite le nom du Datastore sur lequel il est stocké. - -![03 Display PV in vCenter 01](images/03-display-pv-vmware01.png){.thumbnail} - -Cliquez sur l'icône en forme de bloc-notes à gauche du volume pour afficher les détails. - -![03 Display PV in vCenter 02](images/03-display-pv-vmware02.png){.thumbnail} - -Les informations concernant ce stockage persistant sont affichées et correspondent à ce qui a été créé à partir des commandes Kubernetes. - -![03 Display PV in vCenter 03](images/03-display-pv-vmware03.png){.thumbnail} - -Rendez-vous sur le Datastore qui est utilisé par défaut, cliquez à droite sur l'onglet `Fichiers`{.action} et faites défiler les dossiers du Datastore jusqu'au dossier `fcd`. - -Vous constatez que le dossier contient deux fichiers, un fichier vmdk qui contient les données du volumes persistant et un fichier temporaire associé. - -![03 Display PV in vCenter 04](images/03-display-pv-vmware04.png){.thumbnail} - -### Création d'un volume persistant sur le deuxième Storage Class - -Revenez sur la machine virtuelle **Bootstrap** et utilisez la ligne de commande. - -Créez un fichier nommé `second-storage-pvc.yaml` : - -```yaml -kind: PersistentVolumeClaim -apiVersion: v1 -metadata: - name: second-storage-pvc -spec: - accessModes: - - ReadWriteOnce - storageClassName: "secondstorageclass" - resources: - requests: - storage: 2Gi -``` - -Le fichier utilise la même syntaxe que pour le premier stockage persistant mais avec un nom et une **Storage Class** différents. - -Exécutez cette commande pour créer le volume persistant dans l'espace de nom **myspace** : - -```bash -# Application du fichier de configuration dans l'espace de nom créé. -kubectl apply -f second-storage-pvc.yaml -n myspace -# Affichage des volumes persistants de l'espace de nom créé -kubectl get pv,pvc -n myspace -``` - -Le volume persistant est créé sur le deuxième **Datastore**. - -Revenez dans l'interface **vCenter**. Vous constaterez que vous n'avez pas de nouveaux fichiers dans le dossier `fcd`. - -![04 Display PV2 in vCenter 01](images/04-display-pv2-vmware01.png){.thumbnail} - -Cliquez à droite sur le second Datastore, allez dans le dossier `fcd`{.action} de ce datastore. Vous constaterez que vous avez deux nouveaux fichiers comme sur le premier Datastore. - -![04 Display PV2 in vCenter 02](images/04-display-pv2-vmware02.png){.thumbnail} - -Revenez dans le `Datacenter`{.action} à la racine des datacenters, cliquez sur l'onglet `Surveiller`{.action} et choisissez `Volumes de conteneur`{.action} pour voir apparaitre les deux volumes persistants avec leurs emplacements dans les Datastores. - -![04 Display PV2 in vCenter 03](images/04-display-pv2-vmware03.png){.thumbnail} - -## Aller plus loin - -[Présentation de Tanzu Kubernetes Grid au sein d'OVHcloud](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Installer Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Administrer Tanzu Management Cluster Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) - -[Présentation de VMware Tanzu Kubernetes Grid](https://tanzu.vmware.com/kubernetes-grid) - -[Documentation de VMware Tanzu Kubenetes Grid](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Installation manuelle de l'outil CLI pour le déploiement de Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -Si vous avez besoin d'une formation ou d'une assistance technique pour la mise en oeuvre de nos solutions, contactez votre commercial ou cliquez sur [ce lien](/links/professional-services) pour obtenir un devis et demander une analyse personnalisée de votre projet à nos experts de l’équipe Professional Services. - -Échangez avec notre [communauté d'utilisateurs](/links/community). diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/guide.it-it.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/guide.it-it.md deleted file mode 100644 index 210289ae55c..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/guide.it-it.md +++ /dev/null @@ -1,225 +0,0 @@ ---- -title: Gestione dei volumi persistenti in Tanzu Kubernetes Grid (EN) -excerpt: How to deploy an application in Tanzu Kubernetes Grid with persistent volumes -updated: 2024-01-10 ---- - -## Objective - -**This guide documents how to manage persistent volumes on a Tanzu Kubernetes Grid cluster.** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/it/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- You need to have deployed the **Workload** **TKG** cluster using the [Tanzu Management Cluster Grid administration guide](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage). - -## Introduction - -Persistent volumes are used to store data permanently on a **Kubernetes** cluster. This mechanism is based on **Storage Classes**. There are various Storage Classes. Read the [Kubernetes Storage Classes](https://kubernetes.io/docs/concepts/storage/storage-classes/) guide for more information. - -When deploying a *WorkLoad* cluster, a Storage Class **CSI provisioner** is created and points to the **Datastore** folder that contains the virtual machines in the *WorkLoad* cluster. - -From your VMware cluster, go to the inventory. Select the storage icon to the left, and go to the datastore where your *WorkLoad* cluster was deployed. Go to the `Files`{.action} tab and click the `fcd`{.action} folder. - -The folder is empty because the *WorkLoad* cluster does not yet use persistent volumes. - -![01 Display FCD folder](images/01-display-fcd-folder01.png){.thumbnail} - -You can create additional Storage Classes for each *WorkLoad* cluster. - -## Instructions - -We will connect to a *WorkLoad* cluster from the console of the **Bootstrap** virtual machine. You can use the [Tanzu Management Cluster Grid administration](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) guide to create and manage a workload cluster. - -From the **Bootstrap** virtual machine console, run this command to view the contexts that can be used on this cluster: - -```bash -# Display all the contexts of your TANZU KUBERNETES GRID cluster -kubectl config get-contexts -``` - -Run this command to use the *WorkLoad* cluster: - -```bash -# Connect to WorkLoad cluster -kubectl config use-context tkgm-workload-cluster-admin@tkgm-workload-cluster -``` - -### Displaying Existing Storage Classes - -For information about the Storage Classes in a *WorkLoad* cluster, run these commands: - -```bash -# Display Storage Classes -kubectl get storageclass -# Storage Class description -kubectl describe storageclass nomclasse -``` - -### Creating a storage class on another datastore - -On our VMware cluster, we have two datastores connected to NFS servers. One of the datastores contains the virtual machines in the *WorkLoad* cluster, as well as the **fcd** folder used by the Storage Class in the *Workload* cluster. - -We will create a new Storage Class on the second datastore. - -Go back to your VMware cluster in storage management, select the second datastore, and click `Summary`{.action} in the tab on the left. - -Copy the `URL`{.action} below "Type: NFS 3". - -![02 Select URL01](images/02-display-datastore-url01.png) - -Go to the console of the **Bootstrap** virtual machine, edit a new file named `secondstorageclass.yaml` with this content: - -```yaml -kind: StorageClass -apiVersion: storage.k8s.io/v1 -metadata: - name: secondstorageclass - annotations: - storageclass.kubernetes.io/is-default-class: "true" -provisioner: csi.vsphere.vmware.com -parameters: - datastoreurl: "ds:///vmfs/volumes/xxxxxxxxxxxxxxxxx/" -``` - -Edit the file by replacing `ds:///vmfs/volumes/xxxxxxxxxxxxxxxxx/` with the URL you just copied. - -Next, run this command: - -```bash -# Creating storageclass from yaml file -kubectl apply -f secondstorageclass.yaml -# Display storageclasses -kubectl get storageclass -``` - -We are now seeing two Storage Classes: - -```bash -NAME PROVISIONER RECLAIMPOLICY VOLUMEBINDINGMODE ALLOWVOLUMEEXPANSION AGE -default (default) csi.vsphere.vmware.com Delete Immediate true 3d18h -secondstorageclass (default) csi.vsphere.vmware.com Delete Immediate false 12s -tanzu@bootstrap:~$ -``` - -### Creating a persistent volume in the default Storage class - -Create a file named `default-pvc-storage.yaml` with this content: - -```yaml -kind: PersistentVolumeClaim -apiVersion: v1 -metadata: - name: default-pvc-storage -spec: - accessModes: - - ReadWriteOnce - storageClassName: "default" - resources: - requests: - storage: 2Gi -``` - -The persistent storage name is next to `name`, `storageClassName` contains the name of the Storage Class that is used for this volume. - -Run this command to create the persistent volume: - -```bash -# Create a namespace that will be used for my persistent volume. -kubectl create namespace myspace -# Applying the configuration file to the created namespace. -kubectl apply -f default-pvc-storage.yaml -n myspace -# Display persistent volumes of created namespace -kubectl get pv,pvc -n myspace -``` - -Go back to the inventory in your **vCenter** interface, click on the `DataCenter`{.action} icon on the left, then go to the `Monitor`{.action} tab on the right, and click on `Container Volumes`{.action} to see the persistent volumes. - -The persistent volume that has been created is displayed, and to the right you can see the name of the datastore on which it is stored. - -![03 Display PV in vCenter 01](images/03-display-pv-vmware01.png){.thumbnail} - -Click the notebook icon to the left of the volume to view the details. - -![03 Display PV in vCenter 02](images/03-display-pv-vmware02.png){.thumbnail} - -The information about this persistent storage is displayed, and corresponds to what was created using Kubernetes commands. - -![03 Display PV in vCenter 03](images/03-display-pv-vmware03.png){.thumbnail} - -Go to the Datastore that is used by default, right-click the `Files`{.action} tab and scroll through the folders in the Datastore to the `fcd` folder. - -You see that the folder contains two files, a vmdk file that contains the persistent volume data and an associated temporary file. - -![03 Display PV in vCenter 04](images/03-display-pv-vmware04.png){.thumbnail} - -### Creating a persistent volume on the second Storage Class - -Return to the **Bootstrap** virtual machine and use the command line. - -Create a file named `second-storage-pvc.yaml`: - -```yaml -kind: PersistentVolumeClaim -apiVersion: v1 -metadata: - name: second-storage-pvc -spec: - accessModes: - - ReadWriteOnce - storageClassName: "secondstorageclass" - resources: - requests: - storage: 2Gi -``` - -The file uses the same syntax as the first persistent storage, but with a different name and **Storage Class**. - -Run this command to create the persistent volume in the **myspace namespace**: - -```bash -# Applying the configuration file to the created namespace. -kubectl apply -f second-storage-pvc.yaml -n myspace -# Display persistent volumes of created namespace -kubectl get pv,pvc -n myspace -``` - -The persistent volume is created on the second **Datastore**. - -Return to the **vCenter** interface. You will see that you do not have any new files in the `fcd` folder. - -![04 Display PV2 in vCenter 01](images/04-display-pv2-vmware01.png){.thumbnail} - -Right-click the second Datastore, go to the `fcd`{.action} folder for that datastore. You will see that you have two new files, as in the first datastore. - -![04 Display PV2 in vCenter 02](images/04-display-pv2-vmware02.png){.thumbnail} - -Go back to the `Datacenter`{.action} at the root of the datacenters, click on the `Monitor`{.action} tab, and choose `Container volumes`{.action} to see the two persistent volumes appear with their locations in the datastores. - -![04 Display PV2 in vCenter 03](images/04-display-pv2-vmware03.png){.thumbnail} - -## Go further - -[Introduction to Tanzu Kubernetes Grid at OVHcloud](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Installing Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Managing Tanzu Management Cluster Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) - -[Introducing VMware Tanzu Kubernetes Grid](https://tanzu.vmware.com/kubernetes-grid) - -[VMware Tanzu Kubenetes Grid documentation](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/guide.pl-pl.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/guide.pl-pl.md deleted file mode 100644 index d760ac303a7..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/guide.pl-pl.md +++ /dev/null @@ -1,225 +0,0 @@ ---- -title: Zarządzanie trwałymi woluminami w Tanzu Kubernetes Grid (EN) -excerpt: How to deploy an application in Tanzu Kubernetes Grid with persistent volumes -updated: 2024-01-10 ---- - -## Objective - -**This guide documents how to manage persistent volumes on a Tanzu Kubernetes Grid cluster.** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/pl/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- You need to have deployed the **Workload** **TKG** cluster using the [Tanzu Management Cluster Grid administration guide](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage). - -## Introduction - -Persistent volumes are used to store data permanently on a **Kubernetes** cluster. This mechanism is based on **Storage Classes**. There are various Storage Classes. Read the [Kubernetes Storage Classes](https://kubernetes.io/docs/concepts/storage/storage-classes/) guide for more information. - -When deploying a *WorkLoad* cluster, a Storage Class **CSI provisioner** is created and points to the **Datastore** folder that contains the virtual machines in the *WorkLoad* cluster. - -From your VMware cluster, go to the inventory. Select the storage icon to the left, and go to the datastore where your *WorkLoad* cluster was deployed. Go to the `Files`{.action} tab and click the `fcd`{.action} folder. - -The folder is empty because the *WorkLoad* cluster does not yet use persistent volumes. - -![01 Display FCD folder](images/01-display-fcd-folder01.png){.thumbnail} - -You can create additional Storage Classes for each *WorkLoad* cluster. - -## Instructions - -We will connect to a *WorkLoad* cluster from the console of the **Bootstrap** virtual machine. You can use the [Tanzu Management Cluster Grid administration](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) guide to create and manage a workload cluster. - -From the **Bootstrap** virtual machine console, run this command to view the contexts that can be used on this cluster: - -```bash -# Display all the contexts of your TANZU KUBERNETES GRID cluster -kubectl config get-contexts -``` - -Run this command to use the *WorkLoad* cluster: - -```bash -# Connect to WorkLoad cluster -kubectl config use-context tkgm-workload-cluster-admin@tkgm-workload-cluster -``` - -### Displaying Existing Storage Classes - -For information about the Storage Classes in a *WorkLoad* cluster, run these commands: - -```bash -# Display Storage Classes -kubectl get storageclass -# Storage Class description -kubectl describe storageclass nomclasse -``` - -### Creating a storage class on another datastore - -On our VMware cluster, we have two datastores connected to NFS servers. One of the datastores contains the virtual machines in the *WorkLoad* cluster, as well as the **fcd** folder used by the Storage Class in the *Workload* cluster. - -We will create a new Storage Class on the second datastore. - -Go back to your VMware cluster in storage management, select the second datastore, and click `Summary`{.action} in the tab on the left. - -Copy the `URL`{.action} below "Type: NFS 3". - -![02 Select URL01](images/02-display-datastore-url01.png) - -Go to the console of the **Bootstrap** virtual machine, edit a new file named `secondstorageclass.yaml` with this content: - -```yaml -kind: StorageClass -apiVersion: storage.k8s.io/v1 -metadata: - name: secondstorageclass - annotations: - storageclass.kubernetes.io/is-default-class: "true" -provisioner: csi.vsphere.vmware.com -parameters: - datastoreurl: "ds:///vmfs/volumes/xxxxxxxxxxxxxxxxx/" -``` - -Edit the file by replacing `ds:///vmfs/volumes/xxxxxxxxxxxxxxxxx/` with the URL you just copied. - -Next, run this command: - -```bash -# Creating storageclass from yaml file -kubectl apply -f secondstorageclass.yaml -# Display storageclasses -kubectl get storageclass -``` - -We are now seeing two Storage Classes: - -```bash -NAME PROVISIONER RECLAIMPOLICY VOLUMEBINDINGMODE ALLOWVOLUMEEXPANSION AGE -default (default) csi.vsphere.vmware.com Delete Immediate true 3d18h -secondstorageclass (default) csi.vsphere.vmware.com Delete Immediate false 12s -tanzu@bootstrap:~$ -``` - -### Creating a persistent volume in the default Storage class - -Create a file named `default-pvc-storage.yaml` with this content: - -```yaml -kind: PersistentVolumeClaim -apiVersion: v1 -metadata: - name: default-pvc-storage -spec: - accessModes: - - ReadWriteOnce - storageClassName: "default" - resources: - requests: - storage: 2Gi -``` - -The persistent storage name is next to `name`, `storageClassName` contains the name of the Storage Class that is used for this volume. - -Run this command to create the persistent volume: - -```bash -# Create a namespace that will be used for my persistent volume. -kubectl create namespace myspace -# Applying the configuration file to the created namespace. -kubectl apply -f default-pvc-storage.yaml -n myspace -# Display persistent volumes of created namespace -kubectl get pv,pvc -n myspace -``` - -Go back to the inventory in your **vCenter** interface, click on the `DataCenter`{.action} icon on the left, then go to the `Monitor`{.action} tab on the right, and click on `Container Volumes`{.action} to see the persistent volumes. - -The persistent volume that has been created is displayed, and to the right you can see the name of the datastore on which it is stored. - -![03 Display PV in vCenter 01](images/03-display-pv-vmware01.png){.thumbnail} - -Click the notebook icon to the left of the volume to view the details. - -![03 Display PV in vCenter 02](images/03-display-pv-vmware02.png){.thumbnail} - -The information about this persistent storage is displayed, and corresponds to what was created using Kubernetes commands. - -![03 Display PV in vCenter 03](images/03-display-pv-vmware03.png){.thumbnail} - -Go to the Datastore that is used by default, right-click the `Files`{.action} tab and scroll through the folders in the Datastore to the `fcd` folder. - -You see that the folder contains two files, a vmdk file that contains the persistent volume data and an associated temporary file. - -![03 Display PV in vCenter 04](images/03-display-pv-vmware04.png){.thumbnail} - -### Creating a persistent volume on the second Storage Class - -Return to the **Bootstrap** virtual machine and use the command line. - -Create a file named `second-storage-pvc.yaml`: - -```yaml -kind: PersistentVolumeClaim -apiVersion: v1 -metadata: - name: second-storage-pvc -spec: - accessModes: - - ReadWriteOnce - storageClassName: "secondstorageclass" - resources: - requests: - storage: 2Gi -``` - -The file uses the same syntax as the first persistent storage, but with a different name and **Storage Class**. - -Run this command to create the persistent volume in the **myspace namespace**: - -```bash -# Applying the configuration file to the created namespace. -kubectl apply -f second-storage-pvc.yaml -n myspace -# Display persistent volumes of created namespace -kubectl get pv,pvc -n myspace -``` - -The persistent volume is created on the second **Datastore**. - -Return to the **vCenter** interface. You will see that you do not have any new files in the `fcd` folder. - -![04 Display PV2 in vCenter 01](images/04-display-pv2-vmware01.png){.thumbnail} - -Right-click the second Datastore, go to the `fcd`{.action} folder for that datastore. You will see that you have two new files, as in the first datastore. - -![04 Display PV2 in vCenter 02](images/04-display-pv2-vmware02.png){.thumbnail} - -Go back to the `Datacenter`{.action} at the root of the datacenters, click on the `Monitor`{.action} tab, and choose `Container volumes`{.action} to see the two persistent volumes appear with their locations in the datastores. - -![04 Display PV2 in vCenter 03](images/04-display-pv2-vmware03.png){.thumbnail} - -## Go further - -[Introduction to Tanzu Kubernetes Grid at OVHcloud](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Installing Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Managing Tanzu Management Cluster Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) - -[Introducing VMware Tanzu Kubernetes Grid](https://tanzu.vmware.com/kubernetes-grid) - -[VMware Tanzu Kubenetes Grid documentation](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/guide.pt-pt.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/guide.pt-pt.md deleted file mode 100644 index d23a1953f40..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/guide.pt-pt.md +++ /dev/null @@ -1,225 +0,0 @@ ---- -title: Gerenciando volumes persistentes no Tanzu Kubernetes Grid (EN) -excerpt: How to deploy an application in Tanzu Kubernetes Grid with persistent volumes -updated: 2024-01-10 ---- - -## Objective - -**This guide documents how to manage persistent volumes on a Tanzu Kubernetes Grid cluster.** - -> [!warning] -> OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly. -> -> This guide is designed to assist you as much as possible with common tasks. However, we recommend contacting a [specialist provider](https://partner.ovhcloud.com/en-gb/) if you experience any difficulties or doubts when it comes to managing, using or setting up a service on a server. -> - -## Requirements - -- Being an administrative contact of your [Hosted Private Cloud infrastructure](https://www.ovhcloud.com/pt/enterprise/products/hosted-private-cloud/) to receive login credentials -- A user account with access to the [OVHcloud Control Panel](/links/manager) -- A user account with access to vSphere -- You need to have deployed the **Workload** **TKG** cluster using the [Tanzu Management Cluster Grid administration guide](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage). - -## Introduction - -Persistent volumes are used to store data permanently on a **Kubernetes** cluster. This mechanism is based on **Storage Classes**. There are various Storage Classes. Read the [Kubernetes Storage Classes](https://kubernetes.io/docs/concepts/storage/storage-classes/) guide for more information. - -When deploying a *WorkLoad* cluster, a Storage Class **CSI provisioner** is created and points to the **Datastore** folder that contains the virtual machines in the *WorkLoad* cluster. - -From your VMware cluster, go to the inventory. Select the storage icon to the left, and go to the datastore where your *WorkLoad* cluster was deployed. Go to the `Files`{.action} tab and click the `fcd`{.action} folder. - -The folder is empty because the *WorkLoad* cluster does not yet use persistent volumes. - -![01 Display FCD folder](images/01-display-fcd-folder01.png){.thumbnail} - -You can create additional Storage Classes for each *WorkLoad* cluster. - -## Instructions - -We will connect to a *WorkLoad* cluster from the console of the **Bootstrap** virtual machine. You can use the [Tanzu Management Cluster Grid administration](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) guide to create and manage a workload cluster. - -From the **Bootstrap** virtual machine console, run this command to view the contexts that can be used on this cluster: - -```bash -# Display all the contexts of your TANZU KUBERNETES GRID cluster -kubectl config get-contexts -``` - -Run this command to use the *WorkLoad* cluster: - -```bash -# Connect to WorkLoad cluster -kubectl config use-context tkgm-workload-cluster-admin@tkgm-workload-cluster -``` - -### Displaying Existing Storage Classes - -For information about the Storage Classes in a *WorkLoad* cluster, run these commands: - -```bash -# Display Storage Classes -kubectl get storageclass -# Storage Class description -kubectl describe storageclass nomclasse -``` - -### Creating a storage class on another datastore - -On our VMware cluster, we have two datastores connected to NFS servers. One of the datastores contains the virtual machines in the *WorkLoad* cluster, as well as the **fcd** folder used by the Storage Class in the *Workload* cluster. - -We will create a new Storage Class on the second datastore. - -Go back to your VMware cluster in storage management, select the second datastore, and click `Summary`{.action} in the tab on the left. - -Copy the `URL`{.action} below "Type: NFS 3". - -![02 Select URL01](images/02-display-datastore-url01.png) - -Go to the console of the **Bootstrap** virtual machine, edit a new file named `secondstorageclass.yaml` with this content: - -```yaml -kind: StorageClass -apiVersion: storage.k8s.io/v1 -metadata: - name: secondstorageclass - annotations: - storageclass.kubernetes.io/is-default-class: "true" -provisioner: csi.vsphere.vmware.com -parameters: - datastoreurl: "ds:///vmfs/volumes/xxxxxxxxxxxxxxxxx/" -``` - -Edit the file by replacing `ds:///vmfs/volumes/xxxxxxxxxxxxxxxxx/` with the URL you just copied. - -Next, run this command: - -```bash -# Creating storageclass from yaml file -kubectl apply -f secondstorageclass.yaml -# Display storageclasses -kubectl get storageclass -``` - -We are now seeing two Storage Classes: - -```bash -NAME PROVISIONER RECLAIMPOLICY VOLUMEBINDINGMODE ALLOWVOLUMEEXPANSION AGE -default (default) csi.vsphere.vmware.com Delete Immediate true 3d18h -secondstorageclass (default) csi.vsphere.vmware.com Delete Immediate false 12s -tanzu@bootstrap:~$ -``` - -### Creating a persistent volume in the default Storage class - -Create a file named `default-pvc-storage.yaml` with this content: - -```yaml -kind: PersistentVolumeClaim -apiVersion: v1 -metadata: - name: default-pvc-storage -spec: - accessModes: - - ReadWriteOnce - storageClassName: "default" - resources: - requests: - storage: 2Gi -``` - -The persistent storage name is next to `name`, `storageClassName` contains the name of the Storage Class that is used for this volume. - -Run this command to create the persistent volume: - -```bash -# Create a namespace that will be used for my persistent volume. -kubectl create namespace myspace -# Applying the configuration file to the created namespace. -kubectl apply -f default-pvc-storage.yaml -n myspace -# Display persistent volumes of created namespace -kubectl get pv,pvc -n myspace -``` - -Go back to the inventory in your **vCenter** interface, click on the `DataCenter`{.action} icon on the left, then go to the `Monitor`{.action} tab on the right, and click on `Container Volumes`{.action} to see the persistent volumes. - -The persistent volume that has been created is displayed, and to the right you can see the name of the datastore on which it is stored. - -![03 Display PV in vCenter 01](images/03-display-pv-vmware01.png){.thumbnail} - -Click the notebook icon to the left of the volume to view the details. - -![03 Display PV in vCenter 02](images/03-display-pv-vmware02.png){.thumbnail} - -The information about this persistent storage is displayed, and corresponds to what was created using Kubernetes commands. - -![03 Display PV in vCenter 03](images/03-display-pv-vmware03.png){.thumbnail} - -Go to the Datastore that is used by default, right-click the `Files`{.action} tab and scroll through the folders in the Datastore to the `fcd` folder. - -You see that the folder contains two files, a vmdk file that contains the persistent volume data and an associated temporary file. - -![03 Display PV in vCenter 04](images/03-display-pv-vmware04.png){.thumbnail} - -### Creating a persistent volume on the second Storage Class - -Return to the **Bootstrap** virtual machine and use the command line. - -Create a file named `second-storage-pvc.yaml`: - -```yaml -kind: PersistentVolumeClaim -apiVersion: v1 -metadata: - name: second-storage-pvc -spec: - accessModes: - - ReadWriteOnce - storageClassName: "secondstorageclass" - resources: - requests: - storage: 2Gi -``` - -The file uses the same syntax as the first persistent storage, but with a different name and **Storage Class**. - -Run this command to create the persistent volume in the **myspace namespace**: - -```bash -# Applying the configuration file to the created namespace. -kubectl apply -f second-storage-pvc.yaml -n myspace -# Display persistent volumes of created namespace -kubectl get pv,pvc -n myspace -``` - -The persistent volume is created on the second **Datastore**. - -Return to the **vCenter** interface. You will see that you do not have any new files in the `fcd` folder. - -![04 Display PV2 in vCenter 01](images/04-display-pv2-vmware01.png){.thumbnail} - -Right-click the second Datastore, go to the `fcd`{.action} folder for that datastore. You will see that you have two new files, as in the first datastore. - -![04 Display PV2 in vCenter 02](images/04-display-pv2-vmware02.png){.thumbnail} - -Go back to the `Datacenter`{.action} at the root of the datacenters, click on the `Monitor`{.action} tab, and choose `Container volumes`{.action} to see the two persistent volumes appear with their locations in the datastores. - -![04 Display PV2 in vCenter 03](images/04-display-pv2-vmware03.png){.thumbnail} - -## Go further - -[Introduction to Tanzu Kubernetes Grid at OVHcloud](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Installing Tanzu Kubernetes Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_02installation) - -[Managing Tanzu Management Cluster Grid](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_03manage) - -[Introducing VMware Tanzu Kubernetes Grid](https://tanzu.vmware.com/kubernetes-grid) - -[VMware Tanzu Kubenetes Grid documentation](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/index.html) - -[Manual installation of the CLI tool for the deployment of Tanzu Kubernetes GRID](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-install-cli.html) - -If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. - -Join our community of users on . diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/images/01-display-fcd-folder01.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/images/01-display-fcd-folder01.png deleted file mode 100644 index 364a74375cd..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/images/01-display-fcd-folder01.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/images/02-display-datastore-url01.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/images/02-display-datastore-url01.png deleted file mode 100644 index 751f38457de..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/images/02-display-datastore-url01.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/images/03-display-pv-vmware01.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/images/03-display-pv-vmware01.png deleted file mode 100644 index 5fff18b3b3e..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/images/03-display-pv-vmware01.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/images/03-display-pv-vmware02.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/images/03-display-pv-vmware02.png deleted file mode 100644 index 523e15d5174..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/images/03-display-pv-vmware02.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/images/03-display-pv-vmware03.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/images/03-display-pv-vmware03.png deleted file mode 100644 index f7f95694b2d..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/images/03-display-pv-vmware03.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/images/03-display-pv-vmware04.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/images/03-display-pv-vmware04.png deleted file mode 100644 index 80569142731..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/images/03-display-pv-vmware04.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/images/04-display-pv2-vmware01.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/images/04-display-pv2-vmware01.png deleted file mode 100644 index 80569142731..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/images/04-display-pv2-vmware01.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/images/04-display-pv2-vmware02.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/images/04-display-pv2-vmware02.png deleted file mode 100644 index 18c0285e868..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/images/04-display-pv2-vmware02.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/images/04-display-pv2-vmware03.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/images/04-display-pv2-vmware03.png deleted file mode 100644 index 56b1923e618..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/images/04-display-pv2-vmware03.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/meta.yaml b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/meta.yaml deleted file mode 100755 index dddf387fbd2..00000000000 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/tanzu_tkgm_04persistent-volumes/meta.yaml +++ /dev/null @@ -1,2 +0,0 @@ -id: 1d3ca296-fc47-4c31-a610-958f328c8953 -full_slug: vmware-tanzu-tkgm-persistent-volumes \ No newline at end of file diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/use_iam_with_vSphere/images/create_iam_user_2.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/use_iam_with_vSphere/images/create_iam_user_2.png deleted file mode 100644 index 65be12b810c..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/use_iam_with_vSphere/images/create_iam_user_2.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/using_private_cloud_in_vrack/guide.pt-pt.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/using_private_cloud_in_vrack/guide.pt-pt.md index 3850fd63782..aabaa60b955 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/using_private_cloud_in_vrack/guide.pt-pt.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/using_private_cloud_in_vrack/guide.pt-pt.md @@ -24,7 +24,7 @@ O vRack é a possibilidade de ligar diferentes serviços cloud da OVHcloud entre ### Área de Cliente -Aquando da entrega do seu serviço [Hosted Private Cloud](https://www.ovhcloud.com/pt/enterprise/products/hosted-private-cloud/), a parte *datacenter* já está dentro de um vRack. Para aceder à secção vRack, aceda à secção `Bare Metal Cloud`{.action, clique em `Network`{.action}, e em `vRack`{.action}. Selecione o seu vRack na lista para visualizar o conteúdo. +Aquando da entrega do seu serviço [Hosted Private Cloud](https://www.ovhcloud.com/pt/enterprise/products/hosted-private-cloud/), a parte *datacenter* já está dentro de um vRack. Para aceder à secção vRack, aceda à secção `Bare Metal Cloud`{.action}, clique em `Network`{.action}, e em `vRack`{.action}. Selecione o seu vRack na lista para visualizar o conteúdo. ![Datacenter](images/vRackDatacenter.PNG){.thumbnail} diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/using_private_cloud_in_vrack/images/EditSettingsVMN.PNG b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/using_private_cloud_in_vrack/images/EditSettingsVMN.PNG deleted file mode 100644 index bd3c706e209..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/using_private_cloud_in_vrack/images/EditSettingsVMN.PNG and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/using_private_cloud_in_vrack/images/EditSettingvLAN.PNG b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/using_private_cloud_in_vrack/images/EditSettingvLAN.PNG deleted file mode 100644 index 2f0c093e54f..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/using_private_cloud_in_vrack/images/EditSettingvLAN.PNG and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/using_private_cloud_in_vrack/images/img_1054.jpg b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/using_private_cloud_in_vrack/images/img_1054.jpg deleted file mode 100644 index 2cb468239a8..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/using_private_cloud_in_vrack/images/img_1054.jpg and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/using_private_cloud_in_vrack/images/img_1056.jpg b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/using_private_cloud_in_vrack/images/img_1056.jpg deleted file mode 100644 index 419db8e939b..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/using_private_cloud_in_vrack/images/img_1056.jpg and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/using_private_cloud_in_vrack/images/img_1057.jpg b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/using_private_cloud_in_vrack/images/img_1057.jpg deleted file mode 100644 index 5c94d121cbc..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/using_private_cloud_in_vrack/images/img_1057.jpg and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/using_private_cloud_in_vrack/images/img_1059.jpg b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/using_private_cloud_in_vrack/images/img_1059.jpg deleted file mode 100644 index e6d57c1d2aa..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/using_private_cloud_in_vrack/images/img_1059.jpg and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/using_private_cloud_in_vrack/images/img_1060.jpg b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/using_private_cloud_in_vrack/images/img_1060.jpg deleted file mode 100644 index 2fa62ab9806..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/using_private_cloud_in_vrack/images/img_1060.jpg and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/using_private_cloud_in_vrack/images/img_1061.jpg b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/using_private_cloud_in_vrack/images/img_1061.jpg deleted file mode 100644 index 74f61fc28e2..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/using_private_cloud_in_vrack/images/img_1061.jpg and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/using_private_cloud_in_vrack/images/img_1062.jpg b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/using_private_cloud_in_vrack/images/img_1062.jpg deleted file mode 100644 index 6716768f9d0..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/using_private_cloud_in_vrack/images/img_1062.jpg and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/using_private_cloud_in_vrack/images/vRackVMNetwork.PNG b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/using_private_cloud_in_vrack/images/vRackVMNetwork.PNG deleted file mode 100644 index eaab8e3b6a1..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/using_private_cloud_in_vrack/images/vRackVMNetwork.PNG and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/utilisation_du_protocole_sslv3_sur_private_cloud/guide.fr-fr.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/utilisation_du_protocole_sslv3_sur_private_cloud/guide.fr-fr.md index 87e03a54477..cf9c34c7815 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/utilisation_du_protocole_sslv3_sur_private_cloud/guide.fr-fr.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/utilisation_du_protocole_sslv3_sur_private_cloud/guide.fr-fr.md @@ -18,7 +18,7 @@ Toutefois, certains outils ou logiciels requièrent SSLv3 pour fonctionner, c'es Si vous utilisez l'un de ces outils, nous vous recommandons de prévoir leur mise à jour au plus vite afin de supprimer votre dépendance à SSLv3. -Si vous utilisez cette technologie pour vos sauvegardes, notre solution [Veeam Backup](https://www.ovh.com/fr/private-cloud/options/veeam.xml){.external-link}, disponible en option, est intégralement gérée par OVH et respecte tous les standards de sécurité. +Si vous utilisez cette technologie pour vos sauvegardes, notre solution [Veeam Backup](https://www.ovh.com/fr/private-cloud/options/veeam.xml), disponible en option, est intégralement gérée par OVH et respecte tous les standards de sécurité. **Ce guide montre comment vérifier l'état du protocole SSLv3 et comment l'utiliser** @@ -26,7 +26,7 @@ Si vous utilisez cette technologie pour vos sauvegardes, notre solution [Veeam B ### Vérifier l'état du protocole SSLv3 -Vous devez tout d'abord vous rendre sur l'API [ovh.com](http://ovh.com){.external-link} : [http://api.ovh.com](http://api.ovh.com/){.external-link} et vous connecter à l'aide de votre identifiant client ([guide sur l'utilisation de l'API](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/connexion_a_l_api_ovh) +Vous devez tout d'abord vous rendre sur l'API [ovh.com](http://ovh.com) : [http://api.ovh.com](http://api.ovh.com/) et vous connecter à l'aide de votre identifiant client ([guide sur l'utilisation de l'API](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/connexion_a_l_api_ovh) Dans la section /dedicatedCloud, repérez l'appel `GET /dedicatedCloud/{serviceName}` @@ -42,9 +42,9 @@ Si vous devez impérativement ré-activer SSLv3, voici comment procéder. **Attention : La réactivation de SSLv3 nécessite au préalable la mise en place des configurations suivantes :** -- [Restreindre l'accès au vCenter aux IPs autorisées](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud#securite){.external-link} +- [Restreindre l'accès au vCenter aux IPs autorisées](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud#securite) -- [Ajouter explicitement les IPs qui seront autorisées à se connecter](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud#securite){.external-link} +- [Ajouter explicitement les IPs qui seront autorisées à se connecter](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/manager_ovh_private_cloud#securite) Vous devez tout d'abord vous rendre sur l'API ovh.com : et vous connecter à l'aide de votre identifiant client ([guide sur l'utilisation de l'API](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/connexion_a_l_api_ovh) @@ -60,7 +60,7 @@ La réponse de l'api vous indiquera "null". Cette réponse est tout à fait norm Dès lors que vous n'avez plus besoin de SSLv3, afin de garantir la sécurité de votre infrastructure Private Cloud, nous vous recommandons de désactiver cette option en suivant la procédure suivante. -Vous devez tout d'abord vous rendre sur l'API ovh.com : [http://api.ovh.com](http://api.ovh.com/){.external-link} et vous connecter à l'aide de votre identifiant client ([guide sur l'utilisation de l'API](/pages/manage_and_operate/api/first-steps)) +Vous devez tout d'abord vous rendre sur l'API ovh.com : [http://api.ovh.com](http://api.ovh.com/) et vous connecter à l'aide de votre identifiant client ([guide sur l'utilisation de l'API](/pages/manage_and_operate/api/first-steps)) Dans la section /dedicatedCloud, repérez l'appel `PUT /dedicatedCloud/{serviceName}` diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/utilisation_du_protocole_sslv3_sur_private_cloud/images/SSLv3.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/utilisation_du_protocole_sslv3_sur_private_cloud/images/SSLv3.png deleted file mode 100644 index 9bb710b6b5d..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/utilisation_du_protocole_sslv3_sur_private_cloud/images/SSLv3.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.de-de.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.de-de.md index 1466c7a48b2..30f43a74a0c 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.de-de.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.de-de.md @@ -1,6 +1,6 @@ --- -title: "Public VCF as-a-Service - Backup with Veeam Data Platform (EN)" -excerpt: "Find out how to perform backups and restores with Veeam Data Platform integration" +title: "Public VCF as-a-Service - Backups with Veeam Data Platform (EN)" +excerpt: "Find out how to perform backups and restoration with Veeam (Plug-in) Data Platform / Protection for Public VCF as-a-Service" updated: 2025-02-24 --- @@ -31,13 +31,13 @@ details[open]>summary::before { - [How to log in to your organization](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-logging) - [How to use the Public VCF as-a-Service user interface](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started) - You must be familiar with how Veeam Backup works. -- An understanding of the financial impact following the various load factors that apply when setting up this solution with Public VCF as-a-Service (see the [pricing grid for Veeam Managed Backup](/links/hosted-private-cloud/veeam-managed-backup). +- An understanding of the financial impact following the various load factors that apply when setting up this solution with Public VCF as-a-Service (see the [pricing grid for Veeam Managed Backup](/links/hosted-private-cloud/public-vcf-aas-veeam)). ## Instructions Veeam Data Platform supports Public VCF as-a-Service. It uses the Public VCF as-a-Service API to back up the vApps and VMs and restore them directly in the Public VCF as-a-Service hierarchy. -The Veeam Data Platform service is available and ready to use for all 3 OVHcloud solutions (see the [features catalog](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts#key-features). +The Veeam Data Platform service is available and ready to use for all 3 OVHcloud solutions (see the [features catalog](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts#key-features)). > [!warning] > @@ -56,7 +56,7 @@ When using Public VCF as-a-Service Data Protection integration with Veeam to cre To access the Data Protection Portal with Veeam from Cloud Director, log in to the Public VCF as-a-Service Client Portal with a vCloud Director account with the appropriate rights. -In the menu of the top center bar, click `More`{.action} and select `Data Protection with Veeam`{.action} +In the menu of the top center bar, click `More`{.action} and select `Data Protection with Veeam`{.action}. ![Public VCF as-a-Service access to Veeam Backup](images/vcd_veeam_backup.png){.thumbnail} @@ -144,7 +144,7 @@ In the Veeam Public VCF as-a-Service console, click `More`{.action} and select ` ![Public VCF as-a-Service access to Veeam Backup](images/vcd_veeam_backup.png){.thumbnail} -Click `Jobs`{.action} then `Create`{.action} +Click `Jobs`{.action} then `Create`{.action}. ![Public VCF as-a-Service Backup Job Veeam creation](images/vcd_veeam_backup_job_creation.png){.thumbnail} @@ -164,7 +164,7 @@ Click `Next`{.action}. Your virtual machine will then appear in the list. -Click `Next.`{.action} +Click `Next.`{.action}. ![Public VCF as-a-Service Backup Job Veeam creation](images/vcd_veeam_backup_job_creation_5.png){.thumbnail} @@ -177,7 +177,7 @@ Click `Next.`{.action} > > For Windows you can choose a standard account or a managed service account. -Click `Next`{.action} +Click `Next`{.action}. ![Public VCF as-a-Service Backup Job Veeam creation](images/vcd_veeam_backup_job_creation_6.png){.thumbnail} diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.en-asia.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.en-asia.md index b49e7d757bf..6a89b9da271 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.en-asia.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.en-asia.md @@ -1,6 +1,6 @@ --- -title: "Public VCF as-a-Service - Backup with Veeam Data Platform" -excerpt: "Find out how to perform backups and restores with Veeam Data Platform integration" +title: "Public VCF as-a-Service - Backups with Veeam Data Platform" +excerpt: "Find out how to perform backups and restoration with Veeam (Plug-in) Data Platform / Protection for Public VCF as-a-Service" updated: 2025-02-24 --- @@ -31,13 +31,13 @@ details[open]>summary::before { - [How to log in to your organization](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-logging) - [How to use the Public VCF as-a-Service user interface](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started) - You must be familiar with how Veeam Backup works. -- An understanding of the financial impact following the various load factors that apply when setting up this solution with Public VCF as-a-Service (see the [pricing grid for Veeam Managed Backup](/links/hosted-private-cloud/veeam-managed-backup). +- An understanding of the financial impact following the various load factors that apply when setting up this solution with Public VCF as-a-Service (see the [pricing grid for Veeam Managed Backup](/links/hosted-private-cloud/public-vcf-aas-veeam)). ## Instructions Veeam Data Platform supports Public VCF as-a-Service. It uses the Public VCF as-a-Service API to back up the vApps and VMs and restore them directly in the Public VCF as-a-Service hierarchy. -The Veeam Data Platform service is available and ready to use for all 3 OVHcloud solutions (see the [features catalog](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts#key-features). +The Veeam Data Platform service is available and ready to use for all 3 OVHcloud solutions (see the [features catalog](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts#key-features)). > [!warning] > @@ -56,7 +56,7 @@ When using Public VCF as-a-Service Data Protection integration with Veeam to cre To access the Data Protection Portal with Veeam from Cloud Director, log in to the Public VCF as-a-Service Client Portal with a vCloud Director account with the appropriate rights. -In the menu of the top center bar, click `More`{.action} and select `Data Protection with Veeam`{.action} +In the menu of the top center bar, click `More`{.action} and select `Data Protection with Veeam`{.action}. ![Public VCF as-a-Service access to Veeam Backup](images/vcd_veeam_backup.png){.thumbnail} @@ -144,7 +144,7 @@ In the Veeam Public VCF as-a-Service console, click `More`{.action} and select ` ![Public VCF as-a-Service access to Veeam Backup](images/vcd_veeam_backup.png){.thumbnail} -Click `Jobs`{.action} then `Create`{.action} +Click `Jobs`{.action} then `Create`{.action}. ![Public VCF as-a-Service Backup Job Veeam creation](images/vcd_veeam_backup_job_creation.png){.thumbnail} @@ -164,7 +164,7 @@ Click `Next`{.action}. Your virtual machine will then appear in the list. -Click `Next.`{.action} +Click `Next.`{.action}. ![Public VCF as-a-Service Backup Job Veeam creation](images/vcd_veeam_backup_job_creation_5.png){.thumbnail} @@ -177,7 +177,7 @@ Click `Next.`{.action} > > For Windows you can choose a standard account or a managed service account. -Click `Next`{.action} +Click `Next`{.action}. ![Public VCF as-a-Service Backup Job Veeam creation](images/vcd_veeam_backup_job_creation_6.png){.thumbnail} diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.en-au.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.en-au.md index b49e7d757bf..6a89b9da271 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.en-au.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.en-au.md @@ -1,6 +1,6 @@ --- -title: "Public VCF as-a-Service - Backup with Veeam Data Platform" -excerpt: "Find out how to perform backups and restores with Veeam Data Platform integration" +title: "Public VCF as-a-Service - Backups with Veeam Data Platform" +excerpt: "Find out how to perform backups and restoration with Veeam (Plug-in) Data Platform / Protection for Public VCF as-a-Service" updated: 2025-02-24 --- @@ -31,13 +31,13 @@ details[open]>summary::before { - [How to log in to your organization](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-logging) - [How to use the Public VCF as-a-Service user interface](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started) - You must be familiar with how Veeam Backup works. -- An understanding of the financial impact following the various load factors that apply when setting up this solution with Public VCF as-a-Service (see the [pricing grid for Veeam Managed Backup](/links/hosted-private-cloud/veeam-managed-backup). +- An understanding of the financial impact following the various load factors that apply when setting up this solution with Public VCF as-a-Service (see the [pricing grid for Veeam Managed Backup](/links/hosted-private-cloud/public-vcf-aas-veeam)). ## Instructions Veeam Data Platform supports Public VCF as-a-Service. It uses the Public VCF as-a-Service API to back up the vApps and VMs and restore them directly in the Public VCF as-a-Service hierarchy. -The Veeam Data Platform service is available and ready to use for all 3 OVHcloud solutions (see the [features catalog](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts#key-features). +The Veeam Data Platform service is available and ready to use for all 3 OVHcloud solutions (see the [features catalog](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts#key-features)). > [!warning] > @@ -56,7 +56,7 @@ When using Public VCF as-a-Service Data Protection integration with Veeam to cre To access the Data Protection Portal with Veeam from Cloud Director, log in to the Public VCF as-a-Service Client Portal with a vCloud Director account with the appropriate rights. -In the menu of the top center bar, click `More`{.action} and select `Data Protection with Veeam`{.action} +In the menu of the top center bar, click `More`{.action} and select `Data Protection with Veeam`{.action}. ![Public VCF as-a-Service access to Veeam Backup](images/vcd_veeam_backup.png){.thumbnail} @@ -144,7 +144,7 @@ In the Veeam Public VCF as-a-Service console, click `More`{.action} and select ` ![Public VCF as-a-Service access to Veeam Backup](images/vcd_veeam_backup.png){.thumbnail} -Click `Jobs`{.action} then `Create`{.action} +Click `Jobs`{.action} then `Create`{.action}. ![Public VCF as-a-Service Backup Job Veeam creation](images/vcd_veeam_backup_job_creation.png){.thumbnail} @@ -164,7 +164,7 @@ Click `Next`{.action}. Your virtual machine will then appear in the list. -Click `Next.`{.action} +Click `Next.`{.action}. ![Public VCF as-a-Service Backup Job Veeam creation](images/vcd_veeam_backup_job_creation_5.png){.thumbnail} @@ -177,7 +177,7 @@ Click `Next.`{.action} > > For Windows you can choose a standard account or a managed service account. -Click `Next`{.action} +Click `Next`{.action}. ![Public VCF as-a-Service Backup Job Veeam creation](images/vcd_veeam_backup_job_creation_6.png){.thumbnail} diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.en-ca.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.en-ca.md index b49e7d757bf..6a89b9da271 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.en-ca.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.en-ca.md @@ -1,6 +1,6 @@ --- -title: "Public VCF as-a-Service - Backup with Veeam Data Platform" -excerpt: "Find out how to perform backups and restores with Veeam Data Platform integration" +title: "Public VCF as-a-Service - Backups with Veeam Data Platform" +excerpt: "Find out how to perform backups and restoration with Veeam (Plug-in) Data Platform / Protection for Public VCF as-a-Service" updated: 2025-02-24 --- @@ -31,13 +31,13 @@ details[open]>summary::before { - [How to log in to your organization](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-logging) - [How to use the Public VCF as-a-Service user interface](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started) - You must be familiar with how Veeam Backup works. -- An understanding of the financial impact following the various load factors that apply when setting up this solution with Public VCF as-a-Service (see the [pricing grid for Veeam Managed Backup](/links/hosted-private-cloud/veeam-managed-backup). +- An understanding of the financial impact following the various load factors that apply when setting up this solution with Public VCF as-a-Service (see the [pricing grid for Veeam Managed Backup](/links/hosted-private-cloud/public-vcf-aas-veeam)). ## Instructions Veeam Data Platform supports Public VCF as-a-Service. It uses the Public VCF as-a-Service API to back up the vApps and VMs and restore them directly in the Public VCF as-a-Service hierarchy. -The Veeam Data Platform service is available and ready to use for all 3 OVHcloud solutions (see the [features catalog](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts#key-features). +The Veeam Data Platform service is available and ready to use for all 3 OVHcloud solutions (see the [features catalog](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts#key-features)). > [!warning] > @@ -56,7 +56,7 @@ When using Public VCF as-a-Service Data Protection integration with Veeam to cre To access the Data Protection Portal with Veeam from Cloud Director, log in to the Public VCF as-a-Service Client Portal with a vCloud Director account with the appropriate rights. -In the menu of the top center bar, click `More`{.action} and select `Data Protection with Veeam`{.action} +In the menu of the top center bar, click `More`{.action} and select `Data Protection with Veeam`{.action}. ![Public VCF as-a-Service access to Veeam Backup](images/vcd_veeam_backup.png){.thumbnail} @@ -144,7 +144,7 @@ In the Veeam Public VCF as-a-Service console, click `More`{.action} and select ` ![Public VCF as-a-Service access to Veeam Backup](images/vcd_veeam_backup.png){.thumbnail} -Click `Jobs`{.action} then `Create`{.action} +Click `Jobs`{.action} then `Create`{.action}. ![Public VCF as-a-Service Backup Job Veeam creation](images/vcd_veeam_backup_job_creation.png){.thumbnail} @@ -164,7 +164,7 @@ Click `Next`{.action}. Your virtual machine will then appear in the list. -Click `Next.`{.action} +Click `Next.`{.action}. ![Public VCF as-a-Service Backup Job Veeam creation](images/vcd_veeam_backup_job_creation_5.png){.thumbnail} @@ -177,7 +177,7 @@ Click `Next.`{.action} > > For Windows you can choose a standard account or a managed service account. -Click `Next`{.action} +Click `Next`{.action}. ![Public VCF as-a-Service Backup Job Veeam creation](images/vcd_veeam_backup_job_creation_6.png){.thumbnail} diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.en-gb.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.en-gb.md index d9537ccd862..6a89b9da271 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.en-gb.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.en-gb.md @@ -31,13 +31,13 @@ details[open]>summary::before { - [How to log in to your organization](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-logging) - [How to use the Public VCF as-a-Service user interface](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started) - You must be familiar with how Veeam Backup works. -- An understanding of the financial impact following the various load factors that apply when setting up this solution with Public VCF as-a-Service (see the [pricing grid for Veeam Managed Backup](/links/hosted-private-cloud/veeam-managed-backup). +- An understanding of the financial impact following the various load factors that apply when setting up this solution with Public VCF as-a-Service (see the [pricing grid for Veeam Managed Backup](/links/hosted-private-cloud/public-vcf-aas-veeam)). ## Instructions Veeam Data Platform supports Public VCF as-a-Service. It uses the Public VCF as-a-Service API to back up the vApps and VMs and restore them directly in the Public VCF as-a-Service hierarchy. -The Veeam Data Platform service is available and ready to use for all 3 OVHcloud solutions (see the [features catalog](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts#key-features). +The Veeam Data Platform service is available and ready to use for all 3 OVHcloud solutions (see the [features catalog](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts#key-features)). > [!warning] > @@ -56,7 +56,7 @@ When using Public VCF as-a-Service Data Protection integration with Veeam to cre To access the Data Protection Portal with Veeam from Cloud Director, log in to the Public VCF as-a-Service Client Portal with a vCloud Director account with the appropriate rights. -In the menu of the top center bar, click `More`{.action} and select `Data Protection with Veeam`{.action} +In the menu of the top center bar, click `More`{.action} and select `Data Protection with Veeam`{.action}. ![Public VCF as-a-Service access to Veeam Backup](images/vcd_veeam_backup.png){.thumbnail} @@ -144,7 +144,7 @@ In the Veeam Public VCF as-a-Service console, click `More`{.action} and select ` ![Public VCF as-a-Service access to Veeam Backup](images/vcd_veeam_backup.png){.thumbnail} -Click `Jobs`{.action} then `Create`{.action} +Click `Jobs`{.action} then `Create`{.action}. ![Public VCF as-a-Service Backup Job Veeam creation](images/vcd_veeam_backup_job_creation.png){.thumbnail} @@ -164,7 +164,7 @@ Click `Next`{.action}. Your virtual machine will then appear in the list. -Click `Next.`{.action} +Click `Next.`{.action}. ![Public VCF as-a-Service Backup Job Veeam creation](images/vcd_veeam_backup_job_creation_5.png){.thumbnail} @@ -177,7 +177,7 @@ Click `Next.`{.action} > > For Windows you can choose a standard account or a managed service account. -Click `Next`{.action} +Click `Next`{.action}. ![Public VCF as-a-Service Backup Job Veeam creation](images/vcd_veeam_backup_job_creation_6.png){.thumbnail} diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.en-ie.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.en-ie.md index b49e7d757bf..6a89b9da271 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.en-ie.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.en-ie.md @@ -1,6 +1,6 @@ --- -title: "Public VCF as-a-Service - Backup with Veeam Data Platform" -excerpt: "Find out how to perform backups and restores with Veeam Data Platform integration" +title: "Public VCF as-a-Service - Backups with Veeam Data Platform" +excerpt: "Find out how to perform backups and restoration with Veeam (Plug-in) Data Platform / Protection for Public VCF as-a-Service" updated: 2025-02-24 --- @@ -31,13 +31,13 @@ details[open]>summary::before { - [How to log in to your organization](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-logging) - [How to use the Public VCF as-a-Service user interface](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started) - You must be familiar with how Veeam Backup works. -- An understanding of the financial impact following the various load factors that apply when setting up this solution with Public VCF as-a-Service (see the [pricing grid for Veeam Managed Backup](/links/hosted-private-cloud/veeam-managed-backup). +- An understanding of the financial impact following the various load factors that apply when setting up this solution with Public VCF as-a-Service (see the [pricing grid for Veeam Managed Backup](/links/hosted-private-cloud/public-vcf-aas-veeam)). ## Instructions Veeam Data Platform supports Public VCF as-a-Service. It uses the Public VCF as-a-Service API to back up the vApps and VMs and restore them directly in the Public VCF as-a-Service hierarchy. -The Veeam Data Platform service is available and ready to use for all 3 OVHcloud solutions (see the [features catalog](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts#key-features). +The Veeam Data Platform service is available and ready to use for all 3 OVHcloud solutions (see the [features catalog](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts#key-features)). > [!warning] > @@ -56,7 +56,7 @@ When using Public VCF as-a-Service Data Protection integration with Veeam to cre To access the Data Protection Portal with Veeam from Cloud Director, log in to the Public VCF as-a-Service Client Portal with a vCloud Director account with the appropriate rights. -In the menu of the top center bar, click `More`{.action} and select `Data Protection with Veeam`{.action} +In the menu of the top center bar, click `More`{.action} and select `Data Protection with Veeam`{.action}. ![Public VCF as-a-Service access to Veeam Backup](images/vcd_veeam_backup.png){.thumbnail} @@ -144,7 +144,7 @@ In the Veeam Public VCF as-a-Service console, click `More`{.action} and select ` ![Public VCF as-a-Service access to Veeam Backup](images/vcd_veeam_backup.png){.thumbnail} -Click `Jobs`{.action} then `Create`{.action} +Click `Jobs`{.action} then `Create`{.action}. ![Public VCF as-a-Service Backup Job Veeam creation](images/vcd_veeam_backup_job_creation.png){.thumbnail} @@ -164,7 +164,7 @@ Click `Next`{.action}. Your virtual machine will then appear in the list. -Click `Next.`{.action} +Click `Next.`{.action}. ![Public VCF as-a-Service Backup Job Veeam creation](images/vcd_veeam_backup_job_creation_5.png){.thumbnail} @@ -177,7 +177,7 @@ Click `Next.`{.action} > > For Windows you can choose a standard account or a managed service account. -Click `Next`{.action} +Click `Next`{.action}. ![Public VCF as-a-Service Backup Job Veeam creation](images/vcd_veeam_backup_job_creation_6.png){.thumbnail} diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.en-sg.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.en-sg.md index b49e7d757bf..6a89b9da271 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.en-sg.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.en-sg.md @@ -1,6 +1,6 @@ --- -title: "Public VCF as-a-Service - Backup with Veeam Data Platform" -excerpt: "Find out how to perform backups and restores with Veeam Data Platform integration" +title: "Public VCF as-a-Service - Backups with Veeam Data Platform" +excerpt: "Find out how to perform backups and restoration with Veeam (Plug-in) Data Platform / Protection for Public VCF as-a-Service" updated: 2025-02-24 --- @@ -31,13 +31,13 @@ details[open]>summary::before { - [How to log in to your organization](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-logging) - [How to use the Public VCF as-a-Service user interface](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started) - You must be familiar with how Veeam Backup works. -- An understanding of the financial impact following the various load factors that apply when setting up this solution with Public VCF as-a-Service (see the [pricing grid for Veeam Managed Backup](/links/hosted-private-cloud/veeam-managed-backup). +- An understanding of the financial impact following the various load factors that apply when setting up this solution with Public VCF as-a-Service (see the [pricing grid for Veeam Managed Backup](/links/hosted-private-cloud/public-vcf-aas-veeam)). ## Instructions Veeam Data Platform supports Public VCF as-a-Service. It uses the Public VCF as-a-Service API to back up the vApps and VMs and restore them directly in the Public VCF as-a-Service hierarchy. -The Veeam Data Platform service is available and ready to use for all 3 OVHcloud solutions (see the [features catalog](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts#key-features). +The Veeam Data Platform service is available and ready to use for all 3 OVHcloud solutions (see the [features catalog](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts#key-features)). > [!warning] > @@ -56,7 +56,7 @@ When using Public VCF as-a-Service Data Protection integration with Veeam to cre To access the Data Protection Portal with Veeam from Cloud Director, log in to the Public VCF as-a-Service Client Portal with a vCloud Director account with the appropriate rights. -In the menu of the top center bar, click `More`{.action} and select `Data Protection with Veeam`{.action} +In the menu of the top center bar, click `More`{.action} and select `Data Protection with Veeam`{.action}. ![Public VCF as-a-Service access to Veeam Backup](images/vcd_veeam_backup.png){.thumbnail} @@ -144,7 +144,7 @@ In the Veeam Public VCF as-a-Service console, click `More`{.action} and select ` ![Public VCF as-a-Service access to Veeam Backup](images/vcd_veeam_backup.png){.thumbnail} -Click `Jobs`{.action} then `Create`{.action} +Click `Jobs`{.action} then `Create`{.action}. ![Public VCF as-a-Service Backup Job Veeam creation](images/vcd_veeam_backup_job_creation.png){.thumbnail} @@ -164,7 +164,7 @@ Click `Next`{.action}. Your virtual machine will then appear in the list. -Click `Next.`{.action} +Click `Next.`{.action}. ![Public VCF as-a-Service Backup Job Veeam creation](images/vcd_veeam_backup_job_creation_5.png){.thumbnail} @@ -177,7 +177,7 @@ Click `Next.`{.action} > > For Windows you can choose a standard account or a managed service account. -Click `Next`{.action} +Click `Next`{.action}. ![Public VCF as-a-Service Backup Job Veeam creation](images/vcd_veeam_backup_job_creation_6.png){.thumbnail} diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.en-us.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.en-us.md index b49e7d757bf..6a89b9da271 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.en-us.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.en-us.md @@ -1,6 +1,6 @@ --- -title: "Public VCF as-a-Service - Backup with Veeam Data Platform" -excerpt: "Find out how to perform backups and restores with Veeam Data Platform integration" +title: "Public VCF as-a-Service - Backups with Veeam Data Platform" +excerpt: "Find out how to perform backups and restoration with Veeam (Plug-in) Data Platform / Protection for Public VCF as-a-Service" updated: 2025-02-24 --- @@ -31,13 +31,13 @@ details[open]>summary::before { - [How to log in to your organization](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-logging) - [How to use the Public VCF as-a-Service user interface](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started) - You must be familiar with how Veeam Backup works. -- An understanding of the financial impact following the various load factors that apply when setting up this solution with Public VCF as-a-Service (see the [pricing grid for Veeam Managed Backup](/links/hosted-private-cloud/veeam-managed-backup). +- An understanding of the financial impact following the various load factors that apply when setting up this solution with Public VCF as-a-Service (see the [pricing grid for Veeam Managed Backup](/links/hosted-private-cloud/public-vcf-aas-veeam)). ## Instructions Veeam Data Platform supports Public VCF as-a-Service. It uses the Public VCF as-a-Service API to back up the vApps and VMs and restore them directly in the Public VCF as-a-Service hierarchy. -The Veeam Data Platform service is available and ready to use for all 3 OVHcloud solutions (see the [features catalog](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts#key-features). +The Veeam Data Platform service is available and ready to use for all 3 OVHcloud solutions (see the [features catalog](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts#key-features)). > [!warning] > @@ -56,7 +56,7 @@ When using Public VCF as-a-Service Data Protection integration with Veeam to cre To access the Data Protection Portal with Veeam from Cloud Director, log in to the Public VCF as-a-Service Client Portal with a vCloud Director account with the appropriate rights. -In the menu of the top center bar, click `More`{.action} and select `Data Protection with Veeam`{.action} +In the menu of the top center bar, click `More`{.action} and select `Data Protection with Veeam`{.action}. ![Public VCF as-a-Service access to Veeam Backup](images/vcd_veeam_backup.png){.thumbnail} @@ -144,7 +144,7 @@ In the Veeam Public VCF as-a-Service console, click `More`{.action} and select ` ![Public VCF as-a-Service access to Veeam Backup](images/vcd_veeam_backup.png){.thumbnail} -Click `Jobs`{.action} then `Create`{.action} +Click `Jobs`{.action} then `Create`{.action}. ![Public VCF as-a-Service Backup Job Veeam creation](images/vcd_veeam_backup_job_creation.png){.thumbnail} @@ -164,7 +164,7 @@ Click `Next`{.action}. Your virtual machine will then appear in the list. -Click `Next.`{.action} +Click `Next.`{.action}. ![Public VCF as-a-Service Backup Job Veeam creation](images/vcd_veeam_backup_job_creation_5.png){.thumbnail} @@ -177,7 +177,7 @@ Click `Next.`{.action} > > For Windows you can choose a standard account or a managed service account. -Click `Next`{.action} +Click `Next`{.action}. ![Public VCF as-a-Service Backup Job Veeam creation](images/vcd_veeam_backup_job_creation_6.png){.thumbnail} diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.es-es.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.es-es.md index 1466c7a48b2..30f43a74a0c 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.es-es.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.es-es.md @@ -1,6 +1,6 @@ --- -title: "Public VCF as-a-Service - Backup with Veeam Data Platform (EN)" -excerpt: "Find out how to perform backups and restores with Veeam Data Platform integration" +title: "Public VCF as-a-Service - Backups with Veeam Data Platform (EN)" +excerpt: "Find out how to perform backups and restoration with Veeam (Plug-in) Data Platform / Protection for Public VCF as-a-Service" updated: 2025-02-24 --- @@ -31,13 +31,13 @@ details[open]>summary::before { - [How to log in to your organization](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-logging) - [How to use the Public VCF as-a-Service user interface](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started) - You must be familiar with how Veeam Backup works. -- An understanding of the financial impact following the various load factors that apply when setting up this solution with Public VCF as-a-Service (see the [pricing grid for Veeam Managed Backup](/links/hosted-private-cloud/veeam-managed-backup). +- An understanding of the financial impact following the various load factors that apply when setting up this solution with Public VCF as-a-Service (see the [pricing grid for Veeam Managed Backup](/links/hosted-private-cloud/public-vcf-aas-veeam)). ## Instructions Veeam Data Platform supports Public VCF as-a-Service. It uses the Public VCF as-a-Service API to back up the vApps and VMs and restore them directly in the Public VCF as-a-Service hierarchy. -The Veeam Data Platform service is available and ready to use for all 3 OVHcloud solutions (see the [features catalog](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts#key-features). +The Veeam Data Platform service is available and ready to use for all 3 OVHcloud solutions (see the [features catalog](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts#key-features)). > [!warning] > @@ -56,7 +56,7 @@ When using Public VCF as-a-Service Data Protection integration with Veeam to cre To access the Data Protection Portal with Veeam from Cloud Director, log in to the Public VCF as-a-Service Client Portal with a vCloud Director account with the appropriate rights. -In the menu of the top center bar, click `More`{.action} and select `Data Protection with Veeam`{.action} +In the menu of the top center bar, click `More`{.action} and select `Data Protection with Veeam`{.action}. ![Public VCF as-a-Service access to Veeam Backup](images/vcd_veeam_backup.png){.thumbnail} @@ -144,7 +144,7 @@ In the Veeam Public VCF as-a-Service console, click `More`{.action} and select ` ![Public VCF as-a-Service access to Veeam Backup](images/vcd_veeam_backup.png){.thumbnail} -Click `Jobs`{.action} then `Create`{.action} +Click `Jobs`{.action} then `Create`{.action}. ![Public VCF as-a-Service Backup Job Veeam creation](images/vcd_veeam_backup_job_creation.png){.thumbnail} @@ -164,7 +164,7 @@ Click `Next`{.action}. Your virtual machine will then appear in the list. -Click `Next.`{.action} +Click `Next.`{.action}. ![Public VCF as-a-Service Backup Job Veeam creation](images/vcd_veeam_backup_job_creation_5.png){.thumbnail} @@ -177,7 +177,7 @@ Click `Next.`{.action} > > For Windows you can choose a standard account or a managed service account. -Click `Next`{.action} +Click `Next`{.action}. ![Public VCF as-a-Service Backup Job Veeam creation](images/vcd_veeam_backup_job_creation_6.png){.thumbnail} diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.es-us.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.es-us.md index 1466c7a48b2..30f43a74a0c 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.es-us.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.es-us.md @@ -1,6 +1,6 @@ --- -title: "Public VCF as-a-Service - Backup with Veeam Data Platform (EN)" -excerpt: "Find out how to perform backups and restores with Veeam Data Platform integration" +title: "Public VCF as-a-Service - Backups with Veeam Data Platform (EN)" +excerpt: "Find out how to perform backups and restoration with Veeam (Plug-in) Data Platform / Protection for Public VCF as-a-Service" updated: 2025-02-24 --- @@ -31,13 +31,13 @@ details[open]>summary::before { - [How to log in to your organization](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-logging) - [How to use the Public VCF as-a-Service user interface](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started) - You must be familiar with how Veeam Backup works. -- An understanding of the financial impact following the various load factors that apply when setting up this solution with Public VCF as-a-Service (see the [pricing grid for Veeam Managed Backup](/links/hosted-private-cloud/veeam-managed-backup). +- An understanding of the financial impact following the various load factors that apply when setting up this solution with Public VCF as-a-Service (see the [pricing grid for Veeam Managed Backup](/links/hosted-private-cloud/public-vcf-aas-veeam)). ## Instructions Veeam Data Platform supports Public VCF as-a-Service. It uses the Public VCF as-a-Service API to back up the vApps and VMs and restore them directly in the Public VCF as-a-Service hierarchy. -The Veeam Data Platform service is available and ready to use for all 3 OVHcloud solutions (see the [features catalog](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts#key-features). +The Veeam Data Platform service is available and ready to use for all 3 OVHcloud solutions (see the [features catalog](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts#key-features)). > [!warning] > @@ -56,7 +56,7 @@ When using Public VCF as-a-Service Data Protection integration with Veeam to cre To access the Data Protection Portal with Veeam from Cloud Director, log in to the Public VCF as-a-Service Client Portal with a vCloud Director account with the appropriate rights. -In the menu of the top center bar, click `More`{.action} and select `Data Protection with Veeam`{.action} +In the menu of the top center bar, click `More`{.action} and select `Data Protection with Veeam`{.action}. ![Public VCF as-a-Service access to Veeam Backup](images/vcd_veeam_backup.png){.thumbnail} @@ -144,7 +144,7 @@ In the Veeam Public VCF as-a-Service console, click `More`{.action} and select ` ![Public VCF as-a-Service access to Veeam Backup](images/vcd_veeam_backup.png){.thumbnail} -Click `Jobs`{.action} then `Create`{.action} +Click `Jobs`{.action} then `Create`{.action}. ![Public VCF as-a-Service Backup Job Veeam creation](images/vcd_veeam_backup_job_creation.png){.thumbnail} @@ -164,7 +164,7 @@ Click `Next`{.action}. Your virtual machine will then appear in the list. -Click `Next.`{.action} +Click `Next.`{.action}. ![Public VCF as-a-Service Backup Job Veeam creation](images/vcd_veeam_backup_job_creation_5.png){.thumbnail} @@ -177,7 +177,7 @@ Click `Next.`{.action} > > For Windows you can choose a standard account or a managed service account. -Click `Next`{.action} +Click `Next`{.action}. ![Public VCF as-a-Service Backup Job Veeam creation](images/vcd_veeam_backup_job_creation_6.png){.thumbnail} diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.fr-ca.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.fr-ca.md index a2ccd535d36..c7a230dbc5a 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.fr-ca.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.fr-ca.md @@ -30,7 +30,7 @@ details[open]>summary::before { - [Les concepts fondamentaux](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts) - [Comment se connecter à son organisation](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-logging) - [Comment utiliser l'interface utilisateur](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started) -- Avoir une connaissance du fonctionnement de Veeam et de l'impact financier consécutif aux différents paramètres de charge qui s'appliquent lors de la mise en place de cette solution à Public VCF as-a-Service (cf. grille tarifaire des sauvegardes Veeam Public VCF as-a-Service disponible via [ce lien](/links/hosted-private-cloud/veeam-managed-backup). +- Avoir une connaissance du fonctionnement de Veeam et de l'impact financier consécutif aux différents paramètres de charge qui s'appliquent lors de la mise en place de cette solution à Public VCF as-a-Service (cf. grille tarifaire des sauvegardes Veeam Public VCF as-a-Service disponible via [ce lien](/links/hosted-private-cloud/public-vcf-aas-veeam)). ## En pratique diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.fr-fr.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.fr-fr.md index 9af018373bf..799e9f56801 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.fr-fr.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.fr-fr.md @@ -30,7 +30,7 @@ details[open]>summary::before { - [Les concepts fondamentaux](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts) - [Comment se connecter à son organisation](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-logging) - [Comment utiliser l'interface utilisateur](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started) -- Avoir une connaissance du fonctionnement de Veeam et de l'impact financier consécutif aux différents paramètres de charge qui s'appliquent lors de la mise en place de cette solution à Public VCF as-a-Service (cf. grille tarifaire des sauvegardes Veeam Public VCF as-a-Service disponible via [ce lien](/links/hosted-private-cloud/veeam-managed-backup). +- Avoir une connaissance du fonctionnement de Veeam et de l'impact financier consécutif aux différents paramètres de charge qui s'appliquent lors de la mise en place de cette solution à Public VCF as-a-Service (cf. grille tarifaire des sauvegardes Veeam Public VCF as-a-Service disponible via [ce lien](/links/hosted-private-cloud/public-vcf-aas-veeam)). ## En pratique @@ -141,11 +141,11 @@ Pour les machines virtuelles gérées par Public VCF as-a-Service, Veeam Backup Vous allez créer votre premiere tâche de sauvegarde depuis le plugin Public VCF as-a-Service Veeam Data Platform : -Dans la console Public VCF as-a-Service Veeam, cliquez sur `Plus`{.action} et sélectionnez `Protection des données avec Veeam`{.action} +Dans la console Public VCF as-a-Service Veeam, cliquez sur `Plus`{.action} et sélectionnez `Protection des données avec Veeam`{.action}. ![Public VCF as-a-Service access to Veeam Backup](images/vcd_veeam_backup.png){.thumbnail} -Cliquez sur `Jobs`{.action} puis sur `Create`{.action} +Cliquez sur `Jobs`{.action} puis sur `Create`{.action}. ![Public VCF as-a-Service Backup Job Veeam creation](images/vcd_veeam_backup_job_creation.png){.thumbnail} @@ -165,7 +165,7 @@ Cliquez sur `Next`{.action}. Votre machine virtuelle apparait alors dans la liste. -Cliquez sur `Next.`{.action} +Cliquez sur `Next`{.action}. ![Public VCF as-a-Service Backup Job Veeam creation](images/vcd_veeam_backup_job_creation_5.png){.thumbnail} @@ -178,7 +178,7 @@ Cliquez sur `Next.`{.action} > > Pour Windows, vous pouvez choisir un compte standard ou un compte de service managé. -Cliquez sur `Next`{.action} +Cliquez sur `Next`{.action}. ![Public VCF as-a-Service Backup Job Veeam creation](images/vcd_veeam_backup_job_creation_6.png){.thumbnail} @@ -247,13 +247,13 @@ Lorsque vous restaurez des VMs normales ou autonomes dans la hiérarchie vCloud **Comment restaurer une machine virtuelle depuis le plugin Veeam Data Platform Public VCF as-a-Service ?** -Pour effectuer une restauration complète, cliquez sur `Entire VM Restore`{.action} +Pour effectuer une restauration complète, cliquez sur `Entire VM Restore`{.action}. ![VCD_Veeam_restore_vm_1](images/vcd_veeam_restore_vm.png){.thumbnail} Depuis la fenêtre que s'affiche, cliquez sur `Restore to the original location`{.action} pour la restauration d'une VM complète (full). -Puis cliquez sur `Next.`{.action}. +Puis cliquez sur `Next`{.action}. ![VCD_Veeam_restore_vm_2](images/vcd_veeam_restore_vm_2.png){.thumbnail} diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.it-it.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.it-it.md index 1466c7a48b2..30f43a74a0c 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.it-it.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.it-it.md @@ -1,6 +1,6 @@ --- -title: "Public VCF as-a-Service - Backup with Veeam Data Platform (EN)" -excerpt: "Find out how to perform backups and restores with Veeam Data Platform integration" +title: "Public VCF as-a-Service - Backups with Veeam Data Platform (EN)" +excerpt: "Find out how to perform backups and restoration with Veeam (Plug-in) Data Platform / Protection for Public VCF as-a-Service" updated: 2025-02-24 --- @@ -31,13 +31,13 @@ details[open]>summary::before { - [How to log in to your organization](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-logging) - [How to use the Public VCF as-a-Service user interface](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started) - You must be familiar with how Veeam Backup works. -- An understanding of the financial impact following the various load factors that apply when setting up this solution with Public VCF as-a-Service (see the [pricing grid for Veeam Managed Backup](/links/hosted-private-cloud/veeam-managed-backup). +- An understanding of the financial impact following the various load factors that apply when setting up this solution with Public VCF as-a-Service (see the [pricing grid for Veeam Managed Backup](/links/hosted-private-cloud/public-vcf-aas-veeam)). ## Instructions Veeam Data Platform supports Public VCF as-a-Service. It uses the Public VCF as-a-Service API to back up the vApps and VMs and restore them directly in the Public VCF as-a-Service hierarchy. -The Veeam Data Platform service is available and ready to use for all 3 OVHcloud solutions (see the [features catalog](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts#key-features). +The Veeam Data Platform service is available and ready to use for all 3 OVHcloud solutions (see the [features catalog](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts#key-features)). > [!warning] > @@ -56,7 +56,7 @@ When using Public VCF as-a-Service Data Protection integration with Veeam to cre To access the Data Protection Portal with Veeam from Cloud Director, log in to the Public VCF as-a-Service Client Portal with a vCloud Director account with the appropriate rights. -In the menu of the top center bar, click `More`{.action} and select `Data Protection with Veeam`{.action} +In the menu of the top center bar, click `More`{.action} and select `Data Protection with Veeam`{.action}. ![Public VCF as-a-Service access to Veeam Backup](images/vcd_veeam_backup.png){.thumbnail} @@ -144,7 +144,7 @@ In the Veeam Public VCF as-a-Service console, click `More`{.action} and select ` ![Public VCF as-a-Service access to Veeam Backup](images/vcd_veeam_backup.png){.thumbnail} -Click `Jobs`{.action} then `Create`{.action} +Click `Jobs`{.action} then `Create`{.action}. ![Public VCF as-a-Service Backup Job Veeam creation](images/vcd_veeam_backup_job_creation.png){.thumbnail} @@ -164,7 +164,7 @@ Click `Next`{.action}. Your virtual machine will then appear in the list. -Click `Next.`{.action} +Click `Next.`{.action}. ![Public VCF as-a-Service Backup Job Veeam creation](images/vcd_veeam_backup_job_creation_5.png){.thumbnail} @@ -177,7 +177,7 @@ Click `Next.`{.action} > > For Windows you can choose a standard account or a managed service account. -Click `Next`{.action} +Click `Next`{.action}. ![Public VCF as-a-Service Backup Job Veeam creation](images/vcd_veeam_backup_job_creation_6.png){.thumbnail} diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.pl-pl.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.pl-pl.md index 1466c7a48b2..30f43a74a0c 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.pl-pl.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.pl-pl.md @@ -1,6 +1,6 @@ --- -title: "Public VCF as-a-Service - Backup with Veeam Data Platform (EN)" -excerpt: "Find out how to perform backups and restores with Veeam Data Platform integration" +title: "Public VCF as-a-Service - Backups with Veeam Data Platform (EN)" +excerpt: "Find out how to perform backups and restoration with Veeam (Plug-in) Data Platform / Protection for Public VCF as-a-Service" updated: 2025-02-24 --- @@ -31,13 +31,13 @@ details[open]>summary::before { - [How to log in to your organization](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-logging) - [How to use the Public VCF as-a-Service user interface](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started) - You must be familiar with how Veeam Backup works. -- An understanding of the financial impact following the various load factors that apply when setting up this solution with Public VCF as-a-Service (see the [pricing grid for Veeam Managed Backup](/links/hosted-private-cloud/veeam-managed-backup). +- An understanding of the financial impact following the various load factors that apply when setting up this solution with Public VCF as-a-Service (see the [pricing grid for Veeam Managed Backup](/links/hosted-private-cloud/public-vcf-aas-veeam)). ## Instructions Veeam Data Platform supports Public VCF as-a-Service. It uses the Public VCF as-a-Service API to back up the vApps and VMs and restore them directly in the Public VCF as-a-Service hierarchy. -The Veeam Data Platform service is available and ready to use for all 3 OVHcloud solutions (see the [features catalog](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts#key-features). +The Veeam Data Platform service is available and ready to use for all 3 OVHcloud solutions (see the [features catalog](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts#key-features)). > [!warning] > @@ -56,7 +56,7 @@ When using Public VCF as-a-Service Data Protection integration with Veeam to cre To access the Data Protection Portal with Veeam from Cloud Director, log in to the Public VCF as-a-Service Client Portal with a vCloud Director account with the appropriate rights. -In the menu of the top center bar, click `More`{.action} and select `Data Protection with Veeam`{.action} +In the menu of the top center bar, click `More`{.action} and select `Data Protection with Veeam`{.action}. ![Public VCF as-a-Service access to Veeam Backup](images/vcd_veeam_backup.png){.thumbnail} @@ -144,7 +144,7 @@ In the Veeam Public VCF as-a-Service console, click `More`{.action} and select ` ![Public VCF as-a-Service access to Veeam Backup](images/vcd_veeam_backup.png){.thumbnail} -Click `Jobs`{.action} then `Create`{.action} +Click `Jobs`{.action} then `Create`{.action}. ![Public VCF as-a-Service Backup Job Veeam creation](images/vcd_veeam_backup_job_creation.png){.thumbnail} @@ -164,7 +164,7 @@ Click `Next`{.action}. Your virtual machine will then appear in the list. -Click `Next.`{.action} +Click `Next.`{.action}. ![Public VCF as-a-Service Backup Job Veeam creation](images/vcd_veeam_backup_job_creation_5.png){.thumbnail} @@ -177,7 +177,7 @@ Click `Next.`{.action} > > For Windows you can choose a standard account or a managed service account. -Click `Next`{.action} +Click `Next`{.action}. ![Public VCF as-a-Service Backup Job Veeam creation](images/vcd_veeam_backup_job_creation_6.png){.thumbnail} diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.pt-pt.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.pt-pt.md index 1466c7a48b2..30f43a74a0c 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.pt-pt.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/guide.pt-pt.md @@ -1,6 +1,6 @@ --- -title: "Public VCF as-a-Service - Backup with Veeam Data Platform (EN)" -excerpt: "Find out how to perform backups and restores with Veeam Data Platform integration" +title: "Public VCF as-a-Service - Backups with Veeam Data Platform (EN)" +excerpt: "Find out how to perform backups and restoration with Veeam (Plug-in) Data Platform / Protection for Public VCF as-a-Service" updated: 2025-02-24 --- @@ -31,13 +31,13 @@ details[open]>summary::before { - [How to log in to your organization](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-logging) - [How to use the Public VCF as-a-Service user interface](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started) - You must be familiar with how Veeam Backup works. -- An understanding of the financial impact following the various load factors that apply when setting up this solution with Public VCF as-a-Service (see the [pricing grid for Veeam Managed Backup](/links/hosted-private-cloud/veeam-managed-backup). +- An understanding of the financial impact following the various load factors that apply when setting up this solution with Public VCF as-a-Service (see the [pricing grid for Veeam Managed Backup](/links/hosted-private-cloud/public-vcf-aas-veeam)). ## Instructions Veeam Data Platform supports Public VCF as-a-Service. It uses the Public VCF as-a-Service API to back up the vApps and VMs and restore them directly in the Public VCF as-a-Service hierarchy. -The Veeam Data Platform service is available and ready to use for all 3 OVHcloud solutions (see the [features catalog](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts#key-features). +The Veeam Data Platform service is available and ready to use for all 3 OVHcloud solutions (see the [features catalog](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts#key-features)). > [!warning] > @@ -56,7 +56,7 @@ When using Public VCF as-a-Service Data Protection integration with Veeam to cre To access the Data Protection Portal with Veeam from Cloud Director, log in to the Public VCF as-a-Service Client Portal with a vCloud Director account with the appropriate rights. -In the menu of the top center bar, click `More`{.action} and select `Data Protection with Veeam`{.action} +In the menu of the top center bar, click `More`{.action} and select `Data Protection with Veeam`{.action}. ![Public VCF as-a-Service access to Veeam Backup](images/vcd_veeam_backup.png){.thumbnail} @@ -144,7 +144,7 @@ In the Veeam Public VCF as-a-Service console, click `More`{.action} and select ` ![Public VCF as-a-Service access to Veeam Backup](images/vcd_veeam_backup.png){.thumbnail} -Click `Jobs`{.action} then `Create`{.action} +Click `Jobs`{.action} then `Create`{.action}. ![Public VCF as-a-Service Backup Job Veeam creation](images/vcd_veeam_backup_job_creation.png){.thumbnail} @@ -164,7 +164,7 @@ Click `Next`{.action}. Your virtual machine will then appear in the list. -Click `Next.`{.action} +Click `Next.`{.action}. ![Public VCF as-a-Service Backup Job Veeam creation](images/vcd_veeam_backup_job_creation_5.png){.thumbnail} @@ -177,7 +177,7 @@ Click `Next.`{.action} > > For Windows you can choose a standard account or a managed service account. -Click `Next`{.action} +Click `Next`{.action}. ![Public VCF as-a-Service Backup Job Veeam creation](images/vcd_veeam_backup_job_creation_6.png){.thumbnail} diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/images/vcd_veeam_backup_console.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/images/vcd_veeam_backup_console.png deleted file mode 100644 index 6df4d917ca4..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/images/vcd_veeam_backup_console.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/images/vcd_veeam_backup_job.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/images/vcd_veeam_backup_job.png deleted file mode 100644 index ce5d79aef72..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/images/vcd_veeam_backup_job.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/images/vcd_veeam_backup_job_creation_2.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/images/vcd_veeam_backup_job_creation_2.png deleted file mode 100644 index 7e64504ce35..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/images/vcd_veeam_backup_job_creation_2.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/images/vcd_veeam_backup_repo.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/images/vcd_veeam_backup_repo.png deleted file mode 100644 index b320162a556..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-backup/images/vcd_veeam_backup_repo.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.de-de.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.de-de.md index e72283775e7..f3e0ece8c16 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.de-de.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.de-de.md @@ -1,7 +1,7 @@ --- title: "Public VCF as-a-Service - FAQ (EN)" excerpt: "Find the most frequently asked questions about Public VCF as-a-Service" -updated: 2024-10-23 +updated: 2025-09-30 --- ## FAQ @@ -48,6 +48,13 @@ updated: 2024-10-23 > **Can I choose the Thin or Thick disk type with Public VCF as-a-Service when I create a new virtual machine or disk**? > > No. With Public VCF as-a-Service, each disk consumes storage in a Virtual Datacentre (vDC) organization. There is no associated Thin or Thick setting for a tenant. > > +> **Can I use my existing Windows Server licenses in Public VCF as-a-Service?** +> > It depends on the type of license you own: +> > +> > - **Software Subscription licenses**: Yes, you can use these in OVHcloud Public VCF as-a-Service. +> > - **Perpetual software licenses**: No, these cannot be used in OVHcloud Public VCF as-a-Service. +> > +> > If your organization holds both types of licenses, only the subscription ones are eligible for use within the solution. ## Go further diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.en-asia.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.en-asia.md index d00ac19135e..cb05abc432e 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.en-asia.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.en-asia.md @@ -1,7 +1,7 @@ --- title: "Public VCF as-a-Service - FAQ" excerpt: "Find the most frequently asked questions about Public VCF as-a-Service" -updated: 2024-10-23 +updated: 2025-09-30 --- ## FAQ @@ -48,6 +48,13 @@ updated: 2024-10-23 > **Can I choose the Thin or Thick disk type with Public VCF as-a-Service when I create a new virtual machine or disk**? > > No. With Public VCF as-a-Service, each disk consumes storage in a Virtual Datacentre (vDC) organization. There is no associated Thin or Thick setting for a tenant. > > +> **Can I use my existing Windows Server licenses in Public VCF as-a-Service?** +> > It depends on the type of license you own: +> > +> > - **Software Subscription licenses**: Yes, you can use these in OVHcloud Public VCF as-a-Service. +> > - **Perpetual software licenses**: No, these cannot be used in OVHcloud Public VCF as-a-Service. +> > +> > If your organization holds both types of licenses, only the subscription ones are eligible for use within the solution. ## Go further diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.en-au.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.en-au.md index d00ac19135e..cb05abc432e 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.en-au.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.en-au.md @@ -1,7 +1,7 @@ --- title: "Public VCF as-a-Service - FAQ" excerpt: "Find the most frequently asked questions about Public VCF as-a-Service" -updated: 2024-10-23 +updated: 2025-09-30 --- ## FAQ @@ -48,6 +48,13 @@ updated: 2024-10-23 > **Can I choose the Thin or Thick disk type with Public VCF as-a-Service when I create a new virtual machine or disk**? > > No. With Public VCF as-a-Service, each disk consumes storage in a Virtual Datacentre (vDC) organization. There is no associated Thin or Thick setting for a tenant. > > +> **Can I use my existing Windows Server licenses in Public VCF as-a-Service?** +> > It depends on the type of license you own: +> > +> > - **Software Subscription licenses**: Yes, you can use these in OVHcloud Public VCF as-a-Service. +> > - **Perpetual software licenses**: No, these cannot be used in OVHcloud Public VCF as-a-Service. +> > +> > If your organization holds both types of licenses, only the subscription ones are eligible for use within the solution. ## Go further diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.en-ca.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.en-ca.md index d00ac19135e..cb05abc432e 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.en-ca.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.en-ca.md @@ -1,7 +1,7 @@ --- title: "Public VCF as-a-Service - FAQ" excerpt: "Find the most frequently asked questions about Public VCF as-a-Service" -updated: 2024-10-23 +updated: 2025-09-30 --- ## FAQ @@ -48,6 +48,13 @@ updated: 2024-10-23 > **Can I choose the Thin or Thick disk type with Public VCF as-a-Service when I create a new virtual machine or disk**? > > No. With Public VCF as-a-Service, each disk consumes storage in a Virtual Datacentre (vDC) organization. There is no associated Thin or Thick setting for a tenant. > > +> **Can I use my existing Windows Server licenses in Public VCF as-a-Service?** +> > It depends on the type of license you own: +> > +> > - **Software Subscription licenses**: Yes, you can use these in OVHcloud Public VCF as-a-Service. +> > - **Perpetual software licenses**: No, these cannot be used in OVHcloud Public VCF as-a-Service. +> > +> > If your organization holds both types of licenses, only the subscription ones are eligible for use within the solution. ## Go further diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.en-gb.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.en-gb.md index 02f4a5937e3..12b31e0991e 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.en-gb.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.en-gb.md @@ -1,7 +1,7 @@ --- title: "Public VCF as-a-Service - FAQ" excerpt: "Find the most frequently asked questions about Public VCF as-a-Service" -updated: 2024-10-23 +updated: 2025-09-30 --- ## FAQ @@ -48,6 +48,13 @@ updated: 2024-10-23 > **Can I choose the Thin or Thick disk type with Public VCF as-a-Service when I create a new virtual machine or disk**? > > No. With Public VCF as-a-Service, each disk consumes storage in a Virtual Datacentre (vDC) organization. There is no associated Thin or Thick setting for a tenant. > > +> **Can I use my existing Windows Server licenses in Public VCF as-a-Service?** +> > It depends on the type of license you own: +> > +> > - **Software Subscription licenses**: Yes, you can use these in OVHcloud Public VCF as-a-Service. +> > - **Perpetual software licenses**: No, these cannot be used in OVHcloud Public VCF as-a-Service. +> > +> > If your organization holds both types of licenses, only the subscription ones are eligible for use within the solution. ## Go further diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.en-ie.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.en-ie.md index d00ac19135e..cb05abc432e 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.en-ie.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.en-ie.md @@ -1,7 +1,7 @@ --- title: "Public VCF as-a-Service - FAQ" excerpt: "Find the most frequently asked questions about Public VCF as-a-Service" -updated: 2024-10-23 +updated: 2025-09-30 --- ## FAQ @@ -48,6 +48,13 @@ updated: 2024-10-23 > **Can I choose the Thin or Thick disk type with Public VCF as-a-Service when I create a new virtual machine or disk**? > > No. With Public VCF as-a-Service, each disk consumes storage in a Virtual Datacentre (vDC) organization. There is no associated Thin or Thick setting for a tenant. > > +> **Can I use my existing Windows Server licenses in Public VCF as-a-Service?** +> > It depends on the type of license you own: +> > +> > - **Software Subscription licenses**: Yes, you can use these in OVHcloud Public VCF as-a-Service. +> > - **Perpetual software licenses**: No, these cannot be used in OVHcloud Public VCF as-a-Service. +> > +> > If your organization holds both types of licenses, only the subscription ones are eligible for use within the solution. ## Go further diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.en-sg.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.en-sg.md index d00ac19135e..cb05abc432e 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.en-sg.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.en-sg.md @@ -1,7 +1,7 @@ --- title: "Public VCF as-a-Service - FAQ" excerpt: "Find the most frequently asked questions about Public VCF as-a-Service" -updated: 2024-10-23 +updated: 2025-09-30 --- ## FAQ @@ -48,6 +48,13 @@ updated: 2024-10-23 > **Can I choose the Thin or Thick disk type with Public VCF as-a-Service when I create a new virtual machine or disk**? > > No. With Public VCF as-a-Service, each disk consumes storage in a Virtual Datacentre (vDC) organization. There is no associated Thin or Thick setting for a tenant. > > +> **Can I use my existing Windows Server licenses in Public VCF as-a-Service?** +> > It depends on the type of license you own: +> > +> > - **Software Subscription licenses**: Yes, you can use these in OVHcloud Public VCF as-a-Service. +> > - **Perpetual software licenses**: No, these cannot be used in OVHcloud Public VCF as-a-Service. +> > +> > If your organization holds both types of licenses, only the subscription ones are eligible for use within the solution. ## Go further diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.en-us.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.en-us.md index d00ac19135e..cb05abc432e 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.en-us.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.en-us.md @@ -1,7 +1,7 @@ --- title: "Public VCF as-a-Service - FAQ" excerpt: "Find the most frequently asked questions about Public VCF as-a-Service" -updated: 2024-10-23 +updated: 2025-09-30 --- ## FAQ @@ -48,6 +48,13 @@ updated: 2024-10-23 > **Can I choose the Thin or Thick disk type with Public VCF as-a-Service when I create a new virtual machine or disk**? > > No. With Public VCF as-a-Service, each disk consumes storage in a Virtual Datacentre (vDC) organization. There is no associated Thin or Thick setting for a tenant. > > +> **Can I use my existing Windows Server licenses in Public VCF as-a-Service?** +> > It depends on the type of license you own: +> > +> > - **Software Subscription licenses**: Yes, you can use these in OVHcloud Public VCF as-a-Service. +> > - **Perpetual software licenses**: No, these cannot be used in OVHcloud Public VCF as-a-Service. +> > +> > If your organization holds both types of licenses, only the subscription ones are eligible for use within the solution. ## Go further diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.es-es.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.es-es.md index e72283775e7..f3e0ece8c16 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.es-es.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.es-es.md @@ -1,7 +1,7 @@ --- title: "Public VCF as-a-Service - FAQ (EN)" excerpt: "Find the most frequently asked questions about Public VCF as-a-Service" -updated: 2024-10-23 +updated: 2025-09-30 --- ## FAQ @@ -48,6 +48,13 @@ updated: 2024-10-23 > **Can I choose the Thin or Thick disk type with Public VCF as-a-Service when I create a new virtual machine or disk**? > > No. With Public VCF as-a-Service, each disk consumes storage in a Virtual Datacentre (vDC) organization. There is no associated Thin or Thick setting for a tenant. > > +> **Can I use my existing Windows Server licenses in Public VCF as-a-Service?** +> > It depends on the type of license you own: +> > +> > - **Software Subscription licenses**: Yes, you can use these in OVHcloud Public VCF as-a-Service. +> > - **Perpetual software licenses**: No, these cannot be used in OVHcloud Public VCF as-a-Service. +> > +> > If your organization holds both types of licenses, only the subscription ones are eligible for use within the solution. ## Go further diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.es-us.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.es-us.md index e72283775e7..f3e0ece8c16 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.es-us.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.es-us.md @@ -1,7 +1,7 @@ --- title: "Public VCF as-a-Service - FAQ (EN)" excerpt: "Find the most frequently asked questions about Public VCF as-a-Service" -updated: 2024-10-23 +updated: 2025-09-30 --- ## FAQ @@ -48,6 +48,13 @@ updated: 2024-10-23 > **Can I choose the Thin or Thick disk type with Public VCF as-a-Service when I create a new virtual machine or disk**? > > No. With Public VCF as-a-Service, each disk consumes storage in a Virtual Datacentre (vDC) organization. There is no associated Thin or Thick setting for a tenant. > > +> **Can I use my existing Windows Server licenses in Public VCF as-a-Service?** +> > It depends on the type of license you own: +> > +> > - **Software Subscription licenses**: Yes, you can use these in OVHcloud Public VCF as-a-Service. +> > - **Perpetual software licenses**: No, these cannot be used in OVHcloud Public VCF as-a-Service. +> > +> > If your organization holds both types of licenses, only the subscription ones are eligible for use within the solution. ## Go further diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.fr-ca.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.fr-ca.md index e8c9b6ac41b..b5ba3cec033 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.fr-ca.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.fr-ca.md @@ -1,7 +1,7 @@ --- title: "Public VCF as-a-Service - FAQ" excerpt: "Retrouvez les questions les plus fréquentes concernant Public VCF as-a-Service" -updated: 2024-10-07 +updated: 2025-09-30 --- ## FAQ @@ -48,6 +48,13 @@ updated: 2024-10-07 > **Puis-je choisir avec Public VCF as-a-Service le type de disque Thin ou Thick lorsque je crée une nouvelle machine virtuelle ou un nouveau disque** ? > > Non. Avec Public VCF as-a-Service, chaque disque consomme du stockage dans une organisation Virtual Datacenter (VDC). Il n'existe aucun réglage de type Thin ou Thick associé pour le tenant d'un client. > > +> **Puis-je utiliser mes licences Windows Server existantes dans Public VCF as-a-Service ?** +> > Cela dépend du type de licence que vous possédez : +> > +> > - **Licences Software Subscription** : Oui, vous pouvez les utiliser dans OVHcloud Public VCF as-a-Service. +> > - **Licences logicielles perpétuelles** : Non, elles ne peuvent pas être utilisées dans OVHcloud Public VCF as-a-Service. +> > +> > Si votre organisation dispose des deux types de licences, seules les licences par abonnement sont éligibles dans cette solution. ## Aller plus loin diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.fr-fr.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.fr-fr.md index 24f4f3b27fd..8604876029b 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.fr-fr.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.fr-fr.md @@ -1,7 +1,7 @@ --- title: "Public VCF as-a-Service - FAQ" excerpt: "Retrouvez les questions les plus fréquentes concernant Public VCF as-a-Service" -updated: 2024-10-07 +updated: 2025-09-30 --- ## FAQ @@ -48,6 +48,13 @@ updated: 2024-10-07 > **Puis-je choisir avec Public VCF as-a-Service le type de disque Thin ou Thick lorsque je crée une nouvelle machine virtuelle ou un nouveau disque** ? > > Non. Avec Public VCF as-a-Service, chaque disque consomme du stockage dans une organisation Virtual Datacenter (VDC). Il n'existe aucun réglage de type Thin ou Thick associé pour le tenant d'un client. > > +> **Puis-je utiliser mes licences Windows Server existantes dans Public VCF as-a-Service ?** +> > Cela dépend du type de licence que vous possédez : +> > +> > - **Licences Software Subscription** : Oui, vous pouvez les utiliser dans OVHcloud Public VCF as-a-Service. +> > - **Licences logicielles perpétuelles** : Non, elles ne peuvent pas être utilisées dans OVHcloud Public VCF as-a-Service. +> > +> > Si votre organisation dispose des deux types de licences, seules les licences par abonnement sont éligibles dans cette solution. ## Aller plus loin diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.it-it.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.it-it.md index e72283775e7..f3e0ece8c16 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.it-it.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.it-it.md @@ -1,7 +1,7 @@ --- title: "Public VCF as-a-Service - FAQ (EN)" excerpt: "Find the most frequently asked questions about Public VCF as-a-Service" -updated: 2024-10-23 +updated: 2025-09-30 --- ## FAQ @@ -48,6 +48,13 @@ updated: 2024-10-23 > **Can I choose the Thin or Thick disk type with Public VCF as-a-Service when I create a new virtual machine or disk**? > > No. With Public VCF as-a-Service, each disk consumes storage in a Virtual Datacentre (vDC) organization. There is no associated Thin or Thick setting for a tenant. > > +> **Can I use my existing Windows Server licenses in Public VCF as-a-Service?** +> > It depends on the type of license you own: +> > +> > - **Software Subscription licenses**: Yes, you can use these in OVHcloud Public VCF as-a-Service. +> > - **Perpetual software licenses**: No, these cannot be used in OVHcloud Public VCF as-a-Service. +> > +> > If your organization holds both types of licenses, only the subscription ones are eligible for use within the solution. ## Go further diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.pl-pl.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.pl-pl.md index e72283775e7..f3e0ece8c16 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.pl-pl.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.pl-pl.md @@ -1,7 +1,7 @@ --- title: "Public VCF as-a-Service - FAQ (EN)" excerpt: "Find the most frequently asked questions about Public VCF as-a-Service" -updated: 2024-10-23 +updated: 2025-09-30 --- ## FAQ @@ -48,6 +48,13 @@ updated: 2024-10-23 > **Can I choose the Thin or Thick disk type with Public VCF as-a-Service when I create a new virtual machine or disk**? > > No. With Public VCF as-a-Service, each disk consumes storage in a Virtual Datacentre (vDC) organization. There is no associated Thin or Thick setting for a tenant. > > +> **Can I use my existing Windows Server licenses in Public VCF as-a-Service?** +> > It depends on the type of license you own: +> > +> > - **Software Subscription licenses**: Yes, you can use these in OVHcloud Public VCF as-a-Service. +> > - **Perpetual software licenses**: No, these cannot be used in OVHcloud Public VCF as-a-Service. +> > +> > If your organization holds both types of licenses, only the subscription ones are eligible for use within the solution. ## Go further diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.pt-pt.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.pt-pt.md index e72283775e7..f3e0ece8c16 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.pt-pt.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-faq/guide.pt-pt.md @@ -1,7 +1,7 @@ --- title: "Public VCF as-a-Service - FAQ (EN)" excerpt: "Find the most frequently asked questions about Public VCF as-a-Service" -updated: 2024-10-23 +updated: 2025-09-30 --- ## FAQ @@ -48,6 +48,13 @@ updated: 2024-10-23 > **Can I choose the Thin or Thick disk type with Public VCF as-a-Service when I create a new virtual machine or disk**? > > No. With Public VCF as-a-Service, each disk consumes storage in a Virtual Datacentre (vDC) organization. There is no associated Thin or Thick setting for a tenant. > > +> **Can I use my existing Windows Server licenses in Public VCF as-a-Service?** +> > It depends on the type of license you own: +> > +> > - **Software Subscription licenses**: Yes, you can use these in OVHcloud Public VCF as-a-Service. +> > - **Perpetual software licenses**: No, these cannot be used in OVHcloud Public VCF as-a-Service. +> > +> > If your organization holds both types of licenses, only the subscription ones are eligible for use within the solution. ## Go further diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-first-vm-creation/images/vcd-custom-properties.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-first-vm-creation/images/vcd-custom-properties.png deleted file mode 100644 index 8700c1d9936..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-first-vm-creation/images/vcd-custom-properties.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-first-vm-creation/images/vcd-vm-clone_vApp.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-first-vm-creation/images/vcd-vm-clone_vApp.png deleted file mode 100644 index 87bc3ab258c..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-first-vm-creation/images/vcd-vm-clone_vApp.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.de-de.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.de-de.md index 27cf4f539e2..6e1e7ce64c9 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.de-de.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.de-de.md @@ -1,7 +1,7 @@ --- title: "Public VCF as-a-Service - The fundamentals of Public VCF as-a-Service" excerpt: "Discover the basic concepts of Public VCF as-a-Service" -updated: 2024-12-19 +updated: 2025-11-04 --- ## Objective @@ -62,11 +62,10 @@ In addition, organization administrators have the ability to copy items from pub Below is a comparison of the features provided by OVHcloud on its 3 Public VCF as-a-Service solutions. -| | Advanced Network & Security | vSAN Storage | -|:------------:|:---------------------------:|:------------:| -|Public VCF as-a-Service Standard | - | - | -|Public VCF as-a-Service Advanced | ✅ | - | -|Public VCF as-a-Service Premium | ✅ | ✅ | +| | Advanced Network & Security | vSAN Storage | +|:---:|:---:|:---:| +|Public VCF as-a-Service Standard | — | — | +|Public VCF as-a-Service Advanced | ✅ | — | #### Cluster Management @@ -75,7 +74,7 @@ Below is a comparison of the features provided by OVHcloud on its 3 Public VCF a > | Features | -| :-: | +|:---:| | ESXi management / capacity planning | | Hosts Failover / Proactive HA | | DRS / Storage DRS | @@ -83,65 +82,64 @@ Below is a comparison of the features provided by OVHcloud on its 3 Public VCF a ##### Virtual Machine Management -| Features | Standard | Advanced | Premium | Comments | -|:-----------------------: |:--------: |:--------: |:-------: |:-----------------------------------------------------------------------------: | -| Create VM | ✅ | ✅ | ✅ | | -| Manage Virtual Machines | ✅ | ✅ | ✅ | Start, Stop, Suspend, Delete, Copy/clone... | -| Affinity Rules | ✅ | ✅ | ✅ | | -| Anti-Affinity Rules | ✅ | ✅ | ✅ | | -| VMware Marketplace | ✅ | ✅ | ✅ | Allowed to deploy VMs with pre-packaged software solutions | -| Create VM catalogs | ✅ | ✅ | ✅ | Build your own catalog of VM templates | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Create VM | ✅ | ✅ | | +| Manage Virtual Machines | ✅ | ✅ | Start, Stop, Suspend, Delete, Copy/clone... | +| Affinity Rules | ✅ | ✅ | | +| Anti-Affinity Rules | ✅ | ✅ | | +| VMware Marketplace | ✅ | ✅ | Allowed to deploy VMs with pre-packaged software solutions | +| Create VM catalogs | ✅ | ✅ | Build your own catalog of VM templates | #### Organisation / Virtual Datacenter Management -| Features | Standard | Advanced | Premium | Comments | -|:-----------------------------------: |:--------: |:--------: |:-------: |:-------------------------------------------------------------------------------------------------------: | -| User Management | ✅ | ✅ | ✅ | Manage users in a Public VCF as-a-Service | -| Identity Provider Integration - SSO | | | | In Roadmap (via OVHcloud uIAM service) | -| vCPU over-allocation | | | | In Roadmap - Allow users to adjust the quantity of vCPU/GHz for a virtual DC Possible through **OVH manager or API** | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| User Management | ✅ | ✅ | Manage users in a Public VCF as-a-Service | +| Identity Provider Integration - SSO | ⏳ | ⏳ | In Roadmap (via OVHcloud uIAM service) | +| vCPU over-allocation | ⏳ | ⏳ | In Roadmap - Allow users to adjust the quantity of vCPU/GHz for a virtual DC Possible through **OVH manager or API** | #### Networking -| Features | Standard | Advanced | Premium | Comments | -|--------------------------------- |---------- |---------- |--------- |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Routing & Switching IPv4 | | ✅ | ✅ | Network segments, distributed & non distributed routing, Routed Network with/without NAT BGP/ DHCP/ DNS/ Static routes Cross virtual DC Networking on the same site. Not supported: OSPF, VRF Lite | -| Public IPv4 Range | ✅ | ✅ | ✅ | | -| Private Network - vRack support | ✅ | ✅ | ✅ | in Roadmap | -| Routing & Switching IPv6 | | | | in Roadmap | -| VPN | | ✅ | ✅ | L2VPN, VPN IPsec Policy Based Not Supported : SSL VPN, Routed based IPsec VPN | -| Load Balancing | | | | Not supported with native Public VCF as-a-Service network capabilities | -| Advanced Load Balancing | | | | in Roadmap | +| Features | Standard | Advanced| Comments | +|:---:|:---:|:---:|:---:| +| Routing & Switching IPv4 | — | ✅ | Network segments, distributed & non distributed routing, Routed Network with/without NAT BGP/ DHCP/ DNS/ Static routes Cross virtual DC Networking on the same site. Not supported: OSPF, VRF Lite | +| Public IPv4 Range | ✅ | ✅ | | +| Private Network - vRack support | ✅ | ✅ | in Roadmap | +| Routing & Switching IPv6 | — | ⏳ | in Roadmap | +| VPN | — | ✅ | L2VPN, VPN IPsec Policy Based Not Supported: SSL VPN, Routed based IPsec VPN | +| Load Balancing | — | — | Not supported with native Public VCF as-a-Service network capabilities | +| Advanced Load Balancing | — | ⏳ | in Roadmap | #### Security -| Features | Standard | Advanced | Premium | Comments | -|:--------------------: |:--------: |:--------: |:-------: |:----------: | -| Stateful Firewall | | ✅ | ✅ | | -| Distributed Firewall | | ✅ | ✅ | | -| Security groups | | ✅ | ✅ | | -| IDS / IPS | | | | in Roadmap | -| WAF | | | | in Roadmap | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Stateful Firewall | — | ✅ | | +| Distributed Firewall | — | ✅ | | +| Security groups | — | ✅ | | +| IDS / IPS | — | ⏳ | in Roadmap | +| WAF | — | ⏳ | in Roadmap | #### Data protection -| Features | Standard | Advanced | Premium | Comments | -|:----------------------------: |:--------: |:--------: |:-------: |:---------------------------: | -| Backup as a Service | ✅ | ✅ | ✅ | Veeam Managed Backup Option | -| Virtual Machine Snapshots | ✅ | ✅ | ✅ | 1 per VM | -| Protection / Replication VMs | | | | in Roadmap | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Backup as a Service | ✅ | ✅ | Veeam Managed Backup Option | +| Virtual Machine Snapshots | ✅ | ✅ | 1 per VM | +| Protection / Replication VMs | ⏳ | ⏳ | in Roadmap | #### Storage -| Features | Standard | Advanced | Premium | Comments | -|:---------------------------------: |:--------: |:--------: |:-------: |:--------: | -| NFS datastore | ✅ | ✅ | ✅ | | -| High performance datastore (vSAN) | | | ✅ | | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| NFS datastore | ✅ | ✅ | | #### Monitoring -| Features | Standard | Advanced | Premium | Comments | -|:---------------: |:--------: |:--------: |:-------: |:-------------------------------------------------: | -| Aria operations | | | | In Roadmap - Resource management Metrics, Dashboard, Reporting | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Aria operations | ⏳ | ⏳ | In Roadmap - Resource management Metrics, Dashboard, Reporting | ## Go further diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.en-asia.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.en-asia.md index 27cf4f539e2..6e1e7ce64c9 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.en-asia.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.en-asia.md @@ -1,7 +1,7 @@ --- title: "Public VCF as-a-Service - The fundamentals of Public VCF as-a-Service" excerpt: "Discover the basic concepts of Public VCF as-a-Service" -updated: 2024-12-19 +updated: 2025-11-04 --- ## Objective @@ -62,11 +62,10 @@ In addition, organization administrators have the ability to copy items from pub Below is a comparison of the features provided by OVHcloud on its 3 Public VCF as-a-Service solutions. -| | Advanced Network & Security | vSAN Storage | -|:------------:|:---------------------------:|:------------:| -|Public VCF as-a-Service Standard | - | - | -|Public VCF as-a-Service Advanced | ✅ | - | -|Public VCF as-a-Service Premium | ✅ | ✅ | +| | Advanced Network & Security | vSAN Storage | +|:---:|:---:|:---:| +|Public VCF as-a-Service Standard | — | — | +|Public VCF as-a-Service Advanced | ✅ | — | #### Cluster Management @@ -75,7 +74,7 @@ Below is a comparison of the features provided by OVHcloud on its 3 Public VCF a > | Features | -| :-: | +|:---:| | ESXi management / capacity planning | | Hosts Failover / Proactive HA | | DRS / Storage DRS | @@ -83,65 +82,64 @@ Below is a comparison of the features provided by OVHcloud on its 3 Public VCF a ##### Virtual Machine Management -| Features | Standard | Advanced | Premium | Comments | -|:-----------------------: |:--------: |:--------: |:-------: |:-----------------------------------------------------------------------------: | -| Create VM | ✅ | ✅ | ✅ | | -| Manage Virtual Machines | ✅ | ✅ | ✅ | Start, Stop, Suspend, Delete, Copy/clone... | -| Affinity Rules | ✅ | ✅ | ✅ | | -| Anti-Affinity Rules | ✅ | ✅ | ✅ | | -| VMware Marketplace | ✅ | ✅ | ✅ | Allowed to deploy VMs with pre-packaged software solutions | -| Create VM catalogs | ✅ | ✅ | ✅ | Build your own catalog of VM templates | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Create VM | ✅ | ✅ | | +| Manage Virtual Machines | ✅ | ✅ | Start, Stop, Suspend, Delete, Copy/clone... | +| Affinity Rules | ✅ | ✅ | | +| Anti-Affinity Rules | ✅ | ✅ | | +| VMware Marketplace | ✅ | ✅ | Allowed to deploy VMs with pre-packaged software solutions | +| Create VM catalogs | ✅ | ✅ | Build your own catalog of VM templates | #### Organisation / Virtual Datacenter Management -| Features | Standard | Advanced | Premium | Comments | -|:-----------------------------------: |:--------: |:--------: |:-------: |:-------------------------------------------------------------------------------------------------------: | -| User Management | ✅ | ✅ | ✅ | Manage users in a Public VCF as-a-Service | -| Identity Provider Integration - SSO | | | | In Roadmap (via OVHcloud uIAM service) | -| vCPU over-allocation | | | | In Roadmap - Allow users to adjust the quantity of vCPU/GHz for a virtual DC Possible through **OVH manager or API** | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| User Management | ✅ | ✅ | Manage users in a Public VCF as-a-Service | +| Identity Provider Integration - SSO | ⏳ | ⏳ | In Roadmap (via OVHcloud uIAM service) | +| vCPU over-allocation | ⏳ | ⏳ | In Roadmap - Allow users to adjust the quantity of vCPU/GHz for a virtual DC Possible through **OVH manager or API** | #### Networking -| Features | Standard | Advanced | Premium | Comments | -|--------------------------------- |---------- |---------- |--------- |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Routing & Switching IPv4 | | ✅ | ✅ | Network segments, distributed & non distributed routing, Routed Network with/without NAT BGP/ DHCP/ DNS/ Static routes Cross virtual DC Networking on the same site. Not supported: OSPF, VRF Lite | -| Public IPv4 Range | ✅ | ✅ | ✅ | | -| Private Network - vRack support | ✅ | ✅ | ✅ | in Roadmap | -| Routing & Switching IPv6 | | | | in Roadmap | -| VPN | | ✅ | ✅ | L2VPN, VPN IPsec Policy Based Not Supported : SSL VPN, Routed based IPsec VPN | -| Load Balancing | | | | Not supported with native Public VCF as-a-Service network capabilities | -| Advanced Load Balancing | | | | in Roadmap | +| Features | Standard | Advanced| Comments | +|:---:|:---:|:---:|:---:| +| Routing & Switching IPv4 | — | ✅ | Network segments, distributed & non distributed routing, Routed Network with/without NAT BGP/ DHCP/ DNS/ Static routes Cross virtual DC Networking on the same site. Not supported: OSPF, VRF Lite | +| Public IPv4 Range | ✅ | ✅ | | +| Private Network - vRack support | ✅ | ✅ | in Roadmap | +| Routing & Switching IPv6 | — | ⏳ | in Roadmap | +| VPN | — | ✅ | L2VPN, VPN IPsec Policy Based Not Supported: SSL VPN, Routed based IPsec VPN | +| Load Balancing | — | — | Not supported with native Public VCF as-a-Service network capabilities | +| Advanced Load Balancing | — | ⏳ | in Roadmap | #### Security -| Features | Standard | Advanced | Premium | Comments | -|:--------------------: |:--------: |:--------: |:-------: |:----------: | -| Stateful Firewall | | ✅ | ✅ | | -| Distributed Firewall | | ✅ | ✅ | | -| Security groups | | ✅ | ✅ | | -| IDS / IPS | | | | in Roadmap | -| WAF | | | | in Roadmap | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Stateful Firewall | — | ✅ | | +| Distributed Firewall | — | ✅ | | +| Security groups | — | ✅ | | +| IDS / IPS | — | ⏳ | in Roadmap | +| WAF | — | ⏳ | in Roadmap | #### Data protection -| Features | Standard | Advanced | Premium | Comments | -|:----------------------------: |:--------: |:--------: |:-------: |:---------------------------: | -| Backup as a Service | ✅ | ✅ | ✅ | Veeam Managed Backup Option | -| Virtual Machine Snapshots | ✅ | ✅ | ✅ | 1 per VM | -| Protection / Replication VMs | | | | in Roadmap | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Backup as a Service | ✅ | ✅ | Veeam Managed Backup Option | +| Virtual Machine Snapshots | ✅ | ✅ | 1 per VM | +| Protection / Replication VMs | ⏳ | ⏳ | in Roadmap | #### Storage -| Features | Standard | Advanced | Premium | Comments | -|:---------------------------------: |:--------: |:--------: |:-------: |:--------: | -| NFS datastore | ✅ | ✅ | ✅ | | -| High performance datastore (vSAN) | | | ✅ | | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| NFS datastore | ✅ | ✅ | | #### Monitoring -| Features | Standard | Advanced | Premium | Comments | -|:---------------: |:--------: |:--------: |:-------: |:-------------------------------------------------: | -| Aria operations | | | | In Roadmap - Resource management Metrics, Dashboard, Reporting | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Aria operations | ⏳ | ⏳ | In Roadmap - Resource management Metrics, Dashboard, Reporting | ## Go further diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.en-au.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.en-au.md index 27cf4f539e2..6e1e7ce64c9 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.en-au.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.en-au.md @@ -1,7 +1,7 @@ --- title: "Public VCF as-a-Service - The fundamentals of Public VCF as-a-Service" excerpt: "Discover the basic concepts of Public VCF as-a-Service" -updated: 2024-12-19 +updated: 2025-11-04 --- ## Objective @@ -62,11 +62,10 @@ In addition, organization administrators have the ability to copy items from pub Below is a comparison of the features provided by OVHcloud on its 3 Public VCF as-a-Service solutions. -| | Advanced Network & Security | vSAN Storage | -|:------------:|:---------------------------:|:------------:| -|Public VCF as-a-Service Standard | - | - | -|Public VCF as-a-Service Advanced | ✅ | - | -|Public VCF as-a-Service Premium | ✅ | ✅ | +| | Advanced Network & Security | vSAN Storage | +|:---:|:---:|:---:| +|Public VCF as-a-Service Standard | — | — | +|Public VCF as-a-Service Advanced | ✅ | — | #### Cluster Management @@ -75,7 +74,7 @@ Below is a comparison of the features provided by OVHcloud on its 3 Public VCF a > | Features | -| :-: | +|:---:| | ESXi management / capacity planning | | Hosts Failover / Proactive HA | | DRS / Storage DRS | @@ -83,65 +82,64 @@ Below is a comparison of the features provided by OVHcloud on its 3 Public VCF a ##### Virtual Machine Management -| Features | Standard | Advanced | Premium | Comments | -|:-----------------------: |:--------: |:--------: |:-------: |:-----------------------------------------------------------------------------: | -| Create VM | ✅ | ✅ | ✅ | | -| Manage Virtual Machines | ✅ | ✅ | ✅ | Start, Stop, Suspend, Delete, Copy/clone... | -| Affinity Rules | ✅ | ✅ | ✅ | | -| Anti-Affinity Rules | ✅ | ✅ | ✅ | | -| VMware Marketplace | ✅ | ✅ | ✅ | Allowed to deploy VMs with pre-packaged software solutions | -| Create VM catalogs | ✅ | ✅ | ✅ | Build your own catalog of VM templates | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Create VM | ✅ | ✅ | | +| Manage Virtual Machines | ✅ | ✅ | Start, Stop, Suspend, Delete, Copy/clone... | +| Affinity Rules | ✅ | ✅ | | +| Anti-Affinity Rules | ✅ | ✅ | | +| VMware Marketplace | ✅ | ✅ | Allowed to deploy VMs with pre-packaged software solutions | +| Create VM catalogs | ✅ | ✅ | Build your own catalog of VM templates | #### Organisation / Virtual Datacenter Management -| Features | Standard | Advanced | Premium | Comments | -|:-----------------------------------: |:--------: |:--------: |:-------: |:-------------------------------------------------------------------------------------------------------: | -| User Management | ✅ | ✅ | ✅ | Manage users in a Public VCF as-a-Service | -| Identity Provider Integration - SSO | | | | In Roadmap (via OVHcloud uIAM service) | -| vCPU over-allocation | | | | In Roadmap - Allow users to adjust the quantity of vCPU/GHz for a virtual DC Possible through **OVH manager or API** | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| User Management | ✅ | ✅ | Manage users in a Public VCF as-a-Service | +| Identity Provider Integration - SSO | ⏳ | ⏳ | In Roadmap (via OVHcloud uIAM service) | +| vCPU over-allocation | ⏳ | ⏳ | In Roadmap - Allow users to adjust the quantity of vCPU/GHz for a virtual DC Possible through **OVH manager or API** | #### Networking -| Features | Standard | Advanced | Premium | Comments | -|--------------------------------- |---------- |---------- |--------- |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Routing & Switching IPv4 | | ✅ | ✅ | Network segments, distributed & non distributed routing, Routed Network with/without NAT BGP/ DHCP/ DNS/ Static routes Cross virtual DC Networking on the same site. Not supported: OSPF, VRF Lite | -| Public IPv4 Range | ✅ | ✅ | ✅ | | -| Private Network - vRack support | ✅ | ✅ | ✅ | in Roadmap | -| Routing & Switching IPv6 | | | | in Roadmap | -| VPN | | ✅ | ✅ | L2VPN, VPN IPsec Policy Based Not Supported : SSL VPN, Routed based IPsec VPN | -| Load Balancing | | | | Not supported with native Public VCF as-a-Service network capabilities | -| Advanced Load Balancing | | | | in Roadmap | +| Features | Standard | Advanced| Comments | +|:---:|:---:|:---:|:---:| +| Routing & Switching IPv4 | — | ✅ | Network segments, distributed & non distributed routing, Routed Network with/without NAT BGP/ DHCP/ DNS/ Static routes Cross virtual DC Networking on the same site. Not supported: OSPF, VRF Lite | +| Public IPv4 Range | ✅ | ✅ | | +| Private Network - vRack support | ✅ | ✅ | in Roadmap | +| Routing & Switching IPv6 | — | ⏳ | in Roadmap | +| VPN | — | ✅ | L2VPN, VPN IPsec Policy Based Not Supported: SSL VPN, Routed based IPsec VPN | +| Load Balancing | — | — | Not supported with native Public VCF as-a-Service network capabilities | +| Advanced Load Balancing | — | ⏳ | in Roadmap | #### Security -| Features | Standard | Advanced | Premium | Comments | -|:--------------------: |:--------: |:--------: |:-------: |:----------: | -| Stateful Firewall | | ✅ | ✅ | | -| Distributed Firewall | | ✅ | ✅ | | -| Security groups | | ✅ | ✅ | | -| IDS / IPS | | | | in Roadmap | -| WAF | | | | in Roadmap | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Stateful Firewall | — | ✅ | | +| Distributed Firewall | — | ✅ | | +| Security groups | — | ✅ | | +| IDS / IPS | — | ⏳ | in Roadmap | +| WAF | — | ⏳ | in Roadmap | #### Data protection -| Features | Standard | Advanced | Premium | Comments | -|:----------------------------: |:--------: |:--------: |:-------: |:---------------------------: | -| Backup as a Service | ✅ | ✅ | ✅ | Veeam Managed Backup Option | -| Virtual Machine Snapshots | ✅ | ✅ | ✅ | 1 per VM | -| Protection / Replication VMs | | | | in Roadmap | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Backup as a Service | ✅ | ✅ | Veeam Managed Backup Option | +| Virtual Machine Snapshots | ✅ | ✅ | 1 per VM | +| Protection / Replication VMs | ⏳ | ⏳ | in Roadmap | #### Storage -| Features | Standard | Advanced | Premium | Comments | -|:---------------------------------: |:--------: |:--------: |:-------: |:--------: | -| NFS datastore | ✅ | ✅ | ✅ | | -| High performance datastore (vSAN) | | | ✅ | | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| NFS datastore | ✅ | ✅ | | #### Monitoring -| Features | Standard | Advanced | Premium | Comments | -|:---------------: |:--------: |:--------: |:-------: |:-------------------------------------------------: | -| Aria operations | | | | In Roadmap - Resource management Metrics, Dashboard, Reporting | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Aria operations | ⏳ | ⏳ | In Roadmap - Resource management Metrics, Dashboard, Reporting | ## Go further diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.en-ca.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.en-ca.md index 27cf4f539e2..6e1e7ce64c9 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.en-ca.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.en-ca.md @@ -1,7 +1,7 @@ --- title: "Public VCF as-a-Service - The fundamentals of Public VCF as-a-Service" excerpt: "Discover the basic concepts of Public VCF as-a-Service" -updated: 2024-12-19 +updated: 2025-11-04 --- ## Objective @@ -62,11 +62,10 @@ In addition, organization administrators have the ability to copy items from pub Below is a comparison of the features provided by OVHcloud on its 3 Public VCF as-a-Service solutions. -| | Advanced Network & Security | vSAN Storage | -|:------------:|:---------------------------:|:------------:| -|Public VCF as-a-Service Standard | - | - | -|Public VCF as-a-Service Advanced | ✅ | - | -|Public VCF as-a-Service Premium | ✅ | ✅ | +| | Advanced Network & Security | vSAN Storage | +|:---:|:---:|:---:| +|Public VCF as-a-Service Standard | — | — | +|Public VCF as-a-Service Advanced | ✅ | — | #### Cluster Management @@ -75,7 +74,7 @@ Below is a comparison of the features provided by OVHcloud on its 3 Public VCF a > | Features | -| :-: | +|:---:| | ESXi management / capacity planning | | Hosts Failover / Proactive HA | | DRS / Storage DRS | @@ -83,65 +82,64 @@ Below is a comparison of the features provided by OVHcloud on its 3 Public VCF a ##### Virtual Machine Management -| Features | Standard | Advanced | Premium | Comments | -|:-----------------------: |:--------: |:--------: |:-------: |:-----------------------------------------------------------------------------: | -| Create VM | ✅ | ✅ | ✅ | | -| Manage Virtual Machines | ✅ | ✅ | ✅ | Start, Stop, Suspend, Delete, Copy/clone... | -| Affinity Rules | ✅ | ✅ | ✅ | | -| Anti-Affinity Rules | ✅ | ✅ | ✅ | | -| VMware Marketplace | ✅ | ✅ | ✅ | Allowed to deploy VMs with pre-packaged software solutions | -| Create VM catalogs | ✅ | ✅ | ✅ | Build your own catalog of VM templates | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Create VM | ✅ | ✅ | | +| Manage Virtual Machines | ✅ | ✅ | Start, Stop, Suspend, Delete, Copy/clone... | +| Affinity Rules | ✅ | ✅ | | +| Anti-Affinity Rules | ✅ | ✅ | | +| VMware Marketplace | ✅ | ✅ | Allowed to deploy VMs with pre-packaged software solutions | +| Create VM catalogs | ✅ | ✅ | Build your own catalog of VM templates | #### Organisation / Virtual Datacenter Management -| Features | Standard | Advanced | Premium | Comments | -|:-----------------------------------: |:--------: |:--------: |:-------: |:-------------------------------------------------------------------------------------------------------: | -| User Management | ✅ | ✅ | ✅ | Manage users in a Public VCF as-a-Service | -| Identity Provider Integration - SSO | | | | In Roadmap (via OVHcloud uIAM service) | -| vCPU over-allocation | | | | In Roadmap - Allow users to adjust the quantity of vCPU/GHz for a virtual DC Possible through **OVH manager or API** | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| User Management | ✅ | ✅ | Manage users in a Public VCF as-a-Service | +| Identity Provider Integration - SSO | ⏳ | ⏳ | In Roadmap (via OVHcloud uIAM service) | +| vCPU over-allocation | ⏳ | ⏳ | In Roadmap - Allow users to adjust the quantity of vCPU/GHz for a virtual DC Possible through **OVH manager or API** | #### Networking -| Features | Standard | Advanced | Premium | Comments | -|--------------------------------- |---------- |---------- |--------- |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Routing & Switching IPv4 | | ✅ | ✅ | Network segments, distributed & non distributed routing, Routed Network with/without NAT BGP/ DHCP/ DNS/ Static routes Cross virtual DC Networking on the same site. Not supported: OSPF, VRF Lite | -| Public IPv4 Range | ✅ | ✅ | ✅ | | -| Private Network - vRack support | ✅ | ✅ | ✅ | in Roadmap | -| Routing & Switching IPv6 | | | | in Roadmap | -| VPN | | ✅ | ✅ | L2VPN, VPN IPsec Policy Based Not Supported : SSL VPN, Routed based IPsec VPN | -| Load Balancing | | | | Not supported with native Public VCF as-a-Service network capabilities | -| Advanced Load Balancing | | | | in Roadmap | +| Features | Standard | Advanced| Comments | +|:---:|:---:|:---:|:---:| +| Routing & Switching IPv4 | — | ✅ | Network segments, distributed & non distributed routing, Routed Network with/without NAT BGP/ DHCP/ DNS/ Static routes Cross virtual DC Networking on the same site. Not supported: OSPF, VRF Lite | +| Public IPv4 Range | ✅ | ✅ | | +| Private Network - vRack support | ✅ | ✅ | in Roadmap | +| Routing & Switching IPv6 | — | ⏳ | in Roadmap | +| VPN | — | ✅ | L2VPN, VPN IPsec Policy Based Not Supported: SSL VPN, Routed based IPsec VPN | +| Load Balancing | — | — | Not supported with native Public VCF as-a-Service network capabilities | +| Advanced Load Balancing | — | ⏳ | in Roadmap | #### Security -| Features | Standard | Advanced | Premium | Comments | -|:--------------------: |:--------: |:--------: |:-------: |:----------: | -| Stateful Firewall | | ✅ | ✅ | | -| Distributed Firewall | | ✅ | ✅ | | -| Security groups | | ✅ | ✅ | | -| IDS / IPS | | | | in Roadmap | -| WAF | | | | in Roadmap | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Stateful Firewall | — | ✅ | | +| Distributed Firewall | — | ✅ | | +| Security groups | — | ✅ | | +| IDS / IPS | — | ⏳ | in Roadmap | +| WAF | — | ⏳ | in Roadmap | #### Data protection -| Features | Standard | Advanced | Premium | Comments | -|:----------------------------: |:--------: |:--------: |:-------: |:---------------------------: | -| Backup as a Service | ✅ | ✅ | ✅ | Veeam Managed Backup Option | -| Virtual Machine Snapshots | ✅ | ✅ | ✅ | 1 per VM | -| Protection / Replication VMs | | | | in Roadmap | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Backup as a Service | ✅ | ✅ | Veeam Managed Backup Option | +| Virtual Machine Snapshots | ✅ | ✅ | 1 per VM | +| Protection / Replication VMs | ⏳ | ⏳ | in Roadmap | #### Storage -| Features | Standard | Advanced | Premium | Comments | -|:---------------------------------: |:--------: |:--------: |:-------: |:--------: | -| NFS datastore | ✅ | ✅ | ✅ | | -| High performance datastore (vSAN) | | | ✅ | | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| NFS datastore | ✅ | ✅ | | #### Monitoring -| Features | Standard | Advanced | Premium | Comments | -|:---------------: |:--------: |:--------: |:-------: |:-------------------------------------------------: | -| Aria operations | | | | In Roadmap - Resource management Metrics, Dashboard, Reporting | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Aria operations | ⏳ | ⏳ | In Roadmap - Resource management Metrics, Dashboard, Reporting | ## Go further diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.en-gb.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.en-gb.md index 27cf4f539e2..6e1e7ce64c9 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.en-gb.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.en-gb.md @@ -1,7 +1,7 @@ --- title: "Public VCF as-a-Service - The fundamentals of Public VCF as-a-Service" excerpt: "Discover the basic concepts of Public VCF as-a-Service" -updated: 2024-12-19 +updated: 2025-11-04 --- ## Objective @@ -62,11 +62,10 @@ In addition, organization administrators have the ability to copy items from pub Below is a comparison of the features provided by OVHcloud on its 3 Public VCF as-a-Service solutions. -| | Advanced Network & Security | vSAN Storage | -|:------------:|:---------------------------:|:------------:| -|Public VCF as-a-Service Standard | - | - | -|Public VCF as-a-Service Advanced | ✅ | - | -|Public VCF as-a-Service Premium | ✅ | ✅ | +| | Advanced Network & Security | vSAN Storage | +|:---:|:---:|:---:| +|Public VCF as-a-Service Standard | — | — | +|Public VCF as-a-Service Advanced | ✅ | — | #### Cluster Management @@ -75,7 +74,7 @@ Below is a comparison of the features provided by OVHcloud on its 3 Public VCF a > | Features | -| :-: | +|:---:| | ESXi management / capacity planning | | Hosts Failover / Proactive HA | | DRS / Storage DRS | @@ -83,65 +82,64 @@ Below is a comparison of the features provided by OVHcloud on its 3 Public VCF a ##### Virtual Machine Management -| Features | Standard | Advanced | Premium | Comments | -|:-----------------------: |:--------: |:--------: |:-------: |:-----------------------------------------------------------------------------: | -| Create VM | ✅ | ✅ | ✅ | | -| Manage Virtual Machines | ✅ | ✅ | ✅ | Start, Stop, Suspend, Delete, Copy/clone... | -| Affinity Rules | ✅ | ✅ | ✅ | | -| Anti-Affinity Rules | ✅ | ✅ | ✅ | | -| VMware Marketplace | ✅ | ✅ | ✅ | Allowed to deploy VMs with pre-packaged software solutions | -| Create VM catalogs | ✅ | ✅ | ✅ | Build your own catalog of VM templates | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Create VM | ✅ | ✅ | | +| Manage Virtual Machines | ✅ | ✅ | Start, Stop, Suspend, Delete, Copy/clone... | +| Affinity Rules | ✅ | ✅ | | +| Anti-Affinity Rules | ✅ | ✅ | | +| VMware Marketplace | ✅ | ✅ | Allowed to deploy VMs with pre-packaged software solutions | +| Create VM catalogs | ✅ | ✅ | Build your own catalog of VM templates | #### Organisation / Virtual Datacenter Management -| Features | Standard | Advanced | Premium | Comments | -|:-----------------------------------: |:--------: |:--------: |:-------: |:-------------------------------------------------------------------------------------------------------: | -| User Management | ✅ | ✅ | ✅ | Manage users in a Public VCF as-a-Service | -| Identity Provider Integration - SSO | | | | In Roadmap (via OVHcloud uIAM service) | -| vCPU over-allocation | | | | In Roadmap - Allow users to adjust the quantity of vCPU/GHz for a virtual DC Possible through **OVH manager or API** | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| User Management | ✅ | ✅ | Manage users in a Public VCF as-a-Service | +| Identity Provider Integration - SSO | ⏳ | ⏳ | In Roadmap (via OVHcloud uIAM service) | +| vCPU over-allocation | ⏳ | ⏳ | In Roadmap - Allow users to adjust the quantity of vCPU/GHz for a virtual DC Possible through **OVH manager or API** | #### Networking -| Features | Standard | Advanced | Premium | Comments | -|--------------------------------- |---------- |---------- |--------- |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Routing & Switching IPv4 | | ✅ | ✅ | Network segments, distributed & non distributed routing, Routed Network with/without NAT BGP/ DHCP/ DNS/ Static routes Cross virtual DC Networking on the same site. Not supported: OSPF, VRF Lite | -| Public IPv4 Range | ✅ | ✅ | ✅ | | -| Private Network - vRack support | ✅ | ✅ | ✅ | in Roadmap | -| Routing & Switching IPv6 | | | | in Roadmap | -| VPN | | ✅ | ✅ | L2VPN, VPN IPsec Policy Based Not Supported : SSL VPN, Routed based IPsec VPN | -| Load Balancing | | | | Not supported with native Public VCF as-a-Service network capabilities | -| Advanced Load Balancing | | | | in Roadmap | +| Features | Standard | Advanced| Comments | +|:---:|:---:|:---:|:---:| +| Routing & Switching IPv4 | — | ✅ | Network segments, distributed & non distributed routing, Routed Network with/without NAT BGP/ DHCP/ DNS/ Static routes Cross virtual DC Networking on the same site. Not supported: OSPF, VRF Lite | +| Public IPv4 Range | ✅ | ✅ | | +| Private Network - vRack support | ✅ | ✅ | in Roadmap | +| Routing & Switching IPv6 | — | ⏳ | in Roadmap | +| VPN | — | ✅ | L2VPN, VPN IPsec Policy Based Not Supported: SSL VPN, Routed based IPsec VPN | +| Load Balancing | — | — | Not supported with native Public VCF as-a-Service network capabilities | +| Advanced Load Balancing | — | ⏳ | in Roadmap | #### Security -| Features | Standard | Advanced | Premium | Comments | -|:--------------------: |:--------: |:--------: |:-------: |:----------: | -| Stateful Firewall | | ✅ | ✅ | | -| Distributed Firewall | | ✅ | ✅ | | -| Security groups | | ✅ | ✅ | | -| IDS / IPS | | | | in Roadmap | -| WAF | | | | in Roadmap | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Stateful Firewall | — | ✅ | | +| Distributed Firewall | — | ✅ | | +| Security groups | — | ✅ | | +| IDS / IPS | — | ⏳ | in Roadmap | +| WAF | — | ⏳ | in Roadmap | #### Data protection -| Features | Standard | Advanced | Premium | Comments | -|:----------------------------: |:--------: |:--------: |:-------: |:---------------------------: | -| Backup as a Service | ✅ | ✅ | ✅ | Veeam Managed Backup Option | -| Virtual Machine Snapshots | ✅ | ✅ | ✅ | 1 per VM | -| Protection / Replication VMs | | | | in Roadmap | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Backup as a Service | ✅ | ✅ | Veeam Managed Backup Option | +| Virtual Machine Snapshots | ✅ | ✅ | 1 per VM | +| Protection / Replication VMs | ⏳ | ⏳ | in Roadmap | #### Storage -| Features | Standard | Advanced | Premium | Comments | -|:---------------------------------: |:--------: |:--------: |:-------: |:--------: | -| NFS datastore | ✅ | ✅ | ✅ | | -| High performance datastore (vSAN) | | | ✅ | | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| NFS datastore | ✅ | ✅ | | #### Monitoring -| Features | Standard | Advanced | Premium | Comments | -|:---------------: |:--------: |:--------: |:-------: |:-------------------------------------------------: | -| Aria operations | | | | In Roadmap - Resource management Metrics, Dashboard, Reporting | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Aria operations | ⏳ | ⏳ | In Roadmap - Resource management Metrics, Dashboard, Reporting | ## Go further diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.en-ie.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.en-ie.md index 27cf4f539e2..6e1e7ce64c9 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.en-ie.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.en-ie.md @@ -1,7 +1,7 @@ --- title: "Public VCF as-a-Service - The fundamentals of Public VCF as-a-Service" excerpt: "Discover the basic concepts of Public VCF as-a-Service" -updated: 2024-12-19 +updated: 2025-11-04 --- ## Objective @@ -62,11 +62,10 @@ In addition, organization administrators have the ability to copy items from pub Below is a comparison of the features provided by OVHcloud on its 3 Public VCF as-a-Service solutions. -| | Advanced Network & Security | vSAN Storage | -|:------------:|:---------------------------:|:------------:| -|Public VCF as-a-Service Standard | - | - | -|Public VCF as-a-Service Advanced | ✅ | - | -|Public VCF as-a-Service Premium | ✅ | ✅ | +| | Advanced Network & Security | vSAN Storage | +|:---:|:---:|:---:| +|Public VCF as-a-Service Standard | — | — | +|Public VCF as-a-Service Advanced | ✅ | — | #### Cluster Management @@ -75,7 +74,7 @@ Below is a comparison of the features provided by OVHcloud on its 3 Public VCF a > | Features | -| :-: | +|:---:| | ESXi management / capacity planning | | Hosts Failover / Proactive HA | | DRS / Storage DRS | @@ -83,65 +82,64 @@ Below is a comparison of the features provided by OVHcloud on its 3 Public VCF a ##### Virtual Machine Management -| Features | Standard | Advanced | Premium | Comments | -|:-----------------------: |:--------: |:--------: |:-------: |:-----------------------------------------------------------------------------: | -| Create VM | ✅ | ✅ | ✅ | | -| Manage Virtual Machines | ✅ | ✅ | ✅ | Start, Stop, Suspend, Delete, Copy/clone... | -| Affinity Rules | ✅ | ✅ | ✅ | | -| Anti-Affinity Rules | ✅ | ✅ | ✅ | | -| VMware Marketplace | ✅ | ✅ | ✅ | Allowed to deploy VMs with pre-packaged software solutions | -| Create VM catalogs | ✅ | ✅ | ✅ | Build your own catalog of VM templates | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Create VM | ✅ | ✅ | | +| Manage Virtual Machines | ✅ | ✅ | Start, Stop, Suspend, Delete, Copy/clone... | +| Affinity Rules | ✅ | ✅ | | +| Anti-Affinity Rules | ✅ | ✅ | | +| VMware Marketplace | ✅ | ✅ | Allowed to deploy VMs with pre-packaged software solutions | +| Create VM catalogs | ✅ | ✅ | Build your own catalog of VM templates | #### Organisation / Virtual Datacenter Management -| Features | Standard | Advanced | Premium | Comments | -|:-----------------------------------: |:--------: |:--------: |:-------: |:-------------------------------------------------------------------------------------------------------: | -| User Management | ✅ | ✅ | ✅ | Manage users in a Public VCF as-a-Service | -| Identity Provider Integration - SSO | | | | In Roadmap (via OVHcloud uIAM service) | -| vCPU over-allocation | | | | In Roadmap - Allow users to adjust the quantity of vCPU/GHz for a virtual DC Possible through **OVH manager or API** | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| User Management | ✅ | ✅ | Manage users in a Public VCF as-a-Service | +| Identity Provider Integration - SSO | ⏳ | ⏳ | In Roadmap (via OVHcloud uIAM service) | +| vCPU over-allocation | ⏳ | ⏳ | In Roadmap - Allow users to adjust the quantity of vCPU/GHz for a virtual DC Possible through **OVH manager or API** | #### Networking -| Features | Standard | Advanced | Premium | Comments | -|--------------------------------- |---------- |---------- |--------- |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Routing & Switching IPv4 | | ✅ | ✅ | Network segments, distributed & non distributed routing, Routed Network with/without NAT BGP/ DHCP/ DNS/ Static routes Cross virtual DC Networking on the same site. Not supported: OSPF, VRF Lite | -| Public IPv4 Range | ✅ | ✅ | ✅ | | -| Private Network - vRack support | ✅ | ✅ | ✅ | in Roadmap | -| Routing & Switching IPv6 | | | | in Roadmap | -| VPN | | ✅ | ✅ | L2VPN, VPN IPsec Policy Based Not Supported : SSL VPN, Routed based IPsec VPN | -| Load Balancing | | | | Not supported with native Public VCF as-a-Service network capabilities | -| Advanced Load Balancing | | | | in Roadmap | +| Features | Standard | Advanced| Comments | +|:---:|:---:|:---:|:---:| +| Routing & Switching IPv4 | — | ✅ | Network segments, distributed & non distributed routing, Routed Network with/without NAT BGP/ DHCP/ DNS/ Static routes Cross virtual DC Networking on the same site. Not supported: OSPF, VRF Lite | +| Public IPv4 Range | ✅ | ✅ | | +| Private Network - vRack support | ✅ | ✅ | in Roadmap | +| Routing & Switching IPv6 | — | ⏳ | in Roadmap | +| VPN | — | ✅ | L2VPN, VPN IPsec Policy Based Not Supported: SSL VPN, Routed based IPsec VPN | +| Load Balancing | — | — | Not supported with native Public VCF as-a-Service network capabilities | +| Advanced Load Balancing | — | ⏳ | in Roadmap | #### Security -| Features | Standard | Advanced | Premium | Comments | -|:--------------------: |:--------: |:--------: |:-------: |:----------: | -| Stateful Firewall | | ✅ | ✅ | | -| Distributed Firewall | | ✅ | ✅ | | -| Security groups | | ✅ | ✅ | | -| IDS / IPS | | | | in Roadmap | -| WAF | | | | in Roadmap | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Stateful Firewall | — | ✅ | | +| Distributed Firewall | — | ✅ | | +| Security groups | — | ✅ | | +| IDS / IPS | — | ⏳ | in Roadmap | +| WAF | — | ⏳ | in Roadmap | #### Data protection -| Features | Standard | Advanced | Premium | Comments | -|:----------------------------: |:--------: |:--------: |:-------: |:---------------------------: | -| Backup as a Service | ✅ | ✅ | ✅ | Veeam Managed Backup Option | -| Virtual Machine Snapshots | ✅ | ✅ | ✅ | 1 per VM | -| Protection / Replication VMs | | | | in Roadmap | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Backup as a Service | ✅ | ✅ | Veeam Managed Backup Option | +| Virtual Machine Snapshots | ✅ | ✅ | 1 per VM | +| Protection / Replication VMs | ⏳ | ⏳ | in Roadmap | #### Storage -| Features | Standard | Advanced | Premium | Comments | -|:---------------------------------: |:--------: |:--------: |:-------: |:--------: | -| NFS datastore | ✅ | ✅ | ✅ | | -| High performance datastore (vSAN) | | | ✅ | | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| NFS datastore | ✅ | ✅ | | #### Monitoring -| Features | Standard | Advanced | Premium | Comments | -|:---------------: |:--------: |:--------: |:-------: |:-------------------------------------------------: | -| Aria operations | | | | In Roadmap - Resource management Metrics, Dashboard, Reporting | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Aria operations | ⏳ | ⏳ | In Roadmap - Resource management Metrics, Dashboard, Reporting | ## Go further diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.en-sg.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.en-sg.md index 27cf4f539e2..6e1e7ce64c9 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.en-sg.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.en-sg.md @@ -1,7 +1,7 @@ --- title: "Public VCF as-a-Service - The fundamentals of Public VCF as-a-Service" excerpt: "Discover the basic concepts of Public VCF as-a-Service" -updated: 2024-12-19 +updated: 2025-11-04 --- ## Objective @@ -62,11 +62,10 @@ In addition, organization administrators have the ability to copy items from pub Below is a comparison of the features provided by OVHcloud on its 3 Public VCF as-a-Service solutions. -| | Advanced Network & Security | vSAN Storage | -|:------------:|:---------------------------:|:------------:| -|Public VCF as-a-Service Standard | - | - | -|Public VCF as-a-Service Advanced | ✅ | - | -|Public VCF as-a-Service Premium | ✅ | ✅ | +| | Advanced Network & Security | vSAN Storage | +|:---:|:---:|:---:| +|Public VCF as-a-Service Standard | — | — | +|Public VCF as-a-Service Advanced | ✅ | — | #### Cluster Management @@ -75,7 +74,7 @@ Below is a comparison of the features provided by OVHcloud on its 3 Public VCF a > | Features | -| :-: | +|:---:| | ESXi management / capacity planning | | Hosts Failover / Proactive HA | | DRS / Storage DRS | @@ -83,65 +82,64 @@ Below is a comparison of the features provided by OVHcloud on its 3 Public VCF a ##### Virtual Machine Management -| Features | Standard | Advanced | Premium | Comments | -|:-----------------------: |:--------: |:--------: |:-------: |:-----------------------------------------------------------------------------: | -| Create VM | ✅ | ✅ | ✅ | | -| Manage Virtual Machines | ✅ | ✅ | ✅ | Start, Stop, Suspend, Delete, Copy/clone... | -| Affinity Rules | ✅ | ✅ | ✅ | | -| Anti-Affinity Rules | ✅ | ✅ | ✅ | | -| VMware Marketplace | ✅ | ✅ | ✅ | Allowed to deploy VMs with pre-packaged software solutions | -| Create VM catalogs | ✅ | ✅ | ✅ | Build your own catalog of VM templates | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Create VM | ✅ | ✅ | | +| Manage Virtual Machines | ✅ | ✅ | Start, Stop, Suspend, Delete, Copy/clone... | +| Affinity Rules | ✅ | ✅ | | +| Anti-Affinity Rules | ✅ | ✅ | | +| VMware Marketplace | ✅ | ✅ | Allowed to deploy VMs with pre-packaged software solutions | +| Create VM catalogs | ✅ | ✅ | Build your own catalog of VM templates | #### Organisation / Virtual Datacenter Management -| Features | Standard | Advanced | Premium | Comments | -|:-----------------------------------: |:--------: |:--------: |:-------: |:-------------------------------------------------------------------------------------------------------: | -| User Management | ✅ | ✅ | ✅ | Manage users in a Public VCF as-a-Service | -| Identity Provider Integration - SSO | | | | In Roadmap (via OVHcloud uIAM service) | -| vCPU over-allocation | | | | In Roadmap - Allow users to adjust the quantity of vCPU/GHz for a virtual DC Possible through **OVH manager or API** | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| User Management | ✅ | ✅ | Manage users in a Public VCF as-a-Service | +| Identity Provider Integration - SSO | ⏳ | ⏳ | In Roadmap (via OVHcloud uIAM service) | +| vCPU over-allocation | ⏳ | ⏳ | In Roadmap - Allow users to adjust the quantity of vCPU/GHz for a virtual DC Possible through **OVH manager or API** | #### Networking -| Features | Standard | Advanced | Premium | Comments | -|--------------------------------- |---------- |---------- |--------- |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Routing & Switching IPv4 | | ✅ | ✅ | Network segments, distributed & non distributed routing, Routed Network with/without NAT BGP/ DHCP/ DNS/ Static routes Cross virtual DC Networking on the same site. Not supported: OSPF, VRF Lite | -| Public IPv4 Range | ✅ | ✅ | ✅ | | -| Private Network - vRack support | ✅ | ✅ | ✅ | in Roadmap | -| Routing & Switching IPv6 | | | | in Roadmap | -| VPN | | ✅ | ✅ | L2VPN, VPN IPsec Policy Based Not Supported : SSL VPN, Routed based IPsec VPN | -| Load Balancing | | | | Not supported with native Public VCF as-a-Service network capabilities | -| Advanced Load Balancing | | | | in Roadmap | +| Features | Standard | Advanced| Comments | +|:---:|:---:|:---:|:---:| +| Routing & Switching IPv4 | — | ✅ | Network segments, distributed & non distributed routing, Routed Network with/without NAT BGP/ DHCP/ DNS/ Static routes Cross virtual DC Networking on the same site. Not supported: OSPF, VRF Lite | +| Public IPv4 Range | ✅ | ✅ | | +| Private Network - vRack support | ✅ | ✅ | in Roadmap | +| Routing & Switching IPv6 | — | ⏳ | in Roadmap | +| VPN | — | ✅ | L2VPN, VPN IPsec Policy Based Not Supported: SSL VPN, Routed based IPsec VPN | +| Load Balancing | — | — | Not supported with native Public VCF as-a-Service network capabilities | +| Advanced Load Balancing | — | ⏳ | in Roadmap | #### Security -| Features | Standard | Advanced | Premium | Comments | -|:--------------------: |:--------: |:--------: |:-------: |:----------: | -| Stateful Firewall | | ✅ | ✅ | | -| Distributed Firewall | | ✅ | ✅ | | -| Security groups | | ✅ | ✅ | | -| IDS / IPS | | | | in Roadmap | -| WAF | | | | in Roadmap | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Stateful Firewall | — | ✅ | | +| Distributed Firewall | — | ✅ | | +| Security groups | — | ✅ | | +| IDS / IPS | — | ⏳ | in Roadmap | +| WAF | — | ⏳ | in Roadmap | #### Data protection -| Features | Standard | Advanced | Premium | Comments | -|:----------------------------: |:--------: |:--------: |:-------: |:---------------------------: | -| Backup as a Service | ✅ | ✅ | ✅ | Veeam Managed Backup Option | -| Virtual Machine Snapshots | ✅ | ✅ | ✅ | 1 per VM | -| Protection / Replication VMs | | | | in Roadmap | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Backup as a Service | ✅ | ✅ | Veeam Managed Backup Option | +| Virtual Machine Snapshots | ✅ | ✅ | 1 per VM | +| Protection / Replication VMs | ⏳ | ⏳ | in Roadmap | #### Storage -| Features | Standard | Advanced | Premium | Comments | -|:---------------------------------: |:--------: |:--------: |:-------: |:--------: | -| NFS datastore | ✅ | ✅ | ✅ | | -| High performance datastore (vSAN) | | | ✅ | | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| NFS datastore | ✅ | ✅ | | #### Monitoring -| Features | Standard | Advanced | Premium | Comments | -|:---------------: |:--------: |:--------: |:-------: |:-------------------------------------------------: | -| Aria operations | | | | In Roadmap - Resource management Metrics, Dashboard, Reporting | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Aria operations | ⏳ | ⏳ | In Roadmap - Resource management Metrics, Dashboard, Reporting | ## Go further diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.en-us.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.en-us.md index 27cf4f539e2..6e1e7ce64c9 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.en-us.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.en-us.md @@ -1,7 +1,7 @@ --- title: "Public VCF as-a-Service - The fundamentals of Public VCF as-a-Service" excerpt: "Discover the basic concepts of Public VCF as-a-Service" -updated: 2024-12-19 +updated: 2025-11-04 --- ## Objective @@ -62,11 +62,10 @@ In addition, organization administrators have the ability to copy items from pub Below is a comparison of the features provided by OVHcloud on its 3 Public VCF as-a-Service solutions. -| | Advanced Network & Security | vSAN Storage | -|:------------:|:---------------------------:|:------------:| -|Public VCF as-a-Service Standard | - | - | -|Public VCF as-a-Service Advanced | ✅ | - | -|Public VCF as-a-Service Premium | ✅ | ✅ | +| | Advanced Network & Security | vSAN Storage | +|:---:|:---:|:---:| +|Public VCF as-a-Service Standard | — | — | +|Public VCF as-a-Service Advanced | ✅ | — | #### Cluster Management @@ -75,7 +74,7 @@ Below is a comparison of the features provided by OVHcloud on its 3 Public VCF a > | Features | -| :-: | +|:---:| | ESXi management / capacity planning | | Hosts Failover / Proactive HA | | DRS / Storage DRS | @@ -83,65 +82,64 @@ Below is a comparison of the features provided by OVHcloud on its 3 Public VCF a ##### Virtual Machine Management -| Features | Standard | Advanced | Premium | Comments | -|:-----------------------: |:--------: |:--------: |:-------: |:-----------------------------------------------------------------------------: | -| Create VM | ✅ | ✅ | ✅ | | -| Manage Virtual Machines | ✅ | ✅ | ✅ | Start, Stop, Suspend, Delete, Copy/clone... | -| Affinity Rules | ✅ | ✅ | ✅ | | -| Anti-Affinity Rules | ✅ | ✅ | ✅ | | -| VMware Marketplace | ✅ | ✅ | ✅ | Allowed to deploy VMs with pre-packaged software solutions | -| Create VM catalogs | ✅ | ✅ | ✅ | Build your own catalog of VM templates | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Create VM | ✅ | ✅ | | +| Manage Virtual Machines | ✅ | ✅ | Start, Stop, Suspend, Delete, Copy/clone... | +| Affinity Rules | ✅ | ✅ | | +| Anti-Affinity Rules | ✅ | ✅ | | +| VMware Marketplace | ✅ | ✅ | Allowed to deploy VMs with pre-packaged software solutions | +| Create VM catalogs | ✅ | ✅ | Build your own catalog of VM templates | #### Organisation / Virtual Datacenter Management -| Features | Standard | Advanced | Premium | Comments | -|:-----------------------------------: |:--------: |:--------: |:-------: |:-------------------------------------------------------------------------------------------------------: | -| User Management | ✅ | ✅ | ✅ | Manage users in a Public VCF as-a-Service | -| Identity Provider Integration - SSO | | | | In Roadmap (via OVHcloud uIAM service) | -| vCPU over-allocation | | | | In Roadmap - Allow users to adjust the quantity of vCPU/GHz for a virtual DC Possible through **OVH manager or API** | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| User Management | ✅ | ✅ | Manage users in a Public VCF as-a-Service | +| Identity Provider Integration - SSO | ⏳ | ⏳ | In Roadmap (via OVHcloud uIAM service) | +| vCPU over-allocation | ⏳ | ⏳ | In Roadmap - Allow users to adjust the quantity of vCPU/GHz for a virtual DC Possible through **OVH manager or API** | #### Networking -| Features | Standard | Advanced | Premium | Comments | -|--------------------------------- |---------- |---------- |--------- |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Routing & Switching IPv4 | | ✅ | ✅ | Network segments, distributed & non distributed routing, Routed Network with/without NAT BGP/ DHCP/ DNS/ Static routes Cross virtual DC Networking on the same site. Not supported: OSPF, VRF Lite | -| Public IPv4 Range | ✅ | ✅ | ✅ | | -| Private Network - vRack support | ✅ | ✅ | ✅ | in Roadmap | -| Routing & Switching IPv6 | | | | in Roadmap | -| VPN | | ✅ | ✅ | L2VPN, VPN IPsec Policy Based Not Supported : SSL VPN, Routed based IPsec VPN | -| Load Balancing | | | | Not supported with native Public VCF as-a-Service network capabilities | -| Advanced Load Balancing | | | | in Roadmap | +| Features | Standard | Advanced| Comments | +|:---:|:---:|:---:|:---:| +| Routing & Switching IPv4 | — | ✅ | Network segments, distributed & non distributed routing, Routed Network with/without NAT BGP/ DHCP/ DNS/ Static routes Cross virtual DC Networking on the same site. Not supported: OSPF, VRF Lite | +| Public IPv4 Range | ✅ | ✅ | | +| Private Network - vRack support | ✅ | ✅ | in Roadmap | +| Routing & Switching IPv6 | — | ⏳ | in Roadmap | +| VPN | — | ✅ | L2VPN, VPN IPsec Policy Based Not Supported: SSL VPN, Routed based IPsec VPN | +| Load Balancing | — | — | Not supported with native Public VCF as-a-Service network capabilities | +| Advanced Load Balancing | — | ⏳ | in Roadmap | #### Security -| Features | Standard | Advanced | Premium | Comments | -|:--------------------: |:--------: |:--------: |:-------: |:----------: | -| Stateful Firewall | | ✅ | ✅ | | -| Distributed Firewall | | ✅ | ✅ | | -| Security groups | | ✅ | ✅ | | -| IDS / IPS | | | | in Roadmap | -| WAF | | | | in Roadmap | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Stateful Firewall | — | ✅ | | +| Distributed Firewall | — | ✅ | | +| Security groups | — | ✅ | | +| IDS / IPS | — | ⏳ | in Roadmap | +| WAF | — | ⏳ | in Roadmap | #### Data protection -| Features | Standard | Advanced | Premium | Comments | -|:----------------------------: |:--------: |:--------: |:-------: |:---------------------------: | -| Backup as a Service | ✅ | ✅ | ✅ | Veeam Managed Backup Option | -| Virtual Machine Snapshots | ✅ | ✅ | ✅ | 1 per VM | -| Protection / Replication VMs | | | | in Roadmap | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Backup as a Service | ✅ | ✅ | Veeam Managed Backup Option | +| Virtual Machine Snapshots | ✅ | ✅ | 1 per VM | +| Protection / Replication VMs | ⏳ | ⏳ | in Roadmap | #### Storage -| Features | Standard | Advanced | Premium | Comments | -|:---------------------------------: |:--------: |:--------: |:-------: |:--------: | -| NFS datastore | ✅ | ✅ | ✅ | | -| High performance datastore (vSAN) | | | ✅ | | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| NFS datastore | ✅ | ✅ | | #### Monitoring -| Features | Standard | Advanced | Premium | Comments | -|:---------------: |:--------: |:--------: |:-------: |:-------------------------------------------------: | -| Aria operations | | | | In Roadmap - Resource management Metrics, Dashboard, Reporting | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Aria operations | ⏳ | ⏳ | In Roadmap - Resource management Metrics, Dashboard, Reporting | ## Go further diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.es-es.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.es-es.md index 27cf4f539e2..6e1e7ce64c9 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.es-es.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.es-es.md @@ -1,7 +1,7 @@ --- title: "Public VCF as-a-Service - The fundamentals of Public VCF as-a-Service" excerpt: "Discover the basic concepts of Public VCF as-a-Service" -updated: 2024-12-19 +updated: 2025-11-04 --- ## Objective @@ -62,11 +62,10 @@ In addition, organization administrators have the ability to copy items from pub Below is a comparison of the features provided by OVHcloud on its 3 Public VCF as-a-Service solutions. -| | Advanced Network & Security | vSAN Storage | -|:------------:|:---------------------------:|:------------:| -|Public VCF as-a-Service Standard | - | - | -|Public VCF as-a-Service Advanced | ✅ | - | -|Public VCF as-a-Service Premium | ✅ | ✅ | +| | Advanced Network & Security | vSAN Storage | +|:---:|:---:|:---:| +|Public VCF as-a-Service Standard | — | — | +|Public VCF as-a-Service Advanced | ✅ | — | #### Cluster Management @@ -75,7 +74,7 @@ Below is a comparison of the features provided by OVHcloud on its 3 Public VCF a > | Features | -| :-: | +|:---:| | ESXi management / capacity planning | | Hosts Failover / Proactive HA | | DRS / Storage DRS | @@ -83,65 +82,64 @@ Below is a comparison of the features provided by OVHcloud on its 3 Public VCF a ##### Virtual Machine Management -| Features | Standard | Advanced | Premium | Comments | -|:-----------------------: |:--------: |:--------: |:-------: |:-----------------------------------------------------------------------------: | -| Create VM | ✅ | ✅ | ✅ | | -| Manage Virtual Machines | ✅ | ✅ | ✅ | Start, Stop, Suspend, Delete, Copy/clone... | -| Affinity Rules | ✅ | ✅ | ✅ | | -| Anti-Affinity Rules | ✅ | ✅ | ✅ | | -| VMware Marketplace | ✅ | ✅ | ✅ | Allowed to deploy VMs with pre-packaged software solutions | -| Create VM catalogs | ✅ | ✅ | ✅ | Build your own catalog of VM templates | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Create VM | ✅ | ✅ | | +| Manage Virtual Machines | ✅ | ✅ | Start, Stop, Suspend, Delete, Copy/clone... | +| Affinity Rules | ✅ | ✅ | | +| Anti-Affinity Rules | ✅ | ✅ | | +| VMware Marketplace | ✅ | ✅ | Allowed to deploy VMs with pre-packaged software solutions | +| Create VM catalogs | ✅ | ✅ | Build your own catalog of VM templates | #### Organisation / Virtual Datacenter Management -| Features | Standard | Advanced | Premium | Comments | -|:-----------------------------------: |:--------: |:--------: |:-------: |:-------------------------------------------------------------------------------------------------------: | -| User Management | ✅ | ✅ | ✅ | Manage users in a Public VCF as-a-Service | -| Identity Provider Integration - SSO | | | | In Roadmap (via OVHcloud uIAM service) | -| vCPU over-allocation | | | | In Roadmap - Allow users to adjust the quantity of vCPU/GHz for a virtual DC Possible through **OVH manager or API** | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| User Management | ✅ | ✅ | Manage users in a Public VCF as-a-Service | +| Identity Provider Integration - SSO | ⏳ | ⏳ | In Roadmap (via OVHcloud uIAM service) | +| vCPU over-allocation | ⏳ | ⏳ | In Roadmap - Allow users to adjust the quantity of vCPU/GHz for a virtual DC Possible through **OVH manager or API** | #### Networking -| Features | Standard | Advanced | Premium | Comments | -|--------------------------------- |---------- |---------- |--------- |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Routing & Switching IPv4 | | ✅ | ✅ | Network segments, distributed & non distributed routing, Routed Network with/without NAT BGP/ DHCP/ DNS/ Static routes Cross virtual DC Networking on the same site. Not supported: OSPF, VRF Lite | -| Public IPv4 Range | ✅ | ✅ | ✅ | | -| Private Network - vRack support | ✅ | ✅ | ✅ | in Roadmap | -| Routing & Switching IPv6 | | | | in Roadmap | -| VPN | | ✅ | ✅ | L2VPN, VPN IPsec Policy Based Not Supported : SSL VPN, Routed based IPsec VPN | -| Load Balancing | | | | Not supported with native Public VCF as-a-Service network capabilities | -| Advanced Load Balancing | | | | in Roadmap | +| Features | Standard | Advanced| Comments | +|:---:|:---:|:---:|:---:| +| Routing & Switching IPv4 | — | ✅ | Network segments, distributed & non distributed routing, Routed Network with/without NAT BGP/ DHCP/ DNS/ Static routes Cross virtual DC Networking on the same site. Not supported: OSPF, VRF Lite | +| Public IPv4 Range | ✅ | ✅ | | +| Private Network - vRack support | ✅ | ✅ | in Roadmap | +| Routing & Switching IPv6 | — | ⏳ | in Roadmap | +| VPN | — | ✅ | L2VPN, VPN IPsec Policy Based Not Supported: SSL VPN, Routed based IPsec VPN | +| Load Balancing | — | — | Not supported with native Public VCF as-a-Service network capabilities | +| Advanced Load Balancing | — | ⏳ | in Roadmap | #### Security -| Features | Standard | Advanced | Premium | Comments | -|:--------------------: |:--------: |:--------: |:-------: |:----------: | -| Stateful Firewall | | ✅ | ✅ | | -| Distributed Firewall | | ✅ | ✅ | | -| Security groups | | ✅ | ✅ | | -| IDS / IPS | | | | in Roadmap | -| WAF | | | | in Roadmap | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Stateful Firewall | — | ✅ | | +| Distributed Firewall | — | ✅ | | +| Security groups | — | ✅ | | +| IDS / IPS | — | ⏳ | in Roadmap | +| WAF | — | ⏳ | in Roadmap | #### Data protection -| Features | Standard | Advanced | Premium | Comments | -|:----------------------------: |:--------: |:--------: |:-------: |:---------------------------: | -| Backup as a Service | ✅ | ✅ | ✅ | Veeam Managed Backup Option | -| Virtual Machine Snapshots | ✅ | ✅ | ✅ | 1 per VM | -| Protection / Replication VMs | | | | in Roadmap | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Backup as a Service | ✅ | ✅ | Veeam Managed Backup Option | +| Virtual Machine Snapshots | ✅ | ✅ | 1 per VM | +| Protection / Replication VMs | ⏳ | ⏳ | in Roadmap | #### Storage -| Features | Standard | Advanced | Premium | Comments | -|:---------------------------------: |:--------: |:--------: |:-------: |:--------: | -| NFS datastore | ✅ | ✅ | ✅ | | -| High performance datastore (vSAN) | | | ✅ | | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| NFS datastore | ✅ | ✅ | | #### Monitoring -| Features | Standard | Advanced | Premium | Comments | -|:---------------: |:--------: |:--------: |:-------: |:-------------------------------------------------: | -| Aria operations | | | | In Roadmap - Resource management Metrics, Dashboard, Reporting | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Aria operations | ⏳ | ⏳ | In Roadmap - Resource management Metrics, Dashboard, Reporting | ## Go further diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.es-us.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.es-us.md index 27cf4f539e2..6e1e7ce64c9 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.es-us.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.es-us.md @@ -1,7 +1,7 @@ --- title: "Public VCF as-a-Service - The fundamentals of Public VCF as-a-Service" excerpt: "Discover the basic concepts of Public VCF as-a-Service" -updated: 2024-12-19 +updated: 2025-11-04 --- ## Objective @@ -62,11 +62,10 @@ In addition, organization administrators have the ability to copy items from pub Below is a comparison of the features provided by OVHcloud on its 3 Public VCF as-a-Service solutions. -| | Advanced Network & Security | vSAN Storage | -|:------------:|:---------------------------:|:------------:| -|Public VCF as-a-Service Standard | - | - | -|Public VCF as-a-Service Advanced | ✅ | - | -|Public VCF as-a-Service Premium | ✅ | ✅ | +| | Advanced Network & Security | vSAN Storage | +|:---:|:---:|:---:| +|Public VCF as-a-Service Standard | — | — | +|Public VCF as-a-Service Advanced | ✅ | — | #### Cluster Management @@ -75,7 +74,7 @@ Below is a comparison of the features provided by OVHcloud on its 3 Public VCF a > | Features | -| :-: | +|:---:| | ESXi management / capacity planning | | Hosts Failover / Proactive HA | | DRS / Storage DRS | @@ -83,65 +82,64 @@ Below is a comparison of the features provided by OVHcloud on its 3 Public VCF a ##### Virtual Machine Management -| Features | Standard | Advanced | Premium | Comments | -|:-----------------------: |:--------: |:--------: |:-------: |:-----------------------------------------------------------------------------: | -| Create VM | ✅ | ✅ | ✅ | | -| Manage Virtual Machines | ✅ | ✅ | ✅ | Start, Stop, Suspend, Delete, Copy/clone... | -| Affinity Rules | ✅ | ✅ | ✅ | | -| Anti-Affinity Rules | ✅ | ✅ | ✅ | | -| VMware Marketplace | ✅ | ✅ | ✅ | Allowed to deploy VMs with pre-packaged software solutions | -| Create VM catalogs | ✅ | ✅ | ✅ | Build your own catalog of VM templates | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Create VM | ✅ | ✅ | | +| Manage Virtual Machines | ✅ | ✅ | Start, Stop, Suspend, Delete, Copy/clone... | +| Affinity Rules | ✅ | ✅ | | +| Anti-Affinity Rules | ✅ | ✅ | | +| VMware Marketplace | ✅ | ✅ | Allowed to deploy VMs with pre-packaged software solutions | +| Create VM catalogs | ✅ | ✅ | Build your own catalog of VM templates | #### Organisation / Virtual Datacenter Management -| Features | Standard | Advanced | Premium | Comments | -|:-----------------------------------: |:--------: |:--------: |:-------: |:-------------------------------------------------------------------------------------------------------: | -| User Management | ✅ | ✅ | ✅ | Manage users in a Public VCF as-a-Service | -| Identity Provider Integration - SSO | | | | In Roadmap (via OVHcloud uIAM service) | -| vCPU over-allocation | | | | In Roadmap - Allow users to adjust the quantity of vCPU/GHz for a virtual DC Possible through **OVH manager or API** | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| User Management | ✅ | ✅ | Manage users in a Public VCF as-a-Service | +| Identity Provider Integration - SSO | ⏳ | ⏳ | In Roadmap (via OVHcloud uIAM service) | +| vCPU over-allocation | ⏳ | ⏳ | In Roadmap - Allow users to adjust the quantity of vCPU/GHz for a virtual DC Possible through **OVH manager or API** | #### Networking -| Features | Standard | Advanced | Premium | Comments | -|--------------------------------- |---------- |---------- |--------- |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Routing & Switching IPv4 | | ✅ | ✅ | Network segments, distributed & non distributed routing, Routed Network with/without NAT BGP/ DHCP/ DNS/ Static routes Cross virtual DC Networking on the same site. Not supported: OSPF, VRF Lite | -| Public IPv4 Range | ✅ | ✅ | ✅ | | -| Private Network - vRack support | ✅ | ✅ | ✅ | in Roadmap | -| Routing & Switching IPv6 | | | | in Roadmap | -| VPN | | ✅ | ✅ | L2VPN, VPN IPsec Policy Based Not Supported : SSL VPN, Routed based IPsec VPN | -| Load Balancing | | | | Not supported with native Public VCF as-a-Service network capabilities | -| Advanced Load Balancing | | | | in Roadmap | +| Features | Standard | Advanced| Comments | +|:---:|:---:|:---:|:---:| +| Routing & Switching IPv4 | — | ✅ | Network segments, distributed & non distributed routing, Routed Network with/without NAT BGP/ DHCP/ DNS/ Static routes Cross virtual DC Networking on the same site. Not supported: OSPF, VRF Lite | +| Public IPv4 Range | ✅ | ✅ | | +| Private Network - vRack support | ✅ | ✅ | in Roadmap | +| Routing & Switching IPv6 | — | ⏳ | in Roadmap | +| VPN | — | ✅ | L2VPN, VPN IPsec Policy Based Not Supported: SSL VPN, Routed based IPsec VPN | +| Load Balancing | — | — | Not supported with native Public VCF as-a-Service network capabilities | +| Advanced Load Balancing | — | ⏳ | in Roadmap | #### Security -| Features | Standard | Advanced | Premium | Comments | -|:--------------------: |:--------: |:--------: |:-------: |:----------: | -| Stateful Firewall | | ✅ | ✅ | | -| Distributed Firewall | | ✅ | ✅ | | -| Security groups | | ✅ | ✅ | | -| IDS / IPS | | | | in Roadmap | -| WAF | | | | in Roadmap | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Stateful Firewall | — | ✅ | | +| Distributed Firewall | — | ✅ | | +| Security groups | — | ✅ | | +| IDS / IPS | — | ⏳ | in Roadmap | +| WAF | — | ⏳ | in Roadmap | #### Data protection -| Features | Standard | Advanced | Premium | Comments | -|:----------------------------: |:--------: |:--------: |:-------: |:---------------------------: | -| Backup as a Service | ✅ | ✅ | ✅ | Veeam Managed Backup Option | -| Virtual Machine Snapshots | ✅ | ✅ | ✅ | 1 per VM | -| Protection / Replication VMs | | | | in Roadmap | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Backup as a Service | ✅ | ✅ | Veeam Managed Backup Option | +| Virtual Machine Snapshots | ✅ | ✅ | 1 per VM | +| Protection / Replication VMs | ⏳ | ⏳ | in Roadmap | #### Storage -| Features | Standard | Advanced | Premium | Comments | -|:---------------------------------: |:--------: |:--------: |:-------: |:--------: | -| NFS datastore | ✅ | ✅ | ✅ | | -| High performance datastore (vSAN) | | | ✅ | | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| NFS datastore | ✅ | ✅ | | #### Monitoring -| Features | Standard | Advanced | Premium | Comments | -|:---------------: |:--------: |:--------: |:-------: |:-------------------------------------------------: | -| Aria operations | | | | In Roadmap - Resource management Metrics, Dashboard, Reporting | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Aria operations | ⏳ | ⏳ | In Roadmap - Resource management Metrics, Dashboard, Reporting | ## Go further diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.fr-ca.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.fr-ca.md index 5393efd36a3..b55e0faa35a 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.fr-ca.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.fr-ca.md @@ -1,7 +1,7 @@ --- title: "Public VCF as-a-Service - Les concepts fondamentaux de Public VCF as-a-Service" excerpt: "Decouvrez les concepts fondamentaux de Public VCF as-a-Service" -updated: 2024-12-19 +updated: 2025-11-04 --- ## Objectif @@ -58,16 +58,14 @@ De plus, les administrateurs d'organisation ont la capacité de copier des élé - ### Fonctionnalités de Public VCF as-a-Service chez OVHcloud Retrouvez ci-dessous une comparaison des fonctionnalités fournies par OVHcloud sur ses 3 offres de Public VCF as-a-Service. -| | Advanced Network & Security | vSAN Storage | -|:------------:|:---------------------------:|:------------:| -|Public VCF as-a-Service Standard | - | - | -|Public VCF as-a-Service Advanced | ✅ | - | -|Public VCF as-a-Service Premium | ✅ | ✅ | +| | Advanced Network & Security | vSAN Storage | +|:---:|:---:|:---:| +|Public VCF as-a-Service Standard | — | — | +|Public VCF as-a-Service Advanced | ✅ | — | #### Cluster Management @@ -76,73 +74,72 @@ Retrouvez ci-dessous une comparaison des fonctionnalités fournies par OVHcloud > | Features | -| :-: | +|:---:| | ESXi management / capacity planning | -| Hosts Failover / Proactive HA | -| DRS / Storage DRS | -| vMotion / Storage vMotion | +| Hosts Failover / Proactive HA | +| DRS / Storage DRS | +| vMotion / Storage vMotion | ##### Virtual Machine Management -| Features | Standard | Advanced | Premium | Comments | -|:-----------------------: |:--------: |:--------: |:-------: |:-----------------------------------------------------------------------------: | -| Create VM | ✅ | ✅ | ✅ | | -| Manage Virtual Machines | ✅ | ✅ | ✅ | Start, Stop, Suspend, Delete, Copy/clone... | -| Affinity Rules | ✅ | ✅ | ✅ | | -| Anti-Affinity Rules | ✅ | ✅ | ✅ | | -| VMware Marketplace | ✅ | ✅ | ✅ | Allowed to deploy VMs with pre-packaged software solutions | -| Create VM catalogs | ✅ | ✅ | ✅ | Build your own catalog of VM templates | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Create VM | ✅ | ✅ | | +| Manage Virtual Machines | ✅ | ✅ | Start, Stop, Suspend, Delete, Copy/clone... | +| Affinity Rules | ✅ | ✅ | | +| Anti-Affinity Rules | ✅ | ✅ | | +| VMware Marketplace | ✅ | ✅ | Allowed to deploy VMs with pre-packaged software solutions | +| Create VM catalogs | ✅ | ✅ | Build your own catalog of VM templates | #### Organisation / Virtual Datacenter Management -| Features | Standard | Advanced | Premium | Comments | -|:-----------------------------------: |:--------: |:--------: |:-------: |:-------------------------------------------------------------------------------------------------------: | -| User Management | ✅ | ✅ | ✅ | Manage users in a Public VCF as-a-Service | -| Identity Provider Integration - SSO | | | | In Roadmap (via OVHcloud uIAM service) | -| vCPU over-allocation | | | | In Roadmap - Allow users to adjust the quantity of vCPU/GHz for a virtual DC Possible through **OVH manager or API** | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| User Management | ✅ | ✅ | Manage users in a Public VCF as-a-Service | +| Identity Provider Integration - SSO | ⏳ | ⏳ | In Roadmap (via OVHcloud uIAM service) | +| vCPU over-allocation | ⏳ | ⏳ | In Roadmap - Allow users to adjust the quantity of vCPU/GHz for a virtual DC Possible through **OVH manager or API** | #### Networking -| Features | Standard | Advanced | Premium | Comments | -|-----------------------------------|---------- |---------- |--------- |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Routing & Switching IPv4 | | ✅ | ✅ | Network segments, distributed & non distributed routing, Routed Network with/without NAT BGP/ DHCP/ DNS/ Static routes Cross virtual DC Networking on the same site. Not supported: OSPF, VRF Lite | -| Public IPv4 Range | ✅ | ✅ | ✅ | | -| Private Network - vRack support | ✅ | ✅ | ✅ | In Roadmap | -| Routing & Switching IPv6 | | | | in Roadmap | -| VPN | | ✅ | ✅ | L2VPN, VPN IPsec Policy Based Not Supported : SSL VPN, Routed based IPsec VPN | -| Load Balancing | | | | Not supported with native Public VCF as-a-Service network capabilities | -| Advanced Load Balancing | | | | In Roadmap | | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Routing & Switching IPv4 | — | ✅ | ✅ | Network segments, distributed & non distributed routing, Routed Network with/without NAT BGP/ DHCP/ DNS/ Static routes Cross virtual DC Networking on the same site. Not supported: OSPF, VRF Lite | +| Public IPv4 Range | ✅ | ✅ | | +| Private Network - vRack support | ✅ | ✅ | In Roadmap | +| Routing & Switching IPv6 | — | ⏳ | in Roadmap | +| VPN | — | ✅ | L2VPN, VPN IPsec Policy Based Not Supported : SSL VPN, Routed based IPse VPN | +| Load Balancing | — | — | Not supported with native Public VCF as-a-Service network capabilities | +| Advanced Load Balancing | — | ⏳ | In Roadmap | #### Security -| Features | Standard | Advanced | Premium | Comments | -|:--------------------: |:--------: |:--------: |:-------: |:----------: | -| Stateful Firewall | | ✅ | ✅ | | -| Distributed Firewall | | ✅ | ✅ | | -| Security groups | | ✅ | ✅ | | -| IDS / IPS | | | | in Roadmap | -| WAF | | | | in Roadmap | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Stateful Firewall | — | ✅ | | +| Distributed Firewall | — | ✅ | | +| Security groups | — | ✅ | | +| IDS / IPS | — | ⏳ | in Roadmap | +| WAF | — | ⏳ | in Roadmap | #### Data protection -| Features | Standard | Advanced | Premium | Comments | -|:----------------------------: |:--------: |:--------: |:-------: |:---------------------------: | -| Backup as a Service | ✅ | ✅ | ✅ | Veeam Managed Backup Option | -| Virtual Machine Snapshots | ✅ | ✅ | ✅ | 1 per VM | -| Protection / Replication VMs | | | | in Roadmap | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Backup as a Service | ✅ | ✅ | Veeam Managed Backup Option | +| Virtual Machine Snapshots | ✅ | ✅ | 1 per VM | +| Protection / Replication VMs | ⏳ | ⏳ | in Roadmap | #### Storage -| Features | Standard | Advanced | Premium | Comments | -|:---------------------------------: |:--------: |:--------: |:-------: |:--------: | -| NFS datastore | ✅ | ✅ | ✅ | | -| High performance datastore (vSAN) | | | ✅ | | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| NFS datastore | ✅ | ✅ | | #### Monitoring -| Features | Standard | Advanced | Premium | Comments | -|:---------------: |:--------: |:--------: |:-------: |:-------------------------------------------------: | -| Aria operations | | | | In Roadmap - Resource management Metrics, Dashboard, Reporting| +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Aria operations | ⏳ | ⏳ | In Roadmap - Resource management Metrics, Dashboard, Reporting | ## Aller plus loin diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.fr-fr.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.fr-fr.md index 5393efd36a3..b55e0faa35a 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.fr-fr.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.fr-fr.md @@ -1,7 +1,7 @@ --- title: "Public VCF as-a-Service - Les concepts fondamentaux de Public VCF as-a-Service" excerpt: "Decouvrez les concepts fondamentaux de Public VCF as-a-Service" -updated: 2024-12-19 +updated: 2025-11-04 --- ## Objectif @@ -58,16 +58,14 @@ De plus, les administrateurs d'organisation ont la capacité de copier des élé - ### Fonctionnalités de Public VCF as-a-Service chez OVHcloud Retrouvez ci-dessous une comparaison des fonctionnalités fournies par OVHcloud sur ses 3 offres de Public VCF as-a-Service. -| | Advanced Network & Security | vSAN Storage | -|:------------:|:---------------------------:|:------------:| -|Public VCF as-a-Service Standard | - | - | -|Public VCF as-a-Service Advanced | ✅ | - | -|Public VCF as-a-Service Premium | ✅ | ✅ | +| | Advanced Network & Security | vSAN Storage | +|:---:|:---:|:---:| +|Public VCF as-a-Service Standard | — | — | +|Public VCF as-a-Service Advanced | ✅ | — | #### Cluster Management @@ -76,73 +74,72 @@ Retrouvez ci-dessous une comparaison des fonctionnalités fournies par OVHcloud > | Features | -| :-: | +|:---:| | ESXi management / capacity planning | -| Hosts Failover / Proactive HA | -| DRS / Storage DRS | -| vMotion / Storage vMotion | +| Hosts Failover / Proactive HA | +| DRS / Storage DRS | +| vMotion / Storage vMotion | ##### Virtual Machine Management -| Features | Standard | Advanced | Premium | Comments | -|:-----------------------: |:--------: |:--------: |:-------: |:-----------------------------------------------------------------------------: | -| Create VM | ✅ | ✅ | ✅ | | -| Manage Virtual Machines | ✅ | ✅ | ✅ | Start, Stop, Suspend, Delete, Copy/clone... | -| Affinity Rules | ✅ | ✅ | ✅ | | -| Anti-Affinity Rules | ✅ | ✅ | ✅ | | -| VMware Marketplace | ✅ | ✅ | ✅ | Allowed to deploy VMs with pre-packaged software solutions | -| Create VM catalogs | ✅ | ✅ | ✅ | Build your own catalog of VM templates | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Create VM | ✅ | ✅ | | +| Manage Virtual Machines | ✅ | ✅ | Start, Stop, Suspend, Delete, Copy/clone... | +| Affinity Rules | ✅ | ✅ | | +| Anti-Affinity Rules | ✅ | ✅ | | +| VMware Marketplace | ✅ | ✅ | Allowed to deploy VMs with pre-packaged software solutions | +| Create VM catalogs | ✅ | ✅ | Build your own catalog of VM templates | #### Organisation / Virtual Datacenter Management -| Features | Standard | Advanced | Premium | Comments | -|:-----------------------------------: |:--------: |:--------: |:-------: |:-------------------------------------------------------------------------------------------------------: | -| User Management | ✅ | ✅ | ✅ | Manage users in a Public VCF as-a-Service | -| Identity Provider Integration - SSO | | | | In Roadmap (via OVHcloud uIAM service) | -| vCPU over-allocation | | | | In Roadmap - Allow users to adjust the quantity of vCPU/GHz for a virtual DC Possible through **OVH manager or API** | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| User Management | ✅ | ✅ | Manage users in a Public VCF as-a-Service | +| Identity Provider Integration - SSO | ⏳ | ⏳ | In Roadmap (via OVHcloud uIAM service) | +| vCPU over-allocation | ⏳ | ⏳ | In Roadmap - Allow users to adjust the quantity of vCPU/GHz for a virtual DC Possible through **OVH manager or API** | #### Networking -| Features | Standard | Advanced | Premium | Comments | -|-----------------------------------|---------- |---------- |--------- |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Routing & Switching IPv4 | | ✅ | ✅ | Network segments, distributed & non distributed routing, Routed Network with/without NAT BGP/ DHCP/ DNS/ Static routes Cross virtual DC Networking on the same site. Not supported: OSPF, VRF Lite | -| Public IPv4 Range | ✅ | ✅ | ✅ | | -| Private Network - vRack support | ✅ | ✅ | ✅ | In Roadmap | -| Routing & Switching IPv6 | | | | in Roadmap | -| VPN | | ✅ | ✅ | L2VPN, VPN IPsec Policy Based Not Supported : SSL VPN, Routed based IPsec VPN | -| Load Balancing | | | | Not supported with native Public VCF as-a-Service network capabilities | -| Advanced Load Balancing | | | | In Roadmap | | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Routing & Switching IPv4 | — | ✅ | ✅ | Network segments, distributed & non distributed routing, Routed Network with/without NAT BGP/ DHCP/ DNS/ Static routes Cross virtual DC Networking on the same site. Not supported: OSPF, VRF Lite | +| Public IPv4 Range | ✅ | ✅ | | +| Private Network - vRack support | ✅ | ✅ | In Roadmap | +| Routing & Switching IPv6 | — | ⏳ | in Roadmap | +| VPN | — | ✅ | L2VPN, VPN IPsec Policy Based Not Supported : SSL VPN, Routed based IPse VPN | +| Load Balancing | — | — | Not supported with native Public VCF as-a-Service network capabilities | +| Advanced Load Balancing | — | ⏳ | In Roadmap | #### Security -| Features | Standard | Advanced | Premium | Comments | -|:--------------------: |:--------: |:--------: |:-------: |:----------: | -| Stateful Firewall | | ✅ | ✅ | | -| Distributed Firewall | | ✅ | ✅ | | -| Security groups | | ✅ | ✅ | | -| IDS / IPS | | | | in Roadmap | -| WAF | | | | in Roadmap | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Stateful Firewall | — | ✅ | | +| Distributed Firewall | — | ✅ | | +| Security groups | — | ✅ | | +| IDS / IPS | — | ⏳ | in Roadmap | +| WAF | — | ⏳ | in Roadmap | #### Data protection -| Features | Standard | Advanced | Premium | Comments | -|:----------------------------: |:--------: |:--------: |:-------: |:---------------------------: | -| Backup as a Service | ✅ | ✅ | ✅ | Veeam Managed Backup Option | -| Virtual Machine Snapshots | ✅ | ✅ | ✅ | 1 per VM | -| Protection / Replication VMs | | | | in Roadmap | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Backup as a Service | ✅ | ✅ | Veeam Managed Backup Option | +| Virtual Machine Snapshots | ✅ | ✅ | 1 per VM | +| Protection / Replication VMs | ⏳ | ⏳ | in Roadmap | #### Storage -| Features | Standard | Advanced | Premium | Comments | -|:---------------------------------: |:--------: |:--------: |:-------: |:--------: | -| NFS datastore | ✅ | ✅ | ✅ | | -| High performance datastore (vSAN) | | | ✅ | | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| NFS datastore | ✅ | ✅ | | #### Monitoring -| Features | Standard | Advanced | Premium | Comments | -|:---------------: |:--------: |:--------: |:-------: |:-------------------------------------------------: | -| Aria operations | | | | In Roadmap - Resource management Metrics, Dashboard, Reporting| +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Aria operations | ⏳ | ⏳ | In Roadmap - Resource management Metrics, Dashboard, Reporting | ## Aller plus loin diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.it-it.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.it-it.md index 27cf4f539e2..6e1e7ce64c9 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.it-it.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.it-it.md @@ -1,7 +1,7 @@ --- title: "Public VCF as-a-Service - The fundamentals of Public VCF as-a-Service" excerpt: "Discover the basic concepts of Public VCF as-a-Service" -updated: 2024-12-19 +updated: 2025-11-04 --- ## Objective @@ -62,11 +62,10 @@ In addition, organization administrators have the ability to copy items from pub Below is a comparison of the features provided by OVHcloud on its 3 Public VCF as-a-Service solutions. -| | Advanced Network & Security | vSAN Storage | -|:------------:|:---------------------------:|:------------:| -|Public VCF as-a-Service Standard | - | - | -|Public VCF as-a-Service Advanced | ✅ | - | -|Public VCF as-a-Service Premium | ✅ | ✅ | +| | Advanced Network & Security | vSAN Storage | +|:---:|:---:|:---:| +|Public VCF as-a-Service Standard | — | — | +|Public VCF as-a-Service Advanced | ✅ | — | #### Cluster Management @@ -75,7 +74,7 @@ Below is a comparison of the features provided by OVHcloud on its 3 Public VCF a > | Features | -| :-: | +|:---:| | ESXi management / capacity planning | | Hosts Failover / Proactive HA | | DRS / Storage DRS | @@ -83,65 +82,64 @@ Below is a comparison of the features provided by OVHcloud on its 3 Public VCF a ##### Virtual Machine Management -| Features | Standard | Advanced | Premium | Comments | -|:-----------------------: |:--------: |:--------: |:-------: |:-----------------------------------------------------------------------------: | -| Create VM | ✅ | ✅ | ✅ | | -| Manage Virtual Machines | ✅ | ✅ | ✅ | Start, Stop, Suspend, Delete, Copy/clone... | -| Affinity Rules | ✅ | ✅ | ✅ | | -| Anti-Affinity Rules | ✅ | ✅ | ✅ | | -| VMware Marketplace | ✅ | ✅ | ✅ | Allowed to deploy VMs with pre-packaged software solutions | -| Create VM catalogs | ✅ | ✅ | ✅ | Build your own catalog of VM templates | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Create VM | ✅ | ✅ | | +| Manage Virtual Machines | ✅ | ✅ | Start, Stop, Suspend, Delete, Copy/clone... | +| Affinity Rules | ✅ | ✅ | | +| Anti-Affinity Rules | ✅ | ✅ | | +| VMware Marketplace | ✅ | ✅ | Allowed to deploy VMs with pre-packaged software solutions | +| Create VM catalogs | ✅ | ✅ | Build your own catalog of VM templates | #### Organisation / Virtual Datacenter Management -| Features | Standard | Advanced | Premium | Comments | -|:-----------------------------------: |:--------: |:--------: |:-------: |:-------------------------------------------------------------------------------------------------------: | -| User Management | ✅ | ✅ | ✅ | Manage users in a Public VCF as-a-Service | -| Identity Provider Integration - SSO | | | | In Roadmap (via OVHcloud uIAM service) | -| vCPU over-allocation | | | | In Roadmap - Allow users to adjust the quantity of vCPU/GHz for a virtual DC Possible through **OVH manager or API** | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| User Management | ✅ | ✅ | Manage users in a Public VCF as-a-Service | +| Identity Provider Integration - SSO | ⏳ | ⏳ | In Roadmap (via OVHcloud uIAM service) | +| vCPU over-allocation | ⏳ | ⏳ | In Roadmap - Allow users to adjust the quantity of vCPU/GHz for a virtual DC Possible through **OVH manager or API** | #### Networking -| Features | Standard | Advanced | Premium | Comments | -|--------------------------------- |---------- |---------- |--------- |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Routing & Switching IPv4 | | ✅ | ✅ | Network segments, distributed & non distributed routing, Routed Network with/without NAT BGP/ DHCP/ DNS/ Static routes Cross virtual DC Networking on the same site. Not supported: OSPF, VRF Lite | -| Public IPv4 Range | ✅ | ✅ | ✅ | | -| Private Network - vRack support | ✅ | ✅ | ✅ | in Roadmap | -| Routing & Switching IPv6 | | | | in Roadmap | -| VPN | | ✅ | ✅ | L2VPN, VPN IPsec Policy Based Not Supported : SSL VPN, Routed based IPsec VPN | -| Load Balancing | | | | Not supported with native Public VCF as-a-Service network capabilities | -| Advanced Load Balancing | | | | in Roadmap | +| Features | Standard | Advanced| Comments | +|:---:|:---:|:---:|:---:| +| Routing & Switching IPv4 | — | ✅ | Network segments, distributed & non distributed routing, Routed Network with/without NAT BGP/ DHCP/ DNS/ Static routes Cross virtual DC Networking on the same site. Not supported: OSPF, VRF Lite | +| Public IPv4 Range | ✅ | ✅ | | +| Private Network - vRack support | ✅ | ✅ | in Roadmap | +| Routing & Switching IPv6 | — | ⏳ | in Roadmap | +| VPN | — | ✅ | L2VPN, VPN IPsec Policy Based Not Supported: SSL VPN, Routed based IPsec VPN | +| Load Balancing | — | — | Not supported with native Public VCF as-a-Service network capabilities | +| Advanced Load Balancing | — | ⏳ | in Roadmap | #### Security -| Features | Standard | Advanced | Premium | Comments | -|:--------------------: |:--------: |:--------: |:-------: |:----------: | -| Stateful Firewall | | ✅ | ✅ | | -| Distributed Firewall | | ✅ | ✅ | | -| Security groups | | ✅ | ✅ | | -| IDS / IPS | | | | in Roadmap | -| WAF | | | | in Roadmap | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Stateful Firewall | — | ✅ | | +| Distributed Firewall | — | ✅ | | +| Security groups | — | ✅ | | +| IDS / IPS | — | ⏳ | in Roadmap | +| WAF | — | ⏳ | in Roadmap | #### Data protection -| Features | Standard | Advanced | Premium | Comments | -|:----------------------------: |:--------: |:--------: |:-------: |:---------------------------: | -| Backup as a Service | ✅ | ✅ | ✅ | Veeam Managed Backup Option | -| Virtual Machine Snapshots | ✅ | ✅ | ✅ | 1 per VM | -| Protection / Replication VMs | | | | in Roadmap | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Backup as a Service | ✅ | ✅ | Veeam Managed Backup Option | +| Virtual Machine Snapshots | ✅ | ✅ | 1 per VM | +| Protection / Replication VMs | ⏳ | ⏳ | in Roadmap | #### Storage -| Features | Standard | Advanced | Premium | Comments | -|:---------------------------------: |:--------: |:--------: |:-------: |:--------: | -| NFS datastore | ✅ | ✅ | ✅ | | -| High performance datastore (vSAN) | | | ✅ | | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| NFS datastore | ✅ | ✅ | | #### Monitoring -| Features | Standard | Advanced | Premium | Comments | -|:---------------: |:--------: |:--------: |:-------: |:-------------------------------------------------: | -| Aria operations | | | | In Roadmap - Resource management Metrics, Dashboard, Reporting | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Aria operations | ⏳ | ⏳ | In Roadmap - Resource management Metrics, Dashboard, Reporting | ## Go further diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.pl-pl.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.pl-pl.md index 27cf4f539e2..6e1e7ce64c9 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.pl-pl.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.pl-pl.md @@ -1,7 +1,7 @@ --- title: "Public VCF as-a-Service - The fundamentals of Public VCF as-a-Service" excerpt: "Discover the basic concepts of Public VCF as-a-Service" -updated: 2024-12-19 +updated: 2025-11-04 --- ## Objective @@ -62,11 +62,10 @@ In addition, organization administrators have the ability to copy items from pub Below is a comparison of the features provided by OVHcloud on its 3 Public VCF as-a-Service solutions. -| | Advanced Network & Security | vSAN Storage | -|:------------:|:---------------------------:|:------------:| -|Public VCF as-a-Service Standard | - | - | -|Public VCF as-a-Service Advanced | ✅ | - | -|Public VCF as-a-Service Premium | ✅ | ✅ | +| | Advanced Network & Security | vSAN Storage | +|:---:|:---:|:---:| +|Public VCF as-a-Service Standard | — | — | +|Public VCF as-a-Service Advanced | ✅ | — | #### Cluster Management @@ -75,7 +74,7 @@ Below is a comparison of the features provided by OVHcloud on its 3 Public VCF a > | Features | -| :-: | +|:---:| | ESXi management / capacity planning | | Hosts Failover / Proactive HA | | DRS / Storage DRS | @@ -83,65 +82,64 @@ Below is a comparison of the features provided by OVHcloud on its 3 Public VCF a ##### Virtual Machine Management -| Features | Standard | Advanced | Premium | Comments | -|:-----------------------: |:--------: |:--------: |:-------: |:-----------------------------------------------------------------------------: | -| Create VM | ✅ | ✅ | ✅ | | -| Manage Virtual Machines | ✅ | ✅ | ✅ | Start, Stop, Suspend, Delete, Copy/clone... | -| Affinity Rules | ✅ | ✅ | ✅ | | -| Anti-Affinity Rules | ✅ | ✅ | ✅ | | -| VMware Marketplace | ✅ | ✅ | ✅ | Allowed to deploy VMs with pre-packaged software solutions | -| Create VM catalogs | ✅ | ✅ | ✅ | Build your own catalog of VM templates | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Create VM | ✅ | ✅ | | +| Manage Virtual Machines | ✅ | ✅ | Start, Stop, Suspend, Delete, Copy/clone... | +| Affinity Rules | ✅ | ✅ | | +| Anti-Affinity Rules | ✅ | ✅ | | +| VMware Marketplace | ✅ | ✅ | Allowed to deploy VMs with pre-packaged software solutions | +| Create VM catalogs | ✅ | ✅ | Build your own catalog of VM templates | #### Organisation / Virtual Datacenter Management -| Features | Standard | Advanced | Premium | Comments | -|:-----------------------------------: |:--------: |:--------: |:-------: |:-------------------------------------------------------------------------------------------------------: | -| User Management | ✅ | ✅ | ✅ | Manage users in a Public VCF as-a-Service | -| Identity Provider Integration - SSO | | | | In Roadmap (via OVHcloud uIAM service) | -| vCPU over-allocation | | | | In Roadmap - Allow users to adjust the quantity of vCPU/GHz for a virtual DC Possible through **OVH manager or API** | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| User Management | ✅ | ✅ | Manage users in a Public VCF as-a-Service | +| Identity Provider Integration - SSO | ⏳ | ⏳ | In Roadmap (via OVHcloud uIAM service) | +| vCPU over-allocation | ⏳ | ⏳ | In Roadmap - Allow users to adjust the quantity of vCPU/GHz for a virtual DC Possible through **OVH manager or API** | #### Networking -| Features | Standard | Advanced | Premium | Comments | -|--------------------------------- |---------- |---------- |--------- |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Routing & Switching IPv4 | | ✅ | ✅ | Network segments, distributed & non distributed routing, Routed Network with/without NAT BGP/ DHCP/ DNS/ Static routes Cross virtual DC Networking on the same site. Not supported: OSPF, VRF Lite | -| Public IPv4 Range | ✅ | ✅ | ✅ | | -| Private Network - vRack support | ✅ | ✅ | ✅ | in Roadmap | -| Routing & Switching IPv6 | | | | in Roadmap | -| VPN | | ✅ | ✅ | L2VPN, VPN IPsec Policy Based Not Supported : SSL VPN, Routed based IPsec VPN | -| Load Balancing | | | | Not supported with native Public VCF as-a-Service network capabilities | -| Advanced Load Balancing | | | | in Roadmap | +| Features | Standard | Advanced| Comments | +|:---:|:---:|:---:|:---:| +| Routing & Switching IPv4 | — | ✅ | Network segments, distributed & non distributed routing, Routed Network with/without NAT BGP/ DHCP/ DNS/ Static routes Cross virtual DC Networking on the same site. Not supported: OSPF, VRF Lite | +| Public IPv4 Range | ✅ | ✅ | | +| Private Network - vRack support | ✅ | ✅ | in Roadmap | +| Routing & Switching IPv6 | — | ⏳ | in Roadmap | +| VPN | — | ✅ | L2VPN, VPN IPsec Policy Based Not Supported: SSL VPN, Routed based IPsec VPN | +| Load Balancing | — | — | Not supported with native Public VCF as-a-Service network capabilities | +| Advanced Load Balancing | — | ⏳ | in Roadmap | #### Security -| Features | Standard | Advanced | Premium | Comments | -|:--------------------: |:--------: |:--------: |:-------: |:----------: | -| Stateful Firewall | | ✅ | ✅ | | -| Distributed Firewall | | ✅ | ✅ | | -| Security groups | | ✅ | ✅ | | -| IDS / IPS | | | | in Roadmap | -| WAF | | | | in Roadmap | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Stateful Firewall | — | ✅ | | +| Distributed Firewall | — | ✅ | | +| Security groups | — | ✅ | | +| IDS / IPS | — | ⏳ | in Roadmap | +| WAF | — | ⏳ | in Roadmap | #### Data protection -| Features | Standard | Advanced | Premium | Comments | -|:----------------------------: |:--------: |:--------: |:-------: |:---------------------------: | -| Backup as a Service | ✅ | ✅ | ✅ | Veeam Managed Backup Option | -| Virtual Machine Snapshots | ✅ | ✅ | ✅ | 1 per VM | -| Protection / Replication VMs | | | | in Roadmap | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Backup as a Service | ✅ | ✅ | Veeam Managed Backup Option | +| Virtual Machine Snapshots | ✅ | ✅ | 1 per VM | +| Protection / Replication VMs | ⏳ | ⏳ | in Roadmap | #### Storage -| Features | Standard | Advanced | Premium | Comments | -|:---------------------------------: |:--------: |:--------: |:-------: |:--------: | -| NFS datastore | ✅ | ✅ | ✅ | | -| High performance datastore (vSAN) | | | ✅ | | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| NFS datastore | ✅ | ✅ | | #### Monitoring -| Features | Standard | Advanced | Premium | Comments | -|:---------------: |:--------: |:--------: |:-------: |:-------------------------------------------------: | -| Aria operations | | | | In Roadmap - Resource management Metrics, Dashboard, Reporting | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Aria operations | ⏳ | ⏳ | In Roadmap - Resource management Metrics, Dashboard, Reporting | ## Go further diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.pt-pt.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.pt-pt.md index 27cf4f539e2..6e1e7ce64c9 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.pt-pt.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-get-concepts/guide.pt-pt.md @@ -1,7 +1,7 @@ --- title: "Public VCF as-a-Service - The fundamentals of Public VCF as-a-Service" excerpt: "Discover the basic concepts of Public VCF as-a-Service" -updated: 2024-12-19 +updated: 2025-11-04 --- ## Objective @@ -62,11 +62,10 @@ In addition, organization administrators have the ability to copy items from pub Below is a comparison of the features provided by OVHcloud on its 3 Public VCF as-a-Service solutions. -| | Advanced Network & Security | vSAN Storage | -|:------------:|:---------------------------:|:------------:| -|Public VCF as-a-Service Standard | - | - | -|Public VCF as-a-Service Advanced | ✅ | - | -|Public VCF as-a-Service Premium | ✅ | ✅ | +| | Advanced Network & Security | vSAN Storage | +|:---:|:---:|:---:| +|Public VCF as-a-Service Standard | — | — | +|Public VCF as-a-Service Advanced | ✅ | — | #### Cluster Management @@ -75,7 +74,7 @@ Below is a comparison of the features provided by OVHcloud on its 3 Public VCF a > | Features | -| :-: | +|:---:| | ESXi management / capacity planning | | Hosts Failover / Proactive HA | | DRS / Storage DRS | @@ -83,65 +82,64 @@ Below is a comparison of the features provided by OVHcloud on its 3 Public VCF a ##### Virtual Machine Management -| Features | Standard | Advanced | Premium | Comments | -|:-----------------------: |:--------: |:--------: |:-------: |:-----------------------------------------------------------------------------: | -| Create VM | ✅ | ✅ | ✅ | | -| Manage Virtual Machines | ✅ | ✅ | ✅ | Start, Stop, Suspend, Delete, Copy/clone... | -| Affinity Rules | ✅ | ✅ | ✅ | | -| Anti-Affinity Rules | ✅ | ✅ | ✅ | | -| VMware Marketplace | ✅ | ✅ | ✅ | Allowed to deploy VMs with pre-packaged software solutions | -| Create VM catalogs | ✅ | ✅ | ✅ | Build your own catalog of VM templates | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Create VM | ✅ | ✅ | | +| Manage Virtual Machines | ✅ | ✅ | Start, Stop, Suspend, Delete, Copy/clone... | +| Affinity Rules | ✅ | ✅ | | +| Anti-Affinity Rules | ✅ | ✅ | | +| VMware Marketplace | ✅ | ✅ | Allowed to deploy VMs with pre-packaged software solutions | +| Create VM catalogs | ✅ | ✅ | Build your own catalog of VM templates | #### Organisation / Virtual Datacenter Management -| Features | Standard | Advanced | Premium | Comments | -|:-----------------------------------: |:--------: |:--------: |:-------: |:-------------------------------------------------------------------------------------------------------: | -| User Management | ✅ | ✅ | ✅ | Manage users in a Public VCF as-a-Service | -| Identity Provider Integration - SSO | | | | In Roadmap (via OVHcloud uIAM service) | -| vCPU over-allocation | | | | In Roadmap - Allow users to adjust the quantity of vCPU/GHz for a virtual DC Possible through **OVH manager or API** | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| User Management | ✅ | ✅ | Manage users in a Public VCF as-a-Service | +| Identity Provider Integration - SSO | ⏳ | ⏳ | In Roadmap (via OVHcloud uIAM service) | +| vCPU over-allocation | ⏳ | ⏳ | In Roadmap - Allow users to adjust the quantity of vCPU/GHz for a virtual DC Possible through **OVH manager or API** | #### Networking -| Features | Standard | Advanced | Premium | Comments | -|--------------------------------- |---------- |---------- |--------- |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Routing & Switching IPv4 | | ✅ | ✅ | Network segments, distributed & non distributed routing, Routed Network with/without NAT BGP/ DHCP/ DNS/ Static routes Cross virtual DC Networking on the same site. Not supported: OSPF, VRF Lite | -| Public IPv4 Range | ✅ | ✅ | ✅ | | -| Private Network - vRack support | ✅ | ✅ | ✅ | in Roadmap | -| Routing & Switching IPv6 | | | | in Roadmap | -| VPN | | ✅ | ✅ | L2VPN, VPN IPsec Policy Based Not Supported : SSL VPN, Routed based IPsec VPN | -| Load Balancing | | | | Not supported with native Public VCF as-a-Service network capabilities | -| Advanced Load Balancing | | | | in Roadmap | +| Features | Standard | Advanced| Comments | +|:---:|:---:|:---:|:---:| +| Routing & Switching IPv4 | — | ✅ | Network segments, distributed & non distributed routing, Routed Network with/without NAT BGP/ DHCP/ DNS/ Static routes Cross virtual DC Networking on the same site. Not supported: OSPF, VRF Lite | +| Public IPv4 Range | ✅ | ✅ | | +| Private Network - vRack support | ✅ | ✅ | in Roadmap | +| Routing & Switching IPv6 | — | ⏳ | in Roadmap | +| VPN | — | ✅ | L2VPN, VPN IPsec Policy Based Not Supported: SSL VPN, Routed based IPsec VPN | +| Load Balancing | — | — | Not supported with native Public VCF as-a-Service network capabilities | +| Advanced Load Balancing | — | ⏳ | in Roadmap | #### Security -| Features | Standard | Advanced | Premium | Comments | -|:--------------------: |:--------: |:--------: |:-------: |:----------: | -| Stateful Firewall | | ✅ | ✅ | | -| Distributed Firewall | | ✅ | ✅ | | -| Security groups | | ✅ | ✅ | | -| IDS / IPS | | | | in Roadmap | -| WAF | | | | in Roadmap | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Stateful Firewall | — | ✅ | | +| Distributed Firewall | — | ✅ | | +| Security groups | — | ✅ | | +| IDS / IPS | — | ⏳ | in Roadmap | +| WAF | — | ⏳ | in Roadmap | #### Data protection -| Features | Standard | Advanced | Premium | Comments | -|:----------------------------: |:--------: |:--------: |:-------: |:---------------------------: | -| Backup as a Service | ✅ | ✅ | ✅ | Veeam Managed Backup Option | -| Virtual Machine Snapshots | ✅ | ✅ | ✅ | 1 per VM | -| Protection / Replication VMs | | | | in Roadmap | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Backup as a Service | ✅ | ✅ | Veeam Managed Backup Option | +| Virtual Machine Snapshots | ✅ | ✅ | 1 per VM | +| Protection / Replication VMs | ⏳ | ⏳ | in Roadmap | #### Storage -| Features | Standard | Advanced | Premium | Comments | -|:---------------------------------: |:--------: |:--------: |:-------: |:--------: | -| NFS datastore | ✅ | ✅ | ✅ | | -| High performance datastore (vSAN) | | | ✅ | | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| NFS datastore | ✅ | ✅ | | #### Monitoring -| Features | Standard | Advanced | Premium | Comments | -|:---------------: |:--------: |:--------: |:-------: |:-------------------------------------------------: | -| Aria operations | | | | In Roadmap - Resource management Metrics, Dashboard, Reporting | +| Features | Standard | Advanced | Comments | +|:---:|:---:|:---:|:---:| +| Aria operations | ⏳ | ⏳ | In Roadmap - Resource management Metrics, Dashboard, Reporting | ## Go further diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/VCD-libraries-overview.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/VCD-libraries-overview.png deleted file mode 100644 index a168ebc96cf..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/VCD-libraries-overview.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-Veeam-discover.gif b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-Veeam-discover.gif deleted file mode 100644 index edfd9a4fbbe..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-Veeam-discover.gif and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-administration-overview.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-administration-overview.png deleted file mode 100644 index 7f728254590..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-administration-overview.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-anti-affinity-rules.gif b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-anti-affinity-rules.gif deleted file mode 100644 index 6e18367cf08..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-anti-affinity-rules.gif and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-applications-overview.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-applications-overview.png deleted file mode 100644 index 3a9da8bb119..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-applications-overview.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-catalog-ISO.gif b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-catalog-ISO.gif deleted file mode 100644 index 51938ff6951..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-catalog-ISO.gif and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-content-overview.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-content-overview.png deleted file mode 100644 index 9f9582c2f8c..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-content-overview.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-create-template.gif b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-create-template.gif deleted file mode 100644 index d8b707ea30c..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-create-template.gif and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-datacenters-overview.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-datacenters-overview.png deleted file mode 100644 index bdf9b586339..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-datacenters-overview.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-dhcp.gif b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-dhcp.gif deleted file mode 100644 index 2028564ff8d..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-dhcp.gif and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-edge-GW.gif b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-edge-GW.gif deleted file mode 100644 index 760a2e634bc..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-edge-GW.gif and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-export-VM.gif b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-export-VM.gif deleted file mode 100644 index 88599d017b9..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-export-VM.gif and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-libraries-overview.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-libraries-overview.png deleted file mode 100644 index a168ebc96cf..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-libraries-overview.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-monitoring-overview.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-monitoring-overview.png deleted file mode 100644 index 8ef814c9448..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-monitoring-overview.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-more-overview.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-more-overview.png deleted file mode 100644 index e1bbd5d9036..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-more-overview.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-network.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-network.png deleted file mode 100644 index b79f06c74ac..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-network.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-networking-overview.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-networking-overview.png deleted file mode 100644 index 01156bfc796..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-networking-overview.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-research-overview.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-research-overview.png deleted file mode 100644 index b4c1cfd706e..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-research-overview.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-vCPU-GHz.gif b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-vCPU-GHz.gif deleted file mode 100644 index 2eb628b0b37..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-vCPU-GHz.gif and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-vapp.png b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-vapp.png deleted file mode 100644 index 25e46abb2b9..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-vapp.png and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-veeam-restore.gif b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-veeam-restore.gif deleted file mode 100644 index afa146a3763..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-veeam-restore.gif and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-vm-clone.gif b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-vm-clone.gif deleted file mode 100644 index 1b2580f4808..00000000000 Binary files a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-getting-started/images/vcd-vm-clone.gif and /dev/null differ diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.de-de.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.de-de.md index e7bcd4d34f4..98c183b57b3 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.de-de.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.de-de.md @@ -1,7 +1,7 @@ --- title: "Technical capabilities and limitations of Public VCF as-a-Service" excerpt: "Learn about the technical capabilities and limitations of Public VCF aaS (aka Public VCF as-a-Service)" -updated: 2025-05-13 +updated: 2025-09-25 --- ## Objective @@ -33,6 +33,7 @@ Before getting started, review the following guides to better understand Public | VMs (per vApp) | 128 | 128 | 128 | Maximum number of VMs allowed per vApp. | | VMs (per organization) | 2000 | 4000 | 4000 | Maximum number of VMs per organization. | | vApps (per organization) | 10,000 | 10,000 | 10,000 | Maximum number of vApps per organization. | +| Segments (per organization) | 40 | 40 | 40 | Maximum number of segments per organization. | > **Note**: When creating a snapshot that includes the VM's memory, storage usage can quickly add up. > For example, if you have 1 VM with 1 GB of RAM and a 10 GB disk, and you create a snapshot that includes memory, your storage usage will be: @@ -67,4 +68,4 @@ If you need training or technical assistance to implement our solutions, please Ask questions, give your feedback and interact directly with the team building our Hosted Private Cloud services on the dedicated [Discord](https://discord.gg/ovhcloud) channel. -Join our [community of users](/links/community). \ No newline at end of file +Join our [community of users](/links/community). diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.en-asia.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.en-asia.md index e7bcd4d34f4..98c183b57b3 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.en-asia.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.en-asia.md @@ -1,7 +1,7 @@ --- title: "Technical capabilities and limitations of Public VCF as-a-Service" excerpt: "Learn about the technical capabilities and limitations of Public VCF aaS (aka Public VCF as-a-Service)" -updated: 2025-05-13 +updated: 2025-09-25 --- ## Objective @@ -33,6 +33,7 @@ Before getting started, review the following guides to better understand Public | VMs (per vApp) | 128 | 128 | 128 | Maximum number of VMs allowed per vApp. | | VMs (per organization) | 2000 | 4000 | 4000 | Maximum number of VMs per organization. | | vApps (per organization) | 10,000 | 10,000 | 10,000 | Maximum number of vApps per organization. | +| Segments (per organization) | 40 | 40 | 40 | Maximum number of segments per organization. | > **Note**: When creating a snapshot that includes the VM's memory, storage usage can quickly add up. > For example, if you have 1 VM with 1 GB of RAM and a 10 GB disk, and you create a snapshot that includes memory, your storage usage will be: @@ -67,4 +68,4 @@ If you need training or technical assistance to implement our solutions, please Ask questions, give your feedback and interact directly with the team building our Hosted Private Cloud services on the dedicated [Discord](https://discord.gg/ovhcloud) channel. -Join our [community of users](/links/community). \ No newline at end of file +Join our [community of users](/links/community). diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.en-au.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.en-au.md index e7bcd4d34f4..98c183b57b3 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.en-au.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.en-au.md @@ -1,7 +1,7 @@ --- title: "Technical capabilities and limitations of Public VCF as-a-Service" excerpt: "Learn about the technical capabilities and limitations of Public VCF aaS (aka Public VCF as-a-Service)" -updated: 2025-05-13 +updated: 2025-09-25 --- ## Objective @@ -33,6 +33,7 @@ Before getting started, review the following guides to better understand Public | VMs (per vApp) | 128 | 128 | 128 | Maximum number of VMs allowed per vApp. | | VMs (per organization) | 2000 | 4000 | 4000 | Maximum number of VMs per organization. | | vApps (per organization) | 10,000 | 10,000 | 10,000 | Maximum number of vApps per organization. | +| Segments (per organization) | 40 | 40 | 40 | Maximum number of segments per organization. | > **Note**: When creating a snapshot that includes the VM's memory, storage usage can quickly add up. > For example, if you have 1 VM with 1 GB of RAM and a 10 GB disk, and you create a snapshot that includes memory, your storage usage will be: @@ -67,4 +68,4 @@ If you need training or technical assistance to implement our solutions, please Ask questions, give your feedback and interact directly with the team building our Hosted Private Cloud services on the dedicated [Discord](https://discord.gg/ovhcloud) channel. -Join our [community of users](/links/community). \ No newline at end of file +Join our [community of users](/links/community). diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.en-ca.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.en-ca.md index e7bcd4d34f4..98c183b57b3 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.en-ca.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.en-ca.md @@ -1,7 +1,7 @@ --- title: "Technical capabilities and limitations of Public VCF as-a-Service" excerpt: "Learn about the technical capabilities and limitations of Public VCF aaS (aka Public VCF as-a-Service)" -updated: 2025-05-13 +updated: 2025-09-25 --- ## Objective @@ -33,6 +33,7 @@ Before getting started, review the following guides to better understand Public | VMs (per vApp) | 128 | 128 | 128 | Maximum number of VMs allowed per vApp. | | VMs (per organization) | 2000 | 4000 | 4000 | Maximum number of VMs per organization. | | vApps (per organization) | 10,000 | 10,000 | 10,000 | Maximum number of vApps per organization. | +| Segments (per organization) | 40 | 40 | 40 | Maximum number of segments per organization. | > **Note**: When creating a snapshot that includes the VM's memory, storage usage can quickly add up. > For example, if you have 1 VM with 1 GB of RAM and a 10 GB disk, and you create a snapshot that includes memory, your storage usage will be: @@ -67,4 +68,4 @@ If you need training or technical assistance to implement our solutions, please Ask questions, give your feedback and interact directly with the team building our Hosted Private Cloud services on the dedicated [Discord](https://discord.gg/ovhcloud) channel. -Join our [community of users](/links/community). \ No newline at end of file +Join our [community of users](/links/community). diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.en-gb.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.en-gb.md index e7bcd4d34f4..1635671086d 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.en-gb.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.en-gb.md @@ -1,7 +1,7 @@ --- title: "Technical capabilities and limitations of Public VCF as-a-Service" excerpt: "Learn about the technical capabilities and limitations of Public VCF aaS (aka Public VCF as-a-Service)" -updated: 2025-05-13 +updated: 2025-09-25 --- ## Objective @@ -33,6 +33,7 @@ Before getting started, review the following guides to better understand Public | VMs (per vApp) | 128 | 128 | 128 | Maximum number of VMs allowed per vApp. | | VMs (per organization) | 2000 | 4000 | 4000 | Maximum number of VMs per organization. | | vApps (per organization) | 10,000 | 10,000 | 10,000 | Maximum number of vApps per organization. | +| Segments (per organization) | 40 | 40 | 40 | Maximum number of segments per organization. | > **Note**: When creating a snapshot that includes the VM's memory, storage usage can quickly add up. > For example, if you have 1 VM with 1 GB of RAM and a 10 GB disk, and you create a snapshot that includes memory, your storage usage will be: diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.en-ie.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.en-ie.md index e7bcd4d34f4..98c183b57b3 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.en-ie.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.en-ie.md @@ -1,7 +1,7 @@ --- title: "Technical capabilities and limitations of Public VCF as-a-Service" excerpt: "Learn about the technical capabilities and limitations of Public VCF aaS (aka Public VCF as-a-Service)" -updated: 2025-05-13 +updated: 2025-09-25 --- ## Objective @@ -33,6 +33,7 @@ Before getting started, review the following guides to better understand Public | VMs (per vApp) | 128 | 128 | 128 | Maximum number of VMs allowed per vApp. | | VMs (per organization) | 2000 | 4000 | 4000 | Maximum number of VMs per organization. | | vApps (per organization) | 10,000 | 10,000 | 10,000 | Maximum number of vApps per organization. | +| Segments (per organization) | 40 | 40 | 40 | Maximum number of segments per organization. | > **Note**: When creating a snapshot that includes the VM's memory, storage usage can quickly add up. > For example, if you have 1 VM with 1 GB of RAM and a 10 GB disk, and you create a snapshot that includes memory, your storage usage will be: @@ -67,4 +68,4 @@ If you need training or technical assistance to implement our solutions, please Ask questions, give your feedback and interact directly with the team building our Hosted Private Cloud services on the dedicated [Discord](https://discord.gg/ovhcloud) channel. -Join our [community of users](/links/community). \ No newline at end of file +Join our [community of users](/links/community). diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.en-sg.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.en-sg.md index e7bcd4d34f4..98c183b57b3 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.en-sg.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.en-sg.md @@ -1,7 +1,7 @@ --- title: "Technical capabilities and limitations of Public VCF as-a-Service" excerpt: "Learn about the technical capabilities and limitations of Public VCF aaS (aka Public VCF as-a-Service)" -updated: 2025-05-13 +updated: 2025-09-25 --- ## Objective @@ -33,6 +33,7 @@ Before getting started, review the following guides to better understand Public | VMs (per vApp) | 128 | 128 | 128 | Maximum number of VMs allowed per vApp. | | VMs (per organization) | 2000 | 4000 | 4000 | Maximum number of VMs per organization. | | vApps (per organization) | 10,000 | 10,000 | 10,000 | Maximum number of vApps per organization. | +| Segments (per organization) | 40 | 40 | 40 | Maximum number of segments per organization. | > **Note**: When creating a snapshot that includes the VM's memory, storage usage can quickly add up. > For example, if you have 1 VM with 1 GB of RAM and a 10 GB disk, and you create a snapshot that includes memory, your storage usage will be: @@ -67,4 +68,4 @@ If you need training or technical assistance to implement our solutions, please Ask questions, give your feedback and interact directly with the team building our Hosted Private Cloud services on the dedicated [Discord](https://discord.gg/ovhcloud) channel. -Join our [community of users](/links/community). \ No newline at end of file +Join our [community of users](/links/community). diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.en-us.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.en-us.md index e7bcd4d34f4..98c183b57b3 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.en-us.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.en-us.md @@ -1,7 +1,7 @@ --- title: "Technical capabilities and limitations of Public VCF as-a-Service" excerpt: "Learn about the technical capabilities and limitations of Public VCF aaS (aka Public VCF as-a-Service)" -updated: 2025-05-13 +updated: 2025-09-25 --- ## Objective @@ -33,6 +33,7 @@ Before getting started, review the following guides to better understand Public | VMs (per vApp) | 128 | 128 | 128 | Maximum number of VMs allowed per vApp. | | VMs (per organization) | 2000 | 4000 | 4000 | Maximum number of VMs per organization. | | vApps (per organization) | 10,000 | 10,000 | 10,000 | Maximum number of vApps per organization. | +| Segments (per organization) | 40 | 40 | 40 | Maximum number of segments per organization. | > **Note**: When creating a snapshot that includes the VM's memory, storage usage can quickly add up. > For example, if you have 1 VM with 1 GB of RAM and a 10 GB disk, and you create a snapshot that includes memory, your storage usage will be: @@ -67,4 +68,4 @@ If you need training or technical assistance to implement our solutions, please Ask questions, give your feedback and interact directly with the team building our Hosted Private Cloud services on the dedicated [Discord](https://discord.gg/ovhcloud) channel. -Join our [community of users](/links/community). \ No newline at end of file +Join our [community of users](/links/community). diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.es-es.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.es-es.md index e7bcd4d34f4..98c183b57b3 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.es-es.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.es-es.md @@ -1,7 +1,7 @@ --- title: "Technical capabilities and limitations of Public VCF as-a-Service" excerpt: "Learn about the technical capabilities and limitations of Public VCF aaS (aka Public VCF as-a-Service)" -updated: 2025-05-13 +updated: 2025-09-25 --- ## Objective @@ -33,6 +33,7 @@ Before getting started, review the following guides to better understand Public | VMs (per vApp) | 128 | 128 | 128 | Maximum number of VMs allowed per vApp. | | VMs (per organization) | 2000 | 4000 | 4000 | Maximum number of VMs per organization. | | vApps (per organization) | 10,000 | 10,000 | 10,000 | Maximum number of vApps per organization. | +| Segments (per organization) | 40 | 40 | 40 | Maximum number of segments per organization. | > **Note**: When creating a snapshot that includes the VM's memory, storage usage can quickly add up. > For example, if you have 1 VM with 1 GB of RAM and a 10 GB disk, and you create a snapshot that includes memory, your storage usage will be: @@ -67,4 +68,4 @@ If you need training or technical assistance to implement our solutions, please Ask questions, give your feedback and interact directly with the team building our Hosted Private Cloud services on the dedicated [Discord](https://discord.gg/ovhcloud) channel. -Join our [community of users](/links/community). \ No newline at end of file +Join our [community of users](/links/community). diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.es-us.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.es-us.md index e7bcd4d34f4..98c183b57b3 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.es-us.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.es-us.md @@ -1,7 +1,7 @@ --- title: "Technical capabilities and limitations of Public VCF as-a-Service" excerpt: "Learn about the technical capabilities and limitations of Public VCF aaS (aka Public VCF as-a-Service)" -updated: 2025-05-13 +updated: 2025-09-25 --- ## Objective @@ -33,6 +33,7 @@ Before getting started, review the following guides to better understand Public | VMs (per vApp) | 128 | 128 | 128 | Maximum number of VMs allowed per vApp. | | VMs (per organization) | 2000 | 4000 | 4000 | Maximum number of VMs per organization. | | vApps (per organization) | 10,000 | 10,000 | 10,000 | Maximum number of vApps per organization. | +| Segments (per organization) | 40 | 40 | 40 | Maximum number of segments per organization. | > **Note**: When creating a snapshot that includes the VM's memory, storage usage can quickly add up. > For example, if you have 1 VM with 1 GB of RAM and a 10 GB disk, and you create a snapshot that includes memory, your storage usage will be: @@ -67,4 +68,4 @@ If you need training or technical assistance to implement our solutions, please Ask questions, give your feedback and interact directly with the team building our Hosted Private Cloud services on the dedicated [Discord](https://discord.gg/ovhcloud) channel. -Join our [community of users](/links/community). \ No newline at end of file +Join our [community of users](/links/community). diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.fr-ca.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.fr-ca.md index 6632ca70fbe..77ba3b93c02 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.fr-ca.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.fr-ca.md @@ -1,7 +1,7 @@ --- title: "Capacités techniques et limites de Public VCF as-a-Service" excerpt: "Découvrez les capacités techniques et les limites de Public VCF aaS (alias Public VCF as-a-Service)" -updated: 2025-05-13 +updated: 2025-09-25 --- ## Objectif @@ -32,6 +32,7 @@ Avant de commencer, consultez les guides suivants pour mieux comprendre Public V | VMs (par vApp) | 128 | 128 | 128 | Nombre maximal de VMs autorisées par vApp. | | VMs (par organisation) | 2000 | 4000 | 4000 | Nombre maximal de VMs par organisation. | | vApps (par organisation) | 10 000 | 10 000 | 10 000 | Nombre maximal de vApps par organisation. | +| Segments (par organisation) | 40 | 40 | 40 | Nombre maximal de segments par organisation. | > **Remarque** : Lorsqu’un snapshot inclut la mémoire de la machine virtuelle, l’utilisation du stockage peut rapidement augmenter. > Par exemple, si vous avez une VM avec 1 Go de RAM et un disque de 10 Go, et que vous créez un snapshot incluant la mémoire, l’espace de stockage utilisé sera le suivant : @@ -66,4 +67,4 @@ Si vous avez besoin d'une formation ou d'une assistance technique pour la mise e Posez vos questions, donnez votre avis et échangez directement avec l’équipe en charge des services Hosted Private Cloud sur notre canal [Discord](https://discord.gg/ovhcloud). -Échangez avec notre [communauté d'utilisateurs](/links/community). \ No newline at end of file +Échangez avec notre [communauté d'utilisateurs](/links/community). diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.fr-fr.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.fr-fr.md index 6632ca70fbe..77ba3b93c02 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.fr-fr.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.fr-fr.md @@ -1,7 +1,7 @@ --- title: "Capacités techniques et limites de Public VCF as-a-Service" excerpt: "Découvrez les capacités techniques et les limites de Public VCF aaS (alias Public VCF as-a-Service)" -updated: 2025-05-13 +updated: 2025-09-25 --- ## Objectif @@ -32,6 +32,7 @@ Avant de commencer, consultez les guides suivants pour mieux comprendre Public V | VMs (par vApp) | 128 | 128 | 128 | Nombre maximal de VMs autorisées par vApp. | | VMs (par organisation) | 2000 | 4000 | 4000 | Nombre maximal de VMs par organisation. | | vApps (par organisation) | 10 000 | 10 000 | 10 000 | Nombre maximal de vApps par organisation. | +| Segments (par organisation) | 40 | 40 | 40 | Nombre maximal de segments par organisation. | > **Remarque** : Lorsqu’un snapshot inclut la mémoire de la machine virtuelle, l’utilisation du stockage peut rapidement augmenter. > Par exemple, si vous avez une VM avec 1 Go de RAM et un disque de 10 Go, et que vous créez un snapshot incluant la mémoire, l’espace de stockage utilisé sera le suivant : @@ -66,4 +67,4 @@ Si vous avez besoin d'une formation ou d'une assistance technique pour la mise e Posez vos questions, donnez votre avis et échangez directement avec l’équipe en charge des services Hosted Private Cloud sur notre canal [Discord](https://discord.gg/ovhcloud). -Échangez avec notre [communauté d'utilisateurs](/links/community). \ No newline at end of file +Échangez avec notre [communauté d'utilisateurs](/links/community). diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.it-it.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.it-it.md index e7bcd4d34f4..98c183b57b3 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.it-it.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.it-it.md @@ -1,7 +1,7 @@ --- title: "Technical capabilities and limitations of Public VCF as-a-Service" excerpt: "Learn about the technical capabilities and limitations of Public VCF aaS (aka Public VCF as-a-Service)" -updated: 2025-05-13 +updated: 2025-09-25 --- ## Objective @@ -33,6 +33,7 @@ Before getting started, review the following guides to better understand Public | VMs (per vApp) | 128 | 128 | 128 | Maximum number of VMs allowed per vApp. | | VMs (per organization) | 2000 | 4000 | 4000 | Maximum number of VMs per organization. | | vApps (per organization) | 10,000 | 10,000 | 10,000 | Maximum number of vApps per organization. | +| Segments (per organization) | 40 | 40 | 40 | Maximum number of segments per organization. | > **Note**: When creating a snapshot that includes the VM's memory, storage usage can quickly add up. > For example, if you have 1 VM with 1 GB of RAM and a 10 GB disk, and you create a snapshot that includes memory, your storage usage will be: @@ -67,4 +68,4 @@ If you need training or technical assistance to implement our solutions, please Ask questions, give your feedback and interact directly with the team building our Hosted Private Cloud services on the dedicated [Discord](https://discord.gg/ovhcloud) channel. -Join our [community of users](/links/community). \ No newline at end of file +Join our [community of users](/links/community). diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.pl-pl.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.pl-pl.md index e7bcd4d34f4..98c183b57b3 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.pl-pl.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.pl-pl.md @@ -1,7 +1,7 @@ --- title: "Technical capabilities and limitations of Public VCF as-a-Service" excerpt: "Learn about the technical capabilities and limitations of Public VCF aaS (aka Public VCF as-a-Service)" -updated: 2025-05-13 +updated: 2025-09-25 --- ## Objective @@ -33,6 +33,7 @@ Before getting started, review the following guides to better understand Public | VMs (per vApp) | 128 | 128 | 128 | Maximum number of VMs allowed per vApp. | | VMs (per organization) | 2000 | 4000 | 4000 | Maximum number of VMs per organization. | | vApps (per organization) | 10,000 | 10,000 | 10,000 | Maximum number of vApps per organization. | +| Segments (per organization) | 40 | 40 | 40 | Maximum number of segments per organization. | > **Note**: When creating a snapshot that includes the VM's memory, storage usage can quickly add up. > For example, if you have 1 VM with 1 GB of RAM and a 10 GB disk, and you create a snapshot that includes memory, your storage usage will be: @@ -67,4 +68,4 @@ If you need training or technical assistance to implement our solutions, please Ask questions, give your feedback and interact directly with the team building our Hosted Private Cloud services on the dedicated [Discord](https://discord.gg/ovhcloud) channel. -Join our [community of users](/links/community). \ No newline at end of file +Join our [community of users](/links/community). diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.pt-pt.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.pt-pt.md index e7bcd4d34f4..98c183b57b3 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.pt-pt.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd-limitations/guide.pt-pt.md @@ -1,7 +1,7 @@ --- title: "Technical capabilities and limitations of Public VCF as-a-Service" excerpt: "Learn about the technical capabilities and limitations of Public VCF aaS (aka Public VCF as-a-Service)" -updated: 2025-05-13 +updated: 2025-09-25 --- ## Objective @@ -33,6 +33,7 @@ Before getting started, review the following guides to better understand Public | VMs (per vApp) | 128 | 128 | 128 | Maximum number of VMs allowed per vApp. | | VMs (per organization) | 2000 | 4000 | 4000 | Maximum number of VMs per organization. | | vApps (per organization) | 10,000 | 10,000 | 10,000 | Maximum number of vApps per organization. | +| Segments (per organization) | 40 | 40 | 40 | Maximum number of segments per organization. | > **Note**: When creating a snapshot that includes the VM's memory, storage usage can quickly add up. > For example, if you have 1 VM with 1 GB of RAM and a 10 GB disk, and you create a snapshot that includes memory, your storage usage will be: @@ -67,4 +68,4 @@ If you need training or technical assistance to implement our solutions, please Ask questions, give your feedback and interact directly with the team building our Hosted Private Cloud services on the dedicated [Discord](https://discord.gg/ovhcloud) channel. -Join our [community of users](/links/community). \ No newline at end of file +Join our [community of users](/links/community). diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.de-de.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.de-de.md index 408d1467967..fef5746b8e6 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.de-de.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.de-de.md @@ -65,12 +65,12 @@ Migrations will be carried out in 4 waves, from november 2024, depending on the The planned schedule, which is compatible with these environments during the migration, is as follows: -| **Waves**     | **From** | **Target
Offers** | **NSX** | **vRack** | **Microsoft
(SPLA)** | **Summary of migration compatible environments** | +| **Waves**     | **From** | **Target
Offers** | **Microsoft
(SPLA)** | **vRack** | **NSX** | **Summary of migration compatible environments** | |:---------------------------------:|:----------------------------------:|:---------------------:|:----------:|:-----------:|:-------------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------| -| `Wave 1` | **January 2025
February 2025** | `Standard` | ❌ | ❌ | ❌ | - **Without** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX
- **Without** High performance storage (vSAN) | -| `Wave 2` | **Mid-May 2025** | `Standard` | ❌ | ❌ | ✅ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX
- **Without** High performance storage (vSAN) | -| `Wave 3` | **Mid-June 2025** | `Advanced` | ❌ | ❌ | ✅ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX
- **Without** High performance storage (vSAN) | -| `Wave 4` | **May 2025** | `Premium` | ✅ | ✅ | ✅ | - **With** Microsoft Windows license (SPLA) provided by OVHcloud
- **With** NSX + vRack support
- **With** High performance storage (vSAN) | +| `Wave 1` | **January 2025
February 2025** | `Standard` | ❌ | ❌ | ❌ | - **Without** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX | +| `Wave 2` | **Mid-May 2025** | `Standard` | ✅ | ❌ | ❌ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX | +| `Wave 3` | **December 2025** | `Standard` | ✅ | ✅ | ❌ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **With** vRack
- **Without** NSX | +| `Wave 4` | **End of
February 2026** | `Advanced` | ✅ | ✅ | ✅ | - **With** Microsoft Windows license (SPLA) provided by OVHcloud
- **With** vRack
- **With** NSX | During this process, your data will remain unchanged, except for vSAN Storage. Your IP addresses will also remain unchanged. diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.en-asia.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.en-asia.md index a0918a32e0d..36fc1b5eb4a 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.en-asia.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.en-asia.md @@ -65,12 +65,12 @@ Migrations will be carried out in 4 waves, from november 2024, depending on the The planned schedule, which is compatible with these environments during the migration, is as follows: -| **Waves**     | **From** | **Target
Offers** | **NSX** | **vRack** | **Microsoft
(SPLA)** | **Summary of migration compatible environments** | +| **Waves**     | **From** | **Target
Offers** | **Microsoft
(SPLA)** | **vRack** | **NSX** | **Summary of migration compatible environments** | |:---------------------------------:|:----------------------------------:|:---------------------:|:----------:|:-----------:|:-------------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------| -| `Wave 1` | **January 2025
February 2025** | `Standard` | ❌ | ❌ | ❌ | - **Without** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX
- **Without** High performance storage (vSAN) | -| `Wave 2` | **Mid-May 2025** | `Standard` | ❌ | ❌ | ✅ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX
- **Without** High performance storage (vSAN) | -| `Wave 3` | **Mid-June 2025** | `Advanced` | ❌ | ❌ | ✅ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX
- **Without** High performance storage (vSAN) | -| `Wave 4` | **May 2025** | `Premium` | ✅ | ✅ | ✅ | - **With** Microsoft Windows license (SPLA) provided by OVHcloud
- **With** NSX + vRack support
- **With** High performance storage (vSAN) | +| `Wave 1` | **January 2025
February 2025** | `Standard` | ❌ | ❌ | ❌ | - **Without** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX | +| `Wave 2` | **Mid-May 2025** | `Standard` | ✅ | ❌ | ❌ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX | +| `Wave 3` | **December 2025** | `Standard` | ✅ | ✅ | ❌ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **With** vRack
- **Without** NSX | +| `Wave 4` | **End of
February 2026** | `Advanced` | ✅ | ✅ | ✅ | - **With** Microsoft Windows license (SPLA) provided by OVHcloud
- **With** vRack
- **With** NSX | During this process, your data will remain unchanged, except for vSAN Storage. Your IP addresses will also remain unchanged. diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.en-au.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.en-au.md index a0918a32e0d..36fc1b5eb4a 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.en-au.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.en-au.md @@ -65,12 +65,12 @@ Migrations will be carried out in 4 waves, from november 2024, depending on the The planned schedule, which is compatible with these environments during the migration, is as follows: -| **Waves**     | **From** | **Target
Offers** | **NSX** | **vRack** | **Microsoft
(SPLA)** | **Summary of migration compatible environments** | +| **Waves**     | **From** | **Target
Offers** | **Microsoft
(SPLA)** | **vRack** | **NSX** | **Summary of migration compatible environments** | |:---------------------------------:|:----------------------------------:|:---------------------:|:----------:|:-----------:|:-------------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------| -| `Wave 1` | **January 2025
February 2025** | `Standard` | ❌ | ❌ | ❌ | - **Without** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX
- **Without** High performance storage (vSAN) | -| `Wave 2` | **Mid-May 2025** | `Standard` | ❌ | ❌ | ✅ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX
- **Without** High performance storage (vSAN) | -| `Wave 3` | **Mid-June 2025** | `Advanced` | ❌ | ❌ | ✅ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX
- **Without** High performance storage (vSAN) | -| `Wave 4` | **May 2025** | `Premium` | ✅ | ✅ | ✅ | - **With** Microsoft Windows license (SPLA) provided by OVHcloud
- **With** NSX + vRack support
- **With** High performance storage (vSAN) | +| `Wave 1` | **January 2025
February 2025** | `Standard` | ❌ | ❌ | ❌ | - **Without** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX | +| `Wave 2` | **Mid-May 2025** | `Standard` | ✅ | ❌ | ❌ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX | +| `Wave 3` | **December 2025** | `Standard` | ✅ | ✅ | ❌ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **With** vRack
- **Without** NSX | +| `Wave 4` | **End of
February 2026** | `Advanced` | ✅ | ✅ | ✅ | - **With** Microsoft Windows license (SPLA) provided by OVHcloud
- **With** vRack
- **With** NSX | During this process, your data will remain unchanged, except for vSAN Storage. Your IP addresses will also remain unchanged. diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.en-ca.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.en-ca.md index a0918a32e0d..36fc1b5eb4a 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.en-ca.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.en-ca.md @@ -65,12 +65,12 @@ Migrations will be carried out in 4 waves, from november 2024, depending on the The planned schedule, which is compatible with these environments during the migration, is as follows: -| **Waves**     | **From** | **Target
Offers** | **NSX** | **vRack** | **Microsoft
(SPLA)** | **Summary of migration compatible environments** | +| **Waves**     | **From** | **Target
Offers** | **Microsoft
(SPLA)** | **vRack** | **NSX** | **Summary of migration compatible environments** | |:---------------------------------:|:----------------------------------:|:---------------------:|:----------:|:-----------:|:-------------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------| -| `Wave 1` | **January 2025
February 2025** | `Standard` | ❌ | ❌ | ❌ | - **Without** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX
- **Without** High performance storage (vSAN) | -| `Wave 2` | **Mid-May 2025** | `Standard` | ❌ | ❌ | ✅ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX
- **Without** High performance storage (vSAN) | -| `Wave 3` | **Mid-June 2025** | `Advanced` | ❌ | ❌ | ✅ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX
- **Without** High performance storage (vSAN) | -| `Wave 4` | **May 2025** | `Premium` | ✅ | ✅ | ✅ | - **With** Microsoft Windows license (SPLA) provided by OVHcloud
- **With** NSX + vRack support
- **With** High performance storage (vSAN) | +| `Wave 1` | **January 2025
February 2025** | `Standard` | ❌ | ❌ | ❌ | - **Without** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX | +| `Wave 2` | **Mid-May 2025** | `Standard` | ✅ | ❌ | ❌ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX | +| `Wave 3` | **December 2025** | `Standard` | ✅ | ✅ | ❌ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **With** vRack
- **Without** NSX | +| `Wave 4` | **End of
February 2026** | `Advanced` | ✅ | ✅ | ✅ | - **With** Microsoft Windows license (SPLA) provided by OVHcloud
- **With** vRack
- **With** NSX | During this process, your data will remain unchanged, except for vSAN Storage. Your IP addresses will also remain unchanged. diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.en-gb.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.en-gb.md index 408d1467967..fef5746b8e6 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.en-gb.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.en-gb.md @@ -65,12 +65,12 @@ Migrations will be carried out in 4 waves, from november 2024, depending on the The planned schedule, which is compatible with these environments during the migration, is as follows: -| **Waves**     | **From** | **Target
Offers** | **NSX** | **vRack** | **Microsoft
(SPLA)** | **Summary of migration compatible environments** | +| **Waves**     | **From** | **Target
Offers** | **Microsoft
(SPLA)** | **vRack** | **NSX** | **Summary of migration compatible environments** | |:---------------------------------:|:----------------------------------:|:---------------------:|:----------:|:-----------:|:-------------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------| -| `Wave 1` | **January 2025
February 2025** | `Standard` | ❌ | ❌ | ❌ | - **Without** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX
- **Without** High performance storage (vSAN) | -| `Wave 2` | **Mid-May 2025** | `Standard` | ❌ | ❌ | ✅ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX
- **Without** High performance storage (vSAN) | -| `Wave 3` | **Mid-June 2025** | `Advanced` | ❌ | ❌ | ✅ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX
- **Without** High performance storage (vSAN) | -| `Wave 4` | **May 2025** | `Premium` | ✅ | ✅ | ✅ | - **With** Microsoft Windows license (SPLA) provided by OVHcloud
- **With** NSX + vRack support
- **With** High performance storage (vSAN) | +| `Wave 1` | **January 2025
February 2025** | `Standard` | ❌ | ❌ | ❌ | - **Without** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX | +| `Wave 2` | **Mid-May 2025** | `Standard` | ✅ | ❌ | ❌ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX | +| `Wave 3` | **December 2025** | `Standard` | ✅ | ✅ | ❌ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **With** vRack
- **Without** NSX | +| `Wave 4` | **End of
February 2026** | `Advanced` | ✅ | ✅ | ✅ | - **With** Microsoft Windows license (SPLA) provided by OVHcloud
- **With** vRack
- **With** NSX | During this process, your data will remain unchanged, except for vSAN Storage. Your IP addresses will also remain unchanged. diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.en-ie.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.en-ie.md index 408d1467967..fef5746b8e6 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.en-ie.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.en-ie.md @@ -65,12 +65,12 @@ Migrations will be carried out in 4 waves, from november 2024, depending on the The planned schedule, which is compatible with these environments during the migration, is as follows: -| **Waves**     | **From** | **Target
Offers** | **NSX** | **vRack** | **Microsoft
(SPLA)** | **Summary of migration compatible environments** | +| **Waves**     | **From** | **Target
Offers** | **Microsoft
(SPLA)** | **vRack** | **NSX** | **Summary of migration compatible environments** | |:---------------------------------:|:----------------------------------:|:---------------------:|:----------:|:-----------:|:-------------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------| -| `Wave 1` | **January 2025
February 2025** | `Standard` | ❌ | ❌ | ❌ | - **Without** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX
- **Without** High performance storage (vSAN) | -| `Wave 2` | **Mid-May 2025** | `Standard` | ❌ | ❌ | ✅ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX
- **Without** High performance storage (vSAN) | -| `Wave 3` | **Mid-June 2025** | `Advanced` | ❌ | ❌ | ✅ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX
- **Without** High performance storage (vSAN) | -| `Wave 4` | **May 2025** | `Premium` | ✅ | ✅ | ✅ | - **With** Microsoft Windows license (SPLA) provided by OVHcloud
- **With** NSX + vRack support
- **With** High performance storage (vSAN) | +| `Wave 1` | **January 2025
February 2025** | `Standard` | ❌ | ❌ | ❌ | - **Without** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX | +| `Wave 2` | **Mid-May 2025** | `Standard` | ✅ | ❌ | ❌ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX | +| `Wave 3` | **December 2025** | `Standard` | ✅ | ✅ | ❌ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **With** vRack
- **Without** NSX | +| `Wave 4` | **End of
February 2026** | `Advanced` | ✅ | ✅ | ✅ | - **With** Microsoft Windows license (SPLA) provided by OVHcloud
- **With** vRack
- **With** NSX | During this process, your data will remain unchanged, except for vSAN Storage. Your IP addresses will also remain unchanged. diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.en-sg.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.en-sg.md index a0918a32e0d..36fc1b5eb4a 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.en-sg.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.en-sg.md @@ -65,12 +65,12 @@ Migrations will be carried out in 4 waves, from november 2024, depending on the The planned schedule, which is compatible with these environments during the migration, is as follows: -| **Waves**     | **From** | **Target
Offers** | **NSX** | **vRack** | **Microsoft
(SPLA)** | **Summary of migration compatible environments** | +| **Waves**     | **From** | **Target
Offers** | **Microsoft
(SPLA)** | **vRack** | **NSX** | **Summary of migration compatible environments** | |:---------------------------------:|:----------------------------------:|:---------------------:|:----------:|:-----------:|:-------------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------| -| `Wave 1` | **January 2025
February 2025** | `Standard` | ❌ | ❌ | ❌ | - **Without** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX
- **Without** High performance storage (vSAN) | -| `Wave 2` | **Mid-May 2025** | `Standard` | ❌ | ❌ | ✅ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX
- **Without** High performance storage (vSAN) | -| `Wave 3` | **Mid-June 2025** | `Advanced` | ❌ | ❌ | ✅ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX
- **Without** High performance storage (vSAN) | -| `Wave 4` | **May 2025** | `Premium` | ✅ | ✅ | ✅ | - **With** Microsoft Windows license (SPLA) provided by OVHcloud
- **With** NSX + vRack support
- **With** High performance storage (vSAN) | +| `Wave 1` | **January 2025
February 2025** | `Standard` | ❌ | ❌ | ❌ | - **Without** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX | +| `Wave 2` | **Mid-May 2025** | `Standard` | ✅ | ❌ | ❌ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX | +| `Wave 3` | **December 2025** | `Standard` | ✅ | ✅ | ❌ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **With** vRack
- **Without** NSX | +| `Wave 4` | **End of
February 2026** | `Advanced` | ✅ | ✅ | ✅ | - **With** Microsoft Windows license (SPLA) provided by OVHcloud
- **With** vRack
- **With** NSX | During this process, your data will remain unchanged, except for vSAN Storage. Your IP addresses will also remain unchanged. diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.en-us.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.en-us.md index a0918a32e0d..36fc1b5eb4a 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.en-us.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.en-us.md @@ -65,12 +65,12 @@ Migrations will be carried out in 4 waves, from november 2024, depending on the The planned schedule, which is compatible with these environments during the migration, is as follows: -| **Waves**     | **From** | **Target
Offers** | **NSX** | **vRack** | **Microsoft
(SPLA)** | **Summary of migration compatible environments** | +| **Waves**     | **From** | **Target
Offers** | **Microsoft
(SPLA)** | **vRack** | **NSX** | **Summary of migration compatible environments** | |:---------------------------------:|:----------------------------------:|:---------------------:|:----------:|:-----------:|:-------------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------| -| `Wave 1` | **January 2025
February 2025** | `Standard` | ❌ | ❌ | ❌ | - **Without** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX
- **Without** High performance storage (vSAN) | -| `Wave 2` | **Mid-May 2025** | `Standard` | ❌ | ❌ | ✅ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX
- **Without** High performance storage (vSAN) | -| `Wave 3` | **Mid-June 2025** | `Advanced` | ❌ | ❌ | ✅ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX
- **Without** High performance storage (vSAN) | -| `Wave 4` | **May 2025** | `Premium` | ✅ | ✅ | ✅ | - **With** Microsoft Windows license (SPLA) provided by OVHcloud
- **With** NSX + vRack support
- **With** High performance storage (vSAN) | +| `Wave 1` | **January 2025
February 2025** | `Standard` | ❌ | ❌ | ❌ | - **Without** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX | +| `Wave 2` | **Mid-May 2025** | `Standard` | ✅ | ❌ | ❌ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX | +| `Wave 3` | **December 2025** | `Standard` | ✅ | ✅ | ❌ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **With** vRack
- **Without** NSX | +| `Wave 4` | **End of
February 2026** | `Advanced` | ✅ | ✅ | ✅ | - **With** Microsoft Windows license (SPLA) provided by OVHcloud
- **With** vRack
- **With** NSX | During this process, your data will remain unchanged, except for vSAN Storage. Your IP addresses will also remain unchanged. diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.es-es.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.es-es.md index 408d1467967..fef5746b8e6 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.es-es.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.es-es.md @@ -65,12 +65,12 @@ Migrations will be carried out in 4 waves, from november 2024, depending on the The planned schedule, which is compatible with these environments during the migration, is as follows: -| **Waves**     | **From** | **Target
Offers** | **NSX** | **vRack** | **Microsoft
(SPLA)** | **Summary of migration compatible environments** | +| **Waves**     | **From** | **Target
Offers** | **Microsoft
(SPLA)** | **vRack** | **NSX** | **Summary of migration compatible environments** | |:---------------------------------:|:----------------------------------:|:---------------------:|:----------:|:-----------:|:-------------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------| -| `Wave 1` | **January 2025
February 2025** | `Standard` | ❌ | ❌ | ❌ | - **Without** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX
- **Without** High performance storage (vSAN) | -| `Wave 2` | **Mid-May 2025** | `Standard` | ❌ | ❌ | ✅ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX
- **Without** High performance storage (vSAN) | -| `Wave 3` | **Mid-June 2025** | `Advanced` | ❌ | ❌ | ✅ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX
- **Without** High performance storage (vSAN) | -| `Wave 4` | **May 2025** | `Premium` | ✅ | ✅ | ✅ | - **With** Microsoft Windows license (SPLA) provided by OVHcloud
- **With** NSX + vRack support
- **With** High performance storage (vSAN) | +| `Wave 1` | **January 2025
February 2025** | `Standard` | ❌ | ❌ | ❌ | - **Without** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX | +| `Wave 2` | **Mid-May 2025** | `Standard` | ✅ | ❌ | ❌ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX | +| `Wave 3` | **December 2025** | `Standard` | ✅ | ✅ | ❌ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **With** vRack
- **Without** NSX | +| `Wave 4` | **End of
February 2026** | `Advanced` | ✅ | ✅ | ✅ | - **With** Microsoft Windows license (SPLA) provided by OVHcloud
- **With** vRack
- **With** NSX | During this process, your data will remain unchanged, except for vSAN Storage. Your IP addresses will also remain unchanged. diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.es-us.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.es-us.md index a0918a32e0d..36fc1b5eb4a 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.es-us.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.es-us.md @@ -65,12 +65,12 @@ Migrations will be carried out in 4 waves, from november 2024, depending on the The planned schedule, which is compatible with these environments during the migration, is as follows: -| **Waves**     | **From** | **Target
Offers** | **NSX** | **vRack** | **Microsoft
(SPLA)** | **Summary of migration compatible environments** | +| **Waves**     | **From** | **Target
Offers** | **Microsoft
(SPLA)** | **vRack** | **NSX** | **Summary of migration compatible environments** | |:---------------------------------:|:----------------------------------:|:---------------------:|:----------:|:-----------:|:-------------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------| -| `Wave 1` | **January 2025
February 2025** | `Standard` | ❌ | ❌ | ❌ | - **Without** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX
- **Without** High performance storage (vSAN) | -| `Wave 2` | **Mid-May 2025** | `Standard` | ❌ | ❌ | ✅ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX
- **Without** High performance storage (vSAN) | -| `Wave 3` | **Mid-June 2025** | `Advanced` | ❌ | ❌ | ✅ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX
- **Without** High performance storage (vSAN) | -| `Wave 4` | **May 2025** | `Premium` | ✅ | ✅ | ✅ | - **With** Microsoft Windows license (SPLA) provided by OVHcloud
- **With** NSX + vRack support
- **With** High performance storage (vSAN) | +| `Wave 1` | **January 2025
February 2025** | `Standard` | ❌ | ❌ | ❌ | - **Without** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX | +| `Wave 2` | **Mid-May 2025** | `Standard` | ✅ | ❌ | ❌ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX | +| `Wave 3` | **December 2025** | `Standard` | ✅ | ✅ | ❌ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **With** vRack
- **Without** NSX | +| `Wave 4` | **End of
February 2026** | `Advanced` | ✅ | ✅ | ✅ | - **With** Microsoft Windows license (SPLA) provided by OVHcloud
- **With** vRack
- **With** NSX | During this process, your data will remain unchanged, except for vSAN Storage. Your IP addresses will also remain unchanged. diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.fr-ca.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.fr-ca.md index ee79e2f33d7..7fd725f391d 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.fr-ca.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.fr-ca.md @@ -65,12 +65,12 @@ Les migrations seront effectuées en 4 vagues, à partir du mois de novembre 202 Le calendrier prévisionnel, compatible avec ces environnements lors de la migration, est le suivant : -| **Vagues**    ;  | **A partir de** | **Offre
cible** | **NSX** | **vRack** | **Microsoft
(SPLA)** | **Résumé des environnements compatibles avec la migration** | +| **Vagues**    ;  | **A partir de** | **Offre
cible** | **Microsoft
(SPLA)** | **vRack** | **NSX** | **Résumé des environnements compatibles avec la migration** | |:-----------------------------------------:|:-----------------------------:|:-------------------:|:-------:|:---------:|:------------------------:|:------------------------------------------------------------------------------------------------------------------------------------------------------| -| `Vague 1` | **Janvier 2025
Février 2025** | `Standard` | ❌ | ❌ | ❌ | - **Sans** licence VM Microsoft Windows (SPLA) fournie par OVHcloud
- **Sans** NSX
- **Sans** High performance storage (vSAN) | -| `Vague 2` | **Mi-Mai 2025** | `Standard` | ❌ | ❌ | ✅ | - **Avec** licence VM Microsoft Windows (SPLA) fournie par OVHcloud
- **Sans** NSX
- **Sans** High performance storage (vSAN) | -| `Vague 3` | **Mi-Juin 2025** | `Advanced` | ❌ | ❌ | ✅ | - **Avec** licence VM Microsoft Windows (SPLA) fournie par OVHcloud
- **Sans** NSX
- **Sans** High performance storage (vSAN) | -| `Vague 4` | **Mai 2025** | `Premium` | ✅ | ✅ | ✅ | - **Avec** licence Microsoft Windows (SPLA) fournie par OVHcloud
- **Avec** NSX + vRack support
- **Avec** High performance storage (vSAN) | +| `Vague 1` | **Janvier 2025
Février 2025** | `Standard` | ❌ | ❌ | ❌ | - **Sans** licence VM Microsoft Windows (SPLA) fournie par OVHcloud
- **Sans** NSX | +| `Vague 2` | **Mi-Mai 2025** | `Standard` | ✅ | ❌ | ❌ | - **Avec** licence VM Microsoft Windows (SPLA) fournie par OVHcloud
- **Sans** NSX | +| `Vague 3` | **Décembre 2025** | `Standard` | ✅ | ✅ | ❌ | - **Avec** licence VM Microsoft Windows (SPLA) fournie par OVHcloud
- **Avec** vRack
- **Sans** NSX | +| `Vague 4` | **Fin
Février 2026** | `Advanced` | ✅ | ✅ | ✅ | - **Avec** licence Microsoft Windows (SPLA) fournie par OVHcloud
- **Avec** vRack
- **Avec** NSX | Au cours de ce processus, vos données resteront inchangées, à l'exception du vSAN Storage. Vos adresses IP resteront inchangées également. diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.fr-fr.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.fr-fr.md index 6e61a856733..a86bcae72fa 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.fr-fr.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.fr-fr.md @@ -65,12 +65,12 @@ Les migrations seront effectuées en 4 vagues, à partir du mois de novembre 202 Le calendrier prévisionnel, compatible avec ces environnements lors de la migration, est le suivant : -| **Vagues**    ;  | **A partir de** | **Offre
cible** | **NSX** | **vRack** | **Microsoft
(SPLA)** | **Résumé des environnements compatibles avec la migration** | +| **Vagues**    ;  | **A partir de** | **Offre
cible** | **Microsoft
(SPLA)** | **vRack** | **NSX** | **Résumé des environnements compatibles avec la migration** | |:-----------------------------------------:|:-----------------------------:|:-------------------:|:-------:|:---------:|:------------------------:|:------------------------------------------------------------------------------------------------------------------------------------------------------| -| `Vague 1` | **Janvier 2025
Février 2025** | `Standard` | ❌ | ❌ | ❌ | - **Sans** licence VM Microsoft Windows (SPLA) fournie par OVHcloud
- **Sans** NSX
- **Sans** High performance storage (vSAN) | -| `Vague 2` | **Mi-Mai 2025** | `Standard` | ❌ | ❌ | ✅ | - **Avec** licence VM Microsoft Windows (SPLA) fournie par OVHcloud
- **Sans** NSX
- **Sans** High performance storage (vSAN) | -| `Vague 3` | **Mi-Juin 2025** | `Advanced` | ❌ | ❌ | ✅ | - **Avec** licence VM Microsoft Windows (SPLA) fournie par OVHcloud
- **Sans** NSX
- **Sans** High performance storage (vSAN) | -| `Vague 4` | **Mai 2025** | `Premium` | ✅ | ✅ | ✅ | - **Avec** licence Microsoft Windows (SPLA) fournie par OVHcloud
- **Avec** NSX + vRack support
- **Avec** High performance storage (vSAN) | +| `Vague 1` | **Janvier 2025
Février 2025** | `Standard` | ❌ | ❌ | ❌ | - **Sans** licence VM Microsoft Windows (SPLA) fournie par OVHcloud
- **Sans** NSX | +| `Vague 2` | **Mi-Mai 2025** | `Standard` | ✅ | ❌ | ❌ | - **Avec** licence VM Microsoft Windows (SPLA) fournie par OVHcloud
- **Sans** NSX | +| `Vague 3` | **Décembre 2025** | `Standard` | ✅ | ✅ | ❌ | - **Avec** licence VM Microsoft Windows (SPLA) fournie par OVHcloud
- **Avec** vRack
- **Sans** NSX | +| `Vague 4` | **Fin
Février 2026** | `Advanced` | ✅ | ✅ | ✅ | - **Avec** licence Microsoft Windows (SPLA) fournie par OVHcloud
- **Avec** vRack
- **Avec** NSX | Au cours de ce processus, vos données resteront inchangées, à l'exception du vSAN Storage. Vos adresses IP resteront inchangées également. diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.it-it.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.it-it.md index 408d1467967..fef5746b8e6 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.it-it.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.it-it.md @@ -65,12 +65,12 @@ Migrations will be carried out in 4 waves, from november 2024, depending on the The planned schedule, which is compatible with these environments during the migration, is as follows: -| **Waves**     | **From** | **Target
Offers** | **NSX** | **vRack** | **Microsoft
(SPLA)** | **Summary of migration compatible environments** | +| **Waves**     | **From** | **Target
Offers** | **Microsoft
(SPLA)** | **vRack** | **NSX** | **Summary of migration compatible environments** | |:---------------------------------:|:----------------------------------:|:---------------------:|:----------:|:-----------:|:-------------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------| -| `Wave 1` | **January 2025
February 2025** | `Standard` | ❌ | ❌ | ❌ | - **Without** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX
- **Without** High performance storage (vSAN) | -| `Wave 2` | **Mid-May 2025** | `Standard` | ❌ | ❌ | ✅ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX
- **Without** High performance storage (vSAN) | -| `Wave 3` | **Mid-June 2025** | `Advanced` | ❌ | ❌ | ✅ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX
- **Without** High performance storage (vSAN) | -| `Wave 4` | **May 2025** | `Premium` | ✅ | ✅ | ✅ | - **With** Microsoft Windows license (SPLA) provided by OVHcloud
- **With** NSX + vRack support
- **With** High performance storage (vSAN) | +| `Wave 1` | **January 2025
February 2025** | `Standard` | ❌ | ❌ | ❌ | - **Without** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX | +| `Wave 2` | **Mid-May 2025** | `Standard` | ✅ | ❌ | ❌ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX | +| `Wave 3` | **December 2025** | `Standard` | ✅ | ✅ | ❌ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **With** vRack
- **Without** NSX | +| `Wave 4` | **End of
February 2026** | `Advanced` | ✅ | ✅ | ✅ | - **With** Microsoft Windows license (SPLA) provided by OVHcloud
- **With** vRack
- **With** NSX | During this process, your data will remain unchanged, except for vSAN Storage. Your IP addresses will also remain unchanged. diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.pl-pl.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.pl-pl.md index 408d1467967..fef5746b8e6 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.pl-pl.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.pl-pl.md @@ -65,12 +65,12 @@ Migrations will be carried out in 4 waves, from november 2024, depending on the The planned schedule, which is compatible with these environments during the migration, is as follows: -| **Waves**     | **From** | **Target
Offers** | **NSX** | **vRack** | **Microsoft
(SPLA)** | **Summary of migration compatible environments** | +| **Waves**     | **From** | **Target
Offers** | **Microsoft
(SPLA)** | **vRack** | **NSX** | **Summary of migration compatible environments** | |:---------------------------------:|:----------------------------------:|:---------------------:|:----------:|:-----------:|:-------------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------| -| `Wave 1` | **January 2025
February 2025** | `Standard` | ❌ | ❌ | ❌ | - **Without** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX
- **Without** High performance storage (vSAN) | -| `Wave 2` | **Mid-May 2025** | `Standard` | ❌ | ❌ | ✅ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX
- **Without** High performance storage (vSAN) | -| `Wave 3` | **Mid-June 2025** | `Advanced` | ❌ | ❌ | ✅ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX
- **Without** High performance storage (vSAN) | -| `Wave 4` | **May 2025** | `Premium` | ✅ | ✅ | ✅ | - **With** Microsoft Windows license (SPLA) provided by OVHcloud
- **With** NSX + vRack support
- **With** High performance storage (vSAN) | +| `Wave 1` | **January 2025
February 2025** | `Standard` | ❌ | ❌ | ❌ | - **Without** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX | +| `Wave 2` | **Mid-May 2025** | `Standard` | ✅ | ❌ | ❌ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX | +| `Wave 3` | **December 2025** | `Standard` | ✅ | ✅ | ❌ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **With** vRack
- **Without** NSX | +| `Wave 4` | **End of
February 2026** | `Advanced` | ✅ | ✅ | ✅ | - **With** Microsoft Windows license (SPLA) provided by OVHcloud
- **With** vRack
- **With** NSX | During this process, your data will remain unchanged, except for vSAN Storage. Your IP addresses will also remain unchanged. diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.pt-pt.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.pt-pt.md index 408d1467967..fef5746b8e6 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.pt-pt.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_migration_use-cases/guide.pt-pt.md @@ -65,12 +65,12 @@ Migrations will be carried out in 4 waves, from november 2024, depending on the The planned schedule, which is compatible with these environments during the migration, is as follows: -| **Waves**     | **From** | **Target
Offers** | **NSX** | **vRack** | **Microsoft
(SPLA)** | **Summary of migration compatible environments** | +| **Waves**     | **From** | **Target
Offers** | **Microsoft
(SPLA)** | **vRack** | **NSX** | **Summary of migration compatible environments** | |:---------------------------------:|:----------------------------------:|:---------------------:|:----------:|:-----------:|:-------------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------| -| `Wave 1` | **January 2025
February 2025** | `Standard` | ❌ | ❌ | ❌ | - **Without** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX
- **Without** High performance storage (vSAN) | -| `Wave 2` | **Mid-May 2025** | `Standard` | ❌ | ❌ | ✅ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX
- **Without** High performance storage (vSAN) | -| `Wave 3` | **Mid-June 2025** | `Advanced` | ❌ | ❌ | ✅ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX
- **Without** High performance storage (vSAN) | -| `Wave 4` | **May 2025** | `Premium` | ✅ | ✅ | ✅ | - **With** Microsoft Windows license (SPLA) provided by OVHcloud
- **With** NSX + vRack support
- **With** High performance storage (vSAN) | +| `Wave 1` | **January 2025
February 2025** | `Standard` | ❌ | ❌ | ❌ | - **Without** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX | +| `Wave 2` | **Mid-May 2025** | `Standard` | ✅ | ❌ | ❌ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **Without** NSX | +| `Wave 3` | **December 2025** | `Standard` | ✅ | ✅ | ❌ | - **With** Microsoft Windows VM license (SPLA) provided by OVHcloud
- **With** vRack
- **Without** NSX | +| `Wave 4` | **End of
February 2026** | `Advanced` | ✅ | ✅ | ✅ | - **With** Microsoft Windows license (SPLA) provided by OVHcloud
- **With** vRack
- **With** NSX | During this process, your data will remain unchanged, except for vSAN Storage. Your IP addresses will also remain unchanged. diff --git a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_network_concepts/guide.de-de.md b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_network_concepts/guide.de-de.md index 552f9834004..2303cbfdc3c 100644 --- a/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_network_concepts/guide.de-de.md +++ b/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vcd_network_concepts/guide.de-de.md @@ -1,7 +1,7 @@ --- title: "Public VCF as-a-Service - Network concepts and best practices" excerpt: "Discover the powerful networking capabilities of Public VCF as-a-Service with this comprehensive guide (key concepts and features)" -updated: 2025-03-03 +updated: 2025-11-04 --- -> [!primary] -> IAM for Logs Data Platform will be available starting **17th September 2025**. -> The content of this documentation will be valid from this date. -> - ## Overview -This guide provides instructions for configuring access rights on OVHcloud IAM to manage permissions for various components of Logs Data Platform. It will give you the best practices to handle the rights given to your users and will ensure that you can replicate the functionnality of roles and permissions with the more advanced system of policies. This guide will use features explained in the [IAM documentation](/pages/account_and_service_management/account_information/iam-policy-ui). It is therefore recommended to read it before reading this guide. +This guide provides instructions for configuring access rights on OVHcloud IAM to manage permissions for various components of Logs Data Platform. It will give you the best practices to handle the rights given to your users and will ensure that you can replicate the functionality of roles and permissions with the more advanced system of policies. This guide will use features explained in the [IAM documentation](/pages/account_and_service_management/account_information/iam-policy-ui). It is therefore recommended to read it before reading this guide. ## Requirements @@ -35,7 +30,7 @@ This guide provides instructions for configuring access rights on OVHcloud IAM t ## Policies and identities -This guide leverages [local users](/pages/account_and_service_management/account_information/ovhcloud-users-management) to explain how you can share resources to another user. This choice has been done to illustrate through captures how it works inside the OVHcloud Control Panel. The policies created can be applied to any OVHcloud identities through the OVHcloud API. You can use these policies to share data with a local user, another OVHcloud user account or an OAuth client. You can refer to the specific [IAM Policies with API guide](/pages/account_and_service_management/account_information/iam-policies-api) to recreate all these policies with the API. +This guide leverages [local users](/pages/account_and_service_management/account_information/ovhcloud-users-management) to explain how you can share resources with another user. The policies created can be applied to any OVHcloud identities through the OVHcloud API. You can use these policies to share data with a local user, another OVHcloud user account or an OAuth client. You can refer to the specific [IAM Policies with API guide](/pages/account_and_service_management/account_information/iam-policies-api) to re-create all these policies with the API. The identity will see a new service listed in their Logs Data Platform. This service contains the shared Logs Data Platform items. To ensure the recipient can see the shared items, we must share a view of the service with them. @@ -45,7 +40,7 @@ This section details how to configure local user/identity groups and policies to ### Create a group for local users -By default, the least privileged group available for local users is read-only over all the products of your account. If you would like to have an even more restricted account able to read only shared data from your Logs Data Platform, we advise you to create a group with the role **None** and attach your local users to it. In the OVHcloud Control Panel, navigate to `IAM`{.action} > `Identities`{.action} > `User groups`{.action} to create such a group. +By default, the least privileged group available for local users is read-only over all the products of your account. If you would like to have an even more restricted account able to read only shared data from your Logs Data Platform, we advise you to create a group with the role **None** and attach your local users to it. In the OVHcloud Control Panel, navigate to `IAM`{.action} > `Identities`{.action} > `User groups`{.action} to create such a group. ![Create a group](images/create_group.png){.thumbnail} @@ -67,13 +62,13 @@ Creating a local user is fully documented in the [dedicated documentation](/page ### Create a policy for the service -You now need to create a policy in order to allow the local user to see the Logs Data Platform service inside the OVHcloud Control Panel. The goal here is to have access to the service only but without any sub resources visible (ie no streams, dashboards, indices, aliases or OpenSearch Dashboards instances). Navigate to `IAM`{.action} > `Policies`{.action} > `My Policies`{.action} to create this policy. +You now need to create a policy in order to allow the local user to see the Logs Data Platform service inside the OVHcloud Control Panel. The goal here is to have access to the service only but without any sub resources visible (ie no streams, dashboards, indices, aliases or OpenSearch Dashboards instances). Navigate to `IAM`{.action} > `Policies`{.action} > `My Policies`{.action} to create this policy. -Add the local user to your policy and select the **Logs Data Platform: service** product type to list your services in the *Resources* dropdown list and enable the panel of the *Actions* related to Logs Data Service. +Add the local user to your policy and select the **Logs Data Platform: service** product type to list your services in the *Resources* dropdown list and enable the panel of the *Actions* related to Logs Data Service. ![Create policy service 1](images/create_policy_service_1.png){.thumbnail} -The policy can then allow the service with read only access on the choosen service. Some mandatory actions need to be given for users to be able to see the Logs Data Platform control panel without error. The minimal set of actions are listed below: +The policy can then allow the service with read only access to the choosen service. Some mandatory actions need to be given for users to be able to see the Logs Data Platform control panel without error. The minimal set of actions is listed below: ```yaml - ldp:apiovh:cluster/get @@ -83,7 +78,7 @@ The policy can then allow the service with read only access on the choosen servi - ldp:apiovh:input/get - ldp:apiovh:metrics/get - ldp:apiovh:role/get -- ldp:apiovh:service/get +- ldp:apiovh:service/get - ldp:apiovh:serviceInfos/get - ldp:apiovh:services/form/get - ldp:apiovh:services/get @@ -99,27 +94,27 @@ Once the policy is attached to the identity, the users will see the new service ### Create a sub resources group -All the items created by a Logs Data Platform (ie streams, dashboards etc) are materialized as sub-resources of the LDP service. -One of the new feature available thanks to IAM is the ability to group sub-resources in a **Resource group**. A Resource group can be used to share related resources together and are a convenient way to groups items which are supposed to be used together. For example: a stream and its related dashboard, an alias and a OpenSearch Dashboard to explore it, an alias with all the streams attached to it. This feature is a good way to completely isolate sub-resources and make sure you don't have to handle them one by one over all your policies. +All the items created by a Logs Data Platform (i.e. streams, dashboards, etc.) are materialized as sub-resources of the LDP service. +One of the new features available thanks to IAM is the ability to group sub-resources in a **Resource group**. A Resource group can be used to share related resources and is a convenient way to groups items that are supposed to be used together. For example: a stream and its related dashboard, an alias and a OpenSearch Dashboard to explore it, an alias with all the streams attached to it. This feature is a good way to completely isolate sub-resources and make sure you don't have to handle them one by one over all your policies. To create a resource group, navigate to `IAM`{.action} > `Policies`{.action} > `Resource Groups`{.action}. ![Create Resource Group](images/create_rg.png){.thumbnail} -You need to select the product type (Dashboards, Streams, Alias, Index, OpenSearch Dashboards) and then select the specific resource you want to share. +You need to select the product type (Dashboards, Streams, Alias, Index, OpenSearch Dashboards) and then select the specific resource you want to share. ### Create a policy for the sub resources -This policy is the one you need to effectively replicate the [legacy roles permissions](/pages/manage_and_operate/observability/logs_data_platform/getting_started_roles_permission). You will attach OVHcloud APIs rights and backend (Graylog, OpenSearch) rights to allow identities to see the items in their shared service and interact with them in the corresponding Web UIs and APIs. Again navigate to `IAM`{.action} > `Policies`{.action} > `My Policies`{.action} to create a policy. +This policy is the one you need to effectively replicate the [legacy roles' permissions](/pages/manage_and_operate/observability/logs_data_platform/getting_started_roles_permission). You will attach OVHcloud APIs rights and backend (Graylog, OpenSearch) rights to allow identities to see the items in their shared service and interact with them in the corresponding Web UIs and APIs. Again, navigate to `IAM`{.action} > `Policies`{.action} > `My Policies`{.action} to create a policy. -Similarly to the previous policy, you need to add your local user and you need to select the product type of your ressource or sub-resource if you want to enable the actions selection panel for these specific sub-resources. +Similar to the previous policy, you need to add your local user, and you need to select the product type of your resource or sub-resource if you want to enable the actions selection panel for these specific sub-resources. ![Create sub resource policy](images/policy_sub_product_types.png){.thumbnail} > [!warning] > Do not add a Logs Data Platform service to this policy. If you do so it will transitively give access to all sub-resources of this service (ie all LDP items) to the local users/identities or groups attached to the policy. The previous service policy has been created to prevent this behaviour. -You can mix Resource Groups and specific resources in the same policy. All actions attached to the policy will be then be attached to all related sub-resources. +You can mix Resource Groups and specific resources in the same policy. All actions attached to the policy will be then be attached to all related sub-resources. You have several actions for each sub-resource type. For brevity, this guide will not detail all the actions available for all the items. Here are some use cases of several rights which can all be together in one policy showcasing the complexity enabled by IAM policies. Actions starting with **ldp:apiovh** are actions related to OVHcloud APIs (thus the control panel UI). The other actions are related to their specific backend: Graylog or OpenSearch. @@ -154,10 +149,10 @@ Here are some use cases of several rights which can all be together in one polic /// details | These actions allow to consult and create visualizations in one or several OpenSearch Dashboard instances: ```yaml -- ldp:opensearch:osd/update +- ldp:opensearch:osd/update - ldp:apiovh:output/opensearch/osd/get - ldp:apiovh:output/opensearch/osd/url/get -- ldp:opensearch:osd/get +- ldp:opensearch:osd/get ``` ![policy sub resource 3](images/carousel_policy_sub_3.png){.thumbnail} @@ -168,15 +163,15 @@ Here are some use cases of several rights which can all be together in one polic ```yaml - ldp:apiovh:output/graylog/stream/get -- ldp:apiovh:output/graylog/stream/url/get -- ldp:graylog:stream/read +- ldp:apiovh:output/graylog/stream/url/get +- ldp:graylog:stream/read ``` ![policy sub resource 4](images/carousel_policy_sub_4.png){.thumbnail} /// -Once the policy is created, the local user/identity will only see the related sub resource of the policy in its own control panel. +Once the policy is created, the local user/identity will only see the related sub resource of the policy in its own control panel. ![local user control panel](images/local_user_control_panel01.png){.thumbnail} @@ -193,15 +188,15 @@ Local users are useful for generating Personal Access Tokens (PATs). These token > @api {v1} /me POST /me/identity/user/{user}/token > -Thanks to OVHcloud IAM, you can then delegates the creation rights of sub-resources (indices, aliases) to your local user and interact with the backend APIs directly with these Personal Access Tokens. +Thanks to OVHcloud IAM, you can then delegate the creation rights of sub-resources (indices, aliases) to your local user and interact with the backend APIs directly with these Personal Access Tokens. -The actions related to create items are part of the service actions. You will need to add them to a policy to allow a user to create items with their PAT. +The actions related to creating items are part of the service actions. You will need to add them to a policy to allow a user to create items with their PAT. > [!primary] > You don't need to allow any OVHcloud APIs action to allow a local user to interact with the Logs Data Platform backends (OpenSearch, Graylog, OpenSearch Dashboards) APIs. -> Local users allow you to generate tokens which can only interact with the backend similarly to legacy Logs Data Platform tokens. +> Local users allow you to generate tokens that can only interact with the backend similarly to legacy Logs Data Platform tokens. -For example, these two rights allow a local user to create indices/aliases directly on OpenSearch without having any other rights on the OVHcloud APIs. +For example, these two rights allow a local user to create indices/aliases directly on OpenSearch without having any other rights on the OVHcloud APIs. ![policy create actions](images/policy_create_actions.png){.thumbnail} diff --git a/pages/manage_and_operate/observability/logs_data_platform/iam_access_management/images/carousel_policy_sub_2.png b/pages/manage_and_operate/observability/logs_data_platform/iam_access_management/images/carousel_policy_sub_2.png deleted file mode 100644 index 573aa071501..00000000000 Binary files a/pages/manage_and_operate/observability/logs_data_platform/iam_access_management/images/carousel_policy_sub_2.png and /dev/null differ diff --git a/pages/manage_and_operate/observability/logs_data_platform/iam_access_management/images/policy_streams.png b/pages/manage_and_operate/observability/logs_data_platform/iam_access_management/images/policy_streams.png deleted file mode 100644 index 4fa245e720e..00000000000 Binary files a/pages/manage_and_operate/observability/logs_data_platform/iam_access_management/images/policy_streams.png and /dev/null differ diff --git a/pages/manage_and_operate/observability/logs_data_platform/iam_migration_to_iam/guide.en-gb.md b/pages/manage_and_operate/observability/logs_data_platform/iam_migration_to_iam/guide.en-gb.md index 80cdd74ae6d..08b45882893 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/iam_migration_to_iam/guide.en-gb.md +++ b/pages/manage_and_operate/observability/logs_data_platform/iam_migration_to_iam/guide.en-gb.md @@ -1,7 +1,7 @@ --- -title: IAM for Logs Data Platform - Migration and Breaking Changes +title: IAM for Logs Data Platform - Migration and Breaking Changes excerpt: Important changes to be aware of before the IAM migration -updated: 2025-07-22 +updated: 2025-10-16 --- > [!primary] @@ -9,7 +9,7 @@ updated: 2025-07-22 > The content of this documentation should be read to prepare this migration. > -## Objective +## Objective This guide explains the breaking changes resulting from the IAM migration and provides guidance on how to take advantage of the new IAM integration. @@ -21,7 +21,7 @@ This guide explains the breaking changes resulting from the IAM migration and pr ## Instructions -### What is IAM? +### What is IAM? IAM stands for **Identity and Access Management**. It is a system of policies and processes that enable organizations or users to manage digital identities and control access to sensitive resources, such as applications, data, systems, and in the case of Logs Data Platform: logs. @@ -58,7 +58,7 @@ The IAM migration allows us to deprecate some Logs Data Platform features that h These features are replaced by [access management policies](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management) and by either [Local Users Personal Access Tokens](/pages/account_and_service_management/account_information/ovhcloud-users-management) or [Service account tokens](/pages/account_and_service_management/account_information/authenticate-api-with-service-account). -### Useful Documentation +### Useful Documentation #### IAM Resources diff --git a/pages/manage_and_operate/observability/logs_data_platform/iam_presentation_faq/guide.en-gb.md b/pages/manage_and_operate/observability/logs_data_platform/iam_presentation_faq/guide.en-gb.md index 4f20a4b96e6..ca3913207b5 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/iam_presentation_faq/guide.en-gb.md +++ b/pages/manage_and_operate/observability/logs_data_platform/iam_presentation_faq/guide.en-gb.md @@ -1,7 +1,7 @@ --- -title: IAM for Logs Data Platform - Presentation and FAQ +title: IAM for Logs Data Platform - Presentation and FAQ excerpt: A presentation on how IAM works with Logs Data Platform -updated: 2025-07-22 +updated: 2025-10-16 --- > [!primary] @@ -9,19 +9,19 @@ updated: 2025-07-22 > The content of this documentation will be valid from this date. > -## Objective +## Objective -This guide explains the integration of Logs Data Platform with OVHcloud IAM. +This guide explains the integration of Logs Data Platform with OVHcloud IAM. -## Requirements +## Requirements - An [OVHcloud account](/pages/account_and_service_management/account_information/ovhcloud-account-creation) - Access to the [OVHcloud Control Panel](/links/manager) - A [Logs Data Platform service](/links/manage-operate/ldp) -## Instructions +## Instructions -### How is IAM useful for Logs Data Platform? +### How is IAM useful for Logs Data Platform? Enabling OVHcloud IAM on Logs Data Platform delegates authentication, access management, and permissions to OVHcloud IAM. There are several benefits to using IAM: @@ -37,20 +37,20 @@ Enabling OVHcloud IAM on Logs Data Platform delegates authentication, access man If you have an existing service, follow these steps: - Replace all your **Roles** and permissions with [appropriate policies](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). -- Ensure you have no **Roles** declared in your service. +- Ensure you have no **Roles** declared in your service. - Ensure your service is not in any **Roles**. - Ensure you don't have any [tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens). -- Use the dedicated `Enable OVHcloud IAM`{.action} in the **Roles** sections of the Logs Data Platform Control Panel. +- Use the dedicated `Enable OVHcloud IAM`{.action} in the **Roles** sections of the Logs Data Platform Control Panel. ![Activate IAM](images/activate_iam_existing_service.png){.thumbnail} -Once IAM is activated, a new **IAM Policies** section will replace the previous **Roles** section. +Once IAM is activated, a new **IAM Policies** section will replace the previous **Roles** section. ![Activated IAM](images/activated_iam.png){.thumbnail} ### How to enable OVHcloud IAM on a new service? -When a new service is created, you can directly opt-in into using IAM directly and use [IAM policies](/pages/account_and_service_management/account_information/iam-policy-ui) to handle access rights. +When a new service is created, you can directly opt-in into using IAM directly and use [IAM policies](/pages/account_and_service_management/account_information/iam-policy-ui) to handle access rights. ![Activate IAM on a new service](images/activate_iam_new_service.png){.thumbnail} @@ -75,7 +75,7 @@ Once completed, you will be redirected back to the OpenSearch Dashboard instance ### How to connect to Grafana with IAM? - If your Identity Provider is the OVHcloud IAM, you can select the option **Forward OAuth identity** to forward the identity connected to the Logs Data Platform. -- If you use another authentication provider, you can forge an *Authorization* header with an IAM compatible token. See the next section to see how to generate that kind of token. The content of the header must be `Bearer: `. Replace `` with the value of your token. +- If you use another authentication provider, you can forge an *Authorization* header with an IAM compatible token. See the next section to see how to generate that kind of token. The content of the header must be `Bearer: `. Replace `` with the value of your token. ![Grafana header](images/grafana_header.png){.thumbnail} @@ -90,8 +90,8 @@ With IAM enabled, [tokens](/pages/manage_and_operate/observability/logs_data_pla For example if you are on gra1 cluster, curl can use these tokens in the following way: -```bash -ldp@laptop curl -k -v -H 'content-type: application/json' --oauth2-bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c -XGET 'https://gra1.logs.ovh.com:9200/_cluster/health?pretty' +```bash +ldp@laptop curl -H 'content-type: application/json' --oauth2-bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c -XGET 'https://gra1.logs.ovh.com:9200/_cluster/health?pretty' ``` ### How to create indices or aliases on Logs Data Platform backend APIs? @@ -99,12 +99,12 @@ ldp@laptop curl -k -v -H 'content-type: application/json' --oauth2-bearer eyJhbG First, ensure the identity you want to use has permission to create indices and aliases for the service. If authorized, Personal Access Tokens or service account OAuth2 clients can perform creation/deletion operations. > [!warning] -> The previous prefix for indices and aliases was the username. Now the prefix is the **service name**. You will find the service name on the homepage of the Logs Data Platform control panel. It is also the suffix of a Logs Data Platform service URN. For example: +> The previous prefix for indices and aliases was the username. Now the prefix is the **service name**. You will find the service name on the homepage of the Logs Data Platform control panel. It is also the suffix of a Logs Data Platform service URN. For example: > > urn:v1:eu:resource:ldp:**ldp-ab-56945** > -The service is tied to a unique Logs Data Platform so you will be allowed to create items only on this cluster. For example if ldp-ab-56945 is on gra1: +The service is tied to a unique Logs Data Platform so you will be allowed to create items only on this cluster. For example if ldp-ab-56945 is on gra1: ```bash ldp@laptop curl -k -v -H 'content-type: application/json' --oauth2-bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c -XPOST 'https://gra1.logs.ovh.com:9200/ldp-ab-56945-i-my-new-index/_doc' -d '{ "user" : "ldp" }' diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.de-de.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.de-de.md index 0c10b0739cc..3eae51c3f33 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.de-de.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.de-de.md @@ -1,13 +1,13 @@ --- title: Pushing logs with a forwarder - Filebeat (Linux) -updated: 2024-11-28 +updated: 2025-10-16 --- ## Objective [Filebeat](https://github.com/elastic/beats/tree/master/filebeat) is an open source file harvester, used to fetch logs files and can be easily setup to feed them into Logs Data Platform. -The main benefits of Filebeat are it's resilient protocol to send logs, and a variety of modules ready-to-use for most of the common applications. +The main benefits of Filebeat are its resilient protocol to send logs, and a variety of ready-to-use modules for most of the common applications. This guide will describe how to setup Filebeat OSS on your system for forwarding your logs on Logs Data Platform. It will also present you with some configuration setup useful to further structure your logs. @@ -199,8 +199,8 @@ output.elasticsearch: protocol: "https" # Authentication credentials - either API key or username/password. - username: "" - password: "" + username: "pat_jwt_" + password: "" index: "ldp-logs" # Header for OpenSearch 2.X headers: @@ -214,7 +214,7 @@ output.elasticsearch: > -This configuration deactivates the template configuration (unneeded for our endpoint). You need to provide your credentials **** and **** of your account. Like all Logs Data Platform APIs you can also use [tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens). Don't change **ldp-logs** since it is our special destination index. +This configuration deactivates the template configuration (unneeded for our endpoint). You need to provide your IAM credentials **pat_jwt_** and **** of your account. Like all Logs Data Platform backend APIs you can use [IAM tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens). Don't change **ldp-logs** since it is our special destination index. When you use our OpenSearch endpoint with filebeat, it will use the [ingest module](https://www.elastic.co/guide/en/logstash/7.12/use-ingest-pipelines.html) to parse and structure the logs. @@ -310,8 +310,8 @@ Note the type value (apache or syslog or apache-error) that indicates the source Filebeat is a handy tool to send the content of your current log files to Logs Data Platform. It offers a clean and easy way to send your logs without changing the configuration of your software. Don't hesitate to check the links below to master this tool. -- Configuration's details: [https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-configuration-details.html](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-configuration-details.html) -- Getting started: [https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-getting-started.html](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-getting-started.html) +- Getting started: [https://www.elastic.co/guide/en/beats/filebeat/7.12/filebeat-overview.html](https://www.elastic.co/guide/en/beats/filebeat/7.12/filebeat-overview.html) +- Configuration's details: [https://www.elastic.co/guide/en/beats/filebeat/7.12/configuring-howto-filebeat.html](https://www.elastic.co/guide/en/beats/filebeat/7.12/configuring-howto-filebeat.html) - Learn how to configure Filebeat and Logstash to add your own extra filters: [Dedicated input - Logstash](/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input) ## Going further @@ -319,4 +319,4 @@ Filebeat is a handy tool to send the content of your current log files to Logs D - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.en-asia.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.en-asia.md index 0c10b0739cc..3eae51c3f33 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.en-asia.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.en-asia.md @@ -1,13 +1,13 @@ --- title: Pushing logs with a forwarder - Filebeat (Linux) -updated: 2024-11-28 +updated: 2025-10-16 --- ## Objective [Filebeat](https://github.com/elastic/beats/tree/master/filebeat) is an open source file harvester, used to fetch logs files and can be easily setup to feed them into Logs Data Platform. -The main benefits of Filebeat are it's resilient protocol to send logs, and a variety of modules ready-to-use for most of the common applications. +The main benefits of Filebeat are its resilient protocol to send logs, and a variety of ready-to-use modules for most of the common applications. This guide will describe how to setup Filebeat OSS on your system for forwarding your logs on Logs Data Platform. It will also present you with some configuration setup useful to further structure your logs. @@ -199,8 +199,8 @@ output.elasticsearch: protocol: "https" # Authentication credentials - either API key or username/password. - username: "" - password: "" + username: "pat_jwt_" + password: "" index: "ldp-logs" # Header for OpenSearch 2.X headers: @@ -214,7 +214,7 @@ output.elasticsearch: > -This configuration deactivates the template configuration (unneeded for our endpoint). You need to provide your credentials **** and **** of your account. Like all Logs Data Platform APIs you can also use [tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens). Don't change **ldp-logs** since it is our special destination index. +This configuration deactivates the template configuration (unneeded for our endpoint). You need to provide your IAM credentials **pat_jwt_** and **** of your account. Like all Logs Data Platform backend APIs you can use [IAM tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens). Don't change **ldp-logs** since it is our special destination index. When you use our OpenSearch endpoint with filebeat, it will use the [ingest module](https://www.elastic.co/guide/en/logstash/7.12/use-ingest-pipelines.html) to parse and structure the logs. @@ -310,8 +310,8 @@ Note the type value (apache or syslog or apache-error) that indicates the source Filebeat is a handy tool to send the content of your current log files to Logs Data Platform. It offers a clean and easy way to send your logs without changing the configuration of your software. Don't hesitate to check the links below to master this tool. -- Configuration's details: [https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-configuration-details.html](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-configuration-details.html) -- Getting started: [https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-getting-started.html](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-getting-started.html) +- Getting started: [https://www.elastic.co/guide/en/beats/filebeat/7.12/filebeat-overview.html](https://www.elastic.co/guide/en/beats/filebeat/7.12/filebeat-overview.html) +- Configuration's details: [https://www.elastic.co/guide/en/beats/filebeat/7.12/configuring-howto-filebeat.html](https://www.elastic.co/guide/en/beats/filebeat/7.12/configuring-howto-filebeat.html) - Learn how to configure Filebeat and Logstash to add your own extra filters: [Dedicated input - Logstash](/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input) ## Going further @@ -319,4 +319,4 @@ Filebeat is a handy tool to send the content of your current log files to Logs D - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.en-au.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.en-au.md index 0c10b0739cc..3eae51c3f33 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.en-au.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.en-au.md @@ -1,13 +1,13 @@ --- title: Pushing logs with a forwarder - Filebeat (Linux) -updated: 2024-11-28 +updated: 2025-10-16 --- ## Objective [Filebeat](https://github.com/elastic/beats/tree/master/filebeat) is an open source file harvester, used to fetch logs files and can be easily setup to feed them into Logs Data Platform. -The main benefits of Filebeat are it's resilient protocol to send logs, and a variety of modules ready-to-use for most of the common applications. +The main benefits of Filebeat are its resilient protocol to send logs, and a variety of ready-to-use modules for most of the common applications. This guide will describe how to setup Filebeat OSS on your system for forwarding your logs on Logs Data Platform. It will also present you with some configuration setup useful to further structure your logs. @@ -199,8 +199,8 @@ output.elasticsearch: protocol: "https" # Authentication credentials - either API key or username/password. - username: "" - password: "" + username: "pat_jwt_" + password: "" index: "ldp-logs" # Header for OpenSearch 2.X headers: @@ -214,7 +214,7 @@ output.elasticsearch: > -This configuration deactivates the template configuration (unneeded for our endpoint). You need to provide your credentials **** and **** of your account. Like all Logs Data Platform APIs you can also use [tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens). Don't change **ldp-logs** since it is our special destination index. +This configuration deactivates the template configuration (unneeded for our endpoint). You need to provide your IAM credentials **pat_jwt_** and **** of your account. Like all Logs Data Platform backend APIs you can use [IAM tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens). Don't change **ldp-logs** since it is our special destination index. When you use our OpenSearch endpoint with filebeat, it will use the [ingest module](https://www.elastic.co/guide/en/logstash/7.12/use-ingest-pipelines.html) to parse and structure the logs. @@ -310,8 +310,8 @@ Note the type value (apache or syslog or apache-error) that indicates the source Filebeat is a handy tool to send the content of your current log files to Logs Data Platform. It offers a clean and easy way to send your logs without changing the configuration of your software. Don't hesitate to check the links below to master this tool. -- Configuration's details: [https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-configuration-details.html](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-configuration-details.html) -- Getting started: [https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-getting-started.html](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-getting-started.html) +- Getting started: [https://www.elastic.co/guide/en/beats/filebeat/7.12/filebeat-overview.html](https://www.elastic.co/guide/en/beats/filebeat/7.12/filebeat-overview.html) +- Configuration's details: [https://www.elastic.co/guide/en/beats/filebeat/7.12/configuring-howto-filebeat.html](https://www.elastic.co/guide/en/beats/filebeat/7.12/configuring-howto-filebeat.html) - Learn how to configure Filebeat and Logstash to add your own extra filters: [Dedicated input - Logstash](/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input) ## Going further @@ -319,4 +319,4 @@ Filebeat is a handy tool to send the content of your current log files to Logs D - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.en-ca.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.en-ca.md index 0c10b0739cc..3eae51c3f33 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.en-ca.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.en-ca.md @@ -1,13 +1,13 @@ --- title: Pushing logs with a forwarder - Filebeat (Linux) -updated: 2024-11-28 +updated: 2025-10-16 --- ## Objective [Filebeat](https://github.com/elastic/beats/tree/master/filebeat) is an open source file harvester, used to fetch logs files and can be easily setup to feed them into Logs Data Platform. -The main benefits of Filebeat are it's resilient protocol to send logs, and a variety of modules ready-to-use for most of the common applications. +The main benefits of Filebeat are its resilient protocol to send logs, and a variety of ready-to-use modules for most of the common applications. This guide will describe how to setup Filebeat OSS on your system for forwarding your logs on Logs Data Platform. It will also present you with some configuration setup useful to further structure your logs. @@ -199,8 +199,8 @@ output.elasticsearch: protocol: "https" # Authentication credentials - either API key or username/password. - username: "" - password: "" + username: "pat_jwt_" + password: "" index: "ldp-logs" # Header for OpenSearch 2.X headers: @@ -214,7 +214,7 @@ output.elasticsearch: > -This configuration deactivates the template configuration (unneeded for our endpoint). You need to provide your credentials **** and **** of your account. Like all Logs Data Platform APIs you can also use [tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens). Don't change **ldp-logs** since it is our special destination index. +This configuration deactivates the template configuration (unneeded for our endpoint). You need to provide your IAM credentials **pat_jwt_** and **** of your account. Like all Logs Data Platform backend APIs you can use [IAM tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens). Don't change **ldp-logs** since it is our special destination index. When you use our OpenSearch endpoint with filebeat, it will use the [ingest module](https://www.elastic.co/guide/en/logstash/7.12/use-ingest-pipelines.html) to parse and structure the logs. @@ -310,8 +310,8 @@ Note the type value (apache or syslog or apache-error) that indicates the source Filebeat is a handy tool to send the content of your current log files to Logs Data Platform. It offers a clean and easy way to send your logs without changing the configuration of your software. Don't hesitate to check the links below to master this tool. -- Configuration's details: [https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-configuration-details.html](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-configuration-details.html) -- Getting started: [https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-getting-started.html](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-getting-started.html) +- Getting started: [https://www.elastic.co/guide/en/beats/filebeat/7.12/filebeat-overview.html](https://www.elastic.co/guide/en/beats/filebeat/7.12/filebeat-overview.html) +- Configuration's details: [https://www.elastic.co/guide/en/beats/filebeat/7.12/configuring-howto-filebeat.html](https://www.elastic.co/guide/en/beats/filebeat/7.12/configuring-howto-filebeat.html) - Learn how to configure Filebeat and Logstash to add your own extra filters: [Dedicated input - Logstash](/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input) ## Going further @@ -319,4 +319,4 @@ Filebeat is a handy tool to send the content of your current log files to Logs D - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.en-gb.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.en-gb.md index 73bf5afee54..3eae51c3f33 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.en-gb.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.en-gb.md @@ -1,6 +1,6 @@ --- title: Pushing logs with a forwarder - Filebeat (Linux) -updated: 2024-11-28 +updated: 2025-10-16 --- ## Objective @@ -199,8 +199,8 @@ output.elasticsearch: protocol: "https" # Authentication credentials - either API key or username/password. - username: "" - password: "" + username: "pat_jwt_" + password: "" index: "ldp-logs" # Header for OpenSearch 2.X headers: @@ -214,7 +214,7 @@ output.elasticsearch: > -This configuration deactivates the template configuration (unneeded for our endpoint). You need to provide your credentials **** and **** of your account. Like all Logs Data Platform APIs you can also use [tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens). Don't change **ldp-logs** since it is our special destination index. +This configuration deactivates the template configuration (unneeded for our endpoint). You need to provide your IAM credentials **pat_jwt_** and **** of your account. Like all Logs Data Platform backend APIs you can use [IAM tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens). Don't change **ldp-logs** since it is our special destination index. When you use our OpenSearch endpoint with filebeat, it will use the [ingest module](https://www.elastic.co/guide/en/logstash/7.12/use-ingest-pipelines.html) to parse and structure the logs. @@ -310,8 +310,8 @@ Note the type value (apache or syslog or apache-error) that indicates the source Filebeat is a handy tool to send the content of your current log files to Logs Data Platform. It offers a clean and easy way to send your logs without changing the configuration of your software. Don't hesitate to check the links below to master this tool. -- Configuration's details: [https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-configuration-details.html](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-configuration-details.html) -- Getting started: [https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-getting-started.html](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-getting-started.html) +- Getting started: [https://www.elastic.co/guide/en/beats/filebeat/7.12/filebeat-overview.html](https://www.elastic.co/guide/en/beats/filebeat/7.12/filebeat-overview.html) +- Configuration's details: [https://www.elastic.co/guide/en/beats/filebeat/7.12/configuring-howto-filebeat.html](https://www.elastic.co/guide/en/beats/filebeat/7.12/configuring-howto-filebeat.html) - Learn how to configure Filebeat and Logstash to add your own extra filters: [Dedicated input - Logstash](/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input) ## Going further @@ -319,4 +319,4 @@ Filebeat is a handy tool to send the content of your current log files to Logs D - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.en-ie.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.en-ie.md index 0c10b0739cc..3eae51c3f33 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.en-ie.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.en-ie.md @@ -1,13 +1,13 @@ --- title: Pushing logs with a forwarder - Filebeat (Linux) -updated: 2024-11-28 +updated: 2025-10-16 --- ## Objective [Filebeat](https://github.com/elastic/beats/tree/master/filebeat) is an open source file harvester, used to fetch logs files and can be easily setup to feed them into Logs Data Platform. -The main benefits of Filebeat are it's resilient protocol to send logs, and a variety of modules ready-to-use for most of the common applications. +The main benefits of Filebeat are its resilient protocol to send logs, and a variety of ready-to-use modules for most of the common applications. This guide will describe how to setup Filebeat OSS on your system for forwarding your logs on Logs Data Platform. It will also present you with some configuration setup useful to further structure your logs. @@ -199,8 +199,8 @@ output.elasticsearch: protocol: "https" # Authentication credentials - either API key or username/password. - username: "" - password: "" + username: "pat_jwt_" + password: "" index: "ldp-logs" # Header for OpenSearch 2.X headers: @@ -214,7 +214,7 @@ output.elasticsearch: > -This configuration deactivates the template configuration (unneeded for our endpoint). You need to provide your credentials **** and **** of your account. Like all Logs Data Platform APIs you can also use [tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens). Don't change **ldp-logs** since it is our special destination index. +This configuration deactivates the template configuration (unneeded for our endpoint). You need to provide your IAM credentials **pat_jwt_** and **** of your account. Like all Logs Data Platform backend APIs you can use [IAM tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens). Don't change **ldp-logs** since it is our special destination index. When you use our OpenSearch endpoint with filebeat, it will use the [ingest module](https://www.elastic.co/guide/en/logstash/7.12/use-ingest-pipelines.html) to parse and structure the logs. @@ -310,8 +310,8 @@ Note the type value (apache or syslog or apache-error) that indicates the source Filebeat is a handy tool to send the content of your current log files to Logs Data Platform. It offers a clean and easy way to send your logs without changing the configuration of your software. Don't hesitate to check the links below to master this tool. -- Configuration's details: [https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-configuration-details.html](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-configuration-details.html) -- Getting started: [https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-getting-started.html](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-getting-started.html) +- Getting started: [https://www.elastic.co/guide/en/beats/filebeat/7.12/filebeat-overview.html](https://www.elastic.co/guide/en/beats/filebeat/7.12/filebeat-overview.html) +- Configuration's details: [https://www.elastic.co/guide/en/beats/filebeat/7.12/configuring-howto-filebeat.html](https://www.elastic.co/guide/en/beats/filebeat/7.12/configuring-howto-filebeat.html) - Learn how to configure Filebeat and Logstash to add your own extra filters: [Dedicated input - Logstash](/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input) ## Going further @@ -319,4 +319,4 @@ Filebeat is a handy tool to send the content of your current log files to Logs D - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.en-sg.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.en-sg.md index 0c10b0739cc..3eae51c3f33 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.en-sg.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.en-sg.md @@ -1,13 +1,13 @@ --- title: Pushing logs with a forwarder - Filebeat (Linux) -updated: 2024-11-28 +updated: 2025-10-16 --- ## Objective [Filebeat](https://github.com/elastic/beats/tree/master/filebeat) is an open source file harvester, used to fetch logs files and can be easily setup to feed them into Logs Data Platform. -The main benefits of Filebeat are it's resilient protocol to send logs, and a variety of modules ready-to-use for most of the common applications. +The main benefits of Filebeat are its resilient protocol to send logs, and a variety of ready-to-use modules for most of the common applications. This guide will describe how to setup Filebeat OSS on your system for forwarding your logs on Logs Data Platform. It will also present you with some configuration setup useful to further structure your logs. @@ -199,8 +199,8 @@ output.elasticsearch: protocol: "https" # Authentication credentials - either API key or username/password. - username: "" - password: "" + username: "pat_jwt_" + password: "" index: "ldp-logs" # Header for OpenSearch 2.X headers: @@ -214,7 +214,7 @@ output.elasticsearch: > -This configuration deactivates the template configuration (unneeded for our endpoint). You need to provide your credentials **** and **** of your account. Like all Logs Data Platform APIs you can also use [tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens). Don't change **ldp-logs** since it is our special destination index. +This configuration deactivates the template configuration (unneeded for our endpoint). You need to provide your IAM credentials **pat_jwt_** and **** of your account. Like all Logs Data Platform backend APIs you can use [IAM tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens). Don't change **ldp-logs** since it is our special destination index. When you use our OpenSearch endpoint with filebeat, it will use the [ingest module](https://www.elastic.co/guide/en/logstash/7.12/use-ingest-pipelines.html) to parse and structure the logs. @@ -310,8 +310,8 @@ Note the type value (apache or syslog or apache-error) that indicates the source Filebeat is a handy tool to send the content of your current log files to Logs Data Platform. It offers a clean and easy way to send your logs without changing the configuration of your software. Don't hesitate to check the links below to master this tool. -- Configuration's details: [https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-configuration-details.html](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-configuration-details.html) -- Getting started: [https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-getting-started.html](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-getting-started.html) +- Getting started: [https://www.elastic.co/guide/en/beats/filebeat/7.12/filebeat-overview.html](https://www.elastic.co/guide/en/beats/filebeat/7.12/filebeat-overview.html) +- Configuration's details: [https://www.elastic.co/guide/en/beats/filebeat/7.12/configuring-howto-filebeat.html](https://www.elastic.co/guide/en/beats/filebeat/7.12/configuring-howto-filebeat.html) - Learn how to configure Filebeat and Logstash to add your own extra filters: [Dedicated input - Logstash](/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input) ## Going further @@ -319,4 +319,4 @@ Filebeat is a handy tool to send the content of your current log files to Logs D - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.en-us.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.en-us.md index 0c10b0739cc..3eae51c3f33 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.en-us.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.en-us.md @@ -1,13 +1,13 @@ --- title: Pushing logs with a forwarder - Filebeat (Linux) -updated: 2024-11-28 +updated: 2025-10-16 --- ## Objective [Filebeat](https://github.com/elastic/beats/tree/master/filebeat) is an open source file harvester, used to fetch logs files and can be easily setup to feed them into Logs Data Platform. -The main benefits of Filebeat are it's resilient protocol to send logs, and a variety of modules ready-to-use for most of the common applications. +The main benefits of Filebeat are its resilient protocol to send logs, and a variety of ready-to-use modules for most of the common applications. This guide will describe how to setup Filebeat OSS on your system for forwarding your logs on Logs Data Platform. It will also present you with some configuration setup useful to further structure your logs. @@ -199,8 +199,8 @@ output.elasticsearch: protocol: "https" # Authentication credentials - either API key or username/password. - username: "" - password: "" + username: "pat_jwt_" + password: "" index: "ldp-logs" # Header for OpenSearch 2.X headers: @@ -214,7 +214,7 @@ output.elasticsearch: > -This configuration deactivates the template configuration (unneeded for our endpoint). You need to provide your credentials **** and **** of your account. Like all Logs Data Platform APIs you can also use [tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens). Don't change **ldp-logs** since it is our special destination index. +This configuration deactivates the template configuration (unneeded for our endpoint). You need to provide your IAM credentials **pat_jwt_** and **** of your account. Like all Logs Data Platform backend APIs you can use [IAM tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens). Don't change **ldp-logs** since it is our special destination index. When you use our OpenSearch endpoint with filebeat, it will use the [ingest module](https://www.elastic.co/guide/en/logstash/7.12/use-ingest-pipelines.html) to parse and structure the logs. @@ -310,8 +310,8 @@ Note the type value (apache or syslog or apache-error) that indicates the source Filebeat is a handy tool to send the content of your current log files to Logs Data Platform. It offers a clean and easy way to send your logs without changing the configuration of your software. Don't hesitate to check the links below to master this tool. -- Configuration's details: [https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-configuration-details.html](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-configuration-details.html) -- Getting started: [https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-getting-started.html](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-getting-started.html) +- Getting started: [https://www.elastic.co/guide/en/beats/filebeat/7.12/filebeat-overview.html](https://www.elastic.co/guide/en/beats/filebeat/7.12/filebeat-overview.html) +- Configuration's details: [https://www.elastic.co/guide/en/beats/filebeat/7.12/configuring-howto-filebeat.html](https://www.elastic.co/guide/en/beats/filebeat/7.12/configuring-howto-filebeat.html) - Learn how to configure Filebeat and Logstash to add your own extra filters: [Dedicated input - Logstash](/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input) ## Going further @@ -319,4 +319,4 @@ Filebeat is a handy tool to send the content of your current log files to Logs D - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.es-es.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.es-es.md index 0c10b0739cc..3eae51c3f33 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.es-es.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.es-es.md @@ -1,13 +1,13 @@ --- title: Pushing logs with a forwarder - Filebeat (Linux) -updated: 2024-11-28 +updated: 2025-10-16 --- ## Objective [Filebeat](https://github.com/elastic/beats/tree/master/filebeat) is an open source file harvester, used to fetch logs files and can be easily setup to feed them into Logs Data Platform. -The main benefits of Filebeat are it's resilient protocol to send logs, and a variety of modules ready-to-use for most of the common applications. +The main benefits of Filebeat are its resilient protocol to send logs, and a variety of ready-to-use modules for most of the common applications. This guide will describe how to setup Filebeat OSS on your system for forwarding your logs on Logs Data Platform. It will also present you with some configuration setup useful to further structure your logs. @@ -199,8 +199,8 @@ output.elasticsearch: protocol: "https" # Authentication credentials - either API key or username/password. - username: "" - password: "" + username: "pat_jwt_" + password: "" index: "ldp-logs" # Header for OpenSearch 2.X headers: @@ -214,7 +214,7 @@ output.elasticsearch: > -This configuration deactivates the template configuration (unneeded for our endpoint). You need to provide your credentials **** and **** of your account. Like all Logs Data Platform APIs you can also use [tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens). Don't change **ldp-logs** since it is our special destination index. +This configuration deactivates the template configuration (unneeded for our endpoint). You need to provide your IAM credentials **pat_jwt_** and **** of your account. Like all Logs Data Platform backend APIs you can use [IAM tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens). Don't change **ldp-logs** since it is our special destination index. When you use our OpenSearch endpoint with filebeat, it will use the [ingest module](https://www.elastic.co/guide/en/logstash/7.12/use-ingest-pipelines.html) to parse and structure the logs. @@ -310,8 +310,8 @@ Note the type value (apache or syslog or apache-error) that indicates the source Filebeat is a handy tool to send the content of your current log files to Logs Data Platform. It offers a clean and easy way to send your logs without changing the configuration of your software. Don't hesitate to check the links below to master this tool. -- Configuration's details: [https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-configuration-details.html](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-configuration-details.html) -- Getting started: [https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-getting-started.html](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-getting-started.html) +- Getting started: [https://www.elastic.co/guide/en/beats/filebeat/7.12/filebeat-overview.html](https://www.elastic.co/guide/en/beats/filebeat/7.12/filebeat-overview.html) +- Configuration's details: [https://www.elastic.co/guide/en/beats/filebeat/7.12/configuring-howto-filebeat.html](https://www.elastic.co/guide/en/beats/filebeat/7.12/configuring-howto-filebeat.html) - Learn how to configure Filebeat and Logstash to add your own extra filters: [Dedicated input - Logstash](/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input) ## Going further @@ -319,4 +319,4 @@ Filebeat is a handy tool to send the content of your current log files to Logs D - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.es-us.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.es-us.md index 0c10b0739cc..3eae51c3f33 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.es-us.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.es-us.md @@ -1,13 +1,13 @@ --- title: Pushing logs with a forwarder - Filebeat (Linux) -updated: 2024-11-28 +updated: 2025-10-16 --- ## Objective [Filebeat](https://github.com/elastic/beats/tree/master/filebeat) is an open source file harvester, used to fetch logs files and can be easily setup to feed them into Logs Data Platform. -The main benefits of Filebeat are it's resilient protocol to send logs, and a variety of modules ready-to-use for most of the common applications. +The main benefits of Filebeat are its resilient protocol to send logs, and a variety of ready-to-use modules for most of the common applications. This guide will describe how to setup Filebeat OSS on your system for forwarding your logs on Logs Data Platform. It will also present you with some configuration setup useful to further structure your logs. @@ -199,8 +199,8 @@ output.elasticsearch: protocol: "https" # Authentication credentials - either API key or username/password. - username: "" - password: "" + username: "pat_jwt_" + password: "" index: "ldp-logs" # Header for OpenSearch 2.X headers: @@ -214,7 +214,7 @@ output.elasticsearch: > -This configuration deactivates the template configuration (unneeded for our endpoint). You need to provide your credentials **** and **** of your account. Like all Logs Data Platform APIs you can also use [tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens). Don't change **ldp-logs** since it is our special destination index. +This configuration deactivates the template configuration (unneeded for our endpoint). You need to provide your IAM credentials **pat_jwt_** and **** of your account. Like all Logs Data Platform backend APIs you can use [IAM tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens). Don't change **ldp-logs** since it is our special destination index. When you use our OpenSearch endpoint with filebeat, it will use the [ingest module](https://www.elastic.co/guide/en/logstash/7.12/use-ingest-pipelines.html) to parse and structure the logs. @@ -310,8 +310,8 @@ Note the type value (apache or syslog or apache-error) that indicates the source Filebeat is a handy tool to send the content of your current log files to Logs Data Platform. It offers a clean and easy way to send your logs without changing the configuration of your software. Don't hesitate to check the links below to master this tool. -- Configuration's details: [https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-configuration-details.html](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-configuration-details.html) -- Getting started: [https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-getting-started.html](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-getting-started.html) +- Getting started: [https://www.elastic.co/guide/en/beats/filebeat/7.12/filebeat-overview.html](https://www.elastic.co/guide/en/beats/filebeat/7.12/filebeat-overview.html) +- Configuration's details: [https://www.elastic.co/guide/en/beats/filebeat/7.12/configuring-howto-filebeat.html](https://www.elastic.co/guide/en/beats/filebeat/7.12/configuring-howto-filebeat.html) - Learn how to configure Filebeat and Logstash to add your own extra filters: [Dedicated input - Logstash](/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input) ## Going further @@ -319,4 +319,4 @@ Filebeat is a handy tool to send the content of your current log files to Logs D - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.fr-ca.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.fr-ca.md index 0c10b0739cc..3eae51c3f33 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.fr-ca.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.fr-ca.md @@ -1,13 +1,13 @@ --- title: Pushing logs with a forwarder - Filebeat (Linux) -updated: 2024-11-28 +updated: 2025-10-16 --- ## Objective [Filebeat](https://github.com/elastic/beats/tree/master/filebeat) is an open source file harvester, used to fetch logs files and can be easily setup to feed them into Logs Data Platform. -The main benefits of Filebeat are it's resilient protocol to send logs, and a variety of modules ready-to-use for most of the common applications. +The main benefits of Filebeat are its resilient protocol to send logs, and a variety of ready-to-use modules for most of the common applications. This guide will describe how to setup Filebeat OSS on your system for forwarding your logs on Logs Data Platform. It will also present you with some configuration setup useful to further structure your logs. @@ -199,8 +199,8 @@ output.elasticsearch: protocol: "https" # Authentication credentials - either API key or username/password. - username: "" - password: "" + username: "pat_jwt_" + password: "" index: "ldp-logs" # Header for OpenSearch 2.X headers: @@ -214,7 +214,7 @@ output.elasticsearch: > -This configuration deactivates the template configuration (unneeded for our endpoint). You need to provide your credentials **** and **** of your account. Like all Logs Data Platform APIs you can also use [tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens). Don't change **ldp-logs** since it is our special destination index. +This configuration deactivates the template configuration (unneeded for our endpoint). You need to provide your IAM credentials **pat_jwt_** and **** of your account. Like all Logs Data Platform backend APIs you can use [IAM tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens). Don't change **ldp-logs** since it is our special destination index. When you use our OpenSearch endpoint with filebeat, it will use the [ingest module](https://www.elastic.co/guide/en/logstash/7.12/use-ingest-pipelines.html) to parse and structure the logs. @@ -310,8 +310,8 @@ Note the type value (apache or syslog or apache-error) that indicates the source Filebeat is a handy tool to send the content of your current log files to Logs Data Platform. It offers a clean and easy way to send your logs without changing the configuration of your software. Don't hesitate to check the links below to master this tool. -- Configuration's details: [https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-configuration-details.html](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-configuration-details.html) -- Getting started: [https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-getting-started.html](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-getting-started.html) +- Getting started: [https://www.elastic.co/guide/en/beats/filebeat/7.12/filebeat-overview.html](https://www.elastic.co/guide/en/beats/filebeat/7.12/filebeat-overview.html) +- Configuration's details: [https://www.elastic.co/guide/en/beats/filebeat/7.12/configuring-howto-filebeat.html](https://www.elastic.co/guide/en/beats/filebeat/7.12/configuring-howto-filebeat.html) - Learn how to configure Filebeat and Logstash to add your own extra filters: [Dedicated input - Logstash](/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input) ## Going further @@ -319,4 +319,4 @@ Filebeat is a handy tool to send the content of your current log files to Logs D - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.fr-fr.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.fr-fr.md index 0c10b0739cc..3eae51c3f33 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.fr-fr.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.fr-fr.md @@ -1,13 +1,13 @@ --- title: Pushing logs with a forwarder - Filebeat (Linux) -updated: 2024-11-28 +updated: 2025-10-16 --- ## Objective [Filebeat](https://github.com/elastic/beats/tree/master/filebeat) is an open source file harvester, used to fetch logs files and can be easily setup to feed them into Logs Data Platform. -The main benefits of Filebeat are it's resilient protocol to send logs, and a variety of modules ready-to-use for most of the common applications. +The main benefits of Filebeat are its resilient protocol to send logs, and a variety of ready-to-use modules for most of the common applications. This guide will describe how to setup Filebeat OSS on your system for forwarding your logs on Logs Data Platform. It will also present you with some configuration setup useful to further structure your logs. @@ -199,8 +199,8 @@ output.elasticsearch: protocol: "https" # Authentication credentials - either API key or username/password. - username: "" - password: "" + username: "pat_jwt_" + password: "" index: "ldp-logs" # Header for OpenSearch 2.X headers: @@ -214,7 +214,7 @@ output.elasticsearch: > -This configuration deactivates the template configuration (unneeded for our endpoint). You need to provide your credentials **** and **** of your account. Like all Logs Data Platform APIs you can also use [tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens). Don't change **ldp-logs** since it is our special destination index. +This configuration deactivates the template configuration (unneeded for our endpoint). You need to provide your IAM credentials **pat_jwt_** and **** of your account. Like all Logs Data Platform backend APIs you can use [IAM tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens). Don't change **ldp-logs** since it is our special destination index. When you use our OpenSearch endpoint with filebeat, it will use the [ingest module](https://www.elastic.co/guide/en/logstash/7.12/use-ingest-pipelines.html) to parse and structure the logs. @@ -310,8 +310,8 @@ Note the type value (apache or syslog or apache-error) that indicates the source Filebeat is a handy tool to send the content of your current log files to Logs Data Platform. It offers a clean and easy way to send your logs without changing the configuration of your software. Don't hesitate to check the links below to master this tool. -- Configuration's details: [https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-configuration-details.html](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-configuration-details.html) -- Getting started: [https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-getting-started.html](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-getting-started.html) +- Getting started: [https://www.elastic.co/guide/en/beats/filebeat/7.12/filebeat-overview.html](https://www.elastic.co/guide/en/beats/filebeat/7.12/filebeat-overview.html) +- Configuration's details: [https://www.elastic.co/guide/en/beats/filebeat/7.12/configuring-howto-filebeat.html](https://www.elastic.co/guide/en/beats/filebeat/7.12/configuring-howto-filebeat.html) - Learn how to configure Filebeat and Logstash to add your own extra filters: [Dedicated input - Logstash](/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input) ## Going further @@ -319,4 +319,4 @@ Filebeat is a handy tool to send the content of your current log files to Logs D - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.it-it.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.it-it.md index 0c10b0739cc..3eae51c3f33 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.it-it.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.it-it.md @@ -1,13 +1,13 @@ --- title: Pushing logs with a forwarder - Filebeat (Linux) -updated: 2024-11-28 +updated: 2025-10-16 --- ## Objective [Filebeat](https://github.com/elastic/beats/tree/master/filebeat) is an open source file harvester, used to fetch logs files and can be easily setup to feed them into Logs Data Platform. -The main benefits of Filebeat are it's resilient protocol to send logs, and a variety of modules ready-to-use for most of the common applications. +The main benefits of Filebeat are its resilient protocol to send logs, and a variety of ready-to-use modules for most of the common applications. This guide will describe how to setup Filebeat OSS on your system for forwarding your logs on Logs Data Platform. It will also present you with some configuration setup useful to further structure your logs. @@ -199,8 +199,8 @@ output.elasticsearch: protocol: "https" # Authentication credentials - either API key or username/password. - username: "" - password: "" + username: "pat_jwt_" + password: "" index: "ldp-logs" # Header for OpenSearch 2.X headers: @@ -214,7 +214,7 @@ output.elasticsearch: > -This configuration deactivates the template configuration (unneeded for our endpoint). You need to provide your credentials **** and **** of your account. Like all Logs Data Platform APIs you can also use [tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens). Don't change **ldp-logs** since it is our special destination index. +This configuration deactivates the template configuration (unneeded for our endpoint). You need to provide your IAM credentials **pat_jwt_** and **** of your account. Like all Logs Data Platform backend APIs you can use [IAM tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens). Don't change **ldp-logs** since it is our special destination index. When you use our OpenSearch endpoint with filebeat, it will use the [ingest module](https://www.elastic.co/guide/en/logstash/7.12/use-ingest-pipelines.html) to parse and structure the logs. @@ -310,8 +310,8 @@ Note the type value (apache or syslog or apache-error) that indicates the source Filebeat is a handy tool to send the content of your current log files to Logs Data Platform. It offers a clean and easy way to send your logs without changing the configuration of your software. Don't hesitate to check the links below to master this tool. -- Configuration's details: [https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-configuration-details.html](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-configuration-details.html) -- Getting started: [https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-getting-started.html](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-getting-started.html) +- Getting started: [https://www.elastic.co/guide/en/beats/filebeat/7.12/filebeat-overview.html](https://www.elastic.co/guide/en/beats/filebeat/7.12/filebeat-overview.html) +- Configuration's details: [https://www.elastic.co/guide/en/beats/filebeat/7.12/configuring-howto-filebeat.html](https://www.elastic.co/guide/en/beats/filebeat/7.12/configuring-howto-filebeat.html) - Learn how to configure Filebeat and Logstash to add your own extra filters: [Dedicated input - Logstash](/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input) ## Going further @@ -319,4 +319,4 @@ Filebeat is a handy tool to send the content of your current log files to Logs D - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.pl-pl.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.pl-pl.md index 0c10b0739cc..3eae51c3f33 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.pl-pl.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.pl-pl.md @@ -1,13 +1,13 @@ --- title: Pushing logs with a forwarder - Filebeat (Linux) -updated: 2024-11-28 +updated: 2025-10-16 --- ## Objective [Filebeat](https://github.com/elastic/beats/tree/master/filebeat) is an open source file harvester, used to fetch logs files and can be easily setup to feed them into Logs Data Platform. -The main benefits of Filebeat are it's resilient protocol to send logs, and a variety of modules ready-to-use for most of the common applications. +The main benefits of Filebeat are its resilient protocol to send logs, and a variety of ready-to-use modules for most of the common applications. This guide will describe how to setup Filebeat OSS on your system for forwarding your logs on Logs Data Platform. It will also present you with some configuration setup useful to further structure your logs. @@ -199,8 +199,8 @@ output.elasticsearch: protocol: "https" # Authentication credentials - either API key or username/password. - username: "" - password: "" + username: "pat_jwt_" + password: "" index: "ldp-logs" # Header for OpenSearch 2.X headers: @@ -214,7 +214,7 @@ output.elasticsearch: > -This configuration deactivates the template configuration (unneeded for our endpoint). You need to provide your credentials **** and **** of your account. Like all Logs Data Platform APIs you can also use [tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens). Don't change **ldp-logs** since it is our special destination index. +This configuration deactivates the template configuration (unneeded for our endpoint). You need to provide your IAM credentials **pat_jwt_** and **** of your account. Like all Logs Data Platform backend APIs you can use [IAM tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens). Don't change **ldp-logs** since it is our special destination index. When you use our OpenSearch endpoint with filebeat, it will use the [ingest module](https://www.elastic.co/guide/en/logstash/7.12/use-ingest-pipelines.html) to parse and structure the logs. @@ -310,8 +310,8 @@ Note the type value (apache or syslog or apache-error) that indicates the source Filebeat is a handy tool to send the content of your current log files to Logs Data Platform. It offers a clean and easy way to send your logs without changing the configuration of your software. Don't hesitate to check the links below to master this tool. -- Configuration's details: [https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-configuration-details.html](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-configuration-details.html) -- Getting started: [https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-getting-started.html](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-getting-started.html) +- Getting started: [https://www.elastic.co/guide/en/beats/filebeat/7.12/filebeat-overview.html](https://www.elastic.co/guide/en/beats/filebeat/7.12/filebeat-overview.html) +- Configuration's details: [https://www.elastic.co/guide/en/beats/filebeat/7.12/configuring-howto-filebeat.html](https://www.elastic.co/guide/en/beats/filebeat/7.12/configuring-howto-filebeat.html) - Learn how to configure Filebeat and Logstash to add your own extra filters: [Dedicated input - Logstash](/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input) ## Going further @@ -319,4 +319,4 @@ Filebeat is a handy tool to send the content of your current log files to Logs D - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.pt-pt.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.pt-pt.md index 0c10b0739cc..3eae51c3f33 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.pt-pt.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/guide.pt-pt.md @@ -1,13 +1,13 @@ --- title: Pushing logs with a forwarder - Filebeat (Linux) -updated: 2024-11-28 +updated: 2025-10-16 --- ## Objective [Filebeat](https://github.com/elastic/beats/tree/master/filebeat) is an open source file harvester, used to fetch logs files and can be easily setup to feed them into Logs Data Platform. -The main benefits of Filebeat are it's resilient protocol to send logs, and a variety of modules ready-to-use for most of the common applications. +The main benefits of Filebeat are its resilient protocol to send logs, and a variety of ready-to-use modules for most of the common applications. This guide will describe how to setup Filebeat OSS on your system for forwarding your logs on Logs Data Platform. It will also present you with some configuration setup useful to further structure your logs. @@ -199,8 +199,8 @@ output.elasticsearch: protocol: "https" # Authentication credentials - either API key or username/password. - username: "" - password: "" + username: "pat_jwt_" + password: "" index: "ldp-logs" # Header for OpenSearch 2.X headers: @@ -214,7 +214,7 @@ output.elasticsearch: > -This configuration deactivates the template configuration (unneeded for our endpoint). You need to provide your credentials **** and **** of your account. Like all Logs Data Platform APIs you can also use [tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens). Don't change **ldp-logs** since it is our special destination index. +This configuration deactivates the template configuration (unneeded for our endpoint). You need to provide your IAM credentials **pat_jwt_** and **** of your account. Like all Logs Data Platform backend APIs you can use [IAM tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens). Don't change **ldp-logs** since it is our special destination index. When you use our OpenSearch endpoint with filebeat, it will use the [ingest module](https://www.elastic.co/guide/en/logstash/7.12/use-ingest-pipelines.html) to parse and structure the logs. @@ -310,8 +310,8 @@ Note the type value (apache or syslog or apache-error) that indicates the source Filebeat is a handy tool to send the content of your current log files to Logs Data Platform. It offers a clean and easy way to send your logs without changing the configuration of your software. Don't hesitate to check the links below to master this tool. -- Configuration's details: [https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-configuration-details.html](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-configuration-details.html) -- Getting started: [https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-getting-started.html](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-getting-started.html) +- Getting started: [https://www.elastic.co/guide/en/beats/filebeat/7.12/filebeat-overview.html](https://www.elastic.co/guide/en/beats/filebeat/7.12/filebeat-overview.html) +- Configuration's details: [https://www.elastic.co/guide/en/beats/filebeat/7.12/configuring-howto-filebeat.html](https://www.elastic.co/guide/en/beats/filebeat/7.12/configuring-howto-filebeat.html) - Learn how to configure Filebeat and Logstash to add your own extra filters: [Dedicated input - Logstash](/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input) ## Going further @@ -319,4 +319,4 @@ Filebeat is a handy tool to send the content of your current log files to Logs D - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/images/filter_graylog.png b/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/images/filter_graylog.png deleted file mode 100644 index f508f4be81c..00000000000 Binary files a/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat/images/filter_graylog.png and /dev/null differ diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.de-de.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.de-de.md index 35e4585183a..b78e4b06ecb 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.de-de.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.de-de.md @@ -119,7 +119,7 @@ To host this collector in the Logs Data Platform, you will need to configure it - Fill the main port of your input. We need to know which port you will use in your input configuration. We will put **4000** for now. This is also a setting you can change later. - If you want to restrict the Logstash to specific IP Adresses, you can use the **Trusted Networks** field to firewall your instances. Add every IP Adress or subnet you want to allow, separated by comma. Leave it empty to allow any IP to contact it. Your collector will have a public IP Adress, you can use this feature to prevent people to send you false information in it. - Select one of the streams you have to attached this collector to the stream you have. That means that every message that goes out of this collector is automatically routed to the stream. -- Finally, select the number of instances you would need to handle your load. We recommend to have at least two instances to ensure the high availabilty of your Logstash. However some uses cases need you to limit the number of instance at 1 (like the [Twitter use case](/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter)). +- Finally, select the number of instances you would need to handle your load. We recommend to have at least two instances to ensure the high availabilty of your Logstash. However some uses cases need you to limit the number of instance at 1. - Note that you can also choose to *automatically scale the number of instances*. In this case, you need to select a minimum and maximum number of instances. Your input will then be started with the selected minimum number of instances. If these instances face a heavy load for a certain amount of time (more than 1 minute), your input will be automatically scaled up — one new instance at the time — until it reaches the selected maximum number of instances. On the other hand, if the load decreases, this number of instances will be scaled down until it reaches the minimum number of instances. ![logstash_creation](images/logstash_created.png){.thumbnail} @@ -158,7 +158,7 @@ If we take the configuration example above and if we enable the SSL encryption, ssl_certificate => "/etc/ssl/private/server.crt" ssl_key => "/etc/ssl/private/server.key" ssl_extra_chain_certs => ["/etc/ssl/private/ca.crt"] - } + } ``` ![logstash_creation](images/input_section.png){.thumbnail} @@ -372,4 +372,4 @@ That's all you need to know about the Logstash Collector on Logs Data Platform. - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.en-asia.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.en-asia.md index 35e4585183a..b78e4b06ecb 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.en-asia.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.en-asia.md @@ -119,7 +119,7 @@ To host this collector in the Logs Data Platform, you will need to configure it - Fill the main port of your input. We need to know which port you will use in your input configuration. We will put **4000** for now. This is also a setting you can change later. - If you want to restrict the Logstash to specific IP Adresses, you can use the **Trusted Networks** field to firewall your instances. Add every IP Adress or subnet you want to allow, separated by comma. Leave it empty to allow any IP to contact it. Your collector will have a public IP Adress, you can use this feature to prevent people to send you false information in it. - Select one of the streams you have to attached this collector to the stream you have. That means that every message that goes out of this collector is automatically routed to the stream. -- Finally, select the number of instances you would need to handle your load. We recommend to have at least two instances to ensure the high availabilty of your Logstash. However some uses cases need you to limit the number of instance at 1 (like the [Twitter use case](/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter)). +- Finally, select the number of instances you would need to handle your load. We recommend to have at least two instances to ensure the high availabilty of your Logstash. However some uses cases need you to limit the number of instance at 1. - Note that you can also choose to *automatically scale the number of instances*. In this case, you need to select a minimum and maximum number of instances. Your input will then be started with the selected minimum number of instances. If these instances face a heavy load for a certain amount of time (more than 1 minute), your input will be automatically scaled up — one new instance at the time — until it reaches the selected maximum number of instances. On the other hand, if the load decreases, this number of instances will be scaled down until it reaches the minimum number of instances. ![logstash_creation](images/logstash_created.png){.thumbnail} @@ -158,7 +158,7 @@ If we take the configuration example above and if we enable the SSL encryption, ssl_certificate => "/etc/ssl/private/server.crt" ssl_key => "/etc/ssl/private/server.key" ssl_extra_chain_certs => ["/etc/ssl/private/ca.crt"] - } + } ``` ![logstash_creation](images/input_section.png){.thumbnail} @@ -372,4 +372,4 @@ That's all you need to know about the Logstash Collector on Logs Data Platform. - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.en-au.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.en-au.md index 35e4585183a..86d8bcf1f1d 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.en-au.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.en-au.md @@ -119,7 +119,7 @@ To host this collector in the Logs Data Platform, you will need to configure it - Fill the main port of your input. We need to know which port you will use in your input configuration. We will put **4000** for now. This is also a setting you can change later. - If you want to restrict the Logstash to specific IP Adresses, you can use the **Trusted Networks** field to firewall your instances. Add every IP Adress or subnet you want to allow, separated by comma. Leave it empty to allow any IP to contact it. Your collector will have a public IP Adress, you can use this feature to prevent people to send you false information in it. - Select one of the streams you have to attached this collector to the stream you have. That means that every message that goes out of this collector is automatically routed to the stream. -- Finally, select the number of instances you would need to handle your load. We recommend to have at least two instances to ensure the high availabilty of your Logstash. However some uses cases need you to limit the number of instance at 1 (like the [Twitter use case](/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter)). +- Finally, select the number of instances you would need to handle your load. We recommend to have at least two instances to ensure the high availabilty of your Logstash. However some uses cases need you to limit the number of instance at 1. - Note that you can also choose to *automatically scale the number of instances*. In this case, you need to select a minimum and maximum number of instances. Your input will then be started with the selected minimum number of instances. If these instances face a heavy load for a certain amount of time (more than 1 minute), your input will be automatically scaled up — one new instance at the time — until it reaches the selected maximum number of instances. On the other hand, if the load decreases, this number of instances will be scaled down until it reaches the minimum number of instances. ![logstash_creation](images/logstash_created.png){.thumbnail} @@ -372,4 +372,4 @@ That's all you need to know about the Logstash Collector on Logs Data Platform. - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.en-ca.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.en-ca.md index 35e4585183a..b78e4b06ecb 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.en-ca.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.en-ca.md @@ -119,7 +119,7 @@ To host this collector in the Logs Data Platform, you will need to configure it - Fill the main port of your input. We need to know which port you will use in your input configuration. We will put **4000** for now. This is also a setting you can change later. - If you want to restrict the Logstash to specific IP Adresses, you can use the **Trusted Networks** field to firewall your instances. Add every IP Adress or subnet you want to allow, separated by comma. Leave it empty to allow any IP to contact it. Your collector will have a public IP Adress, you can use this feature to prevent people to send you false information in it. - Select one of the streams you have to attached this collector to the stream you have. That means that every message that goes out of this collector is automatically routed to the stream. -- Finally, select the number of instances you would need to handle your load. We recommend to have at least two instances to ensure the high availabilty of your Logstash. However some uses cases need you to limit the number of instance at 1 (like the [Twitter use case](/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter)). +- Finally, select the number of instances you would need to handle your load. We recommend to have at least two instances to ensure the high availabilty of your Logstash. However some uses cases need you to limit the number of instance at 1. - Note that you can also choose to *automatically scale the number of instances*. In this case, you need to select a minimum and maximum number of instances. Your input will then be started with the selected minimum number of instances. If these instances face a heavy load for a certain amount of time (more than 1 minute), your input will be automatically scaled up — one new instance at the time — until it reaches the selected maximum number of instances. On the other hand, if the load decreases, this number of instances will be scaled down until it reaches the minimum number of instances. ![logstash_creation](images/logstash_created.png){.thumbnail} @@ -158,7 +158,7 @@ If we take the configuration example above and if we enable the SSL encryption, ssl_certificate => "/etc/ssl/private/server.crt" ssl_key => "/etc/ssl/private/server.key" ssl_extra_chain_certs => ["/etc/ssl/private/ca.crt"] - } + } ``` ![logstash_creation](images/input_section.png){.thumbnail} @@ -372,4 +372,4 @@ That's all you need to know about the Logstash Collector on Logs Data Platform. - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.en-gb.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.en-gb.md index 35e4585183a..b78e4b06ecb 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.en-gb.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.en-gb.md @@ -119,7 +119,7 @@ To host this collector in the Logs Data Platform, you will need to configure it - Fill the main port of your input. We need to know which port you will use in your input configuration. We will put **4000** for now. This is also a setting you can change later. - If you want to restrict the Logstash to specific IP Adresses, you can use the **Trusted Networks** field to firewall your instances. Add every IP Adress or subnet you want to allow, separated by comma. Leave it empty to allow any IP to contact it. Your collector will have a public IP Adress, you can use this feature to prevent people to send you false information in it. - Select one of the streams you have to attached this collector to the stream you have. That means that every message that goes out of this collector is automatically routed to the stream. -- Finally, select the number of instances you would need to handle your load. We recommend to have at least two instances to ensure the high availabilty of your Logstash. However some uses cases need you to limit the number of instance at 1 (like the [Twitter use case](/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter)). +- Finally, select the number of instances you would need to handle your load. We recommend to have at least two instances to ensure the high availabilty of your Logstash. However some uses cases need you to limit the number of instance at 1. - Note that you can also choose to *automatically scale the number of instances*. In this case, you need to select a minimum and maximum number of instances. Your input will then be started with the selected minimum number of instances. If these instances face a heavy load for a certain amount of time (more than 1 minute), your input will be automatically scaled up — one new instance at the time — until it reaches the selected maximum number of instances. On the other hand, if the load decreases, this number of instances will be scaled down until it reaches the minimum number of instances. ![logstash_creation](images/logstash_created.png){.thumbnail} @@ -158,7 +158,7 @@ If we take the configuration example above and if we enable the SSL encryption, ssl_certificate => "/etc/ssl/private/server.crt" ssl_key => "/etc/ssl/private/server.key" ssl_extra_chain_certs => ["/etc/ssl/private/ca.crt"] - } + } ``` ![logstash_creation](images/input_section.png){.thumbnail} @@ -372,4 +372,4 @@ That's all you need to know about the Logstash Collector on Logs Data Platform. - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.en-ie.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.en-ie.md index 35e4585183a..b78e4b06ecb 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.en-ie.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.en-ie.md @@ -119,7 +119,7 @@ To host this collector in the Logs Data Platform, you will need to configure it - Fill the main port of your input. We need to know which port you will use in your input configuration. We will put **4000** for now. This is also a setting you can change later. - If you want to restrict the Logstash to specific IP Adresses, you can use the **Trusted Networks** field to firewall your instances. Add every IP Adress or subnet you want to allow, separated by comma. Leave it empty to allow any IP to contact it. Your collector will have a public IP Adress, you can use this feature to prevent people to send you false information in it. - Select one of the streams you have to attached this collector to the stream you have. That means that every message that goes out of this collector is automatically routed to the stream. -- Finally, select the number of instances you would need to handle your load. We recommend to have at least two instances to ensure the high availabilty of your Logstash. However some uses cases need you to limit the number of instance at 1 (like the [Twitter use case](/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter)). +- Finally, select the number of instances you would need to handle your load. We recommend to have at least two instances to ensure the high availabilty of your Logstash. However some uses cases need you to limit the number of instance at 1. - Note that you can also choose to *automatically scale the number of instances*. In this case, you need to select a minimum and maximum number of instances. Your input will then be started with the selected minimum number of instances. If these instances face a heavy load for a certain amount of time (more than 1 minute), your input will be automatically scaled up — one new instance at the time — until it reaches the selected maximum number of instances. On the other hand, if the load decreases, this number of instances will be scaled down until it reaches the minimum number of instances. ![logstash_creation](images/logstash_created.png){.thumbnail} @@ -158,7 +158,7 @@ If we take the configuration example above and if we enable the SSL encryption, ssl_certificate => "/etc/ssl/private/server.crt" ssl_key => "/etc/ssl/private/server.key" ssl_extra_chain_certs => ["/etc/ssl/private/ca.crt"] - } + } ``` ![logstash_creation](images/input_section.png){.thumbnail} @@ -372,4 +372,4 @@ That's all you need to know about the Logstash Collector on Logs Data Platform. - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.en-sg.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.en-sg.md index 35e4585183a..b78e4b06ecb 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.en-sg.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.en-sg.md @@ -119,7 +119,7 @@ To host this collector in the Logs Data Platform, you will need to configure it - Fill the main port of your input. We need to know which port you will use in your input configuration. We will put **4000** for now. This is also a setting you can change later. - If you want to restrict the Logstash to specific IP Adresses, you can use the **Trusted Networks** field to firewall your instances. Add every IP Adress or subnet you want to allow, separated by comma. Leave it empty to allow any IP to contact it. Your collector will have a public IP Adress, you can use this feature to prevent people to send you false information in it. - Select one of the streams you have to attached this collector to the stream you have. That means that every message that goes out of this collector is automatically routed to the stream. -- Finally, select the number of instances you would need to handle your load. We recommend to have at least two instances to ensure the high availabilty of your Logstash. However some uses cases need you to limit the number of instance at 1 (like the [Twitter use case](/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter)). +- Finally, select the number of instances you would need to handle your load. We recommend to have at least two instances to ensure the high availabilty of your Logstash. However some uses cases need you to limit the number of instance at 1. - Note that you can also choose to *automatically scale the number of instances*. In this case, you need to select a minimum and maximum number of instances. Your input will then be started with the selected minimum number of instances. If these instances face a heavy load for a certain amount of time (more than 1 minute), your input will be automatically scaled up — one new instance at the time — until it reaches the selected maximum number of instances. On the other hand, if the load decreases, this number of instances will be scaled down until it reaches the minimum number of instances. ![logstash_creation](images/logstash_created.png){.thumbnail} @@ -158,7 +158,7 @@ If we take the configuration example above and if we enable the SSL encryption, ssl_certificate => "/etc/ssl/private/server.crt" ssl_key => "/etc/ssl/private/server.key" ssl_extra_chain_certs => ["/etc/ssl/private/ca.crt"] - } + } ``` ![logstash_creation](images/input_section.png){.thumbnail} @@ -372,4 +372,4 @@ That's all you need to know about the Logstash Collector on Logs Data Platform. - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.en-us.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.en-us.md index 35e4585183a..b78e4b06ecb 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.en-us.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.en-us.md @@ -119,7 +119,7 @@ To host this collector in the Logs Data Platform, you will need to configure it - Fill the main port of your input. We need to know which port you will use in your input configuration. We will put **4000** for now. This is also a setting you can change later. - If you want to restrict the Logstash to specific IP Adresses, you can use the **Trusted Networks** field to firewall your instances. Add every IP Adress or subnet you want to allow, separated by comma. Leave it empty to allow any IP to contact it. Your collector will have a public IP Adress, you can use this feature to prevent people to send you false information in it. - Select one of the streams you have to attached this collector to the stream you have. That means that every message that goes out of this collector is automatically routed to the stream. -- Finally, select the number of instances you would need to handle your load. We recommend to have at least two instances to ensure the high availabilty of your Logstash. However some uses cases need you to limit the number of instance at 1 (like the [Twitter use case](/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter)). +- Finally, select the number of instances you would need to handle your load. We recommend to have at least two instances to ensure the high availabilty of your Logstash. However some uses cases need you to limit the number of instance at 1. - Note that you can also choose to *automatically scale the number of instances*. In this case, you need to select a minimum and maximum number of instances. Your input will then be started with the selected minimum number of instances. If these instances face a heavy load for a certain amount of time (more than 1 minute), your input will be automatically scaled up — one new instance at the time — until it reaches the selected maximum number of instances. On the other hand, if the load decreases, this number of instances will be scaled down until it reaches the minimum number of instances. ![logstash_creation](images/logstash_created.png){.thumbnail} @@ -158,7 +158,7 @@ If we take the configuration example above and if we enable the SSL encryption, ssl_certificate => "/etc/ssl/private/server.crt" ssl_key => "/etc/ssl/private/server.key" ssl_extra_chain_certs => ["/etc/ssl/private/ca.crt"] - } + } ``` ![logstash_creation](images/input_section.png){.thumbnail} @@ -372,4 +372,4 @@ That's all you need to know about the Logstash Collector on Logs Data Platform. - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.es-es.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.es-es.md index 35e4585183a..b78e4b06ecb 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.es-es.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.es-es.md @@ -119,7 +119,7 @@ To host this collector in the Logs Data Platform, you will need to configure it - Fill the main port of your input. We need to know which port you will use in your input configuration. We will put **4000** for now. This is also a setting you can change later. - If you want to restrict the Logstash to specific IP Adresses, you can use the **Trusted Networks** field to firewall your instances. Add every IP Adress or subnet you want to allow, separated by comma. Leave it empty to allow any IP to contact it. Your collector will have a public IP Adress, you can use this feature to prevent people to send you false information in it. - Select one of the streams you have to attached this collector to the stream you have. That means that every message that goes out of this collector is automatically routed to the stream. -- Finally, select the number of instances you would need to handle your load. We recommend to have at least two instances to ensure the high availabilty of your Logstash. However some uses cases need you to limit the number of instance at 1 (like the [Twitter use case](/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter)). +- Finally, select the number of instances you would need to handle your load. We recommend to have at least two instances to ensure the high availabilty of your Logstash. However some uses cases need you to limit the number of instance at 1. - Note that you can also choose to *automatically scale the number of instances*. In this case, you need to select a minimum and maximum number of instances. Your input will then be started with the selected minimum number of instances. If these instances face a heavy load for a certain amount of time (more than 1 minute), your input will be automatically scaled up — one new instance at the time — until it reaches the selected maximum number of instances. On the other hand, if the load decreases, this number of instances will be scaled down until it reaches the minimum number of instances. ![logstash_creation](images/logstash_created.png){.thumbnail} @@ -158,7 +158,7 @@ If we take the configuration example above and if we enable the SSL encryption, ssl_certificate => "/etc/ssl/private/server.crt" ssl_key => "/etc/ssl/private/server.key" ssl_extra_chain_certs => ["/etc/ssl/private/ca.crt"] - } + } ``` ![logstash_creation](images/input_section.png){.thumbnail} @@ -372,4 +372,4 @@ That's all you need to know about the Logstash Collector on Logs Data Platform. - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.es-us.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.es-us.md index 35e4585183a..3209917816c 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.es-us.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.es-us.md @@ -119,7 +119,7 @@ To host this collector in the Logs Data Platform, you will need to configure it - Fill the main port of your input. We need to know which port you will use in your input configuration. We will put **4000** for now. This is also a setting you can change later. - If you want to restrict the Logstash to specific IP Adresses, you can use the **Trusted Networks** field to firewall your instances. Add every IP Adress or subnet you want to allow, separated by comma. Leave it empty to allow any IP to contact it. Your collector will have a public IP Adress, you can use this feature to prevent people to send you false information in it. - Select one of the streams you have to attached this collector to the stream you have. That means that every message that goes out of this collector is automatically routed to the stream. -- Finally, select the number of instances you would need to handle your load. We recommend to have at least two instances to ensure the high availabilty of your Logstash. However some uses cases need you to limit the number of instance at 1 (like the [Twitter use case](/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter)). +- Finally, select the number of instances you would need to handle your load. We recommend to have at least two instances to ensure the high availabilty of your Logstash. However some uses cases need you to limit the number of instance at 1. - Note that you can also choose to *automatically scale the number of instances*. In this case, you need to select a minimum and maximum number of instances. Your input will then be started with the selected minimum number of instances. If these instances face a heavy load for a certain amount of time (more than 1 minute), your input will be automatically scaled up — one new instance at the time — until it reaches the selected maximum number of instances. On the other hand, if the load decreases, this number of instances will be scaled down until it reaches the minimum number of instances. ![logstash_creation](images/logstash_created.png){.thumbnail} @@ -158,7 +158,7 @@ If we take the configuration example above and if we enable the SSL encryption, ssl_certificate => "/etc/ssl/private/server.crt" ssl_key => "/etc/ssl/private/server.key" ssl_extra_chain_certs => ["/etc/ssl/private/ca.crt"] - } + } ``` ![logstash_creation](images/input_section.png){.thumbnail} diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.fr-ca.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.fr-ca.md index 35e4585183a..b78e4b06ecb 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.fr-ca.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.fr-ca.md @@ -119,7 +119,7 @@ To host this collector in the Logs Data Platform, you will need to configure it - Fill the main port of your input. We need to know which port you will use in your input configuration. We will put **4000** for now. This is also a setting you can change later. - If you want to restrict the Logstash to specific IP Adresses, you can use the **Trusted Networks** field to firewall your instances. Add every IP Adress or subnet you want to allow, separated by comma. Leave it empty to allow any IP to contact it. Your collector will have a public IP Adress, you can use this feature to prevent people to send you false information in it. - Select one of the streams you have to attached this collector to the stream you have. That means that every message that goes out of this collector is automatically routed to the stream. -- Finally, select the number of instances you would need to handle your load. We recommend to have at least two instances to ensure the high availabilty of your Logstash. However some uses cases need you to limit the number of instance at 1 (like the [Twitter use case](/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter)). +- Finally, select the number of instances you would need to handle your load. We recommend to have at least two instances to ensure the high availabilty of your Logstash. However some uses cases need you to limit the number of instance at 1. - Note that you can also choose to *automatically scale the number of instances*. In this case, you need to select a minimum and maximum number of instances. Your input will then be started with the selected minimum number of instances. If these instances face a heavy load for a certain amount of time (more than 1 minute), your input will be automatically scaled up — one new instance at the time — until it reaches the selected maximum number of instances. On the other hand, if the load decreases, this number of instances will be scaled down until it reaches the minimum number of instances. ![logstash_creation](images/logstash_created.png){.thumbnail} @@ -158,7 +158,7 @@ If we take the configuration example above and if we enable the SSL encryption, ssl_certificate => "/etc/ssl/private/server.crt" ssl_key => "/etc/ssl/private/server.key" ssl_extra_chain_certs => ["/etc/ssl/private/ca.crt"] - } + } ``` ![logstash_creation](images/input_section.png){.thumbnail} @@ -372,4 +372,4 @@ That's all you need to know about the Logstash Collector on Logs Data Platform. - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.fr-fr.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.fr-fr.md index 35e4585183a..b78e4b06ecb 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.fr-fr.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.fr-fr.md @@ -119,7 +119,7 @@ To host this collector in the Logs Data Platform, you will need to configure it - Fill the main port of your input. We need to know which port you will use in your input configuration. We will put **4000** for now. This is also a setting you can change later. - If you want to restrict the Logstash to specific IP Adresses, you can use the **Trusted Networks** field to firewall your instances. Add every IP Adress or subnet you want to allow, separated by comma. Leave it empty to allow any IP to contact it. Your collector will have a public IP Adress, you can use this feature to prevent people to send you false information in it. - Select one of the streams you have to attached this collector to the stream you have. That means that every message that goes out of this collector is automatically routed to the stream. -- Finally, select the number of instances you would need to handle your load. We recommend to have at least two instances to ensure the high availabilty of your Logstash. However some uses cases need you to limit the number of instance at 1 (like the [Twitter use case](/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter)). +- Finally, select the number of instances you would need to handle your load. We recommend to have at least two instances to ensure the high availabilty of your Logstash. However some uses cases need you to limit the number of instance at 1. - Note that you can also choose to *automatically scale the number of instances*. In this case, you need to select a minimum and maximum number of instances. Your input will then be started with the selected minimum number of instances. If these instances face a heavy load for a certain amount of time (more than 1 minute), your input will be automatically scaled up — one new instance at the time — until it reaches the selected maximum number of instances. On the other hand, if the load decreases, this number of instances will be scaled down until it reaches the minimum number of instances. ![logstash_creation](images/logstash_created.png){.thumbnail} @@ -158,7 +158,7 @@ If we take the configuration example above and if we enable the SSL encryption, ssl_certificate => "/etc/ssl/private/server.crt" ssl_key => "/etc/ssl/private/server.key" ssl_extra_chain_certs => ["/etc/ssl/private/ca.crt"] - } + } ``` ![logstash_creation](images/input_section.png){.thumbnail} @@ -372,4 +372,4 @@ That's all you need to know about the Logstash Collector on Logs Data Platform. - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.it-it.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.it-it.md index 35e4585183a..b78e4b06ecb 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.it-it.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.it-it.md @@ -119,7 +119,7 @@ To host this collector in the Logs Data Platform, you will need to configure it - Fill the main port of your input. We need to know which port you will use in your input configuration. We will put **4000** for now. This is also a setting you can change later. - If you want to restrict the Logstash to specific IP Adresses, you can use the **Trusted Networks** field to firewall your instances. Add every IP Adress or subnet you want to allow, separated by comma. Leave it empty to allow any IP to contact it. Your collector will have a public IP Adress, you can use this feature to prevent people to send you false information in it. - Select one of the streams you have to attached this collector to the stream you have. That means that every message that goes out of this collector is automatically routed to the stream. -- Finally, select the number of instances you would need to handle your load. We recommend to have at least two instances to ensure the high availabilty of your Logstash. However some uses cases need you to limit the number of instance at 1 (like the [Twitter use case](/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter)). +- Finally, select the number of instances you would need to handle your load. We recommend to have at least two instances to ensure the high availabilty of your Logstash. However some uses cases need you to limit the number of instance at 1. - Note that you can also choose to *automatically scale the number of instances*. In this case, you need to select a minimum and maximum number of instances. Your input will then be started with the selected minimum number of instances. If these instances face a heavy load for a certain amount of time (more than 1 minute), your input will be automatically scaled up — one new instance at the time — until it reaches the selected maximum number of instances. On the other hand, if the load decreases, this number of instances will be scaled down until it reaches the minimum number of instances. ![logstash_creation](images/logstash_created.png){.thumbnail} @@ -158,7 +158,7 @@ If we take the configuration example above and if we enable the SSL encryption, ssl_certificate => "/etc/ssl/private/server.crt" ssl_key => "/etc/ssl/private/server.key" ssl_extra_chain_certs => ["/etc/ssl/private/ca.crt"] - } + } ``` ![logstash_creation](images/input_section.png){.thumbnail} @@ -372,4 +372,4 @@ That's all you need to know about the Logstash Collector on Logs Data Platform. - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.pl-pl.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.pl-pl.md index 35e4585183a..b78e4b06ecb 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.pl-pl.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.pl-pl.md @@ -119,7 +119,7 @@ To host this collector in the Logs Data Platform, you will need to configure it - Fill the main port of your input. We need to know which port you will use in your input configuration. We will put **4000** for now. This is also a setting you can change later. - If you want to restrict the Logstash to specific IP Adresses, you can use the **Trusted Networks** field to firewall your instances. Add every IP Adress or subnet you want to allow, separated by comma. Leave it empty to allow any IP to contact it. Your collector will have a public IP Adress, you can use this feature to prevent people to send you false information in it. - Select one of the streams you have to attached this collector to the stream you have. That means that every message that goes out of this collector is automatically routed to the stream. -- Finally, select the number of instances you would need to handle your load. We recommend to have at least two instances to ensure the high availabilty of your Logstash. However some uses cases need you to limit the number of instance at 1 (like the [Twitter use case](/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter)). +- Finally, select the number of instances you would need to handle your load. We recommend to have at least two instances to ensure the high availabilty of your Logstash. However some uses cases need you to limit the number of instance at 1. - Note that you can also choose to *automatically scale the number of instances*. In this case, you need to select a minimum and maximum number of instances. Your input will then be started with the selected minimum number of instances. If these instances face a heavy load for a certain amount of time (more than 1 minute), your input will be automatically scaled up — one new instance at the time — until it reaches the selected maximum number of instances. On the other hand, if the load decreases, this number of instances will be scaled down until it reaches the minimum number of instances. ![logstash_creation](images/logstash_created.png){.thumbnail} @@ -158,7 +158,7 @@ If we take the configuration example above and if we enable the SSL encryption, ssl_certificate => "/etc/ssl/private/server.crt" ssl_key => "/etc/ssl/private/server.key" ssl_extra_chain_certs => ["/etc/ssl/private/ca.crt"] - } + } ``` ![logstash_creation](images/input_section.png){.thumbnail} @@ -372,4 +372,4 @@ That's all you need to know about the Logstash Collector on Logs Data Platform. - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.pt-pt.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.pt-pt.md index 35e4585183a..b78e4b06ecb 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.pt-pt.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input/guide.pt-pt.md @@ -119,7 +119,7 @@ To host this collector in the Logs Data Platform, you will need to configure it - Fill the main port of your input. We need to know which port you will use in your input configuration. We will put **4000** for now. This is also a setting you can change later. - If you want to restrict the Logstash to specific IP Adresses, you can use the **Trusted Networks** field to firewall your instances. Add every IP Adress or subnet you want to allow, separated by comma. Leave it empty to allow any IP to contact it. Your collector will have a public IP Adress, you can use this feature to prevent people to send you false information in it. - Select one of the streams you have to attached this collector to the stream you have. That means that every message that goes out of this collector is automatically routed to the stream. -- Finally, select the number of instances you would need to handle your load. We recommend to have at least two instances to ensure the high availabilty of your Logstash. However some uses cases need you to limit the number of instance at 1 (like the [Twitter use case](/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter)). +- Finally, select the number of instances you would need to handle your load. We recommend to have at least two instances to ensure the high availabilty of your Logstash. However some uses cases need you to limit the number of instance at 1. - Note that you can also choose to *automatically scale the number of instances*. In this case, you need to select a minimum and maximum number of instances. Your input will then be started with the selected minimum number of instances. If these instances face a heavy load for a certain amount of time (more than 1 minute), your input will be automatically scaled up — one new instance at the time — until it reaches the selected maximum number of instances. On the other hand, if the load decreases, this number of instances will be scaled down until it reaches the minimum number of instances. ![logstash_creation](images/logstash_created.png){.thumbnail} @@ -158,7 +158,7 @@ If we take the configuration example above and if we enable the SSL encryption, ssl_certificate => "/etc/ssl/private/server.crt" ssl_key => "/etc/ssl/private/server.key" ssl_extra_chain_certs => ["/etc/ssl/private/ca.crt"] - } + } ``` ![logstash_creation](images/input_section.png){.thumbnail} @@ -372,4 +372,4 @@ That's all you need to know about the Logstash Collector on Logs Data Platform. - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.de-de.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.de-de.md index b035abbd503..6e085f7f1a0 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.de-de.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.de-de.md @@ -1,13 +1,13 @@ --- title: Mutualized Inputs excerpt: Discover what inputs are and how to use them to ingest your logs in Logs Data Platform -updated: 2023-06-02 +updated: 2025-10-16 --- ## Objective This guide will help you understand how to use the mutualized inputs of Logs Data Platform to ingest your logs to the platform. - + *Inputs* are the components from Logs Data Platform that you connect to ingest your logs in the platform. In this guide, we focus specifically on the mutualized inputs that are available to everyone by default. ## Prerequisites @@ -27,7 +27,7 @@ Logs Data Platform imposes a few [constraints](/pages/manage_and_operate/observa The log formats that are accepted by Logs Data Platform are the following: -- **GELF**: This is the native format of logs used by Graylog. This JSON format allows you to send logs really easily. See the [GELF Payload Specification](https://go2docs.graylog.org/4-x/getting_in_log_data/gelf.html?tocpath=Getting%20in%20Log%20Data%7CLog%20Sources%7CGELF%7C_____0#GELFPayloadSpecification). The GELF input only accepts a null (`\0`) delimiter. +- **GELF**: This is the native format of logs used by Graylog. This JSON format allows you to send logs really easily. See the [GELF Payload Specification](https://go2docs.graylog.org/4-0/getting_in_log_data/gelf.html?tocpath=Getting%20in%20Logs%7CLog%20Sources%7CGELF%7C_____0#GELFPayloadSpecification). The GELF input only accepts a null (`\0`) delimiter. - **LTSV**: This simple format is very efficient and human readable. You can learn more about it [here](http://ltsv.org). LTSV has two inputs that accept a line delimiter or a null delimiter. - **RFC 5424**: This format is commonly used by logs utilities such as syslog. It is extensible enough to allow you to send all your data. More information about it can be found [here](https://tools.ietf.org/html/rfc5424). - **Cap'n'Proto**: The most efficient log format. This is a binary format that allows you to maintain a low footprint and high speed performance. For more information, check out the official website: [Cap'n'Proto](https://capnproto.org/). @@ -83,11 +83,11 @@ You should now have all the information you need to configure your software to i ## Go Further -[Ingest your logs with Filebeat](/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat)
-[Ingest your logs with syslog-ng](/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng)
-[Ingest your logs with NXLog](/pages/manage_and_operate/observability/logs_data_platform/ingestion_windows_nxlog)
-[Push your logs with the OpenSearch API](/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input)
+[Ingest your logs with Filebeat](/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat)
+[Ingest your logs with syslog-ng](/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng)
+[Ingest your logs with NXLog](/pages/manage_and_operate/observability/logs_data_platform/ingestion_windows_nxlog)
+[Push your logs with the OpenSearch API](/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input)
[Python 2 SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_python_2_djehouty)
-[Python 3 SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_python_3_logging_ldp)
+[Python 3 SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_python_3_logging_ldp)
[Rust SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_rust_loggers)
-[Ingest the logs from your Kubernetes cluster](/pages/manage_and_operate/observability/logs_data_platform/ingestion_kubernetes_fluent_bit)
+[Ingest the logs from your Kubernetes cluster](/pages/manage_and_operate/observability/logs_data_platform/ingestion_kubernetes_fluent_bit)
\ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.en-asia.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.en-asia.md index b035abbd503..6e085f7f1a0 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.en-asia.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.en-asia.md @@ -1,13 +1,13 @@ --- title: Mutualized Inputs excerpt: Discover what inputs are and how to use them to ingest your logs in Logs Data Platform -updated: 2023-06-02 +updated: 2025-10-16 --- ## Objective This guide will help you understand how to use the mutualized inputs of Logs Data Platform to ingest your logs to the platform. - + *Inputs* are the components from Logs Data Platform that you connect to ingest your logs in the platform. In this guide, we focus specifically on the mutualized inputs that are available to everyone by default. ## Prerequisites @@ -27,7 +27,7 @@ Logs Data Platform imposes a few [constraints](/pages/manage_and_operate/observa The log formats that are accepted by Logs Data Platform are the following: -- **GELF**: This is the native format of logs used by Graylog. This JSON format allows you to send logs really easily. See the [GELF Payload Specification](https://go2docs.graylog.org/4-x/getting_in_log_data/gelf.html?tocpath=Getting%20in%20Log%20Data%7CLog%20Sources%7CGELF%7C_____0#GELFPayloadSpecification). The GELF input only accepts a null (`\0`) delimiter. +- **GELF**: This is the native format of logs used by Graylog. This JSON format allows you to send logs really easily. See the [GELF Payload Specification](https://go2docs.graylog.org/4-0/getting_in_log_data/gelf.html?tocpath=Getting%20in%20Logs%7CLog%20Sources%7CGELF%7C_____0#GELFPayloadSpecification). The GELF input only accepts a null (`\0`) delimiter. - **LTSV**: This simple format is very efficient and human readable. You can learn more about it [here](http://ltsv.org). LTSV has two inputs that accept a line delimiter or a null delimiter. - **RFC 5424**: This format is commonly used by logs utilities such as syslog. It is extensible enough to allow you to send all your data. More information about it can be found [here](https://tools.ietf.org/html/rfc5424). - **Cap'n'Proto**: The most efficient log format. This is a binary format that allows you to maintain a low footprint and high speed performance. For more information, check out the official website: [Cap'n'Proto](https://capnproto.org/). @@ -83,11 +83,11 @@ You should now have all the information you need to configure your software to i ## Go Further -[Ingest your logs with Filebeat](/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat)
-[Ingest your logs with syslog-ng](/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng)
-[Ingest your logs with NXLog](/pages/manage_and_operate/observability/logs_data_platform/ingestion_windows_nxlog)
-[Push your logs with the OpenSearch API](/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input)
+[Ingest your logs with Filebeat](/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat)
+[Ingest your logs with syslog-ng](/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng)
+[Ingest your logs with NXLog](/pages/manage_and_operate/observability/logs_data_platform/ingestion_windows_nxlog)
+[Push your logs with the OpenSearch API](/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input)
[Python 2 SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_python_2_djehouty)
-[Python 3 SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_python_3_logging_ldp)
+[Python 3 SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_python_3_logging_ldp)
[Rust SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_rust_loggers)
-[Ingest the logs from your Kubernetes cluster](/pages/manage_and_operate/observability/logs_data_platform/ingestion_kubernetes_fluent_bit)
+[Ingest the logs from your Kubernetes cluster](/pages/manage_and_operate/observability/logs_data_platform/ingestion_kubernetes_fluent_bit)
\ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.en-au.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.en-au.md index b035abbd503..6e085f7f1a0 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.en-au.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.en-au.md @@ -1,13 +1,13 @@ --- title: Mutualized Inputs excerpt: Discover what inputs are and how to use them to ingest your logs in Logs Data Platform -updated: 2023-06-02 +updated: 2025-10-16 --- ## Objective This guide will help you understand how to use the mutualized inputs of Logs Data Platform to ingest your logs to the platform. - + *Inputs* are the components from Logs Data Platform that you connect to ingest your logs in the platform. In this guide, we focus specifically on the mutualized inputs that are available to everyone by default. ## Prerequisites @@ -27,7 +27,7 @@ Logs Data Platform imposes a few [constraints](/pages/manage_and_operate/observa The log formats that are accepted by Logs Data Platform are the following: -- **GELF**: This is the native format of logs used by Graylog. This JSON format allows you to send logs really easily. See the [GELF Payload Specification](https://go2docs.graylog.org/4-x/getting_in_log_data/gelf.html?tocpath=Getting%20in%20Log%20Data%7CLog%20Sources%7CGELF%7C_____0#GELFPayloadSpecification). The GELF input only accepts a null (`\0`) delimiter. +- **GELF**: This is the native format of logs used by Graylog. This JSON format allows you to send logs really easily. See the [GELF Payload Specification](https://go2docs.graylog.org/4-0/getting_in_log_data/gelf.html?tocpath=Getting%20in%20Logs%7CLog%20Sources%7CGELF%7C_____0#GELFPayloadSpecification). The GELF input only accepts a null (`\0`) delimiter. - **LTSV**: This simple format is very efficient and human readable. You can learn more about it [here](http://ltsv.org). LTSV has two inputs that accept a line delimiter or a null delimiter. - **RFC 5424**: This format is commonly used by logs utilities such as syslog. It is extensible enough to allow you to send all your data. More information about it can be found [here](https://tools.ietf.org/html/rfc5424). - **Cap'n'Proto**: The most efficient log format. This is a binary format that allows you to maintain a low footprint and high speed performance. For more information, check out the official website: [Cap'n'Proto](https://capnproto.org/). @@ -83,11 +83,11 @@ You should now have all the information you need to configure your software to i ## Go Further -[Ingest your logs with Filebeat](/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat)
-[Ingest your logs with syslog-ng](/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng)
-[Ingest your logs with NXLog](/pages/manage_and_operate/observability/logs_data_platform/ingestion_windows_nxlog)
-[Push your logs with the OpenSearch API](/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input)
+[Ingest your logs with Filebeat](/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat)
+[Ingest your logs with syslog-ng](/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng)
+[Ingest your logs with NXLog](/pages/manage_and_operate/observability/logs_data_platform/ingestion_windows_nxlog)
+[Push your logs with the OpenSearch API](/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input)
[Python 2 SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_python_2_djehouty)
-[Python 3 SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_python_3_logging_ldp)
+[Python 3 SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_python_3_logging_ldp)
[Rust SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_rust_loggers)
-[Ingest the logs from your Kubernetes cluster](/pages/manage_and_operate/observability/logs_data_platform/ingestion_kubernetes_fluent_bit)
+[Ingest the logs from your Kubernetes cluster](/pages/manage_and_operate/observability/logs_data_platform/ingestion_kubernetes_fluent_bit)
\ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.en-ca.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.en-ca.md index b035abbd503..6e085f7f1a0 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.en-ca.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.en-ca.md @@ -1,13 +1,13 @@ --- title: Mutualized Inputs excerpt: Discover what inputs are and how to use them to ingest your logs in Logs Data Platform -updated: 2023-06-02 +updated: 2025-10-16 --- ## Objective This guide will help you understand how to use the mutualized inputs of Logs Data Platform to ingest your logs to the platform. - + *Inputs* are the components from Logs Data Platform that you connect to ingest your logs in the platform. In this guide, we focus specifically on the mutualized inputs that are available to everyone by default. ## Prerequisites @@ -27,7 +27,7 @@ Logs Data Platform imposes a few [constraints](/pages/manage_and_operate/observa The log formats that are accepted by Logs Data Platform are the following: -- **GELF**: This is the native format of logs used by Graylog. This JSON format allows you to send logs really easily. See the [GELF Payload Specification](https://go2docs.graylog.org/4-x/getting_in_log_data/gelf.html?tocpath=Getting%20in%20Log%20Data%7CLog%20Sources%7CGELF%7C_____0#GELFPayloadSpecification). The GELF input only accepts a null (`\0`) delimiter. +- **GELF**: This is the native format of logs used by Graylog. This JSON format allows you to send logs really easily. See the [GELF Payload Specification](https://go2docs.graylog.org/4-0/getting_in_log_data/gelf.html?tocpath=Getting%20in%20Logs%7CLog%20Sources%7CGELF%7C_____0#GELFPayloadSpecification). The GELF input only accepts a null (`\0`) delimiter. - **LTSV**: This simple format is very efficient and human readable. You can learn more about it [here](http://ltsv.org). LTSV has two inputs that accept a line delimiter or a null delimiter. - **RFC 5424**: This format is commonly used by logs utilities such as syslog. It is extensible enough to allow you to send all your data. More information about it can be found [here](https://tools.ietf.org/html/rfc5424). - **Cap'n'Proto**: The most efficient log format. This is a binary format that allows you to maintain a low footprint and high speed performance. For more information, check out the official website: [Cap'n'Proto](https://capnproto.org/). @@ -83,11 +83,11 @@ You should now have all the information you need to configure your software to i ## Go Further -[Ingest your logs with Filebeat](/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat)
-[Ingest your logs with syslog-ng](/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng)
-[Ingest your logs with NXLog](/pages/manage_and_operate/observability/logs_data_platform/ingestion_windows_nxlog)
-[Push your logs with the OpenSearch API](/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input)
+[Ingest your logs with Filebeat](/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat)
+[Ingest your logs with syslog-ng](/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng)
+[Ingest your logs with NXLog](/pages/manage_and_operate/observability/logs_data_platform/ingestion_windows_nxlog)
+[Push your logs with the OpenSearch API](/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input)
[Python 2 SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_python_2_djehouty)
-[Python 3 SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_python_3_logging_ldp)
+[Python 3 SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_python_3_logging_ldp)
[Rust SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_rust_loggers)
-[Ingest the logs from your Kubernetes cluster](/pages/manage_and_operate/observability/logs_data_platform/ingestion_kubernetes_fluent_bit)
+[Ingest the logs from your Kubernetes cluster](/pages/manage_and_operate/observability/logs_data_platform/ingestion_kubernetes_fluent_bit)
\ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.en-gb.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.en-gb.md index 94b35495c8a..6e085f7f1a0 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.en-gb.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.en-gb.md @@ -1,13 +1,13 @@ --- title: Mutualized Inputs excerpt: Discover what inputs are and how to use them to ingest your logs in Logs Data Platform -updated: 2023-06-02 +updated: 2025-10-16 --- ## Objective This guide will help you understand how to use the mutualized inputs of Logs Data Platform to ingest your logs to the platform. - + *Inputs* are the components from Logs Data Platform that you connect to ingest your logs in the platform. In this guide, we focus specifically on the mutualized inputs that are available to everyone by default. ## Prerequisites @@ -27,7 +27,7 @@ Logs Data Platform imposes a few [constraints](/pages/manage_and_operate/observa The log formats that are accepted by Logs Data Platform are the following: -- **GELF**: This is the native format of logs used by Graylog. This JSON format allows you to send logs really easily. See the [GELF Payload Specification](https://go2docs.graylog.org/4-x/getting_in_log_data/gelf.html?tocpath=Getting%20in%20Log%20Data%7CLog%20Sources%7CGELF%7C_____0#GELFPayloadSpecification). The GELF input only accepts a null (`\0`) delimiter. +- **GELF**: This is the native format of logs used by Graylog. This JSON format allows you to send logs really easily. See the [GELF Payload Specification](https://go2docs.graylog.org/4-0/getting_in_log_data/gelf.html?tocpath=Getting%20in%20Logs%7CLog%20Sources%7CGELF%7C_____0#GELFPayloadSpecification). The GELF input only accepts a null (`\0`) delimiter. - **LTSV**: This simple format is very efficient and human readable. You can learn more about it [here](http://ltsv.org). LTSV has two inputs that accept a line delimiter or a null delimiter. - **RFC 5424**: This format is commonly used by logs utilities such as syslog. It is extensible enough to allow you to send all your data. More information about it can be found [here](https://tools.ietf.org/html/rfc5424). - **Cap'n'Proto**: The most efficient log format. This is a binary format that allows you to maintain a low footprint and high speed performance. For more information, check out the official website: [Cap'n'Proto](https://capnproto.org/). @@ -83,12 +83,11 @@ You should now have all the information you need to configure your software to i ## Go Further -[Ingest your logs with Filebeat](/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat)
-[Ingest your logs with syslog-ng](/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng)
-[Ingest your logs with NXLog](/pages/manage_and_operate/observability/logs_data_platform/ingestion_windows_nxlog)
-[Push your logs with the OpenSearch API](/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input)
+[Ingest your logs with Filebeat](/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat)
+[Ingest your logs with syslog-ng](/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng)
+[Ingest your logs with NXLog](/pages/manage_and_operate/observability/logs_data_platform/ingestion_windows_nxlog)
+[Push your logs with the OpenSearch API](/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input)
[Python 2 SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_python_2_djehouty)
-[Python 3 SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_python_3_logging_ldp)
+[Python 3 SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_python_3_logging_ldp)
[Rust SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_rust_loggers)
-[Ingest the logs from your Kubernetes cluster](/pages/manage_and_operate/observability/logs_data_platform/ingestion_kubernetes_fluent_bit)
- +[Ingest the logs from your Kubernetes cluster](/pages/manage_and_operate/observability/logs_data_platform/ingestion_kubernetes_fluent_bit)
\ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.en-ie.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.en-ie.md index b035abbd503..6e085f7f1a0 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.en-ie.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.en-ie.md @@ -1,13 +1,13 @@ --- title: Mutualized Inputs excerpt: Discover what inputs are and how to use them to ingest your logs in Logs Data Platform -updated: 2023-06-02 +updated: 2025-10-16 --- ## Objective This guide will help you understand how to use the mutualized inputs of Logs Data Platform to ingest your logs to the platform. - + *Inputs* are the components from Logs Data Platform that you connect to ingest your logs in the platform. In this guide, we focus specifically on the mutualized inputs that are available to everyone by default. ## Prerequisites @@ -27,7 +27,7 @@ Logs Data Platform imposes a few [constraints](/pages/manage_and_operate/observa The log formats that are accepted by Logs Data Platform are the following: -- **GELF**: This is the native format of logs used by Graylog. This JSON format allows you to send logs really easily. See the [GELF Payload Specification](https://go2docs.graylog.org/4-x/getting_in_log_data/gelf.html?tocpath=Getting%20in%20Log%20Data%7CLog%20Sources%7CGELF%7C_____0#GELFPayloadSpecification). The GELF input only accepts a null (`\0`) delimiter. +- **GELF**: This is the native format of logs used by Graylog. This JSON format allows you to send logs really easily. See the [GELF Payload Specification](https://go2docs.graylog.org/4-0/getting_in_log_data/gelf.html?tocpath=Getting%20in%20Logs%7CLog%20Sources%7CGELF%7C_____0#GELFPayloadSpecification). The GELF input only accepts a null (`\0`) delimiter. - **LTSV**: This simple format is very efficient and human readable. You can learn more about it [here](http://ltsv.org). LTSV has two inputs that accept a line delimiter or a null delimiter. - **RFC 5424**: This format is commonly used by logs utilities such as syslog. It is extensible enough to allow you to send all your data. More information about it can be found [here](https://tools.ietf.org/html/rfc5424). - **Cap'n'Proto**: The most efficient log format. This is a binary format that allows you to maintain a low footprint and high speed performance. For more information, check out the official website: [Cap'n'Proto](https://capnproto.org/). @@ -83,11 +83,11 @@ You should now have all the information you need to configure your software to i ## Go Further -[Ingest your logs with Filebeat](/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat)
-[Ingest your logs with syslog-ng](/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng)
-[Ingest your logs with NXLog](/pages/manage_and_operate/observability/logs_data_platform/ingestion_windows_nxlog)
-[Push your logs with the OpenSearch API](/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input)
+[Ingest your logs with Filebeat](/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat)
+[Ingest your logs with syslog-ng](/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng)
+[Ingest your logs with NXLog](/pages/manage_and_operate/observability/logs_data_platform/ingestion_windows_nxlog)
+[Push your logs with the OpenSearch API](/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input)
[Python 2 SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_python_2_djehouty)
-[Python 3 SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_python_3_logging_ldp)
+[Python 3 SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_python_3_logging_ldp)
[Rust SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_rust_loggers)
-[Ingest the logs from your Kubernetes cluster](/pages/manage_and_operate/observability/logs_data_platform/ingestion_kubernetes_fluent_bit)
+[Ingest the logs from your Kubernetes cluster](/pages/manage_and_operate/observability/logs_data_platform/ingestion_kubernetes_fluent_bit)
\ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.en-sg.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.en-sg.md index b035abbd503..6e085f7f1a0 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.en-sg.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.en-sg.md @@ -1,13 +1,13 @@ --- title: Mutualized Inputs excerpt: Discover what inputs are and how to use them to ingest your logs in Logs Data Platform -updated: 2023-06-02 +updated: 2025-10-16 --- ## Objective This guide will help you understand how to use the mutualized inputs of Logs Data Platform to ingest your logs to the platform. - + *Inputs* are the components from Logs Data Platform that you connect to ingest your logs in the platform. In this guide, we focus specifically on the mutualized inputs that are available to everyone by default. ## Prerequisites @@ -27,7 +27,7 @@ Logs Data Platform imposes a few [constraints](/pages/manage_and_operate/observa The log formats that are accepted by Logs Data Platform are the following: -- **GELF**: This is the native format of logs used by Graylog. This JSON format allows you to send logs really easily. See the [GELF Payload Specification](https://go2docs.graylog.org/4-x/getting_in_log_data/gelf.html?tocpath=Getting%20in%20Log%20Data%7CLog%20Sources%7CGELF%7C_____0#GELFPayloadSpecification). The GELF input only accepts a null (`\0`) delimiter. +- **GELF**: This is the native format of logs used by Graylog. This JSON format allows you to send logs really easily. See the [GELF Payload Specification](https://go2docs.graylog.org/4-0/getting_in_log_data/gelf.html?tocpath=Getting%20in%20Logs%7CLog%20Sources%7CGELF%7C_____0#GELFPayloadSpecification). The GELF input only accepts a null (`\0`) delimiter. - **LTSV**: This simple format is very efficient and human readable. You can learn more about it [here](http://ltsv.org). LTSV has two inputs that accept a line delimiter or a null delimiter. - **RFC 5424**: This format is commonly used by logs utilities such as syslog. It is extensible enough to allow you to send all your data. More information about it can be found [here](https://tools.ietf.org/html/rfc5424). - **Cap'n'Proto**: The most efficient log format. This is a binary format that allows you to maintain a low footprint and high speed performance. For more information, check out the official website: [Cap'n'Proto](https://capnproto.org/). @@ -83,11 +83,11 @@ You should now have all the information you need to configure your software to i ## Go Further -[Ingest your logs with Filebeat](/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat)
-[Ingest your logs with syslog-ng](/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng)
-[Ingest your logs with NXLog](/pages/manage_and_operate/observability/logs_data_platform/ingestion_windows_nxlog)
-[Push your logs with the OpenSearch API](/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input)
+[Ingest your logs with Filebeat](/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat)
+[Ingest your logs with syslog-ng](/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng)
+[Ingest your logs with NXLog](/pages/manage_and_operate/observability/logs_data_platform/ingestion_windows_nxlog)
+[Push your logs with the OpenSearch API](/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input)
[Python 2 SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_python_2_djehouty)
-[Python 3 SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_python_3_logging_ldp)
+[Python 3 SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_python_3_logging_ldp)
[Rust SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_rust_loggers)
-[Ingest the logs from your Kubernetes cluster](/pages/manage_and_operate/observability/logs_data_platform/ingestion_kubernetes_fluent_bit)
+[Ingest the logs from your Kubernetes cluster](/pages/manage_and_operate/observability/logs_data_platform/ingestion_kubernetes_fluent_bit)
\ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.en-us.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.en-us.md index b035abbd503..6e085f7f1a0 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.en-us.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.en-us.md @@ -1,13 +1,13 @@ --- title: Mutualized Inputs excerpt: Discover what inputs are and how to use them to ingest your logs in Logs Data Platform -updated: 2023-06-02 +updated: 2025-10-16 --- ## Objective This guide will help you understand how to use the mutualized inputs of Logs Data Platform to ingest your logs to the platform. - + *Inputs* are the components from Logs Data Platform that you connect to ingest your logs in the platform. In this guide, we focus specifically on the mutualized inputs that are available to everyone by default. ## Prerequisites @@ -27,7 +27,7 @@ Logs Data Platform imposes a few [constraints](/pages/manage_and_operate/observa The log formats that are accepted by Logs Data Platform are the following: -- **GELF**: This is the native format of logs used by Graylog. This JSON format allows you to send logs really easily. See the [GELF Payload Specification](https://go2docs.graylog.org/4-x/getting_in_log_data/gelf.html?tocpath=Getting%20in%20Log%20Data%7CLog%20Sources%7CGELF%7C_____0#GELFPayloadSpecification). The GELF input only accepts a null (`\0`) delimiter. +- **GELF**: This is the native format of logs used by Graylog. This JSON format allows you to send logs really easily. See the [GELF Payload Specification](https://go2docs.graylog.org/4-0/getting_in_log_data/gelf.html?tocpath=Getting%20in%20Logs%7CLog%20Sources%7CGELF%7C_____0#GELFPayloadSpecification). The GELF input only accepts a null (`\0`) delimiter. - **LTSV**: This simple format is very efficient and human readable. You can learn more about it [here](http://ltsv.org). LTSV has two inputs that accept a line delimiter or a null delimiter. - **RFC 5424**: This format is commonly used by logs utilities such as syslog. It is extensible enough to allow you to send all your data. More information about it can be found [here](https://tools.ietf.org/html/rfc5424). - **Cap'n'Proto**: The most efficient log format. This is a binary format that allows you to maintain a low footprint and high speed performance. For more information, check out the official website: [Cap'n'Proto](https://capnproto.org/). @@ -83,11 +83,11 @@ You should now have all the information you need to configure your software to i ## Go Further -[Ingest your logs with Filebeat](/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat)
-[Ingest your logs with syslog-ng](/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng)
-[Ingest your logs with NXLog](/pages/manage_and_operate/observability/logs_data_platform/ingestion_windows_nxlog)
-[Push your logs with the OpenSearch API](/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input)
+[Ingest your logs with Filebeat](/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat)
+[Ingest your logs with syslog-ng](/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng)
+[Ingest your logs with NXLog](/pages/manage_and_operate/observability/logs_data_platform/ingestion_windows_nxlog)
+[Push your logs with the OpenSearch API](/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input)
[Python 2 SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_python_2_djehouty)
-[Python 3 SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_python_3_logging_ldp)
+[Python 3 SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_python_3_logging_ldp)
[Rust SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_rust_loggers)
-[Ingest the logs from your Kubernetes cluster](/pages/manage_and_operate/observability/logs_data_platform/ingestion_kubernetes_fluent_bit)
+[Ingest the logs from your Kubernetes cluster](/pages/manage_and_operate/observability/logs_data_platform/ingestion_kubernetes_fluent_bit)
\ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.es-es.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.es-es.md index b035abbd503..6e085f7f1a0 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.es-es.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.es-es.md @@ -1,13 +1,13 @@ --- title: Mutualized Inputs excerpt: Discover what inputs are and how to use them to ingest your logs in Logs Data Platform -updated: 2023-06-02 +updated: 2025-10-16 --- ## Objective This guide will help you understand how to use the mutualized inputs of Logs Data Platform to ingest your logs to the platform. - + *Inputs* are the components from Logs Data Platform that you connect to ingest your logs in the platform. In this guide, we focus specifically on the mutualized inputs that are available to everyone by default. ## Prerequisites @@ -27,7 +27,7 @@ Logs Data Platform imposes a few [constraints](/pages/manage_and_operate/observa The log formats that are accepted by Logs Data Platform are the following: -- **GELF**: This is the native format of logs used by Graylog. This JSON format allows you to send logs really easily. See the [GELF Payload Specification](https://go2docs.graylog.org/4-x/getting_in_log_data/gelf.html?tocpath=Getting%20in%20Log%20Data%7CLog%20Sources%7CGELF%7C_____0#GELFPayloadSpecification). The GELF input only accepts a null (`\0`) delimiter. +- **GELF**: This is the native format of logs used by Graylog. This JSON format allows you to send logs really easily. See the [GELF Payload Specification](https://go2docs.graylog.org/4-0/getting_in_log_data/gelf.html?tocpath=Getting%20in%20Logs%7CLog%20Sources%7CGELF%7C_____0#GELFPayloadSpecification). The GELF input only accepts a null (`\0`) delimiter. - **LTSV**: This simple format is very efficient and human readable. You can learn more about it [here](http://ltsv.org). LTSV has two inputs that accept a line delimiter or a null delimiter. - **RFC 5424**: This format is commonly used by logs utilities such as syslog. It is extensible enough to allow you to send all your data. More information about it can be found [here](https://tools.ietf.org/html/rfc5424). - **Cap'n'Proto**: The most efficient log format. This is a binary format that allows you to maintain a low footprint and high speed performance. For more information, check out the official website: [Cap'n'Proto](https://capnproto.org/). @@ -83,11 +83,11 @@ You should now have all the information you need to configure your software to i ## Go Further -[Ingest your logs with Filebeat](/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat)
-[Ingest your logs with syslog-ng](/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng)
-[Ingest your logs with NXLog](/pages/manage_and_operate/observability/logs_data_platform/ingestion_windows_nxlog)
-[Push your logs with the OpenSearch API](/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input)
+[Ingest your logs with Filebeat](/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat)
+[Ingest your logs with syslog-ng](/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng)
+[Ingest your logs with NXLog](/pages/manage_and_operate/observability/logs_data_platform/ingestion_windows_nxlog)
+[Push your logs with the OpenSearch API](/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input)
[Python 2 SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_python_2_djehouty)
-[Python 3 SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_python_3_logging_ldp)
+[Python 3 SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_python_3_logging_ldp)
[Rust SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_rust_loggers)
-[Ingest the logs from your Kubernetes cluster](/pages/manage_and_operate/observability/logs_data_platform/ingestion_kubernetes_fluent_bit)
+[Ingest the logs from your Kubernetes cluster](/pages/manage_and_operate/observability/logs_data_platform/ingestion_kubernetes_fluent_bit)
\ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.es-us.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.es-us.md index b035abbd503..6e085f7f1a0 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.es-us.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.es-us.md @@ -1,13 +1,13 @@ --- title: Mutualized Inputs excerpt: Discover what inputs are and how to use them to ingest your logs in Logs Data Platform -updated: 2023-06-02 +updated: 2025-10-16 --- ## Objective This guide will help you understand how to use the mutualized inputs of Logs Data Platform to ingest your logs to the platform. - + *Inputs* are the components from Logs Data Platform that you connect to ingest your logs in the platform. In this guide, we focus specifically on the mutualized inputs that are available to everyone by default. ## Prerequisites @@ -27,7 +27,7 @@ Logs Data Platform imposes a few [constraints](/pages/manage_and_operate/observa The log formats that are accepted by Logs Data Platform are the following: -- **GELF**: This is the native format of logs used by Graylog. This JSON format allows you to send logs really easily. See the [GELF Payload Specification](https://go2docs.graylog.org/4-x/getting_in_log_data/gelf.html?tocpath=Getting%20in%20Log%20Data%7CLog%20Sources%7CGELF%7C_____0#GELFPayloadSpecification). The GELF input only accepts a null (`\0`) delimiter. +- **GELF**: This is the native format of logs used by Graylog. This JSON format allows you to send logs really easily. See the [GELF Payload Specification](https://go2docs.graylog.org/4-0/getting_in_log_data/gelf.html?tocpath=Getting%20in%20Logs%7CLog%20Sources%7CGELF%7C_____0#GELFPayloadSpecification). The GELF input only accepts a null (`\0`) delimiter. - **LTSV**: This simple format is very efficient and human readable. You can learn more about it [here](http://ltsv.org). LTSV has two inputs that accept a line delimiter or a null delimiter. - **RFC 5424**: This format is commonly used by logs utilities such as syslog. It is extensible enough to allow you to send all your data. More information about it can be found [here](https://tools.ietf.org/html/rfc5424). - **Cap'n'Proto**: The most efficient log format. This is a binary format that allows you to maintain a low footprint and high speed performance. For more information, check out the official website: [Cap'n'Proto](https://capnproto.org/). @@ -83,11 +83,11 @@ You should now have all the information you need to configure your software to i ## Go Further -[Ingest your logs with Filebeat](/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat)
-[Ingest your logs with syslog-ng](/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng)
-[Ingest your logs with NXLog](/pages/manage_and_operate/observability/logs_data_platform/ingestion_windows_nxlog)
-[Push your logs with the OpenSearch API](/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input)
+[Ingest your logs with Filebeat](/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat)
+[Ingest your logs with syslog-ng](/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng)
+[Ingest your logs with NXLog](/pages/manage_and_operate/observability/logs_data_platform/ingestion_windows_nxlog)
+[Push your logs with the OpenSearch API](/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input)
[Python 2 SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_python_2_djehouty)
-[Python 3 SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_python_3_logging_ldp)
+[Python 3 SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_python_3_logging_ldp)
[Rust SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_rust_loggers)
-[Ingest the logs from your Kubernetes cluster](/pages/manage_and_operate/observability/logs_data_platform/ingestion_kubernetes_fluent_bit)
+[Ingest the logs from your Kubernetes cluster](/pages/manage_and_operate/observability/logs_data_platform/ingestion_kubernetes_fluent_bit)
\ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.fr-ca.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.fr-ca.md index b035abbd503..6e085f7f1a0 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.fr-ca.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.fr-ca.md @@ -1,13 +1,13 @@ --- title: Mutualized Inputs excerpt: Discover what inputs are and how to use them to ingest your logs in Logs Data Platform -updated: 2023-06-02 +updated: 2025-10-16 --- ## Objective This guide will help you understand how to use the mutualized inputs of Logs Data Platform to ingest your logs to the platform. - + *Inputs* are the components from Logs Data Platform that you connect to ingest your logs in the platform. In this guide, we focus specifically on the mutualized inputs that are available to everyone by default. ## Prerequisites @@ -27,7 +27,7 @@ Logs Data Platform imposes a few [constraints](/pages/manage_and_operate/observa The log formats that are accepted by Logs Data Platform are the following: -- **GELF**: This is the native format of logs used by Graylog. This JSON format allows you to send logs really easily. See the [GELF Payload Specification](https://go2docs.graylog.org/4-x/getting_in_log_data/gelf.html?tocpath=Getting%20in%20Log%20Data%7CLog%20Sources%7CGELF%7C_____0#GELFPayloadSpecification). The GELF input only accepts a null (`\0`) delimiter. +- **GELF**: This is the native format of logs used by Graylog. This JSON format allows you to send logs really easily. See the [GELF Payload Specification](https://go2docs.graylog.org/4-0/getting_in_log_data/gelf.html?tocpath=Getting%20in%20Logs%7CLog%20Sources%7CGELF%7C_____0#GELFPayloadSpecification). The GELF input only accepts a null (`\0`) delimiter. - **LTSV**: This simple format is very efficient and human readable. You can learn more about it [here](http://ltsv.org). LTSV has two inputs that accept a line delimiter or a null delimiter. - **RFC 5424**: This format is commonly used by logs utilities such as syslog. It is extensible enough to allow you to send all your data. More information about it can be found [here](https://tools.ietf.org/html/rfc5424). - **Cap'n'Proto**: The most efficient log format. This is a binary format that allows you to maintain a low footprint and high speed performance. For more information, check out the official website: [Cap'n'Proto](https://capnproto.org/). @@ -83,11 +83,11 @@ You should now have all the information you need to configure your software to i ## Go Further -[Ingest your logs with Filebeat](/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat)
-[Ingest your logs with syslog-ng](/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng)
-[Ingest your logs with NXLog](/pages/manage_and_operate/observability/logs_data_platform/ingestion_windows_nxlog)
-[Push your logs with the OpenSearch API](/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input)
+[Ingest your logs with Filebeat](/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat)
+[Ingest your logs with syslog-ng](/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng)
+[Ingest your logs with NXLog](/pages/manage_and_operate/observability/logs_data_platform/ingestion_windows_nxlog)
+[Push your logs with the OpenSearch API](/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input)
[Python 2 SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_python_2_djehouty)
-[Python 3 SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_python_3_logging_ldp)
+[Python 3 SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_python_3_logging_ldp)
[Rust SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_rust_loggers)
-[Ingest the logs from your Kubernetes cluster](/pages/manage_and_operate/observability/logs_data_platform/ingestion_kubernetes_fluent_bit)
+[Ingest the logs from your Kubernetes cluster](/pages/manage_and_operate/observability/logs_data_platform/ingestion_kubernetes_fluent_bit)
\ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.fr-fr.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.fr-fr.md index b035abbd503..6e085f7f1a0 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.fr-fr.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.fr-fr.md @@ -1,13 +1,13 @@ --- title: Mutualized Inputs excerpt: Discover what inputs are and how to use them to ingest your logs in Logs Data Platform -updated: 2023-06-02 +updated: 2025-10-16 --- ## Objective This guide will help you understand how to use the mutualized inputs of Logs Data Platform to ingest your logs to the platform. - + *Inputs* are the components from Logs Data Platform that you connect to ingest your logs in the platform. In this guide, we focus specifically on the mutualized inputs that are available to everyone by default. ## Prerequisites @@ -27,7 +27,7 @@ Logs Data Platform imposes a few [constraints](/pages/manage_and_operate/observa The log formats that are accepted by Logs Data Platform are the following: -- **GELF**: This is the native format of logs used by Graylog. This JSON format allows you to send logs really easily. See the [GELF Payload Specification](https://go2docs.graylog.org/4-x/getting_in_log_data/gelf.html?tocpath=Getting%20in%20Log%20Data%7CLog%20Sources%7CGELF%7C_____0#GELFPayloadSpecification). The GELF input only accepts a null (`\0`) delimiter. +- **GELF**: This is the native format of logs used by Graylog. This JSON format allows you to send logs really easily. See the [GELF Payload Specification](https://go2docs.graylog.org/4-0/getting_in_log_data/gelf.html?tocpath=Getting%20in%20Logs%7CLog%20Sources%7CGELF%7C_____0#GELFPayloadSpecification). The GELF input only accepts a null (`\0`) delimiter. - **LTSV**: This simple format is very efficient and human readable. You can learn more about it [here](http://ltsv.org). LTSV has two inputs that accept a line delimiter or a null delimiter. - **RFC 5424**: This format is commonly used by logs utilities such as syslog. It is extensible enough to allow you to send all your data. More information about it can be found [here](https://tools.ietf.org/html/rfc5424). - **Cap'n'Proto**: The most efficient log format. This is a binary format that allows you to maintain a low footprint and high speed performance. For more information, check out the official website: [Cap'n'Proto](https://capnproto.org/). @@ -83,11 +83,11 @@ You should now have all the information you need to configure your software to i ## Go Further -[Ingest your logs with Filebeat](/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat)
-[Ingest your logs with syslog-ng](/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng)
-[Ingest your logs with NXLog](/pages/manage_and_operate/observability/logs_data_platform/ingestion_windows_nxlog)
-[Push your logs with the OpenSearch API](/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input)
+[Ingest your logs with Filebeat](/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat)
+[Ingest your logs with syslog-ng](/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng)
+[Ingest your logs with NXLog](/pages/manage_and_operate/observability/logs_data_platform/ingestion_windows_nxlog)
+[Push your logs with the OpenSearch API](/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input)
[Python 2 SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_python_2_djehouty)
-[Python 3 SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_python_3_logging_ldp)
+[Python 3 SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_python_3_logging_ldp)
[Rust SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_rust_loggers)
-[Ingest the logs from your Kubernetes cluster](/pages/manage_and_operate/observability/logs_data_platform/ingestion_kubernetes_fluent_bit)
+[Ingest the logs from your Kubernetes cluster](/pages/manage_and_operate/observability/logs_data_platform/ingestion_kubernetes_fluent_bit)
\ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.it-it.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.it-it.md index b035abbd503..6e085f7f1a0 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.it-it.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.it-it.md @@ -1,13 +1,13 @@ --- title: Mutualized Inputs excerpt: Discover what inputs are and how to use them to ingest your logs in Logs Data Platform -updated: 2023-06-02 +updated: 2025-10-16 --- ## Objective This guide will help you understand how to use the mutualized inputs of Logs Data Platform to ingest your logs to the platform. - + *Inputs* are the components from Logs Data Platform that you connect to ingest your logs in the platform. In this guide, we focus specifically on the mutualized inputs that are available to everyone by default. ## Prerequisites @@ -27,7 +27,7 @@ Logs Data Platform imposes a few [constraints](/pages/manage_and_operate/observa The log formats that are accepted by Logs Data Platform are the following: -- **GELF**: This is the native format of logs used by Graylog. This JSON format allows you to send logs really easily. See the [GELF Payload Specification](https://go2docs.graylog.org/4-x/getting_in_log_data/gelf.html?tocpath=Getting%20in%20Log%20Data%7CLog%20Sources%7CGELF%7C_____0#GELFPayloadSpecification). The GELF input only accepts a null (`\0`) delimiter. +- **GELF**: This is the native format of logs used by Graylog. This JSON format allows you to send logs really easily. See the [GELF Payload Specification](https://go2docs.graylog.org/4-0/getting_in_log_data/gelf.html?tocpath=Getting%20in%20Logs%7CLog%20Sources%7CGELF%7C_____0#GELFPayloadSpecification). The GELF input only accepts a null (`\0`) delimiter. - **LTSV**: This simple format is very efficient and human readable. You can learn more about it [here](http://ltsv.org). LTSV has two inputs that accept a line delimiter or a null delimiter. - **RFC 5424**: This format is commonly used by logs utilities such as syslog. It is extensible enough to allow you to send all your data. More information about it can be found [here](https://tools.ietf.org/html/rfc5424). - **Cap'n'Proto**: The most efficient log format. This is a binary format that allows you to maintain a low footprint and high speed performance. For more information, check out the official website: [Cap'n'Proto](https://capnproto.org/). @@ -83,11 +83,11 @@ You should now have all the information you need to configure your software to i ## Go Further -[Ingest your logs with Filebeat](/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat)
-[Ingest your logs with syslog-ng](/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng)
-[Ingest your logs with NXLog](/pages/manage_and_operate/observability/logs_data_platform/ingestion_windows_nxlog)
-[Push your logs with the OpenSearch API](/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input)
+[Ingest your logs with Filebeat](/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat)
+[Ingest your logs with syslog-ng](/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng)
+[Ingest your logs with NXLog](/pages/manage_and_operate/observability/logs_data_platform/ingestion_windows_nxlog)
+[Push your logs with the OpenSearch API](/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input)
[Python 2 SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_python_2_djehouty)
-[Python 3 SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_python_3_logging_ldp)
+[Python 3 SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_python_3_logging_ldp)
[Rust SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_rust_loggers)
-[Ingest the logs from your Kubernetes cluster](/pages/manage_and_operate/observability/logs_data_platform/ingestion_kubernetes_fluent_bit)
+[Ingest the logs from your Kubernetes cluster](/pages/manage_and_operate/observability/logs_data_platform/ingestion_kubernetes_fluent_bit)
\ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.pl-pl.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.pl-pl.md index b035abbd503..6e085f7f1a0 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.pl-pl.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.pl-pl.md @@ -1,13 +1,13 @@ --- title: Mutualized Inputs excerpt: Discover what inputs are and how to use them to ingest your logs in Logs Data Platform -updated: 2023-06-02 +updated: 2025-10-16 --- ## Objective This guide will help you understand how to use the mutualized inputs of Logs Data Platform to ingest your logs to the platform. - + *Inputs* are the components from Logs Data Platform that you connect to ingest your logs in the platform. In this guide, we focus specifically on the mutualized inputs that are available to everyone by default. ## Prerequisites @@ -27,7 +27,7 @@ Logs Data Platform imposes a few [constraints](/pages/manage_and_operate/observa The log formats that are accepted by Logs Data Platform are the following: -- **GELF**: This is the native format of logs used by Graylog. This JSON format allows you to send logs really easily. See the [GELF Payload Specification](https://go2docs.graylog.org/4-x/getting_in_log_data/gelf.html?tocpath=Getting%20in%20Log%20Data%7CLog%20Sources%7CGELF%7C_____0#GELFPayloadSpecification). The GELF input only accepts a null (`\0`) delimiter. +- **GELF**: This is the native format of logs used by Graylog. This JSON format allows you to send logs really easily. See the [GELF Payload Specification](https://go2docs.graylog.org/4-0/getting_in_log_data/gelf.html?tocpath=Getting%20in%20Logs%7CLog%20Sources%7CGELF%7C_____0#GELFPayloadSpecification). The GELF input only accepts a null (`\0`) delimiter. - **LTSV**: This simple format is very efficient and human readable. You can learn more about it [here](http://ltsv.org). LTSV has two inputs that accept a line delimiter or a null delimiter. - **RFC 5424**: This format is commonly used by logs utilities such as syslog. It is extensible enough to allow you to send all your data. More information about it can be found [here](https://tools.ietf.org/html/rfc5424). - **Cap'n'Proto**: The most efficient log format. This is a binary format that allows you to maintain a low footprint and high speed performance. For more information, check out the official website: [Cap'n'Proto](https://capnproto.org/). @@ -83,11 +83,11 @@ You should now have all the information you need to configure your software to i ## Go Further -[Ingest your logs with Filebeat](/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat)
-[Ingest your logs with syslog-ng](/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng)
-[Ingest your logs with NXLog](/pages/manage_and_operate/observability/logs_data_platform/ingestion_windows_nxlog)
-[Push your logs with the OpenSearch API](/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input)
+[Ingest your logs with Filebeat](/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat)
+[Ingest your logs with syslog-ng](/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng)
+[Ingest your logs with NXLog](/pages/manage_and_operate/observability/logs_data_platform/ingestion_windows_nxlog)
+[Push your logs with the OpenSearch API](/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input)
[Python 2 SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_python_2_djehouty)
-[Python 3 SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_python_3_logging_ldp)
+[Python 3 SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_python_3_logging_ldp)
[Rust SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_rust_loggers)
-[Ingest the logs from your Kubernetes cluster](/pages/manage_and_operate/observability/logs_data_platform/ingestion_kubernetes_fluent_bit)
+[Ingest the logs from your Kubernetes cluster](/pages/manage_and_operate/observability/logs_data_platform/ingestion_kubernetes_fluent_bit)
\ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.pt-pt.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.pt-pt.md index b035abbd503..6e085f7f1a0 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.pt-pt.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_mutualized_inputs/guide.pt-pt.md @@ -1,13 +1,13 @@ --- title: Mutualized Inputs excerpt: Discover what inputs are and how to use them to ingest your logs in Logs Data Platform -updated: 2023-06-02 +updated: 2025-10-16 --- ## Objective This guide will help you understand how to use the mutualized inputs of Logs Data Platform to ingest your logs to the platform. - + *Inputs* are the components from Logs Data Platform that you connect to ingest your logs in the platform. In this guide, we focus specifically on the mutualized inputs that are available to everyone by default. ## Prerequisites @@ -27,7 +27,7 @@ Logs Data Platform imposes a few [constraints](/pages/manage_and_operate/observa The log formats that are accepted by Logs Data Platform are the following: -- **GELF**: This is the native format of logs used by Graylog. This JSON format allows you to send logs really easily. See the [GELF Payload Specification](https://go2docs.graylog.org/4-x/getting_in_log_data/gelf.html?tocpath=Getting%20in%20Log%20Data%7CLog%20Sources%7CGELF%7C_____0#GELFPayloadSpecification). The GELF input only accepts a null (`\0`) delimiter. +- **GELF**: This is the native format of logs used by Graylog. This JSON format allows you to send logs really easily. See the [GELF Payload Specification](https://go2docs.graylog.org/4-0/getting_in_log_data/gelf.html?tocpath=Getting%20in%20Logs%7CLog%20Sources%7CGELF%7C_____0#GELFPayloadSpecification). The GELF input only accepts a null (`\0`) delimiter. - **LTSV**: This simple format is very efficient and human readable. You can learn more about it [here](http://ltsv.org). LTSV has two inputs that accept a line delimiter or a null delimiter. - **RFC 5424**: This format is commonly used by logs utilities such as syslog. It is extensible enough to allow you to send all your data. More information about it can be found [here](https://tools.ietf.org/html/rfc5424). - **Cap'n'Proto**: The most efficient log format. This is a binary format that allows you to maintain a low footprint and high speed performance. For more information, check out the official website: [Cap'n'Proto](https://capnproto.org/). @@ -83,11 +83,11 @@ You should now have all the information you need to configure your software to i ## Go Further -[Ingest your logs with Filebeat](/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat)
-[Ingest your logs with syslog-ng](/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng)
-[Ingest your logs with NXLog](/pages/manage_and_operate/observability/logs_data_platform/ingestion_windows_nxlog)
-[Push your logs with the OpenSearch API](/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input)
+[Ingest your logs with Filebeat](/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat)
+[Ingest your logs with syslog-ng](/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng)
+[Ingest your logs with NXLog](/pages/manage_and_operate/observability/logs_data_platform/ingestion_windows_nxlog)
+[Push your logs with the OpenSearch API](/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input)
[Python 2 SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_python_2_djehouty)
-[Python 3 SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_python_3_logging_ldp)
+[Python 3 SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_python_3_logging_ldp)
[Rust SDK](/pages/manage_and_operate/observability/logs_data_platform/ingestion_rust_loggers)
-[Ingest the logs from your Kubernetes cluster](/pages/manage_and_operate/observability/logs_data_platform/ingestion_kubernetes_fluent_bit)
+[Ingest the logs from your Kubernetes cluster](/pages/manage_and_operate/observability/logs_data_platform/ingestion_kubernetes_fluent_bit)
\ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.de-de.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.de-de.md index e6c34b4fde6..73dd5453bd4 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.de-de.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.de-de.md @@ -1,7 +1,7 @@ --- title: Mutualized input - OpenSearch API excerpt: Send your logs to the platform with the OpenSearch API. -updated: 2024-06-29 +updated: 2025-10-16 --- ## Overview @@ -10,12 +10,18 @@ OpenSearch is the star component of our platform, making it possible to use [Ope ## OpenSearch endpoint -The OpenSearch endpoint is a dedicated index where you can send a JSON document. The port used is the **9200**, the same HTTP port used for all other OpenSearch APIs of Logs Data Platform. The only fields needed are the **X-OVH-TOKEN** and an extra field (any custom field). Don't hesitate to go to the [Quick Start documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) if you are not familiar with this notion. This document log will be transformed into a valid GELF log and any missing field will be filled automatically. In order to respect the GELF convention, you can also use all the [GELF format reserved fields](https://docs.graylog.org/docs/gelf). Here is one example of the minimal message you can send: +The OpenSearch endpoint is a dedicated index where you can send a JSON document. The port used is the **9200**, the same HTTP port used for all other OpenSearch APIs of Logs Data Platform. The request must include the **X‑OVH‑TOKEN** field, which is a token used by the logging pipeline, and any additional custom fields. Authentication for the endpoint is performed via basic username/password (or a legacy token) for non‑IAM users, or via an IAM **Bearer** token when IAM is enabled. Don't hesitate to go to the [Quick Start documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) if you are not familiar with this notion. This document log will be transformed into a valid GELF log and any missing field will be filled automatically. In order to respect the GELF convention, you can also use all the [GELF format reserved fields](https://docs.graylog.org/docs/gelf). Here is one example of the minimal message you can send: ```shell-session $ curl -H 'Content-Type: application/json' -u ':' -XPOST https://.logs.ovh.com:9200/ldp-logs/_doc -d '{ "X-OVH-TOKEN" : "7f00cc33-1a7a-4464-830f-91be90dcc880" , "test_field" : "OVHcloud"}' ``` +or with [IAM enabled](/pages/manage_and_operate/observability/logs_data_platform/iam_presentation_faq) + +```shell-session +$ curl -H 'Content-Type: application/json' --oauth2-bearer '' -XPOST https://.logs.ovh.com:9200/ldp-logs/_doc -d '{ "X-OVH-TOKEN" : "7f00cc33-1a7a-4464-830f-91be90dcc880" , "test_field" : "OVHcloud"}' +``` + Replace the ``, `` and `` with your Logs Data Platform username, password and cluster. You can also use [tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens) in place of your credentials. Sending this payload will result in this log: ![simple\_log](images/one_field.png){.thumbnail} @@ -45,6 +51,80 @@ The numeric field **numeric_field** will be detected as a number and will be suf The OpenSearch input will also flatten any sub-object or array sent through it and also supports ingest pipelines that are used, for example, with [Filebeat integrations](/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat). +### Using the OpenSearch API with IAM enabled + +When **IAM** is enabled for your Logs Data Platform service, the authentication method for the OpenSearch API changes: + +- **Legacy (non‑IAM) authentication** uses basic username/password (or a legacy token) as described in the existing examples. +- **IAM authentication** uses a **Bearer token** obtained from OVHcloud IAM (Personal Access Token or Service Account token). + +**How to obtain a Bearer token** – you can generate one via a service account or a local user: + +For a service account: + +- Create a [service account](/pages/manage_and_operate/iam/identities-management/) and assign the required IAM policies (see the [IAM access management guide](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management)). +- Retrieve an API token using the OAuth2 client‑credentials flow as described in the [service‑account authentication guide](/pages/account_and_service_management/account_information/authenticate-api-with-service-account). The request looks like: + + ```bash + curl --request POST \ + --url 'https://www.ovh.com/auth/oauth2/token' \ + --header 'content-type: application/x-www-form-urlencoded' \ + --data grant_type=client_credentials \ + --data client_id= \ + --data scope=all + ``` + The response contains an `access_token` field – this is the Bearer token to use. + +For a local user: + +- You can create a local user by following the dedicated section on the [Identities management guide](/pages/manage_and_operate/iam/identities-management/). +- You can generate a Personal Access Token via the IAM API. See the FAQ documentation or use the call: + +> [!api] +> +> @api {v1} /me POST /me/identity/user/{user}/token +> + + Replace `{user}` with your OVHcloud local user. The response also returns an `access_token` that can be used as a Bearer token. + + +#### New request format + +```bash +# Ingest a log with IAM (Bearer token in header) +curl -H 'Content-Type: application/json' \ + -H 'Authorization: Bearer ' \ + -XPOST https://.logs.ovh.com:9200/ldp-logs/_doc \ + -d '{ "test_field" : "OVHcloud", "short_message" : "Hello with IAM" }' +``` + +*Notes*: +- The **index/alias prefix** is now the **service name** (e.g. `ldp-ab-56945`) instead of the username. You can find the service name on the Logs Data Platform home page or in the service URN (`urn:v1:eu:resource:ldp:`). +- The same Bearer token can be used for **querying** the OpenSearch backend: + +```bash +# Ingest a log with IAM (dedicated option in recents version of curl) +curl -k -v -H 'content-type: application/json' \ + --oauth2-bearer \ + -XGET 'https://gra1.logs.ovh.com:9200/_cluster/health?pretty' +``` + +#### Hybrid authentication (Bearer token with Basic scheme) + +For clients that do not support the `Authorization: Bearer` header, you can use the Bearer token value with a Basic authentication scheme by prefixing it by `pat_jwt_` as follows: + +```bash +Authorization: Basic pat_jwt_: +``` + +Replace `` with any ASCII value to identify your Personal Access Token (PAT) and `` with the token obtained as described above. This allows the request to be accepted by the OpenSearch endpoint with a user/password couple while using the same token. + + +All existing examples that use basic credentials remain valid for customers who have **not** enabled IAM. + +--- + ## Use case: Vector [Vector](https://vector.dev/) is a fast and lightweight log forwarder written in Rust. This software is quite similar to [Logstash](/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input) or [Fluent Bit](/pages/manage_and_operate/observability/logs_data_platform/ingestion_kubernetes_fluent_bit). It takes logs from a source, transforms them and sends them in a format compatible with the configured output module. @@ -105,4 +185,4 @@ The logs from journald arrived fully parsed and ready to be explored. Use differ - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](https://www.ovh.com/fr/order/express/#/express/review?products=~(~(planCode~'logs-account~productId~'logs))) +- Create an account: [Try it!](https://www.ovh.com/fr/order/express/#/express/review?products=~(~(planCode~'logs-account~productId~'logs))) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.en-asia.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.en-asia.md index e6c34b4fde6..73dd5453bd4 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.en-asia.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.en-asia.md @@ -1,7 +1,7 @@ --- title: Mutualized input - OpenSearch API excerpt: Send your logs to the platform with the OpenSearch API. -updated: 2024-06-29 +updated: 2025-10-16 --- ## Overview @@ -10,12 +10,18 @@ OpenSearch is the star component of our platform, making it possible to use [Ope ## OpenSearch endpoint -The OpenSearch endpoint is a dedicated index where you can send a JSON document. The port used is the **9200**, the same HTTP port used for all other OpenSearch APIs of Logs Data Platform. The only fields needed are the **X-OVH-TOKEN** and an extra field (any custom field). Don't hesitate to go to the [Quick Start documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) if you are not familiar with this notion. This document log will be transformed into a valid GELF log and any missing field will be filled automatically. In order to respect the GELF convention, you can also use all the [GELF format reserved fields](https://docs.graylog.org/docs/gelf). Here is one example of the minimal message you can send: +The OpenSearch endpoint is a dedicated index where you can send a JSON document. The port used is the **9200**, the same HTTP port used for all other OpenSearch APIs of Logs Data Platform. The request must include the **X‑OVH‑TOKEN** field, which is a token used by the logging pipeline, and any additional custom fields. Authentication for the endpoint is performed via basic username/password (or a legacy token) for non‑IAM users, or via an IAM **Bearer** token when IAM is enabled. Don't hesitate to go to the [Quick Start documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) if you are not familiar with this notion. This document log will be transformed into a valid GELF log and any missing field will be filled automatically. In order to respect the GELF convention, you can also use all the [GELF format reserved fields](https://docs.graylog.org/docs/gelf). Here is one example of the minimal message you can send: ```shell-session $ curl -H 'Content-Type: application/json' -u ':' -XPOST https://.logs.ovh.com:9200/ldp-logs/_doc -d '{ "X-OVH-TOKEN" : "7f00cc33-1a7a-4464-830f-91be90dcc880" , "test_field" : "OVHcloud"}' ``` +or with [IAM enabled](/pages/manage_and_operate/observability/logs_data_platform/iam_presentation_faq) + +```shell-session +$ curl -H 'Content-Type: application/json' --oauth2-bearer '' -XPOST https://.logs.ovh.com:9200/ldp-logs/_doc -d '{ "X-OVH-TOKEN" : "7f00cc33-1a7a-4464-830f-91be90dcc880" , "test_field" : "OVHcloud"}' +``` + Replace the ``, `` and `` with your Logs Data Platform username, password and cluster. You can also use [tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens) in place of your credentials. Sending this payload will result in this log: ![simple\_log](images/one_field.png){.thumbnail} @@ -45,6 +51,80 @@ The numeric field **numeric_field** will be detected as a number and will be suf The OpenSearch input will also flatten any sub-object or array sent through it and also supports ingest pipelines that are used, for example, with [Filebeat integrations](/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat). +### Using the OpenSearch API with IAM enabled + +When **IAM** is enabled for your Logs Data Platform service, the authentication method for the OpenSearch API changes: + +- **Legacy (non‑IAM) authentication** uses basic username/password (or a legacy token) as described in the existing examples. +- **IAM authentication** uses a **Bearer token** obtained from OVHcloud IAM (Personal Access Token or Service Account token). + +**How to obtain a Bearer token** – you can generate one via a service account or a local user: + +For a service account: + +- Create a [service account](/pages/manage_and_operate/iam/identities-management/) and assign the required IAM policies (see the [IAM access management guide](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management)). +- Retrieve an API token using the OAuth2 client‑credentials flow as described in the [service‑account authentication guide](/pages/account_and_service_management/account_information/authenticate-api-with-service-account). The request looks like: + + ```bash + curl --request POST \ + --url 'https://www.ovh.com/auth/oauth2/token' \ + --header 'content-type: application/x-www-form-urlencoded' \ + --data grant_type=client_credentials \ + --data client_id= \ + --data scope=all + ``` + The response contains an `access_token` field – this is the Bearer token to use. + +For a local user: + +- You can create a local user by following the dedicated section on the [Identities management guide](/pages/manage_and_operate/iam/identities-management/). +- You can generate a Personal Access Token via the IAM API. See the FAQ documentation or use the call: + +> [!api] +> +> @api {v1} /me POST /me/identity/user/{user}/token +> + + Replace `{user}` with your OVHcloud local user. The response also returns an `access_token` that can be used as a Bearer token. + + +#### New request format + +```bash +# Ingest a log with IAM (Bearer token in header) +curl -H 'Content-Type: application/json' \ + -H 'Authorization: Bearer ' \ + -XPOST https://.logs.ovh.com:9200/ldp-logs/_doc \ + -d '{ "test_field" : "OVHcloud", "short_message" : "Hello with IAM" }' +``` + +*Notes*: +- The **index/alias prefix** is now the **service name** (e.g. `ldp-ab-56945`) instead of the username. You can find the service name on the Logs Data Platform home page or in the service URN (`urn:v1:eu:resource:ldp:`). +- The same Bearer token can be used for **querying** the OpenSearch backend: + +```bash +# Ingest a log with IAM (dedicated option in recents version of curl) +curl -k -v -H 'content-type: application/json' \ + --oauth2-bearer \ + -XGET 'https://gra1.logs.ovh.com:9200/_cluster/health?pretty' +``` + +#### Hybrid authentication (Bearer token with Basic scheme) + +For clients that do not support the `Authorization: Bearer` header, you can use the Bearer token value with a Basic authentication scheme by prefixing it by `pat_jwt_` as follows: + +```bash +Authorization: Basic pat_jwt_: +``` + +Replace `` with any ASCII value to identify your Personal Access Token (PAT) and `` with the token obtained as described above. This allows the request to be accepted by the OpenSearch endpoint with a user/password couple while using the same token. + + +All existing examples that use basic credentials remain valid for customers who have **not** enabled IAM. + +--- + ## Use case: Vector [Vector](https://vector.dev/) is a fast and lightweight log forwarder written in Rust. This software is quite similar to [Logstash](/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input) or [Fluent Bit](/pages/manage_and_operate/observability/logs_data_platform/ingestion_kubernetes_fluent_bit). It takes logs from a source, transforms them and sends them in a format compatible with the configured output module. @@ -105,4 +185,4 @@ The logs from journald arrived fully parsed and ready to be explored. Use differ - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](https://www.ovh.com/fr/order/express/#/express/review?products=~(~(planCode~'logs-account~productId~'logs))) +- Create an account: [Try it!](https://www.ovh.com/fr/order/express/#/express/review?products=~(~(planCode~'logs-account~productId~'logs))) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.en-au.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.en-au.md index e6c34b4fde6..73dd5453bd4 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.en-au.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.en-au.md @@ -1,7 +1,7 @@ --- title: Mutualized input - OpenSearch API excerpt: Send your logs to the platform with the OpenSearch API. -updated: 2024-06-29 +updated: 2025-10-16 --- ## Overview @@ -10,12 +10,18 @@ OpenSearch is the star component of our platform, making it possible to use [Ope ## OpenSearch endpoint -The OpenSearch endpoint is a dedicated index where you can send a JSON document. The port used is the **9200**, the same HTTP port used for all other OpenSearch APIs of Logs Data Platform. The only fields needed are the **X-OVH-TOKEN** and an extra field (any custom field). Don't hesitate to go to the [Quick Start documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) if you are not familiar with this notion. This document log will be transformed into a valid GELF log and any missing field will be filled automatically. In order to respect the GELF convention, you can also use all the [GELF format reserved fields](https://docs.graylog.org/docs/gelf). Here is one example of the minimal message you can send: +The OpenSearch endpoint is a dedicated index where you can send a JSON document. The port used is the **9200**, the same HTTP port used for all other OpenSearch APIs of Logs Data Platform. The request must include the **X‑OVH‑TOKEN** field, which is a token used by the logging pipeline, and any additional custom fields. Authentication for the endpoint is performed via basic username/password (or a legacy token) for non‑IAM users, or via an IAM **Bearer** token when IAM is enabled. Don't hesitate to go to the [Quick Start documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) if you are not familiar with this notion. This document log will be transformed into a valid GELF log and any missing field will be filled automatically. In order to respect the GELF convention, you can also use all the [GELF format reserved fields](https://docs.graylog.org/docs/gelf). Here is one example of the minimal message you can send: ```shell-session $ curl -H 'Content-Type: application/json' -u ':' -XPOST https://.logs.ovh.com:9200/ldp-logs/_doc -d '{ "X-OVH-TOKEN" : "7f00cc33-1a7a-4464-830f-91be90dcc880" , "test_field" : "OVHcloud"}' ``` +or with [IAM enabled](/pages/manage_and_operate/observability/logs_data_platform/iam_presentation_faq) + +```shell-session +$ curl -H 'Content-Type: application/json' --oauth2-bearer '' -XPOST https://.logs.ovh.com:9200/ldp-logs/_doc -d '{ "X-OVH-TOKEN" : "7f00cc33-1a7a-4464-830f-91be90dcc880" , "test_field" : "OVHcloud"}' +``` + Replace the ``, `` and `` with your Logs Data Platform username, password and cluster. You can also use [tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens) in place of your credentials. Sending this payload will result in this log: ![simple\_log](images/one_field.png){.thumbnail} @@ -45,6 +51,80 @@ The numeric field **numeric_field** will be detected as a number and will be suf The OpenSearch input will also flatten any sub-object or array sent through it and also supports ingest pipelines that are used, for example, with [Filebeat integrations](/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat). +### Using the OpenSearch API with IAM enabled + +When **IAM** is enabled for your Logs Data Platform service, the authentication method for the OpenSearch API changes: + +- **Legacy (non‑IAM) authentication** uses basic username/password (or a legacy token) as described in the existing examples. +- **IAM authentication** uses a **Bearer token** obtained from OVHcloud IAM (Personal Access Token or Service Account token). + +**How to obtain a Bearer token** – you can generate one via a service account or a local user: + +For a service account: + +- Create a [service account](/pages/manage_and_operate/iam/identities-management/) and assign the required IAM policies (see the [IAM access management guide](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management)). +- Retrieve an API token using the OAuth2 client‑credentials flow as described in the [service‑account authentication guide](/pages/account_and_service_management/account_information/authenticate-api-with-service-account). The request looks like: + + ```bash + curl --request POST \ + --url 'https://www.ovh.com/auth/oauth2/token' \ + --header 'content-type: application/x-www-form-urlencoded' \ + --data grant_type=client_credentials \ + --data client_id= \ + --data scope=all + ``` + The response contains an `access_token` field – this is the Bearer token to use. + +For a local user: + +- You can create a local user by following the dedicated section on the [Identities management guide](/pages/manage_and_operate/iam/identities-management/). +- You can generate a Personal Access Token via the IAM API. See the FAQ documentation or use the call: + +> [!api] +> +> @api {v1} /me POST /me/identity/user/{user}/token +> + + Replace `{user}` with your OVHcloud local user. The response also returns an `access_token` that can be used as a Bearer token. + + +#### New request format + +```bash +# Ingest a log with IAM (Bearer token in header) +curl -H 'Content-Type: application/json' \ + -H 'Authorization: Bearer ' \ + -XPOST https://.logs.ovh.com:9200/ldp-logs/_doc \ + -d '{ "test_field" : "OVHcloud", "short_message" : "Hello with IAM" }' +``` + +*Notes*: +- The **index/alias prefix** is now the **service name** (e.g. `ldp-ab-56945`) instead of the username. You can find the service name on the Logs Data Platform home page or in the service URN (`urn:v1:eu:resource:ldp:`). +- The same Bearer token can be used for **querying** the OpenSearch backend: + +```bash +# Ingest a log with IAM (dedicated option in recents version of curl) +curl -k -v -H 'content-type: application/json' \ + --oauth2-bearer \ + -XGET 'https://gra1.logs.ovh.com:9200/_cluster/health?pretty' +``` + +#### Hybrid authentication (Bearer token with Basic scheme) + +For clients that do not support the `Authorization: Bearer` header, you can use the Bearer token value with a Basic authentication scheme by prefixing it by `pat_jwt_` as follows: + +```bash +Authorization: Basic pat_jwt_: +``` + +Replace `` with any ASCII value to identify your Personal Access Token (PAT) and `` with the token obtained as described above. This allows the request to be accepted by the OpenSearch endpoint with a user/password couple while using the same token. + + +All existing examples that use basic credentials remain valid for customers who have **not** enabled IAM. + +--- + ## Use case: Vector [Vector](https://vector.dev/) is a fast and lightweight log forwarder written in Rust. This software is quite similar to [Logstash](/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input) or [Fluent Bit](/pages/manage_and_operate/observability/logs_data_platform/ingestion_kubernetes_fluent_bit). It takes logs from a source, transforms them and sends them in a format compatible with the configured output module. @@ -105,4 +185,4 @@ The logs from journald arrived fully parsed and ready to be explored. Use differ - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](https://www.ovh.com/fr/order/express/#/express/review?products=~(~(planCode~'logs-account~productId~'logs))) +- Create an account: [Try it!](https://www.ovh.com/fr/order/express/#/express/review?products=~(~(planCode~'logs-account~productId~'logs))) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.en-ca.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.en-ca.md index e6c34b4fde6..73dd5453bd4 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.en-ca.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.en-ca.md @@ -1,7 +1,7 @@ --- title: Mutualized input - OpenSearch API excerpt: Send your logs to the platform with the OpenSearch API. -updated: 2024-06-29 +updated: 2025-10-16 --- ## Overview @@ -10,12 +10,18 @@ OpenSearch is the star component of our platform, making it possible to use [Ope ## OpenSearch endpoint -The OpenSearch endpoint is a dedicated index where you can send a JSON document. The port used is the **9200**, the same HTTP port used for all other OpenSearch APIs of Logs Data Platform. The only fields needed are the **X-OVH-TOKEN** and an extra field (any custom field). Don't hesitate to go to the [Quick Start documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) if you are not familiar with this notion. This document log will be transformed into a valid GELF log and any missing field will be filled automatically. In order to respect the GELF convention, you can also use all the [GELF format reserved fields](https://docs.graylog.org/docs/gelf). Here is one example of the minimal message you can send: +The OpenSearch endpoint is a dedicated index where you can send a JSON document. The port used is the **9200**, the same HTTP port used for all other OpenSearch APIs of Logs Data Platform. The request must include the **X‑OVH‑TOKEN** field, which is a token used by the logging pipeline, and any additional custom fields. Authentication for the endpoint is performed via basic username/password (or a legacy token) for non‑IAM users, or via an IAM **Bearer** token when IAM is enabled. Don't hesitate to go to the [Quick Start documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) if you are not familiar with this notion. This document log will be transformed into a valid GELF log and any missing field will be filled automatically. In order to respect the GELF convention, you can also use all the [GELF format reserved fields](https://docs.graylog.org/docs/gelf). Here is one example of the minimal message you can send: ```shell-session $ curl -H 'Content-Type: application/json' -u ':' -XPOST https://.logs.ovh.com:9200/ldp-logs/_doc -d '{ "X-OVH-TOKEN" : "7f00cc33-1a7a-4464-830f-91be90dcc880" , "test_field" : "OVHcloud"}' ``` +or with [IAM enabled](/pages/manage_and_operate/observability/logs_data_platform/iam_presentation_faq) + +```shell-session +$ curl -H 'Content-Type: application/json' --oauth2-bearer '' -XPOST https://.logs.ovh.com:9200/ldp-logs/_doc -d '{ "X-OVH-TOKEN" : "7f00cc33-1a7a-4464-830f-91be90dcc880" , "test_field" : "OVHcloud"}' +``` + Replace the ``, `` and `` with your Logs Data Platform username, password and cluster. You can also use [tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens) in place of your credentials. Sending this payload will result in this log: ![simple\_log](images/one_field.png){.thumbnail} @@ -45,6 +51,80 @@ The numeric field **numeric_field** will be detected as a number and will be suf The OpenSearch input will also flatten any sub-object or array sent through it and also supports ingest pipelines that are used, for example, with [Filebeat integrations](/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat). +### Using the OpenSearch API with IAM enabled + +When **IAM** is enabled for your Logs Data Platform service, the authentication method for the OpenSearch API changes: + +- **Legacy (non‑IAM) authentication** uses basic username/password (or a legacy token) as described in the existing examples. +- **IAM authentication** uses a **Bearer token** obtained from OVHcloud IAM (Personal Access Token or Service Account token). + +**How to obtain a Bearer token** – you can generate one via a service account or a local user: + +For a service account: + +- Create a [service account](/pages/manage_and_operate/iam/identities-management/) and assign the required IAM policies (see the [IAM access management guide](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management)). +- Retrieve an API token using the OAuth2 client‑credentials flow as described in the [service‑account authentication guide](/pages/account_and_service_management/account_information/authenticate-api-with-service-account). The request looks like: + + ```bash + curl --request POST \ + --url 'https://www.ovh.com/auth/oauth2/token' \ + --header 'content-type: application/x-www-form-urlencoded' \ + --data grant_type=client_credentials \ + --data client_id= \ + --data scope=all + ``` + The response contains an `access_token` field – this is the Bearer token to use. + +For a local user: + +- You can create a local user by following the dedicated section on the [Identities management guide](/pages/manage_and_operate/iam/identities-management/). +- You can generate a Personal Access Token via the IAM API. See the FAQ documentation or use the call: + +> [!api] +> +> @api {v1} /me POST /me/identity/user/{user}/token +> + + Replace `{user}` with your OVHcloud local user. The response also returns an `access_token` that can be used as a Bearer token. + + +#### New request format + +```bash +# Ingest a log with IAM (Bearer token in header) +curl -H 'Content-Type: application/json' \ + -H 'Authorization: Bearer ' \ + -XPOST https://.logs.ovh.com:9200/ldp-logs/_doc \ + -d '{ "test_field" : "OVHcloud", "short_message" : "Hello with IAM" }' +``` + +*Notes*: +- The **index/alias prefix** is now the **service name** (e.g. `ldp-ab-56945`) instead of the username. You can find the service name on the Logs Data Platform home page or in the service URN (`urn:v1:eu:resource:ldp:`). +- The same Bearer token can be used for **querying** the OpenSearch backend: + +```bash +# Ingest a log with IAM (dedicated option in recents version of curl) +curl -k -v -H 'content-type: application/json' \ + --oauth2-bearer \ + -XGET 'https://gra1.logs.ovh.com:9200/_cluster/health?pretty' +``` + +#### Hybrid authentication (Bearer token with Basic scheme) + +For clients that do not support the `Authorization: Bearer` header, you can use the Bearer token value with a Basic authentication scheme by prefixing it by `pat_jwt_` as follows: + +```bash +Authorization: Basic pat_jwt_: +``` + +Replace `` with any ASCII value to identify your Personal Access Token (PAT) and `` with the token obtained as described above. This allows the request to be accepted by the OpenSearch endpoint with a user/password couple while using the same token. + + +All existing examples that use basic credentials remain valid for customers who have **not** enabled IAM. + +--- + ## Use case: Vector [Vector](https://vector.dev/) is a fast and lightweight log forwarder written in Rust. This software is quite similar to [Logstash](/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input) or [Fluent Bit](/pages/manage_and_operate/observability/logs_data_platform/ingestion_kubernetes_fluent_bit). It takes logs from a source, transforms them and sends them in a format compatible with the configured output module. @@ -105,4 +185,4 @@ The logs from journald arrived fully parsed and ready to be explored. Use differ - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](https://www.ovh.com/fr/order/express/#/express/review?products=~(~(planCode~'logs-account~productId~'logs))) +- Create an account: [Try it!](https://www.ovh.com/fr/order/express/#/express/review?products=~(~(planCode~'logs-account~productId~'logs))) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.en-gb.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.en-gb.md index e6c34b4fde6..73dd5453bd4 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.en-gb.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.en-gb.md @@ -1,7 +1,7 @@ --- title: Mutualized input - OpenSearch API excerpt: Send your logs to the platform with the OpenSearch API. -updated: 2024-06-29 +updated: 2025-10-16 --- ## Overview @@ -10,12 +10,18 @@ OpenSearch is the star component of our platform, making it possible to use [Ope ## OpenSearch endpoint -The OpenSearch endpoint is a dedicated index where you can send a JSON document. The port used is the **9200**, the same HTTP port used for all other OpenSearch APIs of Logs Data Platform. The only fields needed are the **X-OVH-TOKEN** and an extra field (any custom field). Don't hesitate to go to the [Quick Start documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) if you are not familiar with this notion. This document log will be transformed into a valid GELF log and any missing field will be filled automatically. In order to respect the GELF convention, you can also use all the [GELF format reserved fields](https://docs.graylog.org/docs/gelf). Here is one example of the minimal message you can send: +The OpenSearch endpoint is a dedicated index where you can send a JSON document. The port used is the **9200**, the same HTTP port used for all other OpenSearch APIs of Logs Data Platform. The request must include the **X‑OVH‑TOKEN** field, which is a token used by the logging pipeline, and any additional custom fields. Authentication for the endpoint is performed via basic username/password (or a legacy token) for non‑IAM users, or via an IAM **Bearer** token when IAM is enabled. Don't hesitate to go to the [Quick Start documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) if you are not familiar with this notion. This document log will be transformed into a valid GELF log and any missing field will be filled automatically. In order to respect the GELF convention, you can also use all the [GELF format reserved fields](https://docs.graylog.org/docs/gelf). Here is one example of the minimal message you can send: ```shell-session $ curl -H 'Content-Type: application/json' -u ':' -XPOST https://.logs.ovh.com:9200/ldp-logs/_doc -d '{ "X-OVH-TOKEN" : "7f00cc33-1a7a-4464-830f-91be90dcc880" , "test_field" : "OVHcloud"}' ``` +or with [IAM enabled](/pages/manage_and_operate/observability/logs_data_platform/iam_presentation_faq) + +```shell-session +$ curl -H 'Content-Type: application/json' --oauth2-bearer '' -XPOST https://.logs.ovh.com:9200/ldp-logs/_doc -d '{ "X-OVH-TOKEN" : "7f00cc33-1a7a-4464-830f-91be90dcc880" , "test_field" : "OVHcloud"}' +``` + Replace the ``, `` and `` with your Logs Data Platform username, password and cluster. You can also use [tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens) in place of your credentials. Sending this payload will result in this log: ![simple\_log](images/one_field.png){.thumbnail} @@ -45,6 +51,80 @@ The numeric field **numeric_field** will be detected as a number and will be suf The OpenSearch input will also flatten any sub-object or array sent through it and also supports ingest pipelines that are used, for example, with [Filebeat integrations](/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat). +### Using the OpenSearch API with IAM enabled + +When **IAM** is enabled for your Logs Data Platform service, the authentication method for the OpenSearch API changes: + +- **Legacy (non‑IAM) authentication** uses basic username/password (or a legacy token) as described in the existing examples. +- **IAM authentication** uses a **Bearer token** obtained from OVHcloud IAM (Personal Access Token or Service Account token). + +**How to obtain a Bearer token** – you can generate one via a service account or a local user: + +For a service account: + +- Create a [service account](/pages/manage_and_operate/iam/identities-management/) and assign the required IAM policies (see the [IAM access management guide](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management)). +- Retrieve an API token using the OAuth2 client‑credentials flow as described in the [service‑account authentication guide](/pages/account_and_service_management/account_information/authenticate-api-with-service-account). The request looks like: + + ```bash + curl --request POST \ + --url 'https://www.ovh.com/auth/oauth2/token' \ + --header 'content-type: application/x-www-form-urlencoded' \ + --data grant_type=client_credentials \ + --data client_id= \ + --data scope=all + ``` + The response contains an `access_token` field – this is the Bearer token to use. + +For a local user: + +- You can create a local user by following the dedicated section on the [Identities management guide](/pages/manage_and_operate/iam/identities-management/). +- You can generate a Personal Access Token via the IAM API. See the FAQ documentation or use the call: + +> [!api] +> +> @api {v1} /me POST /me/identity/user/{user}/token +> + + Replace `{user}` with your OVHcloud local user. The response also returns an `access_token` that can be used as a Bearer token. + + +#### New request format + +```bash +# Ingest a log with IAM (Bearer token in header) +curl -H 'Content-Type: application/json' \ + -H 'Authorization: Bearer ' \ + -XPOST https://.logs.ovh.com:9200/ldp-logs/_doc \ + -d '{ "test_field" : "OVHcloud", "short_message" : "Hello with IAM" }' +``` + +*Notes*: +- The **index/alias prefix** is now the **service name** (e.g. `ldp-ab-56945`) instead of the username. You can find the service name on the Logs Data Platform home page or in the service URN (`urn:v1:eu:resource:ldp:`). +- The same Bearer token can be used for **querying** the OpenSearch backend: + +```bash +# Ingest a log with IAM (dedicated option in recents version of curl) +curl -k -v -H 'content-type: application/json' \ + --oauth2-bearer \ + -XGET 'https://gra1.logs.ovh.com:9200/_cluster/health?pretty' +``` + +#### Hybrid authentication (Bearer token with Basic scheme) + +For clients that do not support the `Authorization: Bearer` header, you can use the Bearer token value with a Basic authentication scheme by prefixing it by `pat_jwt_` as follows: + +```bash +Authorization: Basic pat_jwt_: +``` + +Replace `` with any ASCII value to identify your Personal Access Token (PAT) and `` with the token obtained as described above. This allows the request to be accepted by the OpenSearch endpoint with a user/password couple while using the same token. + + +All existing examples that use basic credentials remain valid for customers who have **not** enabled IAM. + +--- + ## Use case: Vector [Vector](https://vector.dev/) is a fast and lightweight log forwarder written in Rust. This software is quite similar to [Logstash](/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input) or [Fluent Bit](/pages/manage_and_operate/observability/logs_data_platform/ingestion_kubernetes_fluent_bit). It takes logs from a source, transforms them and sends them in a format compatible with the configured output module. @@ -105,4 +185,4 @@ The logs from journald arrived fully parsed and ready to be explored. Use differ - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](https://www.ovh.com/fr/order/express/#/express/review?products=~(~(planCode~'logs-account~productId~'logs))) +- Create an account: [Try it!](https://www.ovh.com/fr/order/express/#/express/review?products=~(~(planCode~'logs-account~productId~'logs))) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.en-ie.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.en-ie.md index e6c34b4fde6..73dd5453bd4 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.en-ie.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.en-ie.md @@ -1,7 +1,7 @@ --- title: Mutualized input - OpenSearch API excerpt: Send your logs to the platform with the OpenSearch API. -updated: 2024-06-29 +updated: 2025-10-16 --- ## Overview @@ -10,12 +10,18 @@ OpenSearch is the star component of our platform, making it possible to use [Ope ## OpenSearch endpoint -The OpenSearch endpoint is a dedicated index where you can send a JSON document. The port used is the **9200**, the same HTTP port used for all other OpenSearch APIs of Logs Data Platform. The only fields needed are the **X-OVH-TOKEN** and an extra field (any custom field). Don't hesitate to go to the [Quick Start documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) if you are not familiar with this notion. This document log will be transformed into a valid GELF log and any missing field will be filled automatically. In order to respect the GELF convention, you can also use all the [GELF format reserved fields](https://docs.graylog.org/docs/gelf). Here is one example of the minimal message you can send: +The OpenSearch endpoint is a dedicated index where you can send a JSON document. The port used is the **9200**, the same HTTP port used for all other OpenSearch APIs of Logs Data Platform. The request must include the **X‑OVH‑TOKEN** field, which is a token used by the logging pipeline, and any additional custom fields. Authentication for the endpoint is performed via basic username/password (or a legacy token) for non‑IAM users, or via an IAM **Bearer** token when IAM is enabled. Don't hesitate to go to the [Quick Start documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) if you are not familiar with this notion. This document log will be transformed into a valid GELF log and any missing field will be filled automatically. In order to respect the GELF convention, you can also use all the [GELF format reserved fields](https://docs.graylog.org/docs/gelf). Here is one example of the minimal message you can send: ```shell-session $ curl -H 'Content-Type: application/json' -u ':' -XPOST https://.logs.ovh.com:9200/ldp-logs/_doc -d '{ "X-OVH-TOKEN" : "7f00cc33-1a7a-4464-830f-91be90dcc880" , "test_field" : "OVHcloud"}' ``` +or with [IAM enabled](/pages/manage_and_operate/observability/logs_data_platform/iam_presentation_faq) + +```shell-session +$ curl -H 'Content-Type: application/json' --oauth2-bearer '' -XPOST https://.logs.ovh.com:9200/ldp-logs/_doc -d '{ "X-OVH-TOKEN" : "7f00cc33-1a7a-4464-830f-91be90dcc880" , "test_field" : "OVHcloud"}' +``` + Replace the ``, `` and `` with your Logs Data Platform username, password and cluster. You can also use [tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens) in place of your credentials. Sending this payload will result in this log: ![simple\_log](images/one_field.png){.thumbnail} @@ -45,6 +51,80 @@ The numeric field **numeric_field** will be detected as a number and will be suf The OpenSearch input will also flatten any sub-object or array sent through it and also supports ingest pipelines that are used, for example, with [Filebeat integrations](/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat). +### Using the OpenSearch API with IAM enabled + +When **IAM** is enabled for your Logs Data Platform service, the authentication method for the OpenSearch API changes: + +- **Legacy (non‑IAM) authentication** uses basic username/password (or a legacy token) as described in the existing examples. +- **IAM authentication** uses a **Bearer token** obtained from OVHcloud IAM (Personal Access Token or Service Account token). + +**How to obtain a Bearer token** – you can generate one via a service account or a local user: + +For a service account: + +- Create a [service account](/pages/manage_and_operate/iam/identities-management/) and assign the required IAM policies (see the [IAM access management guide](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management)). +- Retrieve an API token using the OAuth2 client‑credentials flow as described in the [service‑account authentication guide](/pages/account_and_service_management/account_information/authenticate-api-with-service-account). The request looks like: + + ```bash + curl --request POST \ + --url 'https://www.ovh.com/auth/oauth2/token' \ + --header 'content-type: application/x-www-form-urlencoded' \ + --data grant_type=client_credentials \ + --data client_id= \ + --data scope=all + ``` + The response contains an `access_token` field – this is the Bearer token to use. + +For a local user: + +- You can create a local user by following the dedicated section on the [Identities management guide](/pages/manage_and_operate/iam/identities-management/). +- You can generate a Personal Access Token via the IAM API. See the FAQ documentation or use the call: + +> [!api] +> +> @api {v1} /me POST /me/identity/user/{user}/token +> + + Replace `{user}` with your OVHcloud local user. The response also returns an `access_token` that can be used as a Bearer token. + + +#### New request format + +```bash +# Ingest a log with IAM (Bearer token in header) +curl -H 'Content-Type: application/json' \ + -H 'Authorization: Bearer ' \ + -XPOST https://.logs.ovh.com:9200/ldp-logs/_doc \ + -d '{ "test_field" : "OVHcloud", "short_message" : "Hello with IAM" }' +``` + +*Notes*: +- The **index/alias prefix** is now the **service name** (e.g. `ldp-ab-56945`) instead of the username. You can find the service name on the Logs Data Platform home page or in the service URN (`urn:v1:eu:resource:ldp:`). +- The same Bearer token can be used for **querying** the OpenSearch backend: + +```bash +# Ingest a log with IAM (dedicated option in recents version of curl) +curl -k -v -H 'content-type: application/json' \ + --oauth2-bearer \ + -XGET 'https://gra1.logs.ovh.com:9200/_cluster/health?pretty' +``` + +#### Hybrid authentication (Bearer token with Basic scheme) + +For clients that do not support the `Authorization: Bearer` header, you can use the Bearer token value with a Basic authentication scheme by prefixing it by `pat_jwt_` as follows: + +```bash +Authorization: Basic pat_jwt_: +``` + +Replace `` with any ASCII value to identify your Personal Access Token (PAT) and `` with the token obtained as described above. This allows the request to be accepted by the OpenSearch endpoint with a user/password couple while using the same token. + + +All existing examples that use basic credentials remain valid for customers who have **not** enabled IAM. + +--- + ## Use case: Vector [Vector](https://vector.dev/) is a fast and lightweight log forwarder written in Rust. This software is quite similar to [Logstash](/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input) or [Fluent Bit](/pages/manage_and_operate/observability/logs_data_platform/ingestion_kubernetes_fluent_bit). It takes logs from a source, transforms them and sends them in a format compatible with the configured output module. @@ -105,4 +185,4 @@ The logs from journald arrived fully parsed and ready to be explored. Use differ - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](https://www.ovh.com/fr/order/express/#/express/review?products=~(~(planCode~'logs-account~productId~'logs))) +- Create an account: [Try it!](https://www.ovh.com/fr/order/express/#/express/review?products=~(~(planCode~'logs-account~productId~'logs))) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.en-sg.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.en-sg.md index e6c34b4fde6..73dd5453bd4 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.en-sg.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.en-sg.md @@ -1,7 +1,7 @@ --- title: Mutualized input - OpenSearch API excerpt: Send your logs to the platform with the OpenSearch API. -updated: 2024-06-29 +updated: 2025-10-16 --- ## Overview @@ -10,12 +10,18 @@ OpenSearch is the star component of our platform, making it possible to use [Ope ## OpenSearch endpoint -The OpenSearch endpoint is a dedicated index where you can send a JSON document. The port used is the **9200**, the same HTTP port used for all other OpenSearch APIs of Logs Data Platform. The only fields needed are the **X-OVH-TOKEN** and an extra field (any custom field). Don't hesitate to go to the [Quick Start documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) if you are not familiar with this notion. This document log will be transformed into a valid GELF log and any missing field will be filled automatically. In order to respect the GELF convention, you can also use all the [GELF format reserved fields](https://docs.graylog.org/docs/gelf). Here is one example of the minimal message you can send: +The OpenSearch endpoint is a dedicated index where you can send a JSON document. The port used is the **9200**, the same HTTP port used for all other OpenSearch APIs of Logs Data Platform. The request must include the **X‑OVH‑TOKEN** field, which is a token used by the logging pipeline, and any additional custom fields. Authentication for the endpoint is performed via basic username/password (or a legacy token) for non‑IAM users, or via an IAM **Bearer** token when IAM is enabled. Don't hesitate to go to the [Quick Start documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) if you are not familiar with this notion. This document log will be transformed into a valid GELF log and any missing field will be filled automatically. In order to respect the GELF convention, you can also use all the [GELF format reserved fields](https://docs.graylog.org/docs/gelf). Here is one example of the minimal message you can send: ```shell-session $ curl -H 'Content-Type: application/json' -u ':' -XPOST https://.logs.ovh.com:9200/ldp-logs/_doc -d '{ "X-OVH-TOKEN" : "7f00cc33-1a7a-4464-830f-91be90dcc880" , "test_field" : "OVHcloud"}' ``` +or with [IAM enabled](/pages/manage_and_operate/observability/logs_data_platform/iam_presentation_faq) + +```shell-session +$ curl -H 'Content-Type: application/json' --oauth2-bearer '' -XPOST https://.logs.ovh.com:9200/ldp-logs/_doc -d '{ "X-OVH-TOKEN" : "7f00cc33-1a7a-4464-830f-91be90dcc880" , "test_field" : "OVHcloud"}' +``` + Replace the ``, `` and `` with your Logs Data Platform username, password and cluster. You can also use [tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens) in place of your credentials. Sending this payload will result in this log: ![simple\_log](images/one_field.png){.thumbnail} @@ -45,6 +51,80 @@ The numeric field **numeric_field** will be detected as a number and will be suf The OpenSearch input will also flatten any sub-object or array sent through it and also supports ingest pipelines that are used, for example, with [Filebeat integrations](/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat). +### Using the OpenSearch API with IAM enabled + +When **IAM** is enabled for your Logs Data Platform service, the authentication method for the OpenSearch API changes: + +- **Legacy (non‑IAM) authentication** uses basic username/password (or a legacy token) as described in the existing examples. +- **IAM authentication** uses a **Bearer token** obtained from OVHcloud IAM (Personal Access Token or Service Account token). + +**How to obtain a Bearer token** – you can generate one via a service account or a local user: + +For a service account: + +- Create a [service account](/pages/manage_and_operate/iam/identities-management/) and assign the required IAM policies (see the [IAM access management guide](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management)). +- Retrieve an API token using the OAuth2 client‑credentials flow as described in the [service‑account authentication guide](/pages/account_and_service_management/account_information/authenticate-api-with-service-account). The request looks like: + + ```bash + curl --request POST \ + --url 'https://www.ovh.com/auth/oauth2/token' \ + --header 'content-type: application/x-www-form-urlencoded' \ + --data grant_type=client_credentials \ + --data client_id= \ + --data scope=all + ``` + The response contains an `access_token` field – this is the Bearer token to use. + +For a local user: + +- You can create a local user by following the dedicated section on the [Identities management guide](/pages/manage_and_operate/iam/identities-management/). +- You can generate a Personal Access Token via the IAM API. See the FAQ documentation or use the call: + +> [!api] +> +> @api {v1} /me POST /me/identity/user/{user}/token +> + + Replace `{user}` with your OVHcloud local user. The response also returns an `access_token` that can be used as a Bearer token. + + +#### New request format + +```bash +# Ingest a log with IAM (Bearer token in header) +curl -H 'Content-Type: application/json' \ + -H 'Authorization: Bearer ' \ + -XPOST https://.logs.ovh.com:9200/ldp-logs/_doc \ + -d '{ "test_field" : "OVHcloud", "short_message" : "Hello with IAM" }' +``` + +*Notes*: +- The **index/alias prefix** is now the **service name** (e.g. `ldp-ab-56945`) instead of the username. You can find the service name on the Logs Data Platform home page or in the service URN (`urn:v1:eu:resource:ldp:`). +- The same Bearer token can be used for **querying** the OpenSearch backend: + +```bash +# Ingest a log with IAM (dedicated option in recents version of curl) +curl -k -v -H 'content-type: application/json' \ + --oauth2-bearer \ + -XGET 'https://gra1.logs.ovh.com:9200/_cluster/health?pretty' +``` + +#### Hybrid authentication (Bearer token with Basic scheme) + +For clients that do not support the `Authorization: Bearer` header, you can use the Bearer token value with a Basic authentication scheme by prefixing it by `pat_jwt_` as follows: + +```bash +Authorization: Basic pat_jwt_: +``` + +Replace `` with any ASCII value to identify your Personal Access Token (PAT) and `` with the token obtained as described above. This allows the request to be accepted by the OpenSearch endpoint with a user/password couple while using the same token. + + +All existing examples that use basic credentials remain valid for customers who have **not** enabled IAM. + +--- + ## Use case: Vector [Vector](https://vector.dev/) is a fast and lightweight log forwarder written in Rust. This software is quite similar to [Logstash](/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input) or [Fluent Bit](/pages/manage_and_operate/observability/logs_data_platform/ingestion_kubernetes_fluent_bit). It takes logs from a source, transforms them and sends them in a format compatible with the configured output module. @@ -105,4 +185,4 @@ The logs from journald arrived fully parsed and ready to be explored. Use differ - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](https://www.ovh.com/fr/order/express/#/express/review?products=~(~(planCode~'logs-account~productId~'logs))) +- Create an account: [Try it!](https://www.ovh.com/fr/order/express/#/express/review?products=~(~(planCode~'logs-account~productId~'logs))) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.en-us.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.en-us.md index e6c34b4fde6..6b49f82d8a4 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.en-us.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.en-us.md @@ -1,7 +1,7 @@ --- title: Mutualized input - OpenSearch API excerpt: Send your logs to the platform with the OpenSearch API. -updated: 2024-06-29 +updated: 2025-10-16 --- ## Overview @@ -10,12 +10,18 @@ OpenSearch is the star component of our platform, making it possible to use [Ope ## OpenSearch endpoint -The OpenSearch endpoint is a dedicated index where you can send a JSON document. The port used is the **9200**, the same HTTP port used for all other OpenSearch APIs of Logs Data Platform. The only fields needed are the **X-OVH-TOKEN** and an extra field (any custom field). Don't hesitate to go to the [Quick Start documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) if you are not familiar with this notion. This document log will be transformed into a valid GELF log and any missing field will be filled automatically. In order to respect the GELF convention, you can also use all the [GELF format reserved fields](https://docs.graylog.org/docs/gelf). Here is one example of the minimal message you can send: +The OpenSearch endpoint is a dedicated index where you can send a JSON document. The port used is the **9200**, the same HTTP port used for all other OpenSearch APIs of Logs Data Platform. The request must include the **X‑OVH‑TOKEN** field, which is a token used by the logging pipeline, and any additional custom fields. Authentication for the endpoint is performed via basic username/password (or a legacy token) for non‑IAM users, or via an IAM **Bearer** token when IAM is enabled. Don't hesitate to go to the [Quick Start documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) if you are not familiar with this notion. This document log will be transformed into a valid GELF log and any missing field will be filled automatically. In order to respect the GELF convention, you can also use all the [GELF format reserved fields](https://docs.graylog.org/docs/gelf). Here is one example of the minimal message you can send: ```shell-session $ curl -H 'Content-Type: application/json' -u ':' -XPOST https://.logs.ovh.com:9200/ldp-logs/_doc -d '{ "X-OVH-TOKEN" : "7f00cc33-1a7a-4464-830f-91be90dcc880" , "test_field" : "OVHcloud"}' ``` +or with [IAM enabled](/pages/manage_and_operate/observability/logs_data_platform/iam_presentation_faq) + +```shell-session +$ curl -H 'Content-Type: application/json' --oauth2-bearer '' -XPOST https://.logs.ovh.com:9200/ldp-logs/_doc -d '{ "X-OVH-TOKEN" : "7f00cc33-1a7a-4464-830f-91be90dcc880" , "test_field" : "OVHcloud"}' +``` + Replace the ``, `` and `` with your Logs Data Platform username, password and cluster. You can also use [tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens) in place of your credentials. Sending this payload will result in this log: ![simple\_log](images/one_field.png){.thumbnail} @@ -45,6 +51,80 @@ The numeric field **numeric_field** will be detected as a number and will be suf The OpenSearch input will also flatten any sub-object or array sent through it and also supports ingest pipelines that are used, for example, with [Filebeat integrations](/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat). +### Using the OpenSearch API with IAM enabled + +When **IAM** is enabled for your Logs Data Platform service, the authentication method for the OpenSearch API changes: + +- **Legacy (non‑IAM) authentication** uses basic username/password (or a legacy token) as described in the existing examples. +- **IAM authentication** uses a **Bearer token** obtained from OVHcloud IAM (Personal Access Token or Service Account token). + +**How to obtain a Bearer token** – you can generate one via a service account or a local user: + +For a service account: + +- Create a [service account](/pages/manage_and_operate/iam/identities-management/) and assign the required IAM policies (see the [IAM access management guide](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management)). +- Retrieve an API token using the OAuth2 client‑credentials flow as described in the [service‑account authentication guide](/pages/account_and_service_management/account_information/authenticate-api-with-service-account). The request looks like: + + ```bash + curl --request POST \ + --url 'https://www.ovh.com/auth/oauth2/token' \ + --header 'content-type: application/x-www-form-urlencoded' \ + --data grant_type=client_credentials \ + --data client_id= \ + --data scope=all + ``` + The response contains an `access_token` field – this is the Bearer token to use. + +For a local user: + +- You can create a local user by following the dedicated section on the [Identities management guide](/pages/manage_and_operate/iam/identities-management/). +- You can generate a Personal Access Token via the IAM API. See the FAQ documentation or use the call: + +> [!api] +> +> @api {v1} /me POST /me/identity/user/{user}/token +> + + Replace `{user}` with your OVHcloud local user. The response also returns an `access_token` that can be used as a Bearer token. + + +#### New request format + +```bash +# Ingest a log with IAM (Bearer token in header) +curl -H 'Content-Type: application/json' \ + -H 'Authorization: Bearer ' \ + -XPOST https://.logs.ovh.com:9200/ldp-logs/_doc \ + -d '{ "test_field" : "OVHcloud", "short_message" : "Hello with IAM" }' +``` + +*Notes*: +- The **index/alias prefix** is now the **service name** (e.g. `ldp-ab-56945`) instead of the username. You can find the service name on the Logs Data Platform home page or in the service URN (`urn:v1:eu:resource:ldp:`). +- The same Bearer token can be used for **querying** the OpenSearch backend: + +```bash +# Ingest a log with IAM (dedicated option in recents version of curl) +curl -k -v -H 'content-type: application/json' \ + --oauth2-bearer \ + -XGET 'https://gra1.logs.ovh.com:9200/_cluster/health?pretty' +``` + +#### Hybrid authentication (Bearer token with Basic scheme) + +For clients that do not support the `Authorization: Bearer` header, you can use the Bearer token value with a Basic authentication scheme by prefixing it by `pat_jwt_` as follows: + +```bash +Authorization: Basic pat_jwt_: +``` + +Replace `` with any ASCII value to identify your Personal Access Token (PAT) and `` with the token obtained as described above. This allows the request to be accepted by the OpenSearch endpoint with a user/password couple while using the same token. + + +All existing examples that use basic credentials remain valid for customers who have **not** enabled IAM. + +--- + ## Use case: Vector [Vector](https://vector.dev/) is a fast and lightweight log forwarder written in Rust. This software is quite similar to [Logstash](/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input) or [Fluent Bit](/pages/manage_and_operate/observability/logs_data_platform/ingestion_kubernetes_fluent_bit). It takes logs from a source, transforms them and sends them in a format compatible with the configured output module. @@ -92,7 +172,7 @@ The final part is the [Elasticsearch sink](https://vector.dev/docs/reference/con - the **endpoint** configuration must be replaced with your assigned cluster - the **bulk.index** must be set to "ldp-logs", our special OpenSearch logs index - the **auth.strategy** must be set to "basic". -- **auth.user** and **auth.password** must be set to the username of the Logs Data Platform account and its associated password. Note that you can use [tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens) in place of your credentials. +- **auth.user** and **auth.password** must be set to the username of the Logs Data Platform account and its associated password. Note that you can use **IAM tokens** in place of your credentials. Once configured and launched you will immediately see this type of logs in Graylog: @@ -105,4 +185,4 @@ The logs from journald arrived fully parsed and ready to be explored. Use differ - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](https://www.ovh.com/fr/order/express/#/express/review?products=~(~(planCode~'logs-account~productId~'logs))) +- Create an account: [Try it!](https://www.ovh.com/fr/order/express/#/express/review?products=~(~(planCode~'logs-account~productId~'logs))) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.es-es.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.es-es.md index e6c34b4fde6..73dd5453bd4 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.es-es.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.es-es.md @@ -1,7 +1,7 @@ --- title: Mutualized input - OpenSearch API excerpt: Send your logs to the platform with the OpenSearch API. -updated: 2024-06-29 +updated: 2025-10-16 --- ## Overview @@ -10,12 +10,18 @@ OpenSearch is the star component of our platform, making it possible to use [Ope ## OpenSearch endpoint -The OpenSearch endpoint is a dedicated index where you can send a JSON document. The port used is the **9200**, the same HTTP port used for all other OpenSearch APIs of Logs Data Platform. The only fields needed are the **X-OVH-TOKEN** and an extra field (any custom field). Don't hesitate to go to the [Quick Start documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) if you are not familiar with this notion. This document log will be transformed into a valid GELF log and any missing field will be filled automatically. In order to respect the GELF convention, you can also use all the [GELF format reserved fields](https://docs.graylog.org/docs/gelf). Here is one example of the minimal message you can send: +The OpenSearch endpoint is a dedicated index where you can send a JSON document. The port used is the **9200**, the same HTTP port used for all other OpenSearch APIs of Logs Data Platform. The request must include the **X‑OVH‑TOKEN** field, which is a token used by the logging pipeline, and any additional custom fields. Authentication for the endpoint is performed via basic username/password (or a legacy token) for non‑IAM users, or via an IAM **Bearer** token when IAM is enabled. Don't hesitate to go to the [Quick Start documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) if you are not familiar with this notion. This document log will be transformed into a valid GELF log and any missing field will be filled automatically. In order to respect the GELF convention, you can also use all the [GELF format reserved fields](https://docs.graylog.org/docs/gelf). Here is one example of the minimal message you can send: ```shell-session $ curl -H 'Content-Type: application/json' -u ':' -XPOST https://.logs.ovh.com:9200/ldp-logs/_doc -d '{ "X-OVH-TOKEN" : "7f00cc33-1a7a-4464-830f-91be90dcc880" , "test_field" : "OVHcloud"}' ``` +or with [IAM enabled](/pages/manage_and_operate/observability/logs_data_platform/iam_presentation_faq) + +```shell-session +$ curl -H 'Content-Type: application/json' --oauth2-bearer '' -XPOST https://.logs.ovh.com:9200/ldp-logs/_doc -d '{ "X-OVH-TOKEN" : "7f00cc33-1a7a-4464-830f-91be90dcc880" , "test_field" : "OVHcloud"}' +``` + Replace the ``, `` and `` with your Logs Data Platform username, password and cluster. You can also use [tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens) in place of your credentials. Sending this payload will result in this log: ![simple\_log](images/one_field.png){.thumbnail} @@ -45,6 +51,80 @@ The numeric field **numeric_field** will be detected as a number and will be suf The OpenSearch input will also flatten any sub-object or array sent through it and also supports ingest pipelines that are used, for example, with [Filebeat integrations](/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat). +### Using the OpenSearch API with IAM enabled + +When **IAM** is enabled for your Logs Data Platform service, the authentication method for the OpenSearch API changes: + +- **Legacy (non‑IAM) authentication** uses basic username/password (or a legacy token) as described in the existing examples. +- **IAM authentication** uses a **Bearer token** obtained from OVHcloud IAM (Personal Access Token or Service Account token). + +**How to obtain a Bearer token** – you can generate one via a service account or a local user: + +For a service account: + +- Create a [service account](/pages/manage_and_operate/iam/identities-management/) and assign the required IAM policies (see the [IAM access management guide](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management)). +- Retrieve an API token using the OAuth2 client‑credentials flow as described in the [service‑account authentication guide](/pages/account_and_service_management/account_information/authenticate-api-with-service-account). The request looks like: + + ```bash + curl --request POST \ + --url 'https://www.ovh.com/auth/oauth2/token' \ + --header 'content-type: application/x-www-form-urlencoded' \ + --data grant_type=client_credentials \ + --data client_id= \ + --data scope=all + ``` + The response contains an `access_token` field – this is the Bearer token to use. + +For a local user: + +- You can create a local user by following the dedicated section on the [Identities management guide](/pages/manage_and_operate/iam/identities-management/). +- You can generate a Personal Access Token via the IAM API. See the FAQ documentation or use the call: + +> [!api] +> +> @api {v1} /me POST /me/identity/user/{user}/token +> + + Replace `{user}` with your OVHcloud local user. The response also returns an `access_token` that can be used as a Bearer token. + + +#### New request format + +```bash +# Ingest a log with IAM (Bearer token in header) +curl -H 'Content-Type: application/json' \ + -H 'Authorization: Bearer ' \ + -XPOST https://.logs.ovh.com:9200/ldp-logs/_doc \ + -d '{ "test_field" : "OVHcloud", "short_message" : "Hello with IAM" }' +``` + +*Notes*: +- The **index/alias prefix** is now the **service name** (e.g. `ldp-ab-56945`) instead of the username. You can find the service name on the Logs Data Platform home page or in the service URN (`urn:v1:eu:resource:ldp:`). +- The same Bearer token can be used for **querying** the OpenSearch backend: + +```bash +# Ingest a log with IAM (dedicated option in recents version of curl) +curl -k -v -H 'content-type: application/json' \ + --oauth2-bearer \ + -XGET 'https://gra1.logs.ovh.com:9200/_cluster/health?pretty' +``` + +#### Hybrid authentication (Bearer token with Basic scheme) + +For clients that do not support the `Authorization: Bearer` header, you can use the Bearer token value with a Basic authentication scheme by prefixing it by `pat_jwt_` as follows: + +```bash +Authorization: Basic pat_jwt_: +``` + +Replace `` with any ASCII value to identify your Personal Access Token (PAT) and `` with the token obtained as described above. This allows the request to be accepted by the OpenSearch endpoint with a user/password couple while using the same token. + + +All existing examples that use basic credentials remain valid for customers who have **not** enabled IAM. + +--- + ## Use case: Vector [Vector](https://vector.dev/) is a fast and lightweight log forwarder written in Rust. This software is quite similar to [Logstash](/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input) or [Fluent Bit](/pages/manage_and_operate/observability/logs_data_platform/ingestion_kubernetes_fluent_bit). It takes logs from a source, transforms them and sends them in a format compatible with the configured output module. @@ -105,4 +185,4 @@ The logs from journald arrived fully parsed and ready to be explored. Use differ - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](https://www.ovh.com/fr/order/express/#/express/review?products=~(~(planCode~'logs-account~productId~'logs))) +- Create an account: [Try it!](https://www.ovh.com/fr/order/express/#/express/review?products=~(~(planCode~'logs-account~productId~'logs))) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.es-us.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.es-us.md index e6c34b4fde6..73dd5453bd4 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.es-us.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.es-us.md @@ -1,7 +1,7 @@ --- title: Mutualized input - OpenSearch API excerpt: Send your logs to the platform with the OpenSearch API. -updated: 2024-06-29 +updated: 2025-10-16 --- ## Overview @@ -10,12 +10,18 @@ OpenSearch is the star component of our platform, making it possible to use [Ope ## OpenSearch endpoint -The OpenSearch endpoint is a dedicated index where you can send a JSON document. The port used is the **9200**, the same HTTP port used for all other OpenSearch APIs of Logs Data Platform. The only fields needed are the **X-OVH-TOKEN** and an extra field (any custom field). Don't hesitate to go to the [Quick Start documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) if you are not familiar with this notion. This document log will be transformed into a valid GELF log and any missing field will be filled automatically. In order to respect the GELF convention, you can also use all the [GELF format reserved fields](https://docs.graylog.org/docs/gelf). Here is one example of the minimal message you can send: +The OpenSearch endpoint is a dedicated index where you can send a JSON document. The port used is the **9200**, the same HTTP port used for all other OpenSearch APIs of Logs Data Platform. The request must include the **X‑OVH‑TOKEN** field, which is a token used by the logging pipeline, and any additional custom fields. Authentication for the endpoint is performed via basic username/password (or a legacy token) for non‑IAM users, or via an IAM **Bearer** token when IAM is enabled. Don't hesitate to go to the [Quick Start documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) if you are not familiar with this notion. This document log will be transformed into a valid GELF log and any missing field will be filled automatically. In order to respect the GELF convention, you can also use all the [GELF format reserved fields](https://docs.graylog.org/docs/gelf). Here is one example of the minimal message you can send: ```shell-session $ curl -H 'Content-Type: application/json' -u ':' -XPOST https://.logs.ovh.com:9200/ldp-logs/_doc -d '{ "X-OVH-TOKEN" : "7f00cc33-1a7a-4464-830f-91be90dcc880" , "test_field" : "OVHcloud"}' ``` +or with [IAM enabled](/pages/manage_and_operate/observability/logs_data_platform/iam_presentation_faq) + +```shell-session +$ curl -H 'Content-Type: application/json' --oauth2-bearer '' -XPOST https://.logs.ovh.com:9200/ldp-logs/_doc -d '{ "X-OVH-TOKEN" : "7f00cc33-1a7a-4464-830f-91be90dcc880" , "test_field" : "OVHcloud"}' +``` + Replace the ``, `` and `` with your Logs Data Platform username, password and cluster. You can also use [tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens) in place of your credentials. Sending this payload will result in this log: ![simple\_log](images/one_field.png){.thumbnail} @@ -45,6 +51,80 @@ The numeric field **numeric_field** will be detected as a number and will be suf The OpenSearch input will also flatten any sub-object or array sent through it and also supports ingest pipelines that are used, for example, with [Filebeat integrations](/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat). +### Using the OpenSearch API with IAM enabled + +When **IAM** is enabled for your Logs Data Platform service, the authentication method for the OpenSearch API changes: + +- **Legacy (non‑IAM) authentication** uses basic username/password (or a legacy token) as described in the existing examples. +- **IAM authentication** uses a **Bearer token** obtained from OVHcloud IAM (Personal Access Token or Service Account token). + +**How to obtain a Bearer token** – you can generate one via a service account or a local user: + +For a service account: + +- Create a [service account](/pages/manage_and_operate/iam/identities-management/) and assign the required IAM policies (see the [IAM access management guide](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management)). +- Retrieve an API token using the OAuth2 client‑credentials flow as described in the [service‑account authentication guide](/pages/account_and_service_management/account_information/authenticate-api-with-service-account). The request looks like: + + ```bash + curl --request POST \ + --url 'https://www.ovh.com/auth/oauth2/token' \ + --header 'content-type: application/x-www-form-urlencoded' \ + --data grant_type=client_credentials \ + --data client_id= \ + --data scope=all + ``` + The response contains an `access_token` field – this is the Bearer token to use. + +For a local user: + +- You can create a local user by following the dedicated section on the [Identities management guide](/pages/manage_and_operate/iam/identities-management/). +- You can generate a Personal Access Token via the IAM API. See the FAQ documentation or use the call: + +> [!api] +> +> @api {v1} /me POST /me/identity/user/{user}/token +> + + Replace `{user}` with your OVHcloud local user. The response also returns an `access_token` that can be used as a Bearer token. + + +#### New request format + +```bash +# Ingest a log with IAM (Bearer token in header) +curl -H 'Content-Type: application/json' \ + -H 'Authorization: Bearer ' \ + -XPOST https://.logs.ovh.com:9200/ldp-logs/_doc \ + -d '{ "test_field" : "OVHcloud", "short_message" : "Hello with IAM" }' +``` + +*Notes*: +- The **index/alias prefix** is now the **service name** (e.g. `ldp-ab-56945`) instead of the username. You can find the service name on the Logs Data Platform home page or in the service URN (`urn:v1:eu:resource:ldp:`). +- The same Bearer token can be used for **querying** the OpenSearch backend: + +```bash +# Ingest a log with IAM (dedicated option in recents version of curl) +curl -k -v -H 'content-type: application/json' \ + --oauth2-bearer \ + -XGET 'https://gra1.logs.ovh.com:9200/_cluster/health?pretty' +``` + +#### Hybrid authentication (Bearer token with Basic scheme) + +For clients that do not support the `Authorization: Bearer` header, you can use the Bearer token value with a Basic authentication scheme by prefixing it by `pat_jwt_` as follows: + +```bash +Authorization: Basic pat_jwt_: +``` + +Replace `` with any ASCII value to identify your Personal Access Token (PAT) and `` with the token obtained as described above. This allows the request to be accepted by the OpenSearch endpoint with a user/password couple while using the same token. + + +All existing examples that use basic credentials remain valid for customers who have **not** enabled IAM. + +--- + ## Use case: Vector [Vector](https://vector.dev/) is a fast and lightweight log forwarder written in Rust. This software is quite similar to [Logstash](/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input) or [Fluent Bit](/pages/manage_and_operate/observability/logs_data_platform/ingestion_kubernetes_fluent_bit). It takes logs from a source, transforms them and sends them in a format compatible with the configured output module. @@ -105,4 +185,4 @@ The logs from journald arrived fully parsed and ready to be explored. Use differ - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](https://www.ovh.com/fr/order/express/#/express/review?products=~(~(planCode~'logs-account~productId~'logs))) +- Create an account: [Try it!](https://www.ovh.com/fr/order/express/#/express/review?products=~(~(planCode~'logs-account~productId~'logs))) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.fr-ca.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.fr-ca.md index e6c34b4fde6..73dd5453bd4 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.fr-ca.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.fr-ca.md @@ -1,7 +1,7 @@ --- title: Mutualized input - OpenSearch API excerpt: Send your logs to the platform with the OpenSearch API. -updated: 2024-06-29 +updated: 2025-10-16 --- ## Overview @@ -10,12 +10,18 @@ OpenSearch is the star component of our platform, making it possible to use [Ope ## OpenSearch endpoint -The OpenSearch endpoint is a dedicated index where you can send a JSON document. The port used is the **9200**, the same HTTP port used for all other OpenSearch APIs of Logs Data Platform. The only fields needed are the **X-OVH-TOKEN** and an extra field (any custom field). Don't hesitate to go to the [Quick Start documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) if you are not familiar with this notion. This document log will be transformed into a valid GELF log and any missing field will be filled automatically. In order to respect the GELF convention, you can also use all the [GELF format reserved fields](https://docs.graylog.org/docs/gelf). Here is one example of the minimal message you can send: +The OpenSearch endpoint is a dedicated index where you can send a JSON document. The port used is the **9200**, the same HTTP port used for all other OpenSearch APIs of Logs Data Platform. The request must include the **X‑OVH‑TOKEN** field, which is a token used by the logging pipeline, and any additional custom fields. Authentication for the endpoint is performed via basic username/password (or a legacy token) for non‑IAM users, or via an IAM **Bearer** token when IAM is enabled. Don't hesitate to go to the [Quick Start documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) if you are not familiar with this notion. This document log will be transformed into a valid GELF log and any missing field will be filled automatically. In order to respect the GELF convention, you can also use all the [GELF format reserved fields](https://docs.graylog.org/docs/gelf). Here is one example of the minimal message you can send: ```shell-session $ curl -H 'Content-Type: application/json' -u ':' -XPOST https://.logs.ovh.com:9200/ldp-logs/_doc -d '{ "X-OVH-TOKEN" : "7f00cc33-1a7a-4464-830f-91be90dcc880" , "test_field" : "OVHcloud"}' ``` +or with [IAM enabled](/pages/manage_and_operate/observability/logs_data_platform/iam_presentation_faq) + +```shell-session +$ curl -H 'Content-Type: application/json' --oauth2-bearer '' -XPOST https://.logs.ovh.com:9200/ldp-logs/_doc -d '{ "X-OVH-TOKEN" : "7f00cc33-1a7a-4464-830f-91be90dcc880" , "test_field" : "OVHcloud"}' +``` + Replace the ``, `` and `` with your Logs Data Platform username, password and cluster. You can also use [tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens) in place of your credentials. Sending this payload will result in this log: ![simple\_log](images/one_field.png){.thumbnail} @@ -45,6 +51,80 @@ The numeric field **numeric_field** will be detected as a number and will be suf The OpenSearch input will also flatten any sub-object or array sent through it and also supports ingest pipelines that are used, for example, with [Filebeat integrations](/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat). +### Using the OpenSearch API with IAM enabled + +When **IAM** is enabled for your Logs Data Platform service, the authentication method for the OpenSearch API changes: + +- **Legacy (non‑IAM) authentication** uses basic username/password (or a legacy token) as described in the existing examples. +- **IAM authentication** uses a **Bearer token** obtained from OVHcloud IAM (Personal Access Token or Service Account token). + +**How to obtain a Bearer token** – you can generate one via a service account or a local user: + +For a service account: + +- Create a [service account](/pages/manage_and_operate/iam/identities-management/) and assign the required IAM policies (see the [IAM access management guide](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management)). +- Retrieve an API token using the OAuth2 client‑credentials flow as described in the [service‑account authentication guide](/pages/account_and_service_management/account_information/authenticate-api-with-service-account). The request looks like: + + ```bash + curl --request POST \ + --url 'https://www.ovh.com/auth/oauth2/token' \ + --header 'content-type: application/x-www-form-urlencoded' \ + --data grant_type=client_credentials \ + --data client_id= \ + --data scope=all + ``` + The response contains an `access_token` field – this is the Bearer token to use. + +For a local user: + +- You can create a local user by following the dedicated section on the [Identities management guide](/pages/manage_and_operate/iam/identities-management/). +- You can generate a Personal Access Token via the IAM API. See the FAQ documentation or use the call: + +> [!api] +> +> @api {v1} /me POST /me/identity/user/{user}/token +> + + Replace `{user}` with your OVHcloud local user. The response also returns an `access_token` that can be used as a Bearer token. + + +#### New request format + +```bash +# Ingest a log with IAM (Bearer token in header) +curl -H 'Content-Type: application/json' \ + -H 'Authorization: Bearer ' \ + -XPOST https://.logs.ovh.com:9200/ldp-logs/_doc \ + -d '{ "test_field" : "OVHcloud", "short_message" : "Hello with IAM" }' +``` + +*Notes*: +- The **index/alias prefix** is now the **service name** (e.g. `ldp-ab-56945`) instead of the username. You can find the service name on the Logs Data Platform home page or in the service URN (`urn:v1:eu:resource:ldp:`). +- The same Bearer token can be used for **querying** the OpenSearch backend: + +```bash +# Ingest a log with IAM (dedicated option in recents version of curl) +curl -k -v -H 'content-type: application/json' \ + --oauth2-bearer \ + -XGET 'https://gra1.logs.ovh.com:9200/_cluster/health?pretty' +``` + +#### Hybrid authentication (Bearer token with Basic scheme) + +For clients that do not support the `Authorization: Bearer` header, you can use the Bearer token value with a Basic authentication scheme by prefixing it by `pat_jwt_` as follows: + +```bash +Authorization: Basic pat_jwt_: +``` + +Replace `` with any ASCII value to identify your Personal Access Token (PAT) and `` with the token obtained as described above. This allows the request to be accepted by the OpenSearch endpoint with a user/password couple while using the same token. + + +All existing examples that use basic credentials remain valid for customers who have **not** enabled IAM. + +--- + ## Use case: Vector [Vector](https://vector.dev/) is a fast and lightweight log forwarder written in Rust. This software is quite similar to [Logstash](/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input) or [Fluent Bit](/pages/manage_and_operate/observability/logs_data_platform/ingestion_kubernetes_fluent_bit). It takes logs from a source, transforms them and sends them in a format compatible with the configured output module. @@ -105,4 +185,4 @@ The logs from journald arrived fully parsed and ready to be explored. Use differ - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](https://www.ovh.com/fr/order/express/#/express/review?products=~(~(planCode~'logs-account~productId~'logs))) +- Create an account: [Try it!](https://www.ovh.com/fr/order/express/#/express/review?products=~(~(planCode~'logs-account~productId~'logs))) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.fr-fr.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.fr-fr.md index e6c34b4fde6..73dd5453bd4 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.fr-fr.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.fr-fr.md @@ -1,7 +1,7 @@ --- title: Mutualized input - OpenSearch API excerpt: Send your logs to the platform with the OpenSearch API. -updated: 2024-06-29 +updated: 2025-10-16 --- ## Overview @@ -10,12 +10,18 @@ OpenSearch is the star component of our platform, making it possible to use [Ope ## OpenSearch endpoint -The OpenSearch endpoint is a dedicated index where you can send a JSON document. The port used is the **9200**, the same HTTP port used for all other OpenSearch APIs of Logs Data Platform. The only fields needed are the **X-OVH-TOKEN** and an extra field (any custom field). Don't hesitate to go to the [Quick Start documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) if you are not familiar with this notion. This document log will be transformed into a valid GELF log and any missing field will be filled automatically. In order to respect the GELF convention, you can also use all the [GELF format reserved fields](https://docs.graylog.org/docs/gelf). Here is one example of the minimal message you can send: +The OpenSearch endpoint is a dedicated index where you can send a JSON document. The port used is the **9200**, the same HTTP port used for all other OpenSearch APIs of Logs Data Platform. The request must include the **X‑OVH‑TOKEN** field, which is a token used by the logging pipeline, and any additional custom fields. Authentication for the endpoint is performed via basic username/password (or a legacy token) for non‑IAM users, or via an IAM **Bearer** token when IAM is enabled. Don't hesitate to go to the [Quick Start documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) if you are not familiar with this notion. This document log will be transformed into a valid GELF log and any missing field will be filled automatically. In order to respect the GELF convention, you can also use all the [GELF format reserved fields](https://docs.graylog.org/docs/gelf). Here is one example of the minimal message you can send: ```shell-session $ curl -H 'Content-Type: application/json' -u ':' -XPOST https://.logs.ovh.com:9200/ldp-logs/_doc -d '{ "X-OVH-TOKEN" : "7f00cc33-1a7a-4464-830f-91be90dcc880" , "test_field" : "OVHcloud"}' ``` +or with [IAM enabled](/pages/manage_and_operate/observability/logs_data_platform/iam_presentation_faq) + +```shell-session +$ curl -H 'Content-Type: application/json' --oauth2-bearer '' -XPOST https://.logs.ovh.com:9200/ldp-logs/_doc -d '{ "X-OVH-TOKEN" : "7f00cc33-1a7a-4464-830f-91be90dcc880" , "test_field" : "OVHcloud"}' +``` + Replace the ``, `` and `` with your Logs Data Platform username, password and cluster. You can also use [tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens) in place of your credentials. Sending this payload will result in this log: ![simple\_log](images/one_field.png){.thumbnail} @@ -45,6 +51,80 @@ The numeric field **numeric_field** will be detected as a number and will be suf The OpenSearch input will also flatten any sub-object or array sent through it and also supports ingest pipelines that are used, for example, with [Filebeat integrations](/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat). +### Using the OpenSearch API with IAM enabled + +When **IAM** is enabled for your Logs Data Platform service, the authentication method for the OpenSearch API changes: + +- **Legacy (non‑IAM) authentication** uses basic username/password (or a legacy token) as described in the existing examples. +- **IAM authentication** uses a **Bearer token** obtained from OVHcloud IAM (Personal Access Token or Service Account token). + +**How to obtain a Bearer token** – you can generate one via a service account or a local user: + +For a service account: + +- Create a [service account](/pages/manage_and_operate/iam/identities-management/) and assign the required IAM policies (see the [IAM access management guide](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management)). +- Retrieve an API token using the OAuth2 client‑credentials flow as described in the [service‑account authentication guide](/pages/account_and_service_management/account_information/authenticate-api-with-service-account). The request looks like: + + ```bash + curl --request POST \ + --url 'https://www.ovh.com/auth/oauth2/token' \ + --header 'content-type: application/x-www-form-urlencoded' \ + --data grant_type=client_credentials \ + --data client_id= \ + --data scope=all + ``` + The response contains an `access_token` field – this is the Bearer token to use. + +For a local user: + +- You can create a local user by following the dedicated section on the [Identities management guide](/pages/manage_and_operate/iam/identities-management/). +- You can generate a Personal Access Token via the IAM API. See the FAQ documentation or use the call: + +> [!api] +> +> @api {v1} /me POST /me/identity/user/{user}/token +> + + Replace `{user}` with your OVHcloud local user. The response also returns an `access_token` that can be used as a Bearer token. + + +#### New request format + +```bash +# Ingest a log with IAM (Bearer token in header) +curl -H 'Content-Type: application/json' \ + -H 'Authorization: Bearer ' \ + -XPOST https://.logs.ovh.com:9200/ldp-logs/_doc \ + -d '{ "test_field" : "OVHcloud", "short_message" : "Hello with IAM" }' +``` + +*Notes*: +- The **index/alias prefix** is now the **service name** (e.g. `ldp-ab-56945`) instead of the username. You can find the service name on the Logs Data Platform home page or in the service URN (`urn:v1:eu:resource:ldp:`). +- The same Bearer token can be used for **querying** the OpenSearch backend: + +```bash +# Ingest a log with IAM (dedicated option in recents version of curl) +curl -k -v -H 'content-type: application/json' \ + --oauth2-bearer \ + -XGET 'https://gra1.logs.ovh.com:9200/_cluster/health?pretty' +``` + +#### Hybrid authentication (Bearer token with Basic scheme) + +For clients that do not support the `Authorization: Bearer` header, you can use the Bearer token value with a Basic authentication scheme by prefixing it by `pat_jwt_` as follows: + +```bash +Authorization: Basic pat_jwt_: +``` + +Replace `` with any ASCII value to identify your Personal Access Token (PAT) and `` with the token obtained as described above. This allows the request to be accepted by the OpenSearch endpoint with a user/password couple while using the same token. + + +All existing examples that use basic credentials remain valid for customers who have **not** enabled IAM. + +--- + ## Use case: Vector [Vector](https://vector.dev/) is a fast and lightweight log forwarder written in Rust. This software is quite similar to [Logstash](/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input) or [Fluent Bit](/pages/manage_and_operate/observability/logs_data_platform/ingestion_kubernetes_fluent_bit). It takes logs from a source, transforms them and sends them in a format compatible with the configured output module. @@ -105,4 +185,4 @@ The logs from journald arrived fully parsed and ready to be explored. Use differ - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](https://www.ovh.com/fr/order/express/#/express/review?products=~(~(planCode~'logs-account~productId~'logs))) +- Create an account: [Try it!](https://www.ovh.com/fr/order/express/#/express/review?products=~(~(planCode~'logs-account~productId~'logs))) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.it-it.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.it-it.md index e6c34b4fde6..73dd5453bd4 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.it-it.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.it-it.md @@ -1,7 +1,7 @@ --- title: Mutualized input - OpenSearch API excerpt: Send your logs to the platform with the OpenSearch API. -updated: 2024-06-29 +updated: 2025-10-16 --- ## Overview @@ -10,12 +10,18 @@ OpenSearch is the star component of our platform, making it possible to use [Ope ## OpenSearch endpoint -The OpenSearch endpoint is a dedicated index where you can send a JSON document. The port used is the **9200**, the same HTTP port used for all other OpenSearch APIs of Logs Data Platform. The only fields needed are the **X-OVH-TOKEN** and an extra field (any custom field). Don't hesitate to go to the [Quick Start documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) if you are not familiar with this notion. This document log will be transformed into a valid GELF log and any missing field will be filled automatically. In order to respect the GELF convention, you can also use all the [GELF format reserved fields](https://docs.graylog.org/docs/gelf). Here is one example of the minimal message you can send: +The OpenSearch endpoint is a dedicated index where you can send a JSON document. The port used is the **9200**, the same HTTP port used for all other OpenSearch APIs of Logs Data Platform. The request must include the **X‑OVH‑TOKEN** field, which is a token used by the logging pipeline, and any additional custom fields. Authentication for the endpoint is performed via basic username/password (or a legacy token) for non‑IAM users, or via an IAM **Bearer** token when IAM is enabled. Don't hesitate to go to the [Quick Start documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) if you are not familiar with this notion. This document log will be transformed into a valid GELF log and any missing field will be filled automatically. In order to respect the GELF convention, you can also use all the [GELF format reserved fields](https://docs.graylog.org/docs/gelf). Here is one example of the minimal message you can send: ```shell-session $ curl -H 'Content-Type: application/json' -u ':' -XPOST https://.logs.ovh.com:9200/ldp-logs/_doc -d '{ "X-OVH-TOKEN" : "7f00cc33-1a7a-4464-830f-91be90dcc880" , "test_field" : "OVHcloud"}' ``` +or with [IAM enabled](/pages/manage_and_operate/observability/logs_data_platform/iam_presentation_faq) + +```shell-session +$ curl -H 'Content-Type: application/json' --oauth2-bearer '' -XPOST https://.logs.ovh.com:9200/ldp-logs/_doc -d '{ "X-OVH-TOKEN" : "7f00cc33-1a7a-4464-830f-91be90dcc880" , "test_field" : "OVHcloud"}' +``` + Replace the ``, `` and `` with your Logs Data Platform username, password and cluster. You can also use [tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens) in place of your credentials. Sending this payload will result in this log: ![simple\_log](images/one_field.png){.thumbnail} @@ -45,6 +51,80 @@ The numeric field **numeric_field** will be detected as a number and will be suf The OpenSearch input will also flatten any sub-object or array sent through it and also supports ingest pipelines that are used, for example, with [Filebeat integrations](/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat). +### Using the OpenSearch API with IAM enabled + +When **IAM** is enabled for your Logs Data Platform service, the authentication method for the OpenSearch API changes: + +- **Legacy (non‑IAM) authentication** uses basic username/password (or a legacy token) as described in the existing examples. +- **IAM authentication** uses a **Bearer token** obtained from OVHcloud IAM (Personal Access Token or Service Account token). + +**How to obtain a Bearer token** – you can generate one via a service account or a local user: + +For a service account: + +- Create a [service account](/pages/manage_and_operate/iam/identities-management/) and assign the required IAM policies (see the [IAM access management guide](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management)). +- Retrieve an API token using the OAuth2 client‑credentials flow as described in the [service‑account authentication guide](/pages/account_and_service_management/account_information/authenticate-api-with-service-account). The request looks like: + + ```bash + curl --request POST \ + --url 'https://www.ovh.com/auth/oauth2/token' \ + --header 'content-type: application/x-www-form-urlencoded' \ + --data grant_type=client_credentials \ + --data client_id= \ + --data scope=all + ``` + The response contains an `access_token` field – this is the Bearer token to use. + +For a local user: + +- You can create a local user by following the dedicated section on the [Identities management guide](/pages/manage_and_operate/iam/identities-management/). +- You can generate a Personal Access Token via the IAM API. See the FAQ documentation or use the call: + +> [!api] +> +> @api {v1} /me POST /me/identity/user/{user}/token +> + + Replace `{user}` with your OVHcloud local user. The response also returns an `access_token` that can be used as a Bearer token. + + +#### New request format + +```bash +# Ingest a log with IAM (Bearer token in header) +curl -H 'Content-Type: application/json' \ + -H 'Authorization: Bearer ' \ + -XPOST https://.logs.ovh.com:9200/ldp-logs/_doc \ + -d '{ "test_field" : "OVHcloud", "short_message" : "Hello with IAM" }' +``` + +*Notes*: +- The **index/alias prefix** is now the **service name** (e.g. `ldp-ab-56945`) instead of the username. You can find the service name on the Logs Data Platform home page or in the service URN (`urn:v1:eu:resource:ldp:`). +- The same Bearer token can be used for **querying** the OpenSearch backend: + +```bash +# Ingest a log with IAM (dedicated option in recents version of curl) +curl -k -v -H 'content-type: application/json' \ + --oauth2-bearer \ + -XGET 'https://gra1.logs.ovh.com:9200/_cluster/health?pretty' +``` + +#### Hybrid authentication (Bearer token with Basic scheme) + +For clients that do not support the `Authorization: Bearer` header, you can use the Bearer token value with a Basic authentication scheme by prefixing it by `pat_jwt_` as follows: + +```bash +Authorization: Basic pat_jwt_: +``` + +Replace `` with any ASCII value to identify your Personal Access Token (PAT) and `` with the token obtained as described above. This allows the request to be accepted by the OpenSearch endpoint with a user/password couple while using the same token. + + +All existing examples that use basic credentials remain valid for customers who have **not** enabled IAM. + +--- + ## Use case: Vector [Vector](https://vector.dev/) is a fast and lightweight log forwarder written in Rust. This software is quite similar to [Logstash](/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input) or [Fluent Bit](/pages/manage_and_operate/observability/logs_data_platform/ingestion_kubernetes_fluent_bit). It takes logs from a source, transforms them and sends them in a format compatible with the configured output module. @@ -105,4 +185,4 @@ The logs from journald arrived fully parsed and ready to be explored. Use differ - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](https://www.ovh.com/fr/order/express/#/express/review?products=~(~(planCode~'logs-account~productId~'logs))) +- Create an account: [Try it!](https://www.ovh.com/fr/order/express/#/express/review?products=~(~(planCode~'logs-account~productId~'logs))) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.pl-pl.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.pl-pl.md index e6c34b4fde6..73dd5453bd4 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.pl-pl.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.pl-pl.md @@ -1,7 +1,7 @@ --- title: Mutualized input - OpenSearch API excerpt: Send your logs to the platform with the OpenSearch API. -updated: 2024-06-29 +updated: 2025-10-16 --- ## Overview @@ -10,12 +10,18 @@ OpenSearch is the star component of our platform, making it possible to use [Ope ## OpenSearch endpoint -The OpenSearch endpoint is a dedicated index where you can send a JSON document. The port used is the **9200**, the same HTTP port used for all other OpenSearch APIs of Logs Data Platform. The only fields needed are the **X-OVH-TOKEN** and an extra field (any custom field). Don't hesitate to go to the [Quick Start documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) if you are not familiar with this notion. This document log will be transformed into a valid GELF log and any missing field will be filled automatically. In order to respect the GELF convention, you can also use all the [GELF format reserved fields](https://docs.graylog.org/docs/gelf). Here is one example of the minimal message you can send: +The OpenSearch endpoint is a dedicated index where you can send a JSON document. The port used is the **9200**, the same HTTP port used for all other OpenSearch APIs of Logs Data Platform. The request must include the **X‑OVH‑TOKEN** field, which is a token used by the logging pipeline, and any additional custom fields. Authentication for the endpoint is performed via basic username/password (or a legacy token) for non‑IAM users, or via an IAM **Bearer** token when IAM is enabled. Don't hesitate to go to the [Quick Start documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) if you are not familiar with this notion. This document log will be transformed into a valid GELF log and any missing field will be filled automatically. In order to respect the GELF convention, you can also use all the [GELF format reserved fields](https://docs.graylog.org/docs/gelf). Here is one example of the minimal message you can send: ```shell-session $ curl -H 'Content-Type: application/json' -u ':' -XPOST https://.logs.ovh.com:9200/ldp-logs/_doc -d '{ "X-OVH-TOKEN" : "7f00cc33-1a7a-4464-830f-91be90dcc880" , "test_field" : "OVHcloud"}' ``` +or with [IAM enabled](/pages/manage_and_operate/observability/logs_data_platform/iam_presentation_faq) + +```shell-session +$ curl -H 'Content-Type: application/json' --oauth2-bearer '' -XPOST https://.logs.ovh.com:9200/ldp-logs/_doc -d '{ "X-OVH-TOKEN" : "7f00cc33-1a7a-4464-830f-91be90dcc880" , "test_field" : "OVHcloud"}' +``` + Replace the ``, `` and `` with your Logs Data Platform username, password and cluster. You can also use [tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens) in place of your credentials. Sending this payload will result in this log: ![simple\_log](images/one_field.png){.thumbnail} @@ -45,6 +51,80 @@ The numeric field **numeric_field** will be detected as a number and will be suf The OpenSearch input will also flatten any sub-object or array sent through it and also supports ingest pipelines that are used, for example, with [Filebeat integrations](/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat). +### Using the OpenSearch API with IAM enabled + +When **IAM** is enabled for your Logs Data Platform service, the authentication method for the OpenSearch API changes: + +- **Legacy (non‑IAM) authentication** uses basic username/password (or a legacy token) as described in the existing examples. +- **IAM authentication** uses a **Bearer token** obtained from OVHcloud IAM (Personal Access Token or Service Account token). + +**How to obtain a Bearer token** – you can generate one via a service account or a local user: + +For a service account: + +- Create a [service account](/pages/manage_and_operate/iam/identities-management/) and assign the required IAM policies (see the [IAM access management guide](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management)). +- Retrieve an API token using the OAuth2 client‑credentials flow as described in the [service‑account authentication guide](/pages/account_and_service_management/account_information/authenticate-api-with-service-account). The request looks like: + + ```bash + curl --request POST \ + --url 'https://www.ovh.com/auth/oauth2/token' \ + --header 'content-type: application/x-www-form-urlencoded' \ + --data grant_type=client_credentials \ + --data client_id= \ + --data scope=all + ``` + The response contains an `access_token` field – this is the Bearer token to use. + +For a local user: + +- You can create a local user by following the dedicated section on the [Identities management guide](/pages/manage_and_operate/iam/identities-management/). +- You can generate a Personal Access Token via the IAM API. See the FAQ documentation or use the call: + +> [!api] +> +> @api {v1} /me POST /me/identity/user/{user}/token +> + + Replace `{user}` with your OVHcloud local user. The response also returns an `access_token` that can be used as a Bearer token. + + +#### New request format + +```bash +# Ingest a log with IAM (Bearer token in header) +curl -H 'Content-Type: application/json' \ + -H 'Authorization: Bearer ' \ + -XPOST https://.logs.ovh.com:9200/ldp-logs/_doc \ + -d '{ "test_field" : "OVHcloud", "short_message" : "Hello with IAM" }' +``` + +*Notes*: +- The **index/alias prefix** is now the **service name** (e.g. `ldp-ab-56945`) instead of the username. You can find the service name on the Logs Data Platform home page or in the service URN (`urn:v1:eu:resource:ldp:`). +- The same Bearer token can be used for **querying** the OpenSearch backend: + +```bash +# Ingest a log with IAM (dedicated option in recents version of curl) +curl -k -v -H 'content-type: application/json' \ + --oauth2-bearer \ + -XGET 'https://gra1.logs.ovh.com:9200/_cluster/health?pretty' +``` + +#### Hybrid authentication (Bearer token with Basic scheme) + +For clients that do not support the `Authorization: Bearer` header, you can use the Bearer token value with a Basic authentication scheme by prefixing it by `pat_jwt_` as follows: + +```bash +Authorization: Basic pat_jwt_: +``` + +Replace `` with any ASCII value to identify your Personal Access Token (PAT) and `` with the token obtained as described above. This allows the request to be accepted by the OpenSearch endpoint with a user/password couple while using the same token. + + +All existing examples that use basic credentials remain valid for customers who have **not** enabled IAM. + +--- + ## Use case: Vector [Vector](https://vector.dev/) is a fast and lightweight log forwarder written in Rust. This software is quite similar to [Logstash](/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input) or [Fluent Bit](/pages/manage_and_operate/observability/logs_data_platform/ingestion_kubernetes_fluent_bit). It takes logs from a source, transforms them and sends them in a format compatible with the configured output module. @@ -105,4 +185,4 @@ The logs from journald arrived fully parsed and ready to be explored. Use differ - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](https://www.ovh.com/fr/order/express/#/express/review?products=~(~(planCode~'logs-account~productId~'logs))) +- Create an account: [Try it!](https://www.ovh.com/fr/order/express/#/express/review?products=~(~(planCode~'logs-account~productId~'logs))) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.pt-pt.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.pt-pt.md index e6c34b4fde6..73dd5453bd4 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.pt-pt.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_opensearch_api_mutualized_input/guide.pt-pt.md @@ -1,7 +1,7 @@ --- title: Mutualized input - OpenSearch API excerpt: Send your logs to the platform with the OpenSearch API. -updated: 2024-06-29 +updated: 2025-10-16 --- ## Overview @@ -10,12 +10,18 @@ OpenSearch is the star component of our platform, making it possible to use [Ope ## OpenSearch endpoint -The OpenSearch endpoint is a dedicated index where you can send a JSON document. The port used is the **9200**, the same HTTP port used for all other OpenSearch APIs of Logs Data Platform. The only fields needed are the **X-OVH-TOKEN** and an extra field (any custom field). Don't hesitate to go to the [Quick Start documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) if you are not familiar with this notion. This document log will be transformed into a valid GELF log and any missing field will be filled automatically. In order to respect the GELF convention, you can also use all the [GELF format reserved fields](https://docs.graylog.org/docs/gelf). Here is one example of the minimal message you can send: +The OpenSearch endpoint is a dedicated index where you can send a JSON document. The port used is the **9200**, the same HTTP port used for all other OpenSearch APIs of Logs Data Platform. The request must include the **X‑OVH‑TOKEN** field, which is a token used by the logging pipeline, and any additional custom fields. Authentication for the endpoint is performed via basic username/password (or a legacy token) for non‑IAM users, or via an IAM **Bearer** token when IAM is enabled. Don't hesitate to go to the [Quick Start documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) if you are not familiar with this notion. This document log will be transformed into a valid GELF log and any missing field will be filled automatically. In order to respect the GELF convention, you can also use all the [GELF format reserved fields](https://docs.graylog.org/docs/gelf). Here is one example of the minimal message you can send: ```shell-session $ curl -H 'Content-Type: application/json' -u ':' -XPOST https://.logs.ovh.com:9200/ldp-logs/_doc -d '{ "X-OVH-TOKEN" : "7f00cc33-1a7a-4464-830f-91be90dcc880" , "test_field" : "OVHcloud"}' ``` +or with [IAM enabled](/pages/manage_and_operate/observability/logs_data_platform/iam_presentation_faq) + +```shell-session +$ curl -H 'Content-Type: application/json' --oauth2-bearer '' -XPOST https://.logs.ovh.com:9200/ldp-logs/_doc -d '{ "X-OVH-TOKEN" : "7f00cc33-1a7a-4464-830f-91be90dcc880" , "test_field" : "OVHcloud"}' +``` + Replace the ``, `` and `` with your Logs Data Platform username, password and cluster. You can also use [tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens) in place of your credentials. Sending this payload will result in this log: ![simple\_log](images/one_field.png){.thumbnail} @@ -45,6 +51,80 @@ The numeric field **numeric_field** will be detected as a number and will be suf The OpenSearch input will also flatten any sub-object or array sent through it and also supports ingest pipelines that are used, for example, with [Filebeat integrations](/pages/manage_and_operate/observability/logs_data_platform/ingestion_filebeat). +### Using the OpenSearch API with IAM enabled + +When **IAM** is enabled for your Logs Data Platform service, the authentication method for the OpenSearch API changes: + +- **Legacy (non‑IAM) authentication** uses basic username/password (or a legacy token) as described in the existing examples. +- **IAM authentication** uses a **Bearer token** obtained from OVHcloud IAM (Personal Access Token or Service Account token). + +**How to obtain a Bearer token** – you can generate one via a service account or a local user: + +For a service account: + +- Create a [service account](/pages/manage_and_operate/iam/identities-management/) and assign the required IAM policies (see the [IAM access management guide](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management)). +- Retrieve an API token using the OAuth2 client‑credentials flow as described in the [service‑account authentication guide](/pages/account_and_service_management/account_information/authenticate-api-with-service-account). The request looks like: + + ```bash + curl --request POST \ + --url 'https://www.ovh.com/auth/oauth2/token' \ + --header 'content-type: application/x-www-form-urlencoded' \ + --data grant_type=client_credentials \ + --data client_id= \ + --data scope=all + ``` + The response contains an `access_token` field – this is the Bearer token to use. + +For a local user: + +- You can create a local user by following the dedicated section on the [Identities management guide](/pages/manage_and_operate/iam/identities-management/). +- You can generate a Personal Access Token via the IAM API. See the FAQ documentation or use the call: + +> [!api] +> +> @api {v1} /me POST /me/identity/user/{user}/token +> + + Replace `{user}` with your OVHcloud local user. The response also returns an `access_token` that can be used as a Bearer token. + + +#### New request format + +```bash +# Ingest a log with IAM (Bearer token in header) +curl -H 'Content-Type: application/json' \ + -H 'Authorization: Bearer ' \ + -XPOST https://.logs.ovh.com:9200/ldp-logs/_doc \ + -d '{ "test_field" : "OVHcloud", "short_message" : "Hello with IAM" }' +``` + +*Notes*: +- The **index/alias prefix** is now the **service name** (e.g. `ldp-ab-56945`) instead of the username. You can find the service name on the Logs Data Platform home page or in the service URN (`urn:v1:eu:resource:ldp:`). +- The same Bearer token can be used for **querying** the OpenSearch backend: + +```bash +# Ingest a log with IAM (dedicated option in recents version of curl) +curl -k -v -H 'content-type: application/json' \ + --oauth2-bearer \ + -XGET 'https://gra1.logs.ovh.com:9200/_cluster/health?pretty' +``` + +#### Hybrid authentication (Bearer token with Basic scheme) + +For clients that do not support the `Authorization: Bearer` header, you can use the Bearer token value with a Basic authentication scheme by prefixing it by `pat_jwt_` as follows: + +```bash +Authorization: Basic pat_jwt_: +``` + +Replace `` with any ASCII value to identify your Personal Access Token (PAT) and `` with the token obtained as described above. This allows the request to be accepted by the OpenSearch endpoint with a user/password couple while using the same token. + + +All existing examples that use basic credentials remain valid for customers who have **not** enabled IAM. + +--- + ## Use case: Vector [Vector](https://vector.dev/) is a fast and lightweight log forwarder written in Rust. This software is quite similar to [Logstash](/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input) or [Fluent Bit](/pages/manage_and_operate/observability/logs_data_platform/ingestion_kubernetes_fluent_bit). It takes logs from a source, transforms them and sends them in a format compatible with the configured output module. @@ -105,4 +185,4 @@ The logs from journald arrived fully parsed and ready to be explored. Use differ - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](https://www.ovh.com/fr/order/express/#/express/review?products=~(~(planCode~'logs-account~productId~'logs))) +- Create an account: [Try it!](https://www.ovh.com/fr/order/express/#/express/review?products=~(~(planCode~'logs-account~productId~'logs))) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.de-de.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.de-de.md index ea5fa70adf7..56865dae029 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.de-de.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.de-de.md @@ -1,5 +1,6 @@ --- -title: Pushing logs with a forwarder - Syslog-ng 3.12.1+ (Linux) +title: "Pushing logs with a forwarder - Syslog-ng 3.12.1+ (Linux)" +excerpt: "Find out how to send logs from your Linux instance to Logs Data Platform" updated: 2024-03-08 --- @@ -106,13 +107,13 @@ log { source(s_src); rewrite(ovh-token); destination(ovhPaaSLogs); }; > > - Copy the **data-gathering tools certificate** from the manager Home page in SSL Configuration section, and paste it in file "/usr/local/share/ca-certificates/ldp.pem" > - Ensure the permission on this file is 644 -> +> > 
$ debian@server:~$ sudo chmod 644 /usr/share/ca-certificates/ldp.pem
-> +> > - Import this certificate to your system's trusted CA repository -> +> > 
$ debian@server:~$ sudo update-ca-certificates
-> +> Let's review this configuration. @@ -135,7 +136,7 @@ Let's recap: you have a Linux instance, and it's sending log locally and remotel The last step is to create a dashboard displaying the results: -- Connect to the Logs Data Platform manager, ensure you that you have a Stream and that the token in the syslog configuration file is OK. Ensure that you have a Dashboard created. +- Connect to the Logs Data Platform manager, ensure that you have a Stream and that the token in the syslog configuration file is OK. Ensure that you have a Dashboard created. - Head to your stream by using the button `Graylog access`{.action} located in the **...** menu of your stream, or head directly to the graylog access of your cluster. - Once in Graylog, Go in Stream Tab, click on your stream. In the top-left corner, chose a 1 Day range and click on the green button to search. - You should have some results like this: @@ -144,7 +145,7 @@ The last step is to create a dashboard displaying the results: - On the top right corner of the histogram, click on `Add to dashboard`{.action}. -Alright, you just created the first widget in you dashboard. Now, let's create a Pie chart: +Alright, you just created the first widget in your dashboard. Now, let's create a Pie chart: - On the left, click on the small blue triangle before "facility" - Click on "Quick Values" @@ -159,4 +160,4 @@ The best feature is the ability to mix criteria, based on what is important to y - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.en-asia.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.en-asia.md index ea5fa70adf7..56865dae029 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.en-asia.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.en-asia.md @@ -1,5 +1,6 @@ --- -title: Pushing logs with a forwarder - Syslog-ng 3.12.1+ (Linux) +title: "Pushing logs with a forwarder - Syslog-ng 3.12.1+ (Linux)" +excerpt: "Find out how to send logs from your Linux instance to Logs Data Platform" updated: 2024-03-08 --- @@ -106,13 +107,13 @@ log { source(s_src); rewrite(ovh-token); destination(ovhPaaSLogs); }; > > - Copy the **data-gathering tools certificate** from the manager Home page in SSL Configuration section, and paste it in file "/usr/local/share/ca-certificates/ldp.pem" > - Ensure the permission on this file is 644 -> +> > 
$ debian@server:~$ sudo chmod 644 /usr/share/ca-certificates/ldp.pem
-> +> > - Import this certificate to your system's trusted CA repository -> +> > 
$ debian@server:~$ sudo update-ca-certificates
-> +> Let's review this configuration. @@ -135,7 +136,7 @@ Let's recap: you have a Linux instance, and it's sending log locally and remotel The last step is to create a dashboard displaying the results: -- Connect to the Logs Data Platform manager, ensure you that you have a Stream and that the token in the syslog configuration file is OK. Ensure that you have a Dashboard created. +- Connect to the Logs Data Platform manager, ensure that you have a Stream and that the token in the syslog configuration file is OK. Ensure that you have a Dashboard created. - Head to your stream by using the button `Graylog access`{.action} located in the **...** menu of your stream, or head directly to the graylog access of your cluster. - Once in Graylog, Go in Stream Tab, click on your stream. In the top-left corner, chose a 1 Day range and click on the green button to search. - You should have some results like this: @@ -144,7 +145,7 @@ The last step is to create a dashboard displaying the results: - On the top right corner of the histogram, click on `Add to dashboard`{.action}. -Alright, you just created the first widget in you dashboard. Now, let's create a Pie chart: +Alright, you just created the first widget in your dashboard. Now, let's create a Pie chart: - On the left, click on the small blue triangle before "facility" - Click on "Quick Values" @@ -159,4 +160,4 @@ The best feature is the ability to mix criteria, based on what is important to y - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.en-au.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.en-au.md index ea5fa70adf7..56865dae029 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.en-au.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.en-au.md @@ -1,5 +1,6 @@ --- -title: Pushing logs with a forwarder - Syslog-ng 3.12.1+ (Linux) +title: "Pushing logs with a forwarder - Syslog-ng 3.12.1+ (Linux)" +excerpt: "Find out how to send logs from your Linux instance to Logs Data Platform" updated: 2024-03-08 --- @@ -106,13 +107,13 @@ log { source(s_src); rewrite(ovh-token); destination(ovhPaaSLogs); }; > > - Copy the **data-gathering tools certificate** from the manager Home page in SSL Configuration section, and paste it in file "/usr/local/share/ca-certificates/ldp.pem" > - Ensure the permission on this file is 644 -> +> > 
$ debian@server:~$ sudo chmod 644 /usr/share/ca-certificates/ldp.pem
-> +> > - Import this certificate to your system's trusted CA repository -> +> > 
$ debian@server:~$ sudo update-ca-certificates
-> +> Let's review this configuration. @@ -135,7 +136,7 @@ Let's recap: you have a Linux instance, and it's sending log locally and remotel The last step is to create a dashboard displaying the results: -- Connect to the Logs Data Platform manager, ensure you that you have a Stream and that the token in the syslog configuration file is OK. Ensure that you have a Dashboard created. +- Connect to the Logs Data Platform manager, ensure that you have a Stream and that the token in the syslog configuration file is OK. Ensure that you have a Dashboard created. - Head to your stream by using the button `Graylog access`{.action} located in the **...** menu of your stream, or head directly to the graylog access of your cluster. - Once in Graylog, Go in Stream Tab, click on your stream. In the top-left corner, chose a 1 Day range and click on the green button to search. - You should have some results like this: @@ -144,7 +145,7 @@ The last step is to create a dashboard displaying the results: - On the top right corner of the histogram, click on `Add to dashboard`{.action}. -Alright, you just created the first widget in you dashboard. Now, let's create a Pie chart: +Alright, you just created the first widget in your dashboard. Now, let's create a Pie chart: - On the left, click on the small blue triangle before "facility" - Click on "Quick Values" @@ -159,4 +160,4 @@ The best feature is the ability to mix criteria, based on what is important to y - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.en-ca.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.en-ca.md index ea5fa70adf7..56865dae029 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.en-ca.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.en-ca.md @@ -1,5 +1,6 @@ --- -title: Pushing logs with a forwarder - Syslog-ng 3.12.1+ (Linux) +title: "Pushing logs with a forwarder - Syslog-ng 3.12.1+ (Linux)" +excerpt: "Find out how to send logs from your Linux instance to Logs Data Platform" updated: 2024-03-08 --- @@ -106,13 +107,13 @@ log { source(s_src); rewrite(ovh-token); destination(ovhPaaSLogs); }; > > - Copy the **data-gathering tools certificate** from the manager Home page in SSL Configuration section, and paste it in file "/usr/local/share/ca-certificates/ldp.pem" > - Ensure the permission on this file is 644 -> +> > 
$ debian@server:~$ sudo chmod 644 /usr/share/ca-certificates/ldp.pem
-> +> > - Import this certificate to your system's trusted CA repository -> +> > 
$ debian@server:~$ sudo update-ca-certificates
-> +> Let's review this configuration. @@ -135,7 +136,7 @@ Let's recap: you have a Linux instance, and it's sending log locally and remotel The last step is to create a dashboard displaying the results: -- Connect to the Logs Data Platform manager, ensure you that you have a Stream and that the token in the syslog configuration file is OK. Ensure that you have a Dashboard created. +- Connect to the Logs Data Platform manager, ensure that you have a Stream and that the token in the syslog configuration file is OK. Ensure that you have a Dashboard created. - Head to your stream by using the button `Graylog access`{.action} located in the **...** menu of your stream, or head directly to the graylog access of your cluster. - Once in Graylog, Go in Stream Tab, click on your stream. In the top-left corner, chose a 1 Day range and click on the green button to search. - You should have some results like this: @@ -144,7 +145,7 @@ The last step is to create a dashboard displaying the results: - On the top right corner of the histogram, click on `Add to dashboard`{.action}. -Alright, you just created the first widget in you dashboard. Now, let's create a Pie chart: +Alright, you just created the first widget in your dashboard. Now, let's create a Pie chart: - On the left, click on the small blue triangle before "facility" - Click on "Quick Values" @@ -159,4 +160,4 @@ The best feature is the ability to mix criteria, based on what is important to y - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.en-gb.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.en-gb.md index 33e1a61bda1..56865dae029 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.en-gb.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.en-gb.md @@ -107,13 +107,13 @@ log { source(s_src); rewrite(ovh-token); destination(ovhPaaSLogs); }; > > - Copy the **data-gathering tools certificate** from the manager Home page in SSL Configuration section, and paste it in file "/usr/local/share/ca-certificates/ldp.pem" > - Ensure the permission on this file is 644 -> +> > 
$ debian@server:~$ sudo chmod 644 /usr/share/ca-certificates/ldp.pem
-> +> > - Import this certificate to your system's trusted CA repository -> +> > 
$ debian@server:~$ sudo update-ca-certificates
-> +> Let's review this configuration. @@ -160,4 +160,4 @@ The best feature is the ability to mix criteria, based on what is important to y - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.en-ie.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.en-ie.md index ea5fa70adf7..56865dae029 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.en-ie.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.en-ie.md @@ -1,5 +1,6 @@ --- -title: Pushing logs with a forwarder - Syslog-ng 3.12.1+ (Linux) +title: "Pushing logs with a forwarder - Syslog-ng 3.12.1+ (Linux)" +excerpt: "Find out how to send logs from your Linux instance to Logs Data Platform" updated: 2024-03-08 --- @@ -106,13 +107,13 @@ log { source(s_src); rewrite(ovh-token); destination(ovhPaaSLogs); }; > > - Copy the **data-gathering tools certificate** from the manager Home page in SSL Configuration section, and paste it in file "/usr/local/share/ca-certificates/ldp.pem" > - Ensure the permission on this file is 644 -> +> > 
$ debian@server:~$ sudo chmod 644 /usr/share/ca-certificates/ldp.pem
-> +> > - Import this certificate to your system's trusted CA repository -> +> > 
$ debian@server:~$ sudo update-ca-certificates
-> +> Let's review this configuration. @@ -135,7 +136,7 @@ Let's recap: you have a Linux instance, and it's sending log locally and remotel The last step is to create a dashboard displaying the results: -- Connect to the Logs Data Platform manager, ensure you that you have a Stream and that the token in the syslog configuration file is OK. Ensure that you have a Dashboard created. +- Connect to the Logs Data Platform manager, ensure that you have a Stream and that the token in the syslog configuration file is OK. Ensure that you have a Dashboard created. - Head to your stream by using the button `Graylog access`{.action} located in the **...** menu of your stream, or head directly to the graylog access of your cluster. - Once in Graylog, Go in Stream Tab, click on your stream. In the top-left corner, chose a 1 Day range and click on the green button to search. - You should have some results like this: @@ -144,7 +145,7 @@ The last step is to create a dashboard displaying the results: - On the top right corner of the histogram, click on `Add to dashboard`{.action}. -Alright, you just created the first widget in you dashboard. Now, let's create a Pie chart: +Alright, you just created the first widget in your dashboard. Now, let's create a Pie chart: - On the left, click on the small blue triangle before "facility" - Click on "Quick Values" @@ -159,4 +160,4 @@ The best feature is the ability to mix criteria, based on what is important to y - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.en-sg.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.en-sg.md index ea5fa70adf7..56865dae029 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.en-sg.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.en-sg.md @@ -1,5 +1,6 @@ --- -title: Pushing logs with a forwarder - Syslog-ng 3.12.1+ (Linux) +title: "Pushing logs with a forwarder - Syslog-ng 3.12.1+ (Linux)" +excerpt: "Find out how to send logs from your Linux instance to Logs Data Platform" updated: 2024-03-08 --- @@ -106,13 +107,13 @@ log { source(s_src); rewrite(ovh-token); destination(ovhPaaSLogs); }; > > - Copy the **data-gathering tools certificate** from the manager Home page in SSL Configuration section, and paste it in file "/usr/local/share/ca-certificates/ldp.pem" > - Ensure the permission on this file is 644 -> +> > 
$ debian@server:~$ sudo chmod 644 /usr/share/ca-certificates/ldp.pem
-> +> > - Import this certificate to your system's trusted CA repository -> +> > 
$ debian@server:~$ sudo update-ca-certificates
-> +> Let's review this configuration. @@ -135,7 +136,7 @@ Let's recap: you have a Linux instance, and it's sending log locally and remotel The last step is to create a dashboard displaying the results: -- Connect to the Logs Data Platform manager, ensure you that you have a Stream and that the token in the syslog configuration file is OK. Ensure that you have a Dashboard created. +- Connect to the Logs Data Platform manager, ensure that you have a Stream and that the token in the syslog configuration file is OK. Ensure that you have a Dashboard created. - Head to your stream by using the button `Graylog access`{.action} located in the **...** menu of your stream, or head directly to the graylog access of your cluster. - Once in Graylog, Go in Stream Tab, click on your stream. In the top-left corner, chose a 1 Day range and click on the green button to search. - You should have some results like this: @@ -144,7 +145,7 @@ The last step is to create a dashboard displaying the results: - On the top right corner of the histogram, click on `Add to dashboard`{.action}. -Alright, you just created the first widget in you dashboard. Now, let's create a Pie chart: +Alright, you just created the first widget in your dashboard. Now, let's create a Pie chart: - On the left, click on the small blue triangle before "facility" - Click on "Quick Values" @@ -159,4 +160,4 @@ The best feature is the ability to mix criteria, based on what is important to y - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.en-us.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.en-us.md index ea5fa70adf7..bd3bd220d35 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.en-us.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.en-us.md @@ -1,5 +1,6 @@ --- -title: Pushing logs with a forwarder - Syslog-ng 3.12.1+ (Linux) +title: "Pushing logs with a forwarder - Syslog-ng 3.12.1+ (Linux)" +excerpt: "Find out how to send logs from your Linux instance to Logs Data Platform" updated: 2024-03-08 --- @@ -106,13 +107,13 @@ log { source(s_src); rewrite(ovh-token); destination(ovhPaaSLogs); }; > > - Copy the **data-gathering tools certificate** from the manager Home page in SSL Configuration section, and paste it in file "/usr/local/share/ca-certificates/ldp.pem" > - Ensure the permission on this file is 644 -> +> > 
$ debian@server:~$ sudo chmod 644 /usr/share/ca-certificates/ldp.pem
-> +> > - Import this certificate to your system's trusted CA repository -> +> > 
$ debian@server:~$ sudo update-ca-certificates
-> +> Let's review this configuration. @@ -135,7 +136,7 @@ Let's recap: you have a Linux instance, and it's sending log locally and remotel The last step is to create a dashboard displaying the results: -- Connect to the Logs Data Platform manager, ensure you that you have a Stream and that the token in the syslog configuration file is OK. Ensure that you have a Dashboard created. +- Connect to the Logs Data Platform manager, ensure that you have a Stream and that the token in the syslog configuration file is OK. Ensure that you have a Dashboard created. - Head to your stream by using the button `Graylog access`{.action} located in the **...** menu of your stream, or head directly to the graylog access of your cluster. - Once in Graylog, Go in Stream Tab, click on your stream. In the top-left corner, chose a 1 Day range and click on the green button to search. - You should have some results like this: @@ -144,7 +145,7 @@ The last step is to create a dashboard displaying the results: - On the top right corner of the histogram, click on `Add to dashboard`{.action}. -Alright, you just created the first widget in you dashboard. Now, let's create a Pie chart: +Alright, you just created the first widget in your dashboard. Now, let's create a Pie chart: - On the left, click on the small blue triangle before "facility" - Click on "Quick Values" diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.es-es.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.es-es.md index ea5fa70adf7..56865dae029 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.es-es.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.es-es.md @@ -1,5 +1,6 @@ --- -title: Pushing logs with a forwarder - Syslog-ng 3.12.1+ (Linux) +title: "Pushing logs with a forwarder - Syslog-ng 3.12.1+ (Linux)" +excerpt: "Find out how to send logs from your Linux instance to Logs Data Platform" updated: 2024-03-08 --- @@ -106,13 +107,13 @@ log { source(s_src); rewrite(ovh-token); destination(ovhPaaSLogs); }; > > - Copy the **data-gathering tools certificate** from the manager Home page in SSL Configuration section, and paste it in file "/usr/local/share/ca-certificates/ldp.pem" > - Ensure the permission on this file is 644 -> +> > 
$ debian@server:~$ sudo chmod 644 /usr/share/ca-certificates/ldp.pem
-> +> > - Import this certificate to your system's trusted CA repository -> +> > 
$ debian@server:~$ sudo update-ca-certificates
-> +> Let's review this configuration. @@ -135,7 +136,7 @@ Let's recap: you have a Linux instance, and it's sending log locally and remotel The last step is to create a dashboard displaying the results: -- Connect to the Logs Data Platform manager, ensure you that you have a Stream and that the token in the syslog configuration file is OK. Ensure that you have a Dashboard created. +- Connect to the Logs Data Platform manager, ensure that you have a Stream and that the token in the syslog configuration file is OK. Ensure that you have a Dashboard created. - Head to your stream by using the button `Graylog access`{.action} located in the **...** menu of your stream, or head directly to the graylog access of your cluster. - Once in Graylog, Go in Stream Tab, click on your stream. In the top-left corner, chose a 1 Day range and click on the green button to search. - You should have some results like this: @@ -144,7 +145,7 @@ The last step is to create a dashboard displaying the results: - On the top right corner of the histogram, click on `Add to dashboard`{.action}. -Alright, you just created the first widget in you dashboard. Now, let's create a Pie chart: +Alright, you just created the first widget in your dashboard. Now, let's create a Pie chart: - On the left, click on the small blue triangle before "facility" - Click on "Quick Values" @@ -159,4 +160,4 @@ The best feature is the ability to mix criteria, based on what is important to y - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.es-us.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.es-us.md index ea5fa70adf7..56865dae029 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.es-us.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.es-us.md @@ -1,5 +1,6 @@ --- -title: Pushing logs with a forwarder - Syslog-ng 3.12.1+ (Linux) +title: "Pushing logs with a forwarder - Syslog-ng 3.12.1+ (Linux)" +excerpt: "Find out how to send logs from your Linux instance to Logs Data Platform" updated: 2024-03-08 --- @@ -106,13 +107,13 @@ log { source(s_src); rewrite(ovh-token); destination(ovhPaaSLogs); }; > > - Copy the **data-gathering tools certificate** from the manager Home page in SSL Configuration section, and paste it in file "/usr/local/share/ca-certificates/ldp.pem" > - Ensure the permission on this file is 644 -> +> > 
$ debian@server:~$ sudo chmod 644 /usr/share/ca-certificates/ldp.pem
-> +> > - Import this certificate to your system's trusted CA repository -> +> > 
$ debian@server:~$ sudo update-ca-certificates
-> +> Let's review this configuration. @@ -135,7 +136,7 @@ Let's recap: you have a Linux instance, and it's sending log locally and remotel The last step is to create a dashboard displaying the results: -- Connect to the Logs Data Platform manager, ensure you that you have a Stream and that the token in the syslog configuration file is OK. Ensure that you have a Dashboard created. +- Connect to the Logs Data Platform manager, ensure that you have a Stream and that the token in the syslog configuration file is OK. Ensure that you have a Dashboard created. - Head to your stream by using the button `Graylog access`{.action} located in the **...** menu of your stream, or head directly to the graylog access of your cluster. - Once in Graylog, Go in Stream Tab, click on your stream. In the top-left corner, chose a 1 Day range and click on the green button to search. - You should have some results like this: @@ -144,7 +145,7 @@ The last step is to create a dashboard displaying the results: - On the top right corner of the histogram, click on `Add to dashboard`{.action}. -Alright, you just created the first widget in you dashboard. Now, let's create a Pie chart: +Alright, you just created the first widget in your dashboard. Now, let's create a Pie chart: - On the left, click on the small blue triangle before "facility" - Click on "Quick Values" @@ -159,4 +160,4 @@ The best feature is the ability to mix criteria, based on what is important to y - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.fr-ca.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.fr-ca.md index ea5fa70adf7..56865dae029 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.fr-ca.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.fr-ca.md @@ -1,5 +1,6 @@ --- -title: Pushing logs with a forwarder - Syslog-ng 3.12.1+ (Linux) +title: "Pushing logs with a forwarder - Syslog-ng 3.12.1+ (Linux)" +excerpt: "Find out how to send logs from your Linux instance to Logs Data Platform" updated: 2024-03-08 --- @@ -106,13 +107,13 @@ log { source(s_src); rewrite(ovh-token); destination(ovhPaaSLogs); }; > > - Copy the **data-gathering tools certificate** from the manager Home page in SSL Configuration section, and paste it in file "/usr/local/share/ca-certificates/ldp.pem" > - Ensure the permission on this file is 644 -> +> > 
$ debian@server:~$ sudo chmod 644 /usr/share/ca-certificates/ldp.pem
-> +> > - Import this certificate to your system's trusted CA repository -> +> > 
$ debian@server:~$ sudo update-ca-certificates
-> +> Let's review this configuration. @@ -135,7 +136,7 @@ Let's recap: you have a Linux instance, and it's sending log locally and remotel The last step is to create a dashboard displaying the results: -- Connect to the Logs Data Platform manager, ensure you that you have a Stream and that the token in the syslog configuration file is OK. Ensure that you have a Dashboard created. +- Connect to the Logs Data Platform manager, ensure that you have a Stream and that the token in the syslog configuration file is OK. Ensure that you have a Dashboard created. - Head to your stream by using the button `Graylog access`{.action} located in the **...** menu of your stream, or head directly to the graylog access of your cluster. - Once in Graylog, Go in Stream Tab, click on your stream. In the top-left corner, chose a 1 Day range and click on the green button to search. - You should have some results like this: @@ -144,7 +145,7 @@ The last step is to create a dashboard displaying the results: - On the top right corner of the histogram, click on `Add to dashboard`{.action}. -Alright, you just created the first widget in you dashboard. Now, let's create a Pie chart: +Alright, you just created the first widget in your dashboard. Now, let's create a Pie chart: - On the left, click on the small blue triangle before "facility" - Click on "Quick Values" @@ -159,4 +160,4 @@ The best feature is the ability to mix criteria, based on what is important to y - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.fr-fr.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.fr-fr.md index ea5fa70adf7..56865dae029 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.fr-fr.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.fr-fr.md @@ -1,5 +1,6 @@ --- -title: Pushing logs with a forwarder - Syslog-ng 3.12.1+ (Linux) +title: "Pushing logs with a forwarder - Syslog-ng 3.12.1+ (Linux)" +excerpt: "Find out how to send logs from your Linux instance to Logs Data Platform" updated: 2024-03-08 --- @@ -106,13 +107,13 @@ log { source(s_src); rewrite(ovh-token); destination(ovhPaaSLogs); }; > > - Copy the **data-gathering tools certificate** from the manager Home page in SSL Configuration section, and paste it in file "/usr/local/share/ca-certificates/ldp.pem" > - Ensure the permission on this file is 644 -> +> > 
$ debian@server:~$ sudo chmod 644 /usr/share/ca-certificates/ldp.pem
-> +> > - Import this certificate to your system's trusted CA repository -> +> > 
$ debian@server:~$ sudo update-ca-certificates
-> +> Let's review this configuration. @@ -135,7 +136,7 @@ Let's recap: you have a Linux instance, and it's sending log locally and remotel The last step is to create a dashboard displaying the results: -- Connect to the Logs Data Platform manager, ensure you that you have a Stream and that the token in the syslog configuration file is OK. Ensure that you have a Dashboard created. +- Connect to the Logs Data Platform manager, ensure that you have a Stream and that the token in the syslog configuration file is OK. Ensure that you have a Dashboard created. - Head to your stream by using the button `Graylog access`{.action} located in the **...** menu of your stream, or head directly to the graylog access of your cluster. - Once in Graylog, Go in Stream Tab, click on your stream. In the top-left corner, chose a 1 Day range and click on the green button to search. - You should have some results like this: @@ -144,7 +145,7 @@ The last step is to create a dashboard displaying the results: - On the top right corner of the histogram, click on `Add to dashboard`{.action}. -Alright, you just created the first widget in you dashboard. Now, let's create a Pie chart: +Alright, you just created the first widget in your dashboard. Now, let's create a Pie chart: - On the left, click on the small blue triangle before "facility" - Click on "Quick Values" @@ -159,4 +160,4 @@ The best feature is the ability to mix criteria, based on what is important to y - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.it-it.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.it-it.md index ea5fa70adf7..56865dae029 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.it-it.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.it-it.md @@ -1,5 +1,6 @@ --- -title: Pushing logs with a forwarder - Syslog-ng 3.12.1+ (Linux) +title: "Pushing logs with a forwarder - Syslog-ng 3.12.1+ (Linux)" +excerpt: "Find out how to send logs from your Linux instance to Logs Data Platform" updated: 2024-03-08 --- @@ -106,13 +107,13 @@ log { source(s_src); rewrite(ovh-token); destination(ovhPaaSLogs); }; > > - Copy the **data-gathering tools certificate** from the manager Home page in SSL Configuration section, and paste it in file "/usr/local/share/ca-certificates/ldp.pem" > - Ensure the permission on this file is 644 -> +> > 
$ debian@server:~$ sudo chmod 644 /usr/share/ca-certificates/ldp.pem
-> +> > - Import this certificate to your system's trusted CA repository -> +> > 
$ debian@server:~$ sudo update-ca-certificates
-> +> Let's review this configuration. @@ -135,7 +136,7 @@ Let's recap: you have a Linux instance, and it's sending log locally and remotel The last step is to create a dashboard displaying the results: -- Connect to the Logs Data Platform manager, ensure you that you have a Stream and that the token in the syslog configuration file is OK. Ensure that you have a Dashboard created. +- Connect to the Logs Data Platform manager, ensure that you have a Stream and that the token in the syslog configuration file is OK. Ensure that you have a Dashboard created. - Head to your stream by using the button `Graylog access`{.action} located in the **...** menu of your stream, or head directly to the graylog access of your cluster. - Once in Graylog, Go in Stream Tab, click on your stream. In the top-left corner, chose a 1 Day range and click on the green button to search. - You should have some results like this: @@ -144,7 +145,7 @@ The last step is to create a dashboard displaying the results: - On the top right corner of the histogram, click on `Add to dashboard`{.action}. -Alright, you just created the first widget in you dashboard. Now, let's create a Pie chart: +Alright, you just created the first widget in your dashboard. Now, let's create a Pie chart: - On the left, click on the small blue triangle before "facility" - Click on "Quick Values" @@ -159,4 +160,4 @@ The best feature is the ability to mix criteria, based on what is important to y - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.pl-pl.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.pl-pl.md index ea5fa70adf7..56865dae029 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.pl-pl.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.pl-pl.md @@ -1,5 +1,6 @@ --- -title: Pushing logs with a forwarder - Syslog-ng 3.12.1+ (Linux) +title: "Pushing logs with a forwarder - Syslog-ng 3.12.1+ (Linux)" +excerpt: "Find out how to send logs from your Linux instance to Logs Data Platform" updated: 2024-03-08 --- @@ -106,13 +107,13 @@ log { source(s_src); rewrite(ovh-token); destination(ovhPaaSLogs); }; > > - Copy the **data-gathering tools certificate** from the manager Home page in SSL Configuration section, and paste it in file "/usr/local/share/ca-certificates/ldp.pem" > - Ensure the permission on this file is 644 -> +> > 
$ debian@server:~$ sudo chmod 644 /usr/share/ca-certificates/ldp.pem
-> +> > - Import this certificate to your system's trusted CA repository -> +> > 
$ debian@server:~$ sudo update-ca-certificates
-> +> Let's review this configuration. @@ -135,7 +136,7 @@ Let's recap: you have a Linux instance, and it's sending log locally and remotel The last step is to create a dashboard displaying the results: -- Connect to the Logs Data Platform manager, ensure you that you have a Stream and that the token in the syslog configuration file is OK. Ensure that you have a Dashboard created. +- Connect to the Logs Data Platform manager, ensure that you have a Stream and that the token in the syslog configuration file is OK. Ensure that you have a Dashboard created. - Head to your stream by using the button `Graylog access`{.action} located in the **...** menu of your stream, or head directly to the graylog access of your cluster. - Once in Graylog, Go in Stream Tab, click on your stream. In the top-left corner, chose a 1 Day range and click on the green button to search. - You should have some results like this: @@ -144,7 +145,7 @@ The last step is to create a dashboard displaying the results: - On the top right corner of the histogram, click on `Add to dashboard`{.action}. -Alright, you just created the first widget in you dashboard. Now, let's create a Pie chart: +Alright, you just created the first widget in your dashboard. Now, let's create a Pie chart: - On the left, click on the small blue triangle before "facility" - Click on "Quick Values" @@ -159,4 +160,4 @@ The best feature is the ability to mix criteria, based on what is important to y - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.pt-pt.md b/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.pt-pt.md index ea5fa70adf7..56865dae029 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.pt-pt.md +++ b/pages/manage_and_operate/observability/logs_data_platform/ingestion_syslog_ng/guide.pt-pt.md @@ -1,5 +1,6 @@ --- -title: Pushing logs with a forwarder - Syslog-ng 3.12.1+ (Linux) +title: "Pushing logs with a forwarder - Syslog-ng 3.12.1+ (Linux)" +excerpt: "Find out how to send logs from your Linux instance to Logs Data Platform" updated: 2024-03-08 --- @@ -106,13 +107,13 @@ log { source(s_src); rewrite(ovh-token); destination(ovhPaaSLogs); }; > > - Copy the **data-gathering tools certificate** from the manager Home page in SSL Configuration section, and paste it in file "/usr/local/share/ca-certificates/ldp.pem" > - Ensure the permission on this file is 644 -> +> > 
$ debian@server:~$ sudo chmod 644 /usr/share/ca-certificates/ldp.pem
-> +> > - Import this certificate to your system's trusted CA repository -> +> > 
$ debian@server:~$ sudo update-ca-certificates
-> +> Let's review this configuration. @@ -135,7 +136,7 @@ Let's recap: you have a Linux instance, and it's sending log locally and remotel The last step is to create a dashboard displaying the results: -- Connect to the Logs Data Platform manager, ensure you that you have a Stream and that the token in the syslog configuration file is OK. Ensure that you have a Dashboard created. +- Connect to the Logs Data Platform manager, ensure that you have a Stream and that the token in the syslog configuration file is OK. Ensure that you have a Dashboard created. - Head to your stream by using the button `Graylog access`{.action} located in the **...** menu of your stream, or head directly to the graylog access of your cluster. - Once in Graylog, Go in Stream Tab, click on your stream. In the top-left corner, chose a 1 Day range and click on the green button to search. - You should have some results like this: @@ -144,7 +145,7 @@ The last step is to create a dashboard displaying the results: - On the top right corner of the histogram, click on `Add to dashboard`{.action}. -Alright, you just created the first widget in you dashboard. Now, let's create a Pie chart: +Alright, you just created the first widget in your dashboard. Now, let's create a Pie chart: - On the left, click on the small blue triangle before "facility" - Click on "Quick Values" @@ -159,4 +160,4 @@ The best feature is the ability to mix criteria, based on what is important to y - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.de-de.md b/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.de-de.md index 316dc6af2c6..da16972d571 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.de-de.md +++ b/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.de-de.md @@ -1,14 +1,14 @@ --- title: Exposing your logs to third-party tools via the OpenSearch API excerpt: 'Leverage any software that can use the OpenSearch API with Logs Data Platform.' -updated: 2023-09-08 +updated: 2025-10-16 --- ## Objective -As explained in our [introductory documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_introduction_to_LDP), Logs Data Platform heavily relies on [OpenSearch](https://github.com/opensearch-project/OpenSearch) to work. +As explained in our [introductory documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_introduction_to_LDP), Logs Data Platform heavily relies on [OpenSearch](https://github.com/opensearch-project/OpenSearch) to work. -**This documentation will explain to you how you can use third-party software that integrate with OpenSearch.** +**This documentation will explain to you how you can use third-party software that integrates with OpenSearch.** ## Instructions @@ -50,7 +50,7 @@ In this section, you can: #### Third-party tool configuration -To connect to your alias as if it were an OpenSearch index, third-party tools usually require a few information: +To connect to your alias as if it were an OpenSearch index, third-party tools usually require some information: - A URL/Port: this is your cluster's URL, found on your Logs Data Platform account homepage under the "Access point" name in the "Configuration" section. The port is **9200** for OpenSearch. The resulting URL should be `https://.logs.ovh.com:9200`. - An index name. This is your alias name, found on the left column of your alias homepage like in the following picture. It should look like that: `-a-`. @@ -68,7 +68,7 @@ We currently have specific documentation illustrating the usage of *aliases* in - Using Grafana to visualize logs: [here](/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana). - Using ElastAlert to set up alerting on logs: [here](/pages/manage_and_operate/observability/logs_data_platform/alerting_elastalert). -### Alias for OpenSearch *indices* +### Alias for OpenSearch *indices* If you use a single [managed OpenSearch index as a service](/pages/manage_and_operate/observability/logs_data_platform/opensearch_index), the configuration of any third-party software is straightforward. However, as mentioned above, you can also attach multiple *indices* to an *alias*. In that case, the creation of an *alias* and configuration of your third-party software follow the same steps as described above. @@ -82,4 +82,4 @@ Like most features of Logs Data Platform, aliases can be shared with other Logs - [Getting Started with Logs Data Platform](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - [Our documentation](/products/public-cloud-data-platforms-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.en-asia.md b/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.en-asia.md index 316dc6af2c6..da16972d571 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.en-asia.md +++ b/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.en-asia.md @@ -1,14 +1,14 @@ --- title: Exposing your logs to third-party tools via the OpenSearch API excerpt: 'Leverage any software that can use the OpenSearch API with Logs Data Platform.' -updated: 2023-09-08 +updated: 2025-10-16 --- ## Objective -As explained in our [introductory documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_introduction_to_LDP), Logs Data Platform heavily relies on [OpenSearch](https://github.com/opensearch-project/OpenSearch) to work. +As explained in our [introductory documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_introduction_to_LDP), Logs Data Platform heavily relies on [OpenSearch](https://github.com/opensearch-project/OpenSearch) to work. -**This documentation will explain to you how you can use third-party software that integrate with OpenSearch.** +**This documentation will explain to you how you can use third-party software that integrates with OpenSearch.** ## Instructions @@ -50,7 +50,7 @@ In this section, you can: #### Third-party tool configuration -To connect to your alias as if it were an OpenSearch index, third-party tools usually require a few information: +To connect to your alias as if it were an OpenSearch index, third-party tools usually require some information: - A URL/Port: this is your cluster's URL, found on your Logs Data Platform account homepage under the "Access point" name in the "Configuration" section. The port is **9200** for OpenSearch. The resulting URL should be `https://.logs.ovh.com:9200`. - An index name. This is your alias name, found on the left column of your alias homepage like in the following picture. It should look like that: `-a-`. @@ -68,7 +68,7 @@ We currently have specific documentation illustrating the usage of *aliases* in - Using Grafana to visualize logs: [here](/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana). - Using ElastAlert to set up alerting on logs: [here](/pages/manage_and_operate/observability/logs_data_platform/alerting_elastalert). -### Alias for OpenSearch *indices* +### Alias for OpenSearch *indices* If you use a single [managed OpenSearch index as a service](/pages/manage_and_operate/observability/logs_data_platform/opensearch_index), the configuration of any third-party software is straightforward. However, as mentioned above, you can also attach multiple *indices* to an *alias*. In that case, the creation of an *alias* and configuration of your third-party software follow the same steps as described above. @@ -82,4 +82,4 @@ Like most features of Logs Data Platform, aliases can be shared with other Logs - [Getting Started with Logs Data Platform](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - [Our documentation](/products/public-cloud-data-platforms-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.en-au.md b/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.en-au.md index 316dc6af2c6..da16972d571 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.en-au.md +++ b/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.en-au.md @@ -1,14 +1,14 @@ --- title: Exposing your logs to third-party tools via the OpenSearch API excerpt: 'Leverage any software that can use the OpenSearch API with Logs Data Platform.' -updated: 2023-09-08 +updated: 2025-10-16 --- ## Objective -As explained in our [introductory documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_introduction_to_LDP), Logs Data Platform heavily relies on [OpenSearch](https://github.com/opensearch-project/OpenSearch) to work. +As explained in our [introductory documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_introduction_to_LDP), Logs Data Platform heavily relies on [OpenSearch](https://github.com/opensearch-project/OpenSearch) to work. -**This documentation will explain to you how you can use third-party software that integrate with OpenSearch.** +**This documentation will explain to you how you can use third-party software that integrates with OpenSearch.** ## Instructions @@ -50,7 +50,7 @@ In this section, you can: #### Third-party tool configuration -To connect to your alias as if it were an OpenSearch index, third-party tools usually require a few information: +To connect to your alias as if it were an OpenSearch index, third-party tools usually require some information: - A URL/Port: this is your cluster's URL, found on your Logs Data Platform account homepage under the "Access point" name in the "Configuration" section. The port is **9200** for OpenSearch. The resulting URL should be `https://.logs.ovh.com:9200`. - An index name. This is your alias name, found on the left column of your alias homepage like in the following picture. It should look like that: `-a-`. @@ -68,7 +68,7 @@ We currently have specific documentation illustrating the usage of *aliases* in - Using Grafana to visualize logs: [here](/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana). - Using ElastAlert to set up alerting on logs: [here](/pages/manage_and_operate/observability/logs_data_platform/alerting_elastalert). -### Alias for OpenSearch *indices* +### Alias for OpenSearch *indices* If you use a single [managed OpenSearch index as a service](/pages/manage_and_operate/observability/logs_data_platform/opensearch_index), the configuration of any third-party software is straightforward. However, as mentioned above, you can also attach multiple *indices* to an *alias*. In that case, the creation of an *alias* and configuration of your third-party software follow the same steps as described above. @@ -82,4 +82,4 @@ Like most features of Logs Data Platform, aliases can be shared with other Logs - [Getting Started with Logs Data Platform](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - [Our documentation](/products/public-cloud-data-platforms-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.en-ca.md b/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.en-ca.md index 316dc6af2c6..da16972d571 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.en-ca.md +++ b/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.en-ca.md @@ -1,14 +1,14 @@ --- title: Exposing your logs to third-party tools via the OpenSearch API excerpt: 'Leverage any software that can use the OpenSearch API with Logs Data Platform.' -updated: 2023-09-08 +updated: 2025-10-16 --- ## Objective -As explained in our [introductory documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_introduction_to_LDP), Logs Data Platform heavily relies on [OpenSearch](https://github.com/opensearch-project/OpenSearch) to work. +As explained in our [introductory documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_introduction_to_LDP), Logs Data Platform heavily relies on [OpenSearch](https://github.com/opensearch-project/OpenSearch) to work. -**This documentation will explain to you how you can use third-party software that integrate with OpenSearch.** +**This documentation will explain to you how you can use third-party software that integrates with OpenSearch.** ## Instructions @@ -50,7 +50,7 @@ In this section, you can: #### Third-party tool configuration -To connect to your alias as if it were an OpenSearch index, third-party tools usually require a few information: +To connect to your alias as if it were an OpenSearch index, third-party tools usually require some information: - A URL/Port: this is your cluster's URL, found on your Logs Data Platform account homepage under the "Access point" name in the "Configuration" section. The port is **9200** for OpenSearch. The resulting URL should be `https://.logs.ovh.com:9200`. - An index name. This is your alias name, found on the left column of your alias homepage like in the following picture. It should look like that: `-a-`. @@ -68,7 +68,7 @@ We currently have specific documentation illustrating the usage of *aliases* in - Using Grafana to visualize logs: [here](/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana). - Using ElastAlert to set up alerting on logs: [here](/pages/manage_and_operate/observability/logs_data_platform/alerting_elastalert). -### Alias for OpenSearch *indices* +### Alias for OpenSearch *indices* If you use a single [managed OpenSearch index as a service](/pages/manage_and_operate/observability/logs_data_platform/opensearch_index), the configuration of any third-party software is straightforward. However, as mentioned above, you can also attach multiple *indices* to an *alias*. In that case, the creation of an *alias* and configuration of your third-party software follow the same steps as described above. @@ -82,4 +82,4 @@ Like most features of Logs Data Platform, aliases can be shared with other Logs - [Getting Started with Logs Data Platform](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - [Our documentation](/products/public-cloud-data-platforms-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.en-gb.md b/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.en-gb.md index 846d4325539..da16972d571 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.en-gb.md +++ b/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.en-gb.md @@ -1,12 +1,12 @@ --- title: Exposing your logs to third-party tools via the OpenSearch API excerpt: 'Leverage any software that can use the OpenSearch API with Logs Data Platform.' -updated: 2023-09-08 +updated: 2025-10-16 --- ## Objective -As explained in our [introductory documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_introduction_to_LDP), Logs Data Platform heavily relies on [OpenSearch](https://github.com/opensearch-project/OpenSearch) to work. +As explained in our [introductory documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_introduction_to_LDP), Logs Data Platform heavily relies on [OpenSearch](https://github.com/opensearch-project/OpenSearch) to work. **This documentation will explain to you how you can use third-party software that integrates with OpenSearch.** @@ -68,7 +68,7 @@ We currently have specific documentation illustrating the usage of *aliases* in - Using Grafana to visualize logs: [here](/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana). - Using ElastAlert to set up alerting on logs: [here](/pages/manage_and_operate/observability/logs_data_platform/alerting_elastalert). -### Alias for OpenSearch *indices* +### Alias for OpenSearch *indices* If you use a single [managed OpenSearch index as a service](/pages/manage_and_operate/observability/logs_data_platform/opensearch_index), the configuration of any third-party software is straightforward. However, as mentioned above, you can also attach multiple *indices* to an *alias*. In that case, the creation of an *alias* and configuration of your third-party software follow the same steps as described above. @@ -82,4 +82,4 @@ Like most features of Logs Data Platform, aliases can be shared with other Logs - [Getting Started with Logs Data Platform](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - [Our documentation](/products/public-cloud-data-platforms-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.en-ie.md b/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.en-ie.md index 316dc6af2c6..da16972d571 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.en-ie.md +++ b/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.en-ie.md @@ -1,14 +1,14 @@ --- title: Exposing your logs to third-party tools via the OpenSearch API excerpt: 'Leverage any software that can use the OpenSearch API with Logs Data Platform.' -updated: 2023-09-08 +updated: 2025-10-16 --- ## Objective -As explained in our [introductory documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_introduction_to_LDP), Logs Data Platform heavily relies on [OpenSearch](https://github.com/opensearch-project/OpenSearch) to work. +As explained in our [introductory documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_introduction_to_LDP), Logs Data Platform heavily relies on [OpenSearch](https://github.com/opensearch-project/OpenSearch) to work. -**This documentation will explain to you how you can use third-party software that integrate with OpenSearch.** +**This documentation will explain to you how you can use third-party software that integrates with OpenSearch.** ## Instructions @@ -50,7 +50,7 @@ In this section, you can: #### Third-party tool configuration -To connect to your alias as if it were an OpenSearch index, third-party tools usually require a few information: +To connect to your alias as if it were an OpenSearch index, third-party tools usually require some information: - A URL/Port: this is your cluster's URL, found on your Logs Data Platform account homepage under the "Access point" name in the "Configuration" section. The port is **9200** for OpenSearch. The resulting URL should be `https://.logs.ovh.com:9200`. - An index name. This is your alias name, found on the left column of your alias homepage like in the following picture. It should look like that: `-a-`. @@ -68,7 +68,7 @@ We currently have specific documentation illustrating the usage of *aliases* in - Using Grafana to visualize logs: [here](/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana). - Using ElastAlert to set up alerting on logs: [here](/pages/manage_and_operate/observability/logs_data_platform/alerting_elastalert). -### Alias for OpenSearch *indices* +### Alias for OpenSearch *indices* If you use a single [managed OpenSearch index as a service](/pages/manage_and_operate/observability/logs_data_platform/opensearch_index), the configuration of any third-party software is straightforward. However, as mentioned above, you can also attach multiple *indices* to an *alias*. In that case, the creation of an *alias* and configuration of your third-party software follow the same steps as described above. @@ -82,4 +82,4 @@ Like most features of Logs Data Platform, aliases can be shared with other Logs - [Getting Started with Logs Data Platform](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - [Our documentation](/products/public-cloud-data-platforms-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.en-sg.md b/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.en-sg.md index 316dc6af2c6..da16972d571 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.en-sg.md +++ b/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.en-sg.md @@ -1,14 +1,14 @@ --- title: Exposing your logs to third-party tools via the OpenSearch API excerpt: 'Leverage any software that can use the OpenSearch API with Logs Data Platform.' -updated: 2023-09-08 +updated: 2025-10-16 --- ## Objective -As explained in our [introductory documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_introduction_to_LDP), Logs Data Platform heavily relies on [OpenSearch](https://github.com/opensearch-project/OpenSearch) to work. +As explained in our [introductory documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_introduction_to_LDP), Logs Data Platform heavily relies on [OpenSearch](https://github.com/opensearch-project/OpenSearch) to work. -**This documentation will explain to you how you can use third-party software that integrate with OpenSearch.** +**This documentation will explain to you how you can use third-party software that integrates with OpenSearch.** ## Instructions @@ -50,7 +50,7 @@ In this section, you can: #### Third-party tool configuration -To connect to your alias as if it were an OpenSearch index, third-party tools usually require a few information: +To connect to your alias as if it were an OpenSearch index, third-party tools usually require some information: - A URL/Port: this is your cluster's URL, found on your Logs Data Platform account homepage under the "Access point" name in the "Configuration" section. The port is **9200** for OpenSearch. The resulting URL should be `https://.logs.ovh.com:9200`. - An index name. This is your alias name, found on the left column of your alias homepage like in the following picture. It should look like that: `-a-`. @@ -68,7 +68,7 @@ We currently have specific documentation illustrating the usage of *aliases* in - Using Grafana to visualize logs: [here](/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana). - Using ElastAlert to set up alerting on logs: [here](/pages/manage_and_operate/observability/logs_data_platform/alerting_elastalert). -### Alias for OpenSearch *indices* +### Alias for OpenSearch *indices* If you use a single [managed OpenSearch index as a service](/pages/manage_and_operate/observability/logs_data_platform/opensearch_index), the configuration of any third-party software is straightforward. However, as mentioned above, you can also attach multiple *indices* to an *alias*. In that case, the creation of an *alias* and configuration of your third-party software follow the same steps as described above. @@ -82,4 +82,4 @@ Like most features of Logs Data Platform, aliases can be shared with other Logs - [Getting Started with Logs Data Platform](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - [Our documentation](/products/public-cloud-data-platforms-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.en-us.md b/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.en-us.md index 316dc6af2c6..da16972d571 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.en-us.md +++ b/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.en-us.md @@ -1,14 +1,14 @@ --- title: Exposing your logs to third-party tools via the OpenSearch API excerpt: 'Leverage any software that can use the OpenSearch API with Logs Data Platform.' -updated: 2023-09-08 +updated: 2025-10-16 --- ## Objective -As explained in our [introductory documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_introduction_to_LDP), Logs Data Platform heavily relies on [OpenSearch](https://github.com/opensearch-project/OpenSearch) to work. +As explained in our [introductory documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_introduction_to_LDP), Logs Data Platform heavily relies on [OpenSearch](https://github.com/opensearch-project/OpenSearch) to work. -**This documentation will explain to you how you can use third-party software that integrate with OpenSearch.** +**This documentation will explain to you how you can use third-party software that integrates with OpenSearch.** ## Instructions @@ -50,7 +50,7 @@ In this section, you can: #### Third-party tool configuration -To connect to your alias as if it were an OpenSearch index, third-party tools usually require a few information: +To connect to your alias as if it were an OpenSearch index, third-party tools usually require some information: - A URL/Port: this is your cluster's URL, found on your Logs Data Platform account homepage under the "Access point" name in the "Configuration" section. The port is **9200** for OpenSearch. The resulting URL should be `https://.logs.ovh.com:9200`. - An index name. This is your alias name, found on the left column of your alias homepage like in the following picture. It should look like that: `-a-`. @@ -68,7 +68,7 @@ We currently have specific documentation illustrating the usage of *aliases* in - Using Grafana to visualize logs: [here](/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana). - Using ElastAlert to set up alerting on logs: [here](/pages/manage_and_operate/observability/logs_data_platform/alerting_elastalert). -### Alias for OpenSearch *indices* +### Alias for OpenSearch *indices* If you use a single [managed OpenSearch index as a service](/pages/manage_and_operate/observability/logs_data_platform/opensearch_index), the configuration of any third-party software is straightforward. However, as mentioned above, you can also attach multiple *indices* to an *alias*. In that case, the creation of an *alias* and configuration of your third-party software follow the same steps as described above. @@ -82,4 +82,4 @@ Like most features of Logs Data Platform, aliases can be shared with other Logs - [Getting Started with Logs Data Platform](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - [Our documentation](/products/public-cloud-data-platforms-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.es-es.md b/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.es-es.md index 316dc6af2c6..da16972d571 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.es-es.md +++ b/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.es-es.md @@ -1,14 +1,14 @@ --- title: Exposing your logs to third-party tools via the OpenSearch API excerpt: 'Leverage any software that can use the OpenSearch API with Logs Data Platform.' -updated: 2023-09-08 +updated: 2025-10-16 --- ## Objective -As explained in our [introductory documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_introduction_to_LDP), Logs Data Platform heavily relies on [OpenSearch](https://github.com/opensearch-project/OpenSearch) to work. +As explained in our [introductory documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_introduction_to_LDP), Logs Data Platform heavily relies on [OpenSearch](https://github.com/opensearch-project/OpenSearch) to work. -**This documentation will explain to you how you can use third-party software that integrate with OpenSearch.** +**This documentation will explain to you how you can use third-party software that integrates with OpenSearch.** ## Instructions @@ -50,7 +50,7 @@ In this section, you can: #### Third-party tool configuration -To connect to your alias as if it were an OpenSearch index, third-party tools usually require a few information: +To connect to your alias as if it were an OpenSearch index, third-party tools usually require some information: - A URL/Port: this is your cluster's URL, found on your Logs Data Platform account homepage under the "Access point" name in the "Configuration" section. The port is **9200** for OpenSearch. The resulting URL should be `https://.logs.ovh.com:9200`. - An index name. This is your alias name, found on the left column of your alias homepage like in the following picture. It should look like that: `-a-`. @@ -68,7 +68,7 @@ We currently have specific documentation illustrating the usage of *aliases* in - Using Grafana to visualize logs: [here](/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana). - Using ElastAlert to set up alerting on logs: [here](/pages/manage_and_operate/observability/logs_data_platform/alerting_elastalert). -### Alias for OpenSearch *indices* +### Alias for OpenSearch *indices* If you use a single [managed OpenSearch index as a service](/pages/manage_and_operate/observability/logs_data_platform/opensearch_index), the configuration of any third-party software is straightforward. However, as mentioned above, you can also attach multiple *indices* to an *alias*. In that case, the creation of an *alias* and configuration of your third-party software follow the same steps as described above. @@ -82,4 +82,4 @@ Like most features of Logs Data Platform, aliases can be shared with other Logs - [Getting Started with Logs Data Platform](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - [Our documentation](/products/public-cloud-data-platforms-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.es-us.md b/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.es-us.md index 316dc6af2c6..da16972d571 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.es-us.md +++ b/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.es-us.md @@ -1,14 +1,14 @@ --- title: Exposing your logs to third-party tools via the OpenSearch API excerpt: 'Leverage any software that can use the OpenSearch API with Logs Data Platform.' -updated: 2023-09-08 +updated: 2025-10-16 --- ## Objective -As explained in our [introductory documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_introduction_to_LDP), Logs Data Platform heavily relies on [OpenSearch](https://github.com/opensearch-project/OpenSearch) to work. +As explained in our [introductory documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_introduction_to_LDP), Logs Data Platform heavily relies on [OpenSearch](https://github.com/opensearch-project/OpenSearch) to work. -**This documentation will explain to you how you can use third-party software that integrate with OpenSearch.** +**This documentation will explain to you how you can use third-party software that integrates with OpenSearch.** ## Instructions @@ -50,7 +50,7 @@ In this section, you can: #### Third-party tool configuration -To connect to your alias as if it were an OpenSearch index, third-party tools usually require a few information: +To connect to your alias as if it were an OpenSearch index, third-party tools usually require some information: - A URL/Port: this is your cluster's URL, found on your Logs Data Platform account homepage under the "Access point" name in the "Configuration" section. The port is **9200** for OpenSearch. The resulting URL should be `https://.logs.ovh.com:9200`. - An index name. This is your alias name, found on the left column of your alias homepage like in the following picture. It should look like that: `-a-`. @@ -68,7 +68,7 @@ We currently have specific documentation illustrating the usage of *aliases* in - Using Grafana to visualize logs: [here](/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana). - Using ElastAlert to set up alerting on logs: [here](/pages/manage_and_operate/observability/logs_data_platform/alerting_elastalert). -### Alias for OpenSearch *indices* +### Alias for OpenSearch *indices* If you use a single [managed OpenSearch index as a service](/pages/manage_and_operate/observability/logs_data_platform/opensearch_index), the configuration of any third-party software is straightforward. However, as mentioned above, you can also attach multiple *indices* to an *alias*. In that case, the creation of an *alias* and configuration of your third-party software follow the same steps as described above. @@ -82,4 +82,4 @@ Like most features of Logs Data Platform, aliases can be shared with other Logs - [Getting Started with Logs Data Platform](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - [Our documentation](/products/public-cloud-data-platforms-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.fr-ca.md b/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.fr-ca.md index 316dc6af2c6..da16972d571 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.fr-ca.md +++ b/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.fr-ca.md @@ -1,14 +1,14 @@ --- title: Exposing your logs to third-party tools via the OpenSearch API excerpt: 'Leverage any software that can use the OpenSearch API with Logs Data Platform.' -updated: 2023-09-08 +updated: 2025-10-16 --- ## Objective -As explained in our [introductory documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_introduction_to_LDP), Logs Data Platform heavily relies on [OpenSearch](https://github.com/opensearch-project/OpenSearch) to work. +As explained in our [introductory documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_introduction_to_LDP), Logs Data Platform heavily relies on [OpenSearch](https://github.com/opensearch-project/OpenSearch) to work. -**This documentation will explain to you how you can use third-party software that integrate with OpenSearch.** +**This documentation will explain to you how you can use third-party software that integrates with OpenSearch.** ## Instructions @@ -50,7 +50,7 @@ In this section, you can: #### Third-party tool configuration -To connect to your alias as if it were an OpenSearch index, third-party tools usually require a few information: +To connect to your alias as if it were an OpenSearch index, third-party tools usually require some information: - A URL/Port: this is your cluster's URL, found on your Logs Data Platform account homepage under the "Access point" name in the "Configuration" section. The port is **9200** for OpenSearch. The resulting URL should be `https://.logs.ovh.com:9200`. - An index name. This is your alias name, found on the left column of your alias homepage like in the following picture. It should look like that: `-a-`. @@ -68,7 +68,7 @@ We currently have specific documentation illustrating the usage of *aliases* in - Using Grafana to visualize logs: [here](/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana). - Using ElastAlert to set up alerting on logs: [here](/pages/manage_and_operate/observability/logs_data_platform/alerting_elastalert). -### Alias for OpenSearch *indices* +### Alias for OpenSearch *indices* If you use a single [managed OpenSearch index as a service](/pages/manage_and_operate/observability/logs_data_platform/opensearch_index), the configuration of any third-party software is straightforward. However, as mentioned above, you can also attach multiple *indices* to an *alias*. In that case, the creation of an *alias* and configuration of your third-party software follow the same steps as described above. @@ -82,4 +82,4 @@ Like most features of Logs Data Platform, aliases can be shared with other Logs - [Getting Started with Logs Data Platform](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - [Our documentation](/products/public-cloud-data-platforms-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.fr-fr.md b/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.fr-fr.md index 316dc6af2c6..da16972d571 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.fr-fr.md +++ b/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.fr-fr.md @@ -1,14 +1,14 @@ --- title: Exposing your logs to third-party tools via the OpenSearch API excerpt: 'Leverage any software that can use the OpenSearch API with Logs Data Platform.' -updated: 2023-09-08 +updated: 2025-10-16 --- ## Objective -As explained in our [introductory documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_introduction_to_LDP), Logs Data Platform heavily relies on [OpenSearch](https://github.com/opensearch-project/OpenSearch) to work. +As explained in our [introductory documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_introduction_to_LDP), Logs Data Platform heavily relies on [OpenSearch](https://github.com/opensearch-project/OpenSearch) to work. -**This documentation will explain to you how you can use third-party software that integrate with OpenSearch.** +**This documentation will explain to you how you can use third-party software that integrates with OpenSearch.** ## Instructions @@ -50,7 +50,7 @@ In this section, you can: #### Third-party tool configuration -To connect to your alias as if it were an OpenSearch index, third-party tools usually require a few information: +To connect to your alias as if it were an OpenSearch index, third-party tools usually require some information: - A URL/Port: this is your cluster's URL, found on your Logs Data Platform account homepage under the "Access point" name in the "Configuration" section. The port is **9200** for OpenSearch. The resulting URL should be `https://.logs.ovh.com:9200`. - An index name. This is your alias name, found on the left column of your alias homepage like in the following picture. It should look like that: `-a-`. @@ -68,7 +68,7 @@ We currently have specific documentation illustrating the usage of *aliases* in - Using Grafana to visualize logs: [here](/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana). - Using ElastAlert to set up alerting on logs: [here](/pages/manage_and_operate/observability/logs_data_platform/alerting_elastalert). -### Alias for OpenSearch *indices* +### Alias for OpenSearch *indices* If you use a single [managed OpenSearch index as a service](/pages/manage_and_operate/observability/logs_data_platform/opensearch_index), the configuration of any third-party software is straightforward. However, as mentioned above, you can also attach multiple *indices* to an *alias*. In that case, the creation of an *alias* and configuration of your third-party software follow the same steps as described above. @@ -82,4 +82,4 @@ Like most features of Logs Data Platform, aliases can be shared with other Logs - [Getting Started with Logs Data Platform](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - [Our documentation](/products/public-cloud-data-platforms-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.it-it.md b/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.it-it.md index 316dc6af2c6..da16972d571 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.it-it.md +++ b/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.it-it.md @@ -1,14 +1,14 @@ --- title: Exposing your logs to third-party tools via the OpenSearch API excerpt: 'Leverage any software that can use the OpenSearch API with Logs Data Platform.' -updated: 2023-09-08 +updated: 2025-10-16 --- ## Objective -As explained in our [introductory documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_introduction_to_LDP), Logs Data Platform heavily relies on [OpenSearch](https://github.com/opensearch-project/OpenSearch) to work. +As explained in our [introductory documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_introduction_to_LDP), Logs Data Platform heavily relies on [OpenSearch](https://github.com/opensearch-project/OpenSearch) to work. -**This documentation will explain to you how you can use third-party software that integrate with OpenSearch.** +**This documentation will explain to you how you can use third-party software that integrates with OpenSearch.** ## Instructions @@ -50,7 +50,7 @@ In this section, you can: #### Third-party tool configuration -To connect to your alias as if it were an OpenSearch index, third-party tools usually require a few information: +To connect to your alias as if it were an OpenSearch index, third-party tools usually require some information: - A URL/Port: this is your cluster's URL, found on your Logs Data Platform account homepage under the "Access point" name in the "Configuration" section. The port is **9200** for OpenSearch. The resulting URL should be `https://.logs.ovh.com:9200`. - An index name. This is your alias name, found on the left column of your alias homepage like in the following picture. It should look like that: `-a-`. @@ -68,7 +68,7 @@ We currently have specific documentation illustrating the usage of *aliases* in - Using Grafana to visualize logs: [here](/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana). - Using ElastAlert to set up alerting on logs: [here](/pages/manage_and_operate/observability/logs_data_platform/alerting_elastalert). -### Alias for OpenSearch *indices* +### Alias for OpenSearch *indices* If you use a single [managed OpenSearch index as a service](/pages/manage_and_operate/observability/logs_data_platform/opensearch_index), the configuration of any third-party software is straightforward. However, as mentioned above, you can also attach multiple *indices* to an *alias*. In that case, the creation of an *alias* and configuration of your third-party software follow the same steps as described above. @@ -82,4 +82,4 @@ Like most features of Logs Data Platform, aliases can be shared with other Logs - [Getting Started with Logs Data Platform](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - [Our documentation](/products/public-cloud-data-platforms-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.pl-pl.md b/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.pl-pl.md index 316dc6af2c6..da16972d571 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.pl-pl.md +++ b/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.pl-pl.md @@ -1,14 +1,14 @@ --- title: Exposing your logs to third-party tools via the OpenSearch API excerpt: 'Leverage any software that can use the OpenSearch API with Logs Data Platform.' -updated: 2023-09-08 +updated: 2025-10-16 --- ## Objective -As explained in our [introductory documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_introduction_to_LDP), Logs Data Platform heavily relies on [OpenSearch](https://github.com/opensearch-project/OpenSearch) to work. +As explained in our [introductory documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_introduction_to_LDP), Logs Data Platform heavily relies on [OpenSearch](https://github.com/opensearch-project/OpenSearch) to work. -**This documentation will explain to you how you can use third-party software that integrate with OpenSearch.** +**This documentation will explain to you how you can use third-party software that integrates with OpenSearch.** ## Instructions @@ -50,7 +50,7 @@ In this section, you can: #### Third-party tool configuration -To connect to your alias as if it were an OpenSearch index, third-party tools usually require a few information: +To connect to your alias as if it were an OpenSearch index, third-party tools usually require some information: - A URL/Port: this is your cluster's URL, found on your Logs Data Platform account homepage under the "Access point" name in the "Configuration" section. The port is **9200** for OpenSearch. The resulting URL should be `https://.logs.ovh.com:9200`. - An index name. This is your alias name, found on the left column of your alias homepage like in the following picture. It should look like that: `-a-`. @@ -68,7 +68,7 @@ We currently have specific documentation illustrating the usage of *aliases* in - Using Grafana to visualize logs: [here](/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana). - Using ElastAlert to set up alerting on logs: [here](/pages/manage_and_operate/observability/logs_data_platform/alerting_elastalert). -### Alias for OpenSearch *indices* +### Alias for OpenSearch *indices* If you use a single [managed OpenSearch index as a service](/pages/manage_and_operate/observability/logs_data_platform/opensearch_index), the configuration of any third-party software is straightforward. However, as mentioned above, you can also attach multiple *indices* to an *alias*. In that case, the creation of an *alias* and configuration of your third-party software follow the same steps as described above. @@ -82,4 +82,4 @@ Like most features of Logs Data Platform, aliases can be shared with other Logs - [Getting Started with Logs Data Platform](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - [Our documentation](/products/public-cloud-data-platforms-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.pt-pt.md b/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.pt-pt.md index 316dc6af2c6..da16972d571 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.pt-pt.md +++ b/pages/manage_and_operate/observability/logs_data_platform/integration_opensearch_api/guide.pt-pt.md @@ -1,14 +1,14 @@ --- title: Exposing your logs to third-party tools via the OpenSearch API excerpt: 'Leverage any software that can use the OpenSearch API with Logs Data Platform.' -updated: 2023-09-08 +updated: 2025-10-16 --- ## Objective -As explained in our [introductory documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_introduction_to_LDP), Logs Data Platform heavily relies on [OpenSearch](https://github.com/opensearch-project/OpenSearch) to work. +As explained in our [introductory documentation](/pages/manage_and_operate/observability/logs_data_platform/getting_started_introduction_to_LDP), Logs Data Platform heavily relies on [OpenSearch](https://github.com/opensearch-project/OpenSearch) to work. -**This documentation will explain to you how you can use third-party software that integrate with OpenSearch.** +**This documentation will explain to you how you can use third-party software that integrates with OpenSearch.** ## Instructions @@ -50,7 +50,7 @@ In this section, you can: #### Third-party tool configuration -To connect to your alias as if it were an OpenSearch index, third-party tools usually require a few information: +To connect to your alias as if it were an OpenSearch index, third-party tools usually require some information: - A URL/Port: this is your cluster's URL, found on your Logs Data Platform account homepage under the "Access point" name in the "Configuration" section. The port is **9200** for OpenSearch. The resulting URL should be `https://.logs.ovh.com:9200`. - An index name. This is your alias name, found on the left column of your alias homepage like in the following picture. It should look like that: `-a-`. @@ -68,7 +68,7 @@ We currently have specific documentation illustrating the usage of *aliases* in - Using Grafana to visualize logs: [here](/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana). - Using ElastAlert to set up alerting on logs: [here](/pages/manage_and_operate/observability/logs_data_platform/alerting_elastalert). -### Alias for OpenSearch *indices* +### Alias for OpenSearch *indices* If you use a single [managed OpenSearch index as a service](/pages/manage_and_operate/observability/logs_data_platform/opensearch_index), the configuration of any third-party software is straightforward. However, as mentioned above, you can also attach multiple *indices* to an *alias*. In that case, the creation of an *alias* and configuration of your third-party software follow the same steps as described above. @@ -82,4 +82,4 @@ Like most features of Logs Data Platform, aliases can be shared with other Logs - [Getting Started with Logs Data Platform](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - [Our documentation](/products/public-cloud-data-platforms-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/introduction_to_services_logs/guide.en-gb.md b/pages/manage_and_operate/observability/logs_data_platform/introduction_to_services_logs/guide.en-gb.md index c559ff930e4..c58ad6d0b87 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/introduction_to_services_logs/guide.en-gb.md +++ b/pages/manage_and_operate/observability/logs_data_platform/introduction_to_services_logs/guide.en-gb.md @@ -1,7 +1,7 @@ --- title: Introduction to OVHcloud Service Logs with Logs Data Platform excerpt: Discover how to retrieve your OVHcloud managed products logs in Logs Data Platform -updated: 2025-09-04 +updated: 2025-12-02 --- ## Objective @@ -50,19 +50,21 @@ Our ambition is to make all OVHcloud products compatible with OVHcloud Service L | Product name | Availability | Status | Guide link | | :----------- | :----------- | :----: | :--------- | -| Security & Identity - OVHcloud Account - Activity | API only | Beta | [Generating OVHcloud account logs with Logs Data Platform](/pages/manage_and_operate/iam/iam-logs-forwarding) | -| Security & Identity - OVHcloud Account - Audit | API only | Beta | [Generating OVHcloud account logs with Logs Data Platform](/pages/manage_and_operate/iam/iam-logs-forwarding) | +| Security & Identity - OVHcloud Account - Activity | OVHcloud Control Panel & API | Beta | [Generating OVHcloud account logs with Logs Data Platform](/pages/manage_and_operate/iam/iam-logs-forwarding) | +| Security & Identity - OVHcloud Account - Audit | OVHcloud Control Panel & API | Beta | [Generating OVHcloud account logs with Logs Data Platform](/pages/manage_and_operate/iam/iam-logs-forwarding) | | Security & Identity - OVHcloud Account - IAM | OVHcloud Control Panel & API | Beta | [Generating OVHcloud account logs with Logs Data Platform](/pages/manage_and_operate/iam/iam-logs-forwarding) | | Security & Identity - Key Management Service | OVHcloud Control Panel & API | Beta | [Pushing logs from OVHcloud KMS to Logs Data Platform](/pages/manage_and_operate/kms/kms-troubleshooting) | | Public Cloud - Managed Kubernetes Service | OVHcloud Control Panel & API | Beta | [Managed Kubernetes Service Audit Logs Forwarding](/pages/public_cloud/containers_orchestration/managed_kubernetes/forwarding-audit-logs-to-logs-data-platform) | | Public Cloud - Load Balancer | OVHcloud Control Panel & API | Beta | [Public Cloud Load Balancer TCP / HTTP / HTTPS Logs Forwarding](/pages/public_cloud/public_cloud_network_services/technical-resources-05-lb_logs_2_customers) | | Public Cloud - Managed Databases | OVHcloud Control Panel & API | Beta | [Public Cloud Databases - How to setup logs forwarding](/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer) | -| Hosted Private Cloud - Managed VMware vSphere | API only | Beta | - | +| Hosted Private Cloud - Managed VMware vSphere | OVHcloud Control Panel & API | Beta | - | | Hosting & Collaboration - Web Cloud Databases | OVHcloud Control Panel & API | Beta | [Web Cloud Databases - How to manage logs](/pages/web_cloud/web_cloud_databases/retrieve-logs) | -| Hosting & Collaboration - Microsoft Private Exchange | API only | Beta | - | -| Hosting & Collaboration - Microsoft Trusted Exchange | API only | Beta | - | +| Hosting & Collaboration - Microsoft Private Exchange | OVHcloud Control Panel & API | Beta | [Exchange - How to manage logs](/pages/web_cloud/email_and_collaborative_solutions/microsoft_exchange/exchange_manage_logs) | +| Hosting & Collaboration - Microsoft Trusted Exchange | OVHcloud Control Panel & API | Beta | [Exchange - How to manage logs](/pages/web_cloud/email_and_collaborative_solutions/microsoft_exchange/exchange_manage_logs) | | Infrastructure solutions - OVHcloud Connect | OVHcloud Control Panel & API | Beta | [OVHcloud Connect Logs Forwarding](/pages/network/ovhcloud_connect/occ-logs-2-customers) | -| Infrastructure solutions - OVHcloud Load Balancer | API only | Beta | [OVHcloud Load Balancer TCP / HTTP / HTTPS Logs Forwarding](/pages/network/load_balancer/use_api_logs_2_customers) | +| Infrastructure solutions - OVHcloud Load Balancer | OVHcloud Control Panel & API | Beta | [OVHcloud Load Balancer TCP / HTTP / HTTPS Logs Forwarding](/pages/network/load_balancer/use_api_logs_2_customers) | +| Telecom - Internet Access | API only | Beta | - | +| Telecom - OverTheBox | API only | Beta | - | ## Instructions diff --git a/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.de-de.md b/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.de-de.md index 59deae3fe93..78216c98ff6 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.de-de.md +++ b/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.de-de.md @@ -1,25 +1,25 @@ --- title: OpenSearch Index as a Service excerpt: Use the power of OpenSearch without managing a cluster. -updated: 2024-08-07 +updated: 2025-10-16 --- ## Objective -OpenSearch is one of the main components of the Logs Data Platform, regarded as one of the most powerful search and analytics engines. From the outset we offered the possibility to host an OpenSearch Dashboards index for your OpenSearch Dashboards metadata, Index As A Service being the next step to this functionality. You can now use a fully unlocked index for almost any purpose; be it complex documents, reports or even logs. Thanks to the OpenSearch API, you will be able to use most of the tools of the OpenSearch Ecosystem. +OpenSearch is one of the main components of the Logs Data Platform, regarded as one of the most powerful search and analytics engines. From the outset we offered the possibility to host an OpenSearch Dashboards index for your OpenSearch Dashboards metadata. Index As A Service is the next step. You can now use a fully unlocked index for almost any purpose; be it complex documents, reports or even logs. Thanks to the OpenSearch API, you will be able to use most of the tools of the OpenSearch Ecosystem. ## Requirements This is what you need to know to get you started: - You have created a [Logs Data Platform account](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- You have access to the port 9200 of your cluster (head to the **Home** page in manager to know the address of your cluster). +- You have access to the port 9200 of your cluster (go to the **Home** page in manager to know the address of your cluster). ## Instructions ### First steps with an OpenSearch index -#### Create an index +#### Index name conventions There are two ways to create an OpenSearch Index: @@ -30,36 +30,108 @@ To create an OpenSearch index with the Logs Data Platform manager, you need to g ![add index option](images/add_index.png){.thumbnail} -You must just choose a suffix for your index. The final name will follow this convention: +Simply choose a suffix for your index. The final name will follow this convention: -`logs--i-`. +`-i-`. -For each index, you can specify the number of **shards**. A **shard** is the main component of an **index**. Its maximum storage capacity is set to **25 GB** (per shard). Multiple shards means more volume, more parallelism in your requests and thus more performance. Optionally, you can also be notified when your index is close to its critical size. Once your index is created, you can use it right away. +The service name is the identifier of your Logs Data Platform service. It is different from the username used by non IAM users. The service name starts with `ldp` (e.g. `ldp-ab-12345`). On the other hand, the username starts with `logs` (e.g. `logs-ab-12345`). In this guide we will use **** or **** as tags to let you differentiate both usages. You can find both pieces of information in the **Logs Data Platform control panel**. -When you create an index through the [OpenSearch API](https://opensearch.org/docs/latest/opensearch/index-data/), you can also specify the number of shards. Note that the maximum number of shards by index is limited to **16**. OpenSearch compatible tools can now create indices on the cluster as long as they follow the naming convention `logs--i-`. Here is an example with a curl command with the user **logs-ab-12345** and the index **logs-ab-12345-i-another-index** on gra2 cluster. +> [!primary] +> +> Prior to IAM migration the prefix was . It has now been changed to for all indices created after 17 September 2025. +> -```shell-session -$ curl -u logs-ab-12345:mypassword -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/logs-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 1}}' +For each index, you can specify the number of **shards**. A **shard** is the main component of an **index**. Its maximum storage capacity is set to **25 GB** (per shard). Multiple shards mean more volume, more parallelism in your requests and thus more performance. Optionally, you can also be notified when your index is close to its critical size. Once your index is created, you can use it right away. + +When you create an index through the [OpenSearch API](https://opensearch.org/docs/latest/opensearch/index-data/), you can also specify the number of shards. Note that the maximum number of shards per index is limited to **16**. OpenSearch compatible tools can now create indices on the cluster as long as they follow the naming conventions. + +#### IAM configuration + +If you have enabled [IAM on your account](/pages/manage_and_operate/observability/logs_data_platform/iam_presentation_faq/) you first need to create a policy and give the creation rights to your preferred user/account. See the [IAM for LDP documentation policy guide](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). + +The rights relative to the management of OpenSearch items through the **OVHcloud APIs** are: + + +|Rights |LDP product types|Description| +|---------------------------------------------------|-----------------|-----------| +|ldp:apiovh:url/get |service |Get Logs Data Platform service useful urls| +|ldp:apiovh:output/opensearch/index/create |service |Order a new OpenSearch index over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/create |service |Create a new OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/get |alias |Get OpenSearch aliases over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/edit |alias |Update an OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/index/attach |alias |Attach an OpenSearch index to a OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/index/detach |alias |Detach an OpenSearch index to a OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/delete |alias |Delete an OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/index/get |index |Get OpenSearch indexes over OVHcloud API| +|ldp:apiovh:output/opensearch/index/url/get |index |Get urls of an OpenSearch index over OVHcloud API| +|ldp:apiovh:output/opensearch/index/edit |index |Update an OpenSearch index over OVHcloud API| +|ldp:apiovh:output/opensearch/index/delete |index |Delete an OpenSearch index over OVHcloud API| + + +The rights relative to the management of OpenSearch items through the **OpenSearch API** are: + + +|Rights |LDP product types|Description| +|---------------------------------------------------|-----------------|-----------| +|ldp:opensearch:index/create |service |Create an index over OpenSearch API| +|ldp:opensearch:alias/create |service |Create an alias over OpenSearch API| +|ldp:opensearch:alias/read |alias |Read an alias's contents over OpenSearch API| +|ldp:opensearch:alias/delete |alias |Delete an alias over OpenSearch API| +|ldp:opensearch:index/read |index |Read an index content over OpenSearch API| +|ldp:opensearch:index/write |index |Write content to an index over OpenSearch API| +|ldp:opensearch:index/delete |index |Delete an index over OpenSearch API| + +Attach these rights to your policies freely whether you need to interact directly with the OpenSearch API or through the manager. + +The prefix of all indices or aliases created is . Example: ldp-ab-12345-i-my-awesome-index. +To interact with the OpenSearch API, you can either create [service accounts](/pages/account_and_service_management/account_information/authenticate-api-with-service-account) and leverage the OpenID workflow, or create [local users](/pages/account_and_service_management/account_information/ovhcloud-users-management) with their Personal Access Token with the API: + +> [!api] +> +> @api {v1} /me POST /me/identity/user/{user}/token +> + +This call will return a bearer token for a specific local user. + +You can then use the token of your user to create an index or write documents to your indices. + +```bash +ldp@laptop curl -H 'content-type: application/json' --oauth2-bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c -XPUT 'https://gra2.logs.ovh.com:9200/ldp-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 2}}' +``` + +You can alternatively use the basic scheme authentication with your bearer token as a password for systems that don't support a bearer token (or a custom Authentication Bearer header). The only constraint is to use a username starting with the prefix **pat_jwt_**. For example: + +```bash +ldp@laptop curl -H 'content-type: application/json' -u pat_jwt_user_one:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c -XPUT 'https://gra2.logs.ovh.com:9200/ldp-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 2}}' ``` -There is more information about the API Support at the [dedicated section](#management-through-opensearch-api). +Here, in both examples, the index created will have 2 shards and will appear in your panel. You can then attach it to an IAM policy. + +#### Legacy users + +If you don't have IAM enabled on your account (which will be deprecated) the prefix of indices is `:`. + +Here is an example with a curl command with the user **logs-ab-12345** and the index **logs-ab-12345-i-another-index** on gra2 cluster: + +```bash +$ curl -u logs-ab-12345:mypassword -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/logs-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 1}}' +``` -Whatever method you use, you will be able to query and visualize your documents on Logs Data Platform using the API. #### Index some data -Logs Data Platform OpenSearch indices are compatible with the [OpenSearch REST API](https://opensearch.org/docs/latest/opensearch/rest-api/index/). Therefore, you can use simple http requests to index and search your data. The API is accessible behind a secured https endpoint with mandatory authentication. We recommend that you use [tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens) to authenticate yourself. You can retrieve the endpoint of the API at the **Home** page of your service. Here is a simple example to index a document with curl with an index on the cluster `.logs.ovh.com`. +Logs Data Platform OpenSearch indices are compatible with the [OpenSearch REST API](https://opensearch.org/docs/latest/opensearch/rest-api/index/). Therefore, you can use simple http requests to index and search your data. The API is accessible behind a secured https endpoint with mandatory authentication. You can retrieve the endpoint of the API at the **Home** page of your service. Here is a simple example to index a document with curl on the cluster `.logs.ovh.com`. -```shell-session -$ curl -u token: -XPUT -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/logs--i-/_doc/1' -d '{ "user" : "Oles", "company" : "OVH", "message" : "Hello World !", "post_date" : "1999-11-02T23:01:00" }' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/-i-/_doc/1' -d '{ "user" : "Oles", "company" : "OVH", "message" : "Hello World !", "post_date" : "1999-11-02T23:01:00" }' ``` Here is a quick explanation of this command: - The **PUT** HTTP command can be used to create or modify a document. -- The `Content-Type: application/json` is the mandatory header to indicate that the data will be in the json format. +- The `Content-Type: application/json` is the mandatory header to indicate that the data will be in the JSON format. - The address contains the endpoint of the cluster followed by the **name of your index** -- The **test** just after the index name is the type of the document. +- The **_doc** just after the index name must be used as the type of the document. - The **1** here is the id of your document that can be any string. - The payload of the request is a simple **JSON document** that will be indexed. @@ -68,7 +140,7 @@ This command will return with a simple payload indicating if the document has be ```json { "_id": "1", - "_index": "logs--i-", + "_index": "-i-", "_primary_term": 1, "_seq_no": 0, "_shards": { @@ -86,25 +158,25 @@ This command will return with a simple payload indicating if the document has be There are multiple ways to search your data, this is one area where the OpenSearch REST API excels. You can either get your data directly by using a GET request, or search it with the Search APIs. To get your document indexed previously, use the following curl request: -```shell-session -$ curl -XGET -u token: 'https://.logs.ovh.com:9200/logs--i-/_doc/1' -{"_id":"1","_index":"logs--i-","_primary_term":1,"_seq_no":0,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc","_version":1,"found":true} +```bash +$ curl --oauth2-bearer -XGET 'https://.logs.ovh.com:9200/-i-/_doc/1' +{"_id":"1","_index":"-i-","_primary_term":1,"_seq_no":0,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc","_version":1,"found":true} ``` To issue a simple search you can either use the [Query DSL](https://opensearch.org/docs/latest/opensearch/query-dsl/index/) or a URI search. Here is a simple example with an URI search: -```shell-session -$ curl -XGET -u token: 'https://.logs.ovh.com:9200/logs--i-/_search?q=user:Oles' -{"_shards":{"failed":0,"skipped":0,"successful":1,"total":1},"hits":{"hits":[{"_id":"1","_index":"newindice","_score":0.2876821,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc"}],"max_score":0.2876821,"total":1},"timed_out":false,"took":31} +```bash +$ curl --oauth2-bearer -XGET 'https://.logs.ovh.com:9200/-i-/_search?q=user:Oles' +{"_shards":{"failed":0,"skipped":0,"successful":1,"total":1},"hits":{"hits":[{"_id":"1","_index":"-i-","_score":0.2876821,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc"}],"max_score":0.2876821,"total":1},"timed_out":false,"took":31} ``` ### Use case: Enrich Logs Data on the fly -The following shows how your e-commerce application logs can be sent to the Logs Data Platform whenever a product is ordered. It logs the customer order by using Id for the customers name. For performance reasons or maybe by-design, the application doesn't fetch the full name of the client or other information from the customer database just to produce a log. You can add this information on the fly by using an OpenSearch Index and a Logstash collector on the Logs Data Platform. +The following shows how your e-commerce application logs can be sent to the Logs Data Platform whenever a product is ordered. It logs the customer order by using ID for the customer's name. For performance reasons or maybe by design, the application doesn't fetch the full name of the client or other information from the customer database just to produce a log. You can add this information on the fly by using an OpenSearch Index and a Logstash collector on the Logs Data Platform. -#### Fill an index with clients information +#### Populate an index with clients' information -The first thing to do is to index some clients information. The snippet below is one entry of the client index. +The first thing to do is to index some client information. The snippet below is one entry of the client index. ```json { @@ -137,15 +209,15 @@ The first thing to do is to index some clients information. The snippet below is } ``` -To index several documents at once, it is more efficient to use the bulk api. Here is a small snippet of 3 users you can use to test it. +To index several documents at once, it is more efficient to use the bulk API. Here is a small snippet of 3 users you can use to test it. ```json -{ "index" : { "_index" : "logs--i-" } } -{ "userId": "1", "firstName": "Jon","lastName": "Snow", "age": 22, "address": { "streetAddress": "21 2nd Street", "city": "Winterfell", "state": "North", "postalCode": "14578", "geolocation": { "lat": 54.369488, "long": -5.574768 } },"phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-4567" } ] } -{ "index" : { "_index" : "logs--i-" } } -{ "userId": "2", "firstName": "Cersei","lastName": "Lannister", "age": 43, "address": { "streetAddress": "1 Palace Street", "city": "King's Landing", "state": "The Crownlands", "postalCode": "26863", "geolocation": { "lat": 42.639758, "long": 18.1094725 } },"phoneNumber": [ { "type": "home", "number": "212 555-6789" }, { "type": "mobile", "number": "102 555-8901" } ] } -{ "index" : { "_index" : "logs--i-" } } -{ "userId": "3", "firstName": "Daenerys","lastName": "Targaryen", "age": 22, "address": { "streetAddress": "3 Blackwater Bay Ave", "city": "Dragonstone", "state": "Dragonstone", "postalCode": "75197", "geolocation": { "lat": 43.300097, "long": -2.261580 } },"phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-2345" } ] } +{ "index" : { "_index" : "-i-" } } +{ "userId": "1", "firstName": "Jon","lastName": "Snow", "age": 22, "address": { "streetAddress": "21 2nd Street", "city": "Winterfell", "state": "North", "postalCode": "14578", "geolocation": { "lat": 54.369488, "long": -5.574768 } }, "phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-4567" } ] } +{ "index" : { "_index" : "-i-" } } +{ "userId": "2", "firstName": "Cersei","lastName": "Lannister", "age": 43, "address": { "streetAddress": "1 Palace Street", "city": "King's Landing", "state": "The Crownlands", "postalCode": "26863", "geolocation": { "lat": 42.639758, "long": 18.1094725 } }, "phoneNumber": [ { "type": "home", "number": "212 555-6789" }, { "type": "mobile", "number": "102 555-8901" } ] } +{ "index" : { "_index" : "-i-" } } +{ "userId": "3", "firstName": "Daenerys","lastName": "Targaryen", "age": 22, "address": { "streetAddress": "3 Blackwater Bay Ave", "city": "Dragonstone", "state": "Dragonstone", "postalCode": "75197", "geolocation": { "lat": 43.300097, "long": -2.261580 } }, "phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-2345" } ] } ``` A bulk request is a succession of JSON objects with this structure: @@ -162,14 +234,14 @@ A bulk request is a succession of JSON objects with this structure: You can in one request ask OpenSearch to index, update, delete several documents. Save the content of the previous JSON lines in a file named **bulk** and use the following call to index these 3 users: -```shell-session -$ curl -u token: -XPUT -H 'Content-Type: application/x-ndjson' 'https://.logs.ovh.com:9200/logs--i-/_bulk' --data-binary "@bulk" +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/x-ndjson' 'https://.logs.ovh.com:9200/-i-/_bulk' --data-binary "@bulk" ``` This call will take the content of the bulk file and execute each index operation. Note that you have to use the option **--data-binary** and no **-d** to preserve the newline after each JSON. You can check that your data are properly indexed with the following call: -```shell-session -$ curl -u token: -XGET 'https://.logs.ovh.com:9200/logs--i-/_search?pretty=true' +```bash +$ curl --oauth2-bearer -XGET 'https://.logs.ovh.com:9200/-i-/_search?pretty=true' ``` This will give you back the documents of your index: @@ -187,7 +259,7 @@ This will give you back the documents of your index: "total" : 3, "max_score" : 1.0, "hits" : [ { - "_index" : "logs--i-", + "_index" : "-i-", "_type" : "_doc", "_id" : "AV3HvbQAz85mIBfrJjkV", "_score" : 1.0, @@ -215,7 +287,7 @@ This will give you back the documents of your index: } ] } }, { - "_index" : "logs--i-", + "_index" : "-i-", "_type" : "_doc", "_id" : "AV3HvbQAz85mIBfrJjkW", "_score" : 1.0, @@ -243,7 +315,7 @@ This will give you back the documents of your index: } ] } }, { - "_index" : "logs--i-", + "_index" : "-i-", "_type" : "_doc", "_id" : "AV3HvbQAz85mIBfrJjkX", "_score" : 1.0, @@ -299,9 +371,9 @@ The most important part in this configuration is the filter part: ```ruby opensearch { hosts => ["https://gra2.logs.ovh.com:9200"] - index => "logs--i-" - user => "" - password => "" + index => "-i-" + user => "pat_jwt_logstash" + password => "" enable_sort => false query => "userId:%{[userId]}" fields => { @@ -337,7 +409,7 @@ The mutate plugin is here to show you how you can combine different subfield inf One simple way to test your new Logstash configuration is to send a log by using echo and openssl. Check the examples below: -```shell-session +```bash $ echo -e '{"version":"1.1", "host": "little bird", "short_message": "Warrior from the North", "level":1, "_userId": "2", "_unitType": "Westerosis", "_power_num": 200 }'\0 | openssl s_client -quiet -no_ign_eof -connect : $ echo -e '{"version":"1.1", "host": "little bird", "short_message": "A legendary dragon", "level":1, "_userId": "3", "_unitType": "Dragon", "_power_num": 200000 }'\0 | openssl s_client -quiet -no_ign_eof -connect : ``` @@ -368,7 +440,7 @@ The **maximum size** of your index is fixed and is dependent on the number of sh Note that you can monitor the size of the index by using the following curl query: ```shell-session -$ curl -u token: -XGET -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/logs--i-/_stats/store?pretty' +$ curl --oauth2-bearer -XGET -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/-i-/_stats/store?pretty' ``` This command will give you a document with the following format: @@ -393,7 +465,7 @@ This command will give you a document with the following format: } }, "indices" : { - "logs--i-" : { + "-i-" : { "uuid" : "JC0IWkd3QYSBNd4B2bBZGg", "primaries" : { "store" : { @@ -411,7 +483,7 @@ This command will give you a document with the following format: ``` The size in bytes used to compute your billing is the one under the following path: -"indices" -> "logs--i-" -> "primaries" -> "store" -> "size\_in\_bytes". +"indices" -> "-i-" -> "primaries" -> "store" -> "size\_in\_bytes". ### Management through OpenSearch API @@ -421,8 +493,8 @@ On Logs Data Platform, we allow users to use OpenSearch API to handle the lifecy To create an index on Logs Data Platform, use the following call: -```shell-session -$ curl -u : -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' -d '{ "settings" : {"number_of_shards" : 1}}' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' -d '{ "settings" : {"number_of_shards" : 1}}' ``` - The **-u** option is followed by your LDP username that you can find on **Home** page. The password 'mypassword' follows it after the separator ':' @@ -431,22 +503,22 @@ $ curl -u : -XPUT -H 'Content-Type: application/json' 'htt - The address contains the endpoint of the cluster followed by the **name of your index** - The payload of the request is a **JSON document** which contains the [settings of your index](https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/create-index/): the number of shards (the number of replicas will be automatically set at 1). -You have to follow the Logs Data Platform naming convention `-i-` to create your index. Your username is the one you use to connect to Graylog or to use the API. The suffix can contain any alphanumeric character. +You have to follow the Logs Data Platform naming convention `-i-` to create your index. Your service name can be found on the home page of the Logs Data Platform control panel. The suffix can contain any alphanumeric characters. -To delete a index use the following call: +To delete an index use the following call: -```shell-session -$ curl -u : -XDELETE -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' +```bash +$ curl --oauth2-bearer -XDELETE -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' ``` Here we use the **DELETE** HTTP command to delete the index. #### Alias creation and deletion -Similarly than indices, you can use the API Calls to delete and create aliases on your indices. The only difference is the convention for the name of your alias. Your alias must be formatted as the following **`-a-`**. Here is an example call: +Similarly than indices, you can use the API Calls to delete and create aliases on your indices. The only difference is the convention for the name of your alias. Your alias must be formatted as the following **`-a-`** (or -a- for legacy users). Here is an example call: -```shell-session -$ curl -u : -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-/_alias/-a-' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-/_alias/-a-' ``` This call creates a individual alias on one index you have previously created. @@ -455,13 +527,13 @@ If you need more information on aliases, you can check the [OpenSearch Documenta We also support the aliases API to create aliases: -```shell-session -$ curl -XPOST "https://gra2.logs.ovh.com:9200/_aliases?pretty" -H 'Content-Type: application/json' -d' +```bash +$ curl --oauth2-bearer -XPOST "https://gra2.logs.ovh.com:9200/_aliases?pretty" -H 'Content-Type: application/json' -d' { "actions" : [ - { "remove" : { "index" : "-i-", "alias" : "-a-" } }, - { "add" : { "index" : "-i-", "alias" : "-a-" } }, - { "remove_index": { "index": "-i-" } } + { "remove" : { "index" : "-i-", "alias" : "-a-" } }, + { "add" : { "index" : "-i-", "alias" : "-a-" } }, + { "remove_index": { "index": "-i-" } } ] }' ``` @@ -472,22 +544,22 @@ All the actions (alias change, alias creation and index deletion) will be done i Logs Data Platform supports your custom templates. As for indices and aliases, the template must follow some rules in order for them to work: -- the template name must contain your **``** inside the name. It can be anywhere in the name string. -- The prefix of the indices involved in the template MUST start by **`-i-`**, the "\*" character must be after this prefix -- The alias attached to your template must follow the usual convention: **`-a-`** +- the template name must contain your **``** inside the name. It can be anywhere in the name string. +- The prefix of the indices involved in the template MUST start by one your allowed services so **`-i-`**, the "\*" character must be after this prefix +- The alias attached to your template must follow the usual convention: **`-a-`** -Here is an example of a template for a user **logs-ab-12345**: +Here is an example of a template for a service **ldp-ab-12345**: -```shell-session -$ curl -u : -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/_template/template_for_logs-ab-12345_indices' -d ' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/_template/template_for_ldp-ab-12345_indices' -d ' { - "index_patterns" : [ "logs-ab-12345-i-debug*","logs-ab-12345-i-test*" ], + "index_patterns" : [ "ldp-ab-12345-i-debug*","ldp-ab-12345-i-test*" ], "settings": { "number_of_shards" : 1 }, "aliases" : { - "logs-ab-12345-a-all" : {}, - "logs-ab-12345-a-debug" : { "filter" : { "term" : { "type" : "debug" } } } + "ldp-ab-12345-a-all" : {}, + "ldp-ab-12345-a-debug" : { "filter" : { "term" : { "type" : "debug" } } } } }' ``` @@ -507,8 +579,8 @@ Here the first index was create through API, its description was filled automati Index as a service has some specificities on our platforms. This additional and technical information can help you to use it properly: - **Replication** is set at 1 and cannot be changed. We ensure the high availability of your index in case of a hardware failure. -- The **maximum size** of your index is fixed and is dependent on the number of shards. If search performance is critical, you should choose an index with the highest number of shard you can afford. -- The **index_refresh_interval** of the index is set at 1 second ensuring near real time search results. +- The **maximum size** of your index is fixed and is dependent on the number of shards. If search performance is critical, you should choose the highest number of shards you can afford. +- The **index_refresh_interval** of the index is set at 1 second, ensuring near real time search results. - You are not allowed to change the settings of your index. - You can create an **alias** on Logs Data Platform and attach it to one or several indices. - Unlike indices, aliases are **read-only**, you cannot write through an alias yet. @@ -519,4 +591,4 @@ Index as a service has some specificities on our platforms. This additional and - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.en-asia.md b/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.en-asia.md index 59deae3fe93..78216c98ff6 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.en-asia.md +++ b/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.en-asia.md @@ -1,25 +1,25 @@ --- title: OpenSearch Index as a Service excerpt: Use the power of OpenSearch without managing a cluster. -updated: 2024-08-07 +updated: 2025-10-16 --- ## Objective -OpenSearch is one of the main components of the Logs Data Platform, regarded as one of the most powerful search and analytics engines. From the outset we offered the possibility to host an OpenSearch Dashboards index for your OpenSearch Dashboards metadata, Index As A Service being the next step to this functionality. You can now use a fully unlocked index for almost any purpose; be it complex documents, reports or even logs. Thanks to the OpenSearch API, you will be able to use most of the tools of the OpenSearch Ecosystem. +OpenSearch is one of the main components of the Logs Data Platform, regarded as one of the most powerful search and analytics engines. From the outset we offered the possibility to host an OpenSearch Dashboards index for your OpenSearch Dashboards metadata. Index As A Service is the next step. You can now use a fully unlocked index for almost any purpose; be it complex documents, reports or even logs. Thanks to the OpenSearch API, you will be able to use most of the tools of the OpenSearch Ecosystem. ## Requirements This is what you need to know to get you started: - You have created a [Logs Data Platform account](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- You have access to the port 9200 of your cluster (head to the **Home** page in manager to know the address of your cluster). +- You have access to the port 9200 of your cluster (go to the **Home** page in manager to know the address of your cluster). ## Instructions ### First steps with an OpenSearch index -#### Create an index +#### Index name conventions There are two ways to create an OpenSearch Index: @@ -30,36 +30,108 @@ To create an OpenSearch index with the Logs Data Platform manager, you need to g ![add index option](images/add_index.png){.thumbnail} -You must just choose a suffix for your index. The final name will follow this convention: +Simply choose a suffix for your index. The final name will follow this convention: -`logs--i-`. +`-i-`. -For each index, you can specify the number of **shards**. A **shard** is the main component of an **index**. Its maximum storage capacity is set to **25 GB** (per shard). Multiple shards means more volume, more parallelism in your requests and thus more performance. Optionally, you can also be notified when your index is close to its critical size. Once your index is created, you can use it right away. +The service name is the identifier of your Logs Data Platform service. It is different from the username used by non IAM users. The service name starts with `ldp` (e.g. `ldp-ab-12345`). On the other hand, the username starts with `logs` (e.g. `logs-ab-12345`). In this guide we will use **** or **** as tags to let you differentiate both usages. You can find both pieces of information in the **Logs Data Platform control panel**. -When you create an index through the [OpenSearch API](https://opensearch.org/docs/latest/opensearch/index-data/), you can also specify the number of shards. Note that the maximum number of shards by index is limited to **16**. OpenSearch compatible tools can now create indices on the cluster as long as they follow the naming convention `logs--i-`. Here is an example with a curl command with the user **logs-ab-12345** and the index **logs-ab-12345-i-another-index** on gra2 cluster. +> [!primary] +> +> Prior to IAM migration the prefix was . It has now been changed to for all indices created after 17 September 2025. +> -```shell-session -$ curl -u logs-ab-12345:mypassword -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/logs-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 1}}' +For each index, you can specify the number of **shards**. A **shard** is the main component of an **index**. Its maximum storage capacity is set to **25 GB** (per shard). Multiple shards mean more volume, more parallelism in your requests and thus more performance. Optionally, you can also be notified when your index is close to its critical size. Once your index is created, you can use it right away. + +When you create an index through the [OpenSearch API](https://opensearch.org/docs/latest/opensearch/index-data/), you can also specify the number of shards. Note that the maximum number of shards per index is limited to **16**. OpenSearch compatible tools can now create indices on the cluster as long as they follow the naming conventions. + +#### IAM configuration + +If you have enabled [IAM on your account](/pages/manage_and_operate/observability/logs_data_platform/iam_presentation_faq/) you first need to create a policy and give the creation rights to your preferred user/account. See the [IAM for LDP documentation policy guide](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). + +The rights relative to the management of OpenSearch items through the **OVHcloud APIs** are: + + +|Rights |LDP product types|Description| +|---------------------------------------------------|-----------------|-----------| +|ldp:apiovh:url/get |service |Get Logs Data Platform service useful urls| +|ldp:apiovh:output/opensearch/index/create |service |Order a new OpenSearch index over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/create |service |Create a new OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/get |alias |Get OpenSearch aliases over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/edit |alias |Update an OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/index/attach |alias |Attach an OpenSearch index to a OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/index/detach |alias |Detach an OpenSearch index to a OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/delete |alias |Delete an OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/index/get |index |Get OpenSearch indexes over OVHcloud API| +|ldp:apiovh:output/opensearch/index/url/get |index |Get urls of an OpenSearch index over OVHcloud API| +|ldp:apiovh:output/opensearch/index/edit |index |Update an OpenSearch index over OVHcloud API| +|ldp:apiovh:output/opensearch/index/delete |index |Delete an OpenSearch index over OVHcloud API| + + +The rights relative to the management of OpenSearch items through the **OpenSearch API** are: + + +|Rights |LDP product types|Description| +|---------------------------------------------------|-----------------|-----------| +|ldp:opensearch:index/create |service |Create an index over OpenSearch API| +|ldp:opensearch:alias/create |service |Create an alias over OpenSearch API| +|ldp:opensearch:alias/read |alias |Read an alias's contents over OpenSearch API| +|ldp:opensearch:alias/delete |alias |Delete an alias over OpenSearch API| +|ldp:opensearch:index/read |index |Read an index content over OpenSearch API| +|ldp:opensearch:index/write |index |Write content to an index over OpenSearch API| +|ldp:opensearch:index/delete |index |Delete an index over OpenSearch API| + +Attach these rights to your policies freely whether you need to interact directly with the OpenSearch API or through the manager. + +The prefix of all indices or aliases created is . Example: ldp-ab-12345-i-my-awesome-index. +To interact with the OpenSearch API, you can either create [service accounts](/pages/account_and_service_management/account_information/authenticate-api-with-service-account) and leverage the OpenID workflow, or create [local users](/pages/account_and_service_management/account_information/ovhcloud-users-management) with their Personal Access Token with the API: + +> [!api] +> +> @api {v1} /me POST /me/identity/user/{user}/token +> + +This call will return a bearer token for a specific local user. + +You can then use the token of your user to create an index or write documents to your indices. + +```bash +ldp@laptop curl -H 'content-type: application/json' --oauth2-bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c -XPUT 'https://gra2.logs.ovh.com:9200/ldp-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 2}}' +``` + +You can alternatively use the basic scheme authentication with your bearer token as a password for systems that don't support a bearer token (or a custom Authentication Bearer header). The only constraint is to use a username starting with the prefix **pat_jwt_**. For example: + +```bash +ldp@laptop curl -H 'content-type: application/json' -u pat_jwt_user_one:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c -XPUT 'https://gra2.logs.ovh.com:9200/ldp-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 2}}' ``` -There is more information about the API Support at the [dedicated section](#management-through-opensearch-api). +Here, in both examples, the index created will have 2 shards and will appear in your panel. You can then attach it to an IAM policy. + +#### Legacy users + +If you don't have IAM enabled on your account (which will be deprecated) the prefix of indices is `:`. + +Here is an example with a curl command with the user **logs-ab-12345** and the index **logs-ab-12345-i-another-index** on gra2 cluster: + +```bash +$ curl -u logs-ab-12345:mypassword -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/logs-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 1}}' +``` -Whatever method you use, you will be able to query and visualize your documents on Logs Data Platform using the API. #### Index some data -Logs Data Platform OpenSearch indices are compatible with the [OpenSearch REST API](https://opensearch.org/docs/latest/opensearch/rest-api/index/). Therefore, you can use simple http requests to index and search your data. The API is accessible behind a secured https endpoint with mandatory authentication. We recommend that you use [tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens) to authenticate yourself. You can retrieve the endpoint of the API at the **Home** page of your service. Here is a simple example to index a document with curl with an index on the cluster `.logs.ovh.com`. +Logs Data Platform OpenSearch indices are compatible with the [OpenSearch REST API](https://opensearch.org/docs/latest/opensearch/rest-api/index/). Therefore, you can use simple http requests to index and search your data. The API is accessible behind a secured https endpoint with mandatory authentication. You can retrieve the endpoint of the API at the **Home** page of your service. Here is a simple example to index a document with curl on the cluster `.logs.ovh.com`. -```shell-session -$ curl -u token: -XPUT -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/logs--i-/_doc/1' -d '{ "user" : "Oles", "company" : "OVH", "message" : "Hello World !", "post_date" : "1999-11-02T23:01:00" }' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/-i-/_doc/1' -d '{ "user" : "Oles", "company" : "OVH", "message" : "Hello World !", "post_date" : "1999-11-02T23:01:00" }' ``` Here is a quick explanation of this command: - The **PUT** HTTP command can be used to create or modify a document. -- The `Content-Type: application/json` is the mandatory header to indicate that the data will be in the json format. +- The `Content-Type: application/json` is the mandatory header to indicate that the data will be in the JSON format. - The address contains the endpoint of the cluster followed by the **name of your index** -- The **test** just after the index name is the type of the document. +- The **_doc** just after the index name must be used as the type of the document. - The **1** here is the id of your document that can be any string. - The payload of the request is a simple **JSON document** that will be indexed. @@ -68,7 +140,7 @@ This command will return with a simple payload indicating if the document has be ```json { "_id": "1", - "_index": "logs--i-", + "_index": "-i-", "_primary_term": 1, "_seq_no": 0, "_shards": { @@ -86,25 +158,25 @@ This command will return with a simple payload indicating if the document has be There are multiple ways to search your data, this is one area where the OpenSearch REST API excels. You can either get your data directly by using a GET request, or search it with the Search APIs. To get your document indexed previously, use the following curl request: -```shell-session -$ curl -XGET -u token: 'https://.logs.ovh.com:9200/logs--i-/_doc/1' -{"_id":"1","_index":"logs--i-","_primary_term":1,"_seq_no":0,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc","_version":1,"found":true} +```bash +$ curl --oauth2-bearer -XGET 'https://.logs.ovh.com:9200/-i-/_doc/1' +{"_id":"1","_index":"-i-","_primary_term":1,"_seq_no":0,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc","_version":1,"found":true} ``` To issue a simple search you can either use the [Query DSL](https://opensearch.org/docs/latest/opensearch/query-dsl/index/) or a URI search. Here is a simple example with an URI search: -```shell-session -$ curl -XGET -u token: 'https://.logs.ovh.com:9200/logs--i-/_search?q=user:Oles' -{"_shards":{"failed":0,"skipped":0,"successful":1,"total":1},"hits":{"hits":[{"_id":"1","_index":"newindice","_score":0.2876821,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc"}],"max_score":0.2876821,"total":1},"timed_out":false,"took":31} +```bash +$ curl --oauth2-bearer -XGET 'https://.logs.ovh.com:9200/-i-/_search?q=user:Oles' +{"_shards":{"failed":0,"skipped":0,"successful":1,"total":1},"hits":{"hits":[{"_id":"1","_index":"-i-","_score":0.2876821,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc"}],"max_score":0.2876821,"total":1},"timed_out":false,"took":31} ``` ### Use case: Enrich Logs Data on the fly -The following shows how your e-commerce application logs can be sent to the Logs Data Platform whenever a product is ordered. It logs the customer order by using Id for the customers name. For performance reasons or maybe by-design, the application doesn't fetch the full name of the client or other information from the customer database just to produce a log. You can add this information on the fly by using an OpenSearch Index and a Logstash collector on the Logs Data Platform. +The following shows how your e-commerce application logs can be sent to the Logs Data Platform whenever a product is ordered. It logs the customer order by using ID for the customer's name. For performance reasons or maybe by design, the application doesn't fetch the full name of the client or other information from the customer database just to produce a log. You can add this information on the fly by using an OpenSearch Index and a Logstash collector on the Logs Data Platform. -#### Fill an index with clients information +#### Populate an index with clients' information -The first thing to do is to index some clients information. The snippet below is one entry of the client index. +The first thing to do is to index some client information. The snippet below is one entry of the client index. ```json { @@ -137,15 +209,15 @@ The first thing to do is to index some clients information. The snippet below is } ``` -To index several documents at once, it is more efficient to use the bulk api. Here is a small snippet of 3 users you can use to test it. +To index several documents at once, it is more efficient to use the bulk API. Here is a small snippet of 3 users you can use to test it. ```json -{ "index" : { "_index" : "logs--i-" } } -{ "userId": "1", "firstName": "Jon","lastName": "Snow", "age": 22, "address": { "streetAddress": "21 2nd Street", "city": "Winterfell", "state": "North", "postalCode": "14578", "geolocation": { "lat": 54.369488, "long": -5.574768 } },"phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-4567" } ] } -{ "index" : { "_index" : "logs--i-" } } -{ "userId": "2", "firstName": "Cersei","lastName": "Lannister", "age": 43, "address": { "streetAddress": "1 Palace Street", "city": "King's Landing", "state": "The Crownlands", "postalCode": "26863", "geolocation": { "lat": 42.639758, "long": 18.1094725 } },"phoneNumber": [ { "type": "home", "number": "212 555-6789" }, { "type": "mobile", "number": "102 555-8901" } ] } -{ "index" : { "_index" : "logs--i-" } } -{ "userId": "3", "firstName": "Daenerys","lastName": "Targaryen", "age": 22, "address": { "streetAddress": "3 Blackwater Bay Ave", "city": "Dragonstone", "state": "Dragonstone", "postalCode": "75197", "geolocation": { "lat": 43.300097, "long": -2.261580 } },"phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-2345" } ] } +{ "index" : { "_index" : "-i-" } } +{ "userId": "1", "firstName": "Jon","lastName": "Snow", "age": 22, "address": { "streetAddress": "21 2nd Street", "city": "Winterfell", "state": "North", "postalCode": "14578", "geolocation": { "lat": 54.369488, "long": -5.574768 } }, "phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-4567" } ] } +{ "index" : { "_index" : "-i-" } } +{ "userId": "2", "firstName": "Cersei","lastName": "Lannister", "age": 43, "address": { "streetAddress": "1 Palace Street", "city": "King's Landing", "state": "The Crownlands", "postalCode": "26863", "geolocation": { "lat": 42.639758, "long": 18.1094725 } }, "phoneNumber": [ { "type": "home", "number": "212 555-6789" }, { "type": "mobile", "number": "102 555-8901" } ] } +{ "index" : { "_index" : "-i-" } } +{ "userId": "3", "firstName": "Daenerys","lastName": "Targaryen", "age": 22, "address": { "streetAddress": "3 Blackwater Bay Ave", "city": "Dragonstone", "state": "Dragonstone", "postalCode": "75197", "geolocation": { "lat": 43.300097, "long": -2.261580 } }, "phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-2345" } ] } ``` A bulk request is a succession of JSON objects with this structure: @@ -162,14 +234,14 @@ A bulk request is a succession of JSON objects with this structure: You can in one request ask OpenSearch to index, update, delete several documents. Save the content of the previous JSON lines in a file named **bulk** and use the following call to index these 3 users: -```shell-session -$ curl -u token: -XPUT -H 'Content-Type: application/x-ndjson' 'https://.logs.ovh.com:9200/logs--i-/_bulk' --data-binary "@bulk" +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/x-ndjson' 'https://.logs.ovh.com:9200/-i-/_bulk' --data-binary "@bulk" ``` This call will take the content of the bulk file and execute each index operation. Note that you have to use the option **--data-binary** and no **-d** to preserve the newline after each JSON. You can check that your data are properly indexed with the following call: -```shell-session -$ curl -u token: -XGET 'https://.logs.ovh.com:9200/logs--i-/_search?pretty=true' +```bash +$ curl --oauth2-bearer -XGET 'https://.logs.ovh.com:9200/-i-/_search?pretty=true' ``` This will give you back the documents of your index: @@ -187,7 +259,7 @@ This will give you back the documents of your index: "total" : 3, "max_score" : 1.0, "hits" : [ { - "_index" : "logs--i-", + "_index" : "-i-", "_type" : "_doc", "_id" : "AV3HvbQAz85mIBfrJjkV", "_score" : 1.0, @@ -215,7 +287,7 @@ This will give you back the documents of your index: } ] } }, { - "_index" : "logs--i-", + "_index" : "-i-", "_type" : "_doc", "_id" : "AV3HvbQAz85mIBfrJjkW", "_score" : 1.0, @@ -243,7 +315,7 @@ This will give you back the documents of your index: } ] } }, { - "_index" : "logs--i-", + "_index" : "-i-", "_type" : "_doc", "_id" : "AV3HvbQAz85mIBfrJjkX", "_score" : 1.0, @@ -299,9 +371,9 @@ The most important part in this configuration is the filter part: ```ruby opensearch { hosts => ["https://gra2.logs.ovh.com:9200"] - index => "logs--i-" - user => "" - password => "" + index => "-i-" + user => "pat_jwt_logstash" + password => "" enable_sort => false query => "userId:%{[userId]}" fields => { @@ -337,7 +409,7 @@ The mutate plugin is here to show you how you can combine different subfield inf One simple way to test your new Logstash configuration is to send a log by using echo and openssl. Check the examples below: -```shell-session +```bash $ echo -e '{"version":"1.1", "host": "little bird", "short_message": "Warrior from the North", "level":1, "_userId": "2", "_unitType": "Westerosis", "_power_num": 200 }'\0 | openssl s_client -quiet -no_ign_eof -connect : $ echo -e '{"version":"1.1", "host": "little bird", "short_message": "A legendary dragon", "level":1, "_userId": "3", "_unitType": "Dragon", "_power_num": 200000 }'\0 | openssl s_client -quiet -no_ign_eof -connect : ``` @@ -368,7 +440,7 @@ The **maximum size** of your index is fixed and is dependent on the number of sh Note that you can monitor the size of the index by using the following curl query: ```shell-session -$ curl -u token: -XGET -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/logs--i-/_stats/store?pretty' +$ curl --oauth2-bearer -XGET -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/-i-/_stats/store?pretty' ``` This command will give you a document with the following format: @@ -393,7 +465,7 @@ This command will give you a document with the following format: } }, "indices" : { - "logs--i-" : { + "-i-" : { "uuid" : "JC0IWkd3QYSBNd4B2bBZGg", "primaries" : { "store" : { @@ -411,7 +483,7 @@ This command will give you a document with the following format: ``` The size in bytes used to compute your billing is the one under the following path: -"indices" -> "logs--i-" -> "primaries" -> "store" -> "size\_in\_bytes". +"indices" -> "-i-" -> "primaries" -> "store" -> "size\_in\_bytes". ### Management through OpenSearch API @@ -421,8 +493,8 @@ On Logs Data Platform, we allow users to use OpenSearch API to handle the lifecy To create an index on Logs Data Platform, use the following call: -```shell-session -$ curl -u : -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' -d '{ "settings" : {"number_of_shards" : 1}}' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' -d '{ "settings" : {"number_of_shards" : 1}}' ``` - The **-u** option is followed by your LDP username that you can find on **Home** page. The password 'mypassword' follows it after the separator ':' @@ -431,22 +503,22 @@ $ curl -u : -XPUT -H 'Content-Type: application/json' 'htt - The address contains the endpoint of the cluster followed by the **name of your index** - The payload of the request is a **JSON document** which contains the [settings of your index](https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/create-index/): the number of shards (the number of replicas will be automatically set at 1). -You have to follow the Logs Data Platform naming convention `-i-` to create your index. Your username is the one you use to connect to Graylog or to use the API. The suffix can contain any alphanumeric character. +You have to follow the Logs Data Platform naming convention `-i-` to create your index. Your service name can be found on the home page of the Logs Data Platform control panel. The suffix can contain any alphanumeric characters. -To delete a index use the following call: +To delete an index use the following call: -```shell-session -$ curl -u : -XDELETE -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' +```bash +$ curl --oauth2-bearer -XDELETE -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' ``` Here we use the **DELETE** HTTP command to delete the index. #### Alias creation and deletion -Similarly than indices, you can use the API Calls to delete and create aliases on your indices. The only difference is the convention for the name of your alias. Your alias must be formatted as the following **`-a-`**. Here is an example call: +Similarly than indices, you can use the API Calls to delete and create aliases on your indices. The only difference is the convention for the name of your alias. Your alias must be formatted as the following **`-a-`** (or -a- for legacy users). Here is an example call: -```shell-session -$ curl -u : -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-/_alias/-a-' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-/_alias/-a-' ``` This call creates a individual alias on one index you have previously created. @@ -455,13 +527,13 @@ If you need more information on aliases, you can check the [OpenSearch Documenta We also support the aliases API to create aliases: -```shell-session -$ curl -XPOST "https://gra2.logs.ovh.com:9200/_aliases?pretty" -H 'Content-Type: application/json' -d' +```bash +$ curl --oauth2-bearer -XPOST "https://gra2.logs.ovh.com:9200/_aliases?pretty" -H 'Content-Type: application/json' -d' { "actions" : [ - { "remove" : { "index" : "-i-", "alias" : "-a-" } }, - { "add" : { "index" : "-i-", "alias" : "-a-" } }, - { "remove_index": { "index": "-i-" } } + { "remove" : { "index" : "-i-", "alias" : "-a-" } }, + { "add" : { "index" : "-i-", "alias" : "-a-" } }, + { "remove_index": { "index": "-i-" } } ] }' ``` @@ -472,22 +544,22 @@ All the actions (alias change, alias creation and index deletion) will be done i Logs Data Platform supports your custom templates. As for indices and aliases, the template must follow some rules in order for them to work: -- the template name must contain your **``** inside the name. It can be anywhere in the name string. -- The prefix of the indices involved in the template MUST start by **`-i-`**, the "\*" character must be after this prefix -- The alias attached to your template must follow the usual convention: **`-a-`** +- the template name must contain your **``** inside the name. It can be anywhere in the name string. +- The prefix of the indices involved in the template MUST start by one your allowed services so **`-i-`**, the "\*" character must be after this prefix +- The alias attached to your template must follow the usual convention: **`-a-`** -Here is an example of a template for a user **logs-ab-12345**: +Here is an example of a template for a service **ldp-ab-12345**: -```shell-session -$ curl -u : -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/_template/template_for_logs-ab-12345_indices' -d ' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/_template/template_for_ldp-ab-12345_indices' -d ' { - "index_patterns" : [ "logs-ab-12345-i-debug*","logs-ab-12345-i-test*" ], + "index_patterns" : [ "ldp-ab-12345-i-debug*","ldp-ab-12345-i-test*" ], "settings": { "number_of_shards" : 1 }, "aliases" : { - "logs-ab-12345-a-all" : {}, - "logs-ab-12345-a-debug" : { "filter" : { "term" : { "type" : "debug" } } } + "ldp-ab-12345-a-all" : {}, + "ldp-ab-12345-a-debug" : { "filter" : { "term" : { "type" : "debug" } } } } }' ``` @@ -507,8 +579,8 @@ Here the first index was create through API, its description was filled automati Index as a service has some specificities on our platforms. This additional and technical information can help you to use it properly: - **Replication** is set at 1 and cannot be changed. We ensure the high availability of your index in case of a hardware failure. -- The **maximum size** of your index is fixed and is dependent on the number of shards. If search performance is critical, you should choose an index with the highest number of shard you can afford. -- The **index_refresh_interval** of the index is set at 1 second ensuring near real time search results. +- The **maximum size** of your index is fixed and is dependent on the number of shards. If search performance is critical, you should choose the highest number of shards you can afford. +- The **index_refresh_interval** of the index is set at 1 second, ensuring near real time search results. - You are not allowed to change the settings of your index. - You can create an **alias** on Logs Data Platform and attach it to one or several indices. - Unlike indices, aliases are **read-only**, you cannot write through an alias yet. @@ -519,4 +591,4 @@ Index as a service has some specificities on our platforms. This additional and - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.en-au.md b/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.en-au.md index 59deae3fe93..78216c98ff6 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.en-au.md +++ b/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.en-au.md @@ -1,25 +1,25 @@ --- title: OpenSearch Index as a Service excerpt: Use the power of OpenSearch without managing a cluster. -updated: 2024-08-07 +updated: 2025-10-16 --- ## Objective -OpenSearch is one of the main components of the Logs Data Platform, regarded as one of the most powerful search and analytics engines. From the outset we offered the possibility to host an OpenSearch Dashboards index for your OpenSearch Dashboards metadata, Index As A Service being the next step to this functionality. You can now use a fully unlocked index for almost any purpose; be it complex documents, reports or even logs. Thanks to the OpenSearch API, you will be able to use most of the tools of the OpenSearch Ecosystem. +OpenSearch is one of the main components of the Logs Data Platform, regarded as one of the most powerful search and analytics engines. From the outset we offered the possibility to host an OpenSearch Dashboards index for your OpenSearch Dashboards metadata. Index As A Service is the next step. You can now use a fully unlocked index for almost any purpose; be it complex documents, reports or even logs. Thanks to the OpenSearch API, you will be able to use most of the tools of the OpenSearch Ecosystem. ## Requirements This is what you need to know to get you started: - You have created a [Logs Data Platform account](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- You have access to the port 9200 of your cluster (head to the **Home** page in manager to know the address of your cluster). +- You have access to the port 9200 of your cluster (go to the **Home** page in manager to know the address of your cluster). ## Instructions ### First steps with an OpenSearch index -#### Create an index +#### Index name conventions There are two ways to create an OpenSearch Index: @@ -30,36 +30,108 @@ To create an OpenSearch index with the Logs Data Platform manager, you need to g ![add index option](images/add_index.png){.thumbnail} -You must just choose a suffix for your index. The final name will follow this convention: +Simply choose a suffix for your index. The final name will follow this convention: -`logs--i-`. +`-i-`. -For each index, you can specify the number of **shards**. A **shard** is the main component of an **index**. Its maximum storage capacity is set to **25 GB** (per shard). Multiple shards means more volume, more parallelism in your requests and thus more performance. Optionally, you can also be notified when your index is close to its critical size. Once your index is created, you can use it right away. +The service name is the identifier of your Logs Data Platform service. It is different from the username used by non IAM users. The service name starts with `ldp` (e.g. `ldp-ab-12345`). On the other hand, the username starts with `logs` (e.g. `logs-ab-12345`). In this guide we will use **** or **** as tags to let you differentiate both usages. You can find both pieces of information in the **Logs Data Platform control panel**. -When you create an index through the [OpenSearch API](https://opensearch.org/docs/latest/opensearch/index-data/), you can also specify the number of shards. Note that the maximum number of shards by index is limited to **16**. OpenSearch compatible tools can now create indices on the cluster as long as they follow the naming convention `logs--i-`. Here is an example with a curl command with the user **logs-ab-12345** and the index **logs-ab-12345-i-another-index** on gra2 cluster. +> [!primary] +> +> Prior to IAM migration the prefix was . It has now been changed to for all indices created after 17 September 2025. +> -```shell-session -$ curl -u logs-ab-12345:mypassword -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/logs-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 1}}' +For each index, you can specify the number of **shards**. A **shard** is the main component of an **index**. Its maximum storage capacity is set to **25 GB** (per shard). Multiple shards mean more volume, more parallelism in your requests and thus more performance. Optionally, you can also be notified when your index is close to its critical size. Once your index is created, you can use it right away. + +When you create an index through the [OpenSearch API](https://opensearch.org/docs/latest/opensearch/index-data/), you can also specify the number of shards. Note that the maximum number of shards per index is limited to **16**. OpenSearch compatible tools can now create indices on the cluster as long as they follow the naming conventions. + +#### IAM configuration + +If you have enabled [IAM on your account](/pages/manage_and_operate/observability/logs_data_platform/iam_presentation_faq/) you first need to create a policy and give the creation rights to your preferred user/account. See the [IAM for LDP documentation policy guide](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). + +The rights relative to the management of OpenSearch items through the **OVHcloud APIs** are: + + +|Rights |LDP product types|Description| +|---------------------------------------------------|-----------------|-----------| +|ldp:apiovh:url/get |service |Get Logs Data Platform service useful urls| +|ldp:apiovh:output/opensearch/index/create |service |Order a new OpenSearch index over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/create |service |Create a new OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/get |alias |Get OpenSearch aliases over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/edit |alias |Update an OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/index/attach |alias |Attach an OpenSearch index to a OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/index/detach |alias |Detach an OpenSearch index to a OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/delete |alias |Delete an OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/index/get |index |Get OpenSearch indexes over OVHcloud API| +|ldp:apiovh:output/opensearch/index/url/get |index |Get urls of an OpenSearch index over OVHcloud API| +|ldp:apiovh:output/opensearch/index/edit |index |Update an OpenSearch index over OVHcloud API| +|ldp:apiovh:output/opensearch/index/delete |index |Delete an OpenSearch index over OVHcloud API| + + +The rights relative to the management of OpenSearch items through the **OpenSearch API** are: + + +|Rights |LDP product types|Description| +|---------------------------------------------------|-----------------|-----------| +|ldp:opensearch:index/create |service |Create an index over OpenSearch API| +|ldp:opensearch:alias/create |service |Create an alias over OpenSearch API| +|ldp:opensearch:alias/read |alias |Read an alias's contents over OpenSearch API| +|ldp:opensearch:alias/delete |alias |Delete an alias over OpenSearch API| +|ldp:opensearch:index/read |index |Read an index content over OpenSearch API| +|ldp:opensearch:index/write |index |Write content to an index over OpenSearch API| +|ldp:opensearch:index/delete |index |Delete an index over OpenSearch API| + +Attach these rights to your policies freely whether you need to interact directly with the OpenSearch API or through the manager. + +The prefix of all indices or aliases created is . Example: ldp-ab-12345-i-my-awesome-index. +To interact with the OpenSearch API, you can either create [service accounts](/pages/account_and_service_management/account_information/authenticate-api-with-service-account) and leverage the OpenID workflow, or create [local users](/pages/account_and_service_management/account_information/ovhcloud-users-management) with their Personal Access Token with the API: + +> [!api] +> +> @api {v1} /me POST /me/identity/user/{user}/token +> + +This call will return a bearer token for a specific local user. + +You can then use the token of your user to create an index or write documents to your indices. + +```bash +ldp@laptop curl -H 'content-type: application/json' --oauth2-bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c -XPUT 'https://gra2.logs.ovh.com:9200/ldp-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 2}}' +``` + +You can alternatively use the basic scheme authentication with your bearer token as a password for systems that don't support a bearer token (or a custom Authentication Bearer header). The only constraint is to use a username starting with the prefix **pat_jwt_**. For example: + +```bash +ldp@laptop curl -H 'content-type: application/json' -u pat_jwt_user_one:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c -XPUT 'https://gra2.logs.ovh.com:9200/ldp-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 2}}' ``` -There is more information about the API Support at the [dedicated section](#management-through-opensearch-api). +Here, in both examples, the index created will have 2 shards and will appear in your panel. You can then attach it to an IAM policy. + +#### Legacy users + +If you don't have IAM enabled on your account (which will be deprecated) the prefix of indices is `:`. + +Here is an example with a curl command with the user **logs-ab-12345** and the index **logs-ab-12345-i-another-index** on gra2 cluster: + +```bash +$ curl -u logs-ab-12345:mypassword -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/logs-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 1}}' +``` -Whatever method you use, you will be able to query and visualize your documents on Logs Data Platform using the API. #### Index some data -Logs Data Platform OpenSearch indices are compatible with the [OpenSearch REST API](https://opensearch.org/docs/latest/opensearch/rest-api/index/). Therefore, you can use simple http requests to index and search your data. The API is accessible behind a secured https endpoint with mandatory authentication. We recommend that you use [tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens) to authenticate yourself. You can retrieve the endpoint of the API at the **Home** page of your service. Here is a simple example to index a document with curl with an index on the cluster `.logs.ovh.com`. +Logs Data Platform OpenSearch indices are compatible with the [OpenSearch REST API](https://opensearch.org/docs/latest/opensearch/rest-api/index/). Therefore, you can use simple http requests to index and search your data. The API is accessible behind a secured https endpoint with mandatory authentication. You can retrieve the endpoint of the API at the **Home** page of your service. Here is a simple example to index a document with curl on the cluster `.logs.ovh.com`. -```shell-session -$ curl -u token: -XPUT -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/logs--i-/_doc/1' -d '{ "user" : "Oles", "company" : "OVH", "message" : "Hello World !", "post_date" : "1999-11-02T23:01:00" }' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/-i-/_doc/1' -d '{ "user" : "Oles", "company" : "OVH", "message" : "Hello World !", "post_date" : "1999-11-02T23:01:00" }' ``` Here is a quick explanation of this command: - The **PUT** HTTP command can be used to create or modify a document. -- The `Content-Type: application/json` is the mandatory header to indicate that the data will be in the json format. +- The `Content-Type: application/json` is the mandatory header to indicate that the data will be in the JSON format. - The address contains the endpoint of the cluster followed by the **name of your index** -- The **test** just after the index name is the type of the document. +- The **_doc** just after the index name must be used as the type of the document. - The **1** here is the id of your document that can be any string. - The payload of the request is a simple **JSON document** that will be indexed. @@ -68,7 +140,7 @@ This command will return with a simple payload indicating if the document has be ```json { "_id": "1", - "_index": "logs--i-", + "_index": "-i-", "_primary_term": 1, "_seq_no": 0, "_shards": { @@ -86,25 +158,25 @@ This command will return with a simple payload indicating if the document has be There are multiple ways to search your data, this is one area where the OpenSearch REST API excels. You can either get your data directly by using a GET request, or search it with the Search APIs. To get your document indexed previously, use the following curl request: -```shell-session -$ curl -XGET -u token: 'https://.logs.ovh.com:9200/logs--i-/_doc/1' -{"_id":"1","_index":"logs--i-","_primary_term":1,"_seq_no":0,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc","_version":1,"found":true} +```bash +$ curl --oauth2-bearer -XGET 'https://.logs.ovh.com:9200/-i-/_doc/1' +{"_id":"1","_index":"-i-","_primary_term":1,"_seq_no":0,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc","_version":1,"found":true} ``` To issue a simple search you can either use the [Query DSL](https://opensearch.org/docs/latest/opensearch/query-dsl/index/) or a URI search. Here is a simple example with an URI search: -```shell-session -$ curl -XGET -u token: 'https://.logs.ovh.com:9200/logs--i-/_search?q=user:Oles' -{"_shards":{"failed":0,"skipped":0,"successful":1,"total":1},"hits":{"hits":[{"_id":"1","_index":"newindice","_score":0.2876821,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc"}],"max_score":0.2876821,"total":1},"timed_out":false,"took":31} +```bash +$ curl --oauth2-bearer -XGET 'https://.logs.ovh.com:9200/-i-/_search?q=user:Oles' +{"_shards":{"failed":0,"skipped":0,"successful":1,"total":1},"hits":{"hits":[{"_id":"1","_index":"-i-","_score":0.2876821,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc"}],"max_score":0.2876821,"total":1},"timed_out":false,"took":31} ``` ### Use case: Enrich Logs Data on the fly -The following shows how your e-commerce application logs can be sent to the Logs Data Platform whenever a product is ordered. It logs the customer order by using Id for the customers name. For performance reasons or maybe by-design, the application doesn't fetch the full name of the client or other information from the customer database just to produce a log. You can add this information on the fly by using an OpenSearch Index and a Logstash collector on the Logs Data Platform. +The following shows how your e-commerce application logs can be sent to the Logs Data Platform whenever a product is ordered. It logs the customer order by using ID for the customer's name. For performance reasons or maybe by design, the application doesn't fetch the full name of the client or other information from the customer database just to produce a log. You can add this information on the fly by using an OpenSearch Index and a Logstash collector on the Logs Data Platform. -#### Fill an index with clients information +#### Populate an index with clients' information -The first thing to do is to index some clients information. The snippet below is one entry of the client index. +The first thing to do is to index some client information. The snippet below is one entry of the client index. ```json { @@ -137,15 +209,15 @@ The first thing to do is to index some clients information. The snippet below is } ``` -To index several documents at once, it is more efficient to use the bulk api. Here is a small snippet of 3 users you can use to test it. +To index several documents at once, it is more efficient to use the bulk API. Here is a small snippet of 3 users you can use to test it. ```json -{ "index" : { "_index" : "logs--i-" } } -{ "userId": "1", "firstName": "Jon","lastName": "Snow", "age": 22, "address": { "streetAddress": "21 2nd Street", "city": "Winterfell", "state": "North", "postalCode": "14578", "geolocation": { "lat": 54.369488, "long": -5.574768 } },"phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-4567" } ] } -{ "index" : { "_index" : "logs--i-" } } -{ "userId": "2", "firstName": "Cersei","lastName": "Lannister", "age": 43, "address": { "streetAddress": "1 Palace Street", "city": "King's Landing", "state": "The Crownlands", "postalCode": "26863", "geolocation": { "lat": 42.639758, "long": 18.1094725 } },"phoneNumber": [ { "type": "home", "number": "212 555-6789" }, { "type": "mobile", "number": "102 555-8901" } ] } -{ "index" : { "_index" : "logs--i-" } } -{ "userId": "3", "firstName": "Daenerys","lastName": "Targaryen", "age": 22, "address": { "streetAddress": "3 Blackwater Bay Ave", "city": "Dragonstone", "state": "Dragonstone", "postalCode": "75197", "geolocation": { "lat": 43.300097, "long": -2.261580 } },"phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-2345" } ] } +{ "index" : { "_index" : "-i-" } } +{ "userId": "1", "firstName": "Jon","lastName": "Snow", "age": 22, "address": { "streetAddress": "21 2nd Street", "city": "Winterfell", "state": "North", "postalCode": "14578", "geolocation": { "lat": 54.369488, "long": -5.574768 } }, "phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-4567" } ] } +{ "index" : { "_index" : "-i-" } } +{ "userId": "2", "firstName": "Cersei","lastName": "Lannister", "age": 43, "address": { "streetAddress": "1 Palace Street", "city": "King's Landing", "state": "The Crownlands", "postalCode": "26863", "geolocation": { "lat": 42.639758, "long": 18.1094725 } }, "phoneNumber": [ { "type": "home", "number": "212 555-6789" }, { "type": "mobile", "number": "102 555-8901" } ] } +{ "index" : { "_index" : "-i-" } } +{ "userId": "3", "firstName": "Daenerys","lastName": "Targaryen", "age": 22, "address": { "streetAddress": "3 Blackwater Bay Ave", "city": "Dragonstone", "state": "Dragonstone", "postalCode": "75197", "geolocation": { "lat": 43.300097, "long": -2.261580 } }, "phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-2345" } ] } ``` A bulk request is a succession of JSON objects with this structure: @@ -162,14 +234,14 @@ A bulk request is a succession of JSON objects with this structure: You can in one request ask OpenSearch to index, update, delete several documents. Save the content of the previous JSON lines in a file named **bulk** and use the following call to index these 3 users: -```shell-session -$ curl -u token: -XPUT -H 'Content-Type: application/x-ndjson' 'https://.logs.ovh.com:9200/logs--i-/_bulk' --data-binary "@bulk" +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/x-ndjson' 'https://.logs.ovh.com:9200/-i-/_bulk' --data-binary "@bulk" ``` This call will take the content of the bulk file and execute each index operation. Note that you have to use the option **--data-binary** and no **-d** to preserve the newline after each JSON. You can check that your data are properly indexed with the following call: -```shell-session -$ curl -u token: -XGET 'https://.logs.ovh.com:9200/logs--i-/_search?pretty=true' +```bash +$ curl --oauth2-bearer -XGET 'https://.logs.ovh.com:9200/-i-/_search?pretty=true' ``` This will give you back the documents of your index: @@ -187,7 +259,7 @@ This will give you back the documents of your index: "total" : 3, "max_score" : 1.0, "hits" : [ { - "_index" : "logs--i-", + "_index" : "-i-", "_type" : "_doc", "_id" : "AV3HvbQAz85mIBfrJjkV", "_score" : 1.0, @@ -215,7 +287,7 @@ This will give you back the documents of your index: } ] } }, { - "_index" : "logs--i-", + "_index" : "-i-", "_type" : "_doc", "_id" : "AV3HvbQAz85mIBfrJjkW", "_score" : 1.0, @@ -243,7 +315,7 @@ This will give you back the documents of your index: } ] } }, { - "_index" : "logs--i-", + "_index" : "-i-", "_type" : "_doc", "_id" : "AV3HvbQAz85mIBfrJjkX", "_score" : 1.0, @@ -299,9 +371,9 @@ The most important part in this configuration is the filter part: ```ruby opensearch { hosts => ["https://gra2.logs.ovh.com:9200"] - index => "logs--i-" - user => "" - password => "" + index => "-i-" + user => "pat_jwt_logstash" + password => "" enable_sort => false query => "userId:%{[userId]}" fields => { @@ -337,7 +409,7 @@ The mutate plugin is here to show you how you can combine different subfield inf One simple way to test your new Logstash configuration is to send a log by using echo and openssl. Check the examples below: -```shell-session +```bash $ echo -e '{"version":"1.1", "host": "little bird", "short_message": "Warrior from the North", "level":1, "_userId": "2", "_unitType": "Westerosis", "_power_num": 200 }'\0 | openssl s_client -quiet -no_ign_eof -connect : $ echo -e '{"version":"1.1", "host": "little bird", "short_message": "A legendary dragon", "level":1, "_userId": "3", "_unitType": "Dragon", "_power_num": 200000 }'\0 | openssl s_client -quiet -no_ign_eof -connect : ``` @@ -368,7 +440,7 @@ The **maximum size** of your index is fixed and is dependent on the number of sh Note that you can monitor the size of the index by using the following curl query: ```shell-session -$ curl -u token: -XGET -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/logs--i-/_stats/store?pretty' +$ curl --oauth2-bearer -XGET -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/-i-/_stats/store?pretty' ``` This command will give you a document with the following format: @@ -393,7 +465,7 @@ This command will give you a document with the following format: } }, "indices" : { - "logs--i-" : { + "-i-" : { "uuid" : "JC0IWkd3QYSBNd4B2bBZGg", "primaries" : { "store" : { @@ -411,7 +483,7 @@ This command will give you a document with the following format: ``` The size in bytes used to compute your billing is the one under the following path: -"indices" -> "logs--i-" -> "primaries" -> "store" -> "size\_in\_bytes". +"indices" -> "-i-" -> "primaries" -> "store" -> "size\_in\_bytes". ### Management through OpenSearch API @@ -421,8 +493,8 @@ On Logs Data Platform, we allow users to use OpenSearch API to handle the lifecy To create an index on Logs Data Platform, use the following call: -```shell-session -$ curl -u : -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' -d '{ "settings" : {"number_of_shards" : 1}}' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' -d '{ "settings" : {"number_of_shards" : 1}}' ``` - The **-u** option is followed by your LDP username that you can find on **Home** page. The password 'mypassword' follows it after the separator ':' @@ -431,22 +503,22 @@ $ curl -u : -XPUT -H 'Content-Type: application/json' 'htt - The address contains the endpoint of the cluster followed by the **name of your index** - The payload of the request is a **JSON document** which contains the [settings of your index](https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/create-index/): the number of shards (the number of replicas will be automatically set at 1). -You have to follow the Logs Data Platform naming convention `-i-` to create your index. Your username is the one you use to connect to Graylog or to use the API. The suffix can contain any alphanumeric character. +You have to follow the Logs Data Platform naming convention `-i-` to create your index. Your service name can be found on the home page of the Logs Data Platform control panel. The suffix can contain any alphanumeric characters. -To delete a index use the following call: +To delete an index use the following call: -```shell-session -$ curl -u : -XDELETE -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' +```bash +$ curl --oauth2-bearer -XDELETE -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' ``` Here we use the **DELETE** HTTP command to delete the index. #### Alias creation and deletion -Similarly than indices, you can use the API Calls to delete and create aliases on your indices. The only difference is the convention for the name of your alias. Your alias must be formatted as the following **`-a-`**. Here is an example call: +Similarly than indices, you can use the API Calls to delete and create aliases on your indices. The only difference is the convention for the name of your alias. Your alias must be formatted as the following **`-a-`** (or -a- for legacy users). Here is an example call: -```shell-session -$ curl -u : -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-/_alias/-a-' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-/_alias/-a-' ``` This call creates a individual alias on one index you have previously created. @@ -455,13 +527,13 @@ If you need more information on aliases, you can check the [OpenSearch Documenta We also support the aliases API to create aliases: -```shell-session -$ curl -XPOST "https://gra2.logs.ovh.com:9200/_aliases?pretty" -H 'Content-Type: application/json' -d' +```bash +$ curl --oauth2-bearer -XPOST "https://gra2.logs.ovh.com:9200/_aliases?pretty" -H 'Content-Type: application/json' -d' { "actions" : [ - { "remove" : { "index" : "-i-", "alias" : "-a-" } }, - { "add" : { "index" : "-i-", "alias" : "-a-" } }, - { "remove_index": { "index": "-i-" } } + { "remove" : { "index" : "-i-", "alias" : "-a-" } }, + { "add" : { "index" : "-i-", "alias" : "-a-" } }, + { "remove_index": { "index": "-i-" } } ] }' ``` @@ -472,22 +544,22 @@ All the actions (alias change, alias creation and index deletion) will be done i Logs Data Platform supports your custom templates. As for indices and aliases, the template must follow some rules in order for them to work: -- the template name must contain your **``** inside the name. It can be anywhere in the name string. -- The prefix of the indices involved in the template MUST start by **`-i-`**, the "\*" character must be after this prefix -- The alias attached to your template must follow the usual convention: **`-a-`** +- the template name must contain your **``** inside the name. It can be anywhere in the name string. +- The prefix of the indices involved in the template MUST start by one your allowed services so **`-i-`**, the "\*" character must be after this prefix +- The alias attached to your template must follow the usual convention: **`-a-`** -Here is an example of a template for a user **logs-ab-12345**: +Here is an example of a template for a service **ldp-ab-12345**: -```shell-session -$ curl -u : -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/_template/template_for_logs-ab-12345_indices' -d ' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/_template/template_for_ldp-ab-12345_indices' -d ' { - "index_patterns" : [ "logs-ab-12345-i-debug*","logs-ab-12345-i-test*" ], + "index_patterns" : [ "ldp-ab-12345-i-debug*","ldp-ab-12345-i-test*" ], "settings": { "number_of_shards" : 1 }, "aliases" : { - "logs-ab-12345-a-all" : {}, - "logs-ab-12345-a-debug" : { "filter" : { "term" : { "type" : "debug" } } } + "ldp-ab-12345-a-all" : {}, + "ldp-ab-12345-a-debug" : { "filter" : { "term" : { "type" : "debug" } } } } }' ``` @@ -507,8 +579,8 @@ Here the first index was create through API, its description was filled automati Index as a service has some specificities on our platforms. This additional and technical information can help you to use it properly: - **Replication** is set at 1 and cannot be changed. We ensure the high availability of your index in case of a hardware failure. -- The **maximum size** of your index is fixed and is dependent on the number of shards. If search performance is critical, you should choose an index with the highest number of shard you can afford. -- The **index_refresh_interval** of the index is set at 1 second ensuring near real time search results. +- The **maximum size** of your index is fixed and is dependent on the number of shards. If search performance is critical, you should choose the highest number of shards you can afford. +- The **index_refresh_interval** of the index is set at 1 second, ensuring near real time search results. - You are not allowed to change the settings of your index. - You can create an **alias** on Logs Data Platform and attach it to one or several indices. - Unlike indices, aliases are **read-only**, you cannot write through an alias yet. @@ -519,4 +591,4 @@ Index as a service has some specificities on our platforms. This additional and - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.en-ca.md b/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.en-ca.md index 59deae3fe93..78216c98ff6 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.en-ca.md +++ b/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.en-ca.md @@ -1,25 +1,25 @@ --- title: OpenSearch Index as a Service excerpt: Use the power of OpenSearch without managing a cluster. -updated: 2024-08-07 +updated: 2025-10-16 --- ## Objective -OpenSearch is one of the main components of the Logs Data Platform, regarded as one of the most powerful search and analytics engines. From the outset we offered the possibility to host an OpenSearch Dashboards index for your OpenSearch Dashboards metadata, Index As A Service being the next step to this functionality. You can now use a fully unlocked index for almost any purpose; be it complex documents, reports or even logs. Thanks to the OpenSearch API, you will be able to use most of the tools of the OpenSearch Ecosystem. +OpenSearch is one of the main components of the Logs Data Platform, regarded as one of the most powerful search and analytics engines. From the outset we offered the possibility to host an OpenSearch Dashboards index for your OpenSearch Dashboards metadata. Index As A Service is the next step. You can now use a fully unlocked index for almost any purpose; be it complex documents, reports or even logs. Thanks to the OpenSearch API, you will be able to use most of the tools of the OpenSearch Ecosystem. ## Requirements This is what you need to know to get you started: - You have created a [Logs Data Platform account](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- You have access to the port 9200 of your cluster (head to the **Home** page in manager to know the address of your cluster). +- You have access to the port 9200 of your cluster (go to the **Home** page in manager to know the address of your cluster). ## Instructions ### First steps with an OpenSearch index -#### Create an index +#### Index name conventions There are two ways to create an OpenSearch Index: @@ -30,36 +30,108 @@ To create an OpenSearch index with the Logs Data Platform manager, you need to g ![add index option](images/add_index.png){.thumbnail} -You must just choose a suffix for your index. The final name will follow this convention: +Simply choose a suffix for your index. The final name will follow this convention: -`logs--i-`. +`-i-`. -For each index, you can specify the number of **shards**. A **shard** is the main component of an **index**. Its maximum storage capacity is set to **25 GB** (per shard). Multiple shards means more volume, more parallelism in your requests and thus more performance. Optionally, you can also be notified when your index is close to its critical size. Once your index is created, you can use it right away. +The service name is the identifier of your Logs Data Platform service. It is different from the username used by non IAM users. The service name starts with `ldp` (e.g. `ldp-ab-12345`). On the other hand, the username starts with `logs` (e.g. `logs-ab-12345`). In this guide we will use **** or **** as tags to let you differentiate both usages. You can find both pieces of information in the **Logs Data Platform control panel**. -When you create an index through the [OpenSearch API](https://opensearch.org/docs/latest/opensearch/index-data/), you can also specify the number of shards. Note that the maximum number of shards by index is limited to **16**. OpenSearch compatible tools can now create indices on the cluster as long as they follow the naming convention `logs--i-`. Here is an example with a curl command with the user **logs-ab-12345** and the index **logs-ab-12345-i-another-index** on gra2 cluster. +> [!primary] +> +> Prior to IAM migration the prefix was . It has now been changed to for all indices created after 17 September 2025. +> -```shell-session -$ curl -u logs-ab-12345:mypassword -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/logs-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 1}}' +For each index, you can specify the number of **shards**. A **shard** is the main component of an **index**. Its maximum storage capacity is set to **25 GB** (per shard). Multiple shards mean more volume, more parallelism in your requests and thus more performance. Optionally, you can also be notified when your index is close to its critical size. Once your index is created, you can use it right away. + +When you create an index through the [OpenSearch API](https://opensearch.org/docs/latest/opensearch/index-data/), you can also specify the number of shards. Note that the maximum number of shards per index is limited to **16**. OpenSearch compatible tools can now create indices on the cluster as long as they follow the naming conventions. + +#### IAM configuration + +If you have enabled [IAM on your account](/pages/manage_and_operate/observability/logs_data_platform/iam_presentation_faq/) you first need to create a policy and give the creation rights to your preferred user/account. See the [IAM for LDP documentation policy guide](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). + +The rights relative to the management of OpenSearch items through the **OVHcloud APIs** are: + + +|Rights |LDP product types|Description| +|---------------------------------------------------|-----------------|-----------| +|ldp:apiovh:url/get |service |Get Logs Data Platform service useful urls| +|ldp:apiovh:output/opensearch/index/create |service |Order a new OpenSearch index over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/create |service |Create a new OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/get |alias |Get OpenSearch aliases over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/edit |alias |Update an OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/index/attach |alias |Attach an OpenSearch index to a OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/index/detach |alias |Detach an OpenSearch index to a OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/delete |alias |Delete an OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/index/get |index |Get OpenSearch indexes over OVHcloud API| +|ldp:apiovh:output/opensearch/index/url/get |index |Get urls of an OpenSearch index over OVHcloud API| +|ldp:apiovh:output/opensearch/index/edit |index |Update an OpenSearch index over OVHcloud API| +|ldp:apiovh:output/opensearch/index/delete |index |Delete an OpenSearch index over OVHcloud API| + + +The rights relative to the management of OpenSearch items through the **OpenSearch API** are: + + +|Rights |LDP product types|Description| +|---------------------------------------------------|-----------------|-----------| +|ldp:opensearch:index/create |service |Create an index over OpenSearch API| +|ldp:opensearch:alias/create |service |Create an alias over OpenSearch API| +|ldp:opensearch:alias/read |alias |Read an alias's contents over OpenSearch API| +|ldp:opensearch:alias/delete |alias |Delete an alias over OpenSearch API| +|ldp:opensearch:index/read |index |Read an index content over OpenSearch API| +|ldp:opensearch:index/write |index |Write content to an index over OpenSearch API| +|ldp:opensearch:index/delete |index |Delete an index over OpenSearch API| + +Attach these rights to your policies freely whether you need to interact directly with the OpenSearch API or through the manager. + +The prefix of all indices or aliases created is . Example: ldp-ab-12345-i-my-awesome-index. +To interact with the OpenSearch API, you can either create [service accounts](/pages/account_and_service_management/account_information/authenticate-api-with-service-account) and leverage the OpenID workflow, or create [local users](/pages/account_and_service_management/account_information/ovhcloud-users-management) with their Personal Access Token with the API: + +> [!api] +> +> @api {v1} /me POST /me/identity/user/{user}/token +> + +This call will return a bearer token for a specific local user. + +You can then use the token of your user to create an index or write documents to your indices. + +```bash +ldp@laptop curl -H 'content-type: application/json' --oauth2-bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c -XPUT 'https://gra2.logs.ovh.com:9200/ldp-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 2}}' +``` + +You can alternatively use the basic scheme authentication with your bearer token as a password for systems that don't support a bearer token (or a custom Authentication Bearer header). The only constraint is to use a username starting with the prefix **pat_jwt_**. For example: + +```bash +ldp@laptop curl -H 'content-type: application/json' -u pat_jwt_user_one:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c -XPUT 'https://gra2.logs.ovh.com:9200/ldp-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 2}}' ``` -There is more information about the API Support at the [dedicated section](#management-through-opensearch-api). +Here, in both examples, the index created will have 2 shards and will appear in your panel. You can then attach it to an IAM policy. + +#### Legacy users + +If you don't have IAM enabled on your account (which will be deprecated) the prefix of indices is `:`. + +Here is an example with a curl command with the user **logs-ab-12345** and the index **logs-ab-12345-i-another-index** on gra2 cluster: + +```bash +$ curl -u logs-ab-12345:mypassword -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/logs-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 1}}' +``` -Whatever method you use, you will be able to query and visualize your documents on Logs Data Platform using the API. #### Index some data -Logs Data Platform OpenSearch indices are compatible with the [OpenSearch REST API](https://opensearch.org/docs/latest/opensearch/rest-api/index/). Therefore, you can use simple http requests to index and search your data. The API is accessible behind a secured https endpoint with mandatory authentication. We recommend that you use [tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens) to authenticate yourself. You can retrieve the endpoint of the API at the **Home** page of your service. Here is a simple example to index a document with curl with an index on the cluster `.logs.ovh.com`. +Logs Data Platform OpenSearch indices are compatible with the [OpenSearch REST API](https://opensearch.org/docs/latest/opensearch/rest-api/index/). Therefore, you can use simple http requests to index and search your data. The API is accessible behind a secured https endpoint with mandatory authentication. You can retrieve the endpoint of the API at the **Home** page of your service. Here is a simple example to index a document with curl on the cluster `.logs.ovh.com`. -```shell-session -$ curl -u token: -XPUT -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/logs--i-/_doc/1' -d '{ "user" : "Oles", "company" : "OVH", "message" : "Hello World !", "post_date" : "1999-11-02T23:01:00" }' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/-i-/_doc/1' -d '{ "user" : "Oles", "company" : "OVH", "message" : "Hello World !", "post_date" : "1999-11-02T23:01:00" }' ``` Here is a quick explanation of this command: - The **PUT** HTTP command can be used to create or modify a document. -- The `Content-Type: application/json` is the mandatory header to indicate that the data will be in the json format. +- The `Content-Type: application/json` is the mandatory header to indicate that the data will be in the JSON format. - The address contains the endpoint of the cluster followed by the **name of your index** -- The **test** just after the index name is the type of the document. +- The **_doc** just after the index name must be used as the type of the document. - The **1** here is the id of your document that can be any string. - The payload of the request is a simple **JSON document** that will be indexed. @@ -68,7 +140,7 @@ This command will return with a simple payload indicating if the document has be ```json { "_id": "1", - "_index": "logs--i-", + "_index": "-i-", "_primary_term": 1, "_seq_no": 0, "_shards": { @@ -86,25 +158,25 @@ This command will return with a simple payload indicating if the document has be There are multiple ways to search your data, this is one area where the OpenSearch REST API excels. You can either get your data directly by using a GET request, or search it with the Search APIs. To get your document indexed previously, use the following curl request: -```shell-session -$ curl -XGET -u token: 'https://.logs.ovh.com:9200/logs--i-/_doc/1' -{"_id":"1","_index":"logs--i-","_primary_term":1,"_seq_no":0,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc","_version":1,"found":true} +```bash +$ curl --oauth2-bearer -XGET 'https://.logs.ovh.com:9200/-i-/_doc/1' +{"_id":"1","_index":"-i-","_primary_term":1,"_seq_no":0,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc","_version":1,"found":true} ``` To issue a simple search you can either use the [Query DSL](https://opensearch.org/docs/latest/opensearch/query-dsl/index/) or a URI search. Here is a simple example with an URI search: -```shell-session -$ curl -XGET -u token: 'https://.logs.ovh.com:9200/logs--i-/_search?q=user:Oles' -{"_shards":{"failed":0,"skipped":0,"successful":1,"total":1},"hits":{"hits":[{"_id":"1","_index":"newindice","_score":0.2876821,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc"}],"max_score":0.2876821,"total":1},"timed_out":false,"took":31} +```bash +$ curl --oauth2-bearer -XGET 'https://.logs.ovh.com:9200/-i-/_search?q=user:Oles' +{"_shards":{"failed":0,"skipped":0,"successful":1,"total":1},"hits":{"hits":[{"_id":"1","_index":"-i-","_score":0.2876821,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc"}],"max_score":0.2876821,"total":1},"timed_out":false,"took":31} ``` ### Use case: Enrich Logs Data on the fly -The following shows how your e-commerce application logs can be sent to the Logs Data Platform whenever a product is ordered. It logs the customer order by using Id for the customers name. For performance reasons or maybe by-design, the application doesn't fetch the full name of the client or other information from the customer database just to produce a log. You can add this information on the fly by using an OpenSearch Index and a Logstash collector on the Logs Data Platform. +The following shows how your e-commerce application logs can be sent to the Logs Data Platform whenever a product is ordered. It logs the customer order by using ID for the customer's name. For performance reasons or maybe by design, the application doesn't fetch the full name of the client or other information from the customer database just to produce a log. You can add this information on the fly by using an OpenSearch Index and a Logstash collector on the Logs Data Platform. -#### Fill an index with clients information +#### Populate an index with clients' information -The first thing to do is to index some clients information. The snippet below is one entry of the client index. +The first thing to do is to index some client information. The snippet below is one entry of the client index. ```json { @@ -137,15 +209,15 @@ The first thing to do is to index some clients information. The snippet below is } ``` -To index several documents at once, it is more efficient to use the bulk api. Here is a small snippet of 3 users you can use to test it. +To index several documents at once, it is more efficient to use the bulk API. Here is a small snippet of 3 users you can use to test it. ```json -{ "index" : { "_index" : "logs--i-" } } -{ "userId": "1", "firstName": "Jon","lastName": "Snow", "age": 22, "address": { "streetAddress": "21 2nd Street", "city": "Winterfell", "state": "North", "postalCode": "14578", "geolocation": { "lat": 54.369488, "long": -5.574768 } },"phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-4567" } ] } -{ "index" : { "_index" : "logs--i-" } } -{ "userId": "2", "firstName": "Cersei","lastName": "Lannister", "age": 43, "address": { "streetAddress": "1 Palace Street", "city": "King's Landing", "state": "The Crownlands", "postalCode": "26863", "geolocation": { "lat": 42.639758, "long": 18.1094725 } },"phoneNumber": [ { "type": "home", "number": "212 555-6789" }, { "type": "mobile", "number": "102 555-8901" } ] } -{ "index" : { "_index" : "logs--i-" } } -{ "userId": "3", "firstName": "Daenerys","lastName": "Targaryen", "age": 22, "address": { "streetAddress": "3 Blackwater Bay Ave", "city": "Dragonstone", "state": "Dragonstone", "postalCode": "75197", "geolocation": { "lat": 43.300097, "long": -2.261580 } },"phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-2345" } ] } +{ "index" : { "_index" : "-i-" } } +{ "userId": "1", "firstName": "Jon","lastName": "Snow", "age": 22, "address": { "streetAddress": "21 2nd Street", "city": "Winterfell", "state": "North", "postalCode": "14578", "geolocation": { "lat": 54.369488, "long": -5.574768 } }, "phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-4567" } ] } +{ "index" : { "_index" : "-i-" } } +{ "userId": "2", "firstName": "Cersei","lastName": "Lannister", "age": 43, "address": { "streetAddress": "1 Palace Street", "city": "King's Landing", "state": "The Crownlands", "postalCode": "26863", "geolocation": { "lat": 42.639758, "long": 18.1094725 } }, "phoneNumber": [ { "type": "home", "number": "212 555-6789" }, { "type": "mobile", "number": "102 555-8901" } ] } +{ "index" : { "_index" : "-i-" } } +{ "userId": "3", "firstName": "Daenerys","lastName": "Targaryen", "age": 22, "address": { "streetAddress": "3 Blackwater Bay Ave", "city": "Dragonstone", "state": "Dragonstone", "postalCode": "75197", "geolocation": { "lat": 43.300097, "long": -2.261580 } }, "phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-2345" } ] } ``` A bulk request is a succession of JSON objects with this structure: @@ -162,14 +234,14 @@ A bulk request is a succession of JSON objects with this structure: You can in one request ask OpenSearch to index, update, delete several documents. Save the content of the previous JSON lines in a file named **bulk** and use the following call to index these 3 users: -```shell-session -$ curl -u token: -XPUT -H 'Content-Type: application/x-ndjson' 'https://.logs.ovh.com:9200/logs--i-/_bulk' --data-binary "@bulk" +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/x-ndjson' 'https://.logs.ovh.com:9200/-i-/_bulk' --data-binary "@bulk" ``` This call will take the content of the bulk file and execute each index operation. Note that you have to use the option **--data-binary** and no **-d** to preserve the newline after each JSON. You can check that your data are properly indexed with the following call: -```shell-session -$ curl -u token: -XGET 'https://.logs.ovh.com:9200/logs--i-/_search?pretty=true' +```bash +$ curl --oauth2-bearer -XGET 'https://.logs.ovh.com:9200/-i-/_search?pretty=true' ``` This will give you back the documents of your index: @@ -187,7 +259,7 @@ This will give you back the documents of your index: "total" : 3, "max_score" : 1.0, "hits" : [ { - "_index" : "logs--i-", + "_index" : "-i-", "_type" : "_doc", "_id" : "AV3HvbQAz85mIBfrJjkV", "_score" : 1.0, @@ -215,7 +287,7 @@ This will give you back the documents of your index: } ] } }, { - "_index" : "logs--i-", + "_index" : "-i-", "_type" : "_doc", "_id" : "AV3HvbQAz85mIBfrJjkW", "_score" : 1.0, @@ -243,7 +315,7 @@ This will give you back the documents of your index: } ] } }, { - "_index" : "logs--i-", + "_index" : "-i-", "_type" : "_doc", "_id" : "AV3HvbQAz85mIBfrJjkX", "_score" : 1.0, @@ -299,9 +371,9 @@ The most important part in this configuration is the filter part: ```ruby opensearch { hosts => ["https://gra2.logs.ovh.com:9200"] - index => "logs--i-" - user => "" - password => "" + index => "-i-" + user => "pat_jwt_logstash" + password => "" enable_sort => false query => "userId:%{[userId]}" fields => { @@ -337,7 +409,7 @@ The mutate plugin is here to show you how you can combine different subfield inf One simple way to test your new Logstash configuration is to send a log by using echo and openssl. Check the examples below: -```shell-session +```bash $ echo -e '{"version":"1.1", "host": "little bird", "short_message": "Warrior from the North", "level":1, "_userId": "2", "_unitType": "Westerosis", "_power_num": 200 }'\0 | openssl s_client -quiet -no_ign_eof -connect : $ echo -e '{"version":"1.1", "host": "little bird", "short_message": "A legendary dragon", "level":1, "_userId": "3", "_unitType": "Dragon", "_power_num": 200000 }'\0 | openssl s_client -quiet -no_ign_eof -connect : ``` @@ -368,7 +440,7 @@ The **maximum size** of your index is fixed and is dependent on the number of sh Note that you can monitor the size of the index by using the following curl query: ```shell-session -$ curl -u token: -XGET -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/logs--i-/_stats/store?pretty' +$ curl --oauth2-bearer -XGET -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/-i-/_stats/store?pretty' ``` This command will give you a document with the following format: @@ -393,7 +465,7 @@ This command will give you a document with the following format: } }, "indices" : { - "logs--i-" : { + "-i-" : { "uuid" : "JC0IWkd3QYSBNd4B2bBZGg", "primaries" : { "store" : { @@ -411,7 +483,7 @@ This command will give you a document with the following format: ``` The size in bytes used to compute your billing is the one under the following path: -"indices" -> "logs--i-" -> "primaries" -> "store" -> "size\_in\_bytes". +"indices" -> "-i-" -> "primaries" -> "store" -> "size\_in\_bytes". ### Management through OpenSearch API @@ -421,8 +493,8 @@ On Logs Data Platform, we allow users to use OpenSearch API to handle the lifecy To create an index on Logs Data Platform, use the following call: -```shell-session -$ curl -u : -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' -d '{ "settings" : {"number_of_shards" : 1}}' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' -d '{ "settings" : {"number_of_shards" : 1}}' ``` - The **-u** option is followed by your LDP username that you can find on **Home** page. The password 'mypassword' follows it after the separator ':' @@ -431,22 +503,22 @@ $ curl -u : -XPUT -H 'Content-Type: application/json' 'htt - The address contains the endpoint of the cluster followed by the **name of your index** - The payload of the request is a **JSON document** which contains the [settings of your index](https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/create-index/): the number of shards (the number of replicas will be automatically set at 1). -You have to follow the Logs Data Platform naming convention `-i-` to create your index. Your username is the one you use to connect to Graylog or to use the API. The suffix can contain any alphanumeric character. +You have to follow the Logs Data Platform naming convention `-i-` to create your index. Your service name can be found on the home page of the Logs Data Platform control panel. The suffix can contain any alphanumeric characters. -To delete a index use the following call: +To delete an index use the following call: -```shell-session -$ curl -u : -XDELETE -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' +```bash +$ curl --oauth2-bearer -XDELETE -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' ``` Here we use the **DELETE** HTTP command to delete the index. #### Alias creation and deletion -Similarly than indices, you can use the API Calls to delete and create aliases on your indices. The only difference is the convention for the name of your alias. Your alias must be formatted as the following **`-a-`**. Here is an example call: +Similarly than indices, you can use the API Calls to delete and create aliases on your indices. The only difference is the convention for the name of your alias. Your alias must be formatted as the following **`-a-`** (or -a- for legacy users). Here is an example call: -```shell-session -$ curl -u : -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-/_alias/-a-' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-/_alias/-a-' ``` This call creates a individual alias on one index you have previously created. @@ -455,13 +527,13 @@ If you need more information on aliases, you can check the [OpenSearch Documenta We also support the aliases API to create aliases: -```shell-session -$ curl -XPOST "https://gra2.logs.ovh.com:9200/_aliases?pretty" -H 'Content-Type: application/json' -d' +```bash +$ curl --oauth2-bearer -XPOST "https://gra2.logs.ovh.com:9200/_aliases?pretty" -H 'Content-Type: application/json' -d' { "actions" : [ - { "remove" : { "index" : "-i-", "alias" : "-a-" } }, - { "add" : { "index" : "-i-", "alias" : "-a-" } }, - { "remove_index": { "index": "-i-" } } + { "remove" : { "index" : "-i-", "alias" : "-a-" } }, + { "add" : { "index" : "-i-", "alias" : "-a-" } }, + { "remove_index": { "index": "-i-" } } ] }' ``` @@ -472,22 +544,22 @@ All the actions (alias change, alias creation and index deletion) will be done i Logs Data Platform supports your custom templates. As for indices and aliases, the template must follow some rules in order for them to work: -- the template name must contain your **``** inside the name. It can be anywhere in the name string. -- The prefix of the indices involved in the template MUST start by **`-i-`**, the "\*" character must be after this prefix -- The alias attached to your template must follow the usual convention: **`-a-`** +- the template name must contain your **``** inside the name. It can be anywhere in the name string. +- The prefix of the indices involved in the template MUST start by one your allowed services so **`-i-`**, the "\*" character must be after this prefix +- The alias attached to your template must follow the usual convention: **`-a-`** -Here is an example of a template for a user **logs-ab-12345**: +Here is an example of a template for a service **ldp-ab-12345**: -```shell-session -$ curl -u : -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/_template/template_for_logs-ab-12345_indices' -d ' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/_template/template_for_ldp-ab-12345_indices' -d ' { - "index_patterns" : [ "logs-ab-12345-i-debug*","logs-ab-12345-i-test*" ], + "index_patterns" : [ "ldp-ab-12345-i-debug*","ldp-ab-12345-i-test*" ], "settings": { "number_of_shards" : 1 }, "aliases" : { - "logs-ab-12345-a-all" : {}, - "logs-ab-12345-a-debug" : { "filter" : { "term" : { "type" : "debug" } } } + "ldp-ab-12345-a-all" : {}, + "ldp-ab-12345-a-debug" : { "filter" : { "term" : { "type" : "debug" } } } } }' ``` @@ -507,8 +579,8 @@ Here the first index was create through API, its description was filled automati Index as a service has some specificities on our platforms. This additional and technical information can help you to use it properly: - **Replication** is set at 1 and cannot be changed. We ensure the high availability of your index in case of a hardware failure. -- The **maximum size** of your index is fixed and is dependent on the number of shards. If search performance is critical, you should choose an index with the highest number of shard you can afford. -- The **index_refresh_interval** of the index is set at 1 second ensuring near real time search results. +- The **maximum size** of your index is fixed and is dependent on the number of shards. If search performance is critical, you should choose the highest number of shards you can afford. +- The **index_refresh_interval** of the index is set at 1 second, ensuring near real time search results. - You are not allowed to change the settings of your index. - You can create an **alias** on Logs Data Platform and attach it to one or several indices. - Unlike indices, aliases are **read-only**, you cannot write through an alias yet. @@ -519,4 +591,4 @@ Index as a service has some specificities on our platforms. This additional and - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.en-gb.md b/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.en-gb.md index 59deae3fe93..78216c98ff6 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.en-gb.md +++ b/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.en-gb.md @@ -1,25 +1,25 @@ --- title: OpenSearch Index as a Service excerpt: Use the power of OpenSearch without managing a cluster. -updated: 2024-08-07 +updated: 2025-10-16 --- ## Objective -OpenSearch is one of the main components of the Logs Data Platform, regarded as one of the most powerful search and analytics engines. From the outset we offered the possibility to host an OpenSearch Dashboards index for your OpenSearch Dashboards metadata, Index As A Service being the next step to this functionality. You can now use a fully unlocked index for almost any purpose; be it complex documents, reports or even logs. Thanks to the OpenSearch API, you will be able to use most of the tools of the OpenSearch Ecosystem. +OpenSearch is one of the main components of the Logs Data Platform, regarded as one of the most powerful search and analytics engines. From the outset we offered the possibility to host an OpenSearch Dashboards index for your OpenSearch Dashboards metadata. Index As A Service is the next step. You can now use a fully unlocked index for almost any purpose; be it complex documents, reports or even logs. Thanks to the OpenSearch API, you will be able to use most of the tools of the OpenSearch Ecosystem. ## Requirements This is what you need to know to get you started: - You have created a [Logs Data Platform account](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- You have access to the port 9200 of your cluster (head to the **Home** page in manager to know the address of your cluster). +- You have access to the port 9200 of your cluster (go to the **Home** page in manager to know the address of your cluster). ## Instructions ### First steps with an OpenSearch index -#### Create an index +#### Index name conventions There are two ways to create an OpenSearch Index: @@ -30,36 +30,108 @@ To create an OpenSearch index with the Logs Data Platform manager, you need to g ![add index option](images/add_index.png){.thumbnail} -You must just choose a suffix for your index. The final name will follow this convention: +Simply choose a suffix for your index. The final name will follow this convention: -`logs--i-`. +`-i-`. -For each index, you can specify the number of **shards**. A **shard** is the main component of an **index**. Its maximum storage capacity is set to **25 GB** (per shard). Multiple shards means more volume, more parallelism in your requests and thus more performance. Optionally, you can also be notified when your index is close to its critical size. Once your index is created, you can use it right away. +The service name is the identifier of your Logs Data Platform service. It is different from the username used by non IAM users. The service name starts with `ldp` (e.g. `ldp-ab-12345`). On the other hand, the username starts with `logs` (e.g. `logs-ab-12345`). In this guide we will use **** or **** as tags to let you differentiate both usages. You can find both pieces of information in the **Logs Data Platform control panel**. -When you create an index through the [OpenSearch API](https://opensearch.org/docs/latest/opensearch/index-data/), you can also specify the number of shards. Note that the maximum number of shards by index is limited to **16**. OpenSearch compatible tools can now create indices on the cluster as long as they follow the naming convention `logs--i-`. Here is an example with a curl command with the user **logs-ab-12345** and the index **logs-ab-12345-i-another-index** on gra2 cluster. +> [!primary] +> +> Prior to IAM migration the prefix was . It has now been changed to for all indices created after 17 September 2025. +> -```shell-session -$ curl -u logs-ab-12345:mypassword -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/logs-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 1}}' +For each index, you can specify the number of **shards**. A **shard** is the main component of an **index**. Its maximum storage capacity is set to **25 GB** (per shard). Multiple shards mean more volume, more parallelism in your requests and thus more performance. Optionally, you can also be notified when your index is close to its critical size. Once your index is created, you can use it right away. + +When you create an index through the [OpenSearch API](https://opensearch.org/docs/latest/opensearch/index-data/), you can also specify the number of shards. Note that the maximum number of shards per index is limited to **16**. OpenSearch compatible tools can now create indices on the cluster as long as they follow the naming conventions. + +#### IAM configuration + +If you have enabled [IAM on your account](/pages/manage_and_operate/observability/logs_data_platform/iam_presentation_faq/) you first need to create a policy and give the creation rights to your preferred user/account. See the [IAM for LDP documentation policy guide](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). + +The rights relative to the management of OpenSearch items through the **OVHcloud APIs** are: + + +|Rights |LDP product types|Description| +|---------------------------------------------------|-----------------|-----------| +|ldp:apiovh:url/get |service |Get Logs Data Platform service useful urls| +|ldp:apiovh:output/opensearch/index/create |service |Order a new OpenSearch index over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/create |service |Create a new OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/get |alias |Get OpenSearch aliases over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/edit |alias |Update an OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/index/attach |alias |Attach an OpenSearch index to a OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/index/detach |alias |Detach an OpenSearch index to a OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/delete |alias |Delete an OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/index/get |index |Get OpenSearch indexes over OVHcloud API| +|ldp:apiovh:output/opensearch/index/url/get |index |Get urls of an OpenSearch index over OVHcloud API| +|ldp:apiovh:output/opensearch/index/edit |index |Update an OpenSearch index over OVHcloud API| +|ldp:apiovh:output/opensearch/index/delete |index |Delete an OpenSearch index over OVHcloud API| + + +The rights relative to the management of OpenSearch items through the **OpenSearch API** are: + + +|Rights |LDP product types|Description| +|---------------------------------------------------|-----------------|-----------| +|ldp:opensearch:index/create |service |Create an index over OpenSearch API| +|ldp:opensearch:alias/create |service |Create an alias over OpenSearch API| +|ldp:opensearch:alias/read |alias |Read an alias's contents over OpenSearch API| +|ldp:opensearch:alias/delete |alias |Delete an alias over OpenSearch API| +|ldp:opensearch:index/read |index |Read an index content over OpenSearch API| +|ldp:opensearch:index/write |index |Write content to an index over OpenSearch API| +|ldp:opensearch:index/delete |index |Delete an index over OpenSearch API| + +Attach these rights to your policies freely whether you need to interact directly with the OpenSearch API or through the manager. + +The prefix of all indices or aliases created is . Example: ldp-ab-12345-i-my-awesome-index. +To interact with the OpenSearch API, you can either create [service accounts](/pages/account_and_service_management/account_information/authenticate-api-with-service-account) and leverage the OpenID workflow, or create [local users](/pages/account_and_service_management/account_information/ovhcloud-users-management) with their Personal Access Token with the API: + +> [!api] +> +> @api {v1} /me POST /me/identity/user/{user}/token +> + +This call will return a bearer token for a specific local user. + +You can then use the token of your user to create an index or write documents to your indices. + +```bash +ldp@laptop curl -H 'content-type: application/json' --oauth2-bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c -XPUT 'https://gra2.logs.ovh.com:9200/ldp-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 2}}' +``` + +You can alternatively use the basic scheme authentication with your bearer token as a password for systems that don't support a bearer token (or a custom Authentication Bearer header). The only constraint is to use a username starting with the prefix **pat_jwt_**. For example: + +```bash +ldp@laptop curl -H 'content-type: application/json' -u pat_jwt_user_one:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c -XPUT 'https://gra2.logs.ovh.com:9200/ldp-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 2}}' ``` -There is more information about the API Support at the [dedicated section](#management-through-opensearch-api). +Here, in both examples, the index created will have 2 shards and will appear in your panel. You can then attach it to an IAM policy. + +#### Legacy users + +If you don't have IAM enabled on your account (which will be deprecated) the prefix of indices is `:`. + +Here is an example with a curl command with the user **logs-ab-12345** and the index **logs-ab-12345-i-another-index** on gra2 cluster: + +```bash +$ curl -u logs-ab-12345:mypassword -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/logs-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 1}}' +``` -Whatever method you use, you will be able to query and visualize your documents on Logs Data Platform using the API. #### Index some data -Logs Data Platform OpenSearch indices are compatible with the [OpenSearch REST API](https://opensearch.org/docs/latest/opensearch/rest-api/index/). Therefore, you can use simple http requests to index and search your data. The API is accessible behind a secured https endpoint with mandatory authentication. We recommend that you use [tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens) to authenticate yourself. You can retrieve the endpoint of the API at the **Home** page of your service. Here is a simple example to index a document with curl with an index on the cluster `.logs.ovh.com`. +Logs Data Platform OpenSearch indices are compatible with the [OpenSearch REST API](https://opensearch.org/docs/latest/opensearch/rest-api/index/). Therefore, you can use simple http requests to index and search your data. The API is accessible behind a secured https endpoint with mandatory authentication. You can retrieve the endpoint of the API at the **Home** page of your service. Here is a simple example to index a document with curl on the cluster `.logs.ovh.com`. -```shell-session -$ curl -u token: -XPUT -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/logs--i-/_doc/1' -d '{ "user" : "Oles", "company" : "OVH", "message" : "Hello World !", "post_date" : "1999-11-02T23:01:00" }' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/-i-/_doc/1' -d '{ "user" : "Oles", "company" : "OVH", "message" : "Hello World !", "post_date" : "1999-11-02T23:01:00" }' ``` Here is a quick explanation of this command: - The **PUT** HTTP command can be used to create or modify a document. -- The `Content-Type: application/json` is the mandatory header to indicate that the data will be in the json format. +- The `Content-Type: application/json` is the mandatory header to indicate that the data will be in the JSON format. - The address contains the endpoint of the cluster followed by the **name of your index** -- The **test** just after the index name is the type of the document. +- The **_doc** just after the index name must be used as the type of the document. - The **1** here is the id of your document that can be any string. - The payload of the request is a simple **JSON document** that will be indexed. @@ -68,7 +140,7 @@ This command will return with a simple payload indicating if the document has be ```json { "_id": "1", - "_index": "logs--i-", + "_index": "-i-", "_primary_term": 1, "_seq_no": 0, "_shards": { @@ -86,25 +158,25 @@ This command will return with a simple payload indicating if the document has be There are multiple ways to search your data, this is one area where the OpenSearch REST API excels. You can either get your data directly by using a GET request, or search it with the Search APIs. To get your document indexed previously, use the following curl request: -```shell-session -$ curl -XGET -u token: 'https://.logs.ovh.com:9200/logs--i-/_doc/1' -{"_id":"1","_index":"logs--i-","_primary_term":1,"_seq_no":0,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc","_version":1,"found":true} +```bash +$ curl --oauth2-bearer -XGET 'https://.logs.ovh.com:9200/-i-/_doc/1' +{"_id":"1","_index":"-i-","_primary_term":1,"_seq_no":0,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc","_version":1,"found":true} ``` To issue a simple search you can either use the [Query DSL](https://opensearch.org/docs/latest/opensearch/query-dsl/index/) or a URI search. Here is a simple example with an URI search: -```shell-session -$ curl -XGET -u token: 'https://.logs.ovh.com:9200/logs--i-/_search?q=user:Oles' -{"_shards":{"failed":0,"skipped":0,"successful":1,"total":1},"hits":{"hits":[{"_id":"1","_index":"newindice","_score":0.2876821,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc"}],"max_score":0.2876821,"total":1},"timed_out":false,"took":31} +```bash +$ curl --oauth2-bearer -XGET 'https://.logs.ovh.com:9200/-i-/_search?q=user:Oles' +{"_shards":{"failed":0,"skipped":0,"successful":1,"total":1},"hits":{"hits":[{"_id":"1","_index":"-i-","_score":0.2876821,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc"}],"max_score":0.2876821,"total":1},"timed_out":false,"took":31} ``` ### Use case: Enrich Logs Data on the fly -The following shows how your e-commerce application logs can be sent to the Logs Data Platform whenever a product is ordered. It logs the customer order by using Id for the customers name. For performance reasons or maybe by-design, the application doesn't fetch the full name of the client or other information from the customer database just to produce a log. You can add this information on the fly by using an OpenSearch Index and a Logstash collector on the Logs Data Platform. +The following shows how your e-commerce application logs can be sent to the Logs Data Platform whenever a product is ordered. It logs the customer order by using ID for the customer's name. For performance reasons or maybe by design, the application doesn't fetch the full name of the client or other information from the customer database just to produce a log. You can add this information on the fly by using an OpenSearch Index and a Logstash collector on the Logs Data Platform. -#### Fill an index with clients information +#### Populate an index with clients' information -The first thing to do is to index some clients information. The snippet below is one entry of the client index. +The first thing to do is to index some client information. The snippet below is one entry of the client index. ```json { @@ -137,15 +209,15 @@ The first thing to do is to index some clients information. The snippet below is } ``` -To index several documents at once, it is more efficient to use the bulk api. Here is a small snippet of 3 users you can use to test it. +To index several documents at once, it is more efficient to use the bulk API. Here is a small snippet of 3 users you can use to test it. ```json -{ "index" : { "_index" : "logs--i-" } } -{ "userId": "1", "firstName": "Jon","lastName": "Snow", "age": 22, "address": { "streetAddress": "21 2nd Street", "city": "Winterfell", "state": "North", "postalCode": "14578", "geolocation": { "lat": 54.369488, "long": -5.574768 } },"phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-4567" } ] } -{ "index" : { "_index" : "logs--i-" } } -{ "userId": "2", "firstName": "Cersei","lastName": "Lannister", "age": 43, "address": { "streetAddress": "1 Palace Street", "city": "King's Landing", "state": "The Crownlands", "postalCode": "26863", "geolocation": { "lat": 42.639758, "long": 18.1094725 } },"phoneNumber": [ { "type": "home", "number": "212 555-6789" }, { "type": "mobile", "number": "102 555-8901" } ] } -{ "index" : { "_index" : "logs--i-" } } -{ "userId": "3", "firstName": "Daenerys","lastName": "Targaryen", "age": 22, "address": { "streetAddress": "3 Blackwater Bay Ave", "city": "Dragonstone", "state": "Dragonstone", "postalCode": "75197", "geolocation": { "lat": 43.300097, "long": -2.261580 } },"phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-2345" } ] } +{ "index" : { "_index" : "-i-" } } +{ "userId": "1", "firstName": "Jon","lastName": "Snow", "age": 22, "address": { "streetAddress": "21 2nd Street", "city": "Winterfell", "state": "North", "postalCode": "14578", "geolocation": { "lat": 54.369488, "long": -5.574768 } }, "phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-4567" } ] } +{ "index" : { "_index" : "-i-" } } +{ "userId": "2", "firstName": "Cersei","lastName": "Lannister", "age": 43, "address": { "streetAddress": "1 Palace Street", "city": "King's Landing", "state": "The Crownlands", "postalCode": "26863", "geolocation": { "lat": 42.639758, "long": 18.1094725 } }, "phoneNumber": [ { "type": "home", "number": "212 555-6789" }, { "type": "mobile", "number": "102 555-8901" } ] } +{ "index" : { "_index" : "-i-" } } +{ "userId": "3", "firstName": "Daenerys","lastName": "Targaryen", "age": 22, "address": { "streetAddress": "3 Blackwater Bay Ave", "city": "Dragonstone", "state": "Dragonstone", "postalCode": "75197", "geolocation": { "lat": 43.300097, "long": -2.261580 } }, "phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-2345" } ] } ``` A bulk request is a succession of JSON objects with this structure: @@ -162,14 +234,14 @@ A bulk request is a succession of JSON objects with this structure: You can in one request ask OpenSearch to index, update, delete several documents. Save the content of the previous JSON lines in a file named **bulk** and use the following call to index these 3 users: -```shell-session -$ curl -u token: -XPUT -H 'Content-Type: application/x-ndjson' 'https://.logs.ovh.com:9200/logs--i-/_bulk' --data-binary "@bulk" +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/x-ndjson' 'https://.logs.ovh.com:9200/-i-/_bulk' --data-binary "@bulk" ``` This call will take the content of the bulk file and execute each index operation. Note that you have to use the option **--data-binary** and no **-d** to preserve the newline after each JSON. You can check that your data are properly indexed with the following call: -```shell-session -$ curl -u token: -XGET 'https://.logs.ovh.com:9200/logs--i-/_search?pretty=true' +```bash +$ curl --oauth2-bearer -XGET 'https://.logs.ovh.com:9200/-i-/_search?pretty=true' ``` This will give you back the documents of your index: @@ -187,7 +259,7 @@ This will give you back the documents of your index: "total" : 3, "max_score" : 1.0, "hits" : [ { - "_index" : "logs--i-", + "_index" : "-i-", "_type" : "_doc", "_id" : "AV3HvbQAz85mIBfrJjkV", "_score" : 1.0, @@ -215,7 +287,7 @@ This will give you back the documents of your index: } ] } }, { - "_index" : "logs--i-", + "_index" : "-i-", "_type" : "_doc", "_id" : "AV3HvbQAz85mIBfrJjkW", "_score" : 1.0, @@ -243,7 +315,7 @@ This will give you back the documents of your index: } ] } }, { - "_index" : "logs--i-", + "_index" : "-i-", "_type" : "_doc", "_id" : "AV3HvbQAz85mIBfrJjkX", "_score" : 1.0, @@ -299,9 +371,9 @@ The most important part in this configuration is the filter part: ```ruby opensearch { hosts => ["https://gra2.logs.ovh.com:9200"] - index => "logs--i-" - user => "" - password => "" + index => "-i-" + user => "pat_jwt_logstash" + password => "" enable_sort => false query => "userId:%{[userId]}" fields => { @@ -337,7 +409,7 @@ The mutate plugin is here to show you how you can combine different subfield inf One simple way to test your new Logstash configuration is to send a log by using echo and openssl. Check the examples below: -```shell-session +```bash $ echo -e '{"version":"1.1", "host": "little bird", "short_message": "Warrior from the North", "level":1, "_userId": "2", "_unitType": "Westerosis", "_power_num": 200 }'\0 | openssl s_client -quiet -no_ign_eof -connect : $ echo -e '{"version":"1.1", "host": "little bird", "short_message": "A legendary dragon", "level":1, "_userId": "3", "_unitType": "Dragon", "_power_num": 200000 }'\0 | openssl s_client -quiet -no_ign_eof -connect : ``` @@ -368,7 +440,7 @@ The **maximum size** of your index is fixed and is dependent on the number of sh Note that you can monitor the size of the index by using the following curl query: ```shell-session -$ curl -u token: -XGET -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/logs--i-/_stats/store?pretty' +$ curl --oauth2-bearer -XGET -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/-i-/_stats/store?pretty' ``` This command will give you a document with the following format: @@ -393,7 +465,7 @@ This command will give you a document with the following format: } }, "indices" : { - "logs--i-" : { + "-i-" : { "uuid" : "JC0IWkd3QYSBNd4B2bBZGg", "primaries" : { "store" : { @@ -411,7 +483,7 @@ This command will give you a document with the following format: ``` The size in bytes used to compute your billing is the one under the following path: -"indices" -> "logs--i-" -> "primaries" -> "store" -> "size\_in\_bytes". +"indices" -> "-i-" -> "primaries" -> "store" -> "size\_in\_bytes". ### Management through OpenSearch API @@ -421,8 +493,8 @@ On Logs Data Platform, we allow users to use OpenSearch API to handle the lifecy To create an index on Logs Data Platform, use the following call: -```shell-session -$ curl -u : -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' -d '{ "settings" : {"number_of_shards" : 1}}' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' -d '{ "settings" : {"number_of_shards" : 1}}' ``` - The **-u** option is followed by your LDP username that you can find on **Home** page. The password 'mypassword' follows it after the separator ':' @@ -431,22 +503,22 @@ $ curl -u : -XPUT -H 'Content-Type: application/json' 'htt - The address contains the endpoint of the cluster followed by the **name of your index** - The payload of the request is a **JSON document** which contains the [settings of your index](https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/create-index/): the number of shards (the number of replicas will be automatically set at 1). -You have to follow the Logs Data Platform naming convention `-i-` to create your index. Your username is the one you use to connect to Graylog or to use the API. The suffix can contain any alphanumeric character. +You have to follow the Logs Data Platform naming convention `-i-` to create your index. Your service name can be found on the home page of the Logs Data Platform control panel. The suffix can contain any alphanumeric characters. -To delete a index use the following call: +To delete an index use the following call: -```shell-session -$ curl -u : -XDELETE -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' +```bash +$ curl --oauth2-bearer -XDELETE -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' ``` Here we use the **DELETE** HTTP command to delete the index. #### Alias creation and deletion -Similarly than indices, you can use the API Calls to delete and create aliases on your indices. The only difference is the convention for the name of your alias. Your alias must be formatted as the following **`-a-`**. Here is an example call: +Similarly than indices, you can use the API Calls to delete and create aliases on your indices. The only difference is the convention for the name of your alias. Your alias must be formatted as the following **`-a-`** (or -a- for legacy users). Here is an example call: -```shell-session -$ curl -u : -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-/_alias/-a-' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-/_alias/-a-' ``` This call creates a individual alias on one index you have previously created. @@ -455,13 +527,13 @@ If you need more information on aliases, you can check the [OpenSearch Documenta We also support the aliases API to create aliases: -```shell-session -$ curl -XPOST "https://gra2.logs.ovh.com:9200/_aliases?pretty" -H 'Content-Type: application/json' -d' +```bash +$ curl --oauth2-bearer -XPOST "https://gra2.logs.ovh.com:9200/_aliases?pretty" -H 'Content-Type: application/json' -d' { "actions" : [ - { "remove" : { "index" : "-i-", "alias" : "-a-" } }, - { "add" : { "index" : "-i-", "alias" : "-a-" } }, - { "remove_index": { "index": "-i-" } } + { "remove" : { "index" : "-i-", "alias" : "-a-" } }, + { "add" : { "index" : "-i-", "alias" : "-a-" } }, + { "remove_index": { "index": "-i-" } } ] }' ``` @@ -472,22 +544,22 @@ All the actions (alias change, alias creation and index deletion) will be done i Logs Data Platform supports your custom templates. As for indices and aliases, the template must follow some rules in order for them to work: -- the template name must contain your **``** inside the name. It can be anywhere in the name string. -- The prefix of the indices involved in the template MUST start by **`-i-`**, the "\*" character must be after this prefix -- The alias attached to your template must follow the usual convention: **`-a-`** +- the template name must contain your **``** inside the name. It can be anywhere in the name string. +- The prefix of the indices involved in the template MUST start by one your allowed services so **`-i-`**, the "\*" character must be after this prefix +- The alias attached to your template must follow the usual convention: **`-a-`** -Here is an example of a template for a user **logs-ab-12345**: +Here is an example of a template for a service **ldp-ab-12345**: -```shell-session -$ curl -u : -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/_template/template_for_logs-ab-12345_indices' -d ' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/_template/template_for_ldp-ab-12345_indices' -d ' { - "index_patterns" : [ "logs-ab-12345-i-debug*","logs-ab-12345-i-test*" ], + "index_patterns" : [ "ldp-ab-12345-i-debug*","ldp-ab-12345-i-test*" ], "settings": { "number_of_shards" : 1 }, "aliases" : { - "logs-ab-12345-a-all" : {}, - "logs-ab-12345-a-debug" : { "filter" : { "term" : { "type" : "debug" } } } + "ldp-ab-12345-a-all" : {}, + "ldp-ab-12345-a-debug" : { "filter" : { "term" : { "type" : "debug" } } } } }' ``` @@ -507,8 +579,8 @@ Here the first index was create through API, its description was filled automati Index as a service has some specificities on our platforms. This additional and technical information can help you to use it properly: - **Replication** is set at 1 and cannot be changed. We ensure the high availability of your index in case of a hardware failure. -- The **maximum size** of your index is fixed and is dependent on the number of shards. If search performance is critical, you should choose an index with the highest number of shard you can afford. -- The **index_refresh_interval** of the index is set at 1 second ensuring near real time search results. +- The **maximum size** of your index is fixed and is dependent on the number of shards. If search performance is critical, you should choose the highest number of shards you can afford. +- The **index_refresh_interval** of the index is set at 1 second, ensuring near real time search results. - You are not allowed to change the settings of your index. - You can create an **alias** on Logs Data Platform and attach it to one or several indices. - Unlike indices, aliases are **read-only**, you cannot write through an alias yet. @@ -519,4 +591,4 @@ Index as a service has some specificities on our platforms. This additional and - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.en-ie.md b/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.en-ie.md index 59deae3fe93..78216c98ff6 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.en-ie.md +++ b/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.en-ie.md @@ -1,25 +1,25 @@ --- title: OpenSearch Index as a Service excerpt: Use the power of OpenSearch without managing a cluster. -updated: 2024-08-07 +updated: 2025-10-16 --- ## Objective -OpenSearch is one of the main components of the Logs Data Platform, regarded as one of the most powerful search and analytics engines. From the outset we offered the possibility to host an OpenSearch Dashboards index for your OpenSearch Dashboards metadata, Index As A Service being the next step to this functionality. You can now use a fully unlocked index for almost any purpose; be it complex documents, reports or even logs. Thanks to the OpenSearch API, you will be able to use most of the tools of the OpenSearch Ecosystem. +OpenSearch is one of the main components of the Logs Data Platform, regarded as one of the most powerful search and analytics engines. From the outset we offered the possibility to host an OpenSearch Dashboards index for your OpenSearch Dashboards metadata. Index As A Service is the next step. You can now use a fully unlocked index for almost any purpose; be it complex documents, reports or even logs. Thanks to the OpenSearch API, you will be able to use most of the tools of the OpenSearch Ecosystem. ## Requirements This is what you need to know to get you started: - You have created a [Logs Data Platform account](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- You have access to the port 9200 of your cluster (head to the **Home** page in manager to know the address of your cluster). +- You have access to the port 9200 of your cluster (go to the **Home** page in manager to know the address of your cluster). ## Instructions ### First steps with an OpenSearch index -#### Create an index +#### Index name conventions There are two ways to create an OpenSearch Index: @@ -30,36 +30,108 @@ To create an OpenSearch index with the Logs Data Platform manager, you need to g ![add index option](images/add_index.png){.thumbnail} -You must just choose a suffix for your index. The final name will follow this convention: +Simply choose a suffix for your index. The final name will follow this convention: -`logs--i-`. +`-i-`. -For each index, you can specify the number of **shards**. A **shard** is the main component of an **index**. Its maximum storage capacity is set to **25 GB** (per shard). Multiple shards means more volume, more parallelism in your requests and thus more performance. Optionally, you can also be notified when your index is close to its critical size. Once your index is created, you can use it right away. +The service name is the identifier of your Logs Data Platform service. It is different from the username used by non IAM users. The service name starts with `ldp` (e.g. `ldp-ab-12345`). On the other hand, the username starts with `logs` (e.g. `logs-ab-12345`). In this guide we will use **** or **** as tags to let you differentiate both usages. You can find both pieces of information in the **Logs Data Platform control panel**. -When you create an index through the [OpenSearch API](https://opensearch.org/docs/latest/opensearch/index-data/), you can also specify the number of shards. Note that the maximum number of shards by index is limited to **16**. OpenSearch compatible tools can now create indices on the cluster as long as they follow the naming convention `logs--i-`. Here is an example with a curl command with the user **logs-ab-12345** and the index **logs-ab-12345-i-another-index** on gra2 cluster. +> [!primary] +> +> Prior to IAM migration the prefix was . It has now been changed to for all indices created after 17 September 2025. +> -```shell-session -$ curl -u logs-ab-12345:mypassword -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/logs-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 1}}' +For each index, you can specify the number of **shards**. A **shard** is the main component of an **index**. Its maximum storage capacity is set to **25 GB** (per shard). Multiple shards mean more volume, more parallelism in your requests and thus more performance. Optionally, you can also be notified when your index is close to its critical size. Once your index is created, you can use it right away. + +When you create an index through the [OpenSearch API](https://opensearch.org/docs/latest/opensearch/index-data/), you can also specify the number of shards. Note that the maximum number of shards per index is limited to **16**. OpenSearch compatible tools can now create indices on the cluster as long as they follow the naming conventions. + +#### IAM configuration + +If you have enabled [IAM on your account](/pages/manage_and_operate/observability/logs_data_platform/iam_presentation_faq/) you first need to create a policy and give the creation rights to your preferred user/account. See the [IAM for LDP documentation policy guide](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). + +The rights relative to the management of OpenSearch items through the **OVHcloud APIs** are: + + +|Rights |LDP product types|Description| +|---------------------------------------------------|-----------------|-----------| +|ldp:apiovh:url/get |service |Get Logs Data Platform service useful urls| +|ldp:apiovh:output/opensearch/index/create |service |Order a new OpenSearch index over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/create |service |Create a new OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/get |alias |Get OpenSearch aliases over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/edit |alias |Update an OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/index/attach |alias |Attach an OpenSearch index to a OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/index/detach |alias |Detach an OpenSearch index to a OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/delete |alias |Delete an OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/index/get |index |Get OpenSearch indexes over OVHcloud API| +|ldp:apiovh:output/opensearch/index/url/get |index |Get urls of an OpenSearch index over OVHcloud API| +|ldp:apiovh:output/opensearch/index/edit |index |Update an OpenSearch index over OVHcloud API| +|ldp:apiovh:output/opensearch/index/delete |index |Delete an OpenSearch index over OVHcloud API| + + +The rights relative to the management of OpenSearch items through the **OpenSearch API** are: + + +|Rights |LDP product types|Description| +|---------------------------------------------------|-----------------|-----------| +|ldp:opensearch:index/create |service |Create an index over OpenSearch API| +|ldp:opensearch:alias/create |service |Create an alias over OpenSearch API| +|ldp:opensearch:alias/read |alias |Read an alias's contents over OpenSearch API| +|ldp:opensearch:alias/delete |alias |Delete an alias over OpenSearch API| +|ldp:opensearch:index/read |index |Read an index content over OpenSearch API| +|ldp:opensearch:index/write |index |Write content to an index over OpenSearch API| +|ldp:opensearch:index/delete |index |Delete an index over OpenSearch API| + +Attach these rights to your policies freely whether you need to interact directly with the OpenSearch API or through the manager. + +The prefix of all indices or aliases created is . Example: ldp-ab-12345-i-my-awesome-index. +To interact with the OpenSearch API, you can either create [service accounts](/pages/account_and_service_management/account_information/authenticate-api-with-service-account) and leverage the OpenID workflow, or create [local users](/pages/account_and_service_management/account_information/ovhcloud-users-management) with their Personal Access Token with the API: + +> [!api] +> +> @api {v1} /me POST /me/identity/user/{user}/token +> + +This call will return a bearer token for a specific local user. + +You can then use the token of your user to create an index or write documents to your indices. + +```bash +ldp@laptop curl -H 'content-type: application/json' --oauth2-bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c -XPUT 'https://gra2.logs.ovh.com:9200/ldp-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 2}}' +``` + +You can alternatively use the basic scheme authentication with your bearer token as a password for systems that don't support a bearer token (or a custom Authentication Bearer header). The only constraint is to use a username starting with the prefix **pat_jwt_**. For example: + +```bash +ldp@laptop curl -H 'content-type: application/json' -u pat_jwt_user_one:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c -XPUT 'https://gra2.logs.ovh.com:9200/ldp-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 2}}' ``` -There is more information about the API Support at the [dedicated section](#management-through-opensearch-api). +Here, in both examples, the index created will have 2 shards and will appear in your panel. You can then attach it to an IAM policy. + +#### Legacy users + +If you don't have IAM enabled on your account (which will be deprecated) the prefix of indices is `:`. + +Here is an example with a curl command with the user **logs-ab-12345** and the index **logs-ab-12345-i-another-index** on gra2 cluster: + +```bash +$ curl -u logs-ab-12345:mypassword -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/logs-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 1}}' +``` -Whatever method you use, you will be able to query and visualize your documents on Logs Data Platform using the API. #### Index some data -Logs Data Platform OpenSearch indices are compatible with the [OpenSearch REST API](https://opensearch.org/docs/latest/opensearch/rest-api/index/). Therefore, you can use simple http requests to index and search your data. The API is accessible behind a secured https endpoint with mandatory authentication. We recommend that you use [tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens) to authenticate yourself. You can retrieve the endpoint of the API at the **Home** page of your service. Here is a simple example to index a document with curl with an index on the cluster `.logs.ovh.com`. +Logs Data Platform OpenSearch indices are compatible with the [OpenSearch REST API](https://opensearch.org/docs/latest/opensearch/rest-api/index/). Therefore, you can use simple http requests to index and search your data. The API is accessible behind a secured https endpoint with mandatory authentication. You can retrieve the endpoint of the API at the **Home** page of your service. Here is a simple example to index a document with curl on the cluster `.logs.ovh.com`. -```shell-session -$ curl -u token: -XPUT -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/logs--i-/_doc/1' -d '{ "user" : "Oles", "company" : "OVH", "message" : "Hello World !", "post_date" : "1999-11-02T23:01:00" }' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/-i-/_doc/1' -d '{ "user" : "Oles", "company" : "OVH", "message" : "Hello World !", "post_date" : "1999-11-02T23:01:00" }' ``` Here is a quick explanation of this command: - The **PUT** HTTP command can be used to create or modify a document. -- The `Content-Type: application/json` is the mandatory header to indicate that the data will be in the json format. +- The `Content-Type: application/json` is the mandatory header to indicate that the data will be in the JSON format. - The address contains the endpoint of the cluster followed by the **name of your index** -- The **test** just after the index name is the type of the document. +- The **_doc** just after the index name must be used as the type of the document. - The **1** here is the id of your document that can be any string. - The payload of the request is a simple **JSON document** that will be indexed. @@ -68,7 +140,7 @@ This command will return with a simple payload indicating if the document has be ```json { "_id": "1", - "_index": "logs--i-", + "_index": "-i-", "_primary_term": 1, "_seq_no": 0, "_shards": { @@ -86,25 +158,25 @@ This command will return with a simple payload indicating if the document has be There are multiple ways to search your data, this is one area where the OpenSearch REST API excels. You can either get your data directly by using a GET request, or search it with the Search APIs. To get your document indexed previously, use the following curl request: -```shell-session -$ curl -XGET -u token: 'https://.logs.ovh.com:9200/logs--i-/_doc/1' -{"_id":"1","_index":"logs--i-","_primary_term":1,"_seq_no":0,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc","_version":1,"found":true} +```bash +$ curl --oauth2-bearer -XGET 'https://.logs.ovh.com:9200/-i-/_doc/1' +{"_id":"1","_index":"-i-","_primary_term":1,"_seq_no":0,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc","_version":1,"found":true} ``` To issue a simple search you can either use the [Query DSL](https://opensearch.org/docs/latest/opensearch/query-dsl/index/) or a URI search. Here is a simple example with an URI search: -```shell-session -$ curl -XGET -u token: 'https://.logs.ovh.com:9200/logs--i-/_search?q=user:Oles' -{"_shards":{"failed":0,"skipped":0,"successful":1,"total":1},"hits":{"hits":[{"_id":"1","_index":"newindice","_score":0.2876821,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc"}],"max_score":0.2876821,"total":1},"timed_out":false,"took":31} +```bash +$ curl --oauth2-bearer -XGET 'https://.logs.ovh.com:9200/-i-/_search?q=user:Oles' +{"_shards":{"failed":0,"skipped":0,"successful":1,"total":1},"hits":{"hits":[{"_id":"1","_index":"-i-","_score":0.2876821,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc"}],"max_score":0.2876821,"total":1},"timed_out":false,"took":31} ``` ### Use case: Enrich Logs Data on the fly -The following shows how your e-commerce application logs can be sent to the Logs Data Platform whenever a product is ordered. It logs the customer order by using Id for the customers name. For performance reasons or maybe by-design, the application doesn't fetch the full name of the client or other information from the customer database just to produce a log. You can add this information on the fly by using an OpenSearch Index and a Logstash collector on the Logs Data Platform. +The following shows how your e-commerce application logs can be sent to the Logs Data Platform whenever a product is ordered. It logs the customer order by using ID for the customer's name. For performance reasons or maybe by design, the application doesn't fetch the full name of the client or other information from the customer database just to produce a log. You can add this information on the fly by using an OpenSearch Index and a Logstash collector on the Logs Data Platform. -#### Fill an index with clients information +#### Populate an index with clients' information -The first thing to do is to index some clients information. The snippet below is one entry of the client index. +The first thing to do is to index some client information. The snippet below is one entry of the client index. ```json { @@ -137,15 +209,15 @@ The first thing to do is to index some clients information. The snippet below is } ``` -To index several documents at once, it is more efficient to use the bulk api. Here is a small snippet of 3 users you can use to test it. +To index several documents at once, it is more efficient to use the bulk API. Here is a small snippet of 3 users you can use to test it. ```json -{ "index" : { "_index" : "logs--i-" } } -{ "userId": "1", "firstName": "Jon","lastName": "Snow", "age": 22, "address": { "streetAddress": "21 2nd Street", "city": "Winterfell", "state": "North", "postalCode": "14578", "geolocation": { "lat": 54.369488, "long": -5.574768 } },"phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-4567" } ] } -{ "index" : { "_index" : "logs--i-" } } -{ "userId": "2", "firstName": "Cersei","lastName": "Lannister", "age": 43, "address": { "streetAddress": "1 Palace Street", "city": "King's Landing", "state": "The Crownlands", "postalCode": "26863", "geolocation": { "lat": 42.639758, "long": 18.1094725 } },"phoneNumber": [ { "type": "home", "number": "212 555-6789" }, { "type": "mobile", "number": "102 555-8901" } ] } -{ "index" : { "_index" : "logs--i-" } } -{ "userId": "3", "firstName": "Daenerys","lastName": "Targaryen", "age": 22, "address": { "streetAddress": "3 Blackwater Bay Ave", "city": "Dragonstone", "state": "Dragonstone", "postalCode": "75197", "geolocation": { "lat": 43.300097, "long": -2.261580 } },"phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-2345" } ] } +{ "index" : { "_index" : "-i-" } } +{ "userId": "1", "firstName": "Jon","lastName": "Snow", "age": 22, "address": { "streetAddress": "21 2nd Street", "city": "Winterfell", "state": "North", "postalCode": "14578", "geolocation": { "lat": 54.369488, "long": -5.574768 } }, "phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-4567" } ] } +{ "index" : { "_index" : "-i-" } } +{ "userId": "2", "firstName": "Cersei","lastName": "Lannister", "age": 43, "address": { "streetAddress": "1 Palace Street", "city": "King's Landing", "state": "The Crownlands", "postalCode": "26863", "geolocation": { "lat": 42.639758, "long": 18.1094725 } }, "phoneNumber": [ { "type": "home", "number": "212 555-6789" }, { "type": "mobile", "number": "102 555-8901" } ] } +{ "index" : { "_index" : "-i-" } } +{ "userId": "3", "firstName": "Daenerys","lastName": "Targaryen", "age": 22, "address": { "streetAddress": "3 Blackwater Bay Ave", "city": "Dragonstone", "state": "Dragonstone", "postalCode": "75197", "geolocation": { "lat": 43.300097, "long": -2.261580 } }, "phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-2345" } ] } ``` A bulk request is a succession of JSON objects with this structure: @@ -162,14 +234,14 @@ A bulk request is a succession of JSON objects with this structure: You can in one request ask OpenSearch to index, update, delete several documents. Save the content of the previous JSON lines in a file named **bulk** and use the following call to index these 3 users: -```shell-session -$ curl -u token: -XPUT -H 'Content-Type: application/x-ndjson' 'https://.logs.ovh.com:9200/logs--i-/_bulk' --data-binary "@bulk" +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/x-ndjson' 'https://.logs.ovh.com:9200/-i-/_bulk' --data-binary "@bulk" ``` This call will take the content of the bulk file and execute each index operation. Note that you have to use the option **--data-binary** and no **-d** to preserve the newline after each JSON. You can check that your data are properly indexed with the following call: -```shell-session -$ curl -u token: -XGET 'https://.logs.ovh.com:9200/logs--i-/_search?pretty=true' +```bash +$ curl --oauth2-bearer -XGET 'https://.logs.ovh.com:9200/-i-/_search?pretty=true' ``` This will give you back the documents of your index: @@ -187,7 +259,7 @@ This will give you back the documents of your index: "total" : 3, "max_score" : 1.0, "hits" : [ { - "_index" : "logs--i-", + "_index" : "-i-", "_type" : "_doc", "_id" : "AV3HvbQAz85mIBfrJjkV", "_score" : 1.0, @@ -215,7 +287,7 @@ This will give you back the documents of your index: } ] } }, { - "_index" : "logs--i-", + "_index" : "-i-", "_type" : "_doc", "_id" : "AV3HvbQAz85mIBfrJjkW", "_score" : 1.0, @@ -243,7 +315,7 @@ This will give you back the documents of your index: } ] } }, { - "_index" : "logs--i-", + "_index" : "-i-", "_type" : "_doc", "_id" : "AV3HvbQAz85mIBfrJjkX", "_score" : 1.0, @@ -299,9 +371,9 @@ The most important part in this configuration is the filter part: ```ruby opensearch { hosts => ["https://gra2.logs.ovh.com:9200"] - index => "logs--i-" - user => "" - password => "" + index => "-i-" + user => "pat_jwt_logstash" + password => "" enable_sort => false query => "userId:%{[userId]}" fields => { @@ -337,7 +409,7 @@ The mutate plugin is here to show you how you can combine different subfield inf One simple way to test your new Logstash configuration is to send a log by using echo and openssl. Check the examples below: -```shell-session +```bash $ echo -e '{"version":"1.1", "host": "little bird", "short_message": "Warrior from the North", "level":1, "_userId": "2", "_unitType": "Westerosis", "_power_num": 200 }'\0 | openssl s_client -quiet -no_ign_eof -connect : $ echo -e '{"version":"1.1", "host": "little bird", "short_message": "A legendary dragon", "level":1, "_userId": "3", "_unitType": "Dragon", "_power_num": 200000 }'\0 | openssl s_client -quiet -no_ign_eof -connect : ``` @@ -368,7 +440,7 @@ The **maximum size** of your index is fixed and is dependent on the number of sh Note that you can monitor the size of the index by using the following curl query: ```shell-session -$ curl -u token: -XGET -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/logs--i-/_stats/store?pretty' +$ curl --oauth2-bearer -XGET -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/-i-/_stats/store?pretty' ``` This command will give you a document with the following format: @@ -393,7 +465,7 @@ This command will give you a document with the following format: } }, "indices" : { - "logs--i-" : { + "-i-" : { "uuid" : "JC0IWkd3QYSBNd4B2bBZGg", "primaries" : { "store" : { @@ -411,7 +483,7 @@ This command will give you a document with the following format: ``` The size in bytes used to compute your billing is the one under the following path: -"indices" -> "logs--i-" -> "primaries" -> "store" -> "size\_in\_bytes". +"indices" -> "-i-" -> "primaries" -> "store" -> "size\_in\_bytes". ### Management through OpenSearch API @@ -421,8 +493,8 @@ On Logs Data Platform, we allow users to use OpenSearch API to handle the lifecy To create an index on Logs Data Platform, use the following call: -```shell-session -$ curl -u : -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' -d '{ "settings" : {"number_of_shards" : 1}}' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' -d '{ "settings" : {"number_of_shards" : 1}}' ``` - The **-u** option is followed by your LDP username that you can find on **Home** page. The password 'mypassword' follows it after the separator ':' @@ -431,22 +503,22 @@ $ curl -u : -XPUT -H 'Content-Type: application/json' 'htt - The address contains the endpoint of the cluster followed by the **name of your index** - The payload of the request is a **JSON document** which contains the [settings of your index](https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/create-index/): the number of shards (the number of replicas will be automatically set at 1). -You have to follow the Logs Data Platform naming convention `-i-` to create your index. Your username is the one you use to connect to Graylog or to use the API. The suffix can contain any alphanumeric character. +You have to follow the Logs Data Platform naming convention `-i-` to create your index. Your service name can be found on the home page of the Logs Data Platform control panel. The suffix can contain any alphanumeric characters. -To delete a index use the following call: +To delete an index use the following call: -```shell-session -$ curl -u : -XDELETE -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' +```bash +$ curl --oauth2-bearer -XDELETE -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' ``` Here we use the **DELETE** HTTP command to delete the index. #### Alias creation and deletion -Similarly than indices, you can use the API Calls to delete and create aliases on your indices. The only difference is the convention for the name of your alias. Your alias must be formatted as the following **`-a-`**. Here is an example call: +Similarly than indices, you can use the API Calls to delete and create aliases on your indices. The only difference is the convention for the name of your alias. Your alias must be formatted as the following **`-a-`** (or -a- for legacy users). Here is an example call: -```shell-session -$ curl -u : -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-/_alias/-a-' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-/_alias/-a-' ``` This call creates a individual alias on one index you have previously created. @@ -455,13 +527,13 @@ If you need more information on aliases, you can check the [OpenSearch Documenta We also support the aliases API to create aliases: -```shell-session -$ curl -XPOST "https://gra2.logs.ovh.com:9200/_aliases?pretty" -H 'Content-Type: application/json' -d' +```bash +$ curl --oauth2-bearer -XPOST "https://gra2.logs.ovh.com:9200/_aliases?pretty" -H 'Content-Type: application/json' -d' { "actions" : [ - { "remove" : { "index" : "-i-", "alias" : "-a-" } }, - { "add" : { "index" : "-i-", "alias" : "-a-" } }, - { "remove_index": { "index": "-i-" } } + { "remove" : { "index" : "-i-", "alias" : "-a-" } }, + { "add" : { "index" : "-i-", "alias" : "-a-" } }, + { "remove_index": { "index": "-i-" } } ] }' ``` @@ -472,22 +544,22 @@ All the actions (alias change, alias creation and index deletion) will be done i Logs Data Platform supports your custom templates. As for indices and aliases, the template must follow some rules in order for them to work: -- the template name must contain your **``** inside the name. It can be anywhere in the name string. -- The prefix of the indices involved in the template MUST start by **`-i-`**, the "\*" character must be after this prefix -- The alias attached to your template must follow the usual convention: **`-a-`** +- the template name must contain your **``** inside the name. It can be anywhere in the name string. +- The prefix of the indices involved in the template MUST start by one your allowed services so **`-i-`**, the "\*" character must be after this prefix +- The alias attached to your template must follow the usual convention: **`-a-`** -Here is an example of a template for a user **logs-ab-12345**: +Here is an example of a template for a service **ldp-ab-12345**: -```shell-session -$ curl -u : -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/_template/template_for_logs-ab-12345_indices' -d ' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/_template/template_for_ldp-ab-12345_indices' -d ' { - "index_patterns" : [ "logs-ab-12345-i-debug*","logs-ab-12345-i-test*" ], + "index_patterns" : [ "ldp-ab-12345-i-debug*","ldp-ab-12345-i-test*" ], "settings": { "number_of_shards" : 1 }, "aliases" : { - "logs-ab-12345-a-all" : {}, - "logs-ab-12345-a-debug" : { "filter" : { "term" : { "type" : "debug" } } } + "ldp-ab-12345-a-all" : {}, + "ldp-ab-12345-a-debug" : { "filter" : { "term" : { "type" : "debug" } } } } }' ``` @@ -507,8 +579,8 @@ Here the first index was create through API, its description was filled automati Index as a service has some specificities on our platforms. This additional and technical information can help you to use it properly: - **Replication** is set at 1 and cannot be changed. We ensure the high availability of your index in case of a hardware failure. -- The **maximum size** of your index is fixed and is dependent on the number of shards. If search performance is critical, you should choose an index with the highest number of shard you can afford. -- The **index_refresh_interval** of the index is set at 1 second ensuring near real time search results. +- The **maximum size** of your index is fixed and is dependent on the number of shards. If search performance is critical, you should choose the highest number of shards you can afford. +- The **index_refresh_interval** of the index is set at 1 second, ensuring near real time search results. - You are not allowed to change the settings of your index. - You can create an **alias** on Logs Data Platform and attach it to one or several indices. - Unlike indices, aliases are **read-only**, you cannot write through an alias yet. @@ -519,4 +591,4 @@ Index as a service has some specificities on our platforms. This additional and - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.en-sg.md b/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.en-sg.md index 59deae3fe93..78216c98ff6 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.en-sg.md +++ b/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.en-sg.md @@ -1,25 +1,25 @@ --- title: OpenSearch Index as a Service excerpt: Use the power of OpenSearch without managing a cluster. -updated: 2024-08-07 +updated: 2025-10-16 --- ## Objective -OpenSearch is one of the main components of the Logs Data Platform, regarded as one of the most powerful search and analytics engines. From the outset we offered the possibility to host an OpenSearch Dashboards index for your OpenSearch Dashboards metadata, Index As A Service being the next step to this functionality. You can now use a fully unlocked index for almost any purpose; be it complex documents, reports or even logs. Thanks to the OpenSearch API, you will be able to use most of the tools of the OpenSearch Ecosystem. +OpenSearch is one of the main components of the Logs Data Platform, regarded as one of the most powerful search and analytics engines. From the outset we offered the possibility to host an OpenSearch Dashboards index for your OpenSearch Dashboards metadata. Index As A Service is the next step. You can now use a fully unlocked index for almost any purpose; be it complex documents, reports or even logs. Thanks to the OpenSearch API, you will be able to use most of the tools of the OpenSearch Ecosystem. ## Requirements This is what you need to know to get you started: - You have created a [Logs Data Platform account](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- You have access to the port 9200 of your cluster (head to the **Home** page in manager to know the address of your cluster). +- You have access to the port 9200 of your cluster (go to the **Home** page in manager to know the address of your cluster). ## Instructions ### First steps with an OpenSearch index -#### Create an index +#### Index name conventions There are two ways to create an OpenSearch Index: @@ -30,36 +30,108 @@ To create an OpenSearch index with the Logs Data Platform manager, you need to g ![add index option](images/add_index.png){.thumbnail} -You must just choose a suffix for your index. The final name will follow this convention: +Simply choose a suffix for your index. The final name will follow this convention: -`logs--i-`. +`-i-`. -For each index, you can specify the number of **shards**. A **shard** is the main component of an **index**. Its maximum storage capacity is set to **25 GB** (per shard). Multiple shards means more volume, more parallelism in your requests and thus more performance. Optionally, you can also be notified when your index is close to its critical size. Once your index is created, you can use it right away. +The service name is the identifier of your Logs Data Platform service. It is different from the username used by non IAM users. The service name starts with `ldp` (e.g. `ldp-ab-12345`). On the other hand, the username starts with `logs` (e.g. `logs-ab-12345`). In this guide we will use **** or **** as tags to let you differentiate both usages. You can find both pieces of information in the **Logs Data Platform control panel**. -When you create an index through the [OpenSearch API](https://opensearch.org/docs/latest/opensearch/index-data/), you can also specify the number of shards. Note that the maximum number of shards by index is limited to **16**. OpenSearch compatible tools can now create indices on the cluster as long as they follow the naming convention `logs--i-`. Here is an example with a curl command with the user **logs-ab-12345** and the index **logs-ab-12345-i-another-index** on gra2 cluster. +> [!primary] +> +> Prior to IAM migration the prefix was . It has now been changed to for all indices created after 17 September 2025. +> -```shell-session -$ curl -u logs-ab-12345:mypassword -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/logs-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 1}}' +For each index, you can specify the number of **shards**. A **shard** is the main component of an **index**. Its maximum storage capacity is set to **25 GB** (per shard). Multiple shards mean more volume, more parallelism in your requests and thus more performance. Optionally, you can also be notified when your index is close to its critical size. Once your index is created, you can use it right away. + +When you create an index through the [OpenSearch API](https://opensearch.org/docs/latest/opensearch/index-data/), you can also specify the number of shards. Note that the maximum number of shards per index is limited to **16**. OpenSearch compatible tools can now create indices on the cluster as long as they follow the naming conventions. + +#### IAM configuration + +If you have enabled [IAM on your account](/pages/manage_and_operate/observability/logs_data_platform/iam_presentation_faq/) you first need to create a policy and give the creation rights to your preferred user/account. See the [IAM for LDP documentation policy guide](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). + +The rights relative to the management of OpenSearch items through the **OVHcloud APIs** are: + + +|Rights |LDP product types|Description| +|---------------------------------------------------|-----------------|-----------| +|ldp:apiovh:url/get |service |Get Logs Data Platform service useful urls| +|ldp:apiovh:output/opensearch/index/create |service |Order a new OpenSearch index over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/create |service |Create a new OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/get |alias |Get OpenSearch aliases over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/edit |alias |Update an OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/index/attach |alias |Attach an OpenSearch index to a OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/index/detach |alias |Detach an OpenSearch index to a OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/delete |alias |Delete an OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/index/get |index |Get OpenSearch indexes over OVHcloud API| +|ldp:apiovh:output/opensearch/index/url/get |index |Get urls of an OpenSearch index over OVHcloud API| +|ldp:apiovh:output/opensearch/index/edit |index |Update an OpenSearch index over OVHcloud API| +|ldp:apiovh:output/opensearch/index/delete |index |Delete an OpenSearch index over OVHcloud API| + + +The rights relative to the management of OpenSearch items through the **OpenSearch API** are: + + +|Rights |LDP product types|Description| +|---------------------------------------------------|-----------------|-----------| +|ldp:opensearch:index/create |service |Create an index over OpenSearch API| +|ldp:opensearch:alias/create |service |Create an alias over OpenSearch API| +|ldp:opensearch:alias/read |alias |Read an alias's contents over OpenSearch API| +|ldp:opensearch:alias/delete |alias |Delete an alias over OpenSearch API| +|ldp:opensearch:index/read |index |Read an index content over OpenSearch API| +|ldp:opensearch:index/write |index |Write content to an index over OpenSearch API| +|ldp:opensearch:index/delete |index |Delete an index over OpenSearch API| + +Attach these rights to your policies freely whether you need to interact directly with the OpenSearch API or through the manager. + +The prefix of all indices or aliases created is . Example: ldp-ab-12345-i-my-awesome-index. +To interact with the OpenSearch API, you can either create [service accounts](/pages/account_and_service_management/account_information/authenticate-api-with-service-account) and leverage the OpenID workflow, or create [local users](/pages/account_and_service_management/account_information/ovhcloud-users-management) with their Personal Access Token with the API: + +> [!api] +> +> @api {v1} /me POST /me/identity/user/{user}/token +> + +This call will return a bearer token for a specific local user. + +You can then use the token of your user to create an index or write documents to your indices. + +```bash +ldp@laptop curl -H 'content-type: application/json' --oauth2-bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c -XPUT 'https://gra2.logs.ovh.com:9200/ldp-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 2}}' +``` + +You can alternatively use the basic scheme authentication with your bearer token as a password for systems that don't support a bearer token (or a custom Authentication Bearer header). The only constraint is to use a username starting with the prefix **pat_jwt_**. For example: + +```bash +ldp@laptop curl -H 'content-type: application/json' -u pat_jwt_user_one:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c -XPUT 'https://gra2.logs.ovh.com:9200/ldp-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 2}}' ``` -There is more information about the API Support at the [dedicated section](#management-through-opensearch-api). +Here, in both examples, the index created will have 2 shards and will appear in your panel. You can then attach it to an IAM policy. + +#### Legacy users + +If you don't have IAM enabled on your account (which will be deprecated) the prefix of indices is `:`. + +Here is an example with a curl command with the user **logs-ab-12345** and the index **logs-ab-12345-i-another-index** on gra2 cluster: + +```bash +$ curl -u logs-ab-12345:mypassword -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/logs-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 1}}' +``` -Whatever method you use, you will be able to query and visualize your documents on Logs Data Platform using the API. #### Index some data -Logs Data Platform OpenSearch indices are compatible with the [OpenSearch REST API](https://opensearch.org/docs/latest/opensearch/rest-api/index/). Therefore, you can use simple http requests to index and search your data. The API is accessible behind a secured https endpoint with mandatory authentication. We recommend that you use [tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens) to authenticate yourself. You can retrieve the endpoint of the API at the **Home** page of your service. Here is a simple example to index a document with curl with an index on the cluster `.logs.ovh.com`. +Logs Data Platform OpenSearch indices are compatible with the [OpenSearch REST API](https://opensearch.org/docs/latest/opensearch/rest-api/index/). Therefore, you can use simple http requests to index and search your data. The API is accessible behind a secured https endpoint with mandatory authentication. You can retrieve the endpoint of the API at the **Home** page of your service. Here is a simple example to index a document with curl on the cluster `.logs.ovh.com`. -```shell-session -$ curl -u token: -XPUT -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/logs--i-/_doc/1' -d '{ "user" : "Oles", "company" : "OVH", "message" : "Hello World !", "post_date" : "1999-11-02T23:01:00" }' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/-i-/_doc/1' -d '{ "user" : "Oles", "company" : "OVH", "message" : "Hello World !", "post_date" : "1999-11-02T23:01:00" }' ``` Here is a quick explanation of this command: - The **PUT** HTTP command can be used to create or modify a document. -- The `Content-Type: application/json` is the mandatory header to indicate that the data will be in the json format. +- The `Content-Type: application/json` is the mandatory header to indicate that the data will be in the JSON format. - The address contains the endpoint of the cluster followed by the **name of your index** -- The **test** just after the index name is the type of the document. +- The **_doc** just after the index name must be used as the type of the document. - The **1** here is the id of your document that can be any string. - The payload of the request is a simple **JSON document** that will be indexed. @@ -68,7 +140,7 @@ This command will return with a simple payload indicating if the document has be ```json { "_id": "1", - "_index": "logs--i-", + "_index": "-i-", "_primary_term": 1, "_seq_no": 0, "_shards": { @@ -86,25 +158,25 @@ This command will return with a simple payload indicating if the document has be There are multiple ways to search your data, this is one area where the OpenSearch REST API excels. You can either get your data directly by using a GET request, or search it with the Search APIs. To get your document indexed previously, use the following curl request: -```shell-session -$ curl -XGET -u token: 'https://.logs.ovh.com:9200/logs--i-/_doc/1' -{"_id":"1","_index":"logs--i-","_primary_term":1,"_seq_no":0,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc","_version":1,"found":true} +```bash +$ curl --oauth2-bearer -XGET 'https://.logs.ovh.com:9200/-i-/_doc/1' +{"_id":"1","_index":"-i-","_primary_term":1,"_seq_no":0,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc","_version":1,"found":true} ``` To issue a simple search you can either use the [Query DSL](https://opensearch.org/docs/latest/opensearch/query-dsl/index/) or a URI search. Here is a simple example with an URI search: -```shell-session -$ curl -XGET -u token: 'https://.logs.ovh.com:9200/logs--i-/_search?q=user:Oles' -{"_shards":{"failed":0,"skipped":0,"successful":1,"total":1},"hits":{"hits":[{"_id":"1","_index":"newindice","_score":0.2876821,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc"}],"max_score":0.2876821,"total":1},"timed_out":false,"took":31} +```bash +$ curl --oauth2-bearer -XGET 'https://.logs.ovh.com:9200/-i-/_search?q=user:Oles' +{"_shards":{"failed":0,"skipped":0,"successful":1,"total":1},"hits":{"hits":[{"_id":"1","_index":"-i-","_score":0.2876821,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc"}],"max_score":0.2876821,"total":1},"timed_out":false,"took":31} ``` ### Use case: Enrich Logs Data on the fly -The following shows how your e-commerce application logs can be sent to the Logs Data Platform whenever a product is ordered. It logs the customer order by using Id for the customers name. For performance reasons or maybe by-design, the application doesn't fetch the full name of the client or other information from the customer database just to produce a log. You can add this information on the fly by using an OpenSearch Index and a Logstash collector on the Logs Data Platform. +The following shows how your e-commerce application logs can be sent to the Logs Data Platform whenever a product is ordered. It logs the customer order by using ID for the customer's name. For performance reasons or maybe by design, the application doesn't fetch the full name of the client or other information from the customer database just to produce a log. You can add this information on the fly by using an OpenSearch Index and a Logstash collector on the Logs Data Platform. -#### Fill an index with clients information +#### Populate an index with clients' information -The first thing to do is to index some clients information. The snippet below is one entry of the client index. +The first thing to do is to index some client information. The snippet below is one entry of the client index. ```json { @@ -137,15 +209,15 @@ The first thing to do is to index some clients information. The snippet below is } ``` -To index several documents at once, it is more efficient to use the bulk api. Here is a small snippet of 3 users you can use to test it. +To index several documents at once, it is more efficient to use the bulk API. Here is a small snippet of 3 users you can use to test it. ```json -{ "index" : { "_index" : "logs--i-" } } -{ "userId": "1", "firstName": "Jon","lastName": "Snow", "age": 22, "address": { "streetAddress": "21 2nd Street", "city": "Winterfell", "state": "North", "postalCode": "14578", "geolocation": { "lat": 54.369488, "long": -5.574768 } },"phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-4567" } ] } -{ "index" : { "_index" : "logs--i-" } } -{ "userId": "2", "firstName": "Cersei","lastName": "Lannister", "age": 43, "address": { "streetAddress": "1 Palace Street", "city": "King's Landing", "state": "The Crownlands", "postalCode": "26863", "geolocation": { "lat": 42.639758, "long": 18.1094725 } },"phoneNumber": [ { "type": "home", "number": "212 555-6789" }, { "type": "mobile", "number": "102 555-8901" } ] } -{ "index" : { "_index" : "logs--i-" } } -{ "userId": "3", "firstName": "Daenerys","lastName": "Targaryen", "age": 22, "address": { "streetAddress": "3 Blackwater Bay Ave", "city": "Dragonstone", "state": "Dragonstone", "postalCode": "75197", "geolocation": { "lat": 43.300097, "long": -2.261580 } },"phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-2345" } ] } +{ "index" : { "_index" : "-i-" } } +{ "userId": "1", "firstName": "Jon","lastName": "Snow", "age": 22, "address": { "streetAddress": "21 2nd Street", "city": "Winterfell", "state": "North", "postalCode": "14578", "geolocation": { "lat": 54.369488, "long": -5.574768 } }, "phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-4567" } ] } +{ "index" : { "_index" : "-i-" } } +{ "userId": "2", "firstName": "Cersei","lastName": "Lannister", "age": 43, "address": { "streetAddress": "1 Palace Street", "city": "King's Landing", "state": "The Crownlands", "postalCode": "26863", "geolocation": { "lat": 42.639758, "long": 18.1094725 } }, "phoneNumber": [ { "type": "home", "number": "212 555-6789" }, { "type": "mobile", "number": "102 555-8901" } ] } +{ "index" : { "_index" : "-i-" } } +{ "userId": "3", "firstName": "Daenerys","lastName": "Targaryen", "age": 22, "address": { "streetAddress": "3 Blackwater Bay Ave", "city": "Dragonstone", "state": "Dragonstone", "postalCode": "75197", "geolocation": { "lat": 43.300097, "long": -2.261580 } }, "phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-2345" } ] } ``` A bulk request is a succession of JSON objects with this structure: @@ -162,14 +234,14 @@ A bulk request is a succession of JSON objects with this structure: You can in one request ask OpenSearch to index, update, delete several documents. Save the content of the previous JSON lines in a file named **bulk** and use the following call to index these 3 users: -```shell-session -$ curl -u token: -XPUT -H 'Content-Type: application/x-ndjson' 'https://.logs.ovh.com:9200/logs--i-/_bulk' --data-binary "@bulk" +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/x-ndjson' 'https://.logs.ovh.com:9200/-i-/_bulk' --data-binary "@bulk" ``` This call will take the content of the bulk file and execute each index operation. Note that you have to use the option **--data-binary** and no **-d** to preserve the newline after each JSON. You can check that your data are properly indexed with the following call: -```shell-session -$ curl -u token: -XGET 'https://.logs.ovh.com:9200/logs--i-/_search?pretty=true' +```bash +$ curl --oauth2-bearer -XGET 'https://.logs.ovh.com:9200/-i-/_search?pretty=true' ``` This will give you back the documents of your index: @@ -187,7 +259,7 @@ This will give you back the documents of your index: "total" : 3, "max_score" : 1.0, "hits" : [ { - "_index" : "logs--i-", + "_index" : "-i-", "_type" : "_doc", "_id" : "AV3HvbQAz85mIBfrJjkV", "_score" : 1.0, @@ -215,7 +287,7 @@ This will give you back the documents of your index: } ] } }, { - "_index" : "logs--i-", + "_index" : "-i-", "_type" : "_doc", "_id" : "AV3HvbQAz85mIBfrJjkW", "_score" : 1.0, @@ -243,7 +315,7 @@ This will give you back the documents of your index: } ] } }, { - "_index" : "logs--i-", + "_index" : "-i-", "_type" : "_doc", "_id" : "AV3HvbQAz85mIBfrJjkX", "_score" : 1.0, @@ -299,9 +371,9 @@ The most important part in this configuration is the filter part: ```ruby opensearch { hosts => ["https://gra2.logs.ovh.com:9200"] - index => "logs--i-" - user => "" - password => "" + index => "-i-" + user => "pat_jwt_logstash" + password => "" enable_sort => false query => "userId:%{[userId]}" fields => { @@ -337,7 +409,7 @@ The mutate plugin is here to show you how you can combine different subfield inf One simple way to test your new Logstash configuration is to send a log by using echo and openssl. Check the examples below: -```shell-session +```bash $ echo -e '{"version":"1.1", "host": "little bird", "short_message": "Warrior from the North", "level":1, "_userId": "2", "_unitType": "Westerosis", "_power_num": 200 }'\0 | openssl s_client -quiet -no_ign_eof -connect : $ echo -e '{"version":"1.1", "host": "little bird", "short_message": "A legendary dragon", "level":1, "_userId": "3", "_unitType": "Dragon", "_power_num": 200000 }'\0 | openssl s_client -quiet -no_ign_eof -connect : ``` @@ -368,7 +440,7 @@ The **maximum size** of your index is fixed and is dependent on the number of sh Note that you can monitor the size of the index by using the following curl query: ```shell-session -$ curl -u token: -XGET -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/logs--i-/_stats/store?pretty' +$ curl --oauth2-bearer -XGET -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/-i-/_stats/store?pretty' ``` This command will give you a document with the following format: @@ -393,7 +465,7 @@ This command will give you a document with the following format: } }, "indices" : { - "logs--i-" : { + "-i-" : { "uuid" : "JC0IWkd3QYSBNd4B2bBZGg", "primaries" : { "store" : { @@ -411,7 +483,7 @@ This command will give you a document with the following format: ``` The size in bytes used to compute your billing is the one under the following path: -"indices" -> "logs--i-" -> "primaries" -> "store" -> "size\_in\_bytes". +"indices" -> "-i-" -> "primaries" -> "store" -> "size\_in\_bytes". ### Management through OpenSearch API @@ -421,8 +493,8 @@ On Logs Data Platform, we allow users to use OpenSearch API to handle the lifecy To create an index on Logs Data Platform, use the following call: -```shell-session -$ curl -u : -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' -d '{ "settings" : {"number_of_shards" : 1}}' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' -d '{ "settings" : {"number_of_shards" : 1}}' ``` - The **-u** option is followed by your LDP username that you can find on **Home** page. The password 'mypassword' follows it after the separator ':' @@ -431,22 +503,22 @@ $ curl -u : -XPUT -H 'Content-Type: application/json' 'htt - The address contains the endpoint of the cluster followed by the **name of your index** - The payload of the request is a **JSON document** which contains the [settings of your index](https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/create-index/): the number of shards (the number of replicas will be automatically set at 1). -You have to follow the Logs Data Platform naming convention `-i-` to create your index. Your username is the one you use to connect to Graylog or to use the API. The suffix can contain any alphanumeric character. +You have to follow the Logs Data Platform naming convention `-i-` to create your index. Your service name can be found on the home page of the Logs Data Platform control panel. The suffix can contain any alphanumeric characters. -To delete a index use the following call: +To delete an index use the following call: -```shell-session -$ curl -u : -XDELETE -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' +```bash +$ curl --oauth2-bearer -XDELETE -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' ``` Here we use the **DELETE** HTTP command to delete the index. #### Alias creation and deletion -Similarly than indices, you can use the API Calls to delete and create aliases on your indices. The only difference is the convention for the name of your alias. Your alias must be formatted as the following **`-a-`**. Here is an example call: +Similarly than indices, you can use the API Calls to delete and create aliases on your indices. The only difference is the convention for the name of your alias. Your alias must be formatted as the following **`-a-`** (or -a- for legacy users). Here is an example call: -```shell-session -$ curl -u : -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-/_alias/-a-' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-/_alias/-a-' ``` This call creates a individual alias on one index you have previously created. @@ -455,13 +527,13 @@ If you need more information on aliases, you can check the [OpenSearch Documenta We also support the aliases API to create aliases: -```shell-session -$ curl -XPOST "https://gra2.logs.ovh.com:9200/_aliases?pretty" -H 'Content-Type: application/json' -d' +```bash +$ curl --oauth2-bearer -XPOST "https://gra2.logs.ovh.com:9200/_aliases?pretty" -H 'Content-Type: application/json' -d' { "actions" : [ - { "remove" : { "index" : "-i-", "alias" : "-a-" } }, - { "add" : { "index" : "-i-", "alias" : "-a-" } }, - { "remove_index": { "index": "-i-" } } + { "remove" : { "index" : "-i-", "alias" : "-a-" } }, + { "add" : { "index" : "-i-", "alias" : "-a-" } }, + { "remove_index": { "index": "-i-" } } ] }' ``` @@ -472,22 +544,22 @@ All the actions (alias change, alias creation and index deletion) will be done i Logs Data Platform supports your custom templates. As for indices and aliases, the template must follow some rules in order for them to work: -- the template name must contain your **``** inside the name. It can be anywhere in the name string. -- The prefix of the indices involved in the template MUST start by **`-i-`**, the "\*" character must be after this prefix -- The alias attached to your template must follow the usual convention: **`-a-`** +- the template name must contain your **``** inside the name. It can be anywhere in the name string. +- The prefix of the indices involved in the template MUST start by one your allowed services so **`-i-`**, the "\*" character must be after this prefix +- The alias attached to your template must follow the usual convention: **`-a-`** -Here is an example of a template for a user **logs-ab-12345**: +Here is an example of a template for a service **ldp-ab-12345**: -```shell-session -$ curl -u : -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/_template/template_for_logs-ab-12345_indices' -d ' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/_template/template_for_ldp-ab-12345_indices' -d ' { - "index_patterns" : [ "logs-ab-12345-i-debug*","logs-ab-12345-i-test*" ], + "index_patterns" : [ "ldp-ab-12345-i-debug*","ldp-ab-12345-i-test*" ], "settings": { "number_of_shards" : 1 }, "aliases" : { - "logs-ab-12345-a-all" : {}, - "logs-ab-12345-a-debug" : { "filter" : { "term" : { "type" : "debug" } } } + "ldp-ab-12345-a-all" : {}, + "ldp-ab-12345-a-debug" : { "filter" : { "term" : { "type" : "debug" } } } } }' ``` @@ -507,8 +579,8 @@ Here the first index was create through API, its description was filled automati Index as a service has some specificities on our platforms. This additional and technical information can help you to use it properly: - **Replication** is set at 1 and cannot be changed. We ensure the high availability of your index in case of a hardware failure. -- The **maximum size** of your index is fixed and is dependent on the number of shards. If search performance is critical, you should choose an index with the highest number of shard you can afford. -- The **index_refresh_interval** of the index is set at 1 second ensuring near real time search results. +- The **maximum size** of your index is fixed and is dependent on the number of shards. If search performance is critical, you should choose the highest number of shards you can afford. +- The **index_refresh_interval** of the index is set at 1 second, ensuring near real time search results. - You are not allowed to change the settings of your index. - You can create an **alias** on Logs Data Platform and attach it to one or several indices. - Unlike indices, aliases are **read-only**, you cannot write through an alias yet. @@ -519,4 +591,4 @@ Index as a service has some specificities on our platforms. This additional and - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.en-us.md b/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.en-us.md index 59deae3fe93..fb3a8b17c24 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.en-us.md +++ b/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.en-us.md @@ -1,25 +1,25 @@ --- title: OpenSearch Index as a Service excerpt: Use the power of OpenSearch without managing a cluster. -updated: 2024-08-07 +updated: 2025-10-16 --- ## Objective -OpenSearch is one of the main components of the Logs Data Platform, regarded as one of the most powerful search and analytics engines. From the outset we offered the possibility to host an OpenSearch Dashboards index for your OpenSearch Dashboards metadata, Index As A Service being the next step to this functionality. You can now use a fully unlocked index for almost any purpose; be it complex documents, reports or even logs. Thanks to the OpenSearch API, you will be able to use most of the tools of the OpenSearch Ecosystem. +OpenSearch is one of the main components of the Logs Data Platform, regarded as one of the most powerful search and analytics engines. From the outset we offered the possibility to host an OpenSearch Dashboards index for your OpenSearch Dashboards metadata. Index As A Service is the next step. You can now use a fully unlocked index for almost any purpose; be it complex documents, reports or even logs. Thanks to the OpenSearch API, you will be able to use most of the tools of the OpenSearch Ecosystem. ## Requirements This is what you need to know to get you started: - You have created a [Logs Data Platform account](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- You have access to the port 9200 of your cluster (head to the **Home** page in manager to know the address of your cluster). +- You have access to the port 9200 of your cluster (go to the **Home** page in manager to know the address of your cluster). ## Instructions ### First steps with an OpenSearch index -#### Create an index +#### Index name conventions There are two ways to create an OpenSearch Index: @@ -30,36 +30,108 @@ To create an OpenSearch index with the Logs Data Platform manager, you need to g ![add index option](images/add_index.png){.thumbnail} -You must just choose a suffix for your index. The final name will follow this convention: +Simply choose a suffix for your index. The final name will follow this convention: -`logs--i-`. +`-i-`. -For each index, you can specify the number of **shards**. A **shard** is the main component of an **index**. Its maximum storage capacity is set to **25 GB** (per shard). Multiple shards means more volume, more parallelism in your requests and thus more performance. Optionally, you can also be notified when your index is close to its critical size. Once your index is created, you can use it right away. +The service name is the identifier of your Logs Data Platform service. It is different from the username used by non IAM users. The service name starts with `ldp` (e.g. `ldp-ab-12345`). On the other hand, the username starts with `logs` (e.g. `logs-ab-12345`). In this guide we will use **** or **** as tags to let you differentiate both usages. You can find both pieces of information in the **Logs Data Platform control panel**. -When you create an index through the [OpenSearch API](https://opensearch.org/docs/latest/opensearch/index-data/), you can also specify the number of shards. Note that the maximum number of shards by index is limited to **16**. OpenSearch compatible tools can now create indices on the cluster as long as they follow the naming convention `logs--i-`. Here is an example with a curl command with the user **logs-ab-12345** and the index **logs-ab-12345-i-another-index** on gra2 cluster. +> [!primary] +> +> Prior to IAM migration the prefix was . It has now been changed to for all indices created after September 17, 2025. +> -```shell-session -$ curl -u logs-ab-12345:mypassword -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/logs-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 1}}' +For each index, you can specify the number of **shards**. A **shard** is the main component of an **index**. Its maximum storage capacity is set to **25 GB** (per shard). Multiple shards mean more volume, more parallelism in your requests and thus more performance. Optionally, you can also be notified when your index is close to its critical size. Once your index is created, you can use it right away. + +When you create an index through the [OpenSearch API](https://opensearch.org/docs/latest/opensearch/index-data/), you can also specify the number of shards. Note that the maximum number of shards per index is limited to **16**. OpenSearch compatible tools can now create indices on the cluster as long as they follow the naming conventions. + +#### IAM configuration + +If you have enabled [IAM on your account](/pages/manage_and_operate/observability/logs_data_platform/iam_presentation_faq/) you first need to create a policy and give the creation rights to your preferred user/account. See the [IAM for LDP documentation policy guide](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). + +The rights relative to the management of OpenSearch items through the **OVHcloud APIs** are: + + +|Rights |LDP product types|Description| +|---------------------------------------------------|-----------------|-----------| +|ldp:apiovh:url/get |service |Get Logs Data Platform service useful urls| +|ldp:apiovh:output/opensearch/index/create |service |Order a new OpenSearch index over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/create |service |Create a new OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/get |alias |Get OpenSearch aliases over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/edit |alias |Update an OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/index/attach |alias |Attach an OpenSearch index to a OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/index/detach |alias |Detach an OpenSearch index to a OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/delete |alias |Delete an OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/index/get |index |Get OpenSearch indexes over OVHcloud API| +|ldp:apiovh:output/opensearch/index/url/get |index |Get urls of an OpenSearch index over OVHcloud API| +|ldp:apiovh:output/opensearch/index/edit |index |Update an OpenSearch index over OVHcloud API| +|ldp:apiovh:output/opensearch/index/delete |index |Delete an OpenSearch index over OVHcloud API| + + +The rights relative to the management of OpenSearch items through the **OpenSearch API** are: + + +|Rights |LDP product types|Description| +|---------------------------------------------------|-----------------|-----------| +|ldp:opensearch:index/create |service |Create an index over OpenSearch API| +|ldp:opensearch:alias/create |service |Create an alias over OpenSearch API| +|ldp:opensearch:alias/read |alias |Read an alias's contents over OpenSearch API| +|ldp:opensearch:alias/delete |alias |Delete an alias over OpenSearch API| +|ldp:opensearch:index/read |index |Read an index content over OpenSearch API| +|ldp:opensearch:index/write |index |Write content to an index over OpenSearch API| +|ldp:opensearch:index/delete |index |Delete an index over OpenSearch API| + +Attach these rights to your policies freely whether you need to interact directly with the OpenSearch API or through the manager. + +The prefix of all indices or aliases created is . Example: ldp-ab-12345-i-my-awesome-index. +To interact with the OpenSearch API, you can either create [service accounts](/pages/account_and_service_management/account_information/authenticate-api-with-service-account) and leverage the OpenID workflow, or create [local users](/pages/account_and_service_management/account_information/ovhcloud-users-management) with their Personal Access Token with the API: + +> [!api] +> +> @api {v1} /me POST /me/identity/user/{user}/token +> + +This call will return a bearer token for a specific local user. + +You can then use the token of your user to create an index or write documents to your indices. + +```bash +ldp@laptop curl -H 'content-type: application/json' --oauth2-bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c -XPUT 'https://gra2.logs.ovh.com:9200/ldp-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 2}}' +``` + +You can alternatively use the basic scheme authentication with your bearer token as a password for systems that don't support a bearer token (or a custom Authentication Bearer header). The only constraint is to use a username starting with the prefix **pat_jwt_**. For example: + +```bash +ldp@laptop curl -H 'content-type: application/json' -u pat_jwt_user_one:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c -XPUT 'https://gra2.logs.ovh.com:9200/ldp-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 2}}' ``` -There is more information about the API Support at the [dedicated section](#management-through-opensearch-api). +Here, in both examples, the index created will have 2 shards and will appear in your panel. You can then attach it to an IAM policy. + +#### Legacy users + +If you don't have IAM enabled on your account (which will be deprecated) the prefix of indices is `:`. + +Here is an example with a curl command with the user **logs-ab-12345** and the index **logs-ab-12345-i-another-index** on gra2 cluster: + +```bash +$ curl -u logs-ab-12345:mypassword -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/logs-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 1}}' +``` -Whatever method you use, you will be able to query and visualize your documents on Logs Data Platform using the API. #### Index some data -Logs Data Platform OpenSearch indices are compatible with the [OpenSearch REST API](https://opensearch.org/docs/latest/opensearch/rest-api/index/). Therefore, you can use simple http requests to index and search your data. The API is accessible behind a secured https endpoint with mandatory authentication. We recommend that you use [tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens) to authenticate yourself. You can retrieve the endpoint of the API at the **Home** page of your service. Here is a simple example to index a document with curl with an index on the cluster `.logs.ovh.com`. +Logs Data Platform OpenSearch indices are compatible with the [OpenSearch REST API](https://opensearch.org/docs/latest/opensearch/rest-api/index/). Therefore, you can use simple http requests to index and search your data. The API is accessible behind a secured https endpoint with mandatory authentication. You can retrieve the endpoint of the API at the **Home** page of your service. Here is a simple example to index a document with curl on the cluster `.logs.ovh.com`. -```shell-session -$ curl -u token: -XPUT -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/logs--i-/_doc/1' -d '{ "user" : "Oles", "company" : "OVH", "message" : "Hello World !", "post_date" : "1999-11-02T23:01:00" }' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/-i-/_doc/1' -d '{ "user" : "Oles", "company" : "OVH", "message" : "Hello World !", "post_date" : "1999-11-02T23:01:00" }' ``` Here is a quick explanation of this command: - The **PUT** HTTP command can be used to create or modify a document. -- The `Content-Type: application/json` is the mandatory header to indicate that the data will be in the json format. +- The `Content-Type: application/json` is the mandatory header to indicate that the data will be in the JSON format. - The address contains the endpoint of the cluster followed by the **name of your index** -- The **test** just after the index name is the type of the document. +- The **_doc** just after the index name must be used as the type of the document. - The **1** here is the id of your document that can be any string. - The payload of the request is a simple **JSON document** that will be indexed. @@ -68,7 +140,7 @@ This command will return with a simple payload indicating if the document has be ```json { "_id": "1", - "_index": "logs--i-", + "_index": "-i-", "_primary_term": 1, "_seq_no": 0, "_shards": { @@ -86,25 +158,25 @@ This command will return with a simple payload indicating if the document has be There are multiple ways to search your data, this is one area where the OpenSearch REST API excels. You can either get your data directly by using a GET request, or search it with the Search APIs. To get your document indexed previously, use the following curl request: -```shell-session -$ curl -XGET -u token: 'https://.logs.ovh.com:9200/logs--i-/_doc/1' -{"_id":"1","_index":"logs--i-","_primary_term":1,"_seq_no":0,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc","_version":1,"found":true} +```bash +$ curl --oauth2-bearer -XGET 'https://.logs.ovh.com:9200/-i-/_doc/1' +{"_id":"1","_index":"-i-","_primary_term":1,"_seq_no":0,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc","_version":1,"found":true} ``` To issue a simple search you can either use the [Query DSL](https://opensearch.org/docs/latest/opensearch/query-dsl/index/) or a URI search. Here is a simple example with an URI search: -```shell-session -$ curl -XGET -u token: 'https://.logs.ovh.com:9200/logs--i-/_search?q=user:Oles' -{"_shards":{"failed":0,"skipped":0,"successful":1,"total":1},"hits":{"hits":[{"_id":"1","_index":"newindice","_score":0.2876821,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc"}],"max_score":0.2876821,"total":1},"timed_out":false,"took":31} +```bash +$ curl --oauth2-bearer -XGET 'https://.logs.ovh.com:9200/-i-/_search?q=user:Oles' +{"_shards":{"failed":0,"skipped":0,"successful":1,"total":1},"hits":{"hits":[{"_id":"1","_index":"-i-","_score":0.2876821,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc"}],"max_score":0.2876821,"total":1},"timed_out":false,"took":31} ``` ### Use case: Enrich Logs Data on the fly -The following shows how your e-commerce application logs can be sent to the Logs Data Platform whenever a product is ordered. It logs the customer order by using Id for the customers name. For performance reasons or maybe by-design, the application doesn't fetch the full name of the client or other information from the customer database just to produce a log. You can add this information on the fly by using an OpenSearch Index and a Logstash collector on the Logs Data Platform. +The following shows how your e-commerce application logs can be sent to the Logs Data Platform whenever a product is ordered. It logs the customer order by using ID for the customer's name. For performance reasons or maybe by design, the application doesn't fetch the full name of the client or other information from the customer database just to produce a log. You can add this information on the fly by using an OpenSearch Index and a Logstash collector on the Logs Data Platform. -#### Fill an index with clients information +#### Populate an index with clients' information -The first thing to do is to index some clients information. The snippet below is one entry of the client index. +The first thing to do is to index some client information. The snippet below is one entry of the client index. ```json { @@ -137,15 +209,15 @@ The first thing to do is to index some clients information. The snippet below is } ``` -To index several documents at once, it is more efficient to use the bulk api. Here is a small snippet of 3 users you can use to test it. +To index several documents at once, it is more efficient to use the bulk API. Here is a small snippet of 3 users you can use to test it. ```json -{ "index" : { "_index" : "logs--i-" } } -{ "userId": "1", "firstName": "Jon","lastName": "Snow", "age": 22, "address": { "streetAddress": "21 2nd Street", "city": "Winterfell", "state": "North", "postalCode": "14578", "geolocation": { "lat": 54.369488, "long": -5.574768 } },"phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-4567" } ] } -{ "index" : { "_index" : "logs--i-" } } -{ "userId": "2", "firstName": "Cersei","lastName": "Lannister", "age": 43, "address": { "streetAddress": "1 Palace Street", "city": "King's Landing", "state": "The Crownlands", "postalCode": "26863", "geolocation": { "lat": 42.639758, "long": 18.1094725 } },"phoneNumber": [ { "type": "home", "number": "212 555-6789" }, { "type": "mobile", "number": "102 555-8901" } ] } -{ "index" : { "_index" : "logs--i-" } } -{ "userId": "3", "firstName": "Daenerys","lastName": "Targaryen", "age": 22, "address": { "streetAddress": "3 Blackwater Bay Ave", "city": "Dragonstone", "state": "Dragonstone", "postalCode": "75197", "geolocation": { "lat": 43.300097, "long": -2.261580 } },"phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-2345" } ] } +{ "index" : { "_index" : "-i-" } } +{ "userId": "1", "firstName": "Jon","lastName": "Snow", "age": 22, "address": { "streetAddress": "21 2nd Street", "city": "Winterfell", "state": "North", "postalCode": "14578", "geolocation": { "lat": 54.369488, "long": -5.574768 } }, "phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-4567" } ] } +{ "index" : { "_index" : "-i-" } } +{ "userId": "2", "firstName": "Cersei","lastName": "Lannister", "age": 43, "address": { "streetAddress": "1 Palace Street", "city": "King's Landing", "state": "The Crownlands", "postalCode": "26863", "geolocation": { "lat": 42.639758, "long": 18.1094725 } }, "phoneNumber": [ { "type": "home", "number": "212 555-6789" }, { "type": "mobile", "number": "102 555-8901" } ] } +{ "index" : { "_index" : "-i-" } } +{ "userId": "3", "firstName": "Daenerys","lastName": "Targaryen", "age": 22, "address": { "streetAddress": "3 Blackwater Bay Ave", "city": "Dragonstone", "state": "Dragonstone", "postalCode": "75197", "geolocation": { "lat": 43.300097, "long": -2.261580 } }, "phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-2345" } ] } ``` A bulk request is a succession of JSON objects with this structure: @@ -162,14 +234,14 @@ A bulk request is a succession of JSON objects with this structure: You can in one request ask OpenSearch to index, update, delete several documents. Save the content of the previous JSON lines in a file named **bulk** and use the following call to index these 3 users: -```shell-session -$ curl -u token: -XPUT -H 'Content-Type: application/x-ndjson' 'https://.logs.ovh.com:9200/logs--i-/_bulk' --data-binary "@bulk" +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/x-ndjson' 'https://.logs.ovh.com:9200/-i-/_bulk' --data-binary "@bulk" ``` This call will take the content of the bulk file and execute each index operation. Note that you have to use the option **--data-binary** and no **-d** to preserve the newline after each JSON. You can check that your data are properly indexed with the following call: -```shell-session -$ curl -u token: -XGET 'https://.logs.ovh.com:9200/logs--i-/_search?pretty=true' +```bash +$ curl --oauth2-bearer -XGET 'https://.logs.ovh.com:9200/-i-/_search?pretty=true' ``` This will give you back the documents of your index: @@ -187,7 +259,7 @@ This will give you back the documents of your index: "total" : 3, "max_score" : 1.0, "hits" : [ { - "_index" : "logs--i-", + "_index" : "-i-", "_type" : "_doc", "_id" : "AV3HvbQAz85mIBfrJjkV", "_score" : 1.0, @@ -215,7 +287,7 @@ This will give you back the documents of your index: } ] } }, { - "_index" : "logs--i-", + "_index" : "-i-", "_type" : "_doc", "_id" : "AV3HvbQAz85mIBfrJjkW", "_score" : 1.0, @@ -243,7 +315,7 @@ This will give you back the documents of your index: } ] } }, { - "_index" : "logs--i-", + "_index" : "-i-", "_type" : "_doc", "_id" : "AV3HvbQAz85mIBfrJjkX", "_score" : 1.0, @@ -299,9 +371,9 @@ The most important part in this configuration is the filter part: ```ruby opensearch { hosts => ["https://gra2.logs.ovh.com:9200"] - index => "logs--i-" - user => "" - password => "" + index => "-i-" + user => "pat_jwt_logstash" + password => "" enable_sort => false query => "userId:%{[userId]}" fields => { @@ -337,7 +409,7 @@ The mutate plugin is here to show you how you can combine different subfield inf One simple way to test your new Logstash configuration is to send a log by using echo and openssl. Check the examples below: -```shell-session +```bash $ echo -e '{"version":"1.1", "host": "little bird", "short_message": "Warrior from the North", "level":1, "_userId": "2", "_unitType": "Westerosis", "_power_num": 200 }'\0 | openssl s_client -quiet -no_ign_eof -connect : $ echo -e '{"version":"1.1", "host": "little bird", "short_message": "A legendary dragon", "level":1, "_userId": "3", "_unitType": "Dragon", "_power_num": 200000 }'\0 | openssl s_client -quiet -no_ign_eof -connect : ``` @@ -368,7 +440,7 @@ The **maximum size** of your index is fixed and is dependent on the number of sh Note that you can monitor the size of the index by using the following curl query: ```shell-session -$ curl -u token: -XGET -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/logs--i-/_stats/store?pretty' +$ curl --oauth2-bearer -XGET -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/-i-/_stats/store?pretty' ``` This command will give you a document with the following format: @@ -393,7 +465,7 @@ This command will give you a document with the following format: } }, "indices" : { - "logs--i-" : { + "-i-" : { "uuid" : "JC0IWkd3QYSBNd4B2bBZGg", "primaries" : { "store" : { @@ -411,7 +483,7 @@ This command will give you a document with the following format: ``` The size in bytes used to compute your billing is the one under the following path: -"indices" -> "logs--i-" -> "primaries" -> "store" -> "size\_in\_bytes". +"indices" -> "-i-" -> "primaries" -> "store" -> "size\_in\_bytes". ### Management through OpenSearch API @@ -421,8 +493,8 @@ On Logs Data Platform, we allow users to use OpenSearch API to handle the lifecy To create an index on Logs Data Platform, use the following call: -```shell-session -$ curl -u : -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' -d '{ "settings" : {"number_of_shards" : 1}}' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' -d '{ "settings" : {"number_of_shards" : 1}}' ``` - The **-u** option is followed by your LDP username that you can find on **Home** page. The password 'mypassword' follows it after the separator ':' @@ -431,22 +503,22 @@ $ curl -u : -XPUT -H 'Content-Type: application/json' 'htt - The address contains the endpoint of the cluster followed by the **name of your index** - The payload of the request is a **JSON document** which contains the [settings of your index](https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/create-index/): the number of shards (the number of replicas will be automatically set at 1). -You have to follow the Logs Data Platform naming convention `-i-` to create your index. Your username is the one you use to connect to Graylog or to use the API. The suffix can contain any alphanumeric character. +You have to follow the Logs Data Platform naming convention `-i-` to create your index. Your service name can be found on the home page of the Logs Data Platform control panel. The suffix can contain any alphanumeric characters. -To delete a index use the following call: +To delete an index use the following call: -```shell-session -$ curl -u : -XDELETE -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' +```bash +$ curl --oauth2-bearer -XDELETE -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' ``` Here we use the **DELETE** HTTP command to delete the index. #### Alias creation and deletion -Similarly than indices, you can use the API Calls to delete and create aliases on your indices. The only difference is the convention for the name of your alias. Your alias must be formatted as the following **`-a-`**. Here is an example call: +Similarly than indices, you can use the API Calls to delete and create aliases on your indices. The only difference is the convention for the name of your alias. Your alias must be formatted as the following **`-a-`** (or -a- for legacy users). Here is an example call: -```shell-session -$ curl -u : -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-/_alias/-a-' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-/_alias/-a-' ``` This call creates a individual alias on one index you have previously created. @@ -455,13 +527,13 @@ If you need more information on aliases, you can check the [OpenSearch Documenta We also support the aliases API to create aliases: -```shell-session -$ curl -XPOST "https://gra2.logs.ovh.com:9200/_aliases?pretty" -H 'Content-Type: application/json' -d' +```bash +$ curl --oauth2-bearer -XPOST "https://gra2.logs.ovh.com:9200/_aliases?pretty" -H 'Content-Type: application/json' -d' { "actions" : [ - { "remove" : { "index" : "-i-", "alias" : "-a-" } }, - { "add" : { "index" : "-i-", "alias" : "-a-" } }, - { "remove_index": { "index": "-i-" } } + { "remove" : { "index" : "-i-", "alias" : "-a-" } }, + { "add" : { "index" : "-i-", "alias" : "-a-" } }, + { "remove_index": { "index": "-i-" } } ] }' ``` @@ -472,22 +544,22 @@ All the actions (alias change, alias creation and index deletion) will be done i Logs Data Platform supports your custom templates. As for indices and aliases, the template must follow some rules in order for them to work: -- the template name must contain your **``** inside the name. It can be anywhere in the name string. -- The prefix of the indices involved in the template MUST start by **`-i-`**, the "\*" character must be after this prefix -- The alias attached to your template must follow the usual convention: **`-a-`** +- the template name must contain your **``** inside the name. It can be anywhere in the name string. +- The prefix of the indices involved in the template MUST start by one your allowed services so **`-i-`**, the "\*" character must be after this prefix +- The alias attached to your template must follow the usual convention: **`-a-`** -Here is an example of a template for a user **logs-ab-12345**: +Here is an example of a template for a service **ldp-ab-12345**: -```shell-session -$ curl -u : -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/_template/template_for_logs-ab-12345_indices' -d ' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/_template/template_for_ldp-ab-12345_indices' -d ' { - "index_patterns" : [ "logs-ab-12345-i-debug*","logs-ab-12345-i-test*" ], + "index_patterns" : [ "ldp-ab-12345-i-debug*","ldp-ab-12345-i-test*" ], "settings": { "number_of_shards" : 1 }, "aliases" : { - "logs-ab-12345-a-all" : {}, - "logs-ab-12345-a-debug" : { "filter" : { "term" : { "type" : "debug" } } } + "ldp-ab-12345-a-all" : {}, + "ldp-ab-12345-a-debug" : { "filter" : { "term" : { "type" : "debug" } } } } }' ``` @@ -507,8 +579,8 @@ Here the first index was create through API, its description was filled automati Index as a service has some specificities on our platforms. This additional and technical information can help you to use it properly: - **Replication** is set at 1 and cannot be changed. We ensure the high availability of your index in case of a hardware failure. -- The **maximum size** of your index is fixed and is dependent on the number of shards. If search performance is critical, you should choose an index with the highest number of shard you can afford. -- The **index_refresh_interval** of the index is set at 1 second ensuring near real time search results. +- The **maximum size** of your index is fixed and is dependent on the number of shards. If search performance is critical, you should choose the highest number of shards you can afford. +- The **index_refresh_interval** of the index is set at 1 second, ensuring near real time search results. - You are not allowed to change the settings of your index. - You can create an **alias** on Logs Data Platform and attach it to one or several indices. - Unlike indices, aliases are **read-only**, you cannot write through an alias yet. @@ -519,4 +591,4 @@ Index as a service has some specificities on our platforms. This additional and - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.es-es.md b/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.es-es.md index 59deae3fe93..78216c98ff6 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.es-es.md +++ b/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.es-es.md @@ -1,25 +1,25 @@ --- title: OpenSearch Index as a Service excerpt: Use the power of OpenSearch without managing a cluster. -updated: 2024-08-07 +updated: 2025-10-16 --- ## Objective -OpenSearch is one of the main components of the Logs Data Platform, regarded as one of the most powerful search and analytics engines. From the outset we offered the possibility to host an OpenSearch Dashboards index for your OpenSearch Dashboards metadata, Index As A Service being the next step to this functionality. You can now use a fully unlocked index for almost any purpose; be it complex documents, reports or even logs. Thanks to the OpenSearch API, you will be able to use most of the tools of the OpenSearch Ecosystem. +OpenSearch is one of the main components of the Logs Data Platform, regarded as one of the most powerful search and analytics engines. From the outset we offered the possibility to host an OpenSearch Dashboards index for your OpenSearch Dashboards metadata. Index As A Service is the next step. You can now use a fully unlocked index for almost any purpose; be it complex documents, reports or even logs. Thanks to the OpenSearch API, you will be able to use most of the tools of the OpenSearch Ecosystem. ## Requirements This is what you need to know to get you started: - You have created a [Logs Data Platform account](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- You have access to the port 9200 of your cluster (head to the **Home** page in manager to know the address of your cluster). +- You have access to the port 9200 of your cluster (go to the **Home** page in manager to know the address of your cluster). ## Instructions ### First steps with an OpenSearch index -#### Create an index +#### Index name conventions There are two ways to create an OpenSearch Index: @@ -30,36 +30,108 @@ To create an OpenSearch index with the Logs Data Platform manager, you need to g ![add index option](images/add_index.png){.thumbnail} -You must just choose a suffix for your index. The final name will follow this convention: +Simply choose a suffix for your index. The final name will follow this convention: -`logs--i-`. +`-i-`. -For each index, you can specify the number of **shards**. A **shard** is the main component of an **index**. Its maximum storage capacity is set to **25 GB** (per shard). Multiple shards means more volume, more parallelism in your requests and thus more performance. Optionally, you can also be notified when your index is close to its critical size. Once your index is created, you can use it right away. +The service name is the identifier of your Logs Data Platform service. It is different from the username used by non IAM users. The service name starts with `ldp` (e.g. `ldp-ab-12345`). On the other hand, the username starts with `logs` (e.g. `logs-ab-12345`). In this guide we will use **** or **** as tags to let you differentiate both usages. You can find both pieces of information in the **Logs Data Platform control panel**. -When you create an index through the [OpenSearch API](https://opensearch.org/docs/latest/opensearch/index-data/), you can also specify the number of shards. Note that the maximum number of shards by index is limited to **16**. OpenSearch compatible tools can now create indices on the cluster as long as they follow the naming convention `logs--i-`. Here is an example with a curl command with the user **logs-ab-12345** and the index **logs-ab-12345-i-another-index** on gra2 cluster. +> [!primary] +> +> Prior to IAM migration the prefix was . It has now been changed to for all indices created after 17 September 2025. +> -```shell-session -$ curl -u logs-ab-12345:mypassword -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/logs-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 1}}' +For each index, you can specify the number of **shards**. A **shard** is the main component of an **index**. Its maximum storage capacity is set to **25 GB** (per shard). Multiple shards mean more volume, more parallelism in your requests and thus more performance. Optionally, you can also be notified when your index is close to its critical size. Once your index is created, you can use it right away. + +When you create an index through the [OpenSearch API](https://opensearch.org/docs/latest/opensearch/index-data/), you can also specify the number of shards. Note that the maximum number of shards per index is limited to **16**. OpenSearch compatible tools can now create indices on the cluster as long as they follow the naming conventions. + +#### IAM configuration + +If you have enabled [IAM on your account](/pages/manage_and_operate/observability/logs_data_platform/iam_presentation_faq/) you first need to create a policy and give the creation rights to your preferred user/account. See the [IAM for LDP documentation policy guide](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). + +The rights relative to the management of OpenSearch items through the **OVHcloud APIs** are: + + +|Rights |LDP product types|Description| +|---------------------------------------------------|-----------------|-----------| +|ldp:apiovh:url/get |service |Get Logs Data Platform service useful urls| +|ldp:apiovh:output/opensearch/index/create |service |Order a new OpenSearch index over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/create |service |Create a new OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/get |alias |Get OpenSearch aliases over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/edit |alias |Update an OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/index/attach |alias |Attach an OpenSearch index to a OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/index/detach |alias |Detach an OpenSearch index to a OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/delete |alias |Delete an OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/index/get |index |Get OpenSearch indexes over OVHcloud API| +|ldp:apiovh:output/opensearch/index/url/get |index |Get urls of an OpenSearch index over OVHcloud API| +|ldp:apiovh:output/opensearch/index/edit |index |Update an OpenSearch index over OVHcloud API| +|ldp:apiovh:output/opensearch/index/delete |index |Delete an OpenSearch index over OVHcloud API| + + +The rights relative to the management of OpenSearch items through the **OpenSearch API** are: + + +|Rights |LDP product types|Description| +|---------------------------------------------------|-----------------|-----------| +|ldp:opensearch:index/create |service |Create an index over OpenSearch API| +|ldp:opensearch:alias/create |service |Create an alias over OpenSearch API| +|ldp:opensearch:alias/read |alias |Read an alias's contents over OpenSearch API| +|ldp:opensearch:alias/delete |alias |Delete an alias over OpenSearch API| +|ldp:opensearch:index/read |index |Read an index content over OpenSearch API| +|ldp:opensearch:index/write |index |Write content to an index over OpenSearch API| +|ldp:opensearch:index/delete |index |Delete an index over OpenSearch API| + +Attach these rights to your policies freely whether you need to interact directly with the OpenSearch API or through the manager. + +The prefix of all indices or aliases created is . Example: ldp-ab-12345-i-my-awesome-index. +To interact with the OpenSearch API, you can either create [service accounts](/pages/account_and_service_management/account_information/authenticate-api-with-service-account) and leverage the OpenID workflow, or create [local users](/pages/account_and_service_management/account_information/ovhcloud-users-management) with their Personal Access Token with the API: + +> [!api] +> +> @api {v1} /me POST /me/identity/user/{user}/token +> + +This call will return a bearer token for a specific local user. + +You can then use the token of your user to create an index or write documents to your indices. + +```bash +ldp@laptop curl -H 'content-type: application/json' --oauth2-bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c -XPUT 'https://gra2.logs.ovh.com:9200/ldp-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 2}}' +``` + +You can alternatively use the basic scheme authentication with your bearer token as a password for systems that don't support a bearer token (or a custom Authentication Bearer header). The only constraint is to use a username starting with the prefix **pat_jwt_**. For example: + +```bash +ldp@laptop curl -H 'content-type: application/json' -u pat_jwt_user_one:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c -XPUT 'https://gra2.logs.ovh.com:9200/ldp-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 2}}' ``` -There is more information about the API Support at the [dedicated section](#management-through-opensearch-api). +Here, in both examples, the index created will have 2 shards and will appear in your panel. You can then attach it to an IAM policy. + +#### Legacy users + +If you don't have IAM enabled on your account (which will be deprecated) the prefix of indices is `:`. + +Here is an example with a curl command with the user **logs-ab-12345** and the index **logs-ab-12345-i-another-index** on gra2 cluster: + +```bash +$ curl -u logs-ab-12345:mypassword -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/logs-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 1}}' +``` -Whatever method you use, you will be able to query and visualize your documents on Logs Data Platform using the API. #### Index some data -Logs Data Platform OpenSearch indices are compatible with the [OpenSearch REST API](https://opensearch.org/docs/latest/opensearch/rest-api/index/). Therefore, you can use simple http requests to index and search your data. The API is accessible behind a secured https endpoint with mandatory authentication. We recommend that you use [tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens) to authenticate yourself. You can retrieve the endpoint of the API at the **Home** page of your service. Here is a simple example to index a document with curl with an index on the cluster `.logs.ovh.com`. +Logs Data Platform OpenSearch indices are compatible with the [OpenSearch REST API](https://opensearch.org/docs/latest/opensearch/rest-api/index/). Therefore, you can use simple http requests to index and search your data. The API is accessible behind a secured https endpoint with mandatory authentication. You can retrieve the endpoint of the API at the **Home** page of your service. Here is a simple example to index a document with curl on the cluster `.logs.ovh.com`. -```shell-session -$ curl -u token: -XPUT -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/logs--i-/_doc/1' -d '{ "user" : "Oles", "company" : "OVH", "message" : "Hello World !", "post_date" : "1999-11-02T23:01:00" }' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/-i-/_doc/1' -d '{ "user" : "Oles", "company" : "OVH", "message" : "Hello World !", "post_date" : "1999-11-02T23:01:00" }' ``` Here is a quick explanation of this command: - The **PUT** HTTP command can be used to create or modify a document. -- The `Content-Type: application/json` is the mandatory header to indicate that the data will be in the json format. +- The `Content-Type: application/json` is the mandatory header to indicate that the data will be in the JSON format. - The address contains the endpoint of the cluster followed by the **name of your index** -- The **test** just after the index name is the type of the document. +- The **_doc** just after the index name must be used as the type of the document. - The **1** here is the id of your document that can be any string. - The payload of the request is a simple **JSON document** that will be indexed. @@ -68,7 +140,7 @@ This command will return with a simple payload indicating if the document has be ```json { "_id": "1", - "_index": "logs--i-", + "_index": "-i-", "_primary_term": 1, "_seq_no": 0, "_shards": { @@ -86,25 +158,25 @@ This command will return with a simple payload indicating if the document has be There are multiple ways to search your data, this is one area where the OpenSearch REST API excels. You can either get your data directly by using a GET request, or search it with the Search APIs. To get your document indexed previously, use the following curl request: -```shell-session -$ curl -XGET -u token: 'https://.logs.ovh.com:9200/logs--i-/_doc/1' -{"_id":"1","_index":"logs--i-","_primary_term":1,"_seq_no":0,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc","_version":1,"found":true} +```bash +$ curl --oauth2-bearer -XGET 'https://.logs.ovh.com:9200/-i-/_doc/1' +{"_id":"1","_index":"-i-","_primary_term":1,"_seq_no":0,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc","_version":1,"found":true} ``` To issue a simple search you can either use the [Query DSL](https://opensearch.org/docs/latest/opensearch/query-dsl/index/) or a URI search. Here is a simple example with an URI search: -```shell-session -$ curl -XGET -u token: 'https://.logs.ovh.com:9200/logs--i-/_search?q=user:Oles' -{"_shards":{"failed":0,"skipped":0,"successful":1,"total":1},"hits":{"hits":[{"_id":"1","_index":"newindice","_score":0.2876821,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc"}],"max_score":0.2876821,"total":1},"timed_out":false,"took":31} +```bash +$ curl --oauth2-bearer -XGET 'https://.logs.ovh.com:9200/-i-/_search?q=user:Oles' +{"_shards":{"failed":0,"skipped":0,"successful":1,"total":1},"hits":{"hits":[{"_id":"1","_index":"-i-","_score":0.2876821,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc"}],"max_score":0.2876821,"total":1},"timed_out":false,"took":31} ``` ### Use case: Enrich Logs Data on the fly -The following shows how your e-commerce application logs can be sent to the Logs Data Platform whenever a product is ordered. It logs the customer order by using Id for the customers name. For performance reasons or maybe by-design, the application doesn't fetch the full name of the client or other information from the customer database just to produce a log. You can add this information on the fly by using an OpenSearch Index and a Logstash collector on the Logs Data Platform. +The following shows how your e-commerce application logs can be sent to the Logs Data Platform whenever a product is ordered. It logs the customer order by using ID for the customer's name. For performance reasons or maybe by design, the application doesn't fetch the full name of the client or other information from the customer database just to produce a log. You can add this information on the fly by using an OpenSearch Index and a Logstash collector on the Logs Data Platform. -#### Fill an index with clients information +#### Populate an index with clients' information -The first thing to do is to index some clients information. The snippet below is one entry of the client index. +The first thing to do is to index some client information. The snippet below is one entry of the client index. ```json { @@ -137,15 +209,15 @@ The first thing to do is to index some clients information. The snippet below is } ``` -To index several documents at once, it is more efficient to use the bulk api. Here is a small snippet of 3 users you can use to test it. +To index several documents at once, it is more efficient to use the bulk API. Here is a small snippet of 3 users you can use to test it. ```json -{ "index" : { "_index" : "logs--i-" } } -{ "userId": "1", "firstName": "Jon","lastName": "Snow", "age": 22, "address": { "streetAddress": "21 2nd Street", "city": "Winterfell", "state": "North", "postalCode": "14578", "geolocation": { "lat": 54.369488, "long": -5.574768 } },"phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-4567" } ] } -{ "index" : { "_index" : "logs--i-" } } -{ "userId": "2", "firstName": "Cersei","lastName": "Lannister", "age": 43, "address": { "streetAddress": "1 Palace Street", "city": "King's Landing", "state": "The Crownlands", "postalCode": "26863", "geolocation": { "lat": 42.639758, "long": 18.1094725 } },"phoneNumber": [ { "type": "home", "number": "212 555-6789" }, { "type": "mobile", "number": "102 555-8901" } ] } -{ "index" : { "_index" : "logs--i-" } } -{ "userId": "3", "firstName": "Daenerys","lastName": "Targaryen", "age": 22, "address": { "streetAddress": "3 Blackwater Bay Ave", "city": "Dragonstone", "state": "Dragonstone", "postalCode": "75197", "geolocation": { "lat": 43.300097, "long": -2.261580 } },"phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-2345" } ] } +{ "index" : { "_index" : "-i-" } } +{ "userId": "1", "firstName": "Jon","lastName": "Snow", "age": 22, "address": { "streetAddress": "21 2nd Street", "city": "Winterfell", "state": "North", "postalCode": "14578", "geolocation": { "lat": 54.369488, "long": -5.574768 } }, "phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-4567" } ] } +{ "index" : { "_index" : "-i-" } } +{ "userId": "2", "firstName": "Cersei","lastName": "Lannister", "age": 43, "address": { "streetAddress": "1 Palace Street", "city": "King's Landing", "state": "The Crownlands", "postalCode": "26863", "geolocation": { "lat": 42.639758, "long": 18.1094725 } }, "phoneNumber": [ { "type": "home", "number": "212 555-6789" }, { "type": "mobile", "number": "102 555-8901" } ] } +{ "index" : { "_index" : "-i-" } } +{ "userId": "3", "firstName": "Daenerys","lastName": "Targaryen", "age": 22, "address": { "streetAddress": "3 Blackwater Bay Ave", "city": "Dragonstone", "state": "Dragonstone", "postalCode": "75197", "geolocation": { "lat": 43.300097, "long": -2.261580 } }, "phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-2345" } ] } ``` A bulk request is a succession of JSON objects with this structure: @@ -162,14 +234,14 @@ A bulk request is a succession of JSON objects with this structure: You can in one request ask OpenSearch to index, update, delete several documents. Save the content of the previous JSON lines in a file named **bulk** and use the following call to index these 3 users: -```shell-session -$ curl -u token: -XPUT -H 'Content-Type: application/x-ndjson' 'https://.logs.ovh.com:9200/logs--i-/_bulk' --data-binary "@bulk" +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/x-ndjson' 'https://.logs.ovh.com:9200/-i-/_bulk' --data-binary "@bulk" ``` This call will take the content of the bulk file and execute each index operation. Note that you have to use the option **--data-binary** and no **-d** to preserve the newline after each JSON. You can check that your data are properly indexed with the following call: -```shell-session -$ curl -u token: -XGET 'https://.logs.ovh.com:9200/logs--i-/_search?pretty=true' +```bash +$ curl --oauth2-bearer -XGET 'https://.logs.ovh.com:9200/-i-/_search?pretty=true' ``` This will give you back the documents of your index: @@ -187,7 +259,7 @@ This will give you back the documents of your index: "total" : 3, "max_score" : 1.0, "hits" : [ { - "_index" : "logs--i-", + "_index" : "-i-", "_type" : "_doc", "_id" : "AV3HvbQAz85mIBfrJjkV", "_score" : 1.0, @@ -215,7 +287,7 @@ This will give you back the documents of your index: } ] } }, { - "_index" : "logs--i-", + "_index" : "-i-", "_type" : "_doc", "_id" : "AV3HvbQAz85mIBfrJjkW", "_score" : 1.0, @@ -243,7 +315,7 @@ This will give you back the documents of your index: } ] } }, { - "_index" : "logs--i-", + "_index" : "-i-", "_type" : "_doc", "_id" : "AV3HvbQAz85mIBfrJjkX", "_score" : 1.0, @@ -299,9 +371,9 @@ The most important part in this configuration is the filter part: ```ruby opensearch { hosts => ["https://gra2.logs.ovh.com:9200"] - index => "logs--i-" - user => "" - password => "" + index => "-i-" + user => "pat_jwt_logstash" + password => "" enable_sort => false query => "userId:%{[userId]}" fields => { @@ -337,7 +409,7 @@ The mutate plugin is here to show you how you can combine different subfield inf One simple way to test your new Logstash configuration is to send a log by using echo and openssl. Check the examples below: -```shell-session +```bash $ echo -e '{"version":"1.1", "host": "little bird", "short_message": "Warrior from the North", "level":1, "_userId": "2", "_unitType": "Westerosis", "_power_num": 200 }'\0 | openssl s_client -quiet -no_ign_eof -connect : $ echo -e '{"version":"1.1", "host": "little bird", "short_message": "A legendary dragon", "level":1, "_userId": "3", "_unitType": "Dragon", "_power_num": 200000 }'\0 | openssl s_client -quiet -no_ign_eof -connect : ``` @@ -368,7 +440,7 @@ The **maximum size** of your index is fixed and is dependent on the number of sh Note that you can monitor the size of the index by using the following curl query: ```shell-session -$ curl -u token: -XGET -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/logs--i-/_stats/store?pretty' +$ curl --oauth2-bearer -XGET -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/-i-/_stats/store?pretty' ``` This command will give you a document with the following format: @@ -393,7 +465,7 @@ This command will give you a document with the following format: } }, "indices" : { - "logs--i-" : { + "-i-" : { "uuid" : "JC0IWkd3QYSBNd4B2bBZGg", "primaries" : { "store" : { @@ -411,7 +483,7 @@ This command will give you a document with the following format: ``` The size in bytes used to compute your billing is the one under the following path: -"indices" -> "logs--i-" -> "primaries" -> "store" -> "size\_in\_bytes". +"indices" -> "-i-" -> "primaries" -> "store" -> "size\_in\_bytes". ### Management through OpenSearch API @@ -421,8 +493,8 @@ On Logs Data Platform, we allow users to use OpenSearch API to handle the lifecy To create an index on Logs Data Platform, use the following call: -```shell-session -$ curl -u : -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' -d '{ "settings" : {"number_of_shards" : 1}}' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' -d '{ "settings" : {"number_of_shards" : 1}}' ``` - The **-u** option is followed by your LDP username that you can find on **Home** page. The password 'mypassword' follows it after the separator ':' @@ -431,22 +503,22 @@ $ curl -u : -XPUT -H 'Content-Type: application/json' 'htt - The address contains the endpoint of the cluster followed by the **name of your index** - The payload of the request is a **JSON document** which contains the [settings of your index](https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/create-index/): the number of shards (the number of replicas will be automatically set at 1). -You have to follow the Logs Data Platform naming convention `-i-` to create your index. Your username is the one you use to connect to Graylog or to use the API. The suffix can contain any alphanumeric character. +You have to follow the Logs Data Platform naming convention `-i-` to create your index. Your service name can be found on the home page of the Logs Data Platform control panel. The suffix can contain any alphanumeric characters. -To delete a index use the following call: +To delete an index use the following call: -```shell-session -$ curl -u : -XDELETE -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' +```bash +$ curl --oauth2-bearer -XDELETE -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' ``` Here we use the **DELETE** HTTP command to delete the index. #### Alias creation and deletion -Similarly than indices, you can use the API Calls to delete and create aliases on your indices. The only difference is the convention for the name of your alias. Your alias must be formatted as the following **`-a-`**. Here is an example call: +Similarly than indices, you can use the API Calls to delete and create aliases on your indices. The only difference is the convention for the name of your alias. Your alias must be formatted as the following **`-a-`** (or -a- for legacy users). Here is an example call: -```shell-session -$ curl -u : -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-/_alias/-a-' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-/_alias/-a-' ``` This call creates a individual alias on one index you have previously created. @@ -455,13 +527,13 @@ If you need more information on aliases, you can check the [OpenSearch Documenta We also support the aliases API to create aliases: -```shell-session -$ curl -XPOST "https://gra2.logs.ovh.com:9200/_aliases?pretty" -H 'Content-Type: application/json' -d' +```bash +$ curl --oauth2-bearer -XPOST "https://gra2.logs.ovh.com:9200/_aliases?pretty" -H 'Content-Type: application/json' -d' { "actions" : [ - { "remove" : { "index" : "-i-", "alias" : "-a-" } }, - { "add" : { "index" : "-i-", "alias" : "-a-" } }, - { "remove_index": { "index": "-i-" } } + { "remove" : { "index" : "-i-", "alias" : "-a-" } }, + { "add" : { "index" : "-i-", "alias" : "-a-" } }, + { "remove_index": { "index": "-i-" } } ] }' ``` @@ -472,22 +544,22 @@ All the actions (alias change, alias creation and index deletion) will be done i Logs Data Platform supports your custom templates. As for indices and aliases, the template must follow some rules in order for them to work: -- the template name must contain your **``** inside the name. It can be anywhere in the name string. -- The prefix of the indices involved in the template MUST start by **`-i-`**, the "\*" character must be after this prefix -- The alias attached to your template must follow the usual convention: **`-a-`** +- the template name must contain your **``** inside the name. It can be anywhere in the name string. +- The prefix of the indices involved in the template MUST start by one your allowed services so **`-i-`**, the "\*" character must be after this prefix +- The alias attached to your template must follow the usual convention: **`-a-`** -Here is an example of a template for a user **logs-ab-12345**: +Here is an example of a template for a service **ldp-ab-12345**: -```shell-session -$ curl -u : -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/_template/template_for_logs-ab-12345_indices' -d ' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/_template/template_for_ldp-ab-12345_indices' -d ' { - "index_patterns" : [ "logs-ab-12345-i-debug*","logs-ab-12345-i-test*" ], + "index_patterns" : [ "ldp-ab-12345-i-debug*","ldp-ab-12345-i-test*" ], "settings": { "number_of_shards" : 1 }, "aliases" : { - "logs-ab-12345-a-all" : {}, - "logs-ab-12345-a-debug" : { "filter" : { "term" : { "type" : "debug" } } } + "ldp-ab-12345-a-all" : {}, + "ldp-ab-12345-a-debug" : { "filter" : { "term" : { "type" : "debug" } } } } }' ``` @@ -507,8 +579,8 @@ Here the first index was create through API, its description was filled automati Index as a service has some specificities on our platforms. This additional and technical information can help you to use it properly: - **Replication** is set at 1 and cannot be changed. We ensure the high availability of your index in case of a hardware failure. -- The **maximum size** of your index is fixed and is dependent on the number of shards. If search performance is critical, you should choose an index with the highest number of shard you can afford. -- The **index_refresh_interval** of the index is set at 1 second ensuring near real time search results. +- The **maximum size** of your index is fixed and is dependent on the number of shards. If search performance is critical, you should choose the highest number of shards you can afford. +- The **index_refresh_interval** of the index is set at 1 second, ensuring near real time search results. - You are not allowed to change the settings of your index. - You can create an **alias** on Logs Data Platform and attach it to one or several indices. - Unlike indices, aliases are **read-only**, you cannot write through an alias yet. @@ -519,4 +591,4 @@ Index as a service has some specificities on our platforms. This additional and - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.es-us.md b/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.es-us.md index 59deae3fe93..78216c98ff6 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.es-us.md +++ b/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.es-us.md @@ -1,25 +1,25 @@ --- title: OpenSearch Index as a Service excerpt: Use the power of OpenSearch without managing a cluster. -updated: 2024-08-07 +updated: 2025-10-16 --- ## Objective -OpenSearch is one of the main components of the Logs Data Platform, regarded as one of the most powerful search and analytics engines. From the outset we offered the possibility to host an OpenSearch Dashboards index for your OpenSearch Dashboards metadata, Index As A Service being the next step to this functionality. You can now use a fully unlocked index for almost any purpose; be it complex documents, reports or even logs. Thanks to the OpenSearch API, you will be able to use most of the tools of the OpenSearch Ecosystem. +OpenSearch is one of the main components of the Logs Data Platform, regarded as one of the most powerful search and analytics engines. From the outset we offered the possibility to host an OpenSearch Dashboards index for your OpenSearch Dashboards metadata. Index As A Service is the next step. You can now use a fully unlocked index for almost any purpose; be it complex documents, reports or even logs. Thanks to the OpenSearch API, you will be able to use most of the tools of the OpenSearch Ecosystem. ## Requirements This is what you need to know to get you started: - You have created a [Logs Data Platform account](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- You have access to the port 9200 of your cluster (head to the **Home** page in manager to know the address of your cluster). +- You have access to the port 9200 of your cluster (go to the **Home** page in manager to know the address of your cluster). ## Instructions ### First steps with an OpenSearch index -#### Create an index +#### Index name conventions There are two ways to create an OpenSearch Index: @@ -30,36 +30,108 @@ To create an OpenSearch index with the Logs Data Platform manager, you need to g ![add index option](images/add_index.png){.thumbnail} -You must just choose a suffix for your index. The final name will follow this convention: +Simply choose a suffix for your index. The final name will follow this convention: -`logs--i-`. +`-i-`. -For each index, you can specify the number of **shards**. A **shard** is the main component of an **index**. Its maximum storage capacity is set to **25 GB** (per shard). Multiple shards means more volume, more parallelism in your requests and thus more performance. Optionally, you can also be notified when your index is close to its critical size. Once your index is created, you can use it right away. +The service name is the identifier of your Logs Data Platform service. It is different from the username used by non IAM users. The service name starts with `ldp` (e.g. `ldp-ab-12345`). On the other hand, the username starts with `logs` (e.g. `logs-ab-12345`). In this guide we will use **** or **** as tags to let you differentiate both usages. You can find both pieces of information in the **Logs Data Platform control panel**. -When you create an index through the [OpenSearch API](https://opensearch.org/docs/latest/opensearch/index-data/), you can also specify the number of shards. Note that the maximum number of shards by index is limited to **16**. OpenSearch compatible tools can now create indices on the cluster as long as they follow the naming convention `logs--i-`. Here is an example with a curl command with the user **logs-ab-12345** and the index **logs-ab-12345-i-another-index** on gra2 cluster. +> [!primary] +> +> Prior to IAM migration the prefix was . It has now been changed to for all indices created after 17 September 2025. +> -```shell-session -$ curl -u logs-ab-12345:mypassword -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/logs-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 1}}' +For each index, you can specify the number of **shards**. A **shard** is the main component of an **index**. Its maximum storage capacity is set to **25 GB** (per shard). Multiple shards mean more volume, more parallelism in your requests and thus more performance. Optionally, you can also be notified when your index is close to its critical size. Once your index is created, you can use it right away. + +When you create an index through the [OpenSearch API](https://opensearch.org/docs/latest/opensearch/index-data/), you can also specify the number of shards. Note that the maximum number of shards per index is limited to **16**. OpenSearch compatible tools can now create indices on the cluster as long as they follow the naming conventions. + +#### IAM configuration + +If you have enabled [IAM on your account](/pages/manage_and_operate/observability/logs_data_platform/iam_presentation_faq/) you first need to create a policy and give the creation rights to your preferred user/account. See the [IAM for LDP documentation policy guide](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). + +The rights relative to the management of OpenSearch items through the **OVHcloud APIs** are: + + +|Rights |LDP product types|Description| +|---------------------------------------------------|-----------------|-----------| +|ldp:apiovh:url/get |service |Get Logs Data Platform service useful urls| +|ldp:apiovh:output/opensearch/index/create |service |Order a new OpenSearch index over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/create |service |Create a new OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/get |alias |Get OpenSearch aliases over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/edit |alias |Update an OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/index/attach |alias |Attach an OpenSearch index to a OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/index/detach |alias |Detach an OpenSearch index to a OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/delete |alias |Delete an OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/index/get |index |Get OpenSearch indexes over OVHcloud API| +|ldp:apiovh:output/opensearch/index/url/get |index |Get urls of an OpenSearch index over OVHcloud API| +|ldp:apiovh:output/opensearch/index/edit |index |Update an OpenSearch index over OVHcloud API| +|ldp:apiovh:output/opensearch/index/delete |index |Delete an OpenSearch index over OVHcloud API| + + +The rights relative to the management of OpenSearch items through the **OpenSearch API** are: + + +|Rights |LDP product types|Description| +|---------------------------------------------------|-----------------|-----------| +|ldp:opensearch:index/create |service |Create an index over OpenSearch API| +|ldp:opensearch:alias/create |service |Create an alias over OpenSearch API| +|ldp:opensearch:alias/read |alias |Read an alias's contents over OpenSearch API| +|ldp:opensearch:alias/delete |alias |Delete an alias over OpenSearch API| +|ldp:opensearch:index/read |index |Read an index content over OpenSearch API| +|ldp:opensearch:index/write |index |Write content to an index over OpenSearch API| +|ldp:opensearch:index/delete |index |Delete an index over OpenSearch API| + +Attach these rights to your policies freely whether you need to interact directly with the OpenSearch API or through the manager. + +The prefix of all indices or aliases created is . Example: ldp-ab-12345-i-my-awesome-index. +To interact with the OpenSearch API, you can either create [service accounts](/pages/account_and_service_management/account_information/authenticate-api-with-service-account) and leverage the OpenID workflow, or create [local users](/pages/account_and_service_management/account_information/ovhcloud-users-management) with their Personal Access Token with the API: + +> [!api] +> +> @api {v1} /me POST /me/identity/user/{user}/token +> + +This call will return a bearer token for a specific local user. + +You can then use the token of your user to create an index or write documents to your indices. + +```bash +ldp@laptop curl -H 'content-type: application/json' --oauth2-bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c -XPUT 'https://gra2.logs.ovh.com:9200/ldp-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 2}}' +``` + +You can alternatively use the basic scheme authentication with your bearer token as a password for systems that don't support a bearer token (or a custom Authentication Bearer header). The only constraint is to use a username starting with the prefix **pat_jwt_**. For example: + +```bash +ldp@laptop curl -H 'content-type: application/json' -u pat_jwt_user_one:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c -XPUT 'https://gra2.logs.ovh.com:9200/ldp-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 2}}' ``` -There is more information about the API Support at the [dedicated section](#management-through-opensearch-api). +Here, in both examples, the index created will have 2 shards and will appear in your panel. You can then attach it to an IAM policy. + +#### Legacy users + +If you don't have IAM enabled on your account (which will be deprecated) the prefix of indices is `:`. + +Here is an example with a curl command with the user **logs-ab-12345** and the index **logs-ab-12345-i-another-index** on gra2 cluster: + +```bash +$ curl -u logs-ab-12345:mypassword -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/logs-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 1}}' +``` -Whatever method you use, you will be able to query and visualize your documents on Logs Data Platform using the API. #### Index some data -Logs Data Platform OpenSearch indices are compatible with the [OpenSearch REST API](https://opensearch.org/docs/latest/opensearch/rest-api/index/). Therefore, you can use simple http requests to index and search your data. The API is accessible behind a secured https endpoint with mandatory authentication. We recommend that you use [tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens) to authenticate yourself. You can retrieve the endpoint of the API at the **Home** page of your service. Here is a simple example to index a document with curl with an index on the cluster `.logs.ovh.com`. +Logs Data Platform OpenSearch indices are compatible with the [OpenSearch REST API](https://opensearch.org/docs/latest/opensearch/rest-api/index/). Therefore, you can use simple http requests to index and search your data. The API is accessible behind a secured https endpoint with mandatory authentication. You can retrieve the endpoint of the API at the **Home** page of your service. Here is a simple example to index a document with curl on the cluster `.logs.ovh.com`. -```shell-session -$ curl -u token: -XPUT -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/logs--i-/_doc/1' -d '{ "user" : "Oles", "company" : "OVH", "message" : "Hello World !", "post_date" : "1999-11-02T23:01:00" }' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/-i-/_doc/1' -d '{ "user" : "Oles", "company" : "OVH", "message" : "Hello World !", "post_date" : "1999-11-02T23:01:00" }' ``` Here is a quick explanation of this command: - The **PUT** HTTP command can be used to create or modify a document. -- The `Content-Type: application/json` is the mandatory header to indicate that the data will be in the json format. +- The `Content-Type: application/json` is the mandatory header to indicate that the data will be in the JSON format. - The address contains the endpoint of the cluster followed by the **name of your index** -- The **test** just after the index name is the type of the document. +- The **_doc** just after the index name must be used as the type of the document. - The **1** here is the id of your document that can be any string. - The payload of the request is a simple **JSON document** that will be indexed. @@ -68,7 +140,7 @@ This command will return with a simple payload indicating if the document has be ```json { "_id": "1", - "_index": "logs--i-", + "_index": "-i-", "_primary_term": 1, "_seq_no": 0, "_shards": { @@ -86,25 +158,25 @@ This command will return with a simple payload indicating if the document has be There are multiple ways to search your data, this is one area where the OpenSearch REST API excels. You can either get your data directly by using a GET request, or search it with the Search APIs. To get your document indexed previously, use the following curl request: -```shell-session -$ curl -XGET -u token: 'https://.logs.ovh.com:9200/logs--i-/_doc/1' -{"_id":"1","_index":"logs--i-","_primary_term":1,"_seq_no":0,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc","_version":1,"found":true} +```bash +$ curl --oauth2-bearer -XGET 'https://.logs.ovh.com:9200/-i-/_doc/1' +{"_id":"1","_index":"-i-","_primary_term":1,"_seq_no":0,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc","_version":1,"found":true} ``` To issue a simple search you can either use the [Query DSL](https://opensearch.org/docs/latest/opensearch/query-dsl/index/) or a URI search. Here is a simple example with an URI search: -```shell-session -$ curl -XGET -u token: 'https://.logs.ovh.com:9200/logs--i-/_search?q=user:Oles' -{"_shards":{"failed":0,"skipped":0,"successful":1,"total":1},"hits":{"hits":[{"_id":"1","_index":"newindice","_score":0.2876821,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc"}],"max_score":0.2876821,"total":1},"timed_out":false,"took":31} +```bash +$ curl --oauth2-bearer -XGET 'https://.logs.ovh.com:9200/-i-/_search?q=user:Oles' +{"_shards":{"failed":0,"skipped":0,"successful":1,"total":1},"hits":{"hits":[{"_id":"1","_index":"-i-","_score":0.2876821,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc"}],"max_score":0.2876821,"total":1},"timed_out":false,"took":31} ``` ### Use case: Enrich Logs Data on the fly -The following shows how your e-commerce application logs can be sent to the Logs Data Platform whenever a product is ordered. It logs the customer order by using Id for the customers name. For performance reasons or maybe by-design, the application doesn't fetch the full name of the client or other information from the customer database just to produce a log. You can add this information on the fly by using an OpenSearch Index and a Logstash collector on the Logs Data Platform. +The following shows how your e-commerce application logs can be sent to the Logs Data Platform whenever a product is ordered. It logs the customer order by using ID for the customer's name. For performance reasons or maybe by design, the application doesn't fetch the full name of the client or other information from the customer database just to produce a log. You can add this information on the fly by using an OpenSearch Index and a Logstash collector on the Logs Data Platform. -#### Fill an index with clients information +#### Populate an index with clients' information -The first thing to do is to index some clients information. The snippet below is one entry of the client index. +The first thing to do is to index some client information. The snippet below is one entry of the client index. ```json { @@ -137,15 +209,15 @@ The first thing to do is to index some clients information. The snippet below is } ``` -To index several documents at once, it is more efficient to use the bulk api. Here is a small snippet of 3 users you can use to test it. +To index several documents at once, it is more efficient to use the bulk API. Here is a small snippet of 3 users you can use to test it. ```json -{ "index" : { "_index" : "logs--i-" } } -{ "userId": "1", "firstName": "Jon","lastName": "Snow", "age": 22, "address": { "streetAddress": "21 2nd Street", "city": "Winterfell", "state": "North", "postalCode": "14578", "geolocation": { "lat": 54.369488, "long": -5.574768 } },"phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-4567" } ] } -{ "index" : { "_index" : "logs--i-" } } -{ "userId": "2", "firstName": "Cersei","lastName": "Lannister", "age": 43, "address": { "streetAddress": "1 Palace Street", "city": "King's Landing", "state": "The Crownlands", "postalCode": "26863", "geolocation": { "lat": 42.639758, "long": 18.1094725 } },"phoneNumber": [ { "type": "home", "number": "212 555-6789" }, { "type": "mobile", "number": "102 555-8901" } ] } -{ "index" : { "_index" : "logs--i-" } } -{ "userId": "3", "firstName": "Daenerys","lastName": "Targaryen", "age": 22, "address": { "streetAddress": "3 Blackwater Bay Ave", "city": "Dragonstone", "state": "Dragonstone", "postalCode": "75197", "geolocation": { "lat": 43.300097, "long": -2.261580 } },"phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-2345" } ] } +{ "index" : { "_index" : "-i-" } } +{ "userId": "1", "firstName": "Jon","lastName": "Snow", "age": 22, "address": { "streetAddress": "21 2nd Street", "city": "Winterfell", "state": "North", "postalCode": "14578", "geolocation": { "lat": 54.369488, "long": -5.574768 } }, "phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-4567" } ] } +{ "index" : { "_index" : "-i-" } } +{ "userId": "2", "firstName": "Cersei","lastName": "Lannister", "age": 43, "address": { "streetAddress": "1 Palace Street", "city": "King's Landing", "state": "The Crownlands", "postalCode": "26863", "geolocation": { "lat": 42.639758, "long": 18.1094725 } }, "phoneNumber": [ { "type": "home", "number": "212 555-6789" }, { "type": "mobile", "number": "102 555-8901" } ] } +{ "index" : { "_index" : "-i-" } } +{ "userId": "3", "firstName": "Daenerys","lastName": "Targaryen", "age": 22, "address": { "streetAddress": "3 Blackwater Bay Ave", "city": "Dragonstone", "state": "Dragonstone", "postalCode": "75197", "geolocation": { "lat": 43.300097, "long": -2.261580 } }, "phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-2345" } ] } ``` A bulk request is a succession of JSON objects with this structure: @@ -162,14 +234,14 @@ A bulk request is a succession of JSON objects with this structure: You can in one request ask OpenSearch to index, update, delete several documents. Save the content of the previous JSON lines in a file named **bulk** and use the following call to index these 3 users: -```shell-session -$ curl -u token: -XPUT -H 'Content-Type: application/x-ndjson' 'https://.logs.ovh.com:9200/logs--i-/_bulk' --data-binary "@bulk" +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/x-ndjson' 'https://.logs.ovh.com:9200/-i-/_bulk' --data-binary "@bulk" ``` This call will take the content of the bulk file and execute each index operation. Note that you have to use the option **--data-binary** and no **-d** to preserve the newline after each JSON. You can check that your data are properly indexed with the following call: -```shell-session -$ curl -u token: -XGET 'https://.logs.ovh.com:9200/logs--i-/_search?pretty=true' +```bash +$ curl --oauth2-bearer -XGET 'https://.logs.ovh.com:9200/-i-/_search?pretty=true' ``` This will give you back the documents of your index: @@ -187,7 +259,7 @@ This will give you back the documents of your index: "total" : 3, "max_score" : 1.0, "hits" : [ { - "_index" : "logs--i-", + "_index" : "-i-", "_type" : "_doc", "_id" : "AV3HvbQAz85mIBfrJjkV", "_score" : 1.0, @@ -215,7 +287,7 @@ This will give you back the documents of your index: } ] } }, { - "_index" : "logs--i-", + "_index" : "-i-", "_type" : "_doc", "_id" : "AV3HvbQAz85mIBfrJjkW", "_score" : 1.0, @@ -243,7 +315,7 @@ This will give you back the documents of your index: } ] } }, { - "_index" : "logs--i-", + "_index" : "-i-", "_type" : "_doc", "_id" : "AV3HvbQAz85mIBfrJjkX", "_score" : 1.0, @@ -299,9 +371,9 @@ The most important part in this configuration is the filter part: ```ruby opensearch { hosts => ["https://gra2.logs.ovh.com:9200"] - index => "logs--i-" - user => "" - password => "" + index => "-i-" + user => "pat_jwt_logstash" + password => "" enable_sort => false query => "userId:%{[userId]}" fields => { @@ -337,7 +409,7 @@ The mutate plugin is here to show you how you can combine different subfield inf One simple way to test your new Logstash configuration is to send a log by using echo and openssl. Check the examples below: -```shell-session +```bash $ echo -e '{"version":"1.1", "host": "little bird", "short_message": "Warrior from the North", "level":1, "_userId": "2", "_unitType": "Westerosis", "_power_num": 200 }'\0 | openssl s_client -quiet -no_ign_eof -connect : $ echo -e '{"version":"1.1", "host": "little bird", "short_message": "A legendary dragon", "level":1, "_userId": "3", "_unitType": "Dragon", "_power_num": 200000 }'\0 | openssl s_client -quiet -no_ign_eof -connect : ``` @@ -368,7 +440,7 @@ The **maximum size** of your index is fixed and is dependent on the number of sh Note that you can monitor the size of the index by using the following curl query: ```shell-session -$ curl -u token: -XGET -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/logs--i-/_stats/store?pretty' +$ curl --oauth2-bearer -XGET -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/-i-/_stats/store?pretty' ``` This command will give you a document with the following format: @@ -393,7 +465,7 @@ This command will give you a document with the following format: } }, "indices" : { - "logs--i-" : { + "-i-" : { "uuid" : "JC0IWkd3QYSBNd4B2bBZGg", "primaries" : { "store" : { @@ -411,7 +483,7 @@ This command will give you a document with the following format: ``` The size in bytes used to compute your billing is the one under the following path: -"indices" -> "logs--i-" -> "primaries" -> "store" -> "size\_in\_bytes". +"indices" -> "-i-" -> "primaries" -> "store" -> "size\_in\_bytes". ### Management through OpenSearch API @@ -421,8 +493,8 @@ On Logs Data Platform, we allow users to use OpenSearch API to handle the lifecy To create an index on Logs Data Platform, use the following call: -```shell-session -$ curl -u : -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' -d '{ "settings" : {"number_of_shards" : 1}}' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' -d '{ "settings" : {"number_of_shards" : 1}}' ``` - The **-u** option is followed by your LDP username that you can find on **Home** page. The password 'mypassword' follows it after the separator ':' @@ -431,22 +503,22 @@ $ curl -u : -XPUT -H 'Content-Type: application/json' 'htt - The address contains the endpoint of the cluster followed by the **name of your index** - The payload of the request is a **JSON document** which contains the [settings of your index](https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/create-index/): the number of shards (the number of replicas will be automatically set at 1). -You have to follow the Logs Data Platform naming convention `-i-` to create your index. Your username is the one you use to connect to Graylog or to use the API. The suffix can contain any alphanumeric character. +You have to follow the Logs Data Platform naming convention `-i-` to create your index. Your service name can be found on the home page of the Logs Data Platform control panel. The suffix can contain any alphanumeric characters. -To delete a index use the following call: +To delete an index use the following call: -```shell-session -$ curl -u : -XDELETE -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' +```bash +$ curl --oauth2-bearer -XDELETE -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' ``` Here we use the **DELETE** HTTP command to delete the index. #### Alias creation and deletion -Similarly than indices, you can use the API Calls to delete and create aliases on your indices. The only difference is the convention for the name of your alias. Your alias must be formatted as the following **`-a-`**. Here is an example call: +Similarly than indices, you can use the API Calls to delete and create aliases on your indices. The only difference is the convention for the name of your alias. Your alias must be formatted as the following **`-a-`** (or -a- for legacy users). Here is an example call: -```shell-session -$ curl -u : -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-/_alias/-a-' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-/_alias/-a-' ``` This call creates a individual alias on one index you have previously created. @@ -455,13 +527,13 @@ If you need more information on aliases, you can check the [OpenSearch Documenta We also support the aliases API to create aliases: -```shell-session -$ curl -XPOST "https://gra2.logs.ovh.com:9200/_aliases?pretty" -H 'Content-Type: application/json' -d' +```bash +$ curl --oauth2-bearer -XPOST "https://gra2.logs.ovh.com:9200/_aliases?pretty" -H 'Content-Type: application/json' -d' { "actions" : [ - { "remove" : { "index" : "-i-", "alias" : "-a-" } }, - { "add" : { "index" : "-i-", "alias" : "-a-" } }, - { "remove_index": { "index": "-i-" } } + { "remove" : { "index" : "-i-", "alias" : "-a-" } }, + { "add" : { "index" : "-i-", "alias" : "-a-" } }, + { "remove_index": { "index": "-i-" } } ] }' ``` @@ -472,22 +544,22 @@ All the actions (alias change, alias creation and index deletion) will be done i Logs Data Platform supports your custom templates. As for indices and aliases, the template must follow some rules in order for them to work: -- the template name must contain your **``** inside the name. It can be anywhere in the name string. -- The prefix of the indices involved in the template MUST start by **`-i-`**, the "\*" character must be after this prefix -- The alias attached to your template must follow the usual convention: **`-a-`** +- the template name must contain your **``** inside the name. It can be anywhere in the name string. +- The prefix of the indices involved in the template MUST start by one your allowed services so **`-i-`**, the "\*" character must be after this prefix +- The alias attached to your template must follow the usual convention: **`-a-`** -Here is an example of a template for a user **logs-ab-12345**: +Here is an example of a template for a service **ldp-ab-12345**: -```shell-session -$ curl -u : -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/_template/template_for_logs-ab-12345_indices' -d ' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/_template/template_for_ldp-ab-12345_indices' -d ' { - "index_patterns" : [ "logs-ab-12345-i-debug*","logs-ab-12345-i-test*" ], + "index_patterns" : [ "ldp-ab-12345-i-debug*","ldp-ab-12345-i-test*" ], "settings": { "number_of_shards" : 1 }, "aliases" : { - "logs-ab-12345-a-all" : {}, - "logs-ab-12345-a-debug" : { "filter" : { "term" : { "type" : "debug" } } } + "ldp-ab-12345-a-all" : {}, + "ldp-ab-12345-a-debug" : { "filter" : { "term" : { "type" : "debug" } } } } }' ``` @@ -507,8 +579,8 @@ Here the first index was create through API, its description was filled automati Index as a service has some specificities on our platforms. This additional and technical information can help you to use it properly: - **Replication** is set at 1 and cannot be changed. We ensure the high availability of your index in case of a hardware failure. -- The **maximum size** of your index is fixed and is dependent on the number of shards. If search performance is critical, you should choose an index with the highest number of shard you can afford. -- The **index_refresh_interval** of the index is set at 1 second ensuring near real time search results. +- The **maximum size** of your index is fixed and is dependent on the number of shards. If search performance is critical, you should choose the highest number of shards you can afford. +- The **index_refresh_interval** of the index is set at 1 second, ensuring near real time search results. - You are not allowed to change the settings of your index. - You can create an **alias** on Logs Data Platform and attach it to one or several indices. - Unlike indices, aliases are **read-only**, you cannot write through an alias yet. @@ -519,4 +591,4 @@ Index as a service has some specificities on our platforms. This additional and - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.fr-ca.md b/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.fr-ca.md index 3bc409d6bc9..78216c98ff6 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.fr-ca.md +++ b/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.fr-ca.md @@ -1,25 +1,25 @@ --- title: OpenSearch Index as a Service excerpt: Use the power of OpenSearch without managing a cluster. -updated: 2024-08-07 +updated: 2025-10-16 --- ## Objective -OpenSearch is one of the main components of the Logs Data Platform, regarded as one of the most powerful search and analytics engines. From the outset we offered the possibility to host an OpenSearch Dashboards index for your OpenSearch Dashboards metadata, Index As A Service being the next step to this functionality. You can now use a fully unlocked index for almost any purpose; be it complex documents, reports or even logs. Thanks to the OpenSearch API, you will be able to use most of the tools of the OpenSearch Ecosystem. +OpenSearch is one of the main components of the Logs Data Platform, regarded as one of the most powerful search and analytics engines. From the outset we offered the possibility to host an OpenSearch Dashboards index for your OpenSearch Dashboards metadata. Index As A Service is the next step. You can now use a fully unlocked index for almost any purpose; be it complex documents, reports or even logs. Thanks to the OpenSearch API, you will be able to use most of the tools of the OpenSearch Ecosystem. ## Requirements This is what you need to know to get you started: - You have created a [Logs Data Platform account](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- You have access to the port 9200 of your cluster (head to the **Home** page in manager to know the address of your cluster). +- You have access to the port 9200 of your cluster (go to the **Home** page in manager to know the address of your cluster). ## Instructions ### First steps with an OpenSearch index -#### Create an index +#### Index name conventions There are two ways to create an OpenSearch Index: @@ -30,36 +30,108 @@ To create an OpenSearch index with the Logs Data Platform manager, you need to g ![add index option](images/add_index.png){.thumbnail} -You must just choose a suffix for your index. The final name will follow this convention: +Simply choose a suffix for your index. The final name will follow this convention: -`logs--i-`. +`-i-`. -For each index, you can specify the number of **shards**. A **shard** is the main component of an **index**. Its maximum storage capacity is set to **25 GB** (per shard). Multiple shards means more volume, more parallelism in your requests and thus more performance. Optionally, you can also be notified when your index is close to its critical size. Once your index is created, you can use it right away. +The service name is the identifier of your Logs Data Platform service. It is different from the username used by non IAM users. The service name starts with `ldp` (e.g. `ldp-ab-12345`). On the other hand, the username starts with `logs` (e.g. `logs-ab-12345`). In this guide we will use **** or **** as tags to let you differentiate both usages. You can find both pieces of information in the **Logs Data Platform control panel**. -When you create an index through the [OpenSearch API](https://opensearch.org/docs/latest/opensearch/index-data/), you can also specify the number of shards. Note that the maximum number of shards by index is limited to **16**. OpenSearch compatible tools can now create indices on the cluster as long as they follow the naming convention `logs--i-`. Here is an example with a curl command with the user **logs-ab-12345** and the index **logs-ab-12345-i-another-index** on gra2 cluster. +> [!primary] +> +> Prior to IAM migration the prefix was . It has now been changed to for all indices created after 17 September 2025. +> -```shell-session -$ curl -u logs-ab-12345:mypassword -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/logs-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 1}}' +For each index, you can specify the number of **shards**. A **shard** is the main component of an **index**. Its maximum storage capacity is set to **25 GB** (per shard). Multiple shards mean more volume, more parallelism in your requests and thus more performance. Optionally, you can also be notified when your index is close to its critical size. Once your index is created, you can use it right away. + +When you create an index through the [OpenSearch API](https://opensearch.org/docs/latest/opensearch/index-data/), you can also specify the number of shards. Note that the maximum number of shards per index is limited to **16**. OpenSearch compatible tools can now create indices on the cluster as long as they follow the naming conventions. + +#### IAM configuration + +If you have enabled [IAM on your account](/pages/manage_and_operate/observability/logs_data_platform/iam_presentation_faq/) you first need to create a policy and give the creation rights to your preferred user/account. See the [IAM for LDP documentation policy guide](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). + +The rights relative to the management of OpenSearch items through the **OVHcloud APIs** are: + + +|Rights |LDP product types|Description| +|---------------------------------------------------|-----------------|-----------| +|ldp:apiovh:url/get |service |Get Logs Data Platform service useful urls| +|ldp:apiovh:output/opensearch/index/create |service |Order a new OpenSearch index over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/create |service |Create a new OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/get |alias |Get OpenSearch aliases over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/edit |alias |Update an OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/index/attach |alias |Attach an OpenSearch index to a OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/index/detach |alias |Detach an OpenSearch index to a OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/delete |alias |Delete an OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/index/get |index |Get OpenSearch indexes over OVHcloud API| +|ldp:apiovh:output/opensearch/index/url/get |index |Get urls of an OpenSearch index over OVHcloud API| +|ldp:apiovh:output/opensearch/index/edit |index |Update an OpenSearch index over OVHcloud API| +|ldp:apiovh:output/opensearch/index/delete |index |Delete an OpenSearch index over OVHcloud API| + + +The rights relative to the management of OpenSearch items through the **OpenSearch API** are: + + +|Rights |LDP product types|Description| +|---------------------------------------------------|-----------------|-----------| +|ldp:opensearch:index/create |service |Create an index over OpenSearch API| +|ldp:opensearch:alias/create |service |Create an alias over OpenSearch API| +|ldp:opensearch:alias/read |alias |Read an alias's contents over OpenSearch API| +|ldp:opensearch:alias/delete |alias |Delete an alias over OpenSearch API| +|ldp:opensearch:index/read |index |Read an index content over OpenSearch API| +|ldp:opensearch:index/write |index |Write content to an index over OpenSearch API| +|ldp:opensearch:index/delete |index |Delete an index over OpenSearch API| + +Attach these rights to your policies freely whether you need to interact directly with the OpenSearch API or through the manager. + +The prefix of all indices or aliases created is . Example: ldp-ab-12345-i-my-awesome-index. +To interact with the OpenSearch API, you can either create [service accounts](/pages/account_and_service_management/account_information/authenticate-api-with-service-account) and leverage the OpenID workflow, or create [local users](/pages/account_and_service_management/account_information/ovhcloud-users-management) with their Personal Access Token with the API: + +> [!api] +> +> @api {v1} /me POST /me/identity/user/{user}/token +> + +This call will return a bearer token for a specific local user. + +You can then use the token of your user to create an index or write documents to your indices. + +```bash +ldp@laptop curl -H 'content-type: application/json' --oauth2-bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c -XPUT 'https://gra2.logs.ovh.com:9200/ldp-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 2}}' +``` + +You can alternatively use the basic scheme authentication with your bearer token as a password for systems that don't support a bearer token (or a custom Authentication Bearer header). The only constraint is to use a username starting with the prefix **pat_jwt_**. For example: + +```bash +ldp@laptop curl -H 'content-type: application/json' -u pat_jwt_user_one:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c -XPUT 'https://gra2.logs.ovh.com:9200/ldp-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 2}}' ``` -There is more information about the API Support at the [dedicated section](#management-through-opensearch-api). +Here, in both examples, the index created will have 2 shards and will appear in your panel. You can then attach it to an IAM policy. + +#### Legacy users + +If you don't have IAM enabled on your account (which will be deprecated) the prefix of indices is `:`. + +Here is an example with a curl command with the user **logs-ab-12345** and the index **logs-ab-12345-i-another-index** on gra2 cluster: + +```bash +$ curl -u logs-ab-12345:mypassword -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/logs-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 1}}' +``` -Whatever method you use, you will be able to query and visualize your documents on Logs Data Platform using the API. #### Index some data -Logs Data Platform OpenSearch indices are compatible with the [OpenSearch REST API](https://opensearch.org/docs/latest/opensearch/rest-api/index/). Therefore, you can use simple http requests to index and search your data. The API is accessible behind a secured https endpoint with mandatory authentication. We recommend that you use [tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens) to authenticate yourself. You can retrieve the endpoint of the API at the **Home** page of your service. Here is a simple example to index a document with curl with an index on the cluster `.logs.ovh.com`. +Logs Data Platform OpenSearch indices are compatible with the [OpenSearch REST API](https://opensearch.org/docs/latest/opensearch/rest-api/index/). Therefore, you can use simple http requests to index and search your data. The API is accessible behind a secured https endpoint with mandatory authentication. You can retrieve the endpoint of the API at the **Home** page of your service. Here is a simple example to index a document with curl on the cluster `.logs.ovh.com`. -```shell-session -$ curl -u token: -XPUT -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/logs--i-/_doc/1' -d '{ "user" : "Oles", "company" : "OVH", "message" : "Hello World !", "post_date" : "1999-11-02T23:01:00" }' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/-i-/_doc/1' -d '{ "user" : "Oles", "company" : "OVH", "message" : "Hello World !", "post_date" : "1999-11-02T23:01:00" }' ``` Here is a quick explanation of this command: - The **PUT** HTTP command can be used to create or modify a document. -- The `Content-Type: application/json` is the mandatory header to indicate that the data will be in the json format. +- The `Content-Type: application/json` is the mandatory header to indicate that the data will be in the JSON format. - The address contains the endpoint of the cluster followed by the **name of your index** -- The **test** just after the index name is the type of the document. +- The **_doc** just after the index name must be used as the type of the document. - The **1** here is the id of your document that can be any string. - The payload of the request is a simple **JSON document** that will be indexed. @@ -68,7 +140,7 @@ This command will return with a simple payload indicating if the document has be ```json { "_id": "1", - "_index": "logs--i-", + "_index": "-i-", "_primary_term": 1, "_seq_no": 0, "_shards": { @@ -86,25 +158,25 @@ This command will return with a simple payload indicating if the document has be There are multiple ways to search your data, this is one area where the OpenSearch REST API excels. You can either get your data directly by using a GET request, or search it with the Search APIs. To get your document indexed previously, use the following curl request: -```shell-session -$ curl -XGET -u token: 'https://.logs.ovh.com:9200/logs--i-/_doc/1' -{"_id":"1","_index":"logs--i-","_primary_term":1,"_seq_no":0,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc","_version":1,"found":true} +```bash +$ curl --oauth2-bearer -XGET 'https://.logs.ovh.com:9200/-i-/_doc/1' +{"_id":"1","_index":"-i-","_primary_term":1,"_seq_no":0,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc","_version":1,"found":true} ``` To issue a simple search you can either use the [Query DSL](https://opensearch.org/docs/latest/opensearch/query-dsl/index/) or a URI search. Here is a simple example with an URI search: -```shell-session -$ curl -XGET -u token: 'https://.logs.ovh.com:9200/logs--i-/_search?q=user:Oles' -{"_shards":{"failed":0,"skipped":0,"successful":1,"total":1},"hits":{"hits":[{"_id":"1","_index":"newindice","_score":0.2876821,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc"}],"max_score":0.2876821,"total":1},"timed_out":false,"took":31} +```bash +$ curl --oauth2-bearer -XGET 'https://.logs.ovh.com:9200/-i-/_search?q=user:Oles' +{"_shards":{"failed":0,"skipped":0,"successful":1,"total":1},"hits":{"hits":[{"_id":"1","_index":"-i-","_score":0.2876821,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc"}],"max_score":0.2876821,"total":1},"timed_out":false,"took":31} ``` ### Use case: Enrich Logs Data on the fly -The following shows how your e-commerce application logs can be sent to the Logs Data Platform whenever a product is ordered. It logs the customer order by using Id for the customers name. For performance reasons or maybe by-design, the application doesn't fetch the full name of the client or other information from the customer database just to produce a log. You can add this information on the fly by using an OpenSearch Index and a Logstash collector on the Logs Data Platform. +The following shows how your e-commerce application logs can be sent to the Logs Data Platform whenever a product is ordered. It logs the customer order by using ID for the customer's name. For performance reasons or maybe by design, the application doesn't fetch the full name of the client or other information from the customer database just to produce a log. You can add this information on the fly by using an OpenSearch Index and a Logstash collector on the Logs Data Platform. -#### Fill an index with clients information +#### Populate an index with clients' information -The first thing to do is to index some clients information. The snippet below is one entry of the client index. +The first thing to do is to index some client information. The snippet below is one entry of the client index. ```json { @@ -137,15 +209,15 @@ The first thing to do is to index some clients information. The snippet below is } ``` -To index several documents at once, it is more efficient to use the bulk api. Here is a small snippet of 3 users you can use to test it. +To index several documents at once, it is more efficient to use the bulk API. Here is a small snippet of 3 users you can use to test it. ```json -{ "index" : { "_index" : "logs--i-" } } -{ "userId": "1", "firstName": "Jon","lastName": "Snow", "age": 22, "address": { "streetAddress": "21 2nd Street", "city": "Winterfell", "state": "North", "postalCode": "14578", "geolocation": { "lat": 54.369488, "long": -5.574768 } },"phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-4567" } ] } -{ "index" : { "_index" : "logs--i-" } } -{ "userId": "2", "firstName": "Cersei","lastName": "Lannister", "age": 43, "address": { "streetAddress": "1 Palace Street", "city": "King's Landing", "state": "The Crownlands", "postalCode": "26863", "geolocation": { "lat": 42.639758, "long": 18.1094725 } },"phoneNumber": [ { "type": "home", "number": "212 555-6789" }, { "type": "mobile", "number": "102 555-8901" } ] } -{ "index" : { "_index" : "logs--i-" } } -{ "userId": "3", "firstName": "Daenerys","lastName": "Targaryen", "age": 22, "address": { "streetAddress": "3 Blackwater Bay Ave", "city": "Dragonstone", "state": "Dragonstone", "postalCode": "75197", "geolocation": { "lat": 43.300097, "long": -2.261580 } },"phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-2345" } ] } +{ "index" : { "_index" : "-i-" } } +{ "userId": "1", "firstName": "Jon","lastName": "Snow", "age": 22, "address": { "streetAddress": "21 2nd Street", "city": "Winterfell", "state": "North", "postalCode": "14578", "geolocation": { "lat": 54.369488, "long": -5.574768 } }, "phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-4567" } ] } +{ "index" : { "_index" : "-i-" } } +{ "userId": "2", "firstName": "Cersei","lastName": "Lannister", "age": 43, "address": { "streetAddress": "1 Palace Street", "city": "King's Landing", "state": "The Crownlands", "postalCode": "26863", "geolocation": { "lat": 42.639758, "long": 18.1094725 } }, "phoneNumber": [ { "type": "home", "number": "212 555-6789" }, { "type": "mobile", "number": "102 555-8901" } ] } +{ "index" : { "_index" : "-i-" } } +{ "userId": "3", "firstName": "Daenerys","lastName": "Targaryen", "age": 22, "address": { "streetAddress": "3 Blackwater Bay Ave", "city": "Dragonstone", "state": "Dragonstone", "postalCode": "75197", "geolocation": { "lat": 43.300097, "long": -2.261580 } }, "phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-2345" } ] } ``` A bulk request is a succession of JSON objects with this structure: @@ -162,14 +234,14 @@ A bulk request is a succession of JSON objects with this structure: You can in one request ask OpenSearch to index, update, delete several documents. Save the content of the previous JSON lines in a file named **bulk** and use the following call to index these 3 users: -```shell-session -$ curl -u token: -XPUT -H 'Content-Type: application/x-ndjson' 'https://.logs.ovh.com:9200/logs--i-/_bulk' --data-binary "@bulk" +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/x-ndjson' 'https://.logs.ovh.com:9200/-i-/_bulk' --data-binary "@bulk" ``` This call will take the content of the bulk file and execute each index operation. Note that you have to use the option **--data-binary** and no **-d** to preserve the newline after each JSON. You can check that your data are properly indexed with the following call: -```shell-session -$ curl -u token: -XGET 'https://.logs.ovh.com:9200/logs--i-/_search?pretty=true' +```bash +$ curl --oauth2-bearer -XGET 'https://.logs.ovh.com:9200/-i-/_search?pretty=true' ``` This will give you back the documents of your index: @@ -187,7 +259,7 @@ This will give you back the documents of your index: "total" : 3, "max_score" : 1.0, "hits" : [ { - "_index" : "logs--i-", + "_index" : "-i-", "_type" : "_doc", "_id" : "AV3HvbQAz85mIBfrJjkV", "_score" : 1.0, @@ -215,7 +287,7 @@ This will give you back the documents of your index: } ] } }, { - "_index" : "logs--i-", + "_index" : "-i-", "_type" : "_doc", "_id" : "AV3HvbQAz85mIBfrJjkW", "_score" : 1.0, @@ -243,7 +315,7 @@ This will give you back the documents of your index: } ] } }, { - "_index" : "logs--i-", + "_index" : "-i-", "_type" : "_doc", "_id" : "AV3HvbQAz85mIBfrJjkX", "_score" : 1.0, @@ -299,9 +371,9 @@ The most important part in this configuration is the filter part: ```ruby opensearch { hosts => ["https://gra2.logs.ovh.com:9200"] - index => "logs--i-" - user => "" - password => "" + index => "-i-" + user => "pat_jwt_logstash" + password => "" enable_sort => false query => "userId:%{[userId]}" fields => { @@ -337,7 +409,7 @@ The mutate plugin is here to show you how you can combine different subfield inf One simple way to test your new Logstash configuration is to send a log by using echo and openssl. Check the examples below: -```shell-session +```bash $ echo -e '{"version":"1.1", "host": "little bird", "short_message": "Warrior from the North", "level":1, "_userId": "2", "_unitType": "Westerosis", "_power_num": 200 }'\0 | openssl s_client -quiet -no_ign_eof -connect : $ echo -e '{"version":"1.1", "host": "little bird", "short_message": "A legendary dragon", "level":1, "_userId": "3", "_unitType": "Dragon", "_power_num": 200000 }'\0 | openssl s_client -quiet -no_ign_eof -connect : ``` @@ -368,7 +440,7 @@ The **maximum size** of your index is fixed and is dependent on the number of sh Note that you can monitor the size of the index by using the following curl query: ```shell-session -$ curl -u token: -XGET -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/logs--i-/_stats/store?pretty' +$ curl --oauth2-bearer -XGET -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/-i-/_stats/store?pretty' ``` This command will give you a document with the following format: @@ -393,7 +465,7 @@ This command will give you a document with the following format: } }, "indices" : { - "logs--i-" : { + "-i-" : { "uuid" : "JC0IWkd3QYSBNd4B2bBZGg", "primaries" : { "store" : { @@ -411,7 +483,7 @@ This command will give you a document with the following format: ``` The size in bytes used to compute your billing is the one under the following path: -"indices" -> "logs--i-" -> "primaries" -> "store" -> "size\_in\_bytes". +"indices" -> "-i-" -> "primaries" -> "store" -> "size\_in\_bytes". ### Management through OpenSearch API @@ -421,8 +493,8 @@ On Logs Data Platform, we allow users to use OpenSearch API to handle the lifecy To create an index on Logs Data Platform, use the following call: -```shell-session -$ curl -u : -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' -d '{ "settings" : {"number_of_shards" : 1}}' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' -d '{ "settings" : {"number_of_shards" : 1}}' ``` - The **-u** option is followed by your LDP username that you can find on **Home** page. The password 'mypassword' follows it after the separator ':' @@ -431,22 +503,22 @@ $ curl -u : -XPUT -H 'Content-Type: application/json' 'htt - The address contains the endpoint of the cluster followed by the **name of your index** - The payload of the request is a **JSON document** which contains the [settings of your index](https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/create-index/): the number of shards (the number of replicas will be automatically set at 1). -You have to follow the Logs Data Platform naming convention `-i-` to create your index. Your username is the one you use to connect to Graylog or to use the API. The suffix can contain any alphanumeric character. +You have to follow the Logs Data Platform naming convention `-i-` to create your index. Your service name can be found on the home page of the Logs Data Platform control panel. The suffix can contain any alphanumeric characters. -To delete a index use the following call: +To delete an index use the following call: -```shell-session -$ curl -u : -XDELETE -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' +```bash +$ curl --oauth2-bearer -XDELETE -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' ``` Here we use the **DELETE** HTTP command to delete the index. #### Alias creation and deletion -Similarly than indices, you can use the API Calls to delete and create aliases on your indices. The only difference is the convention for the name of your alias. Your alias must be formatted as the following **`-a-`**. Here is an example call: +Similarly than indices, you can use the API Calls to delete and create aliases on your indices. The only difference is the convention for the name of your alias. Your alias must be formatted as the following **`-a-`** (or -a- for legacy users). Here is an example call: -```shell-session -$ curl -u : -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-/_alias/-a-' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-/_alias/-a-' ``` This call creates a individual alias on one index you have previously created. @@ -455,13 +527,13 @@ If you need more information on aliases, you can check the [OpenSearch Documenta We also support the aliases API to create aliases: -```shell-session -$ curl -XPOST "https://gra2.logs.ovh.com:9200/_aliases?pretty" -H 'Content-Type: application/json' -d' +```bash +$ curl --oauth2-bearer -XPOST "https://gra2.logs.ovh.com:9200/_aliases?pretty" -H 'Content-Type: application/json' -d' { "actions" : [ - { "remove" : { "index" : "-i-", "alias" : "-a-" } }, - { "add" : { "index" : "-i-", "alias" : "-a-" } }, - { "remove_index": { "index": "-i-" } } + { "remove" : { "index" : "-i-", "alias" : "-a-" } }, + { "add" : { "index" : "-i-", "alias" : "-a-" } }, + { "remove_index": { "index": "-i-" } } ] }' ``` @@ -472,22 +544,22 @@ All the actions (alias change, alias creation and index deletion) will be done i Logs Data Platform supports your custom templates. As for indices and aliases, the template must follow some rules in order for them to work: -- the template name must contain your **``** inside the name. It can be anywhere in the name string. -- The prefix of the indices involved in the template MUST start by **`-i-`**, the "\*" character must be after this prefix -- The alias attached to your template must follow the usual convention: **`-a-`** +- the template name must contain your **``** inside the name. It can be anywhere in the name string. +- The prefix of the indices involved in the template MUST start by one your allowed services so **`-i-`**, the "\*" character must be after this prefix +- The alias attached to your template must follow the usual convention: **`-a-`** -Here is an exemple of a template for a user **logs-ab-12345**: +Here is an example of a template for a service **ldp-ab-12345**: -```shell-session -$ curl -u : -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/_template/template_for_logs-ab-12345_indices' -d ' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/_template/template_for_ldp-ab-12345_indices' -d ' { - "index_patterns" : [ "logs-ab-12345-i-debug*","logs-ab-12345-i-test*" ], + "index_patterns" : [ "ldp-ab-12345-i-debug*","ldp-ab-12345-i-test*" ], "settings": { "number_of_shards" : 1 }, "aliases" : { - "logs-ab-12345-a-all" : {}, - "logs-ab-12345-a-debug" : { "filter" : { "term" : { "type" : "debug" } } } + "ldp-ab-12345-a-all" : {}, + "ldp-ab-12345-a-debug" : { "filter" : { "term" : { "type" : "debug" } } } } }' ``` @@ -507,8 +579,8 @@ Here the first index was create through API, its description was filled automati Index as a service has some specificities on our platforms. This additional and technical information can help you to use it properly: - **Replication** is set at 1 and cannot be changed. We ensure the high availability of your index in case of a hardware failure. -- The **maximum size** of your index is fixed and is dependent on the number of shards. If search performance is critical, you should choose an index with the highest number of shard you can afford. -- The **index_refresh_interval** of the index is set at 1 second ensuring near real time search results. +- The **maximum size** of your index is fixed and is dependent on the number of shards. If search performance is critical, you should choose the highest number of shards you can afford. +- The **index_refresh_interval** of the index is set at 1 second, ensuring near real time search results. - You are not allowed to change the settings of your index. - You can create an **alias** on Logs Data Platform and attach it to one or several indices. - Unlike indices, aliases are **read-only**, you cannot write through an alias yet. @@ -519,4 +591,4 @@ Index as a service has some specificities on our platforms. This additional and - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.fr-fr.md b/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.fr-fr.md index 3bc409d6bc9..78216c98ff6 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.fr-fr.md +++ b/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.fr-fr.md @@ -1,25 +1,25 @@ --- title: OpenSearch Index as a Service excerpt: Use the power of OpenSearch without managing a cluster. -updated: 2024-08-07 +updated: 2025-10-16 --- ## Objective -OpenSearch is one of the main components of the Logs Data Platform, regarded as one of the most powerful search and analytics engines. From the outset we offered the possibility to host an OpenSearch Dashboards index for your OpenSearch Dashboards metadata, Index As A Service being the next step to this functionality. You can now use a fully unlocked index for almost any purpose; be it complex documents, reports or even logs. Thanks to the OpenSearch API, you will be able to use most of the tools of the OpenSearch Ecosystem. +OpenSearch is one of the main components of the Logs Data Platform, regarded as one of the most powerful search and analytics engines. From the outset we offered the possibility to host an OpenSearch Dashboards index for your OpenSearch Dashboards metadata. Index As A Service is the next step. You can now use a fully unlocked index for almost any purpose; be it complex documents, reports or even logs. Thanks to the OpenSearch API, you will be able to use most of the tools of the OpenSearch Ecosystem. ## Requirements This is what you need to know to get you started: - You have created a [Logs Data Platform account](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- You have access to the port 9200 of your cluster (head to the **Home** page in manager to know the address of your cluster). +- You have access to the port 9200 of your cluster (go to the **Home** page in manager to know the address of your cluster). ## Instructions ### First steps with an OpenSearch index -#### Create an index +#### Index name conventions There are two ways to create an OpenSearch Index: @@ -30,36 +30,108 @@ To create an OpenSearch index with the Logs Data Platform manager, you need to g ![add index option](images/add_index.png){.thumbnail} -You must just choose a suffix for your index. The final name will follow this convention: +Simply choose a suffix for your index. The final name will follow this convention: -`logs--i-`. +`-i-`. -For each index, you can specify the number of **shards**. A **shard** is the main component of an **index**. Its maximum storage capacity is set to **25 GB** (per shard). Multiple shards means more volume, more parallelism in your requests and thus more performance. Optionally, you can also be notified when your index is close to its critical size. Once your index is created, you can use it right away. +The service name is the identifier of your Logs Data Platform service. It is different from the username used by non IAM users. The service name starts with `ldp` (e.g. `ldp-ab-12345`). On the other hand, the username starts with `logs` (e.g. `logs-ab-12345`). In this guide we will use **** or **** as tags to let you differentiate both usages. You can find both pieces of information in the **Logs Data Platform control panel**. -When you create an index through the [OpenSearch API](https://opensearch.org/docs/latest/opensearch/index-data/), you can also specify the number of shards. Note that the maximum number of shards by index is limited to **16**. OpenSearch compatible tools can now create indices on the cluster as long as they follow the naming convention `logs--i-`. Here is an example with a curl command with the user **logs-ab-12345** and the index **logs-ab-12345-i-another-index** on gra2 cluster. +> [!primary] +> +> Prior to IAM migration the prefix was . It has now been changed to for all indices created after 17 September 2025. +> -```shell-session -$ curl -u logs-ab-12345:mypassword -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/logs-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 1}}' +For each index, you can specify the number of **shards**. A **shard** is the main component of an **index**. Its maximum storage capacity is set to **25 GB** (per shard). Multiple shards mean more volume, more parallelism in your requests and thus more performance. Optionally, you can also be notified when your index is close to its critical size. Once your index is created, you can use it right away. + +When you create an index through the [OpenSearch API](https://opensearch.org/docs/latest/opensearch/index-data/), you can also specify the number of shards. Note that the maximum number of shards per index is limited to **16**. OpenSearch compatible tools can now create indices on the cluster as long as they follow the naming conventions. + +#### IAM configuration + +If you have enabled [IAM on your account](/pages/manage_and_operate/observability/logs_data_platform/iam_presentation_faq/) you first need to create a policy and give the creation rights to your preferred user/account. See the [IAM for LDP documentation policy guide](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). + +The rights relative to the management of OpenSearch items through the **OVHcloud APIs** are: + + +|Rights |LDP product types|Description| +|---------------------------------------------------|-----------------|-----------| +|ldp:apiovh:url/get |service |Get Logs Data Platform service useful urls| +|ldp:apiovh:output/opensearch/index/create |service |Order a new OpenSearch index over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/create |service |Create a new OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/get |alias |Get OpenSearch aliases over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/edit |alias |Update an OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/index/attach |alias |Attach an OpenSearch index to a OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/index/detach |alias |Detach an OpenSearch index to a OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/delete |alias |Delete an OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/index/get |index |Get OpenSearch indexes over OVHcloud API| +|ldp:apiovh:output/opensearch/index/url/get |index |Get urls of an OpenSearch index over OVHcloud API| +|ldp:apiovh:output/opensearch/index/edit |index |Update an OpenSearch index over OVHcloud API| +|ldp:apiovh:output/opensearch/index/delete |index |Delete an OpenSearch index over OVHcloud API| + + +The rights relative to the management of OpenSearch items through the **OpenSearch API** are: + + +|Rights |LDP product types|Description| +|---------------------------------------------------|-----------------|-----------| +|ldp:opensearch:index/create |service |Create an index over OpenSearch API| +|ldp:opensearch:alias/create |service |Create an alias over OpenSearch API| +|ldp:opensearch:alias/read |alias |Read an alias's contents over OpenSearch API| +|ldp:opensearch:alias/delete |alias |Delete an alias over OpenSearch API| +|ldp:opensearch:index/read |index |Read an index content over OpenSearch API| +|ldp:opensearch:index/write |index |Write content to an index over OpenSearch API| +|ldp:opensearch:index/delete |index |Delete an index over OpenSearch API| + +Attach these rights to your policies freely whether you need to interact directly with the OpenSearch API or through the manager. + +The prefix of all indices or aliases created is . Example: ldp-ab-12345-i-my-awesome-index. +To interact with the OpenSearch API, you can either create [service accounts](/pages/account_and_service_management/account_information/authenticate-api-with-service-account) and leverage the OpenID workflow, or create [local users](/pages/account_and_service_management/account_information/ovhcloud-users-management) with their Personal Access Token with the API: + +> [!api] +> +> @api {v1} /me POST /me/identity/user/{user}/token +> + +This call will return a bearer token for a specific local user. + +You can then use the token of your user to create an index or write documents to your indices. + +```bash +ldp@laptop curl -H 'content-type: application/json' --oauth2-bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c -XPUT 'https://gra2.logs.ovh.com:9200/ldp-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 2}}' +``` + +You can alternatively use the basic scheme authentication with your bearer token as a password for systems that don't support a bearer token (or a custom Authentication Bearer header). The only constraint is to use a username starting with the prefix **pat_jwt_**. For example: + +```bash +ldp@laptop curl -H 'content-type: application/json' -u pat_jwt_user_one:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c -XPUT 'https://gra2.logs.ovh.com:9200/ldp-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 2}}' ``` -There is more information about the API Support at the [dedicated section](#management-through-opensearch-api). +Here, in both examples, the index created will have 2 shards and will appear in your panel. You can then attach it to an IAM policy. + +#### Legacy users + +If you don't have IAM enabled on your account (which will be deprecated) the prefix of indices is `:`. + +Here is an example with a curl command with the user **logs-ab-12345** and the index **logs-ab-12345-i-another-index** on gra2 cluster: + +```bash +$ curl -u logs-ab-12345:mypassword -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/logs-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 1}}' +``` -Whatever method you use, you will be able to query and visualize your documents on Logs Data Platform using the API. #### Index some data -Logs Data Platform OpenSearch indices are compatible with the [OpenSearch REST API](https://opensearch.org/docs/latest/opensearch/rest-api/index/). Therefore, you can use simple http requests to index and search your data. The API is accessible behind a secured https endpoint with mandatory authentication. We recommend that you use [tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens) to authenticate yourself. You can retrieve the endpoint of the API at the **Home** page of your service. Here is a simple example to index a document with curl with an index on the cluster `.logs.ovh.com`. +Logs Data Platform OpenSearch indices are compatible with the [OpenSearch REST API](https://opensearch.org/docs/latest/opensearch/rest-api/index/). Therefore, you can use simple http requests to index and search your data. The API is accessible behind a secured https endpoint with mandatory authentication. You can retrieve the endpoint of the API at the **Home** page of your service. Here is a simple example to index a document with curl on the cluster `.logs.ovh.com`. -```shell-session -$ curl -u token: -XPUT -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/logs--i-/_doc/1' -d '{ "user" : "Oles", "company" : "OVH", "message" : "Hello World !", "post_date" : "1999-11-02T23:01:00" }' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/-i-/_doc/1' -d '{ "user" : "Oles", "company" : "OVH", "message" : "Hello World !", "post_date" : "1999-11-02T23:01:00" }' ``` Here is a quick explanation of this command: - The **PUT** HTTP command can be used to create or modify a document. -- The `Content-Type: application/json` is the mandatory header to indicate that the data will be in the json format. +- The `Content-Type: application/json` is the mandatory header to indicate that the data will be in the JSON format. - The address contains the endpoint of the cluster followed by the **name of your index** -- The **test** just after the index name is the type of the document. +- The **_doc** just after the index name must be used as the type of the document. - The **1** here is the id of your document that can be any string. - The payload of the request is a simple **JSON document** that will be indexed. @@ -68,7 +140,7 @@ This command will return with a simple payload indicating if the document has be ```json { "_id": "1", - "_index": "logs--i-", + "_index": "-i-", "_primary_term": 1, "_seq_no": 0, "_shards": { @@ -86,25 +158,25 @@ This command will return with a simple payload indicating if the document has be There are multiple ways to search your data, this is one area where the OpenSearch REST API excels. You can either get your data directly by using a GET request, or search it with the Search APIs. To get your document indexed previously, use the following curl request: -```shell-session -$ curl -XGET -u token: 'https://.logs.ovh.com:9200/logs--i-/_doc/1' -{"_id":"1","_index":"logs--i-","_primary_term":1,"_seq_no":0,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc","_version":1,"found":true} +```bash +$ curl --oauth2-bearer -XGET 'https://.logs.ovh.com:9200/-i-/_doc/1' +{"_id":"1","_index":"-i-","_primary_term":1,"_seq_no":0,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc","_version":1,"found":true} ``` To issue a simple search you can either use the [Query DSL](https://opensearch.org/docs/latest/opensearch/query-dsl/index/) or a URI search. Here is a simple example with an URI search: -```shell-session -$ curl -XGET -u token: 'https://.logs.ovh.com:9200/logs--i-/_search?q=user:Oles' -{"_shards":{"failed":0,"skipped":0,"successful":1,"total":1},"hits":{"hits":[{"_id":"1","_index":"newindice","_score":0.2876821,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc"}],"max_score":0.2876821,"total":1},"timed_out":false,"took":31} +```bash +$ curl --oauth2-bearer -XGET 'https://.logs.ovh.com:9200/-i-/_search?q=user:Oles' +{"_shards":{"failed":0,"skipped":0,"successful":1,"total":1},"hits":{"hits":[{"_id":"1","_index":"-i-","_score":0.2876821,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc"}],"max_score":0.2876821,"total":1},"timed_out":false,"took":31} ``` ### Use case: Enrich Logs Data on the fly -The following shows how your e-commerce application logs can be sent to the Logs Data Platform whenever a product is ordered. It logs the customer order by using Id for the customers name. For performance reasons or maybe by-design, the application doesn't fetch the full name of the client or other information from the customer database just to produce a log. You can add this information on the fly by using an OpenSearch Index and a Logstash collector on the Logs Data Platform. +The following shows how your e-commerce application logs can be sent to the Logs Data Platform whenever a product is ordered. It logs the customer order by using ID for the customer's name. For performance reasons or maybe by design, the application doesn't fetch the full name of the client or other information from the customer database just to produce a log. You can add this information on the fly by using an OpenSearch Index and a Logstash collector on the Logs Data Platform. -#### Fill an index with clients information +#### Populate an index with clients' information -The first thing to do is to index some clients information. The snippet below is one entry of the client index. +The first thing to do is to index some client information. The snippet below is one entry of the client index. ```json { @@ -137,15 +209,15 @@ The first thing to do is to index some clients information. The snippet below is } ``` -To index several documents at once, it is more efficient to use the bulk api. Here is a small snippet of 3 users you can use to test it. +To index several documents at once, it is more efficient to use the bulk API. Here is a small snippet of 3 users you can use to test it. ```json -{ "index" : { "_index" : "logs--i-" } } -{ "userId": "1", "firstName": "Jon","lastName": "Snow", "age": 22, "address": { "streetAddress": "21 2nd Street", "city": "Winterfell", "state": "North", "postalCode": "14578", "geolocation": { "lat": 54.369488, "long": -5.574768 } },"phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-4567" } ] } -{ "index" : { "_index" : "logs--i-" } } -{ "userId": "2", "firstName": "Cersei","lastName": "Lannister", "age": 43, "address": { "streetAddress": "1 Palace Street", "city": "King's Landing", "state": "The Crownlands", "postalCode": "26863", "geolocation": { "lat": 42.639758, "long": 18.1094725 } },"phoneNumber": [ { "type": "home", "number": "212 555-6789" }, { "type": "mobile", "number": "102 555-8901" } ] } -{ "index" : { "_index" : "logs--i-" } } -{ "userId": "3", "firstName": "Daenerys","lastName": "Targaryen", "age": 22, "address": { "streetAddress": "3 Blackwater Bay Ave", "city": "Dragonstone", "state": "Dragonstone", "postalCode": "75197", "geolocation": { "lat": 43.300097, "long": -2.261580 } },"phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-2345" } ] } +{ "index" : { "_index" : "-i-" } } +{ "userId": "1", "firstName": "Jon","lastName": "Snow", "age": 22, "address": { "streetAddress": "21 2nd Street", "city": "Winterfell", "state": "North", "postalCode": "14578", "geolocation": { "lat": 54.369488, "long": -5.574768 } }, "phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-4567" } ] } +{ "index" : { "_index" : "-i-" } } +{ "userId": "2", "firstName": "Cersei","lastName": "Lannister", "age": 43, "address": { "streetAddress": "1 Palace Street", "city": "King's Landing", "state": "The Crownlands", "postalCode": "26863", "geolocation": { "lat": 42.639758, "long": 18.1094725 } }, "phoneNumber": [ { "type": "home", "number": "212 555-6789" }, { "type": "mobile", "number": "102 555-8901" } ] } +{ "index" : { "_index" : "-i-" } } +{ "userId": "3", "firstName": "Daenerys","lastName": "Targaryen", "age": 22, "address": { "streetAddress": "3 Blackwater Bay Ave", "city": "Dragonstone", "state": "Dragonstone", "postalCode": "75197", "geolocation": { "lat": 43.300097, "long": -2.261580 } }, "phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-2345" } ] } ``` A bulk request is a succession of JSON objects with this structure: @@ -162,14 +234,14 @@ A bulk request is a succession of JSON objects with this structure: You can in one request ask OpenSearch to index, update, delete several documents. Save the content of the previous JSON lines in a file named **bulk** and use the following call to index these 3 users: -```shell-session -$ curl -u token: -XPUT -H 'Content-Type: application/x-ndjson' 'https://.logs.ovh.com:9200/logs--i-/_bulk' --data-binary "@bulk" +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/x-ndjson' 'https://.logs.ovh.com:9200/-i-/_bulk' --data-binary "@bulk" ``` This call will take the content of the bulk file and execute each index operation. Note that you have to use the option **--data-binary** and no **-d** to preserve the newline after each JSON. You can check that your data are properly indexed with the following call: -```shell-session -$ curl -u token: -XGET 'https://.logs.ovh.com:9200/logs--i-/_search?pretty=true' +```bash +$ curl --oauth2-bearer -XGET 'https://.logs.ovh.com:9200/-i-/_search?pretty=true' ``` This will give you back the documents of your index: @@ -187,7 +259,7 @@ This will give you back the documents of your index: "total" : 3, "max_score" : 1.0, "hits" : [ { - "_index" : "logs--i-", + "_index" : "-i-", "_type" : "_doc", "_id" : "AV3HvbQAz85mIBfrJjkV", "_score" : 1.0, @@ -215,7 +287,7 @@ This will give you back the documents of your index: } ] } }, { - "_index" : "logs--i-", + "_index" : "-i-", "_type" : "_doc", "_id" : "AV3HvbQAz85mIBfrJjkW", "_score" : 1.0, @@ -243,7 +315,7 @@ This will give you back the documents of your index: } ] } }, { - "_index" : "logs--i-", + "_index" : "-i-", "_type" : "_doc", "_id" : "AV3HvbQAz85mIBfrJjkX", "_score" : 1.0, @@ -299,9 +371,9 @@ The most important part in this configuration is the filter part: ```ruby opensearch { hosts => ["https://gra2.logs.ovh.com:9200"] - index => "logs--i-" - user => "" - password => "" + index => "-i-" + user => "pat_jwt_logstash" + password => "" enable_sort => false query => "userId:%{[userId]}" fields => { @@ -337,7 +409,7 @@ The mutate plugin is here to show you how you can combine different subfield inf One simple way to test your new Logstash configuration is to send a log by using echo and openssl. Check the examples below: -```shell-session +```bash $ echo -e '{"version":"1.1", "host": "little bird", "short_message": "Warrior from the North", "level":1, "_userId": "2", "_unitType": "Westerosis", "_power_num": 200 }'\0 | openssl s_client -quiet -no_ign_eof -connect : $ echo -e '{"version":"1.1", "host": "little bird", "short_message": "A legendary dragon", "level":1, "_userId": "3", "_unitType": "Dragon", "_power_num": 200000 }'\0 | openssl s_client -quiet -no_ign_eof -connect : ``` @@ -368,7 +440,7 @@ The **maximum size** of your index is fixed and is dependent on the number of sh Note that you can monitor the size of the index by using the following curl query: ```shell-session -$ curl -u token: -XGET -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/logs--i-/_stats/store?pretty' +$ curl --oauth2-bearer -XGET -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/-i-/_stats/store?pretty' ``` This command will give you a document with the following format: @@ -393,7 +465,7 @@ This command will give you a document with the following format: } }, "indices" : { - "logs--i-" : { + "-i-" : { "uuid" : "JC0IWkd3QYSBNd4B2bBZGg", "primaries" : { "store" : { @@ -411,7 +483,7 @@ This command will give you a document with the following format: ``` The size in bytes used to compute your billing is the one under the following path: -"indices" -> "logs--i-" -> "primaries" -> "store" -> "size\_in\_bytes". +"indices" -> "-i-" -> "primaries" -> "store" -> "size\_in\_bytes". ### Management through OpenSearch API @@ -421,8 +493,8 @@ On Logs Data Platform, we allow users to use OpenSearch API to handle the lifecy To create an index on Logs Data Platform, use the following call: -```shell-session -$ curl -u : -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' -d '{ "settings" : {"number_of_shards" : 1}}' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' -d '{ "settings" : {"number_of_shards" : 1}}' ``` - The **-u** option is followed by your LDP username that you can find on **Home** page. The password 'mypassword' follows it after the separator ':' @@ -431,22 +503,22 @@ $ curl -u : -XPUT -H 'Content-Type: application/json' 'htt - The address contains the endpoint of the cluster followed by the **name of your index** - The payload of the request is a **JSON document** which contains the [settings of your index](https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/create-index/): the number of shards (the number of replicas will be automatically set at 1). -You have to follow the Logs Data Platform naming convention `-i-` to create your index. Your username is the one you use to connect to Graylog or to use the API. The suffix can contain any alphanumeric character. +You have to follow the Logs Data Platform naming convention `-i-` to create your index. Your service name can be found on the home page of the Logs Data Platform control panel. The suffix can contain any alphanumeric characters. -To delete a index use the following call: +To delete an index use the following call: -```shell-session -$ curl -u : -XDELETE -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' +```bash +$ curl --oauth2-bearer -XDELETE -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' ``` Here we use the **DELETE** HTTP command to delete the index. #### Alias creation and deletion -Similarly than indices, you can use the API Calls to delete and create aliases on your indices. The only difference is the convention for the name of your alias. Your alias must be formatted as the following **`-a-`**. Here is an example call: +Similarly than indices, you can use the API Calls to delete and create aliases on your indices. The only difference is the convention for the name of your alias. Your alias must be formatted as the following **`-a-`** (or -a- for legacy users). Here is an example call: -```shell-session -$ curl -u : -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-/_alias/-a-' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-/_alias/-a-' ``` This call creates a individual alias on one index you have previously created. @@ -455,13 +527,13 @@ If you need more information on aliases, you can check the [OpenSearch Documenta We also support the aliases API to create aliases: -```shell-session -$ curl -XPOST "https://gra2.logs.ovh.com:9200/_aliases?pretty" -H 'Content-Type: application/json' -d' +```bash +$ curl --oauth2-bearer -XPOST "https://gra2.logs.ovh.com:9200/_aliases?pretty" -H 'Content-Type: application/json' -d' { "actions" : [ - { "remove" : { "index" : "-i-", "alias" : "-a-" } }, - { "add" : { "index" : "-i-", "alias" : "-a-" } }, - { "remove_index": { "index": "-i-" } } + { "remove" : { "index" : "-i-", "alias" : "-a-" } }, + { "add" : { "index" : "-i-", "alias" : "-a-" } }, + { "remove_index": { "index": "-i-" } } ] }' ``` @@ -472,22 +544,22 @@ All the actions (alias change, alias creation and index deletion) will be done i Logs Data Platform supports your custom templates. As for indices and aliases, the template must follow some rules in order for them to work: -- the template name must contain your **``** inside the name. It can be anywhere in the name string. -- The prefix of the indices involved in the template MUST start by **`-i-`**, the "\*" character must be after this prefix -- The alias attached to your template must follow the usual convention: **`-a-`** +- the template name must contain your **``** inside the name. It can be anywhere in the name string. +- The prefix of the indices involved in the template MUST start by one your allowed services so **`-i-`**, the "\*" character must be after this prefix +- The alias attached to your template must follow the usual convention: **`-a-`** -Here is an exemple of a template for a user **logs-ab-12345**: +Here is an example of a template for a service **ldp-ab-12345**: -```shell-session -$ curl -u : -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/_template/template_for_logs-ab-12345_indices' -d ' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/_template/template_for_ldp-ab-12345_indices' -d ' { - "index_patterns" : [ "logs-ab-12345-i-debug*","logs-ab-12345-i-test*" ], + "index_patterns" : [ "ldp-ab-12345-i-debug*","ldp-ab-12345-i-test*" ], "settings": { "number_of_shards" : 1 }, "aliases" : { - "logs-ab-12345-a-all" : {}, - "logs-ab-12345-a-debug" : { "filter" : { "term" : { "type" : "debug" } } } + "ldp-ab-12345-a-all" : {}, + "ldp-ab-12345-a-debug" : { "filter" : { "term" : { "type" : "debug" } } } } }' ``` @@ -507,8 +579,8 @@ Here the first index was create through API, its description was filled automati Index as a service has some specificities on our platforms. This additional and technical information can help you to use it properly: - **Replication** is set at 1 and cannot be changed. We ensure the high availability of your index in case of a hardware failure. -- The **maximum size** of your index is fixed and is dependent on the number of shards. If search performance is critical, you should choose an index with the highest number of shard you can afford. -- The **index_refresh_interval** of the index is set at 1 second ensuring near real time search results. +- The **maximum size** of your index is fixed and is dependent on the number of shards. If search performance is critical, you should choose the highest number of shards you can afford. +- The **index_refresh_interval** of the index is set at 1 second, ensuring near real time search results. - You are not allowed to change the settings of your index. - You can create an **alias** on Logs Data Platform and attach it to one or several indices. - Unlike indices, aliases are **read-only**, you cannot write through an alias yet. @@ -519,4 +591,4 @@ Index as a service has some specificities on our platforms. This additional and - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.it-it.md b/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.it-it.md index 59deae3fe93..78216c98ff6 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.it-it.md +++ b/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.it-it.md @@ -1,25 +1,25 @@ --- title: OpenSearch Index as a Service excerpt: Use the power of OpenSearch without managing a cluster. -updated: 2024-08-07 +updated: 2025-10-16 --- ## Objective -OpenSearch is one of the main components of the Logs Data Platform, regarded as one of the most powerful search and analytics engines. From the outset we offered the possibility to host an OpenSearch Dashboards index for your OpenSearch Dashboards metadata, Index As A Service being the next step to this functionality. You can now use a fully unlocked index for almost any purpose; be it complex documents, reports or even logs. Thanks to the OpenSearch API, you will be able to use most of the tools of the OpenSearch Ecosystem. +OpenSearch is one of the main components of the Logs Data Platform, regarded as one of the most powerful search and analytics engines. From the outset we offered the possibility to host an OpenSearch Dashboards index for your OpenSearch Dashboards metadata. Index As A Service is the next step. You can now use a fully unlocked index for almost any purpose; be it complex documents, reports or even logs. Thanks to the OpenSearch API, you will be able to use most of the tools of the OpenSearch Ecosystem. ## Requirements This is what you need to know to get you started: - You have created a [Logs Data Platform account](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- You have access to the port 9200 of your cluster (head to the **Home** page in manager to know the address of your cluster). +- You have access to the port 9200 of your cluster (go to the **Home** page in manager to know the address of your cluster). ## Instructions ### First steps with an OpenSearch index -#### Create an index +#### Index name conventions There are two ways to create an OpenSearch Index: @@ -30,36 +30,108 @@ To create an OpenSearch index with the Logs Data Platform manager, you need to g ![add index option](images/add_index.png){.thumbnail} -You must just choose a suffix for your index. The final name will follow this convention: +Simply choose a suffix for your index. The final name will follow this convention: -`logs--i-`. +`-i-`. -For each index, you can specify the number of **shards**. A **shard** is the main component of an **index**. Its maximum storage capacity is set to **25 GB** (per shard). Multiple shards means more volume, more parallelism in your requests and thus more performance. Optionally, you can also be notified when your index is close to its critical size. Once your index is created, you can use it right away. +The service name is the identifier of your Logs Data Platform service. It is different from the username used by non IAM users. The service name starts with `ldp` (e.g. `ldp-ab-12345`). On the other hand, the username starts with `logs` (e.g. `logs-ab-12345`). In this guide we will use **** or **** as tags to let you differentiate both usages. You can find both pieces of information in the **Logs Data Platform control panel**. -When you create an index through the [OpenSearch API](https://opensearch.org/docs/latest/opensearch/index-data/), you can also specify the number of shards. Note that the maximum number of shards by index is limited to **16**. OpenSearch compatible tools can now create indices on the cluster as long as they follow the naming convention `logs--i-`. Here is an example with a curl command with the user **logs-ab-12345** and the index **logs-ab-12345-i-another-index** on gra2 cluster. +> [!primary] +> +> Prior to IAM migration the prefix was . It has now been changed to for all indices created after 17 September 2025. +> -```shell-session -$ curl -u logs-ab-12345:mypassword -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/logs-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 1}}' +For each index, you can specify the number of **shards**. A **shard** is the main component of an **index**. Its maximum storage capacity is set to **25 GB** (per shard). Multiple shards mean more volume, more parallelism in your requests and thus more performance. Optionally, you can also be notified when your index is close to its critical size. Once your index is created, you can use it right away. + +When you create an index through the [OpenSearch API](https://opensearch.org/docs/latest/opensearch/index-data/), you can also specify the number of shards. Note that the maximum number of shards per index is limited to **16**. OpenSearch compatible tools can now create indices on the cluster as long as they follow the naming conventions. + +#### IAM configuration + +If you have enabled [IAM on your account](/pages/manage_and_operate/observability/logs_data_platform/iam_presentation_faq/) you first need to create a policy and give the creation rights to your preferred user/account. See the [IAM for LDP documentation policy guide](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). + +The rights relative to the management of OpenSearch items through the **OVHcloud APIs** are: + + +|Rights |LDP product types|Description| +|---------------------------------------------------|-----------------|-----------| +|ldp:apiovh:url/get |service |Get Logs Data Platform service useful urls| +|ldp:apiovh:output/opensearch/index/create |service |Order a new OpenSearch index over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/create |service |Create a new OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/get |alias |Get OpenSearch aliases over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/edit |alias |Update an OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/index/attach |alias |Attach an OpenSearch index to a OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/index/detach |alias |Detach an OpenSearch index to a OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/delete |alias |Delete an OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/index/get |index |Get OpenSearch indexes over OVHcloud API| +|ldp:apiovh:output/opensearch/index/url/get |index |Get urls of an OpenSearch index over OVHcloud API| +|ldp:apiovh:output/opensearch/index/edit |index |Update an OpenSearch index over OVHcloud API| +|ldp:apiovh:output/opensearch/index/delete |index |Delete an OpenSearch index over OVHcloud API| + + +The rights relative to the management of OpenSearch items through the **OpenSearch API** are: + + +|Rights |LDP product types|Description| +|---------------------------------------------------|-----------------|-----------| +|ldp:opensearch:index/create |service |Create an index over OpenSearch API| +|ldp:opensearch:alias/create |service |Create an alias over OpenSearch API| +|ldp:opensearch:alias/read |alias |Read an alias's contents over OpenSearch API| +|ldp:opensearch:alias/delete |alias |Delete an alias over OpenSearch API| +|ldp:opensearch:index/read |index |Read an index content over OpenSearch API| +|ldp:opensearch:index/write |index |Write content to an index over OpenSearch API| +|ldp:opensearch:index/delete |index |Delete an index over OpenSearch API| + +Attach these rights to your policies freely whether you need to interact directly with the OpenSearch API or through the manager. + +The prefix of all indices or aliases created is . Example: ldp-ab-12345-i-my-awesome-index. +To interact with the OpenSearch API, you can either create [service accounts](/pages/account_and_service_management/account_information/authenticate-api-with-service-account) and leverage the OpenID workflow, or create [local users](/pages/account_and_service_management/account_information/ovhcloud-users-management) with their Personal Access Token with the API: + +> [!api] +> +> @api {v1} /me POST /me/identity/user/{user}/token +> + +This call will return a bearer token for a specific local user. + +You can then use the token of your user to create an index or write documents to your indices. + +```bash +ldp@laptop curl -H 'content-type: application/json' --oauth2-bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c -XPUT 'https://gra2.logs.ovh.com:9200/ldp-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 2}}' +``` + +You can alternatively use the basic scheme authentication with your bearer token as a password for systems that don't support a bearer token (or a custom Authentication Bearer header). The only constraint is to use a username starting with the prefix **pat_jwt_**. For example: + +```bash +ldp@laptop curl -H 'content-type: application/json' -u pat_jwt_user_one:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c -XPUT 'https://gra2.logs.ovh.com:9200/ldp-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 2}}' ``` -There is more information about the API Support at the [dedicated section](#management-through-opensearch-api). +Here, in both examples, the index created will have 2 shards and will appear in your panel. You can then attach it to an IAM policy. + +#### Legacy users + +If you don't have IAM enabled on your account (which will be deprecated) the prefix of indices is `:`. + +Here is an example with a curl command with the user **logs-ab-12345** and the index **logs-ab-12345-i-another-index** on gra2 cluster: + +```bash +$ curl -u logs-ab-12345:mypassword -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/logs-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 1}}' +``` -Whatever method you use, you will be able to query and visualize your documents on Logs Data Platform using the API. #### Index some data -Logs Data Platform OpenSearch indices are compatible with the [OpenSearch REST API](https://opensearch.org/docs/latest/opensearch/rest-api/index/). Therefore, you can use simple http requests to index and search your data. The API is accessible behind a secured https endpoint with mandatory authentication. We recommend that you use [tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens) to authenticate yourself. You can retrieve the endpoint of the API at the **Home** page of your service. Here is a simple example to index a document with curl with an index on the cluster `.logs.ovh.com`. +Logs Data Platform OpenSearch indices are compatible with the [OpenSearch REST API](https://opensearch.org/docs/latest/opensearch/rest-api/index/). Therefore, you can use simple http requests to index and search your data. The API is accessible behind a secured https endpoint with mandatory authentication. You can retrieve the endpoint of the API at the **Home** page of your service. Here is a simple example to index a document with curl on the cluster `.logs.ovh.com`. -```shell-session -$ curl -u token: -XPUT -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/logs--i-/_doc/1' -d '{ "user" : "Oles", "company" : "OVH", "message" : "Hello World !", "post_date" : "1999-11-02T23:01:00" }' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/-i-/_doc/1' -d '{ "user" : "Oles", "company" : "OVH", "message" : "Hello World !", "post_date" : "1999-11-02T23:01:00" }' ``` Here is a quick explanation of this command: - The **PUT** HTTP command can be used to create or modify a document. -- The `Content-Type: application/json` is the mandatory header to indicate that the data will be in the json format. +- The `Content-Type: application/json` is the mandatory header to indicate that the data will be in the JSON format. - The address contains the endpoint of the cluster followed by the **name of your index** -- The **test** just after the index name is the type of the document. +- The **_doc** just after the index name must be used as the type of the document. - The **1** here is the id of your document that can be any string. - The payload of the request is a simple **JSON document** that will be indexed. @@ -68,7 +140,7 @@ This command will return with a simple payload indicating if the document has be ```json { "_id": "1", - "_index": "logs--i-", + "_index": "-i-", "_primary_term": 1, "_seq_no": 0, "_shards": { @@ -86,25 +158,25 @@ This command will return with a simple payload indicating if the document has be There are multiple ways to search your data, this is one area where the OpenSearch REST API excels. You can either get your data directly by using a GET request, or search it with the Search APIs. To get your document indexed previously, use the following curl request: -```shell-session -$ curl -XGET -u token: 'https://.logs.ovh.com:9200/logs--i-/_doc/1' -{"_id":"1","_index":"logs--i-","_primary_term":1,"_seq_no":0,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc","_version":1,"found":true} +```bash +$ curl --oauth2-bearer -XGET 'https://.logs.ovh.com:9200/-i-/_doc/1' +{"_id":"1","_index":"-i-","_primary_term":1,"_seq_no":0,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc","_version":1,"found":true} ``` To issue a simple search you can either use the [Query DSL](https://opensearch.org/docs/latest/opensearch/query-dsl/index/) or a URI search. Here is a simple example with an URI search: -```shell-session -$ curl -XGET -u token: 'https://.logs.ovh.com:9200/logs--i-/_search?q=user:Oles' -{"_shards":{"failed":0,"skipped":0,"successful":1,"total":1},"hits":{"hits":[{"_id":"1","_index":"newindice","_score":0.2876821,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc"}],"max_score":0.2876821,"total":1},"timed_out":false,"took":31} +```bash +$ curl --oauth2-bearer -XGET 'https://.logs.ovh.com:9200/-i-/_search?q=user:Oles' +{"_shards":{"failed":0,"skipped":0,"successful":1,"total":1},"hits":{"hits":[{"_id":"1","_index":"-i-","_score":0.2876821,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc"}],"max_score":0.2876821,"total":1},"timed_out":false,"took":31} ``` ### Use case: Enrich Logs Data on the fly -The following shows how your e-commerce application logs can be sent to the Logs Data Platform whenever a product is ordered. It logs the customer order by using Id for the customers name. For performance reasons or maybe by-design, the application doesn't fetch the full name of the client or other information from the customer database just to produce a log. You can add this information on the fly by using an OpenSearch Index and a Logstash collector on the Logs Data Platform. +The following shows how your e-commerce application logs can be sent to the Logs Data Platform whenever a product is ordered. It logs the customer order by using ID for the customer's name. For performance reasons or maybe by design, the application doesn't fetch the full name of the client or other information from the customer database just to produce a log. You can add this information on the fly by using an OpenSearch Index and a Logstash collector on the Logs Data Platform. -#### Fill an index with clients information +#### Populate an index with clients' information -The first thing to do is to index some clients information. The snippet below is one entry of the client index. +The first thing to do is to index some client information. The snippet below is one entry of the client index. ```json { @@ -137,15 +209,15 @@ The first thing to do is to index some clients information. The snippet below is } ``` -To index several documents at once, it is more efficient to use the bulk api. Here is a small snippet of 3 users you can use to test it. +To index several documents at once, it is more efficient to use the bulk API. Here is a small snippet of 3 users you can use to test it. ```json -{ "index" : { "_index" : "logs--i-" } } -{ "userId": "1", "firstName": "Jon","lastName": "Snow", "age": 22, "address": { "streetAddress": "21 2nd Street", "city": "Winterfell", "state": "North", "postalCode": "14578", "geolocation": { "lat": 54.369488, "long": -5.574768 } },"phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-4567" } ] } -{ "index" : { "_index" : "logs--i-" } } -{ "userId": "2", "firstName": "Cersei","lastName": "Lannister", "age": 43, "address": { "streetAddress": "1 Palace Street", "city": "King's Landing", "state": "The Crownlands", "postalCode": "26863", "geolocation": { "lat": 42.639758, "long": 18.1094725 } },"phoneNumber": [ { "type": "home", "number": "212 555-6789" }, { "type": "mobile", "number": "102 555-8901" } ] } -{ "index" : { "_index" : "logs--i-" } } -{ "userId": "3", "firstName": "Daenerys","lastName": "Targaryen", "age": 22, "address": { "streetAddress": "3 Blackwater Bay Ave", "city": "Dragonstone", "state": "Dragonstone", "postalCode": "75197", "geolocation": { "lat": 43.300097, "long": -2.261580 } },"phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-2345" } ] } +{ "index" : { "_index" : "-i-" } } +{ "userId": "1", "firstName": "Jon","lastName": "Snow", "age": 22, "address": { "streetAddress": "21 2nd Street", "city": "Winterfell", "state": "North", "postalCode": "14578", "geolocation": { "lat": 54.369488, "long": -5.574768 } }, "phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-4567" } ] } +{ "index" : { "_index" : "-i-" } } +{ "userId": "2", "firstName": "Cersei","lastName": "Lannister", "age": 43, "address": { "streetAddress": "1 Palace Street", "city": "King's Landing", "state": "The Crownlands", "postalCode": "26863", "geolocation": { "lat": 42.639758, "long": 18.1094725 } }, "phoneNumber": [ { "type": "home", "number": "212 555-6789" }, { "type": "mobile", "number": "102 555-8901" } ] } +{ "index" : { "_index" : "-i-" } } +{ "userId": "3", "firstName": "Daenerys","lastName": "Targaryen", "age": 22, "address": { "streetAddress": "3 Blackwater Bay Ave", "city": "Dragonstone", "state": "Dragonstone", "postalCode": "75197", "geolocation": { "lat": 43.300097, "long": -2.261580 } }, "phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-2345" } ] } ``` A bulk request is a succession of JSON objects with this structure: @@ -162,14 +234,14 @@ A bulk request is a succession of JSON objects with this structure: You can in one request ask OpenSearch to index, update, delete several documents. Save the content of the previous JSON lines in a file named **bulk** and use the following call to index these 3 users: -```shell-session -$ curl -u token: -XPUT -H 'Content-Type: application/x-ndjson' 'https://.logs.ovh.com:9200/logs--i-/_bulk' --data-binary "@bulk" +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/x-ndjson' 'https://.logs.ovh.com:9200/-i-/_bulk' --data-binary "@bulk" ``` This call will take the content of the bulk file and execute each index operation. Note that you have to use the option **--data-binary** and no **-d** to preserve the newline after each JSON. You can check that your data are properly indexed with the following call: -```shell-session -$ curl -u token: -XGET 'https://.logs.ovh.com:9200/logs--i-/_search?pretty=true' +```bash +$ curl --oauth2-bearer -XGET 'https://.logs.ovh.com:9200/-i-/_search?pretty=true' ``` This will give you back the documents of your index: @@ -187,7 +259,7 @@ This will give you back the documents of your index: "total" : 3, "max_score" : 1.0, "hits" : [ { - "_index" : "logs--i-", + "_index" : "-i-", "_type" : "_doc", "_id" : "AV3HvbQAz85mIBfrJjkV", "_score" : 1.0, @@ -215,7 +287,7 @@ This will give you back the documents of your index: } ] } }, { - "_index" : "logs--i-", + "_index" : "-i-", "_type" : "_doc", "_id" : "AV3HvbQAz85mIBfrJjkW", "_score" : 1.0, @@ -243,7 +315,7 @@ This will give you back the documents of your index: } ] } }, { - "_index" : "logs--i-", + "_index" : "-i-", "_type" : "_doc", "_id" : "AV3HvbQAz85mIBfrJjkX", "_score" : 1.0, @@ -299,9 +371,9 @@ The most important part in this configuration is the filter part: ```ruby opensearch { hosts => ["https://gra2.logs.ovh.com:9200"] - index => "logs--i-" - user => "" - password => "" + index => "-i-" + user => "pat_jwt_logstash" + password => "" enable_sort => false query => "userId:%{[userId]}" fields => { @@ -337,7 +409,7 @@ The mutate plugin is here to show you how you can combine different subfield inf One simple way to test your new Logstash configuration is to send a log by using echo and openssl. Check the examples below: -```shell-session +```bash $ echo -e '{"version":"1.1", "host": "little bird", "short_message": "Warrior from the North", "level":1, "_userId": "2", "_unitType": "Westerosis", "_power_num": 200 }'\0 | openssl s_client -quiet -no_ign_eof -connect : $ echo -e '{"version":"1.1", "host": "little bird", "short_message": "A legendary dragon", "level":1, "_userId": "3", "_unitType": "Dragon", "_power_num": 200000 }'\0 | openssl s_client -quiet -no_ign_eof -connect : ``` @@ -368,7 +440,7 @@ The **maximum size** of your index is fixed and is dependent on the number of sh Note that you can monitor the size of the index by using the following curl query: ```shell-session -$ curl -u token: -XGET -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/logs--i-/_stats/store?pretty' +$ curl --oauth2-bearer -XGET -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/-i-/_stats/store?pretty' ``` This command will give you a document with the following format: @@ -393,7 +465,7 @@ This command will give you a document with the following format: } }, "indices" : { - "logs--i-" : { + "-i-" : { "uuid" : "JC0IWkd3QYSBNd4B2bBZGg", "primaries" : { "store" : { @@ -411,7 +483,7 @@ This command will give you a document with the following format: ``` The size in bytes used to compute your billing is the one under the following path: -"indices" -> "logs--i-" -> "primaries" -> "store" -> "size\_in\_bytes". +"indices" -> "-i-" -> "primaries" -> "store" -> "size\_in\_bytes". ### Management through OpenSearch API @@ -421,8 +493,8 @@ On Logs Data Platform, we allow users to use OpenSearch API to handle the lifecy To create an index on Logs Data Platform, use the following call: -```shell-session -$ curl -u : -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' -d '{ "settings" : {"number_of_shards" : 1}}' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' -d '{ "settings" : {"number_of_shards" : 1}}' ``` - The **-u** option is followed by your LDP username that you can find on **Home** page. The password 'mypassword' follows it after the separator ':' @@ -431,22 +503,22 @@ $ curl -u : -XPUT -H 'Content-Type: application/json' 'htt - The address contains the endpoint of the cluster followed by the **name of your index** - The payload of the request is a **JSON document** which contains the [settings of your index](https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/create-index/): the number of shards (the number of replicas will be automatically set at 1). -You have to follow the Logs Data Platform naming convention `-i-` to create your index. Your username is the one you use to connect to Graylog or to use the API. The suffix can contain any alphanumeric character. +You have to follow the Logs Data Platform naming convention `-i-` to create your index. Your service name can be found on the home page of the Logs Data Platform control panel. The suffix can contain any alphanumeric characters. -To delete a index use the following call: +To delete an index use the following call: -```shell-session -$ curl -u : -XDELETE -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' +```bash +$ curl --oauth2-bearer -XDELETE -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' ``` Here we use the **DELETE** HTTP command to delete the index. #### Alias creation and deletion -Similarly than indices, you can use the API Calls to delete and create aliases on your indices. The only difference is the convention for the name of your alias. Your alias must be formatted as the following **`-a-`**. Here is an example call: +Similarly than indices, you can use the API Calls to delete and create aliases on your indices. The only difference is the convention for the name of your alias. Your alias must be formatted as the following **`-a-`** (or -a- for legacy users). Here is an example call: -```shell-session -$ curl -u : -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-/_alias/-a-' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-/_alias/-a-' ``` This call creates a individual alias on one index you have previously created. @@ -455,13 +527,13 @@ If you need more information on aliases, you can check the [OpenSearch Documenta We also support the aliases API to create aliases: -```shell-session -$ curl -XPOST "https://gra2.logs.ovh.com:9200/_aliases?pretty" -H 'Content-Type: application/json' -d' +```bash +$ curl --oauth2-bearer -XPOST "https://gra2.logs.ovh.com:9200/_aliases?pretty" -H 'Content-Type: application/json' -d' { "actions" : [ - { "remove" : { "index" : "-i-", "alias" : "-a-" } }, - { "add" : { "index" : "-i-", "alias" : "-a-" } }, - { "remove_index": { "index": "-i-" } } + { "remove" : { "index" : "-i-", "alias" : "-a-" } }, + { "add" : { "index" : "-i-", "alias" : "-a-" } }, + { "remove_index": { "index": "-i-" } } ] }' ``` @@ -472,22 +544,22 @@ All the actions (alias change, alias creation and index deletion) will be done i Logs Data Platform supports your custom templates. As for indices and aliases, the template must follow some rules in order for them to work: -- the template name must contain your **``** inside the name. It can be anywhere in the name string. -- The prefix of the indices involved in the template MUST start by **`-i-`**, the "\*" character must be after this prefix -- The alias attached to your template must follow the usual convention: **`-a-`** +- the template name must contain your **``** inside the name. It can be anywhere in the name string. +- The prefix of the indices involved in the template MUST start by one your allowed services so **`-i-`**, the "\*" character must be after this prefix +- The alias attached to your template must follow the usual convention: **`-a-`** -Here is an example of a template for a user **logs-ab-12345**: +Here is an example of a template for a service **ldp-ab-12345**: -```shell-session -$ curl -u : -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/_template/template_for_logs-ab-12345_indices' -d ' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/_template/template_for_ldp-ab-12345_indices' -d ' { - "index_patterns" : [ "logs-ab-12345-i-debug*","logs-ab-12345-i-test*" ], + "index_patterns" : [ "ldp-ab-12345-i-debug*","ldp-ab-12345-i-test*" ], "settings": { "number_of_shards" : 1 }, "aliases" : { - "logs-ab-12345-a-all" : {}, - "logs-ab-12345-a-debug" : { "filter" : { "term" : { "type" : "debug" } } } + "ldp-ab-12345-a-all" : {}, + "ldp-ab-12345-a-debug" : { "filter" : { "term" : { "type" : "debug" } } } } }' ``` @@ -507,8 +579,8 @@ Here the first index was create through API, its description was filled automati Index as a service has some specificities on our platforms. This additional and technical information can help you to use it properly: - **Replication** is set at 1 and cannot be changed. We ensure the high availability of your index in case of a hardware failure. -- The **maximum size** of your index is fixed and is dependent on the number of shards. If search performance is critical, you should choose an index with the highest number of shard you can afford. -- The **index_refresh_interval** of the index is set at 1 second ensuring near real time search results. +- The **maximum size** of your index is fixed and is dependent on the number of shards. If search performance is critical, you should choose the highest number of shards you can afford. +- The **index_refresh_interval** of the index is set at 1 second, ensuring near real time search results. - You are not allowed to change the settings of your index. - You can create an **alias** on Logs Data Platform and attach it to one or several indices. - Unlike indices, aliases are **read-only**, you cannot write through an alias yet. @@ -519,4 +591,4 @@ Index as a service has some specificities on our platforms. This additional and - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.pl-pl.md b/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.pl-pl.md index 59deae3fe93..78216c98ff6 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.pl-pl.md +++ b/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.pl-pl.md @@ -1,25 +1,25 @@ --- title: OpenSearch Index as a Service excerpt: Use the power of OpenSearch without managing a cluster. -updated: 2024-08-07 +updated: 2025-10-16 --- ## Objective -OpenSearch is one of the main components of the Logs Data Platform, regarded as one of the most powerful search and analytics engines. From the outset we offered the possibility to host an OpenSearch Dashboards index for your OpenSearch Dashboards metadata, Index As A Service being the next step to this functionality. You can now use a fully unlocked index for almost any purpose; be it complex documents, reports or even logs. Thanks to the OpenSearch API, you will be able to use most of the tools of the OpenSearch Ecosystem. +OpenSearch is one of the main components of the Logs Data Platform, regarded as one of the most powerful search and analytics engines. From the outset we offered the possibility to host an OpenSearch Dashboards index for your OpenSearch Dashboards metadata. Index As A Service is the next step. You can now use a fully unlocked index for almost any purpose; be it complex documents, reports or even logs. Thanks to the OpenSearch API, you will be able to use most of the tools of the OpenSearch Ecosystem. ## Requirements This is what you need to know to get you started: - You have created a [Logs Data Platform account](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- You have access to the port 9200 of your cluster (head to the **Home** page in manager to know the address of your cluster). +- You have access to the port 9200 of your cluster (go to the **Home** page in manager to know the address of your cluster). ## Instructions ### First steps with an OpenSearch index -#### Create an index +#### Index name conventions There are two ways to create an OpenSearch Index: @@ -30,36 +30,108 @@ To create an OpenSearch index with the Logs Data Platform manager, you need to g ![add index option](images/add_index.png){.thumbnail} -You must just choose a suffix for your index. The final name will follow this convention: +Simply choose a suffix for your index. The final name will follow this convention: -`logs--i-`. +`-i-`. -For each index, you can specify the number of **shards**. A **shard** is the main component of an **index**. Its maximum storage capacity is set to **25 GB** (per shard). Multiple shards means more volume, more parallelism in your requests and thus more performance. Optionally, you can also be notified when your index is close to its critical size. Once your index is created, you can use it right away. +The service name is the identifier of your Logs Data Platform service. It is different from the username used by non IAM users. The service name starts with `ldp` (e.g. `ldp-ab-12345`). On the other hand, the username starts with `logs` (e.g. `logs-ab-12345`). In this guide we will use **** or **** as tags to let you differentiate both usages. You can find both pieces of information in the **Logs Data Platform control panel**. -When you create an index through the [OpenSearch API](https://opensearch.org/docs/latest/opensearch/index-data/), you can also specify the number of shards. Note that the maximum number of shards by index is limited to **16**. OpenSearch compatible tools can now create indices on the cluster as long as they follow the naming convention `logs--i-`. Here is an example with a curl command with the user **logs-ab-12345** and the index **logs-ab-12345-i-another-index** on gra2 cluster. +> [!primary] +> +> Prior to IAM migration the prefix was . It has now been changed to for all indices created after 17 September 2025. +> -```shell-session -$ curl -u logs-ab-12345:mypassword -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/logs-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 1}}' +For each index, you can specify the number of **shards**. A **shard** is the main component of an **index**. Its maximum storage capacity is set to **25 GB** (per shard). Multiple shards mean more volume, more parallelism in your requests and thus more performance. Optionally, you can also be notified when your index is close to its critical size. Once your index is created, you can use it right away. + +When you create an index through the [OpenSearch API](https://opensearch.org/docs/latest/opensearch/index-data/), you can also specify the number of shards. Note that the maximum number of shards per index is limited to **16**. OpenSearch compatible tools can now create indices on the cluster as long as they follow the naming conventions. + +#### IAM configuration + +If you have enabled [IAM on your account](/pages/manage_and_operate/observability/logs_data_platform/iam_presentation_faq/) you first need to create a policy and give the creation rights to your preferred user/account. See the [IAM for LDP documentation policy guide](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). + +The rights relative to the management of OpenSearch items through the **OVHcloud APIs** are: + + +|Rights |LDP product types|Description| +|---------------------------------------------------|-----------------|-----------| +|ldp:apiovh:url/get |service |Get Logs Data Platform service useful urls| +|ldp:apiovh:output/opensearch/index/create |service |Order a new OpenSearch index over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/create |service |Create a new OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/get |alias |Get OpenSearch aliases over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/edit |alias |Update an OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/index/attach |alias |Attach an OpenSearch index to a OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/index/detach |alias |Detach an OpenSearch index to a OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/delete |alias |Delete an OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/index/get |index |Get OpenSearch indexes over OVHcloud API| +|ldp:apiovh:output/opensearch/index/url/get |index |Get urls of an OpenSearch index over OVHcloud API| +|ldp:apiovh:output/opensearch/index/edit |index |Update an OpenSearch index over OVHcloud API| +|ldp:apiovh:output/opensearch/index/delete |index |Delete an OpenSearch index over OVHcloud API| + + +The rights relative to the management of OpenSearch items through the **OpenSearch API** are: + + +|Rights |LDP product types|Description| +|---------------------------------------------------|-----------------|-----------| +|ldp:opensearch:index/create |service |Create an index over OpenSearch API| +|ldp:opensearch:alias/create |service |Create an alias over OpenSearch API| +|ldp:opensearch:alias/read |alias |Read an alias's contents over OpenSearch API| +|ldp:opensearch:alias/delete |alias |Delete an alias over OpenSearch API| +|ldp:opensearch:index/read |index |Read an index content over OpenSearch API| +|ldp:opensearch:index/write |index |Write content to an index over OpenSearch API| +|ldp:opensearch:index/delete |index |Delete an index over OpenSearch API| + +Attach these rights to your policies freely whether you need to interact directly with the OpenSearch API or through the manager. + +The prefix of all indices or aliases created is . Example: ldp-ab-12345-i-my-awesome-index. +To interact with the OpenSearch API, you can either create [service accounts](/pages/account_and_service_management/account_information/authenticate-api-with-service-account) and leverage the OpenID workflow, or create [local users](/pages/account_and_service_management/account_information/ovhcloud-users-management) with their Personal Access Token with the API: + +> [!api] +> +> @api {v1} /me POST /me/identity/user/{user}/token +> + +This call will return a bearer token for a specific local user. + +You can then use the token of your user to create an index or write documents to your indices. + +```bash +ldp@laptop curl -H 'content-type: application/json' --oauth2-bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c -XPUT 'https://gra2.logs.ovh.com:9200/ldp-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 2}}' +``` + +You can alternatively use the basic scheme authentication with your bearer token as a password for systems that don't support a bearer token (or a custom Authentication Bearer header). The only constraint is to use a username starting with the prefix **pat_jwt_**. For example: + +```bash +ldp@laptop curl -H 'content-type: application/json' -u pat_jwt_user_one:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c -XPUT 'https://gra2.logs.ovh.com:9200/ldp-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 2}}' ``` -There is more information about the API Support at the [dedicated section](#management-through-opensearch-api). +Here, in both examples, the index created will have 2 shards and will appear in your panel. You can then attach it to an IAM policy. + +#### Legacy users + +If you don't have IAM enabled on your account (which will be deprecated) the prefix of indices is `:`. + +Here is an example with a curl command with the user **logs-ab-12345** and the index **logs-ab-12345-i-another-index** on gra2 cluster: + +```bash +$ curl -u logs-ab-12345:mypassword -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/logs-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 1}}' +``` -Whatever method you use, you will be able to query and visualize your documents on Logs Data Platform using the API. #### Index some data -Logs Data Platform OpenSearch indices are compatible with the [OpenSearch REST API](https://opensearch.org/docs/latest/opensearch/rest-api/index/). Therefore, you can use simple http requests to index and search your data. The API is accessible behind a secured https endpoint with mandatory authentication. We recommend that you use [tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens) to authenticate yourself. You can retrieve the endpoint of the API at the **Home** page of your service. Here is a simple example to index a document with curl with an index on the cluster `.logs.ovh.com`. +Logs Data Platform OpenSearch indices are compatible with the [OpenSearch REST API](https://opensearch.org/docs/latest/opensearch/rest-api/index/). Therefore, you can use simple http requests to index and search your data. The API is accessible behind a secured https endpoint with mandatory authentication. You can retrieve the endpoint of the API at the **Home** page of your service. Here is a simple example to index a document with curl on the cluster `.logs.ovh.com`. -```shell-session -$ curl -u token: -XPUT -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/logs--i-/_doc/1' -d '{ "user" : "Oles", "company" : "OVH", "message" : "Hello World !", "post_date" : "1999-11-02T23:01:00" }' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/-i-/_doc/1' -d '{ "user" : "Oles", "company" : "OVH", "message" : "Hello World !", "post_date" : "1999-11-02T23:01:00" }' ``` Here is a quick explanation of this command: - The **PUT** HTTP command can be used to create or modify a document. -- The `Content-Type: application/json` is the mandatory header to indicate that the data will be in the json format. +- The `Content-Type: application/json` is the mandatory header to indicate that the data will be in the JSON format. - The address contains the endpoint of the cluster followed by the **name of your index** -- The **test** just after the index name is the type of the document. +- The **_doc** just after the index name must be used as the type of the document. - The **1** here is the id of your document that can be any string. - The payload of the request is a simple **JSON document** that will be indexed. @@ -68,7 +140,7 @@ This command will return with a simple payload indicating if the document has be ```json { "_id": "1", - "_index": "logs--i-", + "_index": "-i-", "_primary_term": 1, "_seq_no": 0, "_shards": { @@ -86,25 +158,25 @@ This command will return with a simple payload indicating if the document has be There are multiple ways to search your data, this is one area where the OpenSearch REST API excels. You can either get your data directly by using a GET request, or search it with the Search APIs. To get your document indexed previously, use the following curl request: -```shell-session -$ curl -XGET -u token: 'https://.logs.ovh.com:9200/logs--i-/_doc/1' -{"_id":"1","_index":"logs--i-","_primary_term":1,"_seq_no":0,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc","_version":1,"found":true} +```bash +$ curl --oauth2-bearer -XGET 'https://.logs.ovh.com:9200/-i-/_doc/1' +{"_id":"1","_index":"-i-","_primary_term":1,"_seq_no":0,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc","_version":1,"found":true} ``` To issue a simple search you can either use the [Query DSL](https://opensearch.org/docs/latest/opensearch/query-dsl/index/) or a URI search. Here is a simple example with an URI search: -```shell-session -$ curl -XGET -u token: 'https://.logs.ovh.com:9200/logs--i-/_search?q=user:Oles' -{"_shards":{"failed":0,"skipped":0,"successful":1,"total":1},"hits":{"hits":[{"_id":"1","_index":"newindice","_score":0.2876821,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc"}],"max_score":0.2876821,"total":1},"timed_out":false,"took":31} +```bash +$ curl --oauth2-bearer -XGET 'https://.logs.ovh.com:9200/-i-/_search?q=user:Oles' +{"_shards":{"failed":0,"skipped":0,"successful":1,"total":1},"hits":{"hits":[{"_id":"1","_index":"-i-","_score":0.2876821,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc"}],"max_score":0.2876821,"total":1},"timed_out":false,"took":31} ``` ### Use case: Enrich Logs Data on the fly -The following shows how your e-commerce application logs can be sent to the Logs Data Platform whenever a product is ordered. It logs the customer order by using Id for the customers name. For performance reasons or maybe by-design, the application doesn't fetch the full name of the client or other information from the customer database just to produce a log. You can add this information on the fly by using an OpenSearch Index and a Logstash collector on the Logs Data Platform. +The following shows how your e-commerce application logs can be sent to the Logs Data Platform whenever a product is ordered. It logs the customer order by using ID for the customer's name. For performance reasons or maybe by design, the application doesn't fetch the full name of the client or other information from the customer database just to produce a log. You can add this information on the fly by using an OpenSearch Index and a Logstash collector on the Logs Data Platform. -#### Fill an index with clients information +#### Populate an index with clients' information -The first thing to do is to index some clients information. The snippet below is one entry of the client index. +The first thing to do is to index some client information. The snippet below is one entry of the client index. ```json { @@ -137,15 +209,15 @@ The first thing to do is to index some clients information. The snippet below is } ``` -To index several documents at once, it is more efficient to use the bulk api. Here is a small snippet of 3 users you can use to test it. +To index several documents at once, it is more efficient to use the bulk API. Here is a small snippet of 3 users you can use to test it. ```json -{ "index" : { "_index" : "logs--i-" } } -{ "userId": "1", "firstName": "Jon","lastName": "Snow", "age": 22, "address": { "streetAddress": "21 2nd Street", "city": "Winterfell", "state": "North", "postalCode": "14578", "geolocation": { "lat": 54.369488, "long": -5.574768 } },"phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-4567" } ] } -{ "index" : { "_index" : "logs--i-" } } -{ "userId": "2", "firstName": "Cersei","lastName": "Lannister", "age": 43, "address": { "streetAddress": "1 Palace Street", "city": "King's Landing", "state": "The Crownlands", "postalCode": "26863", "geolocation": { "lat": 42.639758, "long": 18.1094725 } },"phoneNumber": [ { "type": "home", "number": "212 555-6789" }, { "type": "mobile", "number": "102 555-8901" } ] } -{ "index" : { "_index" : "logs--i-" } } -{ "userId": "3", "firstName": "Daenerys","lastName": "Targaryen", "age": 22, "address": { "streetAddress": "3 Blackwater Bay Ave", "city": "Dragonstone", "state": "Dragonstone", "postalCode": "75197", "geolocation": { "lat": 43.300097, "long": -2.261580 } },"phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-2345" } ] } +{ "index" : { "_index" : "-i-" } } +{ "userId": "1", "firstName": "Jon","lastName": "Snow", "age": 22, "address": { "streetAddress": "21 2nd Street", "city": "Winterfell", "state": "North", "postalCode": "14578", "geolocation": { "lat": 54.369488, "long": -5.574768 } }, "phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-4567" } ] } +{ "index" : { "_index" : "-i-" } } +{ "userId": "2", "firstName": "Cersei","lastName": "Lannister", "age": 43, "address": { "streetAddress": "1 Palace Street", "city": "King's Landing", "state": "The Crownlands", "postalCode": "26863", "geolocation": { "lat": 42.639758, "long": 18.1094725 } }, "phoneNumber": [ { "type": "home", "number": "212 555-6789" }, { "type": "mobile", "number": "102 555-8901" } ] } +{ "index" : { "_index" : "-i-" } } +{ "userId": "3", "firstName": "Daenerys","lastName": "Targaryen", "age": 22, "address": { "streetAddress": "3 Blackwater Bay Ave", "city": "Dragonstone", "state": "Dragonstone", "postalCode": "75197", "geolocation": { "lat": 43.300097, "long": -2.261580 } }, "phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-2345" } ] } ``` A bulk request is a succession of JSON objects with this structure: @@ -162,14 +234,14 @@ A bulk request is a succession of JSON objects with this structure: You can in one request ask OpenSearch to index, update, delete several documents. Save the content of the previous JSON lines in a file named **bulk** and use the following call to index these 3 users: -```shell-session -$ curl -u token: -XPUT -H 'Content-Type: application/x-ndjson' 'https://.logs.ovh.com:9200/logs--i-/_bulk' --data-binary "@bulk" +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/x-ndjson' 'https://.logs.ovh.com:9200/-i-/_bulk' --data-binary "@bulk" ``` This call will take the content of the bulk file and execute each index operation. Note that you have to use the option **--data-binary** and no **-d** to preserve the newline after each JSON. You can check that your data are properly indexed with the following call: -```shell-session -$ curl -u token: -XGET 'https://.logs.ovh.com:9200/logs--i-/_search?pretty=true' +```bash +$ curl --oauth2-bearer -XGET 'https://.logs.ovh.com:9200/-i-/_search?pretty=true' ``` This will give you back the documents of your index: @@ -187,7 +259,7 @@ This will give you back the documents of your index: "total" : 3, "max_score" : 1.0, "hits" : [ { - "_index" : "logs--i-", + "_index" : "-i-", "_type" : "_doc", "_id" : "AV3HvbQAz85mIBfrJjkV", "_score" : 1.0, @@ -215,7 +287,7 @@ This will give you back the documents of your index: } ] } }, { - "_index" : "logs--i-", + "_index" : "-i-", "_type" : "_doc", "_id" : "AV3HvbQAz85mIBfrJjkW", "_score" : 1.0, @@ -243,7 +315,7 @@ This will give you back the documents of your index: } ] } }, { - "_index" : "logs--i-", + "_index" : "-i-", "_type" : "_doc", "_id" : "AV3HvbQAz85mIBfrJjkX", "_score" : 1.0, @@ -299,9 +371,9 @@ The most important part in this configuration is the filter part: ```ruby opensearch { hosts => ["https://gra2.logs.ovh.com:9200"] - index => "logs--i-" - user => "" - password => "" + index => "-i-" + user => "pat_jwt_logstash" + password => "" enable_sort => false query => "userId:%{[userId]}" fields => { @@ -337,7 +409,7 @@ The mutate plugin is here to show you how you can combine different subfield inf One simple way to test your new Logstash configuration is to send a log by using echo and openssl. Check the examples below: -```shell-session +```bash $ echo -e '{"version":"1.1", "host": "little bird", "short_message": "Warrior from the North", "level":1, "_userId": "2", "_unitType": "Westerosis", "_power_num": 200 }'\0 | openssl s_client -quiet -no_ign_eof -connect : $ echo -e '{"version":"1.1", "host": "little bird", "short_message": "A legendary dragon", "level":1, "_userId": "3", "_unitType": "Dragon", "_power_num": 200000 }'\0 | openssl s_client -quiet -no_ign_eof -connect : ``` @@ -368,7 +440,7 @@ The **maximum size** of your index is fixed and is dependent on the number of sh Note that you can monitor the size of the index by using the following curl query: ```shell-session -$ curl -u token: -XGET -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/logs--i-/_stats/store?pretty' +$ curl --oauth2-bearer -XGET -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/-i-/_stats/store?pretty' ``` This command will give you a document with the following format: @@ -393,7 +465,7 @@ This command will give you a document with the following format: } }, "indices" : { - "logs--i-" : { + "-i-" : { "uuid" : "JC0IWkd3QYSBNd4B2bBZGg", "primaries" : { "store" : { @@ -411,7 +483,7 @@ This command will give you a document with the following format: ``` The size in bytes used to compute your billing is the one under the following path: -"indices" -> "logs--i-" -> "primaries" -> "store" -> "size\_in\_bytes". +"indices" -> "-i-" -> "primaries" -> "store" -> "size\_in\_bytes". ### Management through OpenSearch API @@ -421,8 +493,8 @@ On Logs Data Platform, we allow users to use OpenSearch API to handle the lifecy To create an index on Logs Data Platform, use the following call: -```shell-session -$ curl -u : -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' -d '{ "settings" : {"number_of_shards" : 1}}' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' -d '{ "settings" : {"number_of_shards" : 1}}' ``` - The **-u** option is followed by your LDP username that you can find on **Home** page. The password 'mypassword' follows it after the separator ':' @@ -431,22 +503,22 @@ $ curl -u : -XPUT -H 'Content-Type: application/json' 'htt - The address contains the endpoint of the cluster followed by the **name of your index** - The payload of the request is a **JSON document** which contains the [settings of your index](https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/create-index/): the number of shards (the number of replicas will be automatically set at 1). -You have to follow the Logs Data Platform naming convention `-i-` to create your index. Your username is the one you use to connect to Graylog or to use the API. The suffix can contain any alphanumeric character. +You have to follow the Logs Data Platform naming convention `-i-` to create your index. Your service name can be found on the home page of the Logs Data Platform control panel. The suffix can contain any alphanumeric characters. -To delete a index use the following call: +To delete an index use the following call: -```shell-session -$ curl -u : -XDELETE -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' +```bash +$ curl --oauth2-bearer -XDELETE -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' ``` Here we use the **DELETE** HTTP command to delete the index. #### Alias creation and deletion -Similarly than indices, you can use the API Calls to delete and create aliases on your indices. The only difference is the convention for the name of your alias. Your alias must be formatted as the following **`-a-`**. Here is an example call: +Similarly than indices, you can use the API Calls to delete and create aliases on your indices. The only difference is the convention for the name of your alias. Your alias must be formatted as the following **`-a-`** (or -a- for legacy users). Here is an example call: -```shell-session -$ curl -u : -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-/_alias/-a-' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-/_alias/-a-' ``` This call creates a individual alias on one index you have previously created. @@ -455,13 +527,13 @@ If you need more information on aliases, you can check the [OpenSearch Documenta We also support the aliases API to create aliases: -```shell-session -$ curl -XPOST "https://gra2.logs.ovh.com:9200/_aliases?pretty" -H 'Content-Type: application/json' -d' +```bash +$ curl --oauth2-bearer -XPOST "https://gra2.logs.ovh.com:9200/_aliases?pretty" -H 'Content-Type: application/json' -d' { "actions" : [ - { "remove" : { "index" : "-i-", "alias" : "-a-" } }, - { "add" : { "index" : "-i-", "alias" : "-a-" } }, - { "remove_index": { "index": "-i-" } } + { "remove" : { "index" : "-i-", "alias" : "-a-" } }, + { "add" : { "index" : "-i-", "alias" : "-a-" } }, + { "remove_index": { "index": "-i-" } } ] }' ``` @@ -472,22 +544,22 @@ All the actions (alias change, alias creation and index deletion) will be done i Logs Data Platform supports your custom templates. As for indices and aliases, the template must follow some rules in order for them to work: -- the template name must contain your **``** inside the name. It can be anywhere in the name string. -- The prefix of the indices involved in the template MUST start by **`-i-`**, the "\*" character must be after this prefix -- The alias attached to your template must follow the usual convention: **`-a-`** +- the template name must contain your **``** inside the name. It can be anywhere in the name string. +- The prefix of the indices involved in the template MUST start by one your allowed services so **`-i-`**, the "\*" character must be after this prefix +- The alias attached to your template must follow the usual convention: **`-a-`** -Here is an example of a template for a user **logs-ab-12345**: +Here is an example of a template for a service **ldp-ab-12345**: -```shell-session -$ curl -u : -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/_template/template_for_logs-ab-12345_indices' -d ' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/_template/template_for_ldp-ab-12345_indices' -d ' { - "index_patterns" : [ "logs-ab-12345-i-debug*","logs-ab-12345-i-test*" ], + "index_patterns" : [ "ldp-ab-12345-i-debug*","ldp-ab-12345-i-test*" ], "settings": { "number_of_shards" : 1 }, "aliases" : { - "logs-ab-12345-a-all" : {}, - "logs-ab-12345-a-debug" : { "filter" : { "term" : { "type" : "debug" } } } + "ldp-ab-12345-a-all" : {}, + "ldp-ab-12345-a-debug" : { "filter" : { "term" : { "type" : "debug" } } } } }' ``` @@ -507,8 +579,8 @@ Here the first index was create through API, its description was filled automati Index as a service has some specificities on our platforms. This additional and technical information can help you to use it properly: - **Replication** is set at 1 and cannot be changed. We ensure the high availability of your index in case of a hardware failure. -- The **maximum size** of your index is fixed and is dependent on the number of shards. If search performance is critical, you should choose an index with the highest number of shard you can afford. -- The **index_refresh_interval** of the index is set at 1 second ensuring near real time search results. +- The **maximum size** of your index is fixed and is dependent on the number of shards. If search performance is critical, you should choose the highest number of shards you can afford. +- The **index_refresh_interval** of the index is set at 1 second, ensuring near real time search results. - You are not allowed to change the settings of your index. - You can create an **alias** on Logs Data Platform and attach it to one or several indices. - Unlike indices, aliases are **read-only**, you cannot write through an alias yet. @@ -519,4 +591,4 @@ Index as a service has some specificities on our platforms. This additional and - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.pt-pt.md b/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.pt-pt.md index 59deae3fe93..78216c98ff6 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.pt-pt.md +++ b/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/guide.pt-pt.md @@ -1,25 +1,25 @@ --- title: OpenSearch Index as a Service excerpt: Use the power of OpenSearch without managing a cluster. -updated: 2024-08-07 +updated: 2025-10-16 --- ## Objective -OpenSearch is one of the main components of the Logs Data Platform, regarded as one of the most powerful search and analytics engines. From the outset we offered the possibility to host an OpenSearch Dashboards index for your OpenSearch Dashboards metadata, Index As A Service being the next step to this functionality. You can now use a fully unlocked index for almost any purpose; be it complex documents, reports or even logs. Thanks to the OpenSearch API, you will be able to use most of the tools of the OpenSearch Ecosystem. +OpenSearch is one of the main components of the Logs Data Platform, regarded as one of the most powerful search and analytics engines. From the outset we offered the possibility to host an OpenSearch Dashboards index for your OpenSearch Dashboards metadata. Index As A Service is the next step. You can now use a fully unlocked index for almost any purpose; be it complex documents, reports or even logs. Thanks to the OpenSearch API, you will be able to use most of the tools of the OpenSearch Ecosystem. ## Requirements This is what you need to know to get you started: - You have created a [Logs Data Platform account](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- You have access to the port 9200 of your cluster (head to the **Home** page in manager to know the address of your cluster). +- You have access to the port 9200 of your cluster (go to the **Home** page in manager to know the address of your cluster). ## Instructions ### First steps with an OpenSearch index -#### Create an index +#### Index name conventions There are two ways to create an OpenSearch Index: @@ -30,36 +30,108 @@ To create an OpenSearch index with the Logs Data Platform manager, you need to g ![add index option](images/add_index.png){.thumbnail} -You must just choose a suffix for your index. The final name will follow this convention: +Simply choose a suffix for your index. The final name will follow this convention: -`logs--i-`. +`-i-`. -For each index, you can specify the number of **shards**. A **shard** is the main component of an **index**. Its maximum storage capacity is set to **25 GB** (per shard). Multiple shards means more volume, more parallelism in your requests and thus more performance. Optionally, you can also be notified when your index is close to its critical size. Once your index is created, you can use it right away. +The service name is the identifier of your Logs Data Platform service. It is different from the username used by non IAM users. The service name starts with `ldp` (e.g. `ldp-ab-12345`). On the other hand, the username starts with `logs` (e.g. `logs-ab-12345`). In this guide we will use **** or **** as tags to let you differentiate both usages. You can find both pieces of information in the **Logs Data Platform control panel**. -When you create an index through the [OpenSearch API](https://opensearch.org/docs/latest/opensearch/index-data/), you can also specify the number of shards. Note that the maximum number of shards by index is limited to **16**. OpenSearch compatible tools can now create indices on the cluster as long as they follow the naming convention `logs--i-`. Here is an example with a curl command with the user **logs-ab-12345** and the index **logs-ab-12345-i-another-index** on gra2 cluster. +> [!primary] +> +> Prior to IAM migration the prefix was . It has now been changed to for all indices created after 17 September 2025. +> -```shell-session -$ curl -u logs-ab-12345:mypassword -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/logs-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 1}}' +For each index, you can specify the number of **shards**. A **shard** is the main component of an **index**. Its maximum storage capacity is set to **25 GB** (per shard). Multiple shards mean more volume, more parallelism in your requests and thus more performance. Optionally, you can also be notified when your index is close to its critical size. Once your index is created, you can use it right away. + +When you create an index through the [OpenSearch API](https://opensearch.org/docs/latest/opensearch/index-data/), you can also specify the number of shards. Note that the maximum number of shards per index is limited to **16**. OpenSearch compatible tools can now create indices on the cluster as long as they follow the naming conventions. + +#### IAM configuration + +If you have enabled [IAM on your account](/pages/manage_and_operate/observability/logs_data_platform/iam_presentation_faq/) you first need to create a policy and give the creation rights to your preferred user/account. See the [IAM for LDP documentation policy guide](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). + +The rights relative to the management of OpenSearch items through the **OVHcloud APIs** are: + + +|Rights |LDP product types|Description| +|---------------------------------------------------|-----------------|-----------| +|ldp:apiovh:url/get |service |Get Logs Data Platform service useful urls| +|ldp:apiovh:output/opensearch/index/create |service |Order a new OpenSearch index over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/create |service |Create a new OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/get |alias |Get OpenSearch aliases over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/edit |alias |Update an OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/index/attach |alias |Attach an OpenSearch index to a OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/index/detach |alias |Detach an OpenSearch index to a OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/alias/delete |alias |Delete an OpenSearch alias over OVHcloud API| +|ldp:apiovh:output/opensearch/index/get |index |Get OpenSearch indexes over OVHcloud API| +|ldp:apiovh:output/opensearch/index/url/get |index |Get urls of an OpenSearch index over OVHcloud API| +|ldp:apiovh:output/opensearch/index/edit |index |Update an OpenSearch index over OVHcloud API| +|ldp:apiovh:output/opensearch/index/delete |index |Delete an OpenSearch index over OVHcloud API| + + +The rights relative to the management of OpenSearch items through the **OpenSearch API** are: + + +|Rights |LDP product types|Description| +|---------------------------------------------------|-----------------|-----------| +|ldp:opensearch:index/create |service |Create an index over OpenSearch API| +|ldp:opensearch:alias/create |service |Create an alias over OpenSearch API| +|ldp:opensearch:alias/read |alias |Read an alias's contents over OpenSearch API| +|ldp:opensearch:alias/delete |alias |Delete an alias over OpenSearch API| +|ldp:opensearch:index/read |index |Read an index content over OpenSearch API| +|ldp:opensearch:index/write |index |Write content to an index over OpenSearch API| +|ldp:opensearch:index/delete |index |Delete an index over OpenSearch API| + +Attach these rights to your policies freely whether you need to interact directly with the OpenSearch API or through the manager. + +The prefix of all indices or aliases created is . Example: ldp-ab-12345-i-my-awesome-index. +To interact with the OpenSearch API, you can either create [service accounts](/pages/account_and_service_management/account_information/authenticate-api-with-service-account) and leverage the OpenID workflow, or create [local users](/pages/account_and_service_management/account_information/ovhcloud-users-management) with their Personal Access Token with the API: + +> [!api] +> +> @api {v1} /me POST /me/identity/user/{user}/token +> + +This call will return a bearer token for a specific local user. + +You can then use the token of your user to create an index or write documents to your indices. + +```bash +ldp@laptop curl -H 'content-type: application/json' --oauth2-bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c -XPUT 'https://gra2.logs.ovh.com:9200/ldp-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 2}}' +``` + +You can alternatively use the basic scheme authentication with your bearer token as a password for systems that don't support a bearer token (or a custom Authentication Bearer header). The only constraint is to use a username starting with the prefix **pat_jwt_**. For example: + +```bash +ldp@laptop curl -H 'content-type: application/json' -u pat_jwt_user_one:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c -XPUT 'https://gra2.logs.ovh.com:9200/ldp-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 2}}' ``` -There is more information about the API Support at the [dedicated section](#management-through-opensearch-api). +Here, in both examples, the index created will have 2 shards and will appear in your panel. You can then attach it to an IAM policy. + +#### Legacy users + +If you don't have IAM enabled on your account (which will be deprecated) the prefix of indices is `:`. + +Here is an example with a curl command with the user **logs-ab-12345** and the index **logs-ab-12345-i-another-index** on gra2 cluster: + +```bash +$ curl -u logs-ab-12345:mypassword -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/logs-ab-12345-i-another-index' -d '{ "settings" : {"number_of_shards" : 1}}' +``` -Whatever method you use, you will be able to query and visualize your documents on Logs Data Platform using the API. #### Index some data -Logs Data Platform OpenSearch indices are compatible with the [OpenSearch REST API](https://opensearch.org/docs/latest/opensearch/rest-api/index/). Therefore, you can use simple http requests to index and search your data. The API is accessible behind a secured https endpoint with mandatory authentication. We recommend that you use [tokens](/pages/manage_and_operate/observability/logs_data_platform/security_tokens) to authenticate yourself. You can retrieve the endpoint of the API at the **Home** page of your service. Here is a simple example to index a document with curl with an index on the cluster `.logs.ovh.com`. +Logs Data Platform OpenSearch indices are compatible with the [OpenSearch REST API](https://opensearch.org/docs/latest/opensearch/rest-api/index/). Therefore, you can use simple http requests to index and search your data. The API is accessible behind a secured https endpoint with mandatory authentication. You can retrieve the endpoint of the API at the **Home** page of your service. Here is a simple example to index a document with curl on the cluster `.logs.ovh.com`. -```shell-session -$ curl -u token: -XPUT -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/logs--i-/_doc/1' -d '{ "user" : "Oles", "company" : "OVH", "message" : "Hello World !", "post_date" : "1999-11-02T23:01:00" }' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/-i-/_doc/1' -d '{ "user" : "Oles", "company" : "OVH", "message" : "Hello World !", "post_date" : "1999-11-02T23:01:00" }' ``` Here is a quick explanation of this command: - The **PUT** HTTP command can be used to create or modify a document. -- The `Content-Type: application/json` is the mandatory header to indicate that the data will be in the json format. +- The `Content-Type: application/json` is the mandatory header to indicate that the data will be in the JSON format. - The address contains the endpoint of the cluster followed by the **name of your index** -- The **test** just after the index name is the type of the document. +- The **_doc** just after the index name must be used as the type of the document. - The **1** here is the id of your document that can be any string. - The payload of the request is a simple **JSON document** that will be indexed. @@ -68,7 +140,7 @@ This command will return with a simple payload indicating if the document has be ```json { "_id": "1", - "_index": "logs--i-", + "_index": "-i-", "_primary_term": 1, "_seq_no": 0, "_shards": { @@ -86,25 +158,25 @@ This command will return with a simple payload indicating if the document has be There are multiple ways to search your data, this is one area where the OpenSearch REST API excels. You can either get your data directly by using a GET request, or search it with the Search APIs. To get your document indexed previously, use the following curl request: -```shell-session -$ curl -XGET -u token: 'https://.logs.ovh.com:9200/logs--i-/_doc/1' -{"_id":"1","_index":"logs--i-","_primary_term":1,"_seq_no":0,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc","_version":1,"found":true} +```bash +$ curl --oauth2-bearer -XGET 'https://.logs.ovh.com:9200/-i-/_doc/1' +{"_id":"1","_index":"-i-","_primary_term":1,"_seq_no":0,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc","_version":1,"found":true} ``` To issue a simple search you can either use the [Query DSL](https://opensearch.org/docs/latest/opensearch/query-dsl/index/) or a URI search. Here is a simple example with an URI search: -```shell-session -$ curl -XGET -u token: 'https://.logs.ovh.com:9200/logs--i-/_search?q=user:Oles' -{"_shards":{"failed":0,"skipped":0,"successful":1,"total":1},"hits":{"hits":[{"_id":"1","_index":"newindice","_score":0.2876821,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc"}],"max_score":0.2876821,"total":1},"timed_out":false,"took":31} +```bash +$ curl --oauth2-bearer -XGET 'https://.logs.ovh.com:9200/-i-/_search?q=user:Oles' +{"_shards":{"failed":0,"skipped":0,"successful":1,"total":1},"hits":{"hits":[{"_id":"1","_index":"-i-","_score":0.2876821,"_source":{"company":"OVH","message":"Hello World !","post_date":"1999-11-02T23:01:00","user":"Oles"},"_type":"_doc"}],"max_score":0.2876821,"total":1},"timed_out":false,"took":31} ``` ### Use case: Enrich Logs Data on the fly -The following shows how your e-commerce application logs can be sent to the Logs Data Platform whenever a product is ordered. It logs the customer order by using Id for the customers name. For performance reasons or maybe by-design, the application doesn't fetch the full name of the client or other information from the customer database just to produce a log. You can add this information on the fly by using an OpenSearch Index and a Logstash collector on the Logs Data Platform. +The following shows how your e-commerce application logs can be sent to the Logs Data Platform whenever a product is ordered. It logs the customer order by using ID for the customer's name. For performance reasons or maybe by design, the application doesn't fetch the full name of the client or other information from the customer database just to produce a log. You can add this information on the fly by using an OpenSearch Index and a Logstash collector on the Logs Data Platform. -#### Fill an index with clients information +#### Populate an index with clients' information -The first thing to do is to index some clients information. The snippet below is one entry of the client index. +The first thing to do is to index some client information. The snippet below is one entry of the client index. ```json { @@ -137,15 +209,15 @@ The first thing to do is to index some clients information. The snippet below is } ``` -To index several documents at once, it is more efficient to use the bulk api. Here is a small snippet of 3 users you can use to test it. +To index several documents at once, it is more efficient to use the bulk API. Here is a small snippet of 3 users you can use to test it. ```json -{ "index" : { "_index" : "logs--i-" } } -{ "userId": "1", "firstName": "Jon","lastName": "Snow", "age": 22, "address": { "streetAddress": "21 2nd Street", "city": "Winterfell", "state": "North", "postalCode": "14578", "geolocation": { "lat": 54.369488, "long": -5.574768 } },"phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-4567" } ] } -{ "index" : { "_index" : "logs--i-" } } -{ "userId": "2", "firstName": "Cersei","lastName": "Lannister", "age": 43, "address": { "streetAddress": "1 Palace Street", "city": "King's Landing", "state": "The Crownlands", "postalCode": "26863", "geolocation": { "lat": 42.639758, "long": 18.1094725 } },"phoneNumber": [ { "type": "home", "number": "212 555-6789" }, { "type": "mobile", "number": "102 555-8901" } ] } -{ "index" : { "_index" : "logs--i-" } } -{ "userId": "3", "firstName": "Daenerys","lastName": "Targaryen", "age": 22, "address": { "streetAddress": "3 Blackwater Bay Ave", "city": "Dragonstone", "state": "Dragonstone", "postalCode": "75197", "geolocation": { "lat": 43.300097, "long": -2.261580 } },"phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-2345" } ] } +{ "index" : { "_index" : "-i-" } } +{ "userId": "1", "firstName": "Jon","lastName": "Snow", "age": 22, "address": { "streetAddress": "21 2nd Street", "city": "Winterfell", "state": "North", "postalCode": "14578", "geolocation": { "lat": 54.369488, "long": -5.574768 } }, "phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-4567" } ] } +{ "index" : { "_index" : "-i-" } } +{ "userId": "2", "firstName": "Cersei","lastName": "Lannister", "age": 43, "address": { "streetAddress": "1 Palace Street", "city": "King's Landing", "state": "The Crownlands", "postalCode": "26863", "geolocation": { "lat": 42.639758, "long": 18.1094725 } }, "phoneNumber": [ { "type": "home", "number": "212 555-6789" }, { "type": "mobile", "number": "102 555-8901" } ] } +{ "index" : { "_index" : "-i-" } } +{ "userId": "3", "firstName": "Daenerys","lastName": "Targaryen", "age": 22, "address": { "streetAddress": "3 Blackwater Bay Ave", "city": "Dragonstone", "state": "Dragonstone", "postalCode": "75197", "geolocation": { "lat": 43.300097, "long": -2.261580 } }, "phoneNumber": [ { "type": "home", "number": "212 555-1234" }, { "type": "mobile", "number": "102 555-2345" } ] } ``` A bulk request is a succession of JSON objects with this structure: @@ -162,14 +234,14 @@ A bulk request is a succession of JSON objects with this structure: You can in one request ask OpenSearch to index, update, delete several documents. Save the content of the previous JSON lines in a file named **bulk** and use the following call to index these 3 users: -```shell-session -$ curl -u token: -XPUT -H 'Content-Type: application/x-ndjson' 'https://.logs.ovh.com:9200/logs--i-/_bulk' --data-binary "@bulk" +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/x-ndjson' 'https://.logs.ovh.com:9200/-i-/_bulk' --data-binary "@bulk" ``` This call will take the content of the bulk file and execute each index operation. Note that you have to use the option **--data-binary** and no **-d** to preserve the newline after each JSON. You can check that your data are properly indexed with the following call: -```shell-session -$ curl -u token: -XGET 'https://.logs.ovh.com:9200/logs--i-/_search?pretty=true' +```bash +$ curl --oauth2-bearer -XGET 'https://.logs.ovh.com:9200/-i-/_search?pretty=true' ``` This will give you back the documents of your index: @@ -187,7 +259,7 @@ This will give you back the documents of your index: "total" : 3, "max_score" : 1.0, "hits" : [ { - "_index" : "logs--i-", + "_index" : "-i-", "_type" : "_doc", "_id" : "AV3HvbQAz85mIBfrJjkV", "_score" : 1.0, @@ -215,7 +287,7 @@ This will give you back the documents of your index: } ] } }, { - "_index" : "logs--i-", + "_index" : "-i-", "_type" : "_doc", "_id" : "AV3HvbQAz85mIBfrJjkW", "_score" : 1.0, @@ -243,7 +315,7 @@ This will give you back the documents of your index: } ] } }, { - "_index" : "logs--i-", + "_index" : "-i-", "_type" : "_doc", "_id" : "AV3HvbQAz85mIBfrJjkX", "_score" : 1.0, @@ -299,9 +371,9 @@ The most important part in this configuration is the filter part: ```ruby opensearch { hosts => ["https://gra2.logs.ovh.com:9200"] - index => "logs--i-" - user => "" - password => "" + index => "-i-" + user => "pat_jwt_logstash" + password => "" enable_sort => false query => "userId:%{[userId]}" fields => { @@ -337,7 +409,7 @@ The mutate plugin is here to show you how you can combine different subfield inf One simple way to test your new Logstash configuration is to send a log by using echo and openssl. Check the examples below: -```shell-session +```bash $ echo -e '{"version":"1.1", "host": "little bird", "short_message": "Warrior from the North", "level":1, "_userId": "2", "_unitType": "Westerosis", "_power_num": 200 }'\0 | openssl s_client -quiet -no_ign_eof -connect : $ echo -e '{"version":"1.1", "host": "little bird", "short_message": "A legendary dragon", "level":1, "_userId": "3", "_unitType": "Dragon", "_power_num": 200000 }'\0 | openssl s_client -quiet -no_ign_eof -connect : ``` @@ -368,7 +440,7 @@ The **maximum size** of your index is fixed and is dependent on the number of sh Note that you can monitor the size of the index by using the following curl query: ```shell-session -$ curl -u token: -XGET -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/logs--i-/_stats/store?pretty' +$ curl --oauth2-bearer -XGET -H 'Content-Type: application/json' 'https://.logs.ovh.com:9200/-i-/_stats/store?pretty' ``` This command will give you a document with the following format: @@ -393,7 +465,7 @@ This command will give you a document with the following format: } }, "indices" : { - "logs--i-" : { + "-i-" : { "uuid" : "JC0IWkd3QYSBNd4B2bBZGg", "primaries" : { "store" : { @@ -411,7 +483,7 @@ This command will give you a document with the following format: ``` The size in bytes used to compute your billing is the one under the following path: -"indices" -> "logs--i-" -> "primaries" -> "store" -> "size\_in\_bytes". +"indices" -> "-i-" -> "primaries" -> "store" -> "size\_in\_bytes". ### Management through OpenSearch API @@ -421,8 +493,8 @@ On Logs Data Platform, we allow users to use OpenSearch API to handle the lifecy To create an index on Logs Data Platform, use the following call: -```shell-session -$ curl -u : -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' -d '{ "settings" : {"number_of_shards" : 1}}' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' -d '{ "settings" : {"number_of_shards" : 1}}' ``` - The **-u** option is followed by your LDP username that you can find on **Home** page. The password 'mypassword' follows it after the separator ':' @@ -431,22 +503,22 @@ $ curl -u : -XPUT -H 'Content-Type: application/json' 'htt - The address contains the endpoint of the cluster followed by the **name of your index** - The payload of the request is a **JSON document** which contains the [settings of your index](https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/create-index/): the number of shards (the number of replicas will be automatically set at 1). -You have to follow the Logs Data Platform naming convention `-i-` to create your index. Your username is the one you use to connect to Graylog or to use the API. The suffix can contain any alphanumeric character. +You have to follow the Logs Data Platform naming convention `-i-` to create your index. Your service name can be found on the home page of the Logs Data Platform control panel. The suffix can contain any alphanumeric characters. -To delete a index use the following call: +To delete an index use the following call: -```shell-session -$ curl -u : -XDELETE -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' +```bash +$ curl --oauth2-bearer -XDELETE -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-' ``` Here we use the **DELETE** HTTP command to delete the index. #### Alias creation and deletion -Similarly than indices, you can use the API Calls to delete and create aliases on your indices. The only difference is the convention for the name of your alias. Your alias must be formatted as the following **`-a-`**. Here is an example call: +Similarly than indices, you can use the API Calls to delete and create aliases on your indices. The only difference is the convention for the name of your alias. Your alias must be formatted as the following **`-a-`** (or -a- for legacy users). Here is an example call: -```shell-session -$ curl -u : -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-/_alias/-a-' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/-i-/_alias/-a-' ``` This call creates a individual alias on one index you have previously created. @@ -455,13 +527,13 @@ If you need more information on aliases, you can check the [OpenSearch Documenta We also support the aliases API to create aliases: -```shell-session -$ curl -XPOST "https://gra2.logs.ovh.com:9200/_aliases?pretty" -H 'Content-Type: application/json' -d' +```bash +$ curl --oauth2-bearer -XPOST "https://gra2.logs.ovh.com:9200/_aliases?pretty" -H 'Content-Type: application/json' -d' { "actions" : [ - { "remove" : { "index" : "-i-", "alias" : "-a-" } }, - { "add" : { "index" : "-i-", "alias" : "-a-" } }, - { "remove_index": { "index": "-i-" } } + { "remove" : { "index" : "-i-", "alias" : "-a-" } }, + { "add" : { "index" : "-i-", "alias" : "-a-" } }, + { "remove_index": { "index": "-i-" } } ] }' ``` @@ -472,22 +544,22 @@ All the actions (alias change, alias creation and index deletion) will be done i Logs Data Platform supports your custom templates. As for indices and aliases, the template must follow some rules in order for them to work: -- the template name must contain your **``** inside the name. It can be anywhere in the name string. -- The prefix of the indices involved in the template MUST start by **`-i-`**, the "\*" character must be after this prefix -- The alias attached to your template must follow the usual convention: **`-a-`** +- the template name must contain your **``** inside the name. It can be anywhere in the name string. +- The prefix of the indices involved in the template MUST start by one your allowed services so **`-i-`**, the "\*" character must be after this prefix +- The alias attached to your template must follow the usual convention: **`-a-`** -Here is an example of a template for a user **logs-ab-12345**: +Here is an example of a template for a service **ldp-ab-12345**: -```shell-session -$ curl -u : -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/_template/template_for_logs-ab-12345_indices' -d ' +```bash +$ curl --oauth2-bearer -XPUT -H 'Content-Type: application/json' 'https://gra2.logs.ovh.com:9200/_template/template_for_ldp-ab-12345_indices' -d ' { - "index_patterns" : [ "logs-ab-12345-i-debug*","logs-ab-12345-i-test*" ], + "index_patterns" : [ "ldp-ab-12345-i-debug*","ldp-ab-12345-i-test*" ], "settings": { "number_of_shards" : 1 }, "aliases" : { - "logs-ab-12345-a-all" : {}, - "logs-ab-12345-a-debug" : { "filter" : { "term" : { "type" : "debug" } } } + "ldp-ab-12345-a-all" : {}, + "ldp-ab-12345-a-debug" : { "filter" : { "term" : { "type" : "debug" } } } } }' ``` @@ -507,8 +579,8 @@ Here the first index was create through API, its description was filled automati Index as a service has some specificities on our platforms. This additional and technical information can help you to use it properly: - **Replication** is set at 1 and cannot be changed. We ensure the high availability of your index in case of a hardware failure. -- The **maximum size** of your index is fixed and is dependent on the number of shards. If search performance is critical, you should choose an index with the highest number of shard you can afford. -- The **index_refresh_interval** of the index is set at 1 second ensuring near real time search results. +- The **maximum size** of your index is fixed and is dependent on the number of shards. If search performance is critical, you should choose the highest number of shards you can afford. +- The **index_refresh_interval** of the index is set at 1 second, ensuring near real time search results. - You are not allowed to change the settings of your index. - You can create an **alias** on Logs Data Platform and attach it to one or several indices. - Unlike indices, aliases are **read-only**, you cannot write through an alias yet. @@ -519,4 +591,4 @@ Index as a service has some specificities on our platforms. This additional and - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/images/index_menu.png b/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/images/index_menu.png deleted file mode 100644 index 69fa3a60b6f..00000000000 Binary files a/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/images/index_menu.png and /dev/null differ diff --git a/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/images/options_menu.png b/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/images/options_menu.png deleted file mode 100644 index 07e7a783ea6..00000000000 Binary files a/pages/manage_and_operate/observability/logs_data_platform/opensearch_index/images/options_menu.png and /dev/null differ diff --git a/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.de-de.md b/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.de-de.md index 986e2a548b8..d403fc4f392 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.de-de.md +++ b/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.de-de.md @@ -1,133 +1,160 @@ --- title: Securing Logs Data Platform's APIs with tokens -excerpt: If you want to give access to your logs to a software or automatize some tasks depending on your logs. You will maybe need to access them through the API. The most secure way to do this is to use tokens. -updated: 2023-06-02 +excerpt: If you want to give access to your logs to a software application or automate tasks that depend on your logs, you may need to access them through the API. +updated: 2025-10-16 --- ## Objective -With Logs Data Platform, there are 3 ways to query your logs. +With Logs Data Platform, there are 3 ways to query your logs: - The [Graylog Web Interface](https://gra1.logs.ovh.com) - The [Graylog API](https://gra1.logs.ovh.com/api/api-browser/global/index.html#!/search47universal47relative/searchRelative) -- The [OpenSearch API](https://opensearch.org/docs/latest/opensearch/query-dsl/index/) located at the port 9200 of your cluster (find its address in the **Home** Page) against your [alias](/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards). +- The [OpenSearch API](https://opensearch.org/docs/latest/opensearch/query-dsl/index/) located on port 9200 of your cluster (find its address in the **Home** Page) against your [alias](/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards). -So you can pop up a [Grafana](/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana) or even [a terminal Dashboard for Graylog](https://github.com/Graylog2/cli-dashboard). +So you open a [Grafana](/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana) or even [a terminal Dashboard for Graylog](https://github.com/Graylog2/cli-dashboard). All these accesses are secured by your username and password. But what if you don't want to put your Logs Data Platform credentials everywhere? You can just use tokens to access all these endpoints and revoke them anytime you want. This tutorial is here to tell you how. ## Requirements -- No specific requirements +- A service with IAM enabled to use IAM tokens or without IAM to use legacy tokens ## Instructions -### Generating tokens using the manager +### Generating tokens with IAM -Once you have logged into Logs Data Platform you will have to access to the token Generation panel from the Configuration box. +Before generating tokens with IAM you will need to create a [Service Account or a Local User](/pages/manage_and_operate/iam/identities-management). Both have specificities detailed in IAM documentation. Don't forget to attach these new identities to your [IAM Policies](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). -![Token Menu](images/token_menu.png){.thumbnail} +#### Service accounts -On this page you will have the possibility to create a token and to remove them. Note that you cannot modify a token. +Create a service account and tokens by following the [documentation](/pages/manage_and_operate/api/manage-service-account). Service accounts are a identifier/token pair following the OAuth2 **client- credentials** authentication mechanism. If you are familiar with OAuth2 clients, here are the API calls to create them. We still recommend you to read the dedicated guide to understand its specificities. -![token generation](images/token_generation.png){.thumbnail} +To create a service account, use the following API call: -Once the token is created, you can use its value or remove it: +> [!api] +> +> @api {v1} /me POST /me/api/oauth2/client +> -![token generated](images/token_generated.png){.thumbnail} +With this API call, you can create OAuth2 credentials for several authentication mechanisms. The one we are interested in here is **CLIENT_CREDENTIALS**. This mechanism does not require a callback URL. -### Generating tokens with API +You must supply the following values: -One goal with token is to automatize APIs call. Sometime you even need to automatize token creation. That's why it is possible to create token by using only the OVHcloud APIs. If you're familiar with the OVHcloud API, it should be fairly straightforward, if you're not, this section will help you with it. Generating tokens is two API calls away. You can use the OVHcloud API console to make theses calls. +- **callbackUrls**: An empty array of callback URLs `[]`. +- **flow**: `CLIENT_CREDENTIALS`. +- **name**: The name you would like to provide to your identifier. +- **description**: A description of your identifier. We recommend describing how you will use this identifier. If you audit your access in the future, it is easier to link it to your application name, so that you can easily find out where the identifier is deployed (and what the impact will be if you change your access). -First you will have to retrieve the serviceName you want to generate token for. The API call to get your serviceName is the following: +In response, the API will provide you with two pieces of information: -> [!api] -> -> @api {v1} /dbaas/logs GET /dbaas/logs -> +- **clientId**: Your service account ID. +- **clientSecret**: A token allowing you to authenticate yourself on our APIs. This information must be stored securely. With these two credentials, you can log in to this service account and get the rights associated with it. Save this value. It will not be possible to retrieve it at a later stage. -If you want to know what is the Logs Data Platform username associated with this serviceName, use the following call: +In order to retrieve an API token, you can use the following HTTP call with these two pieces of information: -> [!api] -> -> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName} -> +```bash +curl --request POST \ + --url 'https://www.ovh.com/auth/oauth2/token' \ + --header 'content-type: application/x-www-form-urlencoded' \ + --data grant_type=client_credentials \ + --data client_id=0f0f0f0f0f0f0f0f \ + --data client_secret=xxxxx \ + --data scope=all +``` -This call returns the service object of the connected identity. +Depending on the location of your API, you will need to use the following URL: -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) +- **EU API**: `https://www.ovh.com/auth/oauth2/token`. +- **CA API**: `https://ca.ovh.com/auth/oauth2/token`. -Once you have the login you want, use the following call to add a new token: +Following this API call, you will receive a response in the following format: -> [!api] -> -> @api {v1} /dbaas/logs POST /dbaas/logs/{serviceName}/token -> +```json +{ + "access_token":"your-api-token", + "token_type":"Bearer", + "expires_in":3599, + "scope":"all" +} +``` -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> - `name`: The name of your token (string) -> +Save the token in the **access_token** field. You will need it to authenticate your API calls. -Please replace **serviceName** with your serviceName, and replace **name** by the name of your choice for your token. This call will give you a taskId. After a few seconds you can retrieve your **tokenId** with this call: +This access token can then be used to interact with Logs Data Platform backend APIs. Don't forget to manage access rights of your service account with the [IAM policies](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). -> [!api] -> -> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName}/token -> +```bash +ldp@laptop curl -H 'content-type: application/json' --oauth2-bearer -XPUT 'https://.logs.ovh.com:9200/_cat/indices/ldp-*' +``` -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> +Or with the Bearer header: + +```bash +ldp@laptop curl -H 'content-type: application/json' -H "Authorization: Bearer " -XPUT 'https://.logs.ovh.com:9200/_cat/indices/ldp-*' +``` + +Note that access tokens created through a service account expire after some time. You must regenerate a new one after it has expired. -This will give you back the id of your token. The actual value of the token can be retrieved with this next call: +#### Local Users + +Create a local user by following the [dedicated documentation](/pages/account_and_service_management/account_information/ovhcloud-users-management) and create the right [IAM policies](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). Once created, you can use the OVHcloud API to create a token for this user: > [!api] > -> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName}/token/{tokenId} +> @api {v1} /me POST /me/identity/user/{user}/token > -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> - `tokenId`: UUID of your token (string) +This call will return a bearer access token for your local user. -Here is the final response you will get. +You can then use this token on Logs Data Platform backend APIs: -```json -{ - "updatedAt": "2016-12-01T12:30:26.566986+00:00", - "createdAt": "2016-12-01T12:30:26.566939+00:00", - "value": "kujg9g227qv0123mav3s0q4pra4psqsi5leka6j7lc62qdef58q", - "name": "token_name", - "tokenId": "XXXXXXXXXXXXXXXXXXXXXXXXXXX" -} +```bash +ldp@laptop curl -H 'content-type: application/json' --oauth2-bearer -XPUT 'https://.logs.ovh.com/api/search/universal/relative?query=*&range=300&filter=streams:a123aebc12345623aafd' ``` -The token value is the value field. That is the field you will need to use the Logs Data Platform Search APIs. +Or with the Bearer header + +```bash +ldp@laptop curl -H 'content-type: application/json' -H "Authorization: Bearer " -XPUT 'https://.logs.ovh.com/api/search/universal/relative?query=*&range=300&filter=streams:a123aebc12345623aafd' +``` -Finally to delete your token, use the following call: +These tokens do not expire but can be deleted whenever needed with this call: > [!api] > -> @api {v1} /dbaas/logs DELETE /dbaas/logs/{serviceName}/token/{tokenId} +> @api {v1} /me DELETE /me/identity/user/{user}/token/{name} > -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> - `tokenId`: UUID of your token (string) -> +#### Hybrid authentication + +For software that does not support the Bearer authentication scheme, we provide a hybrid authentication mode based on the Basic authentication scheme. Use a username that starts with **pat_jwt_** and supply the token value as the password. + +```bash +ldp@laptop curl -H 'content-type: application/json' \\ + -u pat_jwt_: \\ + -XPUT 'https://.logs.ovh.com:9200/_cat/indices/ldp-*' +``` + +### Legacy tokens + +Legacy tokens are still working and maintained for users without IAM. They are not available to IAM-enabled users. We strongly encourage you to migrate to IAM now and use the more flexible tokens described above. + +Once you have logged into Logs Data Platform you will have access to the token generation function from the Configuration panel. + +![Token Menu](images/token_menu.png){.thumbnail} + +On this page you will have the possibility to create a token and to remove them. Note that you cannot modify a token. + +![token generation](images/token_generation.png){.thumbnail} + +Once the token is created, you can use its value or remove it: + +![token generated](images/token_generated.png){.thumbnail} ### Using your tokens -Using your token is no different of using your credentials. You just have to replace your username with the word **token** and your password with the token (the opposite works too). -For example to issue a search against the Graylog API with the token obtained above, you can do the following: +Using your token is no different than using your credentials. You just have to replace your username with the word **token** and your password with the token (the opposite works too). +For example, to issue a search against the Graylog API with the token obtained above, you can do the following: ```shell-session $ curl -u token:kujg9g227qv0123mav3s0q4pra4psqsi5leka6j7lc62qdef58q -XGET "https://.logs.ovh.com/api/search/universal/relative?query=*&range=300&filter=streams:a123aebc12345623aafd" @@ -148,13 +175,13 @@ To issue a search against the OpenSearch API, you also use the same credentials. $ curl -u token:kujg9g227qv0123mav3s0q4pra4psqsi5leka6j7lc62qdef58q "https://.logs.ovh.com:9200/your_alias/_search?pretty" ``` -This call will launch a quick search (to retrieve the count and a sample of your documents) against the alias **your_alias**. Replace the alias by the one you have setup in you Logs Data Platform console. Note that these credentials are usable in place of your account credentials in Grafana (or any tool that supports Basic Authentication with OpenSearch). +This call will launch a quick search (to retrieve the count and a sample of your documents) against the alias **your_alias**. Replace the alias by the one you have set up in your Logs Data Platform console. Note that these credentials are usable in place of your account credentials in Grafana (or any tool that supports Basic Authentication with OpenSearch). -The only place you cannot use your token is the Graylog Web Interface. +The Graylog Web Interface does not support token authentication. ## Go further - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.en-asia.md b/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.en-asia.md index 986e2a548b8..d403fc4f392 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.en-asia.md +++ b/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.en-asia.md @@ -1,133 +1,160 @@ --- title: Securing Logs Data Platform's APIs with tokens -excerpt: If you want to give access to your logs to a software or automatize some tasks depending on your logs. You will maybe need to access them through the API. The most secure way to do this is to use tokens. -updated: 2023-06-02 +excerpt: If you want to give access to your logs to a software application or automate tasks that depend on your logs, you may need to access them through the API. +updated: 2025-10-16 --- ## Objective -With Logs Data Platform, there are 3 ways to query your logs. +With Logs Data Platform, there are 3 ways to query your logs: - The [Graylog Web Interface](https://gra1.logs.ovh.com) - The [Graylog API](https://gra1.logs.ovh.com/api/api-browser/global/index.html#!/search47universal47relative/searchRelative) -- The [OpenSearch API](https://opensearch.org/docs/latest/opensearch/query-dsl/index/) located at the port 9200 of your cluster (find its address in the **Home** Page) against your [alias](/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards). +- The [OpenSearch API](https://opensearch.org/docs/latest/opensearch/query-dsl/index/) located on port 9200 of your cluster (find its address in the **Home** Page) against your [alias](/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards). -So you can pop up a [Grafana](/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana) or even [a terminal Dashboard for Graylog](https://github.com/Graylog2/cli-dashboard). +So you open a [Grafana](/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana) or even [a terminal Dashboard for Graylog](https://github.com/Graylog2/cli-dashboard). All these accesses are secured by your username and password. But what if you don't want to put your Logs Data Platform credentials everywhere? You can just use tokens to access all these endpoints and revoke them anytime you want. This tutorial is here to tell you how. ## Requirements -- No specific requirements +- A service with IAM enabled to use IAM tokens or without IAM to use legacy tokens ## Instructions -### Generating tokens using the manager +### Generating tokens with IAM -Once you have logged into Logs Data Platform you will have to access to the token Generation panel from the Configuration box. +Before generating tokens with IAM you will need to create a [Service Account or a Local User](/pages/manage_and_operate/iam/identities-management). Both have specificities detailed in IAM documentation. Don't forget to attach these new identities to your [IAM Policies](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). -![Token Menu](images/token_menu.png){.thumbnail} +#### Service accounts -On this page you will have the possibility to create a token and to remove them. Note that you cannot modify a token. +Create a service account and tokens by following the [documentation](/pages/manage_and_operate/api/manage-service-account). Service accounts are a identifier/token pair following the OAuth2 **client- credentials** authentication mechanism. If you are familiar with OAuth2 clients, here are the API calls to create them. We still recommend you to read the dedicated guide to understand its specificities. -![token generation](images/token_generation.png){.thumbnail} +To create a service account, use the following API call: -Once the token is created, you can use its value or remove it: +> [!api] +> +> @api {v1} /me POST /me/api/oauth2/client +> -![token generated](images/token_generated.png){.thumbnail} +With this API call, you can create OAuth2 credentials for several authentication mechanisms. The one we are interested in here is **CLIENT_CREDENTIALS**. This mechanism does not require a callback URL. -### Generating tokens with API +You must supply the following values: -One goal with token is to automatize APIs call. Sometime you even need to automatize token creation. That's why it is possible to create token by using only the OVHcloud APIs. If you're familiar with the OVHcloud API, it should be fairly straightforward, if you're not, this section will help you with it. Generating tokens is two API calls away. You can use the OVHcloud API console to make theses calls. +- **callbackUrls**: An empty array of callback URLs `[]`. +- **flow**: `CLIENT_CREDENTIALS`. +- **name**: The name you would like to provide to your identifier. +- **description**: A description of your identifier. We recommend describing how you will use this identifier. If you audit your access in the future, it is easier to link it to your application name, so that you can easily find out where the identifier is deployed (and what the impact will be if you change your access). -First you will have to retrieve the serviceName you want to generate token for. The API call to get your serviceName is the following: +In response, the API will provide you with two pieces of information: -> [!api] -> -> @api {v1} /dbaas/logs GET /dbaas/logs -> +- **clientId**: Your service account ID. +- **clientSecret**: A token allowing you to authenticate yourself on our APIs. This information must be stored securely. With these two credentials, you can log in to this service account and get the rights associated with it. Save this value. It will not be possible to retrieve it at a later stage. -If you want to know what is the Logs Data Platform username associated with this serviceName, use the following call: +In order to retrieve an API token, you can use the following HTTP call with these two pieces of information: -> [!api] -> -> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName} -> +```bash +curl --request POST \ + --url 'https://www.ovh.com/auth/oauth2/token' \ + --header 'content-type: application/x-www-form-urlencoded' \ + --data grant_type=client_credentials \ + --data client_id=0f0f0f0f0f0f0f0f \ + --data client_secret=xxxxx \ + --data scope=all +``` -This call returns the service object of the connected identity. +Depending on the location of your API, you will need to use the following URL: -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) +- **EU API**: `https://www.ovh.com/auth/oauth2/token`. +- **CA API**: `https://ca.ovh.com/auth/oauth2/token`. -Once you have the login you want, use the following call to add a new token: +Following this API call, you will receive a response in the following format: -> [!api] -> -> @api {v1} /dbaas/logs POST /dbaas/logs/{serviceName}/token -> +```json +{ + "access_token":"your-api-token", + "token_type":"Bearer", + "expires_in":3599, + "scope":"all" +} +``` -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> - `name`: The name of your token (string) -> +Save the token in the **access_token** field. You will need it to authenticate your API calls. -Please replace **serviceName** with your serviceName, and replace **name** by the name of your choice for your token. This call will give you a taskId. After a few seconds you can retrieve your **tokenId** with this call: +This access token can then be used to interact with Logs Data Platform backend APIs. Don't forget to manage access rights of your service account with the [IAM policies](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). -> [!api] -> -> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName}/token -> +```bash +ldp@laptop curl -H 'content-type: application/json' --oauth2-bearer -XPUT 'https://.logs.ovh.com:9200/_cat/indices/ldp-*' +``` -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> +Or with the Bearer header: + +```bash +ldp@laptop curl -H 'content-type: application/json' -H "Authorization: Bearer " -XPUT 'https://.logs.ovh.com:9200/_cat/indices/ldp-*' +``` + +Note that access tokens created through a service account expire after some time. You must regenerate a new one after it has expired. -This will give you back the id of your token. The actual value of the token can be retrieved with this next call: +#### Local Users + +Create a local user by following the [dedicated documentation](/pages/account_and_service_management/account_information/ovhcloud-users-management) and create the right [IAM policies](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). Once created, you can use the OVHcloud API to create a token for this user: > [!api] > -> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName}/token/{tokenId} +> @api {v1} /me POST /me/identity/user/{user}/token > -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> - `tokenId`: UUID of your token (string) +This call will return a bearer access token for your local user. -Here is the final response you will get. +You can then use this token on Logs Data Platform backend APIs: -```json -{ - "updatedAt": "2016-12-01T12:30:26.566986+00:00", - "createdAt": "2016-12-01T12:30:26.566939+00:00", - "value": "kujg9g227qv0123mav3s0q4pra4psqsi5leka6j7lc62qdef58q", - "name": "token_name", - "tokenId": "XXXXXXXXXXXXXXXXXXXXXXXXXXX" -} +```bash +ldp@laptop curl -H 'content-type: application/json' --oauth2-bearer -XPUT 'https://.logs.ovh.com/api/search/universal/relative?query=*&range=300&filter=streams:a123aebc12345623aafd' ``` -The token value is the value field. That is the field you will need to use the Logs Data Platform Search APIs. +Or with the Bearer header + +```bash +ldp@laptop curl -H 'content-type: application/json' -H "Authorization: Bearer " -XPUT 'https://.logs.ovh.com/api/search/universal/relative?query=*&range=300&filter=streams:a123aebc12345623aafd' +``` -Finally to delete your token, use the following call: +These tokens do not expire but can be deleted whenever needed with this call: > [!api] > -> @api {v1} /dbaas/logs DELETE /dbaas/logs/{serviceName}/token/{tokenId} +> @api {v1} /me DELETE /me/identity/user/{user}/token/{name} > -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> - `tokenId`: UUID of your token (string) -> +#### Hybrid authentication + +For software that does not support the Bearer authentication scheme, we provide a hybrid authentication mode based on the Basic authentication scheme. Use a username that starts with **pat_jwt_** and supply the token value as the password. + +```bash +ldp@laptop curl -H 'content-type: application/json' \\ + -u pat_jwt_: \\ + -XPUT 'https://.logs.ovh.com:9200/_cat/indices/ldp-*' +``` + +### Legacy tokens + +Legacy tokens are still working and maintained for users without IAM. They are not available to IAM-enabled users. We strongly encourage you to migrate to IAM now and use the more flexible tokens described above. + +Once you have logged into Logs Data Platform you will have access to the token generation function from the Configuration panel. + +![Token Menu](images/token_menu.png){.thumbnail} + +On this page you will have the possibility to create a token and to remove them. Note that you cannot modify a token. + +![token generation](images/token_generation.png){.thumbnail} + +Once the token is created, you can use its value or remove it: + +![token generated](images/token_generated.png){.thumbnail} ### Using your tokens -Using your token is no different of using your credentials. You just have to replace your username with the word **token** and your password with the token (the opposite works too). -For example to issue a search against the Graylog API with the token obtained above, you can do the following: +Using your token is no different than using your credentials. You just have to replace your username with the word **token** and your password with the token (the opposite works too). +For example, to issue a search against the Graylog API with the token obtained above, you can do the following: ```shell-session $ curl -u token:kujg9g227qv0123mav3s0q4pra4psqsi5leka6j7lc62qdef58q -XGET "https://.logs.ovh.com/api/search/universal/relative?query=*&range=300&filter=streams:a123aebc12345623aafd" @@ -148,13 +175,13 @@ To issue a search against the OpenSearch API, you also use the same credentials. $ curl -u token:kujg9g227qv0123mav3s0q4pra4psqsi5leka6j7lc62qdef58q "https://.logs.ovh.com:9200/your_alias/_search?pretty" ``` -This call will launch a quick search (to retrieve the count and a sample of your documents) against the alias **your_alias**. Replace the alias by the one you have setup in you Logs Data Platform console. Note that these credentials are usable in place of your account credentials in Grafana (or any tool that supports Basic Authentication with OpenSearch). +This call will launch a quick search (to retrieve the count and a sample of your documents) against the alias **your_alias**. Replace the alias by the one you have set up in your Logs Data Platform console. Note that these credentials are usable in place of your account credentials in Grafana (or any tool that supports Basic Authentication with OpenSearch). -The only place you cannot use your token is the Graylog Web Interface. +The Graylog Web Interface does not support token authentication. ## Go further - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.en-au.md b/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.en-au.md index 986e2a548b8..d403fc4f392 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.en-au.md +++ b/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.en-au.md @@ -1,133 +1,160 @@ --- title: Securing Logs Data Platform's APIs with tokens -excerpt: If you want to give access to your logs to a software or automatize some tasks depending on your logs. You will maybe need to access them through the API. The most secure way to do this is to use tokens. -updated: 2023-06-02 +excerpt: If you want to give access to your logs to a software application or automate tasks that depend on your logs, you may need to access them through the API. +updated: 2025-10-16 --- ## Objective -With Logs Data Platform, there are 3 ways to query your logs. +With Logs Data Platform, there are 3 ways to query your logs: - The [Graylog Web Interface](https://gra1.logs.ovh.com) - The [Graylog API](https://gra1.logs.ovh.com/api/api-browser/global/index.html#!/search47universal47relative/searchRelative) -- The [OpenSearch API](https://opensearch.org/docs/latest/opensearch/query-dsl/index/) located at the port 9200 of your cluster (find its address in the **Home** Page) against your [alias](/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards). +- The [OpenSearch API](https://opensearch.org/docs/latest/opensearch/query-dsl/index/) located on port 9200 of your cluster (find its address in the **Home** Page) against your [alias](/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards). -So you can pop up a [Grafana](/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana) or even [a terminal Dashboard for Graylog](https://github.com/Graylog2/cli-dashboard). +So you open a [Grafana](/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana) or even [a terminal Dashboard for Graylog](https://github.com/Graylog2/cli-dashboard). All these accesses are secured by your username and password. But what if you don't want to put your Logs Data Platform credentials everywhere? You can just use tokens to access all these endpoints and revoke them anytime you want. This tutorial is here to tell you how. ## Requirements -- No specific requirements +- A service with IAM enabled to use IAM tokens or without IAM to use legacy tokens ## Instructions -### Generating tokens using the manager +### Generating tokens with IAM -Once you have logged into Logs Data Platform you will have to access to the token Generation panel from the Configuration box. +Before generating tokens with IAM you will need to create a [Service Account or a Local User](/pages/manage_and_operate/iam/identities-management). Both have specificities detailed in IAM documentation. Don't forget to attach these new identities to your [IAM Policies](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). -![Token Menu](images/token_menu.png){.thumbnail} +#### Service accounts -On this page you will have the possibility to create a token and to remove them. Note that you cannot modify a token. +Create a service account and tokens by following the [documentation](/pages/manage_and_operate/api/manage-service-account). Service accounts are a identifier/token pair following the OAuth2 **client- credentials** authentication mechanism. If you are familiar with OAuth2 clients, here are the API calls to create them. We still recommend you to read the dedicated guide to understand its specificities. -![token generation](images/token_generation.png){.thumbnail} +To create a service account, use the following API call: -Once the token is created, you can use its value or remove it: +> [!api] +> +> @api {v1} /me POST /me/api/oauth2/client +> -![token generated](images/token_generated.png){.thumbnail} +With this API call, you can create OAuth2 credentials for several authentication mechanisms. The one we are interested in here is **CLIENT_CREDENTIALS**. This mechanism does not require a callback URL. -### Generating tokens with API +You must supply the following values: -One goal with token is to automatize APIs call. Sometime you even need to automatize token creation. That's why it is possible to create token by using only the OVHcloud APIs. If you're familiar with the OVHcloud API, it should be fairly straightforward, if you're not, this section will help you with it. Generating tokens is two API calls away. You can use the OVHcloud API console to make theses calls. +- **callbackUrls**: An empty array of callback URLs `[]`. +- **flow**: `CLIENT_CREDENTIALS`. +- **name**: The name you would like to provide to your identifier. +- **description**: A description of your identifier. We recommend describing how you will use this identifier. If you audit your access in the future, it is easier to link it to your application name, so that you can easily find out where the identifier is deployed (and what the impact will be if you change your access). -First you will have to retrieve the serviceName you want to generate token for. The API call to get your serviceName is the following: +In response, the API will provide you with two pieces of information: -> [!api] -> -> @api {v1} /dbaas/logs GET /dbaas/logs -> +- **clientId**: Your service account ID. +- **clientSecret**: A token allowing you to authenticate yourself on our APIs. This information must be stored securely. With these two credentials, you can log in to this service account and get the rights associated with it. Save this value. It will not be possible to retrieve it at a later stage. -If you want to know what is the Logs Data Platform username associated with this serviceName, use the following call: +In order to retrieve an API token, you can use the following HTTP call with these two pieces of information: -> [!api] -> -> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName} -> +```bash +curl --request POST \ + --url 'https://www.ovh.com/auth/oauth2/token' \ + --header 'content-type: application/x-www-form-urlencoded' \ + --data grant_type=client_credentials \ + --data client_id=0f0f0f0f0f0f0f0f \ + --data client_secret=xxxxx \ + --data scope=all +``` -This call returns the service object of the connected identity. +Depending on the location of your API, you will need to use the following URL: -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) +- **EU API**: `https://www.ovh.com/auth/oauth2/token`. +- **CA API**: `https://ca.ovh.com/auth/oauth2/token`. -Once you have the login you want, use the following call to add a new token: +Following this API call, you will receive a response in the following format: -> [!api] -> -> @api {v1} /dbaas/logs POST /dbaas/logs/{serviceName}/token -> +```json +{ + "access_token":"your-api-token", + "token_type":"Bearer", + "expires_in":3599, + "scope":"all" +} +``` -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> - `name`: The name of your token (string) -> +Save the token in the **access_token** field. You will need it to authenticate your API calls. -Please replace **serviceName** with your serviceName, and replace **name** by the name of your choice for your token. This call will give you a taskId. After a few seconds you can retrieve your **tokenId** with this call: +This access token can then be used to interact with Logs Data Platform backend APIs. Don't forget to manage access rights of your service account with the [IAM policies](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). -> [!api] -> -> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName}/token -> +```bash +ldp@laptop curl -H 'content-type: application/json' --oauth2-bearer -XPUT 'https://.logs.ovh.com:9200/_cat/indices/ldp-*' +``` -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> +Or with the Bearer header: + +```bash +ldp@laptop curl -H 'content-type: application/json' -H "Authorization: Bearer " -XPUT 'https://.logs.ovh.com:9200/_cat/indices/ldp-*' +``` + +Note that access tokens created through a service account expire after some time. You must regenerate a new one after it has expired. -This will give you back the id of your token. The actual value of the token can be retrieved with this next call: +#### Local Users + +Create a local user by following the [dedicated documentation](/pages/account_and_service_management/account_information/ovhcloud-users-management) and create the right [IAM policies](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). Once created, you can use the OVHcloud API to create a token for this user: > [!api] > -> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName}/token/{tokenId} +> @api {v1} /me POST /me/identity/user/{user}/token > -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> - `tokenId`: UUID of your token (string) +This call will return a bearer access token for your local user. -Here is the final response you will get. +You can then use this token on Logs Data Platform backend APIs: -```json -{ - "updatedAt": "2016-12-01T12:30:26.566986+00:00", - "createdAt": "2016-12-01T12:30:26.566939+00:00", - "value": "kujg9g227qv0123mav3s0q4pra4psqsi5leka6j7lc62qdef58q", - "name": "token_name", - "tokenId": "XXXXXXXXXXXXXXXXXXXXXXXXXXX" -} +```bash +ldp@laptop curl -H 'content-type: application/json' --oauth2-bearer -XPUT 'https://.logs.ovh.com/api/search/universal/relative?query=*&range=300&filter=streams:a123aebc12345623aafd' ``` -The token value is the value field. That is the field you will need to use the Logs Data Platform Search APIs. +Or with the Bearer header + +```bash +ldp@laptop curl -H 'content-type: application/json' -H "Authorization: Bearer " -XPUT 'https://.logs.ovh.com/api/search/universal/relative?query=*&range=300&filter=streams:a123aebc12345623aafd' +``` -Finally to delete your token, use the following call: +These tokens do not expire but can be deleted whenever needed with this call: > [!api] > -> @api {v1} /dbaas/logs DELETE /dbaas/logs/{serviceName}/token/{tokenId} +> @api {v1} /me DELETE /me/identity/user/{user}/token/{name} > -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> - `tokenId`: UUID of your token (string) -> +#### Hybrid authentication + +For software that does not support the Bearer authentication scheme, we provide a hybrid authentication mode based on the Basic authentication scheme. Use a username that starts with **pat_jwt_** and supply the token value as the password. + +```bash +ldp@laptop curl -H 'content-type: application/json' \\ + -u pat_jwt_: \\ + -XPUT 'https://.logs.ovh.com:9200/_cat/indices/ldp-*' +``` + +### Legacy tokens + +Legacy tokens are still working and maintained for users without IAM. They are not available to IAM-enabled users. We strongly encourage you to migrate to IAM now and use the more flexible tokens described above. + +Once you have logged into Logs Data Platform you will have access to the token generation function from the Configuration panel. + +![Token Menu](images/token_menu.png){.thumbnail} + +On this page you will have the possibility to create a token and to remove them. Note that you cannot modify a token. + +![token generation](images/token_generation.png){.thumbnail} + +Once the token is created, you can use its value or remove it: + +![token generated](images/token_generated.png){.thumbnail} ### Using your tokens -Using your token is no different of using your credentials. You just have to replace your username with the word **token** and your password with the token (the opposite works too). -For example to issue a search against the Graylog API with the token obtained above, you can do the following: +Using your token is no different than using your credentials. You just have to replace your username with the word **token** and your password with the token (the opposite works too). +For example, to issue a search against the Graylog API with the token obtained above, you can do the following: ```shell-session $ curl -u token:kujg9g227qv0123mav3s0q4pra4psqsi5leka6j7lc62qdef58q -XGET "https://.logs.ovh.com/api/search/universal/relative?query=*&range=300&filter=streams:a123aebc12345623aafd" @@ -148,13 +175,13 @@ To issue a search against the OpenSearch API, you also use the same credentials. $ curl -u token:kujg9g227qv0123mav3s0q4pra4psqsi5leka6j7lc62qdef58q "https://.logs.ovh.com:9200/your_alias/_search?pretty" ``` -This call will launch a quick search (to retrieve the count and a sample of your documents) against the alias **your_alias**. Replace the alias by the one you have setup in you Logs Data Platform console. Note that these credentials are usable in place of your account credentials in Grafana (or any tool that supports Basic Authentication with OpenSearch). +This call will launch a quick search (to retrieve the count and a sample of your documents) against the alias **your_alias**. Replace the alias by the one you have set up in your Logs Data Platform console. Note that these credentials are usable in place of your account credentials in Grafana (or any tool that supports Basic Authentication with OpenSearch). -The only place you cannot use your token is the Graylog Web Interface. +The Graylog Web Interface does not support token authentication. ## Go further - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.en-ca.md b/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.en-ca.md index 986e2a548b8..d403fc4f392 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.en-ca.md +++ b/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.en-ca.md @@ -1,133 +1,160 @@ --- title: Securing Logs Data Platform's APIs with tokens -excerpt: If you want to give access to your logs to a software or automatize some tasks depending on your logs. You will maybe need to access them through the API. The most secure way to do this is to use tokens. -updated: 2023-06-02 +excerpt: If you want to give access to your logs to a software application or automate tasks that depend on your logs, you may need to access them through the API. +updated: 2025-10-16 --- ## Objective -With Logs Data Platform, there are 3 ways to query your logs. +With Logs Data Platform, there are 3 ways to query your logs: - The [Graylog Web Interface](https://gra1.logs.ovh.com) - The [Graylog API](https://gra1.logs.ovh.com/api/api-browser/global/index.html#!/search47universal47relative/searchRelative) -- The [OpenSearch API](https://opensearch.org/docs/latest/opensearch/query-dsl/index/) located at the port 9200 of your cluster (find its address in the **Home** Page) against your [alias](/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards). +- The [OpenSearch API](https://opensearch.org/docs/latest/opensearch/query-dsl/index/) located on port 9200 of your cluster (find its address in the **Home** Page) against your [alias](/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards). -So you can pop up a [Grafana](/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana) or even [a terminal Dashboard for Graylog](https://github.com/Graylog2/cli-dashboard). +So you open a [Grafana](/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana) or even [a terminal Dashboard for Graylog](https://github.com/Graylog2/cli-dashboard). All these accesses are secured by your username and password. But what if you don't want to put your Logs Data Platform credentials everywhere? You can just use tokens to access all these endpoints and revoke them anytime you want. This tutorial is here to tell you how. ## Requirements -- No specific requirements +- A service with IAM enabled to use IAM tokens or without IAM to use legacy tokens ## Instructions -### Generating tokens using the manager +### Generating tokens with IAM -Once you have logged into Logs Data Platform you will have to access to the token Generation panel from the Configuration box. +Before generating tokens with IAM you will need to create a [Service Account or a Local User](/pages/manage_and_operate/iam/identities-management). Both have specificities detailed in IAM documentation. Don't forget to attach these new identities to your [IAM Policies](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). -![Token Menu](images/token_menu.png){.thumbnail} +#### Service accounts -On this page you will have the possibility to create a token and to remove them. Note that you cannot modify a token. +Create a service account and tokens by following the [documentation](/pages/manage_and_operate/api/manage-service-account). Service accounts are a identifier/token pair following the OAuth2 **client- credentials** authentication mechanism. If you are familiar with OAuth2 clients, here are the API calls to create them. We still recommend you to read the dedicated guide to understand its specificities. -![token generation](images/token_generation.png){.thumbnail} +To create a service account, use the following API call: -Once the token is created, you can use its value or remove it: +> [!api] +> +> @api {v1} /me POST /me/api/oauth2/client +> -![token generated](images/token_generated.png){.thumbnail} +With this API call, you can create OAuth2 credentials for several authentication mechanisms. The one we are interested in here is **CLIENT_CREDENTIALS**. This mechanism does not require a callback URL. -### Generating tokens with API +You must supply the following values: -One goal with token is to automatize APIs call. Sometime you even need to automatize token creation. That's why it is possible to create token by using only the OVHcloud APIs. If you're familiar with the OVHcloud API, it should be fairly straightforward, if you're not, this section will help you with it. Generating tokens is two API calls away. You can use the OVHcloud API console to make theses calls. +- **callbackUrls**: An empty array of callback URLs `[]`. +- **flow**: `CLIENT_CREDENTIALS`. +- **name**: The name you would like to provide to your identifier. +- **description**: A description of your identifier. We recommend describing how you will use this identifier. If you audit your access in the future, it is easier to link it to your application name, so that you can easily find out where the identifier is deployed (and what the impact will be if you change your access). -First you will have to retrieve the serviceName you want to generate token for. The API call to get your serviceName is the following: +In response, the API will provide you with two pieces of information: -> [!api] -> -> @api {v1} /dbaas/logs GET /dbaas/logs -> +- **clientId**: Your service account ID. +- **clientSecret**: A token allowing you to authenticate yourself on our APIs. This information must be stored securely. With these two credentials, you can log in to this service account and get the rights associated with it. Save this value. It will not be possible to retrieve it at a later stage. -If you want to know what is the Logs Data Platform username associated with this serviceName, use the following call: +In order to retrieve an API token, you can use the following HTTP call with these two pieces of information: -> [!api] -> -> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName} -> +```bash +curl --request POST \ + --url 'https://www.ovh.com/auth/oauth2/token' \ + --header 'content-type: application/x-www-form-urlencoded' \ + --data grant_type=client_credentials \ + --data client_id=0f0f0f0f0f0f0f0f \ + --data client_secret=xxxxx \ + --data scope=all +``` -This call returns the service object of the connected identity. +Depending on the location of your API, you will need to use the following URL: -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) +- **EU API**: `https://www.ovh.com/auth/oauth2/token`. +- **CA API**: `https://ca.ovh.com/auth/oauth2/token`. -Once you have the login you want, use the following call to add a new token: +Following this API call, you will receive a response in the following format: -> [!api] -> -> @api {v1} /dbaas/logs POST /dbaas/logs/{serviceName}/token -> +```json +{ + "access_token":"your-api-token", + "token_type":"Bearer", + "expires_in":3599, + "scope":"all" +} +``` -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> - `name`: The name of your token (string) -> +Save the token in the **access_token** field. You will need it to authenticate your API calls. -Please replace **serviceName** with your serviceName, and replace **name** by the name of your choice for your token. This call will give you a taskId. After a few seconds you can retrieve your **tokenId** with this call: +This access token can then be used to interact with Logs Data Platform backend APIs. Don't forget to manage access rights of your service account with the [IAM policies](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). -> [!api] -> -> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName}/token -> +```bash +ldp@laptop curl -H 'content-type: application/json' --oauth2-bearer -XPUT 'https://.logs.ovh.com:9200/_cat/indices/ldp-*' +``` -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> +Or with the Bearer header: + +```bash +ldp@laptop curl -H 'content-type: application/json' -H "Authorization: Bearer " -XPUT 'https://.logs.ovh.com:9200/_cat/indices/ldp-*' +``` + +Note that access tokens created through a service account expire after some time. You must regenerate a new one after it has expired. -This will give you back the id of your token. The actual value of the token can be retrieved with this next call: +#### Local Users + +Create a local user by following the [dedicated documentation](/pages/account_and_service_management/account_information/ovhcloud-users-management) and create the right [IAM policies](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). Once created, you can use the OVHcloud API to create a token for this user: > [!api] > -> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName}/token/{tokenId} +> @api {v1} /me POST /me/identity/user/{user}/token > -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> - `tokenId`: UUID of your token (string) +This call will return a bearer access token for your local user. -Here is the final response you will get. +You can then use this token on Logs Data Platform backend APIs: -```json -{ - "updatedAt": "2016-12-01T12:30:26.566986+00:00", - "createdAt": "2016-12-01T12:30:26.566939+00:00", - "value": "kujg9g227qv0123mav3s0q4pra4psqsi5leka6j7lc62qdef58q", - "name": "token_name", - "tokenId": "XXXXXXXXXXXXXXXXXXXXXXXXXXX" -} +```bash +ldp@laptop curl -H 'content-type: application/json' --oauth2-bearer -XPUT 'https://.logs.ovh.com/api/search/universal/relative?query=*&range=300&filter=streams:a123aebc12345623aafd' ``` -The token value is the value field. That is the field you will need to use the Logs Data Platform Search APIs. +Or with the Bearer header + +```bash +ldp@laptop curl -H 'content-type: application/json' -H "Authorization: Bearer " -XPUT 'https://.logs.ovh.com/api/search/universal/relative?query=*&range=300&filter=streams:a123aebc12345623aafd' +``` -Finally to delete your token, use the following call: +These tokens do not expire but can be deleted whenever needed with this call: > [!api] > -> @api {v1} /dbaas/logs DELETE /dbaas/logs/{serviceName}/token/{tokenId} +> @api {v1} /me DELETE /me/identity/user/{user}/token/{name} > -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> - `tokenId`: UUID of your token (string) -> +#### Hybrid authentication + +For software that does not support the Bearer authentication scheme, we provide a hybrid authentication mode based on the Basic authentication scheme. Use a username that starts with **pat_jwt_** and supply the token value as the password. + +```bash +ldp@laptop curl -H 'content-type: application/json' \\ + -u pat_jwt_: \\ + -XPUT 'https://.logs.ovh.com:9200/_cat/indices/ldp-*' +``` + +### Legacy tokens + +Legacy tokens are still working and maintained for users without IAM. They are not available to IAM-enabled users. We strongly encourage you to migrate to IAM now and use the more flexible tokens described above. + +Once you have logged into Logs Data Platform you will have access to the token generation function from the Configuration panel. + +![Token Menu](images/token_menu.png){.thumbnail} + +On this page you will have the possibility to create a token and to remove them. Note that you cannot modify a token. + +![token generation](images/token_generation.png){.thumbnail} + +Once the token is created, you can use its value or remove it: + +![token generated](images/token_generated.png){.thumbnail} ### Using your tokens -Using your token is no different of using your credentials. You just have to replace your username with the word **token** and your password with the token (the opposite works too). -For example to issue a search against the Graylog API with the token obtained above, you can do the following: +Using your token is no different than using your credentials. You just have to replace your username with the word **token** and your password with the token (the opposite works too). +For example, to issue a search against the Graylog API with the token obtained above, you can do the following: ```shell-session $ curl -u token:kujg9g227qv0123mav3s0q4pra4psqsi5leka6j7lc62qdef58q -XGET "https://.logs.ovh.com/api/search/universal/relative?query=*&range=300&filter=streams:a123aebc12345623aafd" @@ -148,13 +175,13 @@ To issue a search against the OpenSearch API, you also use the same credentials. $ curl -u token:kujg9g227qv0123mav3s0q4pra4psqsi5leka6j7lc62qdef58q "https://.logs.ovh.com:9200/your_alias/_search?pretty" ``` -This call will launch a quick search (to retrieve the count and a sample of your documents) against the alias **your_alias**. Replace the alias by the one you have setup in you Logs Data Platform console. Note that these credentials are usable in place of your account credentials in Grafana (or any tool that supports Basic Authentication with OpenSearch). +This call will launch a quick search (to retrieve the count and a sample of your documents) against the alias **your_alias**. Replace the alias by the one you have set up in your Logs Data Platform console. Note that these credentials are usable in place of your account credentials in Grafana (or any tool that supports Basic Authentication with OpenSearch). -The only place you cannot use your token is the Graylog Web Interface. +The Graylog Web Interface does not support token authentication. ## Go further - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.en-gb.md b/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.en-gb.md index e3035ddb68c..d403fc4f392 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.en-gb.md +++ b/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.en-gb.md @@ -1,133 +1,160 @@ --- title: Securing Logs Data Platform's APIs with tokens -excerpt: If you want to give access to your logs to a software or automatize some tasks depending on your logs. You will maybe need to access them through the API. The most secure way to do this is to use tokens. -updated: 2023-06-02 +excerpt: If you want to give access to your logs to a software application or automate tasks that depend on your logs, you may need to access them through the API. +updated: 2025-10-16 --- ## Objective -With Logs Data Platform, there are 3 ways to query your logs. +With Logs Data Platform, there are 3 ways to query your logs: - The [Graylog Web Interface](https://gra1.logs.ovh.com) - The [Graylog API](https://gra1.logs.ovh.com/api/api-browser/global/index.html#!/search47universal47relative/searchRelative) -- The [OpenSearch API](https://opensearch.org/docs/latest/opensearch/query-dsl/index/) located at the port 9200 of your cluster (find its address in the **Home** Page) against your [alias](/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards). +- The [OpenSearch API](https://opensearch.org/docs/latest/opensearch/query-dsl/index/) located on port 9200 of your cluster (find its address in the **Home** Page) against your [alias](/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards). -So you can pop up a [Grafana](/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana) or even [a terminal Dashboard for Graylog](https://github.com/Graylog2/cli-dashboard). +So you open a [Grafana](/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana) or even [a terminal Dashboard for Graylog](https://github.com/Graylog2/cli-dashboard). All these accesses are secured by your username and password. But what if you don't want to put your Logs Data Platform credentials everywhere? You can just use tokens to access all these endpoints and revoke them anytime you want. This tutorial is here to tell you how. ## Requirements -- No specific requirements +- A service with IAM enabled to use IAM tokens or without IAM to use legacy tokens ## Instructions -### Generating tokens using the manager +### Generating tokens with IAM -Once you have logged into Logs Data Platform you will have access to the token generation function from the Configuration panel. +Before generating tokens with IAM you will need to create a [Service Account or a Local User](/pages/manage_and_operate/iam/identities-management). Both have specificities detailed in IAM documentation. Don't forget to attach these new identities to your [IAM Policies](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). -![Token Menu](images/token_menu.png){.thumbnail} +#### Service accounts -On this page you will have the possibility to create a token and to remove them. Note that you cannot modify a token. +Create a service account and tokens by following the [documentation](/pages/manage_and_operate/api/manage-service-account). Service accounts are a identifier/token pair following the OAuth2 **client- credentials** authentication mechanism. If you are familiar with OAuth2 clients, here are the API calls to create them. We still recommend you to read the dedicated guide to understand its specificities. -![token generation](images/token_generation.png){.thumbnail} +To create a service account, use the following API call: -Once the token is created, you can use its value or remove it: +> [!api] +> +> @api {v1} /me POST /me/api/oauth2/client +> -![token generated](images/token_generated.png){.thumbnail} +With this API call, you can create OAuth2 credentials for several authentication mechanisms. The one we are interested in here is **CLIENT_CREDENTIALS**. This mechanism does not require a callback URL. -### Generating tokens with API +You must supply the following values: -One goal of tokens is to automatize API calls. Sometimes you even need to automatize token creation. That's why it is possible to create tokens by using only the OVHcloud APIs. If you're familiar with the OVHcloud API, it should be fairly straightforward, if you're not, this section will help you with it. Generating tokens is two API calls away. You can use the OVHcloud API console to make theses calls. +- **callbackUrls**: An empty array of callback URLs `[]`. +- **flow**: `CLIENT_CREDENTIALS`. +- **name**: The name you would like to provide to your identifier. +- **description**: A description of your identifier. We recommend describing how you will use this identifier. If you audit your access in the future, it is easier to link it to your application name, so that you can easily find out where the identifier is deployed (and what the impact will be if you change your access). -First you will have to retrieve the serviceName you want to generate token for. The API call to get your serviceName is the following: +In response, the API will provide you with two pieces of information: -> [!api] -> -> @api {v1} /dbaas/logs GET /dbaas/logs -> +- **clientId**: Your service account ID. +- **clientSecret**: A token allowing you to authenticate yourself on our APIs. This information must be stored securely. With these two credentials, you can log in to this service account and get the rights associated with it. Save this value. It will not be possible to retrieve it at a later stage. -If you want to know what is the Logs Data Platform username associated with this serviceName, use the following call: +In order to retrieve an API token, you can use the following HTTP call with these two pieces of information: -> [!api] -> -> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName} -> +```bash +curl --request POST \ + --url 'https://www.ovh.com/auth/oauth2/token' \ + --header 'content-type: application/x-www-form-urlencoded' \ + --data grant_type=client_credentials \ + --data client_id=0f0f0f0f0f0f0f0f \ + --data client_secret=xxxxx \ + --data scope=all +``` -This call returns the service object of the connected identity. +Depending on the location of your API, you will need to use the following URL: -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) +- **EU API**: `https://www.ovh.com/auth/oauth2/token`. +- **CA API**: `https://ca.ovh.com/auth/oauth2/token`. -Once you have the login you want, use the following call to add a new token: +Following this API call, you will receive a response in the following format: -> [!api] -> -> @api {v1} /dbaas/logs POST /dbaas/logs/{serviceName}/token -> +```json +{ + "access_token":"your-api-token", + "token_type":"Bearer", + "expires_in":3599, + "scope":"all" +} +``` -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> - `name`: The name of your token (string) -> +Save the token in the **access_token** field. You will need it to authenticate your API calls. -Please replace **serviceName** with your serviceName, and replace **name** with the name of your choice for your token. This call will give you a taskId. After a few seconds you can retrieve your **tokenId** with this call: +This access token can then be used to interact with Logs Data Platform backend APIs. Don't forget to manage access rights of your service account with the [IAM policies](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). -> [!api] -> -> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName}/token -> +```bash +ldp@laptop curl -H 'content-type: application/json' --oauth2-bearer -XPUT 'https://.logs.ovh.com:9200/_cat/indices/ldp-*' +``` -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> +Or with the Bearer header: + +```bash +ldp@laptop curl -H 'content-type: application/json' -H "Authorization: Bearer " -XPUT 'https://.logs.ovh.com:9200/_cat/indices/ldp-*' +``` + +Note that access tokens created through a service account expire after some time. You must regenerate a new one after it has expired. -This will give you back the id of your token. The actual value of the token can be retrieved with this next call: +#### Local Users + +Create a local user by following the [dedicated documentation](/pages/account_and_service_management/account_information/ovhcloud-users-management) and create the right [IAM policies](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). Once created, you can use the OVHcloud API to create a token for this user: > [!api] > -> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName}/token/{tokenId} +> @api {v1} /me POST /me/identity/user/{user}/token > -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> - `tokenId`: UUID of your token (string) +This call will return a bearer access token for your local user. -Here is the final response you will get. +You can then use this token on Logs Data Platform backend APIs: -```json -{ - "updatedAt": "2016-12-01T12:30:26.566986+00:00", - "createdAt": "2016-12-01T12:30:26.566939+00:00", - "value": "kujg9g227qv0123mav3s0q4pra4psqsi5leka6j7lc62qdef58q", - "name": "token_name", - "tokenId": "XXXXXXXXXXXXXXXXXXXXXXXXXXX" -} +```bash +ldp@laptop curl -H 'content-type: application/json' --oauth2-bearer -XPUT 'https://.logs.ovh.com/api/search/universal/relative?query=*&range=300&filter=streams:a123aebc12345623aafd' ``` -The token value is the value field. That is the field you will need to use the Logs Data Platform Search APIs. +Or with the Bearer header + +```bash +ldp@laptop curl -H 'content-type: application/json' -H "Authorization: Bearer " -XPUT 'https://.logs.ovh.com/api/search/universal/relative?query=*&range=300&filter=streams:a123aebc12345623aafd' +``` -Finally to delete your token, use the following call: +These tokens do not expire but can be deleted whenever needed with this call: > [!api] > -> @api {v1} /dbaas/logs DELETE /dbaas/logs/{serviceName}/token/{tokenId} +> @api {v1} /me DELETE /me/identity/user/{user}/token/{name} > -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> - `tokenId`: UUID of your token (string) -> +#### Hybrid authentication + +For software that does not support the Bearer authentication scheme, we provide a hybrid authentication mode based on the Basic authentication scheme. Use a username that starts with **pat_jwt_** and supply the token value as the password. + +```bash +ldp@laptop curl -H 'content-type: application/json' \\ + -u pat_jwt_: \\ + -XPUT 'https://.logs.ovh.com:9200/_cat/indices/ldp-*' +``` + +### Legacy tokens + +Legacy tokens are still working and maintained for users without IAM. They are not available to IAM-enabled users. We strongly encourage you to migrate to IAM now and use the more flexible tokens described above. + +Once you have logged into Logs Data Platform you will have access to the token generation function from the Configuration panel. + +![Token Menu](images/token_menu.png){.thumbnail} + +On this page you will have the possibility to create a token and to remove them. Note that you cannot modify a token. + +![token generation](images/token_generation.png){.thumbnail} + +Once the token is created, you can use its value or remove it: + +![token generated](images/token_generated.png){.thumbnail} ### Using your tokens Using your token is no different than using your credentials. You just have to replace your username with the word **token** and your password with the token (the opposite works too). -For example to issue a search against the Graylog API with the token obtained above, you can do the following: +For example, to issue a search against the Graylog API with the token obtained above, you can do the following: ```shell-session $ curl -u token:kujg9g227qv0123mav3s0q4pra4psqsi5leka6j7lc62qdef58q -XGET "https://.logs.ovh.com/api/search/universal/relative?query=*&range=300&filter=streams:a123aebc12345623aafd" @@ -150,12 +177,11 @@ $ curl -u token:kujg9g227qv0123mav3s0q4pra4psqsi5leka6j7lc62qdef58q "https:// [!api] +> +> @api {v1} /me POST /me/api/oauth2/client +> -![token generated](images/token_generated.png){.thumbnail} +With this API call, you can create OAuth2 credentials for several authentication mechanisms. The one we are interested in here is **CLIENT_CREDENTIALS**. This mechanism does not require a callback URL. -### Generating tokens with API +You must supply the following values: -One goal with token is to automatize APIs call. Sometime you even need to automatize token creation. That's why it is possible to create token by using only the OVHcloud APIs. If you're familiar with the OVHcloud API, it should be fairly straightforward, if you're not, this section will help you with it. Generating tokens is two API calls away. You can use the OVHcloud API console to make theses calls. +- **callbackUrls**: An empty array of callback URLs `[]`. +- **flow**: `CLIENT_CREDENTIALS`. +- **name**: The name you would like to provide to your identifier. +- **description**: A description of your identifier. We recommend describing how you will use this identifier. If you audit your access in the future, it is easier to link it to your application name, so that you can easily find out where the identifier is deployed (and what the impact will be if you change your access). -First you will have to retrieve the serviceName you want to generate token for. The API call to get your serviceName is the following: +In response, the API will provide you with two pieces of information: -> [!api] -> -> @api {v1} /dbaas/logs GET /dbaas/logs -> +- **clientId**: Your service account ID. +- **clientSecret**: A token allowing you to authenticate yourself on our APIs. This information must be stored securely. With these two credentials, you can log in to this service account and get the rights associated with it. Save this value. It will not be possible to retrieve it at a later stage. -If you want to know what is the Logs Data Platform username associated with this serviceName, use the following call: +In order to retrieve an API token, you can use the following HTTP call with these two pieces of information: -> [!api] -> -> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName} -> +```bash +curl --request POST \ + --url 'https://www.ovh.com/auth/oauth2/token' \ + --header 'content-type: application/x-www-form-urlencoded' \ + --data grant_type=client_credentials \ + --data client_id=0f0f0f0f0f0f0f0f \ + --data client_secret=xxxxx \ + --data scope=all +``` -This call returns the service object of the connected identity. +Depending on the location of your API, you will need to use the following URL: -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) +- **EU API**: `https://www.ovh.com/auth/oauth2/token`. +- **CA API**: `https://ca.ovh.com/auth/oauth2/token`. -Once you have the login you want, use the following call to add a new token: +Following this API call, you will receive a response in the following format: -> [!api] -> -> @api {v1} /dbaas/logs POST /dbaas/logs/{serviceName}/token -> +```json +{ + "access_token":"your-api-token", + "token_type":"Bearer", + "expires_in":3599, + "scope":"all" +} +``` -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> - `name`: The name of your token (string) -> +Save the token in the **access_token** field. You will need it to authenticate your API calls. -Please replace **serviceName** with your serviceName, and replace **name** by the name of your choice for your token. This call will give you a taskId. After a few seconds you can retrieve your **tokenId** with this call: +This access token can then be used to interact with Logs Data Platform backend APIs. Don't forget to manage access rights of your service account with the [IAM policies](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). -> [!api] -> -> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName}/token -> +```bash +ldp@laptop curl -H 'content-type: application/json' --oauth2-bearer -XPUT 'https://.logs.ovh.com:9200/_cat/indices/ldp-*' +``` -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> +Or with the Bearer header: + +```bash +ldp@laptop curl -H 'content-type: application/json' -H "Authorization: Bearer " -XPUT 'https://.logs.ovh.com:9200/_cat/indices/ldp-*' +``` + +Note that access tokens created through a service account expire after some time. You must regenerate a new one after it has expired. -This will give you back the id of your token. The actual value of the token can be retrieved with this next call: +#### Local Users + +Create a local user by following the [dedicated documentation](/pages/account_and_service_management/account_information/ovhcloud-users-management) and create the right [IAM policies](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). Once created, you can use the OVHcloud API to create a token for this user: > [!api] > -> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName}/token/{tokenId} +> @api {v1} /me POST /me/identity/user/{user}/token > -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> - `tokenId`: UUID of your token (string) +This call will return a bearer access token for your local user. -Here is the final response you will get. +You can then use this token on Logs Data Platform backend APIs: -```json -{ - "updatedAt": "2016-12-01T12:30:26.566986+00:00", - "createdAt": "2016-12-01T12:30:26.566939+00:00", - "value": "kujg9g227qv0123mav3s0q4pra4psqsi5leka6j7lc62qdef58q", - "name": "token_name", - "tokenId": "XXXXXXXXXXXXXXXXXXXXXXXXXXX" -} +```bash +ldp@laptop curl -H 'content-type: application/json' --oauth2-bearer -XPUT 'https://.logs.ovh.com/api/search/universal/relative?query=*&range=300&filter=streams:a123aebc12345623aafd' ``` -The token value is the value field. That is the field you will need to use the Logs Data Platform Search APIs. +Or with the Bearer header + +```bash +ldp@laptop curl -H 'content-type: application/json' -H "Authorization: Bearer " -XPUT 'https://.logs.ovh.com/api/search/universal/relative?query=*&range=300&filter=streams:a123aebc12345623aafd' +``` -Finally to delete your token, use the following call: +These tokens do not expire but can be deleted whenever needed with this call: > [!api] > -> @api {v1} /dbaas/logs DELETE /dbaas/logs/{serviceName}/token/{tokenId} +> @api {v1} /me DELETE /me/identity/user/{user}/token/{name} > -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> - `tokenId`: UUID of your token (string) -> +#### Hybrid authentication + +For software that does not support the Bearer authentication scheme, we provide a hybrid authentication mode based on the Basic authentication scheme. Use a username that starts with **pat_jwt_** and supply the token value as the password. + +```bash +ldp@laptop curl -H 'content-type: application/json' \\ + -u pat_jwt_: \\ + -XPUT 'https://.logs.ovh.com:9200/_cat/indices/ldp-*' +``` + +### Legacy tokens + +Legacy tokens are still working and maintained for users without IAM. They are not available to IAM-enabled users. We strongly encourage you to migrate to IAM now and use the more flexible tokens described above. + +Once you have logged into Logs Data Platform you will have access to the token generation function from the Configuration panel. + +![Token Menu](images/token_menu.png){.thumbnail} + +On this page you will have the possibility to create a token and to remove them. Note that you cannot modify a token. + +![token generation](images/token_generation.png){.thumbnail} + +Once the token is created, you can use its value or remove it: + +![token generated](images/token_generated.png){.thumbnail} ### Using your tokens -Using your token is no different of using your credentials. You just have to replace your username with the word **token** and your password with the token (the opposite works too). -For example to issue a search against the Graylog API with the token obtained above, you can do the following: +Using your token is no different than using your credentials. You just have to replace your username with the word **token** and your password with the token (the opposite works too). +For example, to issue a search against the Graylog API with the token obtained above, you can do the following: ```shell-session $ curl -u token:kujg9g227qv0123mav3s0q4pra4psqsi5leka6j7lc62qdef58q -XGET "https://.logs.ovh.com/api/search/universal/relative?query=*&range=300&filter=streams:a123aebc12345623aafd" @@ -148,13 +175,13 @@ To issue a search against the OpenSearch API, you also use the same credentials. $ curl -u token:kujg9g227qv0123mav3s0q4pra4psqsi5leka6j7lc62qdef58q "https://.logs.ovh.com:9200/your_alias/_search?pretty" ``` -This call will launch a quick search (to retrieve the count and a sample of your documents) against the alias **your_alias**. Replace the alias by the one you have setup in you Logs Data Platform console. Note that these credentials are usable in place of your account credentials in Grafana (or any tool that supports Basic Authentication with OpenSearch). +This call will launch a quick search (to retrieve the count and a sample of your documents) against the alias **your_alias**. Replace the alias by the one you have set up in your Logs Data Platform console. Note that these credentials are usable in place of your account credentials in Grafana (or any tool that supports Basic Authentication with OpenSearch). -The only place you cannot use your token is the Graylog Web Interface. +The Graylog Web Interface does not support token authentication. ## Go further - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.en-sg.md b/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.en-sg.md index 986e2a548b8..d403fc4f392 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.en-sg.md +++ b/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.en-sg.md @@ -1,133 +1,160 @@ --- title: Securing Logs Data Platform's APIs with tokens -excerpt: If you want to give access to your logs to a software or automatize some tasks depending on your logs. You will maybe need to access them through the API. The most secure way to do this is to use tokens. -updated: 2023-06-02 +excerpt: If you want to give access to your logs to a software application or automate tasks that depend on your logs, you may need to access them through the API. +updated: 2025-10-16 --- ## Objective -With Logs Data Platform, there are 3 ways to query your logs. +With Logs Data Platform, there are 3 ways to query your logs: - The [Graylog Web Interface](https://gra1.logs.ovh.com) - The [Graylog API](https://gra1.logs.ovh.com/api/api-browser/global/index.html#!/search47universal47relative/searchRelative) -- The [OpenSearch API](https://opensearch.org/docs/latest/opensearch/query-dsl/index/) located at the port 9200 of your cluster (find its address in the **Home** Page) against your [alias](/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards). +- The [OpenSearch API](https://opensearch.org/docs/latest/opensearch/query-dsl/index/) located on port 9200 of your cluster (find its address in the **Home** Page) against your [alias](/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards). -So you can pop up a [Grafana](/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana) or even [a terminal Dashboard for Graylog](https://github.com/Graylog2/cli-dashboard). +So you open a [Grafana](/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana) or even [a terminal Dashboard for Graylog](https://github.com/Graylog2/cli-dashboard). All these accesses are secured by your username and password. But what if you don't want to put your Logs Data Platform credentials everywhere? You can just use tokens to access all these endpoints and revoke them anytime you want. This tutorial is here to tell you how. ## Requirements -- No specific requirements +- A service with IAM enabled to use IAM tokens or without IAM to use legacy tokens ## Instructions -### Generating tokens using the manager +### Generating tokens with IAM -Once you have logged into Logs Data Platform you will have to access to the token Generation panel from the Configuration box. +Before generating tokens with IAM you will need to create a [Service Account or a Local User](/pages/manage_and_operate/iam/identities-management). Both have specificities detailed in IAM documentation. Don't forget to attach these new identities to your [IAM Policies](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). -![Token Menu](images/token_menu.png){.thumbnail} +#### Service accounts -On this page you will have the possibility to create a token and to remove them. Note that you cannot modify a token. +Create a service account and tokens by following the [documentation](/pages/manage_and_operate/api/manage-service-account). Service accounts are a identifier/token pair following the OAuth2 **client- credentials** authentication mechanism. If you are familiar with OAuth2 clients, here are the API calls to create them. We still recommend you to read the dedicated guide to understand its specificities. -![token generation](images/token_generation.png){.thumbnail} +To create a service account, use the following API call: -Once the token is created, you can use its value or remove it: +> [!api] +> +> @api {v1} /me POST /me/api/oauth2/client +> -![token generated](images/token_generated.png){.thumbnail} +With this API call, you can create OAuth2 credentials for several authentication mechanisms. The one we are interested in here is **CLIENT_CREDENTIALS**. This mechanism does not require a callback URL. -### Generating tokens with API +You must supply the following values: -One goal with token is to automatize APIs call. Sometime you even need to automatize token creation. That's why it is possible to create token by using only the OVHcloud APIs. If you're familiar with the OVHcloud API, it should be fairly straightforward, if you're not, this section will help you with it. Generating tokens is two API calls away. You can use the OVHcloud API console to make theses calls. +- **callbackUrls**: An empty array of callback URLs `[]`. +- **flow**: `CLIENT_CREDENTIALS`. +- **name**: The name you would like to provide to your identifier. +- **description**: A description of your identifier. We recommend describing how you will use this identifier. If you audit your access in the future, it is easier to link it to your application name, so that you can easily find out where the identifier is deployed (and what the impact will be if you change your access). -First you will have to retrieve the serviceName you want to generate token for. The API call to get your serviceName is the following: +In response, the API will provide you with two pieces of information: -> [!api] -> -> @api {v1} /dbaas/logs GET /dbaas/logs -> +- **clientId**: Your service account ID. +- **clientSecret**: A token allowing you to authenticate yourself on our APIs. This information must be stored securely. With these two credentials, you can log in to this service account and get the rights associated with it. Save this value. It will not be possible to retrieve it at a later stage. -If you want to know what is the Logs Data Platform username associated with this serviceName, use the following call: +In order to retrieve an API token, you can use the following HTTP call with these two pieces of information: -> [!api] -> -> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName} -> +```bash +curl --request POST \ + --url 'https://www.ovh.com/auth/oauth2/token' \ + --header 'content-type: application/x-www-form-urlencoded' \ + --data grant_type=client_credentials \ + --data client_id=0f0f0f0f0f0f0f0f \ + --data client_secret=xxxxx \ + --data scope=all +``` -This call returns the service object of the connected identity. +Depending on the location of your API, you will need to use the following URL: -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) +- **EU API**: `https://www.ovh.com/auth/oauth2/token`. +- **CA API**: `https://ca.ovh.com/auth/oauth2/token`. -Once you have the login you want, use the following call to add a new token: +Following this API call, you will receive a response in the following format: -> [!api] -> -> @api {v1} /dbaas/logs POST /dbaas/logs/{serviceName}/token -> +```json +{ + "access_token":"your-api-token", + "token_type":"Bearer", + "expires_in":3599, + "scope":"all" +} +``` -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> - `name`: The name of your token (string) -> +Save the token in the **access_token** field. You will need it to authenticate your API calls. -Please replace **serviceName** with your serviceName, and replace **name** by the name of your choice for your token. This call will give you a taskId. After a few seconds you can retrieve your **tokenId** with this call: +This access token can then be used to interact with Logs Data Platform backend APIs. Don't forget to manage access rights of your service account with the [IAM policies](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). -> [!api] -> -> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName}/token -> +```bash +ldp@laptop curl -H 'content-type: application/json' --oauth2-bearer -XPUT 'https://.logs.ovh.com:9200/_cat/indices/ldp-*' +``` -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> +Or with the Bearer header: + +```bash +ldp@laptop curl -H 'content-type: application/json' -H "Authorization: Bearer " -XPUT 'https://.logs.ovh.com:9200/_cat/indices/ldp-*' +``` + +Note that access tokens created through a service account expire after some time. You must regenerate a new one after it has expired. -This will give you back the id of your token. The actual value of the token can be retrieved with this next call: +#### Local Users + +Create a local user by following the [dedicated documentation](/pages/account_and_service_management/account_information/ovhcloud-users-management) and create the right [IAM policies](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). Once created, you can use the OVHcloud API to create a token for this user: > [!api] > -> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName}/token/{tokenId} +> @api {v1} /me POST /me/identity/user/{user}/token > -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> - `tokenId`: UUID of your token (string) +This call will return a bearer access token for your local user. -Here is the final response you will get. +You can then use this token on Logs Data Platform backend APIs: -```json -{ - "updatedAt": "2016-12-01T12:30:26.566986+00:00", - "createdAt": "2016-12-01T12:30:26.566939+00:00", - "value": "kujg9g227qv0123mav3s0q4pra4psqsi5leka6j7lc62qdef58q", - "name": "token_name", - "tokenId": "XXXXXXXXXXXXXXXXXXXXXXXXXXX" -} +```bash +ldp@laptop curl -H 'content-type: application/json' --oauth2-bearer -XPUT 'https://.logs.ovh.com/api/search/universal/relative?query=*&range=300&filter=streams:a123aebc12345623aafd' ``` -The token value is the value field. That is the field you will need to use the Logs Data Platform Search APIs. +Or with the Bearer header + +```bash +ldp@laptop curl -H 'content-type: application/json' -H "Authorization: Bearer " -XPUT 'https://.logs.ovh.com/api/search/universal/relative?query=*&range=300&filter=streams:a123aebc12345623aafd' +``` -Finally to delete your token, use the following call: +These tokens do not expire but can be deleted whenever needed with this call: > [!api] > -> @api {v1} /dbaas/logs DELETE /dbaas/logs/{serviceName}/token/{tokenId} +> @api {v1} /me DELETE /me/identity/user/{user}/token/{name} > -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> - `tokenId`: UUID of your token (string) -> +#### Hybrid authentication + +For software that does not support the Bearer authentication scheme, we provide a hybrid authentication mode based on the Basic authentication scheme. Use a username that starts with **pat_jwt_** and supply the token value as the password. + +```bash +ldp@laptop curl -H 'content-type: application/json' \\ + -u pat_jwt_: \\ + -XPUT 'https://.logs.ovh.com:9200/_cat/indices/ldp-*' +``` + +### Legacy tokens + +Legacy tokens are still working and maintained for users without IAM. They are not available to IAM-enabled users. We strongly encourage you to migrate to IAM now and use the more flexible tokens described above. + +Once you have logged into Logs Data Platform you will have access to the token generation function from the Configuration panel. + +![Token Menu](images/token_menu.png){.thumbnail} + +On this page you will have the possibility to create a token and to remove them. Note that you cannot modify a token. + +![token generation](images/token_generation.png){.thumbnail} + +Once the token is created, you can use its value or remove it: + +![token generated](images/token_generated.png){.thumbnail} ### Using your tokens -Using your token is no different of using your credentials. You just have to replace your username with the word **token** and your password with the token (the opposite works too). -For example to issue a search against the Graylog API with the token obtained above, you can do the following: +Using your token is no different than using your credentials. You just have to replace your username with the word **token** and your password with the token (the opposite works too). +For example, to issue a search against the Graylog API with the token obtained above, you can do the following: ```shell-session $ curl -u token:kujg9g227qv0123mav3s0q4pra4psqsi5leka6j7lc62qdef58q -XGET "https://.logs.ovh.com/api/search/universal/relative?query=*&range=300&filter=streams:a123aebc12345623aafd" @@ -148,13 +175,13 @@ To issue a search against the OpenSearch API, you also use the same credentials. $ curl -u token:kujg9g227qv0123mav3s0q4pra4psqsi5leka6j7lc62qdef58q "https://.logs.ovh.com:9200/your_alias/_search?pretty" ``` -This call will launch a quick search (to retrieve the count and a sample of your documents) against the alias **your_alias**. Replace the alias by the one you have setup in you Logs Data Platform console. Note that these credentials are usable in place of your account credentials in Grafana (or any tool that supports Basic Authentication with OpenSearch). +This call will launch a quick search (to retrieve the count and a sample of your documents) against the alias **your_alias**. Replace the alias by the one you have set up in your Logs Data Platform console. Note that these credentials are usable in place of your account credentials in Grafana (or any tool that supports Basic Authentication with OpenSearch). -The only place you cannot use your token is the Graylog Web Interface. +The Graylog Web Interface does not support token authentication. ## Go further - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.en-us.md b/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.en-us.md index 986e2a548b8..d403fc4f392 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.en-us.md +++ b/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.en-us.md @@ -1,133 +1,160 @@ --- title: Securing Logs Data Platform's APIs with tokens -excerpt: If you want to give access to your logs to a software or automatize some tasks depending on your logs. You will maybe need to access them through the API. The most secure way to do this is to use tokens. -updated: 2023-06-02 +excerpt: If you want to give access to your logs to a software application or automate tasks that depend on your logs, you may need to access them through the API. +updated: 2025-10-16 --- ## Objective -With Logs Data Platform, there are 3 ways to query your logs. +With Logs Data Platform, there are 3 ways to query your logs: - The [Graylog Web Interface](https://gra1.logs.ovh.com) - The [Graylog API](https://gra1.logs.ovh.com/api/api-browser/global/index.html#!/search47universal47relative/searchRelative) -- The [OpenSearch API](https://opensearch.org/docs/latest/opensearch/query-dsl/index/) located at the port 9200 of your cluster (find its address in the **Home** Page) against your [alias](/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards). +- The [OpenSearch API](https://opensearch.org/docs/latest/opensearch/query-dsl/index/) located on port 9200 of your cluster (find its address in the **Home** Page) against your [alias](/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards). -So you can pop up a [Grafana](/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana) or even [a terminal Dashboard for Graylog](https://github.com/Graylog2/cli-dashboard). +So you open a [Grafana](/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana) or even [a terminal Dashboard for Graylog](https://github.com/Graylog2/cli-dashboard). All these accesses are secured by your username and password. But what if you don't want to put your Logs Data Platform credentials everywhere? You can just use tokens to access all these endpoints and revoke them anytime you want. This tutorial is here to tell you how. ## Requirements -- No specific requirements +- A service with IAM enabled to use IAM tokens or without IAM to use legacy tokens ## Instructions -### Generating tokens using the manager +### Generating tokens with IAM -Once you have logged into Logs Data Platform you will have to access to the token Generation panel from the Configuration box. +Before generating tokens with IAM you will need to create a [Service Account or a Local User](/pages/manage_and_operate/iam/identities-management). Both have specificities detailed in IAM documentation. Don't forget to attach these new identities to your [IAM Policies](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). -![Token Menu](images/token_menu.png){.thumbnail} +#### Service accounts -On this page you will have the possibility to create a token and to remove them. Note that you cannot modify a token. +Create a service account and tokens by following the [documentation](/pages/manage_and_operate/api/manage-service-account). Service accounts are a identifier/token pair following the OAuth2 **client- credentials** authentication mechanism. If you are familiar with OAuth2 clients, here are the API calls to create them. We still recommend you to read the dedicated guide to understand its specificities. -![token generation](images/token_generation.png){.thumbnail} +To create a service account, use the following API call: -Once the token is created, you can use its value or remove it: +> [!api] +> +> @api {v1} /me POST /me/api/oauth2/client +> -![token generated](images/token_generated.png){.thumbnail} +With this API call, you can create OAuth2 credentials for several authentication mechanisms. The one we are interested in here is **CLIENT_CREDENTIALS**. This mechanism does not require a callback URL. -### Generating tokens with API +You must supply the following values: -One goal with token is to automatize APIs call. Sometime you even need to automatize token creation. That's why it is possible to create token by using only the OVHcloud APIs. If you're familiar with the OVHcloud API, it should be fairly straightforward, if you're not, this section will help you with it. Generating tokens is two API calls away. You can use the OVHcloud API console to make theses calls. +- **callbackUrls**: An empty array of callback URLs `[]`. +- **flow**: `CLIENT_CREDENTIALS`. +- **name**: The name you would like to provide to your identifier. +- **description**: A description of your identifier. We recommend describing how you will use this identifier. If you audit your access in the future, it is easier to link it to your application name, so that you can easily find out where the identifier is deployed (and what the impact will be if you change your access). -First you will have to retrieve the serviceName you want to generate token for. The API call to get your serviceName is the following: +In response, the API will provide you with two pieces of information: -> [!api] -> -> @api {v1} /dbaas/logs GET /dbaas/logs -> +- **clientId**: Your service account ID. +- **clientSecret**: A token allowing you to authenticate yourself on our APIs. This information must be stored securely. With these two credentials, you can log in to this service account and get the rights associated with it. Save this value. It will not be possible to retrieve it at a later stage. -If you want to know what is the Logs Data Platform username associated with this serviceName, use the following call: +In order to retrieve an API token, you can use the following HTTP call with these two pieces of information: -> [!api] -> -> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName} -> +```bash +curl --request POST \ + --url 'https://www.ovh.com/auth/oauth2/token' \ + --header 'content-type: application/x-www-form-urlencoded' \ + --data grant_type=client_credentials \ + --data client_id=0f0f0f0f0f0f0f0f \ + --data client_secret=xxxxx \ + --data scope=all +``` -This call returns the service object of the connected identity. +Depending on the location of your API, you will need to use the following URL: -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) +- **EU API**: `https://www.ovh.com/auth/oauth2/token`. +- **CA API**: `https://ca.ovh.com/auth/oauth2/token`. -Once you have the login you want, use the following call to add a new token: +Following this API call, you will receive a response in the following format: -> [!api] -> -> @api {v1} /dbaas/logs POST /dbaas/logs/{serviceName}/token -> +```json +{ + "access_token":"your-api-token", + "token_type":"Bearer", + "expires_in":3599, + "scope":"all" +} +``` -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> - `name`: The name of your token (string) -> +Save the token in the **access_token** field. You will need it to authenticate your API calls. -Please replace **serviceName** with your serviceName, and replace **name** by the name of your choice for your token. This call will give you a taskId. After a few seconds you can retrieve your **tokenId** with this call: +This access token can then be used to interact with Logs Data Platform backend APIs. Don't forget to manage access rights of your service account with the [IAM policies](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). -> [!api] -> -> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName}/token -> +```bash +ldp@laptop curl -H 'content-type: application/json' --oauth2-bearer -XPUT 'https://.logs.ovh.com:9200/_cat/indices/ldp-*' +``` -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> +Or with the Bearer header: + +```bash +ldp@laptop curl -H 'content-type: application/json' -H "Authorization: Bearer " -XPUT 'https://.logs.ovh.com:9200/_cat/indices/ldp-*' +``` + +Note that access tokens created through a service account expire after some time. You must regenerate a new one after it has expired. -This will give you back the id of your token. The actual value of the token can be retrieved with this next call: +#### Local Users + +Create a local user by following the [dedicated documentation](/pages/account_and_service_management/account_information/ovhcloud-users-management) and create the right [IAM policies](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). Once created, you can use the OVHcloud API to create a token for this user: > [!api] > -> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName}/token/{tokenId} +> @api {v1} /me POST /me/identity/user/{user}/token > -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> - `tokenId`: UUID of your token (string) +This call will return a bearer access token for your local user. -Here is the final response you will get. +You can then use this token on Logs Data Platform backend APIs: -```json -{ - "updatedAt": "2016-12-01T12:30:26.566986+00:00", - "createdAt": "2016-12-01T12:30:26.566939+00:00", - "value": "kujg9g227qv0123mav3s0q4pra4psqsi5leka6j7lc62qdef58q", - "name": "token_name", - "tokenId": "XXXXXXXXXXXXXXXXXXXXXXXXXXX" -} +```bash +ldp@laptop curl -H 'content-type: application/json' --oauth2-bearer -XPUT 'https://.logs.ovh.com/api/search/universal/relative?query=*&range=300&filter=streams:a123aebc12345623aafd' ``` -The token value is the value field. That is the field you will need to use the Logs Data Platform Search APIs. +Or with the Bearer header + +```bash +ldp@laptop curl -H 'content-type: application/json' -H "Authorization: Bearer " -XPUT 'https://.logs.ovh.com/api/search/universal/relative?query=*&range=300&filter=streams:a123aebc12345623aafd' +``` -Finally to delete your token, use the following call: +These tokens do not expire but can be deleted whenever needed with this call: > [!api] > -> @api {v1} /dbaas/logs DELETE /dbaas/logs/{serviceName}/token/{tokenId} +> @api {v1} /me DELETE /me/identity/user/{user}/token/{name} > -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> - `tokenId`: UUID of your token (string) -> +#### Hybrid authentication + +For software that does not support the Bearer authentication scheme, we provide a hybrid authentication mode based on the Basic authentication scheme. Use a username that starts with **pat_jwt_** and supply the token value as the password. + +```bash +ldp@laptop curl -H 'content-type: application/json' \\ + -u pat_jwt_: \\ + -XPUT 'https://.logs.ovh.com:9200/_cat/indices/ldp-*' +``` + +### Legacy tokens + +Legacy tokens are still working and maintained for users without IAM. They are not available to IAM-enabled users. We strongly encourage you to migrate to IAM now and use the more flexible tokens described above. + +Once you have logged into Logs Data Platform you will have access to the token generation function from the Configuration panel. + +![Token Menu](images/token_menu.png){.thumbnail} + +On this page you will have the possibility to create a token and to remove them. Note that you cannot modify a token. + +![token generation](images/token_generation.png){.thumbnail} + +Once the token is created, you can use its value or remove it: + +![token generated](images/token_generated.png){.thumbnail} ### Using your tokens -Using your token is no different of using your credentials. You just have to replace your username with the word **token** and your password with the token (the opposite works too). -For example to issue a search against the Graylog API with the token obtained above, you can do the following: +Using your token is no different than using your credentials. You just have to replace your username with the word **token** and your password with the token (the opposite works too). +For example, to issue a search against the Graylog API with the token obtained above, you can do the following: ```shell-session $ curl -u token:kujg9g227qv0123mav3s0q4pra4psqsi5leka6j7lc62qdef58q -XGET "https://.logs.ovh.com/api/search/universal/relative?query=*&range=300&filter=streams:a123aebc12345623aafd" @@ -148,13 +175,13 @@ To issue a search against the OpenSearch API, you also use the same credentials. $ curl -u token:kujg9g227qv0123mav3s0q4pra4psqsi5leka6j7lc62qdef58q "https://.logs.ovh.com:9200/your_alias/_search?pretty" ``` -This call will launch a quick search (to retrieve the count and a sample of your documents) against the alias **your_alias**. Replace the alias by the one you have setup in you Logs Data Platform console. Note that these credentials are usable in place of your account credentials in Grafana (or any tool that supports Basic Authentication with OpenSearch). +This call will launch a quick search (to retrieve the count and a sample of your documents) against the alias **your_alias**. Replace the alias by the one you have set up in your Logs Data Platform console. Note that these credentials are usable in place of your account credentials in Grafana (or any tool that supports Basic Authentication with OpenSearch). -The only place you cannot use your token is the Graylog Web Interface. +The Graylog Web Interface does not support token authentication. ## Go further - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.es-es.md b/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.es-es.md index 986e2a548b8..d403fc4f392 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.es-es.md +++ b/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.es-es.md @@ -1,133 +1,160 @@ --- title: Securing Logs Data Platform's APIs with tokens -excerpt: If you want to give access to your logs to a software or automatize some tasks depending on your logs. You will maybe need to access them through the API. The most secure way to do this is to use tokens. -updated: 2023-06-02 +excerpt: If you want to give access to your logs to a software application or automate tasks that depend on your logs, you may need to access them through the API. +updated: 2025-10-16 --- ## Objective -With Logs Data Platform, there are 3 ways to query your logs. +With Logs Data Platform, there are 3 ways to query your logs: - The [Graylog Web Interface](https://gra1.logs.ovh.com) - The [Graylog API](https://gra1.logs.ovh.com/api/api-browser/global/index.html#!/search47universal47relative/searchRelative) -- The [OpenSearch API](https://opensearch.org/docs/latest/opensearch/query-dsl/index/) located at the port 9200 of your cluster (find its address in the **Home** Page) against your [alias](/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards). +- The [OpenSearch API](https://opensearch.org/docs/latest/opensearch/query-dsl/index/) located on port 9200 of your cluster (find its address in the **Home** Page) against your [alias](/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards). -So you can pop up a [Grafana](/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana) or even [a terminal Dashboard for Graylog](https://github.com/Graylog2/cli-dashboard). +So you open a [Grafana](/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana) or even [a terminal Dashboard for Graylog](https://github.com/Graylog2/cli-dashboard). All these accesses are secured by your username and password. But what if you don't want to put your Logs Data Platform credentials everywhere? You can just use tokens to access all these endpoints and revoke them anytime you want. This tutorial is here to tell you how. ## Requirements -- No specific requirements +- A service with IAM enabled to use IAM tokens or without IAM to use legacy tokens ## Instructions -### Generating tokens using the manager +### Generating tokens with IAM -Once you have logged into Logs Data Platform you will have to access to the token Generation panel from the Configuration box. +Before generating tokens with IAM you will need to create a [Service Account or a Local User](/pages/manage_and_operate/iam/identities-management). Both have specificities detailed in IAM documentation. Don't forget to attach these new identities to your [IAM Policies](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). -![Token Menu](images/token_menu.png){.thumbnail} +#### Service accounts -On this page you will have the possibility to create a token and to remove them. Note that you cannot modify a token. +Create a service account and tokens by following the [documentation](/pages/manage_and_operate/api/manage-service-account). Service accounts are a identifier/token pair following the OAuth2 **client- credentials** authentication mechanism. If you are familiar with OAuth2 clients, here are the API calls to create them. We still recommend you to read the dedicated guide to understand its specificities. -![token generation](images/token_generation.png){.thumbnail} +To create a service account, use the following API call: -Once the token is created, you can use its value or remove it: +> [!api] +> +> @api {v1} /me POST /me/api/oauth2/client +> -![token generated](images/token_generated.png){.thumbnail} +With this API call, you can create OAuth2 credentials for several authentication mechanisms. The one we are interested in here is **CLIENT_CREDENTIALS**. This mechanism does not require a callback URL. -### Generating tokens with API +You must supply the following values: -One goal with token is to automatize APIs call. Sometime you even need to automatize token creation. That's why it is possible to create token by using only the OVHcloud APIs. If you're familiar with the OVHcloud API, it should be fairly straightforward, if you're not, this section will help you with it. Generating tokens is two API calls away. You can use the OVHcloud API console to make theses calls. +- **callbackUrls**: An empty array of callback URLs `[]`. +- **flow**: `CLIENT_CREDENTIALS`. +- **name**: The name you would like to provide to your identifier. +- **description**: A description of your identifier. We recommend describing how you will use this identifier. If you audit your access in the future, it is easier to link it to your application name, so that you can easily find out where the identifier is deployed (and what the impact will be if you change your access). -First you will have to retrieve the serviceName you want to generate token for. The API call to get your serviceName is the following: +In response, the API will provide you with two pieces of information: -> [!api] -> -> @api {v1} /dbaas/logs GET /dbaas/logs -> +- **clientId**: Your service account ID. +- **clientSecret**: A token allowing you to authenticate yourself on our APIs. This information must be stored securely. With these two credentials, you can log in to this service account and get the rights associated with it. Save this value. It will not be possible to retrieve it at a later stage. -If you want to know what is the Logs Data Platform username associated with this serviceName, use the following call: +In order to retrieve an API token, you can use the following HTTP call with these two pieces of information: -> [!api] -> -> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName} -> +```bash +curl --request POST \ + --url 'https://www.ovh.com/auth/oauth2/token' \ + --header 'content-type: application/x-www-form-urlencoded' \ + --data grant_type=client_credentials \ + --data client_id=0f0f0f0f0f0f0f0f \ + --data client_secret=xxxxx \ + --data scope=all +``` -This call returns the service object of the connected identity. +Depending on the location of your API, you will need to use the following URL: -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) +- **EU API**: `https://www.ovh.com/auth/oauth2/token`. +- **CA API**: `https://ca.ovh.com/auth/oauth2/token`. -Once you have the login you want, use the following call to add a new token: +Following this API call, you will receive a response in the following format: -> [!api] -> -> @api {v1} /dbaas/logs POST /dbaas/logs/{serviceName}/token -> +```json +{ + "access_token":"your-api-token", + "token_type":"Bearer", + "expires_in":3599, + "scope":"all" +} +``` -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> - `name`: The name of your token (string) -> +Save the token in the **access_token** field. You will need it to authenticate your API calls. -Please replace **serviceName** with your serviceName, and replace **name** by the name of your choice for your token. This call will give you a taskId. After a few seconds you can retrieve your **tokenId** with this call: +This access token can then be used to interact with Logs Data Platform backend APIs. Don't forget to manage access rights of your service account with the [IAM policies](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). -> [!api] -> -> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName}/token -> +```bash +ldp@laptop curl -H 'content-type: application/json' --oauth2-bearer -XPUT 'https://.logs.ovh.com:9200/_cat/indices/ldp-*' +``` -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> +Or with the Bearer header: + +```bash +ldp@laptop curl -H 'content-type: application/json' -H "Authorization: Bearer " -XPUT 'https://.logs.ovh.com:9200/_cat/indices/ldp-*' +``` + +Note that access tokens created through a service account expire after some time. You must regenerate a new one after it has expired. -This will give you back the id of your token. The actual value of the token can be retrieved with this next call: +#### Local Users + +Create a local user by following the [dedicated documentation](/pages/account_and_service_management/account_information/ovhcloud-users-management) and create the right [IAM policies](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). Once created, you can use the OVHcloud API to create a token for this user: > [!api] > -> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName}/token/{tokenId} +> @api {v1} /me POST /me/identity/user/{user}/token > -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> - `tokenId`: UUID of your token (string) +This call will return a bearer access token for your local user. -Here is the final response you will get. +You can then use this token on Logs Data Platform backend APIs: -```json -{ - "updatedAt": "2016-12-01T12:30:26.566986+00:00", - "createdAt": "2016-12-01T12:30:26.566939+00:00", - "value": "kujg9g227qv0123mav3s0q4pra4psqsi5leka6j7lc62qdef58q", - "name": "token_name", - "tokenId": "XXXXXXXXXXXXXXXXXXXXXXXXXXX" -} +```bash +ldp@laptop curl -H 'content-type: application/json' --oauth2-bearer -XPUT 'https://.logs.ovh.com/api/search/universal/relative?query=*&range=300&filter=streams:a123aebc12345623aafd' ``` -The token value is the value field. That is the field you will need to use the Logs Data Platform Search APIs. +Or with the Bearer header + +```bash +ldp@laptop curl -H 'content-type: application/json' -H "Authorization: Bearer " -XPUT 'https://.logs.ovh.com/api/search/universal/relative?query=*&range=300&filter=streams:a123aebc12345623aafd' +``` -Finally to delete your token, use the following call: +These tokens do not expire but can be deleted whenever needed with this call: > [!api] > -> @api {v1} /dbaas/logs DELETE /dbaas/logs/{serviceName}/token/{tokenId} +> @api {v1} /me DELETE /me/identity/user/{user}/token/{name} > -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> - `tokenId`: UUID of your token (string) -> +#### Hybrid authentication + +For software that does not support the Bearer authentication scheme, we provide a hybrid authentication mode based on the Basic authentication scheme. Use a username that starts with **pat_jwt_** and supply the token value as the password. + +```bash +ldp@laptop curl -H 'content-type: application/json' \\ + -u pat_jwt_: \\ + -XPUT 'https://.logs.ovh.com:9200/_cat/indices/ldp-*' +``` + +### Legacy tokens + +Legacy tokens are still working and maintained for users without IAM. They are not available to IAM-enabled users. We strongly encourage you to migrate to IAM now and use the more flexible tokens described above. + +Once you have logged into Logs Data Platform you will have access to the token generation function from the Configuration panel. + +![Token Menu](images/token_menu.png){.thumbnail} + +On this page you will have the possibility to create a token and to remove them. Note that you cannot modify a token. + +![token generation](images/token_generation.png){.thumbnail} + +Once the token is created, you can use its value or remove it: + +![token generated](images/token_generated.png){.thumbnail} ### Using your tokens -Using your token is no different of using your credentials. You just have to replace your username with the word **token** and your password with the token (the opposite works too). -For example to issue a search against the Graylog API with the token obtained above, you can do the following: +Using your token is no different than using your credentials. You just have to replace your username with the word **token** and your password with the token (the opposite works too). +For example, to issue a search against the Graylog API with the token obtained above, you can do the following: ```shell-session $ curl -u token:kujg9g227qv0123mav3s0q4pra4psqsi5leka6j7lc62qdef58q -XGET "https://.logs.ovh.com/api/search/universal/relative?query=*&range=300&filter=streams:a123aebc12345623aafd" @@ -148,13 +175,13 @@ To issue a search against the OpenSearch API, you also use the same credentials. $ curl -u token:kujg9g227qv0123mav3s0q4pra4psqsi5leka6j7lc62qdef58q "https://.logs.ovh.com:9200/your_alias/_search?pretty" ``` -This call will launch a quick search (to retrieve the count and a sample of your documents) against the alias **your_alias**. Replace the alias by the one you have setup in you Logs Data Platform console. Note that these credentials are usable in place of your account credentials in Grafana (or any tool that supports Basic Authentication with OpenSearch). +This call will launch a quick search (to retrieve the count and a sample of your documents) against the alias **your_alias**. Replace the alias by the one you have set up in your Logs Data Platform console. Note that these credentials are usable in place of your account credentials in Grafana (or any tool that supports Basic Authentication with OpenSearch). -The only place you cannot use your token is the Graylog Web Interface. +The Graylog Web Interface does not support token authentication. ## Go further - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.es-us.md b/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.es-us.md index 986e2a548b8..d403fc4f392 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.es-us.md +++ b/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.es-us.md @@ -1,133 +1,160 @@ --- title: Securing Logs Data Platform's APIs with tokens -excerpt: If you want to give access to your logs to a software or automatize some tasks depending on your logs. You will maybe need to access them through the API. The most secure way to do this is to use tokens. -updated: 2023-06-02 +excerpt: If you want to give access to your logs to a software application or automate tasks that depend on your logs, you may need to access them through the API. +updated: 2025-10-16 --- ## Objective -With Logs Data Platform, there are 3 ways to query your logs. +With Logs Data Platform, there are 3 ways to query your logs: - The [Graylog Web Interface](https://gra1.logs.ovh.com) - The [Graylog API](https://gra1.logs.ovh.com/api/api-browser/global/index.html#!/search47universal47relative/searchRelative) -- The [OpenSearch API](https://opensearch.org/docs/latest/opensearch/query-dsl/index/) located at the port 9200 of your cluster (find its address in the **Home** Page) against your [alias](/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards). +- The [OpenSearch API](https://opensearch.org/docs/latest/opensearch/query-dsl/index/) located on port 9200 of your cluster (find its address in the **Home** Page) against your [alias](/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards). -So you can pop up a [Grafana](/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana) or even [a terminal Dashboard for Graylog](https://github.com/Graylog2/cli-dashboard). +So you open a [Grafana](/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana) or even [a terminal Dashboard for Graylog](https://github.com/Graylog2/cli-dashboard). All these accesses are secured by your username and password. But what if you don't want to put your Logs Data Platform credentials everywhere? You can just use tokens to access all these endpoints and revoke them anytime you want. This tutorial is here to tell you how. ## Requirements -- No specific requirements +- A service with IAM enabled to use IAM tokens or without IAM to use legacy tokens ## Instructions -### Generating tokens using the manager +### Generating tokens with IAM -Once you have logged into Logs Data Platform you will have to access to the token Generation panel from the Configuration box. +Before generating tokens with IAM you will need to create a [Service Account or a Local User](/pages/manage_and_operate/iam/identities-management). Both have specificities detailed in IAM documentation. Don't forget to attach these new identities to your [IAM Policies](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). -![Token Menu](images/token_menu.png){.thumbnail} +#### Service accounts -On this page you will have the possibility to create a token and to remove them. Note that you cannot modify a token. +Create a service account and tokens by following the [documentation](/pages/manage_and_operate/api/manage-service-account). Service accounts are a identifier/token pair following the OAuth2 **client- credentials** authentication mechanism. If you are familiar with OAuth2 clients, here are the API calls to create them. We still recommend you to read the dedicated guide to understand its specificities. -![token generation](images/token_generation.png){.thumbnail} +To create a service account, use the following API call: -Once the token is created, you can use its value or remove it: +> [!api] +> +> @api {v1} /me POST /me/api/oauth2/client +> -![token generated](images/token_generated.png){.thumbnail} +With this API call, you can create OAuth2 credentials for several authentication mechanisms. The one we are interested in here is **CLIENT_CREDENTIALS**. This mechanism does not require a callback URL. -### Generating tokens with API +You must supply the following values: -One goal with token is to automatize APIs call. Sometime you even need to automatize token creation. That's why it is possible to create token by using only the OVHcloud APIs. If you're familiar with the OVHcloud API, it should be fairly straightforward, if you're not, this section will help you with it. Generating tokens is two API calls away. You can use the OVHcloud API console to make theses calls. +- **callbackUrls**: An empty array of callback URLs `[]`. +- **flow**: `CLIENT_CREDENTIALS`. +- **name**: The name you would like to provide to your identifier. +- **description**: A description of your identifier. We recommend describing how you will use this identifier. If you audit your access in the future, it is easier to link it to your application name, so that you can easily find out where the identifier is deployed (and what the impact will be if you change your access). -First you will have to retrieve the serviceName you want to generate token for. The API call to get your serviceName is the following: +In response, the API will provide you with two pieces of information: -> [!api] -> -> @api {v1} /dbaas/logs GET /dbaas/logs -> +- **clientId**: Your service account ID. +- **clientSecret**: A token allowing you to authenticate yourself on our APIs. This information must be stored securely. With these two credentials, you can log in to this service account and get the rights associated with it. Save this value. It will not be possible to retrieve it at a later stage. -If you want to know what is the Logs Data Platform username associated with this serviceName, use the following call: +In order to retrieve an API token, you can use the following HTTP call with these two pieces of information: -> [!api] -> -> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName} -> +```bash +curl --request POST \ + --url 'https://www.ovh.com/auth/oauth2/token' \ + --header 'content-type: application/x-www-form-urlencoded' \ + --data grant_type=client_credentials \ + --data client_id=0f0f0f0f0f0f0f0f \ + --data client_secret=xxxxx \ + --data scope=all +``` -This call returns the service object of the connected identity. +Depending on the location of your API, you will need to use the following URL: -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) +- **EU API**: `https://www.ovh.com/auth/oauth2/token`. +- **CA API**: `https://ca.ovh.com/auth/oauth2/token`. -Once you have the login you want, use the following call to add a new token: +Following this API call, you will receive a response in the following format: -> [!api] -> -> @api {v1} /dbaas/logs POST /dbaas/logs/{serviceName}/token -> +```json +{ + "access_token":"your-api-token", + "token_type":"Bearer", + "expires_in":3599, + "scope":"all" +} +``` -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> - `name`: The name of your token (string) -> +Save the token in the **access_token** field. You will need it to authenticate your API calls. -Please replace **serviceName** with your serviceName, and replace **name** by the name of your choice for your token. This call will give you a taskId. After a few seconds you can retrieve your **tokenId** with this call: +This access token can then be used to interact with Logs Data Platform backend APIs. Don't forget to manage access rights of your service account with the [IAM policies](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). -> [!api] -> -> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName}/token -> +```bash +ldp@laptop curl -H 'content-type: application/json' --oauth2-bearer -XPUT 'https://.logs.ovh.com:9200/_cat/indices/ldp-*' +``` -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> +Or with the Bearer header: + +```bash +ldp@laptop curl -H 'content-type: application/json' -H "Authorization: Bearer " -XPUT 'https://.logs.ovh.com:9200/_cat/indices/ldp-*' +``` + +Note that access tokens created through a service account expire after some time. You must regenerate a new one after it has expired. -This will give you back the id of your token. The actual value of the token can be retrieved with this next call: +#### Local Users + +Create a local user by following the [dedicated documentation](/pages/account_and_service_management/account_information/ovhcloud-users-management) and create the right [IAM policies](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). Once created, you can use the OVHcloud API to create a token for this user: > [!api] > -> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName}/token/{tokenId} +> @api {v1} /me POST /me/identity/user/{user}/token > -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> - `tokenId`: UUID of your token (string) +This call will return a bearer access token for your local user. -Here is the final response you will get. +You can then use this token on Logs Data Platform backend APIs: -```json -{ - "updatedAt": "2016-12-01T12:30:26.566986+00:00", - "createdAt": "2016-12-01T12:30:26.566939+00:00", - "value": "kujg9g227qv0123mav3s0q4pra4psqsi5leka6j7lc62qdef58q", - "name": "token_name", - "tokenId": "XXXXXXXXXXXXXXXXXXXXXXXXXXX" -} +```bash +ldp@laptop curl -H 'content-type: application/json' --oauth2-bearer -XPUT 'https://.logs.ovh.com/api/search/universal/relative?query=*&range=300&filter=streams:a123aebc12345623aafd' ``` -The token value is the value field. That is the field you will need to use the Logs Data Platform Search APIs. +Or with the Bearer header + +```bash +ldp@laptop curl -H 'content-type: application/json' -H "Authorization: Bearer " -XPUT 'https://.logs.ovh.com/api/search/universal/relative?query=*&range=300&filter=streams:a123aebc12345623aafd' +``` -Finally to delete your token, use the following call: +These tokens do not expire but can be deleted whenever needed with this call: > [!api] > -> @api {v1} /dbaas/logs DELETE /dbaas/logs/{serviceName}/token/{tokenId} +> @api {v1} /me DELETE /me/identity/user/{user}/token/{name} > -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> - `tokenId`: UUID of your token (string) -> +#### Hybrid authentication + +For software that does not support the Bearer authentication scheme, we provide a hybrid authentication mode based on the Basic authentication scheme. Use a username that starts with **pat_jwt_** and supply the token value as the password. + +```bash +ldp@laptop curl -H 'content-type: application/json' \\ + -u pat_jwt_: \\ + -XPUT 'https://.logs.ovh.com:9200/_cat/indices/ldp-*' +``` + +### Legacy tokens + +Legacy tokens are still working and maintained for users without IAM. They are not available to IAM-enabled users. We strongly encourage you to migrate to IAM now and use the more flexible tokens described above. + +Once you have logged into Logs Data Platform you will have access to the token generation function from the Configuration panel. + +![Token Menu](images/token_menu.png){.thumbnail} + +On this page you will have the possibility to create a token and to remove them. Note that you cannot modify a token. + +![token generation](images/token_generation.png){.thumbnail} + +Once the token is created, you can use its value or remove it: + +![token generated](images/token_generated.png){.thumbnail} ### Using your tokens -Using your token is no different of using your credentials. You just have to replace your username with the word **token** and your password with the token (the opposite works too). -For example to issue a search against the Graylog API with the token obtained above, you can do the following: +Using your token is no different than using your credentials. You just have to replace your username with the word **token** and your password with the token (the opposite works too). +For example, to issue a search against the Graylog API with the token obtained above, you can do the following: ```shell-session $ curl -u token:kujg9g227qv0123mav3s0q4pra4psqsi5leka6j7lc62qdef58q -XGET "https://.logs.ovh.com/api/search/universal/relative?query=*&range=300&filter=streams:a123aebc12345623aafd" @@ -148,13 +175,13 @@ To issue a search against the OpenSearch API, you also use the same credentials. $ curl -u token:kujg9g227qv0123mav3s0q4pra4psqsi5leka6j7lc62qdef58q "https://.logs.ovh.com:9200/your_alias/_search?pretty" ``` -This call will launch a quick search (to retrieve the count and a sample of your documents) against the alias **your_alias**. Replace the alias by the one you have setup in you Logs Data Platform console. Note that these credentials are usable in place of your account credentials in Grafana (or any tool that supports Basic Authentication with OpenSearch). +This call will launch a quick search (to retrieve the count and a sample of your documents) against the alias **your_alias**. Replace the alias by the one you have set up in your Logs Data Platform console. Note that these credentials are usable in place of your account credentials in Grafana (or any tool that supports Basic Authentication with OpenSearch). -The only place you cannot use your token is the Graylog Web Interface. +The Graylog Web Interface does not support token authentication. ## Go further - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.fr-ca.md b/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.fr-ca.md index 986e2a548b8..d403fc4f392 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.fr-ca.md +++ b/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.fr-ca.md @@ -1,133 +1,160 @@ --- title: Securing Logs Data Platform's APIs with tokens -excerpt: If you want to give access to your logs to a software or automatize some tasks depending on your logs. You will maybe need to access them through the API. The most secure way to do this is to use tokens. -updated: 2023-06-02 +excerpt: If you want to give access to your logs to a software application or automate tasks that depend on your logs, you may need to access them through the API. +updated: 2025-10-16 --- ## Objective -With Logs Data Platform, there are 3 ways to query your logs. +With Logs Data Platform, there are 3 ways to query your logs: - The [Graylog Web Interface](https://gra1.logs.ovh.com) - The [Graylog API](https://gra1.logs.ovh.com/api/api-browser/global/index.html#!/search47universal47relative/searchRelative) -- The [OpenSearch API](https://opensearch.org/docs/latest/opensearch/query-dsl/index/) located at the port 9200 of your cluster (find its address in the **Home** Page) against your [alias](/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards). +- The [OpenSearch API](https://opensearch.org/docs/latest/opensearch/query-dsl/index/) located on port 9200 of your cluster (find its address in the **Home** Page) against your [alias](/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards). -So you can pop up a [Grafana](/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana) or even [a terminal Dashboard for Graylog](https://github.com/Graylog2/cli-dashboard). +So you open a [Grafana](/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana) or even [a terminal Dashboard for Graylog](https://github.com/Graylog2/cli-dashboard). All these accesses are secured by your username and password. But what if you don't want to put your Logs Data Platform credentials everywhere? You can just use tokens to access all these endpoints and revoke them anytime you want. This tutorial is here to tell you how. ## Requirements -- No specific requirements +- A service with IAM enabled to use IAM tokens or without IAM to use legacy tokens ## Instructions -### Generating tokens using the manager +### Generating tokens with IAM -Once you have logged into Logs Data Platform you will have to access to the token Generation panel from the Configuration box. +Before generating tokens with IAM you will need to create a [Service Account or a Local User](/pages/manage_and_operate/iam/identities-management). Both have specificities detailed in IAM documentation. Don't forget to attach these new identities to your [IAM Policies](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). -![Token Menu](images/token_menu.png){.thumbnail} +#### Service accounts -On this page you will have the possibility to create a token and to remove them. Note that you cannot modify a token. +Create a service account and tokens by following the [documentation](/pages/manage_and_operate/api/manage-service-account). Service accounts are a identifier/token pair following the OAuth2 **client- credentials** authentication mechanism. If you are familiar with OAuth2 clients, here are the API calls to create them. We still recommend you to read the dedicated guide to understand its specificities. -![token generation](images/token_generation.png){.thumbnail} +To create a service account, use the following API call: -Once the token is created, you can use its value or remove it: +> [!api] +> +> @api {v1} /me POST /me/api/oauth2/client +> -![token generated](images/token_generated.png){.thumbnail} +With this API call, you can create OAuth2 credentials for several authentication mechanisms. The one we are interested in here is **CLIENT_CREDENTIALS**. This mechanism does not require a callback URL. -### Generating tokens with API +You must supply the following values: -One goal with token is to automatize APIs call. Sometime you even need to automatize token creation. That's why it is possible to create token by using only the OVHcloud APIs. If you're familiar with the OVHcloud API, it should be fairly straightforward, if you're not, this section will help you with it. Generating tokens is two API calls away. You can use the OVHcloud API console to make theses calls. +- **callbackUrls**: An empty array of callback URLs `[]`. +- **flow**: `CLIENT_CREDENTIALS`. +- **name**: The name you would like to provide to your identifier. +- **description**: A description of your identifier. We recommend describing how you will use this identifier. If you audit your access in the future, it is easier to link it to your application name, so that you can easily find out where the identifier is deployed (and what the impact will be if you change your access). -First you will have to retrieve the serviceName you want to generate token for. The API call to get your serviceName is the following: +In response, the API will provide you with two pieces of information: -> [!api] -> -> @api {v1} /dbaas/logs GET /dbaas/logs -> +- **clientId**: Your service account ID. +- **clientSecret**: A token allowing you to authenticate yourself on our APIs. This information must be stored securely. With these two credentials, you can log in to this service account and get the rights associated with it. Save this value. It will not be possible to retrieve it at a later stage. -If you want to know what is the Logs Data Platform username associated with this serviceName, use the following call: +In order to retrieve an API token, you can use the following HTTP call with these two pieces of information: -> [!api] -> -> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName} -> +```bash +curl --request POST \ + --url 'https://www.ovh.com/auth/oauth2/token' \ + --header 'content-type: application/x-www-form-urlencoded' \ + --data grant_type=client_credentials \ + --data client_id=0f0f0f0f0f0f0f0f \ + --data client_secret=xxxxx \ + --data scope=all +``` -This call returns the service object of the connected identity. +Depending on the location of your API, you will need to use the following URL: -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) +- **EU API**: `https://www.ovh.com/auth/oauth2/token`. +- **CA API**: `https://ca.ovh.com/auth/oauth2/token`. -Once you have the login you want, use the following call to add a new token: +Following this API call, you will receive a response in the following format: -> [!api] -> -> @api {v1} /dbaas/logs POST /dbaas/logs/{serviceName}/token -> +```json +{ + "access_token":"your-api-token", + "token_type":"Bearer", + "expires_in":3599, + "scope":"all" +} +``` -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> - `name`: The name of your token (string) -> +Save the token in the **access_token** field. You will need it to authenticate your API calls. -Please replace **serviceName** with your serviceName, and replace **name** by the name of your choice for your token. This call will give you a taskId. After a few seconds you can retrieve your **tokenId** with this call: +This access token can then be used to interact with Logs Data Platform backend APIs. Don't forget to manage access rights of your service account with the [IAM policies](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). -> [!api] -> -> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName}/token -> +```bash +ldp@laptop curl -H 'content-type: application/json' --oauth2-bearer -XPUT 'https://.logs.ovh.com:9200/_cat/indices/ldp-*' +``` -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> +Or with the Bearer header: + +```bash +ldp@laptop curl -H 'content-type: application/json' -H "Authorization: Bearer " -XPUT 'https://.logs.ovh.com:9200/_cat/indices/ldp-*' +``` + +Note that access tokens created through a service account expire after some time. You must regenerate a new one after it has expired. -This will give you back the id of your token. The actual value of the token can be retrieved with this next call: +#### Local Users + +Create a local user by following the [dedicated documentation](/pages/account_and_service_management/account_information/ovhcloud-users-management) and create the right [IAM policies](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). Once created, you can use the OVHcloud API to create a token for this user: > [!api] > -> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName}/token/{tokenId} +> @api {v1} /me POST /me/identity/user/{user}/token > -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> - `tokenId`: UUID of your token (string) +This call will return a bearer access token for your local user. -Here is the final response you will get. +You can then use this token on Logs Data Platform backend APIs: -```json -{ - "updatedAt": "2016-12-01T12:30:26.566986+00:00", - "createdAt": "2016-12-01T12:30:26.566939+00:00", - "value": "kujg9g227qv0123mav3s0q4pra4psqsi5leka6j7lc62qdef58q", - "name": "token_name", - "tokenId": "XXXXXXXXXXXXXXXXXXXXXXXXXXX" -} +```bash +ldp@laptop curl -H 'content-type: application/json' --oauth2-bearer -XPUT 'https://.logs.ovh.com/api/search/universal/relative?query=*&range=300&filter=streams:a123aebc12345623aafd' ``` -The token value is the value field. That is the field you will need to use the Logs Data Platform Search APIs. +Or with the Bearer header + +```bash +ldp@laptop curl -H 'content-type: application/json' -H "Authorization: Bearer " -XPUT 'https://.logs.ovh.com/api/search/universal/relative?query=*&range=300&filter=streams:a123aebc12345623aafd' +``` -Finally to delete your token, use the following call: +These tokens do not expire but can be deleted whenever needed with this call: > [!api] > -> @api {v1} /dbaas/logs DELETE /dbaas/logs/{serviceName}/token/{tokenId} +> @api {v1} /me DELETE /me/identity/user/{user}/token/{name} > -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> - `tokenId`: UUID of your token (string) -> +#### Hybrid authentication + +For software that does not support the Bearer authentication scheme, we provide a hybrid authentication mode based on the Basic authentication scheme. Use a username that starts with **pat_jwt_** and supply the token value as the password. + +```bash +ldp@laptop curl -H 'content-type: application/json' \\ + -u pat_jwt_: \\ + -XPUT 'https://.logs.ovh.com:9200/_cat/indices/ldp-*' +``` + +### Legacy tokens + +Legacy tokens are still working and maintained for users without IAM. They are not available to IAM-enabled users. We strongly encourage you to migrate to IAM now and use the more flexible tokens described above. + +Once you have logged into Logs Data Platform you will have access to the token generation function from the Configuration panel. + +![Token Menu](images/token_menu.png){.thumbnail} + +On this page you will have the possibility to create a token and to remove them. Note that you cannot modify a token. + +![token generation](images/token_generation.png){.thumbnail} + +Once the token is created, you can use its value or remove it: + +![token generated](images/token_generated.png){.thumbnail} ### Using your tokens -Using your token is no different of using your credentials. You just have to replace your username with the word **token** and your password with the token (the opposite works too). -For example to issue a search against the Graylog API with the token obtained above, you can do the following: +Using your token is no different than using your credentials. You just have to replace your username with the word **token** and your password with the token (the opposite works too). +For example, to issue a search against the Graylog API with the token obtained above, you can do the following: ```shell-session $ curl -u token:kujg9g227qv0123mav3s0q4pra4psqsi5leka6j7lc62qdef58q -XGET "https://.logs.ovh.com/api/search/universal/relative?query=*&range=300&filter=streams:a123aebc12345623aafd" @@ -148,13 +175,13 @@ To issue a search against the OpenSearch API, you also use the same credentials. $ curl -u token:kujg9g227qv0123mav3s0q4pra4psqsi5leka6j7lc62qdef58q "https://.logs.ovh.com:9200/your_alias/_search?pretty" ``` -This call will launch a quick search (to retrieve the count and a sample of your documents) against the alias **your_alias**. Replace the alias by the one you have setup in you Logs Data Platform console. Note that these credentials are usable in place of your account credentials in Grafana (or any tool that supports Basic Authentication with OpenSearch). +This call will launch a quick search (to retrieve the count and a sample of your documents) against the alias **your_alias**. Replace the alias by the one you have set up in your Logs Data Platform console. Note that these credentials are usable in place of your account credentials in Grafana (or any tool that supports Basic Authentication with OpenSearch). -The only place you cannot use your token is the Graylog Web Interface. +The Graylog Web Interface does not support token authentication. ## Go further - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.fr-fr.md b/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.fr-fr.md index 986e2a548b8..d403fc4f392 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.fr-fr.md +++ b/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.fr-fr.md @@ -1,133 +1,160 @@ --- title: Securing Logs Data Platform's APIs with tokens -excerpt: If you want to give access to your logs to a software or automatize some tasks depending on your logs. You will maybe need to access them through the API. The most secure way to do this is to use tokens. -updated: 2023-06-02 +excerpt: If you want to give access to your logs to a software application or automate tasks that depend on your logs, you may need to access them through the API. +updated: 2025-10-16 --- ## Objective -With Logs Data Platform, there are 3 ways to query your logs. +With Logs Data Platform, there are 3 ways to query your logs: - The [Graylog Web Interface](https://gra1.logs.ovh.com) - The [Graylog API](https://gra1.logs.ovh.com/api/api-browser/global/index.html#!/search47universal47relative/searchRelative) -- The [OpenSearch API](https://opensearch.org/docs/latest/opensearch/query-dsl/index/) located at the port 9200 of your cluster (find its address in the **Home** Page) against your [alias](/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards). +- The [OpenSearch API](https://opensearch.org/docs/latest/opensearch/query-dsl/index/) located on port 9200 of your cluster (find its address in the **Home** Page) against your [alias](/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards). -So you can pop up a [Grafana](/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana) or even [a terminal Dashboard for Graylog](https://github.com/Graylog2/cli-dashboard). +So you open a [Grafana](/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana) or even [a terminal Dashboard for Graylog](https://github.com/Graylog2/cli-dashboard). All these accesses are secured by your username and password. But what if you don't want to put your Logs Data Platform credentials everywhere? You can just use tokens to access all these endpoints and revoke them anytime you want. This tutorial is here to tell you how. ## Requirements -- No specific requirements +- A service with IAM enabled to use IAM tokens or without IAM to use legacy tokens ## Instructions -### Generating tokens using the manager +### Generating tokens with IAM -Once you have logged into Logs Data Platform you will have to access to the token Generation panel from the Configuration box. +Before generating tokens with IAM you will need to create a [Service Account or a Local User](/pages/manage_and_operate/iam/identities-management). Both have specificities detailed in IAM documentation. Don't forget to attach these new identities to your [IAM Policies](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). -![Token Menu](images/token_menu.png){.thumbnail} +#### Service accounts -On this page you will have the possibility to create a token and to remove them. Note that you cannot modify a token. +Create a service account and tokens by following the [documentation](/pages/manage_and_operate/api/manage-service-account). Service accounts are a identifier/token pair following the OAuth2 **client- credentials** authentication mechanism. If you are familiar with OAuth2 clients, here are the API calls to create them. We still recommend you to read the dedicated guide to understand its specificities. -![token generation](images/token_generation.png){.thumbnail} +To create a service account, use the following API call: -Once the token is created, you can use its value or remove it: +> [!api] +> +> @api {v1} /me POST /me/api/oauth2/client +> -![token generated](images/token_generated.png){.thumbnail} +With this API call, you can create OAuth2 credentials for several authentication mechanisms. The one we are interested in here is **CLIENT_CREDENTIALS**. This mechanism does not require a callback URL. -### Generating tokens with API +You must supply the following values: -One goal with token is to automatize APIs call. Sometime you even need to automatize token creation. That's why it is possible to create token by using only the OVHcloud APIs. If you're familiar with the OVHcloud API, it should be fairly straightforward, if you're not, this section will help you with it. Generating tokens is two API calls away. You can use the OVHcloud API console to make theses calls. +- **callbackUrls**: An empty array of callback URLs `[]`. +- **flow**: `CLIENT_CREDENTIALS`. +- **name**: The name you would like to provide to your identifier. +- **description**: A description of your identifier. We recommend describing how you will use this identifier. If you audit your access in the future, it is easier to link it to your application name, so that you can easily find out where the identifier is deployed (and what the impact will be if you change your access). -First you will have to retrieve the serviceName you want to generate token for. The API call to get your serviceName is the following: +In response, the API will provide you with two pieces of information: -> [!api] -> -> @api {v1} /dbaas/logs GET /dbaas/logs -> +- **clientId**: Your service account ID. +- **clientSecret**: A token allowing you to authenticate yourself on our APIs. This information must be stored securely. With these two credentials, you can log in to this service account and get the rights associated with it. Save this value. It will not be possible to retrieve it at a later stage. -If you want to know what is the Logs Data Platform username associated with this serviceName, use the following call: +In order to retrieve an API token, you can use the following HTTP call with these two pieces of information: -> [!api] -> -> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName} -> +```bash +curl --request POST \ + --url 'https://www.ovh.com/auth/oauth2/token' \ + --header 'content-type: application/x-www-form-urlencoded' \ + --data grant_type=client_credentials \ + --data client_id=0f0f0f0f0f0f0f0f \ + --data client_secret=xxxxx \ + --data scope=all +``` -This call returns the service object of the connected identity. +Depending on the location of your API, you will need to use the following URL: -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) +- **EU API**: `https://www.ovh.com/auth/oauth2/token`. +- **CA API**: `https://ca.ovh.com/auth/oauth2/token`. -Once you have the login you want, use the following call to add a new token: +Following this API call, you will receive a response in the following format: -> [!api] -> -> @api {v1} /dbaas/logs POST /dbaas/logs/{serviceName}/token -> +```json +{ + "access_token":"your-api-token", + "token_type":"Bearer", + "expires_in":3599, + "scope":"all" +} +``` -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> - `name`: The name of your token (string) -> +Save the token in the **access_token** field. You will need it to authenticate your API calls. -Please replace **serviceName** with your serviceName, and replace **name** by the name of your choice for your token. This call will give you a taskId. After a few seconds you can retrieve your **tokenId** with this call: +This access token can then be used to interact with Logs Data Platform backend APIs. Don't forget to manage access rights of your service account with the [IAM policies](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). -> [!api] -> -> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName}/token -> +```bash +ldp@laptop curl -H 'content-type: application/json' --oauth2-bearer -XPUT 'https://.logs.ovh.com:9200/_cat/indices/ldp-*' +``` -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> +Or with the Bearer header: + +```bash +ldp@laptop curl -H 'content-type: application/json' -H "Authorization: Bearer " -XPUT 'https://.logs.ovh.com:9200/_cat/indices/ldp-*' +``` + +Note that access tokens created through a service account expire after some time. You must regenerate a new one after it has expired. -This will give you back the id of your token. The actual value of the token can be retrieved with this next call: +#### Local Users + +Create a local user by following the [dedicated documentation](/pages/account_and_service_management/account_information/ovhcloud-users-management) and create the right [IAM policies](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). Once created, you can use the OVHcloud API to create a token for this user: > [!api] > -> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName}/token/{tokenId} +> @api {v1} /me POST /me/identity/user/{user}/token > -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> - `tokenId`: UUID of your token (string) +This call will return a bearer access token for your local user. -Here is the final response you will get. +You can then use this token on Logs Data Platform backend APIs: -```json -{ - "updatedAt": "2016-12-01T12:30:26.566986+00:00", - "createdAt": "2016-12-01T12:30:26.566939+00:00", - "value": "kujg9g227qv0123mav3s0q4pra4psqsi5leka6j7lc62qdef58q", - "name": "token_name", - "tokenId": "XXXXXXXXXXXXXXXXXXXXXXXXXXX" -} +```bash +ldp@laptop curl -H 'content-type: application/json' --oauth2-bearer -XPUT 'https://.logs.ovh.com/api/search/universal/relative?query=*&range=300&filter=streams:a123aebc12345623aafd' ``` -The token value is the value field. That is the field you will need to use the Logs Data Platform Search APIs. +Or with the Bearer header + +```bash +ldp@laptop curl -H 'content-type: application/json' -H "Authorization: Bearer " -XPUT 'https://.logs.ovh.com/api/search/universal/relative?query=*&range=300&filter=streams:a123aebc12345623aafd' +``` -Finally to delete your token, use the following call: +These tokens do not expire but can be deleted whenever needed with this call: > [!api] > -> @api {v1} /dbaas/logs DELETE /dbaas/logs/{serviceName}/token/{tokenId} +> @api {v1} /me DELETE /me/identity/user/{user}/token/{name} > -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> - `tokenId`: UUID of your token (string) -> +#### Hybrid authentication + +For software that does not support the Bearer authentication scheme, we provide a hybrid authentication mode based on the Basic authentication scheme. Use a username that starts with **pat_jwt_** and supply the token value as the password. + +```bash +ldp@laptop curl -H 'content-type: application/json' \\ + -u pat_jwt_: \\ + -XPUT 'https://.logs.ovh.com:9200/_cat/indices/ldp-*' +``` + +### Legacy tokens + +Legacy tokens are still working and maintained for users without IAM. They are not available to IAM-enabled users. We strongly encourage you to migrate to IAM now and use the more flexible tokens described above. + +Once you have logged into Logs Data Platform you will have access to the token generation function from the Configuration panel. + +![Token Menu](images/token_menu.png){.thumbnail} + +On this page you will have the possibility to create a token and to remove them. Note that you cannot modify a token. + +![token generation](images/token_generation.png){.thumbnail} + +Once the token is created, you can use its value or remove it: + +![token generated](images/token_generated.png){.thumbnail} ### Using your tokens -Using your token is no different of using your credentials. You just have to replace your username with the word **token** and your password with the token (the opposite works too). -For example to issue a search against the Graylog API with the token obtained above, you can do the following: +Using your token is no different than using your credentials. You just have to replace your username with the word **token** and your password with the token (the opposite works too). +For example, to issue a search against the Graylog API with the token obtained above, you can do the following: ```shell-session $ curl -u token:kujg9g227qv0123mav3s0q4pra4psqsi5leka6j7lc62qdef58q -XGET "https://.logs.ovh.com/api/search/universal/relative?query=*&range=300&filter=streams:a123aebc12345623aafd" @@ -148,13 +175,13 @@ To issue a search against the OpenSearch API, you also use the same credentials. $ curl -u token:kujg9g227qv0123mav3s0q4pra4psqsi5leka6j7lc62qdef58q "https://.logs.ovh.com:9200/your_alias/_search?pretty" ``` -This call will launch a quick search (to retrieve the count and a sample of your documents) against the alias **your_alias**. Replace the alias by the one you have setup in you Logs Data Platform console. Note that these credentials are usable in place of your account credentials in Grafana (or any tool that supports Basic Authentication with OpenSearch). +This call will launch a quick search (to retrieve the count and a sample of your documents) against the alias **your_alias**. Replace the alias by the one you have set up in your Logs Data Platform console. Note that these credentials are usable in place of your account credentials in Grafana (or any tool that supports Basic Authentication with OpenSearch). -The only place you cannot use your token is the Graylog Web Interface. +The Graylog Web Interface does not support token authentication. ## Go further - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.it-it.md b/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.it-it.md index 986e2a548b8..d403fc4f392 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.it-it.md +++ b/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.it-it.md @@ -1,133 +1,160 @@ --- title: Securing Logs Data Platform's APIs with tokens -excerpt: If you want to give access to your logs to a software or automatize some tasks depending on your logs. You will maybe need to access them through the API. The most secure way to do this is to use tokens. -updated: 2023-06-02 +excerpt: If you want to give access to your logs to a software application or automate tasks that depend on your logs, you may need to access them through the API. +updated: 2025-10-16 --- ## Objective -With Logs Data Platform, there are 3 ways to query your logs. +With Logs Data Platform, there are 3 ways to query your logs: - The [Graylog Web Interface](https://gra1.logs.ovh.com) - The [Graylog API](https://gra1.logs.ovh.com/api/api-browser/global/index.html#!/search47universal47relative/searchRelative) -- The [OpenSearch API](https://opensearch.org/docs/latest/opensearch/query-dsl/index/) located at the port 9200 of your cluster (find its address in the **Home** Page) against your [alias](/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards). +- The [OpenSearch API](https://opensearch.org/docs/latest/opensearch/query-dsl/index/) located on port 9200 of your cluster (find its address in the **Home** Page) against your [alias](/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards). -So you can pop up a [Grafana](/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana) or even [a terminal Dashboard for Graylog](https://github.com/Graylog2/cli-dashboard). +So you open a [Grafana](/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana) or even [a terminal Dashboard for Graylog](https://github.com/Graylog2/cli-dashboard). All these accesses are secured by your username and password. But what if you don't want to put your Logs Data Platform credentials everywhere? You can just use tokens to access all these endpoints and revoke them anytime you want. This tutorial is here to tell you how. ## Requirements -- No specific requirements +- A service with IAM enabled to use IAM tokens or without IAM to use legacy tokens ## Instructions -### Generating tokens using the manager +### Generating tokens with IAM -Once you have logged into Logs Data Platform you will have to access to the token Generation panel from the Configuration box. +Before generating tokens with IAM you will need to create a [Service Account or a Local User](/pages/manage_and_operate/iam/identities-management). Both have specificities detailed in IAM documentation. Don't forget to attach these new identities to your [IAM Policies](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). -![Token Menu](images/token_menu.png){.thumbnail} +#### Service accounts -On this page you will have the possibility to create a token and to remove them. Note that you cannot modify a token. +Create a service account and tokens by following the [documentation](/pages/manage_and_operate/api/manage-service-account). Service accounts are a identifier/token pair following the OAuth2 **client- credentials** authentication mechanism. If you are familiar with OAuth2 clients, here are the API calls to create them. We still recommend you to read the dedicated guide to understand its specificities. -![token generation](images/token_generation.png){.thumbnail} +To create a service account, use the following API call: -Once the token is created, you can use its value or remove it: +> [!api] +> +> @api {v1} /me POST /me/api/oauth2/client +> -![token generated](images/token_generated.png){.thumbnail} +With this API call, you can create OAuth2 credentials for several authentication mechanisms. The one we are interested in here is **CLIENT_CREDENTIALS**. This mechanism does not require a callback URL. -### Generating tokens with API +You must supply the following values: -One goal with token is to automatize APIs call. Sometime you even need to automatize token creation. That's why it is possible to create token by using only the OVHcloud APIs. If you're familiar with the OVHcloud API, it should be fairly straightforward, if you're not, this section will help you with it. Generating tokens is two API calls away. You can use the OVHcloud API console to make theses calls. +- **callbackUrls**: An empty array of callback URLs `[]`. +- **flow**: `CLIENT_CREDENTIALS`. +- **name**: The name you would like to provide to your identifier. +- **description**: A description of your identifier. We recommend describing how you will use this identifier. If you audit your access in the future, it is easier to link it to your application name, so that you can easily find out where the identifier is deployed (and what the impact will be if you change your access). -First you will have to retrieve the serviceName you want to generate token for. The API call to get your serviceName is the following: +In response, the API will provide you with two pieces of information: -> [!api] -> -> @api {v1} /dbaas/logs GET /dbaas/logs -> +- **clientId**: Your service account ID. +- **clientSecret**: A token allowing you to authenticate yourself on our APIs. This information must be stored securely. With these two credentials, you can log in to this service account and get the rights associated with it. Save this value. It will not be possible to retrieve it at a later stage. -If you want to know what is the Logs Data Platform username associated with this serviceName, use the following call: +In order to retrieve an API token, you can use the following HTTP call with these two pieces of information: -> [!api] -> -> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName} -> +```bash +curl --request POST \ + --url 'https://www.ovh.com/auth/oauth2/token' \ + --header 'content-type: application/x-www-form-urlencoded' \ + --data grant_type=client_credentials \ + --data client_id=0f0f0f0f0f0f0f0f \ + --data client_secret=xxxxx \ + --data scope=all +``` -This call returns the service object of the connected identity. +Depending on the location of your API, you will need to use the following URL: -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) +- **EU API**: `https://www.ovh.com/auth/oauth2/token`. +- **CA API**: `https://ca.ovh.com/auth/oauth2/token`. -Once you have the login you want, use the following call to add a new token: +Following this API call, you will receive a response in the following format: -> [!api] -> -> @api {v1} /dbaas/logs POST /dbaas/logs/{serviceName}/token -> +```json +{ + "access_token":"your-api-token", + "token_type":"Bearer", + "expires_in":3599, + "scope":"all" +} +``` -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> - `name`: The name of your token (string) -> +Save the token in the **access_token** field. You will need it to authenticate your API calls. -Please replace **serviceName** with your serviceName, and replace **name** by the name of your choice for your token. This call will give you a taskId. After a few seconds you can retrieve your **tokenId** with this call: +This access token can then be used to interact with Logs Data Platform backend APIs. Don't forget to manage access rights of your service account with the [IAM policies](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). -> [!api] -> -> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName}/token -> +```bash +ldp@laptop curl -H 'content-type: application/json' --oauth2-bearer -XPUT 'https://.logs.ovh.com:9200/_cat/indices/ldp-*' +``` -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> +Or with the Bearer header: + +```bash +ldp@laptop curl -H 'content-type: application/json' -H "Authorization: Bearer " -XPUT 'https://.logs.ovh.com:9200/_cat/indices/ldp-*' +``` + +Note that access tokens created through a service account expire after some time. You must regenerate a new one after it has expired. -This will give you back the id of your token. The actual value of the token can be retrieved with this next call: +#### Local Users + +Create a local user by following the [dedicated documentation](/pages/account_and_service_management/account_information/ovhcloud-users-management) and create the right [IAM policies](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). Once created, you can use the OVHcloud API to create a token for this user: > [!api] > -> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName}/token/{tokenId} +> @api {v1} /me POST /me/identity/user/{user}/token > -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> - `tokenId`: UUID of your token (string) +This call will return a bearer access token for your local user. -Here is the final response you will get. +You can then use this token on Logs Data Platform backend APIs: -```json -{ - "updatedAt": "2016-12-01T12:30:26.566986+00:00", - "createdAt": "2016-12-01T12:30:26.566939+00:00", - "value": "kujg9g227qv0123mav3s0q4pra4psqsi5leka6j7lc62qdef58q", - "name": "token_name", - "tokenId": "XXXXXXXXXXXXXXXXXXXXXXXXXXX" -} +```bash +ldp@laptop curl -H 'content-type: application/json' --oauth2-bearer -XPUT 'https://.logs.ovh.com/api/search/universal/relative?query=*&range=300&filter=streams:a123aebc12345623aafd' ``` -The token value is the value field. That is the field you will need to use the Logs Data Platform Search APIs. +Or with the Bearer header + +```bash +ldp@laptop curl -H 'content-type: application/json' -H "Authorization: Bearer " -XPUT 'https://.logs.ovh.com/api/search/universal/relative?query=*&range=300&filter=streams:a123aebc12345623aafd' +``` -Finally to delete your token, use the following call: +These tokens do not expire but can be deleted whenever needed with this call: > [!api] > -> @api {v1} /dbaas/logs DELETE /dbaas/logs/{serviceName}/token/{tokenId} +> @api {v1} /me DELETE /me/identity/user/{user}/token/{name} > -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> - `tokenId`: UUID of your token (string) -> +#### Hybrid authentication + +For software that does not support the Bearer authentication scheme, we provide a hybrid authentication mode based on the Basic authentication scheme. Use a username that starts with **pat_jwt_** and supply the token value as the password. + +```bash +ldp@laptop curl -H 'content-type: application/json' \\ + -u pat_jwt_: \\ + -XPUT 'https://.logs.ovh.com:9200/_cat/indices/ldp-*' +``` + +### Legacy tokens + +Legacy tokens are still working and maintained for users without IAM. They are not available to IAM-enabled users. We strongly encourage you to migrate to IAM now and use the more flexible tokens described above. + +Once you have logged into Logs Data Platform you will have access to the token generation function from the Configuration panel. + +![Token Menu](images/token_menu.png){.thumbnail} + +On this page you will have the possibility to create a token and to remove them. Note that you cannot modify a token. + +![token generation](images/token_generation.png){.thumbnail} + +Once the token is created, you can use its value or remove it: + +![token generated](images/token_generated.png){.thumbnail} ### Using your tokens -Using your token is no different of using your credentials. You just have to replace your username with the word **token** and your password with the token (the opposite works too). -For example to issue a search against the Graylog API with the token obtained above, you can do the following: +Using your token is no different than using your credentials. You just have to replace your username with the word **token** and your password with the token (the opposite works too). +For example, to issue a search against the Graylog API with the token obtained above, you can do the following: ```shell-session $ curl -u token:kujg9g227qv0123mav3s0q4pra4psqsi5leka6j7lc62qdef58q -XGET "https://.logs.ovh.com/api/search/universal/relative?query=*&range=300&filter=streams:a123aebc12345623aafd" @@ -148,13 +175,13 @@ To issue a search against the OpenSearch API, you also use the same credentials. $ curl -u token:kujg9g227qv0123mav3s0q4pra4psqsi5leka6j7lc62qdef58q "https://.logs.ovh.com:9200/your_alias/_search?pretty" ``` -This call will launch a quick search (to retrieve the count and a sample of your documents) against the alias **your_alias**. Replace the alias by the one you have setup in you Logs Data Platform console. Note that these credentials are usable in place of your account credentials in Grafana (or any tool that supports Basic Authentication with OpenSearch). +This call will launch a quick search (to retrieve the count and a sample of your documents) against the alias **your_alias**. Replace the alias by the one you have set up in your Logs Data Platform console. Note that these credentials are usable in place of your account credentials in Grafana (or any tool that supports Basic Authentication with OpenSearch). -The only place you cannot use your token is the Graylog Web Interface. +The Graylog Web Interface does not support token authentication. ## Go further - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.pl-pl.md b/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.pl-pl.md index 986e2a548b8..d403fc4f392 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.pl-pl.md +++ b/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.pl-pl.md @@ -1,133 +1,160 @@ --- title: Securing Logs Data Platform's APIs with tokens -excerpt: If you want to give access to your logs to a software or automatize some tasks depending on your logs. You will maybe need to access them through the API. The most secure way to do this is to use tokens. -updated: 2023-06-02 +excerpt: If you want to give access to your logs to a software application or automate tasks that depend on your logs, you may need to access them through the API. +updated: 2025-10-16 --- ## Objective -With Logs Data Platform, there are 3 ways to query your logs. +With Logs Data Platform, there are 3 ways to query your logs: - The [Graylog Web Interface](https://gra1.logs.ovh.com) - The [Graylog API](https://gra1.logs.ovh.com/api/api-browser/global/index.html#!/search47universal47relative/searchRelative) -- The [OpenSearch API](https://opensearch.org/docs/latest/opensearch/query-dsl/index/) located at the port 9200 of your cluster (find its address in the **Home** Page) against your [alias](/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards). +- The [OpenSearch API](https://opensearch.org/docs/latest/opensearch/query-dsl/index/) located on port 9200 of your cluster (find its address in the **Home** Page) against your [alias](/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards). -So you can pop up a [Grafana](/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana) or even [a terminal Dashboard for Graylog](https://github.com/Graylog2/cli-dashboard). +So you open a [Grafana](/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana) or even [a terminal Dashboard for Graylog](https://github.com/Graylog2/cli-dashboard). All these accesses are secured by your username and password. But what if you don't want to put your Logs Data Platform credentials everywhere? You can just use tokens to access all these endpoints and revoke them anytime you want. This tutorial is here to tell you how. ## Requirements -- No specific requirements +- A service with IAM enabled to use IAM tokens or without IAM to use legacy tokens ## Instructions -### Generating tokens using the manager +### Generating tokens with IAM -Once you have logged into Logs Data Platform you will have to access to the token Generation panel from the Configuration box. +Before generating tokens with IAM you will need to create a [Service Account or a Local User](/pages/manage_and_operate/iam/identities-management). Both have specificities detailed in IAM documentation. Don't forget to attach these new identities to your [IAM Policies](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). -![Token Menu](images/token_menu.png){.thumbnail} +#### Service accounts -On this page you will have the possibility to create a token and to remove them. Note that you cannot modify a token. +Create a service account and tokens by following the [documentation](/pages/manage_and_operate/api/manage-service-account). Service accounts are a identifier/token pair following the OAuth2 **client- credentials** authentication mechanism. If you are familiar with OAuth2 clients, here are the API calls to create them. We still recommend you to read the dedicated guide to understand its specificities. -![token generation](images/token_generation.png){.thumbnail} +To create a service account, use the following API call: -Once the token is created, you can use its value or remove it: +> [!api] +> +> @api {v1} /me POST /me/api/oauth2/client +> -![token generated](images/token_generated.png){.thumbnail} +With this API call, you can create OAuth2 credentials for several authentication mechanisms. The one we are interested in here is **CLIENT_CREDENTIALS**. This mechanism does not require a callback URL. -### Generating tokens with API +You must supply the following values: -One goal with token is to automatize APIs call. Sometime you even need to automatize token creation. That's why it is possible to create token by using only the OVHcloud APIs. If you're familiar with the OVHcloud API, it should be fairly straightforward, if you're not, this section will help you with it. Generating tokens is two API calls away. You can use the OVHcloud API console to make theses calls. +- **callbackUrls**: An empty array of callback URLs `[]`. +- **flow**: `CLIENT_CREDENTIALS`. +- **name**: The name you would like to provide to your identifier. +- **description**: A description of your identifier. We recommend describing how you will use this identifier. If you audit your access in the future, it is easier to link it to your application name, so that you can easily find out where the identifier is deployed (and what the impact will be if you change your access). -First you will have to retrieve the serviceName you want to generate token for. The API call to get your serviceName is the following: +In response, the API will provide you with two pieces of information: -> [!api] -> -> @api {v1} /dbaas/logs GET /dbaas/logs -> +- **clientId**: Your service account ID. +- **clientSecret**: A token allowing you to authenticate yourself on our APIs. This information must be stored securely. With these two credentials, you can log in to this service account and get the rights associated with it. Save this value. It will not be possible to retrieve it at a later stage. -If you want to know what is the Logs Data Platform username associated with this serviceName, use the following call: +In order to retrieve an API token, you can use the following HTTP call with these two pieces of information: -> [!api] -> -> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName} -> +```bash +curl --request POST \ + --url 'https://www.ovh.com/auth/oauth2/token' \ + --header 'content-type: application/x-www-form-urlencoded' \ + --data grant_type=client_credentials \ + --data client_id=0f0f0f0f0f0f0f0f \ + --data client_secret=xxxxx \ + --data scope=all +``` -This call returns the service object of the connected identity. +Depending on the location of your API, you will need to use the following URL: -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) +- **EU API**: `https://www.ovh.com/auth/oauth2/token`. +- **CA API**: `https://ca.ovh.com/auth/oauth2/token`. -Once you have the login you want, use the following call to add a new token: +Following this API call, you will receive a response in the following format: -> [!api] -> -> @api {v1} /dbaas/logs POST /dbaas/logs/{serviceName}/token -> +```json +{ + "access_token":"your-api-token", + "token_type":"Bearer", + "expires_in":3599, + "scope":"all" +} +``` -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> - `name`: The name of your token (string) -> +Save the token in the **access_token** field. You will need it to authenticate your API calls. -Please replace **serviceName** with your serviceName, and replace **name** by the name of your choice for your token. This call will give you a taskId. After a few seconds you can retrieve your **tokenId** with this call: +This access token can then be used to interact with Logs Data Platform backend APIs. Don't forget to manage access rights of your service account with the [IAM policies](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). -> [!api] -> -> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName}/token -> +```bash +ldp@laptop curl -H 'content-type: application/json' --oauth2-bearer -XPUT 'https://.logs.ovh.com:9200/_cat/indices/ldp-*' +``` -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> +Or with the Bearer header: + +```bash +ldp@laptop curl -H 'content-type: application/json' -H "Authorization: Bearer " -XPUT 'https://.logs.ovh.com:9200/_cat/indices/ldp-*' +``` + +Note that access tokens created through a service account expire after some time. You must regenerate a new one after it has expired. -This will give you back the id of your token. The actual value of the token can be retrieved with this next call: +#### Local Users + +Create a local user by following the [dedicated documentation](/pages/account_and_service_management/account_information/ovhcloud-users-management) and create the right [IAM policies](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). Once created, you can use the OVHcloud API to create a token for this user: > [!api] > -> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName}/token/{tokenId} +> @api {v1} /me POST /me/identity/user/{user}/token > -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> - `tokenId`: UUID of your token (string) +This call will return a bearer access token for your local user. -Here is the final response you will get. +You can then use this token on Logs Data Platform backend APIs: -```json -{ - "updatedAt": "2016-12-01T12:30:26.566986+00:00", - "createdAt": "2016-12-01T12:30:26.566939+00:00", - "value": "kujg9g227qv0123mav3s0q4pra4psqsi5leka6j7lc62qdef58q", - "name": "token_name", - "tokenId": "XXXXXXXXXXXXXXXXXXXXXXXXXXX" -} +```bash +ldp@laptop curl -H 'content-type: application/json' --oauth2-bearer -XPUT 'https://.logs.ovh.com/api/search/universal/relative?query=*&range=300&filter=streams:a123aebc12345623aafd' ``` -The token value is the value field. That is the field you will need to use the Logs Data Platform Search APIs. +Or with the Bearer header + +```bash +ldp@laptop curl -H 'content-type: application/json' -H "Authorization: Bearer " -XPUT 'https://.logs.ovh.com/api/search/universal/relative?query=*&range=300&filter=streams:a123aebc12345623aafd' +``` -Finally to delete your token, use the following call: +These tokens do not expire but can be deleted whenever needed with this call: > [!api] > -> @api {v1} /dbaas/logs DELETE /dbaas/logs/{serviceName}/token/{tokenId} +> @api {v1} /me DELETE /me/identity/user/{user}/token/{name} > -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> - `tokenId`: UUID of your token (string) -> +#### Hybrid authentication + +For software that does not support the Bearer authentication scheme, we provide a hybrid authentication mode based on the Basic authentication scheme. Use a username that starts with **pat_jwt_** and supply the token value as the password. + +```bash +ldp@laptop curl -H 'content-type: application/json' \\ + -u pat_jwt_: \\ + -XPUT 'https://.logs.ovh.com:9200/_cat/indices/ldp-*' +``` + +### Legacy tokens + +Legacy tokens are still working and maintained for users without IAM. They are not available to IAM-enabled users. We strongly encourage you to migrate to IAM now and use the more flexible tokens described above. + +Once you have logged into Logs Data Platform you will have access to the token generation function from the Configuration panel. + +![Token Menu](images/token_menu.png){.thumbnail} + +On this page you will have the possibility to create a token and to remove them. Note that you cannot modify a token. + +![token generation](images/token_generation.png){.thumbnail} + +Once the token is created, you can use its value or remove it: + +![token generated](images/token_generated.png){.thumbnail} ### Using your tokens -Using your token is no different of using your credentials. You just have to replace your username with the word **token** and your password with the token (the opposite works too). -For example to issue a search against the Graylog API with the token obtained above, you can do the following: +Using your token is no different than using your credentials. You just have to replace your username with the word **token** and your password with the token (the opposite works too). +For example, to issue a search against the Graylog API with the token obtained above, you can do the following: ```shell-session $ curl -u token:kujg9g227qv0123mav3s0q4pra4psqsi5leka6j7lc62qdef58q -XGET "https://.logs.ovh.com/api/search/universal/relative?query=*&range=300&filter=streams:a123aebc12345623aafd" @@ -148,13 +175,13 @@ To issue a search against the OpenSearch API, you also use the same credentials. $ curl -u token:kujg9g227qv0123mav3s0q4pra4psqsi5leka6j7lc62qdef58q "https://.logs.ovh.com:9200/your_alias/_search?pretty" ``` -This call will launch a quick search (to retrieve the count and a sample of your documents) against the alias **your_alias**. Replace the alias by the one you have setup in you Logs Data Platform console. Note that these credentials are usable in place of your account credentials in Grafana (or any tool that supports Basic Authentication with OpenSearch). +This call will launch a quick search (to retrieve the count and a sample of your documents) against the alias **your_alias**. Replace the alias by the one you have set up in your Logs Data Platform console. Note that these credentials are usable in place of your account credentials in Grafana (or any tool that supports Basic Authentication with OpenSearch). -The only place you cannot use your token is the Graylog Web Interface. +The Graylog Web Interface does not support token authentication. ## Go further - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.pt-pt.md b/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.pt-pt.md index 986e2a548b8..d403fc4f392 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.pt-pt.md +++ b/pages/manage_and_operate/observability/logs_data_platform/security_tokens/guide.pt-pt.md @@ -1,133 +1,160 @@ --- title: Securing Logs Data Platform's APIs with tokens -excerpt: If you want to give access to your logs to a software or automatize some tasks depending on your logs. You will maybe need to access them through the API. The most secure way to do this is to use tokens. -updated: 2023-06-02 +excerpt: If you want to give access to your logs to a software application or automate tasks that depend on your logs, you may need to access them through the API. +updated: 2025-10-16 --- ## Objective -With Logs Data Platform, there are 3 ways to query your logs. +With Logs Data Platform, there are 3 ways to query your logs: - The [Graylog Web Interface](https://gra1.logs.ovh.com) - The [Graylog API](https://gra1.logs.ovh.com/api/api-browser/global/index.html#!/search47universal47relative/searchRelative) -- The [OpenSearch API](https://opensearch.org/docs/latest/opensearch/query-dsl/index/) located at the port 9200 of your cluster (find its address in the **Home** Page) against your [alias](/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards). +- The [OpenSearch API](https://opensearch.org/docs/latest/opensearch/query-dsl/index/) located on port 9200 of your cluster (find its address in the **Home** Page) against your [alias](/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards). -So you can pop up a [Grafana](/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana) or even [a terminal Dashboard for Graylog](https://github.com/Graylog2/cli-dashboard). +So you open a [Grafana](/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana) or even [a terminal Dashboard for Graylog](https://github.com/Graylog2/cli-dashboard). All these accesses are secured by your username and password. But what if you don't want to put your Logs Data Platform credentials everywhere? You can just use tokens to access all these endpoints and revoke them anytime you want. This tutorial is here to tell you how. ## Requirements -- No specific requirements +- A service with IAM enabled to use IAM tokens or without IAM to use legacy tokens ## Instructions -### Generating tokens using the manager +### Generating tokens with IAM -Once you have logged into Logs Data Platform you will have to access to the token Generation panel from the Configuration box. +Before generating tokens with IAM you will need to create a [Service Account or a Local User](/pages/manage_and_operate/iam/identities-management). Both have specificities detailed in IAM documentation. Don't forget to attach these new identities to your [IAM Policies](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). -![Token Menu](images/token_menu.png){.thumbnail} +#### Service accounts -On this page you will have the possibility to create a token and to remove them. Note that you cannot modify a token. +Create a service account and tokens by following the [documentation](/pages/manage_and_operate/api/manage-service-account). Service accounts are a identifier/token pair following the OAuth2 **client- credentials** authentication mechanism. If you are familiar with OAuth2 clients, here are the API calls to create them. We still recommend you to read the dedicated guide to understand its specificities. -![token generation](images/token_generation.png){.thumbnail} +To create a service account, use the following API call: -Once the token is created, you can use its value or remove it: +> [!api] +> +> @api {v1} /me POST /me/api/oauth2/client +> -![token generated](images/token_generated.png){.thumbnail} +With this API call, you can create OAuth2 credentials for several authentication mechanisms. The one we are interested in here is **CLIENT_CREDENTIALS**. This mechanism does not require a callback URL. -### Generating tokens with API +You must supply the following values: -One goal with token is to automatize APIs call. Sometime you even need to automatize token creation. That's why it is possible to create token by using only the OVHcloud APIs. If you're familiar with the OVHcloud API, it should be fairly straightforward, if you're not, this section will help you with it. Generating tokens is two API calls away. You can use the OVHcloud API console to make theses calls. +- **callbackUrls**: An empty array of callback URLs `[]`. +- **flow**: `CLIENT_CREDENTIALS`. +- **name**: The name you would like to provide to your identifier. +- **description**: A description of your identifier. We recommend describing how you will use this identifier. If you audit your access in the future, it is easier to link it to your application name, so that you can easily find out where the identifier is deployed (and what the impact will be if you change your access). -First you will have to retrieve the serviceName you want to generate token for. The API call to get your serviceName is the following: +In response, the API will provide you with two pieces of information: -> [!api] -> -> @api {v1} /dbaas/logs GET /dbaas/logs -> +- **clientId**: Your service account ID. +- **clientSecret**: A token allowing you to authenticate yourself on our APIs. This information must be stored securely. With these two credentials, you can log in to this service account and get the rights associated with it. Save this value. It will not be possible to retrieve it at a later stage. -If you want to know what is the Logs Data Platform username associated with this serviceName, use the following call: +In order to retrieve an API token, you can use the following HTTP call with these two pieces of information: -> [!api] -> -> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName} -> +```bash +curl --request POST \ + --url 'https://www.ovh.com/auth/oauth2/token' \ + --header 'content-type: application/x-www-form-urlencoded' \ + --data grant_type=client_credentials \ + --data client_id=0f0f0f0f0f0f0f0f \ + --data client_secret=xxxxx \ + --data scope=all +``` -This call returns the service object of the connected identity. +Depending on the location of your API, you will need to use the following URL: -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) +- **EU API**: `https://www.ovh.com/auth/oauth2/token`. +- **CA API**: `https://ca.ovh.com/auth/oauth2/token`. -Once you have the login you want, use the following call to add a new token: +Following this API call, you will receive a response in the following format: -> [!api] -> -> @api {v1} /dbaas/logs POST /dbaas/logs/{serviceName}/token -> +```json +{ + "access_token":"your-api-token", + "token_type":"Bearer", + "expires_in":3599, + "scope":"all" +} +``` -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> - `name`: The name of your token (string) -> +Save the token in the **access_token** field. You will need it to authenticate your API calls. -Please replace **serviceName** with your serviceName, and replace **name** by the name of your choice for your token. This call will give you a taskId. After a few seconds you can retrieve your **tokenId** with this call: +This access token can then be used to interact with Logs Data Platform backend APIs. Don't forget to manage access rights of your service account with the [IAM policies](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). -> [!api] -> -> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName}/token -> +```bash +ldp@laptop curl -H 'content-type: application/json' --oauth2-bearer -XPUT 'https://.logs.ovh.com:9200/_cat/indices/ldp-*' +``` -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> +Or with the Bearer header: + +```bash +ldp@laptop curl -H 'content-type: application/json' -H "Authorization: Bearer " -XPUT 'https://.logs.ovh.com:9200/_cat/indices/ldp-*' +``` + +Note that access tokens created through a service account expire after some time. You must regenerate a new one after it has expired. -This will give you back the id of your token. The actual value of the token can be retrieved with this next call: +#### Local Users + +Create a local user by following the [dedicated documentation](/pages/account_and_service_management/account_information/ovhcloud-users-management) and create the right [IAM policies](/pages/manage_and_operate/observability/logs_data_platform/iam_access_management). Once created, you can use the OVHcloud API to create a token for this user: > [!api] > -> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName}/token/{tokenId} +> @api {v1} /me POST /me/identity/user/{user}/token > -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> - `tokenId`: UUID of your token (string) +This call will return a bearer access token for your local user. -Here is the final response you will get. +You can then use this token on Logs Data Platform backend APIs: -```json -{ - "updatedAt": "2016-12-01T12:30:26.566986+00:00", - "createdAt": "2016-12-01T12:30:26.566939+00:00", - "value": "kujg9g227qv0123mav3s0q4pra4psqsi5leka6j7lc62qdef58q", - "name": "token_name", - "tokenId": "XXXXXXXXXXXXXXXXXXXXXXXXXXX" -} +```bash +ldp@laptop curl -H 'content-type: application/json' --oauth2-bearer -XPUT 'https://.logs.ovh.com/api/search/universal/relative?query=*&range=300&filter=streams:a123aebc12345623aafd' ``` -The token value is the value field. That is the field you will need to use the Logs Data Platform Search APIs. +Or with the Bearer header + +```bash +ldp@laptop curl -H 'content-type: application/json' -H "Authorization: Bearer " -XPUT 'https://.logs.ovh.com/api/search/universal/relative?query=*&range=300&filter=streams:a123aebc12345623aafd' +``` -Finally to delete your token, use the following call: +These tokens do not expire but can be deleted whenever needed with this call: > [!api] > -> @api {v1} /dbaas/logs DELETE /dbaas/logs/{serviceName}/token/{tokenId} +> @api {v1} /me DELETE /me/identity/user/{user}/token/{name} > -> Parameters: -> -> - `serviceName`: The internal ID of your Logs Data Platform service (string) -> - `tokenId`: UUID of your token (string) -> +#### Hybrid authentication + +For software that does not support the Bearer authentication scheme, we provide a hybrid authentication mode based on the Basic authentication scheme. Use a username that starts with **pat_jwt_** and supply the token value as the password. + +```bash +ldp@laptop curl -H 'content-type: application/json' \\ + -u pat_jwt_: \\ + -XPUT 'https://.logs.ovh.com:9200/_cat/indices/ldp-*' +``` + +### Legacy tokens + +Legacy tokens are still working and maintained for users without IAM. They are not available to IAM-enabled users. We strongly encourage you to migrate to IAM now and use the more flexible tokens described above. + +Once you have logged into Logs Data Platform you will have access to the token generation function from the Configuration panel. + +![Token Menu](images/token_menu.png){.thumbnail} + +On this page you will have the possibility to create a token and to remove them. Note that you cannot modify a token. + +![token generation](images/token_generation.png){.thumbnail} + +Once the token is created, you can use its value or remove it: + +![token generated](images/token_generated.png){.thumbnail} ### Using your tokens -Using your token is no different of using your credentials. You just have to replace your username with the word **token** and your password with the token (the opposite works too). -For example to issue a search against the Graylog API with the token obtained above, you can do the following: +Using your token is no different than using your credentials. You just have to replace your username with the word **token** and your password with the token (the opposite works too). +For example, to issue a search against the Graylog API with the token obtained above, you can do the following: ```shell-session $ curl -u token:kujg9g227qv0123mav3s0q4pra4psqsi5leka6j7lc62qdef58q -XGET "https://.logs.ovh.com/api/search/universal/relative?query=*&range=300&filter=streams:a123aebc12345623aafd" @@ -148,13 +175,13 @@ To issue a search against the OpenSearch API, you also use the same credentials. $ curl -u token:kujg9g227qv0123mav3s0q4pra4psqsi5leka6j7lc62qdef58q "https://.logs.ovh.com:9200/your_alias/_search?pretty" ``` -This call will launch a quick search (to retrieve the count and a sample of your documents) against the alias **your_alias**. Replace the alias by the one you have setup in you Logs Data Platform console. Note that these credentials are usable in place of your account credentials in Grafana (or any tool that supports Basic Authentication with OpenSearch). +This call will launch a quick search (to retrieve the count and a sample of your documents) against the alias **your_alias**. Replace the alias by the one you have set up in your Logs Data Platform console. Note that these credentials are usable in place of your account credentials in Grafana (or any tool that supports Basic Authentication with OpenSearch). -The only place you cannot use your token is the Graylog Web Interface. +The Graylog Web Interface does not support token authentication. ## Go further - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/usecase_extract_logs_from_ldp/guide.en-gb.md b/pages/manage_and_operate/observability/logs_data_platform/usecase_extract_logs_from_ldp/guide.en-gb.md new file mode 100644 index 00000000000..2ab6ba510cc --- /dev/null +++ b/pages/manage_and_operate/observability/logs_data_platform/usecase_extract_logs_from_ldp/guide.en-gb.md @@ -0,0 +1,320 @@ +--- +title: Extracting logs from Logs Data Platform +excerpt: How to export logs using Logstash or Elasticdump +updated: 2025-10-16 +--- + +## Objective + +This guide explains how to **export logs stored in the Logs Data Platform (LDP)** using tooling that speaks the OpenSearch API. +It presents two reference implementations: + +- **Logstash**, suited to long-running pipelines and complex transformations. +- **Elasticdump**, a lightweight CLI utility designed for one-off or scheduled exports. + +Exporting logs is a common need when you want to analyse data outside the LDP ecosystem or feed it to external BI tools. For long-term archiving, we provide [another solution](#export-logs-from-archive). + +The next sections explain how to pull documents from your alias with **Logstash** or with the **Elasticdump** CLI, letting you choose the tool that best fits your operational model. + +The final part explains how you can export your logs from your [cold-stored archives](/pages/manage_and_operate/observability/logs_data_platform/archive_cold_storage). + +## Requirements + +- You are already sending logs on a stream you own — [see the quick start tutorial](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start). +- You know the OpenSearch endpoint of your LDP cluster (`https://.logs.ovh.com:9200`). +- Your host can reach TCP port **9200** on the cluster endpoint over TLS. +- You have credentials for the alias you want to export (basic authentication or IAM bearer token). +- You can install either **Logstash ≥ 8.0** or **Elasticdump ≥ 6.0** on the host that will run the export. + +## Instructions + +### Alias naming conventions + +When you create an OpenSearch alias that points to a Graylog stream, the **only customizable part is the suffix after -a-.**. e.g., `ldp-ti-98765-a-your_suffix`**. + +The remainder of the name is generated by the platform: + +| IAM status | Generated part | Full alias example | +|------------|----------------|--------------------| +| **IAM enabled** | the *service identifier* (e.g. `ldp-ti-98765`) | `ldp-ti-98765-a-logs-export` | +| **IAM disabled** (before IAM migration) | your *username* (e.g. `logs-ab-12345`) | `logs-ab-12345-a-logs-export` | + +The `` part (here `logs-export`) is a free‑form string you choose to describe the purpose of the alias. + +### Create a stream alias + +1. Log in to the [OVHcloud Control Panel](/links/manager) and go to the `Identity, Security & Operations`{.action} section. +1. Click on `Logs Data Platform`{.action} under **Operations** then click on the desired account. +1. Select the `Alias`{.action} tab and click `Add an alias`{.action}. +1. Choose a suffix, add a description and save the alias. +1. Click the `…`{.action} menu on the right of the newly created alias and select `Attach content to the alias`{.action}. +1. Select the Graylog stream(s) you want to export and confirm. + +The alias now points to the underlying OpenSearch alias that stores the logs of the chosen stream. + +### Export logs with Logstash + +#### Prerequisites + +| Requirement | Details | +|-------------|---------| +| Logstash ≥ 8.0 | Install Logstash on a host that can reach your LDP cluster. | +| Java 8 or 11 | Required by Logstash. | +| OpenSearch endpoint | `https://.logs.ovh.com:9200` | +| Authentication | Basic user/password **or** IAM bearer token (see the [IAM FAQ](/pages/manage_and_operate/observability/logs_data_platform/iam_presentation_faq/)). | +| Alias name | The alias created in the previous step (e.g. `ldp-ti-98765-a-logs-export`). | + +#### Install Logstash and the OpenSearch plugins + +```bash +# Download Logstash (tarball example) +wget https://artifacts.elastic.co/downloads/logstash/logstash-8.8.2-linux-x86_64.tar.gz +tar -zxvf logstash-8.8.2-linux-x86_64.tar.gz +cd logstash-8.8.2 + +# Install the required plugins +bin/logstash-plugin install logstash-input-opensearch +``` + +#### Logstash pipeline + +Create a file `pipeline.conf` (any location, e.g. `config/pipeline.conf`): + +```ruby +input { + opensearch { + # Note that only the hostname is put + hosts => [".logs.ovh.com:9200"] + # Use basic auth or IAM token with pat_jwt_ username + user => "" + password => "" + index => "" + schedule => "*/5 * * * *" # (Optional) Run every 5 minutes + query => '{"query":{"bool":{"must":[{"match_all":{}}],"filter":[{"range":{"timestamp":{"gte":"now-1d"}}}]}}}' + scroll => "5m" # (Optional) The scroll stays open for 5m + ssl => true + } +} + +filter { + # (Optional) Convert the timestamp to a readable format + date { + match => ["timestamp", "ISO8601"] + target => "timestamp" + } +} + +output { + csv { + path => "/var/log/ldp/export-%{+YYYY-MM-dd}.csv" + fields => ["timestamp", "host", "log.level", "message"] + gzip => false # (Optional) Compress the output file. + create_if_deleted => true # (Optional) Re‑create the file if it disappears while Logstash runs. + flush_interval => 2 # (Optional) How often Logstash flushes data to disk. + } +} +``` + +#### Run the pipeline + +```bash +# From the Logstash root directory +bin/logstash -f config/pipeline.conf --config.reload.automatic +``` + +Logstash will connect to the OpenSearch endpoint, read the documents that belong to the alias defined above, and write the selected fields to a daily CSV file under `/var/log/ldp/`. + +### Export logs with Elasticdump + +#### Prerequisites + +| Requirement | Details | +|-------------|---------| +| Elasticdump ≥ 6.0 | Install on a host that can reach your LDP cluster over HTTPS. | +| Node.js runtime | Elasticdump is a Node.js CLI; install Node.js 18 LTS or later. | +| Network access | Allow outbound TCP connectivity to `.logs.ovh.com` on port `9200`. | +| Authentication | Use either basic auth credentials (legacy users) or an IAM bearer token. | +| TLS trust store | Ensure the system trust store contains public Certificate Authorities, or supply a CA bundle with `--input-ca`. | +| Alias name | The alias created earlier (e.g. `ldp-ti-98765-a-logs-export`). | + +#### Install Elasticdump + +[Elasticdump](https://github.com/elasticsearch-dump/elasticsearch-dump) is an open-source software designed to export data from ElasticSearch/OpenSearch to a file or to another OpenSearch/ElasticSearch. It's a great tool to migrate from ElasticSearch to OpenSearch and to download data contained in your aliases or indices. It is written in JavaScript and thus relies on a JavaScript runtime to run. + +```bash +# Install Node.js using your preferred method (example for Debian/Ubuntu) +sudo apt update +sudo apt install nodejs npm + +# Install elasticdump globally +npm install -g elasticdump + +# Validate the installation +elasticdump --version +``` + +For air-gapped or containerised environments, you can download the [official Docker image](https://hub.docker.com/r/elasticdump/elasticsearch-dump) and run the same commands with `docker run --rm -v "$PWD":/work -w /work elasticdump/elasticsearch-dump`. + +#### Authenticate to the Logs Data Platform + +Elasticdump relies on HTTP headers for authentication. Choose the method that matches your account: + +- **Basic authentication** — append credentials in the URL: `https://:@.logs.ovh.com:9200/`. +- **IAM bearer token** — add an `Authorization` header: `--input-headers '{"Authorization":"Bearer "}'`. + +When using IAM tokens, leave the credentials out of the URL and rely solely on the header. Tokens are short-lived; plan to refresh them before launching long exports. + +### Export an alias to JSON + +Create a JSON file (`search-body.json`) that defines your query. The example below retrieves events from the last 24 hours: + +```json +{ + "query": { + "bool": { + "filter": [ + { + "range": { + "timestamp": { + "gte": "now-24h", + "lte": "now" + } + } + } + ] + } + }, + "sort": [ + { + "timestamp": "asc" + } + ] +} +``` + +Run Elasticdump to export the documents: + +```bash +elasticdump \ + --input https://:@.logs.ovh.com:9200/ \ + --output ./ldp-export.json \ + --searchBody @search-body.json \ + --limit 1000 \ + --type data +``` + +To authenticate with IAM, you can use the header flag or the hybrid authentication: + +```bash +elasticdump \ + --input https://.logs.ovh.com:9200/ \ + --input-headers '{"Authorization":"Bearer "}' \ + --output ./ldp-export.json \ + --searchBody @search-body.json \ + --type data +``` + +```bash +elasticdump \ + --input https://pat_jwt_:@.logs.ovh.com:9200/ \ + --output ./ldp-export.json \ + --searchBody @search-body.json \ + --type data +``` + +Elasticdump streams the results to `ldp-export.json` in newline-delimited JSON format, which can be loaded into analytics tools or archived for compliance. + +```bash +$ elasticdump --input https://:@gra2.logs.ovh.com:9200/ --output ./ldp-export.json --searchBody @search-body.json --limit 500 --type data +Tue, 07 Oct 2025 14:11:30 GMT | starting dump +Tue, 07 Oct 2025 14:11:30 GMT | got 79 objects from source elasticsearch (offset: 0) +Tue, 07 Oct 2025 14:11:30 GMT | sent 79 objects, 0 offset, to destination file, wrote 79 +Tue, 07 Oct 2025 14:11:30 GMT | got 0 objects from source elasticsearch (offset: 500) +Tue, 07 Oct 2025 14:11:30 GMT | Total Writes: 79 +Tue, 07 Oct 2025 14:11:30 GMT | dump complete +``` + +#### Handle formats, pagination and large time ranges + +To export data in CSV format, use the csv scheme in the output file: + +```bash +elasticdump \ + --input https://pat_jwt_:@.logs.ovh.com:9200/ \ + --output csv://./ldp-export.json \ + --searchBody @search-body.json \ + --type data +``` + +Elasticdump paginates results automatically using the OpenSearch scroll API. Tune the export with the following options: + +- `--limit ` : controls how many documents Elasticdump pulls per batch. Reduce the value (e.g. `200`) if you experience timeouts. +- `--maxSockets ` : adjusts the number of concurrent HTTP connections. Set it to `1` for strict rate limiting or increase it to accelerate exports on aliases with high throughput. +- `--input-parameters '{"scroll":"10m"}'` : extends the server-side cursor to 10 minutes, useful for large datasets. + +To export specific time windows, modify `search-body.json` with a `range` filter and run several commands in sequence: + +```bash +elasticdump --input https://:@/ \ + --output ./ldp-2024-05-01.json \ + --searchBody '{"query":{"range":{"timestamp":{"gte":"2024-05-01","lt":"2024-05-02"}}}}' + +elasticdump --input https://:@/ \ + --output ./ldp-2024-05-02.json \ + --searchBody '{"query":{"range":{"timestamp":{"gte":"2024-05-02","lt":"2024-05-03"}}}}' +``` + +The `--transform` flag lets you adjust each document before writing it to disk. For example, to remove the `_id` field: + +```bash +elasticdump --input https:/// \ + --output ./ldp.json \ + --searchBody @search-body.json \ + --transform 'delete doc._id; return doc;' +``` + +### Export logs from archive + +To export logs from your archives, we provide a tool to download them: [ldp-archive-mirror](https://github.com/ovh/ldp-archive-mirror). This software requires Python ≥ 3.6 to run. + +First, install ldp-archive-mirror using pip: + +```bash +$ pip3 install -U ldp-archive-mirror +``` + +Then you can use the binary ldp-mirror: + +```text +usage: ldp-mirror [-h] [--app-key KEY] [--app-secret SECRET] + [--consumer-key KEY] [--ovh-region REGION] [--db DIR] + [--mirror DIR] [--ldp-host HOST] [--ldp-token TOKEN] + [--chunk-size CHUNK] [--gpg-passphrase SECRET] + STREAM_ID [STREAM_ID ...] + +LDP archive Mirror CLI - 0.2.0 + +positional arguments: + STREAM_ID LDP Stream UUIDs + +optional arguments: + -h, --help Show this help message and exit + --app-key KEY OVH application key (default: dcd57be8c9dc53ff) + --app-secret SECRET OVH application secret (default: d37f35c27e60be58746e81e3351a84db) + --consumer-key SECRET OVH consumer key (default: 819fb70c64f91f797daf0ed3990e5ff0) + --ovh-region REGION OVH region (default: ovh-eu) + --db DIR Where to place the local sqlite database (default: /data/db) + --mirror DIR Where to place your archives (default: /data/mirror) + --ldp-host HOST If set, push logs of the current application to given LDP hostname + --ldp-token TOKEN If set, push logs of the current application to associated LDP stream token + --chunk-size CHUNK Download chunk size in bytes (default: 16384) + --gpg-passphrase SECRET PGP private key passphrase (default: None) +``` + +Please go to the [github page](https://github.com/ovh/ldp-archive-mirror) to setup this software and obtain the latest information on it. + +## Go further + +For more details on the OpenSearch input plugin, see [the official documentation](https://docs.opensearch.org/latest/tools/logstash/read-from-opensearch/). +The CSV output plugin reference is available [here](https://www.elastic.co/guide/en/logstash/current/plugins-outputs-csv.html). +Documentation for Elasticdump is available [here](https://github.com/elasticsearch-dump/elasticsearch-dump). \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/usecase_extract_logs_from_ldp/meta.yaml b/pages/manage_and_operate/observability/logs_data_platform/usecase_extract_logs_from_ldp/meta.yaml new file mode 100644 index 00000000000..a3b3929fc72 --- /dev/null +++ b/pages/manage_and_operate/observability/logs_data_platform/usecase_extract_logs_from_ldp/meta.yaml @@ -0,0 +1,2 @@ +id: f3b502fe-e20b-46b0-85c2-b8dc076da68e +full_slug: logs-data-platform-extract-logs \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/guide.de-de.md b/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/guide.de-de.md deleted file mode 100644 index 95d5613e3d3..00000000000 --- a/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/guide.de-de.md +++ /dev/null @@ -1,264 +0,0 @@ ---- -title: Analyzing Twitter with Logs Data Platform -excerpt: Logs Data Platform can be used in multiple ways. Twitter feed and keyword analysis is one of them. -updated: 2019-04-10 ---- - -## Objective - -Twitter can be an amazing source to have a direct feedback on your products or events, track a particular subject to find new business opportunities or just to follow the most important people of your network. You can use Logs Data Platform to fully exploit this data flow with the Logstash collector feature and its powerful plugins. This guide will show you how to analyze your tweets using the Logs Data Platform. - -## Requirements - -Prior to completing this guide, you should read the following: - -- [Quick Start of Logs Data Platform](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- [Field naming conventions](/pages/manage_and_operate/observability/logs_data_platform/getting_started_field_naming_convention) -- [Logstash collector](/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input) - -If you have completely understood these three guides, let's dive into this one. - -## Instructions - -### Logstash collector configuration - -#### Twitter application creation - -Logstash has a powerful Twitter Input plugin. This plugin allows you to connect to the Stream API of Twitter and to listen for incoming tweets. In order to do this, it just needs your Twitter account API Keys. They are free and can be retrieved with a Twitter account. Log in your Twitter account in: [https://apps.twitter.com/](https://apps.twitter.com/) and click on create a new app. Fill a name, a description and a website for your project. Read and agree to the Twitter Developer Agreement to proceed. You will then arrive on the application webpage: - -![twitter_app](images/twitter-app.png){.thumbnail} - -From there, head to the **Keys and Access Tokens tab** and click on the **Create my access token** button at the bottom of the page. So you have now a total of 4 keys that identify your access: - -Two main application Keys located at the top: - -- The Consumer Key -- The Consumer Secret - -Two API access Keys located below: - -- The Access Token -- The Access Token Secret - -Note that you can configure the access levels on both your app and tokens. All these keys will be used in the Twitter input plugin of Logstash. Now let's configure our Twitter logstash collector! - -#### Logstash collector creation - -In the Logs Data Platform manager, create a Logstash collector. On the creation page, as usual fill a Name and a Description and leave the default port since it will not be used (The logstash input will connect to Twitter by itself). Also attach your collector to a dedicated stream. The only important thing is to create only one instance. If not, you will have several instances fetching the same data from Twitter and sending it to your stream multiple times. - -![single_instance](images/single_instance.png){.thumbnail} - -#### Twitter input plugin configuration - -Once your collector has been created, head to the configuration page, this is where the real fun begins! To configure your input plugin, you need the Twitter Keys created before. Here is a configuration snippet of the Twitter plugin input: - -```ruby -twitter { - consumer_key => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - consumer_secret => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXx" - oauth_token => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - oauth_token_secret => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - keywords => [ "playstation","Nintendo","xbox"] - type => "tweet" - full_tweet => true -} -``` - -Fill the consumer Keys and Secret with the keys you obtained at the Twitter app configuration step. The oauth_token and the oauth_token_secret are the Access Token and Access Token Secret you created just before. - -The keywords array is the special array where you can specify which keywords you want to follow. Here I want to follow the three different competitors of the famous #ConsoleWars. If you want to follow tweets that contain multiple terms simultaneously you just separate them by a space in the same string. For example: "call of duty" will follow only tweets that contain 'call', 'of' and 'Duty'. You can also just follow a specific Twitter account by using the option **follows**. For more information about the Twitter input, go to the complete [Twitter input documentation](https://www.elastic.co/guide/en/logstash/6.7/plugins-inputs-twitter.html). - -You must use two additional parameters: - -- **type** will be useful for our Logstash filters -- **full_tweet** is here to fetch all the metadata from the tweet. - -#### Filter plugin configuration - -Actually, if you want a minimal Twitter configuration, this could be enough. But our goal is to analyze trends, hashtags, mentions, user activities etc. In order to do this, we need to have at least a clear view of the main objects contained in a tweet: hashtags and mentions. Both of them are normally embedded in a tweet event but Logs Data Platform need flat objects, so we will have to extract them. The goal is to have three different objects: tweets, hashtags and mentions so that we can freely analyze them or correlate them. Here is the filter configuration: - -```ruby -if [type] == "tweet" { - - mutate { - add_field => { - "message" => "%{text}" - "full_message" => "%{text}" - "hashtags" => "%{[entities][hashtags]}" - "mentions" => "%{[entities][user_mentions]}" - "host" => "twitter" - "tweet_url" => "https://twitter.com/%{[user][screen_name]}/status/%{id_str}" - "user_screen_name" => "%{[user][screen_name]}" - "user_id" => "%{[user][id_str]}" - "user_followers_count_int" => "%{[user][followers_count]}" - "user_friends_count_int" => "%{[user][friends_count]}" - "user_listed_count_int" => "%{[user][listed_count]}" - "user_favourites_count_int" => "%{[user][favourites_count]}" - "user_statuses_count_int" => "%{[user][statuses_count]}" - "user_profile_image_url" => "%{[user][profile_image_url_https]}" - "user_verified_bool" => "%{[user][verified]}" - } - remove_field => ["timestamp_ms"] - } - - if [user][profile_banner_url] { - mutate { - add_field => { - "user_profile_banner_url" => "%{[user][profile_banner_url]}" - } - } - } - - if [retweeted_status] { - mutate { - add_field => { - "retweeted_status_user_screen_name" => "%{[retweeted_status][user][screen_name]}" - "retweeted_status_tweet_url" => "https://twitter.com/%{[retweeted_status][user][screen_name]}/status/%{[retweeted_status][id_str]}" - } - } - } - - if [entities][user_mentions] and [type] == "tweet" { - clone { - clones => ["mention"] - } - } - - if [entities][hashtags] and [type] == "tweet" { - clone { - clones => ["hashtag"] - } - } - -} - -if [type] == "hashtag" { - - split { - field => "[entities][hashtags]" - } - - mutate { - add_field => { - "hashtag" => "%{[entities][hashtags][text]}" - "indice_begin_int" => "%{[entities][hashtags][indices][0]}" - "indice_end_int" => "%{[entities][hashtags][indices][1]}" - } - remove_field => [ "retweet_count", "retweeted_status", "user", "text", "filter_level", "favorite_count", "extended_tweet", "entities"] - update => { - "message" => "#%{[entities][hashtags][text]}" - } - } - -} - -if [type] == "mention" { - - split { - field => "[entities][user_mentions]" - } - - mutate { - add_field => { - "mention" => "%{[entities][user_mentions][screen_name]}" - "mention_user_id_" => "%{[entities][user_mentions][id]}" - "indice_begin_int" => "%{[entities][user_mentions][indices][0]}" - "indice_end_int" => "%{[entities][user_mentions][indices][1]}" - } - remove_field => [ "retweet_count", "retweeted_status", "user", "text", "filter_level", "favorite_count", "extended_tweet", "entities"] - update => { - "message" => "@%{[entities][user_mentions][screen_name]}" - } - } - -} -``` - -The configuration looks quite long and complex, it is in fact split into three parts: the *tweet type section*, the *hashtag type section* and the *mention type section* - -- The tweet type section: In this section, we select all the objects that have the *tweet* type. We use the *mutate filter* to extract and move some information at the top level of the event. We also remove unneeded information as id_str or timestamp_ms. Then we use [conditional expressions](https://www.elastic.co/guide/en/logstash/6.7/event-dependent-configuration.html) to extract information and to create hashtags and mentions objects. The *clone filters* will create a new event that will contain a copy of the full tweet and will tag it as a hashtag or mention type. They will execute only if mentions or hashtags are present. -- The hashtag type section: In this section, the hashtags of a tweet will be split into distinct events so a tweet that has 4 hashtags will generate 4 events of type hashtag. That's the purpose of the *split filter*. After the split filter, there is a mutate filter that will promote some information at the top level of the event and remove unnecessary information for this type of object. It will also change the message to the hashtag text itself with the preceding 'hash' character. -- The mention type section: It is pretty much the same as the hashtag one. One *split filter* to create mentions events and one *mutate filter* to extract, delete and modify useful information. - -We could have applied the same process for the media entities for example. The workflow would have been the same: Extract the entities from the tweet by cloning it with the media type, add a media type section with a split and mutate filter to generate different events. - -Now that we have our filter, test the configuration, and then start the collector ! Head to your Graylog Stream attached to the collector to analyze your data! - -### Analyze tweets in Graylog - -Depending on the popularity of your keywords, you may or may not have any information in your stream yet. If you don't have any, check that the input started correctly or try it with more popular subjects:-). Here are some examples of queries you can use in your Graylog stream: - -If you want to know what is the number of tweets over time just type in the Graylog search bar: -``` -type:tweet -``` -This will give you only the tweets without hashtag nor mentions objects. - -To search for a particular subject just type it in the search bar (with double-quotes): -``` -"Final Fantasy XV" -``` - -If you want the hashtags, type: -``` -type:hashtag -``` -This will give you the hashtags list. - -How to list all tweets from @PlayStation? -``` -type:tweet AND user_screen_name:PlayStation -``` - -What are the most popular hashtags? -Use the left panel to select the *Quick Values widget* for the value **hashtag** to display a listing of the most frequent values. - -What are the most popular hashtags associated with Nintendo? -You can combine the query and the quick values by issuing a query in the search bar first: -``` -type:hashtag AND Nintendo. Then use the *Quick Values Widget* again -``` - -Which tweets contain 'xbox'? -``` -type:tweet AND message:*xbox* -``` - -How many times @xboxuk is mentioned? -``` -mention:xboxuk -``` - -In which tweets? -``` -type:tweet AND mentions:*xboxuk* -``` -Note here that we used the *mentions* field (with a final 's') on the tweet to retrieve the mention. Moreover with all objects types, you always have the original tweet message in the full_message field. - -How to list tweets from "popular" users? -``` -type:tweet AND user_followers_count_int:>5000 -``` - -How to list all hashtags on the PlayStation subject except the PlayStation hashtag? -``` -type:hashtag AND playstation AND NOT hashtag:PlayStation -``` - -How to list all tweets except retweets? -``` -type:tweet AND NOT _exists_:retweet_status -``` - -There are many more possibilities. Of course you can create beautiful dashboards from all this information to visualize your data: - -![Dashboards](images/dashboard.png){.thumbnail} - -That's all for now. If you have any proposition or trouble with this tutorial, don't hesitate to reach us on the [Community hub](https://community.ovh.com/en/c/Platform/data-platforms). - -## Go further - -- Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- Documentation: [Guides](/products/observability-logs-data-platform) -- Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) diff --git a/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/guide.en-asia.md b/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/guide.en-asia.md deleted file mode 100644 index 95d5613e3d3..00000000000 --- a/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/guide.en-asia.md +++ /dev/null @@ -1,264 +0,0 @@ ---- -title: Analyzing Twitter with Logs Data Platform -excerpt: Logs Data Platform can be used in multiple ways. Twitter feed and keyword analysis is one of them. -updated: 2019-04-10 ---- - -## Objective - -Twitter can be an amazing source to have a direct feedback on your products or events, track a particular subject to find new business opportunities or just to follow the most important people of your network. You can use Logs Data Platform to fully exploit this data flow with the Logstash collector feature and its powerful plugins. This guide will show you how to analyze your tweets using the Logs Data Platform. - -## Requirements - -Prior to completing this guide, you should read the following: - -- [Quick Start of Logs Data Platform](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- [Field naming conventions](/pages/manage_and_operate/observability/logs_data_platform/getting_started_field_naming_convention) -- [Logstash collector](/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input) - -If you have completely understood these three guides, let's dive into this one. - -## Instructions - -### Logstash collector configuration - -#### Twitter application creation - -Logstash has a powerful Twitter Input plugin. This plugin allows you to connect to the Stream API of Twitter and to listen for incoming tweets. In order to do this, it just needs your Twitter account API Keys. They are free and can be retrieved with a Twitter account. Log in your Twitter account in: [https://apps.twitter.com/](https://apps.twitter.com/) and click on create a new app. Fill a name, a description and a website for your project. Read and agree to the Twitter Developer Agreement to proceed. You will then arrive on the application webpage: - -![twitter_app](images/twitter-app.png){.thumbnail} - -From there, head to the **Keys and Access Tokens tab** and click on the **Create my access token** button at the bottom of the page. So you have now a total of 4 keys that identify your access: - -Two main application Keys located at the top: - -- The Consumer Key -- The Consumer Secret - -Two API access Keys located below: - -- The Access Token -- The Access Token Secret - -Note that you can configure the access levels on both your app and tokens. All these keys will be used in the Twitter input plugin of Logstash. Now let's configure our Twitter logstash collector! - -#### Logstash collector creation - -In the Logs Data Platform manager, create a Logstash collector. On the creation page, as usual fill a Name and a Description and leave the default port since it will not be used (The logstash input will connect to Twitter by itself). Also attach your collector to a dedicated stream. The only important thing is to create only one instance. If not, you will have several instances fetching the same data from Twitter and sending it to your stream multiple times. - -![single_instance](images/single_instance.png){.thumbnail} - -#### Twitter input plugin configuration - -Once your collector has been created, head to the configuration page, this is where the real fun begins! To configure your input plugin, you need the Twitter Keys created before. Here is a configuration snippet of the Twitter plugin input: - -```ruby -twitter { - consumer_key => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - consumer_secret => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXx" - oauth_token => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - oauth_token_secret => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - keywords => [ "playstation","Nintendo","xbox"] - type => "tweet" - full_tweet => true -} -``` - -Fill the consumer Keys and Secret with the keys you obtained at the Twitter app configuration step. The oauth_token and the oauth_token_secret are the Access Token and Access Token Secret you created just before. - -The keywords array is the special array where you can specify which keywords you want to follow. Here I want to follow the three different competitors of the famous #ConsoleWars. If you want to follow tweets that contain multiple terms simultaneously you just separate them by a space in the same string. For example: "call of duty" will follow only tweets that contain 'call', 'of' and 'Duty'. You can also just follow a specific Twitter account by using the option **follows**. For more information about the Twitter input, go to the complete [Twitter input documentation](https://www.elastic.co/guide/en/logstash/6.7/plugins-inputs-twitter.html). - -You must use two additional parameters: - -- **type** will be useful for our Logstash filters -- **full_tweet** is here to fetch all the metadata from the tweet. - -#### Filter plugin configuration - -Actually, if you want a minimal Twitter configuration, this could be enough. But our goal is to analyze trends, hashtags, mentions, user activities etc. In order to do this, we need to have at least a clear view of the main objects contained in a tweet: hashtags and mentions. Both of them are normally embedded in a tweet event but Logs Data Platform need flat objects, so we will have to extract them. The goal is to have three different objects: tweets, hashtags and mentions so that we can freely analyze them or correlate them. Here is the filter configuration: - -```ruby -if [type] == "tweet" { - - mutate { - add_field => { - "message" => "%{text}" - "full_message" => "%{text}" - "hashtags" => "%{[entities][hashtags]}" - "mentions" => "%{[entities][user_mentions]}" - "host" => "twitter" - "tweet_url" => "https://twitter.com/%{[user][screen_name]}/status/%{id_str}" - "user_screen_name" => "%{[user][screen_name]}" - "user_id" => "%{[user][id_str]}" - "user_followers_count_int" => "%{[user][followers_count]}" - "user_friends_count_int" => "%{[user][friends_count]}" - "user_listed_count_int" => "%{[user][listed_count]}" - "user_favourites_count_int" => "%{[user][favourites_count]}" - "user_statuses_count_int" => "%{[user][statuses_count]}" - "user_profile_image_url" => "%{[user][profile_image_url_https]}" - "user_verified_bool" => "%{[user][verified]}" - } - remove_field => ["timestamp_ms"] - } - - if [user][profile_banner_url] { - mutate { - add_field => { - "user_profile_banner_url" => "%{[user][profile_banner_url]}" - } - } - } - - if [retweeted_status] { - mutate { - add_field => { - "retweeted_status_user_screen_name" => "%{[retweeted_status][user][screen_name]}" - "retweeted_status_tweet_url" => "https://twitter.com/%{[retweeted_status][user][screen_name]}/status/%{[retweeted_status][id_str]}" - } - } - } - - if [entities][user_mentions] and [type] == "tweet" { - clone { - clones => ["mention"] - } - } - - if [entities][hashtags] and [type] == "tweet" { - clone { - clones => ["hashtag"] - } - } - -} - -if [type] == "hashtag" { - - split { - field => "[entities][hashtags]" - } - - mutate { - add_field => { - "hashtag" => "%{[entities][hashtags][text]}" - "indice_begin_int" => "%{[entities][hashtags][indices][0]}" - "indice_end_int" => "%{[entities][hashtags][indices][1]}" - } - remove_field => [ "retweet_count", "retweeted_status", "user", "text", "filter_level", "favorite_count", "extended_tweet", "entities"] - update => { - "message" => "#%{[entities][hashtags][text]}" - } - } - -} - -if [type] == "mention" { - - split { - field => "[entities][user_mentions]" - } - - mutate { - add_field => { - "mention" => "%{[entities][user_mentions][screen_name]}" - "mention_user_id_" => "%{[entities][user_mentions][id]}" - "indice_begin_int" => "%{[entities][user_mentions][indices][0]}" - "indice_end_int" => "%{[entities][user_mentions][indices][1]}" - } - remove_field => [ "retweet_count", "retweeted_status", "user", "text", "filter_level", "favorite_count", "extended_tweet", "entities"] - update => { - "message" => "@%{[entities][user_mentions][screen_name]}" - } - } - -} -``` - -The configuration looks quite long and complex, it is in fact split into three parts: the *tweet type section*, the *hashtag type section* and the *mention type section* - -- The tweet type section: In this section, we select all the objects that have the *tweet* type. We use the *mutate filter* to extract and move some information at the top level of the event. We also remove unneeded information as id_str or timestamp_ms. Then we use [conditional expressions](https://www.elastic.co/guide/en/logstash/6.7/event-dependent-configuration.html) to extract information and to create hashtags and mentions objects. The *clone filters* will create a new event that will contain a copy of the full tweet and will tag it as a hashtag or mention type. They will execute only if mentions or hashtags are present. -- The hashtag type section: In this section, the hashtags of a tweet will be split into distinct events so a tweet that has 4 hashtags will generate 4 events of type hashtag. That's the purpose of the *split filter*. After the split filter, there is a mutate filter that will promote some information at the top level of the event and remove unnecessary information for this type of object. It will also change the message to the hashtag text itself with the preceding 'hash' character. -- The mention type section: It is pretty much the same as the hashtag one. One *split filter* to create mentions events and one *mutate filter* to extract, delete and modify useful information. - -We could have applied the same process for the media entities for example. The workflow would have been the same: Extract the entities from the tweet by cloning it with the media type, add a media type section with a split and mutate filter to generate different events. - -Now that we have our filter, test the configuration, and then start the collector ! Head to your Graylog Stream attached to the collector to analyze your data! - -### Analyze tweets in Graylog - -Depending on the popularity of your keywords, you may or may not have any information in your stream yet. If you don't have any, check that the input started correctly or try it with more popular subjects:-). Here are some examples of queries you can use in your Graylog stream: - -If you want to know what is the number of tweets over time just type in the Graylog search bar: -``` -type:tweet -``` -This will give you only the tweets without hashtag nor mentions objects. - -To search for a particular subject just type it in the search bar (with double-quotes): -``` -"Final Fantasy XV" -``` - -If you want the hashtags, type: -``` -type:hashtag -``` -This will give you the hashtags list. - -How to list all tweets from @PlayStation? -``` -type:tweet AND user_screen_name:PlayStation -``` - -What are the most popular hashtags? -Use the left panel to select the *Quick Values widget* for the value **hashtag** to display a listing of the most frequent values. - -What are the most popular hashtags associated with Nintendo? -You can combine the query and the quick values by issuing a query in the search bar first: -``` -type:hashtag AND Nintendo. Then use the *Quick Values Widget* again -``` - -Which tweets contain 'xbox'? -``` -type:tweet AND message:*xbox* -``` - -How many times @xboxuk is mentioned? -``` -mention:xboxuk -``` - -In which tweets? -``` -type:tweet AND mentions:*xboxuk* -``` -Note here that we used the *mentions* field (with a final 's') on the tweet to retrieve the mention. Moreover with all objects types, you always have the original tweet message in the full_message field. - -How to list tweets from "popular" users? -``` -type:tweet AND user_followers_count_int:>5000 -``` - -How to list all hashtags on the PlayStation subject except the PlayStation hashtag? -``` -type:hashtag AND playstation AND NOT hashtag:PlayStation -``` - -How to list all tweets except retweets? -``` -type:tweet AND NOT _exists_:retweet_status -``` - -There are many more possibilities. Of course you can create beautiful dashboards from all this information to visualize your data: - -![Dashboards](images/dashboard.png){.thumbnail} - -That's all for now. If you have any proposition or trouble with this tutorial, don't hesitate to reach us on the [Community hub](https://community.ovh.com/en/c/Platform/data-platforms). - -## Go further - -- Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- Documentation: [Guides](/products/observability-logs-data-platform) -- Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) diff --git a/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/guide.en-au.md b/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/guide.en-au.md deleted file mode 100644 index 95d5613e3d3..00000000000 --- a/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/guide.en-au.md +++ /dev/null @@ -1,264 +0,0 @@ ---- -title: Analyzing Twitter with Logs Data Platform -excerpt: Logs Data Platform can be used in multiple ways. Twitter feed and keyword analysis is one of them. -updated: 2019-04-10 ---- - -## Objective - -Twitter can be an amazing source to have a direct feedback on your products or events, track a particular subject to find new business opportunities or just to follow the most important people of your network. You can use Logs Data Platform to fully exploit this data flow with the Logstash collector feature and its powerful plugins. This guide will show you how to analyze your tweets using the Logs Data Platform. - -## Requirements - -Prior to completing this guide, you should read the following: - -- [Quick Start of Logs Data Platform](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- [Field naming conventions](/pages/manage_and_operate/observability/logs_data_platform/getting_started_field_naming_convention) -- [Logstash collector](/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input) - -If you have completely understood these three guides, let's dive into this one. - -## Instructions - -### Logstash collector configuration - -#### Twitter application creation - -Logstash has a powerful Twitter Input plugin. This plugin allows you to connect to the Stream API of Twitter and to listen for incoming tweets. In order to do this, it just needs your Twitter account API Keys. They are free and can be retrieved with a Twitter account. Log in your Twitter account in: [https://apps.twitter.com/](https://apps.twitter.com/) and click on create a new app. Fill a name, a description and a website for your project. Read and agree to the Twitter Developer Agreement to proceed. You will then arrive on the application webpage: - -![twitter_app](images/twitter-app.png){.thumbnail} - -From there, head to the **Keys and Access Tokens tab** and click on the **Create my access token** button at the bottom of the page. So you have now a total of 4 keys that identify your access: - -Two main application Keys located at the top: - -- The Consumer Key -- The Consumer Secret - -Two API access Keys located below: - -- The Access Token -- The Access Token Secret - -Note that you can configure the access levels on both your app and tokens. All these keys will be used in the Twitter input plugin of Logstash. Now let's configure our Twitter logstash collector! - -#### Logstash collector creation - -In the Logs Data Platform manager, create a Logstash collector. On the creation page, as usual fill a Name and a Description and leave the default port since it will not be used (The logstash input will connect to Twitter by itself). Also attach your collector to a dedicated stream. The only important thing is to create only one instance. If not, you will have several instances fetching the same data from Twitter and sending it to your stream multiple times. - -![single_instance](images/single_instance.png){.thumbnail} - -#### Twitter input plugin configuration - -Once your collector has been created, head to the configuration page, this is where the real fun begins! To configure your input plugin, you need the Twitter Keys created before. Here is a configuration snippet of the Twitter plugin input: - -```ruby -twitter { - consumer_key => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - consumer_secret => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXx" - oauth_token => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - oauth_token_secret => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - keywords => [ "playstation","Nintendo","xbox"] - type => "tweet" - full_tweet => true -} -``` - -Fill the consumer Keys and Secret with the keys you obtained at the Twitter app configuration step. The oauth_token and the oauth_token_secret are the Access Token and Access Token Secret you created just before. - -The keywords array is the special array where you can specify which keywords you want to follow. Here I want to follow the three different competitors of the famous #ConsoleWars. If you want to follow tweets that contain multiple terms simultaneously you just separate them by a space in the same string. For example: "call of duty" will follow only tweets that contain 'call', 'of' and 'Duty'. You can also just follow a specific Twitter account by using the option **follows**. For more information about the Twitter input, go to the complete [Twitter input documentation](https://www.elastic.co/guide/en/logstash/6.7/plugins-inputs-twitter.html). - -You must use two additional parameters: - -- **type** will be useful for our Logstash filters -- **full_tweet** is here to fetch all the metadata from the tweet. - -#### Filter plugin configuration - -Actually, if you want a minimal Twitter configuration, this could be enough. But our goal is to analyze trends, hashtags, mentions, user activities etc. In order to do this, we need to have at least a clear view of the main objects contained in a tweet: hashtags and mentions. Both of them are normally embedded in a tweet event but Logs Data Platform need flat objects, so we will have to extract them. The goal is to have three different objects: tweets, hashtags and mentions so that we can freely analyze them or correlate them. Here is the filter configuration: - -```ruby -if [type] == "tweet" { - - mutate { - add_field => { - "message" => "%{text}" - "full_message" => "%{text}" - "hashtags" => "%{[entities][hashtags]}" - "mentions" => "%{[entities][user_mentions]}" - "host" => "twitter" - "tweet_url" => "https://twitter.com/%{[user][screen_name]}/status/%{id_str}" - "user_screen_name" => "%{[user][screen_name]}" - "user_id" => "%{[user][id_str]}" - "user_followers_count_int" => "%{[user][followers_count]}" - "user_friends_count_int" => "%{[user][friends_count]}" - "user_listed_count_int" => "%{[user][listed_count]}" - "user_favourites_count_int" => "%{[user][favourites_count]}" - "user_statuses_count_int" => "%{[user][statuses_count]}" - "user_profile_image_url" => "%{[user][profile_image_url_https]}" - "user_verified_bool" => "%{[user][verified]}" - } - remove_field => ["timestamp_ms"] - } - - if [user][profile_banner_url] { - mutate { - add_field => { - "user_profile_banner_url" => "%{[user][profile_banner_url]}" - } - } - } - - if [retweeted_status] { - mutate { - add_field => { - "retweeted_status_user_screen_name" => "%{[retweeted_status][user][screen_name]}" - "retweeted_status_tweet_url" => "https://twitter.com/%{[retweeted_status][user][screen_name]}/status/%{[retweeted_status][id_str]}" - } - } - } - - if [entities][user_mentions] and [type] == "tweet" { - clone { - clones => ["mention"] - } - } - - if [entities][hashtags] and [type] == "tweet" { - clone { - clones => ["hashtag"] - } - } - -} - -if [type] == "hashtag" { - - split { - field => "[entities][hashtags]" - } - - mutate { - add_field => { - "hashtag" => "%{[entities][hashtags][text]}" - "indice_begin_int" => "%{[entities][hashtags][indices][0]}" - "indice_end_int" => "%{[entities][hashtags][indices][1]}" - } - remove_field => [ "retweet_count", "retweeted_status", "user", "text", "filter_level", "favorite_count", "extended_tweet", "entities"] - update => { - "message" => "#%{[entities][hashtags][text]}" - } - } - -} - -if [type] == "mention" { - - split { - field => "[entities][user_mentions]" - } - - mutate { - add_field => { - "mention" => "%{[entities][user_mentions][screen_name]}" - "mention_user_id_" => "%{[entities][user_mentions][id]}" - "indice_begin_int" => "%{[entities][user_mentions][indices][0]}" - "indice_end_int" => "%{[entities][user_mentions][indices][1]}" - } - remove_field => [ "retweet_count", "retweeted_status", "user", "text", "filter_level", "favorite_count", "extended_tweet", "entities"] - update => { - "message" => "@%{[entities][user_mentions][screen_name]}" - } - } - -} -``` - -The configuration looks quite long and complex, it is in fact split into three parts: the *tweet type section*, the *hashtag type section* and the *mention type section* - -- The tweet type section: In this section, we select all the objects that have the *tweet* type. We use the *mutate filter* to extract and move some information at the top level of the event. We also remove unneeded information as id_str or timestamp_ms. Then we use [conditional expressions](https://www.elastic.co/guide/en/logstash/6.7/event-dependent-configuration.html) to extract information and to create hashtags and mentions objects. The *clone filters* will create a new event that will contain a copy of the full tweet and will tag it as a hashtag or mention type. They will execute only if mentions or hashtags are present. -- The hashtag type section: In this section, the hashtags of a tweet will be split into distinct events so a tweet that has 4 hashtags will generate 4 events of type hashtag. That's the purpose of the *split filter*. After the split filter, there is a mutate filter that will promote some information at the top level of the event and remove unnecessary information for this type of object. It will also change the message to the hashtag text itself with the preceding 'hash' character. -- The mention type section: It is pretty much the same as the hashtag one. One *split filter* to create mentions events and one *mutate filter* to extract, delete and modify useful information. - -We could have applied the same process for the media entities for example. The workflow would have been the same: Extract the entities from the tweet by cloning it with the media type, add a media type section with a split and mutate filter to generate different events. - -Now that we have our filter, test the configuration, and then start the collector ! Head to your Graylog Stream attached to the collector to analyze your data! - -### Analyze tweets in Graylog - -Depending on the popularity of your keywords, you may or may not have any information in your stream yet. If you don't have any, check that the input started correctly or try it with more popular subjects:-). Here are some examples of queries you can use in your Graylog stream: - -If you want to know what is the number of tweets over time just type in the Graylog search bar: -``` -type:tweet -``` -This will give you only the tweets without hashtag nor mentions objects. - -To search for a particular subject just type it in the search bar (with double-quotes): -``` -"Final Fantasy XV" -``` - -If you want the hashtags, type: -``` -type:hashtag -``` -This will give you the hashtags list. - -How to list all tweets from @PlayStation? -``` -type:tweet AND user_screen_name:PlayStation -``` - -What are the most popular hashtags? -Use the left panel to select the *Quick Values widget* for the value **hashtag** to display a listing of the most frequent values. - -What are the most popular hashtags associated with Nintendo? -You can combine the query and the quick values by issuing a query in the search bar first: -``` -type:hashtag AND Nintendo. Then use the *Quick Values Widget* again -``` - -Which tweets contain 'xbox'? -``` -type:tweet AND message:*xbox* -``` - -How many times @xboxuk is mentioned? -``` -mention:xboxuk -``` - -In which tweets? -``` -type:tweet AND mentions:*xboxuk* -``` -Note here that we used the *mentions* field (with a final 's') on the tweet to retrieve the mention. Moreover with all objects types, you always have the original tweet message in the full_message field. - -How to list tweets from "popular" users? -``` -type:tweet AND user_followers_count_int:>5000 -``` - -How to list all hashtags on the PlayStation subject except the PlayStation hashtag? -``` -type:hashtag AND playstation AND NOT hashtag:PlayStation -``` - -How to list all tweets except retweets? -``` -type:tweet AND NOT _exists_:retweet_status -``` - -There are many more possibilities. Of course you can create beautiful dashboards from all this information to visualize your data: - -![Dashboards](images/dashboard.png){.thumbnail} - -That's all for now. If you have any proposition or trouble with this tutorial, don't hesitate to reach us on the [Community hub](https://community.ovh.com/en/c/Platform/data-platforms). - -## Go further - -- Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- Documentation: [Guides](/products/observability-logs-data-platform) -- Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) diff --git a/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/guide.en-ca.md b/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/guide.en-ca.md deleted file mode 100644 index 95d5613e3d3..00000000000 --- a/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/guide.en-ca.md +++ /dev/null @@ -1,264 +0,0 @@ ---- -title: Analyzing Twitter with Logs Data Platform -excerpt: Logs Data Platform can be used in multiple ways. Twitter feed and keyword analysis is one of them. -updated: 2019-04-10 ---- - -## Objective - -Twitter can be an amazing source to have a direct feedback on your products or events, track a particular subject to find new business opportunities or just to follow the most important people of your network. You can use Logs Data Platform to fully exploit this data flow with the Logstash collector feature and its powerful plugins. This guide will show you how to analyze your tweets using the Logs Data Platform. - -## Requirements - -Prior to completing this guide, you should read the following: - -- [Quick Start of Logs Data Platform](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- [Field naming conventions](/pages/manage_and_operate/observability/logs_data_platform/getting_started_field_naming_convention) -- [Logstash collector](/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input) - -If you have completely understood these three guides, let's dive into this one. - -## Instructions - -### Logstash collector configuration - -#### Twitter application creation - -Logstash has a powerful Twitter Input plugin. This plugin allows you to connect to the Stream API of Twitter and to listen for incoming tweets. In order to do this, it just needs your Twitter account API Keys. They are free and can be retrieved with a Twitter account. Log in your Twitter account in: [https://apps.twitter.com/](https://apps.twitter.com/) and click on create a new app. Fill a name, a description and a website for your project. Read and agree to the Twitter Developer Agreement to proceed. You will then arrive on the application webpage: - -![twitter_app](images/twitter-app.png){.thumbnail} - -From there, head to the **Keys and Access Tokens tab** and click on the **Create my access token** button at the bottom of the page. So you have now a total of 4 keys that identify your access: - -Two main application Keys located at the top: - -- The Consumer Key -- The Consumer Secret - -Two API access Keys located below: - -- The Access Token -- The Access Token Secret - -Note that you can configure the access levels on both your app and tokens. All these keys will be used in the Twitter input plugin of Logstash. Now let's configure our Twitter logstash collector! - -#### Logstash collector creation - -In the Logs Data Platform manager, create a Logstash collector. On the creation page, as usual fill a Name and a Description and leave the default port since it will not be used (The logstash input will connect to Twitter by itself). Also attach your collector to a dedicated stream. The only important thing is to create only one instance. If not, you will have several instances fetching the same data from Twitter and sending it to your stream multiple times. - -![single_instance](images/single_instance.png){.thumbnail} - -#### Twitter input plugin configuration - -Once your collector has been created, head to the configuration page, this is where the real fun begins! To configure your input plugin, you need the Twitter Keys created before. Here is a configuration snippet of the Twitter plugin input: - -```ruby -twitter { - consumer_key => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - consumer_secret => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXx" - oauth_token => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - oauth_token_secret => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - keywords => [ "playstation","Nintendo","xbox"] - type => "tweet" - full_tweet => true -} -``` - -Fill the consumer Keys and Secret with the keys you obtained at the Twitter app configuration step. The oauth_token and the oauth_token_secret are the Access Token and Access Token Secret you created just before. - -The keywords array is the special array where you can specify which keywords you want to follow. Here I want to follow the three different competitors of the famous #ConsoleWars. If you want to follow tweets that contain multiple terms simultaneously you just separate them by a space in the same string. For example: "call of duty" will follow only tweets that contain 'call', 'of' and 'Duty'. You can also just follow a specific Twitter account by using the option **follows**. For more information about the Twitter input, go to the complete [Twitter input documentation](https://www.elastic.co/guide/en/logstash/6.7/plugins-inputs-twitter.html). - -You must use two additional parameters: - -- **type** will be useful for our Logstash filters -- **full_tweet** is here to fetch all the metadata from the tweet. - -#### Filter plugin configuration - -Actually, if you want a minimal Twitter configuration, this could be enough. But our goal is to analyze trends, hashtags, mentions, user activities etc. In order to do this, we need to have at least a clear view of the main objects contained in a tweet: hashtags and mentions. Both of them are normally embedded in a tweet event but Logs Data Platform need flat objects, so we will have to extract them. The goal is to have three different objects: tweets, hashtags and mentions so that we can freely analyze them or correlate them. Here is the filter configuration: - -```ruby -if [type] == "tweet" { - - mutate { - add_field => { - "message" => "%{text}" - "full_message" => "%{text}" - "hashtags" => "%{[entities][hashtags]}" - "mentions" => "%{[entities][user_mentions]}" - "host" => "twitter" - "tweet_url" => "https://twitter.com/%{[user][screen_name]}/status/%{id_str}" - "user_screen_name" => "%{[user][screen_name]}" - "user_id" => "%{[user][id_str]}" - "user_followers_count_int" => "%{[user][followers_count]}" - "user_friends_count_int" => "%{[user][friends_count]}" - "user_listed_count_int" => "%{[user][listed_count]}" - "user_favourites_count_int" => "%{[user][favourites_count]}" - "user_statuses_count_int" => "%{[user][statuses_count]}" - "user_profile_image_url" => "%{[user][profile_image_url_https]}" - "user_verified_bool" => "%{[user][verified]}" - } - remove_field => ["timestamp_ms"] - } - - if [user][profile_banner_url] { - mutate { - add_field => { - "user_profile_banner_url" => "%{[user][profile_banner_url]}" - } - } - } - - if [retweeted_status] { - mutate { - add_field => { - "retweeted_status_user_screen_name" => "%{[retweeted_status][user][screen_name]}" - "retweeted_status_tweet_url" => "https://twitter.com/%{[retweeted_status][user][screen_name]}/status/%{[retweeted_status][id_str]}" - } - } - } - - if [entities][user_mentions] and [type] == "tweet" { - clone { - clones => ["mention"] - } - } - - if [entities][hashtags] and [type] == "tweet" { - clone { - clones => ["hashtag"] - } - } - -} - -if [type] == "hashtag" { - - split { - field => "[entities][hashtags]" - } - - mutate { - add_field => { - "hashtag" => "%{[entities][hashtags][text]}" - "indice_begin_int" => "%{[entities][hashtags][indices][0]}" - "indice_end_int" => "%{[entities][hashtags][indices][1]}" - } - remove_field => [ "retweet_count", "retweeted_status", "user", "text", "filter_level", "favorite_count", "extended_tweet", "entities"] - update => { - "message" => "#%{[entities][hashtags][text]}" - } - } - -} - -if [type] == "mention" { - - split { - field => "[entities][user_mentions]" - } - - mutate { - add_field => { - "mention" => "%{[entities][user_mentions][screen_name]}" - "mention_user_id_" => "%{[entities][user_mentions][id]}" - "indice_begin_int" => "%{[entities][user_mentions][indices][0]}" - "indice_end_int" => "%{[entities][user_mentions][indices][1]}" - } - remove_field => [ "retweet_count", "retweeted_status", "user", "text", "filter_level", "favorite_count", "extended_tweet", "entities"] - update => { - "message" => "@%{[entities][user_mentions][screen_name]}" - } - } - -} -``` - -The configuration looks quite long and complex, it is in fact split into three parts: the *tweet type section*, the *hashtag type section* and the *mention type section* - -- The tweet type section: In this section, we select all the objects that have the *tweet* type. We use the *mutate filter* to extract and move some information at the top level of the event. We also remove unneeded information as id_str or timestamp_ms. Then we use [conditional expressions](https://www.elastic.co/guide/en/logstash/6.7/event-dependent-configuration.html) to extract information and to create hashtags and mentions objects. The *clone filters* will create a new event that will contain a copy of the full tweet and will tag it as a hashtag or mention type. They will execute only if mentions or hashtags are present. -- The hashtag type section: In this section, the hashtags of a tweet will be split into distinct events so a tweet that has 4 hashtags will generate 4 events of type hashtag. That's the purpose of the *split filter*. After the split filter, there is a mutate filter that will promote some information at the top level of the event and remove unnecessary information for this type of object. It will also change the message to the hashtag text itself with the preceding 'hash' character. -- The mention type section: It is pretty much the same as the hashtag one. One *split filter* to create mentions events and one *mutate filter* to extract, delete and modify useful information. - -We could have applied the same process for the media entities for example. The workflow would have been the same: Extract the entities from the tweet by cloning it with the media type, add a media type section with a split and mutate filter to generate different events. - -Now that we have our filter, test the configuration, and then start the collector ! Head to your Graylog Stream attached to the collector to analyze your data! - -### Analyze tweets in Graylog - -Depending on the popularity of your keywords, you may or may not have any information in your stream yet. If you don't have any, check that the input started correctly or try it with more popular subjects:-). Here are some examples of queries you can use in your Graylog stream: - -If you want to know what is the number of tweets over time just type in the Graylog search bar: -``` -type:tweet -``` -This will give you only the tweets without hashtag nor mentions objects. - -To search for a particular subject just type it in the search bar (with double-quotes): -``` -"Final Fantasy XV" -``` - -If you want the hashtags, type: -``` -type:hashtag -``` -This will give you the hashtags list. - -How to list all tweets from @PlayStation? -``` -type:tweet AND user_screen_name:PlayStation -``` - -What are the most popular hashtags? -Use the left panel to select the *Quick Values widget* for the value **hashtag** to display a listing of the most frequent values. - -What are the most popular hashtags associated with Nintendo? -You can combine the query and the quick values by issuing a query in the search bar first: -``` -type:hashtag AND Nintendo. Then use the *Quick Values Widget* again -``` - -Which tweets contain 'xbox'? -``` -type:tweet AND message:*xbox* -``` - -How many times @xboxuk is mentioned? -``` -mention:xboxuk -``` - -In which tweets? -``` -type:tweet AND mentions:*xboxuk* -``` -Note here that we used the *mentions* field (with a final 's') on the tweet to retrieve the mention. Moreover with all objects types, you always have the original tweet message in the full_message field. - -How to list tweets from "popular" users? -``` -type:tweet AND user_followers_count_int:>5000 -``` - -How to list all hashtags on the PlayStation subject except the PlayStation hashtag? -``` -type:hashtag AND playstation AND NOT hashtag:PlayStation -``` - -How to list all tweets except retweets? -``` -type:tweet AND NOT _exists_:retweet_status -``` - -There are many more possibilities. Of course you can create beautiful dashboards from all this information to visualize your data: - -![Dashboards](images/dashboard.png){.thumbnail} - -That's all for now. If you have any proposition or trouble with this tutorial, don't hesitate to reach us on the [Community hub](https://community.ovh.com/en/c/Platform/data-platforms). - -## Go further - -- Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- Documentation: [Guides](/products/observability-logs-data-platform) -- Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) diff --git a/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/guide.en-gb.md b/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/guide.en-gb.md deleted file mode 100644 index 95d5613e3d3..00000000000 --- a/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/guide.en-gb.md +++ /dev/null @@ -1,264 +0,0 @@ ---- -title: Analyzing Twitter with Logs Data Platform -excerpt: Logs Data Platform can be used in multiple ways. Twitter feed and keyword analysis is one of them. -updated: 2019-04-10 ---- - -## Objective - -Twitter can be an amazing source to have a direct feedback on your products or events, track a particular subject to find new business opportunities or just to follow the most important people of your network. You can use Logs Data Platform to fully exploit this data flow with the Logstash collector feature and its powerful plugins. This guide will show you how to analyze your tweets using the Logs Data Platform. - -## Requirements - -Prior to completing this guide, you should read the following: - -- [Quick Start of Logs Data Platform](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- [Field naming conventions](/pages/manage_and_operate/observability/logs_data_platform/getting_started_field_naming_convention) -- [Logstash collector](/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input) - -If you have completely understood these three guides, let's dive into this one. - -## Instructions - -### Logstash collector configuration - -#### Twitter application creation - -Logstash has a powerful Twitter Input plugin. This plugin allows you to connect to the Stream API of Twitter and to listen for incoming tweets. In order to do this, it just needs your Twitter account API Keys. They are free and can be retrieved with a Twitter account. Log in your Twitter account in: [https://apps.twitter.com/](https://apps.twitter.com/) and click on create a new app. Fill a name, a description and a website for your project. Read and agree to the Twitter Developer Agreement to proceed. You will then arrive on the application webpage: - -![twitter_app](images/twitter-app.png){.thumbnail} - -From there, head to the **Keys and Access Tokens tab** and click on the **Create my access token** button at the bottom of the page. So you have now a total of 4 keys that identify your access: - -Two main application Keys located at the top: - -- The Consumer Key -- The Consumer Secret - -Two API access Keys located below: - -- The Access Token -- The Access Token Secret - -Note that you can configure the access levels on both your app and tokens. All these keys will be used in the Twitter input plugin of Logstash. Now let's configure our Twitter logstash collector! - -#### Logstash collector creation - -In the Logs Data Platform manager, create a Logstash collector. On the creation page, as usual fill a Name and a Description and leave the default port since it will not be used (The logstash input will connect to Twitter by itself). Also attach your collector to a dedicated stream. The only important thing is to create only one instance. If not, you will have several instances fetching the same data from Twitter and sending it to your stream multiple times. - -![single_instance](images/single_instance.png){.thumbnail} - -#### Twitter input plugin configuration - -Once your collector has been created, head to the configuration page, this is where the real fun begins! To configure your input plugin, you need the Twitter Keys created before. Here is a configuration snippet of the Twitter plugin input: - -```ruby -twitter { - consumer_key => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - consumer_secret => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXx" - oauth_token => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - oauth_token_secret => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - keywords => [ "playstation","Nintendo","xbox"] - type => "tweet" - full_tweet => true -} -``` - -Fill the consumer Keys and Secret with the keys you obtained at the Twitter app configuration step. The oauth_token and the oauth_token_secret are the Access Token and Access Token Secret you created just before. - -The keywords array is the special array where you can specify which keywords you want to follow. Here I want to follow the three different competitors of the famous #ConsoleWars. If you want to follow tweets that contain multiple terms simultaneously you just separate them by a space in the same string. For example: "call of duty" will follow only tweets that contain 'call', 'of' and 'Duty'. You can also just follow a specific Twitter account by using the option **follows**. For more information about the Twitter input, go to the complete [Twitter input documentation](https://www.elastic.co/guide/en/logstash/6.7/plugins-inputs-twitter.html). - -You must use two additional parameters: - -- **type** will be useful for our Logstash filters -- **full_tweet** is here to fetch all the metadata from the tweet. - -#### Filter plugin configuration - -Actually, if you want a minimal Twitter configuration, this could be enough. But our goal is to analyze trends, hashtags, mentions, user activities etc. In order to do this, we need to have at least a clear view of the main objects contained in a tweet: hashtags and mentions. Both of them are normally embedded in a tweet event but Logs Data Platform need flat objects, so we will have to extract them. The goal is to have three different objects: tweets, hashtags and mentions so that we can freely analyze them or correlate them. Here is the filter configuration: - -```ruby -if [type] == "tweet" { - - mutate { - add_field => { - "message" => "%{text}" - "full_message" => "%{text}" - "hashtags" => "%{[entities][hashtags]}" - "mentions" => "%{[entities][user_mentions]}" - "host" => "twitter" - "tweet_url" => "https://twitter.com/%{[user][screen_name]}/status/%{id_str}" - "user_screen_name" => "%{[user][screen_name]}" - "user_id" => "%{[user][id_str]}" - "user_followers_count_int" => "%{[user][followers_count]}" - "user_friends_count_int" => "%{[user][friends_count]}" - "user_listed_count_int" => "%{[user][listed_count]}" - "user_favourites_count_int" => "%{[user][favourites_count]}" - "user_statuses_count_int" => "%{[user][statuses_count]}" - "user_profile_image_url" => "%{[user][profile_image_url_https]}" - "user_verified_bool" => "%{[user][verified]}" - } - remove_field => ["timestamp_ms"] - } - - if [user][profile_banner_url] { - mutate { - add_field => { - "user_profile_banner_url" => "%{[user][profile_banner_url]}" - } - } - } - - if [retweeted_status] { - mutate { - add_field => { - "retweeted_status_user_screen_name" => "%{[retweeted_status][user][screen_name]}" - "retweeted_status_tweet_url" => "https://twitter.com/%{[retweeted_status][user][screen_name]}/status/%{[retweeted_status][id_str]}" - } - } - } - - if [entities][user_mentions] and [type] == "tweet" { - clone { - clones => ["mention"] - } - } - - if [entities][hashtags] and [type] == "tweet" { - clone { - clones => ["hashtag"] - } - } - -} - -if [type] == "hashtag" { - - split { - field => "[entities][hashtags]" - } - - mutate { - add_field => { - "hashtag" => "%{[entities][hashtags][text]}" - "indice_begin_int" => "%{[entities][hashtags][indices][0]}" - "indice_end_int" => "%{[entities][hashtags][indices][1]}" - } - remove_field => [ "retweet_count", "retweeted_status", "user", "text", "filter_level", "favorite_count", "extended_tweet", "entities"] - update => { - "message" => "#%{[entities][hashtags][text]}" - } - } - -} - -if [type] == "mention" { - - split { - field => "[entities][user_mentions]" - } - - mutate { - add_field => { - "mention" => "%{[entities][user_mentions][screen_name]}" - "mention_user_id_" => "%{[entities][user_mentions][id]}" - "indice_begin_int" => "%{[entities][user_mentions][indices][0]}" - "indice_end_int" => "%{[entities][user_mentions][indices][1]}" - } - remove_field => [ "retweet_count", "retweeted_status", "user", "text", "filter_level", "favorite_count", "extended_tweet", "entities"] - update => { - "message" => "@%{[entities][user_mentions][screen_name]}" - } - } - -} -``` - -The configuration looks quite long and complex, it is in fact split into three parts: the *tweet type section*, the *hashtag type section* and the *mention type section* - -- The tweet type section: In this section, we select all the objects that have the *tweet* type. We use the *mutate filter* to extract and move some information at the top level of the event. We also remove unneeded information as id_str or timestamp_ms. Then we use [conditional expressions](https://www.elastic.co/guide/en/logstash/6.7/event-dependent-configuration.html) to extract information and to create hashtags and mentions objects. The *clone filters* will create a new event that will contain a copy of the full tweet and will tag it as a hashtag or mention type. They will execute only if mentions or hashtags are present. -- The hashtag type section: In this section, the hashtags of a tweet will be split into distinct events so a tweet that has 4 hashtags will generate 4 events of type hashtag. That's the purpose of the *split filter*. After the split filter, there is a mutate filter that will promote some information at the top level of the event and remove unnecessary information for this type of object. It will also change the message to the hashtag text itself with the preceding 'hash' character. -- The mention type section: It is pretty much the same as the hashtag one. One *split filter* to create mentions events and one *mutate filter* to extract, delete and modify useful information. - -We could have applied the same process for the media entities for example. The workflow would have been the same: Extract the entities from the tweet by cloning it with the media type, add a media type section with a split and mutate filter to generate different events. - -Now that we have our filter, test the configuration, and then start the collector ! Head to your Graylog Stream attached to the collector to analyze your data! - -### Analyze tweets in Graylog - -Depending on the popularity of your keywords, you may or may not have any information in your stream yet. If you don't have any, check that the input started correctly or try it with more popular subjects:-). Here are some examples of queries you can use in your Graylog stream: - -If you want to know what is the number of tweets over time just type in the Graylog search bar: -``` -type:tweet -``` -This will give you only the tweets without hashtag nor mentions objects. - -To search for a particular subject just type it in the search bar (with double-quotes): -``` -"Final Fantasy XV" -``` - -If you want the hashtags, type: -``` -type:hashtag -``` -This will give you the hashtags list. - -How to list all tweets from @PlayStation? -``` -type:tweet AND user_screen_name:PlayStation -``` - -What are the most popular hashtags? -Use the left panel to select the *Quick Values widget* for the value **hashtag** to display a listing of the most frequent values. - -What are the most popular hashtags associated with Nintendo? -You can combine the query and the quick values by issuing a query in the search bar first: -``` -type:hashtag AND Nintendo. Then use the *Quick Values Widget* again -``` - -Which tweets contain 'xbox'? -``` -type:tweet AND message:*xbox* -``` - -How many times @xboxuk is mentioned? -``` -mention:xboxuk -``` - -In which tweets? -``` -type:tweet AND mentions:*xboxuk* -``` -Note here that we used the *mentions* field (with a final 's') on the tweet to retrieve the mention. Moreover with all objects types, you always have the original tweet message in the full_message field. - -How to list tweets from "popular" users? -``` -type:tweet AND user_followers_count_int:>5000 -``` - -How to list all hashtags on the PlayStation subject except the PlayStation hashtag? -``` -type:hashtag AND playstation AND NOT hashtag:PlayStation -``` - -How to list all tweets except retweets? -``` -type:tweet AND NOT _exists_:retweet_status -``` - -There are many more possibilities. Of course you can create beautiful dashboards from all this information to visualize your data: - -![Dashboards](images/dashboard.png){.thumbnail} - -That's all for now. If you have any proposition or trouble with this tutorial, don't hesitate to reach us on the [Community hub](https://community.ovh.com/en/c/Platform/data-platforms). - -## Go further - -- Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- Documentation: [Guides](/products/observability-logs-data-platform) -- Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) diff --git a/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/guide.en-ie.md b/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/guide.en-ie.md deleted file mode 100644 index 95d5613e3d3..00000000000 --- a/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/guide.en-ie.md +++ /dev/null @@ -1,264 +0,0 @@ ---- -title: Analyzing Twitter with Logs Data Platform -excerpt: Logs Data Platform can be used in multiple ways. Twitter feed and keyword analysis is one of them. -updated: 2019-04-10 ---- - -## Objective - -Twitter can be an amazing source to have a direct feedback on your products or events, track a particular subject to find new business opportunities or just to follow the most important people of your network. You can use Logs Data Platform to fully exploit this data flow with the Logstash collector feature and its powerful plugins. This guide will show you how to analyze your tweets using the Logs Data Platform. - -## Requirements - -Prior to completing this guide, you should read the following: - -- [Quick Start of Logs Data Platform](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- [Field naming conventions](/pages/manage_and_operate/observability/logs_data_platform/getting_started_field_naming_convention) -- [Logstash collector](/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input) - -If you have completely understood these three guides, let's dive into this one. - -## Instructions - -### Logstash collector configuration - -#### Twitter application creation - -Logstash has a powerful Twitter Input plugin. This plugin allows you to connect to the Stream API of Twitter and to listen for incoming tweets. In order to do this, it just needs your Twitter account API Keys. They are free and can be retrieved with a Twitter account. Log in your Twitter account in: [https://apps.twitter.com/](https://apps.twitter.com/) and click on create a new app. Fill a name, a description and a website for your project. Read and agree to the Twitter Developer Agreement to proceed. You will then arrive on the application webpage: - -![twitter_app](images/twitter-app.png){.thumbnail} - -From there, head to the **Keys and Access Tokens tab** and click on the **Create my access token** button at the bottom of the page. So you have now a total of 4 keys that identify your access: - -Two main application Keys located at the top: - -- The Consumer Key -- The Consumer Secret - -Two API access Keys located below: - -- The Access Token -- The Access Token Secret - -Note that you can configure the access levels on both your app and tokens. All these keys will be used in the Twitter input plugin of Logstash. Now let's configure our Twitter logstash collector! - -#### Logstash collector creation - -In the Logs Data Platform manager, create a Logstash collector. On the creation page, as usual fill a Name and a Description and leave the default port since it will not be used (The logstash input will connect to Twitter by itself). Also attach your collector to a dedicated stream. The only important thing is to create only one instance. If not, you will have several instances fetching the same data from Twitter and sending it to your stream multiple times. - -![single_instance](images/single_instance.png){.thumbnail} - -#### Twitter input plugin configuration - -Once your collector has been created, head to the configuration page, this is where the real fun begins! To configure your input plugin, you need the Twitter Keys created before. Here is a configuration snippet of the Twitter plugin input: - -```ruby -twitter { - consumer_key => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - consumer_secret => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXx" - oauth_token => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - oauth_token_secret => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - keywords => [ "playstation","Nintendo","xbox"] - type => "tweet" - full_tweet => true -} -``` - -Fill the consumer Keys and Secret with the keys you obtained at the Twitter app configuration step. The oauth_token and the oauth_token_secret are the Access Token and Access Token Secret you created just before. - -The keywords array is the special array where you can specify which keywords you want to follow. Here I want to follow the three different competitors of the famous #ConsoleWars. If you want to follow tweets that contain multiple terms simultaneously you just separate them by a space in the same string. For example: "call of duty" will follow only tweets that contain 'call', 'of' and 'Duty'. You can also just follow a specific Twitter account by using the option **follows**. For more information about the Twitter input, go to the complete [Twitter input documentation](https://www.elastic.co/guide/en/logstash/6.7/plugins-inputs-twitter.html). - -You must use two additional parameters: - -- **type** will be useful for our Logstash filters -- **full_tweet** is here to fetch all the metadata from the tweet. - -#### Filter plugin configuration - -Actually, if you want a minimal Twitter configuration, this could be enough. But our goal is to analyze trends, hashtags, mentions, user activities etc. In order to do this, we need to have at least a clear view of the main objects contained in a tweet: hashtags and mentions. Both of them are normally embedded in a tweet event but Logs Data Platform need flat objects, so we will have to extract them. The goal is to have three different objects: tweets, hashtags and mentions so that we can freely analyze them or correlate them. Here is the filter configuration: - -```ruby -if [type] == "tweet" { - - mutate { - add_field => { - "message" => "%{text}" - "full_message" => "%{text}" - "hashtags" => "%{[entities][hashtags]}" - "mentions" => "%{[entities][user_mentions]}" - "host" => "twitter" - "tweet_url" => "https://twitter.com/%{[user][screen_name]}/status/%{id_str}" - "user_screen_name" => "%{[user][screen_name]}" - "user_id" => "%{[user][id_str]}" - "user_followers_count_int" => "%{[user][followers_count]}" - "user_friends_count_int" => "%{[user][friends_count]}" - "user_listed_count_int" => "%{[user][listed_count]}" - "user_favourites_count_int" => "%{[user][favourites_count]}" - "user_statuses_count_int" => "%{[user][statuses_count]}" - "user_profile_image_url" => "%{[user][profile_image_url_https]}" - "user_verified_bool" => "%{[user][verified]}" - } - remove_field => ["timestamp_ms"] - } - - if [user][profile_banner_url] { - mutate { - add_field => { - "user_profile_banner_url" => "%{[user][profile_banner_url]}" - } - } - } - - if [retweeted_status] { - mutate { - add_field => { - "retweeted_status_user_screen_name" => "%{[retweeted_status][user][screen_name]}" - "retweeted_status_tweet_url" => "https://twitter.com/%{[retweeted_status][user][screen_name]}/status/%{[retweeted_status][id_str]}" - } - } - } - - if [entities][user_mentions] and [type] == "tweet" { - clone { - clones => ["mention"] - } - } - - if [entities][hashtags] and [type] == "tweet" { - clone { - clones => ["hashtag"] - } - } - -} - -if [type] == "hashtag" { - - split { - field => "[entities][hashtags]" - } - - mutate { - add_field => { - "hashtag" => "%{[entities][hashtags][text]}" - "indice_begin_int" => "%{[entities][hashtags][indices][0]}" - "indice_end_int" => "%{[entities][hashtags][indices][1]}" - } - remove_field => [ "retweet_count", "retweeted_status", "user", "text", "filter_level", "favorite_count", "extended_tweet", "entities"] - update => { - "message" => "#%{[entities][hashtags][text]}" - } - } - -} - -if [type] == "mention" { - - split { - field => "[entities][user_mentions]" - } - - mutate { - add_field => { - "mention" => "%{[entities][user_mentions][screen_name]}" - "mention_user_id_" => "%{[entities][user_mentions][id]}" - "indice_begin_int" => "%{[entities][user_mentions][indices][0]}" - "indice_end_int" => "%{[entities][user_mentions][indices][1]}" - } - remove_field => [ "retweet_count", "retweeted_status", "user", "text", "filter_level", "favorite_count", "extended_tweet", "entities"] - update => { - "message" => "@%{[entities][user_mentions][screen_name]}" - } - } - -} -``` - -The configuration looks quite long and complex, it is in fact split into three parts: the *tweet type section*, the *hashtag type section* and the *mention type section* - -- The tweet type section: In this section, we select all the objects that have the *tweet* type. We use the *mutate filter* to extract and move some information at the top level of the event. We also remove unneeded information as id_str or timestamp_ms. Then we use [conditional expressions](https://www.elastic.co/guide/en/logstash/6.7/event-dependent-configuration.html) to extract information and to create hashtags and mentions objects. The *clone filters* will create a new event that will contain a copy of the full tweet and will tag it as a hashtag or mention type. They will execute only if mentions or hashtags are present. -- The hashtag type section: In this section, the hashtags of a tweet will be split into distinct events so a tweet that has 4 hashtags will generate 4 events of type hashtag. That's the purpose of the *split filter*. After the split filter, there is a mutate filter that will promote some information at the top level of the event and remove unnecessary information for this type of object. It will also change the message to the hashtag text itself with the preceding 'hash' character. -- The mention type section: It is pretty much the same as the hashtag one. One *split filter* to create mentions events and one *mutate filter* to extract, delete and modify useful information. - -We could have applied the same process for the media entities for example. The workflow would have been the same: Extract the entities from the tweet by cloning it with the media type, add a media type section with a split and mutate filter to generate different events. - -Now that we have our filter, test the configuration, and then start the collector ! Head to your Graylog Stream attached to the collector to analyze your data! - -### Analyze tweets in Graylog - -Depending on the popularity of your keywords, you may or may not have any information in your stream yet. If you don't have any, check that the input started correctly or try it with more popular subjects:-). Here are some examples of queries you can use in your Graylog stream: - -If you want to know what is the number of tweets over time just type in the Graylog search bar: -``` -type:tweet -``` -This will give you only the tweets without hashtag nor mentions objects. - -To search for a particular subject just type it in the search bar (with double-quotes): -``` -"Final Fantasy XV" -``` - -If you want the hashtags, type: -``` -type:hashtag -``` -This will give you the hashtags list. - -How to list all tweets from @PlayStation? -``` -type:tweet AND user_screen_name:PlayStation -``` - -What are the most popular hashtags? -Use the left panel to select the *Quick Values widget* for the value **hashtag** to display a listing of the most frequent values. - -What are the most popular hashtags associated with Nintendo? -You can combine the query and the quick values by issuing a query in the search bar first: -``` -type:hashtag AND Nintendo. Then use the *Quick Values Widget* again -``` - -Which tweets contain 'xbox'? -``` -type:tweet AND message:*xbox* -``` - -How many times @xboxuk is mentioned? -``` -mention:xboxuk -``` - -In which tweets? -``` -type:tweet AND mentions:*xboxuk* -``` -Note here that we used the *mentions* field (with a final 's') on the tweet to retrieve the mention. Moreover with all objects types, you always have the original tweet message in the full_message field. - -How to list tweets from "popular" users? -``` -type:tweet AND user_followers_count_int:>5000 -``` - -How to list all hashtags on the PlayStation subject except the PlayStation hashtag? -``` -type:hashtag AND playstation AND NOT hashtag:PlayStation -``` - -How to list all tweets except retweets? -``` -type:tweet AND NOT _exists_:retweet_status -``` - -There are many more possibilities. Of course you can create beautiful dashboards from all this information to visualize your data: - -![Dashboards](images/dashboard.png){.thumbnail} - -That's all for now. If you have any proposition or trouble with this tutorial, don't hesitate to reach us on the [Community hub](https://community.ovh.com/en/c/Platform/data-platforms). - -## Go further - -- Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- Documentation: [Guides](/products/observability-logs-data-platform) -- Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) diff --git a/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/guide.en-sg.md b/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/guide.en-sg.md deleted file mode 100644 index 95d5613e3d3..00000000000 --- a/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/guide.en-sg.md +++ /dev/null @@ -1,264 +0,0 @@ ---- -title: Analyzing Twitter with Logs Data Platform -excerpt: Logs Data Platform can be used in multiple ways. Twitter feed and keyword analysis is one of them. -updated: 2019-04-10 ---- - -## Objective - -Twitter can be an amazing source to have a direct feedback on your products or events, track a particular subject to find new business opportunities or just to follow the most important people of your network. You can use Logs Data Platform to fully exploit this data flow with the Logstash collector feature and its powerful plugins. This guide will show you how to analyze your tweets using the Logs Data Platform. - -## Requirements - -Prior to completing this guide, you should read the following: - -- [Quick Start of Logs Data Platform](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- [Field naming conventions](/pages/manage_and_operate/observability/logs_data_platform/getting_started_field_naming_convention) -- [Logstash collector](/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input) - -If you have completely understood these three guides, let's dive into this one. - -## Instructions - -### Logstash collector configuration - -#### Twitter application creation - -Logstash has a powerful Twitter Input plugin. This plugin allows you to connect to the Stream API of Twitter and to listen for incoming tweets. In order to do this, it just needs your Twitter account API Keys. They are free and can be retrieved with a Twitter account. Log in your Twitter account in: [https://apps.twitter.com/](https://apps.twitter.com/) and click on create a new app. Fill a name, a description and a website for your project. Read and agree to the Twitter Developer Agreement to proceed. You will then arrive on the application webpage: - -![twitter_app](images/twitter-app.png){.thumbnail} - -From there, head to the **Keys and Access Tokens tab** and click on the **Create my access token** button at the bottom of the page. So you have now a total of 4 keys that identify your access: - -Two main application Keys located at the top: - -- The Consumer Key -- The Consumer Secret - -Two API access Keys located below: - -- The Access Token -- The Access Token Secret - -Note that you can configure the access levels on both your app and tokens. All these keys will be used in the Twitter input plugin of Logstash. Now let's configure our Twitter logstash collector! - -#### Logstash collector creation - -In the Logs Data Platform manager, create a Logstash collector. On the creation page, as usual fill a Name and a Description and leave the default port since it will not be used (The logstash input will connect to Twitter by itself). Also attach your collector to a dedicated stream. The only important thing is to create only one instance. If not, you will have several instances fetching the same data from Twitter and sending it to your stream multiple times. - -![single_instance](images/single_instance.png){.thumbnail} - -#### Twitter input plugin configuration - -Once your collector has been created, head to the configuration page, this is where the real fun begins! To configure your input plugin, you need the Twitter Keys created before. Here is a configuration snippet of the Twitter plugin input: - -```ruby -twitter { - consumer_key => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - consumer_secret => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXx" - oauth_token => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - oauth_token_secret => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - keywords => [ "playstation","Nintendo","xbox"] - type => "tweet" - full_tweet => true -} -``` - -Fill the consumer Keys and Secret with the keys you obtained at the Twitter app configuration step. The oauth_token and the oauth_token_secret are the Access Token and Access Token Secret you created just before. - -The keywords array is the special array where you can specify which keywords you want to follow. Here I want to follow the three different competitors of the famous #ConsoleWars. If you want to follow tweets that contain multiple terms simultaneously you just separate them by a space in the same string. For example: "call of duty" will follow only tweets that contain 'call', 'of' and 'Duty'. You can also just follow a specific Twitter account by using the option **follows**. For more information about the Twitter input, go to the complete [Twitter input documentation](https://www.elastic.co/guide/en/logstash/6.7/plugins-inputs-twitter.html). - -You must use two additional parameters: - -- **type** will be useful for our Logstash filters -- **full_tweet** is here to fetch all the metadata from the tweet. - -#### Filter plugin configuration - -Actually, if you want a minimal Twitter configuration, this could be enough. But our goal is to analyze trends, hashtags, mentions, user activities etc. In order to do this, we need to have at least a clear view of the main objects contained in a tweet: hashtags and mentions. Both of them are normally embedded in a tweet event but Logs Data Platform need flat objects, so we will have to extract them. The goal is to have three different objects: tweets, hashtags and mentions so that we can freely analyze them or correlate them. Here is the filter configuration: - -```ruby -if [type] == "tweet" { - - mutate { - add_field => { - "message" => "%{text}" - "full_message" => "%{text}" - "hashtags" => "%{[entities][hashtags]}" - "mentions" => "%{[entities][user_mentions]}" - "host" => "twitter" - "tweet_url" => "https://twitter.com/%{[user][screen_name]}/status/%{id_str}" - "user_screen_name" => "%{[user][screen_name]}" - "user_id" => "%{[user][id_str]}" - "user_followers_count_int" => "%{[user][followers_count]}" - "user_friends_count_int" => "%{[user][friends_count]}" - "user_listed_count_int" => "%{[user][listed_count]}" - "user_favourites_count_int" => "%{[user][favourites_count]}" - "user_statuses_count_int" => "%{[user][statuses_count]}" - "user_profile_image_url" => "%{[user][profile_image_url_https]}" - "user_verified_bool" => "%{[user][verified]}" - } - remove_field => ["timestamp_ms"] - } - - if [user][profile_banner_url] { - mutate { - add_field => { - "user_profile_banner_url" => "%{[user][profile_banner_url]}" - } - } - } - - if [retweeted_status] { - mutate { - add_field => { - "retweeted_status_user_screen_name" => "%{[retweeted_status][user][screen_name]}" - "retweeted_status_tweet_url" => "https://twitter.com/%{[retweeted_status][user][screen_name]}/status/%{[retweeted_status][id_str]}" - } - } - } - - if [entities][user_mentions] and [type] == "tweet" { - clone { - clones => ["mention"] - } - } - - if [entities][hashtags] and [type] == "tweet" { - clone { - clones => ["hashtag"] - } - } - -} - -if [type] == "hashtag" { - - split { - field => "[entities][hashtags]" - } - - mutate { - add_field => { - "hashtag" => "%{[entities][hashtags][text]}" - "indice_begin_int" => "%{[entities][hashtags][indices][0]}" - "indice_end_int" => "%{[entities][hashtags][indices][1]}" - } - remove_field => [ "retweet_count", "retweeted_status", "user", "text", "filter_level", "favorite_count", "extended_tweet", "entities"] - update => { - "message" => "#%{[entities][hashtags][text]}" - } - } - -} - -if [type] == "mention" { - - split { - field => "[entities][user_mentions]" - } - - mutate { - add_field => { - "mention" => "%{[entities][user_mentions][screen_name]}" - "mention_user_id_" => "%{[entities][user_mentions][id]}" - "indice_begin_int" => "%{[entities][user_mentions][indices][0]}" - "indice_end_int" => "%{[entities][user_mentions][indices][1]}" - } - remove_field => [ "retweet_count", "retweeted_status", "user", "text", "filter_level", "favorite_count", "extended_tweet", "entities"] - update => { - "message" => "@%{[entities][user_mentions][screen_name]}" - } - } - -} -``` - -The configuration looks quite long and complex, it is in fact split into three parts: the *tweet type section*, the *hashtag type section* and the *mention type section* - -- The tweet type section: In this section, we select all the objects that have the *tweet* type. We use the *mutate filter* to extract and move some information at the top level of the event. We also remove unneeded information as id_str or timestamp_ms. Then we use [conditional expressions](https://www.elastic.co/guide/en/logstash/6.7/event-dependent-configuration.html) to extract information and to create hashtags and mentions objects. The *clone filters* will create a new event that will contain a copy of the full tweet and will tag it as a hashtag or mention type. They will execute only if mentions or hashtags are present. -- The hashtag type section: In this section, the hashtags of a tweet will be split into distinct events so a tweet that has 4 hashtags will generate 4 events of type hashtag. That's the purpose of the *split filter*. After the split filter, there is a mutate filter that will promote some information at the top level of the event and remove unnecessary information for this type of object. It will also change the message to the hashtag text itself with the preceding 'hash' character. -- The mention type section: It is pretty much the same as the hashtag one. One *split filter* to create mentions events and one *mutate filter* to extract, delete and modify useful information. - -We could have applied the same process for the media entities for example. The workflow would have been the same: Extract the entities from the tweet by cloning it with the media type, add a media type section with a split and mutate filter to generate different events. - -Now that we have our filter, test the configuration, and then start the collector ! Head to your Graylog Stream attached to the collector to analyze your data! - -### Analyze tweets in Graylog - -Depending on the popularity of your keywords, you may or may not have any information in your stream yet. If you don't have any, check that the input started correctly or try it with more popular subjects:-). Here are some examples of queries you can use in your Graylog stream: - -If you want to know what is the number of tweets over time just type in the Graylog search bar: -``` -type:tweet -``` -This will give you only the tweets without hashtag nor mentions objects. - -To search for a particular subject just type it in the search bar (with double-quotes): -``` -"Final Fantasy XV" -``` - -If you want the hashtags, type: -``` -type:hashtag -``` -This will give you the hashtags list. - -How to list all tweets from @PlayStation? -``` -type:tweet AND user_screen_name:PlayStation -``` - -What are the most popular hashtags? -Use the left panel to select the *Quick Values widget* for the value **hashtag** to display a listing of the most frequent values. - -What are the most popular hashtags associated with Nintendo? -You can combine the query and the quick values by issuing a query in the search bar first: -``` -type:hashtag AND Nintendo. Then use the *Quick Values Widget* again -``` - -Which tweets contain 'xbox'? -``` -type:tweet AND message:*xbox* -``` - -How many times @xboxuk is mentioned? -``` -mention:xboxuk -``` - -In which tweets? -``` -type:tweet AND mentions:*xboxuk* -``` -Note here that we used the *mentions* field (with a final 's') on the tweet to retrieve the mention. Moreover with all objects types, you always have the original tweet message in the full_message field. - -How to list tweets from "popular" users? -``` -type:tweet AND user_followers_count_int:>5000 -``` - -How to list all hashtags on the PlayStation subject except the PlayStation hashtag? -``` -type:hashtag AND playstation AND NOT hashtag:PlayStation -``` - -How to list all tweets except retweets? -``` -type:tweet AND NOT _exists_:retweet_status -``` - -There are many more possibilities. Of course you can create beautiful dashboards from all this information to visualize your data: - -![Dashboards](images/dashboard.png){.thumbnail} - -That's all for now. If you have any proposition or trouble with this tutorial, don't hesitate to reach us on the [Community hub](https://community.ovh.com/en/c/Platform/data-platforms). - -## Go further - -- Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- Documentation: [Guides](/products/observability-logs-data-platform) -- Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) diff --git a/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/guide.en-us.md b/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/guide.en-us.md deleted file mode 100644 index 95d5613e3d3..00000000000 --- a/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/guide.en-us.md +++ /dev/null @@ -1,264 +0,0 @@ ---- -title: Analyzing Twitter with Logs Data Platform -excerpt: Logs Data Platform can be used in multiple ways. Twitter feed and keyword analysis is one of them. -updated: 2019-04-10 ---- - -## Objective - -Twitter can be an amazing source to have a direct feedback on your products or events, track a particular subject to find new business opportunities or just to follow the most important people of your network. You can use Logs Data Platform to fully exploit this data flow with the Logstash collector feature and its powerful plugins. This guide will show you how to analyze your tweets using the Logs Data Platform. - -## Requirements - -Prior to completing this guide, you should read the following: - -- [Quick Start of Logs Data Platform](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- [Field naming conventions](/pages/manage_and_operate/observability/logs_data_platform/getting_started_field_naming_convention) -- [Logstash collector](/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input) - -If you have completely understood these three guides, let's dive into this one. - -## Instructions - -### Logstash collector configuration - -#### Twitter application creation - -Logstash has a powerful Twitter Input plugin. This plugin allows you to connect to the Stream API of Twitter and to listen for incoming tweets. In order to do this, it just needs your Twitter account API Keys. They are free and can be retrieved with a Twitter account. Log in your Twitter account in: [https://apps.twitter.com/](https://apps.twitter.com/) and click on create a new app. Fill a name, a description and a website for your project. Read and agree to the Twitter Developer Agreement to proceed. You will then arrive on the application webpage: - -![twitter_app](images/twitter-app.png){.thumbnail} - -From there, head to the **Keys and Access Tokens tab** and click on the **Create my access token** button at the bottom of the page. So you have now a total of 4 keys that identify your access: - -Two main application Keys located at the top: - -- The Consumer Key -- The Consumer Secret - -Two API access Keys located below: - -- The Access Token -- The Access Token Secret - -Note that you can configure the access levels on both your app and tokens. All these keys will be used in the Twitter input plugin of Logstash. Now let's configure our Twitter logstash collector! - -#### Logstash collector creation - -In the Logs Data Platform manager, create a Logstash collector. On the creation page, as usual fill a Name and a Description and leave the default port since it will not be used (The logstash input will connect to Twitter by itself). Also attach your collector to a dedicated stream. The only important thing is to create only one instance. If not, you will have several instances fetching the same data from Twitter and sending it to your stream multiple times. - -![single_instance](images/single_instance.png){.thumbnail} - -#### Twitter input plugin configuration - -Once your collector has been created, head to the configuration page, this is where the real fun begins! To configure your input plugin, you need the Twitter Keys created before. Here is a configuration snippet of the Twitter plugin input: - -```ruby -twitter { - consumer_key => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - consumer_secret => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXx" - oauth_token => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - oauth_token_secret => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - keywords => [ "playstation","Nintendo","xbox"] - type => "tweet" - full_tweet => true -} -``` - -Fill the consumer Keys and Secret with the keys you obtained at the Twitter app configuration step. The oauth_token and the oauth_token_secret are the Access Token and Access Token Secret you created just before. - -The keywords array is the special array where you can specify which keywords you want to follow. Here I want to follow the three different competitors of the famous #ConsoleWars. If you want to follow tweets that contain multiple terms simultaneously you just separate them by a space in the same string. For example: "call of duty" will follow only tweets that contain 'call', 'of' and 'Duty'. You can also just follow a specific Twitter account by using the option **follows**. For more information about the Twitter input, go to the complete [Twitter input documentation](https://www.elastic.co/guide/en/logstash/6.7/plugins-inputs-twitter.html). - -You must use two additional parameters: - -- **type** will be useful for our Logstash filters -- **full_tweet** is here to fetch all the metadata from the tweet. - -#### Filter plugin configuration - -Actually, if you want a minimal Twitter configuration, this could be enough. But our goal is to analyze trends, hashtags, mentions, user activities etc. In order to do this, we need to have at least a clear view of the main objects contained in a tweet: hashtags and mentions. Both of them are normally embedded in a tweet event but Logs Data Platform need flat objects, so we will have to extract them. The goal is to have three different objects: tweets, hashtags and mentions so that we can freely analyze them or correlate them. Here is the filter configuration: - -```ruby -if [type] == "tweet" { - - mutate { - add_field => { - "message" => "%{text}" - "full_message" => "%{text}" - "hashtags" => "%{[entities][hashtags]}" - "mentions" => "%{[entities][user_mentions]}" - "host" => "twitter" - "tweet_url" => "https://twitter.com/%{[user][screen_name]}/status/%{id_str}" - "user_screen_name" => "%{[user][screen_name]}" - "user_id" => "%{[user][id_str]}" - "user_followers_count_int" => "%{[user][followers_count]}" - "user_friends_count_int" => "%{[user][friends_count]}" - "user_listed_count_int" => "%{[user][listed_count]}" - "user_favourites_count_int" => "%{[user][favourites_count]}" - "user_statuses_count_int" => "%{[user][statuses_count]}" - "user_profile_image_url" => "%{[user][profile_image_url_https]}" - "user_verified_bool" => "%{[user][verified]}" - } - remove_field => ["timestamp_ms"] - } - - if [user][profile_banner_url] { - mutate { - add_field => { - "user_profile_banner_url" => "%{[user][profile_banner_url]}" - } - } - } - - if [retweeted_status] { - mutate { - add_field => { - "retweeted_status_user_screen_name" => "%{[retweeted_status][user][screen_name]}" - "retweeted_status_tweet_url" => "https://twitter.com/%{[retweeted_status][user][screen_name]}/status/%{[retweeted_status][id_str]}" - } - } - } - - if [entities][user_mentions] and [type] == "tweet" { - clone { - clones => ["mention"] - } - } - - if [entities][hashtags] and [type] == "tweet" { - clone { - clones => ["hashtag"] - } - } - -} - -if [type] == "hashtag" { - - split { - field => "[entities][hashtags]" - } - - mutate { - add_field => { - "hashtag" => "%{[entities][hashtags][text]}" - "indice_begin_int" => "%{[entities][hashtags][indices][0]}" - "indice_end_int" => "%{[entities][hashtags][indices][1]}" - } - remove_field => [ "retweet_count", "retweeted_status", "user", "text", "filter_level", "favorite_count", "extended_tweet", "entities"] - update => { - "message" => "#%{[entities][hashtags][text]}" - } - } - -} - -if [type] == "mention" { - - split { - field => "[entities][user_mentions]" - } - - mutate { - add_field => { - "mention" => "%{[entities][user_mentions][screen_name]}" - "mention_user_id_" => "%{[entities][user_mentions][id]}" - "indice_begin_int" => "%{[entities][user_mentions][indices][0]}" - "indice_end_int" => "%{[entities][user_mentions][indices][1]}" - } - remove_field => [ "retweet_count", "retweeted_status", "user", "text", "filter_level", "favorite_count", "extended_tweet", "entities"] - update => { - "message" => "@%{[entities][user_mentions][screen_name]}" - } - } - -} -``` - -The configuration looks quite long and complex, it is in fact split into three parts: the *tweet type section*, the *hashtag type section* and the *mention type section* - -- The tweet type section: In this section, we select all the objects that have the *tweet* type. We use the *mutate filter* to extract and move some information at the top level of the event. We also remove unneeded information as id_str or timestamp_ms. Then we use [conditional expressions](https://www.elastic.co/guide/en/logstash/6.7/event-dependent-configuration.html) to extract information and to create hashtags and mentions objects. The *clone filters* will create a new event that will contain a copy of the full tweet and will tag it as a hashtag or mention type. They will execute only if mentions or hashtags are present. -- The hashtag type section: In this section, the hashtags of a tweet will be split into distinct events so a tweet that has 4 hashtags will generate 4 events of type hashtag. That's the purpose of the *split filter*. After the split filter, there is a mutate filter that will promote some information at the top level of the event and remove unnecessary information for this type of object. It will also change the message to the hashtag text itself with the preceding 'hash' character. -- The mention type section: It is pretty much the same as the hashtag one. One *split filter* to create mentions events and one *mutate filter* to extract, delete and modify useful information. - -We could have applied the same process for the media entities for example. The workflow would have been the same: Extract the entities from the tweet by cloning it with the media type, add a media type section with a split and mutate filter to generate different events. - -Now that we have our filter, test the configuration, and then start the collector ! Head to your Graylog Stream attached to the collector to analyze your data! - -### Analyze tweets in Graylog - -Depending on the popularity of your keywords, you may or may not have any information in your stream yet. If you don't have any, check that the input started correctly or try it with more popular subjects:-). Here are some examples of queries you can use in your Graylog stream: - -If you want to know what is the number of tweets over time just type in the Graylog search bar: -``` -type:tweet -``` -This will give you only the tweets without hashtag nor mentions objects. - -To search for a particular subject just type it in the search bar (with double-quotes): -``` -"Final Fantasy XV" -``` - -If you want the hashtags, type: -``` -type:hashtag -``` -This will give you the hashtags list. - -How to list all tweets from @PlayStation? -``` -type:tweet AND user_screen_name:PlayStation -``` - -What are the most popular hashtags? -Use the left panel to select the *Quick Values widget* for the value **hashtag** to display a listing of the most frequent values. - -What are the most popular hashtags associated with Nintendo? -You can combine the query and the quick values by issuing a query in the search bar first: -``` -type:hashtag AND Nintendo. Then use the *Quick Values Widget* again -``` - -Which tweets contain 'xbox'? -``` -type:tweet AND message:*xbox* -``` - -How many times @xboxuk is mentioned? -``` -mention:xboxuk -``` - -In which tweets? -``` -type:tweet AND mentions:*xboxuk* -``` -Note here that we used the *mentions* field (with a final 's') on the tweet to retrieve the mention. Moreover with all objects types, you always have the original tweet message in the full_message field. - -How to list tweets from "popular" users? -``` -type:tweet AND user_followers_count_int:>5000 -``` - -How to list all hashtags on the PlayStation subject except the PlayStation hashtag? -``` -type:hashtag AND playstation AND NOT hashtag:PlayStation -``` - -How to list all tweets except retweets? -``` -type:tweet AND NOT _exists_:retweet_status -``` - -There are many more possibilities. Of course you can create beautiful dashboards from all this information to visualize your data: - -![Dashboards](images/dashboard.png){.thumbnail} - -That's all for now. If you have any proposition or trouble with this tutorial, don't hesitate to reach us on the [Community hub](https://community.ovh.com/en/c/Platform/data-platforms). - -## Go further - -- Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- Documentation: [Guides](/products/observability-logs-data-platform) -- Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) diff --git a/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/guide.es-es.md b/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/guide.es-es.md deleted file mode 100644 index 95d5613e3d3..00000000000 --- a/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/guide.es-es.md +++ /dev/null @@ -1,264 +0,0 @@ ---- -title: Analyzing Twitter with Logs Data Platform -excerpt: Logs Data Platform can be used in multiple ways. Twitter feed and keyword analysis is one of them. -updated: 2019-04-10 ---- - -## Objective - -Twitter can be an amazing source to have a direct feedback on your products or events, track a particular subject to find new business opportunities or just to follow the most important people of your network. You can use Logs Data Platform to fully exploit this data flow with the Logstash collector feature and its powerful plugins. This guide will show you how to analyze your tweets using the Logs Data Platform. - -## Requirements - -Prior to completing this guide, you should read the following: - -- [Quick Start of Logs Data Platform](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- [Field naming conventions](/pages/manage_and_operate/observability/logs_data_platform/getting_started_field_naming_convention) -- [Logstash collector](/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input) - -If you have completely understood these three guides, let's dive into this one. - -## Instructions - -### Logstash collector configuration - -#### Twitter application creation - -Logstash has a powerful Twitter Input plugin. This plugin allows you to connect to the Stream API of Twitter and to listen for incoming tweets. In order to do this, it just needs your Twitter account API Keys. They are free and can be retrieved with a Twitter account. Log in your Twitter account in: [https://apps.twitter.com/](https://apps.twitter.com/) and click on create a new app. Fill a name, a description and a website for your project. Read and agree to the Twitter Developer Agreement to proceed. You will then arrive on the application webpage: - -![twitter_app](images/twitter-app.png){.thumbnail} - -From there, head to the **Keys and Access Tokens tab** and click on the **Create my access token** button at the bottom of the page. So you have now a total of 4 keys that identify your access: - -Two main application Keys located at the top: - -- The Consumer Key -- The Consumer Secret - -Two API access Keys located below: - -- The Access Token -- The Access Token Secret - -Note that you can configure the access levels on both your app and tokens. All these keys will be used in the Twitter input plugin of Logstash. Now let's configure our Twitter logstash collector! - -#### Logstash collector creation - -In the Logs Data Platform manager, create a Logstash collector. On the creation page, as usual fill a Name and a Description and leave the default port since it will not be used (The logstash input will connect to Twitter by itself). Also attach your collector to a dedicated stream. The only important thing is to create only one instance. If not, you will have several instances fetching the same data from Twitter and sending it to your stream multiple times. - -![single_instance](images/single_instance.png){.thumbnail} - -#### Twitter input plugin configuration - -Once your collector has been created, head to the configuration page, this is where the real fun begins! To configure your input plugin, you need the Twitter Keys created before. Here is a configuration snippet of the Twitter plugin input: - -```ruby -twitter { - consumer_key => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - consumer_secret => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXx" - oauth_token => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - oauth_token_secret => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - keywords => [ "playstation","Nintendo","xbox"] - type => "tweet" - full_tweet => true -} -``` - -Fill the consumer Keys and Secret with the keys you obtained at the Twitter app configuration step. The oauth_token and the oauth_token_secret are the Access Token and Access Token Secret you created just before. - -The keywords array is the special array where you can specify which keywords you want to follow. Here I want to follow the three different competitors of the famous #ConsoleWars. If you want to follow tweets that contain multiple terms simultaneously you just separate them by a space in the same string. For example: "call of duty" will follow only tweets that contain 'call', 'of' and 'Duty'. You can also just follow a specific Twitter account by using the option **follows**. For more information about the Twitter input, go to the complete [Twitter input documentation](https://www.elastic.co/guide/en/logstash/6.7/plugins-inputs-twitter.html). - -You must use two additional parameters: - -- **type** will be useful for our Logstash filters -- **full_tweet** is here to fetch all the metadata from the tweet. - -#### Filter plugin configuration - -Actually, if you want a minimal Twitter configuration, this could be enough. But our goal is to analyze trends, hashtags, mentions, user activities etc. In order to do this, we need to have at least a clear view of the main objects contained in a tweet: hashtags and mentions. Both of them are normally embedded in a tweet event but Logs Data Platform need flat objects, so we will have to extract them. The goal is to have three different objects: tweets, hashtags and mentions so that we can freely analyze them or correlate them. Here is the filter configuration: - -```ruby -if [type] == "tweet" { - - mutate { - add_field => { - "message" => "%{text}" - "full_message" => "%{text}" - "hashtags" => "%{[entities][hashtags]}" - "mentions" => "%{[entities][user_mentions]}" - "host" => "twitter" - "tweet_url" => "https://twitter.com/%{[user][screen_name]}/status/%{id_str}" - "user_screen_name" => "%{[user][screen_name]}" - "user_id" => "%{[user][id_str]}" - "user_followers_count_int" => "%{[user][followers_count]}" - "user_friends_count_int" => "%{[user][friends_count]}" - "user_listed_count_int" => "%{[user][listed_count]}" - "user_favourites_count_int" => "%{[user][favourites_count]}" - "user_statuses_count_int" => "%{[user][statuses_count]}" - "user_profile_image_url" => "%{[user][profile_image_url_https]}" - "user_verified_bool" => "%{[user][verified]}" - } - remove_field => ["timestamp_ms"] - } - - if [user][profile_banner_url] { - mutate { - add_field => { - "user_profile_banner_url" => "%{[user][profile_banner_url]}" - } - } - } - - if [retweeted_status] { - mutate { - add_field => { - "retweeted_status_user_screen_name" => "%{[retweeted_status][user][screen_name]}" - "retweeted_status_tweet_url" => "https://twitter.com/%{[retweeted_status][user][screen_name]}/status/%{[retweeted_status][id_str]}" - } - } - } - - if [entities][user_mentions] and [type] == "tweet" { - clone { - clones => ["mention"] - } - } - - if [entities][hashtags] and [type] == "tweet" { - clone { - clones => ["hashtag"] - } - } - -} - -if [type] == "hashtag" { - - split { - field => "[entities][hashtags]" - } - - mutate { - add_field => { - "hashtag" => "%{[entities][hashtags][text]}" - "indice_begin_int" => "%{[entities][hashtags][indices][0]}" - "indice_end_int" => "%{[entities][hashtags][indices][1]}" - } - remove_field => [ "retweet_count", "retweeted_status", "user", "text", "filter_level", "favorite_count", "extended_tweet", "entities"] - update => { - "message" => "#%{[entities][hashtags][text]}" - } - } - -} - -if [type] == "mention" { - - split { - field => "[entities][user_mentions]" - } - - mutate { - add_field => { - "mention" => "%{[entities][user_mentions][screen_name]}" - "mention_user_id_" => "%{[entities][user_mentions][id]}" - "indice_begin_int" => "%{[entities][user_mentions][indices][0]}" - "indice_end_int" => "%{[entities][user_mentions][indices][1]}" - } - remove_field => [ "retweet_count", "retweeted_status", "user", "text", "filter_level", "favorite_count", "extended_tweet", "entities"] - update => { - "message" => "@%{[entities][user_mentions][screen_name]}" - } - } - -} -``` - -The configuration looks quite long and complex, it is in fact split into three parts: the *tweet type section*, the *hashtag type section* and the *mention type section* - -- The tweet type section: In this section, we select all the objects that have the *tweet* type. We use the *mutate filter* to extract and move some information at the top level of the event. We also remove unneeded information as id_str or timestamp_ms. Then we use [conditional expressions](https://www.elastic.co/guide/en/logstash/6.7/event-dependent-configuration.html) to extract information and to create hashtags and mentions objects. The *clone filters* will create a new event that will contain a copy of the full tweet and will tag it as a hashtag or mention type. They will execute only if mentions or hashtags are present. -- The hashtag type section: In this section, the hashtags of a tweet will be split into distinct events so a tweet that has 4 hashtags will generate 4 events of type hashtag. That's the purpose of the *split filter*. After the split filter, there is a mutate filter that will promote some information at the top level of the event and remove unnecessary information for this type of object. It will also change the message to the hashtag text itself with the preceding 'hash' character. -- The mention type section: It is pretty much the same as the hashtag one. One *split filter* to create mentions events and one *mutate filter* to extract, delete and modify useful information. - -We could have applied the same process for the media entities for example. The workflow would have been the same: Extract the entities from the tweet by cloning it with the media type, add a media type section with a split and mutate filter to generate different events. - -Now that we have our filter, test the configuration, and then start the collector ! Head to your Graylog Stream attached to the collector to analyze your data! - -### Analyze tweets in Graylog - -Depending on the popularity of your keywords, you may or may not have any information in your stream yet. If you don't have any, check that the input started correctly or try it with more popular subjects:-). Here are some examples of queries you can use in your Graylog stream: - -If you want to know what is the number of tweets over time just type in the Graylog search bar: -``` -type:tweet -``` -This will give you only the tweets without hashtag nor mentions objects. - -To search for a particular subject just type it in the search bar (with double-quotes): -``` -"Final Fantasy XV" -``` - -If you want the hashtags, type: -``` -type:hashtag -``` -This will give you the hashtags list. - -How to list all tweets from @PlayStation? -``` -type:tweet AND user_screen_name:PlayStation -``` - -What are the most popular hashtags? -Use the left panel to select the *Quick Values widget* for the value **hashtag** to display a listing of the most frequent values. - -What are the most popular hashtags associated with Nintendo? -You can combine the query and the quick values by issuing a query in the search bar first: -``` -type:hashtag AND Nintendo. Then use the *Quick Values Widget* again -``` - -Which tweets contain 'xbox'? -``` -type:tweet AND message:*xbox* -``` - -How many times @xboxuk is mentioned? -``` -mention:xboxuk -``` - -In which tweets? -``` -type:tweet AND mentions:*xboxuk* -``` -Note here that we used the *mentions* field (with a final 's') on the tweet to retrieve the mention. Moreover with all objects types, you always have the original tweet message in the full_message field. - -How to list tweets from "popular" users? -``` -type:tweet AND user_followers_count_int:>5000 -``` - -How to list all hashtags on the PlayStation subject except the PlayStation hashtag? -``` -type:hashtag AND playstation AND NOT hashtag:PlayStation -``` - -How to list all tweets except retweets? -``` -type:tweet AND NOT _exists_:retweet_status -``` - -There are many more possibilities. Of course you can create beautiful dashboards from all this information to visualize your data: - -![Dashboards](images/dashboard.png){.thumbnail} - -That's all for now. If you have any proposition or trouble with this tutorial, don't hesitate to reach us on the [Community hub](https://community.ovh.com/en/c/Platform/data-platforms). - -## Go further - -- Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- Documentation: [Guides](/products/observability-logs-data-platform) -- Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) diff --git a/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/guide.es-us.md b/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/guide.es-us.md deleted file mode 100644 index 95d5613e3d3..00000000000 --- a/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/guide.es-us.md +++ /dev/null @@ -1,264 +0,0 @@ ---- -title: Analyzing Twitter with Logs Data Platform -excerpt: Logs Data Platform can be used in multiple ways. Twitter feed and keyword analysis is one of them. -updated: 2019-04-10 ---- - -## Objective - -Twitter can be an amazing source to have a direct feedback on your products or events, track a particular subject to find new business opportunities or just to follow the most important people of your network. You can use Logs Data Platform to fully exploit this data flow with the Logstash collector feature and its powerful plugins. This guide will show you how to analyze your tweets using the Logs Data Platform. - -## Requirements - -Prior to completing this guide, you should read the following: - -- [Quick Start of Logs Data Platform](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- [Field naming conventions](/pages/manage_and_operate/observability/logs_data_platform/getting_started_field_naming_convention) -- [Logstash collector](/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input) - -If you have completely understood these three guides, let's dive into this one. - -## Instructions - -### Logstash collector configuration - -#### Twitter application creation - -Logstash has a powerful Twitter Input plugin. This plugin allows you to connect to the Stream API of Twitter and to listen for incoming tweets. In order to do this, it just needs your Twitter account API Keys. They are free and can be retrieved with a Twitter account. Log in your Twitter account in: [https://apps.twitter.com/](https://apps.twitter.com/) and click on create a new app. Fill a name, a description and a website for your project. Read and agree to the Twitter Developer Agreement to proceed. You will then arrive on the application webpage: - -![twitter_app](images/twitter-app.png){.thumbnail} - -From there, head to the **Keys and Access Tokens tab** and click on the **Create my access token** button at the bottom of the page. So you have now a total of 4 keys that identify your access: - -Two main application Keys located at the top: - -- The Consumer Key -- The Consumer Secret - -Two API access Keys located below: - -- The Access Token -- The Access Token Secret - -Note that you can configure the access levels on both your app and tokens. All these keys will be used in the Twitter input plugin of Logstash. Now let's configure our Twitter logstash collector! - -#### Logstash collector creation - -In the Logs Data Platform manager, create a Logstash collector. On the creation page, as usual fill a Name and a Description and leave the default port since it will not be used (The logstash input will connect to Twitter by itself). Also attach your collector to a dedicated stream. The only important thing is to create only one instance. If not, you will have several instances fetching the same data from Twitter and sending it to your stream multiple times. - -![single_instance](images/single_instance.png){.thumbnail} - -#### Twitter input plugin configuration - -Once your collector has been created, head to the configuration page, this is where the real fun begins! To configure your input plugin, you need the Twitter Keys created before. Here is a configuration snippet of the Twitter plugin input: - -```ruby -twitter { - consumer_key => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - consumer_secret => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXx" - oauth_token => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - oauth_token_secret => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - keywords => [ "playstation","Nintendo","xbox"] - type => "tweet" - full_tweet => true -} -``` - -Fill the consumer Keys and Secret with the keys you obtained at the Twitter app configuration step. The oauth_token and the oauth_token_secret are the Access Token and Access Token Secret you created just before. - -The keywords array is the special array where you can specify which keywords you want to follow. Here I want to follow the three different competitors of the famous #ConsoleWars. If you want to follow tweets that contain multiple terms simultaneously you just separate them by a space in the same string. For example: "call of duty" will follow only tweets that contain 'call', 'of' and 'Duty'. You can also just follow a specific Twitter account by using the option **follows**. For more information about the Twitter input, go to the complete [Twitter input documentation](https://www.elastic.co/guide/en/logstash/6.7/plugins-inputs-twitter.html). - -You must use two additional parameters: - -- **type** will be useful for our Logstash filters -- **full_tweet** is here to fetch all the metadata from the tweet. - -#### Filter plugin configuration - -Actually, if you want a minimal Twitter configuration, this could be enough. But our goal is to analyze trends, hashtags, mentions, user activities etc. In order to do this, we need to have at least a clear view of the main objects contained in a tweet: hashtags and mentions. Both of them are normally embedded in a tweet event but Logs Data Platform need flat objects, so we will have to extract them. The goal is to have three different objects: tweets, hashtags and mentions so that we can freely analyze them or correlate them. Here is the filter configuration: - -```ruby -if [type] == "tweet" { - - mutate { - add_field => { - "message" => "%{text}" - "full_message" => "%{text}" - "hashtags" => "%{[entities][hashtags]}" - "mentions" => "%{[entities][user_mentions]}" - "host" => "twitter" - "tweet_url" => "https://twitter.com/%{[user][screen_name]}/status/%{id_str}" - "user_screen_name" => "%{[user][screen_name]}" - "user_id" => "%{[user][id_str]}" - "user_followers_count_int" => "%{[user][followers_count]}" - "user_friends_count_int" => "%{[user][friends_count]}" - "user_listed_count_int" => "%{[user][listed_count]}" - "user_favourites_count_int" => "%{[user][favourites_count]}" - "user_statuses_count_int" => "%{[user][statuses_count]}" - "user_profile_image_url" => "%{[user][profile_image_url_https]}" - "user_verified_bool" => "%{[user][verified]}" - } - remove_field => ["timestamp_ms"] - } - - if [user][profile_banner_url] { - mutate { - add_field => { - "user_profile_banner_url" => "%{[user][profile_banner_url]}" - } - } - } - - if [retweeted_status] { - mutate { - add_field => { - "retweeted_status_user_screen_name" => "%{[retweeted_status][user][screen_name]}" - "retweeted_status_tweet_url" => "https://twitter.com/%{[retweeted_status][user][screen_name]}/status/%{[retweeted_status][id_str]}" - } - } - } - - if [entities][user_mentions] and [type] == "tweet" { - clone { - clones => ["mention"] - } - } - - if [entities][hashtags] and [type] == "tweet" { - clone { - clones => ["hashtag"] - } - } - -} - -if [type] == "hashtag" { - - split { - field => "[entities][hashtags]" - } - - mutate { - add_field => { - "hashtag" => "%{[entities][hashtags][text]}" - "indice_begin_int" => "%{[entities][hashtags][indices][0]}" - "indice_end_int" => "%{[entities][hashtags][indices][1]}" - } - remove_field => [ "retweet_count", "retweeted_status", "user", "text", "filter_level", "favorite_count", "extended_tweet", "entities"] - update => { - "message" => "#%{[entities][hashtags][text]}" - } - } - -} - -if [type] == "mention" { - - split { - field => "[entities][user_mentions]" - } - - mutate { - add_field => { - "mention" => "%{[entities][user_mentions][screen_name]}" - "mention_user_id_" => "%{[entities][user_mentions][id]}" - "indice_begin_int" => "%{[entities][user_mentions][indices][0]}" - "indice_end_int" => "%{[entities][user_mentions][indices][1]}" - } - remove_field => [ "retweet_count", "retweeted_status", "user", "text", "filter_level", "favorite_count", "extended_tweet", "entities"] - update => { - "message" => "@%{[entities][user_mentions][screen_name]}" - } - } - -} -``` - -The configuration looks quite long and complex, it is in fact split into three parts: the *tweet type section*, the *hashtag type section* and the *mention type section* - -- The tweet type section: In this section, we select all the objects that have the *tweet* type. We use the *mutate filter* to extract and move some information at the top level of the event. We also remove unneeded information as id_str or timestamp_ms. Then we use [conditional expressions](https://www.elastic.co/guide/en/logstash/6.7/event-dependent-configuration.html) to extract information and to create hashtags and mentions objects. The *clone filters* will create a new event that will contain a copy of the full tweet and will tag it as a hashtag or mention type. They will execute only if mentions or hashtags are present. -- The hashtag type section: In this section, the hashtags of a tweet will be split into distinct events so a tweet that has 4 hashtags will generate 4 events of type hashtag. That's the purpose of the *split filter*. After the split filter, there is a mutate filter that will promote some information at the top level of the event and remove unnecessary information for this type of object. It will also change the message to the hashtag text itself with the preceding 'hash' character. -- The mention type section: It is pretty much the same as the hashtag one. One *split filter* to create mentions events and one *mutate filter* to extract, delete and modify useful information. - -We could have applied the same process for the media entities for example. The workflow would have been the same: Extract the entities from the tweet by cloning it with the media type, add a media type section with a split and mutate filter to generate different events. - -Now that we have our filter, test the configuration, and then start the collector ! Head to your Graylog Stream attached to the collector to analyze your data! - -### Analyze tweets in Graylog - -Depending on the popularity of your keywords, you may or may not have any information in your stream yet. If you don't have any, check that the input started correctly or try it with more popular subjects:-). Here are some examples of queries you can use in your Graylog stream: - -If you want to know what is the number of tweets over time just type in the Graylog search bar: -``` -type:tweet -``` -This will give you only the tweets without hashtag nor mentions objects. - -To search for a particular subject just type it in the search bar (with double-quotes): -``` -"Final Fantasy XV" -``` - -If you want the hashtags, type: -``` -type:hashtag -``` -This will give you the hashtags list. - -How to list all tweets from @PlayStation? -``` -type:tweet AND user_screen_name:PlayStation -``` - -What are the most popular hashtags? -Use the left panel to select the *Quick Values widget* for the value **hashtag** to display a listing of the most frequent values. - -What are the most popular hashtags associated with Nintendo? -You can combine the query and the quick values by issuing a query in the search bar first: -``` -type:hashtag AND Nintendo. Then use the *Quick Values Widget* again -``` - -Which tweets contain 'xbox'? -``` -type:tweet AND message:*xbox* -``` - -How many times @xboxuk is mentioned? -``` -mention:xboxuk -``` - -In which tweets? -``` -type:tweet AND mentions:*xboxuk* -``` -Note here that we used the *mentions* field (with a final 's') on the tweet to retrieve the mention. Moreover with all objects types, you always have the original tweet message in the full_message field. - -How to list tweets from "popular" users? -``` -type:tweet AND user_followers_count_int:>5000 -``` - -How to list all hashtags on the PlayStation subject except the PlayStation hashtag? -``` -type:hashtag AND playstation AND NOT hashtag:PlayStation -``` - -How to list all tweets except retweets? -``` -type:tweet AND NOT _exists_:retweet_status -``` - -There are many more possibilities. Of course you can create beautiful dashboards from all this information to visualize your data: - -![Dashboards](images/dashboard.png){.thumbnail} - -That's all for now. If you have any proposition or trouble with this tutorial, don't hesitate to reach us on the [Community hub](https://community.ovh.com/en/c/Platform/data-platforms). - -## Go further - -- Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- Documentation: [Guides](/products/observability-logs-data-platform) -- Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) diff --git a/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/guide.fr-ca.md b/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/guide.fr-ca.md deleted file mode 100644 index 95d5613e3d3..00000000000 --- a/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/guide.fr-ca.md +++ /dev/null @@ -1,264 +0,0 @@ ---- -title: Analyzing Twitter with Logs Data Platform -excerpt: Logs Data Platform can be used in multiple ways. Twitter feed and keyword analysis is one of them. -updated: 2019-04-10 ---- - -## Objective - -Twitter can be an amazing source to have a direct feedback on your products or events, track a particular subject to find new business opportunities or just to follow the most important people of your network. You can use Logs Data Platform to fully exploit this data flow with the Logstash collector feature and its powerful plugins. This guide will show you how to analyze your tweets using the Logs Data Platform. - -## Requirements - -Prior to completing this guide, you should read the following: - -- [Quick Start of Logs Data Platform](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- [Field naming conventions](/pages/manage_and_operate/observability/logs_data_platform/getting_started_field_naming_convention) -- [Logstash collector](/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input) - -If you have completely understood these three guides, let's dive into this one. - -## Instructions - -### Logstash collector configuration - -#### Twitter application creation - -Logstash has a powerful Twitter Input plugin. This plugin allows you to connect to the Stream API of Twitter and to listen for incoming tweets. In order to do this, it just needs your Twitter account API Keys. They are free and can be retrieved with a Twitter account. Log in your Twitter account in: [https://apps.twitter.com/](https://apps.twitter.com/) and click on create a new app. Fill a name, a description and a website for your project. Read and agree to the Twitter Developer Agreement to proceed. You will then arrive on the application webpage: - -![twitter_app](images/twitter-app.png){.thumbnail} - -From there, head to the **Keys and Access Tokens tab** and click on the **Create my access token** button at the bottom of the page. So you have now a total of 4 keys that identify your access: - -Two main application Keys located at the top: - -- The Consumer Key -- The Consumer Secret - -Two API access Keys located below: - -- The Access Token -- The Access Token Secret - -Note that you can configure the access levels on both your app and tokens. All these keys will be used in the Twitter input plugin of Logstash. Now let's configure our Twitter logstash collector! - -#### Logstash collector creation - -In the Logs Data Platform manager, create a Logstash collector. On the creation page, as usual fill a Name and a Description and leave the default port since it will not be used (The logstash input will connect to Twitter by itself). Also attach your collector to a dedicated stream. The only important thing is to create only one instance. If not, you will have several instances fetching the same data from Twitter and sending it to your stream multiple times. - -![single_instance](images/single_instance.png){.thumbnail} - -#### Twitter input plugin configuration - -Once your collector has been created, head to the configuration page, this is where the real fun begins! To configure your input plugin, you need the Twitter Keys created before. Here is a configuration snippet of the Twitter plugin input: - -```ruby -twitter { - consumer_key => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - consumer_secret => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXx" - oauth_token => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - oauth_token_secret => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - keywords => [ "playstation","Nintendo","xbox"] - type => "tweet" - full_tweet => true -} -``` - -Fill the consumer Keys and Secret with the keys you obtained at the Twitter app configuration step. The oauth_token and the oauth_token_secret are the Access Token and Access Token Secret you created just before. - -The keywords array is the special array where you can specify which keywords you want to follow. Here I want to follow the three different competitors of the famous #ConsoleWars. If you want to follow tweets that contain multiple terms simultaneously you just separate them by a space in the same string. For example: "call of duty" will follow only tweets that contain 'call', 'of' and 'Duty'. You can also just follow a specific Twitter account by using the option **follows**. For more information about the Twitter input, go to the complete [Twitter input documentation](https://www.elastic.co/guide/en/logstash/6.7/plugins-inputs-twitter.html). - -You must use two additional parameters: - -- **type** will be useful for our Logstash filters -- **full_tweet** is here to fetch all the metadata from the tweet. - -#### Filter plugin configuration - -Actually, if you want a minimal Twitter configuration, this could be enough. But our goal is to analyze trends, hashtags, mentions, user activities etc. In order to do this, we need to have at least a clear view of the main objects contained in a tweet: hashtags and mentions. Both of them are normally embedded in a tweet event but Logs Data Platform need flat objects, so we will have to extract them. The goal is to have three different objects: tweets, hashtags and mentions so that we can freely analyze them or correlate them. Here is the filter configuration: - -```ruby -if [type] == "tweet" { - - mutate { - add_field => { - "message" => "%{text}" - "full_message" => "%{text}" - "hashtags" => "%{[entities][hashtags]}" - "mentions" => "%{[entities][user_mentions]}" - "host" => "twitter" - "tweet_url" => "https://twitter.com/%{[user][screen_name]}/status/%{id_str}" - "user_screen_name" => "%{[user][screen_name]}" - "user_id" => "%{[user][id_str]}" - "user_followers_count_int" => "%{[user][followers_count]}" - "user_friends_count_int" => "%{[user][friends_count]}" - "user_listed_count_int" => "%{[user][listed_count]}" - "user_favourites_count_int" => "%{[user][favourites_count]}" - "user_statuses_count_int" => "%{[user][statuses_count]}" - "user_profile_image_url" => "%{[user][profile_image_url_https]}" - "user_verified_bool" => "%{[user][verified]}" - } - remove_field => ["timestamp_ms"] - } - - if [user][profile_banner_url] { - mutate { - add_field => { - "user_profile_banner_url" => "%{[user][profile_banner_url]}" - } - } - } - - if [retweeted_status] { - mutate { - add_field => { - "retweeted_status_user_screen_name" => "%{[retweeted_status][user][screen_name]}" - "retweeted_status_tweet_url" => "https://twitter.com/%{[retweeted_status][user][screen_name]}/status/%{[retweeted_status][id_str]}" - } - } - } - - if [entities][user_mentions] and [type] == "tweet" { - clone { - clones => ["mention"] - } - } - - if [entities][hashtags] and [type] == "tweet" { - clone { - clones => ["hashtag"] - } - } - -} - -if [type] == "hashtag" { - - split { - field => "[entities][hashtags]" - } - - mutate { - add_field => { - "hashtag" => "%{[entities][hashtags][text]}" - "indice_begin_int" => "%{[entities][hashtags][indices][0]}" - "indice_end_int" => "%{[entities][hashtags][indices][1]}" - } - remove_field => [ "retweet_count", "retweeted_status", "user", "text", "filter_level", "favorite_count", "extended_tweet", "entities"] - update => { - "message" => "#%{[entities][hashtags][text]}" - } - } - -} - -if [type] == "mention" { - - split { - field => "[entities][user_mentions]" - } - - mutate { - add_field => { - "mention" => "%{[entities][user_mentions][screen_name]}" - "mention_user_id_" => "%{[entities][user_mentions][id]}" - "indice_begin_int" => "%{[entities][user_mentions][indices][0]}" - "indice_end_int" => "%{[entities][user_mentions][indices][1]}" - } - remove_field => [ "retweet_count", "retweeted_status", "user", "text", "filter_level", "favorite_count", "extended_tweet", "entities"] - update => { - "message" => "@%{[entities][user_mentions][screen_name]}" - } - } - -} -``` - -The configuration looks quite long and complex, it is in fact split into three parts: the *tweet type section*, the *hashtag type section* and the *mention type section* - -- The tweet type section: In this section, we select all the objects that have the *tweet* type. We use the *mutate filter* to extract and move some information at the top level of the event. We also remove unneeded information as id_str or timestamp_ms. Then we use [conditional expressions](https://www.elastic.co/guide/en/logstash/6.7/event-dependent-configuration.html) to extract information and to create hashtags and mentions objects. The *clone filters* will create a new event that will contain a copy of the full tweet and will tag it as a hashtag or mention type. They will execute only if mentions or hashtags are present. -- The hashtag type section: In this section, the hashtags of a tweet will be split into distinct events so a tweet that has 4 hashtags will generate 4 events of type hashtag. That's the purpose of the *split filter*. After the split filter, there is a mutate filter that will promote some information at the top level of the event and remove unnecessary information for this type of object. It will also change the message to the hashtag text itself with the preceding 'hash' character. -- The mention type section: It is pretty much the same as the hashtag one. One *split filter* to create mentions events and one *mutate filter* to extract, delete and modify useful information. - -We could have applied the same process for the media entities for example. The workflow would have been the same: Extract the entities from the tweet by cloning it with the media type, add a media type section with a split and mutate filter to generate different events. - -Now that we have our filter, test the configuration, and then start the collector ! Head to your Graylog Stream attached to the collector to analyze your data! - -### Analyze tweets in Graylog - -Depending on the popularity of your keywords, you may or may not have any information in your stream yet. If you don't have any, check that the input started correctly or try it with more popular subjects:-). Here are some examples of queries you can use in your Graylog stream: - -If you want to know what is the number of tweets over time just type in the Graylog search bar: -``` -type:tweet -``` -This will give you only the tweets without hashtag nor mentions objects. - -To search for a particular subject just type it in the search bar (with double-quotes): -``` -"Final Fantasy XV" -``` - -If you want the hashtags, type: -``` -type:hashtag -``` -This will give you the hashtags list. - -How to list all tweets from @PlayStation? -``` -type:tweet AND user_screen_name:PlayStation -``` - -What are the most popular hashtags? -Use the left panel to select the *Quick Values widget* for the value **hashtag** to display a listing of the most frequent values. - -What are the most popular hashtags associated with Nintendo? -You can combine the query and the quick values by issuing a query in the search bar first: -``` -type:hashtag AND Nintendo. Then use the *Quick Values Widget* again -``` - -Which tweets contain 'xbox'? -``` -type:tweet AND message:*xbox* -``` - -How many times @xboxuk is mentioned? -``` -mention:xboxuk -``` - -In which tweets? -``` -type:tweet AND mentions:*xboxuk* -``` -Note here that we used the *mentions* field (with a final 's') on the tweet to retrieve the mention. Moreover with all objects types, you always have the original tweet message in the full_message field. - -How to list tweets from "popular" users? -``` -type:tweet AND user_followers_count_int:>5000 -``` - -How to list all hashtags on the PlayStation subject except the PlayStation hashtag? -``` -type:hashtag AND playstation AND NOT hashtag:PlayStation -``` - -How to list all tweets except retweets? -``` -type:tweet AND NOT _exists_:retweet_status -``` - -There are many more possibilities. Of course you can create beautiful dashboards from all this information to visualize your data: - -![Dashboards](images/dashboard.png){.thumbnail} - -That's all for now. If you have any proposition or trouble with this tutorial, don't hesitate to reach us on the [Community hub](https://community.ovh.com/en/c/Platform/data-platforms). - -## Go further - -- Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- Documentation: [Guides](/products/observability-logs-data-platform) -- Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) diff --git a/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/guide.fr-fr.md b/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/guide.fr-fr.md deleted file mode 100644 index 95d5613e3d3..00000000000 --- a/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/guide.fr-fr.md +++ /dev/null @@ -1,264 +0,0 @@ ---- -title: Analyzing Twitter with Logs Data Platform -excerpt: Logs Data Platform can be used in multiple ways. Twitter feed and keyword analysis is one of them. -updated: 2019-04-10 ---- - -## Objective - -Twitter can be an amazing source to have a direct feedback on your products or events, track a particular subject to find new business opportunities or just to follow the most important people of your network. You can use Logs Data Platform to fully exploit this data flow with the Logstash collector feature and its powerful plugins. This guide will show you how to analyze your tweets using the Logs Data Platform. - -## Requirements - -Prior to completing this guide, you should read the following: - -- [Quick Start of Logs Data Platform](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- [Field naming conventions](/pages/manage_and_operate/observability/logs_data_platform/getting_started_field_naming_convention) -- [Logstash collector](/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input) - -If you have completely understood these three guides, let's dive into this one. - -## Instructions - -### Logstash collector configuration - -#### Twitter application creation - -Logstash has a powerful Twitter Input plugin. This plugin allows you to connect to the Stream API of Twitter and to listen for incoming tweets. In order to do this, it just needs your Twitter account API Keys. They are free and can be retrieved with a Twitter account. Log in your Twitter account in: [https://apps.twitter.com/](https://apps.twitter.com/) and click on create a new app. Fill a name, a description and a website for your project. Read and agree to the Twitter Developer Agreement to proceed. You will then arrive on the application webpage: - -![twitter_app](images/twitter-app.png){.thumbnail} - -From there, head to the **Keys and Access Tokens tab** and click on the **Create my access token** button at the bottom of the page. So you have now a total of 4 keys that identify your access: - -Two main application Keys located at the top: - -- The Consumer Key -- The Consumer Secret - -Two API access Keys located below: - -- The Access Token -- The Access Token Secret - -Note that you can configure the access levels on both your app and tokens. All these keys will be used in the Twitter input plugin of Logstash. Now let's configure our Twitter logstash collector! - -#### Logstash collector creation - -In the Logs Data Platform manager, create a Logstash collector. On the creation page, as usual fill a Name and a Description and leave the default port since it will not be used (The logstash input will connect to Twitter by itself). Also attach your collector to a dedicated stream. The only important thing is to create only one instance. If not, you will have several instances fetching the same data from Twitter and sending it to your stream multiple times. - -![single_instance](images/single_instance.png){.thumbnail} - -#### Twitter input plugin configuration - -Once your collector has been created, head to the configuration page, this is where the real fun begins! To configure your input plugin, you need the Twitter Keys created before. Here is a configuration snippet of the Twitter plugin input: - -```ruby -twitter { - consumer_key => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - consumer_secret => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXx" - oauth_token => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - oauth_token_secret => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - keywords => [ "playstation","Nintendo","xbox"] - type => "tweet" - full_tweet => true -} -``` - -Fill the consumer Keys and Secret with the keys you obtained at the Twitter app configuration step. The oauth_token and the oauth_token_secret are the Access Token and Access Token Secret you created just before. - -The keywords array is the special array where you can specify which keywords you want to follow. Here I want to follow the three different competitors of the famous #ConsoleWars. If you want to follow tweets that contain multiple terms simultaneously you just separate them by a space in the same string. For example: "call of duty" will follow only tweets that contain 'call', 'of' and 'Duty'. You can also just follow a specific Twitter account by using the option **follows**. For more information about the Twitter input, go to the complete [Twitter input documentation](https://www.elastic.co/guide/en/logstash/6.7/plugins-inputs-twitter.html). - -You must use two additional parameters: - -- **type** will be useful for our Logstash filters -- **full_tweet** is here to fetch all the metadata from the tweet. - -#### Filter plugin configuration - -Actually, if you want a minimal Twitter configuration, this could be enough. But our goal is to analyze trends, hashtags, mentions, user activities etc. In order to do this, we need to have at least a clear view of the main objects contained in a tweet: hashtags and mentions. Both of them are normally embedded in a tweet event but Logs Data Platform need flat objects, so we will have to extract them. The goal is to have three different objects: tweets, hashtags and mentions so that we can freely analyze them or correlate them. Here is the filter configuration: - -```ruby -if [type] == "tweet" { - - mutate { - add_field => { - "message" => "%{text}" - "full_message" => "%{text}" - "hashtags" => "%{[entities][hashtags]}" - "mentions" => "%{[entities][user_mentions]}" - "host" => "twitter" - "tweet_url" => "https://twitter.com/%{[user][screen_name]}/status/%{id_str}" - "user_screen_name" => "%{[user][screen_name]}" - "user_id" => "%{[user][id_str]}" - "user_followers_count_int" => "%{[user][followers_count]}" - "user_friends_count_int" => "%{[user][friends_count]}" - "user_listed_count_int" => "%{[user][listed_count]}" - "user_favourites_count_int" => "%{[user][favourites_count]}" - "user_statuses_count_int" => "%{[user][statuses_count]}" - "user_profile_image_url" => "%{[user][profile_image_url_https]}" - "user_verified_bool" => "%{[user][verified]}" - } - remove_field => ["timestamp_ms"] - } - - if [user][profile_banner_url] { - mutate { - add_field => { - "user_profile_banner_url" => "%{[user][profile_banner_url]}" - } - } - } - - if [retweeted_status] { - mutate { - add_field => { - "retweeted_status_user_screen_name" => "%{[retweeted_status][user][screen_name]}" - "retweeted_status_tweet_url" => "https://twitter.com/%{[retweeted_status][user][screen_name]}/status/%{[retweeted_status][id_str]}" - } - } - } - - if [entities][user_mentions] and [type] == "tweet" { - clone { - clones => ["mention"] - } - } - - if [entities][hashtags] and [type] == "tweet" { - clone { - clones => ["hashtag"] - } - } - -} - -if [type] == "hashtag" { - - split { - field => "[entities][hashtags]" - } - - mutate { - add_field => { - "hashtag" => "%{[entities][hashtags][text]}" - "indice_begin_int" => "%{[entities][hashtags][indices][0]}" - "indice_end_int" => "%{[entities][hashtags][indices][1]}" - } - remove_field => [ "retweet_count", "retweeted_status", "user", "text", "filter_level", "favorite_count", "extended_tweet", "entities"] - update => { - "message" => "#%{[entities][hashtags][text]}" - } - } - -} - -if [type] == "mention" { - - split { - field => "[entities][user_mentions]" - } - - mutate { - add_field => { - "mention" => "%{[entities][user_mentions][screen_name]}" - "mention_user_id_" => "%{[entities][user_mentions][id]}" - "indice_begin_int" => "%{[entities][user_mentions][indices][0]}" - "indice_end_int" => "%{[entities][user_mentions][indices][1]}" - } - remove_field => [ "retweet_count", "retweeted_status", "user", "text", "filter_level", "favorite_count", "extended_tweet", "entities"] - update => { - "message" => "@%{[entities][user_mentions][screen_name]}" - } - } - -} -``` - -The configuration looks quite long and complex, it is in fact split into three parts: the *tweet type section*, the *hashtag type section* and the *mention type section* - -- The tweet type section: In this section, we select all the objects that have the *tweet* type. We use the *mutate filter* to extract and move some information at the top level of the event. We also remove unneeded information as id_str or timestamp_ms. Then we use [conditional expressions](https://www.elastic.co/guide/en/logstash/6.7/event-dependent-configuration.html) to extract information and to create hashtags and mentions objects. The *clone filters* will create a new event that will contain a copy of the full tweet and will tag it as a hashtag or mention type. They will execute only if mentions or hashtags are present. -- The hashtag type section: In this section, the hashtags of a tweet will be split into distinct events so a tweet that has 4 hashtags will generate 4 events of type hashtag. That's the purpose of the *split filter*. After the split filter, there is a mutate filter that will promote some information at the top level of the event and remove unnecessary information for this type of object. It will also change the message to the hashtag text itself with the preceding 'hash' character. -- The mention type section: It is pretty much the same as the hashtag one. One *split filter* to create mentions events and one *mutate filter* to extract, delete and modify useful information. - -We could have applied the same process for the media entities for example. The workflow would have been the same: Extract the entities from the tweet by cloning it with the media type, add a media type section with a split and mutate filter to generate different events. - -Now that we have our filter, test the configuration, and then start the collector ! Head to your Graylog Stream attached to the collector to analyze your data! - -### Analyze tweets in Graylog - -Depending on the popularity of your keywords, you may or may not have any information in your stream yet. If you don't have any, check that the input started correctly or try it with more popular subjects:-). Here are some examples of queries you can use in your Graylog stream: - -If you want to know what is the number of tweets over time just type in the Graylog search bar: -``` -type:tweet -``` -This will give you only the tweets without hashtag nor mentions objects. - -To search for a particular subject just type it in the search bar (with double-quotes): -``` -"Final Fantasy XV" -``` - -If you want the hashtags, type: -``` -type:hashtag -``` -This will give you the hashtags list. - -How to list all tweets from @PlayStation? -``` -type:tweet AND user_screen_name:PlayStation -``` - -What are the most popular hashtags? -Use the left panel to select the *Quick Values widget* for the value **hashtag** to display a listing of the most frequent values. - -What are the most popular hashtags associated with Nintendo? -You can combine the query and the quick values by issuing a query in the search bar first: -``` -type:hashtag AND Nintendo. Then use the *Quick Values Widget* again -``` - -Which tweets contain 'xbox'? -``` -type:tweet AND message:*xbox* -``` - -How many times @xboxuk is mentioned? -``` -mention:xboxuk -``` - -In which tweets? -``` -type:tweet AND mentions:*xboxuk* -``` -Note here that we used the *mentions* field (with a final 's') on the tweet to retrieve the mention. Moreover with all objects types, you always have the original tweet message in the full_message field. - -How to list tweets from "popular" users? -``` -type:tweet AND user_followers_count_int:>5000 -``` - -How to list all hashtags on the PlayStation subject except the PlayStation hashtag? -``` -type:hashtag AND playstation AND NOT hashtag:PlayStation -``` - -How to list all tweets except retweets? -``` -type:tweet AND NOT _exists_:retweet_status -``` - -There are many more possibilities. Of course you can create beautiful dashboards from all this information to visualize your data: - -![Dashboards](images/dashboard.png){.thumbnail} - -That's all for now. If you have any proposition or trouble with this tutorial, don't hesitate to reach us on the [Community hub](https://community.ovh.com/en/c/Platform/data-platforms). - -## Go further - -- Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- Documentation: [Guides](/products/observability-logs-data-platform) -- Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) diff --git a/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/guide.it-it.md b/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/guide.it-it.md deleted file mode 100644 index 95d5613e3d3..00000000000 --- a/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/guide.it-it.md +++ /dev/null @@ -1,264 +0,0 @@ ---- -title: Analyzing Twitter with Logs Data Platform -excerpt: Logs Data Platform can be used in multiple ways. Twitter feed and keyword analysis is one of them. -updated: 2019-04-10 ---- - -## Objective - -Twitter can be an amazing source to have a direct feedback on your products or events, track a particular subject to find new business opportunities or just to follow the most important people of your network. You can use Logs Data Platform to fully exploit this data flow with the Logstash collector feature and its powerful plugins. This guide will show you how to analyze your tweets using the Logs Data Platform. - -## Requirements - -Prior to completing this guide, you should read the following: - -- [Quick Start of Logs Data Platform](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- [Field naming conventions](/pages/manage_and_operate/observability/logs_data_platform/getting_started_field_naming_convention) -- [Logstash collector](/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input) - -If you have completely understood these three guides, let's dive into this one. - -## Instructions - -### Logstash collector configuration - -#### Twitter application creation - -Logstash has a powerful Twitter Input plugin. This plugin allows you to connect to the Stream API of Twitter and to listen for incoming tweets. In order to do this, it just needs your Twitter account API Keys. They are free and can be retrieved with a Twitter account. Log in your Twitter account in: [https://apps.twitter.com/](https://apps.twitter.com/) and click on create a new app. Fill a name, a description and a website for your project. Read and agree to the Twitter Developer Agreement to proceed. You will then arrive on the application webpage: - -![twitter_app](images/twitter-app.png){.thumbnail} - -From there, head to the **Keys and Access Tokens tab** and click on the **Create my access token** button at the bottom of the page. So you have now a total of 4 keys that identify your access: - -Two main application Keys located at the top: - -- The Consumer Key -- The Consumer Secret - -Two API access Keys located below: - -- The Access Token -- The Access Token Secret - -Note that you can configure the access levels on both your app and tokens. All these keys will be used in the Twitter input plugin of Logstash. Now let's configure our Twitter logstash collector! - -#### Logstash collector creation - -In the Logs Data Platform manager, create a Logstash collector. On the creation page, as usual fill a Name and a Description and leave the default port since it will not be used (The logstash input will connect to Twitter by itself). Also attach your collector to a dedicated stream. The only important thing is to create only one instance. If not, you will have several instances fetching the same data from Twitter and sending it to your stream multiple times. - -![single_instance](images/single_instance.png){.thumbnail} - -#### Twitter input plugin configuration - -Once your collector has been created, head to the configuration page, this is where the real fun begins! To configure your input plugin, you need the Twitter Keys created before. Here is a configuration snippet of the Twitter plugin input: - -```ruby -twitter { - consumer_key => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - consumer_secret => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXx" - oauth_token => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - oauth_token_secret => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - keywords => [ "playstation","Nintendo","xbox"] - type => "tweet" - full_tweet => true -} -``` - -Fill the consumer Keys and Secret with the keys you obtained at the Twitter app configuration step. The oauth_token and the oauth_token_secret are the Access Token and Access Token Secret you created just before. - -The keywords array is the special array where you can specify which keywords you want to follow. Here I want to follow the three different competitors of the famous #ConsoleWars. If you want to follow tweets that contain multiple terms simultaneously you just separate them by a space in the same string. For example: "call of duty" will follow only tweets that contain 'call', 'of' and 'Duty'. You can also just follow a specific Twitter account by using the option **follows**. For more information about the Twitter input, go to the complete [Twitter input documentation](https://www.elastic.co/guide/en/logstash/6.7/plugins-inputs-twitter.html). - -You must use two additional parameters: - -- **type** will be useful for our Logstash filters -- **full_tweet** is here to fetch all the metadata from the tweet. - -#### Filter plugin configuration - -Actually, if you want a minimal Twitter configuration, this could be enough. But our goal is to analyze trends, hashtags, mentions, user activities etc. In order to do this, we need to have at least a clear view of the main objects contained in a tweet: hashtags and mentions. Both of them are normally embedded in a tweet event but Logs Data Platform need flat objects, so we will have to extract them. The goal is to have three different objects: tweets, hashtags and mentions so that we can freely analyze them or correlate them. Here is the filter configuration: - -```ruby -if [type] == "tweet" { - - mutate { - add_field => { - "message" => "%{text}" - "full_message" => "%{text}" - "hashtags" => "%{[entities][hashtags]}" - "mentions" => "%{[entities][user_mentions]}" - "host" => "twitter" - "tweet_url" => "https://twitter.com/%{[user][screen_name]}/status/%{id_str}" - "user_screen_name" => "%{[user][screen_name]}" - "user_id" => "%{[user][id_str]}" - "user_followers_count_int" => "%{[user][followers_count]}" - "user_friends_count_int" => "%{[user][friends_count]}" - "user_listed_count_int" => "%{[user][listed_count]}" - "user_favourites_count_int" => "%{[user][favourites_count]}" - "user_statuses_count_int" => "%{[user][statuses_count]}" - "user_profile_image_url" => "%{[user][profile_image_url_https]}" - "user_verified_bool" => "%{[user][verified]}" - } - remove_field => ["timestamp_ms"] - } - - if [user][profile_banner_url] { - mutate { - add_field => { - "user_profile_banner_url" => "%{[user][profile_banner_url]}" - } - } - } - - if [retweeted_status] { - mutate { - add_field => { - "retweeted_status_user_screen_name" => "%{[retweeted_status][user][screen_name]}" - "retweeted_status_tweet_url" => "https://twitter.com/%{[retweeted_status][user][screen_name]}/status/%{[retweeted_status][id_str]}" - } - } - } - - if [entities][user_mentions] and [type] == "tweet" { - clone { - clones => ["mention"] - } - } - - if [entities][hashtags] and [type] == "tweet" { - clone { - clones => ["hashtag"] - } - } - -} - -if [type] == "hashtag" { - - split { - field => "[entities][hashtags]" - } - - mutate { - add_field => { - "hashtag" => "%{[entities][hashtags][text]}" - "indice_begin_int" => "%{[entities][hashtags][indices][0]}" - "indice_end_int" => "%{[entities][hashtags][indices][1]}" - } - remove_field => [ "retweet_count", "retweeted_status", "user", "text", "filter_level", "favorite_count", "extended_tweet", "entities"] - update => { - "message" => "#%{[entities][hashtags][text]}" - } - } - -} - -if [type] == "mention" { - - split { - field => "[entities][user_mentions]" - } - - mutate { - add_field => { - "mention" => "%{[entities][user_mentions][screen_name]}" - "mention_user_id_" => "%{[entities][user_mentions][id]}" - "indice_begin_int" => "%{[entities][user_mentions][indices][0]}" - "indice_end_int" => "%{[entities][user_mentions][indices][1]}" - } - remove_field => [ "retweet_count", "retweeted_status", "user", "text", "filter_level", "favorite_count", "extended_tweet", "entities"] - update => { - "message" => "@%{[entities][user_mentions][screen_name]}" - } - } - -} -``` - -The configuration looks quite long and complex, it is in fact split into three parts: the *tweet type section*, the *hashtag type section* and the *mention type section* - -- The tweet type section: In this section, we select all the objects that have the *tweet* type. We use the *mutate filter* to extract and move some information at the top level of the event. We also remove unneeded information as id_str or timestamp_ms. Then we use [conditional expressions](https://www.elastic.co/guide/en/logstash/6.7/event-dependent-configuration.html) to extract information and to create hashtags and mentions objects. The *clone filters* will create a new event that will contain a copy of the full tweet and will tag it as a hashtag or mention type. They will execute only if mentions or hashtags are present. -- The hashtag type section: In this section, the hashtags of a tweet will be split into distinct events so a tweet that has 4 hashtags will generate 4 events of type hashtag. That's the purpose of the *split filter*. After the split filter, there is a mutate filter that will promote some information at the top level of the event and remove unnecessary information for this type of object. It will also change the message to the hashtag text itself with the preceding 'hash' character. -- The mention type section: It is pretty much the same as the hashtag one. One *split filter* to create mentions events and one *mutate filter* to extract, delete and modify useful information. - -We could have applied the same process for the media entities for example. The workflow would have been the same: Extract the entities from the tweet by cloning it with the media type, add a media type section with a split and mutate filter to generate different events. - -Now that we have our filter, test the configuration, and then start the collector ! Head to your Graylog Stream attached to the collector to analyze your data! - -### Analyze tweets in Graylog - -Depending on the popularity of your keywords, you may or may not have any information in your stream yet. If you don't have any, check that the input started correctly or try it with more popular subjects:-). Here are some examples of queries you can use in your Graylog stream: - -If you want to know what is the number of tweets over time just type in the Graylog search bar: -``` -type:tweet -``` -This will give you only the tweets without hashtag nor mentions objects. - -To search for a particular subject just type it in the search bar (with double-quotes): -``` -"Final Fantasy XV" -``` - -If you want the hashtags, type: -``` -type:hashtag -``` -This will give you the hashtags list. - -How to list all tweets from @PlayStation? -``` -type:tweet AND user_screen_name:PlayStation -``` - -What are the most popular hashtags? -Use the left panel to select the *Quick Values widget* for the value **hashtag** to display a listing of the most frequent values. - -What are the most popular hashtags associated with Nintendo? -You can combine the query and the quick values by issuing a query in the search bar first: -``` -type:hashtag AND Nintendo. Then use the *Quick Values Widget* again -``` - -Which tweets contain 'xbox'? -``` -type:tweet AND message:*xbox* -``` - -How many times @xboxuk is mentioned? -``` -mention:xboxuk -``` - -In which tweets? -``` -type:tweet AND mentions:*xboxuk* -``` -Note here that we used the *mentions* field (with a final 's') on the tweet to retrieve the mention. Moreover with all objects types, you always have the original tweet message in the full_message field. - -How to list tweets from "popular" users? -``` -type:tweet AND user_followers_count_int:>5000 -``` - -How to list all hashtags on the PlayStation subject except the PlayStation hashtag? -``` -type:hashtag AND playstation AND NOT hashtag:PlayStation -``` - -How to list all tweets except retweets? -``` -type:tweet AND NOT _exists_:retweet_status -``` - -There are many more possibilities. Of course you can create beautiful dashboards from all this information to visualize your data: - -![Dashboards](images/dashboard.png){.thumbnail} - -That's all for now. If you have any proposition or trouble with this tutorial, don't hesitate to reach us on the [Community hub](https://community.ovh.com/en/c/Platform/data-platforms). - -## Go further - -- Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- Documentation: [Guides](/products/observability-logs-data-platform) -- Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) diff --git a/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/guide.pl-pl.md b/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/guide.pl-pl.md deleted file mode 100644 index 95d5613e3d3..00000000000 --- a/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/guide.pl-pl.md +++ /dev/null @@ -1,264 +0,0 @@ ---- -title: Analyzing Twitter with Logs Data Platform -excerpt: Logs Data Platform can be used in multiple ways. Twitter feed and keyword analysis is one of them. -updated: 2019-04-10 ---- - -## Objective - -Twitter can be an amazing source to have a direct feedback on your products or events, track a particular subject to find new business opportunities or just to follow the most important people of your network. You can use Logs Data Platform to fully exploit this data flow with the Logstash collector feature and its powerful plugins. This guide will show you how to analyze your tweets using the Logs Data Platform. - -## Requirements - -Prior to completing this guide, you should read the following: - -- [Quick Start of Logs Data Platform](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- [Field naming conventions](/pages/manage_and_operate/observability/logs_data_platform/getting_started_field_naming_convention) -- [Logstash collector](/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input) - -If you have completely understood these three guides, let's dive into this one. - -## Instructions - -### Logstash collector configuration - -#### Twitter application creation - -Logstash has a powerful Twitter Input plugin. This plugin allows you to connect to the Stream API of Twitter and to listen for incoming tweets. In order to do this, it just needs your Twitter account API Keys. They are free and can be retrieved with a Twitter account. Log in your Twitter account in: [https://apps.twitter.com/](https://apps.twitter.com/) and click on create a new app. Fill a name, a description and a website for your project. Read and agree to the Twitter Developer Agreement to proceed. You will then arrive on the application webpage: - -![twitter_app](images/twitter-app.png){.thumbnail} - -From there, head to the **Keys and Access Tokens tab** and click on the **Create my access token** button at the bottom of the page. So you have now a total of 4 keys that identify your access: - -Two main application Keys located at the top: - -- The Consumer Key -- The Consumer Secret - -Two API access Keys located below: - -- The Access Token -- The Access Token Secret - -Note that you can configure the access levels on both your app and tokens. All these keys will be used in the Twitter input plugin of Logstash. Now let's configure our Twitter logstash collector! - -#### Logstash collector creation - -In the Logs Data Platform manager, create a Logstash collector. On the creation page, as usual fill a Name and a Description and leave the default port since it will not be used (The logstash input will connect to Twitter by itself). Also attach your collector to a dedicated stream. The only important thing is to create only one instance. If not, you will have several instances fetching the same data from Twitter and sending it to your stream multiple times. - -![single_instance](images/single_instance.png){.thumbnail} - -#### Twitter input plugin configuration - -Once your collector has been created, head to the configuration page, this is where the real fun begins! To configure your input plugin, you need the Twitter Keys created before. Here is a configuration snippet of the Twitter plugin input: - -```ruby -twitter { - consumer_key => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - consumer_secret => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXx" - oauth_token => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - oauth_token_secret => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - keywords => [ "playstation","Nintendo","xbox"] - type => "tweet" - full_tweet => true -} -``` - -Fill the consumer Keys and Secret with the keys you obtained at the Twitter app configuration step. The oauth_token and the oauth_token_secret are the Access Token and Access Token Secret you created just before. - -The keywords array is the special array where you can specify which keywords you want to follow. Here I want to follow the three different competitors of the famous #ConsoleWars. If you want to follow tweets that contain multiple terms simultaneously you just separate them by a space in the same string. For example: "call of duty" will follow only tweets that contain 'call', 'of' and 'Duty'. You can also just follow a specific Twitter account by using the option **follows**. For more information about the Twitter input, go to the complete [Twitter input documentation](https://www.elastic.co/guide/en/logstash/6.7/plugins-inputs-twitter.html). - -You must use two additional parameters: - -- **type** will be useful for our Logstash filters -- **full_tweet** is here to fetch all the metadata from the tweet. - -#### Filter plugin configuration - -Actually, if you want a minimal Twitter configuration, this could be enough. But our goal is to analyze trends, hashtags, mentions, user activities etc. In order to do this, we need to have at least a clear view of the main objects contained in a tweet: hashtags and mentions. Both of them are normally embedded in a tweet event but Logs Data Platform need flat objects, so we will have to extract them. The goal is to have three different objects: tweets, hashtags and mentions so that we can freely analyze them or correlate them. Here is the filter configuration: - -```ruby -if [type] == "tweet" { - - mutate { - add_field => { - "message" => "%{text}" - "full_message" => "%{text}" - "hashtags" => "%{[entities][hashtags]}" - "mentions" => "%{[entities][user_mentions]}" - "host" => "twitter" - "tweet_url" => "https://twitter.com/%{[user][screen_name]}/status/%{id_str}" - "user_screen_name" => "%{[user][screen_name]}" - "user_id" => "%{[user][id_str]}" - "user_followers_count_int" => "%{[user][followers_count]}" - "user_friends_count_int" => "%{[user][friends_count]}" - "user_listed_count_int" => "%{[user][listed_count]}" - "user_favourites_count_int" => "%{[user][favourites_count]}" - "user_statuses_count_int" => "%{[user][statuses_count]}" - "user_profile_image_url" => "%{[user][profile_image_url_https]}" - "user_verified_bool" => "%{[user][verified]}" - } - remove_field => ["timestamp_ms"] - } - - if [user][profile_banner_url] { - mutate { - add_field => { - "user_profile_banner_url" => "%{[user][profile_banner_url]}" - } - } - } - - if [retweeted_status] { - mutate { - add_field => { - "retweeted_status_user_screen_name" => "%{[retweeted_status][user][screen_name]}" - "retweeted_status_tweet_url" => "https://twitter.com/%{[retweeted_status][user][screen_name]}/status/%{[retweeted_status][id_str]}" - } - } - } - - if [entities][user_mentions] and [type] == "tweet" { - clone { - clones => ["mention"] - } - } - - if [entities][hashtags] and [type] == "tweet" { - clone { - clones => ["hashtag"] - } - } - -} - -if [type] == "hashtag" { - - split { - field => "[entities][hashtags]" - } - - mutate { - add_field => { - "hashtag" => "%{[entities][hashtags][text]}" - "indice_begin_int" => "%{[entities][hashtags][indices][0]}" - "indice_end_int" => "%{[entities][hashtags][indices][1]}" - } - remove_field => [ "retweet_count", "retweeted_status", "user", "text", "filter_level", "favorite_count", "extended_tweet", "entities"] - update => { - "message" => "#%{[entities][hashtags][text]}" - } - } - -} - -if [type] == "mention" { - - split { - field => "[entities][user_mentions]" - } - - mutate { - add_field => { - "mention" => "%{[entities][user_mentions][screen_name]}" - "mention_user_id_" => "%{[entities][user_mentions][id]}" - "indice_begin_int" => "%{[entities][user_mentions][indices][0]}" - "indice_end_int" => "%{[entities][user_mentions][indices][1]}" - } - remove_field => [ "retweet_count", "retweeted_status", "user", "text", "filter_level", "favorite_count", "extended_tweet", "entities"] - update => { - "message" => "@%{[entities][user_mentions][screen_name]}" - } - } - -} -``` - -The configuration looks quite long and complex, it is in fact split into three parts: the *tweet type section*, the *hashtag type section* and the *mention type section* - -- The tweet type section: In this section, we select all the objects that have the *tweet* type. We use the *mutate filter* to extract and move some information at the top level of the event. We also remove unneeded information as id_str or timestamp_ms. Then we use [conditional expressions](https://www.elastic.co/guide/en/logstash/6.7/event-dependent-configuration.html) to extract information and to create hashtags and mentions objects. The *clone filters* will create a new event that will contain a copy of the full tweet and will tag it as a hashtag or mention type. They will execute only if mentions or hashtags are present. -- The hashtag type section: In this section, the hashtags of a tweet will be split into distinct events so a tweet that has 4 hashtags will generate 4 events of type hashtag. That's the purpose of the *split filter*. After the split filter, there is a mutate filter that will promote some information at the top level of the event and remove unnecessary information for this type of object. It will also change the message to the hashtag text itself with the preceding 'hash' character. -- The mention type section: It is pretty much the same as the hashtag one. One *split filter* to create mentions events and one *mutate filter* to extract, delete and modify useful information. - -We could have applied the same process for the media entities for example. The workflow would have been the same: Extract the entities from the tweet by cloning it with the media type, add a media type section with a split and mutate filter to generate different events. - -Now that we have our filter, test the configuration, and then start the collector ! Head to your Graylog Stream attached to the collector to analyze your data! - -### Analyze tweets in Graylog - -Depending on the popularity of your keywords, you may or may not have any information in your stream yet. If you don't have any, check that the input started correctly or try it with more popular subjects:-). Here are some examples of queries you can use in your Graylog stream: - -If you want to know what is the number of tweets over time just type in the Graylog search bar: -``` -type:tweet -``` -This will give you only the tweets without hashtag nor mentions objects. - -To search for a particular subject just type it in the search bar (with double-quotes): -``` -"Final Fantasy XV" -``` - -If you want the hashtags, type: -``` -type:hashtag -``` -This will give you the hashtags list. - -How to list all tweets from @PlayStation? -``` -type:tweet AND user_screen_name:PlayStation -``` - -What are the most popular hashtags? -Use the left panel to select the *Quick Values widget* for the value **hashtag** to display a listing of the most frequent values. - -What are the most popular hashtags associated with Nintendo? -You can combine the query and the quick values by issuing a query in the search bar first: -``` -type:hashtag AND Nintendo. Then use the *Quick Values Widget* again -``` - -Which tweets contain 'xbox'? -``` -type:tweet AND message:*xbox* -``` - -How many times @xboxuk is mentioned? -``` -mention:xboxuk -``` - -In which tweets? -``` -type:tweet AND mentions:*xboxuk* -``` -Note here that we used the *mentions* field (with a final 's') on the tweet to retrieve the mention. Moreover with all objects types, you always have the original tweet message in the full_message field. - -How to list tweets from "popular" users? -``` -type:tweet AND user_followers_count_int:>5000 -``` - -How to list all hashtags on the PlayStation subject except the PlayStation hashtag? -``` -type:hashtag AND playstation AND NOT hashtag:PlayStation -``` - -How to list all tweets except retweets? -``` -type:tweet AND NOT _exists_:retweet_status -``` - -There are many more possibilities. Of course you can create beautiful dashboards from all this information to visualize your data: - -![Dashboards](images/dashboard.png){.thumbnail} - -That's all for now. If you have any proposition or trouble with this tutorial, don't hesitate to reach us on the [Community hub](https://community.ovh.com/en/c/Platform/data-platforms). - -## Go further - -- Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- Documentation: [Guides](/products/observability-logs-data-platform) -- Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) diff --git a/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/guide.pt-pt.md b/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/guide.pt-pt.md deleted file mode 100644 index 95d5613e3d3..00000000000 --- a/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/guide.pt-pt.md +++ /dev/null @@ -1,264 +0,0 @@ ---- -title: Analyzing Twitter with Logs Data Platform -excerpt: Logs Data Platform can be used in multiple ways. Twitter feed and keyword analysis is one of them. -updated: 2019-04-10 ---- - -## Objective - -Twitter can be an amazing source to have a direct feedback on your products or events, track a particular subject to find new business opportunities or just to follow the most important people of your network. You can use Logs Data Platform to fully exploit this data flow with the Logstash collector feature and its powerful plugins. This guide will show you how to analyze your tweets using the Logs Data Platform. - -## Requirements - -Prior to completing this guide, you should read the following: - -- [Quick Start of Logs Data Platform](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- [Field naming conventions](/pages/manage_and_operate/observability/logs_data_platform/getting_started_field_naming_convention) -- [Logstash collector](/pages/manage_and_operate/observability/logs_data_platform/ingestion_logstash_dedicated_input) - -If you have completely understood these three guides, let's dive into this one. - -## Instructions - -### Logstash collector configuration - -#### Twitter application creation - -Logstash has a powerful Twitter Input plugin. This plugin allows you to connect to the Stream API of Twitter and to listen for incoming tweets. In order to do this, it just needs your Twitter account API Keys. They are free and can be retrieved with a Twitter account. Log in your Twitter account in: [https://apps.twitter.com/](https://apps.twitter.com/) and click on create a new app. Fill a name, a description and a website for your project. Read and agree to the Twitter Developer Agreement to proceed. You will then arrive on the application webpage: - -![twitter_app](images/twitter-app.png){.thumbnail} - -From there, head to the **Keys and Access Tokens tab** and click on the **Create my access token** button at the bottom of the page. So you have now a total of 4 keys that identify your access: - -Two main application Keys located at the top: - -- The Consumer Key -- The Consumer Secret - -Two API access Keys located below: - -- The Access Token -- The Access Token Secret - -Note that you can configure the access levels on both your app and tokens. All these keys will be used in the Twitter input plugin of Logstash. Now let's configure our Twitter logstash collector! - -#### Logstash collector creation - -In the Logs Data Platform manager, create a Logstash collector. On the creation page, as usual fill a Name and a Description and leave the default port since it will not be used (The logstash input will connect to Twitter by itself). Also attach your collector to a dedicated stream. The only important thing is to create only one instance. If not, you will have several instances fetching the same data from Twitter and sending it to your stream multiple times. - -![single_instance](images/single_instance.png){.thumbnail} - -#### Twitter input plugin configuration - -Once your collector has been created, head to the configuration page, this is where the real fun begins! To configure your input plugin, you need the Twitter Keys created before. Here is a configuration snippet of the Twitter plugin input: - -```ruby -twitter { - consumer_key => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - consumer_secret => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXx" - oauth_token => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - oauth_token_secret => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - keywords => [ "playstation","Nintendo","xbox"] - type => "tweet" - full_tweet => true -} -``` - -Fill the consumer Keys and Secret with the keys you obtained at the Twitter app configuration step. The oauth_token and the oauth_token_secret are the Access Token and Access Token Secret you created just before. - -The keywords array is the special array where you can specify which keywords you want to follow. Here I want to follow the three different competitors of the famous #ConsoleWars. If you want to follow tweets that contain multiple terms simultaneously you just separate them by a space in the same string. For example: "call of duty" will follow only tweets that contain 'call', 'of' and 'Duty'. You can also just follow a specific Twitter account by using the option **follows**. For more information about the Twitter input, go to the complete [Twitter input documentation](https://www.elastic.co/guide/en/logstash/6.7/plugins-inputs-twitter.html). - -You must use two additional parameters: - -- **type** will be useful for our Logstash filters -- **full_tweet** is here to fetch all the metadata from the tweet. - -#### Filter plugin configuration - -Actually, if you want a minimal Twitter configuration, this could be enough. But our goal is to analyze trends, hashtags, mentions, user activities etc. In order to do this, we need to have at least a clear view of the main objects contained in a tweet: hashtags and mentions. Both of them are normally embedded in a tweet event but Logs Data Platform need flat objects, so we will have to extract them. The goal is to have three different objects: tweets, hashtags and mentions so that we can freely analyze them or correlate them. Here is the filter configuration: - -```ruby -if [type] == "tweet" { - - mutate { - add_field => { - "message" => "%{text}" - "full_message" => "%{text}" - "hashtags" => "%{[entities][hashtags]}" - "mentions" => "%{[entities][user_mentions]}" - "host" => "twitter" - "tweet_url" => "https://twitter.com/%{[user][screen_name]}/status/%{id_str}" - "user_screen_name" => "%{[user][screen_name]}" - "user_id" => "%{[user][id_str]}" - "user_followers_count_int" => "%{[user][followers_count]}" - "user_friends_count_int" => "%{[user][friends_count]}" - "user_listed_count_int" => "%{[user][listed_count]}" - "user_favourites_count_int" => "%{[user][favourites_count]}" - "user_statuses_count_int" => "%{[user][statuses_count]}" - "user_profile_image_url" => "%{[user][profile_image_url_https]}" - "user_verified_bool" => "%{[user][verified]}" - } - remove_field => ["timestamp_ms"] - } - - if [user][profile_banner_url] { - mutate { - add_field => { - "user_profile_banner_url" => "%{[user][profile_banner_url]}" - } - } - } - - if [retweeted_status] { - mutate { - add_field => { - "retweeted_status_user_screen_name" => "%{[retweeted_status][user][screen_name]}" - "retweeted_status_tweet_url" => "https://twitter.com/%{[retweeted_status][user][screen_name]}/status/%{[retweeted_status][id_str]}" - } - } - } - - if [entities][user_mentions] and [type] == "tweet" { - clone { - clones => ["mention"] - } - } - - if [entities][hashtags] and [type] == "tweet" { - clone { - clones => ["hashtag"] - } - } - -} - -if [type] == "hashtag" { - - split { - field => "[entities][hashtags]" - } - - mutate { - add_field => { - "hashtag" => "%{[entities][hashtags][text]}" - "indice_begin_int" => "%{[entities][hashtags][indices][0]}" - "indice_end_int" => "%{[entities][hashtags][indices][1]}" - } - remove_field => [ "retweet_count", "retweeted_status", "user", "text", "filter_level", "favorite_count", "extended_tweet", "entities"] - update => { - "message" => "#%{[entities][hashtags][text]}" - } - } - -} - -if [type] == "mention" { - - split { - field => "[entities][user_mentions]" - } - - mutate { - add_field => { - "mention" => "%{[entities][user_mentions][screen_name]}" - "mention_user_id_" => "%{[entities][user_mentions][id]}" - "indice_begin_int" => "%{[entities][user_mentions][indices][0]}" - "indice_end_int" => "%{[entities][user_mentions][indices][1]}" - } - remove_field => [ "retweet_count", "retweeted_status", "user", "text", "filter_level", "favorite_count", "extended_tweet", "entities"] - update => { - "message" => "@%{[entities][user_mentions][screen_name]}" - } - } - -} -``` - -The configuration looks quite long and complex, it is in fact split into three parts: the *tweet type section*, the *hashtag type section* and the *mention type section* - -- The tweet type section: In this section, we select all the objects that have the *tweet* type. We use the *mutate filter* to extract and move some information at the top level of the event. We also remove unneeded information as id_str or timestamp_ms. Then we use [conditional expressions](https://www.elastic.co/guide/en/logstash/6.7/event-dependent-configuration.html) to extract information and to create hashtags and mentions objects. The *clone filters* will create a new event that will contain a copy of the full tweet and will tag it as a hashtag or mention type. They will execute only if mentions or hashtags are present. -- The hashtag type section: In this section, the hashtags of a tweet will be split into distinct events so a tweet that has 4 hashtags will generate 4 events of type hashtag. That's the purpose of the *split filter*. After the split filter, there is a mutate filter that will promote some information at the top level of the event and remove unnecessary information for this type of object. It will also change the message to the hashtag text itself with the preceding 'hash' character. -- The mention type section: It is pretty much the same as the hashtag one. One *split filter* to create mentions events and one *mutate filter* to extract, delete and modify useful information. - -We could have applied the same process for the media entities for example. The workflow would have been the same: Extract the entities from the tweet by cloning it with the media type, add a media type section with a split and mutate filter to generate different events. - -Now that we have our filter, test the configuration, and then start the collector ! Head to your Graylog Stream attached to the collector to analyze your data! - -### Analyze tweets in Graylog - -Depending on the popularity of your keywords, you may or may not have any information in your stream yet. If you don't have any, check that the input started correctly or try it with more popular subjects:-). Here are some examples of queries you can use in your Graylog stream: - -If you want to know what is the number of tweets over time just type in the Graylog search bar: -``` -type:tweet -``` -This will give you only the tweets without hashtag nor mentions objects. - -To search for a particular subject just type it in the search bar (with double-quotes): -``` -"Final Fantasy XV" -``` - -If you want the hashtags, type: -``` -type:hashtag -``` -This will give you the hashtags list. - -How to list all tweets from @PlayStation? -``` -type:tweet AND user_screen_name:PlayStation -``` - -What are the most popular hashtags? -Use the left panel to select the *Quick Values widget* for the value **hashtag** to display a listing of the most frequent values. - -What are the most popular hashtags associated with Nintendo? -You can combine the query and the quick values by issuing a query in the search bar first: -``` -type:hashtag AND Nintendo. Then use the *Quick Values Widget* again -``` - -Which tweets contain 'xbox'? -``` -type:tweet AND message:*xbox* -``` - -How many times @xboxuk is mentioned? -``` -mention:xboxuk -``` - -In which tweets? -``` -type:tweet AND mentions:*xboxuk* -``` -Note here that we used the *mentions* field (with a final 's') on the tweet to retrieve the mention. Moreover with all objects types, you always have the original tweet message in the full_message field. - -How to list tweets from "popular" users? -``` -type:tweet AND user_followers_count_int:>5000 -``` - -How to list all hashtags on the PlayStation subject except the PlayStation hashtag? -``` -type:hashtag AND playstation AND NOT hashtag:PlayStation -``` - -How to list all tweets except retweets? -``` -type:tweet AND NOT _exists_:retweet_status -``` - -There are many more possibilities. Of course you can create beautiful dashboards from all this information to visualize your data: - -![Dashboards](images/dashboard.png){.thumbnail} - -That's all for now. If you have any proposition or trouble with this tutorial, don't hesitate to reach us on the [Community hub](https://community.ovh.com/en/c/Platform/data-platforms). - -## Go further - -- Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- Documentation: [Guides](/products/observability-logs-data-platform) -- Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) diff --git a/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/images/dashboard.png b/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/images/dashboard.png deleted file mode 100644 index 58d6706cee8..00000000000 Binary files a/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/images/dashboard.png and /dev/null differ diff --git a/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/images/single_instance.png b/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/images/single_instance.png deleted file mode 100644 index 88fae87c649..00000000000 Binary files a/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/images/single_instance.png and /dev/null differ diff --git a/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/images/twitter-app.png b/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/images/twitter-app.png deleted file mode 100644 index e818b477a8a..00000000000 Binary files a/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/images/twitter-app.png and /dev/null differ diff --git a/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/meta.yaml b/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/meta.yaml deleted file mode 100755 index e412f53b993..00000000000 --- a/pages/manage_and_operate/observability/logs_data_platform/usecase_twitter/meta.yaml +++ /dev/null @@ -1,2 +0,0 @@ -id: b4a69f6b-45c8-4015-b114-ca4e8c32dc5c -full_slug: logs-data-platform-twitter \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.de-de.md b/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.de-de.md index e36899ea883..cc3c564d33c 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.de-de.md +++ b/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.de-de.md @@ -1,6 +1,6 @@ --- title: Using Grafana with Logs Data Platform -updated: 2024-11-28 +updated: 2025-10-16 --- ## Objective @@ -12,7 +12,7 @@ updated: 2024-11-28 This is what you need to know to get you started: - you are already sending logs on a stream you own [see the quick start tutorial](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- Your have access to the port 9200 to your cluster (head to the **Home** page in manager to know the address of your cluster). +- you have access to the port 9200 to your cluster (head to the **Home** page in manager to know the address of your cluster) After some training you will be able to create this kind of dashboard: @@ -52,7 +52,7 @@ If everything is setup properly, launch your favorite browser, and point it to [ > To make the magic happen, please ensure to: > > - Set `https://.logs.ovh.com:9200` as **URL** value -> - Set your Logs Data Platform credentials for **Basic auth values** +> - Set your [Logs Data Platform credentials](/pages/manage_and_operate/observability/logs_data_platform/security_tokens) for **Basic auth values** > - Set the **Index name** as the Logs Data Platform alias linked to Grafana > - Change default **Time field name** to timestamp > - Set the **Version** by clicking `Get Version and Save`{.action}. @@ -64,7 +64,6 @@ If your configuration is correct, it should display: " _Index Ok. Timefield Ok._ ![Data source 2](images/datasource_2.png){.thumbnail} To explore further, you can create a new dashboard and add different styles of visualizations. - If you want to know what you can do with Grafana and OpenSearch, read the [official documentation](https://grafana.com/grafana/plugins/grafana-opensearch-datasource/). ## Go further @@ -72,4 +71,4 @@ If you want to know what you can do with Grafana and OpenSearch, read the [offic - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.en-asia.md b/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.en-asia.md index e36899ea883..cc3c564d33c 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.en-asia.md +++ b/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.en-asia.md @@ -1,6 +1,6 @@ --- title: Using Grafana with Logs Data Platform -updated: 2024-11-28 +updated: 2025-10-16 --- ## Objective @@ -12,7 +12,7 @@ updated: 2024-11-28 This is what you need to know to get you started: - you are already sending logs on a stream you own [see the quick start tutorial](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- Your have access to the port 9200 to your cluster (head to the **Home** page in manager to know the address of your cluster). +- you have access to the port 9200 to your cluster (head to the **Home** page in manager to know the address of your cluster) After some training you will be able to create this kind of dashboard: @@ -52,7 +52,7 @@ If everything is setup properly, launch your favorite browser, and point it to [ > To make the magic happen, please ensure to: > > - Set `https://.logs.ovh.com:9200` as **URL** value -> - Set your Logs Data Platform credentials for **Basic auth values** +> - Set your [Logs Data Platform credentials](/pages/manage_and_operate/observability/logs_data_platform/security_tokens) for **Basic auth values** > - Set the **Index name** as the Logs Data Platform alias linked to Grafana > - Change default **Time field name** to timestamp > - Set the **Version** by clicking `Get Version and Save`{.action}. @@ -64,7 +64,6 @@ If your configuration is correct, it should display: " _Index Ok. Timefield Ok._ ![Data source 2](images/datasource_2.png){.thumbnail} To explore further, you can create a new dashboard and add different styles of visualizations. - If you want to know what you can do with Grafana and OpenSearch, read the [official documentation](https://grafana.com/grafana/plugins/grafana-opensearch-datasource/). ## Go further @@ -72,4 +71,4 @@ If you want to know what you can do with Grafana and OpenSearch, read the [offic - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.en-au.md b/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.en-au.md index e36899ea883..cc3c564d33c 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.en-au.md +++ b/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.en-au.md @@ -1,6 +1,6 @@ --- title: Using Grafana with Logs Data Platform -updated: 2024-11-28 +updated: 2025-10-16 --- ## Objective @@ -12,7 +12,7 @@ updated: 2024-11-28 This is what you need to know to get you started: - you are already sending logs on a stream you own [see the quick start tutorial](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- Your have access to the port 9200 to your cluster (head to the **Home** page in manager to know the address of your cluster). +- you have access to the port 9200 to your cluster (head to the **Home** page in manager to know the address of your cluster) After some training you will be able to create this kind of dashboard: @@ -52,7 +52,7 @@ If everything is setup properly, launch your favorite browser, and point it to [ > To make the magic happen, please ensure to: > > - Set `https://.logs.ovh.com:9200` as **URL** value -> - Set your Logs Data Platform credentials for **Basic auth values** +> - Set your [Logs Data Platform credentials](/pages/manage_and_operate/observability/logs_data_platform/security_tokens) for **Basic auth values** > - Set the **Index name** as the Logs Data Platform alias linked to Grafana > - Change default **Time field name** to timestamp > - Set the **Version** by clicking `Get Version and Save`{.action}. @@ -64,7 +64,6 @@ If your configuration is correct, it should display: " _Index Ok. Timefield Ok._ ![Data source 2](images/datasource_2.png){.thumbnail} To explore further, you can create a new dashboard and add different styles of visualizations. - If you want to know what you can do with Grafana and OpenSearch, read the [official documentation](https://grafana.com/grafana/plugins/grafana-opensearch-datasource/). ## Go further @@ -72,4 +71,4 @@ If you want to know what you can do with Grafana and OpenSearch, read the [offic - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.en-ca.md b/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.en-ca.md index e36899ea883..cc3c564d33c 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.en-ca.md +++ b/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.en-ca.md @@ -1,6 +1,6 @@ --- title: Using Grafana with Logs Data Platform -updated: 2024-11-28 +updated: 2025-10-16 --- ## Objective @@ -12,7 +12,7 @@ updated: 2024-11-28 This is what you need to know to get you started: - you are already sending logs on a stream you own [see the quick start tutorial](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- Your have access to the port 9200 to your cluster (head to the **Home** page in manager to know the address of your cluster). +- you have access to the port 9200 to your cluster (head to the **Home** page in manager to know the address of your cluster) After some training you will be able to create this kind of dashboard: @@ -52,7 +52,7 @@ If everything is setup properly, launch your favorite browser, and point it to [ > To make the magic happen, please ensure to: > > - Set `https://.logs.ovh.com:9200` as **URL** value -> - Set your Logs Data Platform credentials for **Basic auth values** +> - Set your [Logs Data Platform credentials](/pages/manage_and_operate/observability/logs_data_platform/security_tokens) for **Basic auth values** > - Set the **Index name** as the Logs Data Platform alias linked to Grafana > - Change default **Time field name** to timestamp > - Set the **Version** by clicking `Get Version and Save`{.action}. @@ -64,7 +64,6 @@ If your configuration is correct, it should display: " _Index Ok. Timefield Ok._ ![Data source 2](images/datasource_2.png){.thumbnail} To explore further, you can create a new dashboard and add different styles of visualizations. - If you want to know what you can do with Grafana and OpenSearch, read the [official documentation](https://grafana.com/grafana/plugins/grafana-opensearch-datasource/). ## Go further @@ -72,4 +71,4 @@ If you want to know what you can do with Grafana and OpenSearch, read the [offic - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.en-gb.md b/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.en-gb.md index aed250f647b..cc3c564d33c 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.en-gb.md +++ b/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.en-gb.md @@ -1,6 +1,6 @@ --- title: Using Grafana with Logs Data Platform -updated: 2024-11-28 +updated: 2025-10-16 --- ## Objective @@ -52,7 +52,7 @@ If everything is setup properly, launch your favorite browser, and point it to [ > To make the magic happen, please ensure to: > > - Set `https://.logs.ovh.com:9200` as **URL** value -> - Set your Logs Data Platform credentials for **Basic auth values** +> - Set your [Logs Data Platform credentials](/pages/manage_and_operate/observability/logs_data_platform/security_tokens) for **Basic auth values** > - Set the **Index name** as the Logs Data Platform alias linked to Grafana > - Change default **Time field name** to timestamp > - Set the **Version** by clicking `Get Version and Save`{.action}. @@ -71,4 +71,4 @@ If you want to know what you can do with Grafana and OpenSearch, read the [offic - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.en-ie.md b/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.en-ie.md index e36899ea883..cc3c564d33c 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.en-ie.md +++ b/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.en-ie.md @@ -1,6 +1,6 @@ --- title: Using Grafana with Logs Data Platform -updated: 2024-11-28 +updated: 2025-10-16 --- ## Objective @@ -12,7 +12,7 @@ updated: 2024-11-28 This is what you need to know to get you started: - you are already sending logs on a stream you own [see the quick start tutorial](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- Your have access to the port 9200 to your cluster (head to the **Home** page in manager to know the address of your cluster). +- you have access to the port 9200 to your cluster (head to the **Home** page in manager to know the address of your cluster) After some training you will be able to create this kind of dashboard: @@ -52,7 +52,7 @@ If everything is setup properly, launch your favorite browser, and point it to [ > To make the magic happen, please ensure to: > > - Set `https://.logs.ovh.com:9200` as **URL** value -> - Set your Logs Data Platform credentials for **Basic auth values** +> - Set your [Logs Data Platform credentials](/pages/manage_and_operate/observability/logs_data_platform/security_tokens) for **Basic auth values** > - Set the **Index name** as the Logs Data Platform alias linked to Grafana > - Change default **Time field name** to timestamp > - Set the **Version** by clicking `Get Version and Save`{.action}. @@ -64,7 +64,6 @@ If your configuration is correct, it should display: " _Index Ok. Timefield Ok._ ![Data source 2](images/datasource_2.png){.thumbnail} To explore further, you can create a new dashboard and add different styles of visualizations. - If you want to know what you can do with Grafana and OpenSearch, read the [official documentation](https://grafana.com/grafana/plugins/grafana-opensearch-datasource/). ## Go further @@ -72,4 +71,4 @@ If you want to know what you can do with Grafana and OpenSearch, read the [offic - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.en-sg.md b/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.en-sg.md index e36899ea883..cc3c564d33c 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.en-sg.md +++ b/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.en-sg.md @@ -1,6 +1,6 @@ --- title: Using Grafana with Logs Data Platform -updated: 2024-11-28 +updated: 2025-10-16 --- ## Objective @@ -12,7 +12,7 @@ updated: 2024-11-28 This is what you need to know to get you started: - you are already sending logs on a stream you own [see the quick start tutorial](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- Your have access to the port 9200 to your cluster (head to the **Home** page in manager to know the address of your cluster). +- you have access to the port 9200 to your cluster (head to the **Home** page in manager to know the address of your cluster) After some training you will be able to create this kind of dashboard: @@ -52,7 +52,7 @@ If everything is setup properly, launch your favorite browser, and point it to [ > To make the magic happen, please ensure to: > > - Set `https://.logs.ovh.com:9200` as **URL** value -> - Set your Logs Data Platform credentials for **Basic auth values** +> - Set your [Logs Data Platform credentials](/pages/manage_and_operate/observability/logs_data_platform/security_tokens) for **Basic auth values** > - Set the **Index name** as the Logs Data Platform alias linked to Grafana > - Change default **Time field name** to timestamp > - Set the **Version** by clicking `Get Version and Save`{.action}. @@ -64,7 +64,6 @@ If your configuration is correct, it should display: " _Index Ok. Timefield Ok._ ![Data source 2](images/datasource_2.png){.thumbnail} To explore further, you can create a new dashboard and add different styles of visualizations. - If you want to know what you can do with Grafana and OpenSearch, read the [official documentation](https://grafana.com/grafana/plugins/grafana-opensearch-datasource/). ## Go further @@ -72,4 +71,4 @@ If you want to know what you can do with Grafana and OpenSearch, read the [offic - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.en-us.md b/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.en-us.md index e36899ea883..cc3c564d33c 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.en-us.md +++ b/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.en-us.md @@ -1,6 +1,6 @@ --- title: Using Grafana with Logs Data Platform -updated: 2024-11-28 +updated: 2025-10-16 --- ## Objective @@ -12,7 +12,7 @@ updated: 2024-11-28 This is what you need to know to get you started: - you are already sending logs on a stream you own [see the quick start tutorial](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- Your have access to the port 9200 to your cluster (head to the **Home** page in manager to know the address of your cluster). +- you have access to the port 9200 to your cluster (head to the **Home** page in manager to know the address of your cluster) After some training you will be able to create this kind of dashboard: @@ -52,7 +52,7 @@ If everything is setup properly, launch your favorite browser, and point it to [ > To make the magic happen, please ensure to: > > - Set `https://.logs.ovh.com:9200` as **URL** value -> - Set your Logs Data Platform credentials for **Basic auth values** +> - Set your [Logs Data Platform credentials](/pages/manage_and_operate/observability/logs_data_platform/security_tokens) for **Basic auth values** > - Set the **Index name** as the Logs Data Platform alias linked to Grafana > - Change default **Time field name** to timestamp > - Set the **Version** by clicking `Get Version and Save`{.action}. @@ -64,7 +64,6 @@ If your configuration is correct, it should display: " _Index Ok. Timefield Ok._ ![Data source 2](images/datasource_2.png){.thumbnail} To explore further, you can create a new dashboard and add different styles of visualizations. - If you want to know what you can do with Grafana and OpenSearch, read the [official documentation](https://grafana.com/grafana/plugins/grafana-opensearch-datasource/). ## Go further @@ -72,4 +71,4 @@ If you want to know what you can do with Grafana and OpenSearch, read the [offic - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.es-es.md b/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.es-es.md index e36899ea883..cc3c564d33c 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.es-es.md +++ b/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.es-es.md @@ -1,6 +1,6 @@ --- title: Using Grafana with Logs Data Platform -updated: 2024-11-28 +updated: 2025-10-16 --- ## Objective @@ -12,7 +12,7 @@ updated: 2024-11-28 This is what you need to know to get you started: - you are already sending logs on a stream you own [see the quick start tutorial](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- Your have access to the port 9200 to your cluster (head to the **Home** page in manager to know the address of your cluster). +- you have access to the port 9200 to your cluster (head to the **Home** page in manager to know the address of your cluster) After some training you will be able to create this kind of dashboard: @@ -52,7 +52,7 @@ If everything is setup properly, launch your favorite browser, and point it to [ > To make the magic happen, please ensure to: > > - Set `https://.logs.ovh.com:9200` as **URL** value -> - Set your Logs Data Platform credentials for **Basic auth values** +> - Set your [Logs Data Platform credentials](/pages/manage_and_operate/observability/logs_data_platform/security_tokens) for **Basic auth values** > - Set the **Index name** as the Logs Data Platform alias linked to Grafana > - Change default **Time field name** to timestamp > - Set the **Version** by clicking `Get Version and Save`{.action}. @@ -64,7 +64,6 @@ If your configuration is correct, it should display: " _Index Ok. Timefield Ok._ ![Data source 2](images/datasource_2.png){.thumbnail} To explore further, you can create a new dashboard and add different styles of visualizations. - If you want to know what you can do with Grafana and OpenSearch, read the [official documentation](https://grafana.com/grafana/plugins/grafana-opensearch-datasource/). ## Go further @@ -72,4 +71,4 @@ If you want to know what you can do with Grafana and OpenSearch, read the [offic - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.es-us.md b/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.es-us.md index e36899ea883..cc3c564d33c 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.es-us.md +++ b/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.es-us.md @@ -1,6 +1,6 @@ --- title: Using Grafana with Logs Data Platform -updated: 2024-11-28 +updated: 2025-10-16 --- ## Objective @@ -12,7 +12,7 @@ updated: 2024-11-28 This is what you need to know to get you started: - you are already sending logs on a stream you own [see the quick start tutorial](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- Your have access to the port 9200 to your cluster (head to the **Home** page in manager to know the address of your cluster). +- you have access to the port 9200 to your cluster (head to the **Home** page in manager to know the address of your cluster) After some training you will be able to create this kind of dashboard: @@ -52,7 +52,7 @@ If everything is setup properly, launch your favorite browser, and point it to [ > To make the magic happen, please ensure to: > > - Set `https://.logs.ovh.com:9200` as **URL** value -> - Set your Logs Data Platform credentials for **Basic auth values** +> - Set your [Logs Data Platform credentials](/pages/manage_and_operate/observability/logs_data_platform/security_tokens) for **Basic auth values** > - Set the **Index name** as the Logs Data Platform alias linked to Grafana > - Change default **Time field name** to timestamp > - Set the **Version** by clicking `Get Version and Save`{.action}. @@ -64,7 +64,6 @@ If your configuration is correct, it should display: " _Index Ok. Timefield Ok._ ![Data source 2](images/datasource_2.png){.thumbnail} To explore further, you can create a new dashboard and add different styles of visualizations. - If you want to know what you can do with Grafana and OpenSearch, read the [official documentation](https://grafana.com/grafana/plugins/grafana-opensearch-datasource/). ## Go further @@ -72,4 +71,4 @@ If you want to know what you can do with Grafana and OpenSearch, read the [offic - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.fr-ca.md b/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.fr-ca.md index e36899ea883..cc3c564d33c 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.fr-ca.md +++ b/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.fr-ca.md @@ -1,6 +1,6 @@ --- title: Using Grafana with Logs Data Platform -updated: 2024-11-28 +updated: 2025-10-16 --- ## Objective @@ -12,7 +12,7 @@ updated: 2024-11-28 This is what you need to know to get you started: - you are already sending logs on a stream you own [see the quick start tutorial](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- Your have access to the port 9200 to your cluster (head to the **Home** page in manager to know the address of your cluster). +- you have access to the port 9200 to your cluster (head to the **Home** page in manager to know the address of your cluster) After some training you will be able to create this kind of dashboard: @@ -52,7 +52,7 @@ If everything is setup properly, launch your favorite browser, and point it to [ > To make the magic happen, please ensure to: > > - Set `https://.logs.ovh.com:9200` as **URL** value -> - Set your Logs Data Platform credentials for **Basic auth values** +> - Set your [Logs Data Platform credentials](/pages/manage_and_operate/observability/logs_data_platform/security_tokens) for **Basic auth values** > - Set the **Index name** as the Logs Data Platform alias linked to Grafana > - Change default **Time field name** to timestamp > - Set the **Version** by clicking `Get Version and Save`{.action}. @@ -64,7 +64,6 @@ If your configuration is correct, it should display: " _Index Ok. Timefield Ok._ ![Data source 2](images/datasource_2.png){.thumbnail} To explore further, you can create a new dashboard and add different styles of visualizations. - If you want to know what you can do with Grafana and OpenSearch, read the [official documentation](https://grafana.com/grafana/plugins/grafana-opensearch-datasource/). ## Go further @@ -72,4 +71,4 @@ If you want to know what you can do with Grafana and OpenSearch, read the [offic - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.fr-fr.md b/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.fr-fr.md index e36899ea883..cc3c564d33c 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.fr-fr.md +++ b/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.fr-fr.md @@ -1,6 +1,6 @@ --- title: Using Grafana with Logs Data Platform -updated: 2024-11-28 +updated: 2025-10-16 --- ## Objective @@ -12,7 +12,7 @@ updated: 2024-11-28 This is what you need to know to get you started: - you are already sending logs on a stream you own [see the quick start tutorial](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- Your have access to the port 9200 to your cluster (head to the **Home** page in manager to know the address of your cluster). +- you have access to the port 9200 to your cluster (head to the **Home** page in manager to know the address of your cluster) After some training you will be able to create this kind of dashboard: @@ -52,7 +52,7 @@ If everything is setup properly, launch your favorite browser, and point it to [ > To make the magic happen, please ensure to: > > - Set `https://.logs.ovh.com:9200` as **URL** value -> - Set your Logs Data Platform credentials for **Basic auth values** +> - Set your [Logs Data Platform credentials](/pages/manage_and_operate/observability/logs_data_platform/security_tokens) for **Basic auth values** > - Set the **Index name** as the Logs Data Platform alias linked to Grafana > - Change default **Time field name** to timestamp > - Set the **Version** by clicking `Get Version and Save`{.action}. @@ -64,7 +64,6 @@ If your configuration is correct, it should display: " _Index Ok. Timefield Ok._ ![Data source 2](images/datasource_2.png){.thumbnail} To explore further, you can create a new dashboard and add different styles of visualizations. - If you want to know what you can do with Grafana and OpenSearch, read the [official documentation](https://grafana.com/grafana/plugins/grafana-opensearch-datasource/). ## Go further @@ -72,4 +71,4 @@ If you want to know what you can do with Grafana and OpenSearch, read the [offic - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.it-it.md b/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.it-it.md index e36899ea883..cc3c564d33c 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.it-it.md +++ b/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.it-it.md @@ -1,6 +1,6 @@ --- title: Using Grafana with Logs Data Platform -updated: 2024-11-28 +updated: 2025-10-16 --- ## Objective @@ -12,7 +12,7 @@ updated: 2024-11-28 This is what you need to know to get you started: - you are already sending logs on a stream you own [see the quick start tutorial](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- Your have access to the port 9200 to your cluster (head to the **Home** page in manager to know the address of your cluster). +- you have access to the port 9200 to your cluster (head to the **Home** page in manager to know the address of your cluster) After some training you will be able to create this kind of dashboard: @@ -52,7 +52,7 @@ If everything is setup properly, launch your favorite browser, and point it to [ > To make the magic happen, please ensure to: > > - Set `https://.logs.ovh.com:9200` as **URL** value -> - Set your Logs Data Platform credentials for **Basic auth values** +> - Set your [Logs Data Platform credentials](/pages/manage_and_operate/observability/logs_data_platform/security_tokens) for **Basic auth values** > - Set the **Index name** as the Logs Data Platform alias linked to Grafana > - Change default **Time field name** to timestamp > - Set the **Version** by clicking `Get Version and Save`{.action}. @@ -64,7 +64,6 @@ If your configuration is correct, it should display: " _Index Ok. Timefield Ok._ ![Data source 2](images/datasource_2.png){.thumbnail} To explore further, you can create a new dashboard and add different styles of visualizations. - If you want to know what you can do with Grafana and OpenSearch, read the [official documentation](https://grafana.com/grafana/plugins/grafana-opensearch-datasource/). ## Go further @@ -72,4 +71,4 @@ If you want to know what you can do with Grafana and OpenSearch, read the [offic - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.pl-pl.md b/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.pl-pl.md index e36899ea883..cc3c564d33c 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.pl-pl.md +++ b/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.pl-pl.md @@ -1,6 +1,6 @@ --- title: Using Grafana with Logs Data Platform -updated: 2024-11-28 +updated: 2025-10-16 --- ## Objective @@ -12,7 +12,7 @@ updated: 2024-11-28 This is what you need to know to get you started: - you are already sending logs on a stream you own [see the quick start tutorial](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- Your have access to the port 9200 to your cluster (head to the **Home** page in manager to know the address of your cluster). +- you have access to the port 9200 to your cluster (head to the **Home** page in manager to know the address of your cluster) After some training you will be able to create this kind of dashboard: @@ -52,7 +52,7 @@ If everything is setup properly, launch your favorite browser, and point it to [ > To make the magic happen, please ensure to: > > - Set `https://.logs.ovh.com:9200` as **URL** value -> - Set your Logs Data Platform credentials for **Basic auth values** +> - Set your [Logs Data Platform credentials](/pages/manage_and_operate/observability/logs_data_platform/security_tokens) for **Basic auth values** > - Set the **Index name** as the Logs Data Platform alias linked to Grafana > - Change default **Time field name** to timestamp > - Set the **Version** by clicking `Get Version and Save`{.action}. @@ -64,7 +64,6 @@ If your configuration is correct, it should display: " _Index Ok. Timefield Ok._ ![Data source 2](images/datasource_2.png){.thumbnail} To explore further, you can create a new dashboard and add different styles of visualizations. - If you want to know what you can do with Grafana and OpenSearch, read the [official documentation](https://grafana.com/grafana/plugins/grafana-opensearch-datasource/). ## Go further @@ -72,4 +71,4 @@ If you want to know what you can do with Grafana and OpenSearch, read the [offic - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.pt-pt.md b/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.pt-pt.md index e36899ea883..cc3c564d33c 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.pt-pt.md +++ b/pages/manage_and_operate/observability/logs_data_platform/visualization_grafana/guide.pt-pt.md @@ -1,6 +1,6 @@ --- title: Using Grafana with Logs Data Platform -updated: 2024-11-28 +updated: 2025-10-16 --- ## Objective @@ -12,7 +12,7 @@ updated: 2024-11-28 This is what you need to know to get you started: - you are already sending logs on a stream you own [see the quick start tutorial](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) -- Your have access to the port 9200 to your cluster (head to the **Home** page in manager to know the address of your cluster). +- you have access to the port 9200 to your cluster (head to the **Home** page in manager to know the address of your cluster) After some training you will be able to create this kind of dashboard: @@ -52,7 +52,7 @@ If everything is setup properly, launch your favorite browser, and point it to [ > To make the magic happen, please ensure to: > > - Set `https://.logs.ovh.com:9200` as **URL** value -> - Set your Logs Data Platform credentials for **Basic auth values** +> - Set your [Logs Data Platform credentials](/pages/manage_and_operate/observability/logs_data_platform/security_tokens) for **Basic auth values** > - Set the **Index name** as the Logs Data Platform alias linked to Grafana > - Change default **Time field name** to timestamp > - Set the **Version** by clicking `Get Version and Save`{.action}. @@ -64,7 +64,6 @@ If your configuration is correct, it should display: " _Index Ok. Timefield Ok._ ![Data source 2](images/datasource_2.png){.thumbnail} To explore further, you can create a new dashboard and add different styles of visualizations. - If you want to know what you can do with Grafana and OpenSearch, read the [official documentation](https://grafana.com/grafana/plugins/grafana-opensearch-datasource/). ## Go further @@ -72,4 +71,4 @@ If you want to know what you can do with Grafana and OpenSearch, read the [offic - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.de-de.md b/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.de-de.md index eb221ad283e..0883ac71423 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.de-de.md +++ b/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.de-de.md @@ -1,6 +1,6 @@ --- title: Using OpenSearch Dashboards with Logs Data Platform -updated: 2022-06-13 +updated: 2025-10-16 --- ## Objective @@ -38,7 +38,7 @@ So now Logs Data Platform knows which stream you want to browse. Now let's confi ### Access your OpenSearch Dashboards instance -To create your OpenSearch Dashboards instance, click on OpenSearch Dashboards tab, Click on `Add a instance`{.action}, put a description and click on **Order** to launch the creation of your instance. Your instance will be created and delivered in approximatively 20 minutes. +To create your OpenSearch Dashboards instance, click on OpenSearch Dashboards tab, click on `Add a instance`{.action}, put a description and click on **Order** to launch the creation of your instance. Your instance will be created and delivered in approximately 20 minutes. ![osd creation](images/osd_created.png){.thumbnail} @@ -46,9 +46,9 @@ Use the **...** menu to the right and select `Access to your OpenSearch Dashboar ![osd access](images/url.png){.thumbnail} -Once there, use your LDP credentials to sign in and set on the first page. Click on the `Add data`{.action} button to add sample data you can play with. However if you want to use your own data, you must configure **Index Patterns** in the stack management page. This page is accessible by clicking on the `Manage`{.action} button next to the "Add data" button. You can also use the "Stack Management" option in the left side menu, displayable by using the top left the sandwich button. +Once there, use the right Identity provider to sign in and set on the first page. Click on the `Add data`{.action} button to add sample data you can play with. However if you want to use your own data, you must configure **Index Patterns** in the stack management page. This page is accessible by clicking on the `Manage`{.action} button next to the "Add data" button. You can also use the "Stack Management" option in the left side menu, displayable by using the top left the sandwich button. -In this configuration page, you can configure as the Index name, the full name of your alias **logs-XXXXX-a-XXXXX**, but you can also use wildcards. Choose **timestamp** for the time field name then click on Discover tab to read your log entries. +In this configuration page, you can configure as the Index name, the full name of your alias **ldp-XXXXX-a-XXXXX**, but you can also use wildcards. Choose **timestamp** for the time field name then click on Discover tab to read your log entries. ![osd setup](images/osd_setup.png){.thumbnail} @@ -61,4 +61,4 @@ To know what you can do with OpenSearch Dashboards, read the [OpenSearch Dashboa - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.en-asia.md b/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.en-asia.md index eb221ad283e..0883ac71423 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.en-asia.md +++ b/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.en-asia.md @@ -1,6 +1,6 @@ --- title: Using OpenSearch Dashboards with Logs Data Platform -updated: 2022-06-13 +updated: 2025-10-16 --- ## Objective @@ -38,7 +38,7 @@ So now Logs Data Platform knows which stream you want to browse. Now let's confi ### Access your OpenSearch Dashboards instance -To create your OpenSearch Dashboards instance, click on OpenSearch Dashboards tab, Click on `Add a instance`{.action}, put a description and click on **Order** to launch the creation of your instance. Your instance will be created and delivered in approximatively 20 minutes. +To create your OpenSearch Dashboards instance, click on OpenSearch Dashboards tab, click on `Add a instance`{.action}, put a description and click on **Order** to launch the creation of your instance. Your instance will be created and delivered in approximately 20 minutes. ![osd creation](images/osd_created.png){.thumbnail} @@ -46,9 +46,9 @@ Use the **...** menu to the right and select `Access to your OpenSearch Dashboar ![osd access](images/url.png){.thumbnail} -Once there, use your LDP credentials to sign in and set on the first page. Click on the `Add data`{.action} button to add sample data you can play with. However if you want to use your own data, you must configure **Index Patterns** in the stack management page. This page is accessible by clicking on the `Manage`{.action} button next to the "Add data" button. You can also use the "Stack Management" option in the left side menu, displayable by using the top left the sandwich button. +Once there, use the right Identity provider to sign in and set on the first page. Click on the `Add data`{.action} button to add sample data you can play with. However if you want to use your own data, you must configure **Index Patterns** in the stack management page. This page is accessible by clicking on the `Manage`{.action} button next to the "Add data" button. You can also use the "Stack Management" option in the left side menu, displayable by using the top left the sandwich button. -In this configuration page, you can configure as the Index name, the full name of your alias **logs-XXXXX-a-XXXXX**, but you can also use wildcards. Choose **timestamp** for the time field name then click on Discover tab to read your log entries. +In this configuration page, you can configure as the Index name, the full name of your alias **ldp-XXXXX-a-XXXXX**, but you can also use wildcards. Choose **timestamp** for the time field name then click on Discover tab to read your log entries. ![osd setup](images/osd_setup.png){.thumbnail} @@ -61,4 +61,4 @@ To know what you can do with OpenSearch Dashboards, read the [OpenSearch Dashboa - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.en-au.md b/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.en-au.md index eb221ad283e..0883ac71423 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.en-au.md +++ b/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.en-au.md @@ -1,6 +1,6 @@ --- title: Using OpenSearch Dashboards with Logs Data Platform -updated: 2022-06-13 +updated: 2025-10-16 --- ## Objective @@ -38,7 +38,7 @@ So now Logs Data Platform knows which stream you want to browse. Now let's confi ### Access your OpenSearch Dashboards instance -To create your OpenSearch Dashboards instance, click on OpenSearch Dashboards tab, Click on `Add a instance`{.action}, put a description and click on **Order** to launch the creation of your instance. Your instance will be created and delivered in approximatively 20 minutes. +To create your OpenSearch Dashboards instance, click on OpenSearch Dashboards tab, click on `Add a instance`{.action}, put a description and click on **Order** to launch the creation of your instance. Your instance will be created and delivered in approximately 20 minutes. ![osd creation](images/osd_created.png){.thumbnail} @@ -46,9 +46,9 @@ Use the **...** menu to the right and select `Access to your OpenSearch Dashboar ![osd access](images/url.png){.thumbnail} -Once there, use your LDP credentials to sign in and set on the first page. Click on the `Add data`{.action} button to add sample data you can play with. However if you want to use your own data, you must configure **Index Patterns** in the stack management page. This page is accessible by clicking on the `Manage`{.action} button next to the "Add data" button. You can also use the "Stack Management" option in the left side menu, displayable by using the top left the sandwich button. +Once there, use the right Identity provider to sign in and set on the first page. Click on the `Add data`{.action} button to add sample data you can play with. However if you want to use your own data, you must configure **Index Patterns** in the stack management page. This page is accessible by clicking on the `Manage`{.action} button next to the "Add data" button. You can also use the "Stack Management" option in the left side menu, displayable by using the top left the sandwich button. -In this configuration page, you can configure as the Index name, the full name of your alias **logs-XXXXX-a-XXXXX**, but you can also use wildcards. Choose **timestamp** for the time field name then click on Discover tab to read your log entries. +In this configuration page, you can configure as the Index name, the full name of your alias **ldp-XXXXX-a-XXXXX**, but you can also use wildcards. Choose **timestamp** for the time field name then click on Discover tab to read your log entries. ![osd setup](images/osd_setup.png){.thumbnail} @@ -61,4 +61,4 @@ To know what you can do with OpenSearch Dashboards, read the [OpenSearch Dashboa - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.en-ca.md b/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.en-ca.md index eb221ad283e..0883ac71423 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.en-ca.md +++ b/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.en-ca.md @@ -1,6 +1,6 @@ --- title: Using OpenSearch Dashboards with Logs Data Platform -updated: 2022-06-13 +updated: 2025-10-16 --- ## Objective @@ -38,7 +38,7 @@ So now Logs Data Platform knows which stream you want to browse. Now let's confi ### Access your OpenSearch Dashboards instance -To create your OpenSearch Dashboards instance, click on OpenSearch Dashboards tab, Click on `Add a instance`{.action}, put a description and click on **Order** to launch the creation of your instance. Your instance will be created and delivered in approximatively 20 minutes. +To create your OpenSearch Dashboards instance, click on OpenSearch Dashboards tab, click on `Add a instance`{.action}, put a description and click on **Order** to launch the creation of your instance. Your instance will be created and delivered in approximately 20 minutes. ![osd creation](images/osd_created.png){.thumbnail} @@ -46,9 +46,9 @@ Use the **...** menu to the right and select `Access to your OpenSearch Dashboar ![osd access](images/url.png){.thumbnail} -Once there, use your LDP credentials to sign in and set on the first page. Click on the `Add data`{.action} button to add sample data you can play with. However if you want to use your own data, you must configure **Index Patterns** in the stack management page. This page is accessible by clicking on the `Manage`{.action} button next to the "Add data" button. You can also use the "Stack Management" option in the left side menu, displayable by using the top left the sandwich button. +Once there, use the right Identity provider to sign in and set on the first page. Click on the `Add data`{.action} button to add sample data you can play with. However if you want to use your own data, you must configure **Index Patterns** in the stack management page. This page is accessible by clicking on the `Manage`{.action} button next to the "Add data" button. You can also use the "Stack Management" option in the left side menu, displayable by using the top left the sandwich button. -In this configuration page, you can configure as the Index name, the full name of your alias **logs-XXXXX-a-XXXXX**, but you can also use wildcards. Choose **timestamp** for the time field name then click on Discover tab to read your log entries. +In this configuration page, you can configure as the Index name, the full name of your alias **ldp-XXXXX-a-XXXXX**, but you can also use wildcards. Choose **timestamp** for the time field name then click on Discover tab to read your log entries. ![osd setup](images/osd_setup.png){.thumbnail} @@ -61,4 +61,4 @@ To know what you can do with OpenSearch Dashboards, read the [OpenSearch Dashboa - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.en-gb.md b/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.en-gb.md index 4bbc2ec3c7c..0883ac71423 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.en-gb.md +++ b/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.en-gb.md @@ -1,6 +1,6 @@ --- title: Using OpenSearch Dashboards with Logs Data Platform -updated: 2022-06-13 +updated: 2025-10-16 --- ## Objective @@ -38,7 +38,7 @@ So now Logs Data Platform knows which stream you want to browse. Now let's confi ### Access your OpenSearch Dashboards instance -To create your OpenSearch Dashboards instance, click on OpenSearch Dashboards tab, Click on `Add a instance`{.action}, put a description and click on **Order** to launch the creation of your instance. Your instance will be created and delivered in approximately 20 minutes. +To create your OpenSearch Dashboards instance, click on OpenSearch Dashboards tab, click on `Add a instance`{.action}, put a description and click on **Order** to launch the creation of your instance. Your instance will be created and delivered in approximately 20 minutes. ![osd creation](images/osd_created.png){.thumbnail} @@ -46,9 +46,9 @@ Use the **...** menu to the right and select `Access to your OpenSearch Dashboar ![osd access](images/url.png){.thumbnail} -Once there, use your LDP credentials to sign in and set on the first page. Click on the `Add data`{.action} button to add sample data you can play with. However if you want to use your own data, you must configure **Index Patterns** in the stack management page. This page is accessible by clicking on the `Manage`{.action} button next to the "Add data" button. You can also use the "Stack Management" option in the left side menu, displayable by using the top left the sandwich button. +Once there, use the right Identity provider to sign in and set on the first page. Click on the `Add data`{.action} button to add sample data you can play with. However if you want to use your own data, you must configure **Index Patterns** in the stack management page. This page is accessible by clicking on the `Manage`{.action} button next to the "Add data" button. You can also use the "Stack Management" option in the left side menu, displayable by using the top left the sandwich button. -In this configuration page, you can configure as the Index name, the full name of your alias **logs-XXXXX-a-XXXXX**, but you can also use wildcards. Choose **timestamp** for the time field name then click on Discover tab to read your log entries. +In this configuration page, you can configure as the Index name, the full name of your alias **ldp-XXXXX-a-XXXXX**, but you can also use wildcards. Choose **timestamp** for the time field name then click on Discover tab to read your log entries. ![osd setup](images/osd_setup.png){.thumbnail} @@ -61,5 +61,4 @@ To know what you can do with OpenSearch Dashboards, read the [OpenSearch Dashboa - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) - +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.en-ie.md b/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.en-ie.md index eb221ad283e..0883ac71423 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.en-ie.md +++ b/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.en-ie.md @@ -1,6 +1,6 @@ --- title: Using OpenSearch Dashboards with Logs Data Platform -updated: 2022-06-13 +updated: 2025-10-16 --- ## Objective @@ -38,7 +38,7 @@ So now Logs Data Platform knows which stream you want to browse. Now let's confi ### Access your OpenSearch Dashboards instance -To create your OpenSearch Dashboards instance, click on OpenSearch Dashboards tab, Click on `Add a instance`{.action}, put a description and click on **Order** to launch the creation of your instance. Your instance will be created and delivered in approximatively 20 minutes. +To create your OpenSearch Dashboards instance, click on OpenSearch Dashboards tab, click on `Add a instance`{.action}, put a description and click on **Order** to launch the creation of your instance. Your instance will be created and delivered in approximately 20 minutes. ![osd creation](images/osd_created.png){.thumbnail} @@ -46,9 +46,9 @@ Use the **...** menu to the right and select `Access to your OpenSearch Dashboar ![osd access](images/url.png){.thumbnail} -Once there, use your LDP credentials to sign in and set on the first page. Click on the `Add data`{.action} button to add sample data you can play with. However if you want to use your own data, you must configure **Index Patterns** in the stack management page. This page is accessible by clicking on the `Manage`{.action} button next to the "Add data" button. You can also use the "Stack Management" option in the left side menu, displayable by using the top left the sandwich button. +Once there, use the right Identity provider to sign in and set on the first page. Click on the `Add data`{.action} button to add sample data you can play with. However if you want to use your own data, you must configure **Index Patterns** in the stack management page. This page is accessible by clicking on the `Manage`{.action} button next to the "Add data" button. You can also use the "Stack Management" option in the left side menu, displayable by using the top left the sandwich button. -In this configuration page, you can configure as the Index name, the full name of your alias **logs-XXXXX-a-XXXXX**, but you can also use wildcards. Choose **timestamp** for the time field name then click on Discover tab to read your log entries. +In this configuration page, you can configure as the Index name, the full name of your alias **ldp-XXXXX-a-XXXXX**, but you can also use wildcards. Choose **timestamp** for the time field name then click on Discover tab to read your log entries. ![osd setup](images/osd_setup.png){.thumbnail} @@ -61,4 +61,4 @@ To know what you can do with OpenSearch Dashboards, read the [OpenSearch Dashboa - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.en-sg.md b/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.en-sg.md index eb221ad283e..0883ac71423 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.en-sg.md +++ b/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.en-sg.md @@ -1,6 +1,6 @@ --- title: Using OpenSearch Dashboards with Logs Data Platform -updated: 2022-06-13 +updated: 2025-10-16 --- ## Objective @@ -38,7 +38,7 @@ So now Logs Data Platform knows which stream you want to browse. Now let's confi ### Access your OpenSearch Dashboards instance -To create your OpenSearch Dashboards instance, click on OpenSearch Dashboards tab, Click on `Add a instance`{.action}, put a description and click on **Order** to launch the creation of your instance. Your instance will be created and delivered in approximatively 20 minutes. +To create your OpenSearch Dashboards instance, click on OpenSearch Dashboards tab, click on `Add a instance`{.action}, put a description and click on **Order** to launch the creation of your instance. Your instance will be created and delivered in approximately 20 minutes. ![osd creation](images/osd_created.png){.thumbnail} @@ -46,9 +46,9 @@ Use the **...** menu to the right and select `Access to your OpenSearch Dashboar ![osd access](images/url.png){.thumbnail} -Once there, use your LDP credentials to sign in and set on the first page. Click on the `Add data`{.action} button to add sample data you can play with. However if you want to use your own data, you must configure **Index Patterns** in the stack management page. This page is accessible by clicking on the `Manage`{.action} button next to the "Add data" button. You can also use the "Stack Management" option in the left side menu, displayable by using the top left the sandwich button. +Once there, use the right Identity provider to sign in and set on the first page. Click on the `Add data`{.action} button to add sample data you can play with. However if you want to use your own data, you must configure **Index Patterns** in the stack management page. This page is accessible by clicking on the `Manage`{.action} button next to the "Add data" button. You can also use the "Stack Management" option in the left side menu, displayable by using the top left the sandwich button. -In this configuration page, you can configure as the Index name, the full name of your alias **logs-XXXXX-a-XXXXX**, but you can also use wildcards. Choose **timestamp** for the time field name then click on Discover tab to read your log entries. +In this configuration page, you can configure as the Index name, the full name of your alias **ldp-XXXXX-a-XXXXX**, but you can also use wildcards. Choose **timestamp** for the time field name then click on Discover tab to read your log entries. ![osd setup](images/osd_setup.png){.thumbnail} @@ -61,4 +61,4 @@ To know what you can do with OpenSearch Dashboards, read the [OpenSearch Dashboa - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.en-us.md b/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.en-us.md index eb221ad283e..0883ac71423 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.en-us.md +++ b/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.en-us.md @@ -1,6 +1,6 @@ --- title: Using OpenSearch Dashboards with Logs Data Platform -updated: 2022-06-13 +updated: 2025-10-16 --- ## Objective @@ -38,7 +38,7 @@ So now Logs Data Platform knows which stream you want to browse. Now let's confi ### Access your OpenSearch Dashboards instance -To create your OpenSearch Dashboards instance, click on OpenSearch Dashboards tab, Click on `Add a instance`{.action}, put a description and click on **Order** to launch the creation of your instance. Your instance will be created and delivered in approximatively 20 minutes. +To create your OpenSearch Dashboards instance, click on OpenSearch Dashboards tab, click on `Add a instance`{.action}, put a description and click on **Order** to launch the creation of your instance. Your instance will be created and delivered in approximately 20 minutes. ![osd creation](images/osd_created.png){.thumbnail} @@ -46,9 +46,9 @@ Use the **...** menu to the right and select `Access to your OpenSearch Dashboar ![osd access](images/url.png){.thumbnail} -Once there, use your LDP credentials to sign in and set on the first page. Click on the `Add data`{.action} button to add sample data you can play with. However if you want to use your own data, you must configure **Index Patterns** in the stack management page. This page is accessible by clicking on the `Manage`{.action} button next to the "Add data" button. You can also use the "Stack Management" option in the left side menu, displayable by using the top left the sandwich button. +Once there, use the right Identity provider to sign in and set on the first page. Click on the `Add data`{.action} button to add sample data you can play with. However if you want to use your own data, you must configure **Index Patterns** in the stack management page. This page is accessible by clicking on the `Manage`{.action} button next to the "Add data" button. You can also use the "Stack Management" option in the left side menu, displayable by using the top left the sandwich button. -In this configuration page, you can configure as the Index name, the full name of your alias **logs-XXXXX-a-XXXXX**, but you can also use wildcards. Choose **timestamp** for the time field name then click on Discover tab to read your log entries. +In this configuration page, you can configure as the Index name, the full name of your alias **ldp-XXXXX-a-XXXXX**, but you can also use wildcards. Choose **timestamp** for the time field name then click on Discover tab to read your log entries. ![osd setup](images/osd_setup.png){.thumbnail} @@ -61,4 +61,4 @@ To know what you can do with OpenSearch Dashboards, read the [OpenSearch Dashboa - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.es-es.md b/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.es-es.md index eb221ad283e..0883ac71423 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.es-es.md +++ b/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.es-es.md @@ -1,6 +1,6 @@ --- title: Using OpenSearch Dashboards with Logs Data Platform -updated: 2022-06-13 +updated: 2025-10-16 --- ## Objective @@ -38,7 +38,7 @@ So now Logs Data Platform knows which stream you want to browse. Now let's confi ### Access your OpenSearch Dashboards instance -To create your OpenSearch Dashboards instance, click on OpenSearch Dashboards tab, Click on `Add a instance`{.action}, put a description and click on **Order** to launch the creation of your instance. Your instance will be created and delivered in approximatively 20 minutes. +To create your OpenSearch Dashboards instance, click on OpenSearch Dashboards tab, click on `Add a instance`{.action}, put a description and click on **Order** to launch the creation of your instance. Your instance will be created and delivered in approximately 20 minutes. ![osd creation](images/osd_created.png){.thumbnail} @@ -46,9 +46,9 @@ Use the **...** menu to the right and select `Access to your OpenSearch Dashboar ![osd access](images/url.png){.thumbnail} -Once there, use your LDP credentials to sign in and set on the first page. Click on the `Add data`{.action} button to add sample data you can play with. However if you want to use your own data, you must configure **Index Patterns** in the stack management page. This page is accessible by clicking on the `Manage`{.action} button next to the "Add data" button. You can also use the "Stack Management" option in the left side menu, displayable by using the top left the sandwich button. +Once there, use the right Identity provider to sign in and set on the first page. Click on the `Add data`{.action} button to add sample data you can play with. However if you want to use your own data, you must configure **Index Patterns** in the stack management page. This page is accessible by clicking on the `Manage`{.action} button next to the "Add data" button. You can also use the "Stack Management" option in the left side menu, displayable by using the top left the sandwich button. -In this configuration page, you can configure as the Index name, the full name of your alias **logs-XXXXX-a-XXXXX**, but you can also use wildcards. Choose **timestamp** for the time field name then click on Discover tab to read your log entries. +In this configuration page, you can configure as the Index name, the full name of your alias **ldp-XXXXX-a-XXXXX**, but you can also use wildcards. Choose **timestamp** for the time field name then click on Discover tab to read your log entries. ![osd setup](images/osd_setup.png){.thumbnail} @@ -61,4 +61,4 @@ To know what you can do with OpenSearch Dashboards, read the [OpenSearch Dashboa - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.es-us.md b/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.es-us.md index eb221ad283e..0883ac71423 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.es-us.md +++ b/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.es-us.md @@ -1,6 +1,6 @@ --- title: Using OpenSearch Dashboards with Logs Data Platform -updated: 2022-06-13 +updated: 2025-10-16 --- ## Objective @@ -38,7 +38,7 @@ So now Logs Data Platform knows which stream you want to browse. Now let's confi ### Access your OpenSearch Dashboards instance -To create your OpenSearch Dashboards instance, click on OpenSearch Dashboards tab, Click on `Add a instance`{.action}, put a description and click on **Order** to launch the creation of your instance. Your instance will be created and delivered in approximatively 20 minutes. +To create your OpenSearch Dashboards instance, click on OpenSearch Dashboards tab, click on `Add a instance`{.action}, put a description and click on **Order** to launch the creation of your instance. Your instance will be created and delivered in approximately 20 minutes. ![osd creation](images/osd_created.png){.thumbnail} @@ -46,9 +46,9 @@ Use the **...** menu to the right and select `Access to your OpenSearch Dashboar ![osd access](images/url.png){.thumbnail} -Once there, use your LDP credentials to sign in and set on the first page. Click on the `Add data`{.action} button to add sample data you can play with. However if you want to use your own data, you must configure **Index Patterns** in the stack management page. This page is accessible by clicking on the `Manage`{.action} button next to the "Add data" button. You can also use the "Stack Management" option in the left side menu, displayable by using the top left the sandwich button. +Once there, use the right Identity provider to sign in and set on the first page. Click on the `Add data`{.action} button to add sample data you can play with. However if you want to use your own data, you must configure **Index Patterns** in the stack management page. This page is accessible by clicking on the `Manage`{.action} button next to the "Add data" button. You can also use the "Stack Management" option in the left side menu, displayable by using the top left the sandwich button. -In this configuration page, you can configure as the Index name, the full name of your alias **logs-XXXXX-a-XXXXX**, but you can also use wildcards. Choose **timestamp** for the time field name then click on Discover tab to read your log entries. +In this configuration page, you can configure as the Index name, the full name of your alias **ldp-XXXXX-a-XXXXX**, but you can also use wildcards. Choose **timestamp** for the time field name then click on Discover tab to read your log entries. ![osd setup](images/osd_setup.png){.thumbnail} @@ -61,4 +61,4 @@ To know what you can do with OpenSearch Dashboards, read the [OpenSearch Dashboa - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.fr-ca.md b/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.fr-ca.md index eb221ad283e..0883ac71423 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.fr-ca.md +++ b/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.fr-ca.md @@ -1,6 +1,6 @@ --- title: Using OpenSearch Dashboards with Logs Data Platform -updated: 2022-06-13 +updated: 2025-10-16 --- ## Objective @@ -38,7 +38,7 @@ So now Logs Data Platform knows which stream you want to browse. Now let's confi ### Access your OpenSearch Dashboards instance -To create your OpenSearch Dashboards instance, click on OpenSearch Dashboards tab, Click on `Add a instance`{.action}, put a description and click on **Order** to launch the creation of your instance. Your instance will be created and delivered in approximatively 20 minutes. +To create your OpenSearch Dashboards instance, click on OpenSearch Dashboards tab, click on `Add a instance`{.action}, put a description and click on **Order** to launch the creation of your instance. Your instance will be created and delivered in approximately 20 minutes. ![osd creation](images/osd_created.png){.thumbnail} @@ -46,9 +46,9 @@ Use the **...** menu to the right and select `Access to your OpenSearch Dashboar ![osd access](images/url.png){.thumbnail} -Once there, use your LDP credentials to sign in and set on the first page. Click on the `Add data`{.action} button to add sample data you can play with. However if you want to use your own data, you must configure **Index Patterns** in the stack management page. This page is accessible by clicking on the `Manage`{.action} button next to the "Add data" button. You can also use the "Stack Management" option in the left side menu, displayable by using the top left the sandwich button. +Once there, use the right Identity provider to sign in and set on the first page. Click on the `Add data`{.action} button to add sample data you can play with. However if you want to use your own data, you must configure **Index Patterns** in the stack management page. This page is accessible by clicking on the `Manage`{.action} button next to the "Add data" button. You can also use the "Stack Management" option in the left side menu, displayable by using the top left the sandwich button. -In this configuration page, you can configure as the Index name, the full name of your alias **logs-XXXXX-a-XXXXX**, but you can also use wildcards. Choose **timestamp** for the time field name then click on Discover tab to read your log entries. +In this configuration page, you can configure as the Index name, the full name of your alias **ldp-XXXXX-a-XXXXX**, but you can also use wildcards. Choose **timestamp** for the time field name then click on Discover tab to read your log entries. ![osd setup](images/osd_setup.png){.thumbnail} @@ -61,4 +61,4 @@ To know what you can do with OpenSearch Dashboards, read the [OpenSearch Dashboa - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.fr-fr.md b/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.fr-fr.md index eb221ad283e..0883ac71423 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.fr-fr.md +++ b/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.fr-fr.md @@ -1,6 +1,6 @@ --- title: Using OpenSearch Dashboards with Logs Data Platform -updated: 2022-06-13 +updated: 2025-10-16 --- ## Objective @@ -38,7 +38,7 @@ So now Logs Data Platform knows which stream you want to browse. Now let's confi ### Access your OpenSearch Dashboards instance -To create your OpenSearch Dashboards instance, click on OpenSearch Dashboards tab, Click on `Add a instance`{.action}, put a description and click on **Order** to launch the creation of your instance. Your instance will be created and delivered in approximatively 20 minutes. +To create your OpenSearch Dashboards instance, click on OpenSearch Dashboards tab, click on `Add a instance`{.action}, put a description and click on **Order** to launch the creation of your instance. Your instance will be created and delivered in approximately 20 minutes. ![osd creation](images/osd_created.png){.thumbnail} @@ -46,9 +46,9 @@ Use the **...** menu to the right and select `Access to your OpenSearch Dashboar ![osd access](images/url.png){.thumbnail} -Once there, use your LDP credentials to sign in and set on the first page. Click on the `Add data`{.action} button to add sample data you can play with. However if you want to use your own data, you must configure **Index Patterns** in the stack management page. This page is accessible by clicking on the `Manage`{.action} button next to the "Add data" button. You can also use the "Stack Management" option in the left side menu, displayable by using the top left the sandwich button. +Once there, use the right Identity provider to sign in and set on the first page. Click on the `Add data`{.action} button to add sample data you can play with. However if you want to use your own data, you must configure **Index Patterns** in the stack management page. This page is accessible by clicking on the `Manage`{.action} button next to the "Add data" button. You can also use the "Stack Management" option in the left side menu, displayable by using the top left the sandwich button. -In this configuration page, you can configure as the Index name, the full name of your alias **logs-XXXXX-a-XXXXX**, but you can also use wildcards. Choose **timestamp** for the time field name then click on Discover tab to read your log entries. +In this configuration page, you can configure as the Index name, the full name of your alias **ldp-XXXXX-a-XXXXX**, but you can also use wildcards. Choose **timestamp** for the time field name then click on Discover tab to read your log entries. ![osd setup](images/osd_setup.png){.thumbnail} @@ -61,4 +61,4 @@ To know what you can do with OpenSearch Dashboards, read the [OpenSearch Dashboa - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.it-it.md b/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.it-it.md index eb221ad283e..0883ac71423 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.it-it.md +++ b/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.it-it.md @@ -1,6 +1,6 @@ --- title: Using OpenSearch Dashboards with Logs Data Platform -updated: 2022-06-13 +updated: 2025-10-16 --- ## Objective @@ -38,7 +38,7 @@ So now Logs Data Platform knows which stream you want to browse. Now let's confi ### Access your OpenSearch Dashboards instance -To create your OpenSearch Dashboards instance, click on OpenSearch Dashboards tab, Click on `Add a instance`{.action}, put a description and click on **Order** to launch the creation of your instance. Your instance will be created and delivered in approximatively 20 minutes. +To create your OpenSearch Dashboards instance, click on OpenSearch Dashboards tab, click on `Add a instance`{.action}, put a description and click on **Order** to launch the creation of your instance. Your instance will be created and delivered in approximately 20 minutes. ![osd creation](images/osd_created.png){.thumbnail} @@ -46,9 +46,9 @@ Use the **...** menu to the right and select `Access to your OpenSearch Dashboar ![osd access](images/url.png){.thumbnail} -Once there, use your LDP credentials to sign in and set on the first page. Click on the `Add data`{.action} button to add sample data you can play with. However if you want to use your own data, you must configure **Index Patterns** in the stack management page. This page is accessible by clicking on the `Manage`{.action} button next to the "Add data" button. You can also use the "Stack Management" option in the left side menu, displayable by using the top left the sandwich button. +Once there, use the right Identity provider to sign in and set on the first page. Click on the `Add data`{.action} button to add sample data you can play with. However if you want to use your own data, you must configure **Index Patterns** in the stack management page. This page is accessible by clicking on the `Manage`{.action} button next to the "Add data" button. You can also use the "Stack Management" option in the left side menu, displayable by using the top left the sandwich button. -In this configuration page, you can configure as the Index name, the full name of your alias **logs-XXXXX-a-XXXXX**, but you can also use wildcards. Choose **timestamp** for the time field name then click on Discover tab to read your log entries. +In this configuration page, you can configure as the Index name, the full name of your alias **ldp-XXXXX-a-XXXXX**, but you can also use wildcards. Choose **timestamp** for the time field name then click on Discover tab to read your log entries. ![osd setup](images/osd_setup.png){.thumbnail} @@ -61,4 +61,4 @@ To know what you can do with OpenSearch Dashboards, read the [OpenSearch Dashboa - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.pl-pl.md b/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.pl-pl.md index eb221ad283e..0883ac71423 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.pl-pl.md +++ b/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.pl-pl.md @@ -1,6 +1,6 @@ --- title: Using OpenSearch Dashboards with Logs Data Platform -updated: 2022-06-13 +updated: 2025-10-16 --- ## Objective @@ -38,7 +38,7 @@ So now Logs Data Platform knows which stream you want to browse. Now let's confi ### Access your OpenSearch Dashboards instance -To create your OpenSearch Dashboards instance, click on OpenSearch Dashboards tab, Click on `Add a instance`{.action}, put a description and click on **Order** to launch the creation of your instance. Your instance will be created and delivered in approximatively 20 minutes. +To create your OpenSearch Dashboards instance, click on OpenSearch Dashboards tab, click on `Add a instance`{.action}, put a description and click on **Order** to launch the creation of your instance. Your instance will be created and delivered in approximately 20 minutes. ![osd creation](images/osd_created.png){.thumbnail} @@ -46,9 +46,9 @@ Use the **...** menu to the right and select `Access to your OpenSearch Dashboar ![osd access](images/url.png){.thumbnail} -Once there, use your LDP credentials to sign in and set on the first page. Click on the `Add data`{.action} button to add sample data you can play with. However if you want to use your own data, you must configure **Index Patterns** in the stack management page. This page is accessible by clicking on the `Manage`{.action} button next to the "Add data" button. You can also use the "Stack Management" option in the left side menu, displayable by using the top left the sandwich button. +Once there, use the right Identity provider to sign in and set on the first page. Click on the `Add data`{.action} button to add sample data you can play with. However if you want to use your own data, you must configure **Index Patterns** in the stack management page. This page is accessible by clicking on the `Manage`{.action} button next to the "Add data" button. You can also use the "Stack Management" option in the left side menu, displayable by using the top left the sandwich button. -In this configuration page, you can configure as the Index name, the full name of your alias **logs-XXXXX-a-XXXXX**, but you can also use wildcards. Choose **timestamp** for the time field name then click on Discover tab to read your log entries. +In this configuration page, you can configure as the Index name, the full name of your alias **ldp-XXXXX-a-XXXXX**, but you can also use wildcards. Choose **timestamp** for the time field name then click on Discover tab to read your log entries. ![osd setup](images/osd_setup.png){.thumbnail} @@ -61,4 +61,4 @@ To know what you can do with OpenSearch Dashboards, read the [OpenSearch Dashboa - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.pt-pt.md b/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.pt-pt.md index eb221ad283e..0883ac71423 100644 --- a/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.pt-pt.md +++ b/pages/manage_and_operate/observability/logs_data_platform/visualization_opensearch_dashboards/guide.pt-pt.md @@ -1,6 +1,6 @@ --- title: Using OpenSearch Dashboards with Logs Data Platform -updated: 2022-06-13 +updated: 2025-10-16 --- ## Objective @@ -38,7 +38,7 @@ So now Logs Data Platform knows which stream you want to browse. Now let's confi ### Access your OpenSearch Dashboards instance -To create your OpenSearch Dashboards instance, click on OpenSearch Dashboards tab, Click on `Add a instance`{.action}, put a description and click on **Order** to launch the creation of your instance. Your instance will be created and delivered in approximatively 20 minutes. +To create your OpenSearch Dashboards instance, click on OpenSearch Dashboards tab, click on `Add a instance`{.action}, put a description and click on **Order** to launch the creation of your instance. Your instance will be created and delivered in approximately 20 minutes. ![osd creation](images/osd_created.png){.thumbnail} @@ -46,9 +46,9 @@ Use the **...** menu to the right and select `Access to your OpenSearch Dashboar ![osd access](images/url.png){.thumbnail} -Once there, use your LDP credentials to sign in and set on the first page. Click on the `Add data`{.action} button to add sample data you can play with. However if you want to use your own data, you must configure **Index Patterns** in the stack management page. This page is accessible by clicking on the `Manage`{.action} button next to the "Add data" button. You can also use the "Stack Management" option in the left side menu, displayable by using the top left the sandwich button. +Once there, use the right Identity provider to sign in and set on the first page. Click on the `Add data`{.action} button to add sample data you can play with. However if you want to use your own data, you must configure **Index Patterns** in the stack management page. This page is accessible by clicking on the `Manage`{.action} button next to the "Add data" button. You can also use the "Stack Management" option in the left side menu, displayable by using the top left the sandwich button. -In this configuration page, you can configure as the Index name, the full name of your alias **logs-XXXXX-a-XXXXX**, but you can also use wildcards. Choose **timestamp** for the time field name then click on Discover tab to read your log entries. +In this configuration page, you can configure as the Index name, the full name of your alias **ldp-XXXXX-a-XXXXX**, but you can also use wildcards. Choose **timestamp** for the time field name then click on Discover tab to read your log entries. ![osd setup](images/osd_setup.png){.thumbnail} @@ -61,4 +61,4 @@ To know what you can do with OpenSearch Dashboards, read the [OpenSearch Dashboa - Getting Started: [Quick Start](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start) - Documentation: [Guides](/products/observability-logs-data-platform) - Community hub: [https://community.ovh.com](https://community.ovh.com/en/c/Platform/data-platforms) -- Create an account: [Try it!](/links/manage-operate/ldp) +- Create an account: [Try it!](/links/manage-operate/ldp) \ No newline at end of file diff --git a/pages/manage_and_operate/secret_manager/secret-manager-ui/guide.en-gb.md b/pages/manage_and_operate/secret_manager/secret-manager-ui/guide.en-gb.md new file mode 100644 index 00000000000..519f69a2f82 --- /dev/null +++ b/pages/manage_and_operate/secret_manager/secret-manager-ui/guide.en-gb.md @@ -0,0 +1,140 @@ +--- +title: "Using the Secret Manager in the OVHcloud Control Panel" +excerpt: "Discover how to use the Secret Manager with the graphical interface" +updated: 2025-10-15 +--- + +> [!primary] +> Secret Manager is currently in beta phase. This guide can be updated in the future with the advances of our teams in charge of this product. + +## Objective + +The objective of this guide is to present the use of the Secret Manager through the OVHcloud Control Panel. + +## Requirements + +- An [OVHcloud customer account](/pages/account_and_service_management/account_information/ovhcloud-account-creation). + +## Instructions + +### Description + +The Secret Manager is a product that allows you to securely store credentials, API keys, SSH keys, or any other type of secret necessary for the operation of your applications. + +A secret is a collection of one or more key-value pairs grouped within a version. +Each modification of a secret creates a new version of that secret, allowing you to go back in the history of changes to the secret. + +### Creating a Secret + +The Secret Manager is accessible from the `Identity, Security & Operations`{.action} menu in the `Security`{.action} section. + +![Secret Manager](images/Secret-onboarding.png){.thumbnail} + +To create a secret, click directly on the `Create a secret`{.action} button. + +Then select the region where you want to create the secret. + +> [!primary] +> +> When creating a secret for the first time in a new region, a prior activation step is necessary by clicking on the Activate button to create an OKMS domain in the selected region. +> This activation may take a few minutes to take effect. + +Indicate the `Path` of the secret, for example **prod/database/MySQL**. This path will serve to hierarchize the secrets among themselves. + +Then indicate the content of the secret. The secret must contain a list of key-value pairs entered in JSON format: + +```json +{ + "login": "admin", + "password": "my_secret_password" +} +``` + +![Secret Manager](images/Secret-creation.png){.thumbnail} + +> [!primary] +> +> There is no limit to the number of key-value pairs in a secret, however the total data size must not exceed 64KB. + +Once the secret is created, it appears in the list of secrets in the Secret Manager. + +### Managing Secrets + +Once a secret is created, the list of secrets is displayed in the Control Panel. +A selector is present to navigate between the different regions where a secret is present. + +It is possible to access the configuration of the secret by clicking on it in the list of secrets to display its content, create a new version, or delete it. + +The secret dashboard displays several pieces of information, such as general information and parameters applying to the secret: + +- Maximum number of versions: Beyond the indicated value, the oldest version is deleted. +- Expiration period of a version: Beyond the indicated period, the version is disabled. +- CAS: If activated, it is necessary to systematically specify the current version number when making changes. + +![Secret Manager](images/Secret-dashboard.png){.thumbnail} + +#### Accessing the Content of a Secret + +A user with the necessary IAM rights can access the content of a secret. + +> [!primary] +> +> The rights to list a version (**okms:apiovh:secret/get**) are different from the right to retrieve the content of this version (**okms:apiovh:secret/version/getData**). + +To do this, click on `Display the value`{.action} in the secret dashboard. + +A side panel opens with the content of the most recent version of the secret. + +![Secret Manager](images/Secret-content.png){.thumbnail} + +A selector allows you to navigate between different versions of the secret, and view the status of the selected version. +If the version is disabled or deleted, no value is displayed. + +#### Managing Versions + +To access the versions of a secret, a `Versions` tab takes you to the table listing all versions of a secret. +Each modification of a secret creates a new version. + +![Secret Manager](images/Secret-versions.png){.thumbnail} + +A version can be either: + +- Active: The value of this version is accessible. +- Disabled: The value of this version is still present in the system but is no longer accessible until the version is reactivated. +- Deleted: The value of this version is no longer present in the system and cannot be restored. + +The action buttons for each version allow you to display the value, disable or reactivate the version, or delete it. + +A version deleted by the **Maximum number of versions** parameter no longer appears in the list of versions. + +### Managing the OKMS Domain + +The OKMS domain of the Secret Manager is shared with the OKMS domain of the Key Management Service. +Creating or deleting an OKMS domain therefore has consequences for both products. + +In the context of the Secret Manager beta, it is not yet possible to modify the OKMS domain configuration via the graphical interface. + +#### Multi-OKMS Domain Case + +In the case where at least two OKMS domains are already present in a region, an additional selection step appears when creating a secret. + +![Secret Manager](images/Secret-multi-domaine.png){.thumbnail} + +Furthermore, in the list of secrets, if a region contains multiple OKMS domains, an intermediate table is present to select the target OKMS domain. + +![Secret Manager](images/Secret-multi-domaine-2.png){.thumbnail} + +In the context of the Secret Manager beta, it is not yet possible to add an OKMS domain in a region via the graphical interface. + +### Using the Secret Manager via API + +The Secret Manager is accessible via two different API sets: + +- A [REST API](/pages/manage_and_operate/secret_manager/secret_manager-rest-api) similar to OVHcloud's standard APIs. +- A [Hashicorp Vault KV2 compliant API](/pages/manage_and_operate/secret_manager/secret_manager-kv2-api) providing compatibility with applications already compatible with Hashicorp Vault KV2. + +Both APIs manipulate the same objects. A secret created by one method is accessible by the other method. + +## Go further + +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/manage_and_operate/secret_manager/secret-manager-ui/guide.fr-fr.md b/pages/manage_and_operate/secret_manager/secret-manager-ui/guide.fr-fr.md new file mode 100644 index 00000000000..b66453b4102 --- /dev/null +++ b/pages/manage_and_operate/secret_manager/secret-manager-ui/guide.fr-fr.md @@ -0,0 +1,141 @@ +--- +title: "Utiliser le Secret Manager dans l'espace client OVHcloud" +excerpt: "Découvrez comment utiliser le Secret Manager avec l'interface graphique" +updated: 2025-10-15 +--- + +> [!primary] +> Le Secret Manager est actuellement en phase bêta. Ce guide est susceptible d’être mis à jour ultérieurement avec les avancées de nos équipes en charge de ce produit. +> + +## Objectif + +L'objectif de ce guide est de présenter l'utilisation du Secret Manager à travers l'espace client OVHcloud. + +## Prérequis + +- Disposer d'un [compte client OVHcloud](/pages/account_and_service_management/account_information/ovhcloud-account-creation). + +## En pratique + +### Description + +Le Secret Manager est un produit vous permettant de stocker de manière sécurisée les credentials, clés d'API, clés SSH ou tout autre type de secret nécessaire au fonctionnement de vos applications. + +Un secret est une collection d'une ou plusieurs clés/valeurs regroupées au sein d'une version. +Chaque modification d'un secret amène la création d'une nouvelle version de ce secret, permettant de remonter dans l'historique des modifications du secret. + +### Création d'un secret + +Le Secret Manager est accessible depuis le menu `Identité, Sécurité & Opérations`{.action} dans la section `Sécurité`{.action}. + +![Secret Manager](images/Secret-onboarding.png){.thumbnail} + +Pour créer un secret, cliquez directement sur le bouton `Créer un secret`{.action}. + +Sélectionnez ensuite la région sur laquelle créer le secret. + +> [!primary] +> +> Lors de la création d'un secret pour la première fois dans une nouvelle région, une étape d'activation préalable est nécessaire en cliquant sur le bouton `Activer`{.action} pour créer un domaine OKMS dans la région sélectionnée. +> Cette activation peut prendre quelques minutes pour être effective. + +Indiquez ensuite le `Path` du secret, par exemple **prod/database/MySQL**. Ce Path servira à hiérarchiser les secrets entre eux. + +Puis indiquez le contenu du secret. Le secret doit contenir une liste de clés/valeurs renseignées sous la forme d'un JSON : + +```json +{ + "login": "admin", + "password": "my_secret_password" +} +``` + +![Secret Manager](images/Secret-creation.png){.thumbnail} + +> [!primary] +> +> Il n'y a pas de limite dans le nombre de clés/valeurs d'un secret, cependant la taille totale des données ne doit pas dépasser 64 ko. + +Une fois le secret créé, celui-ci apparaît dans la liste des secrets du Secret Manager. + +### Gestion des secrets + +Une fois un secret créé, la liste des secrets s'affiche dans l'espace client. +Un sélecteur est présent pour naviguer entre les différentes régions où un secret est présent. + +Il est possible d'accéder à la configuration du secret en cliquant dessus dans la liste des secrets pour en afficher le contenu, créer une nouvelle version ou le supprimer. + +Le tableau de bord du secret affiche plusieurs informations comme les informations générales ainsi que les paramètres s'appliquant au secret : + +- Nombre maximum de versions : Au-delà de la valeur indiquée, la plus ancienne version est supprimée. +- Durée d'expiration d'une version : Au-delà de la durée indiquée, la version est désactivée. +- CAS : Si activé, il est nécessaire de systématiquement préciser le numéro de version actuelle lors des modifications. + +![Secret Manager](images/Secret-dashboard.png){.thumbnail} + +#### Accéder au contenu d'un secret + +Un utilisateur avec les droits IAM nécessaires peut accéder au contenu d'un secret. + +> [!primary] +> +> Les droits pour lister une version (**okms:apiovh:secret/get**) sont différents du droit pour récupérer le contenu de cette version (**okms:apiovh:secret/version/getData**) + +Pour cela, cliquez sur `Afficher la valeur`{.action} dans le tableau de bord d'un secret. + +Un panneau latéral s'ouvre avec le contenu de la version la plus récente du secret. + +![Secret Manager](images/Secret-content.png){.thumbnail} + +Un sélecteur permet de naviguer entre les différentes versions du secret ainsi que de consulter le statut de la version sélectionnée. +Si la version est désactivée ou supprimée, aucune valeur n'est affichée. + +#### Gestion des versions + +Pour accéder aux versions d'un secret, un onglet `Versions` contient un tableau listant l'ensemble des versions d'un secret. +Chaque modification d'un secret amène la création d'une nouvelle version. + +![Secret Manager](images/Secret-versions.png){.thumbnail} + +Une version peut être soit : + +- Active : La valeur de cette version est accessible. +- Désactivée : La valeur de cette version est encore présente dans le système mais n'est plus accessible tant que la version n'est pas réactivée. +- Supprimée : La valeur de cette version n'est plus présente dans le système et ne peut plus être restaurée. + +Les boutons d'action de chaque version permettent d'afficher la valeur, désactiver ou réactiver la version, ou de supprimer celle-ci. + +Une version supprimée par le paramètre **Nombre maximum de versions** n'apparaît plus dans la liste des versions. + +### Gestion du domaine OKMS + +Le domaine OKMS du Secret Manager est commun avec le domaine OKMS du Key Management Service. +La création ou la suppression d'un domaine OKMS a donc des conséquences sur les deux produits. + +Dans le cadre de la version bêta du Secret Manager, il n'est pas encore possible de modifier la configuration du domaine OKMS via l'interface graphique. + +#### Cas du multi-domaine OKMS + +Dans le cas où au moins deux domaines OKMS sont déjà présents dans une région, une étape de sélection supplémentaire apparaît à la création du secret. + +![Secret Manager](images/Secret-multi-domaine.png){.thumbnail} + +De plus, dans la liste des secrets, si une région contient plusieurs domaines OKMS, un tableau intermédiaire est présent pour sélectionner le domaine OKMS ciblé. + +![Secret Manager](images/Secret-multi-domaine-2.png){.thumbnail} + +Dans le cadre de la bêta du Secret Manager, il n'est pas encore possible d'ajouter un domaine OKMS dans une région via l'interface graphique. + +### Utilisation du Secret Manager par API + +Le Secret Manager est accessible par deux jeu d'API différents : + +- Une [API REST](/pages/manage_and_operate/secret_manager/secret_manager-rest-api) similaire aux standards d'API d'OVHcloud. +- Une [API compatible Hashicorp Vault KV2](/pages/manage_and_operate/secret_manager/secret_manager-kv2-api) apportant une compatibilité avec les applications déjà compatibles avec Hashicorp Vault KV2. + +Les deux API manipulent les mêmes objets. Un secret créé par une méthode est accessible par l'autre méthode. + +## Aller plus loin + +Échangez avec notre [communauté d'utilisateurs](/links/community). \ No newline at end of file diff --git a/pages/manage_and_operate/secret_manager/secret-manager-ui/images/Secret-content.png b/pages/manage_and_operate/secret_manager/secret-manager-ui/images/Secret-content.png new file mode 100644 index 00000000000..fbc624ef723 Binary files /dev/null and b/pages/manage_and_operate/secret_manager/secret-manager-ui/images/Secret-content.png differ diff --git a/pages/manage_and_operate/secret_manager/secret-manager-ui/images/Secret-creation.png b/pages/manage_and_operate/secret_manager/secret-manager-ui/images/Secret-creation.png new file mode 100644 index 00000000000..3437c0bd7b9 Binary files /dev/null and b/pages/manage_and_operate/secret_manager/secret-manager-ui/images/Secret-creation.png differ diff --git a/pages/manage_and_operate/secret_manager/secret-manager-ui/images/Secret-dashboard.png b/pages/manage_and_operate/secret_manager/secret-manager-ui/images/Secret-dashboard.png new file mode 100644 index 00000000000..49b6b093067 Binary files /dev/null and b/pages/manage_and_operate/secret_manager/secret-manager-ui/images/Secret-dashboard.png differ diff --git a/pages/manage_and_operate/secret_manager/secret-manager-ui/images/Secret-multi-domaine-2.png b/pages/manage_and_operate/secret_manager/secret-manager-ui/images/Secret-multi-domaine-2.png new file mode 100644 index 00000000000..959a0a5810f Binary files /dev/null and b/pages/manage_and_operate/secret_manager/secret-manager-ui/images/Secret-multi-domaine-2.png differ diff --git a/pages/manage_and_operate/secret_manager/secret-manager-ui/images/Secret-multi-domaine.png b/pages/manage_and_operate/secret_manager/secret-manager-ui/images/Secret-multi-domaine.png new file mode 100644 index 00000000000..49e876ed180 Binary files /dev/null and b/pages/manage_and_operate/secret_manager/secret-manager-ui/images/Secret-multi-domaine.png differ diff --git a/pages/manage_and_operate/secret_manager/secret-manager-ui/images/Secret-onboarding.png b/pages/manage_and_operate/secret_manager/secret-manager-ui/images/Secret-onboarding.png new file mode 100644 index 00000000000..dc44a934bfc Binary files /dev/null and b/pages/manage_and_operate/secret_manager/secret-manager-ui/images/Secret-onboarding.png differ diff --git a/pages/manage_and_operate/secret_manager/secret-manager-ui/images/Secret-versions.png b/pages/manage_and_operate/secret_manager/secret-manager-ui/images/Secret-versions.png new file mode 100644 index 00000000000..4b307a3ae95 Binary files /dev/null and b/pages/manage_and_operate/secret_manager/secret-manager-ui/images/Secret-versions.png differ diff --git a/pages/manage_and_operate/secret_manager/secret-manager-ui/meta.yaml b/pages/manage_and_operate/secret_manager/secret-manager-ui/meta.yaml new file mode 100644 index 00000000000..5ad2714b471 --- /dev/null +++ b/pages/manage_and_operate/secret_manager/secret-manager-ui/meta.yaml @@ -0,0 +1,2 @@ +id: 8cce2f89-1c86-4dfd-b884-ec0c34733656 +full_slug: secret-manager-ui \ No newline at end of file diff --git a/pages/manage_and_operate/secret_manager/secret_manager-kv2-api/guide.en-gb.md b/pages/manage_and_operate/secret_manager/secret_manager-kv2-api/guide.en-gb.md new file mode 100644 index 00000000000..5fff22d3e0a --- /dev/null +++ b/pages/manage_and_operate/secret_manager/secret_manager-kv2-api/guide.en-gb.md @@ -0,0 +1,238 @@ +--- +title: "Using the Secret Manager with the HashiCorp Vault KV2 compliant API" +excerpt: "Access and manage Secret Manager secrets with the HashiCorp Vault KV2 compliant API" +updated: 2025-10-15 +--- + +## Objective + +The objective of this guide is to present the use of the HashiCorp Vault KV2 compliant API for the Secret Manager. + +## Requirements + +- An [OVHcloud customer account](/pages/account_and_service_management/account_information/ovhcloud-account-creation). +- Have [ordered an OKMS domain](/pages/manage_and_operate/kms/quick-start) or [created a first secret](/pages/manage_and_operate/secret_manager/secret-manager-ui). + +## Instructions + +### Description + +The Secret Manager is a product that allows you to securely store credentials, API keys, SSH keys, or any other type of secret necessary for the operation of your applications. + +A secret is a collection of one or more key-value pairs grouped within a version. +Each modification of a secret creates a new version of that secret, allowing you to go back in the history of changes to the secret. + +The HashiCorp Vault KV2 compliant APIs are one of the two API sets offered by the Secret Manager, along with the [REST API](/pages/manage_and_operate/secret_manager/secret_manager-rest-api). +They are designed to be similar to HashiCorp Vault APIs to ensure compatibility with applications already compatible with HashiCorp Vault. + +### Contacting the OKMS domain + +Communication with the OKMS domain for encryption and signature actions is available via APIs. + +Since the OKMS domain is regionalized, you can access the API directly in its region: `https://my-region.ovh.com.net`. + +For example, for a OKMS domain created in the **eu-west-rbx** region: . + +It's possible to communicate with the OKMS domain using: + +- The Swagger UI +- The OMKS CLI: +- The Golang SDK: + +### Using the OKMS domain API via the Swagger UI + +You can access the OKMS domain Swagger UI by clicking on the link in the [OVHcloud Control Panel](/links/manager), in your OKMS domain dashboard. + +![swagger](images/swagger.png){.thumbnail} + +You will land on the non-authenticated version of the Swagger UI, that is meant for API documentation purposes. If you want to use the Swagger UI to make requests on your own OKMS domain, you will need to switch to the authenticated version, whose link is in the description section: + +![public-swagger-ui](images/public-swagger-ui.png){.thumbnail} + +The next steps will guide you on how to authenticate. + +#### Importing your OKMS domain credentials into the browser + +To access the authenticated Swagger UI, you need to load your [OKMS access certificate](/pages/manage_and_operate/kms/okms-certificate-management) into the browser Certificate Manager. + +For that, it is required to convert it to PKCS#12 format. PKCS#12 is a binary format for storing a certificate chain and private key in a single, encrypted file. It is commonly used for importing and exporting certificates and private keys, especially in environments that require secure transport of these items, such as web servers and client applications. + +To convert your OKMS domain credentials (assuming you saved them into files named `ID_certificate.pem` and `ID_privatekey.pem`) to PKCS#12 with the openssl Command Line Interface, use the following command: + +```bash +openssl pkcs12 -export -in ID_certificate.pem -inkey ID_privatekey.pem -out client.p12 +``` + +You will be prompted to enter a password that will be used for the symmetrical encryption of the file content. +Then, you need to import it into your web browser. + +##### On Firefox + +- Type `about:preferences#privacy` into the address bar. +- Scroll down until reaching a section named `Certificates`{.action}. + +![firefox-cert-manager](images/firefox-cert-manager.png){.thumbnail} + +- Click `View Certificates...`{.action} to open the Certificate Manager. +- Go to the tab named `My Certificates`{.action}, then `Import...`{.action} and select the location of your `client.p12` file. +- You will be prompted to enter the password you used during the PKCS#12 file creation. +- After entering the password, your certificate will be imported and ready for use. + +##### On Chrome/Chromium + +- Type `chrome://settings/certificates` into the address bar. +- Go to the `Your certificates`{.action} tab. Click `Import`{.action} and select your `client.p12` file. +- You will be prompted to enter the password you used during the PKCS#12 file creation. +- After entering the password, your certificate will be imported and ready for use. + +![chromium-cert-manager](images/chromium-cert-manager.png){.thumbnail} + +#### Accessing the authenticated Swagger UI + +Once your certificate is loaded into your browser, you can go to the authenticated Swagger UI. + +You will be prompted to identify yourself with a certificate. Select the previously imported PKCS#12 certificate in the drop-down list. + +![certificate-identification](images/firefox-identify-with-certificate.png){.thumbnail} + +You can now use the Swagger UI interactively. + +### Create a Secret + +To create a secret, you can use the following API: + +| **Method** | **Path** | **Description** | +| :---------: | :---------------------------------: | :-------------: | +| POST | /api/{okmsId}/v1/secret/data/{path} | Create a Secret | + +The secret's path must be specified in the API path. + +The API expects the following values: + +| **Field** | **Value** | **Description** | +| :-------: | :--------: | :-----------------------------------------------------------: | +| data | Json | Secret content. It is possible to have nested JSON | +| cas | Integer | (optional) Current version of the secret | + +For example: + +```json +{ + "data": { + "login": "admin", + "password": "my_secret_password", + "address": { + "ip": "1.1.1.1" + }, + "ports": [ + "30", + "31" + ] + }, + "options": { + "cas": 0 + } +} +``` + +It is also possible to add metadata to the secret via the API: + +| **Method** | **Path** | **Description** | +| :---------: | :-------------------------------------: | :------------------------------------: | +| POST | /api/{okmsId}/v1/secret/metadata/{path} | Update secret metadata | + +The API expects the following values: + +| **Field** | **Value** | **Description** | +| :----------------------: | :------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------: | +| cas_required | boolean | If enabled, it is necessary to systematically specify the current version number when making changes | +| custom_metadata | Json | Additional data associated with the secret. This data is not protected by the secret | +| deactivate_version_after | [Duration String](https://developer.hashicorp.com/vault/docs/concepts/duration-format) | Duration after which versions are deactivated | +| max_versions | Integer | Maximum number of versions for the secret | + +For example: + +```json +{ + "cas_required": true, + "custom_metadata": { + "project": "A", + "team": "X" + }, + "deactivate_version_after": "10h30m10s", + "max_versions": 5 +} +``` + +### Manage Secrets + +#### Update Metadata and configuration + +Once the secret is created, it is possible to update the secret's metadata or configuration. + +| **Method** | **Path** | **Description** | +| :---------: | :-------------------------------------: | :------------------------------------: | +| PATCH | /api/{okmsId}/v1/secret/metadata/{path} | Update secret metadata | + +The API expects the following values: + +| **Field** | **Value** | **Description** | +| :----------------------: | :------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------: | +| cas_required | boolean | If enabled, it is necessary to systematically specify the current version number when making changes | +| custom_metadata | Json | Additional data associated with the secret. This data is not protected by the secret | +| deactivate_version_after | [Duration String](https://developer.hashicorp.com/vault/docs/concepts/duration-format) | Duration after which versions are deactivated | +| max_versions | Integer | Maximum number of versions for the secret | + +It is also possible to change the default configuration of the OKMS domain for the values **cas_required**, **deactivate_version_after**, and **max_versions** using the API: + +| **Method** | **Path** | **Description** | +| :---------: | :----------------------------: | :--------------------------------------------------: | +| POST | /api/{okmsId}/v1/secret/config | Set the default configuration of the OKMS domain | + +#### Create a new version + +It is also possible to modify the secret's content, which implies creating a new version for the secret. +New versions can be created using the API: + +| **Method** | **Path** | **Description** | +| :---------: | :---------------------------------: | :---------------------: | +| PATCH | /api/{okmsId}/v1/secret/data/{path} | Update a secret | + +A secret can contain as many versions as desired, up to the maximum limit of the **max_versions** parameter. +If the maximum number of versions is reached, the oldest version is automatically deleted. + +#### Manage versions + +It is possible to manage the different versions of the secret using the API: + +| **Method** | **Path** | **Description** | +| :---------: | :-----------------------------------: | :-----------------------------------------: | +| POST | /api/{okmsId}/v1/secret/delete/{path} | Deactivates the specified versions of the secret | +| DELETE | /api/{okmsId}/v1/secret/data/{path} | Deactivates the latest version of the secret | + +Deactivated versions of a secret are still present in the Secret Manager, but their content is no longer accessible. + +It is possible to reactivate a version via the API: + +| **Method** | **Path** | **Description** | +| :---------: | :-------------------------------------: | :-----------------------------------------: | +| POST | /api/{okmsId}/v1/secret/undelete/{path} | Reactivates the specified versions of the secret | + +Finally, it is possible to permanently delete a version via the API: + +| **Method** | **Path** | **Description** | +| :---------: | :------------------------------------: | :-----------------------------------------: | +| PUT | /api/{okmsId}/v1/secret/destroy/{path} | Deletes the specified versions of the secret | + +It's also possible to permanently delete the whole secret with all his versions: + +| **Method** | **Path** | **Description** | +| :---------: | :------------------------------------: | :-----------------------------------------: | +| DELETE | /api/{okmsId}/v1/secret/metadata/{path} | Deletes the secret and all his versions | + +> [!warning] +> A deleted version is no longer present in the Secret Manager and cannot be reactivated. + +## Go further + +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/manage_and_operate/secret_manager/secret_manager-kv2-api/guide.fr-fr.md b/pages/manage_and_operate/secret_manager/secret_manager-kv2-api/guide.fr-fr.md new file mode 100644 index 00000000000..1050e884735 --- /dev/null +++ b/pages/manage_and_operate/secret_manager/secret_manager-kv2-api/guide.fr-fr.md @@ -0,0 +1,238 @@ +--- +title: "Utiliser le Secret Manager avec l'API compatible Hashicorp Vault KV2" +excerpt: "Accéder et gérer les secrets du Secret Manager avec l'API compatible Hashicorp Vault KV2" +updated: 2025-10-15 +--- + +## Objectif + +L'objectif de ce guide est de présenter l'usage de l'API compatible Hashicorp Vault KV2 pour le Secret Manager. + +## Prérequis + +- Disposer d'un [compte client OVHcloud](/pages/account_and_service_management/account_information/ovhcloud-account-creation). +- Avoir [commandé un domaine OKMS](/pages/manage_and_operate/kms/quick-start) ou [créé un premier secret](/pages/manage_and_operate/secret_manager/secret-manager-ui). + +## En pratique + +### Description + +Le Secret Manager est un produit vous permettant de stocker de manière sécurisée les credentials, clés d'API, clés SSH ou tout autre type de secret nécessaire au fonctionnement de vos applications. + +Un secret est une collection d'une ou plusieurs clés/valeurs regroupées au sein d'une version. +Chaque modification d'un secret amène la création d'une nouvelle version de ce secret, permettant de remonter dans l'historique des modifications du secret. + +Les API compatibles Hashicorp Vault KV2 sont l'un des deux jeux d'API offerts par le Secret Manager avec les [API REST](/pages/manage_and_operate/secret_manager/secret_manager-rest-api). +Elles sont conçues pour être similaires aux API Hashicorp Vault afin d'assurer une compatibilité avec les applications déjà compatibles avec Hashicorp Vault. + +### Communiquer avec le domaine OKMS + +La communication avec le domaine OKMS pour les actions de chiffrement et de signature est disponible via l'API. + +Le domaine OKMS étant régionalisé, l'accès à l'API se fait directement sur la région de celui-ci : `https://my-region.okms.ovh.net`. + +Par exemple, pour un domaine OKMS créé sur la région **eu-west-rbx** : . + +Il est possible de communiquer avec le domaine OKMS en utilisant : + +- L'interface utilisateur Swagger +- La CLI OKMS : +- Le SDK Golang : + +### Utilisation de l'API OKMS via l'interface utilisateur Swagger + +Il est possible d'accéder au Swagger correspondant à votre domaine OKMS en cliquant sur le lien présent dans [l'espace client OVHcloud](/links/manager) au niveau du dashboard de votre domaine OKMS. + +![swagger](images/swagger.png){.thumbnail} + +Vous êtes alors redirigé sur la version non authentifiée de l'interface utilisateur Swagger, qui est destinée à la documentation de l'API. Si vous souhaitez utiliser l'interface utilisateur Swagger pour effectuer des requêtes sur votre propre domaine OKMS, vous devez basculer vers la version authentifiée, dont le lien se trouve dans la section description : + +![public-swagger-ui](images/public-swagger-ui.png){.thumbnail} + +Les étapes suivantes vous guideront sur la façon de vous authentifier. + +#### Import de vos informations d'identification OKMS dans le navigateur + +Pour accéder à l'interface utilisateur Swagger authentifiée, vous devez charger votre [certificat d'accès OKMS](/pages/manage_and_operate/kms/okms-certificate-management) dans le gestionnaire de certificats du navigateur. + +Pour cela, il faut le convertir au format PKCS#12. PKCS#12 est un format binaire permettant de stocker une chaîne de certificats et une clé privée dans un seul fichier chiffré. Il est couramment utilisé pour importer et exporter des certificats et des clés privées, en particulier dans les environnements qui nécessitent un transport sécurisé de ces éléments, tels que les serveurs web et les applications clientes. + +Pour convertir vos informations d'identification au domaine OKMS (normalement nommés `ID_certificate.pem` et `ID_privatekey.pem`) en PKCS#12 avec la CLI openssl, utilisez la commande suivante : + +```bash +openssl pkcs12 -export -in ID_certificate.pem -inkey ID_privatekey.pem -out client.p12 +``` + +Vous serez invité à entrer un mot de passe qui sera utilisé pour le chiffrement symétrique du contenu du fichier. +Vous devez ensuite l'importer dans votre navigateur web. + +##### Sur Firefox + +- Tapez `about:preferences#privacy` dans la barre d'adresse. +- Faites défiler vers le bas jusqu'à atteindre une section intitulée `Certificats`{.action}. + +![firefox-cert-manager](images/firefox-cert-manager.png){.thumbnail} + +- Cliquez sur `Afficher les Certificats...`{.action} pour ouvrir le gestionnaire de certificats. +- Accédez à l'onglet intitulé `Vos Certificats`{.action}, puis cliquez sur `Importer...`{.action} et sélectionnez l'emplacement de votre fichier `client.p12`. +- Vous serez invité à entrer le mot de passe que vous avez utilisé lors de la création du fichier PKCS#12. +- Après avoir entré le mot de passe, votre certificat sera importé et prêt à l'emploi. + +##### Sur Chrome/Chromium + +- Tapez `chrome://settings/certificates` dans la barre d'adresse. +- Accédez à l'onglet `Vos certificats`{.action}. Cliquez sur `Importer`{.action} et sélectionnez votre fichier `client.p12`. +- Vous serez invité à entrer le mot de passe que vous avez utilisé lors de la création du fichier PKCS#12. +- Après avoir entré le mot de passe, votre certificat sera importé et prêt à l'emploi. + +![chromium-cert-manager](images/chromium-cert-manager.png){.thumbnail} + +#### Accès à l'interface utilisateur Swagger authentifiée + +Une fois votre certificat chargé dans votre navigateur, vous pouvez accéder à l'interface utilisateur Swagger authentifiée. + +Vous serez invité à vous identifier avec un certificat. Sélectionnez le certificat PKCS#12 précédemment importé dans la liste déroulante. + +![identification-certificat](images/firefox-identify-with-certificate.png){.thumbnail} + +Vous pouvez maintenant utiliser l'interface utilisateur Swagger de manière interactive. + +### Créer un secret + +Pour créer un secret, il est possible d'utiliser l'API suivante : + +| **Méthode** | **Chemin** | **Description** | +| :---------: | :---------------------------------: | :-------------: | +| POST | /api/{okmsId}/v1/secret/data/{path} | Créer un secret | + +Le chemin du secret devant être indiqué dans le chemin de l'API. + +L'API attend les valeurs suivantes : + +| **Champ** | **Valeur** | **Description** | +| :-------: | :--------: | :-----------------------------------------------------------: | +| data | Json | Contenu du secret. Il est possible d'avoir des JSON imbriqués | +| cas | Integer | (optionnel) Version actuelle du secret | + +Par exemple : + +```json +{ + "data": { + "login": "admin", + "password": "my_secret_password", + "address": { + "ip": "1.1.1.1" + }, + "ports": [ + "30", + "31" + ] + }, + "options": { + "cas": 0 + } +} +``` + +Il est aussi possible d'ajouter des métadonnées au secret par l'API : + +| **Méthode** | **Chemin** | **Description** | +| :---------: | :-------------------------------------: | :------------------------------------: | +| POST | /api/{okmsId}/v1/secret/metadata/{path} | Mettre à jour les métadonnées d'un secret | + +L'API attend les valeurs suivantes : + +| **Champ** | **Valeur** | **Description** | +| :----------------------: | :------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------: | +| cas_required | booléen | Si activé, il est nécessaire de systématiquement préciser le numéro de version actuelle lors des modifications | +| custom_metadata | Json | Données complémentaires associées au secret. Ces données ne sont pas protégées par le secret | +| deactivate_version_after | [Duration String](https://developer.hashicorp.com/vault/docs/concepts/duration-format) | Durée après laquelle les versions sont désactivées | +| max_versions | Integer | Nombre maximal de versions pour le secret | + +Par exemple : + +```json +{ + "cas_required": true, + "custom_metadata": { + "project": "A", + "team": "X" + }, + "deactivate_version_after": "10h30m10s", + "max_versions": 5 +} +``` + +### Gérer les secrets + +#### Mettre à jour les métadonnées et la configuration + +Une fois le secret créé, il est possible de mettre à jour les métadonnées du secret ainsi que sa configuration. + +| **Méthode** | **Chemin** | **Description** | +| :---------: | :-------------------------------------: | :------------------------------------: | +| PATCH | /api/{okmsId}/v1/secret/metadata/{path} | Mettre à jour les métadonnées d'un secret | + +L'API attend les valeurs suivantes : + +| **Champ** | **Valeur** | **Description** | +| :----------------------: | :------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------: | +| cas_required | booléen | Si activé, il est nécessaire de systématiquement préciser le numéro de version actuelle lors des modifications | +| custom_metadata | Json | Données complémentaires associées au secret. Ces données ne sont pas protégées par le secret | +| deactivate_version_after | [Duration String](https://developer.hashicorp.com/vault/docs/concepts/duration-format) | Durée après laquelle les versions sont désactivées | +| max_versions | Integer | Nombre maximal de versions pour le secret | + +Il est aussi possible de changer la configuration par défaut du domaine OKMS pour les valeurs **cas_required**, **deactivate_version_after** et **max_versions** par l'API : + +| **Méthode** | **Chemin** | **Description** | +| :---------: | :----------------------------: | :--------------------------------------------------: | +| POST | /api/{okmsId}/v1/secret/config | Configurer la configuration par défaut du domaine OKMS | + +#### Créer une nouvelle version + +Il est aussi possible de modifier le contenu du secret, ce qui implique la création d'une nouvelle version pour ce secret. +Les nouvelles versions peuvent être créées par l'API : + +| **Méthode** | **Chemin** | **Description** | +| :---------: | :---------------------------------: | :---------------------: | +| PATCH | /api/{okmsId}/v1/secret/data/{path} | Mettre à jour un secret | + +Un secret peut contenir autant de versions que souhaitées dans la limite maximale du paramètre **max_versions** +Si le maximum de version est atteint, la plus ancienne version est automatiquement supprimée. + +#### Gérer les versions + +Il est possible de gérer les différentes versions du secret par plusieurs API : + +| **Méthode** | **Chemin** | **Description** | +| :---------: | :-----------------------------------: | :-----------------------------------------: | +| POST | /api/{okmsId}/v1/secret/delete/{path} | Désactive les versions spécifiées du secret | +| DELETE | /api/{okmsId}/v1/secret/data/{path} | Désactive la dernière version du secret | + +Les versions désactivées d'un secret sont encore présentes dans le Secret Manager mais leur contenu n'est plus accessible. + +Il est possible de réactiver une version par l'API : + +| **Méthode** | **Chemin** | **Description** | +| :---------: | :-------------------------------------: | :-----------------------------------------: | +| POST | /api/{okmsId}/v1/secret/undelete/{path} | Réactive les versions spécifiées du secret | + +Enfin il est possible de supprimer définitivement une version par l'API : + +| **Méthode** | **Chemin** | **Description** | +| :---------: | :------------------------------------: | :-----------------------------------------: | +| PUT | /api/{okmsId}/v1/secret/destroy/{path} | Supprime les versions spécifiées du secret | + +Il est aussi possible de supprimer définitivement l'intégralité du secret avec toutes ses versions : + +| **Méthode** | **Chemin** | **Description** | +| :---------: | :------------------------------------: | :-----------------------------------------: | +| DELETE | /api/{okmsId}/v1/secret/metadata/{path} | Supprime le secret et ses versions | + +> [!warning] +> Une version supprimée n'est plus présente dans le Secret Manager et ne peut plus être réactivée. + +## Aller plus loin + +Échangez avec notre [communauté d'utilisateurs](/links/community). \ No newline at end of file diff --git a/pages/manage_and_operate/secret_manager/secret_manager-kv2-api/images/chromium-cert-manager.png b/pages/manage_and_operate/secret_manager/secret_manager-kv2-api/images/chromium-cert-manager.png new file mode 100644 index 00000000000..972433db5d2 Binary files /dev/null and b/pages/manage_and_operate/secret_manager/secret_manager-kv2-api/images/chromium-cert-manager.png differ diff --git a/pages/manage_and_operate/secret_manager/secret_manager-kv2-api/images/firefox-cert-manager.png b/pages/manage_and_operate/secret_manager/secret_manager-kv2-api/images/firefox-cert-manager.png new file mode 100644 index 00000000000..ef9f104dd19 Binary files /dev/null and b/pages/manage_and_operate/secret_manager/secret_manager-kv2-api/images/firefox-cert-manager.png differ diff --git a/pages/manage_and_operate/secret_manager/secret_manager-kv2-api/images/firefox-identify-with-certificate.png b/pages/manage_and_operate/secret_manager/secret_manager-kv2-api/images/firefox-identify-with-certificate.png new file mode 100644 index 00000000000..c56c550c51c Binary files /dev/null and b/pages/manage_and_operate/secret_manager/secret_manager-kv2-api/images/firefox-identify-with-certificate.png differ diff --git a/pages/manage_and_operate/secret_manager/secret_manager-kv2-api/images/public-swagger-ui.png b/pages/manage_and_operate/secret_manager/secret_manager-kv2-api/images/public-swagger-ui.png new file mode 100644 index 00000000000..cb21bac33e5 Binary files /dev/null and b/pages/manage_and_operate/secret_manager/secret_manager-kv2-api/images/public-swagger-ui.png differ diff --git a/pages/manage_and_operate/secret_manager/secret_manager-kv2-api/images/swagger.png b/pages/manage_and_operate/secret_manager/secret_manager-kv2-api/images/swagger.png new file mode 100644 index 00000000000..fb6d4b616d1 Binary files /dev/null and b/pages/manage_and_operate/secret_manager/secret_manager-kv2-api/images/swagger.png differ diff --git a/pages/manage_and_operate/secret_manager/secret_manager-kv2-api/meta.yaml b/pages/manage_and_operate/secret_manager/secret_manager-kv2-api/meta.yaml new file mode 100644 index 00000000000..788c9be1b8b --- /dev/null +++ b/pages/manage_and_operate/secret_manager/secret_manager-kv2-api/meta.yaml @@ -0,0 +1,2 @@ +id: 66d5d84a-55af-4f09-b863-0cf8a6f281c2 +full_slug: secret-manager-kv2-api \ No newline at end of file diff --git a/pages/manage_and_operate/secret_manager/secret_manager-rest-api/guide.en-gb.md b/pages/manage_and_operate/secret_manager/secret_manager-rest-api/guide.en-gb.md new file mode 100644 index 00000000000..bb1418fb286 --- /dev/null +++ b/pages/manage_and_operate/secret_manager/secret_manager-rest-api/guide.en-gb.md @@ -0,0 +1,213 @@ +--- +title: "Using the Secret Manager with the REST API" +excerpt: "Access and manage Secret Manager secrets with the REST API" +updated: 2025-10-15 +--- + +## Objective + +The objective of this guide is to present the use of the REST API for the Secret Manager. + +## Requirements + +- An [OVHcloud customer account](/pages/account_and_service_management/account_information/ovhcloud-account-creation). +- Have [ordered an OKMS domain](/pages/manage_and_operate/kms/quick-start) or [created a first secret](/pages/manage_and_operate/secret_manager/secret-manager-ui). + +## Instructions + +### Description + +The Secret Manager is a product that allows you to securely store credentials, API keys, SSH keys, or any other type of secret necessary for the operation of your applications. + +A secret is a collection of one or more key-value pairs grouped within a version. +Each modification of a secret creates a new version of that secret, allowing you to go back in the history of changes to the secret. + +The REST APIs are one of the two API sets offered by the Secret Manager, along with the [Hashicorp Vault KV2 compliant API](/pages/manage_and_operate/secret_manager/secret_manager-kv2-api). +These APIs are designed to be similar to the OVHcloud API set and the OKMS APIs for the Key Management Service. + +The REST APIs can be used either through the [centralized OVHcloud API](/pages/manage_and_operate/api/apiv2) or directly on the OKMS domain in the region. +The only difference lies in the exact API path: + +- Centralized OVHcloud API: /v2/okms/resource/{okmsId}/secret/{path} +- Regionalized OKMS API: /api/{okmsId}/v2/secret/{path} + +This documentation will focus on the APIs of the OKMS domain in the region. + +### Contacting the OKMS domain + +Communication with the OKMS domain for encryption and signature actions is available via APIs. + +Since the OKMS domain is regionalized, you can access the API directly in its region: `https://my-region.ovh.com.net`. + +For example, for a OKMS domain created in the **eu-west-rbx** region: . + +It's possible to communicate with the OKMS domain using: + +- The Swagger UI +- The OMKS CLI: +- The Golang SDK: + +### Using the OKMS API via the Swagger UI + +You can access the OKMS Swagger UI by clicking on the link in the [OVHcloud Control Panel](/links/manager), in your OKMS domain dashboard. + +![swagger](images/swagger.png){.thumbnail} + +You will land on the non-authenticated version of the Swagger UI, that is meant for API documentation purposes. If you want to use the Swagger UI to make requests on your own OKMS domain, you will need to switch to the authenticated version, whose link is in the description section: + +![public-swagger-ui](images/public-swagger-ui.png){.thumbnail} + +The next steps will guide you on how to authenticate. + +#### Importing your OKMS credentials into the browser + +To access the authenticated Swagger UI, you need to load your [OKMS access certificate](/pages/manage_and_operate/kms/okms-certificate-management) into the browser Certificate Manager. + +For that, it is required to convert it to PKCS#12 format. PKCS#12 is a binary format for storing a certificate chain and private key in a single, encrypted file. It is commonly used for importing and exporting certificates and private keys, especially in environments that require secure transport of these items, such as web servers and client applications. + +To convert your OKMS domain credentials (assuming you saved them into files named `ID_certificate.pem` and `ID_privatekey.pem`) to PKCS#12 with the openssl Command Line Interface, use the following command: + +```bash +openssl pkcs12 -export -in ID_certificate.pem -inkey ID_privatekey.pem -out client.p12 +``` + +You will be prompted to enter a password that will be used for the symmetrical encryption of the file content. +Then, you need to import it into your web browser. + +##### On Firefox + +- Type `about:preferences#privacy` into the address bar. +- Scroll down until reaching a section named `Certificates`{.action}. + +![firefox-cert-manager](images/firefox-cert-manager.png){.thumbnail} + +- Click `View Certificates...`{.action} to open the Certificate Manager. +- Go to the tab named `My Certificates`{.action}, then `Import...`{.action} and select the location of your `client.p12` file. +- You will be prompted to enter the password you used during the PKCS#12 file creation. +- After entering the password, your certificate will be imported and ready for use. + +##### On Chrome/Chromium + +- Type `chrome://settings/certificates` into the address bar. +- Go to the `Your certificates`{.action} tab. Click `Import`{.action} and select your `client.p12` file. +- You will be prompted to enter the password you used during the PKCS#12 file creation. +- After entering the password, your certificate will be imported and ready for use. + +![chromium-cert-manager](images/chromium-cert-manager.png){.thumbnail} + +#### Accessing the authenticated Swagger UI + +Once your certificate is loaded into your browser, you can go to the authenticated Swagger UI. + +You will be prompted to identify yourself with a certificate. Select the previously imported PKCS#12 certificate in the drop-down list. + +![certificate-identification](images/firefox-identify-with-certificate.png){.thumbnail} + +You can now use the Swagger UI interactively. + +### Create a Secret + +To create a secret, you can use the following API: + +| **Method** | **Path** | **Description** | +| :--------: | :----------------------: | :-------------: | +| POST | /api/{okmsId}/v2/secret/ | Create a Secret | + +The API expects the following values: + +| **Field** | **Value** | **Description** | +| :----------------------: | :------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------: | +| cas_required | boolean | If enabled, it is necessary to systematically specify the current version number when making changes | +| custom_metadata | Json | Additional data associated with the secret. This data is not protected by the secret | +| deactivate_version_after | [Duration String](https://developer.hashicorp.com/vault/docs/concepts/duration-format) | Duration after which versions are deactivated | +| max_versions | Integer | Maximum number of versions for the secret | +| path | String | Secret path | +| version | Json | Secret content. It is possible to have nested JSON | + +For example: + +```json +{ + "metadata": { + "cas_required": true, + "custom_metadata": { + "project": "A", + "team": "X" + }, + "deactivate_version_after": "10h30m10s", + "max_versions": 5 + }, + "path": "prod/database/MySQL", + "version": { + "data": { + "login": "admin", + "password": "my_secret_password", + "address": { + "ip": "1.1.1.1" + }, + "ports": [ + "30", + "31" + ] + } + } +} +``` + +### Manage Secrets + +#### Update Metadata and configuration + +Once the secret is created, it is possible to update the secret's metadata or configuration. + +| **Method** | **Path** | **Description** | +| :--------: | :---------------: | :-------------: | +| PUT | /v2/secret/{path} | Update a secret | + +The API expects the following values: + +| **Field** | **Value** | **Description** | +| :----------------------: | :------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------: | +| cas_required | boolean | If enabled, it is necessary to systematically specify the current version number when making changes | +| custom_metadata | Json | Additional data associated with the secret. This data is not protected by the secret | +| deactivate_version_after | [Duration String](https://developer.hashicorp.com/vault/docs/concepts/duration-format) | Duration after which versions are deactivated | +| max_versions | Integer | Maximum number of versions for the secret | + +It is also possible to change the default configuration of the OKMS domain for the values **cas_required**, **deactivate_version_after**, and **max_versions** using the API: + +| **Method** | **Path** | **Description** | +| :--------: | :--------------: | :----------------------------------------------: | +| PUT | /v2/secretConfig | Set the default configuration of the OKMS domain | + +#### Create a new version + +It is also possible to modify the secret's content, which implies creating a new version for the secret. +New versions can be created using the API: + +| **Method** | **Path** | **Description** | +| :--------: | :-----------------------: | :------------------------------: | +| PUT | /v2/secret/{path} | Update a secret | +| PUT | /v2/secret/{path}/version | Create a new version of a secret | + +Whether the modification of the **data** of the secret is done using the general API for updating the secret or the specific API, a new version of the secret is created. + +A secret can contain as many versions as desired, up to the maximum limit of the **max_versions** parameter. +If the maximum number of versions is reached, the oldest version is automatically deleted. + +#### Manage versions + +It is possible to manage the different versions of the secret using the API: + +| **Method** | **Path** | **Description** | +| :--------: | :---------------------------------: | :----------------------------: | +| PUT | /v2/secret/{path}/version/{version} | Update the version of a secret | + +The API expects the unique value: + +| **Field** | **Value** | **Description** | +| :-------: | :---------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | +| state | active , deactivated, deleted | active: The value of this version is accessible
deactivated: The value of this version is still present in the system but is no longer accessible until the version is reactivated
deleted: The value of this version is no longer present in the system and cannot be restored. | + +## Go further + +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/manage_and_operate/secret_manager/secret_manager-rest-api/guide.fr-fr.md b/pages/manage_and_operate/secret_manager/secret_manager-rest-api/guide.fr-fr.md new file mode 100644 index 00000000000..8e6da56506d --- /dev/null +++ b/pages/manage_and_operate/secret_manager/secret_manager-rest-api/guide.fr-fr.md @@ -0,0 +1,213 @@ +--- +title: "Utiliser le Secret Manager avec l'API REST" +excerpt: "Accéder et gérer les secrets du Secret Manager avec l'API REST" +updated: 2025-10-15 +--- + +## Objectif + +L'objectif de ce guide est de présenter l'usage de l'API REST pour le Secret Manager. + +## Prérequis + +- Disposer d'un [compte client OVHcloud](/pages/account_and_service_management/account_information/ovhcloud-account-creation). +- Avoir [commandé un domaine OKMS](/pages/manage_and_operate/kms/quick-start) ou [créé un premier secret](/pages/manage_and_operate/secret_manager/secret-manager-ui). + +## En pratique + +### Description + +Le Secret Manager est un produit vous permettant de stocker de manière sécurisée les credentials, clés d'API, clés SSH ou tout autre type de secret nécessaire au fonctionnement de vos applications. + +Un secret est une collection d'une ou plusieurs clés/valeurs regroupées au sein d'une version. +Chaque modification d'un secret amène la création d'une nouvelle version de ce secret, permettant de remonter dans l'historique des modifications du secret. + +Les API REST sont l'un des deux jeux d'API offerts par le Secret Manager avec les [API compatibles Hashicorp Vault KV2](/pages/manage_and_operate/secret_manager/secret_manager-kv2-api). +Elles sont conçues pour être similaires à l'ensemble des API OVHcloud ainsi qu'aux API OKMS pour le Key Management Service. + +Les API REST peuvent être utilisées soit par les [API centralisées OVHcloud](/pages/manage_and_operate/api/apiv2), soit directement sur le domaine OKMS en région. +La seule différence réside dans le chemin d'API exact : + +- API centralisée OVHcloud : /v2/okms/resource/{okmsId}/secret/{path} +- API régionalisée OKMS : /api/{okmsId}/v2/secret/{path} + +Cette documentation se concentrera sur les API du domaine OKMS en région. + +### Communiquer avec le domaine OKMS + +La communication avec le domaine OKMS pour les actions de chiffrement et de signature est disponible via l'API. + +Le domaine OKMS étant régionalisé, l'accès à l'API se fait directement sur la région de celui-ci : `https://my-region.okms.ovh.net`. + +Par exemple, pour un domaine OKMS créé sur la région **eu-west-rbx** : . + +Il est possible de communiquer avec le domaine OKMS en utilisant : + +- L'interface utilisateur Swagger +- La CLI OKMS : +- Le SDK Golang : + +### Utilisation de l'API OKMS via l'interface utilisateur Swagger + +Il est possible d'accéder au swagger correspondant à votre domaine OKMS en cliquant sur le lien présent dans [l'espace client OVHcloud](/links/manager) au niveau du dashboard de votre domaine OKMS. + +![swagger](images/swagger.png){.thumbnail} + +Vous êtes alors redirigé sur la version non authentifiée de l'interface utilisateur Swagger, qui est destinée à la documentation de l'API. Si vous souhaitez utiliser l'interface utilisateur Swagger pour effectuer des requêtes sur votre propre domaine OKMS, vous devez basculer vers la version authentifiée, dont le lien se trouve dans la section description : + +![public-swagger-ui](images/public-swagger-ui.png){.thumbnail} + +Les étapes suivantes vous guideront sur la façon de vous authentifier. + +#### Import de vos informations d'identification OKMS dans le navigateur + +Pour accéder à l'interface utilisateur Swagger authentifiée, vous devez charger votre [certificat d'accès OKMS](/pages/manage_and_operate/kms/okms-certificate-management) dans le gestionnaire de certificats du navigateur. + +Pour cela, il faut le convertir au format PKCS#12. PKCS#12 est un format binaire permettant de stocker une chaîne de certificats et une clé privée dans un seul fichier chiffré. Il est couramment utilisé pour importer et exporter des certificats et des clés privées, en particulier dans les environnements qui nécessitent un transport sécurisé de ces éléments, tels que les serveurs Web et les applications clientes. + +Pour convertir vos informations d'identification au domaine OKMS (normalement nommées `ID_certificate.pem` et `ID_privatekey.pem`) en PKCS#12 avec la CLI openssl, utilisez la commande suivante : + +```bash +openssl pkcs12 -export -in ID_certificate.pem -inkey ID_privatekey.pem -out client.p12 +``` + +Vous serez invité à entrer un mot de passe qui sera utilisé pour le chiffrement symétrique du contenu du fichier. +Vous devez ensuite l'importer dans votre navigateur Web. + +##### Sur Firefox + +- Tapez `about:preferences#privacy` dans la barre d'adresse. +- Faites défiler vers le bas jusqu'à atteindre une section intitulée `Certificats`{.action}. + +![firefox-cert-manager](images/firefox-cert-manager.png){.thumbnail} + +- Cliquez sur `Afficher les Certificats...`{.action} pour ouvrir le gestionnaire de certificats. +- Accédez à l'onglet intitulé `Vos Certificats`{.action}, puis cliquez sur `Importer...`{.action} et sélectionnez l'emplacement de votre fichier `client.p12`. +- Vous serez invité à entrer le mot de passe que vous avez utilisé lors de la création du fichier PKCS#12. +- Après avoir entré le mot de passe, votre certificat sera importé et prêt à l'emploi. + +##### Sur Chrome/Chromium + +- Tapez `chrome://settings/certificates` dans la barre d'adresse. +- Accédez à l'onglet `Vos certificats`{.action}. Cliquez sur `Importer`{.action} et sélectionnez votre fichier `client.p12`. +- Vous serez invité à entrer le mot de passe que vous avez utilisé lors de la création du fichier PKCS#12. +- Après avoir entré le mot de passe, votre certificat sera importé et prêt à l'emploi. + +![chromium-cert-manager](images/chromium-cert-manager.png){.thumbnail} + +#### Accès à l'interface utilisateur Swagger authentifiée + +Une fois votre certificat chargé dans votre navigateur, vous pouvez accéder à l'interface utilisateur Swagger authentifiée. + +Vous serez invité à vous identifier avec un certificat. Sélectionnez le certificat PKCS#12 précédemment importé dans la liste déroulante. + +![identification-certificat](images/firefox-identify-with-certificate.png){.thumbnail} + +Vous pouvez maintenant utiliser l'interface utilisateur Swagger de manière interactive. + +### Créer un secret + +Pour créer un secret il est possible d'utiliser l'API suivante : + +| **Méthode** | **Chemin** | **Description** | +| :---------: | :----------------------: | :-------------: | +| POST | /api/{okmsId}/v2/secret/ | Créer un secret | + +L'API attend les valeurs suivantes : + +| **Champ** | **Valeur** | **Description** | +| :----------------------: | :------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------: | +| cas_required | booléen | Si activé, il est nécessaire de systématiquement préciser le numéro de version actuelle lors des modifications | +| custom_metadata | Json | Données complémentaires associées au secret. Ces données ne sont pas protégées par le secret | +| deactivate_version_after | [Duration String](https://developer.hashicorp.com/vault/docs/concepts/duration-format) | Durée après laquelle les versions sont désactivée | +| max_versions | Integer | Nombre de version maximale pour le secret | +| path | String | Chemin du secret | +| version | Json | Contenu du secret. Il est possible d'avoir des JSON imbriqués | + +Par exemple : + +```json +{ + "metadata": { + "cas_required": true, + "custom_metadata": { + "project": "A", + "team": "X" + }, + "deactivate_version_after": "10h30m10s", + "max_versions": 5 + }, + "path": "prod/database/MySQL", + "version": { + "data": { + "login": "admin", + "password": "my_secret_password", + "address": { + "ip": "1.1.1.1" + }, + "ports": [ + "30", + "31" + ] + } + } +} +``` + +### Gérer les secrets + +#### Mettre à jour les métadonnées et la configuration + +Une fois le secret créé, il est possible de mettre à jour les métadonnées du secret ou sa configuration. + +| **Méthode** | **Chemin** | **Description** | +| :---------: | :----------------------------: | :---------------------: | +| PUT | /api/{okmsId}/v2/secret/{path} | Mettre à jour un secret | + +L'API attend les valeurs suivantes : + +| **Champ** | **Valeur** | **Description** | +| :----------------------: | :------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------: | +| cas_required | boléen | Si activé, il est nécessaire de systématiquement préciser le numéro de version actuelle lors des modifications | +| custom_metadata | Json | Données complémentaires associées au secret. Ces données ne sont pas protégées par le secret | +| deactivate_version_after | [Duration String](https://developer.hashicorp.com/vault/docs/concepts/duration-format) | Durée après laquelle les versions sont désactivée | +| max_versions | Integer | Nombre maximal de versions pour le secret | + +Il est aussi possible de changer la configuration par défaut du domaine OKMS pour les valeurs **cas_required**, **deactivate_version_after** et **max_versions** par l'API : + +| **Méthode** | **Chemin** | **Description** | +| :---------: | :---------------------------: | :--------------------------------------------------: | +| PUT | /api/{okmsId}/v2/secretConfig | Configurer la configuration par défaut du domaine OKMS | + +#### Créer une nouvelle version + +Il est aussi possible de modifier le contenu du secret, ce qui implique la création d'une nouvelle version pour ce secret. +Les nouvelles versions peuvent être créées par l'API : + +| **Méthode** | **Chemin** | **Description** | +| :---------: | :------------------------------------: | :------------------------------------: | +| PUT | /api/{okmsId}/v2/secret/{path} | Mettre à jour un secret | +| PUT | /api/{okmsId}/v2/secret/{path}/version | Créer une nouvelle version d'un secret | + +Que la modification des **data** du secret soit faite par l'API générale de mise à jour du secret ou l'API spécifique, une nouvelle version du secret est créée. + +Un secret peut contenir autant de versions que souhaitées dans la limite maximale du paramètre **max_versions** +Si le nombre maximal de versions est atteint, la plus ancienne version est automatiquement supprimée. + +#### Gérer les versions + +Il est possible de gérer les différentes versions du secret par l'API : + +| **Méthode** | **Chemin** | **Description** | +| :---------: | :----------------------------------------------: | :----------------------------------: | +| PUT | /api/{okmsId}/v2/secret/{path}/version/{version} | Mettre à jour la version d'un secret | + +L'API attendant l'unique valeur : + +| **Champ** | **Valeur** | **Description** | +| :-------: | :---------------------------: | :--------------: | +| state | active , deactivated, deleted | active : La valeur de cette version est accessible
deactivated : La valeur de cette version est encore présente dans le système mais n'est plus accessible tant que la version n'est pas réactivée
deleted : La valeur de cette version n'est plus présente dans le système et ne peut plus être restaurée. | + +## Aller plus loin + +Échangez avec notre [communauté d'utilisateurs](/links/community). \ No newline at end of file diff --git a/pages/manage_and_operate/secret_manager/secret_manager-rest-api/images/chromium-cert-manager.png b/pages/manage_and_operate/secret_manager/secret_manager-rest-api/images/chromium-cert-manager.png new file mode 100644 index 00000000000..972433db5d2 Binary files /dev/null and b/pages/manage_and_operate/secret_manager/secret_manager-rest-api/images/chromium-cert-manager.png differ diff --git a/pages/manage_and_operate/secret_manager/secret_manager-rest-api/images/firefox-cert-manager.png b/pages/manage_and_operate/secret_manager/secret_manager-rest-api/images/firefox-cert-manager.png new file mode 100644 index 00000000000..ef9f104dd19 Binary files /dev/null and b/pages/manage_and_operate/secret_manager/secret_manager-rest-api/images/firefox-cert-manager.png differ diff --git a/pages/manage_and_operate/secret_manager/secret_manager-rest-api/images/firefox-identify-with-certificate.png b/pages/manage_and_operate/secret_manager/secret_manager-rest-api/images/firefox-identify-with-certificate.png new file mode 100644 index 00000000000..c56c550c51c Binary files /dev/null and b/pages/manage_and_operate/secret_manager/secret_manager-rest-api/images/firefox-identify-with-certificate.png differ diff --git a/pages/manage_and_operate/secret_manager/secret_manager-rest-api/images/public-swagger-ui.png b/pages/manage_and_operate/secret_manager/secret_manager-rest-api/images/public-swagger-ui.png new file mode 100644 index 00000000000..cb21bac33e5 Binary files /dev/null and b/pages/manage_and_operate/secret_manager/secret_manager-rest-api/images/public-swagger-ui.png differ diff --git a/pages/manage_and_operate/secret_manager/secret_manager-rest-api/images/swagger.png b/pages/manage_and_operate/secret_manager/secret_manager-rest-api/images/swagger.png new file mode 100644 index 00000000000..fb6d4b616d1 Binary files /dev/null and b/pages/manage_and_operate/secret_manager/secret_manager-rest-api/images/swagger.png differ diff --git a/pages/manage_and_operate/secret_manager/secret_manager-rest-api/meta.yaml b/pages/manage_and_operate/secret_manager/secret_manager-rest-api/meta.yaml new file mode 100644 index 00000000000..f34591efa14 --- /dev/null +++ b/pages/manage_and_operate/secret_manager/secret_manager-rest-api/meta.yaml @@ -0,0 +1,2 @@ +id: afbafdf3-1309-4f99-867b-3af67b78e506 +full_slug: secret-manager-rest-api \ No newline at end of file diff --git a/pages/network/additional_ip/primary_additional_ip_concepts/guide.en-gb.md b/pages/network/additional_ip/primary_additional_ip_concepts/guide.en-gb.md new file mode 100644 index 00000000000..cb490e88205 --- /dev/null +++ b/pages/network/additional_ip/primary_additional_ip_concepts/guide.en-gb.md @@ -0,0 +1,92 @@ +--- +title: Concepts - Primary IP and Additional IP +excerpt: Understand the differences between Primary IP and Additional IP addresses, and learn about their use cases +updated: 2025-09-22 +--- + +## Objective + +This document aims to clarify the distinctions between Primary IP and Additional IP addresses within the OVHcloud ecosystem. You will learn the unique characteristics and appropriate use cases for each, enabling you to make informed decisions for your network architecture, whether for basic connectivity, high-availability, or scalable service deployment. + +In the Bare Metal universe, you can use the Primary IP addresses of your services, or configure Additional IP addresses, which provide a flexible way to manage public access to your services. They can stay infrastructure-agnostic and be scaled up or migrated whenever needed. + +## IP Addresses in OVHcloud: Primary, Additional + +OVHcloud offers various types of IP addresses, each designed for specific use cases and offering different levels of flexibility and functionality. Understanding the distinctions between Primary IP and Additional IP is crucial for effective network management and service deployment. + +In the Public Cloud universe, we also offer Floating IP addresses that are cloud-native, with a pay-as-you-go billing model. + +You can find more information about the differences between Floating IP and Additional IP in [this guide](/pages/public_cloud/public_cloud_network_services/concepts-02-additional-ip-vs-floating-ip). + +### Primary IP Addresses + +Primary IP addresses are fundamental to OVHcloud services, providing immediate connectivity and reachability upon service deployment. + +#### Characteristics + +- **Pre-configured**: Primary IP addresses come pre-attached to your OVHcloud services, and serve as their default IP address, simplifying initial setup. +- **Purpose**: Its main purpose is to enable easy communication and ensure reachability for the associated service. +- **Availability**: Both IPv4 and IPv6 primary addresses are available with many OVHcloud products. Refer to specific product pages for detailed availability. +- **Configuration**: IPv4 and IPv6 addresses configuration details, such as address, prefix size, or default gateway, can be found within the [OVHcloud Control Panel](/links/manager), usually in the `Network`{.action} tab of the given product. + +#### Use Cases + +- Default network interface for a server or service. +- Basic connectivity and management access. + +> [!success] +> **Related Guide** : +> - [Configuring IPv6 on dedicated servers](/pages/bare_metal_cloud/dedicated_servers/network_ipv6) + +### Additional IP Addresses + +Additional IP addresses offer enhanced flexibility and are infrastructure-agnostic, meaning they are not tied to any specific underlying hardware or solution. This allows for dynamic reassignment between different services within the same region (with an exception for the eu-west-gra, eu-west-sbg and eu-west-rbx regions). + +For more information about moving Additional IP, please check [this guide](/pages/bare_metal_cloud/dedicated_servers/move-failover-ip). + +#### Characteristics + +- **Flexibility**: Offer greater flexibility compared to Primary IPs. +- **Infrastructure-Agnostic**: Not tied to specific hardware, allowing dynamic reassignment. +- **Dynamic Reassignment**: Can be dynamically reassigned between different services within the same region. +- **Availability**: + - **IPv4**: Can be used with multiple products. + - **IPv6**: Support for Additional IPv6 when used with a vRack. + +#### Attachment Methods + +Additional IP addresses can be attached to OVHcloud services in two primary ways (availability may vary): + +1. **Via the public interface**: + + - Available for Additional IPv4 only. + - An Additional IPv4 address (or a block of addresses) can be used similarly to the Primary IP of a server. + - Refer to your product’s specifications for network/gateway settings details. + +2. **Via vRack Private Network**: + + - Supports both Additional IPv4 and Additional IPv6. + - Available for products compatible with vRack. + - **Advantages of using with vRack**: + - **Crossing Regional Boundaries**: While Additional IP addresses can only be moved between products within the region they were issued, using them over a vRack allows customers to define the gateway's region (where public traffic enters and leaves the vRack network), while backend services can be utilized in any location that supports vRack network. + - **IPv6 Subnet Routing**: This feature is available only for Additional IPv6 when used over a vRack network, enabling more granular control over IPv6 traffic within your private network. + - **Automated Failover with VRRP/CARP**: VRRP (*Virtual Router Redundancy Protocol*) and CARP (*Common Address Redundancy Protocol*) on a vRack network allow for automatic failover. The Additional IP is attached to a master server, with backup servers that take over instantly if the master fails. This creates a resilient, self-healing, high-availability infrastructure without requiring manual intervention. + +#### Use Cases + +- **Manual and Automated Failover**: Quickly reassign IP addresses to backup services in case of main services failure, either manually or automatically VRRP or CARP; +- **Load Balancing**: Attach an Additional IP to your OVHcloud Load Balancer, and seamlessly redirect traffic to a standby Load Balancer during maintenance of failover; +- **IP aliasing**: Assign several IP addresses to the same network interface, and host multiple websites or services on a single server; +- **Service Migration**: Migrate services between servers without changing the public-facing IP address. +- **IP Geolocation**: Present a local IP address to customers in different regions, to improve latency and user experience. + +> [!success] +> **Related Guides** : +> - [Configuring an Additional IPv6 block in a vRack](/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack) +> - [Configuring an Additional IP block in a vRack](/pages/bare_metal_cloud/dedicated_servers/configuring-an-ip-block-in-a-vrack) +> - [Moving an Additional IP](/pages/bare_metal_cloud/dedicated_servers/move-failover-ip) +> - [Configuring Additional IPs in bridge mode on your virtual machines](/pages/bare_metal_cloud/dedicated_servers/network_bridging) + +## Go further + +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/additional_ip/primary_additional_ip_concepts/guide.fr-fr.md b/pages/network/additional_ip/primary_additional_ip_concepts/guide.fr-fr.md new file mode 100644 index 00000000000..9cdf04d06db --- /dev/null +++ b/pages/network/additional_ip/primary_additional_ip_concepts/guide.fr-fr.md @@ -0,0 +1,92 @@ +--- +title: Concepts - Primary IP et Additional IP +excerpt: "Comprendre les différences entre les adresses IP Primary et Additional, et découvrir leurs cas d'utilisation." +updated: 2025-09-22 +--- + +## Objectif + +Ce document vise à clarifier les distinctions entre les adresses Primary IP et Additional IP au sein de l'écosystème OVHcloud. Vous y découvrirez leurs caractéristiques et leurs cas d'utilisation, afin de prendre des décisions éclairées pour une architecture réseau flexible et à haute disponibilité. + +Dans l'univers Bare Metal, vous pouvez utiliser les adresses Primary IP de vos services ou configurer des adresses Additional IP, qui offrent un moyen flexible de gérer l'accès public à vos services. Elles peuvent rester agnostiques de l'infrastructure et être mises à l'échelle ou migrées si nécessaire. + +## Les adresses IP chez OVHcloud : Primary, Additional + +OVHcloud propose différents types d'adresses IP, chacune conçue pour des cas d'utilisation spécifiques et offrant différents niveaux de flexibilité et de fonctionnalité. Comprendre les distinctions entre Primary IP et Additional IP est crucial pour une gestion de réseau et un déploiement de services efficaces. + +Dans l’univers Public Cloud, nous proposons également des adresses IP flottantes (**Floating IP**) cloud natives, avec un modèle de facturation à l’usage. + +Vous trouverez plus d’informations sur les différences entre les Floating IP et les Additional IP dans [ce guide](/pages/public_cloud/public_cloud_network_services/concepts-02-additional-ip-vs-floating-ip). + +### Les adresses Primary IP + +Les adresses Primary IP sont fondamentales pour les services OVHcloud, fournissant une connectivité immédiate et une accessibilité dès le déploiement du service. + +#### Caractéristiques + +- **Pré-configurées** : Les adresses Primary IP sont pré-attachées à vos services OVHcloud et servent d'adresse IP par défaut, ce qui simplifie la configuration initiale. +- **Objectif** : Leur objectif principal est de permettre une communication facile et d'assurer l'accessibilité pour le service associé. +- **Disponibilité** : Les adresses Primary IPv4 et IPv6 sont disponibles avec de nombreux produits OVHcloud. Reportez-vous aux pages produits spécifiques pour la disponibilité détaillée. +- **Configuration** : Les détails de configuration des adresses IPv4 et IPv6, tels que l'adresse, la taille du préfixe ou la passerelle par défaut, se trouvent dans [l'espace client OVHcloud](/links/manager), généralement dans l'onglet `Réseau`{.action} du produit concerné. + +#### Cas d'utilisation + +- Interface réseau par défaut pour un serveur ou un service. +- Connectivité de base et accès à la gestion. + +> [!success] +> **Guide associé** : +> - [Configurer une adresse IPv6 principale sur un serveur dédié](/pages/bare_metal_cloud/dedicated_servers/network_ipv6) + +### Les adresses Additional IP + +Les adresses Additional IP offrent une flexibilité accrue et sont agnostiques de l'infrastructure, ce qui signifie qu'elles ne sont pas liées à un matériel ou une solution sous-jacente spécifique. Cela permet une réaffectation dynamique entre différents services au sein de la même région (à l’exception des régions eu-west-gra, eu-west-sbg et eu-west-rbx). + +Pour obtenir plus d'information à propos du déplacement d'Additional IP, veuillez consulter [ce guide](/pages/bare_metal_cloud/dedicated_servers/move-failover-ip). + +#### Caractéristiques + +- **Flexibilité** : Offrent une plus grande flexibilité par rapport aux Primary IP. +- **Agnostique de l'infrastructure** : Non liées à un matériel spécifique, ce qui permet une réaffectation dynamique. +- **Réaffectation dynamique** : Peuvent être réaffectées dynamiquement entre différents services au sein de la même région. +- **Disponibilité** : + - **IPv4** : Peuvent être utilisées avec de nombreux produits. + - **IPv6** : Prise en charge des Additional IPv6 lorsqu'elles sont utilisées avec un vRack. + +#### Méthodes d'attachement + +Les adresses Additional IP peuvent être attachées aux services OVHcloud de deux manières principales (la disponibilité peut varier) : + +1.  **Via l'interface publique** : + + - Disponible pour les Additional IPv4 uniquement. + - Une adresse Additional IPv4 (ou un bloc d'adresses) peut être utilisée de manière similaire à l'adresse Primary IP d'un serveur. + - Reportez-vous aux spécifications de votre produit pour obtenir les détails de configuration du réseau/de la passerelle. + +2.  **Via le réseau privé vRack** : + + - Prise en charge des Additional IPv4 et Additional IPv6. + - Disponible pour les produits compatibles avec le vRack. + - **Avantages d'une utilisation avec un vRack** : + - **Franchissement des frontières régionales** : Alors que les adresses Additional IP ne peuvent être déplacées qu'entre des produits de la région dans laquelle elles ont été émises, leur utilisation sur un vRack permet aux clients de définir la région de la passerelle (où le trafic public entre et sort du réseau vRack), tandis que les services de backend peuvent être utilisés dans n'importe quel emplacement prenant en charge le réseau vRack. + - **Routage de sous-réseau IPv6** : Cette fonctionnalité n'est disponible que pour les Additional IPv6 lorsqu'elles sont utilisées sur un réseau vRack, ce qui permet un contrôle plus granulaire du trafic IPv6 au sein de votre réseau privé. + - **Failover automatisé avec VRRP/CARP** : Les protocoles VRRP (*Virtual Router Redundancy Protocol*) et CARP (*Common Address Redundancy Protocol*) sur un réseau vRack permettent un basculement automatique. L'Additional IP est attachée à un serveur maître, avec des serveurs de secours qui prennent le relais instantanément en cas de défaillance du serveur maître. Cela crée une infrastructure résiliente, s'auto-réparant, à haute disponibilité et qui ne nécessite aucune intervention manuelle. + +#### Cas d'utilisation + +- **Failover manuel et automatisé** : Réaffectez rapidement des adresses IP aux services de sauvegarde en cas de défaillance des services principaux, manuellement ou automatiquement via les protocoles VRRP ou CARP ; +- **Load Balancing** : Attachez une Additional IP à votre Load Balancer OVHcloud, et redirigez le trafic de manière transparente vers un Load Balancer de secours lors d'opérations de maintenance ou de failover ; +- **IP aliasing** : Attribuez plusieurs adresses IP à la même interface réseau et hébergez plusieurs sites web ou services sur un seul serveur ; +- **Migration de service** : Migrez des services entre serveurs sans changer l'adresse IP publique ; +- **Géolocalisation IP** : Présentez une adresse IP locale aux clients de différentes régions, afin d'améliorer la latence et l'expérience utilisateur. + +> [!success] +> **Guides associés** : +> - [Configurer un bloc Additional IPv6 dans un vRack](/pages/bare_metal_cloud/dedicated_servers/configure-an-ipv6-in-a-vrack) +> - [Configurer un bloc Additional IP dans le vRack](/pages/bare_metal_cloud/dedicated_servers/configuring-an-ip-block-in-a-vrack) +> - [Déplacer une Additional IP](/pages/bare_metal_cloud/dedicated_servers/move-failover-ip) +> - [Configurer des Additional IP en mode bridge sur vos machines virtuelles](/pages/bare_metal_cloud/dedicated_servers/network_bridging) + +## Pour aller plus loin + +Rejoignez notre [communauté d'utilisateurs](/links/community). \ No newline at end of file diff --git a/pages/network/additional_ip/primary_additional_ip_concepts/meta.yaml b/pages/network/additional_ip/primary_additional_ip_concepts/meta.yaml new file mode 100644 index 00000000000..0dc23514dc3 --- /dev/null +++ b/pages/network/additional_ip/primary_additional_ip_concepts/meta.yaml @@ -0,0 +1,2 @@ +id: c9604c52-f504-41aa-b5c1-d68cc54eb99d +full_slug: network-primary-additional-ip-concepts \ No newline at end of file diff --git a/pages/network/content_delivery_network_infrastructure/first_domain_name_configuration/guide.it-it.md b/pages/network/content_delivery_network_infrastructure/first_domain_name_configuration/guide.it-it.md index bedca44172a..7ea04313ecc 100644 --- a/pages/network/content_delivery_network_infrastructure/first_domain_name_configuration/guide.it-it.md +++ b/pages/network/content_delivery_network_infrastructure/first_domain_name_configuration/guide.it-it.md @@ -12,7 +12,7 @@ Per iniziare a utilizzare il servizio Content Delivery Network (CDN) di OVH, è ## Prerequisiti -- Usufruire della [Content Delivery Network (CDN) OVH](https://www.ovh.it/cdn/) +- Usufruire della [Content Delivery Network (CDN) OVH](/links/network/cdn-infrastructure). - Avere accesso alla gestione della zona DNS del dominio - Avere accesso allo [Spazio Cliente OVH](/links/manager). diff --git a/pages/network/content_delivery_network_infrastructure/ssl_certificate/guide.en-gb.md b/pages/network/content_delivery_network_infrastructure/ssl_certificate/guide.en-gb.md index 1a42ef26495..795fdd82097 100644 --- a/pages/network/content_delivery_network_infrastructure/ssl_certificate/guide.en-gb.md +++ b/pages/network/content_delivery_network_infrastructure/ssl_certificate/guide.en-gb.md @@ -12,7 +12,7 @@ You can add an [SSL certificate](/links/web/hosting-options-ssl) to your Content ## Requirements -- an [OVH CDN solution](https://www.ovh.co.uk/cdn/) +- an [OVH CDN solution](/links/network/cdn-infrastructure). - the permissions needed to manage your domain’s DNS zone ## Instructions diff --git a/pages/network/content_delivery_network_infrastructure/ssl_certificate/guide.it-it.md b/pages/network/content_delivery_network_infrastructure/ssl_certificate/guide.it-it.md index 464fc91e9a6..3cdfca41490 100644 --- a/pages/network/content_delivery_network_infrastructure/ssl_certificate/guide.it-it.md +++ b/pages/network/content_delivery_network_infrastructure/ssl_certificate/guide.it-it.md @@ -12,7 +12,7 @@ updated: 2018-02-22 ## Prerequisiti -- Disporre della soluzione [CDN OVH](https://www.ovh.it/cdn/) +- Disporre della soluzione [CDN OVH](/links/network/cdn-infrastructure). - Avere accesso alla gestione della zona DNS del dominio ## Procedura diff --git a/pages/network/content_delivery_network_infrastructure/ssl_certificate/guide.pt-pt.md b/pages/network/content_delivery_network_infrastructure/ssl_certificate/guide.pt-pt.md index 12ffdce1bc3..7813ebdd11a 100644 --- a/pages/network/content_delivery_network_infrastructure/ssl_certificate/guide.pt-pt.md +++ b/pages/network/content_delivery_network_infrastructure/ssl_certificate/guide.pt-pt.md @@ -12,7 +12,7 @@ updated: 2018-02-22 ## Requisitos -- Dispor da solução [CDN da OVH](https://www.ovh.com/pt/cdn/). +- Dispor da solução [CDN da OVH](/links/network/cdn-infrastructure). - Ter acesso à gestão da zona DNS do seu domínio. ## Instruções diff --git a/pages/network/load_balancer/case_blue_green/guide.en-asia.md b/pages/network/load_balancer/case_blue_green/guide.en-asia.md index de705cecacc..60c95ac97a0 100644 --- a/pages/network/load_balancer/case_blue_green/guide.en-asia.md +++ b/pages/network/load_balancer/case_blue_green/guide.en-asia.md @@ -1,64 +1,62 @@ --- title: 'Deploying a blue-green infrastructure' excerpt: 'This guide will show you how to deploy a blue-green infrastructure with the OVHcloud Load Balancer' -updated: 2019-02-25 +updated: 2025-10-24 --- ## Objective -With this guide, we will explore a specific use for the OVHcloud Load Balancer service — configuring a service to manage production/development infrastructures easily. This is also called a blue-green infrastructure. +This guide demonstrates a specific use case for the OVHcloud Load Balancer: the configuration of a service to facilitate seamless traffic switching between production and new production candidate environments, also called a **blue-green infrastructure**. -With a `blue-green`{.action} infrastructure, you can stop your infrastructure from experiencing any downtime. The main benefit of this deployment type is that you can prepare updates and/or maintenance in an environment that is isolated from your production environment. This way, you can test your changes before they are put into production, undo them quickly if you detect any faults, and do all of this with virtually zero downtime. +With a blue-green infrastructure, you can stop your infrastructure from experiencing any downtime. The main benefit of this deployment type is that you can prepare updates and/or maintenance in an environment that is isolated from your production environment. This way, you can test your changes before they are put into production, undo them quickly if you detect any faults, and do all of this with virtually zero downtime. **This guide will show you how to deploy a blue-green infrastructure with the OVHcloud Load Balancer.** ## Requirements -To deploy a `blue-green`{.action} infrastructure, you need the following components: +To deploy a blue-green infrastructure, you need the following components: -- an OVHcloud Load Balancer service -- a first server that hosts your production infrastructure -- a second server with a similar infrastructure, dedicated to development +- An [OVHcloud Load Balancer](/links/network/load-balancer) service +- Access to the [OVHcloud Control Panel](/links/manager) +- Two [dedicated servers](/links/bare-metal/bare-metal), one hosting your production environment, and a similarly configured server hosting your staging environment ## Instructions ### Scenario -The scenario we’ll describe here is as follows... +You have an infrastructure designed to host your live website. -You have an infrastructure that you can use to put your website online. +This environment hosts the website’s code, in addition to all essential applications (web servers, database servers, etc.). You need to update your applications and/or your code on a regular basis. You want to be able to test your updates without impacting the website's availability or functionality for end-users. -This infrastructure hosts your website’s code, and it also hosts the applications (web servers, database servers, etc.) required to put your website online. You need to update your applications and/or your code on a regular basis. You want to be able to test your updates without the risk of affecting your website’s availability to customers, or stopping the website from working properly. +One way to achieve this is by deploying a blue-green infrastructure. -One way to achieve this is by deploying a `blue-green`{.action} infrastructure. +The principle of a blue-green deployment involves being able to switch easily from a development infrastructure to a production infrastructure, and vice versa. This switch must be done in a way that is transparent for your users. To do this, public traffic will be routed to the standard HTTP port 80 for access to the production infrastructure, and a non-standard port, such as 8888, will be used to access the development infrastructure. -The principle of a `blue-green`{.action} deployment involves being able to switch easily from a development infrastructure to a production infrastructure, and vice versa. This switch must be done in a way that is transparent for your users. To do this, we will assign the standard HTTP port 80 for access to the production infrastructure, and the arbitrary port 8888 to access the development infrastructure. +## Deploy the infrastructures -## Deploy the infrastructures. - -In the scenario we are using, your IP Load Balancer service plays a central role. It is the element you use to expose your two infrastructures (production and development) to different users at the same time. +In this scenario, your Load Balancer service plays a central role. It is the element you use to expose your two infrastructures (production and development) to different users at the same time. The production infrastructure can be accessed by your customers on the standard HTTP service (port 80), and your development infrastructure can be accessed by developers and admins on the non-standard port 8888. -During the initial setup phase, we will arbitrarily assign a role to each of the parts of our infrastructure. `Infrastructure A`{.action} will be assigned to production, while `infrastructure B`{.action} will be assigned to development. At this stage, we will consider them to be similar to one another. +During the initial setup phase, roles are provisionally assigned to each infrastructure component. **Infrastructure A** serves as the initial production environment, while **Infrastructure B** serves as the staging environment. At this stage, we will consider them to be similar to one another. -A `blue-green`{.action} infrastructure involves switching from infrastructure A to infrastructure B, when infrastructure B is ready to expose your website after your changes have been applied and tested. The IP Load Balancer will manage this switch. +A blue-green infrastructure involves switching from infrastructure A to infrastructure B, once infrastructure B has been fully updated and validated. The Load Balancer will manage this switch. The diagram below gives a general idea of the architecture: ![General diagram of blue-green architecture](images/scheme.png){.thumbnail} -### Infrastructure A. +### Infrastructure A -This infrastructure is made up of a server farm that will later be associated with a front-end of your IP Load Balancer. This farm will expose an HTTP, TCP or UDP service to the front-end. It also balances loads by sending the front-end’s incoming traffic to the servers. For more detail on the role of various component of the OVHcloud Load Balancer service, you can read the following guide: [Introduction to the OVHcloud Load Balancer](/pages/network/load_balancer/use_presentation){.ref}. +This infrastructure is made up of a server farm that will later be associated with a front-end of your Load Balancer. This farm will expose an HTTP, TCP or UDP service to the front-end. It also balances loads by sending the front-end’s incoming traffic to the servers. For more details on the role of the various components of the OVHcloud Load Balancer service, please refer to the following guide: [Introduction to the OVHcloud Load Balancer](/pages/network/load_balancer/use_presentation). In our scenario, we will declare a farm of servers for the HTTP service. Please note that you can create as many farms (as well as TCP and/or UDP services) as are required for your final service to be exposed to your customers. -#### Via the OVHcloud Control Panel: +#### Via the OVHcloud Control Panel ![Add a new HTTP farm dedicated to infrastructure A](images/ferme1.png){.thumbnail} -#### Via the API: +#### Via the OVHcloud API > [!api] > @@ -69,7 +67,7 @@ In our scenario, we will declare a farm of servers for the HTTP service. Please |---|---| |serviceName|Your Load Balancer service ID| -With the additional calls listed below, you can list, modify and delete your server farms respectively. +With the additional calls listed below, you can list, modify and delete your server farms respectively: > [!api] > @@ -86,15 +84,15 @@ With the additional calls listed below, you can list, modify and delete your ser > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm > -Associate a server with your farm, if it is a physical server hosting your production infrastructure. The service exposed to the front-end is supplied by the server’s port 8080. Please note that you can associate one or more servers with each farm (to balance the load and/or offer higher fault tolerance, for ex.). +Link a dedicated server to your farm if it hosts your production infrastructure. The service is exposed to the front-end via the server’s port 8080. Note that you may LINK one or more servers with each farm (for example, to balance the load or offer higher fault tolerance). -#### Via the OVHcloud Control Panel: +#### Via the OVHcloud Control Panel ![Add a new server to the farm HTTP A](images/serveur1.png){.thumbnail} ![Enter the HTTP A server’s configuration](images/server1.png){.thumbnail} -#### Via the API: +#### Via the OVHcloud API > [!api] > @@ -109,7 +107,7 @@ Associate a server with your farm, if it is a physical server hosting your produ |displayName||The name of the server associated with your farm|HTTP A server| |port||The server port associated with your farm|8080| -With the additional calls listed below, you can list, modify and delete your servers respectively. +With the additional calls listed below, you can list, modify and delete your servers respectively: > [!api] > @@ -126,19 +124,19 @@ With the additional calls listed below, you can list, modify and delete your ser > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server > -### Infrastructure B. +### Infrastructure B -Functionally, this second infrastructure is identical to the first. It is also composed of a server farm that will later be associated with a second front-end of your IP Load Balancer. This server farm exposes the same service to the front-end as the first server farm. This service is supplied on the servers by port 8080. +Functionally, this second infrastructure is identical to the first. It is also composed of a server farm that will later be associated with a second front-end of your Load Balancer. This server farm exposes the same service to the front-end as the first server farm. This service is supplied on the servers by port 8080. Deploy the server farm for the HTTP service (and/or any other TCP or UDP services required for your final service to be exposed to your customers). -#### Via the Sunrise Control Panel: +#### Via the OVHcloud Control Panel ![Add a new HTTP farm dedicated to infrastructure B](images/ferme2.png){.thumbnail} ![Create a second farm dedicated to infrastructure B](images/backend2.png){.thumbnail} -#### Via the API: +#### Via the OVHcloud API > [!api] > @@ -151,13 +149,13 @@ Deploy the server farm for the HTTP service (and/or any other TCP or UDP service Associate a server with your farm. Here, it involves one or more physical servers hosting your development infrastructure. -#### Via the OVHcloud Control Panel: +#### Via the OVHcloud Control Panel ![Add a new server to the farm HTTP B](images/serveur2.png){.thumbnail} ![Enter the HTTP B server’s configuration](images/server2.png){.thumbnail} -#### Via the API: +#### Via the OVHcloud API > [!api] > @@ -176,9 +174,9 @@ At this stage, here is the configuration status for your two farms: ![Farm configuration](images/farms.png){.thumbnail} -## Front-ends. +## Front-ends -The magic of `blue-green`{.action} deployment lies in the configuration of your front-ends. At this stage, we have configure two functionally identical infrastructures. For both infrastructures, you have declared one or more server farms, each with their own set of associated servers. +The magic of blue-green deployment lies in the configuration of your front-ends. At this stage, we have configured two functionally identical infrastructures. For both infrastructures, you have declared one or more server farms, each with their own set of associated servers. To switch simply from one infrastructure to another, we will use front-ends. @@ -186,19 +184,20 @@ To do this, we need to declare two front-ends. The first one will give you acces > [!warning] > -> If the final service you expose to your customers requires several server farms (e.g. ports 80 and 443), you will need to declare a `front-end`{.action} for each of your farms. +> If the final service you expose to your customers requires several server farms (e.g. ports 80 and 443), you will need to declare a **front-end** for each of your farms. > -### Blue front-end. -This `front-end`{.action} is dedicated to accessing the production infrastructure. The ports exposed to your customers are the standard ports for accessing the service. In this case, we are exposing a HTTP service, so we will use port 80 (443 if you would like an SSL termination). +### Blue front-end + +This **front-end** is dedicated to accessing the production infrastructure. The ports exposed to your customers are the standard ports for accessing the service. In this case, we are exposing an HTTP service, so we will use port 80 (443 if you would like an SSL termination). -#### Via the OVHcloud Control Panel: +#### Via the OVHcloud Control Panel ![Adding a front-end dedicated to production, a blue front-end](images/frontend1.png){.thumbnail} ![Enter the blue front-end’s configuration](images/fblue.png){.thumbnail} -#### Via the API: +#### Via the OVHcloud API > [!api] > @@ -213,17 +212,17 @@ This `front-end`{.action} is dedicated to accessing the production infrastructur |port|Required|The port exposed to your customers by your front-end|80| |zone|Required|The zone in which you want to deploy your front-end|all| -### Green front-end. +### Green front-end -This `front-end`{.action} is dedicated to accessing the development infrastructure. The ports exposed to your customers will be non-standard ports that you can choose arbitrarily. In this case, we will expose the HTTP development service on port 8888. +This **front-end** is dedicated to accessing the development infrastructure. The ports exposed to your customers will be non-standard ports that you can choose arbitrarily. In this case, we will expose the HTTP development service on port 8888. -#### Via the OVHcloud Control Panel: +#### Via the OVHcloud Control Panel ![Add the green front-end, dedicated to development](images/frontend2.png){.thumbnail} ![Enter the green front-end’s configuration](images/fgreen.png){.thumbnail} -#### Via the API: +#### Via the OVHcloud API > [!api] > @@ -238,17 +237,17 @@ This `front-end`{.action} is dedicated to accessing the development infrastructu |port|Required|The port exposed to your customers by your front-end|8888| |zone|Required|The zone in which you want to deploy your front-end|all| -## Manage the deployments. +## Manage the deployments -### Initial deployment. +### Initial deployment -Once you have finished configuring the components of the OVHcloud Load Balancer service, you now just need to apply your changes. +Once you have finished configuring the components of the OVHcloud Load Balancer service, the only thing left to do is apply your changes. -#### Via the OVHcloud Control Panel: +#### Via the OVHcloud Control Panel ![Apply your changes to the zone](images/deploy.png){.thumbnail} -#### Via the API: +#### Via the OVHcloud API > [!api] > @@ -259,30 +258,30 @@ Once you have finished configuring the components of the OVHcloud Load Balancer |---|---| |serviceName|Your Load Balancer service ID| -### The production/pre-production switch. +### The production/staging switch -At this stage, our initial environment is deployed and ready to use. How do we use it? - -To put it simply, you just need to switch over your front-ends from one server farm to another. +At this stage, our initial environment is deployed and ready to use. Now, you need to switch over your front-ends from one server farm to another. Let’s take a look at our scenario: -- The production infrastructure (A) is deployed on `HTTP farm A`{.action} (id 77212), which in turn is attached to `HTTP server A`{.action}. This infrastructure can be accessed through the `blue front-end`{.action}. -- The development infrastructure (B) is deployed on `HTTP farm B`{.action} (id 77213), which in turn is attached to `HTTP server B`{.action}. This infrastructure can be accessed through the `green front-end`{.action}. +- The production infrastructure (A) is deployed on **HTTP farm A** (id 77212), which in turn is attached to **HTTP server A**. This infrastructure can be accessed through the **blue front-end**. +- The development infrastructure (B) is deployed on **HTTP farm B** (id 77213), which in turn is attached to **HTTP server B**. This infrastructure can be accessed through the **green front-end**. -Once you have modified/applied updates to `infrastructure B`{.action} and checked that the service is working properly, you decide to put it into production. +Once you have modified/applied updates to **infrastructure B** and checked that the service is working properly, you can decide to put it into production. To switch between the two farms, you can simply update your different front-ends by modifying the ID of the farm it is attached to, and applying the modification. -The `blue front-end`{.action} (id 70089) will then be associated with `Farm B`{.action} (infrastructure B, new production, id 77213). +The **blue front-end** (id 70089) will then be associated with **Farm B** (infrastructure B, new production, id 77213). -The `green front-end`{.action} (id 70090) will then be associated with `Farm A`{.action} (infrastructure A, new development, id 77212). +The **green front-end** (id 70090) will then be associated with **Farm A** (infrastructure A, new development, id 77212). -This should be the result on the Sunrise Control Panel after updating the front-ends and applying the new configuration: +This should be the result on the OVHcloud Control Panel after updating the front-ends and applying the new configuration: ![Result after updating front-ends](images/switch.png){.thumbnail} -#### Via the API: updating front-ends and applying modifications#### +#### Via the OVHcloud API + +- Updating front-ends and applying modifications: > [!api] > @@ -306,7 +305,7 @@ This should be the result on the Sunrise Control Panel after updating the front- |frontendId|Your production front-end ID|70090| |defaultFarmId|Your development server farm ID|77212| -#### To apply your changes and effectively switch over the production and development environments: +- To apply your changes and effectively switch over the production and development environments: > [!api] > @@ -317,12 +316,16 @@ This should be the result on the Sunrise Control Panel after updating the front- |---|---| |serviceName|Your Load Balancer service ID| -## Go further +## Conclusion -You now have an infrastructure you can use to simply and efficiently manage `blue-green deployments`{.action}. +You have successfully implemented a highly available infrastructure for managing blue-green deployments. -Developers have access to a development environment on port 8888 (or whichever other port you would prefer to define), while your customers continue to access the service in production via the standard HTTP port (80 in our case, for example). +Developers have access to a development environment on port 8888 (or any configurable non-standard port), while your customers continue to access the service in production via the standard HTTP port (80). The infrastructure presented here is limited to just one port, but it can be expanded by adding other ports. For example, you can also expose your website on the standard HTTPS port (443). You can do this by defining new farms dedicated to each port you want to expose, and associating them with their corresponding front-ends (one for the standard port exposed in production, the second for the arbitrary port dedicated to development). Another way to consolidate your infrastructure even further is by multiplying the servers attached to your farms. This way, you can make your services more redundant (guaranteeing availability as a result), and also add a load balancing capacity. + +## Go further + +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/case_blue_green/guide.en-au.md b/pages/network/load_balancer/case_blue_green/guide.en-au.md index de705cecacc..60c95ac97a0 100644 --- a/pages/network/load_balancer/case_blue_green/guide.en-au.md +++ b/pages/network/load_balancer/case_blue_green/guide.en-au.md @@ -1,64 +1,62 @@ --- title: 'Deploying a blue-green infrastructure' excerpt: 'This guide will show you how to deploy a blue-green infrastructure with the OVHcloud Load Balancer' -updated: 2019-02-25 +updated: 2025-10-24 --- ## Objective -With this guide, we will explore a specific use for the OVHcloud Load Balancer service — configuring a service to manage production/development infrastructures easily. This is also called a blue-green infrastructure. +This guide demonstrates a specific use case for the OVHcloud Load Balancer: the configuration of a service to facilitate seamless traffic switching between production and new production candidate environments, also called a **blue-green infrastructure**. -With a `blue-green`{.action} infrastructure, you can stop your infrastructure from experiencing any downtime. The main benefit of this deployment type is that you can prepare updates and/or maintenance in an environment that is isolated from your production environment. This way, you can test your changes before they are put into production, undo them quickly if you detect any faults, and do all of this with virtually zero downtime. +With a blue-green infrastructure, you can stop your infrastructure from experiencing any downtime. The main benefit of this deployment type is that you can prepare updates and/or maintenance in an environment that is isolated from your production environment. This way, you can test your changes before they are put into production, undo them quickly if you detect any faults, and do all of this with virtually zero downtime. **This guide will show you how to deploy a blue-green infrastructure with the OVHcloud Load Balancer.** ## Requirements -To deploy a `blue-green`{.action} infrastructure, you need the following components: +To deploy a blue-green infrastructure, you need the following components: -- an OVHcloud Load Balancer service -- a first server that hosts your production infrastructure -- a second server with a similar infrastructure, dedicated to development +- An [OVHcloud Load Balancer](/links/network/load-balancer) service +- Access to the [OVHcloud Control Panel](/links/manager) +- Two [dedicated servers](/links/bare-metal/bare-metal), one hosting your production environment, and a similarly configured server hosting your staging environment ## Instructions ### Scenario -The scenario we’ll describe here is as follows... +You have an infrastructure designed to host your live website. -You have an infrastructure that you can use to put your website online. +This environment hosts the website’s code, in addition to all essential applications (web servers, database servers, etc.). You need to update your applications and/or your code on a regular basis. You want to be able to test your updates without impacting the website's availability or functionality for end-users. -This infrastructure hosts your website’s code, and it also hosts the applications (web servers, database servers, etc.) required to put your website online. You need to update your applications and/or your code on a regular basis. You want to be able to test your updates without the risk of affecting your website’s availability to customers, or stopping the website from working properly. +One way to achieve this is by deploying a blue-green infrastructure. -One way to achieve this is by deploying a `blue-green`{.action} infrastructure. +The principle of a blue-green deployment involves being able to switch easily from a development infrastructure to a production infrastructure, and vice versa. This switch must be done in a way that is transparent for your users. To do this, public traffic will be routed to the standard HTTP port 80 for access to the production infrastructure, and a non-standard port, such as 8888, will be used to access the development infrastructure. -The principle of a `blue-green`{.action} deployment involves being able to switch easily from a development infrastructure to a production infrastructure, and vice versa. This switch must be done in a way that is transparent for your users. To do this, we will assign the standard HTTP port 80 for access to the production infrastructure, and the arbitrary port 8888 to access the development infrastructure. +## Deploy the infrastructures -## Deploy the infrastructures. - -In the scenario we are using, your IP Load Balancer service plays a central role. It is the element you use to expose your two infrastructures (production and development) to different users at the same time. +In this scenario, your Load Balancer service plays a central role. It is the element you use to expose your two infrastructures (production and development) to different users at the same time. The production infrastructure can be accessed by your customers on the standard HTTP service (port 80), and your development infrastructure can be accessed by developers and admins on the non-standard port 8888. -During the initial setup phase, we will arbitrarily assign a role to each of the parts of our infrastructure. `Infrastructure A`{.action} will be assigned to production, while `infrastructure B`{.action} will be assigned to development. At this stage, we will consider them to be similar to one another. +During the initial setup phase, roles are provisionally assigned to each infrastructure component. **Infrastructure A** serves as the initial production environment, while **Infrastructure B** serves as the staging environment. At this stage, we will consider them to be similar to one another. -A `blue-green`{.action} infrastructure involves switching from infrastructure A to infrastructure B, when infrastructure B is ready to expose your website after your changes have been applied and tested. The IP Load Balancer will manage this switch. +A blue-green infrastructure involves switching from infrastructure A to infrastructure B, once infrastructure B has been fully updated and validated. The Load Balancer will manage this switch. The diagram below gives a general idea of the architecture: ![General diagram of blue-green architecture](images/scheme.png){.thumbnail} -### Infrastructure A. +### Infrastructure A -This infrastructure is made up of a server farm that will later be associated with a front-end of your IP Load Balancer. This farm will expose an HTTP, TCP or UDP service to the front-end. It also balances loads by sending the front-end’s incoming traffic to the servers. For more detail on the role of various component of the OVHcloud Load Balancer service, you can read the following guide: [Introduction to the OVHcloud Load Balancer](/pages/network/load_balancer/use_presentation){.ref}. +This infrastructure is made up of a server farm that will later be associated with a front-end of your Load Balancer. This farm will expose an HTTP, TCP or UDP service to the front-end. It also balances loads by sending the front-end’s incoming traffic to the servers. For more details on the role of the various components of the OVHcloud Load Balancer service, please refer to the following guide: [Introduction to the OVHcloud Load Balancer](/pages/network/load_balancer/use_presentation). In our scenario, we will declare a farm of servers for the HTTP service. Please note that you can create as many farms (as well as TCP and/or UDP services) as are required for your final service to be exposed to your customers. -#### Via the OVHcloud Control Panel: +#### Via the OVHcloud Control Panel ![Add a new HTTP farm dedicated to infrastructure A](images/ferme1.png){.thumbnail} -#### Via the API: +#### Via the OVHcloud API > [!api] > @@ -69,7 +67,7 @@ In our scenario, we will declare a farm of servers for the HTTP service. Please |---|---| |serviceName|Your Load Balancer service ID| -With the additional calls listed below, you can list, modify and delete your server farms respectively. +With the additional calls listed below, you can list, modify and delete your server farms respectively: > [!api] > @@ -86,15 +84,15 @@ With the additional calls listed below, you can list, modify and delete your ser > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm > -Associate a server with your farm, if it is a physical server hosting your production infrastructure. The service exposed to the front-end is supplied by the server’s port 8080. Please note that you can associate one or more servers with each farm (to balance the load and/or offer higher fault tolerance, for ex.). +Link a dedicated server to your farm if it hosts your production infrastructure. The service is exposed to the front-end via the server’s port 8080. Note that you may LINK one or more servers with each farm (for example, to balance the load or offer higher fault tolerance). -#### Via the OVHcloud Control Panel: +#### Via the OVHcloud Control Panel ![Add a new server to the farm HTTP A](images/serveur1.png){.thumbnail} ![Enter the HTTP A server’s configuration](images/server1.png){.thumbnail} -#### Via the API: +#### Via the OVHcloud API > [!api] > @@ -109,7 +107,7 @@ Associate a server with your farm, if it is a physical server hosting your produ |displayName||The name of the server associated with your farm|HTTP A server| |port||The server port associated with your farm|8080| -With the additional calls listed below, you can list, modify and delete your servers respectively. +With the additional calls listed below, you can list, modify and delete your servers respectively: > [!api] > @@ -126,19 +124,19 @@ With the additional calls listed below, you can list, modify and delete your ser > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server > -### Infrastructure B. +### Infrastructure B -Functionally, this second infrastructure is identical to the first. It is also composed of a server farm that will later be associated with a second front-end of your IP Load Balancer. This server farm exposes the same service to the front-end as the first server farm. This service is supplied on the servers by port 8080. +Functionally, this second infrastructure is identical to the first. It is also composed of a server farm that will later be associated with a second front-end of your Load Balancer. This server farm exposes the same service to the front-end as the first server farm. This service is supplied on the servers by port 8080. Deploy the server farm for the HTTP service (and/or any other TCP or UDP services required for your final service to be exposed to your customers). -#### Via the Sunrise Control Panel: +#### Via the OVHcloud Control Panel ![Add a new HTTP farm dedicated to infrastructure B](images/ferme2.png){.thumbnail} ![Create a second farm dedicated to infrastructure B](images/backend2.png){.thumbnail} -#### Via the API: +#### Via the OVHcloud API > [!api] > @@ -151,13 +149,13 @@ Deploy the server farm for the HTTP service (and/or any other TCP or UDP service Associate a server with your farm. Here, it involves one or more physical servers hosting your development infrastructure. -#### Via the OVHcloud Control Panel: +#### Via the OVHcloud Control Panel ![Add a new server to the farm HTTP B](images/serveur2.png){.thumbnail} ![Enter the HTTP B server’s configuration](images/server2.png){.thumbnail} -#### Via the API: +#### Via the OVHcloud API > [!api] > @@ -176,9 +174,9 @@ At this stage, here is the configuration status for your two farms: ![Farm configuration](images/farms.png){.thumbnail} -## Front-ends. +## Front-ends -The magic of `blue-green`{.action} deployment lies in the configuration of your front-ends. At this stage, we have configure two functionally identical infrastructures. For both infrastructures, you have declared one or more server farms, each with their own set of associated servers. +The magic of blue-green deployment lies in the configuration of your front-ends. At this stage, we have configured two functionally identical infrastructures. For both infrastructures, you have declared one or more server farms, each with their own set of associated servers. To switch simply from one infrastructure to another, we will use front-ends. @@ -186,19 +184,20 @@ To do this, we need to declare two front-ends. The first one will give you acces > [!warning] > -> If the final service you expose to your customers requires several server farms (e.g. ports 80 and 443), you will need to declare a `front-end`{.action} for each of your farms. +> If the final service you expose to your customers requires several server farms (e.g. ports 80 and 443), you will need to declare a **front-end** for each of your farms. > -### Blue front-end. -This `front-end`{.action} is dedicated to accessing the production infrastructure. The ports exposed to your customers are the standard ports for accessing the service. In this case, we are exposing a HTTP service, so we will use port 80 (443 if you would like an SSL termination). +### Blue front-end + +This **front-end** is dedicated to accessing the production infrastructure. The ports exposed to your customers are the standard ports for accessing the service. In this case, we are exposing an HTTP service, so we will use port 80 (443 if you would like an SSL termination). -#### Via the OVHcloud Control Panel: +#### Via the OVHcloud Control Panel ![Adding a front-end dedicated to production, a blue front-end](images/frontend1.png){.thumbnail} ![Enter the blue front-end’s configuration](images/fblue.png){.thumbnail} -#### Via the API: +#### Via the OVHcloud API > [!api] > @@ -213,17 +212,17 @@ This `front-end`{.action} is dedicated to accessing the production infrastructur |port|Required|The port exposed to your customers by your front-end|80| |zone|Required|The zone in which you want to deploy your front-end|all| -### Green front-end. +### Green front-end -This `front-end`{.action} is dedicated to accessing the development infrastructure. The ports exposed to your customers will be non-standard ports that you can choose arbitrarily. In this case, we will expose the HTTP development service on port 8888. +This **front-end** is dedicated to accessing the development infrastructure. The ports exposed to your customers will be non-standard ports that you can choose arbitrarily. In this case, we will expose the HTTP development service on port 8888. -#### Via the OVHcloud Control Panel: +#### Via the OVHcloud Control Panel ![Add the green front-end, dedicated to development](images/frontend2.png){.thumbnail} ![Enter the green front-end’s configuration](images/fgreen.png){.thumbnail} -#### Via the API: +#### Via the OVHcloud API > [!api] > @@ -238,17 +237,17 @@ This `front-end`{.action} is dedicated to accessing the development infrastructu |port|Required|The port exposed to your customers by your front-end|8888| |zone|Required|The zone in which you want to deploy your front-end|all| -## Manage the deployments. +## Manage the deployments -### Initial deployment. +### Initial deployment -Once you have finished configuring the components of the OVHcloud Load Balancer service, you now just need to apply your changes. +Once you have finished configuring the components of the OVHcloud Load Balancer service, the only thing left to do is apply your changes. -#### Via the OVHcloud Control Panel: +#### Via the OVHcloud Control Panel ![Apply your changes to the zone](images/deploy.png){.thumbnail} -#### Via the API: +#### Via the OVHcloud API > [!api] > @@ -259,30 +258,30 @@ Once you have finished configuring the components of the OVHcloud Load Balancer |---|---| |serviceName|Your Load Balancer service ID| -### The production/pre-production switch. +### The production/staging switch -At this stage, our initial environment is deployed and ready to use. How do we use it? - -To put it simply, you just need to switch over your front-ends from one server farm to another. +At this stage, our initial environment is deployed and ready to use. Now, you need to switch over your front-ends from one server farm to another. Let’s take a look at our scenario: -- The production infrastructure (A) is deployed on `HTTP farm A`{.action} (id 77212), which in turn is attached to `HTTP server A`{.action}. This infrastructure can be accessed through the `blue front-end`{.action}. -- The development infrastructure (B) is deployed on `HTTP farm B`{.action} (id 77213), which in turn is attached to `HTTP server B`{.action}. This infrastructure can be accessed through the `green front-end`{.action}. +- The production infrastructure (A) is deployed on **HTTP farm A** (id 77212), which in turn is attached to **HTTP server A**. This infrastructure can be accessed through the **blue front-end**. +- The development infrastructure (B) is deployed on **HTTP farm B** (id 77213), which in turn is attached to **HTTP server B**. This infrastructure can be accessed through the **green front-end**. -Once you have modified/applied updates to `infrastructure B`{.action} and checked that the service is working properly, you decide to put it into production. +Once you have modified/applied updates to **infrastructure B** and checked that the service is working properly, you can decide to put it into production. To switch between the two farms, you can simply update your different front-ends by modifying the ID of the farm it is attached to, and applying the modification. -The `blue front-end`{.action} (id 70089) will then be associated with `Farm B`{.action} (infrastructure B, new production, id 77213). +The **blue front-end** (id 70089) will then be associated with **Farm B** (infrastructure B, new production, id 77213). -The `green front-end`{.action} (id 70090) will then be associated with `Farm A`{.action} (infrastructure A, new development, id 77212). +The **green front-end** (id 70090) will then be associated with **Farm A** (infrastructure A, new development, id 77212). -This should be the result on the Sunrise Control Panel after updating the front-ends and applying the new configuration: +This should be the result on the OVHcloud Control Panel after updating the front-ends and applying the new configuration: ![Result after updating front-ends](images/switch.png){.thumbnail} -#### Via the API: updating front-ends and applying modifications#### +#### Via the OVHcloud API + +- Updating front-ends and applying modifications: > [!api] > @@ -306,7 +305,7 @@ This should be the result on the Sunrise Control Panel after updating the front- |frontendId|Your production front-end ID|70090| |defaultFarmId|Your development server farm ID|77212| -#### To apply your changes and effectively switch over the production and development environments: +- To apply your changes and effectively switch over the production and development environments: > [!api] > @@ -317,12 +316,16 @@ This should be the result on the Sunrise Control Panel after updating the front- |---|---| |serviceName|Your Load Balancer service ID| -## Go further +## Conclusion -You now have an infrastructure you can use to simply and efficiently manage `blue-green deployments`{.action}. +You have successfully implemented a highly available infrastructure for managing blue-green deployments. -Developers have access to a development environment on port 8888 (or whichever other port you would prefer to define), while your customers continue to access the service in production via the standard HTTP port (80 in our case, for example). +Developers have access to a development environment on port 8888 (or any configurable non-standard port), while your customers continue to access the service in production via the standard HTTP port (80). The infrastructure presented here is limited to just one port, but it can be expanded by adding other ports. For example, you can also expose your website on the standard HTTPS port (443). You can do this by defining new farms dedicated to each port you want to expose, and associating them with their corresponding front-ends (one for the standard port exposed in production, the second for the arbitrary port dedicated to development). Another way to consolidate your infrastructure even further is by multiplying the servers attached to your farms. This way, you can make your services more redundant (guaranteeing availability as a result), and also add a load balancing capacity. + +## Go further + +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/case_blue_green/guide.en-ca.md b/pages/network/load_balancer/case_blue_green/guide.en-ca.md index de705cecacc..60c95ac97a0 100644 --- a/pages/network/load_balancer/case_blue_green/guide.en-ca.md +++ b/pages/network/load_balancer/case_blue_green/guide.en-ca.md @@ -1,64 +1,62 @@ --- title: 'Deploying a blue-green infrastructure' excerpt: 'This guide will show you how to deploy a blue-green infrastructure with the OVHcloud Load Balancer' -updated: 2019-02-25 +updated: 2025-10-24 --- ## Objective -With this guide, we will explore a specific use for the OVHcloud Load Balancer service — configuring a service to manage production/development infrastructures easily. This is also called a blue-green infrastructure. +This guide demonstrates a specific use case for the OVHcloud Load Balancer: the configuration of a service to facilitate seamless traffic switching between production and new production candidate environments, also called a **blue-green infrastructure**. -With a `blue-green`{.action} infrastructure, you can stop your infrastructure from experiencing any downtime. The main benefit of this deployment type is that you can prepare updates and/or maintenance in an environment that is isolated from your production environment. This way, you can test your changes before they are put into production, undo them quickly if you detect any faults, and do all of this with virtually zero downtime. +With a blue-green infrastructure, you can stop your infrastructure from experiencing any downtime. The main benefit of this deployment type is that you can prepare updates and/or maintenance in an environment that is isolated from your production environment. This way, you can test your changes before they are put into production, undo them quickly if you detect any faults, and do all of this with virtually zero downtime. **This guide will show you how to deploy a blue-green infrastructure with the OVHcloud Load Balancer.** ## Requirements -To deploy a `blue-green`{.action} infrastructure, you need the following components: +To deploy a blue-green infrastructure, you need the following components: -- an OVHcloud Load Balancer service -- a first server that hosts your production infrastructure -- a second server with a similar infrastructure, dedicated to development +- An [OVHcloud Load Balancer](/links/network/load-balancer) service +- Access to the [OVHcloud Control Panel](/links/manager) +- Two [dedicated servers](/links/bare-metal/bare-metal), one hosting your production environment, and a similarly configured server hosting your staging environment ## Instructions ### Scenario -The scenario we’ll describe here is as follows... +You have an infrastructure designed to host your live website. -You have an infrastructure that you can use to put your website online. +This environment hosts the website’s code, in addition to all essential applications (web servers, database servers, etc.). You need to update your applications and/or your code on a regular basis. You want to be able to test your updates without impacting the website's availability or functionality for end-users. -This infrastructure hosts your website’s code, and it also hosts the applications (web servers, database servers, etc.) required to put your website online. You need to update your applications and/or your code on a regular basis. You want to be able to test your updates without the risk of affecting your website’s availability to customers, or stopping the website from working properly. +One way to achieve this is by deploying a blue-green infrastructure. -One way to achieve this is by deploying a `blue-green`{.action} infrastructure. +The principle of a blue-green deployment involves being able to switch easily from a development infrastructure to a production infrastructure, and vice versa. This switch must be done in a way that is transparent for your users. To do this, public traffic will be routed to the standard HTTP port 80 for access to the production infrastructure, and a non-standard port, such as 8888, will be used to access the development infrastructure. -The principle of a `blue-green`{.action} deployment involves being able to switch easily from a development infrastructure to a production infrastructure, and vice versa. This switch must be done in a way that is transparent for your users. To do this, we will assign the standard HTTP port 80 for access to the production infrastructure, and the arbitrary port 8888 to access the development infrastructure. +## Deploy the infrastructures -## Deploy the infrastructures. - -In the scenario we are using, your IP Load Balancer service plays a central role. It is the element you use to expose your two infrastructures (production and development) to different users at the same time. +In this scenario, your Load Balancer service plays a central role. It is the element you use to expose your two infrastructures (production and development) to different users at the same time. The production infrastructure can be accessed by your customers on the standard HTTP service (port 80), and your development infrastructure can be accessed by developers and admins on the non-standard port 8888. -During the initial setup phase, we will arbitrarily assign a role to each of the parts of our infrastructure. `Infrastructure A`{.action} will be assigned to production, while `infrastructure B`{.action} will be assigned to development. At this stage, we will consider them to be similar to one another. +During the initial setup phase, roles are provisionally assigned to each infrastructure component. **Infrastructure A** serves as the initial production environment, while **Infrastructure B** serves as the staging environment. At this stage, we will consider them to be similar to one another. -A `blue-green`{.action} infrastructure involves switching from infrastructure A to infrastructure B, when infrastructure B is ready to expose your website after your changes have been applied and tested. The IP Load Balancer will manage this switch. +A blue-green infrastructure involves switching from infrastructure A to infrastructure B, once infrastructure B has been fully updated and validated. The Load Balancer will manage this switch. The diagram below gives a general idea of the architecture: ![General diagram of blue-green architecture](images/scheme.png){.thumbnail} -### Infrastructure A. +### Infrastructure A -This infrastructure is made up of a server farm that will later be associated with a front-end of your IP Load Balancer. This farm will expose an HTTP, TCP or UDP service to the front-end. It also balances loads by sending the front-end’s incoming traffic to the servers. For more detail on the role of various component of the OVHcloud Load Balancer service, you can read the following guide: [Introduction to the OVHcloud Load Balancer](/pages/network/load_balancer/use_presentation){.ref}. +This infrastructure is made up of a server farm that will later be associated with a front-end of your Load Balancer. This farm will expose an HTTP, TCP or UDP service to the front-end. It also balances loads by sending the front-end’s incoming traffic to the servers. For more details on the role of the various components of the OVHcloud Load Balancer service, please refer to the following guide: [Introduction to the OVHcloud Load Balancer](/pages/network/load_balancer/use_presentation). In our scenario, we will declare a farm of servers for the HTTP service. Please note that you can create as many farms (as well as TCP and/or UDP services) as are required for your final service to be exposed to your customers. -#### Via the OVHcloud Control Panel: +#### Via the OVHcloud Control Panel ![Add a new HTTP farm dedicated to infrastructure A](images/ferme1.png){.thumbnail} -#### Via the API: +#### Via the OVHcloud API > [!api] > @@ -69,7 +67,7 @@ In our scenario, we will declare a farm of servers for the HTTP service. Please |---|---| |serviceName|Your Load Balancer service ID| -With the additional calls listed below, you can list, modify and delete your server farms respectively. +With the additional calls listed below, you can list, modify and delete your server farms respectively: > [!api] > @@ -86,15 +84,15 @@ With the additional calls listed below, you can list, modify and delete your ser > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm > -Associate a server with your farm, if it is a physical server hosting your production infrastructure. The service exposed to the front-end is supplied by the server’s port 8080. Please note that you can associate one or more servers with each farm (to balance the load and/or offer higher fault tolerance, for ex.). +Link a dedicated server to your farm if it hosts your production infrastructure. The service is exposed to the front-end via the server’s port 8080. Note that you may LINK one or more servers with each farm (for example, to balance the load or offer higher fault tolerance). -#### Via the OVHcloud Control Panel: +#### Via the OVHcloud Control Panel ![Add a new server to the farm HTTP A](images/serveur1.png){.thumbnail} ![Enter the HTTP A server’s configuration](images/server1.png){.thumbnail} -#### Via the API: +#### Via the OVHcloud API > [!api] > @@ -109,7 +107,7 @@ Associate a server with your farm, if it is a physical server hosting your produ |displayName||The name of the server associated with your farm|HTTP A server| |port||The server port associated with your farm|8080| -With the additional calls listed below, you can list, modify and delete your servers respectively. +With the additional calls listed below, you can list, modify and delete your servers respectively: > [!api] > @@ -126,19 +124,19 @@ With the additional calls listed below, you can list, modify and delete your ser > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server > -### Infrastructure B. +### Infrastructure B -Functionally, this second infrastructure is identical to the first. It is also composed of a server farm that will later be associated with a second front-end of your IP Load Balancer. This server farm exposes the same service to the front-end as the first server farm. This service is supplied on the servers by port 8080. +Functionally, this second infrastructure is identical to the first. It is also composed of a server farm that will later be associated with a second front-end of your Load Balancer. This server farm exposes the same service to the front-end as the first server farm. This service is supplied on the servers by port 8080. Deploy the server farm for the HTTP service (and/or any other TCP or UDP services required for your final service to be exposed to your customers). -#### Via the Sunrise Control Panel: +#### Via the OVHcloud Control Panel ![Add a new HTTP farm dedicated to infrastructure B](images/ferme2.png){.thumbnail} ![Create a second farm dedicated to infrastructure B](images/backend2.png){.thumbnail} -#### Via the API: +#### Via the OVHcloud API > [!api] > @@ -151,13 +149,13 @@ Deploy the server farm for the HTTP service (and/or any other TCP or UDP service Associate a server with your farm. Here, it involves one or more physical servers hosting your development infrastructure. -#### Via the OVHcloud Control Panel: +#### Via the OVHcloud Control Panel ![Add a new server to the farm HTTP B](images/serveur2.png){.thumbnail} ![Enter the HTTP B server’s configuration](images/server2.png){.thumbnail} -#### Via the API: +#### Via the OVHcloud API > [!api] > @@ -176,9 +174,9 @@ At this stage, here is the configuration status for your two farms: ![Farm configuration](images/farms.png){.thumbnail} -## Front-ends. +## Front-ends -The magic of `blue-green`{.action} deployment lies in the configuration of your front-ends. At this stage, we have configure two functionally identical infrastructures. For both infrastructures, you have declared one or more server farms, each with their own set of associated servers. +The magic of blue-green deployment lies in the configuration of your front-ends. At this stage, we have configured two functionally identical infrastructures. For both infrastructures, you have declared one or more server farms, each with their own set of associated servers. To switch simply from one infrastructure to another, we will use front-ends. @@ -186,19 +184,20 @@ To do this, we need to declare two front-ends. The first one will give you acces > [!warning] > -> If the final service you expose to your customers requires several server farms (e.g. ports 80 and 443), you will need to declare a `front-end`{.action} for each of your farms. +> If the final service you expose to your customers requires several server farms (e.g. ports 80 and 443), you will need to declare a **front-end** for each of your farms. > -### Blue front-end. -This `front-end`{.action} is dedicated to accessing the production infrastructure. The ports exposed to your customers are the standard ports for accessing the service. In this case, we are exposing a HTTP service, so we will use port 80 (443 if you would like an SSL termination). +### Blue front-end + +This **front-end** is dedicated to accessing the production infrastructure. The ports exposed to your customers are the standard ports for accessing the service. In this case, we are exposing an HTTP service, so we will use port 80 (443 if you would like an SSL termination). -#### Via the OVHcloud Control Panel: +#### Via the OVHcloud Control Panel ![Adding a front-end dedicated to production, a blue front-end](images/frontend1.png){.thumbnail} ![Enter the blue front-end’s configuration](images/fblue.png){.thumbnail} -#### Via the API: +#### Via the OVHcloud API > [!api] > @@ -213,17 +212,17 @@ This `front-end`{.action} is dedicated to accessing the production infrastructur |port|Required|The port exposed to your customers by your front-end|80| |zone|Required|The zone in which you want to deploy your front-end|all| -### Green front-end. +### Green front-end -This `front-end`{.action} is dedicated to accessing the development infrastructure. The ports exposed to your customers will be non-standard ports that you can choose arbitrarily. In this case, we will expose the HTTP development service on port 8888. +This **front-end** is dedicated to accessing the development infrastructure. The ports exposed to your customers will be non-standard ports that you can choose arbitrarily. In this case, we will expose the HTTP development service on port 8888. -#### Via the OVHcloud Control Panel: +#### Via the OVHcloud Control Panel ![Add the green front-end, dedicated to development](images/frontend2.png){.thumbnail} ![Enter the green front-end’s configuration](images/fgreen.png){.thumbnail} -#### Via the API: +#### Via the OVHcloud API > [!api] > @@ -238,17 +237,17 @@ This `front-end`{.action} is dedicated to accessing the development infrastructu |port|Required|The port exposed to your customers by your front-end|8888| |zone|Required|The zone in which you want to deploy your front-end|all| -## Manage the deployments. +## Manage the deployments -### Initial deployment. +### Initial deployment -Once you have finished configuring the components of the OVHcloud Load Balancer service, you now just need to apply your changes. +Once you have finished configuring the components of the OVHcloud Load Balancer service, the only thing left to do is apply your changes. -#### Via the OVHcloud Control Panel: +#### Via the OVHcloud Control Panel ![Apply your changes to the zone](images/deploy.png){.thumbnail} -#### Via the API: +#### Via the OVHcloud API > [!api] > @@ -259,30 +258,30 @@ Once you have finished configuring the components of the OVHcloud Load Balancer |---|---| |serviceName|Your Load Balancer service ID| -### The production/pre-production switch. +### The production/staging switch -At this stage, our initial environment is deployed and ready to use. How do we use it? - -To put it simply, you just need to switch over your front-ends from one server farm to another. +At this stage, our initial environment is deployed and ready to use. Now, you need to switch over your front-ends from one server farm to another. Let’s take a look at our scenario: -- The production infrastructure (A) is deployed on `HTTP farm A`{.action} (id 77212), which in turn is attached to `HTTP server A`{.action}. This infrastructure can be accessed through the `blue front-end`{.action}. -- The development infrastructure (B) is deployed on `HTTP farm B`{.action} (id 77213), which in turn is attached to `HTTP server B`{.action}. This infrastructure can be accessed through the `green front-end`{.action}. +- The production infrastructure (A) is deployed on **HTTP farm A** (id 77212), which in turn is attached to **HTTP server A**. This infrastructure can be accessed through the **blue front-end**. +- The development infrastructure (B) is deployed on **HTTP farm B** (id 77213), which in turn is attached to **HTTP server B**. This infrastructure can be accessed through the **green front-end**. -Once you have modified/applied updates to `infrastructure B`{.action} and checked that the service is working properly, you decide to put it into production. +Once you have modified/applied updates to **infrastructure B** and checked that the service is working properly, you can decide to put it into production. To switch between the two farms, you can simply update your different front-ends by modifying the ID of the farm it is attached to, and applying the modification. -The `blue front-end`{.action} (id 70089) will then be associated with `Farm B`{.action} (infrastructure B, new production, id 77213). +The **blue front-end** (id 70089) will then be associated with **Farm B** (infrastructure B, new production, id 77213). -The `green front-end`{.action} (id 70090) will then be associated with `Farm A`{.action} (infrastructure A, new development, id 77212). +The **green front-end** (id 70090) will then be associated with **Farm A** (infrastructure A, new development, id 77212). -This should be the result on the Sunrise Control Panel after updating the front-ends and applying the new configuration: +This should be the result on the OVHcloud Control Panel after updating the front-ends and applying the new configuration: ![Result after updating front-ends](images/switch.png){.thumbnail} -#### Via the API: updating front-ends and applying modifications#### +#### Via the OVHcloud API + +- Updating front-ends and applying modifications: > [!api] > @@ -306,7 +305,7 @@ This should be the result on the Sunrise Control Panel after updating the front- |frontendId|Your production front-end ID|70090| |defaultFarmId|Your development server farm ID|77212| -#### To apply your changes and effectively switch over the production and development environments: +- To apply your changes and effectively switch over the production and development environments: > [!api] > @@ -317,12 +316,16 @@ This should be the result on the Sunrise Control Panel after updating the front- |---|---| |serviceName|Your Load Balancer service ID| -## Go further +## Conclusion -You now have an infrastructure you can use to simply and efficiently manage `blue-green deployments`{.action}. +You have successfully implemented a highly available infrastructure for managing blue-green deployments. -Developers have access to a development environment on port 8888 (or whichever other port you would prefer to define), while your customers continue to access the service in production via the standard HTTP port (80 in our case, for example). +Developers have access to a development environment on port 8888 (or any configurable non-standard port), while your customers continue to access the service in production via the standard HTTP port (80). The infrastructure presented here is limited to just one port, but it can be expanded by adding other ports. For example, you can also expose your website on the standard HTTPS port (443). You can do this by defining new farms dedicated to each port you want to expose, and associating them with their corresponding front-ends (one for the standard port exposed in production, the second for the arbitrary port dedicated to development). Another way to consolidate your infrastructure even further is by multiplying the servers attached to your farms. This way, you can make your services more redundant (guaranteeing availability as a result), and also add a load balancing capacity. + +## Go further + +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/case_blue_green/guide.en-gb.md b/pages/network/load_balancer/case_blue_green/guide.en-gb.md index 3126cb4f2f5..60c95ac97a0 100644 --- a/pages/network/load_balancer/case_blue_green/guide.en-gb.md +++ b/pages/network/load_balancer/case_blue_green/guide.en-gb.md @@ -1,64 +1,62 @@ --- title: 'Deploying a blue-green infrastructure' -excerpt: 'This guide will show you how to deploy a blue-green infrastructure with the OVH Load Balancer' -updated: 2019-02-25 +excerpt: 'This guide will show you how to deploy a blue-green infrastructure with the OVHcloud Load Balancer' +updated: 2025-10-24 --- ## Objective -With this guide, we will explore a specific use for the OVH Load Balancer service — configuring a service to manage production/development infrastructures easily. This is also called a blue-green infrastructure. +This guide demonstrates a specific use case for the OVHcloud Load Balancer: the configuration of a service to facilitate seamless traffic switching between production and new production candidate environments, also called a **blue-green infrastructure**. -With a `blue-green`{.action} infrastructure, you can stop your infrastructure from experiencing any downtime. The main benefit of this deployment type is that you can prepare updates and/or maintenance in an environment that is isolated from your production environment. This way, you can test your changes before they are put into production, undo them quickly if you detect any faults, and do all of this with virtually zero downtime. +With a blue-green infrastructure, you can stop your infrastructure from experiencing any downtime. The main benefit of this deployment type is that you can prepare updates and/or maintenance in an environment that is isolated from your production environment. This way, you can test your changes before they are put into production, undo them quickly if you detect any faults, and do all of this with virtually zero downtime. -**This guide will show you how to deploy a blue-green infrastructure with the OVH Load Balancer.** +**This guide will show you how to deploy a blue-green infrastructure with the OVHcloud Load Balancer.** ## Requirements -To deploy a `blue-green`{.action} infrastructure, you need the following components: +To deploy a blue-green infrastructure, you need the following components: -- an OVH Load Balancer service -- a first server that hosts your production infrastructure -- a second server with a similar infrastructure, dedicated to development +- An [OVHcloud Load Balancer](/links/network/load-balancer) service +- Access to the [OVHcloud Control Panel](/links/manager) +- Two [dedicated servers](/links/bare-metal/bare-metal), one hosting your production environment, and a similarly configured server hosting your staging environment ## Instructions ### Scenario -The scenario we’ll describe here is as follows... +You have an infrastructure designed to host your live website. -You have an infrastructure that you can use to put your website online. +This environment hosts the website’s code, in addition to all essential applications (web servers, database servers, etc.). You need to update your applications and/or your code on a regular basis. You want to be able to test your updates without impacting the website's availability or functionality for end-users. -This infrastructure hosts your website’s code, and it also hosts the applications (web servers, database servers, etc.) required to put your website online. You need to update your applications and/or your code on a regular basis. You want to be able to test your updates without the risk of affecting your website’s availability to customers, or stopping the website from working properly. +One way to achieve this is by deploying a blue-green infrastructure. -One way to achieve this is by deploying a `blue-green`{.action} infrastructure. +The principle of a blue-green deployment involves being able to switch easily from a development infrastructure to a production infrastructure, and vice versa. This switch must be done in a way that is transparent for your users. To do this, public traffic will be routed to the standard HTTP port 80 for access to the production infrastructure, and a non-standard port, such as 8888, will be used to access the development infrastructure. -The principle of a `blue-green`{.action} deployment involves being able to switch easily from a development infrastructure to a production infrastructure, and vice versa. This switch must be done in a way that is transparent for your users. To do this, we will assign the standard HTTP port 80 for access to the production infrastructure, and the arbitrary port 8888 to access the development infrastructure. +## Deploy the infrastructures -## Deploy the infrastructures. - -In the scenario we are using, your IP Load Balancer service plays a central role. It is the element you use to expose your two infrastructures (production and development) to different users at the same time. +In this scenario, your Load Balancer service plays a central role. It is the element you use to expose your two infrastructures (production and development) to different users at the same time. The production infrastructure can be accessed by your customers on the standard HTTP service (port 80), and your development infrastructure can be accessed by developers and admins on the non-standard port 8888. -During the initial setup phase, we will arbitrarily assign a role to each of the parts of our infrastructure. `Infrastructure A`{.action} will be assigned to production, while `infrastructure B`{.action} will be assigned to development. At this stage, we will consider them to be similar to one another. +During the initial setup phase, roles are provisionally assigned to each infrastructure component. **Infrastructure A** serves as the initial production environment, while **Infrastructure B** serves as the staging environment. At this stage, we will consider them to be similar to one another. -A `blue-green`{.action} infrastructure involves switching from infrastructure A to infrastructure B, when infrastructure B is ready to expose your website after your changes have been applied and tested. The IP Load Balancer will manage this switch. +A blue-green infrastructure involves switching from infrastructure A to infrastructure B, once infrastructure B has been fully updated and validated. The Load Balancer will manage this switch. The diagram below gives a general idea of the architecture: ![General diagram of blue-green architecture](images/scheme.png){.thumbnail} -### Infrastructure A. +### Infrastructure A -This infrastructure is made up of a server farm that will later be associated with a front-end of your IP Load Balancer. This farm will expose an HTTP, TCP or UDP service to the front-end. It also balances loads by sending the front-end’s incoming traffic to the servers. For more detail on the role of various component of the OVH Load Balancer service, you can read the following guide: [Introduction to the OVH Load Balancer](/pages/network/load_balancer/use_presentation). +This infrastructure is made up of a server farm that will later be associated with a front-end of your Load Balancer. This farm will expose an HTTP, TCP or UDP service to the front-end. It also balances loads by sending the front-end’s incoming traffic to the servers. For more details on the role of the various components of the OVHcloud Load Balancer service, please refer to the following guide: [Introduction to the OVHcloud Load Balancer](/pages/network/load_balancer/use_presentation). In our scenario, we will declare a farm of servers for the HTTP service. Please note that you can create as many farms (as well as TCP and/or UDP services) as are required for your final service to be exposed to your customers. -#### Via the OVH Control Panel: +#### Via the OVHcloud Control Panel ![Add a new HTTP farm dedicated to infrastructure A](images/ferme1.png){.thumbnail} -#### Via the API: +#### Via the OVHcloud API > [!api] > @@ -69,7 +67,7 @@ In our scenario, we will declare a farm of servers for the HTTP service. Please |---|---| |serviceName|Your Load Balancer service ID| -With the additional calls listed below, you can list, modify and delete your server farms respectively. +With the additional calls listed below, you can list, modify and delete your server farms respectively: > [!api] > @@ -86,15 +84,15 @@ With the additional calls listed below, you can list, modify and delete your ser > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm > -Associate a server with your farm, if it is a physical server hosting your production infrastructure. The service exposed to the front-end is supplied by the server’s port 8080. Please note that you can associate one or more servers with each farm (to balance the load and/or offer higher fault tolerance, for ex.). +Link a dedicated server to your farm if it hosts your production infrastructure. The service is exposed to the front-end via the server’s port 8080. Note that you may LINK one or more servers with each farm (for example, to balance the load or offer higher fault tolerance). -#### Via the OVH Control Panel: +#### Via the OVHcloud Control Panel ![Add a new server to the farm HTTP A](images/serveur1.png){.thumbnail} ![Enter the HTTP A server’s configuration](images/server1.png){.thumbnail} -#### Via the API: +#### Via the OVHcloud API > [!api] > @@ -109,7 +107,7 @@ Associate a server with your farm, if it is a physical server hosting your produ |displayName||The name of the server associated with your farm|HTTP A server| |port||The server port associated with your farm|8080| -With the additional calls listed below, you can list, modify and delete your servers respectively. +With the additional calls listed below, you can list, modify and delete your servers respectively: > [!api] > @@ -126,19 +124,19 @@ With the additional calls listed below, you can list, modify and delete your ser > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server > -### Infrastructure B. +### Infrastructure B -Functionally, this second infrastructure is identical to the first. It is also composed of a server farm that will later be associated with a second front-end of your IP Load Balancer. This server farm exposes the same service to the front-end as the first server farm. This service is supplied on the servers by port 8080. +Functionally, this second infrastructure is identical to the first. It is also composed of a server farm that will later be associated with a second front-end of your Load Balancer. This server farm exposes the same service to the front-end as the first server farm. This service is supplied on the servers by port 8080. Deploy the server farm for the HTTP service (and/or any other TCP or UDP services required for your final service to be exposed to your customers). -#### Via the Sunrise Control Panel: +#### Via the OVHcloud Control Panel ![Add a new HTTP farm dedicated to infrastructure B](images/ferme2.png){.thumbnail} ![Create a second farm dedicated to infrastructure B](images/backend2.png){.thumbnail} -#### Via the API: +#### Via the OVHcloud API > [!api] > @@ -151,13 +149,13 @@ Deploy the server farm for the HTTP service (and/or any other TCP or UDP service Associate a server with your farm. Here, it involves one or more physical servers hosting your development infrastructure. -#### Via the OVH Control Panel: +#### Via the OVHcloud Control Panel ![Add a new server to the farm HTTP B](images/serveur2.png){.thumbnail} ![Enter the HTTP B server’s configuration](images/server2.png){.thumbnail} -#### Via the API: +#### Via the OVHcloud API > [!api] > @@ -176,9 +174,9 @@ At this stage, here is the configuration status for your two farms: ![Farm configuration](images/farms.png){.thumbnail} -## Front-ends. +## Front-ends -The magic of `blue-green`{.action} deployment lies in the configuration of your front-ends. At this stage, we have configure two functionally identical infrastructures. For both infrastructures, you have declared one or more server farms, each with their own set of associated servers. +The magic of blue-green deployment lies in the configuration of your front-ends. At this stage, we have configured two functionally identical infrastructures. For both infrastructures, you have declared one or more server farms, each with their own set of associated servers. To switch simply from one infrastructure to another, we will use front-ends. @@ -186,19 +184,20 @@ To do this, we need to declare two front-ends. The first one will give you acces > [!warning] > -> If the final service you expose to your customers requires several server farms (e.g. ports 80 and 443), you will need to declare a `front-end`{.action} for each of your farms. +> If the final service you expose to your customers requires several server farms (e.g. ports 80 and 443), you will need to declare a **front-end** for each of your farms. > -### Blue front-end. -This `front-end`{.action} is dedicated to accessing the production infrastructure. The ports exposed to your customers are the standard ports for accessing the service. In this case, we are exposing a HTTP service, so we will use port 80 (443 if you would like an SSL termination). +### Blue front-end + +This **front-end** is dedicated to accessing the production infrastructure. The ports exposed to your customers are the standard ports for accessing the service. In this case, we are exposing an HTTP service, so we will use port 80 (443 if you would like an SSL termination). -#### Via the OVH Control Panel: +#### Via the OVHcloud Control Panel ![Adding a front-end dedicated to production, a blue front-end](images/frontend1.png){.thumbnail} ![Enter the blue front-end’s configuration](images/fblue.png){.thumbnail} -#### Via the API: +#### Via the OVHcloud API > [!api] > @@ -213,17 +212,17 @@ This `front-end`{.action} is dedicated to accessing the production infrastructur |port|Required|The port exposed to your customers by your front-end|80| |zone|Required|The zone in which you want to deploy your front-end|all| -### Green front-end. +### Green front-end -This `front-end`{.action} is dedicated to accessing the development infrastructure. The ports exposed to your customers will be non-standard ports that you can choose arbitrarily. In this case, we will expose the HTTP development service on port 8888. +This **front-end** is dedicated to accessing the development infrastructure. The ports exposed to your customers will be non-standard ports that you can choose arbitrarily. In this case, we will expose the HTTP development service on port 8888. -#### Via the OVH Control Panel: +#### Via the OVHcloud Control Panel ![Add the green front-end, dedicated to development](images/frontend2.png){.thumbnail} ![Enter the green front-end’s configuration](images/fgreen.png){.thumbnail} -#### Via the API: +#### Via the OVHcloud API > [!api] > @@ -238,17 +237,17 @@ This `front-end`{.action} is dedicated to accessing the development infrastructu |port|Required|The port exposed to your customers by your front-end|8888| |zone|Required|The zone in which you want to deploy your front-end|all| -## Manage the deployments. +## Manage the deployments -### Initial deployment. +### Initial deployment -Once you have finished configuring the components of the OVH Load Balancer service, you now just need to apply your changes. +Once you have finished configuring the components of the OVHcloud Load Balancer service, the only thing left to do is apply your changes. -#### Via the OVH Control Panel: +#### Via the OVHcloud Control Panel ![Apply your changes to the zone](images/deploy.png){.thumbnail} -#### Via the API: +#### Via the OVHcloud API > [!api] > @@ -259,30 +258,30 @@ Once you have finished configuring the components of the OVH Load Balancer servi |---|---| |serviceName|Your Load Balancer service ID| -### The production/pre-production switch. +### The production/staging switch -At this stage, our initial environment is deployed and ready to use. How do we use it? - -To put it simply, you just need to switch over your front-ends from one server farm to another. +At this stage, our initial environment is deployed and ready to use. Now, you need to switch over your front-ends from one server farm to another. Let’s take a look at our scenario: -- The production infrastructure (A) is deployed on `HTTP farm A`{.action} (id 77212), which in turn is attached to `HTTP server A`{.action}. This infrastructure can be accessed through the `blue front-end`{.action}. -- The development infrastructure (B) is deployed on `HTTP farm B`{.action} (id 77213), which in turn is attached to `HTTP server B`{.action}. This infrastructure can be accessed through the `green front-end`{.action}. +- The production infrastructure (A) is deployed on **HTTP farm A** (id 77212), which in turn is attached to **HTTP server A**. This infrastructure can be accessed through the **blue front-end**. +- The development infrastructure (B) is deployed on **HTTP farm B** (id 77213), which in turn is attached to **HTTP server B**. This infrastructure can be accessed through the **green front-end**. -Once you have modified/applied updates to `infrastructure B`{.action} and checked that the service is working properly, you decide to put it into production. +Once you have modified/applied updates to **infrastructure B** and checked that the service is working properly, you can decide to put it into production. To switch between the two farms, you can simply update your different front-ends by modifying the ID of the farm it is attached to, and applying the modification. -The `blue front-end`{.action} (id 70089) will then be associated with `Farm B`{.action} (infrastructure B, new production, id 77213). +The **blue front-end** (id 70089) will then be associated with **Farm B** (infrastructure B, new production, id 77213). -The `green front-end`{.action} (id 70090) will then be associated with `Farm A`{.action} (infrastructure A, new development, id 77212). +The **green front-end** (id 70090) will then be associated with **Farm A** (infrastructure A, new development, id 77212). -This should be the result on the Sunrise Control Panel after updating the front-ends and applying the new configuration: +This should be the result on the OVHcloud Control Panel after updating the front-ends and applying the new configuration: ![Result after updating front-ends](images/switch.png){.thumbnail} -#### Via the API: updating front-ends and applying modifications#### +#### Via the OVHcloud API + +- Updating front-ends and applying modifications: > [!api] > @@ -306,7 +305,7 @@ This should be the result on the Sunrise Control Panel after updating the front- |frontendId|Your production front-end ID|70090| |defaultFarmId|Your development server farm ID|77212| -#### To apply your changes and effectively switch over the production and development environments: +- To apply your changes and effectively switch over the production and development environments: > [!api] > @@ -317,12 +316,16 @@ This should be the result on the Sunrise Control Panel after updating the front- |---|---| |serviceName|Your Load Balancer service ID| -## Go further +## Conclusion -You now have an infrastructure you can use to simply and efficiently manage `blue-green deployments`{.action}. +You have successfully implemented a highly available infrastructure for managing blue-green deployments. -Developers have access to a development environment on port 8888 (or whichever other port you would prefer to define), while your customers continue to access the service in production via the standard HTTP port (80 in our case, for example). +Developers have access to a development environment on port 8888 (or any configurable non-standard port), while your customers continue to access the service in production via the standard HTTP port (80). The infrastructure presented here is limited to just one port, but it can be expanded by adding other ports. For example, you can also expose your website on the standard HTTPS port (443). You can do this by defining new farms dedicated to each port you want to expose, and associating them with their corresponding front-ends (one for the standard port exposed in production, the second for the arbitrary port dedicated to development). Another way to consolidate your infrastructure even further is by multiplying the servers attached to your farms. This way, you can make your services more redundant (guaranteeing availability as a result), and also add a load balancing capacity. + +## Go further + +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/case_blue_green/guide.en-sg.md b/pages/network/load_balancer/case_blue_green/guide.en-sg.md index de705cecacc..60c95ac97a0 100644 --- a/pages/network/load_balancer/case_blue_green/guide.en-sg.md +++ b/pages/network/load_balancer/case_blue_green/guide.en-sg.md @@ -1,64 +1,62 @@ --- title: 'Deploying a blue-green infrastructure' excerpt: 'This guide will show you how to deploy a blue-green infrastructure with the OVHcloud Load Balancer' -updated: 2019-02-25 +updated: 2025-10-24 --- ## Objective -With this guide, we will explore a specific use for the OVHcloud Load Balancer service — configuring a service to manage production/development infrastructures easily. This is also called a blue-green infrastructure. +This guide demonstrates a specific use case for the OVHcloud Load Balancer: the configuration of a service to facilitate seamless traffic switching between production and new production candidate environments, also called a **blue-green infrastructure**. -With a `blue-green`{.action} infrastructure, you can stop your infrastructure from experiencing any downtime. The main benefit of this deployment type is that you can prepare updates and/or maintenance in an environment that is isolated from your production environment. This way, you can test your changes before they are put into production, undo them quickly if you detect any faults, and do all of this with virtually zero downtime. +With a blue-green infrastructure, you can stop your infrastructure from experiencing any downtime. The main benefit of this deployment type is that you can prepare updates and/or maintenance in an environment that is isolated from your production environment. This way, you can test your changes before they are put into production, undo them quickly if you detect any faults, and do all of this with virtually zero downtime. **This guide will show you how to deploy a blue-green infrastructure with the OVHcloud Load Balancer.** ## Requirements -To deploy a `blue-green`{.action} infrastructure, you need the following components: +To deploy a blue-green infrastructure, you need the following components: -- an OVHcloud Load Balancer service -- a first server that hosts your production infrastructure -- a second server with a similar infrastructure, dedicated to development +- An [OVHcloud Load Balancer](/links/network/load-balancer) service +- Access to the [OVHcloud Control Panel](/links/manager) +- Two [dedicated servers](/links/bare-metal/bare-metal), one hosting your production environment, and a similarly configured server hosting your staging environment ## Instructions ### Scenario -The scenario we’ll describe here is as follows... +You have an infrastructure designed to host your live website. -You have an infrastructure that you can use to put your website online. +This environment hosts the website’s code, in addition to all essential applications (web servers, database servers, etc.). You need to update your applications and/or your code on a regular basis. You want to be able to test your updates without impacting the website's availability or functionality for end-users. -This infrastructure hosts your website’s code, and it also hosts the applications (web servers, database servers, etc.) required to put your website online. You need to update your applications and/or your code on a regular basis. You want to be able to test your updates without the risk of affecting your website’s availability to customers, or stopping the website from working properly. +One way to achieve this is by deploying a blue-green infrastructure. -One way to achieve this is by deploying a `blue-green`{.action} infrastructure. +The principle of a blue-green deployment involves being able to switch easily from a development infrastructure to a production infrastructure, and vice versa. This switch must be done in a way that is transparent for your users. To do this, public traffic will be routed to the standard HTTP port 80 for access to the production infrastructure, and a non-standard port, such as 8888, will be used to access the development infrastructure. -The principle of a `blue-green`{.action} deployment involves being able to switch easily from a development infrastructure to a production infrastructure, and vice versa. This switch must be done in a way that is transparent for your users. To do this, we will assign the standard HTTP port 80 for access to the production infrastructure, and the arbitrary port 8888 to access the development infrastructure. +## Deploy the infrastructures -## Deploy the infrastructures. - -In the scenario we are using, your IP Load Balancer service plays a central role. It is the element you use to expose your two infrastructures (production and development) to different users at the same time. +In this scenario, your Load Balancer service plays a central role. It is the element you use to expose your two infrastructures (production and development) to different users at the same time. The production infrastructure can be accessed by your customers on the standard HTTP service (port 80), and your development infrastructure can be accessed by developers and admins on the non-standard port 8888. -During the initial setup phase, we will arbitrarily assign a role to each of the parts of our infrastructure. `Infrastructure A`{.action} will be assigned to production, while `infrastructure B`{.action} will be assigned to development. At this stage, we will consider them to be similar to one another. +During the initial setup phase, roles are provisionally assigned to each infrastructure component. **Infrastructure A** serves as the initial production environment, while **Infrastructure B** serves as the staging environment. At this stage, we will consider them to be similar to one another. -A `blue-green`{.action} infrastructure involves switching from infrastructure A to infrastructure B, when infrastructure B is ready to expose your website after your changes have been applied and tested. The IP Load Balancer will manage this switch. +A blue-green infrastructure involves switching from infrastructure A to infrastructure B, once infrastructure B has been fully updated and validated. The Load Balancer will manage this switch. The diagram below gives a general idea of the architecture: ![General diagram of blue-green architecture](images/scheme.png){.thumbnail} -### Infrastructure A. +### Infrastructure A -This infrastructure is made up of a server farm that will later be associated with a front-end of your IP Load Balancer. This farm will expose an HTTP, TCP or UDP service to the front-end. It also balances loads by sending the front-end’s incoming traffic to the servers. For more detail on the role of various component of the OVHcloud Load Balancer service, you can read the following guide: [Introduction to the OVHcloud Load Balancer](/pages/network/load_balancer/use_presentation){.ref}. +This infrastructure is made up of a server farm that will later be associated with a front-end of your Load Balancer. This farm will expose an HTTP, TCP or UDP service to the front-end. It also balances loads by sending the front-end’s incoming traffic to the servers. For more details on the role of the various components of the OVHcloud Load Balancer service, please refer to the following guide: [Introduction to the OVHcloud Load Balancer](/pages/network/load_balancer/use_presentation). In our scenario, we will declare a farm of servers for the HTTP service. Please note that you can create as many farms (as well as TCP and/or UDP services) as are required for your final service to be exposed to your customers. -#### Via the OVHcloud Control Panel: +#### Via the OVHcloud Control Panel ![Add a new HTTP farm dedicated to infrastructure A](images/ferme1.png){.thumbnail} -#### Via the API: +#### Via the OVHcloud API > [!api] > @@ -69,7 +67,7 @@ In our scenario, we will declare a farm of servers for the HTTP service. Please |---|---| |serviceName|Your Load Balancer service ID| -With the additional calls listed below, you can list, modify and delete your server farms respectively. +With the additional calls listed below, you can list, modify and delete your server farms respectively: > [!api] > @@ -86,15 +84,15 @@ With the additional calls listed below, you can list, modify and delete your ser > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm > -Associate a server with your farm, if it is a physical server hosting your production infrastructure. The service exposed to the front-end is supplied by the server’s port 8080. Please note that you can associate one or more servers with each farm (to balance the load and/or offer higher fault tolerance, for ex.). +Link a dedicated server to your farm if it hosts your production infrastructure. The service is exposed to the front-end via the server’s port 8080. Note that you may LINK one or more servers with each farm (for example, to balance the load or offer higher fault tolerance). -#### Via the OVHcloud Control Panel: +#### Via the OVHcloud Control Panel ![Add a new server to the farm HTTP A](images/serveur1.png){.thumbnail} ![Enter the HTTP A server’s configuration](images/server1.png){.thumbnail} -#### Via the API: +#### Via the OVHcloud API > [!api] > @@ -109,7 +107,7 @@ Associate a server with your farm, if it is a physical server hosting your produ |displayName||The name of the server associated with your farm|HTTP A server| |port||The server port associated with your farm|8080| -With the additional calls listed below, you can list, modify and delete your servers respectively. +With the additional calls listed below, you can list, modify and delete your servers respectively: > [!api] > @@ -126,19 +124,19 @@ With the additional calls listed below, you can list, modify and delete your ser > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server > -### Infrastructure B. +### Infrastructure B -Functionally, this second infrastructure is identical to the first. It is also composed of a server farm that will later be associated with a second front-end of your IP Load Balancer. This server farm exposes the same service to the front-end as the first server farm. This service is supplied on the servers by port 8080. +Functionally, this second infrastructure is identical to the first. It is also composed of a server farm that will later be associated with a second front-end of your Load Balancer. This server farm exposes the same service to the front-end as the first server farm. This service is supplied on the servers by port 8080. Deploy the server farm for the HTTP service (and/or any other TCP or UDP services required for your final service to be exposed to your customers). -#### Via the Sunrise Control Panel: +#### Via the OVHcloud Control Panel ![Add a new HTTP farm dedicated to infrastructure B](images/ferme2.png){.thumbnail} ![Create a second farm dedicated to infrastructure B](images/backend2.png){.thumbnail} -#### Via the API: +#### Via the OVHcloud API > [!api] > @@ -151,13 +149,13 @@ Deploy the server farm for the HTTP service (and/or any other TCP or UDP service Associate a server with your farm. Here, it involves one or more physical servers hosting your development infrastructure. -#### Via the OVHcloud Control Panel: +#### Via the OVHcloud Control Panel ![Add a new server to the farm HTTP B](images/serveur2.png){.thumbnail} ![Enter the HTTP B server’s configuration](images/server2.png){.thumbnail} -#### Via the API: +#### Via the OVHcloud API > [!api] > @@ -176,9 +174,9 @@ At this stage, here is the configuration status for your two farms: ![Farm configuration](images/farms.png){.thumbnail} -## Front-ends. +## Front-ends -The magic of `blue-green`{.action} deployment lies in the configuration of your front-ends. At this stage, we have configure two functionally identical infrastructures. For both infrastructures, you have declared one or more server farms, each with their own set of associated servers. +The magic of blue-green deployment lies in the configuration of your front-ends. At this stage, we have configured two functionally identical infrastructures. For both infrastructures, you have declared one or more server farms, each with their own set of associated servers. To switch simply from one infrastructure to another, we will use front-ends. @@ -186,19 +184,20 @@ To do this, we need to declare two front-ends. The first one will give you acces > [!warning] > -> If the final service you expose to your customers requires several server farms (e.g. ports 80 and 443), you will need to declare a `front-end`{.action} for each of your farms. +> If the final service you expose to your customers requires several server farms (e.g. ports 80 and 443), you will need to declare a **front-end** for each of your farms. > -### Blue front-end. -This `front-end`{.action} is dedicated to accessing the production infrastructure. The ports exposed to your customers are the standard ports for accessing the service. In this case, we are exposing a HTTP service, so we will use port 80 (443 if you would like an SSL termination). +### Blue front-end + +This **front-end** is dedicated to accessing the production infrastructure. The ports exposed to your customers are the standard ports for accessing the service. In this case, we are exposing an HTTP service, so we will use port 80 (443 if you would like an SSL termination). -#### Via the OVHcloud Control Panel: +#### Via the OVHcloud Control Panel ![Adding a front-end dedicated to production, a blue front-end](images/frontend1.png){.thumbnail} ![Enter the blue front-end’s configuration](images/fblue.png){.thumbnail} -#### Via the API: +#### Via the OVHcloud API > [!api] > @@ -213,17 +212,17 @@ This `front-end`{.action} is dedicated to accessing the production infrastructur |port|Required|The port exposed to your customers by your front-end|80| |zone|Required|The zone in which you want to deploy your front-end|all| -### Green front-end. +### Green front-end -This `front-end`{.action} is dedicated to accessing the development infrastructure. The ports exposed to your customers will be non-standard ports that you can choose arbitrarily. In this case, we will expose the HTTP development service on port 8888. +This **front-end** is dedicated to accessing the development infrastructure. The ports exposed to your customers will be non-standard ports that you can choose arbitrarily. In this case, we will expose the HTTP development service on port 8888. -#### Via the OVHcloud Control Panel: +#### Via the OVHcloud Control Panel ![Add the green front-end, dedicated to development](images/frontend2.png){.thumbnail} ![Enter the green front-end’s configuration](images/fgreen.png){.thumbnail} -#### Via the API: +#### Via the OVHcloud API > [!api] > @@ -238,17 +237,17 @@ This `front-end`{.action} is dedicated to accessing the development infrastructu |port|Required|The port exposed to your customers by your front-end|8888| |zone|Required|The zone in which you want to deploy your front-end|all| -## Manage the deployments. +## Manage the deployments -### Initial deployment. +### Initial deployment -Once you have finished configuring the components of the OVHcloud Load Balancer service, you now just need to apply your changes. +Once you have finished configuring the components of the OVHcloud Load Balancer service, the only thing left to do is apply your changes. -#### Via the OVHcloud Control Panel: +#### Via the OVHcloud Control Panel ![Apply your changes to the zone](images/deploy.png){.thumbnail} -#### Via the API: +#### Via the OVHcloud API > [!api] > @@ -259,30 +258,30 @@ Once you have finished configuring the components of the OVHcloud Load Balancer |---|---| |serviceName|Your Load Balancer service ID| -### The production/pre-production switch. +### The production/staging switch -At this stage, our initial environment is deployed and ready to use. How do we use it? - -To put it simply, you just need to switch over your front-ends from one server farm to another. +At this stage, our initial environment is deployed and ready to use. Now, you need to switch over your front-ends from one server farm to another. Let’s take a look at our scenario: -- The production infrastructure (A) is deployed on `HTTP farm A`{.action} (id 77212), which in turn is attached to `HTTP server A`{.action}. This infrastructure can be accessed through the `blue front-end`{.action}. -- The development infrastructure (B) is deployed on `HTTP farm B`{.action} (id 77213), which in turn is attached to `HTTP server B`{.action}. This infrastructure can be accessed through the `green front-end`{.action}. +- The production infrastructure (A) is deployed on **HTTP farm A** (id 77212), which in turn is attached to **HTTP server A**. This infrastructure can be accessed through the **blue front-end**. +- The development infrastructure (B) is deployed on **HTTP farm B** (id 77213), which in turn is attached to **HTTP server B**. This infrastructure can be accessed through the **green front-end**. -Once you have modified/applied updates to `infrastructure B`{.action} and checked that the service is working properly, you decide to put it into production. +Once you have modified/applied updates to **infrastructure B** and checked that the service is working properly, you can decide to put it into production. To switch between the two farms, you can simply update your different front-ends by modifying the ID of the farm it is attached to, and applying the modification. -The `blue front-end`{.action} (id 70089) will then be associated with `Farm B`{.action} (infrastructure B, new production, id 77213). +The **blue front-end** (id 70089) will then be associated with **Farm B** (infrastructure B, new production, id 77213). -The `green front-end`{.action} (id 70090) will then be associated with `Farm A`{.action} (infrastructure A, new development, id 77212). +The **green front-end** (id 70090) will then be associated with **Farm A** (infrastructure A, new development, id 77212). -This should be the result on the Sunrise Control Panel after updating the front-ends and applying the new configuration: +This should be the result on the OVHcloud Control Panel after updating the front-ends and applying the new configuration: ![Result after updating front-ends](images/switch.png){.thumbnail} -#### Via the API: updating front-ends and applying modifications#### +#### Via the OVHcloud API + +- Updating front-ends and applying modifications: > [!api] > @@ -306,7 +305,7 @@ This should be the result on the Sunrise Control Panel after updating the front- |frontendId|Your production front-end ID|70090| |defaultFarmId|Your development server farm ID|77212| -#### To apply your changes and effectively switch over the production and development environments: +- To apply your changes and effectively switch over the production and development environments: > [!api] > @@ -317,12 +316,16 @@ This should be the result on the Sunrise Control Panel after updating the front- |---|---| |serviceName|Your Load Balancer service ID| -## Go further +## Conclusion -You now have an infrastructure you can use to simply and efficiently manage `blue-green deployments`{.action}. +You have successfully implemented a highly available infrastructure for managing blue-green deployments. -Developers have access to a development environment on port 8888 (or whichever other port you would prefer to define), while your customers continue to access the service in production via the standard HTTP port (80 in our case, for example). +Developers have access to a development environment on port 8888 (or any configurable non-standard port), while your customers continue to access the service in production via the standard HTTP port (80). The infrastructure presented here is limited to just one port, but it can be expanded by adding other ports. For example, you can also expose your website on the standard HTTPS port (443). You can do this by defining new farms dedicated to each port you want to expose, and associating them with their corresponding front-ends (one for the standard port exposed in production, the second for the arbitrary port dedicated to development). Another way to consolidate your infrastructure even further is by multiplying the servers attached to your farms. This way, you can make your services more redundant (guaranteeing availability as a result), and also add a load balancing capacity. + +## Go further + +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/case_blue_green/guide.en-us.md b/pages/network/load_balancer/case_blue_green/guide.en-us.md index de705cecacc..60c95ac97a0 100644 --- a/pages/network/load_balancer/case_blue_green/guide.en-us.md +++ b/pages/network/load_balancer/case_blue_green/guide.en-us.md @@ -1,64 +1,62 @@ --- title: 'Deploying a blue-green infrastructure' excerpt: 'This guide will show you how to deploy a blue-green infrastructure with the OVHcloud Load Balancer' -updated: 2019-02-25 +updated: 2025-10-24 --- ## Objective -With this guide, we will explore a specific use for the OVHcloud Load Balancer service — configuring a service to manage production/development infrastructures easily. This is also called a blue-green infrastructure. +This guide demonstrates a specific use case for the OVHcloud Load Balancer: the configuration of a service to facilitate seamless traffic switching between production and new production candidate environments, also called a **blue-green infrastructure**. -With a `blue-green`{.action} infrastructure, you can stop your infrastructure from experiencing any downtime. The main benefit of this deployment type is that you can prepare updates and/or maintenance in an environment that is isolated from your production environment. This way, you can test your changes before they are put into production, undo them quickly if you detect any faults, and do all of this with virtually zero downtime. +With a blue-green infrastructure, you can stop your infrastructure from experiencing any downtime. The main benefit of this deployment type is that you can prepare updates and/or maintenance in an environment that is isolated from your production environment. This way, you can test your changes before they are put into production, undo them quickly if you detect any faults, and do all of this with virtually zero downtime. **This guide will show you how to deploy a blue-green infrastructure with the OVHcloud Load Balancer.** ## Requirements -To deploy a `blue-green`{.action} infrastructure, you need the following components: +To deploy a blue-green infrastructure, you need the following components: -- an OVHcloud Load Balancer service -- a first server that hosts your production infrastructure -- a second server with a similar infrastructure, dedicated to development +- An [OVHcloud Load Balancer](/links/network/load-balancer) service +- Access to the [OVHcloud Control Panel](/links/manager) +- Two [dedicated servers](/links/bare-metal/bare-metal), one hosting your production environment, and a similarly configured server hosting your staging environment ## Instructions ### Scenario -The scenario we’ll describe here is as follows... +You have an infrastructure designed to host your live website. -You have an infrastructure that you can use to put your website online. +This environment hosts the website’s code, in addition to all essential applications (web servers, database servers, etc.). You need to update your applications and/or your code on a regular basis. You want to be able to test your updates without impacting the website's availability or functionality for end-users. -This infrastructure hosts your website’s code, and it also hosts the applications (web servers, database servers, etc.) required to put your website online. You need to update your applications and/or your code on a regular basis. You want to be able to test your updates without the risk of affecting your website’s availability to customers, or stopping the website from working properly. +One way to achieve this is by deploying a blue-green infrastructure. -One way to achieve this is by deploying a `blue-green`{.action} infrastructure. +The principle of a blue-green deployment involves being able to switch easily from a development infrastructure to a production infrastructure, and vice versa. This switch must be done in a way that is transparent for your users. To do this, public traffic will be routed to the standard HTTP port 80 for access to the production infrastructure, and a non-standard port, such as 8888, will be used to access the development infrastructure. -The principle of a `blue-green`{.action} deployment involves being able to switch easily from a development infrastructure to a production infrastructure, and vice versa. This switch must be done in a way that is transparent for your users. To do this, we will assign the standard HTTP port 80 for access to the production infrastructure, and the arbitrary port 8888 to access the development infrastructure. +## Deploy the infrastructures -## Deploy the infrastructures. - -In the scenario we are using, your IP Load Balancer service plays a central role. It is the element you use to expose your two infrastructures (production and development) to different users at the same time. +In this scenario, your Load Balancer service plays a central role. It is the element you use to expose your two infrastructures (production and development) to different users at the same time. The production infrastructure can be accessed by your customers on the standard HTTP service (port 80), and your development infrastructure can be accessed by developers and admins on the non-standard port 8888. -During the initial setup phase, we will arbitrarily assign a role to each of the parts of our infrastructure. `Infrastructure A`{.action} will be assigned to production, while `infrastructure B`{.action} will be assigned to development. At this stage, we will consider them to be similar to one another. +During the initial setup phase, roles are provisionally assigned to each infrastructure component. **Infrastructure A** serves as the initial production environment, while **Infrastructure B** serves as the staging environment. At this stage, we will consider them to be similar to one another. -A `blue-green`{.action} infrastructure involves switching from infrastructure A to infrastructure B, when infrastructure B is ready to expose your website after your changes have been applied and tested. The IP Load Balancer will manage this switch. +A blue-green infrastructure involves switching from infrastructure A to infrastructure B, once infrastructure B has been fully updated and validated. The Load Balancer will manage this switch. The diagram below gives a general idea of the architecture: ![General diagram of blue-green architecture](images/scheme.png){.thumbnail} -### Infrastructure A. +### Infrastructure A -This infrastructure is made up of a server farm that will later be associated with a front-end of your IP Load Balancer. This farm will expose an HTTP, TCP or UDP service to the front-end. It also balances loads by sending the front-end’s incoming traffic to the servers. For more detail on the role of various component of the OVHcloud Load Balancer service, you can read the following guide: [Introduction to the OVHcloud Load Balancer](/pages/network/load_balancer/use_presentation){.ref}. +This infrastructure is made up of a server farm that will later be associated with a front-end of your Load Balancer. This farm will expose an HTTP, TCP or UDP service to the front-end. It also balances loads by sending the front-end’s incoming traffic to the servers. For more details on the role of the various components of the OVHcloud Load Balancer service, please refer to the following guide: [Introduction to the OVHcloud Load Balancer](/pages/network/load_balancer/use_presentation). In our scenario, we will declare a farm of servers for the HTTP service. Please note that you can create as many farms (as well as TCP and/or UDP services) as are required for your final service to be exposed to your customers. -#### Via the OVHcloud Control Panel: +#### Via the OVHcloud Control Panel ![Add a new HTTP farm dedicated to infrastructure A](images/ferme1.png){.thumbnail} -#### Via the API: +#### Via the OVHcloud API > [!api] > @@ -69,7 +67,7 @@ In our scenario, we will declare a farm of servers for the HTTP service. Please |---|---| |serviceName|Your Load Balancer service ID| -With the additional calls listed below, you can list, modify and delete your server farms respectively. +With the additional calls listed below, you can list, modify and delete your server farms respectively: > [!api] > @@ -86,15 +84,15 @@ With the additional calls listed below, you can list, modify and delete your ser > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm > -Associate a server with your farm, if it is a physical server hosting your production infrastructure. The service exposed to the front-end is supplied by the server’s port 8080. Please note that you can associate one or more servers with each farm (to balance the load and/or offer higher fault tolerance, for ex.). +Link a dedicated server to your farm if it hosts your production infrastructure. The service is exposed to the front-end via the server’s port 8080. Note that you may LINK one or more servers with each farm (for example, to balance the load or offer higher fault tolerance). -#### Via the OVHcloud Control Panel: +#### Via the OVHcloud Control Panel ![Add a new server to the farm HTTP A](images/serveur1.png){.thumbnail} ![Enter the HTTP A server’s configuration](images/server1.png){.thumbnail} -#### Via the API: +#### Via the OVHcloud API > [!api] > @@ -109,7 +107,7 @@ Associate a server with your farm, if it is a physical server hosting your produ |displayName||The name of the server associated with your farm|HTTP A server| |port||The server port associated with your farm|8080| -With the additional calls listed below, you can list, modify and delete your servers respectively. +With the additional calls listed below, you can list, modify and delete your servers respectively: > [!api] > @@ -126,19 +124,19 @@ With the additional calls listed below, you can list, modify and delete your ser > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server > -### Infrastructure B. +### Infrastructure B -Functionally, this second infrastructure is identical to the first. It is also composed of a server farm that will later be associated with a second front-end of your IP Load Balancer. This server farm exposes the same service to the front-end as the first server farm. This service is supplied on the servers by port 8080. +Functionally, this second infrastructure is identical to the first. It is also composed of a server farm that will later be associated with a second front-end of your Load Balancer. This server farm exposes the same service to the front-end as the first server farm. This service is supplied on the servers by port 8080. Deploy the server farm for the HTTP service (and/or any other TCP or UDP services required for your final service to be exposed to your customers). -#### Via the Sunrise Control Panel: +#### Via the OVHcloud Control Panel ![Add a new HTTP farm dedicated to infrastructure B](images/ferme2.png){.thumbnail} ![Create a second farm dedicated to infrastructure B](images/backend2.png){.thumbnail} -#### Via the API: +#### Via the OVHcloud API > [!api] > @@ -151,13 +149,13 @@ Deploy the server farm for the HTTP service (and/or any other TCP or UDP service Associate a server with your farm. Here, it involves one or more physical servers hosting your development infrastructure. -#### Via the OVHcloud Control Panel: +#### Via the OVHcloud Control Panel ![Add a new server to the farm HTTP B](images/serveur2.png){.thumbnail} ![Enter the HTTP B server’s configuration](images/server2.png){.thumbnail} -#### Via the API: +#### Via the OVHcloud API > [!api] > @@ -176,9 +174,9 @@ At this stage, here is the configuration status for your two farms: ![Farm configuration](images/farms.png){.thumbnail} -## Front-ends. +## Front-ends -The magic of `blue-green`{.action} deployment lies in the configuration of your front-ends. At this stage, we have configure two functionally identical infrastructures. For both infrastructures, you have declared one or more server farms, each with their own set of associated servers. +The magic of blue-green deployment lies in the configuration of your front-ends. At this stage, we have configured two functionally identical infrastructures. For both infrastructures, you have declared one or more server farms, each with their own set of associated servers. To switch simply from one infrastructure to another, we will use front-ends. @@ -186,19 +184,20 @@ To do this, we need to declare two front-ends. The first one will give you acces > [!warning] > -> If the final service you expose to your customers requires several server farms (e.g. ports 80 and 443), you will need to declare a `front-end`{.action} for each of your farms. +> If the final service you expose to your customers requires several server farms (e.g. ports 80 and 443), you will need to declare a **front-end** for each of your farms. > -### Blue front-end. -This `front-end`{.action} is dedicated to accessing the production infrastructure. The ports exposed to your customers are the standard ports for accessing the service. In this case, we are exposing a HTTP service, so we will use port 80 (443 if you would like an SSL termination). +### Blue front-end + +This **front-end** is dedicated to accessing the production infrastructure. The ports exposed to your customers are the standard ports for accessing the service. In this case, we are exposing an HTTP service, so we will use port 80 (443 if you would like an SSL termination). -#### Via the OVHcloud Control Panel: +#### Via the OVHcloud Control Panel ![Adding a front-end dedicated to production, a blue front-end](images/frontend1.png){.thumbnail} ![Enter the blue front-end’s configuration](images/fblue.png){.thumbnail} -#### Via the API: +#### Via the OVHcloud API > [!api] > @@ -213,17 +212,17 @@ This `front-end`{.action} is dedicated to accessing the production infrastructur |port|Required|The port exposed to your customers by your front-end|80| |zone|Required|The zone in which you want to deploy your front-end|all| -### Green front-end. +### Green front-end -This `front-end`{.action} is dedicated to accessing the development infrastructure. The ports exposed to your customers will be non-standard ports that you can choose arbitrarily. In this case, we will expose the HTTP development service on port 8888. +This **front-end** is dedicated to accessing the development infrastructure. The ports exposed to your customers will be non-standard ports that you can choose arbitrarily. In this case, we will expose the HTTP development service on port 8888. -#### Via the OVHcloud Control Panel: +#### Via the OVHcloud Control Panel ![Add the green front-end, dedicated to development](images/frontend2.png){.thumbnail} ![Enter the green front-end’s configuration](images/fgreen.png){.thumbnail} -#### Via the API: +#### Via the OVHcloud API > [!api] > @@ -238,17 +237,17 @@ This `front-end`{.action} is dedicated to accessing the development infrastructu |port|Required|The port exposed to your customers by your front-end|8888| |zone|Required|The zone in which you want to deploy your front-end|all| -## Manage the deployments. +## Manage the deployments -### Initial deployment. +### Initial deployment -Once you have finished configuring the components of the OVHcloud Load Balancer service, you now just need to apply your changes. +Once you have finished configuring the components of the OVHcloud Load Balancer service, the only thing left to do is apply your changes. -#### Via the OVHcloud Control Panel: +#### Via the OVHcloud Control Panel ![Apply your changes to the zone](images/deploy.png){.thumbnail} -#### Via the API: +#### Via the OVHcloud API > [!api] > @@ -259,30 +258,30 @@ Once you have finished configuring the components of the OVHcloud Load Balancer |---|---| |serviceName|Your Load Balancer service ID| -### The production/pre-production switch. +### The production/staging switch -At this stage, our initial environment is deployed and ready to use. How do we use it? - -To put it simply, you just need to switch over your front-ends from one server farm to another. +At this stage, our initial environment is deployed and ready to use. Now, you need to switch over your front-ends from one server farm to another. Let’s take a look at our scenario: -- The production infrastructure (A) is deployed on `HTTP farm A`{.action} (id 77212), which in turn is attached to `HTTP server A`{.action}. This infrastructure can be accessed through the `blue front-end`{.action}. -- The development infrastructure (B) is deployed on `HTTP farm B`{.action} (id 77213), which in turn is attached to `HTTP server B`{.action}. This infrastructure can be accessed through the `green front-end`{.action}. +- The production infrastructure (A) is deployed on **HTTP farm A** (id 77212), which in turn is attached to **HTTP server A**. This infrastructure can be accessed through the **blue front-end**. +- The development infrastructure (B) is deployed on **HTTP farm B** (id 77213), which in turn is attached to **HTTP server B**. This infrastructure can be accessed through the **green front-end**. -Once you have modified/applied updates to `infrastructure B`{.action} and checked that the service is working properly, you decide to put it into production. +Once you have modified/applied updates to **infrastructure B** and checked that the service is working properly, you can decide to put it into production. To switch between the two farms, you can simply update your different front-ends by modifying the ID of the farm it is attached to, and applying the modification. -The `blue front-end`{.action} (id 70089) will then be associated with `Farm B`{.action} (infrastructure B, new production, id 77213). +The **blue front-end** (id 70089) will then be associated with **Farm B** (infrastructure B, new production, id 77213). -The `green front-end`{.action} (id 70090) will then be associated with `Farm A`{.action} (infrastructure A, new development, id 77212). +The **green front-end** (id 70090) will then be associated with **Farm A** (infrastructure A, new development, id 77212). -This should be the result on the Sunrise Control Panel after updating the front-ends and applying the new configuration: +This should be the result on the OVHcloud Control Panel after updating the front-ends and applying the new configuration: ![Result after updating front-ends](images/switch.png){.thumbnail} -#### Via the API: updating front-ends and applying modifications#### +#### Via the OVHcloud API + +- Updating front-ends and applying modifications: > [!api] > @@ -306,7 +305,7 @@ This should be the result on the Sunrise Control Panel after updating the front- |frontendId|Your production front-end ID|70090| |defaultFarmId|Your development server farm ID|77212| -#### To apply your changes and effectively switch over the production and development environments: +- To apply your changes and effectively switch over the production and development environments: > [!api] > @@ -317,12 +316,16 @@ This should be the result on the Sunrise Control Panel after updating the front- |---|---| |serviceName|Your Load Balancer service ID| -## Go further +## Conclusion -You now have an infrastructure you can use to simply and efficiently manage `blue-green deployments`{.action}. +You have successfully implemented a highly available infrastructure for managing blue-green deployments. -Developers have access to a development environment on port 8888 (or whichever other port you would prefer to define), while your customers continue to access the service in production via the standard HTTP port (80 in our case, for example). +Developers have access to a development environment on port 8888 (or any configurable non-standard port), while your customers continue to access the service in production via the standard HTTP port (80). The infrastructure presented here is limited to just one port, but it can be expanded by adding other ports. For example, you can also expose your website on the standard HTTPS port (443). You can do this by defining new farms dedicated to each port you want to expose, and associating them with their corresponding front-ends (one for the standard port exposed in production, the second for the arbitrary port dedicated to development). Another way to consolidate your infrastructure even further is by multiplying the servers attached to your farms. This way, you can make your services more redundant (guaranteeing availability as a result), and also add a load balancing capacity. + +## Go further + +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/case_blue_green/guide.fr-ca.md b/pages/network/load_balancer/case_blue_green/guide.fr-ca.md index 8ac93e77b49..36313db60a0 100644 --- a/pages/network/load_balancer/case_blue_green/guide.fr-ca.md +++ b/pages/network/load_balancer/case_blue_green/guide.fr-ca.md @@ -1,54 +1,62 @@ --- -title: Infrastructure Blue-Green -excerpt: Cas pratique -updated: 2022-04-26 +title: "Déploiement d'une infrastructure blue-green" +excerpt: "Ce guide vous montre comment déployer une infrastructure blue-green avec le Load Balancer OVHcloud" +updated: 2025-10-24 --- -## Introduction -Avec ce guide nous vous proposons d'explorer un cas d'usage particulier de votre service OVHcloud Load Balancer : configurer son service pour gérer facilement une infrastructure production / développement également appelée Blue-Green. +## Objectif -## Déploiement Blue-Green -Un déploiement `Blue-Green`{.action} permet de s'affranchir du temps d'indisponibilité de votre infrastructure. L'intérêt principal est que ce type de déploiement vous offre la possibilité de préparer vos mises à jour et / ou maintenances dans un environnement isolé de votre environnement de production. Vous pouvez ainsi tester vos modifications avant leur mise en production mais aussi revenir rapidement en arrière en cas de détection d'un dysfonctionnement, tout ceci avec des délais d'indisponibilité quasiment nuls. +Ce guide présente un cas d'usage spécifique du service Load Balancer OVHcloud : la configuration d'un service visant à faciliter le basculement fluide du trafic entre l'environnement de production et un nouvel environnement candidat à la production, également appelé infrastructure **blue-green**. -### Prérequis -Pour mettre en oeuvre un déploiement de type `Blue-Green`{.action} vous devez disposer des éléments suivants : +Une infrastructure **blue-green** vous permet d'éviter toute interruption de service de votre infrastructure. Le principal avantage de ce type de déploiement est de pouvoir préparer des mises à jour et/ou des opérations de maintenance dans un environnement isolé de votre environnement de production. Vous pouvez ainsi tester vos modifications avant la mise en production, les annuler rapidement en cas de défaillance, et ce, avec une interruption de service quasi nulle. -- un service OVHcloud Load Balancer ; -- un premier serveur qui porte votre infrastructure de production ; -- un second serveur qui porte une infrastructure similaire dédiée au développement ; +**Ce guide vous montre comment déployer une infrastructure blue-green avec le Load Balancer OVHcloud.** + +## Prérequis + +Pour déployer une infrastructure **blue-green**, vous avez besoin des composants suivants : + +- Un service [Load Balancer OVHcloud](/links/network/load-balancer) +- Un accès à l'[espace client OVHcloud](/links/manager) +- Deux [serveurs dédiés](/links/bare-metal/bare-metal), l'un hébergeant votre environnement de production, l'autre, un serveur de configuration similaire hébergeant votre environnement de développement. + +## En pratique ### Scénario -Le scénario que nous vous proposons ici est le suivant : vous disposez d'une infrastructure qui vous permet de mettre en ligne votre site internet. -Cette infrastructure héberge le code de votre site mais aussi les applications (serveurs web, serveurs de base de données, etc.) nécessaires à la mise en ligne du site. Régulièrement vous êtes confronté à la nécessité de mettre à jour vos applications et / ou votre code. Vous souhaitez être en mesure de tester vos mises à jours sans impacter ni la disponibilité ni le bon fonctionnement du site exposé à vos clients. +Vous disposez d'une infrastructure conçue pour héberger votre site Web en direct. -Une solution possible pour atteindre ces objectifs est de mettre en œuvre un déploiement `Blue-Green`{.action}. +Cet environnement héberge le code de votre site Web, ainsi que toutes les applications essentielles (serveurs Web, serveurs de bases de données, etc.). Vous devez mettre à jour vos applications et/ou votre code régulièrement. Vous souhaitez pouvoir tester vos mises à jour sans impact sur la disponibilité ou la fonctionnalité du site Web pour les utilisateurs finaux. -Le principe d'un déploiement `Blue-Green`{.action} consiste à vous permettre de basculer facilement d'une infrastructure de développement vers une infrastructure de production, et vice-versa. Cette bascule doit pouvoir se faire de manière transparente pour vos différents utilisateurs. Pour ce faire nous allons assigner le port HTTP standard 80 pour les accès à l'infrastructure de production et le port arbitraire 8888 pour les accès à l'infrastructure de développement. +Une façon d'y parvenir est de déployer une infrastructure **blue-green**. -## Déployer les infrastructures -Dans le cadre du scénario proposé, votre service IP Load Balancing joue un rôle central. Il est l'élément qui vous permet d'exposer simultanément vos 2 infrastructures (production et développement) à vos différents utilisateurs. +Le principe d'un déploiement **blue-green** implique de pouvoir basculer facilement d'une infrastructure de développement à une infrastructure de production, et inversement. Ce basculement doit être transparent pour vos utilisateurs. Pour ce faire, le trafic public sera acheminé vers le port HTTP standard 80 pour l'accès à l'infrastructure de production, et un port non standard, tel que 8888, sera utilisé pour l'accès à l'infrastructure de développement. -L'infrastructure de production est accessible à vos clients sur le service HTTP standard (port 80). L'infrastructure de développement quant à elle est accessible à vos développeurs / administrateurs sur le port non-standard 8888. +## Déploiement des infrastructures -Durant la phase initiale d'installation, nous allons assigner arbitrairement un rôle à chacune des parties de notre infrastructure. L'`infrastructure A`{.action} sera assignée à la production tandis que l'`infrastructure B`{.action} sera assignée au développement. Nous considérerons qu'à ce stade elles sont similaires. +Dans ce scénario, votre service Load Balancer joue un rôle central. C'est l'élément que vous utilisez pour exposer simultanément vos deux infrastructures (production et développement) à différents utilisateurs. -Le déploiement `Blue-Green`{.action} consiste à basculer de l'infrastructure A vers l'infrastructure B lorsque cette dernière est prête à exposer votre site après que vos changements aient été appliqués et testés. C'est l'IPBL qui se chargera de gérer cette bascule. +L'infrastructure de production est accessible pour vos clients sur le service HTTP standard (port 80), et votre infrastructure de développement est accessible pour les développeurs et administrateurs sur le port non standard 8888. -Le schéma suivant détail l'architecture générale : +Au cours de la phase de configuration initiale, les rôles sont provisoirement attribués à chaque composant de l'infrastructure. **L'infrastructure A** sert d'environnement de production initial, tandis que **l'infrastructure B** sert d'environnement de staging. À ce stade, nous allons les considérer comme similaires l'une à l'autre. -![Schéma général de l'architecture blue-green](images/scheme.png){.thumbnail} +Une infrastructure **blue-green** implique le basculement de l'infrastructure A vers l'infrastructure B, une fois que l'infrastructure B est prête à exposer votre site Web après que vos modifications ont été appliquées et testées. Le Load Balancer gérera ce basculement. + +Le schéma ci-dessous donne une idée générale de l'architecture : + +![General diagram of blue-green architecture](images/scheme.png){.thumbnail} ### Infrastructure A -Cette infrastructure est composée d'une ferme de serveurs qui sera ultérieurement associée à un frontend de votre IPLB. Cette ferme expose au frontend un service de type HTTP, TCP ou UDP. Elle se charge également de la répartition de charge en transmettant aux serveurs le trafic reçu par le frontend. Pour plus de précision sur le rôle des différents éléments du service OVHcloud Load Balancer, vous pouvez vous réferer à cette documentation : [Présentation de l'OVH Load Balancer](/pages/network/load_balancer/use_presentation). -Dans le cadre de notre scénario, nous déclarons une ferme de serveurs pour le service HTTP. A noter que vous pouvez créer autant de fermes que de services TCP et / ou UDP nécessaires au bon fonctionnement du service final exposé à vos clients. +Cette infrastructure est composée d'une ferme de serveurs qui sera associée plus tard à un front-end de votre Load Balancer. Cette ferme exposera un service HTTP, TCP ou UDP au front-end. Elle assure également l'équilibrage de charge en envoyant le trafic entrant du front-end aux serveurs. Pour plus de détails sur le rôle des différents composants du service Load Balancer OVHcloud, vous pouvez lire le guide suivant : [Présentation du service OVHcloud Load Balancer ](/pages/network/load_balancer/use_presentation). -Depuis le manager : +Dans notre scénario, nous allons déclarer une ferme de serveurs pour le service HTTP. Veuillez noter que vous pouvez créer autant de fermes (ainsi que de services TCP et/ou UDP) que nécessaire pour que votre service final soit accessible pour vos clients. -![Ajout d'une nouvelle ferme HTTP dédié à l'infrastructure A](images/ferme1.png){.thumbnail} +#### Via l'espace client OVHcloud -Via l'Api : +![Add a new HTTP farm dedicated to infrastructure A](images/ferme1.png){.thumbnail} + +#### Via l'API OVHcloud > [!api] > @@ -57,9 +65,9 @@ Via l'Api : |Paramètre|Signification| |---|---| -|serviceName|L'identifiant de votre service Load Balancer| +|serviceName|Votre ID de service Load Balancer| -Les appels complémentaires suivants vous permettront respectivement de lister, modifier ou supprimer vos fermes. +Avec les appels supplémentaires listés ci-dessous, vous pouvez respectivement lister, modifier et supprimer vos fermes de serveurs: > [!api] > @@ -76,15 +84,15 @@ Les appels complémentaires suivants vous permettront respectivement de lister, > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm > -Associer un serveur à votre ferme, il s'agit ici du serveur physique portant votre infrastructure de production. Le service exposé au frontend est fournis par le port 8080 du serveur. A noter que vous pouvez associer à chaque ferme un ou plusieurs serveurs (pour par exemple répartir la charge et / ou offrir une meilleur tolérance aux pannes). +Associez un **serveur dédié** à votre ferme s'il héberge votre infrastructure de production. Le service est exposé au front-end via le port 8080 du serveur. Notez que vous pouvez associer un ou plusieurs serveurs à chaque ferme (par exemple, pour équilibrer la charge ou offrir une tolérance aux pannes plus élevée). -Depuis le manager : +#### Via l'espace client OVHcloud -![Ajout d'un nouveau serveur à la ferme HTTP A](images/serveur1.png){.thumbnail} +![Add a new server to the farm HTTP A](images/serveur1.png){.thumbnail} -![Renseigner la configuration du serveur HTTP A](images/server1.png){.thumbnail} +![Enter the HTTP A server’s configuration](images/server1.png){.thumbnail} -Via l'Api : +#### Via l'API OVHcloud > [!api] > @@ -93,13 +101,13 @@ Via l'Api : |Paramètre|Requis|Signification|Exemple| |---|---|---|---| -|serviceName|Requis|L'identifiant de votre service Load Balancer|loadbalancer-abcdef0123456789| -|farmId|Requis|L'identifiant de votre ferme de serveurs|77212| -|address|Requis|L'addresse IPv4 de votre serveur|10.10.1.100| -|displayName||Le nom du serveur associé à votre ferme|Serveur HTTP A| +|serviceName|Requis|Votre ID de service Load Balancer|loadbalancer-abcdef0123456789| +|farmId|Requis|Votre ID de ferme de serveurs|77212| +|address|Requis|L'adresse IPv4 de votre serveur|10.10.1.100| +|displayName||Le nom du serveur associé à votre ferme|HTTP A server| |port||Le port du serveur associé à votre ferme|8080| -Les appels complémentaires suivants vous permettront respectivement de lister, modifier ou supprimer vos serveurs. +Avec les appels supplémentaires listés ci-dessous, vous pouvez respectivement lister, modifier et supprimer vos serveurs: > [!api] > @@ -117,17 +125,18 @@ Les appels complémentaires suivants vous permettront respectivement de lister, > ### Infrastructure B -Cette seconde infrastructure est fonctionnellement jumelle de la précédente, elle est également composée d'une ferme de serveurs qui sera ultérieurement associée à un second frontend de votre IPLB. Cette ferme expose au frontend le même service que la ferme précédemment créé. Ce service est fournis sur les serveurs par le port 8080. -Déployer la ferme de serveurs pour le service HTTP (et / ou tout autre service TCP ou UDP nécessaire au fonctionnement du service final exposé à vos clients). +Fonctionnellement, cette deuxième infrastructure est identique à la première. Elle est également composée d'une ferme de serveurs qui sera associée plus tard à un second front-end de votre Load Balancer. Cette ferme de serveurs expose le même service au front-end que la première ferme de serveurs. Ce service est fourni sur les serveurs par le port 8080. + +Déployez la ferme de serveurs pour le service HTTP (et/ou tout autre service TCP ou UDP requis pour que votre service final soit exposé à vos clients). -Depuis le manager Sunrise : +#### Via l'espace client OVHcloud -![Ajout d'une nouvelle ferme HTTP dédié à l'infrastructure B](images/ferme2.png){.thumbnail} +![Add a new HTTP farm dedicated to infrastructure B](images/ferme2.png){.thumbnail} -![Création d'une seconde ferme dédiée à l'infrastructure B](images/backend2.png){.thumbnail} +![Create a second farm dedicated to infrastructure B](images/backend2.png){.thumbnail} -Via l'Api : +#### Via l'API OVHcloud > [!api] > @@ -136,17 +145,17 @@ Via l'Api : |Paramètre|Signification| |---|---| -|serviceName|L'identifiant de votre service Load Balancer| +|serviceName|Votre ID de service Load Balancer| -Associer un serveur à votre ferme, il s'agit ici du (ou des) serveur(s) physique(s) portant votre infrastructure de développement. +Associez un serveur à votre ferme. Ici, il s'agit d'un ou plusieurs **serveurs dédiés** hébergeant votre infrastructure de développement. -Depuis le manager : +#### Via l'espace client OVHcloud -![Ajout d'une nouveau serveur à la ferme HTTP B](images/serveur2.png){.thumbnail} +![Add a new server to the farm HTTP B](images/serveur2.png){.thumbnail} -![Renseigner la configuration du serveur HTTP B](images/server2.png){.thumbnail} +![Enter the HTTP B server’s configuration](images/server2.png){.thumbnail} -Via l'Api : +#### Via l'API OVHcloud > [!api] > @@ -155,38 +164,40 @@ Via l'Api : |Paramètre|Requis|Signification|Exemple| |---|---|---|---| -|serviceName|Requis|L'identifiant de votre service Load Balancer|loadbalancer-abcdef0123456789| -|farmId|Requis|L'identifiant de votre ferme de serveurs|77213| -|address|Requis|L'addresse IPv4 de votre serveur|10.10.2.100| -|displayName||Le nom du serveur associé à votre ferme|Serveur HTTP B| +|serviceName|Requis|Votre ID de service Load Balancer|loadbalancer-abcdef0123456789| +|farmId|Requis|Votre ID de ferme de serveurs|77213| +|address|Requis|L'adresse IPv4 de votre serveur|10.10.2.100| +|displayName||Le nom du serveur associé à votre ferme|HTTP B server| |port||Le port du serveur associé à votre ferme|8080| -A ce stade voici l'état de la configuration de vos 2 fermes : +À ce stade, voici l'état de la configuration de vos deux fermes : -![Configuration des fermes](images/farms.png){.thumbnail} +![Farm configuration](images/farms.png){.thumbnail} -## Les frontends -Toute la magie du déploiement `Blue-Green`{.action} se situe au niveau de la configuration de vos frontends. A ce stade nous avons configuré 2 infrastructures fonctionnellement jumelles en déclarant, pour chaque infrastructure, une (ou plusieurs) ferme(s) de serveurs, avec pour chaque ferme son (ses) serveur(s) associé(s). +## Front-ends -Pour permettre de basculer simplement d'une infrastructure à une autre nous allons nous servir des frontends. +La magie du déploiement **blue-green** réside dans la configuration de vos front-ends. À ce stade, nous avons configuré deux infrastructures fonctionnellement identiques. Pour les deux infrastructures, vous avez déclaré une ou plusieurs fermes de serveurs, chacune avec son propre ensemble de serveurs associés. -Pour cela nous devons déclarer 2 frontends. Le premier permettra d'accéder à l'infrastructure de production tandis que le second se chargera des accès à l'infrastructure de développement. Les accès à l'une ou l'autre des infrastructures seront controlés grâce aux ports exposés à vos clients. +Pour basculer simplement d'une infrastructure à l'autre, nous utiliserons des front-ends. + +Pour ce faire, nous devons déclarer deux front-ends. Le premier vous donnera accès à votre infrastructure de production, tandis que le second vous donnera accès à votre infrastructure de développement. Vous pouvez contrôler l'accès à une infrastructure ou à l'autre en utilisant les ports que vous exposez à vos clients. > [!warning] > -> Si le service final exposé à vos clients nécessite plusieurs fermes de serveurs (par exemple : les ports 80 et 443), vous devrez déclarer un `frontend`{.action} pour chacune de vos fermes. +> Si le service final que vous exposez à vos clients nécessite plusieurs fermes de serveurs (par ex. les ports 80 et 443), vous devrez déclarer un **front-end** pour chacune de vos fermes. > -### Frontend Blue -Ce `frontend`{.action} est dédié aux accès à l'infrastructure de production, les ports exposés à vos clients sont les ports standards d'accès au service. Dans le cas présent nous exposons un service HTTP, nous allons donc utiliser le port 80 (443 si vous souhaitez une terminaison SSL). +### Front-end Blue + +Ce **front-end** est dédié à l'accès à l'infrastructure de production. Les ports exposés à vos clients sont les ports standard pour l'accès au service. Dans ce cas, nous exposons un service HTTP, nous utiliserons donc le port 80 (443 si vous souhaitez une terminaison SSL). -Depuis le manager : +#### Via l'espace client OVHcloud -![Ajout du frontend dédié à la production, Blue Frontend](images/frontend1.png){.thumbnail} +![Adding a front-end dedicated to production, a blue front-end](images/frontend1.png){.thumbnail} -![Renseigner la configuration du frontend Blue](images/fblue.png){.thumbnail} +![Enter the blue front-end’s configuration](images/fblue.png){.thumbnail} -Via l'Api : +#### Via l'API OVHcloud > [!api] > @@ -195,22 +206,23 @@ Via l'Api : |Paramètre|Requis|Signification|Exemple| |---|---|---|---| -|serviceName|Requis|L'identifiant de votre Load Balancer|loadbalancer-abcdef0123456789| -|defaultFarmId||L'identifiant de la ferme de production|77212| -|displayName||Le nom donné au frontend|Blue Frontend| -|port|Requis|Le port exposé par votre frontend à vos clients|80| -|zone|Requis|La zone dans laquelle vous souhaitez déployer votre frontend|all| +|serviceName|Requis|Votre ID de service Load Balancer|loadbalancer-abcdef0123456789| +|defaultFarmId||Votre ID de ferme de production|77212| +|displayName||Le nom donné au front-end|Blue front-end| +|port|Requis|Le port exposé à vos clients par votre front-end|80| +|zone|Requis|La zone dans laquelle vous souhaitez déployer votre front-end|all| -### Frontend Green -Ce `frontend`{.action} est dédié aux accès à l'infrastructure de développement, les ports exposés à vos clients seront des ports non-standards que vous pouvez choisir arbitrairement. Dans le cas présent nous allons exposer le service HTTP de développement sur le port 8888. +### Front-end Green -Depuis le manager : +Ce **front-end** est dédié à l'accès à l'infrastructure de développement. Les ports exposés à vos clients seront des ports non standard que vous pourrez choisir arbitrairement. Dans ce cas, nous exposerons le service de développement HTTP sur le port 8888. -![Ajout du frontend dédié au développement, Green Frontend](images/frontend2.png){.thumbnail} +#### Via l'espace client OVHcloud -![Renseigner la configuration du frontend Green](images/fgreen.png){.thumbnail} +![Add the green front-end, dedicated to development](images/frontend2.png){.thumbnail} -Via l'Api : +![Enter the green front-end’s configuration](images/fgreen.png){.thumbnail} + +#### Via l'API OVHcloud > [!api] > @@ -219,22 +231,23 @@ Via l'Api : |Paramètre|Requis|Signification|Exemple| |---|---|---|---| -|serviceName|Requis|L'identifiant de votre Load Balancer|loadbalancer-abcdef0123456789| -|defaultFarmId||L'identifiant de la ferme de production|77213| -|displayName||Le nom donné au frontend|Green Frontend| -|port|Requis|Le port exposé par votre frontend à vos clients|8888| -|zone|Requis|La zone dans laquelle vous souhaitez déployer votre frontend|all| +|serviceName|Requis|Votre ID de service Load Balancer|loadbalancer-abcdef0123456789| +|defaultFarmId||Votre ID de ferme de production|77213| +|displayName||Le nom donné au front-end|Green front-end| +|port|Requis|Le port exposé à vos clients par votre front-end|8888| +|zone|Requis|La zone dans laquelle vous souhaitez déployer votre front-end|all| -## Gérer les déploiements +## Gestion des déploiements ### Déploiement initial -Après avoir finalisé la configuration des différents composants de votre service OVHcloud Load Balancer, il ne vous reste plus qu'à appliquer vos changements. -Depuis le manager : +Une fois que vous avez terminé de configurer les composants du service Load Balancer OVHcloud, il ne vous reste plus qu'à appliquer vos modifications. + +#### Via l'espace client OVHcloud -![Appliquer vos changements sur la zone](images/deploy.png){.thumbnail} +![Apply your changes to the zone](images/deploy.png){.thumbnail} -Via l'Api : +#### Via l'API OVHcloud > [!api] > @@ -243,31 +256,30 @@ Via l'Api : |Paramètre|Signification| |---|---| -|serviceName|L'identifiant de votre service Load Balancer| +|serviceName|Votre ID de service Load Balancer| -### Bascule production / preproduction -À ce stade notre environnement initial est déployé et prêt à être utilisé. Comment l'utiliser ? +### Changement de production ou de mise en scène -De manière assez simple finalement, il suffira désormais de basculer vos frontends d'une ferme de serveur à une autre ! +À ce stade, notre environnement initial est déployé et prêt à l'emploi. Maintenant, vous devez basculer vos front-ends d'une ferme de serveurs à une autre. -Reprenons notre scénario : +Prenons notre scénario : -- l'infrastructure de production (A) est déployée sur la `Ferme HTTP A`{.action} (id 77212) qui est elle même attachée au `Serveur HTTP A`{.action}. L'accès à cette infrastructure se fait par l'intermédiaire du `Frontend Blue`{.action}. -- l'infrastructure de développement (B) est déployée sur la `Ferme HTTP B`{.action} (id 77213) qui est elle même attachée au `Serveur HTTP B`{.action}. L'accès à cette infrastructure se fait par l'intermédiaire du `Frontend Green`{.action}. +- L'infrastructure de production (A) est déployée sur la **ferme HTTP A** (id 77212), qui est elle-même attachée au **serveur HTTP A**. Cette infrastructure est accessible via le **front-end blue**. +- L'infrastructure de développement (B) est déployée sur la **ferme HTTP B** (id 77213), qui est elle-même attachée au **serveur HTTP B**. Cette infrastructure est accessible via le **front-end green**. -Après avoir réalisé vos modifications / mises à jours sur l'`infrastructure B`{.action} et validé le bon fonctionnement du service, vous décidez de l'assigner à la production. +Une fois que vous avez modifié/appliqué les mises à jour à l'**infrastructure B** et vérifié que le service fonctionne correctement, vous décidez de la mettre en production. -Pour faire la bascule entre les 2 fermes, il suffira simplement de mettre à jour vos différents frontends en modifiant l'identifiant de la ferme à laquelle ils sont rattachés et d'appliquer la modification. +Pour basculer entre les deux fermes, vous pouvez simplement mettre à jour vos différents front-ends en modifiant l'ID de la ferme à laquelle il est attaché, et en appliquant la modification. -Le `Frontend Blue`{.action} (id 70089) va donc être associé à la `Ferme B`{.action} (infrastructure B, nouvelle production, id 77213). +Le **front-end blue** (id 70089) sera alors associé à la **Ferme B** (infrastructure B, nouvelle production, id 77213). -Le `Frontend Green`{.action} (id 70090) quant à lui sera désormais associé à la `Ferme A`{.action} (infrastructure A, nouvelle développement, id 77212). +Le **front-end green** (id 70090) sera alors associé à la **Ferme A** (infrastructure A, nouveau développement, id 77212). -Résultat sur le manager Sunrise après mise à jour des frontends et application de la nouvelle configuration : +Voici le résultat attendu dans l'espace client OVHcloud après la mise à jour des front-ends et l'application de la nouvelle configuration : -![Résultat après la mise à jour des frontends](images/switch.png){.thumbnail} +![Result after updating front-ends](images/switch.png){.thumbnail} -Via l'Api : mise à jour des frontends et application des modifications +#### Via l'API OVHcloud : mise à jour des front-ends et application des modifications > [!api] > @@ -276,9 +288,9 @@ Via l'Api : mise à jour des frontends et application des modifications |Paramètre|Signification|Exemple| |---|---|---| -|ServiceName|L'identifiant de votre service Load Balancer|loadbalancer-abcdef0123456789| -|frontendId|L'identifiant de votre frontend de production|70089| -|defaultFarmId|L'identifiant de votre ferme de serveurs de développement|77213| +|serviceName|Votre ID de service Load Balancer|loadbalancer-abcdef0123456789| +|frontendId|Votre ID de front-end de production|70089| +|defaultFarmId|Votre ID de ferme de serveurs de développement|77213| > [!api] > @@ -287,11 +299,11 @@ Via l'Api : mise à jour des frontends et application des modifications |Paramètre|Signification|Exemple| |---|---|---| -|ServiceName|L'identifiant de votre service Load Balancer|loadbalancer-abcdef0123456789| -|frontendId|L'identifiant de votre frontend de production|70090| -|defaultFarmId|L'identifiant de votre ferme de serveurs de développement|77212| +|serviceName|Votre ID de service Load Balancer|loadbalancer-abcdef0123456789| +|frontendId|Votre ID de front-end de production|70090| +|defaultFarmId|Votre ID de ferme de serveurs de développement|77212| -Pour appliquer vos changements et réaliser effectivement la bascule production / développement. +#### Appliquer vos modifications et basculer effectivement les environnements de production et de développement > [!api] > @@ -300,13 +312,18 @@ Pour appliquer vos changements et réaliser effectivement la bascule production |Paramètre|Signification| |---|---| -|serviceName|L'identifiant de votre service Load Balancer| +|serviceName|Votre ID de service Load Balancer| ## Conclusion -Vous disposez désormais d'une infrastructure vous permettant de gérer simplement et efficacement vos déploiements `Blue-Green`{.action}. -Les développeurs disposent d'un accès à l'infrastructure de développement sur le port 8888 (ou tout autre port que vous auriez préférer définir) tandis que vos clients continuent d'accéder au service en production via le port HTTP standard (80 dans le cas de notre exemple). +Vous avez réussi à mettre en œuvre une infrastructure hautement disponible pour la gestion des déploiements blue-green. + +Les développeurs ont accès à un environnement de développement sur le port 8888 (ou tout port non standard configurable), tandis que vos clients continuent d'accéder au service en production via le port HTTP standard (80). + +L'infrastructure présentée ici est limitée à un seul port, mais elle peut être étendue en ajoutant d'autres ports. Par exemple, vous pouvez également exposer votre site Web sur le port HTTPS standard (443). Vous pouvez le faire en définissant de nouvelles fermes dédiées à chaque port que vous souhaitez exposer, et en les associant à leurs front-ends correspondants (un pour le port standard exposé en production, le second pour le port arbitraire dédié au développement). + +Une autre façon de consolider davantage votre infrastructure est de multiplier les serveurs attachés à vos fermes. De cette façon, vous pouvez rendre vos services plus redondants (garantissant ainsi la disponibilité) et ajouter également une capacité d'équilibrage de charge. -L'infrastructure présentée ici se limite à l'exposition d'un seul et unique port, elle peut bien entendue être développée en ajoutant d'autres ports. Vous pouvez par exemple vouloir également exposer votre site sur le port HTTPS standard (443). Ceci peut se faire en définissant de nouvelles fermes dédiées à chaque nouveau port que vous souhaitez exposer et en les associant à leurs frontends correspondant (un pour le port standard exposé en production, le second pour le port arbitraire dédié aux développements). +## Aller plus loin -Une autre possibilité pour consolider encore un peu plus votre infrastructure est de multiplier les serveurs attachés à votre (vos) ferme(s). Ceci vous permettra d'ajouter à la simplicité de réalisation de vos déploiements une redondance de vos services (garantissant ainsi leur disponibilité) ainsi qu'une capacité de répartition de charge. +Échangez avec notre [communauté d'utilisateurs](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/case_blue_green/guide.fr-fr.md b/pages/network/load_balancer/case_blue_green/guide.fr-fr.md index 49ce58f18df..36313db60a0 100644 --- a/pages/network/load_balancer/case_blue_green/guide.fr-fr.md +++ b/pages/network/load_balancer/case_blue_green/guide.fr-fr.md @@ -1,63 +1,62 @@ --- -title: Infrastructure Blue-Green -excerpt: Cas pratique -updated: 2022-04-26 +title: "Déploiement d'une infrastructure blue-green" +excerpt: "Ce guide vous montre comment déployer une infrastructure blue-green avec le Load Balancer OVHcloud" +updated: 2025-10-24 --- ## Objectif -Ce guide a pour but de vous aider à explorer un cas d'usage particulier de votre service OVHcloud Load Balancer : configurer son service pour gérer facilement une infrastructure production / développement également appelée **Blue-Green**. +Ce guide présente un cas d'usage spécifique du service Load Balancer OVHcloud : la configuration d'un service visant à faciliter le basculement fluide du trafic entre l'environnement de production et un nouvel environnement candidat à la production, également appelé infrastructure **blue-green**. -Un déploiement **Blue-Green** permet de s'affranchir du temps d'indisponibilité de votre infrastructure. L'intérêt principal est que ce type de déploiement vous offre la possibilité de préparer vos mises à jour et / ou maintenances dans un environnement isolé de votre environnement de production. Vous pouvez ainsi tester vos modifications avant leur mise en production mais aussi revenir rapidement en arrière en cas de détection d'un dysfonctionnement, tout ceci avec des délais d'indisponibilité quasiment nuls. +Une infrastructure **blue-green** vous permet d'éviter toute interruption de service de votre infrastructure. Le principal avantage de ce type de déploiement est de pouvoir préparer des mises à jour et/ou des opérations de maintenance dans un environnement isolé de votre environnement de production. Vous pouvez ainsi tester vos modifications avant la mise en production, les annuler rapidement en cas de défaillance, et ce, avec une interruption de service quasi nulle. + +**Ce guide vous montre comment déployer une infrastructure blue-green avec le Load Balancer OVHcloud.** ## Prérequis -Pour mettre en oeuvre un déploiement de type **Blue-Green**, vous devez disposer des éléments suivants : +Pour déployer une infrastructure **blue-green**, vous avez besoin des composants suivants : -- Posséder une offre [OVHcloud Load balancer](/links/network/load-balancer) dans votre compte OVHcloud -- Être connecté à votre [espace client OVHcloud](/links/manager) -- Un premier serveur qui porte votre infrastructure de production -- Un second serveur qui porte une infrastructure similaire dédiée au développement +- Un service [Load Balancer OVHcloud](/links/network/load-balancer) +- Un accès à l'[espace client OVHcloud](/links/manager) +- Deux [serveurs dédiés](/links/bare-metal/bare-metal), l'un hébergeant votre environnement de production, l'autre, un serveur de configuration similaire hébergeant votre environnement de développement. ## En pratique ### Scénario -Le scénario que nous vous proposons ici est le suivant : vous disposez d'une infrastructure qui vous permet de mettre en ligne votre site internet. +Vous disposez d'une infrastructure conçue pour héberger votre site Web en direct. -Cette infrastructure héberge le code de votre site mais aussi les applications (serveurs web, serveurs de base de données, etc.) nécessaires à la mise en ligne du site. Régulièrement vous êtes confronté à la nécessité de mettre à jour vos applications et / ou votre code. Vous souhaitez être en mesure de tester vos mises à jours sans affecter ni la disponibilité, ni le bon fonctionnement du site exposé à vos clients. +Cet environnement héberge le code de votre site Web, ainsi que toutes les applications essentielles (serveurs Web, serveurs de bases de données, etc.). Vous devez mettre à jour vos applications et/ou votre code régulièrement. Vous souhaitez pouvoir tester vos mises à jour sans impact sur la disponibilité ou la fonctionnalité du site Web pour les utilisateurs finaux. -Une solution possible pour atteindre ces objectifs est de mettre en œuvre un déploiement **Blue-Green**. +Une façon d'y parvenir est de déployer une infrastructure **blue-green**. -Le principe d'un déploiement **Blue-Green** consiste à vous permettre de basculer facilement d'une infrastructure de développement vers une infrastructure de production, et vice-versa. Cette bascule doit pouvoir se faire de manière transparente pour vos différents utilisateurs. Pour ce faire, nous allons assigner le port HTTP standard 80 pour les accès à l'infrastructure de production et le port arbitraire 8888 pour les accès à l'infrastructure de développement. +Le principe d'un déploiement **blue-green** implique de pouvoir basculer facilement d'une infrastructure de développement à une infrastructure de production, et inversement. Ce basculement doit être transparent pour vos utilisateurs. Pour ce faire, le trafic public sera acheminé vers le port HTTP standard 80 pour l'accès à l'infrastructure de production, et un port non standard, tel que 8888, sera utilisé pour l'accès à l'infrastructure de développement. -### Déployer les infrastructures +## Déploiement des infrastructures -Dans le cadre du scénario proposé, votre service IP Load Balancing joue un rôle central. Il est l'élément qui vous permet d'exposer simultanément vos 2 infrastructures (production et développement) à vos différents utilisateurs. +Dans ce scénario, votre service Load Balancer joue un rôle central. C'est l'élément que vous utilisez pour exposer simultanément vos deux infrastructures (production et développement) à différents utilisateurs. -L'infrastructure de production est accessible à vos clients sur le service HTTP standard (port 80). L'infrastructure de développement quant à elle est accessible à vos développeurs / administrateurs sur le port non-standard 8888. +L'infrastructure de production est accessible pour vos clients sur le service HTTP standard (port 80), et votre infrastructure de développement est accessible pour les développeurs et administrateurs sur le port non standard 8888. -Durant la phase initiale d'installation, nous allons assigner arbitrairement un rôle à chacune des parties de notre infrastructure. L'**infrastructure A** sera assignée à la production tandis que l'**infrastructure B** sera assignée au développement. Nous considérons qu'à ce stade elles sont similaires. +Au cours de la phase de configuration initiale, les rôles sont provisoirement attribués à chaque composant de l'infrastructure. **L'infrastructure A** sert d'environnement de production initial, tandis que **l'infrastructure B** sert d'environnement de staging. À ce stade, nous allons les considérer comme similaires l'une à l'autre. -Le déploiement **Blue-Green** consiste à basculer de l'infrastructure A vers l'infrastructure B lorsque cette dernière est prête à exposer votre site après que vos changements aient été appliqués et testés. C'est l'IPBL qui se chargera de gérer cette bascule. +Une infrastructure **blue-green** implique le basculement de l'infrastructure A vers l'infrastructure B, une fois que l'infrastructure B est prête à exposer votre site Web après que vos modifications ont été appliquées et testées. Le Load Balancer gérera ce basculement. -Le schéma suivant détail l'architecture générale : +Le schéma ci-dessous donne une idée générale de l'architecture : -![Schéma général de l'architecture blue-green](images/scheme.png){.thumbnail} +![General diagram of blue-green architecture](images/scheme.png){.thumbnail} ### Infrastructure A -Cette infrastructure est composée d'une ferme de serveurs qui sera ultérieurement associée à un frontend de votre IPLB. Cette ferme expose au frontend un service de type HTTP, TCP ou UDP. Elle se charge également de la répartition de charge en transmettant aux serveurs le trafic reçu par le frontend. Pour plus de précisions sur le rôle des différents éléments du service OVHcloud Load Balancer, vous pouvez vous réferer à cette documentation : [Présentation de l'OVHcloud Load Balancer](/pages/network/load_balancer/use_presentation). - -**Déployer la ferme de serveurs pour le service HTTP :** +Cette infrastructure est composée d'une ferme de serveurs qui sera associée plus tard à un front-end de votre Load Balancer. Cette ferme exposera un service HTTP, TCP ou UDP au front-end. Elle assure également l'équilibrage de charge en envoyant le trafic entrant du front-end aux serveurs. Pour plus de détails sur le rôle des différents composants du service Load Balancer OVHcloud, vous pouvez lire le guide suivant : [Présentation du service OVHcloud Load Balancer ](/pages/network/load_balancer/use_presentation). -Dans le cadre de notre scénario, nous déclarons une ferme de serveurs pour le service HTTP. À noter que vous pouvez créer autant de fermes que de services TCP et / ou UDP nécessaires au bon fonctionnement du service final exposé à vos clients. +Dans notre scénario, nous allons déclarer une ferme de serveurs pour le service HTTP. Veuillez noter que vous pouvez créer autant de fermes (ainsi que de services TCP et/ou UDP) que nécessaire pour que votre service final soit accessible pour vos clients. -Depuis l'espace client OVHcloud : +#### Via l'espace client OVHcloud -![Ajout d'une nouvelle ferme HTTP dédié à l'infrastructure A](images/ferme1.png){.thumbnail} +![Add a new HTTP farm dedicated to infrastructure A](images/ferme1.png){.thumbnail} -Depuis l'API OVHcloud : +#### Via l'API OVHcloud > [!api] > @@ -66,9 +65,9 @@ Depuis l'API OVHcloud : |Paramètre|Signification| |---|---| -|serviceName|L'identifiant de votre service Load Balancer| +|serviceName|Votre ID de service Load Balancer| -Les appels complémentaires suivants vous permettront respectivement de lister, modifier ou supprimer vos fermes. +Avec les appels supplémentaires listés ci-dessous, vous pouvez respectivement lister, modifier et supprimer vos fermes de serveurs: > [!api] > @@ -85,17 +84,15 @@ Les appels complémentaires suivants vous permettront respectivement de lister, > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm > -**Associer un serveur à votre ferme :** - -Il s'agit ici du serveur physique portant votre infrastructure de production. Le service exposé au frontend est fourni par le port 8080 du serveur. A noter que vous pouvez associer à chaque ferme un ou plusieurs serveurs (par exemple, pour répartir la charge et / ou offrir une meilleur tolérance aux pannes). +Associez un **serveur dédié** à votre ferme s'il héberge votre infrastructure de production. Le service est exposé au front-end via le port 8080 du serveur. Notez que vous pouvez associer un ou plusieurs serveurs à chaque ferme (par exemple, pour équilibrer la charge ou offrir une tolérance aux pannes plus élevée). -Depuis l'espace client OVHcloud : +#### Via l'espace client OVHcloud -![Ajout d'un nouveau serveur à la ferme HTTP A](images/serveur1.png){.thumbnail} +![Add a new server to the farm HTTP A](images/serveur1.png){.thumbnail} -![Renseigner la configuration du serveur HTTP A](images/server1.png){.thumbnail} +![Enter the HTTP A server’s configuration](images/server1.png){.thumbnail} -Depuis l'API OVHcloud : +#### Via l'API OVHcloud > [!api] > @@ -104,13 +101,13 @@ Depuis l'API OVHcloud : |Paramètre|Requis|Signification|Exemple| |---|---|---|---| -|serviceName|Requis|L'identifiant de votre service Load Balancer|loadbalancer-XXXXXXXXXXXXX| -|farmId|Requis|L'identifiant de votre ferme de serveurs|197529| -|address|Requis|L'addresse IPv4 de votre serveur|139.XX.XX.XX| -|displayName||Le nom du serveur associé à votre ferme|Serveur HTTP A| +|serviceName|Requis|Votre ID de service Load Balancer|loadbalancer-abcdef0123456789| +|farmId|Requis|Votre ID de ferme de serveurs|77212| +|address|Requis|L'adresse IPv4 de votre serveur|10.10.1.100| +|displayName||Le nom du serveur associé à votre ferme|HTTP A server| |port||Le port du serveur associé à votre ferme|8080| -Les appels complémentaires suivants vous permettront respectivement de lister, modifier ou supprimer vos serveurs. +Avec les appels supplémentaires listés ci-dessous, vous pouvez respectivement lister, modifier et supprimer vos serveurs: > [!api] > @@ -129,17 +126,17 @@ Les appels complémentaires suivants vous permettront respectivement de lister, ### Infrastructure B -Cette seconde infrastructure est fonctionnellement jumelle de la précédente. Elle est également composée d'une ferme de serveurs qui sera ultérieurement associée à un second frontend de votre IPLB. Cette ferme expose au frontend le même service que la ferme précédemment créée. Ce service est fourni sur les serveurs par le port 8080. +Fonctionnellement, cette deuxième infrastructure est identique à la première. Elle est également composée d'une ferme de serveurs qui sera associée plus tard à un second front-end de votre Load Balancer. Cette ferme de serveurs expose le même service au front-end que la première ferme de serveurs. Ce service est fourni sur les serveurs par le port 8080. -**Déployer la ferme de serveurs pour le service HTTP (et / ou tout autre service TCP ou UDP nécessaire au fonctionnement du service final exposé à vos clients) :** +Déployez la ferme de serveurs pour le service HTTP (et/ou tout autre service TCP ou UDP requis pour que votre service final soit exposé à vos clients). -Depuis l'espace client OVHcloud : +#### Via l'espace client OVHcloud -![Ajout d'une nouvelle ferme HTTP dédié à l'infrastructure B](images/ferme2.png){.thumbnail} +![Add a new HTTP farm dedicated to infrastructure B](images/ferme2.png){.thumbnail} -![Création d'une seconde ferme dédiée à l'infrastructure B](images/backend2.png){.thumbnail} +![Create a second farm dedicated to infrastructure B](images/backend2.png){.thumbnail} -Depuis l'API OVHcloud : +#### Via l'API OVHcloud > [!api] > @@ -148,19 +145,17 @@ Depuis l'API OVHcloud : |Paramètre|Signification| |---|---| -|serviceName|L'identifiant de votre service Load Balancer| +|serviceName|Votre ID de service Load Balancer| -**Associer un serveur à votre ferme :** +Associez un serveur à votre ferme. Ici, il s'agit d'un ou plusieurs **serveurs dédiés** hébergeant votre infrastructure de développement. -Il s'agit ici du (ou des) serveur(s) physique(s) portant votre infrastructure de développement. +#### Via l'espace client OVHcloud -Depuis l'espace client OVHcloud : +![Add a new server to the farm HTTP B](images/serveur2.png){.thumbnail} -![Ajout d'une nouveau serveur à la ferme HTTP B](images/serveur2.png){.thumbnail} +![Enter the HTTP B server’s configuration](images/server2.png){.thumbnail} -![Renseigner la configuration du serveur HTTP B](images/server2.png){.thumbnail} - -Depuis l'API OVHcloud : +#### Via l'API OVHcloud > [!api] > @@ -169,40 +164,40 @@ Depuis l'API OVHcloud : |Paramètre|Requis|Signification|Exemple| |---|---|---|---| -|serviceName|Requis|L'identifiant de votre service Load Balancer|loadbalancer-XXXXXXXXXXX| -|farmId|Requis|L'identifiant de votre ferme de serveurs|197530| -|address|Requis|L'addresse IPv4 de votre serveur|51.XX.XX.XX| -|displayName||Le nom du serveur associé à votre ferme|Serveur HTTP B| +|serviceName|Requis|Votre ID de service Load Balancer|loadbalancer-abcdef0123456789| +|farmId|Requis|Votre ID de ferme de serveurs|77213| +|address|Requis|L'adresse IPv4 de votre serveur|10.10.2.100| +|displayName||Le nom du serveur associé à votre ferme|HTTP B server| |port||Le port du serveur associé à votre ferme|8080| -À ce stade, voici l'état de la configuration de vos 2 fermes : +À ce stade, voici l'état de la configuration de vos deux fermes : -![Configuration des fermes](images/farms.png){.thumbnail} +![Farm configuration](images/farms.png){.thumbnail} -### Les frontends +## Front-ends -Toute la magie du déploiement **Blue-Green** se situe au niveau de la configuration de vos frontends. A ce stade nous avons configuré 2 infrastructures fonctionnellement jumelles en déclarant, pour chaque infrastructure, une (ou plusieurs) ferme(s) de serveurs, avec pour chaque ferme son (ses) serveur(s) associé(s). +La magie du déploiement **blue-green** réside dans la configuration de vos front-ends. À ce stade, nous avons configuré deux infrastructures fonctionnellement identiques. Pour les deux infrastructures, vous avez déclaré une ou plusieurs fermes de serveurs, chacune avec son propre ensemble de serveurs associés. -Pour permettre de basculer simplement d'une infrastructure à une autre, nous allons nous servir des frontends. +Pour basculer simplement d'une infrastructure à l'autre, nous utiliserons des front-ends. -Pour cela, nous devons déclarer 2 frontends. Le premier permettra d'accéder à l'infrastructure de production tandis que le second se chargera des accès à l'infrastructure de développement. Les accès à l'une ou l'autre des infrastructures seront controlés grâce aux ports exposés à vos clients. +Pour ce faire, nous devons déclarer deux front-ends. Le premier vous donnera accès à votre infrastructure de production, tandis que le second vous donnera accès à votre infrastructure de développement. Vous pouvez contrôler l'accès à une infrastructure ou à l'autre en utilisant les ports que vous exposez à vos clients. > [!warning] > -> Si le service final exposé à vos clients nécessite plusieurs fermes de serveurs (par exemple : les ports 80 et 443), vous devrez déclarer un **frontend** pour chacune de vos fermes. +> Si le service final que vous exposez à vos clients nécessite plusieurs fermes de serveurs (par ex. les ports 80 et 443), vous devrez déclarer un **front-end** pour chacune de vos fermes. > -#### Frontend Blue +### Front-end Blue -Ce **frontend** est dédié aux accès à l'infrastructure de production, les ports exposés à vos clients sont les ports standards d'accès au service. Dans le cas présent, nous exposons un service HTTP. Nous allons donc utiliser le port 80 (443 si vous souhaitez une terminaison SSL). +Ce **front-end** est dédié à l'accès à l'infrastructure de production. Les ports exposés à vos clients sont les ports standard pour l'accès au service. Dans ce cas, nous exposons un service HTTP, nous utiliserons donc le port 80 (443 si vous souhaitez une terminaison SSL). -Depuis l'espace client OVHcloud : +#### Via l'espace client OVHcloud -![Ajout du frontend dédié à la production, Blue Frontend](images/frontend1.png){.thumbnail} +![Adding a front-end dedicated to production, a blue front-end](images/frontend1.png){.thumbnail} -![Renseigner la configuration du frontend Blue](images/fblue.png){.thumbnail} +![Enter the blue front-end’s configuration](images/fblue.png){.thumbnail} -Depuis l'API OVHcloud : +#### Via l'API OVHcloud > [!api] > @@ -211,23 +206,23 @@ Depuis l'API OVHcloud : |Paramètre|Requis|Signification|Exemple| |---|---|---|---| -|serviceName|Requis|L'identifiant de votre Load Balancer|loadbalancer-XXXXXXXXXXX| -|defaultFarmId||L'identifiant de la ferme de production|151917| -|displayName||Le nom donné au frontend|Blue Frontend| -|port|Requis|Le port exposé par votre frontend à vos clients|80| -|zone|Requis|La zone dans laquelle vous souhaitez déployer votre frontend|all| +|serviceName|Requis|Votre ID de service Load Balancer|loadbalancer-abcdef0123456789| +|defaultFarmId||Votre ID de ferme de production|77212| +|displayName||Le nom donné au front-end|Blue front-end| +|port|Requis|Le port exposé à vos clients par votre front-end|80| +|zone|Requis|La zone dans laquelle vous souhaitez déployer votre front-end|all| -#### Frontend Green +### Front-end Green -Ce **frontend** est dédié aux accès à l'infrastructure de développement, les ports exposés à vos clients seront des ports non-standards que vous pouvez choisir arbitrairement. Dans le cas présent, nous allons exposer le service HTTP de développement sur le port 8888. +Ce **front-end** est dédié à l'accès à l'infrastructure de développement. Les ports exposés à vos clients seront des ports non standard que vous pourrez choisir arbitrairement. Dans ce cas, nous exposerons le service de développement HTTP sur le port 8888. -Depuis l'espace client OVHcloud : +#### Via l'espace client OVHcloud -![Ajout du frontend dédié au développement, Green Frontend](images/frontend2.png){.thumbnail} +![Add the green front-end, dedicated to development](images/frontend2.png){.thumbnail} -![Renseigner la configuration du frontend Green](images/fgreen.png){.thumbnail} +![Enter the green front-end’s configuration](images/fgreen.png){.thumbnail} -Depuis l'API OVHcloud : +#### Via l'API OVHcloud > [!api] > @@ -236,23 +231,23 @@ Depuis l'API OVHcloud : |Paramètre|Requis|Signification|Exemple| |---|---|---|---| -|serviceName|Requis|L'identifiant de votre Load Balancer|loadbalancer-xxxxxxxxxx| -|defaultFarmId||L'identifiant de la ferme de production|151918| -|displayName||Le nom donné au frontend|Green Frontend| -|port|Requis|Le port exposé par votre frontend à vos clients|8888| -|zone|Requis|La zone dans laquelle vous souhaitez déployer votre frontend|all| +|serviceName|Requis|Votre ID de service Load Balancer|loadbalancer-abcdef0123456789| +|defaultFarmId||Votre ID de ferme de production|77213| +|displayName||Le nom donné au front-end|Green front-end| +|port|Requis|Le port exposé à vos clients par votre front-end|8888| +|zone|Requis|La zone dans laquelle vous souhaitez déployer votre front-end|all| -### Gérer les déploiements +## Gestion des déploiements -#### Déploiement initial +### Déploiement initial -Après avoir finalisé la configuration des différents composants de votre service OVHcloud Load Balancer, il ne vous reste plus qu'à appliquer vos changements. +Une fois que vous avez terminé de configurer les composants du service Load Balancer OVHcloud, il ne vous reste plus qu'à appliquer vos modifications. -Depuis l'espace client OVHcloud : +#### Via l'espace client OVHcloud -![Appliquer vos changements sur la zone](images/deploy.png){.thumbnail} +![Apply your changes to the zone](images/deploy.png){.thumbnail} -Depuis l'API OVHcloud : +#### Via l'API OVHcloud > [!api] > @@ -261,32 +256,30 @@ Depuis l'API OVHcloud : |Paramètre|Signification| |---|---| -|serviceName|L'identifiant de votre service Load Balancer| - -#### Bascule production / preproduction +|serviceName|Votre ID de service Load Balancer| -À ce stade, notre environnement initial est déployé et prêt à être utilisé. Comment l'utiliser ? +### Changement de production ou de mise en scène -De manière assez simple, il suffira désormais de basculer vos frontends d'une ferme de serveur à une autre ! +À ce stade, notre environnement initial est déployé et prêt à l'emploi. Maintenant, vous devez basculer vos front-ends d'une ferme de serveurs à une autre. -Reprenons notre scénario : +Prenons notre scénario : -- l'infrastructure de production (A) est déployée sur la **Ferme HTTP A** (id 197529) qui est elle même attachée au **Serveur HTTP A**. L'accès à cette infrastructure se fait par l'intermédiaire du **Frontend Blue**. -- l'infrastructure de développement (B) est déployée sur la **Ferme HTTP B** (id 197530) qui est elle même attachée au **Serveur HTTP B**. L'accès à cette infrastructure se fait par l'intermédiaire du **Frontend Green**. +- L'infrastructure de production (A) est déployée sur la **ferme HTTP A** (id 77212), qui est elle-même attachée au **serveur HTTP A**. Cette infrastructure est accessible via le **front-end blue**. +- L'infrastructure de développement (B) est déployée sur la **ferme HTTP B** (id 77213), qui est elle-même attachée au **serveur HTTP B**. Cette infrastructure est accessible via le **front-end green**. -Après avoir réalisé vos modifications / mises à jour sur l'**infrastructure B** et validé le bon fonctionnement du service, vous décidez de l'assigner à la production. +Une fois que vous avez modifié/appliqué les mises à jour à l'**infrastructure B** et vérifié que le service fonctionne correctement, vous décidez de la mettre en production. -Pour faire la bascule entre les 2 fermes, il suffira simplement de mettre à jour vos différents frontends en modifiant l'identifiant de la ferme à laquelle ils sont rattachés et d'appliquer la modification. +Pour basculer entre les deux fermes, vous pouvez simplement mettre à jour vos différents front-ends en modifiant l'ID de la ferme à laquelle il est attaché, et en appliquant la modification. -Le **Frontend Blue** (id 151917) va donc être associé à la **Ferme B** (infrastructure B, nouvelle production, id 197530). +Le **front-end blue** (id 70089) sera alors associé à la **Ferme B** (infrastructure B, nouvelle production, id 77213). -Le **Frontend Green** (id 151918) quant à lui sera désormais associé à la **Ferme A** (infrastructure A, nouveau développement, id 197529). +Le **front-end green** (id 70090) sera alors associé à la **Ferme A** (infrastructure A, nouveau développement, id 77212). -Résultat sur l'espace client après la mise à jour des frontends et application de la nouvelle configuration : +Voici le résultat attendu dans l'espace client OVHcloud après la mise à jour des front-ends et l'application de la nouvelle configuration : -![Résultat après la mise à jour des frontends](images/switch.png){.thumbnail} +![Result after updating front-ends](images/switch.png){.thumbnail} -Depuis l'API OVHcloud : mise à jour des frontends et application des modifications +#### Via l'API OVHcloud : mise à jour des front-ends et application des modifications > [!api] > @@ -295,9 +288,9 @@ Depuis l'API OVHcloud : mise à jour des frontends et application des modificati |Paramètre|Signification|Exemple| |---|---|---| -|ServiceName|L'identifiant de votre service Load Balancer|loadbalancer-xxxxxxxxxxx| -|frontendId|L'identifiant de votre frontend de production|151917| -|defaultFarmId|L'identifiant de votre ferme de serveurs de développement|151918| +|serviceName|Votre ID de service Load Balancer|loadbalancer-abcdef0123456789| +|frontendId|Votre ID de front-end de production|70089| +|defaultFarmId|Votre ID de ferme de serveurs de développement|77213| > [!api] > @@ -306,11 +299,11 @@ Depuis l'API OVHcloud : mise à jour des frontends et application des modificati |Paramètre|Signification|Exemple| |---|---|---| -|ServiceName|L'identifiant de votre service Load Balancer|loadbalancer-xxxxxxxxxxx| -|frontendId|L'identifiant de votre frontend de production|151917| -|defaultFarmId|L'identifiant de votre ferme de serveurs de développement|197530| +|serviceName|Votre ID de service Load Balancer|loadbalancer-abcdef0123456789| +|frontendId|Votre ID de front-end de production|70090| +|defaultFarmId|Votre ID de ferme de serveurs de développement|77212| -Utilisez l'appel API suivant pour appliquer vos changements et réaliser effectivement la bascule production / développement : +#### Appliquer vos modifications et basculer effectivement les environnements de production et de développement > [!api] > @@ -319,18 +312,18 @@ Utilisez l'appel API suivant pour appliquer vos changements et réaliser effecti |Paramètre|Signification| |---|---| -|serviceName|L'identifiant de votre service Load Balancer| +|serviceName|Votre ID de service Load Balancer| ## Conclusion -Vous disposez désormais d'une infrastructure vous permettant de gérer simplement et efficacement vos déploiements **Blue-Green**. +Vous avez réussi à mettre en œuvre une infrastructure hautement disponible pour la gestion des déploiements blue-green. -Les développeurs disposent d'un accès à l'infrastructure de développement sur le port 8888 (ou tout autre port que vous souhaiteriez définir) tandis que vos clients continuent d'accéder au service en production via le port HTTP standard (80 dans le cas de notre exemple). +Les développeurs ont accès à un environnement de développement sur le port 8888 (ou tout port non standard configurable), tandis que vos clients continuent d'accéder au service en production via le port HTTP standard (80). -L'infrastructure présentée ici se limite à l'exposition d'un seul et unique port, elle peut bien entendue être développée en ajoutant d'autres ports. Par exemple, vous pouvez vouloir également exposer votre site sur le port HTTPS standard (443). Ceci peut se faire en définissant de nouvelles fermes dédiées à chaque nouveau port que vous souhaitez exposer, et en les associant à leurs frontends correspondants (le premier pour le port standard exposé en production, le second pour le port arbitraire dédié aux développements). +L'infrastructure présentée ici est limitée à un seul port, mais elle peut être étendue en ajoutant d'autres ports. Par exemple, vous pouvez également exposer votre site Web sur le port HTTPS standard (443). Vous pouvez le faire en définissant de nouvelles fermes dédiées à chaque port que vous souhaitez exposer, et en les associant à leurs front-ends correspondants (un pour le port standard exposé en production, le second pour le port arbitraire dédié au développement). -Une autre possibilité pour consolider encore un peu plus votre infrastructure est de multiplier les serveurs attachés à votre (vos) ferme(s). Ceci vous permettra d'ajouter à la simplicité de réalisation de vos déploiements une redondance de vos services (garantissant ainsi leur disponibilité) ainsi qu'une capacité de répartition de charge. +Une autre façon de consolider davantage votre infrastructure est de multiplier les serveurs attachés à vos fermes. De cette façon, vous pouvez rendre vos services plus redondants (garantissant ainsi la disponibilité) et ajouter également une capacité d'équilibrage de charge. ## Aller plus loin -Échangez avec notre [communauté d'utilisateurs](/links/community). +Échangez avec notre [communauté d'utilisateurs](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/case_blue_green/images/backend1.png b/pages/network/load_balancer/case_blue_green/images/backend1.png deleted file mode 100644 index 744747db944..00000000000 Binary files a/pages/network/load_balancer/case_blue_green/images/backend1.png and /dev/null differ diff --git a/pages/network/load_balancer/case_smtp/guide.en-asia.md b/pages/network/load_balancer/case_smtp/guide.en-asia.md index 81712ab5352..6ff6bd90aa2 100644 --- a/pages/network/load_balancer/case_smtp/guide.en-asia.md +++ b/pages/network/load_balancer/case_smtp/guide.en-asia.md @@ -1,71 +1,67 @@ --- -title: 'Configuring SMTP on a Load Balancer service' -excerpt: 'Find out how to use SMTP with the OVH Load Balancer' -updated: 2018-12-28 +title: 'How to configure SMTP on a Load Balancer service' +excerpt: 'Find out how to use SMTP with the OVHcloud Load Balancer' +updated: 2025-10-24 --- ## Objective -In this guide, we will configure a basic TCP load balancing service, for one or more SMTP servers. A TCP front-end will listen to TCP traffic on port 25. It is configured to direct traffic to a TCP farm with one or more TCP servers, depending on how you choose to configure it. +**This guide outlines how to configure the OVHcloud Load Balancer to distribute traffic across multiple SMTP servers.** -**This guide is designed to help you configure an OVH Load Balancer service in order to balance load across several servers that respond in SMTP.** +## Requirements -> [!warning] -> -> Questions on what an SMTP service is and how it works will not be covered here. This guide is aimed at readers who have a general understanding of SMTP, or practical experience with it. -> +- An [OVHcloud Load balancer](/links/network/load-balancer) service in your OVHcloud account. +- Access to the [OVHcloud Control Panel](/links/manager). +- A Postfix-type SMTP service installed and configured on your servers. -> [!warning] -> -> We will assume that you already have a Postfix SMTP service set up and configured your servers. -> +## Instructions > [!warning] > -> This guide will take you through the steps required. Depending on the way you have designed your architecture, some configurations may vary. +> This guide assumes a working knowledge of SMTP protocol and service operation. > -As a reminder, each protocol (HTTP, TCP and UDP) in the OVH Load Balancer service has its own associated front-ends, farms and servers. +As a reminder, each protocol (HTTP, TCP and UDP) in the OVHcloud Load Balancer service has its own associated front-ends, farms and servers. > [!warning] > -> The order in which elements are created is important. In particular, the server farms must be configured before we can attach servers to them. +> The order in which elements are created is important. In particular, the server farms must be configured before servers can be attached to them. > -In the Sunrise Control Panel, you will see the features detailed below: +In the Control Panel, you will see the features detailed below: -![OVH Load Balancer service](images/iplb_service.png){.thumbnail} +![OVHcloud Load Balancer service](images/iplb_service.png){.thumbnail} -Via the OVH API, in the section: +Via the OVHcloud API, use the following call: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing > -For more information on the API’s features, you can refer to the following guide: [Load Balancer API Quick Reference](/pages/network/load_balancer/use_api_reference){.ref} +For more information on the API features, you can refer to [the following guide](/pages/network/load_balancer/use_api_reference). -## Add a server farm. +### Add a server farm -We will add a farm of TCP servers to our service, which is the part that balances traffic on the servers. +A TCP server farm must be added to the service; this component manages traffic balancing across the servers. -### Via the Sunrise Control Panel. +#### Via the OVHcloud Control Panel In the `Farms`{.action} tab for servers, click on the `+TCP/TLS`{.action} button. -Fill in the fields. The mandatory fields for a basic configuration are *Port* and *Zone*. In our case, for SMTP, port 25 is used. If no ports are specified, your OVH Load Balancer will automatically use the same port as the corresponding front-end. +Fill in the fields. The mandatory fields for a basic configuration are *Port* and *Zone*. For SMTP, port 25 is used. If no ports are specified, your OVHcloud Load Balancer will automatically use the same port as the corresponding front-end. -As an option, you can add an SMTP probe on your farm. +Optionally, you can add an SMTP probe on your farm. ![Add a server farm via the Control Panel](images/add_farm.png){.thumbnail} -Click `Add`{.action} once you have filled in the fields. +Click on `Add`{.action} once you have filled in the fields. Your server farm should appear in the list, in the `Farms`{.action} tab. ![Details of the server farm created](images/resume_farm.png){.thumbnail} -### Via the API +#### Via the OVHcloud API - List of TCP server farms: @@ -74,7 +70,7 @@ Your server farm should appear in the list, in the `Farms`{.action} tab. > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm > -- Details of a specific TCP server: +- Details of a specific TCP server farm: > [!api] > @@ -102,30 +98,30 @@ Your server farm should appear in the list, in the `Farms`{.action} tab. > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId} > -## Add a server. +### Add a server -We will now add a server to our server farm. +A server must now be added to the server farm. -### Via the Sunrise Control Panel. +#### Via the OVHcloud Control Panel -In the `Farms`{.action} tab, select the farm you want to add a server to by clicking on the corresponding line. The list of servers already configured in the farm will appear beneath the list of farms, along with the `Add a server`{.action} button. Click on this button to add a new server. +In the `Farms`{.action} tab, select the farm you want to add a server to by clicking on the corresponding line. The list of servers already configured in the farm will appear beneath the list of farms, along with the `Add a server`{.action} button. Click this button to add a new server. -Only the *IPv4 address*, *Status* and *ProxyProtocol version* fields are mandatory. If a server does not use the same port as the one defined earlier in the farm, you may overload it by configuring a server. However, to keep the configuration as standard as possible and easy to maintain, we recommend only using this parameter in advanced cases. +The mandatory fields are the *IPv4 address*, *Status*, and *ProxyProtocol version*. If a server port is configured, it will override the port defined in the farm. To keep the configuration as standard as possible and easy to maintain, we recommend only using this parameter in advanced cases. > [!warning] > -> It is important to configure ProxyProtocol in version v1, so that you can get the real source IP on your SMTP service. Postfix is compatible with this protocol. +> It is important to configure ProxyProtocol in version v1 so that you can retrieve the real source IP on your SMTP service. Postfix is compatible with this protocol. > ![Add a server to a farm.](images/add_server.png){.thumbnail} -Click `Add`{.action} once you have filled in the fields. +Click on `Add`{.action} once you have filled in the fields. Your server should appear in the server list, in the `Farms`{.action} tab, just below the list of farms. ![Details of the server created.](images/resume_server.png){.thumbnail} -### Via the API +#### Via the OVHcloud API - List of servers in the farm: @@ -162,29 +158,29 @@ Your server should appear in the server list, in the `Farms`{.action} tab, just > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server > -## Add a front-end +### Add a front-end -We will now add a `front-end`{.action} to our service, and connect it to our server farm. The front-end is the part of your OVH Load Balancer that exposes your service on the internet. +A `front-end`{.action} must now be added to the service and connected to the server farm. The front-end is the component of your OVHcloud Load Balancer that exposes your service to the internet. -### Via the Sunrise Control Panel. +#### Via the OVHcloud Control Panel Go to the `+ Front-ends`{.action} tab, and click `+TCP/TLS`{.action}. -Fill in the fields. The only mandatory fields for a basic configuration are *Port* (25 for a standard SMTP service), *Zone* and *Probe*, if you configured a probe on your farm. If you want your service to be available across several ports at once, you can specify a list of ports, separated by commas, or a range of ports, in the format "start_port-end_port". +Fill in the fields. The mandatory fields for a basic configuration are *Port* (25 for a standard SMTP service), *Zone*, *Default farm* and *Probe* (if a probe was configured on your farm). If you want your service to be available across several ports at once, you can specify a list of ports, separated by commas, or a port range, in the format "-". -If you have routed Additional IPs to your OVH Load Balancer service, you can also attach a front-end to one or more specific Additional IPs. +If you have routed Additional IPs to your OVHcloud Load Balancer service, you can also attach a front-end to one or more specific Additional IPs. -Please remember to specify the farm you created earlier as a “default farm”. +Ensure the farm you created earlier is specified as the “default farm”. ![Add a front-end](images/add_frontend.png){.thumbnail} -Click `Add`{.action} once you have filled in the fields. +Click `Add`{.action} once the fields are filled. Your front-end must appear in the list, in the `Front-ends`{.action} tab. ![Details of the front-end created](images/resume_frontend.png){.thumbnail} -### Via the API +#### Via the OVHcloud API - List of TCP front-ends: @@ -221,17 +217,17 @@ Your front-end must appear in the list, in the `Front-ends`{.action} tab. > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId} > -## Apply the modifications +### Apply the modifications -The modifications made to your OVH Load Balancer must be *explicitly applied* in each of the zones configured for your service. Only at this point will they be visible to your website visitors. This way, you can make complex configuration changes several times, and only apply them once the configuration is ready. +Modifications made to your OVHcloud Load Balancer must be **explicitly applied** in each of the zones configured for your service. They will only become visible to your users at this point. This process allows for complex configuration changes to be prepared and applied only when fully ready. -If you have several zones, you must apply the same configuration for each of them. +If you have several zones, the same configuration must be applied to each. -### Via the Sunrise Control Panel. +#### Via the OVHcloud Control Panel -Go the homepage for the OVH Load Balancer, and click `Apply:Zone`{.action} for each of the zones concerned. +Go to the homepage for the OVHcloud Load Balancer, and click `Apply:Zone`{.action} for each of the zones concerned. -### Via the API. +#### Via the OVHcloud API - Refresh a zone: @@ -240,21 +236,22 @@ Go the homepage for the OVH Load Balancer, and click `Apply:Zone`{.action} for e > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh > -## Postfix configuration. +### Postfix configuration To make Postfix compatible with HAProxy *ProxyProtocol*, an option is required in the postfix main.cf configuration file: -**smtp_upstream_proxy_protocol = haproxy** +```bash +smtp_upstream_proxy_protocol = haproxy +``` -You then need to restart your Postfix daemon. +The Postfix daemon must then be restarted. -## Confirmation. +### Confirmation -After you have completed all of these steps, you should now have a functional Load Balancer service for your SMTP servers. You can now check the service status by requesting your IP Load Balancer as an SMTP server. +Upon completing these steps, you will have a functional Load Balancer service for your SMTP servers. The service status can now be checked by requesting your IP Load Balancer as an SMTP server. ![Connection to SMTP via telnet](images/resume_validate.png){.thumbnail} ## Go further -Join our community of users on . - +Join our [community of users](/links/community). diff --git a/pages/network/load_balancer/case_smtp/guide.en-ca.md b/pages/network/load_balancer/case_smtp/guide.en-ca.md index 81712ab5352..6ff6bd90aa2 100644 --- a/pages/network/load_balancer/case_smtp/guide.en-ca.md +++ b/pages/network/load_balancer/case_smtp/guide.en-ca.md @@ -1,71 +1,67 @@ --- -title: 'Configuring SMTP on a Load Balancer service' -excerpt: 'Find out how to use SMTP with the OVH Load Balancer' -updated: 2018-12-28 +title: 'How to configure SMTP on a Load Balancer service' +excerpt: 'Find out how to use SMTP with the OVHcloud Load Balancer' +updated: 2025-10-24 --- ## Objective -In this guide, we will configure a basic TCP load balancing service, for one or more SMTP servers. A TCP front-end will listen to TCP traffic on port 25. It is configured to direct traffic to a TCP farm with one or more TCP servers, depending on how you choose to configure it. +**This guide outlines how to configure the OVHcloud Load Balancer to distribute traffic across multiple SMTP servers.** -**This guide is designed to help you configure an OVH Load Balancer service in order to balance load across several servers that respond in SMTP.** +## Requirements -> [!warning] -> -> Questions on what an SMTP service is and how it works will not be covered here. This guide is aimed at readers who have a general understanding of SMTP, or practical experience with it. -> +- An [OVHcloud Load balancer](/links/network/load-balancer) service in your OVHcloud account. +- Access to the [OVHcloud Control Panel](/links/manager). +- A Postfix-type SMTP service installed and configured on your servers. -> [!warning] -> -> We will assume that you already have a Postfix SMTP service set up and configured your servers. -> +## Instructions > [!warning] > -> This guide will take you through the steps required. Depending on the way you have designed your architecture, some configurations may vary. +> This guide assumes a working knowledge of SMTP protocol and service operation. > -As a reminder, each protocol (HTTP, TCP and UDP) in the OVH Load Balancer service has its own associated front-ends, farms and servers. +As a reminder, each protocol (HTTP, TCP and UDP) in the OVHcloud Load Balancer service has its own associated front-ends, farms and servers. > [!warning] > -> The order in which elements are created is important. In particular, the server farms must be configured before we can attach servers to them. +> The order in which elements are created is important. In particular, the server farms must be configured before servers can be attached to them. > -In the Sunrise Control Panel, you will see the features detailed below: +In the Control Panel, you will see the features detailed below: -![OVH Load Balancer service](images/iplb_service.png){.thumbnail} +![OVHcloud Load Balancer service](images/iplb_service.png){.thumbnail} -Via the OVH API, in the section: +Via the OVHcloud API, use the following call: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing > -For more information on the API’s features, you can refer to the following guide: [Load Balancer API Quick Reference](/pages/network/load_balancer/use_api_reference){.ref} +For more information on the API features, you can refer to [the following guide](/pages/network/load_balancer/use_api_reference). -## Add a server farm. +### Add a server farm -We will add a farm of TCP servers to our service, which is the part that balances traffic on the servers. +A TCP server farm must be added to the service; this component manages traffic balancing across the servers. -### Via the Sunrise Control Panel. +#### Via the OVHcloud Control Panel In the `Farms`{.action} tab for servers, click on the `+TCP/TLS`{.action} button. -Fill in the fields. The mandatory fields for a basic configuration are *Port* and *Zone*. In our case, for SMTP, port 25 is used. If no ports are specified, your OVH Load Balancer will automatically use the same port as the corresponding front-end. +Fill in the fields. The mandatory fields for a basic configuration are *Port* and *Zone*. For SMTP, port 25 is used. If no ports are specified, your OVHcloud Load Balancer will automatically use the same port as the corresponding front-end. -As an option, you can add an SMTP probe on your farm. +Optionally, you can add an SMTP probe on your farm. ![Add a server farm via the Control Panel](images/add_farm.png){.thumbnail} -Click `Add`{.action} once you have filled in the fields. +Click on `Add`{.action} once you have filled in the fields. Your server farm should appear in the list, in the `Farms`{.action} tab. ![Details of the server farm created](images/resume_farm.png){.thumbnail} -### Via the API +#### Via the OVHcloud API - List of TCP server farms: @@ -74,7 +70,7 @@ Your server farm should appear in the list, in the `Farms`{.action} tab. > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm > -- Details of a specific TCP server: +- Details of a specific TCP server farm: > [!api] > @@ -102,30 +98,30 @@ Your server farm should appear in the list, in the `Farms`{.action} tab. > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId} > -## Add a server. +### Add a server -We will now add a server to our server farm. +A server must now be added to the server farm. -### Via the Sunrise Control Panel. +#### Via the OVHcloud Control Panel -In the `Farms`{.action} tab, select the farm you want to add a server to by clicking on the corresponding line. The list of servers already configured in the farm will appear beneath the list of farms, along with the `Add a server`{.action} button. Click on this button to add a new server. +In the `Farms`{.action} tab, select the farm you want to add a server to by clicking on the corresponding line. The list of servers already configured in the farm will appear beneath the list of farms, along with the `Add a server`{.action} button. Click this button to add a new server. -Only the *IPv4 address*, *Status* and *ProxyProtocol version* fields are mandatory. If a server does not use the same port as the one defined earlier in the farm, you may overload it by configuring a server. However, to keep the configuration as standard as possible and easy to maintain, we recommend only using this parameter in advanced cases. +The mandatory fields are the *IPv4 address*, *Status*, and *ProxyProtocol version*. If a server port is configured, it will override the port defined in the farm. To keep the configuration as standard as possible and easy to maintain, we recommend only using this parameter in advanced cases. > [!warning] > -> It is important to configure ProxyProtocol in version v1, so that you can get the real source IP on your SMTP service. Postfix is compatible with this protocol. +> It is important to configure ProxyProtocol in version v1 so that you can retrieve the real source IP on your SMTP service. Postfix is compatible with this protocol. > ![Add a server to a farm.](images/add_server.png){.thumbnail} -Click `Add`{.action} once you have filled in the fields. +Click on `Add`{.action} once you have filled in the fields. Your server should appear in the server list, in the `Farms`{.action} tab, just below the list of farms. ![Details of the server created.](images/resume_server.png){.thumbnail} -### Via the API +#### Via the OVHcloud API - List of servers in the farm: @@ -162,29 +158,29 @@ Your server should appear in the server list, in the `Farms`{.action} tab, just > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server > -## Add a front-end +### Add a front-end -We will now add a `front-end`{.action} to our service, and connect it to our server farm. The front-end is the part of your OVH Load Balancer that exposes your service on the internet. +A `front-end`{.action} must now be added to the service and connected to the server farm. The front-end is the component of your OVHcloud Load Balancer that exposes your service to the internet. -### Via the Sunrise Control Panel. +#### Via the OVHcloud Control Panel Go to the `+ Front-ends`{.action} tab, and click `+TCP/TLS`{.action}. -Fill in the fields. The only mandatory fields for a basic configuration are *Port* (25 for a standard SMTP service), *Zone* and *Probe*, if you configured a probe on your farm. If you want your service to be available across several ports at once, you can specify a list of ports, separated by commas, or a range of ports, in the format "start_port-end_port". +Fill in the fields. The mandatory fields for a basic configuration are *Port* (25 for a standard SMTP service), *Zone*, *Default farm* and *Probe* (if a probe was configured on your farm). If you want your service to be available across several ports at once, you can specify a list of ports, separated by commas, or a port range, in the format "-". -If you have routed Additional IPs to your OVH Load Balancer service, you can also attach a front-end to one or more specific Additional IPs. +If you have routed Additional IPs to your OVHcloud Load Balancer service, you can also attach a front-end to one or more specific Additional IPs. -Please remember to specify the farm you created earlier as a “default farm”. +Ensure the farm you created earlier is specified as the “default farm”. ![Add a front-end](images/add_frontend.png){.thumbnail} -Click `Add`{.action} once you have filled in the fields. +Click `Add`{.action} once the fields are filled. Your front-end must appear in the list, in the `Front-ends`{.action} tab. ![Details of the front-end created](images/resume_frontend.png){.thumbnail} -### Via the API +#### Via the OVHcloud API - List of TCP front-ends: @@ -221,17 +217,17 @@ Your front-end must appear in the list, in the `Front-ends`{.action} tab. > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId} > -## Apply the modifications +### Apply the modifications -The modifications made to your OVH Load Balancer must be *explicitly applied* in each of the zones configured for your service. Only at this point will they be visible to your website visitors. This way, you can make complex configuration changes several times, and only apply them once the configuration is ready. +Modifications made to your OVHcloud Load Balancer must be **explicitly applied** in each of the zones configured for your service. They will only become visible to your users at this point. This process allows for complex configuration changes to be prepared and applied only when fully ready. -If you have several zones, you must apply the same configuration for each of them. +If you have several zones, the same configuration must be applied to each. -### Via the Sunrise Control Panel. +#### Via the OVHcloud Control Panel -Go the homepage for the OVH Load Balancer, and click `Apply:Zone`{.action} for each of the zones concerned. +Go to the homepage for the OVHcloud Load Balancer, and click `Apply:Zone`{.action} for each of the zones concerned. -### Via the API. +#### Via the OVHcloud API - Refresh a zone: @@ -240,21 +236,22 @@ Go the homepage for the OVH Load Balancer, and click `Apply:Zone`{.action} for e > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh > -## Postfix configuration. +### Postfix configuration To make Postfix compatible with HAProxy *ProxyProtocol*, an option is required in the postfix main.cf configuration file: -**smtp_upstream_proxy_protocol = haproxy** +```bash +smtp_upstream_proxy_protocol = haproxy +``` -You then need to restart your Postfix daemon. +The Postfix daemon must then be restarted. -## Confirmation. +### Confirmation -After you have completed all of these steps, you should now have a functional Load Balancer service for your SMTP servers. You can now check the service status by requesting your IP Load Balancer as an SMTP server. +Upon completing these steps, you will have a functional Load Balancer service for your SMTP servers. The service status can now be checked by requesting your IP Load Balancer as an SMTP server. ![Connection to SMTP via telnet](images/resume_validate.png){.thumbnail} ## Go further -Join our community of users on . - +Join our [community of users](/links/community). diff --git a/pages/network/load_balancer/case_smtp/guide.en-gb.md b/pages/network/load_balancer/case_smtp/guide.en-gb.md index 148b5f7fe61..6ff6bd90aa2 100644 --- a/pages/network/load_balancer/case_smtp/guide.en-gb.md +++ b/pages/network/load_balancer/case_smtp/guide.en-gb.md @@ -1,71 +1,67 @@ --- -title: 'Configuring SMTP on a Load Balancer service' -excerpt: 'Find out how to use SMTP with the OVH Load Balancer' -updated: 2018-12-28 +title: 'How to configure SMTP on a Load Balancer service' +excerpt: 'Find out how to use SMTP with the OVHcloud Load Balancer' +updated: 2025-10-24 --- ## Objective -In this guide, we will configure a basic TCP load balancing service, for one or more SMTP servers. A TCP front-end will listen to TCP traffic on port 25. It is configured to direct traffic to a TCP farm with one or more TCP servers, depending on how you choose to configure it. +**This guide outlines how to configure the OVHcloud Load Balancer to distribute traffic across multiple SMTP servers.** -**This guide is designed to help you configure an OVH Load Balancer service in order to balance load across several servers that respond in SMTP.** +## Requirements -> [!warning] -> -> Questions on what an SMTP service is and how it works will not be covered here. This guide is aimed at readers who have a general understanding of SMTP, or practical experience with it. -> +- An [OVHcloud Load balancer](/links/network/load-balancer) service in your OVHcloud account. +- Access to the [OVHcloud Control Panel](/links/manager). +- A Postfix-type SMTP service installed and configured on your servers. -> [!warning] -> -> We will assume that you already have a Postfix SMTP service set up and configured your servers. -> +## Instructions > [!warning] > -> This guide will take you through the steps required. Depending on the way you have designed your architecture, some configurations may vary. +> This guide assumes a working knowledge of SMTP protocol and service operation. > -As a reminder, each protocol (HTTP, TCP and UDP) in the OVH Load Balancer service has its own associated front-ends, farms and servers. +As a reminder, each protocol (HTTP, TCP and UDP) in the OVHcloud Load Balancer service has its own associated front-ends, farms and servers. > [!warning] > -> The order in which elements are created is important. In particular, the server farms must be configured before we can attach servers to them. +> The order in which elements are created is important. In particular, the server farms must be configured before servers can be attached to them. > -In the Sunrise Control Panel, you will see the features detailed below: +In the Control Panel, you will see the features detailed below: -![OVH Load Balancer service](images/iplb_service.png){.thumbnail} +![OVHcloud Load Balancer service](images/iplb_service.png){.thumbnail} -Via the OVH API, in the section: +Via the OVHcloud API, use the following call: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing > -For more information on the API’s features, you can refer to [the following guide in French](/pages/network/load_balancer/use_api_reference). +For more information on the API features, you can refer to [the following guide](/pages/network/load_balancer/use_api_reference). -## Add a server farm. +### Add a server farm -We will add a farm of TCP servers to our service, which is the part that balances traffic on the servers. +A TCP server farm must be added to the service; this component manages traffic balancing across the servers. -### Via the Sunrise Control Panel. +#### Via the OVHcloud Control Panel In the `Farms`{.action} tab for servers, click on the `+TCP/TLS`{.action} button. -Fill in the fields. The mandatory fields for a basic configuration are *Port* and *Zone*. In our case, for SMTP, port 25 is used. If no ports are specified, your OVH Load Balancer will automatically use the same port as the corresponding front-end. +Fill in the fields. The mandatory fields for a basic configuration are *Port* and *Zone*. For SMTP, port 25 is used. If no ports are specified, your OVHcloud Load Balancer will automatically use the same port as the corresponding front-end. -As an option, you can add an SMTP probe on your farm. +Optionally, you can add an SMTP probe on your farm. ![Add a server farm via the Control Panel](images/add_farm.png){.thumbnail} -Click `Add`{.action} once you have filled in the fields. +Click on `Add`{.action} once you have filled in the fields. Your server farm should appear in the list, in the `Farms`{.action} tab. ![Details of the server farm created](images/resume_farm.png){.thumbnail} -### Via the API +#### Via the OVHcloud API - List of TCP server farms: @@ -74,7 +70,7 @@ Your server farm should appear in the list, in the `Farms`{.action} tab. > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm > -- Details of a specific TCP server: +- Details of a specific TCP server farm: > [!api] > @@ -102,30 +98,30 @@ Your server farm should appear in the list, in the `Farms`{.action} tab. > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId} > -## Add a server. +### Add a server -We will now add a server to our server farm. +A server must now be added to the server farm. -### Via the Sunrise Control Panel. +#### Via the OVHcloud Control Panel -In the `Farms`{.action} tab, select the farm you want to add a server to by clicking on the corresponding line. The list of servers already configured in the farm will appear beneath the list of farms, along with the `Add a server`{.action} button. Click on this button to add a new server. +In the `Farms`{.action} tab, select the farm you want to add a server to by clicking on the corresponding line. The list of servers already configured in the farm will appear beneath the list of farms, along with the `Add a server`{.action} button. Click this button to add a new server. -Only the *IPv4 address*, *Status* and *ProxyProtocol version* fields are mandatory. If a server does not use the same port as the one defined earlier in the farm, you may overload it by configuring a server. However, to keep the configuration as standard as possible and easy to maintain, we recommend only using this parameter in advanced cases. +The mandatory fields are the *IPv4 address*, *Status*, and *ProxyProtocol version*. If a server port is configured, it will override the port defined in the farm. To keep the configuration as standard as possible and easy to maintain, we recommend only using this parameter in advanced cases. > [!warning] > -> It is important to configure ProxyProtocol in version v1, so that you can get the real source IP on your SMTP service. Postfix is compatible with this protocol. +> It is important to configure ProxyProtocol in version v1 so that you can retrieve the real source IP on your SMTP service. Postfix is compatible with this protocol. > ![Add a server to a farm.](images/add_server.png){.thumbnail} -Click `Add`{.action} once you have filled in the fields. +Click on `Add`{.action} once you have filled in the fields. Your server should appear in the server list, in the `Farms`{.action} tab, just below the list of farms. ![Details of the server created.](images/resume_server.png){.thumbnail} -### Via the API +#### Via the OVHcloud API - List of servers in the farm: @@ -162,29 +158,29 @@ Your server should appear in the server list, in the `Farms`{.action} tab, just > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server > -## Add a front-end +### Add a front-end -We will now add a `front-end`{.action} to our service, and connect it to our server farm. The front-end is the part of your OVH Load Balancer that exposes your service on the internet. +A `front-end`{.action} must now be added to the service and connected to the server farm. The front-end is the component of your OVHcloud Load Balancer that exposes your service to the internet. -### Via the Sunrise Control Panel. +#### Via the OVHcloud Control Panel Go to the `+ Front-ends`{.action} tab, and click `+TCP/TLS`{.action}. -Fill in the fields. The only mandatory fields for a basic configuration are *Port* (25 for a standard SMTP service), *Zone* and *Probe*, if you configured a probe on your farm. If you want your service to be available across several ports at once, you can specify a list of ports, separated by commas, or a range of ports, in the format "start_port-end_port". +Fill in the fields. The mandatory fields for a basic configuration are *Port* (25 for a standard SMTP service), *Zone*, *Default farm* and *Probe* (if a probe was configured on your farm). If you want your service to be available across several ports at once, you can specify a list of ports, separated by commas, or a port range, in the format "-". -If you have routed Additional IPs to your OVH Load Balancer service, you can also attach a front-end to one or more specific Additional IPs. +If you have routed Additional IPs to your OVHcloud Load Balancer service, you can also attach a front-end to one or more specific Additional IPs. -Please remember to specify the farm you created earlier as a “default farm”. +Ensure the farm you created earlier is specified as the “default farm”. ![Add a front-end](images/add_frontend.png){.thumbnail} -Click `Add`{.action} once you have filled in the fields. +Click `Add`{.action} once the fields are filled. Your front-end must appear in the list, in the `Front-ends`{.action} tab. ![Details of the front-end created](images/resume_frontend.png){.thumbnail} -### Via the API +#### Via the OVHcloud API - List of TCP front-ends: @@ -221,17 +217,17 @@ Your front-end must appear in the list, in the `Front-ends`{.action} tab. > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId} > -## Apply the modifications +### Apply the modifications -The modifications made to your OVH Load Balancer must be *explicitly applied* in each of the zones configured for your service. Only at this point will they be visible to your website visitors. This way, you can make complex configuration changes several times, and only apply them once the configuration is ready. +Modifications made to your OVHcloud Load Balancer must be **explicitly applied** in each of the zones configured for your service. They will only become visible to your users at this point. This process allows for complex configuration changes to be prepared and applied only when fully ready. -If you have several zones, you must apply the same configuration for each of them. +If you have several zones, the same configuration must be applied to each. -### Via the Sunrise Control Panel. +#### Via the OVHcloud Control Panel -Go the homepage for the OVH Load Balancer, and click `Apply:Zone`{.action} for each of the zones concerned. +Go to the homepage for the OVHcloud Load Balancer, and click `Apply:Zone`{.action} for each of the zones concerned. -### Via the API. +#### Via the OVHcloud API - Refresh a zone: @@ -240,21 +236,22 @@ Go the homepage for the OVH Load Balancer, and click `Apply:Zone`{.action} for e > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh > -## Postfix configuration. +### Postfix configuration To make Postfix compatible with HAProxy *ProxyProtocol*, an option is required in the postfix main.cf configuration file: -**smtp_upstream_proxy_protocol = haproxy** +```bash +smtp_upstream_proxy_protocol = haproxy +``` -You then need to restart your Postfix daemon. +The Postfix daemon must then be restarted. -## Confirmation. +### Confirmation -After you have completed all of these steps, you should now have a functional Load Balancer service for your SMTP servers. You can now check the service status by requesting your IP Load Balancer as an SMTP server. +Upon completing these steps, you will have a functional Load Balancer service for your SMTP servers. The service status can now be checked by requesting your IP Load Balancer as an SMTP server. ![Connection to SMTP via telnet](images/resume_validate.png){.thumbnail} ## Go further -Join our community of users on . - +Join our [community of users](/links/community). diff --git a/pages/network/load_balancer/case_smtp/guide.en-sg.md b/pages/network/load_balancer/case_smtp/guide.en-sg.md index 81712ab5352..6ff6bd90aa2 100644 --- a/pages/network/load_balancer/case_smtp/guide.en-sg.md +++ b/pages/network/load_balancer/case_smtp/guide.en-sg.md @@ -1,71 +1,67 @@ --- -title: 'Configuring SMTP on a Load Balancer service' -excerpt: 'Find out how to use SMTP with the OVH Load Balancer' -updated: 2018-12-28 +title: 'How to configure SMTP on a Load Balancer service' +excerpt: 'Find out how to use SMTP with the OVHcloud Load Balancer' +updated: 2025-10-24 --- ## Objective -In this guide, we will configure a basic TCP load balancing service, for one or more SMTP servers. A TCP front-end will listen to TCP traffic on port 25. It is configured to direct traffic to a TCP farm with one or more TCP servers, depending on how you choose to configure it. +**This guide outlines how to configure the OVHcloud Load Balancer to distribute traffic across multiple SMTP servers.** -**This guide is designed to help you configure an OVH Load Balancer service in order to balance load across several servers that respond in SMTP.** +## Requirements -> [!warning] -> -> Questions on what an SMTP service is and how it works will not be covered here. This guide is aimed at readers who have a general understanding of SMTP, or practical experience with it. -> +- An [OVHcloud Load balancer](/links/network/load-balancer) service in your OVHcloud account. +- Access to the [OVHcloud Control Panel](/links/manager). +- A Postfix-type SMTP service installed and configured on your servers. -> [!warning] -> -> We will assume that you already have a Postfix SMTP service set up and configured your servers. -> +## Instructions > [!warning] > -> This guide will take you through the steps required. Depending on the way you have designed your architecture, some configurations may vary. +> This guide assumes a working knowledge of SMTP protocol and service operation. > -As a reminder, each protocol (HTTP, TCP and UDP) in the OVH Load Balancer service has its own associated front-ends, farms and servers. +As a reminder, each protocol (HTTP, TCP and UDP) in the OVHcloud Load Balancer service has its own associated front-ends, farms and servers. > [!warning] > -> The order in which elements are created is important. In particular, the server farms must be configured before we can attach servers to them. +> The order in which elements are created is important. In particular, the server farms must be configured before servers can be attached to them. > -In the Sunrise Control Panel, you will see the features detailed below: +In the Control Panel, you will see the features detailed below: -![OVH Load Balancer service](images/iplb_service.png){.thumbnail} +![OVHcloud Load Balancer service](images/iplb_service.png){.thumbnail} -Via the OVH API, in the section: +Via the OVHcloud API, use the following call: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing > -For more information on the API’s features, you can refer to the following guide: [Load Balancer API Quick Reference](/pages/network/load_balancer/use_api_reference){.ref} +For more information on the API features, you can refer to [the following guide](/pages/network/load_balancer/use_api_reference). -## Add a server farm. +### Add a server farm -We will add a farm of TCP servers to our service, which is the part that balances traffic on the servers. +A TCP server farm must be added to the service; this component manages traffic balancing across the servers. -### Via the Sunrise Control Panel. +#### Via the OVHcloud Control Panel In the `Farms`{.action} tab for servers, click on the `+TCP/TLS`{.action} button. -Fill in the fields. The mandatory fields for a basic configuration are *Port* and *Zone*. In our case, for SMTP, port 25 is used. If no ports are specified, your OVH Load Balancer will automatically use the same port as the corresponding front-end. +Fill in the fields. The mandatory fields for a basic configuration are *Port* and *Zone*. For SMTP, port 25 is used. If no ports are specified, your OVHcloud Load Balancer will automatically use the same port as the corresponding front-end. -As an option, you can add an SMTP probe on your farm. +Optionally, you can add an SMTP probe on your farm. ![Add a server farm via the Control Panel](images/add_farm.png){.thumbnail} -Click `Add`{.action} once you have filled in the fields. +Click on `Add`{.action} once you have filled in the fields. Your server farm should appear in the list, in the `Farms`{.action} tab. ![Details of the server farm created](images/resume_farm.png){.thumbnail} -### Via the API +#### Via the OVHcloud API - List of TCP server farms: @@ -74,7 +70,7 @@ Your server farm should appear in the list, in the `Farms`{.action} tab. > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm > -- Details of a specific TCP server: +- Details of a specific TCP server farm: > [!api] > @@ -102,30 +98,30 @@ Your server farm should appear in the list, in the `Farms`{.action} tab. > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId} > -## Add a server. +### Add a server -We will now add a server to our server farm. +A server must now be added to the server farm. -### Via the Sunrise Control Panel. +#### Via the OVHcloud Control Panel -In the `Farms`{.action} tab, select the farm you want to add a server to by clicking on the corresponding line. The list of servers already configured in the farm will appear beneath the list of farms, along with the `Add a server`{.action} button. Click on this button to add a new server. +In the `Farms`{.action} tab, select the farm you want to add a server to by clicking on the corresponding line. The list of servers already configured in the farm will appear beneath the list of farms, along with the `Add a server`{.action} button. Click this button to add a new server. -Only the *IPv4 address*, *Status* and *ProxyProtocol version* fields are mandatory. If a server does not use the same port as the one defined earlier in the farm, you may overload it by configuring a server. However, to keep the configuration as standard as possible and easy to maintain, we recommend only using this parameter in advanced cases. +The mandatory fields are the *IPv4 address*, *Status*, and *ProxyProtocol version*. If a server port is configured, it will override the port defined in the farm. To keep the configuration as standard as possible and easy to maintain, we recommend only using this parameter in advanced cases. > [!warning] > -> It is important to configure ProxyProtocol in version v1, so that you can get the real source IP on your SMTP service. Postfix is compatible with this protocol. +> It is important to configure ProxyProtocol in version v1 so that you can retrieve the real source IP on your SMTP service. Postfix is compatible with this protocol. > ![Add a server to a farm.](images/add_server.png){.thumbnail} -Click `Add`{.action} once you have filled in the fields. +Click on `Add`{.action} once you have filled in the fields. Your server should appear in the server list, in the `Farms`{.action} tab, just below the list of farms. ![Details of the server created.](images/resume_server.png){.thumbnail} -### Via the API +#### Via the OVHcloud API - List of servers in the farm: @@ -162,29 +158,29 @@ Your server should appear in the server list, in the `Farms`{.action} tab, just > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server > -## Add a front-end +### Add a front-end -We will now add a `front-end`{.action} to our service, and connect it to our server farm. The front-end is the part of your OVH Load Balancer that exposes your service on the internet. +A `front-end`{.action} must now be added to the service and connected to the server farm. The front-end is the component of your OVHcloud Load Balancer that exposes your service to the internet. -### Via the Sunrise Control Panel. +#### Via the OVHcloud Control Panel Go to the `+ Front-ends`{.action} tab, and click `+TCP/TLS`{.action}. -Fill in the fields. The only mandatory fields for a basic configuration are *Port* (25 for a standard SMTP service), *Zone* and *Probe*, if you configured a probe on your farm. If you want your service to be available across several ports at once, you can specify a list of ports, separated by commas, or a range of ports, in the format "start_port-end_port". +Fill in the fields. The mandatory fields for a basic configuration are *Port* (25 for a standard SMTP service), *Zone*, *Default farm* and *Probe* (if a probe was configured on your farm). If you want your service to be available across several ports at once, you can specify a list of ports, separated by commas, or a port range, in the format "-". -If you have routed Additional IPs to your OVH Load Balancer service, you can also attach a front-end to one or more specific Additional IPs. +If you have routed Additional IPs to your OVHcloud Load Balancer service, you can also attach a front-end to one or more specific Additional IPs. -Please remember to specify the farm you created earlier as a “default farm”. +Ensure the farm you created earlier is specified as the “default farm”. ![Add a front-end](images/add_frontend.png){.thumbnail} -Click `Add`{.action} once you have filled in the fields. +Click `Add`{.action} once the fields are filled. Your front-end must appear in the list, in the `Front-ends`{.action} tab. ![Details of the front-end created](images/resume_frontend.png){.thumbnail} -### Via the API +#### Via the OVHcloud API - List of TCP front-ends: @@ -221,17 +217,17 @@ Your front-end must appear in the list, in the `Front-ends`{.action} tab. > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId} > -## Apply the modifications +### Apply the modifications -The modifications made to your OVH Load Balancer must be *explicitly applied* in each of the zones configured for your service. Only at this point will they be visible to your website visitors. This way, you can make complex configuration changes several times, and only apply them once the configuration is ready. +Modifications made to your OVHcloud Load Balancer must be **explicitly applied** in each of the zones configured for your service. They will only become visible to your users at this point. This process allows for complex configuration changes to be prepared and applied only when fully ready. -If you have several zones, you must apply the same configuration for each of them. +If you have several zones, the same configuration must be applied to each. -### Via the Sunrise Control Panel. +#### Via the OVHcloud Control Panel -Go the homepage for the OVH Load Balancer, and click `Apply:Zone`{.action} for each of the zones concerned. +Go to the homepage for the OVHcloud Load Balancer, and click `Apply:Zone`{.action} for each of the zones concerned. -### Via the API. +#### Via the OVHcloud API - Refresh a zone: @@ -240,21 +236,22 @@ Go the homepage for the OVH Load Balancer, and click `Apply:Zone`{.action} for e > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh > -## Postfix configuration. +### Postfix configuration To make Postfix compatible with HAProxy *ProxyProtocol*, an option is required in the postfix main.cf configuration file: -**smtp_upstream_proxy_protocol = haproxy** +```bash +smtp_upstream_proxy_protocol = haproxy +``` -You then need to restart your Postfix daemon. +The Postfix daemon must then be restarted. -## Confirmation. +### Confirmation -After you have completed all of these steps, you should now have a functional Load Balancer service for your SMTP servers. You can now check the service status by requesting your IP Load Balancer as an SMTP server. +Upon completing these steps, you will have a functional Load Balancer service for your SMTP servers. The service status can now be checked by requesting your IP Load Balancer as an SMTP server. ![Connection to SMTP via telnet](images/resume_validate.png){.thumbnail} ## Go further -Join our community of users on . - +Join our [community of users](/links/community). diff --git a/pages/network/load_balancer/case_smtp/guide.en-us.md b/pages/network/load_balancer/case_smtp/guide.en-us.md index 81712ab5352..6ff6bd90aa2 100644 --- a/pages/network/load_balancer/case_smtp/guide.en-us.md +++ b/pages/network/load_balancer/case_smtp/guide.en-us.md @@ -1,71 +1,67 @@ --- -title: 'Configuring SMTP on a Load Balancer service' -excerpt: 'Find out how to use SMTP with the OVH Load Balancer' -updated: 2018-12-28 +title: 'How to configure SMTP on a Load Balancer service' +excerpt: 'Find out how to use SMTP with the OVHcloud Load Balancer' +updated: 2025-10-24 --- ## Objective -In this guide, we will configure a basic TCP load balancing service, for one or more SMTP servers. A TCP front-end will listen to TCP traffic on port 25. It is configured to direct traffic to a TCP farm with one or more TCP servers, depending on how you choose to configure it. +**This guide outlines how to configure the OVHcloud Load Balancer to distribute traffic across multiple SMTP servers.** -**This guide is designed to help you configure an OVH Load Balancer service in order to balance load across several servers that respond in SMTP.** +## Requirements -> [!warning] -> -> Questions on what an SMTP service is and how it works will not be covered here. This guide is aimed at readers who have a general understanding of SMTP, or practical experience with it. -> +- An [OVHcloud Load balancer](/links/network/load-balancer) service in your OVHcloud account. +- Access to the [OVHcloud Control Panel](/links/manager). +- A Postfix-type SMTP service installed and configured on your servers. -> [!warning] -> -> We will assume that you already have a Postfix SMTP service set up and configured your servers. -> +## Instructions > [!warning] > -> This guide will take you through the steps required. Depending on the way you have designed your architecture, some configurations may vary. +> This guide assumes a working knowledge of SMTP protocol and service operation. > -As a reminder, each protocol (HTTP, TCP and UDP) in the OVH Load Balancer service has its own associated front-ends, farms and servers. +As a reminder, each protocol (HTTP, TCP and UDP) in the OVHcloud Load Balancer service has its own associated front-ends, farms and servers. > [!warning] > -> The order in which elements are created is important. In particular, the server farms must be configured before we can attach servers to them. +> The order in which elements are created is important. In particular, the server farms must be configured before servers can be attached to them. > -In the Sunrise Control Panel, you will see the features detailed below: +In the Control Panel, you will see the features detailed below: -![OVH Load Balancer service](images/iplb_service.png){.thumbnail} +![OVHcloud Load Balancer service](images/iplb_service.png){.thumbnail} -Via the OVH API, in the section: +Via the OVHcloud API, use the following call: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing > -For more information on the API’s features, you can refer to the following guide: [Load Balancer API Quick Reference](/pages/network/load_balancer/use_api_reference){.ref} +For more information on the API features, you can refer to [the following guide](/pages/network/load_balancer/use_api_reference). -## Add a server farm. +### Add a server farm -We will add a farm of TCP servers to our service, which is the part that balances traffic on the servers. +A TCP server farm must be added to the service; this component manages traffic balancing across the servers. -### Via the Sunrise Control Panel. +#### Via the OVHcloud Control Panel In the `Farms`{.action} tab for servers, click on the `+TCP/TLS`{.action} button. -Fill in the fields. The mandatory fields for a basic configuration are *Port* and *Zone*. In our case, for SMTP, port 25 is used. If no ports are specified, your OVH Load Balancer will automatically use the same port as the corresponding front-end. +Fill in the fields. The mandatory fields for a basic configuration are *Port* and *Zone*. For SMTP, port 25 is used. If no ports are specified, your OVHcloud Load Balancer will automatically use the same port as the corresponding front-end. -As an option, you can add an SMTP probe on your farm. +Optionally, you can add an SMTP probe on your farm. ![Add a server farm via the Control Panel](images/add_farm.png){.thumbnail} -Click `Add`{.action} once you have filled in the fields. +Click on `Add`{.action} once you have filled in the fields. Your server farm should appear in the list, in the `Farms`{.action} tab. ![Details of the server farm created](images/resume_farm.png){.thumbnail} -### Via the API +#### Via the OVHcloud API - List of TCP server farms: @@ -74,7 +70,7 @@ Your server farm should appear in the list, in the `Farms`{.action} tab. > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm > -- Details of a specific TCP server: +- Details of a specific TCP server farm: > [!api] > @@ -102,30 +98,30 @@ Your server farm should appear in the list, in the `Farms`{.action} tab. > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId} > -## Add a server. +### Add a server -We will now add a server to our server farm. +A server must now be added to the server farm. -### Via the Sunrise Control Panel. +#### Via the OVHcloud Control Panel -In the `Farms`{.action} tab, select the farm you want to add a server to by clicking on the corresponding line. The list of servers already configured in the farm will appear beneath the list of farms, along with the `Add a server`{.action} button. Click on this button to add a new server. +In the `Farms`{.action} tab, select the farm you want to add a server to by clicking on the corresponding line. The list of servers already configured in the farm will appear beneath the list of farms, along with the `Add a server`{.action} button. Click this button to add a new server. -Only the *IPv4 address*, *Status* and *ProxyProtocol version* fields are mandatory. If a server does not use the same port as the one defined earlier in the farm, you may overload it by configuring a server. However, to keep the configuration as standard as possible and easy to maintain, we recommend only using this parameter in advanced cases. +The mandatory fields are the *IPv4 address*, *Status*, and *ProxyProtocol version*. If a server port is configured, it will override the port defined in the farm. To keep the configuration as standard as possible and easy to maintain, we recommend only using this parameter in advanced cases. > [!warning] > -> It is important to configure ProxyProtocol in version v1, so that you can get the real source IP on your SMTP service. Postfix is compatible with this protocol. +> It is important to configure ProxyProtocol in version v1 so that you can retrieve the real source IP on your SMTP service. Postfix is compatible with this protocol. > ![Add a server to a farm.](images/add_server.png){.thumbnail} -Click `Add`{.action} once you have filled in the fields. +Click on `Add`{.action} once you have filled in the fields. Your server should appear in the server list, in the `Farms`{.action} tab, just below the list of farms. ![Details of the server created.](images/resume_server.png){.thumbnail} -### Via the API +#### Via the OVHcloud API - List of servers in the farm: @@ -162,29 +158,29 @@ Your server should appear in the server list, in the `Farms`{.action} tab, just > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server > -## Add a front-end +### Add a front-end -We will now add a `front-end`{.action} to our service, and connect it to our server farm. The front-end is the part of your OVH Load Balancer that exposes your service on the internet. +A `front-end`{.action} must now be added to the service and connected to the server farm. The front-end is the component of your OVHcloud Load Balancer that exposes your service to the internet. -### Via the Sunrise Control Panel. +#### Via the OVHcloud Control Panel Go to the `+ Front-ends`{.action} tab, and click `+TCP/TLS`{.action}. -Fill in the fields. The only mandatory fields for a basic configuration are *Port* (25 for a standard SMTP service), *Zone* and *Probe*, if you configured a probe on your farm. If you want your service to be available across several ports at once, you can specify a list of ports, separated by commas, or a range of ports, in the format "start_port-end_port". +Fill in the fields. The mandatory fields for a basic configuration are *Port* (25 for a standard SMTP service), *Zone*, *Default farm* and *Probe* (if a probe was configured on your farm). If you want your service to be available across several ports at once, you can specify a list of ports, separated by commas, or a port range, in the format "-". -If you have routed Additional IPs to your OVH Load Balancer service, you can also attach a front-end to one or more specific Additional IPs. +If you have routed Additional IPs to your OVHcloud Load Balancer service, you can also attach a front-end to one or more specific Additional IPs. -Please remember to specify the farm you created earlier as a “default farm”. +Ensure the farm you created earlier is specified as the “default farm”. ![Add a front-end](images/add_frontend.png){.thumbnail} -Click `Add`{.action} once you have filled in the fields. +Click `Add`{.action} once the fields are filled. Your front-end must appear in the list, in the `Front-ends`{.action} tab. ![Details of the front-end created](images/resume_frontend.png){.thumbnail} -### Via the API +#### Via the OVHcloud API - List of TCP front-ends: @@ -221,17 +217,17 @@ Your front-end must appear in the list, in the `Front-ends`{.action} tab. > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId} > -## Apply the modifications +### Apply the modifications -The modifications made to your OVH Load Balancer must be *explicitly applied* in each of the zones configured for your service. Only at this point will they be visible to your website visitors. This way, you can make complex configuration changes several times, and only apply them once the configuration is ready. +Modifications made to your OVHcloud Load Balancer must be **explicitly applied** in each of the zones configured for your service. They will only become visible to your users at this point. This process allows for complex configuration changes to be prepared and applied only when fully ready. -If you have several zones, you must apply the same configuration for each of them. +If you have several zones, the same configuration must be applied to each. -### Via the Sunrise Control Panel. +#### Via the OVHcloud Control Panel -Go the homepage for the OVH Load Balancer, and click `Apply:Zone`{.action} for each of the zones concerned. +Go to the homepage for the OVHcloud Load Balancer, and click `Apply:Zone`{.action} for each of the zones concerned. -### Via the API. +#### Via the OVHcloud API - Refresh a zone: @@ -240,21 +236,22 @@ Go the homepage for the OVH Load Balancer, and click `Apply:Zone`{.action} for e > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh > -## Postfix configuration. +### Postfix configuration To make Postfix compatible with HAProxy *ProxyProtocol*, an option is required in the postfix main.cf configuration file: -**smtp_upstream_proxy_protocol = haproxy** +```bash +smtp_upstream_proxy_protocol = haproxy +``` -You then need to restart your Postfix daemon. +The Postfix daemon must then be restarted. -## Confirmation. +### Confirmation -After you have completed all of these steps, you should now have a functional Load Balancer service for your SMTP servers. You can now check the service status by requesting your IP Load Balancer as an SMTP server. +Upon completing these steps, you will have a functional Load Balancer service for your SMTP servers. The service status can now be checked by requesting your IP Load Balancer as an SMTP server. ![Connection to SMTP via telnet](images/resume_validate.png){.thumbnail} ## Go further -Join our community of users on . - +Join our [community of users](/links/community). diff --git a/pages/network/load_balancer/case_smtp/guide.fr-ca.md b/pages/network/load_balancer/case_smtp/guide.fr-ca.md index 243a9fee82c..76651178f56 100644 --- a/pages/network/load_balancer/case_smtp/guide.fr-ca.md +++ b/pages/network/load_balancer/case_smtp/guide.fr-ca.md @@ -1,241 +1,241 @@ --- -title: 'Configurer SMTP sur un service Load Balancer' -excerpt: 'Cas pratique SMTP' -updated: 2018-12-28 +title: 'Comment configurer le SMTP sur un service Load Balancer' +excerpt: 'Découvrez comment utiliser le SMTP avec le Load Balancer OVHcloud' +updated: 2025-10-24 --- -## Introduction -Ce guide a pour but de vous aider à configurer un service OVH Load Balancer OVH pour répartir la charge sur plusieurs serveurs répondant convenablement en SMTP. +## Objectif -> [!warning] -> -> Les questions de ce qu'est un service SMTP, et son fonctionnement, ne seront pas abordées ici. -> Il est considéré que ces informations sont raisonnablement comprises et/ou maîtrisées. -> +**Ce guide détaille la configuration du Load Balancer OVHcloud afin de distribuer le trafic entre plusieurs serveurs SMTP.** -> [!warning] -> -> Nous considérons que vous avez déjà un service SMTP de type postfix installé et configuré sur vos serveurs. -> +## Prérequis + +- Posséder une offre [OVHcloud Load balancer](/links/network/load-balancer) dans votre compte OVHcloud. +- Être connecté à votre [espace client OVHcloud](/links/manager). +- Posséder un service SMTP de type Postfix installé et configuré sur vos serveurs. + +## En pratique > [!warning] > -> Nous allons vous guider au travers des différentes étapes. -> Dépendant de vos choix d'architecture, certaines configurations peuvent différer. -> +> Ce guide présuppose une connaissance fonctionnelle du protocole SMTP et de son service. +> -Dans ce guide, nous allons configurer un service simple de Load Balancing TCP, pour un (ou plusieurs) serveur(s) SMTP. Un Frontend TCP écoutera le trafic TCP sur le port 25. Il sera configuré pour diriger le trafic sur une Ferme TCP, avec un ou plusieurs Serveurs TCP, selon votre configuration. +Dans ce guide, nous configurons un service simple d'équilibrage de charge TCP pour un (ou plusieurs) serveur(s) SMTP. Un *frontend* TCP écoutera le trafic TCP sur le port 25. Il sera configuré pour diriger le trafic vers une ferme TCP, comprenant un ou plusieurs serveurs TCP, selon la configuration retenue. -Pour rappel, chaque protocole (HTTP, TCP et UDP) dans le service OVH Load Balancer dispose de ses propres Frontends, Fermes et Serveurs associés. +Pour rappel, chaque protocole (HTTP, TCP et UDP) du service OVHcloud Load Balancer dispose de ses propres *frontends*, fermes et serveurs associés. > [!warning] > > L'ordre de création des éléments est important. -> En particulier, les Fermes de serveurs doivent être configurées avant de pouvoir leur attacher des Serveurs. -> +> En particulier, les fermes de serveurs doivent être configurées **avant** de pouvoir leur attacher des serveurs. +> -Dans le Manager nous allons retrouver les fonctionnalités détaillées ci-dessous : +Les fonctionnalités détaillées ci-dessous sont disponibles dans l'espace client OVHcloud : -![Service OVH Load Balancer](images/iplb_service.png){.thumbnail} +![Service OVHcloud Load Balancer](images/iplb_service.png){.thumbnail} -Via l'API OVH, dans la section +Depuis l'API OVHcloud : > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing > -Pour plus d'informations sur les fonctionnalités de l'API, consulter la page [Référence Rapide API Load Balancer](/pages/network/load_balancer/use_api_reference){.ref}. +Pour plus d'informations sur les fonctionnalités de l'API, consultez la page « [Détails des fonctions API](/pages/network/load_balancer/use_api_details) ». -## Ajouter une `Ferme`{.action} de serveurs +### Ajouter une ferme de serveurs -Nous allons ajouter une Ferme de serveurs TCP à notre service, la partie en charge de répartir le trafic sur les serveurs. +Une ferme de serveurs TCP doit être ajoutée à notre service ; ce composant est en charge de la répartition du trafic sur les serveurs. -### Via le Manager +#### Depuis l'espace client OVHcloud Dans l'onglet `Fermes`{.action} de serveurs, cliquez sur le bouton `+TCP/TLS`{.action}. -Remplissez les différents champs. Les champs obligatoires pour une configuration simple sont le *Port* et la *Zone*. Dans notre cas, pour SMTP, le port utilisé est le port 25. Si aucun port n'est spécifié, votre OVH Load Balancer utilisera automatiquement le même port que le Frontend correspondant. +Remplissez les différents champs. Les champs obligatoires pour une configuration simple sont le *Port* et la *Zone*. Dans notre cas, pour SMTP, le port utilisé est le port 25. Si aucun port n'est spécifié, votre OVHcloud Load Balancer utilisera automatiquement le même port que le *frontend* correspondant. -Vous pouvez optionnelement ajouter une sonde de type smtp sur votre Ferme. +Vous pouvez optionnelement ajouter une sonde de type SMTP sur votre ferme. ![Ajout d'une ferme de serveurs via le Manager](images/add_farm.png){.thumbnail} +![Ajout d'une ferme de serveurs via le Manager](images/add_farm_Probe.png){.thumbnail} + Cliquez sur le bouton `Ajouter`{.action} une fois les champs remplis. -Votre Ferme de serveurs devrait apparaître dans la liste, sous l'onglet `Fermes`{.action}. +Votre ferme de serveurs devrait apparaître dans la liste, sous l'onglet `Fermes`{.action}. ![Détails de la ferme de serveurs créée](images/resume_farm.png){.thumbnail} -### Via l'API +#### Depuis l'API OVHcloud -- Liste des Fermes de serveurs TCP : +- Liste des fermes de serveurs TCP : > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm > -- Détails d'un serveur TCP spécifique : +- Détails d'une ferme de serveurs TCP : > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId} > -- Ajout d'une nouvelle Ferme de serveurs TCP : +- Ajout d'une nouvelle ferme de serveurs TCP : > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm > -- Modification d'une Ferme de serveurs spécifique : +- Modification d'une ferme de serveurs spécifique : > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId} > -- Suppression d'une Ferme de serveurs spécifique : +- Suppression d'une ferme de serveurs spécifique : > [!api] > > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId} > -## Ajouter un `Serveur`{.action} +### Ajouter un serveur -Nous allons maintenant ajouter un serveur à notre Ferme de serveurs. +Un serveur doit maintenant être ajouté à la ferme de serveurs. -### Via le Manager +#### Depuis l'espace client OVHcloud -Toujours dans l'onglet `Ferme`{.action}, sélectionnez la Ferme dans laquelle vous souhaitez ajouter un serveur en cliquant sur la ligne correspondante. La liste des Serveurs déjà configurés dans la Ferme apparaît en dessous de la liste des Fermes, ainsi qu'un bouton `+Server`{.action}. Cliquez sur ce bouton pour ajouter un nouveau serveur. +Toujours dans l'onglet `Fermes`{.action}, sélectionnez la ferme dans laquelle vous souhaitez ajouter un serveur en cliquant sur la ligne correspondante. La liste des serveurs déjà configurés dans la ferme apparaît en dessous de la liste des fermes, ainsi qu'un bouton `+Server`{.action}. Cliquez sur ce bouton pour ajouter un nouveau serveur. -Seuls les champs *Adresse IPv4*, *État* et *Version du ProxyProtocol* sont obligatoires. Si un serveur n'utilise pas le même port que celui défini plus haut dans la Ferme, il est possible de le surcharger dans la configuration du serveur. Cependant, afin de conserver une configuration la plus homogène et maintenable possible, il est recommandé de n'utiliser ce paramètre que dans les cas avancés. +Les champs obligatoires sont l'*Adresse IPv4*, l'*État* et la *Version du ProxyProtocol*. Si un port de serveur est configuré, il remplacera le port défini au niveau de la ferme. Afin de conserver une configuration la plus homogène et maintenable possible, il est recommandé de n'utiliser ce paramètre que dans les cas avancés. > [!warning] > -> Il est important de configurer le ProxyProtocol en version v1, -> afin d'obtenir l'IP source réelle sur votre service SMTP. +> Il est important de configurer le ProxyProtocol en version v1 afin d'obtenir l'IP source réelle sur votre service SMTP. > Postfix est compatible avec ce protocole. > -![Ajour d'un serveur dans une Ferme.](images/add_server.png){.thumbnail} +![Ajout d'un serveur dans une ferme](images/add_server.png){.thumbnail} + +![Ajout d'un serveur dans une ferme](images/add_server_advance.png){.thumbnail} Cliquez sur le bouton `Ajouter`{.action} une fois les champs remplis. -Votre Serveur devrait apparaître dans la liste des Serveurs l'onglet `Fermes`{.action}, juste en dessous de la liste des Fermes. +Votre serveur devrait apparaître dans la liste des serveurs dans l'onglet `Fermes`{.action}, juste en dessous de la liste des fermes. -![Détails du serveur créé.](images/resume_server.png){.thumbnail} +![Détails du serveur créé](images/resume_server.png){.thumbnail} -### Via l'API +### Depuis l'API OVHcloud -- Liste des Serveurs de la Ferme : +- Liste des serveurs de la ferme : > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server > -- Détails d'un Serveur spécifique : +- Détails d'un serveur spécifique : > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId} > -- Ajout d'un nouveau Serveur : +- Ajout d'un nouveau serveur : > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server > -- Modification d'un Serveur spécifique : +- Modification d'un serveur spécifique : > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server > -- Suppression d'un Serveur spécifique : +- Suppression d'un serveur spécifique : > [!api] > > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server > -## Ajouter un `Frontend`{.action} +### Ajouter un frontend -Nous allons maintenant ajouter un `Frontend`{.action} à notre service et le connecter à notre Ferme de serveurs. Le Frontend est la partie de votre OVH Load Balancer qui sert à exposer votre service sur Internet. +Un *frontend* doit maintenant être ajouté à notre service et connecté à la ferme de serveurs. Le *frontend* est le composant de votre OVHcloud Load Balancer qui expose votre service sur Internet. -### Via le Manager +#### Depuis l'espace client OVHcloud Dans l'onglet `+Frontends`{.action}, cliquez sur le bouton `+TCP/TLS`{.action}. -Remplissez les différents champs. Les seuls champs obligatoires pour une configuration simple sont le *Port* (25 pour un service SMTP standard), la *Zone* et la *Sonde* si vous en avez configuré un dans votre Ferme. Si vous souhaitez que votre service soit disponible sur plusieurs ports en même temps, vous pouvez spécifier une liste de ports séparés par des virgules ou une plage de ports de la forme "-". +Remplissez les différents champs. Les seuls champs obligatoires pour une configuration simple sont le *Port* (25 pour un service SMTP standard), la *Zone*, la *Ferme par défaut* et la *Sonde* (si vous en avez configuré une dans votre Ferme). Si vous souhaitez que votre service soit disponible sur plusieurs ports en même temps, vous pouvez spécifier une liste de ports séparés par des virgules ou une plage de ports de la forme "-". -Si vous avez routé des Additional IPs vers votre service OVH Load Balancer, vous pouvez également attacher un Frontend à une ou plusieurs Additional IPs spécifiques. +Si vous avez routé des Additional IP vers votre service OVHcloud Load Balancer, vous pouvez également attacher un *frontend* à une ou plusieurs Additional IP spécifiques. -N'oubliez pas de spécifier comme «Ferme par défaut» la Ferme créée précédemment. +Assurez-vous de spécifier la ferme créée précédemment comme « Ferme par défaut ». ![Ajout d'un frontend](images/add_frontend.png){.thumbnail} Cliquez sur le bouton `Ajouter`{.action} une fois les champs remplis. -Votre Frontend devrait apparaître dans la liste, sous l'onglet `Frontends`{.action}. +Votre *frontend* devrait apparaître dans la liste, sous l'onglet `Frontends`{.action}. ![Détails du frontend créé](images/resume_frontend.png){.thumbnail} -### Via l'API +#### Depuis l'API OVHcloud -- Liste des Frontends TCP : +- Liste des *frontends* TCP : > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend > -- Détails d'un Frontend spécifique : +- Détails d'un *frontend* spécifique : > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId} > -- Ajout d'un nouveau Frontend : +- Ajout d'un nouveau *frontend* : > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/frontend > -- Modification d'un Frontend spécifique : +- Modification d'un *frontend* spécifique : > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId} > -- Suppression d'un Frontend spécifique : +- Suppression d'un *frontend* spécifique : > [!api] > > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId} > -## Appliquer les modifications +### Appliquer les modifications -Les modifications apportées à votre service OVH Load Balancer doivent être *appliquées explicitement* dans chacune des zones configurées pour votre service OVH Load Balancer. C'est seulement à ce moment qu'elles seront visibles pour vos visiteurs. Cela permet de faire un changement complexe de configuration en plusieurs fois, et de ne l'appliquer que lorsque la configuration est prête. +Les modifications apportées à votre service OVHcloud Load Balancer doivent être **appliquées explicitement** dans chacune des zones configurées pour votre service. C'est seulement à ce moment qu'elles deviendront visibles pour vos visiteurs. Ce processus permet de préparer des changements de configuration complexes et de ne les appliquer qu'une fois la configuration entièrement prête. -Si vous avez plusieurs zones, vous devrez appliquer la même configuration pour chacune de vos zones. +Si vous avez plusieurs zones, la même configuration devra être appliquée pour chacune de vos zones. -### Via le Manager +#### Depuis l'espace client OVHcloud -Rendez-vous sur la page principale de votre service OVH Load Balancer et cliquez sur les boutons `Appliquer:Zone`{.action} pour chacune des zones concernées. +Rendez-vous sur la page principale de votre service OVHcloud Load Balancer et cliquez sur les boutons `Appliquer:Zone`{.action} pour chacune des zones concernées. -### Via l'API +#### Depuis l'API OVHcloud - Rafraîchir une zone : @@ -244,16 +244,22 @@ Rendez-vous sur la page principale de votre service OVH Load Balancer et cliquez > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh > -## Configuration de postfix +### Configuration de Postfix -Afin de rendre compatible postfix avec le *ProxyProtocol* de haproxy, une option est requise dans le fichier de configuration postfix main.cf. +Afin de rendre Postfix compatible avec le *ProxyProtocol* de HAProxy, une option est requise dans le fichier de configuration `postfix main.cf` : +```bash smtp_upstream_proxy_protocol = haproxy +``` -Vous devez ensuite redémarrer votre démon postfix. +Le daemon Postfix doit ensuite être redémarré. -## Validation +### Validation Une fois toutes ces étapes terminées, vous devriez disposer d'un service de répartition de charge fonctionnel pour vos serveurs SMTP. Vous pouvez alors valider l'état du service en interrogeant votre IPLB comme un serveur SMTP. ![Connexion à SMTP via telnet](images/resume_validate.png){.thumbnail} + +## Aller plus loin + +Échangez avec notre [communauté d'utilisateurs](/links/community). diff --git a/pages/network/load_balancer/case_smtp/guide.fr-fr.md b/pages/network/load_balancer/case_smtp/guide.fr-fr.md index 4eb8216605a..76651178f56 100644 --- a/pages/network/load_balancer/case_smtp/guide.fr-fr.md +++ b/pages/network/load_balancer/case_smtp/guide.fr-fr.md @@ -1,41 +1,37 @@ --- -title: 'Configuration SMTP sur un service Load Balancer' -excerpt: 'Cas pratique SMTP' -updated: 2018-12-28 +title: 'Comment configurer le SMTP sur un service Load Balancer' +excerpt: 'Découvrez comment utiliser le SMTP avec le Load Balancer OVHcloud' +updated: 2025-10-24 --- ## Objectif -Ce guide a pour but de vous aider à configurer un service OVHcloud Load Balancer pour répartir la charge sur plusieurs serveurs répondant convenablement en SMTP. +**Ce guide détaille la configuration du Load Balancer OVHcloud afin de distribuer le trafic entre plusieurs serveurs SMTP.** ## Prérequis - Posséder une offre [OVHcloud Load balancer](/links/network/load-balancer) dans votre compte OVHcloud. - Être connecté à votre [espace client OVHcloud](/links/manager). -- Posséder un service SMTP de type postfix installé et configuré sur vos serveurs +- Posséder un service SMTP de type Postfix installé et configuré sur vos serveurs. ## En pratique > [!warning] > -> La définition d'un service SMTP et son fonctionnement sont des notions qui ne seront pas abordées ici. -> Il est considéré ici que ces informations sont raisonnablement comprises et/ou maîtrisées. +> Ce guide présuppose une connaissance fonctionnelle du protocole SMTP et de son service. > -> Nous allons vous guider au travers des différentes étapes. -> Dépendant de vos choix d'architecture, certaines configurations peuvent différer. -> -Dans ce guide, nous allons configurer un service simple de Load Balancing TCP, pour un (ou plusieurs) serveur(s) SMTP. Un frontend TCP écoutera le trafic TCP sur le port 25. Il sera configuré pour diriger le trafic sur une ferme TCP, avec un ou plusieurs serveurs TCP, selon votre configuration. +Dans ce guide, nous configurons un service simple d'équilibrage de charge TCP pour un (ou plusieurs) serveur(s) SMTP. Un *frontend* TCP écoutera le trafic TCP sur le port 25. Il sera configuré pour diriger le trafic vers une ferme TCP, comprenant un ou plusieurs serveurs TCP, selon la configuration retenue. -Pour rappel, chaque protocole (HTTP, TCP et UDP) dans le service OVHcloud Load Balancer dispose de ses propres frontends, fermes et serveurs associés. +Pour rappel, chaque protocole (HTTP, TCP et UDP) du service OVHcloud Load Balancer dispose de ses propres *frontends*, fermes et serveurs associés. > [!warning] > > L'ordre de création des éléments est important. > En particulier, les fermes de serveurs doivent être configurées **avant** de pouvoir leur attacher des serveurs. -> +> -Dans l'espace client OVHcloud, nous allons retrouver les fonctionnalités détaillées ci-dessous : +Les fonctionnalités détaillées ci-dessous sont disponibles dans l'espace client OVHcloud : ![Service OVHcloud Load Balancer](images/iplb_service.png){.thumbnail} @@ -50,36 +46,36 @@ Pour plus d'informations sur les fonctionnalités de l'API, consultez la page « ### Ajouter une ferme de serveurs -Nous allons ajouter une ferme de serveurs TCP à notre service, c'est à dire la partie en charge de répartir le trafic sur les serveurs. +Une ferme de serveurs TCP doit être ajoutée à notre service ; ce composant est en charge de la répartition du trafic sur les serveurs. #### Depuis l'espace client OVHcloud Dans l'onglet `Fermes`{.action} de serveurs, cliquez sur le bouton `+TCP/TLS`{.action}. -Remplissez les différents champs. Les champs obligatoires pour une configuration simple sont le *Port* et la *Zone*. Dans notre cas, pour SMTP, le port utilisé est le port 25. Si aucun port n'est spécifié, votre OVHcloud Load Balancer utilisera automatiquement le même port que le frontend correspondant. - -![Ajout d'une ferme de serveurs via le Manager](images/add_farm.png){.thumbnail} - -Cliquez sur le bouton `Ajouter`{.action} une fois les champs remplis. +Remplissez les différents champs. Les champs obligatoires pour une configuration simple sont le *Port* et la *Zone*. Dans notre cas, pour SMTP, le port utilisé est le port 25. Si aucun port n'est spécifié, votre OVHcloud Load Balancer utilisera automatiquement le même port que le *frontend* correspondant. Vous pouvez optionnelement ajouter une sonde de type SMTP sur votre ferme. +![Ajout d'une ferme de serveurs via le Manager](images/add_farm.png){.thumbnail} + ![Ajout d'une ferme de serveurs via le Manager](images/add_farm_Probe.png){.thumbnail} +Cliquez sur le bouton `Ajouter`{.action} une fois les champs remplis. + Votre ferme de serveurs devrait apparaître dans la liste, sous l'onglet `Fermes`{.action}. ![Détails de la ferme de serveurs créée](images/resume_farm.png){.thumbnail} -#### Depuis l'API OVHcloud +#### Depuis l'API OVHcloud -- Liste des Fermes de serveurs TCP : +- Liste des fermes de serveurs TCP : > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm > -- Détails d'un serveur TCP spécifique : +- Détails d'une ferme de serveurs TCP : > [!api] > @@ -109,28 +105,29 @@ Votre ferme de serveurs devrait apparaître dans la liste, sous l'onglet `Fermes ### Ajouter un serveur -Nous allons maintenant ajouter un serveur à notre ferme de serveurs. +Un serveur doit maintenant être ajouté à la ferme de serveurs. #### Depuis l'espace client OVHcloud Toujours dans l'onglet `Fermes`{.action}, sélectionnez la ferme dans laquelle vous souhaitez ajouter un serveur en cliquant sur la ligne correspondante. La liste des serveurs déjà configurés dans la ferme apparaît en dessous de la liste des fermes, ainsi qu'un bouton `+Server`{.action}. Cliquez sur ce bouton pour ajouter un nouveau serveur. -Seuls les champs *Adresse IPv4*, *État* et *Version du ProxyProtocol* sont obligatoires. Si un serveur n'utilise pas le même port que celui défini plus haut dans la ferme, il est possible de le surcharger dans la configuration du serveur. Cependant, afin de conserver une configuration la plus homogène et maintenable possible, il est recommandé de n'utiliser ce paramètre que dans les cas avancés. +Les champs obligatoires sont l'*Adresse IPv4*, l'*État* et la *Version du ProxyProtocol*. Si un port de serveur est configuré, il remplacera le port défini au niveau de la ferme. Afin de conserver une configuration la plus homogène et maintenable possible, il est recommandé de n'utiliser ce paramètre que dans les cas avancés. > [!warning] > -> Il est important de configurer le ProxyProtocol en version v1, afin d'obtenir l'IP source réelle sur votre service SMTP. +> Il est important de configurer le ProxyProtocol en version v1 afin d'obtenir l'IP source réelle sur votre service SMTP. > Postfix est compatible avec ce protocole. > -![Ajour d'un serveur dans une Ferme.](images/add_server.png){.thumbnail} -![Ajour d'un serveur dans une Ferme.](images/add_server_advance.png){.thumbnail} +![Ajout d'un serveur dans une ferme](images/add_server.png){.thumbnail} + +![Ajout d'un serveur dans une ferme](images/add_server_advance.png){.thumbnail} Cliquez sur le bouton `Ajouter`{.action} une fois les champs remplis. Votre serveur devrait apparaître dans la liste des serveurs dans l'onglet `Fermes`{.action}, juste en dessous de la liste des fermes. -![Détails du serveur créé.](images/resume_server.png){.thumbnail} +![Détails du serveur créé](images/resume_server.png){.thumbnail} ### Depuis l'API OVHcloud @@ -171,57 +168,57 @@ Votre serveur devrait apparaître dans la liste des serveurs dans l'onglet `Ferm ### Ajouter un frontend -Nous allons maintenant ajouter un frontend à notre service et le connecter à notre ferme de serveurs. Le frontend est la partie de votre OVHcloud Load Balancer qui sert à exposer votre service sur Internet. +Un *frontend* doit maintenant être ajouté à notre service et connecté à la ferme de serveurs. Le *frontend* est le composant de votre OVHcloud Load Balancer qui expose votre service sur Internet. #### Depuis l'espace client OVHcloud Dans l'onglet `+Frontends`{.action}, cliquez sur le bouton `+TCP/TLS`{.action}. -Remplissez les différents champs. Les seuls champs obligatoires pour une configuration simple sont le *Port* (25 pour un service SMTP standard), la *Zone* et la *Sonde* si vous en avez configuré une dans votre Ferme. Si vous souhaitez que votre service soit disponible sur plusieurs ports en même temps, vous pouvez spécifier une liste de ports séparés par des virgules ou une plage de ports de la forme "-". +Remplissez les différents champs. Les seuls champs obligatoires pour une configuration simple sont le *Port* (25 pour un service SMTP standard), la *Zone*, la *Ferme par défaut* et la *Sonde* (si vous en avez configuré une dans votre Ferme). Si vous souhaitez que votre service soit disponible sur plusieurs ports en même temps, vous pouvez spécifier une liste de ports séparés par des virgules ou une plage de ports de la forme "-". -Si vous avez routé des Additional IP vers votre service OVHcloud Load Balancer, vous pouvez également attacher un frontend à une ou plusieurs Additional IP spécifiques. +Si vous avez routé des Additional IP vers votre service OVHcloud Load Balancer, vous pouvez également attacher un *frontend* à une ou plusieurs Additional IP spécifiques. -N'oubliez pas de spécifier comme « Ferme par défaut » la ferme créée précédemment. +Assurez-vous de spécifier la ferme créée précédemment comme « Ferme par défaut ». ![Ajout d'un frontend](images/add_frontend.png){.thumbnail} Cliquez sur le bouton `Ajouter`{.action} une fois les champs remplis. -Votre frontend devrait apparaître dans la liste, sous l'onglet `Frontends`{.action}. +Votre *frontend* devrait apparaître dans la liste, sous l'onglet `Frontends`{.action}. ![Détails du frontend créé](images/resume_frontend.png){.thumbnail} #### Depuis l'API OVHcloud -- Liste des frontends TCP : +- Liste des *frontends* TCP : > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend > -- Détails d'un frontend spécifique : +- Détails d'un *frontend* spécifique : > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId} > -- Ajout d'un nouveau frontend : +- Ajout d'un nouveau *frontend* : > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/frontend > -- Modification d'un frontend spécifique : +- Modification d'un *frontend* spécifique : > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId} > -- Suppression d'un frontend spécifique : +- Suppression d'un *frontend* spécifique : > [!api] > @@ -230,9 +227,9 @@ Votre frontend devrait apparaître dans la liste, sous l'onglet `Frontends`{.act ### Appliquer les modifications -Les modifications apportées à votre service OVHcloud Load Balancer doivent être *appliquées explicitement* dans chacune des zones configurées pour votre service OVHcloud Load Balancer. C'est seulement à ce moment qu'elles seront visibles pour vos visiteurs. Cela permet de faire un changement complexe de configuration en plusieurs fois, et de ne l'appliquer que lorsque la configuration est prête. +Les modifications apportées à votre service OVHcloud Load Balancer doivent être **appliquées explicitement** dans chacune des zones configurées pour votre service. C'est seulement à ce moment qu'elles deviendront visibles pour vos visiteurs. Ce processus permet de préparer des changements de configuration complexes et de ne les appliquer qu'une fois la configuration entièrement prête. -Si vous avez plusieurs zones, vous devrez appliquer la même configuration pour chacune de vos zones. +Si vous avez plusieurs zones, la même configuration devra être appliquée pour chacune de vos zones. #### Depuis l'espace client OVHcloud @@ -247,15 +244,15 @@ Rendez-vous sur la page principale de votre service OVHcloud Load Balancer et cl > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh > -### Configuration de postfix +### Configuration de Postfix -Afin de rendre postfix compatible avec le *ProxyProtocol* de haproxy, une option est requise dans le fichier de configuration `postfix main.cf`. +Afin de rendre Postfix compatible avec le *ProxyProtocol* de HAProxy, une option est requise dans le fichier de configuration `postfix main.cf` : ```bash smtp_upstream_proxy_protocol = haproxy ``` -Vous devez ensuite redémarrer votre démon postfix. +Le daemon Postfix doit ensuite être redémarré. ### Validation @@ -265,4 +262,4 @@ Une fois toutes ces étapes terminées, vous devriez disposer d'un service de r ## Aller plus loin -Échangez avec notre [communauté d'utilisateurs](/links/community). \ No newline at end of file +Échangez avec notre [communauté d'utilisateurs](/links/community). diff --git a/pages/network/load_balancer/create_balancing/guide.de-de.md b/pages/network/load_balancer/create_balancing/guide.de-de.md deleted file mode 100644 index 3b904017b58..00000000000 --- a/pages/network/load_balancer/create_balancing/guide.de-de.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -title: Lastverteilungstyp -excerpt: Diese Anleitung beschreibt die verschiedenen Lastverteilungsmethoden des OVH Loadbalancers -updated: 2018-01-17 ---- - -## Einleitung - -Der neue OVH Loadbalancer bietet Ihnen mehrere Lastverteilungstypen für Ihre Dienste. Die gewählte Methode bestimmt, wie der OVH Loadbalancer die empfangenen Anfragen auf Ihre Server aufteilt. - -**Diese Anleitung gibt eine Einführung zu den verschiedenen Lastverteilungstypen und zeigt Ihnen, wie Sie diese ändern können.** - -## Voraussetzungen - -- Sie sind in Ihrem [OVHcloud Kundencenter](/links/manager) eingeloggt. -- Sie haben eine Serverfarm erstellt. - -## Beschreibung - -### Die verschiedenen Lastverteilungstypen - -Lastverteilung (engl. „Load Balancing“) wird in Serverfarmen verwendet. Diese Einstellung bestimmt, wie Anfragen zwischen den verschiedenen Servern einer Farm aufgeteilt werden. - -Weitere Informationen zu den Grundbestandteilen des OVH Loadbalancers finden Sie in der [Einführung zum OVH Loadbalancer](/pages/network/load_balancer/use_presentation). - -|Algorithmus|Funktion| -|---|---| -|First|Der erste verfügbare Server empfängt die Verbindung. Der Server wird entsprechend seiner ID ausgewählt, immer von der kleinsten zur größten.| -|LeastConn|Wählt den Server mit den wenigsten aktiven Verbindungen aus. Diese Einstellung wird für längere Sitzungen mit geringem Traffic empfohlen. Der *RoundRobin* Algorithmus wird auf Gruppen von Servern mit gleicher Anzahl an Verbindungen angewendet.| -|RoundRobin|Wählt einen Server nach dem anderen für jede Verbindung. **Dieser Algorithmus ist standardmäßig eingestellt.**| -|Source|Dieser Algorithmus wendet eine *Hashfunktion* auf die Quell-IP an und teilt anschließend das Ergebnis durch die Anzahl der aktuell aktiven Server. So wird die gleiche Quell-IP immer auf denselben Server weitergeleitet, solange dieser aktiv ist.| -|URI|Dieser Algorithmus wendet eine *Hashfunktion* auf einen Teil oder den kompletten URI an und teilt anschließend das Ergebnis durch die Anzahl der aktuell aktiven Server. So wird der gleiche URI immer auf denselben Server weitergeleitet, solange dieser aktiv ist.| - -### Lastverteilungstyp einer Farm über das Kundencenter anpassen - -- Im Bereich `Serverfarmen`{.action} Ihres OVH Loadbalancers werden Ihnen die aktuell eingerichteten Serverfarmen angezeigt. Um eine der Farmen zu bearbeiten, klicken Sie einfach auf die drei Punkte rechts neben der entsprechenden Farm (2) und anschließend auf `Ändern`{.action}: - -![Serverfarm bearbeiten](images/server_cluster_change.png){.thumbnail} - -In den `erweiterten Einstellungen`{.action} können Sie Ihren `Lastverteilungstyp`{.action} ändern: - -![Serverfarm bearbeiten](images/distrib_mode_edit.png){.thumbnail} - -Wenn Sie den gewünschten Lastverteilungstyp ausgewählt haben, klicken Sie auf `Update`{.action} und dann auf `Die Konfiguration anwenden`{.action} in dem angezeigten gelben Banner: - -![Konfiguration anwenden](images/apply_config.png){.thumbnail} - -### Lastverteilungstyp einer Farm über die API anpassen - -Sie können die Einstellungen des Lastverteilungstyps anpassen, indem Sie die entsprechenden Einstellungen in den Serverfarmen vornehmen. - -- Details einer Farm einsehen - -Mit dieser API-Funktion können Sie sich die Details einer Farm anzeigen lassen, wenn Sie deren ID kennen. Im folgenden Beispiel werden wir eine HTTP-Farm bearbeiten: - -> [!api] -> -> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId} -> - -|Einstellung|Bedeutung| -|---|---| -|ServiceName*|ID Ihres Loadbalancer Dienstes| -|farmId*|ID der Farm| - -|Antwort (BackendHttp)|Bedeutung| -|---|---| -|farmId|ID der Farm| -|balance|Aktuell auf der Farm konfigurierter Lastverteilungstyp| -|zone|Name der Zone, in der die Farm konfiguriert ist| -|port|Port, der verwendet wird, um die Server zu kontaktieren| -|probe|Aktuell auf der Farm konfigurierte Monitoring-Sonde| -|displayName|Name der Farm| -|stickiness|Aktuell auf der Farm konfigurierte Verbindungsüberwachung| - -- Lastverteilungstyp anpassen - -Mit diesem Aufrufbefehl können Sie die Konfiguration einer Farm bearbeiten, wenn Sie deren ID kennen. Im folgenden Beispiel werden wir eine HTTP-Farm bearbeiten. Um den Lastverteilungstyp zu ändern, aktualisieren Sie das Feld `BackendHttp.balance` mit einem verfügbaren Lastverteilungstyp: - -> [!api] -> -> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{id} -> - -|Einstellung|Bedeutung| -|---|---| -|ServiceName*|ID Ihres Loadbalancer Dienstes| -|farmId*|ID der Farm| -|BackendHttp.balance|Der gewünschte Lastverteilungstyp für diese Farm| - -- Änderungen anwenden - -> [!api] -> -> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh -> - -|Einstellung|Bedeutung| -|---|---| -|ServiceName*|ID Ihres Loadbalancer Dienstes| -|zone*|Name der Zone, in der die Konfiguration angewendet werden soll| - -## Weiterführende Informationen - -Für den Austausch mit unserer User Community gehen Sie auf . diff --git a/pages/network/load_balancer/create_balancing/guide.en-asia.md b/pages/network/load_balancer/create_balancing/guide.en-asia.md index 0d25c0f0aea..ddb51f2c8cf 100644 --- a/pages/network/load_balancer/create_balancing/guide.en-asia.md +++ b/pages/network/load_balancer/create_balancing/guide.en-asia.md @@ -1,105 +1,106 @@ --- title: Load balancing methods -excerpt: Find out about the various load balancing methods used by the OVH Load Balancer -updated: 2018-01-17 +excerpt: Discover the various load balancing algorithms available with the OVHcloud Load Balancer +updated: 2025-10-24 --- ## Objective -The new OVH Load Balancer service offers a variety of load balancing methods for your services. This process determines the way in which the OVH Load Balancer distributes the requests received by your servers. +The OVHcloud Load Balancer service supports a variety of load balancing algorithms for your services. This setting dictates how the Load Balancer distributes incoming client requests among the servers in a farm. -**This guide will provide an introduction to the various load balancing methods, and will explain how you can modify them.** +**This guide introduces the various load balancing methods and explains how to modify them.** ## Requirements -- You must be logged in to the [OVH Control Panel](/links/manager). +- An [OVHcloud Load Balancer](/links/network/load-balancer) service in your OVHcloud account. +- Access to the [OVHcloud Control Panel](/links/manager). - You need to have created a server farm. ## Instructions -### Different load balancing methods +### Available Load Balancing Algorithms -Load balancing is used in server farms. This setting defines the way that requests are distributed between the servers within the farm. +The load balancing setting is applied at the server farm level and defines the method by which client requests are distributed among the servers within that farm. -To understand the basics of the OVH Load Balancer service, please refer to the [Load Balancer Introduction](/pages/network/load_balancer/use_presentation). +For an overview of the OVHcloud Load Balancer service components, please refer to the [Load Balancer Introduction](/pages/network/load_balancer/use_presentation) guide. |Algorithm|Features| |---|---| -|First|The first available server receives the connection. The server is chosen according to its ID, from smallest to largest.| -|LeastConn|Selects the server that has the lowest number of active connections. This setting is recommended for long sessions, with low levels of traffic. The *RoundRobin* algorithm is applied to groups of servers that have the same number of active connections.| -|RoundRobin|Selects the servers one after the other for each connection. **This is the default algorithm.**| -|Source|This algorithm *hashes* the source IP address, then divides the result by the number of servers currently running. The same source IP address will then still be redirected to the same server, provided that it continues to run.| -|URI|This algorithm *hashes* part or all of the URI, then divides the result by the number of servers currently running. The same URI will then still be redirected to the same server, provided that it continues to run.| +|**First**|Directs the connection to the first available server based on its ID (smallest to largest).| +|**LeastConn**|Selects the server with the lowest number of active connections. This is recommended for long-duration sessions with light traffic. The *RoundRobin* algorithm is used for tie-breaking among equally loaded servers.| +|**RoundRobin**|Distributes connections sequentially, one after the other, for each new request. **This is the default algorithm.**| +|**Source**|Uses a hash of the source IP address to consistently redirect the same client IP to the same server, provided the server remains operational.| +|**URI**|Uses a hash of part or all of the URI path to consistently redirect identical URIs to the same server, provided the server remains operational. *(Applicable to HTTP/HTTPS farms only.)*| -### Modify a server farm’s load balancing method via the Control Panel +### Modify a server farm’s load balancing method via the OVHcloud Control Panel -- In the `Server farms`{.action} section (1), you will see the farms that have been created. You can edit them by clicking the three dots on the right-hand side (2), then `Change`{.action}: +- In the `Server farms`{.action} section (1), locate the desired farm. You can edit it by clicking the three dots on the right-hand side (2), then on `Change`{.action}. ![Modify a farm](images/server_cluster_change.png){.thumbnail} -In `Advanced settings`{.action}, you can modify your `Load balancing method`{.action}: +In `Advanced settings`{.action}, modify the `Load balancing method`{.action}. ![Modify a farm](images/distrib_mode_edit.png){.thumbnail} -Once you have selected your preferred load balancing method, click `Update`{.action}, then `Apply configuration`{.action} in the yellow banner that appears: +Once your preferred method is selected, click `Update`{.action}, then click `Apply configuration`{.action} in the yellow banner that appears. ![Apply configuration](images/apply_config.png){.thumbnail} -### Modify a server farm’s load balancing method via the API +### Modify a server farm’s load balancing method via the OVHcloud API -You can modify the load balancing method settings by editing them in the server farm. +The load balancing method is changed by updating the corresponding field within the server farm configuration. -- View details on a server farm +#### View details on a server farm -With this call instruction, you can view details on a server farm if you know its ID. In this example, we will work on an HTTP farm: +Use this api call to view the details of a server farm given its ID. In this example, we work with an HTTP farm: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId} -> +> |Setting|Meaning| |---|---| -|ServiceName*|Your Load Balancer service ID| +|serviceName*|Your Load Balancer service ID| |farmId*|The farm’s ID number| |Response (BackendHttp)|Meaning| |---|---| |farmId|The farm’s ID number| -|balance|Balance type currently set for the farm| +|balance|The load balancing algorithm currently set for the farm| |zone|Name of the zone in which the farm is configured| |port|Port used to contact the servers configured on the farm| |probe|Type of probe currently configured on the farm| |displayName|Name given to this farm| |stickiness|Connection monitoring method currently set for the farm| -- Modify a server farm’s load balancing method +#### Modify a server farm’s load balancing method -With this call instruction, you can edit the settings of a server farm if you know its ID. In this example, we will work on an HTTP farm. To modify the balancing method, the `BackendHttp.balance` field must be updated with an available balancing method: +Use this api call to edit the settings of a server farm given its ID. In this example, we work with an HTTP farm. To modify the balancing method, update the `BackendHttp.balance` field with an available algorithm: > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{id} -> +> |Setting|Meaning| |---|---| -|ServiceName*|Your Load Balancer service ID| +|serviceName*|Your Load Balancer service ID| |farmId*|The farm’s ID number| |BackendHttp.balance|Preferred balancing method for this farm| -- Apply the modifications +#### Apply the modifications > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh -> +> |Setting|Meaning| |---|---| -|ServiceName*|Your Load Balancer service ID| +|serviceName*|Your Load Balancer service ID| |zone*|Name of the zone in which to deploy the configuration| ## Go further -Join our community of users on . +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_balancing/guide.en-au.md b/pages/network/load_balancer/create_balancing/guide.en-au.md index 0d25c0f0aea..ddb51f2c8cf 100644 --- a/pages/network/load_balancer/create_balancing/guide.en-au.md +++ b/pages/network/load_balancer/create_balancing/guide.en-au.md @@ -1,105 +1,106 @@ --- title: Load balancing methods -excerpt: Find out about the various load balancing methods used by the OVH Load Balancer -updated: 2018-01-17 +excerpt: Discover the various load balancing algorithms available with the OVHcloud Load Balancer +updated: 2025-10-24 --- ## Objective -The new OVH Load Balancer service offers a variety of load balancing methods for your services. This process determines the way in which the OVH Load Balancer distributes the requests received by your servers. +The OVHcloud Load Balancer service supports a variety of load balancing algorithms for your services. This setting dictates how the Load Balancer distributes incoming client requests among the servers in a farm. -**This guide will provide an introduction to the various load balancing methods, and will explain how you can modify them.** +**This guide introduces the various load balancing methods and explains how to modify them.** ## Requirements -- You must be logged in to the [OVH Control Panel](/links/manager). +- An [OVHcloud Load Balancer](/links/network/load-balancer) service in your OVHcloud account. +- Access to the [OVHcloud Control Panel](/links/manager). - You need to have created a server farm. ## Instructions -### Different load balancing methods +### Available Load Balancing Algorithms -Load balancing is used in server farms. This setting defines the way that requests are distributed between the servers within the farm. +The load balancing setting is applied at the server farm level and defines the method by which client requests are distributed among the servers within that farm. -To understand the basics of the OVH Load Balancer service, please refer to the [Load Balancer Introduction](/pages/network/load_balancer/use_presentation). +For an overview of the OVHcloud Load Balancer service components, please refer to the [Load Balancer Introduction](/pages/network/load_balancer/use_presentation) guide. |Algorithm|Features| |---|---| -|First|The first available server receives the connection. The server is chosen according to its ID, from smallest to largest.| -|LeastConn|Selects the server that has the lowest number of active connections. This setting is recommended for long sessions, with low levels of traffic. The *RoundRobin* algorithm is applied to groups of servers that have the same number of active connections.| -|RoundRobin|Selects the servers one after the other for each connection. **This is the default algorithm.**| -|Source|This algorithm *hashes* the source IP address, then divides the result by the number of servers currently running. The same source IP address will then still be redirected to the same server, provided that it continues to run.| -|URI|This algorithm *hashes* part or all of the URI, then divides the result by the number of servers currently running. The same URI will then still be redirected to the same server, provided that it continues to run.| +|**First**|Directs the connection to the first available server based on its ID (smallest to largest).| +|**LeastConn**|Selects the server with the lowest number of active connections. This is recommended for long-duration sessions with light traffic. The *RoundRobin* algorithm is used for tie-breaking among equally loaded servers.| +|**RoundRobin**|Distributes connections sequentially, one after the other, for each new request. **This is the default algorithm.**| +|**Source**|Uses a hash of the source IP address to consistently redirect the same client IP to the same server, provided the server remains operational.| +|**URI**|Uses a hash of part or all of the URI path to consistently redirect identical URIs to the same server, provided the server remains operational. *(Applicable to HTTP/HTTPS farms only.)*| -### Modify a server farm’s load balancing method via the Control Panel +### Modify a server farm’s load balancing method via the OVHcloud Control Panel -- In the `Server farms`{.action} section (1), you will see the farms that have been created. You can edit them by clicking the three dots on the right-hand side (2), then `Change`{.action}: +- In the `Server farms`{.action} section (1), locate the desired farm. You can edit it by clicking the three dots on the right-hand side (2), then on `Change`{.action}. ![Modify a farm](images/server_cluster_change.png){.thumbnail} -In `Advanced settings`{.action}, you can modify your `Load balancing method`{.action}: +In `Advanced settings`{.action}, modify the `Load balancing method`{.action}. ![Modify a farm](images/distrib_mode_edit.png){.thumbnail} -Once you have selected your preferred load balancing method, click `Update`{.action}, then `Apply configuration`{.action} in the yellow banner that appears: +Once your preferred method is selected, click `Update`{.action}, then click `Apply configuration`{.action} in the yellow banner that appears. ![Apply configuration](images/apply_config.png){.thumbnail} -### Modify a server farm’s load balancing method via the API +### Modify a server farm’s load balancing method via the OVHcloud API -You can modify the load balancing method settings by editing them in the server farm. +The load balancing method is changed by updating the corresponding field within the server farm configuration. -- View details on a server farm +#### View details on a server farm -With this call instruction, you can view details on a server farm if you know its ID. In this example, we will work on an HTTP farm: +Use this api call to view the details of a server farm given its ID. In this example, we work with an HTTP farm: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId} -> +> |Setting|Meaning| |---|---| -|ServiceName*|Your Load Balancer service ID| +|serviceName*|Your Load Balancer service ID| |farmId*|The farm’s ID number| |Response (BackendHttp)|Meaning| |---|---| |farmId|The farm’s ID number| -|balance|Balance type currently set for the farm| +|balance|The load balancing algorithm currently set for the farm| |zone|Name of the zone in which the farm is configured| |port|Port used to contact the servers configured on the farm| |probe|Type of probe currently configured on the farm| |displayName|Name given to this farm| |stickiness|Connection monitoring method currently set for the farm| -- Modify a server farm’s load balancing method +#### Modify a server farm’s load balancing method -With this call instruction, you can edit the settings of a server farm if you know its ID. In this example, we will work on an HTTP farm. To modify the balancing method, the `BackendHttp.balance` field must be updated with an available balancing method: +Use this api call to edit the settings of a server farm given its ID. In this example, we work with an HTTP farm. To modify the balancing method, update the `BackendHttp.balance` field with an available algorithm: > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{id} -> +> |Setting|Meaning| |---|---| -|ServiceName*|Your Load Balancer service ID| +|serviceName*|Your Load Balancer service ID| |farmId*|The farm’s ID number| |BackendHttp.balance|Preferred balancing method for this farm| -- Apply the modifications +#### Apply the modifications > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh -> +> |Setting|Meaning| |---|---| -|ServiceName*|Your Load Balancer service ID| +|serviceName*|Your Load Balancer service ID| |zone*|Name of the zone in which to deploy the configuration| ## Go further -Join our community of users on . +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_balancing/guide.en-ca.md b/pages/network/load_balancer/create_balancing/guide.en-ca.md index 0d25c0f0aea..ddb51f2c8cf 100644 --- a/pages/network/load_balancer/create_balancing/guide.en-ca.md +++ b/pages/network/load_balancer/create_balancing/guide.en-ca.md @@ -1,105 +1,106 @@ --- title: Load balancing methods -excerpt: Find out about the various load balancing methods used by the OVH Load Balancer -updated: 2018-01-17 +excerpt: Discover the various load balancing algorithms available with the OVHcloud Load Balancer +updated: 2025-10-24 --- ## Objective -The new OVH Load Balancer service offers a variety of load balancing methods for your services. This process determines the way in which the OVH Load Balancer distributes the requests received by your servers. +The OVHcloud Load Balancer service supports a variety of load balancing algorithms for your services. This setting dictates how the Load Balancer distributes incoming client requests among the servers in a farm. -**This guide will provide an introduction to the various load balancing methods, and will explain how you can modify them.** +**This guide introduces the various load balancing methods and explains how to modify them.** ## Requirements -- You must be logged in to the [OVH Control Panel](/links/manager). +- An [OVHcloud Load Balancer](/links/network/load-balancer) service in your OVHcloud account. +- Access to the [OVHcloud Control Panel](/links/manager). - You need to have created a server farm. ## Instructions -### Different load balancing methods +### Available Load Balancing Algorithms -Load balancing is used in server farms. This setting defines the way that requests are distributed between the servers within the farm. +The load balancing setting is applied at the server farm level and defines the method by which client requests are distributed among the servers within that farm. -To understand the basics of the OVH Load Balancer service, please refer to the [Load Balancer Introduction](/pages/network/load_balancer/use_presentation). +For an overview of the OVHcloud Load Balancer service components, please refer to the [Load Balancer Introduction](/pages/network/load_balancer/use_presentation) guide. |Algorithm|Features| |---|---| -|First|The first available server receives the connection. The server is chosen according to its ID, from smallest to largest.| -|LeastConn|Selects the server that has the lowest number of active connections. This setting is recommended for long sessions, with low levels of traffic. The *RoundRobin* algorithm is applied to groups of servers that have the same number of active connections.| -|RoundRobin|Selects the servers one after the other for each connection. **This is the default algorithm.**| -|Source|This algorithm *hashes* the source IP address, then divides the result by the number of servers currently running. The same source IP address will then still be redirected to the same server, provided that it continues to run.| -|URI|This algorithm *hashes* part or all of the URI, then divides the result by the number of servers currently running. The same URI will then still be redirected to the same server, provided that it continues to run.| +|**First**|Directs the connection to the first available server based on its ID (smallest to largest).| +|**LeastConn**|Selects the server with the lowest number of active connections. This is recommended for long-duration sessions with light traffic. The *RoundRobin* algorithm is used for tie-breaking among equally loaded servers.| +|**RoundRobin**|Distributes connections sequentially, one after the other, for each new request. **This is the default algorithm.**| +|**Source**|Uses a hash of the source IP address to consistently redirect the same client IP to the same server, provided the server remains operational.| +|**URI**|Uses a hash of part or all of the URI path to consistently redirect identical URIs to the same server, provided the server remains operational. *(Applicable to HTTP/HTTPS farms only.)*| -### Modify a server farm’s load balancing method via the Control Panel +### Modify a server farm’s load balancing method via the OVHcloud Control Panel -- In the `Server farms`{.action} section (1), you will see the farms that have been created. You can edit them by clicking the three dots on the right-hand side (2), then `Change`{.action}: +- In the `Server farms`{.action} section (1), locate the desired farm. You can edit it by clicking the three dots on the right-hand side (2), then on `Change`{.action}. ![Modify a farm](images/server_cluster_change.png){.thumbnail} -In `Advanced settings`{.action}, you can modify your `Load balancing method`{.action}: +In `Advanced settings`{.action}, modify the `Load balancing method`{.action}. ![Modify a farm](images/distrib_mode_edit.png){.thumbnail} -Once you have selected your preferred load balancing method, click `Update`{.action}, then `Apply configuration`{.action} in the yellow banner that appears: +Once your preferred method is selected, click `Update`{.action}, then click `Apply configuration`{.action} in the yellow banner that appears. ![Apply configuration](images/apply_config.png){.thumbnail} -### Modify a server farm’s load balancing method via the API +### Modify a server farm’s load balancing method via the OVHcloud API -You can modify the load balancing method settings by editing them in the server farm. +The load balancing method is changed by updating the corresponding field within the server farm configuration. -- View details on a server farm +#### View details on a server farm -With this call instruction, you can view details on a server farm if you know its ID. In this example, we will work on an HTTP farm: +Use this api call to view the details of a server farm given its ID. In this example, we work with an HTTP farm: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId} -> +> |Setting|Meaning| |---|---| -|ServiceName*|Your Load Balancer service ID| +|serviceName*|Your Load Balancer service ID| |farmId*|The farm’s ID number| |Response (BackendHttp)|Meaning| |---|---| |farmId|The farm’s ID number| -|balance|Balance type currently set for the farm| +|balance|The load balancing algorithm currently set for the farm| |zone|Name of the zone in which the farm is configured| |port|Port used to contact the servers configured on the farm| |probe|Type of probe currently configured on the farm| |displayName|Name given to this farm| |stickiness|Connection monitoring method currently set for the farm| -- Modify a server farm’s load balancing method +#### Modify a server farm’s load balancing method -With this call instruction, you can edit the settings of a server farm if you know its ID. In this example, we will work on an HTTP farm. To modify the balancing method, the `BackendHttp.balance` field must be updated with an available balancing method: +Use this api call to edit the settings of a server farm given its ID. In this example, we work with an HTTP farm. To modify the balancing method, update the `BackendHttp.balance` field with an available algorithm: > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{id} -> +> |Setting|Meaning| |---|---| -|ServiceName*|Your Load Balancer service ID| +|serviceName*|Your Load Balancer service ID| |farmId*|The farm’s ID number| |BackendHttp.balance|Preferred balancing method for this farm| -- Apply the modifications +#### Apply the modifications > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh -> +> |Setting|Meaning| |---|---| -|ServiceName*|Your Load Balancer service ID| +|serviceName*|Your Load Balancer service ID| |zone*|Name of the zone in which to deploy the configuration| ## Go further -Join our community of users on . +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_balancing/guide.en-gb.md b/pages/network/load_balancer/create_balancing/guide.en-gb.md index 0d25c0f0aea..ddb51f2c8cf 100644 --- a/pages/network/load_balancer/create_balancing/guide.en-gb.md +++ b/pages/network/load_balancer/create_balancing/guide.en-gb.md @@ -1,105 +1,106 @@ --- title: Load balancing methods -excerpt: Find out about the various load balancing methods used by the OVH Load Balancer -updated: 2018-01-17 +excerpt: Discover the various load balancing algorithms available with the OVHcloud Load Balancer +updated: 2025-10-24 --- ## Objective -The new OVH Load Balancer service offers a variety of load balancing methods for your services. This process determines the way in which the OVH Load Balancer distributes the requests received by your servers. +The OVHcloud Load Balancer service supports a variety of load balancing algorithms for your services. This setting dictates how the Load Balancer distributes incoming client requests among the servers in a farm. -**This guide will provide an introduction to the various load balancing methods, and will explain how you can modify them.** +**This guide introduces the various load balancing methods and explains how to modify them.** ## Requirements -- You must be logged in to the [OVH Control Panel](/links/manager). +- An [OVHcloud Load Balancer](/links/network/load-balancer) service in your OVHcloud account. +- Access to the [OVHcloud Control Panel](/links/manager). - You need to have created a server farm. ## Instructions -### Different load balancing methods +### Available Load Balancing Algorithms -Load balancing is used in server farms. This setting defines the way that requests are distributed between the servers within the farm. +The load balancing setting is applied at the server farm level and defines the method by which client requests are distributed among the servers within that farm. -To understand the basics of the OVH Load Balancer service, please refer to the [Load Balancer Introduction](/pages/network/load_balancer/use_presentation). +For an overview of the OVHcloud Load Balancer service components, please refer to the [Load Balancer Introduction](/pages/network/load_balancer/use_presentation) guide. |Algorithm|Features| |---|---| -|First|The first available server receives the connection. The server is chosen according to its ID, from smallest to largest.| -|LeastConn|Selects the server that has the lowest number of active connections. This setting is recommended for long sessions, with low levels of traffic. The *RoundRobin* algorithm is applied to groups of servers that have the same number of active connections.| -|RoundRobin|Selects the servers one after the other for each connection. **This is the default algorithm.**| -|Source|This algorithm *hashes* the source IP address, then divides the result by the number of servers currently running. The same source IP address will then still be redirected to the same server, provided that it continues to run.| -|URI|This algorithm *hashes* part or all of the URI, then divides the result by the number of servers currently running. The same URI will then still be redirected to the same server, provided that it continues to run.| +|**First**|Directs the connection to the first available server based on its ID (smallest to largest).| +|**LeastConn**|Selects the server with the lowest number of active connections. This is recommended for long-duration sessions with light traffic. The *RoundRobin* algorithm is used for tie-breaking among equally loaded servers.| +|**RoundRobin**|Distributes connections sequentially, one after the other, for each new request. **This is the default algorithm.**| +|**Source**|Uses a hash of the source IP address to consistently redirect the same client IP to the same server, provided the server remains operational.| +|**URI**|Uses a hash of part or all of the URI path to consistently redirect identical URIs to the same server, provided the server remains operational. *(Applicable to HTTP/HTTPS farms only.)*| -### Modify a server farm’s load balancing method via the Control Panel +### Modify a server farm’s load balancing method via the OVHcloud Control Panel -- In the `Server farms`{.action} section (1), you will see the farms that have been created. You can edit them by clicking the three dots on the right-hand side (2), then `Change`{.action}: +- In the `Server farms`{.action} section (1), locate the desired farm. You can edit it by clicking the three dots on the right-hand side (2), then on `Change`{.action}. ![Modify a farm](images/server_cluster_change.png){.thumbnail} -In `Advanced settings`{.action}, you can modify your `Load balancing method`{.action}: +In `Advanced settings`{.action}, modify the `Load balancing method`{.action}. ![Modify a farm](images/distrib_mode_edit.png){.thumbnail} -Once you have selected your preferred load balancing method, click `Update`{.action}, then `Apply configuration`{.action} in the yellow banner that appears: +Once your preferred method is selected, click `Update`{.action}, then click `Apply configuration`{.action} in the yellow banner that appears. ![Apply configuration](images/apply_config.png){.thumbnail} -### Modify a server farm’s load balancing method via the API +### Modify a server farm’s load balancing method via the OVHcloud API -You can modify the load balancing method settings by editing them in the server farm. +The load balancing method is changed by updating the corresponding field within the server farm configuration. -- View details on a server farm +#### View details on a server farm -With this call instruction, you can view details on a server farm if you know its ID. In this example, we will work on an HTTP farm: +Use this api call to view the details of a server farm given its ID. In this example, we work with an HTTP farm: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId} -> +> |Setting|Meaning| |---|---| -|ServiceName*|Your Load Balancer service ID| +|serviceName*|Your Load Balancer service ID| |farmId*|The farm’s ID number| |Response (BackendHttp)|Meaning| |---|---| |farmId|The farm’s ID number| -|balance|Balance type currently set for the farm| +|balance|The load balancing algorithm currently set for the farm| |zone|Name of the zone in which the farm is configured| |port|Port used to contact the servers configured on the farm| |probe|Type of probe currently configured on the farm| |displayName|Name given to this farm| |stickiness|Connection monitoring method currently set for the farm| -- Modify a server farm’s load balancing method +#### Modify a server farm’s load balancing method -With this call instruction, you can edit the settings of a server farm if you know its ID. In this example, we will work on an HTTP farm. To modify the balancing method, the `BackendHttp.balance` field must be updated with an available balancing method: +Use this api call to edit the settings of a server farm given its ID. In this example, we work with an HTTP farm. To modify the balancing method, update the `BackendHttp.balance` field with an available algorithm: > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{id} -> +> |Setting|Meaning| |---|---| -|ServiceName*|Your Load Balancer service ID| +|serviceName*|Your Load Balancer service ID| |farmId*|The farm’s ID number| |BackendHttp.balance|Preferred balancing method for this farm| -- Apply the modifications +#### Apply the modifications > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh -> +> |Setting|Meaning| |---|---| -|ServiceName*|Your Load Balancer service ID| +|serviceName*|Your Load Balancer service ID| |zone*|Name of the zone in which to deploy the configuration| ## Go further -Join our community of users on . +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_balancing/guide.en-sg.md b/pages/network/load_balancer/create_balancing/guide.en-sg.md index 0d25c0f0aea..ddb51f2c8cf 100644 --- a/pages/network/load_balancer/create_balancing/guide.en-sg.md +++ b/pages/network/load_balancer/create_balancing/guide.en-sg.md @@ -1,105 +1,106 @@ --- title: Load balancing methods -excerpt: Find out about the various load balancing methods used by the OVH Load Balancer -updated: 2018-01-17 +excerpt: Discover the various load balancing algorithms available with the OVHcloud Load Balancer +updated: 2025-10-24 --- ## Objective -The new OVH Load Balancer service offers a variety of load balancing methods for your services. This process determines the way in which the OVH Load Balancer distributes the requests received by your servers. +The OVHcloud Load Balancer service supports a variety of load balancing algorithms for your services. This setting dictates how the Load Balancer distributes incoming client requests among the servers in a farm. -**This guide will provide an introduction to the various load balancing methods, and will explain how you can modify them.** +**This guide introduces the various load balancing methods and explains how to modify them.** ## Requirements -- You must be logged in to the [OVH Control Panel](/links/manager). +- An [OVHcloud Load Balancer](/links/network/load-balancer) service in your OVHcloud account. +- Access to the [OVHcloud Control Panel](/links/manager). - You need to have created a server farm. ## Instructions -### Different load balancing methods +### Available Load Balancing Algorithms -Load balancing is used in server farms. This setting defines the way that requests are distributed between the servers within the farm. +The load balancing setting is applied at the server farm level and defines the method by which client requests are distributed among the servers within that farm. -To understand the basics of the OVH Load Balancer service, please refer to the [Load Balancer Introduction](/pages/network/load_balancer/use_presentation). +For an overview of the OVHcloud Load Balancer service components, please refer to the [Load Balancer Introduction](/pages/network/load_balancer/use_presentation) guide. |Algorithm|Features| |---|---| -|First|The first available server receives the connection. The server is chosen according to its ID, from smallest to largest.| -|LeastConn|Selects the server that has the lowest number of active connections. This setting is recommended for long sessions, with low levels of traffic. The *RoundRobin* algorithm is applied to groups of servers that have the same number of active connections.| -|RoundRobin|Selects the servers one after the other for each connection. **This is the default algorithm.**| -|Source|This algorithm *hashes* the source IP address, then divides the result by the number of servers currently running. The same source IP address will then still be redirected to the same server, provided that it continues to run.| -|URI|This algorithm *hashes* part or all of the URI, then divides the result by the number of servers currently running. The same URI will then still be redirected to the same server, provided that it continues to run.| +|**First**|Directs the connection to the first available server based on its ID (smallest to largest).| +|**LeastConn**|Selects the server with the lowest number of active connections. This is recommended for long-duration sessions with light traffic. The *RoundRobin* algorithm is used for tie-breaking among equally loaded servers.| +|**RoundRobin**|Distributes connections sequentially, one after the other, for each new request. **This is the default algorithm.**| +|**Source**|Uses a hash of the source IP address to consistently redirect the same client IP to the same server, provided the server remains operational.| +|**URI**|Uses a hash of part or all of the URI path to consistently redirect identical URIs to the same server, provided the server remains operational. *(Applicable to HTTP/HTTPS farms only.)*| -### Modify a server farm’s load balancing method via the Control Panel +### Modify a server farm’s load balancing method via the OVHcloud Control Panel -- In the `Server farms`{.action} section (1), you will see the farms that have been created. You can edit them by clicking the three dots on the right-hand side (2), then `Change`{.action}: +- In the `Server farms`{.action} section (1), locate the desired farm. You can edit it by clicking the three dots on the right-hand side (2), then on `Change`{.action}. ![Modify a farm](images/server_cluster_change.png){.thumbnail} -In `Advanced settings`{.action}, you can modify your `Load balancing method`{.action}: +In `Advanced settings`{.action}, modify the `Load balancing method`{.action}. ![Modify a farm](images/distrib_mode_edit.png){.thumbnail} -Once you have selected your preferred load balancing method, click `Update`{.action}, then `Apply configuration`{.action} in the yellow banner that appears: +Once your preferred method is selected, click `Update`{.action}, then click `Apply configuration`{.action} in the yellow banner that appears. ![Apply configuration](images/apply_config.png){.thumbnail} -### Modify a server farm’s load balancing method via the API +### Modify a server farm’s load balancing method via the OVHcloud API -You can modify the load balancing method settings by editing them in the server farm. +The load balancing method is changed by updating the corresponding field within the server farm configuration. -- View details on a server farm +#### View details on a server farm -With this call instruction, you can view details on a server farm if you know its ID. In this example, we will work on an HTTP farm: +Use this api call to view the details of a server farm given its ID. In this example, we work with an HTTP farm: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId} -> +> |Setting|Meaning| |---|---| -|ServiceName*|Your Load Balancer service ID| +|serviceName*|Your Load Balancer service ID| |farmId*|The farm’s ID number| |Response (BackendHttp)|Meaning| |---|---| |farmId|The farm’s ID number| -|balance|Balance type currently set for the farm| +|balance|The load balancing algorithm currently set for the farm| |zone|Name of the zone in which the farm is configured| |port|Port used to contact the servers configured on the farm| |probe|Type of probe currently configured on the farm| |displayName|Name given to this farm| |stickiness|Connection monitoring method currently set for the farm| -- Modify a server farm’s load balancing method +#### Modify a server farm’s load balancing method -With this call instruction, you can edit the settings of a server farm if you know its ID. In this example, we will work on an HTTP farm. To modify the balancing method, the `BackendHttp.balance` field must be updated with an available balancing method: +Use this api call to edit the settings of a server farm given its ID. In this example, we work with an HTTP farm. To modify the balancing method, update the `BackendHttp.balance` field with an available algorithm: > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{id} -> +> |Setting|Meaning| |---|---| -|ServiceName*|Your Load Balancer service ID| +|serviceName*|Your Load Balancer service ID| |farmId*|The farm’s ID number| |BackendHttp.balance|Preferred balancing method for this farm| -- Apply the modifications +#### Apply the modifications > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh -> +> |Setting|Meaning| |---|---| -|ServiceName*|Your Load Balancer service ID| +|serviceName*|Your Load Balancer service ID| |zone*|Name of the zone in which to deploy the configuration| ## Go further -Join our community of users on . +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_balancing/guide.es-es.md b/pages/network/load_balancer/create_balancing/guide.es-es.md deleted file mode 100644 index a8e597376be..00000000000 --- a/pages/network/load_balancer/create_balancing/guide.es-es.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -title: 'Modos de balanceo' -excerpt: 'Modos de balanceo de la carga del Load Balancer de OVH' -updated: 2018-01-17 ---- - -## Objetivo - -El nuevo Load Balancer de OVH ofrece distintos tipos de balanceo de la carga de los servicios, que determinan la forma en la que las peticiones recibidas se distribuyen entre los servidores. - -**Esta guía explica los distintos tipos de balanceo de carga y cómo cambiar entre ellos.** - -## Requisitos - -- Estar conectado al [área de cliente de OVH](/links/manager). -- Haber creado una granja de servidores. - -## Procedimiento - -### Tipos de balanceo de la carga - -En las granjas de servidores, el balanceo de carga determina la forma en la que las peticiones se distribuirán entre los distintos servidores de la granja. - -Para conocer las principales características del Load Balancer de OVH, consulte la [guía de presentación del servicio](/pages/network/load_balancer/use_presentation). - -|Algoritmo|Funcionalidades| -|---|---| -|Round-robin|Elige un servidor tras otro en cada conexión. Es el algoritmo utilizado por defecto.| -|First|El primer servidor disponible recibe la conexión. El orden de los servidores se elige en función de su ID, de menor a mayor.| -|Least|Elige el servidor con menos conexiones activas. Se recomienda elegir este algoritmo para sesiones prolongadas con poco tráfico. En los grupos de servidores que tienen el mismo número de conexiones activas, se aplica el algoritmo round-robin.| -|Source|Este algoritmo realiza una función de *hash* en la dirección IP de origen y divide el resultado entre el número de servidores activos en ese momento. Cada dirección IP de origen siempre será dirigida al mismo servidor, mientras este permanezca activo.| -|URI|Este algoritmo realiza una función de *hash* en una parte de la URI (o en la URI entera) y divide el resultado entre el número de servidores activos en ese momento. Cada URI siempre será dirigida al mismo servidor, mientras este permanezca activo.| - -### Cambiar el modo de balanceo de la carga de una granja desde el área de cliente - -Una vez en la sección Cloud del área de cliente, haga clic en `Load Balancer`{.action} en la columna izquierda y seleccione el Load Balancer. - -Abra la pestaña `Granjas de servidores`{.action}. Se mostrarán las granjas de servidores existentes en ese momento. Para editar una, haga clic en los tres puntos situados a la derecha de la línea correspondiente y seleccione `Editar`{.action}. - -![Editar una granja](images/server_cluster_change.png){.thumbnail} - -En **Parámetros avanzados** podrá cambiar el modo de balanceo. - -![Editar una granja](images/distrib_mode_edit.png){.thumbnail} - -Una vez seleccionado el modo de balanceo, haga clic en `Actualizar`{.action} y, en la banda amarilla que aparecerá en la parte superior, haga clic en `Aplicar la configuración`{.action}. - -![Aplicar la configuración](images/apply_config.png){.thumbnail} - -### Cambiar el modo de balanceo de la carga de una granja a través de la API - -Para cambiar el modo de balanceo, es necesario editar los parámetros de la granja de servidores. - -#### Ver el detalle de una granja - -Esta llamada a la API permite consultar el detalle de una granja a partir de su identificador. En este ejemplo utilizamos una granja HTTP. - -> [!api] -> -> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId} -> - -|Parámetro|Significado| -|---|---| -|ServiceName*|Identificador del servicio Load Balancer| -|farmId*|Identificador numérico de la granja| - -|Respuesta (BackendHttp)|Significado| -|---|---| -|zone|Nombre de la zona en la que está configurada la granja| -|port|Puerto utilizado para conectar con los servidores configurados en la granja| -|farmId|Identificador numérico de la granja| -|balance|Tipo de balanceo actualmente configurado en la granja| -|probe|Tipo de sonda actualmente configurada en la granja| -|stickiness|Modo de seguimiento de conexión actualmente configurado en la granja| -|displayName|Nombre asignado a la granja| - -#### Cambiar el modo de balanceo de una granja - -Esta llamada a la API permite modificar la configuración de una granja a partir de su identificador. En este ejemplo utilizamos una granja HTTP. Para cambiar el modo de balanceo, es necesario actualizar el campo **BackendHttp.balance** con un modo de balanceo disponible. - -> [!api] -> -> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId} -> - -|Parámetro|Significado| -|---|---| -|serviceName*|Identificador del servicio Load Balancer| -|farmId*|Identificador numérico de la granja| -|BackendHttp.balance|Tipo de balanceo deseado para la granja| - -#### Aplicar los cambios - -> [!api] -> -> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh -> - -|Parámetro|Significado| -|---|---| -|serviceName*|Identificador del servicio Load Balancer| -|zone|Nombre de la zona en la que desea desplegar la configuración| - -## Más información - -Interactúe con nuestra comunidad de usuarios en . \ No newline at end of file diff --git a/pages/network/load_balancer/create_balancing/guide.es-us.md b/pages/network/load_balancer/create_balancing/guide.es-us.md deleted file mode 100644 index a8e597376be..00000000000 --- a/pages/network/load_balancer/create_balancing/guide.es-us.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -title: 'Modos de balanceo' -excerpt: 'Modos de balanceo de la carga del Load Balancer de OVH' -updated: 2018-01-17 ---- - -## Objetivo - -El nuevo Load Balancer de OVH ofrece distintos tipos de balanceo de la carga de los servicios, que determinan la forma en la que las peticiones recibidas se distribuyen entre los servidores. - -**Esta guía explica los distintos tipos de balanceo de carga y cómo cambiar entre ellos.** - -## Requisitos - -- Estar conectado al [área de cliente de OVH](/links/manager). -- Haber creado una granja de servidores. - -## Procedimiento - -### Tipos de balanceo de la carga - -En las granjas de servidores, el balanceo de carga determina la forma en la que las peticiones se distribuirán entre los distintos servidores de la granja. - -Para conocer las principales características del Load Balancer de OVH, consulte la [guía de presentación del servicio](/pages/network/load_balancer/use_presentation). - -|Algoritmo|Funcionalidades| -|---|---| -|Round-robin|Elige un servidor tras otro en cada conexión. Es el algoritmo utilizado por defecto.| -|First|El primer servidor disponible recibe la conexión. El orden de los servidores se elige en función de su ID, de menor a mayor.| -|Least|Elige el servidor con menos conexiones activas. Se recomienda elegir este algoritmo para sesiones prolongadas con poco tráfico. En los grupos de servidores que tienen el mismo número de conexiones activas, se aplica el algoritmo round-robin.| -|Source|Este algoritmo realiza una función de *hash* en la dirección IP de origen y divide el resultado entre el número de servidores activos en ese momento. Cada dirección IP de origen siempre será dirigida al mismo servidor, mientras este permanezca activo.| -|URI|Este algoritmo realiza una función de *hash* en una parte de la URI (o en la URI entera) y divide el resultado entre el número de servidores activos en ese momento. Cada URI siempre será dirigida al mismo servidor, mientras este permanezca activo.| - -### Cambiar el modo de balanceo de la carga de una granja desde el área de cliente - -Una vez en la sección Cloud del área de cliente, haga clic en `Load Balancer`{.action} en la columna izquierda y seleccione el Load Balancer. - -Abra la pestaña `Granjas de servidores`{.action}. Se mostrarán las granjas de servidores existentes en ese momento. Para editar una, haga clic en los tres puntos situados a la derecha de la línea correspondiente y seleccione `Editar`{.action}. - -![Editar una granja](images/server_cluster_change.png){.thumbnail} - -En **Parámetros avanzados** podrá cambiar el modo de balanceo. - -![Editar una granja](images/distrib_mode_edit.png){.thumbnail} - -Una vez seleccionado el modo de balanceo, haga clic en `Actualizar`{.action} y, en la banda amarilla que aparecerá en la parte superior, haga clic en `Aplicar la configuración`{.action}. - -![Aplicar la configuración](images/apply_config.png){.thumbnail} - -### Cambiar el modo de balanceo de la carga de una granja a través de la API - -Para cambiar el modo de balanceo, es necesario editar los parámetros de la granja de servidores. - -#### Ver el detalle de una granja - -Esta llamada a la API permite consultar el detalle de una granja a partir de su identificador. En este ejemplo utilizamos una granja HTTP. - -> [!api] -> -> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId} -> - -|Parámetro|Significado| -|---|---| -|ServiceName*|Identificador del servicio Load Balancer| -|farmId*|Identificador numérico de la granja| - -|Respuesta (BackendHttp)|Significado| -|---|---| -|zone|Nombre de la zona en la que está configurada la granja| -|port|Puerto utilizado para conectar con los servidores configurados en la granja| -|farmId|Identificador numérico de la granja| -|balance|Tipo de balanceo actualmente configurado en la granja| -|probe|Tipo de sonda actualmente configurada en la granja| -|stickiness|Modo de seguimiento de conexión actualmente configurado en la granja| -|displayName|Nombre asignado a la granja| - -#### Cambiar el modo de balanceo de una granja - -Esta llamada a la API permite modificar la configuración de una granja a partir de su identificador. En este ejemplo utilizamos una granja HTTP. Para cambiar el modo de balanceo, es necesario actualizar el campo **BackendHttp.balance** con un modo de balanceo disponible. - -> [!api] -> -> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId} -> - -|Parámetro|Significado| -|---|---| -|serviceName*|Identificador del servicio Load Balancer| -|farmId*|Identificador numérico de la granja| -|BackendHttp.balance|Tipo de balanceo deseado para la granja| - -#### Aplicar los cambios - -> [!api] -> -> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh -> - -|Parámetro|Significado| -|---|---| -|serviceName*|Identificador del servicio Load Balancer| -|zone|Nombre de la zona en la que desea desplegar la configuración| - -## Más información - -Interactúe con nuestra comunidad de usuarios en . \ No newline at end of file diff --git a/pages/network/load_balancer/create_balancing/guide.fr-ca.md b/pages/network/load_balancer/create_balancing/guide.fr-ca.md index 2f5e1657ebf..642b33791f2 100644 --- a/pages/network/load_balancer/create_balancing/guide.fr-ca.md +++ b/pages/network/load_balancer/create_balancing/guide.fr-ca.md @@ -1,39 +1,40 @@ --- -title: Mode de répartition -excerpt: Découvrez les différents modes de répartition de charge de l'OVH Load Balancer -updated: 2018-01-17 +title: Modes de répartition +excerpt: Découvrez les différents modes de répartition de charge du Load Balancer OVHcloud +updated: 2025-10-24 --- ## Objectif -Le nouveau service OVH Load Balancer offre différents types de répartition de charge pour vos services. Ce processus détermine la manière dont l'OVH Load Balancer va répartir les requêtes reçues vers vos serveurs. +Le service OVHcloud Load Balancer prend en charge différents algorithmes de répartition de charge pour vos services. Ce paramètre détermine la manière dont le Load Balancer va distribuer les requêtes clientes entrantes vers les serveurs d'une ferme. -**Ce guide vous présente les différents types de répartition de charge et vous explique comment les modifier.** +**Ce guide présente les différents algorithmes de répartition de charge et explique comment les modifier.** ## Prérequis -- Être connecté à l'[espace client OVH](/links/manager). +- Posséder une offre [OVHcloud Load balancer](/links/network/load-balancer) dans votre compte OVHcloud. +- Être connecté à votre [espace client OVHcloud](/links/manager) - Posséder une ferme de serveurs créée. ## En pratique -### Les différents types de répartition de charge +### Algorithmes de répartition de charge disponibles -La répartition de charge est utilisée dans les fermes de serveurs. C'est ce paramètre qui définit la manière dont les requêtes sont réparties entre les serveurs de la ferme. +L'algorithme de répartition de charge est appliqué au niveau des fermes de serveurs. C'est ce paramètre qui définit la manière dont les requêtes sont réparties entre les serveurs de la ferme. -Pour connaître les différentes parties élémentaires du service OVH Load Balancer, voir [Présentation Load Balancer](/pages/network/load_balancer/use_presentation). +Pour une vue d'ensemble des composants du service OVHcloud Load Balancer, consultez ce guide : [Présentation du service OVHcloud Load Balancer](/pages/network/load_balancer/use_presentation). |Algorithme|Fonctionnalités| |---|---| -|First|Le premier serveur disponible reçoit la connexion. Le serveur est choisi en fonction de son ID, du plus petit au plus grand.| -|LeastConn|Sélectionne le serveur qui a le moins de connexions actives, c'est le paramètre recommandé pour de longues sessions avec peu de trafic. L'algorithme *RoundRobin* est appliqué sur les groupes de serveurs qui ont le même nombre de connexion actives.| -|RoundRobin|Sélectionne les serveurs les uns après les autres pour chaque connexion, **c'est l'algorithme par défaut.**| -|Source|Cet algorithme effectue une fonction de *hashage* (hash) sur l'adresse IP source, puis divise le résultat par le nombre de serveurs actuellement actifs. La même adresse IP source sera alors toujours redirigée vers le même serveur, tant que celui-ci reste actif.| -|URI|Cet algorithme effectue une fonction de *hashage* (hash) sur une partie, ou sur l'URI entière, puis divise le résultat par le nombre de serveurs actuellement actifs. Le même URI sera alors toujours redirigée vers le même serveur tant, que celui-ci reste actif.| +|**First**|Dirige la connexion vers le premier serveur disponible en fonction de son ID (du plus petit au plus grand).| +|**LeastConn**|Sélectionne le serveur qui a le moins de connexions actives. Ceci est recommandé pour les sessions longues avec peu de trafic. L'algorithme *RoundRobin* est appliqué pour départager les serveurs ayant un nombre de connexions actives égal.| +|**RoundRobin**|Distribue les connexions séquentiellement, les unes après les autres, pour chaque nouvelle requête. **C'est l'algorithme par défaut.**| +|**Source**|Utilise une fonction de *hachage* sur l'adresse IP source pour rediriger systématiquement la même IP cliente vers le même serveur, tant que celui-ci reste opérationnel.| +|**URI**|Utilise une fonction de *hachage* sur une partie ou la totalité de l'URI pour rediriger systématiquement les URI identiques vers le même serveur, tant que celui-ci reste opérationnel. *(Applicable uniquement aux fermes HTTP/HTTPS.)*| -### Modifier le mode de répartition de charge d'une ferme via l'espace client +### Modifier l'algorithme de répartition de charge d'une ferme via l'espace client OVHcloud -- Dans la section `Fermes de serveur`{.action} (1) vous verrez les fermes actuellement créées. Il vous suffit d'éditer l'une d'entre elles en cliquant sur les trois points à droite (2) puis `Modifier`{.action} : +Dans la section `Fermes de serveur`{.action}, vous verrez les fermes actuellement créées. Il vous suffit d'éditer l'une d'entre elles en cliquant sur les trois points à droite puis sur `Modifier`{.action} : ![Modification d'une ferme](images/server_cluster_change.png){.thumbnail} @@ -41,65 +42,65 @@ Dans les `Paramètres avancés`{.action} vous pourrez modifier votre `Mode de r ![Modification d'une ferme](images/distrib_mode_edit.png){.thumbnail} -Une fois le mode de répartition souhaité sélectionné, cliquez sur `Mettre à jour`{.action}, puis sur `Appliquer la configuration`{.action} dans le bandeau jaune qui apparaît : +Une fois l'algorithme souhaité sélectionné, cliquez sur `Mettre à jour`{.action}, puis sur `Appliquer la configuration`{.action} dans le bandeau jaune qui apparaît : ![Appliquer la configuration](images/apply_config.png){.thumbnail} -### Modifier le mode de répartition de charge d'une ferme via l'API +### Modifier l'algorithme de répartition de charge d'une ferme depuis l'API OVHcloud -La modification des paramètres de mode de répartition s'effectue en éditant ceux de la ferme de serveurs. +La modification de l'algorithme de répartition s'effectue en éditant le champ correspondant dans la configuration de la ferme de serveurs. -- Voir le détail d'une ferme +#### Voir le détail d'une ferme -Cet appel permet de consulter le détail d'une ferme en connaissant son identifiant. Dans cet exemple, nous allons travailler sur une ferme HTTP : +Cet appel API permet de consulter le détail d'une ferme en connaissant son identifiant. Dans cet exemple, nous travaillons sur une ferme HTTP : > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId} -> +> |Paramètre|Signification| |---|---| -|ServiceName\*|Identifiant de votre service Load Balancer| -|farmId\*|Identifiant numérique de la ferme| +|serviceName*|Identifiant de votre service Load Balancer| +|farmId*|Identifiant numérique de la ferme| |Réponse (BackendHttp)|Signification| |---|---| |farmId|Identifiant numérique de la ferme| -|balance|Type de répartition actuellement configuré sur la ferme| +|balance|Algorithme de répartition de charge actuellement configuré sur la ferme| |zone|Nom de la zone où est configurée la ferme| -|port|port utilisé pour contacter les serveurs configurés sur la ferme| +|port|Port utilisé pour contacter les serveurs configurés sur la ferme| |probe|Type de sonde actuellement configurée sur la ferme| |displayName|Nom donné à cette ferme| |stickiness|Mode de suivi de connexion actuellement configuré sur la ferme| -- Modifier le mode de répartition d'une ferme +#### Modifier l'algorithme de répartition de charge d'une ferme -Cet appel permet de modifier la configuration d'une ferme en connaissant son identifiant. Dans cet exemple, nous allons travailler sur une ferme HTTP. Pour modifier le mode de répartition, le champ `BackendHttp.balance` doit être mis à jour avec un mode de répartition disponible : +Cet appel API permet de modifier la configuration d'une ferme en connaissant son identifiant. Dans cet exemple, nous travaillons sur une ferme HTTP. Pour modifier le mode de répartition, le champ `BackendHttp.balance` doit être mis à jour avec un algorithme disponible : > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{id} -> +> |Paramètre|Signification| |---|---| -|ServiceName\*|Identifiant de votre service Load Balancer| -|farmId\*|Identifiant numérique de la ferme| -|BackendHttp.balance|Type de répartition souhaité pour cette ferme| +|serviceName*|Identifiant de votre service Load Balancer| +|farmId*|Identifiant numérique de la ferme| +|BackendHttp.balance|Algorithme de répartition souhaité pour cette ferme| -- Appliquer les modifications +#### Appliquer les modifications > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh -> +> |Paramètre|Signification| |---|---| -|ServiceName\*|Identifiant de votre service Load Balancer| -|zone\*|Nom de la zone dans laquelle déployer la configuration| +|serviceName*|Identifiant de votre service Load Balancer| +|zone*|Nom de la zone dans laquelle déployer la configuration| ## Aller plus loin -Échangez avec notre [communauté d'utilisateurs](/links/community). +Échangez avec notre [communauté d'utilisateurs](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_balancing/guide.fr-fr.md b/pages/network/load_balancer/create_balancing/guide.fr-fr.md index 5ba2fa28b7f..642b33791f2 100644 --- a/pages/network/load_balancer/create_balancing/guide.fr-fr.md +++ b/pages/network/load_balancer/create_balancing/guide.fr-fr.md @@ -1,14 +1,14 @@ --- -title: Mode de répartition +title: Modes de répartition excerpt: Découvrez les différents modes de répartition de charge du Load Balancer OVHcloud -updated: 2018-01-17 +updated: 2025-10-24 --- ## Objectif -Le service OVHcloud Load Balancer offre différents types de répartition de charge pour vos services. Ce processus détermine la manière dont le Load Balancer OVHcloud va répartir les requêtes reçues vers vos serveurs. +Le service OVHcloud Load Balancer prend en charge différents algorithmes de répartition de charge pour vos services. Ce paramètre détermine la manière dont le Load Balancer va distribuer les requêtes clientes entrantes vers les serveurs d'une ferme. -**Ce guide vous présente les différents types de répartition de charge et vous explique comment les modifier.** +**Ce guide présente les différents algorithmes de répartition de charge et explique comment les modifier.** ## Prérequis @@ -18,23 +18,23 @@ Le service OVHcloud Load Balancer offre différents types de répartition de cha ## En pratique -### Les différents types de répartition de charge +### Algorithmes de répartition de charge disponibles -La répartition de charge est utilisée dans les fermes de serveurs. C'est ce paramètre qui définit la manière dont les requêtes sont réparties entre les serveurs de la ferme. +L'algorithme de répartition de charge est appliqué au niveau des fermes de serveurs. C'est ce paramètre qui définit la manière dont les requêtes sont réparties entre les serveurs de la ferme. -Pour connaître les différentes parties élémentaires du service OVHcloud Load Balancer, consultez la [présentation du Load Balancer](/pages/network/load_balancer/use_presentation). +Pour une vue d'ensemble des composants du service OVHcloud Load Balancer, consultez ce guide : [Présentation du service OVHcloud Load Balancer](/pages/network/load_balancer/use_presentation). |Algorithme|Fonctionnalités| |---|---| -|First|Le premier serveur disponible reçoit la connexion. Le serveur est choisi en fonction de son ID, du plus petit au plus grand.| -|LeastConn|Sélectionne le serveur qui a le moins de connexions actives, c'est le paramètre recommandé pour de longues sessions avec peu de trafic. L'algorithme *RoundRobin* est appliqué sur les groupes de serveurs qui ont le même nombre de connexion actives.| -|RoundRobin|Sélectionne les serveurs les uns après les autres pour chaque connexion, **c'est l'algorithme par défaut.**| -|Source|Cet algorithme effectue une fonction de *hashage* (hash) sur l'adresse IP source, puis divise le résultat par le nombre de serveurs actuellement actifs. La même adresse IP source sera alors toujours redirigée vers le même serveur, tant que celui-ci reste actif.| -|URI|Cet algorithme effectue une fonction de *hashage* (hash) sur une partie, ou sur l'URI entière, puis divise le résultat par le nombre de serveurs actuellement actifs. La même URI sera alors toujours redirigée vers le même serveur tant que celui-ci reste actif.| +|**First**|Dirige la connexion vers le premier serveur disponible en fonction de son ID (du plus petit au plus grand).| +|**LeastConn**|Sélectionne le serveur qui a le moins de connexions actives. Ceci est recommandé pour les sessions longues avec peu de trafic. L'algorithme *RoundRobin* est appliqué pour départager les serveurs ayant un nombre de connexions actives égal.| +|**RoundRobin**|Distribue les connexions séquentiellement, les unes après les autres, pour chaque nouvelle requête. **C'est l'algorithme par défaut.**| +|**Source**|Utilise une fonction de *hachage* sur l'adresse IP source pour rediriger systématiquement la même IP cliente vers le même serveur, tant que celui-ci reste opérationnel.| +|**URI**|Utilise une fonction de *hachage* sur une partie ou la totalité de l'URI pour rediriger systématiquement les URI identiques vers le même serveur, tant que celui-ci reste opérationnel. *(Applicable uniquement aux fermes HTTP/HTTPS.)*| -### Modifier le mode de répartition de charge d'une ferme via l'espace client +### Modifier l'algorithme de répartition de charge d'une ferme via l'espace client OVHcloud -Dans la section `Fermes de serveur`{.action} vous verrez les fermes actuellement créées. Il vous suffit d'éditer l'une d'entre elles en cliquant sur les trois points à droite puis `Modifier`{.action} : +Dans la section `Fermes de serveur`{.action}, vous verrez les fermes actuellement créées. Il vous suffit d'éditer l'une d'entre elles en cliquant sur les trois points à droite puis sur `Modifier`{.action} : ![Modification d'une ferme](images/server_cluster_change.png){.thumbnail} @@ -42,65 +42,65 @@ Dans les `Paramètres avancés`{.action} vous pourrez modifier votre `Mode de r ![Modification d'une ferme](images/distrib_mode_edit.png){.thumbnail} -Une fois le mode de répartition souhaité sélectionné, cliquez sur `Mettre à jour`{.action}, puis sur `Appliquer la configuration`{.action} dans le bandeau jaune qui apparaît : +Une fois l'algorithme souhaité sélectionné, cliquez sur `Mettre à jour`{.action}, puis sur `Appliquer la configuration`{.action} dans le bandeau jaune qui apparaît : ![Appliquer la configuration](images/apply_config.png){.thumbnail} -### Modifier le mode de répartition de charge d'une ferme depuis l'API OVHcloud +### Modifier l'algorithme de répartition de charge d'une ferme depuis l'API OVHcloud -La modification des paramètres de mode de répartition s'effectue en éditant ceux de la ferme de serveurs. +La modification de l'algorithme de répartition s'effectue en éditant le champ correspondant dans la configuration de la ferme de serveurs. #### Voir le détail d'une ferme -Cet appel permet de consulter le détail d'une ferme en connaissant son identifiant. Dans cet exemple, nous allons travailler sur une ferme HTTP : +Cet appel API permet de consulter le détail d'une ferme en connaissant son identifiant. Dans cet exemple, nous travaillons sur une ferme HTTP : > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId} -> +> |Paramètre|Signification| |---|---| -|ServiceName\*|Identifiant de votre service Load Balancer| -|farmId\*|Identifiant numérique de la ferme| +|serviceName*|Identifiant de votre service Load Balancer| +|farmId*|Identifiant numérique de la ferme| |Réponse (BackendHttp)|Signification| |---|---| |farmId|Identifiant numérique de la ferme| -|balance|Type de répartition actuellement configuré sur la ferme| +|balance|Algorithme de répartition de charge actuellement configuré sur la ferme| |zone|Nom de la zone où est configurée la ferme| -|port|port utilisé pour contacter les serveurs configurés sur la ferme| +|port|Port utilisé pour contacter les serveurs configurés sur la ferme| |probe|Type de sonde actuellement configurée sur la ferme| |displayName|Nom donné à cette ferme| |stickiness|Mode de suivi de connexion actuellement configuré sur la ferme| -#### Modifier le mode de répartition d'une ferme +#### Modifier l'algorithme de répartition de charge d'une ferme -Cet appel permet de modifier la configuration d'une ferme en connaissant son identifiant. Dans cet exemple, nous allons travailler sur une ferme HTTP. Pour modifier le mode de répartition, le champ `BackendHttp.balance` doit être mis à jour avec un mode de répartition disponible : +Cet appel API permet de modifier la configuration d'une ferme en connaissant son identifiant. Dans cet exemple, nous travaillons sur une ferme HTTP. Pour modifier le mode de répartition, le champ `BackendHttp.balance` doit être mis à jour avec un algorithme disponible : > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{id} -> +> |Paramètre|Signification| |---|---| -|ServiceName\*|Identifiant de votre service Load Balancer| -|farmId\*|Identifiant numérique de la ferme| -|BackendHttp.balance|Type de répartition souhaité pour cette ferme| +|serviceName*|Identifiant de votre service Load Balancer| +|farmId*|Identifiant numérique de la ferme| +|BackendHttp.balance|Algorithme de répartition souhaité pour cette ferme| #### Appliquer les modifications > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh -> +> |Paramètre|Signification| |---|---| -|ServiceName\*|Identifiant de votre service Load Balancer| -|zone\*|Nom de la zone dans laquelle déployer la configuration| +|serviceName*|Identifiant de votre service Load Balancer| +|zone*|Nom de la zone dans laquelle déployer la configuration| ## Aller plus loin -Échangez avec notre [communauté d'utilisateurs](/links/community). +Échangez avec notre [communauté d'utilisateurs](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_balancing/guide.it-it.md b/pages/network/load_balancer/create_balancing/guide.it-it.md deleted file mode 100644 index 9d94c5e9bf3..00000000000 --- a/pages/network/load_balancer/create_balancing/guide.it-it.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -title: 'Modalità di ripartizione' -excerpt: 'Scopri le diverse modalità di ripartizione del carico dell’OVH Load Balancer' -updated: 2018-01-17 ---- - -## Obiettivo - -La nuova soluzione OVH Load Balancer offre diverse tipologie di ripartizione del carico per i tuoi servizi. Questo processo determina il modo in cui l’OVH Load Balancer ripartisce le richieste ricevute verso i tuoi server. - -**Questa guida ti mostra i diversi tipi di ripartizione del carico e ti spiega come modificarli.** - -## Prerequisiti - -- Avere accesso allo [Spazio Cliente OVH](/links/manager) -- Disporre di una server farm - -## Procedura - -### Le diverse tipologie di ripartizione del carico - -La ripartizione del carico si utilizza nelle server farm. Attraverso questo parametro si definisce il modo in cui le richieste vengono suddivise tra i server della farm. - -Per saperne di più sul servizio OVH Load Balancer, consulta la seguente guida: [Presentazione Load Balancer](/pages/network/load_balancer/use_presentation). - -|Algoritmo|Caratteristiche| -|---|---| -|First|Il primo server disponibile riceve la connessione. La scelta del server avviene in base all’ID, dal più piccolo al più grande.| -|LeastConn|Seleziona il server con il numero minore di connessioni attive: è l’opzione suggerita per lunghe sessioni con poco traffico. L'algoritmo *RoundRobin* si applica sui gruppi di server con lo stesso numero di connessioni attive.| -|RoundRobin|Seleziona i server uno dopo l’altro per ciascuna connessione, **è l’algoritmo di default.**| -|Source|Questo algoritmo ha una funzione di *hash* sull’indirizzo IP di origine e divide il risultato per il numero di server attivi in quel preciso momento. Lo stesso indirizzo IP di origine verrà quindi sempre reindirizzato verso lo stesso server, fino a quando questo resterà attivo.| -|URI|Questo algoritmo ha una funzione di *hash* su una parte dell’URI (o sull’URI per intero) e divide il risultato per il numero dei server attivi in quel preciso momento. Lo stesso URI verrà quindi sempre reindirizzato verso lo stesso server fino a quando questo resterà attivo.| - -### Modifica la modalità di ripartizione del carico di una server farm attraverso lo Spazio Cliente - -- Nella sezione `Server farm`{.action} (1) puoi visualizzare le farm precedentemente create. è sufficiente modificarne una cliccando sui tre puntini a destra (2) poi su `Modifica`{.action} (3): - -![Modification d'une ferme](images/server_cluster_change.png){.thumbnail} - -Nella sezione `Opzioni avanzate`{.action} puoi modificare la `Modalità di ripartizione`{.action}: - -![Modification d'une ferme](images/distrib_mode_edit.png){.thumbnail} - -Una volta modificata la modalità di ripartizione, clicca su `Aggiorna`{.action}, e poi su `Applica la configurazione`{.action} nella barra gialla che apparirà in alto: - -![Attivazione della configurazione](images/apply_config.png){.thumbnail} - -### Modifica la modalità di ripartizione del carico di una server farm via API - -Per cambiare i parametri della modalità di ripartizione attraverso le API è necessario modificare la configurazione della server farm. - -- Una server farm nel dettaglio - -Questa chiamata API consente di consultare il dettaglio di una farm a partire dal relativo identificativo. In questo esempio utilizziamo una farm HTTP: - -> [!api] -> -> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId} -> - -|Parametro|Significato| -|---|---| -|ServiceName*|Identificativo del tuo servizio Load Balancer| -|farmId*|Identificativo numerico della farm| - -|Risposta (BackendHttp)|Significato| -|---|---| -|farmId|Identificativo numerico della farm| -|balance|Tipo di ripartizione attualmente configurato sulla farm| -|zone|Nome della zona in cui è stata configurata la farm| -|port|Porta utilizzata per contattare i server configurati sulla farm| -|probe|Tipo di sonda attualmente configurata sulla farm| -|displayName|Nome assegnato a questa farm| -|stikiness|Modalità di monitoraggio della connessione attualmente configurato sulla farm| - -- Modifica la modalità di ripartizione di una server farm - -Questa chiamata API consente di consultare il dettaglio di una farm a partire dal relativo identificativo. In questo esempio utilizziamo una farm HTTP: Per modificare la modalità di ripartizione, è necessario aggiornare il campo `BackendHttp.balance` con una modalità di ripartizione disponibile: - -> [!api] -> -> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{id} -> - -|Parametro|Significato| -|---|---| -|ServiceName*|Identificativo del tuo servizio Load Balancer| -|farmId*|Identificativo numerico della farm| -|BackendHttp.balance|Tipo di ripartizione preferita per questa farm| - -- Applica le modifiche - -> [!api] -> -> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh -> - -|Parametro|Significato| -|---|---| -|ServiceName*|Identificativo del tuo servizio Load Balancer| -|zone*|Nome della zona in cui distribuire la configurazione| - -## Per saperne di più - -Contatta la nostra Community di utenti all’indirizzo . diff --git a/pages/network/load_balancer/create_balancing/guide.pl-pl.md b/pages/network/load_balancer/create_balancing/guide.pl-pl.md deleted file mode 100644 index cc922e077b2..00000000000 --- a/pages/network/load_balancer/create_balancing/guide.pl-pl.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -title: Sposoby równoważenia obciążenia -excerpt: Poznaj różne sposoby równoważenia obciążenia dostępne w usłudze Load Balancer -updated: 2018-01-17 ---- - -## Wprowadzenie - -Nowa usługa Load Balancer oferuje różne typy równoważenia obciążenia (load balancingu) dla Twoich usług. Opisany proces określa sposób, w jaki Load Balancer będzie rozdzielał zapytania kierowane do Twoich serwerów. - -**Niniejszy przewodnik przedstawia różne typy równoważenia obciążenia i wyjaśnia, jak je modyfikować.** - -## Wymagania początkowe - -- Dostęp do [Panelu klienta OVH](/links/manager) -- Aktywna usługa Load Balancer -- Utworzona farma serwerów - -## W praktyce - -### Różne typy równoważenia obciążenia - -Równoważenie obciążenia realizowane jest w farmach serwerów. Poniżej podane są parametry, które określają sposób, w jaki zapytania są rozdzielane między serwery danej farmy. - -Poznaj podstawowe części składowe usługi w [przewodniku prezentującym Load Balancer](/pages/network/load_balancer/use_presentation). - -|Algorytm|Funkcje| -|---|---| -|First|Pierwszy dostępny serwer otrzymuje połączenie. Serwer jest wybierany według jego ID, od najniższego numeru do najwyższego. | -|LeastConn|Wybierz serwer, który ma najmniej aktywnych połączeń. Jest to parametr zalecany w przypadku długich sesji i niewielkiego ruchu. Algorytm*RoundRobin* stosowany jest w grupach serwerów mających tę samą liczbę aktywnych połączeń.| -|RoundRobin|Połączenia są przekazywane, kolejno do każdego serwera, **to algorytm domyślny.**| -|Source|Algorytm wykonuje funkcję *hash* na źródłowym adresie IP, następnie dzieli wynik przez liczbę serwerów aktywnych w danym momencie. Ten sam źródłowy adres IP będzie zawsze przekierowywany do tego samego serwera, dopóki pozostaje on aktywny.| -|URI|Algorytm wykonuję funkcję *hash* na części lub całości URI, następnie dzieli wynik przez liczbę serwerów aktywnych w danym momencie. Ten sam URI będzie zawsze przekierowywany do tego samego serwera, dopóki pozostaje on aktywny.| - -### Modyfikacja sposobu równoważenia obciążenia farmy w Panelu klienta - -- Sprawdź utworzone farmy w sekcji `Farmy serwerów`{.action} (1). Edytuj wybraną farmę, klikając trzy kropki, oznaczające rozwijane menu, po prawej stronie (2), a następnie kliknij `Modyfikuj`{.action} : - -![Modyfikacja farmy](images/server_cluster_change.png){.thumbnail} - - `Sposób równoważenia obciążenia`{.action} możesz zmienić w `Ustawieniach zaawansowanych`{.action}: - -![Modyfikacja farmy](images/distrib_mode_edit.png){.thumbnail} - -Po wybraniu sposobu równoważenia obciążenia kliknij `Aktualizacja`{.action}, a następnie `Zastosuj konfigurację`{.action} na żółtym pasku, który się pojawi: - -![Zastosuj konfigurację](images/apply_config.png){.thumbnail} - -### Modyfikacja sposobu równoważenia obciążenia farmy przez API - -Modyfikacja ustawień sposobu równoważenia obciążenia następuje po zmianie ustawień farmy serwerów. - -- Zobacz szczegóły dotyczące farmy. - -Komenda ta pozwala wyświetlić szczegóły dotyczące farmy serwerów po wpisaniu jej identyfikatora. Operacja została przedstawiona poniżej na przykładzie farmy HTTP. - -> [!api] -> -> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId} -> - -|Parametr|Opis| -|---|---| -|ServiceName*|Identyfikator Twojej usługi Load Balancer| -|farmId*|Identyfikator numeryczny farmy| - -|Odpowiedź (BackendHttp)|Opis| -|---|---| -|farmId|Identyfikator numeryczny farmy| -|balance|Typ równoważenia obciążenia obecnie skonfigurowany dla farmy| -|zone|Nazwa strefy, w której skonfigurowana jest farma| -|port|port używany do łączenia się z serwerami skonfigurowanymi w farmie| -|probe|Typ sondy skonfigurowanej w farmie| -|displayName|Nazwa nadana tej farmie| -|stickiness|Sposób połączenia skonfigurowany w farmie| - -- Zmodyfikuj sposób równoważenia obciążenia farmy. - -Komenda ta pozwala zmodyfikować konfigurację farmy po wpisaniu jej identyfikatora. Operacja została przedstawiona poniżej na przykładzie farmy HTTP: Aby zmodyfikować sposób równoważenia obciążenia, zaktualizuj pole `BackendHttp.balance`, wpisując dostępny sposób równoważenia: - -> [!api] -> -> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{id} -> - -|Parametr|Opis| -|---|---| -|ServiceName*|Identyfikator Twojej usługi Load Balancer| -|farmId*|Identyfikator numeryczny farmy| -|BackendHttp.balance|Typ równoważenia wybrany dla tej farmy| - -- Zastosuj modyfikacje. - -> [!api] -> -> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh -> - -|Parametr|Opis| -|---|---| -|ServiceName*|Identyfikator Twojej usługi Load Balancer| -|zone*|Nazwa strefy do konfiguracji| - -## Sprawdź również - -Przyłącz się do społeczności naszych użytkowników na stronie . diff --git a/pages/network/load_balancer/create_balancing/guide.pt-pt.md b/pages/network/load_balancer/create_balancing/guide.pt-pt.md deleted file mode 100644 index d5af737a31b..00000000000 --- a/pages/network/load_balancer/create_balancing/guide.pt-pt.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -title: 'Método de repartição' -excerpt: 'Conheça os diferentes métodos de repartição de carga do Load Balancer OVH' -updated: 2018-01-17 ---- - -## Sumário - -O novo Load Balancer OVH oferece diferentes tipos de repartição de carga para os seus serviços. Este processo determina a forma como o Load Balancer OVH distribui os pedidos recebidos pelos seus servidores. - -**Este guia apresenta os diferentes tipos de repartição de carga e explica como modificá-los.** - -## Requisitos - -- Ter acesso à [Área de Cliente OVH](/links/manager). -- Ter uma Farm de servidores criada. - -## Instruções - -### Os diferentes tipos de repartição de carga - -A repartição de carga é utilizada nas Farms de servidores. É este parâmetro que define a forma como os pedidos são distribuídos entre os servidores da Farm. - -Para conhecer os principais elementos do Load Balancer OVH, consulte [Apresentação do Load Balancer](/pages/network/load_balancer/use_presentation). - -|Algoritmo|Funcionalidades| -|---|---| -|First|O primeiro servidor disponível recebe a conexão. O servidor é escolhido em função do seu ID, do menor ao maior.| -LeastConn|Seleciona o servidor que tem menos conexões ativas. Este parâmetro é recomendado para sessões longas com pouco tráfego. O algortimo *RoundRobin* é aplicado aos grupos de servidores que têm o mesmo número de conexões ativas.| -|RoundRobin|Seleciona os servidores um após o outro para cada conexão. **Este é o algoritmo usado por defeito.**| -|Source|Este algoritmo efetua uma função de *hash* no endereço IP de origem e a seguir divide o resultado pelo número de servidores atualmente ativos. Cada endereço IP de origem será então redirigido para o mesmo servidor, enquanto este continuar ativo.| -|URI|Este algoritmo efetua uma função de *hash* numa parte da URI, ou na URI inteira, e a seguir divide o resultado pelo número de servidores atualmente ativos. Cada URI será então redirigida para o mesmo servidor, enquanto este continuar ativo.| - -### Modificar o método de repartição de carga de uma Farm através da Área de Cliente - -- Na secção `Server farms`{.action} (1), verá as Farms já criadas. Basta editar uma delas clicando nos três pontos à direita (2) e depois em `Change`{.action}: - -![Modificação de uma Farm](images/server_cluster_change.png){.thumbnail} - -Em `Advanced settings`{.action}, poderá modificar o `Load balancing method`{.action}: - -![Modificação de uma Farm](images/distrib_mode_edit.png){.thumbnail} - -Quando tiver selecionado o método de repartição desejado, clique em `Update`{.action} e depois em `Apply configuration`{.action} na barra amarela que surgir: - -![Aplicar a configuração ](images/apply_config.png){.thumbnail} - -### Modificar o método de repartição de carga de uma Farm através da API - -Para modificar os parâmetros do método de repartição, edite os parâmetros da Farm de servidores. - -- Ver detalhes de uma Farm - -Esta instrução permite consultar detalhes de uma Farm se conhecer o seu ID. Neste exemplo, vamos trabalhar sobre uma Farm HTTP: - -> [!api] -> -> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId} -> - -|Parâmetro|Significado| -|---|---| -|ServiceName*|ID do serviço Load Balancer| -|farmId*|ID da Farm| - -|Resposta (BackendHttp)|Significado| -|---|---| -|farmId|ID da Farm| -|balance|Tipo de repartição atualmente configurado para a Farm| -|zone|Nome da zona em que está configurada a Farm| -|port|Porta usada para ligar aos servidores configurados na Farm| -|probe|Tipo de probe atualmente configurado para a Farm| -|displayName|Nome dado a esta Farm| -|stikiness|Modo de monitoramento de conexão atualmente configurado para a Farm| - -- Modificar o método de repartição de uma Farm - -Esta instrução permite modificar a configuração de uma Farm se conhecer o seu ID. Neste exemplo, vamos trabalhar sobre uma Farm HTTP. Para modificar o método de repartição, o campo `BackendHttp.balance` deve ser atualizado com um método de repartição disponível: - -> [!api] -> -> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{id} -> - -|Parâmetro|Significado| -|---|---| -|ServiceName*|ID do serviço Load Balancer| -|farmId*|ID da Farm| -|BackendHttp.balance|Tipo de repartição desejado para esta Farm| - -- Aplicar as modificações - -> [!api] -> -> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh -> - -|Parâmetro|Significado| -|---|---| -|ServiceName*|ID do Load Balancer| -|zone*|Nome da zona na qual deseja aplicar a configuração| - -## Quer saber mais? - -Fale com a nossa comunidade de utilizadores: . diff --git a/pages/network/load_balancer/create_faq/guide.en-asia.md b/pages/network/load_balancer/create_faq/guide.en-asia.md index 1a10812d5ed..af443228d6a 100644 --- a/pages/network/load_balancer/create_faq/guide.en-asia.md +++ b/pages/network/load_balancer/create_faq/guide.en-asia.md @@ -1,23 +1,40 @@ --- -title: 'Load Balancer FAQ' -excerpt: 'FAQ Load Balancer' -updated: 2018-03-26 +title: 'OVHcloud Load Balancer FAQ' +excerpt: 'Frequently Asked Questions on the OVHcloud Load Balancer' +updated: 2025-11-12 --- -## How do I configure my Firewall to accept traffic from the OVHcloud Load Balancer? -When using the Load Balancer, your clients do not connect directly to your servers. A good practice is to setup a firewall to allow only traffic from the OVHcloud Load Balancer service. +## Objective -- To determine which IPs to allow in your firewall, you can use the following API call: +This document provides a set of the most frequently asked questions and their corresponding OVHcloud API calls for performing common management and configuration tasks on your OVHcloud Load Balancer service. + +## FAQ + +### How do I configure my Firewall to accept traffic from the OVHcloud Load Balancer? + +When using the Load Balancer, your clients do not connect directly to your servers. A good practice is to set up a firewall to allow only traffic from the OVHcloud Load Balancer service. + +#### Via the OVHcloud API + +To determine which IP addresses you need to allow in your firewall, you can use the following API call: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/natIp > -## How do I know the status of my service? +#### Via the OVHcloud Control Panel + +In your Load Balancer service, navigate to the `Home`{.action} tab, and find the **Information** section. On the **Outbound IPv4** line, click the ellipsis, and select "Read". +A window will open, listing the IP addresses you need to allow in your firewall. + +### How do I know the status of my service? + Sometimes it may be useful to know the status of your OVHcloud Load Balancer. -- To determine the status of your service, you can use the following API call : +#### Via the OVHcloud API + +To determine the status of your service, you can use the following API call: > [!api] > @@ -26,45 +43,75 @@ Sometimes it may be useful to know the status of your OVHcloud Load Balancer. The different statuses of the OVHcloud Load Balancer can be `running`{.action} (Active), `reload`{.action} (Refresh in progress), `unknown`{.action} (Not yet started), or `dead`{.action} (inactive). -## How to add an Additional IP to the OVHcloud Load Balancer? -An Additional IP is an additional IP in which can be joined with your primary IP. The Additional IP can be switched from one server to another in seconds. +#### Via the OVHcloud Control Panel + +In your Load Balancer service dashboard, navigate to the `Home`{.action} tab, and find the **Status** section, which lists the internal service name of your Load Balancer and its status. + +### How to add an Additional IP to the OVHcloud Load Balancer? + +An Additional IP is an secondary IP address which can be associated to your service in addition to your primary IP. The Additional IP can be switched from one server to another in seconds. + +#### Via the OVHcloud API -- To add an Additional IP to an OVHcloud Load Balancer service : +- To add an Additional IP to an OVHcloud Load Balancer service: > [!api] > > @api {v1} /ip POST /ip/{ip}/move > -- Apply the change : +- Apply the change: > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh > -## How to list the Additional IPs routed to the OVHcloud Load Balancer? +#### Via the OVHcloud Control Panel + +In your Load Balancer service dashboard, click on `Front-ends`{.action}, then on `Add a front-end`{.action}. +Then, expand the `Advanced settings`{.action}, and select the Additional IPs you would like to add to your front-end *(listed on the interface as "Dedicated failover IP")*. + +### How to list the Additional IPs routed to the OVHcloud Load Balancer? > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/failover > -## How do I order a free SSL certificate ? -It is possible to order a free SSL ceritificate for the OVHcloud Load Balancer.. +### How do I order a free SSL certificate? + +#### Via the OVHcloud Control Panel + +In your Load Balancer service dashboard, navigate to the `SSL certificates`{.action} tab, and click on `Order an SSL certificate`{.action}. +Fill in the FQDN in the dedicated field, then click on `Order`{.action}. + +For the order to be completed, it is required that the domain name points to your OVHcloud Load Balancer. + +#### Via the OVHcloud API + +It is possible to order a free SSL certificate for the OVHcloud Load Balancer. -- To order a free SSL certificate, you can use the following API call and entering your domain in the `fqdn` field: +- To order a free SSL certificate, you can use the following API call and enter your domain in the ‘fqdn’ field: > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/freeCertificate > -It is possible to order a multi-domain certificate; the `fqdn` fields accepts a sting type input. +It is possible to order a multi-domain certificate; the `fqdn` field accepts a string type input. -For the orer to be completed, it is required that the domain name points to your OVHcloud Load Balancer. +For the order to be completed, it is required that the domain name points to your OVHcloud Load Balancer. -## How to list the SSL certificates associated with the OVHcloud Load Balancer ? +### How to list the SSL certificates associated with the OVHcloud Load Balancer? + +#### Via the OVHcloud Control Panel + +In your Load Balancer service dashboard, navigate to the `SSL certificates`{.action} section, where you will find a table listing the certificates associated to that Load Balancer. + +To retrieve the details of an SSL certificate, click the ellipsis button to the right of the desired certificate, then click on `See a preview`{.action}. + +#### Via the OVHcloud API - To list the SSL certificates associated with the OVHcloud Load Balancer, you can use the following API call: @@ -73,14 +120,19 @@ For the orer to be completed, it is required that the domain name points to your > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl > -The SSL certificates that have been ordered (free or not) will appear as `built`. Those added by yourself are will appear as `custom`. +The SSL certificates that have been ordered (free or not) will appear as `built`. Those added by yourself will appear as `custom`. -An SSL certificate appearing as `built_not_routed` is a certificate that has been order and delivered, but whose domain cannot be validated. Usually, this is because the domain to longer points to the OVHcloud Load Balancer. +An SSL certificate appearing as `built_not_routed` is a certificate that has been ordered and delivered, but whose domain cannot be validated. Usually, this is because the domain no longer points to the OVHcloud Load Balancer. -- To retrieve the details of an SSL certificate, you can use the following API call : +- To retrieve the details of an SSL certificate, you can use the following API call: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl/{id} > +## Go further + +Find details about all the API calls related to the OVHcloud Load Balancer in [this guide](/pages/network/load_balancer/use_api_details). + +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_faq/guide.en-au.md b/pages/network/load_balancer/create_faq/guide.en-au.md index 1a10812d5ed..af443228d6a 100644 --- a/pages/network/load_balancer/create_faq/guide.en-au.md +++ b/pages/network/load_balancer/create_faq/guide.en-au.md @@ -1,23 +1,40 @@ --- -title: 'Load Balancer FAQ' -excerpt: 'FAQ Load Balancer' -updated: 2018-03-26 +title: 'OVHcloud Load Balancer FAQ' +excerpt: 'Frequently Asked Questions on the OVHcloud Load Balancer' +updated: 2025-11-12 --- -## How do I configure my Firewall to accept traffic from the OVHcloud Load Balancer? -When using the Load Balancer, your clients do not connect directly to your servers. A good practice is to setup a firewall to allow only traffic from the OVHcloud Load Balancer service. +## Objective -- To determine which IPs to allow in your firewall, you can use the following API call: +This document provides a set of the most frequently asked questions and their corresponding OVHcloud API calls for performing common management and configuration tasks on your OVHcloud Load Balancer service. + +## FAQ + +### How do I configure my Firewall to accept traffic from the OVHcloud Load Balancer? + +When using the Load Balancer, your clients do not connect directly to your servers. A good practice is to set up a firewall to allow only traffic from the OVHcloud Load Balancer service. + +#### Via the OVHcloud API + +To determine which IP addresses you need to allow in your firewall, you can use the following API call: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/natIp > -## How do I know the status of my service? +#### Via the OVHcloud Control Panel + +In your Load Balancer service, navigate to the `Home`{.action} tab, and find the **Information** section. On the **Outbound IPv4** line, click the ellipsis, and select "Read". +A window will open, listing the IP addresses you need to allow in your firewall. + +### How do I know the status of my service? + Sometimes it may be useful to know the status of your OVHcloud Load Balancer. -- To determine the status of your service, you can use the following API call : +#### Via the OVHcloud API + +To determine the status of your service, you can use the following API call: > [!api] > @@ -26,45 +43,75 @@ Sometimes it may be useful to know the status of your OVHcloud Load Balancer. The different statuses of the OVHcloud Load Balancer can be `running`{.action} (Active), `reload`{.action} (Refresh in progress), `unknown`{.action} (Not yet started), or `dead`{.action} (inactive). -## How to add an Additional IP to the OVHcloud Load Balancer? -An Additional IP is an additional IP in which can be joined with your primary IP. The Additional IP can be switched from one server to another in seconds. +#### Via the OVHcloud Control Panel + +In your Load Balancer service dashboard, navigate to the `Home`{.action} tab, and find the **Status** section, which lists the internal service name of your Load Balancer and its status. + +### How to add an Additional IP to the OVHcloud Load Balancer? + +An Additional IP is an secondary IP address which can be associated to your service in addition to your primary IP. The Additional IP can be switched from one server to another in seconds. + +#### Via the OVHcloud API -- To add an Additional IP to an OVHcloud Load Balancer service : +- To add an Additional IP to an OVHcloud Load Balancer service: > [!api] > > @api {v1} /ip POST /ip/{ip}/move > -- Apply the change : +- Apply the change: > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh > -## How to list the Additional IPs routed to the OVHcloud Load Balancer? +#### Via the OVHcloud Control Panel + +In your Load Balancer service dashboard, click on `Front-ends`{.action}, then on `Add a front-end`{.action}. +Then, expand the `Advanced settings`{.action}, and select the Additional IPs you would like to add to your front-end *(listed on the interface as "Dedicated failover IP")*. + +### How to list the Additional IPs routed to the OVHcloud Load Balancer? > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/failover > -## How do I order a free SSL certificate ? -It is possible to order a free SSL ceritificate for the OVHcloud Load Balancer.. +### How do I order a free SSL certificate? + +#### Via the OVHcloud Control Panel + +In your Load Balancer service dashboard, navigate to the `SSL certificates`{.action} tab, and click on `Order an SSL certificate`{.action}. +Fill in the FQDN in the dedicated field, then click on `Order`{.action}. + +For the order to be completed, it is required that the domain name points to your OVHcloud Load Balancer. + +#### Via the OVHcloud API + +It is possible to order a free SSL certificate for the OVHcloud Load Balancer. -- To order a free SSL certificate, you can use the following API call and entering your domain in the `fqdn` field: +- To order a free SSL certificate, you can use the following API call and enter your domain in the ‘fqdn’ field: > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/freeCertificate > -It is possible to order a multi-domain certificate; the `fqdn` fields accepts a sting type input. +It is possible to order a multi-domain certificate; the `fqdn` field accepts a string type input. -For the orer to be completed, it is required that the domain name points to your OVHcloud Load Balancer. +For the order to be completed, it is required that the domain name points to your OVHcloud Load Balancer. -## How to list the SSL certificates associated with the OVHcloud Load Balancer ? +### How to list the SSL certificates associated with the OVHcloud Load Balancer? + +#### Via the OVHcloud Control Panel + +In your Load Balancer service dashboard, navigate to the `SSL certificates`{.action} section, where you will find a table listing the certificates associated to that Load Balancer. + +To retrieve the details of an SSL certificate, click the ellipsis button to the right of the desired certificate, then click on `See a preview`{.action}. + +#### Via the OVHcloud API - To list the SSL certificates associated with the OVHcloud Load Balancer, you can use the following API call: @@ -73,14 +120,19 @@ For the orer to be completed, it is required that the domain name points to your > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl > -The SSL certificates that have been ordered (free or not) will appear as `built`. Those added by yourself are will appear as `custom`. +The SSL certificates that have been ordered (free or not) will appear as `built`. Those added by yourself will appear as `custom`. -An SSL certificate appearing as `built_not_routed` is a certificate that has been order and delivered, but whose domain cannot be validated. Usually, this is because the domain to longer points to the OVHcloud Load Balancer. +An SSL certificate appearing as `built_not_routed` is a certificate that has been ordered and delivered, but whose domain cannot be validated. Usually, this is because the domain no longer points to the OVHcloud Load Balancer. -- To retrieve the details of an SSL certificate, you can use the following API call : +- To retrieve the details of an SSL certificate, you can use the following API call: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl/{id} > +## Go further + +Find details about all the API calls related to the OVHcloud Load Balancer in [this guide](/pages/network/load_balancer/use_api_details). + +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_faq/guide.en-ca.md b/pages/network/load_balancer/create_faq/guide.en-ca.md index 1a10812d5ed..af443228d6a 100644 --- a/pages/network/load_balancer/create_faq/guide.en-ca.md +++ b/pages/network/load_balancer/create_faq/guide.en-ca.md @@ -1,23 +1,40 @@ --- -title: 'Load Balancer FAQ' -excerpt: 'FAQ Load Balancer' -updated: 2018-03-26 +title: 'OVHcloud Load Balancer FAQ' +excerpt: 'Frequently Asked Questions on the OVHcloud Load Balancer' +updated: 2025-11-12 --- -## How do I configure my Firewall to accept traffic from the OVHcloud Load Balancer? -When using the Load Balancer, your clients do not connect directly to your servers. A good practice is to setup a firewall to allow only traffic from the OVHcloud Load Balancer service. +## Objective -- To determine which IPs to allow in your firewall, you can use the following API call: +This document provides a set of the most frequently asked questions and their corresponding OVHcloud API calls for performing common management and configuration tasks on your OVHcloud Load Balancer service. + +## FAQ + +### How do I configure my Firewall to accept traffic from the OVHcloud Load Balancer? + +When using the Load Balancer, your clients do not connect directly to your servers. A good practice is to set up a firewall to allow only traffic from the OVHcloud Load Balancer service. + +#### Via the OVHcloud API + +To determine which IP addresses you need to allow in your firewall, you can use the following API call: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/natIp > -## How do I know the status of my service? +#### Via the OVHcloud Control Panel + +In your Load Balancer service, navigate to the `Home`{.action} tab, and find the **Information** section. On the **Outbound IPv4** line, click the ellipsis, and select "Read". +A window will open, listing the IP addresses you need to allow in your firewall. + +### How do I know the status of my service? + Sometimes it may be useful to know the status of your OVHcloud Load Balancer. -- To determine the status of your service, you can use the following API call : +#### Via the OVHcloud API + +To determine the status of your service, you can use the following API call: > [!api] > @@ -26,45 +43,75 @@ Sometimes it may be useful to know the status of your OVHcloud Load Balancer. The different statuses of the OVHcloud Load Balancer can be `running`{.action} (Active), `reload`{.action} (Refresh in progress), `unknown`{.action} (Not yet started), or `dead`{.action} (inactive). -## How to add an Additional IP to the OVHcloud Load Balancer? -An Additional IP is an additional IP in which can be joined with your primary IP. The Additional IP can be switched from one server to another in seconds. +#### Via the OVHcloud Control Panel + +In your Load Balancer service dashboard, navigate to the `Home`{.action} tab, and find the **Status** section, which lists the internal service name of your Load Balancer and its status. + +### How to add an Additional IP to the OVHcloud Load Balancer? + +An Additional IP is an secondary IP address which can be associated to your service in addition to your primary IP. The Additional IP can be switched from one server to another in seconds. + +#### Via the OVHcloud API -- To add an Additional IP to an OVHcloud Load Balancer service : +- To add an Additional IP to an OVHcloud Load Balancer service: > [!api] > > @api {v1} /ip POST /ip/{ip}/move > -- Apply the change : +- Apply the change: > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh > -## How to list the Additional IPs routed to the OVHcloud Load Balancer? +#### Via the OVHcloud Control Panel + +In your Load Balancer service dashboard, click on `Front-ends`{.action}, then on `Add a front-end`{.action}. +Then, expand the `Advanced settings`{.action}, and select the Additional IPs you would like to add to your front-end *(listed on the interface as "Dedicated failover IP")*. + +### How to list the Additional IPs routed to the OVHcloud Load Balancer? > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/failover > -## How do I order a free SSL certificate ? -It is possible to order a free SSL ceritificate for the OVHcloud Load Balancer.. +### How do I order a free SSL certificate? + +#### Via the OVHcloud Control Panel + +In your Load Balancer service dashboard, navigate to the `SSL certificates`{.action} tab, and click on `Order an SSL certificate`{.action}. +Fill in the FQDN in the dedicated field, then click on `Order`{.action}. + +For the order to be completed, it is required that the domain name points to your OVHcloud Load Balancer. + +#### Via the OVHcloud API + +It is possible to order a free SSL certificate for the OVHcloud Load Balancer. -- To order a free SSL certificate, you can use the following API call and entering your domain in the `fqdn` field: +- To order a free SSL certificate, you can use the following API call and enter your domain in the ‘fqdn’ field: > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/freeCertificate > -It is possible to order a multi-domain certificate; the `fqdn` fields accepts a sting type input. +It is possible to order a multi-domain certificate; the `fqdn` field accepts a string type input. -For the orer to be completed, it is required that the domain name points to your OVHcloud Load Balancer. +For the order to be completed, it is required that the domain name points to your OVHcloud Load Balancer. -## How to list the SSL certificates associated with the OVHcloud Load Balancer ? +### How to list the SSL certificates associated with the OVHcloud Load Balancer? + +#### Via the OVHcloud Control Panel + +In your Load Balancer service dashboard, navigate to the `SSL certificates`{.action} section, where you will find a table listing the certificates associated to that Load Balancer. + +To retrieve the details of an SSL certificate, click the ellipsis button to the right of the desired certificate, then click on `See a preview`{.action}. + +#### Via the OVHcloud API - To list the SSL certificates associated with the OVHcloud Load Balancer, you can use the following API call: @@ -73,14 +120,19 @@ For the orer to be completed, it is required that the domain name points to your > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl > -The SSL certificates that have been ordered (free or not) will appear as `built`. Those added by yourself are will appear as `custom`. +The SSL certificates that have been ordered (free or not) will appear as `built`. Those added by yourself will appear as `custom`. -An SSL certificate appearing as `built_not_routed` is a certificate that has been order and delivered, but whose domain cannot be validated. Usually, this is because the domain to longer points to the OVHcloud Load Balancer. +An SSL certificate appearing as `built_not_routed` is a certificate that has been ordered and delivered, but whose domain cannot be validated. Usually, this is because the domain no longer points to the OVHcloud Load Balancer. -- To retrieve the details of an SSL certificate, you can use the following API call : +- To retrieve the details of an SSL certificate, you can use the following API call: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl/{id} > +## Go further + +Find details about all the API calls related to the OVHcloud Load Balancer in [this guide](/pages/network/load_balancer/use_api_details). + +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_faq/guide.en-gb.md b/pages/network/load_balancer/create_faq/guide.en-gb.md index 1a10812d5ed..af443228d6a 100644 --- a/pages/network/load_balancer/create_faq/guide.en-gb.md +++ b/pages/network/load_balancer/create_faq/guide.en-gb.md @@ -1,23 +1,40 @@ --- -title: 'Load Balancer FAQ' -excerpt: 'FAQ Load Balancer' -updated: 2018-03-26 +title: 'OVHcloud Load Balancer FAQ' +excerpt: 'Frequently Asked Questions on the OVHcloud Load Balancer' +updated: 2025-11-12 --- -## How do I configure my Firewall to accept traffic from the OVHcloud Load Balancer? -When using the Load Balancer, your clients do not connect directly to your servers. A good practice is to setup a firewall to allow only traffic from the OVHcloud Load Balancer service. +## Objective -- To determine which IPs to allow in your firewall, you can use the following API call: +This document provides a set of the most frequently asked questions and their corresponding OVHcloud API calls for performing common management and configuration tasks on your OVHcloud Load Balancer service. + +## FAQ + +### How do I configure my Firewall to accept traffic from the OVHcloud Load Balancer? + +When using the Load Balancer, your clients do not connect directly to your servers. A good practice is to set up a firewall to allow only traffic from the OVHcloud Load Balancer service. + +#### Via the OVHcloud API + +To determine which IP addresses you need to allow in your firewall, you can use the following API call: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/natIp > -## How do I know the status of my service? +#### Via the OVHcloud Control Panel + +In your Load Balancer service, navigate to the `Home`{.action} tab, and find the **Information** section. On the **Outbound IPv4** line, click the ellipsis, and select "Read". +A window will open, listing the IP addresses you need to allow in your firewall. + +### How do I know the status of my service? + Sometimes it may be useful to know the status of your OVHcloud Load Balancer. -- To determine the status of your service, you can use the following API call : +#### Via the OVHcloud API + +To determine the status of your service, you can use the following API call: > [!api] > @@ -26,45 +43,75 @@ Sometimes it may be useful to know the status of your OVHcloud Load Balancer. The different statuses of the OVHcloud Load Balancer can be `running`{.action} (Active), `reload`{.action} (Refresh in progress), `unknown`{.action} (Not yet started), or `dead`{.action} (inactive). -## How to add an Additional IP to the OVHcloud Load Balancer? -An Additional IP is an additional IP in which can be joined with your primary IP. The Additional IP can be switched from one server to another in seconds. +#### Via the OVHcloud Control Panel + +In your Load Balancer service dashboard, navigate to the `Home`{.action} tab, and find the **Status** section, which lists the internal service name of your Load Balancer and its status. + +### How to add an Additional IP to the OVHcloud Load Balancer? + +An Additional IP is an secondary IP address which can be associated to your service in addition to your primary IP. The Additional IP can be switched from one server to another in seconds. + +#### Via the OVHcloud API -- To add an Additional IP to an OVHcloud Load Balancer service : +- To add an Additional IP to an OVHcloud Load Balancer service: > [!api] > > @api {v1} /ip POST /ip/{ip}/move > -- Apply the change : +- Apply the change: > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh > -## How to list the Additional IPs routed to the OVHcloud Load Balancer? +#### Via the OVHcloud Control Panel + +In your Load Balancer service dashboard, click on `Front-ends`{.action}, then on `Add a front-end`{.action}. +Then, expand the `Advanced settings`{.action}, and select the Additional IPs you would like to add to your front-end *(listed on the interface as "Dedicated failover IP")*. + +### How to list the Additional IPs routed to the OVHcloud Load Balancer? > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/failover > -## How do I order a free SSL certificate ? -It is possible to order a free SSL ceritificate for the OVHcloud Load Balancer.. +### How do I order a free SSL certificate? + +#### Via the OVHcloud Control Panel + +In your Load Balancer service dashboard, navigate to the `SSL certificates`{.action} tab, and click on `Order an SSL certificate`{.action}. +Fill in the FQDN in the dedicated field, then click on `Order`{.action}. + +For the order to be completed, it is required that the domain name points to your OVHcloud Load Balancer. + +#### Via the OVHcloud API + +It is possible to order a free SSL certificate for the OVHcloud Load Balancer. -- To order a free SSL certificate, you can use the following API call and entering your domain in the `fqdn` field: +- To order a free SSL certificate, you can use the following API call and enter your domain in the ‘fqdn’ field: > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/freeCertificate > -It is possible to order a multi-domain certificate; the `fqdn` fields accepts a sting type input. +It is possible to order a multi-domain certificate; the `fqdn` field accepts a string type input. -For the orer to be completed, it is required that the domain name points to your OVHcloud Load Balancer. +For the order to be completed, it is required that the domain name points to your OVHcloud Load Balancer. -## How to list the SSL certificates associated with the OVHcloud Load Balancer ? +### How to list the SSL certificates associated with the OVHcloud Load Balancer? + +#### Via the OVHcloud Control Panel + +In your Load Balancer service dashboard, navigate to the `SSL certificates`{.action} section, where you will find a table listing the certificates associated to that Load Balancer. + +To retrieve the details of an SSL certificate, click the ellipsis button to the right of the desired certificate, then click on `See a preview`{.action}. + +#### Via the OVHcloud API - To list the SSL certificates associated with the OVHcloud Load Balancer, you can use the following API call: @@ -73,14 +120,19 @@ For the orer to be completed, it is required that the domain name points to your > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl > -The SSL certificates that have been ordered (free or not) will appear as `built`. Those added by yourself are will appear as `custom`. +The SSL certificates that have been ordered (free or not) will appear as `built`. Those added by yourself will appear as `custom`. -An SSL certificate appearing as `built_not_routed` is a certificate that has been order and delivered, but whose domain cannot be validated. Usually, this is because the domain to longer points to the OVHcloud Load Balancer. +An SSL certificate appearing as `built_not_routed` is a certificate that has been ordered and delivered, but whose domain cannot be validated. Usually, this is because the domain no longer points to the OVHcloud Load Balancer. -- To retrieve the details of an SSL certificate, you can use the following API call : +- To retrieve the details of an SSL certificate, you can use the following API call: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl/{id} > +## Go further + +Find details about all the API calls related to the OVHcloud Load Balancer in [this guide](/pages/network/load_balancer/use_api_details). + +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_faq/guide.en-sg.md b/pages/network/load_balancer/create_faq/guide.en-sg.md index 1a10812d5ed..af443228d6a 100644 --- a/pages/network/load_balancer/create_faq/guide.en-sg.md +++ b/pages/network/load_balancer/create_faq/guide.en-sg.md @@ -1,23 +1,40 @@ --- -title: 'Load Balancer FAQ' -excerpt: 'FAQ Load Balancer' -updated: 2018-03-26 +title: 'OVHcloud Load Balancer FAQ' +excerpt: 'Frequently Asked Questions on the OVHcloud Load Balancer' +updated: 2025-11-12 --- -## How do I configure my Firewall to accept traffic from the OVHcloud Load Balancer? -When using the Load Balancer, your clients do not connect directly to your servers. A good practice is to setup a firewall to allow only traffic from the OVHcloud Load Balancer service. +## Objective -- To determine which IPs to allow in your firewall, you can use the following API call: +This document provides a set of the most frequently asked questions and their corresponding OVHcloud API calls for performing common management and configuration tasks on your OVHcloud Load Balancer service. + +## FAQ + +### How do I configure my Firewall to accept traffic from the OVHcloud Load Balancer? + +When using the Load Balancer, your clients do not connect directly to your servers. A good practice is to set up a firewall to allow only traffic from the OVHcloud Load Balancer service. + +#### Via the OVHcloud API + +To determine which IP addresses you need to allow in your firewall, you can use the following API call: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/natIp > -## How do I know the status of my service? +#### Via the OVHcloud Control Panel + +In your Load Balancer service, navigate to the `Home`{.action} tab, and find the **Information** section. On the **Outbound IPv4** line, click the ellipsis, and select "Read". +A window will open, listing the IP addresses you need to allow in your firewall. + +### How do I know the status of my service? + Sometimes it may be useful to know the status of your OVHcloud Load Balancer. -- To determine the status of your service, you can use the following API call : +#### Via the OVHcloud API + +To determine the status of your service, you can use the following API call: > [!api] > @@ -26,45 +43,75 @@ Sometimes it may be useful to know the status of your OVHcloud Load Balancer. The different statuses of the OVHcloud Load Balancer can be `running`{.action} (Active), `reload`{.action} (Refresh in progress), `unknown`{.action} (Not yet started), or `dead`{.action} (inactive). -## How to add an Additional IP to the OVHcloud Load Balancer? -An Additional IP is an additional IP in which can be joined with your primary IP. The Additional IP can be switched from one server to another in seconds. +#### Via the OVHcloud Control Panel + +In your Load Balancer service dashboard, navigate to the `Home`{.action} tab, and find the **Status** section, which lists the internal service name of your Load Balancer and its status. + +### How to add an Additional IP to the OVHcloud Load Balancer? + +An Additional IP is an secondary IP address which can be associated to your service in addition to your primary IP. The Additional IP can be switched from one server to another in seconds. + +#### Via the OVHcloud API -- To add an Additional IP to an OVHcloud Load Balancer service : +- To add an Additional IP to an OVHcloud Load Balancer service: > [!api] > > @api {v1} /ip POST /ip/{ip}/move > -- Apply the change : +- Apply the change: > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh > -## How to list the Additional IPs routed to the OVHcloud Load Balancer? +#### Via the OVHcloud Control Panel + +In your Load Balancer service dashboard, click on `Front-ends`{.action}, then on `Add a front-end`{.action}. +Then, expand the `Advanced settings`{.action}, and select the Additional IPs you would like to add to your front-end *(listed on the interface as "Dedicated failover IP")*. + +### How to list the Additional IPs routed to the OVHcloud Load Balancer? > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/failover > -## How do I order a free SSL certificate ? -It is possible to order a free SSL ceritificate for the OVHcloud Load Balancer.. +### How do I order a free SSL certificate? + +#### Via the OVHcloud Control Panel + +In your Load Balancer service dashboard, navigate to the `SSL certificates`{.action} tab, and click on `Order an SSL certificate`{.action}. +Fill in the FQDN in the dedicated field, then click on `Order`{.action}. + +For the order to be completed, it is required that the domain name points to your OVHcloud Load Balancer. + +#### Via the OVHcloud API + +It is possible to order a free SSL certificate for the OVHcloud Load Balancer. -- To order a free SSL certificate, you can use the following API call and entering your domain in the `fqdn` field: +- To order a free SSL certificate, you can use the following API call and enter your domain in the ‘fqdn’ field: > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/freeCertificate > -It is possible to order a multi-domain certificate; the `fqdn` fields accepts a sting type input. +It is possible to order a multi-domain certificate; the `fqdn` field accepts a string type input. -For the orer to be completed, it is required that the domain name points to your OVHcloud Load Balancer. +For the order to be completed, it is required that the domain name points to your OVHcloud Load Balancer. -## How to list the SSL certificates associated with the OVHcloud Load Balancer ? +### How to list the SSL certificates associated with the OVHcloud Load Balancer? + +#### Via the OVHcloud Control Panel + +In your Load Balancer service dashboard, navigate to the `SSL certificates`{.action} section, where you will find a table listing the certificates associated to that Load Balancer. + +To retrieve the details of an SSL certificate, click the ellipsis button to the right of the desired certificate, then click on `See a preview`{.action}. + +#### Via the OVHcloud API - To list the SSL certificates associated with the OVHcloud Load Balancer, you can use the following API call: @@ -73,14 +120,19 @@ For the orer to be completed, it is required that the domain name points to your > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl > -The SSL certificates that have been ordered (free or not) will appear as `built`. Those added by yourself are will appear as `custom`. +The SSL certificates that have been ordered (free or not) will appear as `built`. Those added by yourself will appear as `custom`. -An SSL certificate appearing as `built_not_routed` is a certificate that has been order and delivered, but whose domain cannot be validated. Usually, this is because the domain to longer points to the OVHcloud Load Balancer. +An SSL certificate appearing as `built_not_routed` is a certificate that has been ordered and delivered, but whose domain cannot be validated. Usually, this is because the domain no longer points to the OVHcloud Load Balancer. -- To retrieve the details of an SSL certificate, you can use the following API call : +- To retrieve the details of an SSL certificate, you can use the following API call: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl/{id} > +## Go further + +Find details about all the API calls related to the OVHcloud Load Balancer in [this guide](/pages/network/load_balancer/use_api_details). + +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_faq/guide.en-us.md b/pages/network/load_balancer/create_faq/guide.en-us.md index d0644c748ba..af443228d6a 100644 --- a/pages/network/load_balancer/create_faq/guide.en-us.md +++ b/pages/network/load_balancer/create_faq/guide.en-us.md @@ -1,25 +1,40 @@ --- -title: 'Load Balancer FAQ' -excerpt: 'FAQ Load Balancer' -updated: 2018-03-26 +title: 'OVHcloud Load Balancer FAQ' +excerpt: 'Frequently Asked Questions on the OVHcloud Load Balancer' +updated: 2025-11-12 --- -## How do I configure my Firewall to accept traffic from the OVHcloud Load Balancer? +## Objective -When using the Load Balancer, your clients do not connect directly to your servers. A good practice is to setup a firewall to allow only traffic from the OVHcloud Load Balancer service. +This document provides a set of the most frequently asked questions and their corresponding OVHcloud API calls for performing common management and configuration tasks on your OVHcloud Load Balancer service. -- To determine which IPs to allow in your firewall, you can use the following API call: +## FAQ + +### How do I configure my Firewall to accept traffic from the OVHcloud Load Balancer? + +When using the Load Balancer, your clients do not connect directly to your servers. A good practice is to set up a firewall to allow only traffic from the OVHcloud Load Balancer service. + +#### Via the OVHcloud API + +To determine which IP addresses you need to allow in your firewall, you can use the following API call: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/natIp > -## How do I know the status of my service? +#### Via the OVHcloud Control Panel + +In your Load Balancer service, navigate to the `Home`{.action} tab, and find the **Information** section. On the **Outbound IPv4** line, click the ellipsis, and select "Read". +A window will open, listing the IP addresses you need to allow in your firewall. + +### How do I know the status of my service? Sometimes it may be useful to know the status of your OVHcloud Load Balancer. -- To determine the status of your service, you can use the following API call : +#### Via the OVHcloud API + +To determine the status of your service, you can use the following API call: > [!api] > @@ -28,47 +43,75 @@ Sometimes it may be useful to know the status of your OVHcloud Load Balancer. The different statuses of the OVHcloud Load Balancer can be `running`{.action} (Active), `reload`{.action} (Refresh in progress), `unknown`{.action} (Not yet started), or `dead`{.action} (inactive). -## How to add an Additional IP to the OVHcloud Load Balancer? +#### Via the OVHcloud Control Panel + +In your Load Balancer service dashboard, navigate to the `Home`{.action} tab, and find the **Status** section, which lists the internal service name of your Load Balancer and its status. + +### How to add an Additional IP to the OVHcloud Load Balancer? -An Additional IP is an additional IP in which can be joined with your primary IP. The Additional IP can be switched from one server to another in seconds. +An Additional IP is an secondary IP address which can be associated to your service in addition to your primary IP. The Additional IP can be switched from one server to another in seconds. -- To add an Additional IP to an OVHcloud Load Balancer service : +#### Via the OVHcloud API + +- To add an Additional IP to an OVHcloud Load Balancer service: > [!api] > > @api {v1} /ip POST /ip/{ip}/move > -- Apply the change : +- Apply the change: > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh > -## How to list the Additional IPs routed to the OVHcloud Load Balancer? +#### Via the OVHcloud Control Panel + +In your Load Balancer service dashboard, click on `Front-ends`{.action}, then on `Add a front-end`{.action}. +Then, expand the `Advanced settings`{.action}, and select the Additional IPs you would like to add to your front-end *(listed on the interface as "Dedicated failover IP")*. + +### How to list the Additional IPs routed to the OVHcloud Load Balancer? > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/failover > -## How do I order a free SSL certificate ? +### How do I order a free SSL certificate? + +#### Via the OVHcloud Control Panel + +In your Load Balancer service dashboard, navigate to the `SSL certificates`{.action} tab, and click on `Order an SSL certificate`{.action}. +Fill in the FQDN in the dedicated field, then click on `Order`{.action}. + +For the order to be completed, it is required that the domain name points to your OVHcloud Load Balancer. + +#### Via the OVHcloud API -It is possible to order a free SSL ceritificate for the OVHcloud Load Balancer.. +It is possible to order a free SSL certificate for the OVHcloud Load Balancer. -- To order a free SSL certificate, you can use the following API call and entering your domain in the `fqdn` field: +- To order a free SSL certificate, you can use the following API call and enter your domain in the ‘fqdn’ field: > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/freeCertificate > -It is possible to order a multi-domain certificate; the `fqdn` fields accepts a sting type input. +It is possible to order a multi-domain certificate; the `fqdn` field accepts a string type input. -For the orer to be completed, it is required that the domain name points to your OVHcloud Load Balancer. +For the order to be completed, it is required that the domain name points to your OVHcloud Load Balancer. -## How to list the SSL certificates associated with the OVHcloud Load Balancer ? +### How to list the SSL certificates associated with the OVHcloud Load Balancer? + +#### Via the OVHcloud Control Panel + +In your Load Balancer service dashboard, navigate to the `SSL certificates`{.action} section, where you will find a table listing the certificates associated to that Load Balancer. + +To retrieve the details of an SSL certificate, click the ellipsis button to the right of the desired certificate, then click on `See a preview`{.action}. + +#### Via the OVHcloud API - To list the SSL certificates associated with the OVHcloud Load Balancer, you can use the following API call: @@ -77,11 +120,11 @@ For the orer to be completed, it is required that the domain name points to your > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl > -The SSL certificates that have been ordered (free or not) will appear as `built`. Those added by yourself are will appear as `custom`. +The SSL certificates that have been ordered (free or not) will appear as `built`. Those added by yourself will appear as `custom`. -An SSL certificate appearing as `built_not_routed` is a certificate that has been order and delivered, but whose domain cannot be validated. Usually, this is because the domain to longer points to the OVHcloud Load Balancer. +An SSL certificate appearing as `built_not_routed` is a certificate that has been ordered and delivered, but whose domain cannot be validated. Usually, this is because the domain no longer points to the OVHcloud Load Balancer. -- To retrieve the details of an SSL certificate, you can use the following API call : +- To retrieve the details of an SSL certificate, you can use the following API call: > [!api] > @@ -90,4 +133,6 @@ An SSL certificate appearing as `built_not_routed` is a certificate that has bee ## Go further +Find details about all the API calls related to the OVHcloud Load Balancer in [this guide](/pages/network/load_balancer/use_api_details). + Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_faq/guide.fr-ca.md b/pages/network/load_balancer/create_faq/guide.fr-ca.md index fbe1ac84f2e..425c64479bb 100644 --- a/pages/network/load_balancer/create_faq/guide.fr-ca.md +++ b/pages/network/load_balancer/create_faq/guide.fr-ca.md @@ -1,86 +1,147 @@ --- -title: 'Load Balancer FAQ' -excerpt: 'FAQ Load Balancer' -updated: 2022-09-30 +title: 'OVHcloud Load Balancer FAQ' +excerpt: 'Questions fréquentes concernant le service OVHcloud Load Balancer' +updated: 2025-11-12 --- -## Comment configurer mon Firewall pour accepter le trafic provenant du service Load Balancer OVHcloud ? -Lors de l'utilisation du Load-Balancer, vos clients ne se connectent pas directement à vos serveurs. Une bonne pratique est de mettre en place un Firewall (Pare-Feu) pour autoriser uniquement le trafic provenant du service Load Balancer OVHcloud. +## Objectif -- Pour déterminer les IPs à autoriser dans votre Firewall, vous pouvez utiliser la fonction API suivante : +Retrouvez dans ce document les questions les plus fréquemment posées et les instructions correspondantes pour effectuer des tâches de gestion et de configuration courantes sur votre service OVHcloud Load Balancer. + +## FAQ + +### Comment configurer mon pare-feu pour accepter le trafic provenant de l'OVHcloud Load Balancer ? + +Lorsque vous utilisez le Load Balancer, vos clients ne se connectent pas directement à vos serveurs. Il est recommandé de configurer un pare-feu permettant uniquement le trafic provenant du service OVHcloud Load Balancer. + +#### Via l'API OVHcloud + +Pour identifier les adresses IP que vous devez autoriser dans votre pare-feu, vous pouvez utiliser l'appel API suivant : > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/natIp > -## Comment connaître l'état de mon service ? -Parfois, il peut être utile de connaître l'état de votre service Load Balancer OVHcloud. +#### Via l'espace client OVHcloud + +Dans le tableau de bord de votre service Load Balancer, accédez à l'onglet `Accueil`{.action}. Dans le cadre **Informations**, cliquez sur le bouton `...`{.action} à droite de la mention **IPv4 de sortie** et sélectionnez `Consulter`{.action}. + +Une fenêtre s'ouvrira, listant les adresses IP que vous devez autoriser dans votre pare-feu. + +### Comment connaître le statut de mon service ? -- Pour déterminer l'état de votre service, vous pouvez utiliser la fonction API suivante : +Parfois, il peut être utile de connaître le statut de votre service OVHcloud Load Balancer. + +#### Via l'API OVHcloud + +Pour déterminer le statut de votre service, vous pouvez utiliser l'appel API suivant : > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/instancesState > -L'état des différentes instances du Load Balancer OVHcloud peut être `running` (actif), `reload` (en cours de rafraîchissement), `unknown` (pas encore démarré) ou `dead` (inactif). +Les différents statuts de l'OVHcloud Load Balancer peuvent être : + +- `running` : Actif. +- `reload` : Mise à jour en cours. +- `unknown` : Non encore démarré. +- `dead` : Inactif. + +#### Via l'espace client OVHcloud + +Dans le tableau de bord de votre service Load Balancer, accédez à l'onglet `Accueil`{.action}. Retrouvez dans le cadre **Statut** le nom interne de votre service Load Balancer ainsi que son statut. + +### Comment ajouter une Additional IP à l'OVHcloud Load Balancer ? + +Une Additional IP est une adresse IP secondaire qui peut être associée à votre service en plus de votre adresse IP principale. L'Additional IP peut être transférée d'un serveur à un autre en quelques secondes. -## Comment ajouter une Additional IP au service Load Balancer OVHcloud ? -L'Additional IP est une IP supplémentaire sur laquelle peut être joint votre service en plus de l'IP principale. L'Additional IP peut être basculée d'un service à un autre en quelques secondes. +#### Via l'API OVHcloud -- Pour ajouter une Additional IP à un service Load Balancer OVHcloud : +Pour ajouter une Additional IP à votre service OVHcloud Load Balancer : > [!api] > > @api {v1} /ip POST /ip/{ip}/move > -- Appliquer les modifications : +Appliquez le changement : > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh > -## Comment lister les Additional IP rattachées au service Load Balancer OVHcloud ? +#### Via l'espace client OVHcloud + +Dans le tableau de bord de votre service Load Balancer, accédez à l'onglet `Frontends`{.action} et cliquez sur le bouton `Ajouter un frontend`{.action}. + +Ensuite, affichez les `Paramètres avancés`{.action} et sélectionnez les Additional IPs (listées sur l'interface comme « Dedicated IP failover ») que vous souhaitez ajouter à votre frontend. + +### Comment lister les Additional IPs routées vers le service OVHcloud Load Balancer ? + +Utilisez l'appel API suivant : > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/failover > -## Comment commander un certificat SSL gratuit ? -Il est possible de commander un certificat SSL gratuit pour le Load Balancer OVHcloud. +### Comment commander un certificat SSL gratuit ? + +#### Via l'espace client OVHcloud + +Dans le tableau de bord de votre service Load Balancer, accédez à l'onglet `Certificats SSL`{.action} et cliquez sur le bouton `Commander un certificat SSL`{.action}. +Remplissez le FQDN dans le champ dédié, puis cliquez sur `Commander`{.action}. + +Pour que la commande soit validée, il est nécessaire que le nom de domaine pointe vers votre service OVHcloud Load Balancer. + +#### Via l'API OVHcloud -- Pour commander un certificat gratuit, vous pouvez utiliser la fonction API suivante, en renseignant le champs `fqdn` : +Il est possible de commander un certificat SSL gratuit pour le service OVHcloud Load Balancer. + +Pour ce faire, vous pouvez utiliser l'appel API suivant et renseigner votre domaine dans le champ `fqdn` : > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/freeCertificate > -Il est possible de commander un certificat multi-domaine ; le champs `fqdn` prend comme paramètre un tableau de chaîne de caractères. +Il est possible de commander un certificat multi-domaines ; le champ `fqdn` accepte une entrée de type chaîne de caractères. + +Pour que la commande soit validée, il est nécessaire que le nom de domaine pointe vers votre service OVHcloud Load Balancer. + +### Comment lister les certificats SSL associés à l'OVHcloud Load Balancer ? + +#### Via l'espace client OVHcloud -Pour que la commande se finalise, il faut obligatoirement que le nom de domaine choisi pointe vers votre Load Balancer OVHcloud. +Dans le tableau de bord de votre service Load Balancer, accédez à l'onglet `Certificats SSL`{.action}, où vous trouverez un tableau listant les certificats associés à ce Load Balancer. -## Comment lister les certificats SSL associés au Load Balancer OVHcloud ? +Pour obtenir les détails d'un certificat SSL, cliquez sur le bouton `...`{.action} à droite du certificat souhaité, puis sélectionnez `Voir un aperçu`{.action}. -- Pour lister les certificats SSL associés au Load Balancer OVHcloud, vous pouvez utiliser la fonction API suivante : +#### Via l'API OVHcloud + +Pour lister les certificats SSL associés à l'OVHcloud Load Balancer, vous pouvez utiliser l'appel API suivant : > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl > -Les certificats commandés (gratuit ou non) sont de type `built`. Ceux ajoutés par vous-même sont de type `custom`. +Les certificats SSL commandés (gratuits ou non) apparaîtront comme `built`. Ceux ajoutés par vous-même apparaîtront comme `custom`. -Un certificat de type `built_not_routed` est un certificat qui a été commandé et livré, mais dont le domaine n'a pas put être validé. Usuellement, c'est parce que le domaine ne pointe plus vers le Load Balancer OVHcloud. +Un certificat SSL apparaissant comme `built_not_routed` est un certificat qui a été commandé et livré, mais dont le domaine ne peut pas être validé. Cela est généralement dû au fait que le domaine ne pointe plus vers le service OVHcloud Load Balancer. -- Pour obtenir les détails d'un certificat SSL, vous pouvez utiliser la fonction API suivante : +Pour obtenir les détails d'un certificat SSL, vous pouvez utiliser l'appel API suivant : > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl/{id} > +## Aller plus loin + +Trouvez les détails de tous les appels API liés à l'OVHcloud Load Balancer dans [ce guide](/pages/network/load_balancer/use_api_details). + +Rejoignez notre [communauté d'utilisateurs](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_faq/guide.fr-fr.md b/pages/network/load_balancer/create_faq/guide.fr-fr.md index b68bf71d1d1..34221a92ed7 100644 --- a/pages/network/load_balancer/create_faq/guide.fr-fr.md +++ b/pages/network/load_balancer/create_faq/guide.fr-fr.md @@ -1,52 +1,85 @@ --- -title: 'Load Balancer FAQ' -excerpt: 'FAQ Load Balancer' -updated: 2018-03-26 +title: 'OVHcloud Load Balancer FAQ' +excerpt: 'Questions fréquentes concernant le service OVHcloud Load Balancer' +updated: 2025-11-12 --- -## Comment configurer mon Firewall pour accepter le trafic provenant du service Load Balancer OVHcloud ? +## Objectif -Lors de l'utilisation du Load-Balancer, vos clients ne se connectent pas directement à vos serveurs. Une bonne pratique est de mettre en place un Firewall (Pare-Feu) pour autoriser uniquement le trafic provenant du service Load Balancer OVHcloud. +Retrouvez dans ce document les questions les plus fréquemment posées et les instructions correspondantes pour effectuer des tâches de gestion et de configuration courantes sur votre service OVHcloud Load Balancer. -- Pour déterminer les IPs à autoriser dans votre Firewall, vous pouvez utiliser la fonction API suivante : +## FAQ + +### Comment configurer mon pare-feu pour accepter le trafic provenant de l'OVHcloud Load Balancer ? + +Lorsque vous utilisez le Load Balancer, vos clients ne se connectent pas directement à vos serveurs. Il est recommandé de configurer un pare-feu permettant uniquement le trafic provenant du service OVHcloud Load Balancer. + +#### Via l'API OVHcloud + +Pour identifier les adresses IP que vous devez autoriser dans votre pare-feu, vous pouvez utiliser l'appel API suivant : > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/natIp > -## Comment connaître l'état de mon service ? +#### Via l'espace client OVHcloud + +Dans le tableau de bord de votre service Load Balancer, accédez à l'onglet `Accueil`{.action}. Dans le cadre **Informations**, cliquez sur le bouton `...`{.action} à droite de la mention **IPv4 de sortie** et sélectionnez `Consulter`{.action}. + +Une fenêtre s'ouvrira, listant les adresses IP que vous devez autoriser dans votre pare-feu. -Parfois, il peut être utile de connaître l'état de votre service Load Balancer OVHcloud. +### Comment connaître le statut de mon service ? -- Pour déterminer l'état de votre service, vous pouvez utiliser la fonction API suivante : +Parfois, il peut être utile de connaître le statut de votre service OVHcloud Load Balancer. + +#### Via l'API OVHcloud + +Pour déterminer le statut de votre service, vous pouvez utiliser l'appel API suivant : > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/instancesState > -L'état des différentes instances du Load Balancer OVHcloud peut être `running` (actif), `reload` (en cours de rafraîchissement), `unknown` (pas encore démarré) ou `dead` (inactif). +Les différents statuts de l'OVHcloud Load Balancer peuvent être : + +- `running` : Actif. +- `reload` : Mise à jour en cours. +- `unknown` : Non encore démarré. +- `dead` : Inactif. + +#### Via l'espace client OVHcloud + +Dans le tableau de bord de votre service Load Balancer, accédez à l'onglet `Accueil`{.action}. Retrouvez dans le cadre **Statut** le nom interne de votre service Load Balancer ainsi que son statut. + +### Comment ajouter une Additional IP à l'OVHcloud Load Balancer ? -## Comment ajouter une Additional IP au service Load Balancer OVHcloud ? +Une Additional IP est une adresse IP secondaire qui peut être associée à votre service en plus de votre adresse IP principale. L'Additional IP peut être transférée d'un serveur à un autre en quelques secondes. -L'Additional IP est une IP supplémentaire sur laquelle peut être joint votre service en plus de l'IP principale. L'Additional IP peut être basculée d'un service à un autre en quelques secondes. +#### Via l'API OVHcloud -- Pour ajouter une Additional IP à un service Load Balancer OVHcloud : +Pour ajouter une Additional IP à votre service OVHcloud Load Balancer : > [!api] > > @api {v1} /ip POST /ip/{ip}/move > -- Appliquer les modifications : +Appliquez le changement : > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh > -## Comment lister les Additional IP rattachées au service Load Balancer OVHcloud ? +#### Via l'espace client OVHcloud + +Dans le tableau de bord de votre service Load Balancer, accédez à l'onglet `Frontends`{.action} et cliquez sur le bouton `Ajouter un frontend`{.action}. + +Ensuite, affichez les `Paramètres avancés`{.action} et sélectionnez les Additional IPs (listées sur l'interface comme « Dedicated IP failover ») que vous souhaitez ajouter à votre frontend. + +### Comment lister les Additional IPs routées vers le service OVHcloud Load Balancer ? Utilisez l'appel API suivant : @@ -55,35 +88,52 @@ Utilisez l'appel API suivant : > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/failover > -## Comment commander un certificat SSL gratuit ? +### Comment commander un certificat SSL gratuit ? + +#### Via l'espace client OVHcloud + +Dans le tableau de bord de votre service Load Balancer, accédez à l'onglet `Certificats SSL`{.action} et cliquez sur le bouton `Commander un certificat SSL`{.action}. +Remplissez le FQDN dans le champ dédié, puis cliquez sur `Commander`{.action}. + +Pour que la commande soit validée, il est nécessaire que le nom de domaine pointe vers votre service OVHcloud Load Balancer. -Il est possible de commander un certificat SSL gratuit pour le Load Balancer OVHcloud. +#### Via l'API OVHcloud -- Pour commander un certificat gratuit, vous pouvez utiliser la fonction API suivante, en renseignant le champ `fqdn` : +Il est possible de commander un certificat SSL gratuit pour le service OVHcloud Load Balancer. + +Pour ce faire, vous pouvez utiliser l'appel API suivant et renseigner votre domaine dans le champ `fqdn` : > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/freeCertificate > -Il est possible de commander un certificat multi-domaine ; le champ `fqdn` prend comme paramètre un tableau de chaîne de caractères. +Il est possible de commander un certificat multi-domaines ; le champ `fqdn` accepte une entrée de type chaîne de caractères. + +Pour que la commande soit validée, il est nécessaire que le nom de domaine pointe vers votre service OVHcloud Load Balancer. + +### Comment lister les certificats SSL associés à l'OVHcloud Load Balancer ? -Pour que la commande se finalise, il faut obligatoirement que le nom de domaine choisi pointe vers votre Load Balancer OVHcloud. +#### Via l'espace client OVHcloud -## Comment lister les certificats SSL associés au Load Balancer OVHcloud ? +Dans le tableau de bord de votre service Load Balancer, accédez à l'onglet `Certificats SSL`{.action}, où vous trouverez un tableau listant les certificats associés à ce Load Balancer. -- Pour lister les certificats SSL associés au Load Balancer OVHcloud, vous pouvez utiliser la fonction API suivante : +Pour obtenir les détails d'un certificat SSL, cliquez sur le bouton `...`{.action} à droite du certificat souhaité, puis sélectionnez `Voir un aperçu`{.action}. + +#### Via l'API OVHcloud + +Pour lister les certificats SSL associés à l'OVHcloud Load Balancer, vous pouvez utiliser l'appel API suivant : > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl > -Les certificats commandés (gratuit ou non) sont de type `built`. Ceux ajoutés par vous-même sont de type `custom`. +Les certificats SSL commandés (gratuits ou non) apparaîtront comme `built`. Ceux ajoutés par vous-même apparaîtront comme `custom`. -Un certificat de type `built_not_routed` est un certificat qui a été commandé et livré, mais dont le domaine n'a pas pu être validé. Généralement, c'est parce que le domaine ne pointe plus vers le Load Balancer OVHcloud. +Un certificat SSL apparaissant comme `built_not_routed` est un certificat qui a été commandé et livré, mais dont le domaine ne peut pas être validé. Cela est généralement dû au fait que le domaine ne pointe plus vers le service OVHcloud Load Balancer. -- Pour obtenir les détails d'un certificat SSL, vous pouvez utiliser la fonction API suivante : +Pour obtenir les détails d'un certificat SSL, vous pouvez utiliser l'appel API suivant : > [!api] > @@ -92,4 +142,6 @@ Un certificat de type `built_not_routed` est un certificat qui a été commandé ## Aller plus loin -Échangez avec notre [communauté d'utilisateurs](/links/community). +Trouvez les détails de tous les appels API liés à l'OVHcloud Load Balancer dans [ce guide](/pages/network/load_balancer/use_api_details). + +Rejoignez notre [communauté d'utilisateurs](/links/community). diff --git a/pages/network/load_balancer/create_headers/guide.en-asia.md b/pages/network/load_balancer/create_headers/guide.en-asia.md index 75cecc048dc..aa8adb97bd7 100644 --- a/pages/network/load_balancer/create_headers/guide.en-asia.md +++ b/pages/network/load_balancer/create_headers/guide.en-asia.md @@ -1,97 +1,255 @@ --- -title: OVH Load Balancer - HTTP Header -excerpt: Get HTTP Headers on your services behind OVH Load Balancer -updated: 2018-08-03 +title: "Configuration of an OVHcloud Load Balancer service - HTTP headers" +excerpt: Integrate your web services behind a Load Balancer with HTTP headers +updated: 2025-11-12 --- -## Introduction -With any frontend service like CDN, IP Loadbalancing in front of your services, the IP of your clients is hidden by this service. +## Objective -In your log, you'll only see privateIP, and we'll fix this. +The OVHcloud Load Balancer service acts as a proxy. Like a human proxy, it serves as an intermediary: the client addresses the proxy, which in turn contacts the service provider on behalf of the client. In this configuration, **only the proxy** has information about the **real client** (the visitor of your web service) and the **real service provider** (one of your servers). + +For the visitor, this configuration does not raise any issues. They do not need to know the specific server handling their request; it is an implementation detail. However, for legal and statistical reasons, it is **essential** that the final server knows the client's real IP address. By default, it only identifies the proxy, which is your OVHcloud Load Balancer service. To overcome this issue, your OVHcloud Load Balancer service **adds by default** the standard HTTP headers that allow you to retrieve this information in the case of an HTTP connection. For a TCP connection, other solutions such as the ProxyProtocol exist, but they are beyond the scope of this guide. + +**This guide presents the default headers, their function, how to use them on the most common servers, and how to customize them according to the requirements of your infrastructure.** + +This guide is specifically for you if you only find private IP addresses in your access logs (`access_log`). + +## Requirements + +- Have an [OVHcloud Load Balancer](/links/network/load-balancer) offer in your OVHcloud account. +- You must be logged in to your [OVHcloud Control Panel](/links/manager). +- Have a Web service installed and configured on your servers. +- Have an Nginx service installed and configured on your servers. + +## Instructions ```bash -10.108.0.15 - - [22/Mar/2017:10:56:47 +0100] "GET / HTTP/1.1" 200 706 "-" "Mozilla/5.0 (Linux[...]" -10.108.0.24 - - [22/Mar/2017:10:56:47 +0100] "GET / HTTP/1.1" 200 706 "-" "Mozilla/5.0 (Linux[...]" +10.108.0.15 - - [02/Fev/2022:10:56:47 +0100] "GET / HTTP/1.1" 200 706 "-" "Mozilla/5.0 (Linux[...]" +10.108.0.24 - - [02/Fev/2022/:10:56:47 +0100] "GET / HTTP/1.1" 200 706 "-" "Mozilla/5.0 (Linux[...]" ``` -## Avertissement -You need to restrict access to your webservices from our IP Loadbalancing. +### Legal obligations + +You may be required to keep logs and certain data related to traffic in accordance with the laws and regulations applicable to you. **It is your responsibility to comply with these obligations.** + +**As an example:** + +- [Article L34-1 of the Code of Posts and Electronic Communications](https://www.legifrance.gouv.fr/affichCodeArticle.do?cidTexte=LEGITEXT000006070987&idArticle=LEGIARTI000006465770&dateTexte=&categorieLien=cid) and [Decree No. 2006-358 of 24 March 2006 on the retention of electronic communication data](https://www.legifrance.gouv.fr/affichTexte.do?cidTexte=JORFTEXT000000637071&dateTexte=20180110) require any natural or legal person providing a public electronic communications service to retain user identification data for the services provided, etc. ; +- [Law No. 2004-575 of 21 June 2004 on trust in the digital economy](https://www.legifrance.gouv.fr/affichTexteArticle.do?idArticle=JORFARTI000002457442&cidTexte=JORFTEXT000000801164) and [Decree No. 2011-219 of 25 February 2011](https://www.legifrance.gouv.fr/affichTexte.do?cidTexte=JORFTEXT000023646013&categorieLien=id) require, among other things, that persons whose activity consists of providing access to online public communication services retain, for each connection, data relating to the connection identifier, the start and end dates and times of the connection, etc. + +### Default headers + +By default, your OVHcloud Load Balancer service adds **five** standard HTTP headers to each request, allowing you to identify the visitor's IP address and port as well as the initial connection protocol of the visitor to your site. -With this api call you can get IP Range of our servers. +|Header|Description| +|---|---| +|X-Forwarded-For and X-Remote-Ip|IP address of the client, as seen by your OVHcloud Load Balancer.| +|X-Forwarded-Port and X-Remote-Port|Source port of the client, as seen by your OVHcloud Load Balancer.| +|X-Forwarded-Proto|Client protocol (HTTP or HTTPS), as seen by your OVHcloud Load Balancer.| + +> [!warning] +> The `X-Forwarded-*` fields can be manipulated by a malicious client, **so they should only be considered if they come from a trusted source.** +> +> It is therefore **essential** to restrict their use to trusted IP addresses, which are the output IP addresses of your OVHcloud Load Balancer service. Major web servers such as Nginx and Apache have modules that can handle this aspect of security and reliability. +> + +The list of your output IP addresses is available via the OVHcloud Control Panel and the OVHcloud API. + +#### From the OVHcloud Control Panel + +The list of IPv4 output addresses that may be used by your OVHcloud Load Balancer service is available on the homepage of your Load Balancer service under the heading "IPv4 output". + +![IPv4 output address of your OVHcloud Load Balancer service](images/iplb_service.png){.thumbnail} + +#### From the OVHcloud API + +- Retrieving the list of IP addresses used by your OVHcloud Load Balancer service: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/natIp > -If you accept proxy-headers (X-Forwarded-*) from anywhere, some request could bypass your security policies. -## Headers +### Correcting the source IP in the logs + +By default, Apache, Nginx and other web servers record the source IP address in their logs. When you use an OVHcloud Load Balancer in front of your website, the logs then only contain IP addresses of the form "10.108.a.b". These are the internal IP addresses used by the OVHcloud Load Balancer to contact you. + +When a request goes through your OVHcloud Load Balancer service, it records the visitor's IP address in the `X-Forwarded-For` and `X-Remote-Ip` headers. These two fields carry the same information, their names differ only for compatibility with most servers. -### X-Forwarded-For -This header have inside the Ip of your client. +To correct the IP addresses in the logs, one solution would be to modify the log format directive on your server to use one of these headers instead of the Load Balancer's IP address. Unfortunately, this approach is insufficient, as anyone can fill in this header, even without going through your OVHcloud Load Balancer. This manipulation would allow the visitor to impersonate someone else. Apart from the ethical aspect, this practice has legal, security and statistical implications that make its prevention essential. + +This is why the main web servers include specialized modules that allow you to precisely control the level of trust given to these headers based on: + +- The source IP address (must be exclusively that of your OVHcloud Load Balancer service!) +- The depth of the IP in the field. Indeed, each proxy (proxy, load balancer) adds the client's IP address to this field. + +The rest of this guide provides recommended configuration practices for the main web servers. #### Apache +- Create the file `/etc/apache2/conf-available/remoteip.conf`. +- Insert the following configuration: + ```apache -1. LogFormat "%{X-Forwarded-For}i-%h- %l %u %t \"%r\" %>s %O \"%{Referer}i\" \"%{User-Agent}i\"" loadbalancing -2. CustomLog /chemin/fichier.log loadbalancing +1. # Trust X-Forwarded-For headers from the OVHcloud Load Balancer +2. # See https://www.ovh.com/manager/sunrise/iplb/index.html#/iplb for an up to date list +3. RemoteIPHeader X-Forwarded-For +4. RemoteIPInternalProxy 10.108.0.0/14 +``` + +- Then replace the variables `%h` with `%a` in the `LogFormat` directives of the Apache configuration. +- Finally, enable the new configuration with: + +```bash +# Enable the 'remoteip' module and configuration +a2enmod remoteip +a2enconf remoteip + +# Restart apache to load the new module ("reload" is enough if the module was already enabled) +service apache2 restart ``` #### Nginx +For Nginx, the approach is slightly simpler, but the principle remains the same as for Apache: only take into account the `X-Forwarded-For` field if it comes from your OVHcloud Load Balancer service. + +This configuration can be applied: + +- To all sites, by inserting the configuration in the `http {}` section; +- To a specific site, by inserting the configuration in the corresponding `server {}` section; +- To a specific URL, by inserting the configuration in the corresponding `location {}` section. +- Insert the configuration in the desired section(s) (`http {}` for a global configuration): + ```nginx -1. log_format "%{X-Forwarded-For}i-%h- %l %u %t \"%r\" %>s %O \"%{Referer}i\" \"%{User-Agent}i\"" loadbalancing -2. access_log /chemin/fichier.log loadbalancing +1. # Trust X-Forwarded-For headers from the OVHcloud Load Balancer +2. # See https://www.ovh.com/manager/sunrise/iplb/index.html#/iplb for an up to date list +3. set_real_ip_from 10.108.0.0/16; +4. real_ip_header X-Forwarded-For; +``` + +- Then enable the new configuration with: + +```bash +service nginx reload ``` -### X-Forwarded-Proto -You can also get the scheme used by your client to reach OVH Load Balancer. This is helpful to redirect **HTTP** to **HTTPS** +#### Redirecting HTTP visitors to HTTPS + +To enhance security, some content such as login pages, can be restricted to the HTTPS protocol. Some sites even choose to systematically redirect all visits to the HTTPS version. By default, the HTTP and HTTPS protocols use different ports (80 and 443 respectively), so the classic solution is to place the redirection rules directly in the *vhost* dedicated to HTTP. + +When a request goes through a service like the OVHcloud Load Balancer, it handles the reception of HTTP traffic, the decryption of HTTPS traffic and forwards both types of traffic to your servers. Depending on your server configuration, all traffic will be propagated in HTTP or HTTPS, without distinction of the incoming protocol on the Load Balancer. Your server can no longer differentiate the two, as both arrive at the same point. This process is called **SSL Termination**. + +This is why the OVHcloud Load Balancer service automatically adds a header `X-Forwarded-Proto` which indicates the name of the original protocol, either "http" or "https". + +Like `X-Forwarded-For`, this header can be forged by a malicious visitor to make an insecure request appear to come from your OVHcloud Load Balancer service, in HTTPS. It is crucial to trust this header only if it is proven to come from your OVHcloud Load Balancer service. #### Apache -With htaccess, you can redirect your customers in HTTPS. -```htaccess +- Insert the following configuration in your site's `.htaccess` file: + +```apache 1. RewriteEngine on -2. RewriteCond %{HTTP:X_Forwarded_Proto} !https +2. RewriteCond %{HTTP:X-Forwarded-Proto} !https 3. RewriteRule ^ https://%{HTTP_HOST}%{REQUEST_URI} [L,R=301] ``` -#### Nginx -This is not a good configuration, you'll reduce your service performance. +- Then enable the new configuration with: ```bash -if ($http_x_forwarded_proto = "http") { - return 301 https://$host/$request_uri; -} +service apache2 reload ``` -#### Nginx (best) -With Nginx, it's best to use a entire VHost to redirect HTTP to HTTPS. +#### Nginx + +- Insert the following configuration in the `server {` section of your site: + +```nginx +1. if ($http_x_forwarded_proto = "http") { +2.         return 301 https://$host/$request_uri; +3. } +``` + +- Then enable the new configuration with: ```bash -server { - listen [::]:80 default_server; - listen 80 default_server; - server_name _; - root /var/www/; - location / { - return 301 https://$server_name$request_uri; - } -} +service nginx reload ``` -### Send headers to PHP +### Passing headers to PHP -#### Apache +PHP uses the `REMOTE_ADDR` header to determine the address of the visitors. This header is automatically configured as soon as the configuration detailed in the section "[Correcting the source IP in the logs](#ip-source-logs)" is applied. -```apache -1. Header set REMOTE_ADDR %{HTTP:X_Forwarded_Proto} -``` +### Adding custom headers -#### Nginx -With RealIP module. +Whether your application requires a specific header format to identify the visitor's IP, port or protocol, or you want to know which *frontend* a request arrived through (or for any other reason), you can add custom headers on your HTTP *frontend*. -```nginx -1. real_ip_header X-Forwarded-For; -2. set_real_ip_from 10.108.0.0/14; +Custom headers must follow the format "X-Header Header Value". The header name and its value are separated by a space. It is possible to specify several headers on the same *frontend*. + +If an existing header is present in the request, it will be overwritten and replaced by the new value, making it impossible for the visitor passing through this *frontend* to forge it. It is not possible to redefine headers reserved for proxies, such as those described in this document, as they are automatically managed by your OVHcloud Load Balancer service. + +When specifying a non-standard header name, it is customary to prefix it with "X-". + +The use of variables in the header values is supported: + +- `%ci` will be replaced by the visitor's IP address. +- `%cp` will be replaced by the visitor's source port. + +Custom headers can be configured via the OVHcloud Control Panel and the API, whether on a new *frontend* or an existing *frontend*. + +#### From the OVHcloud Control Panel + +Go to the `Frontends`{.action} tab in the dashboard of your OVHcloud Load Balancer service and select the *frontend* to edit or click on the `Add a frontend`{.action} button to create a new one. An editing window will appear, displaying an `HTTP Header`{.action} field in the `Advanced Settings`{.action} section. + +If you want to configure multiple headers, they must be separated by commas, *without spaces*. For example, you can define the following headers: `X-Ip-Header %ci,X-Port-Header %cp`. + +![Configuration of HTTP headers of a Frontend via ovh manager API](images/add_headers.png){.thumbnail} + +Click on the `Update`{.action} button after configuring the headers, then on `Deploy zone: YOUR ZONE`{.action} to apply the changes in the concerned zone. + +### From the OVHcloud API + +In the API, the headers are specified within an `httpHeader` list. Unlike the OVHcloud Control Panel, each header must be its own entry in the list. + +In the OVHcloud API console, a `+`{.action} button is available as soon as you start to specify a value, allowing you to add a new field to the list. + +![Configuration of HTTP headers of a Frontend](images/add_headers_with_api.png){.thumbnail} + +If you integrate the API into your code, this corresponds to a JSON list of the type: + +```json +1. { +2.         "httpHeader": [ +3.                 "X-Ip-Header %ci", +4.                 "X-Port-Header %cp" +5.         ] +6. } ``` + +- Modification of an existing `Frontend`{.action} : + +> [!api] +> +> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId} +> + +|Parameter|Meaning| +|---------|-------------| +|serviceName|Name of the Load Balancer service concerned| +|frontendId|Identifier of the frontend where to configure the HTTP headers| +|httpHeader|List of headers to configure| + +- Applying the changes: + +> [!api] +> +> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh +> + +|Parameter|Meaning| +|---------|-------------| +|serviceName|Name of the Load Balancer service concerned| +|zone|Name of the zone in which to deploy the configuration| + +## Go further + +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_headers/guide.en-au.md b/pages/network/load_balancer/create_headers/guide.en-au.md index 75cecc048dc..aa8adb97bd7 100644 --- a/pages/network/load_balancer/create_headers/guide.en-au.md +++ b/pages/network/load_balancer/create_headers/guide.en-au.md @@ -1,97 +1,255 @@ --- -title: OVH Load Balancer - HTTP Header -excerpt: Get HTTP Headers on your services behind OVH Load Balancer -updated: 2018-08-03 +title: "Configuration of an OVHcloud Load Balancer service - HTTP headers" +excerpt: Integrate your web services behind a Load Balancer with HTTP headers +updated: 2025-11-12 --- -## Introduction -With any frontend service like CDN, IP Loadbalancing in front of your services, the IP of your clients is hidden by this service. +## Objective -In your log, you'll only see privateIP, and we'll fix this. +The OVHcloud Load Balancer service acts as a proxy. Like a human proxy, it serves as an intermediary: the client addresses the proxy, which in turn contacts the service provider on behalf of the client. In this configuration, **only the proxy** has information about the **real client** (the visitor of your web service) and the **real service provider** (one of your servers). + +For the visitor, this configuration does not raise any issues. They do not need to know the specific server handling their request; it is an implementation detail. However, for legal and statistical reasons, it is **essential** that the final server knows the client's real IP address. By default, it only identifies the proxy, which is your OVHcloud Load Balancer service. To overcome this issue, your OVHcloud Load Balancer service **adds by default** the standard HTTP headers that allow you to retrieve this information in the case of an HTTP connection. For a TCP connection, other solutions such as the ProxyProtocol exist, but they are beyond the scope of this guide. + +**This guide presents the default headers, their function, how to use them on the most common servers, and how to customize them according to the requirements of your infrastructure.** + +This guide is specifically for you if you only find private IP addresses in your access logs (`access_log`). + +## Requirements + +- Have an [OVHcloud Load Balancer](/links/network/load-balancer) offer in your OVHcloud account. +- You must be logged in to your [OVHcloud Control Panel](/links/manager). +- Have a Web service installed and configured on your servers. +- Have an Nginx service installed and configured on your servers. + +## Instructions ```bash -10.108.0.15 - - [22/Mar/2017:10:56:47 +0100] "GET / HTTP/1.1" 200 706 "-" "Mozilla/5.0 (Linux[...]" -10.108.0.24 - - [22/Mar/2017:10:56:47 +0100] "GET / HTTP/1.1" 200 706 "-" "Mozilla/5.0 (Linux[...]" +10.108.0.15 - - [02/Fev/2022:10:56:47 +0100] "GET / HTTP/1.1" 200 706 "-" "Mozilla/5.0 (Linux[...]" +10.108.0.24 - - [02/Fev/2022/:10:56:47 +0100] "GET / HTTP/1.1" 200 706 "-" "Mozilla/5.0 (Linux[...]" ``` -## Avertissement -You need to restrict access to your webservices from our IP Loadbalancing. +### Legal obligations + +You may be required to keep logs and certain data related to traffic in accordance with the laws and regulations applicable to you. **It is your responsibility to comply with these obligations.** + +**As an example:** + +- [Article L34-1 of the Code of Posts and Electronic Communications](https://www.legifrance.gouv.fr/affichCodeArticle.do?cidTexte=LEGITEXT000006070987&idArticle=LEGIARTI000006465770&dateTexte=&categorieLien=cid) and [Decree No. 2006-358 of 24 March 2006 on the retention of electronic communication data](https://www.legifrance.gouv.fr/affichTexte.do?cidTexte=JORFTEXT000000637071&dateTexte=20180110) require any natural or legal person providing a public electronic communications service to retain user identification data for the services provided, etc. ; +- [Law No. 2004-575 of 21 June 2004 on trust in the digital economy](https://www.legifrance.gouv.fr/affichTexteArticle.do?idArticle=JORFARTI000002457442&cidTexte=JORFTEXT000000801164) and [Decree No. 2011-219 of 25 February 2011](https://www.legifrance.gouv.fr/affichTexte.do?cidTexte=JORFTEXT000023646013&categorieLien=id) require, among other things, that persons whose activity consists of providing access to online public communication services retain, for each connection, data relating to the connection identifier, the start and end dates and times of the connection, etc. + +### Default headers + +By default, your OVHcloud Load Balancer service adds **five** standard HTTP headers to each request, allowing you to identify the visitor's IP address and port as well as the initial connection protocol of the visitor to your site. -With this api call you can get IP Range of our servers. +|Header|Description| +|---|---| +|X-Forwarded-For and X-Remote-Ip|IP address of the client, as seen by your OVHcloud Load Balancer.| +|X-Forwarded-Port and X-Remote-Port|Source port of the client, as seen by your OVHcloud Load Balancer.| +|X-Forwarded-Proto|Client protocol (HTTP or HTTPS), as seen by your OVHcloud Load Balancer.| + +> [!warning] +> The `X-Forwarded-*` fields can be manipulated by a malicious client, **so they should only be considered if they come from a trusted source.** +> +> It is therefore **essential** to restrict their use to trusted IP addresses, which are the output IP addresses of your OVHcloud Load Balancer service. Major web servers such as Nginx and Apache have modules that can handle this aspect of security and reliability. +> + +The list of your output IP addresses is available via the OVHcloud Control Panel and the OVHcloud API. + +#### From the OVHcloud Control Panel + +The list of IPv4 output addresses that may be used by your OVHcloud Load Balancer service is available on the homepage of your Load Balancer service under the heading "IPv4 output". + +![IPv4 output address of your OVHcloud Load Balancer service](images/iplb_service.png){.thumbnail} + +#### From the OVHcloud API + +- Retrieving the list of IP addresses used by your OVHcloud Load Balancer service: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/natIp > -If you accept proxy-headers (X-Forwarded-*) from anywhere, some request could bypass your security policies. -## Headers +### Correcting the source IP in the logs + +By default, Apache, Nginx and other web servers record the source IP address in their logs. When you use an OVHcloud Load Balancer in front of your website, the logs then only contain IP addresses of the form "10.108.a.b". These are the internal IP addresses used by the OVHcloud Load Balancer to contact you. + +When a request goes through your OVHcloud Load Balancer service, it records the visitor's IP address in the `X-Forwarded-For` and `X-Remote-Ip` headers. These two fields carry the same information, their names differ only for compatibility with most servers. -### X-Forwarded-For -This header have inside the Ip of your client. +To correct the IP addresses in the logs, one solution would be to modify the log format directive on your server to use one of these headers instead of the Load Balancer's IP address. Unfortunately, this approach is insufficient, as anyone can fill in this header, even without going through your OVHcloud Load Balancer. This manipulation would allow the visitor to impersonate someone else. Apart from the ethical aspect, this practice has legal, security and statistical implications that make its prevention essential. + +This is why the main web servers include specialized modules that allow you to precisely control the level of trust given to these headers based on: + +- The source IP address (must be exclusively that of your OVHcloud Load Balancer service!) +- The depth of the IP in the field. Indeed, each proxy (proxy, load balancer) adds the client's IP address to this field. + +The rest of this guide provides recommended configuration practices for the main web servers. #### Apache +- Create the file `/etc/apache2/conf-available/remoteip.conf`. +- Insert the following configuration: + ```apache -1. LogFormat "%{X-Forwarded-For}i-%h- %l %u %t \"%r\" %>s %O \"%{Referer}i\" \"%{User-Agent}i\"" loadbalancing -2. CustomLog /chemin/fichier.log loadbalancing +1. # Trust X-Forwarded-For headers from the OVHcloud Load Balancer +2. # See https://www.ovh.com/manager/sunrise/iplb/index.html#/iplb for an up to date list +3. RemoteIPHeader X-Forwarded-For +4. RemoteIPInternalProxy 10.108.0.0/14 +``` + +- Then replace the variables `%h` with `%a` in the `LogFormat` directives of the Apache configuration. +- Finally, enable the new configuration with: + +```bash +# Enable the 'remoteip' module and configuration +a2enmod remoteip +a2enconf remoteip + +# Restart apache to load the new module ("reload" is enough if the module was already enabled) +service apache2 restart ``` #### Nginx +For Nginx, the approach is slightly simpler, but the principle remains the same as for Apache: only take into account the `X-Forwarded-For` field if it comes from your OVHcloud Load Balancer service. + +This configuration can be applied: + +- To all sites, by inserting the configuration in the `http {}` section; +- To a specific site, by inserting the configuration in the corresponding `server {}` section; +- To a specific URL, by inserting the configuration in the corresponding `location {}` section. +- Insert the configuration in the desired section(s) (`http {}` for a global configuration): + ```nginx -1. log_format "%{X-Forwarded-For}i-%h- %l %u %t \"%r\" %>s %O \"%{Referer}i\" \"%{User-Agent}i\"" loadbalancing -2. access_log /chemin/fichier.log loadbalancing +1. # Trust X-Forwarded-For headers from the OVHcloud Load Balancer +2. # See https://www.ovh.com/manager/sunrise/iplb/index.html#/iplb for an up to date list +3. set_real_ip_from 10.108.0.0/16; +4. real_ip_header X-Forwarded-For; +``` + +- Then enable the new configuration with: + +```bash +service nginx reload ``` -### X-Forwarded-Proto -You can also get the scheme used by your client to reach OVH Load Balancer. This is helpful to redirect **HTTP** to **HTTPS** +#### Redirecting HTTP visitors to HTTPS + +To enhance security, some content such as login pages, can be restricted to the HTTPS protocol. Some sites even choose to systematically redirect all visits to the HTTPS version. By default, the HTTP and HTTPS protocols use different ports (80 and 443 respectively), so the classic solution is to place the redirection rules directly in the *vhost* dedicated to HTTP. + +When a request goes through a service like the OVHcloud Load Balancer, it handles the reception of HTTP traffic, the decryption of HTTPS traffic and forwards both types of traffic to your servers. Depending on your server configuration, all traffic will be propagated in HTTP or HTTPS, without distinction of the incoming protocol on the Load Balancer. Your server can no longer differentiate the two, as both arrive at the same point. This process is called **SSL Termination**. + +This is why the OVHcloud Load Balancer service automatically adds a header `X-Forwarded-Proto` which indicates the name of the original protocol, either "http" or "https". + +Like `X-Forwarded-For`, this header can be forged by a malicious visitor to make an insecure request appear to come from your OVHcloud Load Balancer service, in HTTPS. It is crucial to trust this header only if it is proven to come from your OVHcloud Load Balancer service. #### Apache -With htaccess, you can redirect your customers in HTTPS. -```htaccess +- Insert the following configuration in your site's `.htaccess` file: + +```apache 1. RewriteEngine on -2. RewriteCond %{HTTP:X_Forwarded_Proto} !https +2. RewriteCond %{HTTP:X-Forwarded-Proto} !https 3. RewriteRule ^ https://%{HTTP_HOST}%{REQUEST_URI} [L,R=301] ``` -#### Nginx -This is not a good configuration, you'll reduce your service performance. +- Then enable the new configuration with: ```bash -if ($http_x_forwarded_proto = "http") { - return 301 https://$host/$request_uri; -} +service apache2 reload ``` -#### Nginx (best) -With Nginx, it's best to use a entire VHost to redirect HTTP to HTTPS. +#### Nginx + +- Insert the following configuration in the `server {` section of your site: + +```nginx +1. if ($http_x_forwarded_proto = "http") { +2.         return 301 https://$host/$request_uri; +3. } +``` + +- Then enable the new configuration with: ```bash -server { - listen [::]:80 default_server; - listen 80 default_server; - server_name _; - root /var/www/; - location / { - return 301 https://$server_name$request_uri; - } -} +service nginx reload ``` -### Send headers to PHP +### Passing headers to PHP -#### Apache +PHP uses the `REMOTE_ADDR` header to determine the address of the visitors. This header is automatically configured as soon as the configuration detailed in the section "[Correcting the source IP in the logs](#ip-source-logs)" is applied. -```apache -1. Header set REMOTE_ADDR %{HTTP:X_Forwarded_Proto} -``` +### Adding custom headers -#### Nginx -With RealIP module. +Whether your application requires a specific header format to identify the visitor's IP, port or protocol, or you want to know which *frontend* a request arrived through (or for any other reason), you can add custom headers on your HTTP *frontend*. -```nginx -1. real_ip_header X-Forwarded-For; -2. set_real_ip_from 10.108.0.0/14; +Custom headers must follow the format "X-Header Header Value". The header name and its value are separated by a space. It is possible to specify several headers on the same *frontend*. + +If an existing header is present in the request, it will be overwritten and replaced by the new value, making it impossible for the visitor passing through this *frontend* to forge it. It is not possible to redefine headers reserved for proxies, such as those described in this document, as they are automatically managed by your OVHcloud Load Balancer service. + +When specifying a non-standard header name, it is customary to prefix it with "X-". + +The use of variables in the header values is supported: + +- `%ci` will be replaced by the visitor's IP address. +- `%cp` will be replaced by the visitor's source port. + +Custom headers can be configured via the OVHcloud Control Panel and the API, whether on a new *frontend* or an existing *frontend*. + +#### From the OVHcloud Control Panel + +Go to the `Frontends`{.action} tab in the dashboard of your OVHcloud Load Balancer service and select the *frontend* to edit or click on the `Add a frontend`{.action} button to create a new one. An editing window will appear, displaying an `HTTP Header`{.action} field in the `Advanced Settings`{.action} section. + +If you want to configure multiple headers, they must be separated by commas, *without spaces*. For example, you can define the following headers: `X-Ip-Header %ci,X-Port-Header %cp`. + +![Configuration of HTTP headers of a Frontend via ovh manager API](images/add_headers.png){.thumbnail} + +Click on the `Update`{.action} button after configuring the headers, then on `Deploy zone: YOUR ZONE`{.action} to apply the changes in the concerned zone. + +### From the OVHcloud API + +In the API, the headers are specified within an `httpHeader` list. Unlike the OVHcloud Control Panel, each header must be its own entry in the list. + +In the OVHcloud API console, a `+`{.action} button is available as soon as you start to specify a value, allowing you to add a new field to the list. + +![Configuration of HTTP headers of a Frontend](images/add_headers_with_api.png){.thumbnail} + +If you integrate the API into your code, this corresponds to a JSON list of the type: + +```json +1. { +2.         "httpHeader": [ +3.                 "X-Ip-Header %ci", +4.                 "X-Port-Header %cp" +5.         ] +6. } ``` + +- Modification of an existing `Frontend`{.action} : + +> [!api] +> +> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId} +> + +|Parameter|Meaning| +|---------|-------------| +|serviceName|Name of the Load Balancer service concerned| +|frontendId|Identifier of the frontend where to configure the HTTP headers| +|httpHeader|List of headers to configure| + +- Applying the changes: + +> [!api] +> +> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh +> + +|Parameter|Meaning| +|---------|-------------| +|serviceName|Name of the Load Balancer service concerned| +|zone|Name of the zone in which to deploy the configuration| + +## Go further + +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_headers/guide.en-ca.md b/pages/network/load_balancer/create_headers/guide.en-ca.md index 75cecc048dc..aa8adb97bd7 100644 --- a/pages/network/load_balancer/create_headers/guide.en-ca.md +++ b/pages/network/load_balancer/create_headers/guide.en-ca.md @@ -1,97 +1,255 @@ --- -title: OVH Load Balancer - HTTP Header -excerpt: Get HTTP Headers on your services behind OVH Load Balancer -updated: 2018-08-03 +title: "Configuration of an OVHcloud Load Balancer service - HTTP headers" +excerpt: Integrate your web services behind a Load Balancer with HTTP headers +updated: 2025-11-12 --- -## Introduction -With any frontend service like CDN, IP Loadbalancing in front of your services, the IP of your clients is hidden by this service. +## Objective -In your log, you'll only see privateIP, and we'll fix this. +The OVHcloud Load Balancer service acts as a proxy. Like a human proxy, it serves as an intermediary: the client addresses the proxy, which in turn contacts the service provider on behalf of the client. In this configuration, **only the proxy** has information about the **real client** (the visitor of your web service) and the **real service provider** (one of your servers). + +For the visitor, this configuration does not raise any issues. They do not need to know the specific server handling their request; it is an implementation detail. However, for legal and statistical reasons, it is **essential** that the final server knows the client's real IP address. By default, it only identifies the proxy, which is your OVHcloud Load Balancer service. To overcome this issue, your OVHcloud Load Balancer service **adds by default** the standard HTTP headers that allow you to retrieve this information in the case of an HTTP connection. For a TCP connection, other solutions such as the ProxyProtocol exist, but they are beyond the scope of this guide. + +**This guide presents the default headers, their function, how to use them on the most common servers, and how to customize them according to the requirements of your infrastructure.** + +This guide is specifically for you if you only find private IP addresses in your access logs (`access_log`). + +## Requirements + +- Have an [OVHcloud Load Balancer](/links/network/load-balancer) offer in your OVHcloud account. +- You must be logged in to your [OVHcloud Control Panel](/links/manager). +- Have a Web service installed and configured on your servers. +- Have an Nginx service installed and configured on your servers. + +## Instructions ```bash -10.108.0.15 - - [22/Mar/2017:10:56:47 +0100] "GET / HTTP/1.1" 200 706 "-" "Mozilla/5.0 (Linux[...]" -10.108.0.24 - - [22/Mar/2017:10:56:47 +0100] "GET / HTTP/1.1" 200 706 "-" "Mozilla/5.0 (Linux[...]" +10.108.0.15 - - [02/Fev/2022:10:56:47 +0100] "GET / HTTP/1.1" 200 706 "-" "Mozilla/5.0 (Linux[...]" +10.108.0.24 - - [02/Fev/2022/:10:56:47 +0100] "GET / HTTP/1.1" 200 706 "-" "Mozilla/5.0 (Linux[...]" ``` -## Avertissement -You need to restrict access to your webservices from our IP Loadbalancing. +### Legal obligations + +You may be required to keep logs and certain data related to traffic in accordance with the laws and regulations applicable to you. **It is your responsibility to comply with these obligations.** + +**As an example:** + +- [Article L34-1 of the Code of Posts and Electronic Communications](https://www.legifrance.gouv.fr/affichCodeArticle.do?cidTexte=LEGITEXT000006070987&idArticle=LEGIARTI000006465770&dateTexte=&categorieLien=cid) and [Decree No. 2006-358 of 24 March 2006 on the retention of electronic communication data](https://www.legifrance.gouv.fr/affichTexte.do?cidTexte=JORFTEXT000000637071&dateTexte=20180110) require any natural or legal person providing a public electronic communications service to retain user identification data for the services provided, etc. ; +- [Law No. 2004-575 of 21 June 2004 on trust in the digital economy](https://www.legifrance.gouv.fr/affichTexteArticle.do?idArticle=JORFARTI000002457442&cidTexte=JORFTEXT000000801164) and [Decree No. 2011-219 of 25 February 2011](https://www.legifrance.gouv.fr/affichTexte.do?cidTexte=JORFTEXT000023646013&categorieLien=id) require, among other things, that persons whose activity consists of providing access to online public communication services retain, for each connection, data relating to the connection identifier, the start and end dates and times of the connection, etc. + +### Default headers + +By default, your OVHcloud Load Balancer service adds **five** standard HTTP headers to each request, allowing you to identify the visitor's IP address and port as well as the initial connection protocol of the visitor to your site. -With this api call you can get IP Range of our servers. +|Header|Description| +|---|---| +|X-Forwarded-For and X-Remote-Ip|IP address of the client, as seen by your OVHcloud Load Balancer.| +|X-Forwarded-Port and X-Remote-Port|Source port of the client, as seen by your OVHcloud Load Balancer.| +|X-Forwarded-Proto|Client protocol (HTTP or HTTPS), as seen by your OVHcloud Load Balancer.| + +> [!warning] +> The `X-Forwarded-*` fields can be manipulated by a malicious client, **so they should only be considered if they come from a trusted source.** +> +> It is therefore **essential** to restrict their use to trusted IP addresses, which are the output IP addresses of your OVHcloud Load Balancer service. Major web servers such as Nginx and Apache have modules that can handle this aspect of security and reliability. +> + +The list of your output IP addresses is available via the OVHcloud Control Panel and the OVHcloud API. + +#### From the OVHcloud Control Panel + +The list of IPv4 output addresses that may be used by your OVHcloud Load Balancer service is available on the homepage of your Load Balancer service under the heading "IPv4 output". + +![IPv4 output address of your OVHcloud Load Balancer service](images/iplb_service.png){.thumbnail} + +#### From the OVHcloud API + +- Retrieving the list of IP addresses used by your OVHcloud Load Balancer service: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/natIp > -If you accept proxy-headers (X-Forwarded-*) from anywhere, some request could bypass your security policies. -## Headers +### Correcting the source IP in the logs + +By default, Apache, Nginx and other web servers record the source IP address in their logs. When you use an OVHcloud Load Balancer in front of your website, the logs then only contain IP addresses of the form "10.108.a.b". These are the internal IP addresses used by the OVHcloud Load Balancer to contact you. + +When a request goes through your OVHcloud Load Balancer service, it records the visitor's IP address in the `X-Forwarded-For` and `X-Remote-Ip` headers. These two fields carry the same information, their names differ only for compatibility with most servers. -### X-Forwarded-For -This header have inside the Ip of your client. +To correct the IP addresses in the logs, one solution would be to modify the log format directive on your server to use one of these headers instead of the Load Balancer's IP address. Unfortunately, this approach is insufficient, as anyone can fill in this header, even without going through your OVHcloud Load Balancer. This manipulation would allow the visitor to impersonate someone else. Apart from the ethical aspect, this practice has legal, security and statistical implications that make its prevention essential. + +This is why the main web servers include specialized modules that allow you to precisely control the level of trust given to these headers based on: + +- The source IP address (must be exclusively that of your OVHcloud Load Balancer service!) +- The depth of the IP in the field. Indeed, each proxy (proxy, load balancer) adds the client's IP address to this field. + +The rest of this guide provides recommended configuration practices for the main web servers. #### Apache +- Create the file `/etc/apache2/conf-available/remoteip.conf`. +- Insert the following configuration: + ```apache -1. LogFormat "%{X-Forwarded-For}i-%h- %l %u %t \"%r\" %>s %O \"%{Referer}i\" \"%{User-Agent}i\"" loadbalancing -2. CustomLog /chemin/fichier.log loadbalancing +1. # Trust X-Forwarded-For headers from the OVHcloud Load Balancer +2. # See https://www.ovh.com/manager/sunrise/iplb/index.html#/iplb for an up to date list +3. RemoteIPHeader X-Forwarded-For +4. RemoteIPInternalProxy 10.108.0.0/14 +``` + +- Then replace the variables `%h` with `%a` in the `LogFormat` directives of the Apache configuration. +- Finally, enable the new configuration with: + +```bash +# Enable the 'remoteip' module and configuration +a2enmod remoteip +a2enconf remoteip + +# Restart apache to load the new module ("reload" is enough if the module was already enabled) +service apache2 restart ``` #### Nginx +For Nginx, the approach is slightly simpler, but the principle remains the same as for Apache: only take into account the `X-Forwarded-For` field if it comes from your OVHcloud Load Balancer service. + +This configuration can be applied: + +- To all sites, by inserting the configuration in the `http {}` section; +- To a specific site, by inserting the configuration in the corresponding `server {}` section; +- To a specific URL, by inserting the configuration in the corresponding `location {}` section. +- Insert the configuration in the desired section(s) (`http {}` for a global configuration): + ```nginx -1. log_format "%{X-Forwarded-For}i-%h- %l %u %t \"%r\" %>s %O \"%{Referer}i\" \"%{User-Agent}i\"" loadbalancing -2. access_log /chemin/fichier.log loadbalancing +1. # Trust X-Forwarded-For headers from the OVHcloud Load Balancer +2. # See https://www.ovh.com/manager/sunrise/iplb/index.html#/iplb for an up to date list +3. set_real_ip_from 10.108.0.0/16; +4. real_ip_header X-Forwarded-For; +``` + +- Then enable the new configuration with: + +```bash +service nginx reload ``` -### X-Forwarded-Proto -You can also get the scheme used by your client to reach OVH Load Balancer. This is helpful to redirect **HTTP** to **HTTPS** +#### Redirecting HTTP visitors to HTTPS + +To enhance security, some content such as login pages, can be restricted to the HTTPS protocol. Some sites even choose to systematically redirect all visits to the HTTPS version. By default, the HTTP and HTTPS protocols use different ports (80 and 443 respectively), so the classic solution is to place the redirection rules directly in the *vhost* dedicated to HTTP. + +When a request goes through a service like the OVHcloud Load Balancer, it handles the reception of HTTP traffic, the decryption of HTTPS traffic and forwards both types of traffic to your servers. Depending on your server configuration, all traffic will be propagated in HTTP or HTTPS, without distinction of the incoming protocol on the Load Balancer. Your server can no longer differentiate the two, as both arrive at the same point. This process is called **SSL Termination**. + +This is why the OVHcloud Load Balancer service automatically adds a header `X-Forwarded-Proto` which indicates the name of the original protocol, either "http" or "https". + +Like `X-Forwarded-For`, this header can be forged by a malicious visitor to make an insecure request appear to come from your OVHcloud Load Balancer service, in HTTPS. It is crucial to trust this header only if it is proven to come from your OVHcloud Load Balancer service. #### Apache -With htaccess, you can redirect your customers in HTTPS. -```htaccess +- Insert the following configuration in your site's `.htaccess` file: + +```apache 1. RewriteEngine on -2. RewriteCond %{HTTP:X_Forwarded_Proto} !https +2. RewriteCond %{HTTP:X-Forwarded-Proto} !https 3. RewriteRule ^ https://%{HTTP_HOST}%{REQUEST_URI} [L,R=301] ``` -#### Nginx -This is not a good configuration, you'll reduce your service performance. +- Then enable the new configuration with: ```bash -if ($http_x_forwarded_proto = "http") { - return 301 https://$host/$request_uri; -} +service apache2 reload ``` -#### Nginx (best) -With Nginx, it's best to use a entire VHost to redirect HTTP to HTTPS. +#### Nginx + +- Insert the following configuration in the `server {` section of your site: + +```nginx +1. if ($http_x_forwarded_proto = "http") { +2.         return 301 https://$host/$request_uri; +3. } +``` + +- Then enable the new configuration with: ```bash -server { - listen [::]:80 default_server; - listen 80 default_server; - server_name _; - root /var/www/; - location / { - return 301 https://$server_name$request_uri; - } -} +service nginx reload ``` -### Send headers to PHP +### Passing headers to PHP -#### Apache +PHP uses the `REMOTE_ADDR` header to determine the address of the visitors. This header is automatically configured as soon as the configuration detailed in the section "[Correcting the source IP in the logs](#ip-source-logs)" is applied. -```apache -1. Header set REMOTE_ADDR %{HTTP:X_Forwarded_Proto} -``` +### Adding custom headers -#### Nginx -With RealIP module. +Whether your application requires a specific header format to identify the visitor's IP, port or protocol, or you want to know which *frontend* a request arrived through (or for any other reason), you can add custom headers on your HTTP *frontend*. -```nginx -1. real_ip_header X-Forwarded-For; -2. set_real_ip_from 10.108.0.0/14; +Custom headers must follow the format "X-Header Header Value". The header name and its value are separated by a space. It is possible to specify several headers on the same *frontend*. + +If an existing header is present in the request, it will be overwritten and replaced by the new value, making it impossible for the visitor passing through this *frontend* to forge it. It is not possible to redefine headers reserved for proxies, such as those described in this document, as they are automatically managed by your OVHcloud Load Balancer service. + +When specifying a non-standard header name, it is customary to prefix it with "X-". + +The use of variables in the header values is supported: + +- `%ci` will be replaced by the visitor's IP address. +- `%cp` will be replaced by the visitor's source port. + +Custom headers can be configured via the OVHcloud Control Panel and the API, whether on a new *frontend* or an existing *frontend*. + +#### From the OVHcloud Control Panel + +Go to the `Frontends`{.action} tab in the dashboard of your OVHcloud Load Balancer service and select the *frontend* to edit or click on the `Add a frontend`{.action} button to create a new one. An editing window will appear, displaying an `HTTP Header`{.action} field in the `Advanced Settings`{.action} section. + +If you want to configure multiple headers, they must be separated by commas, *without spaces*. For example, you can define the following headers: `X-Ip-Header %ci,X-Port-Header %cp`. + +![Configuration of HTTP headers of a Frontend via ovh manager API](images/add_headers.png){.thumbnail} + +Click on the `Update`{.action} button after configuring the headers, then on `Deploy zone: YOUR ZONE`{.action} to apply the changes in the concerned zone. + +### From the OVHcloud API + +In the API, the headers are specified within an `httpHeader` list. Unlike the OVHcloud Control Panel, each header must be its own entry in the list. + +In the OVHcloud API console, a `+`{.action} button is available as soon as you start to specify a value, allowing you to add a new field to the list. + +![Configuration of HTTP headers of a Frontend](images/add_headers_with_api.png){.thumbnail} + +If you integrate the API into your code, this corresponds to a JSON list of the type: + +```json +1. { +2.         "httpHeader": [ +3.                 "X-Ip-Header %ci", +4.                 "X-Port-Header %cp" +5.         ] +6. } ``` + +- Modification of an existing `Frontend`{.action} : + +> [!api] +> +> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId} +> + +|Parameter|Meaning| +|---------|-------------| +|serviceName|Name of the Load Balancer service concerned| +|frontendId|Identifier of the frontend where to configure the HTTP headers| +|httpHeader|List of headers to configure| + +- Applying the changes: + +> [!api] +> +> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh +> + +|Parameter|Meaning| +|---------|-------------| +|serviceName|Name of the Load Balancer service concerned| +|zone|Name of the zone in which to deploy the configuration| + +## Go further + +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_headers/guide.en-gb.md b/pages/network/load_balancer/create_headers/guide.en-gb.md index 97bb5728a06..aa8adb97bd7 100644 --- a/pages/network/load_balancer/create_headers/guide.en-gb.md +++ b/pages/network/load_balancer/create_headers/guide.en-gb.md @@ -1,98 +1,255 @@ --- -title: 'OVH Load Balancer : HTTP Header' -excerpt: 'Get HTTP Headers on your services behind OVH Load Balancer' -updated: 2018-08-03 +title: "Configuration of an OVHcloud Load Balancer service - HTTP headers" +excerpt: Integrate your web services behind a Load Balancer with HTTP headers +updated: 2025-11-12 --- -## Introduction -With any frontend service like CDN, IP Loadbalancing in front of your services, the IP of your clients is hidden by this service. +## Objective -In your log, you'll only see privateIP, and we'll fix this. +The OVHcloud Load Balancer service acts as a proxy. Like a human proxy, it serves as an intermediary: the client addresses the proxy, which in turn contacts the service provider on behalf of the client. In this configuration, **only the proxy** has information about the **real client** (the visitor of your web service) and the **real service provider** (one of your servers). + +For the visitor, this configuration does not raise any issues. They do not need to know the specific server handling their request; it is an implementation detail. However, for legal and statistical reasons, it is **essential** that the final server knows the client's real IP address. By default, it only identifies the proxy, which is your OVHcloud Load Balancer service. To overcome this issue, your OVHcloud Load Balancer service **adds by default** the standard HTTP headers that allow you to retrieve this information in the case of an HTTP connection. For a TCP connection, other solutions such as the ProxyProtocol exist, but they are beyond the scope of this guide. + +**This guide presents the default headers, their function, how to use them on the most common servers, and how to customize them according to the requirements of your infrastructure.** + +This guide is specifically for you if you only find private IP addresses in your access logs (`access_log`). + +## Requirements + +- Have an [OVHcloud Load Balancer](/links/network/load-balancer) offer in your OVHcloud account. +- You must be logged in to your [OVHcloud Control Panel](/links/manager). +- Have a Web service installed and configured on your servers. +- Have an Nginx service installed and configured on your servers. + +## Instructions ```bash -10.108.0.15 - - [22/Mar/2017:10:56:47 +0100] "GET / HTTP/1.1" 200 706 "-" "Mozilla/5.0 (Linux[...]" -10.108.0.24 - - [22/Mar/2017:10:56:47 +0100] "GET / HTTP/1.1" 200 706 "-" "Mozilla/5.0 (Linux[...]" +10.108.0.15 - - [02/Fev/2022:10:56:47 +0100] "GET / HTTP/1.1" 200 706 "-" "Mozilla/5.0 (Linux[...]" +10.108.0.24 - - [02/Fev/2022/:10:56:47 +0100] "GET / HTTP/1.1" 200 706 "-" "Mozilla/5.0 (Linux[...]" ``` -## Warning +### Legal obligations + +You may be required to keep logs and certain data related to traffic in accordance with the laws and regulations applicable to you. **It is your responsibility to comply with these obligations.** + +**As an example:** + +- [Article L34-1 of the Code of Posts and Electronic Communications](https://www.legifrance.gouv.fr/affichCodeArticle.do?cidTexte=LEGITEXT000006070987&idArticle=LEGIARTI000006465770&dateTexte=&categorieLien=cid) and [Decree No. 2006-358 of 24 March 2006 on the retention of electronic communication data](https://www.legifrance.gouv.fr/affichTexte.do?cidTexte=JORFTEXT000000637071&dateTexte=20180110) require any natural or legal person providing a public electronic communications service to retain user identification data for the services provided, etc. ; +- [Law No. 2004-575 of 21 June 2004 on trust in the digital economy](https://www.legifrance.gouv.fr/affichTexteArticle.do?idArticle=JORFARTI000002457442&cidTexte=JORFTEXT000000801164) and [Decree No. 2011-219 of 25 February 2011](https://www.legifrance.gouv.fr/affichTexte.do?cidTexte=JORFTEXT000023646013&categorieLien=id) require, among other things, that persons whose activity consists of providing access to online public communication services retain, for each connection, data relating to the connection identifier, the start and end dates and times of the connection, etc. + +### Default headers + +By default, your OVHcloud Load Balancer service adds **five** standard HTTP headers to each request, allowing you to identify the visitor's IP address and port as well as the initial connection protocol of the visitor to your site. -You need to restrict access to your webservices from our IP Loadbalancing. +|Header|Description| +|---|---| +|X-Forwarded-For and X-Remote-Ip|IP address of the client, as seen by your OVHcloud Load Balancer.| +|X-Forwarded-Port and X-Remote-Port|Source port of the client, as seen by your OVHcloud Load Balancer.| +|X-Forwarded-Proto|Client protocol (HTTP or HTTPS), as seen by your OVHcloud Load Balancer.| -With this api call you can get IP Range of our servers. +> [!warning] +> The `X-Forwarded-*` fields can be manipulated by a malicious client, **so they should only be considered if they come from a trusted source.** +> +> It is therefore **essential** to restrict their use to trusted IP addresses, which are the output IP addresses of your OVHcloud Load Balancer service. Major web servers such as Nginx and Apache have modules that can handle this aspect of security and reliability. +> + +The list of your output IP addresses is available via the OVHcloud Control Panel and the OVHcloud API. + +#### From the OVHcloud Control Panel + +The list of IPv4 output addresses that may be used by your OVHcloud Load Balancer service is available on the homepage of your Load Balancer service under the heading "IPv4 output". + +![IPv4 output address of your OVHcloud Load Balancer service](images/iplb_service.png){.thumbnail} + +#### From the OVHcloud API + +- Retrieving the list of IP addresses used by your OVHcloud Load Balancer service: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/natIp > -If you accept proxy-headers (X-Forwarded-*) from anywhere, some request could bypass your security policies. -## Headers +### Correcting the source IP in the logs + +By default, Apache, Nginx and other web servers record the source IP address in their logs. When you use an OVHcloud Load Balancer in front of your website, the logs then only contain IP addresses of the form "10.108.a.b". These are the internal IP addresses used by the OVHcloud Load Balancer to contact you. + +When a request goes through your OVHcloud Load Balancer service, it records the visitor's IP address in the `X-Forwarded-For` and `X-Remote-Ip` headers. These two fields carry the same information, their names differ only for compatibility with most servers. + +To correct the IP addresses in the logs, one solution would be to modify the log format directive on your server to use one of these headers instead of the Load Balancer's IP address. Unfortunately, this approach is insufficient, as anyone can fill in this header, even without going through your OVHcloud Load Balancer. This manipulation would allow the visitor to impersonate someone else. Apart from the ethical aspect, this practice has legal, security and statistical implications that make its prevention essential. -### X-Forwarded-For -This header have inside the Ip of your client. +This is why the main web servers include specialized modules that allow you to precisely control the level of trust given to these headers based on: + +- The source IP address (must be exclusively that of your OVHcloud Load Balancer service!) +- The depth of the IP in the field. Indeed, each proxy (proxy, load balancer) adds the client's IP address to this field. + +The rest of this guide provides recommended configuration practices for the main web servers. #### Apache +- Create the file `/etc/apache2/conf-available/remoteip.conf`. +- Insert the following configuration: + ```apache -1. LogFormat "%{X-Forwarded-For}i-%h- %l %u %t \"%r\" %>s %O \"%{Referer}i\" \"%{User-Agent}i\"" loadbalancing -2. CustomLog /chemin/fichier.log loadbalancing +1. # Trust X-Forwarded-For headers from the OVHcloud Load Balancer +2. # See https://www.ovh.com/manager/sunrise/iplb/index.html#/iplb for an up to date list +3. RemoteIPHeader X-Forwarded-For +4. RemoteIPInternalProxy 10.108.0.0/14 +``` + +- Then replace the variables `%h` with `%a` in the `LogFormat` directives of the Apache configuration. +- Finally, enable the new configuration with: + +```bash +# Enable the 'remoteip' module and configuration +a2enmod remoteip +a2enconf remoteip + +# Restart apache to load the new module ("reload" is enough if the module was already enabled) +service apache2 restart ``` #### Nginx +For Nginx, the approach is slightly simpler, but the principle remains the same as for Apache: only take into account the `X-Forwarded-For` field if it comes from your OVHcloud Load Balancer service. + +This configuration can be applied: + +- To all sites, by inserting the configuration in the `http {}` section; +- To a specific site, by inserting the configuration in the corresponding `server {}` section; +- To a specific URL, by inserting the configuration in the corresponding `location {}` section. +- Insert the configuration in the desired section(s) (`http {}` for a global configuration): + ```nginx -1. log_format "%{X-Forwarded-For}i-%h- %l %u %t \"%r\" %>s %O \"%{Referer}i\" \"%{User-Agent}i\"" loadbalancing -2. access_log /chemin/fichier.log loadbalancing +1. # Trust X-Forwarded-For headers from the OVHcloud Load Balancer +2. # See https://www.ovh.com/manager/sunrise/iplb/index.html#/iplb for an up to date list +3. set_real_ip_from 10.108.0.0/16; +4. real_ip_header X-Forwarded-For; ``` -### X-Forwarded-Proto -You can also get the scheme used by your client to reach OVH Load Balancer. This is helpful to redirect **HTTP** to **HTTPS** +- Then enable the new configuration with: + +```bash +service nginx reload +``` + +#### Redirecting HTTP visitors to HTTPS + +To enhance security, some content such as login pages, can be restricted to the HTTPS protocol. Some sites even choose to systematically redirect all visits to the HTTPS version. By default, the HTTP and HTTPS protocols use different ports (80 and 443 respectively), so the classic solution is to place the redirection rules directly in the *vhost* dedicated to HTTP. + +When a request goes through a service like the OVHcloud Load Balancer, it handles the reception of HTTP traffic, the decryption of HTTPS traffic and forwards both types of traffic to your servers. Depending on your server configuration, all traffic will be propagated in HTTP or HTTPS, without distinction of the incoming protocol on the Load Balancer. Your server can no longer differentiate the two, as both arrive at the same point. This process is called **SSL Termination**. + +This is why the OVHcloud Load Balancer service automatically adds a header `X-Forwarded-Proto` which indicates the name of the original protocol, either "http" or "https". + +Like `X-Forwarded-For`, this header can be forged by a malicious visitor to make an insecure request appear to come from your OVHcloud Load Balancer service, in HTTPS. It is crucial to trust this header only if it is proven to come from your OVHcloud Load Balancer service. #### Apache -With htaccess, you can redirect your customers in HTTPS. -```htaccess +- Insert the following configuration in your site's `.htaccess` file: + +```apache 1. RewriteEngine on -2. RewriteCond %{HTTP:X_Forwarded_Proto} !https +2. RewriteCond %{HTTP:X-Forwarded-Proto} !https 3. RewriteRule ^ https://%{HTTP_HOST}%{REQUEST_URI} [L,R=301] ``` -#### Nginx -This is not a good configuration, you'll reduce your service performance. +- Then enable the new configuration with: ```bash -if ($http_x_forwarded_proto = "http") { - return 301 https://$host/$request_uri; -} +service apache2 reload ``` -#### Nginx (best) -With Nginx, it's best to use a entire VHost to redirect HTTP to HTTPS. +#### Nginx + +- Insert the following configuration in the `server {` section of your site: + +```nginx +1. if ($http_x_forwarded_proto = "http") { +2.         return 301 https://$host/$request_uri; +3. } +``` + +- Then enable the new configuration with: ```bash -server { - listen [::]:80 default_server; - listen 80 default_server; - server_name _; - root /var/www/; - location / { - return 301 https://$server_name$request_uri; - } -} +service nginx reload ``` -### Send headers to PHP +### Passing headers to PHP -#### Apache +PHP uses the `REMOTE_ADDR` header to determine the address of the visitors. This header is automatically configured as soon as the configuration detailed in the section "[Correcting the source IP in the logs](#ip-source-logs)" is applied. -```apache -1. Header set REMOTE_ADDR %{HTTP:X_Forwarded_Proto} -``` +### Adding custom headers -#### Nginx -With RealIP module. +Whether your application requires a specific header format to identify the visitor's IP, port or protocol, or you want to know which *frontend* a request arrived through (or for any other reason), you can add custom headers on your HTTP *frontend*. -```nginx -1. real_ip_header X-Forwarded-For; -2. set_real_ip_from 10.108.0.0/14; +Custom headers must follow the format "X-Header Header Value". The header name and its value are separated by a space. It is possible to specify several headers on the same *frontend*. + +If an existing header is present in the request, it will be overwritten and replaced by the new value, making it impossible for the visitor passing through this *frontend* to forge it. It is not possible to redefine headers reserved for proxies, such as those described in this document, as they are automatically managed by your OVHcloud Load Balancer service. + +When specifying a non-standard header name, it is customary to prefix it with "X-". + +The use of variables in the header values is supported: + +- `%ci` will be replaced by the visitor's IP address. +- `%cp` will be replaced by the visitor's source port. + +Custom headers can be configured via the OVHcloud Control Panel and the API, whether on a new *frontend* or an existing *frontend*. + +#### From the OVHcloud Control Panel + +Go to the `Frontends`{.action} tab in the dashboard of your OVHcloud Load Balancer service and select the *frontend* to edit or click on the `Add a frontend`{.action} button to create a new one. An editing window will appear, displaying an `HTTP Header`{.action} field in the `Advanced Settings`{.action} section. + +If you want to configure multiple headers, they must be separated by commas, *without spaces*. For example, you can define the following headers: `X-Ip-Header %ci,X-Port-Header %cp`. + +![Configuration of HTTP headers of a Frontend via ovh manager API](images/add_headers.png){.thumbnail} + +Click on the `Update`{.action} button after configuring the headers, then on `Deploy zone: YOUR ZONE`{.action} to apply the changes in the concerned zone. + +### From the OVHcloud API + +In the API, the headers are specified within an `httpHeader` list. Unlike the OVHcloud Control Panel, each header must be its own entry in the list. + +In the OVHcloud API console, a `+`{.action} button is available as soon as you start to specify a value, allowing you to add a new field to the list. + +![Configuration of HTTP headers of a Frontend](images/add_headers_with_api.png){.thumbnail} + +If you integrate the API into your code, this corresponds to a JSON list of the type: + +```json +1. { +2.         "httpHeader": [ +3.                 "X-Ip-Header %ci", +4.                 "X-Port-Header %cp" +5.         ] +6. } ``` + +- Modification of an existing `Frontend`{.action} : + +> [!api] +> +> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId} +> + +|Parameter|Meaning| +|---------|-------------| +|serviceName|Name of the Load Balancer service concerned| +|frontendId|Identifier of the frontend where to configure the HTTP headers| +|httpHeader|List of headers to configure| + +- Applying the changes: + +> [!api] +> +> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh +> + +|Parameter|Meaning| +|---------|-------------| +|serviceName|Name of the Load Balancer service concerned| +|zone|Name of the zone in which to deploy the configuration| + +## Go further + +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_headers/guide.en-sg.md b/pages/network/load_balancer/create_headers/guide.en-sg.md index 75cecc048dc..aa8adb97bd7 100644 --- a/pages/network/load_balancer/create_headers/guide.en-sg.md +++ b/pages/network/load_balancer/create_headers/guide.en-sg.md @@ -1,97 +1,255 @@ --- -title: OVH Load Balancer - HTTP Header -excerpt: Get HTTP Headers on your services behind OVH Load Balancer -updated: 2018-08-03 +title: "Configuration of an OVHcloud Load Balancer service - HTTP headers" +excerpt: Integrate your web services behind a Load Balancer with HTTP headers +updated: 2025-11-12 --- -## Introduction -With any frontend service like CDN, IP Loadbalancing in front of your services, the IP of your clients is hidden by this service. +## Objective -In your log, you'll only see privateIP, and we'll fix this. +The OVHcloud Load Balancer service acts as a proxy. Like a human proxy, it serves as an intermediary: the client addresses the proxy, which in turn contacts the service provider on behalf of the client. In this configuration, **only the proxy** has information about the **real client** (the visitor of your web service) and the **real service provider** (one of your servers). + +For the visitor, this configuration does not raise any issues. They do not need to know the specific server handling their request; it is an implementation detail. However, for legal and statistical reasons, it is **essential** that the final server knows the client's real IP address. By default, it only identifies the proxy, which is your OVHcloud Load Balancer service. To overcome this issue, your OVHcloud Load Balancer service **adds by default** the standard HTTP headers that allow you to retrieve this information in the case of an HTTP connection. For a TCP connection, other solutions such as the ProxyProtocol exist, but they are beyond the scope of this guide. + +**This guide presents the default headers, their function, how to use them on the most common servers, and how to customize them according to the requirements of your infrastructure.** + +This guide is specifically for you if you only find private IP addresses in your access logs (`access_log`). + +## Requirements + +- Have an [OVHcloud Load Balancer](/links/network/load-balancer) offer in your OVHcloud account. +- You must be logged in to your [OVHcloud Control Panel](/links/manager). +- Have a Web service installed and configured on your servers. +- Have an Nginx service installed and configured on your servers. + +## Instructions ```bash -10.108.0.15 - - [22/Mar/2017:10:56:47 +0100] "GET / HTTP/1.1" 200 706 "-" "Mozilla/5.0 (Linux[...]" -10.108.0.24 - - [22/Mar/2017:10:56:47 +0100] "GET / HTTP/1.1" 200 706 "-" "Mozilla/5.0 (Linux[...]" +10.108.0.15 - - [02/Fev/2022:10:56:47 +0100] "GET / HTTP/1.1" 200 706 "-" "Mozilla/5.0 (Linux[...]" +10.108.0.24 - - [02/Fev/2022/:10:56:47 +0100] "GET / HTTP/1.1" 200 706 "-" "Mozilla/5.0 (Linux[...]" ``` -## Avertissement -You need to restrict access to your webservices from our IP Loadbalancing. +### Legal obligations + +You may be required to keep logs and certain data related to traffic in accordance with the laws and regulations applicable to you. **It is your responsibility to comply with these obligations.** + +**As an example:** + +- [Article L34-1 of the Code of Posts and Electronic Communications](https://www.legifrance.gouv.fr/affichCodeArticle.do?cidTexte=LEGITEXT000006070987&idArticle=LEGIARTI000006465770&dateTexte=&categorieLien=cid) and [Decree No. 2006-358 of 24 March 2006 on the retention of electronic communication data](https://www.legifrance.gouv.fr/affichTexte.do?cidTexte=JORFTEXT000000637071&dateTexte=20180110) require any natural or legal person providing a public electronic communications service to retain user identification data for the services provided, etc. ; +- [Law No. 2004-575 of 21 June 2004 on trust in the digital economy](https://www.legifrance.gouv.fr/affichTexteArticle.do?idArticle=JORFARTI000002457442&cidTexte=JORFTEXT000000801164) and [Decree No. 2011-219 of 25 February 2011](https://www.legifrance.gouv.fr/affichTexte.do?cidTexte=JORFTEXT000023646013&categorieLien=id) require, among other things, that persons whose activity consists of providing access to online public communication services retain, for each connection, data relating to the connection identifier, the start and end dates and times of the connection, etc. + +### Default headers + +By default, your OVHcloud Load Balancer service adds **five** standard HTTP headers to each request, allowing you to identify the visitor's IP address and port as well as the initial connection protocol of the visitor to your site. -With this api call you can get IP Range of our servers. +|Header|Description| +|---|---| +|X-Forwarded-For and X-Remote-Ip|IP address of the client, as seen by your OVHcloud Load Balancer.| +|X-Forwarded-Port and X-Remote-Port|Source port of the client, as seen by your OVHcloud Load Balancer.| +|X-Forwarded-Proto|Client protocol (HTTP or HTTPS), as seen by your OVHcloud Load Balancer.| + +> [!warning] +> The `X-Forwarded-*` fields can be manipulated by a malicious client, **so they should only be considered if they come from a trusted source.** +> +> It is therefore **essential** to restrict their use to trusted IP addresses, which are the output IP addresses of your OVHcloud Load Balancer service. Major web servers such as Nginx and Apache have modules that can handle this aspect of security and reliability. +> + +The list of your output IP addresses is available via the OVHcloud Control Panel and the OVHcloud API. + +#### From the OVHcloud Control Panel + +The list of IPv4 output addresses that may be used by your OVHcloud Load Balancer service is available on the homepage of your Load Balancer service under the heading "IPv4 output". + +![IPv4 output address of your OVHcloud Load Balancer service](images/iplb_service.png){.thumbnail} + +#### From the OVHcloud API + +- Retrieving the list of IP addresses used by your OVHcloud Load Balancer service: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/natIp > -If you accept proxy-headers (X-Forwarded-*) from anywhere, some request could bypass your security policies. -## Headers +### Correcting the source IP in the logs + +By default, Apache, Nginx and other web servers record the source IP address in their logs. When you use an OVHcloud Load Balancer in front of your website, the logs then only contain IP addresses of the form "10.108.a.b". These are the internal IP addresses used by the OVHcloud Load Balancer to contact you. + +When a request goes through your OVHcloud Load Balancer service, it records the visitor's IP address in the `X-Forwarded-For` and `X-Remote-Ip` headers. These two fields carry the same information, their names differ only for compatibility with most servers. -### X-Forwarded-For -This header have inside the Ip of your client. +To correct the IP addresses in the logs, one solution would be to modify the log format directive on your server to use one of these headers instead of the Load Balancer's IP address. Unfortunately, this approach is insufficient, as anyone can fill in this header, even without going through your OVHcloud Load Balancer. This manipulation would allow the visitor to impersonate someone else. Apart from the ethical aspect, this practice has legal, security and statistical implications that make its prevention essential. + +This is why the main web servers include specialized modules that allow you to precisely control the level of trust given to these headers based on: + +- The source IP address (must be exclusively that of your OVHcloud Load Balancer service!) +- The depth of the IP in the field. Indeed, each proxy (proxy, load balancer) adds the client's IP address to this field. + +The rest of this guide provides recommended configuration practices for the main web servers. #### Apache +- Create the file `/etc/apache2/conf-available/remoteip.conf`. +- Insert the following configuration: + ```apache -1. LogFormat "%{X-Forwarded-For}i-%h- %l %u %t \"%r\" %>s %O \"%{Referer}i\" \"%{User-Agent}i\"" loadbalancing -2. CustomLog /chemin/fichier.log loadbalancing +1. # Trust X-Forwarded-For headers from the OVHcloud Load Balancer +2. # See https://www.ovh.com/manager/sunrise/iplb/index.html#/iplb for an up to date list +3. RemoteIPHeader X-Forwarded-For +4. RemoteIPInternalProxy 10.108.0.0/14 +``` + +- Then replace the variables `%h` with `%a` in the `LogFormat` directives of the Apache configuration. +- Finally, enable the new configuration with: + +```bash +# Enable the 'remoteip' module and configuration +a2enmod remoteip +a2enconf remoteip + +# Restart apache to load the new module ("reload" is enough if the module was already enabled) +service apache2 restart ``` #### Nginx +For Nginx, the approach is slightly simpler, but the principle remains the same as for Apache: only take into account the `X-Forwarded-For` field if it comes from your OVHcloud Load Balancer service. + +This configuration can be applied: + +- To all sites, by inserting the configuration in the `http {}` section; +- To a specific site, by inserting the configuration in the corresponding `server {}` section; +- To a specific URL, by inserting the configuration in the corresponding `location {}` section. +- Insert the configuration in the desired section(s) (`http {}` for a global configuration): + ```nginx -1. log_format "%{X-Forwarded-For}i-%h- %l %u %t \"%r\" %>s %O \"%{Referer}i\" \"%{User-Agent}i\"" loadbalancing -2. access_log /chemin/fichier.log loadbalancing +1. # Trust X-Forwarded-For headers from the OVHcloud Load Balancer +2. # See https://www.ovh.com/manager/sunrise/iplb/index.html#/iplb for an up to date list +3. set_real_ip_from 10.108.0.0/16; +4. real_ip_header X-Forwarded-For; +``` + +- Then enable the new configuration with: + +```bash +service nginx reload ``` -### X-Forwarded-Proto -You can also get the scheme used by your client to reach OVH Load Balancer. This is helpful to redirect **HTTP** to **HTTPS** +#### Redirecting HTTP visitors to HTTPS + +To enhance security, some content such as login pages, can be restricted to the HTTPS protocol. Some sites even choose to systematically redirect all visits to the HTTPS version. By default, the HTTP and HTTPS protocols use different ports (80 and 443 respectively), so the classic solution is to place the redirection rules directly in the *vhost* dedicated to HTTP. + +When a request goes through a service like the OVHcloud Load Balancer, it handles the reception of HTTP traffic, the decryption of HTTPS traffic and forwards both types of traffic to your servers. Depending on your server configuration, all traffic will be propagated in HTTP or HTTPS, without distinction of the incoming protocol on the Load Balancer. Your server can no longer differentiate the two, as both arrive at the same point. This process is called **SSL Termination**. + +This is why the OVHcloud Load Balancer service automatically adds a header `X-Forwarded-Proto` which indicates the name of the original protocol, either "http" or "https". + +Like `X-Forwarded-For`, this header can be forged by a malicious visitor to make an insecure request appear to come from your OVHcloud Load Balancer service, in HTTPS. It is crucial to trust this header only if it is proven to come from your OVHcloud Load Balancer service. #### Apache -With htaccess, you can redirect your customers in HTTPS. -```htaccess +- Insert the following configuration in your site's `.htaccess` file: + +```apache 1. RewriteEngine on -2. RewriteCond %{HTTP:X_Forwarded_Proto} !https +2. RewriteCond %{HTTP:X-Forwarded-Proto} !https 3. RewriteRule ^ https://%{HTTP_HOST}%{REQUEST_URI} [L,R=301] ``` -#### Nginx -This is not a good configuration, you'll reduce your service performance. +- Then enable the new configuration with: ```bash -if ($http_x_forwarded_proto = "http") { - return 301 https://$host/$request_uri; -} +service apache2 reload ``` -#### Nginx (best) -With Nginx, it's best to use a entire VHost to redirect HTTP to HTTPS. +#### Nginx + +- Insert the following configuration in the `server {` section of your site: + +```nginx +1. if ($http_x_forwarded_proto = "http") { +2.         return 301 https://$host/$request_uri; +3. } +``` + +- Then enable the new configuration with: ```bash -server { - listen [::]:80 default_server; - listen 80 default_server; - server_name _; - root /var/www/; - location / { - return 301 https://$server_name$request_uri; - } -} +service nginx reload ``` -### Send headers to PHP +### Passing headers to PHP -#### Apache +PHP uses the `REMOTE_ADDR` header to determine the address of the visitors. This header is automatically configured as soon as the configuration detailed in the section "[Correcting the source IP in the logs](#ip-source-logs)" is applied. -```apache -1. Header set REMOTE_ADDR %{HTTP:X_Forwarded_Proto} -``` +### Adding custom headers -#### Nginx -With RealIP module. +Whether your application requires a specific header format to identify the visitor's IP, port or protocol, or you want to know which *frontend* a request arrived through (or for any other reason), you can add custom headers on your HTTP *frontend*. -```nginx -1. real_ip_header X-Forwarded-For; -2. set_real_ip_from 10.108.0.0/14; +Custom headers must follow the format "X-Header Header Value". The header name and its value are separated by a space. It is possible to specify several headers on the same *frontend*. + +If an existing header is present in the request, it will be overwritten and replaced by the new value, making it impossible for the visitor passing through this *frontend* to forge it. It is not possible to redefine headers reserved for proxies, such as those described in this document, as they are automatically managed by your OVHcloud Load Balancer service. + +When specifying a non-standard header name, it is customary to prefix it with "X-". + +The use of variables in the header values is supported: + +- `%ci` will be replaced by the visitor's IP address. +- `%cp` will be replaced by the visitor's source port. + +Custom headers can be configured via the OVHcloud Control Panel and the API, whether on a new *frontend* or an existing *frontend*. + +#### From the OVHcloud Control Panel + +Go to the `Frontends`{.action} tab in the dashboard of your OVHcloud Load Balancer service and select the *frontend* to edit or click on the `Add a frontend`{.action} button to create a new one. An editing window will appear, displaying an `HTTP Header`{.action} field in the `Advanced Settings`{.action} section. + +If you want to configure multiple headers, they must be separated by commas, *without spaces*. For example, you can define the following headers: `X-Ip-Header %ci,X-Port-Header %cp`. + +![Configuration of HTTP headers of a Frontend via ovh manager API](images/add_headers.png){.thumbnail} + +Click on the `Update`{.action} button after configuring the headers, then on `Deploy zone: YOUR ZONE`{.action} to apply the changes in the concerned zone. + +### From the OVHcloud API + +In the API, the headers are specified within an `httpHeader` list. Unlike the OVHcloud Control Panel, each header must be its own entry in the list. + +In the OVHcloud API console, a `+`{.action} button is available as soon as you start to specify a value, allowing you to add a new field to the list. + +![Configuration of HTTP headers of a Frontend](images/add_headers_with_api.png){.thumbnail} + +If you integrate the API into your code, this corresponds to a JSON list of the type: + +```json +1. { +2.         "httpHeader": [ +3.                 "X-Ip-Header %ci", +4.                 "X-Port-Header %cp" +5.         ] +6. } ``` + +- Modification of an existing `Frontend`{.action} : + +> [!api] +> +> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId} +> + +|Parameter|Meaning| +|---------|-------------| +|serviceName|Name of the Load Balancer service concerned| +|frontendId|Identifier of the frontend where to configure the HTTP headers| +|httpHeader|List of headers to configure| + +- Applying the changes: + +> [!api] +> +> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh +> + +|Parameter|Meaning| +|---------|-------------| +|serviceName|Name of the Load Balancer service concerned| +|zone|Name of the zone in which to deploy the configuration| + +## Go further + +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_headers/guide.en-us.md b/pages/network/load_balancer/create_headers/guide.en-us.md index 75cecc048dc..aa8adb97bd7 100644 --- a/pages/network/load_balancer/create_headers/guide.en-us.md +++ b/pages/network/load_balancer/create_headers/guide.en-us.md @@ -1,97 +1,255 @@ --- -title: OVH Load Balancer - HTTP Header -excerpt: Get HTTP Headers on your services behind OVH Load Balancer -updated: 2018-08-03 +title: "Configuration of an OVHcloud Load Balancer service - HTTP headers" +excerpt: Integrate your web services behind a Load Balancer with HTTP headers +updated: 2025-11-12 --- -## Introduction -With any frontend service like CDN, IP Loadbalancing in front of your services, the IP of your clients is hidden by this service. +## Objective -In your log, you'll only see privateIP, and we'll fix this. +The OVHcloud Load Balancer service acts as a proxy. Like a human proxy, it serves as an intermediary: the client addresses the proxy, which in turn contacts the service provider on behalf of the client. In this configuration, **only the proxy** has information about the **real client** (the visitor of your web service) and the **real service provider** (one of your servers). + +For the visitor, this configuration does not raise any issues. They do not need to know the specific server handling their request; it is an implementation detail. However, for legal and statistical reasons, it is **essential** that the final server knows the client's real IP address. By default, it only identifies the proxy, which is your OVHcloud Load Balancer service. To overcome this issue, your OVHcloud Load Balancer service **adds by default** the standard HTTP headers that allow you to retrieve this information in the case of an HTTP connection. For a TCP connection, other solutions such as the ProxyProtocol exist, but they are beyond the scope of this guide. + +**This guide presents the default headers, their function, how to use them on the most common servers, and how to customize them according to the requirements of your infrastructure.** + +This guide is specifically for you if you only find private IP addresses in your access logs (`access_log`). + +## Requirements + +- Have an [OVHcloud Load Balancer](/links/network/load-balancer) offer in your OVHcloud account. +- You must be logged in to your [OVHcloud Control Panel](/links/manager). +- Have a Web service installed and configured on your servers. +- Have an Nginx service installed and configured on your servers. + +## Instructions ```bash -10.108.0.15 - - [22/Mar/2017:10:56:47 +0100] "GET / HTTP/1.1" 200 706 "-" "Mozilla/5.0 (Linux[...]" -10.108.0.24 - - [22/Mar/2017:10:56:47 +0100] "GET / HTTP/1.1" 200 706 "-" "Mozilla/5.0 (Linux[...]" +10.108.0.15 - - [02/Fev/2022:10:56:47 +0100] "GET / HTTP/1.1" 200 706 "-" "Mozilla/5.0 (Linux[...]" +10.108.0.24 - - [02/Fev/2022/:10:56:47 +0100] "GET / HTTP/1.1" 200 706 "-" "Mozilla/5.0 (Linux[...]" ``` -## Avertissement -You need to restrict access to your webservices from our IP Loadbalancing. +### Legal obligations + +You may be required to keep logs and certain data related to traffic in accordance with the laws and regulations applicable to you. **It is your responsibility to comply with these obligations.** + +**As an example:** + +- [Article L34-1 of the Code of Posts and Electronic Communications](https://www.legifrance.gouv.fr/affichCodeArticle.do?cidTexte=LEGITEXT000006070987&idArticle=LEGIARTI000006465770&dateTexte=&categorieLien=cid) and [Decree No. 2006-358 of 24 March 2006 on the retention of electronic communication data](https://www.legifrance.gouv.fr/affichTexte.do?cidTexte=JORFTEXT000000637071&dateTexte=20180110) require any natural or legal person providing a public electronic communications service to retain user identification data for the services provided, etc. ; +- [Law No. 2004-575 of 21 June 2004 on trust in the digital economy](https://www.legifrance.gouv.fr/affichTexteArticle.do?idArticle=JORFARTI000002457442&cidTexte=JORFTEXT000000801164) and [Decree No. 2011-219 of 25 February 2011](https://www.legifrance.gouv.fr/affichTexte.do?cidTexte=JORFTEXT000023646013&categorieLien=id) require, among other things, that persons whose activity consists of providing access to online public communication services retain, for each connection, data relating to the connection identifier, the start and end dates and times of the connection, etc. + +### Default headers + +By default, your OVHcloud Load Balancer service adds **five** standard HTTP headers to each request, allowing you to identify the visitor's IP address and port as well as the initial connection protocol of the visitor to your site. -With this api call you can get IP Range of our servers. +|Header|Description| +|---|---| +|X-Forwarded-For and X-Remote-Ip|IP address of the client, as seen by your OVHcloud Load Balancer.| +|X-Forwarded-Port and X-Remote-Port|Source port of the client, as seen by your OVHcloud Load Balancer.| +|X-Forwarded-Proto|Client protocol (HTTP or HTTPS), as seen by your OVHcloud Load Balancer.| + +> [!warning] +> The `X-Forwarded-*` fields can be manipulated by a malicious client, **so they should only be considered if they come from a trusted source.** +> +> It is therefore **essential** to restrict their use to trusted IP addresses, which are the output IP addresses of your OVHcloud Load Balancer service. Major web servers such as Nginx and Apache have modules that can handle this aspect of security and reliability. +> + +The list of your output IP addresses is available via the OVHcloud Control Panel and the OVHcloud API. + +#### From the OVHcloud Control Panel + +The list of IPv4 output addresses that may be used by your OVHcloud Load Balancer service is available on the homepage of your Load Balancer service under the heading "IPv4 output". + +![IPv4 output address of your OVHcloud Load Balancer service](images/iplb_service.png){.thumbnail} + +#### From the OVHcloud API + +- Retrieving the list of IP addresses used by your OVHcloud Load Balancer service: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/natIp > -If you accept proxy-headers (X-Forwarded-*) from anywhere, some request could bypass your security policies. -## Headers +### Correcting the source IP in the logs + +By default, Apache, Nginx and other web servers record the source IP address in their logs. When you use an OVHcloud Load Balancer in front of your website, the logs then only contain IP addresses of the form "10.108.a.b". These are the internal IP addresses used by the OVHcloud Load Balancer to contact you. + +When a request goes through your OVHcloud Load Balancer service, it records the visitor's IP address in the `X-Forwarded-For` and `X-Remote-Ip` headers. These two fields carry the same information, their names differ only for compatibility with most servers. -### X-Forwarded-For -This header have inside the Ip of your client. +To correct the IP addresses in the logs, one solution would be to modify the log format directive on your server to use one of these headers instead of the Load Balancer's IP address. Unfortunately, this approach is insufficient, as anyone can fill in this header, even without going through your OVHcloud Load Balancer. This manipulation would allow the visitor to impersonate someone else. Apart from the ethical aspect, this practice has legal, security and statistical implications that make its prevention essential. + +This is why the main web servers include specialized modules that allow you to precisely control the level of trust given to these headers based on: + +- The source IP address (must be exclusively that of your OVHcloud Load Balancer service!) +- The depth of the IP in the field. Indeed, each proxy (proxy, load balancer) adds the client's IP address to this field. + +The rest of this guide provides recommended configuration practices for the main web servers. #### Apache +- Create the file `/etc/apache2/conf-available/remoteip.conf`. +- Insert the following configuration: + ```apache -1. LogFormat "%{X-Forwarded-For}i-%h- %l %u %t \"%r\" %>s %O \"%{Referer}i\" \"%{User-Agent}i\"" loadbalancing -2. CustomLog /chemin/fichier.log loadbalancing +1. # Trust X-Forwarded-For headers from the OVHcloud Load Balancer +2. # See https://www.ovh.com/manager/sunrise/iplb/index.html#/iplb for an up to date list +3. RemoteIPHeader X-Forwarded-For +4. RemoteIPInternalProxy 10.108.0.0/14 +``` + +- Then replace the variables `%h` with `%a` in the `LogFormat` directives of the Apache configuration. +- Finally, enable the new configuration with: + +```bash +# Enable the 'remoteip' module and configuration +a2enmod remoteip +a2enconf remoteip + +# Restart apache to load the new module ("reload" is enough if the module was already enabled) +service apache2 restart ``` #### Nginx +For Nginx, the approach is slightly simpler, but the principle remains the same as for Apache: only take into account the `X-Forwarded-For` field if it comes from your OVHcloud Load Balancer service. + +This configuration can be applied: + +- To all sites, by inserting the configuration in the `http {}` section; +- To a specific site, by inserting the configuration in the corresponding `server {}` section; +- To a specific URL, by inserting the configuration in the corresponding `location {}` section. +- Insert the configuration in the desired section(s) (`http {}` for a global configuration): + ```nginx -1. log_format "%{X-Forwarded-For}i-%h- %l %u %t \"%r\" %>s %O \"%{Referer}i\" \"%{User-Agent}i\"" loadbalancing -2. access_log /chemin/fichier.log loadbalancing +1. # Trust X-Forwarded-For headers from the OVHcloud Load Balancer +2. # See https://www.ovh.com/manager/sunrise/iplb/index.html#/iplb for an up to date list +3. set_real_ip_from 10.108.0.0/16; +4. real_ip_header X-Forwarded-For; +``` + +- Then enable the new configuration with: + +```bash +service nginx reload ``` -### X-Forwarded-Proto -You can also get the scheme used by your client to reach OVH Load Balancer. This is helpful to redirect **HTTP** to **HTTPS** +#### Redirecting HTTP visitors to HTTPS + +To enhance security, some content such as login pages, can be restricted to the HTTPS protocol. Some sites even choose to systematically redirect all visits to the HTTPS version. By default, the HTTP and HTTPS protocols use different ports (80 and 443 respectively), so the classic solution is to place the redirection rules directly in the *vhost* dedicated to HTTP. + +When a request goes through a service like the OVHcloud Load Balancer, it handles the reception of HTTP traffic, the decryption of HTTPS traffic and forwards both types of traffic to your servers. Depending on your server configuration, all traffic will be propagated in HTTP or HTTPS, without distinction of the incoming protocol on the Load Balancer. Your server can no longer differentiate the two, as both arrive at the same point. This process is called **SSL Termination**. + +This is why the OVHcloud Load Balancer service automatically adds a header `X-Forwarded-Proto` which indicates the name of the original protocol, either "http" or "https". + +Like `X-Forwarded-For`, this header can be forged by a malicious visitor to make an insecure request appear to come from your OVHcloud Load Balancer service, in HTTPS. It is crucial to trust this header only if it is proven to come from your OVHcloud Load Balancer service. #### Apache -With htaccess, you can redirect your customers in HTTPS. -```htaccess +- Insert the following configuration in your site's `.htaccess` file: + +```apache 1. RewriteEngine on -2. RewriteCond %{HTTP:X_Forwarded_Proto} !https +2. RewriteCond %{HTTP:X-Forwarded-Proto} !https 3. RewriteRule ^ https://%{HTTP_HOST}%{REQUEST_URI} [L,R=301] ``` -#### Nginx -This is not a good configuration, you'll reduce your service performance. +- Then enable the new configuration with: ```bash -if ($http_x_forwarded_proto = "http") { - return 301 https://$host/$request_uri; -} +service apache2 reload ``` -#### Nginx (best) -With Nginx, it's best to use a entire VHost to redirect HTTP to HTTPS. +#### Nginx + +- Insert the following configuration in the `server {` section of your site: + +```nginx +1. if ($http_x_forwarded_proto = "http") { +2.         return 301 https://$host/$request_uri; +3. } +``` + +- Then enable the new configuration with: ```bash -server { - listen [::]:80 default_server; - listen 80 default_server; - server_name _; - root /var/www/; - location / { - return 301 https://$server_name$request_uri; - } -} +service nginx reload ``` -### Send headers to PHP +### Passing headers to PHP -#### Apache +PHP uses the `REMOTE_ADDR` header to determine the address of the visitors. This header is automatically configured as soon as the configuration detailed in the section "[Correcting the source IP in the logs](#ip-source-logs)" is applied. -```apache -1. Header set REMOTE_ADDR %{HTTP:X_Forwarded_Proto} -``` +### Adding custom headers -#### Nginx -With RealIP module. +Whether your application requires a specific header format to identify the visitor's IP, port or protocol, or you want to know which *frontend* a request arrived through (or for any other reason), you can add custom headers on your HTTP *frontend*. -```nginx -1. real_ip_header X-Forwarded-For; -2. set_real_ip_from 10.108.0.0/14; +Custom headers must follow the format "X-Header Header Value". The header name and its value are separated by a space. It is possible to specify several headers on the same *frontend*. + +If an existing header is present in the request, it will be overwritten and replaced by the new value, making it impossible for the visitor passing through this *frontend* to forge it. It is not possible to redefine headers reserved for proxies, such as those described in this document, as they are automatically managed by your OVHcloud Load Balancer service. + +When specifying a non-standard header name, it is customary to prefix it with "X-". + +The use of variables in the header values is supported: + +- `%ci` will be replaced by the visitor's IP address. +- `%cp` will be replaced by the visitor's source port. + +Custom headers can be configured via the OVHcloud Control Panel and the API, whether on a new *frontend* or an existing *frontend*. + +#### From the OVHcloud Control Panel + +Go to the `Frontends`{.action} tab in the dashboard of your OVHcloud Load Balancer service and select the *frontend* to edit or click on the `Add a frontend`{.action} button to create a new one. An editing window will appear, displaying an `HTTP Header`{.action} field in the `Advanced Settings`{.action} section. + +If you want to configure multiple headers, they must be separated by commas, *without spaces*. For example, you can define the following headers: `X-Ip-Header %ci,X-Port-Header %cp`. + +![Configuration of HTTP headers of a Frontend via ovh manager API](images/add_headers.png){.thumbnail} + +Click on the `Update`{.action} button after configuring the headers, then on `Deploy zone: YOUR ZONE`{.action} to apply the changes in the concerned zone. + +### From the OVHcloud API + +In the API, the headers are specified within an `httpHeader` list. Unlike the OVHcloud Control Panel, each header must be its own entry in the list. + +In the OVHcloud API console, a `+`{.action} button is available as soon as you start to specify a value, allowing you to add a new field to the list. + +![Configuration of HTTP headers of a Frontend](images/add_headers_with_api.png){.thumbnail} + +If you integrate the API into your code, this corresponds to a JSON list of the type: + +```json +1. { +2.         "httpHeader": [ +3.                 "X-Ip-Header %ci", +4.                 "X-Port-Header %cp" +5.         ] +6. } ``` + +- Modification of an existing `Frontend`{.action} : + +> [!api] +> +> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId} +> + +|Parameter|Meaning| +|---------|-------------| +|serviceName|Name of the Load Balancer service concerned| +|frontendId|Identifier of the frontend where to configure the HTTP headers| +|httpHeader|List of headers to configure| + +- Applying the changes: + +> [!api] +> +> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh +> + +|Parameter|Meaning| +|---------|-------------| +|serviceName|Name of the Load Balancer service concerned| +|zone|Name of the zone in which to deploy the configuration| + +## Go further + +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_headers/guide.fr-ca.md b/pages/network/load_balancer/create_headers/guide.fr-ca.md index 8db8f01c049..d678ae59fcc 100644 --- a/pages/network/load_balancer/create_headers/guide.fr-ca.md +++ b/pages/network/load_balancer/create_headers/guide.fr-ca.md @@ -1,27 +1,27 @@ --- title: "Configuration d'un service OVHcloud Load Balancer - Les en-têtes HTTP" excerpt: Intégrez vos services web derrière un Load Balancer avec les en-têtes HTTP -updated: 2022-07-27 +updated: 2025-11-12 --- ## Objectif -Le service OVHcloud Load Balancer agit comme un mandataire ou "Proxy". Comme un mandataire humain, il agit comme un intermédiaire, de telle sorte que le client s'adresse au mandataire et le mandataire au fournisseur de service, au nom du client. Dans cette configuration, seul le mandataire connait à la fois le véritable client (le visiteur de votre service web) et le véritable fournisseur de service (l'un de vos serveurs). +Le service OVHcloud Load Balancer agit en tant que mandataire ou « Proxy ». À l'instar d'un mandataire humain, il fait office d'intermédiaire : le client s'adresse au mandataire qui, à son tour, contacte le fournisseur de service au nom du client. Dans cette configuration, **seul le mandataire** est en possession des informations concernant le **véritable client** (le visiteur de votre service web) et le **véritable fournisseur de service** (l'un de vos serveurs). -Pour le visiteur, cela ne pose aucun souci. Il n'a pas besoin de connaître avec précision le serveur qui répond à sa requête. C'est un détail d'implémentation. En revanche, pour des raisons à la fois légales et de statistiques, il est indispensable que le serveur final ait connaissance de la véritable adresse du client. Or, par défaut, il ne voit que le mandataire (en l'occurence, votre service OVHcloud Load Balancer). +Pour le visiteur, cette configuration ne soulève aucune difficulté. Il n'a pas besoin de connaître le serveur précis qui traite sa requête ; il s'agit d'un détail d'implémentation. En revanche, pour des raisons à la fois légales et statistiques, il est **impératif** que le serveur final ait connaissance de l'adresse réelle du client. Or, par défaut, il n'identifie que le mandataire, en l'occurrence votre service OVHcloud Load Balancer. -Pour palier à cela, votre service OVHcloud Load Balancer ajoute par défaut les en-têtes HTTP standards permettant de retrouver ces informations dans le cas d'une connexion HTTP. Dans le cas d'une connexion TCP, d'autres solutions existent telles que le ProxyProtocol, mais cela sort du cadre de ce guide. +Afin de pallier cet inconvénient, votre service OVHcloud Load Balancer **ajoute par défaut** les en-têtes HTTP standards qui permettent de retrouver ces informations dans le cas d'une connexion HTTP. Pour une connexion TCP, d'autres solutions telles que le ProxyProtocol existent, mais elles dépassent le cadre de ce guide. -**Ce guide présente les en-têtes par défaut, leur rôle, comment les exploiter depuis les serveurs les plus courants et comment les personnaliser en fonction des contraintes de votre infrastructure.** +**Ce guide présente les en-têtes par défaut, leur fonction, la manière de les exploiter sur les serveurs les plus courants et comment les personnaliser en fonction des exigences de votre infrastructure.** -Si vous retrouvez uniquement des IP privées dans vos acces_log, ce guide est fait pour vous. +Ce guide s'adresse spécifiquement à vous si vous ne retrouvez que des adresses IP privées dans vos journaux d'accès (`access_log`). ## Prérequis -- Posséder une offre [OVHcloud Load balancer](https://www.ovh.com/ca/fr/solutions/load-balancer/) dans votre compte OVHcloud. +- Posséder une offre [OVHcloud Load balancer](/links/network/load-balancer) dans votre compte OVHcloud. - Être connecté à votre [espace client OVHcloud](/links/manager). -- Posséder un service Web installé et configuré sur vos serveurs -- Posséder un service Nginx installé et configuré sur vos serveurs +- Posséder un service Web installé et configuré sur vos serveurs. +- Posséder un service Nginx installé et configuré sur vos serveurs. ## En pratique @@ -32,64 +32,64 @@ Si vous retrouvez uniquement des IP privées dans vos acces_log, ce guide est fa ### Obligations légales -Vous pouvez être tenu de conserver des logs et certaines données relatives au trafic en vertu des lois et règlementations vous étant applicables. Il vous incombe de respecter ces obligations. +Il se peut que vous soyez tenu de conserver des journaux et certaines données relatives au trafic en vertu des lois et réglementations qui vous sont applicables. **Il vous incombe de vous conformer à ces obligations.** -**A titre d’exemple :** +**À titre d'exemple :** -- [L’article L34-1 du Code des postes et des communications électroniques](https://www.legifrance.gouv.fr/affichCodeArticle.do?cidTexte=LEGITEXT000006070987&idArticle=LEGIARTI000006465770&dateTexte=&categorieLien=cid) ainsi que le [décret n°2006-358 du 24 mars 2006 relatif à la conservation des données des communications électroniques](https://www.legifrance.gouv.fr/affichTexte.do?cidTexte=JORFTEXT000000637071&dateTexte=20180110) imposent notamment à toute personne physique ou morale fournissant au public un service de communications électroniques de conserver des données d'identification des personnes utilisatrices des services fournis, etc. ; -- La [loi n° 2004-575 du 21 juin 2004 pour la confiance dans l'économie numérique](https://www.legifrance.gouv.fr/affichTexteArticle.do?idArticle=JORFARTI000002457442&cidTexte=JORFTEXT000000801164) et le [décret n° 2011-219 du 25 février 2011](https://www.legifrance.gouv.fr/affichTexte.do?cidTexte=JORFTEXT000023646013&categorieLien=id) imposent notamment aux personnes dont l’activité est d’offrir un accès à des services de communication au public en ligne de conserver pour chaque connexion les données relatives à l’identifiant de la connexion, les dates et heure de début et de fin de la connexion, etc. +- [L'article L34-1 du Code des postes et des communications électroniques](https://www.legifrance.gouv.fr/affichCodeArticle.do?cidTexte=LEGITEXT000006070987&idArticle=LEGIARTI000006465770&dateTexte=&categorieLien=cid) ainsi que le [décret n°2006-358 du 24 mars 2006 relatif à la conservation des données des communications électroniques](https://www.legifrance.gouv.fr/affichTexte.do?cidTexte=JORFTEXT000000637071&dateTexte=20180110) imposent notamment à toute personne physique ou morale fournissant un service de communications électroniques au public de conserver les données d'identification des utilisateurs des services fournis, etc. ; +- La [loi n° 2004-575 du 21 juin 2004 pour la confiance dans l'économie numérique](https://www.legifrance.gouv.fr/affichTexteArticle.do?idArticle=JORFARTI000002457442&cidTexte=JORFTEXT000000801164) et le [décret n° 2011-219 du 25 février 2011](https://www.legifrance.gouv.fr/affichTexte.do?cidTexte=JORFTEXT000023646013&categorieLien=id) exigent notamment des personnes dont l'activité consiste à offrir un accès à des services de communication au public en ligne de conserver, pour chaque connexion, les données relatives à l'identifiant de la connexion, les dates et heures de début et de fin de la connexion, etc. -### En-tetes par defaut +### En-têtes par défaut -Par défaut, votre service OVHcloud Load Balancer ajoute à chaque requête HTTP 5 des en-têtes standard permettant de connaître l'adresse et le port du visiteur de votre site ainsi que le protocole de connexion. +Par défaut, votre service OVHcloud Load Balancer ajoute **cinq** en-têtes HTTP standards à chaque requête, permettant d'identifier l'adresse et le port du visiteur de votre site ainsi que le protocole de connexion initial. |En-tête|Description| |---|---| -|X-Forwarded-For et X-Remote-Ip|Adresse du client, telle que vue par votre OVHcloud Load Balancer.| +|X-Forwarded-For et X-Remote-Ip|Adresse IP du client, telle que vue par votre OVHcloud Load Balancer.| |X-Forwarded-Port et X-Remote-Port|Port source du client, tel que vu par votre OVHcloud Load Balancer.| |X-Forwarded-Proto|Protocole du client (HTTP ou HTTPS), tel que vu par votre OVHcloud Load Balancer.| > [!warning] ->Les champs X-Fowarded-* pouvant être forgés par un client malicieux, ils ne doivent être pris en compte que s’ils viennent d’une source de confiance. +> Les champs `X-Forwarded-*` pouvant être manipulés par un client malveillant, **ils ne doivent être pris en compte que s'ils proviennent d'une source de confiance.** > ->Il est donc indispensable de limiter leur utilisation à des adresses IP de confiance, en l'occurence les adresses IP de sortie de votre service OVHcloud Load Balancer. Les principaux serveurs tels que Nginx et Apache disposent de modules capable de gérer cet aspect de sécurité et confiance. +> Il est donc **essentiel** de restreindre leur utilisation aux adresses IP de confiance, qui sont en l'occurrence les adresses IP de sortie de votre service OVHcloud Load Balancer. Les principaux serveurs web tels que Nginx et Apache disposent de modules capables de gérer cet aspect de sécurité et de fiabilité. > -Vous pouvez obtenir la liste de vos adresse IP de sortie depuis l'espace client OVHcloud et via l'API OVHcloud. +La liste de vos adresses IP de sortie est disponible via l'espace client OVHcloud et l'API OVHcloud. #### Depuis l'espace client OVHcloud -La liste des IPv4 de sortie potentiellement utilisées par votre service OVHcloud Load Balancer se trouve sur la page d'accueil de votre service OVHcloud Load Balancer sous le nom « IPv4 de sortie ». +La liste des adresses IPv4 de sortie susceptibles d'être utilisées par votre service OVHcloud Load Balancer est accessible sur la page d'accueil de votre service Load Balancer. Dans le cadre **Informations**, cliquez sur le bouton `...`{.action} à droite de la mention **IPv4 de sortie** et sélectionnez `Consulter`{.action}. ![Adresse IPv4 de sortie de votre service OVHcloud Load Balancer](images/iplb_service.png){.thumbnail} #### Depuis l'API OVHcloud -- Liste des adresses IP utilisées par votre service OVHcloud Load Balancer : +Récupération de la liste des adresses IP utilisées par votre service OVHcloud Load Balancer : > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/natIp > -### Correction de l'IP source dans les logs +### Correction de l'adresse IP source dans les logs -Par défaut, Apache, Nginx et les autres serveurs web prennent en compte l'adresse IP source dans les logs. Quand vous utilisez un OVHcloud Load Balancer en amont de votre site web, les logs ne contiennent alors plus que des adresses IPs qui ressemblent à « 10.108.a.b ». Ce sont les adresses IP utilisées par l'OVHcloud Load Balancer pour vous contacter. +Par défaut, Apache, Nginx et les autres serveurs web enregistrent l'adresse IP source dans leurs journaux. Lorsque vous utilisez un service OVHcloud Load Balancer en amont de votre site web, les logs ne contiennent alors que des adresses IP de la forme « 10.108.a.b ». Il s'agit des adresses IP internes utilisées par le service OVHcloud Load Balancer pour vous contacter. -Lorsque la requête passe par votre service OVHcloud Load Balancer, celui-ci enregistre l'adresse IP de votre visiteur dans les en-têtes X-Forwarded-For et X-Remote-Ip. Ils contiennent la même information. Seul le nom change pour des raisons de compatibilité avec la majorité des serveurs. +Lorsqu'une requête transite par votre service OVHcloud Load Balancer, celui-ci enregistre l'adresse IP de votre visiteur dans les en-têtes `X-Forwarded-For` et `X-Remote-Ip`. Ces deux champs contiennent la même information, leur nom diffère uniquement pour des raisons de compatibilité avec la majorité des serveurs. -Pour corriger les adresses IP dans les logs, la solution évidente serait de modifier la directive de format de logs de votre serveur pour utiliser l'un de ces en-têtes en lieu et place de l'IP du Load Balancer. Malheureusement, cela ne suffit pas car n'importe qui peut renseigner ces en-tête, même s'il ne passe pas par votre OVHcloud Load Balancer. Et cela lui permettrait de se faire passer pour quelqu'un d'autre. En dehors de l'aspect éthique de cette pratique, il y a également des implications légales, de sécurité et de statistiques pour lesquelles cela ne doit pas se produire. +Pour corriger les adresses IP dans les logs, une solution pourrait être de modifier la directive de format de logs de votre serveur pour utiliser l'un de ces en-têtes à la place de l'adresse IP du Load Balancer. Malheureusement, cette approche est insuffisante, car n'importe qui peut renseigner cet en-tête, même sans passer par votre service OVHcloud Load Balancer. Une telle manipulation permettrait au visiteur de se faire passer pour quelqu'un d'autre. Outre l'aspect éthique, cette pratique a des implications légales de sécurité et de statistiques, qui rendent sa prévention indispensable. -Pour cette raison, les principaux serveurs web disposent de modules spécialisées permettant de contrôler exactement le niveau de confiance à accorder à ces en-têtes en fonction de +C'est pourquoi les principaux serveurs web intègrent des modules spécialisés permettant de contrôler avec précision le niveau de confiance accordé à ces en-têtes en se basant sur : -- L'adresse IP source (seulement celle de votre service OVHcloud Load Balancer !) -- Le niveau de profondeur de l'IP dans le champ. En effet, chaque mandataire (proxy, load balancer) ajoute l'IP de son client dans ce champ. +- l'adresse IP source (doit être exclusivement celle de votre service OVHcloud Load Balancer !) ; +- le niveau de profondeur de l'adresse IP dans le champ. En effet, chaque mandataire (proxy, load balancer) ajoute l'adresse IP de son client dans ce champ. -La suite de ce guide vous propose quelques bonnes pratiques de configuration pour les principaux serveurs webs. +La suite de ce guide propose des pratiques de configuration recommandées pour les principaux serveurs web. #### Apache -- Créez le fichier `/etc/apache2/conf-available/remoteip.conf` +- Créez le fichier `/etc/apache2/conf-available/remoteip.conf`. - Insérez la configuration suivante : ```apache @@ -99,7 +99,7 @@ La suite de ce guide vous propose quelques bonnes pratiques de configuration pou 4. RemoteIPInternalProxy 10.108.0.0/14 ``` -- Remplacez les variables `%h` par `%a` dans les directives `LogFormat` de la configuration Apache +- Remplacez les variables `%h` par `%a` dans les directives `LogFormat` de la configuration Apache. - Enfin, activez la nouvelle configuration avec : ```bash @@ -113,14 +113,14 @@ service apache2 restart #### Nginx -Pour Nginx, c'est un peu plus simple mais l'idée reste la même que pour Apache en ne prenant en compte le champ X-Forwarded-For que s'il vient de votre service OVHcloud Load Balancer. +Pour Nginx, l'approche est légèrement plus simple, mais le principe demeure identique à celui d'Apache : ne prendre en compte le champ `X-Forwarded-For` que s'il provient de votre service OVHcloud Load Balancer. -Cette configuration peut être effectuée soit : +Cette configuration peut être appliquée : -- pour l'ensemble des sites en insérant la configuration dans la section `http {}` -- pour un site en particulier en insérant la configuration dans la section `server {}` correspondante -- pour une URL en particulier en insérant la configuration dans la section `location {}` correspondante -- Insérez la configuration dans la ou les sections voulue (`http {}` pour une configuration globale) : +- à l'ensemble des sites, en insérant la configuration dans la section `http {}` ; +- à un site en particulier, en insérant la configuration dans la section `server {}` correspondante ; +- à une URL spécifique, en insérant la configuration dans la section `location {}` correspondante. +- Insérez la configuration dans la ou les sections souhaitées (`http {}` pour une configuration globale) : ```nginx 1. # Trust X-Forwarded-For headers from the OVHcloud Load Balancer @@ -137,39 +137,39 @@ service nginx reload #### Redirection des visiteurs HTTP vers HTTPS -Pour plus de sécurité, certains contenus tels que les pages de connexion peuvent n'être disponible qu'en HTTPS. Certains sites vont même plus loin en redirigeant systématiquement toutes les visites vers la version HTTPS du site. Par défaut, comme les 2 protocoles HTTP et HTTPS passent par des ports différents, respectivement le 80 et le 443, la solution consiste à mettre les règles de redirections directement dans le vhost correspondant au HTTP. +Pour renforcer la sécurité, certains contenus, tels que les pages de connexion, peuvent être restreints au protocole HTTPS. Certains sites optent même pour la redirection systématique de toutes les visites vers la version HTTPS. Par défaut, les protocoles HTTP et HTTPS utilisent des ports différents (respectivement 80 et 443), la solution classique consiste à placer les règles de redirection directement dans le *vhost* dédié au HTTP. -Lorsque la requête passe par un service comme le service OVHcloud Load Balancer, celui-ci s'occupe de recevoir le trafic HTTP, déchiffrer le trafic HTTPS et les fait suivre tous les 2 vers vos serveurs. En fonction de la configuration de vos serveurs, l'ensemble du trafic sera propagé en HTTP ou en HTTPS, sans distinction de protocole d'entrée sur le Load Balancer. Votre serveur ne peut plus faire la différence entre les 2, puisque les 2 arrivent au même endroit. On parle de « Terminaison SSL ». +Lorsqu'une requête passe par un service comme le Load Balancer OVHcloud, celui-ci gère la réception du trafic HTTP, le déchiffrement du trafic HTTPS et transmet les deux types de trafic à vos serveurs. Selon la configuration de vos serveurs, l'ensemble du trafic sera propagé en HTTP ou en HTTPS, sans distinction du protocole d'entrée sur le Load Balancer. Votre serveur ne peut plus différencier les deux, car les deux arrivent au même point. Ce processus est appelé **« Terminaison SSL »**. -Pour cette raison, le service OVHcloud Load Balancer ajoute automatiquement un en-tête `X-Forwarded-Proto` qui contient le nom du protocole d'origine. En l'occurence « http » ou « https ». +C'est pourquoi le service OVHcloud Load Balancer ajoute automatiquement un en-tête `X-Forwarded-Proto` qui indique le nom du protocole d'origine, soit « http » ou « https ». -De même que `X-Forwarded-For`, cet en-tête peut être forgé par un visiteur malicieux pour faire croire qu'une requête non sécurisée proviendrait de votre service OVHcloud Load Balancer, en HTTPS. Il est essentiel de ne faire confiance à cet en-tête que s'il vient bien de votre service OVHcloud Load Balancer. +Tout comme `X-Forwarded-For`, cet en-tête peut être contrefait par un visiteur malveillant pour faire croire qu'une requête non sécurisée provient de votre service OVHcloud Load Balancer, en HTTPS. Il est crucial de ne se fier à cet en-tête que s'il est avéré qu'il provient de votre service OVHcloud Load Balancer. #### Apache -- Insérez la configuration suivante dans le fichier .hatccess de votre site : +- Insérez la configuration suivante dans le fichier `.htaccess` de votre site : -```apache -1. RewriteEngine on -2. RewriteCond %{HTTP:X-Forwarded-Proto} !https -3. RewriteRule ^ https://%{HTTP_HOST}%{REQUEST_URI} [L,R=301] -``` + ```apache + 1. RewriteEngine on + 2. RewriteCond %{HTTP:X-Forwarded-Proto} !https + 3. RewriteRule ^ https://%{HTTP_HOST}%{REQUEST_URI} [L,R=301] + ``` - Puis activez la nouvelle configuration avec : -```bash -service apache2 reload -``` + ```bash + service apache2 reload + ``` #### Nginx -- Insérez la configuration suivante dans la section `server {`} de votre site : +- Insérez la configuration suivante dans la section `server {` de votre site : -```nginx -1. if ($http_x_forwarded_proto = "http") { -2. return 301 https://$host/$request_uri; -3. } -``` + ```nginx + 1. if ($http_x_forwarded_proto = "http") { + 2.         return 301 https://$host/$request_uri; + 3. } + ``` - Puis activez la nouvelle configuration avec : @@ -177,57 +177,57 @@ service apache2 reload service nginx reload ``` -### Transmissions des en-têtes à PHP +### Transmission des en-têtes à PHP -PHP se base sur l'en-tête `REMOTE_ADDR` pour déterminer l'adresse des visiteurs. Cet en-tête est configuré automatiquement lorsque la configuration de la section « [Correction de l’IP source dans les Logs](#ip-source-logs) » est appliquée. +PHP utilise l'en-tête `REMOTE_ADDR` pour déterminer l'adresse des visiteurs. Cet en-tête est automatiquement configuré dès lors que la configuration détaillée dans la section « [Correction de l'adresse IP source dans les logs](#ip-source-logs) » est appliquée. ### Ajouter des en-têtes personnalisés -Si votre application attend un format particulier d'en-tête pour découvrir l'IP, le port ou le protocole du visiteur ou que vous souhaitez savoir par quel frontend est arrivée une requête ou pour toute autre raison, vous pouvez ajouter des en-têtes personnalisés sur votre frontend HTTP. +Que votre application nécessite un format d'en-tête spécifique pour identifier l'adresse IP, le port ou le protocole du visiteur, ou que vous souhaitiez connaître le *frontend* par lequel une requête est arrivée (ou pour toute autre raison), vous avez la possibilité d'ajouter des en-têtes personnalisés sur votre *frontend* HTTP. -Les en-têtes personnalisés doivent être de la forme « X-En-Tete Valeur de l'Entête ». Le nom de l'en-tête et sa valeur sont séparés par un espace. Il est possible de spécifier plusieurs en-têtes sur un même frontend. +Les en-têtes personnalisés doivent respecter le format « `X-En-Tete Valeur de l'En-tête` ». Le nom de l'en-tête et sa valeur sont séparés par un espace. Il est possible de spécifier plusieurs en-têtes sur un même *frontend*. -Si un autre en-tête existe dans la requête, il sera écrasé et remplacé par la nouvelle valeur de telle sorte qu'il devient impossible pour le visiteur passant par ce frontend de le forger. Il n'est pas possible de re-définir un des en-têtes réservés aux mandataires tels que ceux décrits dans ce document. Ceux ci sont gérés automatiquement par votre service OVHcloud Load Balancer. +Si un en-tête existant est présent dans la requête, il sera écrasé et remplacé par la nouvelle valeur, rendant ainsi impossible sa contrefaçon par le visiteur passant par ce *frontend*. Il n'est pas possible de redéfinir les en-têtes réservés aux mandataires, tels que ceux décrits dans ce document, car ils sont gérés automatiquement par votre service OVHcloud Load Balancer. -Lorsque vous spécifiez un nom d'en-tête non standard, une bonne pratique est de le faire commencer par le préfixe « X- ». +Lors de la spécification d'un nom d'en-tête non standard, il est d'usage de le faire précéder du préfixe « `X-` ». -Il est possible d'utiliser des variables dans la valeur des en-têtes: +L'utilisation de variables dans la valeur des en-têtes est supportée : -- `%ci` sera remplacé par l'adresse IP de votre visiteur -- `%cp` sera remplacé par le port source de votre visiteur +- `%ci` sera remplacé par l'adresse IP de votre visiteur. +- `%cp` sera remplacé par le port source de votre visiteur. -Les en-têtes personnalisés peuvent être spécifiés via l'espace client OVHcloud et via l'API, à la fois sur un nouveau frontend comme sur un frontend existant. +Les en-têtes personnalisés peuvent être configurés via l'espace client OVHcloud et l'API, que ce soit sur un nouveau *frontend* ou un *frontend* existant. #### Depuis l'espace client OVHcloud -Dans la section `Frontends`{.action} de votre espace client OVHcloud, choisissez le frontend à éditer ou cliquez sur le bouton `Ajouter un frontend`{.action} pour en créer un nouveau. Une fenêtre d'édition apparait alors avec un champ `Entête HTTP`{.action} dans la partie `Paramètres avancés`{.action}. +Rendez-vous dans l'onglet `Frontends`{.action} du tableau de bord de votre service OVHcloud Load Balancer et sélectionnez le *frontend* à éditer ou cliquez sur le bouton `Ajouter un frontend`{.action} pour en créer un nouveau. Une fenêtre d'édition apparaîtra, présentant un champ `Entête HTTP`{.action} dans la section `Paramètres avancés`{.action}. -Si vous souhaitez configurer plusieurs en-têtes, ceux-ci doivent être séparés par des virgules *sans espaces*. Par exemple, vous pouvez créer les en-têtes suivants: `X-Ip-Header %ci,X-Port-Header %cp`. +Si vous souhaitez configurer plusieurs en-têtes, ceux-ci doivent être séparés par des virgules, *sans espace*. Par exemple, vous pouvez définir les en-têtes suivants : `X-Ip-Header %ci,X-Port-Header %cp`. ![Configuration des en-têtes HTTP d'un Frontend via ovh manager API](images/add_headers.png){.thumbnail} -Cliquez sur le bouton `Mettre à jour`{.action} une fois les en-têtes configurés puis sur `Déployer la zone: VOTRE ZONE`{.action} pour appliquer vos changements dans la zone concernée. +Cliquez sur le bouton `Mettre à jour`{.action} après avoir configuré les en-têtes, puis sur `Déployer la zone: VOTRE ZONE`{.action} pour appliquer les modifications dans la zone concernée. ### Depuis l'API OVHcloud -Dans l'API, les en-têtes sont spécifiées dans une liste httpHeader. À la différence de l'espace client OVHcloud, chaque en-tête doit être dans sa propre entrée de la liste. +Dans l'API, les en-têtes sont spécifiés au sein d'une liste `httpHeader`. Contrairement à l'espace client OVHcloud, chaque en-tête doit constituer sa propre entrée dans la liste. -Dans la console de l'API OVHcloud, un bouton `+`{.action} est disponible dès que vous commencez à spécifier une valeur, afin d'ajouter un nouveau champ dans la liste. +Dans la console de l'API OVHcloud, un bouton `+`{.action} est disponible dès que vous commencez à spécifier une valeur, permettant d'ajouter un nouveau champ à la liste. ![Configuration des en-têtes HTTP d'un Frontend](images/add_headers_with_api.png){.thumbnail} -Si vous utilisez l'API dans votre code, cela correspond à une liste json telle que : +Si vous intégrez l'API dans votre code, cela correspond à une liste JSON du type : ```json 1. { -2. "httpHeader": [ -3. "X-Ip-Header %ci", -4. "X-Port-Header %cp" -5. ] +2.         "httpHeader": [ +3.                 "X-Ip-Header %ci", +4.                 "X-Port-Header %cp" +5.         ] 6. } ``` -- Modifier un `Frontend`{.action} existant : +- Modification d'un `Frontend`{.action} existant : > [!api] > @@ -240,7 +240,7 @@ Si vous utilisez l'API dans votre code, cela correspond à une liste json telle |frontendId|Identifiant du frontend où configurer les en-têtes HTTP| |httpHeader|Liste d'en-têtes à configurer| -- Appliquer les modifications : +- Application des modifications : > [!api] > @@ -254,4 +254,4 @@ Si vous utilisez l'API dans votre code, cela correspond à une liste json telle ## Aller plus loin -Échangez avec notre [communauté d'utilisateurs](/links/community). +Échangez avec notre [communauté d'utilisateurs](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_headers/guide.fr-fr.md b/pages/network/load_balancer/create_headers/guide.fr-fr.md index 9cee53504d1..b07ed48ee28 100644 --- a/pages/network/load_balancer/create_headers/guide.fr-fr.md +++ b/pages/network/load_balancer/create_headers/guide.fr-fr.md @@ -1,27 +1,27 @@ --- title: "Configuration d'un service OVHcloud Load Balancer - Les en-têtes HTTP" excerpt: Intégrez vos services web derrière un Load Balancer avec les en-têtes HTTP -updated: 2022-07-27 +updated: 2025-11-12 --- ## Objectif -Le service OVHcloud Load Balancer agit comme un mandataire ou "Proxy". Comme un mandataire humain, il agit comme un intermédiaire, de telle sorte que le client s'adresse au mandataire et le mandataire au fournisseur de service, au nom du client. Dans cette configuration, seul le mandataire connait à la fois le véritable client (le visiteur de votre service web) et le véritable fournisseur de service (l'un de vos serveurs). +Le service OVHcloud Load Balancer agit en tant que mandataire ou « Proxy ». À l'instar d'un mandataire humain, il fait office d'intermédiaire : le client s'adresse au mandataire qui, à son tour, contacte le fournisseur de service au nom du client. Dans cette configuration, **seul le mandataire** est en possession des informations concernant le **véritable client** (le visiteur de votre service web) et le **véritable fournisseur de service** (l'un de vos serveurs). -Pour le visiteur, cela ne pose aucun souci. Il n'a pas besoin de connaître avec précision le serveur qui répond à sa requête. C'est un détail d'implémentation. En revanche, pour des raisons à la fois légales et de statistiques, il est indispensable que le serveur final ait connaissance de la véritable adresse du client. Or, par défaut, il ne voit que le mandataire (en l'occurence, votre service OVHcloud Load Balancer). +Pour le visiteur, cette configuration ne soulève aucune difficulté. Il n'a pas besoin de connaître le serveur précis qui traite sa requête ; il s'agit d'un détail d'implémentation. En revanche, pour des raisons à la fois légales et statistiques, il est **impératif** que le serveur final ait connaissance de l'adresse réelle du client. Or, par défaut, il n'identifie que le mandataire, en l'occurrence votre service OVHcloud Load Balancer. -Pour palier à cela, votre service OVHcloud Load Balancer ajoute par défaut les en-têtes HTTP standards permettant de retrouver ces informations dans le cas d'une connexion HTTP. Dans le cas d'une connexion TCP, d'autres solutions existent telles que le ProxyProtocol, mais cela sort du cadre de ce guide. +Afin de pallier cet inconvénient, votre service OVHcloud Load Balancer **ajoute par défaut** les en-têtes HTTP standards qui permettent de retrouver ces informations dans le cas d'une connexion HTTP. Pour une connexion TCP, d'autres solutions telles que le ProxyProtocol existent, mais elles dépassent le cadre de ce guide. -**Ce guide présente les en-têtes par défaut, leur rôle, comment les exploiter depuis les serveurs les plus courants et comment les personnaliser en fonction des contraintes de votre infrastructure.** +**Ce guide présente les en-têtes par défaut, leur fonction, la manière de les exploiter sur les serveurs les plus courants et comment les personnaliser en fonction des exigences de votre infrastructure.** -Si vous retrouvez uniquement des IP privées dans vos acces_log, ce guide est fait pour vous. +Ce guide s'adresse spécifiquement à vous si vous ne retrouvez que des adresses IP privées dans vos journaux d'accès (`access_log`). ## Prérequis - Posséder une offre [OVHcloud Load balancer](/links/network/load-balancer) dans votre compte OVHcloud. - Être connecté à votre [espace client OVHcloud](/links/manager). -- Posséder un service Web installé et configuré sur vos serveurs -- Posséder un service Nginx installé et configuré sur vos serveurs +- Posséder un service Web installé et configuré sur vos serveurs. +- Posséder un service Nginx installé et configuré sur vos serveurs. ## En pratique @@ -32,64 +32,64 @@ Si vous retrouvez uniquement des IP privées dans vos acces_log, ce guide est fa ### Obligations légales -Vous pouvez être tenu de conserver des logs et certaines données relatives au trafic en vertu des lois et règlementations vous étant applicables. Il vous incombe de respecter ces obligations. +Il se peut que vous soyez tenu de conserver des journaux et certaines données relatives au trafic en vertu des lois et réglementations qui vous sont applicables. **Il vous incombe de vous conformer à ces obligations.** -**A titre d’exemple :** +**À titre d'exemple :** -- [L’article L34-1 du Code des postes et des communications électroniques](https://www.legifrance.gouv.fr/affichCodeArticle.do?cidTexte=LEGITEXT000006070987&idArticle=LEGIARTI000006465770&dateTexte=&categorieLien=cid) ainsi que le [décret n°2006-358 du 24 mars 2006 relatif à la conservation des données des communications électroniques](https://www.legifrance.gouv.fr/affichTexte.do?cidTexte=JORFTEXT000000637071&dateTexte=20180110) imposent notamment à toute personne physique ou morale fournissant au public un service de communications électroniques de conserver des données d'identification des personnes utilisatrices des services fournis, etc. ; -- La [loi n° 2004-575 du 21 juin 2004 pour la confiance dans l'économie numérique](https://www.legifrance.gouv.fr/affichTexteArticle.do?idArticle=JORFARTI000002457442&cidTexte=JORFTEXT000000801164) et le [décret n° 2011-219 du 25 février 2011](https://www.legifrance.gouv.fr/affichTexte.do?cidTexte=JORFTEXT000023646013&categorieLien=id) imposent notamment aux personnes dont l’activité est d’offrir un accès à des services de communication au public en ligne de conserver pour chaque connexion les données relatives à l’identifiant de la connexion, les dates et heure de début et de fin de la connexion, etc. +- [L'article L34-1 du Code des postes et des communications électroniques](https://www.legifrance.gouv.fr/affichCodeArticle.do?cidTexte=LEGITEXT000006070987&idArticle=LEGIARTI000006465770&dateTexte=&categorieLien=cid) ainsi que le [décret n°2006-358 du 24 mars 2006 relatif à la conservation des données des communications électroniques](https://www.legifrance.gouv.fr/affichTexte.do?cidTexte=JORFTEXT000000637071&dateTexte=20180110) imposent notamment à toute personne physique ou morale fournissant un service de communications électroniques au public de conserver les données d'identification des utilisateurs des services fournis, etc. ; +- La [loi n° 2004-575 du 21 juin 2004 pour la confiance dans l'économie numérique](https://www.legifrance.gouv.fr/affichTexteArticle.do?idArticle=JORFARTI000002457442&cidTexte=JORFTEXT000000801164) et le [décret n° 2011-219 du 25 février 2011](https://www.legifrance.gouv.fr/affichTexte.do?cidTexte=JORFTEXT000023646013&categorieLien=id) exigent notamment des personnes dont l'activité consiste à offrir un accès à des services de communication au public en ligne de conserver, pour chaque connexion, les données relatives à l'identifiant de la connexion, les dates et heures de début et de fin de la connexion, etc. -### En-tetes par defaut +### En-têtes par défaut -Par défaut, votre service OVHcloud Load Balancer ajoute à chaque requête HTTP 5 des en-têtes standard permettant de connaître l'adresse et le port du visiteur de votre site ainsi que le protocole de connexion. +Par défaut, votre service OVHcloud Load Balancer ajoute **cinq** en-têtes HTTP standards à chaque requête, permettant d'identifier l'adresse et le port du visiteur de votre site ainsi que le protocole de connexion initial. |En-tête|Description| |---|---| -|X-Forwarded-For et X-Remote-Ip|Adresse du client, telle que vue par votre OVHcloud Load Balancer.| +|X-Forwarded-For et X-Remote-Ip|Adresse IP du client, telle que vue par votre OVHcloud Load Balancer.| |X-Forwarded-Port et X-Remote-Port|Port source du client, tel que vu par votre OVHcloud Load Balancer.| |X-Forwarded-Proto|Protocole du client (HTTP ou HTTPS), tel que vu par votre OVHcloud Load Balancer.| > [!warning] ->Les champs X-Fowarded-* pouvant être forgés par un client malicieux, ils ne doivent être pris en compte que s’ils viennent d’une source de confiance. +> Les champs `X-Forwarded-*` pouvant être manipulés par un client malveillant, **ils ne doivent être pris en compte que s'ils proviennent d'une source de confiance.** > ->Il est donc indispensable de limiter leur utilisation à des adresses IP de confiance, en l'occurence les adresses IP de sortie de votre service OVHcloud Load Balancer. Les principaux serveurs tels que Nginx et Apache disposent de modules capable de gérer cet aspect de sécurité et confiance. +> Il est donc **essentiel** de restreindre leur utilisation aux adresses IP de confiance, qui sont en l'occurrence les adresses IP de sortie de votre service OVHcloud Load Balancer. Les principaux serveurs web tels que Nginx et Apache disposent de modules capables de gérer cet aspect de sécurité et de fiabilité. > -Vous pouvez obtenir la liste de vos adresse IP de sortie depuis l'espace client OVHcloud et via l'API OVHcloud. +La liste de vos adresses IP de sortie est disponible via l'espace client OVHcloud et l'API OVHcloud. #### Depuis l'espace client OVHcloud -La liste des IPv4 de sortie potentiellement utilisées par votre service OVHcloud Load Balancer se trouve sur la page d'accueil de votre service OVHcloud Load Balancer sous le nom « IPv4 de sortie ». +La liste des adresses IPv4 de sortie susceptibles d'être utilisées par votre service OVHcloud Load Balancer est accessible sur la page d'accueil de votre service Load Balancer. Dans le cadre **Informations**, cliquez sur le bouton `...`{.action} à droite de la mention **IPv4 de sortie** et sélectionnez `Consulter`{.action}. ![Adresse IPv4 de sortie de votre service OVHcloud Load Balancer](images/iplb_service.png){.thumbnail} #### Depuis l'API OVHcloud -- Liste des adresses IP utilisées par votre service OVHcloud Load Balancer : +Récupération de la liste des adresses IP utilisées par votre service OVHcloud Load Balancer : > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/natIp > -### Correction de l'IP source dans les logs +### Correction de l'adresse IP source dans les logs -Par défaut, Apache, Nginx et les autres serveurs web prennent en compte l'adresse IP source dans les logs. Quand vous utilisez un OVHcloud Load Balancer en amont de votre site web, les logs ne contiennent alors plus que des adresses IPs qui ressemblent à « 10.108.a.b ». Ce sont les adresses IP utilisées par l'OVHcloud Load Balancer pour vous contacter. +Par défaut, Apache, Nginx et les autres serveurs web enregistrent l'adresse IP source dans leurs journaux. Lorsque vous utilisez un service OVHcloud Load Balancer en amont de votre site web, les logs ne contiennent alors que des adresses IP de la forme « 10.108.a.b ». Il s'agit des adresses IP internes utilisées par le service OVHcloud Load Balancer pour vous contacter. -Lorsque la requête passe par votre service OVHcloud Load Balancer, celui-ci enregistre l'adresse IP de votre visiteur dans les en-têtes X-Forwarded-For et X-Remote-Ip. Ils contiennent la même information. Seul le nom change pour des raisons de compatibilité avec la majorité des serveurs. +Lorsqu'une requête transite par votre service OVHcloud Load Balancer, celui-ci enregistre l'adresse IP de votre visiteur dans les en-têtes `X-Forwarded-For` et `X-Remote-Ip`. Ces deux champs contiennent la même information, leur nom diffère uniquement pour des raisons de compatibilité avec la majorité des serveurs. -Pour corriger les adresses IP dans les logs, la solution évidente serait de modifier la directive de format de logs de votre serveur pour utiliser l'un de ces en-têtes en lieu et place de l'IP du Load Balancer. Malheureusement, cela ne suffit pas car n'importe qui peut renseigner ces en-tête, même s'il ne passe pas par votre OVHcloud Load Balancer. Et cela lui permettrait de se faire passer pour quelqu'un d'autre. En dehors de l'aspect éthique de cette pratique, il y a également des implications légales, de sécurité et de statistiques pour lesquelles cela ne doit pas se produire. +Pour corriger les adresses IP dans les logs, une solution pourrait être de modifier la directive de format de logs de votre serveur pour utiliser l'un de ces en-têtes à la place de l'adresse IP du Load Balancer. Malheureusement, cette approche est insuffisante, car n'importe qui peut renseigner cet en-tête, même sans passer par votre service OVHcloud Load Balancer. Une telle manipulation permettrait au visiteur de se faire passer pour quelqu'un d'autre. Outre l'aspect éthique, cette pratique a des implications légales de sécurité et de statistiques, qui rendent sa prévention indispensable. -Pour cette raison, les principaux serveurs web disposent de modules spécialisées permettant de contrôler exactement le niveau de confiance à accorder à ces en-têtes en fonction de +C'est pourquoi les principaux serveurs web intègrent des modules spécialisés permettant de contrôler avec précision le niveau de confiance accordé à ces en-têtes en se basant sur : -- L'adresse IP source (seulement celle de votre service OVHcloud Load Balancer !) -- Le niveau de profondeur de l'IP dans le champ. En effet, chaque mandataire (proxy, load balancer) ajoute l'IP de son client dans ce champ. +- l'adresse IP source (doit être exclusivement celle de votre service OVHcloud Load Balancer !) ; +- le niveau de profondeur de l'adresse IP dans le champ. En effet, chaque mandataire (proxy, load balancer) ajoute l'adresse IP de son client dans ce champ. -La suite de ce guide vous propose quelques bonnes pratiques de configuration pour les principaux serveurs webs. +La suite de ce guide propose des pratiques de configuration recommandées pour les principaux serveurs web. #### Apache -- Créez le fichier `/etc/apache2/conf-available/remoteip.conf` +- Créez le fichier `/etc/apache2/conf-available/remoteip.conf`. - Insérez la configuration suivante : ```apache @@ -99,7 +99,7 @@ La suite de ce guide vous propose quelques bonnes pratiques de configuration pou 4. RemoteIPInternalProxy 10.108.0.0/14 ``` -- Remplacez les variables `%h` par `%a` dans les directives `LogFormat` de la configuration Apache +- Remplacez les variables `%h` par `%a` dans les directives `LogFormat` de la configuration Apache. - Enfin, activez la nouvelle configuration avec : ```bash @@ -113,14 +113,14 @@ service apache2 restart #### Nginx -Pour Nginx, c'est un peu plus simple mais l'idée reste la même que pour Apache en ne prenant en compte le champ X-Forwarded-For que s'il vient de votre service OVHcloud Load Balancer. +Pour Nginx, l'approche est légèrement plus simple, mais le principe demeure identique à celui d'Apache : ne prendre en compte le champ `X-Forwarded-For` que s'il provient de votre service OVHcloud Load Balancer. -Cette configuration peut être effectuée soit : +Cette configuration peut être appliquée : -- pour l'ensemble des sites en insérant la configuration dans la section `http {}` -- pour un site en particulier en insérant la configuration dans la section `server {}` correspondante -- pour une URL en particulier en insérant la configuration dans la section `location {}` correspondante -- Insérez la configuration dans la ou les sections voulue (`http {}` pour une configuration globale) : +- à l'ensemble des sites, en insérant la configuration dans la section `http {}` ; +- à un site en particulier, en insérant la configuration dans la section `server {}` correspondante ; +- à une URL spécifique, en insérant la configuration dans la section `location {}` correspondante. +- Insérez la configuration dans la ou les sections souhaitées (`http {}` pour une configuration globale) : ```nginx 1. # Trust X-Forwarded-For headers from the OVHcloud Load Balancer @@ -137,39 +137,39 @@ service nginx reload #### Redirection des visiteurs HTTP vers HTTPS -Pour plus de sécurité, certains contenus tels que les pages de connexion peuvent n'être disponible qu'en HTTPS. Certains sites vont même plus loin en redirigeant systématiquement toutes les visites vers la version HTTPS du site. Par défaut, comme les 2 protocoles HTTP et HTTPS passent par des ports différents, respectivement le 80 et le 443, la solution consiste à mettre les règles de redirections directement dans le vhost correspondant au HTTP. +Pour renforcer la sécurité, certains contenus, tels que les pages de connexion, peuvent être restreints au protocole HTTPS. Certains sites optent même pour la redirection systématique de toutes les visites vers la version HTTPS. Par défaut, les protocoles HTTP et HTTPS utilisent des ports différents (respectivement 80 et 443), la solution classique consiste à placer les règles de redirection directement dans le *vhost* dédié au HTTP. -Lorsque la requête passe par un service comme le service OVHcloud Load Balancer, celui-ci s'occupe de recevoir le trafic HTTP, déchiffrer le trafic HTTPS et les fait suivre tous les 2 vers vos serveurs. En fonction de la configuration de vos serveurs, l'ensemble du trafic sera propagé en HTTP ou en HTTPS, sans distinction de protocole d'entrée sur le Load Balancer. Votre serveur ne peut plus faire la différence entre les 2, puisque les 2 arrivent au même endroit. On parle de « Terminaison SSL ». +Lorsqu'une requête passe par un service comme le Load Balancer OVHcloud, celui-ci gère la réception du trafic HTTP, le déchiffrement du trafic HTTPS et transmet les deux types de trafic à vos serveurs. Selon la configuration de vos serveurs, l'ensemble du trafic sera propagé en HTTP ou en HTTPS, sans distinction du protocole d'entrée sur le Load Balancer. Votre serveur ne peut plus différencier les deux, car les deux arrivent au même point. Ce processus est appelé **« Terminaison SSL »**. -Pour cette raison, le service OVHcloud Load Balancer ajoute automatiquement un en-tête `X-Forwarded-Proto` qui contient le nom du protocole d'origine. En l'occurence « http » ou « https ». +C'est pourquoi le service OVHcloud Load Balancer ajoute automatiquement un en-tête `X-Forwarded-Proto` qui indique le nom du protocole d'origine, soit « http » ou « https ». -De même que `X-Forwarded-For`, cet en-tête peut être forgé par un visiteur malicieux pour faire croire qu'une requête non sécurisée proviendrait de votre service OVHcloud Load Balancer, en HTTPS. Il est essentiel de ne faire confiance à cet en-tête que s'il vient bien de votre service OVHcloud Load Balancer. +Tout comme `X-Forwarded-For`, cet en-tête peut être contrefait par un visiteur malveillant pour faire croire qu'une requête non sécurisée provient de votre service OVHcloud Load Balancer, en HTTPS. Il est crucial de ne se fier à cet en-tête que s'il est avéré qu'il provient de votre service OVHcloud Load Balancer. #### Apache -- Insérez la configuration suivante dans le fichier .hatccess de votre site : +- Insérez la configuration suivante dans le fichier `.htaccess` de votre site : -```apache -1. RewriteEngine on -2. RewriteCond %{HTTP:X-Forwarded-Proto} !https -3. RewriteRule ^ https://%{HTTP_HOST}%{REQUEST_URI} [L,R=301] -``` + ```apache + 1. RewriteEngine on + 2. RewriteCond %{HTTP:X-Forwarded-Proto} !https + 3. RewriteRule ^ https://%{HTTP_HOST}%{REQUEST_URI} [L,R=301] + ``` - Puis activez la nouvelle configuration avec : -```bash -service apache2 reload -``` + ```bash + service apache2 reload + ``` #### Nginx -- Insérez la configuration suivante dans la section `server {`} de votre site : +- Insérez la configuration suivante dans la section `server {` de votre site : -```nginx -1. if ($http_x_forwarded_proto = "http") { -2. return 301 https://$host/$request_uri; -3. } -``` + ```nginx + 1. if ($http_x_forwarded_proto = "http") { + 2.         return 301 https://$host/$request_uri; + 3. } + ``` - Puis activez la nouvelle configuration avec : @@ -177,57 +177,57 @@ service apache2 reload service nginx reload ``` -### Transmissions des en-têtes à PHP +### Transmission des en-têtes à PHP -PHP se base sur l'en-tête `REMOTE_ADDR` pour déterminer l'adresse des visiteurs. Cet en-tête est configuré automatiquement lorsque la configuration de la section « [Correction de l’IP source dans les Logs](#ip-source-logs) » est appliquée. +PHP utilise l'en-tête `REMOTE_ADDR` pour déterminer l'adresse des visiteurs. Cet en-tête est automatiquement configuré dès lors que la configuration détaillée dans la section « [Correction de l'adresse IP source dans les logs](#ip-source-logs) » est appliquée. ### Ajouter des en-têtes personnalisés -Si votre application attend un format particulier d'en-tête pour découvrir l'IP, le port ou le protocole du visiteur ou que vous souhaitez savoir par quel frontend est arrivée une requête ou pour toute autre raison, vous pouvez ajouter des en-têtes personnalisés sur votre frontend HTTP. +Que votre application nécessite un format d'en-tête spécifique pour identifier l'adresse IP, le port ou le protocole du visiteur, ou que vous souhaitiez connaître le *frontend* par lequel une requête est arrivée (ou pour toute autre raison), vous avez la possibilité d'ajouter des en-têtes personnalisés sur votre *frontend* HTTP. -Les en-têtes personnalisés doivent être de la forme « X-En-Tete Valeur de l'Entête ». Le nom de l'en-tête et sa valeur sont séparés par un espace. Il est possible de spécifier plusieurs en-têtes sur un même frontend. +Les en-têtes personnalisés doivent respecter le format « `X-En-Tete Valeur de l'En-tête` ». Le nom de l'en-tête et sa valeur sont séparés par un espace. Il est possible de spécifier plusieurs en-têtes sur un même *frontend*. -Si un autre en-tête existe dans la requête, il sera écrasé et remplacé par la nouvelle valeur de telle sorte qu'il devient impossible pour le visiteur passant par ce frontend de le forger. Il n'est pas possible de re-définir un des en-têtes réservés aux mandataires tels que ceux décrits dans ce document. Ceux ci sont gérés automatiquement par votre service OVHcloud Load Balancer. +Si un en-tête existant est présent dans la requête, il sera écrasé et remplacé par la nouvelle valeur, rendant ainsi impossible sa contrefaçon par le visiteur passant par ce *frontend*. Il n'est pas possible de redéfinir les en-têtes réservés aux mandataires, tels que ceux décrits dans ce document, car ils sont gérés automatiquement par votre service OVHcloud Load Balancer. -Lorsque vous spécifiez un nom d'en-tête non standard, une bonne pratique est de le faire commencer par le préfixe « X- ». +Lors de la spécification d'un nom d'en-tête non standard, il est d'usage de le faire précéder du préfixe « `X-` ». -Il est possible d'utiliser des variables dans la valeur des en-têtes: +L'utilisation de variables dans la valeur des en-têtes est supportée : -- `%ci` sera remplacé par l'adresse IP de votre visiteur -- `%cp` sera remplacé par le port source de votre visiteur +- `%ci` sera remplacé par l'adresse IP de votre visiteur. +- `%cp` sera remplacé par le port source de votre visiteur. -Les en-têtes personnalisés peuvent être spécifiés via l'espace client OVHcloud et via l'API, à la fois sur un nouveau frontend comme sur un frontend existant. +Les en-têtes personnalisés peuvent être configurés via l'espace client OVHcloud et l'API, que ce soit sur un nouveau *frontend* ou un *frontend* existant. #### Depuis l'espace client OVHcloud -Dans la section `Frontends`{.action} de votre espace client OVHcloud, choisissez le frontend à éditer ou cliquez sur le bouton `Ajouter un frontend`{.action} pour en créer un nouveau. Une fenêtre d'édition apparait alors avec un champ `Entête HTTP`{.action} dans la partie `Paramètres avancés`{.action}. +Rendez-vous dans l'onglet `Frontends`{.action} du tableau de bord de votre service OVHcloud Load Balancer et sélectionnez le *frontend* à éditer ou cliquez sur le bouton `Ajouter un frontend`{.action} pour en créer un nouveau. Une fenêtre d'édition apparaîtra, présentant un champ `Entête HTTP`{.action} dans la section `Paramètres avancés`{.action}. -Si vous souhaitez configurer plusieurs en-têtes, ceux-ci doivent être séparés par des virgules *sans espaces*. Par exemple, vous pouvez créer les en-têtes suivants: `X-Ip-Header %ci,X-Port-Header %cp`. +Si vous souhaitez configurer plusieurs en-têtes, ceux-ci doivent être séparés par des virgules, *sans espace*. Par exemple, vous pouvez définir les en-têtes suivants : `X-Ip-Header %ci,X-Port-Header %cp`. ![Configuration des en-têtes HTTP d'un Frontend via ovh manager API](images/add_headers.png){.thumbnail} -Cliquez sur le bouton `Mettre à jour`{.action} une fois les en-têtes configurés puis sur `Déployer la zone: VOTRE ZONE`{.action} pour appliquer vos changements dans la zone concernée. +Cliquez sur le bouton `Mettre à jour`{.action} après avoir configuré les en-têtes, puis sur `Déployer la zone: VOTRE ZONE`{.action} pour appliquer les modifications dans la zone concernée. ### Depuis l'API OVHcloud -Dans l'API, les en-têtes sont spécifiées dans une liste httpHeader. À la différence de l'espace client OVHcloud, chaque en-tête doit être dans sa propre entrée de la liste. +Dans l'API, les en-têtes sont spécifiés au sein d'une liste `httpHeader`. Contrairement à l'espace client OVHcloud, chaque en-tête doit constituer sa propre entrée dans la liste. -Dans la console de l'API OVHcloud, un bouton `+`{.action} est disponible dès que vous commencez à spécifier une valeur, afin d'ajouter un nouveau champ dans la liste. +Dans la console de l'API OVHcloud, un bouton `+`{.action} est disponible dès que vous commencez à spécifier une valeur, permettant d'ajouter un nouveau champ à la liste. ![Configuration des en-têtes HTTP d'un Frontend](images/add_headers_with_api.png){.thumbnail} -Si vous utilisez l'API dans votre code, cela correspond à une liste json telle que : +Si vous intégrez l'API dans votre code, cela correspond à une liste JSON du type : ```json 1. { -2. "httpHeader": [ -3. "X-Ip-Header %ci", -4. "X-Port-Header %cp" -5. ] +2.         "httpHeader": [ +3.                 "X-Ip-Header %ci", +4.                 "X-Port-Header %cp" +5.         ] 6. } ``` -- Modifier un `Frontend`{.action} existant : +- Modification d'un `Frontend`{.action} existant : > [!api] > @@ -240,7 +240,7 @@ Si vous utilisez l'API dans votre code, cela correspond à une liste json telle |frontendId|Identifiant du frontend où configurer les en-têtes HTTP| |httpHeader|Liste d'en-têtes à configurer| -- Appliquer les modifications : +- Application des modifications : > [!api] > diff --git a/pages/network/load_balancer/create_http_https/guide.en-asia.md b/pages/network/load_balancer/create_http_https/guide.en-asia.md index 8b7a5b59a68..37bcbfcdcec 100644 --- a/pages/network/load_balancer/create_http_https/guide.en-asia.md +++ b/pages/network/load_balancer/create_http_https/guide.en-asia.md @@ -1,81 +1,106 @@ --- -title: 'Configuring a HTTP/HTTPS OVH Load Balancer service' -excerpt: 'Find out how to configure an OVH Load Balancer service' -updated: 2023-11-22 +title: "Configuration of an OVHcloud Load Balancer service with HTTP/HTTPS" +excerpt: "Configure your OVHcloud Load Balancer to distribute HTTP traffic and secure your connections with HTTPS" +updated: 2025-11-12 --- -## Objective + -The purpose of this guide is to help you create your first HTTP/HTTPS service with the new OVHcloud Load Balancer solution. Here, we will set up a basic OVHcloud Load Balancer service configuration to balance the HTTP load for a service like a website. +## Objective -A front-end will be created to listen on port 80, while another listens on port 443 with an SSL/TLS certificate. These front-ends will be configured to direct their traffic to a common HTTP farm. This farm can have one or more servers, depending on the configuration you have chosen/adapted. +This guide aims to help you create your first HTTP/HTTPS service using the OVHcloud Load Balancer offer. We will configure a simple OVHcloud Load Balancer service to distribute HTTP traffic for a service, such as a website. -As a reminder, the OVHcloud Load Balancer has four primary components: +A frontend will be created to listen on port 80, while another will listen on port 443 with an SSL/TLS certificate. These frontends will be configured to direct their traffic to a common HTTP farm. This farm can have one or more servers, depending on the chosen / adapted configuration. -- `front-ends` -- server `farms` and their `servers` -- the advanced `routes` between the front-ends and server farms -- `SSL/TLS` connections that can encrypt TCP and/or HTTP connections +As a reminder, the OVHcloud Load Balancer service is composed of 4 elementary parts: -**This guide will show you how to configure an OVHcloud Load Balancer Service.** +- the `frontends`; +- the `farms` of servers and their `servers`; +- the advanced `routes` between Frontends and Server Farms; +- the `SSL/TLS` certificates allowing TCP and/or HTTP connections to be encrypted. ## Requirements -- an OVHcloud Load Balancer -- the ability to add and configure a farm, a server, a front-end and an SSL certificate +- Have an [OVHcloud Load balancer](/links/network/load-balancer) offer in your OVHcloud account +- You must be logged in to your [OVHcloud Control Panel](/links/manager) +- Have a configured farm +- Have a configured frontend +- Have an SSL certificate + +## Instructions -## Introduction +## Table of contents + +- [Add a server farm](#farm) +- [Add a server](#server) +- [Add a frontend](#frontend) +- [Add an SSL/TLS certificate](#certificate) +- [Apply the changes](#apply) +- [Validation](#validation) > [!warning] > -> This guide will take you through the steps required. Depending on the way you have designed your architecture, some configurations may vary. +> We will guide you through the different steps. Depending on your architecture choices, some configurations may differ. > -If you have not done so already, we recommend reading a general introduction to the OVHcloud Load Balancer service before you get started: [Introduction to the OVHcloud Load Balancer](/pages/network/load_balancer/use_presentation){.ref} +Before you start, it is recommended to consult the [OVHcloud Load Balancer presentation](/pages/network/load_balancer/use_presentation). > [!warning] > -> The order in which elements are created is important. In particular, the server farms must be configured before we can attach an SSL/TLS certificate or servers to them. The front-ends must be configured after the server farms in order to configure the front-end’s default farm. +> The order of element creation is important. In particular, server farms must be configured before being able to attach an SSL/TLS certificate or servers to them. Similarly, frontends must be configured after the server farms in order to be able to configure the frontend's default farm. > -In the control panel of the load balancer, you will see the features detailed below: +The features detailed below are accessible from the OVHcloud Control Panel: -![OVHcloud Load Balancer service](images/iplb_service.png){.thumbnail} +![OVHcloud Load Balancer Service](images/iplb_service.png){.thumbnail} -For more information on the Control Panel’s features, you can consult the following guide: [Managing the Load Balancer from the customer control panel](/pages/network/load_balancer/use-lb){.ref} +For more information about the features of the OVHcloud Control Panel, see the [Managing the Load Balancer service via the OVHcloud Control Panel](/pages/network/load_balancer/use-lb) page. -Similarly, this can be done via the OVHcloud API, in the section: +Via the OVHcloud API, use the following call: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing > -For more information on the API’s features, you can consult the following guide: [Load Balancer API Quick Reference](/pages/network/load_balancer/use_api_reference){.ref} - -## Add a server farm. +For more information on the API features, consult the page [API function details](/pages/network/load_balancer/use_api_details) -We will add a farm of HTTP servers to our service, which is the part that balances traffic on the servers. +### Add a server farm -### Via the OVHCloud Control Panel. +We will add an HTTP server farm to our service. This part is responsible for distributing traffic to the servers. -Log into the [OVHcloud Control Panel](/links/manager), click `Network`{.action} in the left-hand menu, then `Load Balancer`. Click on your load balancer service. +#### From the OVHcloud Control Panel -In the `Server farms`{.action} tab, click on the `Add a server farm`{.action} button. +In the `Server Farms`{.action} tab, click the `Add a server farm`{.action} button. -Fill in the fields. The only mandatory fields for a basic configuration are *Protocol* and *Datacentre*. We recommend explicitly defining a *Port* (generally port 80 for a web service). If no ports are specified, your OVHcloud Load Balancer will automatically use the same port as the corresponding front-end, and the probes will not be able to work as intended. +Fill in the fields. The only mandatory fields for a simple configuration are the *Protocol* and the *Datacentre*. It is recommended to explicitly define a *Port*, generally port 80 for a web service. If no port is specified, your OVHcloud Load Balancer will automatically use the same port as the corresponding frontend and the probes may not work as expected. -If you add several servers to your farm, we advise configuring an HTTP `availability probe`. When a probe is configured, the OVHcloud Load Balancer service can automatically disable a server that is down or under maintenance, so that your web users are not affected. +If you add several servers in your farm, it is recommended to configure an HTTP `availability probe`. When a probe is configured, the OVHcloud Load Balancer service can automatically disable a server that is down or under maintenance, in order not to affect visitors. -![Add a server farm via the Control Panel](images/add_backend.png){.thumbnail} +![Adding a server farm via the OVHcloud Control Panel](images/add_backend.png){.thumbnail} -Click `Add`{.action} once you have filled in the fields. +Click the `Add`{.action} button once you have filled in the fields. -Your server farm should appear in the list, in the `Server farms`{.action} tab. +Your server farm should appear in the list, under the `Server Farms`{.action} tab. -![Details of the server farm created](images/resume_backend.png){.thumbnail} +![Details of the created server farm](images/resume_backend.png){.thumbnail} -### Via the API +#### From the OVHcloud API - List of HTTP server farms: @@ -91,48 +116,46 @@ Your server farm should appear in the list, in the `Server farms`{.action} tab. > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId} > -- Add a new HTTP server farm: +- Adding a new HTTP server farm: > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm > -- Modify a specific server farm: +- Modifying a specific server farm: > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId} > -- Delete a specific server farm: +- Deleting a specific server farm: > [!api] > > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId} > -## Add a server. +### Add a server We will now add a server to our server farm. -### Via the OVHcloud Control Panel. - -Log into the [OVHcloud Control Panel](/links/manager), click `Network`{.action} in the left-hand menu, then `Load Balancer`. Click on your load balancer service. +#### From the OVHcloud Control Panel -In the `Server farms`{.action} tab, select the farm you want to add a server to by clicking on the corresponding line. The list of servers already configured in the farm will appear beneath the list of farms, along with the `Add a server`{.action} button. Click on this button to add a new server. +Still in the `Server Farms`{.action} tab, select the farm to which you want to add a server by clicking on the corresponding line. The list of servers already configured in the farm appears below the list of farms, as well as the `Add a server`{.action} button. Click on this button to add a new server. -Only the *IPv4 address* field is mandatory. If a server does not use the same port as the one defined earlier in the farm, you may overload it by configuring a server. However, to keep the configuration as standardised and easy to maintain as possible, we recommend only using this parameter in advanced cases. +Only the *IPv4 Address* field is mandatory. If a server does not use the same port as the one defined above in the farm, it is possible to override it in the server configuration. However, in order to maintain the most homogeneous and maintainable configuration possible, it is recommended to use this parameter only in advanced cases. -![Add a server to a farm.](images/add_server.png){.thumbnail} +![Adding a server to a Farm.](images/add_server.png){.thumbnail} -Click `Add`{.action} once you have filled in the fields. +Click the `Add`{.action} button once you have filled in the fields. -Your server should appear in the server list, in the `Server farm`{.action} tab, just below the list of farms. +Your server should appear in the list of servers, in the `Server Farms`{.action} tab, just below the list of farms. -![Details of the server created.](images/resume_server.png){.thumbnail} +![Details of the created server.](images/resume_server.png){.thumbnail} -### Via the API +#### From the OVHcloud API - List of servers in the farm: @@ -148,193 +171,198 @@ Your server should appear in the server list, in the `Server farm`{.action} tab, > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId} > -- Add a new server: +- Adding a new server: > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server > -- Modify a specific server: +- Modifying a specific server: > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server > -- Delete a specific server: +- Deleting a specific server: > [!api] > > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server > -## Add a front-end. +### Add a frontend -We will now add a `front-end` to our service, and connect it to our server farm. The front-end is the part of your OVHcloud Load Balancer that exposes your service on the internet. First, we will only configure it in HTTP, without an SSL/TLS certificate. +We will now add a `frontend` to our service and connect it to our server farm. The frontend is the part of your OVHcloud Load Balancer that is used to expose your service on the Internet. At first, we will configure it in HTTP only, without an SSL/TLS certificate. -### Via the OVHcloud Control Panel. +#### From the OVHcloud Control Panel -Go to the `Front-ends`{.action} tab, and click `Add a front-end`{.action}. +In the `Frontends`{.action} tab, click the `Add a frontend`{.action} button. -Fill in the fields. The only mandatory fields for a basic configuration are *Protocol*, *Port* (80 for a standard HTTP web service) and *Datacentre*. If you want your service to be available across several ports at once, you can specify a list of ports, separated by commas, or a range of ports, in the format "START_PORT-END_PORT". +Fill in the fields. The only mandatory fields for a simple configuration are the *Protocol*, the *Port* (80 for a standard HTTP web service) and the *Datacentre*. If you want your service to be available on several ports at the same time, you can specify a list of ports separated by commas or a range of ports in the form "START_PORT-END_PORT". -If you have routed Additional IPs to your OVHcloud Load Balancer service, you can also attach a front-end to one or more specific Additional IPs. +If you have routed Additional IPs to your OVHcloud Load Balancer service, you can also attach a frontend to one or more specific Additional IPs. -![Add a front-end](images/add_frontend.png){.thumbnail} +![Adding a frontend](images/add_frontend.png){.thumbnail} -Click `Add`{.action} once you have filled in the fields. +Click the `Add`{.action} button once you have filled in the fields. -Your front-end must appear in the list, in the `Front-ends`{.action} tab. +Your frontend should appear in the list, under the `Frontends`{.action} tab. -![Details of the front-end created](images/resume_frontend.png){.thumbnail} +![Details of the created frontend](images/resume_frontend.png){.thumbnail} -### Via the API +#### From the OVHcloud API -- List of HTTP front-ends: +- List of HTTP frontends: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend > -- Details of a specific front-end: +- Details of a specific frontend: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend/{frontendId} > -- Add a new front-end: +- Adding a new frontend: > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend > -- Modify a specific front-end: +- Modifying a specific frontend: > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId} > -- Delete a specific front-end: +- Deleting a specific frontend: > [!api] > > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/frontend/{frontendId} > -## Add an SSL/TLS certificate. +### Add an SSL/TLS certificate -The section above described the general configuration of a HTTP front-end. This next section describes the additional steps you need to take to activate support of HTTPS protocol on an HTTP front-end. In particular, you need to: +The previous section described the general configuration for an HTTP frontend. This section describes the additional steps to enable support for the HTTPS protocol on an HTTP frontend. In particular, you will need to: -- switch over the front-end to port 443, which is standard for HTTPS protocol -- configure an SSL/TLS certificate to authenticate and encrypt connections +- switch the frontend to port 443, the standard port for the HTTPS protocol; +- configure an SSL/TLS certificate to authenticate and encrypt the connections. -Whether you choose to configure your service via the API or the OVHcloud Control Panel, you can choose from two methods for adding an SSL/TLS certificate. The choice of method will depend on your needs, as well as the solutions currently set up. You can either: +Whether you choose a configuration via the API or via the OVHcloud Control Panel, you will have a choice between 2 strategies for your SSL/TLS certificates. This choice depends on your needs as well as the current solutions in place: - Import an existing SSL/TLS certificate. -- Order an automatically managed SSL/TLS certificate. DV and EV certificates will be available to order soon. +- Order an automatically managed SSL/TLS certificate. The ordering of DV and EV certificates will be available soon. -If you choose to import an SSL/TLS certificate that you have already ordered and managed yourself, you will need to renew it periodically yourself, and update it in your OVHcloud Load Balancer service. Most certificates are valid for one year. Some remain valid for longer periods of time. However, Let's Encrypt certificates need to be renewed every three months. We recommend using your OVHcloud Load Balancer to automatically manage the service for Let’s Encrypt certificates, so that you do not miss the expiry dates. +If you choose to import an SSL/TLS certificate that you have ordered and managed yourself, you will have to renew it periodically yourself and update it in your OVHcloud Load Balancer service. Most certificates are valid for 1 year. Some may be valid for longer. Let's Encrypt certificates are valid for 3 months. It is recommended to use the service managed automatically by your OVHcloud Load Balancer for Let's Encrypt certificates in order not to accidentally miss a deadline. -If you opt for a certificate managed by the OVHcloud Load Balancer service, it will be automatically ordered, validated, installed and renewed periodically by your OVHcloud Load Balancer. For the validation and renewal operations to work, the domains you are ordering this certificate for need to be routed to your OVHcloud Load Balancer service. This means that your domain’s *A* and *AAAA* DNS records must point to your OVHcloud Load Balancer’s IPv4 and IPv6 fields respectively, or to one of its Additional IPs. When you order, you will receive an email that will guide you through the validation steps. +If you choose a certificate managed by your OVHcloud Load Balancer service, it will be automatically ordered, validated, installed and renewed periodically by your OVHcloud Load Balancer.
+For the validation and renewal operations to work, the domain(s) you are ordering this certificate for must be routed to your OVHcloud Load Balancer service. This implies that the *A* and *AAAA* fields of your domain point respectively to the IPv4 and IPv6 of your OVHcloud Load Balancer or one of its Additional IPs. During the order, you will receive an email that will guide you through the validation steps. +> [!primary] > -> To ensure that your service remains accessible when you switch your domain to your OVHcloud Load Balancer service’s IP address in order to validate your certificate, it is good practice to start by configuring and testing all of the HTTP configuration on port 80. This way, your website will remain accessible without any interruptions. -> If the website already has a HTTPS connection and you want to switch to certificates managed by your OVHcloud Load Balancer service, you can import your existing certificates, configure and test your HTTPS front-end, and order a new certificate for the same domain. It will be taken into account automatically when your old certificate expires. +> To ensure service continuity when switching your domain to the IP of your OVHcloud Load Balancer service to validate your certificate, a good practice is to first configure and fully test the HTTP configuration on port 80. This way, your site remains accessible without interruption. +> If your site already has an HTTPS connection and you want to migrate to certificates managed by your OVHcloud Load Balancer service, you can import your existing certificates, configure and test your HTTPS Frontend and finally order a new certificate for the same domain. It will be automatically taken into account before your old certificate expires. > -The certificates configured on your OVHcloud Load Balancer service are automatically available for all of the front-ends on your service that have *SSL* options enabled. +The certificates configured on your OVHcloud Load Balancer service are automatically available for all frontends of your OVHcloud Load Balancer service on which the *SSL* option is enabled. #### TLS 1.3 support -With the constant evolution of Internet security standards, OVHcloud is committed to providing the latest and most secure technologies for your services. The OVHcloud Load Balancer now supports TLS 1.3. -##### What is TLS 1.3? -TLS 1.3 is the latest version of the TLS protocol, offering significant improvements in security and performance over TLS 1.2. Key benefits include a faster handshake process, reducing the time needed to establish secure connections, and the use of more secure cipher suites to strengthen the security of transmitted data. +With the constant evolution of security standards on the Internet, OVHcloud is committed to providing the most recent and secure technologies for your services. The OVHcloud Load Balancer now supports TLS 1.3. -##### Why use TLS 1.3 with OVHcloud Load Balancer? -By integrating TLS 1.3, your OVHcloud Load Balancer will benefit from enhanced security and improved performance, ensuring an optimal user experience for your visitors. Reduced handshake times speed up page loading, while security enhancements ensure that your data is protected with the latest, most secure standards. +##### **What is TLS 1.3?** -### Via the OVHcloud Control Panel. +TLS 1.3 is the latest version of the TLS protocol, offering significant improvements in terms of security and performance compared to TLS 1.2. The key advantages include a faster *handshake* process, thus reducing the time needed to establish secure connections, and the use of safer encryption suites to strengthen the security of transmitted data. -The list of SSL/TLS certificates configured on the OVHcloud Load Balancer can be found in the `SSL certificates`{.action} tab. In this interface, you can select one of the two options mentioned further up, i.e. importing an existing certificate (`Add an SSL certificate`{.action}) and (`Order an SSL certificate`{.action}) managed automatically by your OVHcloud Load Balancer. +##### **Why use TLS 1.3 with OVHcloud Load Balancer?** -![Buttons for adding certificates](images/certificat.png){.thumbnail} +By integrating TLS 1.3, your OVHcloud Load Balancer will benefit from enhanced security and improved performance, ensuring an optimal user experience for your visitors. The reduction in *handshake* time speeds up page loading, while the security improvements ensure that your data is protected with the most recent and secure standards. -If you choose to import an existing SSL/TLS certificate, click `Add an SSL certificate`{.action}. The *Private key* and *Certificate* fields are obligatory. +#### From the OVHcloud Control Panel -Click `Add`{.action} once you have filled in the fields. Your certificate will appear in the certificate list. +The list of SSL/TLS certificates configured on your OVHcloud Load Balancer service is in the `SSL Certificates`{.action} tab. This interface offers the 2 options mentioned above, namely importing an existing certificate (via the `Add an SSL certificate`{.action} button) and `Order an SSL certificate`{.action} managed automatically by your OVHcloud Load Balancer service. -![Add an existing SSL certificate](images/add_certificat_custom.png){.thumbnail} +![Certificate addition buttons](images/certificat.png){.thumbnail} -To add a Let's Encrypt certificate, click `Order an SSL certificate`{.action}, enter your domains, ensure that they point to your OVHcloud Load Balancer, and follow the instructions set out in the guides you receive. You will then see it appear in the list of available certificates. +If you choose to import an existing SSL/TLS certificate, click on `Add an SSL certificate`{.action}. The *Private Key* and *Certificate* fields are mandatory. -![Order a Let’s Encrypt certificate](images/add_certificat_letsencrypt.png){.thumbnail} +Click the `Add`{.action} button once the fields are filled in. Your certificate will then appear in the certificate list. -Once your certificates have been configured, you can create a HTTPS front-end, on the same model as the HTTP front-end created earlier on with port 443, and the *SSL* option enabled. You can also choose to enable the *HSTS* option. With this option enabled, web browsers will remember that this website should *no longer* be visited without HTTPS after the first time the web user visits in HTTPS. This way, you can improve your infrastructure’s overall security by protecting it against ‘man-in-the-middle’ attacks, where a malicious party can make it seem as though your website is not available in HTTPS, forcing your web users to switch to HTTP. +![Adding an existing certificate](images/add_certificat_custom.png){.thumbnail} + +To add a Let's Encrypt certificate, click on `Order an SSL certificate`{.action}, enter your domain, make sure it points to your OVHcloud Load Balancer service and follow the emails you receive. You will then see it appear in the list of available certificates. + +![Ordering a Let's Encrypt certificate](images/add_certificat_letsencrypt.png){.thumbnail} + +Once your certificate(s) are configured, you can create an HTTPS frontend, on the same model as the HTTP frontend created above with port 443 and the *SSL* option enabled.
+Optionally, you can also enable the *HSTS* option. If this option is enabled, browsers will record that this website should *never again* be visited without HTTPS after their first visit in HTTPS. This strengthens overall security by protecting against "Man-in-the-middle" attacks in which a malicious actor could make your website appear unavailable in HTTPS and force your visitors to switch to "HTTP". > [!warning] +> Although the added security is significant, it is recommended to wait a while before enabling this option, to make sure there are no side effects in HTTPS. Indeed, once HSTS is enabled, there is no going back. > -> All though adding this additional level of security is important, we recommend waiting for a while before you enable this option, to ensure that there are no issues with your website forming HTTPS connections. Once HSTS has been enabled, you cannot undo the change. -> -### Via the API +#### From the OVHcloud API -- To list the SSL/TLS certificates in place: +- List the existing SSL/TLS certificates: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl > -- To view details on an SSL/TLS certificate: +- Get the details of an SSL/TLS certificate: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl/{id} > -- To add a new, existing SSL/TLS certificate: +- Adding a new existing SSL/TLS certificate: > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/ssl > -- To modify a specific SSL/TLS certificate (only the display name can be modified): +- Modifying a specific SSL/TLS certificate (only the displayed name can be modified) : > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/ssl/{id} > -- To delete a specific SSL/TLS certificate: +- Deleting a specific SSL/TLS certificate: > [!api] > > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/ssl/{id} > -## Apply the modifications +### Apply the changes -The modifications made to your OVHcloud Load Balancer must be *explicitly applied* in each of the zones configured for your OVHcloud Load Balancer service. Only then will they be visible to your website visitors. This way, you can make complex configuration changes in one go. +The changes made to your OVHcloud Load Balancer service must be *explicitly applied* in each of the zones configured for your OVHcloud Load Balancer service. Only then will they be visible to your visitors. This allows a complex configuration change to be made in a single step. -If you have several zones, you must apply the same configuration for each of them. +If you have several zones, you will have to apply the same configuration for each of your zones. -### Via the OVHcloud Control Panel. +#### From the OVHcloud Control Panel -Go to the page for your OVHcloud Load Balancer, and click `Apply configuration`{.action}. +Go to the home page of your OVHcloud Load Balancer service, click on the `...`{.action} dots next to the name of your service and click on `Apply the configuration`{.action}. -![Apply configuration](images/btn_apply_configuration.png){.thumbnail} +![Apply the configuration](images/btn_apply_configuration.png){.thumbnail} -Next, select the zones you want to deploy, and click `Apply configuration`{.action}. +Then select the list of zones you want to deploy and click on the `Apply the configuration`{.action} button. -![Apply configuration to zones](images/btn_apply_configuration_zones.png){.thumbnail} +![Apply the configuration zones](images/btn_apply_configuration_zones.png){.thumbnail} -### Via the API +#### From the OVHcloud API - Refresh a zone: @@ -343,11 +371,10 @@ Next, select the zones you want to deploy, and click `Apply configuration`{.acti > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh > -## Confirmation +### Validation -Once you have completed all of these steps, you should have a functional load balancing service. You can check the service status by visiting your website. +Once all these steps are completed, you should have a functional load balancing service. You can validate the status of the service by visiting your site. ## Go further -Join our community of users on . - +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_http_https/guide.en-au.md b/pages/network/load_balancer/create_http_https/guide.en-au.md index 8b7a5b59a68..37bcbfcdcec 100644 --- a/pages/network/load_balancer/create_http_https/guide.en-au.md +++ b/pages/network/load_balancer/create_http_https/guide.en-au.md @@ -1,81 +1,106 @@ --- -title: 'Configuring a HTTP/HTTPS OVH Load Balancer service' -excerpt: 'Find out how to configure an OVH Load Balancer service' -updated: 2023-11-22 +title: "Configuration of an OVHcloud Load Balancer service with HTTP/HTTPS" +excerpt: "Configure your OVHcloud Load Balancer to distribute HTTP traffic and secure your connections with HTTPS" +updated: 2025-11-12 --- -## Objective + -The purpose of this guide is to help you create your first HTTP/HTTPS service with the new OVHcloud Load Balancer solution. Here, we will set up a basic OVHcloud Load Balancer service configuration to balance the HTTP load for a service like a website. +## Objective -A front-end will be created to listen on port 80, while another listens on port 443 with an SSL/TLS certificate. These front-ends will be configured to direct their traffic to a common HTTP farm. This farm can have one or more servers, depending on the configuration you have chosen/adapted. +This guide aims to help you create your first HTTP/HTTPS service using the OVHcloud Load Balancer offer. We will configure a simple OVHcloud Load Balancer service to distribute HTTP traffic for a service, such as a website. -As a reminder, the OVHcloud Load Balancer has four primary components: +A frontend will be created to listen on port 80, while another will listen on port 443 with an SSL/TLS certificate. These frontends will be configured to direct their traffic to a common HTTP farm. This farm can have one or more servers, depending on the chosen / adapted configuration. -- `front-ends` -- server `farms` and their `servers` -- the advanced `routes` between the front-ends and server farms -- `SSL/TLS` connections that can encrypt TCP and/or HTTP connections +As a reminder, the OVHcloud Load Balancer service is composed of 4 elementary parts: -**This guide will show you how to configure an OVHcloud Load Balancer Service.** +- the `frontends`; +- the `farms` of servers and their `servers`; +- the advanced `routes` between Frontends and Server Farms; +- the `SSL/TLS` certificates allowing TCP and/or HTTP connections to be encrypted. ## Requirements -- an OVHcloud Load Balancer -- the ability to add and configure a farm, a server, a front-end and an SSL certificate +- Have an [OVHcloud Load balancer](/links/network/load-balancer) offer in your OVHcloud account +- You must be logged in to your [OVHcloud Control Panel](/links/manager) +- Have a configured farm +- Have a configured frontend +- Have an SSL certificate + +## Instructions -## Introduction +## Table of contents + +- [Add a server farm](#farm) +- [Add a server](#server) +- [Add a frontend](#frontend) +- [Add an SSL/TLS certificate](#certificate) +- [Apply the changes](#apply) +- [Validation](#validation) > [!warning] > -> This guide will take you through the steps required. Depending on the way you have designed your architecture, some configurations may vary. +> We will guide you through the different steps. Depending on your architecture choices, some configurations may differ. > -If you have not done so already, we recommend reading a general introduction to the OVHcloud Load Balancer service before you get started: [Introduction to the OVHcloud Load Balancer](/pages/network/load_balancer/use_presentation){.ref} +Before you start, it is recommended to consult the [OVHcloud Load Balancer presentation](/pages/network/load_balancer/use_presentation). > [!warning] > -> The order in which elements are created is important. In particular, the server farms must be configured before we can attach an SSL/TLS certificate or servers to them. The front-ends must be configured after the server farms in order to configure the front-end’s default farm. +> The order of element creation is important. In particular, server farms must be configured before being able to attach an SSL/TLS certificate or servers to them. Similarly, frontends must be configured after the server farms in order to be able to configure the frontend's default farm. > -In the control panel of the load balancer, you will see the features detailed below: +The features detailed below are accessible from the OVHcloud Control Panel: -![OVHcloud Load Balancer service](images/iplb_service.png){.thumbnail} +![OVHcloud Load Balancer Service](images/iplb_service.png){.thumbnail} -For more information on the Control Panel’s features, you can consult the following guide: [Managing the Load Balancer from the customer control panel](/pages/network/load_balancer/use-lb){.ref} +For more information about the features of the OVHcloud Control Panel, see the [Managing the Load Balancer service via the OVHcloud Control Panel](/pages/network/load_balancer/use-lb) page. -Similarly, this can be done via the OVHcloud API, in the section: +Via the OVHcloud API, use the following call: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing > -For more information on the API’s features, you can consult the following guide: [Load Balancer API Quick Reference](/pages/network/load_balancer/use_api_reference){.ref} - -## Add a server farm. +For more information on the API features, consult the page [API function details](/pages/network/load_balancer/use_api_details) -We will add a farm of HTTP servers to our service, which is the part that balances traffic on the servers. +### Add a server farm -### Via the OVHCloud Control Panel. +We will add an HTTP server farm to our service. This part is responsible for distributing traffic to the servers. -Log into the [OVHcloud Control Panel](/links/manager), click `Network`{.action} in the left-hand menu, then `Load Balancer`. Click on your load balancer service. +#### From the OVHcloud Control Panel -In the `Server farms`{.action} tab, click on the `Add a server farm`{.action} button. +In the `Server Farms`{.action} tab, click the `Add a server farm`{.action} button. -Fill in the fields. The only mandatory fields for a basic configuration are *Protocol* and *Datacentre*. We recommend explicitly defining a *Port* (generally port 80 for a web service). If no ports are specified, your OVHcloud Load Balancer will automatically use the same port as the corresponding front-end, and the probes will not be able to work as intended. +Fill in the fields. The only mandatory fields for a simple configuration are the *Protocol* and the *Datacentre*. It is recommended to explicitly define a *Port*, generally port 80 for a web service. If no port is specified, your OVHcloud Load Balancer will automatically use the same port as the corresponding frontend and the probes may not work as expected. -If you add several servers to your farm, we advise configuring an HTTP `availability probe`. When a probe is configured, the OVHcloud Load Balancer service can automatically disable a server that is down or under maintenance, so that your web users are not affected. +If you add several servers in your farm, it is recommended to configure an HTTP `availability probe`. When a probe is configured, the OVHcloud Load Balancer service can automatically disable a server that is down or under maintenance, in order not to affect visitors. -![Add a server farm via the Control Panel](images/add_backend.png){.thumbnail} +![Adding a server farm via the OVHcloud Control Panel](images/add_backend.png){.thumbnail} -Click `Add`{.action} once you have filled in the fields. +Click the `Add`{.action} button once you have filled in the fields. -Your server farm should appear in the list, in the `Server farms`{.action} tab. +Your server farm should appear in the list, under the `Server Farms`{.action} tab. -![Details of the server farm created](images/resume_backend.png){.thumbnail} +![Details of the created server farm](images/resume_backend.png){.thumbnail} -### Via the API +#### From the OVHcloud API - List of HTTP server farms: @@ -91,48 +116,46 @@ Your server farm should appear in the list, in the `Server farms`{.action} tab. > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId} > -- Add a new HTTP server farm: +- Adding a new HTTP server farm: > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm > -- Modify a specific server farm: +- Modifying a specific server farm: > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId} > -- Delete a specific server farm: +- Deleting a specific server farm: > [!api] > > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId} > -## Add a server. +### Add a server We will now add a server to our server farm. -### Via the OVHcloud Control Panel. - -Log into the [OVHcloud Control Panel](/links/manager), click `Network`{.action} in the left-hand menu, then `Load Balancer`. Click on your load balancer service. +#### From the OVHcloud Control Panel -In the `Server farms`{.action} tab, select the farm you want to add a server to by clicking on the corresponding line. The list of servers already configured in the farm will appear beneath the list of farms, along with the `Add a server`{.action} button. Click on this button to add a new server. +Still in the `Server Farms`{.action} tab, select the farm to which you want to add a server by clicking on the corresponding line. The list of servers already configured in the farm appears below the list of farms, as well as the `Add a server`{.action} button. Click on this button to add a new server. -Only the *IPv4 address* field is mandatory. If a server does not use the same port as the one defined earlier in the farm, you may overload it by configuring a server. However, to keep the configuration as standardised and easy to maintain as possible, we recommend only using this parameter in advanced cases. +Only the *IPv4 Address* field is mandatory. If a server does not use the same port as the one defined above in the farm, it is possible to override it in the server configuration. However, in order to maintain the most homogeneous and maintainable configuration possible, it is recommended to use this parameter only in advanced cases. -![Add a server to a farm.](images/add_server.png){.thumbnail} +![Adding a server to a Farm.](images/add_server.png){.thumbnail} -Click `Add`{.action} once you have filled in the fields. +Click the `Add`{.action} button once you have filled in the fields. -Your server should appear in the server list, in the `Server farm`{.action} tab, just below the list of farms. +Your server should appear in the list of servers, in the `Server Farms`{.action} tab, just below the list of farms. -![Details of the server created.](images/resume_server.png){.thumbnail} +![Details of the created server.](images/resume_server.png){.thumbnail} -### Via the API +#### From the OVHcloud API - List of servers in the farm: @@ -148,193 +171,198 @@ Your server should appear in the server list, in the `Server farm`{.action} tab, > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId} > -- Add a new server: +- Adding a new server: > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server > -- Modify a specific server: +- Modifying a specific server: > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server > -- Delete a specific server: +- Deleting a specific server: > [!api] > > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server > -## Add a front-end. +### Add a frontend -We will now add a `front-end` to our service, and connect it to our server farm. The front-end is the part of your OVHcloud Load Balancer that exposes your service on the internet. First, we will only configure it in HTTP, without an SSL/TLS certificate. +We will now add a `frontend` to our service and connect it to our server farm. The frontend is the part of your OVHcloud Load Balancer that is used to expose your service on the Internet. At first, we will configure it in HTTP only, without an SSL/TLS certificate. -### Via the OVHcloud Control Panel. +#### From the OVHcloud Control Panel -Go to the `Front-ends`{.action} tab, and click `Add a front-end`{.action}. +In the `Frontends`{.action} tab, click the `Add a frontend`{.action} button. -Fill in the fields. The only mandatory fields for a basic configuration are *Protocol*, *Port* (80 for a standard HTTP web service) and *Datacentre*. If you want your service to be available across several ports at once, you can specify a list of ports, separated by commas, or a range of ports, in the format "START_PORT-END_PORT". +Fill in the fields. The only mandatory fields for a simple configuration are the *Protocol*, the *Port* (80 for a standard HTTP web service) and the *Datacentre*. If you want your service to be available on several ports at the same time, you can specify a list of ports separated by commas or a range of ports in the form "START_PORT-END_PORT". -If you have routed Additional IPs to your OVHcloud Load Balancer service, you can also attach a front-end to one or more specific Additional IPs. +If you have routed Additional IPs to your OVHcloud Load Balancer service, you can also attach a frontend to one or more specific Additional IPs. -![Add a front-end](images/add_frontend.png){.thumbnail} +![Adding a frontend](images/add_frontend.png){.thumbnail} -Click `Add`{.action} once you have filled in the fields. +Click the `Add`{.action} button once you have filled in the fields. -Your front-end must appear in the list, in the `Front-ends`{.action} tab. +Your frontend should appear in the list, under the `Frontends`{.action} tab. -![Details of the front-end created](images/resume_frontend.png){.thumbnail} +![Details of the created frontend](images/resume_frontend.png){.thumbnail} -### Via the API +#### From the OVHcloud API -- List of HTTP front-ends: +- List of HTTP frontends: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend > -- Details of a specific front-end: +- Details of a specific frontend: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend/{frontendId} > -- Add a new front-end: +- Adding a new frontend: > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend > -- Modify a specific front-end: +- Modifying a specific frontend: > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId} > -- Delete a specific front-end: +- Deleting a specific frontend: > [!api] > > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/frontend/{frontendId} > -## Add an SSL/TLS certificate. +### Add an SSL/TLS certificate -The section above described the general configuration of a HTTP front-end. This next section describes the additional steps you need to take to activate support of HTTPS protocol on an HTTP front-end. In particular, you need to: +The previous section described the general configuration for an HTTP frontend. This section describes the additional steps to enable support for the HTTPS protocol on an HTTP frontend. In particular, you will need to: -- switch over the front-end to port 443, which is standard for HTTPS protocol -- configure an SSL/TLS certificate to authenticate and encrypt connections +- switch the frontend to port 443, the standard port for the HTTPS protocol; +- configure an SSL/TLS certificate to authenticate and encrypt the connections. -Whether you choose to configure your service via the API or the OVHcloud Control Panel, you can choose from two methods for adding an SSL/TLS certificate. The choice of method will depend on your needs, as well as the solutions currently set up. You can either: +Whether you choose a configuration via the API or via the OVHcloud Control Panel, you will have a choice between 2 strategies for your SSL/TLS certificates. This choice depends on your needs as well as the current solutions in place: - Import an existing SSL/TLS certificate. -- Order an automatically managed SSL/TLS certificate. DV and EV certificates will be available to order soon. +- Order an automatically managed SSL/TLS certificate. The ordering of DV and EV certificates will be available soon. -If you choose to import an SSL/TLS certificate that you have already ordered and managed yourself, you will need to renew it periodically yourself, and update it in your OVHcloud Load Balancer service. Most certificates are valid for one year. Some remain valid for longer periods of time. However, Let's Encrypt certificates need to be renewed every three months. We recommend using your OVHcloud Load Balancer to automatically manage the service for Let’s Encrypt certificates, so that you do not miss the expiry dates. +If you choose to import an SSL/TLS certificate that you have ordered and managed yourself, you will have to renew it periodically yourself and update it in your OVHcloud Load Balancer service. Most certificates are valid for 1 year. Some may be valid for longer. Let's Encrypt certificates are valid for 3 months. It is recommended to use the service managed automatically by your OVHcloud Load Balancer for Let's Encrypt certificates in order not to accidentally miss a deadline. -If you opt for a certificate managed by the OVHcloud Load Balancer service, it will be automatically ordered, validated, installed and renewed periodically by your OVHcloud Load Balancer. For the validation and renewal operations to work, the domains you are ordering this certificate for need to be routed to your OVHcloud Load Balancer service. This means that your domain’s *A* and *AAAA* DNS records must point to your OVHcloud Load Balancer’s IPv4 and IPv6 fields respectively, or to one of its Additional IPs. When you order, you will receive an email that will guide you through the validation steps. +If you choose a certificate managed by your OVHcloud Load Balancer service, it will be automatically ordered, validated, installed and renewed periodically by your OVHcloud Load Balancer.
+For the validation and renewal operations to work, the domain(s) you are ordering this certificate for must be routed to your OVHcloud Load Balancer service. This implies that the *A* and *AAAA* fields of your domain point respectively to the IPv4 and IPv6 of your OVHcloud Load Balancer or one of its Additional IPs. During the order, you will receive an email that will guide you through the validation steps. +> [!primary] > -> To ensure that your service remains accessible when you switch your domain to your OVHcloud Load Balancer service’s IP address in order to validate your certificate, it is good practice to start by configuring and testing all of the HTTP configuration on port 80. This way, your website will remain accessible without any interruptions. -> If the website already has a HTTPS connection and you want to switch to certificates managed by your OVHcloud Load Balancer service, you can import your existing certificates, configure and test your HTTPS front-end, and order a new certificate for the same domain. It will be taken into account automatically when your old certificate expires. +> To ensure service continuity when switching your domain to the IP of your OVHcloud Load Balancer service to validate your certificate, a good practice is to first configure and fully test the HTTP configuration on port 80. This way, your site remains accessible without interruption. +> If your site already has an HTTPS connection and you want to migrate to certificates managed by your OVHcloud Load Balancer service, you can import your existing certificates, configure and test your HTTPS Frontend and finally order a new certificate for the same domain. It will be automatically taken into account before your old certificate expires. > -The certificates configured on your OVHcloud Load Balancer service are automatically available for all of the front-ends on your service that have *SSL* options enabled. +The certificates configured on your OVHcloud Load Balancer service are automatically available for all frontends of your OVHcloud Load Balancer service on which the *SSL* option is enabled. #### TLS 1.3 support -With the constant evolution of Internet security standards, OVHcloud is committed to providing the latest and most secure technologies for your services. The OVHcloud Load Balancer now supports TLS 1.3. -##### What is TLS 1.3? -TLS 1.3 is the latest version of the TLS protocol, offering significant improvements in security and performance over TLS 1.2. Key benefits include a faster handshake process, reducing the time needed to establish secure connections, and the use of more secure cipher suites to strengthen the security of transmitted data. +With the constant evolution of security standards on the Internet, OVHcloud is committed to providing the most recent and secure technologies for your services. The OVHcloud Load Balancer now supports TLS 1.3. -##### Why use TLS 1.3 with OVHcloud Load Balancer? -By integrating TLS 1.3, your OVHcloud Load Balancer will benefit from enhanced security and improved performance, ensuring an optimal user experience for your visitors. Reduced handshake times speed up page loading, while security enhancements ensure that your data is protected with the latest, most secure standards. +##### **What is TLS 1.3?** -### Via the OVHcloud Control Panel. +TLS 1.3 is the latest version of the TLS protocol, offering significant improvements in terms of security and performance compared to TLS 1.2. The key advantages include a faster *handshake* process, thus reducing the time needed to establish secure connections, and the use of safer encryption suites to strengthen the security of transmitted data. -The list of SSL/TLS certificates configured on the OVHcloud Load Balancer can be found in the `SSL certificates`{.action} tab. In this interface, you can select one of the two options mentioned further up, i.e. importing an existing certificate (`Add an SSL certificate`{.action}) and (`Order an SSL certificate`{.action}) managed automatically by your OVHcloud Load Balancer. +##### **Why use TLS 1.3 with OVHcloud Load Balancer?** -![Buttons for adding certificates](images/certificat.png){.thumbnail} +By integrating TLS 1.3, your OVHcloud Load Balancer will benefit from enhanced security and improved performance, ensuring an optimal user experience for your visitors. The reduction in *handshake* time speeds up page loading, while the security improvements ensure that your data is protected with the most recent and secure standards. -If you choose to import an existing SSL/TLS certificate, click `Add an SSL certificate`{.action}. The *Private key* and *Certificate* fields are obligatory. +#### From the OVHcloud Control Panel -Click `Add`{.action} once you have filled in the fields. Your certificate will appear in the certificate list. +The list of SSL/TLS certificates configured on your OVHcloud Load Balancer service is in the `SSL Certificates`{.action} tab. This interface offers the 2 options mentioned above, namely importing an existing certificate (via the `Add an SSL certificate`{.action} button) and `Order an SSL certificate`{.action} managed automatically by your OVHcloud Load Balancer service. -![Add an existing SSL certificate](images/add_certificat_custom.png){.thumbnail} +![Certificate addition buttons](images/certificat.png){.thumbnail} -To add a Let's Encrypt certificate, click `Order an SSL certificate`{.action}, enter your domains, ensure that they point to your OVHcloud Load Balancer, and follow the instructions set out in the guides you receive. You will then see it appear in the list of available certificates. +If you choose to import an existing SSL/TLS certificate, click on `Add an SSL certificate`{.action}. The *Private Key* and *Certificate* fields are mandatory. -![Order a Let’s Encrypt certificate](images/add_certificat_letsencrypt.png){.thumbnail} +Click the `Add`{.action} button once the fields are filled in. Your certificate will then appear in the certificate list. -Once your certificates have been configured, you can create a HTTPS front-end, on the same model as the HTTP front-end created earlier on with port 443, and the *SSL* option enabled. You can also choose to enable the *HSTS* option. With this option enabled, web browsers will remember that this website should *no longer* be visited without HTTPS after the first time the web user visits in HTTPS. This way, you can improve your infrastructure’s overall security by protecting it against ‘man-in-the-middle’ attacks, where a malicious party can make it seem as though your website is not available in HTTPS, forcing your web users to switch to HTTP. +![Adding an existing certificate](images/add_certificat_custom.png){.thumbnail} + +To add a Let's Encrypt certificate, click on `Order an SSL certificate`{.action}, enter your domain, make sure it points to your OVHcloud Load Balancer service and follow the emails you receive. You will then see it appear in the list of available certificates. + +![Ordering a Let's Encrypt certificate](images/add_certificat_letsencrypt.png){.thumbnail} + +Once your certificate(s) are configured, you can create an HTTPS frontend, on the same model as the HTTP frontend created above with port 443 and the *SSL* option enabled.
+Optionally, you can also enable the *HSTS* option. If this option is enabled, browsers will record that this website should *never again* be visited without HTTPS after their first visit in HTTPS. This strengthens overall security by protecting against "Man-in-the-middle" attacks in which a malicious actor could make your website appear unavailable in HTTPS and force your visitors to switch to "HTTP". > [!warning] +> Although the added security is significant, it is recommended to wait a while before enabling this option, to make sure there are no side effects in HTTPS. Indeed, once HSTS is enabled, there is no going back. > -> All though adding this additional level of security is important, we recommend waiting for a while before you enable this option, to ensure that there are no issues with your website forming HTTPS connections. Once HSTS has been enabled, you cannot undo the change. -> -### Via the API +#### From the OVHcloud API -- To list the SSL/TLS certificates in place: +- List the existing SSL/TLS certificates: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl > -- To view details on an SSL/TLS certificate: +- Get the details of an SSL/TLS certificate: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl/{id} > -- To add a new, existing SSL/TLS certificate: +- Adding a new existing SSL/TLS certificate: > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/ssl > -- To modify a specific SSL/TLS certificate (only the display name can be modified): +- Modifying a specific SSL/TLS certificate (only the displayed name can be modified) : > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/ssl/{id} > -- To delete a specific SSL/TLS certificate: +- Deleting a specific SSL/TLS certificate: > [!api] > > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/ssl/{id} > -## Apply the modifications +### Apply the changes -The modifications made to your OVHcloud Load Balancer must be *explicitly applied* in each of the zones configured for your OVHcloud Load Balancer service. Only then will they be visible to your website visitors. This way, you can make complex configuration changes in one go. +The changes made to your OVHcloud Load Balancer service must be *explicitly applied* in each of the zones configured for your OVHcloud Load Balancer service. Only then will they be visible to your visitors. This allows a complex configuration change to be made in a single step. -If you have several zones, you must apply the same configuration for each of them. +If you have several zones, you will have to apply the same configuration for each of your zones. -### Via the OVHcloud Control Panel. +#### From the OVHcloud Control Panel -Go to the page for your OVHcloud Load Balancer, and click `Apply configuration`{.action}. +Go to the home page of your OVHcloud Load Balancer service, click on the `...`{.action} dots next to the name of your service and click on `Apply the configuration`{.action}. -![Apply configuration](images/btn_apply_configuration.png){.thumbnail} +![Apply the configuration](images/btn_apply_configuration.png){.thumbnail} -Next, select the zones you want to deploy, and click `Apply configuration`{.action}. +Then select the list of zones you want to deploy and click on the `Apply the configuration`{.action} button. -![Apply configuration to zones](images/btn_apply_configuration_zones.png){.thumbnail} +![Apply the configuration zones](images/btn_apply_configuration_zones.png){.thumbnail} -### Via the API +#### From the OVHcloud API - Refresh a zone: @@ -343,11 +371,10 @@ Next, select the zones you want to deploy, and click `Apply configuration`{.acti > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh > -## Confirmation +### Validation -Once you have completed all of these steps, you should have a functional load balancing service. You can check the service status by visiting your website. +Once all these steps are completed, you should have a functional load balancing service. You can validate the status of the service by visiting your site. ## Go further -Join our community of users on . - +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_http_https/guide.en-ca.md b/pages/network/load_balancer/create_http_https/guide.en-ca.md index 8fb7329b659..37bcbfcdcec 100644 --- a/pages/network/load_balancer/create_http_https/guide.en-ca.md +++ b/pages/network/load_balancer/create_http_https/guide.en-ca.md @@ -1,81 +1,106 @@ --- -title: 'Configuring a HTTP/HTTPS OVH Load Balancer service' -excerpt: 'Find out how to configure an OVH Load Balancer service' -updated: 2023-11-22 +title: "Configuration of an OVHcloud Load Balancer service with HTTP/HTTPS" +excerpt: "Configure your OVHcloud Load Balancer to distribute HTTP traffic and secure your connections with HTTPS" +updated: 2025-11-12 --- -## Objective + -The purpose of this guide is to help you create your first HTTP/HTTPS service with the new OVHcloud Load Balancer solution. Here, we will set up a basic OVHcloud Load Balancer service configuration to balance the HTTP load for a service like a website. +## Objective -A front-end will be created to listen on port 80, while another listens on port 443 with an SSL/TLS certificate. These front-ends will be configured to direct their traffic to a common HTTP farm. This farm can have one or more servers, depending on the configuration you have chosen/adapted. +This guide aims to help you create your first HTTP/HTTPS service using the OVHcloud Load Balancer offer. We will configure a simple OVHcloud Load Balancer service to distribute HTTP traffic for a service, such as a website. -As a reminder, the OVHcloud Load Balancer has four primary components: +A frontend will be created to listen on port 80, while another will listen on port 443 with an SSL/TLS certificate. These frontends will be configured to direct their traffic to a common HTTP farm. This farm can have one or more servers, depending on the chosen / adapted configuration. -- `front-ends` -- server `farms` and their `servers` -- the advanced `routes` between the front-ends and server farms -- `SSL/TLS` connections that can encrypt TCP and/or HTTP connections +As a reminder, the OVHcloud Load Balancer service is composed of 4 elementary parts: -**This guide will show you how to configure an OVHcloud Load Balancer Service.** +- the `frontends`; +- the `farms` of servers and their `servers`; +- the advanced `routes` between Frontends and Server Farms; +- the `SSL/TLS` certificates allowing TCP and/or HTTP connections to be encrypted. ## Requirements -- an OVHcloud Load Balancer -- the ability to add and configure a farm, a server, a front-end and an SSL certificate +- Have an [OVHcloud Load balancer](/links/network/load-balancer) offer in your OVHcloud account +- You must be logged in to your [OVHcloud Control Panel](/links/manager) +- Have a configured farm +- Have a configured frontend +- Have an SSL certificate + +## Instructions -## Introduction +## Table of contents + +- [Add a server farm](#farm) +- [Add a server](#server) +- [Add a frontend](#frontend) +- [Add an SSL/TLS certificate](#certificate) +- [Apply the changes](#apply) +- [Validation](#validation) > [!warning] > -> This guide will take you through the steps required. Depending on the way you have designed your architecture, some configurations may vary. +> We will guide you through the different steps. Depending on your architecture choices, some configurations may differ. > -If you have not done so already, we recommend reading a general introduction to the OVHcloud Load Balancer service before you get started: [Introduction to the OVHcloud Load Balancer](/pages/network/load_balancer/use_presentation){.ref} +Before you start, it is recommended to consult the [OVHcloud Load Balancer presentation](/pages/network/load_balancer/use_presentation). > [!warning] > -> The order in which elements are created is important. In particular, the server farms must be configured before we can attach an SSL/TLS certificate or servers to them. The front-ends must be configured after the server farms in order to configure the front-end’s default farm. +> The order of element creation is important. In particular, server farms must be configured before being able to attach an SSL/TLS certificate or servers to them. Similarly, frontends must be configured after the server farms in order to be able to configure the frontend's default farm. > -In the control panel of the load balancer, you will see the features detailed below: +The features detailed below are accessible from the OVHcloud Control Panel: -![OVHcloud Load Balancer service](images/iplb_service.png){.thumbnail} +![OVHcloud Load Balancer Service](images/iplb_service.png){.thumbnail} -For more information on the Control Panel’s features, you can consult the following guide: [Managing the Load Balancer from the customer control panel](/pages/network/load_balancer/use-lb){.ref} +For more information about the features of the OVHcloud Control Panel, see the [Managing the Load Balancer service via the OVHcloud Control Panel](/pages/network/load_balancer/use-lb) page. -Similarly, this can be done via the OVHcloud API, in the section: +Via the OVHcloud API, use the following call: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing > -For more information on the API’s features, you can consult the following guide: [Load Balancer API Quick Reference](/pages/network/load_balancer/use_api_reference){.ref} - -## Add a server farm. +For more information on the API features, consult the page [API function details](/pages/network/load_balancer/use_api_details) -We will add a farm of HTTP servers to our service, which is the part that balances traffic on the servers. +### Add a server farm -### Via the OVHCloud Control Panel. +We will add an HTTP server farm to our service. This part is responsible for distributing traffic to the servers. -Log into the [OVHcloud Control Panel](/links/manager), click `Network`{.action} in the left-hand menu, then `Load Balancer`. Click on your load balancer service. +#### From the OVHcloud Control Panel -In the `Server farms`{.action} tab, click on the `Add a server farm`{.action} button. +In the `Server Farms`{.action} tab, click the `Add a server farm`{.action} button. -Fill in the fields. The only mandatory fields for a basic configuration are *Protocol* and *Datacentre*. We recommend explicitly defining a *Port* (generally port 80 for a web service). If no ports are specified, your OVHcloud Load Balancer will automatically use the same port as the corresponding front-end, and the probes will not be able to work as intended. +Fill in the fields. The only mandatory fields for a simple configuration are the *Protocol* and the *Datacentre*. It is recommended to explicitly define a *Port*, generally port 80 for a web service. If no port is specified, your OVHcloud Load Balancer will automatically use the same port as the corresponding frontend and the probes may not work as expected. -If you add several servers to your farm, we advise configuring an HTTP `availability probe`. When a probe is configured, the OVHcloud Load Balancer service can automatically disable a server that is down or under maintenance, so that your web users are not affected. +If you add several servers in your farm, it is recommended to configure an HTTP `availability probe`. When a probe is configured, the OVHcloud Load Balancer service can automatically disable a server that is down or under maintenance, in order not to affect visitors. -![Add a server farm via the Control Panel](images/add_backend.png){.thumbnail} +![Adding a server farm via the OVHcloud Control Panel](images/add_backend.png){.thumbnail} -Click `Add`{.action} once you have filled in the fields. +Click the `Add`{.action} button once you have filled in the fields. -Your server farm should appear in the list, in the `Server farms`{.action} tab. +Your server farm should appear in the list, under the `Server Farms`{.action} tab. -![Details of the server farm created](images/resume_backend.png){.thumbnail} +![Details of the created server farm](images/resume_backend.png){.thumbnail} -### Via the API +#### From the OVHcloud API - List of HTTP server farms: @@ -91,48 +116,46 @@ Your server farm should appear in the list, in the `Server farms`{.action} tab. > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId} > -- Add a new HTTP server farm: +- Adding a new HTTP server farm: > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm > -- Modify a specific server farm: +- Modifying a specific server farm: > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId} > -- Delete a specific server farm: +- Deleting a specific server farm: > [!api] > > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId} > -## Add a server. +### Add a server We will now add a server to our server farm. -### Via the OVHcloud Control Panel. +#### From the OVHcloud Control Panel -Log into the [OVHcloud Control Panel](/links/manager), click `Network`{.action} in the left-hand menu, then `Load Balancer`. Click on your load balancer service. +Still in the `Server Farms`{.action} tab, select the farm to which you want to add a server by clicking on the corresponding line. The list of servers already configured in the farm appears below the list of farms, as well as the `Add a server`{.action} button. Click on this button to add a new server. -In the `Server farms`{.action} tab, select the farm you want to add a server to by clicking on the corresponding line. The list of servers already configured in the farm will appear beneath the list of farms, along with the `Add a server`{.action} button. Click on this button to add a new server. +Only the *IPv4 Address* field is mandatory. If a server does not use the same port as the one defined above in the farm, it is possible to override it in the server configuration. However, in order to maintain the most homogeneous and maintainable configuration possible, it is recommended to use this parameter only in advanced cases. -Only the *IPv4 address* field is mandatory. If a server does not use the same port as the one defined earlier in the farm, you may overload it by configuring a server. However, to keep the configuration as standardised and easy to maintain as possible, we recommend only using this parameter in advanced cases. +![Adding a server to a Farm.](images/add_server.png){.thumbnail} -![Add a server to a farm.](images/add_server.png){.thumbnail} +Click the `Add`{.action} button once you have filled in the fields. -Click `Add`{.action} once you have filled in the fields. +Your server should appear in the list of servers, in the `Server Farms`{.action} tab, just below the list of farms. -Your server should appear in the server list, in the `Server farm`{.action} tab, just below the list of farms. +![Details of the created server.](images/resume_server.png){.thumbnail} -![Details of the server created.](images/resume_server.png){.thumbnail} - -### Via the API +#### From the OVHcloud API - List of servers in the farm: @@ -148,193 +171,198 @@ Your server should appear in the server list, in the `Server farm`{.action} tab, > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId} > -- Add a new server: +- Adding a new server: > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server > -- Modify a specific server: +- Modifying a specific server: > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server > -- Delete a specific server: +- Deleting a specific server: > [!api] > > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server > -## Add a front-end. +### Add a frontend -We will now add a `front-end` to our service, and connect it to our server farm. The front-end is the part of your OVHcloud Load Balancer that exposes your service on the internet. First, we will only configure it in HTTP, without an SSL/TLS certificate. +We will now add a `frontend` to our service and connect it to our server farm. The frontend is the part of your OVHcloud Load Balancer that is used to expose your service on the Internet. At first, we will configure it in HTTP only, without an SSL/TLS certificate. -### Via the OVHcloud Control Panel. +#### From the OVHcloud Control Panel -Go to the `Front-ends`{.action} tab, and click `Add a front-end`{.action}. +In the `Frontends`{.action} tab, click the `Add a frontend`{.action} button. -Fill in the fields. The only mandatory fields for a basic configuration are *Protocol*, *Port* (80 for a standard HTTP web service) and *Datacentre*. If you want your service to be available across several ports at once, you can specify a list of ports, separated by commas, or a range of ports, in the format "START_PORT-END_PORT". +Fill in the fields. The only mandatory fields for a simple configuration are the *Protocol*, the *Port* (80 for a standard HTTP web service) and the *Datacentre*. If you want your service to be available on several ports at the same time, you can specify a list of ports separated by commas or a range of ports in the form "START_PORT-END_PORT". -If you have routed Additional IPs to your OVHcloud Load Balancer service, you can also attach a front-end to one or more specific Additional IPs. +If you have routed Additional IPs to your OVHcloud Load Balancer service, you can also attach a frontend to one or more specific Additional IPs. -![Add a front-end](images/add_frontend.png){.thumbnail} +![Adding a frontend](images/add_frontend.png){.thumbnail} -Click `Add`{.action} once you have filled in the fields. +Click the `Add`{.action} button once you have filled in the fields. -Your front-end must appear in the list, in the `Front-ends`{.action} tab. +Your frontend should appear in the list, under the `Frontends`{.action} tab. -![Details of the front-end created](images/resume_frontend.png){.thumbnail} +![Details of the created frontend](images/resume_frontend.png){.thumbnail} -### Via the API +#### From the OVHcloud API -- List of HTTP front-ends: +- List of HTTP frontends: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend > -- Details of a specific front-end: +- Details of a specific frontend: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend/{frontendId} > -- Add a new front-end: +- Adding a new frontend: > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend > -- Modify a specific front-end: +- Modifying a specific frontend: > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId} > -- Delete a specific front-end: +- Deleting a specific frontend: > [!api] > > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/frontend/{frontendId} > -## Add an SSL/TLS certificate. +### Add an SSL/TLS certificate -The section above described the general configuration of a HTTP front-end. This next section describes the additional steps you need to take to activate support of HTTPS protocol on an HTTP front-end. In particular, you need to: +The previous section described the general configuration for an HTTP frontend. This section describes the additional steps to enable support for the HTTPS protocol on an HTTP frontend. In particular, you will need to: -- switch over the front-end to port 443, which is standard for HTTPS protocol -- configure an SSL/TLS certificate to authenticate and encrypt connections +- switch the frontend to port 443, the standard port for the HTTPS protocol; +- configure an SSL/TLS certificate to authenticate and encrypt the connections. -Whether you choose to configure your service via the API or the OVHcloud Control Panel, you can choose from two methods for adding an SSL/TLS certificate. The choice of method will depend on your needs, as well as the solutions currently set up. You can either: +Whether you choose a configuration via the API or via the OVHcloud Control Panel, you will have a choice between 2 strategies for your SSL/TLS certificates. This choice depends on your needs as well as the current solutions in place: - Import an existing SSL/TLS certificate. -- Order an automatically managed SSL/TLS certificate. DV and EV certificates will be available to order soon. +- Order an automatically managed SSL/TLS certificate. The ordering of DV and EV certificates will be available soon. -If you choose to import an SSL/TLS certificate that you have already ordered and managed yourself, you will need to renew it periodically yourself, and update it in your OVHcloud Load Balancer service. Most certificates are valid for one year. Some remain valid for longer periods of time. However, Let's Encrypt certificates need to be renewed every three months. We recommend using your OVHcloud Load Balancer to automatically manage the service for Let’s Encrypt certificates, so that you do not miss the expiry dates. +If you choose to import an SSL/TLS certificate that you have ordered and managed yourself, you will have to renew it periodically yourself and update it in your OVHcloud Load Balancer service. Most certificates are valid for 1 year. Some may be valid for longer. Let's Encrypt certificates are valid for 3 months. It is recommended to use the service managed automatically by your OVHcloud Load Balancer for Let's Encrypt certificates in order not to accidentally miss a deadline. -If you opt for a certificate managed by the OVHcloud Load Balancer service, it will be automatically ordered, validated, installed and renewed periodically by your OVHcloud Load Balancer. For the validation and renewal operations to work, the domains you are ordering this certificate for need to be routed to your OVHcloud Load Balancer service. This means that your domain’s *A* and *AAAA* DNS records must point to your OVHcloud Load Balancer’s IPv4 and IPv6 fields respectively, or to one of its Additional IPs. When you order, you will receive an email that will guide you through the validation steps. +If you choose a certificate managed by your OVHcloud Load Balancer service, it will be automatically ordered, validated, installed and renewed periodically by your OVHcloud Load Balancer.
+For the validation and renewal operations to work, the domain(s) you are ordering this certificate for must be routed to your OVHcloud Load Balancer service. This implies that the *A* and *AAAA* fields of your domain point respectively to the IPv4 and IPv6 of your OVHcloud Load Balancer or one of its Additional IPs. During the order, you will receive an email that will guide you through the validation steps. +> [!primary] > -> To ensure that your service remains accessible when you switch your domain to your OVHcloud Load Balancer service’s IP address in order to validate your certificate, it is good practice to start by configuring and testing all of the HTTP configuration on port 80. This way, your website will remain accessible without any interruptions. -> If the website already has a HTTPS connection and you want to switch to certificates managed by your OVHcloud Load Balancer service, you can import your existing certificates, configure and test your HTTPS front-end, and order a new certificate for the same domain. It will be taken into account automatically when your old certificate expires. +> To ensure service continuity when switching your domain to the IP of your OVHcloud Load Balancer service to validate your certificate, a good practice is to first configure and fully test the HTTP configuration on port 80. This way, your site remains accessible without interruption. +> If your site already has an HTTPS connection and you want to migrate to certificates managed by your OVHcloud Load Balancer service, you can import your existing certificates, configure and test your HTTPS Frontend and finally order a new certificate for the same domain. It will be automatically taken into account before your old certificate expires. > -The certificates configured on your OVHcloud Load Balancer service are automatically available for all of the front-ends on your service that have *SSL* options enabled. +The certificates configured on your OVHcloud Load Balancer service are automatically available for all frontends of your OVHcloud Load Balancer service on which the *SSL* option is enabled. #### TLS 1.3 support -With the constant evolution of Internet security standards, OVHcloud is committed to providing the latest and most secure technologies for your services. The OVHcloud Load Balancer now supports TLS 1.3. -##### What is TLS 1.3? -TLS 1.3 is the latest version of the TLS protocol, offering significant improvements in security and performance over TLS 1.2. Key benefits include a faster handshake process, reducing the time needed to establish secure connections, and the use of more secure cipher suites to strengthen the security of transmitted data. +With the constant evolution of security standards on the Internet, OVHcloud is committed to providing the most recent and secure technologies for your services. The OVHcloud Load Balancer now supports TLS 1.3. + +##### **What is TLS 1.3?** + +TLS 1.3 is the latest version of the TLS protocol, offering significant improvements in terms of security and performance compared to TLS 1.2. The key advantages include a faster *handshake* process, thus reducing the time needed to establish secure connections, and the use of safer encryption suites to strengthen the security of transmitted data. -##### Why use TLS 1.3 with OVHcloud Load Balancer? -By integrating TLS 1.3, your OVHcloud Load Balancer will benefit from enhanced security and improved performance, ensuring an optimal user experience for your visitors. Reduced handshake times speed up page loading, while security enhancements ensure that your data is protected with the latest, most secure standards. +##### **Why use TLS 1.3 with OVHcloud Load Balancer?** -### Via the OVHcloud Control Panel. +By integrating TLS 1.3, your OVHcloud Load Balancer will benefit from enhanced security and improved performance, ensuring an optimal user experience for your visitors. The reduction in *handshake* time speeds up page loading, while the security improvements ensure that your data is protected with the most recent and secure standards. -The list of SSL/TLS certificates configured on the OVHcloud Load Balancer can be found in the `SSL certificates`{.action} tab. In this interface, you can select one of the two options mentioned further up, i.e. importing an existing certificate (`Add an SSL certificate`{.action}) and (`Order an SSL certificate`{.action}) managed automatically by your OVHcloud Load Balancer. +#### From the OVHcloud Control Panel -![Buttons for adding certificates](images/certificat.png){.thumbnail} +The list of SSL/TLS certificates configured on your OVHcloud Load Balancer service is in the `SSL Certificates`{.action} tab. This interface offers the 2 options mentioned above, namely importing an existing certificate (via the `Add an SSL certificate`{.action} button) and `Order an SSL certificate`{.action} managed automatically by your OVHcloud Load Balancer service. -If you choose to import an existing SSL/TLS certificate, click `Add an SSL certificate`{.action}. The *Private key* and *Certificate* fields are obligatory. +![Certificate addition buttons](images/certificat.png){.thumbnail} -Click `Add`{.action} once you have filled in the fields. Your certificate will appear in the certificate list. +If you choose to import an existing SSL/TLS certificate, click on `Add an SSL certificate`{.action}. The *Private Key* and *Certificate* fields are mandatory. -![Add an existing SSL certificate](images/add_certificat_custom.png){.thumbnail} +Click the `Add`{.action} button once the fields are filled in. Your certificate will then appear in the certificate list. -To add a Let's Encrypt certificate, click `Order an SSL certificate`{.action}, enter your domains, ensure that they point to your OVHcloud Load Balancer, and follow the instructions set out in the guides you receive. You will then see it appear in the list of available certificates. +![Adding an existing certificate](images/add_certificat_custom.png){.thumbnail} -![Order a Let’s Encrypt certificate](images/add_certificat_letsencrypt.png){.thumbnail} +To add a Let's Encrypt certificate, click on `Order an SSL certificate`{.action}, enter your domain, make sure it points to your OVHcloud Load Balancer service and follow the emails you receive. You will then see it appear in the list of available certificates. -Once your certificates have been configured, you can create a HTTPS front-end, on the same model as the HTTP front-end created earlier on with port 443, and the *SSL* option enabled. You can also choose to enable the *HSTS* option. With this option enabled, web browsers will remember that this website should *no longer* be visited without HTTPS after the first time the web user visits in HTTPS. This way, you can improve your infrastructure’s overall security by protecting it against ‘man-in-the-middle’ attacks, where a malicious party can make it seem as though your website is not available in HTTPS, forcing your web users to switch to HTTP. +![Ordering a Let's Encrypt certificate](images/add_certificat_letsencrypt.png){.thumbnail} + +Once your certificate(s) are configured, you can create an HTTPS frontend, on the same model as the HTTP frontend created above with port 443 and the *SSL* option enabled.
+Optionally, you can also enable the *HSTS* option. If this option is enabled, browsers will record that this website should *never again* be visited without HTTPS after their first visit in HTTPS. This strengthens overall security by protecting against "Man-in-the-middle" attacks in which a malicious actor could make your website appear unavailable in HTTPS and force your visitors to switch to "HTTP". > [!warning] +> Although the added security is significant, it is recommended to wait a while before enabling this option, to make sure there are no side effects in HTTPS. Indeed, once HSTS is enabled, there is no going back. > -> All though adding this additional level of security is important, we recommend waiting for a while before you enable this option, to ensure that there are no issues with your website forming HTTPS connections. Once HSTS has been enabled, you cannot undo the change. -> -### Via the API +#### From the OVHcloud API -- To list the SSL/TLS certificates in place: +- List the existing SSL/TLS certificates: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl > -- To view details on an SSL/TLS certificate: +- Get the details of an SSL/TLS certificate: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl/{id} > -- To add a new, existing SSL/TLS certificate: +- Adding a new existing SSL/TLS certificate: > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/ssl > -- To modify a specific SSL/TLS certificate (only the display name can be modified): +- Modifying a specific SSL/TLS certificate (only the displayed name can be modified) : > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/ssl/{id} > -- To delete a specific SSL/TLS certificate: +- Deleting a specific SSL/TLS certificate: > [!api] > > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/ssl/{id} > -## Apply the modifications +### Apply the changes -The modifications made to your OVHcloud Load Balancer must be *explicitly applied* in each of the zones configured for your OVHcloud Load Balancer service. Only then will they be visible to your website visitors. This way, you can make complex configuration changes in one go. +The changes made to your OVHcloud Load Balancer service must be *explicitly applied* in each of the zones configured for your OVHcloud Load Balancer service. Only then will they be visible to your visitors. This allows a complex configuration change to be made in a single step. -If you have several zones, you must apply the same configuration for each of them. +If you have several zones, you will have to apply the same configuration for each of your zones. -### Via the OVHcloud Control Panel. +#### From the OVHcloud Control Panel -Go to the page for your OVHcloud Load Balancer, and click `Apply configuration`{.action}. +Go to the home page of your OVHcloud Load Balancer service, click on the `...`{.action} dots next to the name of your service and click on `Apply the configuration`{.action}. -![Apply configuration](images/btn_apply_configuration.png){.thumbnail} +![Apply the configuration](images/btn_apply_configuration.png){.thumbnail} -Next, select the zones you want to deploy, and click `Apply configuration`{.action}. +Then select the list of zones you want to deploy and click on the `Apply the configuration`{.action} button. -![Apply configuration to zones](images/btn_apply_configuration_zones.png){.thumbnail} +![Apply the configuration zones](images/btn_apply_configuration_zones.png){.thumbnail} -### Via the API +#### From the OVHcloud API - Refresh a zone: @@ -343,10 +371,10 @@ Next, select the zones you want to deploy, and click `Apply configuration`{.acti > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh > -## Confirmation +### Validation -Once you have completed all of these steps, you should have a functional load balancing service. You can check the service status by visiting your website. +Once all these steps are completed, you should have a functional load balancing service. You can validate the status of the service by visiting your site. ## Go further -Join our community of users on . \ No newline at end of file +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_http_https/guide.en-gb.md b/pages/network/load_balancer/create_http_https/guide.en-gb.md index 8fb7329b659..2fed9523cf1 100644 --- a/pages/network/load_balancer/create_http_https/guide.en-gb.md +++ b/pages/network/load_balancer/create_http_https/guide.en-gb.md @@ -1,81 +1,106 @@ --- -title: 'Configuring a HTTP/HTTPS OVH Load Balancer service' -excerpt: 'Find out how to configure an OVH Load Balancer service' -updated: 2023-11-22 +title: "Configuration of an OVHcloud Load Balancer service with HTTP/HTTPS" +excerpt: "Configure your OVHcloud Load Balancer to distribute HTTP traffic and secure your connections with HTTPS" +updated: 2025-11-12 --- -## Objective + -The purpose of this guide is to help you create your first HTTP/HTTPS service with the new OVHcloud Load Balancer solution. Here, we will set up a basic OVHcloud Load Balancer service configuration to balance the HTTP load for a service like a website. +## Objective -A front-end will be created to listen on port 80, while another listens on port 443 with an SSL/TLS certificate. These front-ends will be configured to direct their traffic to a common HTTP farm. This farm can have one or more servers, depending on the configuration you have chosen/adapted. +This guide aims to help you create your first HTTP/HTTPS service using the OVHcloud Load Balancer offer. We will configure a simple OVHcloud Load Balancer service to distribute HTTP traffic for a service, such as a website. -As a reminder, the OVHcloud Load Balancer has four primary components: +A frontend will be created to listen on port 80, while another will listen on port 443 with an SSL/TLS certificate. These frontends will be configured to direct their traffic to a common HTTP farm. This farm can have one or more servers, depending on the chosen / adapted configuration. -- `front-ends` -- server `farms` and their `servers` -- the advanced `routes` between the front-ends and server farms -- `SSL/TLS` connections that can encrypt TCP and/or HTTP connections +As a reminder, the OVHcloud Load Balancer service is composed of 4 elementary parts: -**This guide will show you how to configure an OVHcloud Load Balancer Service.** +- the `frontends`; +- the `farms` of servers and their `servers`; +- the advanced `routes` between Frontends and Server Farms; +- the `SSL/TLS` certificates allowing TCP and/or HTTP connections to be encrypted. ## Requirements -- an OVHcloud Load Balancer -- the ability to add and configure a farm, a server, a front-end and an SSL certificate +- Have an [OVHcloud Load balancer](/links/network/load-balancer) offer in your OVHcloud account +- You must be logged in to your [OVHcloud Control Panel](/links/manager) +- Have a configured farm +- Have a configured frontend +- Have an SSL certificate + +## Instructions -## Introduction +## Table of contents + +- [Add a server farm](#farm) +- [Add a server](#server) +- [Add a frontend](#frontend) +- [Add an SSL/TLS certificate](#certificate) +- [Apply the changes](#apply) +- [Validation](#validation) > [!warning] > -> This guide will take you through the steps required. Depending on the way you have designed your architecture, some configurations may vary. +> We will guide you through the different steps. Depending on your architecture choices, some configurations may differ. > -If you have not done so already, we recommend reading a general introduction to the OVHcloud Load Balancer service before you get started: [Introduction to the OVHcloud Load Balancer](/pages/network/load_balancer/use_presentation){.ref} +Before you start, it is recommended to consult the [OVHcloud Load Balancer presentation](/pages/network/load_balancer/use_presentation). > [!warning] > -> The order in which elements are created is important. In particular, the server farms must be configured before we can attach an SSL/TLS certificate or servers to them. The front-ends must be configured after the server farms in order to configure the front-end’s default farm. +> The order of element creation is important. In particular, server farms must be configured before being able to attach an SSL/TLS certificate or servers to them. Similarly, frontends must be configured after the server farms in order to be able to configure the frontend's default farm. > -In the control panel of the load balancer, you will see the features detailed below: +The features detailed below are accessible from the OVHcloud Control Panel: -![OVHcloud Load Balancer service](images/iplb_service.png){.thumbnail} +![OVHcloud Load Balancer Service](images/iplb_service.png){.thumbnail} -For more information on the Control Panel’s features, you can consult the following guide: [Managing the Load Balancer from the customer control panel](/pages/network/load_balancer/use-lb){.ref} +For more information about the features of the OVHcloud Control Panel, see the [Managing the Load Balancer service via the OVHcloud Control Panel](/pages/network/load_balancer/use-lb) page. -Similarly, this can be done via the OVHcloud API, in the section: +Via the OVHcloud API, use the following call: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing > -For more information on the API’s features, you can consult the following guide: [Load Balancer API Quick Reference](/pages/network/load_balancer/use_api_reference){.ref} - -## Add a server farm. +For more information on the API features, consult the page [API function details](/pages/network/load_balancer/use_api_details) -We will add a farm of HTTP servers to our service, which is the part that balances traffic on the servers. +### Add a server farm -### Via the OVHCloud Control Panel. +We will add an HTTP server farm to our service. This part is responsible for distributing traffic to the servers. -Log into the [OVHcloud Control Panel](/links/manager), click `Network`{.action} in the left-hand menu, then `Load Balancer`. Click on your load balancer service. +#### From the OVHcloud Control Panel -In the `Server farms`{.action} tab, click on the `Add a server farm`{.action} button. +In the `Server Farms`{.action} tab, click the `Add a server farm`{.action} button. -Fill in the fields. The only mandatory fields for a basic configuration are *Protocol* and *Datacentre*. We recommend explicitly defining a *Port* (generally port 80 for a web service). If no ports are specified, your OVHcloud Load Balancer will automatically use the same port as the corresponding front-end, and the probes will not be able to work as intended. +Fill in the fields. The only mandatory fields for a simple configuration are the *Protocol* and the *Datacentre*. It is recommended to explicitly define a *Port*, generally port 80 for a web service. If no port is specified, your OVHcloud Load Balancer will automatically use the same port as the corresponding frontend and the probes may not work as expected. -If you add several servers to your farm, we advise configuring an HTTP `availability probe`. When a probe is configured, the OVHcloud Load Balancer service can automatically disable a server that is down or under maintenance, so that your web users are not affected. +If you add several servers in your farm, it is recommended to configure an HTTP `availability probe`. When a probe is configured, the OVHcloud Load Balancer service can automatically disable a server that is down or under maintenance, in order not to affect visitors. -![Add a server farm via the Control Panel](images/add_backend.png){.thumbnail} +![Adding a server farm via the OVHcloud Control Panel](images/add_backend.png){.thumbnail} -Click `Add`{.action} once you have filled in the fields. +Click the `Add`{.action} button once you have filled in the fields. -Your server farm should appear in the list, in the `Server farms`{.action} tab. +Your server farm should appear in the list, under the `Server Farms`{.action} tab. -![Details of the server farm created](images/resume_backend.png){.thumbnail} +![Details of the created server farm](images/resume_backend.png){.thumbnail} -### Via the API +#### From the OVHcloud API - List of HTTP server farms: @@ -91,48 +116,46 @@ Your server farm should appear in the list, in the `Server farms`{.action} tab. > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId} > -- Add a new HTTP server farm: +- Adding a new HTTP server farm: > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm > -- Modify a specific server farm: +- Modifying a specific server farm: > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId} > -- Delete a specific server farm: +- Deleting a specific server farm: > [!api] > > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId} > -## Add a server. +### Add a server We will now add a server to our server farm. -### Via the OVHcloud Control Panel. +#### From the OVHcloud Control Panel -Log into the [OVHcloud Control Panel](/links/manager), click `Network`{.action} in the left-hand menu, then `Load Balancer`. Click on your load balancer service. +Still in the `Server Farms`{.action} tab, select the farm to which you want to add a server by clicking on the corresponding line. The list of servers already configured in the farm appears below the list of farms, as well as the `Add a server`{.action} button. Click on this button to add a new server. -In the `Server farms`{.action} tab, select the farm you want to add a server to by clicking on the corresponding line. The list of servers already configured in the farm will appear beneath the list of farms, along with the `Add a server`{.action} button. Click on this button to add a new server. +Only the *IPv4 Address* field is mandatory. If a server does not use the same port as the one defined above in the farm, it is possible to override it in the server configuration. However, in order to maintain the most homogeneous and maintainable configuration possible, it is recommended to use this parameter only in advanced cases. -Only the *IPv4 address* field is mandatory. If a server does not use the same port as the one defined earlier in the farm, you may overload it by configuring a server. However, to keep the configuration as standardised and easy to maintain as possible, we recommend only using this parameter in advanced cases. +![Adding a server to a Farm.](images/add_server.png){.thumbnail} -![Add a server to a farm.](images/add_server.png){.thumbnail} +Click the `Add`{.action} button once you have filled in the fields. -Click `Add`{.action} once you have filled in the fields. +Your server should appear in the list of servers, in the `Server Farms`{.action} tab, just below the list of farms. -Your server should appear in the server list, in the `Server farm`{.action} tab, just below the list of farms. +![Details of the created server.](images/resume_server.png){.thumbnail} -![Details of the server created.](images/resume_server.png){.thumbnail} - -### Via the API +#### From the OVHcloud API - List of servers in the farm: @@ -148,193 +171,198 @@ Your server should appear in the server list, in the `Server farm`{.action} tab, > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId} > -- Add a new server: +- Adding a new server: > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server > -- Modify a specific server: +- Modifying a specific server: > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server > -- Delete a specific server: +- Deleting a specific server: > [!api] > > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server > -## Add a front-end. +### Add a frontend -We will now add a `front-end` to our service, and connect it to our server farm. The front-end is the part of your OVHcloud Load Balancer that exposes your service on the internet. First, we will only configure it in HTTP, without an SSL/TLS certificate. +We will now add a `frontend` to our service and connect it to our server farm. The frontend is the part of your OVHcloud Load Balancer that is used to expose your service on the Internet. At first, we will configure it in HTTP only, without an SSL/TLS certificate. -### Via the OVHcloud Control Panel. +#### From the OVHcloud Control Panel -Go to the `Front-ends`{.action} tab, and click `Add a front-end`{.action}. +In the `Frontends`{.action} tab, click the `Add a frontend`{.action} button. -Fill in the fields. The only mandatory fields for a basic configuration are *Protocol*, *Port* (80 for a standard HTTP web service) and *Datacentre*. If you want your service to be available across several ports at once, you can specify a list of ports, separated by commas, or a range of ports, in the format "START_PORT-END_PORT". +Fill in the fields. The only mandatory fields for a simple configuration are the *Protocol*, the *Port* (80 for a standard HTTP web service) and the *Datacentre*. If you want your service to be available on several ports at the same time, you can specify a list of ports separated by commas or a range of ports in the form "START_PORT-END_PORT". -If you have routed Additional IPs to your OVHcloud Load Balancer service, you can also attach a front-end to one or more specific Additional IPs. +If you have routed Additional IPs to your OVHcloud Load Balancer service, you can also attach a frontend to one or more specific Additional IPs. -![Add a front-end](images/add_frontend.png){.thumbnail} +![Adding a frontend](images/add_frontend.png){.thumbnail} -Click `Add`{.action} once you have filled in the fields. +Click the `Add`{.action} button once you have filled in the fields. -Your front-end must appear in the list, in the `Front-ends`{.action} tab. +Your frontend should appear in the list, under the `Frontends`{.action} tab. -![Details of the front-end created](images/resume_frontend.png){.thumbnail} +![Details of the created frontend](images/resume_frontend.png){.thumbnail} -### Via the API +#### From the OVHcloud API -- List of HTTP front-ends: +- List of HTTP frontends: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend > -- Details of a specific front-end: +- Details of a specific frontend: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend/{frontendId} > -- Add a new front-end: +- Adding a new frontend: > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend > -- Modify a specific front-end: +- Modifying a specific frontend: > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId} > -- Delete a specific front-end: +- Deleting a specific frontend: > [!api] > > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/frontend/{frontendId} > -## Add an SSL/TLS certificate. +### Add an SSL/TLS certificate -The section above described the general configuration of a HTTP front-end. This next section describes the additional steps you need to take to activate support of HTTPS protocol on an HTTP front-end. In particular, you need to: +The previous section described the general configuration for an HTTP frontend. This section describes the additional steps to enable support for the HTTPS protocol on an HTTP frontend. In particular, you will need to: -- switch over the front-end to port 443, which is standard for HTTPS protocol -- configure an SSL/TLS certificate to authenticate and encrypt connections +- switch the frontend to port 443, the standard port for the HTTPS protocol; +- configure an SSL/TLS certificate to authenticate and encrypt the connections. -Whether you choose to configure your service via the API or the OVHcloud Control Panel, you can choose from two methods for adding an SSL/TLS certificate. The choice of method will depend on your needs, as well as the solutions currently set up. You can either: +Whether you choose a configuration via the API or via the OVHcloud Control Panel, you will have a choice between 2 strategies for your SSL/TLS certificates. This choice depends on your needs as well as the current solutions in place: - Import an existing SSL/TLS certificate. -- Order an automatically managed SSL/TLS certificate. DV and EV certificates will be available to order soon. +- Order an automatically managed SSL/TLS certificate. The ordering of DV and EV certificates will be available soon. -If you choose to import an SSL/TLS certificate that you have already ordered and managed yourself, you will need to renew it periodically yourself, and update it in your OVHcloud Load Balancer service. Most certificates are valid for one year. Some remain valid for longer periods of time. However, Let's Encrypt certificates need to be renewed every three months. We recommend using your OVHcloud Load Balancer to automatically manage the service for Let’s Encrypt certificates, so that you do not miss the expiry dates. +If you choose to import an SSL/TLS certificate that you have ordered and managed yourself, you will have to renew it periodically yourself and update it in your OVHcloud Load Balancer service. Most certificates are valid for 1 year. Some may be valid for longer. Let's Encrypt certificates are valid for 3 months. It is recommended to use the service managed automatically by your OVHcloud Load Balancer for Let's Encrypt certificates in order not to accidentally miss a deadline. -If you opt for a certificate managed by the OVHcloud Load Balancer service, it will be automatically ordered, validated, installed and renewed periodically by your OVHcloud Load Balancer. For the validation and renewal operations to work, the domains you are ordering this certificate for need to be routed to your OVHcloud Load Balancer service. This means that your domain’s *A* and *AAAA* DNS records must point to your OVHcloud Load Balancer’s IPv4 and IPv6 fields respectively, or to one of its Additional IPs. When you order, you will receive an email that will guide you through the validation steps. +If you choose a certificate managed by your OVHcloud Load Balancer service, it will be automatically ordered, validated, installed and renewed periodically by your OVHcloud Load Balancer.
+For the validation and renewal operations to work, the domain(s) you are ordering this certificate for must be routed to your OVHcloud Load Balancer service. This implies that the *A* and *AAAA* fields of your domain point respectively to the IPv4 and IPv6 of your OVHcloud Load Balancer or one of its Additional IPs. During the order, you will receive an email that will guide you through the validation steps. +> [!primary] > -> To ensure that your service remains accessible when you switch your domain to your OVHcloud Load Balancer service’s IP address in order to validate your certificate, it is good practice to start by configuring and testing all of the HTTP configuration on port 80. This way, your website will remain accessible without any interruptions. -> If the website already has a HTTPS connection and you want to switch to certificates managed by your OVHcloud Load Balancer service, you can import your existing certificates, configure and test your HTTPS front-end, and order a new certificate for the same domain. It will be taken into account automatically when your old certificate expires. +> To ensure service continuity when switching your domain to the IP of your OVHcloud Load Balancer service to validate your certificate, a good practice is to first configure and fully test the HTTP configuration on port 80. This way, your site remains accessible without interruption. +> If your site already has an HTTPS connection and you want to migrate to certificates managed by your OVHcloud Load Balancer service, you can import your existing certificates, configure and test your HTTPS Frontend and finally order a new certificate for the same domain. It will be automatically taken into account before your old certificate expires. > -The certificates configured on your OVHcloud Load Balancer service are automatically available for all of the front-ends on your service that have *SSL* options enabled. +The certificates configured on your OVHcloud Load Balancer service are automatically available for all frontends of your OVHcloud Load Balancer service on which the *SSL* option is enabled. #### TLS 1.3 support -With the constant evolution of Internet security standards, OVHcloud is committed to providing the latest and most secure technologies for your services. The OVHcloud Load Balancer now supports TLS 1.3. -##### What is TLS 1.3? -TLS 1.3 is the latest version of the TLS protocol, offering significant improvements in security and performance over TLS 1.2. Key benefits include a faster handshake process, reducing the time needed to establish secure connections, and the use of more secure cipher suites to strengthen the security of transmitted data. +With the constant evolution of security standards on the Internet, OVHcloud is committed to providing the most recent and secure technologies for your services. The OVHcloud Load Balancer now supports TLS 1.3. + +##### **What is TLS 1.3?** + +TLS 1.3 is the latest version of the TLS protocol, offering significant improvements in terms of security and performance compared to TLS 1.2. The key advantages include a faster *handshake* process, thus reducing the time needed to establish secure connections, and the use of safer encryption suites to strengthen the security of transmitted data. -##### Why use TLS 1.3 with OVHcloud Load Balancer? -By integrating TLS 1.3, your OVHcloud Load Balancer will benefit from enhanced security and improved performance, ensuring an optimal user experience for your visitors. Reduced handshake times speed up page loading, while security enhancements ensure that your data is protected with the latest, most secure standards. +##### **Why use TLS 1.3 with OVHcloud Load Balancer?** -### Via the OVHcloud Control Panel. +By integrating TLS 1.3, your OVHcloud Load Balancer will benefit from enhanced security and improved performance, ensuring an optimal user experience for your visitors. The reduction in *handshake* time speeds up page loading, while the security improvements ensure that your data is protected with the most recent and secure standards. -The list of SSL/TLS certificates configured on the OVHcloud Load Balancer can be found in the `SSL certificates`{.action} tab. In this interface, you can select one of the two options mentioned further up, i.e. importing an existing certificate (`Add an SSL certificate`{.action}) and (`Order an SSL certificate`{.action}) managed automatically by your OVHcloud Load Balancer. +#### From the OVHcloud Control Panel -![Buttons for adding certificates](images/certificat.png){.thumbnail} +The list of SSL/TLS certificates configured on your OVHcloud Load Balancer service is in the `SSL Certificates`{.action} tab. This interface offers the 2 options mentioned above, namely importing an existing certificate (via the `Add an SSL certificate`{.action} button) and `Order an SSL certificate`{.action} managed automatically by your OVHcloud Load Balancer service. -If you choose to import an existing SSL/TLS certificate, click `Add an SSL certificate`{.action}. The *Private key* and *Certificate* fields are obligatory. +![Certificate addition buttons](images/certificat.png){.thumbnail} -Click `Add`{.action} once you have filled in the fields. Your certificate will appear in the certificate list. +If you choose to import an existing SSL/TLS certificate, click on `Add an SSL certificate`{.action}. The *Private Key* and *Certificate* fields are mandatory. -![Add an existing SSL certificate](images/add_certificat_custom.png){.thumbnail} +Click the `Add`{.action} button once the fields are filled in. Your certificate will then appear in the certificate list. -To add a Let's Encrypt certificate, click `Order an SSL certificate`{.action}, enter your domains, ensure that they point to your OVHcloud Load Balancer, and follow the instructions set out in the guides you receive. You will then see it appear in the list of available certificates. +![Adding an existing certificate](images/add_certificat_custom.png){.thumbnail} -![Order a Let’s Encrypt certificate](images/add_certificat_letsencrypt.png){.thumbnail} +To add a Let's Encrypt certificate, click on `Order an SSL certificate`{.action}, enter your domain, make sure it points to your OVHcloud Load Balancer service and follow the emails you receive. You will then see it appear in the list of available certificates. -Once your certificates have been configured, you can create a HTTPS front-end, on the same model as the HTTP front-end created earlier on with port 443, and the *SSL* option enabled. You can also choose to enable the *HSTS* option. With this option enabled, web browsers will remember that this website should *no longer* be visited without HTTPS after the first time the web user visits in HTTPS. This way, you can improve your infrastructure’s overall security by protecting it against ‘man-in-the-middle’ attacks, where a malicious party can make it seem as though your website is not available in HTTPS, forcing your web users to switch to HTTP. +![Ordering a Let's Encrypt certificate](images/add_certificat_letsencrypt.png){.thumbnail} + +Once your certificate(s) are configured, you can create an HTTPS frontend, on the same model as the HTTP frontend created above with port 443 and the *SSL* option enabled.
+Optionally, you can also enable the *HSTS* option. If this option is enabled, browsers will record that this website should *never again* be visited without HTTPS after their first visit in HTTPS. This strengthens overall security by protecting against "Man-in-the-middle" attacks in which a malicious actor could make your website appear unavailable in HTTPS and force your visitors to switch to "HTTP". > [!warning] +> Although the added security is significant, it is recommended to wait a while before enabling this option, to make sure there are no side effects in HTTPS. Indeed, once HSTS is enabled, there is no going back. > -> All though adding this additional level of security is important, we recommend waiting for a while before you enable this option, to ensure that there are no issues with your website forming HTTPS connections. Once HSTS has been enabled, you cannot undo the change. -> -### Via the API +#### From the OVHcloud API -- To list the SSL/TLS certificates in place: +- List the existing SSL/TLS certificates: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl > -- To view details on an SSL/TLS certificate: +- Get the details of an SSL/TLS certificate: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl/{id} > -- To add a new, existing SSL/TLS certificate: +- Adding a new existing SSL/TLS certificate: > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/ssl > -- To modify a specific SSL/TLS certificate (only the display name can be modified): +- Modifying a specific SSL/TLS certificate (only the displayed name can be modified) : > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/ssl/{id} > -- To delete a specific SSL/TLS certificate: +- Deleting a specific SSL/TLS certificate: > [!api] > > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/ssl/{id} > -## Apply the modifications +### Apply the changes -The modifications made to your OVHcloud Load Balancer must be *explicitly applied* in each of the zones configured for your OVHcloud Load Balancer service. Only then will they be visible to your website visitors. This way, you can make complex configuration changes in one go. +The changes made to your OVHcloud Load Balancer service must be *explicitly applied* in each of the zones configured for your OVHcloud Load Balancer service. Only then will they be visible to your visitors. This allows a complex configuration change to be made in a single step. -If you have several zones, you must apply the same configuration for each of them. +If you have several zones, you will have to apply the same configuration for each of your zones. -### Via the OVHcloud Control Panel. +#### From the OVHcloud Control Panel -Go to the page for your OVHcloud Load Balancer, and click `Apply configuration`{.action}. +Go to the home page of your OVHcloud Load Balancer service, click on the `...`{.action} dots next to the name of your service and click on `Apply the configuration`{.action}. -![Apply configuration](images/btn_apply_configuration.png){.thumbnail} +![Apply the configuration](images/btn_apply_configuration.png){.thumbnail} -Next, select the zones you want to deploy, and click `Apply configuration`{.action}. +Then select the list of zones you want to deploy and click on the `Apply the configuration`{.action} button. -![Apply configuration to zones](images/btn_apply_configuration_zones.png){.thumbnail} +![Apply the configuration zones](images/btn_apply_configuration_zones.png){.thumbnail} -### Via the API +#### From the OVHcloud API - Refresh a zone: @@ -343,10 +371,10 @@ Next, select the zones you want to deploy, and click `Apply configuration`{.acti > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh > -## Confirmation +### Validation -Once you have completed all of these steps, you should have a functional load balancing service. You can check the service status by visiting your website. +Once all these steps are completed, you should have a functional load balancing service. You can validate the status of the service by visiting your site. ## Go further -Join our community of users on . \ No newline at end of file +Join our [community of users](/links/community). diff --git a/pages/network/load_balancer/create_http_https/guide.en-sg.md b/pages/network/load_balancer/create_http_https/guide.en-sg.md index 8fb7329b659..37bcbfcdcec 100644 --- a/pages/network/load_balancer/create_http_https/guide.en-sg.md +++ b/pages/network/load_balancer/create_http_https/guide.en-sg.md @@ -1,81 +1,106 @@ --- -title: 'Configuring a HTTP/HTTPS OVH Load Balancer service' -excerpt: 'Find out how to configure an OVH Load Balancer service' -updated: 2023-11-22 +title: "Configuration of an OVHcloud Load Balancer service with HTTP/HTTPS" +excerpt: "Configure your OVHcloud Load Balancer to distribute HTTP traffic and secure your connections with HTTPS" +updated: 2025-11-12 --- -## Objective + -The purpose of this guide is to help you create your first HTTP/HTTPS service with the new OVHcloud Load Balancer solution. Here, we will set up a basic OVHcloud Load Balancer service configuration to balance the HTTP load for a service like a website. +## Objective -A front-end will be created to listen on port 80, while another listens on port 443 with an SSL/TLS certificate. These front-ends will be configured to direct their traffic to a common HTTP farm. This farm can have one or more servers, depending on the configuration you have chosen/adapted. +This guide aims to help you create your first HTTP/HTTPS service using the OVHcloud Load Balancer offer. We will configure a simple OVHcloud Load Balancer service to distribute HTTP traffic for a service, such as a website. -As a reminder, the OVHcloud Load Balancer has four primary components: +A frontend will be created to listen on port 80, while another will listen on port 443 with an SSL/TLS certificate. These frontends will be configured to direct their traffic to a common HTTP farm. This farm can have one or more servers, depending on the chosen / adapted configuration. -- `front-ends` -- server `farms` and their `servers` -- the advanced `routes` between the front-ends and server farms -- `SSL/TLS` connections that can encrypt TCP and/or HTTP connections +As a reminder, the OVHcloud Load Balancer service is composed of 4 elementary parts: -**This guide will show you how to configure an OVHcloud Load Balancer Service.** +- the `frontends`; +- the `farms` of servers and their `servers`; +- the advanced `routes` between Frontends and Server Farms; +- the `SSL/TLS` certificates allowing TCP and/or HTTP connections to be encrypted. ## Requirements -- an OVHcloud Load Balancer -- the ability to add and configure a farm, a server, a front-end and an SSL certificate +- Have an [OVHcloud Load balancer](/links/network/load-balancer) offer in your OVHcloud account +- You must be logged in to your [OVHcloud Control Panel](/links/manager) +- Have a configured farm +- Have a configured frontend +- Have an SSL certificate + +## Instructions -## Introduction +## Table of contents + +- [Add a server farm](#farm) +- [Add a server](#server) +- [Add a frontend](#frontend) +- [Add an SSL/TLS certificate](#certificate) +- [Apply the changes](#apply) +- [Validation](#validation) > [!warning] > -> This guide will take you through the steps required. Depending on the way you have designed your architecture, some configurations may vary. +> We will guide you through the different steps. Depending on your architecture choices, some configurations may differ. > -If you have not done so already, we recommend reading a general introduction to the OVHcloud Load Balancer service before you get started: [Introduction to the OVHcloud Load Balancer](/pages/network/load_balancer/use_presentation){.ref} +Before you start, it is recommended to consult the [OVHcloud Load Balancer presentation](/pages/network/load_balancer/use_presentation). > [!warning] > -> The order in which elements are created is important. In particular, the server farms must be configured before we can attach an SSL/TLS certificate or servers to them. The front-ends must be configured after the server farms in order to configure the front-end’s default farm. +> The order of element creation is important. In particular, server farms must be configured before being able to attach an SSL/TLS certificate or servers to them. Similarly, frontends must be configured after the server farms in order to be able to configure the frontend's default farm. > -In the control panel of the load balancer, you will see the features detailed below: +The features detailed below are accessible from the OVHcloud Control Panel: -![OVHcloud Load Balancer service](images/iplb_service.png){.thumbnail} +![OVHcloud Load Balancer Service](images/iplb_service.png){.thumbnail} -For more information on the Control Panel’s features, you can consult the following guide: [Managing the Load Balancer from the customer control panel](/pages/network/load_balancer/use-lb){.ref} +For more information about the features of the OVHcloud Control Panel, see the [Managing the Load Balancer service via the OVHcloud Control Panel](/pages/network/load_balancer/use-lb) page. -Similarly, this can be done via the OVHcloud API, in the section: +Via the OVHcloud API, use the following call: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing > -For more information on the API’s features, you can consult the following guide: [Load Balancer API Quick Reference](/pages/network/load_balancer/use_api_reference){.ref} - -## Add a server farm. +For more information on the API features, consult the page [API function details](/pages/network/load_balancer/use_api_details) -We will add a farm of HTTP servers to our service, which is the part that balances traffic on the servers. +### Add a server farm -### Via the OVHCloud Control Panel. +We will add an HTTP server farm to our service. This part is responsible for distributing traffic to the servers. -Log into the [OVHcloud Control Panel](/links/manager), click `Network`{.action} in the left-hand menu, then `Load Balancer`. Click on your load balancer service. +#### From the OVHcloud Control Panel -In the `Server farms`{.action} tab, click on the `Add a server farm`{.action} button. +In the `Server Farms`{.action} tab, click the `Add a server farm`{.action} button. -Fill in the fields. The only mandatory fields for a basic configuration are *Protocol* and *Datacentre*. We recommend explicitly defining a *Port* (generally port 80 for a web service). If no ports are specified, your OVHcloud Load Balancer will automatically use the same port as the corresponding front-end, and the probes will not be able to work as intended. +Fill in the fields. The only mandatory fields for a simple configuration are the *Protocol* and the *Datacentre*. It is recommended to explicitly define a *Port*, generally port 80 for a web service. If no port is specified, your OVHcloud Load Balancer will automatically use the same port as the corresponding frontend and the probes may not work as expected. -If you add several servers to your farm, we advise configuring an HTTP `availability probe`. When a probe is configured, the OVHcloud Load Balancer service can automatically disable a server that is down or under maintenance, so that your web users are not affected. +If you add several servers in your farm, it is recommended to configure an HTTP `availability probe`. When a probe is configured, the OVHcloud Load Balancer service can automatically disable a server that is down or under maintenance, in order not to affect visitors. -![Add a server farm via the Control Panel](images/add_backend.png){.thumbnail} +![Adding a server farm via the OVHcloud Control Panel](images/add_backend.png){.thumbnail} -Click `Add`{.action} once you have filled in the fields. +Click the `Add`{.action} button once you have filled in the fields. -Your server farm should appear in the list, in the `Server farms`{.action} tab. +Your server farm should appear in the list, under the `Server Farms`{.action} tab. -![Details of the server farm created](images/resume_backend.png){.thumbnail} +![Details of the created server farm](images/resume_backend.png){.thumbnail} -### Via the API +#### From the OVHcloud API - List of HTTP server farms: @@ -91,48 +116,46 @@ Your server farm should appear in the list, in the `Server farms`{.action} tab. > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId} > -- Add a new HTTP server farm: +- Adding a new HTTP server farm: > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm > -- Modify a specific server farm: +- Modifying a specific server farm: > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId} > -- Delete a specific server farm: +- Deleting a specific server farm: > [!api] > > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId} > -## Add a server. +### Add a server We will now add a server to our server farm. -### Via the OVHcloud Control Panel. +#### From the OVHcloud Control Panel -Log into the [OVHcloud Control Panel](/links/manager), click `Network`{.action} in the left-hand menu, then `Load Balancer`. Click on your load balancer service. +Still in the `Server Farms`{.action} tab, select the farm to which you want to add a server by clicking on the corresponding line. The list of servers already configured in the farm appears below the list of farms, as well as the `Add a server`{.action} button. Click on this button to add a new server. -In the `Server farms`{.action} tab, select the farm you want to add a server to by clicking on the corresponding line. The list of servers already configured in the farm will appear beneath the list of farms, along with the `Add a server`{.action} button. Click on this button to add a new server. +Only the *IPv4 Address* field is mandatory. If a server does not use the same port as the one defined above in the farm, it is possible to override it in the server configuration. However, in order to maintain the most homogeneous and maintainable configuration possible, it is recommended to use this parameter only in advanced cases. -Only the *IPv4 address* field is mandatory. If a server does not use the same port as the one defined earlier in the farm, you may overload it by configuring a server. However, to keep the configuration as standardised and easy to maintain as possible, we recommend only using this parameter in advanced cases. +![Adding a server to a Farm.](images/add_server.png){.thumbnail} -![Add a server to a farm.](images/add_server.png){.thumbnail} +Click the `Add`{.action} button once you have filled in the fields. -Click `Add`{.action} once you have filled in the fields. +Your server should appear in the list of servers, in the `Server Farms`{.action} tab, just below the list of farms. -Your server should appear in the server list, in the `Server farm`{.action} tab, just below the list of farms. +![Details of the created server.](images/resume_server.png){.thumbnail} -![Details of the server created.](images/resume_server.png){.thumbnail} - -### Via the API +#### From the OVHcloud API - List of servers in the farm: @@ -148,193 +171,198 @@ Your server should appear in the server list, in the `Server farm`{.action} tab, > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId} > -- Add a new server: +- Adding a new server: > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server > -- Modify a specific server: +- Modifying a specific server: > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server > -- Delete a specific server: +- Deleting a specific server: > [!api] > > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server > -## Add a front-end. +### Add a frontend -We will now add a `front-end` to our service, and connect it to our server farm. The front-end is the part of your OVHcloud Load Balancer that exposes your service on the internet. First, we will only configure it in HTTP, without an SSL/TLS certificate. +We will now add a `frontend` to our service and connect it to our server farm. The frontend is the part of your OVHcloud Load Balancer that is used to expose your service on the Internet. At first, we will configure it in HTTP only, without an SSL/TLS certificate. -### Via the OVHcloud Control Panel. +#### From the OVHcloud Control Panel -Go to the `Front-ends`{.action} tab, and click `Add a front-end`{.action}. +In the `Frontends`{.action} tab, click the `Add a frontend`{.action} button. -Fill in the fields. The only mandatory fields for a basic configuration are *Protocol*, *Port* (80 for a standard HTTP web service) and *Datacentre*. If you want your service to be available across several ports at once, you can specify a list of ports, separated by commas, or a range of ports, in the format "START_PORT-END_PORT". +Fill in the fields. The only mandatory fields for a simple configuration are the *Protocol*, the *Port* (80 for a standard HTTP web service) and the *Datacentre*. If you want your service to be available on several ports at the same time, you can specify a list of ports separated by commas or a range of ports in the form "START_PORT-END_PORT". -If you have routed Additional IPs to your OVHcloud Load Balancer service, you can also attach a front-end to one or more specific Additional IPs. +If you have routed Additional IPs to your OVHcloud Load Balancer service, you can also attach a frontend to one or more specific Additional IPs. -![Add a front-end](images/add_frontend.png){.thumbnail} +![Adding a frontend](images/add_frontend.png){.thumbnail} -Click `Add`{.action} once you have filled in the fields. +Click the `Add`{.action} button once you have filled in the fields. -Your front-end must appear in the list, in the `Front-ends`{.action} tab. +Your frontend should appear in the list, under the `Frontends`{.action} tab. -![Details of the front-end created](images/resume_frontend.png){.thumbnail} +![Details of the created frontend](images/resume_frontend.png){.thumbnail} -### Via the API +#### From the OVHcloud API -- List of HTTP front-ends: +- List of HTTP frontends: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend > -- Details of a specific front-end: +- Details of a specific frontend: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend/{frontendId} > -- Add a new front-end: +- Adding a new frontend: > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend > -- Modify a specific front-end: +- Modifying a specific frontend: > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId} > -- Delete a specific front-end: +- Deleting a specific frontend: > [!api] > > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/frontend/{frontendId} > -## Add an SSL/TLS certificate. +### Add an SSL/TLS certificate -The section above described the general configuration of a HTTP front-end. This next section describes the additional steps you need to take to activate support of HTTPS protocol on an HTTP front-end. In particular, you need to: +The previous section described the general configuration for an HTTP frontend. This section describes the additional steps to enable support for the HTTPS protocol on an HTTP frontend. In particular, you will need to: -- switch over the front-end to port 443, which is standard for HTTPS protocol -- configure an SSL/TLS certificate to authenticate and encrypt connections +- switch the frontend to port 443, the standard port for the HTTPS protocol; +- configure an SSL/TLS certificate to authenticate and encrypt the connections. -Whether you choose to configure your service via the API or the OVHcloud Control Panel, you can choose from two methods for adding an SSL/TLS certificate. The choice of method will depend on your needs, as well as the solutions currently set up. You can either: +Whether you choose a configuration via the API or via the OVHcloud Control Panel, you will have a choice between 2 strategies for your SSL/TLS certificates. This choice depends on your needs as well as the current solutions in place: - Import an existing SSL/TLS certificate. -- Order an automatically managed SSL/TLS certificate. DV and EV certificates will be available to order soon. +- Order an automatically managed SSL/TLS certificate. The ordering of DV and EV certificates will be available soon. -If you choose to import an SSL/TLS certificate that you have already ordered and managed yourself, you will need to renew it periodically yourself, and update it in your OVHcloud Load Balancer service. Most certificates are valid for one year. Some remain valid for longer periods of time. However, Let's Encrypt certificates need to be renewed every three months. We recommend using your OVHcloud Load Balancer to automatically manage the service for Let’s Encrypt certificates, so that you do not miss the expiry dates. +If you choose to import an SSL/TLS certificate that you have ordered and managed yourself, you will have to renew it periodically yourself and update it in your OVHcloud Load Balancer service. Most certificates are valid for 1 year. Some may be valid for longer. Let's Encrypt certificates are valid for 3 months. It is recommended to use the service managed automatically by your OVHcloud Load Balancer for Let's Encrypt certificates in order not to accidentally miss a deadline. -If you opt for a certificate managed by the OVHcloud Load Balancer service, it will be automatically ordered, validated, installed and renewed periodically by your OVHcloud Load Balancer. For the validation and renewal operations to work, the domains you are ordering this certificate for need to be routed to your OVHcloud Load Balancer service. This means that your domain’s *A* and *AAAA* DNS records must point to your OVHcloud Load Balancer’s IPv4 and IPv6 fields respectively, or to one of its Additional IPs. When you order, you will receive an email that will guide you through the validation steps. +If you choose a certificate managed by your OVHcloud Load Balancer service, it will be automatically ordered, validated, installed and renewed periodically by your OVHcloud Load Balancer.
+For the validation and renewal operations to work, the domain(s) you are ordering this certificate for must be routed to your OVHcloud Load Balancer service. This implies that the *A* and *AAAA* fields of your domain point respectively to the IPv4 and IPv6 of your OVHcloud Load Balancer or one of its Additional IPs. During the order, you will receive an email that will guide you through the validation steps. +> [!primary] > -> To ensure that your service remains accessible when you switch your domain to your OVHcloud Load Balancer service’s IP address in order to validate your certificate, it is good practice to start by configuring and testing all of the HTTP configuration on port 80. This way, your website will remain accessible without any interruptions. -> If the website already has a HTTPS connection and you want to switch to certificates managed by your OVHcloud Load Balancer service, you can import your existing certificates, configure and test your HTTPS front-end, and order a new certificate for the same domain. It will be taken into account automatically when your old certificate expires. +> To ensure service continuity when switching your domain to the IP of your OVHcloud Load Balancer service to validate your certificate, a good practice is to first configure and fully test the HTTP configuration on port 80. This way, your site remains accessible without interruption. +> If your site already has an HTTPS connection and you want to migrate to certificates managed by your OVHcloud Load Balancer service, you can import your existing certificates, configure and test your HTTPS Frontend and finally order a new certificate for the same domain. It will be automatically taken into account before your old certificate expires. > -The certificates configured on your OVHcloud Load Balancer service are automatically available for all of the front-ends on your service that have *SSL* options enabled. +The certificates configured on your OVHcloud Load Balancer service are automatically available for all frontends of your OVHcloud Load Balancer service on which the *SSL* option is enabled. #### TLS 1.3 support -With the constant evolution of Internet security standards, OVHcloud is committed to providing the latest and most secure technologies for your services. The OVHcloud Load Balancer now supports TLS 1.3. -##### What is TLS 1.3? -TLS 1.3 is the latest version of the TLS protocol, offering significant improvements in security and performance over TLS 1.2. Key benefits include a faster handshake process, reducing the time needed to establish secure connections, and the use of more secure cipher suites to strengthen the security of transmitted data. +With the constant evolution of security standards on the Internet, OVHcloud is committed to providing the most recent and secure technologies for your services. The OVHcloud Load Balancer now supports TLS 1.3. + +##### **What is TLS 1.3?** + +TLS 1.3 is the latest version of the TLS protocol, offering significant improvements in terms of security and performance compared to TLS 1.2. The key advantages include a faster *handshake* process, thus reducing the time needed to establish secure connections, and the use of safer encryption suites to strengthen the security of transmitted data. -##### Why use TLS 1.3 with OVHcloud Load Balancer? -By integrating TLS 1.3, your OVHcloud Load Balancer will benefit from enhanced security and improved performance, ensuring an optimal user experience for your visitors. Reduced handshake times speed up page loading, while security enhancements ensure that your data is protected with the latest, most secure standards. +##### **Why use TLS 1.3 with OVHcloud Load Balancer?** -### Via the OVHcloud Control Panel. +By integrating TLS 1.3, your OVHcloud Load Balancer will benefit from enhanced security and improved performance, ensuring an optimal user experience for your visitors. The reduction in *handshake* time speeds up page loading, while the security improvements ensure that your data is protected with the most recent and secure standards. -The list of SSL/TLS certificates configured on the OVHcloud Load Balancer can be found in the `SSL certificates`{.action} tab. In this interface, you can select one of the two options mentioned further up, i.e. importing an existing certificate (`Add an SSL certificate`{.action}) and (`Order an SSL certificate`{.action}) managed automatically by your OVHcloud Load Balancer. +#### From the OVHcloud Control Panel -![Buttons for adding certificates](images/certificat.png){.thumbnail} +The list of SSL/TLS certificates configured on your OVHcloud Load Balancer service is in the `SSL Certificates`{.action} tab. This interface offers the 2 options mentioned above, namely importing an existing certificate (via the `Add an SSL certificate`{.action} button) and `Order an SSL certificate`{.action} managed automatically by your OVHcloud Load Balancer service. -If you choose to import an existing SSL/TLS certificate, click `Add an SSL certificate`{.action}. The *Private key* and *Certificate* fields are obligatory. +![Certificate addition buttons](images/certificat.png){.thumbnail} -Click `Add`{.action} once you have filled in the fields. Your certificate will appear in the certificate list. +If you choose to import an existing SSL/TLS certificate, click on `Add an SSL certificate`{.action}. The *Private Key* and *Certificate* fields are mandatory. -![Add an existing SSL certificate](images/add_certificat_custom.png){.thumbnail} +Click the `Add`{.action} button once the fields are filled in. Your certificate will then appear in the certificate list. -To add a Let's Encrypt certificate, click `Order an SSL certificate`{.action}, enter your domains, ensure that they point to your OVHcloud Load Balancer, and follow the instructions set out in the guides you receive. You will then see it appear in the list of available certificates. +![Adding an existing certificate](images/add_certificat_custom.png){.thumbnail} -![Order a Let’s Encrypt certificate](images/add_certificat_letsencrypt.png){.thumbnail} +To add a Let's Encrypt certificate, click on `Order an SSL certificate`{.action}, enter your domain, make sure it points to your OVHcloud Load Balancer service and follow the emails you receive. You will then see it appear in the list of available certificates. -Once your certificates have been configured, you can create a HTTPS front-end, on the same model as the HTTP front-end created earlier on with port 443, and the *SSL* option enabled. You can also choose to enable the *HSTS* option. With this option enabled, web browsers will remember that this website should *no longer* be visited without HTTPS after the first time the web user visits in HTTPS. This way, you can improve your infrastructure’s overall security by protecting it against ‘man-in-the-middle’ attacks, where a malicious party can make it seem as though your website is not available in HTTPS, forcing your web users to switch to HTTP. +![Ordering a Let's Encrypt certificate](images/add_certificat_letsencrypt.png){.thumbnail} + +Once your certificate(s) are configured, you can create an HTTPS frontend, on the same model as the HTTP frontend created above with port 443 and the *SSL* option enabled.
+Optionally, you can also enable the *HSTS* option. If this option is enabled, browsers will record that this website should *never again* be visited without HTTPS after their first visit in HTTPS. This strengthens overall security by protecting against "Man-in-the-middle" attacks in which a malicious actor could make your website appear unavailable in HTTPS and force your visitors to switch to "HTTP". > [!warning] +> Although the added security is significant, it is recommended to wait a while before enabling this option, to make sure there are no side effects in HTTPS. Indeed, once HSTS is enabled, there is no going back. > -> All though adding this additional level of security is important, we recommend waiting for a while before you enable this option, to ensure that there are no issues with your website forming HTTPS connections. Once HSTS has been enabled, you cannot undo the change. -> -### Via the API +#### From the OVHcloud API -- To list the SSL/TLS certificates in place: +- List the existing SSL/TLS certificates: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl > -- To view details on an SSL/TLS certificate: +- Get the details of an SSL/TLS certificate: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl/{id} > -- To add a new, existing SSL/TLS certificate: +- Adding a new existing SSL/TLS certificate: > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/ssl > -- To modify a specific SSL/TLS certificate (only the display name can be modified): +- Modifying a specific SSL/TLS certificate (only the displayed name can be modified) : > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/ssl/{id} > -- To delete a specific SSL/TLS certificate: +- Deleting a specific SSL/TLS certificate: > [!api] > > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/ssl/{id} > -## Apply the modifications +### Apply the changes -The modifications made to your OVHcloud Load Balancer must be *explicitly applied* in each of the zones configured for your OVHcloud Load Balancer service. Only then will they be visible to your website visitors. This way, you can make complex configuration changes in one go. +The changes made to your OVHcloud Load Balancer service must be *explicitly applied* in each of the zones configured for your OVHcloud Load Balancer service. Only then will they be visible to your visitors. This allows a complex configuration change to be made in a single step. -If you have several zones, you must apply the same configuration for each of them. +If you have several zones, you will have to apply the same configuration for each of your zones. -### Via the OVHcloud Control Panel. +#### From the OVHcloud Control Panel -Go to the page for your OVHcloud Load Balancer, and click `Apply configuration`{.action}. +Go to the home page of your OVHcloud Load Balancer service, click on the `...`{.action} dots next to the name of your service and click on `Apply the configuration`{.action}. -![Apply configuration](images/btn_apply_configuration.png){.thumbnail} +![Apply the configuration](images/btn_apply_configuration.png){.thumbnail} -Next, select the zones you want to deploy, and click `Apply configuration`{.action}. +Then select the list of zones you want to deploy and click on the `Apply the configuration`{.action} button. -![Apply configuration to zones](images/btn_apply_configuration_zones.png){.thumbnail} +![Apply the configuration zones](images/btn_apply_configuration_zones.png){.thumbnail} -### Via the API +#### From the OVHcloud API - Refresh a zone: @@ -343,10 +371,10 @@ Next, select the zones you want to deploy, and click `Apply configuration`{.acti > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh > -## Confirmation +### Validation -Once you have completed all of these steps, you should have a functional load balancing service. You can check the service status by visiting your website. +Once all these steps are completed, you should have a functional load balancing service. You can validate the status of the service by visiting your site. ## Go further -Join our community of users on . \ No newline at end of file +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_http_https/guide.en-us.md b/pages/network/load_balancer/create_http_https/guide.en-us.md index 8fb7329b659..37bcbfcdcec 100644 --- a/pages/network/load_balancer/create_http_https/guide.en-us.md +++ b/pages/network/load_balancer/create_http_https/guide.en-us.md @@ -1,81 +1,106 @@ --- -title: 'Configuring a HTTP/HTTPS OVH Load Balancer service' -excerpt: 'Find out how to configure an OVH Load Balancer service' -updated: 2023-11-22 +title: "Configuration of an OVHcloud Load Balancer service with HTTP/HTTPS" +excerpt: "Configure your OVHcloud Load Balancer to distribute HTTP traffic and secure your connections with HTTPS" +updated: 2025-11-12 --- -## Objective + -The purpose of this guide is to help you create your first HTTP/HTTPS service with the new OVHcloud Load Balancer solution. Here, we will set up a basic OVHcloud Load Balancer service configuration to balance the HTTP load for a service like a website. +## Objective -A front-end will be created to listen on port 80, while another listens on port 443 with an SSL/TLS certificate. These front-ends will be configured to direct their traffic to a common HTTP farm. This farm can have one or more servers, depending on the configuration you have chosen/adapted. +This guide aims to help you create your first HTTP/HTTPS service using the OVHcloud Load Balancer offer. We will configure a simple OVHcloud Load Balancer service to distribute HTTP traffic for a service, such as a website. -As a reminder, the OVHcloud Load Balancer has four primary components: +A frontend will be created to listen on port 80, while another will listen on port 443 with an SSL/TLS certificate. These frontends will be configured to direct their traffic to a common HTTP farm. This farm can have one or more servers, depending on the chosen / adapted configuration. -- `front-ends` -- server `farms` and their `servers` -- the advanced `routes` between the front-ends and server farms -- `SSL/TLS` connections that can encrypt TCP and/or HTTP connections +As a reminder, the OVHcloud Load Balancer service is composed of 4 elementary parts: -**This guide will show you how to configure an OVHcloud Load Balancer Service.** +- the `frontends`; +- the `farms` of servers and their `servers`; +- the advanced `routes` between Frontends and Server Farms; +- the `SSL/TLS` certificates allowing TCP and/or HTTP connections to be encrypted. ## Requirements -- an OVHcloud Load Balancer -- the ability to add and configure a farm, a server, a front-end and an SSL certificate +- Have an [OVHcloud Load balancer](/links/network/load-balancer) offer in your OVHcloud account +- You must be logged in to your [OVHcloud Control Panel](/links/manager) +- Have a configured farm +- Have a configured frontend +- Have an SSL certificate + +## Instructions -## Introduction +## Table of contents + +- [Add a server farm](#farm) +- [Add a server](#server) +- [Add a frontend](#frontend) +- [Add an SSL/TLS certificate](#certificate) +- [Apply the changes](#apply) +- [Validation](#validation) > [!warning] > -> This guide will take you through the steps required. Depending on the way you have designed your architecture, some configurations may vary. +> We will guide you through the different steps. Depending on your architecture choices, some configurations may differ. > -If you have not done so already, we recommend reading a general introduction to the OVHcloud Load Balancer service before you get started: [Introduction to the OVHcloud Load Balancer](/pages/network/load_balancer/use_presentation){.ref} +Before you start, it is recommended to consult the [OVHcloud Load Balancer presentation](/pages/network/load_balancer/use_presentation). > [!warning] > -> The order in which elements are created is important. In particular, the server farms must be configured before we can attach an SSL/TLS certificate or servers to them. The front-ends must be configured after the server farms in order to configure the front-end’s default farm. +> The order of element creation is important. In particular, server farms must be configured before being able to attach an SSL/TLS certificate or servers to them. Similarly, frontends must be configured after the server farms in order to be able to configure the frontend's default farm. > -In the control panel of the load balancer, you will see the features detailed below: +The features detailed below are accessible from the OVHcloud Control Panel: -![OVHcloud Load Balancer service](images/iplb_service.png){.thumbnail} +![OVHcloud Load Balancer Service](images/iplb_service.png){.thumbnail} -For more information on the Control Panel’s features, you can consult the following guide: [Managing the Load Balancer from the customer control panel](/pages/network/load_balancer/use-lb){.ref} +For more information about the features of the OVHcloud Control Panel, see the [Managing the Load Balancer service via the OVHcloud Control Panel](/pages/network/load_balancer/use-lb) page. -Similarly, this can be done via the OVHcloud API, in the section: +Via the OVHcloud API, use the following call: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing > -For more information on the API’s features, you can consult the following guide: [Load Balancer API Quick Reference](/pages/network/load_balancer/use_api_reference){.ref} - -## Add a server farm. +For more information on the API features, consult the page [API function details](/pages/network/load_balancer/use_api_details) -We will add a farm of HTTP servers to our service, which is the part that balances traffic on the servers. +### Add a server farm -### Via the OVHCloud Control Panel. +We will add an HTTP server farm to our service. This part is responsible for distributing traffic to the servers. -Log into the [OVHcloud Control Panel](/links/manager), click `Network`{.action} in the left-hand menu, then `Load Balancer`. Click on your load balancer service. +#### From the OVHcloud Control Panel -In the `Server farms`{.action} tab, click on the `Add a server farm`{.action} button. +In the `Server Farms`{.action} tab, click the `Add a server farm`{.action} button. -Fill in the fields. The only mandatory fields for a basic configuration are *Protocol* and *Datacentre*. We recommend explicitly defining a *Port* (generally port 80 for a web service). If no ports are specified, your OVHcloud Load Balancer will automatically use the same port as the corresponding front-end, and the probes will not be able to work as intended. +Fill in the fields. The only mandatory fields for a simple configuration are the *Protocol* and the *Datacentre*. It is recommended to explicitly define a *Port*, generally port 80 for a web service. If no port is specified, your OVHcloud Load Balancer will automatically use the same port as the corresponding frontend and the probes may not work as expected. -If you add several servers to your farm, we advise configuring an HTTP `availability probe`. When a probe is configured, the OVHcloud Load Balancer service can automatically disable a server that is down or under maintenance, so that your web users are not affected. +If you add several servers in your farm, it is recommended to configure an HTTP `availability probe`. When a probe is configured, the OVHcloud Load Balancer service can automatically disable a server that is down or under maintenance, in order not to affect visitors. -![Add a server farm via the Control Panel](images/add_backend.png){.thumbnail} +![Adding a server farm via the OVHcloud Control Panel](images/add_backend.png){.thumbnail} -Click `Add`{.action} once you have filled in the fields. +Click the `Add`{.action} button once you have filled in the fields. -Your server farm should appear in the list, in the `Server farms`{.action} tab. +Your server farm should appear in the list, under the `Server Farms`{.action} tab. -![Details of the server farm created](images/resume_backend.png){.thumbnail} +![Details of the created server farm](images/resume_backend.png){.thumbnail} -### Via the API +#### From the OVHcloud API - List of HTTP server farms: @@ -91,48 +116,46 @@ Your server farm should appear in the list, in the `Server farms`{.action} tab. > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId} > -- Add a new HTTP server farm: +- Adding a new HTTP server farm: > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm > -- Modify a specific server farm: +- Modifying a specific server farm: > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId} > -- Delete a specific server farm: +- Deleting a specific server farm: > [!api] > > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId} > -## Add a server. +### Add a server We will now add a server to our server farm. -### Via the OVHcloud Control Panel. +#### From the OVHcloud Control Panel -Log into the [OVHcloud Control Panel](/links/manager), click `Network`{.action} in the left-hand menu, then `Load Balancer`. Click on your load balancer service. +Still in the `Server Farms`{.action} tab, select the farm to which you want to add a server by clicking on the corresponding line. The list of servers already configured in the farm appears below the list of farms, as well as the `Add a server`{.action} button. Click on this button to add a new server. -In the `Server farms`{.action} tab, select the farm you want to add a server to by clicking on the corresponding line. The list of servers already configured in the farm will appear beneath the list of farms, along with the `Add a server`{.action} button. Click on this button to add a new server. +Only the *IPv4 Address* field is mandatory. If a server does not use the same port as the one defined above in the farm, it is possible to override it in the server configuration. However, in order to maintain the most homogeneous and maintainable configuration possible, it is recommended to use this parameter only in advanced cases. -Only the *IPv4 address* field is mandatory. If a server does not use the same port as the one defined earlier in the farm, you may overload it by configuring a server. However, to keep the configuration as standardised and easy to maintain as possible, we recommend only using this parameter in advanced cases. +![Adding a server to a Farm.](images/add_server.png){.thumbnail} -![Add a server to a farm.](images/add_server.png){.thumbnail} +Click the `Add`{.action} button once you have filled in the fields. -Click `Add`{.action} once you have filled in the fields. +Your server should appear in the list of servers, in the `Server Farms`{.action} tab, just below the list of farms. -Your server should appear in the server list, in the `Server farm`{.action} tab, just below the list of farms. +![Details of the created server.](images/resume_server.png){.thumbnail} -![Details of the server created.](images/resume_server.png){.thumbnail} - -### Via the API +#### From the OVHcloud API - List of servers in the farm: @@ -148,193 +171,198 @@ Your server should appear in the server list, in the `Server farm`{.action} tab, > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId} > -- Add a new server: +- Adding a new server: > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server > -- Modify a specific server: +- Modifying a specific server: > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server > -- Delete a specific server: +- Deleting a specific server: > [!api] > > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server > -## Add a front-end. +### Add a frontend -We will now add a `front-end` to our service, and connect it to our server farm. The front-end is the part of your OVHcloud Load Balancer that exposes your service on the internet. First, we will only configure it in HTTP, without an SSL/TLS certificate. +We will now add a `frontend` to our service and connect it to our server farm. The frontend is the part of your OVHcloud Load Balancer that is used to expose your service on the Internet. At first, we will configure it in HTTP only, without an SSL/TLS certificate. -### Via the OVHcloud Control Panel. +#### From the OVHcloud Control Panel -Go to the `Front-ends`{.action} tab, and click `Add a front-end`{.action}. +In the `Frontends`{.action} tab, click the `Add a frontend`{.action} button. -Fill in the fields. The only mandatory fields for a basic configuration are *Protocol*, *Port* (80 for a standard HTTP web service) and *Datacentre*. If you want your service to be available across several ports at once, you can specify a list of ports, separated by commas, or a range of ports, in the format "START_PORT-END_PORT". +Fill in the fields. The only mandatory fields for a simple configuration are the *Protocol*, the *Port* (80 for a standard HTTP web service) and the *Datacentre*. If you want your service to be available on several ports at the same time, you can specify a list of ports separated by commas or a range of ports in the form "START_PORT-END_PORT". -If you have routed Additional IPs to your OVHcloud Load Balancer service, you can also attach a front-end to one or more specific Additional IPs. +If you have routed Additional IPs to your OVHcloud Load Balancer service, you can also attach a frontend to one or more specific Additional IPs. -![Add a front-end](images/add_frontend.png){.thumbnail} +![Adding a frontend](images/add_frontend.png){.thumbnail} -Click `Add`{.action} once you have filled in the fields. +Click the `Add`{.action} button once you have filled in the fields. -Your front-end must appear in the list, in the `Front-ends`{.action} tab. +Your frontend should appear in the list, under the `Frontends`{.action} tab. -![Details of the front-end created](images/resume_frontend.png){.thumbnail} +![Details of the created frontend](images/resume_frontend.png){.thumbnail} -### Via the API +#### From the OVHcloud API -- List of HTTP front-ends: +- List of HTTP frontends: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend > -- Details of a specific front-end: +- Details of a specific frontend: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend/{frontendId} > -- Add a new front-end: +- Adding a new frontend: > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend > -- Modify a specific front-end: +- Modifying a specific frontend: > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId} > -- Delete a specific front-end: +- Deleting a specific frontend: > [!api] > > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/frontend/{frontendId} > -## Add an SSL/TLS certificate. +### Add an SSL/TLS certificate -The section above described the general configuration of a HTTP front-end. This next section describes the additional steps you need to take to activate support of HTTPS protocol on an HTTP front-end. In particular, you need to: +The previous section described the general configuration for an HTTP frontend. This section describes the additional steps to enable support for the HTTPS protocol on an HTTP frontend. In particular, you will need to: -- switch over the front-end to port 443, which is standard for HTTPS protocol -- configure an SSL/TLS certificate to authenticate and encrypt connections +- switch the frontend to port 443, the standard port for the HTTPS protocol; +- configure an SSL/TLS certificate to authenticate and encrypt the connections. -Whether you choose to configure your service via the API or the OVHcloud Control Panel, you can choose from two methods for adding an SSL/TLS certificate. The choice of method will depend on your needs, as well as the solutions currently set up. You can either: +Whether you choose a configuration via the API or via the OVHcloud Control Panel, you will have a choice between 2 strategies for your SSL/TLS certificates. This choice depends on your needs as well as the current solutions in place: - Import an existing SSL/TLS certificate. -- Order an automatically managed SSL/TLS certificate. DV and EV certificates will be available to order soon. +- Order an automatically managed SSL/TLS certificate. The ordering of DV and EV certificates will be available soon. -If you choose to import an SSL/TLS certificate that you have already ordered and managed yourself, you will need to renew it periodically yourself, and update it in your OVHcloud Load Balancer service. Most certificates are valid for one year. Some remain valid for longer periods of time. However, Let's Encrypt certificates need to be renewed every three months. We recommend using your OVHcloud Load Balancer to automatically manage the service for Let’s Encrypt certificates, so that you do not miss the expiry dates. +If you choose to import an SSL/TLS certificate that you have ordered and managed yourself, you will have to renew it periodically yourself and update it in your OVHcloud Load Balancer service. Most certificates are valid for 1 year. Some may be valid for longer. Let's Encrypt certificates are valid for 3 months. It is recommended to use the service managed automatically by your OVHcloud Load Balancer for Let's Encrypt certificates in order not to accidentally miss a deadline. -If you opt for a certificate managed by the OVHcloud Load Balancer service, it will be automatically ordered, validated, installed and renewed periodically by your OVHcloud Load Balancer. For the validation and renewal operations to work, the domains you are ordering this certificate for need to be routed to your OVHcloud Load Balancer service. This means that your domain’s *A* and *AAAA* DNS records must point to your OVHcloud Load Balancer’s IPv4 and IPv6 fields respectively, or to one of its Additional IPs. When you order, you will receive an email that will guide you through the validation steps. +If you choose a certificate managed by your OVHcloud Load Balancer service, it will be automatically ordered, validated, installed and renewed periodically by your OVHcloud Load Balancer.
+For the validation and renewal operations to work, the domain(s) you are ordering this certificate for must be routed to your OVHcloud Load Balancer service. This implies that the *A* and *AAAA* fields of your domain point respectively to the IPv4 and IPv6 of your OVHcloud Load Balancer or one of its Additional IPs. During the order, you will receive an email that will guide you through the validation steps. +> [!primary] > -> To ensure that your service remains accessible when you switch your domain to your OVHcloud Load Balancer service’s IP address in order to validate your certificate, it is good practice to start by configuring and testing all of the HTTP configuration on port 80. This way, your website will remain accessible without any interruptions. -> If the website already has a HTTPS connection and you want to switch to certificates managed by your OVHcloud Load Balancer service, you can import your existing certificates, configure and test your HTTPS front-end, and order a new certificate for the same domain. It will be taken into account automatically when your old certificate expires. +> To ensure service continuity when switching your domain to the IP of your OVHcloud Load Balancer service to validate your certificate, a good practice is to first configure and fully test the HTTP configuration on port 80. This way, your site remains accessible without interruption. +> If your site already has an HTTPS connection and you want to migrate to certificates managed by your OVHcloud Load Balancer service, you can import your existing certificates, configure and test your HTTPS Frontend and finally order a new certificate for the same domain. It will be automatically taken into account before your old certificate expires. > -The certificates configured on your OVHcloud Load Balancer service are automatically available for all of the front-ends on your service that have *SSL* options enabled. +The certificates configured on your OVHcloud Load Balancer service are automatically available for all frontends of your OVHcloud Load Balancer service on which the *SSL* option is enabled. #### TLS 1.3 support -With the constant evolution of Internet security standards, OVHcloud is committed to providing the latest and most secure technologies for your services. The OVHcloud Load Balancer now supports TLS 1.3. -##### What is TLS 1.3? -TLS 1.3 is the latest version of the TLS protocol, offering significant improvements in security and performance over TLS 1.2. Key benefits include a faster handshake process, reducing the time needed to establish secure connections, and the use of more secure cipher suites to strengthen the security of transmitted data. +With the constant evolution of security standards on the Internet, OVHcloud is committed to providing the most recent and secure technologies for your services. The OVHcloud Load Balancer now supports TLS 1.3. + +##### **What is TLS 1.3?** + +TLS 1.3 is the latest version of the TLS protocol, offering significant improvements in terms of security and performance compared to TLS 1.2. The key advantages include a faster *handshake* process, thus reducing the time needed to establish secure connections, and the use of safer encryption suites to strengthen the security of transmitted data. -##### Why use TLS 1.3 with OVHcloud Load Balancer? -By integrating TLS 1.3, your OVHcloud Load Balancer will benefit from enhanced security and improved performance, ensuring an optimal user experience for your visitors. Reduced handshake times speed up page loading, while security enhancements ensure that your data is protected with the latest, most secure standards. +##### **Why use TLS 1.3 with OVHcloud Load Balancer?** -### Via the OVHcloud Control Panel. +By integrating TLS 1.3, your OVHcloud Load Balancer will benefit from enhanced security and improved performance, ensuring an optimal user experience for your visitors. The reduction in *handshake* time speeds up page loading, while the security improvements ensure that your data is protected with the most recent and secure standards. -The list of SSL/TLS certificates configured on the OVHcloud Load Balancer can be found in the `SSL certificates`{.action} tab. In this interface, you can select one of the two options mentioned further up, i.e. importing an existing certificate (`Add an SSL certificate`{.action}) and (`Order an SSL certificate`{.action}) managed automatically by your OVHcloud Load Balancer. +#### From the OVHcloud Control Panel -![Buttons for adding certificates](images/certificat.png){.thumbnail} +The list of SSL/TLS certificates configured on your OVHcloud Load Balancer service is in the `SSL Certificates`{.action} tab. This interface offers the 2 options mentioned above, namely importing an existing certificate (via the `Add an SSL certificate`{.action} button) and `Order an SSL certificate`{.action} managed automatically by your OVHcloud Load Balancer service. -If you choose to import an existing SSL/TLS certificate, click `Add an SSL certificate`{.action}. The *Private key* and *Certificate* fields are obligatory. +![Certificate addition buttons](images/certificat.png){.thumbnail} -Click `Add`{.action} once you have filled in the fields. Your certificate will appear in the certificate list. +If you choose to import an existing SSL/TLS certificate, click on `Add an SSL certificate`{.action}. The *Private Key* and *Certificate* fields are mandatory. -![Add an existing SSL certificate](images/add_certificat_custom.png){.thumbnail} +Click the `Add`{.action} button once the fields are filled in. Your certificate will then appear in the certificate list. -To add a Let's Encrypt certificate, click `Order an SSL certificate`{.action}, enter your domains, ensure that they point to your OVHcloud Load Balancer, and follow the instructions set out in the guides you receive. You will then see it appear in the list of available certificates. +![Adding an existing certificate](images/add_certificat_custom.png){.thumbnail} -![Order a Let’s Encrypt certificate](images/add_certificat_letsencrypt.png){.thumbnail} +To add a Let's Encrypt certificate, click on `Order an SSL certificate`{.action}, enter your domain, make sure it points to your OVHcloud Load Balancer service and follow the emails you receive. You will then see it appear in the list of available certificates. -Once your certificates have been configured, you can create a HTTPS front-end, on the same model as the HTTP front-end created earlier on with port 443, and the *SSL* option enabled. You can also choose to enable the *HSTS* option. With this option enabled, web browsers will remember that this website should *no longer* be visited without HTTPS after the first time the web user visits in HTTPS. This way, you can improve your infrastructure’s overall security by protecting it against ‘man-in-the-middle’ attacks, where a malicious party can make it seem as though your website is not available in HTTPS, forcing your web users to switch to HTTP. +![Ordering a Let's Encrypt certificate](images/add_certificat_letsencrypt.png){.thumbnail} + +Once your certificate(s) are configured, you can create an HTTPS frontend, on the same model as the HTTP frontend created above with port 443 and the *SSL* option enabled.
+Optionally, you can also enable the *HSTS* option. If this option is enabled, browsers will record that this website should *never again* be visited without HTTPS after their first visit in HTTPS. This strengthens overall security by protecting against "Man-in-the-middle" attacks in which a malicious actor could make your website appear unavailable in HTTPS and force your visitors to switch to "HTTP". > [!warning] +> Although the added security is significant, it is recommended to wait a while before enabling this option, to make sure there are no side effects in HTTPS. Indeed, once HSTS is enabled, there is no going back. > -> All though adding this additional level of security is important, we recommend waiting for a while before you enable this option, to ensure that there are no issues with your website forming HTTPS connections. Once HSTS has been enabled, you cannot undo the change. -> -### Via the API +#### From the OVHcloud API -- To list the SSL/TLS certificates in place: +- List the existing SSL/TLS certificates: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl > -- To view details on an SSL/TLS certificate: +- Get the details of an SSL/TLS certificate: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl/{id} > -- To add a new, existing SSL/TLS certificate: +- Adding a new existing SSL/TLS certificate: > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/ssl > -- To modify a specific SSL/TLS certificate (only the display name can be modified): +- Modifying a specific SSL/TLS certificate (only the displayed name can be modified) : > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/ssl/{id} > -- To delete a specific SSL/TLS certificate: +- Deleting a specific SSL/TLS certificate: > [!api] > > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/ssl/{id} > -## Apply the modifications +### Apply the changes -The modifications made to your OVHcloud Load Balancer must be *explicitly applied* in each of the zones configured for your OVHcloud Load Balancer service. Only then will they be visible to your website visitors. This way, you can make complex configuration changes in one go. +The changes made to your OVHcloud Load Balancer service must be *explicitly applied* in each of the zones configured for your OVHcloud Load Balancer service. Only then will they be visible to your visitors. This allows a complex configuration change to be made in a single step. -If you have several zones, you must apply the same configuration for each of them. +If you have several zones, you will have to apply the same configuration for each of your zones. -### Via the OVHcloud Control Panel. +#### From the OVHcloud Control Panel -Go to the page for your OVHcloud Load Balancer, and click `Apply configuration`{.action}. +Go to the home page of your OVHcloud Load Balancer service, click on the `...`{.action} dots next to the name of your service and click on `Apply the configuration`{.action}. -![Apply configuration](images/btn_apply_configuration.png){.thumbnail} +![Apply the configuration](images/btn_apply_configuration.png){.thumbnail} -Next, select the zones you want to deploy, and click `Apply configuration`{.action}. +Then select the list of zones you want to deploy and click on the `Apply the configuration`{.action} button. -![Apply configuration to zones](images/btn_apply_configuration_zones.png){.thumbnail} +![Apply the configuration zones](images/btn_apply_configuration_zones.png){.thumbnail} -### Via the API +#### From the OVHcloud API - Refresh a zone: @@ -343,10 +371,10 @@ Next, select the zones you want to deploy, and click `Apply configuration`{.acti > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh > -## Confirmation +### Validation -Once you have completed all of these steps, you should have a functional load balancing service. You can check the service status by visiting your website. +Once all these steps are completed, you should have a functional load balancing service. You can validate the status of the service by visiting your site. ## Go further -Join our community of users on . \ No newline at end of file +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_http_https/guide.fr-ca.md b/pages/network/load_balancer/create_http_https/guide.fr-ca.md index 1e8eacde8fb..e59f4190b12 100644 --- a/pages/network/load_balancer/create_http_https/guide.fr-ca.md +++ b/pages/network/load_balancer/create_http_https/guide.fr-ca.md @@ -1,14 +1,31 @@ --- title: "Configuration d'un service OVHcloud Load Balancer avec HTTP/HTTPS" -excerpt: Configuration d’un service Load Balancer -updated: 2023-11-22 +excerpt: "Découvrez comment configurer votre Load Balancer OVHcloud pour répartir la charge HTTP et sécuriser vos connexions avec HTTPS" +updated: 2025-11-12 --- + + ## Objectif -Ce guide a pour but de vous aider à créer votre premier service HTTP/HTTPS avec l'offre OVHcloud Load Balancer OVHcloud. Nous allons ici configurer un service OVHcloud Load Balancer simple pour répartir la charge HTTP d'un service, tel qu'un site web. +Ce guide a pour but de vous aider à créer votre premier service HTTP/HTTPS avec l'offre OVHcloud Load Balancer. Nous allons ici configurer un service OVHcloud Load Balancer simple pour répartir la charge HTTP d'un service, tel qu'un site web. -Un frontend sera créé pour écouter sur le port 80, tandis qu'un autre écoutera sur le port 443 avec un certificat SSL/TLS. Ces frontends seront configurés pour diriger leur trafic vers une ferme HTTP commune. Cette ferme peut disposer d'un ou plusieurs serveurs, selon la configuration choisie / adaptée. +Un frontend sera créé pour écouter sur le port 80, tandis qu'un autre écoutera sur le port 443 avec un certificat SSL/TLS. Ces frontends seront configurés pour diriger leur trafic vers une ferme HTTP commune. Cette ferme peut disposer d'un ou plusieurs serveurs, selon la configuration choisie/adaptée. Pour rappel, le service OVHcloud Load Balancer est composé de 4 parties élémentaires : @@ -17,6 +34,8 @@ Pour rappel, le service OVHcloud Load Balancer est composé de 4 parties éléme - les `routes` avancées entre les Frontends et les Fermes de serveurs ; - les certificats `SSL/TLS` permettant de chiffrer les connexions TCP et/ou HTTP. +**Découvrez comment configurer votre service Load Balancer OVHcloud pour répartir la charge HTTP et sécuriser vos connexions avec HTTPS.** + ## Prérequis - Posséder une offre [OVHcloud Load balancer](/links/network/load-balancer) dans votre compte OVHcloud. @@ -27,19 +46,28 @@ Pour rappel, le service OVHcloud Load Balancer est composé de 4 parties éléme ## En pratique +## Sommaire + +- [Ajouter une ferme de serveurs](#farm) +- [Ajouter un serveur](#server) +- [Ajouter un frontend](#frontend) +- [Ajouter un certificat SSL/TLS](#certificate) +- [Appliquer les modifications](#apply) +- [Validation](#validation) + > [!warning] > > Nous allons vous guider au travers des différentes étapes. Selon vos choix d'architecture, certaines configurations peuvent différer. > -Avant de vous lancer, si vous ne l'avez pas encore lue, nous vous conseillons de consulter la présentation générale du service OVHcloud Load Balancer: [Présentation de l'OVHcloud Load Balancer](/pages/network/load_balancer/use_presentation). +Avant de vous lancer, il est conseillé de consulter la [présentation du service OVHcloud Load Balancer](/pages/network/load_balancer/use_presentation). > [!warning] > > L'ordre de création des éléments est important. En particulier, les fermes de serveurs doivent être configurées avant de pouvoir leur attacher un certificat SSL/TLS ou des serveurs. De même, les frontends doivent être configurés après les fermes de serveurs afin de pouvoir configurer la ferme par défaut du frontend. > -Dans l'espace client OVHcloud, nous allons retrouver les fonctionnalités détaillées ci-dessous: +Les fonctionnalités détaillées ci-dessous sont accessibles depuis l'espace client OVHcloud : ![Service OVHcloud Load Balancer](images/iplb_service.png){.thumbnail} @@ -52,25 +80,25 @@ Via l'API OVHcloud, utilisez l'appel suivant : > @api {v1} /ipLoadbalancing GET /ipLoadbalancing > -Pour plus d'informations sur les fonctionnalités de l'API, consultez la page [Détails des fonctions API](/pages/network/load_balancer/use_api_details){.ref} +Pour plus d'informations sur les fonctionnalités de l'API, consultez la page [Détails des fonctions API](/pages/network/load_balancer/use_api_details) -### Ajouter une ferme de serveurs +### Ajouter une ferme de serveurs -Nous allons ajouter une ferme de serveurs HTTP à notre service, la partie en charge de répartir le trafic sur les serveurs. +Nous allons ajouter une ferme de serveurs HTTP à notre service. Cette partie est en charge de répartir le trafic sur les serveurs. #### Depuis l'espace client OVHcloud Dans l'onglet `Fermes de serveurs`{.action}, cliquez sur le bouton `Ajouter une ferme de serveurs`{.action}. -Remplissez les champs. Les seuls champs obligatoires pour une configuration simple sont le *Protocole* et le *Datacentre*. Il est recommandé de définir explicitement un *Port*, généralement le port 80 pour un service web. Si aucun port n'est spécifié, votre OVHcloud Load Balancer utilisera automatiquement le même port que le frontend correspondant et les sondes pourront ne pas fonctionner comme prévu. +Remplissez les champs. Les seuls champs obligatoires pour une configuration simple sont le *Protocole* et le *Datacentre*. Il est recommandé de définir explicitement un *Port*, généralement le port 80 pour un service web. Si aucun port n'est spécifié, votre service OVHcloud Load Balancer utilisera automatiquement le même port que le frontend correspondant et les sondes pourront ne pas fonctionner comme prévu. Si vous ajoutez plusieurs serveurs dans votre ferme, il est recommandé de configurer une `sonde de disponibilité` HTTP. Lorsqu'une sonde est configurée, le service OVHcloud Load Balancer pourra automatiquement désactiver un serveur qui serait en panne ou en maintenance, de manière à ne pas affecter les visiteurs. -![Ajout d'une ferme de serveurs via le Manager](images/add_backend.png){.thumbnail} +![Ajout d'une ferme de serveurs via l'espace client OVHcloud](images/add_backend.png){.thumbnail} Cliquez sur le bouton `Ajouter`{.action} une fois les champs remplis. -Votre ferme de serveurs devrait apparaitre dans la liste, sous l'onglet `Fermes de serveurs`{.action}. +Votre ferme de serveurs devrait apparaître dans la liste, sous l'onglet `Fermes de serveurs`{.action}. ![Détails de la ferme de serveurs créée](images/resume_backend.png){.thumbnail} @@ -111,13 +139,13 @@ Votre ferme de serveurs devrait apparaitre dans la liste, sous l'onglet `Fermes > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId} > -### Ajouter un Serveur +### Ajouter un serveur Nous allons maintenant ajouter un serveur à notre ferme de serveurs. #### Depuis l'espace client OVHcloud -Toujours dans l'onglet `Fermes de serveurs`{.action}, sélectionnez la ferme dans laquelle vous souhaitez ajouter un serveur en cliquant sur la ligne correspondante. La liste des Serveurs déjà configurés dans la ferme apparaît en dessous de la liste des fermes, ainsi qu'un bouton `Ajouter un serveur`{.action}. Cliquez sur ce bouton pour ajouter un nouveau serveur. +Toujours dans l'onglet `Fermes de serveurs`{.action}, sélectionnez la ferme à laquelle vous souhaitez ajouter un serveur en cliquant sur la ligne correspondante. La liste des serveurs déjà configurés dans la ferme apparaît en dessous de la liste des fermes, ainsi qu'un bouton `Ajouter un serveur`{.action}. Cliquez sur ce bouton pour ajouter un nouveau serveur. Seul le champ *Adresse IPv4* est obligatoire. Si un serveur n'utilise pas le même port que celui défini plus haut dans la ferme, il est possible de le surcharger dans la configuration du serveur. Cependant, afin de conserver une configuration la plus homogène et maintenable possible, il est recommandé de n'utiliser ce paramètre que dans les cas avancés. @@ -152,7 +180,7 @@ Votre serveur devrait apparaître dans la liste des serveurs, dans l'onglet `Fer > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server > -- Modification d'un Serveur spécifique : +- Modification d'un serveur spécifique : > [!api] > @@ -166,9 +194,9 @@ Votre serveur devrait apparaître dans la liste des serveurs, dans l'onglet `Fer > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server > -### Ajouter un frontend +### Ajouter un frontend -Nous allons maintenant ajouter un `frontend` à notre service et le connecter à notre ferme de serveurs. Le frontend est la partie de votre OVHcloud Load Balancer qui sert à exposer votre service sur Internet. Dans un premier temps, nous allons le configurer en HTTP uniquement, sans certificat SSL/TLS. +Nous allons maintenant ajouter un `frontend` à notre service et le connecter à notre ferme de serveurs. Le frontend est la partie de votre service OVHcloud Load Balancer qui sert à exposer votre service sur Internet. Dans un premier temps, nous allons le configurer en HTTP uniquement, sans certificat SSL/TLS. #### Depuis l'espace client OVHcloud @@ -223,40 +251,46 @@ Votre frontend devrait apparaître dans la liste, sous l'onglet `Frontends`{.act > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/frontend/{frontendId} > -### Ajouter un certificat SSL/TLS +### Ajouter un certificat SSL/TLS -La section précédente décrivait la configuration générale pour un frontend HTTP. Cette section décrit les étapes supplémentaires pour activer le support du protocole HTTPS sur un Frontend HTTP. En particulier, il faudra : +La section précédente décrivait la configuration générale pour un frontend HTTP. Cette section décrit les étapes supplémentaires pour activer le support du protocole HTTPS sur un frontend HTTP. En particulier, il faudra : -- basculer le Frontend sur le port 443, standard pour le protocole HTTPS ; +- basculer le frontend sur le port 443, standard pour le protocole HTTPS ; - configurer un certificat SSL/TLS afin d'authentifier et chiffrer les connexions. -Que vous optiez pour une configuration via l'API ou via l'espace client OVHcloud, vous aurez le choix entre 2 stratégies pour vos certificats SSL/TLS, ce choix dépendant de vos besoins ainsi que des solutions actuellement en place : +Que vous optiez pour une configuration via l'API ou via l'espace client OVHcloud, vous aurez le choix entre 2 stratégies pour vos certificats SSL/TLS : - Importer un certificat SSL/TLS existant. -- Commander un certificat SSL/TLS géré automatiquement. La commande de certificats DV et EV arrivera prochainement. +- Commander un certificat SSL/TLS géré automatiquement. La commande de certificats DV et EV sera disponible prochainement. -Si vous optez pour l'importation d'un certificat SSL/TLS commandé et géré par vos soins, vous devrez le renouveler périodiquement vous-même et le mettre à jour dans votre service OVHcloud Load Balancer. La majorité des certificats sont valides pour 1 an. Certains peuvent l'être plus longtemps. Les certificats Let's Encrypt ne sont quant à eux valides que 3 mois. Il est recommandé d'utiliser le service géré automatiquement par votre OVHcloud Load Balancer pour les certificats Let's Encrypt afin de ne pas accidentellement rater une échéance. +> [!primary] +> +> Ce choix dépend de vos besoins ainsi que des solutions actuellement en place. + +Si vous optez pour l'importation d'un certificat SSL/TLS commandé et géré par vos soins, vous devrez le renouveler périodiquement vous-même et le mettre à jour dans votre service OVHcloud Load Balancer. La majorité des certificats sont valides pour 1 an. Certains peuvent l'être plus longtemps. Les certificats `Let's Encrypt` ne sont quant à eux valides que 3 mois. Il est recommandé d'utiliser le service géré automatiquement par votre service OVHcloud Load Balancer pour les certificats `Let's Encrypt` afin de ne pas accidentellement rater une échéance. Si vous optez pour un certificat géré par votre service OVHcloud Load Balancer, celui-ci sera automatiquement commandé, validé, installé et renouvelé périodiquement par votre OVHcloud Load Balancer.
-Pour que les opérations de validation et de renouvellement fonctionnent, il est nécessaire que le ou les domaines pour lesquels vous commandez ce certificat soient routés vers votre service OVHcloud Load Balancer. Cela implique que les champs *A* et *AAAA* de votre domaine pointent respectivement sur l'IPv4 et l'IPv6 de votre OVHcloud Load Balancer ou l'une de ses Additional IPs. Lors de la commande, vous recevrez un email qui vous guidera dans les étapes de la validation. +Pour que les opérations de validation et de renouvellement fonctionnent, il est nécessaire que le ou les domaines pour lesquels vous commandez ce certificat soient routés vers votre service OVHcloud Load Balancer. Cela implique que les champs *A* et *AAAA* de votre domaine pointent respectivement sur l'IPv4 et l'IPv6 de votre Load Balancer ou l'une de ses Additional IPs. Lors de la commande, vous recevrez un e-mail qui vous guidera dans les étapes de la validation. > [!primary] > -> Pour assurer la continuité de service lors du basculement de votre domaine vers l'IP de votre service OVHcloud Load Balancer afin de valider votre certificat, une bonne pratique est de commencer par configurer et tester complètement la configuration HTTP sur le port 80. De cette manière, votre site reste accessible sans interruption. +> Pour assurer la continuité de service lors du basculement de votre domaine vers l'IP de votre service OVHcloud Load Balancer afin de valider votre certificat, une bonne pratique consiste à commencer par configurer et tester complètement la configuration HTTP sur le port 80. De cette manière, votre site reste accessible sans interruption. > Si votre site dispose déjà d'une connexion HTTPS et que vous souhaitez migrer vers des certificats gérés par votre service OVHcloud Load Balancer, vous pouvez importer vos certificats existants, configurer et tester votre Frontend HTTPS et enfin commander un nouveau certificat pour le même domaine. Il sera automatiquement pris en compte avant l'expiration de votre ancien certificat. > -Les certificats configurés sur votre service OVHcloud Load Balancer sont automatiquement disponibles pour l'ensemble des frontend de votre service OVHcloud Load Balancer sur lesquels l'options *SSL* est activée. +Les certificats configurés sur votre service OVHcloud Load Balancer sont automatiquement disponibles pour l'ensemble des frontends de votre service OVHcloud Load Balancer sur lesquels l'option *SSL* est activée. #### Support de TLS 1.3 + Avec l'évolution constante des normes de sécurité sur Internet, OVHcloud s'engage à fournir les technologies les plus récentes et les plus sûres pour vos services. Le Load Balancer OVHcloud supporte désormais TLS 1.3. -##### Qu'est-ce que TLS 1.3 ? -TLS 1.3 est la dernière version du protocole TLS, offrant des améliorations significatives en matière de sécurité et de performance par rapport à TLS 1.2. Les avantages clés incluent un processus de handshake plus rapide, réduisant ainsi le temps nécessaire pour établir des connexions sécurisées, et l'utilisation de suites de chiffrement plus sûres pour renforcer la sécurité des données transmises. +##### **Qu'est-ce que TLS 1.3 ?** + +TLS 1.3 est la dernière version du protocole TLS. Elle améliore significativement la sécurité et les performances par rapport à TLS 1.2, notamment grâce à un processus de *handshake* plus rapide, réduisant le temps nécessaire pour établir des connexions sécurisées, et à l’utilisation de suites de chiffrement plus sûres pour renforcer la sécurité des données transmises. -##### Pourquoi utiliser TLS 1.3 avec OVHcloud Load Balancer ? +##### **Pourquoi utiliser TLS 1.3 avec OVHcloud Load Balancer ?** -En intégrant TLS 1.3, votre Load Balancer OVHcloud bénéficiera d'une sécurité renforcée et d'une performance améliorée, assurant une expérience utilisateur optimale pour vos visiteurs. La réduction du temps de handshake accélère le chargement des pages, tandis que les améliorations de sécurité garantissent que vos données sont protégées avec les normes les plus récentes et les plus sûres. +En intégrant TLS 1.3, votre service OVHcloud Load Balancer bénéficiera d'une sécurité renforcée et d'une performance améliorée, assurant une expérience utilisateur optimale pour vos visiteurs. La réduction du temps de *handshake* accélère le chargement des pages, tandis que les améliorations de sécurité garantissent que vos données sont protégées avec les normes les plus récentes et les plus sûres. #### Depuis l'espace client OVHcloud @@ -270,12 +304,12 @@ Cliquez sur le bouton `Ajouter`{.action} une fois les champs remplis. Votre cert ![Ajout d'un certificat existant](images/add_certificat_custom.png){.thumbnail} -Pour ajouter un certificat Let's Encrypt, cliquez sur `Commander un certificat SSL`{.action}, renseignez votre domaine, assurez vous que celui-ci pointe bien sur votre service OVHcloud Load Balancer et laissez-vous guider par les e-mails que vous recevrez. Vous le verrez ensuite apparaître dans la liste des certificats disponibles. +Pour ajouter un certificat `Let's Encrypt`, cliquez sur `Commander un certificat SSL`{.action}, renseignez votre domaine, assurez-vous que celui-ci pointe bien sur votre service OVHcloud Load Balancer et laissez-vous guider par les e-mails que vous recevrez. Vous le verrez ensuite apparaître dans la liste des certificats disponibles. ![Command d'un certificat Let's Encrypt](images/add_certificat_letsencrypt.png){.thumbnail} -Une fois votre / vos certificats configurés, vous pouvez créer un frontend HTTPS, sur le même modèle que le frontend HTTP créé plus haut avec le port 443 et l'option *SSL* active.
-Optionnellement, vous pouvez également activer l'option *HSTS*. Si cette option est active, les navigateurs enregistreront que ce site Internet ne doit *plus jamais* être visité sans HTTPS après leur première visite en HTTPS. Cela permet de renforcer la sécurité globale en se protégeant contre les attaques de type « Homme du milieu » dans laquelle un acteur malveillant pour faire croire que votre site Internet n'est pas disponible en HTTPS et forcer vos visiteurs à basculer en « HTTP ». +Une fois votre/vos certificats configurés, vous pouvez créer un frontend HTTPS, sur le même modèle que le frontend HTTP créé plus haut avec le port 443 et l'option *SSL* active.
+Optionnellement, vous pouvez également activer l'option *HSTS*. Si cette option est active, les navigateurs enregistreront que ce site Internet ne doit *plus jamais* être visité sans HTTPS après leur première visite en HTTPS. Cela permet de renforcer la sécurité globale en se protégeant contre les attaques de type « Homme du milieu » dans laquelle un acteur malveillant pourrait faire croire que votre site Internet n'est pas disponible en HTTPS et forcer vos visiteurs à basculer en « HTTP ». > [!warning] > @@ -319,9 +353,9 @@ Optionnellement, vous pouvez également activer l'option *HSTS*. Si cette option > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/ssl/{id} > -### Appliquer les modifications +### Appliquer les modifications -Les modifications apportées à votre service OVHcloud Load Balancer soivent être *appliquées explicitement* dans chacune des zones configurées pour votre service OVHcloud Load Balancer. C'est seulement à ce moment qu'elles seront visibles pour vos visiteurs. Cela permet de faire un changement complexe de configuration en une seule fois. +Les modifications apportées à votre service OVHcloud Load Balancer doivent être *appliquées explicitement* dans chacune des zones configurées pour votre service OVHcloud Load Balancer. C'est seulement à ce moment qu'elles seront visibles pour vos visiteurs. Cela permet de faire un changement complexe de configuration en une seule fois. Si vous avez plusieurs zones, vous devrez appliquer la même configuration pour chacune de vos zones. @@ -331,7 +365,7 @@ Rendez-vous sur la page d'accueil de votre service OVHcloud Load Balancer et cli ![Appliquer la configuration](images/btn_apply_configuration.png){.thumbnail} -Selectionnez ensuite la liste des zones que vous souhaitez deployer et cliquez sur le bouton `Appliquer la configuration`{.action}. +Sélectionnez ensuite la liste des zones que vous souhaitez déployer et cliquez sur le bouton `Appliquer la configuration`{.action}. ![Appliquer la configuration zones](images/btn_apply_configuration_zones.png){.thumbnail} @@ -344,10 +378,10 @@ Selectionnez ensuite la liste des zones que vous souhaitez deployer et cliquez s > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh > -### Validation +### Validation Une fois toutes ces étapes terminées, vous devriez disposer d'un service de répartition de charge fonctionnel. Vous pouvez valider l'état du service en visitant votre site. ## Aller plus loin -Échangez avec notre [communauté d'utilisateurs](/links/community). +Échangez avec notre [communauté d'utilisateurs](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_http_https/guide.fr-fr.md b/pages/network/load_balancer/create_http_https/guide.fr-fr.md index 9a8e4374316..d90feca7733 100644 --- a/pages/network/load_balancer/create_http_https/guide.fr-fr.md +++ b/pages/network/load_balancer/create_http_https/guide.fr-fr.md @@ -1,14 +1,31 @@ --- title: "Configuration d'un service OVHcloud Load Balancer avec HTTP/HTTPS" -excerpt: Configuration d’un service Load Balancer -updated: 2023-11-22 +excerpt: "Découvrez comment configurer votre Load Balancer OVHcloud pour répartir la charge HTTP et sécuriser vos connexions avec HTTPS" +updated: 2025-11-12 --- + + ## Objectif -Ce guide a pour but de vous aider à créer votre premier service HTTP/HTTPS avec l'offre OVHcloud Load Balancer OVHcloud. Nous allons ici configurer un service OVHcloud Load Balancer simple pour répartir la charge HTTP d'un service, tel qu'un site web. +Ce guide a pour but de vous aider à créer votre premier service HTTP/HTTPS avec l'offre OVHcloud Load Balancer. Nous allons ici configurer un service OVHcloud Load Balancer simple pour répartir la charge HTTP d'un service, tel qu'un site web. -Un frontend sera créé pour écouter sur le port 80, tandis qu'un autre écoutera sur le port 443 avec un certificat SSL/TLS. Ces frontends seront configurés pour diriger leur trafic vers une ferme HTTP commune. Cette ferme peut disposer d'un ou plusieurs serveurs, selon la configuration choisie / adaptée. +Un frontend sera créé pour écouter sur le port 80, tandis qu'un autre écoutera sur le port 443 avec un certificat SSL/TLS. Ces frontends seront configurés pour diriger leur trafic vers une ferme HTTP commune. Cette ferme peut disposer d'un ou plusieurs serveurs, selon la configuration choisie/adaptée. Pour rappel, le service OVHcloud Load Balancer est composé de 4 parties élémentaires : @@ -17,6 +34,8 @@ Pour rappel, le service OVHcloud Load Balancer est composé de 4 parties éléme - les `routes` avancées entre les Frontends et les Fermes de serveurs ; - les certificats `SSL/TLS` permettant de chiffrer les connexions TCP et/ou HTTP. +**Découvrez comment configurer votre service Load Balancer OVHcloud pour répartir la charge HTTP et sécuriser vos connexions avec HTTPS.** + ## Prérequis - Posséder une offre [OVHcloud Load balancer](/links/network/load-balancer) dans votre compte OVHcloud. @@ -27,19 +46,28 @@ Pour rappel, le service OVHcloud Load Balancer est composé de 4 parties éléme ## En pratique +## Sommaire + +- [Ajouter une ferme de serveurs](#farm) +- [Ajouter un serveur](#server) +- [Ajouter un frontend](#frontend) +- [Ajouter un certificat SSL/TLS](#certificate) +- [Appliquer les modifications](#apply) +- [Validation](#validation) + > [!warning] > > Nous allons vous guider au travers des différentes étapes. Selon vos choix d'architecture, certaines configurations peuvent différer. > -Avant de vous lancer, si vous ne l'avez pas encore lue, nous vous conseillons de consulter la présentation générale du service OVHcloud Load Balancer: [Présentation de l'OVHcloud Load Balancer](/pages/network/load_balancer/use_presentation). +Avant de vous lancer, il est conseillé de consulter la [présentation du service OVHcloud Load Balancer](/pages/network/load_balancer/use_presentation). > [!warning] > > L'ordre de création des éléments est important. En particulier, les fermes de serveurs doivent être configurées avant de pouvoir leur attacher un certificat SSL/TLS ou des serveurs. De même, les frontends doivent être configurés après les fermes de serveurs afin de pouvoir configurer la ferme par défaut du frontend. > -Dans l'espace client OVHcloud, nous allons retrouver les fonctionnalités détaillées ci-dessous: +Les fonctionnalités détaillées ci-dessous sont accessibles depuis l'espace client OVHcloud : ![Service OVHcloud Load Balancer](images/iplb_service.png){.thumbnail} @@ -52,25 +80,25 @@ Via l'API OVHcloud, utilisez l'appel suivant : > @api {v1} /ipLoadbalancing GET /ipLoadbalancing > -Pour plus d'informations sur les fonctionnalités de l'API, consultez la page [Détails des fonctions API](/pages/network/load_balancer/use_api_details){.ref} +Pour plus d'informations sur les fonctionnalités de l'API, consultez la page [Détails des fonctions API](/pages/network/load_balancer/use_api_details) -### Ajouter une ferme de serveurs +### Ajouter une ferme de serveurs -Nous allons ajouter une ferme de serveurs HTTP à notre service, la partie en charge de répartir le trafic sur les serveurs. +Nous allons ajouter une ferme de serveurs HTTP à notre service. Cette partie est en charge de répartir le trafic sur les serveurs. #### Depuis l'espace client OVHcloud Dans l'onglet `Fermes de serveurs`{.action}, cliquez sur le bouton `Ajouter une ferme de serveurs`{.action}. -Remplissez les champs. Les seuls champs obligatoires pour une configuration simple sont le *Protocole* et le *Datacentre*. Il est recommandé de définir explicitement un *Port*, généralement le port 80 pour un service web. Si aucun port n'est spécifié, votre OVHcloud Load Balancer utilisera automatiquement le même port que le frontend correspondant et les sondes pourront ne pas fonctionner comme prévu. +Remplissez les champs. Les seuls champs obligatoires pour une configuration simple sont le *Protocole* et le *Datacentre*. Il est recommandé de définir explicitement un *Port*, généralement le port 80 pour un service web. Si aucun port n'est spécifié, votre service OVHcloud Load Balancer utilisera automatiquement le même port que le frontend correspondant et les sondes pourront ne pas fonctionner comme prévu. Si vous ajoutez plusieurs serveurs dans votre ferme, il est recommandé de configurer une `sonde de disponibilité` HTTP. Lorsqu'une sonde est configurée, le service OVHcloud Load Balancer pourra automatiquement désactiver un serveur qui serait en panne ou en maintenance, de manière à ne pas affecter les visiteurs. -![Ajout d'une ferme de serveurs via le Manager](images/add_backend.png){.thumbnail} +![Ajout d'une ferme de serveurs via l'espace client OVHcloud](images/add_backend.png){.thumbnail} Cliquez sur le bouton `Ajouter`{.action} une fois les champs remplis. -Votre ferme de serveurs devrait apparaitre dans la liste, sous l'onglet `Fermes de serveurs`{.action}. +Votre ferme de serveurs devrait apparaître dans la liste, sous l'onglet `Fermes de serveurs`{.action}. ![Détails de la ferme de serveurs créée](images/resume_backend.png){.thumbnail} @@ -111,13 +139,13 @@ Votre ferme de serveurs devrait apparaitre dans la liste, sous l'onglet `Fermes > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId} > -### Ajouter un Serveur +### Ajouter un serveur Nous allons maintenant ajouter un serveur à notre ferme de serveurs. #### Depuis l'espace client OVHcloud -Toujours dans l'onglet `Fermes de serveurs`{.action}, sélectionnez la ferme dans laquelle vous souhaitez ajouter un serveur en cliquant sur la ligne correspondante. La liste des Serveurs déjà configurés dans la ferme apparaît en dessous de la liste des fermes, ainsi qu'un bouton `Ajouter un serveur`{.action}. Cliquez sur ce bouton pour ajouter un nouveau serveur. +Toujours dans l'onglet `Fermes de serveurs`{.action}, sélectionnez la ferme à laquelle vous souhaitez ajouter un serveur en cliquant sur la ligne correspondante. La liste des serveurs déjà configurés dans la ferme apparaît en dessous de la liste des fermes, ainsi qu'un bouton `Ajouter un serveur`{.action}. Cliquez sur ce bouton pour ajouter un nouveau serveur. Seul le champ *Adresse IPv4* est obligatoire. Si un serveur n'utilise pas le même port que celui défini plus haut dans la ferme, il est possible de le surcharger dans la configuration du serveur. Cependant, afin de conserver une configuration la plus homogène et maintenable possible, il est recommandé de n'utiliser ce paramètre que dans les cas avancés. @@ -152,7 +180,7 @@ Votre serveur devrait apparaître dans la liste des serveurs, dans l'onglet `Fer > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server > -- Modification d'un Serveur spécifique : +- Modification d'un serveur spécifique : > [!api] > @@ -166,9 +194,9 @@ Votre serveur devrait apparaître dans la liste des serveurs, dans l'onglet `Fer > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server > -### Ajouter un frontend +### Ajouter un frontend -Nous allons maintenant ajouter un `frontend` à notre service et le connecter à notre ferme de serveurs. Le frontend est la partie de votre OVHcloud Load Balancer qui sert à exposer votre service sur Internet. Dans un premier temps, nous allons le configurer en HTTP uniquement, sans certificat SSL/TLS. +Nous allons maintenant ajouter un `frontend` à notre service et le connecter à notre ferme de serveurs. Le frontend est la partie de votre service OVHcloud Load Balancer qui sert à exposer votre service sur Internet. Dans un premier temps, nous allons le configurer en HTTP uniquement, sans certificat SSL/TLS. #### Depuis l'espace client OVHcloud @@ -223,39 +251,46 @@ Votre frontend devrait apparaître dans la liste, sous l'onglet `Frontends`{.act > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/frontend/{frontendId} > -### Ajouter un certificat SSL/TLS +### Ajouter un certificat SSL/TLS -La section précédente décrivait la configuration générale pour un frontend HTTP. Cette section décrit les étapes supplémentaires pour activer le support du protocole HTTPS sur un Frontend HTTP. En particulier, il faudra : +La section précédente décrivait la configuration générale pour un frontend HTTP. Cette section décrit les étapes supplémentaires pour activer le support du protocole HTTPS sur un frontend HTTP. En particulier, il faudra : -- basculer le Frontend sur le port 443, standard pour le protocole HTTPS ; +- basculer le frontend sur le port 443, standard pour le protocole HTTPS ; - configurer un certificat SSL/TLS afin d'authentifier et chiffrer les connexions. -Que vous optiez pour une configuration via l'API ou via l'espace client OVHcloud, vous aurez le choix entre 2 stratégies pour vos certificats SSL/TLS, ce choix dépendant de vos besoins ainsi que des solutions actuellement en place : +Que vous optiez pour une configuration via l'API ou via l'espace client OVHcloud, vous aurez le choix entre 2 stratégies pour vos certificats SSL/TLS : - Importer un certificat SSL/TLS existant. -- Commander un certificat SSL/TLS géré automatiquement. La commande de certificats DV et EV arrivera prochainement. +- Commander un certificat SSL/TLS géré automatiquement. La commande de certificats DV et EV sera disponible prochainement. + +> [!primary] +> +> Ce choix dépend de vos besoins ainsi que des solutions actuellement en place. -Si vous optez pour l'importation d'un certificat SSL/TLS commandé et géré par vos soins, vous devrez le renouveler périodiquement vous-même et le mettre à jour dans votre service OVHcloud Load Balancer. La majorité des certificats sont valides pour 1 an. Certains peuvent l'être plus longtemps. Les certificats Let's Encrypt ne sont quant à eux valides que 3 mois. Il est recommandé d'utiliser le service géré automatiquement par votre OVHcloud Load Balancer pour les certificats Let's Encrypt afin de ne pas accidentellement rater une échéance. +Si vous optez pour l'importation d'un certificat SSL/TLS commandé et géré par vos soins, vous devrez le renouveler périodiquement vous-même et le mettre à jour dans votre service OVHcloud Load Balancer. La majorité des certificats sont valides pour 1 an. Certains peuvent l'être plus longtemps. Les certificats `Let's Encrypt` ne sont quant à eux valides que 3 mois. Il est recommandé d'utiliser le service géré automatiquement par votre service OVHcloud Load Balancer pour les certificats `Let's Encrypt` afin de ne pas accidentellement rater une échéance. Si vous optez pour un certificat géré par votre service OVHcloud Load Balancer, celui-ci sera automatiquement commandé, validé, installé et renouvelé périodiquement par votre OVHcloud Load Balancer.
-Pour que les opérations de validation et de renouvellement fonctionnent, il est nécessaire que le ou les domaines pour lesquels vous commandez ce certificat soient routés vers votre service OVHcloud Load Balancer. Cela implique que les champs *A* et *AAAA* de votre domaine pointent respectivement sur l'IPv4 et l'IPv6 de votre OVHcloud Load Balancer ou l'une de ses Additional IPs. Lors de la commande, vous recevrez un email qui vous guidera dans les étapes de la validation. +Pour que les opérations de validation et de renouvellement fonctionnent, il est nécessaire que le ou les domaines pour lesquels vous commandez ce certificat soient routés vers votre service OVHcloud Load Balancer. Cela implique que les champs *A* et *AAAA* de votre domaine pointent respectivement sur l'IPv4 et l'IPv6 de votre Load Balancer ou l'une de ses Additional IPs. Lors de la commande, vous recevrez un e-mail qui vous guidera dans les étapes de la validation. > [!primary] > -> Pour assurer la continuité de service lors du basculement de votre domaine vers l'IP de votre service OVHcloud Load Balancer afin de valider votre certificat, une bonne pratique est de commencer par configurer et tester complètement la configuration HTTP sur le port 80. De cette manière, votre site reste accessible sans interruption. +> Pour assurer la continuité de service lors du basculement de votre domaine vers l'IP de votre service OVHcloud Load Balancer afin de valider votre certificat, une bonne pratique consiste à commencer par configurer et tester complètement la configuration HTTP sur le port 80. De cette manière, votre site reste accessible sans interruption. > Si votre site dispose déjà d'une connexion HTTPS et que vous souhaitez migrer vers des certificats gérés par votre service OVHcloud Load Balancer, vous pouvez importer vos certificats existants, configurer et tester votre Frontend HTTPS et enfin commander un nouveau certificat pour le même domaine. Il sera automatiquement pris en compte avant l'expiration de votre ancien certificat. > -Les certificats configurés sur votre service OVHcloud Load Balancer sont automatiquement disponibles pour l'ensemble des frontend de votre service OVHcloud Load Balancer sur lesquels l'options *SSL* est activée. +Les certificats configurés sur votre service OVHcloud Load Balancer sont automatiquement disponibles pour l'ensemble des frontends de votre service OVHcloud Load Balancer sur lesquels l'option *SSL* est activée. #### Support de TLS 1.3 + Avec l'évolution constante des normes de sécurité sur Internet, OVHcloud s'engage à fournir les technologies les plus récentes et les plus sûres pour vos services. Le Load Balancer OVHcloud supporte désormais TLS 1.3. -##### Qu'est-ce que TLS 1.3 ? -TLS 1.3 est la dernière version du protocole TLS, offrant des améliorations significatives en matière de sécurité et de performance par rapport à TLS 1.2. Les avantages clés incluent un processus de handshake plus rapide, réduisant ainsi le temps nécessaire pour établir des connexions sécurisées, et l'utilisation de suites de chiffrement plus sûres pour renforcer la sécurité des données transmises. +##### **Qu'est-ce que TLS 1.3 ?** + +TLS 1.3 est la dernière version du protocole TLS. Elle améliore significativement la sécurité et les performances par rapport à TLS 1.2, notamment grâce à un processus de *handshake* plus rapide, réduisant le temps nécessaire pour établir des connexions sécurisées, et à l’utilisation de suites de chiffrement plus sûres pour renforcer la sécurité des données transmises. + +##### **Pourquoi utiliser TLS 1.3 avec OVHcloud Load Balancer ?** -##### Pourquoi utiliser TLS 1.3 avec OVHcloud Load Balancer ? -En intégrant TLS 1.3, votre Load Balancer OVHcloud bénéficiera d'une sécurité renforcée et d'une performance améliorée, assurant une expérience utilisateur optimale pour vos visiteurs. La réduction du temps de handshake accélère le chargement des pages, tandis que les améliorations de sécurité garantissent que vos données sont protégées avec les normes les plus récentes et les plus sûres. +En intégrant TLS 1.3, votre service OVHcloud Load Balancer bénéficiera d'une sécurité renforcée et d'une performance améliorée, assurant une expérience utilisateur optimale pour vos visiteurs. La réduction du temps de *handshake* accélère le chargement des pages, tandis que les améliorations de sécurité garantissent que vos données sont protégées avec les normes les plus récentes et les plus sûres. #### Depuis l'espace client OVHcloud @@ -269,12 +304,12 @@ Cliquez sur le bouton `Ajouter`{.action} une fois les champs remplis. Votre cert ![Ajout d'un certificat existant](images/add_certificat_custom.png){.thumbnail} -Pour ajouter un certificat Let's Encrypt, cliquez sur `Commander un certificat SSL`{.action}, renseignez votre domaine, assurez vous que celui-ci pointe bien sur votre service OVHcloud Load Balancer et laissez-vous guider par les e-mails que vous recevrez. Vous le verrez ensuite apparaître dans la liste des certificats disponibles. +Pour ajouter un certificat `Let's Encrypt`, cliquez sur `Commander un certificat SSL`{.action}, renseignez votre domaine, assurez-vous que celui-ci pointe bien sur votre service OVHcloud Load Balancer et laissez-vous guider par les e-mails que vous recevrez. Vous le verrez ensuite apparaître dans la liste des certificats disponibles. ![Command d'un certificat Let's Encrypt](images/add_certificat_letsencrypt.png){.thumbnail} -Une fois votre / vos certificats configurés, vous pouvez créer un frontend HTTPS, sur le même modèle que le frontend HTTP créé plus haut avec le port 443 et l'option *SSL* active.
-Optionnellement, vous pouvez également activer l'option *HSTS*. Si cette option est active, les navigateurs enregistreront que ce site Internet ne doit *plus jamais* être visité sans HTTPS après leur première visite en HTTPS. Cela permet de renforcer la sécurité globale en se protégeant contre les attaques de type « Homme du milieu » dans laquelle un acteur malveillant pour faire croire que votre site Internet n'est pas disponible en HTTPS et forcer vos visiteurs à basculer en « HTTP ». +Une fois votre/vos certificats configurés, vous pouvez créer un frontend HTTPS, sur le même modèle que le frontend HTTP créé plus haut avec le port 443 et l'option *SSL* active.
+Optionnellement, vous pouvez également activer l'option *HSTS*. Si cette option est active, les navigateurs enregistreront que ce site Internet ne doit *plus jamais* être visité sans HTTPS après leur première visite en HTTPS. Cela permet de renforcer la sécurité globale en se protégeant contre les attaques de type « Homme du milieu » dans laquelle un acteur malveillant pourrait faire croire que votre site Internet n'est pas disponible en HTTPS et forcer vos visiteurs à basculer en « HTTP ». > [!warning] > @@ -318,9 +353,9 @@ Optionnellement, vous pouvez également activer l'option *HSTS*. Si cette option > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/ssl/{id} > -### Appliquer les modifications +### Appliquer les modifications -Les modifications apportées à votre service OVHcloud Load Balancer soivent être *appliquées explicitement* dans chacune des zones configurées pour votre service OVHcloud Load Balancer. C'est seulement à ce moment qu'elles seront visibles pour vos visiteurs. Cela permet de faire un changement complexe de configuration en une seule fois. +Les modifications apportées à votre service OVHcloud Load Balancer doivent être *appliquées explicitement* dans chacune des zones configurées pour votre service OVHcloud Load Balancer. C'est seulement à ce moment qu'elles seront visibles pour vos visiteurs. Cela permet de faire un changement complexe de configuration en une seule fois. Si vous avez plusieurs zones, vous devrez appliquer la même configuration pour chacune de vos zones. @@ -330,7 +365,7 @@ Rendez-vous sur la page d'accueil de votre service OVHcloud Load Balancer et cli ![Appliquer la configuration](images/btn_apply_configuration.png){.thumbnail} -Selectionnez ensuite la liste des zones que vous souhaitez deployer et cliquez sur le bouton `Appliquer la configuration`{.action}. +Sélectionnez ensuite la liste des zones que vous souhaitez déployer et cliquez sur le bouton `Appliquer la configuration`{.action}. ![Appliquer la configuration zones](images/btn_apply_configuration_zones.png){.thumbnail} @@ -343,7 +378,7 @@ Selectionnez ensuite la liste des zones que vous souhaitez deployer et cliquez s > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh > -### Validation +### Validation Une fois toutes ces étapes terminées, vous devriez disposer d'un service de répartition de charge fonctionnel. Vous pouvez valider l'état du service en visitant votre site. diff --git a/pages/network/load_balancer/create_probes/guide.en-asia.md b/pages/network/load_balancer/create_probes/guide.en-asia.md index 52be1704be5..d774b695308 100644 --- a/pages/network/load_balancer/create_probes/guide.en-asia.md +++ b/pages/network/load_balancer/create_probes/guide.en-asia.md @@ -1,45 +1,69 @@ --- -title: 'Working with probes' -excerpt: 'Find out about the general principles behind probes, and why they are used' -updated: 2019-02-12 +title: "Configuration of probes on an OVHcloud Load Balancer service" +excerpt: "Discover the general principles and use cases for probes" +updated: 2025-11-12 --- -## Objective + -With the OVH Load Balancer, you can distribute a front-end’s incoming traffic across a set of servers in a destination farm. +## Objective -There may be instances where a server in your farm becomes unavailable for a number of reasons, including oversaturation, an incident, or scheduled maintenance. When the OVH Load Balancer detects a connection error, it will try to redirect traffic to another server. The connection will be slower, but it will continue to work. +The OVHcloud Load Balancer allows you to distribute incoming traffic on a frontend to a set of servers in a destination farm. -However, the reasons behind certain types of unavailability can be harder to pinpoint. For example, if a new version of code is being deployed, the application may momentarily experience a glitch, and return a 500 error. In this particular case, a solution would be to mark the servers concerned as unavailable in the API before you begin the maintenance work, apply the configuration and update, then mark the server as available again. This method is not ideal, but it works. For more information on deploying a blue-green architecture with an OVH Load Balancer, please read our guide: . +It may happen that one of the servers in your farm is no longer available for various reasons, such as overload, an incident, or scheduled maintenance. When it encounters a connection error, your OVHcloud Load Balancer attempts to switch traffic to another server. The connection will be slowed down, but it will continue to function. -The purpose of a probe is to test an infrastructure’s health. It periodically examines each of your servers, to ensure that they are working properly. If it detects an error, the server is automatically disabled until the situation is resolved. +However, the causes of some unavailability are more subtle. For example, if a new version of the code is being deployed, the application may temporarily be in a transitional state and return 500 errors. In this specific case, one solution would be to mark the affected servers as unavailable in the API before the start of the maintenance, apply the configuration and update, and then mark the server as available again. This method is not ideal, but it works.
+For more details on deploying a Blue-Green architecture with your OVHcloud Load Balancer, refer to [this guide](/pages/network/load_balancer/case_blue_green). -Since this service is still very new, its basic features are only available in the API. +Probes are health checks. They periodically query each of your servers to ensure they are operational. If an error is detected, the server is automatically disabled until the situation is resolved. -**This guide will explain the general principles behind probes, and provide practical examples of probes being used.** +**This guide will present the general principles, as well as usage scenarios for probes, drawn from real-world use cases.** ## Requirements -- a correctly configured OVH Load Balancer, with farms and servers set +- Have an [OVHcloud Load Balancer](/links/network/load-balancer) offer in your OVHcloud account. The service must be properly configured, with farms and servers set up. +- Be logged in to your [OVHcloud Control Panel](/links/manager). ## Instructions -### An introduction to the API. +**Table of contents** + +- [Probe API overview](#probe-api) +- [Examples](#examples) +- [Reference](#reference) +- [From the OVHcloud Control Panel](#manager) + +### Probe API overview -The API for probes in the OVH Load Balancer is designed to be flexible and scalable. +The probe API of your OVHcloud Load Balancer has been designed to be flexible and scalable. -The probes can be configured directly on the farms. All of the servers from a single farm will have exactly the same probe applied. However, probe activation and deactivation is specific for each server. As a result, it is possible to only monitor certain servers within a single farm. +Probes are configured directly on the farms. All servers in the same farm thus apply exactly the same probe. However, enabling or disabling a probe is specific to each server. It is therefore possible to "monitor" only certain servers in the same farm. -You can view the list of available probes and their settings with the following API call: +The list of available probes and their parameters can be consulted with the API call : > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmProbes > -For more information on this call, please read the *Available probes* section at the bottom of this guide. +For more information on this call, we invite you to consult the [Available probes](#available-probes) section at the bottom of this guide. -The probes in this list can be configured on `http` and `tcp` farms via the following calls: +The probes returned by this list can be configured on `http` and `tcp` farms via the following calls : > [!api] > @@ -61,56 +85,58 @@ The probes in this list can be configured on `http` and `tcp` farms via the foll > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId} > -For more information on these calls, please read the *Probe configuration* section at the bottom of this guide. +For more information on these calls, you can refer to the [Probe handling](#handling-probes) section of this guide. -### Examples +### Examples -#### Check if the server accepts TCP connections. +#### Check if the server accepts TCP connections -This is the simplest method to set up. It is compatible with `tcp` and `http` farms. If no other probes are configured, you can activate it to start. It works by periodically attempting to establish a connection on each of your servers. If the connection fails twice in a row, the server is put aside until it responds again. +This is the simplest probe to set up. It is compatible with `tcp` and `http` farms. If no other probe is configured, you can activate this one to start. It works by periodically trying to open a connection on each of your servers. If the connection fails twice in a row, the server is put aside until it responds again. -In practice, this gives a probe: +In practice, this gives a probe : |Field|Value and description| |---|---| -|serviceName|Your OVH Load Balancer ID| -|farmId|Your TCP or HTTP farm| +|serviceName|Identifier of your OVHcloud Load Balancer| +|farmId|Identifier of your TCP or HTTP farm| |probe.type|"tcp"| -All other probe fields can keep their default values. Just apply the configuration to the zone concerned, and the probe will begin to work. +All other `probe` fields can remain at their default values. You just need to apply the configuration in the relevant area. -#### Test a specific HTTP page. +#### Test a specific HTTP page -By default, the HTTP `probe` sends an "OPTIONS" request on "/" in HTTP/1.0, without a domain name. In many cases, this is sufficient, but some servers do not manage this method. You can carry out much more powerful tests with the HTTP probe. For example, a good practice when exposing a HTTP service is to add a router dedicated to probes. It is normal to see "/status", "/health", and "/check", which summarise the service’s status. +By default, the HTTP probe sends an `OPTIONS` request on `/` in HTTP/1.0, without a domain name. This is sufficient in many cases, but some servers do not handle this method.
+It is possible to perform much more powerful tests with the HTTP probe. For example, a good practice when exposing an HTTP service is to add a dedicated route for probes. It is common to find `/status`, `/health`, `/check` which return a summary of the service's status. -In practice, if you want to configure the probe to send a "GET" request on [http://api.example.com/status](http://api.example.com/status), it gives: +In practice, if you want to configure the probe to send a `GET` request to [http://api.example.com/status](http://api.example.com/status), this gives : |Field|Value and description| |---|---| -|serviceName|Your OVH Load Balancer ID| -|farmId|Your TCP or HTTP farm| +|serviceName|Identifier of your OVHcloud Load Balancer| +|farmId|Identifier of your TCP or HTTP farm| |probe.type|http| |probe.method|GET| |probe.url|[http://api.example.com/status](http://api.example.com/status)| |probe.match|status| -|probe.pattern|200 (multiple status codes can be added, provided they are separated by commas)| +|probe.pattern|200 (several status codes can be added, separated by commas)| -All other probe fields can keep their default values. Finally, apply the configuration to the zone concerned. +All other `probe` fields can remain at their default values. It is then sufficient to apply the configuration in the relevant area. -#### Use an external HTTP test. +#### Use an external HTTP test -What happens if, for example, your service is an IMAP server that relies on an LDAP server for authentication? The server may accept connections, but experience a temporary connection issue with the LDAP server. If this happens, the customers redirected to this server would be able to connect, but wouldn’t be able to authenticate. As a result, the server would need to be removed from the farm. +What if your service is, for example, an IMAP server that relies on an LDAP server for authentication ?
+It is possible that the server accepts connections, but has a temporary connection issue with the LDAP server. If this happens, clients who are directed to this server could connect but not authenticate. The server should therefore be removed from the farm. -If you are using a `tcp` probe, it will manage to connect. As a result, it will consider the service to be available, even though this is not the case. +If a `tcp` type probe is used, it will be able to connect and consider the service available even though it is not the case. -In this situation, the health test would ideally be able to confirm that the basic service works. You can provide a specific port to use in the tests. This way, you can set up arbitrary tests for a service, and expose them to HTTP on a dedicated port. +In this scenario, the ideal would be for the health check to confirm that the base service is working. It is possible to indicate a specific port to use in the tests. This allows arbitrary tests to be set up for a service and exposed in HTTP, on a dedicated port. -For example, in this situation, you can have a HTTP server on port 8080\. It will test the IMAP server via the URL "/service/imap/status", and will return ‘OK’ when everything is working properly. In practice, this will return: +For example, in this scenario, it would be possible to have an HTTP server on port 8080 that tests the IMAP server via the url `/service/imap/status` and returns *OK* when everything is fine. This would give in practice : |Field|Value and description| |---|---| -|serviceName|Your OVH Load Balancer ID| -|farmId|Your TCP or HTTP farm| +|serviceName|Identifier of your OVHcloud Load Balancer| +|farmId|Identifier of your TCP or HTTP farm| |probe.type|http| |probe.port|8080| |probe.method|GET| @@ -118,24 +144,24 @@ For example, in this situation, you can have a HTTP server on port 8080\. It wil |probe.match|contains| |probe.pattern|OK| -Just apply the configuration to the zone concerned, and the probe will begin to work. +It is then sufficient to apply the configuration in the relevant area. > [!warning] > -> If the HTTP service dedicated to monitoring your IMAP service experiences a fault, the IMAP service will also be considered faulty, even if it is working properly. +> If the HTTP service dedicated to monitoring your IMAP service itself fails, the IMAP service will also be considered as failed, even if it is in perfect working condition. > -### Reference +### Reference -#### Probe configuration. +#### Probe handling -##### Configure a probe. +##### **Configure a probe** -Probes can be configured on a new farm (`POST`) or an existing one (`PUT`). Since the two methods are equivalent, only the second (`PUT`) method is presented here. +Probes can be configured on a new farm (`POST`) or an existing farm (`PUT`). The two methods being equivalent, only the second one (`PUT`) will be presented here. > [!faq] > -> Service: +> Service : > >> > [!api] >> > @@ -143,85 +169,86 @@ Probes can be configured on a new farm (`POST`) or an existing one (`PUT`). Sinc >> > >> > -> Settings: +> Parameters : > >> > **serviceName** >> > ->> >> Your OVH Load Balancer ID. +>> >> The identifier of your OVHcloud Load Balancer. >> > >> > **farmId** >> > ->> >> Your `farm` ID number. +>> >> The numeric identifier of your `farm`. >> > >> > **probe** >> > >> >> **type** >> >> ->> >> > The type of `probe` to activate. The probe types managed are: +>> >> > The type of `probe` to enable. The probe types handled are : >> >> > ->> >> > `tcp` for a basic TCP connection test. +>> >> > `tcp` for a basic TCP connection test ; >> >> > ->> >> > `http` for a HTTP connection test. You can specify the URL and the method. +>> >> > `http` for an HTTP connection test. It is possible to specify the URL and method ; >> >> > ->> >> > `smtp` for a basic SMTP connection test. +>> >> > `smtp` for a basic SMTP connection test ; >> >> > ->> >> > `mysql` for a basic MySQL connection test. +>> >> > `mysql` for a basic MySQL connection test ; >> >> > ->> >> > `pgsql` for a basic PostgreSQL connection test. +>> >> > `pgslq` for a basic PostgreSQL connection test ; >> >> > ->> >> > `oco` for a confirmation of the general status returned on port 79. +>> >> > `oco` for a general status validation returned on port 79. >> > >> >> **interval** >> >> ->> >> > The interval (in seconds) between a probe’s two connection attempts. It must be at least 30 seconds. +>> >> > The interval in seconds between two probe attempts. It must be at least 30 seconds. >> > >> >> **port** >> >> ->> >> > The port that the probe must use, if it is different to the port configured on the farm. ->> >> > This enables you to delegate a server’s status validation to a separate service on the machine, and carry out arbitrary probes. +>> >> > The port that the probe should use, if it is different from the one configured on the farm. +>> >> > This allows you to delegate the server status validation to a third-party service on the machine and perform arbitrary probes. >> > >> >> **method** >> >> ->> >> > The HTTP method to use if the probe is a “http” probe. ->> >> > Compatible methods are `GET`, `HEAD` and `OPTIONS` (by default). +>> >> > The HTTP method to use if the probe is of type "http". +>> >> > The compatible methods are `GET`, `HEAD` and `OPTIONS` (default). >> > >> >> **url** >> >> ->> >> > The URL to use for tests, if it is a “http” probe type. ->> >> > It should be formulated as follows: `[[https?://]www.example.com]/path/to/check`. ->> >> > If a domain is specified, its request will be sent to HTTP/1.1 rather than HTTP/1.0 by default. +>> >> > The URL to use for the tests, if the probe is of type "http". +>> >> > Its form must be `[[https?://]www.example.com]/path/to/check`. +>> >> > If a domain is specified, the request will be sent in HTTP/1.1 instead of HTTP/1.0 by default. >> > >> >> **match** >> >> ->> >> > The type of comparison to use to check if the server is in good health. ->> >> > The managed comparison types are `default`, `status`, `contains` and `matches`. ->> >> > Comparison types are compatible with both “http” and “tcp” probes. +>> >> > The type of comparator to use to check that the server is healthy. +>> >> > The comparators handled are `default`, `status`, `contains` and `matches`. +>> >> > The comparators are compatible with "http" and "tcp" probes. >> > >> >> **pattern** >> >> ->> >> > The value to use as an argument of the comparison type if it is different from “default”. +>> >> > The value to use as an argument for the comparator if it is different from "default". >> > >> >> **forceSsl** >> >> ->> >> > This defines whether the probe must work in SSL/TLS, even if the farm is configured to connect via standard TCP. ->> >> > This can be useful when, for example, your OVH Load Balancer is configured to monitor HTTPS traffic in TCP without decrypting it. +>> >> > Defines whether the probe should work in SSL/TLS even if the farm is configured to connect in classic TCP. +>> >> > This can be useful, for example, when your OVHcloud Load Balancer is configured to forward HTTPS traffic in TCP without decrypting it. > -Other settings can be edited via this call. Since this guide focuses on probes, they are not documented here. +Other parameters can be edited via this call. As this guide focuses on probes, they are not documented here. -If a port other than the farm’s base port is configured on the probe, the `proxyprotocol` and `ssl` settings are reset. As an example, we will take a configured farm to use `proxyprotocol` on **port 4242**, and an associated probe using **port 8080**. The probe will not send the `proxyprotocol` header when it connects on **port 8080**. The same goes for `ssl`, but it can be forced. +If a port other than the base port of the farm is configured on the probe, the `proxyprotocol` and `ssl` parameters are reset. Take the example of a farm configured to use `proxyprotocol` on port **4242** and a probe associated with port **8080**: the latter will not send the `proxyprotocol` header when connecting to port **8080**. The same applies to `ssl`, which can nevertheless be forced. > [!warning] > -> When a probe is configured on a farm, it must be activated on the servers. +> When a probe is configured on a farm, it must also be enabled on the servers. > -##### Activate probes on a server. -For a probe to be active, it must be configured on the farm and activated on the servers concerned. With this call, you can activate the probe being taken into account: +##### **Enable probes on a server** + +For a probe to be active, it must have been configured on the farm and enabled on the relevant servers. This call allows you to enable the probe : > [!faq] > -> Service: +> Service : > >> > [!api] >> > @@ -229,47 +256,47 @@ For a probe to be active, it must be configured on the farm and activated on the >> > >> > -> Settings: +> Parameters : > >> > **serviceName** >> > ->> >> Your OVH Load Balancer ID. +>> >> The identifier of your OVHcloud Load Balancer. >> > >> > **farmId** >> > ->> >> Your `farm` ID number. +>> >> The numeric identifier of your `farm`. >> > >> > **serverId** >> > ->> >> Your `server’s` ID number. +>> >> The numeric identifier of your `server`. >> > >> > **probe** >> > ->> >> Whether or not the `probes` must be taken into account. +>> >> Indicates whether `probe` should be taken into account or not. > -Other settings can be edited via this call. Since this guide focuses on probes, they are not documented here. +Other parameters can be edited via this call. As this guide focuses on probes, they are not documented here. -#### Available comparison types. +#### Available comparators -Four comparison types are available to confirm a probe’s results: +Four comparators are available to validate the result of a probe : -|Comparison type|Description| +|Comparator|Description| |---|---| -|default|Launches a basic test, without any settings.| -|status|A list of valid HTTP response codes, separated by commas.| -|contains|Checks that the pattern can be found in the response.| -|matches|Checks that the response corresponds to a regular expression pattern.| +|default|Runs a basic test, without parameters.| +|status|Comma-separated list of valid HTTP return codes.| +|contains|Checks that the pattern is in the response.| +|matches|Checks that the response matches the pattern regular expression.| -‘Contains’ and ‘matches’ comparison types find a correspondence in the first 16 KB of the response. If the response is longer than 16 KB, whatever comes afterwards will be ignored during the test. Please note that to optimise your performance, we recommend returning as little information as possible in your probes. +The `contains` and `matches` comparators look for a match in the first 16 KB of the response. If it is longer, the part beyond will be ignored during the search. Note that for better performance, we recommend returning as little information as possible in your probes. -#### Available probes. +#### Available probes -You can get a list of the available probes using the following API call: +The list of available probes can be obtained with the API call : > [!faq] > -> Service: +> Service : > >> > [!api] >> > @@ -277,56 +304,56 @@ You can get a list of the available probes using the following API call: >> > >> > -> Response: +> Response : > >> > **type** >> > ->> >> The type of `probe` to configure in the `probe.type` of `farms`. +>> >> The type of `probe` to configure in the `probe.type` field of the `farms`. >> >> ->> >> The probe types managed are: +>> >> The probe types handled are : >> >> ->> >> `tcp` for a basic TCP connection test. +>> >> `tcp` for a basic TCP connection test ; >> >> ->> >> `http` for a HTTP connection test. You can specify the URL and the method. +>> >> `http` for an HTTP connection test. It is possible to specify the URL and method ; >> >> ->> >> `smtp` for a basic SMTP connection test. +>> >> `smtp` for a basic SMTP connection test ; >> >> ->> >> `mysql` for a basic MySQL connection test. +>> >> `mysql` for a basic MySQL connection test ; >> >> ->> >> `pgsql` for a basic PostgreSQL connection test. +>> >> `pgslq` for a basic PostgreSQL connection test ; >> >> ->> >> `oco` for a confirmation of the general status returned on port 79. +>> >> `oco` for a general status validation returned on port 79. >> > >> > **port** >> > ->> >> This defines whether the port can be configured for this probe. +>> >> Indicates whether the port can be configured for this probe. >> > >> > **method** >> > ->> >> The list of HTTP methods managed, or `null` if none are managed. +>> >> The list of HTTP methods handled or `null` if none exist. >> > >> > **url** >> > ->> >> This defines if the probe’s URL can be configured. +>> >> Indicates whether the probe URL can be configured. >> > >> > **matches** >> > ->> >> The list of comparison types available for this probe. +>> >> The list of available comparators for this probe. >> >> The interpretation of the `probe.pattern` field depends on this field. ->> >> The comparison types potentially managed are: +>> >> The potentially handled comparators are : >> >> ->> >> `default`. The most simple test, without any particular conditions.`probe.pattern` must be empty. +>> >> `default` the simplest test, without specific conditions. `probe.pattern` must be empty ; >> >> ->> >> `status`. Checks if the HTTP status code is in the list separated by commas. +>> >> `status` checks that the HTTP status code is in the comma-separated list ; >> >> ->> >> `contains`. Checks that the server response contains `probe.pattern`. +>> >> `contains` checks that the server response contains `probe.pattern` ; >> >> ->> >> `matches`. Checks that the server response matches `probe.pattern`. +>> >> `matches` checks that the server response matches `probe.pattern`. > -##### TCP +##### **TCP** -This probe attempts to establish a TCP connection to the server. If the server sends a “banner”, you can check if it matches a schema. The default test simply ensures that the connection can be established. +This probe attempts to establish a TCP connection with the server. If the latter sends a "banner", it is possible to check that it matches a pattern. The default test simply ensures that the connection can be established. |Fields|Description| |---|---| @@ -336,29 +363,29 @@ This probe attempts to establish a TCP connection to the server. If the server s |URL|Not supported| |matches|`default`, `contains` or `matches`| -##### HTTP +##### **HTTP** -This probe attempts to establish a HTTP connection to the server. If the server responds, you can check its HTTP status code, and that the response body matches a schema. The default test sends an OPTIONS request to the '/' page in HTTP/1.0, without a Host field. +This probe attempts to establish an HTTP connection with the server. If the latter responds, it is possible to check its HTTP status code or that the response body matches a pattern. The default test sends an OPTIONS request to the '/' page in HTTP/1.0, without the Host field. |Fields|Description| |---|---| |type|`http`| |port|Configurable| |method|`GET`, `HEAD` or `OPTIONS`| -|URL|URL in the form: \[\[https?://]www.example.com]/path/to/check| +|URL|URL of the form [[https?://]www.example.com]/path/to/check| |matches|`default`, `contains` or `matches`| -If the URL is specified, the domain name and protocol are operational. If a domain name is specified, the “Host” field of the request will be filled in, and the request will be sent to HTTP/1.1. If the protocol is specified, it must be consistent with the farm’s SSL configuration. +If a URL is specified, the domain name and protocol are operational. If a domain name is specified, the "Host" field of the request will be filled in and the request will be sent in HTTP/1.1. If the protocol is specified, it must be consistent with the SSL configuration of the farm. > [!primary] > -> We recommend configuring the method, at least, with GET. -> Some servers, including NGINX, do not manage the OPTIONS method without it being configured in advance. +> It is recommended to configure at least the method with GET. +> Indeed, some servers -including Nginx- do not handle the OPTIONS method without prior configuration. > -##### SMTP +##### **SMTP** -This probe attempts to establish an SMTP connection with the server, and sends the command "HELLO localhost". If the server responds, the probe checks that the response code starts with a ‘2’ (success). This probe does not have any specific configuration options. +This probe attempts to establish an SMTP connection with the server and sends the "HELLO localhost" command. If the latter responds, the probe checks that the return code starts with a "2" (success). This probe has no specific configuration options. |Fields|Description| |---|---| @@ -368,9 +395,9 @@ This probe attempts to establish an SMTP connection with the server, and sends t |URL|Not supported| |matches|`default`| -##### MySQL +##### **MySQL** -This probe attempts to establish a MySQL connection with the server, and analyses the server’s response. This probe does not have any specific configuration options. +This probe attempts to establish a MySQL connection with the server and analyses the server's response. This probe has no specific configuration options. |Fields|Description| |---|---| @@ -380,9 +407,9 @@ This probe attempts to establish a MySQL connection with the server, and analyse |URL|Not supported| |matches|`default`| -##### PostgreSQL +##### **PostgreSQL** -This probe attempts to establish a PostgreSQL connection with the server, and analyses the server’s response. This probe does not have any specific configuration options. +This probe attempts to establish a PostgreSQL connection with the server and analyses the server's response. This probe has no specific configuration options. |Fields|Description| |---|---| @@ -392,9 +419,9 @@ This probe attempts to establish a PostgreSQL connection with the server, and an |URL|Not supported| |matches|`default`| -##### oco +##### **oco** -This probe attempts to establish a TCP connection on port 79 of your server, and checks that the response starts with a ‘2’ (success). This probe does not have any specific configuration options. +This probe attempts to establish a TCP connection on port 79 of your server and checks that the response starts with a "2" (success). This probe has no specific configuration options. |Fields|Description| |---|---| @@ -404,20 +431,24 @@ This probe attempts to establish a TCP connection on port 79 of your server, and |URL|Not supported| |matches|`default`| -## Via the OVH Control Panel. +### From the OVHcloud Control Panel -You can configure probes when you add (or modify) a server farm, in advanced settings. +You can configure probes when you add or modify a server farm, in advanced settings. -![Advanced settings for a farm](images/farm_advanced_settings.png){.thumbnail} +![Advanced farm settings](images/farm_advanced_settings.png){.thumbnail} -This is how you access the probe type’s configuration. +You will then have access to the configuration for the probe type. ![Probe settings](images/farm_advanced_settings_unfolded.png){.thumbnail} -If you are able to do so with the probe type you have selected, you can configure specific advanced settings for the probe. +If the probe type you have selected allows it, you can configure advanced settings that are specific to that probe. -![Advanced settings for a probe](images/probe_settings.png){.thumbnail} +![Advanced probe settings](images/probe_settings.png){.thumbnail} A new configuration window will appear, with the probe’s settings. -![Advanced settings for a probe](images/probe_settings_dialog.png){.thumbnail} +![Advanced probe settings](images/probe_settings_dialog.png){.thumbnail} + +## Go further + +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_probes/guide.en-au.md b/pages/network/load_balancer/create_probes/guide.en-au.md index 52be1704be5..d774b695308 100644 --- a/pages/network/load_balancer/create_probes/guide.en-au.md +++ b/pages/network/load_balancer/create_probes/guide.en-au.md @@ -1,45 +1,69 @@ --- -title: 'Working with probes' -excerpt: 'Find out about the general principles behind probes, and why they are used' -updated: 2019-02-12 +title: "Configuration of probes on an OVHcloud Load Balancer service" +excerpt: "Discover the general principles and use cases for probes" +updated: 2025-11-12 --- -## Objective + -With the OVH Load Balancer, you can distribute a front-end’s incoming traffic across a set of servers in a destination farm. +## Objective -There may be instances where a server in your farm becomes unavailable for a number of reasons, including oversaturation, an incident, or scheduled maintenance. When the OVH Load Balancer detects a connection error, it will try to redirect traffic to another server. The connection will be slower, but it will continue to work. +The OVHcloud Load Balancer allows you to distribute incoming traffic on a frontend to a set of servers in a destination farm. -However, the reasons behind certain types of unavailability can be harder to pinpoint. For example, if a new version of code is being deployed, the application may momentarily experience a glitch, and return a 500 error. In this particular case, a solution would be to mark the servers concerned as unavailable in the API before you begin the maintenance work, apply the configuration and update, then mark the server as available again. This method is not ideal, but it works. For more information on deploying a blue-green architecture with an OVH Load Balancer, please read our guide: . +It may happen that one of the servers in your farm is no longer available for various reasons, such as overload, an incident, or scheduled maintenance. When it encounters a connection error, your OVHcloud Load Balancer attempts to switch traffic to another server. The connection will be slowed down, but it will continue to function. -The purpose of a probe is to test an infrastructure’s health. It periodically examines each of your servers, to ensure that they are working properly. If it detects an error, the server is automatically disabled until the situation is resolved. +However, the causes of some unavailability are more subtle. For example, if a new version of the code is being deployed, the application may temporarily be in a transitional state and return 500 errors. In this specific case, one solution would be to mark the affected servers as unavailable in the API before the start of the maintenance, apply the configuration and update, and then mark the server as available again. This method is not ideal, but it works.
+For more details on deploying a Blue-Green architecture with your OVHcloud Load Balancer, refer to [this guide](/pages/network/load_balancer/case_blue_green). -Since this service is still very new, its basic features are only available in the API. +Probes are health checks. They periodically query each of your servers to ensure they are operational. If an error is detected, the server is automatically disabled until the situation is resolved. -**This guide will explain the general principles behind probes, and provide practical examples of probes being used.** +**This guide will present the general principles, as well as usage scenarios for probes, drawn from real-world use cases.** ## Requirements -- a correctly configured OVH Load Balancer, with farms and servers set +- Have an [OVHcloud Load Balancer](/links/network/load-balancer) offer in your OVHcloud account. The service must be properly configured, with farms and servers set up. +- Be logged in to your [OVHcloud Control Panel](/links/manager). ## Instructions -### An introduction to the API. +**Table of contents** + +- [Probe API overview](#probe-api) +- [Examples](#examples) +- [Reference](#reference) +- [From the OVHcloud Control Panel](#manager) + +### Probe API overview -The API for probes in the OVH Load Balancer is designed to be flexible and scalable. +The probe API of your OVHcloud Load Balancer has been designed to be flexible and scalable. -The probes can be configured directly on the farms. All of the servers from a single farm will have exactly the same probe applied. However, probe activation and deactivation is specific for each server. As a result, it is possible to only monitor certain servers within a single farm. +Probes are configured directly on the farms. All servers in the same farm thus apply exactly the same probe. However, enabling or disabling a probe is specific to each server. It is therefore possible to "monitor" only certain servers in the same farm. -You can view the list of available probes and their settings with the following API call: +The list of available probes and their parameters can be consulted with the API call : > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmProbes > -For more information on this call, please read the *Available probes* section at the bottom of this guide. +For more information on this call, we invite you to consult the [Available probes](#available-probes) section at the bottom of this guide. -The probes in this list can be configured on `http` and `tcp` farms via the following calls: +The probes returned by this list can be configured on `http` and `tcp` farms via the following calls : > [!api] > @@ -61,56 +85,58 @@ The probes in this list can be configured on `http` and `tcp` farms via the foll > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId} > -For more information on these calls, please read the *Probe configuration* section at the bottom of this guide. +For more information on these calls, you can refer to the [Probe handling](#handling-probes) section of this guide. -### Examples +### Examples -#### Check if the server accepts TCP connections. +#### Check if the server accepts TCP connections -This is the simplest method to set up. It is compatible with `tcp` and `http` farms. If no other probes are configured, you can activate it to start. It works by periodically attempting to establish a connection on each of your servers. If the connection fails twice in a row, the server is put aside until it responds again. +This is the simplest probe to set up. It is compatible with `tcp` and `http` farms. If no other probe is configured, you can activate this one to start. It works by periodically trying to open a connection on each of your servers. If the connection fails twice in a row, the server is put aside until it responds again. -In practice, this gives a probe: +In practice, this gives a probe : |Field|Value and description| |---|---| -|serviceName|Your OVH Load Balancer ID| -|farmId|Your TCP or HTTP farm| +|serviceName|Identifier of your OVHcloud Load Balancer| +|farmId|Identifier of your TCP or HTTP farm| |probe.type|"tcp"| -All other probe fields can keep their default values. Just apply the configuration to the zone concerned, and the probe will begin to work. +All other `probe` fields can remain at their default values. You just need to apply the configuration in the relevant area. -#### Test a specific HTTP page. +#### Test a specific HTTP page -By default, the HTTP `probe` sends an "OPTIONS" request on "/" in HTTP/1.0, without a domain name. In many cases, this is sufficient, but some servers do not manage this method. You can carry out much more powerful tests with the HTTP probe. For example, a good practice when exposing a HTTP service is to add a router dedicated to probes. It is normal to see "/status", "/health", and "/check", which summarise the service’s status. +By default, the HTTP probe sends an `OPTIONS` request on `/` in HTTP/1.0, without a domain name. This is sufficient in many cases, but some servers do not handle this method.
+It is possible to perform much more powerful tests with the HTTP probe. For example, a good practice when exposing an HTTP service is to add a dedicated route for probes. It is common to find `/status`, `/health`, `/check` which return a summary of the service's status. -In practice, if you want to configure the probe to send a "GET" request on [http://api.example.com/status](http://api.example.com/status), it gives: +In practice, if you want to configure the probe to send a `GET` request to [http://api.example.com/status](http://api.example.com/status), this gives : |Field|Value and description| |---|---| -|serviceName|Your OVH Load Balancer ID| -|farmId|Your TCP or HTTP farm| +|serviceName|Identifier of your OVHcloud Load Balancer| +|farmId|Identifier of your TCP or HTTP farm| |probe.type|http| |probe.method|GET| |probe.url|[http://api.example.com/status](http://api.example.com/status)| |probe.match|status| -|probe.pattern|200 (multiple status codes can be added, provided they are separated by commas)| +|probe.pattern|200 (several status codes can be added, separated by commas)| -All other probe fields can keep their default values. Finally, apply the configuration to the zone concerned. +All other `probe` fields can remain at their default values. It is then sufficient to apply the configuration in the relevant area. -#### Use an external HTTP test. +#### Use an external HTTP test -What happens if, for example, your service is an IMAP server that relies on an LDAP server for authentication? The server may accept connections, but experience a temporary connection issue with the LDAP server. If this happens, the customers redirected to this server would be able to connect, but wouldn’t be able to authenticate. As a result, the server would need to be removed from the farm. +What if your service is, for example, an IMAP server that relies on an LDAP server for authentication ?
+It is possible that the server accepts connections, but has a temporary connection issue with the LDAP server. If this happens, clients who are directed to this server could connect but not authenticate. The server should therefore be removed from the farm. -If you are using a `tcp` probe, it will manage to connect. As a result, it will consider the service to be available, even though this is not the case. +If a `tcp` type probe is used, it will be able to connect and consider the service available even though it is not the case. -In this situation, the health test would ideally be able to confirm that the basic service works. You can provide a specific port to use in the tests. This way, you can set up arbitrary tests for a service, and expose them to HTTP on a dedicated port. +In this scenario, the ideal would be for the health check to confirm that the base service is working. It is possible to indicate a specific port to use in the tests. This allows arbitrary tests to be set up for a service and exposed in HTTP, on a dedicated port. -For example, in this situation, you can have a HTTP server on port 8080\. It will test the IMAP server via the URL "/service/imap/status", and will return ‘OK’ when everything is working properly. In practice, this will return: +For example, in this scenario, it would be possible to have an HTTP server on port 8080 that tests the IMAP server via the url `/service/imap/status` and returns *OK* when everything is fine. This would give in practice : |Field|Value and description| |---|---| -|serviceName|Your OVH Load Balancer ID| -|farmId|Your TCP or HTTP farm| +|serviceName|Identifier of your OVHcloud Load Balancer| +|farmId|Identifier of your TCP or HTTP farm| |probe.type|http| |probe.port|8080| |probe.method|GET| @@ -118,24 +144,24 @@ For example, in this situation, you can have a HTTP server on port 8080\. It wil |probe.match|contains| |probe.pattern|OK| -Just apply the configuration to the zone concerned, and the probe will begin to work. +It is then sufficient to apply the configuration in the relevant area. > [!warning] > -> If the HTTP service dedicated to monitoring your IMAP service experiences a fault, the IMAP service will also be considered faulty, even if it is working properly. +> If the HTTP service dedicated to monitoring your IMAP service itself fails, the IMAP service will also be considered as failed, even if it is in perfect working condition. > -### Reference +### Reference -#### Probe configuration. +#### Probe handling -##### Configure a probe. +##### **Configure a probe** -Probes can be configured on a new farm (`POST`) or an existing one (`PUT`). Since the two methods are equivalent, only the second (`PUT`) method is presented here. +Probes can be configured on a new farm (`POST`) or an existing farm (`PUT`). The two methods being equivalent, only the second one (`PUT`) will be presented here. > [!faq] > -> Service: +> Service : > >> > [!api] >> > @@ -143,85 +169,86 @@ Probes can be configured on a new farm (`POST`) or an existing one (`PUT`). Sinc >> > >> > -> Settings: +> Parameters : > >> > **serviceName** >> > ->> >> Your OVH Load Balancer ID. +>> >> The identifier of your OVHcloud Load Balancer. >> > >> > **farmId** >> > ->> >> Your `farm` ID number. +>> >> The numeric identifier of your `farm`. >> > >> > **probe** >> > >> >> **type** >> >> ->> >> > The type of `probe` to activate. The probe types managed are: +>> >> > The type of `probe` to enable. The probe types handled are : >> >> > ->> >> > `tcp` for a basic TCP connection test. +>> >> > `tcp` for a basic TCP connection test ; >> >> > ->> >> > `http` for a HTTP connection test. You can specify the URL and the method. +>> >> > `http` for an HTTP connection test. It is possible to specify the URL and method ; >> >> > ->> >> > `smtp` for a basic SMTP connection test. +>> >> > `smtp` for a basic SMTP connection test ; >> >> > ->> >> > `mysql` for a basic MySQL connection test. +>> >> > `mysql` for a basic MySQL connection test ; >> >> > ->> >> > `pgsql` for a basic PostgreSQL connection test. +>> >> > `pgslq` for a basic PostgreSQL connection test ; >> >> > ->> >> > `oco` for a confirmation of the general status returned on port 79. +>> >> > `oco` for a general status validation returned on port 79. >> > >> >> **interval** >> >> ->> >> > The interval (in seconds) between a probe’s two connection attempts. It must be at least 30 seconds. +>> >> > The interval in seconds between two probe attempts. It must be at least 30 seconds. >> > >> >> **port** >> >> ->> >> > The port that the probe must use, if it is different to the port configured on the farm. ->> >> > This enables you to delegate a server’s status validation to a separate service on the machine, and carry out arbitrary probes. +>> >> > The port that the probe should use, if it is different from the one configured on the farm. +>> >> > This allows you to delegate the server status validation to a third-party service on the machine and perform arbitrary probes. >> > >> >> **method** >> >> ->> >> > The HTTP method to use if the probe is a “http” probe. ->> >> > Compatible methods are `GET`, `HEAD` and `OPTIONS` (by default). +>> >> > The HTTP method to use if the probe is of type "http". +>> >> > The compatible methods are `GET`, `HEAD` and `OPTIONS` (default). >> > >> >> **url** >> >> ->> >> > The URL to use for tests, if it is a “http” probe type. ->> >> > It should be formulated as follows: `[[https?://]www.example.com]/path/to/check`. ->> >> > If a domain is specified, its request will be sent to HTTP/1.1 rather than HTTP/1.0 by default. +>> >> > The URL to use for the tests, if the probe is of type "http". +>> >> > Its form must be `[[https?://]www.example.com]/path/to/check`. +>> >> > If a domain is specified, the request will be sent in HTTP/1.1 instead of HTTP/1.0 by default. >> > >> >> **match** >> >> ->> >> > The type of comparison to use to check if the server is in good health. ->> >> > The managed comparison types are `default`, `status`, `contains` and `matches`. ->> >> > Comparison types are compatible with both “http” and “tcp” probes. +>> >> > The type of comparator to use to check that the server is healthy. +>> >> > The comparators handled are `default`, `status`, `contains` and `matches`. +>> >> > The comparators are compatible with "http" and "tcp" probes. >> > >> >> **pattern** >> >> ->> >> > The value to use as an argument of the comparison type if it is different from “default”. +>> >> > The value to use as an argument for the comparator if it is different from "default". >> > >> >> **forceSsl** >> >> ->> >> > This defines whether the probe must work in SSL/TLS, even if the farm is configured to connect via standard TCP. ->> >> > This can be useful when, for example, your OVH Load Balancer is configured to monitor HTTPS traffic in TCP without decrypting it. +>> >> > Defines whether the probe should work in SSL/TLS even if the farm is configured to connect in classic TCP. +>> >> > This can be useful, for example, when your OVHcloud Load Balancer is configured to forward HTTPS traffic in TCP without decrypting it. > -Other settings can be edited via this call. Since this guide focuses on probes, they are not documented here. +Other parameters can be edited via this call. As this guide focuses on probes, they are not documented here. -If a port other than the farm’s base port is configured on the probe, the `proxyprotocol` and `ssl` settings are reset. As an example, we will take a configured farm to use `proxyprotocol` on **port 4242**, and an associated probe using **port 8080**. The probe will not send the `proxyprotocol` header when it connects on **port 8080**. The same goes for `ssl`, but it can be forced. +If a port other than the base port of the farm is configured on the probe, the `proxyprotocol` and `ssl` parameters are reset. Take the example of a farm configured to use `proxyprotocol` on port **4242** and a probe associated with port **8080**: the latter will not send the `proxyprotocol` header when connecting to port **8080**. The same applies to `ssl`, which can nevertheless be forced. > [!warning] > -> When a probe is configured on a farm, it must be activated on the servers. +> When a probe is configured on a farm, it must also be enabled on the servers. > -##### Activate probes on a server. -For a probe to be active, it must be configured on the farm and activated on the servers concerned. With this call, you can activate the probe being taken into account: +##### **Enable probes on a server** + +For a probe to be active, it must have been configured on the farm and enabled on the relevant servers. This call allows you to enable the probe : > [!faq] > -> Service: +> Service : > >> > [!api] >> > @@ -229,47 +256,47 @@ For a probe to be active, it must be configured on the farm and activated on the >> > >> > -> Settings: +> Parameters : > >> > **serviceName** >> > ->> >> Your OVH Load Balancer ID. +>> >> The identifier of your OVHcloud Load Balancer. >> > >> > **farmId** >> > ->> >> Your `farm` ID number. +>> >> The numeric identifier of your `farm`. >> > >> > **serverId** >> > ->> >> Your `server’s` ID number. +>> >> The numeric identifier of your `server`. >> > >> > **probe** >> > ->> >> Whether or not the `probes` must be taken into account. +>> >> Indicates whether `probe` should be taken into account or not. > -Other settings can be edited via this call. Since this guide focuses on probes, they are not documented here. +Other parameters can be edited via this call. As this guide focuses on probes, they are not documented here. -#### Available comparison types. +#### Available comparators -Four comparison types are available to confirm a probe’s results: +Four comparators are available to validate the result of a probe : -|Comparison type|Description| +|Comparator|Description| |---|---| -|default|Launches a basic test, without any settings.| -|status|A list of valid HTTP response codes, separated by commas.| -|contains|Checks that the pattern can be found in the response.| -|matches|Checks that the response corresponds to a regular expression pattern.| +|default|Runs a basic test, without parameters.| +|status|Comma-separated list of valid HTTP return codes.| +|contains|Checks that the pattern is in the response.| +|matches|Checks that the response matches the pattern regular expression.| -‘Contains’ and ‘matches’ comparison types find a correspondence in the first 16 KB of the response. If the response is longer than 16 KB, whatever comes afterwards will be ignored during the test. Please note that to optimise your performance, we recommend returning as little information as possible in your probes. +The `contains` and `matches` comparators look for a match in the first 16 KB of the response. If it is longer, the part beyond will be ignored during the search. Note that for better performance, we recommend returning as little information as possible in your probes. -#### Available probes. +#### Available probes -You can get a list of the available probes using the following API call: +The list of available probes can be obtained with the API call : > [!faq] > -> Service: +> Service : > >> > [!api] >> > @@ -277,56 +304,56 @@ You can get a list of the available probes using the following API call: >> > >> > -> Response: +> Response : > >> > **type** >> > ->> >> The type of `probe` to configure in the `probe.type` of `farms`. +>> >> The type of `probe` to configure in the `probe.type` field of the `farms`. >> >> ->> >> The probe types managed are: +>> >> The probe types handled are : >> >> ->> >> `tcp` for a basic TCP connection test. +>> >> `tcp` for a basic TCP connection test ; >> >> ->> >> `http` for a HTTP connection test. You can specify the URL and the method. +>> >> `http` for an HTTP connection test. It is possible to specify the URL and method ; >> >> ->> >> `smtp` for a basic SMTP connection test. +>> >> `smtp` for a basic SMTP connection test ; >> >> ->> >> `mysql` for a basic MySQL connection test. +>> >> `mysql` for a basic MySQL connection test ; >> >> ->> >> `pgsql` for a basic PostgreSQL connection test. +>> >> `pgslq` for a basic PostgreSQL connection test ; >> >> ->> >> `oco` for a confirmation of the general status returned on port 79. +>> >> `oco` for a general status validation returned on port 79. >> > >> > **port** >> > ->> >> This defines whether the port can be configured for this probe. +>> >> Indicates whether the port can be configured for this probe. >> > >> > **method** >> > ->> >> The list of HTTP methods managed, or `null` if none are managed. +>> >> The list of HTTP methods handled or `null` if none exist. >> > >> > **url** >> > ->> >> This defines if the probe’s URL can be configured. +>> >> Indicates whether the probe URL can be configured. >> > >> > **matches** >> > ->> >> The list of comparison types available for this probe. +>> >> The list of available comparators for this probe. >> >> The interpretation of the `probe.pattern` field depends on this field. ->> >> The comparison types potentially managed are: +>> >> The potentially handled comparators are : >> >> ->> >> `default`. The most simple test, without any particular conditions.`probe.pattern` must be empty. +>> >> `default` the simplest test, without specific conditions. `probe.pattern` must be empty ; >> >> ->> >> `status`. Checks if the HTTP status code is in the list separated by commas. +>> >> `status` checks that the HTTP status code is in the comma-separated list ; >> >> ->> >> `contains`. Checks that the server response contains `probe.pattern`. +>> >> `contains` checks that the server response contains `probe.pattern` ; >> >> ->> >> `matches`. Checks that the server response matches `probe.pattern`. +>> >> `matches` checks that the server response matches `probe.pattern`. > -##### TCP +##### **TCP** -This probe attempts to establish a TCP connection to the server. If the server sends a “banner”, you can check if it matches a schema. The default test simply ensures that the connection can be established. +This probe attempts to establish a TCP connection with the server. If the latter sends a "banner", it is possible to check that it matches a pattern. The default test simply ensures that the connection can be established. |Fields|Description| |---|---| @@ -336,29 +363,29 @@ This probe attempts to establish a TCP connection to the server. If the server s |URL|Not supported| |matches|`default`, `contains` or `matches`| -##### HTTP +##### **HTTP** -This probe attempts to establish a HTTP connection to the server. If the server responds, you can check its HTTP status code, and that the response body matches a schema. The default test sends an OPTIONS request to the '/' page in HTTP/1.0, without a Host field. +This probe attempts to establish an HTTP connection with the server. If the latter responds, it is possible to check its HTTP status code or that the response body matches a pattern. The default test sends an OPTIONS request to the '/' page in HTTP/1.0, without the Host field. |Fields|Description| |---|---| |type|`http`| |port|Configurable| |method|`GET`, `HEAD` or `OPTIONS`| -|URL|URL in the form: \[\[https?://]www.example.com]/path/to/check| +|URL|URL of the form [[https?://]www.example.com]/path/to/check| |matches|`default`, `contains` or `matches`| -If the URL is specified, the domain name and protocol are operational. If a domain name is specified, the “Host” field of the request will be filled in, and the request will be sent to HTTP/1.1. If the protocol is specified, it must be consistent with the farm’s SSL configuration. +If a URL is specified, the domain name and protocol are operational. If a domain name is specified, the "Host" field of the request will be filled in and the request will be sent in HTTP/1.1. If the protocol is specified, it must be consistent with the SSL configuration of the farm. > [!primary] > -> We recommend configuring the method, at least, with GET. -> Some servers, including NGINX, do not manage the OPTIONS method without it being configured in advance. +> It is recommended to configure at least the method with GET. +> Indeed, some servers -including Nginx- do not handle the OPTIONS method without prior configuration. > -##### SMTP +##### **SMTP** -This probe attempts to establish an SMTP connection with the server, and sends the command "HELLO localhost". If the server responds, the probe checks that the response code starts with a ‘2’ (success). This probe does not have any specific configuration options. +This probe attempts to establish an SMTP connection with the server and sends the "HELLO localhost" command. If the latter responds, the probe checks that the return code starts with a "2" (success). This probe has no specific configuration options. |Fields|Description| |---|---| @@ -368,9 +395,9 @@ This probe attempts to establish an SMTP connection with the server, and sends t |URL|Not supported| |matches|`default`| -##### MySQL +##### **MySQL** -This probe attempts to establish a MySQL connection with the server, and analyses the server’s response. This probe does not have any specific configuration options. +This probe attempts to establish a MySQL connection with the server and analyses the server's response. This probe has no specific configuration options. |Fields|Description| |---|---| @@ -380,9 +407,9 @@ This probe attempts to establish a MySQL connection with the server, and analyse |URL|Not supported| |matches|`default`| -##### PostgreSQL +##### **PostgreSQL** -This probe attempts to establish a PostgreSQL connection with the server, and analyses the server’s response. This probe does not have any specific configuration options. +This probe attempts to establish a PostgreSQL connection with the server and analyses the server's response. This probe has no specific configuration options. |Fields|Description| |---|---| @@ -392,9 +419,9 @@ This probe attempts to establish a PostgreSQL connection with the server, and an |URL|Not supported| |matches|`default`| -##### oco +##### **oco** -This probe attempts to establish a TCP connection on port 79 of your server, and checks that the response starts with a ‘2’ (success). This probe does not have any specific configuration options. +This probe attempts to establish a TCP connection on port 79 of your server and checks that the response starts with a "2" (success). This probe has no specific configuration options. |Fields|Description| |---|---| @@ -404,20 +431,24 @@ This probe attempts to establish a TCP connection on port 79 of your server, and |URL|Not supported| |matches|`default`| -## Via the OVH Control Panel. +### From the OVHcloud Control Panel -You can configure probes when you add (or modify) a server farm, in advanced settings. +You can configure probes when you add or modify a server farm, in advanced settings. -![Advanced settings for a farm](images/farm_advanced_settings.png){.thumbnail} +![Advanced farm settings](images/farm_advanced_settings.png){.thumbnail} -This is how you access the probe type’s configuration. +You will then have access to the configuration for the probe type. ![Probe settings](images/farm_advanced_settings_unfolded.png){.thumbnail} -If you are able to do so with the probe type you have selected, you can configure specific advanced settings for the probe. +If the probe type you have selected allows it, you can configure advanced settings that are specific to that probe. -![Advanced settings for a probe](images/probe_settings.png){.thumbnail} +![Advanced probe settings](images/probe_settings.png){.thumbnail} A new configuration window will appear, with the probe’s settings. -![Advanced settings for a probe](images/probe_settings_dialog.png){.thumbnail} +![Advanced probe settings](images/probe_settings_dialog.png){.thumbnail} + +## Go further + +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_probes/guide.en-ca.md b/pages/network/load_balancer/create_probes/guide.en-ca.md index 52be1704be5..d774b695308 100644 --- a/pages/network/load_balancer/create_probes/guide.en-ca.md +++ b/pages/network/load_balancer/create_probes/guide.en-ca.md @@ -1,45 +1,69 @@ --- -title: 'Working with probes' -excerpt: 'Find out about the general principles behind probes, and why they are used' -updated: 2019-02-12 +title: "Configuration of probes on an OVHcloud Load Balancer service" +excerpt: "Discover the general principles and use cases for probes" +updated: 2025-11-12 --- -## Objective + -With the OVH Load Balancer, you can distribute a front-end’s incoming traffic across a set of servers in a destination farm. +## Objective -There may be instances where a server in your farm becomes unavailable for a number of reasons, including oversaturation, an incident, or scheduled maintenance. When the OVH Load Balancer detects a connection error, it will try to redirect traffic to another server. The connection will be slower, but it will continue to work. +The OVHcloud Load Balancer allows you to distribute incoming traffic on a frontend to a set of servers in a destination farm. -However, the reasons behind certain types of unavailability can be harder to pinpoint. For example, if a new version of code is being deployed, the application may momentarily experience a glitch, and return a 500 error. In this particular case, a solution would be to mark the servers concerned as unavailable in the API before you begin the maintenance work, apply the configuration and update, then mark the server as available again. This method is not ideal, but it works. For more information on deploying a blue-green architecture with an OVH Load Balancer, please read our guide: . +It may happen that one of the servers in your farm is no longer available for various reasons, such as overload, an incident, or scheduled maintenance. When it encounters a connection error, your OVHcloud Load Balancer attempts to switch traffic to another server. The connection will be slowed down, but it will continue to function. -The purpose of a probe is to test an infrastructure’s health. It periodically examines each of your servers, to ensure that they are working properly. If it detects an error, the server is automatically disabled until the situation is resolved. +However, the causes of some unavailability are more subtle. For example, if a new version of the code is being deployed, the application may temporarily be in a transitional state and return 500 errors. In this specific case, one solution would be to mark the affected servers as unavailable in the API before the start of the maintenance, apply the configuration and update, and then mark the server as available again. This method is not ideal, but it works.
+For more details on deploying a Blue-Green architecture with your OVHcloud Load Balancer, refer to [this guide](/pages/network/load_balancer/case_blue_green). -Since this service is still very new, its basic features are only available in the API. +Probes are health checks. They periodically query each of your servers to ensure they are operational. If an error is detected, the server is automatically disabled until the situation is resolved. -**This guide will explain the general principles behind probes, and provide practical examples of probes being used.** +**This guide will present the general principles, as well as usage scenarios for probes, drawn from real-world use cases.** ## Requirements -- a correctly configured OVH Load Balancer, with farms and servers set +- Have an [OVHcloud Load Balancer](/links/network/load-balancer) offer in your OVHcloud account. The service must be properly configured, with farms and servers set up. +- Be logged in to your [OVHcloud Control Panel](/links/manager). ## Instructions -### An introduction to the API. +**Table of contents** + +- [Probe API overview](#probe-api) +- [Examples](#examples) +- [Reference](#reference) +- [From the OVHcloud Control Panel](#manager) + +### Probe API overview -The API for probes in the OVH Load Balancer is designed to be flexible and scalable. +The probe API of your OVHcloud Load Balancer has been designed to be flexible and scalable. -The probes can be configured directly on the farms. All of the servers from a single farm will have exactly the same probe applied. However, probe activation and deactivation is specific for each server. As a result, it is possible to only monitor certain servers within a single farm. +Probes are configured directly on the farms. All servers in the same farm thus apply exactly the same probe. However, enabling or disabling a probe is specific to each server. It is therefore possible to "monitor" only certain servers in the same farm. -You can view the list of available probes and their settings with the following API call: +The list of available probes and their parameters can be consulted with the API call : > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmProbes > -For more information on this call, please read the *Available probes* section at the bottom of this guide. +For more information on this call, we invite you to consult the [Available probes](#available-probes) section at the bottom of this guide. -The probes in this list can be configured on `http` and `tcp` farms via the following calls: +The probes returned by this list can be configured on `http` and `tcp` farms via the following calls : > [!api] > @@ -61,56 +85,58 @@ The probes in this list can be configured on `http` and `tcp` farms via the foll > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId} > -For more information on these calls, please read the *Probe configuration* section at the bottom of this guide. +For more information on these calls, you can refer to the [Probe handling](#handling-probes) section of this guide. -### Examples +### Examples -#### Check if the server accepts TCP connections. +#### Check if the server accepts TCP connections -This is the simplest method to set up. It is compatible with `tcp` and `http` farms. If no other probes are configured, you can activate it to start. It works by periodically attempting to establish a connection on each of your servers. If the connection fails twice in a row, the server is put aside until it responds again. +This is the simplest probe to set up. It is compatible with `tcp` and `http` farms. If no other probe is configured, you can activate this one to start. It works by periodically trying to open a connection on each of your servers. If the connection fails twice in a row, the server is put aside until it responds again. -In practice, this gives a probe: +In practice, this gives a probe : |Field|Value and description| |---|---| -|serviceName|Your OVH Load Balancer ID| -|farmId|Your TCP or HTTP farm| +|serviceName|Identifier of your OVHcloud Load Balancer| +|farmId|Identifier of your TCP or HTTP farm| |probe.type|"tcp"| -All other probe fields can keep their default values. Just apply the configuration to the zone concerned, and the probe will begin to work. +All other `probe` fields can remain at their default values. You just need to apply the configuration in the relevant area. -#### Test a specific HTTP page. +#### Test a specific HTTP page -By default, the HTTP `probe` sends an "OPTIONS" request on "/" in HTTP/1.0, without a domain name. In many cases, this is sufficient, but some servers do not manage this method. You can carry out much more powerful tests with the HTTP probe. For example, a good practice when exposing a HTTP service is to add a router dedicated to probes. It is normal to see "/status", "/health", and "/check", which summarise the service’s status. +By default, the HTTP probe sends an `OPTIONS` request on `/` in HTTP/1.0, without a domain name. This is sufficient in many cases, but some servers do not handle this method.
+It is possible to perform much more powerful tests with the HTTP probe. For example, a good practice when exposing an HTTP service is to add a dedicated route for probes. It is common to find `/status`, `/health`, `/check` which return a summary of the service's status. -In practice, if you want to configure the probe to send a "GET" request on [http://api.example.com/status](http://api.example.com/status), it gives: +In practice, if you want to configure the probe to send a `GET` request to [http://api.example.com/status](http://api.example.com/status), this gives : |Field|Value and description| |---|---| -|serviceName|Your OVH Load Balancer ID| -|farmId|Your TCP or HTTP farm| +|serviceName|Identifier of your OVHcloud Load Balancer| +|farmId|Identifier of your TCP or HTTP farm| |probe.type|http| |probe.method|GET| |probe.url|[http://api.example.com/status](http://api.example.com/status)| |probe.match|status| -|probe.pattern|200 (multiple status codes can be added, provided they are separated by commas)| +|probe.pattern|200 (several status codes can be added, separated by commas)| -All other probe fields can keep their default values. Finally, apply the configuration to the zone concerned. +All other `probe` fields can remain at their default values. It is then sufficient to apply the configuration in the relevant area. -#### Use an external HTTP test. +#### Use an external HTTP test -What happens if, for example, your service is an IMAP server that relies on an LDAP server for authentication? The server may accept connections, but experience a temporary connection issue with the LDAP server. If this happens, the customers redirected to this server would be able to connect, but wouldn’t be able to authenticate. As a result, the server would need to be removed from the farm. +What if your service is, for example, an IMAP server that relies on an LDAP server for authentication ?
+It is possible that the server accepts connections, but has a temporary connection issue with the LDAP server. If this happens, clients who are directed to this server could connect but not authenticate. The server should therefore be removed from the farm. -If you are using a `tcp` probe, it will manage to connect. As a result, it will consider the service to be available, even though this is not the case. +If a `tcp` type probe is used, it will be able to connect and consider the service available even though it is not the case. -In this situation, the health test would ideally be able to confirm that the basic service works. You can provide a specific port to use in the tests. This way, you can set up arbitrary tests for a service, and expose them to HTTP on a dedicated port. +In this scenario, the ideal would be for the health check to confirm that the base service is working. It is possible to indicate a specific port to use in the tests. This allows arbitrary tests to be set up for a service and exposed in HTTP, on a dedicated port. -For example, in this situation, you can have a HTTP server on port 8080\. It will test the IMAP server via the URL "/service/imap/status", and will return ‘OK’ when everything is working properly. In practice, this will return: +For example, in this scenario, it would be possible to have an HTTP server on port 8080 that tests the IMAP server via the url `/service/imap/status` and returns *OK* when everything is fine. This would give in practice : |Field|Value and description| |---|---| -|serviceName|Your OVH Load Balancer ID| -|farmId|Your TCP or HTTP farm| +|serviceName|Identifier of your OVHcloud Load Balancer| +|farmId|Identifier of your TCP or HTTP farm| |probe.type|http| |probe.port|8080| |probe.method|GET| @@ -118,24 +144,24 @@ For example, in this situation, you can have a HTTP server on port 8080\. It wil |probe.match|contains| |probe.pattern|OK| -Just apply the configuration to the zone concerned, and the probe will begin to work. +It is then sufficient to apply the configuration in the relevant area. > [!warning] > -> If the HTTP service dedicated to monitoring your IMAP service experiences a fault, the IMAP service will also be considered faulty, even if it is working properly. +> If the HTTP service dedicated to monitoring your IMAP service itself fails, the IMAP service will also be considered as failed, even if it is in perfect working condition. > -### Reference +### Reference -#### Probe configuration. +#### Probe handling -##### Configure a probe. +##### **Configure a probe** -Probes can be configured on a new farm (`POST`) or an existing one (`PUT`). Since the two methods are equivalent, only the second (`PUT`) method is presented here. +Probes can be configured on a new farm (`POST`) or an existing farm (`PUT`). The two methods being equivalent, only the second one (`PUT`) will be presented here. > [!faq] > -> Service: +> Service : > >> > [!api] >> > @@ -143,85 +169,86 @@ Probes can be configured on a new farm (`POST`) or an existing one (`PUT`). Sinc >> > >> > -> Settings: +> Parameters : > >> > **serviceName** >> > ->> >> Your OVH Load Balancer ID. +>> >> The identifier of your OVHcloud Load Balancer. >> > >> > **farmId** >> > ->> >> Your `farm` ID number. +>> >> The numeric identifier of your `farm`. >> > >> > **probe** >> > >> >> **type** >> >> ->> >> > The type of `probe` to activate. The probe types managed are: +>> >> > The type of `probe` to enable. The probe types handled are : >> >> > ->> >> > `tcp` for a basic TCP connection test. +>> >> > `tcp` for a basic TCP connection test ; >> >> > ->> >> > `http` for a HTTP connection test. You can specify the URL and the method. +>> >> > `http` for an HTTP connection test. It is possible to specify the URL and method ; >> >> > ->> >> > `smtp` for a basic SMTP connection test. +>> >> > `smtp` for a basic SMTP connection test ; >> >> > ->> >> > `mysql` for a basic MySQL connection test. +>> >> > `mysql` for a basic MySQL connection test ; >> >> > ->> >> > `pgsql` for a basic PostgreSQL connection test. +>> >> > `pgslq` for a basic PostgreSQL connection test ; >> >> > ->> >> > `oco` for a confirmation of the general status returned on port 79. +>> >> > `oco` for a general status validation returned on port 79. >> > >> >> **interval** >> >> ->> >> > The interval (in seconds) between a probe’s two connection attempts. It must be at least 30 seconds. +>> >> > The interval in seconds between two probe attempts. It must be at least 30 seconds. >> > >> >> **port** >> >> ->> >> > The port that the probe must use, if it is different to the port configured on the farm. ->> >> > This enables you to delegate a server’s status validation to a separate service on the machine, and carry out arbitrary probes. +>> >> > The port that the probe should use, if it is different from the one configured on the farm. +>> >> > This allows you to delegate the server status validation to a third-party service on the machine and perform arbitrary probes. >> > >> >> **method** >> >> ->> >> > The HTTP method to use if the probe is a “http” probe. ->> >> > Compatible methods are `GET`, `HEAD` and `OPTIONS` (by default). +>> >> > The HTTP method to use if the probe is of type "http". +>> >> > The compatible methods are `GET`, `HEAD` and `OPTIONS` (default). >> > >> >> **url** >> >> ->> >> > The URL to use for tests, if it is a “http” probe type. ->> >> > It should be formulated as follows: `[[https?://]www.example.com]/path/to/check`. ->> >> > If a domain is specified, its request will be sent to HTTP/1.1 rather than HTTP/1.0 by default. +>> >> > The URL to use for the tests, if the probe is of type "http". +>> >> > Its form must be `[[https?://]www.example.com]/path/to/check`. +>> >> > If a domain is specified, the request will be sent in HTTP/1.1 instead of HTTP/1.0 by default. >> > >> >> **match** >> >> ->> >> > The type of comparison to use to check if the server is in good health. ->> >> > The managed comparison types are `default`, `status`, `contains` and `matches`. ->> >> > Comparison types are compatible with both “http” and “tcp” probes. +>> >> > The type of comparator to use to check that the server is healthy. +>> >> > The comparators handled are `default`, `status`, `contains` and `matches`. +>> >> > The comparators are compatible with "http" and "tcp" probes. >> > >> >> **pattern** >> >> ->> >> > The value to use as an argument of the comparison type if it is different from “default”. +>> >> > The value to use as an argument for the comparator if it is different from "default". >> > >> >> **forceSsl** >> >> ->> >> > This defines whether the probe must work in SSL/TLS, even if the farm is configured to connect via standard TCP. ->> >> > This can be useful when, for example, your OVH Load Balancer is configured to monitor HTTPS traffic in TCP without decrypting it. +>> >> > Defines whether the probe should work in SSL/TLS even if the farm is configured to connect in classic TCP. +>> >> > This can be useful, for example, when your OVHcloud Load Balancer is configured to forward HTTPS traffic in TCP without decrypting it. > -Other settings can be edited via this call. Since this guide focuses on probes, they are not documented here. +Other parameters can be edited via this call. As this guide focuses on probes, they are not documented here. -If a port other than the farm’s base port is configured on the probe, the `proxyprotocol` and `ssl` settings are reset. As an example, we will take a configured farm to use `proxyprotocol` on **port 4242**, and an associated probe using **port 8080**. The probe will not send the `proxyprotocol` header when it connects on **port 8080**. The same goes for `ssl`, but it can be forced. +If a port other than the base port of the farm is configured on the probe, the `proxyprotocol` and `ssl` parameters are reset. Take the example of a farm configured to use `proxyprotocol` on port **4242** and a probe associated with port **8080**: the latter will not send the `proxyprotocol` header when connecting to port **8080**. The same applies to `ssl`, which can nevertheless be forced. > [!warning] > -> When a probe is configured on a farm, it must be activated on the servers. +> When a probe is configured on a farm, it must also be enabled on the servers. > -##### Activate probes on a server. -For a probe to be active, it must be configured on the farm and activated on the servers concerned. With this call, you can activate the probe being taken into account: +##### **Enable probes on a server** + +For a probe to be active, it must have been configured on the farm and enabled on the relevant servers. This call allows you to enable the probe : > [!faq] > -> Service: +> Service : > >> > [!api] >> > @@ -229,47 +256,47 @@ For a probe to be active, it must be configured on the farm and activated on the >> > >> > -> Settings: +> Parameters : > >> > **serviceName** >> > ->> >> Your OVH Load Balancer ID. +>> >> The identifier of your OVHcloud Load Balancer. >> > >> > **farmId** >> > ->> >> Your `farm` ID number. +>> >> The numeric identifier of your `farm`. >> > >> > **serverId** >> > ->> >> Your `server’s` ID number. +>> >> The numeric identifier of your `server`. >> > >> > **probe** >> > ->> >> Whether or not the `probes` must be taken into account. +>> >> Indicates whether `probe` should be taken into account or not. > -Other settings can be edited via this call. Since this guide focuses on probes, they are not documented here. +Other parameters can be edited via this call. As this guide focuses on probes, they are not documented here. -#### Available comparison types. +#### Available comparators -Four comparison types are available to confirm a probe’s results: +Four comparators are available to validate the result of a probe : -|Comparison type|Description| +|Comparator|Description| |---|---| -|default|Launches a basic test, without any settings.| -|status|A list of valid HTTP response codes, separated by commas.| -|contains|Checks that the pattern can be found in the response.| -|matches|Checks that the response corresponds to a regular expression pattern.| +|default|Runs a basic test, without parameters.| +|status|Comma-separated list of valid HTTP return codes.| +|contains|Checks that the pattern is in the response.| +|matches|Checks that the response matches the pattern regular expression.| -‘Contains’ and ‘matches’ comparison types find a correspondence in the first 16 KB of the response. If the response is longer than 16 KB, whatever comes afterwards will be ignored during the test. Please note that to optimise your performance, we recommend returning as little information as possible in your probes. +The `contains` and `matches` comparators look for a match in the first 16 KB of the response. If it is longer, the part beyond will be ignored during the search. Note that for better performance, we recommend returning as little information as possible in your probes. -#### Available probes. +#### Available probes -You can get a list of the available probes using the following API call: +The list of available probes can be obtained with the API call : > [!faq] > -> Service: +> Service : > >> > [!api] >> > @@ -277,56 +304,56 @@ You can get a list of the available probes using the following API call: >> > >> > -> Response: +> Response : > >> > **type** >> > ->> >> The type of `probe` to configure in the `probe.type` of `farms`. +>> >> The type of `probe` to configure in the `probe.type` field of the `farms`. >> >> ->> >> The probe types managed are: +>> >> The probe types handled are : >> >> ->> >> `tcp` for a basic TCP connection test. +>> >> `tcp` for a basic TCP connection test ; >> >> ->> >> `http` for a HTTP connection test. You can specify the URL and the method. +>> >> `http` for an HTTP connection test. It is possible to specify the URL and method ; >> >> ->> >> `smtp` for a basic SMTP connection test. +>> >> `smtp` for a basic SMTP connection test ; >> >> ->> >> `mysql` for a basic MySQL connection test. +>> >> `mysql` for a basic MySQL connection test ; >> >> ->> >> `pgsql` for a basic PostgreSQL connection test. +>> >> `pgslq` for a basic PostgreSQL connection test ; >> >> ->> >> `oco` for a confirmation of the general status returned on port 79. +>> >> `oco` for a general status validation returned on port 79. >> > >> > **port** >> > ->> >> This defines whether the port can be configured for this probe. +>> >> Indicates whether the port can be configured for this probe. >> > >> > **method** >> > ->> >> The list of HTTP methods managed, or `null` if none are managed. +>> >> The list of HTTP methods handled or `null` if none exist. >> > >> > **url** >> > ->> >> This defines if the probe’s URL can be configured. +>> >> Indicates whether the probe URL can be configured. >> > >> > **matches** >> > ->> >> The list of comparison types available for this probe. +>> >> The list of available comparators for this probe. >> >> The interpretation of the `probe.pattern` field depends on this field. ->> >> The comparison types potentially managed are: +>> >> The potentially handled comparators are : >> >> ->> >> `default`. The most simple test, without any particular conditions.`probe.pattern` must be empty. +>> >> `default` the simplest test, without specific conditions. `probe.pattern` must be empty ; >> >> ->> >> `status`. Checks if the HTTP status code is in the list separated by commas. +>> >> `status` checks that the HTTP status code is in the comma-separated list ; >> >> ->> >> `contains`. Checks that the server response contains `probe.pattern`. +>> >> `contains` checks that the server response contains `probe.pattern` ; >> >> ->> >> `matches`. Checks that the server response matches `probe.pattern`. +>> >> `matches` checks that the server response matches `probe.pattern`. > -##### TCP +##### **TCP** -This probe attempts to establish a TCP connection to the server. If the server sends a “banner”, you can check if it matches a schema. The default test simply ensures that the connection can be established. +This probe attempts to establish a TCP connection with the server. If the latter sends a "banner", it is possible to check that it matches a pattern. The default test simply ensures that the connection can be established. |Fields|Description| |---|---| @@ -336,29 +363,29 @@ This probe attempts to establish a TCP connection to the server. If the server s |URL|Not supported| |matches|`default`, `contains` or `matches`| -##### HTTP +##### **HTTP** -This probe attempts to establish a HTTP connection to the server. If the server responds, you can check its HTTP status code, and that the response body matches a schema. The default test sends an OPTIONS request to the '/' page in HTTP/1.0, without a Host field. +This probe attempts to establish an HTTP connection with the server. If the latter responds, it is possible to check its HTTP status code or that the response body matches a pattern. The default test sends an OPTIONS request to the '/' page in HTTP/1.0, without the Host field. |Fields|Description| |---|---| |type|`http`| |port|Configurable| |method|`GET`, `HEAD` or `OPTIONS`| -|URL|URL in the form: \[\[https?://]www.example.com]/path/to/check| +|URL|URL of the form [[https?://]www.example.com]/path/to/check| |matches|`default`, `contains` or `matches`| -If the URL is specified, the domain name and protocol are operational. If a domain name is specified, the “Host” field of the request will be filled in, and the request will be sent to HTTP/1.1. If the protocol is specified, it must be consistent with the farm’s SSL configuration. +If a URL is specified, the domain name and protocol are operational. If a domain name is specified, the "Host" field of the request will be filled in and the request will be sent in HTTP/1.1. If the protocol is specified, it must be consistent with the SSL configuration of the farm. > [!primary] > -> We recommend configuring the method, at least, with GET. -> Some servers, including NGINX, do not manage the OPTIONS method without it being configured in advance. +> It is recommended to configure at least the method with GET. +> Indeed, some servers -including Nginx- do not handle the OPTIONS method without prior configuration. > -##### SMTP +##### **SMTP** -This probe attempts to establish an SMTP connection with the server, and sends the command "HELLO localhost". If the server responds, the probe checks that the response code starts with a ‘2’ (success). This probe does not have any specific configuration options. +This probe attempts to establish an SMTP connection with the server and sends the "HELLO localhost" command. If the latter responds, the probe checks that the return code starts with a "2" (success). This probe has no specific configuration options. |Fields|Description| |---|---| @@ -368,9 +395,9 @@ This probe attempts to establish an SMTP connection with the server, and sends t |URL|Not supported| |matches|`default`| -##### MySQL +##### **MySQL** -This probe attempts to establish a MySQL connection with the server, and analyses the server’s response. This probe does not have any specific configuration options. +This probe attempts to establish a MySQL connection with the server and analyses the server's response. This probe has no specific configuration options. |Fields|Description| |---|---| @@ -380,9 +407,9 @@ This probe attempts to establish a MySQL connection with the server, and analyse |URL|Not supported| |matches|`default`| -##### PostgreSQL +##### **PostgreSQL** -This probe attempts to establish a PostgreSQL connection with the server, and analyses the server’s response. This probe does not have any specific configuration options. +This probe attempts to establish a PostgreSQL connection with the server and analyses the server's response. This probe has no specific configuration options. |Fields|Description| |---|---| @@ -392,9 +419,9 @@ This probe attempts to establish a PostgreSQL connection with the server, and an |URL|Not supported| |matches|`default`| -##### oco +##### **oco** -This probe attempts to establish a TCP connection on port 79 of your server, and checks that the response starts with a ‘2’ (success). This probe does not have any specific configuration options. +This probe attempts to establish a TCP connection on port 79 of your server and checks that the response starts with a "2" (success). This probe has no specific configuration options. |Fields|Description| |---|---| @@ -404,20 +431,24 @@ This probe attempts to establish a TCP connection on port 79 of your server, and |URL|Not supported| |matches|`default`| -## Via the OVH Control Panel. +### From the OVHcloud Control Panel -You can configure probes when you add (or modify) a server farm, in advanced settings. +You can configure probes when you add or modify a server farm, in advanced settings. -![Advanced settings for a farm](images/farm_advanced_settings.png){.thumbnail} +![Advanced farm settings](images/farm_advanced_settings.png){.thumbnail} -This is how you access the probe type’s configuration. +You will then have access to the configuration for the probe type. ![Probe settings](images/farm_advanced_settings_unfolded.png){.thumbnail} -If you are able to do so with the probe type you have selected, you can configure specific advanced settings for the probe. +If the probe type you have selected allows it, you can configure advanced settings that are specific to that probe. -![Advanced settings for a probe](images/probe_settings.png){.thumbnail} +![Advanced probe settings](images/probe_settings.png){.thumbnail} A new configuration window will appear, with the probe’s settings. -![Advanced settings for a probe](images/probe_settings_dialog.png){.thumbnail} +![Advanced probe settings](images/probe_settings_dialog.png){.thumbnail} + +## Go further + +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_probes/guide.en-gb.md b/pages/network/load_balancer/create_probes/guide.en-gb.md index 52be1704be5..d774b695308 100644 --- a/pages/network/load_balancer/create_probes/guide.en-gb.md +++ b/pages/network/load_balancer/create_probes/guide.en-gb.md @@ -1,45 +1,69 @@ --- -title: 'Working with probes' -excerpt: 'Find out about the general principles behind probes, and why they are used' -updated: 2019-02-12 +title: "Configuration of probes on an OVHcloud Load Balancer service" +excerpt: "Discover the general principles and use cases for probes" +updated: 2025-11-12 --- -## Objective + -With the OVH Load Balancer, you can distribute a front-end’s incoming traffic across a set of servers in a destination farm. +## Objective -There may be instances where a server in your farm becomes unavailable for a number of reasons, including oversaturation, an incident, or scheduled maintenance. When the OVH Load Balancer detects a connection error, it will try to redirect traffic to another server. The connection will be slower, but it will continue to work. +The OVHcloud Load Balancer allows you to distribute incoming traffic on a frontend to a set of servers in a destination farm. -However, the reasons behind certain types of unavailability can be harder to pinpoint. For example, if a new version of code is being deployed, the application may momentarily experience a glitch, and return a 500 error. In this particular case, a solution would be to mark the servers concerned as unavailable in the API before you begin the maintenance work, apply the configuration and update, then mark the server as available again. This method is not ideal, but it works. For more information on deploying a blue-green architecture with an OVH Load Balancer, please read our guide: . +It may happen that one of the servers in your farm is no longer available for various reasons, such as overload, an incident, or scheduled maintenance. When it encounters a connection error, your OVHcloud Load Balancer attempts to switch traffic to another server. The connection will be slowed down, but it will continue to function. -The purpose of a probe is to test an infrastructure’s health. It periodically examines each of your servers, to ensure that they are working properly. If it detects an error, the server is automatically disabled until the situation is resolved. +However, the causes of some unavailability are more subtle. For example, if a new version of the code is being deployed, the application may temporarily be in a transitional state and return 500 errors. In this specific case, one solution would be to mark the affected servers as unavailable in the API before the start of the maintenance, apply the configuration and update, and then mark the server as available again. This method is not ideal, but it works.
+For more details on deploying a Blue-Green architecture with your OVHcloud Load Balancer, refer to [this guide](/pages/network/load_balancer/case_blue_green). -Since this service is still very new, its basic features are only available in the API. +Probes are health checks. They periodically query each of your servers to ensure they are operational. If an error is detected, the server is automatically disabled until the situation is resolved. -**This guide will explain the general principles behind probes, and provide practical examples of probes being used.** +**This guide will present the general principles, as well as usage scenarios for probes, drawn from real-world use cases.** ## Requirements -- a correctly configured OVH Load Balancer, with farms and servers set +- Have an [OVHcloud Load Balancer](/links/network/load-balancer) offer in your OVHcloud account. The service must be properly configured, with farms and servers set up. +- Be logged in to your [OVHcloud Control Panel](/links/manager). ## Instructions -### An introduction to the API. +**Table of contents** + +- [Probe API overview](#probe-api) +- [Examples](#examples) +- [Reference](#reference) +- [From the OVHcloud Control Panel](#manager) + +### Probe API overview -The API for probes in the OVH Load Balancer is designed to be flexible and scalable. +The probe API of your OVHcloud Load Balancer has been designed to be flexible and scalable. -The probes can be configured directly on the farms. All of the servers from a single farm will have exactly the same probe applied. However, probe activation and deactivation is specific for each server. As a result, it is possible to only monitor certain servers within a single farm. +Probes are configured directly on the farms. All servers in the same farm thus apply exactly the same probe. However, enabling or disabling a probe is specific to each server. It is therefore possible to "monitor" only certain servers in the same farm. -You can view the list of available probes and their settings with the following API call: +The list of available probes and their parameters can be consulted with the API call : > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmProbes > -For more information on this call, please read the *Available probes* section at the bottom of this guide. +For more information on this call, we invite you to consult the [Available probes](#available-probes) section at the bottom of this guide. -The probes in this list can be configured on `http` and `tcp` farms via the following calls: +The probes returned by this list can be configured on `http` and `tcp` farms via the following calls : > [!api] > @@ -61,56 +85,58 @@ The probes in this list can be configured on `http` and `tcp` farms via the foll > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId} > -For more information on these calls, please read the *Probe configuration* section at the bottom of this guide. +For more information on these calls, you can refer to the [Probe handling](#handling-probes) section of this guide. -### Examples +### Examples -#### Check if the server accepts TCP connections. +#### Check if the server accepts TCP connections -This is the simplest method to set up. It is compatible with `tcp` and `http` farms. If no other probes are configured, you can activate it to start. It works by periodically attempting to establish a connection on each of your servers. If the connection fails twice in a row, the server is put aside until it responds again. +This is the simplest probe to set up. It is compatible with `tcp` and `http` farms. If no other probe is configured, you can activate this one to start. It works by periodically trying to open a connection on each of your servers. If the connection fails twice in a row, the server is put aside until it responds again. -In practice, this gives a probe: +In practice, this gives a probe : |Field|Value and description| |---|---| -|serviceName|Your OVH Load Balancer ID| -|farmId|Your TCP or HTTP farm| +|serviceName|Identifier of your OVHcloud Load Balancer| +|farmId|Identifier of your TCP or HTTP farm| |probe.type|"tcp"| -All other probe fields can keep their default values. Just apply the configuration to the zone concerned, and the probe will begin to work. +All other `probe` fields can remain at their default values. You just need to apply the configuration in the relevant area. -#### Test a specific HTTP page. +#### Test a specific HTTP page -By default, the HTTP `probe` sends an "OPTIONS" request on "/" in HTTP/1.0, without a domain name. In many cases, this is sufficient, but some servers do not manage this method. You can carry out much more powerful tests with the HTTP probe. For example, a good practice when exposing a HTTP service is to add a router dedicated to probes. It is normal to see "/status", "/health", and "/check", which summarise the service’s status. +By default, the HTTP probe sends an `OPTIONS` request on `/` in HTTP/1.0, without a domain name. This is sufficient in many cases, but some servers do not handle this method.
+It is possible to perform much more powerful tests with the HTTP probe. For example, a good practice when exposing an HTTP service is to add a dedicated route for probes. It is common to find `/status`, `/health`, `/check` which return a summary of the service's status. -In practice, if you want to configure the probe to send a "GET" request on [http://api.example.com/status](http://api.example.com/status), it gives: +In practice, if you want to configure the probe to send a `GET` request to [http://api.example.com/status](http://api.example.com/status), this gives : |Field|Value and description| |---|---| -|serviceName|Your OVH Load Balancer ID| -|farmId|Your TCP or HTTP farm| +|serviceName|Identifier of your OVHcloud Load Balancer| +|farmId|Identifier of your TCP or HTTP farm| |probe.type|http| |probe.method|GET| |probe.url|[http://api.example.com/status](http://api.example.com/status)| |probe.match|status| -|probe.pattern|200 (multiple status codes can be added, provided they are separated by commas)| +|probe.pattern|200 (several status codes can be added, separated by commas)| -All other probe fields can keep their default values. Finally, apply the configuration to the zone concerned. +All other `probe` fields can remain at their default values. It is then sufficient to apply the configuration in the relevant area. -#### Use an external HTTP test. +#### Use an external HTTP test -What happens if, for example, your service is an IMAP server that relies on an LDAP server for authentication? The server may accept connections, but experience a temporary connection issue with the LDAP server. If this happens, the customers redirected to this server would be able to connect, but wouldn’t be able to authenticate. As a result, the server would need to be removed from the farm. +What if your service is, for example, an IMAP server that relies on an LDAP server for authentication ?
+It is possible that the server accepts connections, but has a temporary connection issue with the LDAP server. If this happens, clients who are directed to this server could connect but not authenticate. The server should therefore be removed from the farm. -If you are using a `tcp` probe, it will manage to connect. As a result, it will consider the service to be available, even though this is not the case. +If a `tcp` type probe is used, it will be able to connect and consider the service available even though it is not the case. -In this situation, the health test would ideally be able to confirm that the basic service works. You can provide a specific port to use in the tests. This way, you can set up arbitrary tests for a service, and expose them to HTTP on a dedicated port. +In this scenario, the ideal would be for the health check to confirm that the base service is working. It is possible to indicate a specific port to use in the tests. This allows arbitrary tests to be set up for a service and exposed in HTTP, on a dedicated port. -For example, in this situation, you can have a HTTP server on port 8080\. It will test the IMAP server via the URL "/service/imap/status", and will return ‘OK’ when everything is working properly. In practice, this will return: +For example, in this scenario, it would be possible to have an HTTP server on port 8080 that tests the IMAP server via the url `/service/imap/status` and returns *OK* when everything is fine. This would give in practice : |Field|Value and description| |---|---| -|serviceName|Your OVH Load Balancer ID| -|farmId|Your TCP or HTTP farm| +|serviceName|Identifier of your OVHcloud Load Balancer| +|farmId|Identifier of your TCP or HTTP farm| |probe.type|http| |probe.port|8080| |probe.method|GET| @@ -118,24 +144,24 @@ For example, in this situation, you can have a HTTP server on port 8080\. It wil |probe.match|contains| |probe.pattern|OK| -Just apply the configuration to the zone concerned, and the probe will begin to work. +It is then sufficient to apply the configuration in the relevant area. > [!warning] > -> If the HTTP service dedicated to monitoring your IMAP service experiences a fault, the IMAP service will also be considered faulty, even if it is working properly. +> If the HTTP service dedicated to monitoring your IMAP service itself fails, the IMAP service will also be considered as failed, even if it is in perfect working condition. > -### Reference +### Reference -#### Probe configuration. +#### Probe handling -##### Configure a probe. +##### **Configure a probe** -Probes can be configured on a new farm (`POST`) or an existing one (`PUT`). Since the two methods are equivalent, only the second (`PUT`) method is presented here. +Probes can be configured on a new farm (`POST`) or an existing farm (`PUT`). The two methods being equivalent, only the second one (`PUT`) will be presented here. > [!faq] > -> Service: +> Service : > >> > [!api] >> > @@ -143,85 +169,86 @@ Probes can be configured on a new farm (`POST`) or an existing one (`PUT`). Sinc >> > >> > -> Settings: +> Parameters : > >> > **serviceName** >> > ->> >> Your OVH Load Balancer ID. +>> >> The identifier of your OVHcloud Load Balancer. >> > >> > **farmId** >> > ->> >> Your `farm` ID number. +>> >> The numeric identifier of your `farm`. >> > >> > **probe** >> > >> >> **type** >> >> ->> >> > The type of `probe` to activate. The probe types managed are: +>> >> > The type of `probe` to enable. The probe types handled are : >> >> > ->> >> > `tcp` for a basic TCP connection test. +>> >> > `tcp` for a basic TCP connection test ; >> >> > ->> >> > `http` for a HTTP connection test. You can specify the URL and the method. +>> >> > `http` for an HTTP connection test. It is possible to specify the URL and method ; >> >> > ->> >> > `smtp` for a basic SMTP connection test. +>> >> > `smtp` for a basic SMTP connection test ; >> >> > ->> >> > `mysql` for a basic MySQL connection test. +>> >> > `mysql` for a basic MySQL connection test ; >> >> > ->> >> > `pgsql` for a basic PostgreSQL connection test. +>> >> > `pgslq` for a basic PostgreSQL connection test ; >> >> > ->> >> > `oco` for a confirmation of the general status returned on port 79. +>> >> > `oco` for a general status validation returned on port 79. >> > >> >> **interval** >> >> ->> >> > The interval (in seconds) between a probe’s two connection attempts. It must be at least 30 seconds. +>> >> > The interval in seconds between two probe attempts. It must be at least 30 seconds. >> > >> >> **port** >> >> ->> >> > The port that the probe must use, if it is different to the port configured on the farm. ->> >> > This enables you to delegate a server’s status validation to a separate service on the machine, and carry out arbitrary probes. +>> >> > The port that the probe should use, if it is different from the one configured on the farm. +>> >> > This allows you to delegate the server status validation to a third-party service on the machine and perform arbitrary probes. >> > >> >> **method** >> >> ->> >> > The HTTP method to use if the probe is a “http” probe. ->> >> > Compatible methods are `GET`, `HEAD` and `OPTIONS` (by default). +>> >> > The HTTP method to use if the probe is of type "http". +>> >> > The compatible methods are `GET`, `HEAD` and `OPTIONS` (default). >> > >> >> **url** >> >> ->> >> > The URL to use for tests, if it is a “http” probe type. ->> >> > It should be formulated as follows: `[[https?://]www.example.com]/path/to/check`. ->> >> > If a domain is specified, its request will be sent to HTTP/1.1 rather than HTTP/1.0 by default. +>> >> > The URL to use for the tests, if the probe is of type "http". +>> >> > Its form must be `[[https?://]www.example.com]/path/to/check`. +>> >> > If a domain is specified, the request will be sent in HTTP/1.1 instead of HTTP/1.0 by default. >> > >> >> **match** >> >> ->> >> > The type of comparison to use to check if the server is in good health. ->> >> > The managed comparison types are `default`, `status`, `contains` and `matches`. ->> >> > Comparison types are compatible with both “http” and “tcp” probes. +>> >> > The type of comparator to use to check that the server is healthy. +>> >> > The comparators handled are `default`, `status`, `contains` and `matches`. +>> >> > The comparators are compatible with "http" and "tcp" probes. >> > >> >> **pattern** >> >> ->> >> > The value to use as an argument of the comparison type if it is different from “default”. +>> >> > The value to use as an argument for the comparator if it is different from "default". >> > >> >> **forceSsl** >> >> ->> >> > This defines whether the probe must work in SSL/TLS, even if the farm is configured to connect via standard TCP. ->> >> > This can be useful when, for example, your OVH Load Balancer is configured to monitor HTTPS traffic in TCP without decrypting it. +>> >> > Defines whether the probe should work in SSL/TLS even if the farm is configured to connect in classic TCP. +>> >> > This can be useful, for example, when your OVHcloud Load Balancer is configured to forward HTTPS traffic in TCP without decrypting it. > -Other settings can be edited via this call. Since this guide focuses on probes, they are not documented here. +Other parameters can be edited via this call. As this guide focuses on probes, they are not documented here. -If a port other than the farm’s base port is configured on the probe, the `proxyprotocol` and `ssl` settings are reset. As an example, we will take a configured farm to use `proxyprotocol` on **port 4242**, and an associated probe using **port 8080**. The probe will not send the `proxyprotocol` header when it connects on **port 8080**. The same goes for `ssl`, but it can be forced. +If a port other than the base port of the farm is configured on the probe, the `proxyprotocol` and `ssl` parameters are reset. Take the example of a farm configured to use `proxyprotocol` on port **4242** and a probe associated with port **8080**: the latter will not send the `proxyprotocol` header when connecting to port **8080**. The same applies to `ssl`, which can nevertheless be forced. > [!warning] > -> When a probe is configured on a farm, it must be activated on the servers. +> When a probe is configured on a farm, it must also be enabled on the servers. > -##### Activate probes on a server. -For a probe to be active, it must be configured on the farm and activated on the servers concerned. With this call, you can activate the probe being taken into account: +##### **Enable probes on a server** + +For a probe to be active, it must have been configured on the farm and enabled on the relevant servers. This call allows you to enable the probe : > [!faq] > -> Service: +> Service : > >> > [!api] >> > @@ -229,47 +256,47 @@ For a probe to be active, it must be configured on the farm and activated on the >> > >> > -> Settings: +> Parameters : > >> > **serviceName** >> > ->> >> Your OVH Load Balancer ID. +>> >> The identifier of your OVHcloud Load Balancer. >> > >> > **farmId** >> > ->> >> Your `farm` ID number. +>> >> The numeric identifier of your `farm`. >> > >> > **serverId** >> > ->> >> Your `server’s` ID number. +>> >> The numeric identifier of your `server`. >> > >> > **probe** >> > ->> >> Whether or not the `probes` must be taken into account. +>> >> Indicates whether `probe` should be taken into account or not. > -Other settings can be edited via this call. Since this guide focuses on probes, they are not documented here. +Other parameters can be edited via this call. As this guide focuses on probes, they are not documented here. -#### Available comparison types. +#### Available comparators -Four comparison types are available to confirm a probe’s results: +Four comparators are available to validate the result of a probe : -|Comparison type|Description| +|Comparator|Description| |---|---| -|default|Launches a basic test, without any settings.| -|status|A list of valid HTTP response codes, separated by commas.| -|contains|Checks that the pattern can be found in the response.| -|matches|Checks that the response corresponds to a regular expression pattern.| +|default|Runs a basic test, without parameters.| +|status|Comma-separated list of valid HTTP return codes.| +|contains|Checks that the pattern is in the response.| +|matches|Checks that the response matches the pattern regular expression.| -‘Contains’ and ‘matches’ comparison types find a correspondence in the first 16 KB of the response. If the response is longer than 16 KB, whatever comes afterwards will be ignored during the test. Please note that to optimise your performance, we recommend returning as little information as possible in your probes. +The `contains` and `matches` comparators look for a match in the first 16 KB of the response. If it is longer, the part beyond will be ignored during the search. Note that for better performance, we recommend returning as little information as possible in your probes. -#### Available probes. +#### Available probes -You can get a list of the available probes using the following API call: +The list of available probes can be obtained with the API call : > [!faq] > -> Service: +> Service : > >> > [!api] >> > @@ -277,56 +304,56 @@ You can get a list of the available probes using the following API call: >> > >> > -> Response: +> Response : > >> > **type** >> > ->> >> The type of `probe` to configure in the `probe.type` of `farms`. +>> >> The type of `probe` to configure in the `probe.type` field of the `farms`. >> >> ->> >> The probe types managed are: +>> >> The probe types handled are : >> >> ->> >> `tcp` for a basic TCP connection test. +>> >> `tcp` for a basic TCP connection test ; >> >> ->> >> `http` for a HTTP connection test. You can specify the URL and the method. +>> >> `http` for an HTTP connection test. It is possible to specify the URL and method ; >> >> ->> >> `smtp` for a basic SMTP connection test. +>> >> `smtp` for a basic SMTP connection test ; >> >> ->> >> `mysql` for a basic MySQL connection test. +>> >> `mysql` for a basic MySQL connection test ; >> >> ->> >> `pgsql` for a basic PostgreSQL connection test. +>> >> `pgslq` for a basic PostgreSQL connection test ; >> >> ->> >> `oco` for a confirmation of the general status returned on port 79. +>> >> `oco` for a general status validation returned on port 79. >> > >> > **port** >> > ->> >> This defines whether the port can be configured for this probe. +>> >> Indicates whether the port can be configured for this probe. >> > >> > **method** >> > ->> >> The list of HTTP methods managed, or `null` if none are managed. +>> >> The list of HTTP methods handled or `null` if none exist. >> > >> > **url** >> > ->> >> This defines if the probe’s URL can be configured. +>> >> Indicates whether the probe URL can be configured. >> > >> > **matches** >> > ->> >> The list of comparison types available for this probe. +>> >> The list of available comparators for this probe. >> >> The interpretation of the `probe.pattern` field depends on this field. ->> >> The comparison types potentially managed are: +>> >> The potentially handled comparators are : >> >> ->> >> `default`. The most simple test, without any particular conditions.`probe.pattern` must be empty. +>> >> `default` the simplest test, without specific conditions. `probe.pattern` must be empty ; >> >> ->> >> `status`. Checks if the HTTP status code is in the list separated by commas. +>> >> `status` checks that the HTTP status code is in the comma-separated list ; >> >> ->> >> `contains`. Checks that the server response contains `probe.pattern`. +>> >> `contains` checks that the server response contains `probe.pattern` ; >> >> ->> >> `matches`. Checks that the server response matches `probe.pattern`. +>> >> `matches` checks that the server response matches `probe.pattern`. > -##### TCP +##### **TCP** -This probe attempts to establish a TCP connection to the server. If the server sends a “banner”, you can check if it matches a schema. The default test simply ensures that the connection can be established. +This probe attempts to establish a TCP connection with the server. If the latter sends a "banner", it is possible to check that it matches a pattern. The default test simply ensures that the connection can be established. |Fields|Description| |---|---| @@ -336,29 +363,29 @@ This probe attempts to establish a TCP connection to the server. If the server s |URL|Not supported| |matches|`default`, `contains` or `matches`| -##### HTTP +##### **HTTP** -This probe attempts to establish a HTTP connection to the server. If the server responds, you can check its HTTP status code, and that the response body matches a schema. The default test sends an OPTIONS request to the '/' page in HTTP/1.0, without a Host field. +This probe attempts to establish an HTTP connection with the server. If the latter responds, it is possible to check its HTTP status code or that the response body matches a pattern. The default test sends an OPTIONS request to the '/' page in HTTP/1.0, without the Host field. |Fields|Description| |---|---| |type|`http`| |port|Configurable| |method|`GET`, `HEAD` or `OPTIONS`| -|URL|URL in the form: \[\[https?://]www.example.com]/path/to/check| +|URL|URL of the form [[https?://]www.example.com]/path/to/check| |matches|`default`, `contains` or `matches`| -If the URL is specified, the domain name and protocol are operational. If a domain name is specified, the “Host” field of the request will be filled in, and the request will be sent to HTTP/1.1. If the protocol is specified, it must be consistent with the farm’s SSL configuration. +If a URL is specified, the domain name and protocol are operational. If a domain name is specified, the "Host" field of the request will be filled in and the request will be sent in HTTP/1.1. If the protocol is specified, it must be consistent with the SSL configuration of the farm. > [!primary] > -> We recommend configuring the method, at least, with GET. -> Some servers, including NGINX, do not manage the OPTIONS method without it being configured in advance. +> It is recommended to configure at least the method with GET. +> Indeed, some servers -including Nginx- do not handle the OPTIONS method without prior configuration. > -##### SMTP +##### **SMTP** -This probe attempts to establish an SMTP connection with the server, and sends the command "HELLO localhost". If the server responds, the probe checks that the response code starts with a ‘2’ (success). This probe does not have any specific configuration options. +This probe attempts to establish an SMTP connection with the server and sends the "HELLO localhost" command. If the latter responds, the probe checks that the return code starts with a "2" (success). This probe has no specific configuration options. |Fields|Description| |---|---| @@ -368,9 +395,9 @@ This probe attempts to establish an SMTP connection with the server, and sends t |URL|Not supported| |matches|`default`| -##### MySQL +##### **MySQL** -This probe attempts to establish a MySQL connection with the server, and analyses the server’s response. This probe does not have any specific configuration options. +This probe attempts to establish a MySQL connection with the server and analyses the server's response. This probe has no specific configuration options. |Fields|Description| |---|---| @@ -380,9 +407,9 @@ This probe attempts to establish a MySQL connection with the server, and analyse |URL|Not supported| |matches|`default`| -##### PostgreSQL +##### **PostgreSQL** -This probe attempts to establish a PostgreSQL connection with the server, and analyses the server’s response. This probe does not have any specific configuration options. +This probe attempts to establish a PostgreSQL connection with the server and analyses the server's response. This probe has no specific configuration options. |Fields|Description| |---|---| @@ -392,9 +419,9 @@ This probe attempts to establish a PostgreSQL connection with the server, and an |URL|Not supported| |matches|`default`| -##### oco +##### **oco** -This probe attempts to establish a TCP connection on port 79 of your server, and checks that the response starts with a ‘2’ (success). This probe does not have any specific configuration options. +This probe attempts to establish a TCP connection on port 79 of your server and checks that the response starts with a "2" (success). This probe has no specific configuration options. |Fields|Description| |---|---| @@ -404,20 +431,24 @@ This probe attempts to establish a TCP connection on port 79 of your server, and |URL|Not supported| |matches|`default`| -## Via the OVH Control Panel. +### From the OVHcloud Control Panel -You can configure probes when you add (or modify) a server farm, in advanced settings. +You can configure probes when you add or modify a server farm, in advanced settings. -![Advanced settings for a farm](images/farm_advanced_settings.png){.thumbnail} +![Advanced farm settings](images/farm_advanced_settings.png){.thumbnail} -This is how you access the probe type’s configuration. +You will then have access to the configuration for the probe type. ![Probe settings](images/farm_advanced_settings_unfolded.png){.thumbnail} -If you are able to do so with the probe type you have selected, you can configure specific advanced settings for the probe. +If the probe type you have selected allows it, you can configure advanced settings that are specific to that probe. -![Advanced settings for a probe](images/probe_settings.png){.thumbnail} +![Advanced probe settings](images/probe_settings.png){.thumbnail} A new configuration window will appear, with the probe’s settings. -![Advanced settings for a probe](images/probe_settings_dialog.png){.thumbnail} +![Advanced probe settings](images/probe_settings_dialog.png){.thumbnail} + +## Go further + +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_probes/guide.en-sg.md b/pages/network/load_balancer/create_probes/guide.en-sg.md index 52be1704be5..d774b695308 100644 --- a/pages/network/load_balancer/create_probes/guide.en-sg.md +++ b/pages/network/load_balancer/create_probes/guide.en-sg.md @@ -1,45 +1,69 @@ --- -title: 'Working with probes' -excerpt: 'Find out about the general principles behind probes, and why they are used' -updated: 2019-02-12 +title: "Configuration of probes on an OVHcloud Load Balancer service" +excerpt: "Discover the general principles and use cases for probes" +updated: 2025-11-12 --- -## Objective + -With the OVH Load Balancer, you can distribute a front-end’s incoming traffic across a set of servers in a destination farm. +## Objective -There may be instances where a server in your farm becomes unavailable for a number of reasons, including oversaturation, an incident, or scheduled maintenance. When the OVH Load Balancer detects a connection error, it will try to redirect traffic to another server. The connection will be slower, but it will continue to work. +The OVHcloud Load Balancer allows you to distribute incoming traffic on a frontend to a set of servers in a destination farm. -However, the reasons behind certain types of unavailability can be harder to pinpoint. For example, if a new version of code is being deployed, the application may momentarily experience a glitch, and return a 500 error. In this particular case, a solution would be to mark the servers concerned as unavailable in the API before you begin the maintenance work, apply the configuration and update, then mark the server as available again. This method is not ideal, but it works. For more information on deploying a blue-green architecture with an OVH Load Balancer, please read our guide: . +It may happen that one of the servers in your farm is no longer available for various reasons, such as overload, an incident, or scheduled maintenance. When it encounters a connection error, your OVHcloud Load Balancer attempts to switch traffic to another server. The connection will be slowed down, but it will continue to function. -The purpose of a probe is to test an infrastructure’s health. It periodically examines each of your servers, to ensure that they are working properly. If it detects an error, the server is automatically disabled until the situation is resolved. +However, the causes of some unavailability are more subtle. For example, if a new version of the code is being deployed, the application may temporarily be in a transitional state and return 500 errors. In this specific case, one solution would be to mark the affected servers as unavailable in the API before the start of the maintenance, apply the configuration and update, and then mark the server as available again. This method is not ideal, but it works.
+For more details on deploying a Blue-Green architecture with your OVHcloud Load Balancer, refer to [this guide](/pages/network/load_balancer/case_blue_green). -Since this service is still very new, its basic features are only available in the API. +Probes are health checks. They periodically query each of your servers to ensure they are operational. If an error is detected, the server is automatically disabled until the situation is resolved. -**This guide will explain the general principles behind probes, and provide practical examples of probes being used.** +**This guide will present the general principles, as well as usage scenarios for probes, drawn from real-world use cases.** ## Requirements -- a correctly configured OVH Load Balancer, with farms and servers set +- Have an [OVHcloud Load Balancer](/links/network/load-balancer) offer in your OVHcloud account. The service must be properly configured, with farms and servers set up. +- Be logged in to your [OVHcloud Control Panel](/links/manager). ## Instructions -### An introduction to the API. +**Table of contents** + +- [Probe API overview](#probe-api) +- [Examples](#examples) +- [Reference](#reference) +- [From the OVHcloud Control Panel](#manager) + +### Probe API overview -The API for probes in the OVH Load Balancer is designed to be flexible and scalable. +The probe API of your OVHcloud Load Balancer has been designed to be flexible and scalable. -The probes can be configured directly on the farms. All of the servers from a single farm will have exactly the same probe applied. However, probe activation and deactivation is specific for each server. As a result, it is possible to only monitor certain servers within a single farm. +Probes are configured directly on the farms. All servers in the same farm thus apply exactly the same probe. However, enabling or disabling a probe is specific to each server. It is therefore possible to "monitor" only certain servers in the same farm. -You can view the list of available probes and their settings with the following API call: +The list of available probes and their parameters can be consulted with the API call : > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmProbes > -For more information on this call, please read the *Available probes* section at the bottom of this guide. +For more information on this call, we invite you to consult the [Available probes](#available-probes) section at the bottom of this guide. -The probes in this list can be configured on `http` and `tcp` farms via the following calls: +The probes returned by this list can be configured on `http` and `tcp` farms via the following calls : > [!api] > @@ -61,56 +85,58 @@ The probes in this list can be configured on `http` and `tcp` farms via the foll > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId} > -For more information on these calls, please read the *Probe configuration* section at the bottom of this guide. +For more information on these calls, you can refer to the [Probe handling](#handling-probes) section of this guide. -### Examples +### Examples -#### Check if the server accepts TCP connections. +#### Check if the server accepts TCP connections -This is the simplest method to set up. It is compatible with `tcp` and `http` farms. If no other probes are configured, you can activate it to start. It works by periodically attempting to establish a connection on each of your servers. If the connection fails twice in a row, the server is put aside until it responds again. +This is the simplest probe to set up. It is compatible with `tcp` and `http` farms. If no other probe is configured, you can activate this one to start. It works by periodically trying to open a connection on each of your servers. If the connection fails twice in a row, the server is put aside until it responds again. -In practice, this gives a probe: +In practice, this gives a probe : |Field|Value and description| |---|---| -|serviceName|Your OVH Load Balancer ID| -|farmId|Your TCP or HTTP farm| +|serviceName|Identifier of your OVHcloud Load Balancer| +|farmId|Identifier of your TCP or HTTP farm| |probe.type|"tcp"| -All other probe fields can keep their default values. Just apply the configuration to the zone concerned, and the probe will begin to work. +All other `probe` fields can remain at their default values. You just need to apply the configuration in the relevant area. -#### Test a specific HTTP page. +#### Test a specific HTTP page -By default, the HTTP `probe` sends an "OPTIONS" request on "/" in HTTP/1.0, without a domain name. In many cases, this is sufficient, but some servers do not manage this method. You can carry out much more powerful tests with the HTTP probe. For example, a good practice when exposing a HTTP service is to add a router dedicated to probes. It is normal to see "/status", "/health", and "/check", which summarise the service’s status. +By default, the HTTP probe sends an `OPTIONS` request on `/` in HTTP/1.0, without a domain name. This is sufficient in many cases, but some servers do not handle this method.
+It is possible to perform much more powerful tests with the HTTP probe. For example, a good practice when exposing an HTTP service is to add a dedicated route for probes. It is common to find `/status`, `/health`, `/check` which return a summary of the service's status. -In practice, if you want to configure the probe to send a "GET" request on [http://api.example.com/status](http://api.example.com/status), it gives: +In practice, if you want to configure the probe to send a `GET` request to [http://api.example.com/status](http://api.example.com/status), this gives : |Field|Value and description| |---|---| -|serviceName|Your OVH Load Balancer ID| -|farmId|Your TCP or HTTP farm| +|serviceName|Identifier of your OVHcloud Load Balancer| +|farmId|Identifier of your TCP or HTTP farm| |probe.type|http| |probe.method|GET| |probe.url|[http://api.example.com/status](http://api.example.com/status)| |probe.match|status| -|probe.pattern|200 (multiple status codes can be added, provided they are separated by commas)| +|probe.pattern|200 (several status codes can be added, separated by commas)| -All other probe fields can keep their default values. Finally, apply the configuration to the zone concerned. +All other `probe` fields can remain at their default values. It is then sufficient to apply the configuration in the relevant area. -#### Use an external HTTP test. +#### Use an external HTTP test -What happens if, for example, your service is an IMAP server that relies on an LDAP server for authentication? The server may accept connections, but experience a temporary connection issue with the LDAP server. If this happens, the customers redirected to this server would be able to connect, but wouldn’t be able to authenticate. As a result, the server would need to be removed from the farm. +What if your service is, for example, an IMAP server that relies on an LDAP server for authentication ?
+It is possible that the server accepts connections, but has a temporary connection issue with the LDAP server. If this happens, clients who are directed to this server could connect but not authenticate. The server should therefore be removed from the farm. -If you are using a `tcp` probe, it will manage to connect. As a result, it will consider the service to be available, even though this is not the case. +If a `tcp` type probe is used, it will be able to connect and consider the service available even though it is not the case. -In this situation, the health test would ideally be able to confirm that the basic service works. You can provide a specific port to use in the tests. This way, you can set up arbitrary tests for a service, and expose them to HTTP on a dedicated port. +In this scenario, the ideal would be for the health check to confirm that the base service is working. It is possible to indicate a specific port to use in the tests. This allows arbitrary tests to be set up for a service and exposed in HTTP, on a dedicated port. -For example, in this situation, you can have a HTTP server on port 8080\. It will test the IMAP server via the URL "/service/imap/status", and will return ‘OK’ when everything is working properly. In practice, this will return: +For example, in this scenario, it would be possible to have an HTTP server on port 8080 that tests the IMAP server via the url `/service/imap/status` and returns *OK* when everything is fine. This would give in practice : |Field|Value and description| |---|---| -|serviceName|Your OVH Load Balancer ID| -|farmId|Your TCP or HTTP farm| +|serviceName|Identifier of your OVHcloud Load Balancer| +|farmId|Identifier of your TCP or HTTP farm| |probe.type|http| |probe.port|8080| |probe.method|GET| @@ -118,24 +144,24 @@ For example, in this situation, you can have a HTTP server on port 8080\. It wil |probe.match|contains| |probe.pattern|OK| -Just apply the configuration to the zone concerned, and the probe will begin to work. +It is then sufficient to apply the configuration in the relevant area. > [!warning] > -> If the HTTP service dedicated to monitoring your IMAP service experiences a fault, the IMAP service will also be considered faulty, even if it is working properly. +> If the HTTP service dedicated to monitoring your IMAP service itself fails, the IMAP service will also be considered as failed, even if it is in perfect working condition. > -### Reference +### Reference -#### Probe configuration. +#### Probe handling -##### Configure a probe. +##### **Configure a probe** -Probes can be configured on a new farm (`POST`) or an existing one (`PUT`). Since the two methods are equivalent, only the second (`PUT`) method is presented here. +Probes can be configured on a new farm (`POST`) or an existing farm (`PUT`). The two methods being equivalent, only the second one (`PUT`) will be presented here. > [!faq] > -> Service: +> Service : > >> > [!api] >> > @@ -143,85 +169,86 @@ Probes can be configured on a new farm (`POST`) or an existing one (`PUT`). Sinc >> > >> > -> Settings: +> Parameters : > >> > **serviceName** >> > ->> >> Your OVH Load Balancer ID. +>> >> The identifier of your OVHcloud Load Balancer. >> > >> > **farmId** >> > ->> >> Your `farm` ID number. +>> >> The numeric identifier of your `farm`. >> > >> > **probe** >> > >> >> **type** >> >> ->> >> > The type of `probe` to activate. The probe types managed are: +>> >> > The type of `probe` to enable. The probe types handled are : >> >> > ->> >> > `tcp` for a basic TCP connection test. +>> >> > `tcp` for a basic TCP connection test ; >> >> > ->> >> > `http` for a HTTP connection test. You can specify the URL and the method. +>> >> > `http` for an HTTP connection test. It is possible to specify the URL and method ; >> >> > ->> >> > `smtp` for a basic SMTP connection test. +>> >> > `smtp` for a basic SMTP connection test ; >> >> > ->> >> > `mysql` for a basic MySQL connection test. +>> >> > `mysql` for a basic MySQL connection test ; >> >> > ->> >> > `pgsql` for a basic PostgreSQL connection test. +>> >> > `pgslq` for a basic PostgreSQL connection test ; >> >> > ->> >> > `oco` for a confirmation of the general status returned on port 79. +>> >> > `oco` for a general status validation returned on port 79. >> > >> >> **interval** >> >> ->> >> > The interval (in seconds) between a probe’s two connection attempts. It must be at least 30 seconds. +>> >> > The interval in seconds between two probe attempts. It must be at least 30 seconds. >> > >> >> **port** >> >> ->> >> > The port that the probe must use, if it is different to the port configured on the farm. ->> >> > This enables you to delegate a server’s status validation to a separate service on the machine, and carry out arbitrary probes. +>> >> > The port that the probe should use, if it is different from the one configured on the farm. +>> >> > This allows you to delegate the server status validation to a third-party service on the machine and perform arbitrary probes. >> > >> >> **method** >> >> ->> >> > The HTTP method to use if the probe is a “http” probe. ->> >> > Compatible methods are `GET`, `HEAD` and `OPTIONS` (by default). +>> >> > The HTTP method to use if the probe is of type "http". +>> >> > The compatible methods are `GET`, `HEAD` and `OPTIONS` (default). >> > >> >> **url** >> >> ->> >> > The URL to use for tests, if it is a “http” probe type. ->> >> > It should be formulated as follows: `[[https?://]www.example.com]/path/to/check`. ->> >> > If a domain is specified, its request will be sent to HTTP/1.1 rather than HTTP/1.0 by default. +>> >> > The URL to use for the tests, if the probe is of type "http". +>> >> > Its form must be `[[https?://]www.example.com]/path/to/check`. +>> >> > If a domain is specified, the request will be sent in HTTP/1.1 instead of HTTP/1.0 by default. >> > >> >> **match** >> >> ->> >> > The type of comparison to use to check if the server is in good health. ->> >> > The managed comparison types are `default`, `status`, `contains` and `matches`. ->> >> > Comparison types are compatible with both “http” and “tcp” probes. +>> >> > The type of comparator to use to check that the server is healthy. +>> >> > The comparators handled are `default`, `status`, `contains` and `matches`. +>> >> > The comparators are compatible with "http" and "tcp" probes. >> > >> >> **pattern** >> >> ->> >> > The value to use as an argument of the comparison type if it is different from “default”. +>> >> > The value to use as an argument for the comparator if it is different from "default". >> > >> >> **forceSsl** >> >> ->> >> > This defines whether the probe must work in SSL/TLS, even if the farm is configured to connect via standard TCP. ->> >> > This can be useful when, for example, your OVH Load Balancer is configured to monitor HTTPS traffic in TCP without decrypting it. +>> >> > Defines whether the probe should work in SSL/TLS even if the farm is configured to connect in classic TCP. +>> >> > This can be useful, for example, when your OVHcloud Load Balancer is configured to forward HTTPS traffic in TCP without decrypting it. > -Other settings can be edited via this call. Since this guide focuses on probes, they are not documented here. +Other parameters can be edited via this call. As this guide focuses on probes, they are not documented here. -If a port other than the farm’s base port is configured on the probe, the `proxyprotocol` and `ssl` settings are reset. As an example, we will take a configured farm to use `proxyprotocol` on **port 4242**, and an associated probe using **port 8080**. The probe will not send the `proxyprotocol` header when it connects on **port 8080**. The same goes for `ssl`, but it can be forced. +If a port other than the base port of the farm is configured on the probe, the `proxyprotocol` and `ssl` parameters are reset. Take the example of a farm configured to use `proxyprotocol` on port **4242** and a probe associated with port **8080**: the latter will not send the `proxyprotocol` header when connecting to port **8080**. The same applies to `ssl`, which can nevertheless be forced. > [!warning] > -> When a probe is configured on a farm, it must be activated on the servers. +> When a probe is configured on a farm, it must also be enabled on the servers. > -##### Activate probes on a server. -For a probe to be active, it must be configured on the farm and activated on the servers concerned. With this call, you can activate the probe being taken into account: +##### **Enable probes on a server** + +For a probe to be active, it must have been configured on the farm and enabled on the relevant servers. This call allows you to enable the probe : > [!faq] > -> Service: +> Service : > >> > [!api] >> > @@ -229,47 +256,47 @@ For a probe to be active, it must be configured on the farm and activated on the >> > >> > -> Settings: +> Parameters : > >> > **serviceName** >> > ->> >> Your OVH Load Balancer ID. +>> >> The identifier of your OVHcloud Load Balancer. >> > >> > **farmId** >> > ->> >> Your `farm` ID number. +>> >> The numeric identifier of your `farm`. >> > >> > **serverId** >> > ->> >> Your `server’s` ID number. +>> >> The numeric identifier of your `server`. >> > >> > **probe** >> > ->> >> Whether or not the `probes` must be taken into account. +>> >> Indicates whether `probe` should be taken into account or not. > -Other settings can be edited via this call. Since this guide focuses on probes, they are not documented here. +Other parameters can be edited via this call. As this guide focuses on probes, they are not documented here. -#### Available comparison types. +#### Available comparators -Four comparison types are available to confirm a probe’s results: +Four comparators are available to validate the result of a probe : -|Comparison type|Description| +|Comparator|Description| |---|---| -|default|Launches a basic test, without any settings.| -|status|A list of valid HTTP response codes, separated by commas.| -|contains|Checks that the pattern can be found in the response.| -|matches|Checks that the response corresponds to a regular expression pattern.| +|default|Runs a basic test, without parameters.| +|status|Comma-separated list of valid HTTP return codes.| +|contains|Checks that the pattern is in the response.| +|matches|Checks that the response matches the pattern regular expression.| -‘Contains’ and ‘matches’ comparison types find a correspondence in the first 16 KB of the response. If the response is longer than 16 KB, whatever comes afterwards will be ignored during the test. Please note that to optimise your performance, we recommend returning as little information as possible in your probes. +The `contains` and `matches` comparators look for a match in the first 16 KB of the response. If it is longer, the part beyond will be ignored during the search. Note that for better performance, we recommend returning as little information as possible in your probes. -#### Available probes. +#### Available probes -You can get a list of the available probes using the following API call: +The list of available probes can be obtained with the API call : > [!faq] > -> Service: +> Service : > >> > [!api] >> > @@ -277,56 +304,56 @@ You can get a list of the available probes using the following API call: >> > >> > -> Response: +> Response : > >> > **type** >> > ->> >> The type of `probe` to configure in the `probe.type` of `farms`. +>> >> The type of `probe` to configure in the `probe.type` field of the `farms`. >> >> ->> >> The probe types managed are: +>> >> The probe types handled are : >> >> ->> >> `tcp` for a basic TCP connection test. +>> >> `tcp` for a basic TCP connection test ; >> >> ->> >> `http` for a HTTP connection test. You can specify the URL and the method. +>> >> `http` for an HTTP connection test. It is possible to specify the URL and method ; >> >> ->> >> `smtp` for a basic SMTP connection test. +>> >> `smtp` for a basic SMTP connection test ; >> >> ->> >> `mysql` for a basic MySQL connection test. +>> >> `mysql` for a basic MySQL connection test ; >> >> ->> >> `pgsql` for a basic PostgreSQL connection test. +>> >> `pgslq` for a basic PostgreSQL connection test ; >> >> ->> >> `oco` for a confirmation of the general status returned on port 79. +>> >> `oco` for a general status validation returned on port 79. >> > >> > **port** >> > ->> >> This defines whether the port can be configured for this probe. +>> >> Indicates whether the port can be configured for this probe. >> > >> > **method** >> > ->> >> The list of HTTP methods managed, or `null` if none are managed. +>> >> The list of HTTP methods handled or `null` if none exist. >> > >> > **url** >> > ->> >> This defines if the probe’s URL can be configured. +>> >> Indicates whether the probe URL can be configured. >> > >> > **matches** >> > ->> >> The list of comparison types available for this probe. +>> >> The list of available comparators for this probe. >> >> The interpretation of the `probe.pattern` field depends on this field. ->> >> The comparison types potentially managed are: +>> >> The potentially handled comparators are : >> >> ->> >> `default`. The most simple test, without any particular conditions.`probe.pattern` must be empty. +>> >> `default` the simplest test, without specific conditions. `probe.pattern` must be empty ; >> >> ->> >> `status`. Checks if the HTTP status code is in the list separated by commas. +>> >> `status` checks that the HTTP status code is in the comma-separated list ; >> >> ->> >> `contains`. Checks that the server response contains `probe.pattern`. +>> >> `contains` checks that the server response contains `probe.pattern` ; >> >> ->> >> `matches`. Checks that the server response matches `probe.pattern`. +>> >> `matches` checks that the server response matches `probe.pattern`. > -##### TCP +##### **TCP** -This probe attempts to establish a TCP connection to the server. If the server sends a “banner”, you can check if it matches a schema. The default test simply ensures that the connection can be established. +This probe attempts to establish a TCP connection with the server. If the latter sends a "banner", it is possible to check that it matches a pattern. The default test simply ensures that the connection can be established. |Fields|Description| |---|---| @@ -336,29 +363,29 @@ This probe attempts to establish a TCP connection to the server. If the server s |URL|Not supported| |matches|`default`, `contains` or `matches`| -##### HTTP +##### **HTTP** -This probe attempts to establish a HTTP connection to the server. If the server responds, you can check its HTTP status code, and that the response body matches a schema. The default test sends an OPTIONS request to the '/' page in HTTP/1.0, without a Host field. +This probe attempts to establish an HTTP connection with the server. If the latter responds, it is possible to check its HTTP status code or that the response body matches a pattern. The default test sends an OPTIONS request to the '/' page in HTTP/1.0, without the Host field. |Fields|Description| |---|---| |type|`http`| |port|Configurable| |method|`GET`, `HEAD` or `OPTIONS`| -|URL|URL in the form: \[\[https?://]www.example.com]/path/to/check| +|URL|URL of the form [[https?://]www.example.com]/path/to/check| |matches|`default`, `contains` or `matches`| -If the URL is specified, the domain name and protocol are operational. If a domain name is specified, the “Host” field of the request will be filled in, and the request will be sent to HTTP/1.1. If the protocol is specified, it must be consistent with the farm’s SSL configuration. +If a URL is specified, the domain name and protocol are operational. If a domain name is specified, the "Host" field of the request will be filled in and the request will be sent in HTTP/1.1. If the protocol is specified, it must be consistent with the SSL configuration of the farm. > [!primary] > -> We recommend configuring the method, at least, with GET. -> Some servers, including NGINX, do not manage the OPTIONS method without it being configured in advance. +> It is recommended to configure at least the method with GET. +> Indeed, some servers -including Nginx- do not handle the OPTIONS method without prior configuration. > -##### SMTP +##### **SMTP** -This probe attempts to establish an SMTP connection with the server, and sends the command "HELLO localhost". If the server responds, the probe checks that the response code starts with a ‘2’ (success). This probe does not have any specific configuration options. +This probe attempts to establish an SMTP connection with the server and sends the "HELLO localhost" command. If the latter responds, the probe checks that the return code starts with a "2" (success). This probe has no specific configuration options. |Fields|Description| |---|---| @@ -368,9 +395,9 @@ This probe attempts to establish an SMTP connection with the server, and sends t |URL|Not supported| |matches|`default`| -##### MySQL +##### **MySQL** -This probe attempts to establish a MySQL connection with the server, and analyses the server’s response. This probe does not have any specific configuration options. +This probe attempts to establish a MySQL connection with the server and analyses the server's response. This probe has no specific configuration options. |Fields|Description| |---|---| @@ -380,9 +407,9 @@ This probe attempts to establish a MySQL connection with the server, and analyse |URL|Not supported| |matches|`default`| -##### PostgreSQL +##### **PostgreSQL** -This probe attempts to establish a PostgreSQL connection with the server, and analyses the server’s response. This probe does not have any specific configuration options. +This probe attempts to establish a PostgreSQL connection with the server and analyses the server's response. This probe has no specific configuration options. |Fields|Description| |---|---| @@ -392,9 +419,9 @@ This probe attempts to establish a PostgreSQL connection with the server, and an |URL|Not supported| |matches|`default`| -##### oco +##### **oco** -This probe attempts to establish a TCP connection on port 79 of your server, and checks that the response starts with a ‘2’ (success). This probe does not have any specific configuration options. +This probe attempts to establish a TCP connection on port 79 of your server and checks that the response starts with a "2" (success). This probe has no specific configuration options. |Fields|Description| |---|---| @@ -404,20 +431,24 @@ This probe attempts to establish a TCP connection on port 79 of your server, and |URL|Not supported| |matches|`default`| -## Via the OVH Control Panel. +### From the OVHcloud Control Panel -You can configure probes when you add (or modify) a server farm, in advanced settings. +You can configure probes when you add or modify a server farm, in advanced settings. -![Advanced settings for a farm](images/farm_advanced_settings.png){.thumbnail} +![Advanced farm settings](images/farm_advanced_settings.png){.thumbnail} -This is how you access the probe type’s configuration. +You will then have access to the configuration for the probe type. ![Probe settings](images/farm_advanced_settings_unfolded.png){.thumbnail} -If you are able to do so with the probe type you have selected, you can configure specific advanced settings for the probe. +If the probe type you have selected allows it, you can configure advanced settings that are specific to that probe. -![Advanced settings for a probe](images/probe_settings.png){.thumbnail} +![Advanced probe settings](images/probe_settings.png){.thumbnail} A new configuration window will appear, with the probe’s settings. -![Advanced settings for a probe](images/probe_settings_dialog.png){.thumbnail} +![Advanced probe settings](images/probe_settings_dialog.png){.thumbnail} + +## Go further + +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_probes/guide.en-us.md b/pages/network/load_balancer/create_probes/guide.en-us.md index 52be1704be5..d774b695308 100644 --- a/pages/network/load_balancer/create_probes/guide.en-us.md +++ b/pages/network/load_balancer/create_probes/guide.en-us.md @@ -1,45 +1,69 @@ --- -title: 'Working with probes' -excerpt: 'Find out about the general principles behind probes, and why they are used' -updated: 2019-02-12 +title: "Configuration of probes on an OVHcloud Load Balancer service" +excerpt: "Discover the general principles and use cases for probes" +updated: 2025-11-12 --- -## Objective + -With the OVH Load Balancer, you can distribute a front-end’s incoming traffic across a set of servers in a destination farm. +## Objective -There may be instances where a server in your farm becomes unavailable for a number of reasons, including oversaturation, an incident, or scheduled maintenance. When the OVH Load Balancer detects a connection error, it will try to redirect traffic to another server. The connection will be slower, but it will continue to work. +The OVHcloud Load Balancer allows you to distribute incoming traffic on a frontend to a set of servers in a destination farm. -However, the reasons behind certain types of unavailability can be harder to pinpoint. For example, if a new version of code is being deployed, the application may momentarily experience a glitch, and return a 500 error. In this particular case, a solution would be to mark the servers concerned as unavailable in the API before you begin the maintenance work, apply the configuration and update, then mark the server as available again. This method is not ideal, but it works. For more information on deploying a blue-green architecture with an OVH Load Balancer, please read our guide: . +It may happen that one of the servers in your farm is no longer available for various reasons, such as overload, an incident, or scheduled maintenance. When it encounters a connection error, your OVHcloud Load Balancer attempts to switch traffic to another server. The connection will be slowed down, but it will continue to function. -The purpose of a probe is to test an infrastructure’s health. It periodically examines each of your servers, to ensure that they are working properly. If it detects an error, the server is automatically disabled until the situation is resolved. +However, the causes of some unavailability are more subtle. For example, if a new version of the code is being deployed, the application may temporarily be in a transitional state and return 500 errors. In this specific case, one solution would be to mark the affected servers as unavailable in the API before the start of the maintenance, apply the configuration and update, and then mark the server as available again. This method is not ideal, but it works.
+For more details on deploying a Blue-Green architecture with your OVHcloud Load Balancer, refer to [this guide](/pages/network/load_balancer/case_blue_green). -Since this service is still very new, its basic features are only available in the API. +Probes are health checks. They periodically query each of your servers to ensure they are operational. If an error is detected, the server is automatically disabled until the situation is resolved. -**This guide will explain the general principles behind probes, and provide practical examples of probes being used.** +**This guide will present the general principles, as well as usage scenarios for probes, drawn from real-world use cases.** ## Requirements -- a correctly configured OVH Load Balancer, with farms and servers set +- Have an [OVHcloud Load Balancer](/links/network/load-balancer) offer in your OVHcloud account. The service must be properly configured, with farms and servers set up. +- Be logged in to your [OVHcloud Control Panel](/links/manager). ## Instructions -### An introduction to the API. +**Table of contents** + +- [Probe API overview](#probe-api) +- [Examples](#examples) +- [Reference](#reference) +- [From the OVHcloud Control Panel](#manager) + +### Probe API overview -The API for probes in the OVH Load Balancer is designed to be flexible and scalable. +The probe API of your OVHcloud Load Balancer has been designed to be flexible and scalable. -The probes can be configured directly on the farms. All of the servers from a single farm will have exactly the same probe applied. However, probe activation and deactivation is specific for each server. As a result, it is possible to only monitor certain servers within a single farm. +Probes are configured directly on the farms. All servers in the same farm thus apply exactly the same probe. However, enabling or disabling a probe is specific to each server. It is therefore possible to "monitor" only certain servers in the same farm. -You can view the list of available probes and their settings with the following API call: +The list of available probes and their parameters can be consulted with the API call : > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmProbes > -For more information on this call, please read the *Available probes* section at the bottom of this guide. +For more information on this call, we invite you to consult the [Available probes](#available-probes) section at the bottom of this guide. -The probes in this list can be configured on `http` and `tcp` farms via the following calls: +The probes returned by this list can be configured on `http` and `tcp` farms via the following calls : > [!api] > @@ -61,56 +85,58 @@ The probes in this list can be configured on `http` and `tcp` farms via the foll > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId} > -For more information on these calls, please read the *Probe configuration* section at the bottom of this guide. +For more information on these calls, you can refer to the [Probe handling](#handling-probes) section of this guide. -### Examples +### Examples -#### Check if the server accepts TCP connections. +#### Check if the server accepts TCP connections -This is the simplest method to set up. It is compatible with `tcp` and `http` farms. If no other probes are configured, you can activate it to start. It works by periodically attempting to establish a connection on each of your servers. If the connection fails twice in a row, the server is put aside until it responds again. +This is the simplest probe to set up. It is compatible with `tcp` and `http` farms. If no other probe is configured, you can activate this one to start. It works by periodically trying to open a connection on each of your servers. If the connection fails twice in a row, the server is put aside until it responds again. -In practice, this gives a probe: +In practice, this gives a probe : |Field|Value and description| |---|---| -|serviceName|Your OVH Load Balancer ID| -|farmId|Your TCP or HTTP farm| +|serviceName|Identifier of your OVHcloud Load Balancer| +|farmId|Identifier of your TCP or HTTP farm| |probe.type|"tcp"| -All other probe fields can keep their default values. Just apply the configuration to the zone concerned, and the probe will begin to work. +All other `probe` fields can remain at their default values. You just need to apply the configuration in the relevant area. -#### Test a specific HTTP page. +#### Test a specific HTTP page -By default, the HTTP `probe` sends an "OPTIONS" request on "/" in HTTP/1.0, without a domain name. In many cases, this is sufficient, but some servers do not manage this method. You can carry out much more powerful tests with the HTTP probe. For example, a good practice when exposing a HTTP service is to add a router dedicated to probes. It is normal to see "/status", "/health", and "/check", which summarise the service’s status. +By default, the HTTP probe sends an `OPTIONS` request on `/` in HTTP/1.0, without a domain name. This is sufficient in many cases, but some servers do not handle this method.
+It is possible to perform much more powerful tests with the HTTP probe. For example, a good practice when exposing an HTTP service is to add a dedicated route for probes. It is common to find `/status`, `/health`, `/check` which return a summary of the service's status. -In practice, if you want to configure the probe to send a "GET" request on [http://api.example.com/status](http://api.example.com/status), it gives: +In practice, if you want to configure the probe to send a `GET` request to [http://api.example.com/status](http://api.example.com/status), this gives : |Field|Value and description| |---|---| -|serviceName|Your OVH Load Balancer ID| -|farmId|Your TCP or HTTP farm| +|serviceName|Identifier of your OVHcloud Load Balancer| +|farmId|Identifier of your TCP or HTTP farm| |probe.type|http| |probe.method|GET| |probe.url|[http://api.example.com/status](http://api.example.com/status)| |probe.match|status| -|probe.pattern|200 (multiple status codes can be added, provided they are separated by commas)| +|probe.pattern|200 (several status codes can be added, separated by commas)| -All other probe fields can keep their default values. Finally, apply the configuration to the zone concerned. +All other `probe` fields can remain at their default values. It is then sufficient to apply the configuration in the relevant area. -#### Use an external HTTP test. +#### Use an external HTTP test -What happens if, for example, your service is an IMAP server that relies on an LDAP server for authentication? The server may accept connections, but experience a temporary connection issue with the LDAP server. If this happens, the customers redirected to this server would be able to connect, but wouldn’t be able to authenticate. As a result, the server would need to be removed from the farm. +What if your service is, for example, an IMAP server that relies on an LDAP server for authentication ?
+It is possible that the server accepts connections, but has a temporary connection issue with the LDAP server. If this happens, clients who are directed to this server could connect but not authenticate. The server should therefore be removed from the farm. -If you are using a `tcp` probe, it will manage to connect. As a result, it will consider the service to be available, even though this is not the case. +If a `tcp` type probe is used, it will be able to connect and consider the service available even though it is not the case. -In this situation, the health test would ideally be able to confirm that the basic service works. You can provide a specific port to use in the tests. This way, you can set up arbitrary tests for a service, and expose them to HTTP on a dedicated port. +In this scenario, the ideal would be for the health check to confirm that the base service is working. It is possible to indicate a specific port to use in the tests. This allows arbitrary tests to be set up for a service and exposed in HTTP, on a dedicated port. -For example, in this situation, you can have a HTTP server on port 8080\. It will test the IMAP server via the URL "/service/imap/status", and will return ‘OK’ when everything is working properly. In practice, this will return: +For example, in this scenario, it would be possible to have an HTTP server on port 8080 that tests the IMAP server via the url `/service/imap/status` and returns *OK* when everything is fine. This would give in practice : |Field|Value and description| |---|---| -|serviceName|Your OVH Load Balancer ID| -|farmId|Your TCP or HTTP farm| +|serviceName|Identifier of your OVHcloud Load Balancer| +|farmId|Identifier of your TCP or HTTP farm| |probe.type|http| |probe.port|8080| |probe.method|GET| @@ -118,24 +144,24 @@ For example, in this situation, you can have a HTTP server on port 8080\. It wil |probe.match|contains| |probe.pattern|OK| -Just apply the configuration to the zone concerned, and the probe will begin to work. +It is then sufficient to apply the configuration in the relevant area. > [!warning] > -> If the HTTP service dedicated to monitoring your IMAP service experiences a fault, the IMAP service will also be considered faulty, even if it is working properly. +> If the HTTP service dedicated to monitoring your IMAP service itself fails, the IMAP service will also be considered as failed, even if it is in perfect working condition. > -### Reference +### Reference -#### Probe configuration. +#### Probe handling -##### Configure a probe. +##### **Configure a probe** -Probes can be configured on a new farm (`POST`) or an existing one (`PUT`). Since the two methods are equivalent, only the second (`PUT`) method is presented here. +Probes can be configured on a new farm (`POST`) or an existing farm (`PUT`). The two methods being equivalent, only the second one (`PUT`) will be presented here. > [!faq] > -> Service: +> Service : > >> > [!api] >> > @@ -143,85 +169,86 @@ Probes can be configured on a new farm (`POST`) or an existing one (`PUT`). Sinc >> > >> > -> Settings: +> Parameters : > >> > **serviceName** >> > ->> >> Your OVH Load Balancer ID. +>> >> The identifier of your OVHcloud Load Balancer. >> > >> > **farmId** >> > ->> >> Your `farm` ID number. +>> >> The numeric identifier of your `farm`. >> > >> > **probe** >> > >> >> **type** >> >> ->> >> > The type of `probe` to activate. The probe types managed are: +>> >> > The type of `probe` to enable. The probe types handled are : >> >> > ->> >> > `tcp` for a basic TCP connection test. +>> >> > `tcp` for a basic TCP connection test ; >> >> > ->> >> > `http` for a HTTP connection test. You can specify the URL and the method. +>> >> > `http` for an HTTP connection test. It is possible to specify the URL and method ; >> >> > ->> >> > `smtp` for a basic SMTP connection test. +>> >> > `smtp` for a basic SMTP connection test ; >> >> > ->> >> > `mysql` for a basic MySQL connection test. +>> >> > `mysql` for a basic MySQL connection test ; >> >> > ->> >> > `pgsql` for a basic PostgreSQL connection test. +>> >> > `pgslq` for a basic PostgreSQL connection test ; >> >> > ->> >> > `oco` for a confirmation of the general status returned on port 79. +>> >> > `oco` for a general status validation returned on port 79. >> > >> >> **interval** >> >> ->> >> > The interval (in seconds) between a probe’s two connection attempts. It must be at least 30 seconds. +>> >> > The interval in seconds between two probe attempts. It must be at least 30 seconds. >> > >> >> **port** >> >> ->> >> > The port that the probe must use, if it is different to the port configured on the farm. ->> >> > This enables you to delegate a server’s status validation to a separate service on the machine, and carry out arbitrary probes. +>> >> > The port that the probe should use, if it is different from the one configured on the farm. +>> >> > This allows you to delegate the server status validation to a third-party service on the machine and perform arbitrary probes. >> > >> >> **method** >> >> ->> >> > The HTTP method to use if the probe is a “http” probe. ->> >> > Compatible methods are `GET`, `HEAD` and `OPTIONS` (by default). +>> >> > The HTTP method to use if the probe is of type "http". +>> >> > The compatible methods are `GET`, `HEAD` and `OPTIONS` (default). >> > >> >> **url** >> >> ->> >> > The URL to use for tests, if it is a “http” probe type. ->> >> > It should be formulated as follows: `[[https?://]www.example.com]/path/to/check`. ->> >> > If a domain is specified, its request will be sent to HTTP/1.1 rather than HTTP/1.0 by default. +>> >> > The URL to use for the tests, if the probe is of type "http". +>> >> > Its form must be `[[https?://]www.example.com]/path/to/check`. +>> >> > If a domain is specified, the request will be sent in HTTP/1.1 instead of HTTP/1.0 by default. >> > >> >> **match** >> >> ->> >> > The type of comparison to use to check if the server is in good health. ->> >> > The managed comparison types are `default`, `status`, `contains` and `matches`. ->> >> > Comparison types are compatible with both “http” and “tcp” probes. +>> >> > The type of comparator to use to check that the server is healthy. +>> >> > The comparators handled are `default`, `status`, `contains` and `matches`. +>> >> > The comparators are compatible with "http" and "tcp" probes. >> > >> >> **pattern** >> >> ->> >> > The value to use as an argument of the comparison type if it is different from “default”. +>> >> > The value to use as an argument for the comparator if it is different from "default". >> > >> >> **forceSsl** >> >> ->> >> > This defines whether the probe must work in SSL/TLS, even if the farm is configured to connect via standard TCP. ->> >> > This can be useful when, for example, your OVH Load Balancer is configured to monitor HTTPS traffic in TCP without decrypting it. +>> >> > Defines whether the probe should work in SSL/TLS even if the farm is configured to connect in classic TCP. +>> >> > This can be useful, for example, when your OVHcloud Load Balancer is configured to forward HTTPS traffic in TCP without decrypting it. > -Other settings can be edited via this call. Since this guide focuses on probes, they are not documented here. +Other parameters can be edited via this call. As this guide focuses on probes, they are not documented here. -If a port other than the farm’s base port is configured on the probe, the `proxyprotocol` and `ssl` settings are reset. As an example, we will take a configured farm to use `proxyprotocol` on **port 4242**, and an associated probe using **port 8080**. The probe will not send the `proxyprotocol` header when it connects on **port 8080**. The same goes for `ssl`, but it can be forced. +If a port other than the base port of the farm is configured on the probe, the `proxyprotocol` and `ssl` parameters are reset. Take the example of a farm configured to use `proxyprotocol` on port **4242** and a probe associated with port **8080**: the latter will not send the `proxyprotocol` header when connecting to port **8080**. The same applies to `ssl`, which can nevertheless be forced. > [!warning] > -> When a probe is configured on a farm, it must be activated on the servers. +> When a probe is configured on a farm, it must also be enabled on the servers. > -##### Activate probes on a server. -For a probe to be active, it must be configured on the farm and activated on the servers concerned. With this call, you can activate the probe being taken into account: +##### **Enable probes on a server** + +For a probe to be active, it must have been configured on the farm and enabled on the relevant servers. This call allows you to enable the probe : > [!faq] > -> Service: +> Service : > >> > [!api] >> > @@ -229,47 +256,47 @@ For a probe to be active, it must be configured on the farm and activated on the >> > >> > -> Settings: +> Parameters : > >> > **serviceName** >> > ->> >> Your OVH Load Balancer ID. +>> >> The identifier of your OVHcloud Load Balancer. >> > >> > **farmId** >> > ->> >> Your `farm` ID number. +>> >> The numeric identifier of your `farm`. >> > >> > **serverId** >> > ->> >> Your `server’s` ID number. +>> >> The numeric identifier of your `server`. >> > >> > **probe** >> > ->> >> Whether or not the `probes` must be taken into account. +>> >> Indicates whether `probe` should be taken into account or not. > -Other settings can be edited via this call. Since this guide focuses on probes, they are not documented here. +Other parameters can be edited via this call. As this guide focuses on probes, they are not documented here. -#### Available comparison types. +#### Available comparators -Four comparison types are available to confirm a probe’s results: +Four comparators are available to validate the result of a probe : -|Comparison type|Description| +|Comparator|Description| |---|---| -|default|Launches a basic test, without any settings.| -|status|A list of valid HTTP response codes, separated by commas.| -|contains|Checks that the pattern can be found in the response.| -|matches|Checks that the response corresponds to a regular expression pattern.| +|default|Runs a basic test, without parameters.| +|status|Comma-separated list of valid HTTP return codes.| +|contains|Checks that the pattern is in the response.| +|matches|Checks that the response matches the pattern regular expression.| -‘Contains’ and ‘matches’ comparison types find a correspondence in the first 16 KB of the response. If the response is longer than 16 KB, whatever comes afterwards will be ignored during the test. Please note that to optimise your performance, we recommend returning as little information as possible in your probes. +The `contains` and `matches` comparators look for a match in the first 16 KB of the response. If it is longer, the part beyond will be ignored during the search. Note that for better performance, we recommend returning as little information as possible in your probes. -#### Available probes. +#### Available probes -You can get a list of the available probes using the following API call: +The list of available probes can be obtained with the API call : > [!faq] > -> Service: +> Service : > >> > [!api] >> > @@ -277,56 +304,56 @@ You can get a list of the available probes using the following API call: >> > >> > -> Response: +> Response : > >> > **type** >> > ->> >> The type of `probe` to configure in the `probe.type` of `farms`. +>> >> The type of `probe` to configure in the `probe.type` field of the `farms`. >> >> ->> >> The probe types managed are: +>> >> The probe types handled are : >> >> ->> >> `tcp` for a basic TCP connection test. +>> >> `tcp` for a basic TCP connection test ; >> >> ->> >> `http` for a HTTP connection test. You can specify the URL and the method. +>> >> `http` for an HTTP connection test. It is possible to specify the URL and method ; >> >> ->> >> `smtp` for a basic SMTP connection test. +>> >> `smtp` for a basic SMTP connection test ; >> >> ->> >> `mysql` for a basic MySQL connection test. +>> >> `mysql` for a basic MySQL connection test ; >> >> ->> >> `pgsql` for a basic PostgreSQL connection test. +>> >> `pgslq` for a basic PostgreSQL connection test ; >> >> ->> >> `oco` for a confirmation of the general status returned on port 79. +>> >> `oco` for a general status validation returned on port 79. >> > >> > **port** >> > ->> >> This defines whether the port can be configured for this probe. +>> >> Indicates whether the port can be configured for this probe. >> > >> > **method** >> > ->> >> The list of HTTP methods managed, or `null` if none are managed. +>> >> The list of HTTP methods handled or `null` if none exist. >> > >> > **url** >> > ->> >> This defines if the probe’s URL can be configured. +>> >> Indicates whether the probe URL can be configured. >> > >> > **matches** >> > ->> >> The list of comparison types available for this probe. +>> >> The list of available comparators for this probe. >> >> The interpretation of the `probe.pattern` field depends on this field. ->> >> The comparison types potentially managed are: +>> >> The potentially handled comparators are : >> >> ->> >> `default`. The most simple test, without any particular conditions.`probe.pattern` must be empty. +>> >> `default` the simplest test, without specific conditions. `probe.pattern` must be empty ; >> >> ->> >> `status`. Checks if the HTTP status code is in the list separated by commas. +>> >> `status` checks that the HTTP status code is in the comma-separated list ; >> >> ->> >> `contains`. Checks that the server response contains `probe.pattern`. +>> >> `contains` checks that the server response contains `probe.pattern` ; >> >> ->> >> `matches`. Checks that the server response matches `probe.pattern`. +>> >> `matches` checks that the server response matches `probe.pattern`. > -##### TCP +##### **TCP** -This probe attempts to establish a TCP connection to the server. If the server sends a “banner”, you can check if it matches a schema. The default test simply ensures that the connection can be established. +This probe attempts to establish a TCP connection with the server. If the latter sends a "banner", it is possible to check that it matches a pattern. The default test simply ensures that the connection can be established. |Fields|Description| |---|---| @@ -336,29 +363,29 @@ This probe attempts to establish a TCP connection to the server. If the server s |URL|Not supported| |matches|`default`, `contains` or `matches`| -##### HTTP +##### **HTTP** -This probe attempts to establish a HTTP connection to the server. If the server responds, you can check its HTTP status code, and that the response body matches a schema. The default test sends an OPTIONS request to the '/' page in HTTP/1.0, without a Host field. +This probe attempts to establish an HTTP connection with the server. If the latter responds, it is possible to check its HTTP status code or that the response body matches a pattern. The default test sends an OPTIONS request to the '/' page in HTTP/1.0, without the Host field. |Fields|Description| |---|---| |type|`http`| |port|Configurable| |method|`GET`, `HEAD` or `OPTIONS`| -|URL|URL in the form: \[\[https?://]www.example.com]/path/to/check| +|URL|URL of the form [[https?://]www.example.com]/path/to/check| |matches|`default`, `contains` or `matches`| -If the URL is specified, the domain name and protocol are operational. If a domain name is specified, the “Host” field of the request will be filled in, and the request will be sent to HTTP/1.1. If the protocol is specified, it must be consistent with the farm’s SSL configuration. +If a URL is specified, the domain name and protocol are operational. If a domain name is specified, the "Host" field of the request will be filled in and the request will be sent in HTTP/1.1. If the protocol is specified, it must be consistent with the SSL configuration of the farm. > [!primary] > -> We recommend configuring the method, at least, with GET. -> Some servers, including NGINX, do not manage the OPTIONS method without it being configured in advance. +> It is recommended to configure at least the method with GET. +> Indeed, some servers -including Nginx- do not handle the OPTIONS method without prior configuration. > -##### SMTP +##### **SMTP** -This probe attempts to establish an SMTP connection with the server, and sends the command "HELLO localhost". If the server responds, the probe checks that the response code starts with a ‘2’ (success). This probe does not have any specific configuration options. +This probe attempts to establish an SMTP connection with the server and sends the "HELLO localhost" command. If the latter responds, the probe checks that the return code starts with a "2" (success). This probe has no specific configuration options. |Fields|Description| |---|---| @@ -368,9 +395,9 @@ This probe attempts to establish an SMTP connection with the server, and sends t |URL|Not supported| |matches|`default`| -##### MySQL +##### **MySQL** -This probe attempts to establish a MySQL connection with the server, and analyses the server’s response. This probe does not have any specific configuration options. +This probe attempts to establish a MySQL connection with the server and analyses the server's response. This probe has no specific configuration options. |Fields|Description| |---|---| @@ -380,9 +407,9 @@ This probe attempts to establish a MySQL connection with the server, and analyse |URL|Not supported| |matches|`default`| -##### PostgreSQL +##### **PostgreSQL** -This probe attempts to establish a PostgreSQL connection with the server, and analyses the server’s response. This probe does not have any specific configuration options. +This probe attempts to establish a PostgreSQL connection with the server and analyses the server's response. This probe has no specific configuration options. |Fields|Description| |---|---| @@ -392,9 +419,9 @@ This probe attempts to establish a PostgreSQL connection with the server, and an |URL|Not supported| |matches|`default`| -##### oco +##### **oco** -This probe attempts to establish a TCP connection on port 79 of your server, and checks that the response starts with a ‘2’ (success). This probe does not have any specific configuration options. +This probe attempts to establish a TCP connection on port 79 of your server and checks that the response starts with a "2" (success). This probe has no specific configuration options. |Fields|Description| |---|---| @@ -404,20 +431,24 @@ This probe attempts to establish a TCP connection on port 79 of your server, and |URL|Not supported| |matches|`default`| -## Via the OVH Control Panel. +### From the OVHcloud Control Panel -You can configure probes when you add (or modify) a server farm, in advanced settings. +You can configure probes when you add or modify a server farm, in advanced settings. -![Advanced settings for a farm](images/farm_advanced_settings.png){.thumbnail} +![Advanced farm settings](images/farm_advanced_settings.png){.thumbnail} -This is how you access the probe type’s configuration. +You will then have access to the configuration for the probe type. ![Probe settings](images/farm_advanced_settings_unfolded.png){.thumbnail} -If you are able to do so with the probe type you have selected, you can configure specific advanced settings for the probe. +If the probe type you have selected allows it, you can configure advanced settings that are specific to that probe. -![Advanced settings for a probe](images/probe_settings.png){.thumbnail} +![Advanced probe settings](images/probe_settings.png){.thumbnail} A new configuration window will appear, with the probe’s settings. -![Advanced settings for a probe](images/probe_settings_dialog.png){.thumbnail} +![Advanced probe settings](images/probe_settings_dialog.png){.thumbnail} + +## Go further + +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_probes/guide.fr-ca.md b/pages/network/load_balancer/create_probes/guide.fr-ca.md index cd48aa0bb0b..9a553f4fae5 100644 --- a/pages/network/load_balancer/create_probes/guide.fr-ca.md +++ b/pages/network/load_balancer/create_probes/guide.fr-ca.md @@ -1,43 +1,67 @@ --- -title: Travailler avec les sondes -excerpt: Découvrez les principes généraux et des cas d'usage pour les sondes -updated: 2019-02-12 +title: "Configuration des sondes sur un service OVHcloud Load Balancer" +excerpt: "Découvrez les principes généraux et des cas d'usage pour les sondes" +updated: 2025-11-12 --- -## Objectif + -L'OVH Load Balancer permet de répartir le trafic entrant sur un front-end vers un ensemble de serveurs d'une ferme de destination. +## Objectif -Il peut arriver que l'un des serveurs de votre ferme ne soit plus disponible pour différentes raisons, comme une surcharge, un incident ou une maintenance planifiée. Lorsqu'il rencontre une erreur de connexion, votre OVH Load Balancer va tenter de basculer le trafic sur un autre serveur. La connexion sera ralentie, mais continuera de fonctionner. +L'OVHcloud Load Balancer permet de répartir le trafic entrant sur un frontend vers un ensemble de serveurs d'une ferme de destination. -Cependant, les causes de certaines indisponibilités sont plus subtiles. Par exemple, si une nouvelle version du code est en cours de déploiement, l'application peut se trouver momentanément dans un état transitoire et retourner des erreurs 500. Dans ce cas précis, une solution serait de marquer les serveurs concernés comme indisponibles dans l'API avant le début de la maintenance, appliquer la configuration et la mise à jour, puis marquer à nouveau le serveur comme disponible. Cette méthode n'est pas idéale mais fonctionne. Pour plus de détail sur le déploiement d'une architecture Blue-Green avec votre OVH Load Balancer, référez-vous à la documentation suivante : . +Il peut arriver que l'un des serveurs de votre ferme ne soit plus disponible pour diverses raisons, telles qu'une surcharge, un incident ou une maintenance planifiée. Lorsqu'il rencontre une erreur de connexion, votre OVHcloud Load Balancer tente de basculer le trafic sur un autre serveur. La connexion sera ralentie, mais continuera de fonctionner. -Les sondes (probes en anglais) sont des tests de santé. Elles interrogent périodiquement chacun de vos serveurs pour s'assurer qu'ils sont opérationnels. Si une erreur est détectée, le serveur est automatiquement désactivé jusqu'à ce que la situation soit rétablie. +Cependant, les causes de certaines indisponibilités sont plus subtiles. Par exemple, si une nouvelle version du code est en cours de déploiement, l'application peut se trouver momentanément dans un état transitoire et retourner des erreurs 500. Dans ce cas précis, une solution consisterait à marquer les serveurs concernés comme indisponibles dans l'API avant le début de la maintenance, appliquer la configuration et la mise à jour, puis marquer à nouveau le serveur comme disponible. Cette méthode n'est pas idéale, mais elle fonctionne.
+Pour plus de détails sur le déploiement d'une architecture Blue-Green avec votre OVHcloud Load Balancer, référez-vous à [ce guide](/pages/network/load_balancer/case_blue_green). -Ce service étant encore jeune, l'essentiel de ses fonctionnalités est uniquement disponible dans l'API. +Les sondes (*probes* en anglais) sont des tests de santé. Elles interrogent périodiquement chacun de vos serveurs pour s'assurer qu'ils sont opérationnels. Si une erreur est détectée, le serveur est automatiquement désactivé jusqu'à ce que la situation soit rétablie. -**Ce guide vous présentera les principes généraux, ainsi que des scénarios d'utilisation des sondes tirés de cas d'usages réels.** +**Ce guide vous présente les principes généraux des sondes, ainsi que des scénarios d'utilisation inspirés de cas d'usage réels.** ## Prérequis -- Disposer d'un OVH Load Balancer correctement configuré, avec un paramétrage des fermes et des serveurs. +- Posséder une offre [OVHcloud Load balancer](/links/network/load-balancer) dans votre compte OVHcloud. Le service doit être correctement configuré, avec un paramétrage des fermes et des serveurs. +- Être connecté à votre [espace client OVHcloud](/links/manager). ## En pratique -### Présentation de l'API +## Sommaire + +- [Présentation de l'API des sondes](#probe-api) +- [Exemples](#examples) +- [Référence](#reference) +- [Depuis l'espace client OVHcloud](#manager) + +### Présentation de l'API des sondes -L'API des sondes de votre OVH Load Balancer a été pensée pour être souple et évolutive. +L'API des sondes de votre service OVHcloud Load Balancer a été conçue pour être souple et évolutive. -Les sondes se configurent directement sur les fermes. Tous les serveurs d'une même ferme appliquent ainsi exactement la même sonde. Cependant, l'activation ou la désactivation d'une sonde est spécifique à chaque serveur : il est donc possible de ne « surveiller » que certains serveurs d'une même ferme. +Les sondes se configurent directement sur les fermes. Tous les serveurs d'une même ferme appliquent ainsi exactement la même sonde. Cependant, l'activation ou la désactivation d'une sonde est spécifique à chaque serveur. Il est donc possible de ne « surveiller » que certains serveurs d'une même ferme. -La liste des sondes disponibles et de leurs paramètres peut être consultée avec l'appel d'API : +La liste des sondes disponibles et de leurs paramètres peut être consultée avec l'appel API suivant : > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmProbes > -Pour plus d'informations sur cet appel, nous vous invitons à consulter la section *Sondes disponibles* en bas de ce guide. +Pour plus d'informations sur cet appel, nous vous invitons à consulter la section [Sondes disponibles](#available-probes) en bas de ce guide. Les sondes retournées par cette liste peuvent être configurées sur les fermes `http` et `tcp` via les appels : @@ -61,9 +85,9 @@ Les sondes retournées par cette liste peuvent être configurées sur les fermes > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId} > -Pour plus d'informations sur ces appels, vous pouvez consulter la section *Manipulation des sondes* en bas de ce guide. +Pour plus d'informations sur ces appels, vous pouvez consulter la section [Manipulation des sondes](#handling-probes) de ce guide. -### Exemples +### Exemples #### Vérifier si le serveur accepte des connexions TCP @@ -73,43 +97,45 @@ Dans la pratique, cela donne une sonde : |Champ|Valeur et description| |---|---| -|serviceName|Identifiant de votre OVH Load Balancer| +|serviceName|Identifiant de votre OVHcloud Load Balancer| |farmId|Identifiant de votre ferme TCP ou HTTP| |probe.type|"tcp"| -Tous les autres champs probe peuvent rester à leur valeur par défaut. Il ne reste ensuite qu'à appliquer la configuration dans la zone concernée et le tour est joué. +Tous les autres champs `probe` peuvent rester à leur valeur par défaut. Il ne reste ensuite qu'à appliquer la configuration dans la zone concernée. #### Tester une page HTTP spécifique -Par défaut, la `sonde` HTTP envoie une requête "OPTIONS" sur "/" en HTTP/1.0, sans nom de domaine. Cela suffit dans beaucoup de cas, mais certains serveurs ne gèrent pas cette méthode. Et il est possible de faire des tests beaucoup plus puissants avec la sonde HTTP. Par exemple, une bonne pratique lors de l'exposition d'un service HTTP consiste à ajouter une route dédiée aux sondes. Il est courant de retrouver des "/status", "/health", "/check" qui renvoient une synthèse de l'état du service. +Par défaut, la sonde HTTP envoie une requête `OPTIONS` sur `/` en HTTP/1.0, sans nom de domaine. Cela suffit dans beaucoup de cas, mais certains serveurs ne gèrent pas cette méthode.
+Il est possible de réaliser des tests beaucoup plus puissants avec la sonde HTTP. Par exemple, une bonne pratique lors de l'exposition d'un service HTTP consiste à ajouter une route dédiée aux sondes. Il est courant de retrouver des `/status`, `/health`, `/check` qui renvoient une synthèse de l'état du service. -Dans la pratique, si vous voulez configurer la sonde pour envoyer une requête "GET" sur [http://api.example.com/status](http://api.example.com/status), cela donne : +Dans la pratique, si vous voulez configurer la sonde pour envoyer une requête `GET` sur [http://api.example.com/status](http://api.example.com/status), cela donne : |Champ|Valeur et description| |---|---| -|serviceName|Identifiant de votre OVH Load Balancer| +|serviceName|Identifiant de votre OVHcloud Load Balancer| |farmId|Identifiant de votre ferme TCP ou HTTP| |probe.type|http| |probe.method|GET| |probe.url|[http://api.example.com/status](http://api.example.com/status)| |probe.match|status| -|probe.pattern|200 (Plusieurs codes d'état peuvent être ajoutés, en les séparant par des virgules)| +|probe.pattern|200 (plusieurs codes d'état peuvent être ajoutés, en les séparant par des virgules)| -Tous les autres champs probe peuvent rester à leur valeur par défaut. Il suffit ensuite d'appliquer la configuration dans la zone concernée. +Tous les autres champs `probe` peuvent rester à leur valeur par défaut. Il suffit ensuite d'appliquer la configuration dans la zone concernée. #### Utiliser un test HTTP externe -Que se passe-t-il si votre service est, par exemple, un serveur IMAP qui repose sur un serveur LDAP pour l'authentification ? Il est possible que le serveur accepte des connexions mais qu'il ait un souci temporaire de connexion avec le serveur LDAP. Si cela arrive, les clients qui seraient dirigés vers ce serveur pourraient se connecter mais pas s'authentifier. Le serveur devrait donc être retiré de la ferme. +Que se passe-t-il si votre service est, par exemple, un serveur IMAP qui repose sur un serveur LDAP pour l'authentification ?
+Il est possible que le serveur accepte des connexions, mais qu'il ait un souci temporaire de connexion avec le serveur LDAP. Si cela arrive, les clients qui seraient dirigés vers ce serveur pourraient se connecter mais pas s'authentifier. Le serveur devrait donc être retiré de la ferme. Si une sonde de type `tcp` est utilisée, elle arrivera à se connecter et considérera que le service est disponible bien que ce ne soit pas le cas. Dans ce scénario, l'idéal serait que le test de santé puisse confirmer que le service de base fonctionne. Il est possible d'indiquer un port spécifique à utiliser dans les tests. Cela permet de mettre en place des tests arbitraires pour un service et les exposer en HTTP, sur un port dédié. -Par exemple, dans ce scénario, il serait possible d'avoir un serveur HTTP sur le port 8080 qui teste le serveur IMAP via l'url "/service/imap/status" et retourne *OK* lorsque tout va bien. Ce qui donnerait dans la pratique : +Par exemple, dans ce scénario, il serait possible d'avoir un serveur HTTP sur le port 8080 qui teste le serveur IMAP via l'url `/service/imap/status` et retourne *OK* lorsque tout va bien. Ce qui donnerait dans la pratique : |Champ|Valeur et description| |---|---| -|serviceName|Identifiant de votre OVH Load Balancer| +|serviceName|Identifiant de votre OVHcloud Load Balancer| |farmId|Identifiant de votre ferme TCP ou HTTP| |probe.type|http| |probe.port|8080| @@ -118,18 +144,18 @@ Par exemple, dans ce scénario, il serait possible d'avoir un serveur HTTP sur l |probe.match|contains| |probe.pattern|OK| -Il ne reste ensuite qu'à appliquer la configuration dans la zone concernée et le tour est joué. +Il ne reste ensuite qu'à appliquer la configuration dans la zone concernée. > [!warning] > > Si le service HTTP dédié à la surveillance de votre service IMAP tombe lui-même en panne, le service IMAP sera considéré comme en panne lui aussi, même s'il est en parfait état de fonctionnement. > -### Référence +### Référence -#### Manipulation des sondes +#### Manipulation des sondes -##### Configurer une sonde +##### **Configurer une sonde** Les sondes peuvent être configurées sur une nouvelle ferme (`POST`) ou une ferme existante (`PUT`). Les deux méthodes étant équivalentes, seule la seconde (`PUT`) sera présentée ici. @@ -147,7 +173,7 @@ Les sondes peuvent être configurées sur une nouvelle ferme (`POST`) ou une fer > >> > **serviceName** >> > ->> >> L'identifiant de votre OVH Load Balancer. +>> >> L'identifiant de votre OVHcloud Load Balancer. >> > >> > **farmId** >> > @@ -203,20 +229,21 @@ Les sondes peuvent être configurées sur une nouvelle ferme (`POST`) ou une fer >> > >> >> **forceSsl** >> >> ->> >> > Cela définit si la sonde doit fonctionner en SSL/TLS même si la ferme est configurée pour se connecter en TCP classique. ->> >> > Cela peut servir par exemple lorsque votre OVH Load Balancer est configuré pour faire suivre le trafic HTTPS en TCP sans le déchiffrer. +>> >> > Définit si la sonde doit fonctionner en SSL/TLS même si la ferme est configurée pour se connecter en TCP classique. +>> >> > Ceci peut être utile, par exemple, lorsque votre OVHcloud Load Balancer est configuré pour faire suivre le trafic HTTPS en TCP sans le déchiffrer. > D'autres paramètres peuvent être édités via cet appel. Dans la mesure où ce guide se concentre sur les sondes, ils ne sont pas documentés ici. -Si un port autre que le port de base de la ferme est configuré sur la sonde, les paramètres `proxyprotocol` et `ssl` sont réinitialisés. Prenons l'exemple d'une ferme configurée pour utiliser le `proxyprotocol` sur le *port* **4242** et d'une sonde associée employant le *port* **8080** : cette dernière n'enverra pas l'entête `proxyprotocol` lorsqu'elle se connectera sur le *port* **8080**. Il en est de même pour le `ssl`, qui peut néanmoins être forcé. +Si un port autre que le port de base de la ferme est configuré sur la sonde, les paramètres `proxyprotocol` et `ssl` sont réinitialisés. Prenons l'exemple d'une ferme configurée pour utiliser le `proxyprotocol` sur le *port* **4242** et d'une sonde associée employant le *port* **8080** : cette dernière n'enverra pas l'en-tête `proxyprotocol` lorsqu'elle se connectera sur le *port* **8080**. Il en est de même pour le `ssl`, qui peut néanmoins être forcé. > [!warning] > -> Lorsqu'une sonde est configurée sur une ferme, elle doit être activée sur les serveurs. +> Lorsqu'une sonde est configurée sur une ferme, elle doit également être activée sur les serveurs. > -##### Activer les sondes sur un serveur +##### **Activer les sondes sur un serveur** + Pour qu'une sonde soit active, il faut qu'elle ait été configurée sur la ferme et activée sur les serveurs concernés. Cet appel permet d'activer la prise en compte de la sonde : > [!faq] @@ -233,7 +260,7 @@ Pour qu'une sonde soit active, il faut qu'elle ait été configurée sur la ferm > >> > **serviceName** >> > ->> >> L'identifiant de votre OVH Load Balancer. +>> >> L'identifiant de votre OVHcloud Load Balancer. >> > >> > **farmId** >> > @@ -245,7 +272,7 @@ Pour qu'une sonde soit active, il faut qu'elle ait été configurée sur la ferm >> > >> > **probe** >> > ->> >> Si les `probe` doivent être prises en compte ou non. +>> >> Indique si les `probe` doivent être prises en compte ou non. > D'autres paramètres peuvent être édités via cet appel. Dans la mesure où ce guide se concentre sur les sondes, ils ne sont pas documentés ici. @@ -257,13 +284,13 @@ Quatre comparateurs sont disponibles pour valider le résultat d'une sonde : |Comparateur|Description| |---|---| |default|Lance un test de base, sans paramètre.| -|status|Liste séparée par des virgules de code de retour HTTP valides.| +|status|Liste de codes de retour HTTP valides, séparés par des virgules.| |contains|Vérifie que le pattern se trouve dans la réponse.| -|matches|Vérifie que la réponse correspond à l'expression régulière pattern.| +|matches|Vérifie que la réponse correspond à l'expression régulière du pattern.| -Les comparateurs contains et matches cherchent une correspondance dans les 16 premiers ko de la réponse. Si celle-ci est plus longue, la partie au-delà sera ignorée lors de la recherche. Notez que pour de meilleures performances, nous vous recommandons de retourner le moins d'informations possible dans vos sondes. +Les comparateurs `contains` et `matches` cherchent une correspondance dans les 16 premiers ko de la réponse. Si celle-ci est plus longue, la partie au-delà sera ignorée lors de la recherche. Notez que pour de meilleures performances, nous vous recommandons de retourner le moins d'informations possible dans vos sondes. -#### Sondes disponibles +#### Sondes disponibles La liste des sondes disponibles peut être obtenue avec l'appel API : @@ -299,15 +326,15 @@ La liste des sondes disponibles peut être obtenue avec l'appel API : >> > >> > **port** >> > ->> >> Cela définit si le port peut être configuré pour cette sonde. +>> >> Indique si le port peut être configuré pour cette sonde. >> > >> > **method** >> > ->> >> La liste de méthodes HTTP gérées ou `null` s'il n'en existe aucune. +>> >> La liste des méthodes HTTP gérées ou `null` s'il n'en existe aucune. >> > >> > **url** >> > ->> >> Cela définit si l'URL de la sonde peut être configurée. +>> >> Indique si l'URL de la sonde peut être configurée. >> > >> > **matches** >> > @@ -324,7 +351,7 @@ La liste des sondes disponibles peut être obtenue avec l'appel API : >> >> `matches` vérifie que la réponse du serveur correspond à `probe.pattern`. > -##### TCP +##### **TCP** Cette sonde tente d'établir une connexion TCP avec le serveur. Si ce dernier envoie une « bannière », il est possible de vérifier qu'elle correspond à un schéma. Le test par défaut s'assure simplement que la connexion peut être établie. @@ -336,7 +363,7 @@ Cette sonde tente d'établir une connexion TCP avec le serveur. Si ce dernier en |URL|Non supporté| |matches|`default`, `contains` ou `matches`| -##### HTTP +##### **HTTP** Cette sonde tente d'établir une connexion HTTP avec le serveur. Si ce dernier répond, il est possible de vérifier son code d'état HTTP ou que le corps de la réponse correspond à un schéma. Le test par défaut envoie une requête OPTIONS sur la page '/' en HTTP/1.0, sans champ Host. @@ -348,7 +375,7 @@ Cette sonde tente d'établir une connexion HTTP avec le serveur. Si ce dernier r |URL|URL de la forme [[https?://]www.example.com]/path/to/check| |matches|`default`, `contains` ou `matches`| -Si une URL est spécifiée, le nom de domaine et le protocole sont opérationels. Si un nom de domaine est spécifié, le champ "Host" de la requête sera renseigné et la requête sera envoyée en HTTP/1.1. Si le protocole est spécifié, il doit être cohérent avec la configuration SSL de la ferme. +Si une URL est spécifiée, le nom de domaine et le protocole sont opérationnels. Si un nom de domaine est spécifié, le champ "Host" de la requête sera renseigné et la requête sera envoyée en HTTP/1.1. Si le protocole est spécifié, il doit être cohérent avec la configuration SSL de la ferme. > [!primary] > @@ -356,7 +383,7 @@ Si une URL est spécifiée, le nom de domaine et le protocole sont opérationels > En effet, certains serveurs -dont Nginx- ne gèrent pas la méthode OPTIONS sans configuration préalable. > -##### SMTP +##### **SMTP** Cette sonde tente d'établir une connexion SMTP avec le serveur et envoie la commande "HELLO localhost". Si ce dernier répond, la sonde vérifie que le code de retour commence par un "2" (succès). Cette sonde n'a pas d'options de configuration particulières. @@ -368,7 +395,7 @@ Cette sonde tente d'établir une connexion SMTP avec le serveur et envoie la com |URL|Non supporté| |matches|`default`| -##### MySQL +##### **MySQL** Cette sonde tente d'établir une connexion MySQL avec le serveur et analyse la réponse du serveur. Cette sonde n'a pas d'options de configuration particulières. @@ -380,7 +407,7 @@ Cette sonde tente d'établir une connexion MySQL avec le serveur et analyse la r |URL|Non supporté| |matches|`default`| -##### PostgreSQL +##### **PostgreSQL** Cette sonde tente d'établir une connexion PostgreSQL avec le serveur et analyse la réponse du serveur. Cette sonde n'a pas d'options de configuration particulières. @@ -392,7 +419,7 @@ Cette sonde tente d'établir une connexion PostgreSQL avec le serveur et analyse |URL|Non supporté| |matches|`default`| -##### oco +##### **oco** Cette sonde tente d'établir une connexion TCP sur le port 79 de votre serveur et vérifie que la réponse commence par un "2" (succès). Cette sonde n'a pas d'options de configuration particulières. @@ -404,9 +431,9 @@ Cette sonde tente d'établir une connexion TCP sur le port 79 de votre serveur e |URL|Non supporté| |matches|`default`| -## Depuis le manager +### Depuis l'espace client OVHcloud -La configuration des sondes se fait lors de l'ajout (ou modification) d'une ferme de serveurs, dans les paramètres avancés. +La configuration des sondes se fait lors de l'ajout ou de la modification d'une ferme de serveurs, dans les paramètres avancés. ![Paramètres avancés d'une ferme](images/farm_advanced_settings.png){.thumbnail} @@ -414,10 +441,14 @@ Vous avez alors accès à la configuration du type de sonde. ![Paramètres d'une sonde](images/farm_advanced_settings_unfolded.png){.thumbnail} -Si le type de sonde séléctionné le permet, vous pouvez configurer les paramètres avancés spécifiques à cette sonde. +Si le type de sonde sélectionné le permet, vous pouvez configurer les paramètres avancés spécifiques à cette sonde. ![Paramètres avancés d'une sonde](images/probe_settings.png){.thumbnail} Une nouvelle fenêtre de configuration apparaît avec les paramètres de la sonde. ![Paramètres avancés d'une sonde](images/probe_settings_dialog.png){.thumbnail} + +## Aller plus loin + +Échangez avec notre [communauté d'utilisateurs](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_probes/guide.fr-fr.md b/pages/network/load_balancer/create_probes/guide.fr-fr.md index 0dda6298009..0a79894d0a0 100644 --- a/pages/network/load_balancer/create_probes/guide.fr-fr.md +++ b/pages/network/load_balancer/create_probes/guide.fr-fr.md @@ -1,23 +1,38 @@ --- title: "Configuration des sondes sur un service OVHcloud Load Balancer" excerpt: "Découvrez les principes généraux et des cas d'usage pour les sondes" -updated: 2022-03-25 +updated: 2025-11-12 --- + + ## Objectif L'OVHcloud Load Balancer permet de répartir le trafic entrant sur un frontend vers un ensemble de serveurs d'une ferme de destination. -Il peut arriver que l'un des serveurs de votre ferme ne soit plus disponible pour différentes raisons, comme une surcharge, un incident ou une maintenance planifiée. Lorsqu'il rencontre une erreur de connexion, votre OVHcloud Load Balancer va tenter de basculer le trafic sur un autre serveur. La connexion sera ralentie, mais continuera de fonctionner. +Il peut arriver que l'un des serveurs de votre ferme ne soit plus disponible pour diverses raisons, telles qu'une surcharge, un incident ou une maintenance planifiée. Lorsqu'il rencontre une erreur de connexion, votre OVHcloud Load Balancer tente de basculer le trafic sur un autre serveur. La connexion sera ralentie, mais continuera de fonctionner. -Cependant, les causes de certaines indisponibilités sont plus subtiles. Par exemple, si une nouvelle version du code est en cours de déploiement, l'application peut se trouver momentanément dans un état transitoire et retourner des erreurs 500. Dans ce cas précis, une solution serait de marquer les serveurs concernés comme indisponibles dans l'API avant le début de la maintenance, appliquer la configuration et la mise à jour, puis marquer à nouveau le serveur comme disponible. Cette méthode n'est pas idéale mais fonctionne.
+Cependant, les causes de certaines indisponibilités sont plus subtiles. Par exemple, si une nouvelle version du code est en cours de déploiement, l'application peut se trouver momentanément dans un état transitoire et retourner des erreurs 500. Dans ce cas précis, une solution consisterait à marquer les serveurs concernés comme indisponibles dans l'API avant le début de la maintenance, appliquer la configuration et la mise à jour, puis marquer à nouveau le serveur comme disponible. Cette méthode n'est pas idéale, mais elle fonctionne.
Pour plus de détails sur le déploiement d'une architecture Blue-Green avec votre OVHcloud Load Balancer, référez-vous à [ce guide](/pages/network/load_balancer/case_blue_green). Les sondes (*probes* en anglais) sont des tests de santé. Elles interrogent périodiquement chacun de vos serveurs pour s'assurer qu'ils sont opérationnels. Si une erreur est détectée, le serveur est automatiquement désactivé jusqu'à ce que la situation soit rétablie. -Ce service étant encore jeune, l'essentiel de ses fonctionnalités est uniquement disponible dans l'API. - -**Ce guide vous présentera les principes généraux, ainsi que des scénarios d'utilisation des sondes, tirés de cas d'usages réels.** +**Ce guide vous présente les principes généraux des sondes, ainsi que des scénarios d'utilisation inspirés de cas d'usage réels.** ## Prérequis @@ -26,13 +41,20 @@ Ce service étant encore jeune, l'essentiel de ses fonctionnalités est uniqueme ## En pratique -### Présentation de l'API des sondes +## Sommaire + +- [Présentation de l'API des sondes](#probe-api) +- [Exemples](#examples) +- [Référence](#reference) +- [Depuis l'espace client OVHcloud](#manager) + +### Présentation de l'API des sondes -L'API des sondes de votre OVHcloud Load Balancer a été pensée pour être souple et évolutive. +L'API des sondes de votre service OVHcloud Load Balancer a été conçue pour être souple et évolutive. Les sondes se configurent directement sur les fermes. Tous les serveurs d'une même ferme appliquent ainsi exactement la même sonde. Cependant, l'activation ou la désactivation d'une sonde est spécifique à chaque serveur. Il est donc possible de ne « surveiller » que certains serveurs d'une même ferme. -La liste des sondes disponibles et de leurs paramètres peut être consultée avec l'appel d'API : +La liste des sondes disponibles et de leurs paramètres peut être consultée avec l'appel API suivant : > [!api] > @@ -65,7 +87,7 @@ Les sondes retournées par cette liste peuvent être configurées sur les fermes Pour plus d'informations sur ces appels, vous pouvez consulter la section [Manipulation des sondes](#handling-probes) de ce guide. -### Exemples +### Exemples #### Vérifier si le serveur accepte des connexions TCP @@ -79,12 +101,12 @@ Dans la pratique, cela donne une sonde : |farmId|Identifiant de votre ferme TCP ou HTTP| |probe.type|"tcp"| -Tous les autres champs probe peuvent rester à leur valeur par défaut. Il ne reste ensuite qu'à appliquer la configuration dans la zone concernée. +Tous les autres champs `probe` peuvent rester à leur valeur par défaut. Il ne reste ensuite qu'à appliquer la configuration dans la zone concernée. #### Tester une page HTTP spécifique Par défaut, la sonde HTTP envoie une requête `OPTIONS` sur `/` en HTTP/1.0, sans nom de domaine. Cela suffit dans beaucoup de cas, mais certains serveurs ne gèrent pas cette méthode.
-Il est possible de faire des tests beaucoup plus puissants avec la sonde HTTP. Par exemple, une bonne pratique lors de l'exposition d'un service HTTP consiste à ajouter une route dédiée aux sondes. Il est courant de retrouver des `/status`, `/health`, `/check` qui renvoient une synthèse de l'état du service. +Il est possible de réaliser des tests beaucoup plus puissants avec la sonde HTTP. Par exemple, une bonne pratique lors de l'exposition d'un service HTTP consiste à ajouter une route dédiée aux sondes. Il est courant de retrouver des `/status`, `/health`, `/check` qui renvoient une synthèse de l'état du service. Dans la pratique, si vous voulez configurer la sonde pour envoyer une requête `GET` sur [http://api.example.com/status](http://api.example.com/status), cela donne : @@ -98,12 +120,12 @@ Dans la pratique, si vous voulez configurer la sonde pour envoyer une requête ` |probe.match|status| |probe.pattern|200 (plusieurs codes d'état peuvent être ajoutés, en les séparant par des virgules)| -Tous les autres champs probe peuvent rester à leur valeur par défaut. Il suffit ensuite d'appliquer la configuration dans la zone concernée. +Tous les autres champs `probe` peuvent rester à leur valeur par défaut. Il suffit ensuite d'appliquer la configuration dans la zone concernée. #### Utiliser un test HTTP externe Que se passe-t-il si votre service est, par exemple, un serveur IMAP qui repose sur un serveur LDAP pour l'authentification ?
-Il est possible que le serveur accepte des connexions mais qu'il ait un souci temporaire de connexion avec le serveur LDAP. Si cela arrive, les clients qui seraient dirigés vers ce serveur pourraient se connecter mais pas s'authentifier. Le serveur devrait donc être retiré de la ferme. +Il est possible que le serveur accepte des connexions, mais qu'il ait un souci temporaire de connexion avec le serveur LDAP. Si cela arrive, les clients qui seraient dirigés vers ce serveur pourraient se connecter mais pas s'authentifier. Le serveur devrait donc être retiré de la ferme. Si une sonde de type `tcp` est utilisée, elle arrivera à se connecter et considérera que le service est disponible bien que ce ne soit pas le cas. @@ -129,7 +151,7 @@ Il ne reste ensuite qu'à appliquer la configuration dans la zone concernée. > Si le service HTTP dédié à la surveillance de votre service IMAP tombe lui-même en panne, le service IMAP sera considéré comme en panne lui aussi, même s'il est en parfait état de fonctionnement. > -### Référence +### Référence #### Manipulation des sondes @@ -207,8 +229,8 @@ Les sondes peuvent être configurées sur une nouvelle ferme (`POST`) ou une fer >> > >> >> **forceSsl** >> >> ->> >> > Cela définit si la sonde doit fonctionner en SSL/TLS même si la ferme est configurée pour se connecter en TCP classique. ->> >> > Cela peut servir par exemple lorsque votre OVHcloud Load Balancer est configuré pour faire suivre le trafic HTTPS en TCP sans le déchiffrer. +>> >> > Définit si la sonde doit fonctionner en SSL/TLS même si la ferme est configurée pour se connecter en TCP classique. +>> >> > Ceci peut être utile, par exemple, lorsque votre OVHcloud Load Balancer est configuré pour faire suivre le trafic HTTPS en TCP sans le déchiffrer. > D'autres paramètres peuvent être édités via cet appel. Dans la mesure où ce guide se concentre sur les sondes, ils ne sont pas documentés ici. @@ -217,7 +239,7 @@ Si un port autre que le port de base de la ferme est configuré sur la sonde, le > [!warning] > -> Lorsqu'une sonde est configurée sur une ferme, elle doit être activée sur les serveurs. +> Lorsqu'une sonde est configurée sur une ferme, elle doit également être activée sur les serveurs. > ##### **Activer les sondes sur un serveur** @@ -250,7 +272,7 @@ Pour qu'une sonde soit active, il faut qu'elle ait été configurée sur la ferm >> > >> > **probe** >> > ->> >> Si les `probe` doivent être prises en compte ou non. +>> >> Indique si les `probe` doivent être prises en compte ou non. > D'autres paramètres peuvent être édités via cet appel. Dans la mesure où ce guide se concentre sur les sondes, ils ne sont pas documentés ici. @@ -262,9 +284,9 @@ Quatre comparateurs sont disponibles pour valider le résultat d'une sonde : |Comparateur|Description| |---|---| |default|Lance un test de base, sans paramètre.| -|status|Liste séparée par des virgules de code de retour HTTP valides.| +|status|Liste de codes de retour HTTP valides, séparés par des virgules.| |contains|Vérifie que le pattern se trouve dans la réponse.| -|matches|Vérifie que la réponse correspond à l'expression régulière pattern.| +|matches|Vérifie que la réponse correspond à l'expression régulière du pattern.| Les comparateurs `contains` et `matches` cherchent une correspondance dans les 16 premiers ko de la réponse. Si celle-ci est plus longue, la partie au-delà sera ignorée lors de la recherche. Notez que pour de meilleures performances, nous vous recommandons de retourner le moins d'informations possible dans vos sondes. @@ -304,15 +326,15 @@ La liste des sondes disponibles peut être obtenue avec l'appel API : >> > >> > **port** >> > ->> >> Cela définit si le port peut être configuré pour cette sonde. +>> >> Indique si le port peut être configuré pour cette sonde. >> > >> > **method** >> > ->> >> La liste de méthodes HTTP gérées ou `null` s'il n'en existe aucune. +>> >> La liste des méthodes HTTP gérées ou `null` s'il n'en existe aucune. >> > >> > **url** >> > ->> >> Cela définit si l'URL de la sonde peut être configurée. +>> >> Indique si l'URL de la sonde peut être configurée. >> > >> > **matches** >> > @@ -353,7 +375,7 @@ Cette sonde tente d'établir une connexion HTTP avec le serveur. Si ce dernier r |URL|URL de la forme [[https?://]www.example.com]/path/to/check| |matches|`default`, `contains` ou `matches`| -Si une URL est spécifiée, le nom de domaine et le protocole sont opérationels. Si un nom de domaine est spécifié, le champ "Host" de la requête sera renseigné et la requête sera envoyée en HTTP/1.1. Si le protocole est spécifié, il doit être cohérent avec la configuration SSL de la ferme. +Si une URL est spécifiée, le nom de domaine et le protocole sont opérationnels. Si un nom de domaine est spécifié, le champ "Host" de la requête sera renseigné et la requête sera envoyée en HTTP/1.1. Si le protocole est spécifié, il doit être cohérent avec la configuration SSL de la ferme. > [!primary] > @@ -409,9 +431,9 @@ Cette sonde tente d'établir une connexion TCP sur le port 79 de votre serveur e |URL|Non supporté| |matches|`default`| -### Depuis l'espace client OVHcloud +### Depuis l'espace client OVHcloud -La configuration des sondes se fait lors de l'ajout (ou modification) d'une ferme de serveurs, dans les paramètres avancés. +La configuration des sondes se fait lors de l'ajout ou de la modification d'une ferme de serveurs, dans les paramètres avancés. ![Paramètres avancés d'une ferme](images/farm_advanced_settings.png){.thumbnail} diff --git a/pages/network/load_balancer/create_proxyprotocol/guide.fr-ca.md b/pages/network/load_balancer/create_proxyprotocol/guide.fr-ca.md index f9e28324e23..ce896f5d742 100644 --- a/pages/network/load_balancer/create_proxyprotocol/guide.fr-ca.md +++ b/pages/network/load_balancer/create_proxyprotocol/guide.fr-ca.md @@ -10,12 +10,12 @@ Le service OVH Load Balancer agit comme un mandataire ou "Proxy". Comme un manda Pour le visiteur, cela ne pose aucun soucis. Il n'a pas besoin de connaître avec précision le serveur qui répond à sa requête. C'est un détail d'implémentation. En revanche, pour des raisons de statistique et de sécurité, il est parfois indispensable que le serveur final ait connaissance de la véritable adresse du client, or, par défaut, il ne voit que le mandataire (en l’occurrence, votre service OVH Load Balancer). -Si vous utilisez un `Frontend`{.action} HTTP, nous vous recommandons le [guide](/pages/network/load_balancer/create_headers){.ref} qui décrit la manière standard d'utiliser les En-Têtes HTTP pour retrouver l'adresse IP, le port ainsi que le protocole source. +Si vous utilisez un `Frontend`{.action} HTTP, nous vous recommandons le [guide](/pages/network/load_balancer/create_headers) qui décrit la manière standard d'utiliser les En-Têtes HTTP pour retrouver l'adresse IP, le port ainsi que le protocole source. Si vous utilisez un `Frontend`{.action} TCP, alors ce guide est pour vous. ## Prérequis -Ce guide est un guide avancé. Il fait l'hypothèse que vous vous êtes déjà familiarisé avec les fonctionnalités principales de votre service OVH Load Balancer, en particulier, les `Frontend`{.action} et les `Fermes`{.action}. Si ce n'est pas encore le cas, nous vous recommandons de visiter le [guide](/pages/network/load_balancer/create_http_https){.ref}. Ce guide est plus particulièrement orienté sur les services HTTP mais les principes généraux sont les mêmes. +Ce guide est un guide avancé. Il fait l'hypothèse que vous vous êtes déjà familiarisé avec les fonctionnalités principales de votre service OVH Load Balancer, en particulier, les `Frontend`{.action} et les `Fermes`{.action}. Si ce n'est pas encore le cas, nous vous recommandons de visiter le [guide](/pages/network/load_balancer/create_http_https). Ce guide est plus particulièrement orienté sur les services HTTP mais les principes généraux sont les mêmes. Vous devez disposez de : diff --git a/pages/network/load_balancer/create_redirectlocation/guide.en-asia.md b/pages/network/load_balancer/create_redirectlocation/guide.en-asia.md index c9f19f4e011..86244077ac1 100644 --- a/pages/network/load_balancer/create_redirectlocation/guide.en-asia.md +++ b/pages/network/load_balancer/create_redirectlocation/guide.en-asia.md @@ -1,26 +1,26 @@ --- -title: 'Working with redirections' -universe: cloud -excerpt: 'Integrate your web services behind a Load Balancer with redirections' -updated: 2021-02-05 +title: "Configuring an OVHcloud Load Balancer service with redirects" +excerpt: Integrate your web services behind a Load Balancer with redirects +updated: 2025-11-27 --- ## Objective -The OVH Load Balancer acts by default as a proxy. It can also be configured to redirect your customers to a third-party website, which is useful if you are changing your domain name, or want to redirect your customers to your website’s HTTPS version, for example. This is known as HTTP redirection. +The **OVHcloud Load Balancer** operates by default as a proxy. It can also be configured to redirect client traffic to a third-party website. This functionality is essential for scenarios such as **domain name migration** or enforcing the **HTTPS version** of a website. This is known as **HTTP redirection**. -**This guide will show you how to integrate your web services behind an OVH Load Balancer with redirections.** +**This guide outlines the process for integrating your web services behind an OVHcloud Load Balancer utilizing HTTP redirections.** ## Requirements -- an [OVH Load Balancer](https://www.ovh.com/asia/solutions/load-balancer/) -- access to the [OVH Control Panel](https://ca.ovh.com/auth/), or the [OVH API](/links/api) +- Have an [OVHcloud Load Balancer](/links/network/load-balancer) offer in your OVHcloud account. +- Have access to your [OVHcloud Control Panel](/links/manager). +- Have access to the [OVHcloud API](/links/api). ## Instructions -### Presentation +### Overview -A HTTP redirection is presented as follows: +An HTTP redirect looks like this: ```bash HTTP/1.1 301 Moved Permanently @@ -29,85 +29,88 @@ Content-Type: text/html Content-Length: 174 ``` -Custom redirections should have the following form: `:///;?#`. You can only specify one redirection per front-end. +Custom redirects must be formatted as `:///;?#`. Only one redirect can be specified per frontend. -Custom redirections can be specified via the OVH Control Panel and via the API, both on new and existing `front-ends`{.action}. +Custom redirects can be specified via the OVHcloud Control Panel or via the API, on a new or existing frontend. -### Add a custom redirection via the OVH Control Panel. +### Adding a custom redirect from the OVHcloud Control Panel -You can define custom redirections from the [OVH Control Panel](https://ca.ovh.com/auth/) by going to the `Cloud`{.action} section, then `Load Balancer`{.action}. +You can define a custom redirect from the [OVHcloud Control Panel](/links/manager) in the `Bare Metal Cloud`{.action} section and then `Load Balancer`{.action}. +This can be done either on a new frontend during its creation, or on an existing frontend. -You can either do this on a new front-end as you create it, or on an existing front-end. +#### Adding a new frontend -* Add a new front-end. +In the `Frontends`{.action} section, click on the `Add a frontend`{.action} button to create a new one. -In the `Front-ends`{.action} section of the OVH Control Panel, click on `Add a front-end`{.action} to create a new one. +In the frontend editing page, select the `HTTP`{.action} or `HTTPS`{.action} protocol.
+Configure the information as usual. However, it is unnecessary to specify the `Default backend`{.action}, as it will not be used. -In the editing page for a front-end, select `HTTP`{.action} or `HTTPS`{.action} protocol. Configure the information as requested. However, please note that there is no need to set a `Default farm`{.action}, as it will not be used. +In the advanced settings, fill in the `HTTP redirect`{.action}. -In the advanced settings, enter the `HTTP redirection`{.action}. +#### Editing an existing frontend -* Edit an existing front-end. +In the `Frontends`{.action} section, click on the `...`{.action} button to the right of the relevant frontend and select `Edit`{.action}.
+Make sure the selected frontend is of the `HTTP` or `HTTPS` protocol. Complete the configuration if necessary. +However, it is unnecessary to specify the `Default backend`{.action}, as it will not be used. -In the `Front-ends`{.action} section of the OVH Control Panel, select the front-end you would like to edit. To do this, click the `...`{.action} button, then select `Edit`{.action} in the menu that appears. Please ensure that the front-end you have chosen uses either `HTTP` or `HTTPS` protocol. +In the advanced settings, fill in the `HTTP redirect`{.action}. -In the editing page for the front-end, complete the configuration if needed. However, please note that there is no need to set a `Default farm`{.action}, as it will not be used. +![Configuration of a Frontend Redirect](images/add_redirectlocation.png){.thumbnail} -In the advanced settings, enter the `HTTP redirection`{.action}. +Once the frontend is configured, click on `Add`{.action} or `Edit`{.action} depending on whether you are configuring a new frontend or an existing one. +Do not forget to deploy the configuration. -![Configure a front-end redirection](images/add_redirectlocation.png){.thumbnail} +To do this, you can either: -Once the front-end has been configured, click `Add`{.action} or `Edit`{.action}, depending on whether you are configuring a new or existing front-end. Please remember to deploy the configuration. There are two ways of doing this: +- In the `Status` section of the `Home`{.action} tab, click on the `...`{.action} button of your Load Balancer and then click on `Apply the configuration`{.action}. -- via the `Status`{.action} section of the OVH Control Panel, by clicking on your Load Balancer’s `...`{.action} button, then selecting `Apply configuration`{.action} +- In the reminder banner informing you that the configuration is not applied, click on `Apply the configuration`{.action}. -- via the reminder box in the OVH Control Panel, notifying you that the configuration has not been applied, by clicking `Apply configuration`{.action} +![Application of a Load Balancer Configuration](images/apply_configuration.png){.thumbnail} -![Apply a Load Balancer configuration](images/apply_configuration.png){.thumbnail} +### Adding a custom redirect from the OVHcloud API -### Add a custom redirection via the API. +In the [OVHcloud API](/links/api), redirects are specified in the redirectLocation string: -In the [OVH API](/links/api), redirections are specified in the redirectLocation character chain. - -* If you are creating a new front-end: +**Creating a new frontend** > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend > -|Setting|Meaning| +|Parameter|Meaning| |---|---| -|serviceName|Your Load Balancer service ID| -|port|Front-end listening ports| -|zone|Front-end deployment zones| -|redirectLocation|HTTP redirection URL| +|serviceName|Identifier of your Load Balancer service| +|port|Port(s) of the frontend| +|zone|Deployment zone of the frontend| +|redirectLocation|HTTP redirect URL| -* If you are updating an existing front-end: +**Updating an existing frontend** > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId} > -|Setting|Meaning| +|Parameter|Meaning| |---|---| -|serviceName|Your Load Balancer service ID| -|frontendId|ID of the front-end to be updated| -|redirectLocation|HTTP redirection URL| +|serviceName|Identifier of your Load Balancer service| +|frontendId|Identifier of the frontend to update| +|redirectLocation|HTTP redirect URL| -Then apply the modifications: +**Applying the changes** > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh > -|Setting|Meaning| +|Parameter|Meaning| |---|---| -|serviceName|Your Load Balancer service ID| -|zone|Front-end deployment zones| +|serviceName|Identifier of your Load Balancer service| +|zone|Deployment zone of the frontend| ## Go further -Join our community of users on . +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_redirectlocation/guide.en-au.md b/pages/network/load_balancer/create_redirectlocation/guide.en-au.md index 36bdd99c755..86244077ac1 100644 --- a/pages/network/load_balancer/create_redirectlocation/guide.en-au.md +++ b/pages/network/load_balancer/create_redirectlocation/guide.en-au.md @@ -1,26 +1,26 @@ --- -title: 'Working with redirections' -universe: cloud -excerpt: 'Integrate your web services behind a Load Balancer with redirections' -updated: 2021-02-05 +title: "Configuring an OVHcloud Load Balancer service with redirects" +excerpt: Integrate your web services behind a Load Balancer with redirects +updated: 2025-11-27 --- ## Objective -The OVH Load Balancer acts by default as a proxy. It can also be configured to redirect your customers to a third-party website, which is useful if you are changing your domain name, or want to redirect your customers to your website’s HTTPS version, for example. This is known as HTTP redirection. +The **OVHcloud Load Balancer** operates by default as a proxy. It can also be configured to redirect client traffic to a third-party website. This functionality is essential for scenarios such as **domain name migration** or enforcing the **HTTPS version** of a website. This is known as **HTTP redirection**. -**This guide will show you how to integrate your web services behind an OVH Load Balancer with redirections.** +**This guide outlines the process for integrating your web services behind an OVHcloud Load Balancer utilizing HTTP redirections.** ## Requirements -- an [OVH Load Balancer](https://www.ovh.com.au/solutions/load-balancer/) -- access to the [OVH Control Panel](https://ca.ovh.com/auth/), or the [OVH API](/links/api) +- Have an [OVHcloud Load Balancer](/links/network/load-balancer) offer in your OVHcloud account. +- Have access to your [OVHcloud Control Panel](/links/manager). +- Have access to the [OVHcloud API](/links/api). ## Instructions -### Presentation +### Overview -A HTTP redirection is presented as follows: +An HTTP redirect looks like this: ```bash HTTP/1.1 301 Moved Permanently @@ -29,85 +29,88 @@ Content-Type: text/html Content-Length: 174 ``` -Custom redirections should have the following form: `:///;?#`. You can only specify one redirection per front-end. +Custom redirects must be formatted as `:///;?#`. Only one redirect can be specified per frontend. -Custom redirections can be specified via the OVH Control Panel and via the API, both on new and existing `front-ends`{.action}. +Custom redirects can be specified via the OVHcloud Control Panel or via the API, on a new or existing frontend. -### Add a custom redirection via the OVH Control Panel. +### Adding a custom redirect from the OVHcloud Control Panel -You can define custom redirections from the [OVH Control Panel](https://ca.ovh.com/auth/) by going to the `Cloud`{.action} section, then `Load Balancer`{.action}. +You can define a custom redirect from the [OVHcloud Control Panel](/links/manager) in the `Bare Metal Cloud`{.action} section and then `Load Balancer`{.action}. +This can be done either on a new frontend during its creation, or on an existing frontend. -You can either do this on a new front-end as you create it, or on an existing front-end. +#### Adding a new frontend -* Add a new front-end. +In the `Frontends`{.action} section, click on the `Add a frontend`{.action} button to create a new one. -In the `Front-ends`{.action} section of the OVH Control Panel, click on `Add a front-end`{.action} to create a new one. +In the frontend editing page, select the `HTTP`{.action} or `HTTPS`{.action} protocol.
+Configure the information as usual. However, it is unnecessary to specify the `Default backend`{.action}, as it will not be used. -In the editing page for a front-end, select `HTTP`{.action} or `HTTPS`{.action} protocol. Configure the information as requested. However, please note that there is no need to set a `Default farm`{.action}, as it will not be used. +In the advanced settings, fill in the `HTTP redirect`{.action}. -In the advanced settings, enter the `HTTP redirection`{.action}. +#### Editing an existing frontend -* Edit an existing front-end. +In the `Frontends`{.action} section, click on the `...`{.action} button to the right of the relevant frontend and select `Edit`{.action}.
+Make sure the selected frontend is of the `HTTP` or `HTTPS` protocol. Complete the configuration if necessary. +However, it is unnecessary to specify the `Default backend`{.action}, as it will not be used. -In the `Front-ends`{.action} section of the OVH Control Panel, select the front-end you would like to edit. To do this, click the `...`{.action} button, then select `Edit`{.action} in the menu that appears. Please ensure that the front-end you have chosen uses either `HTTP` or `HTTPS` protocol. +In the advanced settings, fill in the `HTTP redirect`{.action}. -In the editing page for the front-end, complete the configuration if needed. However, please note that there is no need to set a `Default farm`{.action}, as it will not be used. +![Configuration of a Frontend Redirect](images/add_redirectlocation.png){.thumbnail} -In the advanced settings, enter the `HTTP redirection`{.action}. +Once the frontend is configured, click on `Add`{.action} or `Edit`{.action} depending on whether you are configuring a new frontend or an existing one. +Do not forget to deploy the configuration. -![Configure a front-end redirection](images/add_redirectlocation.png){.thumbnail} +To do this, you can either: -Once the front-end has been configured, click `Add`{.action} or `Edit`{.action}, depending on whether you are configuring a new or existing front-end. Please remember to deploy the configuration. There are two ways of doing this: +- In the `Status` section of the `Home`{.action} tab, click on the `...`{.action} button of your Load Balancer and then click on `Apply the configuration`{.action}. -- via the `Status`{.action} section of the OVH Control Panel, by clicking on your Load Balancer’s `...`{.action} button, then selecting `Apply configuration`{.action} +- In the reminder banner informing you that the configuration is not applied, click on `Apply the configuration`{.action}. -- via the reminder box in the OVH Control Panel, notifying you that the configuration has not been applied, by clicking `Apply configuration`{.action} +![Application of a Load Balancer Configuration](images/apply_configuration.png){.thumbnail} -![Apply a Load Balancer configuration](images/apply_configuration.png){.thumbnail} +### Adding a custom redirect from the OVHcloud API -### Add a custom redirection via the API. +In the [OVHcloud API](/links/api), redirects are specified in the redirectLocation string: -In the [OVH API](/links/api), redirections are specified in the redirectLocation character chain. - -* If you are creating a new front-end: +**Creating a new frontend** > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend > -|Setting|Meaning| +|Parameter|Meaning| |---|---| -|serviceName|Your Load Balancer service ID| -|port|Front-end listening ports| -|zone|Front-end deployment zones| -|redirectLocation|HTTP redirection URL| +|serviceName|Identifier of your Load Balancer service| +|port|Port(s) of the frontend| +|zone|Deployment zone of the frontend| +|redirectLocation|HTTP redirect URL| -* If you are updating an existing front-end: +**Updating an existing frontend** > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId} > -|Setting|Meaning| +|Parameter|Meaning| |---|---| -|serviceName|Your Load Balancer service ID| -|frontendId|ID of the front-end to be updated| -|redirectLocation|HTTP redirection URL| +|serviceName|Identifier of your Load Balancer service| +|frontendId|Identifier of the frontend to update| +|redirectLocation|HTTP redirect URL| -Then apply the modifications: +**Applying the changes** > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh > -|Setting|Meaning| +|Parameter|Meaning| |---|---| -|serviceName|Your Load Balancer service ID| -|zone|Front-end deployment zones| +|serviceName|Identifier of your Load Balancer service| +|zone|Deployment zone of the frontend| ## Go further -Join our community of users on . +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_redirectlocation/guide.en-ca.md b/pages/network/load_balancer/create_redirectlocation/guide.en-ca.md index 54e531c8aae..86244077ac1 100644 --- a/pages/network/load_balancer/create_redirectlocation/guide.en-ca.md +++ b/pages/network/load_balancer/create_redirectlocation/guide.en-ca.md @@ -1,26 +1,26 @@ --- -title: 'Working with redirections' -universe: cloud -excerpt: 'Integrate your web services behind a Load Balancer with redirections' -updated: 2021-02-05 +title: "Configuring an OVHcloud Load Balancer service with redirects" +excerpt: Integrate your web services behind a Load Balancer with redirects +updated: 2025-11-27 --- ## Objective -The OVH Load Balancer acts by default as a proxy. It can also be configured to redirect your customers to a third-party website, which is useful if you are changing your domain name, or want to redirect your customers to your website’s HTTPS version, for example. This is known as HTTP redirection. +The **OVHcloud Load Balancer** operates by default as a proxy. It can also be configured to redirect client traffic to a third-party website. This functionality is essential for scenarios such as **domain name migration** or enforcing the **HTTPS version** of a website. This is known as **HTTP redirection**. -**This guide will show you how to integrate your web services behind an OVH Load Balancer with redirections.** +**This guide outlines the process for integrating your web services behind an OVHcloud Load Balancer utilizing HTTP redirections.** ## Requirements -- an [OVH Load Balancer](https://www.ovh.com/ca/en/solutions/load-balancer/) -- access to the [OVH Control Panel](https://ca.ovh.com/auth/), or the [OVH API](/links/api) +- Have an [OVHcloud Load Balancer](/links/network/load-balancer) offer in your OVHcloud account. +- Have access to your [OVHcloud Control Panel](/links/manager). +- Have access to the [OVHcloud API](/links/api). ## Instructions -### Presentation +### Overview -A HTTP redirection is presented as follows: +An HTTP redirect looks like this: ```bash HTTP/1.1 301 Moved Permanently @@ -29,85 +29,88 @@ Content-Type: text/html Content-Length: 174 ``` -Custom redirections should have the following form: `:///;?#`. You can only specify one redirection per front-end. +Custom redirects must be formatted as `:///;?#`. Only one redirect can be specified per frontend. -Custom redirections can be specified via the OVH Control Panel and via the API, both on new and existing `front-ends`{.action}. +Custom redirects can be specified via the OVHcloud Control Panel or via the API, on a new or existing frontend. -### Add a custom redirection via the OVH Control Panel. +### Adding a custom redirect from the OVHcloud Control Panel -You can define custom redirections from the [OVH Control Panel](https://ca.ovh.com/auth/) by going to the `Cloud`{.action} section, then `Load Balancer`{.action}. +You can define a custom redirect from the [OVHcloud Control Panel](/links/manager) in the `Bare Metal Cloud`{.action} section and then `Load Balancer`{.action}. +This can be done either on a new frontend during its creation, or on an existing frontend. -You can either do this on a new front-end as you create it, or on an existing front-end. +#### Adding a new frontend -* Add a new front-end. +In the `Frontends`{.action} section, click on the `Add a frontend`{.action} button to create a new one. -In the `Front-ends`{.action} section of the OVH Control Panel, click on `Add a front-end`{.action} to create a new one. +In the frontend editing page, select the `HTTP`{.action} or `HTTPS`{.action} protocol.
+Configure the information as usual. However, it is unnecessary to specify the `Default backend`{.action}, as it will not be used. -In the editing page for a front-end, select `HTTP`{.action} or `HTTPS`{.action} protocol. Configure the information as requested. However, please note that there is no need to set a `Default farm`{.action}, as it will not be used. +In the advanced settings, fill in the `HTTP redirect`{.action}. -In the advanced settings, enter the `HTTP redirection`{.action}. +#### Editing an existing frontend -* Edit an existing front-end. +In the `Frontends`{.action} section, click on the `...`{.action} button to the right of the relevant frontend and select `Edit`{.action}.
+Make sure the selected frontend is of the `HTTP` or `HTTPS` protocol. Complete the configuration if necessary. +However, it is unnecessary to specify the `Default backend`{.action}, as it will not be used. -In the `Front-ends`{.action} section of the OVH Control Panel, select the front-end you would like to edit. To do this, click the `...`{.action} button, then select `Edit`{.action} in the menu that appears. Please ensure that the front-end you have chosen uses either `HTTP` or `HTTPS` protocol. +In the advanced settings, fill in the `HTTP redirect`{.action}. -In the editing page for the front-end, complete the configuration if needed. However, please note that there is no need to set a `Default farm`{.action}, as it will not be used. +![Configuration of a Frontend Redirect](images/add_redirectlocation.png){.thumbnail} -In the advanced settings, enter the `HTTP redirection`{.action}. +Once the frontend is configured, click on `Add`{.action} or `Edit`{.action} depending on whether you are configuring a new frontend or an existing one. +Do not forget to deploy the configuration. -![Configure a front-end redirection](images/add_redirectlocation.png){.thumbnail} +To do this, you can either: -Once the front-end has been configured, click `Add`{.action} or `Edit`{.action}, depending on whether you are configuring a new or existing front-end. Please remember to deploy the configuration. There are two ways of doing this: +- In the `Status` section of the `Home`{.action} tab, click on the `...`{.action} button of your Load Balancer and then click on `Apply the configuration`{.action}. -- via the `Status`{.action} section of the OVH Control Panel, by clicking on your Load Balancer’s `...`{.action} button, then selecting `Apply configuration`{.action} +- In the reminder banner informing you that the configuration is not applied, click on `Apply the configuration`{.action}. -- via the reminder box in the OVH Control Panel, notifying you that the configuration has not been applied, by clicking `Apply configuration`{.action} +![Application of a Load Balancer Configuration](images/apply_configuration.png){.thumbnail} -![Apply a Load Balancer configuration](images/apply_configuration.png){.thumbnail} +### Adding a custom redirect from the OVHcloud API -### Add a custom redirection via the API. +In the [OVHcloud API](/links/api), redirects are specified in the redirectLocation string: -In the [OVH API](/links/api), redirections are specified in the redirectLocation character chain. - -* If you are creating a new front-end: +**Creating a new frontend** > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend > -|Setting|Meaning| +|Parameter|Meaning| |---|---| -|serviceName|Your Load Balancer service ID| -|port|Front-end listening ports| -|zone|Front-end deployment zones| -|redirectLocation|HTTP redirection URL| +|serviceName|Identifier of your Load Balancer service| +|port|Port(s) of the frontend| +|zone|Deployment zone of the frontend| +|redirectLocation|HTTP redirect URL| -* If you are updating an existing front-end: +**Updating an existing frontend** > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId} > -|Setting|Meaning| +|Parameter|Meaning| |---|---| -|serviceName|Your Load Balancer service ID| -|frontendId|ID of the front-end to be updated| -|redirectLocation|HTTP redirection URL| +|serviceName|Identifier of your Load Balancer service| +|frontendId|Identifier of the frontend to update| +|redirectLocation|HTTP redirect URL| -Then apply the modifications: +**Applying the changes** > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh > -|Setting|Meaning| +|Parameter|Meaning| |---|---| -|serviceName|Your Load Balancer service ID| -|zone|Front-end deployment zones| +|serviceName|Identifier of your Load Balancer service| +|zone|Deployment zone of the frontend| ## Go further -Join our community of users on . +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_redirectlocation/guide.en-gb.md b/pages/network/load_balancer/create_redirectlocation/guide.en-gb.md index beb4d27a80e..86244077ac1 100644 --- a/pages/network/load_balancer/create_redirectlocation/guide.en-gb.md +++ b/pages/network/load_balancer/create_redirectlocation/guide.en-gb.md @@ -1,26 +1,26 @@ --- -title: 'Working with redirections' -universe: cloud -excerpt: 'Integrate your web services behind a Load Balancer with redirections' -updated: 2021-02-05 +title: "Configuring an OVHcloud Load Balancer service with redirects" +excerpt: Integrate your web services behind a Load Balancer with redirects +updated: 2025-11-27 --- ## Objective -The OVH Load Balancer acts by default as a proxy. It can also be configured to redirect your customers to a third-party website, which is useful if you are changing your domain name, or want to redirect your customers to your website’s HTTPS version, for example. This is known as HTTP redirection. +The **OVHcloud Load Balancer** operates by default as a proxy. It can also be configured to redirect client traffic to a third-party website. This functionality is essential for scenarios such as **domain name migration** or enforcing the **HTTPS version** of a website. This is known as **HTTP redirection**. -**This guide will show you how to integrate your web services behind an OVH Load Balancer with redirections.** +**This guide outlines the process for integrating your web services behind an OVHcloud Load Balancer utilizing HTTP redirections.** ## Requirements -- an [OVH Load Balancer](/links/network/load-balancer) -- access to the [OVH Control Panel](/links/manager), or the [OVH API](/links/api) +- Have an [OVHcloud Load Balancer](/links/network/load-balancer) offer in your OVHcloud account. +- Have access to your [OVHcloud Control Panel](/links/manager). +- Have access to the [OVHcloud API](/links/api). ## Instructions -### Presentation +### Overview -A HTTP redirection is presented as follows: +An HTTP redirect looks like this: ```bash HTTP/1.1 301 Moved Permanently @@ -29,85 +29,88 @@ Content-Type: text/html Content-Length: 174 ``` -Custom redirections should have the following form: `:///;?#`. You can only specify one redirection per front-end. +Custom redirects must be formatted as `:///;?#`. Only one redirect can be specified per frontend. -Custom redirections can be specified via the OVH Control Panel and via the API, both on new and existing `front-ends`{.action}. +Custom redirects can be specified via the OVHcloud Control Panel or via the API, on a new or existing frontend. -### Add a custom redirection via the OVH Control Panel. +### Adding a custom redirect from the OVHcloud Control Panel -You can define custom redirections from the [OVH Control Panel](/links/manager) by going to the `Cloud`{.action} section, then `Load Balancer`{.action}. +You can define a custom redirect from the [OVHcloud Control Panel](/links/manager) in the `Bare Metal Cloud`{.action} section and then `Load Balancer`{.action}. +This can be done either on a new frontend during its creation, or on an existing frontend. -You can either do this on a new front-end as you create it, or on an existing front-end. +#### Adding a new frontend -* Add a new front-end. +In the `Frontends`{.action} section, click on the `Add a frontend`{.action} button to create a new one. -In the `Front-ends`{.action} section of the OVH Control Panel, click on `Add a front-end`{.action} to create a new one. +In the frontend editing page, select the `HTTP`{.action} or `HTTPS`{.action} protocol.
+Configure the information as usual. However, it is unnecessary to specify the `Default backend`{.action}, as it will not be used. -In the editing page for a front-end, select `HTTP`{.action} or `HTTPS`{.action} protocol. Configure the information as requested. However, please note that there is no need to set a `Default farm`{.action}, as it will not be used. +In the advanced settings, fill in the `HTTP redirect`{.action}. -In the advanced settings, enter the `HTTP redirection`{.action}. +#### Editing an existing frontend -* Edit an existing front-end. +In the `Frontends`{.action} section, click on the `...`{.action} button to the right of the relevant frontend and select `Edit`{.action}.
+Make sure the selected frontend is of the `HTTP` or `HTTPS` protocol. Complete the configuration if necessary. +However, it is unnecessary to specify the `Default backend`{.action}, as it will not be used. -In the `Front-ends`{.action} section of the OVH Control Panel, select the front-end you would like to edit. To do this, click the `...`{.action} button, then select `Edit`{.action} in the menu that appears. Please ensure that the front-end you have chosen uses either `HTTP` or `HTTPS` protocol. +In the advanced settings, fill in the `HTTP redirect`{.action}. -In the editing page for the front-end, complete the configuration if needed. However, please note that there is no need to set a `Default farm`{.action}, as it will not be used. +![Configuration of a Frontend Redirect](images/add_redirectlocation.png){.thumbnail} -In the advanced settings, enter the `HTTP redirection`{.action}. +Once the frontend is configured, click on `Add`{.action} or `Edit`{.action} depending on whether you are configuring a new frontend or an existing one. +Do not forget to deploy the configuration. -![Configure a front-end redirection](images/add_redirectlocation.png){.thumbnail} +To do this, you can either: -Once the front-end has been configured, click `Add`{.action} or `Edit`{.action}, depending on whether you are configuring a new or existing front-end. Please remember to deploy the configuration. There are two ways of doing this: +- In the `Status` section of the `Home`{.action} tab, click on the `...`{.action} button of your Load Balancer and then click on `Apply the configuration`{.action}. -- via the `Status`{.action} section of the OVH Control Panel, by clicking on your Load Balancer’s `...`{.action} button, then selecting `Apply configuration`{.action} +- In the reminder banner informing you that the configuration is not applied, click on `Apply the configuration`{.action}. -- via the reminder box in the OVH Control Panel, notifying you that the configuration has not been applied, by clicking `Apply configuration`{.action} +![Application of a Load Balancer Configuration](images/apply_configuration.png){.thumbnail} -![Apply a Load Balancer configuration](images/apply_configuration.png){.thumbnail} +### Adding a custom redirect from the OVHcloud API -### Add a custom redirection via the API. +In the [OVHcloud API](/links/api), redirects are specified in the redirectLocation string: -In the [OVH API](/links/api), redirections are specified in the redirectLocation character chain. - -* If you are creating a new front-end: +**Creating a new frontend** > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend > -|Setting|Meaning| +|Parameter|Meaning| |---|---| -|serviceName|Your Load Balancer service ID| -|port|Front-end listening ports| -|zone|Front-end deployment zones| -|redirectLocation|HTTP redirection URL| +|serviceName|Identifier of your Load Balancer service| +|port|Port(s) of the frontend| +|zone|Deployment zone of the frontend| +|redirectLocation|HTTP redirect URL| -* If you are updating an existing front-end: +**Updating an existing frontend** > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId} > -|Setting|Meaning| +|Parameter|Meaning| |---|---| -|serviceName|Your Load Balancer service ID| -|frontendId|ID of the front-end to be updated| -|redirectLocation|HTTP redirection URL| +|serviceName|Identifier of your Load Balancer service| +|frontendId|Identifier of the frontend to update| +|redirectLocation|HTTP redirect URL| -Then apply the modifications: +**Applying the changes** > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh > -|Setting|Meaning| +|Parameter|Meaning| |---|---| -|serviceName|Your Load Balancer service ID| -|zone|Front-end deployment zones| +|serviceName|Identifier of your Load Balancer service| +|zone|Deployment zone of the frontend| ## Go further -Join our community of users on . +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_redirectlocation/guide.en-sg.md b/pages/network/load_balancer/create_redirectlocation/guide.en-sg.md index 07daa87e4e1..86244077ac1 100644 --- a/pages/network/load_balancer/create_redirectlocation/guide.en-sg.md +++ b/pages/network/load_balancer/create_redirectlocation/guide.en-sg.md @@ -1,26 +1,26 @@ --- -title: 'Working with redirections' -universe: cloud -excerpt: 'Integrate your web services behind a Load Balancer with redirections' -updated: 2021-02-05 +title: "Configuring an OVHcloud Load Balancer service with redirects" +excerpt: Integrate your web services behind a Load Balancer with redirects +updated: 2025-11-27 --- ## Objective -The OVH Load Balancer acts by default as a proxy. It can also be configured to redirect your customers to a third-party website, which is useful if you are changing your domain name, or want to redirect your customers to your website’s HTTPS version, for example. This is known as HTTP redirection. +The **OVHcloud Load Balancer** operates by default as a proxy. It can also be configured to redirect client traffic to a third-party website. This functionality is essential for scenarios such as **domain name migration** or enforcing the **HTTPS version** of a website. This is known as **HTTP redirection**. -**This guide will show you how to integrate your web services behind an OVH Load Balancer with redirections.** +**This guide outlines the process for integrating your web services behind an OVHcloud Load Balancer utilizing HTTP redirections.** ## Requirements -- an [OVH Load Balancer](https://www.ovh.com/sg/solutions/load-balancer/) -- access to the [OVH Control Panel](https://ca.ovh.com/auth/), or the [OVH API](/links/api) +- Have an [OVHcloud Load Balancer](/links/network/load-balancer) offer in your OVHcloud account. +- Have access to your [OVHcloud Control Panel](/links/manager). +- Have access to the [OVHcloud API](/links/api). ## Instructions -### Presentation +### Overview -A HTTP redirection is presented as follows: +An HTTP redirect looks like this: ```bash HTTP/1.1 301 Moved Permanently @@ -29,85 +29,88 @@ Content-Type: text/html Content-Length: 174 ``` -Custom redirections should have the following form: `:///;?#`. You can only specify one redirection per front-end. +Custom redirects must be formatted as `:///;?#`. Only one redirect can be specified per frontend. -Custom redirections can be specified via the OVH Control Panel and via the API, both on new and existing `front-ends`{.action}. +Custom redirects can be specified via the OVHcloud Control Panel or via the API, on a new or existing frontend. -### Add a custom redirection via the OVH Control Panel. +### Adding a custom redirect from the OVHcloud Control Panel -You can define custom redirections from the [OVH Control Panel](https://ca.ovh.com/auth/) by going to the `Cloud`{.action} section, then `Load Balancer`{.action}. +You can define a custom redirect from the [OVHcloud Control Panel](/links/manager) in the `Bare Metal Cloud`{.action} section and then `Load Balancer`{.action}. +This can be done either on a new frontend during its creation, or on an existing frontend. -You can either do this on a new front-end as you create it, or on an existing front-end. +#### Adding a new frontend -* Add a new front-end. +In the `Frontends`{.action} section, click on the `Add a frontend`{.action} button to create a new one. -In the `Front-ends`{.action} section of the OVH Control Panel, click on `Add a front-end`{.action} to create a new one. +In the frontend editing page, select the `HTTP`{.action} or `HTTPS`{.action} protocol.
+Configure the information as usual. However, it is unnecessary to specify the `Default backend`{.action}, as it will not be used. -In the editing page for a front-end, select `HTTP`{.action} or `HTTPS`{.action} protocol. Configure the information as requested. However, please note that there is no need to set a `Default farm`{.action}, as it will not be used. +In the advanced settings, fill in the `HTTP redirect`{.action}. -In the advanced settings, enter the `HTTP redirection`{.action}. +#### Editing an existing frontend -* Edit an existing front-end. +In the `Frontends`{.action} section, click on the `...`{.action} button to the right of the relevant frontend and select `Edit`{.action}.
+Make sure the selected frontend is of the `HTTP` or `HTTPS` protocol. Complete the configuration if necessary. +However, it is unnecessary to specify the `Default backend`{.action}, as it will not be used. -In the `Front-ends`{.action} section of the OVH Control Panel, select the front-end you would like to edit. To do this, click the `...`{.action} button, then select `Edit`{.action} in the menu that appears. Please ensure that the front-end you have chosen uses either `HTTP` or `HTTPS` protocol. +In the advanced settings, fill in the `HTTP redirect`{.action}. -In the editing page for the front-end, complete the configuration if needed. However, please note that there is no need to set a `Default farm`{.action}, as it will not be used. +![Configuration of a Frontend Redirect](images/add_redirectlocation.png){.thumbnail} -In the advanced settings, enter the `HTTP redirection`{.action}. +Once the frontend is configured, click on `Add`{.action} or `Edit`{.action} depending on whether you are configuring a new frontend or an existing one. +Do not forget to deploy the configuration. -![Configure a front-end redirection](images/add_redirectlocation.png){.thumbnail} +To do this, you can either: -Once the front-end has been configured, click `Add`{.action} or `Edit`{.action}, depending on whether you are configuring a new or existing front-end. Please remember to deploy the configuration. There are two ways of doing this: +- In the `Status` section of the `Home`{.action} tab, click on the `...`{.action} button of your Load Balancer and then click on `Apply the configuration`{.action}. -- via the `Status`{.action} section of the OVH Control Panel, by clicking on your Load Balancer’s `...`{.action} button, then selecting `Apply configuration`{.action} +- In the reminder banner informing you that the configuration is not applied, click on `Apply the configuration`{.action}. -- via the reminder box in the OVH Control Panel, notifying you that the configuration has not been applied, by clicking `Apply configuration`{.action} +![Application of a Load Balancer Configuration](images/apply_configuration.png){.thumbnail} -![Apply a Load Balancer configuration](images/apply_configuration.png){.thumbnail} +### Adding a custom redirect from the OVHcloud API -### Add a custom redirection via the API. +In the [OVHcloud API](/links/api), redirects are specified in the redirectLocation string: -In the [OVH API](/links/api), redirections are specified in the redirectLocation character chain. - -* If you are creating a new front-end: +**Creating a new frontend** > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend > -|Setting|Meaning| +|Parameter|Meaning| |---|---| -|serviceName|Your Load Balancer service ID| -|port|Front-end listening ports| -|zone|Front-end deployment zones| -|redirectLocation|HTTP redirection URL| +|serviceName|Identifier of your Load Balancer service| +|port|Port(s) of the frontend| +|zone|Deployment zone of the frontend| +|redirectLocation|HTTP redirect URL| -* If you are updating an existing front-end: +**Updating an existing frontend** > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId} > -|Setting|Meaning| +|Parameter|Meaning| |---|---| -|serviceName|Your Load Balancer service ID| -|frontendId|ID of the front-end to be updated| -|redirectLocation|HTTP redirection URL| +|serviceName|Identifier of your Load Balancer service| +|frontendId|Identifier of the frontend to update| +|redirectLocation|HTTP redirect URL| -Then apply the modifications: +**Applying the changes** > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh > -|Setting|Meaning| +|Parameter|Meaning| |---|---| -|serviceName|Your Load Balancer service ID| -|zone|Front-end deployment zones| +|serviceName|Identifier of your Load Balancer service| +|zone|Deployment zone of the frontend| ## Go further -Join our community of users on . +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_redirectlocation/guide.en-us.md b/pages/network/load_balancer/create_redirectlocation/guide.en-us.md index be330d7c78a..86244077ac1 100644 --- a/pages/network/load_balancer/create_redirectlocation/guide.en-us.md +++ b/pages/network/load_balancer/create_redirectlocation/guide.en-us.md @@ -1,26 +1,26 @@ --- -title: 'Working with redirections' -universe: cloud -excerpt: 'Integrate your web services behind a Load Balancer with redirections' -updated: 2021-02-05 +title: "Configuring an OVHcloud Load Balancer service with redirects" +excerpt: Integrate your web services behind a Load Balancer with redirects +updated: 2025-11-27 --- ## Objective -The OVH Load Balancer acts by default as a proxy. It can also be configured to redirect your customers to a third-party website, which is useful if you are changing your domain name, or want to redirect your customers to your website’s HTTPS version, for example. This is known as HTTP redirection. +The **OVHcloud Load Balancer** operates by default as a proxy. It can also be configured to redirect client traffic to a third-party website. This functionality is essential for scenarios such as **domain name migration** or enforcing the **HTTPS version** of a website. This is known as **HTTP redirection**. -**This guide will show you how to integrate your web services behind an OVH Load Balancer with redirections.** +**This guide outlines the process for integrating your web services behind an OVHcloud Load Balancer utilizing HTTP redirections.** ## Requirements -- an [OVH Load Balancer](https://www.ovh.com/world/solutions/load-balancer/) -- access to the [OVH Control Panel](https://ca.ovh.com/auth/), or the [OVH API](/links/api) +- Have an [OVHcloud Load Balancer](/links/network/load-balancer) offer in your OVHcloud account. +- Have access to your [OVHcloud Control Panel](/links/manager). +- Have access to the [OVHcloud API](/links/api). ## Instructions -### Presentation +### Overview -A HTTP redirection is presented as follows: +An HTTP redirect looks like this: ```bash HTTP/1.1 301 Moved Permanently @@ -29,85 +29,88 @@ Content-Type: text/html Content-Length: 174 ``` -Custom redirections should have the following form: `:///;?#`. You can only specify one redirection per front-end. +Custom redirects must be formatted as `:///;?#`. Only one redirect can be specified per frontend. -Custom redirections can be specified via the OVH Control Panel and via the API, both on new and existing `front-ends`{.action}. +Custom redirects can be specified via the OVHcloud Control Panel or via the API, on a new or existing frontend. -### Add a custom redirection via the OVH Control Panel. +### Adding a custom redirect from the OVHcloud Control Panel -You can define custom redirections from the [OVH Control Panel](https://ca.ovh.com/auth/) by going to the `Cloud`{.action} section, then `Load Balancer`{.action}. +You can define a custom redirect from the [OVHcloud Control Panel](/links/manager) in the `Bare Metal Cloud`{.action} section and then `Load Balancer`{.action}. +This can be done either on a new frontend during its creation, or on an existing frontend. -You can either do this on a new front-end as you create it, or on an existing front-end. +#### Adding a new frontend -* Add a new front-end. +In the `Frontends`{.action} section, click on the `Add a frontend`{.action} button to create a new one. -In the `Front-ends`{.action} section of the OVH Control Panel, click on `Add a front-end`{.action} to create a new one. +In the frontend editing page, select the `HTTP`{.action} or `HTTPS`{.action} protocol.
+Configure the information as usual. However, it is unnecessary to specify the `Default backend`{.action}, as it will not be used. -In the editing page for a front-end, select `HTTP`{.action} or `HTTPS`{.action} protocol. Configure the information as requested. However, please note that there is no need to set a `Default farm`{.action}, as it will not be used. +In the advanced settings, fill in the `HTTP redirect`{.action}. -In the advanced settings, enter the `HTTP redirection`{.action}. +#### Editing an existing frontend -* Edit an existing front-end. +In the `Frontends`{.action} section, click on the `...`{.action} button to the right of the relevant frontend and select `Edit`{.action}.
+Make sure the selected frontend is of the `HTTP` or `HTTPS` protocol. Complete the configuration if necessary. +However, it is unnecessary to specify the `Default backend`{.action}, as it will not be used. -In the `Front-ends`{.action} section of the OVH Control Panel, select the front-end you would like to edit. To do this, click the `...`{.action} button, then select `Edit`{.action} in the menu that appears. Please ensure that the front-end you have chosen uses either `HTTP` or `HTTPS` protocol. +In the advanced settings, fill in the `HTTP redirect`{.action}. -In the editing page for the front-end, complete the configuration if needed. However, please note that there is no need to set a `Default farm`{.action}, as it will not be used. +![Configuration of a Frontend Redirect](images/add_redirectlocation.png){.thumbnail} -In the advanced settings, enter the `HTTP redirection`{.action}. +Once the frontend is configured, click on `Add`{.action} or `Edit`{.action} depending on whether you are configuring a new frontend or an existing one. +Do not forget to deploy the configuration. -![Configure a front-end redirection](images/add_redirectlocation.png){.thumbnail} +To do this, you can either: -Once the front-end has been configured, click `Add`{.action} or `Edit`{.action}, depending on whether you are configuring a new or existing front-end. Please remember to deploy the configuration. There are two ways of doing this: +- In the `Status` section of the `Home`{.action} tab, click on the `...`{.action} button of your Load Balancer and then click on `Apply the configuration`{.action}. -- via the `Status`{.action} section of the OVH Control Panel, by clicking on your Load Balancer’s `...`{.action} button, then selecting `Apply configuration`{.action} +- In the reminder banner informing you that the configuration is not applied, click on `Apply the configuration`{.action}. -- via the reminder box in the OVH Control Panel, notifying you that the configuration has not been applied, by clicking `Apply configuration`{.action} +![Application of a Load Balancer Configuration](images/apply_configuration.png){.thumbnail} -![Apply a Load Balancer configuration](images/apply_configuration.png){.thumbnail} +### Adding a custom redirect from the OVHcloud API -### Add a custom redirection via the API. +In the [OVHcloud API](/links/api), redirects are specified in the redirectLocation string: -In the [OVH API](/links/api), redirections are specified in the redirectLocation character chain. - -* If you are creating a new front-end: +**Creating a new frontend** > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend > -|Setting|Meaning| +|Parameter|Meaning| |---|---| -|serviceName|Your Load Balancer service ID| -|port|Front-end listening ports| -|zone|Front-end deployment zones| -|redirectLocation|HTTP redirection URL| +|serviceName|Identifier of your Load Balancer service| +|port|Port(s) of the frontend| +|zone|Deployment zone of the frontend| +|redirectLocation|HTTP redirect URL| -* If you are updating an existing front-end: +**Updating an existing frontend** > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId} > -|Setting|Meaning| +|Parameter|Meaning| |---|---| -|serviceName|Your Load Balancer service ID| -|frontendId|ID of the front-end to be updated| -|redirectLocation|HTTP redirection URL| +|serviceName|Identifier of your Load Balancer service| +|frontendId|Identifier of the frontend to update| +|redirectLocation|HTTP redirect URL| -Then apply the modifications: +**Applying the changes** > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh > -|Setting|Meaning| +|Parameter|Meaning| |---|---| -|serviceName|Your Load Balancer service ID| -|zone|Front-end deployment zones| +|serviceName|Identifier of your Load Balancer service| +|zone|Deployment zone of the frontend| ## Go further -Join our community of users on . +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_redirectlocation/guide.fr-ca.md b/pages/network/load_balancer/create_redirectlocation/guide.fr-ca.md index 580e9f6f812..a5818f1a59e 100644 --- a/pages/network/load_balancer/create_redirectlocation/guide.fr-ca.md +++ b/pages/network/load_balancer/create_redirectlocation/guide.fr-ca.md @@ -1,20 +1,20 @@ --- -title: Travailler avec les redirections -universe: cloud -excerpt: Intégrez vos services web derrière un Load Balancer avec les Redirections -updated: 2021-02-05 +title: "Configuration d'un service OVHcloud Load Balancer avec les redirections" +excerpt: Intégrez vos services web derrière un Load Balancer avec les redirections +updated: 2025-11-27 --- ## Objectif -Le service OVH Load Balancer agit par défault comme un mandataire ou "Proxy". Il peut aussi être configuré pour rediriger vos clients vers un site tiers dans le cas d'un changement de nom de domaine ou pour rediriger vos clients en HTTPS par exemple. C'est que l'on appelle la redirection HTTP. +Le **Load Balancer OVHcloud** fonctionne par défaut comme un proxy, un intermédiaire entre le trafic client et vos serveurs backend. Il peut également être configuré pour rediriger le trafic client vers un site web tiers. Cette fonctionnalité est essentielle pour des scénarios tels que la **migration de nom de domaine** ou l'application de la **version HTTPS** d'un site web. On parle alors de **redirection HTTP**. + +**Ce guide décrit le processus d'intégration de vos services web derrière un Load Balancer OVHcloud utilisant des redirections HTTP.** ## Prérequis -- Disposer d'un [Load Balancer OVH](https://www.ovh.com/ca/fr/solutions/load-balancer/). -- Avoir accès : - - à l'[espace client OVH](/links/manager), ou bien - - à l'[API OVH](/links/api). +- Posséder une offre [OVHcloud Load balancer](/links/network/load-balancer) dans votre compte OVHcloud. +- Avoir accès à votre [espace client OVHcloud](/links/manager). +- Avoir accès à l'[API OVHcloud](/links/api). ## En pratique @@ -29,56 +29,49 @@ Content-Type: text/html Content-Length: 174 ``` -Les Redirections personnalisées doivent être de la forme `:///;?#`. Il n'est possible de spécifier qu'une seule Redirection par Frontend. +Les redirections personnalisées doivent utiliser le format `:///;?#`. Il n'est possible de spécifier qu'une seule redirection par frontend. -Les Redirections personnalisées peuvent être spécifiées via le Manager et via l'API, tant sur un nouveau `Frontend`{.action} qu'un existant. +Les redirections personnalisées peuvent être spécifiées via l'espace client ou via l'API, tant sur un nouveau frontend qu'un existant. -### Ajouter une redirection personnalisée via le Manager +### Ajouter une redirection personnalisée depuis l'espace client OVHcloud -Il est possible de définir une redirection personnalisée depuis l'[espace client](/links/manager) dans la partie `Cloud`{.action}, section `Load Balancer`{.action}. -Cela peut-être effectué tant sur un nouveau Frontend pendant sa création, que sur un Frontend existant. +Il est possible de définir une redirection personnalisée depuis l'[espace client OVHcloud](/links/manager), dans la partie `Bare Metal Cloud`{.action} puis `Load Balancer`{.action}. +Cela peut-être effectué tant sur un nouveau frontend pendant sa création, que sur un frontend existant. -* Ajout d'un nouveau Frontend +#### Ajout d'un nouveau frontend -Dans la section `Frontends`{.action} de votre Manager, cliquez sur le bouton `Ajouter un frontend`{.action} pour en créer un nouveau. +Dans la section `Frontends`{.action}, cliquez sur le bouton `Ajouter un frontend`{.action} pour en créer un nouveau. -Dans la page d'édition d'un frontend, sélectionnez le protocole `HTTP`{.action} ou `HTTPS`{.action}. -Configurez les informations normalement. -Il est cependant inutile de préciser la `Ferme par défaut`{.action}, celle-ci ne sera pas utilisée. +Dans la page d'édition d'un frontend, sélectionnez le protocole `HTTP`{.action} ou `HTTPS`{.action}.
+Configurez les informations normalement. Il est cependant inutile de préciser la `Ferme par défaut`{.action}, celle-ci ne sera pas utilisée. Dans les paramètres avancés, renseignez la `Redirection HTTP`{.action}. -* Édition d'un Frontend existant - -Dans la section `Frontends`{.action} de votre Manager, sélectionnez le frontend que vous souhaitez éditer. -Pour ce faire, cliquez que le bouton `...`{.action} et sélectionnez `Modifier`{.action} dans le menu apparu. -Assurez vous que le frontend choisi soit bien de protocole `HTTP` ou `HTTPS`. +#### Édition d'un frontend existant -Dans la page d'édition du frontend, complétez la configuration du si besoin. +Dans la section `Frontends`{.action}, cliquez que le bouton `...`{.action} à droite du frontend concerné et sélectionnez `Modifier`{.action}.
+Assurez vous que le frontend choisi utilise bien le protocole `HTTP` ou `HTTPS`. Complétez la configuration si besoin. Il est cependant inutile de préciser la `Ferme par défaut`{.action}, celle-ci ne sera pas utilisée. Dans les paramètres avancés, renseignez la `Redirection HTTP`{.action}. ![Configuration d'une Redirection d'un Frontend](images/add_redirectlocation.png){.thumbnail} -Une fois le frontend configuré, cliquez sur `Ajouter`{.action} ou `Modifier`{.action} selon que vous configuriez un nouveau frontend, ou un frontend existant. +Une fois le frontend configuré, cliquez sur `Ajouter`{.action} ou `Modifier`{.action} selon que vous configurez un nouveau frontend, ou un frontend existant. N'oubliez pas de déployer la configuration. Pour ce faire, vous pouvez au choix : -- dans la section `Statut`{.action} de la page d'accueil du Manager, -cliquez sur le bouton `...`{.action} de votre Load Balancer, -et sélectionnez `Appliquer la configuration`{.action} ; +- Dans la section `Statut` de l'onglet `Accueil`{.action}, cliquez sur le bouton `...`{.action} de votre Load Balancer puis cliquez sur `Appliquer la configuration`{.action}. -- dans le bandeau de rappel du Manager vous précisant que la configuration n'est pas appliquée, -cliquez sur `Appliquer la configuration`{.action}. +- Dans le bandeau de rappel vous précisant que la configuration n'est pas appliquée, cliquez sur `Appliquer la configuration`{.action}. ![Application d'une Configuration d'un Load Balancer](images/apply_configuration.png){.thumbnail} -### Ajouter une redirection personnalisée via l'API +### Ajouter une redirection personnalisée depuis l'API OVHcloud -Dans l'[API OVH](/links/api), les Redirections sont spécifiées dans la chaîne de caractère redirectLocation : +Dans l'[API OVHcloud](/links/api), les redirections sont spécifiées dans la chaîne de caractère redirectLocation : -* création d'un nouveau Frontend +**Création d'un nouveau frontend** > [!api] > @@ -92,7 +85,7 @@ Dans l'[API OVH](/links/api), les Redirections sont spécifiées dans la chaîne |zone|Zone de déploiement du frontend| |redirectLocation|URL de redirection HTTP| -* mise à jour d'un Frontend existant +**Mise à jour d'un frontend existant** > [!api] > @@ -102,10 +95,10 @@ Dans l'[API OVH](/links/api), les Redirections sont spécifiées dans la chaîne |Paramètre|Signification| |---|---| |serviceName|Identifiant de votre service Load Balancer| -|frontendId|Identifiant du frontend à metter à jour| +|frontendId|Identifiant du frontend à mettre à jour| |redirectLocation|URL de redirection HTTP| -Puis appliquer les modifications : +**Appliquer les modifications** > [!api] > @@ -119,4 +112,4 @@ Puis appliquer les modifications : ## Aller plus loin -Échangez avec notre [communauté d'utilisateurs](/links/community). +Échangez avec notre [communauté d'utilisateurs](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_redirectlocation/guide.fr-fr.md b/pages/network/load_balancer/create_redirectlocation/guide.fr-fr.md index dbaa2bf8b4f..a5818f1a59e 100644 --- a/pages/network/load_balancer/create_redirectlocation/guide.fr-fr.md +++ b/pages/network/load_balancer/create_redirectlocation/guide.fr-fr.md @@ -1,18 +1,20 @@ --- title: "Configuration d'un service OVHcloud Load Balancer avec les redirections" excerpt: Intégrez vos services web derrière un Load Balancer avec les redirections -updated: 2022-03-28 +updated: 2025-11-27 --- ## Objectif -Le service OVHcloud Load Balancer agit par défaut comme un mandataire ou « Proxy ». Il peut aussi être configuré pour rediriger vos clients vers un site tiers, par exemple dans le cas d'un changement de nom de domaine ou pour rediriger vos clients en HTTPS. C'est que l'on appelle la redirection HTTP. +Le **Load Balancer OVHcloud** fonctionne par défaut comme un proxy, un intermédiaire entre le trafic client et vos serveurs backend. Il peut également être configuré pour rediriger le trafic client vers un site web tiers. Cette fonctionnalité est essentielle pour des scénarios tels que la **migration de nom de domaine** ou l'application de la **version HTTPS** d'un site web. On parle alors de **redirection HTTP**. + +**Ce guide décrit le processus d'intégration de vos services web derrière un Load Balancer OVHcloud utilisant des redirections HTTP.** ## Prérequis - Posséder une offre [OVHcloud Load balancer](/links/network/load-balancer) dans votre compte OVHcloud. -- Être connecté à votre [espace client OVHcloud](/links/manager). -- Être connecté à l'[API OVHcloud](/links/api). +- Avoir accès à votre [espace client OVHcloud](/links/manager). +- Avoir accès à l'[API OVHcloud](/links/api). ## En pratique @@ -27,13 +29,13 @@ Content-Type: text/html Content-Length: 174 ``` -Les Rrdirections personnalisées doivent être de la forme `:///;?#`. Il n'est possible de spécifier qu'une seule redirection par frontend. +Les redirections personnalisées doivent utiliser le format `:///;?#`. Il n'est possible de spécifier qu'une seule redirection par frontend. Les redirections personnalisées peuvent être spécifiées via l'espace client ou via l'API, tant sur un nouveau frontend qu'un existant. ### Ajouter une redirection personnalisée depuis l'espace client OVHcloud -Il est possible de définir une redirection personnalisée depuis l'[espace client OVHcloud](/links/manager) dans la partie `Bare Metal Cloud`{.action} puis `Load Balancer`{.action}. +Il est possible de définir une redirection personnalisée depuis l'[espace client OVHcloud](/links/manager), dans la partie `Bare Metal Cloud`{.action} puis `Load Balancer`{.action}. Cela peut-être effectué tant sur un nouveau frontend pendant sa création, que sur un frontend existant. #### Ajout d'un nouveau frontend @@ -48,7 +50,7 @@ Dans les paramètres avancés, renseignez la `Redirection HTTP`{.action}. #### Édition d'un frontend existant Dans la section `Frontends`{.action}, cliquez que le bouton `...`{.action} à droite du frontend concerné et sélectionnez `Modifier`{.action}.
-Assurez vous que le frontend choisi soit bien de protocole `HTTP` ou `HTTPS`. Complétez la configuration si besoin. +Assurez vous que le frontend choisi utilise bien le protocole `HTTP` ou `HTTPS`. Complétez la configuration si besoin. Il est cependant inutile de préciser la `Ferme par défaut`{.action}, celle-ci ne sera pas utilisée. Dans les paramètres avancés, renseignez la `Redirection HTTP`{.action}. @@ -59,9 +61,9 @@ Une fois le frontend configuré, cliquez sur `Ajouter`{.action} ou `Modifier`{.a N'oubliez pas de déployer la configuration. Pour ce faire, vous pouvez au choix : -- dans la section `Statut` de l'onglet `Accueil`{.action}, cliquez sur le bouton `...`{.action} de votre Load Balancer puis cliquez sur `Appliquer la configuration`{.action}. +- Dans la section `Statut` de l'onglet `Accueil`{.action}, cliquez sur le bouton `...`{.action} de votre Load Balancer puis cliquez sur `Appliquer la configuration`{.action}. -- dans le bandeau de rappel vous précisant que la configuration n'est pas appliquée, cliquez sur `Appliquer la configuration`{.action}. +- Dans le bandeau de rappel vous précisant que la configuration n'est pas appliquée, cliquez sur `Appliquer la configuration`{.action}. ![Application d'une Configuration d'un Load Balancer](images/apply_configuration.png){.thumbnail} @@ -69,7 +71,7 @@ Pour ce faire, vous pouvez au choix : Dans l'[API OVHcloud](/links/api), les redirections sont spécifiées dans la chaîne de caractère redirectLocation : -#### Création d'un nouveau frontend +**Création d'un nouveau frontend** > [!api] > @@ -83,7 +85,7 @@ Dans l'[API OVHcloud](/links/api), les redirections sont spécifiées dans la ch |zone|Zone de déploiement du frontend| |redirectLocation|URL de redirection HTTP| -#### Mise à jour d'un frontend existant +**Mise à jour d'un frontend existant** > [!api] > @@ -96,7 +98,7 @@ Dans l'[API OVHcloud](/links/api), les redirections sont spécifiées dans la ch |frontendId|Identifiant du frontend à mettre à jour| |redirectLocation|URL de redirection HTTP| -#### Appliquer les modifications : +**Appliquer les modifications** > [!api] > @@ -110,4 +112,4 @@ Dans l'[API OVHcloud](/links/api), les redirections sont spécifiées dans la ch ## Aller plus loin -Échangez avec notre [communauté d'utilisateurs](/links/community). +Échangez avec notre [communauté d'utilisateurs](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_route/guide.en-asia.md b/pages/network/load_balancer/create_route/guide.en-asia.md index cb18ec7ebc2..efe77c2df9f 100644 --- a/pages/network/load_balancer/create_route/guide.en-asia.md +++ b/pages/network/load_balancer/create_route/guide.en-asia.md @@ -1,875 +1,880 @@ --- -title: 'Working with HTTP routes' -excerpt: 'Find out how to direct your requests dynamically, to a specific farm' -updated: 2018-04-09 +title: "Configuring an OVHcloud Load Balancer with HTTP routes" +excerpt: "Find out how to dynamically direct your requests to a specific farm" +updated: 2025-11-27 --- ## Objective -The OVH Load Balancer service redirects the front-end’s incoming traffic to the servers that make up the front-end’s default farm, or its default redirection. +The OVHcloud Load Balancer service redirects the front-end’s incoming traffic to the servers that make up the front-end’s default farm, or its default redirection. -In some cases, you can go a step further and route, redirect or block traffic according to a range of criteria. For example, in the case of a HTTP(S) service, you can filter traffic depending on the HTTP method, the URL, and even a cookie or header value! In the OVH Load Balancer service, these are called `routes`{.action}. A route is a particular action to carry out if one or more conditions are met. +In some cases, you can go further and route, redirect, or block traffic according to a range of criteria. For example, in the case of an HTTP(S) service, you can filter traffic based on the HTTP method, the URL, or even the value of a cookie or header. -**This guide will show you how to direct your requests dynamically, to a specific farm.** +In the OVHcloud Load Balancer service, these elements are called **routes**. A route is a specific action to perform if one or more conditions are met. + +**This guide will show you how to direct your requests dynamically to a specific farm using routes.** ## Requirements -- an [OVH Load Balancer](https://www.ovh.com/asia/solutions/load-balancer/) on a solution that lets you create routes -- access to the [OVH API](/links/api) +- Have an [OVHcloud Load Balancer](/links/network/load-balancer) on an offer allowing the creation of routes. +- Have access to the [OVHcloud API](/links/api). ## Instructions > [!primary] > -> Although this guide focuses on HTTP routes, the same principle applies to TCP (with TCP routes). This can be used to direct HTTP/2 traffic to a particular farm, or reject incoming requests from certain IPs. -> +> Although this guide focuses on **HTTP routes**, the same principle applies to **TCP routes**. This can be useful for directing HTTP/2 traffic to a specific farm or rejecting incoming requests from certain IP addresses. +> -Since this feature is still very new, it is only available in the API. This guide will explain the general principles behind routing, and provide practical examples of routes being used. +This feature is only available via the API. This guide will present the general principles as well as use cases for routes drawn from real-life scenarios. -- **An introduction to routes**. +### Introduction to routes -A route controls traffic according to different criteria. You can express these criteria as rules, conditions, or actions. +A route is used to control traffic according to different criteria. They can be expressed in the form of **rules**, **conditions**, or **actions**. -For example, *IF* the URL _starts_ with '/wp-admin/' (1) *AND* the connection _is_ in HTTP (2) *THEN* _redirect_ to the HTTPS version of the page (3). +For example, *IF* the URL _starts with_ '/wp-admin/' (1) *AND* the connection _is_ HTTP (2) *THEN* _redirect_ to the HTTPS version of the page (3). -In this example, there are two rules: +In this example, there are two rules : -- the connection must come from a HTTP front-end (2) -- its URL must begin with the WordPress admin pages (1) +- the connection must come from an HTTP frontend (2); +- its URL must start with the WordPress administration pages (1). There is an action associated with these rules: redirect to the HTTPS version of the page (3). -This is what is known as an ‘end action’. It means that if the rules are confirmed, the evaluation of routes stops, and the action is executed. +This is what is known as an "end action". That means if the rules are validated, the evaluation of the routes stops and the action is executed. -## An introduction to the API. +### API presentation -You can only manage routes via the [OVH API](/links/api). It is only valid for `http`{.action} and `tcp`{.action} protocols, and the `/ipLoadbalancing/{serviceName}/{protocol}/route/`{.action} pathway exposes the API dedicated to routes. +Route management is only available through the [OVHcloud API](/links/api). It is only valid for the **http** and **tcp** protocols, and the path `/ipLoadbalancing/{serviceName}/{protocol}/route/`{.action} exposes the dedicated route API. -The API for routes to the OVH Load Balancer is specially designed for flexibility, power and scalability. It is organised around three main sections: +The OVHcloud Load Balancer service route API has been specifically designed to be flexible, powerful, and scalable. It is organized around three main sections: -1. the APIs listing available rules and actions -2. the APIs listing the routes configured on the OVH Load Balancer service -3. the APIs for configuring routes on the OVH Load Balancer service +1. API calls listing the available rules and actions. +2. API calls listing the routes configured on your OVHcloud Load Balancer service. +3. API calls for configuring the routes of your OVHcloud Load Balancer service. > [!primary] > -> To only show the APIs linked to routes in the OVH API console, you can use the `filter`{.action} field with ‘route’ as a keyword. -> +> To display only the API calls related to routes in the OVHcloud API console, you can use the `filter`{.action} field with the keyword "[a-z]*". +> -When you want to configure a route or rules, the first thing you need to do is look at the available actions and rules. This will give you the possible values for the API route and rule configuration fields. +When you want to configure a route or rules, the first thing to do is to consult the **available actions and rules**. This will give you the possible values for the configuration fields of the route and rule APIs. - A route can have several rules. -- A route can only be attached to a single front-end. -- A front-end can have several routes. In this case, the order of evaluation depends on its type and weight. +- A route can only be attached to a single frontend. +- A frontend can have several routes. In this case, the evaluation order depends on its type and weight. -When a request arrives at your OVH Load Balancer service, the routes are evaluated successively following the principles below: +When a request arrives on your OVHcloud Load Balancer service, the routes are evaluated successively according to the following principles: -1. firstly, reject and rewrite routes, then the farm routes -1. within categories, the routes are evaluated in order of ascending weight -1. if two routes are the same weight, the first route created is evaluated first -1. only the first action from all the validated rules is executed +1. first, the **reject and rewrite routes**, then the **farm routes**; +2. within these categories, the routes are evaluated in **increasing weight order**; +3. if two routes have the same weight, the **first route created** is evaluated first; +4. only the **first action** of all validated rules is executed. -### Available rules and actions. +### Available rules and actions -This first section of the API contains an updated list of actions and rules available for the OVH Load Balancer service. It contains a call for actions, and another for rules. These two calls return a list of objects. Each object has a name, and if it applies to all TCP or HTTP routes as well as the values or value types expected for different fields of the API. If a field is “null”, this means that no value is expected. If an invalid value is entered, the API will return a validation error. +This first section of the API contains an up-to-date list of available actions and rules for your OVHcloud Load Balancer service. It contains one call for the actions and another for the rules. These two calls return a list of objects. Each object is named, and indicates whether it applies to TCP or HTTP routes, as well as the expected values or types of values for the different fields of the API. If a field is "null", it means no value is expected. If an invalid value is provided, the API will return a validation error. #### Actions > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteActions -> +> -For more information on this call, please read the [Available actions](#available-actions){.internal} section at the bottom of this guide. +For more information on this call, we invite you to consult the section [Available Actions](#available-actions), at the bottom of this guide. -#### Rules: +#### Rules > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteRules -> +> -For more information on this call, please read the [Available rules](#available-rules){.internal} section at the bottom of this guide. +For more information on this call, we invite you to consult the section [Available Rules](#available-rules), at the bottom of this guide. -### Configured routes. +### Configured routes -This section of the API only contains one call. It was mainly designed to help implement auto-complete systems. It returns the ID, name and type of each defined route. You can get a route’s details with a GET /ipLoadbalancing/{serviceName}/route/{type}/{routeId} call, defined further below. +This second section of the API contains only one call. It was mainly designed to facilitate the implementation of auto-completion mechanisms. It returns the identifier, name, and type of each defined route. The details of a route can be obtained with a `GET /ipLoadbalancing/{serviceName}/route/{type}/{routeId}` call defined below. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/definedRoutes -> +> -For more information on this call, please read the [Edit routes](#edit-routes){.internal} section at the bottom of this guide. +For more information on this call, we invite you to consult the section " [Route Handling](#handling-routes) ", at the bottom of this guide. -### Route configuration. +### Route configuration -With these basic principles around the action and rules available, and the order in which routes are evaluated, these routes can be edited the same way as the farms can. When you create a route, you can attach rules to it. The possible values for rules and actions are defined by the API calls. +With these basic principles on available actions and rules, and the route evaluation order, these routes can be manipulated in the same way as farms. When you create a route, you can attach rules to it. The possible values for the rules and actions are defined by the API calls. -For more information on these calls, please read the [Edit routes](#edit-routes){.internal} section at the bottom of this guide. +For more information on these methods, you can consult the section " [Route Handling](#handling-routes) ", at the bottom of this guide. ## Examples -If you still have doubts about the power of routes, this should change your mind. The purpose of this section is to offer some practical examples of how this technology has been used for OVH’s internal requirements, without going into great detail about API calls. +To demonstrate the utility of routes, this section will offer some practical examples of the use of this technology for OVHcloud's internal needs, without going into the details of the API calls. -You can read about API calls in more detail in the [Edit routes](#edit-routes){.internal} section at the bottom of this guide, and the sections that follow it. +You will find the details of the API calls in the section [Route Handling](#handling-routes), at the bottom of this guide and the following sections. -### Force HTTPS for WordPress login pages. +### Force HTTPS for WordPress login pages -HTTPS protocol has become the norm. Its purpose is to make all websites available securely in HTTPS, with the SSL/TLS protocol. If you need an SSL/TLS certificate, you can use the OVH Load Balancer service to order a new one, which will be automatically managed for you. +The HTTPS protocol has become the norm. Its objective is to make all websites available in HTTPS in a secure manner, thanks to the SSL/TLS protocol. If you need an SSL/TLS certificate, you can use your OVHcloud Load Balancer service to order a new one, which will be managed for you in a completely automatic way. -Migrating a website to HTTPS involves a lot of work, especially to avoid [mixed content](https://developer.mozilla.org/en-us/docs/Web/Security/Mixed_content). It may be worth migrating your website section by section, and starting by securing pages that send login credentials. +Migrating a website to HTTPS requires work, especially to avoid [Mixed-Content](https://developer.mozilla.org/en-us/docs/Web/Security/Mixed_content) problems. It may be interesting to migrate your website section by section, starting by securing the pages that send login credentials. -One approach could be to base it on the beginning of WordPress URLs. By default, the URL the login pages for WordPress start with "/wp-login". So we would need: +An approach could be to rely on the beginning of WordPress URLs. By default, the URLs of WordPress login pages start with "/wp-login". We would therefore need to: -- a route with a redirect action -- a rule in this route that detects URLs starting with "/wp-login" +- a route with a **redirection action**; +- a rule in this route that detects URLs starting with **"/wp-login"**. -In practice, this gives a route like this: +In practice, this gives a route as follows: -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|frontendId|Your HTTP front-end ID| -|displayName|“Redirection of WordPress logins to HTTPS”| -|weight|(empty)| -|action.type|"redirect"| -|action.status|302 for a temporary redirection, 301 for a permanent redirection| -|action.target|"`https://${host}${path}${arguments}`" to take the same host, path and arguments| +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| frontendId | Identifier of your HTTP frontend | +| displayName | "Redirect WordPress connections to HTTPS" | +| weight | (empty) | +| action.type | "redirect" | +| action.status | 302 for a temporary redirect, 301 for a permanent redirect | +| action.target | "`https://\${host}\${path}\${arguments}`" to take the same host, path and arguments | On this route, we will attach a rule: -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|routeId|Route ID created above| -|field|"uri"| -|subField|(empty)| -|match|"startswith"| -|negate|false| -|pattern|"/wp-login"| +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| routeId | Identifier of the route created above | +| field | "uri" | +| subField | (empty) | +| match | "startswith" | +| negate | false | +| pattern | "/wp-login" | -Next, apply the configuration to the zone concerned, and the rule will begin to work. +Then apply the configuration to the concerned area. > [!warning] > -> To add a new redirection, you will need to repeat these actions again, creating a route, then a rule. If a second rule is added to the same route, the two rules need to be validated for the redirect to work. Note that if the rules are "startswith /wp-login" and "startswith /wp-admin", the redirection would never work because these two conditions cannot both be true at once. -> +> To add a new redirection, you will have to repeat these actions, creating a route, then a rule. If a second rule is added to the same route, both rules must be validated for the redirection to work. Note that if the rules are `startswith /wp-login` and `startswith /wp-admin`, the redirection will never work because these two conditions cannot be true at the same time. +> -### Route according to a domain (vhost) +### Route based on a domain (VHost) -This feature helped propel the expansion of the web at its very early stages, by exposing several websites behind a single IP address using the “host” field of HTTP headers. +This is the feature that made the web possible when it was in its infancy, with the possibility of exposing several sites behind the same IP address thanks to the "Host" field of HTTP headers. -For example, if your infrastructure is made up of a VPS for your website, an OVH Load Balancer to ensure SSL/TLS termination, and redirection to a maintenance page with a backup server in the farms, you would originally have needed one Additional IP per website, routed to your OVH Load Balancer, and one front-end per IP. +For example, if your infrastructure is composed of a VPS for your website, an OVHcloud Load Balancer for SSL/TLS termination, and redirections to a maintenance page with a backup server in the farms, you would have needed an Additional IP per website, routed to your OVHcloud Load Balancer, and a frontend per IP in the past. -With routes, you can share the same front-end, and choose the server farm dynamically, with the “host” field. +With routes, you can share the same frontend and choose the server farm dynamically, thanks to the *[a-z]* field. -To do this, you will need: +For this, you will need: -- one route per vhost -- one rule per route detecting a specific domain +- a route per VHost; +- a rule per route detecting a specific domain. -In practice, to route the domain www.example.com, this would give the following route: +In practice, to route the domain **www.example.com**, this will give the following route: -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|frontendId|Your front-end ID| -|displayName|"VHost - www.example.com"| -|weight|(empty)| -|action.type|"farm"| -|action.status|(empty)| -|action.target|ID of the farm to direct this domain to| +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| frontendId | Identifier of your frontend | +| displayName | "VHost - www.example.com" | +| weight | (empty) | +| action.type | "farm" | +| action.status | (empty) | +| action.target | Identifier of the farm to which to direct this domain | And on this route, we will attach a rule: -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|routeId|Route ID created above| -|field|"host"| -|subField|(empty)| -|match|"is"| -|negate|false| -|pattern|"www.example.com" or a domain of your choice| +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| routeId | Identifier of the route created above | +| field | "host" | +| subField | (empty) | +| match | "is" | +| negate | false | +| pattern | "www.example.com" or a domain of your choice | Finally, apply the configuration. -### Reserve an Additional IP to a particular website. +### Reserve an Additional IP for a specific website -If you are hosting a website on a VPS, you may want to dedicate an IP address to a specific customer. You can easily make the IP available by routing it to your OVH Load Balancer service, then configuring a dedicated front-end attached to this Additional IP address, and having the customer’s target VPS set as a defaultFarmId. +If you host a website on a VPS, you might want to dedicate an IP address to a specific client. You can easily make the IP available by routing it to your OVHcloud Load Balancer service, then configuring a dedicated frontend attached to this Additional IP, and setting the client's target VPS as the `defaultFarmId`. -But what will happen if another customer detects this, and configures their domain to point to the premium customer’s IP address? By default, this will work, and its website will be routed to the other VPS. If there is an SSL/TLS certificate, it will still work as all of the certificates are automatically available for all of the front-ends. +However, what will happen if another client detects this and configures their domain to point to the premium client's IP? By default, this will work, and their website will be routed to another client's VPS. If an SSL/TLS certificate is present, this will still work, as all certificates are automatically available for all frontends. -In such scenarios, the solution is to add a rule that will reject requests if the domain is not a premium one. You can do this with a rejection route and a rule. +In such scenarios, the solution is to add a rule that **rejects requests if the domain is not a premium domain**. You can do this with a reject route and a rule. -In practice, to reserve a front-end with an IP dedicated to the domain www.example.com, this will give the following route: +In practice, to reserve a frontend with a dedicated IP for the domain **www.example.com**, this will give the following route: -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|frontendId|Your front-end ID| -|displayName|"Restrict to www.example.com"| -|weight|(empty)| -|action.type|"reject"| -|action.status|403| -|action.target|(empty)| +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| frontendId | Identifier of your frontend | +| displayName | "Restriction to www.example.com" | +| weight | (empty) | +| action.type | "reject" | +| action.status | 403 | +| action.target | (empty) | And on this route, we will attach a rule: -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|routeId|Route ID created above| -|field|"host"| -|subField|(empty)| -|match|"is"| -|negate|true| -|pattern|"www.example.com" or a domain of your choice| +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| routeId | Identifier of the route created above | +| field | "host" | +| subField | (empty) | +| match | "is" | +| negate | true | +| pattern | "www.example.com" or a domain of your choice | Finally, apply the configuration. -### Route depending on a URL and HTTP method. +### Route based on a URL and an HTTP method -On some specific infrastructures, certain requests need to be routed to a specific farm. For example, to manage rare but data-intensive requests without impacting production, such as analytical requests that would work from a read-only duplicate of the data with a server that has a higher volume of memory. +On some specific infrastructures, certain requests must be routed to a specific farm. For example, to handle rare but data-intensive requests without impacting production, such as analytical requests that work on a read-only copy of the data with a server having a higher memory volume. If, for example, the request is sent: -- with the POST method -- on a URL corresponding to "^/.\*/batch-analytics$" +- with the **POST** method; +- on a URL matching **"^/.*/batch-analytics$"**. -... you would need a route with two rules, with one rule using a regular expression. +Then, you would need a route with two rules, one of which uses a regular expression. -In practice, this gives a route like this: +In practice, this gives a route as follows: -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|frontendId|Your front-end ID| -|displayName|"Route batch analytics to dedicated farm"| -|weight|(empty)| -|action.type|"farm"| -|action.status|(empty)| -|action.target|ID of the farm to direct these operations to| +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| frontendId | Identifier of your frontend | +| displayName | "Route batch analytics to a dedicated farm" | +| weight | (empty) | +| action.type | "farm" | +| action.status | (empty) | +| action.target | Identifier of the farm to which to direct these operations | And on this route, we will attach two rules: -|Field|Rule 1|Rule 2| -|---|---|---| -|serviceName|Your OVH Load Balancer service ID|as per rule 1| -|routeId|Route ID created above|as per rule 1| -|field|"method"|"uri"| -|subField|(empty)|(empty)| -|match|"is"|"matches"| -|negate|false|false| -|pattern|"POST"|"^/.\*/batch-analytics$"| +| Field | Rule 1 | Rule 2 | +| :--- | :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | as for rule 1 | +| routeId | Identifier of the route created above | as for rule 1 | +| field | "method" | "uri" | +| subField | (empty) | (empty) | +| match | "is" | "matches" | +| negate | false | false | +| pattern | "POST" | "`^/.*/batch-analytics$`" | + +Here, the first rule applies to an enumeration. Only standard HTTP methods are available. The second rule, on the other hand, exploits the full power of routes by using a regular expression. Although it is possible to use such expressions, avoiding them results in enhanced performance. -Here, the first rule applies on a list. Only standard HTTP methods are available. However, the second rule uses all the power of routes using a regular expression. Although it is possible to use expressions like this, if you can go without using them, your performance will be even higher. +All that remains is to apply the configuration in the concerned area. -Next, apply the configuration to the zone concerned. +#### Route certain IPs and voluntary clients to preproduction -### Route certain IPs and voluntary clients to a pre-production environment. +When a site grows, you may want to set up a preproduction environment to validate ongoing changes, without affecting the majority of users. Generally, when configuring this type of environment, you want to reduce the gap as much as possible between production and preproduction, in order to detect problems as accurately as possible. A classic and often neglected source of problems is the domain name. It is sometimes hardcoded in a file or an article. At that point, a link may work in preproduction but not in production. -When your website gains momentum, you may want to set up a pre-production environment, which you can use to check ongoing developments without affecting the majority of your users. Generally, when you configure an environment like this, it is best to minimise the differences between production and pre-production as much as possible, so that any issues can be detected as accurately as possible. A common but often-forgotten issue is the domain name, as it is sometimes hard-coded into a file or item. If this is the case, the link may work in pre-production, but not in production. +Instead of setting up rules based on the domain name, you could set up rules based on the source IP address (for example, an enterprise proxy) and possibly a cookie for voluntary clients. These configurations can be detected with two routes on your OVHcloud Load Balancer service. -Instead of setting up rules based on the domain name, you can set up rules based on the source IP (e.g. an enterprise proxy), and possibly a cookie for voluntary clients. These configurations can be detected with two routes on the OVH Load Balancer service. +For this example, we will consider: -For this example, we will consider that: +- that the enterprise proxy can use the addresses 42.42.42.0/24 and the VPN uses 1.2.3.4/32; +- that the voluntary users have a "PreprodOptIn" cookie, the value of which is not important. -- the enterprise proxy can use the addresses 42.42.42.0/24, and that the VPN uses 1.2.3.4/32 -- the voluntary users have a "PreprodOptIn" cookie — it doesn’t matter what the value is +In practice, you will need two identical routes: -In practice, we would need two identical routes: +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| frontendId | Identifier of your frontend | +| displayName | "Route Opt-In and internal users to preproduction environment" | +| weight | (empty) | +| action.type | "farm" | +| action.status | (empty) | +| action.target | Identifier of the preproduction farm | -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|frontendId|Your front-end ID| -|displayName|"Route Opt-In and internal users to pre-production environment"| -|weight|(empty)| -|action.type|"farm"| -|action.status|(empty)| -|action.target|Your pre-production farm’s ID| +Next, we attach the following 2 rules, each on one of the routes (1 rule per route): -Then we will attach the following two rules to each of the routes (one rule per route): +| Field | Rule 1 | Rule 2 | +| :--- | :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | same | +| routeId | Identifier of the first route | Identifier of the second route | +| field | "source" | "cookie" | +| subField | (empty) | "PreprodOptIn" | +| match | "in" | "exists" | +| negate | false | false | +| pattern | "42.42.42.0/24, 1.2.3.4" | (empty) | -|Field|Rule 1|Rule 2| -|---|---|---| -|serviceName|Your OVH Load Balancer service ID|as per rule 1| -|routeId|ID of the first route|ID of the second route| -|field|"source"|"cookie"| -|subField|(empty)|"PreprodOptIn"| -|match|"in"|"exists"| -|negate|false|false| -|pattern|"42.42.42.0/24, 1.2.3.4"|(empty)| +The first rule checks if the source IP is in a list of address ranges. In this case, the different address ranges are separated by commas and can be surrounded by spaces for better readability. If a range contains only one address, the "/32" is implicit but can be added explicitly. In any case, the size of this field is limited to 255 characters. -The first rule tests whether the source IP is in the address range list. In this case, the various address ranges are separated by commas, and can have spaces in between one another to make them easier to read. If the range only contains one address, the "/32" is implicit, but can be added explicitly. Either way, this field is limited to 255 characters. +The second rule simply checks the existence of the cookie. It would be possible to check if its value matches a regular expression or is in a list of possibilities, but this allows to show a simple example of what can be done with cookies. Rules based on HTTP Headers work according to a similar approach. -The second rule simply tests to see if a cookie exists. It is also possible to test if the value corresponds to a regular expression, or is found in a possibility list, but this offers a simple example of what you can do with cookies. Rules based on HTTP headers work using a similar approach. +All that remains is to apply the configuration in the concerned area. -Next, apply the configuration to the zone concerned. +#### Route WebSockets to a dedicated farm -### Route WebSockets to a dedicated farm. +When a site has interactive functions based on WebSockets such as a chatbot, you may want to direct these connections to a server farm dedicated to this task. In fact, it is quite simple.W -When a website has interactive features based on WebSockets — a chatbot, for example — you may want to direct these connections to a server farm dedicated to this task. This is actually quite simple. When a browser attempts to open a WebSockets connection, it sends a standard HTTP request with these headers: +When a browser tries to open a WebSocket connection, it sends a standard HTTP request with the headers: ``` Upgrade: websocket Connection: Upgrade ``` -In this case, only the first header needs to be detected. This can be done very easily with a route and a rule: +In practice, it is sufficient to detect the first header. This can be done very easily with a route and a rule: -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|frontendId|Your front-end ID| -|displayName|"Route WebSockets to a dedicated farm"| -|weight|(empty)| -|action.type|"farm"| -|action.status|(empty)| -|action.target|ID of the farm dedicated to WebSockets| +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| frontendId | Identifier of your frontend | +| displayName | "Route WebSockets to a dedicated farm" | +| weight | (empty) | +| action.type | "farm" | +| action.status | (empty) | +| action.target | Identifier of the WebSocket dedicated farm | -And on this route, we will attach a rule: +And on this route, we come to attach a rule: + +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| routeId | Identifier of the route created just above | +| field | "header" | +| subField | "Upgrade" | +| match | "is" | +| negate | false | +| pattern | "websocket" (case-sensitive) | -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|routeId|Route ID created above| -|field|"header"| -|subField|"Upgrade"| -|match|"is"| -|negate|false| -|pattern|"websocket" (case-sensitive)| +All that remains is to apply the configuration in the relevant zone. -Next, apply the configuration to the zone concerned. -## Reference. +### References -Here, you will find more details on the API calls linked to the routes. To get a general idea of how routes work, we recommend starting off by reading the [introduction to the API](#an-introduction-to-the-api){.internal} section further up. +You will find here the details of the API calls related to routes. For a more general overview of route features, we invite you to first consult the section " [API presentation](#apipresentation) " a little further up in this guide. -### Edit routes. +#### Handling routes -TCP and HTTP routes are configured the same way. Since the routes are more powerful in HTTP, this section focuses on HTTP rules and routes. TCP routes can be extrapolated from the information below by replacing “http” with “tcp” in each route. Some fields only apply to HTTP routes, and are not available in TCP. +TCP and HTTP routes are configured in the same way. Since HTTP routes are more powerful, this section focuses on HTTP routes and rules. The operation of TCP routes can be extrapolated by replacing "http" with "tcp" in the routes. Some fields only make sense in HTTP, so they are not available in TCP. -#### List the routes. +##### **List routes** -This call returns the list of ID numbers of routes defined for HTTP protocol. You can filter this list by frontendId. This call returns the routes in the order in which they will be evaluated. The evaluation order can be partially controlled by the weight of the route. +This call returns the list of numeric identifiers of routes defined for the HTTP protocol. You can filter this list by `frontendId`. This call returns the routes in the order in which they will be evaluated. The evaluation order can be partially controlled using the "weight" of the route. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route -> +> -|Setting|Required|Meaning| -|---|---|---| -|serviceName|Required|Your Load Balancer service ID| -|frontendId||ID number of a HTTP front-end the routes are attached to| +| Parameter | Required | Meaning | +| :--- | :--- | :--- | +| serviceName | Required | Identifier of your Load Balancer service | +| frontendId | | Numeric identifier of an HTTP frontend to which the routes are attached | -#### Create a route. +##### **Create a route** -With this call, you can create a route. Only the action is mandatory. A route can be attached to and detached from a front-end. You can create up to 50 routes on an OVH Load Balancer. This call returns the route created, if it is successful. You will need to re-deploy your OVH Load Balancer to apply the changes. +This call allows you to create a route. Only the action is mandatory. A route can be attached and detached from a frontend. It is possible to create up to 50 routes on an OVHcloud Load Balancer service. This call returns the created route in case of success. Your OVHcloud Load Balancer service must be redeployed to apply the changes. > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route -> +> -|Setting|Required|Meaning| -|---|---|---| -|serviceName|Required|Your Load Balancer service ID| -|displayName||Display name for your route (255 characters maximum)| -|frontendId||ID number of a HTTP front-end to attach the route to| -|weight||Route priority, between 1 (carry out first) and 255 (carry out after the others)| -|action.type|Required|Name of the action type to execute if all of the rules associated with the route are validated| -|action.status||HTTP status code for `reject` and `redirect` actions| -|action.target||ID number of the target farm for `farm` actions, or the URL template for `redirect` actions| +| Parameter | Required | Meaning | +| :--- | :--- | :--- | +| serviceName | Required | Identifier of your Load Balancer service | +| displayName | | Display name of your route (maximum 255 characters) | +| frontendId | | Numeric identifier of an HTTP frontend to which to attach the route | +| weight | | Priority of the route, between 1 (passes first) and 255 (passes after others) | +| action.type | Required | Name of the type of action to execute if all the rules associated with the route are validated | +| action.status | | HTTP status code for the `reject` and `redirect` actions | +| action.target | | Numeric identifier of the target farm for the `farm` actions, or URL pattern for the `redirect` actions | -The possible action types are listed below: +The possible action types are: -|action|Meaning| -|---|---| -|redirect|Redirects a request to `action.target`, with the HTTP `action.status` code| -|reject|Rejects a request with the HTTP `action.status` code| -|farm|Routes a request to the farm with the ID entered in `action.target`| +| action | Meaning | +| :--- | :--- | +| redirect | Redirect a request to `action.target` with the HTTP status code `action.status` | +| reject | Reject a request with the HTTP status code `action.status` | +| farm | Route a request to the farm whose identifier is specified in `action.target` | -For further information on the actions managed and the format of parameters, please read the [Available actions](#available-actions){.internal} section further down. +For more information on the actions handled and the format of the parameters, we invite you to consult the section " [Available actions](#available-actions) " further down in this guide. -#### View details on a route. +##### **View the details of a route** -With this call, you can view details on an HTTP route if you know its ID. +This call allows you to view the details of an HTTP route, knowing its identifier. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId} -> +> -Query +- Request: -|Setting|Meaning| -|---|---| -|serviceName|Your Load Balancer service ID| -|routeId|The route’s ID number| +| Parameter | Meaning | +| :--- | :--- | +| serviceName | Identifier of your Load Balancer service | +| routeId | Numeric identifier of the route | -Answer +- Response: -|Setting|Meaning| -|---|---| -|routeId|The route’s ID number| -|displayName|The display name for your route| -|frontendId|ID number of the front-end your route is attached to| -|weight|Priority of your route| -|action.type|Name of the action type for your route| -|action.status|Associated HTTP status code| -|action.target|ID number of the associated farm or URL template| -|rules|List of rules that must be validated to trigger the route’s action More detail on this is available in the [Edit rules](#edit-rules){.internal} section.| +| Parameter | Meaning | +| :--- | :--- | +| routeId | Numeric identifier of the route | +| displayName | Display name of your route | +| frontendId | Numeric identifier of the frontend to which your route is attached | +| weight | Priority of your route | +| action.type | Name of the type of action of your route | +| action.status | Associated HTTP status code | +| action.target | Numeric identifier of the farm or associated URL pattern | +| rules | List of rules that must be validated to trigger the action of the route. More details are available in the section " [Handling Rules](#handling-rules) ". | -For further information on the actions managed and the format of parameters, please read the [Available actions](#available-actions){.internal} section further down. +For more information on the actions handled and the format of the parameters, we invite you to consult the section "[Available actions](#available-actions)" further down in this guide. -#### Modify a route. +##### **Modify a route** -With this call, you can modify an HTTP route if you know its ID. You will need to re-deploy your OVH Load Balancer to apply the changes. +This call allows you to modify an HTTP route, knowing its identifier. Your OVHcloud Load Balancer service must be redeployed to apply the changes. > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId} > -|Setting|Required|Meaning| -|---|---|---| -|serviceName|Required|Your Load Balancer service ID| -|routeId|Required|The route’s ID number| -|displayName||Display name for your route (255 characters maximum)| -|frontendId||ID number of a HTTP front-end to attach the route to| -|weight||Route priority, between 1 (carry out first) and 255 (carry out after the others)| -|action.type|Required|Name of the action type to execute if all of the rules associated with the route are validated| -|action.status||HTTP status code for `reject` and `redirect` actions| -|action.target||ID number of the target farm for `farm` actions, or the URL template for `redirect` actions| +| Parameter | Required | Meaning | +| :--- | :--- | :--- | +| serviceName | Required | Identifier of your Load Balancer service | +| routeId | Required | Numeric identifier of the route | +| displayName | | Display name of your route (maximum 255 characters) | +| frontendId | | Numeric identifier of an HTTP frontend to which to attach the route | +| weight | | Priority of the route, between 1 (passes first) and 255 (passes after others) | +| action.type | Required | Name of the type of action to execute if all the rules associated with the route are validated | +| action.status | | HTTP status code for the `reject` and `redirect` actions | +| action.target | | Numeric identifier of the target farm for the `farm` actions, or URL pattern for the `redirect` actions | -For further information on the actions managed and the format of parameters, please read the [Available actions](#available-actions){.internal} section further down. +For more information on the actions handled and the format of the parameters, we invite you to consult the section " [Available actions](#available-actions) " further down in this guide. -#### Delete a route. +##### **Delete a route** -With this call, you can delete an HTTP route if you know its ID. When a route is deleted, all of the rules associated with the route are deleted, too. You do not need to delete them individually. You will need to re-deploy your OVH Load Balancer to apply the changes. +This call allows you to delete an HTTP route, knowing its identifier. When a route is deleted, all the rules associated with that route are also deleted. There is no need to delete them individually. Your OVHcloud Load Balancer service must be redeployed to apply the changes. > [!api] > > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId} -> +> -|Setting|Required|Meaning| -|---|---|---| -|serviceName|Required|Your Load Balancer service ID| -|routeId|Required|The route’s ID number| +| Parameter | Required | Meaning | +| :--- | :--- | :--- | +| serviceName | Required | Identifier of your Load Balancer service | +| routeId | Required | Numeric identifier of the route | -### Edit rules. +#### Handling rules -#### List the rules. +##### **List rules** -This call returns the list of ID numbers of rules defined for a particular route. +This call returns the list of numeric identifiers of rules defined for a given route. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule -> +> -|Setting|Required|Meaning| -|---|---|---| -|serviceName|Required|Your Load Balancer service ID| -|routeId|Required|The route’s ID number| +| Parameter | Required | Meaning | +| :--- | :--- | :--- | +| serviceName | Required | Identifier of your Load Balancer service | +| routeId | Required | Numeric identifier of the route | -#### Attach a rule. +##### **Attach a rule** -With this call, you can attach a rule to a route. You can attach up to 5 rules per route on an OVH Load Balancer. This call returns the route created, if it is successful. You will need to re-deploy your OVH Load Balancer to apply the changes. +This call allows you to attach a rule to a route. It is possible to attach up to 5 rules per route on an OVHcloud Load Balancer service. This call returns the created rule in case of success. Your OVHcloud Load Balancer service must be redeployed to apply the changes. > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule -> - -|Setting|Required|Meaning| -|---|---|---| -|serviceName|Required|Your Load Balancer service ID| -|routeId|Required|The route’s ID number| -|field|Required|The name of the HTTP parameter to apply the rule to| -|subField||HTTP header name for the `header` rules, or cookie name for `cookie` rules| -|match|Required|Name of the comparison to apply to validate the rule| -|negate||Reverses the comparison result| -|pattern||Comparison pattern| - -`field` - -|Value|Meaning| -|---|---| -|source|The address or list of source IP addresses (a.b.c.d/z)| -|protocol|Protocol (“http” or “https”)| -|method|HTTP method (GET, HEAD, POST, PUT, DELETE, OPTIONS, CONNECT, TRACE)| -|host|Domain name (vhost), without the port number| -|uri|Path of the request as it appears between the first "/" and the last "?"| -|param|HTTP parameter contained in the part after the first "?"| -|header|HTTP header| -|cookie|HTTP cookie| - -`match` - -|Value|Meaning| -|---|---| -|exists|The property must exist (e.g. HTTP header or cookie)| -|-|The property must correspond exactly to a `pattern`| -|in|The property must be in the list of values (separated by commas) defined by `pattern`| -|contains|The property must contain the `pattern` value| -|startswith|The property must start with the `pattern` value| -|endswith|The property must end with the `pattern` value| -|matches|The property must match the regular `pattern` expression| - -For further information on the rules managed and the format of parameters, please read the [Available rules](#available-rules){.internal} section further down. - -#### View details on a rule. - -With this call instruction, you can view the details on a rule attached to an HTTP route if you know its ID. +> + +| Parameter | Required | Meaning | +| :--- | :--- | :--- | +| serviceName | Required | Identifier of your Load Balancer service | +| routeId | Required | Numeric identifier of the route | +| field | Required | Name of the HTTP parameter on which to apply this rule | +| subField | | Name of the HTTP header for `header` rules or name of the cookie for `cookie` rules | +| match | Required | Name of the comparator to apply to validate the rule | +| negate | | Inverts the result of the comparator | +| pattern | | Comparator argument | + +- `field` + +| Value | Meaning | +| :--- | :--- | +| source | Address or list of source addresses in the form of IP (a.b.c.d/z) | +| protocol | Protocol. "http" or "https" | +| method | HTTP method (GET, HEAD, POST, PUT, DELETE, OPTIONS, CONNECT, TRACE) | +| host | Domain name (vhost), without the port number | +| uri | Request path as understood between the first "/" and the first "?" | +| param | HTTP parameter coming from the part after the first "?" | +| header | HTTP header | +| cookie | HTTP cookie | + +- `match` + +| Value | Meaning | +| :--- | :--- | +| exists | The property must exist (HTTP header or cookie for example) | +| is | The property must match exactly `pattern` | +| in | The property must be in the list of values (separated by commas) defined by `pattern` | +| contains | The property must contain the value of `pattern` | +| startswith | The property must start with the value of `pattern` | +| endswith | The property must end with the value of `pattern` | +| matches | The property must match the regular expression of `pattern` | + +For more information on the rules handled and the format of the parameters, we invite you to consult the section " [Available rules](#available-rules) " further down in this guide. + +##### **View the details of a rule** + +This call allows you to view the details of a rule attached to an HTTP route, knowing its identifier. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId} -> +> -Query +- Request: -|Setting|Meaning| -|---|---| -|serviceName|Your Load Balancer service ID| -|routeId|The route’s ID number| -|ruleId|The rule’s ID number| +| Parameter | Meaning | +| :--- | :--- | +| serviceName | Identifier of your Load Balancer service | +| routeId | Numeric identifier of the route | +| ruleId | Numeric identifier of the rule | -Answer +- Response: -|Setting|Meaning| -|---|---| -|ruleId|The rule’s ID number| -|field|Name of the HTTP parameter to apply the rule on| -|subField|Name of the HTTP header or cookie for the rule| -|match|Name of the comparison to apply to validate the rule| -|negate|"true" if the comparison result is reversed| -|pattern|Comparison argument. The direction and syntax depends on the `match` and the `field`.| +| Parameter | Meaning | +| :--- | :--- | +| ruleId | Numeric identifier of the rule | +| field | Name of the HTTP parameter on which to apply the rule | +| subField | Name of the HTTP header or cookie for the rule | +| match | Name of the comparator to apply to validate the rule | +| negate | "true" if the result of the comparator is inverted | +| pattern | Comparator argument. The meaning and syntax depend on `match` and `field` | -For further information on the rules managed and the format of parameters, please read the [Available rules](#available-rules){.internal} section further down. +For more information on the rules handled and the format of the parameters, we invite you to consult the section " [Available rules](#available-rules) " further down in this guide. -#### Modify a rule. +##### **Modify a rule** -With this call, you can modify a rule attached to an HTTP route if you know its ID. You will need to re-deploy your OVH Load Balancer to apply the changes. +This call allows you to modify a rule attached to an HTTP route, knowing its identifier. Your OVHcloud Load Balancer service must be redeployed to apply the changes. > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId} -> +> -|Setting|Required|Meaning| -|---|---|---| -|serviceName|Required|Your Load Balancer service ID| -|routeId|Required|The route’s ID number| -|ruleId|Required|The rule’s ID number| -|field|Required|The name of the HTTP parameter to apply the rule to| -|subField||HTTP header name for the `header` rules, or cookie name for `cookie` rules| -|match|Required|Name of the comparison to apply to validate the rule| -|negate||Reverses the comparison result| -|pattern||Comparison pattern| +| Parameter | Required | Meaning | +| :--- | :--- | :--- | +| serviceName | Required | Identifier of your Load Balancer service | +| routeId | Required | Numeric identifier of the route | +| ruleId | Required | Numeric identifier of the rule | +| field | Required | Name of the HTTP parameter on which to apply this rule | +| subField | | Name of the HTTP header for `header` rules or name of the cookie for `cookie` rules | +| match | Required | Name of the comparator to apply to validate the rule | +| negate | | Inverts the result of the comparator | +| pattern | | Comparator argument | -For further information on the rules managed and the format of parameters, please read the [Available rules](#available-rules){.internal} section further down. +For more information on the rules handled and the format of the parameters, we invite you to consult the section " [Available rules](#available-rules) " further down in this guide. -#### Delete a rule. +##### **Delete a rule** -With this call, you can delete a rule attached to an HTTP route if you know its ID. You will need to re-deploy your OVH Load Balancer to apply the changes. +This call allows you to delete a rule attached to an HTTP route, knowing its identifier. Your OVHcloud Load Balancer service must be redeployed to apply the changes. > [!api] > > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId} -> +> -|Setting|Required|Meaning| -|---|---|---| -|serviceName|Required|Your Load Balancer service ID| -|routeId|Required|The route’s ID number| -|ruleId|Required|The rule’s ID number| +| Parameter | Required | Meaning | +| :--- | :--- | :--- | +| serviceName | Required | Identifier of your Load Balancer service | +| routeId | Required | Numeric identifier of the route | +| ruleId | Required | Numeric identifier of the rule | > [!primary] > -> If you want to delete a route, you do not need to delete all the rules attached to it. The rules are automatically deleted when you delete the route. -> +> If you want to delete a route, it is not necessary to delete all the rules attached to it. The rules are automatically deleted when you delete a route. +> -#### List all of the TCP and HTTP routes. +##### **List all TCP and HTTP routes** -With this call, you can get a list of all the IDs, display names and types ("http"/"tcp") of routes defined on an OVH Load Balancer service. It is designed to simplify the implementation of auto-completion. +This call allows you to list all the identifiers, display names and types ("http"/"tcp") of routes defined on an OVHcloud Load Balancer service. It was designed to simplify the implementation of auto-completion. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/definedRoutes -> +> -Query +- Request: -|Setting|Meaning| -|---|---| -|serviceName|Your Load Balancer service ID| +| Parameter | Meaning | +| :--- | :--- | +| serviceName | Identifier of your Load Balancer service | -Answer +- Response: -|Setting|Meaning| -|---|---| -|type|Type of protocol for the route: "tcp" for TCP routes, "http" for HTTP routes| -|routeId|The route’s ID number| -|displayName|The display name of the route| +| Parameter | Meaning | +| :--- | :--- | +| type | Type of protocol of the route: "tcp" for TCP routes, "http" for HTTP routes | +| routeId | Numeric identifier of the route | +| displayName | Display name of the route | -### Actions available +#### Available actions -This call returns the list of actions available for TCP and HTTP routes, as well as the values expected for each of the fields. +This call returns the list of available actions for TCP and HTTP routes as well as the expected values for each of the fields. -If a field is “null”, this means that no value is expected. If an invalid value is entered, the API will return a validation error. +If a field is "null", it means that no value is expected. If an invalid value is provided, the API will return a validation error. -All of the actions managed by the OVH Load Balancer service are final. This means that executing an action also triggers the end of route evaluation. +All actions managed by the OVHcloud Load Balancer service are final. This means that the execution of an action also ends the evaluation of the routes. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteActions -> +> -Query +- Request: -|Setting|Meaning| -|---|---| -|serviceName|Your Load Balancer service ID| +| Parameter | Meaning | +| :--- | :--- | +| serviceName | Identifier of your Load Balancer service | -Answer +- Response: -|Setting|Meaning| -|---|---| -|type|Shows if this action is valid for a HTTP or a TCP route| -|name|Name of the action to enter into the `type` field of routes| -|status|List of HTTP status codes available for this action (`status` fields of routes)| -|destination|Value type expected in the `destination` fields for routes| +| Parameter | Meaning | +| :--- | :--- | +| type | Indicates whether this action is valid for an HTTP route or a TCP route | +| name | Name of the action to specify in the `type` field of the routes | +| status | List of available HTTP status codes for this action (the `status` field of the routes) | +| destination | Type of value expected in the `destination` field of the routes | -#### Redirection +##### **Redirection** -This action sends a redirection to the visitor. This redirection type can be configured with the status field. When this action is selected, no farms will receive the request. +This action returns a redirection to the visitor. The type of redirection can be configured with the `status` field. When this action is selected, no farm will receive the request. -|Setting|Value| -|---|---| -|type|`redirect`| -|status|301, 302, 303, 307 or 308| -|target|Target URL (may contain variables)| +| Parameter | Value | +| :--- | :--- | +| type | `redirect` | +| status | 301, 302, 303, 307 or 308 | +| target | Destination URL (can contain variables) | -Only the HTTP redirection status codes can be specified. The most common codes are 301 and 302. If you have any doubts, you can set up a 302 (temporary redirection). The HTTP status codes for redirections are: +Only HTTP redirection status codes can be specified. The most common are codes 301 and 302. If you are unsure, you can use the 302 "Temporary Redirect". The HTTP status codes recognized for redirections are: -|Status code|Description| -|---|---| -|301|Permanent redirection. The redirection can be saved by the browser.| -|302 (default)|Temporary redirection. The redirection must be revalidated for each request by the browser.| -|303|Works like a 302, and forces the use of the HTTP GET method.| -|307|Works like a 302, and forces the same HTTP method to be reused (GET, POST, etc.).| -|308|Works like a 301, and forces the same HTTP method to be reused (GET, POST, etc.).| +| Status code | Description | +| :--- | :--- | +| 301 | Permanent redirect. The redirect can be stored by the browser. | +| 302 (default) | Temporary redirect. The redirect must be revalidated by the browser on each request. | +| 303 | Like 302 and forces the use of the HTTP GET method. | +| 307 | Like 302 and forces the reuse of the same HTTP method (GET, POST, etc.). | +| 308 | Like 301 and forces the reuse of the same HTTP method (GET, POST, etc.). | -The target URL may contain simple variables. This helps users redirect to another domain, another protocol or add a suffix/prefix to a URL. The recognised variables are: +The destination URL can contain simple variables. This allows you to redirect to another domain, another protocol or add a suffix / prefix to a URL. The recognized variables are: -|Variable|Description| -|---|---| -|`protocol`|Protocol of the request ("http" or "https")| -|`domain`|Domain name of the request, without the port number| -|`host`|"Host" field of the request, including the port number, if there is one| -|`port`|Port of the request| -|`path`|Path of the request, starts with a '/' and ends before the first '?'| -|`arguments`|Arguments of the request, starts with a '?' if present| +| Variable | Description | +| :--- | :--- | +| `protocol` | Protocol of the request ("http" or "https") | +| `domain` | Domain name of the request, without the port number | +| `host` | "Host" field of the request, including the port number if present | +| `port` | Port of the request | +| `path` | Path of the request, starts with a '/' and ends at the first '?' | +| `arguments` | Arguments of the request, starts with a '?' if present | -For example, for: +For example, to: -- redirect to https: `https://${host}${path}${arguments}` -- redirect to a new domain: ${protocol}://new.example.com${path}${arguments} -- prefix the URL: ${protocol}://${host}/staging${path}${arguments} +- redirect to https: `https://\${host}\${path}\${arguments}` +- redirect to a new domain: `${protocol}://new.example.com\${path}\${arguments}` +- prefix the URL: `${protocol}://\${host}/staging\${path}\${arguments}` -#### Reject. +##### **Rejection** -This action returns an HTTP error status code to the visitor. The HTTP error code can be configured with the status field. When this action is selected, no farms will receive the request. +This action returns an HTTP error status code to the visitor. The error HTTP status code can be configured with the `status` field. When this action is selected, no farm will receive the request. -|Setting|Value| -|---|---| -|type|`reject`| -|status|200, 400, 403, 405, 408, 429, 500, 502, 503 or 504| -|target|not available| +| Parameter | Value | +| :--- | :--- | +| type | `reject` | +| status | 200, 400, 403, 405, 408, 429, 500, 502, 503 or 504 | +| target | not available | > [!primary] > -> This action is also available in TCP. In this case, the parameter status is not available, and the request is terminated. TCP requests that are terminated like this are not compatible with high percentages of requests. -> +> This action is also available in TCP. In this case, the `status` parameter is not available and the request is terminated. TCP requests terminated in this way are not counted in the request rate. +> -Only the HTTP error codes listed in the API can be specified. The most common ones are 400 ("Bad request") errors, and 403 ("Forbidden") errors. A 200 code can be used to block a request type while simulating a success, and a 503 code can be used to simulate a server outage. +Only the HTTP error status codes listed in the API can be specified. The most common are the codes 400 "Bad request" and 403 "Forbidden". 200 can be used to block a type of request while simulating a success, and 503 can be used to simulate a server failure. -|Status code|Description| -|---|---| -|200|The request has been successfully executed.| -|400|Invalid request.| -|403 (default)|Access forbidden.| -|405|Method (GET, POST, PUT, ...) invalid or not managed.| -|408|The request has taken too long to be sent by the client.| -|429|The client has sent too many requests (rate limiting).| -|500|Generic server error.| -|502|Error communicating with the server.| -|503|The service is temporarily unavailable.| -|504|The server has taken too much time to respond.| +| Status code | Description | +| :--- | :--- | +| 200 | The request was executed successfully. | +| 400 | Invalid request. | +| 403 (default) | Access forbidden. | +| 405 | Invalid or unhandled method (GET, POST, PUT, etc.) +| 408 | The client failed to send a complete request within the server's time limit. | +| 429 | The client sent too many requests (rate-limiting). | +| 500 | Generic server error. | +| 502 | Communication error with the server. | +| 503 | The service is temporarily unavailable. | +| 504 | The server took too long to respond. | -#### Routing. +##### **Routing** -This action redirects requests to a specific farm, other than the default farm configured on the front-end. The destination farm must be the same type as the front-end ("http" or "tcp"). +This action directs requests to a specific farm, other than the default farm configured on the frontend. The target farm must be of the same type as the frontend ("http" or "tcp"). -|Setting|Value| -|---|---| -|type|`farm`| -|status|not available| -|target|The destination farm’s ID number. This must be the same type.| +| Parameter | Value | +| :--- | :--- | +| type | `farm` | +| status | not available | +| target | Numeric identifier of the target farm. This must be of the same type | > [!primary] > -> This action is also available in TCP. In this case, the destination farm type must be "tcp". -> +> This action is also available in TCP. In this case, the target farm must be of type "tcp". +> -### Available rules. +#### Available rules -This call returns the list of rules available for TCP and HTTP routes, as well as the values expected for each of the fields. +This call returns the list of available rules for TCP and HTTP routes, as well as the expected values for each field. -If a field is “null”, this means that no value is expected. If an invalid value is entered, the API will return a validation error. +If a field is "null", it means no value is expected. If an invalid value is provided, the API will return a validation error. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteRules -> +> -Query +- Request: -|Setting|Meaning| -|---|---| -|serviceName|Your Load Balancer service ID| +| Parameter | Meaning | +| :--- | :--- | +| serviceName | Identifier of your Load Balancer service | -Answer +- Response: -|Setting|Meaning| -|---|---| -|type|Type of protocol for the route: "tcp" for TCP routes, "http" for HTTP routes| -|name|Name of the property on which to apply this rule, to be entered into the `field` field| -|hasSubField|"true" is this property is a sub-property (e.g. a header or cookie)| -|matches|List of comparisons available for each rule, to be entered into the `match` field| -|pattern|Type of value expected for the `pattern` field| -|enum|List of values for the chmaps `pattern`, if it is a list| +| Parameter | Meaning | +| :--- | :--- | +| type | Protocol type of the route: "tcp" for TCP routes, "http" for HTTP routes | +| name | Name of the property to which this rule applies, to be filled in the `field` field | +| hasSubField | "true" if this property has a "sub-property" (e.g.: a header or a cookie) | +| matches | List of available comparators for this rule, to be filled in the `match` field | +| pattern | Type of expected value for the `pattern` field | +| enum | List of possible values for the `pattern` field if it is an enumeration | -The different `pattern` types are: +The different types of `pattern` are: -|Value|Meaning| -|---|---| -|cidr|IP address (a.b.c.d) or sub-network (a.b.c.d/z)| -|string|Free text. For the `in` operator, a list of values separated by columns (255 characters maximum)| -|enum|The field is a list defined in `enum`| +| Value | Meaning | +| :--- | :--- | +| cidr | IP address (a.b.c.d) or subnet (a.b.c.d/z) | +| string | Free text. For the operator `in`, a list of comma-separated values (maximum 255 characters) | +| enum | The field is an enumeration defined in `enum` | -#### Protocol. +##### **Protocol** -With this rule, you can filter requests depending on their protocol. In practice, the uses for this rule are quite limited, as the protocol depends on the front-end that the route is attached to, or a front-end that only manages a single protocol recognised the moment the route is defined. +This rule allows filtering requests based on their protocol. In practice, the use cases for this rule are quite limited because the protocol depends on the frontend to which the route is attached, and a frontend only handles one protocol, which is known at the time the route is defined. -|Fields|Value| -|---|---| -|name|`protocol`| -|hasSubField|no| -|matches|`is` or `in`| -|pattern|`tcp`, `tls`, `http` or `https`| +| Field | Value | +| :--- | :--- | +| name | `protocol` | +| hasSubField | no | +| matches | `is` or `in` | +| pattern | `tcp`, `tls`, `http` or `https` | > [!primary] > -> This action is also available in TCP. In this case, "http/2.0" protocol is also available. It is based on the "ALPN" SSL/TLS field used by browsers to announce that they are attempting to establish a HTTP/2.0 connection. This way, you can have a common TCP front-end for SSL/TLS termination of HTTP 1 and 2, then direct traffic depending on the protocol version. -> +> This action is also available in TCP. In this case, the "http/2.0" protocol is also available. It is based on the SSL/TLS "ALPN" field used by browsers to announce that they are trying to establish an HTTP/2.0 connection. This allows for a common TCP frontend for HTTP 1 and 2 SSL/TLS termination, then routing these streams based on the protocol version. +> -#### Source address. +##### **Source address** -With this rule, you can filter requests depending on their source address. By combining it with a rule based on the URI or the domain name, you can restrict certain resources to an enterprise proxy while exposing all of your other resources without restrictions, via your OVH Load Balancer. +This rule allows filtering requests based on their source address. By combining it with a rule based on the URI or domain name, it is for example possible to restrict certain resources to an enterprise proxy, while exposing all other resources without restrictions on your OVHcloud Load Balancer service. -|Fields|Value| -|---|---| -|name|`source`| -|hasSubField|no| -|matches|`is` or `in`| -|pattern|Sub-network (a.b.c.d/z) or address (a.b.c.d)| +| Field | Value | +| :--- | :--- | +| name | `source` | +| hasSubField | no | +| matches | `is` or `in` | +| pattern | Subnet (a.b.c.d/z) or address (a.b.c.d) | > [!primary] > -> This action is also available in TCP using the same method. -> +> This action is also available in TCP with the same behavior. +> -To block a particular network and address, for example, you can use a pattern like "4.4.0.0/16, 8.8.8.8". +For example, to block a network and a specific address, you can use a pattern such as "4.4.0.0/16, 8.8.8.8". -#### Domain name. +##### **Domain name** -With this rule, you can filter requests depending on their domain name. In doing so, you can reproduce the Apache "vhost" feature, or route all of the domains that start with "mail." to a server dedicated to webmail. +This rule allows filtering requests based on their domain name. This can for example be used to reproduce the "vhost" function of Apache or to route all domains starting with "mail." to a server dedicated to webmail. -|Fields|Value| -|---|---| -|name|`host`| -|hasSubField|no| -|matches|`is`, `in`, `contains`, `startswith`, `endswith` or `matches`| -|pattern|Character chain or regular expression| +| Field | Value | +| :--- | :--- | +| name | `host` | +| hasSubField | no | +| matches | `is`, `in`, `contains`, `startswith`, `endswith` or `matches` | +| pattern | String or regular expression | > [!primary] > -> This action is also available in TCP. It will only work if the front-end is configured to accept SSL/TLS connections, and if the client sends an "SNI" option. This is especially the case with recent web browsers. -> +> This action is also available in TCP. It is only applicable if the frontend is configured to accept SSL/TLS connections and the client sends an "SNI" option. This is particularly the case for recent web browsers. +> -#### HTTP method. +##### **HTTP method** -With this rule, you can filter requests depending on their HTTP method. It is commonly used alongside a rule based the request URI or path, to make the rule more selective. +This rule allows filtering requests based on the HTTP method. It is commonly used in conjunction with a rule based on the request URI or path to make the rule more selective. -|Fields|Value| -|---|---| -|name|`method`| -|hasSubField|no| -|matches|`is` or `in`| -|pattern|`GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS` or `TRACE`| +| Field | Value | +| :--- | :--- | +| name | `method` | +| hasSubField | no | +| matches | `is` or `in` | +| pattern | `GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS` or `TRACE` | -#### Request path. +##### **Request path** -With this rule, you can filter requests depending on their path, or URI. The request path is between the first '/' (inclusive) and the first '?' (excluded). +This rule allows filtering requests based on the request path or URI. The request path is the part between the first '/' included and the first '?' excluded. -|Fields|Value| -|---|---| -|name|`uri`| -|hasSubField|no| -|matches|`is`, `in`, `contains`, `startswith`, `endswith` or `matches`| -|pattern|Character chain or regular expression| +| Field | Value | +| :--- | :--- | +| name | `uri` | +| hasSubField | no | +| matches | `is`, `in`, `contains`, `startswith`, `endswith` or `matches` | +| pattern | String or regular expression | -#### Request parameter. +##### **Request parameter** -This rule filters requests depending on their existence, or the value of a specific HTTP request parameter. This is the part after the first '?'. If a parameter is specified several times in a request, only the first instance is taken into account. +This rule allows filtering requests based on the existence or value of a specific HTTP request parameter. This is the part after the first '?'. If a parameter is specified multiple times in the request, only the first one is taken into account. -|Fields|Value| -|---|---| -|name|`param`| -|hasSubField|yes| -|matches|`is`, `in`, `contains`, `startswith`, `endswith` or `matches`| -|pattern|Character chain or regular expression| +| Field | Value | +| :--- | :--- | +| name | `param` | +| hasSubField | yes | +| matches | `is`, `in`, `contains`, `startswith`, `endswith` or `matches` | +| pattern | String or regular expression | -#### HTTP header. +##### **HTTP header** -This rule filters requests depending on their existence, or the value of a specific HTTP header value. You can use it to detect the opening of a WebSocket connection, and direct it to a dedicated server farm. +This rule allows filtering requests based on the existence or value of a specific HTTP header. This can for example be used to detect the opening of a websocket connection and route it to a dedicated farm. -|Fields|Value| -|---|---| -|name|`header`| -|hasSubField|yes| -|matches|`is`, `in`, `contains`, `startswith`, `endswith` or `matches`| -|pattern|Character chain or regular expression| +| Field | Value | +| :--- | :--- | +| name | `header` | +| hasSubField | yes | +| matches | `is`, `in`, `contains`, `startswith`, `endswith` or `matches` | +| pattern | String or regular expression | -#### Cookie. +##### **Cookie** -With this rule, you can filter requests depending on the existence or value of a specific HTTP cookie. You can use it to direct voluntary visitors to a pre-production farm. +This rule allows filtering requests based on the existence or value of a specific HTTP cookie. This can for example be used to direct opt-in visitors to a pre-production farm. -|Fields|Value| -|---|---| -|name|`cookie`| -|hasSubField|yes| -|matches|`is`, `in`, `contains`, `startswith`, `endswith` or `matches`| -|pattern|Character chain or regular expression| +| Field | Value | +| :--- | :--- | +| name | `cookie` | +| hasSubField | yes | +| matches | `is`, `in`, `contains`, `startswith`, `endswith` or `matches` | +| pattern | String or regular expression | ## Go further -Join our community of users on . +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_route/guide.en-au.md b/pages/network/load_balancer/create_route/guide.en-au.md index 3cbe31f9b34..efe77c2df9f 100644 --- a/pages/network/load_balancer/create_route/guide.en-au.md +++ b/pages/network/load_balancer/create_route/guide.en-au.md @@ -1,875 +1,880 @@ --- -title: 'Working with HTTP routes' -excerpt: 'Find out how to direct your requests dynamically, to a specific farm' -updated: 2018-04-09 +title: "Configuring an OVHcloud Load Balancer with HTTP routes" +excerpt: "Find out how to dynamically direct your requests to a specific farm" +updated: 2025-11-27 --- ## Objective -The OVH Load Balancer service redirects the front-end’s incoming traffic to the servers that make up the front-end’s default farm, or its default redirection. +The OVHcloud Load Balancer service redirects the front-end’s incoming traffic to the servers that make up the front-end’s default farm, or its default redirection. -In some cases, you can go a step further and route, redirect or block traffic according to a range of criteria. For example, in the case of a HTTP(S) service, you can filter traffic depending on the HTTP method, the URL, and even a cookie or header value! In the OVH Load Balancer service, these are called `routes`{.action}. A route is a particular action to carry out if one or more conditions are met. +In some cases, you can go further and route, redirect, or block traffic according to a range of criteria. For example, in the case of an HTTP(S) service, you can filter traffic based on the HTTP method, the URL, or even the value of a cookie or header. -**This guide will show you how to direct your requests dynamically, to a specific farm.** +In the OVHcloud Load Balancer service, these elements are called **routes**. A route is a specific action to perform if one or more conditions are met. + +**This guide will show you how to direct your requests dynamically to a specific farm using routes.** ## Requirements -- an [OVH Load Balancer](https://www.ovh.com.au/solutions/load-balancer/) on a solution that lets you create routes -- access to the [OVH API](/links/api) +- Have an [OVHcloud Load Balancer](/links/network/load-balancer) on an offer allowing the creation of routes. +- Have access to the [OVHcloud API](/links/api). ## Instructions > [!primary] > -> Although this guide focuses on HTTP routes, the same principle applies to TCP (with TCP routes). This can be used to direct HTTP/2 traffic to a particular farm, or reject incoming requests from certain IPs. -> +> Although this guide focuses on **HTTP routes**, the same principle applies to **TCP routes**. This can be useful for directing HTTP/2 traffic to a specific farm or rejecting incoming requests from certain IP addresses. +> -Since this feature is still very new, it is only available in the API. This guide will explain the general principles behind routing, and provide practical examples of routes being used. +This feature is only available via the API. This guide will present the general principles as well as use cases for routes drawn from real-life scenarios. -- **An introduction to routes**. +### Introduction to routes -A route controls traffic according to different criteria. You can express these criteria as rules, conditions, or actions. +A route is used to control traffic according to different criteria. They can be expressed in the form of **rules**, **conditions**, or **actions**. -For example, *IF* the URL _starts_ with '/wp-admin/' (1) *AND* the connection _is_ in HTTP (2) *THEN* _redirect_ to the HTTPS version of the page (3). +For example, *IF* the URL _starts with_ '/wp-admin/' (1) *AND* the connection _is_ HTTP (2) *THEN* _redirect_ to the HTTPS version of the page (3). -In this example, there are two rules: +In this example, there are two rules : -- the connection must come from a HTTP front-end (2) -- its URL must begin with the WordPress admin pages (1) +- the connection must come from an HTTP frontend (2); +- its URL must start with the WordPress administration pages (1). There is an action associated with these rules: redirect to the HTTPS version of the page (3). -This is what is known as an ‘end action’. It means that if the rules are confirmed, the evaluation of routes stops, and the action is executed. +This is what is known as an "end action". That means if the rules are validated, the evaluation of the routes stops and the action is executed. -## An introduction to the API. +### API presentation -You can only manage routes via the [OVH API](/links/api). It is only valid for `http`{.action} and `tcp`{.action} protocols, and the `/ipLoadbalancing/{serviceName}/{protocol}/route/`{.action} pathway exposes the API dedicated to routes. +Route management is only available through the [OVHcloud API](/links/api). It is only valid for the **http** and **tcp** protocols, and the path `/ipLoadbalancing/{serviceName}/{protocol}/route/`{.action} exposes the dedicated route API. -The API for routes to the OVH Load Balancer is specially designed for flexibility, power and scalability. It is organised around three main sections: +The OVHcloud Load Balancer service route API has been specifically designed to be flexible, powerful, and scalable. It is organized around three main sections: -1. the APIs listing available rules and actions -2. the APIs listing the routes configured on the OVH Load Balancer service -3. the APIs for configuring routes on the OVH Load Balancer service +1. API calls listing the available rules and actions. +2. API calls listing the routes configured on your OVHcloud Load Balancer service. +3. API calls for configuring the routes of your OVHcloud Load Balancer service. > [!primary] > -> To only show the APIs linked to routes in the OVH API console, you can use the `filter`{.action} field with ‘route’ as a keyword. -> +> To display only the API calls related to routes in the OVHcloud API console, you can use the `filter`{.action} field with the keyword "[a-z]*". +> -When you want to configure a route or rules, the first thing you need to do is look at the available actions and rules. This will give you the possible values for the API route and rule configuration fields. +When you want to configure a route or rules, the first thing to do is to consult the **available actions and rules**. This will give you the possible values for the configuration fields of the route and rule APIs. - A route can have several rules. -- A route can only be attached to a single front-end. -- A front-end can have several routes. In this case, the order of evaluation depends on its type and weight. +- A route can only be attached to a single frontend. +- A frontend can have several routes. In this case, the evaluation order depends on its type and weight. -When a request arrives at your OVH Load Balancer service, the routes are evaluated successively following the principles below: +When a request arrives on your OVHcloud Load Balancer service, the routes are evaluated successively according to the following principles: -1. firstly, reject and rewrite routes, then the farm routes -1. within categories, the routes are evaluated in order of ascending weight -1. if two routes are the same weight, the first route created is evaluated first -1. only the first action from all the validated rules is executed +1. first, the **reject and rewrite routes**, then the **farm routes**; +2. within these categories, the routes are evaluated in **increasing weight order**; +3. if two routes have the same weight, the **first route created** is evaluated first; +4. only the **first action** of all validated rules is executed. -### Available rules and actions. +### Available rules and actions -This first section of the API contains an updated list of actions and rules available for the OVH Load Balancer service. It contains a call for actions, and another for rules. These two calls return a list of objects. Each object has a name, and if it applies to all TCP or HTTP routes as well as the values or value types expected for different fields of the API. If a field is “null”, this means that no value is expected. If an invalid value is entered, the API will return a validation error. +This first section of the API contains an up-to-date list of available actions and rules for your OVHcloud Load Balancer service. It contains one call for the actions and another for the rules. These two calls return a list of objects. Each object is named, and indicates whether it applies to TCP or HTTP routes, as well as the expected values or types of values for the different fields of the API. If a field is "null", it means no value is expected. If an invalid value is provided, the API will return a validation error. #### Actions > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteActions -> +> -For more information on this call, please read the [Available actions](#available-actions){.internal} section at the bottom of this guide. +For more information on this call, we invite you to consult the section [Available Actions](#available-actions), at the bottom of this guide. -#### Rules: +#### Rules > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteRules -> +> -For more information on this call, please read the [Available rules](#available-rules){.internal} section at the bottom of this guide. +For more information on this call, we invite you to consult the section [Available Rules](#available-rules), at the bottom of this guide. -### Configured routes. +### Configured routes -This section of the API only contains one call. It was mainly designed to help implement auto-complete systems. It returns the ID, name and type of each defined route. You can get a route’s details with a GET /ipLoadbalancing/{serviceName}/route/{type}/{routeId} call, defined further below. +This second section of the API contains only one call. It was mainly designed to facilitate the implementation of auto-completion mechanisms. It returns the identifier, name, and type of each defined route. The details of a route can be obtained with a `GET /ipLoadbalancing/{serviceName}/route/{type}/{routeId}` call defined below. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/definedRoutes -> +> -For more information on this call, please read the [Edit routes](#edit-routes){.internal} section at the bottom of this guide. +For more information on this call, we invite you to consult the section " [Route Handling](#handling-routes) ", at the bottom of this guide. -### Route configuration. +### Route configuration -With these basic principles around the action and rules available, and the order in which routes are evaluated, these routes can be edited the same way as the farms can. When you create a route, you can attach rules to it. The possible values for rules and actions are defined by the API calls. +With these basic principles on available actions and rules, and the route evaluation order, these routes can be manipulated in the same way as farms. When you create a route, you can attach rules to it. The possible values for the rules and actions are defined by the API calls. -For more information on these calls, please read the [Edit routes](#edit-routes){.internal} section at the bottom of this guide. +For more information on these methods, you can consult the section " [Route Handling](#handling-routes) ", at the bottom of this guide. ## Examples -If you still have doubts about the power of routes, this should change your mind. The purpose of this section is to offer some practical examples of how this technology has been used for OVH’s internal requirements, without going into great detail about API calls. +To demonstrate the utility of routes, this section will offer some practical examples of the use of this technology for OVHcloud's internal needs, without going into the details of the API calls. -You can read about API calls in more detail in the [Edit routes](#edit-routes){.internal} section at the bottom of this guide, and the sections that follow it. +You will find the details of the API calls in the section [Route Handling](#handling-routes), at the bottom of this guide and the following sections. -### Force HTTPS for WordPress login pages. +### Force HTTPS for WordPress login pages -HTTPS protocol has become the norm. Its purpose is to make all websites available securely in HTTPS, with the SSL/TLS protocol. If you need an SSL/TLS certificate, you can use the OVH Load Balancer service to order a new one, which will be automatically managed for you. +The HTTPS protocol has become the norm. Its objective is to make all websites available in HTTPS in a secure manner, thanks to the SSL/TLS protocol. If you need an SSL/TLS certificate, you can use your OVHcloud Load Balancer service to order a new one, which will be managed for you in a completely automatic way. -Migrating a website to HTTPS involves a lot of work, especially to avoid [mixed content](https://developer.mozilla.org/en-us/docs/Web/Security/Mixed_content). It may be worth migrating your website section by section, and starting by securing pages that send login credentials. +Migrating a website to HTTPS requires work, especially to avoid [Mixed-Content](https://developer.mozilla.org/en-us/docs/Web/Security/Mixed_content) problems. It may be interesting to migrate your website section by section, starting by securing the pages that send login credentials. -One approach could be to base it on the beginning of WordPress URLs. By default, the URL the login pages for WordPress start with "/wp-login". So we would need: +An approach could be to rely on the beginning of WordPress URLs. By default, the URLs of WordPress login pages start with "/wp-login". We would therefore need to: -- a route with a redirect action -- a rule in this route that detects URLs starting with "/wp-login" +- a route with a **redirection action**; +- a rule in this route that detects URLs starting with **"/wp-login"**. -In practice, this gives a route like this: +In practice, this gives a route as follows: -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|frontendId|Your HTTP front-end ID| -|displayName|“Redirection of WordPress logins to HTTPS”| -|weight|(empty)| -|action.type|"redirect"| -|action.status|302 for a temporary redirection, 301 for a permanent redirection| -|action.target|"`https://${host}${path}${arguments}`" to take the same host, path and arguments| +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| frontendId | Identifier of your HTTP frontend | +| displayName | "Redirect WordPress connections to HTTPS" | +| weight | (empty) | +| action.type | "redirect" | +| action.status | 302 for a temporary redirect, 301 for a permanent redirect | +| action.target | "`https://\${host}\${path}\${arguments}`" to take the same host, path and arguments | On this route, we will attach a rule: -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|routeId|Route ID created above| -|field|"uri"| -|subField|(empty)| -|match|"startswith"| -|negate|false| -|pattern|"/wp-login"| +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| routeId | Identifier of the route created above | +| field | "uri" | +| subField | (empty) | +| match | "startswith" | +| negate | false | +| pattern | "/wp-login" | -Next, apply the configuration to the zone concerned, and the rule will begin to work. +Then apply the configuration to the concerned area. > [!warning] > -> To add a new redirection, you will need to repeat these actions again, creating a route, then a rule. If a second rule is added to the same route, the two rules need to be validated for the redirect to work. Note that if the rules are "startswith /wp-login" and "startswith /wp-admin", the redirection would never work because these two conditions cannot both be true at once. -> +> To add a new redirection, you will have to repeat these actions, creating a route, then a rule. If a second rule is added to the same route, both rules must be validated for the redirection to work. Note that if the rules are `startswith /wp-login` and `startswith /wp-admin`, the redirection will never work because these two conditions cannot be true at the same time. +> -### Route according to a domain (vhost) +### Route based on a domain (VHost) -This feature helped propel the expansion of the web at its very early stages, by exposing several websites behind a single IP address using the “host” field of HTTP headers. +This is the feature that made the web possible when it was in its infancy, with the possibility of exposing several sites behind the same IP address thanks to the "Host" field of HTTP headers. -For example, if your infrastructure is made up of a VPS for your website, an OVH Load Balancer to ensure SSL/TLS termination, and redirection to a maintenance page with a backup server in the farms, you would originally have needed one Additional IP per website, routed to your OVH Load Balancer, and one front-end per IP. +For example, if your infrastructure is composed of a VPS for your website, an OVHcloud Load Balancer for SSL/TLS termination, and redirections to a maintenance page with a backup server in the farms, you would have needed an Additional IP per website, routed to your OVHcloud Load Balancer, and a frontend per IP in the past. -With routes, you can share the same front-end, and choose the server farm dynamically, with the “host” field. +With routes, you can share the same frontend and choose the server farm dynamically, thanks to the *[a-z]* field. -To do this, you will need: +For this, you will need: -- one route per vhost -- one rule per route detecting a specific domain +- a route per VHost; +- a rule per route detecting a specific domain. -In practice, to route the domain www.example.com, this would give the following route: +In practice, to route the domain **www.example.com**, this will give the following route: -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|frontendId|Your front-end ID| -|displayName|"VHost - www.example.com"| -|weight|(empty)| -|action.type|"farm"| -|action.status|(empty)| -|action.target|ID of the farm to direct this domain to| +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| frontendId | Identifier of your frontend | +| displayName | "VHost - www.example.com" | +| weight | (empty) | +| action.type | "farm" | +| action.status | (empty) | +| action.target | Identifier of the farm to which to direct this domain | And on this route, we will attach a rule: -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|routeId|Route ID created above| -|field|"host"| -|subField|(empty)| -|match|"is"| -|negate|false| -|pattern|"www.example.com" or a domain of your choice| +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| routeId | Identifier of the route created above | +| field | "host" | +| subField | (empty) | +| match | "is" | +| negate | false | +| pattern | "www.example.com" or a domain of your choice | Finally, apply the configuration. -### Reserve an Additional IP to a particular website. +### Reserve an Additional IP for a specific website -If you are hosting a website on a VPS, you may want to dedicate an IP address to a specific customer. You can easily make the IP available by routing it to your OVH Load Balancer service, then configuring a dedicated front-end attached to this Additional IP address, and having the customer’s target VPS set as a defaultFarmId. +If you host a website on a VPS, you might want to dedicate an IP address to a specific client. You can easily make the IP available by routing it to your OVHcloud Load Balancer service, then configuring a dedicated frontend attached to this Additional IP, and setting the client's target VPS as the `defaultFarmId`. -But what will happen if another customer detects this, and configures their domain to point to the premium customer’s IP address? By default, this will work, and its website will be routed to the other VPS. If there is an SSL/TLS certificate, it will still work as all of the certificates are automatically available for all of the front-ends. +However, what will happen if another client detects this and configures their domain to point to the premium client's IP? By default, this will work, and their website will be routed to another client's VPS. If an SSL/TLS certificate is present, this will still work, as all certificates are automatically available for all frontends. -In such scenarios, the solution is to add a rule that will reject requests if the domain is not a premium one. You can do this with a rejection route and a rule. +In such scenarios, the solution is to add a rule that **rejects requests if the domain is not a premium domain**. You can do this with a reject route and a rule. -In practice, to reserve a front-end with an IP dedicated to the domain www.example.com, this will give the following route: +In practice, to reserve a frontend with a dedicated IP for the domain **www.example.com**, this will give the following route: -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|frontendId|Your front-end ID| -|displayName|"Restrict to www.example.com"| -|weight|(empty)| -|action.type|"reject"| -|action.status|403| -|action.target|(empty)| +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| frontendId | Identifier of your frontend | +| displayName | "Restriction to www.example.com" | +| weight | (empty) | +| action.type | "reject" | +| action.status | 403 | +| action.target | (empty) | And on this route, we will attach a rule: -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|routeId|Route ID created above| -|field|"host"| -|subField|(empty)| -|match|"is"| -|negate|true| -|pattern|"www.example.com" or a domain of your choice| +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| routeId | Identifier of the route created above | +| field | "host" | +| subField | (empty) | +| match | "is" | +| negate | true | +| pattern | "www.example.com" or a domain of your choice | Finally, apply the configuration. -### Route depending on a URL and HTTP method. +### Route based on a URL and an HTTP method -On some specific infrastructures, certain requests need to be routed to a specific farm. For example, to manage rare but data-intensive requests without impacting production, such as analytical requests that would work from a read-only duplicate of the data with a server that has a higher volume of memory. +On some specific infrastructures, certain requests must be routed to a specific farm. For example, to handle rare but data-intensive requests without impacting production, such as analytical requests that work on a read-only copy of the data with a server having a higher memory volume. If, for example, the request is sent: -- with the POST method -- on a URL corresponding to "^/.\*/batch-analytics$" +- with the **POST** method; +- on a URL matching **"^/.*/batch-analytics$"**. -... you would need a route with two rules, with one rule using a regular expression. +Then, you would need a route with two rules, one of which uses a regular expression. -In practice, this gives a route like this: +In practice, this gives a route as follows: -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|frontendId|Your front-end ID| -|displayName|"Route batch analytics to dedicated farm"| -|weight|(empty)| -|action.type|"farm"| -|action.status|(empty)| -|action.target|ID of the farm to direct these operations to| +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| frontendId | Identifier of your frontend | +| displayName | "Route batch analytics to a dedicated farm" | +| weight | (empty) | +| action.type | "farm" | +| action.status | (empty) | +| action.target | Identifier of the farm to which to direct these operations | And on this route, we will attach two rules: -|Field|Rule 1|Rule 2| -|---|---|---| -|serviceName|Your OVH Load Balancer service ID|as per rule 1| -|routeId|Route ID created above|as per rule 1| -|field|"method"|"uri"| -|subField|(empty)|(empty)| -|match|"is"|"matches"| -|negate|false|false| -|pattern|"POST"|"^/.\*/batch-analytics$"| +| Field | Rule 1 | Rule 2 | +| :--- | :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | as for rule 1 | +| routeId | Identifier of the route created above | as for rule 1 | +| field | "method" | "uri" | +| subField | (empty) | (empty) | +| match | "is" | "matches" | +| negate | false | false | +| pattern | "POST" | "`^/.*/batch-analytics$`" | + +Here, the first rule applies to an enumeration. Only standard HTTP methods are available. The second rule, on the other hand, exploits the full power of routes by using a regular expression. Although it is possible to use such expressions, avoiding them results in enhanced performance. -Here, the first rule applies on a list. Only standard HTTP methods are available. However, the second rule uses all the power of routes using a regular expression. Although it is possible to use expressions like this, if you can go without using them, your performance will be even higher. +All that remains is to apply the configuration in the concerned area. -Next, apply the configuration to the zone concerned. +#### Route certain IPs and voluntary clients to preproduction -### Route certain IPs and voluntary clients to a pre-production environment. +When a site grows, you may want to set up a preproduction environment to validate ongoing changes, without affecting the majority of users. Generally, when configuring this type of environment, you want to reduce the gap as much as possible between production and preproduction, in order to detect problems as accurately as possible. A classic and often neglected source of problems is the domain name. It is sometimes hardcoded in a file or an article. At that point, a link may work in preproduction but not in production. -When your website gains momentum, you may want to set up a pre-production environment, which you can use to check ongoing developments without affecting the majority of your users. Generally, when you configure an environment like this, it is best to minimise the differences between production and pre-production as much as possible, so that any issues can be detected as accurately as possible. A common but often-forgotten issue is the domain name, as it is sometimes hard-coded into a file or item. If this is the case, the link may work in pre-production, but not in production. +Instead of setting up rules based on the domain name, you could set up rules based on the source IP address (for example, an enterprise proxy) and possibly a cookie for voluntary clients. These configurations can be detected with two routes on your OVHcloud Load Balancer service. -Instead of setting up rules based on the domain name, you can set up rules based on the source IP (e.g. an enterprise proxy), and possibly a cookie for voluntary clients. These configurations can be detected with two routes on the OVH Load Balancer service. +For this example, we will consider: -For this example, we will consider that: +- that the enterprise proxy can use the addresses 42.42.42.0/24 and the VPN uses 1.2.3.4/32; +- that the voluntary users have a "PreprodOptIn" cookie, the value of which is not important. -- the enterprise proxy can use the addresses 42.42.42.0/24, and that the VPN uses 1.2.3.4/32 -- the voluntary users have a "PreprodOptIn" cookie — it doesn’t matter what the value is +In practice, you will need two identical routes: -In practice, we would need two identical routes: +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| frontendId | Identifier of your frontend | +| displayName | "Route Opt-In and internal users to preproduction environment" | +| weight | (empty) | +| action.type | "farm" | +| action.status | (empty) | +| action.target | Identifier of the preproduction farm | -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|frontendId|Your front-end ID| -|displayName|"Route Opt-In and internal users to pre-production environment"| -|weight|(empty)| -|action.type|"farm"| -|action.status|(empty)| -|action.target|Your pre-production farm’s ID| +Next, we attach the following 2 rules, each on one of the routes (1 rule per route): -Then we will attach the following two rules to each of the routes (one rule per route): +| Field | Rule 1 | Rule 2 | +| :--- | :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | same | +| routeId | Identifier of the first route | Identifier of the second route | +| field | "source" | "cookie" | +| subField | (empty) | "PreprodOptIn" | +| match | "in" | "exists" | +| negate | false | false | +| pattern | "42.42.42.0/24, 1.2.3.4" | (empty) | -|Field|Rule 1|Rule 2| -|---|---|---| -|serviceName|Your OVH Load Balancer service ID|as per rule 1| -|routeId|ID of the first route|ID of the second route| -|field|"source"|"cookie"| -|subField|(empty)|"PreprodOptIn"| -|match|"in"|"exists"| -|negate|false|false| -|pattern|"42.42.42.0/24, 1.2.3.4"|(empty)| +The first rule checks if the source IP is in a list of address ranges. In this case, the different address ranges are separated by commas and can be surrounded by spaces for better readability. If a range contains only one address, the "/32" is implicit but can be added explicitly. In any case, the size of this field is limited to 255 characters. -The first rule tests whether the source IP is in the address range list. In this case, the various address ranges are separated by commas, and can have spaces in between one another to make them easier to read. If the range only contains one address, the "/32" is implicit, but can be added explicitly. Either way, this field is limited to 255 characters. +The second rule simply checks the existence of the cookie. It would be possible to check if its value matches a regular expression or is in a list of possibilities, but this allows to show a simple example of what can be done with cookies. Rules based on HTTP Headers work according to a similar approach. -The second rule simply tests to see if a cookie exists. It is also possible to test if the value corresponds to a regular expression, or is found in a possibility list, but this offers a simple example of what you can do with cookies. Rules based on HTTP headers work using a similar approach. +All that remains is to apply the configuration in the concerned area. -Next, apply the configuration to the zone concerned. +#### Route WebSockets to a dedicated farm -### Route WebSockets to a dedicated farm. +When a site has interactive functions based on WebSockets such as a chatbot, you may want to direct these connections to a server farm dedicated to this task. In fact, it is quite simple.W -When a website has interactive features based on WebSockets — a chatbot, for example — you may want to direct these connections to a server farm dedicated to this task. This is actually quite simple. When a browser attempts to open a WebSockets connection, it sends a standard HTTP request with these headers: +When a browser tries to open a WebSocket connection, it sends a standard HTTP request with the headers: ``` Upgrade: websocket Connection: Upgrade ``` -In this case, only the first header needs to be detected. This can be done very easily with a route and a rule: +In practice, it is sufficient to detect the first header. This can be done very easily with a route and a rule: -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|frontendId|Your front-end ID| -|displayName|"Route WebSockets to a dedicated farm"| -|weight|(empty)| -|action.type|"farm"| -|action.status|(empty)| -|action.target|ID of the farm dedicated to WebSockets| +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| frontendId | Identifier of your frontend | +| displayName | "Route WebSockets to a dedicated farm" | +| weight | (empty) | +| action.type | "farm" | +| action.status | (empty) | +| action.target | Identifier of the WebSocket dedicated farm | -And on this route, we will attach a rule: +And on this route, we come to attach a rule: + +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| routeId | Identifier of the route created just above | +| field | "header" | +| subField | "Upgrade" | +| match | "is" | +| negate | false | +| pattern | "websocket" (case-sensitive) | -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|routeId|Route ID created above| -|field|"header"| -|subField|"Upgrade"| -|match|"is"| -|negate|false| -|pattern|"websocket" (case-sensitive)| +All that remains is to apply the configuration in the relevant zone. -Next, apply the configuration to the zone concerned. -## Reference. +### References -Here, you will find more details on the API calls linked to the routes. To get a general idea of how routes work, we recommend starting off by reading the [introduction to the API](#an-introduction-to-the-api){.internal} section further up. +You will find here the details of the API calls related to routes. For a more general overview of route features, we invite you to first consult the section " [API presentation](#apipresentation) " a little further up in this guide. -### Edit routes. +#### Handling routes -TCP and HTTP routes are configured the same way. Since the routes are more powerful in HTTP, this section focuses on HTTP rules and routes. TCP routes can be extrapolated from the information below by replacing “http” with “tcp” in each route. Some fields only apply to HTTP routes, and are not available in TCP. +TCP and HTTP routes are configured in the same way. Since HTTP routes are more powerful, this section focuses on HTTP routes and rules. The operation of TCP routes can be extrapolated by replacing "http" with "tcp" in the routes. Some fields only make sense in HTTP, so they are not available in TCP. -#### List the routes. +##### **List routes** -This call returns the list of ID numbers of routes defined for HTTP protocol. You can filter this list by frontendId. This call returns the routes in the order in which they will be evaluated. The evaluation order can be partially controlled by the weight of the route. +This call returns the list of numeric identifiers of routes defined for the HTTP protocol. You can filter this list by `frontendId`. This call returns the routes in the order in which they will be evaluated. The evaluation order can be partially controlled using the "weight" of the route. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route -> +> -|Setting|Required|Meaning| -|---|---|---| -|serviceName|Required|Your Load Balancer service ID| -|frontendId||ID number of a HTTP front-end the routes are attached to| +| Parameter | Required | Meaning | +| :--- | :--- | :--- | +| serviceName | Required | Identifier of your Load Balancer service | +| frontendId | | Numeric identifier of an HTTP frontend to which the routes are attached | -#### Create a route. +##### **Create a route** -With this call, you can create a route. Only the action is mandatory. A route can be attached to and detached from a front-end. You can create up to 50 routes on an OVH Load Balancer. This call returns the route created, if it is successful. You will need to re-deploy your OVH Load Balancer to apply the changes. +This call allows you to create a route. Only the action is mandatory. A route can be attached and detached from a frontend. It is possible to create up to 50 routes on an OVHcloud Load Balancer service. This call returns the created route in case of success. Your OVHcloud Load Balancer service must be redeployed to apply the changes. > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route -> +> -|Setting|Required|Meaning| -|---|---|---| -|serviceName|Required|Your Load Balancer service ID| -|displayName||Display name for your route (255 characters maximum)| -|frontendId||ID number of a HTTP front-end to attach the route to| -|weight||Route priority, between 1 (carry out first) and 255 (carry out after the others)| -|action.type|Required|Name of the action type to execute if all of the rules associated with the route are validated| -|action.status||HTTP status code for `reject` and `redirect` actions| -|action.target||ID number of the target farm for `farm` actions, or the URL template for `redirect` actions| +| Parameter | Required | Meaning | +| :--- | :--- | :--- | +| serviceName | Required | Identifier of your Load Balancer service | +| displayName | | Display name of your route (maximum 255 characters) | +| frontendId | | Numeric identifier of an HTTP frontend to which to attach the route | +| weight | | Priority of the route, between 1 (passes first) and 255 (passes after others) | +| action.type | Required | Name of the type of action to execute if all the rules associated with the route are validated | +| action.status | | HTTP status code for the `reject` and `redirect` actions | +| action.target | | Numeric identifier of the target farm for the `farm` actions, or URL pattern for the `redirect` actions | -The possible action types are listed below: +The possible action types are: -|action|Meaning| -|---|---| -|redirect|Redirects a request to `action.target`, with the HTTP `action.status` code| -|reject|Rejects a request with the HTTP `action.status` code| -|farm|Routes a request to the farm with the ID entered in `action.target`| +| action | Meaning | +| :--- | :--- | +| redirect | Redirect a request to `action.target` with the HTTP status code `action.status` | +| reject | Reject a request with the HTTP status code `action.status` | +| farm | Route a request to the farm whose identifier is specified in `action.target` | -For further information on the actions managed and the format of parameters, please read the [Available actions](#available-actions){.internal} section further down. +For more information on the actions handled and the format of the parameters, we invite you to consult the section " [Available actions](#available-actions) " further down in this guide. -#### View details on a route. +##### **View the details of a route** -With this call, you can view details on an HTTP route if you know its ID. +This call allows you to view the details of an HTTP route, knowing its identifier. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId} -> +> -Query +- Request: -|Setting|Meaning| -|---|---| -|serviceName|Your Load Balancer service ID| -|routeId|The route’s ID number| +| Parameter | Meaning | +| :--- | :--- | +| serviceName | Identifier of your Load Balancer service | +| routeId | Numeric identifier of the route | -Answer +- Response: -|Setting|Meaning| -|---|---| -|routeId|The route’s ID number| -|displayName|The display name for your route| -|frontendId|ID number of the front-end your route is attached to| -|weight|Priority of your route| -|action.type|Name of the action type for your route| -|action.status|Associated HTTP status code| -|action.target|ID number of the associated farm or URL template| -|rules|List of rules that must be validated to trigger the route’s action More detail on this is available in the [Edit rules](#edit-rules){.internal} section.| +| Parameter | Meaning | +| :--- | :--- | +| routeId | Numeric identifier of the route | +| displayName | Display name of your route | +| frontendId | Numeric identifier of the frontend to which your route is attached | +| weight | Priority of your route | +| action.type | Name of the type of action of your route | +| action.status | Associated HTTP status code | +| action.target | Numeric identifier of the farm or associated URL pattern | +| rules | List of rules that must be validated to trigger the action of the route. More details are available in the section " [Handling Rules](#handling-rules) ". | -For further information on the actions managed and the format of parameters, please read the [Available actions](#available-actions){.internal} section further down. +For more information on the actions handled and the format of the parameters, we invite you to consult the section "[Available actions](#available-actions)" further down in this guide. -#### Modify a route. +##### **Modify a route** -With this call, you can modify an HTTP route if you know its ID. You will need to re-deploy your OVH Load Balancer to apply the changes. +This call allows you to modify an HTTP route, knowing its identifier. Your OVHcloud Load Balancer service must be redeployed to apply the changes. > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId} > -|Setting|Required|Meaning| -|---|---|---| -|serviceName|Required|Your Load Balancer service ID| -|routeId|Required|The route’s ID number| -|displayName||Display name for your route (255 characters maximum)| -|frontendId||ID number of a HTTP front-end to attach the route to| -|weight||Route priority, between 1 (carry out first) and 255 (carry out after the others)| -|action.type|Required|Name of the action type to execute if all of the rules associated with the route are validated| -|action.status||HTTP status code for `reject` and `redirect` actions| -|action.target||ID number of the target farm for `farm` actions, or the URL template for `redirect` actions| +| Parameter | Required | Meaning | +| :--- | :--- | :--- | +| serviceName | Required | Identifier of your Load Balancer service | +| routeId | Required | Numeric identifier of the route | +| displayName | | Display name of your route (maximum 255 characters) | +| frontendId | | Numeric identifier of an HTTP frontend to which to attach the route | +| weight | | Priority of the route, between 1 (passes first) and 255 (passes after others) | +| action.type | Required | Name of the type of action to execute if all the rules associated with the route are validated | +| action.status | | HTTP status code for the `reject` and `redirect` actions | +| action.target | | Numeric identifier of the target farm for the `farm` actions, or URL pattern for the `redirect` actions | -For further information on the actions managed and the format of parameters, please read the [Available actions](#available-actions){.internal} section further down. +For more information on the actions handled and the format of the parameters, we invite you to consult the section " [Available actions](#available-actions) " further down in this guide. -#### Delete a route. +##### **Delete a route** -With this call, you can delete an HTTP route if you know its ID. When a route is deleted, all of the rules associated with the route are deleted, too. You do not need to delete them individually. You will need to re-deploy your OVH Load Balancer to apply the changes. +This call allows you to delete an HTTP route, knowing its identifier. When a route is deleted, all the rules associated with that route are also deleted. There is no need to delete them individually. Your OVHcloud Load Balancer service must be redeployed to apply the changes. > [!api] > > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId} -> +> -|Setting|Required|Meaning| -|---|---|---| -|serviceName|Required|Your Load Balancer service ID| -|routeId|Required|The route’s ID number| +| Parameter | Required | Meaning | +| :--- | :--- | :--- | +| serviceName | Required | Identifier of your Load Balancer service | +| routeId | Required | Numeric identifier of the route | -### Edit rules. +#### Handling rules -#### List the rules. +##### **List rules** -This call returns the list of ID numbers of rules defined for a particular route. +This call returns the list of numeric identifiers of rules defined for a given route. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule -> +> -|Setting|Required|Meaning| -|---|---|---| -|serviceName|Required|Your Load Balancer service ID| -|routeId|Required|The route’s ID number| +| Parameter | Required | Meaning | +| :--- | :--- | :--- | +| serviceName | Required | Identifier of your Load Balancer service | +| routeId | Required | Numeric identifier of the route | -#### Attach a rule. +##### **Attach a rule** -With this call, you can attach a rule to a route. You can attach up to 5 rules per route on an OVH Load Balancer. This call returns the route created, if it is successful. You will need to re-deploy your OVH Load Balancer to apply the changes. +This call allows you to attach a rule to a route. It is possible to attach up to 5 rules per route on an OVHcloud Load Balancer service. This call returns the created rule in case of success. Your OVHcloud Load Balancer service must be redeployed to apply the changes. > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule -> - -|Setting|Required|Meaning| -|---|---|---| -|serviceName|Required|Your Load Balancer service ID| -|routeId|Required|The route’s ID number| -|field|Required|The name of the HTTP parameter to apply the rule to| -|subField||HTTP header name for the `header` rules, or cookie name for `cookie` rules| -|match|Required|Name of the comparison to apply to validate the rule| -|negate||Reverses the comparison result| -|pattern||Comparison pattern| - -`field` - -|Value|Meaning| -|---|---| -|source|The address or list of source IP addresses (a.b.c.d/z)| -|protocol|Protocol (“http” or “https”)| -|method|HTTP method (GET, HEAD, POST, PUT, DELETE, OPTIONS, CONNECT, TRACE)| -|host|Domain name (vhost), without the port number| -|uri|Path of the request as it appears between the first "/" and the last "?"| -|param|HTTP parameter contained in the part after the first "?"| -|header|HTTP header| -|cookie|HTTP cookie| - -`match` - -|Value|Meaning| -|---|---| -|exists|The property must exist (e.g. HTTP header or cookie)| -|-|The property must correspond exactly to a `pattern`| -|in|The property must be in the list of values (separated by commas) defined by `pattern`| -|contains|The property must contain the `pattern` value| -|startswith|The property must start with the `pattern` value| -|endswith|The property must end with the `pattern` value| -|matches|The property must match the regular `pattern` expression| - -For further information on the rules managed and the format of parameters, please read the [Available rules](#available-rules){.internal} section further down. - -#### View details on a rule. - -With this call instruction, you can view the details on a rule attached to an HTTP route if you know its ID. +> + +| Parameter | Required | Meaning | +| :--- | :--- | :--- | +| serviceName | Required | Identifier of your Load Balancer service | +| routeId | Required | Numeric identifier of the route | +| field | Required | Name of the HTTP parameter on which to apply this rule | +| subField | | Name of the HTTP header for `header` rules or name of the cookie for `cookie` rules | +| match | Required | Name of the comparator to apply to validate the rule | +| negate | | Inverts the result of the comparator | +| pattern | | Comparator argument | + +- `field` + +| Value | Meaning | +| :--- | :--- | +| source | Address or list of source addresses in the form of IP (a.b.c.d/z) | +| protocol | Protocol. "http" or "https" | +| method | HTTP method (GET, HEAD, POST, PUT, DELETE, OPTIONS, CONNECT, TRACE) | +| host | Domain name (vhost), without the port number | +| uri | Request path as understood between the first "/" and the first "?" | +| param | HTTP parameter coming from the part after the first "?" | +| header | HTTP header | +| cookie | HTTP cookie | + +- `match` + +| Value | Meaning | +| :--- | :--- | +| exists | The property must exist (HTTP header or cookie for example) | +| is | The property must match exactly `pattern` | +| in | The property must be in the list of values (separated by commas) defined by `pattern` | +| contains | The property must contain the value of `pattern` | +| startswith | The property must start with the value of `pattern` | +| endswith | The property must end with the value of `pattern` | +| matches | The property must match the regular expression of `pattern` | + +For more information on the rules handled and the format of the parameters, we invite you to consult the section " [Available rules](#available-rules) " further down in this guide. + +##### **View the details of a rule** + +This call allows you to view the details of a rule attached to an HTTP route, knowing its identifier. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId} -> +> -Query +- Request: -|Setting|Meaning| -|---|---| -|serviceName|Your Load Balancer service ID| -|routeId|The route’s ID number| -|ruleId|The rule’s ID number| +| Parameter | Meaning | +| :--- | :--- | +| serviceName | Identifier of your Load Balancer service | +| routeId | Numeric identifier of the route | +| ruleId | Numeric identifier of the rule | -Answer +- Response: -|Setting|Meaning| -|---|---| -|ruleId|The rule’s ID number| -|field|Name of the HTTP parameter to apply the rule on| -|subField|Name of the HTTP header or cookie for the rule| -|match|Name of the comparison to apply to validate the rule| -|negate|"true" if the comparison result is reversed| -|pattern|Comparison argument. The direction and syntax depends on the `match` and the `field`.| +| Parameter | Meaning | +| :--- | :--- | +| ruleId | Numeric identifier of the rule | +| field | Name of the HTTP parameter on which to apply the rule | +| subField | Name of the HTTP header or cookie for the rule | +| match | Name of the comparator to apply to validate the rule | +| negate | "true" if the result of the comparator is inverted | +| pattern | Comparator argument. The meaning and syntax depend on `match` and `field` | -For further information on the rules managed and the format of parameters, please read the [Available rules](#available-rules){.internal} section further down. +For more information on the rules handled and the format of the parameters, we invite you to consult the section " [Available rules](#available-rules) " further down in this guide. -#### Modify a rule. +##### **Modify a rule** -With this call, you can modify a rule attached to an HTTP route if you know its ID. You will need to re-deploy your OVH Load Balancer to apply the changes. +This call allows you to modify a rule attached to an HTTP route, knowing its identifier. Your OVHcloud Load Balancer service must be redeployed to apply the changes. > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId} -> +> -|Setting|Required|Meaning| -|---|---|---| -|serviceName|Required|Your Load Balancer service ID| -|routeId|Required|The route’s ID number| -|ruleId|Required|The rule’s ID number| -|field|Required|The name of the HTTP parameter to apply the rule to| -|subField||HTTP header name for the `header` rules, or cookie name for `cookie` rules| -|match|Required|Name of the comparison to apply to validate the rule| -|negate||Reverses the comparison result| -|pattern||Comparison pattern| +| Parameter | Required | Meaning | +| :--- | :--- | :--- | +| serviceName | Required | Identifier of your Load Balancer service | +| routeId | Required | Numeric identifier of the route | +| ruleId | Required | Numeric identifier of the rule | +| field | Required | Name of the HTTP parameter on which to apply this rule | +| subField | | Name of the HTTP header for `header` rules or name of the cookie for `cookie` rules | +| match | Required | Name of the comparator to apply to validate the rule | +| negate | | Inverts the result of the comparator | +| pattern | | Comparator argument | -For further information on the rules managed and the format of parameters, please read the [Available rules](#available-rules){.internal} section further down. +For more information on the rules handled and the format of the parameters, we invite you to consult the section " [Available rules](#available-rules) " further down in this guide. -#### Delete a rule. +##### **Delete a rule** -With this call, you can delete a rule attached to an HTTP route if you know its ID. You will need to re-deploy your OVH Load Balancer to apply the changes. +This call allows you to delete a rule attached to an HTTP route, knowing its identifier. Your OVHcloud Load Balancer service must be redeployed to apply the changes. > [!api] > > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId} -> +> -|Setting|Required|Meaning| -|---|---|---| -|serviceName|Required|Your Load Balancer service ID| -|routeId|Required|The route’s ID number| -|ruleId|Required|The rule’s ID number| +| Parameter | Required | Meaning | +| :--- | :--- | :--- | +| serviceName | Required | Identifier of your Load Balancer service | +| routeId | Required | Numeric identifier of the route | +| ruleId | Required | Numeric identifier of the rule | > [!primary] > -> If you want to delete a route, you do not need to delete all the rules attached to it. The rules are automatically deleted when you delete the route. -> +> If you want to delete a route, it is not necessary to delete all the rules attached to it. The rules are automatically deleted when you delete a route. +> -#### List all of the TCP and HTTP routes. +##### **List all TCP and HTTP routes** -With this call, you can get a list of all the IDs, display names and types ("http"/"tcp") of routes defined on an OVH Load Balancer service. It is designed to simplify the implementation of auto-completion. +This call allows you to list all the identifiers, display names and types ("http"/"tcp") of routes defined on an OVHcloud Load Balancer service. It was designed to simplify the implementation of auto-completion. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/definedRoutes -> +> -Query +- Request: -|Setting|Meaning| -|---|---| -|serviceName|Your Load Balancer service ID| +| Parameter | Meaning | +| :--- | :--- | +| serviceName | Identifier of your Load Balancer service | -Answer +- Response: -|Setting|Meaning| -|---|---| -|type|Type of protocol for the route: "tcp" for TCP routes, "http" for HTTP routes| -|routeId|The route’s ID number| -|displayName|The display name of the route| +| Parameter | Meaning | +| :--- | :--- | +| type | Type of protocol of the route: "tcp" for TCP routes, "http" for HTTP routes | +| routeId | Numeric identifier of the route | +| displayName | Display name of the route | -### Actions available +#### Available actions -This call returns the list of actions available for TCP and HTTP routes, as well as the values expected for each of the fields. +This call returns the list of available actions for TCP and HTTP routes as well as the expected values for each of the fields. -If a field is “null”, this means that no value is expected. If an invalid value is entered, the API will return a validation error. +If a field is "null", it means that no value is expected. If an invalid value is provided, the API will return a validation error. -All of the actions managed by the OVH Load Balancer service are final. This means that executing an action also triggers the end of route evaluation. +All actions managed by the OVHcloud Load Balancer service are final. This means that the execution of an action also ends the evaluation of the routes. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteActions -> +> -Query +- Request: -|Setting|Meaning| -|---|---| -|serviceName|Your Load Balancer service ID| +| Parameter | Meaning | +| :--- | :--- | +| serviceName | Identifier of your Load Balancer service | -Answer +- Response: -|Setting|Meaning| -|---|---| -|type|Shows if this action is valid for a HTTP or a TCP route| -|name|Name of the action to enter into the `type` field of routes| -|status|List of HTTP status codes available for this action (`status` fields of routes)| -|destination|Value type expected in the `destination` fields for routes| +| Parameter | Meaning | +| :--- | :--- | +| type | Indicates whether this action is valid for an HTTP route or a TCP route | +| name | Name of the action to specify in the `type` field of the routes | +| status | List of available HTTP status codes for this action (the `status` field of the routes) | +| destination | Type of value expected in the `destination` field of the routes | -#### Redirection +##### **Redirection** -This action sends a redirection to the visitor. This redirection type can be configured with the status field. When this action is selected, no farms will receive the request. +This action returns a redirection to the visitor. The type of redirection can be configured with the `status` field. When this action is selected, no farm will receive the request. -|Setting|Value| -|---|---| -|type|`redirect`| -|status|301, 302, 303, 307 or 308| -|target|Target URL (may contain variables)| +| Parameter | Value | +| :--- | :--- | +| type | `redirect` | +| status | 301, 302, 303, 307 or 308 | +| target | Destination URL (can contain variables) | -Only the HTTP redirection status codes can be specified. The most common codes are 301 and 302. If you have any doubts, you can set up a 302 (temporary redirection). The HTTP status codes for redirections are: +Only HTTP redirection status codes can be specified. The most common are codes 301 and 302. If you are unsure, you can use the 302 "Temporary Redirect". The HTTP status codes recognized for redirections are: -|Status code|Description| -|---|---| -|301|Permanent redirection. The redirection can be saved by the browser.| -|302 (default)|Temporary redirection. The redirection must be revalidated for each request by the browser.| -|303|Works like a 302, and forces the use of the HTTP GET method.| -|307|Works like a 302, and forces the same HTTP method to be reused (GET, POST, etc.).| -|308|Works like a 301, and forces the same HTTP method to be reused (GET, POST, etc.).| +| Status code | Description | +| :--- | :--- | +| 301 | Permanent redirect. The redirect can be stored by the browser. | +| 302 (default) | Temporary redirect. The redirect must be revalidated by the browser on each request. | +| 303 | Like 302 and forces the use of the HTTP GET method. | +| 307 | Like 302 and forces the reuse of the same HTTP method (GET, POST, etc.). | +| 308 | Like 301 and forces the reuse of the same HTTP method (GET, POST, etc.). | -The target URL may contain simple variables. This helps users redirect to another domain, another protocol or add a suffix/prefix to a URL. The recognised variables are: +The destination URL can contain simple variables. This allows you to redirect to another domain, another protocol or add a suffix / prefix to a URL. The recognized variables are: -|Variable|Description| -|---|---| -|`protocol`|Protocol of the request ("http" or "https")| -|`domain`|Domain name of the request, without the port number| -|`host`|"Host" field of the request, including the port number, if there is one| -|`port`|Port of the request| -|`path`|Path of the request, starts with a '/' and ends before the first '?'| -|`arguments`|Arguments of the request, starts with a '?' if present| +| Variable | Description | +| :--- | :--- | +| `protocol` | Protocol of the request ("http" or "https") | +| `domain` | Domain name of the request, without the port number | +| `host` | "Host" field of the request, including the port number if present | +| `port` | Port of the request | +| `path` | Path of the request, starts with a '/' and ends at the first '?' | +| `arguments` | Arguments of the request, starts with a '?' if present | -For example, for: +For example, to: -- redirect to https: `https://${host}${path}${arguments}` -- redirect to a new domain: ${protocol}://new.example.com${path}${arguments} -- prefix the URL: ${protocol}://${host}/staging${path}${arguments} +- redirect to https: `https://\${host}\${path}\${arguments}` +- redirect to a new domain: `${protocol}://new.example.com\${path}\${arguments}` +- prefix the URL: `${protocol}://\${host}/staging\${path}\${arguments}` -#### Reject. +##### **Rejection** -This action returns an HTTP error status code to the visitor. The HTTP error code can be configured with the status field. When this action is selected, no farms will receive the request. +This action returns an HTTP error status code to the visitor. The error HTTP status code can be configured with the `status` field. When this action is selected, no farm will receive the request. -|Setting|Value| -|---|---| -|type|`reject`| -|status|200, 400, 403, 405, 408, 429, 500, 502, 503 or 504| -|target|not available| +| Parameter | Value | +| :--- | :--- | +| type | `reject` | +| status | 200, 400, 403, 405, 408, 429, 500, 502, 503 or 504 | +| target | not available | > [!primary] > -> This action is also available in TCP. In this case, the parameter status is not available, and the request is terminated. TCP requests that are terminated like this are not compatible with high percentages of requests. -> +> This action is also available in TCP. In this case, the `status` parameter is not available and the request is terminated. TCP requests terminated in this way are not counted in the request rate. +> -Only the HTTP error codes listed in the API can be specified. The most common ones are 400 ("Bad request") errors, and 403 ("Forbidden") errors. A 200 code can be used to block a request type while simulating a success, and a 503 code can be used to simulate a server outage. +Only the HTTP error status codes listed in the API can be specified. The most common are the codes 400 "Bad request" and 403 "Forbidden". 200 can be used to block a type of request while simulating a success, and 503 can be used to simulate a server failure. -|Status code|Description| -|---|---| -|200|The request has been successfully executed.| -|400|Invalid request.| -|403 (default)|Access forbidden.| -|405|Method (GET, POST, PUT, ...) invalid or not managed.| -|408|The request has taken too long to be sent by the client.| -|429|The client has sent too many requests (rate limiting).| -|500|Generic server error.| -|502|Error communicating with the server.| -|503|The service is temporarily unavailable.| -|504|The server has taken too much time to respond.| +| Status code | Description | +| :--- | :--- | +| 200 | The request was executed successfully. | +| 400 | Invalid request. | +| 403 (default) | Access forbidden. | +| 405 | Invalid or unhandled method (GET, POST, PUT, etc.) +| 408 | The client failed to send a complete request within the server's time limit. | +| 429 | The client sent too many requests (rate-limiting). | +| 500 | Generic server error. | +| 502 | Communication error with the server. | +| 503 | The service is temporarily unavailable. | +| 504 | The server took too long to respond. | -#### Routing. +##### **Routing** -This action redirects requests to a specific farm, other than the default farm configured on the front-end. The destination farm must be the same type as the front-end ("http" or "tcp"). +This action directs requests to a specific farm, other than the default farm configured on the frontend. The target farm must be of the same type as the frontend ("http" or "tcp"). -|Setting|Value| -|---|---| -|type|`farm`| -|status|not available| -|target|The destination farm’s ID number. This must be the same type.| +| Parameter | Value | +| :--- | :--- | +| type | `farm` | +| status | not available | +| target | Numeric identifier of the target farm. This must be of the same type | > [!primary] > -> This action is also available in TCP. In this case, the destination farm type must be "tcp". -> +> This action is also available in TCP. In this case, the target farm must be of type "tcp". +> -### Available rules. +#### Available rules -This call returns the list of rules available for TCP and HTTP routes, as well as the values expected for each of the fields. +This call returns the list of available rules for TCP and HTTP routes, as well as the expected values for each field. -If a field is “null”, this means that no value is expected. If an invalid value is entered, the API will return a validation error. +If a field is "null", it means no value is expected. If an invalid value is provided, the API will return a validation error. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteRules -> +> -Query +- Request: -|Setting|Meaning| -|---|---| -|serviceName|Your Load Balancer service ID| +| Parameter | Meaning | +| :--- | :--- | +| serviceName | Identifier of your Load Balancer service | -Answer +- Response: -|Setting|Meaning| -|---|---| -|type|Type of protocol for the route: "tcp" for TCP routes, "http" for HTTP routes| -|name|Name of the property on which to apply this rule, to be entered into the `field` field| -|hasSubField|"true" is this property is a sub-property (e.g. a header or cookie)| -|matches|List of comparisons available for each rule, to be entered into the `match` field| -|pattern|Type of value expected for the `pattern` field| -|enum|List of values for the chmaps `pattern`, if it is a list| +| Parameter | Meaning | +| :--- | :--- | +| type | Protocol type of the route: "tcp" for TCP routes, "http" for HTTP routes | +| name | Name of the property to which this rule applies, to be filled in the `field` field | +| hasSubField | "true" if this property has a "sub-property" (e.g.: a header or a cookie) | +| matches | List of available comparators for this rule, to be filled in the `match` field | +| pattern | Type of expected value for the `pattern` field | +| enum | List of possible values for the `pattern` field if it is an enumeration | -The different `pattern` types are: +The different types of `pattern` are: -|Value|Meaning| -|---|---| -|cidr|IP address (a.b.c.d) or sub-network (a.b.c.d/z)| -|string|Free text. For the `in` operator, a list of values separated by columns (255 characters maximum)| -|enum|The field is a list defined in `enum`| +| Value | Meaning | +| :--- | :--- | +| cidr | IP address (a.b.c.d) or subnet (a.b.c.d/z) | +| string | Free text. For the operator `in`, a list of comma-separated values (maximum 255 characters) | +| enum | The field is an enumeration defined in `enum` | -#### Protocol. +##### **Protocol** -With this rule, you can filter requests depending on their protocol. In practice, the uses for this rule are quite limited, as the protocol depends on the front-end that the route is attached to, or a front-end that only manages a single protocol recognised the moment the route is defined. +This rule allows filtering requests based on their protocol. In practice, the use cases for this rule are quite limited because the protocol depends on the frontend to which the route is attached, and a frontend only handles one protocol, which is known at the time the route is defined. -|Fields|Value| -|---|---| -|name|`protocol`| -|hasSubField|no| -|matches|`is` or `in`| -|pattern|`tcp`, `tls`, `http` or `https`| +| Field | Value | +| :--- | :--- | +| name | `protocol` | +| hasSubField | no | +| matches | `is` or `in` | +| pattern | `tcp`, `tls`, `http` or `https` | > [!primary] > -> This action is also available in TCP. In this case, "http/2.0" protocol is also available. It is based on the "ALPN" SSL/TLS field used by browsers to announce that they are attempting to establish a HTTP/2.0 connection. This way, you can have a common TCP front-end for SSL/TLS termination of HTTP 1 and 2, then direct traffic depending on the protocol version. -> +> This action is also available in TCP. In this case, the "http/2.0" protocol is also available. It is based on the SSL/TLS "ALPN" field used by browsers to announce that they are trying to establish an HTTP/2.0 connection. This allows for a common TCP frontend for HTTP 1 and 2 SSL/TLS termination, then routing these streams based on the protocol version. +> -#### Source address. +##### **Source address** -With this rule, you can filter requests depending on their source address. By combining it with a rule based on the URI or the domain name, you can restrict certain resources to an enterprise proxy while exposing all of your other resources without restrictions, via your OVH Load Balancer. +This rule allows filtering requests based on their source address. By combining it with a rule based on the URI or domain name, it is for example possible to restrict certain resources to an enterprise proxy, while exposing all other resources without restrictions on your OVHcloud Load Balancer service. -|Fields|Value| -|---|---| -|name|`source`| -|hasSubField|no| -|matches|`is` or `in`| -|pattern|Sub-network (a.b.c.d/z) or address (a.b.c.d)| +| Field | Value | +| :--- | :--- | +| name | `source` | +| hasSubField | no | +| matches | `is` or `in` | +| pattern | Subnet (a.b.c.d/z) or address (a.b.c.d) | > [!primary] > -> This action is also available in TCP using the same method. -> +> This action is also available in TCP with the same behavior. +> -To block a particular network and address, for example, you can use a pattern like "4.4.0.0/16, 8.8.8.8". +For example, to block a network and a specific address, you can use a pattern such as "4.4.0.0/16, 8.8.8.8". -#### Domain name. +##### **Domain name** -With this rule, you can filter requests depending on their domain name. In doing so, you can reproduce the Apache "vhost" feature, or route all of the domains that start with "mail." to a server dedicated to webmail. +This rule allows filtering requests based on their domain name. This can for example be used to reproduce the "vhost" function of Apache or to route all domains starting with "mail." to a server dedicated to webmail. -|Fields|Value| -|---|---| -|name|`host`| -|hasSubField|no| -|matches|`is`, `in`, `contains`, `startswith`, `endswith` or `matches`| -|pattern|Character chain or regular expression| +| Field | Value | +| :--- | :--- | +| name | `host` | +| hasSubField | no | +| matches | `is`, `in`, `contains`, `startswith`, `endswith` or `matches` | +| pattern | String or regular expression | > [!primary] > -> This action is also available in TCP. It will only work if the front-end is configured to accept SSL/TLS connections, and if the client sends an "SNI" option. This is especially the case with recent web browsers. -> +> This action is also available in TCP. It is only applicable if the frontend is configured to accept SSL/TLS connections and the client sends an "SNI" option. This is particularly the case for recent web browsers. +> -#### HTTP method. +##### **HTTP method** -With this rule, you can filter requests depending on their HTTP method. It is commonly used alongside a rule based the request URI or path, to make the rule more selective. +This rule allows filtering requests based on the HTTP method. It is commonly used in conjunction with a rule based on the request URI or path to make the rule more selective. -|Fields|Value| -|---|---| -|name|`method`| -|hasSubField|no| -|matches|`is` or `in`| -|pattern|`GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS` or `TRACE`| +| Field | Value | +| :--- | :--- | +| name | `method` | +| hasSubField | no | +| matches | `is` or `in` | +| pattern | `GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS` or `TRACE` | -#### Request path. +##### **Request path** -With this rule, you can filter requests depending on their path, or URI. The request path is between the first '/' (inclusive) and the first '?' (excluded). +This rule allows filtering requests based on the request path or URI. The request path is the part between the first '/' included and the first '?' excluded. -|Fields|Value| -|---|---| -|name|`uri`| -|hasSubField|no| -|matches|`is`, `in`, `contains`, `startswith`, `endswith` or `matches`| -|pattern|Character chain or regular expression| +| Field | Value | +| :--- | :--- | +| name | `uri` | +| hasSubField | no | +| matches | `is`, `in`, `contains`, `startswith`, `endswith` or `matches` | +| pattern | String or regular expression | -#### Request parameter. +##### **Request parameter** -This rule filters requests depending on their existence, or the value of a specific HTTP request parameter. This is the part after the first '?'. If a parameter is specified several times in a request, only the first instance is taken into account. +This rule allows filtering requests based on the existence or value of a specific HTTP request parameter. This is the part after the first '?'. If a parameter is specified multiple times in the request, only the first one is taken into account. -|Fields|Value| -|---|---| -|name|`param`| -|hasSubField|yes| -|matches|`is`, `in`, `contains`, `startswith`, `endswith` or `matches`| -|pattern|Character chain or regular expression| +| Field | Value | +| :--- | :--- | +| name | `param` | +| hasSubField | yes | +| matches | `is`, `in`, `contains`, `startswith`, `endswith` or `matches` | +| pattern | String or regular expression | -#### HTTP header. +##### **HTTP header** -This rule filters requests depending on their existence, or the value of a specific HTTP header value. You can use it to detect the opening of a WebSocket connection, and direct it to a dedicated server farm. +This rule allows filtering requests based on the existence or value of a specific HTTP header. This can for example be used to detect the opening of a websocket connection and route it to a dedicated farm. -|Fields|Value| -|---|---| -|name|`header`| -|hasSubField|yes| -|matches|`is`, `in`, `contains`, `startswith`, `endswith` or `matches`| -|pattern|Character chain or regular expression| +| Field | Value | +| :--- | :--- | +| name | `header` | +| hasSubField | yes | +| matches | `is`, `in`, `contains`, `startswith`, `endswith` or `matches` | +| pattern | String or regular expression | -#### Cookie. +##### **Cookie** -With this rule, you can filter requests depending on the existence or value of a specific HTTP cookie. You can use it to direct voluntary visitors to a pre-production farm. +This rule allows filtering requests based on the existence or value of a specific HTTP cookie. This can for example be used to direct opt-in visitors to a pre-production farm. -|Fields|Value| -|---|---| -|name|`cookie`| -|hasSubField|yes| -|matches|`is`, `in`, `contains`, `startswith`, `endswith` or `matches`| -|pattern|Character chain or regular expression| +| Field | Value | +| :--- | :--- | +| name | `cookie` | +| hasSubField | yes | +| matches | `is`, `in`, `contains`, `startswith`, `endswith` or `matches` | +| pattern | String or regular expression | ## Go further -Join our community of users on . +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_route/guide.en-ca.md b/pages/network/load_balancer/create_route/guide.en-ca.md index b7830c408dd..efe77c2df9f 100644 --- a/pages/network/load_balancer/create_route/guide.en-ca.md +++ b/pages/network/load_balancer/create_route/guide.en-ca.md @@ -1,875 +1,880 @@ --- -title: 'Working with HTTP routes' -excerpt: 'Find out how to direct your requests dynamically, to a specific farm' -updated: 2018-04-09 +title: "Configuring an OVHcloud Load Balancer with HTTP routes" +excerpt: "Find out how to dynamically direct your requests to a specific farm" +updated: 2025-11-27 --- ## Objective -The OVH Load Balancer service redirects the front-end’s incoming traffic to the servers that make up the front-end’s default farm, or its default redirection. +The OVHcloud Load Balancer service redirects the front-end’s incoming traffic to the servers that make up the front-end’s default farm, or its default redirection. -In some cases, you can go a step further and route, redirect or block traffic according to a range of criteria. For example, in the case of a HTTP(S) service, you can filter traffic depending on the HTTP method, the URL, and even a cookie or header value! In the OVH Load Balancer service, these are called `routes`{.action}. A route is a particular action to carry out if one or more conditions are met. +In some cases, you can go further and route, redirect, or block traffic according to a range of criteria. For example, in the case of an HTTP(S) service, you can filter traffic based on the HTTP method, the URL, or even the value of a cookie or header. -**This guide will show you how to direct your requests dynamically, to a specific farm.** +In the OVHcloud Load Balancer service, these elements are called **routes**. A route is a specific action to perform if one or more conditions are met. + +**This guide will show you how to direct your requests dynamically to a specific farm using routes.** ## Requirements -- an [OVH Load Balancer](https://www.ovh.com/ca/en/solutions/load-balancer/) on a solution that lets you create routes -- access to the [OVH API](/links/api) +- Have an [OVHcloud Load Balancer](/links/network/load-balancer) on an offer allowing the creation of routes. +- Have access to the [OVHcloud API](/links/api). ## Instructions > [!primary] > -> Although this guide focuses on HTTP routes, the same principle applies to TCP (with TCP routes). This can be used to direct HTTP/2 traffic to a particular farm, or reject incoming requests from certain IPs. -> +> Although this guide focuses on **HTTP routes**, the same principle applies to **TCP routes**. This can be useful for directing HTTP/2 traffic to a specific farm or rejecting incoming requests from certain IP addresses. +> -Since this feature is still very new, it is only available in the API. This guide will explain the general principles behind routing, and provide practical examples of routes being used. +This feature is only available via the API. This guide will present the general principles as well as use cases for routes drawn from real-life scenarios. -- **An introduction to routes**. +### Introduction to routes -A route controls traffic according to different criteria. You can express these criteria as rules, conditions, or actions. +A route is used to control traffic according to different criteria. They can be expressed in the form of **rules**, **conditions**, or **actions**. -For example, *IF* the URL _starts_ with '/wp-admin/' (1) *AND* the connection _is_ in HTTP (2) *THEN* _redirect_ to the HTTPS version of the page (3). +For example, *IF* the URL _starts with_ '/wp-admin/' (1) *AND* the connection _is_ HTTP (2) *THEN* _redirect_ to the HTTPS version of the page (3). -In this example, there are two rules: +In this example, there are two rules : -- the connection must come from a HTTP front-end (2) -- its URL must begin with the WordPress admin pages (1) +- the connection must come from an HTTP frontend (2); +- its URL must start with the WordPress administration pages (1). There is an action associated with these rules: redirect to the HTTPS version of the page (3). -This is what is known as an ‘end action’. It means that if the rules are confirmed, the evaluation of routes stops, and the action is executed. +This is what is known as an "end action". That means if the rules are validated, the evaluation of the routes stops and the action is executed. -## An introduction to the API. +### API presentation -You can only manage routes via the [OVH API](/links/api). It is only valid for `http`{.action} and `tcp`{.action} protocols, and the `/ipLoadbalancing/{serviceName}/{protocol}/route/`{.action} pathway exposes the API dedicated to routes. +Route management is only available through the [OVHcloud API](/links/api). It is only valid for the **http** and **tcp** protocols, and the path `/ipLoadbalancing/{serviceName}/{protocol}/route/`{.action} exposes the dedicated route API. -The API for routes to the OVH Load Balancer is specially designed for flexibility, power and scalability. It is organised around three main sections: +The OVHcloud Load Balancer service route API has been specifically designed to be flexible, powerful, and scalable. It is organized around three main sections: -1. the APIs listing available rules and actions -2. the APIs listing the routes configured on the OVH Load Balancer service -3. the APIs for configuring routes on the OVH Load Balancer service +1. API calls listing the available rules and actions. +2. API calls listing the routes configured on your OVHcloud Load Balancer service. +3. API calls for configuring the routes of your OVHcloud Load Balancer service. > [!primary] > -> To only show the APIs linked to routes in the OVH API console, you can use the `filter`{.action} field with ‘route’ as a keyword. -> +> To display only the API calls related to routes in the OVHcloud API console, you can use the `filter`{.action} field with the keyword "[a-z]*". +> -When you want to configure a route or rules, the first thing you need to do is look at the available actions and rules. This will give you the possible values for the API route and rule configuration fields. +When you want to configure a route or rules, the first thing to do is to consult the **available actions and rules**. This will give you the possible values for the configuration fields of the route and rule APIs. - A route can have several rules. -- A route can only be attached to a single front-end. -- A front-end can have several routes. In this case, the order of evaluation depends on its type and weight. +- A route can only be attached to a single frontend. +- A frontend can have several routes. In this case, the evaluation order depends on its type and weight. -When a request arrives at your OVH Load Balancer service, the routes are evaluated successively following the principles below: +When a request arrives on your OVHcloud Load Balancer service, the routes are evaluated successively according to the following principles: -1. firstly, reject and rewrite routes, then the farm routes -1. within categories, the routes are evaluated in order of ascending weight -1. if two routes are the same weight, the first route created is evaluated first -1. only the first action from all the validated rules is executed +1. first, the **reject and rewrite routes**, then the **farm routes**; +2. within these categories, the routes are evaluated in **increasing weight order**; +3. if two routes have the same weight, the **first route created** is evaluated first; +4. only the **first action** of all validated rules is executed. -### Available rules and actions. +### Available rules and actions -This first section of the API contains an updated list of actions and rules available for the OVH Load Balancer service. It contains a call for actions, and another for rules. These two calls return a list of objects. Each object has a name, and if it applies to all TCP or HTTP routes as well as the values or value types expected for different fields of the API. If a field is “null”, this means that no value is expected. If an invalid value is entered, the API will return a validation error. +This first section of the API contains an up-to-date list of available actions and rules for your OVHcloud Load Balancer service. It contains one call for the actions and another for the rules. These two calls return a list of objects. Each object is named, and indicates whether it applies to TCP or HTTP routes, as well as the expected values or types of values for the different fields of the API. If a field is "null", it means no value is expected. If an invalid value is provided, the API will return a validation error. #### Actions > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteActions -> +> -For more information on this call, please read the [Available actions](#available-actions){.internal} section at the bottom of this guide. +For more information on this call, we invite you to consult the section [Available Actions](#available-actions), at the bottom of this guide. -#### Rules: +#### Rules > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteRules -> +> -For more information on this call, please read the [Available rules](#available-rules){.internal} section at the bottom of this guide. +For more information on this call, we invite you to consult the section [Available Rules](#available-rules), at the bottom of this guide. -### Configured routes. +### Configured routes -This section of the API only contains one call. It was mainly designed to help implement auto-complete systems. It returns the ID, name and type of each defined route. You can get a route’s details with a GET /ipLoadbalancing/{serviceName}/route/{type}/{routeId} call, defined further below. +This second section of the API contains only one call. It was mainly designed to facilitate the implementation of auto-completion mechanisms. It returns the identifier, name, and type of each defined route. The details of a route can be obtained with a `GET /ipLoadbalancing/{serviceName}/route/{type}/{routeId}` call defined below. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/definedRoutes -> +> -For more information on this call, please read the [Edit routes](#edit-routes){.internal} section at the bottom of this guide. +For more information on this call, we invite you to consult the section " [Route Handling](#handling-routes) ", at the bottom of this guide. -### Route configuration. +### Route configuration -With these basic principles around the action and rules available, and the order in which routes are evaluated, these routes can be edited the same way as the farms can. When you create a route, you can attach rules to it. The possible values for rules and actions are defined by the API calls. +With these basic principles on available actions and rules, and the route evaluation order, these routes can be manipulated in the same way as farms. When you create a route, you can attach rules to it. The possible values for the rules and actions are defined by the API calls. -For more information on these calls, please read the [Edit routes](#edit-routes){.internal} section at the bottom of this guide. +For more information on these methods, you can consult the section " [Route Handling](#handling-routes) ", at the bottom of this guide. ## Examples -If you still have doubts about the power of routes, this should change your mind. The purpose of this section is to offer some practical examples of how this technology has been used for OVH’s internal requirements, without going into great detail about API calls. +To demonstrate the utility of routes, this section will offer some practical examples of the use of this technology for OVHcloud's internal needs, without going into the details of the API calls. -You can read about API calls in more detail in the [Edit routes](#edit-routes){.internal} section at the bottom of this guide, and the sections that follow it. +You will find the details of the API calls in the section [Route Handling](#handling-routes), at the bottom of this guide and the following sections. -### Force HTTPS for WordPress login pages. +### Force HTTPS for WordPress login pages -HTTPS protocol has become the norm. Its purpose is to make all websites available securely in HTTPS, with the SSL/TLS protocol. If you need an SSL/TLS certificate, you can use the OVH Load Balancer service to order a new one, which will be automatically managed for you. +The HTTPS protocol has become the norm. Its objective is to make all websites available in HTTPS in a secure manner, thanks to the SSL/TLS protocol. If you need an SSL/TLS certificate, you can use your OVHcloud Load Balancer service to order a new one, which will be managed for you in a completely automatic way. -Migrating a website to HTTPS involves a lot of work, especially to avoid [mixed content](https://developer.mozilla.org/en-us/docs/Web/Security/Mixed_content). It may be worth migrating your website section by section, and starting by securing pages that send login credentials. +Migrating a website to HTTPS requires work, especially to avoid [Mixed-Content](https://developer.mozilla.org/en-us/docs/Web/Security/Mixed_content) problems. It may be interesting to migrate your website section by section, starting by securing the pages that send login credentials. -One approach could be to base it on the beginning of WordPress URLs. By default, the URL the login pages for WordPress start with "/wp-login". So we would need: +An approach could be to rely on the beginning of WordPress URLs. By default, the URLs of WordPress login pages start with "/wp-login". We would therefore need to: -- a route with a redirect action -- a rule in this route that detects URLs starting with "/wp-login" +- a route with a **redirection action**; +- a rule in this route that detects URLs starting with **"/wp-login"**. -In practice, this gives a route like this: +In practice, this gives a route as follows: -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|frontendId|Your HTTP front-end ID| -|displayName|“Redirection of WordPress logins to HTTPS”| -|weight|(empty)| -|action.type|"redirect"| -|action.status|302 for a temporary redirection, 301 for a permanent redirection| -|action.target|"`https://${host}${path}${arguments}`" to take the same host, path and arguments| +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| frontendId | Identifier of your HTTP frontend | +| displayName | "Redirect WordPress connections to HTTPS" | +| weight | (empty) | +| action.type | "redirect" | +| action.status | 302 for a temporary redirect, 301 for a permanent redirect | +| action.target | "`https://\${host}\${path}\${arguments}`" to take the same host, path and arguments | On this route, we will attach a rule: -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|routeId|Route ID created above| -|field|"uri"| -|subField|(empty)| -|match|"startswith"| -|negate|false| -|pattern|"/wp-login"| +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| routeId | Identifier of the route created above | +| field | "uri" | +| subField | (empty) | +| match | "startswith" | +| negate | false | +| pattern | "/wp-login" | -Next, apply the configuration to the zone concerned, and the rule will begin to work. +Then apply the configuration to the concerned area. > [!warning] > -> To add a new redirection, you will need to repeat these actions again, creating a route, then a rule. If a second rule is added to the same route, the two rules need to be validated for the redirect to work. Note that if the rules are "startswith /wp-login" and "startswith /wp-admin", the redirection would never work because these two conditions cannot both be true at once. -> +> To add a new redirection, you will have to repeat these actions, creating a route, then a rule. If a second rule is added to the same route, both rules must be validated for the redirection to work. Note that if the rules are `startswith /wp-login` and `startswith /wp-admin`, the redirection will never work because these two conditions cannot be true at the same time. +> -### Route according to a domain (vhost) +### Route based on a domain (VHost) -This feature helped propel the expansion of the web at its very early stages, by exposing several websites behind a single IP address using the “host” field of HTTP headers. +This is the feature that made the web possible when it was in its infancy, with the possibility of exposing several sites behind the same IP address thanks to the "Host" field of HTTP headers. -For example, if your infrastructure is made up of a VPS for your website, an OVH Load Balancer to ensure SSL/TLS termination, and redirection to a maintenance page with a backup server in the farms, you would originally have needed one Additional IP per website, routed to your OVH Load Balancer, and one front-end per IP. +For example, if your infrastructure is composed of a VPS for your website, an OVHcloud Load Balancer for SSL/TLS termination, and redirections to a maintenance page with a backup server in the farms, you would have needed an Additional IP per website, routed to your OVHcloud Load Balancer, and a frontend per IP in the past. -With routes, you can share the same front-end, and choose the server farm dynamically, with the “host” field. +With routes, you can share the same frontend and choose the server farm dynamically, thanks to the *[a-z]* field. -To do this, you will need: +For this, you will need: -- one route per vhost -- one rule per route detecting a specific domain +- a route per VHost; +- a rule per route detecting a specific domain. -In practice, to route the domain www.example.com, this would give the following route: +In practice, to route the domain **www.example.com**, this will give the following route: -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|frontendId|Your front-end ID| -|displayName|"VHost - www.example.com"| -|weight|(empty)| -|action.type|"farm"| -|action.status|(empty)| -|action.target|ID of the farm to direct this domain to| +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| frontendId | Identifier of your frontend | +| displayName | "VHost - www.example.com" | +| weight | (empty) | +| action.type | "farm" | +| action.status | (empty) | +| action.target | Identifier of the farm to which to direct this domain | And on this route, we will attach a rule: -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|routeId|Route ID created above| -|field|"host"| -|subField|(empty)| -|match|"is"| -|negate|false| -|pattern|"www.example.com" or a domain of your choice| +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| routeId | Identifier of the route created above | +| field | "host" | +| subField | (empty) | +| match | "is" | +| negate | false | +| pattern | "www.example.com" or a domain of your choice | Finally, apply the configuration. -### Reserve an Additional IP to a particular website. +### Reserve an Additional IP for a specific website -If you are hosting a website on a VPS, you may want to dedicate an IP address to a specific customer. You can easily make the IP available by routing it to your OVH Load Balancer service, then configuring a dedicated front-end attached to this Additional IP address, and having the customer’s target VPS set as a defaultFarmId. +If you host a website on a VPS, you might want to dedicate an IP address to a specific client. You can easily make the IP available by routing it to your OVHcloud Load Balancer service, then configuring a dedicated frontend attached to this Additional IP, and setting the client's target VPS as the `defaultFarmId`. -But what will happen if another customer detects this, and configures their domain to point to the premium customer’s IP address? By default, this will work, and its website will be routed to the other VPS. If there is an SSL/TLS certificate, it will still work as all of the certificates are automatically available for all of the front-ends. +However, what will happen if another client detects this and configures their domain to point to the premium client's IP? By default, this will work, and their website will be routed to another client's VPS. If an SSL/TLS certificate is present, this will still work, as all certificates are automatically available for all frontends. -In such scenarios, the solution is to add a rule that will reject requests if the domain is not a premium one. You can do this with a rejection route and a rule. +In such scenarios, the solution is to add a rule that **rejects requests if the domain is not a premium domain**. You can do this with a reject route and a rule. -In practice, to reserve a front-end with an IP dedicated to the domain www.example.com, this will give the following route: +In practice, to reserve a frontend with a dedicated IP for the domain **www.example.com**, this will give the following route: -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|frontendId|Your front-end ID| -|displayName|"Restrict to www.example.com"| -|weight|(empty)| -|action.type|"reject"| -|action.status|403| -|action.target|(empty)| +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| frontendId | Identifier of your frontend | +| displayName | "Restriction to www.example.com" | +| weight | (empty) | +| action.type | "reject" | +| action.status | 403 | +| action.target | (empty) | And on this route, we will attach a rule: -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|routeId|Route ID created above| -|field|"host"| -|subField|(empty)| -|match|"is"| -|negate|true| -|pattern|"www.example.com" or a domain of your choice| +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| routeId | Identifier of the route created above | +| field | "host" | +| subField | (empty) | +| match | "is" | +| negate | true | +| pattern | "www.example.com" or a domain of your choice | Finally, apply the configuration. -### Route depending on a URL and HTTP method. +### Route based on a URL and an HTTP method -On some specific infrastructures, certain requests need to be routed to a specific farm. For example, to manage rare but data-intensive requests without impacting production, such as analytical requests that would work from a read-only duplicate of the data with a server that has a higher volume of memory. +On some specific infrastructures, certain requests must be routed to a specific farm. For example, to handle rare but data-intensive requests without impacting production, such as analytical requests that work on a read-only copy of the data with a server having a higher memory volume. If, for example, the request is sent: -- with the POST method -- on a URL corresponding to "^/.\*/batch-analytics$" +- with the **POST** method; +- on a URL matching **"^/.*/batch-analytics$"**. -... you would need a route with two rules, with one rule using a regular expression. +Then, you would need a route with two rules, one of which uses a regular expression. -In practice, this gives a route like this: +In practice, this gives a route as follows: -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|frontendId|Your front-end ID| -|displayName|"Route batch analytics to dedicated farm"| -|weight|(empty)| -|action.type|"farm"| -|action.status|(empty)| -|action.target|ID of the farm to direct these operations to| +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| frontendId | Identifier of your frontend | +| displayName | "Route batch analytics to a dedicated farm" | +| weight | (empty) | +| action.type | "farm" | +| action.status | (empty) | +| action.target | Identifier of the farm to which to direct these operations | And on this route, we will attach two rules: -|Field|Rule 1|Rule 2| -|---|---|---| -|serviceName|Your OVH Load Balancer service ID|as per rule 1| -|routeId|Route ID created above|as per rule 1| -|field|"method"|"uri"| -|subField|(empty)|(empty)| -|match|"is"|"matches"| -|negate|false|false| -|pattern|"POST"|"^/.\*/batch-analytics$"| +| Field | Rule 1 | Rule 2 | +| :--- | :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | as for rule 1 | +| routeId | Identifier of the route created above | as for rule 1 | +| field | "method" | "uri" | +| subField | (empty) | (empty) | +| match | "is" | "matches" | +| negate | false | false | +| pattern | "POST" | "`^/.*/batch-analytics$`" | + +Here, the first rule applies to an enumeration. Only standard HTTP methods are available. The second rule, on the other hand, exploits the full power of routes by using a regular expression. Although it is possible to use such expressions, avoiding them results in enhanced performance. -Here, the first rule applies on a list. Only standard HTTP methods are available. However, the second rule uses all the power of routes using a regular expression. Although it is possible to use expressions like this, if you can go without using them, your performance will be even higher. +All that remains is to apply the configuration in the concerned area. -Next, apply the configuration to the zone concerned. +#### Route certain IPs and voluntary clients to preproduction -### Route certain IPs and voluntary clients to a pre-production environment. +When a site grows, you may want to set up a preproduction environment to validate ongoing changes, without affecting the majority of users. Generally, when configuring this type of environment, you want to reduce the gap as much as possible between production and preproduction, in order to detect problems as accurately as possible. A classic and often neglected source of problems is the domain name. It is sometimes hardcoded in a file or an article. At that point, a link may work in preproduction but not in production. -When your website gains momentum, you may want to set up a pre-production environment, which you can use to check ongoing developments without affecting the majority of your users. Generally, when you configure an environment like this, it is best to minimise the differences between production and pre-production as much as possible, so that any issues can be detected as accurately as possible. A common but often-forgotten issue is the domain name, as it is sometimes hard-coded into a file or item. If this is the case, the link may work in pre-production, but not in production. +Instead of setting up rules based on the domain name, you could set up rules based on the source IP address (for example, an enterprise proxy) and possibly a cookie for voluntary clients. These configurations can be detected with two routes on your OVHcloud Load Balancer service. -Instead of setting up rules based on the domain name, you can set up rules based on the source IP (e.g. an enterprise proxy), and possibly a cookie for voluntary clients. These configurations can be detected with two routes on the OVH Load Balancer service. +For this example, we will consider: -For this example, we will consider that: +- that the enterprise proxy can use the addresses 42.42.42.0/24 and the VPN uses 1.2.3.4/32; +- that the voluntary users have a "PreprodOptIn" cookie, the value of which is not important. -- the enterprise proxy can use the addresses 42.42.42.0/24, and that the VPN uses 1.2.3.4/32 -- the voluntary users have a "PreprodOptIn" cookie — it doesn’t matter what the value is +In practice, you will need two identical routes: -In practice, we would need two identical routes: +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| frontendId | Identifier of your frontend | +| displayName | "Route Opt-In and internal users to preproduction environment" | +| weight | (empty) | +| action.type | "farm" | +| action.status | (empty) | +| action.target | Identifier of the preproduction farm | -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|frontendId|Your front-end ID| -|displayName|"Route Opt-In and internal users to pre-production environment"| -|weight|(empty)| -|action.type|"farm"| -|action.status|(empty)| -|action.target|Your pre-production farm’s ID| +Next, we attach the following 2 rules, each on one of the routes (1 rule per route): -Then we will attach the following two rules to each of the routes (one rule per route): +| Field | Rule 1 | Rule 2 | +| :--- | :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | same | +| routeId | Identifier of the first route | Identifier of the second route | +| field | "source" | "cookie" | +| subField | (empty) | "PreprodOptIn" | +| match | "in" | "exists" | +| negate | false | false | +| pattern | "42.42.42.0/24, 1.2.3.4" | (empty) | -|Field|Rule 1|Rule 2| -|---|---|---| -|serviceName|Your OVH Load Balancer service ID|as per rule 1| -|routeId|ID of the first route|ID of the second route| -|field|"source"|"cookie"| -|subField|(empty)|"PreprodOptIn"| -|match|"in"|"exists"| -|negate|false|false| -|pattern|"42.42.42.0/24, 1.2.3.4"|(empty)| +The first rule checks if the source IP is in a list of address ranges. In this case, the different address ranges are separated by commas and can be surrounded by spaces for better readability. If a range contains only one address, the "/32" is implicit but can be added explicitly. In any case, the size of this field is limited to 255 characters. -The first rule tests whether the source IP is in the address range list. In this case, the various address ranges are separated by commas, and can have spaces in between one another to make them easier to read. If the range only contains one address, the "/32" is implicit, but can be added explicitly. Either way, this field is limited to 255 characters. +The second rule simply checks the existence of the cookie. It would be possible to check if its value matches a regular expression or is in a list of possibilities, but this allows to show a simple example of what can be done with cookies. Rules based on HTTP Headers work according to a similar approach. -The second rule simply tests to see if a cookie exists. It is also possible to test if the value corresponds to a regular expression, or is found in a possibility list, but this offers a simple example of what you can do with cookies. Rules based on HTTP headers work using a similar approach. +All that remains is to apply the configuration in the concerned area. -Next, apply the configuration to the zone concerned. +#### Route WebSockets to a dedicated farm -### Route WebSockets to a dedicated farm. +When a site has interactive functions based on WebSockets such as a chatbot, you may want to direct these connections to a server farm dedicated to this task. In fact, it is quite simple.W -When a website has interactive features based on WebSockets — a chatbot, for example — you may want to direct these connections to a server farm dedicated to this task. This is actually quite simple. When a browser attempts to open a WebSockets connection, it sends a standard HTTP request with these headers: +When a browser tries to open a WebSocket connection, it sends a standard HTTP request with the headers: ``` Upgrade: websocket Connection: Upgrade ``` -In this case, only the first header needs to be detected. This can be done very easily with a route and a rule: +In practice, it is sufficient to detect the first header. This can be done very easily with a route and a rule: -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|frontendId|Your front-end ID| -|displayName|"Route WebSockets to a dedicated farm"| -|weight|(empty)| -|action.type|"farm"| -|action.status|(empty)| -|action.target|ID of the farm dedicated to WebSockets| +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| frontendId | Identifier of your frontend | +| displayName | "Route WebSockets to a dedicated farm" | +| weight | (empty) | +| action.type | "farm" | +| action.status | (empty) | +| action.target | Identifier of the WebSocket dedicated farm | -And on this route, we will attach a rule: +And on this route, we come to attach a rule: + +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| routeId | Identifier of the route created just above | +| field | "header" | +| subField | "Upgrade" | +| match | "is" | +| negate | false | +| pattern | "websocket" (case-sensitive) | -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|routeId|Route ID created above| -|field|"header"| -|subField|"Upgrade"| -|match|"is"| -|negate|false| -|pattern|"websocket" (case-sensitive)| +All that remains is to apply the configuration in the relevant zone. -Next, apply the configuration to the zone concerned. -## Reference. +### References -Here, you will find more details on the API calls linked to the routes. To get a general idea of how routes work, we recommend starting off by reading the [introduction to the API](#an-introduction-to-the-api){.internal} section further up. +You will find here the details of the API calls related to routes. For a more general overview of route features, we invite you to first consult the section " [API presentation](#apipresentation) " a little further up in this guide. -### Edit routes. +#### Handling routes -TCP and HTTP routes are configured the same way. Since the routes are more powerful in HTTP, this section focuses on HTTP rules and routes. TCP routes can be extrapolated from the information below by replacing “http” with “tcp” in each route. Some fields only apply to HTTP routes, and are not available in TCP. +TCP and HTTP routes are configured in the same way. Since HTTP routes are more powerful, this section focuses on HTTP routes and rules. The operation of TCP routes can be extrapolated by replacing "http" with "tcp" in the routes. Some fields only make sense in HTTP, so they are not available in TCP. -#### List the routes. +##### **List routes** -This call returns the list of ID numbers of routes defined for HTTP protocol. You can filter this list by frontendId. This call returns the routes in the order in which they will be evaluated. The evaluation order can be partially controlled by the weight of the route. +This call returns the list of numeric identifiers of routes defined for the HTTP protocol. You can filter this list by `frontendId`. This call returns the routes in the order in which they will be evaluated. The evaluation order can be partially controlled using the "weight" of the route. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route -> +> -|Setting|Required|Meaning| -|---|---|---| -|serviceName|Required|Your Load Balancer service ID| -|frontendId||ID number of a HTTP front-end the routes are attached to| +| Parameter | Required | Meaning | +| :--- | :--- | :--- | +| serviceName | Required | Identifier of your Load Balancer service | +| frontendId | | Numeric identifier of an HTTP frontend to which the routes are attached | -#### Create a route. +##### **Create a route** -With this call, you can create a route. Only the action is mandatory. A route can be attached to and detached from a front-end. You can create up to 50 routes on an OVH Load Balancer. This call returns the route created, if it is successful. You will need to re-deploy your OVH Load Balancer to apply the changes. +This call allows you to create a route. Only the action is mandatory. A route can be attached and detached from a frontend. It is possible to create up to 50 routes on an OVHcloud Load Balancer service. This call returns the created route in case of success. Your OVHcloud Load Balancer service must be redeployed to apply the changes. > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route -> +> -|Setting|Required|Meaning| -|---|---|---| -|serviceName|Required|Your Load Balancer service ID| -|displayName||Display name for your route (255 characters maximum)| -|frontendId||ID number of a HTTP front-end to attach the route to| -|weight||Route priority, between 1 (carry out first) and 255 (carry out after the others)| -|action.type|Required|Name of the action type to execute if all of the rules associated with the route are validated| -|action.status||HTTP status code for `reject` and `redirect` actions| -|action.target||ID number of the target farm for `farm` actions, or the URL template for `redirect` actions| +| Parameter | Required | Meaning | +| :--- | :--- | :--- | +| serviceName | Required | Identifier of your Load Balancer service | +| displayName | | Display name of your route (maximum 255 characters) | +| frontendId | | Numeric identifier of an HTTP frontend to which to attach the route | +| weight | | Priority of the route, between 1 (passes first) and 255 (passes after others) | +| action.type | Required | Name of the type of action to execute if all the rules associated with the route are validated | +| action.status | | HTTP status code for the `reject` and `redirect` actions | +| action.target | | Numeric identifier of the target farm for the `farm` actions, or URL pattern for the `redirect` actions | -The possible action types are listed below: +The possible action types are: -|action|Meaning| -|---|---| -|redirect|Redirects a request to `action.target`, with the HTTP `action.status` code| -|reject|Rejects a request with the HTTP `action.status` code| -|farm|Routes a request to the farm with the ID entered in `action.target`| +| action | Meaning | +| :--- | :--- | +| redirect | Redirect a request to `action.target` with the HTTP status code `action.status` | +| reject | Reject a request with the HTTP status code `action.status` | +| farm | Route a request to the farm whose identifier is specified in `action.target` | -For further information on the actions managed and the format of parameters, please read the [Available actions](#available-actions){.internal} section further down. +For more information on the actions handled and the format of the parameters, we invite you to consult the section " [Available actions](#available-actions) " further down in this guide. -#### View details on a route. +##### **View the details of a route** -With this call, you can view details on an HTTP route if you know its ID. +This call allows you to view the details of an HTTP route, knowing its identifier. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId} -> +> -Query +- Request: -|Setting|Meaning| -|---|---| -|serviceName|Your Load Balancer service ID| -|routeId|The route’s ID number| +| Parameter | Meaning | +| :--- | :--- | +| serviceName | Identifier of your Load Balancer service | +| routeId | Numeric identifier of the route | -Answer +- Response: -|Setting|Meaning| -|---|---| -|routeId|The route’s ID number| -|displayName|The display name for your route| -|frontendId|ID number of the front-end your route is attached to| -|weight|Priority of your route| -|action.type|Name of the action type for your route| -|action.status|Associated HTTP status code| -|action.target|ID number of the associated farm or URL template| -|rules|List of rules that must be validated to trigger the route’s action More detail on this is available in the [Edit rules](#edit-rules){.internal} section.| +| Parameter | Meaning | +| :--- | :--- | +| routeId | Numeric identifier of the route | +| displayName | Display name of your route | +| frontendId | Numeric identifier of the frontend to which your route is attached | +| weight | Priority of your route | +| action.type | Name of the type of action of your route | +| action.status | Associated HTTP status code | +| action.target | Numeric identifier of the farm or associated URL pattern | +| rules | List of rules that must be validated to trigger the action of the route. More details are available in the section " [Handling Rules](#handling-rules) ". | -For further information on the actions managed and the format of parameters, please read the [Available actions](#available-actions){.internal} section further down. +For more information on the actions handled and the format of the parameters, we invite you to consult the section "[Available actions](#available-actions)" further down in this guide. -#### Modify a route. +##### **Modify a route** -With this call, you can modify an HTTP route if you know its ID. You will need to re-deploy your OVH Load Balancer to apply the changes. +This call allows you to modify an HTTP route, knowing its identifier. Your OVHcloud Load Balancer service must be redeployed to apply the changes. > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId} > -|Setting|Required|Meaning| -|---|---|---| -|serviceName|Required|Your Load Balancer service ID| -|routeId|Required|The route’s ID number| -|displayName||Display name for your route (255 characters maximum)| -|frontendId||ID number of a HTTP front-end to attach the route to| -|weight||Route priority, between 1 (carry out first) and 255 (carry out after the others)| -|action.type|Required|Name of the action type to execute if all of the rules associated with the route are validated| -|action.status||HTTP status code for `reject` and `redirect` actions| -|action.target||ID number of the target farm for `farm` actions, or the URL template for `redirect` actions| +| Parameter | Required | Meaning | +| :--- | :--- | :--- | +| serviceName | Required | Identifier of your Load Balancer service | +| routeId | Required | Numeric identifier of the route | +| displayName | | Display name of your route (maximum 255 characters) | +| frontendId | | Numeric identifier of an HTTP frontend to which to attach the route | +| weight | | Priority of the route, between 1 (passes first) and 255 (passes after others) | +| action.type | Required | Name of the type of action to execute if all the rules associated with the route are validated | +| action.status | | HTTP status code for the `reject` and `redirect` actions | +| action.target | | Numeric identifier of the target farm for the `farm` actions, or URL pattern for the `redirect` actions | -For further information on the actions managed and the format of parameters, please read the [Available actions](#available-actions){.internal} section further down. +For more information on the actions handled and the format of the parameters, we invite you to consult the section " [Available actions](#available-actions) " further down in this guide. -#### Delete a route. +##### **Delete a route** -With this call, you can delete an HTTP route if you know its ID. When a route is deleted, all of the rules associated with the route are deleted, too. You do not need to delete them individually. You will need to re-deploy your OVH Load Balancer to apply the changes. +This call allows you to delete an HTTP route, knowing its identifier. When a route is deleted, all the rules associated with that route are also deleted. There is no need to delete them individually. Your OVHcloud Load Balancer service must be redeployed to apply the changes. > [!api] > > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId} -> +> -|Setting|Required|Meaning| -|---|---|---| -|serviceName|Required|Your Load Balancer service ID| -|routeId|Required|The route’s ID number| +| Parameter | Required | Meaning | +| :--- | :--- | :--- | +| serviceName | Required | Identifier of your Load Balancer service | +| routeId | Required | Numeric identifier of the route | -### Edit rules. +#### Handling rules -#### List the rules. +##### **List rules** -This call returns the list of ID numbers of rules defined for a particular route. +This call returns the list of numeric identifiers of rules defined for a given route. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule -> +> -|Setting|Required|Meaning| -|---|---|---| -|serviceName|Required|Your Load Balancer service ID| -|routeId|Required|The route’s ID number| +| Parameter | Required | Meaning | +| :--- | :--- | :--- | +| serviceName | Required | Identifier of your Load Balancer service | +| routeId | Required | Numeric identifier of the route | -#### Attach a rule. +##### **Attach a rule** -With this call, you can attach a rule to a route. You can attach up to 5 rules per route on an OVH Load Balancer. This call returns the route created, if it is successful. You will need to re-deploy your OVH Load Balancer to apply the changes. +This call allows you to attach a rule to a route. It is possible to attach up to 5 rules per route on an OVHcloud Load Balancer service. This call returns the created rule in case of success. Your OVHcloud Load Balancer service must be redeployed to apply the changes. > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule -> - -|Setting|Required|Meaning| -|---|---|---| -|serviceName|Required|Your Load Balancer service ID| -|routeId|Required|The route’s ID number| -|field|Required|The name of the HTTP parameter to apply the rule to| -|subField||HTTP header name for the `header` rules, or cookie name for `cookie` rules| -|match|Required|Name of the comparison to apply to validate the rule| -|negate||Reverses the comparison result| -|pattern||Comparison pattern| - -`field` - -|Value|Meaning| -|---|---| -|source|The address or list of source IP addresses (a.b.c.d/z)| -|protocol|Protocol (“http” or “https”)| -|method|HTTP method (GET, HEAD, POST, PUT, DELETE, OPTIONS, CONNECT, TRACE)| -|host|Domain name (vhost), without the port number| -|uri|Path of the request as it appears between the first "/" and the last "?"| -|param|HTTP parameter contained in the part after the first "?"| -|header|HTTP header| -|cookie|HTTP cookie| - -`match` - -|Value|Meaning| -|---|---| -|exists|The property must exist (e.g. HTTP header or cookie)| -|-|The property must correspond exactly to a `pattern`| -|in|The property must be in the list of values (separated by commas) defined by `pattern`| -|contains|The property must contain the `pattern` value| -|startswith|The property must start with the `pattern` value| -|endswith|The property must end with the `pattern` value| -|matches|The property must match the regular `pattern` expression| - -For further information on the rules managed and the format of parameters, please read the [Available rules](#available-rules){.internal} section further down. - -#### View details on a rule. - -With this call instruction, you can view the details on a rule attached to an HTTP route if you know its ID. +> + +| Parameter | Required | Meaning | +| :--- | :--- | :--- | +| serviceName | Required | Identifier of your Load Balancer service | +| routeId | Required | Numeric identifier of the route | +| field | Required | Name of the HTTP parameter on which to apply this rule | +| subField | | Name of the HTTP header for `header` rules or name of the cookie for `cookie` rules | +| match | Required | Name of the comparator to apply to validate the rule | +| negate | | Inverts the result of the comparator | +| pattern | | Comparator argument | + +- `field` + +| Value | Meaning | +| :--- | :--- | +| source | Address or list of source addresses in the form of IP (a.b.c.d/z) | +| protocol | Protocol. "http" or "https" | +| method | HTTP method (GET, HEAD, POST, PUT, DELETE, OPTIONS, CONNECT, TRACE) | +| host | Domain name (vhost), without the port number | +| uri | Request path as understood between the first "/" and the first "?" | +| param | HTTP parameter coming from the part after the first "?" | +| header | HTTP header | +| cookie | HTTP cookie | + +- `match` + +| Value | Meaning | +| :--- | :--- | +| exists | The property must exist (HTTP header or cookie for example) | +| is | The property must match exactly `pattern` | +| in | The property must be in the list of values (separated by commas) defined by `pattern` | +| contains | The property must contain the value of `pattern` | +| startswith | The property must start with the value of `pattern` | +| endswith | The property must end with the value of `pattern` | +| matches | The property must match the regular expression of `pattern` | + +For more information on the rules handled and the format of the parameters, we invite you to consult the section " [Available rules](#available-rules) " further down in this guide. + +##### **View the details of a rule** + +This call allows you to view the details of a rule attached to an HTTP route, knowing its identifier. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId} -> +> -Query +- Request: -|Setting|Meaning| -|---|---| -|serviceName|Your Load Balancer service ID| -|routeId|The route’s ID number| -|ruleId|The rule’s ID number| +| Parameter | Meaning | +| :--- | :--- | +| serviceName | Identifier of your Load Balancer service | +| routeId | Numeric identifier of the route | +| ruleId | Numeric identifier of the rule | -Answer +- Response: -|Setting|Meaning| -|---|---| -|ruleId|The rule’s ID number| -|field|Name of the HTTP parameter to apply the rule on| -|subField|Name of the HTTP header or cookie for the rule| -|match|Name of the comparison to apply to validate the rule| -|negate|"true" if the comparison result is reversed| -|pattern|Comparison argument. The direction and syntax depends on the `match` and the `field`.| +| Parameter | Meaning | +| :--- | :--- | +| ruleId | Numeric identifier of the rule | +| field | Name of the HTTP parameter on which to apply the rule | +| subField | Name of the HTTP header or cookie for the rule | +| match | Name of the comparator to apply to validate the rule | +| negate | "true" if the result of the comparator is inverted | +| pattern | Comparator argument. The meaning and syntax depend on `match` and `field` | -For further information on the rules managed and the format of parameters, please read the [Available rules](#available-rules){.internal} section further down. +For more information on the rules handled and the format of the parameters, we invite you to consult the section " [Available rules](#available-rules) " further down in this guide. -#### Modify a rule. +##### **Modify a rule** -With this call, you can modify a rule attached to an HTTP route if you know its ID. You will need to re-deploy your OVH Load Balancer to apply the changes. +This call allows you to modify a rule attached to an HTTP route, knowing its identifier. Your OVHcloud Load Balancer service must be redeployed to apply the changes. > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId} -> +> -|Setting|Required|Meaning| -|---|---|---| -|serviceName|Required|Your Load Balancer service ID| -|routeId|Required|The route’s ID number| -|ruleId|Required|The rule’s ID number| -|field|Required|The name of the HTTP parameter to apply the rule to| -|subField||HTTP header name for the `header` rules, or cookie name for `cookie` rules| -|match|Required|Name of the comparison to apply to validate the rule| -|negate||Reverses the comparison result| -|pattern||Comparison pattern| +| Parameter | Required | Meaning | +| :--- | :--- | :--- | +| serviceName | Required | Identifier of your Load Balancer service | +| routeId | Required | Numeric identifier of the route | +| ruleId | Required | Numeric identifier of the rule | +| field | Required | Name of the HTTP parameter on which to apply this rule | +| subField | | Name of the HTTP header for `header` rules or name of the cookie for `cookie` rules | +| match | Required | Name of the comparator to apply to validate the rule | +| negate | | Inverts the result of the comparator | +| pattern | | Comparator argument | -For further information on the rules managed and the format of parameters, please read the [Available rules](#available-rules){.internal} section further down. +For more information on the rules handled and the format of the parameters, we invite you to consult the section " [Available rules](#available-rules) " further down in this guide. -#### Delete a rule. +##### **Delete a rule** -With this call, you can delete a rule attached to an HTTP route if you know its ID. You will need to re-deploy your OVH Load Balancer to apply the changes. +This call allows you to delete a rule attached to an HTTP route, knowing its identifier. Your OVHcloud Load Balancer service must be redeployed to apply the changes. > [!api] > > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId} -> +> -|Setting|Required|Meaning| -|---|---|---| -|serviceName|Required|Your Load Balancer service ID| -|routeId|Required|The route’s ID number| -|ruleId|Required|The rule’s ID number| +| Parameter | Required | Meaning | +| :--- | :--- | :--- | +| serviceName | Required | Identifier of your Load Balancer service | +| routeId | Required | Numeric identifier of the route | +| ruleId | Required | Numeric identifier of the rule | > [!primary] > -> If you want to delete a route, you do not need to delete all the rules attached to it. The rules are automatically deleted when you delete the route. -> +> If you want to delete a route, it is not necessary to delete all the rules attached to it. The rules are automatically deleted when you delete a route. +> -#### List all of the TCP and HTTP routes. +##### **List all TCP and HTTP routes** -With this call, you can get a list of all the IDs, display names and types ("http"/"tcp") of routes defined on an OVH Load Balancer service. It is designed to simplify the implementation of auto-completion. +This call allows you to list all the identifiers, display names and types ("http"/"tcp") of routes defined on an OVHcloud Load Balancer service. It was designed to simplify the implementation of auto-completion. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/definedRoutes -> +> -Query +- Request: -|Setting|Meaning| -|---|---| -|serviceName|Your Load Balancer service ID| +| Parameter | Meaning | +| :--- | :--- | +| serviceName | Identifier of your Load Balancer service | -Answer +- Response: -|Setting|Meaning| -|---|---| -|type|Type of protocol for the route: "tcp" for TCP routes, "http" for HTTP routes| -|routeId|The route’s ID number| -|displayName|The display name of the route| +| Parameter | Meaning | +| :--- | :--- | +| type | Type of protocol of the route: "tcp" for TCP routes, "http" for HTTP routes | +| routeId | Numeric identifier of the route | +| displayName | Display name of the route | -### Actions available +#### Available actions -This call returns the list of actions available for TCP and HTTP routes, as well as the values expected for each of the fields. +This call returns the list of available actions for TCP and HTTP routes as well as the expected values for each of the fields. -If a field is “null”, this means that no value is expected. If an invalid value is entered, the API will return a validation error. +If a field is "null", it means that no value is expected. If an invalid value is provided, the API will return a validation error. -All of the actions managed by the OVH Load Balancer service are final. This means that executing an action also triggers the end of route evaluation. +All actions managed by the OVHcloud Load Balancer service are final. This means that the execution of an action also ends the evaluation of the routes. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteActions -> +> -Query +- Request: -|Setting|Meaning| -|---|---| -|serviceName|Your Load Balancer service ID| +| Parameter | Meaning | +| :--- | :--- | +| serviceName | Identifier of your Load Balancer service | -Answer +- Response: -|Setting|Meaning| -|---|---| -|type|Shows if this action is valid for a HTTP or a TCP route| -|name|Name of the action to enter into the `type` field of routes| -|status|List of HTTP status codes available for this action (`status` fields of routes)| -|destination|Value type expected in the `destination` fields for routes| +| Parameter | Meaning | +| :--- | :--- | +| type | Indicates whether this action is valid for an HTTP route or a TCP route | +| name | Name of the action to specify in the `type` field of the routes | +| status | List of available HTTP status codes for this action (the `status` field of the routes) | +| destination | Type of value expected in the `destination` field of the routes | -#### Redirection +##### **Redirection** -This action sends a redirection to the visitor. This redirection type can be configured with the status field. When this action is selected, no farms will receive the request. +This action returns a redirection to the visitor. The type of redirection can be configured with the `status` field. When this action is selected, no farm will receive the request. -|Setting|Value| -|---|---| -|type|`redirect`| -|status|301, 302, 303, 307 or 308| -|target|Target URL (may contain variables)| +| Parameter | Value | +| :--- | :--- | +| type | `redirect` | +| status | 301, 302, 303, 307 or 308 | +| target | Destination URL (can contain variables) | -Only the HTTP redirection status codes can be specified. The most common codes are 301 and 302. If you have any doubts, you can set up a 302 (temporary redirection). The HTTP status codes for redirections are: +Only HTTP redirection status codes can be specified. The most common are codes 301 and 302. If you are unsure, you can use the 302 "Temporary Redirect". The HTTP status codes recognized for redirections are: -|Status code|Description| -|---|---| -|301|Permanent redirection. The redirection can be saved by the browser.| -|302 (default)|Temporary redirection. The redirection must be revalidated for each request by the browser.| -|303|Works like a 302, and forces the use of the HTTP GET method.| -|307|Works like a 302, and forces the same HTTP method to be reused (GET, POST, etc.).| -|308|Works like a 301, and forces the same HTTP method to be reused (GET, POST, etc.).| +| Status code | Description | +| :--- | :--- | +| 301 | Permanent redirect. The redirect can be stored by the browser. | +| 302 (default) | Temporary redirect. The redirect must be revalidated by the browser on each request. | +| 303 | Like 302 and forces the use of the HTTP GET method. | +| 307 | Like 302 and forces the reuse of the same HTTP method (GET, POST, etc.). | +| 308 | Like 301 and forces the reuse of the same HTTP method (GET, POST, etc.). | -The target URL may contain simple variables. This helps users redirect to another domain, another protocol or add a suffix/prefix to a URL. The recognised variables are: +The destination URL can contain simple variables. This allows you to redirect to another domain, another protocol or add a suffix / prefix to a URL. The recognized variables are: -|Variable|Description| -|---|---| -|`protocol`|Protocol of the request ("http" or "https")| -|`domain`|Domain name of the request, without the port number| -|`host`|"Host" field of the request, including the port number, if there is one| -|`port`|Port of the request| -|`path`|Path of the request, starts with a '/' and ends before the first '?'| -|`arguments`|Arguments of the request, starts with a '?' if present| +| Variable | Description | +| :--- | :--- | +| `protocol` | Protocol of the request ("http" or "https") | +| `domain` | Domain name of the request, without the port number | +| `host` | "Host" field of the request, including the port number if present | +| `port` | Port of the request | +| `path` | Path of the request, starts with a '/' and ends at the first '?' | +| `arguments` | Arguments of the request, starts with a '?' if present | -For example, for: +For example, to: -- redirect to https: `https://${host}${path}${arguments}` -- redirect to a new domain: ${protocol}://new.example.com${path}${arguments} -- prefix the URL: ${protocol}://${host}/staging${path}${arguments} +- redirect to https: `https://\${host}\${path}\${arguments}` +- redirect to a new domain: `${protocol}://new.example.com\${path}\${arguments}` +- prefix the URL: `${protocol}://\${host}/staging\${path}\${arguments}` -#### Reject. +##### **Rejection** -This action returns an HTTP error status code to the visitor. The HTTP error code can be configured with the status field. When this action is selected, no farms will receive the request. +This action returns an HTTP error status code to the visitor. The error HTTP status code can be configured with the `status` field. When this action is selected, no farm will receive the request. -|Setting|Value| -|---|---| -|type|`reject`| -|status|200, 400, 403, 405, 408, 429, 500, 502, 503 or 504| -|target|not available| +| Parameter | Value | +| :--- | :--- | +| type | `reject` | +| status | 200, 400, 403, 405, 408, 429, 500, 502, 503 or 504 | +| target | not available | > [!primary] > -> This action is also available in TCP. In this case, the parameter status is not available, and the request is terminated. TCP requests that are terminated like this are not compatible with high percentages of requests. -> +> This action is also available in TCP. In this case, the `status` parameter is not available and the request is terminated. TCP requests terminated in this way are not counted in the request rate. +> -Only the HTTP error codes listed in the API can be specified. The most common ones are 400 ("Bad request") errors, and 403 ("Forbidden") errors. A 200 code can be used to block a request type while simulating a success, and a 503 code can be used to simulate a server outage. +Only the HTTP error status codes listed in the API can be specified. The most common are the codes 400 "Bad request" and 403 "Forbidden". 200 can be used to block a type of request while simulating a success, and 503 can be used to simulate a server failure. -|Status code|Description| -|---|---| -|200|The request has been successfully executed.| -|400|Invalid request.| -|403 (default)|Access forbidden.| -|405|Method (GET, POST, PUT, ...) invalid or not managed.| -|408|The request has taken too long to be sent by the client.| -|429|The client has sent too many requests (rate limiting).| -|500|Generic server error.| -|502|Error communicating with the server.| -|503|The service is temporarily unavailable.| -|504|The server has taken too much time to respond.| +| Status code | Description | +| :--- | :--- | +| 200 | The request was executed successfully. | +| 400 | Invalid request. | +| 403 (default) | Access forbidden. | +| 405 | Invalid or unhandled method (GET, POST, PUT, etc.) +| 408 | The client failed to send a complete request within the server's time limit. | +| 429 | The client sent too many requests (rate-limiting). | +| 500 | Generic server error. | +| 502 | Communication error with the server. | +| 503 | The service is temporarily unavailable. | +| 504 | The server took too long to respond. | -#### Routing. +##### **Routing** -This action redirects requests to a specific farm, other than the default farm configured on the front-end. The destination farm must be the same type as the front-end ("http" or "tcp"). +This action directs requests to a specific farm, other than the default farm configured on the frontend. The target farm must be of the same type as the frontend ("http" or "tcp"). -|Setting|Value| -|---|---| -|type|`farm`| -|status|not available| -|target|The destination farm’s ID number. This must be the same type.| +| Parameter | Value | +| :--- | :--- | +| type | `farm` | +| status | not available | +| target | Numeric identifier of the target farm. This must be of the same type | > [!primary] > -> This action is also available in TCP. In this case, the destination farm type must be "tcp". -> +> This action is also available in TCP. In this case, the target farm must be of type "tcp". +> -### Available rules. +#### Available rules -This call returns the list of rules available for TCP and HTTP routes, as well as the values expected for each of the fields. +This call returns the list of available rules for TCP and HTTP routes, as well as the expected values for each field. -If a field is “null”, this means that no value is expected. If an invalid value is entered, the API will return a validation error. +If a field is "null", it means no value is expected. If an invalid value is provided, the API will return a validation error. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteRules -> +> -Query +- Request: -|Setting|Meaning| -|---|---| -|serviceName|Your Load Balancer service ID| +| Parameter | Meaning | +| :--- | :--- | +| serviceName | Identifier of your Load Balancer service | -Answer +- Response: -|Setting|Meaning| -|---|---| -|type|Type of protocol for the route: "tcp" for TCP routes, "http" for HTTP routes| -|name|Name of the property on which to apply this rule, to be entered into the `field` field| -|hasSubField|"true" is this property is a sub-property (e.g. a header or cookie)| -|matches|List of comparisons available for each rule, to be entered into the `match` field| -|pattern|Type of value expected for the `pattern` field| -|enum|List of values for the chmaps `pattern`, if it is a list| +| Parameter | Meaning | +| :--- | :--- | +| type | Protocol type of the route: "tcp" for TCP routes, "http" for HTTP routes | +| name | Name of the property to which this rule applies, to be filled in the `field` field | +| hasSubField | "true" if this property has a "sub-property" (e.g.: a header or a cookie) | +| matches | List of available comparators for this rule, to be filled in the `match` field | +| pattern | Type of expected value for the `pattern` field | +| enum | List of possible values for the `pattern` field if it is an enumeration | -The different `pattern` types are: +The different types of `pattern` are: -|Value|Meaning| -|---|---| -|cidr|IP address (a.b.c.d) or sub-network (a.b.c.d/z)| -|string|Free text. For the `in` operator, a list of values separated by columns (255 characters maximum)| -|enum|The field is a list defined in `enum`| +| Value | Meaning | +| :--- | :--- | +| cidr | IP address (a.b.c.d) or subnet (a.b.c.d/z) | +| string | Free text. For the operator `in`, a list of comma-separated values (maximum 255 characters) | +| enum | The field is an enumeration defined in `enum` | -#### Protocol. +##### **Protocol** -With this rule, you can filter requests depending on their protocol. In practice, the uses for this rule are quite limited, as the protocol depends on the front-end that the route is attached to, or a front-end that only manages a single protocol recognised the moment the route is defined. +This rule allows filtering requests based on their protocol. In practice, the use cases for this rule are quite limited because the protocol depends on the frontend to which the route is attached, and a frontend only handles one protocol, which is known at the time the route is defined. -|Fields|Value| -|---|---| -|name|`protocol`| -|hasSubField|no| -|matches|`is` or `in`| -|pattern|`tcp`, `tls`, `http` or `https`| +| Field | Value | +| :--- | :--- | +| name | `protocol` | +| hasSubField | no | +| matches | `is` or `in` | +| pattern | `tcp`, `tls`, `http` or `https` | > [!primary] > -> This action is also available in TCP. In this case, "http/2.0" protocol is also available. It is based on the "ALPN" SSL/TLS field used by browsers to announce that they are attempting to establish a HTTP/2.0 connection. This way, you can have a common TCP front-end for SSL/TLS termination of HTTP 1 and 2, then direct traffic depending on the protocol version. -> +> This action is also available in TCP. In this case, the "http/2.0" protocol is also available. It is based on the SSL/TLS "ALPN" field used by browsers to announce that they are trying to establish an HTTP/2.0 connection. This allows for a common TCP frontend for HTTP 1 and 2 SSL/TLS termination, then routing these streams based on the protocol version. +> -#### Source address. +##### **Source address** -With this rule, you can filter requests depending on their source address. By combining it with a rule based on the URI or the domain name, you can restrict certain resources to an enterprise proxy while exposing all of your other resources without restrictions, via your OVH Load Balancer. +This rule allows filtering requests based on their source address. By combining it with a rule based on the URI or domain name, it is for example possible to restrict certain resources to an enterprise proxy, while exposing all other resources without restrictions on your OVHcloud Load Balancer service. -|Fields|Value| -|---|---| -|name|`source`| -|hasSubField|no| -|matches|`is` or `in`| -|pattern|Sub-network (a.b.c.d/z) or address (a.b.c.d)| +| Field | Value | +| :--- | :--- | +| name | `source` | +| hasSubField | no | +| matches | `is` or `in` | +| pattern | Subnet (a.b.c.d/z) or address (a.b.c.d) | > [!primary] > -> This action is also available in TCP using the same method. -> +> This action is also available in TCP with the same behavior. +> -To block a particular network and address, for example, you can use a pattern like "4.4.0.0/16, 8.8.8.8". +For example, to block a network and a specific address, you can use a pattern such as "4.4.0.0/16, 8.8.8.8". -#### Domain name. +##### **Domain name** -With this rule, you can filter requests depending on their domain name. In doing so, you can reproduce the Apache "vhost" feature, or route all of the domains that start with "mail." to a server dedicated to webmail. +This rule allows filtering requests based on their domain name. This can for example be used to reproduce the "vhost" function of Apache or to route all domains starting with "mail." to a server dedicated to webmail. -|Fields|Value| -|---|---| -|name|`host`| -|hasSubField|no| -|matches|`is`, `in`, `contains`, `startswith`, `endswith` or `matches`| -|pattern|Character chain or regular expression| +| Field | Value | +| :--- | :--- | +| name | `host` | +| hasSubField | no | +| matches | `is`, `in`, `contains`, `startswith`, `endswith` or `matches` | +| pattern | String or regular expression | > [!primary] > -> This action is also available in TCP. It will only work if the front-end is configured to accept SSL/TLS connections, and if the client sends an "SNI" option. This is especially the case with recent web browsers. -> +> This action is also available in TCP. It is only applicable if the frontend is configured to accept SSL/TLS connections and the client sends an "SNI" option. This is particularly the case for recent web browsers. +> -#### HTTP method. +##### **HTTP method** -With this rule, you can filter requests depending on their HTTP method. It is commonly used alongside a rule based the request URI or path, to make the rule more selective. +This rule allows filtering requests based on the HTTP method. It is commonly used in conjunction with a rule based on the request URI or path to make the rule more selective. -|Fields|Value| -|---|---| -|name|`method`| -|hasSubField|no| -|matches|`is` or `in`| -|pattern|`GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS` or `TRACE`| +| Field | Value | +| :--- | :--- | +| name | `method` | +| hasSubField | no | +| matches | `is` or `in` | +| pattern | `GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS` or `TRACE` | -#### Request path. +##### **Request path** -With this rule, you can filter requests depending on their path, or URI. The request path is between the first '/' (inclusive) and the first '?' (excluded). +This rule allows filtering requests based on the request path or URI. The request path is the part between the first '/' included and the first '?' excluded. -|Fields|Value| -|---|---| -|name|`uri`| -|hasSubField|no| -|matches|`is`, `in`, `contains`, `startswith`, `endswith` or `matches`| -|pattern|Character chain or regular expression| +| Field | Value | +| :--- | :--- | +| name | `uri` | +| hasSubField | no | +| matches | `is`, `in`, `contains`, `startswith`, `endswith` or `matches` | +| pattern | String or regular expression | -#### Request parameter. +##### **Request parameter** -This rule filters requests depending on their existence, or the value of a specific HTTP request parameter. This is the part after the first '?'. If a parameter is specified several times in a request, only the first instance is taken into account. +This rule allows filtering requests based on the existence or value of a specific HTTP request parameter. This is the part after the first '?'. If a parameter is specified multiple times in the request, only the first one is taken into account. -|Fields|Value| -|---|---| -|name|`param`| -|hasSubField|yes| -|matches|`is`, `in`, `contains`, `startswith`, `endswith` or `matches`| -|pattern|Character chain or regular expression| +| Field | Value | +| :--- | :--- | +| name | `param` | +| hasSubField | yes | +| matches | `is`, `in`, `contains`, `startswith`, `endswith` or `matches` | +| pattern | String or regular expression | -#### HTTP header. +##### **HTTP header** -This rule filters requests depending on their existence, or the value of a specific HTTP header value. You can use it to detect the opening of a WebSocket connection, and direct it to a dedicated server farm. +This rule allows filtering requests based on the existence or value of a specific HTTP header. This can for example be used to detect the opening of a websocket connection and route it to a dedicated farm. -|Fields|Value| -|---|---| -|name|`header`| -|hasSubField|yes| -|matches|`is`, `in`, `contains`, `startswith`, `endswith` or `matches`| -|pattern|Character chain or regular expression| +| Field | Value | +| :--- | :--- | +| name | `header` | +| hasSubField | yes | +| matches | `is`, `in`, `contains`, `startswith`, `endswith` or `matches` | +| pattern | String or regular expression | -#### Cookie. +##### **Cookie** -With this rule, you can filter requests depending on the existence or value of a specific HTTP cookie. You can use it to direct voluntary visitors to a pre-production farm. +This rule allows filtering requests based on the existence or value of a specific HTTP cookie. This can for example be used to direct opt-in visitors to a pre-production farm. -|Fields|Value| -|---|---| -|name|`cookie`| -|hasSubField|yes| -|matches|`is`, `in`, `contains`, `startswith`, `endswith` or `matches`| -|pattern|Character chain or regular expression| +| Field | Value | +| :--- | :--- | +| name | `cookie` | +| hasSubField | yes | +| matches | `is`, `in`, `contains`, `startswith`, `endswith` or `matches` | +| pattern | String or regular expression | ## Go further -Join our community of users on . +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_route/guide.en-gb.md b/pages/network/load_balancer/create_route/guide.en-gb.md index b904f97ce75..efe77c2df9f 100644 --- a/pages/network/load_balancer/create_route/guide.en-gb.md +++ b/pages/network/load_balancer/create_route/guide.en-gb.md @@ -1,875 +1,880 @@ --- -title: 'Working with HTTP routes' -excerpt: 'Find out how to direct your requests dynamically, to a specific farm' -updated: 2018-04-09 +title: "Configuring an OVHcloud Load Balancer with HTTP routes" +excerpt: "Find out how to dynamically direct your requests to a specific farm" +updated: 2025-11-27 --- ## Objective -The OVH Load Balancer service redirects the front-end’s incoming traffic to the servers that make up the front-end’s default farm, or its default redirection. +The OVHcloud Load Balancer service redirects the front-end’s incoming traffic to the servers that make up the front-end’s default farm, or its default redirection. -In some cases, you can go a step further and route, redirect or block traffic according to a range of criteria. For example, in the case of a HTTP(S) service, you can filter traffic depending on the HTTP method, the URL, and even a cookie or header value! In the OVH Load Balancer service, these are called `routes`{.action}. A route is a particular action to carry out if one or more conditions are met. +In some cases, you can go further and route, redirect, or block traffic according to a range of criteria. For example, in the case of an HTTP(S) service, you can filter traffic based on the HTTP method, the URL, or even the value of a cookie or header. -**This guide will show you how to direct your requests dynamically, to a specific farm.** +In the OVHcloud Load Balancer service, these elements are called **routes**. A route is a specific action to perform if one or more conditions are met. + +**This guide will show you how to direct your requests dynamically to a specific farm using routes.** ## Requirements -- an [OVH Load Balancer](/links/network/load-balancer) on a solution that lets you create routes -- access to the [OVH API](/links/api) +- Have an [OVHcloud Load Balancer](/links/network/load-balancer) on an offer allowing the creation of routes. +- Have access to the [OVHcloud API](/links/api). ## Instructions > [!primary] > -> Although this guide focuses on HTTP routes, the same principle applies to TCP (with TCP routes). This can be used to direct HTTP/2 traffic to a particular farm, or reject incoming requests from certain IPs. -> +> Although this guide focuses on **HTTP routes**, the same principle applies to **TCP routes**. This can be useful for directing HTTP/2 traffic to a specific farm or rejecting incoming requests from certain IP addresses. +> -Since this feature is still very new, it is only available in the API. This guide will explain the general principles behind routing, and provide practical examples of routes being used. +This feature is only available via the API. This guide will present the general principles as well as use cases for routes drawn from real-life scenarios. -- **An introduction to routes**. +### Introduction to routes -A route controls traffic according to different criteria. You can express these criteria as rules, conditions, or actions. +A route is used to control traffic according to different criteria. They can be expressed in the form of **rules**, **conditions**, or **actions**. -For example, *IF* the URL _starts_ with '/wp-admin/' (1) *AND* the connection _is_ in HTTP (2) *THEN* _redirect_ to the HTTPS version of the page (3). +For example, *IF* the URL _starts with_ '/wp-admin/' (1) *AND* the connection _is_ HTTP (2) *THEN* _redirect_ to the HTTPS version of the page (3). -In this example, there are two rules: +In this example, there are two rules : -- the connection must come from a HTTP front-end (2) -- its URL must begin with the WordPress admin pages (1) +- the connection must come from an HTTP frontend (2); +- its URL must start with the WordPress administration pages (1). There is an action associated with these rules: redirect to the HTTPS version of the page (3). -This is what is known as an ‘end action’. It means that if the rules are confirmed, the evaluation of routes stops, and the action is executed. +This is what is known as an "end action". That means if the rules are validated, the evaluation of the routes stops and the action is executed. -## An introduction to the API. +### API presentation -You can only manage routes via the [OVH API](/links/api). It is only valid for `http`{.action} and `tcp`{.action} protocols, and the `/ipLoadbalancing/{serviceName}/{protocol}/route/`{.action} pathway exposes the API dedicated to routes. +Route management is only available through the [OVHcloud API](/links/api). It is only valid for the **http** and **tcp** protocols, and the path `/ipLoadbalancing/{serviceName}/{protocol}/route/`{.action} exposes the dedicated route API. -The API for routes to the OVH Load Balancer is specially designed for flexibility, power and scalability. It is organised around three main sections: +The OVHcloud Load Balancer service route API has been specifically designed to be flexible, powerful, and scalable. It is organized around three main sections: -1. the APIs listing available rules and actions -2. the APIs listing the routes configured on the OVH Load Balancer service -3. the APIs for configuring routes on the OVH Load Balancer service +1. API calls listing the available rules and actions. +2. API calls listing the routes configured on your OVHcloud Load Balancer service. +3. API calls for configuring the routes of your OVHcloud Load Balancer service. > [!primary] > -> To only show the APIs linked to routes in the OVH API console, you can use the `filter`{.action} field with ‘route’ as a keyword. -> +> To display only the API calls related to routes in the OVHcloud API console, you can use the `filter`{.action} field with the keyword "[a-z]*". +> -When you want to configure a route or rules, the first thing you need to do is look at the available actions and rules. This will give you the possible values for the API route and rule configuration fields. +When you want to configure a route or rules, the first thing to do is to consult the **available actions and rules**. This will give you the possible values for the configuration fields of the route and rule APIs. - A route can have several rules. -- A route can only be attached to a single front-end. -- A front-end can have several routes. In this case, the order of evaluation depends on its type and weight. +- A route can only be attached to a single frontend. +- A frontend can have several routes. In this case, the evaluation order depends on its type and weight. -When a request arrives at your OVH Load Balancer service, the routes are evaluated successively following the principles below: +When a request arrives on your OVHcloud Load Balancer service, the routes are evaluated successively according to the following principles: -1. firstly, reject and rewrite routes, then the farm routes -1. within categories, the routes are evaluated in order of ascending weight -1. if two routes are the same weight, the first route created is evaluated first -1. only the first action from all the validated rules is executed +1. first, the **reject and rewrite routes**, then the **farm routes**; +2. within these categories, the routes are evaluated in **increasing weight order**; +3. if two routes have the same weight, the **first route created** is evaluated first; +4. only the **first action** of all validated rules is executed. -### Available rules and actions. +### Available rules and actions -This first section of the API contains an updated list of actions and rules available for the OVH Load Balancer service. It contains a call for actions, and another for rules. These two calls return a list of objects. Each object has a name, and if it applies to all TCP or HTTP routes as well as the values or value types expected for different fields of the API. If a field is “null”, this means that no value is expected. If an invalid value is entered, the API will return a validation error. +This first section of the API contains an up-to-date list of available actions and rules for your OVHcloud Load Balancer service. It contains one call for the actions and another for the rules. These two calls return a list of objects. Each object is named, and indicates whether it applies to TCP or HTTP routes, as well as the expected values or types of values for the different fields of the API. If a field is "null", it means no value is expected. If an invalid value is provided, the API will return a validation error. #### Actions > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteActions -> +> -For more information on this call, please read the [Available actions](#available-actions){.internal} section at the bottom of this guide. +For more information on this call, we invite you to consult the section [Available Actions](#available-actions), at the bottom of this guide. -#### Rules: +#### Rules > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteRules -> +> -For more information on this call, please read the [Available rules](#available-rules){.internal} section at the bottom of this guide. +For more information on this call, we invite you to consult the section [Available Rules](#available-rules), at the bottom of this guide. -### Configured routes. +### Configured routes -This section of the API only contains one call. It was mainly designed to help implement auto-complete systems. It returns the ID, name and type of each defined route. You can get a route’s details with a GET /ipLoadbalancing/{serviceName}/route/{type}/{routeId} call, defined further below. +This second section of the API contains only one call. It was mainly designed to facilitate the implementation of auto-completion mechanisms. It returns the identifier, name, and type of each defined route. The details of a route can be obtained with a `GET /ipLoadbalancing/{serviceName}/route/{type}/{routeId}` call defined below. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/definedRoutes -> +> -For more information on this call, please read the [Edit routes](#edit-routes){.internal} section at the bottom of this guide. +For more information on this call, we invite you to consult the section " [Route Handling](#handling-routes) ", at the bottom of this guide. -### Route configuration. +### Route configuration -With these basic principles around the action and rules available, and the order in which routes are evaluated, these routes can be edited the same way as the farms can. When you create a route, you can attach rules to it. The possible values for rules and actions are defined by the API calls. +With these basic principles on available actions and rules, and the route evaluation order, these routes can be manipulated in the same way as farms. When you create a route, you can attach rules to it. The possible values for the rules and actions are defined by the API calls. -For more information on these calls, please read the [Edit routes](#edit-routes){.internal} section at the bottom of this guide. +For more information on these methods, you can consult the section " [Route Handling](#handling-routes) ", at the bottom of this guide. ## Examples -If you still have doubts about the power of routes, this should change your mind. The purpose of this section is to offer some practical examples of how this technology has been used for OVH’s internal requirements, without going into great detail about API calls. +To demonstrate the utility of routes, this section will offer some practical examples of the use of this technology for OVHcloud's internal needs, without going into the details of the API calls. -You can read about API calls in more detail in the [Edit routes](#edit-routes){.internal} section at the bottom of this guide, and the sections that follow it. +You will find the details of the API calls in the section [Route Handling](#handling-routes), at the bottom of this guide and the following sections. -### Force HTTPS for WordPress login pages. +### Force HTTPS for WordPress login pages -HTTPS protocol has become the norm. Its purpose is to make all websites available securely in HTTPS, with the SSL/TLS protocol. If you need an SSL/TLS certificate, you can use the OVH Load Balancer service to order a new one, which will be automatically managed for you. +The HTTPS protocol has become the norm. Its objective is to make all websites available in HTTPS in a secure manner, thanks to the SSL/TLS protocol. If you need an SSL/TLS certificate, you can use your OVHcloud Load Balancer service to order a new one, which will be managed for you in a completely automatic way. -Migrating a website to HTTPS involves a lot of work, especially to avoid [mixed content](https://developer.mozilla.org/en-us/docs/Web/Security/Mixed_content). It may be worth migrating your website section by section, and starting by securing pages that send login credentials. +Migrating a website to HTTPS requires work, especially to avoid [Mixed-Content](https://developer.mozilla.org/en-us/docs/Web/Security/Mixed_content) problems. It may be interesting to migrate your website section by section, starting by securing the pages that send login credentials. -One approach could be to base it on the beginning of WordPress URLs. By default, the URL the login pages for WordPress start with "/wp-login". So we would need: +An approach could be to rely on the beginning of WordPress URLs. By default, the URLs of WordPress login pages start with "/wp-login". We would therefore need to: -- a route with a redirect action -- a rule in this route that detects URLs starting with "/wp-login" +- a route with a **redirection action**; +- a rule in this route that detects URLs starting with **"/wp-login"**. -In practice, this gives a route like this: +In practice, this gives a route as follows: -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|frontendId|Your HTTP front-end ID| -|displayName|“Redirection of WordPress logins to HTTPS”| -|weight|(empty)| -|action.type|"redirect"| -|action.status|302 for a temporary redirection, 301 for a permanent redirection| -|action.target|"`https://${host}${path}${arguments}`" to take the same host, path and arguments| +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| frontendId | Identifier of your HTTP frontend | +| displayName | "Redirect WordPress connections to HTTPS" | +| weight | (empty) | +| action.type | "redirect" | +| action.status | 302 for a temporary redirect, 301 for a permanent redirect | +| action.target | "`https://\${host}\${path}\${arguments}`" to take the same host, path and arguments | On this route, we will attach a rule: -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|routeId|Route ID created above| -|field|"uri"| -|subField|(empty)| -|match|"startswith"| -|negate|false| -|pattern|"/wp-login"| +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| routeId | Identifier of the route created above | +| field | "uri" | +| subField | (empty) | +| match | "startswith" | +| negate | false | +| pattern | "/wp-login" | -Next, apply the configuration to the zone concerned, and the rule will begin to work. +Then apply the configuration to the concerned area. > [!warning] > -> To add a new redirection, you will need to repeat these actions again, creating a route, then a rule. If a second rule is added to the same route, the two rules need to be validated for the redirect to work. Note that if the rules are "startswith /wp-login" and "startswith /wp-admin", the redirection would never work because these two conditions cannot both be true at once. -> +> To add a new redirection, you will have to repeat these actions, creating a route, then a rule. If a second rule is added to the same route, both rules must be validated for the redirection to work. Note that if the rules are `startswith /wp-login` and `startswith /wp-admin`, the redirection will never work because these two conditions cannot be true at the same time. +> -### Route according to a domain (vhost) +### Route based on a domain (VHost) -This feature helped propel the expansion of the web at its very early stages, by exposing several websites behind a single IP address using the “host” field of HTTP headers. +This is the feature that made the web possible when it was in its infancy, with the possibility of exposing several sites behind the same IP address thanks to the "Host" field of HTTP headers. -For example, if your infrastructure is made up of a VPS for your website, an OVH Load Balancer to ensure SSL/TLS termination, and redirection to a maintenance page with a backup server in the farms, you would originally have needed one Additional IP per website, routed to your OVH Load Balancer, and one front-end per IP. +For example, if your infrastructure is composed of a VPS for your website, an OVHcloud Load Balancer for SSL/TLS termination, and redirections to a maintenance page with a backup server in the farms, you would have needed an Additional IP per website, routed to your OVHcloud Load Balancer, and a frontend per IP in the past. -With routes, you can share the same front-end, and choose the server farm dynamically, with the “host” field. +With routes, you can share the same frontend and choose the server farm dynamically, thanks to the *[a-z]* field. -To do this, you will need: +For this, you will need: -- one route per vhost -- one rule per route detecting a specific domain +- a route per VHost; +- a rule per route detecting a specific domain. -In practice, to route the domain www.example.com, this would give the following route: +In practice, to route the domain **www.example.com**, this will give the following route: -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|frontendId|Your front-end ID| -|displayName|"VHost - www.example.com"| -|weight|(empty)| -|action.type|"farm"| -|action.status|(empty)| -|action.target|ID of the farm to direct this domain to| +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| frontendId | Identifier of your frontend | +| displayName | "VHost - www.example.com" | +| weight | (empty) | +| action.type | "farm" | +| action.status | (empty) | +| action.target | Identifier of the farm to which to direct this domain | And on this route, we will attach a rule: -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|routeId|Route ID created above| -|field|"host"| -|subField|(empty)| -|match|"is"| -|negate|false| -|pattern|"www.example.com" or a domain of your choice| +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| routeId | Identifier of the route created above | +| field | "host" | +| subField | (empty) | +| match | "is" | +| negate | false | +| pattern | "www.example.com" or a domain of your choice | Finally, apply the configuration. -### Reserve an Additional IP to a particular website. +### Reserve an Additional IP for a specific website -If you are hosting a website on a VPS, you may want to dedicate an IP address to a specific customer. You can easily make the IP available by routing it to your OVH Load Balancer service, then configuring a dedicated front-end attached to this Additional IP address, and having the customer’s target VPS set as a defaultFarmId. +If you host a website on a VPS, you might want to dedicate an IP address to a specific client. You can easily make the IP available by routing it to your OVHcloud Load Balancer service, then configuring a dedicated frontend attached to this Additional IP, and setting the client's target VPS as the `defaultFarmId`. -But what will happen if another customer detects this, and configures their domain to point to the premium customer’s IP address? By default, this will work, and its website will be routed to the other VPS. If there is an SSL/TLS certificate, it will still work as all of the certificates are automatically available for all of the front-ends. +However, what will happen if another client detects this and configures their domain to point to the premium client's IP? By default, this will work, and their website will be routed to another client's VPS. If an SSL/TLS certificate is present, this will still work, as all certificates are automatically available for all frontends. -In such scenarios, the solution is to add a rule that will reject requests if the domain is not a premium one. You can do this with a rejection route and a rule. +In such scenarios, the solution is to add a rule that **rejects requests if the domain is not a premium domain**. You can do this with a reject route and a rule. -In practice, to reserve a front-end with an IP dedicated to the domain www.example.com, this will give the following route: +In practice, to reserve a frontend with a dedicated IP for the domain **www.example.com**, this will give the following route: -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|frontendId|Your front-end ID| -|displayName|"Restrict to www.example.com"| -|weight|(empty)| -|action.type|"reject"| -|action.status|403| -|action.target|(empty)| +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| frontendId | Identifier of your frontend | +| displayName | "Restriction to www.example.com" | +| weight | (empty) | +| action.type | "reject" | +| action.status | 403 | +| action.target | (empty) | And on this route, we will attach a rule: -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|routeId|Route ID created above| -|field|"host"| -|subField|(empty)| -|match|"is"| -|negate|true| -|pattern|"www.example.com" or a domain of your choice| +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| routeId | Identifier of the route created above | +| field | "host" | +| subField | (empty) | +| match | "is" | +| negate | true | +| pattern | "www.example.com" or a domain of your choice | Finally, apply the configuration. -### Route depending on a URL and HTTP method. +### Route based on a URL and an HTTP method -On some specific infrastructures, certain requests need to be routed to a specific farm. For example, to manage rare but data-intensive requests without impacting production, such as analytical requests that would work from a read-only duplicate of the data with a server that has a higher volume of memory. +On some specific infrastructures, certain requests must be routed to a specific farm. For example, to handle rare but data-intensive requests without impacting production, such as analytical requests that work on a read-only copy of the data with a server having a higher memory volume. If, for example, the request is sent: -- with the POST method -- on a URL corresponding to "^/.\*/batch-analytics$" +- with the **POST** method; +- on a URL matching **"^/.*/batch-analytics$"**. -... you would need a route with two rules, with one rule using a regular expression. +Then, you would need a route with two rules, one of which uses a regular expression. -In practice, this gives a route like this: +In practice, this gives a route as follows: -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|frontendId|Your front-end ID| -|displayName|"Route batch analytics to dedicated farm"| -|weight|(empty)| -|action.type|"farm"| -|action.status|(empty)| -|action.target|ID of the farm to direct these operations to| +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| frontendId | Identifier of your frontend | +| displayName | "Route batch analytics to a dedicated farm" | +| weight | (empty) | +| action.type | "farm" | +| action.status | (empty) | +| action.target | Identifier of the farm to which to direct these operations | And on this route, we will attach two rules: -|Field|Rule 1|Rule 2| -|---|---|---| -|serviceName|Your OVH Load Balancer service ID|as per rule 1| -|routeId|Route ID created above|as per rule 1| -|field|"method"|"uri"| -|subField|(empty)|(empty)| -|match|"is"|"matches"| -|negate|false|false| -|pattern|"POST"|"^/.\*/batch-analytics$"| +| Field | Rule 1 | Rule 2 | +| :--- | :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | as for rule 1 | +| routeId | Identifier of the route created above | as for rule 1 | +| field | "method" | "uri" | +| subField | (empty) | (empty) | +| match | "is" | "matches" | +| negate | false | false | +| pattern | "POST" | "`^/.*/batch-analytics$`" | + +Here, the first rule applies to an enumeration. Only standard HTTP methods are available. The second rule, on the other hand, exploits the full power of routes by using a regular expression. Although it is possible to use such expressions, avoiding them results in enhanced performance. -Here, the first rule applies on a list. Only standard HTTP methods are available. However, the second rule uses all the power of routes using a regular expression. Although it is possible to use expressions like this, if you can go without using them, your performance will be even higher. +All that remains is to apply the configuration in the concerned area. -Next, apply the configuration to the zone concerned. +#### Route certain IPs and voluntary clients to preproduction -### Route certain IPs and voluntary clients to a pre-production environment. +When a site grows, you may want to set up a preproduction environment to validate ongoing changes, without affecting the majority of users. Generally, when configuring this type of environment, you want to reduce the gap as much as possible between production and preproduction, in order to detect problems as accurately as possible. A classic and often neglected source of problems is the domain name. It is sometimes hardcoded in a file or an article. At that point, a link may work in preproduction but not in production. -When your website gains momentum, you may want to set up a pre-production environment, which you can use to check ongoing developments without affecting the majority of your users. Generally, when you configure an environment like this, it is best to minimise the differences between production and pre-production as much as possible, so that any issues can be detected as accurately as possible. A common but often-forgotten issue is the domain name, as it is sometimes hard-coded into a file or item. If this is the case, the link may work in pre-production, but not in production. +Instead of setting up rules based on the domain name, you could set up rules based on the source IP address (for example, an enterprise proxy) and possibly a cookie for voluntary clients. These configurations can be detected with two routes on your OVHcloud Load Balancer service. -Instead of setting up rules based on the domain name, you can set up rules based on the source IP (e.g. an enterprise proxy), and possibly a cookie for voluntary clients. These configurations can be detected with two routes on the OVH Load Balancer service. +For this example, we will consider: -For this example, we will consider that: +- that the enterprise proxy can use the addresses 42.42.42.0/24 and the VPN uses 1.2.3.4/32; +- that the voluntary users have a "PreprodOptIn" cookie, the value of which is not important. -- the enterprise proxy can use the addresses 42.42.42.0/24, and that the VPN uses 1.2.3.4/32 -- the voluntary users have a "PreprodOptIn" cookie — it doesn’t matter what the value is +In practice, you will need two identical routes: -In practice, we would need two identical routes: +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| frontendId | Identifier of your frontend | +| displayName | "Route Opt-In and internal users to preproduction environment" | +| weight | (empty) | +| action.type | "farm" | +| action.status | (empty) | +| action.target | Identifier of the preproduction farm | -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|frontendId|Your front-end ID| -|displayName|"Route Opt-In and internal users to pre-production environment"| -|weight|(empty)| -|action.type|"farm"| -|action.status|(empty)| -|action.target|Your pre-production farm’s ID| +Next, we attach the following 2 rules, each on one of the routes (1 rule per route): -Then we will attach the following two rules to each of the routes (one rule per route): +| Field | Rule 1 | Rule 2 | +| :--- | :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | same | +| routeId | Identifier of the first route | Identifier of the second route | +| field | "source" | "cookie" | +| subField | (empty) | "PreprodOptIn" | +| match | "in" | "exists" | +| negate | false | false | +| pattern | "42.42.42.0/24, 1.2.3.4" | (empty) | -|Field|Rule 1|Rule 2| -|---|---|---| -|serviceName|Your OVH Load Balancer service ID|as per rule 1| -|routeId|ID of the first route|ID of the second route| -|field|"source"|"cookie"| -|subField|(empty)|"PreprodOptIn"| -|match|"in"|"exists"| -|negate|false|false| -|pattern|"42.42.42.0/24, 1.2.3.4"|(empty)| +The first rule checks if the source IP is in a list of address ranges. In this case, the different address ranges are separated by commas and can be surrounded by spaces for better readability. If a range contains only one address, the "/32" is implicit but can be added explicitly. In any case, the size of this field is limited to 255 characters. -The first rule tests whether the source IP is in the address range list. In this case, the various address ranges are separated by commas, and can have spaces in between one another to make them easier to read. If the range only contains one address, the "/32" is implicit, but can be added explicitly. Either way, this field is limited to 255 characters. +The second rule simply checks the existence of the cookie. It would be possible to check if its value matches a regular expression or is in a list of possibilities, but this allows to show a simple example of what can be done with cookies. Rules based on HTTP Headers work according to a similar approach. -The second rule simply tests to see if a cookie exists. It is also possible to test if the value corresponds to a regular expression, or is found in a possibility list, but this offers a simple example of what you can do with cookies. Rules based on HTTP headers work using a similar approach. +All that remains is to apply the configuration in the concerned area. -Next, apply the configuration to the zone concerned. +#### Route WebSockets to a dedicated farm -### Route WebSockets to a dedicated farm. +When a site has interactive functions based on WebSockets such as a chatbot, you may want to direct these connections to a server farm dedicated to this task. In fact, it is quite simple.W -When a website has interactive features based on WebSockets — a chatbot, for example — you may want to direct these connections to a server farm dedicated to this task. This is actually quite simple. When a browser attempts to open a WebSockets connection, it sends a standard HTTP request with these headers: +When a browser tries to open a WebSocket connection, it sends a standard HTTP request with the headers: ``` Upgrade: websocket Connection: Upgrade ``` -In this case, only the first header needs to be detected. This can be done very easily with a route and a rule: +In practice, it is sufficient to detect the first header. This can be done very easily with a route and a rule: -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|frontendId|Your front-end ID| -|displayName|"Route WebSockets to a dedicated farm"| -|weight|(empty)| -|action.type|"farm"| -|action.status|(empty)| -|action.target|ID of the farm dedicated to WebSockets| +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| frontendId | Identifier of your frontend | +| displayName | "Route WebSockets to a dedicated farm" | +| weight | (empty) | +| action.type | "farm" | +| action.status | (empty) | +| action.target | Identifier of the WebSocket dedicated farm | -And on this route, we will attach a rule: +And on this route, we come to attach a rule: + +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| routeId | Identifier of the route created just above | +| field | "header" | +| subField | "Upgrade" | +| match | "is" | +| negate | false | +| pattern | "websocket" (case-sensitive) | -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|routeId|Route ID created above| -|field|"header"| -|subField|"Upgrade"| -|match|"is"| -|negate|false| -|pattern|"websocket" (case-sensitive)| +All that remains is to apply the configuration in the relevant zone. -Next, apply the configuration to the zone concerned. -## Reference. +### References -Here, you will find more details on the API calls linked to the routes. To get a general idea of how routes work, we recommend starting off by reading the [introduction to the API](#an-introduction-to-the-api){.internal} section further up. +You will find here the details of the API calls related to routes. For a more general overview of route features, we invite you to first consult the section " [API presentation](#apipresentation) " a little further up in this guide. -### Edit routes. +#### Handling routes -TCP and HTTP routes are configured the same way. Since the routes are more powerful in HTTP, this section focuses on HTTP rules and routes. TCP routes can be extrapolated from the information below by replacing “http” with “tcp” in each route. Some fields only apply to HTTP routes, and are not available in TCP. +TCP and HTTP routes are configured in the same way. Since HTTP routes are more powerful, this section focuses on HTTP routes and rules. The operation of TCP routes can be extrapolated by replacing "http" with "tcp" in the routes. Some fields only make sense in HTTP, so they are not available in TCP. -#### List the routes. +##### **List routes** -This call returns the list of ID numbers of routes defined for HTTP protocol. You can filter this list by frontendId. This call returns the routes in the order in which they will be evaluated. The evaluation order can be partially controlled by the weight of the route. +This call returns the list of numeric identifiers of routes defined for the HTTP protocol. You can filter this list by `frontendId`. This call returns the routes in the order in which they will be evaluated. The evaluation order can be partially controlled using the "weight" of the route. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route -> +> -|Setting|Required|Meaning| -|---|---|---| -|serviceName|Required|Your Load Balancer service ID| -|frontendId||ID number of a HTTP front-end the routes are attached to| +| Parameter | Required | Meaning | +| :--- | :--- | :--- | +| serviceName | Required | Identifier of your Load Balancer service | +| frontendId | | Numeric identifier of an HTTP frontend to which the routes are attached | -#### Create a route. +##### **Create a route** -With this call, you can create a route. Only the action is mandatory. A route can be attached to and detached from a front-end. You can create up to 50 routes on an OVH Load Balancer. This call returns the route created, if it is successful. You will need to re-deploy your OVH Load Balancer to apply the changes. +This call allows you to create a route. Only the action is mandatory. A route can be attached and detached from a frontend. It is possible to create up to 50 routes on an OVHcloud Load Balancer service. This call returns the created route in case of success. Your OVHcloud Load Balancer service must be redeployed to apply the changes. > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route -> +> -|Setting|Required|Meaning| -|---|---|---| -|serviceName|Required|Your Load Balancer service ID| -|displayName||Display name for your route (255 characters maximum)| -|frontendId||ID number of a HTTP front-end to attach the route to| -|weight||Route priority, between 1 (carry out first) and 255 (carry out after the others)| -|action.type|Required|Name of the action type to execute if all of the rules associated with the route are validated| -|action.status||HTTP status code for `reject` and `redirect` actions| -|action.target||ID number of the target farm for `farm` actions, or the URL template for `redirect` actions| +| Parameter | Required | Meaning | +| :--- | :--- | :--- | +| serviceName | Required | Identifier of your Load Balancer service | +| displayName | | Display name of your route (maximum 255 characters) | +| frontendId | | Numeric identifier of an HTTP frontend to which to attach the route | +| weight | | Priority of the route, between 1 (passes first) and 255 (passes after others) | +| action.type | Required | Name of the type of action to execute if all the rules associated with the route are validated | +| action.status | | HTTP status code for the `reject` and `redirect` actions | +| action.target | | Numeric identifier of the target farm for the `farm` actions, or URL pattern for the `redirect` actions | -The possible action types are listed below: +The possible action types are: -|action|Meaning| -|---|---| -|redirect|Redirects a request to `action.target`, with the HTTP `action.status` code| -|reject|Rejects a request with the HTTP `action.status` code| -|farm|Routes a request to the farm with the ID entered in `action.target`| +| action | Meaning | +| :--- | :--- | +| redirect | Redirect a request to `action.target` with the HTTP status code `action.status` | +| reject | Reject a request with the HTTP status code `action.status` | +| farm | Route a request to the farm whose identifier is specified in `action.target` | -For further information on the actions managed and the format of parameters, please read the [Available actions](#available-actions){.internal} section further down. +For more information on the actions handled and the format of the parameters, we invite you to consult the section " [Available actions](#available-actions) " further down in this guide. -#### View details on a route. +##### **View the details of a route** -With this call, you can view details on an HTTP route if you know its ID. +This call allows you to view the details of an HTTP route, knowing its identifier. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId} -> +> -Query +- Request: -|Setting|Meaning| -|---|---| -|serviceName|Your Load Balancer service ID| -|routeId|The route’s ID number| +| Parameter | Meaning | +| :--- | :--- | +| serviceName | Identifier of your Load Balancer service | +| routeId | Numeric identifier of the route | -Answer +- Response: -|Setting|Meaning| -|---|---| -|routeId|The route’s ID number| -|displayName|The display name for your route| -|frontendId|ID number of the front-end your route is attached to| -|weight|Priority of your route| -|action.type|Name of the action type for your route| -|action.status|Associated HTTP status code| -|action.target|ID number of the associated farm or URL template| -|rules|List of rules that must be validated to trigger the route’s action More detail on this is available in the [Edit rules](#edit-rules){.internal} section.| +| Parameter | Meaning | +| :--- | :--- | +| routeId | Numeric identifier of the route | +| displayName | Display name of your route | +| frontendId | Numeric identifier of the frontend to which your route is attached | +| weight | Priority of your route | +| action.type | Name of the type of action of your route | +| action.status | Associated HTTP status code | +| action.target | Numeric identifier of the farm or associated URL pattern | +| rules | List of rules that must be validated to trigger the action of the route. More details are available in the section " [Handling Rules](#handling-rules) ". | -For further information on the actions managed and the format of parameters, please read the [Available actions](#available-actions){.internal} section further down. +For more information on the actions handled and the format of the parameters, we invite you to consult the section "[Available actions](#available-actions)" further down in this guide. -#### Modify a route. +##### **Modify a route** -With this call, you can modify an HTTP route if you know its ID. You will need to re-deploy your OVH Load Balancer to apply the changes. +This call allows you to modify an HTTP route, knowing its identifier. Your OVHcloud Load Balancer service must be redeployed to apply the changes. > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId} > -|Setting|Required|Meaning| -|---|---|---| -|serviceName|Required|Your Load Balancer service ID| -|routeId|Required|The route’s ID number| -|displayName||Display name for your route (255 characters maximum)| -|frontendId||ID number of a HTTP front-end to attach the route to| -|weight||Route priority, between 1 (carry out first) and 255 (carry out after the others)| -|action.type|Required|Name of the action type to execute if all of the rules associated with the route are validated| -|action.status||HTTP status code for `reject` and `redirect` actions| -|action.target||ID number of the target farm for `farm` actions, or the URL template for `redirect` actions| +| Parameter | Required | Meaning | +| :--- | :--- | :--- | +| serviceName | Required | Identifier of your Load Balancer service | +| routeId | Required | Numeric identifier of the route | +| displayName | | Display name of your route (maximum 255 characters) | +| frontendId | | Numeric identifier of an HTTP frontend to which to attach the route | +| weight | | Priority of the route, between 1 (passes first) and 255 (passes after others) | +| action.type | Required | Name of the type of action to execute if all the rules associated with the route are validated | +| action.status | | HTTP status code for the `reject` and `redirect` actions | +| action.target | | Numeric identifier of the target farm for the `farm` actions, or URL pattern for the `redirect` actions | -For further information on the actions managed and the format of parameters, please read the [Available actions](#available-actions){.internal} section further down. +For more information on the actions handled and the format of the parameters, we invite you to consult the section " [Available actions](#available-actions) " further down in this guide. -#### Delete a route. +##### **Delete a route** -With this call, you can delete an HTTP route if you know its ID. When a route is deleted, all of the rules associated with the route are deleted, too. You do not need to delete them individually. You will need to re-deploy your OVH Load Balancer to apply the changes. +This call allows you to delete an HTTP route, knowing its identifier. When a route is deleted, all the rules associated with that route are also deleted. There is no need to delete them individually. Your OVHcloud Load Balancer service must be redeployed to apply the changes. > [!api] > > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId} -> +> -|Setting|Required|Meaning| -|---|---|---| -|serviceName|Required|Your Load Balancer service ID| -|routeId|Required|The route’s ID number| +| Parameter | Required | Meaning | +| :--- | :--- | :--- | +| serviceName | Required | Identifier of your Load Balancer service | +| routeId | Required | Numeric identifier of the route | -### Edit rules. +#### Handling rules -#### List the rules. +##### **List rules** -This call returns the list of ID numbers of rules defined for a particular route. +This call returns the list of numeric identifiers of rules defined for a given route. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule -> +> -|Setting|Required|Meaning| -|---|---|---| -|serviceName|Required|Your Load Balancer service ID| -|routeId|Required|The route’s ID number| +| Parameter | Required | Meaning | +| :--- | :--- | :--- | +| serviceName | Required | Identifier of your Load Balancer service | +| routeId | Required | Numeric identifier of the route | -#### Attach a rule. +##### **Attach a rule** -With this call, you can attach a rule to a route. You can attach up to 5 rules per route on an OVH Load Balancer. This call returns the route created, if it is successful. You will need to re-deploy your OVH Load Balancer to apply the changes. +This call allows you to attach a rule to a route. It is possible to attach up to 5 rules per route on an OVHcloud Load Balancer service. This call returns the created rule in case of success. Your OVHcloud Load Balancer service must be redeployed to apply the changes. > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule -> - -|Setting|Required|Meaning| -|---|---|---| -|serviceName|Required|Your Load Balancer service ID| -|routeId|Required|The route’s ID number| -|field|Required|The name of the HTTP parameter to apply the rule to| -|subField||HTTP header name for the `header` rules, or cookie name for `cookie` rules| -|match|Required|Name of the comparison to apply to validate the rule| -|negate||Reverses the comparison result| -|pattern||Comparison pattern| - -`field` - -|Value|Meaning| -|---|---| -|source|The address or list of source IP addresses (a.b.c.d/z)| -|protocol|Protocol (“http” or “https”)| -|method|HTTP method (GET, HEAD, POST, PUT, DELETE, OPTIONS, CONNECT, TRACE)| -|host|Domain name (vhost), without the port number| -|uri|Path of the request as it appears between the first "/" and the last "?"| -|param|HTTP parameter contained in the part after the first "?"| -|header|HTTP header| -|cookie|HTTP cookie| - -`match` - -|Value|Meaning| -|---|---| -|exists|The property must exist (e.g. HTTP header or cookie)| -|-|The property must correspond exactly to a `pattern`| -|in|The property must be in the list of values (separated by commas) defined by `pattern`| -|contains|The property must contain the `pattern` value| -|startswith|The property must start with the `pattern` value| -|endswith|The property must end with the `pattern` value| -|matches|The property must match the regular `pattern` expression| - -For further information on the rules managed and the format of parameters, please read the [Available rules](#available-rules){.internal} section further down. - -#### View details on a rule. - -With this call instruction, you can view the details on a rule attached to an HTTP route if you know its ID. +> + +| Parameter | Required | Meaning | +| :--- | :--- | :--- | +| serviceName | Required | Identifier of your Load Balancer service | +| routeId | Required | Numeric identifier of the route | +| field | Required | Name of the HTTP parameter on which to apply this rule | +| subField | | Name of the HTTP header for `header` rules or name of the cookie for `cookie` rules | +| match | Required | Name of the comparator to apply to validate the rule | +| negate | | Inverts the result of the comparator | +| pattern | | Comparator argument | + +- `field` + +| Value | Meaning | +| :--- | :--- | +| source | Address or list of source addresses in the form of IP (a.b.c.d/z) | +| protocol | Protocol. "http" or "https" | +| method | HTTP method (GET, HEAD, POST, PUT, DELETE, OPTIONS, CONNECT, TRACE) | +| host | Domain name (vhost), without the port number | +| uri | Request path as understood between the first "/" and the first "?" | +| param | HTTP parameter coming from the part after the first "?" | +| header | HTTP header | +| cookie | HTTP cookie | + +- `match` + +| Value | Meaning | +| :--- | :--- | +| exists | The property must exist (HTTP header or cookie for example) | +| is | The property must match exactly `pattern` | +| in | The property must be in the list of values (separated by commas) defined by `pattern` | +| contains | The property must contain the value of `pattern` | +| startswith | The property must start with the value of `pattern` | +| endswith | The property must end with the value of `pattern` | +| matches | The property must match the regular expression of `pattern` | + +For more information on the rules handled and the format of the parameters, we invite you to consult the section " [Available rules](#available-rules) " further down in this guide. + +##### **View the details of a rule** + +This call allows you to view the details of a rule attached to an HTTP route, knowing its identifier. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId} -> +> -Query +- Request: -|Setting|Meaning| -|---|---| -|serviceName|Your Load Balancer service ID| -|routeId|The route’s ID number| -|ruleId|The rule’s ID number| +| Parameter | Meaning | +| :--- | :--- | +| serviceName | Identifier of your Load Balancer service | +| routeId | Numeric identifier of the route | +| ruleId | Numeric identifier of the rule | -Answer +- Response: -|Setting|Meaning| -|---|---| -|ruleId|The rule’s ID number| -|field|Name of the HTTP parameter to apply the rule on| -|subField|Name of the HTTP header or cookie for the rule| -|match|Name of the comparison to apply to validate the rule| -|negate|"true" if the comparison result is reversed| -|pattern|Comparison argument. The direction and syntax depends on the `match` and the `field`.| +| Parameter | Meaning | +| :--- | :--- | +| ruleId | Numeric identifier of the rule | +| field | Name of the HTTP parameter on which to apply the rule | +| subField | Name of the HTTP header or cookie for the rule | +| match | Name of the comparator to apply to validate the rule | +| negate | "true" if the result of the comparator is inverted | +| pattern | Comparator argument. The meaning and syntax depend on `match` and `field` | -For further information on the rules managed and the format of parameters, please read the [Available rules](#available-rules){.internal} section further down. +For more information on the rules handled and the format of the parameters, we invite you to consult the section " [Available rules](#available-rules) " further down in this guide. -#### Modify a rule. +##### **Modify a rule** -With this call, you can modify a rule attached to an HTTP route if you know its ID. You will need to re-deploy your OVH Load Balancer to apply the changes. +This call allows you to modify a rule attached to an HTTP route, knowing its identifier. Your OVHcloud Load Balancer service must be redeployed to apply the changes. > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId} -> +> -|Setting|Required|Meaning| -|---|---|---| -|serviceName|Required|Your Load Balancer service ID| -|routeId|Required|The route’s ID number| -|ruleId|Required|The rule’s ID number| -|field|Required|The name of the HTTP parameter to apply the rule to| -|subField||HTTP header name for the `header` rules, or cookie name for `cookie` rules| -|match|Required|Name of the comparison to apply to validate the rule| -|negate||Reverses the comparison result| -|pattern||Comparison pattern| +| Parameter | Required | Meaning | +| :--- | :--- | :--- | +| serviceName | Required | Identifier of your Load Balancer service | +| routeId | Required | Numeric identifier of the route | +| ruleId | Required | Numeric identifier of the rule | +| field | Required | Name of the HTTP parameter on which to apply this rule | +| subField | | Name of the HTTP header for `header` rules or name of the cookie for `cookie` rules | +| match | Required | Name of the comparator to apply to validate the rule | +| negate | | Inverts the result of the comparator | +| pattern | | Comparator argument | -For further information on the rules managed and the format of parameters, please read the [Available rules](#available-rules){.internal} section further down. +For more information on the rules handled and the format of the parameters, we invite you to consult the section " [Available rules](#available-rules) " further down in this guide. -#### Delete a rule. +##### **Delete a rule** -With this call, you can delete a rule attached to an HTTP route if you know its ID. You will need to re-deploy your OVH Load Balancer to apply the changes. +This call allows you to delete a rule attached to an HTTP route, knowing its identifier. Your OVHcloud Load Balancer service must be redeployed to apply the changes. > [!api] > > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId} -> +> -|Setting|Required|Meaning| -|---|---|---| -|serviceName|Required|Your Load Balancer service ID| -|routeId|Required|The route’s ID number| -|ruleId|Required|The rule’s ID number| +| Parameter | Required | Meaning | +| :--- | :--- | :--- | +| serviceName | Required | Identifier of your Load Balancer service | +| routeId | Required | Numeric identifier of the route | +| ruleId | Required | Numeric identifier of the rule | > [!primary] > -> If you want to delete a route, you do not need to delete all the rules attached to it. The rules are automatically deleted when you delete the route. -> +> If you want to delete a route, it is not necessary to delete all the rules attached to it. The rules are automatically deleted when you delete a route. +> -#### List all of the TCP and HTTP routes. +##### **List all TCP and HTTP routes** -With this call, you can get a list of all the IDs, display names and types ("http"/"tcp") of routes defined on an OVH Load Balancer service. It is designed to simplify the implementation of auto-completion. +This call allows you to list all the identifiers, display names and types ("http"/"tcp") of routes defined on an OVHcloud Load Balancer service. It was designed to simplify the implementation of auto-completion. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/definedRoutes -> +> -Query +- Request: -|Setting|Meaning| -|---|---| -|serviceName|Your Load Balancer service ID| +| Parameter | Meaning | +| :--- | :--- | +| serviceName | Identifier of your Load Balancer service | -Answer +- Response: -|Setting|Meaning| -|---|---| -|type|Type of protocol for the route: "tcp" for TCP routes, "http" for HTTP routes| -|routeId|The route’s ID number| -|displayName|The display name of the route| +| Parameter | Meaning | +| :--- | :--- | +| type | Type of protocol of the route: "tcp" for TCP routes, "http" for HTTP routes | +| routeId | Numeric identifier of the route | +| displayName | Display name of the route | -### Actions available +#### Available actions -This call returns the list of actions available for TCP and HTTP routes, as well as the values expected for each of the fields. +This call returns the list of available actions for TCP and HTTP routes as well as the expected values for each of the fields. -If a field is “null”, this means that no value is expected. If an invalid value is entered, the API will return a validation error. +If a field is "null", it means that no value is expected. If an invalid value is provided, the API will return a validation error. -All of the actions managed by the OVH Load Balancer service are final. This means that executing an action also triggers the end of route evaluation. +All actions managed by the OVHcloud Load Balancer service are final. This means that the execution of an action also ends the evaluation of the routes. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteActions -> +> -Query +- Request: -|Setting|Meaning| -|---|---| -|serviceName|Your Load Balancer service ID| +| Parameter | Meaning | +| :--- | :--- | +| serviceName | Identifier of your Load Balancer service | -Answer +- Response: -|Setting|Meaning| -|---|---| -|type|Shows if this action is valid for a HTTP or a TCP route| -|name|Name of the action to enter into the `type` field of routes| -|status|List of HTTP status codes available for this action (`status` fields of routes)| -|destination|Value type expected in the `destination` fields for routes| +| Parameter | Meaning | +| :--- | :--- | +| type | Indicates whether this action is valid for an HTTP route or a TCP route | +| name | Name of the action to specify in the `type` field of the routes | +| status | List of available HTTP status codes for this action (the `status` field of the routes) | +| destination | Type of value expected in the `destination` field of the routes | -#### Redirection +##### **Redirection** -This action sends a redirection to the visitor. This redirection type can be configured with the status field. When this action is selected, no farms will receive the request. +This action returns a redirection to the visitor. The type of redirection can be configured with the `status` field. When this action is selected, no farm will receive the request. -|Setting|Value| -|---|---| -|type|`redirect`| -|status|301, 302, 303, 307 or 308| -|target|Target URL (may contain variables)| +| Parameter | Value | +| :--- | :--- | +| type | `redirect` | +| status | 301, 302, 303, 307 or 308 | +| target | Destination URL (can contain variables) | -Only the HTTP redirection status codes can be specified. The most common codes are 301 and 302. If you have any doubts, you can set up a 302 (temporary redirection). The HTTP status codes for redirections are: +Only HTTP redirection status codes can be specified. The most common are codes 301 and 302. If you are unsure, you can use the 302 "Temporary Redirect". The HTTP status codes recognized for redirections are: -|Status code|Description| -|---|---| -|301|Permanent redirection. The redirection can be saved by the browser.| -|302 (default)|Temporary redirection. The redirection must be revalidated for each request by the browser.| -|303|Works like a 302, and forces the use of the HTTP GET method.| -|307|Works like a 302, and forces the same HTTP method to be reused (GET, POST, etc.).| -|308|Works like a 301, and forces the same HTTP method to be reused (GET, POST, etc.).| +| Status code | Description | +| :--- | :--- | +| 301 | Permanent redirect. The redirect can be stored by the browser. | +| 302 (default) | Temporary redirect. The redirect must be revalidated by the browser on each request. | +| 303 | Like 302 and forces the use of the HTTP GET method. | +| 307 | Like 302 and forces the reuse of the same HTTP method (GET, POST, etc.). | +| 308 | Like 301 and forces the reuse of the same HTTP method (GET, POST, etc.). | -The target URL may contain simple variables. This helps users redirect to another domain, another protocol or add a suffix/prefix to a URL. The recognised variables are: +The destination URL can contain simple variables. This allows you to redirect to another domain, another protocol or add a suffix / prefix to a URL. The recognized variables are: -|Variable|Description| -|---|---| -|`protocol`|Protocol of the request ("http" or "https")| -|`domain`|Domain name of the request, without the port number| -|`host`|"Host" field of the request, including the port number, if there is one| -|`port`|Port of the request| -|`path`|Path of the request, starts with a '/' and ends before the first '?'| -|`arguments`|Arguments of the request, starts with a '?' if present| +| Variable | Description | +| :--- | :--- | +| `protocol` | Protocol of the request ("http" or "https") | +| `domain` | Domain name of the request, without the port number | +| `host` | "Host" field of the request, including the port number if present | +| `port` | Port of the request | +| `path` | Path of the request, starts with a '/' and ends at the first '?' | +| `arguments` | Arguments of the request, starts with a '?' if present | -For example, for: +For example, to: -- redirect to https: `https://${host}${path}${arguments}` -- redirect to a new domain: ${protocol}://new.example.com${path}${arguments} -- prefix the URL: ${protocol}://${host}/staging${path}${arguments} +- redirect to https: `https://\${host}\${path}\${arguments}` +- redirect to a new domain: `${protocol}://new.example.com\${path}\${arguments}` +- prefix the URL: `${protocol}://\${host}/staging\${path}\${arguments}` -#### Reject. +##### **Rejection** -This action returns an HTTP error status code to the visitor. The HTTP error code can be configured with the status field. When this action is selected, no farms will receive the request. +This action returns an HTTP error status code to the visitor. The error HTTP status code can be configured with the `status` field. When this action is selected, no farm will receive the request. -|Setting|Value| -|---|---| -|type|`reject`| -|status|200, 400, 403, 405, 408, 429, 500, 502, 503 or 504| -|target|not available| +| Parameter | Value | +| :--- | :--- | +| type | `reject` | +| status | 200, 400, 403, 405, 408, 429, 500, 502, 503 or 504 | +| target | not available | > [!primary] > -> This action is also available in TCP. In this case, the parameter status is not available, and the request is terminated. TCP requests that are terminated like this are not compatible with high percentages of requests. -> +> This action is also available in TCP. In this case, the `status` parameter is not available and the request is terminated. TCP requests terminated in this way are not counted in the request rate. +> -Only the HTTP error codes listed in the API can be specified. The most common ones are 400 ("Bad request") errors, and 403 ("Forbidden") errors. A 200 code can be used to block a request type while simulating a success, and a 503 code can be used to simulate a server outage. +Only the HTTP error status codes listed in the API can be specified. The most common are the codes 400 "Bad request" and 403 "Forbidden". 200 can be used to block a type of request while simulating a success, and 503 can be used to simulate a server failure. -|Status code|Description| -|---|---| -|200|The request has been successfully executed.| -|400|Invalid request.| -|403 (default)|Access forbidden.| -|405|Method (GET, POST, PUT, ...) invalid or not managed.| -|408|The request has taken too long to be sent by the client.| -|429|The client has sent too many requests (rate limiting).| -|500|Generic server error.| -|502|Error communicating with the server.| -|503|The service is temporarily unavailable.| -|504|The server has taken too much time to respond.| +| Status code | Description | +| :--- | :--- | +| 200 | The request was executed successfully. | +| 400 | Invalid request. | +| 403 (default) | Access forbidden. | +| 405 | Invalid or unhandled method (GET, POST, PUT, etc.) +| 408 | The client failed to send a complete request within the server's time limit. | +| 429 | The client sent too many requests (rate-limiting). | +| 500 | Generic server error. | +| 502 | Communication error with the server. | +| 503 | The service is temporarily unavailable. | +| 504 | The server took too long to respond. | -#### Routing. +##### **Routing** -This action redirects requests to a specific farm, other than the default farm configured on the front-end. The destination farm must be the same type as the front-end ("http" or "tcp"). +This action directs requests to a specific farm, other than the default farm configured on the frontend. The target farm must be of the same type as the frontend ("http" or "tcp"). -|Setting|Value| -|---|---| -|type|`farm`| -|status|not available| -|target|The destination farm’s ID number. This must be the same type.| +| Parameter | Value | +| :--- | :--- | +| type | `farm` | +| status | not available | +| target | Numeric identifier of the target farm. This must be of the same type | > [!primary] > -> This action is also available in TCP. In this case, the destination farm type must be "tcp". -> +> This action is also available in TCP. In this case, the target farm must be of type "tcp". +> -### Available rules. +#### Available rules -This call returns the list of rules available for TCP and HTTP routes, as well as the values expected for each of the fields. +This call returns the list of available rules for TCP and HTTP routes, as well as the expected values for each field. -If a field is “null”, this means that no value is expected. If an invalid value is entered, the API will return a validation error. +If a field is "null", it means no value is expected. If an invalid value is provided, the API will return a validation error. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteRules -> +> -Query +- Request: -|Setting|Meaning| -|---|---| -|serviceName|Your Load Balancer service ID| +| Parameter | Meaning | +| :--- | :--- | +| serviceName | Identifier of your Load Balancer service | -Answer +- Response: -|Setting|Meaning| -|---|---| -|type|Type of protocol for the route: "tcp" for TCP routes, "http" for HTTP routes| -|name|Name of the property on which to apply this rule, to be entered into the `field` field| -|hasSubField|"true" is this property is a sub-property (e.g. a header or cookie)| -|matches|List of comparisons available for each rule, to be entered into the `match` field| -|pattern|Type of value expected for the `pattern` field| -|enum|List of values for the chmaps `pattern`, if it is a list| +| Parameter | Meaning | +| :--- | :--- | +| type | Protocol type of the route: "tcp" for TCP routes, "http" for HTTP routes | +| name | Name of the property to which this rule applies, to be filled in the `field` field | +| hasSubField | "true" if this property has a "sub-property" (e.g.: a header or a cookie) | +| matches | List of available comparators for this rule, to be filled in the `match` field | +| pattern | Type of expected value for the `pattern` field | +| enum | List of possible values for the `pattern` field if it is an enumeration | -The different `pattern` types are: +The different types of `pattern` are: -|Value|Meaning| -|---|---| -|cidr|IP address (a.b.c.d) or sub-network (a.b.c.d/z)| -|string|Free text. For the `in` operator, a list of values separated by columns (255 characters maximum)| -|enum|The field is a list defined in `enum`| +| Value | Meaning | +| :--- | :--- | +| cidr | IP address (a.b.c.d) or subnet (a.b.c.d/z) | +| string | Free text. For the operator `in`, a list of comma-separated values (maximum 255 characters) | +| enum | The field is an enumeration defined in `enum` | -#### Protocol. +##### **Protocol** -With this rule, you can filter requests depending on their protocol. In practice, the uses for this rule are quite limited, as the protocol depends on the front-end that the route is attached to, or a front-end that only manages a single protocol recognised the moment the route is defined. +This rule allows filtering requests based on their protocol. In practice, the use cases for this rule are quite limited because the protocol depends on the frontend to which the route is attached, and a frontend only handles one protocol, which is known at the time the route is defined. -|Fields|Value| -|---|---| -|name|`protocol`| -|hasSubField|no| -|matches|`is` or `in`| -|pattern|`tcp`, `tls`, `http` or `https`| +| Field | Value | +| :--- | :--- | +| name | `protocol` | +| hasSubField | no | +| matches | `is` or `in` | +| pattern | `tcp`, `tls`, `http` or `https` | > [!primary] > -> This action is also available in TCP. In this case, "http/2.0" protocol is also available. It is based on the "ALPN" SSL/TLS field used by browsers to announce that they are attempting to establish a HTTP/2.0 connection. This way, you can have a common TCP front-end for SSL/TLS termination of HTTP 1 and 2, then direct traffic depending on the protocol version. -> +> This action is also available in TCP. In this case, the "http/2.0" protocol is also available. It is based on the SSL/TLS "ALPN" field used by browsers to announce that they are trying to establish an HTTP/2.0 connection. This allows for a common TCP frontend for HTTP 1 and 2 SSL/TLS termination, then routing these streams based on the protocol version. +> -#### Source address. +##### **Source address** -With this rule, you can filter requests depending on their source address. By combining it with a rule based on the URI or the domain name, you can restrict certain resources to an enterprise proxy while exposing all of your other resources without restrictions, via your OVH Load Balancer. +This rule allows filtering requests based on their source address. By combining it with a rule based on the URI or domain name, it is for example possible to restrict certain resources to an enterprise proxy, while exposing all other resources without restrictions on your OVHcloud Load Balancer service. -|Fields|Value| -|---|---| -|name|`source`| -|hasSubField|no| -|matches|`is` or `in`| -|pattern|Sub-network (a.b.c.d/z) or address (a.b.c.d)| +| Field | Value | +| :--- | :--- | +| name | `source` | +| hasSubField | no | +| matches | `is` or `in` | +| pattern | Subnet (a.b.c.d/z) or address (a.b.c.d) | > [!primary] > -> This action is also available in TCP using the same method. -> +> This action is also available in TCP with the same behavior. +> -To block a particular network and address, for example, you can use a pattern like "4.4.0.0/16, 8.8.8.8". +For example, to block a network and a specific address, you can use a pattern such as "4.4.0.0/16, 8.8.8.8". -#### Domain name. +##### **Domain name** -With this rule, you can filter requests depending on their domain name. In doing so, you can reproduce the Apache "vhost" feature, or route all of the domains that start with "mail." to a server dedicated to webmail. +This rule allows filtering requests based on their domain name. This can for example be used to reproduce the "vhost" function of Apache or to route all domains starting with "mail." to a server dedicated to webmail. -|Fields|Value| -|---|---| -|name|`host`| -|hasSubField|no| -|matches|`is`, `in`, `contains`, `startswith`, `endswith` or `matches`| -|pattern|Character chain or regular expression| +| Field | Value | +| :--- | :--- | +| name | `host` | +| hasSubField | no | +| matches | `is`, `in`, `contains`, `startswith`, `endswith` or `matches` | +| pattern | String or regular expression | > [!primary] > -> This action is also available in TCP. It will only work if the front-end is configured to accept SSL/TLS connections, and if the client sends an "SNI" option. This is especially the case with recent web browsers. -> +> This action is also available in TCP. It is only applicable if the frontend is configured to accept SSL/TLS connections and the client sends an "SNI" option. This is particularly the case for recent web browsers. +> -#### HTTP method. +##### **HTTP method** -With this rule, you can filter requests depending on their HTTP method. It is commonly used alongside a rule based the request URI or path, to make the rule more selective. +This rule allows filtering requests based on the HTTP method. It is commonly used in conjunction with a rule based on the request URI or path to make the rule more selective. -|Fields|Value| -|---|---| -|name|`method`| -|hasSubField|no| -|matches|`is` or `in`| -|pattern|`GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS` or `TRACE`| +| Field | Value | +| :--- | :--- | +| name | `method` | +| hasSubField | no | +| matches | `is` or `in` | +| pattern | `GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS` or `TRACE` | -#### Request path. +##### **Request path** -With this rule, you can filter requests depending on their path, or URI. The request path is between the first '/' (inclusive) and the first '?' (excluded). +This rule allows filtering requests based on the request path or URI. The request path is the part between the first '/' included and the first '?' excluded. -|Fields|Value| -|---|---| -|name|`uri`| -|hasSubField|no| -|matches|`is`, `in`, `contains`, `startswith`, `endswith` or `matches`| -|pattern|Character chain or regular expression| +| Field | Value | +| :--- | :--- | +| name | `uri` | +| hasSubField | no | +| matches | `is`, `in`, `contains`, `startswith`, `endswith` or `matches` | +| pattern | String or regular expression | -#### Request parameter. +##### **Request parameter** -This rule filters requests depending on their existence, or the value of a specific HTTP request parameter. This is the part after the first '?'. If a parameter is specified several times in a request, only the first instance is taken into account. +This rule allows filtering requests based on the existence or value of a specific HTTP request parameter. This is the part after the first '?'. If a parameter is specified multiple times in the request, only the first one is taken into account. -|Fields|Value| -|---|---| -|name|`param`| -|hasSubField|yes| -|matches|`is`, `in`, `contains`, `startswith`, `endswith` or `matches`| -|pattern|Character chain or regular expression| +| Field | Value | +| :--- | :--- | +| name | `param` | +| hasSubField | yes | +| matches | `is`, `in`, `contains`, `startswith`, `endswith` or `matches` | +| pattern | String or regular expression | -#### HTTP header. +##### **HTTP header** -This rule filters requests depending on their existence, or the value of a specific HTTP header value. You can use it to detect the opening of a WebSocket connection, and direct it to a dedicated server farm. +This rule allows filtering requests based on the existence or value of a specific HTTP header. This can for example be used to detect the opening of a websocket connection and route it to a dedicated farm. -|Fields|Value| -|---|---| -|name|`header`| -|hasSubField|yes| -|matches|`is`, `in`, `contains`, `startswith`, `endswith` or `matches`| -|pattern|Character chain or regular expression| +| Field | Value | +| :--- | :--- | +| name | `header` | +| hasSubField | yes | +| matches | `is`, `in`, `contains`, `startswith`, `endswith` or `matches` | +| pattern | String or regular expression | -#### Cookie. +##### **Cookie** -With this rule, you can filter requests depending on the existence or value of a specific HTTP cookie. You can use it to direct voluntary visitors to a pre-production farm. +This rule allows filtering requests based on the existence or value of a specific HTTP cookie. This can for example be used to direct opt-in visitors to a pre-production farm. -|Fields|Value| -|---|---| -|name|`cookie`| -|hasSubField|yes| -|matches|`is`, `in`, `contains`, `startswith`, `endswith` or `matches`| -|pattern|Character chain or regular expression| +| Field | Value | +| :--- | :--- | +| name | `cookie` | +| hasSubField | yes | +| matches | `is`, `in`, `contains`, `startswith`, `endswith` or `matches` | +| pattern | String or regular expression | ## Go further -Join our community of users on . +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_route/guide.en-sg.md b/pages/network/load_balancer/create_route/guide.en-sg.md index 9e166eec1fe..efe77c2df9f 100644 --- a/pages/network/load_balancer/create_route/guide.en-sg.md +++ b/pages/network/load_balancer/create_route/guide.en-sg.md @@ -1,875 +1,880 @@ --- -title: 'Working with HTTP routes' -excerpt: 'Find out how to direct your requests dynamically, to a specific farm' -updated: 2018-04-09 +title: "Configuring an OVHcloud Load Balancer with HTTP routes" +excerpt: "Find out how to dynamically direct your requests to a specific farm" +updated: 2025-11-27 --- ## Objective -The OVH Load Balancer service redirects the front-end’s incoming traffic to the servers that make up the front-end’s default farm, or its default redirection. +The OVHcloud Load Balancer service redirects the front-end’s incoming traffic to the servers that make up the front-end’s default farm, or its default redirection. -In some cases, you can go a step further and route, redirect or block traffic according to a range of criteria. For example, in the case of a HTTP(S) service, you can filter traffic depending on the HTTP method, the URL, and even a cookie or header value! In the OVH Load Balancer service, these are called `routes`{.action}. A route is a particular action to carry out if one or more conditions are met. +In some cases, you can go further and route, redirect, or block traffic according to a range of criteria. For example, in the case of an HTTP(S) service, you can filter traffic based on the HTTP method, the URL, or even the value of a cookie or header. -**This guide will show you how to direct your requests dynamically, to a specific farm.** +In the OVHcloud Load Balancer service, these elements are called **routes**. A route is a specific action to perform if one or more conditions are met. + +**This guide will show you how to direct your requests dynamically to a specific farm using routes.** ## Requirements -- an [OVH Load Balancer](https://www.ovh.com/sg/solutions/load-balancer/) on a solution that lets you create routes -- access to the [OVH API](/links/api) +- Have an [OVHcloud Load Balancer](/links/network/load-balancer) on an offer allowing the creation of routes. +- Have access to the [OVHcloud API](/links/api). ## Instructions > [!primary] > -> Although this guide focuses on HTTP routes, the same principle applies to TCP (with TCP routes). This can be used to direct HTTP/2 traffic to a particular farm, or reject incoming requests from certain IPs. -> +> Although this guide focuses on **HTTP routes**, the same principle applies to **TCP routes**. This can be useful for directing HTTP/2 traffic to a specific farm or rejecting incoming requests from certain IP addresses. +> -Since this feature is still very new, it is only available in the API. This guide will explain the general principles behind routing, and provide practical examples of routes being used. +This feature is only available via the API. This guide will present the general principles as well as use cases for routes drawn from real-life scenarios. -- **An introduction to routes**. +### Introduction to routes -A route controls traffic according to different criteria. You can express these criteria as rules, conditions, or actions. +A route is used to control traffic according to different criteria. They can be expressed in the form of **rules**, **conditions**, or **actions**. -For example, *IF* the URL _starts_ with '/wp-admin/' (1) *AND* the connection _is_ in HTTP (2) *THEN* _redirect_ to the HTTPS version of the page (3). +For example, *IF* the URL _starts with_ '/wp-admin/' (1) *AND* the connection _is_ HTTP (2) *THEN* _redirect_ to the HTTPS version of the page (3). -In this example, there are two rules: +In this example, there are two rules : -- the connection must come from a HTTP front-end (2) -- its URL must begin with the WordPress admin pages (1) +- the connection must come from an HTTP frontend (2); +- its URL must start with the WordPress administration pages (1). There is an action associated with these rules: redirect to the HTTPS version of the page (3). -This is what is known as an ‘end action’. It means that if the rules are confirmed, the evaluation of routes stops, and the action is executed. +This is what is known as an "end action". That means if the rules are validated, the evaluation of the routes stops and the action is executed. -## An introduction to the API. +### API presentation -You can only manage routes via the [OVH API](/links/api). It is only valid for `http`{.action} and `tcp`{.action} protocols, and the `/ipLoadbalancing/{serviceName}/{protocol}/route/`{.action} pathway exposes the API dedicated to routes. +Route management is only available through the [OVHcloud API](/links/api). It is only valid for the **http** and **tcp** protocols, and the path `/ipLoadbalancing/{serviceName}/{protocol}/route/`{.action} exposes the dedicated route API. -The API for routes to the OVH Load Balancer is specially designed for flexibility, power and scalability. It is organised around three main sections: +The OVHcloud Load Balancer service route API has been specifically designed to be flexible, powerful, and scalable. It is organized around three main sections: -1. the APIs listing available rules and actions -2. the APIs listing the routes configured on the OVH Load Balancer service -3. the APIs for configuring routes on the OVH Load Balancer service +1. API calls listing the available rules and actions. +2. API calls listing the routes configured on your OVHcloud Load Balancer service. +3. API calls for configuring the routes of your OVHcloud Load Balancer service. > [!primary] > -> To only show the APIs linked to routes in the OVH API console, you can use the `filter`{.action} field with ‘route’ as a keyword. -> +> To display only the API calls related to routes in the OVHcloud API console, you can use the `filter`{.action} field with the keyword "[a-z]*". +> -When you want to configure a route or rules, the first thing you need to do is look at the available actions and rules. This will give you the possible values for the API route and rule configuration fields. +When you want to configure a route or rules, the first thing to do is to consult the **available actions and rules**. This will give you the possible values for the configuration fields of the route and rule APIs. - A route can have several rules. -- A route can only be attached to a single front-end. -- A front-end can have several routes. In this case, the order of evaluation depends on its type and weight. +- A route can only be attached to a single frontend. +- A frontend can have several routes. In this case, the evaluation order depends on its type and weight. -When a request arrives at your OVH Load Balancer service, the routes are evaluated successively following the principles below: +When a request arrives on your OVHcloud Load Balancer service, the routes are evaluated successively according to the following principles: -1. firstly, reject and rewrite routes, then the farm routes -1. within categories, the routes are evaluated in order of ascending weight -1. if two routes are the same weight, the first route created is evaluated first -1. only the first action from all the validated rules is executed +1. first, the **reject and rewrite routes**, then the **farm routes**; +2. within these categories, the routes are evaluated in **increasing weight order**; +3. if two routes have the same weight, the **first route created** is evaluated first; +4. only the **first action** of all validated rules is executed. -### Available rules and actions. +### Available rules and actions -This first section of the API contains an updated list of actions and rules available for the OVH Load Balancer service. It contains a call for actions, and another for rules. These two calls return a list of objects. Each object has a name, and if it applies to all TCP or HTTP routes as well as the values or value types expected for different fields of the API. If a field is “null”, this means that no value is expected. If an invalid value is entered, the API will return a validation error. +This first section of the API contains an up-to-date list of available actions and rules for your OVHcloud Load Balancer service. It contains one call for the actions and another for the rules. These two calls return a list of objects. Each object is named, and indicates whether it applies to TCP or HTTP routes, as well as the expected values or types of values for the different fields of the API. If a field is "null", it means no value is expected. If an invalid value is provided, the API will return a validation error. #### Actions > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteActions -> +> -For more information on this call, please read the [Available actions](#available-actions){.internal} section at the bottom of this guide. +For more information on this call, we invite you to consult the section [Available Actions](#available-actions), at the bottom of this guide. -#### Rules: +#### Rules > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteRules -> +> -For more information on this call, please read the [Available rules](#available-rules){.internal} section at the bottom of this guide. +For more information on this call, we invite you to consult the section [Available Rules](#available-rules), at the bottom of this guide. -### Configured routes. +### Configured routes -This section of the API only contains one call. It was mainly designed to help implement auto-complete systems. It returns the ID, name and type of each defined route. You can get a route’s details with a GET /ipLoadbalancing/{serviceName}/route/{type}/{routeId} call, defined further below. +This second section of the API contains only one call. It was mainly designed to facilitate the implementation of auto-completion mechanisms. It returns the identifier, name, and type of each defined route. The details of a route can be obtained with a `GET /ipLoadbalancing/{serviceName}/route/{type}/{routeId}` call defined below. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/definedRoutes -> +> -For more information on this call, please read the [Edit routes](#edit-routes){.internal} section at the bottom of this guide. +For more information on this call, we invite you to consult the section " [Route Handling](#handling-routes) ", at the bottom of this guide. -### Route configuration. +### Route configuration -With these basic principles around the action and rules available, and the order in which routes are evaluated, these routes can be edited the same way as the farms can. When you create a route, you can attach rules to it. The possible values for rules and actions are defined by the API calls. +With these basic principles on available actions and rules, and the route evaluation order, these routes can be manipulated in the same way as farms. When you create a route, you can attach rules to it. The possible values for the rules and actions are defined by the API calls. -For more information on these calls, please read the [Edit routes](#edit-routes){.internal} section at the bottom of this guide. +For more information on these methods, you can consult the section " [Route Handling](#handling-routes) ", at the bottom of this guide. ## Examples -If you still have doubts about the power of routes, this should change your mind. The purpose of this section is to offer some practical examples of how this technology has been used for OVH’s internal requirements, without going into great detail about API calls. +To demonstrate the utility of routes, this section will offer some practical examples of the use of this technology for OVHcloud's internal needs, without going into the details of the API calls. -You can read about API calls in more detail in the [Edit routes](#edit-routes){.internal} section at the bottom of this guide, and the sections that follow it. +You will find the details of the API calls in the section [Route Handling](#handling-routes), at the bottom of this guide and the following sections. -### Force HTTPS for WordPress login pages. +### Force HTTPS for WordPress login pages -HTTPS protocol has become the norm. Its purpose is to make all websites available securely in HTTPS, with the SSL/TLS protocol. If you need an SSL/TLS certificate, you can use the OVH Load Balancer service to order a new one, which will be automatically managed for you. +The HTTPS protocol has become the norm. Its objective is to make all websites available in HTTPS in a secure manner, thanks to the SSL/TLS protocol. If you need an SSL/TLS certificate, you can use your OVHcloud Load Balancer service to order a new one, which will be managed for you in a completely automatic way. -Migrating a website to HTTPS involves a lot of work, especially to avoid [mixed content](https://developer.mozilla.org/en-us/docs/Web/Security/Mixed_content). It may be worth migrating your website section by section, and starting by securing pages that send login credentials. +Migrating a website to HTTPS requires work, especially to avoid [Mixed-Content](https://developer.mozilla.org/en-us/docs/Web/Security/Mixed_content) problems. It may be interesting to migrate your website section by section, starting by securing the pages that send login credentials. -One approach could be to base it on the beginning of WordPress URLs. By default, the URL the login pages for WordPress start with "/wp-login". So we would need: +An approach could be to rely on the beginning of WordPress URLs. By default, the URLs of WordPress login pages start with "/wp-login". We would therefore need to: -- a route with a redirect action -- a rule in this route that detects URLs starting with "/wp-login" +- a route with a **redirection action**; +- a rule in this route that detects URLs starting with **"/wp-login"**. -In practice, this gives a route like this: +In practice, this gives a route as follows: -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|frontendId|Your HTTP front-end ID| -|displayName|“Redirection of WordPress logins to HTTPS”| -|weight|(empty)| -|action.type|"redirect"| -|action.status|302 for a temporary redirection, 301 for a permanent redirection| -|action.target|"`https://${host}${path}${arguments}`" to take the same host, path and arguments| +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| frontendId | Identifier of your HTTP frontend | +| displayName | "Redirect WordPress connections to HTTPS" | +| weight | (empty) | +| action.type | "redirect" | +| action.status | 302 for a temporary redirect, 301 for a permanent redirect | +| action.target | "`https://\${host}\${path}\${arguments}`" to take the same host, path and arguments | On this route, we will attach a rule: -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|routeId|Route ID created above| -|field|"uri"| -|subField|(empty)| -|match|"startswith"| -|negate|false| -|pattern|"/wp-login"| +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| routeId | Identifier of the route created above | +| field | "uri" | +| subField | (empty) | +| match | "startswith" | +| negate | false | +| pattern | "/wp-login" | -Next, apply the configuration to the zone concerned, and the rule will begin to work. +Then apply the configuration to the concerned area. > [!warning] > -> To add a new redirection, you will need to repeat these actions again, creating a route, then a rule. If a second rule is added to the same route, the two rules need to be validated for the redirect to work. Note that if the rules are "startswith /wp-login" and "startswith /wp-admin", the redirection would never work because these two conditions cannot both be true at once. -> +> To add a new redirection, you will have to repeat these actions, creating a route, then a rule. If a second rule is added to the same route, both rules must be validated for the redirection to work. Note that if the rules are `startswith /wp-login` and `startswith /wp-admin`, the redirection will never work because these two conditions cannot be true at the same time. +> -### Route according to a domain (vhost) +### Route based on a domain (VHost) -This feature helped propel the expansion of the web at its very early stages, by exposing several websites behind a single IP address using the “host” field of HTTP headers. +This is the feature that made the web possible when it was in its infancy, with the possibility of exposing several sites behind the same IP address thanks to the "Host" field of HTTP headers. -For example, if your infrastructure is made up of a VPS for your website, an OVH Load Balancer to ensure SSL/TLS termination, and redirection to a maintenance page with a backup server in the farms, you would originally have needed one Additional IP per website, routed to your OVH Load Balancer, and one front-end per IP. +For example, if your infrastructure is composed of a VPS for your website, an OVHcloud Load Balancer for SSL/TLS termination, and redirections to a maintenance page with a backup server in the farms, you would have needed an Additional IP per website, routed to your OVHcloud Load Balancer, and a frontend per IP in the past. -With routes, you can share the same front-end, and choose the server farm dynamically, with the “host” field. +With routes, you can share the same frontend and choose the server farm dynamically, thanks to the *[a-z]* field. -To do this, you will need: +For this, you will need: -- one route per vhost -- one rule per route detecting a specific domain +- a route per VHost; +- a rule per route detecting a specific domain. -In practice, to route the domain www.example.com, this would give the following route: +In practice, to route the domain **www.example.com**, this will give the following route: -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|frontendId|Your front-end ID| -|displayName|"VHost - www.example.com"| -|weight|(empty)| -|action.type|"farm"| -|action.status|(empty)| -|action.target|ID of the farm to direct this domain to| +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| frontendId | Identifier of your frontend | +| displayName | "VHost - www.example.com" | +| weight | (empty) | +| action.type | "farm" | +| action.status | (empty) | +| action.target | Identifier of the farm to which to direct this domain | And on this route, we will attach a rule: -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|routeId|Route ID created above| -|field|"host"| -|subField|(empty)| -|match|"is"| -|negate|false| -|pattern|"www.example.com" or a domain of your choice| +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| routeId | Identifier of the route created above | +| field | "host" | +| subField | (empty) | +| match | "is" | +| negate | false | +| pattern | "www.example.com" or a domain of your choice | Finally, apply the configuration. -### Reserve an Additional IP to a particular website. +### Reserve an Additional IP for a specific website -If you are hosting a website on a VPS, you may want to dedicate an IP address to a specific customer. You can easily make the IP available by routing it to your OVH Load Balancer service, then configuring a dedicated front-end attached to this Additional IP address, and having the customer’s target VPS set as a defaultFarmId. +If you host a website on a VPS, you might want to dedicate an IP address to a specific client. You can easily make the IP available by routing it to your OVHcloud Load Balancer service, then configuring a dedicated frontend attached to this Additional IP, and setting the client's target VPS as the `defaultFarmId`. -But what will happen if another customer detects this, and configures their domain to point to the premium customer’s IP address? By default, this will work, and its website will be routed to the other VPS. If there is an SSL/TLS certificate, it will still work as all of the certificates are automatically available for all of the front-ends. +However, what will happen if another client detects this and configures their domain to point to the premium client's IP? By default, this will work, and their website will be routed to another client's VPS. If an SSL/TLS certificate is present, this will still work, as all certificates are automatically available for all frontends. -In such scenarios, the solution is to add a rule that will reject requests if the domain is not a premium one. You can do this with a rejection route and a rule. +In such scenarios, the solution is to add a rule that **rejects requests if the domain is not a premium domain**. You can do this with a reject route and a rule. -In practice, to reserve a front-end with an IP dedicated to the domain www.example.com, this will give the following route: +In practice, to reserve a frontend with a dedicated IP for the domain **www.example.com**, this will give the following route: -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|frontendId|Your front-end ID| -|displayName|"Restrict to www.example.com"| -|weight|(empty)| -|action.type|"reject"| -|action.status|403| -|action.target|(empty)| +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| frontendId | Identifier of your frontend | +| displayName | "Restriction to www.example.com" | +| weight | (empty) | +| action.type | "reject" | +| action.status | 403 | +| action.target | (empty) | And on this route, we will attach a rule: -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|routeId|Route ID created above| -|field|"host"| -|subField|(empty)| -|match|"is"| -|negate|true| -|pattern|"www.example.com" or a domain of your choice| +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| routeId | Identifier of the route created above | +| field | "host" | +| subField | (empty) | +| match | "is" | +| negate | true | +| pattern | "www.example.com" or a domain of your choice | Finally, apply the configuration. -### Route depending on a URL and HTTP method. +### Route based on a URL and an HTTP method -On some specific infrastructures, certain requests need to be routed to a specific farm. For example, to manage rare but data-intensive requests without impacting production, such as analytical requests that would work from a read-only duplicate of the data with a server that has a higher volume of memory. +On some specific infrastructures, certain requests must be routed to a specific farm. For example, to handle rare but data-intensive requests without impacting production, such as analytical requests that work on a read-only copy of the data with a server having a higher memory volume. If, for example, the request is sent: -- with the POST method -- on a URL corresponding to "^/.\*/batch-analytics$" +- with the **POST** method; +- on a URL matching **"^/.*/batch-analytics$"**. -... you would need a route with two rules, with one rule using a regular expression. +Then, you would need a route with two rules, one of which uses a regular expression. -In practice, this gives a route like this: +In practice, this gives a route as follows: -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|frontendId|Your front-end ID| -|displayName|"Route batch analytics to dedicated farm"| -|weight|(empty)| -|action.type|"farm"| -|action.status|(empty)| -|action.target|ID of the farm to direct these operations to| +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| frontendId | Identifier of your frontend | +| displayName | "Route batch analytics to a dedicated farm" | +| weight | (empty) | +| action.type | "farm" | +| action.status | (empty) | +| action.target | Identifier of the farm to which to direct these operations | And on this route, we will attach two rules: -|Field|Rule 1|Rule 2| -|---|---|---| -|serviceName|Your OVH Load Balancer service ID|as per rule 1| -|routeId|Route ID created above|as per rule 1| -|field|"method"|"uri"| -|subField|(empty)|(empty)| -|match|"is"|"matches"| -|negate|false|false| -|pattern|"POST"|"^/.\*/batch-analytics$"| +| Field | Rule 1 | Rule 2 | +| :--- | :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | as for rule 1 | +| routeId | Identifier of the route created above | as for rule 1 | +| field | "method" | "uri" | +| subField | (empty) | (empty) | +| match | "is" | "matches" | +| negate | false | false | +| pattern | "POST" | "`^/.*/batch-analytics$`" | + +Here, the first rule applies to an enumeration. Only standard HTTP methods are available. The second rule, on the other hand, exploits the full power of routes by using a regular expression. Although it is possible to use such expressions, avoiding them results in enhanced performance. -Here, the first rule applies on a list. Only standard HTTP methods are available. However, the second rule uses all the power of routes using a regular expression. Although it is possible to use expressions like this, if you can go without using them, your performance will be even higher. +All that remains is to apply the configuration in the concerned area. -Next, apply the configuration to the zone concerned. +#### Route certain IPs and voluntary clients to preproduction -### Route certain IPs and voluntary clients to a pre-production environment. +When a site grows, you may want to set up a preproduction environment to validate ongoing changes, without affecting the majority of users. Generally, when configuring this type of environment, you want to reduce the gap as much as possible between production and preproduction, in order to detect problems as accurately as possible. A classic and often neglected source of problems is the domain name. It is sometimes hardcoded in a file or an article. At that point, a link may work in preproduction but not in production. -When your website gains momentum, you may want to set up a pre-production environment, which you can use to check ongoing developments without affecting the majority of your users. Generally, when you configure an environment like this, it is best to minimise the differences between production and pre-production as much as possible, so that any issues can be detected as accurately as possible. A common but often-forgotten issue is the domain name, as it is sometimes hard-coded into a file or item. If this is the case, the link may work in pre-production, but not in production. +Instead of setting up rules based on the domain name, you could set up rules based on the source IP address (for example, an enterprise proxy) and possibly a cookie for voluntary clients. These configurations can be detected with two routes on your OVHcloud Load Balancer service. -Instead of setting up rules based on the domain name, you can set up rules based on the source IP (e.g. an enterprise proxy), and possibly a cookie for voluntary clients. These configurations can be detected with two routes on the OVH Load Balancer service. +For this example, we will consider: -For this example, we will consider that: +- that the enterprise proxy can use the addresses 42.42.42.0/24 and the VPN uses 1.2.3.4/32; +- that the voluntary users have a "PreprodOptIn" cookie, the value of which is not important. -- the enterprise proxy can use the addresses 42.42.42.0/24, and that the VPN uses 1.2.3.4/32 -- the voluntary users have a "PreprodOptIn" cookie — it doesn’t matter what the value is +In practice, you will need two identical routes: -In practice, we would need two identical routes: +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| frontendId | Identifier of your frontend | +| displayName | "Route Opt-In and internal users to preproduction environment" | +| weight | (empty) | +| action.type | "farm" | +| action.status | (empty) | +| action.target | Identifier of the preproduction farm | -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|frontendId|Your front-end ID| -|displayName|"Route Opt-In and internal users to pre-production environment"| -|weight|(empty)| -|action.type|"farm"| -|action.status|(empty)| -|action.target|Your pre-production farm’s ID| +Next, we attach the following 2 rules, each on one of the routes (1 rule per route): -Then we will attach the following two rules to each of the routes (one rule per route): +| Field | Rule 1 | Rule 2 | +| :--- | :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | same | +| routeId | Identifier of the first route | Identifier of the second route | +| field | "source" | "cookie" | +| subField | (empty) | "PreprodOptIn" | +| match | "in" | "exists" | +| negate | false | false | +| pattern | "42.42.42.0/24, 1.2.3.4" | (empty) | -|Field|Rule 1|Rule 2| -|---|---|---| -|serviceName|Your OVH Load Balancer service ID|as per rule 1| -|routeId|ID of the first route|ID of the second route| -|field|"source"|"cookie"| -|subField|(empty)|"PreprodOptIn"| -|match|"in"|"exists"| -|negate|false|false| -|pattern|"42.42.42.0/24, 1.2.3.4"|(empty)| +The first rule checks if the source IP is in a list of address ranges. In this case, the different address ranges are separated by commas and can be surrounded by spaces for better readability. If a range contains only one address, the "/32" is implicit but can be added explicitly. In any case, the size of this field is limited to 255 characters. -The first rule tests whether the source IP is in the address range list. In this case, the various address ranges are separated by commas, and can have spaces in between one another to make them easier to read. If the range only contains one address, the "/32" is implicit, but can be added explicitly. Either way, this field is limited to 255 characters. +The second rule simply checks the existence of the cookie. It would be possible to check if its value matches a regular expression or is in a list of possibilities, but this allows to show a simple example of what can be done with cookies. Rules based on HTTP Headers work according to a similar approach. -The second rule simply tests to see if a cookie exists. It is also possible to test if the value corresponds to a regular expression, or is found in a possibility list, but this offers a simple example of what you can do with cookies. Rules based on HTTP headers work using a similar approach. +All that remains is to apply the configuration in the concerned area. -Next, apply the configuration to the zone concerned. +#### Route WebSockets to a dedicated farm -### Route WebSockets to a dedicated farm. +When a site has interactive functions based on WebSockets such as a chatbot, you may want to direct these connections to a server farm dedicated to this task. In fact, it is quite simple.W -When a website has interactive features based on WebSockets — a chatbot, for example — you may want to direct these connections to a server farm dedicated to this task. This is actually quite simple. When a browser attempts to open a WebSockets connection, it sends a standard HTTP request with these headers: +When a browser tries to open a WebSocket connection, it sends a standard HTTP request with the headers: ``` Upgrade: websocket Connection: Upgrade ``` -In this case, only the first header needs to be detected. This can be done very easily with a route and a rule: +In practice, it is sufficient to detect the first header. This can be done very easily with a route and a rule: -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|frontendId|Your front-end ID| -|displayName|"Route WebSockets to a dedicated farm"| -|weight|(empty)| -|action.type|"farm"| -|action.status|(empty)| -|action.target|ID of the farm dedicated to WebSockets| +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| frontendId | Identifier of your frontend | +| displayName | "Route WebSockets to a dedicated farm" | +| weight | (empty) | +| action.type | "farm" | +| action.status | (empty) | +| action.target | Identifier of the WebSocket dedicated farm | -And on this route, we will attach a rule: +And on this route, we come to attach a rule: + +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| routeId | Identifier of the route created just above | +| field | "header" | +| subField | "Upgrade" | +| match | "is" | +| negate | false | +| pattern | "websocket" (case-sensitive) | -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|routeId|Route ID created above| -|field|"header"| -|subField|"Upgrade"| -|match|"is"| -|negate|false| -|pattern|"websocket" (case-sensitive)| +All that remains is to apply the configuration in the relevant zone. -Next, apply the configuration to the zone concerned. -## Reference. +### References -Here, you will find more details on the API calls linked to the routes. To get a general idea of how routes work, we recommend starting off by reading the [introduction to the API](#an-introduction-to-the-api){.internal} section further up. +You will find here the details of the API calls related to routes. For a more general overview of route features, we invite you to first consult the section " [API presentation](#apipresentation) " a little further up in this guide. -### Edit routes. +#### Handling routes -TCP and HTTP routes are configured the same way. Since the routes are more powerful in HTTP, this section focuses on HTTP rules and routes. TCP routes can be extrapolated from the information below by replacing “http” with “tcp” in each route. Some fields only apply to HTTP routes, and are not available in TCP. +TCP and HTTP routes are configured in the same way. Since HTTP routes are more powerful, this section focuses on HTTP routes and rules. The operation of TCP routes can be extrapolated by replacing "http" with "tcp" in the routes. Some fields only make sense in HTTP, so they are not available in TCP. -#### List the routes. +##### **List routes** -This call returns the list of ID numbers of routes defined for HTTP protocol. You can filter this list by frontendId. This call returns the routes in the order in which they will be evaluated. The evaluation order can be partially controlled by the weight of the route. +This call returns the list of numeric identifiers of routes defined for the HTTP protocol. You can filter this list by `frontendId`. This call returns the routes in the order in which they will be evaluated. The evaluation order can be partially controlled using the "weight" of the route. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route -> +> -|Setting|Required|Meaning| -|---|---|---| -|serviceName|Required|Your Load Balancer service ID| -|frontendId||ID number of a HTTP front-end the routes are attached to| +| Parameter | Required | Meaning | +| :--- | :--- | :--- | +| serviceName | Required | Identifier of your Load Balancer service | +| frontendId | | Numeric identifier of an HTTP frontend to which the routes are attached | -#### Create a route. +##### **Create a route** -With this call, you can create a route. Only the action is mandatory. A route can be attached to and detached from a front-end. You can create up to 50 routes on an OVH Load Balancer. This call returns the route created, if it is successful. You will need to re-deploy your OVH Load Balancer to apply the changes. +This call allows you to create a route. Only the action is mandatory. A route can be attached and detached from a frontend. It is possible to create up to 50 routes on an OVHcloud Load Balancer service. This call returns the created route in case of success. Your OVHcloud Load Balancer service must be redeployed to apply the changes. > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route -> +> -|Setting|Required|Meaning| -|---|---|---| -|serviceName|Required|Your Load Balancer service ID| -|displayName||Display name for your route (255 characters maximum)| -|frontendId||ID number of a HTTP front-end to attach the route to| -|weight||Route priority, between 1 (carry out first) and 255 (carry out after the others)| -|action.type|Required|Name of the action type to execute if all of the rules associated with the route are validated| -|action.status||HTTP status code for `reject` and `redirect` actions| -|action.target||ID number of the target farm for `farm` actions, or the URL template for `redirect` actions| +| Parameter | Required | Meaning | +| :--- | :--- | :--- | +| serviceName | Required | Identifier of your Load Balancer service | +| displayName | | Display name of your route (maximum 255 characters) | +| frontendId | | Numeric identifier of an HTTP frontend to which to attach the route | +| weight | | Priority of the route, between 1 (passes first) and 255 (passes after others) | +| action.type | Required | Name of the type of action to execute if all the rules associated with the route are validated | +| action.status | | HTTP status code for the `reject` and `redirect` actions | +| action.target | | Numeric identifier of the target farm for the `farm` actions, or URL pattern for the `redirect` actions | -The possible action types are listed below: +The possible action types are: -|action|Meaning| -|---|---| -|redirect|Redirects a request to `action.target`, with the HTTP `action.status` code| -|reject|Rejects a request with the HTTP `action.status` code| -|farm|Routes a request to the farm with the ID entered in `action.target`| +| action | Meaning | +| :--- | :--- | +| redirect | Redirect a request to `action.target` with the HTTP status code `action.status` | +| reject | Reject a request with the HTTP status code `action.status` | +| farm | Route a request to the farm whose identifier is specified in `action.target` | -For further information on the actions managed and the format of parameters, please read the [Available actions](#available-actions){.internal} section further down. +For more information on the actions handled and the format of the parameters, we invite you to consult the section " [Available actions](#available-actions) " further down in this guide. -#### View details on a route. +##### **View the details of a route** -With this call, you can view details on an HTTP route if you know its ID. +This call allows you to view the details of an HTTP route, knowing its identifier. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId} -> +> -Query +- Request: -|Setting|Meaning| -|---|---| -|serviceName|Your Load Balancer service ID| -|routeId|The route’s ID number| +| Parameter | Meaning | +| :--- | :--- | +| serviceName | Identifier of your Load Balancer service | +| routeId | Numeric identifier of the route | -Answer +- Response: -|Setting|Meaning| -|---|---| -|routeId|The route’s ID number| -|displayName|The display name for your route| -|frontendId|ID number of the front-end your route is attached to| -|weight|Priority of your route| -|action.type|Name of the action type for your route| -|action.status|Associated HTTP status code| -|action.target|ID number of the associated farm or URL template| -|rules|List of rules that must be validated to trigger the route’s action More detail on this is available in the [Edit rules](#edit-rules){.internal} section.| +| Parameter | Meaning | +| :--- | :--- | +| routeId | Numeric identifier of the route | +| displayName | Display name of your route | +| frontendId | Numeric identifier of the frontend to which your route is attached | +| weight | Priority of your route | +| action.type | Name of the type of action of your route | +| action.status | Associated HTTP status code | +| action.target | Numeric identifier of the farm or associated URL pattern | +| rules | List of rules that must be validated to trigger the action of the route. More details are available in the section " [Handling Rules](#handling-rules) ". | -For further information on the actions managed and the format of parameters, please read the [Available actions](#available-actions){.internal} section further down. +For more information on the actions handled and the format of the parameters, we invite you to consult the section "[Available actions](#available-actions)" further down in this guide. -#### Modify a route. +##### **Modify a route** -With this call, you can modify an HTTP route if you know its ID. You will need to re-deploy your OVH Load Balancer to apply the changes. +This call allows you to modify an HTTP route, knowing its identifier. Your OVHcloud Load Balancer service must be redeployed to apply the changes. > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId} > -|Setting|Required|Meaning| -|---|---|---| -|serviceName|Required|Your Load Balancer service ID| -|routeId|Required|The route’s ID number| -|displayName||Display name for your route (255 characters maximum)| -|frontendId||ID number of a HTTP front-end to attach the route to| -|weight||Route priority, between 1 (carry out first) and 255 (carry out after the others)| -|action.type|Required|Name of the action type to execute if all of the rules associated with the route are validated| -|action.status||HTTP status code for `reject` and `redirect` actions| -|action.target||ID number of the target farm for `farm` actions, or the URL template for `redirect` actions| +| Parameter | Required | Meaning | +| :--- | :--- | :--- | +| serviceName | Required | Identifier of your Load Balancer service | +| routeId | Required | Numeric identifier of the route | +| displayName | | Display name of your route (maximum 255 characters) | +| frontendId | | Numeric identifier of an HTTP frontend to which to attach the route | +| weight | | Priority of the route, between 1 (passes first) and 255 (passes after others) | +| action.type | Required | Name of the type of action to execute if all the rules associated with the route are validated | +| action.status | | HTTP status code for the `reject` and `redirect` actions | +| action.target | | Numeric identifier of the target farm for the `farm` actions, or URL pattern for the `redirect` actions | -For further information on the actions managed and the format of parameters, please read the [Available actions](#available-actions){.internal} section further down. +For more information on the actions handled and the format of the parameters, we invite you to consult the section " [Available actions](#available-actions) " further down in this guide. -#### Delete a route. +##### **Delete a route** -With this call, you can delete an HTTP route if you know its ID. When a route is deleted, all of the rules associated with the route are deleted, too. You do not need to delete them individually. You will need to re-deploy your OVH Load Balancer to apply the changes. +This call allows you to delete an HTTP route, knowing its identifier. When a route is deleted, all the rules associated with that route are also deleted. There is no need to delete them individually. Your OVHcloud Load Balancer service must be redeployed to apply the changes. > [!api] > > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId} -> +> -|Setting|Required|Meaning| -|---|---|---| -|serviceName|Required|Your Load Balancer service ID| -|routeId|Required|The route’s ID number| +| Parameter | Required | Meaning | +| :--- | :--- | :--- | +| serviceName | Required | Identifier of your Load Balancer service | +| routeId | Required | Numeric identifier of the route | -### Edit rules. +#### Handling rules -#### List the rules. +##### **List rules** -This call returns the list of ID numbers of rules defined for a particular route. +This call returns the list of numeric identifiers of rules defined for a given route. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule -> +> -|Setting|Required|Meaning| -|---|---|---| -|serviceName|Required|Your Load Balancer service ID| -|routeId|Required|The route’s ID number| +| Parameter | Required | Meaning | +| :--- | :--- | :--- | +| serviceName | Required | Identifier of your Load Balancer service | +| routeId | Required | Numeric identifier of the route | -#### Attach a rule. +##### **Attach a rule** -With this call, you can attach a rule to a route. You can attach up to 5 rules per route on an OVH Load Balancer. This call returns the route created, if it is successful. You will need to re-deploy your OVH Load Balancer to apply the changes. +This call allows you to attach a rule to a route. It is possible to attach up to 5 rules per route on an OVHcloud Load Balancer service. This call returns the created rule in case of success. Your OVHcloud Load Balancer service must be redeployed to apply the changes. > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule -> - -|Setting|Required|Meaning| -|---|---|---| -|serviceName|Required|Your Load Balancer service ID| -|routeId|Required|The route’s ID number| -|field|Required|The name of the HTTP parameter to apply the rule to| -|subField||HTTP header name for the `header` rules, or cookie name for `cookie` rules| -|match|Required|Name of the comparison to apply to validate the rule| -|negate||Reverses the comparison result| -|pattern||Comparison pattern| - -`field` - -|Value|Meaning| -|---|---| -|source|The address or list of source IP addresses (a.b.c.d/z)| -|protocol|Protocol (“http” or “https”)| -|method|HTTP method (GET, HEAD, POST, PUT, DELETE, OPTIONS, CONNECT, TRACE)| -|host|Domain name (vhost), without the port number| -|uri|Path of the request as it appears between the first "/" and the last "?"| -|param|HTTP parameter contained in the part after the first "?"| -|header|HTTP header| -|cookie|HTTP cookie| - -`match` - -|Value|Meaning| -|---|---| -|exists|The property must exist (e.g. HTTP header or cookie)| -|-|The property must correspond exactly to a `pattern`| -|in|The property must be in the list of values (separated by commas) defined by `pattern`| -|contains|The property must contain the `pattern` value| -|startswith|The property must start with the `pattern` value| -|endswith|The property must end with the `pattern` value| -|matches|The property must match the regular `pattern` expression| - -For further information on the rules managed and the format of parameters, please read the [Available rules](#available-rules){.internal} section further down. - -#### View details on a rule. - -With this call instruction, you can view the details on a rule attached to an HTTP route if you know its ID. +> + +| Parameter | Required | Meaning | +| :--- | :--- | :--- | +| serviceName | Required | Identifier of your Load Balancer service | +| routeId | Required | Numeric identifier of the route | +| field | Required | Name of the HTTP parameter on which to apply this rule | +| subField | | Name of the HTTP header for `header` rules or name of the cookie for `cookie` rules | +| match | Required | Name of the comparator to apply to validate the rule | +| negate | | Inverts the result of the comparator | +| pattern | | Comparator argument | + +- `field` + +| Value | Meaning | +| :--- | :--- | +| source | Address or list of source addresses in the form of IP (a.b.c.d/z) | +| protocol | Protocol. "http" or "https" | +| method | HTTP method (GET, HEAD, POST, PUT, DELETE, OPTIONS, CONNECT, TRACE) | +| host | Domain name (vhost), without the port number | +| uri | Request path as understood between the first "/" and the first "?" | +| param | HTTP parameter coming from the part after the first "?" | +| header | HTTP header | +| cookie | HTTP cookie | + +- `match` + +| Value | Meaning | +| :--- | :--- | +| exists | The property must exist (HTTP header or cookie for example) | +| is | The property must match exactly `pattern` | +| in | The property must be in the list of values (separated by commas) defined by `pattern` | +| contains | The property must contain the value of `pattern` | +| startswith | The property must start with the value of `pattern` | +| endswith | The property must end with the value of `pattern` | +| matches | The property must match the regular expression of `pattern` | + +For more information on the rules handled and the format of the parameters, we invite you to consult the section " [Available rules](#available-rules) " further down in this guide. + +##### **View the details of a rule** + +This call allows you to view the details of a rule attached to an HTTP route, knowing its identifier. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId} -> +> -Query +- Request: -|Setting|Meaning| -|---|---| -|serviceName|Your Load Balancer service ID| -|routeId|The route’s ID number| -|ruleId|The rule’s ID number| +| Parameter | Meaning | +| :--- | :--- | +| serviceName | Identifier of your Load Balancer service | +| routeId | Numeric identifier of the route | +| ruleId | Numeric identifier of the rule | -Answer +- Response: -|Setting|Meaning| -|---|---| -|ruleId|The rule’s ID number| -|field|Name of the HTTP parameter to apply the rule on| -|subField|Name of the HTTP header or cookie for the rule| -|match|Name of the comparison to apply to validate the rule| -|negate|"true" if the comparison result is reversed| -|pattern|Comparison argument. The direction and syntax depends on the `match` and the `field`.| +| Parameter | Meaning | +| :--- | :--- | +| ruleId | Numeric identifier of the rule | +| field | Name of the HTTP parameter on which to apply the rule | +| subField | Name of the HTTP header or cookie for the rule | +| match | Name of the comparator to apply to validate the rule | +| negate | "true" if the result of the comparator is inverted | +| pattern | Comparator argument. The meaning and syntax depend on `match` and `field` | -For further information on the rules managed and the format of parameters, please read the [Available rules](#available-rules){.internal} section further down. +For more information on the rules handled and the format of the parameters, we invite you to consult the section " [Available rules](#available-rules) " further down in this guide. -#### Modify a rule. +##### **Modify a rule** -With this call, you can modify a rule attached to an HTTP route if you know its ID. You will need to re-deploy your OVH Load Balancer to apply the changes. +This call allows you to modify a rule attached to an HTTP route, knowing its identifier. Your OVHcloud Load Balancer service must be redeployed to apply the changes. > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId} -> +> -|Setting|Required|Meaning| -|---|---|---| -|serviceName|Required|Your Load Balancer service ID| -|routeId|Required|The route’s ID number| -|ruleId|Required|The rule’s ID number| -|field|Required|The name of the HTTP parameter to apply the rule to| -|subField||HTTP header name for the `header` rules, or cookie name for `cookie` rules| -|match|Required|Name of the comparison to apply to validate the rule| -|negate||Reverses the comparison result| -|pattern||Comparison pattern| +| Parameter | Required | Meaning | +| :--- | :--- | :--- | +| serviceName | Required | Identifier of your Load Balancer service | +| routeId | Required | Numeric identifier of the route | +| ruleId | Required | Numeric identifier of the rule | +| field | Required | Name of the HTTP parameter on which to apply this rule | +| subField | | Name of the HTTP header for `header` rules or name of the cookie for `cookie` rules | +| match | Required | Name of the comparator to apply to validate the rule | +| negate | | Inverts the result of the comparator | +| pattern | | Comparator argument | -For further information on the rules managed and the format of parameters, please read the [Available rules](#available-rules){.internal} section further down. +For more information on the rules handled and the format of the parameters, we invite you to consult the section " [Available rules](#available-rules) " further down in this guide. -#### Delete a rule. +##### **Delete a rule** -With this call, you can delete a rule attached to an HTTP route if you know its ID. You will need to re-deploy your OVH Load Balancer to apply the changes. +This call allows you to delete a rule attached to an HTTP route, knowing its identifier. Your OVHcloud Load Balancer service must be redeployed to apply the changes. > [!api] > > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId} -> +> -|Setting|Required|Meaning| -|---|---|---| -|serviceName|Required|Your Load Balancer service ID| -|routeId|Required|The route’s ID number| -|ruleId|Required|The rule’s ID number| +| Parameter | Required | Meaning | +| :--- | :--- | :--- | +| serviceName | Required | Identifier of your Load Balancer service | +| routeId | Required | Numeric identifier of the route | +| ruleId | Required | Numeric identifier of the rule | > [!primary] > -> If you want to delete a route, you do not need to delete all the rules attached to it. The rules are automatically deleted when you delete the route. -> +> If you want to delete a route, it is not necessary to delete all the rules attached to it. The rules are automatically deleted when you delete a route. +> -#### List all of the TCP and HTTP routes. +##### **List all TCP and HTTP routes** -With this call, you can get a list of all the IDs, display names and types ("http"/"tcp") of routes defined on an OVH Load Balancer service. It is designed to simplify the implementation of auto-completion. +This call allows you to list all the identifiers, display names and types ("http"/"tcp") of routes defined on an OVHcloud Load Balancer service. It was designed to simplify the implementation of auto-completion. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/definedRoutes -> +> -Query +- Request: -|Setting|Meaning| -|---|---| -|serviceName|Your Load Balancer service ID| +| Parameter | Meaning | +| :--- | :--- | +| serviceName | Identifier of your Load Balancer service | -Answer +- Response: -|Setting|Meaning| -|---|---| -|type|Type of protocol for the route: "tcp" for TCP routes, "http" for HTTP routes| -|routeId|The route’s ID number| -|displayName|The display name of the route| +| Parameter | Meaning | +| :--- | :--- | +| type | Type of protocol of the route: "tcp" for TCP routes, "http" for HTTP routes | +| routeId | Numeric identifier of the route | +| displayName | Display name of the route | -### Actions available +#### Available actions -This call returns the list of actions available for TCP and HTTP routes, as well as the values expected for each of the fields. +This call returns the list of available actions for TCP and HTTP routes as well as the expected values for each of the fields. -If a field is “null”, this means that no value is expected. If an invalid value is entered, the API will return a validation error. +If a field is "null", it means that no value is expected. If an invalid value is provided, the API will return a validation error. -All of the actions managed by the OVH Load Balancer service are final. This means that executing an action also triggers the end of route evaluation. +All actions managed by the OVHcloud Load Balancer service are final. This means that the execution of an action also ends the evaluation of the routes. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteActions -> +> -Query +- Request: -|Setting|Meaning| -|---|---| -|serviceName|Your Load Balancer service ID| +| Parameter | Meaning | +| :--- | :--- | +| serviceName | Identifier of your Load Balancer service | -Answer +- Response: -|Setting|Meaning| -|---|---| -|type|Shows if this action is valid for a HTTP or a TCP route| -|name|Name of the action to enter into the `type` field of routes| -|status|List of HTTP status codes available for this action (`status` fields of routes)| -|destination|Value type expected in the `destination` fields for routes| +| Parameter | Meaning | +| :--- | :--- | +| type | Indicates whether this action is valid for an HTTP route or a TCP route | +| name | Name of the action to specify in the `type` field of the routes | +| status | List of available HTTP status codes for this action (the `status` field of the routes) | +| destination | Type of value expected in the `destination` field of the routes | -#### Redirection +##### **Redirection** -This action sends a redirection to the visitor. This redirection type can be configured with the status field. When this action is selected, no farms will receive the request. +This action returns a redirection to the visitor. The type of redirection can be configured with the `status` field. When this action is selected, no farm will receive the request. -|Setting|Value| -|---|---| -|type|`redirect`| -|status|301, 302, 303, 307 or 308| -|target|Target URL (may contain variables)| +| Parameter | Value | +| :--- | :--- | +| type | `redirect` | +| status | 301, 302, 303, 307 or 308 | +| target | Destination URL (can contain variables) | -Only the HTTP redirection status codes can be specified. The most common codes are 301 and 302. If you have any doubts, you can set up a 302 (temporary redirection). The HTTP status codes for redirections are: +Only HTTP redirection status codes can be specified. The most common are codes 301 and 302. If you are unsure, you can use the 302 "Temporary Redirect". The HTTP status codes recognized for redirections are: -|Status code|Description| -|---|---| -|301|Permanent redirection. The redirection can be saved by the browser.| -|302 (default)|Temporary redirection. The redirection must be revalidated for each request by the browser.| -|303|Works like a 302, and forces the use of the HTTP GET method.| -|307|Works like a 302, and forces the same HTTP method to be reused (GET, POST, etc.).| -|308|Works like a 301, and forces the same HTTP method to be reused (GET, POST, etc.).| +| Status code | Description | +| :--- | :--- | +| 301 | Permanent redirect. The redirect can be stored by the browser. | +| 302 (default) | Temporary redirect. The redirect must be revalidated by the browser on each request. | +| 303 | Like 302 and forces the use of the HTTP GET method. | +| 307 | Like 302 and forces the reuse of the same HTTP method (GET, POST, etc.). | +| 308 | Like 301 and forces the reuse of the same HTTP method (GET, POST, etc.). | -The target URL may contain simple variables. This helps users redirect to another domain, another protocol or add a suffix/prefix to a URL. The recognised variables are: +The destination URL can contain simple variables. This allows you to redirect to another domain, another protocol or add a suffix / prefix to a URL. The recognized variables are: -|Variable|Description| -|---|---| -|`protocol`|Protocol of the request ("http" or "https")| -|`domain`|Domain name of the request, without the port number| -|`host`|"Host" field of the request, including the port number, if there is one| -|`port`|Port of the request| -|`path`|Path of the request, starts with a '/' and ends before the first '?'| -|`arguments`|Arguments of the request, starts with a '?' if present| +| Variable | Description | +| :--- | :--- | +| `protocol` | Protocol of the request ("http" or "https") | +| `domain` | Domain name of the request, without the port number | +| `host` | "Host" field of the request, including the port number if present | +| `port` | Port of the request | +| `path` | Path of the request, starts with a '/' and ends at the first '?' | +| `arguments` | Arguments of the request, starts with a '?' if present | -For example, for: +For example, to: -- redirect to https: `https://${host}${path}${arguments}` -- redirect to a new domain: ${protocol}://new.example.com${path}${arguments} -- prefix the URL: ${protocol}://${host}/staging${path}${arguments} +- redirect to https: `https://\${host}\${path}\${arguments}` +- redirect to a new domain: `${protocol}://new.example.com\${path}\${arguments}` +- prefix the URL: `${protocol}://\${host}/staging\${path}\${arguments}` -#### Reject. +##### **Rejection** -This action returns an HTTP error status code to the visitor. The HTTP error code can be configured with the status field. When this action is selected, no farms will receive the request. +This action returns an HTTP error status code to the visitor. The error HTTP status code can be configured with the `status` field. When this action is selected, no farm will receive the request. -|Setting|Value| -|---|---| -|type|`reject`| -|status|200, 400, 403, 405, 408, 429, 500, 502, 503 or 504| -|target|not available| +| Parameter | Value | +| :--- | :--- | +| type | `reject` | +| status | 200, 400, 403, 405, 408, 429, 500, 502, 503 or 504 | +| target | not available | > [!primary] > -> This action is also available in TCP. In this case, the parameter status is not available, and the request is terminated. TCP requests that are terminated like this are not compatible with high percentages of requests. -> +> This action is also available in TCP. In this case, the `status` parameter is not available and the request is terminated. TCP requests terminated in this way are not counted in the request rate. +> -Only the HTTP error codes listed in the API can be specified. The most common ones are 400 ("Bad request") errors, and 403 ("Forbidden") errors. A 200 code can be used to block a request type while simulating a success, and a 503 code can be used to simulate a server outage. +Only the HTTP error status codes listed in the API can be specified. The most common are the codes 400 "Bad request" and 403 "Forbidden". 200 can be used to block a type of request while simulating a success, and 503 can be used to simulate a server failure. -|Status code|Description| -|---|---| -|200|The request has been successfully executed.| -|400|Invalid request.| -|403 (default)|Access forbidden.| -|405|Method (GET, POST, PUT, ...) invalid or not managed.| -|408|The request has taken too long to be sent by the client.| -|429|The client has sent too many requests (rate limiting).| -|500|Generic server error.| -|502|Error communicating with the server.| -|503|The service is temporarily unavailable.| -|504|The server has taken too much time to respond.| +| Status code | Description | +| :--- | :--- | +| 200 | The request was executed successfully. | +| 400 | Invalid request. | +| 403 (default) | Access forbidden. | +| 405 | Invalid or unhandled method (GET, POST, PUT, etc.) +| 408 | The client failed to send a complete request within the server's time limit. | +| 429 | The client sent too many requests (rate-limiting). | +| 500 | Generic server error. | +| 502 | Communication error with the server. | +| 503 | The service is temporarily unavailable. | +| 504 | The server took too long to respond. | -#### Routing. +##### **Routing** -This action redirects requests to a specific farm, other than the default farm configured on the front-end. The destination farm must be the same type as the front-end ("http" or "tcp"). +This action directs requests to a specific farm, other than the default farm configured on the frontend. The target farm must be of the same type as the frontend ("http" or "tcp"). -|Setting|Value| -|---|---| -|type|`farm`| -|status|not available| -|target|The destination farm’s ID number. This must be the same type.| +| Parameter | Value | +| :--- | :--- | +| type | `farm` | +| status | not available | +| target | Numeric identifier of the target farm. This must be of the same type | > [!primary] > -> This action is also available in TCP. In this case, the destination farm type must be "tcp". -> +> This action is also available in TCP. In this case, the target farm must be of type "tcp". +> -### Available rules. +#### Available rules -This call returns the list of rules available for TCP and HTTP routes, as well as the values expected for each of the fields. +This call returns the list of available rules for TCP and HTTP routes, as well as the expected values for each field. -If a field is “null”, this means that no value is expected. If an invalid value is entered, the API will return a validation error. +If a field is "null", it means no value is expected. If an invalid value is provided, the API will return a validation error. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteRules -> +> -Query +- Request: -|Setting|Meaning| -|---|---| -|serviceName|Your Load Balancer service ID| +| Parameter | Meaning | +| :--- | :--- | +| serviceName | Identifier of your Load Balancer service | -Answer +- Response: -|Setting|Meaning| -|---|---| -|type|Type of protocol for the route: "tcp" for TCP routes, "http" for HTTP routes| -|name|Name of the property on which to apply this rule, to be entered into the `field` field| -|hasSubField|"true" is this property is a sub-property (e.g. a header or cookie)| -|matches|List of comparisons available for each rule, to be entered into the `match` field| -|pattern|Type of value expected for the `pattern` field| -|enum|List of values for the chmaps `pattern`, if it is a list| +| Parameter | Meaning | +| :--- | :--- | +| type | Protocol type of the route: "tcp" for TCP routes, "http" for HTTP routes | +| name | Name of the property to which this rule applies, to be filled in the `field` field | +| hasSubField | "true" if this property has a "sub-property" (e.g.: a header or a cookie) | +| matches | List of available comparators for this rule, to be filled in the `match` field | +| pattern | Type of expected value for the `pattern` field | +| enum | List of possible values for the `pattern` field if it is an enumeration | -The different `pattern` types are: +The different types of `pattern` are: -|Value|Meaning| -|---|---| -|cidr|IP address (a.b.c.d) or sub-network (a.b.c.d/z)| -|string|Free text. For the `in` operator, a list of values separated by columns (255 characters maximum)| -|enum|The field is a list defined in `enum`| +| Value | Meaning | +| :--- | :--- | +| cidr | IP address (a.b.c.d) or subnet (a.b.c.d/z) | +| string | Free text. For the operator `in`, a list of comma-separated values (maximum 255 characters) | +| enum | The field is an enumeration defined in `enum` | -#### Protocol. +##### **Protocol** -With this rule, you can filter requests depending on their protocol. In practice, the uses for this rule are quite limited, as the protocol depends on the front-end that the route is attached to, or a front-end that only manages a single protocol recognised the moment the route is defined. +This rule allows filtering requests based on their protocol. In practice, the use cases for this rule are quite limited because the protocol depends on the frontend to which the route is attached, and a frontend only handles one protocol, which is known at the time the route is defined. -|Fields|Value| -|---|---| -|name|`protocol`| -|hasSubField|no| -|matches|`is` or `in`| -|pattern|`tcp`, `tls`, `http` or `https`| +| Field | Value | +| :--- | :--- | +| name | `protocol` | +| hasSubField | no | +| matches | `is` or `in` | +| pattern | `tcp`, `tls`, `http` or `https` | > [!primary] > -> This action is also available in TCP. In this case, "http/2.0" protocol is also available. It is based on the "ALPN" SSL/TLS field used by browsers to announce that they are attempting to establish a HTTP/2.0 connection. This way, you can have a common TCP front-end for SSL/TLS termination of HTTP 1 and 2, then direct traffic depending on the protocol version. -> +> This action is also available in TCP. In this case, the "http/2.0" protocol is also available. It is based on the SSL/TLS "ALPN" field used by browsers to announce that they are trying to establish an HTTP/2.0 connection. This allows for a common TCP frontend for HTTP 1 and 2 SSL/TLS termination, then routing these streams based on the protocol version. +> -#### Source address. +##### **Source address** -With this rule, you can filter requests depending on their source address. By combining it with a rule based on the URI or the domain name, you can restrict certain resources to an enterprise proxy while exposing all of your other resources without restrictions, via your OVH Load Balancer. +This rule allows filtering requests based on their source address. By combining it with a rule based on the URI or domain name, it is for example possible to restrict certain resources to an enterprise proxy, while exposing all other resources without restrictions on your OVHcloud Load Balancer service. -|Fields|Value| -|---|---| -|name|`source`| -|hasSubField|no| -|matches|`is` or `in`| -|pattern|Sub-network (a.b.c.d/z) or address (a.b.c.d)| +| Field | Value | +| :--- | :--- | +| name | `source` | +| hasSubField | no | +| matches | `is` or `in` | +| pattern | Subnet (a.b.c.d/z) or address (a.b.c.d) | > [!primary] > -> This action is also available in TCP using the same method. -> +> This action is also available in TCP with the same behavior. +> -To block a particular network and address, for example, you can use a pattern like "4.4.0.0/16, 8.8.8.8". +For example, to block a network and a specific address, you can use a pattern such as "4.4.0.0/16, 8.8.8.8". -#### Domain name. +##### **Domain name** -With this rule, you can filter requests depending on their domain name. In doing so, you can reproduce the Apache "vhost" feature, or route all of the domains that start with "mail." to a server dedicated to webmail. +This rule allows filtering requests based on their domain name. This can for example be used to reproduce the "vhost" function of Apache or to route all domains starting with "mail." to a server dedicated to webmail. -|Fields|Value| -|---|---| -|name|`host`| -|hasSubField|no| -|matches|`is`, `in`, `contains`, `startswith`, `endswith` or `matches`| -|pattern|Character chain or regular expression| +| Field | Value | +| :--- | :--- | +| name | `host` | +| hasSubField | no | +| matches | `is`, `in`, `contains`, `startswith`, `endswith` or `matches` | +| pattern | String or regular expression | > [!primary] > -> This action is also available in TCP. It will only work if the front-end is configured to accept SSL/TLS connections, and if the client sends an "SNI" option. This is especially the case with recent web browsers. -> +> This action is also available in TCP. It is only applicable if the frontend is configured to accept SSL/TLS connections and the client sends an "SNI" option. This is particularly the case for recent web browsers. +> -#### HTTP method. +##### **HTTP method** -With this rule, you can filter requests depending on their HTTP method. It is commonly used alongside a rule based the request URI or path, to make the rule more selective. +This rule allows filtering requests based on the HTTP method. It is commonly used in conjunction with a rule based on the request URI or path to make the rule more selective. -|Fields|Value| -|---|---| -|name|`method`| -|hasSubField|no| -|matches|`is` or `in`| -|pattern|`GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS` or `TRACE`| +| Field | Value | +| :--- | :--- | +| name | `method` | +| hasSubField | no | +| matches | `is` or `in` | +| pattern | `GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS` or `TRACE` | -#### Request path. +##### **Request path** -With this rule, you can filter requests depending on their path, or URI. The request path is between the first '/' (inclusive) and the first '?' (excluded). +This rule allows filtering requests based on the request path or URI. The request path is the part between the first '/' included and the first '?' excluded. -|Fields|Value| -|---|---| -|name|`uri`| -|hasSubField|no| -|matches|`is`, `in`, `contains`, `startswith`, `endswith` or `matches`| -|pattern|Character chain or regular expression| +| Field | Value | +| :--- | :--- | +| name | `uri` | +| hasSubField | no | +| matches | `is`, `in`, `contains`, `startswith`, `endswith` or `matches` | +| pattern | String or regular expression | -#### Request parameter. +##### **Request parameter** -This rule filters requests depending on their existence, or the value of a specific HTTP request parameter. This is the part after the first '?'. If a parameter is specified several times in a request, only the first instance is taken into account. +This rule allows filtering requests based on the existence or value of a specific HTTP request parameter. This is the part after the first '?'. If a parameter is specified multiple times in the request, only the first one is taken into account. -|Fields|Value| -|---|---| -|name|`param`| -|hasSubField|yes| -|matches|`is`, `in`, `contains`, `startswith`, `endswith` or `matches`| -|pattern|Character chain or regular expression| +| Field | Value | +| :--- | :--- | +| name | `param` | +| hasSubField | yes | +| matches | `is`, `in`, `contains`, `startswith`, `endswith` or `matches` | +| pattern | String or regular expression | -#### HTTP header. +##### **HTTP header** -This rule filters requests depending on their existence, or the value of a specific HTTP header value. You can use it to detect the opening of a WebSocket connection, and direct it to a dedicated server farm. +This rule allows filtering requests based on the existence or value of a specific HTTP header. This can for example be used to detect the opening of a websocket connection and route it to a dedicated farm. -|Fields|Value| -|---|---| -|name|`header`| -|hasSubField|yes| -|matches|`is`, `in`, `contains`, `startswith`, `endswith` or `matches`| -|pattern|Character chain or regular expression| +| Field | Value | +| :--- | :--- | +| name | `header` | +| hasSubField | yes | +| matches | `is`, `in`, `contains`, `startswith`, `endswith` or `matches` | +| pattern | String or regular expression | -#### Cookie. +##### **Cookie** -With this rule, you can filter requests depending on the existence or value of a specific HTTP cookie. You can use it to direct voluntary visitors to a pre-production farm. +This rule allows filtering requests based on the existence or value of a specific HTTP cookie. This can for example be used to direct opt-in visitors to a pre-production farm. -|Fields|Value| -|---|---| -|name|`cookie`| -|hasSubField|yes| -|matches|`is`, `in`, `contains`, `startswith`, `endswith` or `matches`| -|pattern|Character chain or regular expression| +| Field | Value | +| :--- | :--- | +| name | `cookie` | +| hasSubField | yes | +| matches | `is`, `in`, `contains`, `startswith`, `endswith` or `matches` | +| pattern | String or regular expression | ## Go further -Join our community of users on . +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_route/guide.en-us.md b/pages/network/load_balancer/create_route/guide.en-us.md index 206a3ae26d9..efe77c2df9f 100644 --- a/pages/network/load_balancer/create_route/guide.en-us.md +++ b/pages/network/load_balancer/create_route/guide.en-us.md @@ -1,875 +1,880 @@ --- -title: 'Working with HTTP routes' -excerpt: 'Find out how to direct your requests dynamically, to a specific farm' -updated: 2018-04-09 +title: "Configuring an OVHcloud Load Balancer with HTTP routes" +excerpt: "Find out how to dynamically direct your requests to a specific farm" +updated: 2025-11-27 --- ## Objective -The OVH Load Balancer service redirects the front-end’s incoming traffic to the servers that make up the front-end’s default farm, or its default redirection. +The OVHcloud Load Balancer service redirects the front-end’s incoming traffic to the servers that make up the front-end’s default farm, or its default redirection. -In some cases, you can go a step further and route, redirect or block traffic according to a range of criteria. For example, in the case of a HTTP(S) service, you can filter traffic depending on the HTTP method, the URL, and even a cookie or header value! In the OVH Load Balancer service, these are called `routes`{.action}. A route is a particular action to carry out if one or more conditions are met. +In some cases, you can go further and route, redirect, or block traffic according to a range of criteria. For example, in the case of an HTTP(S) service, you can filter traffic based on the HTTP method, the URL, or even the value of a cookie or header. -**This guide will show you how to direct your requests dynamically, to a specific farm.** +In the OVHcloud Load Balancer service, these elements are called **routes**. A route is a specific action to perform if one or more conditions are met. + +**This guide will show you how to direct your requests dynamically to a specific farm using routes.** ## Requirements -- an [OVH Load Balancer](https://www.ovh.com/world/solutions/load-balancer/) on a solution that lets you create routes -- access to the [OVH API](/links/api) +- Have an [OVHcloud Load Balancer](/links/network/load-balancer) on an offer allowing the creation of routes. +- Have access to the [OVHcloud API](/links/api). ## Instructions > [!primary] > -> Although this guide focuses on HTTP routes, the same principle applies to TCP (with TCP routes). This can be used to direct HTTP/2 traffic to a particular farm, or reject incoming requests from certain IPs. -> +> Although this guide focuses on **HTTP routes**, the same principle applies to **TCP routes**. This can be useful for directing HTTP/2 traffic to a specific farm or rejecting incoming requests from certain IP addresses. +> -Since this feature is still very new, it is only available in the API. This guide will explain the general principles behind routing, and provide practical examples of routes being used. +This feature is only available via the API. This guide will present the general principles as well as use cases for routes drawn from real-life scenarios. -- **An introduction to routes**. +### Introduction to routes -A route controls traffic according to different criteria. You can express these criteria as rules, conditions, or actions. +A route is used to control traffic according to different criteria. They can be expressed in the form of **rules**, **conditions**, or **actions**. -For example, *IF* the URL _starts_ with '/wp-admin/' (1) *AND* the connection _is_ in HTTP (2) *THEN* _redirect_ to the HTTPS version of the page (3). +For example, *IF* the URL _starts with_ '/wp-admin/' (1) *AND* the connection _is_ HTTP (2) *THEN* _redirect_ to the HTTPS version of the page (3). -In this example, there are two rules: +In this example, there are two rules : -- the connection must come from a HTTP front-end (2) -- its URL must begin with the WordPress admin pages (1) +- the connection must come from an HTTP frontend (2); +- its URL must start with the WordPress administration pages (1). There is an action associated with these rules: redirect to the HTTPS version of the page (3). -This is what is known as an ‘end action’. It means that if the rules are confirmed, the evaluation of routes stops, and the action is executed. +This is what is known as an "end action". That means if the rules are validated, the evaluation of the routes stops and the action is executed. -## An introduction to the API. +### API presentation -You can only manage routes via the [OVH API](/links/api). It is only valid for `http`{.action} and `tcp`{.action} protocols, and the `/ipLoadbalancing/{serviceName}/{protocol}/route/`{.action} pathway exposes the API dedicated to routes. +Route management is only available through the [OVHcloud API](/links/api). It is only valid for the **http** and **tcp** protocols, and the path `/ipLoadbalancing/{serviceName}/{protocol}/route/`{.action} exposes the dedicated route API. -The API for routes to the OVH Load Balancer is specially designed for flexibility, power and scalability. It is organised around three main sections: +The OVHcloud Load Balancer service route API has been specifically designed to be flexible, powerful, and scalable. It is organized around three main sections: -1. the APIs listing available rules and actions -2. the APIs listing the routes configured on the OVH Load Balancer service -3. the APIs for configuring routes on the OVH Load Balancer service +1. API calls listing the available rules and actions. +2. API calls listing the routes configured on your OVHcloud Load Balancer service. +3. API calls for configuring the routes of your OVHcloud Load Balancer service. > [!primary] > -> To only show the APIs linked to routes in the OVH API console, you can use the `filter`{.action} field with ‘route’ as a keyword. -> +> To display only the API calls related to routes in the OVHcloud API console, you can use the `filter`{.action} field with the keyword "[a-z]*". +> -When you want to configure a route or rules, the first thing you need to do is look at the available actions and rules. This will give you the possible values for the API route and rule configuration fields. +When you want to configure a route or rules, the first thing to do is to consult the **available actions and rules**. This will give you the possible values for the configuration fields of the route and rule APIs. - A route can have several rules. -- A route can only be attached to a single front-end. -- A front-end can have several routes. In this case, the order of evaluation depends on its type and weight. +- A route can only be attached to a single frontend. +- A frontend can have several routes. In this case, the evaluation order depends on its type and weight. -When a request arrives at your OVH Load Balancer service, the routes are evaluated successively following the principles below: +When a request arrives on your OVHcloud Load Balancer service, the routes are evaluated successively according to the following principles: -1. firstly, reject and rewrite routes, then the farm routes -1. within categories, the routes are evaluated in order of ascending weight -1. if two routes are the same weight, the first route created is evaluated first -1. only the first action from all the validated rules is executed +1. first, the **reject and rewrite routes**, then the **farm routes**; +2. within these categories, the routes are evaluated in **increasing weight order**; +3. if two routes have the same weight, the **first route created** is evaluated first; +4. only the **first action** of all validated rules is executed. -### Available rules and actions. +### Available rules and actions -This first section of the API contains an updated list of actions and rules available for the OVH Load Balancer service. It contains a call for actions, and another for rules. These two calls return a list of objects. Each object has a name, and if it applies to all TCP or HTTP routes as well as the values or value types expected for different fields of the API. If a field is “null”, this means that no value is expected. If an invalid value is entered, the API will return a validation error. +This first section of the API contains an up-to-date list of available actions and rules for your OVHcloud Load Balancer service. It contains one call for the actions and another for the rules. These two calls return a list of objects. Each object is named, and indicates whether it applies to TCP or HTTP routes, as well as the expected values or types of values for the different fields of the API. If a field is "null", it means no value is expected. If an invalid value is provided, the API will return a validation error. #### Actions > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteActions -> +> -For more information on this call, please read the [Available actions](#available-actions){.internal} section at the bottom of this guide. +For more information on this call, we invite you to consult the section [Available Actions](#available-actions), at the bottom of this guide. -#### Rules: +#### Rules > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteRules -> +> -For more information on this call, please read the [Available rules](#available-rules){.internal} section at the bottom of this guide. +For more information on this call, we invite you to consult the section [Available Rules](#available-rules), at the bottom of this guide. -### Configured routes. +### Configured routes -This section of the API only contains one call. It was mainly designed to help implement auto-complete systems. It returns the ID, name and type of each defined route. You can get a route’s details with a GET /ipLoadbalancing/{serviceName}/route/{type}/{routeId} call, defined further below. +This second section of the API contains only one call. It was mainly designed to facilitate the implementation of auto-completion mechanisms. It returns the identifier, name, and type of each defined route. The details of a route can be obtained with a `GET /ipLoadbalancing/{serviceName}/route/{type}/{routeId}` call defined below. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/definedRoutes -> +> -For more information on this call, please read the [Edit routes](#edit-routes){.internal} section at the bottom of this guide. +For more information on this call, we invite you to consult the section " [Route Handling](#handling-routes) ", at the bottom of this guide. -### Route configuration. +### Route configuration -With these basic principles around the action and rules available, and the order in which routes are evaluated, these routes can be edited the same way as the farms can. When you create a route, you can attach rules to it. The possible values for rules and actions are defined by the API calls. +With these basic principles on available actions and rules, and the route evaluation order, these routes can be manipulated in the same way as farms. When you create a route, you can attach rules to it. The possible values for the rules and actions are defined by the API calls. -For more information on these calls, please read the [Edit routes](#edit-routes){.internal} section at the bottom of this guide. +For more information on these methods, you can consult the section " [Route Handling](#handling-routes) ", at the bottom of this guide. ## Examples -If you still have doubts about the power of routes, this should change your mind. The purpose of this section is to offer some practical examples of how this technology has been used for OVH’s internal requirements, without going into great detail about API calls. +To demonstrate the utility of routes, this section will offer some practical examples of the use of this technology for OVHcloud's internal needs, without going into the details of the API calls. -You can read about API calls in more detail in the [Edit routes](#edit-routes){.internal} section at the bottom of this guide, and the sections that follow it. +You will find the details of the API calls in the section [Route Handling](#handling-routes), at the bottom of this guide and the following sections. -### Force HTTPS for WordPress login pages. +### Force HTTPS for WordPress login pages -HTTPS protocol has become the norm. Its purpose is to make all websites available securely in HTTPS, with the SSL/TLS protocol. If you need an SSL/TLS certificate, you can use the OVH Load Balancer service to order a new one, which will be automatically managed for you. +The HTTPS protocol has become the norm. Its objective is to make all websites available in HTTPS in a secure manner, thanks to the SSL/TLS protocol. If you need an SSL/TLS certificate, you can use your OVHcloud Load Balancer service to order a new one, which will be managed for you in a completely automatic way. -Migrating a website to HTTPS involves a lot of work, especially to avoid [mixed content](https://developer.mozilla.org/en-us/docs/Web/Security/Mixed_content). It may be worth migrating your website section by section, and starting by securing pages that send login credentials. +Migrating a website to HTTPS requires work, especially to avoid [Mixed-Content](https://developer.mozilla.org/en-us/docs/Web/Security/Mixed_content) problems. It may be interesting to migrate your website section by section, starting by securing the pages that send login credentials. -One approach could be to base it on the beginning of WordPress URLs. By default, the URL the login pages for WordPress start with "/wp-login". So we would need: +An approach could be to rely on the beginning of WordPress URLs. By default, the URLs of WordPress login pages start with "/wp-login". We would therefore need to: -- a route with a redirect action -- a rule in this route that detects URLs starting with "/wp-login" +- a route with a **redirection action**; +- a rule in this route that detects URLs starting with **"/wp-login"**. -In practice, this gives a route like this: +In practice, this gives a route as follows: -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|frontendId|Your HTTP front-end ID| -|displayName|“Redirection of WordPress logins to HTTPS”| -|weight|(empty)| -|action.type|"redirect"| -|action.status|302 for a temporary redirection, 301 for a permanent redirection| -|action.target|"`https://${host}${path}${arguments}`" to take the same host, path and arguments| +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| frontendId | Identifier of your HTTP frontend | +| displayName | "Redirect WordPress connections to HTTPS" | +| weight | (empty) | +| action.type | "redirect" | +| action.status | 302 for a temporary redirect, 301 for a permanent redirect | +| action.target | "`https://\${host}\${path}\${arguments}`" to take the same host, path and arguments | On this route, we will attach a rule: -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|routeId|Route ID created above| -|field|"uri"| -|subField|(empty)| -|match|"startswith"| -|negate|false| -|pattern|"/wp-login"| +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| routeId | Identifier of the route created above | +| field | "uri" | +| subField | (empty) | +| match | "startswith" | +| negate | false | +| pattern | "/wp-login" | -Next, apply the configuration to the zone concerned, and the rule will begin to work. +Then apply the configuration to the concerned area. > [!warning] > -> To add a new redirection, you will need to repeat these actions again, creating a route, then a rule. If a second rule is added to the same route, the two rules need to be validated for the redirect to work. Note that if the rules are "startswith /wp-login" and "startswith /wp-admin", the redirection would never work because these two conditions cannot both be true at once. -> +> To add a new redirection, you will have to repeat these actions, creating a route, then a rule. If a second rule is added to the same route, both rules must be validated for the redirection to work. Note that if the rules are `startswith /wp-login` and `startswith /wp-admin`, the redirection will never work because these two conditions cannot be true at the same time. +> -### Route according to a domain (vhost) +### Route based on a domain (VHost) -This feature helped propel the expansion of the web at its very early stages, by exposing several websites behind a single IP address using the “host” field of HTTP headers. +This is the feature that made the web possible when it was in its infancy, with the possibility of exposing several sites behind the same IP address thanks to the "Host" field of HTTP headers. -For example, if your infrastructure is made up of a VPS for your website, an OVH Load Balancer to ensure SSL/TLS termination, and redirection to a maintenance page with a backup server in the farms, you would originally have needed one Additional IP per website, routed to your OVH Load Balancer, and one front-end per IP. +For example, if your infrastructure is composed of a VPS for your website, an OVHcloud Load Balancer for SSL/TLS termination, and redirections to a maintenance page with a backup server in the farms, you would have needed an Additional IP per website, routed to your OVHcloud Load Balancer, and a frontend per IP in the past. -With routes, you can share the same front-end, and choose the server farm dynamically, with the “host” field. +With routes, you can share the same frontend and choose the server farm dynamically, thanks to the *[a-z]* field. -To do this, you will need: +For this, you will need: -- one route per vhost -- one rule per route detecting a specific domain +- a route per VHost; +- a rule per route detecting a specific domain. -In practice, to route the domain www.example.com, this would give the following route: +In practice, to route the domain **www.example.com**, this will give the following route: -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|frontendId|Your front-end ID| -|displayName|"VHost - www.example.com"| -|weight|(empty)| -|action.type|"farm"| -|action.status|(empty)| -|action.target|ID of the farm to direct this domain to| +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| frontendId | Identifier of your frontend | +| displayName | "VHost - www.example.com" | +| weight | (empty) | +| action.type | "farm" | +| action.status | (empty) | +| action.target | Identifier of the farm to which to direct this domain | And on this route, we will attach a rule: -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|routeId|Route ID created above| -|field|"host"| -|subField|(empty)| -|match|"is"| -|negate|false| -|pattern|"www.example.com" or a domain of your choice| +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| routeId | Identifier of the route created above | +| field | "host" | +| subField | (empty) | +| match | "is" | +| negate | false | +| pattern | "www.example.com" or a domain of your choice | Finally, apply the configuration. -### Reserve an Additional IP to a particular website. +### Reserve an Additional IP for a specific website -If you are hosting a website on a VPS, you may want to dedicate an IP address to a specific customer. You can easily make the IP available by routing it to your OVH Load Balancer service, then configuring a dedicated front-end attached to this Additional IP address, and having the customer’s target VPS set as a defaultFarmId. +If you host a website on a VPS, you might want to dedicate an IP address to a specific client. You can easily make the IP available by routing it to your OVHcloud Load Balancer service, then configuring a dedicated frontend attached to this Additional IP, and setting the client's target VPS as the `defaultFarmId`. -But what will happen if another customer detects this, and configures their domain to point to the premium customer’s IP address? By default, this will work, and its website will be routed to the other VPS. If there is an SSL/TLS certificate, it will still work as all of the certificates are automatically available for all of the front-ends. +However, what will happen if another client detects this and configures their domain to point to the premium client's IP? By default, this will work, and their website will be routed to another client's VPS. If an SSL/TLS certificate is present, this will still work, as all certificates are automatically available for all frontends. -In such scenarios, the solution is to add a rule that will reject requests if the domain is not a premium one. You can do this with a rejection route and a rule. +In such scenarios, the solution is to add a rule that **rejects requests if the domain is not a premium domain**. You can do this with a reject route and a rule. -In practice, to reserve a front-end with an IP dedicated to the domain www.example.com, this will give the following route: +In practice, to reserve a frontend with a dedicated IP for the domain **www.example.com**, this will give the following route: -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|frontendId|Your front-end ID| -|displayName|"Restrict to www.example.com"| -|weight|(empty)| -|action.type|"reject"| -|action.status|403| -|action.target|(empty)| +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| frontendId | Identifier of your frontend | +| displayName | "Restriction to www.example.com" | +| weight | (empty) | +| action.type | "reject" | +| action.status | 403 | +| action.target | (empty) | And on this route, we will attach a rule: -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|routeId|Route ID created above| -|field|"host"| -|subField|(empty)| -|match|"is"| -|negate|true| -|pattern|"www.example.com" or a domain of your choice| +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| routeId | Identifier of the route created above | +| field | "host" | +| subField | (empty) | +| match | "is" | +| negate | true | +| pattern | "www.example.com" or a domain of your choice | Finally, apply the configuration. -### Route depending on a URL and HTTP method. +### Route based on a URL and an HTTP method -On some specific infrastructures, certain requests need to be routed to a specific farm. For example, to manage rare but data-intensive requests without impacting production, such as analytical requests that would work from a read-only duplicate of the data with a server that has a higher volume of memory. +On some specific infrastructures, certain requests must be routed to a specific farm. For example, to handle rare but data-intensive requests without impacting production, such as analytical requests that work on a read-only copy of the data with a server having a higher memory volume. If, for example, the request is sent: -- with the POST method -- on a URL corresponding to "^/.\*/batch-analytics$" +- with the **POST** method; +- on a URL matching **"^/.*/batch-analytics$"**. -... you would need a route with two rules, with one rule using a regular expression. +Then, you would need a route with two rules, one of which uses a regular expression. -In practice, this gives a route like this: +In practice, this gives a route as follows: -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|frontendId|Your front-end ID| -|displayName|"Route batch analytics to dedicated farm"| -|weight|(empty)| -|action.type|"farm"| -|action.status|(empty)| -|action.target|ID of the farm to direct these operations to| +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| frontendId | Identifier of your frontend | +| displayName | "Route batch analytics to a dedicated farm" | +| weight | (empty) | +| action.type | "farm" | +| action.status | (empty) | +| action.target | Identifier of the farm to which to direct these operations | And on this route, we will attach two rules: -|Field|Rule 1|Rule 2| -|---|---|---| -|serviceName|Your OVH Load Balancer service ID|as per rule 1| -|routeId|Route ID created above|as per rule 1| -|field|"method"|"uri"| -|subField|(empty)|(empty)| -|match|"is"|"matches"| -|negate|false|false| -|pattern|"POST"|"^/.\*/batch-analytics$"| +| Field | Rule 1 | Rule 2 | +| :--- | :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | as for rule 1 | +| routeId | Identifier of the route created above | as for rule 1 | +| field | "method" | "uri" | +| subField | (empty) | (empty) | +| match | "is" | "matches" | +| negate | false | false | +| pattern | "POST" | "`^/.*/batch-analytics$`" | + +Here, the first rule applies to an enumeration. Only standard HTTP methods are available. The second rule, on the other hand, exploits the full power of routes by using a regular expression. Although it is possible to use such expressions, avoiding them results in enhanced performance. -Here, the first rule applies on a list. Only standard HTTP methods are available. However, the second rule uses all the power of routes using a regular expression. Although it is possible to use expressions like this, if you can go without using them, your performance will be even higher. +All that remains is to apply the configuration in the concerned area. -Next, apply the configuration to the zone concerned. +#### Route certain IPs and voluntary clients to preproduction -### Route certain IPs and voluntary clients to a pre-production environment. +When a site grows, you may want to set up a preproduction environment to validate ongoing changes, without affecting the majority of users. Generally, when configuring this type of environment, you want to reduce the gap as much as possible between production and preproduction, in order to detect problems as accurately as possible. A classic and often neglected source of problems is the domain name. It is sometimes hardcoded in a file or an article. At that point, a link may work in preproduction but not in production. -When your website gains momentum, you may want to set up a pre-production environment, which you can use to check ongoing developments without affecting the majority of your users. Generally, when you configure an environment like this, it is best to minimise the differences between production and pre-production as much as possible, so that any issues can be detected as accurately as possible. A common but often-forgotten issue is the domain name, as it is sometimes hard-coded into a file or item. If this is the case, the link may work in pre-production, but not in production. +Instead of setting up rules based on the domain name, you could set up rules based on the source IP address (for example, an enterprise proxy) and possibly a cookie for voluntary clients. These configurations can be detected with two routes on your OVHcloud Load Balancer service. -Instead of setting up rules based on the domain name, you can set up rules based on the source IP (e.g. an enterprise proxy), and possibly a cookie for voluntary clients. These configurations can be detected with two routes on the OVH Load Balancer service. +For this example, we will consider: -For this example, we will consider that: +- that the enterprise proxy can use the addresses 42.42.42.0/24 and the VPN uses 1.2.3.4/32; +- that the voluntary users have a "PreprodOptIn" cookie, the value of which is not important. -- the enterprise proxy can use the addresses 42.42.42.0/24, and that the VPN uses 1.2.3.4/32 -- the voluntary users have a "PreprodOptIn" cookie — it doesn’t matter what the value is +In practice, you will need two identical routes: -In practice, we would need two identical routes: +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| frontendId | Identifier of your frontend | +| displayName | "Route Opt-In and internal users to preproduction environment" | +| weight | (empty) | +| action.type | "farm" | +| action.status | (empty) | +| action.target | Identifier of the preproduction farm | -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|frontendId|Your front-end ID| -|displayName|"Route Opt-In and internal users to pre-production environment"| -|weight|(empty)| -|action.type|"farm"| -|action.status|(empty)| -|action.target|Your pre-production farm’s ID| +Next, we attach the following 2 rules, each on one of the routes (1 rule per route): -Then we will attach the following two rules to each of the routes (one rule per route): +| Field | Rule 1 | Rule 2 | +| :--- | :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | same | +| routeId | Identifier of the first route | Identifier of the second route | +| field | "source" | "cookie" | +| subField | (empty) | "PreprodOptIn" | +| match | "in" | "exists" | +| negate | false | false | +| pattern | "42.42.42.0/24, 1.2.3.4" | (empty) | -|Field|Rule 1|Rule 2| -|---|---|---| -|serviceName|Your OVH Load Balancer service ID|as per rule 1| -|routeId|ID of the first route|ID of the second route| -|field|"source"|"cookie"| -|subField|(empty)|"PreprodOptIn"| -|match|"in"|"exists"| -|negate|false|false| -|pattern|"42.42.42.0/24, 1.2.3.4"|(empty)| +The first rule checks if the source IP is in a list of address ranges. In this case, the different address ranges are separated by commas and can be surrounded by spaces for better readability. If a range contains only one address, the "/32" is implicit but can be added explicitly. In any case, the size of this field is limited to 255 characters. -The first rule tests whether the source IP is in the address range list. In this case, the various address ranges are separated by commas, and can have spaces in between one another to make them easier to read. If the range only contains one address, the "/32" is implicit, but can be added explicitly. Either way, this field is limited to 255 characters. +The second rule simply checks the existence of the cookie. It would be possible to check if its value matches a regular expression or is in a list of possibilities, but this allows to show a simple example of what can be done with cookies. Rules based on HTTP Headers work according to a similar approach. -The second rule simply tests to see if a cookie exists. It is also possible to test if the value corresponds to a regular expression, or is found in a possibility list, but this offers a simple example of what you can do with cookies. Rules based on HTTP headers work using a similar approach. +All that remains is to apply the configuration in the concerned area. -Next, apply the configuration to the zone concerned. +#### Route WebSockets to a dedicated farm -### Route WebSockets to a dedicated farm. +When a site has interactive functions based on WebSockets such as a chatbot, you may want to direct these connections to a server farm dedicated to this task. In fact, it is quite simple.W -When a website has interactive features based on WebSockets — a chatbot, for example — you may want to direct these connections to a server farm dedicated to this task. This is actually quite simple. When a browser attempts to open a WebSockets connection, it sends a standard HTTP request with these headers: +When a browser tries to open a WebSocket connection, it sends a standard HTTP request with the headers: ``` Upgrade: websocket Connection: Upgrade ``` -In this case, only the first header needs to be detected. This can be done very easily with a route and a rule: +In practice, it is sufficient to detect the first header. This can be done very easily with a route and a rule: -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|frontendId|Your front-end ID| -|displayName|"Route WebSockets to a dedicated farm"| -|weight|(empty)| -|action.type|"farm"| -|action.status|(empty)| -|action.target|ID of the farm dedicated to WebSockets| +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| frontendId | Identifier of your frontend | +| displayName | "Route WebSockets to a dedicated farm" | +| weight | (empty) | +| action.type | "farm" | +| action.status | (empty) | +| action.target | Identifier of the WebSocket dedicated farm | -And on this route, we will attach a rule: +And on this route, we come to attach a rule: + +| Field | Value and description | +| :--- | :--- | +| serviceName | Identifier of your OVHcloud Load Balancer service | +| routeId | Identifier of the route created just above | +| field | "header" | +| subField | "Upgrade" | +| match | "is" | +| negate | false | +| pattern | "websocket" (case-sensitive) | -|Field|Value and description| -|---|---| -|serviceName|Your OVH Load Balancer service ID| -|routeId|Route ID created above| -|field|"header"| -|subField|"Upgrade"| -|match|"is"| -|negate|false| -|pattern|"websocket" (case-sensitive)| +All that remains is to apply the configuration in the relevant zone. -Next, apply the configuration to the zone concerned. -## Reference. +### References -Here, you will find more details on the API calls linked to the routes. To get a general idea of how routes work, we recommend starting off by reading the [introduction to the API](#an-introduction-to-the-api){.internal} section further up. +You will find here the details of the API calls related to routes. For a more general overview of route features, we invite you to first consult the section " [API presentation](#apipresentation) " a little further up in this guide. -### Edit routes. +#### Handling routes -TCP and HTTP routes are configured the same way. Since the routes are more powerful in HTTP, this section focuses on HTTP rules and routes. TCP routes can be extrapolated from the information below by replacing “http” with “tcp” in each route. Some fields only apply to HTTP routes, and are not available in TCP. +TCP and HTTP routes are configured in the same way. Since HTTP routes are more powerful, this section focuses on HTTP routes and rules. The operation of TCP routes can be extrapolated by replacing "http" with "tcp" in the routes. Some fields only make sense in HTTP, so they are not available in TCP. -#### List the routes. +##### **List routes** -This call returns the list of ID numbers of routes defined for HTTP protocol. You can filter this list by frontendId. This call returns the routes in the order in which they will be evaluated. The evaluation order can be partially controlled by the weight of the route. +This call returns the list of numeric identifiers of routes defined for the HTTP protocol. You can filter this list by `frontendId`. This call returns the routes in the order in which they will be evaluated. The evaluation order can be partially controlled using the "weight" of the route. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route -> +> -|Setting|Required|Meaning| -|---|---|---| -|serviceName|Required|Your Load Balancer service ID| -|frontendId||ID number of a HTTP front-end the routes are attached to| +| Parameter | Required | Meaning | +| :--- | :--- | :--- | +| serviceName | Required | Identifier of your Load Balancer service | +| frontendId | | Numeric identifier of an HTTP frontend to which the routes are attached | -#### Create a route. +##### **Create a route** -With this call, you can create a route. Only the action is mandatory. A route can be attached to and detached from a front-end. You can create up to 50 routes on an OVH Load Balancer. This call returns the route created, if it is successful. You will need to re-deploy your OVH Load Balancer to apply the changes. +This call allows you to create a route. Only the action is mandatory. A route can be attached and detached from a frontend. It is possible to create up to 50 routes on an OVHcloud Load Balancer service. This call returns the created route in case of success. Your OVHcloud Load Balancer service must be redeployed to apply the changes. > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route -> +> -|Setting|Required|Meaning| -|---|---|---| -|serviceName|Required|Your Load Balancer service ID| -|displayName||Display name for your route (255 characters maximum)| -|frontendId||ID number of a HTTP front-end to attach the route to| -|weight||Route priority, between 1 (carry out first) and 255 (carry out after the others)| -|action.type|Required|Name of the action type to execute if all of the rules associated with the route are validated| -|action.status||HTTP status code for `reject` and `redirect` actions| -|action.target||ID number of the target farm for `farm` actions, or the URL template for `redirect` actions| +| Parameter | Required | Meaning | +| :--- | :--- | :--- | +| serviceName | Required | Identifier of your Load Balancer service | +| displayName | | Display name of your route (maximum 255 characters) | +| frontendId | | Numeric identifier of an HTTP frontend to which to attach the route | +| weight | | Priority of the route, between 1 (passes first) and 255 (passes after others) | +| action.type | Required | Name of the type of action to execute if all the rules associated with the route are validated | +| action.status | | HTTP status code for the `reject` and `redirect` actions | +| action.target | | Numeric identifier of the target farm for the `farm` actions, or URL pattern for the `redirect` actions | -The possible action types are listed below: +The possible action types are: -|action|Meaning| -|---|---| -|redirect|Redirects a request to `action.target`, with the HTTP `action.status` code| -|reject|Rejects a request with the HTTP `action.status` code| -|farm|Routes a request to the farm with the ID entered in `action.target`| +| action | Meaning | +| :--- | :--- | +| redirect | Redirect a request to `action.target` with the HTTP status code `action.status` | +| reject | Reject a request with the HTTP status code `action.status` | +| farm | Route a request to the farm whose identifier is specified in `action.target` | -For further information on the actions managed and the format of parameters, please read the [Available actions](#available-actions){.internal} section further down. +For more information on the actions handled and the format of the parameters, we invite you to consult the section " [Available actions](#available-actions) " further down in this guide. -#### View details on a route. +##### **View the details of a route** -With this call, you can view details on an HTTP route if you know its ID. +This call allows you to view the details of an HTTP route, knowing its identifier. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId} -> +> -Query +- Request: -|Setting|Meaning| -|---|---| -|serviceName|Your Load Balancer service ID| -|routeId|The route’s ID number| +| Parameter | Meaning | +| :--- | :--- | +| serviceName | Identifier of your Load Balancer service | +| routeId | Numeric identifier of the route | -Answer +- Response: -|Setting|Meaning| -|---|---| -|routeId|The route’s ID number| -|displayName|The display name for your route| -|frontendId|ID number of the front-end your route is attached to| -|weight|Priority of your route| -|action.type|Name of the action type for your route| -|action.status|Associated HTTP status code| -|action.target|ID number of the associated farm or URL template| -|rules|List of rules that must be validated to trigger the route’s action More detail on this is available in the [Edit rules](#edit-rules){.internal} section.| +| Parameter | Meaning | +| :--- | :--- | +| routeId | Numeric identifier of the route | +| displayName | Display name of your route | +| frontendId | Numeric identifier of the frontend to which your route is attached | +| weight | Priority of your route | +| action.type | Name of the type of action of your route | +| action.status | Associated HTTP status code | +| action.target | Numeric identifier of the farm or associated URL pattern | +| rules | List of rules that must be validated to trigger the action of the route. More details are available in the section " [Handling Rules](#handling-rules) ". | -For further information on the actions managed and the format of parameters, please read the [Available actions](#available-actions){.internal} section further down. +For more information on the actions handled and the format of the parameters, we invite you to consult the section "[Available actions](#available-actions)" further down in this guide. -#### Modify a route. +##### **Modify a route** -With this call, you can modify an HTTP route if you know its ID. You will need to re-deploy your OVH Load Balancer to apply the changes. +This call allows you to modify an HTTP route, knowing its identifier. Your OVHcloud Load Balancer service must be redeployed to apply the changes. > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId} > -|Setting|Required|Meaning| -|---|---|---| -|serviceName|Required|Your Load Balancer service ID| -|routeId|Required|The route’s ID number| -|displayName||Display name for your route (255 characters maximum)| -|frontendId||ID number of a HTTP front-end to attach the route to| -|weight||Route priority, between 1 (carry out first) and 255 (carry out after the others)| -|action.type|Required|Name of the action type to execute if all of the rules associated with the route are validated| -|action.status||HTTP status code for `reject` and `redirect` actions| -|action.target||ID number of the target farm for `farm` actions, or the URL template for `redirect` actions| +| Parameter | Required | Meaning | +| :--- | :--- | :--- | +| serviceName | Required | Identifier of your Load Balancer service | +| routeId | Required | Numeric identifier of the route | +| displayName | | Display name of your route (maximum 255 characters) | +| frontendId | | Numeric identifier of an HTTP frontend to which to attach the route | +| weight | | Priority of the route, between 1 (passes first) and 255 (passes after others) | +| action.type | Required | Name of the type of action to execute if all the rules associated with the route are validated | +| action.status | | HTTP status code for the `reject` and `redirect` actions | +| action.target | | Numeric identifier of the target farm for the `farm` actions, or URL pattern for the `redirect` actions | -For further information on the actions managed and the format of parameters, please read the [Available actions](#available-actions){.internal} section further down. +For more information on the actions handled and the format of the parameters, we invite you to consult the section " [Available actions](#available-actions) " further down in this guide. -#### Delete a route. +##### **Delete a route** -With this call, you can delete an HTTP route if you know its ID. When a route is deleted, all of the rules associated with the route are deleted, too. You do not need to delete them individually. You will need to re-deploy your OVH Load Balancer to apply the changes. +This call allows you to delete an HTTP route, knowing its identifier. When a route is deleted, all the rules associated with that route are also deleted. There is no need to delete them individually. Your OVHcloud Load Balancer service must be redeployed to apply the changes. > [!api] > > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId} -> +> -|Setting|Required|Meaning| -|---|---|---| -|serviceName|Required|Your Load Balancer service ID| -|routeId|Required|The route’s ID number| +| Parameter | Required | Meaning | +| :--- | :--- | :--- | +| serviceName | Required | Identifier of your Load Balancer service | +| routeId | Required | Numeric identifier of the route | -### Edit rules. +#### Handling rules -#### List the rules. +##### **List rules** -This call returns the list of ID numbers of rules defined for a particular route. +This call returns the list of numeric identifiers of rules defined for a given route. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule -> +> -|Setting|Required|Meaning| -|---|---|---| -|serviceName|Required|Your Load Balancer service ID| -|routeId|Required|The route’s ID number| +| Parameter | Required | Meaning | +| :--- | :--- | :--- | +| serviceName | Required | Identifier of your Load Balancer service | +| routeId | Required | Numeric identifier of the route | -#### Attach a rule. +##### **Attach a rule** -With this call, you can attach a rule to a route. You can attach up to 5 rules per route on an OVH Load Balancer. This call returns the route created, if it is successful. You will need to re-deploy your OVH Load Balancer to apply the changes. +This call allows you to attach a rule to a route. It is possible to attach up to 5 rules per route on an OVHcloud Load Balancer service. This call returns the created rule in case of success. Your OVHcloud Load Balancer service must be redeployed to apply the changes. > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule -> - -|Setting|Required|Meaning| -|---|---|---| -|serviceName|Required|Your Load Balancer service ID| -|routeId|Required|The route’s ID number| -|field|Required|The name of the HTTP parameter to apply the rule to| -|subField||HTTP header name for the `header` rules, or cookie name for `cookie` rules| -|match|Required|Name of the comparison to apply to validate the rule| -|negate||Reverses the comparison result| -|pattern||Comparison pattern| - -`field` - -|Value|Meaning| -|---|---| -|source|The address or list of source IP addresses (a.b.c.d/z)| -|protocol|Protocol (“http” or “https”)| -|method|HTTP method (GET, HEAD, POST, PUT, DELETE, OPTIONS, CONNECT, TRACE)| -|host|Domain name (vhost), without the port number| -|uri|Path of the request as it appears between the first "/" and the last "?"| -|param|HTTP parameter contained in the part after the first "?"| -|header|HTTP header| -|cookie|HTTP cookie| - -`match` - -|Value|Meaning| -|---|---| -|exists|The property must exist (e.g. HTTP header or cookie)| -|-|The property must correspond exactly to a `pattern`| -|in|The property must be in the list of values (separated by commas) defined by `pattern`| -|contains|The property must contain the `pattern` value| -|startswith|The property must start with the `pattern` value| -|endswith|The property must end with the `pattern` value| -|matches|The property must match the regular `pattern` expression| - -For further information on the rules managed and the format of parameters, please read the [Available rules](#available-rules){.internal} section further down. - -#### View details on a rule. - -With this call instruction, you can view the details on a rule attached to an HTTP route if you know its ID. +> + +| Parameter | Required | Meaning | +| :--- | :--- | :--- | +| serviceName | Required | Identifier of your Load Balancer service | +| routeId | Required | Numeric identifier of the route | +| field | Required | Name of the HTTP parameter on which to apply this rule | +| subField | | Name of the HTTP header for `header` rules or name of the cookie for `cookie` rules | +| match | Required | Name of the comparator to apply to validate the rule | +| negate | | Inverts the result of the comparator | +| pattern | | Comparator argument | + +- `field` + +| Value | Meaning | +| :--- | :--- | +| source | Address or list of source addresses in the form of IP (a.b.c.d/z) | +| protocol | Protocol. "http" or "https" | +| method | HTTP method (GET, HEAD, POST, PUT, DELETE, OPTIONS, CONNECT, TRACE) | +| host | Domain name (vhost), without the port number | +| uri | Request path as understood between the first "/" and the first "?" | +| param | HTTP parameter coming from the part after the first "?" | +| header | HTTP header | +| cookie | HTTP cookie | + +- `match` + +| Value | Meaning | +| :--- | :--- | +| exists | The property must exist (HTTP header or cookie for example) | +| is | The property must match exactly `pattern` | +| in | The property must be in the list of values (separated by commas) defined by `pattern` | +| contains | The property must contain the value of `pattern` | +| startswith | The property must start with the value of `pattern` | +| endswith | The property must end with the value of `pattern` | +| matches | The property must match the regular expression of `pattern` | + +For more information on the rules handled and the format of the parameters, we invite you to consult the section " [Available rules](#available-rules) " further down in this guide. + +##### **View the details of a rule** + +This call allows you to view the details of a rule attached to an HTTP route, knowing its identifier. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId} -> +> -Query +- Request: -|Setting|Meaning| -|---|---| -|serviceName|Your Load Balancer service ID| -|routeId|The route’s ID number| -|ruleId|The rule’s ID number| +| Parameter | Meaning | +| :--- | :--- | +| serviceName | Identifier of your Load Balancer service | +| routeId | Numeric identifier of the route | +| ruleId | Numeric identifier of the rule | -Answer +- Response: -|Setting|Meaning| -|---|---| -|ruleId|The rule’s ID number| -|field|Name of the HTTP parameter to apply the rule on| -|subField|Name of the HTTP header or cookie for the rule| -|match|Name of the comparison to apply to validate the rule| -|negate|"true" if the comparison result is reversed| -|pattern|Comparison argument. The direction and syntax depends on the `match` and the `field`.| +| Parameter | Meaning | +| :--- | :--- | +| ruleId | Numeric identifier of the rule | +| field | Name of the HTTP parameter on which to apply the rule | +| subField | Name of the HTTP header or cookie for the rule | +| match | Name of the comparator to apply to validate the rule | +| negate | "true" if the result of the comparator is inverted | +| pattern | Comparator argument. The meaning and syntax depend on `match` and `field` | -For further information on the rules managed and the format of parameters, please read the [Available rules](#available-rules){.internal} section further down. +For more information on the rules handled and the format of the parameters, we invite you to consult the section " [Available rules](#available-rules) " further down in this guide. -#### Modify a rule. +##### **Modify a rule** -With this call, you can modify a rule attached to an HTTP route if you know its ID. You will need to re-deploy your OVH Load Balancer to apply the changes. +This call allows you to modify a rule attached to an HTTP route, knowing its identifier. Your OVHcloud Load Balancer service must be redeployed to apply the changes. > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId} -> +> -|Setting|Required|Meaning| -|---|---|---| -|serviceName|Required|Your Load Balancer service ID| -|routeId|Required|The route’s ID number| -|ruleId|Required|The rule’s ID number| -|field|Required|The name of the HTTP parameter to apply the rule to| -|subField||HTTP header name for the `header` rules, or cookie name for `cookie` rules| -|match|Required|Name of the comparison to apply to validate the rule| -|negate||Reverses the comparison result| -|pattern||Comparison pattern| +| Parameter | Required | Meaning | +| :--- | :--- | :--- | +| serviceName | Required | Identifier of your Load Balancer service | +| routeId | Required | Numeric identifier of the route | +| ruleId | Required | Numeric identifier of the rule | +| field | Required | Name of the HTTP parameter on which to apply this rule | +| subField | | Name of the HTTP header for `header` rules or name of the cookie for `cookie` rules | +| match | Required | Name of the comparator to apply to validate the rule | +| negate | | Inverts the result of the comparator | +| pattern | | Comparator argument | -For further information on the rules managed and the format of parameters, please read the [Available rules](#available-rules){.internal} section further down. +For more information on the rules handled and the format of the parameters, we invite you to consult the section " [Available rules](#available-rules) " further down in this guide. -#### Delete a rule. +##### **Delete a rule** -With this call, you can delete a rule attached to an HTTP route if you know its ID. You will need to re-deploy your OVH Load Balancer to apply the changes. +This call allows you to delete a rule attached to an HTTP route, knowing its identifier. Your OVHcloud Load Balancer service must be redeployed to apply the changes. > [!api] > > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId} -> +> -|Setting|Required|Meaning| -|---|---|---| -|serviceName|Required|Your Load Balancer service ID| -|routeId|Required|The route’s ID number| -|ruleId|Required|The rule’s ID number| +| Parameter | Required | Meaning | +| :--- | :--- | :--- | +| serviceName | Required | Identifier of your Load Balancer service | +| routeId | Required | Numeric identifier of the route | +| ruleId | Required | Numeric identifier of the rule | > [!primary] > -> If you want to delete a route, you do not need to delete all the rules attached to it. The rules are automatically deleted when you delete the route. -> +> If you want to delete a route, it is not necessary to delete all the rules attached to it. The rules are automatically deleted when you delete a route. +> -#### List all of the TCP and HTTP routes. +##### **List all TCP and HTTP routes** -With this call, you can get a list of all the IDs, display names and types ("http"/"tcp") of routes defined on an OVH Load Balancer service. It is designed to simplify the implementation of auto-completion. +This call allows you to list all the identifiers, display names and types ("http"/"tcp") of routes defined on an OVHcloud Load Balancer service. It was designed to simplify the implementation of auto-completion. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/definedRoutes -> +> -Query +- Request: -|Setting|Meaning| -|---|---| -|serviceName|Your Load Balancer service ID| +| Parameter | Meaning | +| :--- | :--- | +| serviceName | Identifier of your Load Balancer service | -Answer +- Response: -|Setting|Meaning| -|---|---| -|type|Type of protocol for the route: "tcp" for TCP routes, "http" for HTTP routes| -|routeId|The route’s ID number| -|displayName|The display name of the route| +| Parameter | Meaning | +| :--- | :--- | +| type | Type of protocol of the route: "tcp" for TCP routes, "http" for HTTP routes | +| routeId | Numeric identifier of the route | +| displayName | Display name of the route | -### Actions available +#### Available actions -This call returns the list of actions available for TCP and HTTP routes, as well as the values expected for each of the fields. +This call returns the list of available actions for TCP and HTTP routes as well as the expected values for each of the fields. -If a field is “null”, this means that no value is expected. If an invalid value is entered, the API will return a validation error. +If a field is "null", it means that no value is expected. If an invalid value is provided, the API will return a validation error. -All of the actions managed by the OVH Load Balancer service are final. This means that executing an action also triggers the end of route evaluation. +All actions managed by the OVHcloud Load Balancer service are final. This means that the execution of an action also ends the evaluation of the routes. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteActions -> +> -Query +- Request: -|Setting|Meaning| -|---|---| -|serviceName|Your Load Balancer service ID| +| Parameter | Meaning | +| :--- | :--- | +| serviceName | Identifier of your Load Balancer service | -Answer +- Response: -|Setting|Meaning| -|---|---| -|type|Shows if this action is valid for a HTTP or a TCP route| -|name|Name of the action to enter into the `type` field of routes| -|status|List of HTTP status codes available for this action (`status` fields of routes)| -|destination|Value type expected in the `destination` fields for routes| +| Parameter | Meaning | +| :--- | :--- | +| type | Indicates whether this action is valid for an HTTP route or a TCP route | +| name | Name of the action to specify in the `type` field of the routes | +| status | List of available HTTP status codes for this action (the `status` field of the routes) | +| destination | Type of value expected in the `destination` field of the routes | -#### Redirection +##### **Redirection** -This action sends a redirection to the visitor. This redirection type can be configured with the status field. When this action is selected, no farms will receive the request. +This action returns a redirection to the visitor. The type of redirection can be configured with the `status` field. When this action is selected, no farm will receive the request. -|Setting|Value| -|---|---| -|type|`redirect`| -|status|301, 302, 303, 307 or 308| -|target|Target URL (may contain variables)| +| Parameter | Value | +| :--- | :--- | +| type | `redirect` | +| status | 301, 302, 303, 307 or 308 | +| target | Destination URL (can contain variables) | -Only the HTTP redirection status codes can be specified. The most common codes are 301 and 302. If you have any doubts, you can set up a 302 (temporary redirection). The HTTP status codes for redirections are: +Only HTTP redirection status codes can be specified. The most common are codes 301 and 302. If you are unsure, you can use the 302 "Temporary Redirect". The HTTP status codes recognized for redirections are: -|Status code|Description| -|---|---| -|301|Permanent redirection. The redirection can be saved by the browser.| -|302 (default)|Temporary redirection. The redirection must be revalidated for each request by the browser.| -|303|Works like a 302, and forces the use of the HTTP GET method.| -|307|Works like a 302, and forces the same HTTP method to be reused (GET, POST, etc.).| -|308|Works like a 301, and forces the same HTTP method to be reused (GET, POST, etc.).| +| Status code | Description | +| :--- | :--- | +| 301 | Permanent redirect. The redirect can be stored by the browser. | +| 302 (default) | Temporary redirect. The redirect must be revalidated by the browser on each request. | +| 303 | Like 302 and forces the use of the HTTP GET method. | +| 307 | Like 302 and forces the reuse of the same HTTP method (GET, POST, etc.). | +| 308 | Like 301 and forces the reuse of the same HTTP method (GET, POST, etc.). | -The target URL may contain simple variables. This helps users redirect to another domain, another protocol or add a suffix/prefix to a URL. The recognised variables are: +The destination URL can contain simple variables. This allows you to redirect to another domain, another protocol or add a suffix / prefix to a URL. The recognized variables are: -|Variable|Description| -|---|---| -|`protocol`|Protocol of the request ("http" or "https")| -|`domain`|Domain name of the request, without the port number| -|`host`|"Host" field of the request, including the port number, if there is one| -|`port`|Port of the request| -|`path`|Path of the request, starts with a '/' and ends before the first '?'| -|`arguments`|Arguments of the request, starts with a '?' if present| +| Variable | Description | +| :--- | :--- | +| `protocol` | Protocol of the request ("http" or "https") | +| `domain` | Domain name of the request, without the port number | +| `host` | "Host" field of the request, including the port number if present | +| `port` | Port of the request | +| `path` | Path of the request, starts with a '/' and ends at the first '?' | +| `arguments` | Arguments of the request, starts with a '?' if present | -For example, for: +For example, to: -- redirect to https: `https://${host}${path}${arguments}` -- redirect to a new domain: ${protocol}://new.example.com${path}${arguments} -- prefix the URL: ${protocol}://${host}/staging${path}${arguments} +- redirect to https: `https://\${host}\${path}\${arguments}` +- redirect to a new domain: `${protocol}://new.example.com\${path}\${arguments}` +- prefix the URL: `${protocol}://\${host}/staging\${path}\${arguments}` -#### Reject. +##### **Rejection** -This action returns an HTTP error status code to the visitor. The HTTP error code can be configured with the status field. When this action is selected, no farms will receive the request. +This action returns an HTTP error status code to the visitor. The error HTTP status code can be configured with the `status` field. When this action is selected, no farm will receive the request. -|Setting|Value| -|---|---| -|type|`reject`| -|status|200, 400, 403, 405, 408, 429, 500, 502, 503 or 504| -|target|not available| +| Parameter | Value | +| :--- | :--- | +| type | `reject` | +| status | 200, 400, 403, 405, 408, 429, 500, 502, 503 or 504 | +| target | not available | > [!primary] > -> This action is also available in TCP. In this case, the parameter status is not available, and the request is terminated. TCP requests that are terminated like this are not compatible with high percentages of requests. -> +> This action is also available in TCP. In this case, the `status` parameter is not available and the request is terminated. TCP requests terminated in this way are not counted in the request rate. +> -Only the HTTP error codes listed in the API can be specified. The most common ones are 400 ("Bad request") errors, and 403 ("Forbidden") errors. A 200 code can be used to block a request type while simulating a success, and a 503 code can be used to simulate a server outage. +Only the HTTP error status codes listed in the API can be specified. The most common are the codes 400 "Bad request" and 403 "Forbidden". 200 can be used to block a type of request while simulating a success, and 503 can be used to simulate a server failure. -|Status code|Description| -|---|---| -|200|The request has been successfully executed.| -|400|Invalid request.| -|403 (default)|Access forbidden.| -|405|Method (GET, POST, PUT, ...) invalid or not managed.| -|408|The request has taken too long to be sent by the client.| -|429|The client has sent too many requests (rate limiting).| -|500|Generic server error.| -|502|Error communicating with the server.| -|503|The service is temporarily unavailable.| -|504|The server has taken too much time to respond.| +| Status code | Description | +| :--- | :--- | +| 200 | The request was executed successfully. | +| 400 | Invalid request. | +| 403 (default) | Access forbidden. | +| 405 | Invalid or unhandled method (GET, POST, PUT, etc.) +| 408 | The client failed to send a complete request within the server's time limit. | +| 429 | The client sent too many requests (rate-limiting). | +| 500 | Generic server error. | +| 502 | Communication error with the server. | +| 503 | The service is temporarily unavailable. | +| 504 | The server took too long to respond. | -#### Routing. +##### **Routing** -This action redirects requests to a specific farm, other than the default farm configured on the front-end. The destination farm must be the same type as the front-end ("http" or "tcp"). +This action directs requests to a specific farm, other than the default farm configured on the frontend. The target farm must be of the same type as the frontend ("http" or "tcp"). -|Setting|Value| -|---|---| -|type|`farm`| -|status|not available| -|target|The destination farm’s ID number. This must be the same type.| +| Parameter | Value | +| :--- | :--- | +| type | `farm` | +| status | not available | +| target | Numeric identifier of the target farm. This must be of the same type | > [!primary] > -> This action is also available in TCP. In this case, the destination farm type must be "tcp". -> +> This action is also available in TCP. In this case, the target farm must be of type "tcp". +> -### Available rules. +#### Available rules -This call returns the list of rules available for TCP and HTTP routes, as well as the values expected for each of the fields. +This call returns the list of available rules for TCP and HTTP routes, as well as the expected values for each field. -If a field is “null”, this means that no value is expected. If an invalid value is entered, the API will return a validation error. +If a field is "null", it means no value is expected. If an invalid value is provided, the API will return a validation error. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteRules -> +> -Query +- Request: -|Setting|Meaning| -|---|---| -|serviceName|Your Load Balancer service ID| +| Parameter | Meaning | +| :--- | :--- | +| serviceName | Identifier of your Load Balancer service | -Answer +- Response: -|Setting|Meaning| -|---|---| -|type|Type of protocol for the route: "tcp" for TCP routes, "http" for HTTP routes| -|name|Name of the property on which to apply this rule, to be entered into the `field` field| -|hasSubField|"true" is this property is a sub-property (e.g. a header or cookie)| -|matches|List of comparisons available for each rule, to be entered into the `match` field| -|pattern|Type of value expected for the `pattern` field| -|enum|List of values for the chmaps `pattern`, if it is a list| +| Parameter | Meaning | +| :--- | :--- | +| type | Protocol type of the route: "tcp" for TCP routes, "http" for HTTP routes | +| name | Name of the property to which this rule applies, to be filled in the `field` field | +| hasSubField | "true" if this property has a "sub-property" (e.g.: a header or a cookie) | +| matches | List of available comparators for this rule, to be filled in the `match` field | +| pattern | Type of expected value for the `pattern` field | +| enum | List of possible values for the `pattern` field if it is an enumeration | -The different `pattern` types are: +The different types of `pattern` are: -|Value|Meaning| -|---|---| -|cidr|IP address (a.b.c.d) or sub-network (a.b.c.d/z)| -|string|Free text. For the `in` operator, a list of values separated by columns (255 characters maximum)| -|enum|The field is a list defined in `enum`| +| Value | Meaning | +| :--- | :--- | +| cidr | IP address (a.b.c.d) or subnet (a.b.c.d/z) | +| string | Free text. For the operator `in`, a list of comma-separated values (maximum 255 characters) | +| enum | The field is an enumeration defined in `enum` | -#### Protocol. +##### **Protocol** -With this rule, you can filter requests depending on their protocol. In practice, the uses for this rule are quite limited, as the protocol depends on the front-end that the route is attached to, or a front-end that only manages a single protocol recognised the moment the route is defined. +This rule allows filtering requests based on their protocol. In practice, the use cases for this rule are quite limited because the protocol depends on the frontend to which the route is attached, and a frontend only handles one protocol, which is known at the time the route is defined. -|Fields|Value| -|---|---| -|name|`protocol`| -|hasSubField|no| -|matches|`is` or `in`| -|pattern|`tcp`, `tls`, `http` or `https`| +| Field | Value | +| :--- | :--- | +| name | `protocol` | +| hasSubField | no | +| matches | `is` or `in` | +| pattern | `tcp`, `tls`, `http` or `https` | > [!primary] > -> This action is also available in TCP. In this case, "http/2.0" protocol is also available. It is based on the "ALPN" SSL/TLS field used by browsers to announce that they are attempting to establish a HTTP/2.0 connection. This way, you can have a common TCP front-end for SSL/TLS termination of HTTP 1 and 2, then direct traffic depending on the protocol version. -> +> This action is also available in TCP. In this case, the "http/2.0" protocol is also available. It is based on the SSL/TLS "ALPN" field used by browsers to announce that they are trying to establish an HTTP/2.0 connection. This allows for a common TCP frontend for HTTP 1 and 2 SSL/TLS termination, then routing these streams based on the protocol version. +> -#### Source address. +##### **Source address** -With this rule, you can filter requests depending on their source address. By combining it with a rule based on the URI or the domain name, you can restrict certain resources to an enterprise proxy while exposing all of your other resources without restrictions, via your OVH Load Balancer. +This rule allows filtering requests based on their source address. By combining it with a rule based on the URI or domain name, it is for example possible to restrict certain resources to an enterprise proxy, while exposing all other resources without restrictions on your OVHcloud Load Balancer service. -|Fields|Value| -|---|---| -|name|`source`| -|hasSubField|no| -|matches|`is` or `in`| -|pattern|Sub-network (a.b.c.d/z) or address (a.b.c.d)| +| Field | Value | +| :--- | :--- | +| name | `source` | +| hasSubField | no | +| matches | `is` or `in` | +| pattern | Subnet (a.b.c.d/z) or address (a.b.c.d) | > [!primary] > -> This action is also available in TCP using the same method. -> +> This action is also available in TCP with the same behavior. +> -To block a particular network and address, for example, you can use a pattern like "4.4.0.0/16, 8.8.8.8". +For example, to block a network and a specific address, you can use a pattern such as "4.4.0.0/16, 8.8.8.8". -#### Domain name. +##### **Domain name** -With this rule, you can filter requests depending on their domain name. In doing so, you can reproduce the Apache "vhost" feature, or route all of the domains that start with "mail." to a server dedicated to webmail. +This rule allows filtering requests based on their domain name. This can for example be used to reproduce the "vhost" function of Apache or to route all domains starting with "mail." to a server dedicated to webmail. -|Fields|Value| -|---|---| -|name|`host`| -|hasSubField|no| -|matches|`is`, `in`, `contains`, `startswith`, `endswith` or `matches`| -|pattern|Character chain or regular expression| +| Field | Value | +| :--- | :--- | +| name | `host` | +| hasSubField | no | +| matches | `is`, `in`, `contains`, `startswith`, `endswith` or `matches` | +| pattern | String or regular expression | > [!primary] > -> This action is also available in TCP. It will only work if the front-end is configured to accept SSL/TLS connections, and if the client sends an "SNI" option. This is especially the case with recent web browsers. -> +> This action is also available in TCP. It is only applicable if the frontend is configured to accept SSL/TLS connections and the client sends an "SNI" option. This is particularly the case for recent web browsers. +> -#### HTTP method. +##### **HTTP method** -With this rule, you can filter requests depending on their HTTP method. It is commonly used alongside a rule based the request URI or path, to make the rule more selective. +This rule allows filtering requests based on the HTTP method. It is commonly used in conjunction with a rule based on the request URI or path to make the rule more selective. -|Fields|Value| -|---|---| -|name|`method`| -|hasSubField|no| -|matches|`is` or `in`| -|pattern|`GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS` or `TRACE`| +| Field | Value | +| :--- | :--- | +| name | `method` | +| hasSubField | no | +| matches | `is` or `in` | +| pattern | `GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS` or `TRACE` | -#### Request path. +##### **Request path** -With this rule, you can filter requests depending on their path, or URI. The request path is between the first '/' (inclusive) and the first '?' (excluded). +This rule allows filtering requests based on the request path or URI. The request path is the part between the first '/' included and the first '?' excluded. -|Fields|Value| -|---|---| -|name|`uri`| -|hasSubField|no| -|matches|`is`, `in`, `contains`, `startswith`, `endswith` or `matches`| -|pattern|Character chain or regular expression| +| Field | Value | +| :--- | :--- | +| name | `uri` | +| hasSubField | no | +| matches | `is`, `in`, `contains`, `startswith`, `endswith` or `matches` | +| pattern | String or regular expression | -#### Request parameter. +##### **Request parameter** -This rule filters requests depending on their existence, or the value of a specific HTTP request parameter. This is the part after the first '?'. If a parameter is specified several times in a request, only the first instance is taken into account. +This rule allows filtering requests based on the existence or value of a specific HTTP request parameter. This is the part after the first '?'. If a parameter is specified multiple times in the request, only the first one is taken into account. -|Fields|Value| -|---|---| -|name|`param`| -|hasSubField|yes| -|matches|`is`, `in`, `contains`, `startswith`, `endswith` or `matches`| -|pattern|Character chain or regular expression| +| Field | Value | +| :--- | :--- | +| name | `param` | +| hasSubField | yes | +| matches | `is`, `in`, `contains`, `startswith`, `endswith` or `matches` | +| pattern | String or regular expression | -#### HTTP header. +##### **HTTP header** -This rule filters requests depending on their existence, or the value of a specific HTTP header value. You can use it to detect the opening of a WebSocket connection, and direct it to a dedicated server farm. +This rule allows filtering requests based on the existence or value of a specific HTTP header. This can for example be used to detect the opening of a websocket connection and route it to a dedicated farm. -|Fields|Value| -|---|---| -|name|`header`| -|hasSubField|yes| -|matches|`is`, `in`, `contains`, `startswith`, `endswith` or `matches`| -|pattern|Character chain or regular expression| +| Field | Value | +| :--- | :--- | +| name | `header` | +| hasSubField | yes | +| matches | `is`, `in`, `contains`, `startswith`, `endswith` or `matches` | +| pattern | String or regular expression | -#### Cookie. +##### **Cookie** -With this rule, you can filter requests depending on the existence or value of a specific HTTP cookie. You can use it to direct voluntary visitors to a pre-production farm. +This rule allows filtering requests based on the existence or value of a specific HTTP cookie. This can for example be used to direct opt-in visitors to a pre-production farm. -|Fields|Value| -|---|---| -|name|`cookie`| -|hasSubField|yes| -|matches|`is`, `in`, `contains`, `startswith`, `endswith` or `matches`| -|pattern|Character chain or regular expression| +| Field | Value | +| :--- | :--- | +| name | `cookie` | +| hasSubField | yes | +| matches | `is`, `in`, `contains`, `startswith`, `endswith` or `matches` | +| pattern | String or regular expression | ## Go further -Join our community of users on . +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_route/guide.fr-ca.md b/pages/network/load_balancer/create_route/guide.fr-ca.md index 953817cf22c..2942881f2d3 100644 --- a/pages/network/load_balancer/create_route/guide.fr-ca.md +++ b/pages/network/load_balancer/create_route/guide.fr-ca.md @@ -1,706 +1,738 @@ --- -title: 'Travailler avec les routes HTTP' -excerpt: 'Dirigez dynamiquement vos requêtes vers une ferme en particulier' -updated: 2018-04-09 +title: "Configuration d'un service OVHcloud Load Balancer avec les routes HTTP" +excerpt: "Dirigez dynamiquement vos requêtes vers une ferme spécifique" +updated: 2025-11-27 --- ## Objectif -Le service Load Balancer OVH redirige le trafic arrivant sur un Frontend vers les Serveurs de la Ferme par défaut de ce Frontend, ou sa redirection par défaut. +Le service Load Balancer OVHcloud redirige le trafic entrant du frontend vers les serveurs de la ferme par défaut de ce frontend, ou sa redirection par défaut. -Dans certains cas, il est possible d'aller plus loin, et de router, rediriger ou rejeter le trafic selon divers critères. Par exemple, dans le cas d'un service HTTP(S), il est possible de filtrer le trafic en fonction de la méthode HTTP, de l'URL ou même de la valeur d'un Cookie ou d'un En-Tête ! Dans le service OVH Load Balancer, ce sont les `route`{.action}. Une route est une action particulière à réaliser si une ou plusieurs conditions sont réalisées. +Dans certains cas, il est possible d'aller plus loin et de router, rediriger ou rejeter le trafic selon divers critères. Par exemple, dans le cas d'un service HTTP(S), il est possible de filtrer le trafic en fonction de la méthode HTTP, de l'URL ou même de la valeur d'un cookie ou d'un en-tête. Dans le service OVHcloud Load Balancer, ces éléments sont appelés **routes**. Une route est une action particulière à effectuer si une ou plusieurs conditions sont remplies. + +**Ce guide vous montrera comment diriger vos requêtes dynamiquement vers une ferme spécifique grâce à l'utilisation de routes.** ## Prérequis -- Disposer d'un [Load Balancer OVH](https://www.ovh.com/ca/fr/solutions/load-balancer/) sur une offre autorisant la création des routes -- Avoir accès à l'[API OVH](/links/api). +- Disposer d'un [Load Balancer OVHcloud](/links/network/load-balancer) sur une offre autorisant la création des routes. +- Avoir accès à l'[API OVHcloud](/links/api). ## En pratique > [!primary] > -> Bien que ce guide se concentre sur les routes HTTP, le même principe fonctionne en TCP (avec les routes TCP). Cela peut servir pour diriger le trafic HTTP/2 vers une ferme en particulier ou pour rejeter les requêtes venant de certaines IPs. -> +> Bien que ce guide se concentre sur les **routes HTTP**, le même principe s'applique aux routes **TCP**. Cela peut servir pour diriger le trafic HTTP/2 vers une ferme spécifique ou rejeter les requêtes entrantes provenant de certaines adresses IP. +> -Cette fonctionnalité étant encore très jeune, elle est uniquement disponible dans l'API. Ce guide vous présentera les principes généraux ainsi que des scénarii d'utilisation des routes tirés de cas d'usages réels. +Cette fonctionnalité n'est disponible que via l'API. Ce guide vous présentera les principes généraux ainsi que des scénarios d'utilisation des routes tirés de cas d'usages réels. -- **Introduction aux routes** +### Introduction aux routes -Une route sert à contrôler le trafic selon différents critères. Il est possible de les exprimer sous la forme de règles, ou conditions, et d'une action. +Une route sert à contrôler le trafic selon différents critères. Il est possible de les exprimer sous forme de **règles**, de **conditions** ou d'**actions**. -Par exemple, *SI* l'URL _commence_ par '/wp-admin/' (1) *ET* que la connexion _est_ en HTTP (2) *ALORS* _rediriger_ vers la version HTTPS de la page (3). +Par exemple, *SI* l'URL _commence_ par '/wp-admin/' (1) *ET* la connexion _est_ en HTTP (2) *ALORS* _rediriger_ vers la version HTTPS de la page (3). Dans cet exemple, il y a deux règles : -- la connexion doit venir d'un frontend HTTP (2) ; +- la connexion doit provenir d'un frontend HTTP (2) ; - son URL doit commencer par les pages d'administration de WordPress (1). -Associée à ces règles, il y a une action : rediriger vers la version HTTPS de la page (3). +Il y a une action associée à ces règles : rediriger vers la version HTTPS de la page (3). -Il s'agit d'une action « finale ». C'est à dire que si les règles sont validées, l'évaluation des routes s'arrête et l'action est exécutée. +Il s'agit d'une action "finale". C'est à dire que si les règles sont validées, l'évaluation des routes s'arrête et l'action est exécutée. -## Présentation de l'API +### Présentation de l'API -La gestion des routes n'est accessible qu'au travers de l'[API OVH](/links/api). Elle est valide uniquement pour les protocoles `http`{.action} et `tcp`{.action}, le chemin `/ipLoadbalancing/{serviceName}/{protocole}/route/`{.action} expose l'API dédiée aux routes. +La gestion des routes n'est accessible qu'au travers de l'[API OVHcloud](/links/api). Elle n'est valable que pour les protocoles **http** et **tcp**, et le chemin `/ipLoadbalancing/{serviceName}/{protocol}/route/`{.action} expose l'API dédiée aux routes. -L'API des routes de votre service OVH Load Balancer a été pensée spécialement pour être souple, puissante et évolutive. Elle est organisée autour de trois sections principales : +L'API des routes de votre service OVHcloud Load Balancer a été pensée spécialement pour être souple, puissante et évolutive. Elle est organisée autour de trois sections principales : -1. les API listant les règles et actions disponibles. -2. les API listant les routes configurées sur votre service OVH Load Balancer. -3. les API de configuration des routes de votre service OVH Load Balancer. +1. Les appels API listant les règles et actions disponibles. +2. Les appels API listant les routes configurées sur votre service OVHcloud Load Balancer. +3. Les appels de configuration des routes de votre service OVHcloud Load Balancer. > [!primary] > -> Pour n'afficher que les API liées aux routes dans la console d'API OVH, vous pouvez utiliser le champ `filter`{.action} avec le mot clé route. -> +> Pour afficher uniquement les appels API liés aux routes dans la console de l'API OVHcloud, vous pouvez utiliser le champ `filter`{.action} avec le mot-clé "*[a-z]*". +> -Lorsque vous souhaitez configurer une route ou des règles, la première chose à faire est de consulter les actions et les règles disponibles. Cela vous donnera les valeurs possibles pour les champs des APIs de configuration des routes et des règles. +Lorsque vous souhaitez configurer une route ou des règles, la première chose à faire est de consulter les **actions et règles disponibles**. Cela vous donnera les valeurs possibles pour les champs de configuration de l'API des routes et des règles. -- Une route peut avoir plusieurs Règles. -- Une route peut être attachée à un et un seul Frontend. -- Un Frontend peut avoir plusieurs routes. Dans ce cas, l'ordre d'évaluation dépend de leur type et de leur poids. +- Une route peut avoir plusieurs règles. +- Une route ne peut être attachée qu'à un seul frontend. +- Un frontend peut avoir plusieurs routes. Dans ce cas, l'ordre d'évaluation dépend de son type et de son poids. -Quand une requête arrive sur votre service OVH Load Balancer, les routes sont évaluées successivement en suivant ces principes : +Quand une requête arrive sur votre service OVHcloud Load Balancer, les routes sont évaluées successivement selon les principes suivants : -1. d'abord les routes de type reject et rewrite puis enfin les routes de type farm ; -1. à l'intérieur de ces catégories, les routes sont évaluées par poids croissant ; -1. si deux routes ont le même poids, la première créée sera la première évaluée ; -1. seule la première action dont toutes les règles sont validées est exécutée. +1. D'abord, les **routes de type reject et rewrite**, puis les **routes de type farm** ; +2. À l'intérieur de ces catégories, les routes sont évaluées par **poids croissant** ; +3. Si deux routes ont le même poids, la **première route créée** est évaluée en premier ; +4. Seule la **première action** de toutes les règles validées est exécutée. ### Règles et actions disponibles -Cette première section de l'API contient une liste à jour des actions et règles disponibles pour votre service OVH Load Balancer. Elle contient un appel pour les actions et un autre pour les règles. Ces 2 appels retournent une liste d'objets. Chaque objet indique son nom et s'il s'applique aux routes TCP ou aux routes HTTP ainsi que les valeurs ou types de valeur attendues pour les différents champs de l'API. Si un champ est "null", cela signifie qu'aucune valeur n'est attendue. Si une valeur invalide est fournie, l'API retournera une erreur de validation. + +Cette première section de l'API contient une liste à jour des actions et règles disponibles pour votre service OVHcloud Load Balancer. Elle contient un appel pour les actions et un autre pour les règles. Ces deux appels retournent une liste d'objets. Chaque objet est nommé, et indique s'il s'applique aux routes TCP ou HTTP, ainsi que les valeurs ou types de valeurs attendus pour les différents champs de l'API. Si un champ est "null", cela signifie qu'aucune valeur n'est attendue. Si une valeur invalide est fournie, l'API retournera une erreur de validation. #### Actions > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteActions -> +> -Pour plus d'information sur cet appel, nous vous invitons à consulter la section [Actions disponibles](#actions-disponibles){.internal}, en bas de ce guide. +Pour plus d'information sur cet appel, nous vous invitons à consulter la section [Actions disponibles](#available-actions), en bas de ce guide. #### Règles > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteRules -> +> -Pour plus d'information sur cet appel, nous vous invitons à consulter la section [Règles disponibles](#regles-disponibles){.internal}, en bas de ce guide. +Pour plus d'information sur cet appel, nous vous invitons à consulter la section [Règles disponibles](#available-rules), en bas de ce guide. ### Routes configurées -Cette deuxième section de l'API ne contient qu'un seul appel. Il a principalement été pensé pour faciliter l'implémentation de mécanismes d'auto-complétion. Il retourne l'identifiant, le nom et le type de chaque route définie. Les détails d'une route peuvent être obtenus avec un appel GET /ipLoadbalancing/{serviceName}/route/{type}/{routeId} défini plus bas. + +Cette deuxième section de l'API ne contient qu'un seul appel. Il a principalement été pensé pour faciliter l'implémentation de mécanismes d'auto-complétion. Il retourne l'identifiant, le nom et le type de chaque route définie. Les détails d'une route peuvent être obtenus avec un appel `GET /ipLoadbalancing/{serviceName}/route/{type}/{routeId}` défini plus bas. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/definedRoutes -> +> -Pour plus d'information sur cet appel, nous vous invitons à consulter la section [Manipulation des routes](#manipulation-des-routes){.internal}, en bas de ce guide. +Pour plus d'information sur cet appel, nous vous invitons à consulter la section "[Manipulation des routes](#handling-routes)", en bas de ce guide. ### Configuration des routes -Avec ces principes de base que sont les actions et règles disponibles et l'ordre d'évaluation des routes, les routes peuvent être manipulées de la même manière que les Farms. Création d'une Route, sur laquelle il est possible d'attacher des Règles. Les valeurs possibles pour les règles et les actions étant définies par les appels d'API. -Pour plus d'informations sur ces méthodes, vous pouvez consulter la section [Manipulation des routes](#manipulation-des-routes){.internal}, en bas de ce guide. +Avec ces principes de base sur les actions et règles disponibles, et l'ordre d'évaluation des routes, ces routes peuvent être manipulées de la même manière que les fermes. Lorsque vous créez une route, vous pouvez y attacher des règles. Les valeurs possibles pour les règles et les actions sont définies par les appels API. + +Pour plus d'informations sur ces méthodes, vous pouvez consulter la section "[Manipulation des routes](#handling-routes)", en bas de ce guide. ## Exemples -Si vous n'êtes pas encore convaincu par la puissance des routes, cette section devrait vous convaincre pour de bon. Sans rentrer dans le détail des appels d'APIs, elle a pour vocation de présenter comment réaliser plusieurs cas d'utilisation inspirés de nos besoins internes chez OVH. -Vous trouverez le détail des appels d'API dans la section [Manipulation des routes](#manipulation-des-routes){.internal}, en bas de ce guide et les sections suivantes. +Afin de démontrer l'utilité des routes, cette section offrira quelques exemples pratiques de l'utilisation de cette technologie pour les besoins internes d'OVHcloud, sans entrer dans les détails des appels API. + +Vous trouverez le détail des appels API dans la section "[Manipulation des routes](#handling-routes)", en bas de ce guide et les sections suivantes. ### Forcer le HTTPS pour les pages de login WordPress -Le HTTPS est devenu la norme. L'objectif est de rendre tous les sites disponibles de manière sécurisée en HTTPS grâce au protocole SSL/TLS. Si vous avez besoin d'un certificat SSL/TLS, vous pouvez utiliser votre service OVH Load Balancer pour en commander un qui sera géré pour vous de manière complètement automatique. -Migrer un site en HTTPS demande du travail, notamment pour éviter les problèmes de "[Mixed-Content](https://developer.mozilla.org/en-us/docs/Web/Security/Mixed_content)". Il peut être intéressant de migrer section par section, en commençant par sécuriser les pages envoyant des identifiants. +Le protocole HTTPS est devenu la norme. Son objectif est de rendre tous les sites web disponibles en HTTPS de manière sécurisée, grâce au protocole SSL/TLS. Si vous avez besoin d'un certificat SSL/TLS, vous pouvez utiliser votre service OVHcloud Load Balancer pour en commander un nouveau, qui sera géré pour vous de manière complètement automatique. -Une approche pourrait être de se baser sur le début des URLs WordPress. Par défaut, l'URL des pages de connexion de WordPress commencent par "/wp-login". Nous aurions donc besoin : +Migrer un site web vers HTTPS demande du travail, notamment pour éviter les problèmes de [Mixed-Content](https://developer.mozilla.org/en-us/docs/Web/Security/Mixed_content). Il peut être intéressant de migrer votre site web section par section, en commençant par sécuriser les pages qui envoient des identifiants de connexion. -- d'une route avec une action de redirection ; -- d'un règle dans cette route qui détecte les URLs commençant par "/wp-login". +Une approche pourrait être de s'appuyer sur le début des URLs WordPress. Par défaut, l'URL des pages de connexion de WordPress commence par `/wp-login`. Nous aurions donc besoin des élements suivants : -Dans la pratique, cela donne une route : +- une route avec une **action de redirection** ; +- une règle dans cette route qui détecte les URLs commençant par **"/wp-login"**. -|Champ|Valeur et description| -|---|---| -|serviceName|Identifiant de votre service OVH Load Balancer| -|frontendId|Identifiant de votre Frontend HTTP| -|displayName|"Redirection des connexions WordPress vers HTTPS"| -|weight|(vide)| -|action.type|"redirect"| -|action.status|302 pour une redirection temporaire, 301 pour une redirection permanente| -|action.target|"`https://${host}${path}${arguments}`" pour reprendre le même host, chemin et arguments| +En pratique, cela donne une route comme suit : -Et sur cette route, on vient attacher une règle : +| Champ | Valeur et description | +| :--- | :--- | +| serviceName | Identifiant de votre service OVHcloud Load Balancer | +| frontendId | Identifiant de votre frontend HTTP | +| displayName | " Redirection des connexions WordPress vers HTTPS " | +| weight | (vide) | +| action.type | "redirect" | +| action.status | 302 pour une redirection temporaire, 301 pour une redirection permanente | +| action.target | "`https://\${host}\${path}\${arguments}`" pour prendre le même hôte, chemin et arguments | + +Sur cette route, nous allons attacher une règle : -|Champ|Valeur et description| -|---|---| -|serviceName|Identifiant de votre service OVH Load Balancer| -|routeId|Identifiant de la Route créée juste au dessus| -|field|"uri"| -|subField|(vide)| -|match|"startswith"| -|negate|false| -|pattern|"/wp-login"| +| Champ | Valeur et description | +| :--- | :--- | +| serviceName | Identifiant de votre service OVHcloud Load Balancer | +| routeId | Identifiant de la route créée ci-dessus | +| field | "uri" | +| subField | (vide) | +| match | "startswith" | +| negate | false | +| pattern | "/wp-login" | -Il ne reste qu'à appliquer la configuration dans la zone concernée et le tour est joué. +Ensuite, appliquez la configuration à la zone concernée. > [!warning] > -> Pour ajouter une nouvelle redirection, il faudra renouveler cette opération. Création d'une route, puis création d'une règle. Si une seconde règle est ajoutée sur la même route, les 2 devront être validées pour que la redirection fonctionne. Concrètement, si les règles sont "startswith /wp-login" et "startswith /wp-admin", la redirection ne fonctionnera jamais car il est impossible que ces 2 conditions soient vraies simultanément. -> +> Pour ajouter une nouvelle redirection, vous devrez répéter ces actions, en créant une route, puis une règle. Si une seconde règle est ajoutée à la même route, les deux règles doivent être validées pour que la redirection fonctionne. Notez que si les règles sont "startswith /wp-login" et "startswith /wp-admin", la redirection ne fonctionnera jamais car ces deux conditions ne peuvent pas être vraies simultanément. +> -### Router en fonction d'un domaine (VHost) -C'est la fonctionnalité qui a rendu possible l'essor du web quand il en était à ses balbutiements, avec la possibilité d'exposer plusieurs sites derrière une même adresse IP grâce au champ "Host" des En-Têtes HTTP. +### Route en fonction d'un domaine (VHost) -Par exemple, si votre infrastructure est composée d'un VPS par site Internet et d'un service OVH Load Balancer pour assurer la terminaison SSL/TLS et la redirection vers une page de maintenance avec un serveur de "backup" dans les Farms, il était auparavant nécessaire de disposer d'une Additional IP par site, routée vers votre service OVH Load Balancer et un Frontend par IP. +C'est la fonctionnalité qui a rendu possible l'essor du web quand il en était à ses balbutiements, avec la possibilité d'exposer plusieurs sites derrière une même adresse IP grâce au champ "Host" des en-têtes HTTP. -Avec les routes, il devient possible de mutualiser le même Frontend et choisir la Farm de serveurs dynamiquement en fonction du champ "Host". +Par exemple, si votre infrastructure est composée d'un VPS pour votre site web, d'un OVHcloud Load Balancer pour assurer la terminaison SSL/TLS, et de redirections vers une page de maintenance avec un serveur de secours dans les fermes, vous auriez autrefois eu besoin d'une Additional IP par site web, routée vers votre OVHcloud Load Balancer, et d'un frontend par IP. + +Avec les routes, vous pouvez partager le même frontend et choisir la ferme de serveurs dynamiquement, grâce au **champ "[a-z]*"**. Pour cela, vous aurez besoin : -- d'une Route par VHost ; -- d'une Règle par Route détectant un domaine spécifique. +- d'une route par VHost ; +- d'une règle par route détectant un domaine spécifique. -Dans la pratique, pour router le domaine www.example.com, cela donne une route : +En pratique, pour router le domaine **www.example.com**, cela donnera la route suivante : -|Champ|Valeur et description| -|---|---| -|serviceName|Identifiant de votre service OVH Load Balancer| -|frontendId|Identifiant de votre Frontend| -|displayName|"VHost - www.example.com"| -|weight|(vide)| -|action.type|"farm"| -|action.status|(vide)| -|action.target|Identifiant de la Farm vers laquelle diriger ce domaine| +| Champ | Valeur et description | +| :--- | :--- | +| serviceName | Identifiant de votre service OVHcloud Load Balancer | +| frontendId | Identifiant de votre frontend | +| displayName | "VHost - www.example.com" | +| weight | (vide) | +| action.type | "farm" | +| action.status | (vide) | +| action.target | Identifiant de la ferme vers laquelle diriger ce domaine | -Et sur cette route, on vient attacher une règle : +Et sur cette route, nous allons attacher une règle : -|Champ|Valeur et description| -|---|---| -|serviceName|Identifiant de votre service OVH Load Balancer| -|routeId|Identifiant de la Route créée juste au dessus| -|field|"host"| -|subField|(vide)| -|match|"is"| -|negate|false| -|pattern|"www.example.com" ou le domaine de votre choix| +| Champ | Valeur et description | +| :--- | :--- | +| serviceName | Identifiant de votre service OVHcloud Load Balancer | +| routeId | Identifiant de la route créée ci-dessus | +| field | "host" | +| subField | (vide) | +| match | "is" | +| negate | false | +| pattern | "www.example.com" ou un domaine de votre choix | -Il ne reste qu'à appliquer la configuration. +Enfin, appliquez la configuration. -### Réserver une Additional IP à un site en particulier -Si l'on reste sur le scénario de l'hébergement à base de VPS, on peut souhaiter dédier une adresse IP à un client donné. Rendre l'IP disponible se fait facilement en la routant vers votre service OVH Load Balancer puis en configurant un Frontend dédié attaché à cette adresse Additional IP et ayant comme defaultFarmId le VPS cible de ce client. +### Réserver une Additional IP à un site web particulier -Néanmoins, que se passe-t-il si un autre client détecte cela et configure son domaine pour pointer vers l'adresse IP du client premium ? Par défaut, cela fonctionnera et son site sera routé vers l'autre VPS. S'il y a un certificat SSL/TLS, cela fonctionnera quand même car l'ensemble des certificats sont automatiquement disponibles pour l'ensemble des Frontends. +Si vous hébergez un site web sur un VPS, vous pourriez vouloir dédier une adresse IP à un client donné. Vous pouvez facilement rendre l'IP disponible en la routant vers votre service OVHcloud Load Balancer, puis en configurant un frontend dédié attaché à cette Additional IP, et en définissant le VPS cible du client comme `defaultFarmId`. -Dans ce scénario, l'idée est d'ajouter une règle qui va rejeter les requêtes si le domaine n'est pas le domaine premium. Cela peut se faire simplement avec une route de rejet et une règle. +Néanmoins, que se passera-t-il si un autre client détecte cela et configure son domaine pour pointer vers l'IP du client premium ? Par défaut, cela fonctionnera, et son site web sera routé vers le VPS d'un autre client. Si un certificat SSL/TLS est présent, cela fonctionnera toujours, car tous les certificats sont automatiquement disponibles pour l'ensemble des frontends. -Dans la pratique, pour réserver un Frontend avec une IP dédiée au domaine www.example.com, cela donne une route : +Dans de tels scénarios, la solution est d'ajouter une règle qui **rejettera les requêtes si le domaine n'est pas un domaine premium**. Vous pouvez le faire avec une route de rejet et une règle. -|Champ|Valeur et description| -|---|---| -|serviceName|Identifiant de votre service OVH Load Balancer| -|frontendId|Identifiant de votre Frontend| -|displayName|"Restrict to www.example.com"| -|weight|(vide)| -|action.type|"reject"| -|action.status|403| -|action.target|(vide)| +En pratique, pour réserver un frontend avec une IP dédiée au domaine **www.example.com**, cela donnera la route suivante : -Et sur cette route, on vient attacher une règle : +| Champ | Valeur et description | +| :--- | :--- | +| serviceName | Identifiant de votre service OVHcloud Load Balancer | +| frontendId | Identifiant de votre frontend | +| displayName | "Restriction à www.example.com" | +| weight | (vide) | +| action.type | "reject" | +| action.status | 403 | +| action.target | (vide) | + +Et sur cette route, nous allons attacher une règle : + +| Champ | Valeur et description | +| :--- | :--- | +| serviceName | Identifiant de votre service OVHcloud Load Balancer | +| routeId | Identifiant de la route créée ci-dessus | +| field | "host" | +| subField | (vide) | +| match | "is" | +| negate | true | +| pattern | "www.example.com" ou un domaine de votre choix | -|Champ|Valeur et description| -|---|---| -|serviceName|Identifiant de votre service OVH Load Balancer| -|routeId|Identifiant de la Route créée juste au dessus| -|field|"host"| -|subField|(vide)| -|match|"is"| -|negate|true| -|pattern|"www.example.com" ou le domaine de votre choix| +Enfin, appliquez la configuration. -Il ne reste qu'à appliquer la configuration. +### Route en fonction d'une URL et d'une méthode HTTP -### Router en fonction d'une URL et d'une méthode HTTP -Sur certaines infrastructures spécifiques, il est nécessaire de router certaines requêtes vers une Farm spécifique. Par exemple, pour gérer des requêtes rares mais coûteuses sans impacter de la production telles que des requêtes analytiques que l'on ferait fonctionner sur un réplicat en lecture seul des données avec une machine avec plus de mémoire. +Sur certaines infrastructures spécifiques, certaines requêtes doivent être routées vers une ferme spécifique. Par exemple, pour gérer des requêtes rares mais gourmandes en données sans impacter la production, comme des requêtes analytiques qui travailleraient sur une copie en lecture seule des données avec un serveur disposant d'un volume de mémoire plus élevé. -Disons par exemple que la requête est envoyée : +Si, par exemple, la requête est envoyée : -- avec la méthode POST ; -- sur une URL correspondant à "^/.*/batch-analytics$" +- avec la méthode **POST** ; +- sur une URL correspondant à **"^/.*/batch-analytics$"**. -Pour cet exemple, vous aurez besoin d'une route avec 2 règles, l'une d'entre elles utilisant une expression régulière. +Alors, vous auriez besoin d'une route avec deux règles, dont une utilisant une expression régulière. -Dans la pratique, cela donne une route : +En pratique, cela donne une route comme suit : -|Champ|Valeur et description| -|---|---| -|serviceName|Identifiant de votre service OVH Load Balancer| -|frontendId|Identifiant de votre Frontend| -|displayName|"Route batch analytics to dedicated farm"| -|weight|(vide)| -|action.type|"farm"| -|action.status|(vide)| -|action.target|Identifiant de la Farm vers laquelle diriger ces opérations| +| Champ | Valeur et description | +| :--- | :--- | +| serviceName | Identifiant de votre service OVHcloud Load Balancer | +| frontendId | Identifiant de votre frontend | +| displayName | "Route les analyses par batch vers une ferme dédiée" | +| weight | (vide) | +| action.type | "farm" | +| action.status | (vide) | +| action.target | Identifiant de la ferme vers laquelle diriger ces opérations | -Et sur cette route, on vient attacher 2 règles : +Et sur cette route, nous allons attacher deux règles : -|Champ|Règle 1|Règle 2| -|---|---|---| -|serviceName|Identifiant de votre service OVH Load Balancer|idem| -|routeId|Identifiant de la Route créée juste au dessus|idem| -|field|"method"|"uri"| -|subField|(vide)|(vide)| -|match|"is"|"matches"| -|negate|false|false| -|pattern|"POST"|"^/.*/batch-analytics$"| +| Champ | Règle 1 | Règle 2 | +| :--- | :--- | :--- | +| serviceName | Identifiant de votre service OVHcloud Load Balancer | comme pour la règle 1 | +| routeId | Identifiant de la route créée ci-dessus | comme pour la règle 1 | +| field | "method" | "uri" | +| subField | (vide) | (vide) | +| match | "is" | "matches" | +| negate | false | false | +| pattern | "POST" | "`^/.*/batch-analytics$`" | -Ici, la première règle s'applique sur une énumération. Seules les méthodes HTTP standards sont disponibles. La deuxième règle au contraire exploite toute la puissance des routes en utilisant une expression régulière. Bien que ce soit possible d'utiliser de telles expressions, si vous pouvez vous en passer, les performances n'en seront que meilleures. +Ici, la première règle s'applique sur une énumération. Seules les méthodes HTTP standard sont disponibles. La deuxième règle exploite quant à elle toute la puissance des routes en utilisant une expression régulière. Bien que ce soit possible d'utiliser de telles expressions, si vous pouvez vous en passer, les performances n'en seront que meilleures. -Il ne reste qu'à appliquer la configuration dans la zone concernée. +Il ne reste plus qu'à appliquer la configuration dans la zone concernée. -### Router certaines IP et les clients volontaires vers la preproduction -Quand un site prend de l'ampleur, on peut souhaiter mettre en place un environnement de préproduction permettant de valider les évolutions en cours, sans impacter la majorité des utilisateurs. Généralement, lorsque l'on configure ce type environnement, on cherche à réduire autant que possible l'écart entre la production et la préproduction de manière à détecter les problèmes avec le plus de précision possible. Une source de problème classique et pourtant souvent négligée est le nom de domaine. Il est parfois codé "en dur" dans un fichier ou un article. À ce moment, un lien pourra fonctionner en préproduction mais pas en production. Oups... +#### Router certaines IP et les clients volontaires vers la preproduction -Au lieu de mettre en place des règles basées sur le nom de domaine, on pourrait mettre en place des règles basées sur l'adresse IP source (par exemple, un proxy d'entreprise) et, éventuellement un Cookie pour les clients volontaires. Ces configurations peuvent être détectées avec deux routes sur votre service OVH Load Balancer. +Quand un site prend de l'ampleur, on peut souhaiter mettre en place un environnement de préproduction permettant de valider les évolutions en cours, sans affecter la majorité des utilisateurs. Généralement, lorsque l'on configure ce type d'environnement, on cherche à réduire autant que possible l'écart entre la production et la préproduction, de manière à détecter les problèmes avec le plus de précision possible. Une source de problème classique et pourtant souvent négligée est le nom de domaine. Il est parfois codé " en dur " dans un fichier ou un article. À ce moment, un lien pourra fonctionner en préproduction mais pas en production. + +Au lieu de mettre en place des règles basées sur le nom de domaine, on pourrait mettre en place des règles basées sur l'adresse IP source (par exemple, un proxy d'entreprise) et éventuellement un cookie pour les clients volontaires. Ces configurations peuvent être détectées avec deux routes sur votre service OVHcloud Load Balancer. Pour cet exemple, on considérera : - que le proxy d'entreprise peut utiliser les adresses 42.42.42.0/24 et que le VPN utilise 1.2.3.4/32 ; -- que les utilisateurs volontaires ont un Cookie "PreprodOptIn", dont la valeur n'a pas d'importance. +- que les utilisateurs volontaires ont un cookie "PreprodOptIn", dont la valeur n'a pas d'importance. Dans la pratique, vous aurez besoin de deux routes identiques : -|Champ|Valeur et description| -|---|---| -|serviceName|Identifiant de votre service OVH Load Balancer| -|frontendId|Identifiant de votre Frontend| -|displayName|"Route Opt-In and internal users to preproduction environment"| -|weight|(vide)| -|action.type|"farm"| -|action.status|(vide)| -|action.target|Identifiant de la Farm de préproduction| +| Champ | Valeur et description | +| :--- | :--- | +| serviceName | Identifiant de votre service OVHcloud Load Balancer | +| frontendId | Identifiant de votre frontend | +| displayName | "Route Opt-In and internal users to preproduction environment" | +| weight | (vide) | +| action.type | "farm" | +| action.status | (vide) | +| action.target | Identifiant de la ferme de préproduction | Puis on vient attacher les 2 règles suivantes, chacune sur une des routes (1 règle par route) : -|Champ|Règle 1|Règle 2| -|---|---|---| -|serviceName|Identifiant de votre service OVH Load Balancer|idem| -|routeId|Identifiant de la 1ère Route|Identifiant de la 2ème Route| -|field|"source"|"cookie"| -|subField|(vide)|"PreprodOptIn"| -|match|"in"|"exists"| -|negate|false|false| -|pattern|"42.42.42.0/24, 1.2.3.4"|(vide)| +| Champ | Règle 1 | Règle 2 | +| :--- | :--- | :--- | +| serviceName | Identifiant de votre service OVHcloud Load Balancer | idem | +| routeId | Identifiant de la 1ère route | Identifiant de la 2ème route | +| field | "source" | "cookie" | +| subField | (vide) | "PreprodOptIn" | +| match | "in" | "exists" | +| negate | false | false | +| pattern | "42.42.42.0/24, 1.2.3.4" | (vide) | + +La première règle teste si l'IP source est dans une liste de plage d'adresses. Dans ce cas, les différentes plages d'adresses sont séparées par des virgules et peuvent être entourées d'espaces pour plus de lisibilité. Si une plage ne contient qu'une seule adresse, le "/32" est implicite mais peut être mis explicitement. Dans tous les cas, la taille de ce champ est limité à 255 caractères. -La première règle teste si l'IP source est dans une liste de plage d'adresse. Dans ce cas, les différentes plages d'adresses sont séparées par des virgules et peuvent être entourées d'espace pour plus de lisibilité. Si une plage ne contient qu'une seule adresse, le "/32" est implicite mais peut être mis explicitement. Dans tous les cas, la taille de ce champ est limité à 255 caractères. +La seconde règle teste simplement l'existence du cookie. Il serait possible de tester si sa valeur correspond à une expression régulière ou se trouve dans une liste de possibilités, mais cela permet de montrer un exemple simple de ce qui peut être fait avec des cookies. Les règles basées sur les En-Têtes HTTP fonctionnent suivant une approche similaire. -La seconde règle teste simplement l'existence du cookie. Il serait possible de tester si sa valeur correspond à une expression régulière ou se trouve dans une liste de possibilité, mais cela permet de montrer un exemple simple de ce qui peut être fait avec des cookies. Les règles basées sur les En-Têtes HTTP fonctionnent suivant une approche similaire. +Il ne reste plus qu'à appliquer la configuration dans la zone concernée. -Il ne reste qu'à appliquer la configuration dans la zone concernée. +#### Router les WebSockets vers une ferme dédiée -### Router les WebSockets vers une Ferme dédiée -Lorsqu'un site dispose de fonctions interactives basées sur des WebSockets telles qu'un chat-bot, on peut souhaiter diriger ces connexions vers une Farm de serveurs dédiée à cette tâche. Et c'est en fait très simple. Quand un navigateur cherche à ouvrir une connexion WebSockets, il envoie une requête HTTP standard avec les En-Têtes : +Lorsqu'un site dispose de fonctions interactives basées sur des WebSockets telles qu'un chat-bot, on peut souhaiter diriger ces connexions vers une ferme de serveurs dédiée à cette tâche. Et c'est en réalité très simple. + +Quand un navigateur cherche à ouvrir une connexion WebSockets, il envoie une requête HTTP standard avec les en-têtes : ``` Upgrade: websocket Connection: Upgrade ``` -Dans la pratique, il suffit de détecter le premier En-Tête. Cela peut se faire très facilement avec une route et une règle : +Dans la pratique, il suffit de détecter le premier en-tête. Cela peut se faire très facilement avec une route et une règle : -|Champ|Valeur et description| -|---|---| -|serviceName|Identifiant de votre service OVH Load Balancer| -|frontendId|Identifiant de votre Frontend| -|displayName|"Route WebSockets to a dedicated farm"| -|weight|(vide)| -|action.type|"farm"| -|action.status|(vide)| -|action.target|Identifiant de la Farm dédiée au WebSockets| +| Champ | Valeur et description | +| :--- | :--- | +| serviceName | Identifiant de votre service OVHcloud Load Balancer | +| frontendId | Identifiant de votre frontend | +| displayName | "Route WebSockets to a dedicated farm" | +| weight | (vide) | +| action.type | "farm" | +| action.status | (vide) | +| action.target | Identifiant de la ferme dédiée au WebSockets | Et sur cette route, on vient attacher une règle : -|Champ|Valeur et description| -|---|---| -|serviceName|Identifiant de votre service OVH Load Balancer| -|routeId|Identifiant de la Route créée juste au dessus| -|field|"header"| -|subField|"Upgrade"| -|match|"is"| -|negate|false| -|pattern|"websocket" (sensible aux majuscules / minuscules)| +| Champ | Valeur et description | +| :--- | :--- | +| serviceName | Identifiant de votre service OVHcloud Load Balancer | +| routeId | Identifiant de la route créée juste au dessus | +| field | "header" | +| subField | "Upgrade" | +| match | "is" | +| negate | false | +| pattern | "websocket" (sensible aux majuscules / minuscules) | + +Il ne reste plus qu'à appliquer la configuration dans la zone concernée. + +### Références -Il ne reste qu'à appliquer la configuration dans la zone concernée. +Vous trouverez ici le détail des appels d'API liés aux routes. Pour une vue plus générale des fonctionnalités des routes, nous vous invitons d'abord à consulter la section "[Présentation de l'API](#apipresentation)" un peu plus haut dans ce guide. -## Référence -Vous trouverez ici le détail des appels d'API liés aux routes. Pour une vue plus générale des fonctionnalités des routes, nous vous invitons d'abord à consulter la section [Présentation de l'API](#presentation-de-l-api){.internal} un peu plus haut dans ce guide. +#### Manipulation des routes -### Manipulation des routes Les routes TCP et HTTP se configurent de la même manière. Les routes étant plus puissantes en HTTP, cette section se concentre sur les routes et les règles HTTP. Le fonctionnement des routes TCP peut être extrapolé en remplaçant "http" par "tcp" dans les routes. Certains champs n'ayant de sens qu'en HTTP, ils ne sont pas disponibles en TCP. -#### Lister les routes -Cet appel retourne la liste des identifiants numériques des routes définies pour le protocole HTTP. Il est possible de filtrer cette liste par frontendId. Cet appel retourne les routes dans l'ordre dans lequel elles seront évaluées. L'ordre d'évaluation peut être en partie contrôlé avec le "poids" (weight) de la route. +##### **Lister les routes** + +Cet appel retourne la liste des identifiants numériques des routes définies pour le protocole HTTP. Il est possible de filtrer cette liste par `frontendId`. Cet appel retourne les routes dans l'ordre dans lequel elles seront évaluées. L'ordre d'évaluation peut être en partie contrôlé avec le "poids" (weight) de la route. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route -> +> -|Paramètre|Requis|Signification| -|---|---|---| -|serviceName|Requis|Identifiant de votre service Load Balancer| -|frontendId||Identifiant numérique d'un Frontend HTTP auquel les routes sont attachées| +| Paramètre | Requis | Signification | +| :--- | :--- | :--- | +| serviceName | Requis | Identifiant de votre service Load Balancer | +| frontendId | | Identifiant numérique d'un frontend HTTP auquel les routes sont attachées | -#### Créer une route -Cet appel permet de créer une route. Seule l'action est obligatoire. Une route peut être attachée et détachée d'un Frontend. Il est possible de créer jusqu'à 50 routes sur un service OVH Load Balancer. Cet appel retourne la route créée en cas de succès. Votre service OVH Load Balancer doit être re-déployé pour appliquer les changements. +##### **Créer une route** + +Cet appel permet de créer une route. Seule l'action est obligatoire. Une route peut être attachée et détachée d'un frontend. Il est possible de créer jusqu'à 50 routes sur un service OVHcloud Load Balancer. Cet appel retourne la route créée en cas de succès. Votre service OVHcloud Load Balancer doit être re-déployé pour appliquer les changements. > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route -> - -|Paramètre|Requis|Signification| -|---|---|---| -|serviceName|Requis|Identifiant de votre service Load Balancer| -|displayName||Nom d'affichage de votre route (255 caractères maximum)| -|frontendId||Identifiant numérique d'un Frontend HTTP auquel rattacher la route| -|weight||Priorité de la route, entre 1 (passe d'abord) et 255 (passe après les autres)| -|action.type|Requis|Nom du type d'action à exécuter si l'ensemble des règles associées à la route sont validées| -|action.status||Code d'état HTTP pour les actions `reject` et `redirect`| -|action.target||Identifiant numérique de la ferme cible pour les actions `farm`, ou modèle d'URL pour les actions `redirect`| +> + +| Paramètre | Requis | Signification | +| :--- | :--- | :--- | +| serviceName | Requis | Identifiant de votre service Load Balancer | +| displayName | | Nom d'affichage de votre route (255 caractères maximum) | +| frontendId | | Identifiant numérique d'un frontend HTTP auquel rattacher la route | +| weight | | Priorité de la route, entre 1 (passe d'abord) et 255 (passe après les autres) | +| action.type | Requis | Nom du type d'action à exécuter si l'ensemble des règles associées à la route sont validées | +| action.status | | Code d'état HTTP pour les actions `reject` et `redirect` | +| action.target | | Identifiant numérique de la ferme cible pour les actions `farm`, ou modèle d'URL pour les actions `redirect` | Les types d'actions possibles sont : -|action|Signification| -|---|---| -|redirect|Rediriger une requète vers `action.target` avec le code d'état HTTP `action.status`| -|reject|Rejeter une requête avec le code d'état HTTP `action.status`| -|farm|Router une requête vers la ferme dont l'identifiant est renseigné dans `action.target`| +| action | Signification | +| :--- | :--- | +| redirect | Rediriger une requête vers `action.target` avec le code d'état HTTP `action.status` | +| reject | Rejeter une requête avec le code d'état HTTP `action.status` | +| farm | Router une requête vers la ferme dont l'identifiant est renseigné dans `action.target` | -Pour plus d'information sur les actions gérées ainsi que le format des paramètres, nous vous invitons à consulter la section [Actions disponibles](#actions-disponibles){.internal} plus bas dans ce guide. +Pour plus d'informations sur les actions gérées ainsi que le format des paramètres, nous vous invitons à consulter la section "[Actions disponibles](#available-actions)" plus bas dans ce guide. + +##### **Voir le détail d'une route** -#### Voir le détail d'une route Cet appel permet de consulter le détail d'une route HTTP, connaissant son identifiant. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId} -> +> -Requête +- Requête : -|Paramètre|Signification| -|---|---| -|serviceName|Identifiant de votre service Load Balancer| -|routeId|Identifiant numérique de la route| +| Paramètre | Signification | +| :--- | :--- | +| serviceName | Identifiant de votre service Load Balancer | +| routeId | Identifiant numérique de la route | -Réponse +- Réponse : -|Paramètre|Signification| -|---|---| -|routeId|Identifiant numérique de la route| -|displayName|Nom d'affichage de votre route| -|frontendId|Identifiant numérique du frontend auquel votre route est rattachée| -|weight|Priorité de votre route| -|action.type|Nom du type d'action de votre route| -|action.status|Code d'état HTTP associé| -|action.target|Identifiant numérique de la ferme ou modèle d'URL associé| -|rules|Liste des règles devant être validées pour déclencher l'action de la route. Plus de détails sont disponibles dans la section [Manipulation des Règles](#manipulation-des-regles){.internal}.| +| Paramètre | Signification | +| :--- | :--- | +| routeId | Identifiant numérique de la route | +| displayName | Nom d'affichage de votre route | +| frontendId | Identifiant numérique du frontend auquel votre route est rattachée | +| weight | Priorité de votre route | +| action.type | Nom du type d'action de votre route | +| action.status | Code d'état HTTP associé | +| action.target | Identifiant numérique de la ferme ou modèle d'URL associé | +| rules | Liste des règles devant être validées pour déclencher l'action de la route. Plus de détails sont disponibles dans la section "[Manipulation des Règles](#handling-rules)". | -Pour plus d'information sur les actions gérées ainsi que le format des paramètres, nous vous invitons à consulter la section [Actions disponibles](#actions-disponibles){.internal} plus bas dans ce guide. +Pour plus d'informations sur les actions gérées ainsi que le format des paramètres, nous vous invitons à consulter la section "[Actions disponibles](#available-actions)" plus bas dans ce guide. -#### Modifier une route -Cet appel permet de modifier une route HTTP, connaissant son identifiant. Votre service OVH Load Balancer doit être re-déployé pour appliquer les changements. +##### **Modifier une route** + +Cet appel permet de modifier une route HTTP, connaissant son identifiant. Votre service OVHcloud Load Balancer doit être re-déployé pour appliquer les changements. > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId} > -|Paramètre|Requis|Signification| -|---|---|---| -|serviceName|Requis|Identifiant de votre service Load Balancer| -|routeId|Requis|Identifiant numérique de la route| -|displayName||Nom d'affichage de votre route (255 caractères maximum)| -|frontendId||Identifiant numérique d'un Frontend HTTP auquel rattacher la route| -|weight||Priorité de la route, entre 1 (passe d'abord) et 255 (passe après les autres)| -|action.type|Requis|Nom du type d'action à exécuter si l'ensemble des règles associées à la route sont validées| -|action.status||Code d'état HTTP pour les actions `reject` et `redirect`| -|action.target||Identifiant numérique de la ferme cible pour les actions `farm`, ou modèle d'URL pour les actions `redirect`| +| Paramètre | Requis | Signification | +| :--- | :--- | :--- | +| serviceName | Requis | Identifiant de votre service Load Balancer | +| routeId | Requis | Identifiant numérique de la route | +| displayName | | Nom d'affichage de votre route (255 caractères maximum) | +| frontendId | | Identifiant numérique d'un frontend HTTP auquel rattacher la route | +| weight | | Priorité de la route, entre 1 (passe d'abord) et 255 (passe après les autres) | +| action.type | Requis | Nom du type d'action à exécuter si l'ensemble des règles associées à la route sont validées | +| action.status | | Code d'état HTTP pour les actions `reject` et `redirect` | +| action.target | | Identifiant numérique de la ferme cible pour les actions `farm`, ou modèle d'URL pour les actions `redirect` | + +Pour plus d'informations sur les actions gérées ainsi que le format des paramètres, nous vous invitons à consulter la section "[Actions disponibles](#available-actions)" plus bas dans ce guide. -Pour plus d'information sur les actions gérées ainsi que le format des paramètres, nous vous invitons à consulter la section [Actions disponibles](#actions-disponibles){.internal} plus bas dans ce guide. +##### **Supprimer une route** -#### Supprimer une route -Cet appel permet de supprimer une route HTTP, connaissant son identifiant. Lorsqu'une route est supprimée, l'ensemble des règles associées à cette route sont supprimées également. Il n'est pas nécessaire de les supprimer individuellement. Votre service OVH Load Balancer doit être re-déployé pour appliquer les changements. +Cet appel permet de supprimer une route HTTP, connaissant son identifiant. Lorsqu'une route est supprimée, l'ensemble des règles associées à cette route sont supprimées également. Il n'est pas nécessaire de les supprimer individuellement. Votre service OVHcloud Load Balancer doit être re-déployé pour appliquer les changements. > [!api] > > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId} -> +> -|Paramètre|Requis|Signification| -|---|---|---| -|serviceName|Requis|Identifiant de votre service Load Balancer| -|routeId|Requis|Identifiant numérique de la route| +| Paramètre | Requis | Signification | +| :--- | :--- | :--- | +| serviceName | Requis | Identifiant de votre service Load Balancer | +| routeId | Requis | Identifiant numérique de la route | -### Manipulation des Règles +#### Manipulation des règles -#### Lister les règles -Cet appel retourne la liste des identifiants numérique des règles définies pour une route donnée. +##### **Lister les règles** + +Cet appel retourne la liste des identifiants numériques des règles définies pour une route donnée. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule -> +> -|Paramètre|Requis|Signification| -|---|---|---| -|serviceName|Requis|Identifiant de votre service Load Balancer| -|routeId|Requis|Identifiant numérique de la route| +| Paramètre | Requis | Signification | +| :--- | :--- | :--- | +| serviceName | Requis | Identifiant de votre service Load Balancer | +| routeId | Requis | Identifiant numérique de la route | -#### Attacher une règle -Cet appel permet d'attacher une règle à une route. Il est possible d'attacher jusqu'à 5 règles par route sur un service OVH Load Balancer. Cet appel retourne la règle créée en cas de succès. Votre service OVH Load Balancer doit être re-déployé pour appliquer les changements. +##### **Attacher une règle** + +Cet appel permet d'attacher une règle à une route. Il est possible d'attacher jusqu'à 5 règles par route sur un service OVHcloud Load Balancer. Cet appel retourne la règle créée en cas de succès. Votre service OVHcloud Load Balancer doit être re-déployé pour appliquer les changements. > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule -> - -|Paramètre|Requis|Signification| -|---|---|---| -|serviceName|Requis|Identifiant de votre service Load Balancer| -|routeId|Requis|Identifiant numérique de la route| -|field|Requis|Nom du paramèter HTTP sur lequel appliquer cette règle| -|subField||Nom de l'en-tête HTTP pour les règles `header` ou nom du cookie pour les règles `cookie`| -|match|Requis|Nom du comparateur à appliquer pour valider la règle| -|negate||Inverse le résultat du comparateur| -|pattern||Argument du comparateur| - -`field` - -|Valeur|Signification| -|---|---| -|source|Adresse ou liste d'adresses source sous la forme d'IP (a.b.c.d/z)| -|protocol|Protocole. "http" ou "https"| -|method|Méthode HTTP (GET, HEAD, POST, PUT, DELETE, OPTIONS, CONNECT, TRACE)| -|host|Nom de domaine (vhost), sans le numéro de port| -|uri|Chamin de la requête tel que compris entre le premier "/" et le premier "?"| -|param|Paramètre HTTP venant de la partie après le premeir "?"| -|header|En-tête HTTP| -|cookie|Cookie HTTP| - -`match` - -|Valeur|Signification| -|---|---| -|exists|La propriété doit exister (en-tête ou cookie HTTP par exemple)| -|is|La propriété doit correspondre exactement à `pattern`| -|in|La propriété doit être dans la liste de valeurs (séparées par des virgules) définie par `parttern`| -|contains|La propriété doit contenir la valeur de `pattern`| -|startswith|La propriété doit commencer par la valeur de `pattern`| -|endswith|La propriété doit se terminer par la valeur de `pattern`| -|matches|La propriété doit correspondre à l'expression régulière de `pattern`| - -Pour plus d'information sur les règles gérées ainsi que le format des paramètres, nous vous invitons à consulter la section [Règles disponibles](#regles-disponibles){.internal} plus bas dans ce guide. - -#### Voir le détail d'une règle +> + +| Paramètre | Requis | Signification | +| :--- | :--- | :--- | +| serviceName | Requis | Identifiant de votre service Load Balancer | +| routeId | Requis | Identifiant numérique de la route | +| field | Requis | Nom du paramètre HTTP sur lequel appliquer cette règle | +| subField | | Nom de l'en-tête HTTP pour les règles `header` ou nom du cookie pour les règles `cookie` | +| match | Requis | Nom du comparateur à appliquer pour valider la règle | +| negate | | Inverse le résultat du comparateur | +| pattern | | Argument du comparateur | + +- `field` + +| Valeur | Signification | +| :--- | :--- | +| source | Adresse ou liste d'adresses source sous la forme d'IP (a.b.c.d/z) | +| protocol | Protocole. "http" ou "https" | +| method | Méthode HTTP (GET, HEAD, POST, PUT, DELETE, OPTIONS, CONNECT, TRACE) | +| host | Nom de domaine (vhost), sans le numéro de port | +| uri | Chemin de la requête tel que compris entre le premier "/" et le premier "?" | +| param | Paramètre HTTP venant de la partie après le premier "?" | +| header | En-tête HTTP | +| cookie | Cookie HTTP | + +- `match` + +| Valeur | Signification | +| :--- | :--- | +| exists | La propriété doit exister (en-tête ou cookie HTTP par exemple) | +| is | La propriété doit correspondre exactement à `pattern` | +| in | La propriété doit être dans la liste de valeurs (séparées par des virgules) définie par `pattern` | +| contains | La propriété doit contenir la valeur de `pattern` | +| startswith | La propriété doit commencer par la valeur de `pattern` | +| endswith | La propriété doit se terminer par la valeur de `pattern` | +| matches | La propriété doit correspondre à l'expression régulière de `pattern` | + +Pour plus d'informations sur les règles gérées ainsi que le format des paramètres, nous vous invitons à consulter la section "[Règles disponibles](#available-rules)" plus bas dans ce guide. + +##### **Voir le détail d'une règle** + Cet appel permet de consulter le détail d'une règle attachée à une route HTTP, connaissant son identifiant. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId} -> +> + +- Requête : -Requête +| Paramètre | Signification | +| :--- | :--- | +| serviceName | Identifiant de votre service Load Balancer | +| routeId | Identifiant numérique de la route | +| ruleId | Identifiant numérique de la règle | -|Paramètre|Signification| -|---|---| -|serviceName|Identifiant de votre service Load Balancer| -|routeId|Identifiant numérique de la route| -|ruleId|Identifiant numérique de la règle| +- Réponse : -Réponse +| Paramètre | Signification | +| :--- | :--- | +| ruleId | Identifiant numérique de la règle | +| field | Nom du paramètre HTTP sur lequel appliquer la règle | +| subField | Nom de l'en-tête HTTP ou du cookie pour la règle | +| match | Nom du comparateur à appliquer pour valider la règle | +| negate | "true" si le résultat du comparateur est inversé | +| pattern | Argument du comparateur. Le sens et la syntaxe dépendent de `match` et de `field` | -|Paramètre|Signification| -|---|---| -|ruleId|Identifiant numérique de la règle| -|field|Nom du paramèter HTTP sur lequel appliquer la règle| -|subField|Nom de l'en-tête HTTP ou du cookie pour la règle| -|match|Nom du comparateur à appliquer pour valider la règle| -|negate|"true" si le résultat du comparateur est inversé| -|pattern|Argument du comparateur. Le sens et la syntaxe dépendent de `match` et de `field`| +Pour plus d'informations sur les règles gérées ainsi que le format des paramètres, nous vous invitons à consulter la section "[Règles disponibles](#available-rules)" plus bas dans ce guide. -Pour plus d'information sur les règles gérées ainsi que le format des paramètres, nous vous invitons à consulter la section [Règles disponibles](#regles-disponibles){.internal} plus bas dans ce guide. +##### **Modifier une règle** -#### Modifier une règle -Cet appel permet de modifier une règle attachée à une route HTTP, connaissant son identifiant. Votre service OVH Load Balancer doit être re-déployé pour appliquer les changements. +Cet appel permet de modifier une règle attachée à une route HTTP, connaissant son identifiant. Votre service OVHcloud Load Balancer doit être re-déployé pour appliquer les changements. > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId} -> +> -|Paramètre|Requis|Signification| -|---|---|---| -|serviceName|Requis|Identifiant de votre service Load Balancer| -|routeId|Requis|Identifiant numérique de la route| -|ruleId|Requis|Identifiant numérique de la règle| -|field|Requis|Nom du paramèter HTTP sur lequel appliquer cette règle| -|subField||Nom de l'en-tête HTTP pour les règles `header` ou nom du cookie pour les règles `cookie`| -|match|Requis|Nom du comparateur à appliquer pour valider la règle| -|negate||Inverse le résultat du comparateur| -|pattern||Argument du comparateur| +| Paramètre | Requis | Signification | +| :--- | :--- | :--- | +| serviceName | Requis | Identifiant de votre service Load Balancer | +| routeId | Requis | Identifiant numérique de la route | +| ruleId | Requis | Identifiant numérique de la règle | +| field | Requis | Nom du paramètre HTTP sur lequel appliquer cette règle | +| subField | | Nom de l'en-tête HTTP pour les règles `header` ou nom du cookie pour les règles `cookie` | +| match | Requis | Nom du comparateur à appliquer pour valider la règle | +| negate | | Inverse le résultat du comparateur | +| pattern | | Argument du comparateur | -Pour plus d'information sur les règles gérées ainsi que le format des paramètres, nous vous invitons à consulter la section [Règles disponibles](#regles-disponibles){.internal} plus bas dans ce guide. +Pour plus d'informations sur les règles gérées ainsi que le format des paramètres, nous vous invitons à consulter la section "[Règles disponibles](#available-rules)" plus bas dans ce guide. -#### Supprimer une règle -Cet appel permet de supprimer une règle attachée à une route HTTP, connaissant son identifiant. Votre service OVH Load Balancer doit être re-déployé pour appliquer les changements. +##### **Supprimer une règle** + +Cet appel permet de supprimer une règle attachée à une route HTTP, connaissant son identifiant. Votre service OVHcloud Load Balancer doit être re-déployé pour appliquer les changements. > [!api] > > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId} -> +> -|Paramètre|Requis|Signification| -|---|---|---| -|serviceName|Requis|Identifiant de votre service Load Balancer| -|routeId|Requis|Identifiant numérique de la route| -|ruleId|Requis|Identifiant numérique de la règle| +| Paramètre | Requis | Signification | +| :--- | :--- | :--- | +| serviceName | Requis | Identifiant de votre service Load Balancer | +| routeId | Requis | Identifiant numérique de la route | +| ruleId | Requis | Identifiant numérique de la règle | > [!primary] > > Si vous souhaitez supprimer une route, il n'est pas nécessaire de supprimer l'ensemble des règles attachées à celle-ci. Les règles sont automatiquement supprimées lorsque vous supprimez une route. -> +> + +##### **Lister l'ensemble des routes TCP et HTTP** -#### Lister l'ensemble des routes TCP et HTTP -Cet appel permet de lister l'ensemble des identifiants, nom d'affichage et type ("http"/"tcp") des routes définies sur un service OVH Load Balancer. Il a été pensé pour simplifier l'implémentation d'auto-complétion. +Cet appel permet de lister l'ensemble des identifiants, noms d'affichage et types ("http"/"tcp") des routes définies sur un service OVHcloud Load Balancer. Il a été pensé pour simplifier l'implémentation d'auto-complétion. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/definedRoutes -> +> -Requête +- Requête : -|Paramètre|Signification| -|---|---| -|serviceName|Idenfiant de votre service Load Balancer| +| Paramètre | Signification | +| :--- | :--- | +| serviceName | Identifiant de votre service Load Balancer | -Réponse +- Réponse : -|Paramètre|Signification| -|---|---| -|type|Type de protocole de la route: "tcp" pour les routes TCP, "http" pour les routes HTTP| -|routeId|Identifiant numérique de la route| -|displayName|Nom d'affichage de la route| +| Paramètre | Signification | +| :--- | :--- | +| type | Type de protocole de la route: "tcp" pour les routes TCP, "http" pour les routes HTTP | +| routeId | Identifiant numérique de la route | +| displayName | Nom d'affichage de la route | + +#### Actions disponibles -### Actions disponibles Cet appel retourne la liste des actions disponibles pour les routes TCP et HTTP ainsi que les valeurs attendues pour chacun des champs. Si un champ est "null", cela signifie qu'aucune valeur n'est attendue. Si une valeur invalide est fournie, l'API retournera une erreur de validation. -L'ensemble des actions gérées par le service OVH Load Balancer sont finales. C'est à dire que l’exécution d'une action entraîne également la fin de l'évaluation des routes. +L'ensemble des actions gérées par le service OVHcloud Load Balancer sont finales. C'est à dire que l’exécution d'une action entraîne également la fin de l'évaluation des routes. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteActions -> +> -Requête +- Requête : -|Paramètre|Signification| -|---|---| -|serviceName|Idenfiant de votre service Load Balancer| +| Paramètre | Signification | +| :--- | :--- | +| serviceName | Identifiant de votre service Load Balancer | -Réponse +- Réponse : -|Paramètre|Signification| -|---|---| -|type|Indique si cette action est valide pour une route HTTP ou une route TCP| -|name|Nom de l'action à renseigner dans le champs `type` des routes| -|status|Liste des codes d'état HTTP disponibles pour cette action (champs `status` des routes)| -|destination|Type de valeur attendue dans le champs `destination` des routes| +| Paramètre | Signification | +| :--- | :--- | +| type | Indique si cette action est valide pour une route HTTP ou une route TCP | +| name | Nom de l'action à renseigner dans le champ `type` des routes | +| status | Liste des codes d'état HTTP disponibles pour cette action (champ `status` des routes) | +| destination | Type de valeur attendue dans le champ `destination` des routes | -#### Redirection -Cette action renvoie une redirection au visiteur. Le type de redirection peut être configuré avec le champ status. Lorsque cette action est sélectionnée, aucune Farm ne recevra la requête. +##### **Redirection** -|Paramètre|Valeur| -|---|---| -|type|`redirect`| -|status|301, 302, 303, 307 ou 308| -|target|URL de destination (peut contenir des variables)| +Cette action renvoie une redirection au visiteur. Le type de redirection peut être configuré avec le champ `status`. Lorsque cette action est sélectionnée, aucune ferme ne recevra la requête. -Seuls les codes d'état HTTP de redirection peuvent être spécifiés. Les plus courant sont les codes 301 et 302. Si vous hésitez, vous pouvez prendre le 302 "Redirection temporaire". Les codes d'état HTTP reconnus pour les redirections sont : +| Paramètre | Valeur | +| :--- | :--- | +| type | `redirect` | +| status | 301, 302, 303, 307 ou 308 | +| target | URL de destination (peut contenir des variables) | -|Code de status|Description| -|---|---| -|301|Redirection permanente. La redirection peut être enregistrée par le navigateur.| -|302 (default)|Redirection temporaire. La redirection doit être revalidée à chaque requête par le navigateur.| -|303|Comme le 302 et force l'utilisation de la méthode HTTP GET.| -|307|Comme le 302 et force le ré-utilisation de la même méthode HTTP (GET, POST, ...).| -|308|Comme le 301 et force le ré-utilisation de la même méthode HTTP (GET, POST, ...).| +Seuls les codes d'état HTTP de redirection peuvent être spécifiés. Les plus courants sont les codes 301 et 302. Si vous hésitez, vous pouvez prendre le 302 "Redirection temporaire". Les codes d'état HTTP reconnus pour les redirections sont : + +| Code de status | Description | +| :--- | :--- | +| 301 | Redirection permanente. La redirection peut être enregistrée par le navigateur. | +| 302 (default) | Redirection temporaire. La redirection doit être revalidée à chaque requête par le navigateur. | +| 303 | Comme le 302 et force l'utilisation de la méthode HTTP GET. | +| 307 | Comme le 302 et force la ré-utilisation de la même méthode HTTP (GET, POST, etc.). | +| 308 | Comme le 301 et force la ré-utilisation de la même méthode HTTP (GET, POST, etc.). | L'URL de destination peut contenir des variables simples. Cela permet de rediriger simplement vers un autre domaine, un autre protocole ou ajouter un suffixe / préfixe à une URL. Les variables reconnues sont : -|Variable|Description| -|---|---| -|`protocol`|Protocole de la requête ("http" ou "https")| -|`domain`|Nom de domaine de la requête, sans le numéro de port| -|`host`|Champ "Host" de la requête, incluant le numéro de port s'il y en a un| -|`port`|Port de la requête| -|`path`|Chemin de la requête, commence par un '/' et fini avant le premier '?'| -|`arguments`|Arguments de la requête, commence par le '?' si présent| +| Variable | Description | +| :--- | :--- | +| `protocol` | Protocole de la requête ("http" ou "https") | +| `domain` | Nom de domaine de la requête, sans le numéro de port | +| `host` | Champ "Host" de la requête, incluant le numéro de port s'il y en a un | +| `port` | Port de la requête | +| `path` | Chemin de la requête, commence par un '/' et finit avant le premier '?' | +| `arguments` | Arguments de la requête, commence par le '?' si présent | Par exemple, pour : -- rediriger vers https : `https://${host}${path}${arguments}` -- rediriger vers un nouveau domaine : ${protocol}://new.example.com${path}${arguments} -- préfixer l'url: ${protocol}://${host}/staging${path}${arguments} +- rediriger vers https : `https://\${host}\${path}\${arguments}` +- rediriger vers un nouveau domaine : `${protocol}://new.example.com\${path}\${arguments}` +- préfixer l'url: `${protocol}://\${host}/staging\${path}\${arguments}` + +##### **Rejet** -#### Rejet -Cette action renvoie un code d'état HTTP d'erreur au visiteur. Le code d'erreur HTTP peut être configuré avec le champ status. Lorsque cette action est sélectionnée, aucune Farm ne recevra la requête. +Cette action renvoie un code d'état HTTP d'erreur au visiteur. Le code d'erreur HTTP peut être configuré avec le champ `status`. Lorsque cette action est sélectionnée, aucune ferme ne recevra la requête. -|Paramètre|Valeur| -|---|---| -|type|`reject`| -|status|200, 400, 403, 405, 408, 429, 500, 502, 503 ou 504| -|target|non disponible| +| Paramètre | Valeur | +| :--- | :--- | +| type | `reject` | +| status | 200, 400, 403, 405, 408, 429, 500, 502, 503 ou 504 | +| target | non disponible | > [!primary] > -> Cette action est aussi disponible en TCP. Dans ce cas, le paramètre status n'est pas disponible et la requête est terminée. Les requêtes TCP terminées de cette manière ne sont pas comptabilisées dans de débit de requêtes. -> - -Seuls les codes d'erreur HTTP listés dans l'API peuvent être spécifiés. Les plus courant sont les codes 400 "Bad request" et 403 "Forbidden". 200 peut être utilisé pour bloquer un type de requête tout en simulant un succès et 503 peut être utilisé pour simuler une panne serveur. - -|Code de status|Description| -|---|---| -|200|La requête a été exécutée avec succès.| -|400|Requête invalide.| -|403 (default)|Accès interdit.| -|405|Méthode (GET, POST, PUT, ...) invalide ou non gérée.| -|408|La requête a pris trop de temps à être envoyée par le client.| -|429|La client a envoyé trop de requêtes (rate-limiting).| -|500|Erreur serveur générique.| -|502|Erreur de communication avec le serveur.| -|503|Le service est temporairement indisponible.| -|504|Le serveur a mis trop de temps à répondre.| - -#### Routage -Cette action dirige les requêtes vers une Farm spécifique, autre que la Ferme par défaut configurée sur le Frontend. La Ferme de destination doit être du même type que le Frontend ("http" ou "tcp"). - -|Paramètre|Valeur| -|---|---| -|type|`farm`| -|status|non disponible| -|target|Identifiant numérique de la Ferme de destination. Celle-ci doit être du même type| +> Cette action est aussi disponible en TCP. Dans ce cas, le paramètre `status` n'est pas disponible et la requête est terminée. Les requêtes TCP terminées de cette manière ne sont pas comptabilisées dans le débit de requêtes. +> + +Seuls les codes d'erreur HTTP listés dans l'API peuvent être spécifiés. Les plus courants sont les codes 400 "Bad request" et 403 "Forbidden". 200 peut être utilisé pour bloquer un type de requête tout en simulant un succès et 503 peut être utilisé pour simuler une panne serveur. + +| Code de status | Description | +| :--- | :--- | +| 200 | La requête a été exécutée avec succès. | +| 400 | Requête invalide. | +| 403 (default) | Accès interdit. | +| 405 | Méthode (GET, POST, PUT, etc.) invalide ou non gérée. | +| 408 | La requête a pris trop de temps à être envoyée par le client. | +| 429 | Le client a envoyé trop de requêtes (rate-limiting). | +| 500 | Erreur serveur générique. | +| 502 | Erreur de communication avec le serveur. | +| 503 | Le service est temporairement indisponible. | +| 504 | Le serveur a mis trop de temps à répondre. | + +##### **Routage** + +Cette action dirige les requêtes vers une ferme spécifique, autre que la ferme par défaut configurée sur le frontend. La ferme de destination doit être du même type que le frontend ("http" ou "tcp"). + +| Paramètre | Valeur | +| :--- | :--- | +| type | `farm` | +| status | non disponible | +| target | Identifiant numérique de la ferme de destination. Celle-ci doit être du même type | > [!primary] > -> Cette action est aussi disponible en TCP. Dans ce cas, la Farm de destination doit être de type "tcp". -> +> Cette action est aussi disponible en TCP. Dans ce cas, la ferme de destination doit être de type "tcp". +> + +#### Règles disponibles -### Règles disponibles Cet appel retourne la liste des règles disponibles pour les routes TCP et HTTP ainsi que les valeurs attendues pour chacun des champs. Si un champ est "null", cela signifie qu'aucune valeur n'est attendue. Si une valeur invalide est fournie, l'API retournera une erreur de validation. @@ -708,126 +740,138 @@ Si un champ est "null", cela signifie qu'aucune valeur n'est attendue. Si une va > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteRules -> +> -Requête +- Requête : -|Paramètre|Signification| -|---|---| -|serviceName|Identifiant de votre service Load Balancer| +| Paramètre | Signification | +| :--- | :--- | +| serviceName | Identifiant de votre service Load Balancer | -Réponse +- Réponse : -|Paramètre|Signification| -|---|---| -|type|Type de protocole de la route: "tcp" pour les routes TCP, "http" pour les routes HTTP| -|name|Nom de la propriété sur laquelle s'applique cette règle, à renseigner dans le champs `field`| -|hasSubField|"true" si cette propriété à une "sous propriété" (par exemple : un en-tête ou un cookie)| -|matches|Liste des comparateurs disponibles pour cette règle, à renseigner dans le champs `match`| -|pattern|Tupe de valeur attendue pour le champs `pattern`| -|enum|Liste des valeurs possibles pour le chmaps `pattern` si celui-ci est une énumération| +| Paramètre | Signification | +| :--- | :--- | +| type | Type de protocole de la route: "tcp" pour les routes TCP, "http" pour les routes HTTP | +| name | Nom de la propriété sur laquelle s'applique cette règle, à renseigner dans le champ `field` | +| hasSubField | "true" si cette propriété a une "sous propriété" (par exemple : un en-tête ou un cookie) | +| matches | Liste des comparateurs disponibles pour cette règle, à renseigner dans le champ `match` | +| pattern | Type de valeur attendue pour le champ `pattern` | +| enum | Liste des valeurs possibles pour le champ `pattern` si celui-ci est une énumération | Les différents types de `pattern` sont : -|Valeur|Signification| -|---|---| -|cidr|Adresse IP (a.b.c.d) ou sous-réseau (a.b.c.d/z)| -|string|Texte libre. Pour l'opérateur `in`, liste de valeurs séparées par des virgules (255 caractères maximum)| -|enum|Le champs est une énumération définie dans `enum`| +| Valeur | Signification | +| :--- | :--- | +| cidr | Adresse IP (a.b.c.d) ou sous-réseau (a.b.c.d/z) | +| string | Texte libre. Pour l'opérateur `in`, liste de valeurs séparées par des virgules (255 caractères maximum) | +| enum | Le champ est une énumération définie dans `enum` | + +##### **Protocole** -#### Protocole -Cette règle permet de filtrer les requêtes en fonction de leur protocole. Dans la pratique, les cas d'usage de cette règle sont assez limités car le protocole dépend du Frontend auquel la Route est attachée or un Frontend ne gère qu'un seul protocole qui est alors connu au moment de la définition de la route. +Cette règle permet de filtrer les requêtes en fonction de leur protocole. Dans la pratique, les cas d'usage de cette règle sont assez limités car le protocole dépend du frontend auquel la route est attachée or un frontend ne gère qu'un seul protocole qui est alors connu au moment de la définition de la route. -|Champs|Valeur| -|---|---| -|name|`protocol`| -|hasSubField|non| -|matches|`is` ou `in`| -|pattern|`tcp`, `tls`, `http` ou `https`| +| Champ | Valeur | +| :--- | :--- | +| name | `protocol` | +| hasSubField | non | +| matches | `is` ou `in` | +| pattern | `tcp`, `tls`, `http` ou `https` | > [!primary] > -> Cette action est aussi disponible en TCP. Dans ce cas, le protocole "http/2.0" est également disponible. Il se base sur le champ SSL/TLS "ALPN" utilisé par les navigateurs pour annoncer qu'ils tentent d'établir une connexion HTTP/2.0. Cela permet d'avoir un Frontend TCP commun pour la terminaison SSL/TLS du HTTP 1 et 2 puis diriger ces flux en fonction de la version du protocole. -> +> Cette action est aussi disponible en TCP. Dans ce cas, le protocole "http/2.0" est également disponible. Il se base sur le champ SSL/TLS "ALPN" utilisé par les navigateurs pour annoncer qu'ils tentent d'établir une connexion HTTP/2.0. Cela permet d'avoir un frontend TCP commun pour la terminaison SSL/TLS du HTTP 1 et 2 puis diriger ces flux en fonction de la version du protocole. +> + +##### **Adresse source** -#### Adresse source -Cette règle permet de filtrer les requêtes en fonction de leur adresse source. En la combinant avec une règle basée sur l'URI ou le nom de domaine, cela permet par exemple de restreindre certaines ressources à un proxy d'entreprise tout en exposant toutes les autres ressources sans restrictions au niveau de votre service OVH Load Balancer. +Cette règle permet de filtrer les requêtes en fonction de leur adresse source. En la combinant avec une règle basée sur l'URI ou le nom de domaine, cela permet par exemple de restreindre certaines ressources à un proxy d'entreprise, tout en exposant toutes les autres ressources sans restrictions au niveau de votre service OVHcloud Load Balancer. -|Champs|Valeur| -|---|---| -|name|`source`| -|hasSubField|non| -|matches|`is` ou `in`| -|pattern|Sous-réseau (a.b.c.d/z) ou adresse (a.b.c.d)| +| Champ | Valeur | +| :--- | :--- | +| name | `source` | +| hasSubField | non | +| matches | `is` ou `in` | +| pattern | Sous-réseau (a.b.c.d/z) ou adresse (a.b.c.d) | > [!primary] > > Cette action est aussi disponible en TCP avec le même comportement. -> +> Par exemple, pour bloquer un réseau et une adresse en particulier, on pourra utiliser un pattern tel que "4.4.0.0/16, 8.8.8.8". -#### Nom de domaine +##### **Nom de domaine** + Cette règle permet de filtrer les requêtes en fonction de leur nom de domaine. Cela permet par exemple de reproduire la fonction "vhost" de Apache ou router l'ensemble des domaines commençant par "mail." vers un serveur dédié au webmail. -|Champs|Valeur| -|---|---| -|name|`host`| -|hasSubField|non| -|matches|`is`, `in`, `contains`, `startswith`, `endswith` ou `matches`| -|pattern|Chaîne de caractères ou expression régulière| +| Champ | Valeur | +| :--- | :--- | +| name | `host` | +| hasSubField | non | +| matches | `is`, `in`, `contains`, `startswith`, `endswith` ou `matches` | +| pattern | Chaîne de caractères ou expression régulière | > [!primary] > -> Cette action est aussi disponible en TCP. Elle n'aura de sens que si le Frontend est configuré pour accepter des connexions SSL/TLS et que le client envoie une option "SNI". C'est notamment le cas des navigateurs web récents. -> +> Cette action est aussi disponible en TCP. Elle n'aura de sens que si le frontend est configuré pour accepter des connexions SSL/TLS et que le client envoie une option "SNI". C'est notamment le cas des navigateurs web récents. +> + +##### **Méthode HTTP** -#### Méthode HTTP Cette règle permet de filtrer les requêtes en fonction de la méthode HTTP. Elle sera communément utilisée de paire avec une règle basée sur l'URI ou chemin de la requête pour rendre la règle plus sélective. -|Champs|Valeur| -|---|---| -|name|`method`| -|hasSubField|non| -|matches|`is` ou `in`| -|pattern|`GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS` ou `TRACE`| +| Champ | Valeur | +| :--- | :--- | +| name | `method` | +| hasSubField | non | +| matches | `is` ou `in` | +| pattern | `GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS` ou `TRACE` | + +##### **Chemin de la requête** -#### Chemin de la requête Cette règle permet de filtrer les requêtes en fonction du chemin de la requête ou URI. Le chemin de la requête est la portion comprise entre le 1er '/' inclus et le premier '?' exclu. -|Champs|Valeur| -|---|---| -|name|`uri`| -|hasSubField|non| -|matches|`is`, `in`, `contains`, `startswith`, `endswith` ou `matches`| -|pattern|Chaîne de caractères ou expression régulière| +| Champ | Valeur | +| :--- | :--- | +| name | `uri` | +| hasSubField | non | +| matches | `is`, `in`, `contains`, `startswith`, `endswith` ou `matches` | +| pattern | Chaîne de caractères ou expression régulière | + +##### **Paramètre de la requête** -#### Paramètre de la requête Cette règle permet de filtrer les requêtes en fonction de l'existence ou de la valeur d'un paramètre spécifique de la requête HTTP. Il s'agit de la partie après le premier '?'. Si un paramètre est spécifié plusieurs fois dans la requête, seul le premier est pris en compte. -|Champs|Valeur| -|---|---| -|name|`param`| -|hasSubField|oui| -|matches|`is`, `in`, `contains`, `startswith`, `endswith` ou `matches`| -|pattern|Chaîne de caractères ou expression régulière| - -#### En-Tête HTTP -Cette règle permet de filtrer les requêtes en fonction de l'existence ou de la valeur d'un En-Tête HTTP spécifique. Cela permet par exemple de détecter l'ouverture d'une connexion websocket et la diriger vers une Ferme dédiée. - -|Champs|Valeur| -|---|---| -|name|`header`| -|hasSubField|oui| -|matches|`is`, `in`, `contains`, `startswith`, `endswith` ou `matches`| -|pattern|Chaîne de caractères ou expression régulière| - -#### Cookie -Cette règle permet de filtrer les requêtes en fonction de l'existence ou de la valeur d'un Cookie HTTP spécifique. Cela permet par exemple de diriger les visiteurs volontaires vers une Ferme de préproduction. - -|Champs|Valeur| -|---|---| -|name|`cookie`| -|hasSubField|oui| -|matches|`is`, `in`, `contains`, `startswith`, `endswith` ou `matches`| -|pattern|Chaîne de caractères ou expression régulière| +| Champ | Valeur | +| :--- | :--- | +| name | `param` | +| hasSubField | oui | +| matches | `is`, `in`, `contains`, `startswith`, `endswith` ou `matches` | +| pattern | Chaîne de caractères ou expression régulière | + +##### **En-tête HTTP** + +Cette règle permet de filtrer les requêtes en fonction de l'existence ou de la valeur d'un en-tête HTTP spécifique. Cela permet par exemple de détecter l'ouverture d'une connexion websocket et la diriger vers une ferme dédiée. + +| Champ | Valeur | +| :--- | :--- | +| name | `header` | +| hasSubField | oui | +| matches | `is`, `in`, `contains`, `startswith`, `endswith` ou `matches` | +| pattern | Chaîne de caractères ou expression régulière | + +##### **Cookie** + +Cette règle permet de filtrer les requêtes en fonction de l'existence ou de la valeur d'un cookie HTTP spécifique. Cela permet par exemple de diriger les visiteurs volontaires vers une ferme de préproduction. + +| Champ | Valeur | +| :--- | :--- | +| name | `cookie` | +| hasSubField | oui | +| matches | `is`, `in`, `contains`, `startswith`, `endswith` ou `matches` | +| pattern | Chaîne de caractères ou expression régulière | + +## Aller plus loin + +Échangez avec notre [communauté d'utilisateurs](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_route/guide.fr-fr.md b/pages/network/load_balancer/create_route/guide.fr-fr.md index 813922162de..2942881f2d3 100644 --- a/pages/network/load_balancer/create_route/guide.fr-fr.md +++ b/pages/network/load_balancer/create_route/guide.fr-fr.md @@ -1,14 +1,16 @@ --- title: "Configuration d'un service OVHcloud Load Balancer avec les routes HTTP" -excerpt: 'Dirigez dynamiquement vos requêtes vers une ferme en particulier' -updated: 2018-04-09 +excerpt: "Dirigez dynamiquement vos requêtes vers une ferme spécifique" +updated: 2025-11-27 --- ## Objectif -Le service Load Balancer OVHcloud redirige le trafic arrivant sur un frontend vers les serveurs de la ferme par défaut de ce frontend, ou sa redirection par défaut. +Le service Load Balancer OVHcloud redirige le trafic entrant du frontend vers les serveurs de la ferme par défaut de ce frontend, ou sa redirection par défaut. -Dans certains cas, il est possible d'aller plus loin et de router, rediriger ou rejeter le trafic selon divers critères. Par exemple, dans le cas d'un service HTTP(S), il est possible de filtrer le trafic en fonction de la méthode HTTP, de l'URL ou même de la valeur d'un cookie ou d'un en-tête ! Dans le service OVHcloud Load Balancer, ce sont les **routes**. Une route est une action particulière à réaliser si une ou plusieurs conditions sont réalisées. +Dans certains cas, il est possible d'aller plus loin et de router, rediriger ou rejeter le trafic selon divers critères. Par exemple, dans le cas d'un service HTTP(S), il est possible de filtrer le trafic en fonction de la méthode HTTP, de l'URL ou même de la valeur d'un cookie ou d'un en-tête. Dans le service OVHcloud Load Balancer, ces éléments sont appelés **routes**. Une route est une action particulière à effectuer si une ou plusieurs conditions sont remplies. + +**Ce guide vous montrera comment diriger vos requêtes dynamiquement vers une ferme spécifique grâce à l'utilisation de routes.** ## Prérequis @@ -19,64 +21,64 @@ Dans certains cas, il est possible d'aller plus loin et de router, rediriger ou > [!primary] > -> Bien que ce guide se concentre sur les routes HTTP, le même principe fonctionne en TCP (avec les routes TCP). Cela peut servir pour diriger le trafic HTTP/2 vers une ferme en particulier ou pour rejeter les requêtes venant de certaines IPs. -> +> Bien que ce guide se concentre sur les **routes HTTP**, le même principe s'applique aux routes **TCP**. Cela peut servir pour diriger le trafic HTTP/2 vers une ferme spécifique ou rejeter les requêtes entrantes provenant de certaines adresses IP. +> -Cette fonctionnalité étant encore très jeune, elle est uniquement disponible dans l'API. Ce guide vous présentera les principes généraux ainsi que des scénarii d'utilisation des routes tirés de cas d'usages réels. +Cette fonctionnalité n'est disponible que via l'API. Ce guide vous présentera les principes généraux ainsi que des scénarios d'utilisation des routes tirés de cas d'usages réels. ### Introduction aux routes -Une route sert à contrôler le trafic selon différents critères. Il est possible de les exprimer sous la forme de règles, ou conditions, et d'une action. +Une route sert à contrôler le trafic selon différents critères. Il est possible de les exprimer sous forme de **règles**, de **conditions** ou d'**actions**. -Par exemple, *SI* l'URL _commence_ par '/wp-admin/' (1) *ET* que la connexion _est_ en HTTP (2) *ALORS* _rediriger_ vers la version HTTPS de la page (3). +Par exemple, *SI* l'URL _commence_ par '/wp-admin/' (1) *ET* la connexion _est_ en HTTP (2) *ALORS* _rediriger_ vers la version HTTPS de la page (3). Dans cet exemple, il y a deux règles : -- la connexion doit venir d'un frontend HTTP (2) ; +- la connexion doit provenir d'un frontend HTTP (2) ; - son URL doit commencer par les pages d'administration de WordPress (1). -Associée à ces règles, il y a une action : rediriger vers la version HTTPS de la page (3). +Il y a une action associée à ces règles : rediriger vers la version HTTPS de la page (3). -Il s'agit d'une action « finale ». C'est à dire que si les règles sont validées, l'évaluation des routes s'arrête et l'action est exécutée. +Il s'agit d'une action "finale". C'est à dire que si les règles sont validées, l'évaluation des routes s'arrête et l'action est exécutée. ### Présentation de l'API -La gestion des routes n'est accessible qu'au travers de l'[API OVHcloud](/links/api). Elle est valide uniquement pour les protocoles `http` et `tcp`{.action}, le chemin `/ipLoadbalancing/{serviceName}/{protocole}/route/` expose l'API dédiée aux routes. +La gestion des routes n'est accessible qu'au travers de l'[API OVHcloud](/links/api). Elle n'est valable que pour les protocoles **http** et **tcp**, et le chemin `/ipLoadbalancing/{serviceName}/{protocol}/route/`{.action} expose l'API dédiée aux routes. L'API des routes de votre service OVHcloud Load Balancer a été pensée spécialement pour être souple, puissante et évolutive. Elle est organisée autour de trois sections principales : -1. les API listant les règles et actions disponibles. -2. les API listant les routes configurées sur votre service OVHcloud Load Balancer. -3. les API de configuration des routes de votre service OVHcloud Load Balancer. +1. Les appels API listant les règles et actions disponibles. +2. Les appels API listant les routes configurées sur votre service OVHcloud Load Balancer. +3. Les appels de configuration des routes de votre service OVHcloud Load Balancer. > [!primary] > -> Pour n'afficher que les API liées aux routes dans la console d'API OVHcloud, vous pouvez utiliser le champ `filter` avec le mot clé route. -> +> Pour afficher uniquement les appels API liés aux routes dans la console de l'API OVHcloud, vous pouvez utiliser le champ `filter`{.action} avec le mot-clé "*[a-z]*". +> -Lorsque vous souhaitez configurer une route ou des règles, la première chose à faire est de consulter les actions et les règles disponibles. Cela vous donnera les valeurs possibles pour les champs des APIs de configuration des routes et des règles. +Lorsque vous souhaitez configurer une route ou des règles, la première chose à faire est de consulter les **actions et règles disponibles**. Cela vous donnera les valeurs possibles pour les champs de configuration de l'API des routes et des règles. - Une route peut avoir plusieurs règles. -- Une route peut être attachée à un et un seul frontend. -- Un frontend peut avoir plusieurs routes. Dans ce cas, l'ordre d'évaluation dépend de leur type et de leur poids. +- Une route ne peut être attachée qu'à un seul frontend. +- Un frontend peut avoir plusieurs routes. Dans ce cas, l'ordre d'évaluation dépend de son type et de son poids. -Quand une requête arrive sur votre service OVHcloud Load Balancer, les routes sont évaluées successivement en suivant ces principes : +Quand une requête arrive sur votre service OVHcloud Load Balancer, les routes sont évaluées successivement selon les principes suivants : -1. d'abord les routes de type reject et rewrite puis enfin les routes de type farm ; -2. à l'intérieur de ces catégories, les routes sont évaluées par poids croissant ; -3. si deux routes ont le même poids, la première créée sera la première évaluée ; -4. seule la première action dont toutes les règles sont validées est exécutée. +1. D'abord, les **routes de type reject et rewrite**, puis les **routes de type farm** ; +2. À l'intérieur de ces catégories, les routes sont évaluées par **poids croissant** ; +3. Si deux routes ont le même poids, la **première route créée** est évaluée en premier ; +4. Seule la **première action** de toutes les règles validées est exécutée. ### Règles et actions disponibles -Cette première section de l'API contient une liste à jour des actions et règles disponibles pour votre service OVHcloud Load Balancer. Elle contient un appel pour les actions et un autre pour les règles. Ces 2 appels retournent une liste d'objets. Chaque objet indique son nom et s'il s'applique aux routes TCP ou aux routes HTTP ainsi que les valeurs ou types de valeur attendus pour les différents champs de l'API. Si un champ est "null", cela signifie qu'aucune valeur n'est attendue. Si une valeur invalide est fournie, l'API retournera une erreur de validation. +Cette première section de l'API contient une liste à jour des actions et règles disponibles pour votre service OVHcloud Load Balancer. Elle contient un appel pour les actions et un autre pour les règles. Ces deux appels retournent une liste d'objets. Chaque objet est nommé, et indique s'il s'applique aux routes TCP ou HTTP, ainsi que les valeurs ou types de valeurs attendus pour les différents champs de l'API. Si un champ est "null", cela signifie qu'aucune valeur n'est attendue. Si une valeur invalide est fournie, l'API retournera une erreur de validation. #### Actions > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteActions -> +> Pour plus d'information sur cet appel, nous vous invitons à consulter la section [Actions disponibles](#available-actions), en bas de ce guide. @@ -85,183 +87,182 @@ Pour plus d'information sur cet appel, nous vous invitons à consulter la sectio > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteRules -> +> -Pour plus d'information sur cet appel, nous vous invitons à consulter la section [Règles disponibles](#available-rules){.internal}, en bas de ce guide. +Pour plus d'information sur cet appel, nous vous invitons à consulter la section [Règles disponibles](#available-rules), en bas de ce guide. ### Routes configurées -Cette deuxième section de l'API ne contient qu'un seul appel. Il a principalement été pensé pour faciliter l'implémentation de mécanismes d'auto-complétion. Il retourne l'identifiant, le nom et le type de chaque route définie. Les détails d'une route peuvent être obtenus avec un appel GET /ipLoadbalancing/{serviceName}/route/{type}/{routeId} défini plus bas. + +Cette deuxième section de l'API ne contient qu'un seul appel. Il a principalement été pensé pour faciliter l'implémentation de mécanismes d'auto-complétion. Il retourne l'identifiant, le nom et le type de chaque route définie. Les détails d'une route peuvent être obtenus avec un appel `GET /ipLoadbalancing/{serviceName}/route/{type}/{routeId}` défini plus bas. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/definedRoutes -> +> -Pour plus d'information sur cet appel, nous vous invitons à consulter la section « [Manipulation des routes](#handling-routes) », en bas de ce guide. +Pour plus d'information sur cet appel, nous vous invitons à consulter la section "[Manipulation des routes](#handling-routes)", en bas de ce guide. ### Configuration des routes -Avec ces principes de base que sont les actions et règles disponibles et l'ordre d'évaluation des routes, les routes peuvent être manipulées de la même manière que les farms. +Avec ces principes de base sur les actions et règles disponibles, et l'ordre d'évaluation des routes, ces routes peuvent être manipulées de la même manière que les fermes. Lorsque vous créez une route, vous pouvez y attacher des règles. Les valeurs possibles pour les règles et les actions sont définies par les appels API. -Vous créez une route, sur laquelle vous pouvez attacher des règles. Les valeurs possibles pour les règles et les actions étant définies par les appels d'API. +Pour plus d'informations sur ces méthodes, vous pouvez consulter la section "[Manipulation des routes](#handling-routes)", en bas de ce guide. -Pour plus d'informations sur ces méthodes, vous pouvez consulter la section « [Manipulation des routes](#handling-routes) », en bas de ce guide. +## Exemples -### Exemples +Afin de démontrer l'utilité des routes, cette section offrira quelques exemples pratiques de l'utilisation de cette technologie pour les besoins internes d'OVHcloud, sans entrer dans les détails des appels API. -Si vous n'êtes pas encore convaincu par la puissance des routes, cette section devrait vous convaincre pour de bon. Sans rentrer dans le détail des appels d'APIs, elle a pour vocation de présenter comment réaliser plusieurs cas d'utilisation inspirés de nos besoins internes chez OVHcloud. +Vous trouverez le détail des appels API dans la section "[Manipulation des routes](#handling-routes)", en bas de ce guide et les sections suivantes. -Vous trouverez le détail des appels d'API dans la section « [Manipulation des routes](#handling-routes) », en bas de ce guide et les sections suivantes. +### Forcer le HTTPS pour les pages de login WordPress -#### Forcer le HTTPS pour les pages de login WordPress +Le protocole HTTPS est devenu la norme. Son objectif est de rendre tous les sites web disponibles en HTTPS de manière sécurisée, grâce au protocole SSL/TLS. Si vous avez besoin d'un certificat SSL/TLS, vous pouvez utiliser votre service OVHcloud Load Balancer pour en commander un nouveau, qui sera géré pour vous de manière complètement automatique. -Le HTTPS est devenu la norme. L'objectif est de rendre tous les sites disponibles de manière sécurisée en HTTPS grâce au protocole SSL/TLS. Si vous avez besoin d'un certificat SSL/TLS, vous pouvez utiliser votre service OVHcloud Load Balancer pour en commander un qui sera géré pour vous de manière complètement automatique. +Migrer un site web vers HTTPS demande du travail, notamment pour éviter les problèmes de [Mixed-Content](https://developer.mozilla.org/en-us/docs/Web/Security/Mixed_content). Il peut être intéressant de migrer votre site web section par section, en commençant par sécuriser les pages qui envoient des identifiants de connexion. -Migrer un site en HTTPS demande du travail, notamment pour éviter les problèmes de « [Mixed-Content](https://developer.mozilla.org/en-us/docs/Web/Security/Mixed_content) ». Il peut être intéressant de migrer section par section, en commençant par sécuriser les pages envoyant des identifiants. +Une approche pourrait être de s'appuyer sur le début des URLs WordPress. Par défaut, l'URL des pages de connexion de WordPress commence par `/wp-login`. Nous aurions donc besoin des élements suivants : -Une approche pourrait être de se baser sur le début des URLs WordPress. Par défaut, l'URL des pages de connexion de WordPress commencent par `/wp-login`. Nous aurions donc besoin : +- une route avec une **action de redirection** ; +- une règle dans cette route qui détecte les URLs commençant par **"/wp-login"**. -- d'une route avec une action de redirection ; -- d'une règle dans cette route qui détecte les URLs commençant par `/wp-login`. +En pratique, cela donne une route comme suit : -Dans la pratique, cela donne une route : +| Champ | Valeur et description | +| :--- | :--- | +| serviceName | Identifiant de votre service OVHcloud Load Balancer | +| frontendId | Identifiant de votre frontend HTTP | +| displayName | " Redirection des connexions WordPress vers HTTPS " | +| weight | (vide) | +| action.type | "redirect" | +| action.status | 302 pour une redirection temporaire, 301 pour une redirection permanente | +| action.target | "`https://\${host}\${path}\${arguments}`" pour prendre le même hôte, chemin et arguments | -|Champ|Valeur et description| -|---|---| -|serviceName|Identifiant de votre service OVHcloud Load Balancer| -|frontendId|Identifiant de votre frontend HTTP| -|displayName|"Redirection des connexions WordPress vers HTTPS"| -|weight|(vide)| -|action.type|"redirect"| -|action.status|302 pour une redirection temporaire, 301 pour une redirection permanente| -|action.target|"`https://${host}${path}${arguments}`" pour reprendre les mêmes host, chemin et arguments| +Sur cette route, nous allons attacher une règle : -Et sur cette route, on vient attacher une règle : +| Champ | Valeur et description | +| :--- | :--- | +| serviceName | Identifiant de votre service OVHcloud Load Balancer | +| routeId | Identifiant de la route créée ci-dessus | +| field | "uri" | +| subField | (vide) | +| match | "startswith" | +| negate | false | +| pattern | "/wp-login" | -|Champ|Valeur et description| -|---|---| -|serviceName|Identifiant de votre service OVHcloud Load Balancer| -|routeId|Identifiant de la route créée juste au dessus| -|field|"uri"| -|subField|(vide)| -|match|"startswith"| -|negate|false| -|pattern|"/wp-login"| - -Il ne reste plus qu'à appliquer la configuration dans la zone concernée. +Ensuite, appliquez la configuration à la zone concernée. > [!warning] > -> Pour ajouter une nouvelle redirection, il faudra renouveler cette opération. Création d'une route, puis création d'une règle. Si une seconde règle est ajoutée sur la même route, les 2 devront être validées pour que la redirection fonctionne. Concrètement, si les règles sont "startswith /wp-login" et "startswith /wp-admin", la redirection ne fonctionnera jamais car il est impossible que ces 2 conditions soient vraies simultanément. -> +> Pour ajouter une nouvelle redirection, vous devrez répéter ces actions, en créant une route, puis une règle. Si une seconde règle est ajoutée à la même route, les deux règles doivent être validées pour que la redirection fonctionne. Notez que si les règles sont "startswith /wp-login" et "startswith /wp-admin", la redirection ne fonctionnera jamais car ces deux conditions ne peuvent pas être vraies simultanément. +> -#### Router en fonction d'un domaine (VHost) +### Route en fonction d'un domaine (VHost) C'est la fonctionnalité qui a rendu possible l'essor du web quand il en était à ses balbutiements, avec la possibilité d'exposer plusieurs sites derrière une même adresse IP grâce au champ "Host" des en-têtes HTTP. -Par exemple, si votre infrastructure est composée d'un VPS par site Internet et d'un service OVHcloud Load Balancer pour assurer la terminaison SSL/TLS et la redirection vers une page de maintenance avec un serveur de "backup" dans les farms, il était auparavant nécessaire de disposer d'une Additional IP par site, routée vers votre service OVHcloud Load Balancer et un frontend par IP. +Par exemple, si votre infrastructure est composée d'un VPS pour votre site web, d'un OVHcloud Load Balancer pour assurer la terminaison SSL/TLS, et de redirections vers une page de maintenance avec un serveur de secours dans les fermes, vous auriez autrefois eu besoin d'une Additional IP par site web, routée vers votre OVHcloud Load Balancer, et d'un frontend par IP. -Avec les routes, il devient possible de mutualiser le même frontend et choisir la ferme de serveurs dynamiquement en fonction du champ "Host". +Avec les routes, vous pouvez partager le même frontend et choisir la ferme de serveurs dynamiquement, grâce au **champ "[a-z]*"**. Pour cela, vous aurez besoin : - d'une route par VHost ; - d'une règle par route détectant un domaine spécifique. -Dans la pratique, pour router le domaine www.example.com, cela donne une route : +En pratique, pour router le domaine **www.example.com**, cela donnera la route suivante : -|Champ|Valeur et description| -|---|---| -|serviceName|Identifiant de votre service OVHcloud Load Balancer| -|frontendId|Identifiant de votre frontend| -|displayName|"VHost - www.example.com"| -|weight|(vide)| -|action.type|"farm"| -|action.status|(vide)| -|action.target|Identifiant de la ferme vers laquelle diriger ce domaine| +| Champ | Valeur et description | +| :--- | :--- | +| serviceName | Identifiant de votre service OVHcloud Load Balancer | +| frontendId | Identifiant de votre frontend | +| displayName | "VHost - www.example.com" | +| weight | (vide) | +| action.type | "farm" | +| action.status | (vide) | +| action.target | Identifiant de la ferme vers laquelle diriger ce domaine | -Et sur cette route, on vient attacher une règle : +Et sur cette route, nous allons attacher une règle : -|Champ|Valeur et description| -|---|---| -|serviceName|Identifiant de votre service OVHcloud Load Balancer| -|routeId|Identifiant de la route créée juste au dessus| -|field|"host"| -|subField|(vide)| -|match|"is"| -|negate|false| -|pattern|"www.example.com" ou le domaine de votre choix| +| Champ | Valeur et description | +| :--- | :--- | +| serviceName | Identifiant de votre service OVHcloud Load Balancer | +| routeId | Identifiant de la route créée ci-dessus | +| field | "host" | +| subField | (vide) | +| match | "is" | +| negate | false | +| pattern | "www.example.com" ou un domaine de votre choix | -Il ne reste plus qu'à appliquer la configuration. +Enfin, appliquez la configuration. -#### Réserver une Additional IP à un site en particulier +### Réserver une Additional IP à un site web particulier -Si l'on reste sur le scénario de l'hébergement à base de VPS, on peut souhaiter dédier une adresse IP à un client donné. Rendre l'IP disponible se fait facilement en la routant vers votre service OVHcloud Load Balancer puis en configurant un frontend dédié attaché à cette adresse Additional IP et ayant comme defaultFarmId le VPS cible de ce client. +Si vous hébergez un site web sur un VPS, vous pourriez vouloir dédier une adresse IP à un client donné. Vous pouvez facilement rendre l'IP disponible en la routant vers votre service OVHcloud Load Balancer, puis en configurant un frontend dédié attaché à cette Additional IP, et en définissant le VPS cible du client comme `defaultFarmId`. -Néanmoins, que se passe-t-il si un autre client détecte cela et configure son domaine pour pointer vers l'adresse IP du client premium ? Par défaut, cela fonctionnera et son site sera routé vers l'autre VPS. S'il y a un certificat SSL/TLS, cela fonctionnera quand même car l'ensemble des certificats sont automatiquement disponibles pour l'ensemble des frontends. +Néanmoins, que se passera-t-il si un autre client détecte cela et configure son domaine pour pointer vers l'IP du client premium ? Par défaut, cela fonctionnera, et son site web sera routé vers le VPS d'un autre client. Si un certificat SSL/TLS est présent, cela fonctionnera toujours, car tous les certificats sont automatiquement disponibles pour l'ensemble des frontends. -Dans ce scénario, l'idée est d'ajouter une règle qui va rejeter les requêtes si le domaine n'est pas le domaine premium. Cela peut se faire simplement avec une route de rejet et une règle. +Dans de tels scénarios, la solution est d'ajouter une règle qui **rejettera les requêtes si le domaine n'est pas un domaine premium**. Vous pouvez le faire avec une route de rejet et une règle. -Dans la pratique, pour réserver un frontend avec une IP dédiée au domaine www.example.com, cela donne une route : +En pratique, pour réserver un frontend avec une IP dédiée au domaine **www.example.com**, cela donnera la route suivante : -|Champ|Valeur et description| -|---|---| -|serviceName|Identifiant de votre service OVHcloud Load Balancer| -|frontendId|Identifiant de votre frontend| -|displayName|"Restrict to www.example.com"| -|weight|(vide)| -|action.type|"reject"| -|action.status|403| -|action.target|(vide)| +| Champ | Valeur et description | +| :--- | :--- | +| serviceName | Identifiant de votre service OVHcloud Load Balancer | +| frontendId | Identifiant de votre frontend | +| displayName | "Restriction à www.example.com" | +| weight | (vide) | +| action.type | "reject" | +| action.status | 403 | +| action.target | (vide) | -Et sur cette route, on vient attacher une règle : +Et sur cette route, nous allons attacher une règle : -|Champ|Valeur et description| -|---|---| -|serviceName|Identifiant de votre service OVHcloud Load Balancer| -|routeId|Identifiant de la route créée juste au dessus| -|field|"host"| -|subField|(vide)| -|match|"is"| -|negate|true| -|pattern|"www.example.com" ou le domaine de votre choix| +| Champ | Valeur et description | +| :--- | :--- | +| serviceName | Identifiant de votre service OVHcloud Load Balancer | +| routeId | Identifiant de la route créée ci-dessus | +| field | "host" | +| subField | (vide) | +| match | "is" | +| negate | true | +| pattern | "www.example.com" ou un domaine de votre choix | -Il ne reste plus qu'à appliquer la configuration. +Enfin, appliquez la configuration. -#### Router en fonction d'une URL et d'une méthode HTTP +### Route en fonction d'une URL et d'une méthode HTTP -Sur certaines infrastructures spécifiques, il est nécessaire de router certaines requêtes vers une ferme spécifique. Par exemple, pour gérer des requêtes rares mais coûteuses sans affecter la production. Par exemple, des requêtes analytiques que l'on ferait fonctionner sur un réplicat en lecture seule des données, avec une machine disposant de plus de mémoire. +Sur certaines infrastructures spécifiques, certaines requêtes doivent être routées vers une ferme spécifique. Par exemple, pour gérer des requêtes rares mais gourmandes en données sans impacter la production, comme des requêtes analytiques qui travailleraient sur une copie en lecture seule des données avec un serveur disposant d'un volume de mémoire plus élevé. -Disons par exemple que la requête est envoyée : +Si, par exemple, la requête est envoyée : -- avec la méthode POST ; -- sur une URL correspondant à "^/.*/batch-analytics$" +- avec la méthode **POST** ; +- sur une URL correspondant à **"^/.*/batch-analytics$"**. -Pour cet exemple, vous aurez besoin d'une route avec 2 règles, l'une d'entre elles utilisant une expression régulière. +Alors, vous auriez besoin d'une route avec deux règles, dont une utilisant une expression régulière. -Dans la pratique, cela donne une route : +En pratique, cela donne une route comme suit : -|Champ|Valeur et description| -|---|---| -|serviceName|Identifiant de votre service OVHcloud Load Balancer| -|frontendId|Identifiant de votre frontend| -|displayName|"Route batch analytics to dedicated farm"| -|weight|(vide)| -|action.type|"farm"| -|action.status|(vide)| -|action.target|Identifiant de la ferme vers laquelle diriger ces opérations| +| Champ | Valeur et description | +| :--- | :--- | +| serviceName | Identifiant de votre service OVHcloud Load Balancer | +| frontendId | Identifiant de votre frontend | +| displayName | "Route les analyses par batch vers une ferme dédiée" | +| weight | (vide) | +| action.type | "farm" | +| action.status | (vide) | +| action.target | Identifiant de la ferme vers laquelle diriger ces opérations | -Et sur cette route, on vient attacher 2 règles : +Et sur cette route, nous allons attacher deux règles : -|Champ|Règle 1|Règle 2| -|---|---|---| -|serviceName|Identifiant de votre service OVHcloud Load Balancer|idem| -|routeId|Identifiant de la route créée juste au dessus|idem| -|field|"method"|"uri"| -|subField|(vide)|(vide)| -|match|"is"|"matches"| -|negate|false|false| -|pattern|"POST"|"^/.*/batch-analytics$"| +| Champ | Règle 1 | Règle 2 | +| :--- | :--- | :--- | +| serviceName | Identifiant de votre service OVHcloud Load Balancer | comme pour la règle 1 | +| routeId | Identifiant de la route créée ci-dessus | comme pour la règle 1 | +| field | "method" | "uri" | +| subField | (vide) | (vide) | +| match | "is" | "matches" | +| negate | false | false | +| pattern | "POST" | "`^/.*/batch-analytics$`" | Ici, la première règle s'applique sur une énumération. Seules les méthodes HTTP standard sont disponibles. La deuxième règle exploite quant à elle toute la puissance des routes en utilisant une expression régulière. Bien que ce soit possible d'utiliser de telles expressions, si vous pouvez vous en passer, les performances n'en seront que meilleures. @@ -269,7 +270,7 @@ Il ne reste plus qu'à appliquer la configuration dans la zone concernée. #### Router certaines IP et les clients volontaires vers la preproduction -Quand un site prend de l'ampleur, on peut souhaiter mettre en place un environnement de préproduction permettant de valider les évolutions en cours, sans affecter la majorité des utilisateurs. Généralement, lorsque l'on configure ce type d'environnement, on cherche à réduire autant que possible l'écart entre la production et la préproduction, de manière à détecter les problèmes avec le plus de précision possible. Une source de problème classique et pourtant souvent négligée est le nom de domaine. Il est parfois codé « en dur » dans un fichier ou un article. À ce moment, un lien pourra fonctionner en préproduction mais pas en production. Oups... +Quand un site prend de l'ampleur, on peut souhaiter mettre en place un environnement de préproduction permettant de valider les évolutions en cours, sans affecter la majorité des utilisateurs. Généralement, lorsque l'on configure ce type d'environnement, on cherche à réduire autant que possible l'écart entre la production et la préproduction, de manière à détecter les problèmes avec le plus de précision possible. Une source de problème classique et pourtant souvent négligée est le nom de domaine. Il est parfois codé " en dur " dans un fichier ou un article. À ce moment, un lien pourra fonctionner en préproduction mais pas en production. Au lieu de mettre en place des règles basées sur le nom de domaine, on pourrait mettre en place des règles basées sur l'adresse IP source (par exemple, un proxy d'entreprise) et éventuellement un cookie pour les clients volontaires. Ces configurations peuvent être détectées avec deux routes sur votre service OVHcloud Load Balancer. @@ -280,27 +281,27 @@ Pour cet exemple, on considérera : Dans la pratique, vous aurez besoin de deux routes identiques : -|Champ|Valeur et description| -|---|---| -|serviceName|Identifiant de votre service OVHcloud Load Balancer| -|frontendId|Identifiant de votre frontend| -|displayName|"Route Opt-In and internal users to preproduction environment"| -|weight|(vide)| -|action.type|"farm"| -|action.status|(vide)| -|action.target|Identifiant de la ferme de préproduction| +| Champ | Valeur et description | +| :--- | :--- | +| serviceName | Identifiant de votre service OVHcloud Load Balancer | +| frontendId | Identifiant de votre frontend | +| displayName | "Route Opt-In and internal users to preproduction environment" | +| weight | (vide) | +| action.type | "farm" | +| action.status | (vide) | +| action.target | Identifiant de la ferme de préproduction | Puis on vient attacher les 2 règles suivantes, chacune sur une des routes (1 règle par route) : -|Champ|Règle 1|Règle 2| -|---|---|---| -|serviceName|Identifiant de votre service OVHcloud Load Balancer|idem| -|routeId|Identifiant de la 1ère route|Identifiant de la 2ème route| -|field|"source"|"cookie"| -|subField|(vide)|"PreprodOptIn"| -|match|"in"|"exists"| -|negate|false|false| -|pattern|"42.42.42.0/24, 1.2.3.4"|(vide)| +| Champ | Règle 1 | Règle 2 | +| :--- | :--- | :--- | +| serviceName | Identifiant de votre service OVHcloud Load Balancer | idem | +| routeId | Identifiant de la 1ère route | Identifiant de la 2ème route | +| field | "source" | "cookie" | +| subField | (vide) | "PreprodOptIn" | +| match | "in" | "exists" | +| negate | false | false | +| pattern | "42.42.42.0/24, 1.2.3.4" | (vide) | La première règle teste si l'IP source est dans une liste de plage d'adresses. Dans ce cas, les différentes plages d'adresses sont séparées par des virgules et peuvent être entourées d'espaces pour plus de lisibilité. Si une plage ne contient qu'une seule adresse, le "/32" est implicite mais peut être mis explicitement. Dans tous les cas, la taille de ce champ est limité à 255 caractères. @@ -310,7 +311,9 @@ Il ne reste plus qu'à appliquer la configuration dans la zone concernée. #### Router les WebSockets vers une ferme dédiée -Lorsqu'un site dispose de fonctions interactives basées sur des WebSockets telles qu'un chat-bot, on peut souhaiter diriger ces connexions vers une ferme de serveurs dédiée à cette tâche. Et c'est en fait très simple. Quand un navigateur cherche à ouvrir une connexion WebSockets, il envoie une requête HTTP standard avec les en-têtes : +Lorsqu'un site dispose de fonctions interactives basées sur des WebSockets telles qu'un chat-bot, on peut souhaiter diriger ces connexions vers une ferme de serveurs dédiée à cette tâche. Et c'est en réalité très simple. + +Quand un navigateur cherche à ouvrir une connexion WebSockets, il envoie une requête HTTP standard avec les en-têtes : ``` Upgrade: websocket @@ -319,33 +322,33 @@ Connection: Upgrade Dans la pratique, il suffit de détecter le premier en-tête. Cela peut se faire très facilement avec une route et une règle : -|Champ|Valeur et description| -|---|---| -|serviceName|Identifiant de votre service OVHcloud Load Balancer| -|frontendId|Identifiant de votre frontend| -|displayName|"Route WebSockets to a dedicated farm"| -|weight|(vide)| -|action.type|"farm"| -|action.status|(vide)| -|action.target|Identifiant de la ferme dédiée au WebSockets| +| Champ | Valeur et description | +| :--- | :--- | +| serviceName | Identifiant de votre service OVHcloud Load Balancer | +| frontendId | Identifiant de votre frontend | +| displayName | "Route WebSockets to a dedicated farm" | +| weight | (vide) | +| action.type | "farm" | +| action.status | (vide) | +| action.target | Identifiant de la ferme dédiée au WebSockets | Et sur cette route, on vient attacher une règle : -|Champ|Valeur et description| -|---|---| -|serviceName|Identifiant de votre service OVHcloud Load Balancer| -|routeId|Identifiant de la route créée juste au dessus| -|field|"header"| -|subField|"Upgrade"| -|match|"is"| -|negate|false| -|pattern|"websocket" (sensible aux majuscules / minuscules)| +| Champ | Valeur et description | +| :--- | :--- | +| serviceName | Identifiant de votre service OVHcloud Load Balancer | +| routeId | Identifiant de la route créée juste au dessus | +| field | "header" | +| subField | "Upgrade" | +| match | "is" | +| negate | false | +| pattern | "websocket" (sensible aux majuscules / minuscules) | Il ne reste plus qu'à appliquer la configuration dans la zone concernée. ### Références -Vous trouverez ici le détail des appels d'API liés aux routes. Pour une vue plus générale des fonctionnalités des routes, nous vous invitons d'abord à consulter la section « [Présentation de l'API](#apipresentation) » un peu plus haut dans ce guide. +Vous trouverez ici le détail des appels d'API liés aux routes. Pour une vue plus générale des fonctionnalités des routes, nous vous invitons d'abord à consulter la section "[Présentation de l'API](#apipresentation)" un peu plus haut dans ce guide. #### Manipulation des routes @@ -353,17 +356,17 @@ Les routes TCP et HTTP se configurent de la même manière. Les routes étant pl ##### **Lister les routes** -Cet appel retourne la liste des identifiants numériques des routes définies pour le protocole HTTP. Il est possible de filtrer cette liste par frontendId. Cet appel retourne les routes dans l'ordre dans lequel elles seront évaluées. L'ordre d'évaluation peut être en partie contrôlé avec le "poids" (weight) de la route. +Cet appel retourne la liste des identifiants numériques des routes définies pour le protocole HTTP. Il est possible de filtrer cette liste par `frontendId`. Cet appel retourne les routes dans l'ordre dans lequel elles seront évaluées. L'ordre d'évaluation peut être en partie contrôlé avec le "poids" (weight) de la route. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route -> +> -|Paramètre|Requis|Signification| -|---|---|---| -|serviceName|Requis|Identifiant de votre service Load Balancer| -|frontendId||Identifiant numérique d'un frontend HTTP auquel les routes sont attachées| +| Paramètre | Requis | Signification | +| :--- | :--- | :--- | +| serviceName | Requis | Identifiant de votre service Load Balancer | +| frontendId | | Identifiant numérique d'un frontend HTTP auquel les routes sont attachées | ##### **Créer une route** @@ -372,27 +375,27 @@ Cet appel permet de créer une route. Seule l'action est obligatoire. Une route > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route -> - -|Paramètre|Requis|Signification| -|---|---|---| -|serviceName|Requis|Identifiant de votre service Load Balancer| -|displayName||Nom d'affichage de votre route (255 caractères maximum)| -|frontendId||Identifiant numérique d'un frontend HTTP auquel rattacher la route| -|weight||Priorité de la route, entre 1 (passe d'abord) et 255 (passe après les autres)| -|action.type|Requis|Nom du type d'action à exécuter si l'ensemble des règles associées à la route sont validées| -|action.status||Code d'état HTTP pour les actions `reject` et `redirect`| -|action.target||Identifiant numérique de la ferme cible pour les actions `farm`, ou modèle d'URL pour les actions `redirect`| +> + +| Paramètre | Requis | Signification | +| :--- | :--- | :--- | +| serviceName | Requis | Identifiant de votre service Load Balancer | +| displayName | | Nom d'affichage de votre route (255 caractères maximum) | +| frontendId | | Identifiant numérique d'un frontend HTTP auquel rattacher la route | +| weight | | Priorité de la route, entre 1 (passe d'abord) et 255 (passe après les autres) | +| action.type | Requis | Nom du type d'action à exécuter si l'ensemble des règles associées à la route sont validées | +| action.status | | Code d'état HTTP pour les actions `reject` et `redirect` | +| action.target | | Identifiant numérique de la ferme cible pour les actions `farm`, ou modèle d'URL pour les actions `redirect` | Les types d'actions possibles sont : -|action|Signification| -|---|---| -|redirect|Rediriger une requète vers `action.target` avec le code d'état HTTP `action.status`| -|reject|Rejeter une requête avec le code d'état HTTP `action.status`| -|farm|Router une requête vers la ferme dont l'identifiant est renseigné dans `action.target`| +| action | Signification | +| :--- | :--- | +| redirect | Rediriger une requête vers `action.target` avec le code d'état HTTP `action.status` | +| reject | Rejeter une requête avec le code d'état HTTP `action.status` | +| farm | Router une requête vers la ferme dont l'identifiant est renseigné dans `action.target` | -Pour plus d'informations sur les actions gérées ainsi que le format des paramètres, nous vous invitons à consulter la section « [Actions disponibles](#available-actions) » plus bas dans ce guide. +Pour plus d'informations sur les actions gérées ainsi que le format des paramètres, nous vous invitons à consulter la section "[Actions disponibles](#available-actions)" plus bas dans ce guide. ##### **Voir le détail d'une route** @@ -401,29 +404,29 @@ Cet appel permet de consulter le détail d'une route HTTP, connaissant son ident > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId} -> +> -Requête : +- Requête : -|Paramètre|Signification| -|---|---| -|serviceName|Identifiant de votre service Load Balancer| -|routeId|Identifiant numérique de la route| +| Paramètre | Signification | +| :--- | :--- | +| serviceName | Identifiant de votre service Load Balancer | +| routeId | Identifiant numérique de la route | -Réponse : +- Réponse : -|Paramètre|Signification| -|---|---| -|routeId|Identifiant numérique de la route| -|displayName|Nom d'affichage de votre route| -|frontendId|Identifiant numérique du frontend auquel votre route est rattachée| -|weight|Priorité de votre route| -|action.type|Nom du type d'action de votre route| -|action.status|Code d'état HTTP associé| -|action.target|Identifiant numérique de la ferme ou modèle d'URL associé| -|rules|Liste des règles devant être validées pour déclencher l'action de la route. Plus de détails sont disponibles dans la section « [Manipulation des Règles](#handling-rules) ».| +| Paramètre | Signification | +| :--- | :--- | +| routeId | Identifiant numérique de la route | +| displayName | Nom d'affichage de votre route | +| frontendId | Identifiant numérique du frontend auquel votre route est rattachée | +| weight | Priorité de votre route | +| action.type | Nom du type d'action de votre route | +| action.status | Code d'état HTTP associé | +| action.target | Identifiant numérique de la ferme ou modèle d'URL associé | +| rules | Liste des règles devant être validées pour déclencher l'action de la route. Plus de détails sont disponibles dans la section "[Manipulation des Règles](#handling-rules)". | -Pour plus d'informations sur les actions gérées ainsi que le format des paramètres, nous vous invitons à consulter la section « [Actions disponibles](#available-actions) » plus bas dans ce guide. +Pour plus d'informations sur les actions gérées ainsi que le format des paramètres, nous vous invitons à consulter la section "[Actions disponibles](#available-actions)" plus bas dans ce guide. ##### **Modifier une route** @@ -434,18 +437,18 @@ Cet appel permet de modifier une route HTTP, connaissant son identifiant. Votre > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId} > -|Paramètre|Requis|Signification| -|---|---|---| -|serviceName|Requis|Identifiant de votre service Load Balancer| -|routeId|Requis|Identifiant numérique de la route| -|displayName||Nom d'affichage de votre route (255 caractères maximum)| -|frontendId||Identifiant numérique d'un frontend HTTP auquel rattacher la route| -|weight||Priorité de la route, entre 1 (passe d'abord) et 255 (passe après les autres)| -|action.type|Requis|Nom du type d'action à exécuter si l'ensemble des règles associées à la route sont validées| -|action.status||Code d'état HTTP pour les actions `reject` et `redirect`| -|action.target||Identifiant numérique de la ferme cible pour les actions `farm`, ou modèle d'URL pour les actions `redirect`| +| Paramètre | Requis | Signification | +| :--- | :--- | :--- | +| serviceName | Requis | Identifiant de votre service Load Balancer | +| routeId | Requis | Identifiant numérique de la route | +| displayName | | Nom d'affichage de votre route (255 caractères maximum) | +| frontendId | | Identifiant numérique d'un frontend HTTP auquel rattacher la route | +| weight | | Priorité de la route, entre 1 (passe d'abord) et 255 (passe après les autres) | +| action.type | Requis | Nom du type d'action à exécuter si l'ensemble des règles associées à la route sont validées | +| action.status | | Code d'état HTTP pour les actions `reject` et `redirect` | +| action.target | | Identifiant numérique de la ferme cible pour les actions `farm`, ou modèle d'URL pour les actions `redirect` | -Pour plus d'informations sur les actions gérées ainsi que le format des paramètres, nous vous invitons à consulter la section « [Actions disponibles](#available-actions) » plus bas dans ce guide. +Pour plus d'informations sur les actions gérées ainsi que le format des paramètres, nous vous invitons à consulter la section "[Actions disponibles](#available-actions)" plus bas dans ce guide. ##### **Supprimer une route** @@ -454,12 +457,12 @@ Cet appel permet de supprimer une route HTTP, connaissant son identifiant. Lorsq > [!api] > > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId} -> +> -|Paramètre|Requis|Signification| -|---|---|---| -|serviceName|Requis|Identifiant de votre service Load Balancer| -|routeId|Requis|Identifiant numérique de la route| +| Paramètre | Requis | Signification | +| :--- | :--- | :--- | +| serviceName | Requis | Identifiant de votre service Load Balancer | +| routeId | Requis | Identifiant numérique de la route | #### Manipulation des règles @@ -470,12 +473,12 @@ Cet appel retourne la liste des identifiants numériques des règles définies p > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule -> +> -|Paramètre|Requis|Signification| -|---|---|---| -|serviceName|Requis|Identifiant de votre service Load Balancer| -|routeId|Requis|Identifiant numérique de la route| +| Paramètre | Requis | Signification | +| :--- | :--- | :--- | +| serviceName | Requis | Identifiant de votre service Load Balancer | +| routeId | Requis | Identifiant numérique de la route | ##### **Attacher une règle** @@ -484,44 +487,44 @@ Cet appel permet d'attacher une règle à une route. Il est possible d'attacher > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule -> - -|Paramètre|Requis|Signification| -|---|---|---| -|serviceName|Requis|Identifiant de votre service Load Balancer| -|routeId|Requis|Identifiant numérique de la route| -|field|Requis|Nom du paramètre HTTP sur lequel appliquer cette règle| -|subField||Nom de l'en-tête HTTP pour les règles `header` ou nom du cookie pour les règles `cookie`| -|match|Requis|Nom du comparateur à appliquer pour valider la règle| -|negate||Inverse le résultat du comparateur| -|pattern||Argument du comparateur| +> + +| Paramètre | Requis | Signification | +| :--- | :--- | :--- | +| serviceName | Requis | Identifiant de votre service Load Balancer | +| routeId | Requis | Identifiant numérique de la route | +| field | Requis | Nom du paramètre HTTP sur lequel appliquer cette règle | +| subField | | Nom de l'en-tête HTTP pour les règles `header` ou nom du cookie pour les règles `cookie` | +| match | Requis | Nom du comparateur à appliquer pour valider la règle | +| negate | | Inverse le résultat du comparateur | +| pattern | | Argument du comparateur | - `field` -|Valeur|Signification| -|---|---| -|source|Adresse ou liste d'adresses source sous la forme d'IP (a.b.c.d/z)| -|protocol|Protocole. "http" ou "https"| -|method|Méthode HTTP (GET, HEAD, POST, PUT, DELETE, OPTIONS, CONNECT, TRACE)| -|host|Nom de domaine (vhost), sans le numéro de port| -|uri|Chamin de la requête tel que compris entre le premier "/" et le premier "?"| -|param|Paramètre HTTP venant de la partie après le premeir "?"| -|header|En-tête HTTP| -|cookie|Cookie HTTP| +| Valeur | Signification | +| :--- | :--- | +| source | Adresse ou liste d'adresses source sous la forme d'IP (a.b.c.d/z) | +| protocol | Protocole. "http" ou "https" | +| method | Méthode HTTP (GET, HEAD, POST, PUT, DELETE, OPTIONS, CONNECT, TRACE) | +| host | Nom de domaine (vhost), sans le numéro de port | +| uri | Chemin de la requête tel que compris entre le premier "/" et le premier "?" | +| param | Paramètre HTTP venant de la partie après le premier "?" | +| header | En-tête HTTP | +| cookie | Cookie HTTP | - `match` -|Valeur|Signification| -|---|---| -|exists|La propriété doit exister (en-tête ou cookie HTTP par exemple)| -|is|La propriété doit correspondre exactement à `pattern`| -|in|La propriété doit être dans la liste de valeurs (séparées par des virgules) définie par `pattern`| -|contains|La propriété doit contenir la valeur de `pattern`| -|startswith|La propriété doit commencer par la valeur de `pattern`| -|endswith|La propriété doit se terminer par la valeur de `pattern`| -|matches|La propriété doit correspondre à l'expression régulière de `pattern`| +| Valeur | Signification | +| :--- | :--- | +| exists | La propriété doit exister (en-tête ou cookie HTTP par exemple) | +| is | La propriété doit correspondre exactement à `pattern` | +| in | La propriété doit être dans la liste de valeurs (séparées par des virgules) définie par `pattern` | +| contains | La propriété doit contenir la valeur de `pattern` | +| startswith | La propriété doit commencer par la valeur de `pattern` | +| endswith | La propriété doit se terminer par la valeur de `pattern` | +| matches | La propriété doit correspondre à l'expression régulière de `pattern` | -Pour plus d'informations sur les règles gérées ainsi que le format des paramètres, nous vous invitons à consulter la section « [Règles disponibles](#available-rules) » plus bas dans ce guide. +Pour plus d'informations sur les règles gérées ainsi que le format des paramètres, nous vous invitons à consulter la section "[Règles disponibles](#available-rules)" plus bas dans ce guide. ##### **Voir le détail d'une règle** @@ -530,28 +533,28 @@ Cet appel permet de consulter le détail d'une règle attachée à une route HTT > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId} -> +> - Requête : -|Paramètre|Signification| -|---|---| -|serviceName|Identifiant de votre service Load Balancer| -|routeId|Identifiant numérique de la route| -|ruleId|Identifiant numérique de la règle| +| Paramètre | Signification | +| :--- | :--- | +| serviceName | Identifiant de votre service Load Balancer | +| routeId | Identifiant numérique de la route | +| ruleId | Identifiant numérique de la règle | - Réponse : -|Paramètre|Signification| -|---|---| -|ruleId|Identifiant numérique de la règle| -|field|Nom du paramètre HTTP sur lequel appliquer la règle| -|subField|Nom de l'en-tête HTTP ou du cookie pour la règle| -|match|Nom du comparateur à appliquer pour valider la règle| -|negate|"true" si le résultat du comparateur est inversé| -|pattern|Argument du comparateur. Le sens et la syntaxe dépendent de `match` et de `field`| +| Paramètre | Signification | +| :--- | :--- | +| ruleId | Identifiant numérique de la règle | +| field | Nom du paramètre HTTP sur lequel appliquer la règle | +| subField | Nom de l'en-tête HTTP ou du cookie pour la règle | +| match | Nom du comparateur à appliquer pour valider la règle | +| negate | "true" si le résultat du comparateur est inversé | +| pattern | Argument du comparateur. Le sens et la syntaxe dépendent de `match` et de `field` | -Pour plus d'informations sur les règles gérées ainsi que le format des paramètres, nous vous invitons à consulter la section « [Règles disponibles](#available-rules) » plus bas dans ce guide. +Pour plus d'informations sur les règles gérées ainsi que le format des paramètres, nous vous invitons à consulter la section "[Règles disponibles](#available-rules)" plus bas dans ce guide. ##### **Modifier une règle** @@ -560,20 +563,20 @@ Cet appel permet de modifier une règle attachée à une route HTTP, connaissant > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId} -> +> -|Paramètre|Requis|Signification| -|---|---|---| -|serviceName|Requis|Identifiant de votre service Load Balancer| -|routeId|Requis|Identifiant numérique de la route| -|ruleId|Requis|Identifiant numérique de la règle| -|field|Requis|Nom du paramètre HTTP sur lequel appliquer cette règle| -|subField||Nom de l'en-tête HTTP pour les règles `header` ou nom du cookie pour les règles `cookie`| -|match|Requis|Nom du comparateur à appliquer pour valider la règle| -|negate||Inverse le résultat du comparateur| -|pattern||Argument du comparateur| +| Paramètre | Requis | Signification | +| :--- | :--- | :--- | +| serviceName | Requis | Identifiant de votre service Load Balancer | +| routeId | Requis | Identifiant numérique de la route | +| ruleId | Requis | Identifiant numérique de la règle | +| field | Requis | Nom du paramètre HTTP sur lequel appliquer cette règle | +| subField | | Nom de l'en-tête HTTP pour les règles `header` ou nom du cookie pour les règles `cookie` | +| match | Requis | Nom du comparateur à appliquer pour valider la règle | +| negate | | Inverse le résultat du comparateur | +| pattern | | Argument du comparateur | -Pour plus d'informations sur les règles gérées ainsi que le format des paramètres, nous vous invitons à consulter la section « [Règles disponibles](#available-rules) » plus bas dans ce guide. +Pour plus d'informations sur les règles gérées ainsi que le format des paramètres, nous vous invitons à consulter la section "[Règles disponibles](#available-rules)" plus bas dans ce guide. ##### **Supprimer une règle** @@ -582,18 +585,18 @@ Cet appel permet de supprimer une règle attachée à une route HTTP, connaissan > [!api] > > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId} -> +> -|Paramètre|Requis|Signification| -|---|---|---| -|serviceName|Requis|Identifiant de votre service Load Balancer| -|routeId|Requis|Identifiant numérique de la route| -|ruleId|Requis|Identifiant numérique de la règle| +| Paramètre | Requis | Signification | +| :--- | :--- | :--- | +| serviceName | Requis | Identifiant de votre service Load Balancer | +| routeId | Requis | Identifiant numérique de la route | +| ruleId | Requis | Identifiant numérique de la règle | > [!primary] > > Si vous souhaitez supprimer une route, il n'est pas nécessaire de supprimer l'ensemble des règles attachées à celle-ci. Les règles sont automatiquement supprimées lorsque vous supprimez une route. -> +> ##### **Lister l'ensemble des routes TCP et HTTP** @@ -602,21 +605,21 @@ Cet appel permet de lister l'ensemble des identifiants, noms d'affichage et type > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/definedRoutes -> +> - Requête : -|Paramètre|Signification| -|---|---| -|serviceName|Identifiant de votre service Load Balancer| +| Paramètre | Signification | +| :--- | :--- | +| serviceName | Identifiant de votre service Load Balancer | -Réponse +- Réponse : -|Paramètre|Signification| -|---|---| -|type|Type de protocole de la route: "tcp" pour les routes TCP, "http" pour les routes HTTP| -|routeId|Identifiant numérique de la route| -|displayName|Nom d'affichage de la route| +| Paramètre | Signification | +| :--- | :--- | +| type | Type de protocole de la route: "tcp" pour les routes TCP, "http" pour les routes HTTP | +| routeId | Identifiant numérique de la route | +| displayName | Nom d'affichage de la route | #### Actions disponibles @@ -629,104 +632,104 @@ L'ensemble des actions gérées par le service OVHcloud Load Balancer sont final > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteActions -> +> - Requête : -|Paramètre|Signification| -|---|---| -|serviceName|Identifiant de votre service Load Balancer| +| Paramètre | Signification | +| :--- | :--- | +| serviceName | Identifiant de votre service Load Balancer | - Réponse : -|Paramètre|Signification| -|---|---| -|type|Indique si cette action est valide pour une route HTTP ou une route TCP| -|name|Nom de l'action à renseigner dans le champ `type` des routes| -|status|Liste des codes d'état HTTP disponibles pour cette action (champ `status` des routes)| -|destination|Type de valeur attendue dans le champ `destination` des routes| +| Paramètre | Signification | +| :--- | :--- | +| type | Indique si cette action est valide pour une route HTTP ou une route TCP | +| name | Nom de l'action à renseigner dans le champ `type` des routes | +| status | Liste des codes d'état HTTP disponibles pour cette action (champ `status` des routes) | +| destination | Type de valeur attendue dans le champ `destination` des routes | ##### **Redirection** -Cette action renvoie une redirection au visiteur. Le type de redirection peut être configuré avec le champ status. Lorsque cette action est sélectionnée, aucune ferme ne recevra la requête. +Cette action renvoie une redirection au visiteur. Le type de redirection peut être configuré avec le champ `status`. Lorsque cette action est sélectionnée, aucune ferme ne recevra la requête. -|Paramètre|Valeur| -|---|---| -|type|`redirect`| -|status|301, 302, 303, 307 ou 308| -|target|URL de destination (peut contenir des variables)| +| Paramètre | Valeur | +| :--- | :--- | +| type | `redirect` | +| status | 301, 302, 303, 307 ou 308 | +| target | URL de destination (peut contenir des variables) | Seuls les codes d'état HTTP de redirection peuvent être spécifiés. Les plus courants sont les codes 301 et 302. Si vous hésitez, vous pouvez prendre le 302 "Redirection temporaire". Les codes d'état HTTP reconnus pour les redirections sont : -|Code de status|Description| -|---|---| -|301|Redirection permanente. La redirection peut être enregistrée par le navigateur.| -|302 (default)|Redirection temporaire. La redirection doit être revalidée à chaque requête par le navigateur.| -|303|Comme le 302 et force l'utilisation de la méthode HTTP GET.| -|307|Comme le 302 et force la ré-utilisation de la même méthode HTTP (GET, POST, ...).| -|308|Comme le 301 et force la ré-utilisation de la même méthode HTTP (GET, POST, ...).| +| Code de status | Description | +| :--- | :--- | +| 301 | Redirection permanente. La redirection peut être enregistrée par le navigateur. | +| 302 (default) | Redirection temporaire. La redirection doit être revalidée à chaque requête par le navigateur. | +| 303 | Comme le 302 et force l'utilisation de la méthode HTTP GET. | +| 307 | Comme le 302 et force la ré-utilisation de la même méthode HTTP (GET, POST, etc.). | +| 308 | Comme le 301 et force la ré-utilisation de la même méthode HTTP (GET, POST, etc.). | L'URL de destination peut contenir des variables simples. Cela permet de rediriger simplement vers un autre domaine, un autre protocole ou ajouter un suffixe / préfixe à une URL. Les variables reconnues sont : -|Variable|Description| -|---|---| -|`protocol`|Protocole de la requête ("http" ou "https")| -|`domain`|Nom de domaine de la requête, sans le numéro de port| -|`host`|Champ "Host" de la requête, incluant le numéro de port s'il y en a un| -|`port`|Port de la requête| -|`path`|Chemin de la requête, commence par un '/' et finit avant le premier '?'| -|`arguments`|Arguments de la requête, commence par le '?' si présent| +| Variable | Description | +| :--- | :--- | +| `protocol` | Protocole de la requête ("http" ou "https") | +| `domain` | Nom de domaine de la requête, sans le numéro de port | +| `host` | Champ "Host" de la requête, incluant le numéro de port s'il y en a un | +| `port` | Port de la requête | +| `path` | Chemin de la requête, commence par un '/' et finit avant le premier '?' | +| `arguments` | Arguments de la requête, commence par le '?' si présent | Par exemple, pour : -- rediriger vers https : `https://${host}${path}${arguments}` -- rediriger vers un nouveau domaine : ${protocol}://new.example.com${path}${arguments} -- préfixer l'url: ${protocol}://${host}/staging${path}${arguments} +- rediriger vers https : `https://\${host}\${path}\${arguments}` +- rediriger vers un nouveau domaine : `${protocol}://new.example.com\${path}\${arguments}` +- préfixer l'url: `${protocol}://\${host}/staging\${path}\${arguments}` ##### **Rejet** -Cette action renvoie un code d'état HTTP d'erreur au visiteur. Le code d'erreur HTTP peut être configuré avec le champ status. Lorsque cette action est sélectionnée, aucune ferme ne recevra la requête. +Cette action renvoie un code d'état HTTP d'erreur au visiteur. Le code d'erreur HTTP peut être configuré avec le champ `status`. Lorsque cette action est sélectionnée, aucune ferme ne recevra la requête. -|Paramètre|Valeur| -|---|---| -|type|`reject`| -|status|200, 400, 403, 405, 408, 429, 500, 502, 503 ou 504| -|target|non disponible| +| Paramètre | Valeur | +| :--- | :--- | +| type | `reject` | +| status | 200, 400, 403, 405, 408, 429, 500, 502, 503 ou 504 | +| target | non disponible | > [!primary] > -> Cette action est aussi disponible en TCP. Dans ce cas, le paramètre status n'est pas disponible et la requête est terminée. Les requêtes TCP terminées de cette manière ne sont pas comptabilisées dans le débit de requêtes. -> +> Cette action est aussi disponible en TCP. Dans ce cas, le paramètre `status` n'est pas disponible et la requête est terminée. Les requêtes TCP terminées de cette manière ne sont pas comptabilisées dans le débit de requêtes. +> Seuls les codes d'erreur HTTP listés dans l'API peuvent être spécifiés. Les plus courants sont les codes 400 "Bad request" et 403 "Forbidden". 200 peut être utilisé pour bloquer un type de requête tout en simulant un succès et 503 peut être utilisé pour simuler une panne serveur. -|Code de status|Description| -|---|---| -|200|La requête a été exécutée avec succès.| -|400|Requête invalide.| -|403 (default)|Accès interdit.| -|405|Méthode (GET, POST, PUT, ...) invalide ou non gérée.| -|408|La requête a pris trop de temps à être envoyée par le client.| -|429|La client a envoyé trop de requêtes (rate-limiting).| -|500|Erreur serveur générique.| -|502|Erreur de communication avec le serveur.| -|503|Le service est temporairement indisponible.| -|504|Le serveur a mis trop de temps à répondre.| +| Code de status | Description | +| :--- | :--- | +| 200 | La requête a été exécutée avec succès. | +| 400 | Requête invalide. | +| 403 (default) | Accès interdit. | +| 405 | Méthode (GET, POST, PUT, etc.) invalide ou non gérée. | +| 408 | La requête a pris trop de temps à être envoyée par le client. | +| 429 | Le client a envoyé trop de requêtes (rate-limiting). | +| 500 | Erreur serveur générique. | +| 502 | Erreur de communication avec le serveur. | +| 503 | Le service est temporairement indisponible. | +| 504 | Le serveur a mis trop de temps à répondre. | ##### **Routage** Cette action dirige les requêtes vers une ferme spécifique, autre que la ferme par défaut configurée sur le frontend. La ferme de destination doit être du même type que le frontend ("http" ou "tcp"). -|Paramètre|Valeur| -|---|---| -|type|`farm`| -|status|non disponible| -|target|Identifiant numérique de la ferme de destination. Celle-ci doit être du même type| +| Paramètre | Valeur | +| :--- | :--- | +| type | `farm` | +| status | non disponible | +| target | Identifiant numérique de la ferme de destination. Celle-ci doit être du même type | > [!primary] > > Cette action est aussi disponible en TCP. Dans ce cas, la ferme de destination doit être de type "tcp". -> +> #### Règles disponibles @@ -737,64 +740,64 @@ Si un champ est "null", cela signifie qu'aucune valeur n'est attendue. Si une va > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteRules -> +> - Requête : -|Paramètre|Signification| -|---|---| -|serviceName|Identifiant de votre service Load Balancer| +| Paramètre | Signification | +| :--- | :--- | +| serviceName | Identifiant de votre service Load Balancer | - Réponse : -|Paramètre|Signification| -|---|---| -|type|Type de protocole de la route: "tcp" pour les routes TCP, "http" pour les routes HTTP| -|name|Nom de la propriété sur laquelle s'applique cette règle, à renseigner dans le champ `field`| -|hasSubField|"true" si cette propriété a une "sous propriété" (par exemple : un en-tête ou un cookie)| -|matches|Liste des comparateurs disponibles pour cette règle, à renseigner dans le champ `match`| -|pattern|Type de valeur attendue pour le champ `pattern`| -|enum|Liste des valeurs possibles pour le champ `pattern` si celui-ci est une énumération| +| Paramètre | Signification | +| :--- | :--- | +| type | Type de protocole de la route: "tcp" pour les routes TCP, "http" pour les routes HTTP | +| name | Nom de la propriété sur laquelle s'applique cette règle, à renseigner dans le champ `field` | +| hasSubField | "true" si cette propriété a une "sous propriété" (par exemple : un en-tête ou un cookie) | +| matches | Liste des comparateurs disponibles pour cette règle, à renseigner dans le champ `match` | +| pattern | Type de valeur attendue pour le champ `pattern` | +| enum | Liste des valeurs possibles pour le champ `pattern` si celui-ci est une énumération | Les différents types de `pattern` sont : -|Valeur|Signification| -|---|---| -|cidr|Adresse IP (a.b.c.d) ou sous-réseau (a.b.c.d/z)| -|string|Texte libre. Pour l'opérateur `in`, liste de valeurs séparées par des virgules (255 caractères maximum)| -|enum|Le champ est une énumération définie dans `enum`| +| Valeur | Signification | +| :--- | :--- | +| cidr | Adresse IP (a.b.c.d) ou sous-réseau (a.b.c.d/z) | +| string | Texte libre. Pour l'opérateur `in`, liste de valeurs séparées par des virgules (255 caractères maximum) | +| enum | Le champ est une énumération définie dans `enum` | ##### **Protocole** Cette règle permet de filtrer les requêtes en fonction de leur protocole. Dans la pratique, les cas d'usage de cette règle sont assez limités car le protocole dépend du frontend auquel la route est attachée or un frontend ne gère qu'un seul protocole qui est alors connu au moment de la définition de la route. -|Champ|Valeur| -|---|---| -|name|`protocol`| -|hasSubField|non| -|matches|`is` ou `in`| -|pattern|`tcp`, `tls`, `http` ou `https`| +| Champ | Valeur | +| :--- | :--- | +| name | `protocol` | +| hasSubField | non | +| matches | `is` ou `in` | +| pattern | `tcp`, `tls`, `http` ou `https` | > [!primary] > > Cette action est aussi disponible en TCP. Dans ce cas, le protocole "http/2.0" est également disponible. Il se base sur le champ SSL/TLS "ALPN" utilisé par les navigateurs pour annoncer qu'ils tentent d'établir une connexion HTTP/2.0. Cela permet d'avoir un frontend TCP commun pour la terminaison SSL/TLS du HTTP 1 et 2 puis diriger ces flux en fonction de la version du protocole. -> +> ##### **Adresse source** Cette règle permet de filtrer les requêtes en fonction de leur adresse source. En la combinant avec une règle basée sur l'URI ou le nom de domaine, cela permet par exemple de restreindre certaines ressources à un proxy d'entreprise, tout en exposant toutes les autres ressources sans restrictions au niveau de votre service OVHcloud Load Balancer. -|Champ|Valeur| -|---|---| -|name|`source`| -|hasSubField|non| -|matches|`is` ou `in`| -|pattern|Sous-réseau (a.b.c.d/z) ou adresse (a.b.c.d)| +| Champ | Valeur | +| :--- | :--- | +| name | `source` | +| hasSubField | non | +| matches | `is` ou `in` | +| pattern | Sous-réseau (a.b.c.d/z) ou adresse (a.b.c.d) | > [!primary] > > Cette action est aussi disponible en TCP avec le même comportement. -> +> Par exemple, pour bloquer un réseau et une adresse en particulier, on pourra utiliser un pattern tel que "4.4.0.0/16, 8.8.8.8". @@ -802,73 +805,73 @@ Par exemple, pour bloquer un réseau et une adresse en particulier, on pourra ut Cette règle permet de filtrer les requêtes en fonction de leur nom de domaine. Cela permet par exemple de reproduire la fonction "vhost" de Apache ou router l'ensemble des domaines commençant par "mail." vers un serveur dédié au webmail. -|Champ|Valeur| -|---|---| -|name|`host`| -|hasSubField|non| -|matches|`is`, `in`, `contains`, `startswith`, `endswith` ou `matches`| -|pattern|Chaîne de caractères ou expression régulière| +| Champ | Valeur | +| :--- | :--- | +| name | `host` | +| hasSubField | non | +| matches | `is`, `in`, `contains`, `startswith`, `endswith` ou `matches` | +| pattern | Chaîne de caractères ou expression régulière | > [!primary] > > Cette action est aussi disponible en TCP. Elle n'aura de sens que si le frontend est configuré pour accepter des connexions SSL/TLS et que le client envoie une option "SNI". C'est notamment le cas des navigateurs web récents. -> +> ##### **Méthode HTTP** Cette règle permet de filtrer les requêtes en fonction de la méthode HTTP. Elle sera communément utilisée de paire avec une règle basée sur l'URI ou chemin de la requête pour rendre la règle plus sélective. -|Champ|Valeur| -|---|---| -|name|`method`| -|hasSubField|non| -|matches|`is` ou `in`| -|pattern|`GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS` ou `TRACE`| +| Champ | Valeur | +| :--- | :--- | +| name | `method` | +| hasSubField | non | +| matches | `is` ou `in` | +| pattern | `GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS` ou `TRACE` | ##### **Chemin de la requête** Cette règle permet de filtrer les requêtes en fonction du chemin de la requête ou URI. Le chemin de la requête est la portion comprise entre le 1er '/' inclus et le premier '?' exclu. -|Champ|Valeur| -|---|---| -|name|`uri`| -|hasSubField|non| -|matches|`is`, `in`, `contains`, `startswith`, `endswith` ou `matches`| -|pattern|Chaîne de caractères ou expression régulière| +| Champ | Valeur | +| :--- | :--- | +| name | `uri` | +| hasSubField | non | +| matches | `is`, `in`, `contains`, `startswith`, `endswith` ou `matches` | +| pattern | Chaîne de caractères ou expression régulière | ##### **Paramètre de la requête** Cette règle permet de filtrer les requêtes en fonction de l'existence ou de la valeur d'un paramètre spécifique de la requête HTTP. Il s'agit de la partie après le premier '?'. Si un paramètre est spécifié plusieurs fois dans la requête, seul le premier est pris en compte. -|Champ|Valeur| -|---|---| -|name|`param`| -|hasSubField|oui| -|matches|`is`, `in`, `contains`, `startswith`, `endswith` ou `matches`| -|pattern|Chaîne de caractères ou expression régulière| +| Champ | Valeur | +| :--- | :--- | +| name | `param` | +| hasSubField | oui | +| matches | `is`, `in`, `contains`, `startswith`, `endswith` ou `matches` | +| pattern | Chaîne de caractères ou expression régulière | ##### **En-tête HTTP** Cette règle permet de filtrer les requêtes en fonction de l'existence ou de la valeur d'un en-tête HTTP spécifique. Cela permet par exemple de détecter l'ouverture d'une connexion websocket et la diriger vers une ferme dédiée. -|Champ|Valeur| -|---|---| -|name|`header`| -|hasSubField|oui| -|matches|`is`, `in`, `contains`, `startswith`, `endswith` ou `matches`| -|pattern|Chaîne de caractères ou expression régulière| +| Champ | Valeur | +| :--- | :--- | +| name | `header` | +| hasSubField | oui | +| matches | `is`, `in`, `contains`, `startswith`, `endswith` ou `matches` | +| pattern | Chaîne de caractères ou expression régulière | ##### **Cookie** Cette règle permet de filtrer les requêtes en fonction de l'existence ou de la valeur d'un cookie HTTP spécifique. Cela permet par exemple de diriger les visiteurs volontaires vers une ferme de préproduction. -|Champ|Valeur| -|---|---| -|name|`cookie`| -|hasSubField|oui| -|matches|`is`, `in`, `contains`, `startswith`, `endswith` ou `matches`| -|pattern|Chaîne de caractères ou expression régulière| +| Champ | Valeur | +| :--- | :--- | +| name | `cookie` | +| hasSubField | oui | +| matches | `is`, `in`, `contains`, `startswith`, `endswith` ou `matches` | +| pattern | Chaîne de caractères ou expression régulière | ## Aller plus loin -Échangez avec notre [communauté d'utilisateurs](/links/community). +Échangez avec notre [communauté d'utilisateurs](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_stickiness/guide.en-asia.md b/pages/network/load_balancer/create_stickiness/guide.en-asia.md index 50e22e881ac..f3bbe768831 100644 --- a/pages/network/load_balancer/create_stickiness/guide.en-asia.md +++ b/pages/network/load_balancer/create_stickiness/guide.en-asia.md @@ -1,72 +1,70 @@ --- -title: 'Tracking connections' -excerpt: 'This guide will show you a number of ways you can track connections on the OVH Load Balancer.' -updated: 2021-02-05 +title: 'Tracking connections on the OVHcloud Load Balancer' +excerpt: 'This guide explores the methods available for tracking connections on the OVHcloud Load Balancer.' +updated: 2025-11-27 --- ## Objective -The [OVH Load Balancer](https://www.ovh.com/asia/solutions/load-balancer/) service offers a number of ways of tracking connections to your services. +The [OVHcloud Load Balancer](/links/network/load-balancer) service offers several methods for **tracking connections** (also known as *session persistence* or *stickiness*) to your services. -Each session on the OVH Load Balancer service is maintained by a persistent connection system. The system is configured on the application layer of the OVH Load Balancer service, and it maintains a persistent connection to the server. +Each session on the OVHcloud Load Balancer service is maintained by a persistent connection system. This system is configured at the **application layer** of the OVHcloud Load Balancer service to ensure persistent connections to the server. -This guide provides an introduction to the ways in which you can configure these options for the OVH Load Balancer. - -**This guide will show you a number of ways you can configure this option on the OVH Load Balancer.** +**This guide provides different methods to configure connection tracking for the OVHcloud Load Balancer.** ## Requirements -- an [OVH Load Balancer](https://www.ovh.com/asia/solutions/load-balancer/) -- access to the [OVH Control Panel](/links/manager), or the [OVH API](/links/api) +- An [OVHcloud Load Balancer](/links/network/load-balancer) +- Access to the [OVHcloud Control Panel](/links/manager), or +- Access to the [OVHcloud API](/links/api) ## Instructions -### The different types of connection tracking. +### The different types of connection tracking -There are two main connection tracking methods that can be configured on your services: +There are two primary connection tracking methods that can be configured for your services: -|Tracking connections|Details| +|Tracking method|Details| |---|---| -|Cookie|Configures a session cookie, which will be used to distribute traffic from a single HTTP session to the same server in the farm.| -|SourceIp|A hash algorithm will be applied to the source IP address of the request received by the OVH Load Balancer. +|Cookie|Configures a session cookie, which is used to distribute traffic from a single HTTP session to the same server in the farm.| +|SourceIp|A hash algorithm is applied to the source IP address of the request received by the OVHcloud Load Balancer. This ensures the same client IP is consistently routed to the same server.| The following elements will affect traffic redirection: -- if the configured weight changes +- if the configured server weight changes - if a server in the farm is re-enabled - if a server in the farm is no longer responding > [!warning] > -> Once you have refreshed your configuration, the connections will be rebalanced, and your HTTP sessions will be lost as a result. +> Once you have applied your configuration, existing connections will be rebalanced, and their associated HTTP sessions will be lost. > -### Modify a server farm’s connection tracking method via the OVH Control Panel. +### Modify a server farm’s connection tracking method via the OVHcloud Control Panel -To modify connection tracking for a farm, you need to edit it by going to the `Server clusters`{.action} section (*1* on the screenshot below), then click the `...`{.action} edit button (*2* on the screenshot below) for the farm you want to edit, and click `Edit`{.action} (*3* on the screenshot below): +To modify connection tracking for a server farm, navigate to the `Server clusters`{.action} tab, then click the options button `...`{.action} to the right of the desired farm and select `Edit`{.action}: -![Modify a farm](images/farm_edit.png){.thumbnail} +![Modify a farm](images/farm_edit-2022.png){.thumbnail} -In the `Advanced settings`, you will be able to access the `Track session` section: +In the `Advanced settings`{.action} section, you will be able to access the `Track session`{.action} section: -![Modifying connection tracking](images/tracking_session.png){.thumbnail} +![Modifying connection tracking](images/tracking_session-2022.png){.thumbnail} -Once you have configured the farm, click `Add`{.action} or `Edit`{.action}, depending on whether you are configuring a new or existing farm. -Please remember to deploy the configuration. +Once you have configured the farm, click `Add`{.action} or `Edit`{.action}, depending on whether you are configuring a new or modifying an existing farm. -There are two ways of doing this: +Please remember to deploy the configuration afterward. There are two ways to do so: -- via the `Status`{.action} section of the OVH Control Panel, by clicking on your Load Balancer’s `...`{.action} button, then selecting `Apply configuration`{.action} +- via the `Status`{.action} section of the Control Panel, by clicking on your Load Balancer’s `...`{.action} button, then selecting `Apply configuration`{.action} -- via the reminder box in the OVH Control Panel, notifying you that the configuration has not been applied, by clicking `Apply configuration`{.action} +- via the reminder box in the Control Panel, notifying you that the configuration has not been applied, by clicking `Apply configuration`{.action} -![Apply a Load Balancer configuration](images/apply_configuration.png){.thumbnail} +![Apply a Load Balancer configuration](images/apply_configuration-2022.png){.thumbnail} -### Modify a server farm’s connection tracking method via the API. +### Modify a server farm’s connection tracking method via the API -#### View details on a server farm. +#### View details on a server farm -With this call instruction, you can view details on a server farm if you know its ID. In this example, we will work on a HTTP farm. +This API call allows you to view details for a server farm if you know its ID. For this example, we will work on an HTTP farm. > [!api] > @@ -75,22 +73,22 @@ With this call instruction, you can view details on a server farm if you know it |Setting|Meaning| |---|---| -|serviceName*|Your Load Balancer service ID| -|farmId*|The farm’s ID number| +|serviceName*|The ID of your Load Balancer service| +|farmId*|The ID number of the farm| |Response (BackendHttp)|Meaning| |---|---| -|farmId|The farm’s ID number| -|balance|Balance type currently enabled for the farm| +|farmId|The ID number of the farm| +|balance|Load balancing algorithm currently enabled for the farm| |zone|Name of the zone in which the farm is configured| -|port|Port used to contact the servers configured on the farm| -|probe|Type of probe currently configured on the farm| -|displayName|Name given to this farm| +|port|Port used to contact the backend servers configured on the farm| +|probe|Type of health probe currently configured on the farm| +|displayName|User-friendly name given to this farm| |stickiness|Connection tracking method currently set for the farm| -#### Modify a server farm’s connection tracking method. +#### Modify a server farm’s connection tracking method -With this call instruction, you can edit the settings of a server farm if you know its ID. In this example, we will work on a HTTP farm. To modify the tracking method, the BackendHttp.stickiness field must be updated with an available connection tracking method: +This API call allows you to edit the settings of a server farm if you know its ID. In this example, we will work on an HTTP farm. To modify the tracking method, the `BackendHttp.stickiness` field must be updated with an available connection tracking method: > [!api] > @@ -99,11 +97,13 @@ With this call instruction, you can edit the settings of a server farm if you kn |Setting|Meaning| |---|---| -|serviceName*|Your Load Balancer service ID| -|farmId*|The farm’s ID number| -|BackendHttp.stickiness|Connection tracking method chosen for the farm| +|serviceName*|The ID of your Load Balancer service| +|farmId*|The ID number of the farm| +|BackendHttp.stickiness|The connection tracking method chosen for the farm| + +#### Apply the modifications -#### Apply the modifications. +This API call is required to deploy the configuration changes to the Load Balancer service. > [!api] > @@ -112,9 +112,9 @@ With this call instruction, you can edit the settings of a server farm if you kn |Setting|Meaning| |---|---| -|serviceName*|Your Load Balancer service ID| -|zone|Name of the zone in which to deploy the configuration, e.g. "all" or "rbx"| +|serviceName*|The ID of your Load Balancer service| +|zone|Name of the zone in which to deploy the configuration (e.g. "all" or "rbx")| ## Go further -Join our community of users on . +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_stickiness/guide.en-au.md b/pages/network/load_balancer/create_stickiness/guide.en-au.md index 52c5ef70501..f3bbe768831 100644 --- a/pages/network/load_balancer/create_stickiness/guide.en-au.md +++ b/pages/network/load_balancer/create_stickiness/guide.en-au.md @@ -1,72 +1,70 @@ --- -title: 'Tracking connections' -excerpt: 'This guide will show you a number of ways you can track connections on the OVH Load Balancer.' -updated: 2021-02-05 +title: 'Tracking connections on the OVHcloud Load Balancer' +excerpt: 'This guide explores the methods available for tracking connections on the OVHcloud Load Balancer.' +updated: 2025-11-27 --- ## Objective -The [OVH Load Balancer](https://www.ovh.com/world/solutions/load-balancer/) service offers a number of ways of tracking connections to your services. +The [OVHcloud Load Balancer](/links/network/load-balancer) service offers several methods for **tracking connections** (also known as *session persistence* or *stickiness*) to your services. -Each session on the OVH Load Balancer service is maintained by a persistent connection system. The system is configured on the application layer of the OVH Load Balancer service, and it maintains a persistent connection to the server. +Each session on the OVHcloud Load Balancer service is maintained by a persistent connection system. This system is configured at the **application layer** of the OVHcloud Load Balancer service to ensure persistent connections to the server. -This guide provides an introduction to the ways in which you can configure these options for the OVH Load Balancer. - -**This guide will show you a number of ways you can configure this option on the OVH Load Balancer.** +**This guide provides different methods to configure connection tracking for the OVHcloud Load Balancer.** ## Requirements -- an [OVH Load Balancer](https://www.ovh.com.au/solutions/load-balancer/) -- access to the [OVH Control Panel](/links/manager), or the [OVH API](/links/api) +- An [OVHcloud Load Balancer](/links/network/load-balancer) +- Access to the [OVHcloud Control Panel](/links/manager), or +- Access to the [OVHcloud API](/links/api) ## Instructions -### The different types of connection tracking. +### The different types of connection tracking -There are two main connection tracking methods that can be configured on your services: +There are two primary connection tracking methods that can be configured for your services: -|Tracking connections|Details| +|Tracking method|Details| |---|---| -|Cookie|Configures a session cookie, which will be used to distribute traffic from a single HTTP session to the same server in the farm.| -|SourceIp|A hash algorithm will be applied to the source IP address of the request received by the OVH Load Balancer. +|Cookie|Configures a session cookie, which is used to distribute traffic from a single HTTP session to the same server in the farm.| +|SourceIp|A hash algorithm is applied to the source IP address of the request received by the OVHcloud Load Balancer. This ensures the same client IP is consistently routed to the same server.| The following elements will affect traffic redirection: -- if the configured weight changes +- if the configured server weight changes - if a server in the farm is re-enabled - if a server in the farm is no longer responding > [!warning] > -> Once you have refreshed your configuration, the connections will be rebalanced, and your HTTP sessions will be lost as a result. +> Once you have applied your configuration, existing connections will be rebalanced, and their associated HTTP sessions will be lost. > -### Modify a server farm’s connection tracking method via the OVH Control Panel. +### Modify a server farm’s connection tracking method via the OVHcloud Control Panel -To modify connection tracking for a farm, you need to edit it by going to the `Server clusters`{.action} section (*1* on the screenshot below), then click the `...`{.action} edit button (*2* on the screenshot below) for the farm you want to edit, and click `Edit`{.action} (*3* on the screenshot below): +To modify connection tracking for a server farm, navigate to the `Server clusters`{.action} tab, then click the options button `...`{.action} to the right of the desired farm and select `Edit`{.action}: -![Modify a farm](images/farm_edit.png){.thumbnail} +![Modify a farm](images/farm_edit-2022.png){.thumbnail} -In the `Advanced settings`, you will be able to access the `Track session` section: +In the `Advanced settings`{.action} section, you will be able to access the `Track session`{.action} section: -![Modifying connection tracking](images/tracking_session.png){.thumbnail} +![Modifying connection tracking](images/tracking_session-2022.png){.thumbnail} -Once you have configured the farm, click `Add`{.action} or `Edit`{.action}, depending on whether you are configuring a new or existing farm. -Please remember to deploy the configuration. +Once you have configured the farm, click `Add`{.action} or `Edit`{.action}, depending on whether you are configuring a new or modifying an existing farm. -There are two ways of doing this: +Please remember to deploy the configuration afterward. There are two ways to do so: -- via the `Status`{.action} section of the OVH Control Panel, by clicking on your Load Balancer’s `...`{.action} button, then selecting `Apply configuration`{.action} +- via the `Status`{.action} section of the Control Panel, by clicking on your Load Balancer’s `...`{.action} button, then selecting `Apply configuration`{.action} -- via the reminder box in the OVH Control Panel, notifying you that the configuration has not been applied, by clicking `Apply configuration`{.action} +- via the reminder box in the Control Panel, notifying you that the configuration has not been applied, by clicking `Apply configuration`{.action} -![Apply a Load Balancer configuration](images/apply_configuration.png){.thumbnail} +![Apply a Load Balancer configuration](images/apply_configuration-2022.png){.thumbnail} -### Modify a server farm’s connection tracking method via the API. +### Modify a server farm’s connection tracking method via the API -#### View details on a server farm. +#### View details on a server farm -With this call instruction, you can view details on a server farm if you know its ID. In this example, we will work on a HTTP farm. +This API call allows you to view details for a server farm if you know its ID. For this example, we will work on an HTTP farm. > [!api] > @@ -75,22 +73,22 @@ With this call instruction, you can view details on a server farm if you know it |Setting|Meaning| |---|---| -|serviceName*|Your Load Balancer service ID| -|farmId*|The farm’s ID number| +|serviceName*|The ID of your Load Balancer service| +|farmId*|The ID number of the farm| |Response (BackendHttp)|Meaning| |---|---| -|farmId|The farm’s ID number| -|balance|Balance type currently enabled for the farm| +|farmId|The ID number of the farm| +|balance|Load balancing algorithm currently enabled for the farm| |zone|Name of the zone in which the farm is configured| -|port|Port used to contact the servers configured on the farm| -|probe|Type of probe currently configured on the farm| -|displayName|Name given to this farm| +|port|Port used to contact the backend servers configured on the farm| +|probe|Type of health probe currently configured on the farm| +|displayName|User-friendly name given to this farm| |stickiness|Connection tracking method currently set for the farm| -#### Modify a server farm’s connection tracking method. +#### Modify a server farm’s connection tracking method -With this call instruction, you can edit the settings of a server farm if you know its ID. In this example, we will work on a HTTP farm. To modify the tracking method, the BackendHttp.stickiness field must be updated with an available connection tracking method: +This API call allows you to edit the settings of a server farm if you know its ID. In this example, we will work on an HTTP farm. To modify the tracking method, the `BackendHttp.stickiness` field must be updated with an available connection tracking method: > [!api] > @@ -99,11 +97,13 @@ With this call instruction, you can edit the settings of a server farm if you kn |Setting|Meaning| |---|---| -|serviceName*|Your Load Balancer service ID| -|farmId*|The farm’s ID number| -|BackendHttp.stickiness|Connection tracking method chosen for the farm| +|serviceName*|The ID of your Load Balancer service| +|farmId*|The ID number of the farm| +|BackendHttp.stickiness|The connection tracking method chosen for the farm| + +#### Apply the modifications -#### Apply the modifications. +This API call is required to deploy the configuration changes to the Load Balancer service. > [!api] > @@ -112,9 +112,9 @@ With this call instruction, you can edit the settings of a server farm if you kn |Setting|Meaning| |---|---| -|serviceName*|Your Load Balancer service ID| -|zone|Name of the zone in which to deploy the configuration, e.g. "all" or "rbx"| +|serviceName*|The ID of your Load Balancer service| +|zone|Name of the zone in which to deploy the configuration (e.g. "all" or "rbx")| ## Go further -Join our community of users on . +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_stickiness/guide.en-ca.md b/pages/network/load_balancer/create_stickiness/guide.en-ca.md index 8c0fcf2cb20..f3bbe768831 100644 --- a/pages/network/load_balancer/create_stickiness/guide.en-ca.md +++ b/pages/network/load_balancer/create_stickiness/guide.en-ca.md @@ -1,72 +1,70 @@ --- -title: 'Tracking connections' -excerpt: 'This guide will show you a number of ways you can track connections on the OVH Load Balancer.' -updated: 2021-02-05 +title: 'Tracking connections on the OVHcloud Load Balancer' +excerpt: 'This guide explores the methods available for tracking connections on the OVHcloud Load Balancer.' +updated: 2025-11-27 --- ## Objective -The [OVH Load Balancer](https://www.ovh.com/ca/en/solutions/load-balancer/) service offers a number of ways of tracking connections to your services. +The [OVHcloud Load Balancer](/links/network/load-balancer) service offers several methods for **tracking connections** (also known as *session persistence* or *stickiness*) to your services. -Each session on the OVH Load Balancer service is maintained by a persistent connection system. The system is configured on the application layer of the OVH Load Balancer service, and it maintains a persistent connection to the server. +Each session on the OVHcloud Load Balancer service is maintained by a persistent connection system. This system is configured at the **application layer** of the OVHcloud Load Balancer service to ensure persistent connections to the server. -This guide provides an introduction to the ways in which you can configure these options for the OVH Load Balancer. - -**This guide will show you a number of ways you can configure this option on the OVH Load Balancer.** +**This guide provides different methods to configure connection tracking for the OVHcloud Load Balancer.** ## Requirements -- an [OVH Load Balancer](https://www.ovh.com/ca/en/solutions/load-balancer/) -- access to the [OVH Control Panel](/links/manager), or the [OVH API](/links/api) +- An [OVHcloud Load Balancer](/links/network/load-balancer) +- Access to the [OVHcloud Control Panel](/links/manager), or +- Access to the [OVHcloud API](/links/api) ## Instructions -### The different types of connection tracking. +### The different types of connection tracking -There are two main connection tracking methods that can be configured on your services: +There are two primary connection tracking methods that can be configured for your services: -|Tracking connections|Details| +|Tracking method|Details| |---|---| -|Cookie|Configures a session cookie, which will be used to distribute traffic from a single HTTP session to the same server in the farm.| -|SourceIp|A hash algorithm will be applied to the source IP address of the request received by the OVH Load Balancer. +|Cookie|Configures a session cookie, which is used to distribute traffic from a single HTTP session to the same server in the farm.| +|SourceIp|A hash algorithm is applied to the source IP address of the request received by the OVHcloud Load Balancer. This ensures the same client IP is consistently routed to the same server.| The following elements will affect traffic redirection: -- if the configured weight changes +- if the configured server weight changes - if a server in the farm is re-enabled - if a server in the farm is no longer responding > [!warning] > -> Once you have refreshed your configuration, the connections will be rebalanced, and your HTTP sessions will be lost as a result. +> Once you have applied your configuration, existing connections will be rebalanced, and their associated HTTP sessions will be lost. > -### Modify a server farm’s connection tracking method via the OVH Control Panel. +### Modify a server farm’s connection tracking method via the OVHcloud Control Panel -To modify connection tracking for a farm, you need to edit it by going to the `Server clusters`{.action} section (*1* on the screenshot below), then click the `...`{.action} edit button (*2* on the screenshot below) for the farm you want to edit, and click `Edit`{.action} (*3* on the screenshot below): +To modify connection tracking for a server farm, navigate to the `Server clusters`{.action} tab, then click the options button `...`{.action} to the right of the desired farm and select `Edit`{.action}: -![Modify a farm](images/farm_edit.png){.thumbnail} +![Modify a farm](images/farm_edit-2022.png){.thumbnail} -In the `Advanced settings`, you will be able to access the `Track session` section: +In the `Advanced settings`{.action} section, you will be able to access the `Track session`{.action} section: -![Modifying connection tracking](images/tracking_session.png){.thumbnail} +![Modifying connection tracking](images/tracking_session-2022.png){.thumbnail} -Once you have configured the farm, click `Add`{.action} or `Edit`{.action}, depending on whether you are configuring a new or existing farm. -Please remember to deploy the configuration. +Once you have configured the farm, click `Add`{.action} or `Edit`{.action}, depending on whether you are configuring a new or modifying an existing farm. -There are two ways of doing this: +Please remember to deploy the configuration afterward. There are two ways to do so: -- via the `Status`{.action} section of the OVH Control Panel, by clicking on your Load Balancer’s `...`{.action} button, then selecting `Apply configuration`{.action} +- via the `Status`{.action} section of the Control Panel, by clicking on your Load Balancer’s `...`{.action} button, then selecting `Apply configuration`{.action} -- via the reminder box in the OVH Control Panel, notifying you that the configuration has not been applied, by clicking `Apply configuration`{.action} +- via the reminder box in the Control Panel, notifying you that the configuration has not been applied, by clicking `Apply configuration`{.action} -![Apply a Load Balancer configuration](images/apply_configuration.png){.thumbnail} +![Apply a Load Balancer configuration](images/apply_configuration-2022.png){.thumbnail} -### Modify a server farm’s connection tracking method via the API. +### Modify a server farm’s connection tracking method via the API -#### View details on a server farm. +#### View details on a server farm -With this call instruction, you can view details on a server farm if you know its ID. In this example, we will work on a HTTP farm. +This API call allows you to view details for a server farm if you know its ID. For this example, we will work on an HTTP farm. > [!api] > @@ -75,22 +73,22 @@ With this call instruction, you can view details on a server farm if you know it |Setting|Meaning| |---|---| -|serviceName*|Your Load Balancer service ID| -|farmId*|The farm’s ID number| +|serviceName*|The ID of your Load Balancer service| +|farmId*|The ID number of the farm| |Response (BackendHttp)|Meaning| |---|---| -|farmId|The farm’s ID number| -|balance|Balance type currently enabled for the farm| +|farmId|The ID number of the farm| +|balance|Load balancing algorithm currently enabled for the farm| |zone|Name of the zone in which the farm is configured| -|port|Port used to contact the servers configured on the farm| -|probe|Type of probe currently configured on the farm| -|displayName|Name given to this farm| +|port|Port used to contact the backend servers configured on the farm| +|probe|Type of health probe currently configured on the farm| +|displayName|User-friendly name given to this farm| |stickiness|Connection tracking method currently set for the farm| -#### Modify a server farm’s connection tracking method. +#### Modify a server farm’s connection tracking method -With this call instruction, you can edit the settings of a server farm if you know its ID. In this example, we will work on a HTTP farm. To modify the tracking method, the BackendHttp.stickiness field must be updated with an available connection tracking method: +This API call allows you to edit the settings of a server farm if you know its ID. In this example, we will work on an HTTP farm. To modify the tracking method, the `BackendHttp.stickiness` field must be updated with an available connection tracking method: > [!api] > @@ -99,11 +97,13 @@ With this call instruction, you can edit the settings of a server farm if you kn |Setting|Meaning| |---|---| -|serviceName*|Your Load Balancer service ID| -|farmId*|The farm’s ID number| -|BackendHttp.stickiness|Connection tracking method chosen for the farm| +|serviceName*|The ID of your Load Balancer service| +|farmId*|The ID number of the farm| +|BackendHttp.stickiness|The connection tracking method chosen for the farm| + +#### Apply the modifications -#### Apply the modifications. +This API call is required to deploy the configuration changes to the Load Balancer service. > [!api] > @@ -112,9 +112,9 @@ With this call instruction, you can edit the settings of a server farm if you kn |Setting|Meaning| |---|---| -|serviceName*|Your Load Balancer service ID| -|zone|Name of the zone in which to deploy the configuration, e.g. "all" or "rbx"| +|serviceName*|The ID of your Load Balancer service| +|zone|Name of the zone in which to deploy the configuration (e.g. "all" or "rbx")| ## Go further -Join our community of users on . +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_stickiness/guide.en-gb.md b/pages/network/load_balancer/create_stickiness/guide.en-gb.md index 3bff5c9dc92..f3bbe768831 100644 --- a/pages/network/load_balancer/create_stickiness/guide.en-gb.md +++ b/pages/network/load_balancer/create_stickiness/guide.en-gb.md @@ -1,72 +1,70 @@ --- -title: 'Tracking connections' -excerpt: 'This guide will show you a number of ways you can track connections on the OVH Load Balancer.' -updated: 2021-02-05 +title: 'Tracking connections on the OVHcloud Load Balancer' +excerpt: 'This guide explores the methods available for tracking connections on the OVHcloud Load Balancer.' +updated: 2025-11-27 --- ## Objective -The [OVH Load Balancer](/links/network/load-balancer) service offers a number of ways of tracking connections to your services. +The [OVHcloud Load Balancer](/links/network/load-balancer) service offers several methods for **tracking connections** (also known as *session persistence* or *stickiness*) to your services. -Each session on the OVH Load Balancer service is maintained by a persistent connection system. The system is configured on the application layer of the OVH Load Balancer service, and it maintains a persistent connection to the server. +Each session on the OVHcloud Load Balancer service is maintained by a persistent connection system. This system is configured at the **application layer** of the OVHcloud Load Balancer service to ensure persistent connections to the server. -This guide provides an introduction to the ways in which you can configure these options for the OVH Load Balancer. - -**This guide will show you a number of ways you can configure this option on the OVH Load Balancer.** +**This guide provides different methods to configure connection tracking for the OVHcloud Load Balancer.** ## Requirements -- an [OVH Load Balancer](/links/network/load-balancer) -- access to the [OVH Control Panel](/links/manager), or the [OVH API](/links/api) +- An [OVHcloud Load Balancer](/links/network/load-balancer) +- Access to the [OVHcloud Control Panel](/links/manager), or +- Access to the [OVHcloud API](/links/api) ## Instructions -### The different types of connection tracking. +### The different types of connection tracking -There are two main connection tracking methods that can be configured on your services: +There are two primary connection tracking methods that can be configured for your services: -|Tracking connections|Details| +|Tracking method|Details| |---|---| -|Cookie|Configures a session cookie, which will be used to distribute traffic from a single HTTP session to the same server in the farm.| -|SourceIp|A hash algorithm will be applied to the source IP address of the request received by the OVH Load Balancer. +|Cookie|Configures a session cookie, which is used to distribute traffic from a single HTTP session to the same server in the farm.| +|SourceIp|A hash algorithm is applied to the source IP address of the request received by the OVHcloud Load Balancer. This ensures the same client IP is consistently routed to the same server.| The following elements will affect traffic redirection: -- if the configured weight changes +- if the configured server weight changes - if a server in the farm is re-enabled - if a server in the farm is no longer responding > [!warning] > -> Once you have refreshed your configuration, the connections will be rebalanced, and your HTTP sessions will be lost as a result. +> Once you have applied your configuration, existing connections will be rebalanced, and their associated HTTP sessions will be lost. > -### Modify a server farm’s connection tracking method via the OVH Control Panel. +### Modify a server farm’s connection tracking method via the OVHcloud Control Panel -To modify connection tracking for a farm, you need to edit it by going to the `Server clusters`{.action} section (*1* on the screenshot below), then click the `...`{.action} edit button (*2* on the screenshot below) for the farm you want to edit, and click `Edit`{.action} (*3* on the screenshot below): +To modify connection tracking for a server farm, navigate to the `Server clusters`{.action} tab, then click the options button `...`{.action} to the right of the desired farm and select `Edit`{.action}: -![Modify a farm](images/farm_edit.png){.thumbnail} +![Modify a farm](images/farm_edit-2022.png){.thumbnail} -In the `Advanced settings`, you will be able to access the `Track session` section: +In the `Advanced settings`{.action} section, you will be able to access the `Track session`{.action} section: -![Modifying connection tracking](images/tracking_session.png){.thumbnail} +![Modifying connection tracking](images/tracking_session-2022.png){.thumbnail} -Once you have configured the farm, click `Add`{.action} or `Edit`{.action}, depending on whether you are configuring a new or existing farm. -Please remember to deploy the configuration. +Once you have configured the farm, click `Add`{.action} or `Edit`{.action}, depending on whether you are configuring a new or modifying an existing farm. -There are two ways of doing this: +Please remember to deploy the configuration afterward. There are two ways to do so: -- via the `Status`{.action} section of the OVH Control Panel, by clicking on your Load Balancer’s `...`{.action} button, then selecting `Apply configuration`{.action} +- via the `Status`{.action} section of the Control Panel, by clicking on your Load Balancer’s `...`{.action} button, then selecting `Apply configuration`{.action} -- via the reminder box in the OVH Control Panel, notifying you that the configuration has not been applied, by clicking `Apply configuration`{.action} +- via the reminder box in the Control Panel, notifying you that the configuration has not been applied, by clicking `Apply configuration`{.action} -![Apply a Load Balancer configuration](images/apply_configuration.png){.thumbnail} +![Apply a Load Balancer configuration](images/apply_configuration-2022.png){.thumbnail} -### Modify a server farm’s connection tracking method via the API. +### Modify a server farm’s connection tracking method via the API -#### View details on a server farm. +#### View details on a server farm -With this call instruction, you can view details on a server farm if you know its ID. In this example, we will work on a HTTP farm. +This API call allows you to view details for a server farm if you know its ID. For this example, we will work on an HTTP farm. > [!api] > @@ -75,22 +73,22 @@ With this call instruction, you can view details on a server farm if you know it |Setting|Meaning| |---|---| -|serviceName*|Your Load Balancer service ID| -|farmId*|The farm’s ID number| +|serviceName*|The ID of your Load Balancer service| +|farmId*|The ID number of the farm| |Response (BackendHttp)|Meaning| |---|---| -|farmId|The farm’s ID number| -|balance|Balance type currently enabled for the farm| +|farmId|The ID number of the farm| +|balance|Load balancing algorithm currently enabled for the farm| |zone|Name of the zone in which the farm is configured| -|port|Port used to contact the servers configured on the farm| -|probe|Type of probe currently configured on the farm| -|displayName|Name given to this farm| +|port|Port used to contact the backend servers configured on the farm| +|probe|Type of health probe currently configured on the farm| +|displayName|User-friendly name given to this farm| |stickiness|Connection tracking method currently set for the farm| -#### Modify a server farm’s connection tracking method. +#### Modify a server farm’s connection tracking method -With this call instruction, you can edit the settings of a server farm if you know its ID. In this example, we will work on a HTTP farm. To modify the tracking method, the BackendHttp.stickiness field must be updated with an available connection tracking method: +This API call allows you to edit the settings of a server farm if you know its ID. In this example, we will work on an HTTP farm. To modify the tracking method, the `BackendHttp.stickiness` field must be updated with an available connection tracking method: > [!api] > @@ -99,11 +97,13 @@ With this call instruction, you can edit the settings of a server farm if you kn |Setting|Meaning| |---|---| -|serviceName*|Your Load Balancer service ID| -|farmId*|The farm’s ID number| -|BackendHttp.stickiness|Connection tracking method chosen for the farm| +|serviceName*|The ID of your Load Balancer service| +|farmId*|The ID number of the farm| +|BackendHttp.stickiness|The connection tracking method chosen for the farm| + +#### Apply the modifications -#### Apply the modifications. +This API call is required to deploy the configuration changes to the Load Balancer service. > [!api] > @@ -112,9 +112,9 @@ With this call instruction, you can edit the settings of a server farm if you kn |Setting|Meaning| |---|---| -|serviceName*|Your Load Balancer service ID| -|zone|Name of the zone in which to deploy the configuration, e.g. "all" or "rbx"| +|serviceName*|The ID of your Load Balancer service| +|zone|Name of the zone in which to deploy the configuration (e.g. "all" or "rbx")| ## Go further -Join our community of users on . +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_stickiness/guide.en-sg.md b/pages/network/load_balancer/create_stickiness/guide.en-sg.md index f644520a1c2..f3bbe768831 100644 --- a/pages/network/load_balancer/create_stickiness/guide.en-sg.md +++ b/pages/network/load_balancer/create_stickiness/guide.en-sg.md @@ -1,72 +1,70 @@ --- -title: 'Tracking connections' -excerpt: 'This guide will show you a number of ways you can track connections on the OVH Load Balancer.' -updated: 2021-02-05 +title: 'Tracking connections on the OVHcloud Load Balancer' +excerpt: 'This guide explores the methods available for tracking connections on the OVHcloud Load Balancer.' +updated: 2025-11-27 --- ## Objective -The [OVH Load Balancer](https://www.ovh.com/sg/solutions/load-balancer/) service offers a number of ways of tracking connections to your services. +The [OVHcloud Load Balancer](/links/network/load-balancer) service offers several methods for **tracking connections** (also known as *session persistence* or *stickiness*) to your services. -Each session on the OVH Load Balancer service is maintained by a persistent connection system. The system is configured on the application layer of the OVH Load Balancer service, and it maintains a persistent connection to the server. +Each session on the OVHcloud Load Balancer service is maintained by a persistent connection system. This system is configured at the **application layer** of the OVHcloud Load Balancer service to ensure persistent connections to the server. -This guide provides an introduction to the ways in which you can configure these options for the OVH Load Balancer. - -**This guide will show you a number of ways you can configure this option on the OVH Load Balancer.** +**This guide provides different methods to configure connection tracking for the OVHcloud Load Balancer.** ## Requirements -- an [OVH Load Balancer](https://www.ovh.com/sg/solutions/load-balancer/) -- access to the [OVH Control Panel](/links/manager), or the [OVH API](/links/api) +- An [OVHcloud Load Balancer](/links/network/load-balancer) +- Access to the [OVHcloud Control Panel](/links/manager), or +- Access to the [OVHcloud API](/links/api) ## Instructions -### The different types of connection tracking. +### The different types of connection tracking -There are two main connection tracking methods that can be configured on your services: +There are two primary connection tracking methods that can be configured for your services: -|Tracking connections|Details| +|Tracking method|Details| |---|---| -|Cookie|Configures a session cookie, which will be used to distribute traffic from a single HTTP session to the same server in the farm.| -|SourceIp|A hash algorithm will be applied to the source IP address of the request received by the OVH Load Balancer. +|Cookie|Configures a session cookie, which is used to distribute traffic from a single HTTP session to the same server in the farm.| +|SourceIp|A hash algorithm is applied to the source IP address of the request received by the OVHcloud Load Balancer. This ensures the same client IP is consistently routed to the same server.| The following elements will affect traffic redirection: -- if the configured weight changes +- if the configured server weight changes - if a server in the farm is re-enabled - if a server in the farm is no longer responding > [!warning] > -> Once you have refreshed your configuration, the connections will be rebalanced, and your HTTP sessions will be lost as a result. +> Once you have applied your configuration, existing connections will be rebalanced, and their associated HTTP sessions will be lost. > -### Modify a server farm’s connection tracking method via the OVH Control Panel. +### Modify a server farm’s connection tracking method via the OVHcloud Control Panel -To modify connection tracking for a farm, you need to edit it by going to the `Server clusters`{.action} section (*1* on the screenshot below), then click the `...`{.action} edit button (*2* on the screenshot below) for the farm you want to edit, and click `Edit`{.action} (*3* on the screenshot below): +To modify connection tracking for a server farm, navigate to the `Server clusters`{.action} tab, then click the options button `...`{.action} to the right of the desired farm and select `Edit`{.action}: -![Modify a farm](images/farm_edit.png){.thumbnail} +![Modify a farm](images/farm_edit-2022.png){.thumbnail} -In the `Advanced settings`, you will be able to access the `Track session` section: +In the `Advanced settings`{.action} section, you will be able to access the `Track session`{.action} section: -![Modifying connection tracking](images/tracking_session.png){.thumbnail} +![Modifying connection tracking](images/tracking_session-2022.png){.thumbnail} -Once you have configured the farm, click `Add`{.action} or `Edit`{.action}, depending on whether you are configuring a new or existing farm. -Please remember to deploy the configuration. +Once you have configured the farm, click `Add`{.action} or `Edit`{.action}, depending on whether you are configuring a new or modifying an existing farm. -There are two ways of doing this: +Please remember to deploy the configuration afterward. There are two ways to do so: -- via the `Status`{.action} section of the OVH Control Panel, by clicking on your Load Balancer’s `...`{.action} button, then selecting `Apply configuration`{.action} +- via the `Status`{.action} section of the Control Panel, by clicking on your Load Balancer’s `...`{.action} button, then selecting `Apply configuration`{.action} -- via the reminder box in the OVH Control Panel, notifying you that the configuration has not been applied, by clicking `Apply configuration`{.action} +- via the reminder box in the Control Panel, notifying you that the configuration has not been applied, by clicking `Apply configuration`{.action} -![Apply a Load Balancer configuration](images/apply_configuration.png){.thumbnail} +![Apply a Load Balancer configuration](images/apply_configuration-2022.png){.thumbnail} -### Modify a server farm’s connection tracking method via the API. +### Modify a server farm’s connection tracking method via the API -#### View details on a server farm. +#### View details on a server farm -With this call instruction, you can view details on a server farm if you know its ID. In this example, we will work on a HTTP farm. +This API call allows you to view details for a server farm if you know its ID. For this example, we will work on an HTTP farm. > [!api] > @@ -75,22 +73,22 @@ With this call instruction, you can view details on a server farm if you know it |Setting|Meaning| |---|---| -|serviceName*|Your Load Balancer service ID| -|farmId*|The farm’s ID number| +|serviceName*|The ID of your Load Balancer service| +|farmId*|The ID number of the farm| |Response (BackendHttp)|Meaning| |---|---| -|farmId|The farm’s ID number| -|balance|Balance type currently enabled for the farm| +|farmId|The ID number of the farm| +|balance|Load balancing algorithm currently enabled for the farm| |zone|Name of the zone in which the farm is configured| -|port|Port used to contact the servers configured on the farm| -|probe|Type of probe currently configured on the farm| -|displayName|Name given to this farm| +|port|Port used to contact the backend servers configured on the farm| +|probe|Type of health probe currently configured on the farm| +|displayName|User-friendly name given to this farm| |stickiness|Connection tracking method currently set for the farm| -#### Modify a server farm’s connection tracking method. +#### Modify a server farm’s connection tracking method -With this call instruction, you can edit the settings of a server farm if you know its ID. In this example, we will work on a HTTP farm. To modify the tracking method, the BackendHttp.stickiness field must be updated with an available connection tracking method: +This API call allows you to edit the settings of a server farm if you know its ID. In this example, we will work on an HTTP farm. To modify the tracking method, the `BackendHttp.stickiness` field must be updated with an available connection tracking method: > [!api] > @@ -99,11 +97,13 @@ With this call instruction, you can edit the settings of a server farm if you kn |Setting|Meaning| |---|---| -|serviceName*|Your Load Balancer service ID| -|farmId*|The farm’s ID number| -|BackendHttp.stickiness|Connection tracking method chosen for the farm| +|serviceName*|The ID of your Load Balancer service| +|farmId*|The ID number of the farm| +|BackendHttp.stickiness|The connection tracking method chosen for the farm| + +#### Apply the modifications -#### Apply the modifications. +This API call is required to deploy the configuration changes to the Load Balancer service. > [!api] > @@ -112,9 +112,9 @@ With this call instruction, you can edit the settings of a server farm if you kn |Setting|Meaning| |---|---| -|serviceName*|Your Load Balancer service ID| -|zone|Name of the zone in which to deploy the configuration, e.g. "all" or "rbx"| +|serviceName*|The ID of your Load Balancer service| +|zone|Name of the zone in which to deploy the configuration (e.g. "all" or "rbx")| ## Go further -Join our community of users on . +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_stickiness/guide.en-us.md b/pages/network/load_balancer/create_stickiness/guide.en-us.md index ba1f010c776..f3bbe768831 100644 --- a/pages/network/load_balancer/create_stickiness/guide.en-us.md +++ b/pages/network/load_balancer/create_stickiness/guide.en-us.md @@ -1,72 +1,70 @@ --- -title: 'Tracking connections' -excerpt: 'This guide will show you a number of ways you can track connections on the OVH Load Balancer.' -updated: 2021-02-05 +title: 'Tracking connections on the OVHcloud Load Balancer' +excerpt: 'This guide explores the methods available for tracking connections on the OVHcloud Load Balancer.' +updated: 2025-11-27 --- ## Objective -The [OVH Load Balancer](https://www.ovh.com/world/solutions/load-balancer/) service offers a number of ways of tracking connections to your services. +The [OVHcloud Load Balancer](/links/network/load-balancer) service offers several methods for **tracking connections** (also known as *session persistence* or *stickiness*) to your services. -Each session on the OVH Load Balancer service is maintained by a persistent connection system. The system is configured on the application layer of the OVH Load Balancer service, and it maintains a persistent connection to the server. +Each session on the OVHcloud Load Balancer service is maintained by a persistent connection system. This system is configured at the **application layer** of the OVHcloud Load Balancer service to ensure persistent connections to the server. -This guide provides an introduction to the ways in which you can configure these options for the OVH Load Balancer. - -**This guide will show you a number of ways you can configure this option on the OVH Load Balancer.** +**This guide provides different methods to configure connection tracking for the OVHcloud Load Balancer.** ## Requirements -- an [OVH Load Balancer](https://www.ovh.com/world/solutions/load-balancer/) -- access to the [OVH Control Panel](/links/manager), or the [OVH API](/links/api) +- An [OVHcloud Load Balancer](/links/network/load-balancer) +- Access to the [OVHcloud Control Panel](/links/manager), or +- Access to the [OVHcloud API](/links/api) ## Instructions -### The different types of connection tracking. +### The different types of connection tracking -There are two main connection tracking methods that can be configured on your services: +There are two primary connection tracking methods that can be configured for your services: -|Tracking connections|Details| +|Tracking method|Details| |---|---| -|Cookie|Configures a session cookie, which will be used to distribute traffic from a single HTTP session to the same server in the farm.| -|SourceIp|A hash algorithm will be applied to the source IP address of the request received by the OVH Load Balancer. +|Cookie|Configures a session cookie, which is used to distribute traffic from a single HTTP session to the same server in the farm.| +|SourceIp|A hash algorithm is applied to the source IP address of the request received by the OVHcloud Load Balancer. This ensures the same client IP is consistently routed to the same server.| The following elements will affect traffic redirection: -- if the configured weight changes +- if the configured server weight changes - if a server in the farm is re-enabled - if a server in the farm is no longer responding > [!warning] > -> Once you have refreshed your configuration, the connections will be rebalanced, and your HTTP sessions will be lost as a result. +> Once you have applied your configuration, existing connections will be rebalanced, and their associated HTTP sessions will be lost. > -### Modify a server farm’s connection tracking method via the OVH Control Panel. +### Modify a server farm’s connection tracking method via the OVHcloud Control Panel -To modify connection tracking for a farm, you need to edit it by going to the `Server clusters`{.action} section (*1* on the screenshot below), then click the `...`{.action} edit button (*2* on the screenshot below) for the farm you want to edit, and click `Edit`{.action} (*3* on the screenshot below): +To modify connection tracking for a server farm, navigate to the `Server clusters`{.action} tab, then click the options button `...`{.action} to the right of the desired farm and select `Edit`{.action}: -![Modify a farm](images/farm_edit.png){.thumbnail} +![Modify a farm](images/farm_edit-2022.png){.thumbnail} -In the `Advanced settings`, you will be able to access the `Track session` section: +In the `Advanced settings`{.action} section, you will be able to access the `Track session`{.action} section: -![Modifying connection tracking](images/tracking_session.png){.thumbnail} +![Modifying connection tracking](images/tracking_session-2022.png){.thumbnail} -Once you have configured the farm, click `Add`{.action} or `Edit`{.action}, depending on whether you are configuring a new or existing farm. -Please remember to deploy the configuration. +Once you have configured the farm, click `Add`{.action} or `Edit`{.action}, depending on whether you are configuring a new or modifying an existing farm. -There are two ways of doing this: +Please remember to deploy the configuration afterward. There are two ways to do so: -- via the `Status`{.action} section of the OVH Control Panel, by clicking on your Load Balancer’s `...`{.action} button, then selecting `Apply configuration`{.action} +- via the `Status`{.action} section of the Control Panel, by clicking on your Load Balancer’s `...`{.action} button, then selecting `Apply configuration`{.action} -- via the reminder box in the OVH Control Panel, notifying you that the configuration has not been applied, by clicking `Apply configuration`{.action} +- via the reminder box in the Control Panel, notifying you that the configuration has not been applied, by clicking `Apply configuration`{.action} -![Apply a Load Balancer configuration](images/apply_configuration.png){.thumbnail} +![Apply a Load Balancer configuration](images/apply_configuration-2022.png){.thumbnail} -### Modify a server farm’s connection tracking method via the API. +### Modify a server farm’s connection tracking method via the API -#### View details on a server farm. +#### View details on a server farm -With this call instruction, you can view details on a server farm if you know its ID. In this example, we will work on a HTTP farm. +This API call allows you to view details for a server farm if you know its ID. For this example, we will work on an HTTP farm. > [!api] > @@ -75,22 +73,22 @@ With this call instruction, you can view details on a server farm if you know it |Setting|Meaning| |---|---| -|serviceName*|Your Load Balancer service ID| -|farmId*|The farm’s ID number| +|serviceName*|The ID of your Load Balancer service| +|farmId*|The ID number of the farm| |Response (BackendHttp)|Meaning| |---|---| -|farmId|The farm’s ID number| -|balance|Balance type currently enabled for the farm| +|farmId|The ID number of the farm| +|balance|Load balancing algorithm currently enabled for the farm| |zone|Name of the zone in which the farm is configured| -|port|Port used to contact the servers configured on the farm| -|probe|Type of probe currently configured on the farm| -|displayName|Name given to this farm| +|port|Port used to contact the backend servers configured on the farm| +|probe|Type of health probe currently configured on the farm| +|displayName|User-friendly name given to this farm| |stickiness|Connection tracking method currently set for the farm| -#### Modify a server farm’s connection tracking method. +#### Modify a server farm’s connection tracking method -With this call instruction, you can edit the settings of a server farm if you know its ID. In this example, we will work on a HTTP farm. To modify the tracking method, the BackendHttp.stickiness field must be updated with an available connection tracking method: +This API call allows you to edit the settings of a server farm if you know its ID. In this example, we will work on an HTTP farm. To modify the tracking method, the `BackendHttp.stickiness` field must be updated with an available connection tracking method: > [!api] > @@ -99,11 +97,13 @@ With this call instruction, you can edit the settings of a server farm if you kn |Setting|Meaning| |---|---| -|serviceName*|Your Load Balancer service ID| -|farmId*|The farm’s ID number| -|BackendHttp.stickiness|Connection tracking method chosen for the farm| +|serviceName*|The ID of your Load Balancer service| +|farmId*|The ID number of the farm| +|BackendHttp.stickiness|The connection tracking method chosen for the farm| + +#### Apply the modifications -#### Apply the modifications. +This API call is required to deploy the configuration changes to the Load Balancer service. > [!api] > @@ -112,9 +112,9 @@ With this call instruction, you can edit the settings of a server farm if you kn |Setting|Meaning| |---|---| -|serviceName*|Your Load Balancer service ID| -|zone|Name of the zone in which to deploy the configuration, e.g. "all" or "rbx"| +|serviceName*|The ID of your Load Balancer service| +|zone|Name of the zone in which to deploy the configuration (e.g. "all" or "rbx")| ## Go further -Join our community of users on . +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_stickiness/guide.fr-ca.md b/pages/network/load_balancer/create_stickiness/guide.fr-ca.md index 2c71161498d..33cc637a845 100644 --- a/pages/network/load_balancer/create_stickiness/guide.fr-ca.md +++ b/pages/network/load_balancer/create_stickiness/guide.fr-ca.md @@ -1,76 +1,70 @@ --- -title: Suivi de connexion -excerpt: Configuration -updated: 2021-02-05 +title: 'Suivi des connexions sur l’OVHcloud Load Balancer' +excerpt: 'Découvrez les méthodes disponibles pour suivre les connexions sur l’OVHcloud Load Balancer.' +updated: 2025-11-27 --- ## Objectif -Le service [Load Balancer OVH](https://www.ovh.com/ca/fr/solutions/load-balancer/) offre différents types de suivi de connexion pour vos services. +Le service [Load Balancer OVHcloud](/links/network/load-balancer) propose plusieurs méthodes pour le **suivi de connexion** (également appelé *persistence de session* ou *stickiness*) vers vos services. -Chaque session du service OVH Load Balancer est maintenue par un système de persistence de connexion. Ce dernier est configuré au niveau de la couche applicative du service OVH Load Balancer, c'est elle qui assure la persistence de la connexion vers le serveur. +Chaque session du service OVHcloud Load Balancer est maintenue par un système de persistence de connexion. Ce système est configuré au niveau de la **couche applicative** du service OVHcloud Load Balancer afin d'assurer la persistance de la connexion vers le serveur. -Cette documentation présente différentes façon de configurer cette options pour le Load Balancer OVH. - -**Ce guide présente différentes façon de configurer cette option pour le Load Balancer OVH.** +**Ce guide présente différentes façons de configurer le suivi de connexion pour le Load Balancer OVHcloud.** ## Prérequis -- Disposer d'un [Load Balancer OVH](https://www.ovh.com/ca/fr/solutions/load-balancer/). -- Avoir accès : - - à l'[espace client OVH](/links/manager), ou bien - - à l'[API OVH](/links/api). +- Disposer d'un [Load Balancer OVHcloud](/links/network/load-balancer). +- Avoir accès à l'[espace client OVHcloud](/links/manager), ou bien +- Avoir accès à l'[API OVHcloud](/links/api). ## En pratique ### Les différents types de suivi de connexion -Il existe 2 types principaux de suivi de connexion qui peuvent être configurés avec vos services : +Deux méthodes principales de suivi de connexion peuvent être configurées pour vos services : -|Suivi de connexion|Détails| +| Méthode de suivi | Détails | |---|---| -|Cookie|Configure un cookie de session qui sera utilisé pour toujours répartir le trafic d'une même session HTTP vers le même serveur dans la ferme| -|SourceIp|Un algorithme de hash sera appliqué sur l'adresse IP source de la requête reçue par le service OVH Load Balancer. +| Cookie | Configure un cookie de session, utilisé pour toujours répartir le trafic d'une même session HTTP vers le même serveur dans la ferme. | +| SourceIp | Un algorithme de hash est appliqué à l'adresse IP source de la requête reçue par l’OVHcloud Load Balancer. Cela garantit que la même adresse IP client est toujours dirigée vers le même serveur. | -Les éléments suivants auront un impact sur la redirection de trafic : +Les éléments suivants affecteront la redirection du trafic : -- le poids configuré change ; -- un serveur de la ferme se réactive ; -- un serveur de la ferme ne répond plus. +- le poids configuré change +- un serveur de la ferme se réactive +- un serveur de la ferme ne répond plus > [!warning] > -> Après un rafraichissement de votre configuration, les connexions seront re-balancées, vos sessions HTTP seront donc perdues. +> Après un rafraichissement de votre configuration, les connexions existantes seront rééquilibrées, vos sessions HTTP seront donc perdues. > -### Modifier le mode de suivi de connexion d'une ferme via l'espace client +### Modifier le mode de suivi de connexion d’une ferme via l’espace client OVHcloud + +Pour modifier le suivi de connexion d’une ferme, rendez-vous sur l’onglet `Ferme de serveurs`{.action}, puis cliquez sur le bouton `...`{.action} sur la droite de la ferme voulue et sélectionnez `Modifier`{.action} : -Pour modifier le suivi de connexion d'une ferme il faut éditer celle-ci en allant dans la section `Ferme de serveurs`{.action} (*1* sur l'impression écran ci-dessous) puis cliquer sur le bouton d'édition `...`{.action} (*2* sur l'impression écran ci-dessous) de la ferme voulue et faire `Modifier`{.action} (*3* sur l'impression écran ci-dessous) : +![Modifier une ferme](images/farm_edit-2022.png){.thumbnail} -![Modification d'une ferme](images/farm_edit.png){.thumbnail} +Dans la section `Paramètres avancés`{.action}, vous pourrez accéder à la section `Suivi de session`{.action} : -Dans les `Paramètres avancés` vous aurez accès au `Suivi de session`: +![Modifier le suivi de connexions](images/tracking_session-2022.png){.thumbnail} -![Modification du suivi de connexion](images/tracking_session.png){.thumbnail} +Une fois que vous avez configuré la ferme, cliquez sur `Ajouter`{.action} ou `Modifier`{.action}, selon que vous configuriez une nouvelle ferme ou modifiiez une ferme existant. -Une fois la ferme configurée, cliquez sur `Ajouter`{.action} ou `Modifier`{.action} selon que vous configuriez une nouvelle ferme, ou une ferme existante. -N'oubliez pas de déployer la configuration. -Pour ce faire, vous pouvez au choix : +N’oubliez pas de déployer la configuration. Il existe deux façons de le faire : -- dans la section `Statut`{.action} de la page d'accueil du Manager, -cliquez sur le bouton `...`{.action} de votre Load Balancer, -et sélectionnez `Appliquer la configuration`{.action} ; +- dans la section `Statut`{.action} de l’espace client, en cliquant sur le bouton `...`{.action} de votre Load Balancer, puis en sélectionnant `Appliquer la configuration`{.action} -- dans le bandeau de rappel du Manager vous précisant que la configuration n'est pas appliquée, -cliquez sur `Appliquer la configuration`{.action}. +- dans le bandeau de rappel vous précisant que la configuration n'est pas appliquée, cliquer sur `Appliquer la configuration`{.action}. -![Application d'une Configuration d'un Load Balancer](images/apply_configuration.png){.thumbnail} +![Appliquer une configuration au Load Balancer](images/apply_configuration-2022.png){.thumbnail} -### Modifier le mode de suivi de connexion d'une ferme via l'API +### Modifier le mode de suivi de connexion d’une ferme via l’API -#### Voir le détail d'une ferme +#### Voir les détails d’une ferme -Cet appel permet de consulter le détail d'une ferme, connaissant son identifiant. Dans cet exemple, nous allons travailler sur une ferme HTTP. +Cette requête API vous permet de consulter les détails d’une ferme si vous connaissez son ID. Dans cet exemple, nous travaillerons sur une ferme HTTP. > [!api] > @@ -79,7 +73,7 @@ Cet appel permet de consulter le détail d'une ferme, connaissant son identifian |Paramètre|Signification| |---|---| -|serviceName\*|Identificant de votre service Load Balancer| +|serviceName\*|Identifiant de votre service Load Balancer| |farmId\*|Identifiant numérique de la ferme| |Réponse (BackendHttp)|Signification| @@ -92,9 +86,9 @@ Cet appel permet de consulter le détail d'une ferme, connaissant son identifian |displayName|Nom donné à cette ferme| |stickiness|Mode de suivi de connexion actuellement configuré sur la ferme| -#### Modifier le mode de suivi de connexion d'une ferme +#### Modifier le mode de suivi de connexion d’une ferme -Cet appel permet de modifier la configuration d'une ferme, connaissant son identifiant. Dans cet exemple, nous allons travailler sur une ferme HTTP. Pour modifier le mode de suivi de connexion, le champ BackendHttp.stickiness doit être mis à jour avec un mode de suivi de connexion disponible. +Cette requête API vous permet de modifier les paramètres d’une ferme si vous connaissez son ID. Dans cet exemple, nous travaillerons sur une ferme HTTP. Pour modifier le mode de suivi de connexion, le champ `BackendHttp.stickiness` doit être mis à jour avec un mode de suivi de connexion disponible : > [!api] > @@ -103,11 +97,13 @@ Cet appel permet de modifier la configuration d'une ferme, connaissant son ident |Paramètre|Signification| |---|---| -|serviceName\*|Identificant de votre service Load Balancer| +|serviceName\*|Identifiant de votre service Load Balancer| |farmId\*|Identifiant numérique de la ferme| |BackendHttp.stickiness|Mode de suivi de connexion souhaité pour cette ferme| -#### Appliquer les modifications: +#### Appliquer les modifications + +Cette requête API est nécessaire pour déployer les modifications de configuration sur le service Load Balancer. > [!api] > @@ -116,9 +112,9 @@ Cet appel permet de modifier la configuration d'une ferme, connaissant son ident |Paramètre|Signification| |---|---| -|serviceName\*|Identificant de votre service Load Balancer| -|zone|Nom de la zone dans laquelle déployer la configuration. "all" ou "rbx" par exemple| +|serviceName\*|Identifiant de votre service Load Balancer| +|zone|Nom de la zone dans laquelle déployer la configuration, "all" ou "rbx" par exemple| ## Aller plus loin -Échangez avec notre [communauté d'utilisateurs](/links/community). +Échangez avec notre [communauté d'utilisateurs](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_stickiness/guide.fr-fr.md b/pages/network/load_balancer/create_stickiness/guide.fr-fr.md index 57f4943504e..33cc637a845 100644 --- a/pages/network/load_balancer/create_stickiness/guide.fr-fr.md +++ b/pages/network/load_balancer/create_stickiness/guide.fr-fr.md @@ -1,14 +1,14 @@ --- -title: Suivi de connexion -excerpt: Configuration du suivi de connexion pour le Load Balancer OVHcloud -updated: 2022-03-28 +title: 'Suivi des connexions sur l’OVHcloud Load Balancer' +excerpt: 'Découvrez les méthodes disponibles pour suivre les connexions sur l’OVHcloud Load Balancer.' +updated: 2025-11-27 --- ## Objectif -Le service [Load Balancer OVHcloud](/links/network/load-balancer) offre différents types de suivi de connexion pour vos services. +Le service [Load Balancer OVHcloud](/links/network/load-balancer) propose plusieurs méthodes pour le **suivi de connexion** (également appelé *persistence de session* ou *stickiness*) vers vos services. -Chaque session du service OVHcloud Load Balancer est maintenue par un système de persistence de connexion. Ce dernier est configuré au niveau de la couche applicative du service OVHcloud Load Balancer, c'est elle qui assure la persistence de la connexion vers le serveur. +Chaque session du service OVHcloud Load Balancer est maintenue par un système de persistence de connexion. Ce système est configuré au niveau de la **couche applicative** du service OVHcloud Load Balancer afin d'assurer la persistance de la connexion vers le serveur. **Ce guide présente différentes façons de configurer le suivi de connexion pour le Load Balancer OVHcloud.** @@ -22,50 +22,49 @@ Chaque session du service OVHcloud Load Balancer est maintenue par un système d ### Les différents types de suivi de connexion -Il existe 2 types principaux de suivi de connexion qui peuvent être configurés avec vos services : +Deux méthodes principales de suivi de connexion peuvent être configurées pour vos services : -|Suivi de connexion|Détails| +| Méthode de suivi | Détails | |---|---| -|Cookie|Configure un cookie de session qui sera utilisé pour toujours répartir le trafic d'une même session HTTP vers le même serveur dans la ferme| -|SourceIp|Un algorithme de hash sera appliqué sur l'adresse IP source de la requête reçue par le service OVHcloud Load Balancer. +| Cookie | Configure un cookie de session, utilisé pour toujours répartir le trafic d'une même session HTTP vers le même serveur dans la ferme. | +| SourceIp | Un algorithme de hash est appliqué à l'adresse IP source de la requête reçue par l’OVHcloud Load Balancer. Cela garantit que la même adresse IP client est toujours dirigée vers le même serveur. | -Les éléments suivants auront un impact sur la redirection de trafic : +Les éléments suivants affecteront la redirection du trafic : -- le poids configuré change ; -- un serveur de la ferme se réactive ; -- un serveur de la ferme ne répond plus. +- le poids configuré change +- un serveur de la ferme se réactive +- un serveur de la ferme ne répond plus > [!warning] > -> Après un rafraichissement de votre configuration, les connexions seront re-balancées, vos sessions HTTP seront donc perdues. +> Après un rafraichissement de votre configuration, les connexions existantes seront rééquilibrées, vos sessions HTTP seront donc perdues. > -### Modifier le mode de suivi de connexion d'une ferme via l'espace client OVHcloud +### Modifier le mode de suivi de connexion d’une ferme via l’espace client OVHcloud -Dans l'[espace client OVHcloud](/links/manager) rendez-vous dans la partie `Bare Metal Cloud`{.action} puis `Load Balancer`{.action}. +Pour modifier le suivi de connexion d’une ferme, rendez-vous sur l’onglet `Ferme de serveurs`{.action}, puis cliquez sur le bouton `...`{.action} sur la droite de la ferme voulue et sélectionnez `Modifier`{.action} : -Pour modifier le suivi de connexion d'une ferme, il faut éditer celle-ci en allant dans l'onglet `Ferme de serveurs`{.action} puis cliquez sur le bouton d'édition `...`{.action} à droite de la ferme voulue et sélectionnez `Modifier`{.action}. +![Modifier une ferme](images/farm_edit-2022.png){.thumbnail} -![Modification d'une ferme](images/farm_edit-2022.png){.thumbnail} +Dans la section `Paramètres avancés`{.action}, vous pourrez accéder à la section `Suivi de session`{.action} : -Dans les `Paramètres avancés` vous aurez accès au `Suivi de session`. +![Modifier le suivi de connexions](images/tracking_session-2022.png){.thumbnail} -![Modification du suivi de connexion](images/tracking_session-2022.png){.thumbnail} +Une fois que vous avez configuré la ferme, cliquez sur `Ajouter`{.action} ou `Modifier`{.action}, selon que vous configuriez une nouvelle ferme ou modifiiez une ferme existant. -Une fois la ferme configurée, cliquez sur `Ajouter`{.action} ou `Modifier`{.action} selon que vous configuriez une nouvelle ferme, ou une ferme existante. +N’oubliez pas de déployer la configuration. Il existe deux façons de le faire : -N'oubliez pas de déployer la configuration. Pour ce faire, vous pouvez au choix : +- dans la section `Statut`{.action} de l’espace client, en cliquant sur le bouton `...`{.action} de votre Load Balancer, puis en sélectionnant `Appliquer la configuration`{.action} -- dans la section `Statut` de l'onglet `Accueil`{.action}, cliquer sur le bouton `...`{.action} de votre Load Balancer puis cliquez sur `Appliquer la configuration`{.action}; - dans le bandeau de rappel vous précisant que la configuration n'est pas appliquée, cliquer sur `Appliquer la configuration`{.action}. -![Application d'une Configuration d'un Load Balancer](images/apply_configuration-2022.png){.thumbnail} +![Appliquer une configuration au Load Balancer](images/apply_configuration-2022.png){.thumbnail} -### Modifier le mode de suivi de connexion d'une ferme depuis l'API OVHcloud +### Modifier le mode de suivi de connexion d’une ferme via l’API -#### Voir le détail d'une ferme +#### Voir les détails d’une ferme -Cet appel permet de consulter le détail d'une ferme, connaissant son identifiant. Dans cet exemple, nous allons travailler sur une ferme HTTP. +Cette requête API vous permet de consulter les détails d’une ferme si vous connaissez son ID. Dans cet exemple, nous travaillerons sur une ferme HTTP. > [!api] > @@ -87,9 +86,9 @@ Cet appel permet de consulter le détail d'une ferme, connaissant son identifian |displayName|Nom donné à cette ferme| |stickiness|Mode de suivi de connexion actuellement configuré sur la ferme| -#### Modifier le mode de suivi de connexion d'une ferme +#### Modifier le mode de suivi de connexion d’une ferme -Cet appel permet de modifier la configuration d'une ferme, connaissant son identifiant. Dans cet exemple, nous allons travailler sur une ferme HTTP. Pour modifier le mode de suivi de connexion, le champ BackendHttp.stickiness doit être mis à jour avec un mode de suivi de connexion disponible. +Cette requête API vous permet de modifier les paramètres d’une ferme si vous connaissez son ID. Dans cet exemple, nous travaillerons sur une ferme HTTP. Pour modifier le mode de suivi de connexion, le champ `BackendHttp.stickiness` doit être mis à jour avec un mode de suivi de connexion disponible : > [!api] > @@ -102,7 +101,9 @@ Cet appel permet de modifier la configuration d'une ferme, connaissant son ident |farmId\*|Identifiant numérique de la ferme| |BackendHttp.stickiness|Mode de suivi de connexion souhaité pour cette ferme| -#### Appliquer les modifications: +#### Appliquer les modifications + +Cette requête API est nécessaire pour déployer les modifications de configuration sur le service Load Balancer. > [!api] > @@ -116,4 +117,4 @@ Cet appel permet de modifier la configuration d'une ferme, connaissant son ident ## Aller plus loin -Échangez avec notre [communauté d'utilisateurs](/links/community). +Échangez avec notre [communauté d'utilisateurs](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/create_stickiness/images/apply_configuration.png b/pages/network/load_balancer/create_stickiness/images/apply_configuration.png deleted file mode 100644 index 498693a55cf..00000000000 Binary files a/pages/network/load_balancer/create_stickiness/images/apply_configuration.png and /dev/null differ diff --git a/pages/network/load_balancer/create_stickiness/images/farm_edit.png b/pages/network/load_balancer/create_stickiness/images/farm_edit.png deleted file mode 100644 index 3a1983db8b6..00000000000 Binary files a/pages/network/load_balancer/create_stickiness/images/farm_edit.png and /dev/null differ diff --git a/pages/network/load_balancer/create_stickiness/images/tracking_session.png b/pages/network/load_balancer/create_stickiness/images/tracking_session.png deleted file mode 100644 index 3ac5c985636..00000000000 Binary files a/pages/network/load_balancer/create_stickiness/images/tracking_session.png and /dev/null differ diff --git a/pages/network/load_balancer/howto_route_ipfo/guide.en-asia.md b/pages/network/load_balancer/howto_route_ipfo/guide.en-asia.md index 3b6afd7d05f..79b25b05c19 100644 --- a/pages/network/load_balancer/howto_route_ipfo/guide.en-asia.md +++ b/pages/network/load_balancer/howto_route_ipfo/guide.en-asia.md @@ -1,149 +1,146 @@ --- -title: 'Routing an Additional IP' -excerpt: 'Find out how to route an Additional IP and link it to the OVH Load Balancer' -updated: 2022-10-06 +title: 'How to route an Additional IP' +excerpt: 'Find out how to route an Additional IP and link it to the OVHcloud Load Balancer' +updated: 2025-11-27 --- -> [!primary] -> -> Since October 6th, 2022 our service "Failover IP" is named [Additional IP](/links/network/additional-ip). This renaming has no effect on its technical features. -> - ## Objective -An Additional IP is an IP address that can be switched from one service to another. In doing so, it helps you avoid a wide range of issues for your infrastructure (hardware failures, overload for your services, maintenance, etc.). +An **Additional IP** is an IP address that can be switched from one service to another. This capability helps you maintain infrastructure continuity by mitigating issues such as hardware failures, service overload, or maintenance downtime. -For more information on Additional IPs, you can consult our [webpage](/links/bare-metal/ip). +For more information on Additional IPs, please consult our [webpage](/links/bare-metal/ip). -The OVH Load Balancer solution offers load balancing features for a range of different protocols: HTTP, HTTPS, TCP and UDP. When you link it to an Additional IP, you can switch over your existing infrastructure to a Load Balancer without disturbing or interrupting services for your customers. Effectively, you will not need to change the IP address any longer if you are still using the Additional IP, so you will not need to wait for your DNS zone to propagate any changes. +The OVHcloud Load Balancer solution provides load balancing features for various protocols, including HTTP, HTTPS, TCP, and UDP. Linking it to an Additional IP allows you to switch your existing infrastructure to the Load Balancer without service interruption. Since you continue using the Additional IP, you avoid the need to change your public IP address and wait for DNS zone propagation. Using an additional IP means you avoid the need to change your service's IP address, and no longer have to wait for your DNS zone to propagate changes. -For more information on the OVH Load Balancer solution, you can read our [Introduction to the OVH Load Balancer](/pages/network/load_balancer/use_presentation). +For more information on the OVHcloud Load Balancer solution, please read our [Introduction to the OVHcloud Load Balancer](/pages/network/load_balancer/use_presentation) guide. -**This guide will explain how to use the Additional IP with the OVH Load Balancer service.** +**This guide explains how to use an Additional IP with the OVHcloud Load Balancer service.** ## Requirements -- a correctly configured [OVH Load Balancer](https://www.ovh.com/asia/solutions/load-balancer/) -- an [Additional IP](/links/bare-metal/ip) +- A configured [OVHcloud Load Balancer](/links/network/load-balancer) +- An [Additional IP](/links/bare-metal/ip) +- Access to the [OVHcloud Control Panel](/links/manager) +- Access to the [OVHcloud API](/links/api) > [!primary] > -> **The required Load Balancer configuration.** +> **Required Load Balancer configuration** > -> Once you have confirmed the changes in the list of Additional IPs associated with the Load Balancer, you need to be able to refresh them. Several conditions need to be met for this to work. +> Once you confirm the changes in the list of Additional IPs associated with the Load Balancer, the configuration needs to be refreshed. Several conditions must be met for this to work: > -> - If the Load Balancer is in a vRack, all of the farms must also be in the vRack. The Load Balancer must also have its vLAN. Otherwise, there should not be any farms in a vRack. +> - **vRack configuration:** If the Load Balancer is in a vRack, all farms must also be in the vRack, and the Load Balancer must have its vLAN defined. Otherwise, there should be no farms in a vRack. > -> - At least one existing front-end. All of the front-ends must be valid. They can be enabled and disabled, with either: -> - a valid route (with routing rules) -> - a redirection (`redirectLocation`{.action}) -> - a default farm +> - **Front-end validity:** At least one front-end must exist, and all front-ends must be valid. They can be enabled or disabled, but must have either: +>    - a valid route (with routing rules) +>    - a redirection (`redirectLocation`{.action}) +>    - a default farm > -> - Nothing else should be refreshed for the Load Balancer. A Load Balancer cannot be refreshed several times at once. Doing so would not make any changes to the resulting configuration. +> - **Configuration state:** The Load Balancer must not be undergoing any other refresh process. A Load Balancer cannot be refreshed several times at once, as this would prevent changes from being applied to the resulting configuration. > ## Instructions -In this document, we will look at two distinct uses: +In this document, we will cover two distinct use cases: -- linking an Additional IP to the OVH Load Balancer service -- linking an Additional IP to a single front-end of the OVH Load Balancer service +- linking an Additional IP to the overall OVHcloud Load Balancer service +- linking an Additional IP to a single front-end of the OVHcloud Load Balancer service -### Add an Additional IP. +### Add an Additional IP to the OVHcloud Load Balancer -You can link these IPs to your OVH Load Balancer via the [OVH API](https://ca.api.ovh.com). -The API call for this is as follows: +You can link these IPs to your OVHcloud Load Balancer via the [OVHcloud API](/links/api). +The API call for this is: > [!api] > > @api {v1} /ip POST /ip/{ip}/move > -You can then list the Additional IPs linked to your OVH Load Balancer with the following API call: +You can then list the Additional IPs linked to your OVHcloud Load Balancer with the following API call: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/failover > -The Additional IPs linked to your Load Balancer will be available for all of your front-ends. This is contrary to the following case, in which we will link an Additional IP to a single front-end. +Additional IPs linked this way are available for **all** your front-ends. This differs from the next case, where an Additional IP is linked to a single front-end. -## Dedicated Additional IP. +### Add a dedicated Additional IP to a front-end -No matter what kind of front-end you wish to use, you can define a list of dedicated Additional IPs that will be linked to them. Please note that in this particular case, your Additional IP will be attached to only one single front-end. As a result, it will only give access to the service provided by this front-end. The services for your other front-ends will be accessible via your IP Load Balancer’s IP address. +Regardless of the front-end type, you can define a list of dedicated Additional IPs to be linked to it. In this specific case, your Additional IP will be attached to **only one** single front-end. As a result, it will only grant access to the service provided by that front-end. Services for your other front-ends will remain accessible via your IP Load Balancer’s primary IP address. -### Via the API. +#### Via the API -#### If you are creating a front-end: +**If you are creating a front-end:** -From the [OVH API](https://ca.api.ovh.com), you can use the following call to define one or more Additional IPs on a front-end as you create it: +From the [OVHcloud API](/links/api), you can use the following calls to define one or more Additional IPs on a front-end during its creation: -* HTTP protocol +- HTTP protocol > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend > -* TCP protocol +- TCP protocol > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/frontend > -* UDP protocol +- UDP protocol > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/frontend > -#### If you are updating an existing front-end: +**If you are updating an existing front-end:** -From the [OVH API](https://ca.api.ovh.com), you can use the following call to define one or more Additional IPs on an existing front-end: +From the [OVHcloud API](/links/api), you can use the following calls to define one or more Additional IPs on an existing front-end: -* HTTP protocol +- HTTP protocol > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId} > -* TCP protocol +- TCP protocol > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId} > -* UDP protocol +- UDP protocol > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId} > -### Via the OVH Control Panel. +#### Via the OVHcloud Control Panel -You can define dedicated Additional IPs via the [OVH Control Panel](/links/manager) by going to the `Cloud`{.action} section, then `Load Balancer`{.action}. +You can define dedicated Additional IPs via the [OVHcloud Control Panel](/links/manager) by navigating to the `Network`{.action} section, then `Load Balancer`{.action}. -Once you have selected the Load Balancer you want to modify, create a new front-end, or edit an existing one. +Once you have selected the Load Balancer you want to modify, navigate to the `Front-ends`{.action} tab, where you can either create a new front-end or edit an existing one. -In `Advanced settings`{.action}, you can select the Additional IPs you would like to add to your front-end. +In `Advanced settings`{.action}, you can select the Additional IPs you would like to associate with your front-end. ![Configure the front-end by associating an Additional IP](images/iplb_frontend.png){.thumbnail} -Once the front-end has been configured, click `Add`{.action} or `Edit`{.action}, depending on whether you are configuring a new or existing front-end. +Once the front-end has been configured, click `Add`{.action} or `Modify`{.action}, depending on whether you are configuring a new or existing front-end. -Please remember to deploy the configuration. There are two ways of doing this: +Remember to deploy the configuration. There are two ways to do this: -- via the `Status`{.action} section of the OVH Control Panel, by clicking on your Load Balancer’s `...`{.action} button, then selecting `Apply configuration`{.action} +- via the `Status`{.action} section of the `Home`{.action} tab of your OVHcloud Control Panel, by clicking on the `...`{.action} button next to your Load Balancer's ID and selecting `Apply configuration`{.action} -- via the reminder box in the OVH Control Panel, notifying you that the configuration has not been applied, by clicking `Apply configuration`{.action} +- via the reminder box in the OVHcloud Control Panel, which notifies you that the configuration has not been applied, by clicking `Apply configuration`{.action}. ![Apply a Load Balancer configuration](images/apply_configuration.png){.thumbnail} ## Go further -Join our community of users on . +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/howto_route_ipfo/guide.en-au.md b/pages/network/load_balancer/howto_route_ipfo/guide.en-au.md index 335d0a87dcd..79b25b05c19 100644 --- a/pages/network/load_balancer/howto_route_ipfo/guide.en-au.md +++ b/pages/network/load_balancer/howto_route_ipfo/guide.en-au.md @@ -1,149 +1,146 @@ --- -title: 'Routing an Additional IP' -excerpt: 'Find out how to route an Additional IP and link it to the OVH Load Balancer' -updated: 2022-10-06 +title: 'How to route an Additional IP' +excerpt: 'Find out how to route an Additional IP and link it to the OVHcloud Load Balancer' +updated: 2025-11-27 --- -> [!primary] -> -> Since October 6th, 2022 our service "Failover IP" is named [Additional IP](/links/network/additional-ip). This renaming has no effect on its technical features. -> - ## Objective -An Additional IP is an IP address that can be switched from one service to another. In doing so, it helps you avoid a wide range of issues for your infrastructure (hardware failures, overload for your services, maintenance, etc.). +An **Additional IP** is an IP address that can be switched from one service to another. This capability helps you maintain infrastructure continuity by mitigating issues such as hardware failures, service overload, or maintenance downtime. -For more information on Additional IPs, you can consult our [webpage](/links/bare-metal/ip). +For more information on Additional IPs, please consult our [webpage](/links/bare-metal/ip). -The OVH Load Balancer solution offers load balancing features for a range of different protocols: HTTP, HTTPS, TCP and UDP. When you link it to an Additional IP, you can switch over your existing infrastructure to a Load Balancer without disturbing or interrupting services for your customers. Effectively, you will not need to change the IP address any longer if you are still using the Additional IP, so you will not need to wait for your DNS zone to propagate any changes. +The OVHcloud Load Balancer solution provides load balancing features for various protocols, including HTTP, HTTPS, TCP, and UDP. Linking it to an Additional IP allows you to switch your existing infrastructure to the Load Balancer without service interruption. Since you continue using the Additional IP, you avoid the need to change your public IP address and wait for DNS zone propagation. Using an additional IP means you avoid the need to change your service's IP address, and no longer have to wait for your DNS zone to propagate changes. -For more information on the OVH Load Balancer solution, you can read our [Introduction to the OVH Load Balancer](/pages/network/load_balancer/use_presentation). +For more information on the OVHcloud Load Balancer solution, please read our [Introduction to the OVHcloud Load Balancer](/pages/network/load_balancer/use_presentation) guide. -**This guide will explain how to use the Additional IP with the OVH Load Balancer service.** +**This guide explains how to use an Additional IP with the OVHcloud Load Balancer service.** ## Requirements -- a correctly configured [OVH Load Balancer](https://www.ovh.com.au/solutions/load-balancer/) -- an [Additional IP](/links/bare-metal/ip) +- A configured [OVHcloud Load Balancer](/links/network/load-balancer) +- An [Additional IP](/links/bare-metal/ip) +- Access to the [OVHcloud Control Panel](/links/manager) +- Access to the [OVHcloud API](/links/api) > [!primary] > -> **The required Load Balancer configuration.** +> **Required Load Balancer configuration** > -> Once you have confirmed the changes in the list of Additional IPs associated with the Load Balancer, you need to be able to refresh them. Several conditions need to be met for this to work. +> Once you confirm the changes in the list of Additional IPs associated with the Load Balancer, the configuration needs to be refreshed. Several conditions must be met for this to work: > -> - If the Load Balancer is in a vRack, all of the farms must also be in the vRack. The Load Balancer must also have its vLAN. Otherwise, there should not be any farms in a vRack. +> - **vRack configuration:** If the Load Balancer is in a vRack, all farms must also be in the vRack, and the Load Balancer must have its vLAN defined. Otherwise, there should be no farms in a vRack. > -> - At least one existing front-end. All of the front-ends must be valid. They can be enabled and disabled, with either: -> - a valid route (with routing rules) -> - a redirection (`redirectLocation`{.action}) -> - a default farm +> - **Front-end validity:** At least one front-end must exist, and all front-ends must be valid. They can be enabled or disabled, but must have either: +>    - a valid route (with routing rules) +>    - a redirection (`redirectLocation`{.action}) +>    - a default farm > -> - Nothing else should be refreshed for the Load Balancer. A Load Balancer cannot be refreshed several times at once. Doing so would not make any changes to the resulting configuration. +> - **Configuration state:** The Load Balancer must not be undergoing any other refresh process. A Load Balancer cannot be refreshed several times at once, as this would prevent changes from being applied to the resulting configuration. > ## Instructions -In this document, we will look at two distinct uses: +In this document, we will cover two distinct use cases: -- linking an Additional IP to the OVH Load Balancer service -- linking an Additional IP to a single front-end of the OVH Load Balancer service +- linking an Additional IP to the overall OVHcloud Load Balancer service +- linking an Additional IP to a single front-end of the OVHcloud Load Balancer service -### Add an Additional IP. +### Add an Additional IP to the OVHcloud Load Balancer -You can link these IPs to your OVH Load Balancer via the [OVH API](https://ca.api.ovh.com). -The API call for this is as follows: +You can link these IPs to your OVHcloud Load Balancer via the [OVHcloud API](/links/api). +The API call for this is: > [!api] > > @api {v1} /ip POST /ip/{ip}/move > -You can then list the Additional IPs linked to your OVH Load Balancer with the following API call: +You can then list the Additional IPs linked to your OVHcloud Load Balancer with the following API call: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/failover > -The Additional IPs linked to your Load Balancer will be available for all of your front-ends. This is contrary to the following case, in which we will link an Additional IP to a single front-end. +Additional IPs linked this way are available for **all** your front-ends. This differs from the next case, where an Additional IP is linked to a single front-end. -## Dedicated Additional IP. +### Add a dedicated Additional IP to a front-end -No matter what kind of front-end you wish to use, you can define a list of dedicated Additional IPs that will be linked to them. Please note that in this particular case, your Additional IP will be attached to only one single front-end. As a result, it will only give access to the service provided by this front-end. The services for your other front-ends will be accessible via your IP Load Balancer’s IP address. +Regardless of the front-end type, you can define a list of dedicated Additional IPs to be linked to it. In this specific case, your Additional IP will be attached to **only one** single front-end. As a result, it will only grant access to the service provided by that front-end. Services for your other front-ends will remain accessible via your IP Load Balancer’s primary IP address. -### Via the API. +#### Via the API -#### If you are creating a front-end: +**If you are creating a front-end:** -From the [OVH API](https://ca.api.ovh.com), you can use the following call to define one or more Additional IPs on a front-end as you create it: +From the [OVHcloud API](/links/api), you can use the following calls to define one or more Additional IPs on a front-end during its creation: -* HTTP protocol +- HTTP protocol > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend > -* TCP protocol +- TCP protocol > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/frontend > -* UDP protocol +- UDP protocol > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/frontend > -#### If you are updating an existing front-end: +**If you are updating an existing front-end:** -From the [OVH API](https://ca.api.ovh.com), you can use the following call to define one or more Additional IPs on an existing front-end: +From the [OVHcloud API](/links/api), you can use the following calls to define one or more Additional IPs on an existing front-end: -* HTTP protocol +- HTTP protocol > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId} > -* TCP protocol +- TCP protocol > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId} > -* UDP protocol +- UDP protocol > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId} > -### Via the OVH Control Panel. +#### Via the OVHcloud Control Panel -You can define dedicated Additional IPs via the [OVH Control Panel](/links/manager) by going to the `Cloud`{.action} section, then `Load Balancer`{.action}. +You can define dedicated Additional IPs via the [OVHcloud Control Panel](/links/manager) by navigating to the `Network`{.action} section, then `Load Balancer`{.action}. -Once you have selected the Load Balancer you want to modify, create a new front-end, or edit an existing one. +Once you have selected the Load Balancer you want to modify, navigate to the `Front-ends`{.action} tab, where you can either create a new front-end or edit an existing one. -In `Advanced settings`{.action}, you can select the Additional IPs you would like to add to your front-end. +In `Advanced settings`{.action}, you can select the Additional IPs you would like to associate with your front-end. ![Configure the front-end by associating an Additional IP](images/iplb_frontend.png){.thumbnail} -Once the front-end has been configured, click `Add`{.action} or `Edit`{.action}, depending on whether you are configuring a new or existing front-end. +Once the front-end has been configured, click `Add`{.action} or `Modify`{.action}, depending on whether you are configuring a new or existing front-end. -Please remember to deploy the configuration. There are two ways of doing this: +Remember to deploy the configuration. There are two ways to do this: -- via the `Status`{.action} section of the OVH Control Panel, by clicking on your Load Balancer’s `...`{.action} button, then selecting `Apply configuration`{.action} +- via the `Status`{.action} section of the `Home`{.action} tab of your OVHcloud Control Panel, by clicking on the `...`{.action} button next to your Load Balancer's ID and selecting `Apply configuration`{.action} -- via the reminder box in the OVH Control Panel, notifying you that the configuration has not been applied, by clicking `Apply configuration`{.action} +- via the reminder box in the OVHcloud Control Panel, which notifies you that the configuration has not been applied, by clicking `Apply configuration`{.action}. ![Apply a Load Balancer configuration](images/apply_configuration.png){.thumbnail} ## Go further -Join our community of users on . +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/howto_route_ipfo/guide.en-ca.md b/pages/network/load_balancer/howto_route_ipfo/guide.en-ca.md index 0acb56555c6..79b25b05c19 100644 --- a/pages/network/load_balancer/howto_route_ipfo/guide.en-ca.md +++ b/pages/network/load_balancer/howto_route_ipfo/guide.en-ca.md @@ -1,149 +1,146 @@ --- -title: 'Routing an Additional IP' -excerpt: 'Find out how to route an Additional IP and link it to the OVH Load Balancer' -updated: 2022-10-06 +title: 'How to route an Additional IP' +excerpt: 'Find out how to route an Additional IP and link it to the OVHcloud Load Balancer' +updated: 2025-11-27 --- -> [!primary] -> -> Since October 6th, 2022 our service "Failover IP" is named [Additional IP](/links/network/additional-ip). This renaming has no effect on its technical features. -> - ## Objective -An Additional IP is an IP address that can be switched from one service to another. In doing so, it helps you avoid a wide range of issues for your infrastructure (hardware failures, overload for your services, maintenance, etc.). +An **Additional IP** is an IP address that can be switched from one service to another. This capability helps you maintain infrastructure continuity by mitigating issues such as hardware failures, service overload, or maintenance downtime. -For more information on Additional IPs, you can consult our [webpage](/links/bare-metal/ip). +For more information on Additional IPs, please consult our [webpage](/links/bare-metal/ip). -The OVH Load Balancer solution offers load balancing features for a range of different protocols: HTTP, HTTPS, TCP and UDP. When you link it to an Additional IP, you can switch over your existing infrastructure to a Load Balancer without disturbing or interrupting services for your customers. Effectively, you will not need to change the IP address any longer if you are still using the Additional IP, so you will not need to wait for your DNS zone to propagate any changes. +The OVHcloud Load Balancer solution provides load balancing features for various protocols, including HTTP, HTTPS, TCP, and UDP. Linking it to an Additional IP allows you to switch your existing infrastructure to the Load Balancer without service interruption. Since you continue using the Additional IP, you avoid the need to change your public IP address and wait for DNS zone propagation. Using an additional IP means you avoid the need to change your service's IP address, and no longer have to wait for your DNS zone to propagate changes. -For more information on the OVH Load Balancer solution, you can read our [Introduction to the OVH Load Balancer](/pages/network/load_balancer/use_presentation). +For more information on the OVHcloud Load Balancer solution, please read our [Introduction to the OVHcloud Load Balancer](/pages/network/load_balancer/use_presentation) guide. -**This guide will explain how to use the Additional IP with the OVH Load Balancer service.** +**This guide explains how to use an Additional IP with the OVHcloud Load Balancer service.** ## Requirements -- a correctly configured [OVH Load Balancer](https://www.ovh.com/ca/en/solutions/load-balancer/) -- an [Additional IP](/links/bare-metal/ip) +- A configured [OVHcloud Load Balancer](/links/network/load-balancer) +- An [Additional IP](/links/bare-metal/ip) +- Access to the [OVHcloud Control Panel](/links/manager) +- Access to the [OVHcloud API](/links/api) > [!primary] > -> **The required Load Balancer configuration.** +> **Required Load Balancer configuration** > -> Once you have confirmed the changes in the list of Additional IPs associated with the Load Balancer, you need to be able to refresh them. Several conditions need to be met for this to work. +> Once you confirm the changes in the list of Additional IPs associated with the Load Balancer, the configuration needs to be refreshed. Several conditions must be met for this to work: > -> - If the Load Balancer is in a vRack, all of the farms must also be in the vRack. The Load Balancer must also have its vLAN. Otherwise, there should not be any farms in a vRack. +> - **vRack configuration:** If the Load Balancer is in a vRack, all farms must also be in the vRack, and the Load Balancer must have its vLAN defined. Otherwise, there should be no farms in a vRack. > -> - At least one existing front-end. All of the front-ends must be valid. They can be enabled and disabled, with either: -> - a valid route (with routing rules) -> - a redirection (`redirectLocation`{.action}) -> - a default farm +> - **Front-end validity:** At least one front-end must exist, and all front-ends must be valid. They can be enabled or disabled, but must have either: +>    - a valid route (with routing rules) +>    - a redirection (`redirectLocation`{.action}) +>    - a default farm > -> - Nothing else should be refreshed for the Load Balancer. A Load Balancer cannot be refreshed several times at once. Doing so would not make any changes to the resulting configuration. +> - **Configuration state:** The Load Balancer must not be undergoing any other refresh process. A Load Balancer cannot be refreshed several times at once, as this would prevent changes from being applied to the resulting configuration. > ## Instructions -In this document, we will look at two distinct uses: +In this document, we will cover two distinct use cases: -- linking an Additional IP to the OVH Load Balancer service -- linking an Additional IP to a single front-end of the OVH Load Balancer service +- linking an Additional IP to the overall OVHcloud Load Balancer service +- linking an Additional IP to a single front-end of the OVHcloud Load Balancer service -### Add an Additional IP. +### Add an Additional IP to the OVHcloud Load Balancer -You can link these IPs to your OVH Load Balancer via the [OVH API](https://ca.api.ovh.com). -The API call for this is as follows: +You can link these IPs to your OVHcloud Load Balancer via the [OVHcloud API](/links/api). +The API call for this is: > [!api] > > @api {v1} /ip POST /ip/{ip}/move > -You can then list the Additional IPs linked to your OVH Load Balancer with the following API call: +You can then list the Additional IPs linked to your OVHcloud Load Balancer with the following API call: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/failover > -The Additional IPs linked to your Load Balancer will be available for all of your front-ends. This is contrary to the following case, in which we will link an Additional IP to a single front-end. +Additional IPs linked this way are available for **all** your front-ends. This differs from the next case, where an Additional IP is linked to a single front-end. -## Dedicated Additional IP. +### Add a dedicated Additional IP to a front-end -No matter what kind of front-end you wish to use, you can define a list of dedicated Additional IPs that will be linked to them. Please note that in this particular case, your Additional IP will be attached to only one single front-end. As a result, it will only give access to the service provided by this front-end. The services for your other front-ends will be accessible via your IP Load Balancer’s IP address. +Regardless of the front-end type, you can define a list of dedicated Additional IPs to be linked to it. In this specific case, your Additional IP will be attached to **only one** single front-end. As a result, it will only grant access to the service provided by that front-end. Services for your other front-ends will remain accessible via your IP Load Balancer’s primary IP address. -### Via the API. +#### Via the API -#### If you are creating a front-end: +**If you are creating a front-end:** -From the [OVH API](https://ca.api.ovh.com), you can use the following call to define one or more Additional IPs on a front-end as you create it: +From the [OVHcloud API](/links/api), you can use the following calls to define one or more Additional IPs on a front-end during its creation: -* HTTP protocol +- HTTP protocol > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend > -* TCP protocol +- TCP protocol > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/frontend > -* UDP protocol +- UDP protocol > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/frontend > -#### If you are updating an existing front-end: +**If you are updating an existing front-end:** -From the [OVH API](https://ca.api.ovh.com), you can use the following call to define one or more Additional IPs on an existing front-end: +From the [OVHcloud API](/links/api), you can use the following calls to define one or more Additional IPs on an existing front-end: -* HTTP protocol +- HTTP protocol > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId} > -* TCP protocol +- TCP protocol > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId} > -* UDP protocol +- UDP protocol > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId} > -### Via the OVH Control Panel. +#### Via the OVHcloud Control Panel -You can define dedicated Additional IPs via the [OVH Control Panel](/links/manager) by going to the `Cloud`{.action} section, then `Load Balancer`{.action}. +You can define dedicated Additional IPs via the [OVHcloud Control Panel](/links/manager) by navigating to the `Network`{.action} section, then `Load Balancer`{.action}. -Once you have selected the Load Balancer you want to modify, create a new front-end, or edit an existing one. +Once you have selected the Load Balancer you want to modify, navigate to the `Front-ends`{.action} tab, where you can either create a new front-end or edit an existing one. -In `Advanced settings`{.action}, you can select the Additional IPs you would like to add to your front-end. +In `Advanced settings`{.action}, you can select the Additional IPs you would like to associate with your front-end. ![Configure the front-end by associating an Additional IP](images/iplb_frontend.png){.thumbnail} -Once the front-end has been configured, click `Add`{.action} or `Edit`{.action}, depending on whether you are configuring a new or existing front-end. +Once the front-end has been configured, click `Add`{.action} or `Modify`{.action}, depending on whether you are configuring a new or existing front-end. -Please remember to deploy the configuration. There are two ways of doing this: +Remember to deploy the configuration. There are two ways to do this: -- via the `Status`{.action} section of the OVH Control Panel, by clicking on your Load Balancer’s `...`{.action} button, then selecting `Apply configuration`{.action} +- via the `Status`{.action} section of the `Home`{.action} tab of your OVHcloud Control Panel, by clicking on the `...`{.action} button next to your Load Balancer's ID and selecting `Apply configuration`{.action} -- via the reminder box in the OVH Control Panel, notifying you that the configuration has not been applied, by clicking `Apply configuration`{.action} +- via the reminder box in the OVHcloud Control Panel, which notifies you that the configuration has not been applied, by clicking `Apply configuration`{.action}. ![Apply a Load Balancer configuration](images/apply_configuration.png){.thumbnail} ## Go further -Join our community of users on . +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/howto_route_ipfo/guide.en-gb.md b/pages/network/load_balancer/howto_route_ipfo/guide.en-gb.md index 8ff098aa8c5..79b25b05c19 100644 --- a/pages/network/load_balancer/howto_route_ipfo/guide.en-gb.md +++ b/pages/network/load_balancer/howto_route_ipfo/guide.en-gb.md @@ -1,149 +1,146 @@ --- -title: 'Routing an Additional IP' -excerpt: 'Find out how to route an Additional IP and link it to the OVH Load Balancer' -updated: 2022-10-06 +title: 'How to route an Additional IP' +excerpt: 'Find out how to route an Additional IP and link it to the OVHcloud Load Balancer' +updated: 2025-11-27 --- -> [!primary] -> -> Since October 6th, 2022 our service "Failover IP" is named [Additional IP](/links/network/additional-ip). This renaming has no effect on its technical features. -> - ## Objective -An Additional IP is an IP address that can be switched from one service to another. In doing so, it helps you avoid a wide range of issues for your infrastructure (hardware failures, overload for your services, maintenance, etc.). +An **Additional IP** is an IP address that can be switched from one service to another. This capability helps you maintain infrastructure continuity by mitigating issues such as hardware failures, service overload, or maintenance downtime. -For more information on Additional IPs, you can consult our [webpage](/links/bare-metal/ip). +For more information on Additional IPs, please consult our [webpage](/links/bare-metal/ip). -The OVH Load Balancer solution offers load balancing features for a range of different protocols: HTTP, HTTPS, TCP and UDP. When you link it to an Additional IP, you can switch over your existing infrastructure to a Load Balancer without disturbing or interrupting services for your customers. Effectively, you will not need to change the IP address any longer if you are still using the Additional IP, so you will not need to wait for your DNS zone to propagate any changes. +The OVHcloud Load Balancer solution provides load balancing features for various protocols, including HTTP, HTTPS, TCP, and UDP. Linking it to an Additional IP allows you to switch your existing infrastructure to the Load Balancer without service interruption. Since you continue using the Additional IP, you avoid the need to change your public IP address and wait for DNS zone propagation. Using an additional IP means you avoid the need to change your service's IP address, and no longer have to wait for your DNS zone to propagate changes. -For more information on the OVH Load Balancer solution, you can read our [Introduction to the OVH Load Balancer](/pages/network/load_balancer/use_presentation). +For more information on the OVHcloud Load Balancer solution, please read our [Introduction to the OVHcloud Load Balancer](/pages/network/load_balancer/use_presentation) guide. -**This guide will explain how to use the Additional IP with the OVH Load Balancer service.** +**This guide explains how to use an Additional IP with the OVHcloud Load Balancer service.** ## Requirements -- a correctly configured [OVH Load Balancer](/links/network/load-balancer) -- an [Additional IP](/links/bare-metal/ip) +- A configured [OVHcloud Load Balancer](/links/network/load-balancer) +- An [Additional IP](/links/bare-metal/ip) +- Access to the [OVHcloud Control Panel](/links/manager) +- Access to the [OVHcloud API](/links/api) > [!primary] > -> **The required Load Balancer configuration.** +> **Required Load Balancer configuration** > -> Once you have confirmed the changes in the list of Additional IPs associated with the Load Balancer, you need to be able to refresh them. Several conditions need to be met for this to work. +> Once you confirm the changes in the list of Additional IPs associated with the Load Balancer, the configuration needs to be refreshed. Several conditions must be met for this to work: > -> - If the Load Balancer is in a vRack, all of the farms must also be in the vRack. The Load Balancer must also have its vLAN. Otherwise, there should not be any farms in a vRack. +> - **vRack configuration:** If the Load Balancer is in a vRack, all farms must also be in the vRack, and the Load Balancer must have its vLAN defined. Otherwise, there should be no farms in a vRack. > -> - At least one existing front-end. All of the front-ends must be valid. They can be enabled and disabled, with either: -> - a valid route (with routing rules) -> - a redirection (`redirectLocation`{.action}) -> - a default farm +> - **Front-end validity:** At least one front-end must exist, and all front-ends must be valid. They can be enabled or disabled, but must have either: +>    - a valid route (with routing rules) +>    - a redirection (`redirectLocation`{.action}) +>    - a default farm > -> - Nothing else should be refreshed for the Load Balancer. A Load Balancer cannot be refreshed several times at once. Doing so would not make any changes to the resulting configuration. +> - **Configuration state:** The Load Balancer must not be undergoing any other refresh process. A Load Balancer cannot be refreshed several times at once, as this would prevent changes from being applied to the resulting configuration. > ## Instructions -In this document, we will look at two distinct uses: +In this document, we will cover two distinct use cases: -- linking an Additional IP to the OVH Load Balancer service -- linking an Additional IP to a single front-end of the OVH Load Balancer service +- linking an Additional IP to the overall OVHcloud Load Balancer service +- linking an Additional IP to a single front-end of the OVHcloud Load Balancer service -### Add an Additional IP. +### Add an Additional IP to the OVHcloud Load Balancer -You can link these IPs to your OVH Load Balancer via the [OVH API](https://api.ovh.com). -The API call for this is as follows: +You can link these IPs to your OVHcloud Load Balancer via the [OVHcloud API](/links/api). +The API call for this is: > [!api] > > @api {v1} /ip POST /ip/{ip}/move > -You can then list the Additional IPs linked to your OVH Load Balancer with the following API call: +You can then list the Additional IPs linked to your OVHcloud Load Balancer with the following API call: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/failover > -The Additional IPs linked to your Load Balancer will be available for all of your front-ends. This is contrary to the following case, in which we will link an Additional IP to a single front-end. +Additional IPs linked this way are available for **all** your front-ends. This differs from the next case, where an Additional IP is linked to a single front-end. -## Dedicated Additional IP. +### Add a dedicated Additional IP to a front-end -No matter what kind of front-end you wish to use, you can define a list of dedicated Additional IPs that will be linked to them. Please note that in this particular case, your Additional IP will be attached to only one single front-end. As a result, it will only give access to the service provided by this front-end. The services for your other front-ends will be accessible via your IP Load Balancer’s IP address. +Regardless of the front-end type, you can define a list of dedicated Additional IPs to be linked to it. In this specific case, your Additional IP will be attached to **only one** single front-end. As a result, it will only grant access to the service provided by that front-end. Services for your other front-ends will remain accessible via your IP Load Balancer’s primary IP address. -### Via the API. +#### Via the API -#### If you are creating a front-end: +**If you are creating a front-end:** -From the [OVH API](https://api.ovh.com), you can use the following call to define one or more Additional IPs on a front-end as you create it: +From the [OVHcloud API](/links/api), you can use the following calls to define one or more Additional IPs on a front-end during its creation: -* HTTP protocol +- HTTP protocol > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend > -* TCP protocol +- TCP protocol > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/frontend > -* UDP protocol +- UDP protocol > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/frontend > -#### If you are updating an existing front-end: +**If you are updating an existing front-end:** -From the [OVH API](https://api.ovh.com), you can use the following call to define one or more Additional IPs on an existing front-end: +From the [OVHcloud API](/links/api), you can use the following calls to define one or more Additional IPs on an existing front-end: -* HTTP protocol +- HTTP protocol > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId} > -* TCP protocol +- TCP protocol > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId} > -* UDP protocol +- UDP protocol > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId} > -### Via the OVH Control Panel. +#### Via the OVHcloud Control Panel -You can define dedicated Additional IPs via the [OVH Control Panel](/links/manager) by going to the `Cloud`{.action} section, then `Load Balancer`{.action}. +You can define dedicated Additional IPs via the [OVHcloud Control Panel](/links/manager) by navigating to the `Network`{.action} section, then `Load Balancer`{.action}. -Once you have selected the Load Balancer you want to modify, create a new front-end, or edit an existing one. +Once you have selected the Load Balancer you want to modify, navigate to the `Front-ends`{.action} tab, where you can either create a new front-end or edit an existing one. -In `Advanced settings`{.action}, you can select the Additional IPs you would like to add to your front-end. +In `Advanced settings`{.action}, you can select the Additional IPs you would like to associate with your front-end. ![Configure the front-end by associating an Additional IP](images/iplb_frontend.png){.thumbnail} -Once the front-end has been configured, click `Add`{.action} or `Edit`{.action}, depending on whether you are configuring a new or existing front-end. +Once the front-end has been configured, click `Add`{.action} or `Modify`{.action}, depending on whether you are configuring a new or existing front-end. -Please remember to deploy the configuration. There are two ways of doing this: +Remember to deploy the configuration. There are two ways to do this: -- via the `Status`{.action} section of the OVH Control Panel, by clicking on your Load Balancer’s `...`{.action} button, then selecting `Apply configuration`{.action} +- via the `Status`{.action} section of the `Home`{.action} tab of your OVHcloud Control Panel, by clicking on the `...`{.action} button next to your Load Balancer's ID and selecting `Apply configuration`{.action} -- via the reminder box in the OVH Control Panel, notifying you that the configuration has not been applied, by clicking `Apply configuration`{.action} +- via the reminder box in the OVHcloud Control Panel, which notifies you that the configuration has not been applied, by clicking `Apply configuration`{.action}. ![Apply a Load Balancer configuration](images/apply_configuration.png){.thumbnail} ## Go further -Join our community of users on . +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/howto_route_ipfo/guide.en-sg.md b/pages/network/load_balancer/howto_route_ipfo/guide.en-sg.md index 9900b5b2169..79b25b05c19 100644 --- a/pages/network/load_balancer/howto_route_ipfo/guide.en-sg.md +++ b/pages/network/load_balancer/howto_route_ipfo/guide.en-sg.md @@ -1,149 +1,146 @@ --- -title: 'Routing an Additional IP' -excerpt: 'Find out how to route an Additional IP and link it to the OVH Load Balancer' -updated: 2022-10-06 +title: 'How to route an Additional IP' +excerpt: 'Find out how to route an Additional IP and link it to the OVHcloud Load Balancer' +updated: 2025-11-27 --- -> [!primary] -> -> Since October 6th, 2022 our service "Failover IP" is named [Additional IP](/links/network/additional-ip). This renaming has no effect on its technical features. -> - ## Objective -An Additional IP is an IP address that can be switched from one service to another. In doing so, it helps you avoid a wide range of issues for your infrastructure (hardware failures, overload for your services, maintenance, etc.). +An **Additional IP** is an IP address that can be switched from one service to another. This capability helps you maintain infrastructure continuity by mitigating issues such as hardware failures, service overload, or maintenance downtime. -For more information on Additional IPs, you can consult our [webpage](/links/bare-metal/ip). +For more information on Additional IPs, please consult our [webpage](/links/bare-metal/ip). -The OVH Load Balancer solution offers load balancing features for a range of different protocols: HTTP, HTTPS, TCP and UDP. When you link it to an Additional IP, you can switch over your existing infrastructure to a Load Balancer without disturbing or interrupting services for your customers. Effectively, you will not need to change the IP address any longer if you are still using the Additional IP, so you will not need to wait for your DNS zone to propagate any changes. +The OVHcloud Load Balancer solution provides load balancing features for various protocols, including HTTP, HTTPS, TCP, and UDP. Linking it to an Additional IP allows you to switch your existing infrastructure to the Load Balancer without service interruption. Since you continue using the Additional IP, you avoid the need to change your public IP address and wait for DNS zone propagation. Using an additional IP means you avoid the need to change your service's IP address, and no longer have to wait for your DNS zone to propagate changes. -For more information on the OVH Load Balancer solution, you can read our [Introduction to the OVH Load Balancer](/pages/network/load_balancer/use_presentation). +For more information on the OVHcloud Load Balancer solution, please read our [Introduction to the OVHcloud Load Balancer](/pages/network/load_balancer/use_presentation) guide. -**This guide will explain how to use the Additional IP with the OVH Load Balancer service.** +**This guide explains how to use an Additional IP with the OVHcloud Load Balancer service.** ## Requirements -- a correctly configured [OVH Load Balancer](https://www.ovh.com/sg/solutions/load-balancer/) -- an [Additional IP](/links/bare-metal/ip) +- A configured [OVHcloud Load Balancer](/links/network/load-balancer) +- An [Additional IP](/links/bare-metal/ip) +- Access to the [OVHcloud Control Panel](/links/manager) +- Access to the [OVHcloud API](/links/api) > [!primary] > -> **The required Load Balancer configuration.** +> **Required Load Balancer configuration** > -> Once you have confirmed the changes in the list of Additional IPs associated with the Load Balancer, you need to be able to refresh them. Several conditions need to be met for this to work. +> Once you confirm the changes in the list of Additional IPs associated with the Load Balancer, the configuration needs to be refreshed. Several conditions must be met for this to work: > -> - If the Load Balancer is in a vRack, all of the farms must also be in the vRack. The Load Balancer must also have its vLAN. Otherwise, there should not be any farms in a vRack. +> - **vRack configuration:** If the Load Balancer is in a vRack, all farms must also be in the vRack, and the Load Balancer must have its vLAN defined. Otherwise, there should be no farms in a vRack. > -> - At least one existing front-end. All of the front-ends must be valid. They can be enabled and disabled, with either: -> - a valid route (with routing rules) -> - a redirection (`redirectLocation`{.action}) -> - a default farm +> - **Front-end validity:** At least one front-end must exist, and all front-ends must be valid. They can be enabled or disabled, but must have either: +>    - a valid route (with routing rules) +>    - a redirection (`redirectLocation`{.action}) +>    - a default farm > -> - Nothing else should be refreshed for the Load Balancer. A Load Balancer cannot be refreshed several times at once. Doing so would not make any changes to the resulting configuration. +> - **Configuration state:** The Load Balancer must not be undergoing any other refresh process. A Load Balancer cannot be refreshed several times at once, as this would prevent changes from being applied to the resulting configuration. > ## Instructions -In this document, we will look at two distinct uses: +In this document, we will cover two distinct use cases: -- linking an Additional IP to the OVH Load Balancer service -- linking an Additional IP to a single front-end of the OVH Load Balancer service +- linking an Additional IP to the overall OVHcloud Load Balancer service +- linking an Additional IP to a single front-end of the OVHcloud Load Balancer service -### Add an Additional IP. +### Add an Additional IP to the OVHcloud Load Balancer -You can link these IPs to your OVH Load Balancer via the [OVH API](https://ca.api.ovh.com). -The API call for this is as follows: +You can link these IPs to your OVHcloud Load Balancer via the [OVHcloud API](/links/api). +The API call for this is: > [!api] > > @api {v1} /ip POST /ip/{ip}/move > -You can then list the Additional IPs linked to your OVH Load Balancer with the following API call: +You can then list the Additional IPs linked to your OVHcloud Load Balancer with the following API call: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/failover > -The Additional IPs linked to your Load Balancer will be available for all of your front-ends. This is contrary to the following case, in which we will link an Additional IP to a single front-end. +Additional IPs linked this way are available for **all** your front-ends. This differs from the next case, where an Additional IP is linked to a single front-end. -## Dedicated Additional IP. +### Add a dedicated Additional IP to a front-end -No matter what kind of front-end you wish to use, you can define a list of dedicated Additional IPs that will be linked to them. Please note that in this particular case, your Additional IP will be attached to only one single front-end. As a result, it will only give access to the service provided by this front-end. The services for your other front-ends will be accessible via your IP Load Balancer’s IP address. +Regardless of the front-end type, you can define a list of dedicated Additional IPs to be linked to it. In this specific case, your Additional IP will be attached to **only one** single front-end. As a result, it will only grant access to the service provided by that front-end. Services for your other front-ends will remain accessible via your IP Load Balancer’s primary IP address. -### Via the API. +#### Via the API -#### If you are creating a front-end: +**If you are creating a front-end:** -From the [OVH API](https://ca.api.ovh.com), you can use the following call to define one or more Additional IPs on a front-end as you create it: +From the [OVHcloud API](/links/api), you can use the following calls to define one or more Additional IPs on a front-end during its creation: -* HTTP protocol +- HTTP protocol > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend > -* TCP protocol +- TCP protocol > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/frontend > -* UDP protocol +- UDP protocol > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/frontend > -#### If you are updating an existing front-end: +**If you are updating an existing front-end:** -From the [OVH API](https://ca.api.ovh.com), you can use the following call to define one or more Additional IPs on an existing front-end: +From the [OVHcloud API](/links/api), you can use the following calls to define one or more Additional IPs on an existing front-end: -* HTTP protocol +- HTTP protocol > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId} > -* TCP protocol +- TCP protocol > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId} > -* UDP protocol +- UDP protocol > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId} > -### Via the OVH Control Panel. +#### Via the OVHcloud Control Panel -You can define dedicated Additional IPs via the [OVH Control Panel](/links/manager) by going to the `Cloud`{.action} section, then `Load Balancer`{.action}. +You can define dedicated Additional IPs via the [OVHcloud Control Panel](/links/manager) by navigating to the `Network`{.action} section, then `Load Balancer`{.action}. -Once you have selected the Load Balancer you want to modify, create a new front-end, or edit an existing one. +Once you have selected the Load Balancer you want to modify, navigate to the `Front-ends`{.action} tab, where you can either create a new front-end or edit an existing one. -In `Advanced settings`{.action}, you can select the Additional IPs you would like to add to your front-end. +In `Advanced settings`{.action}, you can select the Additional IPs you would like to associate with your front-end. ![Configure the front-end by associating an Additional IP](images/iplb_frontend.png){.thumbnail} -Once the front-end has been configured, click `Add`{.action} or `Edit`{.action}, depending on whether you are configuring a new or existing front-end. +Once the front-end has been configured, click `Add`{.action} or `Modify`{.action}, depending on whether you are configuring a new or existing front-end. -Please remember to deploy the configuration. There are two ways of doing this: +Remember to deploy the configuration. There are two ways to do this: -- via the `Status`{.action} section of the OVH Control Panel, by clicking on your Load Balancer’s `...`{.action} button, then selecting `Apply configuration`{.action} +- via the `Status`{.action} section of the `Home`{.action} tab of your OVHcloud Control Panel, by clicking on the `...`{.action} button next to your Load Balancer's ID and selecting `Apply configuration`{.action} -- via the reminder box in the OVH Control Panel, notifying you that the configuration has not been applied, by clicking `Apply configuration`{.action} +- via the reminder box in the OVHcloud Control Panel, which notifies you that the configuration has not been applied, by clicking `Apply configuration`{.action}. ![Apply a Load Balancer configuration](images/apply_configuration.png){.thumbnail} ## Go further -Join our community of users on . +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/howto_route_ipfo/guide.en-us.md b/pages/network/load_balancer/howto_route_ipfo/guide.en-us.md index 36af4973b1a..79b25b05c19 100644 --- a/pages/network/load_balancer/howto_route_ipfo/guide.en-us.md +++ b/pages/network/load_balancer/howto_route_ipfo/guide.en-us.md @@ -1,149 +1,146 @@ --- -title: 'Routing an Additional IP' -excerpt: 'Find out how to route an Additional IP and link it to the OVH Load Balancer' -updated: 2022-10-06 +title: 'How to route an Additional IP' +excerpt: 'Find out how to route an Additional IP and link it to the OVHcloud Load Balancer' +updated: 2025-11-27 --- -> [!primary] -> -> Since October 6th, 2022 our service "Failover IP" is named [Additional IP](/links/network/additional-ip). This renaming has no effect on its technical features. -> - ## Objective -An Additional IP is an IP address that can be switched from one service to another. In doing so, it helps you avoid a wide range of issues for your infrastructure (hardware failures, overload for your services, maintenance, etc.). +An **Additional IP** is an IP address that can be switched from one service to another. This capability helps you maintain infrastructure continuity by mitigating issues such as hardware failures, service overload, or maintenance downtime. -For more information on Additional IPs, you can consult our [webpage](/links/bare-metal/ip). +For more information on Additional IPs, please consult our [webpage](/links/bare-metal/ip). -The OVH Load Balancer solution offers load balancing features for a range of different protocols: HTTP, HTTPS, TCP and UDP. When you link it to an Additional IP, you can switch over your existing infrastructure to a Load Balancer without disturbing or interrupting services for your customers. Effectively, you will not need to change the IP address any longer if you are still using the Additional IP, so you will not need to wait for your DNS zone to propagate any changes. +The OVHcloud Load Balancer solution provides load balancing features for various protocols, including HTTP, HTTPS, TCP, and UDP. Linking it to an Additional IP allows you to switch your existing infrastructure to the Load Balancer without service interruption. Since you continue using the Additional IP, you avoid the need to change your public IP address and wait for DNS zone propagation. Using an additional IP means you avoid the need to change your service's IP address, and no longer have to wait for your DNS zone to propagate changes. -For more information on the OVH Load Balancer solution, you can read our [Introduction to the OVH Load Balancer](/pages/network/load_balancer/use_presentation). +For more information on the OVHcloud Load Balancer solution, please read our [Introduction to the OVHcloud Load Balancer](/pages/network/load_balancer/use_presentation) guide. -**This guide will explain how to use the Additional IP with the OVH Load Balancer service.** +**This guide explains how to use an Additional IP with the OVHcloud Load Balancer service.** ## Requirements -- a correctly configured [OVH Load Balancer](https://www.ovh.com/world/solutions/load-balancer/) -- an [Additional IP](/links/bare-metal/ip) +- A configured [OVHcloud Load Balancer](/links/network/load-balancer) +- An [Additional IP](/links/bare-metal/ip) +- Access to the [OVHcloud Control Panel](/links/manager) +- Access to the [OVHcloud API](/links/api) > [!primary] > -> **The required Load Balancer configuration.** +> **Required Load Balancer configuration** > -> Once you have confirmed the changes in the list of Additional IPs associated with the Load Balancer, you need to be able to refresh them. Several conditions need to be met for this to work. +> Once you confirm the changes in the list of Additional IPs associated with the Load Balancer, the configuration needs to be refreshed. Several conditions must be met for this to work: > -> - If the Load Balancer is in a vRack, all of the farms must also be in the vRack. The Load Balancer must also have its vLAN. Otherwise, there should not be any farms in a vRack. +> - **vRack configuration:** If the Load Balancer is in a vRack, all farms must also be in the vRack, and the Load Balancer must have its vLAN defined. Otherwise, there should be no farms in a vRack. > -> - At least one existing front-end. All of the front-ends must be valid. They can be enabled and disabled, with either: -> - a valid route (with routing rules) -> - a redirection (`redirectLocation`{.action}) -> - a default farm +> - **Front-end validity:** At least one front-end must exist, and all front-ends must be valid. They can be enabled or disabled, but must have either: +>    - a valid route (with routing rules) +>    - a redirection (`redirectLocation`{.action}) +>    - a default farm > -> - Nothing else should be refreshed for the Load Balancer. A Load Balancer cannot be refreshed several times at once. Doing so would not make any changes to the resulting configuration. +> - **Configuration state:** The Load Balancer must not be undergoing any other refresh process. A Load Balancer cannot be refreshed several times at once, as this would prevent changes from being applied to the resulting configuration. > ## Instructions -In this document, we will look at two distinct uses: +In this document, we will cover two distinct use cases: -- linking an Additional IP to the OVH Load Balancer service -- linking an Additional IP to a single front-end of the OVH Load Balancer service +- linking an Additional IP to the overall OVHcloud Load Balancer service +- linking an Additional IP to a single front-end of the OVHcloud Load Balancer service -### Add an Additional IP. +### Add an Additional IP to the OVHcloud Load Balancer -You can link these IPs to your OVH Load Balancer via the [OVH API](https://ca.api.ovh.com). -The API call for this is as follows: +You can link these IPs to your OVHcloud Load Balancer via the [OVHcloud API](/links/api). +The API call for this is: > [!api] > > @api {v1} /ip POST /ip/{ip}/move > -You can then list the Additional IPs linked to your OVH Load Balancer with the following API call: +You can then list the Additional IPs linked to your OVHcloud Load Balancer with the following API call: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/failover > -The Additional IPs linked to your Load Balancer will be available for all of your front-ends. This is contrary to the following case, in which we will link an Additional IP to a single front-end. +Additional IPs linked this way are available for **all** your front-ends. This differs from the next case, where an Additional IP is linked to a single front-end. -## Dedicated Additional IP. +### Add a dedicated Additional IP to a front-end -No matter what kind of front-end you wish to use, you can define a list of dedicated Additional IPs that will be linked to them. Please note that in this particular case, your Additional IP will be attached to only one single front-end. As a result, it will only give access to the service provided by this front-end. The services for your other front-ends will be accessible via your IP Load Balancer’s IP address. +Regardless of the front-end type, you can define a list of dedicated Additional IPs to be linked to it. In this specific case, your Additional IP will be attached to **only one** single front-end. As a result, it will only grant access to the service provided by that front-end. Services for your other front-ends will remain accessible via your IP Load Balancer’s primary IP address. -### Via the API. +#### Via the API -#### If you are creating a front-end: +**If you are creating a front-end:** -From the [OVH API](https://ca.api.ovh.com), you can use the following call to define one or more Additional IPs on a front-end as you create it: +From the [OVHcloud API](/links/api), you can use the following calls to define one or more Additional IPs on a front-end during its creation: -* HTTP protocol +- HTTP protocol > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend > -* TCP protocol +- TCP protocol > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/frontend > -* UDP protocol +- UDP protocol > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/frontend > -#### If you are updating an existing front-end: +**If you are updating an existing front-end:** -From the [OVH API](https://ca.api.ovh.com), you can use the following call to define one or more Additional IPs on an existing front-end: +From the [OVHcloud API](/links/api), you can use the following calls to define one or more Additional IPs on an existing front-end: -* HTTP protocol +- HTTP protocol > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId} > -* TCP protocol +- TCP protocol > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId} > -* UDP protocol +- UDP protocol > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId} > -### Via the OVH Control Panel. +#### Via the OVHcloud Control Panel -You can define dedicated Additional IPs via the [OVH Control Panel](/links/manager) by going to the `Cloud`{.action} section, then `Load Balancer`{.action}. +You can define dedicated Additional IPs via the [OVHcloud Control Panel](/links/manager) by navigating to the `Network`{.action} section, then `Load Balancer`{.action}. -Once you have selected the Load Balancer you want to modify, create a new front-end, or edit an existing one. +Once you have selected the Load Balancer you want to modify, navigate to the `Front-ends`{.action} tab, where you can either create a new front-end or edit an existing one. -In `Advanced settings`{.action}, you can select the Additional IPs you would like to add to your front-end. +In `Advanced settings`{.action}, you can select the Additional IPs you would like to associate with your front-end. ![Configure the front-end by associating an Additional IP](images/iplb_frontend.png){.thumbnail} -Once the front-end has been configured, click `Add`{.action} or `Edit`{.action}, depending on whether you are configuring a new or existing front-end. +Once the front-end has been configured, click `Add`{.action} or `Modify`{.action}, depending on whether you are configuring a new or existing front-end. -Please remember to deploy the configuration. There are two ways of doing this: +Remember to deploy the configuration. There are two ways to do this: -- via the `Status`{.action} section of the OVH Control Panel, by clicking on your Load Balancer’s `...`{.action} button, then selecting `Apply configuration`{.action} +- via the `Status`{.action} section of the `Home`{.action} tab of your OVHcloud Control Panel, by clicking on the `...`{.action} button next to your Load Balancer's ID and selecting `Apply configuration`{.action} -- via the reminder box in the OVH Control Panel, notifying you that the configuration has not been applied, by clicking `Apply configuration`{.action} +- via the reminder box in the OVHcloud Control Panel, which notifies you that the configuration has not been applied, by clicking `Apply configuration`{.action}. ![Apply a Load Balancer configuration](images/apply_configuration.png){.thumbnail} ## Go further -Join our community of users on . +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/howto_route_ipfo/guide.fr-ca.md b/pages/network/load_balancer/howto_route_ipfo/guide.fr-ca.md index 159af599fcb..cefa2beaae5 100644 --- a/pages/network/load_balancer/howto_route_ipfo/guide.fr-ca.md +++ b/pages/network/load_balancer/howto_route_ipfo/guide.fr-ca.md @@ -1,154 +1,146 @@ --- -title: 'Router une Additional IP' -excerpt: 'Router une Additional IP' -updated: 2022-10-06 +title: 'Comment router une Additional IP' +excerpt: 'Découvrez comment router une Additional IP et la lier au service OVHcloud Load Balancer' +updated: 2025-11-27 --- -> [!primary] -> -> Depuis le 6 octobre 2022, notre solution "IP Failover" s'appelle désormais [Additional IP](/links/network/additional-ip). Cela n'a pas d'impact sur ses fonctionnalités. -> - ## Objectif Une Additional IP est une adresse IP basculable d'un service à l'autre. Elle offre donc la possibilité de disposer d'une infrastructure résistant à une grande diversité de problèmes (pannes matérielles, surcharges de vos services, maintenance...). -Pour plus d'informations sur l'Additional IP nous vous recommandons la lecture du [document de présentation](/links/bare-metal/ip). +Pour plus d'informations sur l'Additional IP, nous vous recommandons la lecture du [document de présentation](/links/bare-metal/ip). -Le service OVH Load Balancer offre quant à lui des fonctionnalités de répartition de charge sur différents protocoles : HTTP, HTTPS, TCP et UDP. Associé à une Additional IP, il devient possible de basculer votre infrastructure existante vers un Load Balancer sans perturber ou interrompre les services de vos clients. En effet il n'y aura désormais plus de changement d'adresse IP dans la mesure où vous utiliserez toujours l'Additional IP, donc pas de délai de propagation des DNS. +Le service OVHcloud Load Balancer offre quant à lui des fonctionnalités de répartition de charge sur différents protocoles : HTTP, HTTPS, TCP et UDP. Associé à une Additional IP, il devient possible de basculer votre infrastructure existante vers un Load Balancer sans perturber ou interrompre les services de vos clients. En effet il n'y aura désormais plus de changement d'adresse IP dans la mesure où vous utiliserez toujours l'Additional IP, donc pas de délai de propagation des DNS. -Pour plus d'informations sur le service OVH Load Balancer, nous vous conseillons de consulter la [présentation générale](/pages/network/load_balancer/use_presentation). +Pour plus d'informations sur le service OVHcloud Load Balancer, veuillez lire notre [Introduction à Load Balancer OVHcloud](/pages/network/load_balancer/use_presentation). -**Ce guide vous explique comment utiliser une Additional IP avec le service OVH Load Balancer.** +**Ce guide explique comment utiliser une Additional IP avec le service Load Balancer OVHcloud.** ## Prérequis -- Disposer d'un [Load Balancer OVH](https://www.ovh.com/ca/fr/solutions/load-balancer/) correctement configuré. -- Disposer d'une [Additional IP](/links/bare-metal/ip). +- Un [Load Balancer OVHcloud](/links/network/load-balancer) configuré +- Une [Additional IP](/links/bare-metal/ip) +- Accès à [l'espace client OVHcloud](/links/manager) +- Accès à [l'API OVHcloud](/links/api) > [!primary] > -> **Configuration du Load Balancer requise** +> **Configuration requise du Load Balancer** > -> Afin de valider le changement dans la liste des Additional IPs associées au Load Balancer, il est nécessaire de pouvoir actualiser celui-ci. Pour ce faire, plusieurs conditions doivent être réunies. +> Une fois que vous confirmez les modifications dans la liste des Additional IPs associées au Load Balancer, la configuration doit être rafraîchie. Plusieurs conditions doivent être remplies pour que cela fonctionne : > -> - Si le Load Balancer est dans un vRack, toutes les fermes doivent être dans le vRack. De plus, le Load Balancer doit disposer de son vLAN. Sinon, aucune ferme ne doit être dans un vRack. +> - **Configuration du vRack :** Si le Load Balancer est dans un vRack, toutes les fermes doivent également être dans le vRack, et le Load Balancer doit avoir son vLAN défini. Sinon, il ne doit pas y avoir de fermes dans un vRack. > -> - Au moins un frontend présent. Tous les frontends doivent être valides. Ils peuvent donc être désactivés ou activés, avec soit : -> - une route valide (avec une règle de routage) ; -> - une redirection (`redirectLocation`{.action}) ; -> - une ferme par défaut. +> - **Validité du frontend :** Il doit exister au moins un frontend, et tous les frontends doivent être valides. Ils peuvent être activés ou désactivés, mais doivent avoir soit : +>    - une route valide (avec des règles de routage) +>    - une redirection (`redirectLocation`{.action}) +>    - une ferme par défaut > -> - Aucun autre rafraîchissement du Load Balancer ne doit être en cours. Un Load Balancer ne peut pas être actualisé/rafraîchi plusieurs fois en même temps. Cela n'aurait pas de sens quand à la configuration résultante. +> - **État de la configuration :** Le Load Balancer ne doit pas être en cours de rafraîchissement. Un Load Balancer ne peut pas être rafraîchi plusieurs fois en même temps, car cela empêcherait les modifications d'être appliquées à la configuration résultante. > ## En pratique -Dans la suite de ce document, nous allons voir 2 cas d'usages distincts. +Dans ce document, nous aborderons deux cas d'utilisation distincts : -- Associer une Additional IP à votre service OVH Load Balancer. -- Associer une Additional IP à un seul et unique frontend de votre service OVH Load Balancer. +- lier une Additional IP à l'ensemble du service Load Balancer OVHcloud +- lier une Additional IP à un seul frontend du service Load Balancer OVHcloud -### Ajouter une Additional IP -Depuis l'[API OVH](https://ca.api.ovh.com) vous pouvez associer ces IPs avec votre service OVH Load Balancer. -Voici l'appel API pour cela : +### Ajouter une Additional IP au Load Balancer OVHcloud + +Vous pouvez lier ces adresses IP à votre Load Balancer OVHcloud via l'[API OVHcloud](/links/api). +L'appel API correspondant est le suivant : > [!api] > > @api {v1} /ip POST /ip/{ip}/move > -Vous pouvez ensuite lister les Additional IPs attachées à votre OVH Load Balancer à l'aide de l'appel suivant : +Vous pouvez ensuite lister les Additional IPs liées à votre Load Balancer OVHcloud avec l'appel API suivant : > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/failover > -Les Additional IPss attachées à votre Load Balancer seront disponibles pour tous vos frontends. -Contrairement au cas suivant dans lequel nous allons attacher une Additional IP à un seul frontend. +Les Additional IPs liées de cette manière sont disponibles pour **tous** vos frontends. Cela diffère du cas suivant, où une Additional IP est liée à un seul frontend. + +### Ajouter une Additional IP dédiée à un frontend -## Additional IP dédiée -Quelque soit le type de frontend que vous souhaitez utiliser, il est possible de définir une liste d'Additional IPs dédiées qui lui seront attachées. -À noter que dans ce cas précis votre Additional IP sera rattachée à un seul et unique frontend. -Elle ne permettra donc d'accéder qu'aux services fournis par ce frontend. -Les services de vos autres frontends restent quant à eux accessibles via l'adresse IP de votre IPLB. +Quel que soit le type de frontend, vous pouvez définir une liste d'Additional IPs qui y seront liées. Dans ce cas précis, votre Additional IP sera attachée à **un seul** frontend. En conséquence, elle n'accordera l'accès qu'au service fourni par ce frontend. Les services de vos autres frontends resteront accessibles via l'adresse IP principale de votre Load Balancer. -### Via l'API +#### Via l'API -#### Création d'un Frontend +**Si vous créez un frontend :** -Depuis l'[API OVH](https://ca.api.ovh.com), l'appel suivant vous permettra de définir une ou plusieurs Additional IPss sur un frontend pendant sa création : +Depuis l'[API OVHcloud](/links/api), vous pouvez utiliser les appels suivants pour définir une ou plusieurs Additional IPs sur un frontend lors de sa création : -* protocole HTTP +- Protocole HTTP > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend > -* protocole TCP +- Protocole TCP > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/frontend > -* protocole UDP +- Protocole UDP > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/frontend > -#### Mise à jour d'un Frontend +**Si vous mettez à jour un frontend existant :** -Toujours depuis l'[API OVH](https://ca.api.ovh.com), l'appel suivant vous permettra de définir une ou plusieurs Additional IPss sur un frontend existant : +Depuis l'[API OVHcloud](/links/api), vous pouvez utiliser les appels suivants pour définir une ou plusieurs Additional IPs sur un frontend existant : -* protocole HTTP +- Protocole HTTP > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId} > -* protocole TCP +- Protocole TCP > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId} > -* protocole UDP +- Protocole UDP > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId} > -### Depuis le Manager -Il est enfin possible de définir vos Additional IPs dédiées depuis l'[espace client](/links/manager) dans la partie `Cloud`{.action}, section `Load Balancer`{.action}. +#### Via l'espace client OVHcloud + +Vous pouvez définir des Additional IPs dédiées via l'[espace client OVHcloud](/links/manager) en accédant à la section `Réseau`{.action}, puis à `Load Balancer`{.action}. + +Une fois que vous avez sélectionné le Load Balancer que vous souhaitez modifier, accédez à l'onglet `frontends`{.action}, où vous pouvez créer un nouveau frontend ou modifier un frontend existant. -Après avoir sélectionné le Load Balancer que vous souhaitez modifier, -créez un nouveau Frontend, ou éditez en un existants. +Dans `Paramètres avancés`{.action}, vous pouvez sélectionner les Additional IPs que vous souhaitez associer à votre frontend. -Dans les `Paramètres avancés`{.action}, vous pourrez choisir la ou les Additional IPss que vous souhaitez associer à votre Frontend. +![Configurer le frontend en associant une Additional IP](images/iplb_frontend.png){.thumbnail} -![Configurer le frontend en associant une IP Fail-Over](images/iplb_frontend.png){.thumbnail} +Une fois le frontend configuré, cliquez sur `Ajouter`{.action} ou `Mettre à jour`{.action}, selon que vous configurez un nouveau frontend ou un frontend existant. -Une fois le frontend configuré, cliquez sur `Ajouter`{.action} ou `Modifier`{.action} selon que vous configuriez un nouveau frontend, ou un frontend existant. -N'oubliez pas de déployer la configuration. -Pour ce faire, vous pouvez au choix : +N’oubliez pas de déployer la configuration. Il existe deux façons de le faire : -- dans la section `Statut`{.action} de la page d'accueil du Manager, -cliquez sur le bouton `...`{.action} de votre Load Balancer, -et sélectionnez `Appliquer la configuration`{.action} ; +- via la section `Statut`{.action} de l’onglet `Accueil`{.action} de votre espace client OVHcloud, en cliquant sur le bouton `...`{.action} à côté de l’ID de votre Load Balancer et en sélectionnant `Appliquer la configuration`{.action} -- dans le bandeau de rappel du Manager vous précisant que la configuration n'est pas appliquée, -cliquez sur `Appliquer la configuration`{.action}. +- via la bannière dans l’espace client OVHcloud, qui vous informe que la configuration n’a pas été appliquée, en cliquant sur `Appliquer la configuration`{.action}. -![Application d'une Configuration d'un Load Balancer](images/apply_configuration.png){.thumbnail} +![Appliquer une configuration de Load Balancer](images/apply_configuration.png){.thumbnail} ## Aller plus loin -Échangez avec notre [communauté d'utilisateurs](/links/community). +Échangez avec notre [communauté d'utilisateurs](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/howto_route_ipfo/guide.fr-fr.md b/pages/network/load_balancer/howto_route_ipfo/guide.fr-fr.md index 090b76827ca..cefa2beaae5 100644 --- a/pages/network/load_balancer/howto_route_ipfo/guide.fr-fr.md +++ b/pages/network/load_balancer/howto_route_ipfo/guide.fr-fr.md @@ -1,14 +1,9 @@ --- -title: "Routage d'une Additional IP" -excerpt: 'Ce guide vous explique comment utiliser une Additional IP avec le service OVHcloud Load Balancer' -updated: 2022-10-06 +title: 'Comment router une Additional IP' +excerpt: 'Découvrez comment router une Additional IP et la lier au service OVHcloud Load Balancer' +updated: 2025-11-27 --- -> [!primary] -> -> Depuis le 6 octobre 2022, notre solution "IP Failover" s'appelle désormais [Additional IP](/links/network/additional-ip). Cela n'a pas d'impact sur ses fonctionnalités. -> - ## Objectif Une Additional IP est une adresse IP basculable d'un service à l'autre. Elle offre donc la possibilité de disposer d'une infrastructure résistant à une grande diversité de problèmes (pannes matérielles, surcharges de vos services, maintenance...). @@ -17,137 +12,135 @@ Pour plus d'informations sur l'Additional IP, nous vous recommandons la lecture Le service OVHcloud Load Balancer offre quant à lui des fonctionnalités de répartition de charge sur différents protocoles : HTTP, HTTPS, TCP et UDP. Associé à une Additional IP, il devient possible de basculer votre infrastructure existante vers un Load Balancer sans perturber ou interrompre les services de vos clients. En effet il n'y aura désormais plus de changement d'adresse IP dans la mesure où vous utiliserez toujours l'Additional IP, donc pas de délai de propagation des DNS. -Pour plus d'informations sur le service OVHcloud Load Balancer, nous vous conseillons de consulter la [présentation générale de l'offre](/pages/network/load_balancer/use_presentation). +Pour plus d'informations sur le service OVHcloud Load Balancer, veuillez lire notre [Introduction à Load Balancer OVHcloud](/pages/network/load_balancer/use_presentation). -**Ce guide vous explique comment utiliser une Additional IP avec le service OVHcloud Load Balancer.** +**Ce guide explique comment utiliser une Additional IP avec le service Load Balancer OVHcloud.** ## Prérequis -- Disposer d'un [Load Balancer OVHcloud](/links/network/load-balancer) correctement configuré. -- Disposer d'une [Additional IP](/links/bare-metal/ip). +- Un [Load Balancer OVHcloud](/links/network/load-balancer) configuré +- Une [Additional IP](/links/bare-metal/ip) +- Accès à [l'espace client OVHcloud](/links/manager) +- Accès à [l'API OVHcloud](/links/api) > [!primary] > -> **Configuration du Load Balancer requise** +> **Configuration requise du Load Balancer** > -> Afin de valider le changement dans la liste des Additional IPs associées au Load Balancer, il est nécessaire de pouvoir actualiser celui-ci. Pour ce faire, plusieurs conditions doivent être réunies : +> Une fois que vous confirmez les modifications dans la liste des Additional IPs associées au Load Balancer, la configuration doit être rafraîchie. Plusieurs conditions doivent être remplies pour que cela fonctionne : > -> - Si le Load Balancer est dans un vRack, toutes les fermes doivent être dans le vRack. De plus, le Load Balancer doit disposer de son vLAN. Sinon, aucune ferme ne doit être dans un vRack. +> - **Configuration du vRack :** Si le Load Balancer est dans un vRack, toutes les fermes doivent également être dans le vRack, et le Load Balancer doit avoir son vLAN défini. Sinon, il ne doit pas y avoir de fermes dans un vRack. > -> - Au moins un frontend présent. Tous les frontends doivent être valides. Ils peuvent donc être désactivés ou activés, avec soit : -> - une route valide (avec une règle de routage) ; -> - une redirection (`redirectLocation`{.action}) ; -> - une ferme par défaut. +> - **Validité du frontend :** Il doit exister au moins un frontend, et tous les frontends doivent être valides. Ils peuvent être activés ou désactivés, mais doivent avoir soit : +>    - une route valide (avec des règles de routage) +>    - une redirection (`redirectLocation`{.action}) +>    - une ferme par défaut > -> - Aucun autre rafraîchissement du Load Balancer ne doit être en cours. Un Load Balancer ne peut pas être actualisé/rafraîchi plusieurs fois en même temps. Cela n'aurait pas de sens quand à la configuration résultante. +> - **État de la configuration :** Le Load Balancer ne doit pas être en cours de rafraîchissement. Un Load Balancer ne peut pas être rafraîchi plusieurs fois en même temps, car cela empêcherait les modifications d'être appliquées à la configuration résultante. > ## En pratique -Dans la suite de ce document, nous allons voir 2 cas d'usages distincts. - -- Associer une Additional IP à votre service OVHcloud Load Balancer. -- Associer une Additional IP à un seul et unique frontend de votre service OVHcloud Load Balancer. +Dans ce document, nous aborderons deux cas d'utilisation distincts : -### Ajouter une Additional IP +- lier une Additional IP à l'ensemble du service Load Balancer OVHcloud +- lier une Additional IP à un seul frontend du service Load Balancer OVHcloud -Depuis l'[API OVHcloud](https://api.ovh.com), vous pouvez associer ces IPs avec votre service OVHcloud Load Balancer. +### Ajouter une Additional IP au Load Balancer OVHcloud -Voici l'appel API pour cela : +Vous pouvez lier ces adresses IP à votre Load Balancer OVHcloud via l'[API OVHcloud](/links/api). +L'appel API correspondant est le suivant : > [!api] > > @api {v1} /ip POST /ip/{ip}/move > -Vous pouvez ensuite lister les Additional IPs attachées à votre OVHcloud Load Balancer à l'aide de l'appel suivant : +Vous pouvez ensuite lister les Additional IPs liées à votre Load Balancer OVHcloud avec l'appel API suivant : > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/failover > -Les Additional IPs attachées à votre Load Balancer seront disponibles pour tous vos frontends. -Contrairement au cas suivant dans lequel nous allons attacher une Additional IP à un seul frontend. +Les Additional IPs liées de cette manière sont disponibles pour **tous** vos frontends. Cela diffère du cas suivant, où une Additional IP est liée à un seul frontend. -### Additional IP dédiée +### Ajouter une Additional IP dédiée à un frontend -Quel que soit le type de frontend que vous souhaitez utiliser, il est possible de définir une liste d'Additional IPs dédiées qui lui seront attachées. -À noter que, dans ce cas précis, votre Additional IP sera rattachée à un seul et unique frontend. -Elle ne permettra donc d'accéder qu'aux services fournis par ce frontend. -Les services de vos autres frontends restent quant à eux accessibles via l'adresse IP de votre IPLB. +Quel que soit le type de frontend, vous pouvez définir une liste d'Additional IPs qui y seront liées. Dans ce cas précis, votre Additional IP sera attachée à **un seul** frontend. En conséquence, elle n'accordera l'accès qu'au service fourni par ce frontend. Les services de vos autres frontends resteront accessibles via l'adresse IP principale de votre Load Balancer. -#### Depuis l'API OVHcloud +#### Via l'API -##### **Création d'un frontend** +**Si vous créez un frontend :** -Depuis l'[API OVHcloud](https://api.ovh.com), l'appel suivant vous permettra de définir une ou plusieurs Additional IPs sur un frontend pendant sa création : +Depuis l'[API OVHcloud](/links/api), vous pouvez utiliser les appels suivants pour définir une ou plusieurs Additional IPs sur un frontend lors de sa création : -- protocole HTTP +- Protocole HTTP > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend > -- protocole TCP +- Protocole TCP > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/frontend > -- protocole UDP +- Protocole UDP > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/frontend > -##### **Mise à jour d'un frontend** +**Si vous mettez à jour un frontend existant :** -Toujours depuis l'[API OVHcloud](https://api.ovh.com), l'appel suivant vous permettra de définir une ou plusieurs Additional IPs sur un frontend existant : +Depuis l'[API OVHcloud](/links/api), vous pouvez utiliser les appels suivants pour définir une ou plusieurs Additional IPs sur un frontend existant : -- protocole HTTP +- Protocole HTTP > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId} > -- protocole TCP +- Protocole TCP > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId} > -- protocole UDP +- Protocole UDP > [!api] > > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId} > -#### Depuis l'espace client OVHcloud +#### Via l'espace client OVHcloud + +Vous pouvez définir des Additional IPs dédiées via l'[espace client OVHcloud](/links/manager) en accédant à la section `Réseau`{.action}, puis à `Load Balancer`{.action}. -Vous pouvez définir vos Additional IPs dédiées depuis l'[espace client OVHcloud](/links/manager). Rendez-vous dans la partie `Bare metal Cloud`{.action} puis dans `Load Balancer`{.action}. +Une fois que vous avez sélectionné le Load Balancer que vous souhaitez modifier, accédez à l'onglet `frontends`{.action}, où vous pouvez créer un nouveau frontend ou modifier un frontend existant. -Après avoir sélectionné le Load Balancer que vous souhaitez modifier, créez un nouveau frontend, ou éditez-en un existant. +Dans `Paramètres avancés`{.action}, vous pouvez sélectionner les Additional IPs que vous souhaitez associer à votre frontend. -Dans les `Paramètres avancés`{.action}, vous pourrez choisir la ou les Additional IPs que vous souhaitez associer à votre frontend. +![Configurer le frontend en associant une Additional IP](images/iplb_frontend.png){.thumbnail} -![Configurer le frontend en associant une IP Fail-Over](images/iplb_frontend.png){.thumbnail} +Une fois le frontend configuré, cliquez sur `Ajouter`{.action} ou `Mettre à jour`{.action}, selon que vous configurez un nouveau frontend ou un frontend existant. -Une fois le frontend configuré, cliquez sur `Ajouter`{.action} ou `Modifier`{.action} selon que vous configuriez un nouveau frontend, ou un frontend existant. +N’oubliez pas de déployer la configuration. Il existe deux façons de le faire : -N'oubliez pas de déployer la configuration. Pour ce faire, vous pouvez au choix : +- via la section `Statut`{.action} de l’onglet `Accueil`{.action} de votre espace client OVHcloud, en cliquant sur le bouton `...`{.action} à côté de l’ID de votre Load Balancer et en sélectionnant `Appliquer la configuration`{.action} -- dans la section `Statut` de l'onglet `Accueil`{.action}, cliquer sur le bouton `...`{.action} de votre Load Balancer puis cliquer sur `Appliquer la configuration`{.action}; -- dans le bandeau de rappel vous précisant que la configuration n'est pas appliquée, cliquer sur `Appliquer la configuration`{.action}. +- via la bannière dans l’espace client OVHcloud, qui vous informe que la configuration n’a pas été appliquée, en cliquant sur `Appliquer la configuration`{.action}. -![Application d'une Configuration d'un Load Balancer](images/apply_configuration.png){.thumbnail} +![Appliquer une configuration de Load Balancer](images/apply_configuration.png){.thumbnail} ## Aller plus loin -Échangez avec notre [communauté d'utilisateurs](/links/community). +Échangez avec notre [communauté d'utilisateurs](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/howto_route_ipfo/images/_iplb_frontend.png b/pages/network/load_balancer/howto_route_ipfo/images/_iplb_frontend.png deleted file mode 100644 index 80f35021a45..00000000000 Binary files a/pages/network/load_balancer/howto_route_ipfo/images/_iplb_frontend.png and /dev/null differ diff --git a/pages/network/load_balancer/howto_route_ipfo/images/iplb_detail.png b/pages/network/load_balancer/howto_route_ipfo/images/iplb_detail.png deleted file mode 100644 index 7246e554f0e..00000000000 Binary files a/pages/network/load_balancer/howto_route_ipfo/images/iplb_detail.png and /dev/null differ diff --git a/pages/network/load_balancer/howto_route_ipfo/images/iplb_frontend.png b/pages/network/load_balancer/howto_route_ipfo/images/iplb_frontend.png index 7663290fc32..ab191fa4957 100644 Binary files a/pages/network/load_balancer/howto_route_ipfo/images/iplb_frontend.png and b/pages/network/load_balancer/howto_route_ipfo/images/iplb_frontend.png differ diff --git a/pages/network/load_balancer/howto_route_ipfo/images/screenshot_ipfo.png b/pages/network/load_balancer/howto_route_ipfo/images/screenshot_ipfo.png deleted file mode 100644 index 7663290fc32..00000000000 Binary files a/pages/network/load_balancer/howto_route_ipfo/images/screenshot_ipfo.png and /dev/null differ diff --git a/pages/network/load_balancer/order_freecertificate/guide.en-asia.md b/pages/network/load_balancer/order_freecertificate/guide.en-asia.md index 5b10f7b5a52..e3bfced3f83 100644 --- a/pages/network/load_balancer/order_freecertificate/guide.en-asia.md +++ b/pages/network/load_balancer/order_freecertificate/guide.en-asia.md @@ -1,80 +1,103 @@ --- title: Order a free SSL certificate -universe: cloud excerpt: Order a free SSL certificate for your web services behind a Load Balancer -updated: 2022-03-29 +updated: 2025-10-24 --- -## Presentation -The OVH Load Balancer service can be configured to support SSL termination.. +## Objective -The purpose of SSL termination is to decrypt the incoming encrypted stream before forwarding it to the appropriate service (web server for example). +The OVHcloud Load Balancer service can be configured to support SSL termination. -SSL termination has a cost for the service that manages it. Rather than letting your servers do it, it is possible to configure your OVH Load Balancer service to do it. +The purpose of SSL termination is to decrypt the incoming encrypted stream before forwarding it to the appropriate service, such as a web server. -Moreover, all your certificates are centralized in one place and their maintenance is easier. +Handling SSL termination on the Load Balancer reduces the computational load on your backend servers and centralizes certificate management. This makes maintenance and security updates easier. -## Configuring the frontend for SSL termination -The first thing to do is to configure your frontend to handle SSL termination. +**Discover how to order a free SSL certificate via the OVHcloud Control Panel or the API.** -### Via the Manager -In the `Frontends` section of your Manager, click on the `Add Frontend`{.action} button to create a new frontend. An edit window will appear, select the `HTTPS` protocol. You will also need to fill in the `Default Close` or `HTTPS Redirection` field in the advanced settings.. +## Requirements + +- You must have an [OVHcloud Load balancer](/links/network/load-balancer) in your OVHcloud account. +- You must be logged in to the [OVHcloud Control Panel](/links/manager). + +## Instructions + +### Via the OVHcloud Control Panel + +#### Configure the frontend for SSL termination + +To enable SSL termination, you must first configure your frontend. + +You can configure your SSL termination from the [OVHcloud Control Panel](/links/manager) in the `Bare Metal Cloud`{.action} section, then `Load Balancer`{.action}. + +After selecting the Load Balancer you wish to modify, create a new frontend or edit an existing one. + +In the `Frontends`{.action} section, click on the `Add Frontend`{.action} button to create a new frontend.
+In the configuration window that opens, select the `HTTPS` protocol. Then, select the `Default server cluster`.
+Finally, open the advanced settings and fill in the `HTTPS Redirection` field. ![Configuring the SSL termination of a Frontend](images/enable_ssl_terminaison.png){.thumbnail} -Once the frontend has been created, you will be prompted to `Apply configuration`{.action} to apply your changes to the relevant area. +Once the frontend has been created, a banner will appear prompting you to `Apply the configuration` to deploy your changes in the appropriate zone. + +#### Order the free SSL certificate + +In the `SSL Certificates` section of your Control Panel, click the `Order SSL Certificate`{.action} button to create a new one. An edit window will appear with an `FQDN` field to be filled in. -### Via API -In the API, the SSL termination is specified by the ssl boolean: (Don't forget to set defaultFarmId or redirectLocation) +![Add a free SSL certificate](images/iplb-order-ssl.png){.thumbnail} + +#### Follow-up of the order + +In the `Tasks`{.action} section of your Control Panel, the tasks related to ordering a free SSL Certificate are of the type `orderFreeCertificate`. + +### Via the OVHcloud API + +#### Configuring the frontend for SSL termination + +In the API, the SSL termination is specified by the `ssl` boolean. To enable SSL termination, set this parameter to `true`, then set the `defaultFarmId` or `redirectLocation` to the corresponding values. > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend > -Then apply the changes : +Then apply the changes: > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh > -## Order the free SSL certificate +#### Order the free SSL certificate -### Via the Manager -In the `SSL Certificates` section of your Manager, click the `Order SSL Certificate`{.action} button to create a new one. An edit window will appear with an `FQDN` field to be filled in. - -![Ajouter un certificate SSL gratuit](images/add_freecertificate.png){.thumbnail} - -### Via API -In the API, the command is as follows. For the order to be finalized, the chosen domain name must point to your OVH Load Balancer service. +In the API, the call is as follows: > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/freeCertificate > -## Follow-up of the order +For the order to be finalized, the chosen domain name must point to your OVHcloud Load Balancer service. -### Via the Manager -In the `Tasks`{.action} section of your Manager, the tasks related to ordering a free SSL Certificate are of the type `orderFreeCertificate`. +#### Follow-up of the order -### Via API +- Returning the task list -#### Return to task list -You can specify the action type orderFreeCertificate to refine the search. +You can specify the action type `orderFreeCertificate` to refine the search: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task > -#### Returning the status of a particular stain +- Returning the status of a particular task: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task/{id} > -## Delivery of the free SSL certificate -Once the order is complete, the SSL Certificate is automatically installed on your OVH Load Balancer service.. +Once the order is complete, the SSL Certificate is automatically installed on your OVHcloud Load Balancer service. + +## Go further + +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/order_freecertificate/guide.en-au.md b/pages/network/load_balancer/order_freecertificate/guide.en-au.md index 5b10f7b5a52..e3bfced3f83 100644 --- a/pages/network/load_balancer/order_freecertificate/guide.en-au.md +++ b/pages/network/load_balancer/order_freecertificate/guide.en-au.md @@ -1,80 +1,103 @@ --- title: Order a free SSL certificate -universe: cloud excerpt: Order a free SSL certificate for your web services behind a Load Balancer -updated: 2022-03-29 +updated: 2025-10-24 --- -## Presentation -The OVH Load Balancer service can be configured to support SSL termination.. +## Objective -The purpose of SSL termination is to decrypt the incoming encrypted stream before forwarding it to the appropriate service (web server for example). +The OVHcloud Load Balancer service can be configured to support SSL termination. -SSL termination has a cost for the service that manages it. Rather than letting your servers do it, it is possible to configure your OVH Load Balancer service to do it. +The purpose of SSL termination is to decrypt the incoming encrypted stream before forwarding it to the appropriate service, such as a web server. -Moreover, all your certificates are centralized in one place and their maintenance is easier. +Handling SSL termination on the Load Balancer reduces the computational load on your backend servers and centralizes certificate management. This makes maintenance and security updates easier. -## Configuring the frontend for SSL termination -The first thing to do is to configure your frontend to handle SSL termination. +**Discover how to order a free SSL certificate via the OVHcloud Control Panel or the API.** -### Via the Manager -In the `Frontends` section of your Manager, click on the `Add Frontend`{.action} button to create a new frontend. An edit window will appear, select the `HTTPS` protocol. You will also need to fill in the `Default Close` or `HTTPS Redirection` field in the advanced settings.. +## Requirements + +- You must have an [OVHcloud Load balancer](/links/network/load-balancer) in your OVHcloud account. +- You must be logged in to the [OVHcloud Control Panel](/links/manager). + +## Instructions + +### Via the OVHcloud Control Panel + +#### Configure the frontend for SSL termination + +To enable SSL termination, you must first configure your frontend. + +You can configure your SSL termination from the [OVHcloud Control Panel](/links/manager) in the `Bare Metal Cloud`{.action} section, then `Load Balancer`{.action}. + +After selecting the Load Balancer you wish to modify, create a new frontend or edit an existing one. + +In the `Frontends`{.action} section, click on the `Add Frontend`{.action} button to create a new frontend.
+In the configuration window that opens, select the `HTTPS` protocol. Then, select the `Default server cluster`.
+Finally, open the advanced settings and fill in the `HTTPS Redirection` field. ![Configuring the SSL termination of a Frontend](images/enable_ssl_terminaison.png){.thumbnail} -Once the frontend has been created, you will be prompted to `Apply configuration`{.action} to apply your changes to the relevant area. +Once the frontend has been created, a banner will appear prompting you to `Apply the configuration` to deploy your changes in the appropriate zone. + +#### Order the free SSL certificate + +In the `SSL Certificates` section of your Control Panel, click the `Order SSL Certificate`{.action} button to create a new one. An edit window will appear with an `FQDN` field to be filled in. -### Via API -In the API, the SSL termination is specified by the ssl boolean: (Don't forget to set defaultFarmId or redirectLocation) +![Add a free SSL certificate](images/iplb-order-ssl.png){.thumbnail} + +#### Follow-up of the order + +In the `Tasks`{.action} section of your Control Panel, the tasks related to ordering a free SSL Certificate are of the type `orderFreeCertificate`. + +### Via the OVHcloud API + +#### Configuring the frontend for SSL termination + +In the API, the SSL termination is specified by the `ssl` boolean. To enable SSL termination, set this parameter to `true`, then set the `defaultFarmId` or `redirectLocation` to the corresponding values. > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend > -Then apply the changes : +Then apply the changes: > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh > -## Order the free SSL certificate +#### Order the free SSL certificate -### Via the Manager -In the `SSL Certificates` section of your Manager, click the `Order SSL Certificate`{.action} button to create a new one. An edit window will appear with an `FQDN` field to be filled in. - -![Ajouter un certificate SSL gratuit](images/add_freecertificate.png){.thumbnail} - -### Via API -In the API, the command is as follows. For the order to be finalized, the chosen domain name must point to your OVH Load Balancer service. +In the API, the call is as follows: > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/freeCertificate > -## Follow-up of the order +For the order to be finalized, the chosen domain name must point to your OVHcloud Load Balancer service. -### Via the Manager -In the `Tasks`{.action} section of your Manager, the tasks related to ordering a free SSL Certificate are of the type `orderFreeCertificate`. +#### Follow-up of the order -### Via API +- Returning the task list -#### Return to task list -You can specify the action type orderFreeCertificate to refine the search. +You can specify the action type `orderFreeCertificate` to refine the search: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task > -#### Returning the status of a particular stain +- Returning the status of a particular task: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task/{id} > -## Delivery of the free SSL certificate -Once the order is complete, the SSL Certificate is automatically installed on your OVH Load Balancer service.. +Once the order is complete, the SSL Certificate is automatically installed on your OVHcloud Load Balancer service. + +## Go further + +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/order_freecertificate/guide.en-ca.md b/pages/network/load_balancer/order_freecertificate/guide.en-ca.md index 1a7978f30a2..e3bfced3f83 100644 --- a/pages/network/load_balancer/order_freecertificate/guide.en-ca.md +++ b/pages/network/load_balancer/order_freecertificate/guide.en-ca.md @@ -1,80 +1,103 @@ --- title: Order a free SSL certificate -universe: cloud excerpt: Order a free SSL certificate for your web services behind a Load Balancer -updated: 2022-03-29 +updated: 2025-10-24 --- -## Presentation -The OVH Load Balancer service can be configured to support SSL termination.. +## Objective -The purpose of SSL termination is to decrypt the incoming encrypted stream before forwarding it to the appropriate service (web server for example). +The OVHcloud Load Balancer service can be configured to support SSL termination. -SSL termination has a cost for the service that manages it. Rather than letting your servers do it, it is possible to configure your OVH Load Balancer service to do it. +The purpose of SSL termination is to decrypt the incoming encrypted stream before forwarding it to the appropriate service, such as a web server. -Moreover, all your certificates are centralized in one place and their maintenance is easier. +Handling SSL termination on the Load Balancer reduces the computational load on your backend servers and centralizes certificate management. This makes maintenance and security updates easier. -## Configuring the frontend for SSL termination -The first thing to do is to configure your frontend to handle SSL termination. +**Discover how to order a free SSL certificate via the OVHcloud Control Panel or the API.** -### Via the Manager -In the `Frontends` section of your Manager, click on the `Add Frontend`{.action} button to create a new frontend. An edit window will appear, select the `HTTPS` protocol. You will also need to fill in the `Default Close` or `HTTPS Redirection` field in the advanced settings.. +## Requirements + +- You must have an [OVHcloud Load balancer](/links/network/load-balancer) in your OVHcloud account. +- You must be logged in to the [OVHcloud Control Panel](/links/manager). + +## Instructions + +### Via the OVHcloud Control Panel + +#### Configure the frontend for SSL termination + +To enable SSL termination, you must first configure your frontend. + +You can configure your SSL termination from the [OVHcloud Control Panel](/links/manager) in the `Bare Metal Cloud`{.action} section, then `Load Balancer`{.action}. + +After selecting the Load Balancer you wish to modify, create a new frontend or edit an existing one. + +In the `Frontends`{.action} section, click on the `Add Frontend`{.action} button to create a new frontend.
+In the configuration window that opens, select the `HTTPS` protocol. Then, select the `Default server cluster`.
+Finally, open the advanced settings and fill in the `HTTPS Redirection` field. ![Configuring the SSL termination of a Frontend](images/enable_ssl_terminaison.png){.thumbnail} -Once the frontend has been created, you will be prompted to `Apply configuration`{.action} to apply your changes to the relevant area. +Once the frontend has been created, a banner will appear prompting you to `Apply the configuration` to deploy your changes in the appropriate zone. + +#### Order the free SSL certificate -### Via API -In the API, the SSL termination is specified by the ssl boolean: (Don't forget to set defaultFarmId or redirectLocation) +In the `SSL Certificates` section of your Control Panel, click the `Order SSL Certificate`{.action} button to create a new one. An edit window will appear with an `FQDN` field to be filled in. + +![Add a free SSL certificate](images/iplb-order-ssl.png){.thumbnail} + +#### Follow-up of the order + +In the `Tasks`{.action} section of your Control Panel, the tasks related to ordering a free SSL Certificate are of the type `orderFreeCertificate`. + +### Via the OVHcloud API + +#### Configuring the frontend for SSL termination + +In the API, the SSL termination is specified by the `ssl` boolean. To enable SSL termination, set this parameter to `true`, then set the `defaultFarmId` or `redirectLocation` to the corresponding values. > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend > -Then apply the changes : +Then apply the changes: > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh > -## Order the free SSL certificate +#### Order the free SSL certificate -### Via the Manager -In the `SSL Certificates` section of your Manager, click the `Order SSL Certificate`{.action} button to create a new one. An edit window will appear with an `FQDN` field to be filled in. - -![Add a free SSL certificate](images/iplb-order-ssl.png){.thumbnail} - -### Via API -In the API, the command is as follows. For the order to be finalized, the chosen domain name must point to your OVH Load Balancer service. +In the API, the call is as follows: > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/freeCertificate > -## Follow-up of the order +For the order to be finalized, the chosen domain name must point to your OVHcloud Load Balancer service. -### Via the Manager -In the `Tasks`{.action} section of your Manager, the tasks related to ordering a free SSL Certificate are of the type `orderFreeCertificate`. +#### Follow-up of the order -### Via API +- Returning the task list -#### Return to task list -You can specify the action type orderFreeCertificate to refine the search. +You can specify the action type `orderFreeCertificate` to refine the search: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task > -#### Returning the status of a particular stain +- Returning the status of a particular task: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task/{id} > -## Delivery of the free SSL certificate -Once the order is complete, the SSL Certificate is automatically installed on your OVH Load Balancer service.. +Once the order is complete, the SSL Certificate is automatically installed on your OVHcloud Load Balancer service. + +## Go further + +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/order_freecertificate/guide.en-gb.md b/pages/network/load_balancer/order_freecertificate/guide.en-gb.md index 1a7978f30a2..e3bfced3f83 100644 --- a/pages/network/load_balancer/order_freecertificate/guide.en-gb.md +++ b/pages/network/load_balancer/order_freecertificate/guide.en-gb.md @@ -1,80 +1,103 @@ --- title: Order a free SSL certificate -universe: cloud excerpt: Order a free SSL certificate for your web services behind a Load Balancer -updated: 2022-03-29 +updated: 2025-10-24 --- -## Presentation -The OVH Load Balancer service can be configured to support SSL termination.. +## Objective -The purpose of SSL termination is to decrypt the incoming encrypted stream before forwarding it to the appropriate service (web server for example). +The OVHcloud Load Balancer service can be configured to support SSL termination. -SSL termination has a cost for the service that manages it. Rather than letting your servers do it, it is possible to configure your OVH Load Balancer service to do it. +The purpose of SSL termination is to decrypt the incoming encrypted stream before forwarding it to the appropriate service, such as a web server. -Moreover, all your certificates are centralized in one place and their maintenance is easier. +Handling SSL termination on the Load Balancer reduces the computational load on your backend servers and centralizes certificate management. This makes maintenance and security updates easier. -## Configuring the frontend for SSL termination -The first thing to do is to configure your frontend to handle SSL termination. +**Discover how to order a free SSL certificate via the OVHcloud Control Panel or the API.** -### Via the Manager -In the `Frontends` section of your Manager, click on the `Add Frontend`{.action} button to create a new frontend. An edit window will appear, select the `HTTPS` protocol. You will also need to fill in the `Default Close` or `HTTPS Redirection` field in the advanced settings.. +## Requirements + +- You must have an [OVHcloud Load balancer](/links/network/load-balancer) in your OVHcloud account. +- You must be logged in to the [OVHcloud Control Panel](/links/manager). + +## Instructions + +### Via the OVHcloud Control Panel + +#### Configure the frontend for SSL termination + +To enable SSL termination, you must first configure your frontend. + +You can configure your SSL termination from the [OVHcloud Control Panel](/links/manager) in the `Bare Metal Cloud`{.action} section, then `Load Balancer`{.action}. + +After selecting the Load Balancer you wish to modify, create a new frontend or edit an existing one. + +In the `Frontends`{.action} section, click on the `Add Frontend`{.action} button to create a new frontend.
+In the configuration window that opens, select the `HTTPS` protocol. Then, select the `Default server cluster`.
+Finally, open the advanced settings and fill in the `HTTPS Redirection` field. ![Configuring the SSL termination of a Frontend](images/enable_ssl_terminaison.png){.thumbnail} -Once the frontend has been created, you will be prompted to `Apply configuration`{.action} to apply your changes to the relevant area. +Once the frontend has been created, a banner will appear prompting you to `Apply the configuration` to deploy your changes in the appropriate zone. + +#### Order the free SSL certificate -### Via API -In the API, the SSL termination is specified by the ssl boolean: (Don't forget to set defaultFarmId or redirectLocation) +In the `SSL Certificates` section of your Control Panel, click the `Order SSL Certificate`{.action} button to create a new one. An edit window will appear with an `FQDN` field to be filled in. + +![Add a free SSL certificate](images/iplb-order-ssl.png){.thumbnail} + +#### Follow-up of the order + +In the `Tasks`{.action} section of your Control Panel, the tasks related to ordering a free SSL Certificate are of the type `orderFreeCertificate`. + +### Via the OVHcloud API + +#### Configuring the frontend for SSL termination + +In the API, the SSL termination is specified by the `ssl` boolean. To enable SSL termination, set this parameter to `true`, then set the `defaultFarmId` or `redirectLocation` to the corresponding values. > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend > -Then apply the changes : +Then apply the changes: > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh > -## Order the free SSL certificate +#### Order the free SSL certificate -### Via the Manager -In the `SSL Certificates` section of your Manager, click the `Order SSL Certificate`{.action} button to create a new one. An edit window will appear with an `FQDN` field to be filled in. - -![Add a free SSL certificate](images/iplb-order-ssl.png){.thumbnail} - -### Via API -In the API, the command is as follows. For the order to be finalized, the chosen domain name must point to your OVH Load Balancer service. +In the API, the call is as follows: > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/freeCertificate > -## Follow-up of the order +For the order to be finalized, the chosen domain name must point to your OVHcloud Load Balancer service. -### Via the Manager -In the `Tasks`{.action} section of your Manager, the tasks related to ordering a free SSL Certificate are of the type `orderFreeCertificate`. +#### Follow-up of the order -### Via API +- Returning the task list -#### Return to task list -You can specify the action type orderFreeCertificate to refine the search. +You can specify the action type `orderFreeCertificate` to refine the search: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task > -#### Returning the status of a particular stain +- Returning the status of a particular task: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task/{id} > -## Delivery of the free SSL certificate -Once the order is complete, the SSL Certificate is automatically installed on your OVH Load Balancer service.. +Once the order is complete, the SSL Certificate is automatically installed on your OVHcloud Load Balancer service. + +## Go further + +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/order_freecertificate/guide.en-sg.md b/pages/network/load_balancer/order_freecertificate/guide.en-sg.md index 5b10f7b5a52..e3bfced3f83 100644 --- a/pages/network/load_balancer/order_freecertificate/guide.en-sg.md +++ b/pages/network/load_balancer/order_freecertificate/guide.en-sg.md @@ -1,80 +1,103 @@ --- title: Order a free SSL certificate -universe: cloud excerpt: Order a free SSL certificate for your web services behind a Load Balancer -updated: 2022-03-29 +updated: 2025-10-24 --- -## Presentation -The OVH Load Balancer service can be configured to support SSL termination.. +## Objective -The purpose of SSL termination is to decrypt the incoming encrypted stream before forwarding it to the appropriate service (web server for example). +The OVHcloud Load Balancer service can be configured to support SSL termination. -SSL termination has a cost for the service that manages it. Rather than letting your servers do it, it is possible to configure your OVH Load Balancer service to do it. +The purpose of SSL termination is to decrypt the incoming encrypted stream before forwarding it to the appropriate service, such as a web server. -Moreover, all your certificates are centralized in one place and their maintenance is easier. +Handling SSL termination on the Load Balancer reduces the computational load on your backend servers and centralizes certificate management. This makes maintenance and security updates easier. -## Configuring the frontend for SSL termination -The first thing to do is to configure your frontend to handle SSL termination. +**Discover how to order a free SSL certificate via the OVHcloud Control Panel or the API.** -### Via the Manager -In the `Frontends` section of your Manager, click on the `Add Frontend`{.action} button to create a new frontend. An edit window will appear, select the `HTTPS` protocol. You will also need to fill in the `Default Close` or `HTTPS Redirection` field in the advanced settings.. +## Requirements + +- You must have an [OVHcloud Load balancer](/links/network/load-balancer) in your OVHcloud account. +- You must be logged in to the [OVHcloud Control Panel](/links/manager). + +## Instructions + +### Via the OVHcloud Control Panel + +#### Configure the frontend for SSL termination + +To enable SSL termination, you must first configure your frontend. + +You can configure your SSL termination from the [OVHcloud Control Panel](/links/manager) in the `Bare Metal Cloud`{.action} section, then `Load Balancer`{.action}. + +After selecting the Load Balancer you wish to modify, create a new frontend or edit an existing one. + +In the `Frontends`{.action} section, click on the `Add Frontend`{.action} button to create a new frontend.
+In the configuration window that opens, select the `HTTPS` protocol. Then, select the `Default server cluster`.
+Finally, open the advanced settings and fill in the `HTTPS Redirection` field. ![Configuring the SSL termination of a Frontend](images/enable_ssl_terminaison.png){.thumbnail} -Once the frontend has been created, you will be prompted to `Apply configuration`{.action} to apply your changes to the relevant area. +Once the frontend has been created, a banner will appear prompting you to `Apply the configuration` to deploy your changes in the appropriate zone. + +#### Order the free SSL certificate + +In the `SSL Certificates` section of your Control Panel, click the `Order SSL Certificate`{.action} button to create a new one. An edit window will appear with an `FQDN` field to be filled in. -### Via API -In the API, the SSL termination is specified by the ssl boolean: (Don't forget to set defaultFarmId or redirectLocation) +![Add a free SSL certificate](images/iplb-order-ssl.png){.thumbnail} + +#### Follow-up of the order + +In the `Tasks`{.action} section of your Control Panel, the tasks related to ordering a free SSL Certificate are of the type `orderFreeCertificate`. + +### Via the OVHcloud API + +#### Configuring the frontend for SSL termination + +In the API, the SSL termination is specified by the `ssl` boolean. To enable SSL termination, set this parameter to `true`, then set the `defaultFarmId` or `redirectLocation` to the corresponding values. > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend > -Then apply the changes : +Then apply the changes: > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh > -## Order the free SSL certificate +#### Order the free SSL certificate -### Via the Manager -In the `SSL Certificates` section of your Manager, click the `Order SSL Certificate`{.action} button to create a new one. An edit window will appear with an `FQDN` field to be filled in. - -![Ajouter un certificate SSL gratuit](images/add_freecertificate.png){.thumbnail} - -### Via API -In the API, the command is as follows. For the order to be finalized, the chosen domain name must point to your OVH Load Balancer service. +In the API, the call is as follows: > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/freeCertificate > -## Follow-up of the order +For the order to be finalized, the chosen domain name must point to your OVHcloud Load Balancer service. -### Via the Manager -In the `Tasks`{.action} section of your Manager, the tasks related to ordering a free SSL Certificate are of the type `orderFreeCertificate`. +#### Follow-up of the order -### Via API +- Returning the task list -#### Return to task list -You can specify the action type orderFreeCertificate to refine the search. +You can specify the action type `orderFreeCertificate` to refine the search: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task > -#### Returning the status of a particular stain +- Returning the status of a particular task: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task/{id} > -## Delivery of the free SSL certificate -Once the order is complete, the SSL Certificate is automatically installed on your OVH Load Balancer service.. +Once the order is complete, the SSL Certificate is automatically installed on your OVHcloud Load Balancer service. + +## Go further + +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/order_freecertificate/guide.en-us.md b/pages/network/load_balancer/order_freecertificate/guide.en-us.md index 8d352ccb803..e3bfced3f83 100644 --- a/pages/network/load_balancer/order_freecertificate/guide.en-us.md +++ b/pages/network/load_balancer/order_freecertificate/guide.en-us.md @@ -1,80 +1,103 @@ --- title: Order a free SSL certificate -universe: cloud excerpt: Order a free SSL certificate for your web services behind a Load Balancer -updated: 2022-03-29 +updated: 2025-10-24 --- -## Presentation -The OVH Load Balancer service can be configured to support SSL termination.. +## Objective -The purpose of SSL termination is to decrypt the incoming encrypted stream before forwarding it to the appropriate service (web server for example). +The OVHcloud Load Balancer service can be configured to support SSL termination. -SSL termination has a cost for the service that manages it. Rather than letting your servers do it, it is possible to configure your OVH Load Balancer service to do it. +The purpose of SSL termination is to decrypt the incoming encrypted stream before forwarding it to the appropriate service, such as a web server. -Moreover, all your certificates are centralized in one place and their maintenance is easier. +Handling SSL termination on the Load Balancer reduces the computational load on your backend servers and centralizes certificate management. This makes maintenance and security updates easier. -## Configuring the frontend for SSL termination -The first thing to do is to configure your frontend to handle SSL termination. +**Discover how to order a free SSL certificate via the OVHcloud Control Panel or the API.** -### Via the Manager -In the `Frontends` section of your Manager, click on the `Add Frontend`{.action} button to create a new frontend. An edit window will appear, select the `HTTPS` protocol. You will also need to fill in the `Default Close` or `HTTPS Redirection` field in the advanced settings.. +## Requirements -![Configuring the SSL termination of a Frontend](images/iplb-add-front-end.png){.thumbnail} +- You must have an [OVHcloud Load balancer](/links/network/load-balancer) in your OVHcloud account. +- You must be logged in to the [OVHcloud Control Panel](/links/manager). -Once the frontend has been created, you will be prompted to `Apply configuration`{.action} to apply your changes to the relevant area. +## Instructions -### Via API -In the API, the SSL termination is specified by the ssl boolean: (Don't forget to set defaultFarmId or redirectLocation) +### Via the OVHcloud Control Panel + +#### Configure the frontend for SSL termination + +To enable SSL termination, you must first configure your frontend. + +You can configure your SSL termination from the [OVHcloud Control Panel](/links/manager) in the `Bare Metal Cloud`{.action} section, then `Load Balancer`{.action}. + +After selecting the Load Balancer you wish to modify, create a new frontend or edit an existing one. + +In the `Frontends`{.action} section, click on the `Add Frontend`{.action} button to create a new frontend.
+In the configuration window that opens, select the `HTTPS` protocol. Then, select the `Default server cluster`.
+Finally, open the advanced settings and fill in the `HTTPS Redirection` field. + +![Configuring the SSL termination of a Frontend](images/enable_ssl_terminaison.png){.thumbnail} + +Once the frontend has been created, a banner will appear prompting you to `Apply the configuration` to deploy your changes in the appropriate zone. + +#### Order the free SSL certificate + +In the `SSL Certificates` section of your Control Panel, click the `Order SSL Certificate`{.action} button to create a new one. An edit window will appear with an `FQDN` field to be filled in. + +![Add a free SSL certificate](images/iplb-order-ssl.png){.thumbnail} + +#### Follow-up of the order + +In the `Tasks`{.action} section of your Control Panel, the tasks related to ordering a free SSL Certificate are of the type `orderFreeCertificate`. + +### Via the OVHcloud API + +#### Configuring the frontend for SSL termination + +In the API, the SSL termination is specified by the `ssl` boolean. To enable SSL termination, set this parameter to `true`, then set the `defaultFarmId` or `redirectLocation` to the corresponding values. > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend > -Then apply the changes : +Then apply the changes: > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh > -## Order the free SSL certificate +#### Order the free SSL certificate -### Via the Manager -In the `SSL Certificates` section of your Manager, click the `Order SSL Certificate`{.action} button to create a new one. An edit window will appear with an `FQDN` field to be filled in. - -![Ajouter un certificate SSL gratuit](images/iplb-order-ssl.png){.thumbnail} - -### Via API -In the API, the command is as follows. For the order to be finalized, the chosen domain name must point to your OVH Load Balancer service. +In the API, the call is as follows: > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/freeCertificate > -## Follow-up of the order +For the order to be finalized, the chosen domain name must point to your OVHcloud Load Balancer service. -### Via the Manager -In the `Tasks`{.action} section of your Manager, the tasks related to ordering a free SSL Certificate are of the type `orderFreeCertificate`. +#### Follow-up of the order -### Via API +- Returning the task list -#### Return to task list -You can specify the action type orderFreeCertificate to refine the search. +You can specify the action type `orderFreeCertificate` to refine the search: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task > -#### Returning the status of a particular stain +- Returning the status of a particular task: > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task/{id} > -## Delivery of the free SSL certificate -Once the order is complete, the SSL Certificate is automatically installed on your OVH Load Balancer service.. +Once the order is complete, the SSL Certificate is automatically installed on your OVHcloud Load Balancer service. + +## Go further + +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/order_freecertificate/guide.fr-ca.md b/pages/network/load_balancer/order_freecertificate/guide.fr-ca.md index aa812fc8802..b6342afa209 100644 --- a/pages/network/load_balancer/order_freecertificate/guide.fr-ca.md +++ b/pages/network/load_balancer/order_freecertificate/guide.fr-ca.md @@ -1,80 +1,101 @@ --- -title: Commander un certificat SSL gratuit -universe: cloud +title: "Commande d'un certificat SSL gratuit" excerpt: Commander un certificat SSL gratuit pour vos services web derrière un Load Balancer -updated: 2022-03-29 +updated: 2025-10-24 --- -## Presentation -Le service OVH Load Balancer peut être configuré pour prendre en charge la terminaison SSL. +## Objectif -La terminaison SSL a pour but de déchiffrer le flux chiffré entrant avant de le faire suivre vers le service approprié (Serveur web par exemple). +Le service OVHcloud Load Balancer peut être configuré pour prendre en charge la terminaison SSL. -La terminaison SSL a un coût pour le service qui le gère. Plutôt que de laisser vos serveurs la faire, il est possible de configurer votre service OVH Load Balancer pour la faire. +La terminaison SSL a pour but de déchiffrer le flux chiffré entrant avant de le faire suivre vers le service approprié, tel qu'un serveur web. -De plus, tous vos certificats sont ainsi centralisés au même endroit et leur maintenance s'en trouve facilitée. +Le traitement de la terminaison SSL sur le Load Balancer réduit la charge de calcul sur vos serveurs backend et centralise la gestion des certificats. Cela facilite la maintenance et les mises à jour de sécurité. -## Configurer le frontend pour la terminaison SSL -La première chose à faire est de configurer votre frontend pour gérer la terminaison SSL. +**Découvrez comment commander un certificat SSL gratuit depuis votre espace client OVHcloud ou via l'API OVHcloud.** -### Via le Manager -Dans la section `Frontends` de votre Manager, cliquez sur le bouton `Ajouter un frontend`{.action} pour en créer un nouveau. Une fenêtre d'édition apparait alors, selectionnez le protocole `HTTPS`. Il faudra aussi renseigner le champ `Ferme par défaut` ou `Redirection HTTP` dans les paramètres avancés. +## Prérequis -![Configuration la terminaison SSL d'un Frontend](images/iplb-add-front-end.png){.thumbnail} +- Posséder une offre [OVHcloud Load balancer](/links/network/load-balancer) dans votre compte OVHcloud. +- Être connecté à votre [espace client OVHcloud](/links/manager) -Une fois le frontend créé, il vous sera proposé d'`Appliquer la configuration`{.action} pour appliquer vos changements dans la zone concernée. +## En pratique -### Via l'API -Dans l'API, la terminaison SSL est spécifiée par le booléen ssl : (N'oubliez pas de renseigner defaultFarmId ou redirectLocation) +### Depuis l'espace client OVHcloud + +La première étape est de configurer votre frontend pour gérer la terminaison SSL. + +Vous pouvez configurer votre terminaison SSL depuis l'[espace client OVHcloud](/links/manager) dans la partie `Bare Metal Cloud`{.action} puis `Load Balancer`{.action}. + +Après avoir sélectionné le Load Balancer que vous souhaitez modifier, créez un nouveau frontend ou éditez-en un existant. + +Dans l'onglet `Frontends`{.action}, cliquez sur le bouton `Ajouter un frontend`{.action} pour en créer un nouveau.
+Une fenêtre d'édition apparait alors, sélectionnez le protocole `HTTPS`. Ensuite, renseignez le champ `Ferme par défaut`.
+Enfin, ouvrez les paramètres avancés et renseignez le champ `Redirection HTTP`. + +![Configuration la terminaison SSL d'un Frontend](images/enable_ssl_terminaison.png){.thumbnail} + +Une fois le frontend créé, une bannière apparaîtra vous invitant à `Appliquer la configuration`{.action} pour déployer vos changements dans la zone concernée. + +#### Commander le certificate SSL gratuit + +Dans l'onglet `Certificats SSL`{.action}, cliquez sur le bouton `Commander un certificat SSL`{.action} pour en créer un nouveau. Une fenêtre d'édition apparait alors avec un champ `FQDN` à renseigner. + +![Ajouter un certificate SSL gratuit](images/add_freecertificate.png){.thumbnail} + +#### Suivi de la commande + +Vous pourrez suivre votre commande dans l'onglet `Tâches`{.action}. La tâche correspondant à la commande d'un certificat SSL gratuit est nommée `orderFreeCertificate`. + +### Depuis l'API OVHcloud + +#### Configurer le frontend pour la terminaison SSL + +Dans l'API, la terminaison SSL est spécifiée par le booléen `ssl`. Pour activer la terminaison SSL, réglez ce paramètre sur `true`, puis définissez `defaultFarmId` ou `redirectLocation` avec les valeurs correspondantes. > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend > -Puis appliquer les modifications : +Appliquez ensuite les modifications : > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh > -## Commander le certificate SSL gratuit +#### Commander le certificat SSL gratuit -### Via le Manager -Dans la section `Certificats SSL` de votre Manager, cliquez sur le bouton `Commander un certificat SSL`{.action} pour en créer un nouveau. Une fenêtre d'édition apparait alors avec un champ `FQDN` à renseigner. - -![Ajouter un certificate SSL gratuit](images/iplb-order-ssl.png){.thumbnail} - -### Via l'API -Dans l'API, la commande se fait comme suit. Pour que la commande se finalise, il faut obligatoirement que le nom de domaine choisi pointe vers votre service OVH Load Balancer. +Dans l'API, la commande se fait via l'appel suivant : > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/freeCertificate > -## Suivi de la commande +Pour que la commande soit finalisée, il faut obligatoirement que le nom de domaine choisi pointe vers votre service OVHcloud Load Balancer. -### Via le Manager -Dans la section `Tâches`{.action} de votre Manager, les tâches relatives à la commandes d'un certificat SSL gratuit correspondent au type `orderFreeCertificate`. +#### Suivi de la commande -### Via l'API +- Retourner la liste des tâches -#### Retourner la liste des taches -Vous pouvez spécifier le type d'action orderFreeCertificate pour affiner la recherche. +Vous pouvez spécifier le type d'action `orderFreeCertificate` pour affiner la recherche. > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task > -#### Retourner le statut d'une tache en particulier +- Retourner le statut d'une tâche en particulier > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task/{id} > -## Livraison du certificat SSL gratuit -Une fois la commande finie, le certificat SSL est automatiquement installé sur votre service OVH Load Balancer. +Une fois la commande finie, le certificat SSL est automatiquement installé sur votre service OVHcloud Load Balancer. + +## Aller plus loin + +Échangez avec notre [communauté d'utilisateurs](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/order_freecertificate/guide.fr-fr.md b/pages/network/load_balancer/order_freecertificate/guide.fr-fr.md index 0922f947f32..b6342afa209 100644 --- a/pages/network/load_balancer/order_freecertificate/guide.fr-fr.md +++ b/pages/network/load_balancer/order_freecertificate/guide.fr-fr.md @@ -1,16 +1,16 @@ --- title: "Commande d'un certificat SSL gratuit" -universe: cloud excerpt: Commander un certificat SSL gratuit pour vos services web derrière un Load Balancer -updated: 2022-03-29 +updated: 2025-10-24 --- ## Objectif -Le service OVHcloud Load Balancer peut être configuré pour prendre en charge la terminaison SSL.
-La terminaison SSL a pour but de déchiffrer le flux chiffré entrant avant de le faire suivre vers le service approprié (serveur web par exemple).
-La terminaison SSL a un coût pour le service qui le gère. Plutôt que de laisser vos serveurs la gérer, vous pouvez configurer votre service OVHcloud Load Balancer afin qu'il s'en charge.
-Par ailleurs, tous vos certificats sont ainsi centralisés au même endroit et leur maintenance s'en trouve facilitée. +Le service OVHcloud Load Balancer peut être configuré pour prendre en charge la terminaison SSL. + +La terminaison SSL a pour but de déchiffrer le flux chiffré entrant avant de le faire suivre vers le service approprié, tel qu'un serveur web. + +Le traitement de la terminaison SSL sur le Load Balancer réduit la charge de calcul sur vos serveurs backend et centralise la gestion des certificats. Cela facilite la maintenance et les mises à jour de sécurité. **Découvrez comment commander un certificat SSL gratuit depuis votre espace client OVHcloud ou via l'API OVHcloud.** @@ -30,12 +30,12 @@ Vous pouvez configurer votre terminaison SSL depuis l'[espace client OVHcloud](/ Après avoir sélectionné le Load Balancer que vous souhaitez modifier, créez un nouveau frontend ou éditez-en un existant. Dans l'onglet `Frontends`{.action}, cliquez sur le bouton `Ajouter un frontend`{.action} pour en créer un nouveau.
-Une fenêtre d'édition apparait alors, sélectionnez le protocole `HTTPS`.
-Renseignez également les champs `Ferme par défaut` ou `Redirection HTTP` dans les paramètres avancés. +Une fenêtre d'édition apparait alors, sélectionnez le protocole `HTTPS`. Ensuite, renseignez le champ `Ferme par défaut`.
+Enfin, ouvrez les paramètres avancés et renseignez le champ `Redirection HTTP`. ![Configuration la terminaison SSL d'un Frontend](images/enable_ssl_terminaison.png){.thumbnail} -Une fois le frontend créé, il vous sera proposé d'`Appliquer la configuration`{.action} pour appliquer vos changements dans la zone concernée. +Une fois le frontend créé, une bannière apparaîtra vous invitant à `Appliquer la configuration`{.action} pour déployer vos changements dans la zone concernée. #### Commander le certificate SSL gratuit @@ -49,9 +49,9 @@ Vous pourrez suivre votre commande dans l'onglet `Tâches`{.action}. La tâche c ### Depuis l'API OVHcloud -#### Commander le certificate SSL gratuit +#### Configurer le frontend pour la terminaison SSL -Dans l'API, la terminaison SSL est spécifiée par le booléen ssl (n'oubliez pas de renseigner `defaultFarmId` ou `redirectLocation`) : +Dans l'API, la terminaison SSL est spécifiée par le booléen `ssl`. Pour activer la terminaison SSL, réglez ce paramètre sur `true`, puis définissez `defaultFarmId` ou `redirectLocation` avec les valeurs correspondantes. > [!api] > @@ -65,6 +65,8 @@ Appliquez ensuite les modifications : > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh > +#### Commander le certificat SSL gratuit + Dans l'API, la commande se fait via l'appel suivant : > [!api] @@ -72,7 +74,7 @@ Dans l'API, la commande se fait via l'appel suivant : > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/freeCertificate > -Pour que la commande se finalise, il faut obligatoirement que le nom de domaine choisi pointe vers votre service OVHcloud Load Balancer. +Pour que la commande soit finalisée, il faut obligatoirement que le nom de domaine choisi pointe vers votre service OVHcloud Load Balancer. #### Suivi de la commande @@ -96,4 +98,4 @@ Une fois la commande finie, le certificat SSL est automatiquement installé sur ## Aller plus loin -Échangez avec notre [communauté d'utilisateurs](/links/community). +Échangez avec notre [communauté d'utilisateurs](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/order_freecertificate/images/Manager-ipLBalancer-ssl.PNG b/pages/network/load_balancer/order_freecertificate/images/Manager-ipLBalancer-ssl.PNG deleted file mode 100644 index 30067cb5258..00000000000 Binary files a/pages/network/load_balancer/order_freecertificate/images/Manager-ipLBalancer-ssl.PNG and /dev/null differ diff --git a/pages/network/load_balancer/retrieve_servers_state/guide.en-asia.md b/pages/network/load_balancer/retrieve_servers_state/guide.en-asia.md index 287e68d5d53..4766512e2a1 100644 --- a/pages/network/load_balancer/retrieve_servers_state/guide.en-asia.md +++ b/pages/network/load_balancer/retrieve_servers_state/guide.en-asia.md @@ -1,27 +1,42 @@ --- -title: Retrieve server health status -universe: cloud -excerpt: Retrieve server status -updated: 2022-03-29 +title: "Retrieving server health status" +excerpt: Find out how to retrieve a server health status +updated: 2025-11-27 --- -## Presentation -The OVH Load Balancer service acts by default as a proxy. That is to say that it distributes the load (requests) it receives between all the servers of the desired farm. +## Objective -Each server can be configured for the load balancer to check its status frequently. +The **OVHcloud Load Balancer** service acts by default as a proxy. It distributes the load (requests) it receives among all the servers in the desired farm. -Once a server is detected as "down", the load balancer no longer sends any data to it and distributes the load among the remaining servers. +Each server can be configured for the Load Balancer to check its status frequently. -This can be practical in the case of server maintenance: you can take the server out of the farm, perform maintenance and then reintegrate it into the farm. +As soon as a server is detected as "down", the Load Balancer stops sending it data and distributes the load among the remaining servers. -However, when a server is removed from the farm by the load balancer beyond our control, it can be interesting to know about it and why. +This functionality is useful in the event of scheduled maintenance: you may take the server out of the farm, perform maintenance, and then reintegrate it into the farm. -This tutorial explains how to know the health status of each server for each instance of your OVH Load Balancer. +However, when a server is removed from the farm by the Load Balancer independently of your will, it is important to be informed and to know the reason. -## Retrieve the health status of the servers +This tutorial explains how to find out the health status of each server for each instance of your **OVHcloud Load Balancer**. -### Via API -In the API, server health status is available in the serverState table : +## Requirements + +- An [OVHcloud Load Balancer](/links/network/load-balancer) offer in your OVHcloud account +- Access to the [OVHcloud Control Panel](/links/manager) +- Access to the [OVHcloud API](/links/api) +- A configured farm +- A configured front-end + +## Instructions + +> [!primary] +> +> In order to have valid server status checks, you need to have a probe configured on your farm, and servers that allow access to that probe. +> +> If you need to configure probes on your Load Balancer, please refer to [this guide](/pages/network/load_balancer/create_probes). + +### From the OVHcloud API + +In the API, the server health status is available in the `serverState` table: > [!api] > @@ -35,39 +50,36 @@ In the API, server health status is available in the serverState table : #### Result -![Result server health status via API](images/result_serversStateApi.png){.thumbnail} +![Result server health status via the API](images/result_servers_state_api.png){.thumbnail} -In the picture above, we have the result of the command in the API. +*The image above illustrates the result of the command in the API.* -### Via the Manager -In the "Farms" section, after selecting one of them, the status of each of its servers is displayed in the line corresponding to it. +### From the OVHcloud Control Panel + +In the `Server clusters`{.action} tab, after selecting one of them, the status of each of its servers is displayed on the corresponding line. #### Result -![Result server health status via Manager](images/farm_server_health.png){.thumbnail} +![Result server health status via the OVHcloud Control Panel](images/farm_server_health.png){.thumbnail} + +To obtain details on a server's health status, click on the text in the "**Status**" column, or click the `...`{.action} button and select `See status`{.action}. -In order to obtain details on the health status of a server, simply click on the pictogram in the "Status" column. +![Result server health status via the OVHcloud Control Panel (details)](images/server_health_detail.png){.thumbnail} -![Result server health status via Manager (details)](images/server_health_detail.png){.thumbnail} +### Explanation of the server status details -### Explanation of the details -As explained previously, we have successfully retrieved the server health status for each instance of your OVH Load Balancer. +As explained previously, we have retrieved the server health status for each instance of your **OVHcloud Load Balancer**. -For each instance, we have several pieces of information : +For each instance, we have the following information: |Field|Description| |---|---| -|Status|Server Status| -|Check code|Probe return code| -|Check status|Probe Status| -|Last check content|Contents of the probe response| -|Check time|Probe execution date| - -## Appendix +|Status|Server status| +|Check code|Return code of the health check probe| +|Check status|Status of the health check probe| +|Last check content|Content of the probe's return| +|Check time|Date and time the probe was executed| -### Getting the list of instances of your OVH Load Balancer +## Go further -> [!api] -> -> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/instancesState -> +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/retrieve_servers_state/guide.en-au.md b/pages/network/load_balancer/retrieve_servers_state/guide.en-au.md index 287e68d5d53..4766512e2a1 100644 --- a/pages/network/load_balancer/retrieve_servers_state/guide.en-au.md +++ b/pages/network/load_balancer/retrieve_servers_state/guide.en-au.md @@ -1,27 +1,42 @@ --- -title: Retrieve server health status -universe: cloud -excerpt: Retrieve server status -updated: 2022-03-29 +title: "Retrieving server health status" +excerpt: Find out how to retrieve a server health status +updated: 2025-11-27 --- -## Presentation -The OVH Load Balancer service acts by default as a proxy. That is to say that it distributes the load (requests) it receives between all the servers of the desired farm. +## Objective -Each server can be configured for the load balancer to check its status frequently. +The **OVHcloud Load Balancer** service acts by default as a proxy. It distributes the load (requests) it receives among all the servers in the desired farm. -Once a server is detected as "down", the load balancer no longer sends any data to it and distributes the load among the remaining servers. +Each server can be configured for the Load Balancer to check its status frequently. -This can be practical in the case of server maintenance: you can take the server out of the farm, perform maintenance and then reintegrate it into the farm. +As soon as a server is detected as "down", the Load Balancer stops sending it data and distributes the load among the remaining servers. -However, when a server is removed from the farm by the load balancer beyond our control, it can be interesting to know about it and why. +This functionality is useful in the event of scheduled maintenance: you may take the server out of the farm, perform maintenance, and then reintegrate it into the farm. -This tutorial explains how to know the health status of each server for each instance of your OVH Load Balancer. +However, when a server is removed from the farm by the Load Balancer independently of your will, it is important to be informed and to know the reason. -## Retrieve the health status of the servers +This tutorial explains how to find out the health status of each server for each instance of your **OVHcloud Load Balancer**. -### Via API -In the API, server health status is available in the serverState table : +## Requirements + +- An [OVHcloud Load Balancer](/links/network/load-balancer) offer in your OVHcloud account +- Access to the [OVHcloud Control Panel](/links/manager) +- Access to the [OVHcloud API](/links/api) +- A configured farm +- A configured front-end + +## Instructions + +> [!primary] +> +> In order to have valid server status checks, you need to have a probe configured on your farm, and servers that allow access to that probe. +> +> If you need to configure probes on your Load Balancer, please refer to [this guide](/pages/network/load_balancer/create_probes). + +### From the OVHcloud API + +In the API, the server health status is available in the `serverState` table: > [!api] > @@ -35,39 +50,36 @@ In the API, server health status is available in the serverState table : #### Result -![Result server health status via API](images/result_serversStateApi.png){.thumbnail} +![Result server health status via the API](images/result_servers_state_api.png){.thumbnail} -In the picture above, we have the result of the command in the API. +*The image above illustrates the result of the command in the API.* -### Via the Manager -In the "Farms" section, after selecting one of them, the status of each of its servers is displayed in the line corresponding to it. +### From the OVHcloud Control Panel + +In the `Server clusters`{.action} tab, after selecting one of them, the status of each of its servers is displayed on the corresponding line. #### Result -![Result server health status via Manager](images/farm_server_health.png){.thumbnail} +![Result server health status via the OVHcloud Control Panel](images/farm_server_health.png){.thumbnail} + +To obtain details on a server's health status, click on the text in the "**Status**" column, or click the `...`{.action} button and select `See status`{.action}. -In order to obtain details on the health status of a server, simply click on the pictogram in the "Status" column. +![Result server health status via the OVHcloud Control Panel (details)](images/server_health_detail.png){.thumbnail} -![Result server health status via Manager (details)](images/server_health_detail.png){.thumbnail} +### Explanation of the server status details -### Explanation of the details -As explained previously, we have successfully retrieved the server health status for each instance of your OVH Load Balancer. +As explained previously, we have retrieved the server health status for each instance of your **OVHcloud Load Balancer**. -For each instance, we have several pieces of information : +For each instance, we have the following information: |Field|Description| |---|---| -|Status|Server Status| -|Check code|Probe return code| -|Check status|Probe Status| -|Last check content|Contents of the probe response| -|Check time|Probe execution date| - -## Appendix +|Status|Server status| +|Check code|Return code of the health check probe| +|Check status|Status of the health check probe| +|Last check content|Content of the probe's return| +|Check time|Date and time the probe was executed| -### Getting the list of instances of your OVH Load Balancer +## Go further -> [!api] -> -> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/instancesState -> +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/retrieve_servers_state/guide.en-ca.md b/pages/network/load_balancer/retrieve_servers_state/guide.en-ca.md index 287e68d5d53..4766512e2a1 100644 --- a/pages/network/load_balancer/retrieve_servers_state/guide.en-ca.md +++ b/pages/network/load_balancer/retrieve_servers_state/guide.en-ca.md @@ -1,27 +1,42 @@ --- -title: Retrieve server health status -universe: cloud -excerpt: Retrieve server status -updated: 2022-03-29 +title: "Retrieving server health status" +excerpt: Find out how to retrieve a server health status +updated: 2025-11-27 --- -## Presentation -The OVH Load Balancer service acts by default as a proxy. That is to say that it distributes the load (requests) it receives between all the servers of the desired farm. +## Objective -Each server can be configured for the load balancer to check its status frequently. +The **OVHcloud Load Balancer** service acts by default as a proxy. It distributes the load (requests) it receives among all the servers in the desired farm. -Once a server is detected as "down", the load balancer no longer sends any data to it and distributes the load among the remaining servers. +Each server can be configured for the Load Balancer to check its status frequently. -This can be practical in the case of server maintenance: you can take the server out of the farm, perform maintenance and then reintegrate it into the farm. +As soon as a server is detected as "down", the Load Balancer stops sending it data and distributes the load among the remaining servers. -However, when a server is removed from the farm by the load balancer beyond our control, it can be interesting to know about it and why. +This functionality is useful in the event of scheduled maintenance: you may take the server out of the farm, perform maintenance, and then reintegrate it into the farm. -This tutorial explains how to know the health status of each server for each instance of your OVH Load Balancer. +However, when a server is removed from the farm by the Load Balancer independently of your will, it is important to be informed and to know the reason. -## Retrieve the health status of the servers +This tutorial explains how to find out the health status of each server for each instance of your **OVHcloud Load Balancer**. -### Via API -In the API, server health status is available in the serverState table : +## Requirements + +- An [OVHcloud Load Balancer](/links/network/load-balancer) offer in your OVHcloud account +- Access to the [OVHcloud Control Panel](/links/manager) +- Access to the [OVHcloud API](/links/api) +- A configured farm +- A configured front-end + +## Instructions + +> [!primary] +> +> In order to have valid server status checks, you need to have a probe configured on your farm, and servers that allow access to that probe. +> +> If you need to configure probes on your Load Balancer, please refer to [this guide](/pages/network/load_balancer/create_probes). + +### From the OVHcloud API + +In the API, the server health status is available in the `serverState` table: > [!api] > @@ -35,39 +50,36 @@ In the API, server health status is available in the serverState table : #### Result -![Result server health status via API](images/result_serversStateApi.png){.thumbnail} +![Result server health status via the API](images/result_servers_state_api.png){.thumbnail} -In the picture above, we have the result of the command in the API. +*The image above illustrates the result of the command in the API.* -### Via the Manager -In the "Farms" section, after selecting one of them, the status of each of its servers is displayed in the line corresponding to it. +### From the OVHcloud Control Panel + +In the `Server clusters`{.action} tab, after selecting one of them, the status of each of its servers is displayed on the corresponding line. #### Result -![Result server health status via Manager](images/farm_server_health.png){.thumbnail} +![Result server health status via the OVHcloud Control Panel](images/farm_server_health.png){.thumbnail} + +To obtain details on a server's health status, click on the text in the "**Status**" column, or click the `...`{.action} button and select `See status`{.action}. -In order to obtain details on the health status of a server, simply click on the pictogram in the "Status" column. +![Result server health status via the OVHcloud Control Panel (details)](images/server_health_detail.png){.thumbnail} -![Result server health status via Manager (details)](images/server_health_detail.png){.thumbnail} +### Explanation of the server status details -### Explanation of the details -As explained previously, we have successfully retrieved the server health status for each instance of your OVH Load Balancer. +As explained previously, we have retrieved the server health status for each instance of your **OVHcloud Load Balancer**. -For each instance, we have several pieces of information : +For each instance, we have the following information: |Field|Description| |---|---| -|Status|Server Status| -|Check code|Probe return code| -|Check status|Probe Status| -|Last check content|Contents of the probe response| -|Check time|Probe execution date| - -## Appendix +|Status|Server status| +|Check code|Return code of the health check probe| +|Check status|Status of the health check probe| +|Last check content|Content of the probe's return| +|Check time|Date and time the probe was executed| -### Getting the list of instances of your OVH Load Balancer +## Go further -> [!api] -> -> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/instancesState -> +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/retrieve_servers_state/guide.en-gb.md b/pages/network/load_balancer/retrieve_servers_state/guide.en-gb.md index 287e68d5d53..4766512e2a1 100644 --- a/pages/network/load_balancer/retrieve_servers_state/guide.en-gb.md +++ b/pages/network/load_balancer/retrieve_servers_state/guide.en-gb.md @@ -1,27 +1,42 @@ --- -title: Retrieve server health status -universe: cloud -excerpt: Retrieve server status -updated: 2022-03-29 +title: "Retrieving server health status" +excerpt: Find out how to retrieve a server health status +updated: 2025-11-27 --- -## Presentation -The OVH Load Balancer service acts by default as a proxy. That is to say that it distributes the load (requests) it receives between all the servers of the desired farm. +## Objective -Each server can be configured for the load balancer to check its status frequently. +The **OVHcloud Load Balancer** service acts by default as a proxy. It distributes the load (requests) it receives among all the servers in the desired farm. -Once a server is detected as "down", the load balancer no longer sends any data to it and distributes the load among the remaining servers. +Each server can be configured for the Load Balancer to check its status frequently. -This can be practical in the case of server maintenance: you can take the server out of the farm, perform maintenance and then reintegrate it into the farm. +As soon as a server is detected as "down", the Load Balancer stops sending it data and distributes the load among the remaining servers. -However, when a server is removed from the farm by the load balancer beyond our control, it can be interesting to know about it and why. +This functionality is useful in the event of scheduled maintenance: you may take the server out of the farm, perform maintenance, and then reintegrate it into the farm. -This tutorial explains how to know the health status of each server for each instance of your OVH Load Balancer. +However, when a server is removed from the farm by the Load Balancer independently of your will, it is important to be informed and to know the reason. -## Retrieve the health status of the servers +This tutorial explains how to find out the health status of each server for each instance of your **OVHcloud Load Balancer**. -### Via API -In the API, server health status is available in the serverState table : +## Requirements + +- An [OVHcloud Load Balancer](/links/network/load-balancer) offer in your OVHcloud account +- Access to the [OVHcloud Control Panel](/links/manager) +- Access to the [OVHcloud API](/links/api) +- A configured farm +- A configured front-end + +## Instructions + +> [!primary] +> +> In order to have valid server status checks, you need to have a probe configured on your farm, and servers that allow access to that probe. +> +> If you need to configure probes on your Load Balancer, please refer to [this guide](/pages/network/load_balancer/create_probes). + +### From the OVHcloud API + +In the API, the server health status is available in the `serverState` table: > [!api] > @@ -35,39 +50,36 @@ In the API, server health status is available in the serverState table : #### Result -![Result server health status via API](images/result_serversStateApi.png){.thumbnail} +![Result server health status via the API](images/result_servers_state_api.png){.thumbnail} -In the picture above, we have the result of the command in the API. +*The image above illustrates the result of the command in the API.* -### Via the Manager -In the "Farms" section, after selecting one of them, the status of each of its servers is displayed in the line corresponding to it. +### From the OVHcloud Control Panel + +In the `Server clusters`{.action} tab, after selecting one of them, the status of each of its servers is displayed on the corresponding line. #### Result -![Result server health status via Manager](images/farm_server_health.png){.thumbnail} +![Result server health status via the OVHcloud Control Panel](images/farm_server_health.png){.thumbnail} + +To obtain details on a server's health status, click on the text in the "**Status**" column, or click the `...`{.action} button and select `See status`{.action}. -In order to obtain details on the health status of a server, simply click on the pictogram in the "Status" column. +![Result server health status via the OVHcloud Control Panel (details)](images/server_health_detail.png){.thumbnail} -![Result server health status via Manager (details)](images/server_health_detail.png){.thumbnail} +### Explanation of the server status details -### Explanation of the details -As explained previously, we have successfully retrieved the server health status for each instance of your OVH Load Balancer. +As explained previously, we have retrieved the server health status for each instance of your **OVHcloud Load Balancer**. -For each instance, we have several pieces of information : +For each instance, we have the following information: |Field|Description| |---|---| -|Status|Server Status| -|Check code|Probe return code| -|Check status|Probe Status| -|Last check content|Contents of the probe response| -|Check time|Probe execution date| - -## Appendix +|Status|Server status| +|Check code|Return code of the health check probe| +|Check status|Status of the health check probe| +|Last check content|Content of the probe's return| +|Check time|Date and time the probe was executed| -### Getting the list of instances of your OVH Load Balancer +## Go further -> [!api] -> -> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/instancesState -> +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/retrieve_servers_state/guide.en-sg.md b/pages/network/load_balancer/retrieve_servers_state/guide.en-sg.md index 287e68d5d53..4766512e2a1 100644 --- a/pages/network/load_balancer/retrieve_servers_state/guide.en-sg.md +++ b/pages/network/load_balancer/retrieve_servers_state/guide.en-sg.md @@ -1,27 +1,42 @@ --- -title: Retrieve server health status -universe: cloud -excerpt: Retrieve server status -updated: 2022-03-29 +title: "Retrieving server health status" +excerpt: Find out how to retrieve a server health status +updated: 2025-11-27 --- -## Presentation -The OVH Load Balancer service acts by default as a proxy. That is to say that it distributes the load (requests) it receives between all the servers of the desired farm. +## Objective -Each server can be configured for the load balancer to check its status frequently. +The **OVHcloud Load Balancer** service acts by default as a proxy. It distributes the load (requests) it receives among all the servers in the desired farm. -Once a server is detected as "down", the load balancer no longer sends any data to it and distributes the load among the remaining servers. +Each server can be configured for the Load Balancer to check its status frequently. -This can be practical in the case of server maintenance: you can take the server out of the farm, perform maintenance and then reintegrate it into the farm. +As soon as a server is detected as "down", the Load Balancer stops sending it data and distributes the load among the remaining servers. -However, when a server is removed from the farm by the load balancer beyond our control, it can be interesting to know about it and why. +This functionality is useful in the event of scheduled maintenance: you may take the server out of the farm, perform maintenance, and then reintegrate it into the farm. -This tutorial explains how to know the health status of each server for each instance of your OVH Load Balancer. +However, when a server is removed from the farm by the Load Balancer independently of your will, it is important to be informed and to know the reason. -## Retrieve the health status of the servers +This tutorial explains how to find out the health status of each server for each instance of your **OVHcloud Load Balancer**. -### Via API -In the API, server health status is available in the serverState table : +## Requirements + +- An [OVHcloud Load Balancer](/links/network/load-balancer) offer in your OVHcloud account +- Access to the [OVHcloud Control Panel](/links/manager) +- Access to the [OVHcloud API](/links/api) +- A configured farm +- A configured front-end + +## Instructions + +> [!primary] +> +> In order to have valid server status checks, you need to have a probe configured on your farm, and servers that allow access to that probe. +> +> If you need to configure probes on your Load Balancer, please refer to [this guide](/pages/network/load_balancer/create_probes). + +### From the OVHcloud API + +In the API, the server health status is available in the `serverState` table: > [!api] > @@ -35,39 +50,36 @@ In the API, server health status is available in the serverState table : #### Result -![Result server health status via API](images/result_serversStateApi.png){.thumbnail} +![Result server health status via the API](images/result_servers_state_api.png){.thumbnail} -In the picture above, we have the result of the command in the API. +*The image above illustrates the result of the command in the API.* -### Via the Manager -In the "Farms" section, after selecting one of them, the status of each of its servers is displayed in the line corresponding to it. +### From the OVHcloud Control Panel + +In the `Server clusters`{.action} tab, after selecting one of them, the status of each of its servers is displayed on the corresponding line. #### Result -![Result server health status via Manager](images/farm_server_health.png){.thumbnail} +![Result server health status via the OVHcloud Control Panel](images/farm_server_health.png){.thumbnail} + +To obtain details on a server's health status, click on the text in the "**Status**" column, or click the `...`{.action} button and select `See status`{.action}. -In order to obtain details on the health status of a server, simply click on the pictogram in the "Status" column. +![Result server health status via the OVHcloud Control Panel (details)](images/server_health_detail.png){.thumbnail} -![Result server health status via Manager (details)](images/server_health_detail.png){.thumbnail} +### Explanation of the server status details -### Explanation of the details -As explained previously, we have successfully retrieved the server health status for each instance of your OVH Load Balancer. +As explained previously, we have retrieved the server health status for each instance of your **OVHcloud Load Balancer**. -For each instance, we have several pieces of information : +For each instance, we have the following information: |Field|Description| |---|---| -|Status|Server Status| -|Check code|Probe return code| -|Check status|Probe Status| -|Last check content|Contents of the probe response| -|Check time|Probe execution date| - -## Appendix +|Status|Server status| +|Check code|Return code of the health check probe| +|Check status|Status of the health check probe| +|Last check content|Content of the probe's return| +|Check time|Date and time the probe was executed| -### Getting the list of instances of your OVH Load Balancer +## Go further -> [!api] -> -> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/instancesState -> +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/retrieve_servers_state/guide.en-us.md b/pages/network/load_balancer/retrieve_servers_state/guide.en-us.md index 287e68d5d53..4766512e2a1 100644 --- a/pages/network/load_balancer/retrieve_servers_state/guide.en-us.md +++ b/pages/network/load_balancer/retrieve_servers_state/guide.en-us.md @@ -1,27 +1,42 @@ --- -title: Retrieve server health status -universe: cloud -excerpt: Retrieve server status -updated: 2022-03-29 +title: "Retrieving server health status" +excerpt: Find out how to retrieve a server health status +updated: 2025-11-27 --- -## Presentation -The OVH Load Balancer service acts by default as a proxy. That is to say that it distributes the load (requests) it receives between all the servers of the desired farm. +## Objective -Each server can be configured for the load balancer to check its status frequently. +The **OVHcloud Load Balancer** service acts by default as a proxy. It distributes the load (requests) it receives among all the servers in the desired farm. -Once a server is detected as "down", the load balancer no longer sends any data to it and distributes the load among the remaining servers. +Each server can be configured for the Load Balancer to check its status frequently. -This can be practical in the case of server maintenance: you can take the server out of the farm, perform maintenance and then reintegrate it into the farm. +As soon as a server is detected as "down", the Load Balancer stops sending it data and distributes the load among the remaining servers. -However, when a server is removed from the farm by the load balancer beyond our control, it can be interesting to know about it and why. +This functionality is useful in the event of scheduled maintenance: you may take the server out of the farm, perform maintenance, and then reintegrate it into the farm. -This tutorial explains how to know the health status of each server for each instance of your OVH Load Balancer. +However, when a server is removed from the farm by the Load Balancer independently of your will, it is important to be informed and to know the reason. -## Retrieve the health status of the servers +This tutorial explains how to find out the health status of each server for each instance of your **OVHcloud Load Balancer**. -### Via API -In the API, server health status is available in the serverState table : +## Requirements + +- An [OVHcloud Load Balancer](/links/network/load-balancer) offer in your OVHcloud account +- Access to the [OVHcloud Control Panel](/links/manager) +- Access to the [OVHcloud API](/links/api) +- A configured farm +- A configured front-end + +## Instructions + +> [!primary] +> +> In order to have valid server status checks, you need to have a probe configured on your farm, and servers that allow access to that probe. +> +> If you need to configure probes on your Load Balancer, please refer to [this guide](/pages/network/load_balancer/create_probes). + +### From the OVHcloud API + +In the API, the server health status is available in the `serverState` table: > [!api] > @@ -35,39 +50,36 @@ In the API, server health status is available in the serverState table : #### Result -![Result server health status via API](images/result_serversStateApi.png){.thumbnail} +![Result server health status via the API](images/result_servers_state_api.png){.thumbnail} -In the picture above, we have the result of the command in the API. +*The image above illustrates the result of the command in the API.* -### Via the Manager -In the "Farms" section, after selecting one of them, the status of each of its servers is displayed in the line corresponding to it. +### From the OVHcloud Control Panel + +In the `Server clusters`{.action} tab, after selecting one of them, the status of each of its servers is displayed on the corresponding line. #### Result -![Result server health status via Manager](images/farm_server_health.png){.thumbnail} +![Result server health status via the OVHcloud Control Panel](images/farm_server_health.png){.thumbnail} + +To obtain details on a server's health status, click on the text in the "**Status**" column, or click the `...`{.action} button and select `See status`{.action}. -In order to obtain details on the health status of a server, simply click on the pictogram in the "Status" column. +![Result server health status via the OVHcloud Control Panel (details)](images/server_health_detail.png){.thumbnail} -![Result server health status via Manager (details)](images/server_health_detail.png){.thumbnail} +### Explanation of the server status details -### Explanation of the details -As explained previously, we have successfully retrieved the server health status for each instance of your OVH Load Balancer. +As explained previously, we have retrieved the server health status for each instance of your **OVHcloud Load Balancer**. -For each instance, we have several pieces of information : +For each instance, we have the following information: |Field|Description| |---|---| -|Status|Server Status| -|Check code|Probe return code| -|Check status|Probe Status| -|Last check content|Contents of the probe response| -|Check time|Probe execution date| - -## Appendix +|Status|Server status| +|Check code|Return code of the health check probe| +|Check status|Status of the health check probe| +|Last check content|Content of the probe's return| +|Check time|Date and time the probe was executed| -### Getting the list of instances of your OVH Load Balancer +## Go further -> [!api] -> -> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/instancesState -> +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/retrieve_servers_state/guide.fr-ca.md b/pages/network/load_balancer/retrieve_servers_state/guide.fr-ca.md index e90cbd2d5f6..0b291d9a193 100644 --- a/pages/network/load_balancer/retrieve_servers_state/guide.fr-ca.md +++ b/pages/network/load_balancer/retrieve_servers_state/guide.fr-ca.md @@ -1,27 +1,42 @@ --- -title: Récupérer l’état de santé des serveurs -universe: cloud -excerpt: Recuperer l’etat des serveurs -updated: 2022-03-29 +title: Récupération de l'état de santé des serveurs +excerpt: Découvrez comment récupérer l'état des serveurs de votre Load Balancer OVHcloud +updated: 2025-11-27 --- -## Presentation -Le service OVH Load Balancer agit par défault comme un mandataire ou "Proxy". C'est à dire qu'il répartit la charge (les requêtes) qu'il reçoit entre tous les serveurs de la ferme voulue. +## Objectif -Chaque serveur peut être configuré pour que le répartiteur de charge vérifie son état fréquemment. +Le service **Load Balancer OVHcloud** agit par défaut en tant que proxy. Il répartit la charge (les requêtes) qu'il reçoit entre tous les serveurs de la ferme souhaitée. -Une fois qu'un serveur est détecté comme "malade", le répartiteur de charge ne lui envoie plus aucune donnée et répartit la charge entre les serveurs restants. +Chaque serveur peut être configuré pour que le Load Balancer vérifie régulièrement son état. -Cela peut être pratique dans le cas de la maintenance d'un serveur : on "sort" le serveur de la ferme, on opère la maintenance puis on le réintègre dans la ferme. +Dès qu'un serveur est détecté comme "down", le Load Balancer cesse d'envoyer des données vers celui-ci et répartit la charge entre les autres serveurs restants. -Cependant, quand un serveur est "sorti" de la ferme par le répartiteur de charge indépendamment de notre volonté, il peut être intéressant de le savoir et d'en connaître la raison. +Cette fonctionnalité est utile en cas de maintenance planifiée : vous pouvez retirer le serveur de la ferme, effectuer la maintenance, puis le réintégrer dans la ferme. -Ce tutoriel explique comment connaître l'état de santé de chaque serveurs pour chaque instance de votre OVH Load Balancer. +Cependant, lorsque le serveur est retiré de la ferme par le Load Balancer de manière indépendante de votre volonté, il est important d'être informé et de connaître la raison. -## Recuperer l'etat de sante des serveurs +Ce tutoriel explique comment connaître l'état de santé de chaque serveur pour chaque instance de votre **Load Balancer OVHcloud**. -### Via l'API -Dans l'API, l'état de santé des serveurs sont disponibles dans le tableau serverState : +## Prérequis + +- Une offre [OVHcloud Load balancer](/links/network/load-balancer) dans votre compte OVHcloud +- Un accès à l'[espace client OVHcloud](/links/manager) +- Un accès à l'[API OVHcloud](/links/api) +- Une ferme configurée +- Un front-end configuré + +## En pratique + +> [!primary] +> +> Afin d'avoir des vérifications d'état des serveurs valides, vous devez disposer d'une sonde configurée sur votre ferme, et de serveurs autorisant l'accès à cette sonde. +> +> Si vous avez besoin de configurer des sondes sur votre Load Balancer, veuillez vous référer à [ce guide](/pages/network/load_balancer/create_probes). + +### Depuis l'API OVHcloud + +Dans l'API, l'état de santé du serveur est disponible dans le tableau `serverState` : > [!api] > @@ -33,41 +48,38 @@ Dans l'API, l'état de santé des serveurs sont disponibles dans le tableau serv > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId} > -#### Resultat +#### Résultat -![Résultat état de santé des serveurs via l'API](images/result_serversStateApi.png){.thumbnail} +![Résultat état de santé du serveur via l'API](images/result_servers_state_api.png){.thumbnail} -Sur l'image ci-dessus, nous avons le résultat de la commande dans l'API. +*L'image ci-dessus illustre le résultat de la commande dans l'API.* -### Via le Manager -Dans la section "Fermes", après avoir sélectionné l'une d'entre elles, l'état de chacun de ses serveurs est affiché dans la ligne correspondant à celui-ci. +### Depuis l'espace client OVHcloud -#### Resultat +Dans l'onglet `Fermes de serveurs`{.action}, après avoir sélectionné l'une d'elles, l'état de chacun de ses serveurs est affiché sur la ligne correspondante. -![Résultat état de santé des serveurs via le Manager](images/farm_server_health.png){.thumbnail} +#### Résultat -Afin d'obtenir les détails sur l'état de santé d'un serveur, il suffit de cliquer sur le pictogramme dans la colonne "Status". +![Résultat état de santé du serveur via l'espace client OVHcloud](images/farm_server_health.png){.thumbnail} -![Résultat état de santé des serveurs via le Manager (détails)](images/server_health_detail.png){.thumbnail} +Pour obtenir des détails sur l'état de santé d'un serveur, cliquez sur le texte dans la colonne "**Status**", ou bien cliquez sur le bouton `...`{.action} et sélectionnez `Voir le statut`{.action}. -### Explication du detail -Comme expliqué précédemment, nous avons bien récupéré l'état de santé du serveur pour chaque instance de votre OVH Load Balancer. +![Résultat état de santé du serveur via l'espace client OVHcloud (détails)](images/server_health_detail.png){.thumbnail} -Pour chaque instance, nous avons plusieurs informations : +### Explication des détails d'état du serveur + +Comme expliqué précédemment, nous avons récupéré l'état de santé du serveur pour chaque instance de votre service **OVHcloud Load Balancer**. + +Pour chaque instance, nous disposons des informations suivantes : |Champ|Description| |---|---| |Status|État du serveur| -|Check code|Code de retour de la sonde| -|Check status|État de la sonde| +|Check code|Code de retour de la sonde de vérification| +|Check status|État de la sonde de vérification| |Last check content|Contenu du retour de la sonde| -|Check time|Date d'exécution de la sonde| - -## Annexe +|Check time|Date et heure d'exécution de la sonde| -### Recuperer la liste des instances de votre OVH Load Balancer +## Aller plus loin -> [!api] -> -> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/instancesState -> +Échangez avec notre [communauté d'utilisateurs](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/retrieve_servers_state/guide.fr-fr.md b/pages/network/load_balancer/retrieve_servers_state/guide.fr-fr.md index 0d0e6310725..0b291d9a193 100644 --- a/pages/network/load_balancer/retrieve_servers_state/guide.fr-fr.md +++ b/pages/network/load_balancer/retrieve_servers_state/guide.fr-fr.md @@ -1,36 +1,42 @@ --- -title: "Récupération de l’état de santé des serveurs" -excerpt: Récupérer l’état des serveurs -updated: 2022-03-29 +title: Récupération de l'état de santé des serveurs +excerpt: Découvrez comment récupérer l'état des serveurs de votre Load Balancer OVHcloud +updated: 2025-11-27 --- ## Objectif -Le service OVHcloud Load Balancer agit par défaut comme un mandataire ou « Proxy ». C'est à dire qu'il répartit la charge (les requêtes) qu'il reçoit entre tous les serveurs de la ferme voulue. +Le service **Load Balancer OVHcloud** agit par défaut en tant que proxy. Il répartit la charge (les requêtes) qu'il reçoit entre tous les serveurs de la ferme souhaitée. -Chaque serveur peut être configuré pour que le répartiteur de charge vérifie son état fréquemment. +Chaque serveur peut être configuré pour que le Load Balancer vérifie régulièrement son état. -Une fois qu'un serveur est détecté comme « malade », le répartiteur de charge ne lui envoie plus aucune donnée et répartit la charge entre les serveurs restants. +Dès qu'un serveur est détecté comme "down", le Load Balancer cesse d'envoyer des données vers celui-ci et répartit la charge entre les autres serveurs restants. -Cela peut être pratique dans le cas de la maintenance d'un serveur : on « sort » le serveur de la ferme, on opère la maintenance puis on le réintègre dans la ferme. +Cette fonctionnalité est utile en cas de maintenance planifiée : vous pouvez retirer le serveur de la ferme, effectuer la maintenance, puis le réintégrer dans la ferme. -Cependant, quand un serveur est « sorti » de la ferme par le répartiteur de charge indépendamment de notre volonté, il peut être intéressant de le savoir et d'en connaître la raison. +Cependant, lorsque le serveur est retiré de la ferme par le Load Balancer de manière indépendante de votre volonté, il est important d'être informé et de connaître la raison. -Ce tutoriel explique comment connaître l'état de santé de chaque serveur pour chaque instance de votre OVHcloud Load Balancer. +Ce tutoriel explique comment connaître l'état de santé de chaque serveur pour chaque instance de votre **Load Balancer OVHcloud**. ## Prérequis -- Posséder une offre [OVHcloud Load balancer](/links/network/load-balancer) dans votre compte OVHcloud. -- Être connecté à votre [espace client OVHcloud](/links/manager). -- Être connecté à l'[API OVHcloud](/links/api). -- Posséder une ferme configurée -- Posséder un frontend configuré +- Une offre [OVHcloud Load balancer](/links/network/load-balancer) dans votre compte OVHcloud +- Un accès à l'[espace client OVHcloud](/links/manager) +- Un accès à l'[API OVHcloud](/links/api) +- Une ferme configurée +- Un front-end configuré ## En pratique +> [!primary] +> +> Afin d'avoir des vérifications d'état des serveurs valides, vous devez disposer d'une sonde configurée sur votre ferme, et de serveurs autorisant l'accès à cette sonde. +> +> Si vous avez besoin de configurer des sondes sur votre Load Balancer, veuillez vous référer à [ce guide](/pages/network/load_balancer/create_probes). + ### Depuis l'API OVHcloud -Dans l'API, l'état de santé des serveurs est disponible dans le tableau serverState : +Dans l'API, l'état de santé du serveur est disponible dans le tableau `serverState` : > [!api] > @@ -44,45 +50,36 @@ Dans l'API, l'état de santé des serveurs est disponible dans le tableau server #### Résultat -![Résultat état de santé des serveurs via l'API](images/result_serversStateApi.png){.thumbnail} +![Résultat état de santé du serveur via l'API](images/result_servers_state_api.png){.thumbnail} -Sur l'image ci-dessus, nous avons le résultat de la commande dans l'API. +*L'image ci-dessus illustre le résultat de la commande dans l'API.* ### Depuis l'espace client OVHcloud -Dans l'onglet `Fermes de serveurs`{.action}, après avoir sélectionné l'une d'entre elles, l'état de chacun de ses serveurs est affiché dans la ligne correspondant à celui-ci. +Dans l'onglet `Fermes de serveurs`{.action}, après avoir sélectionné l'une d'elles, l'état de chacun de ses serveurs est affiché sur la ligne correspondante. #### Résultat -![Résultat état de santé des serveurs via le Manager](images/farm_server_health.png){.thumbnail} +![Résultat état de santé du serveur via l'espace client OVHcloud](images/farm_server_health.png){.thumbnail} -Afin d'obtenir les détails sur l'état de santé d'un serveur, il suffit de cliquer sur le pictogramme dans la colonne "Status". +Pour obtenir des détails sur l'état de santé d'un serveur, cliquez sur le texte dans la colonne "**Status**", ou bien cliquez sur le bouton `...`{.action} et sélectionnez `Voir le statut`{.action}. -![Résultat état de santé des serveurs via le Manager (détails)](images/server_health_detail.png){.thumbnail} +![Résultat état de santé du serveur via l'espace client OVHcloud (détails)](images/server_health_detail.png){.thumbnail} -### Explications des détails obtenus +### Explication des détails d'état du serveur -Comme expliqué précédemment, nous avons bien récupéré l'état de santé du serveur pour chaque instance de votre OVHcloud Load Balancer. +Comme expliqué précédemment, nous avons récupéré l'état de santé du serveur pour chaque instance de votre service **OVHcloud Load Balancer**. -Pour chaque instance, nous avons plusieurs informations : +Pour chaque instance, nous disposons des informations suivantes : |Champ|Description| |---|---| |Status|État du serveur| -|Check code|Code de retour de la sonde| -|Check status|État de la sonde| +|Check code|Code de retour de la sonde de vérification| +|Check status|État de la sonde de vérification| |Last check content|Contenu du retour de la sonde| -|Check time|Date d'exécution de la sonde| - -## Annexe - -### Récupérer la liste des instances de votre OVHcloud Load Balancer - -> [!api] -> -> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/instancesState -> +|Check time|Date et heure d'exécution de la sonde| ## Aller plus loin -Échangez avec notre [communauté d'utilisateurs](/links/community). +Échangez avec notre [communauté d'utilisateurs](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/retrieve_servers_state/images/farm_server_health.png b/pages/network/load_balancer/retrieve_servers_state/images/farm_server_health.png index 25941847b03..99a667cee8f 100644 Binary files a/pages/network/load_balancer/retrieve_servers_state/images/farm_server_health.png and b/pages/network/load_balancer/retrieve_servers_state/images/farm_server_health.png differ diff --git a/pages/network/load_balancer/retrieve_servers_state/images/result_serversStateApi.png b/pages/network/load_balancer/retrieve_servers_state/images/result_serversStateApi.png deleted file mode 100644 index 7df799f8980..00000000000 Binary files a/pages/network/load_balancer/retrieve_servers_state/images/result_serversStateApi.png and /dev/null differ diff --git a/pages/network/load_balancer/retrieve_servers_state/images/result_servers_state_api.png b/pages/network/load_balancer/retrieve_servers_state/images/result_servers_state_api.png new file mode 100644 index 00000000000..1497ef93326 Binary files /dev/null and b/pages/network/load_balancer/retrieve_servers_state/images/result_servers_state_api.png differ diff --git a/pages/network/load_balancer/retrieve_servers_state/images/server_health_detail.png b/pages/network/load_balancer/retrieve_servers_state/images/server_health_detail.png index 1978959e61a..2f4dce8fa16 100644 Binary files a/pages/network/load_balancer/retrieve_servers_state/images/server_health_detail.png and b/pages/network/load_balancer/retrieve_servers_state/images/server_health_detail.png differ diff --git a/pages/network/load_balancer/use-lb/guide.de-de.md b/pages/network/load_balancer/use-lb/guide.de-de.md index 6adcd0223ea..84495985719 100644 --- a/pages/network/load_balancer/use-lb/guide.de-de.md +++ b/pages/network/load_balancer/use-lb/guide.de-de.md @@ -10,8 +10,8 @@ Ziel dieser Anleitung ist es, Sie bei der erstmaligen Verwendung des Loadbalance ## Voraussetzungen -- Zugang zu Ihrem OVHcloud Kundencenter -- Bestellung des [Loadbalancers](/links/network/load-balancer) +- Sie haben einen [OVHcloud Loadbalancer](/links/network/loadbalancer) in Ihrem OVHcloud Kundencenter. +- Sie haben Zugriff auf Ihr [OVHcloud Kundencenter](/links/manager). ## Beschreibung @@ -62,6 +62,7 @@ Sie haben außerdem Zugriff auf die erweiterten Einstellungen: |HTTP-Header|Hier fügen Sie einen HTTP-Header hinzu| ### Verwaltung der Serverfarmen + Um eine Serverfarm hinzuzufügen, gehen Sie einfach in den Bereich `Serverfarmen`{.action} und klicken dann auf `Eine Serverfarm hinzufügen`{.action}. Ihnen stehen die gleichen wesentlichen Optionen zur Verfügung wie beim Frontend. Die erweiterten Einstellungen sind jedoch anders: ![Eine Serverfarm hinzufügen](images/advanced_cluster.png){.thumbnail} @@ -73,6 +74,7 @@ Um eine Serverfarm hinzuzufügen, gehen Sie einfach in den Bereich `Serverfarmen |Monitoring-Sonde|Auswahl und Aktivierung der Monitoring-Sonde| ### Verwaltung der Server + Nachdem Ihre Serverfarm angelegt wurde, müssen Sie ihr nur noch Server zuweisen. Nachfolgend die Details zu den Optionen und den erweiterten Einstellungen: ![Server hinzufügen](images/add_server.png){.thumbnail} @@ -92,9 +94,11 @@ Nachdem Ihre Serverfarm angelegt wurde, müssen Sie ihr nur noch Server zuweisen |Proxy-Protokollversion|**Nur wenn Sie das Proxy-Protokoll bereits konfiguriert haben**, wählen Sie die Proxy-Protokollversion aus, die Sie auf diesem Server verwenden möchten.
Weitere Informationen zum Proxy-Protokoll und dessen Verwendung mit dem Loadbalancer von OVHcloud finden Sie in [dieser Anleitung](/pages/network/load_balancer/create_proxyprotocol/).| ### Verwaltung der SSL-Zertifikate + Im Bereich `SSL-Zertifikate`{.action} ist es möglich, den Loadbalancer um eine SSL-Verschlüsselung zu ergänzen. Sie haben zwei Möglichkeiten: Sie können ein SSL-Zertifikat über OVH bestellen oder ein externes Zertifikat hinzufügen. -#### SSL-Zertifikat von OVH +#### SSL-Zertifikat von OVHcloud + Um ein SSL-Zertifikat zu bestellen, gehen Sie einfach in den Bereich `SSL-Zertifikate`{.action}, klicken dann auf `Ein SSL-Zertifikat bestellen`{.action} und folgen dem Bestellprozess: ![SSL-Zertifikat bestellen](images/ordering_ssl.png){.thumbnail} @@ -106,6 +110,7 @@ Um ein SSL-Zertifikat zu bestellen, gehen Sie einfach in den Bereich `SSL-Zertif |Fully Qualified Domain Name (FQDN)|Die betroffene(n) Domain(s)| #### Hinzufügen eines externen SSL-Zertifikats + Wenn Sie bereits über ein eigenes SSL-Zertifikat verfügen, können Sie es direkt hinzufügen: ![Ein SSL-Zertifikat hinzufügen](images/external_ssl.png){.thumbnail} @@ -119,4 +124,4 @@ Wenn Sie bereits über ein eigenes SSL-Zertifikat verfügen, können Sie es dire ## Weiterführende Informationen -Treten Sie unserer [User Community](/links/community) bei. \ No newline at end of file +Treten Sie unserer [User Community](/links/community) bei. diff --git a/pages/network/load_balancer/use-lb/guide.en-asia.md b/pages/network/load_balancer/use-lb/guide.en-asia.md index 8d2a654a040..c8a55b25d04 100644 --- a/pages/network/load_balancer/use-lb/guide.en-asia.md +++ b/pages/network/load_balancer/use-lb/guide.en-asia.md @@ -10,8 +10,8 @@ This guide is designed to help you get started using the Load Balancer, by intro ## Requirements -- You must have access to your OVH Control Panel. -- You must have ordered a [Load Balancer](/links/network/load-balancer). +- An [OVHcloud Load Balancer](/links/network/load-balancer) service +- Access to the [OVHcloud Control Panel](/links/manager) ## Instructions @@ -94,9 +94,11 @@ Once you have created your server cluster, you just need to add servers to it. D |PROXY Protocol version|**Only if you have configured it**, choose the version of the PROXY protocol you wish to use on the server.
You can find more information on the PROXY protocol and how to use it with the OVHcloud Load Balancer in [this guide](/pages/network/load_balancer/create_proxyprotocol/).| ### Managing SSL certificates + You can add an SSL certificate to the Load Balancer in the `SSL Certificate`{.action} section. You have two options: you can order an SSL certificate from OVH, or add an external certificate. -#### OVH SSL certificate +#### OVHcloud SSL certificate + To order an SSL certificate, simply go to the `SSL Certificate`{.action} section, then click `Order an SSL certificate`{.action} and browse the options available: ![Ordering an SSL certificate](images/ordering_ssl.png){.thumbnail} @@ -108,6 +110,7 @@ To order an SSL certificate, simply go to the `SSL Certificate`{.action} section |Fully Qualified Domain Name (FQDN)|Domain(s) concerned| #### Adding an external SSL certificate + If you already have your own SSL certificate, you can add it directly: ![Adding an SSL certificate](images/external_ssl.png){.thumbnail} diff --git a/pages/network/load_balancer/use-lb/guide.en-au.md b/pages/network/load_balancer/use-lb/guide.en-au.md index 8d2a654a040..c8a55b25d04 100644 --- a/pages/network/load_balancer/use-lb/guide.en-au.md +++ b/pages/network/load_balancer/use-lb/guide.en-au.md @@ -10,8 +10,8 @@ This guide is designed to help you get started using the Load Balancer, by intro ## Requirements -- You must have access to your OVH Control Panel. -- You must have ordered a [Load Balancer](/links/network/load-balancer). +- An [OVHcloud Load Balancer](/links/network/load-balancer) service +- Access to the [OVHcloud Control Panel](/links/manager) ## Instructions @@ -94,9 +94,11 @@ Once you have created your server cluster, you just need to add servers to it. D |PROXY Protocol version|**Only if you have configured it**, choose the version of the PROXY protocol you wish to use on the server.
You can find more information on the PROXY protocol and how to use it with the OVHcloud Load Balancer in [this guide](/pages/network/load_balancer/create_proxyprotocol/).| ### Managing SSL certificates + You can add an SSL certificate to the Load Balancer in the `SSL Certificate`{.action} section. You have two options: you can order an SSL certificate from OVH, or add an external certificate. -#### OVH SSL certificate +#### OVHcloud SSL certificate + To order an SSL certificate, simply go to the `SSL Certificate`{.action} section, then click `Order an SSL certificate`{.action} and browse the options available: ![Ordering an SSL certificate](images/ordering_ssl.png){.thumbnail} @@ -108,6 +110,7 @@ To order an SSL certificate, simply go to the `SSL Certificate`{.action} section |Fully Qualified Domain Name (FQDN)|Domain(s) concerned| #### Adding an external SSL certificate + If you already have your own SSL certificate, you can add it directly: ![Adding an SSL certificate](images/external_ssl.png){.thumbnail} diff --git a/pages/network/load_balancer/use-lb/guide.en-ca.md b/pages/network/load_balancer/use-lb/guide.en-ca.md index 8d2a654a040..c8a55b25d04 100644 --- a/pages/network/load_balancer/use-lb/guide.en-ca.md +++ b/pages/network/load_balancer/use-lb/guide.en-ca.md @@ -10,8 +10,8 @@ This guide is designed to help you get started using the Load Balancer, by intro ## Requirements -- You must have access to your OVH Control Panel. -- You must have ordered a [Load Balancer](/links/network/load-balancer). +- An [OVHcloud Load Balancer](/links/network/load-balancer) service +- Access to the [OVHcloud Control Panel](/links/manager) ## Instructions @@ -94,9 +94,11 @@ Once you have created your server cluster, you just need to add servers to it. D |PROXY Protocol version|**Only if you have configured it**, choose the version of the PROXY protocol you wish to use on the server.
You can find more information on the PROXY protocol and how to use it with the OVHcloud Load Balancer in [this guide](/pages/network/load_balancer/create_proxyprotocol/).| ### Managing SSL certificates + You can add an SSL certificate to the Load Balancer in the `SSL Certificate`{.action} section. You have two options: you can order an SSL certificate from OVH, or add an external certificate. -#### OVH SSL certificate +#### OVHcloud SSL certificate + To order an SSL certificate, simply go to the `SSL Certificate`{.action} section, then click `Order an SSL certificate`{.action} and browse the options available: ![Ordering an SSL certificate](images/ordering_ssl.png){.thumbnail} @@ -108,6 +110,7 @@ To order an SSL certificate, simply go to the `SSL Certificate`{.action} section |Fully Qualified Domain Name (FQDN)|Domain(s) concerned| #### Adding an external SSL certificate + If you already have your own SSL certificate, you can add it directly: ![Adding an SSL certificate](images/external_ssl.png){.thumbnail} diff --git a/pages/network/load_balancer/use-lb/guide.en-gb.md b/pages/network/load_balancer/use-lb/guide.en-gb.md index 8d2a654a040..c8a55b25d04 100644 --- a/pages/network/load_balancer/use-lb/guide.en-gb.md +++ b/pages/network/load_balancer/use-lb/guide.en-gb.md @@ -10,8 +10,8 @@ This guide is designed to help you get started using the Load Balancer, by intro ## Requirements -- You must have access to your OVH Control Panel. -- You must have ordered a [Load Balancer](/links/network/load-balancer). +- An [OVHcloud Load Balancer](/links/network/load-balancer) service +- Access to the [OVHcloud Control Panel](/links/manager) ## Instructions @@ -94,9 +94,11 @@ Once you have created your server cluster, you just need to add servers to it. D |PROXY Protocol version|**Only if you have configured it**, choose the version of the PROXY protocol you wish to use on the server.
You can find more information on the PROXY protocol and how to use it with the OVHcloud Load Balancer in [this guide](/pages/network/load_balancer/create_proxyprotocol/).| ### Managing SSL certificates + You can add an SSL certificate to the Load Balancer in the `SSL Certificate`{.action} section. You have two options: you can order an SSL certificate from OVH, or add an external certificate. -#### OVH SSL certificate +#### OVHcloud SSL certificate + To order an SSL certificate, simply go to the `SSL Certificate`{.action} section, then click `Order an SSL certificate`{.action} and browse the options available: ![Ordering an SSL certificate](images/ordering_ssl.png){.thumbnail} @@ -108,6 +110,7 @@ To order an SSL certificate, simply go to the `SSL Certificate`{.action} section |Fully Qualified Domain Name (FQDN)|Domain(s) concerned| #### Adding an external SSL certificate + If you already have your own SSL certificate, you can add it directly: ![Adding an SSL certificate](images/external_ssl.png){.thumbnail} diff --git a/pages/network/load_balancer/use-lb/guide.en-sg.md b/pages/network/load_balancer/use-lb/guide.en-sg.md index 8d2a654a040..c8a55b25d04 100644 --- a/pages/network/load_balancer/use-lb/guide.en-sg.md +++ b/pages/network/load_balancer/use-lb/guide.en-sg.md @@ -10,8 +10,8 @@ This guide is designed to help you get started using the Load Balancer, by intro ## Requirements -- You must have access to your OVH Control Panel. -- You must have ordered a [Load Balancer](/links/network/load-balancer). +- An [OVHcloud Load Balancer](/links/network/load-balancer) service +- Access to the [OVHcloud Control Panel](/links/manager) ## Instructions @@ -94,9 +94,11 @@ Once you have created your server cluster, you just need to add servers to it. D |PROXY Protocol version|**Only if you have configured it**, choose the version of the PROXY protocol you wish to use on the server.
You can find more information on the PROXY protocol and how to use it with the OVHcloud Load Balancer in [this guide](/pages/network/load_balancer/create_proxyprotocol/).| ### Managing SSL certificates + You can add an SSL certificate to the Load Balancer in the `SSL Certificate`{.action} section. You have two options: you can order an SSL certificate from OVH, or add an external certificate. -#### OVH SSL certificate +#### OVHcloud SSL certificate + To order an SSL certificate, simply go to the `SSL Certificate`{.action} section, then click `Order an SSL certificate`{.action} and browse the options available: ![Ordering an SSL certificate](images/ordering_ssl.png){.thumbnail} @@ -108,6 +110,7 @@ To order an SSL certificate, simply go to the `SSL Certificate`{.action} section |Fully Qualified Domain Name (FQDN)|Domain(s) concerned| #### Adding an external SSL certificate + If you already have your own SSL certificate, you can add it directly: ![Adding an SSL certificate](images/external_ssl.png){.thumbnail} diff --git a/pages/network/load_balancer/use-lb/guide.en-us.md b/pages/network/load_balancer/use-lb/guide.en-us.md index 8d2a654a040..c8a55b25d04 100644 --- a/pages/network/load_balancer/use-lb/guide.en-us.md +++ b/pages/network/load_balancer/use-lb/guide.en-us.md @@ -10,8 +10,8 @@ This guide is designed to help you get started using the Load Balancer, by intro ## Requirements -- You must have access to your OVH Control Panel. -- You must have ordered a [Load Balancer](/links/network/load-balancer). +- An [OVHcloud Load Balancer](/links/network/load-balancer) service +- Access to the [OVHcloud Control Panel](/links/manager) ## Instructions @@ -94,9 +94,11 @@ Once you have created your server cluster, you just need to add servers to it. D |PROXY Protocol version|**Only if you have configured it**, choose the version of the PROXY protocol you wish to use on the server.
You can find more information on the PROXY protocol and how to use it with the OVHcloud Load Balancer in [this guide](/pages/network/load_balancer/create_proxyprotocol/).| ### Managing SSL certificates + You can add an SSL certificate to the Load Balancer in the `SSL Certificate`{.action} section. You have two options: you can order an SSL certificate from OVH, or add an external certificate. -#### OVH SSL certificate +#### OVHcloud SSL certificate + To order an SSL certificate, simply go to the `SSL Certificate`{.action} section, then click `Order an SSL certificate`{.action} and browse the options available: ![Ordering an SSL certificate](images/ordering_ssl.png){.thumbnail} @@ -108,6 +110,7 @@ To order an SSL certificate, simply go to the `SSL Certificate`{.action} section |Fully Qualified Domain Name (FQDN)|Domain(s) concerned| #### Adding an external SSL certificate + If you already have your own SSL certificate, you can add it directly: ![Adding an SSL certificate](images/external_ssl.png){.thumbnail} diff --git a/pages/network/load_balancer/use-lb/guide.es-es.md b/pages/network/load_balancer/use-lb/guide.es-es.md index ec4e36981f4..bb05d033384 100644 --- a/pages/network/load_balancer/use-lb/guide.es-es.md +++ b/pages/network/load_balancer/use-lb/guide.es-es.md @@ -10,8 +10,8 @@ Esta guía explica los primeros pasos con el servicio Load Balancer y presenta s ## Requisitos -- Tener acceso al [área de cliente](/links/manager). -- Haber contratado un [Load Balancer](/links/network/load-balancer). +- Tener el servicio [Load Balancer de OVHcloud](/links/network/load-balancer) en su cuenta de OVHcloud. +- Estar conectado a su [área de cliente de OVHcloud](/links/manager). ## Procedimiento @@ -64,6 +64,7 @@ En función de la configuración anterior, aparecerán algunas de las siguientes En función del protocolo seleccionado, también podrá activar el soporte de HTTP Strict Transport Security. ### Administrar las granjas + Para añadir una granja de servidores, abra la pestaña `Granjas de servidores`{.action} y haga clic en `Añadir una granja de servidores`{.action}. Las opciones principales son las mismas que en la creación de frontends. Sin embargo, los parámetros avanzados son diferentes: ![Añadir una granja de servidores](images/advanced_cluster.png){.thumbnail} @@ -75,6 +76,7 @@ Para añadir una granja de servidores, abra la pestaña `Granjas de servidores`{ |Sonda|Elección y activación de la sonda, y configuración de la misma| ### Administrar los servidores + Una vez haya creado la granja, solo tendrá que añadir los servidores haciendo clic en `Añadir un servidor`{.action}. A continuación se explican en detalle los distintos elementos que deben indicarse, así como los parámetros avanzados: ![Añadir servidor](images/add_server.png){.thumbnail} @@ -94,9 +96,11 @@ Una vez haya creado la granja, solo tendrá que añadir los servidores haciendo |Versión del protocolo de PROXY|**Sólo si ya lo ha configurado**, elija la versión del protocolo de PROXY que desea utilizar en este servidor.
Encontrará más información sobre el protocolo PROXY y su uso con el servicio Load Balancer de OVHcloud en [esta guía](/pages/network/load_balancer/create_proxyprotocol/).| ### Administrar los certificados SSL + En la pestaña `Certificados SSL`{.action}, puede añadir un SSL al Load Balancer, eligiendo entre dos opciones: contratar un certificado SSL en OVH o añadir un certificado externo. -#### Certificado SSL de OVH +#### Certificado SSL de OVHcloud + Para contratar un certificado SSL, abra la pestaña `Certificado SSL`{.action} y haga clic en `Contratar un certificado SSL`{.action}. Introduzca los datos solicitados en el formulario. ![Contratar un certificado SSL](images/ordering_ssl.png){.thumbnail} @@ -110,6 +114,7 @@ Para contratar un certificado SSL, abra la pestaña `Certificado SSL`{.action} y Si opta por un certificado Comodo EV, también deberá introducir la información de contacto y jurisdiccional. #### Añadir un certificado SSL externo + Si ya tiene su propio certificado SSL, puede añadirlo directamente: ![Añadir un certificado SSL](images/external_ssl.png){.thumbnail} diff --git a/pages/network/load_balancer/use-lb/guide.es-us.md b/pages/network/load_balancer/use-lb/guide.es-us.md index 0e1b7b03059..087165bb487 100644 --- a/pages/network/load_balancer/use-lb/guide.es-us.md +++ b/pages/network/load_balancer/use-lb/guide.es-us.md @@ -10,8 +10,8 @@ Esta guía explica los primeros pasos con el servicio Load Balancer y presenta s ## Requisitos -- Tener acceso al [área de cliente](/links/manager). -- Haber contratado un [Load Balancer](/links/network/load-balancer). +- Tener el servicio [Load Balancer de OVHcloud](/links/network/load-balancer) en su cuenta de OVHcloud. +- Estar conectado a su [área de cliente de OVHcloud](/links/manager). ## Procedimiento @@ -64,6 +64,7 @@ En función de la configuración anterior, aparecerán algunas de las siguientes En función del protocolo seleccionado, también podrá activar el soporte de HTTP Strict Transport Security. ### Administrar las granjas + Para añadir una granja de servidores, abra la pestaña `Granjas de servidores`{.action} y haga clic en `Añadir una granja de servidores`{.action}. Las opciones principales son las mismas que en la creación de frontends. Sin embargo, los parámetros avanzados son diferentes: ![Añadir una granja de servidores](images/iplb-cluster-adv.png){.thumbnail} @@ -75,6 +76,7 @@ Para añadir una granja de servidores, abra la pestaña `Granjas de servidores`{ |Sonda|Elección y activación de la sonda, y configuración de la misma| ### Administrar los servidores + Una vez haya creado la granja, solo tendrá que añadir los servidores haciendo clic en `Añadir un servidor`{.action}. A continuación se explican en detalle los distintos elementos que deben indicarse, así como los parámetros avanzados: ![Añadir servidor](images/iplb-cluster-add-server.png){.thumbnail} @@ -95,9 +97,11 @@ Una vez haya creado la granja, solo tendrá que añadir los servidores haciendo |Versión del protocolo de PROXY|**Sólo si ya lo ha configurado**, elija la versión del protocolo de PROXY que desea utilizar en este servidor.
Encontrará más información sobre el protocolo PROXY y su uso con el servicio Load Balancer de OVHcloud en [esta guía](/pages/network/load_balancer/create_proxyprotocol/).| ### Administrar los certificados SSL + En la pestaña `Certificados SSL`{.action}, puede añadir un SSL al Load Balancer, eligiendo entre dos opciones: contratar un certificado SSL en OVH o añadir un certificado externo. -#### Certificado SSL de OVH +#### Certificado SSL de OVHcloud + Para contratar un certificado SSL, abra la pestaña `Certificado SSL`{.action} y haga clic en `Contratar un certificado SSL`{.action}. Introduzca los datos solicitados en el formulario. ![Contratar un certificado SSL](images/iplb-order-ssl.png){.thumbnail} @@ -110,6 +114,7 @@ Para contratar un certificado SSL, abra la pestaña `Certificado SSL`{.action} y Si opta por un certificado Comodo EV, también deberá introducir la información de contacto y jurisdiccional. #### Añadir un certificado SSL externo + Si ya tiene su propio certificado SSL, puede añadirlo directamente: ![Añadir un certificado SSL](images/iplb-add-ssl.png){.thumbnail} diff --git a/pages/network/load_balancer/use-lb/guide.it-it.md b/pages/network/load_balancer/use-lb/guide.it-it.md index 6b84573fa49..d6d37423846 100644 --- a/pages/network/load_balancer/use-lb/guide.it-it.md +++ b/pages/network/load_balancer/use-lb/guide.it-it.md @@ -10,12 +10,12 @@ Questa guida ti mostra come utilizzare il Load Balancer e presenta le principali ## Prerequisiti -- Avere accesso allo Spazio Cliente OVH -- Disporre di un [Load Balancer](/links/network/load-balancer) attivo +- Disporre di una soluzione [OVHcloud Load balancer](/links/network/load-balancer) disponibile nello Spazio Cliente OVHcloud. +- Avere accesso allo [Spazio Cliente OVHcloud](/links/manager). ## Procedura -### Gestisci il Load Balancer dallo Spazio Cliente OVH +### Gestisci il Load Balancer dallo Spazio Cliente OVHcloud Per gestire il Load Balancer accedi alla sezione `Bare Metal Cloud`{.action} dello Spazio Cliente e clicca su `Network`{.action} e `Load Balancer`{.action}. Seleziona il servizio. @@ -74,6 +74,7 @@ Per aggiungere una server farm, seleziona la scheda `Server Farm`{.action} e cli |Sonda|Scegli e attiva la sonda| ### Gestisci i server + Una volta creata la farm, non ti resta che aggiungervi dei server. Di seguito, i dettagli delle opzioni standard e avanzate disponibili: ![Aggiungi un server](images/add_server.png){.thumbnail} @@ -97,7 +98,7 @@ Una volta creata la farm, non ti resta che aggiungervi dei server. Di seguito, i Dalla scheda `Certificati SSL`{.action} è possibile aggiungere un SSL al servizio di Load Balancer. Hai 2 possibilità: ordinare un certificato SSL OVH o aggiungerne uno esterno. -#### Certificato SSL OVH +#### Certificato SSL OVHcloud Per ordinare un certificato SSL, seleziona la scheda `Certificati SSL`{.action}, clicca su `Ordina un certificato SSL`{.action} e segui gli step: diff --git a/pages/network/load_balancer/use-lb/guide.pl-pl.md b/pages/network/load_balancer/use-lb/guide.pl-pl.md index 7d8aceecb59..8a1c9a5379b 100644 --- a/pages/network/load_balancer/use-lb/guide.pl-pl.md +++ b/pages/network/load_balancer/use-lb/guide.pl-pl.md @@ -5,12 +5,13 @@ updated: 2025-07-30 --- ## Wprowadzenie + Niniejsza instrukcja ma na celu zapewnienie użytkownikowi pomocy we wdrożeniu usługi Load Balancer i przedstawienie jej głównych funkcji. ## Wymagania początkowe -- Dostęp do Twojego Panelu klienta -- Zamówienie rozwiązania [Load Balancer](/links/network/load-balancer) +- Posiadanie usługi [OVHcloud Load Balancer](/links/network/load-balancer) na koncie OVHcloud. +- Dostęp do [panelu klienta OVHcloud](/links/manager). ## W praktyce @@ -96,7 +97,7 @@ Po utworzeniu farmy serwerów pozostaje dodać do niej serwery (poniżej przedst Do Load Balancera można dodać certyfikatSSL w sekcji `Certyfikat SSL`{.action}. Tu dostępne są dwie możliwości – zamówienie certyfikatu SSL poprzez OVH lub dodanie certyfikatu zewnętrznego. -#### Certyfikat SSL OVH +#### Certyfikat SSL OVHcloud W celu zamówienia certyfikatu SSL wystarczy przejść do sekcji `Certyfikat SSL`{.action}, a następnie kliknąć `Zamów certyfikat SSL`{.action} i zastosować się do podanych instrukcji: diff --git a/pages/network/load_balancer/use-lb/guide.pt-pt.md b/pages/network/load_balancer/use-lb/guide.pt-pt.md index 7e67add21a3..398b4d56ab0 100644 --- a/pages/network/load_balancer/use-lb/guide.pt-pt.md +++ b/pages/network/load_balancer/use-lb/guide.pt-pt.md @@ -10,8 +10,8 @@ Este guia tem como objetivo facilitar a primeira utilização do Load Balancer e ## Pré-requisitos -- Ter acesso à Área de Cliente -- Ter contratado um [Load Balancer](/links/network/load-balancer) +- Dispor de uma oferta [Load Balancer OVHcloud](/links/network/load-balancer) na sua conta OVHcloud. +- Ter acesso à [Área de Cliente OVHcloud](/links/manager). ## Questões práticas @@ -62,6 +62,7 @@ A gestão dos Frontends tem opções de configuração avançada. |Cabeçalho HTTP|Adicionar cabeçalho HTTP| ### Gestão de Server Farms + Para adicionar uma Server Farm, basta aceder a `Server Farms`{.action} e clicar em `Adicionar Server Farm`{.action}. Nesta secção, as opções básicas são iguais às dos Frontends. Já as opções avançadas são diferentes. ![Adicionar Farm](images/advanced_cluster.png){.thumbnail} @@ -73,6 +74,7 @@ Para adicionar uma Server Farm, basta aceder a `Server Farms`{.action} e clicar |Sonda|Seleção e ativação da sonda| ### Gestão dos Servidores + Depois de criada a Server Farm, só falta adicionar os servidores (veja abaixo os detalhes das opções básicas e opções avançadas): ![Adicionar Servidor](images/add_server.png){.thumbnail} @@ -92,9 +94,11 @@ Depois de criada a Server Farm, só falta adicionar os servidores (veja abaixo o |Versão do protocolo PROXY|**Unicamente se já o configurou**, escolha a versão do protocolo PROXY que pretende utilizar neste servidor.
Pode encontrar mais informações sobre o protocolo PROXY e sobre a sua utilização com o serviço OVHcloud Load Balancer em [este manual](/pages/network/load_balancer/create_proxyprotocol/).| ### Gestão dos Certificados SSL + Pode adicionar um SSL ao Load Balancer na secção `Certificado SSL`{.action}. Aqui tem duas opções: solicitar um certificado SSL da OVH ou adicionar um certificado externo. -#### Certificado SSL OVH +#### Certificado SSL OVHcloud + Para solicitar um certificado SSL, basta aceder à secção `Certificado SSL`{.action}, clicar em `Encomendar um certificado SSL`{.action}, e seguir as instruções: ![Encomendar um certificado SSL](images/ordering_ssl.png){.thumbnail} @@ -106,6 +110,7 @@ Para solicitar um certificado SSL, basta aceder à secção `Certificado SSL`{.a |Fully Qualified Domain Name (FQDN)|O(s) domínio(s) associados(s) ao serviço| #### Adicionar um certificado SSL externo + Se já tem um certificado SSL, este pode ser associado ao serviço: ![Adicionar um Certificado SSL](images/external_ssl.png){.thumbnail} diff --git a/pages/network/load_balancer/use-lb/images/iplb-main.png b/pages/network/load_balancer/use-lb/images/iplb-main.png deleted file mode 100644 index a456b48cacd..00000000000 Binary files a/pages/network/load_balancer/use-lb/images/iplb-main.png and /dev/null differ diff --git a/pages/network/load_balancer/use-lb/images/lb_main_page.png b/pages/network/load_balancer/use-lb/images/lb_main_page.png deleted file mode 100644 index 870f15d3e65..00000000000 Binary files a/pages/network/load_balancer/use-lb/images/lb_main_page.png and /dev/null differ diff --git a/pages/network/load_balancer/use_api_details/guide.en-asia.md b/pages/network/load_balancer/use_api_details/guide.en-asia.md index d02d2004668..0bd400381f1 100644 --- a/pages/network/load_balancer/use_api_details/guide.en-asia.md +++ b/pages/network/load_balancer/use_api_details/guide.en-asia.md @@ -1,49 +1,38 @@ --- title: Details of API functions excerpt: Details of API functionalities -updated: 2022-04-04 +updated: 2025-09-29 --- ## Objective -Description of the different input points in the API for the Load Balancer OVH. +This guide provides a detailed description of all API functions for the OVHcloud Load Balancer. ## Prerequisite -## In Practice +- Consult the guide [First steps with the OVHcloud APIs](/pages/manage_and_operate/api/first-steps) to familiarize yourself with the use of OVHcloud APIv6. -### Manage your Load Balancer OVH service via the API +## Instructions -Details of the API functionality for the Load Balancer OVH +### Manage your OVHcloud Load Balancer service via the API -- All API calls are made in the section */ipLoadbalancing* available here : [https://ca.api.ovh.com/console/#/ipLoadbalancing](https://ca.api.ovh.com/console/#/ipLoadbalancing). - -> [!warning] -> -> Caution, for compatibility reasons, the entry point of the former -> system Load Balancer OVH is always present in the API /ip/loadBalancing, -> not to be confused with the new /ipLoadbalancing. -> +All API calls that are made in the section */ipLoadbalancing* are available on [this page](/links/console). > [!primary] > -> In the calls below all fields marked with an asterisk * -> are mandatory. +> In the calls below all fields marked with an asterisk `*` are mandatory. > > [!primary] > -> The Frontend, Farm and Server are specific to the -> protocol (among HTTP, TCP or UDP) in which they are defined. -> Although they can be "combined" with each other, this is only possible within -> of the same protocol. Thus, it is not possible to use a Frontend -> UDP with an HTTP Farm. But it is possible (in the absence of other -> limitation) to use an HTTP Frontend with an HTTP Farm. +> The Frontends, Farms and Servers are specific to the protocol (HTTP, TCP or UDP) in which they are defined. +> Compatibility between these components is only possible within the same protocol. +> For example, an HTTP Frontend can only be paired with an HTTP Farm, and cannot be used with a UDP Farm. > ## Services and zones -### Load Balancer OVH +### OVHcloud Load Balancer #### List active services @@ -52,14 +41,14 @@ Details of the API functionality for the Load Balancer OVH > @api {v1} /ipLoadbalancing GET /ipLoadbalancing > -#### List the zones available for the Load Balancer OVH +#### List the zones available for the OVHcloud Load Balancer > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/availableZones > -#### Return details of a Load Balancer OVH service +#### Return details of a OVHcloud Load Balancer service > [!faq] > @@ -75,7 +64,7 @@ Details of the API functionality for the Load Balancer OVH >> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters) > -#### Modify a Load Balancer OVH service +#### Modify a OVHcloud Load Balancer service > [!faq] > @@ -104,7 +93,7 @@ Details of the API functionality for the Load Balancer OVH >> >> > The SSL configuration you want to assign to the service (Value) > -#### List the services attached to the Load Balancer OVH +#### List the services attached to the OVHcloud Load Balancer > [!faq] > @@ -146,7 +135,7 @@ Details of the API functionality for the Load Balancer OVH >> >> Allows filtering according to the vrack network > -#### List the areas that can be attached to a Load Balancer OVH service +#### List the areas that can be attached to a OVHcloud Load Balancer service > [!faq] > @@ -320,7 +309,7 @@ Details of the API functionality for the Load Balancer OVH ### Zones -#### List active zones for a Load Balancer OVH service +#### List active zones for a OVHcloud Load Balancer service > [!faq] > @@ -416,7 +405,7 @@ Accessing HTTP protocol related elements (Frontend, Firmware, etc.). ### HTTP farms -#### List HTTP farms attached to a Load Balancer OVH service +#### List HTTP farms attached to a OVHcloud Load Balancer service > [!faq] > @@ -439,7 +428,7 @@ Accessing HTTP protocol related elements (Frontend, Firmware, etc.). >> >> The name of the zone (String of characters) > -#### Adding a new HTTP farm to a Load Balancer OVH service +#### Adding a new HTTP farm to a OVHcloud Load Balancer service > [!faq] > @@ -840,7 +829,7 @@ Accessing HTTP protocol related elements (Frontend, Firmware, etc.). ### Frontends HTTP -#### List HTTP frontends attached to a Load Balancer OVH service +#### List HTTP frontends attached to a OVHcloud Load Balancer service > [!faq] > @@ -871,7 +860,7 @@ Accessing HTTP protocol related elements (Frontend, Firmware, etc.). >> >> The name of your zone, ex: all (String of characters) > -#### Add an HTTP frontend to a Load Balancer OVH service +#### Add an HTTP frontend to a OVHcloud Load Balancer service > [!faq] > @@ -1071,7 +1060,7 @@ Routes are evaluated one by one, testing their routing rules. The first route va >> >> The identifier of an HTTP frontend (Number) > -#### Add a new HTTP route to a Load Balancer OVH service +#### Add a new HTTP route to a OVHcloud Load Balancer service > [!faq] > @@ -1393,7 +1382,7 @@ Access the elements related to the TCP protocol (Frontend, Farm, etc.). ### TCP Farms -#### List TCP farms attached to a Load Balancer OVH service +#### List TCP farms attached to a OVHcloud Load Balancer service > [!faq] > @@ -1416,7 +1405,7 @@ Access the elements related to the TCP protocol (Frontend, Farm, etc.). >> >> The name of your zone, ex: all (String of characters) > -#### Add a new TCP farm to a Load Balancer OVH service +#### Add a new TCP farm to a OVHcloud Load Balancer service > [!faq] > @@ -1809,7 +1798,7 @@ Access the elements related to the TCP protocol (Frontend, Farm, etc.). ### Frontends TCP -#### List TCP frontends attached to a Load Balancer OVH service +#### List TCP frontends attached to a OVHcloud Load Balancer service > [!faq] > @@ -1840,7 +1829,7 @@ Access the elements related to the TCP protocol (Frontend, Farm, etc.). >> >> The name of your zone, ex: all (String of characters) > -#### Add a TCP frontend to a Load Balancer OVH service +#### Add a TCP frontend to a OVHcloud Load Balancer service > [!faq] > @@ -1993,7 +1982,7 @@ Access the elements related to the TCP protocol (Frontend, Farm, etc.). ### Routes TCP Routes are evaluated one by one, testing their routing rules. The first route validating all its rules sees its action executed, and stops the evaluation of the remaining routes. The order of execution is defined by the type and weight of the route. -#### List TCP routes attached to a Load Balancer OVH service +#### List TCP routes attached to a OVHcloud Load Balancer service > [!faq] > @@ -2016,7 +2005,7 @@ Routes are evaluated one by one, testing their routing rules. The first route va >> >> The identifier of a TCP frontend (Number) > -#### Add a new TCP route to a Load Balancer OVH service +#### Add a new TCP route to a OVHcloud Load Balancer service > [!faq] > @@ -2330,7 +2319,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). ### UDP Farms -#### List UDP trusses attached to a Load Balancer OVH service +#### List UDP trusses attached to a OVHcloud Load Balancer service > [!faq] > @@ -2353,7 +2342,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). >> >> The name of your zone, ex: all (String of characters) > -#### Add a new UDP farm to a Load Balancer OVH service +#### Add a new UDP farm to a OVHcloud Load Balancer service > [!faq] > @@ -2632,7 +2621,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). ### Frontends UDP -#### List UDP frontends attached to a Load Balancer OVH service +#### List UDP frontends attached to a OVHcloud Load Balancer service > [!faq] > @@ -2663,7 +2652,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). >> >> The name of your zone, ex: all (String of characters) > -#### Add a UDP frontend to a Load Balancer OVH service +#### Add a UDP frontend to a OVHcloud Load Balancer service > [!faq] > @@ -2793,7 +2782,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). ### Additional IP -#### List Additional IPs routed on a Load Balancer OVH service +#### List Additional IPs routed on a OVHcloud Load Balancer service > [!faq] > @@ -2814,7 +2803,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). ### Service Status -#### Obtenir l'état des instances d'un service Load Balancer OVH +#### Obtenir l'état des instances d'un service OVHcloud Load Balancer > [!faq] > @@ -2852,7 +2841,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). >> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters) > -#### Apply changes to a Load Balancer OVH service +#### Apply changes to a OVHcloud Load Balancer service > [!faq] > @@ -2873,7 +2862,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). ### SSL Certificates -#### List SSL certificates of a Load Balancer OVH service +#### List SSL certificates of a OVHcloud Load Balancer service > [!faq] > @@ -2983,7 +2972,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). ### Tasks -#### List current tasks for a Load Balancer OVH service +#### List current tasks for a OVHcloud Load Balancer service > [!faq] > diff --git a/pages/network/load_balancer/use_api_details/guide.en-au.md b/pages/network/load_balancer/use_api_details/guide.en-au.md index d02d2004668..0bd400381f1 100644 --- a/pages/network/load_balancer/use_api_details/guide.en-au.md +++ b/pages/network/load_balancer/use_api_details/guide.en-au.md @@ -1,49 +1,38 @@ --- title: Details of API functions excerpt: Details of API functionalities -updated: 2022-04-04 +updated: 2025-09-29 --- ## Objective -Description of the different input points in the API for the Load Balancer OVH. +This guide provides a detailed description of all API functions for the OVHcloud Load Balancer. ## Prerequisite -## In Practice +- Consult the guide [First steps with the OVHcloud APIs](/pages/manage_and_operate/api/first-steps) to familiarize yourself with the use of OVHcloud APIv6. -### Manage your Load Balancer OVH service via the API +## Instructions -Details of the API functionality for the Load Balancer OVH +### Manage your OVHcloud Load Balancer service via the API -- All API calls are made in the section */ipLoadbalancing* available here : [https://ca.api.ovh.com/console/#/ipLoadbalancing](https://ca.api.ovh.com/console/#/ipLoadbalancing). - -> [!warning] -> -> Caution, for compatibility reasons, the entry point of the former -> system Load Balancer OVH is always present in the API /ip/loadBalancing, -> not to be confused with the new /ipLoadbalancing. -> +All API calls that are made in the section */ipLoadbalancing* are available on [this page](/links/console). > [!primary] > -> In the calls below all fields marked with an asterisk * -> are mandatory. +> In the calls below all fields marked with an asterisk `*` are mandatory. > > [!primary] > -> The Frontend, Farm and Server are specific to the -> protocol (among HTTP, TCP or UDP) in which they are defined. -> Although they can be "combined" with each other, this is only possible within -> of the same protocol. Thus, it is not possible to use a Frontend -> UDP with an HTTP Farm. But it is possible (in the absence of other -> limitation) to use an HTTP Frontend with an HTTP Farm. +> The Frontends, Farms and Servers are specific to the protocol (HTTP, TCP or UDP) in which they are defined. +> Compatibility between these components is only possible within the same protocol. +> For example, an HTTP Frontend can only be paired with an HTTP Farm, and cannot be used with a UDP Farm. > ## Services and zones -### Load Balancer OVH +### OVHcloud Load Balancer #### List active services @@ -52,14 +41,14 @@ Details of the API functionality for the Load Balancer OVH > @api {v1} /ipLoadbalancing GET /ipLoadbalancing > -#### List the zones available for the Load Balancer OVH +#### List the zones available for the OVHcloud Load Balancer > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/availableZones > -#### Return details of a Load Balancer OVH service +#### Return details of a OVHcloud Load Balancer service > [!faq] > @@ -75,7 +64,7 @@ Details of the API functionality for the Load Balancer OVH >> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters) > -#### Modify a Load Balancer OVH service +#### Modify a OVHcloud Load Balancer service > [!faq] > @@ -104,7 +93,7 @@ Details of the API functionality for the Load Balancer OVH >> >> > The SSL configuration you want to assign to the service (Value) > -#### List the services attached to the Load Balancer OVH +#### List the services attached to the OVHcloud Load Balancer > [!faq] > @@ -146,7 +135,7 @@ Details of the API functionality for the Load Balancer OVH >> >> Allows filtering according to the vrack network > -#### List the areas that can be attached to a Load Balancer OVH service +#### List the areas that can be attached to a OVHcloud Load Balancer service > [!faq] > @@ -320,7 +309,7 @@ Details of the API functionality for the Load Balancer OVH ### Zones -#### List active zones for a Load Balancer OVH service +#### List active zones for a OVHcloud Load Balancer service > [!faq] > @@ -416,7 +405,7 @@ Accessing HTTP protocol related elements (Frontend, Firmware, etc.). ### HTTP farms -#### List HTTP farms attached to a Load Balancer OVH service +#### List HTTP farms attached to a OVHcloud Load Balancer service > [!faq] > @@ -439,7 +428,7 @@ Accessing HTTP protocol related elements (Frontend, Firmware, etc.). >> >> The name of the zone (String of characters) > -#### Adding a new HTTP farm to a Load Balancer OVH service +#### Adding a new HTTP farm to a OVHcloud Load Balancer service > [!faq] > @@ -840,7 +829,7 @@ Accessing HTTP protocol related elements (Frontend, Firmware, etc.). ### Frontends HTTP -#### List HTTP frontends attached to a Load Balancer OVH service +#### List HTTP frontends attached to a OVHcloud Load Balancer service > [!faq] > @@ -871,7 +860,7 @@ Accessing HTTP protocol related elements (Frontend, Firmware, etc.). >> >> The name of your zone, ex: all (String of characters) > -#### Add an HTTP frontend to a Load Balancer OVH service +#### Add an HTTP frontend to a OVHcloud Load Balancer service > [!faq] > @@ -1071,7 +1060,7 @@ Routes are evaluated one by one, testing their routing rules. The first route va >> >> The identifier of an HTTP frontend (Number) > -#### Add a new HTTP route to a Load Balancer OVH service +#### Add a new HTTP route to a OVHcloud Load Balancer service > [!faq] > @@ -1393,7 +1382,7 @@ Access the elements related to the TCP protocol (Frontend, Farm, etc.). ### TCP Farms -#### List TCP farms attached to a Load Balancer OVH service +#### List TCP farms attached to a OVHcloud Load Balancer service > [!faq] > @@ -1416,7 +1405,7 @@ Access the elements related to the TCP protocol (Frontend, Farm, etc.). >> >> The name of your zone, ex: all (String of characters) > -#### Add a new TCP farm to a Load Balancer OVH service +#### Add a new TCP farm to a OVHcloud Load Balancer service > [!faq] > @@ -1809,7 +1798,7 @@ Access the elements related to the TCP protocol (Frontend, Farm, etc.). ### Frontends TCP -#### List TCP frontends attached to a Load Balancer OVH service +#### List TCP frontends attached to a OVHcloud Load Balancer service > [!faq] > @@ -1840,7 +1829,7 @@ Access the elements related to the TCP protocol (Frontend, Farm, etc.). >> >> The name of your zone, ex: all (String of characters) > -#### Add a TCP frontend to a Load Balancer OVH service +#### Add a TCP frontend to a OVHcloud Load Balancer service > [!faq] > @@ -1993,7 +1982,7 @@ Access the elements related to the TCP protocol (Frontend, Farm, etc.). ### Routes TCP Routes are evaluated one by one, testing their routing rules. The first route validating all its rules sees its action executed, and stops the evaluation of the remaining routes. The order of execution is defined by the type and weight of the route. -#### List TCP routes attached to a Load Balancer OVH service +#### List TCP routes attached to a OVHcloud Load Balancer service > [!faq] > @@ -2016,7 +2005,7 @@ Routes are evaluated one by one, testing their routing rules. The first route va >> >> The identifier of a TCP frontend (Number) > -#### Add a new TCP route to a Load Balancer OVH service +#### Add a new TCP route to a OVHcloud Load Balancer service > [!faq] > @@ -2330,7 +2319,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). ### UDP Farms -#### List UDP trusses attached to a Load Balancer OVH service +#### List UDP trusses attached to a OVHcloud Load Balancer service > [!faq] > @@ -2353,7 +2342,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). >> >> The name of your zone, ex: all (String of characters) > -#### Add a new UDP farm to a Load Balancer OVH service +#### Add a new UDP farm to a OVHcloud Load Balancer service > [!faq] > @@ -2632,7 +2621,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). ### Frontends UDP -#### List UDP frontends attached to a Load Balancer OVH service +#### List UDP frontends attached to a OVHcloud Load Balancer service > [!faq] > @@ -2663,7 +2652,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). >> >> The name of your zone, ex: all (String of characters) > -#### Add a UDP frontend to a Load Balancer OVH service +#### Add a UDP frontend to a OVHcloud Load Balancer service > [!faq] > @@ -2793,7 +2782,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). ### Additional IP -#### List Additional IPs routed on a Load Balancer OVH service +#### List Additional IPs routed on a OVHcloud Load Balancer service > [!faq] > @@ -2814,7 +2803,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). ### Service Status -#### Obtenir l'état des instances d'un service Load Balancer OVH +#### Obtenir l'état des instances d'un service OVHcloud Load Balancer > [!faq] > @@ -2852,7 +2841,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). >> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters) > -#### Apply changes to a Load Balancer OVH service +#### Apply changes to a OVHcloud Load Balancer service > [!faq] > @@ -2873,7 +2862,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). ### SSL Certificates -#### List SSL certificates of a Load Balancer OVH service +#### List SSL certificates of a OVHcloud Load Balancer service > [!faq] > @@ -2983,7 +2972,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). ### Tasks -#### List current tasks for a Load Balancer OVH service +#### List current tasks for a OVHcloud Load Balancer service > [!faq] > diff --git a/pages/network/load_balancer/use_api_details/guide.en-ca.md b/pages/network/load_balancer/use_api_details/guide.en-ca.md index d02d2004668..0bd400381f1 100644 --- a/pages/network/load_balancer/use_api_details/guide.en-ca.md +++ b/pages/network/load_balancer/use_api_details/guide.en-ca.md @@ -1,49 +1,38 @@ --- title: Details of API functions excerpt: Details of API functionalities -updated: 2022-04-04 +updated: 2025-09-29 --- ## Objective -Description of the different input points in the API for the Load Balancer OVH. +This guide provides a detailed description of all API functions for the OVHcloud Load Balancer. ## Prerequisite -## In Practice +- Consult the guide [First steps with the OVHcloud APIs](/pages/manage_and_operate/api/first-steps) to familiarize yourself with the use of OVHcloud APIv6. -### Manage your Load Balancer OVH service via the API +## Instructions -Details of the API functionality for the Load Balancer OVH +### Manage your OVHcloud Load Balancer service via the API -- All API calls are made in the section */ipLoadbalancing* available here : [https://ca.api.ovh.com/console/#/ipLoadbalancing](https://ca.api.ovh.com/console/#/ipLoadbalancing). - -> [!warning] -> -> Caution, for compatibility reasons, the entry point of the former -> system Load Balancer OVH is always present in the API /ip/loadBalancing, -> not to be confused with the new /ipLoadbalancing. -> +All API calls that are made in the section */ipLoadbalancing* are available on [this page](/links/console). > [!primary] > -> In the calls below all fields marked with an asterisk * -> are mandatory. +> In the calls below all fields marked with an asterisk `*` are mandatory. > > [!primary] > -> The Frontend, Farm and Server are specific to the -> protocol (among HTTP, TCP or UDP) in which they are defined. -> Although they can be "combined" with each other, this is only possible within -> of the same protocol. Thus, it is not possible to use a Frontend -> UDP with an HTTP Farm. But it is possible (in the absence of other -> limitation) to use an HTTP Frontend with an HTTP Farm. +> The Frontends, Farms and Servers are specific to the protocol (HTTP, TCP or UDP) in which they are defined. +> Compatibility between these components is only possible within the same protocol. +> For example, an HTTP Frontend can only be paired with an HTTP Farm, and cannot be used with a UDP Farm. > ## Services and zones -### Load Balancer OVH +### OVHcloud Load Balancer #### List active services @@ -52,14 +41,14 @@ Details of the API functionality for the Load Balancer OVH > @api {v1} /ipLoadbalancing GET /ipLoadbalancing > -#### List the zones available for the Load Balancer OVH +#### List the zones available for the OVHcloud Load Balancer > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/availableZones > -#### Return details of a Load Balancer OVH service +#### Return details of a OVHcloud Load Balancer service > [!faq] > @@ -75,7 +64,7 @@ Details of the API functionality for the Load Balancer OVH >> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters) > -#### Modify a Load Balancer OVH service +#### Modify a OVHcloud Load Balancer service > [!faq] > @@ -104,7 +93,7 @@ Details of the API functionality for the Load Balancer OVH >> >> > The SSL configuration you want to assign to the service (Value) > -#### List the services attached to the Load Balancer OVH +#### List the services attached to the OVHcloud Load Balancer > [!faq] > @@ -146,7 +135,7 @@ Details of the API functionality for the Load Balancer OVH >> >> Allows filtering according to the vrack network > -#### List the areas that can be attached to a Load Balancer OVH service +#### List the areas that can be attached to a OVHcloud Load Balancer service > [!faq] > @@ -320,7 +309,7 @@ Details of the API functionality for the Load Balancer OVH ### Zones -#### List active zones for a Load Balancer OVH service +#### List active zones for a OVHcloud Load Balancer service > [!faq] > @@ -416,7 +405,7 @@ Accessing HTTP protocol related elements (Frontend, Firmware, etc.). ### HTTP farms -#### List HTTP farms attached to a Load Balancer OVH service +#### List HTTP farms attached to a OVHcloud Load Balancer service > [!faq] > @@ -439,7 +428,7 @@ Accessing HTTP protocol related elements (Frontend, Firmware, etc.). >> >> The name of the zone (String of characters) > -#### Adding a new HTTP farm to a Load Balancer OVH service +#### Adding a new HTTP farm to a OVHcloud Load Balancer service > [!faq] > @@ -840,7 +829,7 @@ Accessing HTTP protocol related elements (Frontend, Firmware, etc.). ### Frontends HTTP -#### List HTTP frontends attached to a Load Balancer OVH service +#### List HTTP frontends attached to a OVHcloud Load Balancer service > [!faq] > @@ -871,7 +860,7 @@ Accessing HTTP protocol related elements (Frontend, Firmware, etc.). >> >> The name of your zone, ex: all (String of characters) > -#### Add an HTTP frontend to a Load Balancer OVH service +#### Add an HTTP frontend to a OVHcloud Load Balancer service > [!faq] > @@ -1071,7 +1060,7 @@ Routes are evaluated one by one, testing their routing rules. The first route va >> >> The identifier of an HTTP frontend (Number) > -#### Add a new HTTP route to a Load Balancer OVH service +#### Add a new HTTP route to a OVHcloud Load Balancer service > [!faq] > @@ -1393,7 +1382,7 @@ Access the elements related to the TCP protocol (Frontend, Farm, etc.). ### TCP Farms -#### List TCP farms attached to a Load Balancer OVH service +#### List TCP farms attached to a OVHcloud Load Balancer service > [!faq] > @@ -1416,7 +1405,7 @@ Access the elements related to the TCP protocol (Frontend, Farm, etc.). >> >> The name of your zone, ex: all (String of characters) > -#### Add a new TCP farm to a Load Balancer OVH service +#### Add a new TCP farm to a OVHcloud Load Balancer service > [!faq] > @@ -1809,7 +1798,7 @@ Access the elements related to the TCP protocol (Frontend, Farm, etc.). ### Frontends TCP -#### List TCP frontends attached to a Load Balancer OVH service +#### List TCP frontends attached to a OVHcloud Load Balancer service > [!faq] > @@ -1840,7 +1829,7 @@ Access the elements related to the TCP protocol (Frontend, Farm, etc.). >> >> The name of your zone, ex: all (String of characters) > -#### Add a TCP frontend to a Load Balancer OVH service +#### Add a TCP frontend to a OVHcloud Load Balancer service > [!faq] > @@ -1993,7 +1982,7 @@ Access the elements related to the TCP protocol (Frontend, Farm, etc.). ### Routes TCP Routes are evaluated one by one, testing their routing rules. The first route validating all its rules sees its action executed, and stops the evaluation of the remaining routes. The order of execution is defined by the type and weight of the route. -#### List TCP routes attached to a Load Balancer OVH service +#### List TCP routes attached to a OVHcloud Load Balancer service > [!faq] > @@ -2016,7 +2005,7 @@ Routes are evaluated one by one, testing their routing rules. The first route va >> >> The identifier of a TCP frontend (Number) > -#### Add a new TCP route to a Load Balancer OVH service +#### Add a new TCP route to a OVHcloud Load Balancer service > [!faq] > @@ -2330,7 +2319,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). ### UDP Farms -#### List UDP trusses attached to a Load Balancer OVH service +#### List UDP trusses attached to a OVHcloud Load Balancer service > [!faq] > @@ -2353,7 +2342,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). >> >> The name of your zone, ex: all (String of characters) > -#### Add a new UDP farm to a Load Balancer OVH service +#### Add a new UDP farm to a OVHcloud Load Balancer service > [!faq] > @@ -2632,7 +2621,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). ### Frontends UDP -#### List UDP frontends attached to a Load Balancer OVH service +#### List UDP frontends attached to a OVHcloud Load Balancer service > [!faq] > @@ -2663,7 +2652,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). >> >> The name of your zone, ex: all (String of characters) > -#### Add a UDP frontend to a Load Balancer OVH service +#### Add a UDP frontend to a OVHcloud Load Balancer service > [!faq] > @@ -2793,7 +2782,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). ### Additional IP -#### List Additional IPs routed on a Load Balancer OVH service +#### List Additional IPs routed on a OVHcloud Load Balancer service > [!faq] > @@ -2814,7 +2803,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). ### Service Status -#### Obtenir l'état des instances d'un service Load Balancer OVH +#### Obtenir l'état des instances d'un service OVHcloud Load Balancer > [!faq] > @@ -2852,7 +2841,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). >> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters) > -#### Apply changes to a Load Balancer OVH service +#### Apply changes to a OVHcloud Load Balancer service > [!faq] > @@ -2873,7 +2862,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). ### SSL Certificates -#### List SSL certificates of a Load Balancer OVH service +#### List SSL certificates of a OVHcloud Load Balancer service > [!faq] > @@ -2983,7 +2972,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). ### Tasks -#### List current tasks for a Load Balancer OVH service +#### List current tasks for a OVHcloud Load Balancer service > [!faq] > diff --git a/pages/network/load_balancer/use_api_details/guide.en-gb.md b/pages/network/load_balancer/use_api_details/guide.en-gb.md index d90a129d77b..0bd400381f1 100644 --- a/pages/network/load_balancer/use_api_details/guide.en-gb.md +++ b/pages/network/load_balancer/use_api_details/guide.en-gb.md @@ -1,49 +1,38 @@ --- title: Details of API functions excerpt: Details of API functionalities -updated: 2022-04-04 +updated: 2025-09-29 --- ## Objective -Description of the different input points in the API for the Load Balancer OVH. +This guide provides a detailed description of all API functions for the OVHcloud Load Balancer. ## Prerequisite -## In Practice +- Consult the guide [First steps with the OVHcloud APIs](/pages/manage_and_operate/api/first-steps) to familiarize yourself with the use of OVHcloud APIv6. -### Manage your Load Balancer OVH service via the API +## Instructions -Details of the API functionality for the Load Balancer OVH +### Manage your OVHcloud Load Balancer service via the API -- All API calls are made in the section */ipLoadbalancing* available here : [https://api.ovh.com/console/#/ipLoadbalancing](https://api.ovh.com/console/#/ipLoadbalancing). - -> [!warning] -> -> Caution, for compatibility reasons, the entry point of the former -> system Load Balancer OVH is always present in the API /ip/loadBalancing, -> not to be confused with the new /ipLoadbalancing. -> +All API calls that are made in the section */ipLoadbalancing* are available on [this page](/links/console). > [!primary] > -> In the calls below all fields marked with an asterisk * -> are mandatory. +> In the calls below all fields marked with an asterisk `*` are mandatory. > > [!primary] > -> The Frontend, Farm and Server are specific to the -> protocol (among HTTP, TCP or UDP) in which they are defined. -> Although they can be "combined" with each other, this is only possible within -> of the same protocol. Thus, it is not possible to use a Frontend -> UDP with an HTTP Farm. But it is possible (in the absence of other -> limitation) to use an HTTP Frontend with an HTTP Farm. +> The Frontends, Farms and Servers are specific to the protocol (HTTP, TCP or UDP) in which they are defined. +> Compatibility between these components is only possible within the same protocol. +> For example, an HTTP Frontend can only be paired with an HTTP Farm, and cannot be used with a UDP Farm. > ## Services and zones -### Load Balancer OVH +### OVHcloud Load Balancer #### List active services @@ -52,14 +41,14 @@ Details of the API functionality for the Load Balancer OVH > @api {v1} /ipLoadbalancing GET /ipLoadbalancing > -#### List the zones available for the Load Balancer OVH +#### List the zones available for the OVHcloud Load Balancer > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/availableZones > -#### Return details of a Load Balancer OVH service +#### Return details of a OVHcloud Load Balancer service > [!faq] > @@ -75,7 +64,7 @@ Details of the API functionality for the Load Balancer OVH >> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters) > -#### Modify a Load Balancer OVH service +#### Modify a OVHcloud Load Balancer service > [!faq] > @@ -104,7 +93,7 @@ Details of the API functionality for the Load Balancer OVH >> >> > The SSL configuration you want to assign to the service (Value) > -#### List the services attached to the Load Balancer OVH +#### List the services attached to the OVHcloud Load Balancer > [!faq] > @@ -146,7 +135,7 @@ Details of the API functionality for the Load Balancer OVH >> >> Allows filtering according to the vrack network > -#### List the areas that can be attached to a Load Balancer OVH service +#### List the areas that can be attached to a OVHcloud Load Balancer service > [!faq] > @@ -320,7 +309,7 @@ Details of the API functionality for the Load Balancer OVH ### Zones -#### List active zones for a Load Balancer OVH service +#### List active zones for a OVHcloud Load Balancer service > [!faq] > @@ -416,7 +405,7 @@ Accessing HTTP protocol related elements (Frontend, Firmware, etc.). ### HTTP farms -#### List HTTP farms attached to a Load Balancer OVH service +#### List HTTP farms attached to a OVHcloud Load Balancer service > [!faq] > @@ -439,7 +428,7 @@ Accessing HTTP protocol related elements (Frontend, Firmware, etc.). >> >> The name of the zone (String of characters) > -#### Adding a new HTTP farm to a Load Balancer OVH service +#### Adding a new HTTP farm to a OVHcloud Load Balancer service > [!faq] > @@ -840,7 +829,7 @@ Accessing HTTP protocol related elements (Frontend, Firmware, etc.). ### Frontends HTTP -#### List HTTP frontends attached to a Load Balancer OVH service +#### List HTTP frontends attached to a OVHcloud Load Balancer service > [!faq] > @@ -871,7 +860,7 @@ Accessing HTTP protocol related elements (Frontend, Firmware, etc.). >> >> The name of your zone, ex: all (String of characters) > -#### Add an HTTP frontend to a Load Balancer OVH service +#### Add an HTTP frontend to a OVHcloud Load Balancer service > [!faq] > @@ -1071,7 +1060,7 @@ Routes are evaluated one by one, testing their routing rules. The first route va >> >> The identifier of an HTTP frontend (Number) > -#### Add a new HTTP route to a Load Balancer OVH service +#### Add a new HTTP route to a OVHcloud Load Balancer service > [!faq] > @@ -1393,7 +1382,7 @@ Access the elements related to the TCP protocol (Frontend, Farm, etc.). ### TCP Farms -#### List TCP farms attached to a Load Balancer OVH service +#### List TCP farms attached to a OVHcloud Load Balancer service > [!faq] > @@ -1416,7 +1405,7 @@ Access the elements related to the TCP protocol (Frontend, Farm, etc.). >> >> The name of your zone, ex: all (String of characters) > -#### Add a new TCP farm to a Load Balancer OVH service +#### Add a new TCP farm to a OVHcloud Load Balancer service > [!faq] > @@ -1809,7 +1798,7 @@ Access the elements related to the TCP protocol (Frontend, Farm, etc.). ### Frontends TCP -#### List TCP frontends attached to a Load Balancer OVH service +#### List TCP frontends attached to a OVHcloud Load Balancer service > [!faq] > @@ -1840,7 +1829,7 @@ Access the elements related to the TCP protocol (Frontend, Farm, etc.). >> >> The name of your zone, ex: all (String of characters) > -#### Add a TCP frontend to a Load Balancer OVH service +#### Add a TCP frontend to a OVHcloud Load Balancer service > [!faq] > @@ -1993,7 +1982,7 @@ Access the elements related to the TCP protocol (Frontend, Farm, etc.). ### Routes TCP Routes are evaluated one by one, testing their routing rules. The first route validating all its rules sees its action executed, and stops the evaluation of the remaining routes. The order of execution is defined by the type and weight of the route. -#### List TCP routes attached to a Load Balancer OVH service +#### List TCP routes attached to a OVHcloud Load Balancer service > [!faq] > @@ -2016,7 +2005,7 @@ Routes are evaluated one by one, testing their routing rules. The first route va >> >> The identifier of a TCP frontend (Number) > -#### Add a new TCP route to a Load Balancer OVH service +#### Add a new TCP route to a OVHcloud Load Balancer service > [!faq] > @@ -2330,7 +2319,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). ### UDP Farms -#### List UDP trusses attached to a Load Balancer OVH service +#### List UDP trusses attached to a OVHcloud Load Balancer service > [!faq] > @@ -2353,7 +2342,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). >> >> The name of your zone, ex: all (String of characters) > -#### Add a new UDP farm to a Load Balancer OVH service +#### Add a new UDP farm to a OVHcloud Load Balancer service > [!faq] > @@ -2632,7 +2621,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). ### Frontends UDP -#### List UDP frontends attached to a Load Balancer OVH service +#### List UDP frontends attached to a OVHcloud Load Balancer service > [!faq] > @@ -2663,7 +2652,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). >> >> The name of your zone, ex: all (String of characters) > -#### Add a UDP frontend to a Load Balancer OVH service +#### Add a UDP frontend to a OVHcloud Load Balancer service > [!faq] > @@ -2793,7 +2782,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). ### Additional IP -#### List Additional IPs routed on a Load Balancer OVH service +#### List Additional IPs routed on a OVHcloud Load Balancer service > [!faq] > @@ -2814,7 +2803,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). ### Service Status -#### Obtenir l'état des instances d'un service Load Balancer OVH +#### Obtenir l'état des instances d'un service OVHcloud Load Balancer > [!faq] > @@ -2852,7 +2841,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). >> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters) > -#### Apply changes to a Load Balancer OVH service +#### Apply changes to a OVHcloud Load Balancer service > [!faq] > @@ -2873,7 +2862,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). ### SSL Certificates -#### List SSL certificates of a Load Balancer OVH service +#### List SSL certificates of a OVHcloud Load Balancer service > [!faq] > @@ -2983,7 +2972,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). ### Tasks -#### List current tasks for a Load Balancer OVH service +#### List current tasks for a OVHcloud Load Balancer service > [!faq] > diff --git a/pages/network/load_balancer/use_api_details/guide.en-sg.md b/pages/network/load_balancer/use_api_details/guide.en-sg.md index d02d2004668..0bd400381f1 100644 --- a/pages/network/load_balancer/use_api_details/guide.en-sg.md +++ b/pages/network/load_balancer/use_api_details/guide.en-sg.md @@ -1,49 +1,38 @@ --- title: Details of API functions excerpt: Details of API functionalities -updated: 2022-04-04 +updated: 2025-09-29 --- ## Objective -Description of the different input points in the API for the Load Balancer OVH. +This guide provides a detailed description of all API functions for the OVHcloud Load Balancer. ## Prerequisite -## In Practice +- Consult the guide [First steps with the OVHcloud APIs](/pages/manage_and_operate/api/first-steps) to familiarize yourself with the use of OVHcloud APIv6. -### Manage your Load Balancer OVH service via the API +## Instructions -Details of the API functionality for the Load Balancer OVH +### Manage your OVHcloud Load Balancer service via the API -- All API calls are made in the section */ipLoadbalancing* available here : [https://ca.api.ovh.com/console/#/ipLoadbalancing](https://ca.api.ovh.com/console/#/ipLoadbalancing). - -> [!warning] -> -> Caution, for compatibility reasons, the entry point of the former -> system Load Balancer OVH is always present in the API /ip/loadBalancing, -> not to be confused with the new /ipLoadbalancing. -> +All API calls that are made in the section */ipLoadbalancing* are available on [this page](/links/console). > [!primary] > -> In the calls below all fields marked with an asterisk * -> are mandatory. +> In the calls below all fields marked with an asterisk `*` are mandatory. > > [!primary] > -> The Frontend, Farm and Server are specific to the -> protocol (among HTTP, TCP or UDP) in which they are defined. -> Although they can be "combined" with each other, this is only possible within -> of the same protocol. Thus, it is not possible to use a Frontend -> UDP with an HTTP Farm. But it is possible (in the absence of other -> limitation) to use an HTTP Frontend with an HTTP Farm. +> The Frontends, Farms and Servers are specific to the protocol (HTTP, TCP or UDP) in which they are defined. +> Compatibility between these components is only possible within the same protocol. +> For example, an HTTP Frontend can only be paired with an HTTP Farm, and cannot be used with a UDP Farm. > ## Services and zones -### Load Balancer OVH +### OVHcloud Load Balancer #### List active services @@ -52,14 +41,14 @@ Details of the API functionality for the Load Balancer OVH > @api {v1} /ipLoadbalancing GET /ipLoadbalancing > -#### List the zones available for the Load Balancer OVH +#### List the zones available for the OVHcloud Load Balancer > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/availableZones > -#### Return details of a Load Balancer OVH service +#### Return details of a OVHcloud Load Balancer service > [!faq] > @@ -75,7 +64,7 @@ Details of the API functionality for the Load Balancer OVH >> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters) > -#### Modify a Load Balancer OVH service +#### Modify a OVHcloud Load Balancer service > [!faq] > @@ -104,7 +93,7 @@ Details of the API functionality for the Load Balancer OVH >> >> > The SSL configuration you want to assign to the service (Value) > -#### List the services attached to the Load Balancer OVH +#### List the services attached to the OVHcloud Load Balancer > [!faq] > @@ -146,7 +135,7 @@ Details of the API functionality for the Load Balancer OVH >> >> Allows filtering according to the vrack network > -#### List the areas that can be attached to a Load Balancer OVH service +#### List the areas that can be attached to a OVHcloud Load Balancer service > [!faq] > @@ -320,7 +309,7 @@ Details of the API functionality for the Load Balancer OVH ### Zones -#### List active zones for a Load Balancer OVH service +#### List active zones for a OVHcloud Load Balancer service > [!faq] > @@ -416,7 +405,7 @@ Accessing HTTP protocol related elements (Frontend, Firmware, etc.). ### HTTP farms -#### List HTTP farms attached to a Load Balancer OVH service +#### List HTTP farms attached to a OVHcloud Load Balancer service > [!faq] > @@ -439,7 +428,7 @@ Accessing HTTP protocol related elements (Frontend, Firmware, etc.). >> >> The name of the zone (String of characters) > -#### Adding a new HTTP farm to a Load Balancer OVH service +#### Adding a new HTTP farm to a OVHcloud Load Balancer service > [!faq] > @@ -840,7 +829,7 @@ Accessing HTTP protocol related elements (Frontend, Firmware, etc.). ### Frontends HTTP -#### List HTTP frontends attached to a Load Balancer OVH service +#### List HTTP frontends attached to a OVHcloud Load Balancer service > [!faq] > @@ -871,7 +860,7 @@ Accessing HTTP protocol related elements (Frontend, Firmware, etc.). >> >> The name of your zone, ex: all (String of characters) > -#### Add an HTTP frontend to a Load Balancer OVH service +#### Add an HTTP frontend to a OVHcloud Load Balancer service > [!faq] > @@ -1071,7 +1060,7 @@ Routes are evaluated one by one, testing their routing rules. The first route va >> >> The identifier of an HTTP frontend (Number) > -#### Add a new HTTP route to a Load Balancer OVH service +#### Add a new HTTP route to a OVHcloud Load Balancer service > [!faq] > @@ -1393,7 +1382,7 @@ Access the elements related to the TCP protocol (Frontend, Farm, etc.). ### TCP Farms -#### List TCP farms attached to a Load Balancer OVH service +#### List TCP farms attached to a OVHcloud Load Balancer service > [!faq] > @@ -1416,7 +1405,7 @@ Access the elements related to the TCP protocol (Frontend, Farm, etc.). >> >> The name of your zone, ex: all (String of characters) > -#### Add a new TCP farm to a Load Balancer OVH service +#### Add a new TCP farm to a OVHcloud Load Balancer service > [!faq] > @@ -1809,7 +1798,7 @@ Access the elements related to the TCP protocol (Frontend, Farm, etc.). ### Frontends TCP -#### List TCP frontends attached to a Load Balancer OVH service +#### List TCP frontends attached to a OVHcloud Load Balancer service > [!faq] > @@ -1840,7 +1829,7 @@ Access the elements related to the TCP protocol (Frontend, Farm, etc.). >> >> The name of your zone, ex: all (String of characters) > -#### Add a TCP frontend to a Load Balancer OVH service +#### Add a TCP frontend to a OVHcloud Load Balancer service > [!faq] > @@ -1993,7 +1982,7 @@ Access the elements related to the TCP protocol (Frontend, Farm, etc.). ### Routes TCP Routes are evaluated one by one, testing their routing rules. The first route validating all its rules sees its action executed, and stops the evaluation of the remaining routes. The order of execution is defined by the type and weight of the route. -#### List TCP routes attached to a Load Balancer OVH service +#### List TCP routes attached to a OVHcloud Load Balancer service > [!faq] > @@ -2016,7 +2005,7 @@ Routes are evaluated one by one, testing their routing rules. The first route va >> >> The identifier of a TCP frontend (Number) > -#### Add a new TCP route to a Load Balancer OVH service +#### Add a new TCP route to a OVHcloud Load Balancer service > [!faq] > @@ -2330,7 +2319,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). ### UDP Farms -#### List UDP trusses attached to a Load Balancer OVH service +#### List UDP trusses attached to a OVHcloud Load Balancer service > [!faq] > @@ -2353,7 +2342,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). >> >> The name of your zone, ex: all (String of characters) > -#### Add a new UDP farm to a Load Balancer OVH service +#### Add a new UDP farm to a OVHcloud Load Balancer service > [!faq] > @@ -2632,7 +2621,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). ### Frontends UDP -#### List UDP frontends attached to a Load Balancer OVH service +#### List UDP frontends attached to a OVHcloud Load Balancer service > [!faq] > @@ -2663,7 +2652,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). >> >> The name of your zone, ex: all (String of characters) > -#### Add a UDP frontend to a Load Balancer OVH service +#### Add a UDP frontend to a OVHcloud Load Balancer service > [!faq] > @@ -2793,7 +2782,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). ### Additional IP -#### List Additional IPs routed on a Load Balancer OVH service +#### List Additional IPs routed on a OVHcloud Load Balancer service > [!faq] > @@ -2814,7 +2803,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). ### Service Status -#### Obtenir l'état des instances d'un service Load Balancer OVH +#### Obtenir l'état des instances d'un service OVHcloud Load Balancer > [!faq] > @@ -2852,7 +2841,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). >> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters) > -#### Apply changes to a Load Balancer OVH service +#### Apply changes to a OVHcloud Load Balancer service > [!faq] > @@ -2873,7 +2862,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). ### SSL Certificates -#### List SSL certificates of a Load Balancer OVH service +#### List SSL certificates of a OVHcloud Load Balancer service > [!faq] > @@ -2983,7 +2972,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). ### Tasks -#### List current tasks for a Load Balancer OVH service +#### List current tasks for a OVHcloud Load Balancer service > [!faq] > diff --git a/pages/network/load_balancer/use_api_details/guide.en-us.md b/pages/network/load_balancer/use_api_details/guide.en-us.md index d02d2004668..0bd400381f1 100644 --- a/pages/network/load_balancer/use_api_details/guide.en-us.md +++ b/pages/network/load_balancer/use_api_details/guide.en-us.md @@ -1,49 +1,38 @@ --- title: Details of API functions excerpt: Details of API functionalities -updated: 2022-04-04 +updated: 2025-09-29 --- ## Objective -Description of the different input points in the API for the Load Balancer OVH. +This guide provides a detailed description of all API functions for the OVHcloud Load Balancer. ## Prerequisite -## In Practice +- Consult the guide [First steps with the OVHcloud APIs](/pages/manage_and_operate/api/first-steps) to familiarize yourself with the use of OVHcloud APIv6. -### Manage your Load Balancer OVH service via the API +## Instructions -Details of the API functionality for the Load Balancer OVH +### Manage your OVHcloud Load Balancer service via the API -- All API calls are made in the section */ipLoadbalancing* available here : [https://ca.api.ovh.com/console/#/ipLoadbalancing](https://ca.api.ovh.com/console/#/ipLoadbalancing). - -> [!warning] -> -> Caution, for compatibility reasons, the entry point of the former -> system Load Balancer OVH is always present in the API /ip/loadBalancing, -> not to be confused with the new /ipLoadbalancing. -> +All API calls that are made in the section */ipLoadbalancing* are available on [this page](/links/console). > [!primary] > -> In the calls below all fields marked with an asterisk * -> are mandatory. +> In the calls below all fields marked with an asterisk `*` are mandatory. > > [!primary] > -> The Frontend, Farm and Server are specific to the -> protocol (among HTTP, TCP or UDP) in which they are defined. -> Although they can be "combined" with each other, this is only possible within -> of the same protocol. Thus, it is not possible to use a Frontend -> UDP with an HTTP Farm. But it is possible (in the absence of other -> limitation) to use an HTTP Frontend with an HTTP Farm. +> The Frontends, Farms and Servers are specific to the protocol (HTTP, TCP or UDP) in which they are defined. +> Compatibility between these components is only possible within the same protocol. +> For example, an HTTP Frontend can only be paired with an HTTP Farm, and cannot be used with a UDP Farm. > ## Services and zones -### Load Balancer OVH +### OVHcloud Load Balancer #### List active services @@ -52,14 +41,14 @@ Details of the API functionality for the Load Balancer OVH > @api {v1} /ipLoadbalancing GET /ipLoadbalancing > -#### List the zones available for the Load Balancer OVH +#### List the zones available for the OVHcloud Load Balancer > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/availableZones > -#### Return details of a Load Balancer OVH service +#### Return details of a OVHcloud Load Balancer service > [!faq] > @@ -75,7 +64,7 @@ Details of the API functionality for the Load Balancer OVH >> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters) > -#### Modify a Load Balancer OVH service +#### Modify a OVHcloud Load Balancer service > [!faq] > @@ -104,7 +93,7 @@ Details of the API functionality for the Load Balancer OVH >> >> > The SSL configuration you want to assign to the service (Value) > -#### List the services attached to the Load Balancer OVH +#### List the services attached to the OVHcloud Load Balancer > [!faq] > @@ -146,7 +135,7 @@ Details of the API functionality for the Load Balancer OVH >> >> Allows filtering according to the vrack network > -#### List the areas that can be attached to a Load Balancer OVH service +#### List the areas that can be attached to a OVHcloud Load Balancer service > [!faq] > @@ -320,7 +309,7 @@ Details of the API functionality for the Load Balancer OVH ### Zones -#### List active zones for a Load Balancer OVH service +#### List active zones for a OVHcloud Load Balancer service > [!faq] > @@ -416,7 +405,7 @@ Accessing HTTP protocol related elements (Frontend, Firmware, etc.). ### HTTP farms -#### List HTTP farms attached to a Load Balancer OVH service +#### List HTTP farms attached to a OVHcloud Load Balancer service > [!faq] > @@ -439,7 +428,7 @@ Accessing HTTP protocol related elements (Frontend, Firmware, etc.). >> >> The name of the zone (String of characters) > -#### Adding a new HTTP farm to a Load Balancer OVH service +#### Adding a new HTTP farm to a OVHcloud Load Balancer service > [!faq] > @@ -840,7 +829,7 @@ Accessing HTTP protocol related elements (Frontend, Firmware, etc.). ### Frontends HTTP -#### List HTTP frontends attached to a Load Balancer OVH service +#### List HTTP frontends attached to a OVHcloud Load Balancer service > [!faq] > @@ -871,7 +860,7 @@ Accessing HTTP protocol related elements (Frontend, Firmware, etc.). >> >> The name of your zone, ex: all (String of characters) > -#### Add an HTTP frontend to a Load Balancer OVH service +#### Add an HTTP frontend to a OVHcloud Load Balancer service > [!faq] > @@ -1071,7 +1060,7 @@ Routes are evaluated one by one, testing their routing rules. The first route va >> >> The identifier of an HTTP frontend (Number) > -#### Add a new HTTP route to a Load Balancer OVH service +#### Add a new HTTP route to a OVHcloud Load Balancer service > [!faq] > @@ -1393,7 +1382,7 @@ Access the elements related to the TCP protocol (Frontend, Farm, etc.). ### TCP Farms -#### List TCP farms attached to a Load Balancer OVH service +#### List TCP farms attached to a OVHcloud Load Balancer service > [!faq] > @@ -1416,7 +1405,7 @@ Access the elements related to the TCP protocol (Frontend, Farm, etc.). >> >> The name of your zone, ex: all (String of characters) > -#### Add a new TCP farm to a Load Balancer OVH service +#### Add a new TCP farm to a OVHcloud Load Balancer service > [!faq] > @@ -1809,7 +1798,7 @@ Access the elements related to the TCP protocol (Frontend, Farm, etc.). ### Frontends TCP -#### List TCP frontends attached to a Load Balancer OVH service +#### List TCP frontends attached to a OVHcloud Load Balancer service > [!faq] > @@ -1840,7 +1829,7 @@ Access the elements related to the TCP protocol (Frontend, Farm, etc.). >> >> The name of your zone, ex: all (String of characters) > -#### Add a TCP frontend to a Load Balancer OVH service +#### Add a TCP frontend to a OVHcloud Load Balancer service > [!faq] > @@ -1993,7 +1982,7 @@ Access the elements related to the TCP protocol (Frontend, Farm, etc.). ### Routes TCP Routes are evaluated one by one, testing their routing rules. The first route validating all its rules sees its action executed, and stops the evaluation of the remaining routes. The order of execution is defined by the type and weight of the route. -#### List TCP routes attached to a Load Balancer OVH service +#### List TCP routes attached to a OVHcloud Load Balancer service > [!faq] > @@ -2016,7 +2005,7 @@ Routes are evaluated one by one, testing their routing rules. The first route va >> >> The identifier of a TCP frontend (Number) > -#### Add a new TCP route to a Load Balancer OVH service +#### Add a new TCP route to a OVHcloud Load Balancer service > [!faq] > @@ -2330,7 +2319,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). ### UDP Farms -#### List UDP trusses attached to a Load Balancer OVH service +#### List UDP trusses attached to a OVHcloud Load Balancer service > [!faq] > @@ -2353,7 +2342,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). >> >> The name of your zone, ex: all (String of characters) > -#### Add a new UDP farm to a Load Balancer OVH service +#### Add a new UDP farm to a OVHcloud Load Balancer service > [!faq] > @@ -2632,7 +2621,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). ### Frontends UDP -#### List UDP frontends attached to a Load Balancer OVH service +#### List UDP frontends attached to a OVHcloud Load Balancer service > [!faq] > @@ -2663,7 +2652,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). >> >> The name of your zone, ex: all (String of characters) > -#### Add a UDP frontend to a Load Balancer OVH service +#### Add a UDP frontend to a OVHcloud Load Balancer service > [!faq] > @@ -2793,7 +2782,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). ### Additional IP -#### List Additional IPs routed on a Load Balancer OVH service +#### List Additional IPs routed on a OVHcloud Load Balancer service > [!faq] > @@ -2814,7 +2803,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). ### Service Status -#### Obtenir l'état des instances d'un service Load Balancer OVH +#### Obtenir l'état des instances d'un service OVHcloud Load Balancer > [!faq] > @@ -2852,7 +2841,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). >> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters) > -#### Apply changes to a Load Balancer OVH service +#### Apply changes to a OVHcloud Load Balancer service > [!faq] > @@ -2873,7 +2862,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). ### SSL Certificates -#### List SSL certificates of a Load Balancer OVH service +#### List SSL certificates of a OVHcloud Load Balancer service > [!faq] > @@ -2983,7 +2972,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.). ### Tasks -#### List current tasks for a Load Balancer OVH service +#### List current tasks for a OVHcloud Load Balancer service > [!faq] > diff --git a/pages/network/load_balancer/use_api_details/guide.fr-ca.md b/pages/network/load_balancer/use_api_details/guide.fr-ca.md index a0ccab5b8d4..d8d1fa7f747 100644 --- a/pages/network/load_balancer/use_api_details/guide.fr-ca.md +++ b/pages/network/load_balancer/use_api_details/guide.fr-ca.md @@ -1,49 +1,38 @@ --- title: Détails des fonctions API excerpt: Détails des fonctionnalités de l’API -updated: 2022-04-04 +updated: 2025-09-29 --- ## Objectif -Description des différents points d'entrées dans l'API pour le Load Balancer OVHcloud. +Ce guide fournit une description détaillée de toutes les fonctions de l'API pour le Load Balancer OVHcloud. ## Prérequis -## En pratique - -### Gérer son service Load Balancer OVH via l'API +- Consulter le guide [Premiers pas avec les API OVHcloud](/pages/manage_and_operate/api/first-steps) pour vous familiariser avec l'utilisation des APIv6 OVHcloud. -Détails des fonctionnalités de l'API pour le Load Balancer OVHcloud. +## En pratique -- Tous les appels API se font dans la section */ipLoadbalancing* disponible ici : [https://ca.api.ovh.com/console/#/ipLoadbalancing](https://ca.api.ovh.com/console/#/ipLoadbalancing). +### Gérer son service OVHcloud Load Balancer via l'API -> [!warning] -> -> Attention, pour des raisons de compatibilité, le point d'entrée de l'ancien -> système Load Balancer OVH est toujours présent dans l'API /ip/loadBalancing, -> à ne pas confondre avec le nouveau /ipLoadbalancing. -> +Toutes les fonctions d'API qui sont utilisées dans la section */ipLoadbalancing* sont disponibles sur [cette page](/links/console). > [!primary] > -> Dans les appels ci-dessous tous les champs marqués d'une astérisque * -> sont obligatoires. +> Dans les appels ci-dessous, tous les champs marqués d'une astérisque `*` sont obligatoires. > > [!primary] > -> Les Frontend, Ferme et Serveur sont spécifiques au -> protocole (parmis HTTP, TCP ou UDP) dans lequel ils sont définis. -> Bien qu'ils puissent être "combinés" entre eux, ce n'est possible qu'au sein -> d'un même protocole. Ainsi, il n'est pas possible d'utiliser un Frontend -> UDP avec une Ferme HTTP. Mais il est possible (en l'absence d'autre -> limitation) d'utiliser un Frontend HTTP avec une Ferme HTTP. +> Les frontends, fermes et serveurs sont spécifiques au protocole (HTTP, TCP ou UDP) dans lequel ils sont définies. +> La compatibilité entre ces composants n'est possible qu'au sein du même protocole. +> Par exemple, un frontend HTTP ne peut être associé qu'à une ferme HTTP, et ne peut pas être utilisé avec une ferme UDP. > ## Services et zones -### Load Balancer OVH +### Load Balancer OVHcloud #### Lister les services actifs @@ -52,14 +41,14 @@ Détails des fonctionnalités de l'API pour le Load Balancer OVHcloud. > @api {v1} /ipLoadbalancing GET /ipLoadbalancing > -#### Lister les zones disponibles pour le Load Balancer OVH +#### Lister les zones disponibles pour le Load Balancer OVHcloud > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/availableZones > -#### Retourner les détails d'un service Load Balancer OVH +#### Retourner les détails d'un service Load Balancer OVHcloud > [!faq] > @@ -72,10 +61,10 @@ Détails des fonctionnalités de l'API pour le Load Balancer OVHcloud. >> >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères) > -#### Modifier un service Load Balancer OVH +#### Modifier un service Load Balancer OVHcloud > [!faq] > @@ -91,20 +80,20 @@ Détails des fonctionnalités de l'API pour le Load Balancer OVHcloud. > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères) >> > >> > **Ip** * >> > >> >> **displayName** >> >> > ->> >> > Le nom que vous souhaitez attribuer au service (Chaîne de caractères) +>> >> > Le nom que vous souhaitez attribuer au service (chaîne de caractères) >> > >> >> **sslConfiguration** >> >> ->> >> > La configuration SSL que vous souhaitez attribuer au service (Valeur) +>> >> > La configuration SSL que vous souhaitez attribuer au service (valeur) > -#### Lister les services attachés au Load Balancer OVH +#### Lister les services attachés au Load Balancer OVHcloud > [!faq] > @@ -120,7 +109,7 @@ Détails des fonctionnalités de l'API pour le Load Balancer OVHcloud. > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères) > #### Lister les fermes existantes et leur type @@ -139,14 +128,14 @@ Détails des fonctionnalités de l'API pour le Load Balancer OVHcloud. > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères) >> > >> > **vrackNetworkId** >> > >> >> Permet de filtrer selon le réseau vrack > -#### Lister les zones pouvant être attachées à un service Load Balancer OVH +#### Lister les zones pouvant être attachées à un service Load Balancer OVHcloud > [!faq] > @@ -162,7 +151,7 @@ Détails des fonctionnalités de l'API pour le Load Balancer OVHcloud. > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères) > #### Lister les différentes sondes pouvant être utilisées @@ -181,7 +170,7 @@ Détails des fonctionnalités de l'API pour le Load Balancer OVHcloud. > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères) > #### Lister les différents types de fermes pouvant être utilisées @@ -200,7 +189,7 @@ Détails des fonctionnalités de l'API pour le Load Balancer OVHcloud. > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères) > #### Lister les différents types de frontends pouvant être utilisés @@ -219,10 +208,10 @@ Détails des fonctionnalités de l'API pour le Load Balancer OVHcloud. > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères) > -#### Lister les différents types d'actions de routage pouvant etre utilisées +#### Lister les différents types d'actions de routage pouvant etre utilisés > [!faq] > @@ -238,7 +227,7 @@ Détails des fonctionnalités de l'API pour le Load Balancer OVHcloud. > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères) > #### Lister les différents types de règles de routage pouvant être utilisés @@ -257,7 +246,7 @@ Détails des fonctionnalités de l'API pour le Load Balancer OVHcloud. > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères) > ### Service @@ -278,7 +267,7 @@ Détails des fonctionnalités de l'API pour le Load Balancer OVHcloud. > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères) > #### Modifier les informations du service @@ -297,30 +286,30 @@ Détails des fonctionnalités de l'API pour le Load Balancer OVHcloud. > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères) >> > >> > **Service** * >> > >> >> - **automatic** >> >> > ->> >> > Active le renouvellement automatique du service (Booléen)) +>> >> > Active le renouvellement automatique du service (booléen)) >> >> >> >> - **deleteAtExpiration** >> >> > ->> >> > Active la suppression du service lors de l'expiration (Booléen) +>> >> > Active la suppression du service lors de l'expiration (booléen) >> >> >> >> - **forced** >> >> > ->> >> > Force le renouvellement automatique (Booléen) +>> >> > Force le renouvellement automatique (booléen) >> >> >> >> - **period** >> >> > ->> >> > Renseigne la durée de renouvellement (Chaîne de caractères) +>> >> > Renseigne la durée de renouvellement (chaîne de caractères) > ### Zones -#### Lister les zones actives pour un service Load Balancer OVH +#### Lister les zones actives pour un service Load Balancer OVHcloud > [!faq] > @@ -336,7 +325,7 @@ Détails des fonctionnalités de l'API pour le Load Balancer OVHcloud. > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, ex. : IP-1.2.3.4 (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, ex. : IP-1.2.3.4 (chaîne de caractères) > #### Obtenir les détails d'une zone @@ -355,7 +344,7 @@ Détails des fonctionnalités de l'API pour le Load Balancer OVHcloud. > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **name** * >> > @@ -381,7 +370,7 @@ Le service sera supprimé à la date d'expiration. > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **name** * >> > @@ -404,7 +393,7 @@ Le service sera supprimé à la date d'expiration. > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **name** * >> > @@ -412,11 +401,12 @@ Le service sera supprimé à la date d'expiration. > ## Protocole HTTP -Accéder aux éléments relatifs au protocole HTTP (Frontend, Ferme, etc.). + +Accéder aux éléments relatifs au protocole HTTP (frontend, ferme, etc.). ### Fermes HTTP -#### Lister les fermes HTTP attachées à un service Load Balancer OVH +#### Lister les fermes HTTP attachées à un service Load Balancer OVHcloud > [!faq] > @@ -432,14 +422,14 @@ Accéder aux éléments relatifs au protocole HTTP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **zone** >> > ->> >> Le nom de la zone (Chaîne de caractères) +>> >> Le nom de la zone (chaîne de caractères) > -#### Ajouter une nouvelle ferme HTTP à un service Load Balancer OVH +#### Ajouter une nouvelle ferme HTTP à un service Load Balancer OVHcloud > [!faq] > @@ -455,39 +445,39 @@ Accéder aux éléments relatifs au protocole HTTP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **zone** * >> > ->> >> Le nom de la zone (Chaîne de caractères) +>> >> Le nom de la zone (chaîne de caractères) >> > >> > **displayName** >> > ->> >> le nom que vous souhaitez attribuer à votre ferme (Chaîne de caractères) +>> >> le nom que vous souhaitez attribuer à votre ferme (chaîne de caractères) >> > >> > **balance** >> >> ->> >> La méthode de répartition de charge de votre ferme (Valeur) +>> >> La méthode de répartition de charge de votre ferme (valeur) >> > >> > **port** >> > ->> >> Le port d'écoute de votre ferme. Hérité du frontend si non défini (Nombre, 1..65535) +>> >> Le port d'écoute de votre ferme. Hérité du frontend si non-défini (nombre, 1..65535) >> > >> > **stickiness** >> > ->> >> Le type de persistence de connexion à utiliser pour votre ferme (Valeur) +>> >> Le type de persistence de connexion à utiliser pour votre ferme (valeur) >> > >> > **probe** >> > ->> >> Le type de sonde à utiliser sur votre ferme (Sonde HTTP) +>> >> Le type de sonde à utiliser sur votre ferme (sonde HTTP) >> >> > >> >> > - **forceSsl** >> >> > ->> >> >> L'activation du SSL est forcée pour la sonde (Booléen) +>> >> >> L'activation du SSL est forcée pour la sonde (booléen) >> >> > >> >> > - **interval** >> >> > ->> >> >> L'intervalle en secondes entre chaque test de la sonde. Doit être supérieur à 30. 30 par défaut (Nombre) +>> >> >> L'intervalle en secondes entre chaque test de la sonde. Doit être supérieur à 30. 30 par défaut (nombre) >> >> > >> >> > - **match** >> >> > @@ -495,7 +485,7 @@ Accéder aux éléments relatifs au protocole HTTP (Frontend, Ferme, etc.). >> >> > >> >> > - **negate** >> >> > ->> >> >> Le comportement de l'opérateur 'match' est inversé (Booléen) +>> >> >> Le comportement de l'opérateur 'match' est inversé (booléen) >> >> > >> >> > - **method** >> >> > @@ -503,11 +493,11 @@ Accéder aux éléments relatifs au protocole HTTP (Frontend, Ferme, etc.). >> >> > >> >> > - **pattern** >> >> > ->> >> >> Le format de la réponse du serveur quand "UP". Vide pour 'default', liste de status séparés par des virgules pour 'status', texte pour 'contains', expression régulière pour 'matches' (Chaîne de caractères) +>> >> >> Le format de la réponse du serveur quand "UP". Vide pour 'default', liste de statuts séparés par des virgules pour 'status', texte pour 'contains', expression régulière pour 'matches' (chaîne de caractères) >> >> > >> >> > - **port** >> >> > ->> >> >> Le port que la sonde doit utiliser pour tester les serveurs attachés à votre ferme. Ignoré pour les sondes 'oco'. Si non défini, le port de la ferme est utilisé (Nombre) +>> >> >> Le port que la sonde doit utiliser pour tester les serveurs attachés à votre ferme. Ignoré pour les sondes 'oco'. Si non-défini, le port de la ferme est utilisé (nombre) >> >> > >> >> > - **type** >> >> > @@ -515,7 +505,7 @@ Accéder aux éléments relatifs au protocole HTTP (Frontend, Ferme, etc.). >> >> > >> >> > - **url** >> >> > ->> >> >> L'adresse à utiliser par la sonde pour les sondes de type HTTP. Le type est ignoré si ce paramètre est définit (Chaîne de caractères) +>> >> >> L'adresse à utiliser par la sonde pour les sondes de type HTTP. Le type est ignoré si ce paramètre est défini (chaîne de caractères) > #### Obtenir les détails d'une ferme HTTP @@ -534,11 +524,11 @@ Accéder aux éléments relatifs au protocole HTTP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **farmId** * >> > ->> >> L'identifiant de votre ferme HTTP (Nombre) +>> >> L'identifiant de votre ferme HTTP (nombre) > #### Modifier les propriétés d'une ferme HTTP @@ -557,33 +547,33 @@ Accéder aux éléments relatifs au protocole HTTP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **farmId** * >> > ->> >> L'identifiant de votre ferme HTTP (Nombre) +>> >> L'identifiant de votre ferme HTTP (nombre) >> > >> > **BackendHttp** * >> > >> >> - **displayName** >> >> > ->> >> > Le nom de la ferme (Chaîne de caractères) +>> >> > Le nom de la ferme (chaîne de caractères) >> >> >> >> - **balance** >> >> > ->> >> > Le type de répartition de charge (Valeur) +>> >> > Le type de répartition de charge (valeur) >> >> >> >> - **port** >> >> > ->> >> > Le port d'écoute de la ferme (Nombre, 1..65000) +>> >> > Le port d'écoute de la ferme (nombre, 1..65000) >> >> >> >> - **probe** >> >> > ->> >> > Le type de sonde à utiliser (Sonde HTTP) +>> >> > Le type de sonde à utiliser (sonde HTTP) >> >> >> >> - **stickiness** >> >> > ->> >> > Le type de persistence de connexion (Valeur) +>> >> > Le type de persistence de connexion (valeur) > #### Supprimer une ferme HTTP @@ -602,11 +592,11 @@ Accéder aux éléments relatifs au protocole HTTP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **farmId** * >> > ->> >> L'identifiant de votre ferme HTTP (Nombre) +>> >> L'identifiant de votre ferme HTTP (nombre) > ### Serveurs HTTP @@ -627,15 +617,15 @@ Accéder aux éléments relatifs au protocole HTTP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **farmId** * >> > ->> >> L'identifiant de votre ferme HTTP (Nombre) +>> >> L'identifiant de votre ferme HTTP (nombre) >> > >> > **cookie** >> > ->> >> Filtrer les valeurs par Cookie (Chaîne de caractères) +>> >> Filtrer les valeurs par cookie (chaîne de caractères) >> > >> > **address** >> > @@ -643,7 +633,7 @@ Accéder aux éléments relatifs au protocole HTTP (Frontend, Ferme, etc.). >> > >> > **status** >> > ->> >> Filtrer les valeurs par statut du serveur (Valeur) +>> >> Filtrer les valeurs par statut du serveur (valeur) > #### Ajouter un serveur à une ferme HTTP @@ -662,11 +652,11 @@ Accéder aux éléments relatifs au protocole HTTP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **farmId** * >> > ->> >> L'identifiant de votre ferme (Nombre) +>> >> L'identifiant de votre ferme (nombre) >> > >> > **address** * >> > @@ -674,44 +664,44 @@ Accéder aux éléments relatifs au protocole HTTP (Frontend, Ferme, etc.). >> > >> > **backup** >> > ->> >> Si votre serveur est configuré comme serveur de secours (Booléen) +>> >> Si votre serveur est configuré comme serveur de secours (booléen) >> > >> > **chain** >> > ->> >> La valeur du certificat SSL intermédiaire (Chaîne de caractères) +>> >> La valeur du certificat SSL intermédiaire (chaîne de caractères) >> > >> > **cookie** >> > ->> >> La valeur de votre Cookie (Chaîne de caractères) +>> >> La valeur de votre cookie (chaîne de caractères) >> > >> > **displayName** >> > ->> >> Le nom donné à votre serveur (Chaîne de caractères) +>> >> Le nom donné à votre serveur (chaîne de caractères) >> > >> > **port** >> > ->> >> Le port d'écoute de votre serveur. Hérité de votre ferme si non défini (Nombre, 1..65535) +>> >> Le port d'écoute de votre serveur. Hérité de votre ferme si non-défini (nombre, 1..65535) >> > >> > **probe** >> > ->> >> Le type de sonde à utiliser (Valeur) +>> >> Le type de sonde à utiliser (valeur) >> > >> > **proxyProtocolVersion** >> > >> >> La version de proxyProtocol à utiliser, ->> >> voir http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt (Valeur) +>> >> voir http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt (valeur) >> > >> > **ssl** * >> > ->> >> Si les requêtes envoyées à vos serveurs doivent être chiffrées avec SSL (Booléen) +>> >> Si les requêtes envoyées à vos serveurs doivent être chiffrées avec SSL (booléen) >> > >> > **weight** * >> > ->> >> Le poids de votre serveur pour votre ferme. Un serveur à poids élevé reçoit plus de requêtes (Nombre) +>> >> Le poids de votre serveur pour votre ferme. Un serveur à poids élevé reçoit plus de requêtes (nombre) >> > >> > **status** * >> > ->> >> Si votre serveur est activé ou non (Booléen) +>> >> Si votre serveur est activé ou non (booléen) > #### Obtenir les détails d'un serveur lié à une ferme HTTP @@ -730,15 +720,15 @@ Accéder aux éléments relatifs au protocole HTTP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **serverId** * >> > ->> >> L'identifiant de votre server (Nombre) +>> >> L'identifiant de votre serveur (nombre) >> > >> > **farmId** * >> > ->> >> L'identifiant de votre ferme (Nombre) +>> >> L'identifiant de votre ferme (nombre) > #### Modifier les propriétés d'un serveur HTTP @@ -757,58 +747,58 @@ Accéder aux éléments relatifs au protocole HTTP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **serverId** * >> > ->> >> L'identifiant de votre server-link (Nombre) +>> >> L'identifiant de votre server-link (nombre) >> > >> > **farmId** * >> > ->> >> L'identifiant de votre ferme (Nombre) +>> >> L'identifiant de votre ferme (nombre) >> > >> > **BackendHttpServer** * >> > >> >> - **backup** >> >> > ->> >> > Si votre serveur est configuré comme serveur de secours (Booléen) +>> >> > Si votre serveur est configuré comme serveur de secours (booléen) >> >> >> >> - **chain** >> >> > ->> >> > La valeur du certificat SSL intermédiaire (Chaîne de caractères) +>> >> > La valeur du certificat SSL intermédiaire (chaîne de caractères) >> >> >> >> - **cookie** >> >> > ->> >> > La valeur de votre Cookie (Chaîne de caractères) +>> >> > La valeur de votre cookie (chaîne de caractères) >> >> >> >> - **displayName** >> >> > ->> >> > Le nom de votre serveur (Chaîne de caractères) +>> >> > Le nom de votre serveur (chaîne de caractères) >> >> >> >> - **port** >> >> > ->> >> > Le port d'écoute de votre serveur (Nombre, 1..65535) +>> >> > Le port d'écoute de votre serveur (nombre, 1..65535) >> >> >> >> - **probe** >> >> > ->> >> > Le type de sonde à utiliser (Valeur) +>> >> > Le type de sonde à utiliser (valeur) >> >> >> >> - **proxyProtocolVersion** >> >> > >> >> > La version de proxyProtocol à utiliser, ->> >> > voir http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt (Valeur) +>> >> > voir http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt (valeur) >> >> >> >> - **ssl** >> >> > ->> >> > Si les requêtes envoyées à vos serveurs doivent être chiffrées avec SSL (Booléen) +>> >> > Si les requêtes envoyées à vos serveurs doivent être chiffrées avec SSL (booléen) >> >> >> >> - **status** >> >> > ->> >> > Si votre serveur est activé ou non (Booléen) +>> >> > Si votre serveur est activé ou non (booléen) >> >> >> >> - **weight** >> >> > ->> >> > Le poids de votre serveur pour votre ferme (Nombre) +>> >> > Le poids de votre serveur pour votre ferme (nombre) > #### Supprimer un serveur d'une ferme HTTP @@ -827,20 +817,20 @@ Accéder aux éléments relatifs au protocole HTTP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **serverId** * >> > ->> >> L'identifiant de votre server (Nombre) +>> >> L'identifiant de votre serveur (nombre) >> > >> > **farmId** * >> > ->> >> L'identifiant de votre ferme (Nombre) +>> >> L'identifiant de votre ferme (nombre) > ### Frontends HTTP -#### Lister les frontends HTTP attachés à un service Load Balancer OVH +#### Lister les frontends HTTP attachés à un service Load Balancer OVHcloud > [!faq] > @@ -856,22 +846,22 @@ Accéder aux éléments relatifs au protocole HTTP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **defaultFarmId** >> > ->> >> L'identifiant de la ferme HTTP à laquelle le frontend HTTP est lié (Nombre) +>> >> L'identifiant de la ferme HTTP à laquelle le frontend HTTP est lié (nombre) >> > >> > **port** >> > ->> >> Le port d'écoute de votre frontend (Nombre, 1..65535) +>> >> Le port d'écoute de votre frontend (nombre, 1..65535) >> > >> > **zone** >> > ->> >> Le nom de votre zone, ex: all (Chaîne de caractères) +>> >> Le nom de votre zone, par exemple: all (chaîne de caractères) > -#### Ajouter un frontend HTTP à un service Load Balancer OVH +#### Ajouter un frontend HTTP à un service Load Balancer OVHcloud > [!faq] > @@ -887,7 +877,7 @@ Accéder aux éléments relatifs au protocole HTTP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **allowedSource** >> > @@ -901,43 +891,43 @@ Accéder aux éléments relatifs au protocole HTTP (Frontend, Ferme, etc.). >> > >> > **defaultFarmId** >> > ->> >> L'identifiant de la ferme HTTP par défaut pour votre frontend (Nombre) +>> >> L'identifiant de la ferme HTTP par défaut pour votre frontend (nombre) >> > >> > **defaultSslId** >> > ->> >> L'identifiant du certificat SSL par défaut (Nombre) +>> >> L'identifiant du certificat SSL par défaut (nombre) >> > >> > **disabled** >> > ->> >> Si votre frontend HTTP est désactivé ou activé (Booléen) +>> >> Si votre frontend HTTP est désactivé ou activé (booléen) >> > >> > **displayName** >> > ->> >> Le nom de votre frontend HTTP (Chaîne de caractères) +>> >> Le nom de votre frontend HTTP (chaîne de caractères) >> > >> > **hsts** >> > ->> >> Si le support du *https strict, HTTP Strict Transport Security* est activé ou désactivé (Booléen) +>> >> Si le support du *https strict, HTTP Strict Transport Security* est activé ou désactivé (booléen) >> > >> > **httpHeader** >> > ->> >> L'entête *http* personnalisé à ajouter (Chaîne de caractères) +>> >> L'entête *http* personnalisé à ajouter (chaîne de caractères) >> > >> > **port** * >> > ->> >> Le port d'écoute de votre frontend (Nombre, 1..65535) +>> >> Le port d'écoute de votre frontend (nombre, 1..65535) >> > >> > **redirectLocation** >> > ->> >> L'URL de redirection *http* (Chaîne de caractères) +>> >> L'URL de redirection *http* (chaîne de caractères) >> > >> > **ssl** >> > ->> >> Si les requêtes envoyées à la ferme HTTP doivent être chiffrées avec SSL ou non (Booléen) +>> >> Si les requêtes envoyées à la ferme HTTP doivent être chiffrées avec SSL ou non (booléen) >> > >> > **zone** * >> > ->> >> Le nom de votre zone, ex: all (Chaîne de caractères) +>> >> Le nom de votre zone, ex: all (chaîne de caractères) > ### Obtenir les détails d'un frontend HTTP @@ -956,11 +946,11 @@ Accéder aux éléments relatifs au protocole HTTP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **frontendId** * >> > ->> >> L'identifiant de votre frontend HTTP (Nombre) +>> >> L'identifiant de votre frontend HTTP (nombre) > #### Modifier les propriétés d'un frontend HTTP @@ -979,11 +969,11 @@ Accéder aux éléments relatifs au protocole HTTP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **frontendId** * >> > ->> >> L'identifiant de votre frontend HTTP (Nombre) +>> >> L'identifiant de votre frontend HTTP (nombre) >> > >> > **FrontendHttp** * >> > @@ -999,27 +989,27 @@ Accéder aux éléments relatifs au protocole HTTP (Frontend, Ferme, etc.). >> >> >> >> - **defaultSslId** >> >> > ->> >> > L'identifiant du certificat SSL par défaut (Nombre) +>> >> > L'identifiant du certificat SSL par défaut (nombre) >> >> >> >> - **disabled** >> >> > ->> >> > Si votre frontend HTTP est désactivé ou activé (Booléen) +>> >> > Si votre frontend HTTP est désactivé ou activé (booléen) >> >> >> >> - **displayName** >> >> > ->> >> > Le nom de votre frontend HTTP (Chaîne de caractères) +>> >> > Le nom de votre frontend HTTP (chaîne de caractères) >> >> >> >> - **hsts** >> >> > ->> >> > Si le support du *https strict, HTTP Strict Transport Security* est activé ou désactivé (Booléen) +>> >> > Si le support du *https strict, HTTP Strict Transport Security* est activé ou désactivé (booléen) >> >> >> >> - **httpHeader** >> >> > ->> >> > L'entête *http* personnalisé à ajouter (Chaîne de caractères) +>> >> > L'en-tête *http* personnalisé à ajouter (chaîne de caractères) >> >> >> >> - **ssl** >> >> > ->> >> > Si les requêtes envoyées à la ferme HTTP doivent être chiffrées avec SSL ou non (Booléen) +>> >> > Si les requêtes envoyées à la ferme HTTP doivent être chiffrées avec SSL ou non (booléen) > #### Supprimer un frontend HTTP @@ -1038,14 +1028,15 @@ Accéder aux éléments relatifs au protocole HTTP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **frontendId** * >> > ->> >> L'identifiant de votre frontend (Nombre) +>> >> L'identifiant de votre frontend (nombre) > ### Routes HTTP + Les routes sont évaluées une par une, en testant leurs règles de routage. La première route validant toutes ses règles voit son action exécutée, et arrête l'évaluation des routes restantes. L'ordre d'exécution est défini par le type et le poids de la route. #### Lister les routes HTTP attachées à un service Load Balancer @@ -1064,14 +1055,14 @@ Les routes sont évaluées une par une, en testant leurs règles de routage. La > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **frontendId** >> > ->> >> L'identifiant d'un frontend HTTP (Nombre) +>> >> L'identifiant d'un frontend HTTP (nombre) > -#### Ajouter une nouvelle route HTTP à un service Load Balancer OVH +#### Ajouter une nouvelle route HTTP à un service Load Balancer OVHcloud > [!faq] > @@ -1087,7 +1078,7 @@ Les routes sont évaluées une par une, en testant leurs règles de routage. La > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **action** * >> > @@ -1095,27 +1086,27 @@ Les routes sont évaluées une par une, en testant leurs règles de routage. La >> >> >> >> - **status** >> >> ->> >> > Le code de retour HTTP attendu (Nombre) +>> >> > Le code de retour HTTP attendu (nombre) >> >> >> >> - **target** >> >> ->> >> > L'identifiant de la ferme, ou le modèle pour l'URL (Chaîne de caractères) +>> >> > L'identifiant de la ferme, ou le modèle pour l'URL (chaîne de caractères) >> >> >> >> - **type** >> >> ->> >> > L'action de votre route (Chaîne de caractères) +>> >> > L'action de votre route (chaîne de caractères) >> > >> > **displayName** >> > ->> >> Le nom de votre route (Chaîne de caractères) +>> >> Le nom de votre route (chaîne de caractères) >> > >> > **frontendId** >> > ->> >> L'Identifiant du frontend HTTP pour lequel votre route est appliquée (Nombre) +>> >> L'identifiant du frontend HTTP pour lequel votre route est appliquée (nombre) >> > >> > **weight** >> > ->> >> La priorité de votre route. (Nombre) [0 - 255] +>> >> La priorité de votre route. (nombre) [0 - 255] > #### Obtenir les détails d'une route HTTP @@ -1134,11 +1125,11 @@ Les routes sont évaluées une par une, en testant leurs règles de routage. La > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **routeId** * >> > ->> >> L'identifiant de votre route (Nombre) +>> >> L'identifiant de votre route (nombre) > #### Modifier les propriétés d'une route HTTP @@ -1157,11 +1148,11 @@ Les routes sont évaluées une par une, en testant leurs règles de routage. La > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **routeId** * >> > ->> >> L'identifiant de votre route (Nombre) +>> >> L'identifiant de votre route (nombre) >> > >> > **routeHttp** * >> > @@ -1171,27 +1162,27 @@ Les routes sont évaluées une par une, en testant leurs règles de routage. La >> >> > >> >> > - **status** >> >> > ->> >> >> Le code de retour HTTP attendu (Nombre) +>> >> >> Le code de retour HTTP attendu (nombre) >> >> > >> >> > - **target** >> >> > ->> >> >> L'identifiant de la ferme, ou le modèle pour l'URL (Chaîne de caractères) +>> >> >> L'identifiant de la ferme, ou le modèle pour l'URL (chaîne de caractères) >> >> > >> >> > - **type** >> >> > ->> >> >> L'action de votre route (Chaîne de caractères) +>> >> >> L'action de votre route (chaîne de caractères) >> >> >> >> **displayName** >> >> ->> >> > Le nom de votre route (Chaîne de caractères) +>> >> > Le nom de votre route (chaîne de caractères) >> >> >> >> **frontendId** >> >> ->> >> > L'Identifiant du frontend HTTP pour lequel votre route est appliquée (Nombre) +>> >> > L'identifiant du frontend HTTP pour lequel votre route est appliquée (nombre) >> >> >> >> **weight** >> >> ->> >> > La priorité de votre route. (Nombre) [0 - 255] +>> >> > La priorité de votre route. (nombre) [0 - 255] > #### Supprimer une route HTTP @@ -1210,11 +1201,11 @@ Les routes sont évaluées une par une, en testant leurs règles de routage. La > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **routeId** * >> > ->> >> L'identifiant de votre route (Nombre) +>> >> L'identifiant de votre route (nombre) > ### Règles de routage @@ -1235,11 +1226,11 @@ Les routes sont évaluées une par une, en testant leurs règles de routage. La > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **routeId** * >> > ->> >> L'identifiant de votre route HTTP (Nombre) +>> >> L'identifiant de votre route HTTP (nombre) > #### Ajouter les règles de routages attachées à une route HTTP @@ -1258,15 +1249,15 @@ Les routes sont évaluées une par une, en testant leurs règles de routage. La > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **routeId** * >> > ->> >> L'identifiant de votre route HTTP (Nombre) +>> >> L'identifiant de votre route HTTP (nombre) >> > >> > **field** * >> > ->> >> Le nom du champs à tester avec l'opérateur "match" (Chaîne de caractères) +>> >> Le nom du champ à tester avec l'opérateur "match" (chaîne de caractères) >> > >> > **match** * >> > @@ -1274,7 +1265,7 @@ Les routes sont évaluées une par une, en testant leurs règles de routage. La >> > >> > **negate** >> > ->> >> Le comportement de l'opérateur :code:`match` est inversé (Booléen) +>> >> Le comportement de l'opérateur :code:`match` est inversé (booléen) >> > >> > **pattern** >> > @@ -1282,7 +1273,7 @@ Les routes sont évaluées une par une, en testant leurs règles de routage. La >> > >> > **subField** >> > ->> >> Le nom du sous-champs, si applicable. Peut être un cookie ou un nom d'en-tête, par exemple (Chaîne de caractères) +>> >> Le nom du sous-champ, si applicable. Peut être un cookie ou un nom d'en-tête, par exemple (chaîne de caractères) > #### Obtenir les détails d'une règle de routage @@ -1301,15 +1292,15 @@ Les routes sont évaluées une par une, en testant leurs règles de routage. La > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **routeId** * >> > ->> >> L'identifiant de votre route HTTP (Nombre) +>> >> L'identifiant de votre route HTTP (nombre) >> > >> > **ruleId** * >> > ->> >> L'identifiant de votre règle de routage HTTP (Nombre) +>> >> L'identifiant de votre règle de routage HTTP (nombre) > #### Modifier les propriétés d'une règle de routage @@ -1328,21 +1319,21 @@ Les routes sont évaluées une par une, en testant leurs règles de routage. La > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **routeId** * >> > ->> >> L'identifiant de votre route HTTP (Nombre) +>> >> L'identifiant de votre route HTTP (nombre) >> > >> > **ruleId** * >> > ->> >> L'identifiant de votre règle de routage HTTP (Nombre) +>> >> L'identifiant de votre règle de routage HTTP (nombre) >> > >> > **RouteRule** * >> > >> >> - **field** >> >> ->> >> > Le nom du champs à tester via l'opérateur "match" (Chaîne de caractères) +>> >> > Le nom du champ à tester via l'opérateur "match" (chaîne de caractères) >> >> >> >> - **match** >> >> @@ -1350,7 +1341,7 @@ Les routes sont évaluées une par une, en testant leurs règles de routage. La >> >> >> >> - **negate** >> >> ->> >> > Si l'opérateur "match" est inversé ou non (Booléen) +>> >> > Si l'opérateur "match" est inversé ou non (booléen) >> >> >> >> - **pattern** >> >> @@ -1358,7 +1349,7 @@ Les routes sont évaluées une par une, en testant leurs règles de routage. La >> >> >> >> - **subField** >> >> ->> >> > Le nom du sous-champs si applicable (Chaîne de caractères) +>> >> > Le nom du sous-champ si applicable (chaîne de caractères) > #### Supprimer une règle de routage @@ -1377,23 +1368,24 @@ Les routes sont évaluées une par une, en testant leurs règles de routage. La > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **routeId** * >> > ->> >> L'identifiant de votre route HTTP (Nombre) +>> >> L'identifiant de votre route HTTP (nombre) >> > >> > **ruleId** * >> > ->> >> L'identifiant de votre règle de routage HTTP (Nombre) +>> >> L'identifiant de votre règle de routage HTTP (nombre) > ## Protocole TCP -Accéder aux éléments relatifs au protocole TCP (Frontend, Ferme, etc.). + +Accéder aux éléments relatifs au protocole TCP (frontend, ferme, etc.). ### Fermes TCP -#### Lister les fermes TCP attachées à un service Load Balancer OVH +#### Lister les fermes TCP attachées à un service Load Balancer OVHcloud > [!faq] > @@ -1409,14 +1401,14 @@ Accéder aux éléments relatifs au protocole TCP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **zone** >> > ->> >> Le nom de votre zone, ex: all (Chaîne de caractères) +>> >> Le nom de votre zone, ex: all (chaîne de caractères) > -#### Ajouter une nouvelle ferme TCP à un service Load Balancer OVH +#### Ajouter une nouvelle ferme TCP à un service Load Balancer OVHcloud > [!faq] > @@ -1432,31 +1424,31 @@ Accéder aux éléments relatifs au protocole TCP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **balance** >> > ->> >> La méthode de répartition de charge de votre ferme (Valeur) +>> >> La méthode de répartition de charge de votre ferme (valeur) >> > >> > **displayName** >> > ->> >> Le nom que vous souhaitez donner à votre ferme (Chaîne de caractères) +>> >> Le nom que vous souhaitez donner à votre ferme (chaîne de caractères) >> > >> > **port** >> > ->> >> Le port d'écoute de votre ferme. Hérité du frontend si non défini (Nombre, 1..65535) +>> >> Le port d'écoute de votre ferme. Hérité du frontend si non-défini (nombre, 1..65535) >> > >> > **probe** >> > ->> >> Le type de sonde à utiliser sur votre ferme (Sonde HTTP) +>> >> Le type de sonde à utiliser sur votre ferme (sonde HTTP) >> >> >> >> - **forceSsl** >> >> ->> >> > L'activation du SSL est forcée pour la sonde (Booléen) +>> >> > L'activation du SSL est forcée pour la sonde (booléen) >> >> >> >> - **interval** >> >> ->> >> > L'intervalle (en secondes) entre chaque test de la sonde. Doit être supérieur à 30. 30 par défaut (Nombre) +>> >> > L'intervalle (en secondes) entre chaque test de la sonde. Doit être supérieur à 30. 30 par défaut (nombre) >> >> >> >> - **match** >> >> @@ -1464,7 +1456,7 @@ Accéder aux éléments relatifs au protocole TCP (Frontend, Ferme, etc.). >> >> >> >> - **negate** >> >> ->> >> > Le comportement de l'opérateur :code:`match` est inversé (Booléen) +>> >> > Le comportement de l'opérateur :code:`match` est inversé (booléen) >> >> >> >> - **method** >> >> @@ -1472,11 +1464,11 @@ Accéder aux éléments relatifs au protocole TCP (Frontend, Ferme, etc.). >> >> >> >> - **pattern** >> >> ->> >> > réponse du serveur quand "UP". Vide pour 'default', liste de statuts séparés par des virgules pour 'status', texte pour 'contains', expression régulière pour 'matches' (Chaîne de caractères) +>> >> > réponse du serveur quand "UP". Vide pour 'default', liste de statuts séparés par des virgules pour 'status', texte pour 'contains', expression régulière pour 'matches' (chaîne de caractères) >> >> >> >> - **port** >> >> ->> >> > Le port que la sonde doit utiliser pour tester les serveurs attachés à votre ferme. Ignoré pour les sondes 'oco'. Si non défini, le port de la ferme est utilisé (Nombre) +>> >> > Le port que la sonde doit utiliser pour tester les serveurs attachés à votre ferme. Ignoré pour les sondes 'oco'. Si non-défini, le port de la ferme est utilisé (nombre) >> >> >> >> - **type** >> >> @@ -1484,15 +1476,15 @@ Accéder aux éléments relatifs au protocole TCP (Frontend, Ferme, etc.). >> >> >> >> - **url** >> >> ->> >> > L'adresse à utiliser par la sonde pour les sondes de type HTTP. Le :code:`type` est ignoré si ce paramètre est définit (Chaîne de caractères) +>> >> > L'adresse à utiliser par la sonde pour les sondes de type HTTP. Le :code:`type` est ignoré si ce paramètre est défini (chaîne de caractères) >> >> >> > **stickiness** >> > ->> >> Le type de persistence de connexion à utiliser pour votre ferme (Valeur) +>> >> Le type de persistence de connexion à utiliser pour votre ferme (valeur) >> > >> > **zone** * >> > ->> >> Le nom de votre zone, ex: all (Chaîne de caractères) +>> >> Le nom de votre zone, ex: all (chaîne de caractères) > #### Obtenir les détails d'une ferme TCP @@ -1511,11 +1503,11 @@ Accéder aux éléments relatifs au protocole TCP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **farmId** * >> > ->> >> L'identifiant de votre ferme (Nombre) +>> >> L'identifiant de votre ferme (nombre) > #### Modifier les propriétés d'une ferme TCP @@ -1534,33 +1526,33 @@ Accéder aux éléments relatifs au protocole TCP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **farmId** * >> > ->> >> L'identifiant de votre ferme (Nombre) +>> >> L'identifiant de votre ferme (nombre) >> > >> > **BackendTcp** * >> > >> >> - **balance** >> >> ->> >> > Le type de répartition de charge (Valeur) +>> >> > Le type de répartition de charge (valeur) >> >> >> >> - **displayName** >> >> ->> >> > Le nom de la ferme (Chaîne de caractères) +>> >> > Le nom de la ferme (chaîne de caractères) >> >> >> >> - **port** >> >> ->> >> > Le port d'écoute de la ferme (Nombre, 1..65000) +>> >> > Le port d'écoute de la ferme (nombre, 1..65000) >> >> >> >> - **probe** >> >> ->> >> > Le type de sonde à utiliser (Sonde TCP) +>> >> > Le type de sonde à utiliser (sonde TCP) >> >> >> >> - **stickiness** >> >> ->> >> > Le type de persistence de connexion (Valeur) +>> >> > Le type de persistence de connexion (valeur) > #### Supprimer une ferme TCP @@ -1579,11 +1571,11 @@ Accéder aux éléments relatifs au protocole TCP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **farmId** * >> > ->> >> L'identifiant de votre ferme (Nombre) +>> >> L'identifiant de votre ferme (nombre) > ### Serveurs TCP @@ -1604,15 +1596,15 @@ Accéder aux éléments relatifs au protocole TCP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **farmId** * >> > ->> >> L'identifiant de votre ferme (Nombre) +>> >> L'identifiant de votre ferme (nombre) >> > >> > **cookie** >> > ->> >> Filtrer les valeurs par Cookie (Chaîne de caractères) +>> >> Filtrer les valeurs par cookie (chaîne de caractères) >> > >> > **address** >> > @@ -1620,7 +1612,7 @@ Accéder aux éléments relatifs au protocole TCP (Frontend, Ferme, etc.). >> > >> > **status** >> > ->> >> Filtrer les valeurs par statut du serveur (Valeur) +>> >> Filtrer les valeurs par statut du serveur (valeur) > #### Ajouter un serveur à une ferme TCP @@ -1639,11 +1631,11 @@ Accéder aux éléments relatifs au protocole TCP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **farmId** * >> > ->> >> L'identifiant de votre ferme (Nombre) +>> >> L'identifiant de votre ferme (nombre) >> > >> > **address** * >> > @@ -1651,40 +1643,40 @@ Accéder aux éléments relatifs au protocole TCP (Frontend, Ferme, etc.). >> > >> > **backup** >> > ->> >> Si votre serveur est configuré comme serveur de secours (Booléen) +>> >> Si votre serveur est configuré comme serveur de secours (booléen) >> > >> > **chain** >> > ->> >> La valeur du certificat SSL intermédiaire (Chaîne de caractères) +>> >> La valeur du certificat SSL intermédiaire (chaîne de caractères) >> > >> > **displayName** >> > ->> >> Le nom donné à votre serveur (Chaîne de caractères) +>> >> Le nom donné à votre serveur (chaîne de caractères) >> > >> > **port** >> > ->> >> Le port d'écoute de votre serveur. Hérité de votre ferme si non défini (Nombre, 1..65535) +>> >> Le port d'écoute de votre serveur. Hérité de votre ferme si non-défini (nombre, 1..65535) >> > >> > **probe** >> > ->> >> Le type de sonde à utiliser (Valeur) +>> >> Le type de sonde à utiliser (valeur) >> > >> > **proxyProtocolVersion** >> > >> >> La version de proxyProtocol à utiliser, ->> >> voir http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt (Valeur) +>> >> voir http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt (valeur) >> > >> > **ssl** * >> > ->> >> Si les requêtes envoyées à vos serveurs doivent être chiffrées avec SSL (Booléen) +>> >> Si les requêtes envoyées à vos serveurs doivent être chiffrées avec SSL (booléen) >> > >> > **weight** * >> > ->> >> Le poids de votre serveur pour votre ferme. Un serveur à poids élevé reçoit plus de requêtes (Nombre) +>> >> Le poids de votre serveur pour votre ferme. Un serveur à poids élevé reçoit plus de requêtes (nombre) >> > >> > **status** * >> > ->> >> Si votre serveur est activé ou non (Booléen) +>> >> Si votre serveur est activé ou non (booléen) > #### Obtenir les détails d'un serveur lié à une ferme TCP @@ -1703,15 +1695,15 @@ Accéder aux éléments relatifs au protocole TCP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **serverId** * >> > ->> >> L'identifiant de votre server (Nombre) +>> >> L'identifiant de votre serveur (nombre) >> > >> > **farmId** * >> > ->> >> L'identifiant de votre ferme (Nombre) +>> >> L'identifiant de votre ferme (nombre) > > #### Modifier les propriétés d'un serveur TCP @@ -1730,37 +1722,37 @@ Accéder aux éléments relatifs au protocole TCP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **serverId** * >> > ->> >> L'identifiant de votre server-link (Nombre) +>> >> L'identifiant de votre server-link (nombre) >> > >> > **farmId** * >> > ->> >> L'identifiant de votre ferme (Nombre) +>> >> L'identifiant de votre ferme (nombre) >> > >> > **BackendTcpServer** * >> > >> >> - **backup** >> >> ->> >> > Si votre serveur est configuré comme serveur de secours (Booléen) +>> >> > Si votre serveur est configuré comme serveur de secours (booléen) >> >> >> >> - **chain** >> >> ->> >> > La valeur du certificat SSL intermédiaire (Chaîne de caractères) +>> >> > La valeur du certificat SSL intermédiaire (chaîne de caractères) >> >> >> >> - **displayName** >> >> ->> >> > Le nom de votre serveur (Chaîne de caractères) +>> >> > Le nom de votre serveur (chaîne de caractères) >> >> >> >> - **port** >> >> ->> >> > Le port d'écoute de votre serveur (Nombre, 1..65535) +>> >> > Le port d'écoute de votre serveur (nombre, 1..65535) >> >> >> >> - **probe** >> >> ->> >> > Le type de sonde à utiliser (Valeur) +>> >> > Le type de sonde à utiliser (valeur) >> >> >> >> - **proxyProtocolVersion** >> >> @@ -1769,15 +1761,15 @@ Accéder aux éléments relatifs au protocole TCP (Frontend, Ferme, etc.). >> >> >> >> - **ssl** >> >> ->> >> > Si les requêtes envoyées à vos serveurs doivent être chiffrées avec SSL (Booléen) +>> >> > Si les requêtes envoyées à vos serveurs doivent être chiffrées avec SSL (booléen) >> >> >> >> - **status** >> >> ->> >> > Si votre serveur est activé ou non (Booléen) +>> >> > Si votre serveur est activé ou non (booléen) >> >> >> >> - **weight** >> >> ->> >> > Le poids de votre serveur pour votre ferme (Nombre) +>> >> > Le poids de votre serveur pour votre ferme (nombre) > #### Supprimer un serveur d'une ferme TCP @@ -1796,20 +1788,20 @@ Accéder aux éléments relatifs au protocole TCP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **serverId** * >> > ->> >> L'identifiant de votre server (Nombre) +>> >> L'identifiant de votre serveur (nombre) >> > >> > **farmId** * >> > ->> >> L'identifiant de votre ferme (Nombre) +>> >> L'identifiant de votre ferme (nombre) > ### Frontends TCP -#### Lister les frontends TCP attachés à un service Load Balancer OVH +#### Lister les frontends TCP attachés à un service Load Balancer OVHcloud > [!faq] > @@ -1825,22 +1817,22 @@ Accéder aux éléments relatifs au protocole TCP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **defaultFarmId** >> > ->> >> L'identifiant de la ferme TCP à laquelle le frontend TCP est lié (Nombre) +>> >> L'identifiant de la ferme TCP à laquelle le frontend TCP est lié (nombre) >> > >> > **port** >> > ->> >> Le port d'écoute de votre frontend (Nombre, 1..65535) +>> >> Le port d'écoute de votre frontend (nombre, 1..65535) >> > >> > **zone** >> > ->> >> Le nom de votre zone, ex: all (Chaîne de caractères) +>> >> Le nom de votre zone, ex: all (chaîne de caractères) > -#### Ajouter un frontend TCP à un service Load Balancer OVH +#### Ajouter un frontend TCP à un service Load Balancer OVHcloud > [!faq] > @@ -1856,7 +1848,7 @@ Accéder aux éléments relatifs au protocole TCP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **allowedSource** >> > @@ -1868,31 +1860,31 @@ Accéder aux éléments relatifs au protocole TCP (Frontend, Ferme, etc.). >> > >> > **defaultFarmId** >> > ->> >> L'identifiant de la ferme TCP par défaut pour votre frontend (Nombre) +>> >> L'identifiant de la ferme TCP par défaut pour votre frontend (nombre) >> > >> > **defaultSslId** >> > ->> >> L'identifiant du certificat SSL par défaut (Nombre) +>> >> L'identifiant du certificat SSL par défaut (nombre) >> > >> > **disabled** >> > ->> >> Si votre frontend TCP est désactivé ou activé (Booléen) +>> >> Si votre frontend TCP est désactivé ou activé (booléen) >> > >> > **displayName** >> > ->> >> Le nom de votre frontend TCP (Chaîne de caractères) +>> >> Le nom de votre frontend TCP (chaîne de caractères) >> > >> > **port** * >> > ->> >> Le port d'écoute de votre frontend (Nombre, 1..65535) +>> >> Le port d'écoute de votre frontend (nombre, 1..65535) >> > >> > **ssl** >> > ->> >> Si les requêtes envoyées à la ferme TCP doivent être chiffrées avec SSL ou non (Booléen) +>> >> Si les requêtes envoyées à la ferme TCP doivent être chiffrées avec SSL ou non (booléen) >> > >> > **zone** * >> > ->> >> Le nom de votre zone, ex: all (Chaîne de caractères) +>> >> Le nom de votre zone, ex: all (chaîne de caractères) > #### Obtenir les détails d'un frontend TCP @@ -1911,11 +1903,11 @@ Accéder aux éléments relatifs au protocole TCP (Frontend, Ferme, etc.). > >> > **serviceName** * >> >> ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **frontendId** * >> >> ->> >> L'identifiant de votre frontend TCP (Nombre) +>> >> L'identifiant de votre frontend TCP (nombre) >> #### Modifier les propriétés d'un frontend TCP @@ -1934,37 +1926,37 @@ Accéder aux éléments relatifs au protocole TCP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **frontendId** * >> > ->> >> L'identifiant de votre frontend TCP (Nombre) +>> >> L'identifiant de votre frontend TCP (nombre) >> > >> > **FrontendTcp** * >> > >> >> - **allowedSource** >> >> ->> >> > La liste des adresses IPs clientes qui ont accès au Load Balancer (IPv4[]) +>> >> > La liste des adresses IP clientes qui ont accès au Load Balancer (IPv4[]) >> >> >> >> - **dedicatedIpfo** >> >> ->> >> > La liste des adresses IPs des serveurs distants auxquels votre Load Balancer est connecté (IPv4[]) +>> >> > La liste des adresses IP des serveurs distants auxquels votre Load Balancer est connecté (IPv4[]) >> >> >> >> - **defaultSslId** >> >> ->> >> > L'identifiant du certificat SSL par défaut (Nombre) +>> >> > L'identifiant du certificat SSL par défaut (nombre) >> >> >> >> - **disabled** >> >> ->> >> > Si votre frontend HTTP est désactivé ou activé (Booléen) +>> >> > Si votre frontend HTTP est désactivé ou activé (booléen) >> >> >> >> - **displayName** >> >> ->> >> > Le nom de votre frontend HTTP (Chaîne de caractères) +>> >> > Le nom de votre frontend HTTP (chaîne de caractères) >> >> >> >> - **ssl** >> >> ->> >> > Si les requêtes envoyées à la ferme HTTP doivent être chiffrées avec SSL ou non (Booléen) +>> >> > Si les requêtes envoyées à la ferme HTTP doivent être chiffrées avec SSL ou non (booléen) > #### Supprimer un frontend TCP @@ -1983,17 +1975,18 @@ Accéder aux éléments relatifs au protocole TCP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **frontendId** * >> > ->> >> L'identifiant de votre frontend (Nombre) +>> >> L'identifiant de votre frontend (nombre) > ### Routes TCP + Les routes sont évaluées une par une, en testant leurs règles de routage. La première route validant toutes ses règles voit son action exécutée, et arrête l'évaluation des routes restantes. L'ordre d'exécution est défini par le type et le poids de la route. -#### Lister les routes TCP attachées à un service Load Balancer OVH +#### Lister les routes TCP attachées à un service Load Balancer OVHcloud > [!faq] > @@ -2009,14 +2002,14 @@ Les routes sont évaluées une par une, en testant leurs règles de routage. La > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **frontendId** >> > ->> >> L'identifiant d'un frontend TCP (Nombre) +>> >> L'identifiant d'un frontend TCP (nombre) > -#### Ajouter une nouvelle route TCP à un service Load Balancer OVH +#### Ajouter une nouvelle route TCP à un service Load Balancer OVHcloud > [!faq] > @@ -2032,7 +2025,7 @@ Les routes sont évaluées une par une, en testant leurs règles de routage. La > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **action** * >> > @@ -2040,23 +2033,23 @@ Les routes sont évaluées une par une, en testant leurs règles de routage. La >> >> >> >> - **target** >> >> ->> >> > L'identifiant de la ferme, ou le modèle pour l'URL (Chaîne de caractères) +>> >> > L'identifiant de la ferme, ou le modèle pour l'URL (chaîne de caractères) >> >> >> >> - **type** >> >> ->> >> > L'action de votre route (Chaîne de caractères) +>> >> > L'action de votre route (chaîne de caractères) >> > >> > **displayName** >> > ->> >> Le nom de votre route (Chaîne de caractères) +>> >> Le nom de votre route (chaîne de caractères) >> > >> > **frontendId** >> > ->> >> L'Identifiant du frontend TCP pour lequel votre route est appliquée (Nombre) +>> >> L'identifiant du frontend TCP pour lequel votre route est appliquée (nombre) >> > >> > **weight** >> > ->> >> La priorité de votre route. (Nombre) [0 - 255] +>> >> La priorité de votre route. (nombre) [0 - 255] > #### Obtenir les détails d'une route TCP @@ -2075,11 +2068,11 @@ Les routes sont évaluées une par une, en testant leurs règles de routage. La > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **routeId** * >> > ->> >> L'identifiant de votre route (Nombre) +>> >> L'identifiant de votre route (nombre) > #### Modifier les propriétés d'une route TCP @@ -2098,11 +2091,11 @@ Les routes sont évaluées une par une, en testant leurs règles de routage. La > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **routeId** * >> > ->> >> L'identifiant de votre route (Nombre) +>> >> L'identifiant de votre route (nombre) >> > >> > **routeTcp** * >> > @@ -2112,23 +2105,23 @@ Les routes sont évaluées une par une, en testant leurs règles de routage. La >> >> > >> >> > - **target** >> >> > ->> >> >> L'identifiant de la ferme, ou le modèle pour l'URL (Chaîne de caractères) +>> >> >> L'identifiant de la ferme, ou le modèle pour l'URL (chaîne de caractères) >> >> > >> >> > - **type** >> >> > ->> >> >> L'action de votre route (Chaîne de caractères) +>> >> >> L'action de votre route (chaîne de caractères) >> >> >> >> - **displayName** >> >> ->> >> > Le nom de votre route (Chaîne de caractères) +>> >> > Le nom de votre route (chaîne de caractères) >> >> >> >> - **frontendId** >> >> ->> >> > Le frontend TCP pour lequel votre route est appliquée (Nombre) +>> >> > Le frontend TCP pour lequel votre route est appliquée (nombre) >> >> >> >> - **weight** >> >> ->> >> > La priorité de votre route (Nombre) [0 - 255] +>> >> > La priorité de votre route (nombre) [0 - 255] > #### Supprimer une route TCP @@ -2147,11 +2140,11 @@ Les routes sont évaluées une par une, en testant leurs règles de routage. La > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **routeId** * >> > ->> >> L'identifiant de votre route (Nombre) +>> >> L'identifiant de votre route (nombre) > ### Règles de routage @@ -2172,11 +2165,11 @@ Les routes sont évaluées une par une, en testant leurs règles de routage. La > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **routeId** * >> > ->> >> L'identifiant de votre route TCP (Nombre) +>> >> L'identifiant de votre route TCP (nombre) > #### Ajouter les règles de routages attachées à une route TCP @@ -2195,15 +2188,15 @@ Les routes sont évaluées une par une, en testant leurs règles de routage. La > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **routeId** * >> > ->> >> L'identifiant de votre route TCP (Nombre) +>> >> L'identifiant de votre route TCP (nombre) >> > >> > **field** * >> > ->> >> Le nom du champs à tester avec l'opérateur "match" (Chaîne de caractères) +>> >> Le nom du champ à tester avec l'opérateur "match" (chaîne de caractères) >> > >> > **match** * >> > @@ -2211,7 +2204,7 @@ Les routes sont évaluées une par une, en testant leurs règles de routage. La >> > >> > **negate** >> > ->> >> Le comportement de l'opérateur :code:`match` est inversé (Booléen) +>> >> Le comportement de l'opérateur :code:`match` est inversé (booléen) >> > >> > **pattern** >> > @@ -2219,7 +2212,7 @@ Les routes sont évaluées une par une, en testant leurs règles de routage. La >> > >> > **subField** >> > ->> >> Le nom du sous-champs, si applicable. Peut être un cookie ou un nom d'en-tête, par exemple (Chaîne de caractères) +>> >> Le nom du sous-champ, si applicable. Peut être un cookie ou un nom d'en-tête, par exemple (chaîne de caractères) > #### Obtenir les détails d'une règle de routage @@ -2238,15 +2231,15 @@ Les routes sont évaluées une par une, en testant leurs règles de routage. La > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **routeId** * >> > ->> >> L'identifiant de votre route TCP (Nombre) +>> >> L'identifiant de votre route TCP (nombre) >> > >> > **ruleId** * >> > ->> >> L'identifiant de votre règle de routage HTTP (Nombre) +>> >> L'identifiant de votre règle de routage HTTP (nombre) > #### Modifier les propriétés d'une règle de routage @@ -2265,21 +2258,21 @@ Les routes sont évaluées une par une, en testant leurs règles de routage. La > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **routeId** * >> > ->> >> L'identifiant de votre route TCP (Nombre) +>> >> L'identifiant de votre route TCP (nombre) >> > >> > **ruleId** * >> > ->> >> L'identifiant de votre règle de routage HTTP (Nombre) +>> >> L'identifiant de votre règle de routage HTTP (nombre) >> > >> > **RouteRule** * >> > >> >> - **field** >> >> ->> >> > Le nom du champs à tester via l'opérateur "match" (Chaîne de caractères) +>> >> > Le nom du champ à tester via l'opérateur "match" (chaîne de caractères) >> >> >> >> - **match** >> >> @@ -2287,7 +2280,7 @@ Les routes sont évaluées une par une, en testant leurs règles de routage. La >> >> >> >> - **negate** >> >> ->> >> > Si l'opérateur "match" est inversé ou non (Booléen) +>> >> > Si l'opérateur "match" est inversé ou non (booléen) >> >> >> >> - **pattern** >> >> @@ -2295,7 +2288,7 @@ Les routes sont évaluées une par une, en testant leurs règles de routage. La >> >> >> >> - **subField** >> >> ->> >> > Le nom du sous-champs si applicable (Chaîne de caractères) +>> >> > Le nom du sous-champ si applicable (chaîne de caractères) > #### Supprimer une règle de routage @@ -2314,23 +2307,24 @@ Les routes sont évaluées une par une, en testant leurs règles de routage. La > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **routeId** * >> > ->> >> L'identifiant de votre route TCP (Nombre) +>> >> L'identifiant de votre route TCP (nombre) >> > >> > **ruleId** * >> > ->> >> L'identifiant de votre règle de routage HTTP (Nombre) +>> >> L'identifiant de votre règle de routage HTTP (nombre) > ## Protocole UDP -Accéder aux éléments relatifs au protocole UDP (Frontend, Ferme, etc.). + +Accéder aux éléments relatifs au protocole UDP (frontend, ferme, etc.). ### Fermes UDP -#### Lister les fermes UDP attachées à un service Load Balancer OVH +#### Lister les fermes UDP attachées à un service Load Balancer OVHcloud > [!faq] > @@ -2346,14 +2340,14 @@ Accéder aux éléments relatifs au protocole UDP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **zone** >> > ->> >> Le nom de votre zone, ex: all (Chaîne de caractères) +>> >> Le nom de votre zone, ex: all (chaîne de caractères) > -#### Ajouter une nouvelle ferme UDP à un service Load Balancer OVH +#### Ajouter une nouvelle ferme UDP à un service Load Balancer OVHcloud > [!faq] > @@ -2369,19 +2363,19 @@ Accéder aux éléments relatifs au protocole UDP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **displayName** >> > ->> >> Le nom que vous souhaitez donner à votre ferme (Chaîne de caractères) +>> >> Le nom que vous souhaitez donner à votre ferme (chaîne de caractères) >> > >> > **port** >> > ->> >> Le port d'écoute de votre ferme. Hérité du frontend si non défini (Nombre, 1..65535) +>> >> Le port d'écoute de votre ferme. Hérité du frontend si non-défini (nombre, 1..65535) >> > >> > **zone** * >> > ->> >> Le nom de votre zone, ex: all (Chaîne de caractères) +>> >> Le nom de votre zone, par exemple : all (chaîne de caractères) > #### Obtenir les détails d'une ferme UDP @@ -2400,11 +2394,11 @@ Accéder aux éléments relatifs au protocole UDP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **farmId** * >> > ->> >> L'identifiant de votre ferme (Nombre) +>> >> L'identifiant de votre ferme (nombre) > #### Modifier les propriétés d'une ferme UDP @@ -2423,21 +2417,21 @@ Accéder aux éléments relatifs au protocole UDP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **farmId** * >> > ->> >> L'identifiant de votre ferme (Nombre) +>> >> L'identifiant de votre ferme (nombre) >> > >> > **BackendUdp** * >> > >> >> - **displayName** >> >> ->> >> > Le nom de la ferme (Chaîne de caractères) +>> >> > Le nom de la ferme (chaîne de caractères) >> >> >> >> - **port** >> >> ->> >> > Le port d'écoute de la ferme (Nombre, 1..65000) +>> >> > Le port d'écoute de la ferme (nombre, 1..65000) > #### Supprimer une ferme UDP @@ -2456,11 +2450,11 @@ Accéder aux éléments relatifs au protocole UDP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **farmId** * >> > ->> >> L'identifiant de votre ferme (Nombre) +>> >> L'identifiant de votre ferme (nombre) > ### Serveurs UDP @@ -2481,11 +2475,11 @@ Accéder aux éléments relatifs au protocole UDP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **farmId** * >> > ->> >> L'identifiant de votre ferme (Nombre) +>> >> L'identifiant de votre ferme (nombre) >> > >> > **address** >> > @@ -2493,7 +2487,7 @@ Accéder aux éléments relatifs au protocole UDP (Frontend, Ferme, etc.). >> > >> > **status** >> > ->> >> Filtrer les valeurs par statut du serveur (Valeur) +>> >> Filtrer les valeurs par statut du serveur (valeur) > #### Ajouter un serveur à une ferme UDP @@ -2512,11 +2506,11 @@ Accéder aux éléments relatifs au protocole UDP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **farmId** * >> > ->> >> L'identifiant de votre ferme (Nombre) +>> >> L'identifiant de votre ferme (nombre) >> > >> > **address** * >> > @@ -2524,15 +2518,15 @@ Accéder aux éléments relatifs au protocole UDP (Frontend, Ferme, etc.). >> > >> > **displayName** >> > ->> >> Le nom donné à votre serveur (Chaîne de caractères) +>> >> Le nom donné à votre serveur (chaîne de caractères) >> > >> > **port** >> > ->> >> Le port d'écoute de votre serveur. Hérité de votre ferme si non défini (Nombre, 1..65535) +>> >> Le port d'écoute de votre serveur. Hérité de votre ferme si non-défini (nombre, 1..65535) >> > >> > **status** * >> > ->> >> Si votre serveur est activé ou non (Booléen) +>> >> Si votre serveur est activé ou non (booléen) > #### Obtenir les détails d'un serveur lié à une ferme UDP @@ -2551,15 +2545,15 @@ Accéder aux éléments relatifs au protocole UDP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **serverId** * >> > ->> >> L'identifiant de votre server (Nombre) +>> >> L'identifiant de votre serveur (nombre) >> > >> > **farmId** * >> > ->> >> L'identifiant de votre ferme (Nombre) +>> >> L'identifiant de votre ferme (nombre) > #### Modifier les propriétés d'un serveur UDP @@ -2578,29 +2572,29 @@ Accéder aux éléments relatifs au protocole UDP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **serverId** * >> > ->> >> L'identifiant de votre serveur (Nombre) +>> >> L'identifiant de votre serveur (nombre) >> > >> > **farmId** * >> > ->> >> L'identifiant de votre ferme (Nombre) +>> >> L'identifiant de votre ferme (nombre) >> > >> > **BackendUdpServer** * >> > >> >> - **displayName** >> >> ->> >> > Le nom de votre serveur (Chaîne de caractères) +>> >> > Le nom de votre serveur (chaîne de caractères) >> >> >> >> - **port** >> >> ->> >> > Le port d'écoute de votre serveur (Nombre, 1..65535) +>> >> > Le port d'écoute de votre serveur (nombre, 1..65535) >> >> >> >> - **status** >> >> ->> >> > Si votre serveur est activé ou non (Booléen) +>> >> > Si votre serveur est activé ou non (booléen) > #### Supprimer un serveur d'une ferme UDP @@ -2619,20 +2613,20 @@ Accéder aux éléments relatifs au protocole UDP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **serverId** * >> > ->> >> L'identifiant de votre serveur UDP (Nombre) +>> >> L'identifiant de votre serveur UDP (nombre) >> > >> > **farmId** * >> > ->> >> L'identifiant de votre ferme UDP (Nombre) +>> >> L'identifiant de votre ferme UDP (nombre) > ### Frontends UDP -#### Lister les frontends UDP attachés à un service Load Balancer OVH +#### Lister les frontends UDP attachés à un service Load Balancer OVHcloud > [!faq] > @@ -2648,22 +2642,22 @@ Accéder aux éléments relatifs au protocole UDP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **defaultFarmId** >> > ->> >> L'identifiant de la ferme UDP à laquelle le frontend UDP est lié (Nombre) +>> >> L'identifiant de la ferme UDP à laquelle le frontend UDP est lié (nombre) >> > >> > **port** >> > ->> >> Le port d'écoute de votre frontend (Nombre, 1..65535) +>> >> Le port d'écoute de votre frontend (nombre, 1..65535) >> > >> > **zone** >> > ->> >> Le nom de votre zone, ex: all (Chaîne de caractères) +>> >> Le nom de votre zone, par exemple : all (chaîne de caractères) > -#### Ajouter un frontend UDP à un service Load Balancer OVH +#### Ajouter un frontend UDP à un service Load Balancer OVHcloud > [!faq] > @@ -2679,7 +2673,7 @@ Accéder aux éléments relatifs au protocole UDP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **dedicatedIpfo** >> > @@ -2687,23 +2681,23 @@ Accéder aux éléments relatifs au protocole UDP (Frontend, Ferme, etc.). >> > >> > **defaultFarmId** * >> > ->> >> L'identifiant de la ferme UDP par défaut pour votre frontend (Nombre) +>> >> L'identifiant de la ferme UDP par défaut pour votre frontend (nombre) >> > >> > **disabled** >> > ->> >> Si votre frontend UDP est désactivé ou activé (Booléen) +>> >> Si votre frontend UDP est désactivé ou activé (booléen) >> > >> > **displayName** >> > ->> >> Le nom de votre frontend UDP (Chaîne de caractères) +>> >> Le nom de votre frontend UDP (chaîne de caractères) >> > >> > **port** * >> > ->> >> Le port d'écoute de votre frontend (Nombre, 1..65535) +>> >> Le port d'écoute de votre frontend (nombre, 1..65535) >> > >> > **zone** * >> > ->> >> Le nom de votre zone, ex: all (Chaîne de caractères) +>> >> Le nom de votre zone, ex: all (chaîne de caractères) > #### Obtenir les détails d'un frontend UDP @@ -2722,11 +2716,11 @@ Accéder aux éléments relatifs au protocole UDP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **frontendId** * >> > ->> >> L'identifiant de votre frontend UDP (Nombre) +>> >> L'identifiant de votre frontend UDP (nombre) > #### Modifier les propriétés d'un frontend UDP @@ -2745,11 +2739,11 @@ Accéder aux éléments relatifs au protocole UDP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **frontendId** * >> > ->> >> L'identifiant de votre frontend UDP (Nombre) +>> >> L'identifiant de votre frontend UDP (nombre) >> > >> > **FrontendUdp** * >> > @@ -2759,11 +2753,11 @@ Accéder aux éléments relatifs au protocole UDP (Frontend, Ferme, etc.). >> >> >> >> - **disabled** >> >> ->> >> > Si votre frontend UDP est désactivé ou activé (Booléen) +>> >> > Si votre frontend UDP est désactivé ou activé (booléen) >> >> >> >> - **displayName** >> >> ->> >> > Le nom de votre frontend UDP (Chaîne de caractères) +>> >> > Le nom de votre frontend UDP (chaîne de caractères) > #### Supprimer un frontend UDP @@ -2782,18 +2776,18 @@ Accéder aux éléments relatifs au protocole UDP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **frontendId** * >> > ->> >> L'identifiant de votre frontend UDP (Nombre) +>> >> L'identifiant de votre frontend UDP (nombre) > ## Autres fonctionnalités ### Additional IP -#### Lister les Additional IPs routées sur un service Load Balancer OVH +#### Lister les Additional IPs routées sur un service Load Balancer OVHcloud > [!faq] > @@ -2809,12 +2803,12 @@ Accéder aux éléments relatifs au protocole UDP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) > ### État du service -#### Obtenir l'état des instances d'un service Load Balancer OVH +#### Obtenir l'état des instances d'un service Load Balancer OVHcloud > [!faq] > @@ -2830,10 +2824,10 @@ Accéder aux éléments relatifs au protocole UDP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) > -#### Lister les IPs de sortie utilisées par OVH pour le NAT +#### Lister les IPs de sortie utilisées par OVHcloud pour le NAT > [!faq] > @@ -2849,10 +2843,10 @@ Accéder aux éléments relatifs au protocole UDP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) > -#### Appliquer les modifications d'un service Load Balancer OVH +#### Appliquer les modifications d'un service Load Balancer OVHcloud > [!faq] > @@ -2868,12 +2862,12 @@ Accéder aux éléments relatifs au protocole UDP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) > ### Certificats SSL -#### Lister les certificats SSL d'un service Load Balancer OVH +#### Lister les certificats SSL d'un service Load Balancer OVHcloud > [!faq] > @@ -2889,19 +2883,19 @@ Accéder aux éléments relatifs au protocole UDP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **fingerprint** >> > ->> >> Liste l'empreinte du certificat SSL (Chaîne de caractères) +>> >> Liste l'empreinte du certificat SSL (chaîne de caractères) >> > >> > **serial** >> > ->> >> Liste le numéro d'indentification du certificat SSL (Chaîne de caractères) +>> >> Liste le numéro d'identification du certificat SSL (chaîne de caractères) >> > >> > **type** >> > ->> >> Type de certificat SSL (Valeur) +>> >> Type de certificat SSL (valeur) > #### Ajouter un nouvel objet SSL @@ -2920,19 +2914,19 @@ Accéder aux éléments relatifs au protocole UDP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **certificate** * >> > ->> >> Ajout du certificat SSL (Chaîne de caractères) +>> >> Ajout du certificat SSL (chaîne de caractères) >> > >> > **chain** >> > ->> >> Ajout du certificat SSL intermédiaire (Chaîne de caractères) +>> >> Ajout du certificat SSL intermédiaire (chaîne de caractères) >> > >> > **key** * >> > ->> >> Ajout de la clé privée (Chaîne de caractères) +>> >> Ajout de la clé privée (chaîne de caractères) > #### Obtenir les détails d'un objet SSL @@ -2951,11 +2945,11 @@ Accéder aux éléments relatifs au protocole UDP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **id** * >> > ->> >> L'identifiant de votre certificat SSL (Nombre) +>> >> L'identifiant de votre certificat SSL (nombre) > #### Supprimer un objet SSL @@ -2974,16 +2968,16 @@ Accéder aux éléments relatifs au protocole UDP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **id** * >> > ->> >> L'identifiant de votre certificat SSL (Nombre) +>> >> L'identifiant de votre certificat SSL (nombre) > ### Tâches -#### Lister les tâches en cours pour un service Load Balancer OVH +#### Lister les tâches en cours pour un service Load Balancer OVHcloud > [!faq] > @@ -2999,7 +2993,7 @@ Accéder aux éléments relatifs au protocole UDP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **action** * >> > @@ -3022,11 +3016,11 @@ Accéder aux éléments relatifs au protocole UDP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **id** * >> > ->> >> L'identifiant de votre tâche (Nombre) +>> >> L'identifiant de votre tâche (nombre) > ### Contact @@ -3047,19 +3041,24 @@ Accéder aux éléments relatifs au protocole UDP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **contactAdmin** >> > ->> >> Le NIC OVH à configurer pour le contact Admin de ce service (Chaîne de caractères) +>> >> L'identifiant client OVHcloud à configurer pour le contact administrateur de ce service (chaîne de caractères) >> > >> > **contactBilling** >> > ->> >> Le NIC OVH à configurer pour le contact Admin de ce service (Chaîne de caractères) +>> >> L'identifiant client OVHcloud à configurer pour le contact facturation de ce service (chaîne de caractères) >> > >> > **contactTech** >> > ->> >> Le NIC OVH à configurer pour le contact Admin de ce service (Chaîne de caractères) +>> >> L'identifiant client OVHcloud à configurer pour le contact technique de ce service (chaîne de caractères) +> + +> [!primary] +> +> Pour plus d'informations sur la gestion des contacts OVHcloud, consultez le guide « [Gérer les contacts de ses services](/pages/account_and_service_management/account_information/managing_contacts) ». > ### vRack @@ -3080,7 +3079,7 @@ Accéder aux éléments relatifs au protocole UDP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **subnet** >> > @@ -3107,11 +3106,11 @@ Accéder aux éléments relatifs au protocole UDP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **displayName** >> > ->> >> Le nom que vous souhaitez attribuer au réseau (Chaîne de caractères) +>> >> Le nom que vous souhaitez attribuer au réseau (chaîne de caractères) >> > >> > **farmId** >> > @@ -3123,7 +3122,7 @@ Accéder aux éléments relatifs au protocole UDP (Frontend, Ferme, etc.). >> > >> > **subnet** >> > ->> >> Le bloc d'Ip du réseau privé +>> >> Le bloc d'IP du réseau privé >> > >> > **vlan** >> > @@ -3148,7 +3147,7 @@ Accéder aux éléments relatifs au protocole UDP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **vrackNetworkId** * >> > @@ -3171,7 +3170,7 @@ Accéder aux éléments relatifs au protocole UDP (Frontend, Ferme, etc.). > >> > **serviceName** * >> > ->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (Chaîne de caractères) +>> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères) >> > >> > **vrackNetworkId** * >> > diff --git a/pages/network/load_balancer/use_api_details/guide.fr-fr.md b/pages/network/load_balancer/use_api_details/guide.fr-fr.md index a167f21323b..377e8cc63b6 100644 --- a/pages/network/load_balancer/use_api_details/guide.fr-fr.md +++ b/pages/network/load_balancer/use_api_details/guide.fr-fr.md @@ -1,12 +1,12 @@ --- title: Détails des fonctionnalités API excerpt: "Détails des fonctionnalités de l’API OVHcloud pour l’offre OVHcloud Load Balancer" -updated: 2022-04-04 +updated: 2025-09-29 --- ## Objectif -Retrouvez ici la description des différents points d'entrées dans l'API pour le Load Balancer OVHcloud. +Ce guide fournit une description détaillée de toutes les fonctions de l'API pour le Load Balancer OVHcloud. ## Prérequis @@ -16,29 +16,18 @@ Retrouvez ici la description des différents points d'entrées dans l'API pour l ### Gérer son service OVHcloud Load Balancer via l'API -Tous les appels API se font dans la section */ipLoadbalancing* disponible ici : [https://api.ovh.com/console/#/ipLoadbalancing](https://api.ovh.com/console/#/ipLoadbalancing). - -> [!warning] -> -> Attention, pour des raisons de compatibilité, le point d'entrée de l'ancien -> système Load Balancer OVHcloud est toujours présent dans l'API /ip/loadBalancing, -> à ne pas confondre avec le nouveau /ipLoadbalancing. -> +Toutes les fonctions d'API qui sont utilisées dans la section */ipLoadbalancing* sont disponibles sur [cette page](/links/console). > [!primary] > -> Dans les appels ci-dessous, tous les champs marqués d'une astérisque * -> sont obligatoires. +> Dans les appels ci-dessous, tous les champs marqués d'une astérisque `*` sont obligatoires. > > [!primary] > -> Les frontend, ferme et ferveur sont spécifiques au -> protocole (parmi HTTP, TCP ou UDP) dans lequel ils sont définis. -> Bien qu'ils puissent être « combinés » entre eux, ce n'est possible qu'au sein -> d'un même protocole. Ainsi, il n'est pas possible d'utiliser un frontend -> UDP avec une ferme HTTP. Mais il est possible (en l'absence d'autres -> limitations) d'utiliser un frontend HTTP avec une ferme HTTP. +> Les frontends, fermes et serveurs sont spécifiques au protocole (HTTP, TCP ou UDP) dans lequel ils sont définies. +> La compatibilité entre ces composants n'est possible qu'au sein du même protocole. +> Par exemple, un frontend HTTP ne peut être associé qu'à une ferme HTTP, et ne peut pas être utilisé avec une ferme UDP. > ## Services et zones diff --git a/pages/network/load_balancer/use_api_reference/guide.en-asia.md b/pages/network/load_balancer/use_api_reference/guide.en-asia.md index daec23af197..7e41b1b9271 100644 --- a/pages/network/load_balancer/use_api_reference/guide.en-asia.md +++ b/pages/network/load_balancer/use_api_reference/guide.en-asia.md @@ -1,37 +1,30 @@ --- title: Load Balancer API Quick Reference excerpt: Quick description of the different API functions used to manage the Load Balancer -updated: 2022-04-04 +updated: 2025-09-29 --- ## List of API functions -This section briefly describes the main functions of the API for the OVH Load Balancer under /ipLoadbalancing -> [!warning] -> -> Attention, for compatibility reasons the entry point of the old OVH Load Balancer system is still present in the /ip/loadBalancing API, not to be confused with the new /ipLoadbalancing. -> +This section briefly describes the main functions of the API for the OVHcloud Load Balancer under /ipLoadbalancing. -For a complete reference to the API functions of the OVH Load Balancer service, it's [here](/pages/network/load_balancer/use_api_details){.ref} +For a comprehensive reference to the API functions of the OVHcloud Load Balancer service, please consult [this detailed guide](/pages/network/load_balancer/use_api_details). > [!primary] > -> The Frontend, Farm and Server are specific to the -> protocol (among HTTP, TCP or UDP) in which they are defined. -> Although they can be "combined" with each other, this is only possible within the same protocol. -> of the same protocol. Thus, it is not possible to use a Frontend -> UDP with an HTTP Farm. But it is possible (in the absence of other -> limitation) to use an HTTP Frontend with an HTTP Farm. +> The Frontends, Farms and Servers are specific to the protocol (HTTP, TCP or UDP) in which they are defined. +> Compatibility between these components is only possible within the same protocol. +> For example, an HTTP Frontend can only be paired with an HTTP Farm, and cannot be used with a UDP Farm. > -## Frontend - -> [!primary] +> [!warning] > -> As you can see, each category consists of 3 API functions. -> It is necessary to properly execute the API function that corresponds to the type of service you want. +> Each category that falls under Frontend, Farm and Server management consists of 3 API functions, one for each protocol (HTTP, TCP or UDP). +> You must execute the API function that corresponds to the specific protocol of the desired service. > +## Frontend + ### Return the list of IDs of existing frontends > [!api] @@ -79,12 +72,6 @@ For a complete reference to the API functions of the OVH Load Balancer service, ## Server farm -> [!primary] -> -> As for the frontend, each category is composed of 3 API functions. -> It is necessary to execute the API function that corresponds to the type of service desired. -> - ### Return the list of IDs of existing farms > [!api] @@ -132,12 +119,6 @@ For a complete reference to the API functions of the OVH Load Balancer service, ## Server -> [!primary] -> -> As for the frontend and farm, each category is composed of 3 API functions. -> It is necessary to properly execute the API function that corresponds to the type of the desired service. -> - ### Return the list of server IDs linked to a particular farm > [!api] diff --git a/pages/network/load_balancer/use_api_reference/guide.en-au.md b/pages/network/load_balancer/use_api_reference/guide.en-au.md index daec23af197..7e41b1b9271 100644 --- a/pages/network/load_balancer/use_api_reference/guide.en-au.md +++ b/pages/network/load_balancer/use_api_reference/guide.en-au.md @@ -1,37 +1,30 @@ --- title: Load Balancer API Quick Reference excerpt: Quick description of the different API functions used to manage the Load Balancer -updated: 2022-04-04 +updated: 2025-09-29 --- ## List of API functions -This section briefly describes the main functions of the API for the OVH Load Balancer under /ipLoadbalancing -> [!warning] -> -> Attention, for compatibility reasons the entry point of the old OVH Load Balancer system is still present in the /ip/loadBalancing API, not to be confused with the new /ipLoadbalancing. -> +This section briefly describes the main functions of the API for the OVHcloud Load Balancer under /ipLoadbalancing. -For a complete reference to the API functions of the OVH Load Balancer service, it's [here](/pages/network/load_balancer/use_api_details){.ref} +For a comprehensive reference to the API functions of the OVHcloud Load Balancer service, please consult [this detailed guide](/pages/network/load_balancer/use_api_details). > [!primary] > -> The Frontend, Farm and Server are specific to the -> protocol (among HTTP, TCP or UDP) in which they are defined. -> Although they can be "combined" with each other, this is only possible within the same protocol. -> of the same protocol. Thus, it is not possible to use a Frontend -> UDP with an HTTP Farm. But it is possible (in the absence of other -> limitation) to use an HTTP Frontend with an HTTP Farm. +> The Frontends, Farms and Servers are specific to the protocol (HTTP, TCP or UDP) in which they are defined. +> Compatibility between these components is only possible within the same protocol. +> For example, an HTTP Frontend can only be paired with an HTTP Farm, and cannot be used with a UDP Farm. > -## Frontend - -> [!primary] +> [!warning] > -> As you can see, each category consists of 3 API functions. -> It is necessary to properly execute the API function that corresponds to the type of service you want. +> Each category that falls under Frontend, Farm and Server management consists of 3 API functions, one for each protocol (HTTP, TCP or UDP). +> You must execute the API function that corresponds to the specific protocol of the desired service. > +## Frontend + ### Return the list of IDs of existing frontends > [!api] @@ -79,12 +72,6 @@ For a complete reference to the API functions of the OVH Load Balancer service, ## Server farm -> [!primary] -> -> As for the frontend, each category is composed of 3 API functions. -> It is necessary to execute the API function that corresponds to the type of service desired. -> - ### Return the list of IDs of existing farms > [!api] @@ -132,12 +119,6 @@ For a complete reference to the API functions of the OVH Load Balancer service, ## Server -> [!primary] -> -> As for the frontend and farm, each category is composed of 3 API functions. -> It is necessary to properly execute the API function that corresponds to the type of the desired service. -> - ### Return the list of server IDs linked to a particular farm > [!api] diff --git a/pages/network/load_balancer/use_api_reference/guide.en-ca.md b/pages/network/load_balancer/use_api_reference/guide.en-ca.md index 359ae47ca4f..7e41b1b9271 100644 --- a/pages/network/load_balancer/use_api_reference/guide.en-ca.md +++ b/pages/network/load_balancer/use_api_reference/guide.en-ca.md @@ -1,37 +1,30 @@ --- title: Load Balancer API Quick Reference excerpt: Quick description of the different API functions used to manage the Load Balancer -updated: 2022-04-04 +updated: 2025-09-29 --- ## List of API functions -This section briefly describes the main functions of the API for the OVH Load Balancer under /ipLoadbalancing -> [!warning] -> -> Attention, for compatibility reasons the entry point of the old OVH Load Balancer system is still present in the /ip/loadBalancing API, not to be confused with the new /ipLoadbalancing. -> +This section briefly describes the main functions of the API for the OVHcloud Load Balancer under /ipLoadbalancing. -For a complete reference to the API functions of the OVH Load Balancer service, it's [here](/pages/network/load_balancer/use_api_details). +For a comprehensive reference to the API functions of the OVHcloud Load Balancer service, please consult [this detailed guide](/pages/network/load_balancer/use_api_details). > [!primary] > -> The Frontend, Farm and Server are specific to the -> protocol (among HTTP, TCP or UDP) in which they are defined. -> Although they can be "combined" with each other, this is only possible within the same protocol. -> of the same protocol. Thus, it is not possible to use a Frontend -> UDP with an HTTP Farm. But it is possible (in the absence of other -> limitation) to use an HTTP Frontend with an HTTP Farm. +> The Frontends, Farms and Servers are specific to the protocol (HTTP, TCP or UDP) in which they are defined. +> Compatibility between these components is only possible within the same protocol. +> For example, an HTTP Frontend can only be paired with an HTTP Farm, and cannot be used with a UDP Farm. > -## Frontend - -> [!primary] +> [!warning] > -> As you can see, each category consists of 3 API functions. -> It is necessary to properly execute the API function that corresponds to the type of service you want. +> Each category that falls under Frontend, Farm and Server management consists of 3 API functions, one for each protocol (HTTP, TCP or UDP). +> You must execute the API function that corresponds to the specific protocol of the desired service. > +## Frontend + ### Return the list of IDs of existing frontends > [!api] @@ -79,12 +72,6 @@ For a complete reference to the API functions of the OVH Load Balancer service, ## Server farm -> [!primary] -> -> As for the frontend, each category is composed of 3 API functions. -> It is necessary to execute the API function that corresponds to the type of service desired. -> - ### Return the list of IDs of existing farms > [!api] @@ -132,12 +119,6 @@ For a complete reference to the API functions of the OVH Load Balancer service, ## Server -> [!primary] -> -> As for the frontend and farm, each category is composed of 3 API functions. -> It is necessary to properly execute the API function that corresponds to the type of the desired service. -> - ### Return the list of server IDs linked to a particular farm > [!api] diff --git a/pages/network/load_balancer/use_api_reference/guide.en-gb.md b/pages/network/load_balancer/use_api_reference/guide.en-gb.md index 359ae47ca4f..f0d6b0b6195 100644 --- a/pages/network/load_balancer/use_api_reference/guide.en-gb.md +++ b/pages/network/load_balancer/use_api_reference/guide.en-gb.md @@ -1,37 +1,30 @@ --- title: Load Balancer API Quick Reference excerpt: Quick description of the different API functions used to manage the Load Balancer -updated: 2022-04-04 +updated: 2025-09-26 --- ## List of API functions -This section briefly describes the main functions of the API for the OVH Load Balancer under /ipLoadbalancing -> [!warning] -> -> Attention, for compatibility reasons the entry point of the old OVH Load Balancer system is still present in the /ip/loadBalancing API, not to be confused with the new /ipLoadbalancing. -> +This section briefly describes the main functions of the API for the OVHcloud Load Balancer under /ipLoadbalancing. -For a complete reference to the API functions of the OVH Load Balancer service, it's [here](/pages/network/load_balancer/use_api_details). +For a comprehensive reference to the API functions of the OVHcloud Load Balancer service, please consult [this detailed guide](/pages/network/load_balancer/use_api_details). > [!primary] > -> The Frontend, Farm and Server are specific to the -> protocol (among HTTP, TCP or UDP) in which they are defined. -> Although they can be "combined" with each other, this is only possible within the same protocol. -> of the same protocol. Thus, it is not possible to use a Frontend -> UDP with an HTTP Farm. But it is possible (in the absence of other -> limitation) to use an HTTP Frontend with an HTTP Farm. +> The Frontends, Farms and Servers are specific to the protocol (HTTP, TCP or UDP) in which they are defined. +> Compatibility between these components is only possible within the same protocol. +> For example, an HTTP Frontend can only be paired with an HTTP Farm, and cannot be used with a UDP Farm. > -## Frontend - -> [!primary] +> [!warning] > -> As you can see, each category consists of 3 API functions. -> It is necessary to properly execute the API function that corresponds to the type of service you want. +> Each category that falls under Frontend, Farm and Server management consists of 3 API functions, one for each protocol (HTTP, TCP or UDP). +> You must execute the API function that corresponds to the specific protocol of the desired service. > +## Frontend + ### Return the list of IDs of existing frontends > [!api] @@ -79,12 +72,6 @@ For a complete reference to the API functions of the OVH Load Balancer service, ## Server farm -> [!primary] -> -> As for the frontend, each category is composed of 3 API functions. -> It is necessary to execute the API function that corresponds to the type of service desired. -> - ### Return the list of IDs of existing farms > [!api] @@ -132,12 +119,6 @@ For a complete reference to the API functions of the OVH Load Balancer service, ## Server -> [!primary] -> -> As for the frontend and farm, each category is composed of 3 API functions. -> It is necessary to properly execute the API function that corresponds to the type of the desired service. -> - ### Return the list of server IDs linked to a particular farm > [!api] diff --git a/pages/network/load_balancer/use_api_reference/guide.en-sg.md b/pages/network/load_balancer/use_api_reference/guide.en-sg.md index 359ae47ca4f..7e41b1b9271 100644 --- a/pages/network/load_balancer/use_api_reference/guide.en-sg.md +++ b/pages/network/load_balancer/use_api_reference/guide.en-sg.md @@ -1,37 +1,30 @@ --- title: Load Balancer API Quick Reference excerpt: Quick description of the different API functions used to manage the Load Balancer -updated: 2022-04-04 +updated: 2025-09-29 --- ## List of API functions -This section briefly describes the main functions of the API for the OVH Load Balancer under /ipLoadbalancing -> [!warning] -> -> Attention, for compatibility reasons the entry point of the old OVH Load Balancer system is still present in the /ip/loadBalancing API, not to be confused with the new /ipLoadbalancing. -> +This section briefly describes the main functions of the API for the OVHcloud Load Balancer under /ipLoadbalancing. -For a complete reference to the API functions of the OVH Load Balancer service, it's [here](/pages/network/load_balancer/use_api_details). +For a comprehensive reference to the API functions of the OVHcloud Load Balancer service, please consult [this detailed guide](/pages/network/load_balancer/use_api_details). > [!primary] > -> The Frontend, Farm and Server are specific to the -> protocol (among HTTP, TCP or UDP) in which they are defined. -> Although they can be "combined" with each other, this is only possible within the same protocol. -> of the same protocol. Thus, it is not possible to use a Frontend -> UDP with an HTTP Farm. But it is possible (in the absence of other -> limitation) to use an HTTP Frontend with an HTTP Farm. +> The Frontends, Farms and Servers are specific to the protocol (HTTP, TCP or UDP) in which they are defined. +> Compatibility between these components is only possible within the same protocol. +> For example, an HTTP Frontend can only be paired with an HTTP Farm, and cannot be used with a UDP Farm. > -## Frontend - -> [!primary] +> [!warning] > -> As you can see, each category consists of 3 API functions. -> It is necessary to properly execute the API function that corresponds to the type of service you want. +> Each category that falls under Frontend, Farm and Server management consists of 3 API functions, one for each protocol (HTTP, TCP or UDP). +> You must execute the API function that corresponds to the specific protocol of the desired service. > +## Frontend + ### Return the list of IDs of existing frontends > [!api] @@ -79,12 +72,6 @@ For a complete reference to the API functions of the OVH Load Balancer service, ## Server farm -> [!primary] -> -> As for the frontend, each category is composed of 3 API functions. -> It is necessary to execute the API function that corresponds to the type of service desired. -> - ### Return the list of IDs of existing farms > [!api] @@ -132,12 +119,6 @@ For a complete reference to the API functions of the OVH Load Balancer service, ## Server -> [!primary] -> -> As for the frontend and farm, each category is composed of 3 API functions. -> It is necessary to properly execute the API function that corresponds to the type of the desired service. -> - ### Return the list of server IDs linked to a particular farm > [!api] diff --git a/pages/network/load_balancer/use_api_reference/guide.en-us.md b/pages/network/load_balancer/use_api_reference/guide.en-us.md index 359ae47ca4f..7e41b1b9271 100644 --- a/pages/network/load_balancer/use_api_reference/guide.en-us.md +++ b/pages/network/load_balancer/use_api_reference/guide.en-us.md @@ -1,37 +1,30 @@ --- title: Load Balancer API Quick Reference excerpt: Quick description of the different API functions used to manage the Load Balancer -updated: 2022-04-04 +updated: 2025-09-29 --- ## List of API functions -This section briefly describes the main functions of the API for the OVH Load Balancer under /ipLoadbalancing -> [!warning] -> -> Attention, for compatibility reasons the entry point of the old OVH Load Balancer system is still present in the /ip/loadBalancing API, not to be confused with the new /ipLoadbalancing. -> +This section briefly describes the main functions of the API for the OVHcloud Load Balancer under /ipLoadbalancing. -For a complete reference to the API functions of the OVH Load Balancer service, it's [here](/pages/network/load_balancer/use_api_details). +For a comprehensive reference to the API functions of the OVHcloud Load Balancer service, please consult [this detailed guide](/pages/network/load_balancer/use_api_details). > [!primary] > -> The Frontend, Farm and Server are specific to the -> protocol (among HTTP, TCP or UDP) in which they are defined. -> Although they can be "combined" with each other, this is only possible within the same protocol. -> of the same protocol. Thus, it is not possible to use a Frontend -> UDP with an HTTP Farm. But it is possible (in the absence of other -> limitation) to use an HTTP Frontend with an HTTP Farm. +> The Frontends, Farms and Servers are specific to the protocol (HTTP, TCP or UDP) in which they are defined. +> Compatibility between these components is only possible within the same protocol. +> For example, an HTTP Frontend can only be paired with an HTTP Farm, and cannot be used with a UDP Farm. > -## Frontend - -> [!primary] +> [!warning] > -> As you can see, each category consists of 3 API functions. -> It is necessary to properly execute the API function that corresponds to the type of service you want. +> Each category that falls under Frontend, Farm and Server management consists of 3 API functions, one for each protocol (HTTP, TCP or UDP). +> You must execute the API function that corresponds to the specific protocol of the desired service. > +## Frontend + ### Return the list of IDs of existing frontends > [!api] @@ -79,12 +72,6 @@ For a complete reference to the API functions of the OVH Load Balancer service, ## Server farm -> [!primary] -> -> As for the frontend, each category is composed of 3 API functions. -> It is necessary to execute the API function that corresponds to the type of service desired. -> - ### Return the list of IDs of existing farms > [!api] @@ -132,12 +119,6 @@ For a complete reference to the API functions of the OVH Load Balancer service, ## Server -> [!primary] -> -> As for the frontend and farm, each category is composed of 3 API functions. -> It is necessary to properly execute the API function that corresponds to the type of the desired service. -> - ### Return the list of server IDs linked to a particular farm > [!api] diff --git a/pages/network/load_balancer/use_api_reference/guide.fr-ca.md b/pages/network/load_balancer/use_api_reference/guide.fr-ca.md index 304a91280e9..82ce685a323 100644 --- a/pages/network/load_balancer/use_api_reference/guide.fr-ca.md +++ b/pages/network/load_balancer/use_api_reference/guide.fr-ca.md @@ -1,38 +1,28 @@ --- title: Référence Rapide API Load Balancer excerpt: Description rapide des différentes fonctions de l’API servant à gérer le Load Balancer -updated: 2022-04-04 +updated: 2025-09-29 --- -## Liste des fonctions API -Cette section décrit brièvement les principales fonctions de l'API pour l'OVH Load Balancer sous /ipLoadbalancing +Cette section décrit brièvement les principales fonctions de l'API pour l'OVHcloud Load Balancer, sous /ipLoadbalancing. -> [!warning] -> -> Attention, pour des raisons de compatibilité le point d'entrée de l'ancien système OVH Load Balancer est toujours présent dans l'API /ip/loadBalancing , à ne pas confondre avec le nouveau /ipLoadbalancing. -> - -Pour une référence complète aux fonctions de l'API du service OVH Load Balancer, c'est [ici](/pages/network/load_balancer/use_api_details). +Pour une référence complète des fonctions de l'API du service OVHcloud Load Balancer, veuillez consulter [ce guide détaillé](/pages/network/load_balancer/use_api_details). > [!primary] > -> Les Frontend, Ferme et Serveur sont spécifiques au -> protocole (parmis HTTP, TCP ou UDP) dans lequel ils sont définis. -> Bien qu'ils puissent être "combinés" entre eux, ce n'est possible qu'au sein -> d'un même protocole. Ainsi, il n'est pas possible d'utiliser un Frontend -> UDP avec une Ferme HTTP. Mais il est possible (en l'absence d'autre -> limitation) d'utiliser un Frontend HTTP avec une Ferme HTTP. +> Les frontends, fermes et serveurs sont spécifiques au protocole (HTTP, TCP ou UDP) dans lequel ils sont définies. +> La compatibilité entre ces composants n'est possible qu'au sein du même protocole. +> Par exemple, un frontend HTTP ne peut être associé qu'à une ferme HTTP, et ne peut pas être utilisé avec une ferme UDP. > -## Frontend - -> [!primary] +> [!warning] > -> Comme vous pouvez le constater, chaque catégorie se compose de 3 fonctions API. -> Il est nécessaire de bien exécuter la fonction API qui correspond au type de service souhaité. -> +> Chaque catégorie relevant de la gestion des frontends, des fermes et des serveurs se compose de 3 fonctions API, une pour chaque protocole (HTTP, TCP ou UDP). +> Il est nécessaire de bien exécuter la fonction API qui correspond au protocole du service souhaité. + +## Frontend -### Retourne la liste des IDs des frontends existants +### Retourner la liste des IDs des frontends existants > [!api] > @@ -41,7 +31,7 @@ Pour une référence complète aux fonctions de l'API du service OVH Load Balanc > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend > -### Crée un frontend +### Créer un frontend > [!api] > @@ -50,7 +40,7 @@ Pour une référence complète aux fonctions de l'API du service OVH Load Balanc > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/frontend > -### Retourne les paramètres appliqués à un frontend +### Retourner les paramètres appliqués à un frontend > [!api] > @@ -59,7 +49,7 @@ Pour une référence complète aux fonctions de l'API du service OVH Load Balanc > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId} > -### Édite les paramètres relatifs à un frontend particulier +### Éditer les paramètres relatifs à un frontend en particulier > [!api] > @@ -68,7 +58,7 @@ Pour une référence complète aux fonctions de l'API du service OVH Load Balanc > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId} > -### Supprime un frontend +### Supprimer un frontend > [!api] > @@ -79,13 +69,7 @@ Pour une référence complète aux fonctions de l'API du service OVH Load Balanc ## Ferme de serveurs -> [!primary] -> -> Tout comme pour le frontend, chaque catégorie se compose de 3 fonctions API. -> Il est nécessaire de bien exécuter la fonction API qui correspond au type de service souhaité. -> - -### Retourne la liste des IDs des fermes existantes +### Retourner la liste des IDs des fermes existantes > [!api] > @@ -94,7 +78,7 @@ Pour une référence complète aux fonctions de l'API du service OVH Load Balanc > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm > -### Crée une ferme +### Créer une ferme > [!api] > @@ -103,7 +87,7 @@ Pour une référence complète aux fonctions de l'API du service OVH Load Balanc > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm > -### Retourne les paramètres appliqués à une ferme +### Retourner les paramètres appliqués à une ferme > [!api] > @@ -112,7 +96,7 @@ Pour une référence complète aux fonctions de l'API du service OVH Load Balanc > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId} > -### Édite les paramètres relatifs à une ferme particulière +### Éditer les paramètres relatifs à une ferme en particulier > [!api] > @@ -121,7 +105,7 @@ Pour une référence complète aux fonctions de l'API du service OVH Load Balanc > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId} > -### Supprime une ferme +### Supprimer une ferme > [!api] > @@ -132,13 +116,7 @@ Pour une référence complète aux fonctions de l'API du service OVH Load Balanc ## Serveur -> [!primary] -> -> Tout comme pour les frontend et ferme, chaque catégorie se compose de 3 fonctions API. -> Il est nécessaire de bien exécuter la fonction API qui correspond au type de service souhaité. -> - -### Retourne la liste des IDs des serveurs liés à une ferme particulière +### Retourner la liste des IDs des serveurs liés à une ferme en particulier > [!api] > @@ -147,7 +125,7 @@ Pour une référence complète aux fonctions de l'API du service OVH Load Balanc > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server > -### Crée un serveur pour une ferme particulière +### Créer un serveur pour une ferme en particulier > [!api] > @@ -156,7 +134,7 @@ Pour une référence complète aux fonctions de l'API du service OVH Load Balanc > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server > -### Retourne les paramètres d'un serveur particulier +### Retourner les paramètres d'un serveur en particulier > [!api] > @@ -165,7 +143,7 @@ Pour une référence complète aux fonctions de l'API du service OVH Load Balanc > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId} > -### Édite les paramètres d'un serveur particulier +### Éditer les paramètres d'un serveur en particulier > [!api] > @@ -174,7 +152,7 @@ Pour une référence complète aux fonctions de l'API du service OVH Load Balanc > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId} > -### Supprime un serveur +### Supprimer un serveur > [!api] > @@ -185,28 +163,28 @@ Pour une référence complète aux fonctions de l'API du service OVH Load Balanc ## Certificats SSL -### Retourne la liste des certificats SSL +### Retourner la liste des certificats SSL > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl > -### Crée un certificat SSL +### Créer un certificat SSL > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/ssl > -### Retourne les paramètres d'un certificat SSL en particulier +### Retourner les paramètres d'un certificat SSL en particulier > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl/{id} > -### Supprime un certificat SSL +### Supprimer un certificat SSL > [!api] > @@ -215,23 +193,27 @@ Pour une référence complète aux fonctions de l'API du service OVH Load Balanc ## Tâche -### Applique les changements à la configuration du Load Balancer +### Appliquer les changements à la configuration du Load Balancer > [!api] > > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh > -### Retourne la liste des IDs des tâches +### Retourner la liste des IDs des tâches > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task > -### Retourne le statut d'une tâche en particulier +### Retourner le statut d'une tâche en particulier > [!api] > > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task/{id} > + +## Aller plus loin + +Échangez avec notre [communauté d'utilisateurs](/links/community). diff --git a/pages/network/load_balancer/use_api_reference/guide.fr-fr.md b/pages/network/load_balancer/use_api_reference/guide.fr-fr.md index 6e8c8e6f441..d36f33eafe4 100644 --- a/pages/network/load_balancer/use_api_reference/guide.fr-fr.md +++ b/pages/network/load_balancer/use_api_reference/guide.fr-fr.md @@ -1,38 +1,27 @@ --- title: "Fonctionnalités principales de l'API Load Balancer" excerpt: "Description rapide des différentes fonctions de l’API servant à gérer le Load Balancer" -updated: 2022-04-04 +updated: 2025-09-29 --- -## Liste des fonctions API +Cette section décrit brièvement les principales fonctions de l'API pour l'OVHcloud Load Balancer, sous /ipLoadbalancing. -Cette section décrit brièvement les principales fonctions de l'API pour le Load Balancer OVHcloud, sous /ipLoadbalancing. +Pour une référence complète des fonctions de l'API du service OVHcloud Load Balancer, veuillez consulter [ce guide détaillé](/pages/network/load_balancer/use_api_details). -> [!warning] +> [!primary] > -> Attention, pour des raisons de compatibilité, le point d'entrée de l'ancien système OVHcloud Load Balancer est toujours présent dans l'API /ip/loadBalancing, à ne pas confondre avec le nouveau /ipLoadbalancing. +> Les frontends, fermes et serveurs sont spécifiques au protocole (HTTP, TCP ou UDP) dans lequel ils sont définies. +> La compatibilité entre ces composants n'est possible qu'au sein du même protocole. +> Par exemple, un frontend HTTP ne peut être associé qu'à une ferme HTTP, et ne peut pas être utilisé avec une ferme UDP. > -Pour une référence complète des fonctions de l'API du service OVHcloud Load Balancer, [cliquez ici](/pages/network/load_balancer/use_api_details). - -> [!primary] +> [!warning] > -> Les frontend, ferme et serveur sont spécifiques au -> protocole (parmi HTTP, TCP ou UDP) dans lequel ils sont définis. -> Bien qu'ils puissent être « combinés » entre eux, ce n'est possible qu'au sein -> d'un même protocole. Ainsi, il n'est pas possible d'utiliser un frontend -> UDP avec une ferme HTTP. Mais il est possible (en l'absence d'autres -> limitations) d'utiliser un frontend HTTP avec une ferme HTTP. -> +> Chaque catégorie relevant de la gestion des frontends, des fermes et des serveurs se compose de 3 fonctions API, une pour chaque protocole (HTTP, TCP ou UDP). +> Il est nécessaire de bien exécuter la fonction API qui correspond au protocole du service souhaité. ## Frontend -> [!primary] -> -> Comme vous pouvez le constater, chaque catégorie se compose de 3 fonctions API. -> Il est nécessaire de bien exécuter la fonction API qui correspond au type de service souhaité. -> - ### Retourner la liste des IDs des frontends existants > [!api] @@ -80,12 +69,6 @@ Pour une référence complète des fonctions de l'API du service OVHcloud Load B ## Ferme de serveurs -> [!primary] -> -> Tout comme pour le frontend, chaque catégorie se compose de 3 fonctions API. -> Il est nécessaire de bien exécuter la fonction API qui correspond au type de service souhaité. -> - ### Retourner la liste des IDs des fermes existantes > [!api] @@ -133,12 +116,6 @@ Pour une référence complète des fonctions de l'API du service OVHcloud Load B ## Serveur -> [!primary] -> -> Tout comme pour les frontend et ferme, chaque catégorie se compose de 3 fonctions API. -> Il est nécessaire de bien exécuter la fonction API qui correspond au type de service souhaité. -> - ### Retourner la liste des IDs des serveurs liés à une ferme en particulier > [!api] diff --git a/pages/network/load_balancer/use_presentation/guide.de-de.md b/pages/network/load_balancer/use_presentation/guide.de-de.md index 744ce71274b..35126348ebc 100644 --- a/pages/network/load_balancer/use_presentation/guide.de-de.md +++ b/pages/network/load_balancer/use_presentation/guide.de-de.md @@ -1,120 +1,108 @@ --- -title: Einführung zum OVH Loadbalancer -excerpt: In dieser Anleitung erhalten Sie einen ersten Überblick über die neue OVH Loadbalancer Lösung -updated: 2018-01-17 +title: Introduction to the OVHcloud Load Balancer +excerpt: Discover the OVHcloud Load Balancer solution for distributing and securing your traffic +updated: 2025-10-29 --- -## Einleitung +## Objective -Unser neues **OVH Loadbalancer** Angebot dient der Lastverteilung (engl. Load Balancing) und verbindet eine einfache Konfiguration mit maximaler Zuverlässigkeit. Konfigurieren Sie einfach Ihre Produkte mit dem OVH Loadbalancer. Wir kümmern uns um den Rest. +The **OVHcloud Load Balancer** is a fully managed service designed to ensure high availability, performance, and scalability for your applications. +Its main role is to distribute workloads across several servers or applications. +Simply configure your services behind the Load Balancer — OVHcloud handles redundancy, security, and global traffic distribution. -**Erfahren Sie jetzt alles Wichtige zum neuen OVH Loadbalancer Angebot.** +## Requirements -## Voraussetzungen +- Access to the [OVHcloud Control Panel](/links/manager) +- At least one service to balance (Dedicated Server, VPS, Public Cloud instance, etc.) -- Keine spezifischen Voraussetzungen +## Instructions -## Beschreibung +The Load Balancer leverages **industry-standard open-source technologies** to handle different traffic types: - -Dieses neue Angebot basiert auf bewährten Open-Source-Lösungen: HAProxy für TCP-Traffic und Nginx für UDP-Traffic. +| Type | Description | Advantages | Technology | +|---|---|---|---| +| HTTP/HTTPS | All web services and APIs | Optimized for L7 (application layer) processing, URL redirection, headers, ACLs | HAProxy | +| TCP | Non-HTTP network services | Supports all TCP applications | HAProxy | +| UDP | All UDP traffic | Supports all UDP applications | Nginx | -Der OVH Loadbalancer bietet Ihnen Lastverteilung ohne Limits und funktioniert problemlos mit verschiedenen Protokollen: +### Key Features -|Typ|Beschreibung|Vorteile|Technologie| -|---|---|---|---| -|HTTP|Für alle Webservices mit HTTP/HTTPS|Optimiert für L7-Verarbeitung (Anwendungsebene)|HAProxy| -|TCP|Für alle Netzwerkdienste, die kein HTTP verwenden|Unterstützt alle TCP-Anwendungen|HAProxy| -|UDP|Für alle Arten von UDP-Traffic|Unterstützt alle UDP-Anwendungen|Nginx| +- **Built-in DDoS protection** across all traffic types +- **Global Anycast network** for optimal latency and failover +- **Advanced HTTP/HTTPS support**: redirections, headers, ACLs, etc. +- **Additional IP and vRack compatibility**: improve availability and performance with advanced networking +- **High availability**: isolated redundant instances ensure resilience +- **Scalability**: add or remove servers and farms without downtime -Folgende Leistungen sind bei dem neuen Dienst inklusive: +### Architecture Overview - - OVH DDoS-Schutz - - Unterstützung verschiedener geografischer Zonen (Anycast) - - erweiterte HTTP/HTTPS-Funktionen (Weiterleitungen, Header, ACL, …) - - kompatibel mit Additional IP - - vRack Unterstützung - - Redundanz: Ihr OVH Loadbalancer läuft auf isolierten Instanzen, die ihrerseits auf komplett getrennter und redundanter Hardware laufen +The Load Balancer consists of three main components: -### Grundbestandteile +| Component | Function | +|---|---| +| **Front-end** | Defines the entry protocol (HTTP/TCP/UDP) and listening port | +| **Farm** | Distributes traffic from the front-end across servers | +| **Server** | Handles inbound and outbound application traffic | -- Das neue OVH Loadbalancer Angebot besteht aus drei wesentlichen Komponenten: +![General diagram](images/diag_gen2025.png){.thumbnail} -![Allgemein](images/diag_gen.png){.thumbnail} +## Benefits -|Komponente|Funktion| -|---|---| -|Frontend|Das Frontend bestimmt den Protokolltyp (HTTP/TCP/UDP) des OVH Loadbalancers. Außerdem enthält es den Listening-Port des Dienstes.| -|Farm|Die Farm empfängt den Traffic des Frontends und ist zuständig für die eigentliche Lastverteilung| -|Server|Die Server erhalten den verteilten Traffic und antworten über die Applikation| +### Balance and Scale Seamlessly -Mit diesen drei Grundbestandteilen, die gemeinsam den Loadbalancer bilden, können fast alle möglichen Loadbalancing-Methoden konfiguriert werden. +Distribute workloads across multiple servers and scale horizontally without service interruption. -### Was spricht für die Verwendung des OVH Loadbalancers? +![Balance the load](images/distribute_load2025.png){.thumbnail} -#### Traffic-Last verteilen +### High Availability and Uptime -Dies ist die zentrale Funktion eines jeden Lastverteilers, der OVH Loadbalancer kann jedoch viel mehr. +Automatic health checks detect unresponsive servers and reroute traffic instantly, minimizing downtime. -![Traffic-Last verteilen](images/distribute_load.png){.thumbnail} +![Eliminate downtime](images/eliminate_downtimes2025.png){.thumbnail} -#### Downtime verhindern +### Simplified Maintenance -Der OVH Loadbalancer erkennt automatisch, wenn ein Server nicht antwortet. In diesem Fall leitet er wenn möglich den für den betroffenen Server bestimmten Traffic auf einen anderen Server weiter. So wird das Problem behoben, ohne Ihre Webdienste zu beeinträchtigen. +Place a farm or server in downtime mode for maintenance without impacting users, then reintegrate it seamlessly. -![Downtimes verhindern](images/eliminate_downtimes.png){.thumbnail} +![Make maintenance easier](images/facilitate_maintenance2025.png){.thumbnail} -#### Ihre Infrastruktur nach Bedarf skalieren +### Service Integration -Sie können jederzeit und ohne Dienstunterbrechung Farmen, Frontends oder Server zu Ihrem OVH Loadbalancer hinzufügen oder entfernen. +Easily combine with other OVHcloud services: -![Ihre Infrastruktur flexibel skalieren](images/facilitate_maintenance.png){.thumbnail} +- Public Cloud instances +- VPS +- Dedicated Servers +- vRack private networking -#### Wartungen vereinfachen +![Combine your services](images/mix_and_match2025.png){.thumbnail} -Für geplante Wartungen Ihrer Infrastruktur können Sie eine Farm ganz einfach in Downtime setzen, damit sie vorübergehend keinen Datenverkehr mehr empfängt. So können Sie leicht eingreifen und Ihren Server wieder hinzufügen, sobald die Wartung abgeschlossen ist. +### Geographic Distribution (Anycast) -![Wartungen vereinfachen](images/scale_easily.png){.thumbnail} +Serve users worldwide with low latency and resilient routing. -#### Dienste kombinieren +![Anycast](images/anycast2025.png){.thumbnail} -Sie können verschiedene OVH Dienstleistungen im Loadbalancer kombinieren, zum Beispiel: +### Versatile Use Cases -- Public Cloud Instanzen mit Additional IP -- VPS mit Additional IP -- Dedicated Server mit Additional IP -- vRack +Support multiple services over HTTP(S), TCP, and UDP traffic. -![Dienste kombinieren](images/mix_and_match.png){.thumbnail} +#### Email server -#### Anycast +Balance the load between your email servers. -Sie können die Last auf verschiedene geografische Zonen verteilen: +![Mail](images/mail2025.png){.thumbnail} -![Anycast](images/anycast.png){.thumbnail} +#### Databases -#### Jede Art von Traffic verteilen +Balance your databases, and make them redundant. -Der OVH Loadbalancer ist nicht länger auf HTTP-Traffic begrenzt. Sie können ihn auch für alle Arten von TCP- oder UDP-Traffic verwenden. +![Databases](images/database2025.png){.thumbnail} -#### E-Mail-Server +## Go Further -Verteilen Sie die Last zwischen Ihren E-Mail-Servern: +- [Find out more about load balancing (Wikipedia)](https://en.wikipedia.org/wiki/Load_balancing) +- [HAProxy official site](http://www.haproxy.org/#desc) +- [Nginx documentation](https://nginx.org/en/docs/) -![E-Mail](images/mail.png){.thumbnail} - -#### Datenbanken - -Sorgen Sie für gleichmäßige Verteilung und Redundanz Ihrer Datenbanken: - -![Database](images/database.png){.thumbnail} - -## Weiterführende Informationen - -[Mehr zum Thema Lastverteilung](http://ovh.to/PhFmeK8). - -[Mehr zum Thema HAProxy](http://www.haproxy.org/#desc). - -[Mehr zum Thema Nginx](https://de.wikipedia.org/wiki/Nginx). - -Für den Austausch mit unserer User Community gehen Sie auf . \ No newline at end of file +Join our [community of users](/links/community). diff --git a/pages/network/load_balancer/use_presentation/guide.en-asia.md b/pages/network/load_balancer/use_presentation/guide.en-asia.md index e15353f8b0e..35126348ebc 100644 --- a/pages/network/load_balancer/use_presentation/guide.en-asia.md +++ b/pages/network/load_balancer/use_presentation/guide.en-asia.md @@ -1,119 +1,108 @@ --- -title: Introduction to the OVHcloud Load Balancer -excerpt: Find out more about the OVHcloud Load Balancer solution -updated: 2018-01-17 +title: Introduction to the OVHcloud Load Balancer +excerpt: Discover the OVHcloud Load Balancer solution for distributing and securing your traffic +updated: 2025-10-29 --- ## Objective -The new **OVHcloud Load Balancer** is a reliable service, with versatile configurations. You just need to configure your products with the OVHcloud Load Balancer, and we’ll take care of the rest. - -**Find out more about the brand-new OVHcloud Load Balancer solution.** +The **OVHcloud Load Balancer** is a fully managed service designed to ensure high availability, performance, and scalability for your applications. +Its main role is to distribute workloads across several servers or applications. +Simply configure your services behind the Load Balancer — OVHcloud handles redundancy, security, and global traffic distribution. ## Requirements -- No specific requirements. +- Access to the [OVHcloud Control Panel](/links/manager) +- At least one service to balance (Dedicated Server, VPS, Public Cloud instance, etc.) ## Instructions -This new solution is based on robust open-source solutions: HAProxy for TCP traffic, and Nginx for UDP traffic. - -There are no limits to what you can do! The new OVHcloud Load Balancer solution can be used to work with a variety of protocols: +The Load Balancer leverages **industry-standard open-source technologies** to handle different traffic types: -|Type|Description|Advantages|Technology| +| Type | Description | Advantages | Technology | |---|---|---|---| -|HTTP|All HTTP/HTTPS web services|Optimised for L7 (application layer) processing|HAProxy| -|TCP|For any network services that aren’t HTTP|Supports all TCP applications|HAProxy| -|UDP|For all UDP traffic types|Supports all UDP applications|Nginx| +| HTTP/HTTPS | All web services and APIs | Optimized for L7 (application layer) processing, URL redirection, headers, ACLs | HAProxy | +| TCP | Non-HTTP network services | Supports all TCP applications | HAProxy | +| UDP | All UDP traffic | Supports all UDP applications | Nginx | -With this new solution, you will get: +### Key Features -- OVHcloud anti-DDoS protection -- your services replicated worldwide (Anycast) -- advanced HTTP/HTTPS support (redirections, headers, ACL, etc.) -- a service compatible with an Additional IP -- vRack supported -- redundancy - your Load Balancer functions on separate instances, working individually on isolated, redundant hardware +- **Built-in DDoS protection** across all traffic types +- **Global Anycast network** for optimal latency and failover +- **Advanced HTTP/HTTPS support**: redirections, headers, ACLs, etc. +- **Additional IP and vRack compatibility**: improve availability and performance with advanced networking +- **High availability**: isolated redundant instances ensure resilience +- **Scalability**: add or remove servers and farms without downtime -### Basic parts +### Architecture Overview -- The new OVHcloud Load Balancer solution is made up of three basic parts: +The Load Balancer consists of three main components: -![General](images/diag_gen.png){.thumbnail} - -|Basic parts|Function| +| Component | Function | |---|---| -|Front-end|The front-end defines the protocol type (HTTP/TCP/UDP) of the OVHcloud Load Balancer service. This part also has the service’s listening port| -|Farm|The farm receives the incoming traffic from the front-end. This part takes care of the load balancing| -|Server|These are the servers that receive the final traffic, and respond via the application| - -With these three basic parts that make up the Load Balancer, you can configure it to use nearly all possible load balancing methods. +| **Front-end** | Defines the entry protocol (HTTP/TCP/UDP) and listening port | +| **Farm** | Distributes traffic from the front-end across servers | +| **Server** | Handles inbound and outbound application traffic | -### Why use the OVHcloud Load Balancer? +![General diagram](images/diag_gen2025.png){.thumbnail} -#### Balance the load +## Benefits -This is the basic function of a load balancer, but the OVHcloud Load Balancer offers much more. +### Balance and Scale Seamlessly -![Balance the load](images/distribute_load.png){.thumbnail} +Distribute workloads across multiple servers and scale horizontally without service interruption. -#### Eliminate downtime +![Balance the load](images/distribute_load2025.png){.thumbnail} -The OVHcloud Load Balancer service can automatically detect when a server is not responding. When this happens, it redirects incoming traffic to another server, if possible. This resolves the problem without affecting your website. +### High Availability and Uptime -![Eliminate downtime](images/eliminate_downtimes.png){.thumbnail} +Automatic health checks detect unresponsive servers and reroute traffic instantly, minimizing downtime. -#### Scale your infrastructure easily +![Eliminate downtime](images/eliminate_downtimes2025.png){.thumbnail} -You can add or remove farms, front-ends or servers from the OVHcloud Load Balancer solution without interrupting your service. +### Simplified Maintenance -![Scale your infrastructure easily](images/facilitate_maintenance.png){.thumbnail} +Place a farm or server in downtime mode for maintenance without impacting users, then reintegrate it seamlessly. -#### Make maintenance easier +![Make maintenance easier](images/facilitate_maintenance2025.png){.thumbnail} -If there is any maintenance scheduled for your solution, you can now easily place a farm in downtime mode to prevent it from receiving traffic. If you need to do this, it’s easy to add your server again once the maintenance has finished. +### Service Integration -![Make maintenance easier](images/scale_easily.png){.thumbnail} +Easily combine with other OVHcloud services: -#### Combine your services +- Public Cloud instances +- VPS +- Dedicated Servers +- vRack private networking -You can now combine various OVHcloud services in the Load Balancer, for example: +![Combine your services](images/mix_and_match2025.png){.thumbnail} -- Public Cloud instances with Additional IPs -- VPS with Additional IPs -- Dedicated servers with Additional IPs -- vRacks +### Geographic Distribution (Anycast) -![Combine your services](images/mix_and_match.png){.thumbnail} +Serve users worldwide with low latency and resilient routing. -#### Anycast +![Anycast](images/anycast2025.png){.thumbnail} -You can balance your load across a variety of geographical zones. +### Versatile Use Cases -![Anycast](images/anycast.png){.thumbnail} - -#### Distribute any kind of traffic - -The OVHcloud Load Balancer doesn’t just work with HTTP traffic any more! You can now use it with all TCP and UDP traffic types. +Support multiple services over HTTP(S), TCP, and UDP traffic. #### Email server Balance the load between your email servers. -![Mail](images/mail.png){.thumbnail} +![Mail](images/mail2025.png){.thumbnail} #### Databases Balance your databases, and make them redundant. -![Databases](images/database.png){.thumbnail} - -## Go further - -[Find out more about load balancing](https://en.wikipedia.org/wiki/Load_balancing). +![Databases](images/database2025.png){.thumbnail} -[Find out more about HAProxy](http://www.haproxy.org/#desc). +## Go Further -[Find out more about Nginx](https://en.wikipedia.org/wiki/Nginx). +- [Find out more about load balancing (Wikipedia)](https://en.wikipedia.org/wiki/Load_balancing) +- [HAProxy official site](http://www.haproxy.org/#desc) +- [Nginx documentation](https://nginx.org/en/docs/) -Join our community of users on . +Join our [community of users](/links/community). diff --git a/pages/network/load_balancer/use_presentation/guide.en-au.md b/pages/network/load_balancer/use_presentation/guide.en-au.md index e15353f8b0e..35126348ebc 100644 --- a/pages/network/load_balancer/use_presentation/guide.en-au.md +++ b/pages/network/load_balancer/use_presentation/guide.en-au.md @@ -1,119 +1,108 @@ --- -title: Introduction to the OVHcloud Load Balancer -excerpt: Find out more about the OVHcloud Load Balancer solution -updated: 2018-01-17 +title: Introduction to the OVHcloud Load Balancer +excerpt: Discover the OVHcloud Load Balancer solution for distributing and securing your traffic +updated: 2025-10-29 --- ## Objective -The new **OVHcloud Load Balancer** is a reliable service, with versatile configurations. You just need to configure your products with the OVHcloud Load Balancer, and we’ll take care of the rest. - -**Find out more about the brand-new OVHcloud Load Balancer solution.** +The **OVHcloud Load Balancer** is a fully managed service designed to ensure high availability, performance, and scalability for your applications. +Its main role is to distribute workloads across several servers or applications. +Simply configure your services behind the Load Balancer — OVHcloud handles redundancy, security, and global traffic distribution. ## Requirements -- No specific requirements. +- Access to the [OVHcloud Control Panel](/links/manager) +- At least one service to balance (Dedicated Server, VPS, Public Cloud instance, etc.) ## Instructions -This new solution is based on robust open-source solutions: HAProxy for TCP traffic, and Nginx for UDP traffic. - -There are no limits to what you can do! The new OVHcloud Load Balancer solution can be used to work with a variety of protocols: +The Load Balancer leverages **industry-standard open-source technologies** to handle different traffic types: -|Type|Description|Advantages|Technology| +| Type | Description | Advantages | Technology | |---|---|---|---| -|HTTP|All HTTP/HTTPS web services|Optimised for L7 (application layer) processing|HAProxy| -|TCP|For any network services that aren’t HTTP|Supports all TCP applications|HAProxy| -|UDP|For all UDP traffic types|Supports all UDP applications|Nginx| +| HTTP/HTTPS | All web services and APIs | Optimized for L7 (application layer) processing, URL redirection, headers, ACLs | HAProxy | +| TCP | Non-HTTP network services | Supports all TCP applications | HAProxy | +| UDP | All UDP traffic | Supports all UDP applications | Nginx | -With this new solution, you will get: +### Key Features -- OVHcloud anti-DDoS protection -- your services replicated worldwide (Anycast) -- advanced HTTP/HTTPS support (redirections, headers, ACL, etc.) -- a service compatible with an Additional IP -- vRack supported -- redundancy - your Load Balancer functions on separate instances, working individually on isolated, redundant hardware +- **Built-in DDoS protection** across all traffic types +- **Global Anycast network** for optimal latency and failover +- **Advanced HTTP/HTTPS support**: redirections, headers, ACLs, etc. +- **Additional IP and vRack compatibility**: improve availability and performance with advanced networking +- **High availability**: isolated redundant instances ensure resilience +- **Scalability**: add or remove servers and farms without downtime -### Basic parts +### Architecture Overview -- The new OVHcloud Load Balancer solution is made up of three basic parts: +The Load Balancer consists of three main components: -![General](images/diag_gen.png){.thumbnail} - -|Basic parts|Function| +| Component | Function | |---|---| -|Front-end|The front-end defines the protocol type (HTTP/TCP/UDP) of the OVHcloud Load Balancer service. This part also has the service’s listening port| -|Farm|The farm receives the incoming traffic from the front-end. This part takes care of the load balancing| -|Server|These are the servers that receive the final traffic, and respond via the application| - -With these three basic parts that make up the Load Balancer, you can configure it to use nearly all possible load balancing methods. +| **Front-end** | Defines the entry protocol (HTTP/TCP/UDP) and listening port | +| **Farm** | Distributes traffic from the front-end across servers | +| **Server** | Handles inbound and outbound application traffic | -### Why use the OVHcloud Load Balancer? +![General diagram](images/diag_gen2025.png){.thumbnail} -#### Balance the load +## Benefits -This is the basic function of a load balancer, but the OVHcloud Load Balancer offers much more. +### Balance and Scale Seamlessly -![Balance the load](images/distribute_load.png){.thumbnail} +Distribute workloads across multiple servers and scale horizontally without service interruption. -#### Eliminate downtime +![Balance the load](images/distribute_load2025.png){.thumbnail} -The OVHcloud Load Balancer service can automatically detect when a server is not responding. When this happens, it redirects incoming traffic to another server, if possible. This resolves the problem without affecting your website. +### High Availability and Uptime -![Eliminate downtime](images/eliminate_downtimes.png){.thumbnail} +Automatic health checks detect unresponsive servers and reroute traffic instantly, minimizing downtime. -#### Scale your infrastructure easily +![Eliminate downtime](images/eliminate_downtimes2025.png){.thumbnail} -You can add or remove farms, front-ends or servers from the OVHcloud Load Balancer solution without interrupting your service. +### Simplified Maintenance -![Scale your infrastructure easily](images/facilitate_maintenance.png){.thumbnail} +Place a farm or server in downtime mode for maintenance without impacting users, then reintegrate it seamlessly. -#### Make maintenance easier +![Make maintenance easier](images/facilitate_maintenance2025.png){.thumbnail} -If there is any maintenance scheduled for your solution, you can now easily place a farm in downtime mode to prevent it from receiving traffic. If you need to do this, it’s easy to add your server again once the maintenance has finished. +### Service Integration -![Make maintenance easier](images/scale_easily.png){.thumbnail} +Easily combine with other OVHcloud services: -#### Combine your services +- Public Cloud instances +- VPS +- Dedicated Servers +- vRack private networking -You can now combine various OVHcloud services in the Load Balancer, for example: +![Combine your services](images/mix_and_match2025.png){.thumbnail} -- Public Cloud instances with Additional IPs -- VPS with Additional IPs -- Dedicated servers with Additional IPs -- vRacks +### Geographic Distribution (Anycast) -![Combine your services](images/mix_and_match.png){.thumbnail} +Serve users worldwide with low latency and resilient routing. -#### Anycast +![Anycast](images/anycast2025.png){.thumbnail} -You can balance your load across a variety of geographical zones. +### Versatile Use Cases -![Anycast](images/anycast.png){.thumbnail} - -#### Distribute any kind of traffic - -The OVHcloud Load Balancer doesn’t just work with HTTP traffic any more! You can now use it with all TCP and UDP traffic types. +Support multiple services over HTTP(S), TCP, and UDP traffic. #### Email server Balance the load between your email servers. -![Mail](images/mail.png){.thumbnail} +![Mail](images/mail2025.png){.thumbnail} #### Databases Balance your databases, and make them redundant. -![Databases](images/database.png){.thumbnail} - -## Go further - -[Find out more about load balancing](https://en.wikipedia.org/wiki/Load_balancing). +![Databases](images/database2025.png){.thumbnail} -[Find out more about HAProxy](http://www.haproxy.org/#desc). +## Go Further -[Find out more about Nginx](https://en.wikipedia.org/wiki/Nginx). +- [Find out more about load balancing (Wikipedia)](https://en.wikipedia.org/wiki/Load_balancing) +- [HAProxy official site](http://www.haproxy.org/#desc) +- [Nginx documentation](https://nginx.org/en/docs/) -Join our community of users on . +Join our [community of users](/links/community). diff --git a/pages/network/load_balancer/use_presentation/guide.en-ca.md b/pages/network/load_balancer/use_presentation/guide.en-ca.md index e15353f8b0e..35126348ebc 100644 --- a/pages/network/load_balancer/use_presentation/guide.en-ca.md +++ b/pages/network/load_balancer/use_presentation/guide.en-ca.md @@ -1,119 +1,108 @@ --- -title: Introduction to the OVHcloud Load Balancer -excerpt: Find out more about the OVHcloud Load Balancer solution -updated: 2018-01-17 +title: Introduction to the OVHcloud Load Balancer +excerpt: Discover the OVHcloud Load Balancer solution for distributing and securing your traffic +updated: 2025-10-29 --- ## Objective -The new **OVHcloud Load Balancer** is a reliable service, with versatile configurations. You just need to configure your products with the OVHcloud Load Balancer, and we’ll take care of the rest. - -**Find out more about the brand-new OVHcloud Load Balancer solution.** +The **OVHcloud Load Balancer** is a fully managed service designed to ensure high availability, performance, and scalability for your applications. +Its main role is to distribute workloads across several servers or applications. +Simply configure your services behind the Load Balancer — OVHcloud handles redundancy, security, and global traffic distribution. ## Requirements -- No specific requirements. +- Access to the [OVHcloud Control Panel](/links/manager) +- At least one service to balance (Dedicated Server, VPS, Public Cloud instance, etc.) ## Instructions -This new solution is based on robust open-source solutions: HAProxy for TCP traffic, and Nginx for UDP traffic. - -There are no limits to what you can do! The new OVHcloud Load Balancer solution can be used to work with a variety of protocols: +The Load Balancer leverages **industry-standard open-source technologies** to handle different traffic types: -|Type|Description|Advantages|Technology| +| Type | Description | Advantages | Technology | |---|---|---|---| -|HTTP|All HTTP/HTTPS web services|Optimised for L7 (application layer) processing|HAProxy| -|TCP|For any network services that aren’t HTTP|Supports all TCP applications|HAProxy| -|UDP|For all UDP traffic types|Supports all UDP applications|Nginx| +| HTTP/HTTPS | All web services and APIs | Optimized for L7 (application layer) processing, URL redirection, headers, ACLs | HAProxy | +| TCP | Non-HTTP network services | Supports all TCP applications | HAProxy | +| UDP | All UDP traffic | Supports all UDP applications | Nginx | -With this new solution, you will get: +### Key Features -- OVHcloud anti-DDoS protection -- your services replicated worldwide (Anycast) -- advanced HTTP/HTTPS support (redirections, headers, ACL, etc.) -- a service compatible with an Additional IP -- vRack supported -- redundancy - your Load Balancer functions on separate instances, working individually on isolated, redundant hardware +- **Built-in DDoS protection** across all traffic types +- **Global Anycast network** for optimal latency and failover +- **Advanced HTTP/HTTPS support**: redirections, headers, ACLs, etc. +- **Additional IP and vRack compatibility**: improve availability and performance with advanced networking +- **High availability**: isolated redundant instances ensure resilience +- **Scalability**: add or remove servers and farms without downtime -### Basic parts +### Architecture Overview -- The new OVHcloud Load Balancer solution is made up of three basic parts: +The Load Balancer consists of three main components: -![General](images/diag_gen.png){.thumbnail} - -|Basic parts|Function| +| Component | Function | |---|---| -|Front-end|The front-end defines the protocol type (HTTP/TCP/UDP) of the OVHcloud Load Balancer service. This part also has the service’s listening port| -|Farm|The farm receives the incoming traffic from the front-end. This part takes care of the load balancing| -|Server|These are the servers that receive the final traffic, and respond via the application| - -With these three basic parts that make up the Load Balancer, you can configure it to use nearly all possible load balancing methods. +| **Front-end** | Defines the entry protocol (HTTP/TCP/UDP) and listening port | +| **Farm** | Distributes traffic from the front-end across servers | +| **Server** | Handles inbound and outbound application traffic | -### Why use the OVHcloud Load Balancer? +![General diagram](images/diag_gen2025.png){.thumbnail} -#### Balance the load +## Benefits -This is the basic function of a load balancer, but the OVHcloud Load Balancer offers much more. +### Balance and Scale Seamlessly -![Balance the load](images/distribute_load.png){.thumbnail} +Distribute workloads across multiple servers and scale horizontally without service interruption. -#### Eliminate downtime +![Balance the load](images/distribute_load2025.png){.thumbnail} -The OVHcloud Load Balancer service can automatically detect when a server is not responding. When this happens, it redirects incoming traffic to another server, if possible. This resolves the problem without affecting your website. +### High Availability and Uptime -![Eliminate downtime](images/eliminate_downtimes.png){.thumbnail} +Automatic health checks detect unresponsive servers and reroute traffic instantly, minimizing downtime. -#### Scale your infrastructure easily +![Eliminate downtime](images/eliminate_downtimes2025.png){.thumbnail} -You can add or remove farms, front-ends or servers from the OVHcloud Load Balancer solution without interrupting your service. +### Simplified Maintenance -![Scale your infrastructure easily](images/facilitate_maintenance.png){.thumbnail} +Place a farm or server in downtime mode for maintenance without impacting users, then reintegrate it seamlessly. -#### Make maintenance easier +![Make maintenance easier](images/facilitate_maintenance2025.png){.thumbnail} -If there is any maintenance scheduled for your solution, you can now easily place a farm in downtime mode to prevent it from receiving traffic. If you need to do this, it’s easy to add your server again once the maintenance has finished. +### Service Integration -![Make maintenance easier](images/scale_easily.png){.thumbnail} +Easily combine with other OVHcloud services: -#### Combine your services +- Public Cloud instances +- VPS +- Dedicated Servers +- vRack private networking -You can now combine various OVHcloud services in the Load Balancer, for example: +![Combine your services](images/mix_and_match2025.png){.thumbnail} -- Public Cloud instances with Additional IPs -- VPS with Additional IPs -- Dedicated servers with Additional IPs -- vRacks +### Geographic Distribution (Anycast) -![Combine your services](images/mix_and_match.png){.thumbnail} +Serve users worldwide with low latency and resilient routing. -#### Anycast +![Anycast](images/anycast2025.png){.thumbnail} -You can balance your load across a variety of geographical zones. +### Versatile Use Cases -![Anycast](images/anycast.png){.thumbnail} - -#### Distribute any kind of traffic - -The OVHcloud Load Balancer doesn’t just work with HTTP traffic any more! You can now use it with all TCP and UDP traffic types. +Support multiple services over HTTP(S), TCP, and UDP traffic. #### Email server Balance the load between your email servers. -![Mail](images/mail.png){.thumbnail} +![Mail](images/mail2025.png){.thumbnail} #### Databases Balance your databases, and make them redundant. -![Databases](images/database.png){.thumbnail} - -## Go further - -[Find out more about load balancing](https://en.wikipedia.org/wiki/Load_balancing). +![Databases](images/database2025.png){.thumbnail} -[Find out more about HAProxy](http://www.haproxy.org/#desc). +## Go Further -[Find out more about Nginx](https://en.wikipedia.org/wiki/Nginx). +- [Find out more about load balancing (Wikipedia)](https://en.wikipedia.org/wiki/Load_balancing) +- [HAProxy official site](http://www.haproxy.org/#desc) +- [Nginx documentation](https://nginx.org/en/docs/) -Join our community of users on . +Join our [community of users](/links/community). diff --git a/pages/network/load_balancer/use_presentation/guide.en-gb.md b/pages/network/load_balancer/use_presentation/guide.en-gb.md index 21397da777f..b52d318bdca 100644 --- a/pages/network/load_balancer/use_presentation/guide.en-gb.md +++ b/pages/network/load_balancer/use_presentation/guide.en-gb.md @@ -1,119 +1,108 @@ --- -title: Introduction to the OVH Load Balancer -excerpt: Find out more about the OVH Load Balancer solution -updated: 2018-01-17 +title: Introduction to the OVHcloud Load Balancer +excerpt: Discover the OVHcloud Load Balancer solution for distributing and securing your traffic +updated: 2025-10-29 --- ## Objective -The new **OVH Load Balancer** is a reliable service, with versatile configurations. You just need to configure your products with the OVH Load Balancer, and we’ll take care of the rest. - -**Find out more about the brand-new OVH Load Balancer solution.** +The **OVHcloud Load Balancer** is a fully managed service designed to ensure high availability, performance, and scalability for your applications. +Its main role is to distribute workloads across several servers or applications. +Simply configure your services behind the Load Balancer — OVHcloud handles redundancy, security, and global traffic distribution. ## Requirements -- No specific requirements. +- Access to the [OVHcloud Control Panel](/links/manager) +- At least one service to balance (Dedicated Server, VPS, Public Cloud instance, etc.) ## Instructions -This new solution is based on robust open-source solutions: HAProxy for TCP traffic, and Nginx for UDP traffic. - -There are no limits to what you can do! The new OVH Load Balancer solution can be used to work with a variety of protocols: +The Load Balancer leverages **industry-standard open-source technologies** to handle different traffic types: -|Type|Description|Advantages|Technology| +| Type | Description | Advantages | Technology | |---|---|---|---| -|HTTP|All HTTP/HTTPS web services|Optimised for L7 (application layer) processing|HAProxy| -|TCP|For any network services that aren’t HTTP|Supports all TCP applications|HAProxy| -|UDP|For all UDP traffic types|Supports all UDP applications|Nginx| +| HTTP/HTTPS | All web services and APIs | Optimized for L7 (application layer) processing, URL redirection, headers, ACLs | HAProxy | +| TCP | Non-HTTP network services | Supports all TCP applications | HAProxy | +| UDP | All UDP traffic | Supports all UDP applications | Nginx | -With this new solution, you will get: +### Key Features -- OVH anti-DDoS protection -- your services replicated worldwide (Anycast) -- advanced HTTP/HTTPS support (redirections, headers, ACL, etc.) -- a service compatible with an Additional IP -- vRack supported -- redundancy - your Load Balancer functions on separate instances, working individually on isolated, redundant hardware +- **Built-in DDoS protection** across all traffic types +- **Global Anycast network** for optimal latency and failover +- **Advanced HTTP/HTTPS support**: redirections, headers, ACLs, etc. +- **Additional IP and vRack compatibility**: improve availability and performance with advanced networking +- **High availability**: isolated redundant instances ensure resilience +- **Scalability**: add or remove servers and farms without downtime -### Basic parts +### Architecture Overview -- The new OVH Load Balancer solution is made up of three basic parts: +The Load Balancer consists of three main components: -![General](images/diag_gen.png){.thumbnail} - -|Basic parts|Function| +| Component | Function | |---|---| -|Front-end|The front-end defines the protocol type (HTTP/TCP/UDP) of the OVH Load Balancer service. This part also has the service’s listening port| -|Farm|The farm receives the incoming traffic from the front-end. This part takes care of the load balancing| -|Server|These are the servers that receive the final traffic, and respond via the application| - -With these three basic parts that make up the Load Balancer, you can configure it to use nearly all possible load balancing methods. +| **Front-end** | Defines the entry protocol (HTTP/TCP/UDP) and listening port | +| **Farm** | Distributes traffic from the front-end across servers | +| **Server** | Handles inbound and outbound application traffic | -### Why use the OVH Load Balancer? +![General diagram](images/diag_gen2025.png){.thumbnail} -#### Balance the load +## Benefits -This is the basic function of a load balancer, but the OVH Load Balancer offers much more. +### Balance and Scale Seamlessly -![Balance the load](images/distribute_load.png){.thumbnail} +Distribute workloads across multiple servers and scale horizontally without service interruption. -#### Eliminate downtime +![Balance the load](images/distribute_load2025.png){.thumbnail} -The OVH Load Balancer service can automatically detect when a server is not responding. When this happens, it redirects incoming traffic to another server, if possible. This resolves the problem without affecting your website. +### High Availability and Uptime -![Eliminate downtime](images/eliminate_downtimes.png){.thumbnail} +Automatic health checks detect unresponsive servers and reroute traffic instantly, minimizing downtime. -#### Scale your infrastructure easily +![Eliminate downtime](images/eliminate_downtimes2025.png){.thumbnail} -You can add or remove farms, front-ends or servers from the OVH Load Balancer solution without interrupting your service. +### Simplified Maintenance -![Scale your infrastructure easily](images/facilitate_maintenance.png){.thumbnail} +Place a farm or server in downtime mode for maintenance without impacting users, then reintegrate it seamlessly. -#### Make maintenance easier +![Make maintenance easier](images/facilitate_maintenance2025.png){.thumbnail} -If there is any maintenance scheduled for your solution, you can now easily place a farm in downtime mode to prevent it from receiving traffic. If you need to do this, it’s easy to add your server again once the maintenance has finished. +### Service Integration -![Make maintenance easier](images/scale_easily.png){.thumbnail} +Easily combine with other OVHcloud services: -#### Combine your services +- Public Cloud instances +- VPS +- Dedicated Servers +- vRack private networking -You can now combine various OVH services in the Load Balancer, for example: +![Combine your services](images/mix_and_match2025.png){.thumbnail} -- Public Cloud instances with Additional IPs -- VPS with Additional IPs -- Dedicated servers with Additional IPs -- vRacks +### Geographic Distribution (Anycast) -![Combine your services](images/mix_and_match.png){.thumbnail} +Serve users worldwide with low latency and resilient routing. -#### Anycast +![Anycast](images/anycast2025.png){.thumbnail} -You can balance your load across a variety of geographical zones. +### Versatile Use Cases -![Anycast](images/anycast.png){.thumbnail} - -#### Distribute any kind of traffic - -The OVH Load Balancer doesn’t just work with HTTP traffic any more! You can now use it with all TCP and UDP traffic types. +Support multiple services over HTTP(S), TCP, and UDP traffic. #### Email server Balance the load between your email servers. -![Mail](images/mail.png){.thumbnail} +![Mail](images/mail2025.png){.thumbnail} #### Databases Balance your databases, and make them redundant. -![Databases](images/database.png){.thumbnail} - -## Go further - -[Find out more about load balancing](https://en.wikipedia.org/wiki/Load_balancing). +![Databases](images/database2025.png){.thumbnail} -[Find out more about HAProxy](http://www.haproxy.org/#desc). +## Go Further -[Find out more about Nginx](https://en.wikipedia.org/wiki/Nginx). +- [Find out more about load balancing (Wikipedia)](https://en.wikipedia.org/wiki/Load_balancing) +- [HAProxy official site](http://www.haproxy.org/#desc) +- [Nginx documentation](https://nginx.org/en/docs/) -Join our community of users on . \ No newline at end of file +Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/use_presentation/guide.en-sg.md b/pages/network/load_balancer/use_presentation/guide.en-sg.md index e15353f8b0e..35126348ebc 100644 --- a/pages/network/load_balancer/use_presentation/guide.en-sg.md +++ b/pages/network/load_balancer/use_presentation/guide.en-sg.md @@ -1,119 +1,108 @@ --- -title: Introduction to the OVHcloud Load Balancer -excerpt: Find out more about the OVHcloud Load Balancer solution -updated: 2018-01-17 +title: Introduction to the OVHcloud Load Balancer +excerpt: Discover the OVHcloud Load Balancer solution for distributing and securing your traffic +updated: 2025-10-29 --- ## Objective -The new **OVHcloud Load Balancer** is a reliable service, with versatile configurations. You just need to configure your products with the OVHcloud Load Balancer, and we’ll take care of the rest. - -**Find out more about the brand-new OVHcloud Load Balancer solution.** +The **OVHcloud Load Balancer** is a fully managed service designed to ensure high availability, performance, and scalability for your applications. +Its main role is to distribute workloads across several servers or applications. +Simply configure your services behind the Load Balancer — OVHcloud handles redundancy, security, and global traffic distribution. ## Requirements -- No specific requirements. +- Access to the [OVHcloud Control Panel](/links/manager) +- At least one service to balance (Dedicated Server, VPS, Public Cloud instance, etc.) ## Instructions -This new solution is based on robust open-source solutions: HAProxy for TCP traffic, and Nginx for UDP traffic. - -There are no limits to what you can do! The new OVHcloud Load Balancer solution can be used to work with a variety of protocols: +The Load Balancer leverages **industry-standard open-source technologies** to handle different traffic types: -|Type|Description|Advantages|Technology| +| Type | Description | Advantages | Technology | |---|---|---|---| -|HTTP|All HTTP/HTTPS web services|Optimised for L7 (application layer) processing|HAProxy| -|TCP|For any network services that aren’t HTTP|Supports all TCP applications|HAProxy| -|UDP|For all UDP traffic types|Supports all UDP applications|Nginx| +| HTTP/HTTPS | All web services and APIs | Optimized for L7 (application layer) processing, URL redirection, headers, ACLs | HAProxy | +| TCP | Non-HTTP network services | Supports all TCP applications | HAProxy | +| UDP | All UDP traffic | Supports all UDP applications | Nginx | -With this new solution, you will get: +### Key Features -- OVHcloud anti-DDoS protection -- your services replicated worldwide (Anycast) -- advanced HTTP/HTTPS support (redirections, headers, ACL, etc.) -- a service compatible with an Additional IP -- vRack supported -- redundancy - your Load Balancer functions on separate instances, working individually on isolated, redundant hardware +- **Built-in DDoS protection** across all traffic types +- **Global Anycast network** for optimal latency and failover +- **Advanced HTTP/HTTPS support**: redirections, headers, ACLs, etc. +- **Additional IP and vRack compatibility**: improve availability and performance with advanced networking +- **High availability**: isolated redundant instances ensure resilience +- **Scalability**: add or remove servers and farms without downtime -### Basic parts +### Architecture Overview -- The new OVHcloud Load Balancer solution is made up of three basic parts: +The Load Balancer consists of three main components: -![General](images/diag_gen.png){.thumbnail} - -|Basic parts|Function| +| Component | Function | |---|---| -|Front-end|The front-end defines the protocol type (HTTP/TCP/UDP) of the OVHcloud Load Balancer service. This part also has the service’s listening port| -|Farm|The farm receives the incoming traffic from the front-end. This part takes care of the load balancing| -|Server|These are the servers that receive the final traffic, and respond via the application| - -With these three basic parts that make up the Load Balancer, you can configure it to use nearly all possible load balancing methods. +| **Front-end** | Defines the entry protocol (HTTP/TCP/UDP) and listening port | +| **Farm** | Distributes traffic from the front-end across servers | +| **Server** | Handles inbound and outbound application traffic | -### Why use the OVHcloud Load Balancer? +![General diagram](images/diag_gen2025.png){.thumbnail} -#### Balance the load +## Benefits -This is the basic function of a load balancer, but the OVHcloud Load Balancer offers much more. +### Balance and Scale Seamlessly -![Balance the load](images/distribute_load.png){.thumbnail} +Distribute workloads across multiple servers and scale horizontally without service interruption. -#### Eliminate downtime +![Balance the load](images/distribute_load2025.png){.thumbnail} -The OVHcloud Load Balancer service can automatically detect when a server is not responding. When this happens, it redirects incoming traffic to another server, if possible. This resolves the problem without affecting your website. +### High Availability and Uptime -![Eliminate downtime](images/eliminate_downtimes.png){.thumbnail} +Automatic health checks detect unresponsive servers and reroute traffic instantly, minimizing downtime. -#### Scale your infrastructure easily +![Eliminate downtime](images/eliminate_downtimes2025.png){.thumbnail} -You can add or remove farms, front-ends or servers from the OVHcloud Load Balancer solution without interrupting your service. +### Simplified Maintenance -![Scale your infrastructure easily](images/facilitate_maintenance.png){.thumbnail} +Place a farm or server in downtime mode for maintenance without impacting users, then reintegrate it seamlessly. -#### Make maintenance easier +![Make maintenance easier](images/facilitate_maintenance2025.png){.thumbnail} -If there is any maintenance scheduled for your solution, you can now easily place a farm in downtime mode to prevent it from receiving traffic. If you need to do this, it’s easy to add your server again once the maintenance has finished. +### Service Integration -![Make maintenance easier](images/scale_easily.png){.thumbnail} +Easily combine with other OVHcloud services: -#### Combine your services +- Public Cloud instances +- VPS +- Dedicated Servers +- vRack private networking -You can now combine various OVHcloud services in the Load Balancer, for example: +![Combine your services](images/mix_and_match2025.png){.thumbnail} -- Public Cloud instances with Additional IPs -- VPS with Additional IPs -- Dedicated servers with Additional IPs -- vRacks +### Geographic Distribution (Anycast) -![Combine your services](images/mix_and_match.png){.thumbnail} +Serve users worldwide with low latency and resilient routing. -#### Anycast +![Anycast](images/anycast2025.png){.thumbnail} -You can balance your load across a variety of geographical zones. +### Versatile Use Cases -![Anycast](images/anycast.png){.thumbnail} - -#### Distribute any kind of traffic - -The OVHcloud Load Balancer doesn’t just work with HTTP traffic any more! You can now use it with all TCP and UDP traffic types. +Support multiple services over HTTP(S), TCP, and UDP traffic. #### Email server Balance the load between your email servers. -![Mail](images/mail.png){.thumbnail} +![Mail](images/mail2025.png){.thumbnail} #### Databases Balance your databases, and make them redundant. -![Databases](images/database.png){.thumbnail} - -## Go further - -[Find out more about load balancing](https://en.wikipedia.org/wiki/Load_balancing). +![Databases](images/database2025.png){.thumbnail} -[Find out more about HAProxy](http://www.haproxy.org/#desc). +## Go Further -[Find out more about Nginx](https://en.wikipedia.org/wiki/Nginx). +- [Find out more about load balancing (Wikipedia)](https://en.wikipedia.org/wiki/Load_balancing) +- [HAProxy official site](http://www.haproxy.org/#desc) +- [Nginx documentation](https://nginx.org/en/docs/) -Join our community of users on . +Join our [community of users](/links/community). diff --git a/pages/network/load_balancer/use_presentation/guide.en-us.md b/pages/network/load_balancer/use_presentation/guide.en-us.md index e15353f8b0e..35126348ebc 100644 --- a/pages/network/load_balancer/use_presentation/guide.en-us.md +++ b/pages/network/load_balancer/use_presentation/guide.en-us.md @@ -1,119 +1,108 @@ --- -title: Introduction to the OVHcloud Load Balancer -excerpt: Find out more about the OVHcloud Load Balancer solution -updated: 2018-01-17 +title: Introduction to the OVHcloud Load Balancer +excerpt: Discover the OVHcloud Load Balancer solution for distributing and securing your traffic +updated: 2025-10-29 --- ## Objective -The new **OVHcloud Load Balancer** is a reliable service, with versatile configurations. You just need to configure your products with the OVHcloud Load Balancer, and we’ll take care of the rest. - -**Find out more about the brand-new OVHcloud Load Balancer solution.** +The **OVHcloud Load Balancer** is a fully managed service designed to ensure high availability, performance, and scalability for your applications. +Its main role is to distribute workloads across several servers or applications. +Simply configure your services behind the Load Balancer — OVHcloud handles redundancy, security, and global traffic distribution. ## Requirements -- No specific requirements. +- Access to the [OVHcloud Control Panel](/links/manager) +- At least one service to balance (Dedicated Server, VPS, Public Cloud instance, etc.) ## Instructions -This new solution is based on robust open-source solutions: HAProxy for TCP traffic, and Nginx for UDP traffic. - -There are no limits to what you can do! The new OVHcloud Load Balancer solution can be used to work with a variety of protocols: +The Load Balancer leverages **industry-standard open-source technologies** to handle different traffic types: -|Type|Description|Advantages|Technology| +| Type | Description | Advantages | Technology | |---|---|---|---| -|HTTP|All HTTP/HTTPS web services|Optimised for L7 (application layer) processing|HAProxy| -|TCP|For any network services that aren’t HTTP|Supports all TCP applications|HAProxy| -|UDP|For all UDP traffic types|Supports all UDP applications|Nginx| +| HTTP/HTTPS | All web services and APIs | Optimized for L7 (application layer) processing, URL redirection, headers, ACLs | HAProxy | +| TCP | Non-HTTP network services | Supports all TCP applications | HAProxy | +| UDP | All UDP traffic | Supports all UDP applications | Nginx | -With this new solution, you will get: +### Key Features -- OVHcloud anti-DDoS protection -- your services replicated worldwide (Anycast) -- advanced HTTP/HTTPS support (redirections, headers, ACL, etc.) -- a service compatible with an Additional IP -- vRack supported -- redundancy - your Load Balancer functions on separate instances, working individually on isolated, redundant hardware +- **Built-in DDoS protection** across all traffic types +- **Global Anycast network** for optimal latency and failover +- **Advanced HTTP/HTTPS support**: redirections, headers, ACLs, etc. +- **Additional IP and vRack compatibility**: improve availability and performance with advanced networking +- **High availability**: isolated redundant instances ensure resilience +- **Scalability**: add or remove servers and farms without downtime -### Basic parts +### Architecture Overview -- The new OVHcloud Load Balancer solution is made up of three basic parts: +The Load Balancer consists of three main components: -![General](images/diag_gen.png){.thumbnail} - -|Basic parts|Function| +| Component | Function | |---|---| -|Front-end|The front-end defines the protocol type (HTTP/TCP/UDP) of the OVHcloud Load Balancer service. This part also has the service’s listening port| -|Farm|The farm receives the incoming traffic from the front-end. This part takes care of the load balancing| -|Server|These are the servers that receive the final traffic, and respond via the application| - -With these three basic parts that make up the Load Balancer, you can configure it to use nearly all possible load balancing methods. +| **Front-end** | Defines the entry protocol (HTTP/TCP/UDP) and listening port | +| **Farm** | Distributes traffic from the front-end across servers | +| **Server** | Handles inbound and outbound application traffic | -### Why use the OVHcloud Load Balancer? +![General diagram](images/diag_gen2025.png){.thumbnail} -#### Balance the load +## Benefits -This is the basic function of a load balancer, but the OVHcloud Load Balancer offers much more. +### Balance and Scale Seamlessly -![Balance the load](images/distribute_load.png){.thumbnail} +Distribute workloads across multiple servers and scale horizontally without service interruption. -#### Eliminate downtime +![Balance the load](images/distribute_load2025.png){.thumbnail} -The OVHcloud Load Balancer service can automatically detect when a server is not responding. When this happens, it redirects incoming traffic to another server, if possible. This resolves the problem without affecting your website. +### High Availability and Uptime -![Eliminate downtime](images/eliminate_downtimes.png){.thumbnail} +Automatic health checks detect unresponsive servers and reroute traffic instantly, minimizing downtime. -#### Scale your infrastructure easily +![Eliminate downtime](images/eliminate_downtimes2025.png){.thumbnail} -You can add or remove farms, front-ends or servers from the OVHcloud Load Balancer solution without interrupting your service. +### Simplified Maintenance -![Scale your infrastructure easily](images/facilitate_maintenance.png){.thumbnail} +Place a farm or server in downtime mode for maintenance without impacting users, then reintegrate it seamlessly. -#### Make maintenance easier +![Make maintenance easier](images/facilitate_maintenance2025.png){.thumbnail} -If there is any maintenance scheduled for your solution, you can now easily place a farm in downtime mode to prevent it from receiving traffic. If you need to do this, it’s easy to add your server again once the maintenance has finished. +### Service Integration -![Make maintenance easier](images/scale_easily.png){.thumbnail} +Easily combine with other OVHcloud services: -#### Combine your services +- Public Cloud instances +- VPS +- Dedicated Servers +- vRack private networking -You can now combine various OVHcloud services in the Load Balancer, for example: +![Combine your services](images/mix_and_match2025.png){.thumbnail} -- Public Cloud instances with Additional IPs -- VPS with Additional IPs -- Dedicated servers with Additional IPs -- vRacks +### Geographic Distribution (Anycast) -![Combine your services](images/mix_and_match.png){.thumbnail} +Serve users worldwide with low latency and resilient routing. -#### Anycast +![Anycast](images/anycast2025.png){.thumbnail} -You can balance your load across a variety of geographical zones. +### Versatile Use Cases -![Anycast](images/anycast.png){.thumbnail} - -#### Distribute any kind of traffic - -The OVHcloud Load Balancer doesn’t just work with HTTP traffic any more! You can now use it with all TCP and UDP traffic types. +Support multiple services over HTTP(S), TCP, and UDP traffic. #### Email server Balance the load between your email servers. -![Mail](images/mail.png){.thumbnail} +![Mail](images/mail2025.png){.thumbnail} #### Databases Balance your databases, and make them redundant. -![Databases](images/database.png){.thumbnail} - -## Go further - -[Find out more about load balancing](https://en.wikipedia.org/wiki/Load_balancing). +![Databases](images/database2025.png){.thumbnail} -[Find out more about HAProxy](http://www.haproxy.org/#desc). +## Go Further -[Find out more about Nginx](https://en.wikipedia.org/wiki/Nginx). +- [Find out more about load balancing (Wikipedia)](https://en.wikipedia.org/wiki/Load_balancing) +- [HAProxy official site](http://www.haproxy.org/#desc) +- [Nginx documentation](https://nginx.org/en/docs/) -Join our community of users on . +Join our [community of users](/links/community). diff --git a/pages/network/load_balancer/use_presentation/guide.es-es.md b/pages/network/load_balancer/use_presentation/guide.es-es.md index 2426c3c5f6c..35126348ebc 100644 --- a/pages/network/load_balancer/use_presentation/guide.es-es.md +++ b/pages/network/load_balancer/use_presentation/guide.es-es.md @@ -1,120 +1,108 @@ --- -title: Presentación del Load Balancer de OVH -excerpt: Descubra el nuevo Load Balancer de OVH -updated: 2018-01-17 +title: Introduction to the OVHcloud Load Balancer +excerpt: Discover the OVHcloud Load Balancer solution for distributing and securing your traffic +updated: 2025-10-29 --- -## Objetivo +## Objective -El nuevo [Load Balancer de OVH](/links/network/load-balancer) es un balanceador de carga (*load balancer*) que combina fiabilidad y una gran flexibilidad en la configuración. Usted solo tiene que configurar sus productos con el Load Balancer de OVH y nosotros nos encargamos del resto. +The **OVHcloud Load Balancer** is a fully managed service designed to ensure high availability, performance, and scalability for your applications. +Its main role is to distribute workloads across several servers or applications. +Simply configure your services behind the Load Balancer — OVHcloud handles redundancy, security, and global traffic distribution. -**Esta guía explica brevemente el funcionamiento del nuevo Load Balancer de OVH.** +## Requirements -## Requisitos +- Access to the [OVHcloud Control Panel](/links/manager) +- At least one service to balance (Dedicated Server, VPS, Public Cloud instance, etc.) -- No hay requisitos específicos. +## Instructions -## Procedimiento +The Load Balancer leverages **industry-standard open-source technologies** to handle different traffic types: - -Este nuevo producto está basado en tecnologías *open source* muy robustas: HAProxy para el tráfico TCP y Nginx para el tráfico UDP. - -¡Se acabaron las limitaciones! El nuevo [Load Balancer de OVH](/links/network/load-balancer) se puede utilizar con diferentes protocolos: - -|Tipo|Descripción|Ventajas|Tecnología| +| Type | Description | Advantages | Technology | |---|---|---|---| -|HTTP|Todo tipo de servicios web HTTP/HTTPS|Optimizado para tratamiento L7 (aplicaciones)|HAProxy| -|TCP|Para cualquier servicio de red que no sea HTTP|Compatible con todas las aplicaciones TCP|HAProxy| -|UDP|Para todo tipo de tráfico UDP|Compatible con todas las aplicaciones UDP|Nginx| +| HTTP/HTTPS | All web services and APIs | Optimized for L7 (application layer) processing, URL redirection, headers, ACLs | HAProxy | +| TCP | Non-HTTP network services | Supports all TCP applications | HAProxy | +| UDP | All UDP traffic | Supports all UDP applications | Nginx | -Este nuevo servicio incluye: +### Key Features -- protección anti-DDoS de OVH -- soporte de zonas múltiples (Anycast) -- soporte HTTP/HTTPS avanzado (redireccionamiento, cabeceras, ACL...) -- compatibilidad con una Additional IP -- compatibilidad con el vRack -- redundancia: el Load Balancer funciona en instancias separadas, que a su vez funcionan en equipos separados y redundantes +- **Built-in DDoS protection** across all traffic types +- **Global Anycast network** for optimal latency and failover +- **Advanced HTTP/HTTPS support**: redirections, headers, ACLs, etc. +- **Additional IP and vRack compatibility**: improve availability and performance with advanced networking +- **High availability**: isolated redundant instances ensure resilience +- **Scalability**: add or remove servers and farms without downtime -### Principales elementos +### Architecture Overview -El nuevo Load Balancer de OVH está formado principalmente por tres elementos, que se describen a continuación. +The Load Balancer consists of three main components: -![General](images/diag_gen.png){.thumbnail} - -|Principales elementos|Función| +| Component | Function | |---|---| -|Frontend|El frontend determina el tipo de protocolo (HTTP, TCP o UDP) del servicio Load Balancer de OVH. Es el elemento que expone el puerto de escucha del servicio.| -|Granja|La granja recibe el tráfico procedente del frontend. Es el que se ocupa de balancear la carga.| -|Servidor|Los servidores son los que reciben el tráfico final y responden a través de la aplicación.| - -Con estos tres elementos fundamentales que componen el Load Balancer, se pueden configurar casi todos los tipos de balanceo de carga posibles. - -### ¿Para qué utilizar el Load Balancer de OVH? - -#### Balancear la carga - -Es la principal función de un balanceador de carga, pero el Load Balancer de OVH puede hacer mucho más. - -![Distribuir la carga](images/distribute_load.png){.thumbnail} +| **Front-end** | Defines the entry protocol (HTTP/TCP/UDP) and listening port | +| **Farm** | Distributes traffic from the front-end across servers | +| **Server** | Handles inbound and outbound application traffic | -#### Eliminar el riesgo de *downtime* +![General diagram](images/diag_gen2025.png){.thumbnail} -El servicio Load Balancer de OVH es capaz de detectar automáticamente si un servidor no responde y, en ese caso, redirige el tráfico que tiene como destino ese servidor hacia otro, siempre que sea posible. Esto permite resolver el problema sin que afecte a los servicios en producción. +## Benefits -![Eliminar el downtime](images/eliminate_downtimes.png){.thumbnail} +### Balance and Scale Seamlessly -#### Escalar una infraestructura fácilmente +Distribute workloads across multiple servers and scale horizontally without service interruption. -Es posible añadir o quitar una granja, frontend o servidor del Load Balancer de OVH sin interrumpir el servicio. +![Balance the load](images/distribute_load2025.png){.thumbnail} -![Escalar una infraestructura fácilmente](images/facilitate_maintenance.png){.thumbnail} +### High Availability and Uptime -#### Facilitar las operaciones de mantenimiento +Automatic health checks detect unresponsive servers and reroute traffic instantly, minimizing downtime. -En caso de mantenimiento planificado en su infraestructura, es posible deshabilitar fácilmente los servidores de una granja para que dejen de recibir tráfico temporalmente. De esa forma, puede realizar la intervención y, una vez finalizado el mantenimiento, volver a añadir los servidores. +![Eliminate downtime](images/eliminate_downtimes2025.png){.thumbnail} -![Facilitar las operaciones de mantenimiento](images/scale_easily.png){.thumbnail} +### Simplified Maintenance -#### Combinar los servicios +Place a farm or server in downtime mode for maintenance without impacting users, then reintegrate it seamlessly. -Es posible combinar diferentes servicios de OVH en el Load Balancer, como por ejemplo: +![Make maintenance easier](images/facilitate_maintenance2025.png){.thumbnail} -- instancias de Public Cloud con Additional IP -- VPS con Additional IP -- servidores dedicados con Additional IP -- vRack +### Service Integration -![Combinar servicios](images/mix_and_match.png){.thumbnail} +Easily combine with other OVHcloud services: -#### Anycast +- Public Cloud instances +- VPS +- Dedicated Servers +- vRack private networking -Es posible balancear la carga en diferentes zonas geográficas. +![Combine your services](images/mix_and_match2025.png){.thumbnail} -![Anycast](images/anycast.png){.thumbnail} +### Geographic Distribution (Anycast) -#### Balancear cualquier tipo de tráfico +Serve users worldwide with low latency and resilient routing. -El Load Balancer de OVH ya no está limitado al tráfico HTTP. Ahora puede utilizarlo con cualquier tipo de tráfico TCP o UDP. +![Anycast](images/anycast2025.png){.thumbnail} -#### Servidores de correo +### Versatile Use Cases -Balancee la carga entre sus servidores de correo. +Support multiple services over HTTP(S), TCP, and UDP traffic. -![Correo electrónico](images/mail.png){.thumbnail} +#### Email server -#### Bases de datos +Balance the load between your email servers. -Equilibre y redunde sus bases de datos. +![Mail](images/mail2025.png){.thumbnail} -![Bases de datos](images/database.png){.thumbnail} +#### Databases -## Más información +Balance your databases, and make them redundant. -[Más información sobre el balanceo de carga](https://es.wikipedia.org/wiki/Balanceador_de_carga) +![Databases](images/database2025.png){.thumbnail} -[Más información sobre HAProxy](http://www.haproxy.org/#desc) +## Go Further -[Más información sobre Nginx](https://es.wikipedia.org/wiki/Nginx) +- [Find out more about load balancing (Wikipedia)](https://en.wikipedia.org/wiki/Load_balancing) +- [HAProxy official site](http://www.haproxy.org/#desc) +- [Nginx documentation](https://nginx.org/en/docs/) -Interactúe con nuestra comunidad de usuarios en . \ No newline at end of file +Join our [community of users](/links/community). diff --git a/pages/network/load_balancer/use_presentation/guide.es-us.md b/pages/network/load_balancer/use_presentation/guide.es-us.md index 187a298c577..35126348ebc 100644 --- a/pages/network/load_balancer/use_presentation/guide.es-us.md +++ b/pages/network/load_balancer/use_presentation/guide.es-us.md @@ -1,120 +1,108 @@ --- -title: Presentación del Load Balancer de OVHcloud -excerpt: Descubra el nuevo Load Balancer de OVHcloud -updated: 2018-01-17 +title: Introduction to the OVHcloud Load Balancer +excerpt: Discover the OVHcloud Load Balancer solution for distributing and securing your traffic +updated: 2025-10-29 --- -## Objetivo +## Objective -El nuevo [Load Balancer de OVHcloud](https://www.ovh.com/world/es/soluciones/load-balancer/) es un balanceador de carga (*load balancer*) que combina fiabilidad y una gran flexibilidad en la configuración. Usted solo tiene que configurar sus productos con el Load Balancer de OVHcloud y nosotros nos encargamos del resto. +The **OVHcloud Load Balancer** is a fully managed service designed to ensure high availability, performance, and scalability for your applications. +Its main role is to distribute workloads across several servers or applications. +Simply configure your services behind the Load Balancer — OVHcloud handles redundancy, security, and global traffic distribution. -**Esta guía explica brevemente el funcionamiento del nuevo Load Balancer de OVHcloud.** +## Requirements -## Requisitos +- Access to the [OVHcloud Control Panel](/links/manager) +- At least one service to balance (Dedicated Server, VPS, Public Cloud instance, etc.) -- No hay requisitos específicos. +## Instructions -## Procedimiento +The Load Balancer leverages **industry-standard open-source technologies** to handle different traffic types: - -Este nuevo producto está basado en tecnologías *open source* muy robustas: HAProxy para el tráfico TCP y Nginx para el tráfico UDP. - -¡Se acabaron las limitaciones! El nuevo [Load Balancer de OVHcloud](https://www.ovh.com/world/es/soluciones/load-balancer/) se puede utilizar con diferentes protocolos: - -|Tipo|Descripción|Ventajas|Tecnología| +| Type | Description | Advantages | Technology | |---|---|---|---| -|HTTP|Todo tipo de servicios web HTTP/HTTPS|Optimizado para tratamiento L7 (aplicaciones)|HAProxy| -|TCP|Para cualquier servicio de red que no sea HTTP|Compatible con todas las aplicaciones TCP|HAProxy| -|UDP|Para todo tipo de tráfico UDP|Compatible con todas las aplicaciones UDP|Nginx| +| HTTP/HTTPS | All web services and APIs | Optimized for L7 (application layer) processing, URL redirection, headers, ACLs | HAProxy | +| TCP | Non-HTTP network services | Supports all TCP applications | HAProxy | +| UDP | All UDP traffic | Supports all UDP applications | Nginx | -Este nuevo servicio incluye: +### Key Features -- protección anti-DDoS de OVHcloud -- soporte de zonas múltiples (Anycast) -- soporte HTTP/HTTPS avanzado (redireccionamiento, cabeceras, ACL...) -- compatibilidad con una Additional IP -- compatibilidad con el vRack -- redundancia: el Load Balancer funciona en instancias separadas, que a su vez funcionan en equipos separados y redundantes +- **Built-in DDoS protection** across all traffic types +- **Global Anycast network** for optimal latency and failover +- **Advanced HTTP/HTTPS support**: redirections, headers, ACLs, etc. +- **Additional IP and vRack compatibility**: improve availability and performance with advanced networking +- **High availability**: isolated redundant instances ensure resilience +- **Scalability**: add or remove servers and farms without downtime -### Principales elementos +### Architecture Overview -El nuevo Load Balancer de OVHcloud está formado principalmente por tres elementos, que se describen a continuación. +The Load Balancer consists of three main components: -![General](images/diag_gen.png){.thumbnail} - -|Principales elementos|Función| +| Component | Function | |---|---| -|Frontend|El frontend determina el tipo de protocolo (HTTP, TCP o UDP) del servicio Load Balancer de OVHcloud. Es el elemento que expone el puerto de escucha del servicio.| -|Granja|La granja recibe el tráfico procedente del frontend. Es el que se ocupa de balancear la carga.| -|Servidor|Los servidores son los que reciben el tráfico final y responden a través de la aplicación.| - -Con estos tres elementos fundamentales que componen el Load Balancer, se pueden configurar casi todos los tipos de balanceo de carga posibles. - -### ¿Para qué utilizar el Load Balancer de OVHcloud? - -#### Balancear la carga - -Es la principal función de un balanceador de carga, pero el Load Balancer de OVHcloud puede hacer mucho más. - -![Distribuir la carga](images/distribute_load.png){.thumbnail} +| **Front-end** | Defines the entry protocol (HTTP/TCP/UDP) and listening port | +| **Farm** | Distributes traffic from the front-end across servers | +| **Server** | Handles inbound and outbound application traffic | -#### Eliminar el riesgo de *downtime* +![General diagram](images/diag_gen2025.png){.thumbnail} -El servicio Load Balancer de OVHcloud es capaz de detectar automáticamente si un servidor no responde y, en ese caso, redirige el tráfico que tiene como destino ese servidor hacia otro, siempre que sea posible. Esto permite resolver el problema sin que afecte a los servicios en producción. +## Benefits -![Eliminar el downtime](images/eliminate_downtimes.png){.thumbnail} +### Balance and Scale Seamlessly -#### Escalar una infraestructura fácilmente +Distribute workloads across multiple servers and scale horizontally without service interruption. -Es posible añadir o quitar una granja, frontend o servidor del Load Balancer de OVHcloud sin interrumpir el servicio. +![Balance the load](images/distribute_load2025.png){.thumbnail} -![Escalar una infraestructura fácilmente](images/facilitate_maintenance.png){.thumbnail} +### High Availability and Uptime -#### Facilitar las operaciones de mantenimiento +Automatic health checks detect unresponsive servers and reroute traffic instantly, minimizing downtime. -En caso de mantenimiento planificado en su infraestructura, es posible deshabilitar fácilmente los servidores de una granja para que dejen de recibir tráfico temporalmente. De esa forma, puede realizar la intervención y, una vez finalizado el mantenimiento, volver a añadir los servidores. +![Eliminate downtime](images/eliminate_downtimes2025.png){.thumbnail} -![Facilitar las operaciones de mantenimiento](images/scale_easily.png){.thumbnail} +### Simplified Maintenance -#### Combinar los servicios +Place a farm or server in downtime mode for maintenance without impacting users, then reintegrate it seamlessly. -Es posible combinar diferentes servicios de OVHcloud en el Load Balancer, como por ejemplo: +![Make maintenance easier](images/facilitate_maintenance2025.png){.thumbnail} -- instancias de Public Cloud con Additional IP -- VPS con Additional IP -- servidores dedicados con Additional IP -- vRack +### Service Integration -![Combinar servicios](images/mix_and_match.png){.thumbnail} +Easily combine with other OVHcloud services: -#### Anycast +- Public Cloud instances +- VPS +- Dedicated Servers +- vRack private networking -Es posible balancear la carga en diferentes zonas geográficas. +![Combine your services](images/mix_and_match2025.png){.thumbnail} -![Anycast](images/anycast.png){.thumbnail} +### Geographic Distribution (Anycast) -#### Balancear cualquier tipo de tráfico +Serve users worldwide with low latency and resilient routing. -El Load Balancer de OVHcloud ya no está limitado al tráfico HTTP. Ahora puede utilizarlo con cualquier tipo de tráfico TCP o UDP. +![Anycast](images/anycast2025.png){.thumbnail} -#### Servidores de correo +### Versatile Use Cases -Balancee la carga entre sus servidores de correo. +Support multiple services over HTTP(S), TCP, and UDP traffic. -![Correo electrónico](images/mail.png){.thumbnail} +#### Email server -#### Bases de datos +Balance the load between your email servers. -Equilibre y redunde sus bases de datos. +![Mail](images/mail2025.png){.thumbnail} -![Bases de datos](images/database.png){.thumbnail} +#### Databases -## Más información +Balance your databases, and make them redundant. -[Más información sobre el balanceo de carga](https://es.wikipedia.org/wiki/Balanceador_de_carga) +![Databases](images/database2025.png){.thumbnail} -[Más información sobre HAProxy](http://www.haproxy.org/#desc) +## Go Further -[Más información sobre Nginx](https://es.wikipedia.org/wiki/Nginx) +- [Find out more about load balancing (Wikipedia)](https://en.wikipedia.org/wiki/Load_balancing) +- [HAProxy official site](http://www.haproxy.org/#desc) +- [Nginx documentation](https://nginx.org/en/docs/) -Interactúe con nuestra comunidad de usuarios en . +Join our [community of users](/links/community). diff --git a/pages/network/load_balancer/use_presentation/guide.fr-ca.md b/pages/network/load_balancer/use_presentation/guide.fr-ca.md index 926bee8a68c..913f2d59f2a 100644 --- a/pages/network/load_balancer/use_presentation/guide.fr-ca.md +++ b/pages/network/load_balancer/use_presentation/guide.fr-ca.md @@ -1,120 +1,109 @@ --- -title: Présentation de le Load Balancer OVHcloud -excerpt: Découvrez la nouvelle offre OVHcloud Load Balancer -updated: 2018-01-17 +title: Présentation du service OVHcloud Load Balancer +excerpt: Découvrez la solution OVHcloud Load Balancer pour distribuer et sécuriser votre trafic +updated: 2025-10-29 --- -## Objectif -La nouvelle offre [OVHcloud Load Balancer](https://www.ovh.com/ca/fr/solutions/load-balancer/) est un répartiteur de charge (load balancer) qui allie souplesse de configuration et fiabilité. Vous n'avez qu'à configurer vos produits avec le Load Balancer OVHcloud et nous nous occupons du reste ! +## Objectif -**Découvrez vite la nouvelle offre OVHcloud Load Balancer.** +Le **Load Balancer OVHcloud** est un service entièrement managé, conçu pour garantir la haute disponibilité, les performances et la scalabilité de vos applications. +Son rôle principal est de distribuer la charge de travail entre différents serveurs ou applications. +Il vous suffit de configurer vos services derrière le Load Balancer — OVHcloud prend en charge la redondance, la sécurité et la distribution mondiale du trafic. ## Prérequis -- Pas de prérequis spécifique. +- Être connecté à l’[espace client OVHcloud](/links/manager) +- Au moins un service à équilibrer (Serveur Dédié, VPS, instance Public Cloud, etc.) ## En pratique - -Cette nouvelle offre est basée sur de robustes solutions open source : Haproxy pour les flux TCP et Nginx pour les flux UDP. - -Plus de limitations ! La nouvelle offre [OVHcloud Load Balancer](https://www.ovh.com/ca/fr/solutions/load-balancer/) peut être utilisée pour fonctionner avec différents protocoles : +Le Load Balancer s’appuie sur des **technologies open source de référence** pour gérer différents types de trafic : -|Type|Description|Avantages|Technologie| +| Type | Description | Avantages | Technologie | |---|---|---|---| -|HTTP|Tout type de services web HTTP/HTTPS|Optimisé pour du traitement L7 (applicatif)|Haproxy| -|TCP|Pour tout service réseau qui n'est pas HTTP|Peut supporter toutes les applications TCP|Haproxy| -|UDP|Pour tout type de flux UDP|Peut supporter toutes les applications UDP|Nginx| +| HTTP/HTTPS | Tous les services web et API | Optimisé pour le traitement L7 (couche applicative), redirection d’URL, en-têtes, ACLs | HAProxy | +| TCP | Services réseau non-HTTP | Compatible avec toutes les applications TCP | HAProxy | +| UDP | Tout trafic UDP | Compatible avec toutes les applications UDP | Nginx | -Ce qui est inclus avec ce nouveau service : +### Fonctionnalités principales -- une protection Anti-DDoS OVHcloud ; - - un support de zones multiples (Anycast) ; - - un support HTTP/HTTPS avancé (redirections, headers, ACL...) ; - - un service compatible avec une Additional IP ; - - le vRack est supporté ; - - la redondance : votre Load Balancer fonctionne sur des instances séparées, fonctionnant elles-mêmes sur des équipements séparés et redondants. +- **Protection anti-DDoS intégrée** pour tous les types de trafic +- **Réseau Anycast mondial** pour une latence optimisée et un basculement automatique +- **Support avancé HTTP/HTTPS** : redirections, en-têtes, ACLs, etc. +- **Compatibilité avec les IP supplémentaires et le vRack** : améliorez la disponibilité et les performances grâce au réseau avancé +- **Haute disponibilité** : instances redondantes isolées pour assurer la résilience +- **Scalabilité** : ajoutez ou retirez des serveurs et des fermes sans interruption de service -### Parties élémentaires +### Vue d’ensemble de l’architecture -- La nouvelle offre OVHcloud Load Balancer se compose de trois parties élémentaires : +Le Load Balancer est constitué de trois composants principaux : -![Général](images/diag_gen.png){.thumbnail} - -|Parties Élémentaires|Fonction| +| Composant | Fonction | |---|---| -|Frontend|Le front end définit le type de protocole (HTTP/TCP/UDP) du service OVHcloud Load Balancer. C'est également la partie qui expose le port d'écoute du service| -|Farm|La ferme reçoit le trafic provenant du front end, c'est la partie qui s'occupe de faire la répartition de charge| -|Server|Ce sont les serveurs qui reçoivent le trafic final et qui répondent via l'application| - -Avec ces trois parties élémentaires qui composent le Load Balancer, il est possible de configurer à peu près tous les types de load-balancing possibles. - -### Pourquoi utiliser le Load Balancer OVHcloud ? - -#### Répartir la charge - -C'est la fonction élémentaire d'un répartiteur de charge, mais le Load Balancer OVHcloud OVHcloud est capable de bien plus. - -![Distribute load](images/distribute_load.png){.thumbnail} +| **Front-end** | Définit le protocole d’entrée (HTTP/TCP/UDP) et le port d’écoute | +| **Ferme** | Répartit le trafic en provenance du front-end entre les serveurs | +| **Serveur** | Taite le trafic applicatif entrant et sortant | -#### Supprimer le downtime +![Schéma général](images/diag_gen2025.png){.thumbnail} -Le service OVHcloud Load Balancer est capable de détecter automatiquement l'absence de réponse d'un serveur. Dans ce cas de figure, il redirige le trafic à destination de ce serveur vers un autre, si c'est possible. Cela permet de résoudre le problème sans affecter votre production. +## Avantages -![Eliminate downtimes](images/eliminate_downtimes.png){.thumbnail} +### Répartir et scaler sans interruption -#### Faire évoluer facilement votre infrastructure +Répartissez les charges entre plusieurs serveurs et augmentez horizontalement vos ressources sans interruption de service. -Il est possible d'ajouter ou retirer une ferme, un front end ou un serveur du service OVHcloud Load Balancer sans interruption de service. +![Répartition de charge](images/distribute_load2025.png){.thumbnail} -![Scale your infra easily](images/facilitate_maintenance.png){.thumbnail} +### Haute disponibilité et continuité de service -#### Faciliter les maintenances +Des sondes automatiques détectent les serveurs non réactifs et redirigent instantanément le trafic, minimisant ainsi les interruptions. -En cas de maintenance planifiée sur votre infrastructure, il est désormais facilement possible de placer une ferme en downtime pour qu'elle cesse préventivement de recevoir du trafic. Dans ce cas, il est facile d'intervenir et d'y rajouter votre serveur une fois la maintenance terminée. +![Haute disponibilité](images/eliminate_downtimes2025.png){.thumbnail} -![Facilitates maintenance](images/scale_easily.png){.thumbnail} +### Maintenance simplifiée -#### Varier les services +Mettez une ferme ou un serveur en mode maintenance sans impacter les utilisateurs, puis réintégrez-le facilement après intervention. -Vous pouvez désormais mixer différents services d'OVHcloud dans le Load Balancer, comme par exemple : +![Maintenance simplifiée](images/facilitate_maintenance2025.png){.thumbnail} -- les instances Public Cloud avec Additional IP ; -- les VPS avec Additional IP ; -- les serveurs dédiés avec Additional IP ; -- les vRack. +### Intégration avec les services OVHcloud -![Mix and match service](images/mix_and_match.png){.thumbnail} +Combinez facilement le Load Balancer avec d’autres services OVHcloud : -#### Anycast +- Instances Public Cloud +- VPS +- Serveurs Dédiés +- Réseau privé vRack -Vous pouvez répartir votre charge sur différentes zones géographiques : +![Combiner vos services](images/mix_and_match2025.png){.thumbnail} -![Anycast](images/anycast.png){.thumbnail} +### Distribution géographique (Anycast) -#### Répartir n'importe quel type de trafic +Fournissez un service à vos utilisateurs partout dans le monde avec une faible latence et un routage résilient. -L'OVHcloud Load Balancer n'est plus limité au trafic HTTP ! Vous pouvez maintenant l'utiliser avec toutes sortes de trafics TCP ou UDP. +![Anycast](images/anycast2025.png){.thumbnail} -#### Serveur e-mail +### Cas d’usage variés -Répartissez la charge entre vos serveurs de messagerie : +Prenez en charge de multiples services via du trafic HTTP(S), TCP et UDP. -![Mail](images/mail.png){.thumbnail} +#### Serveurs de messagerie -#### Base de données +Équilibrez la charge entre vos serveurs de messagerie. -Équilibrez et redondez vos bases de données : +![Mail](images/mail2025.png){.thumbnail} -![Database](images/database.png){.thumbnail} +#### Bases de données -## Aller plus loin +Équilibrez vos bases de données et rendez-les redondantes. -[En apprendre plus sur la répartition de charge](https://fr.wikipedia.org/wiki/Repartition_de_charge). +![Bases de données](images/database2025.png){.thumbnail} -[En apprendre plus sur Haproxy](http://www.haproxy.org/#desc). +## Pour aller plus loin -[En apprendre plus sur Nginx](https://fr.wikipedia.org/wiki/Nginx). +- [En apprendre plus sur la répartition de charge (Wikipedia)](https://fr.wikipedia.org/wiki/R%C3%A9partition_de_charge) +- [Site officiel HAProxy](http://www.haproxy.org/#desc) +- [Documentation Nginx](https://nginx.org/en/docs/) -Échangez avec notre [communauté d'utilisateurs](/links/community). +Rejoignez notre [communauté d’utilisateurs](/links/community). diff --git a/pages/network/load_balancer/use_presentation/guide.fr-fr.md b/pages/network/load_balancer/use_presentation/guide.fr-fr.md index f31ecdb2b5d..c4363009373 100644 --- a/pages/network/load_balancer/use_presentation/guide.fr-fr.md +++ b/pages/network/load_balancer/use_presentation/guide.fr-fr.md @@ -1,120 +1,108 @@ --- title: Présentation du service OVHcloud Load Balancer -excerpt: Découvrez le service OVHcloud Load Balancer -updated: 2018-01-17 +excerpt: Découvrez la solution OVHcloud Load Balancer pour distribuer et sécuriser votre trafic +updated: 2025-10-29 --- ## Objectif -Le [Load Balancer OVHcloud](/links/network/load-balancer) répartit la charge entre vos différents services dans nos datacentres. Il vous assure la mise à l'échelle de votre infrastructure face à un trafic important, une tolérance aux pannes et des temps de réponse optimisés. +Le **Load Balancer OVHcloud** est un service entièrement managé, conçu pour garantir la haute disponibilité, les performances et la scalabilité de vos applications. +Son rôle principal est de distribuer la charge de travail entre différents serveurs ou applications. +Il vous suffit de configurer vos services derrière le Load Balancer — OVHcloud prend en charge la redondance, la sécurité et la distribution mondiale du trafic. -Vous pouvez ajouter des fontionnalités d'équilibrage de charge qui correspondent le mieux à vos besoins. +## Prérequis -## En pratique - -### Qu’est-ce que le load balancing ? - -Le load balancing, ou répartition de charge, est une technologie conçue pour distribuer la charge de travail entre différents serveurs ou applications. Le but : optimiser la performance globale de l’infrastructure, son rendement et sa capacité. +- Être connecté à l’[espace client OVHcloud](/links/manager) +- Au moins un service à équilibrer (Serveur Dédié, VPS, instance Public Cloud, etc.) -### Les types de trafic gérés par le load balancer +## En pratique -Le service OVHcloud Load Balancer est basé sur de robustes solutions open-source : Haproxy pour les flux TCP et Nginx pour les flux UDP.
-Il peut être utilisé pour fonctionner avec différents protocoles : +Le Load Balancer s’appuie sur des **technologies open source de référence** pour gérer différents types de trafic : -|Type|Description|Avantages|Technologie| +| Type | Description | Avantages | Technologie | |---|---|---|---| -|HTTP|Tout type de service web HTTP/HTTPS|Optimisé pour du traitement L7 (applicatif)|Haproxy| -|TCP|Pour tout service réseau qui n'est pas HTTP|Peut supporter toutes les applications TCP|Haproxy| -|UDP|Pour tout type de flux UDP|Peut supporter toutes les applications UDP|Nginx| - -Le service OVHcloud Load Balancer contient de nombreuses fontionnalités : +| HTTP/HTTPS | Tous les services web et API | Optimisé pour le traitement L7 (couche applicative), redirection d’URL, en-têtes, ACLs | HAProxy | +| TCP | Services réseau non-HTTP | Compatible avec toutes les applications TCP | HAProxy | +| UDP | Tout trafic UDP | Compatible avec toutes les applications UDP | Nginx | -- une protection Anti-DDoS OVHcloud ; -- un support de zones multiples (Anycast) ; -- un support HTTP/HTTPS avancé (redirections, headers, ACL...) ; -- un service compatible avec une Additional IP ; -- le vRack est supporté ; -- la redondance : votre Load Balancer fonctionne sur des instances séparées, fonctionnant elles-mêmes sur des équipements séparés et redondants. +### Fonctionnalités principales -### Parties élémentaires +- **Protection anti-DDoS intégrée** pour tous les types de trafic +- **Réseau Anycast mondial** pour une latence optimisée et un basculement automatique +- **Support avancé HTTP/HTTPS** : redirections, en-têtes, ACLs, etc. +- **Compatibilité avec les IP supplémentaires et le vRack** : améliorez la disponibilité et les performances grâce au réseau avancé +- **Haute disponibilité** : instances redondantes isolées pour assurer la résilience +- **Scalabilité** : ajoutez ou retirez des serveurs et des fermes sans interruption de service -- Le service OVHcloud Load Balancer se compose de trois parties élémentaires : +### Vue d’ensemble de l’architecture -![Général](images/diag_gen.png){.thumbnail} +Le Load Balancer est constitué de trois composants principaux : -|Parties Élémentaires|Fonction| +| Composant | Fonction | |---|---| -|Frontend|Le frontend définit le type de protocole (HTTP/TCP/UDP) du service OVHcloud Load Balancer. C'est également la partie qui expose le port d'écoute du service| -|Ferme|La ferme reçoit le trafic provenant du frontend, c'est la partie qui s'occupe de faire la répartition de charge| -|Serveur|Ce sont les serveurs qui reçoivent le trafic final et qui répondent via l'application| - -Avec ces trois parties élémentaires qui composent le Load Balancer, il est possible de configurer à peu près tous les types de load-balancing possibles. - -### Pourquoi utiliser le Load Balancer OVHcloud ? - -#### Répartir la charge - -C'est la fonction élémentaire d'un répartiteur de charge, mais le Load Balancer OVHcloud est capable de bien plus. - -![Distribute load](images/distribute_load.png){.thumbnail} +| **Front-end** | Définit le protocole d’entrée (HTTP/TCP/UDP) et le port d’écoute | +| **Ferme** | Répartit le trafic en provenance du front-end entre les serveurs | +| **Serveur** | Taite le trafic applicatif entrant et sortant | -#### Supprimer le downtime +![Schéma général](images/diag_gen2025.png){.thumbnail} -Le service OVHcloud Load Balancer est capable de détecter automatiquement l'absence de réponse d'un serveur. Dans ce cas de figure, il redirige le trafic à destination de ce serveur vers un autre, si c'est possible. Cela permet de résoudre le problème sans affecter votre production. +## Avantages -![Eliminate downtimes](images/eliminate_downtimes.png){.thumbnail} +### Répartir et scaler sans interruption -#### Faire évoluer facilement votre infrastructure +Répartissez les charges entre plusieurs serveurs et augmentez horizontalement vos ressources sans interruption de service. -Il est possible d'ajouter ou retirer une ferme, un frontend ou un serveur du service OVHcloud Load Balancer sans interruption de service. +![Répartition de charge](images/distribute_load2025.png){.thumbnail} -![Scale your infra easily](images/facilitate_maintenance.png){.thumbnail} +### Haute disponibilité et continuité de service -#### Faciliter les maintenances +Des sondes automatiques détectent les serveurs non réactifs et redirigent instantanément le trafic, minimisant ainsi les interruptions. -En cas de maintenance planifiée sur votre infrastructure, il est désormais facilement possible de placer une ferme en downtime pour qu'elle cesse préventivement de recevoir du trafic. Dans ce cas, il est facile d'intervenir et d'y rajouter votre serveur une fois la maintenance terminée. +![Haute disponibilité](images/eliminate_downtimes2025.png){.thumbnail} -![Facilitates maintenance](images/scale_easily.png){.thumbnail} +### Maintenance simplifiée -#### Varier les services +Mettez une ferme ou un serveur en mode maintenance sans impacter les utilisateurs, puis réintégrez-le facilement après intervention. -Vous pouvez désormais mixer différents services d'OVHcloud dans le Load Balancer, comme par exemple : +![Maintenance simplifiée](images/facilitate_maintenance2025.png){.thumbnail} -- les instances Public Cloud avec Additional IP; -- les VPS avec Additional IP; -- les serveurs dédiés avec Additional IP; -- les vRack. +### Intégration avec les services OVHcloud -![Mix and match service](images/mix_and_match.png){.thumbnail} +Combinez facilement le Load Balancer avec d’autres services OVHcloud : -#### Anycast +- Instances Public Cloud +- VPS +- Serveurs Dédiés +- Réseau privé vRack -Vous pouvez répartir votre charge sur différentes zones géographiques : +![Combiner vos services](images/mix_and_match2025.png){.thumbnail} -![Anycast](images/anycast.png){.thumbnail} +### Distribution géographique (Anycast) -#### Répartir n'importe quel type de trafic +Fournissez un service à vos utilisateurs partout dans le monde avec une faible latence et un routage résilient. -L'OVHcloud Load Balancer peut également être utilisé avec toutes sortes de trafics HTTP, TCP ou UDP. +![Anycast](images/anycast2025.png){.thumbnail} -#### Serveur e-mail +### Cas d’usage variés -Répartissez la charge entre vos serveurs de messagerie : +Prenez en charge de multiples services via du trafic HTTP(S), TCP et UDP. -![Mail](images/mail.png){.thumbnail} +#### Serveurs de messagerie -#### Base de données +Équilibrez la charge entre vos serveurs de messagerie. -Équilibrez et redondez vos bases de données : +![Mail](images/mail2025.png){.thumbnail} -![Database](images/database.png){.thumbnail} +#### Bases de données -## Aller plus loin +Équilibrez vos bases de données et rendez-les redondantes. -[En apprendre plus sur la répartition de charge](https://fr.wikipedia.org/wiki/Repartition_de_charge). +![Bases de données](images/database2025.png){.thumbnail} -[En apprendre plus sur Haproxy](http://www.haproxy.org/#desc). +## Pour aller plus loin -[En apprendre plus sur Nginx](https://fr.wikipedia.org/wiki/Nginx). +- [En apprendre plus sur la répartition de charge (Wikipedia)](https://fr.wikipedia.org/wiki/R%C3%A9partition_de_charge) +- [Site officiel HAProxy](http://www.haproxy.org/#desc) +- [Documentation Nginx](https://nginx.org/en/docs/) -Échangez avec notre [communauté d'utilisateurs](/links/community). +Rejoignez notre [communauté d’utilisateurs](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/use_presentation/guide.it-it.md b/pages/network/load_balancer/use_presentation/guide.it-it.md index e522f22e7bd..35126348ebc 100644 --- a/pages/network/load_balancer/use_presentation/guide.it-it.md +++ b/pages/network/load_balancer/use_presentation/guide.it-it.md @@ -1,120 +1,108 @@ --- -title: 'Presentazione di OVH Load Balancer' -excerpt: 'Scopri il nuovo OVH Load Balancer' -updated: 2018-01-17 +title: Introduction to the OVHcloud Load Balancer +excerpt: Discover the OVHcloud Load Balancer solution for distributing and securing your traffic +updated: 2025-10-29 --- -## Obiettivo +## Objective -Il nuovo [OVH Load Balancer](https://www.ovh.it/soluzioni/load-balancer/) è un ripartitore di carico che combina flessibilità e affidabilità. Non dovrai fare altro che configurare i tuoi prodotti con OVH Load Balancer e noi ci occuperemo di tutto il resto! +The **OVHcloud Load Balancer** is a fully managed service designed to ensure high availability, performance, and scalability for your applications. +Its main role is to distribute workloads across several servers or applications. +Simply configure your services behind the Load Balancer — OVHcloud handles redundancy, security, and global traffic distribution. -**Scopri subito il nuovo OVH Load Balancer** +## Requirements -## Prerequisiti +- Access to the [OVHcloud Control Panel](/links/manager) +- At least one service to balance (Dedicated Server, VPS, Public Cloud instance, etc.) -- Nessun prerequisito specifico +## Instructions -## Procedura +The Load Balancer leverages **industry-standard open-source technologies** to handle different traffic types: - -Questo servizio si basa su tecnologie open source: HAProxy per il traffico TCP e Nginx per il traffico UDP. - -Senza restrizioni! La nuova soluzione di [OVH Load Balancer](https://www.ovh.it/soluzioni/load-balancer/) è stata ideata per funzionare con diversi protocolli: - -|Tipo|Descrizione|Vantaggi|Tecnologia| +| Type | Description | Advantages | Technology | |---|---|---|---| -|HTTP|Per tutti i tipi di servizi Web HTTP/HTTPS|Ottimizzato per l’elaborazione Layer 7 (livello applicativo)|HAProxy| -|TCP|Per tutti i tipi di servizi di rete che non siano HTTP|Può supportare tutte le applicazioni TCP|HAProxy| -|UDP|Per tutti i tipi di protocolli UDP|Può supportare tutte le applicazioni UDP|Nginx| +| HTTP/HTTPS | All web services and APIs | Optimized for L7 (application layer) processing, URL redirection, headers, ACLs | HAProxy | +| TCP | Non-HTTP network services | Supports all TCP applications | HAProxy | +| UDP | All UDP traffic | Supports all UDP applications | Nginx | -Di seguito le funzionalità di OVH Load Balancer: +### Key Features - - protezione Anti-DDoS OVH - - supporto multi-zona (Anycast) - - supporto avanzato HTTP/HTTPS (reindirizzamenti, header, ACL, ecc...) - - servizio compatibile con un Additional IP - - supporto della vRack - - ridondanza: OVH Load Balancer funziona su istanze separate che lavorano a loro volta su dispositivi separati e ridondanti +- **Built-in DDoS protection** across all traffic types +- **Global Anycast network** for optimal latency and failover +- **Advanced HTTP/HTTPS support**: redirections, headers, ACLs, etc. +- **Additional IP and vRack compatibility**: improve availability and performance with advanced networking +- **High availability**: isolated redundant instances ensure resilience +- **Scalability**: add or remove servers and farms without downtime -### Componenti base +### Architecture Overview -- Il nuovo OVH Load Balancer è composto da tre parti essenziali: +The Load Balancer consists of three main components: -![Generale](images/diag_gen.png){.thumbnail} - -|Componenti base|Funzione| +| Component | Function | |---|---| -|Front-end|Definisce il tipo di protocollo (HTTP/TCP/UDP) di OVH Load Balancer ed espone la porta di ascolto del servizio| -|Farm|Riceve il traffico proveniente dal front-end ed è il componente che si occupa di effettuare la ripartizione del carico| -|Server|Ricevono il traffico finale e rispondono tramite l'applicazione| - -Grazie a questi tre componenti alla base del Load Balancer, è possibile configurare praticamente tutte le tipologie di *load balacing* esistenti. - -### Perché scegliere OVH Load Balancer? - -#### Ripartizione del carico - -Questa è la funzione di base di qualsiasi ripartitore di carico, ma OVH Load Balancer fa molto di più: ottimizza la distribuzione delle richieste sulle tue macchine, distribuendole ai server meno carichi, garantendo scalabilità dell'infrastruttura in caso di traffico elevato. - -![Distribute load](images/distribute_load.png){.thumbnail} +| **Front-end** | Defines the entry protocol (HTTP/TCP/UDP) and listening port | +| **Farm** | Distributes traffic from the front-end across servers | +| **Server** | Handles inbound and outbound application traffic | -#### Niente più downtime +![General diagram](images/diag_gen2025.png){.thumbnail} -Il servizio OVH Load Balancer è in grado di rilevare automaticamente l’assenza di risposte da parte di un server, reindirizzando il traffico verso un altro server (se possibile). Ciò consente di risolvere il problema senza danneggiare la produzione. +## Benefits -![Eliminate downtimes](images/eliminate_downtimes.png){.thumbnail} +### Balance and Scale Seamlessly -#### Un’evoluzione dell’infrastruttura senza vincoli +Distribute workloads across multiple servers and scale horizontally without service interruption. -È possibile aggiungere o rimuovere una farm, un front-end o un server da OVH Load Balancer senza alcuna interruzione del servizio. +![Balance the load](images/distribute_load2025.png){.thumbnail} -![Scale your infra easily](images/facilitate_maintenance.png){.thumbnail} +### High Availability and Uptime -#### Semplicità delle manutenzioni +Automatic health checks detect unresponsive servers and reroute traffic instantly, minimizing downtime. -In caso di una manutenzione prevista sulla tua infrastruttura, adesso è possibile impostare facilmente una farm in downtime affinché non riceva più traffico e, una volta completata la manutenzione, sarà altrettanto semplice intervenire e aggiungere nuovamente il server. +![Eliminate downtime](images/eliminate_downtimes2025.png){.thumbnail} -![Facilitates maintenance](images/scale_easily.png){.thumbnail} +### Simplified Maintenance -#### Varietà dei servizi +Place a farm or server in downtime mode for maintenance without impacting users, then reintegrate it seamlessly. -Ora è possibile combinare diversi servizi OVH grazie al Load Balancer, per esempio: +![Make maintenance easier](images/facilitate_maintenance2025.png){.thumbnail} -- le istanze Public Cloud con l’Additional IP -- i VPS con l’Additional IP -- i server dedicati con l’Additional IP -- le vRack +### Service Integration -![Mix and match service](images/mix_and_match.png){.thumbnail} +Easily combine with other OVHcloud services: -#### Anycast +- Public Cloud instances +- VPS +- Dedicated Servers +- vRack private networking -Puoi distribuire il carico su diverse aree geografiche. +![Combine your services](images/mix_and_match2025.png){.thumbnail} -![Anycast](images/anycast.png){.thumbnail} +### Geographic Distribution (Anycast) -#### Ripartizione di tutti i tipi di traffico +Serve users worldwide with low latency and resilient routing. -OVH Load Balancer non è più limitato al traffico HTTP! Adesso puoi utilizzarlo con tutti i tipi di traffico TCP o UDP. +![Anycast](images/anycast2025.png){.thumbnail} -#### Server email +### Versatile Use Cases -Distribuisci il carico tra i tuoi server di posta. +Support multiple services over HTTP(S), TCP, and UDP traffic. -![Mail](images/mail.png){.thumbnail} +#### Email server -#### Database +Balance the load between your email servers. -Distribuzione e ridondanza dei tuoi database. +![Mail](images/mail2025.png){.thumbnail} -![Database](images/database.png){.thumbnail} +#### Databases -## Per saperne di più +Balance your databases, and make them redundant. -[Load balancing](https://it.wikipedia.org/wiki/Load_balancing). +![Databases](images/database2025.png){.thumbnail} -[Haproxy](https://en.wikipedia.org/wiki/HAProxy). +## Go Further -[Nginx](https://it.wikipedia.org/wiki/Nginx). +- [Find out more about load balancing (Wikipedia)](https://en.wikipedia.org/wiki/Load_balancing) +- [HAProxy official site](http://www.haproxy.org/#desc) +- [Nginx documentation](https://nginx.org/en/docs/) -Contatta la nostra Community di utenti all’indirizzo . \ No newline at end of file +Join our [community of users](/links/community). diff --git a/pages/network/load_balancer/use_presentation/guide.pl-pl.md b/pages/network/load_balancer/use_presentation/guide.pl-pl.md index 52a34931d74..35126348ebc 100644 --- a/pages/network/load_balancer/use_presentation/guide.pl-pl.md +++ b/pages/network/load_balancer/use_presentation/guide.pl-pl.md @@ -1,116 +1,108 @@ --- -title: Prezentacja usługi Load Balancer -excerpt: Poznaj nowe rozwiązanie Load Balancer -updated: 2018-01-17 +title: Introduction to the OVHcloud Load Balancer +excerpt: Discover the OVHcloud Load Balancer solution for distributing and securing your traffic +updated: 2025-10-29 --- -## Wprowadzenie +## Objective -Nowa usługa **Load Balancer** umożliwiająca równoważenie obciążenia, charakteryzuje się elastycznością konfiguracji i niezawodnością. Skonfiguruj Twoje produkty z usługą Load Balancer, aby stworzyć wydajną infrastrukturę. +The **OVHcloud Load Balancer** is a fully managed service designed to ensure high availability, performance, and scalability for your applications. +Its main role is to distribute workloads across several servers or applications. +Simply configure your services behind the Load Balancer — OVHcloud handles redundancy, security, and global traffic distribution. -**Poznaj nową usługę Load Balancer.** +## Requirements -## Wymagania początkowe +- Access to the [OVHcloud Control Panel](/links/manager) +- At least one service to balance (Dedicated Server, VPS, Public Cloud instance, etc.) -- Brak specyficznych wymagań +## Instructions -## W praktyce - -Nowa usługa opiera się na solidnych rozwiązaniach open source: Haproxy dla ruchu TCP i Nginx dla ruchu UDP. -Bez ograniczeń. Nowa usługa Load Balancer może współdziałać z różnymi protokołami: +The Load Balancer leverages **industry-standard open-source technologies** to handle different traffic types: -|Typ|Opis|Zalety|Technologia| +| Type | Description | Advantages | Technology | |---|---|---|---| -|HTTP|Wszystkie typy usług WWW HTTP/HTTPS|Zoptymalizowany pod kątem przetwarzania L7 (warstwa aplikacji)|Haproxy| -|TCP|Dla wszystkich usług sieciowych innych nich HTTP|Wspiera wszystkie aplikacje TCP|Haproxy| -|UDP|Dla wszystkich typów ruchu UDP|Wspiera wszystkie aplikacje UDP|Nginx| +| HTTP/HTTPS | All web services and APIs | Optimized for L7 (application layer) processing, URL redirection, headers, ACLs | HAProxy | +| TCP | Non-HTTP network services | Supports all TCP applications | HAProxy | +| UDP | All UDP traffic | Supports all UDP applications | Nginx | -Nowa usługa oferuje: +### Key Features -- ochronę Anty-DDoS, -- wsparcie dla różnych regionów (Anycast), -- zaawansowane wsparcie HTTP/HTTPS (przekierowania, nagłówki, ACL, etc.), -- kompatybilność z Additional IP, -- kompatybilność z technologią wykorzystaną w vRack, -- redundancję: Twój Load Balancer działa na odizolowanych instancjach, które również pracują w oparciu o oddzielone i redundantne urządzenia. +- **Built-in DDoS protection** across all traffic types +- **Global Anycast network** for optimal latency and failover +- **Advanced HTTP/HTTPS support**: redirections, headers, ACLs, etc. +- **Additional IP and vRack compatibility**: improve availability and performance with advanced networking +- **High availability**: isolated redundant instances ensure resilience +- **Scalability**: add or remove servers and farms without downtime -### Podstawowe części składowe usługi +### Architecture Overview -- Nowa usługa Load Balancer obejmuje trzy części składowe: +The Load Balancer consists of three main components: -![Diagram - Load Balancer](images/diag_gen.png){.thumbnail} +| Component | Function | +|---|---| +| **Front-end** | Defines the entry protocol (HTTP/TCP/UDP) and listening port | +| **Farm** | Distributes traffic from the front-end across servers | +| **Server** | Handles inbound and outbound application traffic | -|Części składowe|Funkcja| -|---|---| -|Front-end|Front-end określa typ protokołu (HTTP/TCP/UDP) zastosowanego w usłudze Load Balancer. Jest to również część zawierająca port nasłuchujący usługi.| -|Farma|Farma przyjmuje ruch pochodzący z front-endu. Jest to część odpowiedzialna za równoważenie obciążenia.| -|Serwer|Ruch dociera ostatecznie do serwerów, które odpowiadają poprzez aplikację| +![General diagram](images/diag_gen2025.png){.thumbnail} -Dzięki tym trzem częściom składającym się na usługę Load Balancer, możliwe jest skonfigurowanie niemal wszystkich typów równoważenia obciążenia. +## Benefits -### Funkcje Load Balancera +### Balance and Scale Seamlessly -#### Równoważnie obciążenia +Distribute workloads across multiple servers and scale horizontally without service interruption. -Podstawową funkcją Load Balancera jest równoważenie obciążenia. +![Balance the load](images/distribute_load2025.png){.thumbnail} -![Równoważenie obciążenia](images/distribute_load.png){.thumbnail} +### High Availability and Uptime -#### Zapewnienie ciągłości działania usług +Automatic health checks detect unresponsive servers and reroute traffic instantly, minimizing downtime. -Usługa Load Balancer wykrywa automatycznie brak odpowiedzi serwera. W takim przypadku, jeśli to możliwe, Load Balancer przekierowuje ruch z niedostępnego serwera na kolejny serwer w farmie. Dzięki temu problem zostaje rozwiązany bez naruszenia ciągłości działania Twojej usługi. +![Eliminate downtime](images/eliminate_downtimes2025.png){.thumbnail} -![Eliminacja przerw w ciągłości usługi](images/eliminate_downtimes.png){.thumbnail} +### Simplified Maintenance -#### Skalowalność Twojej infrastruktury +Place a farm or server in downtime mode for maintenance without impacting users, then reintegrate it seamlessly. -W ramach usługi Load Balancer możesz dodać lub usunąć farmę, front-end czy też serwer bez przerywania ciągłości działania usługi. +![Make maintenance easier](images/facilitate_maintenance2025.png){.thumbnail} -![Skalowalność Twojej infrastruktury](images/facilitate_maintenance.png){.thumbnail} +### Service Integration -#### Ułatwiona konserwacja infrastruktury +Easily combine with other OVHcloud services: -W przypadku zaplanowanych prac konserwacyjnych infrastruktury możesz wyłączyć jedną z farm, aby nie przyjmowała ruchu w czasie interwencji technicznej. Po zakończeniu prac, z łatwością znowu dodasz ją do infrastuktury. +- Public Cloud instances +- VPS +- Dedicated Servers +- vRack private networking -![Ułatwiona konserwacja infrastruktury](images/scale_easily.png){.thumbnail} +![Combine your services](images/mix_and_match2025.png){.thumbnail} -#### Łączenie usług +### Geographic Distribution (Anycast) -Korzystając z rozwiązania Load Balancer, możesz łączyć ze sobą różne typy usług w ramach jednej infrastruktury np.: +Serve users worldwide with low latency and resilient routing. -- instancje Public Cloud z Additional IP, -- serwery VPS z Additional IP, -- serwery dedykowane z Additional IP, -- vRack. +![Anycast](images/anycast2025.png){.thumbnail} -![Łączenie usług](images/mix_and_match.png){.thumbnail} +### Versatile Use Cases -#### Anycast +Support multiple services over HTTP(S), TCP, and UDP traffic. -Load balancer umożliwia rozłożenie ruchu na kilka stref geograficznych: +#### Email server -![Anycast](images/anycast.png){.thumbnail} +Balance the load between your email servers. -#### Rozdzielanie wszystkich typów ruchu +![Mail](images/mail2025.png){.thumbnail} -Load Balancer, oprócz ruchu HTTP, obsługuje wszystkie typu ruchu TCP i UDP. +#### Databases -#### Serwer poczty e-mail +Balance your databases, and make them redundant. -Tworząc farmę serwerów, zrównoważysz obciążenie i rozłożysz ruch pomiędzy serwery poczty elektronicznej: +![Databases](images/database2025.png){.thumbnail} -![Mail](images/mail.png){.thumbnail} +## Go Further -#### Bazy danych +- [Find out more about load balancing (Wikipedia)](https://en.wikipedia.org/wiki/Load_balancing) +- [HAProxy official site](http://www.haproxy.org/#desc) +- [Nginx documentation](https://nginx.org/en/docs/) -Dzięki Load balancerowi, zadbasz o redundancję i zrównoważone obciążenie serwerów baz danych: - -![Bazy danych](images/database.png){.thumbnail} - -## Sprawdź również - -[Dowiedz się więcej o Haproxy](http://www.haproxy.org/#desc). - -[Dowiedz się więcej o Nginx](https://pl.wikipedia.org/wiki/Nginx). - -Przyłącz się do społeczności naszych użytkowników na stronie. \ No newline at end of file +Join our [community of users](/links/community). diff --git a/pages/network/load_balancer/use_presentation/guide.pt-pt.md b/pages/network/load_balancer/use_presentation/guide.pt-pt.md index 7c78349e3a5..35126348ebc 100644 --- a/pages/network/load_balancer/use_presentation/guide.pt-pt.md +++ b/pages/network/load_balancer/use_presentation/guide.pt-pt.md @@ -1,120 +1,108 @@ --- -title: Apresentação do Load Balancer OVH -excerpt: Conheça o Load Balancer OVH -updated: 2018-01-17 +title: Introduction to the OVHcloud Load Balancer +excerpt: Discover the OVHcloud Load Balancer solution for distributing and securing your traffic +updated: 2025-10-29 --- -## Sumário +## Objective -O Load Balancer OVH é um repartidor de carga (balanceador de carga) caracterizado pela facilidade de configuração e pela fiabilidade. Configure os seus produtos com o Load Balancer OVH. Nós tratamos do resto! +The **OVHcloud Load Balancer** is a fully managed service designed to ensure high availability, performance, and scalability for your applications. +Its main role is to distribute workloads across several servers or applications. +Simply configure your services behind the Load Balancer — OVHcloud handles redundancy, security, and global traffic distribution. -**Descubra agora o Load Balancer da OVH** +## Requirements -## Requisitos +- Access to the [OVHcloud Control Panel](/links/manager) +- At least one service to balance (Dedicated Server, VPS, Public Cloud instance, etc.) -- Sem requisitos específicos. +## Instructions -## Descrição +The Load Balancer leverages **industry-standard open-source technologies** to handle different traffic types: - -O novo Load Balancer assenta nas melhores soluções open source: Haproxy para o tráfego TCP e Nginx para o tráfego UDP. - - Além disso, a nova solução pode ser usada com diferentes protocolos: - -|Tipo|Descrição|Vantagens|Tecnologia| +| Type | Description | Advantages | Technology | |---|---|---|---| -|HTTP|Qualquer tipo de serviço web HTTP/HTTPS|Otimizado para processamento L7 (aplicações)|Haproxy| -|TCP|Qualquer serviço de rede que não seja HTTP|Compatível com todas as aplicações TCP|Haproxy| -|UDP|Qualquer tipo de tráfego UDP|Compatível com todas as aplicações UDP|Nginx| +| HTTP/HTTPS | All web services and APIs | Optimized for L7 (application layer) processing, URL redirection, headers, ACLs | HAProxy | +| TCP | Non-HTTP network services | Supports all TCP applications | HAProxy | +| UDP | All UDP traffic | Supports all UDP applications | Nginx | -Características do serviço: +### Key Features -- proteção Anti-DDoS OVH; - - replicação DNS em várias zonas geográficas (Anycast); - - funções avançadas para HTTP/HTTPS (reencaminhamento, headers, ACL...); - - compatibilidade com Additional IP; - - compatibilidade com vRack; - - redundância: o Load Balancer funciona em instâncias diferentes, alojadas em equipamentos separados, protegidos por sistemas redundantes. +- **Built-in DDoS protection** across all traffic types +- **Global Anycast network** for optimal latency and failover +- **Advanced HTTP/HTTPS support**: redirections, headers, ACLs, etc. +- **Additional IP and vRack compatibility**: improve availability and performance with advanced networking +- **High availability**: isolated redundant instances ensure resilience +- **Scalability**: add or remove servers and farms without downtime -### Principais elementos +### Architecture Overview -- A nova oferta Load Balancer OVH é composta por três elementos principais: +The Load Balancer consists of three main components: -![Geral](images/diag_gen.png){.thumbnail} - -|Principais elementos|Função| +| Component | Function | |---|---| -|Frontend|O Frontend permite definir o tipo de protocolo (HTTP/TCP/UDP) do serviço Load Balancer OVH. Este inclui ainda a porta de escuta do serviço| -|Farm|A Farm recebe o tráfego proveniente do Frontend; esta é a componente associada à repartição da carga| -|Server|Servidores que recebem o tráfego final e que respondem através da aplicação| - -Os elementos principais do Load Balancer permitem configurar praticamente qualquer tipo de load balancing. - -### Vantagens do Load Balancer OVH - -#### Repartir o tráfego - -A distribuição do tráfego é a função básica de um Load Balancer, mas a solução da OVH faz muito mais do que isso. - -![Distribuir o tráfego](images/distribute_load.png){.thumbnail} +| **Front-end** | Defines the entry protocol (HTTP/TCP/UDP) and listening port | +| **Farm** | Distributes traffic from the front-end across servers | +| **Server** | Handles inbound and outbound application traffic | -#### Eliminar os riscos de downtime +![General diagram](images/diag_gen2025.png){.thumbnail} -O Load Balancer OVH deteta automaticamente a ausência de resposta de um servidor. Nessa altura, redireciona o tráfego do servidor indisponível para outro servidor. Resultado: o problema é resolvido sem qualquer interrupção do serviço. +## Benefits -![Eliminar downtime](images/eliminate_downtimes.png){.thumbnail} +### Balance and Scale Seamlessly -#### Ajustar capacidade da infraestrutura de forma fácil +Distribute workloads across multiple servers and scale horizontally without service interruption. -A solução OVH permite adicionar ou eliminar uma Farm, um Frontend ou um servidor do Load Balancer OVH sem interrupção do serviço. +![Balance the load](images/distribute_load2025.png){.thumbnail} -![Escalar infraestrutura](images/facilitate_maintenance.png){.thumbnail} +### High Availability and Uptime -#### Manutenção mais simples +Automatic health checks detect unresponsive servers and reroute traffic instantly, minimizing downtime. -A infraestrutura tem uma tarefa de manutenção agendada? Agora é possível desativar temporariamente uma server farm com toda a facilidade, para que esta deixe de receber tráfego durante o período da manutenção. Quando a intervenção terminar, pode adicionar novamente os servidores. +![Eliminate downtime](images/eliminate_downtimes2025.png){.thumbnail} -![Manutenção fácil](images/scale_easily.png){.thumbnail} +### Simplified Maintenance -#### Combinar vários serviços +Place a farm or server in downtime mode for maintenance without impacting users, then reintegrate it seamlessly. -O Load Balancer permite usar ou combinar diferentes serviços da OVH, como por exemplo: +![Make maintenance easier](images/facilitate_maintenance2025.png){.thumbnail} -- instâncias Public Cloud com Additional IP; -- VPS com Additional IP; -- servidores dedicados com Additional IP; -- vRack (redes privadas). +### Service Integration -![Combinar diferentes serviços](images/mix_and_match.png){.thumbnail} +Easily combine with other OVHcloud services: -#### Anycast +- Public Cloud instances +- VPS +- Dedicated Servers +- vRack private networking -Com o Anycast, pode distribuir o tráfego dos serviços por diferentes zonas geográficas: +![Combine your services](images/mix_and_match2025.png){.thumbnail} -![Anycast](images/anycast.png){.thumbnail} +### Geographic Distribution (Anycast) -#### Repartir qualquer tipo de tráfego +Serve users worldwide with low latency and resilient routing. -O Load Balancer OVH pode ser usado para repartir tráfego HTTP, TCP ou UDP. +![Anycast](images/anycast2025.png){.thumbnail} -#### Servidor de e-mail +### Versatile Use Cases -Também pode repartir o tráfego entre os servidores de e-mail: +Support multiple services over HTTP(S), TCP, and UDP traffic. -![Mail](images/mail.png){.thumbnail} +#### Email server -#### Base de dados +Balance the load between your email servers. -Equilibre o esforço das base de dados e crie redundâncias: +![Mail](images/mail2025.png){.thumbnail} -![Bases de Dados](images/database.png){.thumbnail} +#### Databases -## Quer saber mais? Consulte a informação abaixo +Balance your databases, and make them redundant. -[Saber mais sobre o Load Balancer](https://pt.wikipedia.org/wiki/Balanceamento_de_carga). +![Databases](images/database2025.png){.thumbnail} -[Saber mais sobre Haproxy](http://www.haproxy.org/#desc). +## Go Further -[Saber mais sobre Nginx](https://pt.wikipedia.org/wiki/Nginx). +- [Find out more about load balancing (Wikipedia)](https://en.wikipedia.org/wiki/Load_balancing) +- [HAProxy official site](http://www.haproxy.org/#desc) +- [Nginx documentation](https://nginx.org/en/docs/) -Ou fale com a nossa comunidade de utilizadores: . \ No newline at end of file +Join our [community of users](/links/community). diff --git a/pages/network/load_balancer/use_presentation/images/anycast.png b/pages/network/load_balancer/use_presentation/images/anycast.png deleted file mode 100644 index e3c1e4d9f95..00000000000 Binary files a/pages/network/load_balancer/use_presentation/images/anycast.png and /dev/null differ diff --git a/pages/network/load_balancer/use_presentation/images/anycast2025.png b/pages/network/load_balancer/use_presentation/images/anycast2025.png new file mode 100644 index 00000000000..7aaa6c28228 Binary files /dev/null and b/pages/network/load_balancer/use_presentation/images/anycast2025.png differ diff --git a/pages/network/load_balancer/use_presentation/images/database.png b/pages/network/load_balancer/use_presentation/images/database.png deleted file mode 100644 index f9368f05654..00000000000 Binary files a/pages/network/load_balancer/use_presentation/images/database.png and /dev/null differ diff --git a/pages/network/load_balancer/use_presentation/images/database2025.png b/pages/network/load_balancer/use_presentation/images/database2025.png new file mode 100644 index 00000000000..e7d329d2cf2 Binary files /dev/null and b/pages/network/load_balancer/use_presentation/images/database2025.png differ diff --git a/pages/network/load_balancer/use_presentation/images/diag_gen.png b/pages/network/load_balancer/use_presentation/images/diag_gen.png deleted file mode 100644 index fc4bad58c23..00000000000 Binary files a/pages/network/load_balancer/use_presentation/images/diag_gen.png and /dev/null differ diff --git a/pages/network/load_balancer/use_presentation/images/diag_gen2025.png b/pages/network/load_balancer/use_presentation/images/diag_gen2025.png new file mode 100644 index 00000000000..7d5fc478bc8 Binary files /dev/null and b/pages/network/load_balancer/use_presentation/images/diag_gen2025.png differ diff --git a/pages/network/load_balancer/use_presentation/images/distribute_load.png b/pages/network/load_balancer/use_presentation/images/distribute_load.png deleted file mode 100644 index 91314fb9c90..00000000000 Binary files a/pages/network/load_balancer/use_presentation/images/distribute_load.png and /dev/null differ diff --git a/pages/network/load_balancer/use_presentation/images/distribute_load2025.png b/pages/network/load_balancer/use_presentation/images/distribute_load2025.png new file mode 100644 index 00000000000..5bc7c015b11 Binary files /dev/null and b/pages/network/load_balancer/use_presentation/images/distribute_load2025.png differ diff --git a/pages/network/load_balancer/use_presentation/images/eliminate_downtimes.png b/pages/network/load_balancer/use_presentation/images/eliminate_downtimes.png deleted file mode 100644 index ee42cd0c400..00000000000 Binary files a/pages/network/load_balancer/use_presentation/images/eliminate_downtimes.png and /dev/null differ diff --git a/pages/network/load_balancer/use_presentation/images/eliminate_downtimes2025.png b/pages/network/load_balancer/use_presentation/images/eliminate_downtimes2025.png new file mode 100644 index 00000000000..f7657b834f8 Binary files /dev/null and b/pages/network/load_balancer/use_presentation/images/eliminate_downtimes2025.png differ diff --git a/pages/network/load_balancer/use_presentation/images/facilitate_maintenance.png b/pages/network/load_balancer/use_presentation/images/facilitate_maintenance.png deleted file mode 100644 index 0d96e5b85a3..00000000000 Binary files a/pages/network/load_balancer/use_presentation/images/facilitate_maintenance.png and /dev/null differ diff --git a/pages/network/load_balancer/use_presentation/images/facilitate_maintenance2025.png b/pages/network/load_balancer/use_presentation/images/facilitate_maintenance2025.png new file mode 100644 index 00000000000..e54840b9cb8 Binary files /dev/null and b/pages/network/load_balancer/use_presentation/images/facilitate_maintenance2025.png differ diff --git a/pages/network/load_balancer/use_presentation/images/mail.png b/pages/network/load_balancer/use_presentation/images/mail.png deleted file mode 100644 index b080a57e169..00000000000 Binary files a/pages/network/load_balancer/use_presentation/images/mail.png and /dev/null differ diff --git a/pages/network/load_balancer/use_presentation/images/mail2025.png b/pages/network/load_balancer/use_presentation/images/mail2025.png new file mode 100644 index 00000000000..cb35e9f663d Binary files /dev/null and b/pages/network/load_balancer/use_presentation/images/mail2025.png differ diff --git a/pages/network/load_balancer/use_presentation/images/mix_and_match.png b/pages/network/load_balancer/use_presentation/images/mix_and_match.png deleted file mode 100644 index 4041d03fd10..00000000000 Binary files a/pages/network/load_balancer/use_presentation/images/mix_and_match.png and /dev/null differ diff --git a/pages/network/load_balancer/use_presentation/images/mix_and_match2025.png b/pages/network/load_balancer/use_presentation/images/mix_and_match2025.png new file mode 100644 index 00000000000..8d1925210e3 Binary files /dev/null and b/pages/network/load_balancer/use_presentation/images/mix_and_match2025.png differ diff --git a/pages/network/load_balancer/use_presentation/images/scale_easily.png b/pages/network/load_balancer/use_presentation/images/scale_easily.png deleted file mode 100644 index 9be1f37547b..00000000000 Binary files a/pages/network/load_balancer/use_presentation/images/scale_easily.png and /dev/null differ diff --git a/pages/network/load_balancer/vrack_and_loadbalancer/images/eligibility_lb.png b/pages/network/load_balancer/vrack_and_loadbalancer/images/eligibility_lb.png deleted file mode 100644 index d7a91baa4d1..00000000000 Binary files a/pages/network/load_balancer/vrack_and_loadbalancer/images/eligibility_lb.png and /dev/null differ diff --git a/pages/network/load_balancer/zones/guide.en-asia.md b/pages/network/load_balancer/zones/guide.en-asia.md index 7b7d18bfbb6..7dbf920d4f1 100644 --- a/pages/network/load_balancer/zones/guide.en-asia.md +++ b/pages/network/load_balancer/zones/guide.en-asia.md @@ -1,18 +1,57 @@ --- -title: Working with zones +title: How to configure the OVHcloud Load Balancer in multiple zones excerpt: Use zones to increase availability and decrease latency -updated: 2025-07-30 +updated: 2025-12-02 --- -## Introduction +## Objective -The OVH Load Balancer service is located in one or more availability area(s), -defined when subscribing to the service. +The OVHcloud Load Balancer is a critical component for distributing network traffic across your infrastructure. To ensure the highest level of service and optimal user experience, it is essential to deploy your Load Balancer across multiple availability zones (AZ). When subscribing to an OVHcloud Load Balancer service, **you may choose one or more availability zones** in which the service will be located. You also have the possibility to **order additional zones** for an existing service. -You have the possibility to order additional zones for your service. -This increases the availability of your Load Balancer service in case a zone is unavailable. +Configuring your OVHcloud Load Balancer in multiple availability zones will help you **increase the reliability** of your Load Balancer service in case a zone is unavailable, or **minimize latency** for your users by directing the traffic to the service nearest to them. -It is also possible, if configured appropriately, to use multiple zones to minimize latency for your visitors. +This guide details how to configure and utilize these multiple zones to achieve enhanced performance and resilience. + +> [!primary] +> +> Due to technical restrictions, when configuring an OVHcloud Load Balancer with two zones, if one is located in an APAC region and the other is not, traffic will be preferentially routed through the non-APAC zone first, even when the Load Balancer service is out of order in that zone. +> +> This behavior is specific to cross-continent setups involving APAC zones. Therefore, we do not recommend configuring your Load Balancer in this manner. +> +> You may find a list of OVHcloud regions on [our website](/links/infrareg). +> + +## Requirements + +- An [OVHcloud Load Balancer](/links/network/load-balancer) service +- Access to the [OVHcloud Control Panel](/links/manager) + +## Introduction to availability zones + +### Multi-region configuration + +Load balancing across multiple regions offers **maximum disaster recovery against widespread regional outages** and allows for worldwide entry points that significantly **reduce latency** by routing users to the **nearest server**. Most regions only have one availability zone, which means that working with several zones usually involves working with several regions. + +By leveraging an **Anycast network**, the OVHcloud Load Balancer can redirect requests coming from a specific region to the geographically nearest backend servers. + +To achieve this, you need to specify a frontend in each zone that uses a cluster in the same zone. This will allow you to declare backend servers in different clusters per zone and to control which backend servers are used in which zone. + +![Operation with several zones and several clusters](images/multi_zones_multi_backends.png){.thumbnail} +*Diagram representing a load balancer distributing traffic across two regions* + +For example, if you have backend servers in the Gravelines (GRA) and Beauharnois (BHS) regions, you can order a Load Balancer service in the `GRA` and `BHS` zones and configure: + +- A frontend in the GRA zone with a default cluster in the GRA zone which contains servers in the Gravelines datacenter. +- A frontend in the BHS zone with a default cluster in the BHS zone that contains servers in the Beauharnois datacenter. + +### Multi-AZ regions + +OVHcloud is currently rolling out its strategic plan for multi-Availability Zone (multi-AZ) regions, beginning with the launch of Paris 3-AZ in April 2024 and Milan 3-AZ in November 2025. + +Load balancing across several Availability Zones (AZs) within the same region, in contrast to a multi-region configuration, ensures **high availability**, **high performance** and **fault tolerance against local outages**, using **low-latency connections** and **Anycast** to distribute traffic in the most efficient way. + +![Difference between multi-region and multi-AZ deployments](images/multi-az.png){.thumbnail} +*Diagram representing a load balancer distributing traffic across the zones of a single multi-AZ region* ## Instructions @@ -20,14 +59,14 @@ It is also possible, if configured appropriately, to use multiple zones to minim #### From the OVHcloud Control Panel -You can order an additional zone from the [OVHcloud Control Panel](/links/manager). In the `Bare Metal Cloud`{.action} section, click `Network`{.action}, then `Load Balancer`{.action}. +You can order an additional zone from the [OVHcloud Control Panel](/links/manager). In the `Network`{.action} section, under `Network services`{.action}, click on `Load Balancer`{.action}. Select your Load Balancer, then in the `Home`{.action} tab and the `Configuration`{.action} menu, click `Add`{.action} in the "Availability zones" section. ![Add a Load Balancer zone from the manager](images/add_Zone_IPLB.png){.thumbnail} Then select the zone(s) you wish to order and click `Add`{.action}. -  + ![Selection of a Load Balancer zone from the manager](images/Select_Zone_IPLB.png){.thumbnail} A purchase order will be generated, which you'll need to pay. @@ -43,30 +82,30 @@ To order a zone via the API, you first need to create a cart. > @api {v1} /order POST /order/cart > -Please make a note of the cart number ("cart"), it will be useful for the rest. +Please make a note of the cart ID ("cart"), it will be useful later in the ordering process. -Then you assign it via +Then, assign the cart to your OVHcloud account via the following call: > [!api] > > @api {v1} /order POST /order/cart/{cartId}/assign > -You can list the options available on your Load Balancer service via +You can list the options available on your Load Balancer service via the following call: > [!api] > > @api {v1} /order GET /order/cartServiceOption/ipLoadbalancing/{serviceName} > -When you have found the option corresponding to the desired area, you can add it to your shopping cart ("cart") via +When you have found the option corresponding to the desired area, you can add it to your shopping cart ("cart") via the following call: > [!api] > > @api {v1} /order POST /order/cartServiceOption/ipLoadbalancing/{serviceName} > -Finally, you can validate your cart ("cart") via +Finally, you can validate your cart ("cart") via the following call: > [!api] > @api {v1} /order POST /order/cart/{cartId}/checkout @@ -74,13 +113,15 @@ Finally, you can validate your cart ("cart") via Don't forget to pay the order form thus generated. -### Add a zone +### Configure your frontend -Once your zone order is finalized, you can add it from your OVHcloud Control Panel. +Once your zone order is finalized, you can add it to your Load Balancer from the OVHcloud Control Panel. Select the Load Balancer you wish to modify, then create a new frontend, or edit an existing one, via the `Frontends`{.action} tab. -In the `Datacenter`{.action} field, choose the zone you wish to associate with your frontend. +In the `Datacenter`{.action} field, choose the zone you wish to associate with your frontend. + +If you want to use multiple zones, you can choose the special `ALL` zone. This special zone will allow you to deploy the same configuration on all zones subscribed to your Load Balancer service, which spares you having to duplicate the configuration for all zones. ![Zone selection](images/Select-Datacenter.png){.thumbnail} @@ -90,29 +131,6 @@ Don't forget to deploy the configuration. To do this, click `Apply configuration ![Applying a Load Balancer Configuration](images/apply-configuration.PNG){.thumbnail} -## Use multiple zones - -### For high availability - -If you want to use multiple zones to achieve high availability, you can use the special `all` zone when you declare a `frontend` and a `farm`. - -This special `all` zone will allow you to deploy the same configuration on all zones subscribed to your Load Balancer service, and avoids you to duplicate the configuration for all zones. - -### To reduce latency - -If the goal is to reduce latency, we can imagine directing requests coming from the zone1 load balancer to backend servers geographically close to zone1, and similarly, directing requests coming from the zone2 load balancer to backend servers close to zone2. - -To achieve this, you need to specify a frontend in each zone that uses a cluster in the same zone. -This will allow us to declare backend servers in different clusters per zone and to control which backend servers are used in which zone. - -![Operation with several zones and several clusters](images/multi_zones_multi_backends.png){.thumbnail} - -For example, if we have backend servers in the data centers of Gravelines (gra) and Beauharnois (bhs), -you can order a Load Balancer service in the `gra` and `bhs` areas and configure : - -- A frontend in the gra zone with as default cluster in the gra zone which contains servers in the Gravelines datacenter -- A frontend in the bhs zone with a default cluster in the bhs zone that contains servers in the Beauharnois datacenter - ## Go further Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/zones/guide.en-au.md b/pages/network/load_balancer/zones/guide.en-au.md index 7b7d18bfbb6..7dbf920d4f1 100644 --- a/pages/network/load_balancer/zones/guide.en-au.md +++ b/pages/network/load_balancer/zones/guide.en-au.md @@ -1,18 +1,57 @@ --- -title: Working with zones +title: How to configure the OVHcloud Load Balancer in multiple zones excerpt: Use zones to increase availability and decrease latency -updated: 2025-07-30 +updated: 2025-12-02 --- -## Introduction +## Objective -The OVH Load Balancer service is located in one or more availability area(s), -defined when subscribing to the service. +The OVHcloud Load Balancer is a critical component for distributing network traffic across your infrastructure. To ensure the highest level of service and optimal user experience, it is essential to deploy your Load Balancer across multiple availability zones (AZ). When subscribing to an OVHcloud Load Balancer service, **you may choose one or more availability zones** in which the service will be located. You also have the possibility to **order additional zones** for an existing service. -You have the possibility to order additional zones for your service. -This increases the availability of your Load Balancer service in case a zone is unavailable. +Configuring your OVHcloud Load Balancer in multiple availability zones will help you **increase the reliability** of your Load Balancer service in case a zone is unavailable, or **minimize latency** for your users by directing the traffic to the service nearest to them. -It is also possible, if configured appropriately, to use multiple zones to minimize latency for your visitors. +This guide details how to configure and utilize these multiple zones to achieve enhanced performance and resilience. + +> [!primary] +> +> Due to technical restrictions, when configuring an OVHcloud Load Balancer with two zones, if one is located in an APAC region and the other is not, traffic will be preferentially routed through the non-APAC zone first, even when the Load Balancer service is out of order in that zone. +> +> This behavior is specific to cross-continent setups involving APAC zones. Therefore, we do not recommend configuring your Load Balancer in this manner. +> +> You may find a list of OVHcloud regions on [our website](/links/infrareg). +> + +## Requirements + +- An [OVHcloud Load Balancer](/links/network/load-balancer) service +- Access to the [OVHcloud Control Panel](/links/manager) + +## Introduction to availability zones + +### Multi-region configuration + +Load balancing across multiple regions offers **maximum disaster recovery against widespread regional outages** and allows for worldwide entry points that significantly **reduce latency** by routing users to the **nearest server**. Most regions only have one availability zone, which means that working with several zones usually involves working with several regions. + +By leveraging an **Anycast network**, the OVHcloud Load Balancer can redirect requests coming from a specific region to the geographically nearest backend servers. + +To achieve this, you need to specify a frontend in each zone that uses a cluster in the same zone. This will allow you to declare backend servers in different clusters per zone and to control which backend servers are used in which zone. + +![Operation with several zones and several clusters](images/multi_zones_multi_backends.png){.thumbnail} +*Diagram representing a load balancer distributing traffic across two regions* + +For example, if you have backend servers in the Gravelines (GRA) and Beauharnois (BHS) regions, you can order a Load Balancer service in the `GRA` and `BHS` zones and configure: + +- A frontend in the GRA zone with a default cluster in the GRA zone which contains servers in the Gravelines datacenter. +- A frontend in the BHS zone with a default cluster in the BHS zone that contains servers in the Beauharnois datacenter. + +### Multi-AZ regions + +OVHcloud is currently rolling out its strategic plan for multi-Availability Zone (multi-AZ) regions, beginning with the launch of Paris 3-AZ in April 2024 and Milan 3-AZ in November 2025. + +Load balancing across several Availability Zones (AZs) within the same region, in contrast to a multi-region configuration, ensures **high availability**, **high performance** and **fault tolerance against local outages**, using **low-latency connections** and **Anycast** to distribute traffic in the most efficient way. + +![Difference between multi-region and multi-AZ deployments](images/multi-az.png){.thumbnail} +*Diagram representing a load balancer distributing traffic across the zones of a single multi-AZ region* ## Instructions @@ -20,14 +59,14 @@ It is also possible, if configured appropriately, to use multiple zones to minim #### From the OVHcloud Control Panel -You can order an additional zone from the [OVHcloud Control Panel](/links/manager). In the `Bare Metal Cloud`{.action} section, click `Network`{.action}, then `Load Balancer`{.action}. +You can order an additional zone from the [OVHcloud Control Panel](/links/manager). In the `Network`{.action} section, under `Network services`{.action}, click on `Load Balancer`{.action}. Select your Load Balancer, then in the `Home`{.action} tab and the `Configuration`{.action} menu, click `Add`{.action} in the "Availability zones" section. ![Add a Load Balancer zone from the manager](images/add_Zone_IPLB.png){.thumbnail} Then select the zone(s) you wish to order and click `Add`{.action}. -  + ![Selection of a Load Balancer zone from the manager](images/Select_Zone_IPLB.png){.thumbnail} A purchase order will be generated, which you'll need to pay. @@ -43,30 +82,30 @@ To order a zone via the API, you first need to create a cart. > @api {v1} /order POST /order/cart > -Please make a note of the cart number ("cart"), it will be useful for the rest. +Please make a note of the cart ID ("cart"), it will be useful later in the ordering process. -Then you assign it via +Then, assign the cart to your OVHcloud account via the following call: > [!api] > > @api {v1} /order POST /order/cart/{cartId}/assign > -You can list the options available on your Load Balancer service via +You can list the options available on your Load Balancer service via the following call: > [!api] > > @api {v1} /order GET /order/cartServiceOption/ipLoadbalancing/{serviceName} > -When you have found the option corresponding to the desired area, you can add it to your shopping cart ("cart") via +When you have found the option corresponding to the desired area, you can add it to your shopping cart ("cart") via the following call: > [!api] > > @api {v1} /order POST /order/cartServiceOption/ipLoadbalancing/{serviceName} > -Finally, you can validate your cart ("cart") via +Finally, you can validate your cart ("cart") via the following call: > [!api] > @api {v1} /order POST /order/cart/{cartId}/checkout @@ -74,13 +113,15 @@ Finally, you can validate your cart ("cart") via Don't forget to pay the order form thus generated. -### Add a zone +### Configure your frontend -Once your zone order is finalized, you can add it from your OVHcloud Control Panel. +Once your zone order is finalized, you can add it to your Load Balancer from the OVHcloud Control Panel. Select the Load Balancer you wish to modify, then create a new frontend, or edit an existing one, via the `Frontends`{.action} tab. -In the `Datacenter`{.action} field, choose the zone you wish to associate with your frontend. +In the `Datacenter`{.action} field, choose the zone you wish to associate with your frontend. + +If you want to use multiple zones, you can choose the special `ALL` zone. This special zone will allow you to deploy the same configuration on all zones subscribed to your Load Balancer service, which spares you having to duplicate the configuration for all zones. ![Zone selection](images/Select-Datacenter.png){.thumbnail} @@ -90,29 +131,6 @@ Don't forget to deploy the configuration. To do this, click `Apply configuration ![Applying a Load Balancer Configuration](images/apply-configuration.PNG){.thumbnail} -## Use multiple zones - -### For high availability - -If you want to use multiple zones to achieve high availability, you can use the special `all` zone when you declare a `frontend` and a `farm`. - -This special `all` zone will allow you to deploy the same configuration on all zones subscribed to your Load Balancer service, and avoids you to duplicate the configuration for all zones. - -### To reduce latency - -If the goal is to reduce latency, we can imagine directing requests coming from the zone1 load balancer to backend servers geographically close to zone1, and similarly, directing requests coming from the zone2 load balancer to backend servers close to zone2. - -To achieve this, you need to specify a frontend in each zone that uses a cluster in the same zone. -This will allow us to declare backend servers in different clusters per zone and to control which backend servers are used in which zone. - -![Operation with several zones and several clusters](images/multi_zones_multi_backends.png){.thumbnail} - -For example, if we have backend servers in the data centers of Gravelines (gra) and Beauharnois (bhs), -you can order a Load Balancer service in the `gra` and `bhs` areas and configure : - -- A frontend in the gra zone with as default cluster in the gra zone which contains servers in the Gravelines datacenter -- A frontend in the bhs zone with a default cluster in the bhs zone that contains servers in the Beauharnois datacenter - ## Go further Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/zones/guide.en-ca.md b/pages/network/load_balancer/zones/guide.en-ca.md index 7b7d18bfbb6..7dbf920d4f1 100644 --- a/pages/network/load_balancer/zones/guide.en-ca.md +++ b/pages/network/load_balancer/zones/guide.en-ca.md @@ -1,18 +1,57 @@ --- -title: Working with zones +title: How to configure the OVHcloud Load Balancer in multiple zones excerpt: Use zones to increase availability and decrease latency -updated: 2025-07-30 +updated: 2025-12-02 --- -## Introduction +## Objective -The OVH Load Balancer service is located in one or more availability area(s), -defined when subscribing to the service. +The OVHcloud Load Balancer is a critical component for distributing network traffic across your infrastructure. To ensure the highest level of service and optimal user experience, it is essential to deploy your Load Balancer across multiple availability zones (AZ). When subscribing to an OVHcloud Load Balancer service, **you may choose one or more availability zones** in which the service will be located. You also have the possibility to **order additional zones** for an existing service. -You have the possibility to order additional zones for your service. -This increases the availability of your Load Balancer service in case a zone is unavailable. +Configuring your OVHcloud Load Balancer in multiple availability zones will help you **increase the reliability** of your Load Balancer service in case a zone is unavailable, or **minimize latency** for your users by directing the traffic to the service nearest to them. -It is also possible, if configured appropriately, to use multiple zones to minimize latency for your visitors. +This guide details how to configure and utilize these multiple zones to achieve enhanced performance and resilience. + +> [!primary] +> +> Due to technical restrictions, when configuring an OVHcloud Load Balancer with two zones, if one is located in an APAC region and the other is not, traffic will be preferentially routed through the non-APAC zone first, even when the Load Balancer service is out of order in that zone. +> +> This behavior is specific to cross-continent setups involving APAC zones. Therefore, we do not recommend configuring your Load Balancer in this manner. +> +> You may find a list of OVHcloud regions on [our website](/links/infrareg). +> + +## Requirements + +- An [OVHcloud Load Balancer](/links/network/load-balancer) service +- Access to the [OVHcloud Control Panel](/links/manager) + +## Introduction to availability zones + +### Multi-region configuration + +Load balancing across multiple regions offers **maximum disaster recovery against widespread regional outages** and allows for worldwide entry points that significantly **reduce latency** by routing users to the **nearest server**. Most regions only have one availability zone, which means that working with several zones usually involves working with several regions. + +By leveraging an **Anycast network**, the OVHcloud Load Balancer can redirect requests coming from a specific region to the geographically nearest backend servers. + +To achieve this, you need to specify a frontend in each zone that uses a cluster in the same zone. This will allow you to declare backend servers in different clusters per zone and to control which backend servers are used in which zone. + +![Operation with several zones and several clusters](images/multi_zones_multi_backends.png){.thumbnail} +*Diagram representing a load balancer distributing traffic across two regions* + +For example, if you have backend servers in the Gravelines (GRA) and Beauharnois (BHS) regions, you can order a Load Balancer service in the `GRA` and `BHS` zones and configure: + +- A frontend in the GRA zone with a default cluster in the GRA zone which contains servers in the Gravelines datacenter. +- A frontend in the BHS zone with a default cluster in the BHS zone that contains servers in the Beauharnois datacenter. + +### Multi-AZ regions + +OVHcloud is currently rolling out its strategic plan for multi-Availability Zone (multi-AZ) regions, beginning with the launch of Paris 3-AZ in April 2024 and Milan 3-AZ in November 2025. + +Load balancing across several Availability Zones (AZs) within the same region, in contrast to a multi-region configuration, ensures **high availability**, **high performance** and **fault tolerance against local outages**, using **low-latency connections** and **Anycast** to distribute traffic in the most efficient way. + +![Difference between multi-region and multi-AZ deployments](images/multi-az.png){.thumbnail} +*Diagram representing a load balancer distributing traffic across the zones of a single multi-AZ region* ## Instructions @@ -20,14 +59,14 @@ It is also possible, if configured appropriately, to use multiple zones to minim #### From the OVHcloud Control Panel -You can order an additional zone from the [OVHcloud Control Panel](/links/manager). In the `Bare Metal Cloud`{.action} section, click `Network`{.action}, then `Load Balancer`{.action}. +You can order an additional zone from the [OVHcloud Control Panel](/links/manager). In the `Network`{.action} section, under `Network services`{.action}, click on `Load Balancer`{.action}. Select your Load Balancer, then in the `Home`{.action} tab and the `Configuration`{.action} menu, click `Add`{.action} in the "Availability zones" section. ![Add a Load Balancer zone from the manager](images/add_Zone_IPLB.png){.thumbnail} Then select the zone(s) you wish to order and click `Add`{.action}. -  + ![Selection of a Load Balancer zone from the manager](images/Select_Zone_IPLB.png){.thumbnail} A purchase order will be generated, which you'll need to pay. @@ -43,30 +82,30 @@ To order a zone via the API, you first need to create a cart. > @api {v1} /order POST /order/cart > -Please make a note of the cart number ("cart"), it will be useful for the rest. +Please make a note of the cart ID ("cart"), it will be useful later in the ordering process. -Then you assign it via +Then, assign the cart to your OVHcloud account via the following call: > [!api] > > @api {v1} /order POST /order/cart/{cartId}/assign > -You can list the options available on your Load Balancer service via +You can list the options available on your Load Balancer service via the following call: > [!api] > > @api {v1} /order GET /order/cartServiceOption/ipLoadbalancing/{serviceName} > -When you have found the option corresponding to the desired area, you can add it to your shopping cart ("cart") via +When you have found the option corresponding to the desired area, you can add it to your shopping cart ("cart") via the following call: > [!api] > > @api {v1} /order POST /order/cartServiceOption/ipLoadbalancing/{serviceName} > -Finally, you can validate your cart ("cart") via +Finally, you can validate your cart ("cart") via the following call: > [!api] > @api {v1} /order POST /order/cart/{cartId}/checkout @@ -74,13 +113,15 @@ Finally, you can validate your cart ("cart") via Don't forget to pay the order form thus generated. -### Add a zone +### Configure your frontend -Once your zone order is finalized, you can add it from your OVHcloud Control Panel. +Once your zone order is finalized, you can add it to your Load Balancer from the OVHcloud Control Panel. Select the Load Balancer you wish to modify, then create a new frontend, or edit an existing one, via the `Frontends`{.action} tab. -In the `Datacenter`{.action} field, choose the zone you wish to associate with your frontend. +In the `Datacenter`{.action} field, choose the zone you wish to associate with your frontend. + +If you want to use multiple zones, you can choose the special `ALL` zone. This special zone will allow you to deploy the same configuration on all zones subscribed to your Load Balancer service, which spares you having to duplicate the configuration for all zones. ![Zone selection](images/Select-Datacenter.png){.thumbnail} @@ -90,29 +131,6 @@ Don't forget to deploy the configuration. To do this, click `Apply configuration ![Applying a Load Balancer Configuration](images/apply-configuration.PNG){.thumbnail} -## Use multiple zones - -### For high availability - -If you want to use multiple zones to achieve high availability, you can use the special `all` zone when you declare a `frontend` and a `farm`. - -This special `all` zone will allow you to deploy the same configuration on all zones subscribed to your Load Balancer service, and avoids you to duplicate the configuration for all zones. - -### To reduce latency - -If the goal is to reduce latency, we can imagine directing requests coming from the zone1 load balancer to backend servers geographically close to zone1, and similarly, directing requests coming from the zone2 load balancer to backend servers close to zone2. - -To achieve this, you need to specify a frontend in each zone that uses a cluster in the same zone. -This will allow us to declare backend servers in different clusters per zone and to control which backend servers are used in which zone. - -![Operation with several zones and several clusters](images/multi_zones_multi_backends.png){.thumbnail} - -For example, if we have backend servers in the data centers of Gravelines (gra) and Beauharnois (bhs), -you can order a Load Balancer service in the `gra` and `bhs` areas and configure : - -- A frontend in the gra zone with as default cluster in the gra zone which contains servers in the Gravelines datacenter -- A frontend in the bhs zone with a default cluster in the bhs zone that contains servers in the Beauharnois datacenter - ## Go further Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/zones/guide.en-gb.md b/pages/network/load_balancer/zones/guide.en-gb.md index 7b7d18bfbb6..7dbf920d4f1 100644 --- a/pages/network/load_balancer/zones/guide.en-gb.md +++ b/pages/network/load_balancer/zones/guide.en-gb.md @@ -1,18 +1,57 @@ --- -title: Working with zones +title: How to configure the OVHcloud Load Balancer in multiple zones excerpt: Use zones to increase availability and decrease latency -updated: 2025-07-30 +updated: 2025-12-02 --- -## Introduction +## Objective -The OVH Load Balancer service is located in one or more availability area(s), -defined when subscribing to the service. +The OVHcloud Load Balancer is a critical component for distributing network traffic across your infrastructure. To ensure the highest level of service and optimal user experience, it is essential to deploy your Load Balancer across multiple availability zones (AZ). When subscribing to an OVHcloud Load Balancer service, **you may choose one or more availability zones** in which the service will be located. You also have the possibility to **order additional zones** for an existing service. -You have the possibility to order additional zones for your service. -This increases the availability of your Load Balancer service in case a zone is unavailable. +Configuring your OVHcloud Load Balancer in multiple availability zones will help you **increase the reliability** of your Load Balancer service in case a zone is unavailable, or **minimize latency** for your users by directing the traffic to the service nearest to them. -It is also possible, if configured appropriately, to use multiple zones to minimize latency for your visitors. +This guide details how to configure and utilize these multiple zones to achieve enhanced performance and resilience. + +> [!primary] +> +> Due to technical restrictions, when configuring an OVHcloud Load Balancer with two zones, if one is located in an APAC region and the other is not, traffic will be preferentially routed through the non-APAC zone first, even when the Load Balancer service is out of order in that zone. +> +> This behavior is specific to cross-continent setups involving APAC zones. Therefore, we do not recommend configuring your Load Balancer in this manner. +> +> You may find a list of OVHcloud regions on [our website](/links/infrareg). +> + +## Requirements + +- An [OVHcloud Load Balancer](/links/network/load-balancer) service +- Access to the [OVHcloud Control Panel](/links/manager) + +## Introduction to availability zones + +### Multi-region configuration + +Load balancing across multiple regions offers **maximum disaster recovery against widespread regional outages** and allows for worldwide entry points that significantly **reduce latency** by routing users to the **nearest server**. Most regions only have one availability zone, which means that working with several zones usually involves working with several regions. + +By leveraging an **Anycast network**, the OVHcloud Load Balancer can redirect requests coming from a specific region to the geographically nearest backend servers. + +To achieve this, you need to specify a frontend in each zone that uses a cluster in the same zone. This will allow you to declare backend servers in different clusters per zone and to control which backend servers are used in which zone. + +![Operation with several zones and several clusters](images/multi_zones_multi_backends.png){.thumbnail} +*Diagram representing a load balancer distributing traffic across two regions* + +For example, if you have backend servers in the Gravelines (GRA) and Beauharnois (BHS) regions, you can order a Load Balancer service in the `GRA` and `BHS` zones and configure: + +- A frontend in the GRA zone with a default cluster in the GRA zone which contains servers in the Gravelines datacenter. +- A frontend in the BHS zone with a default cluster in the BHS zone that contains servers in the Beauharnois datacenter. + +### Multi-AZ regions + +OVHcloud is currently rolling out its strategic plan for multi-Availability Zone (multi-AZ) regions, beginning with the launch of Paris 3-AZ in April 2024 and Milan 3-AZ in November 2025. + +Load balancing across several Availability Zones (AZs) within the same region, in contrast to a multi-region configuration, ensures **high availability**, **high performance** and **fault tolerance against local outages**, using **low-latency connections** and **Anycast** to distribute traffic in the most efficient way. + +![Difference between multi-region and multi-AZ deployments](images/multi-az.png){.thumbnail} +*Diagram representing a load balancer distributing traffic across the zones of a single multi-AZ region* ## Instructions @@ -20,14 +59,14 @@ It is also possible, if configured appropriately, to use multiple zones to minim #### From the OVHcloud Control Panel -You can order an additional zone from the [OVHcloud Control Panel](/links/manager). In the `Bare Metal Cloud`{.action} section, click `Network`{.action}, then `Load Balancer`{.action}. +You can order an additional zone from the [OVHcloud Control Panel](/links/manager). In the `Network`{.action} section, under `Network services`{.action}, click on `Load Balancer`{.action}. Select your Load Balancer, then in the `Home`{.action} tab and the `Configuration`{.action} menu, click `Add`{.action} in the "Availability zones" section. ![Add a Load Balancer zone from the manager](images/add_Zone_IPLB.png){.thumbnail} Then select the zone(s) you wish to order and click `Add`{.action}. -  + ![Selection of a Load Balancer zone from the manager](images/Select_Zone_IPLB.png){.thumbnail} A purchase order will be generated, which you'll need to pay. @@ -43,30 +82,30 @@ To order a zone via the API, you first need to create a cart. > @api {v1} /order POST /order/cart > -Please make a note of the cart number ("cart"), it will be useful for the rest. +Please make a note of the cart ID ("cart"), it will be useful later in the ordering process. -Then you assign it via +Then, assign the cart to your OVHcloud account via the following call: > [!api] > > @api {v1} /order POST /order/cart/{cartId}/assign > -You can list the options available on your Load Balancer service via +You can list the options available on your Load Balancer service via the following call: > [!api] > > @api {v1} /order GET /order/cartServiceOption/ipLoadbalancing/{serviceName} > -When you have found the option corresponding to the desired area, you can add it to your shopping cart ("cart") via +When you have found the option corresponding to the desired area, you can add it to your shopping cart ("cart") via the following call: > [!api] > > @api {v1} /order POST /order/cartServiceOption/ipLoadbalancing/{serviceName} > -Finally, you can validate your cart ("cart") via +Finally, you can validate your cart ("cart") via the following call: > [!api] > @api {v1} /order POST /order/cart/{cartId}/checkout @@ -74,13 +113,15 @@ Finally, you can validate your cart ("cart") via Don't forget to pay the order form thus generated. -### Add a zone +### Configure your frontend -Once your zone order is finalized, you can add it from your OVHcloud Control Panel. +Once your zone order is finalized, you can add it to your Load Balancer from the OVHcloud Control Panel. Select the Load Balancer you wish to modify, then create a new frontend, or edit an existing one, via the `Frontends`{.action} tab. -In the `Datacenter`{.action} field, choose the zone you wish to associate with your frontend. +In the `Datacenter`{.action} field, choose the zone you wish to associate with your frontend. + +If you want to use multiple zones, you can choose the special `ALL` zone. This special zone will allow you to deploy the same configuration on all zones subscribed to your Load Balancer service, which spares you having to duplicate the configuration for all zones. ![Zone selection](images/Select-Datacenter.png){.thumbnail} @@ -90,29 +131,6 @@ Don't forget to deploy the configuration. To do this, click `Apply configuration ![Applying a Load Balancer Configuration](images/apply-configuration.PNG){.thumbnail} -## Use multiple zones - -### For high availability - -If you want to use multiple zones to achieve high availability, you can use the special `all` zone when you declare a `frontend` and a `farm`. - -This special `all` zone will allow you to deploy the same configuration on all zones subscribed to your Load Balancer service, and avoids you to duplicate the configuration for all zones. - -### To reduce latency - -If the goal is to reduce latency, we can imagine directing requests coming from the zone1 load balancer to backend servers geographically close to zone1, and similarly, directing requests coming from the zone2 load balancer to backend servers close to zone2. - -To achieve this, you need to specify a frontend in each zone that uses a cluster in the same zone. -This will allow us to declare backend servers in different clusters per zone and to control which backend servers are used in which zone. - -![Operation with several zones and several clusters](images/multi_zones_multi_backends.png){.thumbnail} - -For example, if we have backend servers in the data centers of Gravelines (gra) and Beauharnois (bhs), -you can order a Load Balancer service in the `gra` and `bhs` areas and configure : - -- A frontend in the gra zone with as default cluster in the gra zone which contains servers in the Gravelines datacenter -- A frontend in the bhs zone with a default cluster in the bhs zone that contains servers in the Beauharnois datacenter - ## Go further Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/zones/guide.en-sg.md b/pages/network/load_balancer/zones/guide.en-sg.md index 7b7d18bfbb6..7dbf920d4f1 100644 --- a/pages/network/load_balancer/zones/guide.en-sg.md +++ b/pages/network/load_balancer/zones/guide.en-sg.md @@ -1,18 +1,57 @@ --- -title: Working with zones +title: How to configure the OVHcloud Load Balancer in multiple zones excerpt: Use zones to increase availability and decrease latency -updated: 2025-07-30 +updated: 2025-12-02 --- -## Introduction +## Objective -The OVH Load Balancer service is located in one or more availability area(s), -defined when subscribing to the service. +The OVHcloud Load Balancer is a critical component for distributing network traffic across your infrastructure. To ensure the highest level of service and optimal user experience, it is essential to deploy your Load Balancer across multiple availability zones (AZ). When subscribing to an OVHcloud Load Balancer service, **you may choose one or more availability zones** in which the service will be located. You also have the possibility to **order additional zones** for an existing service. -You have the possibility to order additional zones for your service. -This increases the availability of your Load Balancer service in case a zone is unavailable. +Configuring your OVHcloud Load Balancer in multiple availability zones will help you **increase the reliability** of your Load Balancer service in case a zone is unavailable, or **minimize latency** for your users by directing the traffic to the service nearest to them. -It is also possible, if configured appropriately, to use multiple zones to minimize latency for your visitors. +This guide details how to configure and utilize these multiple zones to achieve enhanced performance and resilience. + +> [!primary] +> +> Due to technical restrictions, when configuring an OVHcloud Load Balancer with two zones, if one is located in an APAC region and the other is not, traffic will be preferentially routed through the non-APAC zone first, even when the Load Balancer service is out of order in that zone. +> +> This behavior is specific to cross-continent setups involving APAC zones. Therefore, we do not recommend configuring your Load Balancer in this manner. +> +> You may find a list of OVHcloud regions on [our website](/links/infrareg). +> + +## Requirements + +- An [OVHcloud Load Balancer](/links/network/load-balancer) service +- Access to the [OVHcloud Control Panel](/links/manager) + +## Introduction to availability zones + +### Multi-region configuration + +Load balancing across multiple regions offers **maximum disaster recovery against widespread regional outages** and allows for worldwide entry points that significantly **reduce latency** by routing users to the **nearest server**. Most regions only have one availability zone, which means that working with several zones usually involves working with several regions. + +By leveraging an **Anycast network**, the OVHcloud Load Balancer can redirect requests coming from a specific region to the geographically nearest backend servers. + +To achieve this, you need to specify a frontend in each zone that uses a cluster in the same zone. This will allow you to declare backend servers in different clusters per zone and to control which backend servers are used in which zone. + +![Operation with several zones and several clusters](images/multi_zones_multi_backends.png){.thumbnail} +*Diagram representing a load balancer distributing traffic across two regions* + +For example, if you have backend servers in the Gravelines (GRA) and Beauharnois (BHS) regions, you can order a Load Balancer service in the `GRA` and `BHS` zones and configure: + +- A frontend in the GRA zone with a default cluster in the GRA zone which contains servers in the Gravelines datacenter. +- A frontend in the BHS zone with a default cluster in the BHS zone that contains servers in the Beauharnois datacenter. + +### Multi-AZ regions + +OVHcloud is currently rolling out its strategic plan for multi-Availability Zone (multi-AZ) regions, beginning with the launch of Paris 3-AZ in April 2024 and Milan 3-AZ in November 2025. + +Load balancing across several Availability Zones (AZs) within the same region, in contrast to a multi-region configuration, ensures **high availability**, **high performance** and **fault tolerance against local outages**, using **low-latency connections** and **Anycast** to distribute traffic in the most efficient way. + +![Difference between multi-region and multi-AZ deployments](images/multi-az.png){.thumbnail} +*Diagram representing a load balancer distributing traffic across the zones of a single multi-AZ region* ## Instructions @@ -20,14 +59,14 @@ It is also possible, if configured appropriately, to use multiple zones to minim #### From the OVHcloud Control Panel -You can order an additional zone from the [OVHcloud Control Panel](/links/manager). In the `Bare Metal Cloud`{.action} section, click `Network`{.action}, then `Load Balancer`{.action}. +You can order an additional zone from the [OVHcloud Control Panel](/links/manager). In the `Network`{.action} section, under `Network services`{.action}, click on `Load Balancer`{.action}. Select your Load Balancer, then in the `Home`{.action} tab and the `Configuration`{.action} menu, click `Add`{.action} in the "Availability zones" section. ![Add a Load Balancer zone from the manager](images/add_Zone_IPLB.png){.thumbnail} Then select the zone(s) you wish to order and click `Add`{.action}. -  + ![Selection of a Load Balancer zone from the manager](images/Select_Zone_IPLB.png){.thumbnail} A purchase order will be generated, which you'll need to pay. @@ -43,30 +82,30 @@ To order a zone via the API, you first need to create a cart. > @api {v1} /order POST /order/cart > -Please make a note of the cart number ("cart"), it will be useful for the rest. +Please make a note of the cart ID ("cart"), it will be useful later in the ordering process. -Then you assign it via +Then, assign the cart to your OVHcloud account via the following call: > [!api] > > @api {v1} /order POST /order/cart/{cartId}/assign > -You can list the options available on your Load Balancer service via +You can list the options available on your Load Balancer service via the following call: > [!api] > > @api {v1} /order GET /order/cartServiceOption/ipLoadbalancing/{serviceName} > -When you have found the option corresponding to the desired area, you can add it to your shopping cart ("cart") via +When you have found the option corresponding to the desired area, you can add it to your shopping cart ("cart") via the following call: > [!api] > > @api {v1} /order POST /order/cartServiceOption/ipLoadbalancing/{serviceName} > -Finally, you can validate your cart ("cart") via +Finally, you can validate your cart ("cart") via the following call: > [!api] > @api {v1} /order POST /order/cart/{cartId}/checkout @@ -74,13 +113,15 @@ Finally, you can validate your cart ("cart") via Don't forget to pay the order form thus generated. -### Add a zone +### Configure your frontend -Once your zone order is finalized, you can add it from your OVHcloud Control Panel. +Once your zone order is finalized, you can add it to your Load Balancer from the OVHcloud Control Panel. Select the Load Balancer you wish to modify, then create a new frontend, or edit an existing one, via the `Frontends`{.action} tab. -In the `Datacenter`{.action} field, choose the zone you wish to associate with your frontend. +In the `Datacenter`{.action} field, choose the zone you wish to associate with your frontend. + +If you want to use multiple zones, you can choose the special `ALL` zone. This special zone will allow you to deploy the same configuration on all zones subscribed to your Load Balancer service, which spares you having to duplicate the configuration for all zones. ![Zone selection](images/Select-Datacenter.png){.thumbnail} @@ -90,29 +131,6 @@ Don't forget to deploy the configuration. To do this, click `Apply configuration ![Applying a Load Balancer Configuration](images/apply-configuration.PNG){.thumbnail} -## Use multiple zones - -### For high availability - -If you want to use multiple zones to achieve high availability, you can use the special `all` zone when you declare a `frontend` and a `farm`. - -This special `all` zone will allow you to deploy the same configuration on all zones subscribed to your Load Balancer service, and avoids you to duplicate the configuration for all zones. - -### To reduce latency - -If the goal is to reduce latency, we can imagine directing requests coming from the zone1 load balancer to backend servers geographically close to zone1, and similarly, directing requests coming from the zone2 load balancer to backend servers close to zone2. - -To achieve this, you need to specify a frontend in each zone that uses a cluster in the same zone. -This will allow us to declare backend servers in different clusters per zone and to control which backend servers are used in which zone. - -![Operation with several zones and several clusters](images/multi_zones_multi_backends.png){.thumbnail} - -For example, if we have backend servers in the data centers of Gravelines (gra) and Beauharnois (bhs), -you can order a Load Balancer service in the `gra` and `bhs` areas and configure : - -- A frontend in the gra zone with as default cluster in the gra zone which contains servers in the Gravelines datacenter -- A frontend in the bhs zone with a default cluster in the bhs zone that contains servers in the Beauharnois datacenter - ## Go further Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/zones/guide.en-us.md b/pages/network/load_balancer/zones/guide.en-us.md index 7b7d18bfbb6..7dbf920d4f1 100644 --- a/pages/network/load_balancer/zones/guide.en-us.md +++ b/pages/network/load_balancer/zones/guide.en-us.md @@ -1,18 +1,57 @@ --- -title: Working with zones +title: How to configure the OVHcloud Load Balancer in multiple zones excerpt: Use zones to increase availability and decrease latency -updated: 2025-07-30 +updated: 2025-12-02 --- -## Introduction +## Objective -The OVH Load Balancer service is located in one or more availability area(s), -defined when subscribing to the service. +The OVHcloud Load Balancer is a critical component for distributing network traffic across your infrastructure. To ensure the highest level of service and optimal user experience, it is essential to deploy your Load Balancer across multiple availability zones (AZ). When subscribing to an OVHcloud Load Balancer service, **you may choose one or more availability zones** in which the service will be located. You also have the possibility to **order additional zones** for an existing service. -You have the possibility to order additional zones for your service. -This increases the availability of your Load Balancer service in case a zone is unavailable. +Configuring your OVHcloud Load Balancer in multiple availability zones will help you **increase the reliability** of your Load Balancer service in case a zone is unavailable, or **minimize latency** for your users by directing the traffic to the service nearest to them. -It is also possible, if configured appropriately, to use multiple zones to minimize latency for your visitors. +This guide details how to configure and utilize these multiple zones to achieve enhanced performance and resilience. + +> [!primary] +> +> Due to technical restrictions, when configuring an OVHcloud Load Balancer with two zones, if one is located in an APAC region and the other is not, traffic will be preferentially routed through the non-APAC zone first, even when the Load Balancer service is out of order in that zone. +> +> This behavior is specific to cross-continent setups involving APAC zones. Therefore, we do not recommend configuring your Load Balancer in this manner. +> +> You may find a list of OVHcloud regions on [our website](/links/infrareg). +> + +## Requirements + +- An [OVHcloud Load Balancer](/links/network/load-balancer) service +- Access to the [OVHcloud Control Panel](/links/manager) + +## Introduction to availability zones + +### Multi-region configuration + +Load balancing across multiple regions offers **maximum disaster recovery against widespread regional outages** and allows for worldwide entry points that significantly **reduce latency** by routing users to the **nearest server**. Most regions only have one availability zone, which means that working with several zones usually involves working with several regions. + +By leveraging an **Anycast network**, the OVHcloud Load Balancer can redirect requests coming from a specific region to the geographically nearest backend servers. + +To achieve this, you need to specify a frontend in each zone that uses a cluster in the same zone. This will allow you to declare backend servers in different clusters per zone and to control which backend servers are used in which zone. + +![Operation with several zones and several clusters](images/multi_zones_multi_backends.png){.thumbnail} +*Diagram representing a load balancer distributing traffic across two regions* + +For example, if you have backend servers in the Gravelines (GRA) and Beauharnois (BHS) regions, you can order a Load Balancer service in the `GRA` and `BHS` zones and configure: + +- A frontend in the GRA zone with a default cluster in the GRA zone which contains servers in the Gravelines datacenter. +- A frontend in the BHS zone with a default cluster in the BHS zone that contains servers in the Beauharnois datacenter. + +### Multi-AZ regions + +OVHcloud is currently rolling out its strategic plan for multi-Availability Zone (multi-AZ) regions, beginning with the launch of Paris 3-AZ in April 2024 and Milan 3-AZ in November 2025. + +Load balancing across several Availability Zones (AZs) within the same region, in contrast to a multi-region configuration, ensures **high availability**, **high performance** and **fault tolerance against local outages**, using **low-latency connections** and **Anycast** to distribute traffic in the most efficient way. + +![Difference between multi-region and multi-AZ deployments](images/multi-az.png){.thumbnail} +*Diagram representing a load balancer distributing traffic across the zones of a single multi-AZ region* ## Instructions @@ -20,14 +59,14 @@ It is also possible, if configured appropriately, to use multiple zones to minim #### From the OVHcloud Control Panel -You can order an additional zone from the [OVHcloud Control Panel](/links/manager). In the `Bare Metal Cloud`{.action} section, click `Network`{.action}, then `Load Balancer`{.action}. +You can order an additional zone from the [OVHcloud Control Panel](/links/manager). In the `Network`{.action} section, under `Network services`{.action}, click on `Load Balancer`{.action}. Select your Load Balancer, then in the `Home`{.action} tab and the `Configuration`{.action} menu, click `Add`{.action} in the "Availability zones" section. ![Add a Load Balancer zone from the manager](images/add_Zone_IPLB.png){.thumbnail} Then select the zone(s) you wish to order and click `Add`{.action}. -  + ![Selection of a Load Balancer zone from the manager](images/Select_Zone_IPLB.png){.thumbnail} A purchase order will be generated, which you'll need to pay. @@ -43,30 +82,30 @@ To order a zone via the API, you first need to create a cart. > @api {v1} /order POST /order/cart > -Please make a note of the cart number ("cart"), it will be useful for the rest. +Please make a note of the cart ID ("cart"), it will be useful later in the ordering process. -Then you assign it via +Then, assign the cart to your OVHcloud account via the following call: > [!api] > > @api {v1} /order POST /order/cart/{cartId}/assign > -You can list the options available on your Load Balancer service via +You can list the options available on your Load Balancer service via the following call: > [!api] > > @api {v1} /order GET /order/cartServiceOption/ipLoadbalancing/{serviceName} > -When you have found the option corresponding to the desired area, you can add it to your shopping cart ("cart") via +When you have found the option corresponding to the desired area, you can add it to your shopping cart ("cart") via the following call: > [!api] > > @api {v1} /order POST /order/cartServiceOption/ipLoadbalancing/{serviceName} > -Finally, you can validate your cart ("cart") via +Finally, you can validate your cart ("cart") via the following call: > [!api] > @api {v1} /order POST /order/cart/{cartId}/checkout @@ -74,13 +113,15 @@ Finally, you can validate your cart ("cart") via Don't forget to pay the order form thus generated. -### Add a zone +### Configure your frontend -Once your zone order is finalized, you can add it from your OVHcloud Control Panel. +Once your zone order is finalized, you can add it to your Load Balancer from the OVHcloud Control Panel. Select the Load Balancer you wish to modify, then create a new frontend, or edit an existing one, via the `Frontends`{.action} tab. -In the `Datacenter`{.action} field, choose the zone you wish to associate with your frontend. +In the `Datacenter`{.action} field, choose the zone you wish to associate with your frontend. + +If you want to use multiple zones, you can choose the special `ALL` zone. This special zone will allow you to deploy the same configuration on all zones subscribed to your Load Balancer service, which spares you having to duplicate the configuration for all zones. ![Zone selection](images/Select-Datacenter.png){.thumbnail} @@ -90,29 +131,6 @@ Don't forget to deploy the configuration. To do this, click `Apply configuration ![Applying a Load Balancer Configuration](images/apply-configuration.PNG){.thumbnail} -## Use multiple zones - -### For high availability - -If you want to use multiple zones to achieve high availability, you can use the special `all` zone when you declare a `frontend` and a `farm`. - -This special `all` zone will allow you to deploy the same configuration on all zones subscribed to your Load Balancer service, and avoids you to duplicate the configuration for all zones. - -### To reduce latency - -If the goal is to reduce latency, we can imagine directing requests coming from the zone1 load balancer to backend servers geographically close to zone1, and similarly, directing requests coming from the zone2 load balancer to backend servers close to zone2. - -To achieve this, you need to specify a frontend in each zone that uses a cluster in the same zone. -This will allow us to declare backend servers in different clusters per zone and to control which backend servers are used in which zone. - -![Operation with several zones and several clusters](images/multi_zones_multi_backends.png){.thumbnail} - -For example, if we have backend servers in the data centers of Gravelines (gra) and Beauharnois (bhs), -you can order a Load Balancer service in the `gra` and `bhs` areas and configure : - -- A frontend in the gra zone with as default cluster in the gra zone which contains servers in the Gravelines datacenter -- A frontend in the bhs zone with a default cluster in the bhs zone that contains servers in the Beauharnois datacenter - ## Go further Join our [community of users](/links/community). \ No newline at end of file diff --git a/pages/network/load_balancer/zones/guide.fr-ca.md b/pages/network/load_balancer/zones/guide.fr-ca.md index 8253e4f8d6f..1530d40e370 100644 --- a/pages/network/load_balancer/zones/guide.fr-ca.md +++ b/pages/network/load_balancer/zones/guide.fr-ca.md @@ -1,79 +1,111 @@ --- -title: "Configurer un service OVHcloud Load Balancer avec les zones" -excerpt: "Utilisez les zones afin d'augmenter la disponibilité et diminuer la latence" -updated: 2025-07-30 +title: Configurer le Load Balancer OVHcloud en plusieurs zones +excerpt: Utilisez les zones pour augmenter la disponibilité et réduire la latence +updated: 2025-12-02 --- ## Objectif -Le service OVHcloud Load Balancer est localisé dans une ou plusieurs zone(s) de disponibilité, définie(s) lors de la souscription au service. +Le Load Balancer OVHcloud est un composant essentiel pour répartir le trafic réseau sur votre infrastructure. Pour garantir le meilleur niveau de service et une expérience utilisateur optimale, il est essentiel de déployer votre Load Balancer sur plusieurs zones de disponibilité (AZ). Lors de l'abonnement à un service Load Balancer OVHcloud, **vous pouvez choisir une ou plusieurs zones de disponibilité** dans lesquelles le service sera situé. Vous avez également la possibilité **d'ajouter des zones supplémentaires** à un service existant. -Vous pouvez commander des zones supplémentaires pour votre service. -Vous augmentez ainsi la disponibilité de votre service Load Balancer en cas d'indisponibilité d'une zone. +La configuration de votre service Load Balancer OVHcloud sur plusieurs zones de disponibilité vous aidera à **accroître la fiabilité** de votre service Load Balancer en cas de panne d'une zone, ou à **réduire la latence** pour vos utilisateurs en dirigeant le trafic vers le service le plus proche d'eux. -Via une configuration adéquate, vous pouvez également utiliser plusieurs zones afin de minimiser la latence pour vos visiteurs. +Ce guide explique comment configurer et utiliser ces zones multiples afin d'obtenir des performances et une résilience améliorées. -**Découvrez comment commander et gérer des zones supplémentaires.** +> [!primary] +> +> En raison de restrictions techniques, lors de la configuration d'un Load Balancer OVHcloud avec deux zones, si l'une se trouve dans une région APAC et l'autre non, le trafic sera préférentiellement dirigé via la zone non APAC, même lorsque le Load Balancer est hors service dans cette zone. +> +> Ce comportement est spécifique aux configurations transcontinentales impliquant des zones APAC. Par conséquent, nous ne recommandons pas de configurer votre Load Balancer de cette manière. +> +> Vous pouvez trouver une liste des régions OVHcloud sur [notre site web](/links/infrareg). +> ## Prérequis -- Posséder une offre [OVHcloud Load balancer](/links/network/load-balancer) dans votre compte OVHcloud. -- Être connecté à votre [espace client OVHcloud](/links/manager). -- Être connecté à l'[API OVHcloud](/links/api). +- Un service [Load Balancer OVHcloud](/links/network/load-balancer) +- Accès à l'[espace client OVHcloud](/links/manager) + +## Introduction aux zones de disponibilité + +### Configuration multi-régions + +La répartition de charge entre plusieurs régions offre **une meilleure reprise après sinistre en cas de pannes à un niveau régional**, et permet des points d'entrée mondiaux qui **réduisent considérablement la latence** en dirigeant les utilisateurs vers le **serveur le plus proche**. La plupart des régions n'ont qu'une seule zone de disponibilité, ce qui signifie que travailler avec plusieurs zones implique généralement de travailler avec plusieurs régions. + +Grâce à un **réseau Anycast**, le Load Balancer OVHcloud peut rediriger les requêtes provenant d'une région spécifique vers des serveurs backend géographiquement proches. + +Pour cela, vous devez spécifier un frontend dans chaque zone utilisant une ferme dans la même zone. Cela vous permettra de déclarer des serveurs backend dans différentes fermes par zone et de contrôler lesquels sont utilisés dans chaque zone. + +![Fonctionnement avec plusieurs zones et plusieurs fermes](images/multi_zones_multi_backends.png){.thumbnail} +*Diagramme représentant un Load Balancer répartissant le trafic sur deux régions* + +Par exemple, si vous avez des serveurs backend dans les régions Gravelines (GRA) et Beauharnois (BHS), vous pouvez commander un service Load Balancer dans les zones `GRA` et `BHS` et configurer : + +- Un frontend dans la zone GRA avec une ferme par défaut dans la zone GRA contenant des serveurs dans le datacenter de Gravelines. +- Un frontend dans la zone BHS avec une ferme par défaut dans la zone BHS contenant des serveurs dans le datacenter de Beauharnois. + +### Régions multi-AZ + +OVHcloud déploie actuellement son plan stratégique pour les régions multi-zones de disponibilité (multi-AZ), débutant par le lancement de Paris 3-AZ en avril 2024 et Milan 3-AZ en novembre 2025. + +La répartition de charge entre plusieurs zones de disponibilité (AZ) au sein de la même région, à la différence d'une configuration multi-régions, garantit une **haute disponibilité**, une **haute performance** et une **résilience face aux pannes locales**, en utilisant des **connexions à faible latence** et **Anycast** pour distribuer le trafic de la manière la plus efficace. + +![Différence entre les déploiements multi-régions et multi-AZ](images/multi-az.png){.thumbnail} +*Diagramme représentant un load balancer répartissant le trafic sur les zones d'une seule région multi-AZ* ## En pratique -### Commander une zone supplémentaire +### Ajouter une zone #### Depuis l'espace client OVHcloud -Vous pouvez commander une zone supplémentaire depuis l'[espace client OVHcloud](/links/manager). Dans la partie `Bare Metal Cloud`{.action}, cliquez sur `Network`{.action} puis sur `Load Balancer`{.action}. +Vous pouvez commander une zone supplémentaire depuis l'[espace client OVHcloud](/links/manager). Dans la section `Network`{.action}, sous `Services réseau`{.action} cliquez sur `Load Balancer`{.action}. -Sélectionnez votre Load Balancer puis, dans l'onglet `Accueil`{.action} et le menu `Configuration`{.action}, cliquez sur `Ajouter`{.action} dans la partie « Zones de disponibilité ». +Sélectionnez votre Load Balancer, puis dans l'onglet `Accueil`{.action}, section `Configuration`{.action}, cliquez sur le bouton `...`{.action} sur la droite de "Zones de disponibilité" et choisissez `Ajouter`{.action}. -![Ajouter une zone load balancer depuis le manager](images/add_Zone_IPLB.png){.thumbnail} +![Ajout d'une zone Load Balancer depuis le manager](images/add_Zone_IPLB.png){.thumbnail} -Sélectionnez alors le(s) zone(s) que vous souhaitez commander et cliquez sur `Ajouter`{.action}. - -![Selection d'une zone load balancer depuis le manager](images/Select_Zone_IPLB.png){.thumbnail} +Ensuite, sélectionnez la (ou les) zone(s) que vous souhaitez commander et cliquez sur `Ajouter`{.action}. -Un bon de commande est généré, il vous faudra le régler. +![Sélection d'une zone Load Balancer depuis le manager](images/Select_Zone_IPLB.png){.thumbnail} -![Payer la commande zone load balancer depuis le manager](images/Paybill_Zone_IPLB.png){.thumbnail} +Une commande sera générée, que vous devrez régler. + +![Paiement de la commande de zone Load Balancer depuis le manager](images/Paybill_Zone_IPLB.png){.thumbnail} #### Depuis l'API OVHcloud -Pour commander une zone via l'API, vous devez tout d'abord créer un panier (*cart*) +Pour commander une zone via l'API, vous devez d'abord créer un panier ("cart"). > [!api] > > @api {v1} /order POST /order/cart > -Veuillez noter le numéro du panier (*cart*), il vous sera utile pour la suite. +Veuillez noter l'ID du panier ("cart"), il sera utile plus tard dans le processus de commande. -Assignez-vous le panier via l'appel suivant : +Ensuite, attribuez le panier à votre compte OVHcloud via l'appel suivant : > [!api] > > @api {v1} /order POST /order/cart/{cartId}/assign > -Vous pouvez lister les options disponibles sur votre service Load Balancer via : +Vous pouvez lister les options disponibles sur votre service Load Balancer via l'appel suivant : > [!api] > > @api {v1} /order GET /order/cartServiceOption/ipLoadbalancing/{serviceName} > -Quand vous avez trouvé l'option correspondant à la zone souhaitée, vous pouvez l'ajouter à votre panier (*cart*) via : +Lorsque vous avez trouvé l'option correspondant à la zone souhaitée, vous pouvez l'ajouter à votre panier ("cart") via l'appel suivant : > [!api] > > @api {v1} /order POST /order/cartServiceOption/ipLoadbalancing/{serviceName} > -Enfin, vous pouvez valider votre panier (*cart*) via : +Enfin, vous pouvez valider votre panier ("cart") via l'appel suivant : > [!api] > @api {v1} /order POST /order/cart/{cartId}/checkout @@ -81,47 +113,23 @@ Enfin, vous pouvez valider votre panier (*cart*) via : N'oubliez pas de régler le bon de commande ainsi généré. -### Ajouter une zone - -Une fois que la commande de votre zone est finalisée, vous pouvez l'ajouter depuis votre espace client OVHcloud. - -Sélectionnez le Load Balancer que vous souhaitez modifier puis créez un nouveau frontend, ou éditez-en un existant, via l'onglet `Frontends`{.action} - -Dans le champ `Datacenter`{.action}, choisissez la zone que vous souhaitez associer à votre frontend. - -![Choix de la zone](images/Select-Datacenter.png){.thumbnail} +### Configurer votre frontend -Une fois le frontend configuré, cliquez sur `Ajouter`{.action} ou `Modifier`{.action} selon que vous configurez un nouveau frontend ou un frontend existant. +Une fois votre commande de zone finalisée, vous pouvez l'ajouter à votre Load Balancer depuis l'espace client OVHcloud. -N'oubliez pas de déployer la configuration. Pour ce faire, dans le bandeau de rappel vous précisant que la configuration n'est pas appliquée, cliquez sur `Appliquer la configuration`{.action}. +Sélectionnez le Load Balancer que vous souhaitez modifier, puis créez un nouveau frontend, ou modifiez-en un existant, via l'onglet `Frontends`{.action}. -![Application d'une Configuration d'un Load Balancer](images/apply-configuration.PNG){.thumbnail} +Dans le champ `Datacenter`{.action}, choisissez la zone que vous souhaitez associer à votre frontend. -### Utiliser plusieurs zones +Si vous souhaitez utiliser plusieurs zones, vous pouvez choisir la zone spéciale `ALL`. Cette zone spéciale vous permettra de déployer la même configuration sur toutes les zones souscrites à votre service Load Balancer, ce qui vous épargne de dupliquer la configuration pour toutes les zones. -#### Pour la haute disponibilité +![Sélection de la zone](images/Select-Datacenter.png){.thumbnail} -Si vous voulez utiliser plusieurs zones afin d'obtenir une haute disponibilité, vous pouvez utiliser la valeur `Tous (ALL)` lorsque vous déclarez un frontend ou une ferme de serveurs. - -![utiliser plusieurs zones](images/Edit-frontend-All-iplb.png){.thumbnail} - -Cette valeur spéciale `Tous (ALL)` va permettre de déployer la même configuration sur toutes les zones souscrites sur votre service Load Balancer, et vous évite de dupliquer la configuration pour toutes les zones. - -#### Pour réduire la latence - -Si le but est de réduire la latence, vous pouvez diriger les requêtes venant depuis le load balancer de la zone1 vers des serveurs backends proches géographiquement de cette zone1.
-De façon similaire, vous pouvez diriger les requêtes venant depuis le load balancer de la zone2 vers des serveurs backends proches de la zone2. - -Afin de réaliser cela, il vous faut spécifier un frontend dans chaque zone qui utilise une ferme dans la même zone.
-Cela va vous permettre de déclarer les serveurs backends dans des fermes différentes par zone et de contrôler les serveurs backends utilisés en fonction de la zone. - -![Fonctionnement avec plusieurs zones et plusieurs fermes](images/multi_zones_multi_backends.png){.thumbnail} +Une fois le frontend configuré, cliquez sur `Ajouter`{.action} ou `Modifier`{.action}, selon que vous configurez un nouveau frontend ou modifiez un existant. -Par exemple, si vous avez des serveurs backends dans les datacentres de Gravelines (gra) et Beauharnois (bhs), -vous pouvez commander un service Load Balancer dans les zones `gra` et `bhs` et configurer : +N'oubliez pas de déployer la configuration. Pour cela, cliquez sur `Appliquer la configuration`{.action} dans la bannière rappelant que la configuration n'est pas appliquée. -- un frontend dans la zone gra avec une ferme (farm) par défaut dans la zone gra qui contient des serveurs dans le datacentre de Gravelines; -- un frontend dans la zone bhs avec une ferme (farm) par défaut dans la zone bhs qui contient des serveurs dans le datacentre de Beauharnois. +![Application d'une configuration Load Balancer](images/apply-configuration.PNG){.thumbnail} ## Aller plus loin diff --git a/pages/network/load_balancer/zones/guide.fr-fr.md b/pages/network/load_balancer/zones/guide.fr-fr.md index d4db7cf2999..1530d40e370 100644 --- a/pages/network/load_balancer/zones/guide.fr-fr.md +++ b/pages/network/load_balancer/zones/guide.fr-fr.md @@ -1,79 +1,111 @@ --- -title: "Configurer un service OVHcloud Load Balancer avec les zones" -excerpt: "Utilisez les zones afin d'augmenter la disponibilité et diminuer la latence" -updated: 2022-04-04 +title: Configurer le Load Balancer OVHcloud en plusieurs zones +excerpt: Utilisez les zones pour augmenter la disponibilité et réduire la latence +updated: 2025-12-02 --- ## Objectif -Le service OVHcloud Load Balancer est localisé dans une ou plusieurs zone(s) de disponibilité, définie(s) lors de la souscription au service. +Le Load Balancer OVHcloud est un composant essentiel pour répartir le trafic réseau sur votre infrastructure. Pour garantir le meilleur niveau de service et une expérience utilisateur optimale, il est essentiel de déployer votre Load Balancer sur plusieurs zones de disponibilité (AZ). Lors de l'abonnement à un service Load Balancer OVHcloud, **vous pouvez choisir une ou plusieurs zones de disponibilité** dans lesquelles le service sera situé. Vous avez également la possibilité **d'ajouter des zones supplémentaires** à un service existant. -Vous pouvez commander des zones supplémentaires pour votre service. -Vous augmentez ainsi la disponibilité de votre service Load Balancer en cas d'indisponibilité d'une zone. +La configuration de votre service Load Balancer OVHcloud sur plusieurs zones de disponibilité vous aidera à **accroître la fiabilité** de votre service Load Balancer en cas de panne d'une zone, ou à **réduire la latence** pour vos utilisateurs en dirigeant le trafic vers le service le plus proche d'eux. -Via une configuration adéquate, vous pouvez également utiliser plusieurs zones afin de minimiser la latence pour vos visiteurs. +Ce guide explique comment configurer et utiliser ces zones multiples afin d'obtenir des performances et une résilience améliorées. -**Découvrez comment commander et gérer des zones supplémentaires.** +> [!primary] +> +> En raison de restrictions techniques, lors de la configuration d'un Load Balancer OVHcloud avec deux zones, si l'une se trouve dans une région APAC et l'autre non, le trafic sera préférentiellement dirigé via la zone non APAC, même lorsque le Load Balancer est hors service dans cette zone. +> +> Ce comportement est spécifique aux configurations transcontinentales impliquant des zones APAC. Par conséquent, nous ne recommandons pas de configurer votre Load Balancer de cette manière. +> +> Vous pouvez trouver une liste des régions OVHcloud sur [notre site web](/links/infrareg). +> ## Prérequis -- Posséder une offre [OVHcloud Load balancer](/links/network/load-balancer) dans votre compte OVHcloud. -- Être connecté à votre [espace client OVHcloud](/links/manager). -- Être connecté à l'[API OVHcloud](/links/api). +- Un service [Load Balancer OVHcloud](/links/network/load-balancer) +- Accès à l'[espace client OVHcloud](/links/manager) + +## Introduction aux zones de disponibilité + +### Configuration multi-régions + +La répartition de charge entre plusieurs régions offre **une meilleure reprise après sinistre en cas de pannes à un niveau régional**, et permet des points d'entrée mondiaux qui **réduisent considérablement la latence** en dirigeant les utilisateurs vers le **serveur le plus proche**. La plupart des régions n'ont qu'une seule zone de disponibilité, ce qui signifie que travailler avec plusieurs zones implique généralement de travailler avec plusieurs régions. + +Grâce à un **réseau Anycast**, le Load Balancer OVHcloud peut rediriger les requêtes provenant d'une région spécifique vers des serveurs backend géographiquement proches. + +Pour cela, vous devez spécifier un frontend dans chaque zone utilisant une ferme dans la même zone. Cela vous permettra de déclarer des serveurs backend dans différentes fermes par zone et de contrôler lesquels sont utilisés dans chaque zone. + +![Fonctionnement avec plusieurs zones et plusieurs fermes](images/multi_zones_multi_backends.png){.thumbnail} +*Diagramme représentant un Load Balancer répartissant le trafic sur deux régions* + +Par exemple, si vous avez des serveurs backend dans les régions Gravelines (GRA) et Beauharnois (BHS), vous pouvez commander un service Load Balancer dans les zones `GRA` et `BHS` et configurer : + +- Un frontend dans la zone GRA avec une ferme par défaut dans la zone GRA contenant des serveurs dans le datacenter de Gravelines. +- Un frontend dans la zone BHS avec une ferme par défaut dans la zone BHS contenant des serveurs dans le datacenter de Beauharnois. + +### Régions multi-AZ + +OVHcloud déploie actuellement son plan stratégique pour les régions multi-zones de disponibilité (multi-AZ), débutant par le lancement de Paris 3-AZ en avril 2024 et Milan 3-AZ en novembre 2025. + +La répartition de charge entre plusieurs zones de disponibilité (AZ) au sein de la même région, à la différence d'une configuration multi-régions, garantit une **haute disponibilité**, une **haute performance** et une **résilience face aux pannes locales**, en utilisant des **connexions à faible latence** et **Anycast** pour distribuer le trafic de la manière la plus efficace. + +![Différence entre les déploiements multi-régions et multi-AZ](images/multi-az.png){.thumbnail} +*Diagramme représentant un load balancer répartissant le trafic sur les zones d'une seule région multi-AZ* ## En pratique -### Commander une zone supplémentaire +### Ajouter une zone #### Depuis l'espace client OVHcloud -Vous pouvez commander une zone supplémentaire depuis l'[espace client OVHcloud](/links/manager). Dans la partie `Bare Metal Cloud`{.action}, cliquez sur `Network`{.action} puis sur `Load Balancer`{.action}. +Vous pouvez commander une zone supplémentaire depuis l'[espace client OVHcloud](/links/manager). Dans la section `Network`{.action}, sous `Services réseau`{.action} cliquez sur `Load Balancer`{.action}. -Sélectionnez votre Load Balancer puis, dans l'onglet `Accueil`{.action} et le menu `Configuration`{.action}, cliquez sur `Ajouter`{.action} dans la partie « Zones de disponibilité ». +Sélectionnez votre Load Balancer, puis dans l'onglet `Accueil`{.action}, section `Configuration`{.action}, cliquez sur le bouton `...`{.action} sur la droite de "Zones de disponibilité" et choisissez `Ajouter`{.action}. -![Ajouter une zone load balancer depuis le manager](images/add_Zone_IPLB.png){.thumbnail} +![Ajout d'une zone Load Balancer depuis le manager](images/add_Zone_IPLB.png){.thumbnail} -Sélectionnez alors le(s) zone(s) que vous souhaitez commander et cliquez sur `Ajouter`{.action}. - -![Selection d'une zone load balancer depuis le manager](images/Select_Zone_IPLB.png){.thumbnail} +Ensuite, sélectionnez la (ou les) zone(s) que vous souhaitez commander et cliquez sur `Ajouter`{.action}. -Un bon de commande est généré, il vous faudra le régler. +![Sélection d'une zone Load Balancer depuis le manager](images/Select_Zone_IPLB.png){.thumbnail} -![Payer la commande zone load balancer depuis le manager](images/Paybill_Zone_IPLB.png){.thumbnail} +Une commande sera générée, que vous devrez régler. + +![Paiement de la commande de zone Load Balancer depuis le manager](images/Paybill_Zone_IPLB.png){.thumbnail} #### Depuis l'API OVHcloud -Pour commander une zone via l'API, vous devez tout d'abord créer un panier (*cart*) +Pour commander une zone via l'API, vous devez d'abord créer un panier ("cart"). > [!api] > > @api {v1} /order POST /order/cart > -Veuillez noter le numéro du panier (*cart*), il vous sera utile pour la suite. +Veuillez noter l'ID du panier ("cart"), il sera utile plus tard dans le processus de commande. -Assignez-vous le panier via l'appel suivant : +Ensuite, attribuez le panier à votre compte OVHcloud via l'appel suivant : > [!api] > > @api {v1} /order POST /order/cart/{cartId}/assign > -Vous pouvez lister les options disponibles sur votre service Load Balancer via : +Vous pouvez lister les options disponibles sur votre service Load Balancer via l'appel suivant : > [!api] > > @api {v1} /order GET /order/cartServiceOption/ipLoadbalancing/{serviceName} > -Quand vous avez trouvé l'option correspondant à la zone souhaitée, vous pouvez l'ajouter à votre panier (*cart*) via : +Lorsque vous avez trouvé l'option correspondant à la zone souhaitée, vous pouvez l'ajouter à votre panier ("cart") via l'appel suivant : > [!api] > > @api {v1} /order POST /order/cartServiceOption/ipLoadbalancing/{serviceName} > -Enfin, vous pouvez valider votre panier (*cart*) via : +Enfin, vous pouvez valider votre panier ("cart") via l'appel suivant : > [!api] > @api {v1} /order POST /order/cart/{cartId}/checkout @@ -81,47 +113,23 @@ Enfin, vous pouvez valider votre panier (*cart*) via : N'oubliez pas de régler le bon de commande ainsi généré. -### Ajouter une zone - -Une fois que la commande de votre zone est finalisée, vous pouvez l'ajouter depuis votre espace client OVHcloud. - -Sélectionnez le Load Balancer que vous souhaitez modifier puis créez un nouveau frontend, ou éditez-en un existant, via l'onglet `Frontends`{.action} - -Dans le champ `Datacenter`{.action}, choisissez la zone que vous souhaitez associer à votre frontend. - -![Choix de la zone](images/Select-Datacenter.png){.thumbnail} +### Configurer votre frontend -Une fois le frontend configuré, cliquez sur `Ajouter`{.action} ou `Modifier`{.action} selon que vous configurez un nouveau frontend ou un frontend existant. +Une fois votre commande de zone finalisée, vous pouvez l'ajouter à votre Load Balancer depuis l'espace client OVHcloud. -N'oubliez pas de déployer la configuration. Pour ce faire, dans le bandeau de rappel vous précisant que la configuration n'est pas appliquée, cliquez sur `Appliquer la configuration`{.action}. +Sélectionnez le Load Balancer que vous souhaitez modifier, puis créez un nouveau frontend, ou modifiez-en un existant, via l'onglet `Frontends`{.action}. -![Application d'une Configuration d'un Load Balancer](images/apply-configuration.PNG){.thumbnail} +Dans le champ `Datacenter`{.action}, choisissez la zone que vous souhaitez associer à votre frontend. -### Utiliser plusieurs zones +Si vous souhaitez utiliser plusieurs zones, vous pouvez choisir la zone spéciale `ALL`. Cette zone spéciale vous permettra de déployer la même configuration sur toutes les zones souscrites à votre service Load Balancer, ce qui vous épargne de dupliquer la configuration pour toutes les zones. -#### Pour la haute disponibilité +![Sélection de la zone](images/Select-Datacenter.png){.thumbnail} -Si vous voulez utiliser plusieurs zones afin d'obtenir une haute disponibilité, vous pouvez utiliser la valeur `Tous (ALL)` lorsque vous déclarez un frontend ou une ferme de serveurs. - -![utiliser plusieurs zones](images/Edit-frontend-All-iplb.png){.thumbnail} - -Cette valeur spéciale `Tous (ALL)` va permettre de déployer la même configuration sur toutes les zones souscrites sur votre service Load Balancer, et vous évite de dupliquer la configuration pour toutes les zones. - -#### Pour réduire la latence - -Si le but est de réduire la latence, vous pouvez diriger les requêtes venant depuis le load balancer de la zone1 vers des serveurs backends proches géographiquement de cette zone1.
-De façon similaire, vous pouvez diriger les requêtes venant depuis le load balancer de la zone2 vers des serveurs backends proches de la zone2. - -Afin de réaliser cela, il vous faut spécifier un frontend dans chaque zone qui utilise une ferme dans la même zone.
-Cela va vous permettre de déclarer les serveurs backends dans des fermes différentes par zone et de contrôler les serveurs backends utilisés en fonction de la zone. - -![Fonctionnement avec plusieurs zones et plusieurs fermes](images/multi_zones_multi_backends.png){.thumbnail} +Une fois le frontend configuré, cliquez sur `Ajouter`{.action} ou `Modifier`{.action}, selon que vous configurez un nouveau frontend ou modifiez un existant. -Par exemple, si vous avez des serveurs backends dans les datacentres de Gravelines (gra) et Beauharnois (bhs), -vous pouvez commander un service Load Balancer dans les zones `gra` et `bhs` et configurer : +N'oubliez pas de déployer la configuration. Pour cela, cliquez sur `Appliquer la configuration`{.action} dans la bannière rappelant que la configuration n'est pas appliquée. -- un frontend dans la zone gra avec une ferme (farm) par défaut dans la zone gra qui contient des serveurs dans le datacentre de Gravelines; -- un frontend dans la zone bhs avec une ferme (farm) par défaut dans la zone bhs qui contient des serveurs dans le datacentre de Beauharnois. +![Application d'une configuration Load Balancer](images/apply-configuration.PNG){.thumbnail} ## Aller plus loin diff --git a/pages/network/load_balancer/zones/images/Edit-frontend-iplb.png b/pages/network/load_balancer/zones/images/Edit-frontend-iplb.png deleted file mode 100644 index c62fda0cfd1..00000000000 Binary files a/pages/network/load_balancer/zones/images/Edit-frontend-iplb.png and /dev/null differ diff --git a/pages/network/load_balancer/zones/images/multi-az.png b/pages/network/load_balancer/zones/images/multi-az.png new file mode 100644 index 00000000000..89689d06016 Binary files /dev/null and b/pages/network/load_balancer/zones/images/multi-az.png differ diff --git a/pages/network/load_balancer/zones/images/multi_zones_multi_backends.png b/pages/network/load_balancer/zones/images/multi_zones_multi_backends.png index 6fe0e157057..b3655467208 100644 Binary files a/pages/network/load_balancer/zones/images/multi_zones_multi_backends.png and b/pages/network/load_balancer/zones/images/multi_zones_multi_backends.png differ diff --git a/pages/network/ovhcloud_connect/occ-concepts-overview/guide.de-de.md b/pages/network/ovhcloud_connect/occ-concepts-overview/guide.de-de.md index 8bd3af028d1..2246a998b43 100644 --- a/pages/network/ovhcloud_connect/occ-concepts-overview/guide.de-de.md +++ b/pages/network/ovhcloud_connect/occ-concepts-overview/guide.de-de.md @@ -1,14 +1,14 @@ --- title: Concepts overview excerpt: 'Concepts overview - OVHcloud Connect' -updated: 2025-09-09 +updated: 2025-10-29 --- ## What is OVHcloud Connect? OVHcloud Connect is a private, dedicated connection between your on-premises network and your OVHcloud vRack. It is designed to extend your network and securely connect to your cloud resources, bypassing the public internet. -![OVHcloud Connect](images/VrackConnectDedicated.png){.thumbnail} +![OVHcloud Connect](images/VrackConnectDedicated2025.png){.thumbnail} ## Benefits of OVHcloud Connect diff --git a/pages/network/ovhcloud_connect/occ-concepts-overview/guide.en-asia.md b/pages/network/ovhcloud_connect/occ-concepts-overview/guide.en-asia.md index 8bd3af028d1..2246a998b43 100644 --- a/pages/network/ovhcloud_connect/occ-concepts-overview/guide.en-asia.md +++ b/pages/network/ovhcloud_connect/occ-concepts-overview/guide.en-asia.md @@ -1,14 +1,14 @@ --- title: Concepts overview excerpt: 'Concepts overview - OVHcloud Connect' -updated: 2025-09-09 +updated: 2025-10-29 --- ## What is OVHcloud Connect? OVHcloud Connect is a private, dedicated connection between your on-premises network and your OVHcloud vRack. It is designed to extend your network and securely connect to your cloud resources, bypassing the public internet. -![OVHcloud Connect](images/VrackConnectDedicated.png){.thumbnail} +![OVHcloud Connect](images/VrackConnectDedicated2025.png){.thumbnail} ## Benefits of OVHcloud Connect diff --git a/pages/network/ovhcloud_connect/occ-concepts-overview/guide.en-au.md b/pages/network/ovhcloud_connect/occ-concepts-overview/guide.en-au.md index 8bd3af028d1..2246a998b43 100644 --- a/pages/network/ovhcloud_connect/occ-concepts-overview/guide.en-au.md +++ b/pages/network/ovhcloud_connect/occ-concepts-overview/guide.en-au.md @@ -1,14 +1,14 @@ --- title: Concepts overview excerpt: 'Concepts overview - OVHcloud Connect' -updated: 2025-09-09 +updated: 2025-10-29 --- ## What is OVHcloud Connect? OVHcloud Connect is a private, dedicated connection between your on-premises network and your OVHcloud vRack. It is designed to extend your network and securely connect to your cloud resources, bypassing the public internet. -![OVHcloud Connect](images/VrackConnectDedicated.png){.thumbnail} +![OVHcloud Connect](images/VrackConnectDedicated2025.png){.thumbnail} ## Benefits of OVHcloud Connect diff --git a/pages/network/ovhcloud_connect/occ-concepts-overview/guide.en-ca.md b/pages/network/ovhcloud_connect/occ-concepts-overview/guide.en-ca.md index 8bd3af028d1..2246a998b43 100644 --- a/pages/network/ovhcloud_connect/occ-concepts-overview/guide.en-ca.md +++ b/pages/network/ovhcloud_connect/occ-concepts-overview/guide.en-ca.md @@ -1,14 +1,14 @@ --- title: Concepts overview excerpt: 'Concepts overview - OVHcloud Connect' -updated: 2025-09-09 +updated: 2025-10-29 --- ## What is OVHcloud Connect? OVHcloud Connect is a private, dedicated connection between your on-premises network and your OVHcloud vRack. It is designed to extend your network and securely connect to your cloud resources, bypassing the public internet. -![OVHcloud Connect](images/VrackConnectDedicated.png){.thumbnail} +![OVHcloud Connect](images/VrackConnectDedicated2025.png){.thumbnail} ## Benefits of OVHcloud Connect diff --git a/pages/network/ovhcloud_connect/occ-concepts-overview/guide.en-gb.md b/pages/network/ovhcloud_connect/occ-concepts-overview/guide.en-gb.md index 8bd3af028d1..2246a998b43 100644 --- a/pages/network/ovhcloud_connect/occ-concepts-overview/guide.en-gb.md +++ b/pages/network/ovhcloud_connect/occ-concepts-overview/guide.en-gb.md @@ -1,14 +1,14 @@ --- title: Concepts overview excerpt: 'Concepts overview - OVHcloud Connect' -updated: 2025-09-09 +updated: 2025-10-29 --- ## What is OVHcloud Connect? OVHcloud Connect is a private, dedicated connection between your on-premises network and your OVHcloud vRack. It is designed to extend your network and securely connect to your cloud resources, bypassing the public internet. -![OVHcloud Connect](images/VrackConnectDedicated.png){.thumbnail} +![OVHcloud Connect](images/VrackConnectDedicated2025.png){.thumbnail} ## Benefits of OVHcloud Connect diff --git a/pages/network/ovhcloud_connect/occ-concepts-overview/guide.en-ie.md b/pages/network/ovhcloud_connect/occ-concepts-overview/guide.en-ie.md index 8bd3af028d1..2246a998b43 100644 --- a/pages/network/ovhcloud_connect/occ-concepts-overview/guide.en-ie.md +++ b/pages/network/ovhcloud_connect/occ-concepts-overview/guide.en-ie.md @@ -1,14 +1,14 @@ --- title: Concepts overview excerpt: 'Concepts overview - OVHcloud Connect' -updated: 2025-09-09 +updated: 2025-10-29 --- ## What is OVHcloud Connect? OVHcloud Connect is a private, dedicated connection between your on-premises network and your OVHcloud vRack. It is designed to extend your network and securely connect to your cloud resources, bypassing the public internet. -![OVHcloud Connect](images/VrackConnectDedicated.png){.thumbnail} +![OVHcloud Connect](images/VrackConnectDedicated2025.png){.thumbnail} ## Benefits of OVHcloud Connect diff --git a/pages/network/ovhcloud_connect/occ-concepts-overview/guide.en-sg.md b/pages/network/ovhcloud_connect/occ-concepts-overview/guide.en-sg.md index 8bd3af028d1..2246a998b43 100644 --- a/pages/network/ovhcloud_connect/occ-concepts-overview/guide.en-sg.md +++ b/pages/network/ovhcloud_connect/occ-concepts-overview/guide.en-sg.md @@ -1,14 +1,14 @@ --- title: Concepts overview excerpt: 'Concepts overview - OVHcloud Connect' -updated: 2025-09-09 +updated: 2025-10-29 --- ## What is OVHcloud Connect? OVHcloud Connect is a private, dedicated connection between your on-premises network and your OVHcloud vRack. It is designed to extend your network and securely connect to your cloud resources, bypassing the public internet. -![OVHcloud Connect](images/VrackConnectDedicated.png){.thumbnail} +![OVHcloud Connect](images/VrackConnectDedicated2025.png){.thumbnail} ## Benefits of OVHcloud Connect diff --git a/pages/network/ovhcloud_connect/occ-concepts-overview/guide.en-us.md b/pages/network/ovhcloud_connect/occ-concepts-overview/guide.en-us.md index 8bd3af028d1..2246a998b43 100644 --- a/pages/network/ovhcloud_connect/occ-concepts-overview/guide.en-us.md +++ b/pages/network/ovhcloud_connect/occ-concepts-overview/guide.en-us.md @@ -1,14 +1,14 @@ --- title: Concepts overview excerpt: 'Concepts overview - OVHcloud Connect' -updated: 2025-09-09 +updated: 2025-10-29 --- ## What is OVHcloud Connect? OVHcloud Connect is a private, dedicated connection between your on-premises network and your OVHcloud vRack. It is designed to extend your network and securely connect to your cloud resources, bypassing the public internet. -![OVHcloud Connect](images/VrackConnectDedicated.png){.thumbnail} +![OVHcloud Connect](images/VrackConnectDedicated2025.png){.thumbnail} ## Benefits of OVHcloud Connect diff --git a/pages/network/ovhcloud_connect/occ-concepts-overview/guide.es-es.md b/pages/network/ovhcloud_connect/occ-concepts-overview/guide.es-es.md index 8bd3af028d1..2246a998b43 100644 --- a/pages/network/ovhcloud_connect/occ-concepts-overview/guide.es-es.md +++ b/pages/network/ovhcloud_connect/occ-concepts-overview/guide.es-es.md @@ -1,14 +1,14 @@ --- title: Concepts overview excerpt: 'Concepts overview - OVHcloud Connect' -updated: 2025-09-09 +updated: 2025-10-29 --- ## What is OVHcloud Connect? OVHcloud Connect is a private, dedicated connection between your on-premises network and your OVHcloud vRack. It is designed to extend your network and securely connect to your cloud resources, bypassing the public internet. -![OVHcloud Connect](images/VrackConnectDedicated.png){.thumbnail} +![OVHcloud Connect](images/VrackConnectDedicated2025.png){.thumbnail} ## Benefits of OVHcloud Connect diff --git a/pages/network/ovhcloud_connect/occ-concepts-overview/guide.es-us.md b/pages/network/ovhcloud_connect/occ-concepts-overview/guide.es-us.md index 8bd3af028d1..2246a998b43 100644 --- a/pages/network/ovhcloud_connect/occ-concepts-overview/guide.es-us.md +++ b/pages/network/ovhcloud_connect/occ-concepts-overview/guide.es-us.md @@ -1,14 +1,14 @@ --- title: Concepts overview excerpt: 'Concepts overview - OVHcloud Connect' -updated: 2025-09-09 +updated: 2025-10-29 --- ## What is OVHcloud Connect? OVHcloud Connect is a private, dedicated connection between your on-premises network and your OVHcloud vRack. It is designed to extend your network and securely connect to your cloud resources, bypassing the public internet. -![OVHcloud Connect](images/VrackConnectDedicated.png){.thumbnail} +![OVHcloud Connect](images/VrackConnectDedicated2025.png){.thumbnail} ## Benefits of OVHcloud Connect diff --git a/pages/network/ovhcloud_connect/occ-concepts-overview/guide.fr-ca.md b/pages/network/ovhcloud_connect/occ-concepts-overview/guide.fr-ca.md index d94fd1fc063..f1d77f4838b 100644 --- a/pages/network/ovhcloud_connect/occ-concepts-overview/guide.fr-ca.md +++ b/pages/network/ovhcloud_connect/occ-concepts-overview/guide.fr-ca.md @@ -1,14 +1,14 @@ --- title: Présentation des concepts excerpt: Présentation des concepts nécessaires à la compréhension de l’offre OVHcloud Connect -updated: 2025-09-09 +updated: 2025-10-29 --- ## Qu'est-ce que OVHcloud Connect ? OVHcloud Connect est une connexion privée et dédiée entre votre réseau sur site et votre vRack OVHcloud. Il est conçu pour étendre votre réseau et vous connecter de manière sécurisée à vos ressources cloud, en contournant l'internet public. -![OVHcloud Connect](images/VrackConnectDedicated.png){.thumbnail} +![OVHcloud Connect](images/VrackConnectDedicated2025.png){.thumbnail} ## Avantages de l'offre diff --git a/pages/network/ovhcloud_connect/occ-concepts-overview/guide.fr-fr.md b/pages/network/ovhcloud_connect/occ-concepts-overview/guide.fr-fr.md index d94fd1fc063..f1d77f4838b 100644 --- a/pages/network/ovhcloud_connect/occ-concepts-overview/guide.fr-fr.md +++ b/pages/network/ovhcloud_connect/occ-concepts-overview/guide.fr-fr.md @@ -1,14 +1,14 @@ --- title: Présentation des concepts excerpt: Présentation des concepts nécessaires à la compréhension de l’offre OVHcloud Connect -updated: 2025-09-09 +updated: 2025-10-29 --- ## Qu'est-ce que OVHcloud Connect ? OVHcloud Connect est une connexion privée et dédiée entre votre réseau sur site et votre vRack OVHcloud. Il est conçu pour étendre votre réseau et vous connecter de manière sécurisée à vos ressources cloud, en contournant l'internet public. -![OVHcloud Connect](images/VrackConnectDedicated.png){.thumbnail} +![OVHcloud Connect](images/VrackConnectDedicated2025.png){.thumbnail} ## Avantages de l'offre diff --git a/pages/network/ovhcloud_connect/occ-concepts-overview/guide.it-it.md b/pages/network/ovhcloud_connect/occ-concepts-overview/guide.it-it.md index 8bd3af028d1..2246a998b43 100644 --- a/pages/network/ovhcloud_connect/occ-concepts-overview/guide.it-it.md +++ b/pages/network/ovhcloud_connect/occ-concepts-overview/guide.it-it.md @@ -1,14 +1,14 @@ --- title: Concepts overview excerpt: 'Concepts overview - OVHcloud Connect' -updated: 2025-09-09 +updated: 2025-10-29 --- ## What is OVHcloud Connect? OVHcloud Connect is a private, dedicated connection between your on-premises network and your OVHcloud vRack. It is designed to extend your network and securely connect to your cloud resources, bypassing the public internet. -![OVHcloud Connect](images/VrackConnectDedicated.png){.thumbnail} +![OVHcloud Connect](images/VrackConnectDedicated2025.png){.thumbnail} ## Benefits of OVHcloud Connect diff --git a/pages/network/ovhcloud_connect/occ-concepts-overview/guide.pl-pl.md b/pages/network/ovhcloud_connect/occ-concepts-overview/guide.pl-pl.md index 8bd3af028d1..2246a998b43 100644 --- a/pages/network/ovhcloud_connect/occ-concepts-overview/guide.pl-pl.md +++ b/pages/network/ovhcloud_connect/occ-concepts-overview/guide.pl-pl.md @@ -1,14 +1,14 @@ --- title: Concepts overview excerpt: 'Concepts overview - OVHcloud Connect' -updated: 2025-09-09 +updated: 2025-10-29 --- ## What is OVHcloud Connect? OVHcloud Connect is a private, dedicated connection between your on-premises network and your OVHcloud vRack. It is designed to extend your network and securely connect to your cloud resources, bypassing the public internet. -![OVHcloud Connect](images/VrackConnectDedicated.png){.thumbnail} +![OVHcloud Connect](images/VrackConnectDedicated2025.png){.thumbnail} ## Benefits of OVHcloud Connect diff --git a/pages/network/ovhcloud_connect/occ-concepts-overview/guide.pt-pt.md b/pages/network/ovhcloud_connect/occ-concepts-overview/guide.pt-pt.md index 8bd3af028d1..2246a998b43 100644 --- a/pages/network/ovhcloud_connect/occ-concepts-overview/guide.pt-pt.md +++ b/pages/network/ovhcloud_connect/occ-concepts-overview/guide.pt-pt.md @@ -1,14 +1,14 @@ --- title: Concepts overview excerpt: 'Concepts overview - OVHcloud Connect' -updated: 2025-09-09 +updated: 2025-10-29 --- ## What is OVHcloud Connect? OVHcloud Connect is a private, dedicated connection between your on-premises network and your OVHcloud vRack. It is designed to extend your network and securely connect to your cloud resources, bypassing the public internet. -![OVHcloud Connect](images/VrackConnectDedicated.png){.thumbnail} +![OVHcloud Connect](images/VrackConnectDedicated2025.png){.thumbnail} ## Benefits of OVHcloud Connect diff --git a/pages/network/ovhcloud_connect/occ-concepts-overview/images/VrackConnectDedicated.png b/pages/network/ovhcloud_connect/occ-concepts-overview/images/VrackConnectDedicated.png deleted file mode 100644 index 1507623b9e7..00000000000 Binary files a/pages/network/ovhcloud_connect/occ-concepts-overview/images/VrackConnectDedicated.png and /dev/null differ diff --git a/pages/network/ovhcloud_connect/occ-concepts-overview/images/VrackConnectDedicated2025.png b/pages/network/ovhcloud_connect/occ-concepts-overview/images/VrackConnectDedicated2025.png new file mode 100644 index 00000000000..fe81a8786e4 Binary files /dev/null and b/pages/network/ovhcloud_connect/occ-concepts-overview/images/VrackConnectDedicated2025.png differ diff --git a/pages/network/ovhcloud_connect/occ-direct-control-panel/images/l2pop1-1.png b/pages/network/ovhcloud_connect/occ-direct-control-panel/images/l2pop1-1.png deleted file mode 100644 index 68ec65640d7..00000000000 Binary files a/pages/network/ovhcloud_connect/occ-direct-control-panel/images/l2pop1-1.png and /dev/null differ diff --git a/pages/network/ovhcloud_connect/occ-direct-control-panel/images/occ01.png b/pages/network/ovhcloud_connect/occ-direct-control-panel/images/occ01.png deleted file mode 100644 index b13fe43d67e..00000000000 Binary files a/pages/network/ovhcloud_connect/occ-direct-control-panel/images/occ01.png and /dev/null differ diff --git a/pages/network/ovhcloud_connect/occ-direct-control-panel/images/occ1.png b/pages/network/ovhcloud_connect/occ-direct-control-panel/images/occ1.png deleted file mode 100644 index 80ae8132562..00000000000 Binary files a/pages/network/ovhcloud_connect/occ-direct-control-panel/images/occ1.png and /dev/null differ diff --git a/pages/network/ovhcloud_connect/occ-direct-control-panel/images/vrack1-1.png b/pages/network/ovhcloud_connect/occ-direct-control-panel/images/vrack1-1.png deleted file mode 100644 index e91707302dd..00000000000 Binary files a/pages/network/ovhcloud_connect/occ-direct-control-panel/images/vrack1-1.png and /dev/null differ diff --git a/pages/network/ovhcloud_connect/occ-direct-control-panel/images/vrack1.png b/pages/network/ovhcloud_connect/occ-direct-control-panel/images/vrack1.png deleted file mode 100644 index 7fe0c906fe0..00000000000 Binary files a/pages/network/ovhcloud_connect/occ-direct-control-panel/images/vrack1.png and /dev/null differ diff --git a/pages/network/ovhcloud_connect/occ-layer2/images/occ-l2-implementation.jpg b/pages/network/ovhcloud_connect/occ-layer2/images/occ-l2-implementation.jpg deleted file mode 100644 index c652ee60a6d..00000000000 Binary files a/pages/network/ovhcloud_connect/occ-layer2/images/occ-l2-implementation.jpg and /dev/null differ diff --git a/pages/network/ovhcloud_connect/occ-layer2/images/occ-l2-supported.jpg b/pages/network/ovhcloud_connect/occ-layer2/images/occ-l2-supported.jpg deleted file mode 100644 index 56c56c7a5f2..00000000000 Binary files a/pages/network/ovhcloud_connect/occ-layer2/images/occ-l2-supported.jpg and /dev/null differ diff --git a/pages/network/ovhcloud_connect/occ-layer2/images/occ-l2-topologies.jpg b/pages/network/ovhcloud_connect/occ-layer2/images/occ-l2-topologies.jpg deleted file mode 100644 index b9163bc48b7..00000000000 Binary files a/pages/network/ovhcloud_connect/occ-layer2/images/occ-l2-topologies.jpg and /dev/null differ diff --git a/pages/network/ovhcloud_connect/occ-layer2/images/occ-l2-trafic.jpg b/pages/network/ovhcloud_connect/occ-layer2/images/occ-l2-trafic.jpg deleted file mode 100644 index d472e0dff65..00000000000 Binary files a/pages/network/ovhcloud_connect/occ-layer2/images/occ-l2-trafic.jpg and /dev/null differ diff --git a/pages/network/ovhcloud_connect/occ-layer2/images/occ-l2-unsupported.jpg b/pages/network/ovhcloud_connect/occ-layer2/images/occ-l2-unsupported.jpg deleted file mode 100644 index 01ef62c640d..00000000000 Binary files a/pages/network/ovhcloud_connect/occ-layer2/images/occ-l2-unsupported.jpg and /dev/null differ diff --git a/pages/network/ovhcloud_connect/occ-layer3/images/occ-l3-architecture.jpg b/pages/network/ovhcloud_connect/occ-layer3/images/occ-l3-architecture.jpg deleted file mode 100644 index 3c642696bdc..00000000000 Binary files a/pages/network/ovhcloud_connect/occ-layer3/images/occ-l3-architecture.jpg and /dev/null differ diff --git a/pages/network/ovhcloud_connect/occ-layer3/images/occ-l3-bgpasprepend.jpg b/pages/network/ovhcloud_connect/occ-layer3/images/occ-l3-bgpasprepend.jpg deleted file mode 100644 index 7da8b950d25..00000000000 Binary files a/pages/network/ovhcloud_connect/occ-layer3/images/occ-l3-bgpasprepend.jpg and /dev/null differ diff --git a/pages/network/ovhcloud_connect/occ-layer3/images/occ-l3-bgpglobal.jpg b/pages/network/ovhcloud_connect/occ-layer3/images/occ-l3-bgpglobal.jpg deleted file mode 100644 index 6c28c31dc2e..00000000000 Binary files a/pages/network/ovhcloud_connect/occ-layer3/images/occ-l3-bgpglobal.jpg and /dev/null differ diff --git a/pages/network/ovhcloud_connect/occ-layer3/images/occ-l3-bgpmed.jpg b/pages/network/ovhcloud_connect/occ-layer3/images/occ-l3-bgpmed.jpg deleted file mode 100644 index 7a494af5f13..00000000000 Binary files a/pages/network/ovhcloud_connect/occ-layer3/images/occ-l3-bgpmed.jpg and /dev/null differ diff --git a/pages/network/ovhcloud_connect/occ-layer3/images/occ-l3-bgpvrack.jpg b/pages/network/ovhcloud_connect/occ-layer3/images/occ-l3-bgpvrack.jpg deleted file mode 100644 index 06348fcfb77..00000000000 Binary files a/pages/network/ovhcloud_connect/occ-layer3/images/occ-l3-bgpvrack.jpg and /dev/null differ diff --git a/pages/network/ovhcloud_connect/occ-layer3/images/occ-l3-implementation.jpg b/pages/network/ovhcloud_connect/occ-layer3/images/occ-l3-implementation.jpg deleted file mode 100644 index 9bac0560855..00000000000 Binary files a/pages/network/ovhcloud_connect/occ-layer3/images/occ-l3-implementation.jpg and /dev/null differ diff --git a/pages/network/ovhcloud_connect/occ-layer3/images/occ-l3-mixl2.jpg b/pages/network/ovhcloud_connect/occ-layer3/images/occ-l3-mixl2.jpg deleted file mode 100644 index 189d9c5c8de..00000000000 Binary files a/pages/network/ovhcloud_connect/occ-layer3/images/occ-l3-mixl2.jpg and /dev/null differ diff --git a/pages/network/ovhcloud_connect/occ-layer3/images/occ-l3-multidc.jpg b/pages/network/ovhcloud_connect/occ-layer3/images/occ-l3-multidc.jpg deleted file mode 100644 index 210c1686172..00000000000 Binary files a/pages/network/ovhcloud_connect/occ-layer3/images/occ-l3-multidc.jpg and /dev/null differ diff --git a/pages/network/ovhcloud_connect/occ-layer3/images/occ-l3-rules.jpg b/pages/network/ovhcloud_connect/occ-layer3/images/occ-l3-rules.jpg deleted file mode 100644 index a320ddc835a..00000000000 Binary files a/pages/network/ovhcloud_connect/occ-layer3/images/occ-l3-rules.jpg and /dev/null differ diff --git a/pages/network/ovhcloud_connect/occ-layer3/images/occ-l3-twopop.jpg b/pages/network/ovhcloud_connect/occ-layer3/images/occ-l3-twopop.jpg deleted file mode 100644 index 4819a6b765f..00000000000 Binary files a/pages/network/ovhcloud_connect/occ-layer3/images/occ-l3-twopop.jpg and /dev/null differ diff --git a/pages/network/ovhcloud_connect/occ-limits/guide.de-de.md b/pages/network/ovhcloud_connect/occ-limits/guide.de-de.md index f849566e231..eeca25e2675 100644 --- a/pages/network/ovhcloud_connect/occ-limits/guide.de-de.md +++ b/pages/network/ovhcloud_connect/occ-limits/guide.de-de.md @@ -1,7 +1,7 @@ --- title: Technical capabilities and limitations excerpt: 'Learn the technical capabilities and limitations of the OVHcloud Connect solution' -updated: 2022-08-25 +updated: 2025-10-03 --- ## Objective @@ -14,14 +14,16 @@ updated: 2022-08-25 - 1000Base-LX/LH for 1Gb - 10GBase-LR for 10Gb +- 100GBase-LR4 for 100Gb - Jumbo frame up to 9000 bytes - Autonegotiation not supported -### Technical limitationss +### Technical limitations #### Layer 2 mode - The number of client-side MAC addresses is limited to 512 per port +- The maximum bandwidth is 10Gb per port #### Layer 3 mode diff --git a/pages/network/ovhcloud_connect/occ-limits/guide.en-asia.md b/pages/network/ovhcloud_connect/occ-limits/guide.en-asia.md index f849566e231..eeca25e2675 100644 --- a/pages/network/ovhcloud_connect/occ-limits/guide.en-asia.md +++ b/pages/network/ovhcloud_connect/occ-limits/guide.en-asia.md @@ -1,7 +1,7 @@ --- title: Technical capabilities and limitations excerpt: 'Learn the technical capabilities and limitations of the OVHcloud Connect solution' -updated: 2022-08-25 +updated: 2025-10-03 --- ## Objective @@ -14,14 +14,16 @@ updated: 2022-08-25 - 1000Base-LX/LH for 1Gb - 10GBase-LR for 10Gb +- 100GBase-LR4 for 100Gb - Jumbo frame up to 9000 bytes - Autonegotiation not supported -### Technical limitationss +### Technical limitations #### Layer 2 mode - The number of client-side MAC addresses is limited to 512 per port +- The maximum bandwidth is 10Gb per port #### Layer 3 mode diff --git a/pages/network/ovhcloud_connect/occ-limits/guide.en-au.md b/pages/network/ovhcloud_connect/occ-limits/guide.en-au.md index f849566e231..eeca25e2675 100644 --- a/pages/network/ovhcloud_connect/occ-limits/guide.en-au.md +++ b/pages/network/ovhcloud_connect/occ-limits/guide.en-au.md @@ -1,7 +1,7 @@ --- title: Technical capabilities and limitations excerpt: 'Learn the technical capabilities and limitations of the OVHcloud Connect solution' -updated: 2022-08-25 +updated: 2025-10-03 --- ## Objective @@ -14,14 +14,16 @@ updated: 2022-08-25 - 1000Base-LX/LH for 1Gb - 10GBase-LR for 10Gb +- 100GBase-LR4 for 100Gb - Jumbo frame up to 9000 bytes - Autonegotiation not supported -### Technical limitationss +### Technical limitations #### Layer 2 mode - The number of client-side MAC addresses is limited to 512 per port +- The maximum bandwidth is 10Gb per port #### Layer 3 mode diff --git a/pages/network/ovhcloud_connect/occ-limits/guide.en-ca.md b/pages/network/ovhcloud_connect/occ-limits/guide.en-ca.md index f849566e231..eeca25e2675 100644 --- a/pages/network/ovhcloud_connect/occ-limits/guide.en-ca.md +++ b/pages/network/ovhcloud_connect/occ-limits/guide.en-ca.md @@ -1,7 +1,7 @@ --- title: Technical capabilities and limitations excerpt: 'Learn the technical capabilities and limitations of the OVHcloud Connect solution' -updated: 2022-08-25 +updated: 2025-10-03 --- ## Objective @@ -14,14 +14,16 @@ updated: 2022-08-25 - 1000Base-LX/LH for 1Gb - 10GBase-LR for 10Gb +- 100GBase-LR4 for 100Gb - Jumbo frame up to 9000 bytes - Autonegotiation not supported -### Technical limitationss +### Technical limitations #### Layer 2 mode - The number of client-side MAC addresses is limited to 512 per port +- The maximum bandwidth is 10Gb per port #### Layer 3 mode diff --git a/pages/network/ovhcloud_connect/occ-limits/guide.en-gb.md b/pages/network/ovhcloud_connect/occ-limits/guide.en-gb.md index f849566e231..eeca25e2675 100644 --- a/pages/network/ovhcloud_connect/occ-limits/guide.en-gb.md +++ b/pages/network/ovhcloud_connect/occ-limits/guide.en-gb.md @@ -1,7 +1,7 @@ --- title: Technical capabilities and limitations excerpt: 'Learn the technical capabilities and limitations of the OVHcloud Connect solution' -updated: 2022-08-25 +updated: 2025-10-03 --- ## Objective @@ -14,14 +14,16 @@ updated: 2022-08-25 - 1000Base-LX/LH for 1Gb - 10GBase-LR for 10Gb +- 100GBase-LR4 for 100Gb - Jumbo frame up to 9000 bytes - Autonegotiation not supported -### Technical limitationss +### Technical limitations #### Layer 2 mode - The number of client-side MAC addresses is limited to 512 per port +- The maximum bandwidth is 10Gb per port #### Layer 3 mode diff --git a/pages/network/ovhcloud_connect/occ-limits/guide.en-ie.md b/pages/network/ovhcloud_connect/occ-limits/guide.en-ie.md index f849566e231..eeca25e2675 100644 --- a/pages/network/ovhcloud_connect/occ-limits/guide.en-ie.md +++ b/pages/network/ovhcloud_connect/occ-limits/guide.en-ie.md @@ -1,7 +1,7 @@ --- title: Technical capabilities and limitations excerpt: 'Learn the technical capabilities and limitations of the OVHcloud Connect solution' -updated: 2022-08-25 +updated: 2025-10-03 --- ## Objective @@ -14,14 +14,16 @@ updated: 2022-08-25 - 1000Base-LX/LH for 1Gb - 10GBase-LR for 10Gb +- 100GBase-LR4 for 100Gb - Jumbo frame up to 9000 bytes - Autonegotiation not supported -### Technical limitationss +### Technical limitations #### Layer 2 mode - The number of client-side MAC addresses is limited to 512 per port +- The maximum bandwidth is 10Gb per port #### Layer 3 mode diff --git a/pages/network/ovhcloud_connect/occ-limits/guide.en-sg.md b/pages/network/ovhcloud_connect/occ-limits/guide.en-sg.md index f849566e231..eeca25e2675 100644 --- a/pages/network/ovhcloud_connect/occ-limits/guide.en-sg.md +++ b/pages/network/ovhcloud_connect/occ-limits/guide.en-sg.md @@ -1,7 +1,7 @@ --- title: Technical capabilities and limitations excerpt: 'Learn the technical capabilities and limitations of the OVHcloud Connect solution' -updated: 2022-08-25 +updated: 2025-10-03 --- ## Objective @@ -14,14 +14,16 @@ updated: 2022-08-25 - 1000Base-LX/LH for 1Gb - 10GBase-LR for 10Gb +- 100GBase-LR4 for 100Gb - Jumbo frame up to 9000 bytes - Autonegotiation not supported -### Technical limitationss +### Technical limitations #### Layer 2 mode - The number of client-side MAC addresses is limited to 512 per port +- The maximum bandwidth is 10Gb per port #### Layer 3 mode diff --git a/pages/network/ovhcloud_connect/occ-limits/guide.en-us.md b/pages/network/ovhcloud_connect/occ-limits/guide.en-us.md index f849566e231..eeca25e2675 100644 --- a/pages/network/ovhcloud_connect/occ-limits/guide.en-us.md +++ b/pages/network/ovhcloud_connect/occ-limits/guide.en-us.md @@ -1,7 +1,7 @@ --- title: Technical capabilities and limitations excerpt: 'Learn the technical capabilities and limitations of the OVHcloud Connect solution' -updated: 2022-08-25 +updated: 2025-10-03 --- ## Objective @@ -14,14 +14,16 @@ updated: 2022-08-25 - 1000Base-LX/LH for 1Gb - 10GBase-LR for 10Gb +- 100GBase-LR4 for 100Gb - Jumbo frame up to 9000 bytes - Autonegotiation not supported -### Technical limitationss +### Technical limitations #### Layer 2 mode - The number of client-side MAC addresses is limited to 512 per port +- The maximum bandwidth is 10Gb per port #### Layer 3 mode diff --git a/pages/network/ovhcloud_connect/occ-limits/guide.es-es.md b/pages/network/ovhcloud_connect/occ-limits/guide.es-es.md index f849566e231..eeca25e2675 100644 --- a/pages/network/ovhcloud_connect/occ-limits/guide.es-es.md +++ b/pages/network/ovhcloud_connect/occ-limits/guide.es-es.md @@ -1,7 +1,7 @@ --- title: Technical capabilities and limitations excerpt: 'Learn the technical capabilities and limitations of the OVHcloud Connect solution' -updated: 2022-08-25 +updated: 2025-10-03 --- ## Objective @@ -14,14 +14,16 @@ updated: 2022-08-25 - 1000Base-LX/LH for 1Gb - 10GBase-LR for 10Gb +- 100GBase-LR4 for 100Gb - Jumbo frame up to 9000 bytes - Autonegotiation not supported -### Technical limitationss +### Technical limitations #### Layer 2 mode - The number of client-side MAC addresses is limited to 512 per port +- The maximum bandwidth is 10Gb per port #### Layer 3 mode diff --git a/pages/network/ovhcloud_connect/occ-limits/guide.es-us.md b/pages/network/ovhcloud_connect/occ-limits/guide.es-us.md index f849566e231..eeca25e2675 100644 --- a/pages/network/ovhcloud_connect/occ-limits/guide.es-us.md +++ b/pages/network/ovhcloud_connect/occ-limits/guide.es-us.md @@ -1,7 +1,7 @@ --- title: Technical capabilities and limitations excerpt: 'Learn the technical capabilities and limitations of the OVHcloud Connect solution' -updated: 2022-08-25 +updated: 2025-10-03 --- ## Objective @@ -14,14 +14,16 @@ updated: 2022-08-25 - 1000Base-LX/LH for 1Gb - 10GBase-LR for 10Gb +- 100GBase-LR4 for 100Gb - Jumbo frame up to 9000 bytes - Autonegotiation not supported -### Technical limitationss +### Technical limitations #### Layer 2 mode - The number of client-side MAC addresses is limited to 512 per port +- The maximum bandwidth is 10Gb per port #### Layer 3 mode diff --git a/pages/network/ovhcloud_connect/occ-limits/guide.fr-ca.md b/pages/network/ovhcloud_connect/occ-limits/guide.fr-ca.md index fec7c31fda9..b33f7b233fd 100644 --- a/pages/network/ovhcloud_connect/occ-limits/guide.fr-ca.md +++ b/pages/network/ovhcloud_connect/occ-limits/guide.fr-ca.md @@ -1,7 +1,7 @@ --- title: Capacités et limites techniques excerpt: 'Découvrez les capacités et limites techniques de l offre OVHcloud Connect' -updated: 2022-08-25 +updated: 2025-10-03 --- ## Objectif @@ -14,6 +14,7 @@ updated: 2022-08-25 * 1000Base-LX/LH pour 1Gb * 10GBase-LR pour 10Gb +* 100GBase-LR4 pour 100Gb * Jumbo Frame: jusqu'à 9000 bytes * Auto-négociation non supportée @@ -22,6 +23,7 @@ updated: 2022-08-25 #### Mode Layer 2 * Le nombre d'adresses MAC coté client est limité à 512 par port +* La bande passante maximale est de 10Gb par port #### Mode Layer-3 diff --git a/pages/network/ovhcloud_connect/occ-limits/guide.fr-fr.md b/pages/network/ovhcloud_connect/occ-limits/guide.fr-fr.md index fec7c31fda9..b33f7b233fd 100644 --- a/pages/network/ovhcloud_connect/occ-limits/guide.fr-fr.md +++ b/pages/network/ovhcloud_connect/occ-limits/guide.fr-fr.md @@ -1,7 +1,7 @@ --- title: Capacités et limites techniques excerpt: 'Découvrez les capacités et limites techniques de l offre OVHcloud Connect' -updated: 2022-08-25 +updated: 2025-10-03 --- ## Objectif @@ -14,6 +14,7 @@ updated: 2022-08-25 * 1000Base-LX/LH pour 1Gb * 10GBase-LR pour 10Gb +* 100GBase-LR4 pour 100Gb * Jumbo Frame: jusqu'à 9000 bytes * Auto-négociation non supportée @@ -22,6 +23,7 @@ updated: 2022-08-25 #### Mode Layer 2 * Le nombre d'adresses MAC coté client est limité à 512 par port +* La bande passante maximale est de 10Gb par port #### Mode Layer-3 diff --git a/pages/network/ovhcloud_connect/occ-limits/guide.it-it.md b/pages/network/ovhcloud_connect/occ-limits/guide.it-it.md index f849566e231..eeca25e2675 100644 --- a/pages/network/ovhcloud_connect/occ-limits/guide.it-it.md +++ b/pages/network/ovhcloud_connect/occ-limits/guide.it-it.md @@ -1,7 +1,7 @@ --- title: Technical capabilities and limitations excerpt: 'Learn the technical capabilities and limitations of the OVHcloud Connect solution' -updated: 2022-08-25 +updated: 2025-10-03 --- ## Objective @@ -14,14 +14,16 @@ updated: 2022-08-25 - 1000Base-LX/LH for 1Gb - 10GBase-LR for 10Gb +- 100GBase-LR4 for 100Gb - Jumbo frame up to 9000 bytes - Autonegotiation not supported -### Technical limitationss +### Technical limitations #### Layer 2 mode - The number of client-side MAC addresses is limited to 512 per port +- The maximum bandwidth is 10Gb per port #### Layer 3 mode diff --git a/pages/network/ovhcloud_connect/occ-limits/guide.pl-pl.md b/pages/network/ovhcloud_connect/occ-limits/guide.pl-pl.md index f849566e231..eeca25e2675 100644 --- a/pages/network/ovhcloud_connect/occ-limits/guide.pl-pl.md +++ b/pages/network/ovhcloud_connect/occ-limits/guide.pl-pl.md @@ -1,7 +1,7 @@ --- title: Technical capabilities and limitations excerpt: 'Learn the technical capabilities and limitations of the OVHcloud Connect solution' -updated: 2022-08-25 +updated: 2025-10-03 --- ## Objective @@ -14,14 +14,16 @@ updated: 2022-08-25 - 1000Base-LX/LH for 1Gb - 10GBase-LR for 10Gb +- 100GBase-LR4 for 100Gb - Jumbo frame up to 9000 bytes - Autonegotiation not supported -### Technical limitationss +### Technical limitations #### Layer 2 mode - The number of client-side MAC addresses is limited to 512 per port +- The maximum bandwidth is 10Gb per port #### Layer 3 mode diff --git a/pages/network/ovhcloud_connect/occ-limits/guide.pt-pt.md b/pages/network/ovhcloud_connect/occ-limits/guide.pt-pt.md index f849566e231..eeca25e2675 100644 --- a/pages/network/ovhcloud_connect/occ-limits/guide.pt-pt.md +++ b/pages/network/ovhcloud_connect/occ-limits/guide.pt-pt.md @@ -1,7 +1,7 @@ --- title: Technical capabilities and limitations excerpt: 'Learn the technical capabilities and limitations of the OVHcloud Connect solution' -updated: 2022-08-25 +updated: 2025-10-03 --- ## Objective @@ -14,14 +14,16 @@ updated: 2022-08-25 - 1000Base-LX/LH for 1Gb - 10GBase-LR for 10Gb +- 100GBase-LR4 for 100Gb - Jumbo frame up to 9000 bytes - Autonegotiation not supported -### Technical limitationss +### Technical limitations #### Layer 2 mode - The number of client-side MAC addresses is limited to 512 per port +- The maximum bandwidth is 10Gb per port #### Layer 3 mode diff --git a/pages/network/ovhcloud_connect/occ-provider-control-panel/images/occ01.png b/pages/network/ovhcloud_connect/occ-provider-control-panel/images/occ01.png deleted file mode 100644 index b13fe43d67e..00000000000 Binary files a/pages/network/ovhcloud_connect/occ-provider-control-panel/images/occ01.png and /dev/null differ diff --git a/pages/network/ovhcloud_connect/occ-provider-control-panel/images/occ1.png b/pages/network/ovhcloud_connect/occ-provider-control-panel/images/occ1.png deleted file mode 100644 index b446e3c9544..00000000000 Binary files a/pages/network/ovhcloud_connect/occ-provider-control-panel/images/occ1.png and /dev/null differ diff --git a/pages/network/ovhcloud_connect/occ-provider-control-panel/images/vrack1-1.png b/pages/network/ovhcloud_connect/occ-provider-control-panel/images/vrack1-1.png deleted file mode 100644 index ac0afbe4124..00000000000 Binary files a/pages/network/ovhcloud_connect/occ-provider-control-panel/images/vrack1-1.png and /dev/null differ diff --git a/pages/network/ovhcloud_connect/occ-provider-control-panel/images/vrack1.png b/pages/network/ovhcloud_connect/occ-provider-control-panel/images/vrack1.png deleted file mode 100644 index 67d7d693843..00000000000 Binary files a/pages/network/ovhcloud_connect/occ-provider-control-panel/images/vrack1.png and /dev/null differ diff --git a/pages/network/vrack_services/global/guide.de-de.md b/pages/network/vrack_services/global/guide.de-de.md index 044d5f48066..543d8456655 100644 --- a/pages/network/vrack_services/global/guide.de-de.md +++ b/pages/network/vrack_services/global/guide.de-de.md @@ -1,7 +1,7 @@ --- title: "vRack Services - Exposing a Managed Service on your vRack" excerpt: "Discover how to expose your managed service on the vRack using the vRack Services product and the Service Endpoint feature." -updated: 2024-12-19 +updated: 2025-10-21 --- ## Objective @@ -452,6 +452,10 @@ Output: ## Constraints and limitations +> [!primary] +> Please note that creating vRack Services, Subnets, or Service Endpoints on a production vRack **does not cause any service interruption**. +> + ### vRack Services - A vRack Services is attached to a single region. diff --git a/pages/network/vrack_services/global/guide.en-asia.md b/pages/network/vrack_services/global/guide.en-asia.md index 485ed160f9d..c5209c26a3e 100644 --- a/pages/network/vrack_services/global/guide.en-asia.md +++ b/pages/network/vrack_services/global/guide.en-asia.md @@ -1,7 +1,7 @@ --- title: "vRack Services - Exposing a Managed Service on your vRack" excerpt: "Discover how to expose your managed service on the vRack using the vRack Services product and the Service Endpoint feature." -updated: 2024-12-19 +updated: 2025-10-21 --- ## Objective @@ -452,6 +452,10 @@ Output: ## Constraints and limitations +> [!primary] +> Please note that creating vRack Services, Subnets, or Service Endpoints on a production vRack **does not cause any service interruption**. +> + ### vRack Services - A vRack Services is attached to a single region. diff --git a/pages/network/vrack_services/global/guide.en-au.md b/pages/network/vrack_services/global/guide.en-au.md index 485ed160f9d..c5209c26a3e 100644 --- a/pages/network/vrack_services/global/guide.en-au.md +++ b/pages/network/vrack_services/global/guide.en-au.md @@ -1,7 +1,7 @@ --- title: "vRack Services - Exposing a Managed Service on your vRack" excerpt: "Discover how to expose your managed service on the vRack using the vRack Services product and the Service Endpoint feature." -updated: 2024-12-19 +updated: 2025-10-21 --- ## Objective @@ -452,6 +452,10 @@ Output: ## Constraints and limitations +> [!primary] +> Please note that creating vRack Services, Subnets, or Service Endpoints on a production vRack **does not cause any service interruption**. +> + ### vRack Services - A vRack Services is attached to a single region. diff --git a/pages/network/vrack_services/global/guide.en-ca.md b/pages/network/vrack_services/global/guide.en-ca.md index 485ed160f9d..c5209c26a3e 100644 --- a/pages/network/vrack_services/global/guide.en-ca.md +++ b/pages/network/vrack_services/global/guide.en-ca.md @@ -1,7 +1,7 @@ --- title: "vRack Services - Exposing a Managed Service on your vRack" excerpt: "Discover how to expose your managed service on the vRack using the vRack Services product and the Service Endpoint feature." -updated: 2024-12-19 +updated: 2025-10-21 --- ## Objective @@ -452,6 +452,10 @@ Output: ## Constraints and limitations +> [!primary] +> Please note that creating vRack Services, Subnets, or Service Endpoints on a production vRack **does not cause any service interruption**. +> + ### vRack Services - A vRack Services is attached to a single region. diff --git a/pages/network/vrack_services/global/guide.en-gb.md b/pages/network/vrack_services/global/guide.en-gb.md index 044d5f48066..543d8456655 100644 --- a/pages/network/vrack_services/global/guide.en-gb.md +++ b/pages/network/vrack_services/global/guide.en-gb.md @@ -1,7 +1,7 @@ --- title: "vRack Services - Exposing a Managed Service on your vRack" excerpt: "Discover how to expose your managed service on the vRack using the vRack Services product and the Service Endpoint feature." -updated: 2024-12-19 +updated: 2025-10-21 --- ## Objective @@ -452,6 +452,10 @@ Output: ## Constraints and limitations +> [!primary] +> Please note that creating vRack Services, Subnets, or Service Endpoints on a production vRack **does not cause any service interruption**. +> + ### vRack Services - A vRack Services is attached to a single region. diff --git a/pages/network/vrack_services/global/guide.en-ie.md b/pages/network/vrack_services/global/guide.en-ie.md index 044d5f48066..543d8456655 100644 --- a/pages/network/vrack_services/global/guide.en-ie.md +++ b/pages/network/vrack_services/global/guide.en-ie.md @@ -1,7 +1,7 @@ --- title: "vRack Services - Exposing a Managed Service on your vRack" excerpt: "Discover how to expose your managed service on the vRack using the vRack Services product and the Service Endpoint feature." -updated: 2024-12-19 +updated: 2025-10-21 --- ## Objective @@ -452,6 +452,10 @@ Output: ## Constraints and limitations +> [!primary] +> Please note that creating vRack Services, Subnets, or Service Endpoints on a production vRack **does not cause any service interruption**. +> + ### vRack Services - A vRack Services is attached to a single region. diff --git a/pages/network/vrack_services/global/guide.en-sg.md b/pages/network/vrack_services/global/guide.en-sg.md index 485ed160f9d..c5209c26a3e 100644 --- a/pages/network/vrack_services/global/guide.en-sg.md +++ b/pages/network/vrack_services/global/guide.en-sg.md @@ -1,7 +1,7 @@ --- title: "vRack Services - Exposing a Managed Service on your vRack" excerpt: "Discover how to expose your managed service on the vRack using the vRack Services product and the Service Endpoint feature." -updated: 2024-12-19 +updated: 2025-10-21 --- ## Objective @@ -452,6 +452,10 @@ Output: ## Constraints and limitations +> [!primary] +> Please note that creating vRack Services, Subnets, or Service Endpoints on a production vRack **does not cause any service interruption**. +> + ### vRack Services - A vRack Services is attached to a single region. diff --git a/pages/network/vrack_services/global/guide.en-us.md b/pages/network/vrack_services/global/guide.en-us.md index 485ed160f9d..c5209c26a3e 100644 --- a/pages/network/vrack_services/global/guide.en-us.md +++ b/pages/network/vrack_services/global/guide.en-us.md @@ -1,7 +1,7 @@ --- title: "vRack Services - Exposing a Managed Service on your vRack" excerpt: "Discover how to expose your managed service on the vRack using the vRack Services product and the Service Endpoint feature." -updated: 2024-12-19 +updated: 2025-10-21 --- ## Objective @@ -452,6 +452,10 @@ Output: ## Constraints and limitations +> [!primary] +> Please note that creating vRack Services, Subnets, or Service Endpoints on a production vRack **does not cause any service interruption**. +> + ### vRack Services - A vRack Services is attached to a single region. diff --git a/pages/network/vrack_services/global/guide.es-es.md b/pages/network/vrack_services/global/guide.es-es.md index 044d5f48066..543d8456655 100644 --- a/pages/network/vrack_services/global/guide.es-es.md +++ b/pages/network/vrack_services/global/guide.es-es.md @@ -1,7 +1,7 @@ --- title: "vRack Services - Exposing a Managed Service on your vRack" excerpt: "Discover how to expose your managed service on the vRack using the vRack Services product and the Service Endpoint feature." -updated: 2024-12-19 +updated: 2025-10-21 --- ## Objective @@ -452,6 +452,10 @@ Output: ## Constraints and limitations +> [!primary] +> Please note that creating vRack Services, Subnets, or Service Endpoints on a production vRack **does not cause any service interruption**. +> + ### vRack Services - A vRack Services is attached to a single region. diff --git a/pages/network/vrack_services/global/guide.es-us.md b/pages/network/vrack_services/global/guide.es-us.md index 485ed160f9d..c5209c26a3e 100644 --- a/pages/network/vrack_services/global/guide.es-us.md +++ b/pages/network/vrack_services/global/guide.es-us.md @@ -1,7 +1,7 @@ --- title: "vRack Services - Exposing a Managed Service on your vRack" excerpt: "Discover how to expose your managed service on the vRack using the vRack Services product and the Service Endpoint feature." -updated: 2024-12-19 +updated: 2025-10-21 --- ## Objective @@ -452,6 +452,10 @@ Output: ## Constraints and limitations +> [!primary] +> Please note that creating vRack Services, Subnets, or Service Endpoints on a production vRack **does not cause any service interruption**. +> + ### vRack Services - A vRack Services is attached to a single region. diff --git a/pages/network/vrack_services/global/guide.fr-ca.md b/pages/network/vrack_services/global/guide.fr-ca.md index cf0d648312a..23f5b7704a3 100644 --- a/pages/network/vrack_services/global/guide.fr-ca.md +++ b/pages/network/vrack_services/global/guide.fr-ca.md @@ -1,7 +1,7 @@ --- title: "vRack Services - Exposer un service managé sur votre vRack" excerpt: "Découvrez comment exposer votre service managé sur le vRack avec le produit vRack Services et la fonctionnalité Service Endpoint" -updated: 2024-12-19 +updated: 2025-10-21 --- ## Objectif @@ -452,6 +452,10 @@ Retour de l'appel API : ## Contraintes et limites +> [!primary] +> Veuillez noter que la création de vRack Services, de sous-réseaux ou de Service Endpoints sur un vRack en production **n'entraîne aucune interruption de service**. +> + ### vRack Services - Un vRack Services est attaché à une seule région. diff --git a/pages/network/vrack_services/global/guide.fr-fr.md b/pages/network/vrack_services/global/guide.fr-fr.md index 81c7afcaeb2..f68a212b42a 100644 --- a/pages/network/vrack_services/global/guide.fr-fr.md +++ b/pages/network/vrack_services/global/guide.fr-fr.md @@ -1,7 +1,7 @@ --- title: "vRack Services - Exposer un service managé sur votre vRack" excerpt: "Découvrez comment exposer votre service managé sur le vRack avec le produit vRack Services et la fonctionnalité Service Endpoint" -updated: 2024-12-19 +updated: 2025-10-21 --- ## Objectif @@ -452,6 +452,10 @@ Retour de l'appel API : ## Contraintes et limites +> [!primary] +> Veuillez noter que la création de vRack Services, de sous-réseaux ou de Service Endpoints sur un vRack en production **n'entraîne aucune interruption de service**. +> + ### vRack Services - Un vRack Services est attaché à une seule région. diff --git a/pages/network/vrack_services/global/guide.it-it.md b/pages/network/vrack_services/global/guide.it-it.md index 044d5f48066..543d8456655 100644 --- a/pages/network/vrack_services/global/guide.it-it.md +++ b/pages/network/vrack_services/global/guide.it-it.md @@ -1,7 +1,7 @@ --- title: "vRack Services - Exposing a Managed Service on your vRack" excerpt: "Discover how to expose your managed service on the vRack using the vRack Services product and the Service Endpoint feature." -updated: 2024-12-19 +updated: 2025-10-21 --- ## Objective @@ -452,6 +452,10 @@ Output: ## Constraints and limitations +> [!primary] +> Please note that creating vRack Services, Subnets, or Service Endpoints on a production vRack **does not cause any service interruption**. +> + ### vRack Services - A vRack Services is attached to a single region. diff --git a/pages/network/vrack_services/global/guide.pl-pl.md b/pages/network/vrack_services/global/guide.pl-pl.md index 044d5f48066..543d8456655 100644 --- a/pages/network/vrack_services/global/guide.pl-pl.md +++ b/pages/network/vrack_services/global/guide.pl-pl.md @@ -1,7 +1,7 @@ --- title: "vRack Services - Exposing a Managed Service on your vRack" excerpt: "Discover how to expose your managed service on the vRack using the vRack Services product and the Service Endpoint feature." -updated: 2024-12-19 +updated: 2025-10-21 --- ## Objective @@ -452,6 +452,10 @@ Output: ## Constraints and limitations +> [!primary] +> Please note that creating vRack Services, Subnets, or Service Endpoints on a production vRack **does not cause any service interruption**. +> + ### vRack Services - A vRack Services is attached to a single region. diff --git a/pages/network/vrack_services/global/guide.pt-pt.md b/pages/network/vrack_services/global/guide.pt-pt.md index 044d5f48066..543d8456655 100644 --- a/pages/network/vrack_services/global/guide.pt-pt.md +++ b/pages/network/vrack_services/global/guide.pt-pt.md @@ -1,7 +1,7 @@ --- title: "vRack Services - Exposing a Managed Service on your vRack" excerpt: "Discover how to expose your managed service on the vRack using the vRack Services product and the Service Endpoint feature." -updated: 2024-12-19 +updated: 2025-10-21 --- ## Objective @@ -452,6 +452,10 @@ Output: ## Constraints and limitations +> [!primary] +> Please note that creating vRack Services, Subnets, or Service Endpoints on a production vRack **does not cause any service interruption**. +> + ### vRack Services - A vRack Services is attached to a single region. diff --git a/pages/network/vrack_services/global/images/17-VRS.png b/pages/network/vrack_services/global/images/17-VRS.png deleted file mode 100644 index 960e8b648bf..00000000000 Binary files a/pages/network/vrack_services/global/images/17-VRS.png and /dev/null differ diff --git a/pages/ovhcloud_labs/power_web_hosting/python-install-django/images/django01.png b/pages/ovhcloud_labs/power_web_hosting/python-install-django/images/django01.png deleted file mode 100644 index a071b59edd4..00000000000 Binary files a/pages/ovhcloud_labs/power_web_hosting/python-install-django/images/django01.png and /dev/null differ diff --git a/pages/ovhcloud_labs/power_web_hosting/python-install-django/images/django02.png b/pages/ovhcloud_labs/power_web_hosting/python-install-django/images/django02.png deleted file mode 100644 index 49ef4a09181..00000000000 Binary files a/pages/ovhcloud_labs/power_web_hosting/python-install-django/images/django02.png and /dev/null differ diff --git a/pages/ovhcloud_labs/power_web_hosting/python-install-django/images/django03.png b/pages/ovhcloud_labs/power_web_hosting/python-install-django/images/django03.png deleted file mode 100644 index e61a1ce28b3..00000000000 Binary files a/pages/ovhcloud_labs/power_web_hosting/python-install-django/images/django03.png and /dev/null differ diff --git a/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.de-de.md b/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.de-de.md index 68200dd88aa..5b780bf9f2c 100644 --- a/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.de-de.md +++ b/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.de-de.md @@ -1,12 +1,12 @@ --- title: CLI - Launch an AI notebook excerpt: Learn how to run an AI Notebook using the CLI -updated: 2024-09-12 +updated: 2025-11-17 --- ## Objective -This guide covers the submission of new [** AI Notebooks**](/pages/public_cloud/ai_machine_learning/notebook_guide_introduction_definition) through the **ovhai** CLI. +This guide covers the submission of new [**AI Notebooks**](/pages/public_cloud/ai_machine_learning/notebook_guide_introduction_definition) through the **ovhai** CLI. ## Requirements @@ -269,7 +269,7 @@ Now that the notebook is in the `RUNNING` state, a https address is defined in t You can now start writing code in your notebook. Since we used the PyTorch framework in our example, we will be able to use it without having to install anything ourselves. -As you explore your notebook, you will find an `ai-training-examples` folder already included in your workspace. This repository is automatically cloned for each notebook and includes a variety of examples that you can use with OVHcloud AI products, such as AI Notebooks. +As you explore your notebook, you will find an `ai-training-examples` folder already included in your [/workspace](/pages/public_cloud/ai_machine_learning/notebook_guide_workspace). This repository is automatically cloned for each notebook and includes a variety of examples that you can use with OVHcloud AI products, such as AI Notebooks. ### Stopping a notebook @@ -327,4 +327,4 @@ If you need training or technical assistance to implement our solutions, contact Please send us your questions, feedback and suggestions to improve the service: -- On the OVHcloud [Discord server](https://discord.gg/ovhcloud) +- On the OVHcloud [Discord server](https://discord.gg/ovhcloud) \ No newline at end of file diff --git a/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.en-asia.md b/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.en-asia.md index 68200dd88aa..5b780bf9f2c 100644 --- a/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.en-asia.md +++ b/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.en-asia.md @@ -1,12 +1,12 @@ --- title: CLI - Launch an AI notebook excerpt: Learn how to run an AI Notebook using the CLI -updated: 2024-09-12 +updated: 2025-11-17 --- ## Objective -This guide covers the submission of new [** AI Notebooks**](/pages/public_cloud/ai_machine_learning/notebook_guide_introduction_definition) through the **ovhai** CLI. +This guide covers the submission of new [**AI Notebooks**](/pages/public_cloud/ai_machine_learning/notebook_guide_introduction_definition) through the **ovhai** CLI. ## Requirements @@ -269,7 +269,7 @@ Now that the notebook is in the `RUNNING` state, a https address is defined in t You can now start writing code in your notebook. Since we used the PyTorch framework in our example, we will be able to use it without having to install anything ourselves. -As you explore your notebook, you will find an `ai-training-examples` folder already included in your workspace. This repository is automatically cloned for each notebook and includes a variety of examples that you can use with OVHcloud AI products, such as AI Notebooks. +As you explore your notebook, you will find an `ai-training-examples` folder already included in your [/workspace](/pages/public_cloud/ai_machine_learning/notebook_guide_workspace). This repository is automatically cloned for each notebook and includes a variety of examples that you can use with OVHcloud AI products, such as AI Notebooks. ### Stopping a notebook @@ -327,4 +327,4 @@ If you need training or technical assistance to implement our solutions, contact Please send us your questions, feedback and suggestions to improve the service: -- On the OVHcloud [Discord server](https://discord.gg/ovhcloud) +- On the OVHcloud [Discord server](https://discord.gg/ovhcloud) \ No newline at end of file diff --git a/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.en-au.md b/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.en-au.md index 68200dd88aa..5b780bf9f2c 100644 --- a/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.en-au.md +++ b/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.en-au.md @@ -1,12 +1,12 @@ --- title: CLI - Launch an AI notebook excerpt: Learn how to run an AI Notebook using the CLI -updated: 2024-09-12 +updated: 2025-11-17 --- ## Objective -This guide covers the submission of new [** AI Notebooks**](/pages/public_cloud/ai_machine_learning/notebook_guide_introduction_definition) through the **ovhai** CLI. +This guide covers the submission of new [**AI Notebooks**](/pages/public_cloud/ai_machine_learning/notebook_guide_introduction_definition) through the **ovhai** CLI. ## Requirements @@ -269,7 +269,7 @@ Now that the notebook is in the `RUNNING` state, a https address is defined in t You can now start writing code in your notebook. Since we used the PyTorch framework in our example, we will be able to use it without having to install anything ourselves. -As you explore your notebook, you will find an `ai-training-examples` folder already included in your workspace. This repository is automatically cloned for each notebook and includes a variety of examples that you can use with OVHcloud AI products, such as AI Notebooks. +As you explore your notebook, you will find an `ai-training-examples` folder already included in your [/workspace](/pages/public_cloud/ai_machine_learning/notebook_guide_workspace). This repository is automatically cloned for each notebook and includes a variety of examples that you can use with OVHcloud AI products, such as AI Notebooks. ### Stopping a notebook @@ -327,4 +327,4 @@ If you need training or technical assistance to implement our solutions, contact Please send us your questions, feedback and suggestions to improve the service: -- On the OVHcloud [Discord server](https://discord.gg/ovhcloud) +- On the OVHcloud [Discord server](https://discord.gg/ovhcloud) \ No newline at end of file diff --git a/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.en-ca.md b/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.en-ca.md index 68200dd88aa..5b780bf9f2c 100644 --- a/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.en-ca.md +++ b/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.en-ca.md @@ -1,12 +1,12 @@ --- title: CLI - Launch an AI notebook excerpt: Learn how to run an AI Notebook using the CLI -updated: 2024-09-12 +updated: 2025-11-17 --- ## Objective -This guide covers the submission of new [** AI Notebooks**](/pages/public_cloud/ai_machine_learning/notebook_guide_introduction_definition) through the **ovhai** CLI. +This guide covers the submission of new [**AI Notebooks**](/pages/public_cloud/ai_machine_learning/notebook_guide_introduction_definition) through the **ovhai** CLI. ## Requirements @@ -269,7 +269,7 @@ Now that the notebook is in the `RUNNING` state, a https address is defined in t You can now start writing code in your notebook. Since we used the PyTorch framework in our example, we will be able to use it without having to install anything ourselves. -As you explore your notebook, you will find an `ai-training-examples` folder already included in your workspace. This repository is automatically cloned for each notebook and includes a variety of examples that you can use with OVHcloud AI products, such as AI Notebooks. +As you explore your notebook, you will find an `ai-training-examples` folder already included in your [/workspace](/pages/public_cloud/ai_machine_learning/notebook_guide_workspace). This repository is automatically cloned for each notebook and includes a variety of examples that you can use with OVHcloud AI products, such as AI Notebooks. ### Stopping a notebook @@ -327,4 +327,4 @@ If you need training or technical assistance to implement our solutions, contact Please send us your questions, feedback and suggestions to improve the service: -- On the OVHcloud [Discord server](https://discord.gg/ovhcloud) +- On the OVHcloud [Discord server](https://discord.gg/ovhcloud) \ No newline at end of file diff --git a/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.en-gb.md b/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.en-gb.md index 68200dd88aa..d22fa312341 100644 --- a/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.en-gb.md +++ b/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.en-gb.md @@ -1,12 +1,12 @@ --- title: CLI - Launch an AI notebook excerpt: Learn how to run an AI Notebook using the CLI -updated: 2024-09-12 +updated: 2025-11-17 --- ## Objective -This guide covers the submission of new [** AI Notebooks**](/pages/public_cloud/ai_machine_learning/notebook_guide_introduction_definition) through the **ovhai** CLI. +This guide covers the submission of new [**AI Notebooks**](/pages/public_cloud/ai_machine_learning/notebook_guide_introduction_definition) through the **ovhai** CLI. ## Requirements @@ -269,7 +269,7 @@ Now that the notebook is in the `RUNNING` state, a https address is defined in t You can now start writing code in your notebook. Since we used the PyTorch framework in our example, we will be able to use it without having to install anything ourselves. -As you explore your notebook, you will find an `ai-training-examples` folder already included in your workspace. This repository is automatically cloned for each notebook and includes a variety of examples that you can use with OVHcloud AI products, such as AI Notebooks. +As you explore your notebook, you will find an `ai-training-examples` folder already included in your [/workspace](/pages/public_cloud/ai_machine_learning/notebook_guide_workspace). This repository is automatically cloned for each notebook and includes a variety of examples that you can use with OVHcloud AI products, such as AI Notebooks. ### Stopping a notebook diff --git a/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.en-ie.md b/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.en-ie.md index 68200dd88aa..5b780bf9f2c 100644 --- a/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.en-ie.md +++ b/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.en-ie.md @@ -1,12 +1,12 @@ --- title: CLI - Launch an AI notebook excerpt: Learn how to run an AI Notebook using the CLI -updated: 2024-09-12 +updated: 2025-11-17 --- ## Objective -This guide covers the submission of new [** AI Notebooks**](/pages/public_cloud/ai_machine_learning/notebook_guide_introduction_definition) through the **ovhai** CLI. +This guide covers the submission of new [**AI Notebooks**](/pages/public_cloud/ai_machine_learning/notebook_guide_introduction_definition) through the **ovhai** CLI. ## Requirements @@ -269,7 +269,7 @@ Now that the notebook is in the `RUNNING` state, a https address is defined in t You can now start writing code in your notebook. Since we used the PyTorch framework in our example, we will be able to use it without having to install anything ourselves. -As you explore your notebook, you will find an `ai-training-examples` folder already included in your workspace. This repository is automatically cloned for each notebook and includes a variety of examples that you can use with OVHcloud AI products, such as AI Notebooks. +As you explore your notebook, you will find an `ai-training-examples` folder already included in your [/workspace](/pages/public_cloud/ai_machine_learning/notebook_guide_workspace). This repository is automatically cloned for each notebook and includes a variety of examples that you can use with OVHcloud AI products, such as AI Notebooks. ### Stopping a notebook @@ -327,4 +327,4 @@ If you need training or technical assistance to implement our solutions, contact Please send us your questions, feedback and suggestions to improve the service: -- On the OVHcloud [Discord server](https://discord.gg/ovhcloud) +- On the OVHcloud [Discord server](https://discord.gg/ovhcloud) \ No newline at end of file diff --git a/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.en-sg.md b/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.en-sg.md index 68200dd88aa..5b780bf9f2c 100644 --- a/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.en-sg.md +++ b/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.en-sg.md @@ -1,12 +1,12 @@ --- title: CLI - Launch an AI notebook excerpt: Learn how to run an AI Notebook using the CLI -updated: 2024-09-12 +updated: 2025-11-17 --- ## Objective -This guide covers the submission of new [** AI Notebooks**](/pages/public_cloud/ai_machine_learning/notebook_guide_introduction_definition) through the **ovhai** CLI. +This guide covers the submission of new [**AI Notebooks**](/pages/public_cloud/ai_machine_learning/notebook_guide_introduction_definition) through the **ovhai** CLI. ## Requirements @@ -269,7 +269,7 @@ Now that the notebook is in the `RUNNING` state, a https address is defined in t You can now start writing code in your notebook. Since we used the PyTorch framework in our example, we will be able to use it without having to install anything ourselves. -As you explore your notebook, you will find an `ai-training-examples` folder already included in your workspace. This repository is automatically cloned for each notebook and includes a variety of examples that you can use with OVHcloud AI products, such as AI Notebooks. +As you explore your notebook, you will find an `ai-training-examples` folder already included in your [/workspace](/pages/public_cloud/ai_machine_learning/notebook_guide_workspace). This repository is automatically cloned for each notebook and includes a variety of examples that you can use with OVHcloud AI products, such as AI Notebooks. ### Stopping a notebook @@ -327,4 +327,4 @@ If you need training or technical assistance to implement our solutions, contact Please send us your questions, feedback and suggestions to improve the service: -- On the OVHcloud [Discord server](https://discord.gg/ovhcloud) +- On the OVHcloud [Discord server](https://discord.gg/ovhcloud) \ No newline at end of file diff --git a/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.en-us.md b/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.en-us.md index 68200dd88aa..5b780bf9f2c 100644 --- a/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.en-us.md +++ b/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.en-us.md @@ -1,12 +1,12 @@ --- title: CLI - Launch an AI notebook excerpt: Learn how to run an AI Notebook using the CLI -updated: 2024-09-12 +updated: 2025-11-17 --- ## Objective -This guide covers the submission of new [** AI Notebooks**](/pages/public_cloud/ai_machine_learning/notebook_guide_introduction_definition) through the **ovhai** CLI. +This guide covers the submission of new [**AI Notebooks**](/pages/public_cloud/ai_machine_learning/notebook_guide_introduction_definition) through the **ovhai** CLI. ## Requirements @@ -269,7 +269,7 @@ Now that the notebook is in the `RUNNING` state, a https address is defined in t You can now start writing code in your notebook. Since we used the PyTorch framework in our example, we will be able to use it without having to install anything ourselves. -As you explore your notebook, you will find an `ai-training-examples` folder already included in your workspace. This repository is automatically cloned for each notebook and includes a variety of examples that you can use with OVHcloud AI products, such as AI Notebooks. +As you explore your notebook, you will find an `ai-training-examples` folder already included in your [/workspace](/pages/public_cloud/ai_machine_learning/notebook_guide_workspace). This repository is automatically cloned for each notebook and includes a variety of examples that you can use with OVHcloud AI products, such as AI Notebooks. ### Stopping a notebook @@ -327,4 +327,4 @@ If you need training or technical assistance to implement our solutions, contact Please send us your questions, feedback and suggestions to improve the service: -- On the OVHcloud [Discord server](https://discord.gg/ovhcloud) +- On the OVHcloud [Discord server](https://discord.gg/ovhcloud) \ No newline at end of file diff --git a/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.es-es.md b/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.es-es.md index 68200dd88aa..5b780bf9f2c 100644 --- a/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.es-es.md +++ b/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.es-es.md @@ -1,12 +1,12 @@ --- title: CLI - Launch an AI notebook excerpt: Learn how to run an AI Notebook using the CLI -updated: 2024-09-12 +updated: 2025-11-17 --- ## Objective -This guide covers the submission of new [** AI Notebooks**](/pages/public_cloud/ai_machine_learning/notebook_guide_introduction_definition) through the **ovhai** CLI. +This guide covers the submission of new [**AI Notebooks**](/pages/public_cloud/ai_machine_learning/notebook_guide_introduction_definition) through the **ovhai** CLI. ## Requirements @@ -269,7 +269,7 @@ Now that the notebook is in the `RUNNING` state, a https address is defined in t You can now start writing code in your notebook. Since we used the PyTorch framework in our example, we will be able to use it without having to install anything ourselves. -As you explore your notebook, you will find an `ai-training-examples` folder already included in your workspace. This repository is automatically cloned for each notebook and includes a variety of examples that you can use with OVHcloud AI products, such as AI Notebooks. +As you explore your notebook, you will find an `ai-training-examples` folder already included in your [/workspace](/pages/public_cloud/ai_machine_learning/notebook_guide_workspace). This repository is automatically cloned for each notebook and includes a variety of examples that you can use with OVHcloud AI products, such as AI Notebooks. ### Stopping a notebook @@ -327,4 +327,4 @@ If you need training or technical assistance to implement our solutions, contact Please send us your questions, feedback and suggestions to improve the service: -- On the OVHcloud [Discord server](https://discord.gg/ovhcloud) +- On the OVHcloud [Discord server](https://discord.gg/ovhcloud) \ No newline at end of file diff --git a/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.es-us.md b/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.es-us.md index 68200dd88aa..5b780bf9f2c 100644 --- a/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.es-us.md +++ b/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.es-us.md @@ -1,12 +1,12 @@ --- title: CLI - Launch an AI notebook excerpt: Learn how to run an AI Notebook using the CLI -updated: 2024-09-12 +updated: 2025-11-17 --- ## Objective -This guide covers the submission of new [** AI Notebooks**](/pages/public_cloud/ai_machine_learning/notebook_guide_introduction_definition) through the **ovhai** CLI. +This guide covers the submission of new [**AI Notebooks**](/pages/public_cloud/ai_machine_learning/notebook_guide_introduction_definition) through the **ovhai** CLI. ## Requirements @@ -269,7 +269,7 @@ Now that the notebook is in the `RUNNING` state, a https address is defined in t You can now start writing code in your notebook. Since we used the PyTorch framework in our example, we will be able to use it without having to install anything ourselves. -As you explore your notebook, you will find an `ai-training-examples` folder already included in your workspace. This repository is automatically cloned for each notebook and includes a variety of examples that you can use with OVHcloud AI products, such as AI Notebooks. +As you explore your notebook, you will find an `ai-training-examples` folder already included in your [/workspace](/pages/public_cloud/ai_machine_learning/notebook_guide_workspace). This repository is automatically cloned for each notebook and includes a variety of examples that you can use with OVHcloud AI products, such as AI Notebooks. ### Stopping a notebook @@ -327,4 +327,4 @@ If you need training or technical assistance to implement our solutions, contact Please send us your questions, feedback and suggestions to improve the service: -- On the OVHcloud [Discord server](https://discord.gg/ovhcloud) +- On the OVHcloud [Discord server](https://discord.gg/ovhcloud) \ No newline at end of file diff --git a/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.fr-ca.md b/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.fr-ca.md index d44b7f308d8..1375f513ca1 100644 --- a/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.fr-ca.md +++ b/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.fr-ca.md @@ -1,12 +1,12 @@ --- title: CLI - Lancer un AI Notebook (EN) excerpt: Découvrez comment lancer un AI Notebooks avec la CLI -updated: 2024-09-12 +updated: 2025-11-17 --- ## Objective -This guide covers the submission of new [** AI Notebooks**](/pages/public_cloud/ai_machine_learning/notebook_guide_introduction_definition) through the **ovhai** CLI. +This guide covers the submission of new [**AI Notebooks**](/pages/public_cloud/ai_machine_learning/notebook_guide_introduction_definition) through the **ovhai** CLI. ## Requirements @@ -269,7 +269,7 @@ Now that the notebook is in the `RUNNING` state, a https address is defined in t You can now start writing code in your notebook. Since we used the PyTorch framework in our example, we will be able to use it without having to install anything ourselves. -As you explore your notebook, you will find an `ai-training-examples` folder already included in your workspace. This repository is automatically cloned for each notebook and includes a variety of examples that you can use with OVHcloud AI products, such as AI Notebooks. +As you explore your notebook, you will find an `ai-training-examples` folder already included in your [/workspace](/pages/public_cloud/ai_machine_learning/notebook_guide_workspace). This repository is automatically cloned for each notebook and includes a variety of examples that you can use with OVHcloud AI products, such as AI Notebooks. ### Stopping a notebook @@ -327,4 +327,4 @@ If you need training or technical assistance to implement our solutions, contact Please send us your questions, feedback and suggestions to improve the service: -- On the OVHcloud [Discord server](https://discord.gg/ovhcloud) +- On the OVHcloud [Discord server](https://discord.gg/ovhcloud) \ No newline at end of file diff --git a/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.fr-fr.md b/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.fr-fr.md index d44b7f308d8..1375f513ca1 100644 --- a/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.fr-fr.md +++ b/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.fr-fr.md @@ -1,12 +1,12 @@ --- title: CLI - Lancer un AI Notebook (EN) excerpt: Découvrez comment lancer un AI Notebooks avec la CLI -updated: 2024-09-12 +updated: 2025-11-17 --- ## Objective -This guide covers the submission of new [** AI Notebooks**](/pages/public_cloud/ai_machine_learning/notebook_guide_introduction_definition) through the **ovhai** CLI. +This guide covers the submission of new [**AI Notebooks**](/pages/public_cloud/ai_machine_learning/notebook_guide_introduction_definition) through the **ovhai** CLI. ## Requirements @@ -269,7 +269,7 @@ Now that the notebook is in the `RUNNING` state, a https address is defined in t You can now start writing code in your notebook. Since we used the PyTorch framework in our example, we will be able to use it without having to install anything ourselves. -As you explore your notebook, you will find an `ai-training-examples` folder already included in your workspace. This repository is automatically cloned for each notebook and includes a variety of examples that you can use with OVHcloud AI products, such as AI Notebooks. +As you explore your notebook, you will find an `ai-training-examples` folder already included in your [/workspace](/pages/public_cloud/ai_machine_learning/notebook_guide_workspace). This repository is automatically cloned for each notebook and includes a variety of examples that you can use with OVHcloud AI products, such as AI Notebooks. ### Stopping a notebook @@ -327,4 +327,4 @@ If you need training or technical assistance to implement our solutions, contact Please send us your questions, feedback and suggestions to improve the service: -- On the OVHcloud [Discord server](https://discord.gg/ovhcloud) +- On the OVHcloud [Discord server](https://discord.gg/ovhcloud) \ No newline at end of file diff --git a/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.it-it.md b/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.it-it.md index 68200dd88aa..5b780bf9f2c 100644 --- a/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.it-it.md +++ b/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.it-it.md @@ -1,12 +1,12 @@ --- title: CLI - Launch an AI notebook excerpt: Learn how to run an AI Notebook using the CLI -updated: 2024-09-12 +updated: 2025-11-17 --- ## Objective -This guide covers the submission of new [** AI Notebooks**](/pages/public_cloud/ai_machine_learning/notebook_guide_introduction_definition) through the **ovhai** CLI. +This guide covers the submission of new [**AI Notebooks**](/pages/public_cloud/ai_machine_learning/notebook_guide_introduction_definition) through the **ovhai** CLI. ## Requirements @@ -269,7 +269,7 @@ Now that the notebook is in the `RUNNING` state, a https address is defined in t You can now start writing code in your notebook. Since we used the PyTorch framework in our example, we will be able to use it without having to install anything ourselves. -As you explore your notebook, you will find an `ai-training-examples` folder already included in your workspace. This repository is automatically cloned for each notebook and includes a variety of examples that you can use with OVHcloud AI products, such as AI Notebooks. +As you explore your notebook, you will find an `ai-training-examples` folder already included in your [/workspace](/pages/public_cloud/ai_machine_learning/notebook_guide_workspace). This repository is automatically cloned for each notebook and includes a variety of examples that you can use with OVHcloud AI products, such as AI Notebooks. ### Stopping a notebook @@ -327,4 +327,4 @@ If you need training or technical assistance to implement our solutions, contact Please send us your questions, feedback and suggestions to improve the service: -- On the OVHcloud [Discord server](https://discord.gg/ovhcloud) +- On the OVHcloud [Discord server](https://discord.gg/ovhcloud) \ No newline at end of file diff --git a/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.pl-pl.md b/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.pl-pl.md index 68200dd88aa..5b780bf9f2c 100644 --- a/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.pl-pl.md +++ b/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.pl-pl.md @@ -1,12 +1,12 @@ --- title: CLI - Launch an AI notebook excerpt: Learn how to run an AI Notebook using the CLI -updated: 2024-09-12 +updated: 2025-11-17 --- ## Objective -This guide covers the submission of new [** AI Notebooks**](/pages/public_cloud/ai_machine_learning/notebook_guide_introduction_definition) through the **ovhai** CLI. +This guide covers the submission of new [**AI Notebooks**](/pages/public_cloud/ai_machine_learning/notebook_guide_introduction_definition) through the **ovhai** CLI. ## Requirements @@ -269,7 +269,7 @@ Now that the notebook is in the `RUNNING` state, a https address is defined in t You can now start writing code in your notebook. Since we used the PyTorch framework in our example, we will be able to use it without having to install anything ourselves. -As you explore your notebook, you will find an `ai-training-examples` folder already included in your workspace. This repository is automatically cloned for each notebook and includes a variety of examples that you can use with OVHcloud AI products, such as AI Notebooks. +As you explore your notebook, you will find an `ai-training-examples` folder already included in your [/workspace](/pages/public_cloud/ai_machine_learning/notebook_guide_workspace). This repository is automatically cloned for each notebook and includes a variety of examples that you can use with OVHcloud AI products, such as AI Notebooks. ### Stopping a notebook @@ -327,4 +327,4 @@ If you need training or technical assistance to implement our solutions, contact Please send us your questions, feedback and suggestions to improve the service: -- On the OVHcloud [Discord server](https://discord.gg/ovhcloud) +- On the OVHcloud [Discord server](https://discord.gg/ovhcloud) \ No newline at end of file diff --git a/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.pt-pt.md b/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.pt-pt.md index 68200dd88aa..5b780bf9f2c 100644 --- a/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.pt-pt.md +++ b/pages/public_cloud/ai_machine_learning/cli_11_howto_run_notebook_cli/guide.pt-pt.md @@ -1,12 +1,12 @@ --- title: CLI - Launch an AI notebook excerpt: Learn how to run an AI Notebook using the CLI -updated: 2024-09-12 +updated: 2025-11-17 --- ## Objective -This guide covers the submission of new [** AI Notebooks**](/pages/public_cloud/ai_machine_learning/notebook_guide_introduction_definition) through the **ovhai** CLI. +This guide covers the submission of new [**AI Notebooks**](/pages/public_cloud/ai_machine_learning/notebook_guide_introduction_definition) through the **ovhai** CLI. ## Requirements @@ -269,7 +269,7 @@ Now that the notebook is in the `RUNNING` state, a https address is defined in t You can now start writing code in your notebook. Since we used the PyTorch framework in our example, we will be able to use it without having to install anything ourselves. -As you explore your notebook, you will find an `ai-training-examples` folder already included in your workspace. This repository is automatically cloned for each notebook and includes a variety of examples that you can use with OVHcloud AI products, such as AI Notebooks. +As you explore your notebook, you will find an `ai-training-examples` folder already included in your [/workspace](/pages/public_cloud/ai_machine_learning/notebook_guide_workspace). This repository is automatically cloned for each notebook and includes a variety of examples that you can use with OVHcloud AI products, such as AI Notebooks. ### Stopping a notebook @@ -327,4 +327,4 @@ If you need training or technical assistance to implement our solutions, contact Please send us your questions, feedback and suggestions to improve the service: -- On the OVHcloud [Discord server](https://discord.gg/ovhcloud) +- On the OVHcloud [Discord server](https://discord.gg/ovhcloud) \ No newline at end of file diff --git a/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.de-de.md b/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.de-de.md index c31d72e50e8..ef768fa7532 100644 --- a/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.de-de.md +++ b/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.de-de.md @@ -1,7 +1,7 @@ --- title: CLI - Manage access tokens excerpt: Learn how to create Application tokens with the ovhai CLI -updated: 2023-05-11 +updated: 2025-11-06 --- ## Objective @@ -21,11 +21,13 @@ If you need any help while creating a new token, run `ovhai token create --help` ``` {.console} Usage: ovhai token create [OPTIONS] --role +Create an application token + Arguments: Token's name Options: - -r, --role Operator role gives all access, read role only allow to access job's APIs [possible values: read, operator] + -r, --role Operator role gives all access, read role only allow to access job's APIs. DEPRECATED VALUES: "read", "operator" => replaced by "ai_training_read", "ai_training_operator" [possible values: read, operator, ai_training_read, ai_training_operator, quantum_operator, quantum_reader] --token Authentication using Token rather than OAuth -l, --label-selector Only jobs with this label's name and value will be accessible using this token -o, --output Command output format [possible values: json, yaml, description] diff --git a/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.en-asia.md b/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.en-asia.md index c31d72e50e8..ef768fa7532 100644 --- a/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.en-asia.md +++ b/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.en-asia.md @@ -1,7 +1,7 @@ --- title: CLI - Manage access tokens excerpt: Learn how to create Application tokens with the ovhai CLI -updated: 2023-05-11 +updated: 2025-11-06 --- ## Objective @@ -21,11 +21,13 @@ If you need any help while creating a new token, run `ovhai token create --help` ``` {.console} Usage: ovhai token create [OPTIONS] --role +Create an application token + Arguments: Token's name Options: - -r, --role Operator role gives all access, read role only allow to access job's APIs [possible values: read, operator] + -r, --role Operator role gives all access, read role only allow to access job's APIs. DEPRECATED VALUES: "read", "operator" => replaced by "ai_training_read", "ai_training_operator" [possible values: read, operator, ai_training_read, ai_training_operator, quantum_operator, quantum_reader] --token Authentication using Token rather than OAuth -l, --label-selector Only jobs with this label's name and value will be accessible using this token -o, --output Command output format [possible values: json, yaml, description] diff --git a/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.en-au.md b/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.en-au.md index c31d72e50e8..ef768fa7532 100644 --- a/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.en-au.md +++ b/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.en-au.md @@ -1,7 +1,7 @@ --- title: CLI - Manage access tokens excerpt: Learn how to create Application tokens with the ovhai CLI -updated: 2023-05-11 +updated: 2025-11-06 --- ## Objective @@ -21,11 +21,13 @@ If you need any help while creating a new token, run `ovhai token create --help` ``` {.console} Usage: ovhai token create [OPTIONS] --role +Create an application token + Arguments: Token's name Options: - -r, --role Operator role gives all access, read role only allow to access job's APIs [possible values: read, operator] + -r, --role Operator role gives all access, read role only allow to access job's APIs. DEPRECATED VALUES: "read", "operator" => replaced by "ai_training_read", "ai_training_operator" [possible values: read, operator, ai_training_read, ai_training_operator, quantum_operator, quantum_reader] --token Authentication using Token rather than OAuth -l, --label-selector Only jobs with this label's name and value will be accessible using this token -o, --output Command output format [possible values: json, yaml, description] diff --git a/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.en-ca.md b/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.en-ca.md index c31d72e50e8..ef768fa7532 100644 --- a/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.en-ca.md +++ b/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.en-ca.md @@ -1,7 +1,7 @@ --- title: CLI - Manage access tokens excerpt: Learn how to create Application tokens with the ovhai CLI -updated: 2023-05-11 +updated: 2025-11-06 --- ## Objective @@ -21,11 +21,13 @@ If you need any help while creating a new token, run `ovhai token create --help` ``` {.console} Usage: ovhai token create [OPTIONS] --role +Create an application token + Arguments: Token's name Options: - -r, --role Operator role gives all access, read role only allow to access job's APIs [possible values: read, operator] + -r, --role Operator role gives all access, read role only allow to access job's APIs. DEPRECATED VALUES: "read", "operator" => replaced by "ai_training_read", "ai_training_operator" [possible values: read, operator, ai_training_read, ai_training_operator, quantum_operator, quantum_reader] --token Authentication using Token rather than OAuth -l, --label-selector Only jobs with this label's name and value will be accessible using this token -o, --output Command output format [possible values: json, yaml, description] diff --git a/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.en-gb.md b/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.en-gb.md index c31d72e50e8..ef768fa7532 100644 --- a/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.en-gb.md +++ b/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.en-gb.md @@ -1,7 +1,7 @@ --- title: CLI - Manage access tokens excerpt: Learn how to create Application tokens with the ovhai CLI -updated: 2023-05-11 +updated: 2025-11-06 --- ## Objective @@ -21,11 +21,13 @@ If you need any help while creating a new token, run `ovhai token create --help` ``` {.console} Usage: ovhai token create [OPTIONS] --role +Create an application token + Arguments: Token's name Options: - -r, --role Operator role gives all access, read role only allow to access job's APIs [possible values: read, operator] + -r, --role Operator role gives all access, read role only allow to access job's APIs. DEPRECATED VALUES: "read", "operator" => replaced by "ai_training_read", "ai_training_operator" [possible values: read, operator, ai_training_read, ai_training_operator, quantum_operator, quantum_reader] --token Authentication using Token rather than OAuth -l, --label-selector Only jobs with this label's name and value will be accessible using this token -o, --output Command output format [possible values: json, yaml, description] diff --git a/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.en-ie.md b/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.en-ie.md index c31d72e50e8..ef768fa7532 100644 --- a/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.en-ie.md +++ b/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.en-ie.md @@ -1,7 +1,7 @@ --- title: CLI - Manage access tokens excerpt: Learn how to create Application tokens with the ovhai CLI -updated: 2023-05-11 +updated: 2025-11-06 --- ## Objective @@ -21,11 +21,13 @@ If you need any help while creating a new token, run `ovhai token create --help` ``` {.console} Usage: ovhai token create [OPTIONS] --role +Create an application token + Arguments: Token's name Options: - -r, --role Operator role gives all access, read role only allow to access job's APIs [possible values: read, operator] + -r, --role Operator role gives all access, read role only allow to access job's APIs. DEPRECATED VALUES: "read", "operator" => replaced by "ai_training_read", "ai_training_operator" [possible values: read, operator, ai_training_read, ai_training_operator, quantum_operator, quantum_reader] --token Authentication using Token rather than OAuth -l, --label-selector Only jobs with this label's name and value will be accessible using this token -o, --output Command output format [possible values: json, yaml, description] diff --git a/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.en-sg.md b/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.en-sg.md index c31d72e50e8..ef768fa7532 100644 --- a/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.en-sg.md +++ b/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.en-sg.md @@ -1,7 +1,7 @@ --- title: CLI - Manage access tokens excerpt: Learn how to create Application tokens with the ovhai CLI -updated: 2023-05-11 +updated: 2025-11-06 --- ## Objective @@ -21,11 +21,13 @@ If you need any help while creating a new token, run `ovhai token create --help` ``` {.console} Usage: ovhai token create [OPTIONS] --role +Create an application token + Arguments: Token's name Options: - -r, --role Operator role gives all access, read role only allow to access job's APIs [possible values: read, operator] + -r, --role Operator role gives all access, read role only allow to access job's APIs. DEPRECATED VALUES: "read", "operator" => replaced by "ai_training_read", "ai_training_operator" [possible values: read, operator, ai_training_read, ai_training_operator, quantum_operator, quantum_reader] --token Authentication using Token rather than OAuth -l, --label-selector Only jobs with this label's name and value will be accessible using this token -o, --output Command output format [possible values: json, yaml, description] diff --git a/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.en-us.md b/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.en-us.md index c31d72e50e8..ef768fa7532 100644 --- a/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.en-us.md +++ b/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.en-us.md @@ -1,7 +1,7 @@ --- title: CLI - Manage access tokens excerpt: Learn how to create Application tokens with the ovhai CLI -updated: 2023-05-11 +updated: 2025-11-06 --- ## Objective @@ -21,11 +21,13 @@ If you need any help while creating a new token, run `ovhai token create --help` ``` {.console} Usage: ovhai token create [OPTIONS] --role +Create an application token + Arguments: Token's name Options: - -r, --role Operator role gives all access, read role only allow to access job's APIs [possible values: read, operator] + -r, --role Operator role gives all access, read role only allow to access job's APIs. DEPRECATED VALUES: "read", "operator" => replaced by "ai_training_read", "ai_training_operator" [possible values: read, operator, ai_training_read, ai_training_operator, quantum_operator, quantum_reader] --token Authentication using Token rather than OAuth -l, --label-selector Only jobs with this label's name and value will be accessible using this token -o, --output Command output format [possible values: json, yaml, description] diff --git a/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.es-es.md b/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.es-es.md index c31d72e50e8..ef768fa7532 100644 --- a/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.es-es.md +++ b/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.es-es.md @@ -1,7 +1,7 @@ --- title: CLI - Manage access tokens excerpt: Learn how to create Application tokens with the ovhai CLI -updated: 2023-05-11 +updated: 2025-11-06 --- ## Objective @@ -21,11 +21,13 @@ If you need any help while creating a new token, run `ovhai token create --help` ``` {.console} Usage: ovhai token create [OPTIONS] --role +Create an application token + Arguments: Token's name Options: - -r, --role Operator role gives all access, read role only allow to access job's APIs [possible values: read, operator] + -r, --role Operator role gives all access, read role only allow to access job's APIs. DEPRECATED VALUES: "read", "operator" => replaced by "ai_training_read", "ai_training_operator" [possible values: read, operator, ai_training_read, ai_training_operator, quantum_operator, quantum_reader] --token Authentication using Token rather than OAuth -l, --label-selector Only jobs with this label's name and value will be accessible using this token -o, --output Command output format [possible values: json, yaml, description] diff --git a/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.es-us.md b/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.es-us.md index c31d72e50e8..ef768fa7532 100644 --- a/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.es-us.md +++ b/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.es-us.md @@ -1,7 +1,7 @@ --- title: CLI - Manage access tokens excerpt: Learn how to create Application tokens with the ovhai CLI -updated: 2023-05-11 +updated: 2025-11-06 --- ## Objective @@ -21,11 +21,13 @@ If you need any help while creating a new token, run `ovhai token create --help` ``` {.console} Usage: ovhai token create [OPTIONS] --role +Create an application token + Arguments: Token's name Options: - -r, --role Operator role gives all access, read role only allow to access job's APIs [possible values: read, operator] + -r, --role Operator role gives all access, read role only allow to access job's APIs. DEPRECATED VALUES: "read", "operator" => replaced by "ai_training_read", "ai_training_operator" [possible values: read, operator, ai_training_read, ai_training_operator, quantum_operator, quantum_reader] --token Authentication using Token rather than OAuth -l, --label-selector Only jobs with this label's name and value will be accessible using this token -o, --output Command output format [possible values: json, yaml, description] diff --git a/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.fr-ca.md b/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.fr-ca.md index baf93ebbdb4..a78a647d2c1 100644 --- a/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.fr-ca.md +++ b/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.fr-ca.md @@ -1,7 +1,7 @@ --- title: "CLI - Se servir des tokens d'accès (EN)" excerpt: "Découvrez comment créer des tokens d'accès avec la CLI ovhai" -updated: 2023-05-11 +updated: 2025-11-06 --- ## Objective @@ -21,11 +21,13 @@ If you need any help while creating a new token, run `ovhai token create --help` ``` {.console} Usage: ovhai token create [OPTIONS] --role +Create an application token + Arguments: Token's name Options: - -r, --role Operator role gives all access, read role only allow to access job's APIs [possible values: read, operator] + -r, --role Operator role gives all access, read role only allow to access job's APIs. DEPRECATED VALUES: "read", "operator" => replaced by "ai_training_read", "ai_training_operator" [possible values: read, operator, ai_training_read, ai_training_operator, quantum_operator, quantum_reader] --token Authentication using Token rather than OAuth -l, --label-selector Only jobs with this label's name and value will be accessible using this token -o, --output Command output format [possible values: json, yaml, description] diff --git a/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.fr-fr.md b/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.fr-fr.md index baf93ebbdb4..a78a647d2c1 100644 --- a/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.fr-fr.md +++ b/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.fr-fr.md @@ -1,7 +1,7 @@ --- title: "CLI - Se servir des tokens d'accès (EN)" excerpt: "Découvrez comment créer des tokens d'accès avec la CLI ovhai" -updated: 2023-05-11 +updated: 2025-11-06 --- ## Objective @@ -21,11 +21,13 @@ If you need any help while creating a new token, run `ovhai token create --help` ``` {.console} Usage: ovhai token create [OPTIONS] --role +Create an application token + Arguments: Token's name Options: - -r, --role Operator role gives all access, read role only allow to access job's APIs [possible values: read, operator] + -r, --role Operator role gives all access, read role only allow to access job's APIs. DEPRECATED VALUES: "read", "operator" => replaced by "ai_training_read", "ai_training_operator" [possible values: read, operator, ai_training_read, ai_training_operator, quantum_operator, quantum_reader] --token Authentication using Token rather than OAuth -l, --label-selector Only jobs with this label's name and value will be accessible using this token -o, --output Command output format [possible values: json, yaml, description] diff --git a/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.it-it.md b/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.it-it.md index c31d72e50e8..ef768fa7532 100644 --- a/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.it-it.md +++ b/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.it-it.md @@ -1,7 +1,7 @@ --- title: CLI - Manage access tokens excerpt: Learn how to create Application tokens with the ovhai CLI -updated: 2023-05-11 +updated: 2025-11-06 --- ## Objective @@ -21,11 +21,13 @@ If you need any help while creating a new token, run `ovhai token create --help` ``` {.console} Usage: ovhai token create [OPTIONS] --role +Create an application token + Arguments: Token's name Options: - -r, --role Operator role gives all access, read role only allow to access job's APIs [possible values: read, operator] + -r, --role Operator role gives all access, read role only allow to access job's APIs. DEPRECATED VALUES: "read", "operator" => replaced by "ai_training_read", "ai_training_operator" [possible values: read, operator, ai_training_read, ai_training_operator, quantum_operator, quantum_reader] --token Authentication using Token rather than OAuth -l, --label-selector Only jobs with this label's name and value will be accessible using this token -o, --output Command output format [possible values: json, yaml, description] diff --git a/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.pl-pl.md b/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.pl-pl.md index c31d72e50e8..ef768fa7532 100644 --- a/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.pl-pl.md +++ b/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.pl-pl.md @@ -1,7 +1,7 @@ --- title: CLI - Manage access tokens excerpt: Learn how to create Application tokens with the ovhai CLI -updated: 2023-05-11 +updated: 2025-11-06 --- ## Objective @@ -21,11 +21,13 @@ If you need any help while creating a new token, run `ovhai token create --help` ``` {.console} Usage: ovhai token create [OPTIONS] --role +Create an application token + Arguments: Token's name Options: - -r, --role Operator role gives all access, read role only allow to access job's APIs [possible values: read, operator] + -r, --role Operator role gives all access, read role only allow to access job's APIs. DEPRECATED VALUES: "read", "operator" => replaced by "ai_training_read", "ai_training_operator" [possible values: read, operator, ai_training_read, ai_training_operator, quantum_operator, quantum_reader] --token Authentication using Token rather than OAuth -l, --label-selector Only jobs with this label's name and value will be accessible using this token -o, --output Command output format [possible values: json, yaml, description] diff --git a/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.pt-pt.md b/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.pt-pt.md index c31d72e50e8..ef768fa7532 100644 --- a/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.pt-pt.md +++ b/pages/public_cloud/ai_machine_learning/cli_13_howto_app_token_cli/guide.pt-pt.md @@ -1,7 +1,7 @@ --- title: CLI - Manage access tokens excerpt: Learn how to create Application tokens with the ovhai CLI -updated: 2023-05-11 +updated: 2025-11-06 --- ## Objective @@ -21,11 +21,13 @@ If you need any help while creating a new token, run `ovhai token create --help` ``` {.console} Usage: ovhai token create [OPTIONS] --role +Create an application token + Arguments: Token's name Options: - -r, --role Operator role gives all access, read role only allow to access job's APIs [possible values: read, operator] + -r, --role Operator role gives all access, read role only allow to access job's APIs. DEPRECATED VALUES: "read", "operator" => replaced by "ai_training_read", "ai_training_operator" [possible values: read, operator, ai_training_read, ai_training_operator, quantum_operator, quantum_reader] --token Authentication using Token rather than OAuth -l, --label-selector Only jobs with this label's name and value will be accessible using this token -o, --output Command output format [possible values: json, yaml, description] diff --git a/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.de-de.md b/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.de-de.md index 6abd91a819f..5a6a39a473c 100644 --- a/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.de-de.md +++ b/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.de-de.md @@ -258,7 +258,7 @@ If you want to query this API with Python, this code sample with Python Request ```bash export AI_APP_TOKEN=token_value -`````` +``` ``` python import requests diff --git a/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.en-asia.md b/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.en-asia.md index 6abd91a819f..5a6a39a473c 100644 --- a/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.en-asia.md +++ b/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.en-asia.md @@ -258,7 +258,7 @@ If you want to query this API with Python, this code sample with Python Request ```bash export AI_APP_TOKEN=token_value -`````` +``` ``` python import requests diff --git a/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.en-au.md b/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.en-au.md index 6abd91a819f..5a6a39a473c 100644 --- a/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.en-au.md +++ b/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.en-au.md @@ -258,7 +258,7 @@ If you want to query this API with Python, this code sample with Python Request ```bash export AI_APP_TOKEN=token_value -`````` +``` ``` python import requests diff --git a/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.en-ca.md b/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.en-ca.md index 6abd91a819f..5a6a39a473c 100644 --- a/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.en-ca.md +++ b/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.en-ca.md @@ -258,7 +258,7 @@ If you want to query this API with Python, this code sample with Python Request ```bash export AI_APP_TOKEN=token_value -`````` +``` ``` python import requests diff --git a/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.en-gb.md b/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.en-gb.md index 6abd91a819f..5a6a39a473c 100644 --- a/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.en-gb.md +++ b/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.en-gb.md @@ -258,7 +258,7 @@ If you want to query this API with Python, this code sample with Python Request ```bash export AI_APP_TOKEN=token_value -`````` +``` ``` python import requests diff --git a/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.en-ie.md b/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.en-ie.md index 6abd91a819f..5a6a39a473c 100644 --- a/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.en-ie.md +++ b/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.en-ie.md @@ -258,7 +258,7 @@ If you want to query this API with Python, this code sample with Python Request ```bash export AI_APP_TOKEN=token_value -`````` +``` ``` python import requests diff --git a/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.en-sg.md b/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.en-sg.md index 6abd91a819f..5a6a39a473c 100644 --- a/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.en-sg.md +++ b/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.en-sg.md @@ -258,7 +258,7 @@ If you want to query this API with Python, this code sample with Python Request ```bash export AI_APP_TOKEN=token_value -`````` +``` ``` python import requests diff --git a/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.en-us.md b/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.en-us.md index 6abd91a819f..5a6a39a473c 100644 --- a/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.en-us.md +++ b/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.en-us.md @@ -258,7 +258,7 @@ If you want to query this API with Python, this code sample with Python Request ```bash export AI_APP_TOKEN=token_value -`````` +``` ``` python import requests diff --git a/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.es-es.md b/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.es-es.md index 6abd91a819f..5a6a39a473c 100644 --- a/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.es-es.md +++ b/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.es-es.md @@ -258,7 +258,7 @@ If you want to query this API with Python, this code sample with Python Request ```bash export AI_APP_TOKEN=token_value -`````` +``` ``` python import requests diff --git a/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.es-us.md b/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.es-us.md index 6abd91a819f..5a6a39a473c 100644 --- a/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.es-us.md +++ b/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.es-us.md @@ -258,7 +258,7 @@ If you want to query this API with Python, this code sample with Python Request ```bash export AI_APP_TOKEN=token_value -`````` +``` ``` python import requests diff --git a/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.fr-ca.md b/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.fr-ca.md index 5c1ba9272f4..19bd3f03120 100644 --- a/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.fr-ca.md +++ b/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.fr-ca.md @@ -258,7 +258,7 @@ If you want to query this API with Python, this code sample with Python Request ```bash export AI_APP_TOKEN=token_value -`````` +``` ``` python import requests diff --git a/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.fr-fr.md b/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.fr-fr.md index 5c1ba9272f4..19bd3f03120 100644 --- a/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.fr-fr.md +++ b/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.fr-fr.md @@ -258,7 +258,7 @@ If you want to query this API with Python, this code sample with Python Request ```bash export AI_APP_TOKEN=token_value -`````` +``` ``` python import requests diff --git a/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.it-it.md b/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.it-it.md index 6abd91a819f..5a6a39a473c 100644 --- a/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.it-it.md +++ b/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.it-it.md @@ -258,7 +258,7 @@ If you want to query this API with Python, this code sample with Python Request ```bash export AI_APP_TOKEN=token_value -`````` +``` ``` python import requests diff --git a/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.pl-pl.md b/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.pl-pl.md index 6abd91a819f..5a6a39a473c 100644 --- a/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.pl-pl.md +++ b/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.pl-pl.md @@ -258,7 +258,7 @@ If you want to query this API with Python, this code sample with Python Request ```bash export AI_APP_TOKEN=token_value -`````` +``` ``` python import requests diff --git a/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.pt-pt.md b/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.pt-pt.md index 6abd91a819f..5a6a39a473c 100644 --- a/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.pt-pt.md +++ b/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/guide.pt-pt.md @@ -258,7 +258,7 @@ If you want to query this API with Python, this code sample with Python Request ```bash export AI_APP_TOKEN=token_value -`````` +``` ``` python import requests diff --git a/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/images/ai_app_stop.png b/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/images/ai_app_stop.png deleted file mode 100644 index f4d0923bf12..00000000000 Binary files a/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/images/ai_app_stop.png and /dev/null differ diff --git a/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/images/ai_app_token.png b/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/images/ai_app_token.png deleted file mode 100644 index 529b2782c1a..00000000000 Binary files a/pages/public_cloud/ai_machine_learning/deploy_guide_02_getting_started/images/ai_app_token.png and /dev/null differ diff --git a/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.de-de.md b/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.de-de.md index 0e9245d3044..632038e7195 100644 --- a/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.de-de.md +++ b/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.de-de.md @@ -1,78 +1,175 @@ --- title: AI Deploy - Scaling strategies -excerpt: Understand the scaling strategies (static scaling vs autoscaling) of AI Deploy -updated: 2023-04-04 +excerpt: Understand the scaling strategies (static scaling vs autoscaling) of AI Deploy and learn how to use them +updated: 2025-10-08 --- > [!primary] -> > AI Deploy is covered by **[OVHcloud Public Cloud Special Conditions](https://storage.gra.cloud.ovh.net/v1/AUTH_325716a587c64897acbef9a4a4726e38/contracts/d2a208c-Conditions_particulieres_OVH_Stack-WE-9.0.pdf)**. -> ## Objective -This guide covers the use of the different scaling strategies for AI Deploy. The objective is to explain the difference between **static scaling** and **autoscaling** so that you can choose the best solution depending on the use case and type of deployment. +This guide provides a comprehensive understanding of the different scaling strategies for AI Deploy. The objective is to explain the differences between **static scaling** and **autoscaling**, guide users on how to choose between them, set them during app creation, and explain how to modify scaling strategies once apps are created. ## Requirements -- a **Public Cloud** project -- access to the [OVHcloud Control Panel](/links/manager) -- start deploying an app and get to **Step 3**: `Resources` +- An active **Public Cloud** project. +- Access to the [OVHcloud Control Panel](/links/manager). +- The **OVHcloud AI CLI** (`ovhai`) installed. For installation instructions, see [how to install ovhai](/pages/public_cloud/ai_machine_learning/cli_10_howto_install_cli). ## Scaling principles -In the [OVHcloud Control Panel](/links/manager), it is possible to select the **resources** in `Step 3` of the app deployment. +When creating an application via the [OVHcloud Control Panel*** (UI) or the `ovhai` CLI, you can choose one of two scaling strategies: -This step allows you to choose between two scaling strategies: **static scaling** and **autoscaling**. +- **[Static Scaling](#static-scaling)**: Fixed number of running replicas. +- **[Autoscaling](#autoscaling)**: Dynamic replicas based on usage metrics (CPU/RAM or custom metrics). -### Static scaling +## Static Scaling -The **static scaling** strategy allows you to choose the number of replicas on which the app will be deployed. +### What is Static Scaling? + +Static scaling allows you to configure a **fixed number of replicas** (identical instances of your application) running at all times. This is the **default strategy** if not specified. The minimum number of replicas is **1** and the maximum is **10**. > [!warning] > -> It is recommended to deploy on a **minimum of 2 replicas** to have high availability! -> +> For **High Availability**, it is strongly recommended to deploy a **minimum of 2 replicas**. -**When to choose static scaling?** +### When to choose Static Scaling? -- Static scaling can be used if you want to have fixed costs. -- This scaling strategy is also useful when your consumption or inference load are fixed. +- You have **predictable, consistent workloads**. +- You prefer **fixed, predictable costs** with no unexpected resource usage spikes. +- Your use case requires **minimal latency**, as replicas are always active. -### Autoscaling +### Setting Static Scaling (UI and CLI) -With the autoscaling strategy, you can play on several parameters. +> [!tabs] +> **Using the Control Panel (UI)** +>> +>> When creating your application, you will have the opportunity to choose your **scaling strategy**. By default, the strategy is set to **static scaling**. To use this strategy, make sure that automatic scaling is not enabled. Then, you will be asked to choose the number of replicas on which your application will run. +>> +>> ![Set static scaling on AI Deploy via UI](images/set-static-scaling.png){.thumbnail} +>> +> **Using ovhai CLI** +>> +>> Use the `ovhai app run` command with the `--replicas` parameter to set the number of replicas at deployment: +>> +>> ```bash +>> ovhai app run /: \ +>> --replicas 2 \ +>> -- +>> ``` +>> -#### Minimum and maximum number of replicas +## Autoscaling -With the autoscaling strategy, it is possible to choose both the **minimum number of replicas** (1 by default) and the **maximum number of replicas**. +### What is Autoscaling? -#### Monitored metric +Autoscaling dynamically adjusts the number of application replicas based on **real-time metrics**, such as CPU or RAM usage. This is optimized for **workloads with varying demand**. -It is also possible to choose the metric to be monitored. This will act as a trigger for **autoscaling**. There are two metrics to choose from: `CPU` or `RAM`. +### Autoscaling Key Configuration Parameters -#### Trigger threshold +Using this strategy, it is possible to choose: -The threshold for the percentage of average use can also be chosen. It is an integer between 1 and 100%. - -The threshold of the average usage percentage will trigger the scaling (up or down) of the app replicas. +| Parameter | Description | +|----------------------------|-----------------------------------------------------------------------------------------------| +| **Minimum Replicas** | Lowest number of running replicas. | +| **Maximum Replicas** | Upper bound for replica count (define based on usage expectations). | +| **Monitored Metric** | The metric to be monitored. Choose between `CPU` or `RAM` for triggering autoscaling actions. | +| **Trigger Threshold (%)** | Average usage percentage used to trigger scaling up or down. Range: 1–100%. | > [!primary] > -> **High availability** will measure the average resource usage across its replicas and add instances if this average exceeds the specified average usage percentage threshold. -> -> Conversely, it will remove instances when this average resource utilisation falls below the threshold. +> Autoscaling adjusts by calculating the **average resource usage** across all replicas. If the average exceeds the threshold, new replicas are spun up; if it falls below, replicas are removed. > -**When to choose autoscaling?** +### When to Choose Autoscaling? + +- Your app has **irregular or fluctuating** inference/load patterns. +- You want to **scale cost-effectively** with actual usage. +- You are managing a **high-throughput application** with sudden demand spikes. + +### Setting Autoscaling (UI and CLI) + +> [!tabs] +> **Using the Control Panel (UI)** +>> +>> When creating your application, you will have the opportunity to choose your **scaling strategy**. By default, the strategy is set to **static scaling**. Toggle the button to switch to **Autoscaling** Then, configure minimum/maximum replicas, metric, and threshold. +>> +>> ![Set autoscaling on AI Deploy via UI](images/set-autoscaling.png){.thumbnail} +>> +> **Using ovhai CLI** +>> +>> Use the `ovhai app run` command with the following autoscaling parameters: +>> +>> ```bash +>> ovhai app run /: \ +>> --auto-min-replicas 1 \ +>> --auto-max-replicas 5 \ +>> --auto-resource-type CPU \ +>> --auto-resource-usage-threshold 75 +>> ``` +>> + +## Advanced: Custom Metrics for Autoscaling + +**Custom metrics are recommended for workloads such as GPU based inference where CPU and RAM usage provide an incomplete picture of the system’s performance or request load.** + +For advanced scenarios, you can define **custom metrics** to drive autoscaling decisions. This requires an API endpoint to fetch metrics from. + +### Required Parameter + +- `--auto-custom-api-url`: URL of the API operation to call to get the metric value. A specific `` placeholder can be given whenever metrics API is served by the deployed app itself. + +### Optional Parameters + +| Parameter | Description | +|--------------------------------|-----------------------------------------------------------------------------| +| `--auto-custom-value-location` | Specifies where the metric value is located in the API response payload. This value is format-specific. See the valueLocation from the parameters list in the [Trigger Specification documentation](https://keda.sh/docs/2.16/scalers/metrics-api/#trigger-specification) for details. | +| `--auto-custom-target-value` | Target value for metric to scale on. | +| `--auto-custom-metric-format` | Format of the metric to scale on (`JSON`, `XML`, `YAML`, `PROMETHEUS`). Default is `JSON`. | -- You can use autoscaling if you have irregular or sawtooth inference loads. +**Example**: + +Scaling based on a custom metric from an internal endpoint: + +```bash +ovhai app run /: \ + --auto-custom-api-url http://:6000/metrics \ + --auto-custom-value-location foo.bar \ + --auto-custom-target-value 42 \ + --auto-custom-metric-format JSON +``` + +## Modifying Scaling Strategies Post-Deployment + +You can also modify the scaling strategy after the app has been created using the `ovhai app scale` CLI command. This feature is not available on the UI. + +### Updating Static Scaling + +To change the number of replicas for a static scaling strategy, use the `ovhai app scale` command with the `--replicas` parameter: + +```bash +ovhai app scale --replicas +``` + +### Updating Autoscaling + +To change the autoscaling parameters, use the `ovhai app scale` command with the appropriate autoscaling parameters: + +```bash +ovhai app scale \ + --auto-min-replicas \ + --auto-max-replicas \ + --auto-resource-type \ + --auto-resource-usage-threshold \ + +``` ## Scaling example -We will use the following example: +We will use the following example: In case an app is based on the `AI1-1-CPU` flavor with a resource size of 2 (i.e. **2 CPUs**), this means that each replica of the application will be entitled to **2 vCores** and **8GiB RAM**. @@ -94,13 +191,11 @@ In this example, the app will be scaled up when the average RAM usage across all > [!primary] > -> The **total deployment price** will be calculated using the minimum number of replicas. -> +> The total deployment price for **autoscaling apps** is calculated based on the **minimum number of replicas**, **but** costs can **increase** during scaling. -> [!warning] -> -> The cost may increase as `Autoscaling` increases. -> +## Conclusion + +Choosing the right scaling strategy is critical for balancing cost, performance, and reliability in your AI Deploy applications. Static scaling offers stability and predictability, while autoscaling provides flexibility for dynamic workloads. ## Feedback diff --git a/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.en-asia.md b/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.en-asia.md index db40c1e89eb..632038e7195 100644 --- a/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.en-asia.md +++ b/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.en-asia.md @@ -1,74 +1,171 @@ --- title: AI Deploy - Scaling strategies -excerpt: Understand the scaling strategies (static scaling vs autoscaling) of AI Deploy -updated: 2023-04-04 +excerpt: Understand the scaling strategies (static scaling vs autoscaling) of AI Deploy and learn how to use them +updated: 2025-10-08 --- > [!primary] -> > AI Deploy is covered by **[OVHcloud Public Cloud Special Conditions](https://storage.gra.cloud.ovh.net/v1/AUTH_325716a587c64897acbef9a4a4726e38/contracts/d2a208c-Conditions_particulieres_OVH_Stack-WE-9.0.pdf)**. -> ## Objective -This guide covers the use of the different scaling strategies for AI Deploy. The objective is to explain the difference between **static scaling** and **autoscaling** so that you can choose the best solution depending on the use case and type of deployment. +This guide provides a comprehensive understanding of the different scaling strategies for AI Deploy. The objective is to explain the differences between **static scaling** and **autoscaling**, guide users on how to choose between them, set them during app creation, and explain how to modify scaling strategies once apps are created. ## Requirements -- a **Public Cloud** project -- access to the [OVHcloud Control Panel](/links/manager) -- start deploying an app and get to **Step 3**: `Resources` +- An active **Public Cloud** project. +- Access to the [OVHcloud Control Panel](/links/manager). +- The **OVHcloud AI CLI** (`ovhai`) installed. For installation instructions, see [how to install ovhai](/pages/public_cloud/ai_machine_learning/cli_10_howto_install_cli). ## Scaling principles -In the [OVHcloud Control Panel](/links/manager), it is possible to select the **resources** in `Step 3` of the app deployment. +When creating an application via the [OVHcloud Control Panel*** (UI) or the `ovhai` CLI, you can choose one of two scaling strategies: -This step allows you to choose between two scaling strategies: **static scaling** and **autoscaling**. +- **[Static Scaling](#static-scaling)**: Fixed number of running replicas. +- **[Autoscaling](#autoscaling)**: Dynamic replicas based on usage metrics (CPU/RAM or custom metrics). -### Static scaling +## Static Scaling -The **static scaling** strategy allows you to choose the number of replicas on which the app will be deployed. +### What is Static Scaling? + +Static scaling allows you to configure a **fixed number of replicas** (identical instances of your application) running at all times. This is the **default strategy** if not specified. The minimum number of replicas is **1** and the maximum is **10**. > [!warning] > -> It is recommended to deploy on a **minimum of 2 replicas** to have high availability! -> +> For **High Availability**, it is strongly recommended to deploy a **minimum of 2 replicas**. -**When to choose static scaling?** +### When to choose Static Scaling? -- Static scaling can be used if you want to have fixed costs. -- This scaling strategy is also useful when your consumption or inference load are fixed. +- You have **predictable, consistent workloads**. +- You prefer **fixed, predictable costs** with no unexpected resource usage spikes. +- Your use case requires **minimal latency**, as replicas are always active. -### Autoscaling +### Setting Static Scaling (UI and CLI) -With the autoscaling strategy, you can play on several parameters. +> [!tabs] +> **Using the Control Panel (UI)** +>> +>> When creating your application, you will have the opportunity to choose your **scaling strategy**. By default, the strategy is set to **static scaling**. To use this strategy, make sure that automatic scaling is not enabled. Then, you will be asked to choose the number of replicas on which your application will run. +>> +>> ![Set static scaling on AI Deploy via UI](images/set-static-scaling.png){.thumbnail} +>> +> **Using ovhai CLI** +>> +>> Use the `ovhai app run` command with the `--replicas` parameter to set the number of replicas at deployment: +>> +>> ```bash +>> ovhai app run /: \ +>> --replicas 2 \ +>> -- +>> ``` +>> -#### Minimum and maximum number of replicas +## Autoscaling -With the autoscaling strategy, it is possible to choose both the **minimum number of replicas** (1 by default) and the **maximum number of replicas**. +### What is Autoscaling? -#### Monitored metric +Autoscaling dynamically adjusts the number of application replicas based on **real-time metrics**, such as CPU or RAM usage. This is optimized for **workloads with varying demand**. -It is also possible to choose the metric to be monitored. This will act as a trigger for **autoscaling**. There are two metrics to choose from: `CPU` or `RAM`. +### Autoscaling Key Configuration Parameters -#### Trigger threshold +Using this strategy, it is possible to choose: -The threshold for the percentage of average use can also be chosen. It is an integer between 1 and 100%. - -The threshold of the average usage percentage will trigger the scaling (up or down) of the app replicas. +| Parameter | Description | +|----------------------------|-----------------------------------------------------------------------------------------------| +| **Minimum Replicas** | Lowest number of running replicas. | +| **Maximum Replicas** | Upper bound for replica count (define based on usage expectations). | +| **Monitored Metric** | The metric to be monitored. Choose between `CPU` or `RAM` for triggering autoscaling actions. | +| **Trigger Threshold (%)** | Average usage percentage used to trigger scaling up or down. Range: 1–100%. | > [!primary] > -> **High availability** will measure the average resource usage across its replicas and add instances if this average exceeds the specified average usage percentage threshold. -> -> Conversely, it will remove instances when this average resource utilisation falls below the threshold. +> Autoscaling adjusts by calculating the **average resource usage** across all replicas. If the average exceeds the threshold, new replicas are spun up; if it falls below, replicas are removed. > -**When to choose autoscaling?** +### When to Choose Autoscaling? + +- Your app has **irregular or fluctuating** inference/load patterns. +- You want to **scale cost-effectively** with actual usage. +- You are managing a **high-throughput application** with sudden demand spikes. + +### Setting Autoscaling (UI and CLI) + +> [!tabs] +> **Using the Control Panel (UI)** +>> +>> When creating your application, you will have the opportunity to choose your **scaling strategy**. By default, the strategy is set to **static scaling**. Toggle the button to switch to **Autoscaling** Then, configure minimum/maximum replicas, metric, and threshold. +>> +>> ![Set autoscaling on AI Deploy via UI](images/set-autoscaling.png){.thumbnail} +>> +> **Using ovhai CLI** +>> +>> Use the `ovhai app run` command with the following autoscaling parameters: +>> +>> ```bash +>> ovhai app run /: \ +>> --auto-min-replicas 1 \ +>> --auto-max-replicas 5 \ +>> --auto-resource-type CPU \ +>> --auto-resource-usage-threshold 75 +>> ``` +>> + +## Advanced: Custom Metrics for Autoscaling + +**Custom metrics are recommended for workloads such as GPU based inference where CPU and RAM usage provide an incomplete picture of the system’s performance or request load.** + +For advanced scenarios, you can define **custom metrics** to drive autoscaling decisions. This requires an API endpoint to fetch metrics from. + +### Required Parameter + +- `--auto-custom-api-url`: URL of the API operation to call to get the metric value. A specific `` placeholder can be given whenever metrics API is served by the deployed app itself. + +### Optional Parameters + +| Parameter | Description | +|--------------------------------|-----------------------------------------------------------------------------| +| `--auto-custom-value-location` | Specifies where the metric value is located in the API response payload. This value is format-specific. See the valueLocation from the parameters list in the [Trigger Specification documentation](https://keda.sh/docs/2.16/scalers/metrics-api/#trigger-specification) for details. | +| `--auto-custom-target-value` | Target value for metric to scale on. | +| `--auto-custom-metric-format` | Format of the metric to scale on (`JSON`, `XML`, `YAML`, `PROMETHEUS`). Default is `JSON`. | -- You can use autoscaling if you have irregular or sawtooth inference loads. +**Example**: + +Scaling based on a custom metric from an internal endpoint: + +```bash +ovhai app run /: \ + --auto-custom-api-url http://:6000/metrics \ + --auto-custom-value-location foo.bar \ + --auto-custom-target-value 42 \ + --auto-custom-metric-format JSON +``` + +## Modifying Scaling Strategies Post-Deployment + +You can also modify the scaling strategy after the app has been created using the `ovhai app scale` CLI command. This feature is not available on the UI. + +### Updating Static Scaling + +To change the number of replicas for a static scaling strategy, use the `ovhai app scale` command with the `--replicas` parameter: + +```bash +ovhai app scale --replicas +``` + +### Updating Autoscaling + +To change the autoscaling parameters, use the `ovhai app scale` command with the appropriate autoscaling parameters: + +```bash +ovhai app scale \ + --auto-min-replicas \ + --auto-max-replicas \ + --auto-resource-type \ + --auto-resource-usage-threshold \ + +``` ## Scaling example @@ -94,13 +191,11 @@ In this example, the app will be scaled up when the average RAM usage across all > [!primary] > -> The **total deployment price** will be calculated using the minimum number of replicas. -> +> The total deployment price for **autoscaling apps** is calculated based on the **minimum number of replicas**, **but** costs can **increase** during scaling. -> [!warning] -> -> The cost may increase as `Autoscaling` increases. -> +## Conclusion + +Choosing the right scaling strategy is critical for balancing cost, performance, and reliability in your AI Deploy applications. Static scaling offers stability and predictability, while autoscaling provides flexibility for dynamic workloads. ## Feedback diff --git a/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.en-au.md b/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.en-au.md index db40c1e89eb..632038e7195 100644 --- a/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.en-au.md +++ b/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.en-au.md @@ -1,74 +1,171 @@ --- title: AI Deploy - Scaling strategies -excerpt: Understand the scaling strategies (static scaling vs autoscaling) of AI Deploy -updated: 2023-04-04 +excerpt: Understand the scaling strategies (static scaling vs autoscaling) of AI Deploy and learn how to use them +updated: 2025-10-08 --- > [!primary] -> > AI Deploy is covered by **[OVHcloud Public Cloud Special Conditions](https://storage.gra.cloud.ovh.net/v1/AUTH_325716a587c64897acbef9a4a4726e38/contracts/d2a208c-Conditions_particulieres_OVH_Stack-WE-9.0.pdf)**. -> ## Objective -This guide covers the use of the different scaling strategies for AI Deploy. The objective is to explain the difference between **static scaling** and **autoscaling** so that you can choose the best solution depending on the use case and type of deployment. +This guide provides a comprehensive understanding of the different scaling strategies for AI Deploy. The objective is to explain the differences between **static scaling** and **autoscaling**, guide users on how to choose between them, set them during app creation, and explain how to modify scaling strategies once apps are created. ## Requirements -- a **Public Cloud** project -- access to the [OVHcloud Control Panel](/links/manager) -- start deploying an app and get to **Step 3**: `Resources` +- An active **Public Cloud** project. +- Access to the [OVHcloud Control Panel](/links/manager). +- The **OVHcloud AI CLI** (`ovhai`) installed. For installation instructions, see [how to install ovhai](/pages/public_cloud/ai_machine_learning/cli_10_howto_install_cli). ## Scaling principles -In the [OVHcloud Control Panel](/links/manager), it is possible to select the **resources** in `Step 3` of the app deployment. +When creating an application via the [OVHcloud Control Panel*** (UI) or the `ovhai` CLI, you can choose one of two scaling strategies: -This step allows you to choose between two scaling strategies: **static scaling** and **autoscaling**. +- **[Static Scaling](#static-scaling)**: Fixed number of running replicas. +- **[Autoscaling](#autoscaling)**: Dynamic replicas based on usage metrics (CPU/RAM or custom metrics). -### Static scaling +## Static Scaling -The **static scaling** strategy allows you to choose the number of replicas on which the app will be deployed. +### What is Static Scaling? + +Static scaling allows you to configure a **fixed number of replicas** (identical instances of your application) running at all times. This is the **default strategy** if not specified. The minimum number of replicas is **1** and the maximum is **10**. > [!warning] > -> It is recommended to deploy on a **minimum of 2 replicas** to have high availability! -> +> For **High Availability**, it is strongly recommended to deploy a **minimum of 2 replicas**. -**When to choose static scaling?** +### When to choose Static Scaling? -- Static scaling can be used if you want to have fixed costs. -- This scaling strategy is also useful when your consumption or inference load are fixed. +- You have **predictable, consistent workloads**. +- You prefer **fixed, predictable costs** with no unexpected resource usage spikes. +- Your use case requires **minimal latency**, as replicas are always active. -### Autoscaling +### Setting Static Scaling (UI and CLI) -With the autoscaling strategy, you can play on several parameters. +> [!tabs] +> **Using the Control Panel (UI)** +>> +>> When creating your application, you will have the opportunity to choose your **scaling strategy**. By default, the strategy is set to **static scaling**. To use this strategy, make sure that automatic scaling is not enabled. Then, you will be asked to choose the number of replicas on which your application will run. +>> +>> ![Set static scaling on AI Deploy via UI](images/set-static-scaling.png){.thumbnail} +>> +> **Using ovhai CLI** +>> +>> Use the `ovhai app run` command with the `--replicas` parameter to set the number of replicas at deployment: +>> +>> ```bash +>> ovhai app run /: \ +>> --replicas 2 \ +>> -- +>> ``` +>> -#### Minimum and maximum number of replicas +## Autoscaling -With the autoscaling strategy, it is possible to choose both the **minimum number of replicas** (1 by default) and the **maximum number of replicas**. +### What is Autoscaling? -#### Monitored metric +Autoscaling dynamically adjusts the number of application replicas based on **real-time metrics**, such as CPU or RAM usage. This is optimized for **workloads with varying demand**. -It is also possible to choose the metric to be monitored. This will act as a trigger for **autoscaling**. There are two metrics to choose from: `CPU` or `RAM`. +### Autoscaling Key Configuration Parameters -#### Trigger threshold +Using this strategy, it is possible to choose: -The threshold for the percentage of average use can also be chosen. It is an integer between 1 and 100%. - -The threshold of the average usage percentage will trigger the scaling (up or down) of the app replicas. +| Parameter | Description | +|----------------------------|-----------------------------------------------------------------------------------------------| +| **Minimum Replicas** | Lowest number of running replicas. | +| **Maximum Replicas** | Upper bound for replica count (define based on usage expectations). | +| **Monitored Metric** | The metric to be monitored. Choose between `CPU` or `RAM` for triggering autoscaling actions. | +| **Trigger Threshold (%)** | Average usage percentage used to trigger scaling up or down. Range: 1–100%. | > [!primary] > -> **High availability** will measure the average resource usage across its replicas and add instances if this average exceeds the specified average usage percentage threshold. -> -> Conversely, it will remove instances when this average resource utilisation falls below the threshold. +> Autoscaling adjusts by calculating the **average resource usage** across all replicas. If the average exceeds the threshold, new replicas are spun up; if it falls below, replicas are removed. > -**When to choose autoscaling?** +### When to Choose Autoscaling? + +- Your app has **irregular or fluctuating** inference/load patterns. +- You want to **scale cost-effectively** with actual usage. +- You are managing a **high-throughput application** with sudden demand spikes. + +### Setting Autoscaling (UI and CLI) + +> [!tabs] +> **Using the Control Panel (UI)** +>> +>> When creating your application, you will have the opportunity to choose your **scaling strategy**. By default, the strategy is set to **static scaling**. Toggle the button to switch to **Autoscaling** Then, configure minimum/maximum replicas, metric, and threshold. +>> +>> ![Set autoscaling on AI Deploy via UI](images/set-autoscaling.png){.thumbnail} +>> +> **Using ovhai CLI** +>> +>> Use the `ovhai app run` command with the following autoscaling parameters: +>> +>> ```bash +>> ovhai app run /: \ +>> --auto-min-replicas 1 \ +>> --auto-max-replicas 5 \ +>> --auto-resource-type CPU \ +>> --auto-resource-usage-threshold 75 +>> ``` +>> + +## Advanced: Custom Metrics for Autoscaling + +**Custom metrics are recommended for workloads such as GPU based inference where CPU and RAM usage provide an incomplete picture of the system’s performance or request load.** + +For advanced scenarios, you can define **custom metrics** to drive autoscaling decisions. This requires an API endpoint to fetch metrics from. + +### Required Parameter + +- `--auto-custom-api-url`: URL of the API operation to call to get the metric value. A specific `` placeholder can be given whenever metrics API is served by the deployed app itself. + +### Optional Parameters + +| Parameter | Description | +|--------------------------------|-----------------------------------------------------------------------------| +| `--auto-custom-value-location` | Specifies where the metric value is located in the API response payload. This value is format-specific. See the valueLocation from the parameters list in the [Trigger Specification documentation](https://keda.sh/docs/2.16/scalers/metrics-api/#trigger-specification) for details. | +| `--auto-custom-target-value` | Target value for metric to scale on. | +| `--auto-custom-metric-format` | Format of the metric to scale on (`JSON`, `XML`, `YAML`, `PROMETHEUS`). Default is `JSON`. | -- You can use autoscaling if you have irregular or sawtooth inference loads. +**Example**: + +Scaling based on a custom metric from an internal endpoint: + +```bash +ovhai app run /: \ + --auto-custom-api-url http://:6000/metrics \ + --auto-custom-value-location foo.bar \ + --auto-custom-target-value 42 \ + --auto-custom-metric-format JSON +``` + +## Modifying Scaling Strategies Post-Deployment + +You can also modify the scaling strategy after the app has been created using the `ovhai app scale` CLI command. This feature is not available on the UI. + +### Updating Static Scaling + +To change the number of replicas for a static scaling strategy, use the `ovhai app scale` command with the `--replicas` parameter: + +```bash +ovhai app scale --replicas +``` + +### Updating Autoscaling + +To change the autoscaling parameters, use the `ovhai app scale` command with the appropriate autoscaling parameters: + +```bash +ovhai app scale \ + --auto-min-replicas \ + --auto-max-replicas \ + --auto-resource-type \ + --auto-resource-usage-threshold \ + +``` ## Scaling example @@ -94,13 +191,11 @@ In this example, the app will be scaled up when the average RAM usage across all > [!primary] > -> The **total deployment price** will be calculated using the minimum number of replicas. -> +> The total deployment price for **autoscaling apps** is calculated based on the **minimum number of replicas**, **but** costs can **increase** during scaling. -> [!warning] -> -> The cost may increase as `Autoscaling` increases. -> +## Conclusion + +Choosing the right scaling strategy is critical for balancing cost, performance, and reliability in your AI Deploy applications. Static scaling offers stability and predictability, while autoscaling provides flexibility for dynamic workloads. ## Feedback diff --git a/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.en-ca.md b/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.en-ca.md index db40c1e89eb..632038e7195 100644 --- a/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.en-ca.md +++ b/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.en-ca.md @@ -1,74 +1,171 @@ --- title: AI Deploy - Scaling strategies -excerpt: Understand the scaling strategies (static scaling vs autoscaling) of AI Deploy -updated: 2023-04-04 +excerpt: Understand the scaling strategies (static scaling vs autoscaling) of AI Deploy and learn how to use them +updated: 2025-10-08 --- > [!primary] -> > AI Deploy is covered by **[OVHcloud Public Cloud Special Conditions](https://storage.gra.cloud.ovh.net/v1/AUTH_325716a587c64897acbef9a4a4726e38/contracts/d2a208c-Conditions_particulieres_OVH_Stack-WE-9.0.pdf)**. -> ## Objective -This guide covers the use of the different scaling strategies for AI Deploy. The objective is to explain the difference between **static scaling** and **autoscaling** so that you can choose the best solution depending on the use case and type of deployment. +This guide provides a comprehensive understanding of the different scaling strategies for AI Deploy. The objective is to explain the differences between **static scaling** and **autoscaling**, guide users on how to choose between them, set them during app creation, and explain how to modify scaling strategies once apps are created. ## Requirements -- a **Public Cloud** project -- access to the [OVHcloud Control Panel](/links/manager) -- start deploying an app and get to **Step 3**: `Resources` +- An active **Public Cloud** project. +- Access to the [OVHcloud Control Panel](/links/manager). +- The **OVHcloud AI CLI** (`ovhai`) installed. For installation instructions, see [how to install ovhai](/pages/public_cloud/ai_machine_learning/cli_10_howto_install_cli). ## Scaling principles -In the [OVHcloud Control Panel](/links/manager), it is possible to select the **resources** in `Step 3` of the app deployment. +When creating an application via the [OVHcloud Control Panel*** (UI) or the `ovhai` CLI, you can choose one of two scaling strategies: -This step allows you to choose between two scaling strategies: **static scaling** and **autoscaling**. +- **[Static Scaling](#static-scaling)**: Fixed number of running replicas. +- **[Autoscaling](#autoscaling)**: Dynamic replicas based on usage metrics (CPU/RAM or custom metrics). -### Static scaling +## Static Scaling -The **static scaling** strategy allows you to choose the number of replicas on which the app will be deployed. +### What is Static Scaling? + +Static scaling allows you to configure a **fixed number of replicas** (identical instances of your application) running at all times. This is the **default strategy** if not specified. The minimum number of replicas is **1** and the maximum is **10**. > [!warning] > -> It is recommended to deploy on a **minimum of 2 replicas** to have high availability! -> +> For **High Availability**, it is strongly recommended to deploy a **minimum of 2 replicas**. -**When to choose static scaling?** +### When to choose Static Scaling? -- Static scaling can be used if you want to have fixed costs. -- This scaling strategy is also useful when your consumption or inference load are fixed. +- You have **predictable, consistent workloads**. +- You prefer **fixed, predictable costs** with no unexpected resource usage spikes. +- Your use case requires **minimal latency**, as replicas are always active. -### Autoscaling +### Setting Static Scaling (UI and CLI) -With the autoscaling strategy, you can play on several parameters. +> [!tabs] +> **Using the Control Panel (UI)** +>> +>> When creating your application, you will have the opportunity to choose your **scaling strategy**. By default, the strategy is set to **static scaling**. To use this strategy, make sure that automatic scaling is not enabled. Then, you will be asked to choose the number of replicas on which your application will run. +>> +>> ![Set static scaling on AI Deploy via UI](images/set-static-scaling.png){.thumbnail} +>> +> **Using ovhai CLI** +>> +>> Use the `ovhai app run` command with the `--replicas` parameter to set the number of replicas at deployment: +>> +>> ```bash +>> ovhai app run /: \ +>> --replicas 2 \ +>> -- +>> ``` +>> -#### Minimum and maximum number of replicas +## Autoscaling -With the autoscaling strategy, it is possible to choose both the **minimum number of replicas** (1 by default) and the **maximum number of replicas**. +### What is Autoscaling? -#### Monitored metric +Autoscaling dynamically adjusts the number of application replicas based on **real-time metrics**, such as CPU or RAM usage. This is optimized for **workloads with varying demand**. -It is also possible to choose the metric to be monitored. This will act as a trigger for **autoscaling**. There are two metrics to choose from: `CPU` or `RAM`. +### Autoscaling Key Configuration Parameters -#### Trigger threshold +Using this strategy, it is possible to choose: -The threshold for the percentage of average use can also be chosen. It is an integer between 1 and 100%. - -The threshold of the average usage percentage will trigger the scaling (up or down) of the app replicas. +| Parameter | Description | +|----------------------------|-----------------------------------------------------------------------------------------------| +| **Minimum Replicas** | Lowest number of running replicas. | +| **Maximum Replicas** | Upper bound for replica count (define based on usage expectations). | +| **Monitored Metric** | The metric to be monitored. Choose between `CPU` or `RAM` for triggering autoscaling actions. | +| **Trigger Threshold (%)** | Average usage percentage used to trigger scaling up or down. Range: 1–100%. | > [!primary] > -> **High availability** will measure the average resource usage across its replicas and add instances if this average exceeds the specified average usage percentage threshold. -> -> Conversely, it will remove instances when this average resource utilisation falls below the threshold. +> Autoscaling adjusts by calculating the **average resource usage** across all replicas. If the average exceeds the threshold, new replicas are spun up; if it falls below, replicas are removed. > -**When to choose autoscaling?** +### When to Choose Autoscaling? + +- Your app has **irregular or fluctuating** inference/load patterns. +- You want to **scale cost-effectively** with actual usage. +- You are managing a **high-throughput application** with sudden demand spikes. + +### Setting Autoscaling (UI and CLI) + +> [!tabs] +> **Using the Control Panel (UI)** +>> +>> When creating your application, you will have the opportunity to choose your **scaling strategy**. By default, the strategy is set to **static scaling**. Toggle the button to switch to **Autoscaling** Then, configure minimum/maximum replicas, metric, and threshold. +>> +>> ![Set autoscaling on AI Deploy via UI](images/set-autoscaling.png){.thumbnail} +>> +> **Using ovhai CLI** +>> +>> Use the `ovhai app run` command with the following autoscaling parameters: +>> +>> ```bash +>> ovhai app run /: \ +>> --auto-min-replicas 1 \ +>> --auto-max-replicas 5 \ +>> --auto-resource-type CPU \ +>> --auto-resource-usage-threshold 75 +>> ``` +>> + +## Advanced: Custom Metrics for Autoscaling + +**Custom metrics are recommended for workloads such as GPU based inference where CPU and RAM usage provide an incomplete picture of the system’s performance or request load.** + +For advanced scenarios, you can define **custom metrics** to drive autoscaling decisions. This requires an API endpoint to fetch metrics from. + +### Required Parameter + +- `--auto-custom-api-url`: URL of the API operation to call to get the metric value. A specific `` placeholder can be given whenever metrics API is served by the deployed app itself. + +### Optional Parameters + +| Parameter | Description | +|--------------------------------|-----------------------------------------------------------------------------| +| `--auto-custom-value-location` | Specifies where the metric value is located in the API response payload. This value is format-specific. See the valueLocation from the parameters list in the [Trigger Specification documentation](https://keda.sh/docs/2.16/scalers/metrics-api/#trigger-specification) for details. | +| `--auto-custom-target-value` | Target value for metric to scale on. | +| `--auto-custom-metric-format` | Format of the metric to scale on (`JSON`, `XML`, `YAML`, `PROMETHEUS`). Default is `JSON`. | -- You can use autoscaling if you have irregular or sawtooth inference loads. +**Example**: + +Scaling based on a custom metric from an internal endpoint: + +```bash +ovhai app run /: \ + --auto-custom-api-url http://:6000/metrics \ + --auto-custom-value-location foo.bar \ + --auto-custom-target-value 42 \ + --auto-custom-metric-format JSON +``` + +## Modifying Scaling Strategies Post-Deployment + +You can also modify the scaling strategy after the app has been created using the `ovhai app scale` CLI command. This feature is not available on the UI. + +### Updating Static Scaling + +To change the number of replicas for a static scaling strategy, use the `ovhai app scale` command with the `--replicas` parameter: + +```bash +ovhai app scale --replicas +``` + +### Updating Autoscaling + +To change the autoscaling parameters, use the `ovhai app scale` command with the appropriate autoscaling parameters: + +```bash +ovhai app scale \ + --auto-min-replicas \ + --auto-max-replicas \ + --auto-resource-type \ + --auto-resource-usage-threshold \ + +``` ## Scaling example @@ -94,13 +191,11 @@ In this example, the app will be scaled up when the average RAM usage across all > [!primary] > -> The **total deployment price** will be calculated using the minimum number of replicas. -> +> The total deployment price for **autoscaling apps** is calculated based on the **minimum number of replicas**, **but** costs can **increase** during scaling. -> [!warning] -> -> The cost may increase as `Autoscaling` increases. -> +## Conclusion + +Choosing the right scaling strategy is critical for balancing cost, performance, and reliability in your AI Deploy applications. Static scaling offers stability and predictability, while autoscaling provides flexibility for dynamic workloads. ## Feedback diff --git a/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.en-gb.md b/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.en-gb.md index 0e9245d3044..632038e7195 100644 --- a/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.en-gb.md +++ b/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.en-gb.md @@ -1,78 +1,175 @@ --- title: AI Deploy - Scaling strategies -excerpt: Understand the scaling strategies (static scaling vs autoscaling) of AI Deploy -updated: 2023-04-04 +excerpt: Understand the scaling strategies (static scaling vs autoscaling) of AI Deploy and learn how to use them +updated: 2025-10-08 --- > [!primary] -> > AI Deploy is covered by **[OVHcloud Public Cloud Special Conditions](https://storage.gra.cloud.ovh.net/v1/AUTH_325716a587c64897acbef9a4a4726e38/contracts/d2a208c-Conditions_particulieres_OVH_Stack-WE-9.0.pdf)**. -> ## Objective -This guide covers the use of the different scaling strategies for AI Deploy. The objective is to explain the difference between **static scaling** and **autoscaling** so that you can choose the best solution depending on the use case and type of deployment. +This guide provides a comprehensive understanding of the different scaling strategies for AI Deploy. The objective is to explain the differences between **static scaling** and **autoscaling**, guide users on how to choose between them, set them during app creation, and explain how to modify scaling strategies once apps are created. ## Requirements -- a **Public Cloud** project -- access to the [OVHcloud Control Panel](/links/manager) -- start deploying an app and get to **Step 3**: `Resources` +- An active **Public Cloud** project. +- Access to the [OVHcloud Control Panel](/links/manager). +- The **OVHcloud AI CLI** (`ovhai`) installed. For installation instructions, see [how to install ovhai](/pages/public_cloud/ai_machine_learning/cli_10_howto_install_cli). ## Scaling principles -In the [OVHcloud Control Panel](/links/manager), it is possible to select the **resources** in `Step 3` of the app deployment. +When creating an application via the [OVHcloud Control Panel*** (UI) or the `ovhai` CLI, you can choose one of two scaling strategies: -This step allows you to choose between two scaling strategies: **static scaling** and **autoscaling**. +- **[Static Scaling](#static-scaling)**: Fixed number of running replicas. +- **[Autoscaling](#autoscaling)**: Dynamic replicas based on usage metrics (CPU/RAM or custom metrics). -### Static scaling +## Static Scaling -The **static scaling** strategy allows you to choose the number of replicas on which the app will be deployed. +### What is Static Scaling? + +Static scaling allows you to configure a **fixed number of replicas** (identical instances of your application) running at all times. This is the **default strategy** if not specified. The minimum number of replicas is **1** and the maximum is **10**. > [!warning] > -> It is recommended to deploy on a **minimum of 2 replicas** to have high availability! -> +> For **High Availability**, it is strongly recommended to deploy a **minimum of 2 replicas**. -**When to choose static scaling?** +### When to choose Static Scaling? -- Static scaling can be used if you want to have fixed costs. -- This scaling strategy is also useful when your consumption or inference load are fixed. +- You have **predictable, consistent workloads**. +- You prefer **fixed, predictable costs** with no unexpected resource usage spikes. +- Your use case requires **minimal latency**, as replicas are always active. -### Autoscaling +### Setting Static Scaling (UI and CLI) -With the autoscaling strategy, you can play on several parameters. +> [!tabs] +> **Using the Control Panel (UI)** +>> +>> When creating your application, you will have the opportunity to choose your **scaling strategy**. By default, the strategy is set to **static scaling**. To use this strategy, make sure that automatic scaling is not enabled. Then, you will be asked to choose the number of replicas on which your application will run. +>> +>> ![Set static scaling on AI Deploy via UI](images/set-static-scaling.png){.thumbnail} +>> +> **Using ovhai CLI** +>> +>> Use the `ovhai app run` command with the `--replicas` parameter to set the number of replicas at deployment: +>> +>> ```bash +>> ovhai app run /: \ +>> --replicas 2 \ +>> -- +>> ``` +>> -#### Minimum and maximum number of replicas +## Autoscaling -With the autoscaling strategy, it is possible to choose both the **minimum number of replicas** (1 by default) and the **maximum number of replicas**. +### What is Autoscaling? -#### Monitored metric +Autoscaling dynamically adjusts the number of application replicas based on **real-time metrics**, such as CPU or RAM usage. This is optimized for **workloads with varying demand**. -It is also possible to choose the metric to be monitored. This will act as a trigger for **autoscaling**. There are two metrics to choose from: `CPU` or `RAM`. +### Autoscaling Key Configuration Parameters -#### Trigger threshold +Using this strategy, it is possible to choose: -The threshold for the percentage of average use can also be chosen. It is an integer between 1 and 100%. - -The threshold of the average usage percentage will trigger the scaling (up or down) of the app replicas. +| Parameter | Description | +|----------------------------|-----------------------------------------------------------------------------------------------| +| **Minimum Replicas** | Lowest number of running replicas. | +| **Maximum Replicas** | Upper bound for replica count (define based on usage expectations). | +| **Monitored Metric** | The metric to be monitored. Choose between `CPU` or `RAM` for triggering autoscaling actions. | +| **Trigger Threshold (%)** | Average usage percentage used to trigger scaling up or down. Range: 1–100%. | > [!primary] > -> **High availability** will measure the average resource usage across its replicas and add instances if this average exceeds the specified average usage percentage threshold. -> -> Conversely, it will remove instances when this average resource utilisation falls below the threshold. +> Autoscaling adjusts by calculating the **average resource usage** across all replicas. If the average exceeds the threshold, new replicas are spun up; if it falls below, replicas are removed. > -**When to choose autoscaling?** +### When to Choose Autoscaling? + +- Your app has **irregular or fluctuating** inference/load patterns. +- You want to **scale cost-effectively** with actual usage. +- You are managing a **high-throughput application** with sudden demand spikes. + +### Setting Autoscaling (UI and CLI) + +> [!tabs] +> **Using the Control Panel (UI)** +>> +>> When creating your application, you will have the opportunity to choose your **scaling strategy**. By default, the strategy is set to **static scaling**. Toggle the button to switch to **Autoscaling** Then, configure minimum/maximum replicas, metric, and threshold. +>> +>> ![Set autoscaling on AI Deploy via UI](images/set-autoscaling.png){.thumbnail} +>> +> **Using ovhai CLI** +>> +>> Use the `ovhai app run` command with the following autoscaling parameters: +>> +>> ```bash +>> ovhai app run /: \ +>> --auto-min-replicas 1 \ +>> --auto-max-replicas 5 \ +>> --auto-resource-type CPU \ +>> --auto-resource-usage-threshold 75 +>> ``` +>> + +## Advanced: Custom Metrics for Autoscaling + +**Custom metrics are recommended for workloads such as GPU based inference where CPU and RAM usage provide an incomplete picture of the system’s performance or request load.** + +For advanced scenarios, you can define **custom metrics** to drive autoscaling decisions. This requires an API endpoint to fetch metrics from. + +### Required Parameter + +- `--auto-custom-api-url`: URL of the API operation to call to get the metric value. A specific `` placeholder can be given whenever metrics API is served by the deployed app itself. + +### Optional Parameters + +| Parameter | Description | +|--------------------------------|-----------------------------------------------------------------------------| +| `--auto-custom-value-location` | Specifies where the metric value is located in the API response payload. This value is format-specific. See the valueLocation from the parameters list in the [Trigger Specification documentation](https://keda.sh/docs/2.16/scalers/metrics-api/#trigger-specification) for details. | +| `--auto-custom-target-value` | Target value for metric to scale on. | +| `--auto-custom-metric-format` | Format of the metric to scale on (`JSON`, `XML`, `YAML`, `PROMETHEUS`). Default is `JSON`. | -- You can use autoscaling if you have irregular or sawtooth inference loads. +**Example**: + +Scaling based on a custom metric from an internal endpoint: + +```bash +ovhai app run /: \ + --auto-custom-api-url http://:6000/metrics \ + --auto-custom-value-location foo.bar \ + --auto-custom-target-value 42 \ + --auto-custom-metric-format JSON +``` + +## Modifying Scaling Strategies Post-Deployment + +You can also modify the scaling strategy after the app has been created using the `ovhai app scale` CLI command. This feature is not available on the UI. + +### Updating Static Scaling + +To change the number of replicas for a static scaling strategy, use the `ovhai app scale` command with the `--replicas` parameter: + +```bash +ovhai app scale --replicas +``` + +### Updating Autoscaling + +To change the autoscaling parameters, use the `ovhai app scale` command with the appropriate autoscaling parameters: + +```bash +ovhai app scale \ + --auto-min-replicas \ + --auto-max-replicas \ + --auto-resource-type \ + --auto-resource-usage-threshold \ + +``` ## Scaling example -We will use the following example: +We will use the following example: In case an app is based on the `AI1-1-CPU` flavor with a resource size of 2 (i.e. **2 CPUs**), this means that each replica of the application will be entitled to **2 vCores** and **8GiB RAM**. @@ -94,13 +191,11 @@ In this example, the app will be scaled up when the average RAM usage across all > [!primary] > -> The **total deployment price** will be calculated using the minimum number of replicas. -> +> The total deployment price for **autoscaling apps** is calculated based on the **minimum number of replicas**, **but** costs can **increase** during scaling. -> [!warning] -> -> The cost may increase as `Autoscaling` increases. -> +## Conclusion + +Choosing the right scaling strategy is critical for balancing cost, performance, and reliability in your AI Deploy applications. Static scaling offers stability and predictability, while autoscaling provides flexibility for dynamic workloads. ## Feedback diff --git a/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.en-ie.md b/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.en-ie.md index db40c1e89eb..632038e7195 100644 --- a/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.en-ie.md +++ b/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.en-ie.md @@ -1,74 +1,171 @@ --- title: AI Deploy - Scaling strategies -excerpt: Understand the scaling strategies (static scaling vs autoscaling) of AI Deploy -updated: 2023-04-04 +excerpt: Understand the scaling strategies (static scaling vs autoscaling) of AI Deploy and learn how to use them +updated: 2025-10-08 --- > [!primary] -> > AI Deploy is covered by **[OVHcloud Public Cloud Special Conditions](https://storage.gra.cloud.ovh.net/v1/AUTH_325716a587c64897acbef9a4a4726e38/contracts/d2a208c-Conditions_particulieres_OVH_Stack-WE-9.0.pdf)**. -> ## Objective -This guide covers the use of the different scaling strategies for AI Deploy. The objective is to explain the difference between **static scaling** and **autoscaling** so that you can choose the best solution depending on the use case and type of deployment. +This guide provides a comprehensive understanding of the different scaling strategies for AI Deploy. The objective is to explain the differences between **static scaling** and **autoscaling**, guide users on how to choose between them, set them during app creation, and explain how to modify scaling strategies once apps are created. ## Requirements -- a **Public Cloud** project -- access to the [OVHcloud Control Panel](/links/manager) -- start deploying an app and get to **Step 3**: `Resources` +- An active **Public Cloud** project. +- Access to the [OVHcloud Control Panel](/links/manager). +- The **OVHcloud AI CLI** (`ovhai`) installed. For installation instructions, see [how to install ovhai](/pages/public_cloud/ai_machine_learning/cli_10_howto_install_cli). ## Scaling principles -In the [OVHcloud Control Panel](/links/manager), it is possible to select the **resources** in `Step 3` of the app deployment. +When creating an application via the [OVHcloud Control Panel*** (UI) or the `ovhai` CLI, you can choose one of two scaling strategies: -This step allows you to choose between two scaling strategies: **static scaling** and **autoscaling**. +- **[Static Scaling](#static-scaling)**: Fixed number of running replicas. +- **[Autoscaling](#autoscaling)**: Dynamic replicas based on usage metrics (CPU/RAM or custom metrics). -### Static scaling +## Static Scaling -The **static scaling** strategy allows you to choose the number of replicas on which the app will be deployed. +### What is Static Scaling? + +Static scaling allows you to configure a **fixed number of replicas** (identical instances of your application) running at all times. This is the **default strategy** if not specified. The minimum number of replicas is **1** and the maximum is **10**. > [!warning] > -> It is recommended to deploy on a **minimum of 2 replicas** to have high availability! -> +> For **High Availability**, it is strongly recommended to deploy a **minimum of 2 replicas**. -**When to choose static scaling?** +### When to choose Static Scaling? -- Static scaling can be used if you want to have fixed costs. -- This scaling strategy is also useful when your consumption or inference load are fixed. +- You have **predictable, consistent workloads**. +- You prefer **fixed, predictable costs** with no unexpected resource usage spikes. +- Your use case requires **minimal latency**, as replicas are always active. -### Autoscaling +### Setting Static Scaling (UI and CLI) -With the autoscaling strategy, you can play on several parameters. +> [!tabs] +> **Using the Control Panel (UI)** +>> +>> When creating your application, you will have the opportunity to choose your **scaling strategy**. By default, the strategy is set to **static scaling**. To use this strategy, make sure that automatic scaling is not enabled. Then, you will be asked to choose the number of replicas on which your application will run. +>> +>> ![Set static scaling on AI Deploy via UI](images/set-static-scaling.png){.thumbnail} +>> +> **Using ovhai CLI** +>> +>> Use the `ovhai app run` command with the `--replicas` parameter to set the number of replicas at deployment: +>> +>> ```bash +>> ovhai app run /: \ +>> --replicas 2 \ +>> -- +>> ``` +>> -#### Minimum and maximum number of replicas +## Autoscaling -With the autoscaling strategy, it is possible to choose both the **minimum number of replicas** (1 by default) and the **maximum number of replicas**. +### What is Autoscaling? -#### Monitored metric +Autoscaling dynamically adjusts the number of application replicas based on **real-time metrics**, such as CPU or RAM usage. This is optimized for **workloads with varying demand**. -It is also possible to choose the metric to be monitored. This will act as a trigger for **autoscaling**. There are two metrics to choose from: `CPU` or `RAM`. +### Autoscaling Key Configuration Parameters -#### Trigger threshold +Using this strategy, it is possible to choose: -The threshold for the percentage of average use can also be chosen. It is an integer between 1 and 100%. - -The threshold of the average usage percentage will trigger the scaling (up or down) of the app replicas. +| Parameter | Description | +|----------------------------|-----------------------------------------------------------------------------------------------| +| **Minimum Replicas** | Lowest number of running replicas. | +| **Maximum Replicas** | Upper bound for replica count (define based on usage expectations). | +| **Monitored Metric** | The metric to be monitored. Choose between `CPU` or `RAM` for triggering autoscaling actions. | +| **Trigger Threshold (%)** | Average usage percentage used to trigger scaling up or down. Range: 1–100%. | > [!primary] > -> **High availability** will measure the average resource usage across its replicas and add instances if this average exceeds the specified average usage percentage threshold. -> -> Conversely, it will remove instances when this average resource utilisation falls below the threshold. +> Autoscaling adjusts by calculating the **average resource usage** across all replicas. If the average exceeds the threshold, new replicas are spun up; if it falls below, replicas are removed. > -**When to choose autoscaling?** +### When to Choose Autoscaling? + +- Your app has **irregular or fluctuating** inference/load patterns. +- You want to **scale cost-effectively** with actual usage. +- You are managing a **high-throughput application** with sudden demand spikes. + +### Setting Autoscaling (UI and CLI) + +> [!tabs] +> **Using the Control Panel (UI)** +>> +>> When creating your application, you will have the opportunity to choose your **scaling strategy**. By default, the strategy is set to **static scaling**. Toggle the button to switch to **Autoscaling** Then, configure minimum/maximum replicas, metric, and threshold. +>> +>> ![Set autoscaling on AI Deploy via UI](images/set-autoscaling.png){.thumbnail} +>> +> **Using ovhai CLI** +>> +>> Use the `ovhai app run` command with the following autoscaling parameters: +>> +>> ```bash +>> ovhai app run /: \ +>> --auto-min-replicas 1 \ +>> --auto-max-replicas 5 \ +>> --auto-resource-type CPU \ +>> --auto-resource-usage-threshold 75 +>> ``` +>> + +## Advanced: Custom Metrics for Autoscaling + +**Custom metrics are recommended for workloads such as GPU based inference where CPU and RAM usage provide an incomplete picture of the system’s performance or request load.** + +For advanced scenarios, you can define **custom metrics** to drive autoscaling decisions. This requires an API endpoint to fetch metrics from. + +### Required Parameter + +- `--auto-custom-api-url`: URL of the API operation to call to get the metric value. A specific `` placeholder can be given whenever metrics API is served by the deployed app itself. + +### Optional Parameters + +| Parameter | Description | +|--------------------------------|-----------------------------------------------------------------------------| +| `--auto-custom-value-location` | Specifies where the metric value is located in the API response payload. This value is format-specific. See the valueLocation from the parameters list in the [Trigger Specification documentation](https://keda.sh/docs/2.16/scalers/metrics-api/#trigger-specification) for details. | +| `--auto-custom-target-value` | Target value for metric to scale on. | +| `--auto-custom-metric-format` | Format of the metric to scale on (`JSON`, `XML`, `YAML`, `PROMETHEUS`). Default is `JSON`. | -- You can use autoscaling if you have irregular or sawtooth inference loads. +**Example**: + +Scaling based on a custom metric from an internal endpoint: + +```bash +ovhai app run /: \ + --auto-custom-api-url http://:6000/metrics \ + --auto-custom-value-location foo.bar \ + --auto-custom-target-value 42 \ + --auto-custom-metric-format JSON +``` + +## Modifying Scaling Strategies Post-Deployment + +You can also modify the scaling strategy after the app has been created using the `ovhai app scale` CLI command. This feature is not available on the UI. + +### Updating Static Scaling + +To change the number of replicas for a static scaling strategy, use the `ovhai app scale` command with the `--replicas` parameter: + +```bash +ovhai app scale --replicas +``` + +### Updating Autoscaling + +To change the autoscaling parameters, use the `ovhai app scale` command with the appropriate autoscaling parameters: + +```bash +ovhai app scale \ + --auto-min-replicas \ + --auto-max-replicas \ + --auto-resource-type \ + --auto-resource-usage-threshold \ + +``` ## Scaling example @@ -94,13 +191,11 @@ In this example, the app will be scaled up when the average RAM usage across all > [!primary] > -> The **total deployment price** will be calculated using the minimum number of replicas. -> +> The total deployment price for **autoscaling apps** is calculated based on the **minimum number of replicas**, **but** costs can **increase** during scaling. -> [!warning] -> -> The cost may increase as `Autoscaling` increases. -> +## Conclusion + +Choosing the right scaling strategy is critical for balancing cost, performance, and reliability in your AI Deploy applications. Static scaling offers stability and predictability, while autoscaling provides flexibility for dynamic workloads. ## Feedback diff --git a/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.en-sg.md b/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.en-sg.md index db40c1e89eb..632038e7195 100644 --- a/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.en-sg.md +++ b/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.en-sg.md @@ -1,74 +1,171 @@ --- title: AI Deploy - Scaling strategies -excerpt: Understand the scaling strategies (static scaling vs autoscaling) of AI Deploy -updated: 2023-04-04 +excerpt: Understand the scaling strategies (static scaling vs autoscaling) of AI Deploy and learn how to use them +updated: 2025-10-08 --- > [!primary] -> > AI Deploy is covered by **[OVHcloud Public Cloud Special Conditions](https://storage.gra.cloud.ovh.net/v1/AUTH_325716a587c64897acbef9a4a4726e38/contracts/d2a208c-Conditions_particulieres_OVH_Stack-WE-9.0.pdf)**. -> ## Objective -This guide covers the use of the different scaling strategies for AI Deploy. The objective is to explain the difference between **static scaling** and **autoscaling** so that you can choose the best solution depending on the use case and type of deployment. +This guide provides a comprehensive understanding of the different scaling strategies for AI Deploy. The objective is to explain the differences between **static scaling** and **autoscaling**, guide users on how to choose between them, set them during app creation, and explain how to modify scaling strategies once apps are created. ## Requirements -- a **Public Cloud** project -- access to the [OVHcloud Control Panel](/links/manager) -- start deploying an app and get to **Step 3**: `Resources` +- An active **Public Cloud** project. +- Access to the [OVHcloud Control Panel](/links/manager). +- The **OVHcloud AI CLI** (`ovhai`) installed. For installation instructions, see [how to install ovhai](/pages/public_cloud/ai_machine_learning/cli_10_howto_install_cli). ## Scaling principles -In the [OVHcloud Control Panel](/links/manager), it is possible to select the **resources** in `Step 3` of the app deployment. +When creating an application via the [OVHcloud Control Panel*** (UI) or the `ovhai` CLI, you can choose one of two scaling strategies: -This step allows you to choose between two scaling strategies: **static scaling** and **autoscaling**. +- **[Static Scaling](#static-scaling)**: Fixed number of running replicas. +- **[Autoscaling](#autoscaling)**: Dynamic replicas based on usage metrics (CPU/RAM or custom metrics). -### Static scaling +## Static Scaling -The **static scaling** strategy allows you to choose the number of replicas on which the app will be deployed. +### What is Static Scaling? + +Static scaling allows you to configure a **fixed number of replicas** (identical instances of your application) running at all times. This is the **default strategy** if not specified. The minimum number of replicas is **1** and the maximum is **10**. > [!warning] > -> It is recommended to deploy on a **minimum of 2 replicas** to have high availability! -> +> For **High Availability**, it is strongly recommended to deploy a **minimum of 2 replicas**. -**When to choose static scaling?** +### When to choose Static Scaling? -- Static scaling can be used if you want to have fixed costs. -- This scaling strategy is also useful when your consumption or inference load are fixed. +- You have **predictable, consistent workloads**. +- You prefer **fixed, predictable costs** with no unexpected resource usage spikes. +- Your use case requires **minimal latency**, as replicas are always active. -### Autoscaling +### Setting Static Scaling (UI and CLI) -With the autoscaling strategy, you can play on several parameters. +> [!tabs] +> **Using the Control Panel (UI)** +>> +>> When creating your application, you will have the opportunity to choose your **scaling strategy**. By default, the strategy is set to **static scaling**. To use this strategy, make sure that automatic scaling is not enabled. Then, you will be asked to choose the number of replicas on which your application will run. +>> +>> ![Set static scaling on AI Deploy via UI](images/set-static-scaling.png){.thumbnail} +>> +> **Using ovhai CLI** +>> +>> Use the `ovhai app run` command with the `--replicas` parameter to set the number of replicas at deployment: +>> +>> ```bash +>> ovhai app run /: \ +>> --replicas 2 \ +>> -- +>> ``` +>> -#### Minimum and maximum number of replicas +## Autoscaling -With the autoscaling strategy, it is possible to choose both the **minimum number of replicas** (1 by default) and the **maximum number of replicas**. +### What is Autoscaling? -#### Monitored metric +Autoscaling dynamically adjusts the number of application replicas based on **real-time metrics**, such as CPU or RAM usage. This is optimized for **workloads with varying demand**. -It is also possible to choose the metric to be monitored. This will act as a trigger for **autoscaling**. There are two metrics to choose from: `CPU` or `RAM`. +### Autoscaling Key Configuration Parameters -#### Trigger threshold +Using this strategy, it is possible to choose: -The threshold for the percentage of average use can also be chosen. It is an integer between 1 and 100%. - -The threshold of the average usage percentage will trigger the scaling (up or down) of the app replicas. +| Parameter | Description | +|----------------------------|-----------------------------------------------------------------------------------------------| +| **Minimum Replicas** | Lowest number of running replicas. | +| **Maximum Replicas** | Upper bound for replica count (define based on usage expectations). | +| **Monitored Metric** | The metric to be monitored. Choose between `CPU` or `RAM` for triggering autoscaling actions. | +| **Trigger Threshold (%)** | Average usage percentage used to trigger scaling up or down. Range: 1–100%. | > [!primary] > -> **High availability** will measure the average resource usage across its replicas and add instances if this average exceeds the specified average usage percentage threshold. -> -> Conversely, it will remove instances when this average resource utilisation falls below the threshold. +> Autoscaling adjusts by calculating the **average resource usage** across all replicas. If the average exceeds the threshold, new replicas are spun up; if it falls below, replicas are removed. > -**When to choose autoscaling?** +### When to Choose Autoscaling? + +- Your app has **irregular or fluctuating** inference/load patterns. +- You want to **scale cost-effectively** with actual usage. +- You are managing a **high-throughput application** with sudden demand spikes. + +### Setting Autoscaling (UI and CLI) + +> [!tabs] +> **Using the Control Panel (UI)** +>> +>> When creating your application, you will have the opportunity to choose your **scaling strategy**. By default, the strategy is set to **static scaling**. Toggle the button to switch to **Autoscaling** Then, configure minimum/maximum replicas, metric, and threshold. +>> +>> ![Set autoscaling on AI Deploy via UI](images/set-autoscaling.png){.thumbnail} +>> +> **Using ovhai CLI** +>> +>> Use the `ovhai app run` command with the following autoscaling parameters: +>> +>> ```bash +>> ovhai app run /: \ +>> --auto-min-replicas 1 \ +>> --auto-max-replicas 5 \ +>> --auto-resource-type CPU \ +>> --auto-resource-usage-threshold 75 +>> ``` +>> + +## Advanced: Custom Metrics for Autoscaling + +**Custom metrics are recommended for workloads such as GPU based inference where CPU and RAM usage provide an incomplete picture of the system’s performance or request load.** + +For advanced scenarios, you can define **custom metrics** to drive autoscaling decisions. This requires an API endpoint to fetch metrics from. + +### Required Parameter + +- `--auto-custom-api-url`: URL of the API operation to call to get the metric value. A specific `` placeholder can be given whenever metrics API is served by the deployed app itself. + +### Optional Parameters + +| Parameter | Description | +|--------------------------------|-----------------------------------------------------------------------------| +| `--auto-custom-value-location` | Specifies where the metric value is located in the API response payload. This value is format-specific. See the valueLocation from the parameters list in the [Trigger Specification documentation](https://keda.sh/docs/2.16/scalers/metrics-api/#trigger-specification) for details. | +| `--auto-custom-target-value` | Target value for metric to scale on. | +| `--auto-custom-metric-format` | Format of the metric to scale on (`JSON`, `XML`, `YAML`, `PROMETHEUS`). Default is `JSON`. | -- You can use autoscaling if you have irregular or sawtooth inference loads. +**Example**: + +Scaling based on a custom metric from an internal endpoint: + +```bash +ovhai app run /: \ + --auto-custom-api-url http://:6000/metrics \ + --auto-custom-value-location foo.bar \ + --auto-custom-target-value 42 \ + --auto-custom-metric-format JSON +``` + +## Modifying Scaling Strategies Post-Deployment + +You can also modify the scaling strategy after the app has been created using the `ovhai app scale` CLI command. This feature is not available on the UI. + +### Updating Static Scaling + +To change the number of replicas for a static scaling strategy, use the `ovhai app scale` command with the `--replicas` parameter: + +```bash +ovhai app scale --replicas +``` + +### Updating Autoscaling + +To change the autoscaling parameters, use the `ovhai app scale` command with the appropriate autoscaling parameters: + +```bash +ovhai app scale \ + --auto-min-replicas \ + --auto-max-replicas \ + --auto-resource-type \ + --auto-resource-usage-threshold \ + +``` ## Scaling example @@ -94,13 +191,11 @@ In this example, the app will be scaled up when the average RAM usage across all > [!primary] > -> The **total deployment price** will be calculated using the minimum number of replicas. -> +> The total deployment price for **autoscaling apps** is calculated based on the **minimum number of replicas**, **but** costs can **increase** during scaling. -> [!warning] -> -> The cost may increase as `Autoscaling` increases. -> +## Conclusion + +Choosing the right scaling strategy is critical for balancing cost, performance, and reliability in your AI Deploy applications. Static scaling offers stability and predictability, while autoscaling provides flexibility for dynamic workloads. ## Feedback diff --git a/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.en-us.md b/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.en-us.md index db40c1e89eb..632038e7195 100644 --- a/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.en-us.md +++ b/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.en-us.md @@ -1,74 +1,171 @@ --- title: AI Deploy - Scaling strategies -excerpt: Understand the scaling strategies (static scaling vs autoscaling) of AI Deploy -updated: 2023-04-04 +excerpt: Understand the scaling strategies (static scaling vs autoscaling) of AI Deploy and learn how to use them +updated: 2025-10-08 --- > [!primary] -> > AI Deploy is covered by **[OVHcloud Public Cloud Special Conditions](https://storage.gra.cloud.ovh.net/v1/AUTH_325716a587c64897acbef9a4a4726e38/contracts/d2a208c-Conditions_particulieres_OVH_Stack-WE-9.0.pdf)**. -> ## Objective -This guide covers the use of the different scaling strategies for AI Deploy. The objective is to explain the difference between **static scaling** and **autoscaling** so that you can choose the best solution depending on the use case and type of deployment. +This guide provides a comprehensive understanding of the different scaling strategies for AI Deploy. The objective is to explain the differences between **static scaling** and **autoscaling**, guide users on how to choose between them, set them during app creation, and explain how to modify scaling strategies once apps are created. ## Requirements -- a **Public Cloud** project -- access to the [OVHcloud Control Panel](/links/manager) -- start deploying an app and get to **Step 3**: `Resources` +- An active **Public Cloud** project. +- Access to the [OVHcloud Control Panel](/links/manager). +- The **OVHcloud AI CLI** (`ovhai`) installed. For installation instructions, see [how to install ovhai](/pages/public_cloud/ai_machine_learning/cli_10_howto_install_cli). ## Scaling principles -In the [OVHcloud Control Panel](/links/manager), it is possible to select the **resources** in `Step 3` of the app deployment. +When creating an application via the [OVHcloud Control Panel*** (UI) or the `ovhai` CLI, you can choose one of two scaling strategies: -This step allows you to choose between two scaling strategies: **static scaling** and **autoscaling**. +- **[Static Scaling](#static-scaling)**: Fixed number of running replicas. +- **[Autoscaling](#autoscaling)**: Dynamic replicas based on usage metrics (CPU/RAM or custom metrics). -### Static scaling +## Static Scaling -The **static scaling** strategy allows you to choose the number of replicas on which the app will be deployed. +### What is Static Scaling? + +Static scaling allows you to configure a **fixed number of replicas** (identical instances of your application) running at all times. This is the **default strategy** if not specified. The minimum number of replicas is **1** and the maximum is **10**. > [!warning] > -> It is recommended to deploy on a **minimum of 2 replicas** to have high availability! -> +> For **High Availability**, it is strongly recommended to deploy a **minimum of 2 replicas**. -**When to choose static scaling?** +### When to choose Static Scaling? -- Static scaling can be used if you want to have fixed costs. -- This scaling strategy is also useful when your consumption or inference load are fixed. +- You have **predictable, consistent workloads**. +- You prefer **fixed, predictable costs** with no unexpected resource usage spikes. +- Your use case requires **minimal latency**, as replicas are always active. -### Autoscaling +### Setting Static Scaling (UI and CLI) -With the autoscaling strategy, you can play on several parameters. +> [!tabs] +> **Using the Control Panel (UI)** +>> +>> When creating your application, you will have the opportunity to choose your **scaling strategy**. By default, the strategy is set to **static scaling**. To use this strategy, make sure that automatic scaling is not enabled. Then, you will be asked to choose the number of replicas on which your application will run. +>> +>> ![Set static scaling on AI Deploy via UI](images/set-static-scaling.png){.thumbnail} +>> +> **Using ovhai CLI** +>> +>> Use the `ovhai app run` command with the `--replicas` parameter to set the number of replicas at deployment: +>> +>> ```bash +>> ovhai app run /: \ +>> --replicas 2 \ +>> -- +>> ``` +>> -#### Minimum and maximum number of replicas +## Autoscaling -With the autoscaling strategy, it is possible to choose both the **minimum number of replicas** (1 by default) and the **maximum number of replicas**. +### What is Autoscaling? -#### Monitored metric +Autoscaling dynamically adjusts the number of application replicas based on **real-time metrics**, such as CPU or RAM usage. This is optimized for **workloads with varying demand**. -It is also possible to choose the metric to be monitored. This will act as a trigger for **autoscaling**. There are two metrics to choose from: `CPU` or `RAM`. +### Autoscaling Key Configuration Parameters -#### Trigger threshold +Using this strategy, it is possible to choose: -The threshold for the percentage of average use can also be chosen. It is an integer between 1 and 100%. - -The threshold of the average usage percentage will trigger the scaling (up or down) of the app replicas. +| Parameter | Description | +|----------------------------|-----------------------------------------------------------------------------------------------| +| **Minimum Replicas** | Lowest number of running replicas. | +| **Maximum Replicas** | Upper bound for replica count (define based on usage expectations). | +| **Monitored Metric** | The metric to be monitored. Choose between `CPU` or `RAM` for triggering autoscaling actions. | +| **Trigger Threshold (%)** | Average usage percentage used to trigger scaling up or down. Range: 1–100%. | > [!primary] > -> **High availability** will measure the average resource usage across its replicas and add instances if this average exceeds the specified average usage percentage threshold. -> -> Conversely, it will remove instances when this average resource utilisation falls below the threshold. +> Autoscaling adjusts by calculating the **average resource usage** across all replicas. If the average exceeds the threshold, new replicas are spun up; if it falls below, replicas are removed. > -**When to choose autoscaling?** +### When to Choose Autoscaling? + +- Your app has **irregular or fluctuating** inference/load patterns. +- You want to **scale cost-effectively** with actual usage. +- You are managing a **high-throughput application** with sudden demand spikes. + +### Setting Autoscaling (UI and CLI) + +> [!tabs] +> **Using the Control Panel (UI)** +>> +>> When creating your application, you will have the opportunity to choose your **scaling strategy**. By default, the strategy is set to **static scaling**. Toggle the button to switch to **Autoscaling** Then, configure minimum/maximum replicas, metric, and threshold. +>> +>> ![Set autoscaling on AI Deploy via UI](images/set-autoscaling.png){.thumbnail} +>> +> **Using ovhai CLI** +>> +>> Use the `ovhai app run` command with the following autoscaling parameters: +>> +>> ```bash +>> ovhai app run /: \ +>> --auto-min-replicas 1 \ +>> --auto-max-replicas 5 \ +>> --auto-resource-type CPU \ +>> --auto-resource-usage-threshold 75 +>> ``` +>> + +## Advanced: Custom Metrics for Autoscaling + +**Custom metrics are recommended for workloads such as GPU based inference where CPU and RAM usage provide an incomplete picture of the system’s performance or request load.** + +For advanced scenarios, you can define **custom metrics** to drive autoscaling decisions. This requires an API endpoint to fetch metrics from. + +### Required Parameter + +- `--auto-custom-api-url`: URL of the API operation to call to get the metric value. A specific `` placeholder can be given whenever metrics API is served by the deployed app itself. + +### Optional Parameters + +| Parameter | Description | +|--------------------------------|-----------------------------------------------------------------------------| +| `--auto-custom-value-location` | Specifies where the metric value is located in the API response payload. This value is format-specific. See the valueLocation from the parameters list in the [Trigger Specification documentation](https://keda.sh/docs/2.16/scalers/metrics-api/#trigger-specification) for details. | +| `--auto-custom-target-value` | Target value for metric to scale on. | +| `--auto-custom-metric-format` | Format of the metric to scale on (`JSON`, `XML`, `YAML`, `PROMETHEUS`). Default is `JSON`. | -- You can use autoscaling if you have irregular or sawtooth inference loads. +**Example**: + +Scaling based on a custom metric from an internal endpoint: + +```bash +ovhai app run /: \ + --auto-custom-api-url http://:6000/metrics \ + --auto-custom-value-location foo.bar \ + --auto-custom-target-value 42 \ + --auto-custom-metric-format JSON +``` + +## Modifying Scaling Strategies Post-Deployment + +You can also modify the scaling strategy after the app has been created using the `ovhai app scale` CLI command. This feature is not available on the UI. + +### Updating Static Scaling + +To change the number of replicas for a static scaling strategy, use the `ovhai app scale` command with the `--replicas` parameter: + +```bash +ovhai app scale --replicas +``` + +### Updating Autoscaling + +To change the autoscaling parameters, use the `ovhai app scale` command with the appropriate autoscaling parameters: + +```bash +ovhai app scale \ + --auto-min-replicas \ + --auto-max-replicas \ + --auto-resource-type \ + --auto-resource-usage-threshold \ + +``` ## Scaling example @@ -94,13 +191,11 @@ In this example, the app will be scaled up when the average RAM usage across all > [!primary] > -> The **total deployment price** will be calculated using the minimum number of replicas. -> +> The total deployment price for **autoscaling apps** is calculated based on the **minimum number of replicas**, **but** costs can **increase** during scaling. -> [!warning] -> -> The cost may increase as `Autoscaling` increases. -> +## Conclusion + +Choosing the right scaling strategy is critical for balancing cost, performance, and reliability in your AI Deploy applications. Static scaling offers stability and predictability, while autoscaling provides flexibility for dynamic workloads. ## Feedback diff --git a/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.es-es.md b/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.es-es.md index 0e9245d3044..632038e7195 100644 --- a/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.es-es.md +++ b/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.es-es.md @@ -1,78 +1,175 @@ --- title: AI Deploy - Scaling strategies -excerpt: Understand the scaling strategies (static scaling vs autoscaling) of AI Deploy -updated: 2023-04-04 +excerpt: Understand the scaling strategies (static scaling vs autoscaling) of AI Deploy and learn how to use them +updated: 2025-10-08 --- > [!primary] -> > AI Deploy is covered by **[OVHcloud Public Cloud Special Conditions](https://storage.gra.cloud.ovh.net/v1/AUTH_325716a587c64897acbef9a4a4726e38/contracts/d2a208c-Conditions_particulieres_OVH_Stack-WE-9.0.pdf)**. -> ## Objective -This guide covers the use of the different scaling strategies for AI Deploy. The objective is to explain the difference between **static scaling** and **autoscaling** so that you can choose the best solution depending on the use case and type of deployment. +This guide provides a comprehensive understanding of the different scaling strategies for AI Deploy. The objective is to explain the differences between **static scaling** and **autoscaling**, guide users on how to choose between them, set them during app creation, and explain how to modify scaling strategies once apps are created. ## Requirements -- a **Public Cloud** project -- access to the [OVHcloud Control Panel](/links/manager) -- start deploying an app and get to **Step 3**: `Resources` +- An active **Public Cloud** project. +- Access to the [OVHcloud Control Panel](/links/manager). +- The **OVHcloud AI CLI** (`ovhai`) installed. For installation instructions, see [how to install ovhai](/pages/public_cloud/ai_machine_learning/cli_10_howto_install_cli). ## Scaling principles -In the [OVHcloud Control Panel](/links/manager), it is possible to select the **resources** in `Step 3` of the app deployment. +When creating an application via the [OVHcloud Control Panel*** (UI) or the `ovhai` CLI, you can choose one of two scaling strategies: -This step allows you to choose between two scaling strategies: **static scaling** and **autoscaling**. +- **[Static Scaling](#static-scaling)**: Fixed number of running replicas. +- **[Autoscaling](#autoscaling)**: Dynamic replicas based on usage metrics (CPU/RAM or custom metrics). -### Static scaling +## Static Scaling -The **static scaling** strategy allows you to choose the number of replicas on which the app will be deployed. +### What is Static Scaling? + +Static scaling allows you to configure a **fixed number of replicas** (identical instances of your application) running at all times. This is the **default strategy** if not specified. The minimum number of replicas is **1** and the maximum is **10**. > [!warning] > -> It is recommended to deploy on a **minimum of 2 replicas** to have high availability! -> +> For **High Availability**, it is strongly recommended to deploy a **minimum of 2 replicas**. -**When to choose static scaling?** +### When to choose Static Scaling? -- Static scaling can be used if you want to have fixed costs. -- This scaling strategy is also useful when your consumption or inference load are fixed. +- You have **predictable, consistent workloads**. +- You prefer **fixed, predictable costs** with no unexpected resource usage spikes. +- Your use case requires **minimal latency**, as replicas are always active. -### Autoscaling +### Setting Static Scaling (UI and CLI) -With the autoscaling strategy, you can play on several parameters. +> [!tabs] +> **Using the Control Panel (UI)** +>> +>> When creating your application, you will have the opportunity to choose your **scaling strategy**. By default, the strategy is set to **static scaling**. To use this strategy, make sure that automatic scaling is not enabled. Then, you will be asked to choose the number of replicas on which your application will run. +>> +>> ![Set static scaling on AI Deploy via UI](images/set-static-scaling.png){.thumbnail} +>> +> **Using ovhai CLI** +>> +>> Use the `ovhai app run` command with the `--replicas` parameter to set the number of replicas at deployment: +>> +>> ```bash +>> ovhai app run /: \ +>> --replicas 2 \ +>> -- +>> ``` +>> -#### Minimum and maximum number of replicas +## Autoscaling -With the autoscaling strategy, it is possible to choose both the **minimum number of replicas** (1 by default) and the **maximum number of replicas**. +### What is Autoscaling? -#### Monitored metric +Autoscaling dynamically adjusts the number of application replicas based on **real-time metrics**, such as CPU or RAM usage. This is optimized for **workloads with varying demand**. -It is also possible to choose the metric to be monitored. This will act as a trigger for **autoscaling**. There are two metrics to choose from: `CPU` or `RAM`. +### Autoscaling Key Configuration Parameters -#### Trigger threshold +Using this strategy, it is possible to choose: -The threshold for the percentage of average use can also be chosen. It is an integer between 1 and 100%. - -The threshold of the average usage percentage will trigger the scaling (up or down) of the app replicas. +| Parameter | Description | +|----------------------------|-----------------------------------------------------------------------------------------------| +| **Minimum Replicas** | Lowest number of running replicas. | +| **Maximum Replicas** | Upper bound for replica count (define based on usage expectations). | +| **Monitored Metric** | The metric to be monitored. Choose between `CPU` or `RAM` for triggering autoscaling actions. | +| **Trigger Threshold (%)** | Average usage percentage used to trigger scaling up or down. Range: 1–100%. | > [!primary] > -> **High availability** will measure the average resource usage across its replicas and add instances if this average exceeds the specified average usage percentage threshold. -> -> Conversely, it will remove instances when this average resource utilisation falls below the threshold. +> Autoscaling adjusts by calculating the **average resource usage** across all replicas. If the average exceeds the threshold, new replicas are spun up; if it falls below, replicas are removed. > -**When to choose autoscaling?** +### When to Choose Autoscaling? + +- Your app has **irregular or fluctuating** inference/load patterns. +- You want to **scale cost-effectively** with actual usage. +- You are managing a **high-throughput application** with sudden demand spikes. + +### Setting Autoscaling (UI and CLI) + +> [!tabs] +> **Using the Control Panel (UI)** +>> +>> When creating your application, you will have the opportunity to choose your **scaling strategy**. By default, the strategy is set to **static scaling**. Toggle the button to switch to **Autoscaling** Then, configure minimum/maximum replicas, metric, and threshold. +>> +>> ![Set autoscaling on AI Deploy via UI](images/set-autoscaling.png){.thumbnail} +>> +> **Using ovhai CLI** +>> +>> Use the `ovhai app run` command with the following autoscaling parameters: +>> +>> ```bash +>> ovhai app run /: \ +>> --auto-min-replicas 1 \ +>> --auto-max-replicas 5 \ +>> --auto-resource-type CPU \ +>> --auto-resource-usage-threshold 75 +>> ``` +>> + +## Advanced: Custom Metrics for Autoscaling + +**Custom metrics are recommended for workloads such as GPU based inference where CPU and RAM usage provide an incomplete picture of the system’s performance or request load.** + +For advanced scenarios, you can define **custom metrics** to drive autoscaling decisions. This requires an API endpoint to fetch metrics from. + +### Required Parameter + +- `--auto-custom-api-url`: URL of the API operation to call to get the metric value. A specific `` placeholder can be given whenever metrics API is served by the deployed app itself. + +### Optional Parameters + +| Parameter | Description | +|--------------------------------|-----------------------------------------------------------------------------| +| `--auto-custom-value-location` | Specifies where the metric value is located in the API response payload. This value is format-specific. See the valueLocation from the parameters list in the [Trigger Specification documentation](https://keda.sh/docs/2.16/scalers/metrics-api/#trigger-specification) for details. | +| `--auto-custom-target-value` | Target value for metric to scale on. | +| `--auto-custom-metric-format` | Format of the metric to scale on (`JSON`, `XML`, `YAML`, `PROMETHEUS`). Default is `JSON`. | -- You can use autoscaling if you have irregular or sawtooth inference loads. +**Example**: + +Scaling based on a custom metric from an internal endpoint: + +```bash +ovhai app run /: \ + --auto-custom-api-url http://:6000/metrics \ + --auto-custom-value-location foo.bar \ + --auto-custom-target-value 42 \ + --auto-custom-metric-format JSON +``` + +## Modifying Scaling Strategies Post-Deployment + +You can also modify the scaling strategy after the app has been created using the `ovhai app scale` CLI command. This feature is not available on the UI. + +### Updating Static Scaling + +To change the number of replicas for a static scaling strategy, use the `ovhai app scale` command with the `--replicas` parameter: + +```bash +ovhai app scale --replicas +``` + +### Updating Autoscaling + +To change the autoscaling parameters, use the `ovhai app scale` command with the appropriate autoscaling parameters: + +```bash +ovhai app scale \ + --auto-min-replicas \ + --auto-max-replicas \ + --auto-resource-type \ + --auto-resource-usage-threshold \ + +``` ## Scaling example -We will use the following example: +We will use the following example: In case an app is based on the `AI1-1-CPU` flavor with a resource size of 2 (i.e. **2 CPUs**), this means that each replica of the application will be entitled to **2 vCores** and **8GiB RAM**. @@ -94,13 +191,11 @@ In this example, the app will be scaled up when the average RAM usage across all > [!primary] > -> The **total deployment price** will be calculated using the minimum number of replicas. -> +> The total deployment price for **autoscaling apps** is calculated based on the **minimum number of replicas**, **but** costs can **increase** during scaling. -> [!warning] -> -> The cost may increase as `Autoscaling` increases. -> +## Conclusion + +Choosing the right scaling strategy is critical for balancing cost, performance, and reliability in your AI Deploy applications. Static scaling offers stability and predictability, while autoscaling provides flexibility for dynamic workloads. ## Feedback diff --git a/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.es-us.md b/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.es-us.md index 0e9245d3044..632038e7195 100644 --- a/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.es-us.md +++ b/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.es-us.md @@ -1,78 +1,175 @@ --- title: AI Deploy - Scaling strategies -excerpt: Understand the scaling strategies (static scaling vs autoscaling) of AI Deploy -updated: 2023-04-04 +excerpt: Understand the scaling strategies (static scaling vs autoscaling) of AI Deploy and learn how to use them +updated: 2025-10-08 --- > [!primary] -> > AI Deploy is covered by **[OVHcloud Public Cloud Special Conditions](https://storage.gra.cloud.ovh.net/v1/AUTH_325716a587c64897acbef9a4a4726e38/contracts/d2a208c-Conditions_particulieres_OVH_Stack-WE-9.0.pdf)**. -> ## Objective -This guide covers the use of the different scaling strategies for AI Deploy. The objective is to explain the difference between **static scaling** and **autoscaling** so that you can choose the best solution depending on the use case and type of deployment. +This guide provides a comprehensive understanding of the different scaling strategies for AI Deploy. The objective is to explain the differences between **static scaling** and **autoscaling**, guide users on how to choose between them, set them during app creation, and explain how to modify scaling strategies once apps are created. ## Requirements -- a **Public Cloud** project -- access to the [OVHcloud Control Panel](/links/manager) -- start deploying an app and get to **Step 3**: `Resources` +- An active **Public Cloud** project. +- Access to the [OVHcloud Control Panel](/links/manager). +- The **OVHcloud AI CLI** (`ovhai`) installed. For installation instructions, see [how to install ovhai](/pages/public_cloud/ai_machine_learning/cli_10_howto_install_cli). ## Scaling principles -In the [OVHcloud Control Panel](/links/manager), it is possible to select the **resources** in `Step 3` of the app deployment. +When creating an application via the [OVHcloud Control Panel*** (UI) or the `ovhai` CLI, you can choose one of two scaling strategies: -This step allows you to choose between two scaling strategies: **static scaling** and **autoscaling**. +- **[Static Scaling](#static-scaling)**: Fixed number of running replicas. +- **[Autoscaling](#autoscaling)**: Dynamic replicas based on usage metrics (CPU/RAM or custom metrics). -### Static scaling +## Static Scaling -The **static scaling** strategy allows you to choose the number of replicas on which the app will be deployed. +### What is Static Scaling? + +Static scaling allows you to configure a **fixed number of replicas** (identical instances of your application) running at all times. This is the **default strategy** if not specified. The minimum number of replicas is **1** and the maximum is **10**. > [!warning] > -> It is recommended to deploy on a **minimum of 2 replicas** to have high availability! -> +> For **High Availability**, it is strongly recommended to deploy a **minimum of 2 replicas**. -**When to choose static scaling?** +### When to choose Static Scaling? -- Static scaling can be used if you want to have fixed costs. -- This scaling strategy is also useful when your consumption or inference load are fixed. +- You have **predictable, consistent workloads**. +- You prefer **fixed, predictable costs** with no unexpected resource usage spikes. +- Your use case requires **minimal latency**, as replicas are always active. -### Autoscaling +### Setting Static Scaling (UI and CLI) -With the autoscaling strategy, you can play on several parameters. +> [!tabs] +> **Using the Control Panel (UI)** +>> +>> When creating your application, you will have the opportunity to choose your **scaling strategy**. By default, the strategy is set to **static scaling**. To use this strategy, make sure that automatic scaling is not enabled. Then, you will be asked to choose the number of replicas on which your application will run. +>> +>> ![Set static scaling on AI Deploy via UI](images/set-static-scaling.png){.thumbnail} +>> +> **Using ovhai CLI** +>> +>> Use the `ovhai app run` command with the `--replicas` parameter to set the number of replicas at deployment: +>> +>> ```bash +>> ovhai app run /: \ +>> --replicas 2 \ +>> -- +>> ``` +>> -#### Minimum and maximum number of replicas +## Autoscaling -With the autoscaling strategy, it is possible to choose both the **minimum number of replicas** (1 by default) and the **maximum number of replicas**. +### What is Autoscaling? -#### Monitored metric +Autoscaling dynamically adjusts the number of application replicas based on **real-time metrics**, such as CPU or RAM usage. This is optimized for **workloads with varying demand**. -It is also possible to choose the metric to be monitored. This will act as a trigger for **autoscaling**. There are two metrics to choose from: `CPU` or `RAM`. +### Autoscaling Key Configuration Parameters -#### Trigger threshold +Using this strategy, it is possible to choose: -The threshold for the percentage of average use can also be chosen. It is an integer between 1 and 100%. - -The threshold of the average usage percentage will trigger the scaling (up or down) of the app replicas. +| Parameter | Description | +|----------------------------|-----------------------------------------------------------------------------------------------| +| **Minimum Replicas** | Lowest number of running replicas. | +| **Maximum Replicas** | Upper bound for replica count (define based on usage expectations). | +| **Monitored Metric** | The metric to be monitored. Choose between `CPU` or `RAM` for triggering autoscaling actions. | +| **Trigger Threshold (%)** | Average usage percentage used to trigger scaling up or down. Range: 1–100%. | > [!primary] > -> **High availability** will measure the average resource usage across its replicas and add instances if this average exceeds the specified average usage percentage threshold. -> -> Conversely, it will remove instances when this average resource utilisation falls below the threshold. +> Autoscaling adjusts by calculating the **average resource usage** across all replicas. If the average exceeds the threshold, new replicas are spun up; if it falls below, replicas are removed. > -**When to choose autoscaling?** +### When to Choose Autoscaling? + +- Your app has **irregular or fluctuating** inference/load patterns. +- You want to **scale cost-effectively** with actual usage. +- You are managing a **high-throughput application** with sudden demand spikes. + +### Setting Autoscaling (UI and CLI) + +> [!tabs] +> **Using the Control Panel (UI)** +>> +>> When creating your application, you will have the opportunity to choose your **scaling strategy**. By default, the strategy is set to **static scaling**. Toggle the button to switch to **Autoscaling** Then, configure minimum/maximum replicas, metric, and threshold. +>> +>> ![Set autoscaling on AI Deploy via UI](images/set-autoscaling.png){.thumbnail} +>> +> **Using ovhai CLI** +>> +>> Use the `ovhai app run` command with the following autoscaling parameters: +>> +>> ```bash +>> ovhai app run /: \ +>> --auto-min-replicas 1 \ +>> --auto-max-replicas 5 \ +>> --auto-resource-type CPU \ +>> --auto-resource-usage-threshold 75 +>> ``` +>> + +## Advanced: Custom Metrics for Autoscaling + +**Custom metrics are recommended for workloads such as GPU based inference where CPU and RAM usage provide an incomplete picture of the system’s performance or request load.** + +For advanced scenarios, you can define **custom metrics** to drive autoscaling decisions. This requires an API endpoint to fetch metrics from. + +### Required Parameter + +- `--auto-custom-api-url`: URL of the API operation to call to get the metric value. A specific `` placeholder can be given whenever metrics API is served by the deployed app itself. + +### Optional Parameters + +| Parameter | Description | +|--------------------------------|-----------------------------------------------------------------------------| +| `--auto-custom-value-location` | Specifies where the metric value is located in the API response payload. This value is format-specific. See the valueLocation from the parameters list in the [Trigger Specification documentation](https://keda.sh/docs/2.16/scalers/metrics-api/#trigger-specification) for details. | +| `--auto-custom-target-value` | Target value for metric to scale on. | +| `--auto-custom-metric-format` | Format of the metric to scale on (`JSON`, `XML`, `YAML`, `PROMETHEUS`). Default is `JSON`. | -- You can use autoscaling if you have irregular or sawtooth inference loads. +**Example**: + +Scaling based on a custom metric from an internal endpoint: + +```bash +ovhai app run /: \ + --auto-custom-api-url http://:6000/metrics \ + --auto-custom-value-location foo.bar \ + --auto-custom-target-value 42 \ + --auto-custom-metric-format JSON +``` + +## Modifying Scaling Strategies Post-Deployment + +You can also modify the scaling strategy after the app has been created using the `ovhai app scale` CLI command. This feature is not available on the UI. + +### Updating Static Scaling + +To change the number of replicas for a static scaling strategy, use the `ovhai app scale` command with the `--replicas` parameter: + +```bash +ovhai app scale --replicas +``` + +### Updating Autoscaling + +To change the autoscaling parameters, use the `ovhai app scale` command with the appropriate autoscaling parameters: + +```bash +ovhai app scale \ + --auto-min-replicas \ + --auto-max-replicas \ + --auto-resource-type \ + --auto-resource-usage-threshold \ + +``` ## Scaling example -We will use the following example: +We will use the following example: In case an app is based on the `AI1-1-CPU` flavor with a resource size of 2 (i.e. **2 CPUs**), this means that each replica of the application will be entitled to **2 vCores** and **8GiB RAM**. @@ -94,13 +191,11 @@ In this example, the app will be scaled up when the average RAM usage across all > [!primary] > -> The **total deployment price** will be calculated using the minimum number of replicas. -> +> The total deployment price for **autoscaling apps** is calculated based on the **minimum number of replicas**, **but** costs can **increase** during scaling. -> [!warning] -> -> The cost may increase as `Autoscaling` increases. -> +## Conclusion + +Choosing the right scaling strategy is critical for balancing cost, performance, and reliability in your AI Deploy applications. Static scaling offers stability and predictability, while autoscaling provides flexibility for dynamic workloads. ## Feedback diff --git a/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.fr-ca.md b/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.fr-ca.md index 71ceaae08f8..fb76bef3ec6 100644 --- a/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.fr-ca.md +++ b/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.fr-ca.md @@ -1,78 +1,175 @@ --- title: "AI Deploy - Stratégies de mise à l'échelle (EN)" -excerpt: Understand the scaling strategies (static scaling vs autoscaling) of AI Deploy -updated: 2023-04-04 +excerpt: Understand the scaling strategies (static scaling vs autoscaling) of AI Deploy and learn how to use them +updated: 2025-10-08 --- > [!primary] -> > AI Deploy is covered by **[OVHcloud Public Cloud Special Conditions](https://storage.gra.cloud.ovh.net/v1/AUTH_325716a587c64897acbef9a4a4726e38/contracts/d2a208c-Conditions_particulieres_OVH_Stack-WE-9.0.pdf)**. -> ## Objective -This guide covers the use of the different scaling strategies for AI Deploy. The objective is to explain the difference between **static scaling** and **autoscaling** so that you can choose the best solution depending on the use case and type of deployment. +This guide provides a comprehensive understanding of the different scaling strategies for AI Deploy. The objective is to explain the differences between **static scaling** and **autoscaling**, guide users on how to choose between them, set them during app creation, and explain how to modify scaling strategies once apps are created. ## Requirements -- a **Public Cloud** project -- access to the [OVHcloud Control Panel](/links/manager) -- start deploying an app and get to **Step 3**: `Resources` +- An active **Public Cloud** project. +- Access to the [OVHcloud Control Panel](/links/manager). +- The **OVHcloud AI CLI** (`ovhai`) installed. For installation instructions, see [how to install ovhai](/pages/public_cloud/ai_machine_learning/cli_10_howto_install_cli). ## Scaling principles -In the [OVHcloud Control Panel](/links/manager), it is possible to select the **resources** in `Step 3` of the app deployment. +When creating an application via the [OVHcloud Control Panel*** (UI) or the `ovhai` CLI, you can choose one of two scaling strategies: -This step allows you to choose between two scaling strategies: **static scaling** and **autoscaling**. +- **[Static Scaling](#static-scaling)**: Fixed number of running replicas. +- **[Autoscaling](#autoscaling)**: Dynamic replicas based on usage metrics (CPU/RAM or custom metrics). -### Static scaling +## Static Scaling -The **static scaling** strategy allows you to choose the number of replicas on which the app will be deployed. +### What is Static Scaling? + +Static scaling allows you to configure a **fixed number of replicas** (identical instances of your application) running at all times. This is the **default strategy** if not specified. The minimum number of replicas is **1** and the maximum is **10**. > [!warning] > -> It is recommended to deploy on a **minimum of 2 replicas** to have high availability! -> +> For **High Availability**, it is strongly recommended to deploy a **minimum of 2 replicas**. -**When to choose static scaling?** +### When to choose Static Scaling? -- Static scaling can be used if you want to have fixed costs. -- This scaling strategy is also useful when your consumption or inference load are fixed. +- You have **predictable, consistent workloads**. +- You prefer **fixed, predictable costs** with no unexpected resource usage spikes. +- Your use case requires **minimal latency**, as replicas are always active. -### Autoscaling +### Setting Static Scaling (UI and CLI) -With the autoscaling strategy, you can play on several parameters. +> [!tabs] +> **Using the Control Panel (UI)** +>> +>> When creating your application, you will have the opportunity to choose your **scaling strategy**. By default, the strategy is set to **static scaling**. To use this strategy, make sure that automatic scaling is not enabled. Then, you will be asked to choose the number of replicas on which your application will run. +>> +>> ![Set static scaling on AI Deploy via UI](images/set-static-scaling.png){.thumbnail} +>> +> **Using ovhai CLI** +>> +>> Use the `ovhai app run` command with the `--replicas` parameter to set the number of replicas at deployment: +>> +>> ```bash +>> ovhai app run /: \ +>> --replicas 2 \ +>> -- +>> ``` +>> -#### Minimum and maximum number of replicas +## Autoscaling -With the autoscaling strategy, it is possible to choose both the **minimum number of replicas** (1 by default) and the **maximum number of replicas**. +### What is Autoscaling? -#### Monitored metric +Autoscaling dynamically adjusts the number of application replicas based on **real-time metrics**, such as CPU or RAM usage. This is optimized for **workloads with varying demand**. -It is also possible to choose the metric to be monitored. This will act as a trigger for **autoscaling**. There are two metrics to choose from: `CPU` or `RAM`. +### Autoscaling Key Configuration Parameters -#### Trigger threshold +Using this strategy, it is possible to choose: -The threshold for the percentage of average use can also be chosen. It is an integer between 1 and 100%. - -The threshold of the average usage percentage will trigger the scaling (up or down) of the app replicas. +| Parameter | Description | +|----------------------------|-----------------------------------------------------------------------------------------------| +| **Minimum Replicas** | Lowest number of running replicas. | +| **Maximum Replicas** | Upper bound for replica count (define based on usage expectations). | +| **Monitored Metric** | The metric to be monitored. Choose between `CPU` or `RAM` for triggering autoscaling actions. | +| **Trigger Threshold (%)** | Average usage percentage used to trigger scaling up or down. Range: 1–100%. | > [!primary] > -> **High availability** will measure the average resource usage across its replicas and add instances if this average exceeds the specified average usage percentage threshold. -> -> Conversely, it will remove instances when this average resource utilisation falls below the threshold. +> Autoscaling adjusts by calculating the **average resource usage** across all replicas. If the average exceeds the threshold, new replicas are spun up; if it falls below, replicas are removed. > -**When to choose autoscaling?** +### When to Choose Autoscaling? + +- Your app has **irregular or fluctuating** inference/load patterns. +- You want to **scale cost-effectively** with actual usage. +- You are managing a **high-throughput application** with sudden demand spikes. + +### Setting Autoscaling (UI and CLI) + +> [!tabs] +> **Using the Control Panel (UI)** +>> +>> When creating your application, you will have the opportunity to choose your **scaling strategy**. By default, the strategy is set to **static scaling**. Toggle the button to switch to **Autoscaling** Then, configure minimum/maximum replicas, metric, and threshold. +>> +>> ![Set autoscaling on AI Deploy via UI](images/set-autoscaling.png){.thumbnail} +>> +> **Using ovhai CLI** +>> +>> Use the `ovhai app run` command with the following autoscaling parameters: +>> +>> ```bash +>> ovhai app run /: \ +>> --auto-min-replicas 1 \ +>> --auto-max-replicas 5 \ +>> --auto-resource-type CPU \ +>> --auto-resource-usage-threshold 75 +>> ``` +>> + +## Advanced: Custom Metrics for Autoscaling + +**Custom metrics are recommended for workloads such as GPU based inference where CPU and RAM usage provide an incomplete picture of the system’s performance or request load.** + +For advanced scenarios, you can define **custom metrics** to drive autoscaling decisions. This requires an API endpoint to fetch metrics from. + +### Required Parameter + +- `--auto-custom-api-url`: URL of the API operation to call to get the metric value. A specific `` placeholder can be given whenever metrics API is served by the deployed app itself. + +### Optional Parameters + +| Parameter | Description | +|--------------------------------|-----------------------------------------------------------------------------| +| `--auto-custom-value-location` | Specifies where the metric value is located in the API response payload. This value is format-specific. See the valueLocation from the parameters list in the [Trigger Specification documentation](https://keda.sh/docs/2.16/scalers/metrics-api/#trigger-specification) for details. | +| `--auto-custom-target-value` | Target value for metric to scale on. | +| `--auto-custom-metric-format` | Format of the metric to scale on (`JSON`, `XML`, `YAML`, `PROMETHEUS`). Default is `JSON`. | -- You can use autoscaling if you have irregular or sawtooth inference loads. +**Example**: + +Scaling based on a custom metric from an internal endpoint: + +```bash +ovhai app run /: \ + --auto-custom-api-url http://:6000/metrics \ + --auto-custom-value-location foo.bar \ + --auto-custom-target-value 42 \ + --auto-custom-metric-format JSON +``` + +## Modifying Scaling Strategies Post-Deployment + +You can also modify the scaling strategy after the app has been created using the `ovhai app scale` CLI command. This feature is not available on the UI. + +### Updating Static Scaling + +To change the number of replicas for a static scaling strategy, use the `ovhai app scale` command with the `--replicas` parameter: + +```bash +ovhai app scale --replicas +``` + +### Updating Autoscaling + +To change the autoscaling parameters, use the `ovhai app scale` command with the appropriate autoscaling parameters: + +```bash +ovhai app scale \ + --auto-min-replicas \ + --auto-max-replicas \ + --auto-resource-type \ + --auto-resource-usage-threshold \ + +``` ## Scaling example -We will use the following example: +We will use the following example: In case an app is based on the `AI1-1-CPU` flavor with a resource size of 2 (i.e. **2 CPUs**), this means that each replica of the application will be entitled to **2 vCores** and **8GiB RAM**. @@ -94,13 +191,11 @@ In this example, the app will be scaled up when the average RAM usage across all > [!primary] > -> The **total deployment price** will be calculated using the minimum number of replicas. -> +> The total deployment price for **autoscaling apps** is calculated based on the **minimum number of replicas**, **but** costs can **increase** during scaling. -> [!warning] -> -> The cost may increase as `Autoscaling` increases. -> +## Conclusion + +Choosing the right scaling strategy is critical for balancing cost, performance, and reliability in your AI Deploy applications. Static scaling offers stability and predictability, while autoscaling provides flexibility for dynamic workloads. ## Feedback diff --git a/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.fr-fr.md b/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.fr-fr.md index 71ceaae08f8..fb76bef3ec6 100644 --- a/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.fr-fr.md +++ b/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.fr-fr.md @@ -1,78 +1,175 @@ --- title: "AI Deploy - Stratégies de mise à l'échelle (EN)" -excerpt: Understand the scaling strategies (static scaling vs autoscaling) of AI Deploy -updated: 2023-04-04 +excerpt: Understand the scaling strategies (static scaling vs autoscaling) of AI Deploy and learn how to use them +updated: 2025-10-08 --- > [!primary] -> > AI Deploy is covered by **[OVHcloud Public Cloud Special Conditions](https://storage.gra.cloud.ovh.net/v1/AUTH_325716a587c64897acbef9a4a4726e38/contracts/d2a208c-Conditions_particulieres_OVH_Stack-WE-9.0.pdf)**. -> ## Objective -This guide covers the use of the different scaling strategies for AI Deploy. The objective is to explain the difference between **static scaling** and **autoscaling** so that you can choose the best solution depending on the use case and type of deployment. +This guide provides a comprehensive understanding of the different scaling strategies for AI Deploy. The objective is to explain the differences between **static scaling** and **autoscaling**, guide users on how to choose between them, set them during app creation, and explain how to modify scaling strategies once apps are created. ## Requirements -- a **Public Cloud** project -- access to the [OVHcloud Control Panel](/links/manager) -- start deploying an app and get to **Step 3**: `Resources` +- An active **Public Cloud** project. +- Access to the [OVHcloud Control Panel](/links/manager). +- The **OVHcloud AI CLI** (`ovhai`) installed. For installation instructions, see [how to install ovhai](/pages/public_cloud/ai_machine_learning/cli_10_howto_install_cli). ## Scaling principles -In the [OVHcloud Control Panel](/links/manager), it is possible to select the **resources** in `Step 3` of the app deployment. +When creating an application via the [OVHcloud Control Panel*** (UI) or the `ovhai` CLI, you can choose one of two scaling strategies: -This step allows you to choose between two scaling strategies: **static scaling** and **autoscaling**. +- **[Static Scaling](#static-scaling)**: Fixed number of running replicas. +- **[Autoscaling](#autoscaling)**: Dynamic replicas based on usage metrics (CPU/RAM or custom metrics). -### Static scaling +## Static Scaling -The **static scaling** strategy allows you to choose the number of replicas on which the app will be deployed. +### What is Static Scaling? + +Static scaling allows you to configure a **fixed number of replicas** (identical instances of your application) running at all times. This is the **default strategy** if not specified. The minimum number of replicas is **1** and the maximum is **10**. > [!warning] > -> It is recommended to deploy on a **minimum of 2 replicas** to have high availability! -> +> For **High Availability**, it is strongly recommended to deploy a **minimum of 2 replicas**. -**When to choose static scaling?** +### When to choose Static Scaling? -- Static scaling can be used if you want to have fixed costs. -- This scaling strategy is also useful when your consumption or inference load are fixed. +- You have **predictable, consistent workloads**. +- You prefer **fixed, predictable costs** with no unexpected resource usage spikes. +- Your use case requires **minimal latency**, as replicas are always active. -### Autoscaling +### Setting Static Scaling (UI and CLI) -With the autoscaling strategy, you can play on several parameters. +> [!tabs] +> **Using the Control Panel (UI)** +>> +>> When creating your application, you will have the opportunity to choose your **scaling strategy**. By default, the strategy is set to **static scaling**. To use this strategy, make sure that automatic scaling is not enabled. Then, you will be asked to choose the number of replicas on which your application will run. +>> +>> ![Set static scaling on AI Deploy via UI](images/set-static-scaling.png){.thumbnail} +>> +> **Using ovhai CLI** +>> +>> Use the `ovhai app run` command with the `--replicas` parameter to set the number of replicas at deployment: +>> +>> ```bash +>> ovhai app run /: \ +>> --replicas 2 \ +>> -- +>> ``` +>> -#### Minimum and maximum number of replicas +## Autoscaling -With the autoscaling strategy, it is possible to choose both the **minimum number of replicas** (1 by default) and the **maximum number of replicas**. +### What is Autoscaling? -#### Monitored metric +Autoscaling dynamically adjusts the number of application replicas based on **real-time metrics**, such as CPU or RAM usage. This is optimized for **workloads with varying demand**. -It is also possible to choose the metric to be monitored. This will act as a trigger for **autoscaling**. There are two metrics to choose from: `CPU` or `RAM`. +### Autoscaling Key Configuration Parameters -#### Trigger threshold +Using this strategy, it is possible to choose: -The threshold for the percentage of average use can also be chosen. It is an integer between 1 and 100%. - -The threshold of the average usage percentage will trigger the scaling (up or down) of the app replicas. +| Parameter | Description | +|----------------------------|-----------------------------------------------------------------------------------------------| +| **Minimum Replicas** | Lowest number of running replicas. | +| **Maximum Replicas** | Upper bound for replica count (define based on usage expectations). | +| **Monitored Metric** | The metric to be monitored. Choose between `CPU` or `RAM` for triggering autoscaling actions. | +| **Trigger Threshold (%)** | Average usage percentage used to trigger scaling up or down. Range: 1–100%. | > [!primary] > -> **High availability** will measure the average resource usage across its replicas and add instances if this average exceeds the specified average usage percentage threshold. -> -> Conversely, it will remove instances when this average resource utilisation falls below the threshold. +> Autoscaling adjusts by calculating the **average resource usage** across all replicas. If the average exceeds the threshold, new replicas are spun up; if it falls below, replicas are removed. > -**When to choose autoscaling?** +### When to Choose Autoscaling? + +- Your app has **irregular or fluctuating** inference/load patterns. +- You want to **scale cost-effectively** with actual usage. +- You are managing a **high-throughput application** with sudden demand spikes. + +### Setting Autoscaling (UI and CLI) + +> [!tabs] +> **Using the Control Panel (UI)** +>> +>> When creating your application, you will have the opportunity to choose your **scaling strategy**. By default, the strategy is set to **static scaling**. Toggle the button to switch to **Autoscaling** Then, configure minimum/maximum replicas, metric, and threshold. +>> +>> ![Set autoscaling on AI Deploy via UI](images/set-autoscaling.png){.thumbnail} +>> +> **Using ovhai CLI** +>> +>> Use the `ovhai app run` command with the following autoscaling parameters: +>> +>> ```bash +>> ovhai app run /: \ +>> --auto-min-replicas 1 \ +>> --auto-max-replicas 5 \ +>> --auto-resource-type CPU \ +>> --auto-resource-usage-threshold 75 +>> ``` +>> + +## Advanced: Custom Metrics for Autoscaling + +**Custom metrics are recommended for workloads such as GPU based inference where CPU and RAM usage provide an incomplete picture of the system’s performance or request load.** + +For advanced scenarios, you can define **custom metrics** to drive autoscaling decisions. This requires an API endpoint to fetch metrics from. + +### Required Parameter + +- `--auto-custom-api-url`: URL of the API operation to call to get the metric value. A specific `` placeholder can be given whenever metrics API is served by the deployed app itself. + +### Optional Parameters + +| Parameter | Description | +|--------------------------------|-----------------------------------------------------------------------------| +| `--auto-custom-value-location` | Specifies where the metric value is located in the API response payload. This value is format-specific. See the valueLocation from the parameters list in the [Trigger Specification documentation](https://keda.sh/docs/2.16/scalers/metrics-api/#trigger-specification) for details. | +| `--auto-custom-target-value` | Target value for metric to scale on. | +| `--auto-custom-metric-format` | Format of the metric to scale on (`JSON`, `XML`, `YAML`, `PROMETHEUS`). Default is `JSON`. | -- You can use autoscaling if you have irregular or sawtooth inference loads. +**Example**: + +Scaling based on a custom metric from an internal endpoint: + +```bash +ovhai app run /: \ + --auto-custom-api-url http://:6000/metrics \ + --auto-custom-value-location foo.bar \ + --auto-custom-target-value 42 \ + --auto-custom-metric-format JSON +``` + +## Modifying Scaling Strategies Post-Deployment + +You can also modify the scaling strategy after the app has been created using the `ovhai app scale` CLI command. This feature is not available on the UI. + +### Updating Static Scaling + +To change the number of replicas for a static scaling strategy, use the `ovhai app scale` command with the `--replicas` parameter: + +```bash +ovhai app scale --replicas +``` + +### Updating Autoscaling + +To change the autoscaling parameters, use the `ovhai app scale` command with the appropriate autoscaling parameters: + +```bash +ovhai app scale \ + --auto-min-replicas \ + --auto-max-replicas \ + --auto-resource-type \ + --auto-resource-usage-threshold \ + +``` ## Scaling example -We will use the following example: +We will use the following example: In case an app is based on the `AI1-1-CPU` flavor with a resource size of 2 (i.e. **2 CPUs**), this means that each replica of the application will be entitled to **2 vCores** and **8GiB RAM**. @@ -94,13 +191,11 @@ In this example, the app will be scaled up when the average RAM usage across all > [!primary] > -> The **total deployment price** will be calculated using the minimum number of replicas. -> +> The total deployment price for **autoscaling apps** is calculated based on the **minimum number of replicas**, **but** costs can **increase** during scaling. -> [!warning] -> -> The cost may increase as `Autoscaling` increases. -> +## Conclusion + +Choosing the right scaling strategy is critical for balancing cost, performance, and reliability in your AI Deploy applications. Static scaling offers stability and predictability, while autoscaling provides flexibility for dynamic workloads. ## Feedback diff --git a/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.it-it.md b/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.it-it.md index 0e9245d3044..632038e7195 100644 --- a/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.it-it.md +++ b/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.it-it.md @@ -1,78 +1,175 @@ --- title: AI Deploy - Scaling strategies -excerpt: Understand the scaling strategies (static scaling vs autoscaling) of AI Deploy -updated: 2023-04-04 +excerpt: Understand the scaling strategies (static scaling vs autoscaling) of AI Deploy and learn how to use them +updated: 2025-10-08 --- > [!primary] -> > AI Deploy is covered by **[OVHcloud Public Cloud Special Conditions](https://storage.gra.cloud.ovh.net/v1/AUTH_325716a587c64897acbef9a4a4726e38/contracts/d2a208c-Conditions_particulieres_OVH_Stack-WE-9.0.pdf)**. -> ## Objective -This guide covers the use of the different scaling strategies for AI Deploy. The objective is to explain the difference between **static scaling** and **autoscaling** so that you can choose the best solution depending on the use case and type of deployment. +This guide provides a comprehensive understanding of the different scaling strategies for AI Deploy. The objective is to explain the differences between **static scaling** and **autoscaling**, guide users on how to choose between them, set them during app creation, and explain how to modify scaling strategies once apps are created. ## Requirements -- a **Public Cloud** project -- access to the [OVHcloud Control Panel](/links/manager) -- start deploying an app and get to **Step 3**: `Resources` +- An active **Public Cloud** project. +- Access to the [OVHcloud Control Panel](/links/manager). +- The **OVHcloud AI CLI** (`ovhai`) installed. For installation instructions, see [how to install ovhai](/pages/public_cloud/ai_machine_learning/cli_10_howto_install_cli). ## Scaling principles -In the [OVHcloud Control Panel](/links/manager), it is possible to select the **resources** in `Step 3` of the app deployment. +When creating an application via the [OVHcloud Control Panel*** (UI) or the `ovhai` CLI, you can choose one of two scaling strategies: -This step allows you to choose between two scaling strategies: **static scaling** and **autoscaling**. +- **[Static Scaling](#static-scaling)**: Fixed number of running replicas. +- **[Autoscaling](#autoscaling)**: Dynamic replicas based on usage metrics (CPU/RAM or custom metrics). -### Static scaling +## Static Scaling -The **static scaling** strategy allows you to choose the number of replicas on which the app will be deployed. +### What is Static Scaling? + +Static scaling allows you to configure a **fixed number of replicas** (identical instances of your application) running at all times. This is the **default strategy** if not specified. The minimum number of replicas is **1** and the maximum is **10**. > [!warning] > -> It is recommended to deploy on a **minimum of 2 replicas** to have high availability! -> +> For **High Availability**, it is strongly recommended to deploy a **minimum of 2 replicas**. -**When to choose static scaling?** +### When to choose Static Scaling? -- Static scaling can be used if you want to have fixed costs. -- This scaling strategy is also useful when your consumption or inference load are fixed. +- You have **predictable, consistent workloads**. +- You prefer **fixed, predictable costs** with no unexpected resource usage spikes. +- Your use case requires **minimal latency**, as replicas are always active. -### Autoscaling +### Setting Static Scaling (UI and CLI) -With the autoscaling strategy, you can play on several parameters. +> [!tabs] +> **Using the Control Panel (UI)** +>> +>> When creating your application, you will have the opportunity to choose your **scaling strategy**. By default, the strategy is set to **static scaling**. To use this strategy, make sure that automatic scaling is not enabled. Then, you will be asked to choose the number of replicas on which your application will run. +>> +>> ![Set static scaling on AI Deploy via UI](images/set-static-scaling.png){.thumbnail} +>> +> **Using ovhai CLI** +>> +>> Use the `ovhai app run` command with the `--replicas` parameter to set the number of replicas at deployment: +>> +>> ```bash +>> ovhai app run /: \ +>> --replicas 2 \ +>> -- +>> ``` +>> -#### Minimum and maximum number of replicas +## Autoscaling -With the autoscaling strategy, it is possible to choose both the **minimum number of replicas** (1 by default) and the **maximum number of replicas**. +### What is Autoscaling? -#### Monitored metric +Autoscaling dynamically adjusts the number of application replicas based on **real-time metrics**, such as CPU or RAM usage. This is optimized for **workloads with varying demand**. -It is also possible to choose the metric to be monitored. This will act as a trigger for **autoscaling**. There are two metrics to choose from: `CPU` or `RAM`. +### Autoscaling Key Configuration Parameters -#### Trigger threshold +Using this strategy, it is possible to choose: -The threshold for the percentage of average use can also be chosen. It is an integer between 1 and 100%. - -The threshold of the average usage percentage will trigger the scaling (up or down) of the app replicas. +| Parameter | Description | +|----------------------------|-----------------------------------------------------------------------------------------------| +| **Minimum Replicas** | Lowest number of running replicas. | +| **Maximum Replicas** | Upper bound for replica count (define based on usage expectations). | +| **Monitored Metric** | The metric to be monitored. Choose between `CPU` or `RAM` for triggering autoscaling actions. | +| **Trigger Threshold (%)** | Average usage percentage used to trigger scaling up or down. Range: 1–100%. | > [!primary] > -> **High availability** will measure the average resource usage across its replicas and add instances if this average exceeds the specified average usage percentage threshold. -> -> Conversely, it will remove instances when this average resource utilisation falls below the threshold. +> Autoscaling adjusts by calculating the **average resource usage** across all replicas. If the average exceeds the threshold, new replicas are spun up; if it falls below, replicas are removed. > -**When to choose autoscaling?** +### When to Choose Autoscaling? + +- Your app has **irregular or fluctuating** inference/load patterns. +- You want to **scale cost-effectively** with actual usage. +- You are managing a **high-throughput application** with sudden demand spikes. + +### Setting Autoscaling (UI and CLI) + +> [!tabs] +> **Using the Control Panel (UI)** +>> +>> When creating your application, you will have the opportunity to choose your **scaling strategy**. By default, the strategy is set to **static scaling**. Toggle the button to switch to **Autoscaling** Then, configure minimum/maximum replicas, metric, and threshold. +>> +>> ![Set autoscaling on AI Deploy via UI](images/set-autoscaling.png){.thumbnail} +>> +> **Using ovhai CLI** +>> +>> Use the `ovhai app run` command with the following autoscaling parameters: +>> +>> ```bash +>> ovhai app run /: \ +>> --auto-min-replicas 1 \ +>> --auto-max-replicas 5 \ +>> --auto-resource-type CPU \ +>> --auto-resource-usage-threshold 75 +>> ``` +>> + +## Advanced: Custom Metrics for Autoscaling + +**Custom metrics are recommended for workloads such as GPU based inference where CPU and RAM usage provide an incomplete picture of the system’s performance or request load.** + +For advanced scenarios, you can define **custom metrics** to drive autoscaling decisions. This requires an API endpoint to fetch metrics from. + +### Required Parameter + +- `--auto-custom-api-url`: URL of the API operation to call to get the metric value. A specific `` placeholder can be given whenever metrics API is served by the deployed app itself. + +### Optional Parameters + +| Parameter | Description | +|--------------------------------|-----------------------------------------------------------------------------| +| `--auto-custom-value-location` | Specifies where the metric value is located in the API response payload. This value is format-specific. See the valueLocation from the parameters list in the [Trigger Specification documentation](https://keda.sh/docs/2.16/scalers/metrics-api/#trigger-specification) for details. | +| `--auto-custom-target-value` | Target value for metric to scale on. | +| `--auto-custom-metric-format` | Format of the metric to scale on (`JSON`, `XML`, `YAML`, `PROMETHEUS`). Default is `JSON`. | -- You can use autoscaling if you have irregular or sawtooth inference loads. +**Example**: + +Scaling based on a custom metric from an internal endpoint: + +```bash +ovhai app run /: \ + --auto-custom-api-url http://:6000/metrics \ + --auto-custom-value-location foo.bar \ + --auto-custom-target-value 42 \ + --auto-custom-metric-format JSON +``` + +## Modifying Scaling Strategies Post-Deployment + +You can also modify the scaling strategy after the app has been created using the `ovhai app scale` CLI command. This feature is not available on the UI. + +### Updating Static Scaling + +To change the number of replicas for a static scaling strategy, use the `ovhai app scale` command with the `--replicas` parameter: + +```bash +ovhai app scale --replicas +``` + +### Updating Autoscaling + +To change the autoscaling parameters, use the `ovhai app scale` command with the appropriate autoscaling parameters: + +```bash +ovhai app scale \ + --auto-min-replicas \ + --auto-max-replicas \ + --auto-resource-type \ + --auto-resource-usage-threshold \ + +``` ## Scaling example -We will use the following example: +We will use the following example: In case an app is based on the `AI1-1-CPU` flavor with a resource size of 2 (i.e. **2 CPUs**), this means that each replica of the application will be entitled to **2 vCores** and **8GiB RAM**. @@ -94,13 +191,11 @@ In this example, the app will be scaled up when the average RAM usage across all > [!primary] > -> The **total deployment price** will be calculated using the minimum number of replicas. -> +> The total deployment price for **autoscaling apps** is calculated based on the **minimum number of replicas**, **but** costs can **increase** during scaling. -> [!warning] -> -> The cost may increase as `Autoscaling` increases. -> +## Conclusion + +Choosing the right scaling strategy is critical for balancing cost, performance, and reliability in your AI Deploy applications. Static scaling offers stability and predictability, while autoscaling provides flexibility for dynamic workloads. ## Feedback diff --git a/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.pl-pl.md b/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.pl-pl.md index 0e9245d3044..632038e7195 100644 --- a/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.pl-pl.md +++ b/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.pl-pl.md @@ -1,78 +1,175 @@ --- title: AI Deploy - Scaling strategies -excerpt: Understand the scaling strategies (static scaling vs autoscaling) of AI Deploy -updated: 2023-04-04 +excerpt: Understand the scaling strategies (static scaling vs autoscaling) of AI Deploy and learn how to use them +updated: 2025-10-08 --- > [!primary] -> > AI Deploy is covered by **[OVHcloud Public Cloud Special Conditions](https://storage.gra.cloud.ovh.net/v1/AUTH_325716a587c64897acbef9a4a4726e38/contracts/d2a208c-Conditions_particulieres_OVH_Stack-WE-9.0.pdf)**. -> ## Objective -This guide covers the use of the different scaling strategies for AI Deploy. The objective is to explain the difference between **static scaling** and **autoscaling** so that you can choose the best solution depending on the use case and type of deployment. +This guide provides a comprehensive understanding of the different scaling strategies for AI Deploy. The objective is to explain the differences between **static scaling** and **autoscaling**, guide users on how to choose between them, set them during app creation, and explain how to modify scaling strategies once apps are created. ## Requirements -- a **Public Cloud** project -- access to the [OVHcloud Control Panel](/links/manager) -- start deploying an app and get to **Step 3**: `Resources` +- An active **Public Cloud** project. +- Access to the [OVHcloud Control Panel](/links/manager). +- The **OVHcloud AI CLI** (`ovhai`) installed. For installation instructions, see [how to install ovhai](/pages/public_cloud/ai_machine_learning/cli_10_howto_install_cli). ## Scaling principles -In the [OVHcloud Control Panel](/links/manager), it is possible to select the **resources** in `Step 3` of the app deployment. +When creating an application via the [OVHcloud Control Panel*** (UI) or the `ovhai` CLI, you can choose one of two scaling strategies: -This step allows you to choose between two scaling strategies: **static scaling** and **autoscaling**. +- **[Static Scaling](#static-scaling)**: Fixed number of running replicas. +- **[Autoscaling](#autoscaling)**: Dynamic replicas based on usage metrics (CPU/RAM or custom metrics). -### Static scaling +## Static Scaling -The **static scaling** strategy allows you to choose the number of replicas on which the app will be deployed. +### What is Static Scaling? + +Static scaling allows you to configure a **fixed number of replicas** (identical instances of your application) running at all times. This is the **default strategy** if not specified. The minimum number of replicas is **1** and the maximum is **10**. > [!warning] > -> It is recommended to deploy on a **minimum of 2 replicas** to have high availability! -> +> For **High Availability**, it is strongly recommended to deploy a **minimum of 2 replicas**. -**When to choose static scaling?** +### When to choose Static Scaling? -- Static scaling can be used if you want to have fixed costs. -- This scaling strategy is also useful when your consumption or inference load are fixed. +- You have **predictable, consistent workloads**. +- You prefer **fixed, predictable costs** with no unexpected resource usage spikes. +- Your use case requires **minimal latency**, as replicas are always active. -### Autoscaling +### Setting Static Scaling (UI and CLI) -With the autoscaling strategy, you can play on several parameters. +> [!tabs] +> **Using the Control Panel (UI)** +>> +>> When creating your application, you will have the opportunity to choose your **scaling strategy**. By default, the strategy is set to **static scaling**. To use this strategy, make sure that automatic scaling is not enabled. Then, you will be asked to choose the number of replicas on which your application will run. +>> +>> ![Set static scaling on AI Deploy via UI](images/set-static-scaling.png){.thumbnail} +>> +> **Using ovhai CLI** +>> +>> Use the `ovhai app run` command with the `--replicas` parameter to set the number of replicas at deployment: +>> +>> ```bash +>> ovhai app run /: \ +>> --replicas 2 \ +>> -- +>> ``` +>> -#### Minimum and maximum number of replicas +## Autoscaling -With the autoscaling strategy, it is possible to choose both the **minimum number of replicas** (1 by default) and the **maximum number of replicas**. +### What is Autoscaling? -#### Monitored metric +Autoscaling dynamically adjusts the number of application replicas based on **real-time metrics**, such as CPU or RAM usage. This is optimized for **workloads with varying demand**. -It is also possible to choose the metric to be monitored. This will act as a trigger for **autoscaling**. There are two metrics to choose from: `CPU` or `RAM`. +### Autoscaling Key Configuration Parameters -#### Trigger threshold +Using this strategy, it is possible to choose: -The threshold for the percentage of average use can also be chosen. It is an integer between 1 and 100%. - -The threshold of the average usage percentage will trigger the scaling (up or down) of the app replicas. +| Parameter | Description | +|----------------------------|-----------------------------------------------------------------------------------------------| +| **Minimum Replicas** | Lowest number of running replicas. | +| **Maximum Replicas** | Upper bound for replica count (define based on usage expectations). | +| **Monitored Metric** | The metric to be monitored. Choose between `CPU` or `RAM` for triggering autoscaling actions. | +| **Trigger Threshold (%)** | Average usage percentage used to trigger scaling up or down. Range: 1–100%. | > [!primary] > -> **High availability** will measure the average resource usage across its replicas and add instances if this average exceeds the specified average usage percentage threshold. -> -> Conversely, it will remove instances when this average resource utilisation falls below the threshold. +> Autoscaling adjusts by calculating the **average resource usage** across all replicas. If the average exceeds the threshold, new replicas are spun up; if it falls below, replicas are removed. > -**When to choose autoscaling?** +### When to Choose Autoscaling? + +- Your app has **irregular or fluctuating** inference/load patterns. +- You want to **scale cost-effectively** with actual usage. +- You are managing a **high-throughput application** with sudden demand spikes. + +### Setting Autoscaling (UI and CLI) + +> [!tabs] +> **Using the Control Panel (UI)** +>> +>> When creating your application, you will have the opportunity to choose your **scaling strategy**. By default, the strategy is set to **static scaling**. Toggle the button to switch to **Autoscaling** Then, configure minimum/maximum replicas, metric, and threshold. +>> +>> ![Set autoscaling on AI Deploy via UI](images/set-autoscaling.png){.thumbnail} +>> +> **Using ovhai CLI** +>> +>> Use the `ovhai app run` command with the following autoscaling parameters: +>> +>> ```bash +>> ovhai app run /: \ +>> --auto-min-replicas 1 \ +>> --auto-max-replicas 5 \ +>> --auto-resource-type CPU \ +>> --auto-resource-usage-threshold 75 +>> ``` +>> + +## Advanced: Custom Metrics for Autoscaling + +**Custom metrics are recommended for workloads such as GPU based inference where CPU and RAM usage provide an incomplete picture of the system’s performance or request load.** + +For advanced scenarios, you can define **custom metrics** to drive autoscaling decisions. This requires an API endpoint to fetch metrics from. + +### Required Parameter + +- `--auto-custom-api-url`: URL of the API operation to call to get the metric value. A specific `` placeholder can be given whenever metrics API is served by the deployed app itself. + +### Optional Parameters + +| Parameter | Description | +|--------------------------------|-----------------------------------------------------------------------------| +| `--auto-custom-value-location` | Specifies where the metric value is located in the API response payload. This value is format-specific. See the valueLocation from the parameters list in the [Trigger Specification documentation](https://keda.sh/docs/2.16/scalers/metrics-api/#trigger-specification) for details. | +| `--auto-custom-target-value` | Target value for metric to scale on. | +| `--auto-custom-metric-format` | Format of the metric to scale on (`JSON`, `XML`, `YAML`, `PROMETHEUS`). Default is `JSON`. | -- You can use autoscaling if you have irregular or sawtooth inference loads. +**Example**: + +Scaling based on a custom metric from an internal endpoint: + +```bash +ovhai app run /: \ + --auto-custom-api-url http://:6000/metrics \ + --auto-custom-value-location foo.bar \ + --auto-custom-target-value 42 \ + --auto-custom-metric-format JSON +``` + +## Modifying Scaling Strategies Post-Deployment + +You can also modify the scaling strategy after the app has been created using the `ovhai app scale` CLI command. This feature is not available on the UI. + +### Updating Static Scaling + +To change the number of replicas for a static scaling strategy, use the `ovhai app scale` command with the `--replicas` parameter: + +```bash +ovhai app scale --replicas +``` + +### Updating Autoscaling + +To change the autoscaling parameters, use the `ovhai app scale` command with the appropriate autoscaling parameters: + +```bash +ovhai app scale \ + --auto-min-replicas \ + --auto-max-replicas \ + --auto-resource-type \ + --auto-resource-usage-threshold \ + +``` ## Scaling example -We will use the following example: +We will use the following example: In case an app is based on the `AI1-1-CPU` flavor with a resource size of 2 (i.e. **2 CPUs**), this means that each replica of the application will be entitled to **2 vCores** and **8GiB RAM**. @@ -94,13 +191,11 @@ In this example, the app will be scaled up when the average RAM usage across all > [!primary] > -> The **total deployment price** will be calculated using the minimum number of replicas. -> +> The total deployment price for **autoscaling apps** is calculated based on the **minimum number of replicas**, **but** costs can **increase** during scaling. -> [!warning] -> -> The cost may increase as `Autoscaling` increases. -> +## Conclusion + +Choosing the right scaling strategy is critical for balancing cost, performance, and reliability in your AI Deploy applications. Static scaling offers stability and predictability, while autoscaling provides flexibility for dynamic workloads. ## Feedback diff --git a/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.pt-pt.md b/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.pt-pt.md index 0e9245d3044..632038e7195 100644 --- a/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.pt-pt.md +++ b/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/guide.pt-pt.md @@ -1,78 +1,175 @@ --- title: AI Deploy - Scaling strategies -excerpt: Understand the scaling strategies (static scaling vs autoscaling) of AI Deploy -updated: 2023-04-04 +excerpt: Understand the scaling strategies (static scaling vs autoscaling) of AI Deploy and learn how to use them +updated: 2025-10-08 --- > [!primary] -> > AI Deploy is covered by **[OVHcloud Public Cloud Special Conditions](https://storage.gra.cloud.ovh.net/v1/AUTH_325716a587c64897acbef9a4a4726e38/contracts/d2a208c-Conditions_particulieres_OVH_Stack-WE-9.0.pdf)**. -> ## Objective -This guide covers the use of the different scaling strategies for AI Deploy. The objective is to explain the difference between **static scaling** and **autoscaling** so that you can choose the best solution depending on the use case and type of deployment. +This guide provides a comprehensive understanding of the different scaling strategies for AI Deploy. The objective is to explain the differences between **static scaling** and **autoscaling**, guide users on how to choose between them, set them during app creation, and explain how to modify scaling strategies once apps are created. ## Requirements -- a **Public Cloud** project -- access to the [OVHcloud Control Panel](/links/manager) -- start deploying an app and get to **Step 3**: `Resources` +- An active **Public Cloud** project. +- Access to the [OVHcloud Control Panel](/links/manager). +- The **OVHcloud AI CLI** (`ovhai`) installed. For installation instructions, see [how to install ovhai](/pages/public_cloud/ai_machine_learning/cli_10_howto_install_cli). ## Scaling principles -In the [OVHcloud Control Panel](/links/manager), it is possible to select the **resources** in `Step 3` of the app deployment. +When creating an application via the [OVHcloud Control Panel*** (UI) or the `ovhai` CLI, you can choose one of two scaling strategies: -This step allows you to choose between two scaling strategies: **static scaling** and **autoscaling**. +- **[Static Scaling](#static-scaling)**: Fixed number of running replicas. +- **[Autoscaling](#autoscaling)**: Dynamic replicas based on usage metrics (CPU/RAM or custom metrics). -### Static scaling +## Static Scaling -The **static scaling** strategy allows you to choose the number of replicas on which the app will be deployed. +### What is Static Scaling? + +Static scaling allows you to configure a **fixed number of replicas** (identical instances of your application) running at all times. This is the **default strategy** if not specified. The minimum number of replicas is **1** and the maximum is **10**. > [!warning] > -> It is recommended to deploy on a **minimum of 2 replicas** to have high availability! -> +> For **High Availability**, it is strongly recommended to deploy a **minimum of 2 replicas**. -**When to choose static scaling?** +### When to choose Static Scaling? -- Static scaling can be used if you want to have fixed costs. -- This scaling strategy is also useful when your consumption or inference load are fixed. +- You have **predictable, consistent workloads**. +- You prefer **fixed, predictable costs** with no unexpected resource usage spikes. +- Your use case requires **minimal latency**, as replicas are always active. -### Autoscaling +### Setting Static Scaling (UI and CLI) -With the autoscaling strategy, you can play on several parameters. +> [!tabs] +> **Using the Control Panel (UI)** +>> +>> When creating your application, you will have the opportunity to choose your **scaling strategy**. By default, the strategy is set to **static scaling**. To use this strategy, make sure that automatic scaling is not enabled. Then, you will be asked to choose the number of replicas on which your application will run. +>> +>> ![Set static scaling on AI Deploy via UI](images/set-static-scaling.png){.thumbnail} +>> +> **Using ovhai CLI** +>> +>> Use the `ovhai app run` command with the `--replicas` parameter to set the number of replicas at deployment: +>> +>> ```bash +>> ovhai app run /: \ +>> --replicas 2 \ +>> -- +>> ``` +>> -#### Minimum and maximum number of replicas +## Autoscaling -With the autoscaling strategy, it is possible to choose both the **minimum number of replicas** (1 by default) and the **maximum number of replicas**. +### What is Autoscaling? -#### Monitored metric +Autoscaling dynamically adjusts the number of application replicas based on **real-time metrics**, such as CPU or RAM usage. This is optimized for **workloads with varying demand**. -It is also possible to choose the metric to be monitored. This will act as a trigger for **autoscaling**. There are two metrics to choose from: `CPU` or `RAM`. +### Autoscaling Key Configuration Parameters -#### Trigger threshold +Using this strategy, it is possible to choose: -The threshold for the percentage of average use can also be chosen. It is an integer between 1 and 100%. - -The threshold of the average usage percentage will trigger the scaling (up or down) of the app replicas. +| Parameter | Description | +|----------------------------|-----------------------------------------------------------------------------------------------| +| **Minimum Replicas** | Lowest number of running replicas. | +| **Maximum Replicas** | Upper bound for replica count (define based on usage expectations). | +| **Monitored Metric** | The metric to be monitored. Choose between `CPU` or `RAM` for triggering autoscaling actions. | +| **Trigger Threshold (%)** | Average usage percentage used to trigger scaling up or down. Range: 1–100%. | > [!primary] > -> **High availability** will measure the average resource usage across its replicas and add instances if this average exceeds the specified average usage percentage threshold. -> -> Conversely, it will remove instances when this average resource utilisation falls below the threshold. +> Autoscaling adjusts by calculating the **average resource usage** across all replicas. If the average exceeds the threshold, new replicas are spun up; if it falls below, replicas are removed. > -**When to choose autoscaling?** +### When to Choose Autoscaling? + +- Your app has **irregular or fluctuating** inference/load patterns. +- You want to **scale cost-effectively** with actual usage. +- You are managing a **high-throughput application** with sudden demand spikes. + +### Setting Autoscaling (UI and CLI) + +> [!tabs] +> **Using the Control Panel (UI)** +>> +>> When creating your application, you will have the opportunity to choose your **scaling strategy**. By default, the strategy is set to **static scaling**. Toggle the button to switch to **Autoscaling** Then, configure minimum/maximum replicas, metric, and threshold. +>> +>> ![Set autoscaling on AI Deploy via UI](images/set-autoscaling.png){.thumbnail} +>> +> **Using ovhai CLI** +>> +>> Use the `ovhai app run` command with the following autoscaling parameters: +>> +>> ```bash +>> ovhai app run /: \ +>> --auto-min-replicas 1 \ +>> --auto-max-replicas 5 \ +>> --auto-resource-type CPU \ +>> --auto-resource-usage-threshold 75 +>> ``` +>> + +## Advanced: Custom Metrics for Autoscaling + +**Custom metrics are recommended for workloads such as GPU based inference where CPU and RAM usage provide an incomplete picture of the system’s performance or request load.** + +For advanced scenarios, you can define **custom metrics** to drive autoscaling decisions. This requires an API endpoint to fetch metrics from. + +### Required Parameter + +- `--auto-custom-api-url`: URL of the API operation to call to get the metric value. A specific `` placeholder can be given whenever metrics API is served by the deployed app itself. + +### Optional Parameters + +| Parameter | Description | +|--------------------------------|-----------------------------------------------------------------------------| +| `--auto-custom-value-location` | Specifies where the metric value is located in the API response payload. This value is format-specific. See the valueLocation from the parameters list in the [Trigger Specification documentation](https://keda.sh/docs/2.16/scalers/metrics-api/#trigger-specification) for details. | +| `--auto-custom-target-value` | Target value for metric to scale on. | +| `--auto-custom-metric-format` | Format of the metric to scale on (`JSON`, `XML`, `YAML`, `PROMETHEUS`). Default is `JSON`. | -- You can use autoscaling if you have irregular or sawtooth inference loads. +**Example**: + +Scaling based on a custom metric from an internal endpoint: + +```bash +ovhai app run /: \ + --auto-custom-api-url http://:6000/metrics \ + --auto-custom-value-location foo.bar \ + --auto-custom-target-value 42 \ + --auto-custom-metric-format JSON +``` + +## Modifying Scaling Strategies Post-Deployment + +You can also modify the scaling strategy after the app has been created using the `ovhai app scale` CLI command. This feature is not available on the UI. + +### Updating Static Scaling + +To change the number of replicas for a static scaling strategy, use the `ovhai app scale` command with the `--replicas` parameter: + +```bash +ovhai app scale --replicas +``` + +### Updating Autoscaling + +To change the autoscaling parameters, use the `ovhai app scale` command with the appropriate autoscaling parameters: + +```bash +ovhai app scale \ + --auto-min-replicas \ + --auto-max-replicas \ + --auto-resource-type \ + --auto-resource-usage-threshold \ + +``` ## Scaling example -We will use the following example: +We will use the following example: In case an app is based on the `AI1-1-CPU` flavor with a resource size of 2 (i.e. **2 CPUs**), this means that each replica of the application will be entitled to **2 vCores** and **8GiB RAM**. @@ -94,13 +191,11 @@ In this example, the app will be scaled up when the average RAM usage across all > [!primary] > -> The **total deployment price** will be calculated using the minimum number of replicas. -> +> The total deployment price for **autoscaling apps** is calculated based on the **minimum number of replicas**, **but** costs can **increase** during scaling. -> [!warning] -> -> The cost may increase as `Autoscaling` increases. -> +## Conclusion + +Choosing the right scaling strategy is critical for balancing cost, performance, and reliability in your AI Deploy applications. Static scaling offers stability and predictability, while autoscaling provides flexibility for dynamic workloads. ## Feedback diff --git a/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/images/set-autoscaling.png b/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/images/set-autoscaling.png new file mode 100644 index 00000000000..c1b314575c4 Binary files /dev/null and b/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/images/set-autoscaling.png differ diff --git a/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/images/set-static-scaling.png b/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/images/set-static-scaling.png new file mode 100644 index 00000000000..fdc821c4982 Binary files /dev/null and b/pages/public_cloud/ai_machine_learning/deploy_guide_04_scaling_strategies/images/set-static-scaling.png differ diff --git a/pages/public_cloud/ai_machine_learning/deploy_tuto_19_flux/guide.en-gb.md b/pages/public_cloud/ai_machine_learning/deploy_tuto_19_flux/guide.en-gb.md index aa5056a8263..07ea66792c2 100644 --- a/pages/public_cloud/ai_machine_learning/deploy_tuto_19_flux/guide.en-gb.md +++ b/pages/public_cloud/ai_machine_learning/deploy_tuto_19_flux/guide.en-gb.md @@ -323,6 +323,7 @@ Run the following command to deploy your application: >> --env VAE_FILE=ae.safetensors \ >> --env CLIP_FILE_1=clip_l.safetensors \ >> --env CLIP_FILE_2=t5xxl_fp16.safetensors +>> ``` >> > **Kontext Dev** >> diff --git a/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.de-de.md b/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.de-de.md index 9300bb7df3e..06b8cc06df4 100644 --- a/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.de-de.md +++ b/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.de-de.md @@ -1,7 +1,7 @@ --- title: AI Endpoints - Billing and lifecycle excerpt: Learn how we bill AI Endpoints -updated: 2025-09-04 +updated: 2025-10-20 --- > [!primary] @@ -24,46 +24,16 @@ OVHcloud AI Endpoints follows a model lifecycle process to ensure a seamless exp - **Track model usage metrics**: We continuously monitor the usage of each model on our platform to identify underutilized or obsolete models that may no longer serve the needs of our customers. - **Decommissioning decision**: Once a model is identified as a candidate for decommissioning, we make a decision to retire the model. At this point, we communicate the decision to our customers through official deprecation notices on our website and the #ai-endpoints channel of the OVHcloud [Discord server](https://discord.gg/ovhcloud). - **Grace period**: After the deprecation notice is published, a grace period of 30 days is provided for all models except embedding models, which will have a grace period of 3 months. This period allows customers to transition to an alternative model. During this time, we offer guidance on recommended replacements and migration steps to ensure a smooth transition. -- **Removal from active deployment**: Once the grace period ends, the model is removed from active deployment. However, to ensure continuity, we may redirect API calls to the replacement model (if applicable) with a 10-second delay before the decommissioned model responds, signaling to users that the model is no longer in active use. +- **Removal from active deployment**: Once the grace period ends, the model is removed from active deployment. - **AI Endpoints changelog**: Decommissionings are highlighted in the [AI Endpoints Changelog](https://endpoints.ai.cloud.ovh.net/changelog), ensuring that customers are informed about the changes in the platform. By following this model lifecycle process, OVHcloud ensures that customers are well-informed and prepared for any changes, while also maintaining a lean and up-to-date selection of AI models. ## Billing principles -Here is the model billing overview for AI Endpoints models: - -| Category | Model | Input Price (\$) | Output Price (\$) | Input Price (€) | Output Price (€) | Unit Price | -| -------------------------- | -------------------------- | ---------------- | ----------------- | --------------- | ---------------- | --------------------------------- | -| Large Language Model (LLM) | Llama 3.3 70B Instruct | 0.74 | 0.74 | 0.67 | 0.67 | Per 1 million tokens | -| Large Language Model (LLM) | Llama 3.1 70B Instruct | 0.74 | 0.74 | 0.67 | 0.67 | Per 1 million tokens | -| Large Language Model (LLM) | Mixtral 8x7B Instruct v0.1 | 0.70 | 0.70 | 0.63 | 0.63 | Per 1 million tokens | -| Large Language Model (LLM) | Mistral Nemo Instruct 2407 | 0.14 | 0.14 | 0.13 | 0.13 | Per 1 million tokens | -| Large Language Model (LLM) | Llama 3.1 8B Instruct | 0.11 | 0.11 | 0.10 | 0.10 | Per 1 million tokens | -| Large Language Model (LLM) | Mistral 7B Instruct v0.3 | 0.11 | 0.11 | 0.10 | 0.10 | Per 1 million tokens | -| Reasoning LLM | Gpt Oss 120B | 0.09 | 0.44 | 0.08 | 0.40 | Per 1 million tokens | -| Reasoning LLM | Gpt Oss 20B | 0.04 | 0.17 | 0.04 | 0.15 | Per 1 million tokens | -| Reasoning LLM | Qwen 3 32B | 0.09 | 0.25 | 0.08 | 0.23 | Per 1 million tokens | -| Reasoning LLM | DeepSeek R1 Distill Llama 70B | 0.74 | 0.74 | 0.67 | 0.67 | Per 1 million tokens | -| Code LLM | Qwen 2.5 Coder 32B Instruct | 0.96 | 0.96 | 0.87 | 0.87 | Per 1 million tokens | -| Code LLM | Mamba Codestral 7B v0.1 | 0.21 | 0.21 | 0.19 | 0.19 | Per 1 million tokens | -| Visual LLM | Mistral Small 3.2 24B Instruct 2506 | 0.10 | 0.31 | 0.09 | 0.28 | Per 1 million tokens | -| Visual LLM | Qwen 2.5 VL 72B Instruct | 1.01 | 1.01 | 0.91 | 0.91 | Per 1 million tokens | -| Visual LLM | Llava Next Mistral 7B | 0.32 | 0.32 | 0.29 | 0.29 | Per 1 million tokens | -| Embeddings | BGE Multilingual Gemma2 | 0.01 | 0.01 | Free | Free | Per 1 million tokens | -| Embeddings | BGE M3 | 0.01 | 0.01 | Free | Free | Per 1 million tokens | -| Embeddings | BGE Base EN v1.5 | 0.01 | 0.01 | Free | Free | Per 1 million tokens | -| Natural Language Processing (NLP) | Roberta Base Go Emotions | Free | Free | Free | Free | Per 1 million characters | -| Natural Language Processing (NLP) | Bert Base Multilingual uncased sentiment | Free | Free | Free | Free | Per 1 million characters | -| Natural Language Processing (NLP) | Bert Base NER | Free | Free | Free | Free | Per 1 million characters | -| Natural Language Processing (NLP) | Bart Large CNN | Free | Free | Free | Free | Per 1 million characters | -| Image generation | Stable Diffusion XL | Free | Free | Free | Free | Per image | -| Audio Analysis | Whisper Large V3 Turbo | 0.00001413468 | Free | 0.00001278 | Free | Per second | -| Audio Analysis | Whisper Large V3 | 0.00004515798 | Free | 0.00004083 | Free | Per second | -| Audio Analysis | RIVA Text-to-Speech | Free | Free | Free | Free | Per second | -| Translation | T5-Large | Free | Free | Free | Free | Per 1 million characters | -| Computer vision | YOLOv11 Object Detection | Free | Free | Free | Free | Per image | -| Computer vision | YOLOv11 Image Segmentation | Free | Free | Free | Free | Per image | +For detailed information on models, quantization, pricing units, and prices, please visit the `AI Endpoints`{.action} section of the `AI and Machine Learning` drop-down menu, on the [OVHcloud website](/links/public-cloud/prices-ai): + +![ai-endpoints-pricing-overview](images/pricing-overview.png){.thumbnail} ## Feedback diff --git a/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.en-asia.md b/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.en-asia.md index 9300bb7df3e..06b8cc06df4 100644 --- a/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.en-asia.md +++ b/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.en-asia.md @@ -1,7 +1,7 @@ --- title: AI Endpoints - Billing and lifecycle excerpt: Learn how we bill AI Endpoints -updated: 2025-09-04 +updated: 2025-10-20 --- > [!primary] @@ -24,46 +24,16 @@ OVHcloud AI Endpoints follows a model lifecycle process to ensure a seamless exp - **Track model usage metrics**: We continuously monitor the usage of each model on our platform to identify underutilized or obsolete models that may no longer serve the needs of our customers. - **Decommissioning decision**: Once a model is identified as a candidate for decommissioning, we make a decision to retire the model. At this point, we communicate the decision to our customers through official deprecation notices on our website and the #ai-endpoints channel of the OVHcloud [Discord server](https://discord.gg/ovhcloud). - **Grace period**: After the deprecation notice is published, a grace period of 30 days is provided for all models except embedding models, which will have a grace period of 3 months. This period allows customers to transition to an alternative model. During this time, we offer guidance on recommended replacements and migration steps to ensure a smooth transition. -- **Removal from active deployment**: Once the grace period ends, the model is removed from active deployment. However, to ensure continuity, we may redirect API calls to the replacement model (if applicable) with a 10-second delay before the decommissioned model responds, signaling to users that the model is no longer in active use. +- **Removal from active deployment**: Once the grace period ends, the model is removed from active deployment. - **AI Endpoints changelog**: Decommissionings are highlighted in the [AI Endpoints Changelog](https://endpoints.ai.cloud.ovh.net/changelog), ensuring that customers are informed about the changes in the platform. By following this model lifecycle process, OVHcloud ensures that customers are well-informed and prepared for any changes, while also maintaining a lean and up-to-date selection of AI models. ## Billing principles -Here is the model billing overview for AI Endpoints models: - -| Category | Model | Input Price (\$) | Output Price (\$) | Input Price (€) | Output Price (€) | Unit Price | -| -------------------------- | -------------------------- | ---------------- | ----------------- | --------------- | ---------------- | --------------------------------- | -| Large Language Model (LLM) | Llama 3.3 70B Instruct | 0.74 | 0.74 | 0.67 | 0.67 | Per 1 million tokens | -| Large Language Model (LLM) | Llama 3.1 70B Instruct | 0.74 | 0.74 | 0.67 | 0.67 | Per 1 million tokens | -| Large Language Model (LLM) | Mixtral 8x7B Instruct v0.1 | 0.70 | 0.70 | 0.63 | 0.63 | Per 1 million tokens | -| Large Language Model (LLM) | Mistral Nemo Instruct 2407 | 0.14 | 0.14 | 0.13 | 0.13 | Per 1 million tokens | -| Large Language Model (LLM) | Llama 3.1 8B Instruct | 0.11 | 0.11 | 0.10 | 0.10 | Per 1 million tokens | -| Large Language Model (LLM) | Mistral 7B Instruct v0.3 | 0.11 | 0.11 | 0.10 | 0.10 | Per 1 million tokens | -| Reasoning LLM | Gpt Oss 120B | 0.09 | 0.44 | 0.08 | 0.40 | Per 1 million tokens | -| Reasoning LLM | Gpt Oss 20B | 0.04 | 0.17 | 0.04 | 0.15 | Per 1 million tokens | -| Reasoning LLM | Qwen 3 32B | 0.09 | 0.25 | 0.08 | 0.23 | Per 1 million tokens | -| Reasoning LLM | DeepSeek R1 Distill Llama 70B | 0.74 | 0.74 | 0.67 | 0.67 | Per 1 million tokens | -| Code LLM | Qwen 2.5 Coder 32B Instruct | 0.96 | 0.96 | 0.87 | 0.87 | Per 1 million tokens | -| Code LLM | Mamba Codestral 7B v0.1 | 0.21 | 0.21 | 0.19 | 0.19 | Per 1 million tokens | -| Visual LLM | Mistral Small 3.2 24B Instruct 2506 | 0.10 | 0.31 | 0.09 | 0.28 | Per 1 million tokens | -| Visual LLM | Qwen 2.5 VL 72B Instruct | 1.01 | 1.01 | 0.91 | 0.91 | Per 1 million tokens | -| Visual LLM | Llava Next Mistral 7B | 0.32 | 0.32 | 0.29 | 0.29 | Per 1 million tokens | -| Embeddings | BGE Multilingual Gemma2 | 0.01 | 0.01 | Free | Free | Per 1 million tokens | -| Embeddings | BGE M3 | 0.01 | 0.01 | Free | Free | Per 1 million tokens | -| Embeddings | BGE Base EN v1.5 | 0.01 | 0.01 | Free | Free | Per 1 million tokens | -| Natural Language Processing (NLP) | Roberta Base Go Emotions | Free | Free | Free | Free | Per 1 million characters | -| Natural Language Processing (NLP) | Bert Base Multilingual uncased sentiment | Free | Free | Free | Free | Per 1 million characters | -| Natural Language Processing (NLP) | Bert Base NER | Free | Free | Free | Free | Per 1 million characters | -| Natural Language Processing (NLP) | Bart Large CNN | Free | Free | Free | Free | Per 1 million characters | -| Image generation | Stable Diffusion XL | Free | Free | Free | Free | Per image | -| Audio Analysis | Whisper Large V3 Turbo | 0.00001413468 | Free | 0.00001278 | Free | Per second | -| Audio Analysis | Whisper Large V3 | 0.00004515798 | Free | 0.00004083 | Free | Per second | -| Audio Analysis | RIVA Text-to-Speech | Free | Free | Free | Free | Per second | -| Translation | T5-Large | Free | Free | Free | Free | Per 1 million characters | -| Computer vision | YOLOv11 Object Detection | Free | Free | Free | Free | Per image | -| Computer vision | YOLOv11 Image Segmentation | Free | Free | Free | Free | Per image | +For detailed information on models, quantization, pricing units, and prices, please visit the `AI Endpoints`{.action} section of the `AI and Machine Learning` drop-down menu, on the [OVHcloud website](/links/public-cloud/prices-ai): + +![ai-endpoints-pricing-overview](images/pricing-overview.png){.thumbnail} ## Feedback diff --git a/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.en-au.md b/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.en-au.md index 9300bb7df3e..06b8cc06df4 100644 --- a/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.en-au.md +++ b/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.en-au.md @@ -1,7 +1,7 @@ --- title: AI Endpoints - Billing and lifecycle excerpt: Learn how we bill AI Endpoints -updated: 2025-09-04 +updated: 2025-10-20 --- > [!primary] @@ -24,46 +24,16 @@ OVHcloud AI Endpoints follows a model lifecycle process to ensure a seamless exp - **Track model usage metrics**: We continuously monitor the usage of each model on our platform to identify underutilized or obsolete models that may no longer serve the needs of our customers. - **Decommissioning decision**: Once a model is identified as a candidate for decommissioning, we make a decision to retire the model. At this point, we communicate the decision to our customers through official deprecation notices on our website and the #ai-endpoints channel of the OVHcloud [Discord server](https://discord.gg/ovhcloud). - **Grace period**: After the deprecation notice is published, a grace period of 30 days is provided for all models except embedding models, which will have a grace period of 3 months. This period allows customers to transition to an alternative model. During this time, we offer guidance on recommended replacements and migration steps to ensure a smooth transition. -- **Removal from active deployment**: Once the grace period ends, the model is removed from active deployment. However, to ensure continuity, we may redirect API calls to the replacement model (if applicable) with a 10-second delay before the decommissioned model responds, signaling to users that the model is no longer in active use. +- **Removal from active deployment**: Once the grace period ends, the model is removed from active deployment. - **AI Endpoints changelog**: Decommissionings are highlighted in the [AI Endpoints Changelog](https://endpoints.ai.cloud.ovh.net/changelog), ensuring that customers are informed about the changes in the platform. By following this model lifecycle process, OVHcloud ensures that customers are well-informed and prepared for any changes, while also maintaining a lean and up-to-date selection of AI models. ## Billing principles -Here is the model billing overview for AI Endpoints models: - -| Category | Model | Input Price (\$) | Output Price (\$) | Input Price (€) | Output Price (€) | Unit Price | -| -------------------------- | -------------------------- | ---------------- | ----------------- | --------------- | ---------------- | --------------------------------- | -| Large Language Model (LLM) | Llama 3.3 70B Instruct | 0.74 | 0.74 | 0.67 | 0.67 | Per 1 million tokens | -| Large Language Model (LLM) | Llama 3.1 70B Instruct | 0.74 | 0.74 | 0.67 | 0.67 | Per 1 million tokens | -| Large Language Model (LLM) | Mixtral 8x7B Instruct v0.1 | 0.70 | 0.70 | 0.63 | 0.63 | Per 1 million tokens | -| Large Language Model (LLM) | Mistral Nemo Instruct 2407 | 0.14 | 0.14 | 0.13 | 0.13 | Per 1 million tokens | -| Large Language Model (LLM) | Llama 3.1 8B Instruct | 0.11 | 0.11 | 0.10 | 0.10 | Per 1 million tokens | -| Large Language Model (LLM) | Mistral 7B Instruct v0.3 | 0.11 | 0.11 | 0.10 | 0.10 | Per 1 million tokens | -| Reasoning LLM | Gpt Oss 120B | 0.09 | 0.44 | 0.08 | 0.40 | Per 1 million tokens | -| Reasoning LLM | Gpt Oss 20B | 0.04 | 0.17 | 0.04 | 0.15 | Per 1 million tokens | -| Reasoning LLM | Qwen 3 32B | 0.09 | 0.25 | 0.08 | 0.23 | Per 1 million tokens | -| Reasoning LLM | DeepSeek R1 Distill Llama 70B | 0.74 | 0.74 | 0.67 | 0.67 | Per 1 million tokens | -| Code LLM | Qwen 2.5 Coder 32B Instruct | 0.96 | 0.96 | 0.87 | 0.87 | Per 1 million tokens | -| Code LLM | Mamba Codestral 7B v0.1 | 0.21 | 0.21 | 0.19 | 0.19 | Per 1 million tokens | -| Visual LLM | Mistral Small 3.2 24B Instruct 2506 | 0.10 | 0.31 | 0.09 | 0.28 | Per 1 million tokens | -| Visual LLM | Qwen 2.5 VL 72B Instruct | 1.01 | 1.01 | 0.91 | 0.91 | Per 1 million tokens | -| Visual LLM | Llava Next Mistral 7B | 0.32 | 0.32 | 0.29 | 0.29 | Per 1 million tokens | -| Embeddings | BGE Multilingual Gemma2 | 0.01 | 0.01 | Free | Free | Per 1 million tokens | -| Embeddings | BGE M3 | 0.01 | 0.01 | Free | Free | Per 1 million tokens | -| Embeddings | BGE Base EN v1.5 | 0.01 | 0.01 | Free | Free | Per 1 million tokens | -| Natural Language Processing (NLP) | Roberta Base Go Emotions | Free | Free | Free | Free | Per 1 million characters | -| Natural Language Processing (NLP) | Bert Base Multilingual uncased sentiment | Free | Free | Free | Free | Per 1 million characters | -| Natural Language Processing (NLP) | Bert Base NER | Free | Free | Free | Free | Per 1 million characters | -| Natural Language Processing (NLP) | Bart Large CNN | Free | Free | Free | Free | Per 1 million characters | -| Image generation | Stable Diffusion XL | Free | Free | Free | Free | Per image | -| Audio Analysis | Whisper Large V3 Turbo | 0.00001413468 | Free | 0.00001278 | Free | Per second | -| Audio Analysis | Whisper Large V3 | 0.00004515798 | Free | 0.00004083 | Free | Per second | -| Audio Analysis | RIVA Text-to-Speech | Free | Free | Free | Free | Per second | -| Translation | T5-Large | Free | Free | Free | Free | Per 1 million characters | -| Computer vision | YOLOv11 Object Detection | Free | Free | Free | Free | Per image | -| Computer vision | YOLOv11 Image Segmentation | Free | Free | Free | Free | Per image | +For detailed information on models, quantization, pricing units, and prices, please visit the `AI Endpoints`{.action} section of the `AI and Machine Learning` drop-down menu, on the [OVHcloud website](/links/public-cloud/prices-ai): + +![ai-endpoints-pricing-overview](images/pricing-overview.png){.thumbnail} ## Feedback diff --git a/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.en-ca.md b/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.en-ca.md index 9300bb7df3e..06b8cc06df4 100644 --- a/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.en-ca.md +++ b/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.en-ca.md @@ -1,7 +1,7 @@ --- title: AI Endpoints - Billing and lifecycle excerpt: Learn how we bill AI Endpoints -updated: 2025-09-04 +updated: 2025-10-20 --- > [!primary] @@ -24,46 +24,16 @@ OVHcloud AI Endpoints follows a model lifecycle process to ensure a seamless exp - **Track model usage metrics**: We continuously monitor the usage of each model on our platform to identify underutilized or obsolete models that may no longer serve the needs of our customers. - **Decommissioning decision**: Once a model is identified as a candidate for decommissioning, we make a decision to retire the model. At this point, we communicate the decision to our customers through official deprecation notices on our website and the #ai-endpoints channel of the OVHcloud [Discord server](https://discord.gg/ovhcloud). - **Grace period**: After the deprecation notice is published, a grace period of 30 days is provided for all models except embedding models, which will have a grace period of 3 months. This period allows customers to transition to an alternative model. During this time, we offer guidance on recommended replacements and migration steps to ensure a smooth transition. -- **Removal from active deployment**: Once the grace period ends, the model is removed from active deployment. However, to ensure continuity, we may redirect API calls to the replacement model (if applicable) with a 10-second delay before the decommissioned model responds, signaling to users that the model is no longer in active use. +- **Removal from active deployment**: Once the grace period ends, the model is removed from active deployment. - **AI Endpoints changelog**: Decommissionings are highlighted in the [AI Endpoints Changelog](https://endpoints.ai.cloud.ovh.net/changelog), ensuring that customers are informed about the changes in the platform. By following this model lifecycle process, OVHcloud ensures that customers are well-informed and prepared for any changes, while also maintaining a lean and up-to-date selection of AI models. ## Billing principles -Here is the model billing overview for AI Endpoints models: - -| Category | Model | Input Price (\$) | Output Price (\$) | Input Price (€) | Output Price (€) | Unit Price | -| -------------------------- | -------------------------- | ---------------- | ----------------- | --------------- | ---------------- | --------------------------------- | -| Large Language Model (LLM) | Llama 3.3 70B Instruct | 0.74 | 0.74 | 0.67 | 0.67 | Per 1 million tokens | -| Large Language Model (LLM) | Llama 3.1 70B Instruct | 0.74 | 0.74 | 0.67 | 0.67 | Per 1 million tokens | -| Large Language Model (LLM) | Mixtral 8x7B Instruct v0.1 | 0.70 | 0.70 | 0.63 | 0.63 | Per 1 million tokens | -| Large Language Model (LLM) | Mistral Nemo Instruct 2407 | 0.14 | 0.14 | 0.13 | 0.13 | Per 1 million tokens | -| Large Language Model (LLM) | Llama 3.1 8B Instruct | 0.11 | 0.11 | 0.10 | 0.10 | Per 1 million tokens | -| Large Language Model (LLM) | Mistral 7B Instruct v0.3 | 0.11 | 0.11 | 0.10 | 0.10 | Per 1 million tokens | -| Reasoning LLM | Gpt Oss 120B | 0.09 | 0.44 | 0.08 | 0.40 | Per 1 million tokens | -| Reasoning LLM | Gpt Oss 20B | 0.04 | 0.17 | 0.04 | 0.15 | Per 1 million tokens | -| Reasoning LLM | Qwen 3 32B | 0.09 | 0.25 | 0.08 | 0.23 | Per 1 million tokens | -| Reasoning LLM | DeepSeek R1 Distill Llama 70B | 0.74 | 0.74 | 0.67 | 0.67 | Per 1 million tokens | -| Code LLM | Qwen 2.5 Coder 32B Instruct | 0.96 | 0.96 | 0.87 | 0.87 | Per 1 million tokens | -| Code LLM | Mamba Codestral 7B v0.1 | 0.21 | 0.21 | 0.19 | 0.19 | Per 1 million tokens | -| Visual LLM | Mistral Small 3.2 24B Instruct 2506 | 0.10 | 0.31 | 0.09 | 0.28 | Per 1 million tokens | -| Visual LLM | Qwen 2.5 VL 72B Instruct | 1.01 | 1.01 | 0.91 | 0.91 | Per 1 million tokens | -| Visual LLM | Llava Next Mistral 7B | 0.32 | 0.32 | 0.29 | 0.29 | Per 1 million tokens | -| Embeddings | BGE Multilingual Gemma2 | 0.01 | 0.01 | Free | Free | Per 1 million tokens | -| Embeddings | BGE M3 | 0.01 | 0.01 | Free | Free | Per 1 million tokens | -| Embeddings | BGE Base EN v1.5 | 0.01 | 0.01 | Free | Free | Per 1 million tokens | -| Natural Language Processing (NLP) | Roberta Base Go Emotions | Free | Free | Free | Free | Per 1 million characters | -| Natural Language Processing (NLP) | Bert Base Multilingual uncased sentiment | Free | Free | Free | Free | Per 1 million characters | -| Natural Language Processing (NLP) | Bert Base NER | Free | Free | Free | Free | Per 1 million characters | -| Natural Language Processing (NLP) | Bart Large CNN | Free | Free | Free | Free | Per 1 million characters | -| Image generation | Stable Diffusion XL | Free | Free | Free | Free | Per image | -| Audio Analysis | Whisper Large V3 Turbo | 0.00001413468 | Free | 0.00001278 | Free | Per second | -| Audio Analysis | Whisper Large V3 | 0.00004515798 | Free | 0.00004083 | Free | Per second | -| Audio Analysis | RIVA Text-to-Speech | Free | Free | Free | Free | Per second | -| Translation | T5-Large | Free | Free | Free | Free | Per 1 million characters | -| Computer vision | YOLOv11 Object Detection | Free | Free | Free | Free | Per image | -| Computer vision | YOLOv11 Image Segmentation | Free | Free | Free | Free | Per image | +For detailed information on models, quantization, pricing units, and prices, please visit the `AI Endpoints`{.action} section of the `AI and Machine Learning` drop-down menu, on the [OVHcloud website](/links/public-cloud/prices-ai): + +![ai-endpoints-pricing-overview](images/pricing-overview.png){.thumbnail} ## Feedback diff --git a/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.en-gb.md b/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.en-gb.md index 9300bb7df3e..06b8cc06df4 100644 --- a/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.en-gb.md +++ b/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.en-gb.md @@ -1,7 +1,7 @@ --- title: AI Endpoints - Billing and lifecycle excerpt: Learn how we bill AI Endpoints -updated: 2025-09-04 +updated: 2025-10-20 --- > [!primary] @@ -24,46 +24,16 @@ OVHcloud AI Endpoints follows a model lifecycle process to ensure a seamless exp - **Track model usage metrics**: We continuously monitor the usage of each model on our platform to identify underutilized or obsolete models that may no longer serve the needs of our customers. - **Decommissioning decision**: Once a model is identified as a candidate for decommissioning, we make a decision to retire the model. At this point, we communicate the decision to our customers through official deprecation notices on our website and the #ai-endpoints channel of the OVHcloud [Discord server](https://discord.gg/ovhcloud). - **Grace period**: After the deprecation notice is published, a grace period of 30 days is provided for all models except embedding models, which will have a grace period of 3 months. This period allows customers to transition to an alternative model. During this time, we offer guidance on recommended replacements and migration steps to ensure a smooth transition. -- **Removal from active deployment**: Once the grace period ends, the model is removed from active deployment. However, to ensure continuity, we may redirect API calls to the replacement model (if applicable) with a 10-second delay before the decommissioned model responds, signaling to users that the model is no longer in active use. +- **Removal from active deployment**: Once the grace period ends, the model is removed from active deployment. - **AI Endpoints changelog**: Decommissionings are highlighted in the [AI Endpoints Changelog](https://endpoints.ai.cloud.ovh.net/changelog), ensuring that customers are informed about the changes in the platform. By following this model lifecycle process, OVHcloud ensures that customers are well-informed and prepared for any changes, while also maintaining a lean and up-to-date selection of AI models. ## Billing principles -Here is the model billing overview for AI Endpoints models: - -| Category | Model | Input Price (\$) | Output Price (\$) | Input Price (€) | Output Price (€) | Unit Price | -| -------------------------- | -------------------------- | ---------------- | ----------------- | --------------- | ---------------- | --------------------------------- | -| Large Language Model (LLM) | Llama 3.3 70B Instruct | 0.74 | 0.74 | 0.67 | 0.67 | Per 1 million tokens | -| Large Language Model (LLM) | Llama 3.1 70B Instruct | 0.74 | 0.74 | 0.67 | 0.67 | Per 1 million tokens | -| Large Language Model (LLM) | Mixtral 8x7B Instruct v0.1 | 0.70 | 0.70 | 0.63 | 0.63 | Per 1 million tokens | -| Large Language Model (LLM) | Mistral Nemo Instruct 2407 | 0.14 | 0.14 | 0.13 | 0.13 | Per 1 million tokens | -| Large Language Model (LLM) | Llama 3.1 8B Instruct | 0.11 | 0.11 | 0.10 | 0.10 | Per 1 million tokens | -| Large Language Model (LLM) | Mistral 7B Instruct v0.3 | 0.11 | 0.11 | 0.10 | 0.10 | Per 1 million tokens | -| Reasoning LLM | Gpt Oss 120B | 0.09 | 0.44 | 0.08 | 0.40 | Per 1 million tokens | -| Reasoning LLM | Gpt Oss 20B | 0.04 | 0.17 | 0.04 | 0.15 | Per 1 million tokens | -| Reasoning LLM | Qwen 3 32B | 0.09 | 0.25 | 0.08 | 0.23 | Per 1 million tokens | -| Reasoning LLM | DeepSeek R1 Distill Llama 70B | 0.74 | 0.74 | 0.67 | 0.67 | Per 1 million tokens | -| Code LLM | Qwen 2.5 Coder 32B Instruct | 0.96 | 0.96 | 0.87 | 0.87 | Per 1 million tokens | -| Code LLM | Mamba Codestral 7B v0.1 | 0.21 | 0.21 | 0.19 | 0.19 | Per 1 million tokens | -| Visual LLM | Mistral Small 3.2 24B Instruct 2506 | 0.10 | 0.31 | 0.09 | 0.28 | Per 1 million tokens | -| Visual LLM | Qwen 2.5 VL 72B Instruct | 1.01 | 1.01 | 0.91 | 0.91 | Per 1 million tokens | -| Visual LLM | Llava Next Mistral 7B | 0.32 | 0.32 | 0.29 | 0.29 | Per 1 million tokens | -| Embeddings | BGE Multilingual Gemma2 | 0.01 | 0.01 | Free | Free | Per 1 million tokens | -| Embeddings | BGE M3 | 0.01 | 0.01 | Free | Free | Per 1 million tokens | -| Embeddings | BGE Base EN v1.5 | 0.01 | 0.01 | Free | Free | Per 1 million tokens | -| Natural Language Processing (NLP) | Roberta Base Go Emotions | Free | Free | Free | Free | Per 1 million characters | -| Natural Language Processing (NLP) | Bert Base Multilingual uncased sentiment | Free | Free | Free | Free | Per 1 million characters | -| Natural Language Processing (NLP) | Bert Base NER | Free | Free | Free | Free | Per 1 million characters | -| Natural Language Processing (NLP) | Bart Large CNN | Free | Free | Free | Free | Per 1 million characters | -| Image generation | Stable Diffusion XL | Free | Free | Free | Free | Per image | -| Audio Analysis | Whisper Large V3 Turbo | 0.00001413468 | Free | 0.00001278 | Free | Per second | -| Audio Analysis | Whisper Large V3 | 0.00004515798 | Free | 0.00004083 | Free | Per second | -| Audio Analysis | RIVA Text-to-Speech | Free | Free | Free | Free | Per second | -| Translation | T5-Large | Free | Free | Free | Free | Per 1 million characters | -| Computer vision | YOLOv11 Object Detection | Free | Free | Free | Free | Per image | -| Computer vision | YOLOv11 Image Segmentation | Free | Free | Free | Free | Per image | +For detailed information on models, quantization, pricing units, and prices, please visit the `AI Endpoints`{.action} section of the `AI and Machine Learning` drop-down menu, on the [OVHcloud website](/links/public-cloud/prices-ai): + +![ai-endpoints-pricing-overview](images/pricing-overview.png){.thumbnail} ## Feedback diff --git a/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.en-ie.md b/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.en-ie.md index 9300bb7df3e..06b8cc06df4 100644 --- a/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.en-ie.md +++ b/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.en-ie.md @@ -1,7 +1,7 @@ --- title: AI Endpoints - Billing and lifecycle excerpt: Learn how we bill AI Endpoints -updated: 2025-09-04 +updated: 2025-10-20 --- > [!primary] @@ -24,46 +24,16 @@ OVHcloud AI Endpoints follows a model lifecycle process to ensure a seamless exp - **Track model usage metrics**: We continuously monitor the usage of each model on our platform to identify underutilized or obsolete models that may no longer serve the needs of our customers. - **Decommissioning decision**: Once a model is identified as a candidate for decommissioning, we make a decision to retire the model. At this point, we communicate the decision to our customers through official deprecation notices on our website and the #ai-endpoints channel of the OVHcloud [Discord server](https://discord.gg/ovhcloud). - **Grace period**: After the deprecation notice is published, a grace period of 30 days is provided for all models except embedding models, which will have a grace period of 3 months. This period allows customers to transition to an alternative model. During this time, we offer guidance on recommended replacements and migration steps to ensure a smooth transition. -- **Removal from active deployment**: Once the grace period ends, the model is removed from active deployment. However, to ensure continuity, we may redirect API calls to the replacement model (if applicable) with a 10-second delay before the decommissioned model responds, signaling to users that the model is no longer in active use. +- **Removal from active deployment**: Once the grace period ends, the model is removed from active deployment. - **AI Endpoints changelog**: Decommissionings are highlighted in the [AI Endpoints Changelog](https://endpoints.ai.cloud.ovh.net/changelog), ensuring that customers are informed about the changes in the platform. By following this model lifecycle process, OVHcloud ensures that customers are well-informed and prepared for any changes, while also maintaining a lean and up-to-date selection of AI models. ## Billing principles -Here is the model billing overview for AI Endpoints models: - -| Category | Model | Input Price (\$) | Output Price (\$) | Input Price (€) | Output Price (€) | Unit Price | -| -------------------------- | -------------------------- | ---------------- | ----------------- | --------------- | ---------------- | --------------------------------- | -| Large Language Model (LLM) | Llama 3.3 70B Instruct | 0.74 | 0.74 | 0.67 | 0.67 | Per 1 million tokens | -| Large Language Model (LLM) | Llama 3.1 70B Instruct | 0.74 | 0.74 | 0.67 | 0.67 | Per 1 million tokens | -| Large Language Model (LLM) | Mixtral 8x7B Instruct v0.1 | 0.70 | 0.70 | 0.63 | 0.63 | Per 1 million tokens | -| Large Language Model (LLM) | Mistral Nemo Instruct 2407 | 0.14 | 0.14 | 0.13 | 0.13 | Per 1 million tokens | -| Large Language Model (LLM) | Llama 3.1 8B Instruct | 0.11 | 0.11 | 0.10 | 0.10 | Per 1 million tokens | -| Large Language Model (LLM) | Mistral 7B Instruct v0.3 | 0.11 | 0.11 | 0.10 | 0.10 | Per 1 million tokens | -| Reasoning LLM | Gpt Oss 120B | 0.09 | 0.44 | 0.08 | 0.40 | Per 1 million tokens | -| Reasoning LLM | Gpt Oss 20B | 0.04 | 0.17 | 0.04 | 0.15 | Per 1 million tokens | -| Reasoning LLM | Qwen 3 32B | 0.09 | 0.25 | 0.08 | 0.23 | Per 1 million tokens | -| Reasoning LLM | DeepSeek R1 Distill Llama 70B | 0.74 | 0.74 | 0.67 | 0.67 | Per 1 million tokens | -| Code LLM | Qwen 2.5 Coder 32B Instruct | 0.96 | 0.96 | 0.87 | 0.87 | Per 1 million tokens | -| Code LLM | Mamba Codestral 7B v0.1 | 0.21 | 0.21 | 0.19 | 0.19 | Per 1 million tokens | -| Visual LLM | Mistral Small 3.2 24B Instruct 2506 | 0.10 | 0.31 | 0.09 | 0.28 | Per 1 million tokens | -| Visual LLM | Qwen 2.5 VL 72B Instruct | 1.01 | 1.01 | 0.91 | 0.91 | Per 1 million tokens | -| Visual LLM | Llava Next Mistral 7B | 0.32 | 0.32 | 0.29 | 0.29 | Per 1 million tokens | -| Embeddings | BGE Multilingual Gemma2 | 0.01 | 0.01 | Free | Free | Per 1 million tokens | -| Embeddings | BGE M3 | 0.01 | 0.01 | Free | Free | Per 1 million tokens | -| Embeddings | BGE Base EN v1.5 | 0.01 | 0.01 | Free | Free | Per 1 million tokens | -| Natural Language Processing (NLP) | Roberta Base Go Emotions | Free | Free | Free | Free | Per 1 million characters | -| Natural Language Processing (NLP) | Bert Base Multilingual uncased sentiment | Free | Free | Free | Free | Per 1 million characters | -| Natural Language Processing (NLP) | Bert Base NER | Free | Free | Free | Free | Per 1 million characters | -| Natural Language Processing (NLP) | Bart Large CNN | Free | Free | Free | Free | Per 1 million characters | -| Image generation | Stable Diffusion XL | Free | Free | Free | Free | Per image | -| Audio Analysis | Whisper Large V3 Turbo | 0.00001413468 | Free | 0.00001278 | Free | Per second | -| Audio Analysis | Whisper Large V3 | 0.00004515798 | Free | 0.00004083 | Free | Per second | -| Audio Analysis | RIVA Text-to-Speech | Free | Free | Free | Free | Per second | -| Translation | T5-Large | Free | Free | Free | Free | Per 1 million characters | -| Computer vision | YOLOv11 Object Detection | Free | Free | Free | Free | Per image | -| Computer vision | YOLOv11 Image Segmentation | Free | Free | Free | Free | Per image | +For detailed information on models, quantization, pricing units, and prices, please visit the `AI Endpoints`{.action} section of the `AI and Machine Learning` drop-down menu, on the [OVHcloud website](/links/public-cloud/prices-ai): + +![ai-endpoints-pricing-overview](images/pricing-overview.png){.thumbnail} ## Feedback diff --git a/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.en-sg.md b/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.en-sg.md index 9300bb7df3e..06b8cc06df4 100644 --- a/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.en-sg.md +++ b/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.en-sg.md @@ -1,7 +1,7 @@ --- title: AI Endpoints - Billing and lifecycle excerpt: Learn how we bill AI Endpoints -updated: 2025-09-04 +updated: 2025-10-20 --- > [!primary] @@ -24,46 +24,16 @@ OVHcloud AI Endpoints follows a model lifecycle process to ensure a seamless exp - **Track model usage metrics**: We continuously monitor the usage of each model on our platform to identify underutilized or obsolete models that may no longer serve the needs of our customers. - **Decommissioning decision**: Once a model is identified as a candidate for decommissioning, we make a decision to retire the model. At this point, we communicate the decision to our customers through official deprecation notices on our website and the #ai-endpoints channel of the OVHcloud [Discord server](https://discord.gg/ovhcloud). - **Grace period**: After the deprecation notice is published, a grace period of 30 days is provided for all models except embedding models, which will have a grace period of 3 months. This period allows customers to transition to an alternative model. During this time, we offer guidance on recommended replacements and migration steps to ensure a smooth transition. -- **Removal from active deployment**: Once the grace period ends, the model is removed from active deployment. However, to ensure continuity, we may redirect API calls to the replacement model (if applicable) with a 10-second delay before the decommissioned model responds, signaling to users that the model is no longer in active use. +- **Removal from active deployment**: Once the grace period ends, the model is removed from active deployment. - **AI Endpoints changelog**: Decommissionings are highlighted in the [AI Endpoints Changelog](https://endpoints.ai.cloud.ovh.net/changelog), ensuring that customers are informed about the changes in the platform. By following this model lifecycle process, OVHcloud ensures that customers are well-informed and prepared for any changes, while also maintaining a lean and up-to-date selection of AI models. ## Billing principles -Here is the model billing overview for AI Endpoints models: - -| Category | Model | Input Price (\$) | Output Price (\$) | Input Price (€) | Output Price (€) | Unit Price | -| -------------------------- | -------------------------- | ---------------- | ----------------- | --------------- | ---------------- | --------------------------------- | -| Large Language Model (LLM) | Llama 3.3 70B Instruct | 0.74 | 0.74 | 0.67 | 0.67 | Per 1 million tokens | -| Large Language Model (LLM) | Llama 3.1 70B Instruct | 0.74 | 0.74 | 0.67 | 0.67 | Per 1 million tokens | -| Large Language Model (LLM) | Mixtral 8x7B Instruct v0.1 | 0.70 | 0.70 | 0.63 | 0.63 | Per 1 million tokens | -| Large Language Model (LLM) | Mistral Nemo Instruct 2407 | 0.14 | 0.14 | 0.13 | 0.13 | Per 1 million tokens | -| Large Language Model (LLM) | Llama 3.1 8B Instruct | 0.11 | 0.11 | 0.10 | 0.10 | Per 1 million tokens | -| Large Language Model (LLM) | Mistral 7B Instruct v0.3 | 0.11 | 0.11 | 0.10 | 0.10 | Per 1 million tokens | -| Reasoning LLM | Gpt Oss 120B | 0.09 | 0.44 | 0.08 | 0.40 | Per 1 million tokens | -| Reasoning LLM | Gpt Oss 20B | 0.04 | 0.17 | 0.04 | 0.15 | Per 1 million tokens | -| Reasoning LLM | Qwen 3 32B | 0.09 | 0.25 | 0.08 | 0.23 | Per 1 million tokens | -| Reasoning LLM | DeepSeek R1 Distill Llama 70B | 0.74 | 0.74 | 0.67 | 0.67 | Per 1 million tokens | -| Code LLM | Qwen 2.5 Coder 32B Instruct | 0.96 | 0.96 | 0.87 | 0.87 | Per 1 million tokens | -| Code LLM | Mamba Codestral 7B v0.1 | 0.21 | 0.21 | 0.19 | 0.19 | Per 1 million tokens | -| Visual LLM | Mistral Small 3.2 24B Instruct 2506 | 0.10 | 0.31 | 0.09 | 0.28 | Per 1 million tokens | -| Visual LLM | Qwen 2.5 VL 72B Instruct | 1.01 | 1.01 | 0.91 | 0.91 | Per 1 million tokens | -| Visual LLM | Llava Next Mistral 7B | 0.32 | 0.32 | 0.29 | 0.29 | Per 1 million tokens | -| Embeddings | BGE Multilingual Gemma2 | 0.01 | 0.01 | Free | Free | Per 1 million tokens | -| Embeddings | BGE M3 | 0.01 | 0.01 | Free | Free | Per 1 million tokens | -| Embeddings | BGE Base EN v1.5 | 0.01 | 0.01 | Free | Free | Per 1 million tokens | -| Natural Language Processing (NLP) | Roberta Base Go Emotions | Free | Free | Free | Free | Per 1 million characters | -| Natural Language Processing (NLP) | Bert Base Multilingual uncased sentiment | Free | Free | Free | Free | Per 1 million characters | -| Natural Language Processing (NLP) | Bert Base NER | Free | Free | Free | Free | Per 1 million characters | -| Natural Language Processing (NLP) | Bart Large CNN | Free | Free | Free | Free | Per 1 million characters | -| Image generation | Stable Diffusion XL | Free | Free | Free | Free | Per image | -| Audio Analysis | Whisper Large V3 Turbo | 0.00001413468 | Free | 0.00001278 | Free | Per second | -| Audio Analysis | Whisper Large V3 | 0.00004515798 | Free | 0.00004083 | Free | Per second | -| Audio Analysis | RIVA Text-to-Speech | Free | Free | Free | Free | Per second | -| Translation | T5-Large | Free | Free | Free | Free | Per 1 million characters | -| Computer vision | YOLOv11 Object Detection | Free | Free | Free | Free | Per image | -| Computer vision | YOLOv11 Image Segmentation | Free | Free | Free | Free | Per image | +For detailed information on models, quantization, pricing units, and prices, please visit the `AI Endpoints`{.action} section of the `AI and Machine Learning` drop-down menu, on the [OVHcloud website](/links/public-cloud/prices-ai): + +![ai-endpoints-pricing-overview](images/pricing-overview.png){.thumbnail} ## Feedback diff --git a/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.en-us.md b/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.en-us.md index 9300bb7df3e..06b8cc06df4 100644 --- a/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.en-us.md +++ b/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.en-us.md @@ -1,7 +1,7 @@ --- title: AI Endpoints - Billing and lifecycle excerpt: Learn how we bill AI Endpoints -updated: 2025-09-04 +updated: 2025-10-20 --- > [!primary] @@ -24,46 +24,16 @@ OVHcloud AI Endpoints follows a model lifecycle process to ensure a seamless exp - **Track model usage metrics**: We continuously monitor the usage of each model on our platform to identify underutilized or obsolete models that may no longer serve the needs of our customers. - **Decommissioning decision**: Once a model is identified as a candidate for decommissioning, we make a decision to retire the model. At this point, we communicate the decision to our customers through official deprecation notices on our website and the #ai-endpoints channel of the OVHcloud [Discord server](https://discord.gg/ovhcloud). - **Grace period**: After the deprecation notice is published, a grace period of 30 days is provided for all models except embedding models, which will have a grace period of 3 months. This period allows customers to transition to an alternative model. During this time, we offer guidance on recommended replacements and migration steps to ensure a smooth transition. -- **Removal from active deployment**: Once the grace period ends, the model is removed from active deployment. However, to ensure continuity, we may redirect API calls to the replacement model (if applicable) with a 10-second delay before the decommissioned model responds, signaling to users that the model is no longer in active use. +- **Removal from active deployment**: Once the grace period ends, the model is removed from active deployment. - **AI Endpoints changelog**: Decommissionings are highlighted in the [AI Endpoints Changelog](https://endpoints.ai.cloud.ovh.net/changelog), ensuring that customers are informed about the changes in the platform. By following this model lifecycle process, OVHcloud ensures that customers are well-informed and prepared for any changes, while also maintaining a lean and up-to-date selection of AI models. ## Billing principles -Here is the model billing overview for AI Endpoints models: - -| Category | Model | Input Price (\$) | Output Price (\$) | Input Price (€) | Output Price (€) | Unit Price | -| -------------------------- | -------------------------- | ---------------- | ----------------- | --------------- | ---------------- | --------------------------------- | -| Large Language Model (LLM) | Llama 3.3 70B Instruct | 0.74 | 0.74 | 0.67 | 0.67 | Per 1 million tokens | -| Large Language Model (LLM) | Llama 3.1 70B Instruct | 0.74 | 0.74 | 0.67 | 0.67 | Per 1 million tokens | -| Large Language Model (LLM) | Mixtral 8x7B Instruct v0.1 | 0.70 | 0.70 | 0.63 | 0.63 | Per 1 million tokens | -| Large Language Model (LLM) | Mistral Nemo Instruct 2407 | 0.14 | 0.14 | 0.13 | 0.13 | Per 1 million tokens | -| Large Language Model (LLM) | Llama 3.1 8B Instruct | 0.11 | 0.11 | 0.10 | 0.10 | Per 1 million tokens | -| Large Language Model (LLM) | Mistral 7B Instruct v0.3 | 0.11 | 0.11 | 0.10 | 0.10 | Per 1 million tokens | -| Reasoning LLM | Gpt Oss 120B | 0.09 | 0.44 | 0.08 | 0.40 | Per 1 million tokens | -| Reasoning LLM | Gpt Oss 20B | 0.04 | 0.17 | 0.04 | 0.15 | Per 1 million tokens | -| Reasoning LLM | Qwen 3 32B | 0.09 | 0.25 | 0.08 | 0.23 | Per 1 million tokens | -| Reasoning LLM | DeepSeek R1 Distill Llama 70B | 0.74 | 0.74 | 0.67 | 0.67 | Per 1 million tokens | -| Code LLM | Qwen 2.5 Coder 32B Instruct | 0.96 | 0.96 | 0.87 | 0.87 | Per 1 million tokens | -| Code LLM | Mamba Codestral 7B v0.1 | 0.21 | 0.21 | 0.19 | 0.19 | Per 1 million tokens | -| Visual LLM | Mistral Small 3.2 24B Instruct 2506 | 0.10 | 0.31 | 0.09 | 0.28 | Per 1 million tokens | -| Visual LLM | Qwen 2.5 VL 72B Instruct | 1.01 | 1.01 | 0.91 | 0.91 | Per 1 million tokens | -| Visual LLM | Llava Next Mistral 7B | 0.32 | 0.32 | 0.29 | 0.29 | Per 1 million tokens | -| Embeddings | BGE Multilingual Gemma2 | 0.01 | 0.01 | Free | Free | Per 1 million tokens | -| Embeddings | BGE M3 | 0.01 | 0.01 | Free | Free | Per 1 million tokens | -| Embeddings | BGE Base EN v1.5 | 0.01 | 0.01 | Free | Free | Per 1 million tokens | -| Natural Language Processing (NLP) | Roberta Base Go Emotions | Free | Free | Free | Free | Per 1 million characters | -| Natural Language Processing (NLP) | Bert Base Multilingual uncased sentiment | Free | Free | Free | Free | Per 1 million characters | -| Natural Language Processing (NLP) | Bert Base NER | Free | Free | Free | Free | Per 1 million characters | -| Natural Language Processing (NLP) | Bart Large CNN | Free | Free | Free | Free | Per 1 million characters | -| Image generation | Stable Diffusion XL | Free | Free | Free | Free | Per image | -| Audio Analysis | Whisper Large V3 Turbo | 0.00001413468 | Free | 0.00001278 | Free | Per second | -| Audio Analysis | Whisper Large V3 | 0.00004515798 | Free | 0.00004083 | Free | Per second | -| Audio Analysis | RIVA Text-to-Speech | Free | Free | Free | Free | Per second | -| Translation | T5-Large | Free | Free | Free | Free | Per 1 million characters | -| Computer vision | YOLOv11 Object Detection | Free | Free | Free | Free | Per image | -| Computer vision | YOLOv11 Image Segmentation | Free | Free | Free | Free | Per image | +For detailed information on models, quantization, pricing units, and prices, please visit the `AI Endpoints`{.action} section of the `AI and Machine Learning` drop-down menu, on the [OVHcloud website](/links/public-cloud/prices-ai): + +![ai-endpoints-pricing-overview](images/pricing-overview.png){.thumbnail} ## Feedback diff --git a/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.es-es.md b/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.es-es.md index 9300bb7df3e..06b8cc06df4 100644 --- a/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.es-es.md +++ b/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.es-es.md @@ -1,7 +1,7 @@ --- title: AI Endpoints - Billing and lifecycle excerpt: Learn how we bill AI Endpoints -updated: 2025-09-04 +updated: 2025-10-20 --- > [!primary] @@ -24,46 +24,16 @@ OVHcloud AI Endpoints follows a model lifecycle process to ensure a seamless exp - **Track model usage metrics**: We continuously monitor the usage of each model on our platform to identify underutilized or obsolete models that may no longer serve the needs of our customers. - **Decommissioning decision**: Once a model is identified as a candidate for decommissioning, we make a decision to retire the model. At this point, we communicate the decision to our customers through official deprecation notices on our website and the #ai-endpoints channel of the OVHcloud [Discord server](https://discord.gg/ovhcloud). - **Grace period**: After the deprecation notice is published, a grace period of 30 days is provided for all models except embedding models, which will have a grace period of 3 months. This period allows customers to transition to an alternative model. During this time, we offer guidance on recommended replacements and migration steps to ensure a smooth transition. -- **Removal from active deployment**: Once the grace period ends, the model is removed from active deployment. However, to ensure continuity, we may redirect API calls to the replacement model (if applicable) with a 10-second delay before the decommissioned model responds, signaling to users that the model is no longer in active use. +- **Removal from active deployment**: Once the grace period ends, the model is removed from active deployment. - **AI Endpoints changelog**: Decommissionings are highlighted in the [AI Endpoints Changelog](https://endpoints.ai.cloud.ovh.net/changelog), ensuring that customers are informed about the changes in the platform. By following this model lifecycle process, OVHcloud ensures that customers are well-informed and prepared for any changes, while also maintaining a lean and up-to-date selection of AI models. ## Billing principles -Here is the model billing overview for AI Endpoints models: - -| Category | Model | Input Price (\$) | Output Price (\$) | Input Price (€) | Output Price (€) | Unit Price | -| -------------------------- | -------------------------- | ---------------- | ----------------- | --------------- | ---------------- | --------------------------------- | -| Large Language Model (LLM) | Llama 3.3 70B Instruct | 0.74 | 0.74 | 0.67 | 0.67 | Per 1 million tokens | -| Large Language Model (LLM) | Llama 3.1 70B Instruct | 0.74 | 0.74 | 0.67 | 0.67 | Per 1 million tokens | -| Large Language Model (LLM) | Mixtral 8x7B Instruct v0.1 | 0.70 | 0.70 | 0.63 | 0.63 | Per 1 million tokens | -| Large Language Model (LLM) | Mistral Nemo Instruct 2407 | 0.14 | 0.14 | 0.13 | 0.13 | Per 1 million tokens | -| Large Language Model (LLM) | Llama 3.1 8B Instruct | 0.11 | 0.11 | 0.10 | 0.10 | Per 1 million tokens | -| Large Language Model (LLM) | Mistral 7B Instruct v0.3 | 0.11 | 0.11 | 0.10 | 0.10 | Per 1 million tokens | -| Reasoning LLM | Gpt Oss 120B | 0.09 | 0.44 | 0.08 | 0.40 | Per 1 million tokens | -| Reasoning LLM | Gpt Oss 20B | 0.04 | 0.17 | 0.04 | 0.15 | Per 1 million tokens | -| Reasoning LLM | Qwen 3 32B | 0.09 | 0.25 | 0.08 | 0.23 | Per 1 million tokens | -| Reasoning LLM | DeepSeek R1 Distill Llama 70B | 0.74 | 0.74 | 0.67 | 0.67 | Per 1 million tokens | -| Code LLM | Qwen 2.5 Coder 32B Instruct | 0.96 | 0.96 | 0.87 | 0.87 | Per 1 million tokens | -| Code LLM | Mamba Codestral 7B v0.1 | 0.21 | 0.21 | 0.19 | 0.19 | Per 1 million tokens | -| Visual LLM | Mistral Small 3.2 24B Instruct 2506 | 0.10 | 0.31 | 0.09 | 0.28 | Per 1 million tokens | -| Visual LLM | Qwen 2.5 VL 72B Instruct | 1.01 | 1.01 | 0.91 | 0.91 | Per 1 million tokens | -| Visual LLM | Llava Next Mistral 7B | 0.32 | 0.32 | 0.29 | 0.29 | Per 1 million tokens | -| Embeddings | BGE Multilingual Gemma2 | 0.01 | 0.01 | Free | Free | Per 1 million tokens | -| Embeddings | BGE M3 | 0.01 | 0.01 | Free | Free | Per 1 million tokens | -| Embeddings | BGE Base EN v1.5 | 0.01 | 0.01 | Free | Free | Per 1 million tokens | -| Natural Language Processing (NLP) | Roberta Base Go Emotions | Free | Free | Free | Free | Per 1 million characters | -| Natural Language Processing (NLP) | Bert Base Multilingual uncased sentiment | Free | Free | Free | Free | Per 1 million characters | -| Natural Language Processing (NLP) | Bert Base NER | Free | Free | Free | Free | Per 1 million characters | -| Natural Language Processing (NLP) | Bart Large CNN | Free | Free | Free | Free | Per 1 million characters | -| Image generation | Stable Diffusion XL | Free | Free | Free | Free | Per image | -| Audio Analysis | Whisper Large V3 Turbo | 0.00001413468 | Free | 0.00001278 | Free | Per second | -| Audio Analysis | Whisper Large V3 | 0.00004515798 | Free | 0.00004083 | Free | Per second | -| Audio Analysis | RIVA Text-to-Speech | Free | Free | Free | Free | Per second | -| Translation | T5-Large | Free | Free | Free | Free | Per 1 million characters | -| Computer vision | YOLOv11 Object Detection | Free | Free | Free | Free | Per image | -| Computer vision | YOLOv11 Image Segmentation | Free | Free | Free | Free | Per image | +For detailed information on models, quantization, pricing units, and prices, please visit the `AI Endpoints`{.action} section of the `AI and Machine Learning` drop-down menu, on the [OVHcloud website](/links/public-cloud/prices-ai): + +![ai-endpoints-pricing-overview](images/pricing-overview.png){.thumbnail} ## Feedback diff --git a/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.es-us.md b/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.es-us.md index 9300bb7df3e..06b8cc06df4 100644 --- a/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.es-us.md +++ b/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.es-us.md @@ -1,7 +1,7 @@ --- title: AI Endpoints - Billing and lifecycle excerpt: Learn how we bill AI Endpoints -updated: 2025-09-04 +updated: 2025-10-20 --- > [!primary] @@ -24,46 +24,16 @@ OVHcloud AI Endpoints follows a model lifecycle process to ensure a seamless exp - **Track model usage metrics**: We continuously monitor the usage of each model on our platform to identify underutilized or obsolete models that may no longer serve the needs of our customers. - **Decommissioning decision**: Once a model is identified as a candidate for decommissioning, we make a decision to retire the model. At this point, we communicate the decision to our customers through official deprecation notices on our website and the #ai-endpoints channel of the OVHcloud [Discord server](https://discord.gg/ovhcloud). - **Grace period**: After the deprecation notice is published, a grace period of 30 days is provided for all models except embedding models, which will have a grace period of 3 months. This period allows customers to transition to an alternative model. During this time, we offer guidance on recommended replacements and migration steps to ensure a smooth transition. -- **Removal from active deployment**: Once the grace period ends, the model is removed from active deployment. However, to ensure continuity, we may redirect API calls to the replacement model (if applicable) with a 10-second delay before the decommissioned model responds, signaling to users that the model is no longer in active use. +- **Removal from active deployment**: Once the grace period ends, the model is removed from active deployment. - **AI Endpoints changelog**: Decommissionings are highlighted in the [AI Endpoints Changelog](https://endpoints.ai.cloud.ovh.net/changelog), ensuring that customers are informed about the changes in the platform. By following this model lifecycle process, OVHcloud ensures that customers are well-informed and prepared for any changes, while also maintaining a lean and up-to-date selection of AI models. ## Billing principles -Here is the model billing overview for AI Endpoints models: - -| Category | Model | Input Price (\$) | Output Price (\$) | Input Price (€) | Output Price (€) | Unit Price | -| -------------------------- | -------------------------- | ---------------- | ----------------- | --------------- | ---------------- | --------------------------------- | -| Large Language Model (LLM) | Llama 3.3 70B Instruct | 0.74 | 0.74 | 0.67 | 0.67 | Per 1 million tokens | -| Large Language Model (LLM) | Llama 3.1 70B Instruct | 0.74 | 0.74 | 0.67 | 0.67 | Per 1 million tokens | -| Large Language Model (LLM) | Mixtral 8x7B Instruct v0.1 | 0.70 | 0.70 | 0.63 | 0.63 | Per 1 million tokens | -| Large Language Model (LLM) | Mistral Nemo Instruct 2407 | 0.14 | 0.14 | 0.13 | 0.13 | Per 1 million tokens | -| Large Language Model (LLM) | Llama 3.1 8B Instruct | 0.11 | 0.11 | 0.10 | 0.10 | Per 1 million tokens | -| Large Language Model (LLM) | Mistral 7B Instruct v0.3 | 0.11 | 0.11 | 0.10 | 0.10 | Per 1 million tokens | -| Reasoning LLM | Gpt Oss 120B | 0.09 | 0.44 | 0.08 | 0.40 | Per 1 million tokens | -| Reasoning LLM | Gpt Oss 20B | 0.04 | 0.17 | 0.04 | 0.15 | Per 1 million tokens | -| Reasoning LLM | Qwen 3 32B | 0.09 | 0.25 | 0.08 | 0.23 | Per 1 million tokens | -| Reasoning LLM | DeepSeek R1 Distill Llama 70B | 0.74 | 0.74 | 0.67 | 0.67 | Per 1 million tokens | -| Code LLM | Qwen 2.5 Coder 32B Instruct | 0.96 | 0.96 | 0.87 | 0.87 | Per 1 million tokens | -| Code LLM | Mamba Codestral 7B v0.1 | 0.21 | 0.21 | 0.19 | 0.19 | Per 1 million tokens | -| Visual LLM | Mistral Small 3.2 24B Instruct 2506 | 0.10 | 0.31 | 0.09 | 0.28 | Per 1 million tokens | -| Visual LLM | Qwen 2.5 VL 72B Instruct | 1.01 | 1.01 | 0.91 | 0.91 | Per 1 million tokens | -| Visual LLM | Llava Next Mistral 7B | 0.32 | 0.32 | 0.29 | 0.29 | Per 1 million tokens | -| Embeddings | BGE Multilingual Gemma2 | 0.01 | 0.01 | Free | Free | Per 1 million tokens | -| Embeddings | BGE M3 | 0.01 | 0.01 | Free | Free | Per 1 million tokens | -| Embeddings | BGE Base EN v1.5 | 0.01 | 0.01 | Free | Free | Per 1 million tokens | -| Natural Language Processing (NLP) | Roberta Base Go Emotions | Free | Free | Free | Free | Per 1 million characters | -| Natural Language Processing (NLP) | Bert Base Multilingual uncased sentiment | Free | Free | Free | Free | Per 1 million characters | -| Natural Language Processing (NLP) | Bert Base NER | Free | Free | Free | Free | Per 1 million characters | -| Natural Language Processing (NLP) | Bart Large CNN | Free | Free | Free | Free | Per 1 million characters | -| Image generation | Stable Diffusion XL | Free | Free | Free | Free | Per image | -| Audio Analysis | Whisper Large V3 Turbo | 0.00001413468 | Free | 0.00001278 | Free | Per second | -| Audio Analysis | Whisper Large V3 | 0.00004515798 | Free | 0.00004083 | Free | Per second | -| Audio Analysis | RIVA Text-to-Speech | Free | Free | Free | Free | Per second | -| Translation | T5-Large | Free | Free | Free | Free | Per 1 million characters | -| Computer vision | YOLOv11 Object Detection | Free | Free | Free | Free | Per image | -| Computer vision | YOLOv11 Image Segmentation | Free | Free | Free | Free | Per image | +For detailed information on models, quantization, pricing units, and prices, please visit the `AI Endpoints`{.action} section of the `AI and Machine Learning` drop-down menu, on the [OVHcloud website](/links/public-cloud/prices-ai): + +![ai-endpoints-pricing-overview](images/pricing-overview.png){.thumbnail} ## Feedback diff --git a/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.fr-ca.md b/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.fr-ca.md index ff1ab18b179..74b5cfb0805 100644 --- a/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.fr-ca.md +++ b/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.fr-ca.md @@ -1,7 +1,7 @@ --- title: AI Endpoints - Facturation et cycle de vie (EN) excerpt: "Découvrez comment sont facturés les modèles AI Endpoints chez OVHcloud" -updated: 2025-09-04 +updated: 2025-10-20 --- > [!primary] @@ -24,46 +24,16 @@ OVHcloud AI Endpoints follows a model lifecycle process to ensure a seamless exp - **Track model usage metrics**: We continuously monitor the usage of each model on our platform to identify underutilized or obsolete models that may no longer serve the needs of our customers. - **Decommissioning decision**: Once a model is identified as a candidate for decommissioning, we make a decision to retire the model. At this point, we communicate the decision to our customers through official deprecation notices on our website and the #ai-endpoints channel of the OVHcloud [Discord server](https://discord.gg/ovhcloud). - **Grace period**: After the deprecation notice is published, a grace period of 30 days is provided for all models except embedding models, which will have a grace period of 3 months. This period allows customers to transition to an alternative model. During this time, we offer guidance on recommended replacements and migration steps to ensure a smooth transition. -- **Removal from active deployment**: Once the grace period ends, the model is removed from active deployment. However, to ensure continuity, we may redirect API calls to the replacement model (if applicable) with a 10-second delay before the decommissioned model responds, signaling to users that the model is no longer in active use. +- **Removal from active deployment**: Once the grace period ends, the model is removed from active deployment. - **AI Endpoints changelog**: Decommissionings are highlighted in the [AI Endpoints Changelog](https://endpoints.ai.cloud.ovh.net/changelog), ensuring that customers are informed about the changes in the platform. By following this model lifecycle process, OVHcloud ensures that customers are well-informed and prepared for any changes, while also maintaining a lean and up-to-date selection of AI models. ## Billing principles -Here is the model billing overview for AI Endpoints models: - -| Category | Model | Input Price (\$) | Output Price (\$) | Input Price (€) | Output Price (€) | Unit Price | -| -------------------------- | -------------------------- | ---------------- | ----------------- | --------------- | ---------------- | --------------------------------- | -| Large Language Model (LLM) | Llama 3.3 70B Instruct | 0.74 | 0.74 | 0.67 | 0.67 | Per 1 million tokens | -| Large Language Model (LLM) | Llama 3.1 70B Instruct | 0.74 | 0.74 | 0.67 | 0.67 | Per 1 million tokens | -| Large Language Model (LLM) | Mixtral 8x7B Instruct v0.1 | 0.70 | 0.70 | 0.63 | 0.63 | Per 1 million tokens | -| Large Language Model (LLM) | Mistral Nemo Instruct 2407 | 0.14 | 0.14 | 0.13 | 0.13 | Per 1 million tokens | -| Large Language Model (LLM) | Llama 3.1 8B Instruct | 0.11 | 0.11 | 0.10 | 0.10 | Per 1 million tokens | -| Large Language Model (LLM) | Mistral 7B Instruct v0.3 | 0.11 | 0.11 | 0.10 | 0.10 | Per 1 million tokens | -| Reasoning LLM | Gpt Oss 120B | 0.09 | 0.44 | 0.08 | 0.40 | Per 1 million tokens | -| Reasoning LLM | Gpt Oss 20B | 0.04 | 0.17 | 0.04 | 0.15 | Per 1 million tokens | -| Reasoning LLM | Qwen 3 32B | 0.09 | 0.25 | 0.08 | 0.23 | Per 1 million tokens | -| Reasoning LLM | DeepSeek R1 Distill Llama 70B | 0.74 | 0.74 | 0.67 | 0.67 | Per 1 million tokens | -| Code LLM | Qwen 2.5 Coder 32B Instruct | 0.96 | 0.96 | 0.87 | 0.87 | Per 1 million tokens | -| Code LLM | Mamba Codestral 7B v0.1 | 0.21 | 0.21 | 0.19 | 0.19 | Per 1 million tokens | -| Visual LLM | Mistral Small 3.2 24B Instruct 2506 | 0.10 | 0.31 | 0.09 | 0.28 | Per 1 million tokens | -| Visual LLM | Qwen 2.5 VL 72B Instruct | 1.01 | 1.01 | 0.91 | 0.91 | Per 1 million tokens | -| Visual LLM | Llava Next Mistral 7B | 0.32 | 0.32 | 0.29 | 0.29 | Per 1 million tokens | -| Embeddings | BGE Multilingual Gemma2 | 0.01 | 0.01 | Free | Free | Per 1 million tokens | -| Embeddings | BGE M3 | 0.01 | 0.01 | Free | Free | Per 1 million tokens | -| Embeddings | BGE Base EN v1.5 | 0.01 | 0.01 | Free | Free | Per 1 million tokens | -| Natural Language Processing (NLP) | Roberta Base Go Emotions | Free | Free | Free | Free | Per 1 million characters | -| Natural Language Processing (NLP) | Bert Base Multilingual uncased sentiment | Free | Free | Free | Free | Per 1 million characters | -| Natural Language Processing (NLP) | Bert Base NER | Free | Free | Free | Free | Per 1 million characters | -| Natural Language Processing (NLP) | Bart Large CNN | Free | Free | Free | Free | Per 1 million characters | -| Image generation | Stable Diffusion XL | Free | Free | Free | Free | Per image | -| Audio Analysis | Whisper Large V3 Turbo | 0.00001413468 | Free | 0.00001278 | Free | Per second | -| Audio Analysis | Whisper Large V3 | 0.00004515798 | Free | 0.00004083 | Free | Per second | -| Audio Analysis | RIVA Text-to-Speech | Free | Free | Free | Free | Per second | -| Translation | T5-Large | Free | Free | Free | Free | Per 1 million characters | -| Computer vision | YOLOv11 Object Detection | Free | Free | Free | Free | Per image | -| Computer vision | YOLOv11 Image Segmentation | Free | Free | Free | Free | Per image | +For detailed information on models, quantization, pricing units, and prices, please visit the `AI Endpoints`{.action} section of the `AI and Machine Learning` drop-down menu, on the [OVHcloud website](/links/public-cloud/prices-ai): + +![ai-endpoints-pricing-overview](images/pricing-overview.png){.thumbnail} ## Feedback diff --git a/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.fr-fr.md b/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.fr-fr.md index ff1ab18b179..74b5cfb0805 100644 --- a/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.fr-fr.md +++ b/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.fr-fr.md @@ -1,7 +1,7 @@ --- title: AI Endpoints - Facturation et cycle de vie (EN) excerpt: "Découvrez comment sont facturés les modèles AI Endpoints chez OVHcloud" -updated: 2025-09-04 +updated: 2025-10-20 --- > [!primary] @@ -24,46 +24,16 @@ OVHcloud AI Endpoints follows a model lifecycle process to ensure a seamless exp - **Track model usage metrics**: We continuously monitor the usage of each model on our platform to identify underutilized or obsolete models that may no longer serve the needs of our customers. - **Decommissioning decision**: Once a model is identified as a candidate for decommissioning, we make a decision to retire the model. At this point, we communicate the decision to our customers through official deprecation notices on our website and the #ai-endpoints channel of the OVHcloud [Discord server](https://discord.gg/ovhcloud). - **Grace period**: After the deprecation notice is published, a grace period of 30 days is provided for all models except embedding models, which will have a grace period of 3 months. This period allows customers to transition to an alternative model. During this time, we offer guidance on recommended replacements and migration steps to ensure a smooth transition. -- **Removal from active deployment**: Once the grace period ends, the model is removed from active deployment. However, to ensure continuity, we may redirect API calls to the replacement model (if applicable) with a 10-second delay before the decommissioned model responds, signaling to users that the model is no longer in active use. +- **Removal from active deployment**: Once the grace period ends, the model is removed from active deployment. - **AI Endpoints changelog**: Decommissionings are highlighted in the [AI Endpoints Changelog](https://endpoints.ai.cloud.ovh.net/changelog), ensuring that customers are informed about the changes in the platform. By following this model lifecycle process, OVHcloud ensures that customers are well-informed and prepared for any changes, while also maintaining a lean and up-to-date selection of AI models. ## Billing principles -Here is the model billing overview for AI Endpoints models: - -| Category | Model | Input Price (\$) | Output Price (\$) | Input Price (€) | Output Price (€) | Unit Price | -| -------------------------- | -------------------------- | ---------------- | ----------------- | --------------- | ---------------- | --------------------------------- | -| Large Language Model (LLM) | Llama 3.3 70B Instruct | 0.74 | 0.74 | 0.67 | 0.67 | Per 1 million tokens | -| Large Language Model (LLM) | Llama 3.1 70B Instruct | 0.74 | 0.74 | 0.67 | 0.67 | Per 1 million tokens | -| Large Language Model (LLM) | Mixtral 8x7B Instruct v0.1 | 0.70 | 0.70 | 0.63 | 0.63 | Per 1 million tokens | -| Large Language Model (LLM) | Mistral Nemo Instruct 2407 | 0.14 | 0.14 | 0.13 | 0.13 | Per 1 million tokens | -| Large Language Model (LLM) | Llama 3.1 8B Instruct | 0.11 | 0.11 | 0.10 | 0.10 | Per 1 million tokens | -| Large Language Model (LLM) | Mistral 7B Instruct v0.3 | 0.11 | 0.11 | 0.10 | 0.10 | Per 1 million tokens | -| Reasoning LLM | Gpt Oss 120B | 0.09 | 0.44 | 0.08 | 0.40 | Per 1 million tokens | -| Reasoning LLM | Gpt Oss 20B | 0.04 | 0.17 | 0.04 | 0.15 | Per 1 million tokens | -| Reasoning LLM | Qwen 3 32B | 0.09 | 0.25 | 0.08 | 0.23 | Per 1 million tokens | -| Reasoning LLM | DeepSeek R1 Distill Llama 70B | 0.74 | 0.74 | 0.67 | 0.67 | Per 1 million tokens | -| Code LLM | Qwen 2.5 Coder 32B Instruct | 0.96 | 0.96 | 0.87 | 0.87 | Per 1 million tokens | -| Code LLM | Mamba Codestral 7B v0.1 | 0.21 | 0.21 | 0.19 | 0.19 | Per 1 million tokens | -| Visual LLM | Mistral Small 3.2 24B Instruct 2506 | 0.10 | 0.31 | 0.09 | 0.28 | Per 1 million tokens | -| Visual LLM | Qwen 2.5 VL 72B Instruct | 1.01 | 1.01 | 0.91 | 0.91 | Per 1 million tokens | -| Visual LLM | Llava Next Mistral 7B | 0.32 | 0.32 | 0.29 | 0.29 | Per 1 million tokens | -| Embeddings | BGE Multilingual Gemma2 | 0.01 | 0.01 | Free | Free | Per 1 million tokens | -| Embeddings | BGE M3 | 0.01 | 0.01 | Free | Free | Per 1 million tokens | -| Embeddings | BGE Base EN v1.5 | 0.01 | 0.01 | Free | Free | Per 1 million tokens | -| Natural Language Processing (NLP) | Roberta Base Go Emotions | Free | Free | Free | Free | Per 1 million characters | -| Natural Language Processing (NLP) | Bert Base Multilingual uncased sentiment | Free | Free | Free | Free | Per 1 million characters | -| Natural Language Processing (NLP) | Bert Base NER | Free | Free | Free | Free | Per 1 million characters | -| Natural Language Processing (NLP) | Bart Large CNN | Free | Free | Free | Free | Per 1 million characters | -| Image generation | Stable Diffusion XL | Free | Free | Free | Free | Per image | -| Audio Analysis | Whisper Large V3 Turbo | 0.00001413468 | Free | 0.00001278 | Free | Per second | -| Audio Analysis | Whisper Large V3 | 0.00004515798 | Free | 0.00004083 | Free | Per second | -| Audio Analysis | RIVA Text-to-Speech | Free | Free | Free | Free | Per second | -| Translation | T5-Large | Free | Free | Free | Free | Per 1 million characters | -| Computer vision | YOLOv11 Object Detection | Free | Free | Free | Free | Per image | -| Computer vision | YOLOv11 Image Segmentation | Free | Free | Free | Free | Per image | +For detailed information on models, quantization, pricing units, and prices, please visit the `AI Endpoints`{.action} section of the `AI and Machine Learning` drop-down menu, on the [OVHcloud website](/links/public-cloud/prices-ai): + +![ai-endpoints-pricing-overview](images/pricing-overview.png){.thumbnail} ## Feedback diff --git a/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.it-it.md b/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.it-it.md index 9300bb7df3e..06b8cc06df4 100644 --- a/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.it-it.md +++ b/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.it-it.md @@ -1,7 +1,7 @@ --- title: AI Endpoints - Billing and lifecycle excerpt: Learn how we bill AI Endpoints -updated: 2025-09-04 +updated: 2025-10-20 --- > [!primary] @@ -24,46 +24,16 @@ OVHcloud AI Endpoints follows a model lifecycle process to ensure a seamless exp - **Track model usage metrics**: We continuously monitor the usage of each model on our platform to identify underutilized or obsolete models that may no longer serve the needs of our customers. - **Decommissioning decision**: Once a model is identified as a candidate for decommissioning, we make a decision to retire the model. At this point, we communicate the decision to our customers through official deprecation notices on our website and the #ai-endpoints channel of the OVHcloud [Discord server](https://discord.gg/ovhcloud). - **Grace period**: After the deprecation notice is published, a grace period of 30 days is provided for all models except embedding models, which will have a grace period of 3 months. This period allows customers to transition to an alternative model. During this time, we offer guidance on recommended replacements and migration steps to ensure a smooth transition. -- **Removal from active deployment**: Once the grace period ends, the model is removed from active deployment. However, to ensure continuity, we may redirect API calls to the replacement model (if applicable) with a 10-second delay before the decommissioned model responds, signaling to users that the model is no longer in active use. +- **Removal from active deployment**: Once the grace period ends, the model is removed from active deployment. - **AI Endpoints changelog**: Decommissionings are highlighted in the [AI Endpoints Changelog](https://endpoints.ai.cloud.ovh.net/changelog), ensuring that customers are informed about the changes in the platform. By following this model lifecycle process, OVHcloud ensures that customers are well-informed and prepared for any changes, while also maintaining a lean and up-to-date selection of AI models. ## Billing principles -Here is the model billing overview for AI Endpoints models: - -| Category | Model | Input Price (\$) | Output Price (\$) | Input Price (€) | Output Price (€) | Unit Price | -| -------------------------- | -------------------------- | ---------------- | ----------------- | --------------- | ---------------- | --------------------------------- | -| Large Language Model (LLM) | Llama 3.3 70B Instruct | 0.74 | 0.74 | 0.67 | 0.67 | Per 1 million tokens | -| Large Language Model (LLM) | Llama 3.1 70B Instruct | 0.74 | 0.74 | 0.67 | 0.67 | Per 1 million tokens | -| Large Language Model (LLM) | Mixtral 8x7B Instruct v0.1 | 0.70 | 0.70 | 0.63 | 0.63 | Per 1 million tokens | -| Large Language Model (LLM) | Mistral Nemo Instruct 2407 | 0.14 | 0.14 | 0.13 | 0.13 | Per 1 million tokens | -| Large Language Model (LLM) | Llama 3.1 8B Instruct | 0.11 | 0.11 | 0.10 | 0.10 | Per 1 million tokens | -| Large Language Model (LLM) | Mistral 7B Instruct v0.3 | 0.11 | 0.11 | 0.10 | 0.10 | Per 1 million tokens | -| Reasoning LLM | Gpt Oss 120B | 0.09 | 0.44 | 0.08 | 0.40 | Per 1 million tokens | -| Reasoning LLM | Gpt Oss 20B | 0.04 | 0.17 | 0.04 | 0.15 | Per 1 million tokens | -| Reasoning LLM | Qwen 3 32B | 0.09 | 0.25 | 0.08 | 0.23 | Per 1 million tokens | -| Reasoning LLM | DeepSeek R1 Distill Llama 70B | 0.74 | 0.74 | 0.67 | 0.67 | Per 1 million tokens | -| Code LLM | Qwen 2.5 Coder 32B Instruct | 0.96 | 0.96 | 0.87 | 0.87 | Per 1 million tokens | -| Code LLM | Mamba Codestral 7B v0.1 | 0.21 | 0.21 | 0.19 | 0.19 | Per 1 million tokens | -| Visual LLM | Mistral Small 3.2 24B Instruct 2506 | 0.10 | 0.31 | 0.09 | 0.28 | Per 1 million tokens | -| Visual LLM | Qwen 2.5 VL 72B Instruct | 1.01 | 1.01 | 0.91 | 0.91 | Per 1 million tokens | -| Visual LLM | Llava Next Mistral 7B | 0.32 | 0.32 | 0.29 | 0.29 | Per 1 million tokens | -| Embeddings | BGE Multilingual Gemma2 | 0.01 | 0.01 | Free | Free | Per 1 million tokens | -| Embeddings | BGE M3 | 0.01 | 0.01 | Free | Free | Per 1 million tokens | -| Embeddings | BGE Base EN v1.5 | 0.01 | 0.01 | Free | Free | Per 1 million tokens | -| Natural Language Processing (NLP) | Roberta Base Go Emotions | Free | Free | Free | Free | Per 1 million characters | -| Natural Language Processing (NLP) | Bert Base Multilingual uncased sentiment | Free | Free | Free | Free | Per 1 million characters | -| Natural Language Processing (NLP) | Bert Base NER | Free | Free | Free | Free | Per 1 million characters | -| Natural Language Processing (NLP) | Bart Large CNN | Free | Free | Free | Free | Per 1 million characters | -| Image generation | Stable Diffusion XL | Free | Free | Free | Free | Per image | -| Audio Analysis | Whisper Large V3 Turbo | 0.00001413468 | Free | 0.00001278 | Free | Per second | -| Audio Analysis | Whisper Large V3 | 0.00004515798 | Free | 0.00004083 | Free | Per second | -| Audio Analysis | RIVA Text-to-Speech | Free | Free | Free | Free | Per second | -| Translation | T5-Large | Free | Free | Free | Free | Per 1 million characters | -| Computer vision | YOLOv11 Object Detection | Free | Free | Free | Free | Per image | -| Computer vision | YOLOv11 Image Segmentation | Free | Free | Free | Free | Per image | +For detailed information on models, quantization, pricing units, and prices, please visit the `AI Endpoints`{.action} section of the `AI and Machine Learning` drop-down menu, on the [OVHcloud website](/links/public-cloud/prices-ai): + +![ai-endpoints-pricing-overview](images/pricing-overview.png){.thumbnail} ## Feedback diff --git a/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.pl-pl.md b/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.pl-pl.md index 9300bb7df3e..06b8cc06df4 100644 --- a/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.pl-pl.md +++ b/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.pl-pl.md @@ -1,7 +1,7 @@ --- title: AI Endpoints - Billing and lifecycle excerpt: Learn how we bill AI Endpoints -updated: 2025-09-04 +updated: 2025-10-20 --- > [!primary] @@ -24,46 +24,16 @@ OVHcloud AI Endpoints follows a model lifecycle process to ensure a seamless exp - **Track model usage metrics**: We continuously monitor the usage of each model on our platform to identify underutilized or obsolete models that may no longer serve the needs of our customers. - **Decommissioning decision**: Once a model is identified as a candidate for decommissioning, we make a decision to retire the model. At this point, we communicate the decision to our customers through official deprecation notices on our website and the #ai-endpoints channel of the OVHcloud [Discord server](https://discord.gg/ovhcloud). - **Grace period**: After the deprecation notice is published, a grace period of 30 days is provided for all models except embedding models, which will have a grace period of 3 months. This period allows customers to transition to an alternative model. During this time, we offer guidance on recommended replacements and migration steps to ensure a smooth transition. -- **Removal from active deployment**: Once the grace period ends, the model is removed from active deployment. However, to ensure continuity, we may redirect API calls to the replacement model (if applicable) with a 10-second delay before the decommissioned model responds, signaling to users that the model is no longer in active use. +- **Removal from active deployment**: Once the grace period ends, the model is removed from active deployment. - **AI Endpoints changelog**: Decommissionings are highlighted in the [AI Endpoints Changelog](https://endpoints.ai.cloud.ovh.net/changelog), ensuring that customers are informed about the changes in the platform. By following this model lifecycle process, OVHcloud ensures that customers are well-informed and prepared for any changes, while also maintaining a lean and up-to-date selection of AI models. ## Billing principles -Here is the model billing overview for AI Endpoints models: - -| Category | Model | Input Price (\$) | Output Price (\$) | Input Price (€) | Output Price (€) | Unit Price | -| -------------------------- | -------------------------- | ---------------- | ----------------- | --------------- | ---------------- | --------------------------------- | -| Large Language Model (LLM) | Llama 3.3 70B Instruct | 0.74 | 0.74 | 0.67 | 0.67 | Per 1 million tokens | -| Large Language Model (LLM) | Llama 3.1 70B Instruct | 0.74 | 0.74 | 0.67 | 0.67 | Per 1 million tokens | -| Large Language Model (LLM) | Mixtral 8x7B Instruct v0.1 | 0.70 | 0.70 | 0.63 | 0.63 | Per 1 million tokens | -| Large Language Model (LLM) | Mistral Nemo Instruct 2407 | 0.14 | 0.14 | 0.13 | 0.13 | Per 1 million tokens | -| Large Language Model (LLM) | Llama 3.1 8B Instruct | 0.11 | 0.11 | 0.10 | 0.10 | Per 1 million tokens | -| Large Language Model (LLM) | Mistral 7B Instruct v0.3 | 0.11 | 0.11 | 0.10 | 0.10 | Per 1 million tokens | -| Reasoning LLM | Gpt Oss 120B | 0.09 | 0.44 | 0.08 | 0.40 | Per 1 million tokens | -| Reasoning LLM | Gpt Oss 20B | 0.04 | 0.17 | 0.04 | 0.15 | Per 1 million tokens | -| Reasoning LLM | Qwen 3 32B | 0.09 | 0.25 | 0.08 | 0.23 | Per 1 million tokens | -| Reasoning LLM | DeepSeek R1 Distill Llama 70B | 0.74 | 0.74 | 0.67 | 0.67 | Per 1 million tokens | -| Code LLM | Qwen 2.5 Coder 32B Instruct | 0.96 | 0.96 | 0.87 | 0.87 | Per 1 million tokens | -| Code LLM | Mamba Codestral 7B v0.1 | 0.21 | 0.21 | 0.19 | 0.19 | Per 1 million tokens | -| Visual LLM | Mistral Small 3.2 24B Instruct 2506 | 0.10 | 0.31 | 0.09 | 0.28 | Per 1 million tokens | -| Visual LLM | Qwen 2.5 VL 72B Instruct | 1.01 | 1.01 | 0.91 | 0.91 | Per 1 million tokens | -| Visual LLM | Llava Next Mistral 7B | 0.32 | 0.32 | 0.29 | 0.29 | Per 1 million tokens | -| Embeddings | BGE Multilingual Gemma2 | 0.01 | 0.01 | Free | Free | Per 1 million tokens | -| Embeddings | BGE M3 | 0.01 | 0.01 | Free | Free | Per 1 million tokens | -| Embeddings | BGE Base EN v1.5 | 0.01 | 0.01 | Free | Free | Per 1 million tokens | -| Natural Language Processing (NLP) | Roberta Base Go Emotions | Free | Free | Free | Free | Per 1 million characters | -| Natural Language Processing (NLP) | Bert Base Multilingual uncased sentiment | Free | Free | Free | Free | Per 1 million characters | -| Natural Language Processing (NLP) | Bert Base NER | Free | Free | Free | Free | Per 1 million characters | -| Natural Language Processing (NLP) | Bart Large CNN | Free | Free | Free | Free | Per 1 million characters | -| Image generation | Stable Diffusion XL | Free | Free | Free | Free | Per image | -| Audio Analysis | Whisper Large V3 Turbo | 0.00001413468 | Free | 0.00001278 | Free | Per second | -| Audio Analysis | Whisper Large V3 | 0.00004515798 | Free | 0.00004083 | Free | Per second | -| Audio Analysis | RIVA Text-to-Speech | Free | Free | Free | Free | Per second | -| Translation | T5-Large | Free | Free | Free | Free | Per 1 million characters | -| Computer vision | YOLOv11 Object Detection | Free | Free | Free | Free | Per image | -| Computer vision | YOLOv11 Image Segmentation | Free | Free | Free | Free | Per image | +For detailed information on models, quantization, pricing units, and prices, please visit the `AI Endpoints`{.action} section of the `AI and Machine Learning` drop-down menu, on the [OVHcloud website](/links/public-cloud/prices-ai): + +![ai-endpoints-pricing-overview](images/pricing-overview.png){.thumbnail} ## Feedback diff --git a/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.pt-pt.md b/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.pt-pt.md index 9300bb7df3e..06b8cc06df4 100644 --- a/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.pt-pt.md +++ b/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/guide.pt-pt.md @@ -1,7 +1,7 @@ --- title: AI Endpoints - Billing and lifecycle excerpt: Learn how we bill AI Endpoints -updated: 2025-09-04 +updated: 2025-10-20 --- > [!primary] @@ -24,46 +24,16 @@ OVHcloud AI Endpoints follows a model lifecycle process to ensure a seamless exp - **Track model usage metrics**: We continuously monitor the usage of each model on our platform to identify underutilized or obsolete models that may no longer serve the needs of our customers. - **Decommissioning decision**: Once a model is identified as a candidate for decommissioning, we make a decision to retire the model. At this point, we communicate the decision to our customers through official deprecation notices on our website and the #ai-endpoints channel of the OVHcloud [Discord server](https://discord.gg/ovhcloud). - **Grace period**: After the deprecation notice is published, a grace period of 30 days is provided for all models except embedding models, which will have a grace period of 3 months. This period allows customers to transition to an alternative model. During this time, we offer guidance on recommended replacements and migration steps to ensure a smooth transition. -- **Removal from active deployment**: Once the grace period ends, the model is removed from active deployment. However, to ensure continuity, we may redirect API calls to the replacement model (if applicable) with a 10-second delay before the decommissioned model responds, signaling to users that the model is no longer in active use. +- **Removal from active deployment**: Once the grace period ends, the model is removed from active deployment. - **AI Endpoints changelog**: Decommissionings are highlighted in the [AI Endpoints Changelog](https://endpoints.ai.cloud.ovh.net/changelog), ensuring that customers are informed about the changes in the platform. By following this model lifecycle process, OVHcloud ensures that customers are well-informed and prepared for any changes, while also maintaining a lean and up-to-date selection of AI models. ## Billing principles -Here is the model billing overview for AI Endpoints models: - -| Category | Model | Input Price (\$) | Output Price (\$) | Input Price (€) | Output Price (€) | Unit Price | -| -------------------------- | -------------------------- | ---------------- | ----------------- | --------------- | ---------------- | --------------------------------- | -| Large Language Model (LLM) | Llama 3.3 70B Instruct | 0.74 | 0.74 | 0.67 | 0.67 | Per 1 million tokens | -| Large Language Model (LLM) | Llama 3.1 70B Instruct | 0.74 | 0.74 | 0.67 | 0.67 | Per 1 million tokens | -| Large Language Model (LLM) | Mixtral 8x7B Instruct v0.1 | 0.70 | 0.70 | 0.63 | 0.63 | Per 1 million tokens | -| Large Language Model (LLM) | Mistral Nemo Instruct 2407 | 0.14 | 0.14 | 0.13 | 0.13 | Per 1 million tokens | -| Large Language Model (LLM) | Llama 3.1 8B Instruct | 0.11 | 0.11 | 0.10 | 0.10 | Per 1 million tokens | -| Large Language Model (LLM) | Mistral 7B Instruct v0.3 | 0.11 | 0.11 | 0.10 | 0.10 | Per 1 million tokens | -| Reasoning LLM | Gpt Oss 120B | 0.09 | 0.44 | 0.08 | 0.40 | Per 1 million tokens | -| Reasoning LLM | Gpt Oss 20B | 0.04 | 0.17 | 0.04 | 0.15 | Per 1 million tokens | -| Reasoning LLM | Qwen 3 32B | 0.09 | 0.25 | 0.08 | 0.23 | Per 1 million tokens | -| Reasoning LLM | DeepSeek R1 Distill Llama 70B | 0.74 | 0.74 | 0.67 | 0.67 | Per 1 million tokens | -| Code LLM | Qwen 2.5 Coder 32B Instruct | 0.96 | 0.96 | 0.87 | 0.87 | Per 1 million tokens | -| Code LLM | Mamba Codestral 7B v0.1 | 0.21 | 0.21 | 0.19 | 0.19 | Per 1 million tokens | -| Visual LLM | Mistral Small 3.2 24B Instruct 2506 | 0.10 | 0.31 | 0.09 | 0.28 | Per 1 million tokens | -| Visual LLM | Qwen 2.5 VL 72B Instruct | 1.01 | 1.01 | 0.91 | 0.91 | Per 1 million tokens | -| Visual LLM | Llava Next Mistral 7B | 0.32 | 0.32 | 0.29 | 0.29 | Per 1 million tokens | -| Embeddings | BGE Multilingual Gemma2 | 0.01 | 0.01 | Free | Free | Per 1 million tokens | -| Embeddings | BGE M3 | 0.01 | 0.01 | Free | Free | Per 1 million tokens | -| Embeddings | BGE Base EN v1.5 | 0.01 | 0.01 | Free | Free | Per 1 million tokens | -| Natural Language Processing (NLP) | Roberta Base Go Emotions | Free | Free | Free | Free | Per 1 million characters | -| Natural Language Processing (NLP) | Bert Base Multilingual uncased sentiment | Free | Free | Free | Free | Per 1 million characters | -| Natural Language Processing (NLP) | Bert Base NER | Free | Free | Free | Free | Per 1 million characters | -| Natural Language Processing (NLP) | Bart Large CNN | Free | Free | Free | Free | Per 1 million characters | -| Image generation | Stable Diffusion XL | Free | Free | Free | Free | Per image | -| Audio Analysis | Whisper Large V3 Turbo | 0.00001413468 | Free | 0.00001278 | Free | Per second | -| Audio Analysis | Whisper Large V3 | 0.00004515798 | Free | 0.00004083 | Free | Per second | -| Audio Analysis | RIVA Text-to-Speech | Free | Free | Free | Free | Per second | -| Translation | T5-Large | Free | Free | Free | Free | Per 1 million characters | -| Computer vision | YOLOv11 Object Detection | Free | Free | Free | Free | Per image | -| Computer vision | YOLOv11 Image Segmentation | Free | Free | Free | Free | Per image | +For detailed information on models, quantization, pricing units, and prices, please visit the `AI Endpoints`{.action} section of the `AI and Machine Learning` drop-down menu, on the [OVHcloud website](/links/public-cloud/prices-ai): + +![ai-endpoints-pricing-overview](images/pricing-overview.png){.thumbnail} ## Feedback diff --git a/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/images/pricing-overview.png b/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/images/pricing-overview.png new file mode 100644 index 00000000000..077e6df062b Binary files /dev/null and b/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept/images/pricing-overview.png differ diff --git a/pages/public_cloud/ai_machine_learning/endpoints_guide_05_structured_output/guide.en-gb.md b/pages/public_cloud/ai_machine_learning/endpoints_guide_05_structured_output/guide.en-gb.md index a49a160a73c..cb1f84d378b 100644 --- a/pages/public_cloud/ai_machine_learning/endpoints_guide_05_structured_output/guide.en-gb.md +++ b/pages/public_cloud/ai_machine_learning/endpoints_guide_05_structured_output/guide.en-gb.md @@ -43,7 +43,7 @@ The examples provided during this guide can be used with one of the following en >> pip install openai pydantic >> ``` >> ->> **Javascript** +>> **JavaScript** >> >> A [Node.js](https://nodejs.org/en) environment with the [request](https://www.npmjs.com/package/request) library. >> Request can be installed using [NPM](https://www.npmjs.com/): @@ -208,7 +208,7 @@ The following code samples provide a simple example on how to specify a JSON sch >> >> As we can see, the response is matching the expected JSON schema! >> -> **Javascript** +> **JavaScript** >> >> ```javascript >> const request = require('request'); @@ -303,7 +303,7 @@ The following code samples provide a simple example on how to specify a JSON sch >> Java is the n°3 most popular language (https://www.java.com/) >> ``` >> ->> This example shows us how to use the JSON schema response format with Javascript. +>> This example shows us how to use the JSON schema response format with JavaScript. >> ### JSON object @@ -398,7 +398,7 @@ The following code samples provide a simple example on how to use the legacy JSO >> {"id":"chatcmpl-dfdbf074ab864199bac48ec929179fed","object":"chat.completion","created":1750773314,"model":"Meta-Llama-3_3-70B-Instruct","choices":[{"index":0,"message":{"role":"assistant","content":"{\"rank\": [\n {\"position\": 1, \"language\": \"JavaScript\", \"popularity\": \"94.5%\"},\n {\"position\": 2, \"language\": \"HTML/CSS\", \"popularity\": \"93.2%\"},\n {\"position\": 3, \"language\": \"Python\", \"popularity\": \"87.3%\"}\n]}"},"finish_reason":"stop","logprobs":null}],"usage":{"prompt_tokens":65,"completion_tokens":77,"total_tokens":142}}% >> ``` >> -> **Javascript** +> **JavaScript** >> >> ```javascript >> const request = require('request'); @@ -558,8 +558,6 @@ In this guide, we have explained how to use Structured Output with the [AI Endpo Browse the full [AI Endpoints documentation](/products/public-cloud-ai-and-machine-learning-ai-endpoints) to further understand the main concepts and get started. -To discover how to build complete and powerful applications using AI Endpoints, explore our dedicated [AI Endpoints guides](/products/public-cloud-ai-and-machine-learning-ai-endpoints). - If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. ## Feedback diff --git a/pages/public_cloud/ai_machine_learning/endpoints_guide_06_function_calling/guide.en-gb.md b/pages/public_cloud/ai_machine_learning/endpoints_guide_06_function_calling/guide.en-gb.md index 429e28589a9..544d261dc42 100644 --- a/pages/public_cloud/ai_machine_learning/endpoints_guide_06_function_calling/guide.en-gb.md +++ b/pages/public_cloud/ai_machine_learning/endpoints_guide_06_function_calling/guide.en-gb.md @@ -737,8 +737,6 @@ We have provided a comprehensive overview of the feature which can help you perf Browse the full [AI Endpoints documentation](/products/public-cloud-ai-and-machine-learning-ai-endpoints) to further understand the main concepts and get started. -To discover how to build complete and powerful applications using AI Endpoints, explore our dedicated [AI Endpoints guides](/products/public-cloud-ai-and-machine-learning-ai-endpoints). - If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. ## Feedback diff --git a/pages/public_cloud/ai_machine_learning/endpoints_guide_07_virtual_models/guide.en-gb.md b/pages/public_cloud/ai_machine_learning/endpoints_guide_07_virtual_models/guide.en-gb.md index 4eaf43c6b4a..994b0a60abc 100644 --- a/pages/public_cloud/ai_machine_learning/endpoints_guide_07_virtual_models/guide.en-gb.md +++ b/pages/public_cloud/ai_machine_learning/endpoints_guide_07_virtual_models/guide.en-gb.md @@ -1,7 +1,7 @@ --- title: AI Endpoints - Using Virtual Models excerpt: Learn how to use OVHcloud AI Endpoints Virtual Models -updated: 2025-08-18 +updated: 2025-10-13 --- > [!primary] @@ -42,22 +42,27 @@ Follow the instructions in the [AI Endpoints - Getting Started](/pages/public_cl ## Model DSL +> [!warning] +> +> As our virtual model feature allows dynamic model switching, the model’s characteristics (including pricing or context size) may change when a newer model is selected to handle your query. If you prefer certain features to remain fixed, you can lock them using the query conditions listed below. +> + When you request an LLM generation through our unified endpoint, you can provide in the OpenAI-compliant `model` field a model DSL query instead of a hardcoded model name. These queries are divided into three parts: tag, ranker, and condition: -- **Tag**: A tag can be a model series (llama, mistral, codestral, ...), a publisher (meta-llama, mistralai, ...) or use case tag (code_chat, code_completion, summarization, etc.) -- **Ranker**: The ranker defines a model's capability compared to other models. We support multiple rankers such as fastest, cheapest, biggest, latest or smallest. -- **Condition**: The condition allows you to filter models based on strict requirements on some of the model specifications such as context_size, max_tokens and input_cost. These conditions support basic operators (<, >, =). +- **Tag**: A tag can be a model series (llama, mistral, codestral, ...), a publisher (meta-llama, mistralai, ...) or use case tag (code_chat, code_completion, summarization, etc.). You can find the possible values on [our catalog](https://endpoints.ai.cloud.ovh.net/catalog). +- **Ranker**: The ranker defines a model's capability compared to other models. We currently support the following rankers: fastest, cheapest, biggest, latest and smallest. +- **Condition**: The condition allows you to filter models based on strict requirements on some of the model specifications. Currently supported specs are context_size, max_tokens, input_cost, params (number of parameters) and endpoint_publication_date (Date we made the model available on AI Endpoints). These conditions support basic operators (<, >, =). Below are some example queries and the models they currently resolve to. Please note that the resolved model can change, as we continuously update our catalog with new model releases. | Model Query | Current Target Model | Usage | |-----------|-----------|-----------| -| code_chat@latest | Qwen3-32B | The most recently released model optimized for code chat tasks | -| meta-llama@latest | Llama-3.1-8B-Instruct | The latest Meta-released LLaMA model | -| mistral@latest?context_size > 100000 | Mistral-Small-3.2-24B-Instruct-2506 | The latest Mistral model with a context window greater than 100k tokens | -| llama@biggest?input_cost<0.5 | Llama-3.1-8B-Instruct | The largest LLaMA model whose input token cost is under €0.50 per 1M tokens | +| code_chat@latest | **Example:** Qwen3-32B | The most recently released model optimized for code chat tasks | +| meta-llama@latest | **Example:** Llama-3.1-8B-Instruct | The latest Meta-released LLaMA model | +| mistral@latest?context_size > 100000 | **Example:** Mistral-Small-3.2-24B-Instruct-2506 | The latest Mistral model with a context window greater than 100k tokens | +| llama@biggest?input_cost<0.5 | **Example:** Llama-3.1-8B-Instruct | The largest LLaMA model whose input token cost is under €0.50 per 1M tokens | You can visit our [catalog](https://endpoints.ai.cloud.ovh.net/catalog) to learn more about the different model specifications. diff --git a/pages/public_cloud/ai_machine_learning/endpoints_guide_07_virtual_models/guide.fr-fr.md b/pages/public_cloud/ai_machine_learning/endpoints_guide_07_virtual_models/guide.fr-fr.md index 8c6490770fe..1d4924976e0 100644 --- a/pages/public_cloud/ai_machine_learning/endpoints_guide_07_virtual_models/guide.fr-fr.md +++ b/pages/public_cloud/ai_machine_learning/endpoints_guide_07_virtual_models/guide.fr-fr.md @@ -1,7 +1,7 @@ --- title: AI Endpoints - Modèles virtuels excerpt: "Découvrez comment utiliser les modèles virtuels d'AI Endpoints" -updated: 2025-08-18 +updated: 2025-10-13 --- > [!primary] @@ -42,22 +42,27 @@ Follow the instructions in the [AI Endpoints - Getting Started](/pages/public_cl ## Model DSL +> [!warning] +> +> As our virtual model feature allows dynamic model switching, the model’s characteristics (including pricing or context size) may change when a newer model is selected to handle your query. If you prefer certain features to remain fixed, you can lock them using the query conditions listed below. +> + When you request an LLM generation through our unified endpoint, you can provide in the OpenAI-compliant `model` field a model DSL query instead of a hardcoded model name. These queries are divided into three parts: tag, ranker, and condition: -- **Tag**: A tag can be a model series (llama, mistral, codestral, ...), a publisher (meta-llama, mistralai, ...) or use case tag (code_chat, code_completion, summarization, etc.) -- **Ranker**: The ranker defines a model's capability compared to other models. We support multiple rankers such as fastest, cheapest, biggest, latest or smallest. -- **Condition**: The condition allows you to filter models based on strict requirements on some of the model specifications such as context_size, max_tokens and input_cost. These conditions support basic operators (<, >, =). +- **Tag**: A tag can be a model series (llama, mistral, codestral, ...), a publisher (meta-llama, mistralai, ...) or use case tag (code_chat, code_completion, summarization, etc.). You can find the possible values on [our catalog](https://endpoints.ai.cloud.ovh.net/catalog). +- **Ranker**: The ranker defines a model's capability compared to other models. We currently support the following rankers: fastest, cheapest, biggest, latest and smallest. +- **Condition**: The condition allows you to filter models based on strict requirements on some of the model specifications. Currently supported specs are context_size, max_tokens, input_cost, params (number of parameters) and endpoint_publication_date (Date we made the model available on AI Endpoints). These conditions support basic operators (<, >, =). Below are some example queries and the models they currently resolve to. Please note that the resolved model can change, as we continuously update our catalog with new model releases. | Model Query | Current Target Model | Usage | |-----------|-----------|-----------| -| code_chat@latest | Qwen3-32B | The most recently released model optimized for code chat tasks | -| meta-llama@latest | Llama-3.1-8B-Instruct | The latest Meta-released LLaMA model | -| mistral@latest?context_size > 100000 | Mistral-Small-3.2-24B-Instruct-2506 | The latest Mistral model with a context window greater than 100k tokens | -| llama@biggest?input_cost<0.5 | Llama-3.1-8B-Instruct | The largest LLaMA model whose input token cost is under €0.50 per 1M tokens | +| code_chat@latest | **Example:** Qwen3-32B | The most recently released model optimized for code chat tasks | +| meta-llama@latest | **Example:** Llama-3.1-8B-Instruct | The latest Meta-released LLaMA model | +| mistral@latest?context_size > 100000 | **Example:** Mistral-Small-3.2-24B-Instruct-2506 | The latest Mistral model with a context window greater than 100k tokens | +| llama@biggest?input_cost<0.5 | **Example:** Llama-3.1-8B-Instruct | The largest LLaMA model whose input token cost is under €0.50 per 1M tokens | You can visit our [catalog](https://endpoints.ai.cloud.ovh.net/catalog) to learn more about the different model specifications. @@ -141,5 +146,4 @@ If you need training or technical assistance to implement our solutions, contact Please send us your questions, feedback and suggestions to improve the service: -- On the OVHcloud [Discord server](https://discord.gg/ovhcloud). - +- On the OVHcloud [Discord server](https://discord.gg/ovhcloud). \ No newline at end of file diff --git a/pages/public_cloud/ai_machine_learning/endpoints_guide_08_audio_transcriptions/guide.en-gb.md b/pages/public_cloud/ai_machine_learning/endpoints_guide_08_audio_transcriptions/guide.en-gb.md new file mode 100644 index 00000000000..a2b76323e1f --- /dev/null +++ b/pages/public_cloud/ai_machine_learning/endpoints_guide_08_audio_transcriptions/guide.en-gb.md @@ -0,0 +1,728 @@ +--- +title: AI Endpoints - Speech to Text +excerpt: Learn how to transcribe audio files with OVHcloud AI Endpoints +updated: 2025-10-03 +--- + +> [!primary] +> +> AI Endpoints is covered by the **[OVHcloud AI Endpoints Conditions](https://storage.gra.cloud.ovh.net/v1/AUTH_325716a587c64897acbef9a4a4726e38/contracts/48743bf-AI_Endpoints-ALL-1.1.pdf)** and the **[OVHcloud Public Cloud Special Conditions](https://storage.gra.cloud.ovh.net/v1/AUTH_325716a587c64897acbef9a4a4726e38/contracts/d2a208c-Conditions_particulieres_OVH_Stack-WE-9.0.pdf)**. +> + +## Introduction + +[AI Endpoints](https://endpoints.ai.cloud.ovh.net/) is a serverless platform provided by OVHcloud that offers easy access to a selection of world-renowned, pre-trained AI models. The platform is designed to be simple, secure, and intuitive, making it an ideal solution for developers who want to enhance their applications with AI capabilities without extensive AI expertise or concerns about data privacy. + +**Speech to Text** is a powerful feature that enables the conversion of spoken language into written text. + +The Speech to Text APIs on AI Endpoints allow you to easily integrate this technology into your applications, enabling you to transcribe audio files with high accuracy. Our endpoints support various [audio formats](#parameters-overview) and provide flexible configuration options to suit your specific use cases. + +## Objective + +This documentation provides an overview of the Speech to Text endpoints offered on [AI Endpoints](https://endpoints.ai.cloud.ovh.net/). + +Visit our [Catalog](https://endpoints.ai.cloud.ovh.net/catalog) to find out which models are compatible with Audio Analysis. + +The examples provided during this guide can be used with one of the following environments: + +> [!tabs] +> **Python** +>> +>> A [Python](https://www.python.org/) environment with the [openai client](https://pypi.org/project/openai/) and the pydantic library installed. +>> +>> ```sh +>> pip install openai pydantic +>> ``` +>> +> **JavaScript** +>> +>> A [Node.js](https://nodejs.org/en) environment with the [request](https://www.npmjs.com/package/request) library. +>> Request can be installed using [NPM](https://www.npmjs.com/): +>> +>> ```sh +>> npm install request +>> ``` +>> +> **cURL** +>> +>> A standard terminal, with [cURL](https://cURL.se/) installed on the system. +>> + +*These examples will be using the [Whisper-large-v3](https://endpoints.ai.cloud.ovh.net/models/whisper-large-v3) model.* + +## Authentication & Rate Limiting + +All the examples provided in this guide use anonymous authentication, which makes it simpler to use but may cause rate limiting issues. If you wish to enable authentication using your own token, simply specify your API key within the requests. + +Follow the instructions in the [AI Endpoints - Getting Started](/pages/public_cloud/ai_machine_learning/endpoints_guide_01_getting_started) guide for more information on authentication. + +## Request Body + +### Parameters Overview + +The request body for the audio transcription endpoint is of type `multipart/form-data` and includes the following fields: + +| Parameter | Required | Type | Allowed Values / Format | Default | Description | +|--------------------------|----------|---------------|---------------------------------------------------------------------------------------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **file** | Yes | binary | `mp3`, `mp4`, `aac`, `m4a`, `wav`, `flac`, `ogg`, `opus`, `webm`, `mpeg`, `mpga` | - | The **audio file object (not file name)** to transcribe. | +| **chunking_strategy** | No | `string`/`server_vad object`/`null` | - | null | Strategy for dividing the audio into chunks. More details [here](#chunking-strategy). | +| **diarize** | No | `boolean`/`null` | `true`/`false` | false | Enables speaker separation in the transcript. When set to true, the system separates the audio into segments based on speakers, by adding labels like "Speaker 1" and "Speaker 2", so you can see who said what in conversations such as interviews, meetings, or phone calls. More details [here](#diarization). | +| **language** | No | `string`/`null` | [ISO-639-1 format](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) | - | The language parameter specifies the language spoken in the input audio. Providing it can improve transcription accuracy and reduce latency (e.g. `en` for English, `fr` for French, `de` for German, `es` for Spanish, `zh` for Chinese, `ar` for Arabic ...). If not provided, the system will attempt automatic language detection, which may be slightly slower and less accurate in some cases. [More details on language compatibility and performance](#language-compatibility-and-performances). | +| **model** | No | `string`/`null` | ID of the model to use | - | Specifies the model to use for transcription. Useful when using our [unified endpoint](/pages/public_cloud/ai_machine_learning/endpoints_guide_07_virtual_models). | +| **prompt** | No | `string`/`null` | - | - | Text to guide the model's style, translate transcript to english or continue a previous audio segment. The language in which you write the prompt must match the audio's one. More details about prompt usage [here](#prompt). | +| **response_format** | No | `enum`/`null` | `json`, `text`, `srt`, `verbose_json`, `vtt` | `verbose_json` | Determines how the transcription data is returned. For detailed examples of each output type, visit the [Response Formats](#response-formats) section. | +| **stream** | No | `boolean`/`null` | `true`/`false` | false | If set to true, the model response data will be streamed to the client. Currently not supported for Whisper models. | +| **temperature** | No | `number`/`null` | From `0.0` to `1.0` | 0 | Controls randomness in the output. Higher values make the output more random, while lower values make it more focused and deterministic. | +| **timestamp_granularities** | No | `array`/`null` | `["segment"]`, `["word"]`, `["word", "segment"]` | `["segment"]` | Controls the level of detail in the timestamps provided in the transcription. More details [here](#timestamp-granularities). | + +### Example Usage + +Now that you know which parameters are available, let’s look at how to put them into practice. Below are sample requests in **Python**, **cURL** and **JavaScript**: + +> [!tabs] +> **Python (using requests)** +>> +>> ```python +>> import os +>> import requests +>> +>> url = "https://oai.endpoints.kepler.ai.cloud.ovh.net/v1/audio/transcriptions" +>> +>> audio_file_path = "my_audio.mp3" +>> +>> headers = { +>> "accept": "application/json", +>> # "Authorization": f"Bearer {os.getenv('OVH_AI_ENDPOINTS_ACCESS_TOKEN')}", +>> } +>> +>> files = {"file": open(audio_file_path, "rb")} +>> +>> data = { +>> "model": "whisper-large-v3", +>> "language": "en", +>> "temperature": "0", +>> "prompt": "<|transcribe|>", +>> "diarize": "false", +>> "timestamp_granularities": ["segment"], +>> "response_format": "verbose_json" +>> } +>> +>> response = requests.post(url, headers=headers, files=files, data=data) +>> +>> if response.status_code == 200: +>> # Handle response +>> print(response.json()) +>> else: +>> print("Error:", response.status_code, response.text) +>> ``` +>> +> **Python (using OpenAI client)** +>> +>> ```python +>> from openai import OpenAI +>> import os +>> +>> url = "https://oai.endpoints.kepler.ai.cloud.ovh.net/v1/" +>> audio_file_path = "my_audio.mp3" +>> +>> client = OpenAI( +>> base_url=url, +>> # api_key=os.getenv('OVH_AI_ENDPOINTS_ACCESS_TOKEN'), +>> ) +>> +>> with open(audio_file_path, "rb") as f: +>> transcript = client.audio.transcriptions.create( +>> file=f, +>> model="whisper-large-v3", +>> language="en", +>> temperature=0, +>> prompt="<|transcribe|>", +>> timestamp_granularities=["segment"], +>> response_format="verbose_json" +>> ) +>> +>> print(transcript) +>> ``` +>> +>> > [!warning] +>> > +>> > **Warning**: The `diarize` parameter is not supported when using the OpenAI client library. +>> > +>> > To use diarization, you must make a direct HTTP request using `requests` or `cURL` with `diarize` set to `true`. +>> > +>> +> **cURL** +>> +>> ```sh +>> curl -X POST "https://oai.endpoints.kepler.ai.cloud.ovh.net/v1/audio/transcriptions" \ +>> -F "file=@my_audio.mp3" \ +>> -F "model=whisper-large-v3" \ +>> -F "language=en" \ +>> -F "temperature=0" \ +>> -F "prompt==<|transcribe|>" \ +>> -F "diarize=false" \ +>> -F "timestamp_granularities[]=segment" \ +>> -F "response_format=verbose_json" +>> ``` +>> +>> To [**authenticate with your API key**](/pages/public_cloud/ai_machine_learning/endpoints_guide_01_getting_started), add an Authorization header: +>> +>> ```sh +>> `-H "Authorization: Bearer $OVH_AI_ENDPOINTS_ACCESS_TOKEN" \` +>> ``` +>> +> **JavaScript (using OpenAI client)** +>> +>> ```javascript +>> import OpenAI from "openai"; +>> import fs from "fs"; +>> +>> const openai = new OpenAI({ +>> baseURL: "https://oai.endpoints.kepler.ai.cloud.ovh.net/v1/", +>> // apiKey: process.env.OVH_AI_ENDPOINTS_ACCESS_TOKEN, +>> }); +>> +>> const transcript = await openai.audio.>> transcriptions.create({ +>> file: fs.createReadStream("my_audio.mp3"), +>> model: "whisper-large-v3", +>> language: "en", +>> temperature: 0, +>> prompt: "<|transcribe|>", +>> timestamp_granularities: ["segment"], +>> response_format: "verbose_json" +>> }); +>> +>> console.log(transcript); +>> ``` +>> + +**Output example** + +By default, the transcription endpoint returns output in `verbose_json` format. + +This includes detailed metadata such as language, segments, tokens, and diarization information: + +```json +{ + "task": "transcribe", + "success": true, + "language": "en", + "duration": 4.46975, + "text": "My name is Octave and I am working at OVHcloud", + "words": [], + "segments": [ + { + "id": 1, + "seek": 0, + "start": 0, + "end": 3.48, + "text": "My name is Octave and I am working at OVHcloud", + "tokens": [ + 50365, + 2588, + 275, + ... + ], + "temperature": 0, + "avg_logprob": -0.38066408, + "compression_ratio": 0.9, + "no_speech_prob": 0 + } + ], + "diarization": [], + "usage": { + "type": "duration", + "duration": 5 + } +} +``` + +For **detailed examples** of each available output type, see the [Response Formats section](#response-formats) section. + +### Parameters Details + +While the previous overview gives a quick reference, certain parameters require more context to understand how and when to use them. + +#### Diarization + +The `diarize` parameter enables speaker separation in the generated transcript. When set to `true`, the system labels different voices as `Speaker 0`, `Speaker 1`, etc. + +This is useful for meetings, debates, or interviews where multiple people are speaking. + +> [!warning] +> - This parameter is only available with the default `verbose_json` [response format](#response-formats). Using any other will raise an error. +> - `diarize` is not supported when using the OpenAI client libraries. You must use a direct HTTP request with `requests`, `cURL`, or another HTTP client. + +**Output Example**: Transcribing an audio file with `diarize` enabled: + +Request: + +```json +{ + "file": "